Class FilesApi

Constructors

constructor

new FilesApi(configuration, requestFactory?, responseProcessor?): FilesApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: FilesApiRequestFactory
- OptionalresponseProcessor: FilesApiResponseProcessor
Returns FilesApi
- Defined in codegen/files/types/PromiseAPI.ts:25

Methods

_delete

_delete(fileId, _options?): Promise<void>
Delete a file in accordance with GDPR regulations. GDPR-delete file
Parameters
- fileId: string
  ID of file to GDPR delete
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/files/types/PromiseAPI.ts:60

_deleteWithHttpInfo

_deleteWithHttpInfo(fileId, _options?): Promise<HttpInfo<void>>
Delete a file in accordance with GDPR regulations. GDPR-delete file
Parameters
- fileId: string
  ID of file to GDPR delete
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/files/types/PromiseAPI.ts:38

archiveWithHttpInfo

archiveWithHttpInfo(fileId, _options?): Promise<HttpInfo<void>>
Delete a file by ID Delete file by ID
Parameters
- fileId: string
  FileId to delete
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/files/types/PromiseAPI.ts:82

checkImport

checkImport(taskId, _options?): Promise<FileActionResponse>
Check the status of requested import. Check import status
Parameters
- taskId: string
  Import by URL task ID
- Optional_options: PromiseConfigurationOptions
Returns Promise<FileActionResponse>
- Defined in codegen/files/types/PromiseAPI.ts:148

checkImportWithHttpInfo

checkImportWithHttpInfo(taskId, _options?): Promise<HttpInfo<FileActionResponse>>
Check the status of requested import. Check import status
Parameters
- taskId: string
  Import by URL task ID
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<FileActionResponse>>
- Defined in codegen/files/types/PromiseAPI.ts:126

doSearch

doSearch(properties?, after?, before?, limit?, sort?, ids?, idLte?, idGte?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderIds?, size?, sizeLte?, sizeGte?, height?, heightLte?, heightGte?, width?, widthLte?, widthGte?, encoding?, type?, extension?, url?, isUsableInContent?, allowsAnonymousAccess?, fileMd5?, expiresAt?, expiresAtLte?, expiresAtGte?, _options?): Promise<CollectionResponseFile>
Search through files in the file manager. Does not display hidden or archived files. Search files
Parameters
- Optionalproperties: string[]
  A list of file properties to return.
- 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 files by a given field.
- Optionalids: number[]
  Search by a list of file IDs.
- OptionalidLte: number
- OptionalidGte: number
- OptionalcreatedAt: Date
  Search files by time of creation.
- OptionalcreatedAtLte: Date
  Search files by less than or equal to time of creation. Can be used with `createdAtGte` to create a range.
- OptionalcreatedAtGte: Date
  Search files by greater than or equal to time of creation. Can be used with `createdAtLte` to create a range.
- OptionalupdatedAt: Date
  Search files by time of latest updated.
- OptionalupdatedAtLte: Date
  Search files by less than or equal to time of latest update. Can be used with `updatedAtGte` to create a range.
- OptionalupdatedAtGte: Date
  Search files by greater than or equal to time of latest update. Can be used with `updatedAtLte` to create a range.
- Optionalname: string
  Search for files containing the given name.
- Optionalpath: string
  Search files by path.
- OptionalparentFolderIds: number[]
  Search files within given `folderId`.
- Optionalsize: number
  Search files by exact file size in bytes.
- OptionalsizeLte: number
  Search files by less than or equal to file size. Can be used with `sizeGte` to create a range.
- OptionalsizeGte: number
  Search files by greater than or equal to file size. Can be used with `sizeLte` to create a range.
- Optionalheight: number
  Search files by height of image or video.
- OptionalheightLte: number
  Search files by less than or equal to height of image or video. Can be used with `heightGte` to create a range.
- OptionalheightGte: number
  Search files by greater than or equal to height of image or video. Can be used with `heightLte` to create a range.
- Optionalwidth: number
  Search files by width of image or video.
- OptionalwidthLte: number
  Search files by less than or equal to width of image or video. Can be used with `widthGte` to create a range.
- OptionalwidthGte: number
  Search files by greater than or equal to width of image or video. Can be used with `widthLte` to create a range.
- Optionalencoding: string
  Search files by specified encoding.
