Interface Organization

Hierarchy

DefaultElements<OrganizationProp>
OrganizationProp
MetaSys<MetaSysProps>
ContentfulOrganizationAPI
- Organization

Index

Properties

name
sys

Methods

Properties

name

name: string

sys

sys: MetaSysProps

Methods

createAppDefinition

createAppDefinition(data: AppDefinitionProps): Promise<AppDefinition>

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

createOrganizationInvitation

createOrganizationInvitation(data: OrganizationInvitationProps): Promise<OrganizationInvitation>

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

createTeam

createTeam(data: TeamProps): Promise<Team>

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

createTeamMembership

createTeamMembership(data: TeamMembershipProps): Promise<TeamMembership>

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

getAppDefinition

getAppDefinition(id: string): Promise<AppDefinition>

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

getAppDefinitions

getAppDefinitions(): Promise<Collection<AppDefinition>>

Inherited from ContentfulOrganizationAPI.getAppDefinitions
- Defined in organization.d.ts:16
Returns Promise<Collection<AppDefinition>>

getOrganizationInvitation

getOrganizationInvitation(id: string): Promise<OrganizationInvitation>

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

getTeam

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

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

getTeamMembership

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

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

getTeamMemberships

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

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

getTeamSpaceMembership

getTeamSpaceMembership(id: string): Promise<TeamSpaceMembership>

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

getTeamSpaceMemberships

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

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

getTeams

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

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

getUser

getUser(userId: string): Promise<User>

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

getUsers

getUsers(): Promise<Collection<User>>

Inherited from ContentfulOrganizationAPI.getUsers
- Defined in organization.d.ts:18
Returns Promise<Collection<User>>

toPlainObject

toPlainObject(): OrganizationProp

Inherited from DefaultElements.toPlainObject
- Defined in generated/common-types.d.ts:2
Returns OrganizationProp