Class OrganizationsApi

OrganizationsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- OrganizationsApi

Index

Constructors

constructor

new OrganizationsApi(configuration?, basePath?, axios?): OrganizationsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns OrganizationsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

organizationsCreate

organizationsCreate(requestParameters, options?): Promise<AxiosResponse<OrganizationRead, any>>
Parameters
- requestParameters: OrganizationsApiOrganizationsCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OrganizationRead, any>>

Summary
Method creates an organization

Throws

Memberof
OrganizationsApi
- Defined in api-client/organizations-api.ts:600

organizationsDestroy

organizationsDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: OrganizationsApiOrganizationsDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes an organization

Throws

Memberof
OrganizationsApi
- Defined in api-client/organizations-api.ts:612

organizationsList

organizationsList(requestParameters?, options?): Promise<AxiosResponse<PaginatedOrganizationReadList, any>>
Parameters
- requestParameters: OrganizationsApiOrganizationsListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedOrganizationReadList, any>>

Summary
Method returns a paginated list of organizations

Throws

Memberof
OrganizationsApi
- Defined in api-client/organizations-api.ts:624

organizationsPartialUpdate

organizationsPartialUpdate(requestParameters, options?): Promise<AxiosResponse<OrganizationRead, any>>
Parameters
- requestParameters: OrganizationsApiOrganizationsPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OrganizationRead, any>>

Summary
Methods does a partial update of chosen fields in an organization

Throws

Memberof
OrganizationsApi
- Defined in api-client/organizations-api.ts:636

organizationsRetrieve

organizationsRetrieve(requestParameters, options?): Promise<AxiosResponse<OrganizationRead, any>>
Parameters
- requestParameters: OrganizationsApiOrganizationsRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<OrganizationRead, any>>

Summary
Method returns details of an organization

Throws

Memberof
OrganizationsApi
- Defined in api-client/organizations-api.ts:648

Class OrganizationsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns OrganizationsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

organizationsCreate

Parameters

requestParameters: OrganizationsApiOrganizationsCreateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<OrganizationRead, any>>

Summary

Throws

Memberof

organizationsDestroy

Parameters

requestParameters: OrganizationsApiOrganizationsDestroyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

organizationsList

Parameters

requestParameters: OrganizationsApiOrganizationsListRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedOrganizationReadList, any>>

Summary

Throws

Memberof

organizationsPartialUpdate

Parameters

requestParameters: OrganizationsApiOrganizationsPartialUpdateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<OrganizationRead, any>>

Summary

Throws

Memberof

organizationsRetrieve

Parameters

requestParameters: OrganizationsApiOrganizationsRetrieveRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<OrganizationRead, any>>

Summary

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>