Class FoldersApi

Index

Constructors

Methods

archive archiveByPath archiveByPathWithHttpInfo archiveWithHttpInfo checkUpdateStatus checkUpdateStatusWithHttpInfo create createWithHttpInfo doSearch doSearchWithHttpInfo getById getByIdWithHttpInfo getByPath getByPathWithHttpInfo updateProperties updatePropertiesWithHttpInfo

Constructors

constructor

new FoldersApi(configuration, requestFactory?, responseProcessor?): FoldersApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: FoldersApiRequestFactory
- OptionalresponseProcessor: FoldersApiResponseProcessor
Returns FoldersApi
- Defined in codegen/files/types/PromiseAPI.ts:332

Methods

archiveByPath

archiveByPath(folderPath, _options?): Promise<void>
Delete folder by path. Delete folder.
Parameters
- folderPath: string
  Path of folder to delete
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/files/types/PromiseAPI.ts:375

archiveByPathWithHttpInfo

archiveByPathWithHttpInfo(folderPath, _options?): Promise<HttpInfo<void>>
Delete folder by path. Delete folder.
Parameters
- folderPath: string
  Path of folder to delete
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/files/types/PromiseAPI.ts:365

archiveWithHttpInfo

archiveWithHttpInfo(folderId, _options?): Promise<HttpInfo<void>>
Delete folder by ID. Delete folder.
Parameters
- folderId: string
  ID of folder to delete.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/files/types/PromiseAPI.ts:345

checkUpdateStatus

checkUpdateStatus(taskId, _options?): Promise<FolderActionResponse>
Check status of folder update. Folder updates happen asynchronously. Check folder update status.
Parameters
- taskId: string
  TaskId of folder update
- Optional_options: Configuration
Returns Promise<FolderActionResponse>
- Defined in codegen/files/types/PromiseAPI.ts:395

checkUpdateStatusWithHttpInfo

checkUpdateStatusWithHttpInfo(taskId, _options?): Promise<HttpInfo<FolderActionResponse>>
Check status of folder update. Folder updates happen asynchronously. Check folder update status.
Parameters
- taskId: string
  TaskId of folder update
- Optional_options: Configuration
Returns Promise<HttpInfo<FolderActionResponse>>
- Defined in codegen/files/types/PromiseAPI.ts:385

create

create(folderInput, _options?): Promise<Folder>
Creates a folder. Create folder.
Parameters
- folderInput: FolderInput
  Folder creation options
- Optional_options: Configuration
Returns Promise<Folder>
- Defined in codegen/files/types/PromiseAPI.ts:415

createWithHttpInfo

createWithHttpInfo(folderInput, _options?): Promise<HttpInfo<Folder>>
Creates a folder. Create folder.
Parameters
- folderInput: FolderInput
  Folder creation options
- Optional_options: Configuration
Returns Promise<HttpInfo<Folder>>
- Defined in codegen/files/types/PromiseAPI.ts:405

doSearch

doSearch(properties?, after?, before?, limit?, sort?, id?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderId?, _options?): Promise<CollectionResponseFolder>
Search for folders. Does not contain hidden or archived folders. Search folders
Parameters
- Optionalproperties: string[]
  Properties that should be included in the returned folders.
- Optionalafter: string
  The maximum offset of items for a given search is 10000. Narrow your search down if you are reaching this limit.
- Optionalbefore: string
- Optionallimit: number
  Limit of results to return. Max limit is 100.
- Optionalsort: string[]
  Sort results by given property. For example -name sorts by name field descending, name sorts by name field ascending.
- Optionalid: string
  Search folder by given ID.
- OptionalcreatedAt: Date
  Search for folders with the given creation timestamp.
- OptionalcreatedAtLte: Date
- OptionalcreatedAtGte: Date
- OptionalupdatedAt: Date
  Search for folder at given update timestamp.
- OptionalupdatedAtLte: Date
- OptionalupdatedAtGte: Date
- Optionalname: string
  Search for folders containing the specified name.
- Optionalpath: string
  Search for folders by path.
- OptionalparentFolderId: number
  Search for folders with the given parent folderId.
- Optional_options: Configuration
Returns Promise<CollectionResponseFolder>
- Defined in codegen/files/types/PromiseAPI.ts:463

doSearchWithHttpInfo

doSearchWithHttpInfo(properties?, after?, before?, limit?, sort?, id?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderId?, _options?): Promise<HttpInfo<CollectionResponseFolder>>
Search for folders. Does not contain hidden or archived folders. Search folders
Parameters
- Optionalproperties: string[]
  Properties that should be included in the returned folders.