- Optionaltype: string
  Filter by provided file type.
- Optionalextension: string
  Search files by given extension.
- Optionalurl: string
  Search by file URL.
- OptionalisUsableInContent: boolean
  If `true`, shows files that have been marked to be used in new content. If `false`, shows files that should not be used in new content.
- OptionalallowsAnonymousAccess: boolean
  Search files by access. If `true`, will show only public files. If `false`, will show only private files.
- OptionalfileMd5: string
  Search files by a specific md5 hash.
- OptionalexpiresAt: Date
  Search files by exact expires time. Time must be epoch time in milliseconds.
- OptionalexpiresAtLte: Date
  Search files by less than or equal to expires time. Can be used with `expiresAtGte` to create a range.
- OptionalexpiresAtGte: Date
  Search files by greater than or equal to expires time. Can be used with `expiresAtLte` to create a range.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseFile>
- Defined in codegen/files/types/PromiseAPI.ts:262

doSearchWithHttpInfo

doSearchWithHttpInfo(properties?, after?, before?, limit?, sort?, ids?, idLte?, idGte?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderIds?, size?, sizeLte?, sizeGte?, height?, heightLte?, heightGte?, width?, widthLte?, widthGte?, encoding?, type?, extension?, url?, isUsableInContent?, allowsAnonymousAccess?, fileMd5?, expiresAt?, expiresAtLte?, expiresAtGte?, _options?): Promise<HttpInfo<CollectionResponseFile>>
Search through files in the file manager. Does not display hidden or archived files. Search files
Parameters
- Optionalproperties: string[]
  A list of file properties to return.
- 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 files by a given field.
- Optionalids: number[]
  Search by a list of file IDs.
- OptionalidLte: number
- OptionalidGte: number
- OptionalcreatedAt: Date
  Search files by time of creation.
- OptionalcreatedAtLte: Date
  Search files by less than or equal to time of creation. Can be used with `createdAtGte` to create a range.
- OptionalcreatedAtGte: Date
  Search files by greater than or equal to time of creation. Can be used with `createdAtLte` to create a range.
- OptionalupdatedAt: Date
  Search files by time of latest updated.
- OptionalupdatedAtLte: Date
  Search files by less than or equal to time of latest update. Can be used with `updatedAtGte` to create a range.
- OptionalupdatedAtGte: Date
  Search files by greater than or equal to time of latest update. Can be used with `updatedAtLte` to create a range.
- Optionalname: string
  Search for files containing the given name.
- Optionalpath: string
  Search files by path.
- OptionalparentFolderIds: number[]
  Search files within given `folderId`.
- Optionalsize: number
  Search files by exact file size in bytes.
- OptionalsizeLte: number
  Search files by less than or equal to file size. Can be used with `sizeGte` to create a range.
- OptionalsizeGte: number
  Search files by greater than or equal to file size. Can be used with `sizeLte` to create a range.
- Optionalheight: number
  Search files by height of image or video.
- OptionalheightLte: number
  Search files by less than or equal to height of image or video. Can be used with `heightGte` to create a range.
- OptionalheightGte: number
  Search files by greater than or equal to height of image or video. Can be used with `heightLte` to create a range.
- Optionalwidth: number
  Search files by width of image or video.
- OptionalwidthLte: number
  Search files by less than or equal to width of image or video. Can be used with `widthGte` to create a range.
- OptionalwidthGte: number
  Search files by greater than or equal to width of image or video. Can be used with `widthLte` to create a range.
- Optionalencoding: string
  Search files by specified encoding.
- Optionaltype: string
  Filter by provided file type.
- Optionalextension: string
  Search files by given extension.
- Optionalurl: string
  Search by file URL.
- OptionalisUsableInContent: boolean
  If `true`, shows files that have been marked to be used in new content. If `false`, shows files that should not be used in new content.
- OptionalallowsAnonymousAccess: boolean
  Search files by access. If `true`, will show only public files. If `false`, will show only private files.
- OptionalfileMd5: string
  Search files by a specific md5 hash.
- OptionalexpiresAt: Date
  Search files by exact expires time. Time must be epoch time in milliseconds.
- OptionalexpiresAtLte: Date
  Search files by less than or equal to expires time. Can be used with `expiresAtGte` to create a range.
