Inttegro.Products.PageRequest (inttegro v0.2.0)

Copy Markdown View Source

Parameters for Page Request in the Products API.

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

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

A validated page request request.

Functions

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

Types

t()

@type t() :: %Inttegro.Products.PageRequest{
  page_number: integer(),
  page_size: integer() | nil
}

A validated page request request.

Functions

new!(attrs \\ %{})

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

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