Spatio.Api.Calls (spatio_sdk v0.0.2)

API calls for all endpoints tagged Calls.

Summary

Functions

create_call(connection, opts \\ [])

Start a new call.

create_meeting_room(connection, create_meeting_room_request, opts \\ [])

Create a persistent meeting room.

delete_call_recording(connection, recording_id, opts \\ [])

Delete a recording.

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

End a call (host only).

get_bandwidth_history(connection, opts \\ [])

Time-series bandwidth metrics.

get_bandwidth_summary(connection, opts \\ [])

Aggregate bandwidth metrics.

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

Fetch a call.

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

Fetch a meeting room.

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

Join a call.

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

Leave a call.

list_active_calls(connection, opts \\ [])

List active calls.

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

List recordings for a call.

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

Start a recording (host only).

stop_call_recording(connection, id, recording_id, opts \\ [])

Stop an in-progress recording.

update_call_participant_state(connection, id, update_participant_state_request, opts \\ [])

Toggle participant audio/video/screen-share state.

workspace_create_call(connection, org, workspace, request_body, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_create_meeting_room(connection, org, workspace, request_body, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_delete_call_recording(connection, org, workspace, recording_id, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • recording_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
workspace_end_call(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
workspace_get_bandwidth_history(connection, org, workspace, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_get_bandwidth_summary(connection, org, workspace, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_get_call(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_get_meeting_room(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_join_call(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_leave_call(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
workspace_list_active_calls(connection, org, workspace, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_list_call_recordings(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_start_call_recording(connection, org, workspace, id, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_stop_call_recording(connection, org, workspace, id, recording_id, opts \\ [])

Parameters

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

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure
workspace_update_call_participant(connection, org, workspace, id, request_body, opts \\ [])

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

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

Functions

create_call(connection, opts \\ [])

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

Start a new call.

Parameters

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

Returns

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

create_meeting_room(connection, create_meeting_room_request, opts \\ [])

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

Create a persistent meeting room.

Parameters

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

Returns

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

delete_call_recording(connection, recording_id, opts \\ [])

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

Delete a recording.

Parameters

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

Returns

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

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

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

End a call (host only).

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

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

Time-series bandwidth metrics.

Parameters

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

Returns

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

get_bandwidth_summary(connection, opts \\ [])

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

Aggregate bandwidth metrics.

Parameters

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

Returns

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

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

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

Fetch a call.

Parameters

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

Returns

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

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

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

Fetch a meeting room.

Parameters

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

Returns

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

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

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

Join a call.

Parameters

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

Returns

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

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

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

Leave a call.

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

list_active_calls(connection, opts \\ [])

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

List active calls.

Parameters

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

Returns

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

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

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

List recordings for a call.

Parameters

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

Returns

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

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

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

Start a recording (host only).

Parameters

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

Returns

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

stop_call_recording(connection, id, recording_id, opts \\ [])

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

Stop an in-progress recording.

Parameters

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

Returns

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

update_call_participant_state(connection, id, update_participant_state_request, opts \\ [])

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

Toggle participant audio/video/screen-share state.

Parameters

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

Returns

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

workspace_create_call(connection, org, workspace, request_body, opts \\ [])

@spec workspace_create_call(
  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()}

Parameters

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

Returns

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

workspace_create_meeting_room(connection, org, workspace, request_body, opts \\ [])

@spec workspace_create_meeting_room(
  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()}

Parameters

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

Returns

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

workspace_delete_call_recording(connection, org, workspace, recording_id, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • recording_id (String.t):
  • opts (keyword): Optional parameters

Returns

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

workspace_end_call(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_get_bandwidth_history(connection, org, workspace, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

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

workspace_get_bandwidth_summary(connection, org, workspace, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

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

workspace_get_call(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_get_meeting_room(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_join_call(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_leave_call(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_list_active_calls(connection, org, workspace, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • opts (keyword): Optional parameters

Returns

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

workspace_list_call_recordings(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_start_call_recording(connection, org, workspace, id, opts \\ [])

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

Parameters

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

Returns

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

workspace_stop_call_recording(connection, org, workspace, id, recording_id, opts \\ [])

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

Parameters

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

Returns

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

workspace_update_call_participant(connection, org, workspace, id, request_body, opts \\ [])

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

Parameters

  • connection (Spatio.Connection): Connection to server
  • org (String.t):
  • workspace (String.t):
  • id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

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