ESPRMAdminFile
Defined in: src/ESPRMAdminFile.ts:11
Shell class for admin file upload management operations. Methods are added via prototype augmentation in methods/ESPRMAdminFile/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminFile():
ESPRMAdminFile
Returns
Section titled “Returns”ESPRMAdminFile
Methods
Section titled “Methods”confirmUpload()
Section titled “confirmUpload()”confirmUpload(
params):Promise<ConfirmFileUploadResponse>
Defined in: src/methods/ESPRMAdminFile/ConfirmUpload.ts:27
Confirms that a file upload has completed successfully.
Parameters
Section titled “Parameters”params
Section titled “params”The file ID of the uploaded file to confirm.
Returns
Section titled “Returns”Promise<ConfirmFileUploadResponse>
The confirmation response with final file details.
getFiles()
Section titled “getFiles()”getFiles(
params?):Promise<GetFilesResponse>
Defined in: src/methods/ESPRMAdminFile/GetFiles.ts:22
Retrieves the list of uploaded files with optional filtering and pagination.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter or paginate files.
Returns
Section titled “Returns”Promise<GetFilesResponse>
The list of files matching the query.
getUploadUrl()
Section titled “getUploadUrl()”getUploadUrl(
params):Promise<FileUploadUrlResponse>
Defined in: src/methods/ESPRMAdminFile/GetUploadUrl.ts:27
Retrieves a pre-signed URL for uploading a file.
Parameters
Section titled “Parameters”params
Section titled “params”The file name and optional metadata for the upload.
Returns
Section titled “Returns”Promise<FileUploadUrlResponse>
The pre-signed upload URL and file details.