Files
Files API operations.
Summary
Functions
@spec complete_file_upload(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.DownloadableFileRead.t()} | {:error, PolarExpress.Error.t()}
Complete File Upload
Complete a file upload.
Scopes: files:write
See PolarExpress.Params.FilesCompleteFileUploadParams for parameter details.
@spec create_file(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.FileUpload.t()} | {:error, PolarExpress.Error.t()}
Create File
Create a file.
Scopes: files:write
See PolarExpress.Params.FilesCreateFileParams for parameter details.
@spec delete_file(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, PolarExpress.Error.t()}
Delete File
Delete a file.
Scopes: files:write
See PolarExpress.Params.FilesDeleteFileParams for parameter details.
@spec list_files(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.ListResource_FileRead_.t()} | {:error, PolarExpress.Error.t()}
List Files
List files.
Scopes: files:read files:write
See PolarExpress.Params.FilesListFilesParams for parameter details.
@spec update_file(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.DownloadableFileRead.t()} | {:error, PolarExpress.Error.t()}
Update File
Update a file.
Scopes: files:write
See PolarExpress.Params.FilesUpdateFileParams for parameter details.