Class FoldersApi

Index

Constructors

Methods

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

Constructors

constructor

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

Methods

archiveByPath

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

archiveByPathWithHttpInfo

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

archiveWithHttpInfo

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

checkUpdateStatus

checkUpdateStatus(taskId, _options?): Promise<FolderActionResponse>
Check status of folder update. Folder updates happen asynchronously. Check folder update status
Parameters
- taskId: string
  The ID of the folder update task.
- Optional_options: PromiseConfigurationOptions
Returns Promise<FolderActionResponse>
- Defined in codegen/files/types/PromiseAPI.ts:749

checkUpdateStatusWithHttpInfo

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

create

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

createWithHttpInfo

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

doSearch

doSearch(properties?, after?, before?, limit?, sort?, ids?, idLte?, idGte?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderIds?, _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
  Offset search results by this value. The default offset is 0 and the maximum offset of items for a given search is 10,000. Narrow your search down if you are reaching this limit.
- Optionalbefore: string
- Optionallimit: number
  Number of items to return. Default limit is 10, maximum limit is 100.
- Optionalsort: string[]
  Sort results by given property. For example -name sorts by name field descending, name sorts by name field ascending.
- Optionalids: number[]
- OptionalidLte: number
- OptionalidGte: number
- OptionalcreatedAt: Date
  Search folders by exact time of creation. Time must be epoch time in milliseconds.
- OptionalcreatedAtLte: Date
  Search folders by less than or equal to time of creation. Can be used with createdAtGte to create a range.
- OptionalcreatedAtGte: Date
  Search folders by greater than or equal to time of creation. Can be used with createdAtLte to create a range.
- OptionalupdatedAt: Date
  Search folders by exact time of latest updated. Time must be epoch time in milliseconds.
- OptionalupdatedAtLte: Date
  Search folders by less than or equal to time of latest update. Can be used with updatedAtGte to create a range.
- OptionalupdatedAtGte: Date
  Search folders by greater than or equal to time of latest update. Can be used with updatedAtLte to create a range.
- Optionalname: string
  Search for folders containing the specified name.
- Optionalpath: string
  Search folders by path.
- OptionalparentFolderIds: number[]
  Search folders with the given parent folderId.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseFolder>
- Defined in codegen/files/types/PromiseAPI.ts:869

doSearchWithHttpInfo

doSearchWithHttpInfo(properties?, after?, before?, limit?, sort?, ids?, idLte?, idGte?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderIds?, _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
  Offset search results by this value. The default offset is 0 and the maximum offset of items for a given search is 10,000. Narrow your search down if you are reaching this limit.
- Optionalbefore: string
- Optionallimit: number
  Number of items to return. Default limit is 10, maximum limit is 100.
- Optionalsort: string[]
  Sort results by given property. For example -name sorts by name field descending, name sorts by name field ascending.
- Optionalids: number[]
- OptionalidLte: number
- OptionalidGte: number
- OptionalcreatedAt: Date
  Search folders by exact time of creation. Time must be epoch time in milliseconds.
- OptionalcreatedAtLte: Date
  Search folders by less than or equal to time of creation. Can be used with createdAtGte to create a range.
- OptionalcreatedAtGte: Date
  Search folders by greater than or equal to time of creation. Can be used with createdAtLte to create a range.
- OptionalupdatedAt: Date
  Search folders by exact time of latest updated. Time must be epoch time in milliseconds.
- OptionalupdatedAtLte: Date
  Search folders by less than or equal to time of latest update. Can be used with updatedAtGte to create a range.
- OptionalupdatedAtGte: Date
  Search folders by greater than or equal to time of latest update. Can be used with updatedAtLte to create a range.
- Optionalname: string
  Search for folders containing the specified name.
- Optionalpath: string
  Search folders by path.
- OptionalparentFolderIds: number[]
  Search folders with the given parent folderId.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseFolder>>
- Defined in codegen/files/types/PromiseAPI.ts:831

getById

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

getByIdWithHttpInfo

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

getByPath

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

getByPathWithHttpInfo

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

updateProperties

updateProperties(folderId, folderUpdateInput, _options?): Promise<Folder>
Update a folder's properties, identified by folder ID. Update folder properties by folder ID
Parameters
- folderId: string
  ID of folder to update
- folderUpdateInput: FolderUpdateInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<Folder>
- Defined in codegen/files/types/PromiseAPI.ts:1007

updatePropertiesRecursively

updatePropertiesRecursively(folderUpdateInputWithId, _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
- folderUpdateInputWithId: FolderUpdateInputWithId
- Optional_options: PromiseConfigurationOptions
Returns Promise<FolderUpdateTaskLocator>
- Defined in codegen/files/types/PromiseAPI.ts:1051

updatePropertiesRecursivelyWithHttpInfo

updatePropertiesRecursivelyWithHttpInfo(folderUpdateInputWithId, _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
- folderUpdateInputWithId: FolderUpdateInputWithId
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<FolderUpdateTaskLocator>>
- Defined in codegen/files/types/PromiseAPI.ts:1029

updatePropertiesWithHttpInfo

updatePropertiesWithHttpInfo(folderId, folderUpdateInput, _options?): Promise<HttpInfo<Folder>>
Update a folder's properties, identified by folder ID. Update folder properties by folder ID
Parameters
- folderId: string
  ID of folder to update
- folderUpdateInput: FolderUpdateInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<Folder>>
- Defined in codegen/files/types/PromiseAPI.ts:984

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<Folder>

updatePropertiesRecursively

Parameters

Returns Promise<FolderUpdateTaskLocator>

updatePropertiesRecursivelyWithHttpInfo

Parameters

Returns Promise<HttpInfo<FolderUpdateTaskLocator>>

updatePropertiesWithHttpInfo

Parameters

Returns Promise<HttpInfo<Folder>>

Settings

On This Page