@poweredbysous/storefront-sdk 2.3.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1414,6 +1414,40 @@ interface paths {
1414
1414
  patch?: never;
1415
1415
  trace?: never;
1416
1416
  };
1417
+ "/api/v1/merchant-comms/storefront/active/": {
1418
+ parameters: {
1419
+ query?: never;
1420
+ header?: never;
1421
+ path?: never;
1422
+ cookie?: never;
1423
+ };
1424
+ /** @description Adds .store property to views for readability. */
1425
+ get: operations["merchant_comms_storefront_active_list"];
1426
+ put?: never;
1427
+ post?: never;
1428
+ delete?: never;
1429
+ options?: never;
1430
+ head?: never;
1431
+ patch?: never;
1432
+ trace?: never;
1433
+ };
1434
+ "/api/v1/merchant-comms/storefront/events/": {
1435
+ parameters: {
1436
+ query?: never;
1437
+ header?: never;
1438
+ path?: never;
1439
+ cookie?: never;
1440
+ };
1441
+ get?: never;
1442
+ put?: never;
1443
+ /** @description Adds .store property to views for readability. */
1444
+ post: operations["merchant_comms_storefront_events_create"];
1445
+ delete?: never;
1446
+ options?: never;
1447
+ head?: never;
1448
+ patch?: never;
1449
+ trace?: never;
1450
+ };
1417
1451
  "/api/v1/merchant/me/": {
1418
1452
  parameters: {
1419
1453
  query?: never;
@@ -2541,6 +2575,7 @@ interface components {
2541
2575
  /** Format: double */
2542
2576
  longitude?: number | null;
2543
2577
  open_status?: components["schemas"]["OpenStatus"] | null;
2578
+ phone?: string;
2544
2579
  };
2545
2580
  /** @description Pickup address of a brand location (from its primary pickup location). */
2546
2581
  BrandLocationAddress: {
@@ -2834,6 +2869,102 @@ interface components {
2834
2869
  * @enum {string}
2835
2870
  */
2836
2871
  ChangeTypeEnum: "add" | "remove" | "quantity_change" | "option_change" | "adjustment";
2872
+ /** @description Serialized checkout data for API responses. */
2873
+ Checkout: {
2874
+ id: string;
2875
+ cart_id: string;
2876
+ store_id: number;
2877
+ channel_id: number | null;
2878
+ status: string;
2879
+ currency: string;
2880
+ display_currency: string;
2881
+ fx_rate_to_display: string;
2882
+ email: string | null;
2883
+ shipping_address: {
2884
+ [key: string]: unknown;
2885
+ } | null;
2886
+ billing_address: {
2887
+ [key: string]: unknown;
2888
+ } | null;
2889
+ shipping_method: {
2890
+ [key: string]: string;
2891
+ } | null;
2892
+ payment_method: string | null;
2893
+ payment_status: string | null;
2894
+ line_items: {
2895
+ [key: string]: unknown;
2896
+ }[];
2897
+ tax_components: {
2898
+ [key: string]: unknown;
2899
+ }[];
2900
+ subtotal: string;
2901
+ tax_total: string;
2902
+ shipping_cost: string;
2903
+ surcharge_total: string;
2904
+ display_surcharge_total: string;
2905
+ deposit_total: string;
2906
+ display_deposit_total: string;
2907
+ packaging_choice: string;
2908
+ discount_amount: string;
2909
+ discount_code: string | null;
2910
+ discount_name: string | null;
2911
+ applied_promotion_id: number | null;
2912
+ promotion_discount_amount: string;
2913
+ total: string;
2914
+ service_fees: {
2915
+ [key: string]: unknown;
2916
+ };
2917
+ platform_fee_customer: string;
2918
+ platform_fee_merchant: string;
2919
+ delivery_fee_customer: string;
2920
+ delivery_fee_merchant: string;
2921
+ service_fees_total: string;
2922
+ display_service_fees_total: string;
2923
+ display_subtotal: string;
2924
+ display_tax_total: string;
2925
+ display_shipping_cost: string;
2926
+ display_discount_amount: string;
2927
+ display_promotion_discount_amount: string;
2928
+ display_total: string;
2929
+ fulfillment_slot_id: string | null;
2930
+ service_point_id: string | null;
2931
+ gift_card_details: {
2932
+ [key: string]: unknown;
2933
+ } | null;
2934
+ gift_card_redemptions: {
2935
+ id: number;
2936
+ masked_code: string;
2937
+ amount: string;
2938
+ currency: string;
2939
+ state: string;
2940
+ }[];
2941
+ gift_card_redemption_amount: string;
2942
+ display_gift_card_redemption_amount: string;
2943
+ points_to_redeem: number;
2944
+ points_discount_amount: string;
2945
+ display_points_discount_amount: string;
2946
+ customer_id: number | null;
2947
+ order_number: string | null;
2948
+ purpose: string;
2949
+ attribution: {
2950
+ [key: string]: string;
2951
+ } | null;
2952
+ marketing_consent: {
2953
+ [key: string]: unknown;
2954
+ } | null;
2955
+ warnings: {
2956
+ [key: string]: string;
2957
+ }[];
2958
+ available_payment_gateways: {
2959
+ [key: string]: unknown;
2960
+ }[] | null;
2961
+ created_at: string | null;
2962
+ updated_at: string | null;
2963
+ shipping_groups: {
2964
+ id: string;
2965
+ required_minimum_age: number | null;
2966
+ }[];
2967
+ };
2837
2968
  /**
2838
2969
  * @description Ad-click and campaign identifiers captured by the storefront at landing.
2839
2970
  *
@@ -2978,6 +3109,7 @@ interface components {
2978
3109
  unit_price: string;
2979
3110
  line_total: string;
2980
3111
  tax_amount: string;
3112
+ deposit_amount?: string;
2981
3113
  };
2982
3114
  /**
2983
3115
  * @description The snapshot computed by ``eligibility_for_order``.
@@ -3021,6 +3153,25 @@ interface components {
3021
3153
  eligible_promotions: components["schemas"]["EligiblePromotionItem"][];
3022
3154
  best_promotion_id: number | null;
3023
3155
  };
3156
+ EventBatch: {
3157
+ events: components["schemas"]["EventInput"][];
3158
+ };
3159
+ EventInput: {
3160
+ /** Format: uuid */
3161
+ message_id: string;
3162
+ /** Format: uuid */
3163
+ content_id?: string | null;
3164
+ event_type: components["schemas"]["EventTypeEnum"];
3165
+ subject_key: string;
3166
+ metadata?: unknown;
3167
+ };
3168
+ /**
3169
+ * @description * `impression` - Impression
3170
+ * * `click` - Click
3171
+ * * `dismiss` - Dismiss
3172
+ * @enum {string}
3173
+ */
3174
+ EventTypeEnum: "impression" | "click" | "dismiss";
3024
3175
  /**
3025
3176
  * @description * `nationwide_delivery` - Nationwide Delivery
3026
3177
  * * `local_delivery` - Local Delivery
@@ -3297,6 +3448,11 @@ interface components {
3297
3448
  * @description Aggregated non-discountable surcharges (VAT-inclusive)
3298
3449
  */
3299
3450
  surcharge_total?: string;
3451
+ /**
3452
+ * Format: decimal
3453
+ * @description Deposits (subset of surcharge_total), shown separately.
3454
+ */
3455
+ deposit_total?: string;
3300
3456
  cancellation_reason?: string;
3301
3457
  /** Format: decimal */
3302
3458
  total: string;
@@ -3440,6 +3596,11 @@ interface components {
3440
3596
  tax_amount: string;
3441
3597
  /** Format: decimal */
3442
3598
  line_total: string;
3599
+ /**
3600
+ * Format: decimal
3601
+ * @description Deposit charged on this line, snapshotted at order time so removing the line refunds it.
3602
+ */
3603
+ deposit_amount?: string;
3443
3604
  fulfillment_type: string;
3444
3605
  /** Format: date */
3445
3606
  fulfillment_date?: string | null;
@@ -3787,6 +3948,7 @@ interface components {
3787
3948
  value_file?: string;
3788
3949
  /** Format: int64 */
3789
3950
  value_reference?: number | null;
3951
+ value_json?: unknown;
3790
3952
  readonly selected_choices: components["schemas"]["AttributeChoice"][];
3791
3953
  };
3792
3954
  /**
@@ -3903,6 +4065,8 @@ interface components {
3903
4065
  /** Format: decimal */
3904
4066
  price: string;
3905
4067
  /** Format: decimal */
4068
+ readonly deposit_amount: string | null;
4069
+ /** Format: decimal */
3906
4070
  compare_at_price?: string | null;
3907
4071
  currency?: string;
3908
4072
  /** Format: decimal */
@@ -4566,6 +4730,8 @@ interface components {
4566
4730
  price: string;
4567
4731
  currency: string;
4568
4732
  image_url: string;
4733
+ /** Format: decimal */
4734
+ deposit_amount?: string | null;
4569
4735
  reason: string;
4570
4736
  };
4571
4737
  Surcharge: {
@@ -4581,13 +4747,23 @@ interface components {
4581
4747
  amount: string;
4582
4748
  /**
4583
4749
  * Format: decimal
4584
- * @description VAT rate for this surcharge, independent of the product's rate. German Pfand is charged at the standard rate (19%) while the food line is often reduced (7%), so the surcharge cannot inherit the product's rate. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
4750
+ * @description VAT rate for this surcharge. Not used for a deposit attached to a product or modifier: German Pfand is an ancillary charge on the container and is taxed at the rate of the item it is attached to (UStAE A 10.1 Abs. 8). A deposit's rate here only applies when it is charged per order as the reusable-packaging deposit. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
4585
4751
  */
4586
4752
  vat_rate: string;
4587
4753
  /** @description Category: sup, deposit, bag_fee, packaging, etc. */
4588
4754
  surcharge_type: string;
4589
4755
  is_active?: boolean;
4590
4756
  };
4757
+ /**
4758
+ * @description * `top_banner` - Top Banner
4759
+ * * `bottom_banner` - Bottom Banner
4760
+ * * `modal` - Modal
4761
+ * * `toast` - Toast
4762
+ * * `inline_cart` - Inline Cart
4763
+ * * `inline_checkout` - Inline Checkout
4764
+ * @enum {string}
4765
+ */
4766
+ SurfaceEnum: "top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout";
4591
4767
  TableSession: {
4592
4768
  /** Format: uuid */
4593
4769
  id: string;
@@ -4601,6 +4777,15 @@ interface components {
4601
4777
  /** Format: date-time */
4602
4778
  updated_at: string;
4603
4779
  };
4780
+ /**
4781
+ * @description * `info` - Info
4782
+ * * `success` - Success
4783
+ * * `warning` - Warning
4784
+ * * `urgent` - Urgent
4785
+ * * `promotional` - Promotional
4786
+ * @enum {string}
4787
+ */
4788
+ ThemeEnum: "info" | "success" | "warning" | "urgent" | "promotional";
4604
4789
  TokenRefreshResponse: {
4605
4790
  token: string;
4606
4791
  };
@@ -4728,8 +4913,34 @@ interface components {
4728
4913
  value_file?: string;
4729
4914
  /** Format: int64 */
4730
4915
  value_reference?: number | null;
4916
+ value_json?: unknown;
4731
4917
  readonly selected_choices: components["schemas"]["AttributeChoice"][];
4732
4918
  };
4919
+ /** @description Slim serializer for the widget delivery endpoint. */
4920
+ WidgetMessage: {
4921
+ /** Format: uuid */
4922
+ readonly id: string;
4923
+ /** @description Lower values display first. */
4924
+ priority?: number;
4925
+ dismissible?: boolean;
4926
+ /** @description How long a dismiss lasts. NULL = permanent until message updated. */
4927
+ dismiss_duration?: string | null;
4928
+ readonly contents: components["schemas"]["WidgetMessageContent"][];
4929
+ };
4930
+ WidgetMessageContent: {
4931
+ /** Format: uuid */
4932
+ readonly id: string;
4933
+ surface: components["schemas"]["SurfaceEnum"];
4934
+ readonly headline: string;
4935
+ readonly body: string;
4936
+ readonly cta_label: string;
4937
+ /** Format: uri */
4938
+ cta_url?: string;
4939
+ theme?: components["schemas"]["ThemeEnum"];
4940
+ /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
4941
+ custom_colors?: unknown;
4942
+ extra?: unknown;
4943
+ };
4733
4944
  /** @description POST /api/v1/withdrawals/confirm input. */
4734
4945
  WithdrawalConfirmRequest: {
4735
4946
  token: string;
@@ -6906,9 +7117,7 @@ interface operations {
6906
7117
  [name: string]: unknown;
6907
7118
  };
6908
7119
  content: {
6909
- "application/json": {
6910
- [key: string]: unknown;
6911
- };
7120
+ "application/json": components["schemas"]["Checkout"];
6912
7121
  };
6913
7122
  };
6914
7123
  /** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7004,9 +7213,7 @@ interface operations {
7004
7213
  [name: string]: unknown;
7005
7214
  };
7006
7215
  content: {
7007
- "application/json": {
7008
- [key: string]: unknown;
7009
- };
7216
+ "application/json": components["schemas"]["Checkout"];
7010
7217
  };
7011
7218
  };
7012
7219
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7212,9 +7419,7 @@ interface operations {
7212
7419
  [name: string]: unknown;
7213
7420
  };
7214
7421
  content: {
7215
- "application/json": {
7216
- [key: string]: unknown;
7217
- };
7422
+ "application/json": components["schemas"]["Checkout"];
7218
7423
  };
7219
7424
  };
7220
7425
  /** @description Possible error codes: `GIFT_CARD_EMPTY`, `GIFT_CARD_INVALID_CODE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7313,9 +7518,7 @@ interface operations {
7313
7518
  [name: string]: unknown;
7314
7519
  };
7315
7520
  content: {
7316
- "application/json": {
7317
- [key: string]: unknown;
7318
- };
7521
+ "application/json": components["schemas"]["Checkout"];
7319
7522
  };
7320
7523
  };
7321
7524
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7414,9 +7617,7 @@ interface operations {
7414
7617
  [name: string]: unknown;
7415
7618
  };
7416
7619
  content: {
7417
- "application/json": {
7418
- [key: string]: unknown;
7419
- };
7620
+ "application/json": components["schemas"]["Checkout"];
7420
7621
  };
7421
7622
  };
7422
7623
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7509,9 +7710,7 @@ interface operations {
7509
7710
  [name: string]: unknown;
7510
7711
  };
7511
7712
  content: {
7512
- "application/json": {
7513
- [key: string]: unknown;
7514
- };
7713
+ "application/json": components["schemas"]["Checkout"];
7515
7714
  };
7516
7715
  };
7517
7716
  /** @description Possible error codes: `CHECKOUT_NOT_PAID`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7738,9 +7937,7 @@ interface operations {
7738
7937
  [name: string]: unknown;
7739
7938
  };
7740
7939
  content: {
7741
- "application/json": {
7742
- [key: string]: unknown;
7743
- };
7940
+ "application/json": components["schemas"]["Checkout"];
7744
7941
  };
7745
7942
  };
7746
7943
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7937,9 +8134,7 @@ interface operations {
7937
8134
  [name: string]: unknown;
7938
8135
  };
7939
8136
  content: {
7940
- "application/json": {
7941
- [key: string]: unknown;
7942
- };
8137
+ "application/json": components["schemas"]["Checkout"];
7943
8138
  };
7944
8139
  };
7945
8140
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8038,9 +8233,7 @@ interface operations {
8038
8233
  [name: string]: unknown;
8039
8234
  };
8040
8235
  content: {
8041
- "application/json": {
8042
- [key: string]: unknown;
8043
- };
8236
+ "application/json": components["schemas"]["Checkout"];
8044
8237
  };
8045
8238
  };
8046
8239
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8444,9 +8637,7 @@ interface operations {
8444
8637
  [name: string]: unknown;
8445
8638
  };
8446
8639
  content: {
8447
- "application/json": {
8448
- [key: string]: unknown;
8449
- };
8640
+ "application/json": components["schemas"]["Checkout"];
8450
8641
  };
8451
8642
  };
8452
8643
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8637,9 +8828,7 @@ interface operations {
8637
8828
  [name: string]: unknown;
8638
8829
  };
8639
8830
  content: {
8640
- "application/json": {
8641
- [key: string]: unknown;
8642
- };
8831
+ "application/json": components["schemas"]["Checkout"];
8643
8832
  };
8644
8833
  };
8645
8834
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8732,9 +8921,7 @@ interface operations {
8732
8921
  [name: string]: unknown;
8733
8922
  };
8734
8923
  content: {
8735
- "application/json": {
8736
- [key: string]: unknown;
8737
- };
8924
+ "application/json": components["schemas"]["Checkout"];
8738
8925
  };
8739
8926
  };
8740
8927
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8827,9 +9014,7 @@ interface operations {
8827
9014
  [name: string]: unknown;
8828
9015
  };
8829
9016
  content: {
8830
- "application/json": {
8831
- [key: string]: unknown;
8832
- };
9017
+ "application/json": components["schemas"]["Checkout"];
8833
9018
  };
8834
9019
  };
8835
9020
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11846,6 +12031,163 @@ interface operations {
11846
12031
  };
11847
12032
  };
11848
12033
  };
12034
+ merchant_comms_storefront_active_list: {
12035
+ parameters: {
12036
+ query?: {
12037
+ /** @description Surface types to fetch. Repeat the key (?surfaces=a&surfaces=b) as the array schema implies; a single comma-separated value is also accepted. */
12038
+ surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
12039
+ };
12040
+ header?: never;
12041
+ path?: never;
12042
+ cookie?: never;
12043
+ };
12044
+ requestBody?: never;
12045
+ responses: {
12046
+ 200: {
12047
+ headers: {
12048
+ [name: string]: unknown;
12049
+ };
12050
+ content: {
12051
+ "application/json": components["schemas"]["WidgetMessage"][];
12052
+ };
12053
+ };
12054
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12055
+ 400: {
12056
+ headers: {
12057
+ [name: string]: unknown;
12058
+ };
12059
+ content: {
12060
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12061
+ };
12062
+ };
12063
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12064
+ 401: {
12065
+ headers: {
12066
+ [name: string]: unknown;
12067
+ };
12068
+ content: {
12069
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12070
+ };
12071
+ };
12072
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12073
+ 403: {
12074
+ headers: {
12075
+ [name: string]: unknown;
12076
+ };
12077
+ content: {
12078
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12079
+ };
12080
+ };
12081
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
12082
+ 404: {
12083
+ headers: {
12084
+ [name: string]: unknown;
12085
+ };
12086
+ content: {
12087
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12088
+ };
12089
+ };
12090
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
12091
+ 429: {
12092
+ headers: {
12093
+ [name: string]: unknown;
12094
+ };
12095
+ content: {
12096
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12097
+ };
12098
+ };
12099
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12100
+ 500: {
12101
+ headers: {
12102
+ [name: string]: unknown;
12103
+ };
12104
+ content: {
12105
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12106
+ };
12107
+ };
12108
+ };
12109
+ };
12110
+ merchant_comms_storefront_events_create: {
12111
+ parameters: {
12112
+ query?: never;
12113
+ header?: never;
12114
+ path?: never;
12115
+ cookie?: never;
12116
+ };
12117
+ requestBody: {
12118
+ content: {
12119
+ "application/json": components["schemas"]["EventBatch"];
12120
+ "application/x-www-form-urlencoded": components["schemas"]["EventBatch"];
12121
+ "multipart/form-data": components["schemas"]["EventBatch"];
12122
+ };
12123
+ };
12124
+ responses: {
12125
+ 201: {
12126
+ headers: {
12127
+ [name: string]: unknown;
12128
+ };
12129
+ content: {
12130
+ "application/json": {
12131
+ [key: string]: unknown;
12132
+ };
12133
+ };
12134
+ };
12135
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12136
+ 400: {
12137
+ headers: {
12138
+ [name: string]: unknown;
12139
+ };
12140
+ content: {
12141
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12142
+ };
12143
+ };
12144
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12145
+ 401: {
12146
+ headers: {
12147
+ [name: string]: unknown;
12148
+ };
12149
+ content: {
12150
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12151
+ };
12152
+ };
12153
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12154
+ 403: {
12155
+ headers: {
12156
+ [name: string]: unknown;
12157
+ };
12158
+ content: {
12159
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12160
+ };
12161
+ };
12162
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
12163
+ 404: {
12164
+ headers: {
12165
+ [name: string]: unknown;
12166
+ };
12167
+ content: {
12168
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12169
+ };
12170
+ };
12171
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
12172
+ 429: {
12173
+ headers: {
12174
+ [name: string]: unknown;
12175
+ };
12176
+ content: {
12177
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12178
+ };
12179
+ };
12180
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12181
+ 500: {
12182
+ headers: {
12183
+ [name: string]: unknown;
12184
+ };
12185
+ content: {
12186
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12187
+ };
12188
+ };
12189
+ };
12190
+ };
11849
12191
  merchant_me_retrieve: {
11850
12192
  parameters: {
11851
12193
  query?: never;
@@ -14958,7 +15300,11 @@ interface operations {
14958
15300
  };
14959
15301
  pickup_locations_time_slots_retrieve: {
14960
15302
  parameters: {
14961
- query?: {
15303
+ query: {
15304
+ /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
15305
+ date: string;
15306
+ /** @description Set to `local_delivery` to return own-delivery slots. */
15307
+ fulfillment_type?: string;
14962
15308
  /** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
14963
15309
  lang?: string;
14964
15310
  };
package/dist/index.d.ts CHANGED
@@ -1414,6 +1414,40 @@ interface paths {
1414
1414
  patch?: never;
1415
1415
  trace?: never;
1416
1416
  };
1417
+ "/api/v1/merchant-comms/storefront/active/": {
1418
+ parameters: {
1419
+ query?: never;
1420
+ header?: never;
1421
+ path?: never;
1422
+ cookie?: never;
1423
+ };
1424
+ /** @description Adds .store property to views for readability. */
1425
+ get: operations["merchant_comms_storefront_active_list"];
1426
+ put?: never;
1427
+ post?: never;
1428
+ delete?: never;
1429
+ options?: never;
1430
+ head?: never;
1431
+ patch?: never;
1432
+ trace?: never;
1433
+ };
1434
+ "/api/v1/merchant-comms/storefront/events/": {
1435
+ parameters: {
1436
+ query?: never;
1437
+ header?: never;
1438
+ path?: never;
1439
+ cookie?: never;
1440
+ };
1441
+ get?: never;
1442
+ put?: never;
1443
+ /** @description Adds .store property to views for readability. */
1444
+ post: operations["merchant_comms_storefront_events_create"];
1445
+ delete?: never;
1446
+ options?: never;
1447
+ head?: never;
1448
+ patch?: never;
1449
+ trace?: never;
1450
+ };
1417
1451
  "/api/v1/merchant/me/": {
1418
1452
  parameters: {
1419
1453
  query?: never;
@@ -2541,6 +2575,7 @@ interface components {
2541
2575
  /** Format: double */
2542
2576
  longitude?: number | null;
2543
2577
  open_status?: components["schemas"]["OpenStatus"] | null;
2578
+ phone?: string;
2544
2579
  };
2545
2580
  /** @description Pickup address of a brand location (from its primary pickup location). */
2546
2581
  BrandLocationAddress: {
@@ -2834,6 +2869,102 @@ interface components {
2834
2869
  * @enum {string}
2835
2870
  */
2836
2871
  ChangeTypeEnum: "add" | "remove" | "quantity_change" | "option_change" | "adjustment";
2872
+ /** @description Serialized checkout data for API responses. */
2873
+ Checkout: {
2874
+ id: string;
2875
+ cart_id: string;
2876
+ store_id: number;
2877
+ channel_id: number | null;
2878
+ status: string;
2879
+ currency: string;
2880
+ display_currency: string;
2881
+ fx_rate_to_display: string;
2882
+ email: string | null;
2883
+ shipping_address: {
2884
+ [key: string]: unknown;
2885
+ } | null;
2886
+ billing_address: {
2887
+ [key: string]: unknown;
2888
+ } | null;
2889
+ shipping_method: {
2890
+ [key: string]: string;
2891
+ } | null;
2892
+ payment_method: string | null;
2893
+ payment_status: string | null;
2894
+ line_items: {
2895
+ [key: string]: unknown;
2896
+ }[];
2897
+ tax_components: {
2898
+ [key: string]: unknown;
2899
+ }[];
2900
+ subtotal: string;
2901
+ tax_total: string;
2902
+ shipping_cost: string;
2903
+ surcharge_total: string;
2904
+ display_surcharge_total: string;
2905
+ deposit_total: string;
2906
+ display_deposit_total: string;
2907
+ packaging_choice: string;
2908
+ discount_amount: string;
2909
+ discount_code: string | null;
2910
+ discount_name: string | null;
2911
+ applied_promotion_id: number | null;
2912
+ promotion_discount_amount: string;
2913
+ total: string;
2914
+ service_fees: {
2915
+ [key: string]: unknown;
2916
+ };
2917
+ platform_fee_customer: string;
2918
+ platform_fee_merchant: string;
2919
+ delivery_fee_customer: string;
2920
+ delivery_fee_merchant: string;
2921
+ service_fees_total: string;
2922
+ display_service_fees_total: string;
2923
+ display_subtotal: string;
2924
+ display_tax_total: string;
2925
+ display_shipping_cost: string;
2926
+ display_discount_amount: string;
2927
+ display_promotion_discount_amount: string;
2928
+ display_total: string;
2929
+ fulfillment_slot_id: string | null;
2930
+ service_point_id: string | null;
2931
+ gift_card_details: {
2932
+ [key: string]: unknown;
2933
+ } | null;
2934
+ gift_card_redemptions: {
2935
+ id: number;
2936
+ masked_code: string;
2937
+ amount: string;
2938
+ currency: string;
2939
+ state: string;
2940
+ }[];
2941
+ gift_card_redemption_amount: string;
2942
+ display_gift_card_redemption_amount: string;
2943
+ points_to_redeem: number;
2944
+ points_discount_amount: string;
2945
+ display_points_discount_amount: string;
2946
+ customer_id: number | null;
2947
+ order_number: string | null;
2948
+ purpose: string;
2949
+ attribution: {
2950
+ [key: string]: string;
2951
+ } | null;
2952
+ marketing_consent: {
2953
+ [key: string]: unknown;
2954
+ } | null;
2955
+ warnings: {
2956
+ [key: string]: string;
2957
+ }[];
2958
+ available_payment_gateways: {
2959
+ [key: string]: unknown;
2960
+ }[] | null;
2961
+ created_at: string | null;
2962
+ updated_at: string | null;
2963
+ shipping_groups: {
2964
+ id: string;
2965
+ required_minimum_age: number | null;
2966
+ }[];
2967
+ };
2837
2968
  /**
2838
2969
  * @description Ad-click and campaign identifiers captured by the storefront at landing.
2839
2970
  *
@@ -2978,6 +3109,7 @@ interface components {
2978
3109
  unit_price: string;
2979
3110
  line_total: string;
2980
3111
  tax_amount: string;
3112
+ deposit_amount?: string;
2981
3113
  };
2982
3114
  /**
2983
3115
  * @description The snapshot computed by ``eligibility_for_order``.
@@ -3021,6 +3153,25 @@ interface components {
3021
3153
  eligible_promotions: components["schemas"]["EligiblePromotionItem"][];
3022
3154
  best_promotion_id: number | null;
3023
3155
  };
3156
+ EventBatch: {
3157
+ events: components["schemas"]["EventInput"][];
3158
+ };
3159
+ EventInput: {
3160
+ /** Format: uuid */
3161
+ message_id: string;
3162
+ /** Format: uuid */
3163
+ content_id?: string | null;
3164
+ event_type: components["schemas"]["EventTypeEnum"];
3165
+ subject_key: string;
3166
+ metadata?: unknown;
3167
+ };
3168
+ /**
3169
+ * @description * `impression` - Impression
3170
+ * * `click` - Click
3171
+ * * `dismiss` - Dismiss
3172
+ * @enum {string}
3173
+ */
3174
+ EventTypeEnum: "impression" | "click" | "dismiss";
3024
3175
  /**
3025
3176
  * @description * `nationwide_delivery` - Nationwide Delivery
3026
3177
  * * `local_delivery` - Local Delivery
@@ -3297,6 +3448,11 @@ interface components {
3297
3448
  * @description Aggregated non-discountable surcharges (VAT-inclusive)
3298
3449
  */
3299
3450
  surcharge_total?: string;
3451
+ /**
3452
+ * Format: decimal
3453
+ * @description Deposits (subset of surcharge_total), shown separately.
3454
+ */
3455
+ deposit_total?: string;
3300
3456
  cancellation_reason?: string;
3301
3457
  /** Format: decimal */
3302
3458
  total: string;
@@ -3440,6 +3596,11 @@ interface components {
3440
3596
  tax_amount: string;
3441
3597
  /** Format: decimal */
3442
3598
  line_total: string;
3599
+ /**
3600
+ * Format: decimal
3601
+ * @description Deposit charged on this line, snapshotted at order time so removing the line refunds it.
3602
+ */
3603
+ deposit_amount?: string;
3443
3604
  fulfillment_type: string;
3444
3605
  /** Format: date */
3445
3606
  fulfillment_date?: string | null;
@@ -3787,6 +3948,7 @@ interface components {
3787
3948
  value_file?: string;
3788
3949
  /** Format: int64 */
3789
3950
  value_reference?: number | null;
3951
+ value_json?: unknown;
3790
3952
  readonly selected_choices: components["schemas"]["AttributeChoice"][];
3791
3953
  };
3792
3954
  /**
@@ -3903,6 +4065,8 @@ interface components {
3903
4065
  /** Format: decimal */
3904
4066
  price: string;
3905
4067
  /** Format: decimal */
4068
+ readonly deposit_amount: string | null;
4069
+ /** Format: decimal */
3906
4070
  compare_at_price?: string | null;
3907
4071
  currency?: string;
3908
4072
  /** Format: decimal */
@@ -4566,6 +4730,8 @@ interface components {
4566
4730
  price: string;
4567
4731
  currency: string;
4568
4732
  image_url: string;
4733
+ /** Format: decimal */
4734
+ deposit_amount?: string | null;
4569
4735
  reason: string;
4570
4736
  };
4571
4737
  Surcharge: {
@@ -4581,13 +4747,23 @@ interface components {
4581
4747
  amount: string;
4582
4748
  /**
4583
4749
  * Format: decimal
4584
- * @description VAT rate for this surcharge, independent of the product's rate. German Pfand is charged at the standard rate (19%) while the food line is often reduced (7%), so the surcharge cannot inherit the product's rate. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
4750
+ * @description VAT rate for this surcharge. Not used for a deposit attached to a product or modifier: German Pfand is an ancillary charge on the container and is taxed at the rate of the item it is attached to (UStAE A 10.1 Abs. 8). A deposit's rate here only applies when it is charged per order as the reusable-packaging deposit. Stored as a fraction — the convention every VAT rate in this codebase carries: 19% is stored as 0.19, never 19.00. Required, like Product.vat_rate and ProductModifier.vat_rate: a missing rate must fail loudly rather than silently invoice at 0%.
4585
4751
  */
4586
4752
  vat_rate: string;
4587
4753
  /** @description Category: sup, deposit, bag_fee, packaging, etc. */
4588
4754
  surcharge_type: string;
4589
4755
  is_active?: boolean;
4590
4756
  };
4757
+ /**
4758
+ * @description * `top_banner` - Top Banner
4759
+ * * `bottom_banner` - Bottom Banner
4760
+ * * `modal` - Modal
4761
+ * * `toast` - Toast
4762
+ * * `inline_cart` - Inline Cart
4763
+ * * `inline_checkout` - Inline Checkout
4764
+ * @enum {string}
4765
+ */
4766
+ SurfaceEnum: "top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout";
4591
4767
  TableSession: {
4592
4768
  /** Format: uuid */
4593
4769
  id: string;
@@ -4601,6 +4777,15 @@ interface components {
4601
4777
  /** Format: date-time */
4602
4778
  updated_at: string;
4603
4779
  };
4780
+ /**
4781
+ * @description * `info` - Info
4782
+ * * `success` - Success
4783
+ * * `warning` - Warning
4784
+ * * `urgent` - Urgent
4785
+ * * `promotional` - Promotional
4786
+ * @enum {string}
4787
+ */
4788
+ ThemeEnum: "info" | "success" | "warning" | "urgent" | "promotional";
4604
4789
  TokenRefreshResponse: {
4605
4790
  token: string;
4606
4791
  };
@@ -4728,8 +4913,34 @@ interface components {
4728
4913
  value_file?: string;
4729
4914
  /** Format: int64 */
4730
4915
  value_reference?: number | null;
4916
+ value_json?: unknown;
4731
4917
  readonly selected_choices: components["schemas"]["AttributeChoice"][];
4732
4918
  };
4919
+ /** @description Slim serializer for the widget delivery endpoint. */
4920
+ WidgetMessage: {
4921
+ /** Format: uuid */
4922
+ readonly id: string;
4923
+ /** @description Lower values display first. */
4924
+ priority?: number;
4925
+ dismissible?: boolean;
4926
+ /** @description How long a dismiss lasts. NULL = permanent until message updated. */
4927
+ dismiss_duration?: string | null;
4928
+ readonly contents: components["schemas"]["WidgetMessageContent"][];
4929
+ };
4930
+ WidgetMessageContent: {
4931
+ /** Format: uuid */
4932
+ readonly id: string;
4933
+ surface: components["schemas"]["SurfaceEnum"];
4934
+ readonly headline: string;
4935
+ readonly body: string;
4936
+ readonly cta_label: string;
4937
+ /** Format: uri */
4938
+ cta_url?: string;
4939
+ theme?: components["schemas"]["ThemeEnum"];
4940
+ /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
4941
+ custom_colors?: unknown;
4942
+ extra?: unknown;
4943
+ };
4733
4944
  /** @description POST /api/v1/withdrawals/confirm input. */
4734
4945
  WithdrawalConfirmRequest: {
4735
4946
  token: string;
@@ -6906,9 +7117,7 @@ interface operations {
6906
7117
  [name: string]: unknown;
6907
7118
  };
6908
7119
  content: {
6909
- "application/json": {
6910
- [key: string]: unknown;
6911
- };
7120
+ "application/json": components["schemas"]["Checkout"];
6912
7121
  };
6913
7122
  };
6914
7123
  /** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7004,9 +7213,7 @@ interface operations {
7004
7213
  [name: string]: unknown;
7005
7214
  };
7006
7215
  content: {
7007
- "application/json": {
7008
- [key: string]: unknown;
7009
- };
7216
+ "application/json": components["schemas"]["Checkout"];
7010
7217
  };
7011
7218
  };
7012
7219
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7212,9 +7419,7 @@ interface operations {
7212
7419
  [name: string]: unknown;
7213
7420
  };
7214
7421
  content: {
7215
- "application/json": {
7216
- [key: string]: unknown;
7217
- };
7422
+ "application/json": components["schemas"]["Checkout"];
7218
7423
  };
7219
7424
  };
7220
7425
  /** @description Possible error codes: `GIFT_CARD_EMPTY`, `GIFT_CARD_INVALID_CODE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7313,9 +7518,7 @@ interface operations {
7313
7518
  [name: string]: unknown;
7314
7519
  };
7315
7520
  content: {
7316
- "application/json": {
7317
- [key: string]: unknown;
7318
- };
7521
+ "application/json": components["schemas"]["Checkout"];
7319
7522
  };
7320
7523
  };
7321
7524
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7414,9 +7617,7 @@ interface operations {
7414
7617
  [name: string]: unknown;
7415
7618
  };
7416
7619
  content: {
7417
- "application/json": {
7418
- [key: string]: unknown;
7419
- };
7620
+ "application/json": components["schemas"]["Checkout"];
7420
7621
  };
7421
7622
  };
7422
7623
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7509,9 +7710,7 @@ interface operations {
7509
7710
  [name: string]: unknown;
7510
7711
  };
7511
7712
  content: {
7512
- "application/json": {
7513
- [key: string]: unknown;
7514
- };
7713
+ "application/json": components["schemas"]["Checkout"];
7515
7714
  };
7516
7715
  };
7517
7716
  /** @description Possible error codes: `CHECKOUT_NOT_PAID`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7738,9 +7937,7 @@ interface operations {
7738
7937
  [name: string]: unknown;
7739
7938
  };
7740
7939
  content: {
7741
- "application/json": {
7742
- [key: string]: unknown;
7743
- };
7940
+ "application/json": components["schemas"]["Checkout"];
7744
7941
  };
7745
7942
  };
7746
7943
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -7937,9 +8134,7 @@ interface operations {
7937
8134
  [name: string]: unknown;
7938
8135
  };
7939
8136
  content: {
7940
- "application/json": {
7941
- [key: string]: unknown;
7942
- };
8137
+ "application/json": components["schemas"]["Checkout"];
7943
8138
  };
7944
8139
  };
7945
8140
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8038,9 +8233,7 @@ interface operations {
8038
8233
  [name: string]: unknown;
8039
8234
  };
8040
8235
  content: {
8041
- "application/json": {
8042
- [key: string]: unknown;
8043
- };
8236
+ "application/json": components["schemas"]["Checkout"];
8044
8237
  };
8045
8238
  };
8046
8239
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8444,9 +8637,7 @@ interface operations {
8444
8637
  [name: string]: unknown;
8445
8638
  };
8446
8639
  content: {
8447
- "application/json": {
8448
- [key: string]: unknown;
8449
- };
8640
+ "application/json": components["schemas"]["Checkout"];
8450
8641
  };
8451
8642
  };
8452
8643
  /** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8637,9 +8828,7 @@ interface operations {
8637
8828
  [name: string]: unknown;
8638
8829
  };
8639
8830
  content: {
8640
- "application/json": {
8641
- [key: string]: unknown;
8642
- };
8831
+ "application/json": components["schemas"]["Checkout"];
8643
8832
  };
8644
8833
  };
8645
8834
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8732,9 +8921,7 @@ interface operations {
8732
8921
  [name: string]: unknown;
8733
8922
  };
8734
8923
  content: {
8735
- "application/json": {
8736
- [key: string]: unknown;
8737
- };
8924
+ "application/json": components["schemas"]["Checkout"];
8738
8925
  };
8739
8926
  };
8740
8927
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -8827,9 +9014,7 @@ interface operations {
8827
9014
  [name: string]: unknown;
8828
9015
  };
8829
9016
  content: {
8830
- "application/json": {
8831
- [key: string]: unknown;
8832
- };
9017
+ "application/json": components["schemas"]["Checkout"];
8833
9018
  };
8834
9019
  };
8835
9020
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11846,6 +12031,163 @@ interface operations {
11846
12031
  };
11847
12032
  };
11848
12033
  };
12034
+ merchant_comms_storefront_active_list: {
12035
+ parameters: {
12036
+ query?: {
12037
+ /** @description Surface types to fetch. Repeat the key (?surfaces=a&surfaces=b) as the array schema implies; a single comma-separated value is also accepted. */
12038
+ surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
12039
+ };
12040
+ header?: never;
12041
+ path?: never;
12042
+ cookie?: never;
12043
+ };
12044
+ requestBody?: never;
12045
+ responses: {
12046
+ 200: {
12047
+ headers: {
12048
+ [name: string]: unknown;
12049
+ };
12050
+ content: {
12051
+ "application/json": components["schemas"]["WidgetMessage"][];
12052
+ };
12053
+ };
12054
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12055
+ 400: {
12056
+ headers: {
12057
+ [name: string]: unknown;
12058
+ };
12059
+ content: {
12060
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12061
+ };
12062
+ };
12063
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12064
+ 401: {
12065
+ headers: {
12066
+ [name: string]: unknown;
12067
+ };
12068
+ content: {
12069
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12070
+ };
12071
+ };
12072
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12073
+ 403: {
12074
+ headers: {
12075
+ [name: string]: unknown;
12076
+ };
12077
+ content: {
12078
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12079
+ };
12080
+ };
12081
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
12082
+ 404: {
12083
+ headers: {
12084
+ [name: string]: unknown;
12085
+ };
12086
+ content: {
12087
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12088
+ };
12089
+ };
12090
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
12091
+ 429: {
12092
+ headers: {
12093
+ [name: string]: unknown;
12094
+ };
12095
+ content: {
12096
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12097
+ };
12098
+ };
12099
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12100
+ 500: {
12101
+ headers: {
12102
+ [name: string]: unknown;
12103
+ };
12104
+ content: {
12105
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12106
+ };
12107
+ };
12108
+ };
12109
+ };
12110
+ merchant_comms_storefront_events_create: {
12111
+ parameters: {
12112
+ query?: never;
12113
+ header?: never;
12114
+ path?: never;
12115
+ cookie?: never;
12116
+ };
12117
+ requestBody: {
12118
+ content: {
12119
+ "application/json": components["schemas"]["EventBatch"];
12120
+ "application/x-www-form-urlencoded": components["schemas"]["EventBatch"];
12121
+ "multipart/form-data": components["schemas"]["EventBatch"];
12122
+ };
12123
+ };
12124
+ responses: {
12125
+ 201: {
12126
+ headers: {
12127
+ [name: string]: unknown;
12128
+ };
12129
+ content: {
12130
+ "application/json": {
12131
+ [key: string]: unknown;
12132
+ };
12133
+ };
12134
+ };
12135
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12136
+ 400: {
12137
+ headers: {
12138
+ [name: string]: unknown;
12139
+ };
12140
+ content: {
12141
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12142
+ };
12143
+ };
12144
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12145
+ 401: {
12146
+ headers: {
12147
+ [name: string]: unknown;
12148
+ };
12149
+ content: {
12150
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12151
+ };
12152
+ };
12153
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12154
+ 403: {
12155
+ headers: {
12156
+ [name: string]: unknown;
12157
+ };
12158
+ content: {
12159
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12160
+ };
12161
+ };
12162
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
12163
+ 404: {
12164
+ headers: {
12165
+ [name: string]: unknown;
12166
+ };
12167
+ content: {
12168
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12169
+ };
12170
+ };
12171
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
12172
+ 429: {
12173
+ headers: {
12174
+ [name: string]: unknown;
12175
+ };
12176
+ content: {
12177
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12178
+ };
12179
+ };
12180
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12181
+ 500: {
12182
+ headers: {
12183
+ [name: string]: unknown;
12184
+ };
12185
+ content: {
12186
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12187
+ };
12188
+ };
12189
+ };
12190
+ };
11849
12191
  merchant_me_retrieve: {
11850
12192
  parameters: {
11851
12193
  query?: never;
@@ -14958,7 +15300,11 @@ interface operations {
14958
15300
  };
14959
15301
  pickup_locations_time_slots_retrieve: {
14960
15302
  parameters: {
14961
- query?: {
15303
+ query: {
15304
+ /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
15305
+ date: string;
15306
+ /** @description Set to `local_delivery` to return own-delivery slots. */
15307
+ fulfillment_type?: string;
14962
15308
  /** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
14963
15309
  lang?: string;
14964
15310
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-sdk",
3
- "version": "2.3.0",
3
+ "version": "3.0.0",
4
4
  "description": "Type-safe TypeScript SDK for SOUS Storefront Backend",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,