Class WorkspacesApi

WorkspacesApi - object-oriented interface

export

Hierarchy

BaseAPI
- WorkspacesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addWorkspace

addWorkspace(requestParameters: WorkspacesApiAddWorkspaceRequest, options?: any): Promise<AxiosResponse<WorkspacesResponse>>

- Defined in api/api.ts:12026
Create a new workspace.

summary

add_workspace

throws

{RequiredError}

memberof

WorkspacesApi

Parameters
- requestParameters: WorkspacesApiAddWorkspaceRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<WorkspacesResponse>>

deleteWorkspace

deleteWorkspace(requestParameters: WorkspacesApiDeleteWorkspaceRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:12038
Delete a specific workspace, specified by workspace ID.

summary

delete_workspace

throws

{RequiredError}

memberof

WorkspacesApi

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

getWorkspaceById

getWorkspaceById(requestParameters: WorkspacesApiGetWorkspaceByIdRequest, options?: any): Promise<AxiosResponse<WorkspacesResponse>>

- Defined in api/api.ts:12050
Retrieve information on a specific workspace.

summary

get_workspace_by_id

throws

{RequiredError}

memberof

WorkspacesApi

Parameters
- requestParameters: WorkspacesApiGetWorkspaceByIdRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<WorkspacesResponse>>

getWorkspaces

getWorkspaces(requestParameters?: WorkspacesApiGetWorkspacesRequest, options?: any): Promise<AxiosResponse<WorkspacesResponse[]>>

- Defined in api/api.ts:12062
Retrieve a listing of all configured workspaces.

summary

get_workspaces

throws

{RequiredError}

memberof

WorkspacesApi

Parameters
- requestParameters: WorkspacesApiGetWorkspacesRequest = {}
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<WorkspacesResponse[]>>

updateWorkspace

updateWorkspace(requestParameters: WorkspacesApiUpdateWorkspaceRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:12074
Make changes to an existing workspace; for example, change collaboration settings.

summary

update_workspace

throws

{RequiredError}

memberof

WorkspacesApi

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