Class DropboxMembershipsApi

DropboxMembershipsApi - object-oriented interface

export

Hierarchy

BaseAPI
- DropboxMembershipsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addaDropboxMember

addaDropboxMember(requestParameters: DropboxMembershipsApiAddaDropboxMemberRequest, options?: any): Promise<AxiosResponse<DropboxMembershipsParams>>

- Defined in api/api.ts:6942
Add a user or group as a member of this dropbox.

summary

Add a Dropbox Member

throws

{RequiredError}

memberof

DropboxMembershipsApi

Parameters
- requestParameters: DropboxMembershipsApiAddaDropboxMemberRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<DropboxMembershipsParams>>

getDropboxMemberships

getDropboxMemberships(requestParameters?: DropboxMembershipsApiGetDropboxMembershipsRequest, options?: any): Promise<AxiosResponse<DropboxMembershipsResponse[]>>

- Defined in api/api.ts:6954
Get a listing of information about the current members of a given dropbox.

summary

get_dropbox_memberships

throws

{RequiredError}

memberof

DropboxMembershipsApi

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

getInformationonaSpecificDropboxMembership

getInformationonaSpecificDropboxMembership(requestParameters: DropboxMembershipsApiGetInformationonaSpecificDropboxMembershipRequest, options?: any): Promise<AxiosResponse<DropboxMembershipsResponse>>

- Defined in api/api.ts:6966
Get information on a specific dropbox membership.

summary

Get Information on a Specific Dropbox Membership

throws

{RequiredError}

memberof

DropboxMembershipsApi

Parameters
- requestParameters: DropboxMembershipsApiGetInformationonaSpecificDropboxMembershipRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<DropboxMembershipsResponse>>

removeaMemberfromaDropbox

removeaMemberfromaDropbox(requestParameters: DropboxMembershipsApiRemoveaMemberfromaDropboxRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:6978
Remove a direct dropbox membership. Note: If the user also has indirect membership through a group, the user will still have access to the dropbox.

summary

Remove a Member from a Dropbox

throws

{RequiredError}

memberof

DropboxMembershipsApi

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

updateaDropboxMembership

updateaDropboxMembership(requestParameters: DropboxMembershipsApiUpdateaDropboxMembershipRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:6990
Update an existing dropbox membership.

summary

Update a Dropbox Membership

throws

{RequiredError}

memberof

DropboxMembershipsApi

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