@poweredbysous/storefront-all-sdk 3.4.0 → 4.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
@@ -7451,6 +7451,102 @@ interface components {
7451
7451
  * @enum {string}
7452
7452
  */
7453
7453
  ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
7454
+ /** @description Serialized checkout data for API responses. */
7455
+ Checkout: {
7456
+ id: string;
7457
+ cart_id: string;
7458
+ store_id: number;
7459
+ channel_id: number | null;
7460
+ status: string;
7461
+ currency: string;
7462
+ display_currency: string;
7463
+ fx_rate_to_display: string;
7464
+ email: string | null;
7465
+ shipping_address: {
7466
+ [key: string]: unknown;
7467
+ } | null;
7468
+ billing_address: {
7469
+ [key: string]: unknown;
7470
+ } | null;
7471
+ shipping_method: {
7472
+ [key: string]: string;
7473
+ } | null;
7474
+ payment_method: string | null;
7475
+ payment_status: string | null;
7476
+ line_items: {
7477
+ [key: string]: unknown;
7478
+ }[];
7479
+ tax_components: {
7480
+ [key: string]: unknown;
7481
+ }[];
7482
+ subtotal: string;
7483
+ tax_total: string;
7484
+ shipping_cost: string;
7485
+ surcharge_total: string;
7486
+ display_surcharge_total: string;
7487
+ deposit_total: string;
7488
+ display_deposit_total: string;
7489
+ packaging_choice: string;
7490
+ discount_amount: string;
7491
+ discount_code: string | null;
7492
+ discount_name: string | null;
7493
+ applied_promotion_id: number | null;
7494
+ promotion_discount_amount: string;
7495
+ total: string;
7496
+ service_fees: {
7497
+ [key: string]: unknown;
7498
+ };
7499
+ platform_fee_customer: string;
7500
+ platform_fee_merchant: string;
7501
+ delivery_fee_customer: string;
7502
+ delivery_fee_merchant: string;
7503
+ service_fees_total: string;
7504
+ display_service_fees_total: string;
7505
+ display_subtotal: string;
7506
+ display_tax_total: string;
7507
+ display_shipping_cost: string;
7508
+ display_discount_amount: string;
7509
+ display_promotion_discount_amount: string;
7510
+ display_total: string;
7511
+ fulfillment_slot_id: string | null;
7512
+ service_point_id: string | null;
7513
+ gift_card_details: {
7514
+ [key: string]: unknown;
7515
+ } | null;
7516
+ gift_card_redemptions: {
7517
+ id: number;
7518
+ masked_code: string;
7519
+ amount: string;
7520
+ currency: string;
7521
+ state: string;
7522
+ }[];
7523
+ gift_card_redemption_amount: string;
7524
+ display_gift_card_redemption_amount: string;
7525
+ points_to_redeem: number;
7526
+ points_discount_amount: string;
7527
+ display_points_discount_amount: string;
7528
+ customer_id: number | null;
7529
+ order_number: string | null;
7530
+ purpose: string;
7531
+ attribution: {
7532
+ [key: string]: string;
7533
+ } | null;
7534
+ marketing_consent: {
7535
+ [key: string]: unknown;
7536
+ } | null;
7537
+ warnings: {
7538
+ [key: string]: string;
7539
+ }[];
7540
+ available_payment_gateways: {
7541
+ [key: string]: unknown;
7542
+ }[] | null;
7543
+ created_at: string | null;
7544
+ updated_at: string | null;
7545
+ shipping_groups: {
7546
+ id: string;
7547
+ required_minimum_age: number | null;
7548
+ }[];
7549
+ };
7454
7550
  /**
7455
7551
  * @description Ad-click and campaign identifiers captured by the storefront at landing.
7456
7552
  *
@@ -11298,9 +11394,21 @@ interface components {
11298
11394
  dismissible?: boolean;
11299
11395
  /** @description How long a dismiss lasts. NULL = permanent until message updated. */
11300
11396
  dismiss_duration?: string | null;
11301
- readonly contents: {
11302
- [key: string]: unknown;
11303
- }[];
11397
+ readonly contents: components["schemas"]["WidgetMessageContent"][];
11398
+ };
11399
+ WidgetMessageContent: {
11400
+ /** Format: uuid */
11401
+ readonly id: string;
11402
+ surface: components["schemas"]["SurfaceEnum"];
11403
+ readonly headline: string;
11404
+ readonly body: string;
11405
+ readonly cta_label: string;
11406
+ /** Format: uri */
11407
+ cta_url?: string;
11408
+ theme?: components["schemas"]["ThemeEnum"];
11409
+ /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
11410
+ custom_colors?: unknown;
11411
+ extra?: unknown;
11304
11412
  };
