Package version:

Interface FilesOperations

Interface representing a Files operations.

interface FilesOperations {
    delete: ((fileId: string, options?: FilesDeleteFileOptionalParams) => Promise<FileDeletionStatus>);
    get: ((fileId: string, options?: FilesGetFileOptionalParams) => Promise<FileInfo>);
    getContent: ((fileId: string, options?: FilesGetFileContentOptionalParams) => StreamableMethod<any>);
    list: ((options?: FilesListFilesOptionalParams) => Promise<FileListResponse>);
    upload: ((file: any, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => Promise<FileInfo>);
    uploadAndPoll: ((file: any, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => PollerLike<OperationState<FileInfo>, FileInfo>);
}

Index

Properties

delete get getContent list upload uploadAndPoll

Properties

delete

delete: ((fileId: string, options?: FilesDeleteFileOptionalParams) => Promise<FileDeletionStatus>)

Delete a previously uploaded file.

get

get: ((fileId: string, options?: FilesGetFileOptionalParams) => Promise<FileInfo>)

Returns information about a specific file. Does not retrieve file content.

getContent

getContent: ((fileId: string, options?: FilesGetFileContentOptionalParams) => StreamableMethod<any>)

Retrieves the raw content of a specific file.

list

list: ((options?: FilesListFilesOptionalParams) => Promise<FileListResponse>)

Gets a list of previously uploaded files.

upload

upload: ((file: any, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => Promise<FileInfo>)

Uploads a file for use by other operations.

uploadAndPoll

uploadAndPoll: ((file: any, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => PollerLike<OperationState<FileInfo>, FileInfo>)

Uploads a file for use by other operations with polling