Class PermissionOverrideService

constructor

• new PermissionOverrideService(httpRequest): PermissionOverrideService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns PermissionOverrideService

Readonly httpRequest

channelCategoryRolePermissionCreate

• channelCategoryRolePermissionCreate(options): CancelablePromise<{
      channelCategoryRolePermission: ChannelCategoryRolePermissionPayload;
  }>

• Create a channel category role permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        requestBody: {
            permissions: Record<string, any>;
        };
        roleId: number;
        serverId: string;
    }

    • categoryId: number

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • roleId: number

    • serverId: string

  Returns CancelablePromise<{
      channelCategoryRolePermission: ChannelCategoryRolePermissionPayload;
  }>

  any Success

channelCategoryRolePermissionDelete

• channelCategoryRolePermissionDelete(options): CancelablePromise<void>

• Delete a channel category role permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        roleId: number;
        serverId: string;
    }

    • categoryId: number

    • roleId: number

    • serverId: string

  Returns CancelablePromise<void>

  void

channelCategoryRolePermissionRead

• channelCategoryRolePermissionRead(options): CancelablePromise<{
      channelCategoryRolePermission: ChannelCategoryRolePermissionPayload;
  }>

• Read a channel category role permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        roleId: number;
        serverId: string;
    }

    • categoryId: number

    • roleId: number

    • serverId: string

  Returns CancelablePromise<{
      channelCategoryRolePermission: ChannelCategoryRolePermissionPayload;
  }>

  any Success

channelCategoryRolePermissionReadMany

• channelCategoryRolePermissionReadMany(options): CancelablePromise<{
      channelCategoryRolePermissions: ChannelCategoryRolePermissionPayload[];
  }>

• Get a list of the channel category role permissions

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        serverId: string;
    }

    • categoryId: number

    • serverId: string

  Returns CancelablePromise<{
      channelCategoryRolePermissions: ChannelCategoryRolePermissionPayload[];
  }>

  any Success

channelCategoryRolePermissionUpdate

• channelCategoryRolePermissionUpdate(options): CancelablePromise<{
      channelCategoryRolePermission: ChannelCategoryRolePermissionPayload;
  }>

• Update a channel category role permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        requestBody: {
            permissions: Record<string, any>;
        };
        roleId: number;
        serverId: string;
    }

    • categoryId: number

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • roleId: number

    • serverId: string

  Returns CancelablePromise<{
      channelCategoryRolePermission: ChannelCategoryRolePermissionPayload;
  }>

  any Success

channelCategoryUserPermissionCreate

• channelCategoryUserPermissionCreate(options): CancelablePromise<{
      channelCategoryUserPermission: ChannelCategoryUserPermissionPayload;
  }>

• Create a channel category user permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        requestBody: {
            permissions: Record<string, any>;
        };
        serverId: string;
        userId: string;
    }

    • categoryId: number

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      channelCategoryUserPermission: ChannelCategoryUserPermissionPayload;
  }>

  any Success

channelCategoryUserPermissionDelete

• channelCategoryUserPermissionDelete(options): CancelablePromise<void>

• Delete a channel category user permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        serverId: string;
        userId: string;
    }

    • categoryId: number

    • serverId: string

    • userId: string

  Returns CancelablePromise<void>

  void

channelCategoryUserPermissionRead

• channelCategoryUserPermissionRead(options): CancelablePromise<{
      channelCategoryUserPermission: ChannelCategoryUserPermissionPayload;
  }>

• Read a channel category user permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        serverId: string;
        userId: string;
    }

    • categoryId: number

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      channelCategoryUserPermission: ChannelCategoryUserPermissionPayload;
  }>

  any Success

channelCategoryUserPermissionReadMany

• channelCategoryUserPermissionReadMany(options): CancelablePromise<{
      channelCategoryUserPermissions: ChannelCategoryUserPermissionPayload[];
  }>

• Get a list of the channel category user permissions

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        serverId: string;
    }

    • categoryId: number

    • serverId: string

  Returns CancelablePromise<{
      channelCategoryUserPermissions: ChannelCategoryUserPermissionPayload[];
  }>

  any Success

channelCategoryUserPermissionUpdate

• channelCategoryUserPermissionUpdate(options): CancelablePromise<{
      channelCategoryUserPermission: ChannelCategoryUserPermissionPayload;
  }>