11305
11413
  /** @description POST /api/v1/withdrawals/confirm input. */
11306
11414
  WithdrawalConfirmRequest: {
@@ -20512,9 +20620,7 @@ interface operations {
20512
20620
  [name: string]: unknown;
20513
20621
  };
20514
20622
  content: {
20515
- "application/json": {
20516
- [key: string]: unknown;
20517
- };
20623
+ "application/json": components["schemas"]["Checkout"];
20518
20624
  };
20519
20625
  };
20520
20626
  /** @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. */
@@ -20610,9 +20716,7 @@ interface operations {
20610
20716
  [name: string]: unknown;
20611
20717
  };
20612
20718
  content: {
20613
- "application/json": {
20614
- [key: string]: unknown;
20615
- };
20719
+ "application/json": components["schemas"]["Checkout"];
20616
20720
  };
20617
20721
  };
20618
20722
  /** @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. */
@@ -20818,9 +20922,7 @@ interface operations {
20818
20922
  [name: string]: unknown;
20819
20923
  };
20820
20924
  content: {
20821
- "application/json": {
20822
- [key: string]: unknown;
20823
- };
20925
+ "application/json": components["schemas"]["Checkout"];
20824
20926
  };
20825
20927
  };
20826
20928
  /** @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. */
@@ -20919,9 +21021,7 @@ interface operations {
20919
21021
  [name: string]: unknown;
20920
21022
  };
20921
21023
  content: {
20922
- "application/json": {
20923
- [key: string]: unknown;
20924
- };
21024
+ "application/json": components["schemas"]["Checkout"];
20925
21025
  };
20926
21026
  };
20927
21027
  /** @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. */
@@ -21020,9 +21120,7 @@ interface operations {
21020
21120
  [name: string]: unknown;
21021
21121
  };
21022
21122
  content: {
21023
- "application/json": {
21024
- [key: string]: unknown;
21025
- };
21123
+ "application/json": components["schemas"]["Checkout"];
21026
21124
  };
21027
21125
  };
21028
21126
  /** @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. */
@@ -21115,9 +21213,7 @@ interface operations {
21115
21213
  [name: string]: unknown;
21116
21214
  };
21117
21215
  content: {
21118
- "application/json": {
21119
- [key: string]: unknown;
21120
- };
21216
+ "application/json": components["schemas"]["Checkout"];
21121
21217
  };
21122
21218
  };
21123
21219
  /** @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. */
@@ -21344,9 +21440,7 @@ interface operations {
21344
21440
  [name: string]: unknown;
21345
21441
  };
21346
21442
  content: {
21347
- "application/json": {
21348
- [key: string]: unknown;
21349
- };
21443
+ "application/json": components["schemas"]["Checkout"];
21350
21444
  };
21351
21445
  };
21352
21446
  /** @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. */
@@ -21543,9 +21637,7 @@ interface operations {
21543
21637
  [name: string]: unknown;
21544
21638
  };
21545
21639
  content: {
21546
- "application/json": {
21547
- [key: string]: unknown;
21548
- };
21640
+ "application/json": components["schemas"]["Checkout"];
21549
21641
  };
21550
21642
  };
21551
21643
  /** @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. */
@@ -21644,9 +21736,7 @@ interface operations {
21644
21736
  [name: string]: unknown;
21645
21737
  };
21646
21738
  content: {
21647
- "application/json": {
21648
- [key: string]: unknown;
21649
- };
21739
+ "application/json": components["schemas"]["Checkout"];
21650
21740
  };
21651
21741
  };
21652
21742
  /** @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. */
@@ -22050,9 +22140,7 @@ interface operations {
22050
22140
  [name: string]: unknown;
22051
22141
  };
22052
22142
  content: {
22053
- "application/json": {
22054
- [key: string]: unknown;
22055
- };
22143
+ "application/json": components["schemas"]["Checkout"];
22056
22144
  };
22057
22145
  };
22058
22146
  /** @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. */
