Class OrganizationsApi

Hierarchy

BaseAPI
BaseAPI
- OrganizationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrganizationsApi(configuration: Configuration): OrganizationsApi

Overrides BaseAPI.constructor
- Defined in account/organizations/OrganizationsApi.ts:18
Parameters
- configuration: Configuration
Returns OrganizationsApi

Properties

groups

groups: GroupsApi

Protected restClient

restClient: RestClient

settings

settings: SettingsApi

subOrganizations

subOrganizations: SubOrganizationsApi

Methods

create

create(organization: Organization): Promise<Organization>

- Defined in account/organizations/OrganizationsApi.ts:32
Parameters
- Optional organization: Organization
Returns Promise<Organization>

get

get(organizationId: string): Promise<Organization>

- Defined in account/organizations/OrganizationsApi.ts:44
Parameters
- organizationId: string
Returns Promise<Organization>

list

list(): Promise<PaginationResponse<Organization>>

- Defined in account/organizations/OrganizationsApi.ts:58
Returns Promise<PaginationResponse<Organization>>

update

update(organizationId: string, updateOrganizationRequest: UpdateOrganizationRequest): Promise<Organization>

- Defined in account/organizations/OrganizationsApi.ts:71
Parameters
- organizationId: string
- Optional updateOrganizationRequest: UpdateOrganizationRequest
Returns Promise<Organization>

Generated using TypeDoc