Inttegro.Products.Shipment (inttegro v0.2.0)

Copy Markdown View Source

Represents Shipment data in the Products 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.

Manages products and the prices, media, and attributes used to sell them.

Products are reusable catalog records. Publishing controls availability to public purchasing surfaces; archiving retires a product without rewriting historical orders that reference it.

Summary

Types

t()

The decoded shipment value.

Functions

Builds a Inttegro.Products.Shipment and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Products.Shipment{
  delivery: %{optional(String.t()) => term()} | nil,
  download: %{optional(String.t()) => term()} | nil,
  render: %{optional(String.t()) => term()} | nil,
  service: %{optional(String.t()) => term()} | nil,
  stream: %{optional(String.t()) => term()} | nil,
  type: Inttegro.Products.ShipmentType.t()
}

The decoded shipment value.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.Products.Shipment and raises KeyError when a required field is missing.