• Update a channel category user permission

  Throws

  ApiError

  Parameters

  • options: {
        categoryId: number;
        requestBody: {
            permissions: Record<string, any>;
        };
        serverId: string;
        userId: string;
    }

    • categoryId: number

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      channelCategoryUserPermission: ChannelCategoryUserPermissionPayload;
  }>

  any Success

channelRolePermissionCreate

• channelRolePermissionCreate(options): CancelablePromise<{
      channelRolePermission: ChannelRolePermissionPayload;
  }>

• Create a channel role permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            permissions: Record<string, any>;
        };
        roleId: number;
        serverId: string;
    }

    • channelId: string

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • roleId: number

    • serverId: string

  Returns CancelablePromise<{
      channelRolePermission: ChannelRolePermissionPayload;
  }>

  any Success

channelRolePermissionDelete

• channelRolePermissionDelete(options): CancelablePromise<void>

• Delete a channel role permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        roleId: number;
        serverId: string;
    }

    • channelId: string

    • roleId: number

    • serverId: string

  Returns CancelablePromise<void>

  void

channelRolePermissionRead

• channelRolePermissionRead(options): CancelablePromise<{
      channelRolePermission: ChannelRolePermissionPayload;
  }>

• Read a channel role permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        roleId: number;
        serverId: string;
    }

    • channelId: string

    • roleId: number

    • serverId: string

  Returns CancelablePromise<{
      channelRolePermission: ChannelRolePermissionPayload;
  }>

  any Success

channelRolePermissionReadMany

• channelRolePermissionReadMany(options): CancelablePromise<{
      channelRolePermissions: ChannelRolePermissionPayload[];
  }>

• ReadMany a channel role permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        serverId: string;
    }

    • channelId: string

    • serverId: string

  Returns CancelablePromise<{
      channelRolePermissions: ChannelRolePermissionPayload[];
  }>

  any Success

channelRolePermissionUpdate

• channelRolePermissionUpdate(options): CancelablePromise<{
      channelRolePermission: ChannelRolePermissionPayload;
  }>

• Update a channel role permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            permissions: Record<string, any>;
        };
        roleId: number;
        serverId: string;
    }

    • channelId: string

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • roleId: number

    • serverId: string

  Returns CancelablePromise<{
      channelRolePermission: ChannelRolePermissionPayload;
  }>

  any Success

channelUserPermissionCreate

• channelUserPermissionCreate(options): CancelablePromise<{
      channelUserPermission: ChannelUserPermissionPayload;
  }>

• Create a channel user permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            permissions: Record<string, any>;
        };
        serverId: string;
        userId: string;
    }

    • channelId: string

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      channelUserPermission: ChannelUserPermissionPayload;
  }>

  any Success

channelUserPermissionDelete

• channelUserPermissionDelete(options): CancelablePromise<void>

• Delete a channel user permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        serverId: string;
        userId: string;
    }

    • channelId: string

    • serverId: string

    • userId: string

  Returns CancelablePromise<void>

  void

channelUserPermissionRead

• channelUserPermissionRead(options): CancelablePromise<{
      channelUserPermission: ChannelUserPermissionPayload;
  }>

• Read a channel user permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        serverId: string;
        userId: string;
    }

    • channelId: string

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      channelUserPermission: ChannelUserPermissionPayload;
  }>

  any Success

channelUserPermissionReadMany

• channelUserPermissionReadMany(options): CancelablePromise<{
      channelUserPermissions: ChannelUserPermissionPayload[];
  }>

• Read a channel user permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        serverId: string;
    }

    • channelId: string

    • serverId: string

  Returns CancelablePromise<{
      channelUserPermissions: ChannelUserPermissionPayload[];
  }>

  any Success

channelUserPermissionUpdate

• channelUserPermissionUpdate(options): CancelablePromise<{
      channelUserPermission: ChannelUserPermissionPayload;
  }>

• Update a channel user permission

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        requestBody: {
            permissions: Record<string, any>;
        };
        serverId: string;
        userId: string;
    }

    • channelId: string

    • requestBody: {
          permissions: Record<string, any>;
      }

      • permissions: Record<string, any>

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      channelUserPermission: ChannelUserPermissionPayload;
  }>

  any Success