- Optionalafter: string
  The maximum offset of items for a given search is 10000. Narrow your search down if you are reaching this limit.
- Optionalbefore: string
- Optionallimit: number
  Limit of results to return. Max limit is 100.
- Optionalsort: string[]
  Sort results by given property. For example -name sorts by name field descending, name sorts by name field ascending.
- Optionalid: string
  Search folder by given ID.
- OptionalcreatedAt: Date
  Search for folders with the given creation timestamp.
- OptionalcreatedAtLte: Date
- OptionalcreatedAtGte: Date
- OptionalupdatedAt: Date
  Search for folder at given update timestamp.
- OptionalupdatedAtLte: Date
- OptionalupdatedAtGte: Date
- Optionalname: string
  Search for folders containing the specified name.
- Optionalpath: string
  Search for folders by path.
- OptionalparentFolderId: number
  Search for folders with the given parent folderId.
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseFolder>>
- Defined in codegen/files/types/PromiseAPI.ts:439

getById

getById(folderId, properties?, _options?): Promise<Folder>
Get folder by ID Get folder
Parameters
- folderId: string
  ID of desired folder
- Optionalproperties: string[]
  Properties to set on returned folder.
- Optional_options: Configuration
Returns Promise<Folder>
- Defined in codegen/files/types/PromiseAPI.ts:485

getByIdWithHttpInfo

getByIdWithHttpInfo(folderId, properties?, _options?): Promise<HttpInfo<Folder>>
Get folder by ID Get folder
Parameters
- folderId: string
  ID of desired folder
- Optionalproperties: string[]
  Properties to set on returned folder.
- Optional_options: Configuration
Returns Promise<HttpInfo<Folder>>
- Defined in codegen/files/types/PromiseAPI.ts:474

getByPath

getByPath(folderPath, properties?, _options?): Promise<Folder>
Get folder by path. Get folder.
Parameters
- folderPath: string
  Path of desired folder.
- Optionalproperties: string[]
  Properties to set on returned folder.
- Optional_options: Configuration
Returns Promise<Folder>
- Defined in codegen/files/types/PromiseAPI.ts:507

getByPathWithHttpInfo

getByPathWithHttpInfo(folderPath, properties?, _options?): Promise<HttpInfo<Folder>>
Get folder by path. Get folder.
Parameters
- folderPath: string
  Path of desired folder.
- Optionalproperties: string[]
  Properties to set on returned folder.
- Optional_options: Configuration
Returns Promise<HttpInfo<Folder>>
- Defined in codegen/files/types/PromiseAPI.ts:496

updateProperties

updateProperties(folderUpdateInput, _options?): Promise<FolderUpdateTaskLocator>
Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well. Update folder properties
Parameters
- folderUpdateInput: FolderUpdateInput
  Properties to change in the folder
- Optional_options: Configuration
Returns Promise<FolderUpdateTaskLocator>
- Defined in codegen/files/types/PromiseAPI.ts:527

updatePropertiesWithHttpInfo

updatePropertiesWithHttpInfo(folderUpdateInput, _options?): Promise<HttpInfo<FolderUpdateTaskLocator>>
Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well. Update folder properties
Parameters
- folderUpdateInput: FolderUpdateInput
  Properties to change in the folder
- Optional_options: Configuration
Returns Promise<HttpInfo<FolderUpdateTaskLocator>>
- Defined in codegen/files/types/PromiseAPI.ts:517

Class FoldersApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FoldersApi

Methods

archive

Parameters

Returns Promise<void>

archiveByPath

Parameters

Returns Promise<void>

archiveByPathWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

checkUpdateStatus

Parameters

Returns Promise<FolderActionResponse>

checkUpdateStatusWithHttpInfo

Parameters

Returns Promise<HttpInfo<FolderActionResponse>>

create

Parameters

Returns Promise<Folder>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<Folder>>

doSearch

Parameters

Returns Promise<CollectionResponseFolder>

doSearchWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseFolder>>

getById

Parameters

Returns Promise<Folder>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<Folder>>

getByPath

Parameters

Returns Promise<Folder>

getByPathWithHttpInfo

Parameters

Returns Promise<HttpInfo<Folder>>

updateProperties

Parameters

Returns Promise<FolderUpdateTaskLocator>

updatePropertiesWithHttpInfo

Parameters

Returns Promise<HttpInfo<FolderUpdateTaskLocator>>

Settings

On This Page