Polarex.Files (Polarex v0.2.3)

View Source

Provides API endpoints related to files

Summary

Functions

files_create(body, opts \\ [])

Create File

Create a file.

Scopes: files:write

files_delete(id, opts \\ [])

@spec files_delete(
  String.t(),
  keyword()
) ::
  :ok
  | {:error,
     Polarex.HTTPValidationError.t()
     | Polarex.NotPermitted.t()
     | Polarex.ResourceNotFound.t()}

Delete File

Delete a file.

Scopes: files:write

files_list(opts \\ [])

@spec files_list(keyword()) ::
  {:ok, Polarex.ListResourceFileRead.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Files

List files.

Scopes: files:read files:write

Options

  • organization_id: Filter by organization ID.
  • ids: Filter by file ID.
  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.

files_update(id, body, opts \\ [])

Update File

Update a file.

Scopes: files:write

files_uploaded(id, body, opts \\ [])

Complete File Upload

Complete a file upload.

Scopes: files:write