Inttegro.PurchaseIntents.Variant (inttegro v0.2.0)

Represents Variant 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 variant value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.PurchaseIntents.Variant{
  active: boolean(),
  position: integer() | nil,
  price: Inttegro.PurchaseIntents.Price.t() | nil,
  product: Inttegro.PurchaseIntents.Product.t() | nil,
  product_id: String.t(),
  variant_values: %{optional(String.t()) => String.t()}
}

The decoded variant value.

Functions

new!(attrs \\ %{})

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

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