- OptionalexpiresAtGte: Date
  Search files by greater than or equal to expires time. Can be used with `expiresAtLte` to create a range.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseFile>>
- Defined in codegen/files/types/PromiseAPI.ts:205

getById

getById(fileId, properties?, _options?): Promise<any>
Retrieve a file by its ID. Retrieve file by ID
Parameters
- fileId: string
  ID of the desired file.
- Optionalproperties: string[]
  null
- Optional_options: PromiseConfigurationOptions
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:308

getByIdWithHttpInfo

getByIdWithHttpInfo(fileId, properties?, _options?): Promise<HttpInfo<any>>
Retrieve a file by its ID. Retrieve file by ID
Parameters
- fileId: string
  ID of the desired file.
- Optionalproperties: string[]
  null
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:285

getMetadata

getMetadata(path, properties?, _options?): Promise<FileStat>
Retrieve a file by its path. Retrieve file by path
Parameters
- path: string
  The path of the file.
- Optionalproperties: string[]
  Properties to return in the response.
- Optional_options: PromiseConfigurationOptions
Returns Promise<FileStat>
- Defined in codegen/files/types/PromiseAPI.ts:354

getMetadataWithHttpInfo

getMetadataWithHttpInfo(path, properties?, _options?): Promise<HttpInfo<FileStat>>
Retrieve a file by its path. Retrieve file by path
Parameters
- path: string
  The path of the file.
- Optionalproperties: string[]
  Properties to return in the response.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<FileStat>>
- Defined in codegen/files/types/PromiseAPI.ts:331

getSignedUrl

getSignedUrl(fileId, size?, expirationSeconds?, upscale?, _options?): Promise<SignedUrl>
Generates signed URL that allows temporary access to a private file. Get signed URL to access private file
Parameters
- fileId: string
  ID of file.
- Optionalsize:
      | "medium"
      | "thumb"
      | "icon"
      | "preview"
  For image files. This will resize the image to the desired size before sharing. Does not affect the original file, just the file served by this signed URL.
- OptionalexpirationSeconds: number
  How long in seconds the link will provide access to the file.
- Optionalupscale: boolean
  If size is provided, this will upscale the image to fit the size dimensions.
- Optional_options: PromiseConfigurationOptions
Returns Promise<SignedUrl>
- Defined in codegen/files/types/PromiseAPI.ts:404

getSignedUrlWithHttpInfo

getSignedUrlWithHttpInfo(fileId, size?, expirationSeconds?, upscale?, _options?): Promise<HttpInfo<SignedUrl>>
Generates signed URL that allows temporary access to a private file. Get signed URL to access private file
Parameters
- fileId: string
  ID of file.
- Optionalsize:
      | "medium"
      | "thumb"
      | "icon"
      | "preview"
  For image files. This will resize the image to the desired size before sharing. Does not affect the original file, just the file served by this signed URL.
- OptionalexpirationSeconds: number
  How long in seconds the link will provide access to the file.
- Optionalupscale: boolean
  If size is provided, this will upscale the image to fit the size dimensions.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<SignedUrl>>
- Defined in codegen/files/types/PromiseAPI.ts:379

importFromUrl

importFromUrl(importFromUrlInput, _options?): Promise<ImportFromUrlTaskLocator>
Asynchronously imports the file at the given URL into the file manager. Import file from URL
Parameters
- importFromUrlInput: ImportFromUrlInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<ImportFromUrlTaskLocator>
- Defined in codegen/files/types/PromiseAPI.ts:448

importFromUrlWithHttpInfo

importFromUrlWithHttpInfo(importFromUrlInput, _options?): Promise<HttpInfo<ImportFromUrlTaskLocator>>
Asynchronously imports the file at the given URL into the file manager. Import file from URL
Parameters
- importFromUrlInput: ImportFromUrlInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ImportFromUrlTaskLocator>>
- Defined in codegen/files/types/PromiseAPI.ts:426

replace

replace(fileId, file?, charsetHunch?, options?, _options?): Promise<any>
Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references. Replace file
Parameters
- fileId: string
  ID of the desired file.
- Optionalfile: HttpFile
  File data that will replace existing file in the file manager.
- OptionalcharsetHunch: string
  Character set of given file data.
- Optionaloptions: string
  JSON string representing FileReplaceOptions. Includes options to set the access and expiresAt properties, which will automatically update when the file is replaced.
