Welcome to the Uptick API documentation! Our API empowers publishers to seamlessly integrate our ad platform into their offer flow, enabling them to provide targeted offers to their users at crucial moments during the checkout process or while waiting for order delivery. By leveraging our API, publishers can enhance user experience and maximize revenue opportunities.
\n \nThere are 3 main operations when working with our API.
\n
\n This endpoint allows publishers to create a new offer flow for end users, defining the parameters and triggers for displaying relevant offers.\n
\n\n Publishers can use this endpoint to request offers for a specific offer flow, triggering the retrieval of targeted offers from our platform.\n
\n\n This is to send an event back to the server, specifically for the offer_viewed event.\n
\nYou always start by creating a new flow and then following the links in the response.
graph LR\n A[New Offer Flow] -- Links --> B((Next Offer))\n B[Next Offer] -- Links --> C((Flow Event))\n\n
/api/v1/flows/new\nlinks section, find and use the url for next_offer\nnext_offer will have a links section, find and use the url for offer_event and append ev=offer_viewed.\nExplore the detailed documentation for each endpoint to understand how to make requests, handle responses, and integrate our API seamlessly into your offer flow. If you have any questions or need assistance, our support team is here to help.
\nStatus: stable · Applies to: component_template_* offer templates
This is the compiled-output contract: how a fully-resolved segment tree\nrenders. It’s platform-independent — the web renderer (Ruby + Tailwind, in this\npack) and the mobile SDK (consuming the same API payload) MUST produce these\nexact values. If a token resolves to a different size or color in any\nimplementation, that implementation is wrong, not this document.
This is the value contract: the concrete sizes, colors, borders, and layout\nrules every renderer must reproduce, plus (§11) which styles each segment type\naccepts. It describes the tree after the server has evaluated everything;\nhow that tree is authored is a separate concern (see the companion docs).
\n\n\n\nThe three docs. A template flows through three stages, one doc each:\n-
expression_layer_spec.md— authored / pre-compiled: how a template is\n written (expressions, Liquid values, bindings, responsive{base, md}maps).\n-segment_rendering_spec.md(this doc) — compiled / output: the resolved\n tree and the value scales every client renders.\n-segment_styling.md— web implementation: how the web renderer turns\n this contract into Tailwind/HTML.Versioning. The wire contract is frozen at 1.0; any change to a value or\ntoken is a new version (1.1, 2.0). A payload doesn’t carry a spec version; the\nplacement’s template family fixes it. (The filename is unversioned — this is one\npart of the system, not a version of the whole.)
The web renderer expresses spacing and sizing in em (relative to the\nelement’s own font-size), not rem/px. The canonical value is the em.
Everything keys off one absolute base font-size. Because the scale is\nem-based, the offer’s base font-size scales the entire design — text and\nspacing and box sizes — proportionally. The base is set once, as an\nabsolute px value on the offer root (not an em/rem token), so the offer\nrenders at the same size on every host site regardless of the host page’s\nfont-size. It is a per-template input:
component_template_100 anchors its base to a fixed 14px (matching\ntemplate_002). So its concrete px = em × 14, exactly, on any site.\nbase / 16 for a given template (e.g. ×14/16 for ct100, so\nmedium = 14px, large = 15.75px, x-large = 17.5px, …).\nAn implementation conforms by reproducing the em ratios against the\ntemplate’s declared absolute base, not the 16px reference numbers literally.
\npadding, margin_*\n Contiguous; each step is +0.25em. No skipped steps. Extend with higher numbered\nlabels (4x-loose …) rather than gaps.
| token | \nem | \npx@16 | \n
|---|---|---|
x-tight | \n0.25 | \n4 | \n
tight | \n0.5 | \n8 | \n
normal | \n0.75 | \n12 | \n
loose | \n1.0 | \n16 | \n
x-loose | \n1.25 | \n20 | \n
2x-loose | \n1.5 | \n24 | \n
3x-loose | \n1.75 | \n28 | \n
padding: a single token (all sides), [vertical, horizontal], or\n[top, right, bottom, left]. none (or an absent side) = 0.\nmargin_top / margin_right / margin_bottom / margin_left: a single\ntoken, optionally negated with a leading - (e.g. -tight = -0.5em / -8px).\nNegative applies to margins only (there is no negative padding/size/border).\nwidth, height, badge size\n One shared, contiguous scale (+0.25em per step). width: small == height: small\n== a badge’s size: small.
| token | \nem | \npx@16 | \n
|---|---|---|
2x-small | \n0.75 | \n12 | \n
x-small | \n1.0 | \n16 | \n
small | \n1.25 | \n20 | \n
medium | \n1.5 | \n24 | \n
large | \n1.75 | \n28 | \n
x-large | \n2.0 | \n32 | \n
2x-large | \n2.25 | \n36 | \n
width / height also accept auto and full (100% of the parent).\nsize drives both the circle dimensions (this scale) and its\nfont (the font scale below) from the one token.\nsize\n | token | \nem | \npx@16 | \n
|---|---|---|
2x-small | \n0.625 | \n10 | \n
x-small | \n0.75 | \n12 | \n
small | \n0.875 | \n14 | \n
medium | \n1.0 | \n16 | \n
large | \n1.125 | \n18 | \n
x-large | \n1.25 | \n20 | \n
2x-large | \n1.5 | \n24 | \n
3x-large | \n1.875 | \n30 | \n
4x-large | \n2.25 | \n36 | \n
extraSmall is a legacy alias for x-small (rich-text-parser output).
size is em, so it compounds when nested. A sized element inside another\nsized element multiplies — e.g. a large (1.125em) text run inside an\nx-large (1.25em) heading renders at 1.25 × 1.125 × base, not 1.25 × base. Each\npiece of text must be sized once: a heading owns its size and its text runs\ninherit it (don’t carry their own size). An implementation that applies\nabsolute per-element sizes (no cascade) must therefore flatten to one size per\ntext run to match.
Named tokens resolve to fixed hex. Any non-named value (a #hex or rgb(...))\npasses through verbatim as an inline color.
| token | \nhex | \n
|---|---|
white | \n#FFFFFF | \n
lightergray | \n#E5E7EB | \n
lightgray | \n#9CA3AF | \n
gray | \n#6B7280 | \n
darkgray | \n#374151 | \n
black | \n#000000 | \n
A token resolves to the same hex whether used as text, background, or border\ncolor. (lightergray is the light fill; lightgray is the mid-tone used for\nsecondary text.)
appearance: subdued = muted secondary treatment (decoration color\n#E5E7EB); monochrome = text color #E5E7EB.
| attribute | \nvalues | \n
|---|---|
border (line style) | \nnone, solid, dashed, dotted | \n
border_width | \nnone=0, small=1px, medium=2px, large=4px — or a per-side array (same shape as padding). Native 1/2/4 scale; no 3px step. | \n
border_color | \nthe color tokens in §5 (default mid-gray #888888 when border is set without a color) | \n
border_radius | \nrounded = 4px, full = fully rounded (pill/circle) | \n
Border style, width, and color are independent axes. Widths are absolute\npx (not em-scaled).
max_width | \nem | \npx@16 | \n\n | max_height | \nem | \npx@16 | \n
|---|---|---|---|---|---|---|
small | \n7 | \n112 | \n\n | 2x-small | \n1.75 | \n28 | \n
medium | \n9 | \n144 | \n\n | x-small | \n3.5 | \n56 | \n
large | \n11 | \n176 | \n\n | small | \n7 | \n112 | \n
| \n | \n | \n | \n | medium | \n9 | \n144 | \n
| \n | \n | \n | \n | large | \n11 | \n176 | \n
| attribute | \nvalues → behaviour | \n
|---|---|
display | \nnone (hidden), auto (flex), block, inline_block | \n
direction | \nhorizontal (row), vertical (column) | \n
align | \nmain-axis justify + cross-axis center: start, center, space-between, end | \n
vertical_align | \nalign-self: start, center | \n
order | \ninteger flex order | \n
columns (on a flex parent) | \nper-child array; each entry sizes that child: auto (grow+shrink to content), fill (equal share), none (fixed), 25% / 50% / 75% (basis fraction) | \n
{base, md} maps\n A single breakpoint, mobile-first. A responsive layout attribute is a map keyed\nby breakpoint: base applies always; md overrides at viewport width ≥ 768px\n(web emits Tailwind md:; the mobile SDK applies it above its own 768px-equivalent\nthreshold). A non-responsive attribute is a plain scalar/array.
{ \"attributes\": { \"direction\": { \"base\": \"vertical\", \"md\": \"horizontal\" },\n \"padding\": \"tight\" } }\nOnly layout attributes may carry a {base, md} map — display, direction,\nalign, columns, width, height, size, padding. Layout reflows across\nwidths; color/typography/border stay fixed. A map on any other attribute is ignored.
Bespoke container: full-viewport overlay (#000000 at 40% opacity) with 6em\ntop padding, and a centred white panel (≈92% width on mobile, 80% on desktop)\nwith a drop shadow and slide-down entry. Panel max width by max_width:\nnarrow = 400px, wide = 1000px, default = 800px.
Styling attributes are partitioned into groups; each segment type accepts a\nfixed set of them. A renderer MUST ignore (and SHOULD warn on) an attribute\napplied to a type that does not support its group.
\n| Group | \nAttributes | \n
|---|---|
| base (always on) | \ndisplay | \n
| typography | \ncolor, size, text_align, underline, appearance | \n
| text_inline | \nemphasis, white_space | \n
| box | \npadding, margin_top / margin_right / margin_bottom / margin_left, background, border, border_width, border_color, border_radius | \n
| flex_container | \ndirection, align, columns | \n
| flex_item | \norder, vertical_align | \n
| sizing | \nwidth, height, max_width, max_height | \n
| Type | \nbase | \ntypography | \ntext_inline | \nbox | \nflex_container | \nflex_item | \nsizing | \n
|---|---|---|---|---|---|---|---|
view | \n✓ | \n✓ | \n\n | ✓ | \n✓ | \n✓ | \n✓ | \n
grid | \n✓ | \n✓ | \n\n | ✓ | \n✓ | \n✓ | \n✓ | \n
inline_layout | \n✓ | \n✓ | \n\n | ✓ | \n✓ | \n✓ | \n✓ | \n
block_layout | \n✓ | \n✓ | \n\n | ✓ | \n\n | ✓ | \n✓ | \n
text | \n✓ | \n✓ | \n✓ | \n\n | \n | \n | \n |
heading | \n✓ | \n✓ | \n\n | \n | \n | \n | \n |
button | \n✓ | \n✓ | \n\n | ✓ | \n\n | ✓ | \n✓ | \n
link | \n✓ | \n✓ | \n\n | ✓ | \n\n | ✓ | \n✓ | \n
pressable | \n✓ | \n✓ | \n\n | ✓ | \n\n | ✓ | \n✓ | \n
image | \n✓ | \n✓ | \n\n | ✓ | \n\n | ✓ | \n✓ | \n
badge | \n✓ | \n✓ | \n\n | ✓ | \n\n | \n | \n |
spacer | \n✓ | \n\n | \n | ✓ | \n\n | ✓ | \n✓ | \n
modal | \n✓ | \n\n | \n | \n | \n | \n | \n |
icon / newline / default | \n✓ | \n\n | \n | \n | \n | \n | \n |
Notes:\n- block_layout has a fixed internal layout, so it omits flexcontainer (an\n align/direction would fight its baseline); it still accepts flexitem.\n- Text types take no box/flex/sizing — spacing around copy belongs on a\n wrapping container, not the text run itself.\n- columns is authored on a flex parent (grid / inline_layout) to size its\n children; icon / newline / default render fixed markup and ignore\n attributes.
For the exact attributes each type accepts, with descriptions and allowed\nvalues, see that type’s API endpoint.
\n \nTwo renderers conform to v1.0 when, for an identical segment payload, every\nresolved value (spacing, size, font, color, border, radius, layout, and the\n≥768px overrides) matches the tables above. The web renderer’s golden-master\ntest (segment_golden_master_test.rb) locks its output; the mobile SDK should\ncarry an equivalent fixture suite checked against these same values.
Status: implemented. The value layer (Liquid over the open TemplateContext),\nthe structure operators ($if / $each / $range / $wrap_when), the validator,\nand the editor are built. This doc covers the authoring layer – how a stored\ndefinition is written and evaluated – and the design rationale behind it.
\n\n\n \nThe three docs. A template flows through three stages, one doc each:\n-
expression_layer_spec.md(this doc) — authored / pre-compiled: the\n dialect, Liquid values, bindings, responsive{base, md}.\n-segment_rendering_spec.md— compiled / output: the resolved tree and\n value scales the server compiles this into, that every client renders.\n-segment_styling.md— web implementation: how the web renderer turns\n that contract into Tailwind/HTML.On naming: this is the first shipped form of the authoring layer, so the doc\nis not version-suffixed. The dialect carries its own runtime version\n(
DIALECT_VERSION, persisted per template asexpression_dialect_version) so it\ncan evolve without renaming anything. Only the wire contract is formally\nversioned, because clients depend on it.
The editor’s premise is that a non-developer can create and iterate offer designs\nwithout involving engineering. A stored format that is only a thin JSON dialect\n($bind / $if / $each / $fn over a small function registry and a hand-picked\nbinding allow-list) fails that premise: anything it cannot express forces a\nbackend/view-model change, which re-couples design to dev work – at which point\nhardcoded Ruby templates are simply better.
Any genuinely rich design surfaces this at once: money math, currency formatting,\ndeterministic “social proof” counts, conditionally-shown panels – none have a home\nin a thin dialect without new backend code.
\n \n\n\nStructure is declarative. Values are computed by a sandboxed, server-evaluated\nexpression language with a generous, general standard library. The server\nresolves everything and ships a flat segment tree to clients.
Richness lives in server-side evaluation, so native/non-HTML portability is\nuntouched (clients still receive a fully-resolved tree). Computation lives in the\nformat, not the backend – so designers are self-sufficient. In effect:\nLiquid-grade expressiveness over a structured tree, reusing the engine we\nalready have (LiquidFilters + ActionText::LiquidRender).
This was not invented from scratch. It deliberately reuses structures the industry\nhas converged on for the same constraints – portable to native clients, editable by\nnon-developers, machine-generable, sandboxed – so we extend an established design\ninstead of reinventing one. The lineage, mapped 1:1:
Logic as $-prefixed operators in a JSON tree – MongoDB aggregation & JSONLogic.
| this dialect | \nMongoDB aggregation | \nJSONLogic | \n
|---|---|---|
{"$if": c, "$then": a, "$else": b} | \n{"$cond": {if, then, else}} | \n{"if": [c, a, b]} | \n
{"$bind": "offer.id"} | \nfield ref "$offer.id" | \n{"var": "offer.id"} | \n
{"$each": p, "$as": x, "$do": n} | \n{"$map": {input, as, in}} | \n(n/a) | \n
{"$eq": [a,b]}, $and, $or, $not | \n{"$eq": [a,b]}, $and, $or, $not | \n{"==": [a,b]}, and, or, ! | \n
{"$add": [...]}, {"$subtract": [a,b]} | \n{"$add": [...]}, {"$subtract": [a,b]} | \n{"+": [...]}, {"-": [a,b]} | \n
The $-prefix convention is MongoDB’s own trick: data keys never begin with $, so\noperators are unambiguously distinguishable from data. The interpreter relies on\nexactly that.
Logic resolved server-side, a UI tree shipped to the client – Server-Driven UI.\nThe closest concrete analog is Microsoft Adaptive Cards templating:
\n| this dialect | \nAdaptive Cards templating | \n
|---|---|
"{{ offer.id }}" (value binding) | \n"${offer.id}" | \n
{"$each": "...", "$as": "x"} (repeat) | \n"$data": <array> | \n
{"$if": "<cond>"} (include a node) | \n"$when": <cond> | \n
$index loop variable | \n$index | \n
($wrap_when was arrived at independently; it is a cousin of their $when.)
A structured tree with a templating language for values – Shopify Online Store\n2.0 (a JSON section/block tree + Liquid for the dynamic parts). We do not merely\nresemble Liquid – we run it, through the app’s existing sandboxed LiquidFilters.
Smaller pieces.
\n\"$content\" placeholder is a slot (web-component <slot>, Vue/Svelte slots, React children).\n$fn registry – a fixed whitelist, no arbitrary eval – is the sandboxed-expression-language model (Google’s CEL; spreadsheet formula functions).\nStaying close to these pays off when we extend the layer (reference cycles,\nexpression error semantics, how far to let the value language go): there is mature\nprior art to follow rather than re-derive.
\n \nExpose the offer’s full data namespace, documented and stable, instead of a curated\nallow-list:
\noffer – id, position, name, image url, referral url, …\nvariables – all resolved offer variables (firstname, ordername,\ntotalpriceamount, shippingpriceamount, cashback, shippingrebate,\ntotal_rebate, currency, …). The offer’s data dictionary.\nflow – size, index.\nrender – mode (popup/inline), digits?, dark_mode.\nheader / content / disclaimer / actions / contact / feedback – the\nstructured pieces (title, html, accept/reject text+url, …).\nRules: read-only; allow-listed to these namespaces (no arbitrary send), but the\nnamespaces are broad – adding a new offer variable auto-becomes bindable with no\ncode change. The editor reads a published schema of this context for autocomplete.
Values are authored as Liquid expressions (the team already knows Liquid from the\nHTML templates), evaluated server-side, reusing the existing sandboxed\nLiquidFilters infrastructure. Structure stays JSON; a value slot holds either a\nliteral or a Liquid expression string, e.g.:
{ \"type\": \"text\", \"text\": \"{{ variables.cash_back | to_number | money: variables.currency }}\" }\nStandard filter/function library (general primitives – added once, available to\nevery design; this is the dev-extension surface, not per-design):
\nplus minus times divided_by modulo round ceil floor abs at_least at_most\nmoney, number_with_delimiter, percent\nto_number (strip $, commas), to_currency\nand/or/not, default/coalesce, present/blank\nappend/prepend, upcase/downcase/capitalize, truncate, replace\nsize, first, last, join, map, slice\nseeded_int: seed, min, max,\nseeded_pick: seed, list – deterministic, safe, native-stable\nMany are stock Liquid filters; the gaps (to_number, seeded_*, money\nextensions) are small, general additions to LiquidFilters.
Conditionals and repeats that add/remove/iterate segments stay as structured\noperators on the tree (they shape the tree, not a string):
\n$if (condition is a Liquid expression returning truthy) -> include a segment\n$each / $range (iterate a bound collection / count) -> repeat a segment\n$wrap_when -> conditionally wrap a segment authored once (see below)\nSo: tree structure + structured $if/$each/$wrap_when for segment-level flow +\nLiquid expressions for every value and condition.
$wrap_when; fragments deferred)\n $if/$then/$else branches whole subtrees, so “wrap the content in a modal\nonly on the first offer” forces the same inner content into both the wrapped and\nthe bare branch. In the stored tree that means a copy of the offer body per branch –\nharmless in the resolved output (only one branch ever renders), but a real drift\nhazard in the format the editor edits: change the accept button, change it in every\ncopy.
Built – $wrap_when (conditional wrapping). Author the content once and gate\nonly the outer shell:
{ \"$wrap_when\": \"\",\n \"$wrapper\": { \"type\": \"modal\", ..., \"children\": [\"$content\"] },\n \"$content\": { ...the body, authored once... } }\n The server evaluates $content once and, when the condition holds, splices it into\nthe \"$content\" placeholder inside $wrapper; otherwise it renders the content\nbare. Wraps nest, so a popup design is modal -> padding-view -> container -> body\naround a single body definition, and the stored tree holds one copy of the body\ninstead of one per branch. Output is byte-identical to the duplicated form. (See the\ndialect reference at the end of this doc.)
Deferred – named fragments + $ref (general reuse). $wrap_when only dedupes\nconditional wrapping. Sharing an arbitrary subtree across unrelated places (true\nreusable “components”/“symbols”) would need a fragments: section keyed by name plus\na {\"$ref\": \"name\"} node that the interpreter expands (with cycle detection), the\nvalidator resolves, and the editor surfaces as a reusable symbol. Not built, by\nchoice: it changes the definition’s shape, adds resolution machinery, and disconnects\nthe reading flow (you jump elsewhere to see what renders). Revisit when the editor\nneeds cross-node reuse beyond wrapping; until then, author the content inline and\ngate it with $wrap_when.
{ base, md })\n Progressively enhanced, like scalar-then-array: an attribute value is whatever it\nnormally is until it needs to be responsive, then it expands into a small map keyed\nby breakpoint.
\"attributes\": { \"padding\": \"tight\", // non-responsive (common)\n \"columns\": { \"base\": [\"fill\"], \"md\": [\"75%\",\"25%\"] }, // responsive (opt-in)\n \"direction\": { \"base\": \"vertical\", \"md\": \"horizontal\" } }\n
base applies always (mobile-first); md overrides at >=768px. The map is detected\nthe same way expressions are: a plain value is a scalar/array and an expression is\n$-keyed, so a base/md-keyed bag is unambiguously responsive. (An array can’t\ndouble as the responsive form – arrays already mean per-side padding / column tracks.)
Two rules:
\ndisplay direction align columns width height size padding) – you reflow across\nwidths, you don’t recolor. A map anywhere else is a validation error. The set is one\nconstant (Manifest::RESPONSIVE_OVERRIDABLE) to widen later.\n{base, md} map is the responsive form in both the\nauthored definition AND the compiled output (segment spec section 9) — the interpreter\nresolves each breakpoint’s value but keeps the map; the renderer splits it into base +\nmd: classes at render time. Each breakpoint is evaluated independently, so it can hold\nits own $if / Liquid (\"md\": { \"$if\": \"image.show\", \"$then\": ... }).\nThis mirrors Chakra UI’s responsive props (padding={{ base: 2, md: 4 }}) and the\nsingle-attribute spirit of the newer Shopify app templates, kept on our existing\nviewport-breakpoint renderer rather than container queries.
to_data boundary.\nA complex order-confirmation design – money math, currency formatting, a\nconditional rebate panel, deterministic social proof – needs no design-specific\nbackend code; each piece reduces to general primitives:
\n| design logic | \nexpressed as | \n
|---|---|
rebate math (cash_back + shipping_rebate, fallbacks) | \nmath filters + default over variables.* | \n
"$5.00" -> number | \n`\\ | \n
| format currency | \n`\\ | \n
"ORDER CONFIRMED #" + order_name | \n`\\ | \n
| “are the rebate variables present?” | \npresent over variables.cash_back etc. (drives $if) | \n
| fabricated avatars + “23,481 shoppers” | \nseeded_pick: seed, letters / `seeded_int: seed, 5000, 30000 \\ | \n
None are design-specific – the original failure was a too-thin library, not a\nceiling in the format.
\n \nA stored definition is a segment tree in which any value may be an expression\nobject – a Hash carrying one or more $-prefixed operator keys. Segment nodes\nnever use $ keys, so the interpreter (OfferTemplates::Stored::Interpreter) can\ntell expressions from data. It walks the tree, evaluates expressions against an\nOfferViewModel, and emits the resolved segment tree the rendering spec defines.
The structure operators (what Liquid can’t express – they shape the tree):
\n| Operator | \nMeaning | \n
|---|---|
{"$bind": "offer.id", "$default": …} | \ninject a typed value (array/hash/int) from the binding context | \n
{"$if": <cond>, "$then": <node>, "$else": <node>} | \nconditional node ($else optional → drops) | \n
{"$wrap_when": "<cond>", "$wrapper": <node w/ "$content" slot>, "$content": <node>} | \nconditionally wrap a node authored once; nests | \n
| `{“$each”: “ | \n[nodes]>}` | \n
{"$range": <count>, "$from": 2, "$as": "n", "$index": "i", "$do": …} | \niterate a numeric range (0-based $index) | \n
{"$fn": "name", "args": [<expr>…]} | \ncall a pure function from the fixed Functions registry | \n
{"$rich_text": <html>, "attributes": {…}, "prefix": ""} | \nparse a Liquid-rendered HTML field into text segments | \n
{"$subtract": [<a>, <b>]} | \ninteger arithmetic (kept an op so the index stays numeric, not a Liquid string) | \n
Conditions and scalar values are Liquid, not $-ops. An $if/$wrap_when\ncondition is a Liquid boolean string (\"image.show\", \"offer.position == 1\");\na value is a Liquid template (\"{{ offer.id }}\", \"{{ variables.cash_back | money }}\").\nThe engine still understands legacy $-op predicates/arithmetic\n($eq/$present/$call/$and/$or/$not/$lt…$gte/$add) for completeness,\nbut Liquid is the authoring style — see pillar 2.
Array semantics. A children array mirrors the hardcoded templates’\n.compact_blank.flatten: an element evaluating to an array ($each, $range,\n$rich_text, or a $bind to a segment array) is spliced in; nil/blank\nelements drop. Every other array (e.g. a padding value) is positional and\npreserved exactly — never compacted or flattened.
Boundary. The dialect does only assembly + binding + the Liquid value layer +\na fixed library of pure functions. Anything impure (URL building, data fetching)\nstays in the OfferViewModel. $bind/$call reach only the allow-list in\nBindingContext; $fn reaches only Functions::REGISTRY. Versioning is tracked\nby integration_templates.expression_dialect_version (currently \"1\").
The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The flow ID
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"ev","full_name":"ev","description":"Event
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:flow_initiated, missing_integration, missing_placement, missing_offers, holdout, offer_requested, offer_viewed, offer_accepted, offer_redirected, offer_rejected, purchase, flow_completed, flow_expired.","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_type","full_name":"integration_type","description":"The client integration type
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_version","full_name":"integration_version","description":"The client integration version
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"bn","full_name":"bn","description":"Browser
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"cd","full_name":"cd","description":"Color Depth
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"de","full_name":"de","description":"Encoding
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"dl","full_name":"dl","description":"Location
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"dt","full_name":"dt","description":"Title
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"md","full_name":"md","description":"Mobile
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"rl","full_name":"rl","description":"Referer
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"sr","full_name":"sr","description":"Resolution
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"ts","full_name":"ts","description":"Timestamp
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"ua","full_name":"ua","description":"User Agent
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"uid","full_name":"uid","description":"User ID
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"vp","full_name":"vp","description":"Viewport
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Event created","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"When something is missing","is_array":false,"returns_object":[{"name":"error","full_name":"error","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"feedbacks":{"doc_url":"/api/v1/feedbacks","id":"feedbacks","api_url":"/v1","name":"Feedbacks","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/feedbacks/create","name":"create","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/feedbacks","http_method":"POST","short_description":"Offer Feedback","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The flow ID
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"The public ID of the offer the feedback is about
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"event_id","full_name":"event_id","description":"The parent event ID the feedback belongs to
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"reasons","full_name":"reasons","description":"Feedback reason slugs; only slugs configured for the advertiser are considered. Single-select: only the first valid slug is recorded, though the stored format remains an array (length 0..1)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"How the feedback screen was reached: “decline” (reject CTA) or “pill” (rate-this-offer). Only those two values are stored; any other value is accepted but ignored
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Feedback recorded","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"When a required parameter is missing or no valid reasons are supplied","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"flows":{"doc_url":"/api/v1/flows","id":"flows","api_url":"/v1","name":"Flows","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/flows/new","name":"new","apis":[{"api_url":"/v1/places/:integration_id/flows/new","http_method":"GET","short_description":"New Offer Flow","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"placement","description":"The placement of the integration
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_type","full_name":"integration_type","description":"The client integration type
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_version","full_name":"integration_version","description":"The client integration version
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Flow created","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"The flow data
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"Always flow
The personalization of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"data[placement]","description":"The placement of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:order\\_confirmation, order\\_status.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_seconds","full_name":"data[delay_seconds]","description":"The delay in seconds before the offer should be displayed
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The API URL to retrieve the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":404,"description":"When something is missing","is_array":false,"returns_object":[{"name":"error","full_name":"error","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/flows/show","name":"show","apis":[{"api_url":"/v1/places/:integration_id/flows/:id","http_method":"GET","short_description":"Show Offer Flow","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the integration flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":null,"description":"Flow shown","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"The flow data
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"Always flow
The personalization of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"data[placement]","description":"The placement of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:order\\_confirmation, order\\_status.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_seconds","full_name":"data[delay_seconds]","description":"The delay in seconds before the offer should be displayed
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The API URL to retrieve the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"items":{"doc_url":"/api/v1/items","id":"items","api_url":"/v1","name":"Items","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/items/flow","name":"flow","apis":[{"api_url":"/v1/items/flow","http_method":"HEAD","short_description":"Flow","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:flow.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"personalization","full_name":"personalization","description":"The personalization of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"placement","full_name":"placement","description":"The placement of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:order\\_confirmation, order\\_status.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"delay_seconds","full_name":"delay_seconds","description":"The delay in seconds before the offer should be displayed
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/items/event","name":"event","apis":[{"api_url":"/v1/items/event","http_method":"HEAD","short_description":"Event","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:event.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"kind","full_name":"kind","description":"The kind of the event
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offers":{"doc_url":"/api/v1/offers","id":"offers","api_url":"/v1","name":"Offers","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/offers/new","name":"new","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/offers/new","http_method":"GET","short_description":"Next Offer","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"placement","description":"The placement context where the offer will be displayed (e.g., order_confirmation, order_status)
The client integration type
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_version","full_name":"integration_version","description":"The client integration version
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"The first name of the user for personalization
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Offer created","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"Details
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"The type of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes]","description":"The attributes of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"offers","full_name":"data[attributes][offers]","description":"Where you should show a count of offers
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start","full_name":"data[attributes][offers][start]","description":"What offer to start showing digits at
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current","full_name":"data[attributes][offers][current]","description":"What number of offer you are on
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][offers][size]","description":"How many offers in the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"header","full_name":"data[attributes][header]","description":"The header of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][header][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"image","full_name":"data[attributes][image]","description":"The image of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"url","full_name":"data[attributes][image][url]","description":"The URL of the image
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"personalization","full_name":"data[attributes][personalization]","description":"The personalization of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][personalization][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"content","full_name":"data[attributes][content]","description":"The content of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][content][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer","full_name":"data[attributes][disclaimer]","description":"The disclaimer of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][disclaimer][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer_color","full_name":"data[attributes][disclaimer_color]","description":"The color of the disclaimer for the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sponsored","full_name":"data[attributes][sponsored]","description":"The sponsor of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][sponsored][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"actions","full_name":"data[attributes][actions]","description":"The actions of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][actions][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]}]}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"flow","full_name":"links[flow]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The URL of the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_event","full_name":"links[offer_event]","description":"The URL of the offer event
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":202,"description":"No offers found","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Unable to find the integration","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"title","full_name":"errors[title]","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":403,"description":"The site is blocked","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"title","full_name":"errors[title]","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":422,"description":"Unable to find the placement","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"title","full_name":"errors[title]","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/offers/show","name":"show","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/offers/:id","http_method":"GET","short_description":"Show Offer","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":null,"description":"Offer viewed","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"Details
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"The type of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes]","description":"The attributes of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"offers","full_name":"data[attributes][offers]","description":"Where you should show a count of offers
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start","full_name":"data[attributes][offers][start]","description":"What offer to start showing digits at
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current","full_name":"data[attributes][offers][current]","description":"What number of offer you are on
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][offers][size]","description":"How many offers in the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"header","full_name":"data[attributes][header]","description":"The header of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][header][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"image","full_name":"data[attributes][image]","description":"The image of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"url","full_name":"data[attributes][image][url]","description":"The URL of the image
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"personalization","full_name":"data[attributes][personalization]","description":"The personalization of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][personalization][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"content","full_name":"data[attributes][content]","description":"The content of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][content][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer","full_name":"data[attributes][disclaimer]","description":"The disclaimer of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][disclaimer][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer_color","full_name":"data[attributes][disclaimer_color]","description":"The color of the disclaimer for the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sponsored","full_name":"data[attributes][sponsored]","description":"The sponsor of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][sponsored][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"actions","full_name":"data[attributes][actions]","description":"The actions of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][actions][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]}]}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"flow","full_name":"links[flow]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The URL of the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_event","full_name":"links[offer_event]","description":"The URL of the offer event
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"segments":{"doc_url":"/api/v1/segments","id":"segments","api_url":"/v1","name":"Segments","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/segments/modal","name":"modal","apis":[{"api_url":"/v1/segments/modal","http_method":"HEAD","short_description":"Modal","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:modal.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"max_width","full_name":"attributes[max_width]","description":"Panel width: narrow (400px) or wide (1000px); defaults to 800px
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:narrow, wide.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the modal panel
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/view","name":"view","apis":[{"api_url":"/v1/segments/view","http_method":"HEAD","short_description":"View","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:view.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"attributes[direction]","description":"Flex direction of children
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:horizontal, vertical.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"align","full_name":"attributes[align]","description":"Main-axis alignment (also centres the cross-axis)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center, space-between, end.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"attributes[columns]","description":"Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/block_layout","name":"block_layout","apis":[{"api_url":"/v1/segments/block_layout","http_method":"HEAD","short_description":"Block Layout","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:block_layout.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/inline_layout","name":"inline_layout","apis":[{"api_url":"/v1/segments/inline_layout","http_method":"HEAD","short_description":"Inline Layout","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:inline_layout.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"attributes[direction]","description":"Flex direction of children
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:horizontal, vertical.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"align","full_name":"attributes[align]","description":"Main-axis alignment (also centres the cross-axis)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center, space-between, end.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"attributes[columns]","description":"Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/grid","name":"grid","apis":[{"api_url":"/v1/segments/grid","http_method":"HEAD","short_description":"Grid","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:grid.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"attributes[direction]","description":"Flex direction of children
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:horizontal, vertical.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"align","full_name":"attributes[align]","description":"Main-axis alignment (also centres the cross-axis)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center, space-between, end.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"attributes[columns]","description":"Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/newline","name":"newline","apis":[{"api_url":"/v1/segments/newline","http_method":"HEAD","short_description":"Newline","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:newline.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"children","full_name":"children","description":"Child segments rendered after the line break
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/text","name":"text","apis":[{"api_url":"/v1/segments/text","http_method":"HEAD","short_description":"Text","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The text content to render
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"attributes[emphasis]","description":"Inline emphasis (selects the wrapping element)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"white_space","full_name":"attributes[white_space]","description":"Prevent the text from wrapping
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:nowrap.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments (nested text runs)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/image","name":"image","apis":[{"api_url":"/v1/segments/image","http_method":"HEAD","short_description":"Image","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:image.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"source","full_name":"attributes[source]","description":"The image URL (rendered as the img src)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/heading","name":"heading","apis":[{"api_url":"/v1/segments/heading","http_method":"HEAD","short_description":"Heading","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:heading.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"level","full_name":"attributes[level]","description":"Heading level (renders h1–h6); defaults to 1
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:1, 2, 3, 4, 5, 6.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments (the heading text, usually text runs)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/link","name":"link","apis":[{"api_url":"/v1/segments/link","http_method":"HEAD","short_description":"Link","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:link.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The link text; when omitted the children are rendered instead
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"url","full_name":"url","description":"Fallback link target used when attributes.to is absent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"to","full_name":"attributes[to]","description":"The link target (opens in a new tab)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/button","name":"button","apis":[{"api_url":"/v1/segments/button","http_method":"HEAD","short_description":"Button","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:button.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The button label; when omitted the children are rendered instead
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"url","full_name":"url","description":"Fallback link target used when attributes.to is absent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"to","full_name":"attributes[to]","description":"The link target (opens in a new tab)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"attributes[kind]","description":"Semantic label for the button (e.g. primary/secondary), consumed by analytics
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the button
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/icon","name":"icon","apis":[{"api_url":"/v1/segments/icon","http_method":"HEAD","short_description":"Icon","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:icon.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"source","full_name":"attributes[source]","description":"Which built-in icon to render
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:close, check.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/badge","name":"badge","apis":[{"api_url":"/v1/segments/badge","http_method":"HEAD","short_description":"Badge","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:badge.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The badge text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"tone","full_name":"attributes[tone]","description":"Structural tone label for the badge
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/spacer","name":"spacer","apis":[{"api_url":"/v1/segments/spacer","http_method":"HEAD","short_description":"Spacer","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:spacer.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/pressable","name":"pressable","apis":[{"api_url":"/v1/segments/pressable","http_method":"HEAD","short_description":"Pressable","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:pressable.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"url","full_name":"url","description":"Fallback link target used when attributes.to is absent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"to","full_name":"attributes[to]","description":"The link target; when present the pressable renders as a link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action","full_name":"attributes[action]","description":"A client-side action hook surfaced to the SDK via data-*
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the pressable
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}},"sidebar":{"events":{"doc_url":"/api/v1/events","id":"events","api_url":"/v1","name":"Events","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/events/create","name":"create","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/events","http_method":"POST","short_description":"Flow Event","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The flow ID
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"ev","full_name":"ev","description":"Event
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:flow_initiated, missing_integration, missing_placement, missing_offers, holdout, offer_requested, offer_viewed, offer_accepted, offer_redirected, offer_rejected, purchase, flow_completed, flow_expired.","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_type","full_name":"integration_type","description":"The client integration type
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_version","full_name":"integration_version","description":"The client integration version
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"bn","full_name":"bn","description":"Browser
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"cd","full_name":"cd","description":"Color Depth
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"de","full_name":"de","description":"Encoding
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"dl","full_name":"dl","description":"Location
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"dt","full_name":"dt","description":"Title
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"md","full_name":"md","description":"Mobile
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"rl","full_name":"rl","description":"Referer
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"sr","full_name":"sr","description":"Resolution
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"ts","full_name":"ts","description":"Timestamp
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"ua","full_name":"ua","description":"User Agent
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"uid","full_name":"uid","description":"User ID
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"vp","full_name":"vp","description":"Viewport
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Event created","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"When something is missing","is_array":false,"returns_object":[{"name":"error","full_name":"error","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"feedbacks":{"doc_url":"/api/v1/feedbacks","id":"feedbacks","api_url":"/v1","name":"Feedbacks","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/feedbacks/create","name":"create","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/feedbacks","http_method":"POST","short_description":"Offer Feedback","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The flow ID
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"offer_id","full_name":"offer_id","description":"The public ID of the offer the feedback is about
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"event_id","full_name":"event_id","description":"The parent event ID the feedback belongs to
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"reasons","full_name":"reasons","description":"Feedback reason slugs; only slugs configured for the advertiser are considered. Single-select: only the first valid slug is recorded, though the stored format remains an array (length 0..1)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"How the feedback screen was reached: “decline” (reject CTA) or “pill” (rate-this-offer). Only those two values are stored; any other value is accepted but ignored
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Feedback recorded","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"When a required parameter is missing or no valid reasons are supplied","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"flows":{"doc_url":"/api/v1/flows","id":"flows","api_url":"/v1","name":"Flows","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/flows/new","name":"new","apis":[{"api_url":"/v1/places/:integration_id/flows/new","http_method":"GET","short_description":"New Offer Flow","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"placement","description":"The placement of the integration
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_type","full_name":"integration_type","description":"The client integration type
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_version","full_name":"integration_version","description":"The client integration version
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Flow created","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"The flow data
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"Always flow
The personalization of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"data[placement]","description":"The placement of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:order\\_confirmation, order\\_status.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_seconds","full_name":"data[delay_seconds]","description":"The delay in seconds before the offer should be displayed
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The API URL to retrieve the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":404,"description":"When something is missing","is_array":false,"returns_object":[{"name":"error","full_name":"error","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/flows/show","name":"show","apis":[{"api_url":"/v1/places/:integration_id/flows/:id","http_method":"GET","short_description":"Show Offer Flow","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the integration flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":null,"description":"Flow shown","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"The flow data
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"Always flow
The personalization of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"data[placement]","description":"The placement of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:order\\_confirmation, order\\_status.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delay_seconds","full_name":"data[delay_seconds]","description":"The delay in seconds before the offer should be displayed
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The API URL to retrieve the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"items":{"doc_url":"/api/v1/items","id":"items","api_url":"/v1","name":"Items","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/items/flow","name":"flow","apis":[{"api_url":"/v1/items/flow","http_method":"HEAD","short_description":"Flow","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:flow.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"personalization","full_name":"personalization","description":"The personalization of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"placement","full_name":"placement","description":"The placement of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:order\\_confirmation, order\\_status.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"delay_seconds","full_name":"delay_seconds","description":"The delay in seconds before the offer should be displayed
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/items/event","name":"event","apis":[{"api_url":"/v1/items/event","http_method":"HEAD","short_description":"Event","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:event.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the item
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"kind","full_name":"kind","description":"The kind of the event
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"offers":{"doc_url":"/api/v1/offers","id":"offers","api_url":"/v1","name":"Offers","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/offers/new","name":"new","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/offers/new","http_method":"GET","short_description":"Next Offer","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"placement","full_name":"placement","description":"The placement context where the offer will be displayed (e.g., order_confirmation, order_status)
The client integration type
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"integration_version","full_name":"integration_version","description":"The client integration version
","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":{"type":"query"},"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"The first name of the user for personalization
","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Offer created","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"Details
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"The type of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes]","description":"The attributes of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"offers","full_name":"data[attributes][offers]","description":"Where you should show a count of offers
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start","full_name":"data[attributes][offers][start]","description":"What offer to start showing digits at
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current","full_name":"data[attributes][offers][current]","description":"What number of offer you are on
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][offers][size]","description":"How many offers in the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"header","full_name":"data[attributes][header]","description":"The header of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][header][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"image","full_name":"data[attributes][image]","description":"The image of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"url","full_name":"data[attributes][image][url]","description":"The URL of the image
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"personalization","full_name":"data[attributes][personalization]","description":"The personalization of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][personalization][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"content","full_name":"data[attributes][content]","description":"The content of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][content][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer","full_name":"data[attributes][disclaimer]","description":"The disclaimer of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][disclaimer][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer_color","full_name":"data[attributes][disclaimer_color]","description":"The color of the disclaimer for the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sponsored","full_name":"data[attributes][sponsored]","description":"The sponsor of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][sponsored][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"actions","full_name":"data[attributes][actions]","description":"The actions of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][actions][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]}]}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"flow","full_name":"links[flow]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The URL of the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_event","full_name":"links[offer_event]","description":"The URL of the offer event
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":202,"description":"No offers found","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Unable to find the integration","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"title","full_name":"errors[title]","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":403,"description":"The site is blocked","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"title","full_name":"errors[title]","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]},{"code":422,"description":"Unable to find the placement","is_array":false,"returns_object":[{"name":"errors","full_name":"errors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"title","full_name":"errors[title]","description":"The error message
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/offers/show","name":"show","apis":[{"api_url":"/v1/places/:integration_id/flows/:flow_id/offers/:id","http_method":"GET","short_description":"Show Offer","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[{"name":"integration_id","full_name":"integration_id","description":"The ID of the integration
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"flow_id","full_name":"flow_id","description":"The ID of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"The ID of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":{"type":"path"},"show":true,"validations":[],"deprecated":false}],"returns":[{"code":null,"description":"Offer viewed","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"Details
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"The ID of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"data[type]","description":"The type of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes]","description":"The attributes of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"offers","full_name":"data[attributes][offers]","description":"Where you should show a count of offers
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start","full_name":"data[attributes][offers][start]","description":"What offer to start showing digits at
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"current","full_name":"data[attributes][offers][current]","description":"What number of offer you are on
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][offers][size]","description":"How many offers in the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"header","full_name":"data[attributes][header]","description":"The header of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][header][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][header][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][header][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][header][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][header][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][header][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][header][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][header][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][header][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][header][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"image","full_name":"data[attributes][image]","description":"The image of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"url","full_name":"data[attributes][image][url]","description":"The URL of the image
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"personalization","full_name":"data[attributes][personalization]","description":"The personalization of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][personalization][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][personalization][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][personalization][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][personalization][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][personalization][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][personalization][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][personalization][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][personalization][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][personalization][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][personalization][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"content","full_name":"data[attributes][content]","description":"The content of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][content][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][content][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][content][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][content][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][content][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][content][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][content][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][content][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][content][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][content][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer","full_name":"data[attributes][disclaimer]","description":"The disclaimer of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][disclaimer][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][disclaimer][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][disclaimer][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][disclaimer][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][disclaimer][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][disclaimer][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][disclaimer][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][disclaimer][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][disclaimer][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][disclaimer][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"disclaimer_color","full_name":"data[attributes][disclaimer_color]","description":"The color of the disclaimer for the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sponsored","full_name":"data[attributes][sponsored]","description":"The sponsor of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][sponsored][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][sponsored][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][sponsored][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][sponsored][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][sponsored][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][sponsored][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][sponsored][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][sponsored][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][sponsored][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][sponsored][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]},{"name":"actions","full_name":"data[attributes][actions]","description":"The actions of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"data[attributes][actions][children]","description":"The children of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[attributes][actions][children][type]","description":"What type of segment this is
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text, newline, button, spacer.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text","full_name":"data[attributes][actions][children][text]","description":"The text of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes][actions][children][attributes]","description":"The attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"margin_top","full_name":"data[attributes][actions][children][attributes][margin_top]","description":"Margin above the segment (a spacing token, e.g. tight/normal/loose)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"data[attributes][actions][children][attributes][kind]","description":"Semantic label for a button (e.g. primary/secondary)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"data[attributes][actions][children][attributes][size]","description":"The font size of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"data[attributes][actions][children][attributes][appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"data[attributes][actions][children][attributes][emphasis]","description":"The emphasis of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"to","full_name":"data[attributes][actions][children][attributes][to]","description":"The URL to use for the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]}]}]},{"name":"links","full_name":"links","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"self","full_name":"links[self]","description":"The URL of the offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"flow","full_name":"links[flow]","description":"The URL of the flow
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"next_offer","full_name":"links[next_offer]","description":"The URL of the next offer
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offer_event","full_name":"links[offer_event]","description":"The URL of the offer event
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"segments":{"doc_url":"/api/v1/segments","id":"segments","api_url":"/v1","name":"Segments","short_description":null,"full_description":"","version":"v1","formats":["application/json"],"metadata":null,"methods":[{"doc_url":"/api/v1/segments/modal","name":"modal","apis":[{"api_url":"/v1/segments/modal","http_method":"HEAD","short_description":"Modal","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:modal.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"max_width","full_name":"attributes[max_width]","description":"Panel width: narrow (400px) or wide (1000px); defaults to 800px
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:narrow, wide.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the modal panel
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/view","name":"view","apis":[{"api_url":"/v1/segments/view","http_method":"HEAD","short_description":"View","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:view.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"attributes[direction]","description":"Flex direction of children
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:horizontal, vertical.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"align","full_name":"attributes[align]","description":"Main-axis alignment (also centres the cross-axis)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center, space-between, end.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"attributes[columns]","description":"Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/block_layout","name":"block_layout","apis":[{"api_url":"/v1/segments/block_layout","http_method":"HEAD","short_description":"Block Layout","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:block_layout.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/inline_layout","name":"inline_layout","apis":[{"api_url":"/v1/segments/inline_layout","http_method":"HEAD","short_description":"Inline Layout","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:inline_layout.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"attributes[direction]","description":"Flex direction of children
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:horizontal, vertical.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"align","full_name":"attributes[align]","description":"Main-axis alignment (also centres the cross-axis)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center, space-between, end.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"attributes[columns]","description":"Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/grid","name":"grid","apis":[{"api_url":"/v1/segments/grid","http_method":"HEAD","short_description":"Grid","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:grid.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"direction","full_name":"attributes[direction]","description":"Flex direction of children
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:horizontal, vertical.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"align","full_name":"attributes[align]","description":"Main-axis alignment (also centres the cross-axis)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center, space-between, end.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"attributes[columns]","description":"Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/newline","name":"newline","apis":[{"api_url":"/v1/segments/newline","http_method":"HEAD","short_description":"Newline","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:newline.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"children","full_name":"children","description":"Child segments rendered after the line break
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/text","name":"text","apis":[{"api_url":"/v1/segments/text","http_method":"HEAD","short_description":"Text","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:text.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The text content to render
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"emphasis","full_name":"attributes[emphasis]","description":"Inline emphasis (selects the wrapping element)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:bold, italic, del.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"white_space","full_name":"attributes[white_space]","description":"Prevent the text from wrapping
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:nowrap.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments (nested text runs)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/image","name":"image","apis":[{"api_url":"/v1/segments/image","http_method":"HEAD","short_description":"Image","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:image.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"source","full_name":"attributes[source]","description":"The image URL (rendered as the img src)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/heading","name":"heading","apis":[{"api_url":"/v1/segments/heading","http_method":"HEAD","short_description":"Heading","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:heading.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"level","full_name":"attributes[level]","description":"Heading level (renders h1–h6); defaults to 1
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:1, 2, 3, 4, 5, 6.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments (the heading text, usually text runs)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/link","name":"link","apis":[{"api_url":"/v1/segments/link","http_method":"HEAD","short_description":"Link","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:link.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The link text; when omitted the children are rendered instead
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"url","full_name":"url","description":"Fallback link target used when attributes.to is absent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"to","full_name":"attributes[to]","description":"The link target (opens in a new tab)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/button","name":"button","apis":[{"api_url":"/v1/segments/button","http_method":"HEAD","short_description":"Button","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:button.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The button label; when omitted the children are rendered instead
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"url","full_name":"url","description":"Fallback link target used when attributes.to is absent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"to","full_name":"attributes[to]","description":"The link target (opens in a new tab)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"kind","full_name":"attributes[kind]","description":"Semantic label for the button (e.g. primary/secondary), consumed by analytics
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the button
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/icon","name":"icon","apis":[{"api_url":"/v1/segments/icon","http_method":"HEAD","short_description":"Icon","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:icon.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"source","full_name":"attributes[source]","description":"Which built-in icon to render
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:close, check.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/badge","name":"badge","apis":[{"api_url":"/v1/segments/badge","http_method":"HEAD","short_description":"Badge","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:badge.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"text","full_name":"text","description":"The badge text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"tone","full_name":"attributes[tone]","description":"Structural tone label for the badge
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/spacer","name":"spacer","apis":[{"api_url":"/v1/segments/spacer","http_method":"HEAD","short_description":"Spacer","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:spacer.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/v1/segments/pressable","name":"pressable","apis":[{"api_url":"/v1/segments/pressable","http_method":"HEAD","short_description":"Pressable","deprecated":null}],"formats":["application/json"],"full_description":"","errors":[],"params":[],"returns":[{"code":204,"description":"No Content","is_array":false,"returns_object":[{"name":"type","full_name":"type","description":"The type of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:pressable.","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"url","full_name":"url","description":"Fallback link target used when attributes.to is absent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"data","full_name":"data","description":"Arbitrary data echoed onto the rendered element as data-* attributes
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"The name of the segment (rendered as data-ppx-name)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"attributes","full_name":"attributes","description":"Style attributes of the segment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"to","full_name":"attributes[to]","description":"The link target; when present the pressable renders as a link
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action","full_name":"attributes[action]","description":"A client-side action hook surfaced to the SDK via data-*
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"display","full_name":"attributes[display]","description":"Display mode (auto renders as flex)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, auto, block, inline_block.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"color","full_name":"attributes[color]","description":"Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"size","full_name":"attributes[size]","description":"Font size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_align","full_name":"attributes[text_align]","description":"Horizontal text alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:left, center, right.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"underline","full_name":"attributes[underline]","description":"Underline the text
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:true, false, 1, 0.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"appearance","full_name":"attributes[appearance]","description":"Muted text treatment for secondary copy
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:subdued, monochrome.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"padding","full_name":"attributes[padding]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_top","full_name":"attributes[margin_top]","description":"A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_right","full_name":"attributes[margin_right]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_bottom","full_name":"attributes[margin_bottom]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"margin_left","full_name":"attributes[margin_left]","description":"See margin_top
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background","full_name":"attributes[background]","description":"Background color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border","full_name":"attributes[border]","description":"Border line style
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:none, solid, dashed, dotted.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_width","full_name":"attributes[border_width]","description":"none, small (1px), medium (2px), large (4px), or a per-side array
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_color","full_name":"attributes[border_color]","description":"Border color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"border_radius","full_name":"attributes[border_radius]","description":"Corner rounding
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:rounded, full.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"attributes[order]","description":"Flex order within the parent
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"vertical_align","full_name":"attributes[vertical_align]","description":"Cross-axis self-alignment
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:start, center.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"width","full_name":"attributes[width]","description":"Width: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"height","full_name":"attributes[height]","description":"Height: auto, full, or a box-size token
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_width","full_name":"attributes[max_width]","description":"Maximum width
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_height","full_name":"attributes[max_height]","description":"Maximum height
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of:2x-small, x-small, small, medium, large.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"children","full_name":"children","description":"Child segments rendered inside the pressable
","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}