Spatio.Api.Resources (spatio_sdk v0.0.2)

API calls for all endpoints tagged Resources.

Summary

Functions

list_resource_permission_grants(connection, platform, resource_id, opts \\ [])

List access grants on a resource (per-resource ACL).

revoke_resource_permission_grant(connection, platform, resource_id, grant_id, opts \\ [])

Revoke an access grant.

set_resource_permission_grant(connection, platform, resource_id, request_body, opts \\ [])

Create or update an access grant.

Functions

list_resource_permission_grants(connection, platform, resource_id, opts \\ [])

@spec list_resource_permission_grants(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List access grants on a resource (per-resource ACL).

Parameters

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

Returns

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

revoke_resource_permission_grant(connection, platform, resource_id, grant_id, opts \\ [])

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

Revoke an access grant.

Parameters

connection (Spatio.Connection): Connection to server
platform (String.t):
resource_id (String.t):
grant_id (String.t):
opts (keyword): Optional parameters

Returns

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

set_resource_permission_grant(connection, platform, resource_id, request_body, opts \\ [])

@spec set_resource_permission_grant(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Create or update an access grant.

Parameters

connection (Spatio.Connection): Connection to server
platform (String.t):
resource_id (String.t):
request_body (%{optional(String.t) => any()}):
opts (keyword): Optional parameters

Returns

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