Deepgram.Types.Manage (Deepgram v0.1.0)

View Source

Types for the Manage (Project and Key Management) service.

Summary

Types

balance()

@type balance() :: %{
  balance_id: String.t(),
  amount: float(),
  units: String.t(),
  purchased: String.t()
}

balances_response()

@type balances_response() :: %{balances: [balance()]}

invite()

@type invite() :: %{email: String.t(), scope: String.t(), created: String.t()}

invite_options()

@type invite_options() :: %{email: String.t(), scope: String.t()}

invites_response()

@type invites_response() :: %{invites: [invite()]}

key()

@type key() :: %{
  key_id: String.t(),
  api_key: String.t(),
  comment: String.t(),
  created: String.t(),
  scopes: [String.t()],
  tags: [String.t()]
}

key_options()

@type key_options() :: %{
  comment: String.t(),
  scopes: [String.t()],
  tags: [String.t()]
}

key_response()

@type key_response() :: %{api_key: key()}

keys_response()

@type keys_response() :: %{api_keys: [key()]}

member()

@type member() :: %{
  member_id: String.t(),
  first_name: String.t(),
  last_name: String.t(),
  email: String.t(),
  scopes: [String.t()]
}

members_response()

@type members_response() :: %{members: [member()]}

message()

@type message() :: %{message: String.t()}

model()

@type model() :: %{
  name: String.t(),
  canonical_name: String.t(),
  architecture: String.t(),
  languages: [String.t()],
  version: String.t(),
  uuid: String.t(),
  tier: String.t(),
  requests: integer(),
  fallback_to: String.t()
}

model_response()

@type model_response() :: %{
  name: String.t(),
  canonical_name: String.t(),
  architecture: String.t(),
  language: String.t(),
  version: String.t(),
  uuid: String.t(),
  tier: String.t(),
  requests: integer(),
  fallback_to: String.t()
}

models_response()

@type models_response() :: %{stt: [model()], tts: [model()], read: [model()]}

project()

@type project() :: %{
  project_id: String.t(),
  name: String.t(),
  company: String.t(),
  org_id: String.t(),
  created: String.t(),
  updated: String.t()
}

projects_response()

@type projects_response() :: %{projects: [project()]}

scope()

@type scope() :: %{scope: String.t()}

scope_options()

@type scope_options() :: %{scope: String.t()}

scopes_response()

@type scopes_response() :: %{scopes: [scope()]}

usage_request()

@type usage_request() :: %{
  request_id: String.t(),
  created: String.t(),
  path: String.t(),
  api_key_id: String.t(),
  response: map(),
  callback: String.t() | nil
}

usage_requests_response()

@type usage_requests_response() :: %{
  page: integer(),
  limit: integer(),
  requests: [usage_request()]
}

usage_response()

@type usage_response() :: %{start: String.t(), end: String.t(), usage: map()}