Class DropboxesApi

DropboxesApi - object-oriented interface

export

Hierarchy

BaseAPI
- DropboxesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

createaNewSharedInbox

createaNewSharedInbox(requestParameters: DropboxesApiCreateaNewSharedInboxRequest, options?: any): Promise<AxiosResponse<DropboxesResponse>>

- Defined in api/api.ts:7449
Create a new shared inbox.

summary

Create a New Shared Inbox

throws

{RequiredError}

memberof

DropboxesApi

Parameters
- requestParameters: DropboxesApiCreateaNewSharedInboxRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<DropboxesResponse>>

deleteaSpecificSharedInbox

deleteaSpecificSharedInbox(requestParameters: DropboxesApiDeleteaSpecificSharedInboxRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:7461
Delete a specific shared inbox, specified by shared inbox ID.

summary

Delete a Specific Shared Inbox

throws

{RequiredError}

memberof

DropboxesApi

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

getInformationonaSpecificSharedInbox

getInformationonaSpecificSharedInbox(requestParameters: DropboxesApiGetInformationonaSpecificSharedInboxRequest, options?: any): Promise<AxiosResponse<DropboxesResponse>>

- Defined in api/api.ts:7473
Retrieve information on a specific shared inbox.

summary

Get Information on a Specific Shared Inbox

throws

{RequiredError}

memberof

DropboxesApi

Parameters
- requestParameters: DropboxesApiGetInformationonaSpecificSharedInboxRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<DropboxesResponse>>

getaListingofAllSharedInboxes

getaListingofAllSharedInboxes(requestParameters?: DropboxesApiGetaListingofAllSharedInboxesRequest, options?: any): Promise<AxiosResponse<DropboxesResponse[]>>

- Defined in api/api.ts:7485
Retrieve a listing of all shared inboxes.

summary

Get a Listing of All Shared Inboxes

throws

{RequiredError}

memberof

DropboxesApi

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

updateaSharedInbox

updateaSharedInbox(requestParameters: DropboxesApiUpdateaSharedInboxRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:7497
Make changes to an existing shared inbox.

summary

Update a Shared Inbox

throws

{RequiredError}

memberof

DropboxesApi

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