Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamsApi

TeamsApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • TeamsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = ...
    • axios: AxiosInstance = ...

    Returns TeamsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

teamsGet

  • List teams

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2001>>

teamsMembersMemberNameTeamsGet

  • teamsMembersMemberNameTeamsGet(memberName: string, options?: any): Promise<AxiosResponse<InlineResponse2002>>

  • List teams which member belongs into

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • memberName: string

      Member&#39;s name

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2002>>

teamsPost

teamsTeamIdActivationKeyPost

  • teamsTeamIdActivationKeyPost(teamId: string, key: string, options?: any): Promise<AxiosResponse<void>>

  • Activate user who is invited the team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • key: string

      Activation key which is sent when owner invites other user to the team

    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdDelete

  • teamsTeamIdDelete(teamId: string, options?: any): Promise<AxiosResponse<void>>

  • Delete a team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdGet

  • Get a details of team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • Optional options: any

    Returns Promise<AxiosResponse<TeamsResponseWithId>>

teamsTeamIdMembersGet

  • teamsTeamIdMembersGet(teamId: string, options?: any): Promise<AxiosResponse<InlineResponse2003[]>>

  • List users specified team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2003[]>>

teamsTeamIdMembersNameGet

  • teamsTeamIdMembersNameGet(teamId: string, name: string, options?: any): Promise<AxiosResponse<InlineResponse2004>>

  • Get member information specified team and name

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • name: string

      Name of a member

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2004>>

teamsTeamIdMembersNameRoleDelete

  • teamsTeamIdMembersNameRoleDelete(teamId: string, name: string, options?: any): Promise<AxiosResponse<void>>

  • Delete role of specific team member

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • name: string

      name of member

    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdMembersNameRoleGet

  • teamsTeamIdMembersNameRoleGet(teamId: string, name: string, options?: any): Promise<AxiosResponse<InlineResponse2005>>

  • Get role of specific team member

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • name: string

      Name of member

    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2005>>

teamsTeamIdMembersNameRolePost

  • teamsTeamIdMembersNameRolePost(teamId: string, name: string, request: InlineObject18, options?: any): Promise<AxiosResponse<void>>

  • Add role of specific team member

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • name: string

      Name of member

    • request: InlineObject18
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdMembersNameRolePut

  • teamsTeamIdMembersNameRolePut(teamId: string, name: string, request: InlineObject17, options?: any): Promise<AxiosResponse<void>>

  • Update role of specific team member

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • name: string

      name of member

    • request: InlineObject17
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdMembersPost

  • teamsTeamIdMembersPost(teamId: string, request?: InlineObject[], options?: any): Promise<AxiosResponse<void>>

  • Add members to the team by email. If new member already has Shifter Account, This API sends invitation to the the user who matched with email. If new member does not have Shifter account yet, API sends invitation to that email with Sign Up link.

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • Optional request: InlineObject[]
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdPut

  • teamsTeamIdPut(teamId: string, request: TeamsResponseWithoutId, options?: any): Promise<AxiosResponse<void>>

  • Update a team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    Returns Promise<AxiosResponse<void>>

teamsTeamIdSitesDelete

  • teamsTeamIdSitesDelete(teamId: string, request?: InlineObject16, options?: any): Promise<AxiosResponse<void>>

  • Detach sites from specified team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • Optional request: InlineObject16
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdSitesGet

  • teamsTeamIdSitesGet(teamId: string, options?: any): Promise<AxiosResponse<SiteResponse[]>>

  • List sites in specified team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • Optional options: any

    Returns Promise<AxiosResponse<SiteResponse[]>>

teamsTeamIdSitesPost

  • teamsTeamIdSitesPost(teamId: string, request: InlineObject15, options?: any): Promise<AxiosResponse<void>>

  • Add sites to the team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • request: InlineObject15
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

teamsTeamIdSitesSiteIdGet

  • teamsTeamIdSitesSiteIdGet(teamId: string, siteId: string, options?: any): Promise<AxiosResponse<SiteResponse>>

  • Get site details which specified team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • siteId: string

      Site ID

    • Optional options: any

    Returns Promise<AxiosResponse<SiteResponse>>

teamsTeamIdSitesSiteIdPost

  • teamsTeamIdSitesSiteIdPost(teamId: string, siteId: string, options?: any): Promise<AxiosResponse<void>>

  • Add a site to specific team

    throws

    {RequiredError}

    memberof

    TeamsApi

    Parameters

    • teamId: string

      Team ID

    • siteId: string

      Site ID

    • Optional options: any

    Returns Promise<AxiosResponse<void>>

Generated using TypeDoc