Inttegro.PurchaseIntents.CreateRequest (inttegro v0.2.0)

Parameters for Create Request in the PurchaseIntents API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.PurchaseIntents. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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()

A validated create request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.PurchaseIntents.CreateRequest{
  expires_at: String.t() | nil,
  price: Inttegro.PurchaseIntents.CreateRequestPrice.t() | nil,
  price_id: String.t() | nil,
  product: Inttegro.PurchaseIntents.CreateRequestProduct.t() | nil,
  product_id: String.t() | nil,
  quantity: Inttegro.PurchaseIntents.CreateRequestQuantity.t(),
  usage: Inttegro.PurchaseIntents.CreateRequestUsage.t() | nil
}

A validated create request request.

Functions

new!(attrs \\ %{})

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

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