Search documentation of polar_express

# PolarExpress.Services.FilesService (polar_express v0.1.5)

Copy Markdown View Source

Files

Files API operations.

## Summary

### Functions

complete_file_upload(client, id, params \\ %{}, opts \\ [])

Complete File Upload

create_file(client, params \\ %{}, opts \\ [])

Create File

delete_file(client, id, params \\ %{}, opts \\ [])

Delete File

list_files(client, params \\ %{}, opts \\ [])

List Files

update_file(client, id, params \\ %{}, opts \\ [])

Update File

## Functions

# complete_file_upload(client, id, params \\ %{}, opts \\ [])

    @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.

# create_file(client, params \\ %{}, opts \\ [])

    @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.

# delete_file(client, id, params \\ %{}, opts \\ [])

    @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.

# list_files(client, params \\ %{}, opts \\ [])

    @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.

# update_file(client, id, params \\ %{}, opts \\ [])

    @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.