Class FilesApi

Constructors

constructor

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

Methods

archiveGDPR

archiveGDPR(fileId, _options?): Promise<void>
GDRP delete file GDPR delete
Parameters
- fileId: string
  ID of file to GDPR delete
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/files/types/PromiseAPI.ts:66

archiveGDPRWithHttpInfo

archiveGDPRWithHttpInfo(fileId, _options?): Promise<HttpInfo<void>>
GDRP delete file GDPR delete
Parameters
- fileId: string
  ID of file to GDPR delete
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/files/types/PromiseAPI.ts:56

archiveWithHttpInfo

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

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: Configuration
Returns Promise<FileActionResponse>
- Defined in codegen/files/types/PromiseAPI.ts:86

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: Configuration
Returns Promise<HttpInfo<FileActionResponse>>
- Defined in codegen/files/types/PromiseAPI.ts:76

doSearch

doSearch(properties?, after?, before?, limit?, sort?, id?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderId?, size?, height?, width?, encoding?, type?, extension?, url?, isUsableInContent?, allowsAnonymousAccess?, _options?): Promise<CollectionResponseFile>
Search through files in the file manager. Does not display hidden or archived files. Search files
Parameters
- Optionalproperties: string[]
  Desired file properties in the return object.
- 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
  Number of items to return. Maximum limit is 100.
- Optionalsort: string[]
  Sort files by a given field.
- Optionalid: string
  Search files by given ID.
- OptionalcreatedAt: Date
  Search files by time of creation.
- OptionalcreatedAtLte: Date
- OptionalcreatedAtGte: Date
- OptionalupdatedAt: Date
  Search files by time of latest updated.
- OptionalupdatedAtLte: Date
- OptionalupdatedAtGte: Date
- Optionalname: string
  Search for files containing the given name.
- Optionalpath: string
  Search files by path.
- OptionalparentFolderId: number
  Search files within given folderId.
- Optionalsize: number
  Query by file size.
- Optionalheight: number
  Search files by height of image or video.
- Optionalwidth: number
  Search files by width of image or video.
- Optionalencoding: string
  Search files with specified encoding.
- Optionaltype: string
  Filter by provided file type.
- Optionalextension: string
  Search files by given extension.
- Optionalurl: string
  Search for given URL
- OptionalisUsableInContent: boolean
  If true shows files that have been marked to be used in new content. It false shows files that should not be used in new content.
- OptionalallowsAnonymousAccess: boolean
  If 'true' will show private files; if 'false' will show public files
- Optional_options: Configuration
Returns Promise<CollectionResponseFile>
- Defined in codegen/files/types/PromiseAPI.ts:152

doSearchWithHttpInfo

doSearchWithHttpInfo(properties?, after?, before?, limit?, sort?, id?, createdAt?, createdAtLte?, createdAtGte?, updatedAt?, updatedAtLte?, updatedAtGte?, name?, path?, parentFolderId?, size?, height?, width?, encoding?, type?, extension?, url?, isUsableInContent?, allowsAnonymousAccess?, _options?): Promise<HttpInfo<CollectionResponseFile>>
Search through files in the file manager. Does not display hidden or archived files. Search files
Parameters
- Optionalproperties: string[]
  Desired file properties in the return object.
- 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
  Number of items to return. Maximum limit is 100.
- Optionalsort: string[]
  Sort files by a given field.
- Optionalid: string
  Search files by given ID.
- OptionalcreatedAt: Date
  Search files by time of creation.
- OptionalcreatedAtLte: Date
- OptionalcreatedAtGte: Date
- OptionalupdatedAt: Date
  Search files by time of latest updated.
- OptionalupdatedAtLte: Date
- OptionalupdatedAtGte: Date
- Optionalname: string
  Search for files containing the given name.
- Optionalpath: string
  Search files by path.
- OptionalparentFolderId: number
  Search files within given folderId.
- Optionalsize: number
  Query by file size.
- Optionalheight: number
  Search files by height of image or video.
- Optionalwidth: number
  Search files by width of image or video.
- Optionalencoding: string
  Search files with specified encoding.
- Optionaltype: string
  Filter by provided file type.
- Optionalextension: string
  Search files by given extension.
- Optionalurl: string
  Search for given URL
- OptionalisUsableInContent: boolean
  If true shows files that have been marked to be used in new content. It false shows files that should not be used in new content.
- OptionalallowsAnonymousAccess: boolean
  If 'true' will show private files; if 'false' will show public files
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseFile>>
- Defined in codegen/files/types/PromiseAPI.ts:119

getById

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

getByIdWithHttpInfo

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

getMetadata

getMetadata(path, properties?, _options?): Promise<FileStat>
Parameters
- path: string
- Optionalproperties: string[]
- Optional_options: Configuration
Returns Promise<FileStat>
- Defined in codegen/files/types/PromiseAPI.ts:192

getMetadataWithHttpInfo

getMetadataWithHttpInfo(path, properties?, _options?): Promise<HttpInfo<FileStat>>
Parameters
- path: string
- Optionalproperties: string[]
- Optional_options: Configuration
Returns Promise<HttpInfo<FileStat>>
- Defined in codegen/files/types/PromiseAPI.ts:183

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: Configuration
Returns Promise<SignedUrl>
- Defined in codegen/files/types/PromiseAPI.ts:218

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: Configuration
Returns Promise<HttpInfo<SignedUrl>>
- Defined in codegen/files/types/PromiseAPI.ts:205

importFromUrl

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

importFromUrlWithHttpInfo

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

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
- Optional_options: Configuration
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:264

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
- Optional_options: Configuration
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:251

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
  Options to update.
- Optional_options: Configuration
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:286

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
  Options to update.
- Optional_options: Configuration
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:275

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: Configuration
Returns Promise<any>
- Defined in codegen/files/types/PromiseAPI.ts:316

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: Configuration
Returns Promise<HttpInfo<any>>
- Defined in codegen/files/types/PromiseAPI.ts:301

Class FilesApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FilesApi

Methods

archive

Parameters

Returns Promise<void>

archiveGDPR

Parameters

Returns Promise<void>

archiveGDPRWithHttpInfo

Parameters

Returns Promise<HttpInfo<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