- Optional_options: PromiseConfigurationOptions
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:498

replaceWithHttpInfo

replaceWithHttpInfo(fileId, file?, charsetHunch?, options?, _options?): Promise<HttpInfo<any>>
Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references. Replace file
Parameters
- fileId: string
  ID of the desired file.
- Optionalfile: HttpFile
  File data that will replace existing file in the file manager.
- OptionalcharsetHunch: string
  Character set of given file data.
- Optionaloptions: string
  JSON string representing FileReplaceOptions. Includes options to set the access and expiresAt properties, which will automatically update when the file is replaced.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:473

updateProperties

updateProperties(fileId, fileUpdateInput, _options?): Promise<any>
Update properties of file by ID. Update file properties
Parameters
- fileId: string
  ID of file to update
- fileUpdateInput: FileUpdateInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:544

updatePropertiesWithHttpInfo

updatePropertiesWithHttpInfo(fileId, fileUpdateInput, _options?): Promise<HttpInfo<any>>
Update properties of file by ID. Update file properties
Parameters
- fileId: string
  ID of file to update
- fileUpdateInput: FileUpdateInput
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:521

upload

upload(file?, folderId?, folderPath?, fileName?, charsetHunch?, options?, _options?): Promise<any>
Upload a single file with content specified in request body. Upload file
Parameters
- Optionalfile: HttpFile
  File to be uploaded.
- OptionalfolderId: string
  Either \'folderId\' or \'folderPath\' is required. folderId is the ID of the folder the file will be uploaded to.
- OptionalfolderPath: string
  Either \'folderPath\' or \'folderId\' is required. This field represents the destination folder path for the uploaded file. If a path doesn\'t exist, the system will try to create one.
- OptionalfileName: string
  Desired name for the uploaded file.
- OptionalcharsetHunch: string
  Character set of the uploaded file.
- Optionaloptions: string
  JSON string representing FileUploadOptions.
- Optional_options: PromiseConfigurationOptions
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:598

uploadWithHttpInfo

uploadWithHttpInfo(file?, folderId?, folderPath?, fileName?, charsetHunch?, options?, _options?): Promise<HttpInfo<any>>
Upload a single file with content specified in request body. Upload file
Parameters
- Optionalfile: HttpFile
  File to be uploaded.
- OptionalfolderId: string
  Either \'folderId\' or \'folderPath\' is required. folderId is the ID of the folder the file will be uploaded to.
- OptionalfolderPath: string
  Either \'folderPath\' or \'folderId\' is required. This field represents the destination folder path for the uploaded file. If a path doesn\'t exist, the system will try to create one.
- OptionalfileName: string
  Desired name for the uploaded file.
- OptionalcharsetHunch: string
  Character set of the uploaded file.
- Optionaloptions: string
  JSON string representing FileUploadOptions.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:571

Class FilesApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FilesApi

Methods

_delete

Parameters

Returns Promise<void>

_deleteWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

checkImport

Parameters

Returns Promise<FileActionResponse>

checkImportWithHttpInfo

Parameters

Returns Promise<HttpInfo<FileActionResponse>>

doSearch

Parameters

Returns Promise<CollectionResponseFile>

doSearchWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseFile>>

getById

Parameters

Returns Promise<any>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<any>>

getMetadata

Parameters

Returns Promise<FileStat>

getMetadataWithHttpInfo

Parameters

Returns Promise<HttpInfo<FileStat>>

getSignedUrl

Parameters

Returns Promise<SignedUrl>

getSignedUrlWithHttpInfo

Parameters

Returns Promise<HttpInfo<SignedUrl>>

importFromUrl

Parameters

Returns Promise<ImportFromUrlTaskLocator>

importFromUrlWithHttpInfo

Parameters

Returns Promise<HttpInfo<ImportFromUrlTaskLocator>>

replace

Parameters

Returns Promise<any>

replaceWithHttpInfo

Parameters

Returns Promise<HttpInfo<any>>

updateProperties

Parameters

Returns Promise<any>

updatePropertiesWithHttpInfo

Parameters

Returns Promise<HttpInfo<any>>

upload

Parameters

Returns Promise<any>

uploadWithHttpInfo

Parameters

Returns Promise<HttpInfo<any>>

Settings

On This Page