TeamService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• teamCreate
• teamDelete
• teamSort
• teamUpdate
• teamUserAdd
• teamUserPrimaryUpdate
• teamUserRemove
• userTeamList

Constructors

constructor

• new TeamService(httpRequest: BaseHttpRequest): TeamService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns TeamService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicteamCreate

• teamCreate(__namedParameters: { requestBody?: { name: string; parent_id: string; reference?: string } }): CancelablePromise<{ data?: TeamCreateResponse }>

• Create a team Bot-compatible Creates a new team in the organization.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { name: string; parent_id: string; reference?: string } }

  Returns CancelablePromise<{ data?: TeamCreateResponse }>

  any Successfully created the team.

publicteamDelete

• teamDelete(__namedParameters: { requestBody?: { id: string } }): CancelablePromise<{ data?: TeamDeleteResponse }>

• Delete a team Bot-compatible Deletes a team.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { id: string } }

  Returns CancelablePromise<{ data?: TeamDeleteResponse }>

  any Successfully deleted the team.

publicteamSort

• teamSort(__namedParameters: { requestBody: TeamSortParam }): CancelablePromise<any>

• Sort teams Sort the child teams of a parent team in a given order.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: TeamSortParam }

  Returns CancelablePromise<any>

  any Successfully sorted the teams.

publicteamUpdate

• teamUpdate(__namedParameters: { requestBody?: { id: string; name?: string; parent_id?: string; reference?: string } }): CancelablePromise<{ data?: TeamUpdateResponse }>

• Update a team Bot-compatible Updates a team's information including its name and parent team.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { id: string; name?: string; parent_id?: string; reference?: string } }

  Returns CancelablePromise<{ data?: TeamUpdateResponse }>

  any Successfully updated the team's information.

publicteamUserAdd

• teamUserAdd(__namedParameters: { requestBody?: { id?: string; user_ids?: string[] } }): CancelablePromise<{ data?: TeamUserCreateResponse }>

• Add users to a team Bot-compatible Adds users to a team.

  @throws

  ApiError

  ---

  Parameters

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

  Returns CancelablePromise<{ data?: TeamUserCreateResponse }>

  any Successfully added the users to the selected team.

publicteamUserPrimaryUpdate

• teamUserPrimaryUpdate(__namedParameters: { requestBody?: { id: string; user_id: string } }): CancelablePromise<void>

• Update a user's primary team Bot-compatible Updates a user's primary team.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { id: string; user_id: string } }

  Returns CancelablePromise<void>

  void

publicteamUserRemove

• teamUserRemove(__namedParameters: { requestBody?: { id: string; user_ids: string[] } }): CancelablePromise<{ data?: TeamUserDeleteResponse }>

• Remove team members Bot-compatible Removes members from a team.

  @throws

  ApiError

  ---

  Parameters

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

  Returns CancelablePromise<{ data?: TeamUserDeleteResponse }>

  any Successfully removed the members from the team.

publicuserTeamList

• userTeamList(__namedParameters: { directChildrenOnly?: boolean; parentId?: string }): CancelablePromise<{ data?: GetUserTeamListResponse }>

• List out teams Bot-compatible List out the child teams of a given team. If no parameters are passed, the list of all teams in the organization is given as a response.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { directChildrenOnly?: boolean; parentId?: string }

  Returns CancelablePromise<{ data?: GetUserTeamListResponse }>

  any Successfully retrieved the list of teams.