Class default

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createAndSendRequest deleteGenericResource deleteTeam get getGenericResource getGenericResources getMemberForTeam getMemberMembershipsForTeam getMembersForTeam getPermissionForTeam getPermissionsForTeam getTeam getTeamLinksForTeam post postGenericResources putTeam

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deleteGenericResource

deleteGenericResource(id: string, resourceId: string): Promise<TeamGenericResourceMemberResponse>
Remove an existing generic resource team member with given resourceId from team with the given teamId
Parameters
- id: string
- resourceId: string
Returns Promise<TeamGenericResourceMemberResponse>
- Defined in collections/teams.ts:118

deleteTeam

deleteTeam(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in collections/teams.ts:37

get

get(): Promise<ResultSetResponse<TeamResponse>>
Returns Promise<ResultSetResponse<TeamResponse>>
- Defined in collections/teams.ts:22

getGenericResource

getGenericResource(id: string, resourceId: string): Promise<TeamGenericResourceMemberResponse>
Retrieve an existing generic resource team member for the given teamId and resourceId
Parameters
- id: string
- resourceId: string
Returns Promise<TeamGenericResourceMemberResponse>
- Defined in collections/teams.ts:107

getGenericResources

getGenericResources(id: string): Promise<TeamGenericResourceMembersResponse>
Retrieve all the generic resource members for this team
Parameters
- id: string
Returns Promise<TeamGenericResourceMembersResponse>
- Defined in collections/teams.ts:87

getMemberForTeam

getMemberForTeam(id: string, accountId: string): Promise<TeamMemberActiveMembershipResponse>
Parameters
- id: string
- accountId: string
Returns Promise<TeamMemberActiveMembershipResponse>
- Defined in collections/teams.ts:55

getMemberMembershipsForTeam

getMemberMembershipsForTeam(id: string, accountId: string): Promise<ResultSetResponse<TeamMemberMembershipResponse>>
Parameters
- id: string
- accountId: string
Returns Promise<ResultSetResponse<TeamMemberMembershipResponse>>
- Defined in collections/teams.ts:62

getMembersForTeam

getMembersForTeam(id: string): Promise<ResultSetResponse<TeamMemberActiveMembershipResponse>>
Parameters
- id: string
Returns Promise<ResultSetResponse<TeamMemberActiveMembershipResponse>>
- Defined in collections/teams.ts:49

getPermissionForTeam

getPermissionForTeam(id: string, key: string): Promise<TeamPermissionResponse>
Parameters
- id: string
- key: string
Returns Promise<TeamPermissionResponse>
- Defined in collections/teams.ts:77

getPermissionsForTeam

getPermissionsForTeam(id: string): Promise<ResultSetResponse<TeamPermissionResponse>>
Parameters
- id: string
Returns Promise<ResultSetResponse<TeamPermissionResponse>>
- Defined in collections/teams.ts:71

getTeam

getTeam(id: string): Promise<TeamResponse>
Parameters
- id: string
Returns Promise<TeamResponse>
- Defined in collections/teams.ts:26

getTeamLinksForTeam

getTeamLinksForTeam(id: string): Promise<ResultSetResponse<TeamLinkRefResponse>>
Parameters
- id: string
Returns Promise<ResultSetResponse<TeamLinkRefResponse>>
- Defined in collections/teams.ts:43

post

post(team: Team): Promise<TeamResponse>
Parameters
- team: Team
Returns Promise<TeamResponse>
- Defined in collections/teams.ts:15

postGenericResources

postGenericResources(id: string, genericResource: {
genericResourceId: number;
}): Promise<TeamGenericResourceMemberResponse>
Add a generic resource to the given team
Parameters
- id: string
- genericResource: {
  genericResourceId: number;
  }
  - genericResourceId: number
Returns Promise<TeamGenericResourceMemberResponse>
- Defined in collections/teams.ts:94

putTeam

putTeam(id: string, team: Team): Promise<TeamResponse>
Parameters
- id: string
- team: Team
Returns Promise<TeamResponse>
- Defined in collections/teams.ts:30

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deleteGenericResource

Parameters

id: string

resourceId: string

Returns Promise<TeamGenericResourceMemberResponse>

deleteTeam

Parameters

id: string

Returns Promise<void>

get

Returns Promise<ResultSetResponse<TeamResponse>>

getGenericResource

Parameters

id: string

resourceId: string

Returns Promise<TeamGenericResourceMemberResponse>

getGenericResources

Parameters

id: string

Returns Promise<TeamGenericResourceMembersResponse>

getMemberForTeam

Parameters

id: string

accountId: string

Returns Promise<TeamMemberActiveMembershipResponse>

getMemberMembershipsForTeam

Parameters

id: string

accountId: string

Returns Promise<ResultSetResponse<TeamMemberMembershipResponse>>

getMembersForTeam

Parameters

id: string

Returns Promise<ResultSetResponse<TeamMemberActiveMembershipResponse>>

getPermissionForTeam

Parameters

id: string

key: string

Returns Promise<TeamPermissionResponse>

getPermissionsForTeam

Parameters

id: string

Returns Promise<ResultSetResponse<TeamPermissionResponse>>

getTeam

Parameters

id: string

Returns Promise<TeamResponse>

getTeamLinksForTeam

Parameters

id: string

Returns Promise<ResultSetResponse<TeamLinkRefResponse>>

post

Parameters

team: Team

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}

genericResource: {
genericResourceId: number;
}