WorkspaceService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• emojiListByWorkspace
• organizationWorkspaceInvite
• postApiWorkspaceGroupInvite
• workspaceGroupList
• workspaceInfo
• workspaceList
• workspaceUpdate
• workspaceUserInfo
• workspaceUserList

Constructors

constructor

• new WorkspaceService(httpRequest: BaseHttpRequest): WorkspaceService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns WorkspaceService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicemojiListByWorkspace

• emojiListByWorkspace(__namedParameters: { wsId: string }): CancelablePromise<{ data?: Emoji[] }>

• Retrieve a custom emoji list from a workspace Retrieve the list of custom emojis used in a given workspace

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { wsId: string }

  Returns CancelablePromise<{ data?: Emoji[] }>

  any Successfully retrieved the emoji list.

publicorganizationWorkspaceInvite

• organizationWorkspaceInvite(__namedParameters: { requestBody?: AddCompanyWorkspaceInviteParam }): CancelablePromise<{ data?: AddCompanyWorkspaceInviteResponse }>

• Invite a member Invites a member to the workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: AddCompanyWorkspaceInviteParam }

  Returns CancelablePromise<{ data?: AddCompanyWorkspaceInviteResponse }>

  any Successfully invited the member to the workspace

publicpostApiWorkspaceGroupInvite

• postApiWorkspaceGroupInvite(__namedParameters: { requestBody?: { group_id?: string; user_ids?: string[]; workspace_id?: string } }): CancelablePromise<void>

• Invite users to a group in a workspace Invites a user to a group in a workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { group_id?: string; user_ids?: string[]; workspace_id?: string } }

  Returns CancelablePromise<void>

  void

publicworkspaceGroupList

• workspaceGroupList(__namedParameters: { cnt?: number; keyword?: string; page?: number; wsId: string }): CancelablePromise<{ data?: WorkspaceGroup[] }>

• Retrieve a workspace's list of groups Retrieves a list of groups in a workspace

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { cnt?: number; keyword?: string; page?: number; wsId: string }

  Returns CancelablePromise<{ data?: WorkspaceGroup[] }>

  any Successfully retrieved the workspace group list

publicworkspaceInfo

• workspaceInfo(__namedParameters: { id: string }): CancelablePromise<{ data?: GetWorkspaceInfoResponse }>

• Get workspace info Bot-compatible Retrieves information about a workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string }

  Returns CancelablePromise<{ data?: GetWorkspaceInfoResponse }>

  any Successfully retrieved the workspace's information.

publicworkspaceList

• workspaceList(__namedParameters: { limit?: number; name?: string; offset?: string; page?: number }): CancelablePromise<{ data?: GetWorkspaceListResponse }>

• List out workspaces Lists out a given number of workspaces the user joined. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { limit?: number; name?: string; offset?: string; page?: number }

  Returns CancelablePromise<{ data?: GetWorkspaceListResponse }>

  any Successfully retrieved the list of workspaces.

publicworkspaceUpdate

• workspaceUpdate(__namedParameters: { requestBody: PutWorkspaceParam }): CancelablePromise<{ data?: PutWorkspaceResponse }>

• Update a workspace Updates an existing workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: PutWorkspaceParam }

  Returns CancelablePromise<{ data?: PutWorkspaceResponse }>

  any Successfully updated the workspace.

publicworkspaceUserInfo

• workspaceUserInfo(__namedParameters: { userId?: string; workspaceId: string }): CancelablePromise<{ data?: WorkspaceUserResponse }>

• Get a workspace member's profile Bot-compatible Retrieves a user's profile registered in a given workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { userId?: string; workspaceId: string }

  Returns CancelablePromise<{ data?: WorkspaceUserResponse }>

  any Successfully retrieved the user's profile.

publicworkspaceUserList

• workspaceUserList(__namedParameters: { keyword?: string; limit?: number; offset?: string; page?: number; type?: name | email; workspaceId: string }): CancelablePromise<{ data?: GetWorkspaceUserListResponse }>

• List out workspace members Bot-compatible Lists out a given number of members from a workspace. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { keyword?: string; limit?: number; offset?: string; page?: number; type?: name | email; workspaceId: string }

  Returns CancelablePromise<{ data?: GetWorkspaceUserListResponse }>

  any Successfully retrieved the members.