ExClubhouse v0.6.0 ExClubhouse.Api.LinkedFile View Source

Linked file API

Link to this section Summary

Link to this section Functions

Create a LinkedFile

Example

iex> ExClubhouse.Api.LinkedFile.create(ExClubhouse.Model.Input.LinkedFile{...})
{:ok, %ExClubhouse.Model.LinkedFile{...}}
Link to this function

delete(linked_file_public_id)

View Source
delete(integer()) :: :ok | {:error, ExClubhouse.Error.t()}

Delete a LinkedFile

## Example

iex> ExClubhouse.Api.LinkedFile.delete(1)
:ok
Link to this function

delete(session, linked_file_public_id)

View Source
delete(ExClubhouse.Session.t(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

get(linked_file_public_id)

View Source
get(integer()) ::
  {:ok, nil | ExClubhouse.Model.LinkedFile.t()}
  | {:error, ExClubhouse.Error.t()}

Get a single LinkedFile by id

Example

iex> ExClubhouse.Api.LinkedFile.get(1)
{:ok, %ExClubhouse.Model.LinkedFile{...}}
Link to this function

get(session, linked_file_public_id)

View Source

Lists all LinkedFile

Example

iex> ExClubhouse.Api.LinkedFile.list()
{:ok, [%ExClubhouse.Model.LinkedFile{...}, ...]}
Link to this function

update(linked_file_public_id, linked_file_input)

View Source

Update a LinkedFile

Example

iex> ExClubhouse.Api.LinkedFile.update(1, ExClubhouse.Model.Input.LinkedFile{...})
{:ok, %ExClubhouse.Model.LinkedFile{...}}
Link to this function

update(session, linked_file_public_id, linked_file_input)

View Source