Class GroupsService

constructor

• new GroupsService(httpRequest): GroupsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns GroupsService

Readonly httpRequest

groupCreate

• groupCreate(options): CancelablePromise<{
      group: GroupPayload;
  }>

• Create a group Note: only 100 unarchived groups can exist on a server at any time

  Throws

  ApiError

  Parameters

  • options: {
        requestBody: {
            description?: string;
            emoteId?: number;
            isPublic?: boolean;
            name: string;
        };
        serverId: string;
    }

    • requestBody: {
          description?: string;
          emoteId?: number;
          isPublic?: boolean;
          name: string;
      }

      • Optional description?: string

        The description associated with the group

      • Optional emoteId?: number

        The emote to associate with the group

      • Optional isPublic?: boolean

        Is this group open for anyone to join?

      • name: string

        The name of the group

    • serverId: string

  Returns CancelablePromise<{
      group: GroupPayload;
  }>

  any Success

groupDelete

• groupDelete(options): CancelablePromise<void>

• Delete a group Note: you cannot delete the home group

  Throws

  ApiError

  Parameters

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

    • groupId: string

    • serverId: string

  Returns CancelablePromise<void>

  void

groupRead

• groupRead(options): CancelablePromise<{
      group: GroupPayload;
  }>

• Get a group

  Throws

  ApiError

  Parameters

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

    • groupId: string

    • serverId: string

  Returns CancelablePromise<{
      group: GroupPayload;
  }>

  any Success

groupReadMany

• groupReadMany(options): CancelablePromise<{
      groups: GroupPayload[];
  }>

• Get groups

  Throws

  ApiError

  Parameters

  • options: {
        serverId: string;
    }

    • serverId: string

  Returns CancelablePromise<{
      groups: GroupPayload[];
  }>

  any Success

groupUpdate

• groupUpdate(options): CancelablePromise<{
      group: GroupPayload;
  }>

• Update a group

  Throws

  ApiError

  Parameters

  • options: {
        groupId: string;
        requestBody: {
            description?: string;
            emoteId?: number;
            isPublic?: boolean;
            name?: string;
        };
        serverId: string;
    }

    • groupId: string

    • requestBody: {
          description?: string;
          emoteId?: number;
          isPublic?: boolean;
          name?: string;
      }

      • Optional description?: string

        The description associated with the group Note - this property cannot be modified on a home group

      • Optional emoteId?: number

        The emote to associate with the group

      • Optional isPublic?: boolean

        Is this group open for anyone to join? Note - this property cannot be modified on a home group

      • Optional name?: string

        The name of the group

    • serverId: string

  Returns CancelablePromise<{
      group: GroupPayload;
  }>

  any Success