ApolloSignal.Domains.ApiKeys (apollo_signal v1.0.5)

Copy Markdown View Source

apiKeys API operations.

Summary

Types

t()

Functions

export_api_key_usage(domain, project_id, key_id, options \\ [])
get_api_key(domain, project_id, key_id, options \\ [])
get_api_key_usage(domain, project_id, key_id, options \\ [])
list_api_keys(domain, project_id, options \\ [])
new(client)

Types

t()

@type t() :: %ApolloSignal.Domains.ApiKeys{client: ApolloSignal.Client.t()}

Functions

export_api_key_usage(domain, project_id, key_id, options \\ [])

@spec export_api_key_usage(
  domain :: t(),
  project_id :: String.t(),
  key_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}

get_api_key(domain, project_id, key_id, options \\ [])

@spec get_api_key(
  domain :: t(),
  project_id :: String.t(),
  key_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ApiKey.t(), ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_api_key_usage(domain, project_id, key_id, options \\ [])

@spec get_api_key_usage(
  domain :: t(),
  project_id :: String.t(),
  key_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ApiKeyUsageResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

list_api_keys(domain, project_id, options \\ [])

@spec list_api_keys(domain :: t(), project_id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.ListApiKeysResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

new(client)

@spec new(ApolloSignal.Client.t()) :: t()