AppleBusinessRegistry.Business (apple_business_registry v0.3.0)

Copy Markdown View Source

Business struct representing a registered business in Apple Business Registry.

Fields

  • id: Unique identifier for the business
  • name: Business name
  • organization_type: Organization type (e.g., "company", "nonprofit", "government")
  • primary_phone: Primary contact phone number
  • primary_email: Primary contact email
  • website: Business website URL
  • description: Business description
  • status: Registration status ("active", "pending", "suspended")
  • created_at: ISO 8601 timestamp when the business was registered
  • updated_at: ISO 8601 timestamp when the business was last updated

Summary

Functions

Decode a business map into a %Business{} struct.

Encode a %Business{} struct into a map for API requests.

Types

t()

@type t() :: %AppleBusinessRegistry.Business{
  created_at: String.t() | nil,
  description: String.t() | nil,
  id: String.t() | nil,
  name: String.t() | nil,
  organization_type: String.t() | nil,
  primary_email: String.t() | nil,
  primary_phone: String.t() | nil,
  status: String.t() | nil,
  updated_at: String.t() | nil,
  website: String.t() | nil
}

Functions

from_map(attrs)

@spec from_map(map()) :: t()

Decode a business map into a %Business{} struct.

to_map(business)

@spec to_map(t()) :: map()

Encode a %Business{} struct into a map for API requests.