Inttegro.PurchaseIntents.Activity (inttegro v0.3.0)

Copy Markdown View Source

Represents Activity data in the PurchaseIntents API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Creates and manages public purchasing opportunities.

A purchase intent describes what may be bought and can produce an order when a buyer accepts it. It is distinct from the resulting order: update or cancel the intent before acceptance, then use the Orders API for payment and fulfillment state.

Summary

Types

t()

The decoded activity value.

Functions

Builds a Inttegro.PurchaseIntents.Activity and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.PurchaseIntents.Activity{
  amount: Inttegro.Money.Amount.t() | nil,
  attribution: Inttegro.PurchaseIntents.ActivityAttribution.t() | nil,
  created_at: DateTime.t(),
  error_code: String.t() | nil,
  id: String.t(),
  order_id: String.t() | nil,
  payment_id: String.t() | nil,
  product_id: String.t() | nil,
  purchase_intent_id: String.t(),
  quantity: integer() | nil,
  source: String.t() | nil,
  type: Inttegro.PurchaseIntents.ActivityType.t(),
  variant_product_id: String.t() | nil,
  visitor: Inttegro.PurchaseIntents.ActivityVisitor.t() | nil
}

The decoded activity value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.PurchaseIntents.Activity and raises KeyError when a required field is missing.