Class MembersService

constructor

• new MembersService(httpRequest): MembersService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MembersService

Readonly httpRequest

memberNicknameDelete

• memberNicknameDelete(options): CancelablePromise<void>

• Delete a member's nickname

  Throws

  ApiError

  Parameters

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

    • serverId: string

    • userId: string

      The ID of the user to remove nickname from

  Returns CancelablePromise<void>

  void

memberNicknameUpdate

• memberNicknameUpdate(options): CancelablePromise<{
      nickname: string;
  }>

• Update a member's nickname

  Throws

  ApiError

  Parameters

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

    • requestBody: {
          nickname: string;
      }

      • nickname: string

        The nickname to assign to the member

    • serverId: string

    • userId: string

      The ID of the user to update nickname for

  Returns CancelablePromise<{
      nickname: string;
  }>

  any Success

serverMemberDelete

• serverMemberDelete(options): CancelablePromise<void>

• Kick a server member This route can be used to leave servers by passing in your own user ID or @me for userId

  Throws

  ApiError

  Parameters

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

    • serverId: string

      The ID of the server to kick the user from

    • userId: string

      The ID of the user to kick. If the value provided here is your own user's ID, the request will attempt to make you leave the server

  Returns CancelablePromise<void>

  void

serverMemberRead

• serverMemberRead(options): CancelablePromise<{
      member: ServerMemberPayload;
  }>

• Get a server member

  Throws

  ApiError

  Parameters

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

    • serverId: string

    • userId: string

  Returns CancelablePromise<{
      member: ServerMemberPayload;
  }>

  any Success

serverMemberReadMany

• serverMemberReadMany(options): CancelablePromise<{
      members: ServerMemberSummaryPayload[];
  }>

• Get members of a server Results returned will be ordered ascending by the member's joinedAt

  Throws

  ApiError

  Parameters

  • options: {
        serverId: string;
    }

    • serverId: string

  Returns CancelablePromise<{
      members: ServerMemberSummaryPayload[];
  }>

  any Success