Class OrganizationsApi

OrganizationsApi - object-oriented interface

export

Hierarchy

BaseAPI
- OrganizationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrganizationsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): OrganizationsApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns OrganizationsApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

getInformationAboutYourOrganization

getInformationAboutYourOrganization(requestParameters: OrganizationsApiGetInformationAboutYourOrganizationRequest, options?: any): Promise<AxiosResponse<OrganizationsResponse>>

- Defined in api/api.ts:9360
Retrieve information about your organization.

summary

Get Information About Your Organization

throws

{RequiredError}

memberof

OrganizationsApi

Parameters
- requestParameters: OrganizationsApiGetInformationAboutYourOrganizationRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<OrganizationsResponse>>

updateYourOrganization

updateYourOrganization(requestParameters: OrganizationsApiUpdateYourOrganizationRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:9372
Make changes to your organization. Must be an organization admin to access.

summary

Update Your Organization

throws

{RequiredError}

memberof

OrganizationsApi

Parameters
- requestParameters: OrganizationsApiUpdateYourOrganizationRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>