ArchAstro.SDK.Types.User (archastro v0.3.3)

Copy Markdown

A platform user account. Represents a human or system actor that can own threads, belong to an organization, and interact with the API.

Summary

Types

t()

Functions

from_map(data)
matches?(value)
to_map(value)

Types

t()

@type t() :: %ArchAstro.SDK.Types.User{
  alias_: String.t() | nil | ArchAstro.SDK.Unset.t(),
  app: String.t() | nil | ArchAstro.SDK.Unset.t(),
  app_name: String.t() | nil | ArchAstro.SDK.Unset.t(),
  created_by_agent_user: String.t() | nil | ArchAstro.SDK.Unset.t(),
  created_by_developer: String.t() | nil | ArchAstro.SDK.Unset.t(),
  created_by_org: String.t() | nil | ArchAstro.SDK.Unset.t(),
  created_by_team: String.t() | nil | ArchAstro.SDK.Unset.t(),
  created_by_user: String.t() | nil | ArchAstro.SDK.Unset.t(),
  email: String.t() | nil | ArchAstro.SDK.Unset.t(),
  id: String.t(),
  is_system_user: boolean() | ArchAstro.SDK.Unset.t(),
  metadata:
    %{optional(String.t()) => ArchAstro.SDK.JSON.t()} | ArchAstro.SDK.Unset.t(),
  name: String.t() | nil | ArchAstro.SDK.Unset.t(),
  org: String.t() | nil | ArchAstro.SDK.Unset.t(),
  org_name: String.t() | nil | ArchAstro.SDK.Unset.t(),
  org_role: String.t() | nil | ArchAstro.SDK.Unset.t(),
  org_slug: String.t() | nil | ArchAstro.SDK.Unset.t(),
  sandbox: String.t() | nil | ArchAstro.SDK.Unset.t(),
  sandbox_name: String.t() | nil | ArchAstro.SDK.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.SDK.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.SDK.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.SDK.JSON.object()