OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocssoundsFormat View Source

API calls for all endpoints tagged ApiDocssoundsFormat.

Link to this section Summary

Link to this section Functions

Link to this function get(connection, sound_id, opts \\ []) View Source
get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get a sound's details.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • sound_id (String.t): Sound's id
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function list(connection, opts \\ []) View Source
list(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

List all sounds.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :lang (String.t): Lookup sound for a specific language.
    • :format (String.t): Lookup sound in a specific format.

Returns

{:ok, %{}} on success {:error, info} on failure