ArchAstro.SDK.Client (archastro v0.3.0)

Copy Markdown

Immutable entry point for the ArchAstro Platform API.

Summary

Types

option()
t()
telemetry_metadata()

Functions

for_server(token_server, opts \\ [])
for_session(token_server, session_id, opts \\ [])
public(token_server, opts \\ [])

Types

option()

@type option() ::
  {:base_url, String.t()}
  | {:req, Req.Request.t()}
  | {:telemetry_metadata, telemetry_metadata()}

t()

@type t() :: %ArchAstro.SDK.Client{
  base_url: String.t(),
  request: Req.Request.t(),
  telemetry_metadata: telemetry_metadata(),
  token_binding: ArchAstro.SDK.TokenServer.Binding.t()
}

telemetry_metadata()

@type telemetry_metadata() :: %{optional(atom()) => ArchAstro.SDK.JSON.t()}

Functions

for_server(token_server, opts \\ [])

@spec for_server(
  ArchAstro.SDK.TokenServer.provider() | ArchAstro.SDK.TokenServer.server_ref(),
  [
    option()
  ]
) :: {:ok, t()} | {:error, ArchAstro.SDK.Error.reason()}

for_session(token_server, session_id, opts \\ [])

@spec for_session(
  ArchAstro.SDK.TokenServer.provider() | ArchAstro.SDK.TokenServer.server_ref(),
  String.t(),
  [option()]
) :: {:ok, t()} | {:error, ArchAstro.SDK.Error.reason()}

public(token_server, opts \\ [])

@spec public(
  ArchAstro.SDK.TokenServer.provider() | ArchAstro.SDK.TokenServer.server_ref(),
  [option()]
) ::
  {:ok, t()} | {:error, ArchAstro.SDK.Error.reason()}