@@ -22243,9 +22331,7 @@ interface operations {
22243
22331
  [name: string]: unknown;
22244
22332
  };
22245
22333
  content: {
22246
- "application/json": {
22247
- [key: string]: unknown;
22248
- };
22334
+ "application/json": components["schemas"]["Checkout"];
22249
22335
  };
22250
22336
  };
22251
22337
  /** @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. */
@@ -22338,9 +22424,7 @@ interface operations {
22338
22424
  [name: string]: unknown;
22339
22425
  };
22340
22426
  content: {
22341
- "application/json": {
22342
- [key: string]: unknown;
22343
- };
22427
+ "application/json": components["schemas"]["Checkout"];
22344
22428
  };
22345
22429
  };
22346
22430
  /** @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. */
@@ -22433,9 +22517,7 @@ interface operations {
22433
22517
  [name: string]: unknown;
22434
22518
  };
22435
22519
  content: {
22436
- "application/json": {
22437
- [key: string]: unknown;
22438
- };
22520
+ "application/json": components["schemas"]["Checkout"];
22439
22521
  };
22440
22522
  };
22441
22523
  /** @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. */
@@ -28144,8 +28226,8 @@ interface operations {
28144
28226
  merchant_comms_storefront_active_list: {
28145
28227
  parameters: {
28146
28228
  query?: {
28147
- /** @description Comma-separated surface types to fetch. */
28148
- surfaces?: "bottom_banner" | "inline_cart" | "inline_checkout" | "modal" | "toast" | "top_banner";
28229
+ /** @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. */
28230
+ surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
28149
28231
  };
28150
28232
  header?: never;
28151
28233
  path?: never;
@@ -31722,7 +31804,11 @@ interface operations {
31722
31804
  };
31723
31805
  pickup_locations_time_slots_retrieve: {
31724
31806
  parameters: {
31725
- query?: {
31807
+ query: {
31808
+ /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
31809
+ date: string;
31810
+ /** @description Set to `local_delivery` to return own-delivery slots. */
31811
+ fulfillment_type?: string;
31726
31812
  /** @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`. */
31727
31813
  lang?: string;
31728
31814
  };
package/dist/index.d.ts CHANGED
@@ -7451,6 +7451,102 @@ interface components {
7451
7451
  * @enum {string}
7452
7452
  */
7453
7453
  ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
7454
+ /** @description Serialized checkout data for API responses. */
7455
+ Checkout: {
7456
+ id: string;
7457
+ cart_id: string;
7458
+ store_id: number;
7459
+ channel_id: number | null;
7460
+ status: string;
7461
+ currency: string;
7462
+ display_currency: string;
7463
+ fx_rate_to_display: string;
7464
+ email: string | null;
7465
+ shipping_address: {
7466
+ [key: string]: unknown;
7467
+ } | null;
7468
+ billing_address: {
7469
+ [key: string]: unknown;
7470
+ } | null;
7471
+ shipping_method: {
7472
+ [key: string]: string;
7473
+ } | null;
7474
+ payment_method: string | null;
7475
+ payment_status: string | null;
7476
+ line_items: {
7477
+ [key: string]: unknown;
7478
+ }[];
7479
+ tax_components: {
7480
+ [key: string]: unknown;
7481
+ }[];
7482
+ subtotal: string;
7483
+ tax_total: string;
7484
+ shipping_cost: string;
7485
+ surcharge_total: string;
7486
+ display_surcharge_total: string;
7487
+ deposit_total: string;
7488
+ display_deposit_total: string;
7489
+ packaging_choice: string;
7490
+ discount_amount: string;
7491
+ discount_code: string | null;
7492
+ discount_name: string | null;
7493
+ applied_promotion_id: number | null;
7494
+ promotion_discount_amount: string;
7495
+ total: string;
7496
+ service_fees: {
7497
+ [key: string]: unknown;
7498
+ };
7499
+ platform_fee_customer: string;
7500
+ platform_fee_merchant: string;
7501
+ delivery_fee_customer: string;
7502
+ delivery_fee_merchant: string;
7503
+ service_fees_total: string;
7504
+ display_service_fees_total: string;
7505
+ display_subtotal: string;
7506
+ display_tax_total: string;
7507
+ display_shipping_cost: string;
7508
+ display_discount_amount: string;
7509
+ display_promotion_discount_amount: string;
7510
+ display_total: string;
7511
+ fulfillment_slot_id: string | null;
7512
+ service_point_id: string | null;
7513
+ gift_card_details: {
7514
+ [key: string]: unknown;
7515
+ } | null;
7516
+ gift_card_redemptions: {
7517
+ id: number;
7518
+ masked_code: string;
7519
+ amount: string;
7520
+ currency: string;
7521
+ state: string;
7522
+ }[];
7523
+ gift_card_redemption_amount: string;
7524
+ display_gift_card_redemption_amount: string;
7525
+ points_to_redeem: number;
7526
+ points_discount_amount: string;
7527
+ display_points_discount_amount: string;
7528
+ customer_id: number | null;
7529
+ order_number: string | null;
7530
+ purpose: string;
7531
+ attribution: {
7532
+ [key: string]: string;
7533
+ } | null;
7534
+ marketing_consent: {
7535
+ [key: string]: unknown;
7536
+ } | null;
7537
+ warnings: {
7538
+ [key: string]: string;
7539
+ }[];
7540
+ available_payment_gateways: {
7541
+ [key: string]: unknown;
7542
+ }[] | null;
7543
+ created_at: string | null;
7544
+ updated_at: string | null;
7545
+ shipping_groups: {
7546
+ id: string;
7547
+ required_minimum_age: number | null;
7548
+ }[];
7549
+ };
7454
7550
  /**
7455
7551
  * @description Ad-click and campaign identifiers captured by the storefront at landing.
7456
7552
  *
@@ -11298,9 +11394,21 @@ interface components {
11298
11394
  dismissible?: boolean;
11299
11395
  /** @description How long a dismiss lasts. NULL = permanent until message updated. */
11300
11396
  dismiss_duration?: string | null;
11301
- readonly contents: {
11302
- [key: string]: unknown;
11303
- }[];
11397
+ readonly contents: components["schemas"]["WidgetMessageContent"][];
11398
+ };
11399
+ WidgetMessageContent: {
11400
+ /** Format: uuid */
11401
+ readonly id: string;
11402
+ surface: components["schemas"]["SurfaceEnum"];
11403
+ readonly headline: string;
11404
+ readonly body: string;
11405
+ readonly cta_label: string;
11406
+ /** Format: uri */
11407
+ cta_url?: string;
11408
+ theme?: components["schemas"]["ThemeEnum"];
11409
+ /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
11410
+ custom_colors?: unknown;
11411
+ extra?: unknown;
11304
11412
  };
11305
11413
  /** @description POST /api/v1/withdrawals/confirm input. */
11306
11414
  WithdrawalConfirmRequest: {
@@ -20512,9 +20620,7 @@ interface operations {
20512
20620
  [name: string]: unknown;
20513
20621
  };
20514
20622
  content: {
20515
- "application/json": {
20516
- [key: string]: unknown;
20517
- };
20623
+ "application/json": components["schemas"]["Checkout"];
20518
20624
  };
20519
20625
  };
20520
20626
  /** @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. */
@@ -20610,9 +20716,7 @@ interface operations {
20610
20716
  [name: string]: unknown;
20611
20717
  };
20612
20718
  content: {
20613
- "application/json": {
20614
- [key: string]: unknown;
20615
- };
20719
+ "application/json": components["schemas"]["Checkout"];
20616
20720
  };
20617
20721
  };
20618
20722
  /** @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. */
@@ -20818,9 +20922,7 @@ interface operations {
20818
20922
  [name: string]: unknown;
20819
20923
  };
20820
20924
  content: {
20821
- "application/json": {
20822
- [key: string]: unknown;
20823
- };
20925
+ "application/json": components["schemas"]["Checkout"];
20824
20926
  };
20825
20927
  };
20826
20928
  /** @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. */
@@ -20919,9 +21021,7 @@ interface operations {
20919
21021
  [name: string]: unknown;
20920
21022
  };
20921
21023
  content: {
20922
- "application/json": {
20923
- [key: string]: unknown;
20924
- };
21024
+ "application/json": components["schemas"]["Checkout"];
20925
21025
  };
20926
21026
  };
20927
21027
  /** @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. */
@@ -21020,9 +21120,7 @@ interface operations {
21020
21120
  [name: string]: unknown;
21021
21121
  };
21022
21122
  content: {
21023
- "application/json": {
21024
- [key: string]: unknown;
21025
- };
21123
+ "application/json": components["schemas"]["Checkout"];
21026
21124
  };
21027
21125
  };
21028
21126
  /** @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. */
@@ -21115,9 +21213,7 @@ interface operations {
21115
21213
  [name: string]: unknown;
21116
21214
  };
21117
21215
  content: {
21118
- "application/json": {
21119
- [key: string]: unknown;
21120
- };
21216
+ "application/json": components["schemas"]["Checkout"];
21121
21217
  };
21122
21218
  };
21123
21219
  /** @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. */
@@ -21344,9 +21440,7 @@ interface operations {
21344
21440
  [name: string]: unknown;
21345
21441
  };
21346
21442
  content: {
21347
- "application/json": {
21348
- [key: string]: unknown;
21349
- };
21443
+ "application/json": components["schemas"]["Checkout"];
21350
21444
  };
21351
21445
  };
