Interface ContentfulOrganizationAPI

Hierarchy

ContentfulOrganizationAPI
- Organization

Index

Methods

Methods

createAppDefinition

createAppDefinition(data: AppDefinitionProps): Promise<AppDefinition>

- Defined in organization.d.ts:14
Parameters
- data: AppDefinitionProps
Returns Promise<AppDefinition>

createOrganizationInvitation

createOrganizationInvitation(data: OrganizationInvitationProps): Promise<OrganizationInvitation>

- Defined in organization.d.ts:30
Parameters
- data: OrganizationInvitationProps
Returns Promise<OrganizationInvitation>

createTeam

createTeam(data: TeamProps): Promise<Team>

- Defined in organization.d.ts:19
Parameters
- data: TeamProps
Returns Promise<Team>

createTeamMembership

createTeamMembership(data: TeamMembershipProps): Promise<TeamMembership>

- Defined in organization.d.ts:22
Parameters
- data: TeamMembershipProps
Returns Promise<TeamMembership>

getAppDefinition

getAppDefinition(id: string): Promise<AppDefinition>

- Defined in organization.d.ts:15
Parameters
- id: string
Returns Promise<AppDefinition>

getAppDefinitions

getAppDefinitions(): Promise<Collection<AppDefinition>>

- Defined in organization.d.ts:16
Returns Promise<Collection<AppDefinition>>

getOrganizationInvitation

getOrganizationInvitation(id: string): Promise<OrganizationInvitation>

- Defined in organization.d.ts:29
Parameters
- id: string
Returns Promise<OrganizationInvitation>

getTeam

getTeam(teamId: string, id: string): Promise<Team>

- Defined in organization.d.ts:20
Parameters
- teamId: string
- id: string
Returns Promise<Team>

getTeamMembership

getTeamMembership(teamId: string, id: string): Promise<TeamMembership>

- Defined in organization.d.ts:23
Parameters
- teamId: string
- id: string
Returns Promise<TeamMembership>

getTeamMemberships

getTeamMemberships(opts?: TeamMembershipOptions): Promise<Collection<TeamMembership>>

- Defined in organization.d.ts:24
Parameters
- Optional opts: TeamMembershipOptions
Returns Promise<Collection<TeamMembership>>

getTeamSpaceMembership

getTeamSpaceMembership(id: string): Promise<TeamSpaceMembership>

- Defined in organization.d.ts:25
Parameters
- id: string
Returns Promise<TeamSpaceMembership>

getTeamSpaceMemberships

getTeamSpaceMemberships(opts?: TeamSpaceMembershipOptions): Promise<Collection<TeamSpaceMembership>>

- Defined in organization.d.ts:26
Parameters
- Optional opts: TeamSpaceMembershipOptions
Returns Promise<Collection<TeamSpaceMembership>>

getTeams

getTeams(teamId: string): Promise<Collection<Team>>

- Defined in organization.d.ts:21
Parameters
- teamId: string
Returns Promise<Collection<Team>>

getUser

getUser(userId: string): Promise<User>

- Defined in organization.d.ts:17
Parameters
- userId: string
Returns Promise<User>

getUsers

getUsers(): Promise<Collection<User>>

- Defined in organization.d.ts:18
Returns Promise<Collection<User>>