Spatio.Api.Routines (spatio_sdk v0.0.2)

@spec claim_routine_run(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Spatio.Model.RoutineRun.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Worker claims a queued run.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.RoutineRun.t} on success
{:error, Tesla.Env.t} on failure

complete_routine_run(connection, id, routine_run_complete_request, opts \\ [])

@spec complete_routine_run(
  Tesla.Env.client(),
  String.t(),
  Spatio.Model.RoutineRunCompleteRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.RoutineRun.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Worker marks a run complete.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
routine_run_complete_request (RoutineRunCompleteRequest):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.RoutineRun.t} on success
{:error, Tesla.Env.t} on failure

create_routine(connection, create_routine_request, opts \\ [])

@spec create_routine(
  Tesla.Env.client(),
  Spatio.Model.CreateRoutineRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.ApiError.t()}
  | {:ok, Spatio.Model.Routine.t()}
  | {:error, Tesla.Env.t()}

Create a routine.

Parameters

connection (Spatio.Connection): Connection to server
create_routine_request (CreateRoutineRequest):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.Routine.t} on success
{:error, Tesla.Env.t} on failure

delete_routine(connection, id, opts \\ [])

@spec delete_routine(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Delete a routine.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

get_routine(connection, id, opts \\ [])

@spec get_routine(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Spatio.Model.ApiError.t()}
  | {:ok, Spatio.Model.Routine.t()}
  | {:error, Tesla.Env.t()}

Fetch a routine.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.Routine.t} on success
{:error, Tesla.Env.t} on failure

list_routine_runs(connection, id, opts \\ [])

@spec list_routine_runs(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Spatio.Model.RoutineRunListResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List runs for a routine.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.RoutineRunListResponse.t} on success
{:error, Tesla.Env.t} on failure

list_routines(connection, opts \\ [])

@spec list_routines(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Spatio.Model.RoutineListResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List routines for the caller's workspace.

Parameters

connection (Spatio.Connection): Connection to server
opts (keyword): Optional parameters
- :workspaceId (String.t):
- :status (String.t):

Returns

{:ok, Spatio.Model.RoutineListResponse.t} on success
{:error, Tesla.Env.t} on failure

run_routine_now(connection, id, opts \\ [])

@spec run_routine_now(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Spatio.Model.RoutineRun.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Trigger an ad-hoc run.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.RoutineRun.t} on success
{:error, Tesla.Env.t} on failure

update_routine(connection, id, update_routine_request, opts \\ [])

@spec update_routine(
  Tesla.Env.client(),
  String.t(),
  Spatio.Model.UpdateRoutineRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.ApiError.t()}
  | {:ok, Spatio.Model.Routine.t()}
  | {:error, Tesla.Env.t()}

Update a routine.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
update_routine_request (UpdateRoutineRequest):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.Routine.t} on success
{:error, Tesla.Env.t} on failure

update_routine_run_progress(connection, id, routine_run_progress_request, opts \\ [])

@spec update_routine_run_progress(
  Tesla.Env.client(),
  String.t(),
  Spatio.Model.RoutineRunProgressRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.RoutineRun.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Worker reports progress.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
routine_run_progress_request (RoutineRunProgressRequest):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.RoutineRun.t} on success
{:error, Tesla.Env.t} on failure