Spatio.Api.Workspaces (spatio_sdk v0.0.2)

API calls for all endpoints tagged Workspaces.

Summary

Functions

accept_workspace_invitation(connection, token, opts \\ [])

Accept a workspace invitation by token. The signed-in user's email must match the invitation. Organization-token accept lives at POST /v1/organizations/{org}/accept-invitation.

add_workspace_member(connection, workspace_id, add_workspace_member_request, opts \\ [])

Add a member directly (skips invitation flow).

create_workspace(connection, create_workspace_request, opts \\ [])

Create a workspace. Requires organizationId in the body — bare "personal" workspaces aren't supported on the public API.

create_workspace_invitation(connection, workspace_id, create_workspace_invitation_request, opts \\ [])

Invite a user to a workspace.

get_public_invitation(connection, token, opts \\ [])

Fetch invitation details by token (unauthenticated). Used by the renderer to show invitation context before the user signs in.

get_workspace(connection, workspace_id, opts \\ [])

Fetch a single workspace by id.

list_my_workspaces(connection, opts \\ [])

List the caller's workspaces (across organizations).

list_workspace_invitations(connection, workspace_id, opts \\ [])

List pending workspace invitations.

list_workspace_members(connection, workspace_id, opts \\ [])

List members of a workspace.

remove_workspace_member(connection, workspace_id, member_id, opts \\ [])

Remove a member from the workspace.

revoke_workspace_invitation(connection, workspace_id, invitation_id, opts \\ [])

Revoke a pending workspace invitation.

update_workspace(connection, workspace_id, update_workspace_request, opts \\ [])

Update workspace metadata.

update_workspace_member(connection, workspace_id, member_id, update_workspace_member_request, opts \\ [])

Update a member's role.

Functions

accept_workspace_invitation(connection, token, opts \\ [])

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

Accept a workspace invitation by token. The signed-in user's email must match the invitation. Organization-token accept lives at POST /v1/organizations/{org}/accept-invitation.

Parameters

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

Returns

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

add_workspace_member(connection, workspace_id, add_workspace_member_request, opts \\ [])

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

Add a member directly (skips invitation flow).

Parameters

connection (Spatio.Connection): Connection to server
workspace_id (String.t):
add_workspace_member_request (AddWorkspaceMemberRequest):
opts (keyword): Optional parameters

Returns

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

create_workspace(connection, create_workspace_request, opts \\ [])

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

Create a workspace. Requires organizationId in the body — bare "personal" workspaces aren't supported on the public API.

Parameters

connection (Spatio.Connection): Connection to server
create_workspace_request (CreateWorkspaceRequest):
opts (keyword): Optional parameters

Returns

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

create_workspace_invitation(connection, workspace_id, create_workspace_invitation_request, opts \\ [])

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

Invite a user to a workspace.

Parameters

connection (Spatio.Connection): Connection to server
workspace_id (String.t):
create_workspace_invitation_request (CreateWorkspaceInvitationRequest):
opts (keyword): Optional parameters

Returns

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

get_public_invitation(connection, token, opts \\ [])

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

Fetch invitation details by token (unauthenticated). Used by the renderer to show invitation context before the user signs in.

Parameters

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

Returns

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

get_workspace(connection, workspace_id, opts \\ [])

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

Fetch a single workspace by id.

Parameters

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

Returns

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

list_my_workspaces(connection, opts \\ [])

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

List the caller's workspaces (across organizations).

Parameters

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

Returns

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

list_workspace_invitations(connection, workspace_id, opts \\ [])

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

List pending workspace invitations.

Parameters

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

Returns

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

list_workspace_members(connection, workspace_id, opts \\ [])

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

List members of a workspace.

Parameters

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

Returns

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

remove_workspace_member(connection, workspace_id, member_id, opts \\ [])

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

Remove a member from the workspace.

Parameters

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

Returns

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

revoke_workspace_invitation(connection, workspace_id, invitation_id, opts \\ [])

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

Revoke a pending workspace invitation.

Parameters

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

Returns

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

update_workspace(connection, workspace_id, update_workspace_request, opts \\ [])

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

Update workspace metadata.

Parameters

connection (Spatio.Connection): Connection to server
workspace_id (String.t):
update_workspace_request (UpdateWorkspaceRequest):
opts (keyword): Optional parameters

Returns

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

update_workspace_member(connection, workspace_id, member_id, update_workspace_member_request, opts \\ [])

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

Update a member's role.

Parameters

connection (Spatio.Connection): Connection to server
workspace_id (String.t):
member_id (String.t):
update_workspace_member_request (UpdateWorkspaceMemberRequest):
opts (keyword): Optional parameters

Returns

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