21352
21446
  /** @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. */
@@ -21543,9 +21637,7 @@ interface operations {
21543
21637
  [name: string]: unknown;
21544
21638
  };
21545
21639
  content: {
21546
- "application/json": {
21547
- [key: string]: unknown;
21548
- };
21640
+ "application/json": components["schemas"]["Checkout"];
21549
21641
  };
21550
21642
  };
21551
21643
  /** @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. */
@@ -21644,9 +21736,7 @@ interface operations {
21644
21736
  [name: string]: unknown;
21645
21737
  };
21646
21738
  content: {
21647
- "application/json": {
21648
- [key: string]: unknown;
21649
- };
21739
+ "application/json": components["schemas"]["Checkout"];
21650
21740
  };
21651
21741
  };
21652
21742
  /** @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. */
@@ -22050,9 +22140,7 @@ interface operations {
22050
22140
  [name: string]: unknown;
22051
22141
  };
22052
22142
  content: {
22053
- "application/json": {
22054
- [key: string]: unknown;
22055
- };
22143
+ "application/json": components["schemas"]["Checkout"];
22056
22144
  };
22057
22145
  };
22058
22146
  /** @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. */
@@ -22243,9 +22331,7 @@ interface operations {
22243
22331
  [name: string]: unknown;
22244
22332
  };
