Spatio.Api.Records (spatio_sdk v0.0.2)

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

Create a record.

Parameters

connection (Spatio.Connection): Connection to server
create_record_request (CreateRecordRequest):
opts (keyword): Optional parameters

Returns

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

create_record_type(connection, create_record_type_request, opts \\ [])

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

Create a record type (org-scoped).

Parameters

connection (Spatio.Connection): Connection to server
create_record_type_request (CreateRecordTypeRequest):
opts (keyword): Optional parameters

Returns

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

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

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

Delete a record.

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_record(connection, id, opts \\ [])

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

Fetch a record.

Parameters

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

Returns

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

list_record_types(connection, organization_id, opts \\ [])

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

List record types for an organization.

Parameters

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

Returns

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

list_records(connection, organization_id, opts \\ [])

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

List records for an organization. organization_id query param is required (handler returns 400 otherwise).

Parameters

connection (Spatio.Connection): Connection to server
organization_id (String.t):
opts (keyword): Optional parameters
- :record_type_id (String.t):
- :limit (integer()):

Returns

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

update_record(connection, id, update_record_request, opts \\ [])

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

Update a record.

Parameters

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

Returns

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

update_record_type(connection, id, update_record_type_request, opts \\ [])

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

Update a record type.

Parameters

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

Returns

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