Class MemberBansService

constructor

• new MemberBansService(httpRequest): MemberBansService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MemberBansService

Readonly httpRequest

serverMemberBanCreate

• serverMemberBanCreate(options): CancelablePromise<{
      serverMemberBan: ServerMemberBanPayload;
  }>

• Create a server ban Also known as banning a server member

  Throws

  ApiError

  Parameters

  • options: {
        requestBody?: {
            reason?: string;
        };
        serverId: string;
        userId: string;
    }

    • Optional requestBody?: {
          reason?: string;
      }

      • Optional reason?: string

        The reason for the ban

    • serverId: string

    • userId: string

      The ID of the user to ban from this server

  Returns CancelablePromise<{
      serverMemberBan: ServerMemberBanPayload;
  }>

  any Success

serverMemberBanDelete

• serverMemberBanDelete(options): CancelablePromise<void>

• Delete a server ban Also known as unbanning a server member

  Throws

  ApiError

  Parameters

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

    • serverId: string

    • userId: string

      The ID of the user to unban from this server

  Returns CancelablePromise<void>

  void

serverMemberBanRead

• serverMemberBanRead(options): CancelablePromise<{
      serverMemberBan: ServerMemberBanPayload;
  }>

• Get a server ban

  Throws

  ApiError

  Parameters

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

    • serverId: string

    • userId: string

      The ID of the user to get a server ban for

  Returns CancelablePromise<{
      serverMemberBan: ServerMemberBanPayload;
  }>

  any Success

serverMemberBanReadMany

• serverMemberBanReadMany(options): CancelablePromise<{
      serverMemberBans: ServerMemberBanPayload[];
  }>

• Get server bans

  Throws

  ApiError

  Parameters

  • options: {
        serverId: string;
    }

    • serverId: string

  Returns CancelablePromise<{
      serverMemberBans: ServerMemberBanPayload[];
  }>

  any Success