22245
22333
  content: {
22246
- "application/json": {
22247
- [key: string]: unknown;
22248
- };
22334
+ "application/json": components["schemas"]["Checkout"];
22249
22335
  };
22250
22336
  };
22251
22337
  /** @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. */
@@ -22338,9 +22424,7 @@ interface operations {
22338
22424
  [name: string]: unknown;
22339
22425
  };
22340
22426
  content: {
22341
- "application/json": {
22342
- [key: string]: unknown;
22343
- };
22427
+ "application/json": components["schemas"]["Checkout"];
22344
22428
  };
22345
22429
  };
22346
22430
  /** @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. */
@@ -22433,9 +22517,7 @@ interface operations {
22433
22517
  [name: string]: unknown;
22434
22518
  };
22435
22519
  content: {
22436
- "application/json": {
22437
- [key: string]: unknown;
22438
- };
22520
+ "application/json": components["schemas"]["Checkout"];
22439
22521
  };
22440
22522
  };
22441
22523
  /** @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. */
@@ -28144,8 +28226,8 @@ interface operations {
28144
28226
  merchant_comms_storefront_active_list: {
28145
28227
  parameters: {
28146
28228
  query?: {
28147
- /** @description Comma-separated surface types to fetch. */
28148
- surfaces?: "bottom_banner" | "inline_cart" | "inline_checkout" | "modal" | "toast" | "top_banner";
28229
+ /** @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. */
28230
+ surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
28149
28231
  };
28150
28232
  header?: never;
28151
28233
  path?: never;
@@ -31722,7 +31804,11 @@ interface operations {
31722
31804
  };
31723
31805
  pickup_locations_time_slots_retrieve: {
31724
31806
  parameters: {
31725
- query?: {
31807
+ query: {
31808
+ /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
31809
+ date: string;
31810
+ /** @description Set to `local_delivery` to return own-delivery slots. */
31811
+ fulfillment_type?: string;
31726
31812
  /** @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`. */
31727
31813
  lang?: string;
31728
31814
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-all-sdk",
3
- "version": "3.4.0",
3
+ "version": "4.0.0",
4
4
  "description": "Type-safe TypeScript SDK for all SOUS Storefront Backend endpoints",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,