SubspaceProductAPI.Api.SipTeleportService (subspace_openapi_client v1.0.11)

API calls for all endpoints tagged SipTeleportService.

Link to this section Summary

Functions

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • v1_create_sip_teleport (V1CreateSipTeleport): Required parameters to create a new SIPTeleport
  • opts (KeywordList): [optional] Optional parameters
    • :idempotency_key (String.t): Value is the returned etag of a get request. If a retry sends an Idempotency-Key that has been seen before, the existing teleport is returned with the status code of 200

      Returns

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

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

    Returns

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

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

    Returns

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

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :before (String.t):
    • :limit (integer()):

      Returns

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

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • id (String.t):
  • v1_update_sip_teleport (V1UpdateSipTeleport): Parameters to update an existing SIPTeleport, minimum requirement of one of them defined to update
  • opts (KeywordList): [optional] Optional parameters

    Returns

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

Link to this section Functions

Link to this function

sip_teleport_service_create(connection, v1_create_sip_teleport, opts \\ [])

Specs

sip_teleport_service_create(
  Tesla.Env.client(),
  SubspaceProductAPI.Model.V1CreateSipTeleport.t(),
  keyword()
) ::
  {:ok, SubspaceProductAPI.Model.V1SipTeleportResponse.t()}
  | {:ok, Map.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • v1_create_sip_teleport (V1CreateSipTeleport): Required parameters to create a new SIPTeleport
  • opts (KeywordList): [optional] Optional parameters
    • :idempotency_key (String.t): Value is the returned etag of a get request. If a retry sends an Idempotency-Key that has been seen before, the existing teleport is returned with the status code of 200

      Returns

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

Link to this function

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

Specs

sip_teleport_service_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, SubspaceProductAPI.Model.V1SipTeleportResponse.t()}
  | {:ok, Map.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

    Returns

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

Link to this function

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

Specs

sip_teleport_service_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, SubspaceProductAPI.Model.V1SipTeleportResponse.t()}
  | {:ok, Map.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters

    Returns

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

Link to this function

sip_teleport_service_list(connection, opts \\ [])

Specs

sip_teleport_service_list(Tesla.Env.client(), keyword()) ::
  {:ok, SubspaceProductAPI.Model.V1ListSipTeleportResponse.t()}
  | {:ok, Map.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :before (String.t):
    • :limit (integer()):

      Returns

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

Link to this function

sip_teleport_service_update(connection, id, v1_update_sip_teleport, opts \\ [])

Specs

sip_teleport_service_update(
  Tesla.Env.client(),
  String.t(),
  SubspaceProductAPI.Model.V1UpdateSipTeleport.t(),
  keyword()
) ::
  {:ok, SubspaceProductAPI.Model.V1SipTeleportResponse.t()}
  | {:ok, Map.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (SubspaceProductAPI.Connection): Connection to server
  • id (String.t):
  • v1_update_sip_teleport (V1UpdateSipTeleport): Parameters to update an existing SIPTeleport, minimum requirement of one of them defined to update
  • opts (KeywordList): [optional] Optional parameters

    Returns

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