@poweredbysous/storefront-all-sdk 3.4.0 → 4.1.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
@@ -3086,6 +3086,30 @@ interface paths {
3086
3086
  patch?: never;
3087
3087
  trace?: never;
3088
3088
  };
3089
+ "/api/v1/discovery/stores/": {
3090
+ parameters: {
3091
+ query?: never;
3092
+ header?: never;
3093
+ path?: never;
3094
+ cookie?: never;
3095
+ };
3096
+ /**
3097
+ * @description The ``public_id`` of every store on the ExploreSOUS channel.
3098
+ *
3099
+ * A flat membership set, deliberately not a field on the partner index:
3100
+ * that read is brand-grouped and does not say how many locations a brand
3101
+ * has, and this one is a different question. It reveals nothing
3102
+ * ExploreSOUS's sitemap does not, which publishes a URL for every one.
3103
+ */
3104
+ get: operations["discovery_stores_retrieve"];
3105
+ put?: never;
3106
+ post?: never;
3107
+ delete?: never;
3108
+ options?: never;
3109
+ head?: never;
3110
+ patch?: never;
3111
+ trace?: never;
3112
+ };
3089
3113
  "/api/v1/fulfillment/address-check/": {
3090
3114
  parameters: {
3091
3115
  query?: never;
@@ -7451,6 +7475,102 @@ interface components {
7451
7475
  * @enum {string}
7452
7476
  */
7453
7477
  ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
7478
+ /** @description Serialized checkout data for API responses. */
7479
+ Checkout: {
7480
+ id: string;
7481
+ cart_id: string;
7482
+ store_id: number;
7483
+ channel_id: number | null;
7484
+ status: string;
7485
+ currency: string;
7486
+ display_currency: string;
7487
+ fx_rate_to_display: string;
7488
+ email: string | null;
7489
+ shipping_address: {
7490
+ [key: string]: unknown;
7491
+ } | null;
7492
+ billing_address: {
7493
+ [key: string]: unknown;
7494
+ } | null;
7495
+ shipping_method: {
7496
+ [key: string]: string;
7497
+ } | null;
7498
+ payment_method: string | null;
7499
+ payment_status: string | null;
7500
+ line_items: {
7501
+ [key: string]: unknown;
7502
+ }[];
7503
+ tax_components: {
7504
+ [key: string]: unknown;
7505
+ }[];
7506
+ subtotal: string;
7507
+ tax_total: string;
7508
+ shipping_cost: string;
7509
+ surcharge_total: string;
7510
+ display_surcharge_total: string;
7511
+ deposit_total: string;
7512
+ display_deposit_total: string;
7513
+ packaging_choice: string;
7514
+ discount_amount: string;
7515
+ discount_code: string | null;
7516
+ discount_name: string | null;
7517
+ applied_promotion_id: number | null;
7518
+ promotion_discount_amount: string;
7519
+ total: string;
7520
+ service_fees: {
7521
+ [key: string]: unknown;
7522
+ };
7523
+ platform_fee_customer: string;
7524
+ platform_fee_merchant: string;
7525
+ delivery_fee_customer: string;
7526
+ delivery_fee_merchant: string;
7527
+ service_fees_total: string;
7528
+ display_service_fees_total: string;
7529
+ display_subtotal: string;
7530
+ display_tax_total: string;
7531
+ display_shipping_cost: string;
7532
+ display_discount_amount: string;
7533
+ display_promotion_discount_amount: string;
7534
+ display_total: string;
7535
+ fulfillment_slot_id: string | null;
7536
+ service_point_id: string | null;
7537
+ gift_card_details: {
7538
+ [key: string]: unknown;
7539
+ } | null;
7540
+ gift_card_redemptions: {
7541
+ id: number;
7542
+ masked_code: string;
7543
+ amount: string;
7544
+ currency: string;
7545
+ state: string;
7546
+ }[];
7547
+ gift_card_redemption_amount: string;
7548
+ display_gift_card_redemption_amount: string;
7549
+ points_to_redeem: number;
7550
+ points_discount_amount: string;
7551
+ display_points_discount_amount: string;
7552
+ customer_id: number | null;
7553
+ order_number: string | null;
7554
+ purpose: string;
7555
+ attribution: {
7556
+ [key: string]: string;
7557
+ } | null;
7558
+ marketing_consent: {
7559
+ [key: string]: unknown;
7560
+ } | null;
7561
+ warnings: {
7562
+ [key: string]: string;
7563
+ }[];
7564
+ available_payment_gateways: {
7565
+ [key: string]: unknown;
7566
+ }[] | null;
7567
+ created_at: string | null;
7568
+ updated_at: string | null;
7569
+ shipping_groups: {
7570
+ id: string;
7571
+ required_minimum_age: number | null;
7572
+ }[];
7573
+ };
7454
7574
  /**
7455
7575
  * @description Ad-click and campaign identifiers captured by the storefront at landing.
7456
7576
  *
@@ -7925,6 +8045,7 @@ interface components {
7925
8045
  price_band: number | null;
7926
8046
  michelin_stars: number | null;
7927
8047
  tags: string[];
8048
+ book_url: string;
7928
8049
  };
7929
8050
  /**
7930
8051
  * @description The whole directory plus its filter vocabulary, in one read.
@@ -7936,6 +8057,10 @@ interface components {
7936
8057
  tags: components["schemas"]["DiscoveryTag"][];
7937
8058
  partners: components["schemas"]["DiscoveryPartner"][];
7938
8059
  };
8060
+ /** @description The stores ExploreSOUS serves, as ``X-Vendor-ID`` values. */
8061
+ DiscoveryStoreMembership: {
8062
+ store_ids: string[];
8063
+ };
7939
8064
  /** @description One filter option, already named in the reader's language. */
7940
8065
  DiscoveryTag: {
7941
8066
  slug: string;
@@ -11298,9 +11423,21 @@ interface components {
11298
11423
  dismissible?: boolean;
11299
11424
  /** @description How long a dismiss lasts. NULL = permanent until message updated. */
11300
11425
  dismiss_duration?: string | null;
11301
- readonly contents: {
11302
- [key: string]: unknown;
11303
- }[];
11426
+ readonly contents: components["schemas"]["WidgetMessageContent"][];
11427
+ };
11428
+ WidgetMessageContent: {
11429
+ /** Format: uuid */
11430
+ readonly id: string;
11431
+ surface: components["schemas"]["SurfaceEnum"];
11432
+ readonly headline: string;
11433
+ readonly body: string;
11434
+ readonly cta_label: string;
11435
+ /** Format: uri */
11436
+ cta_url?: string;
11437
+ theme?: components["schemas"]["ThemeEnum"];
11438
+ /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
11439
+ custom_colors?: unknown;
11440
+ extra?: unknown;
11304
11441
  };
11305
11442
  /** @description POST /api/v1/withdrawals/confirm input. */
11306
11443
  WithdrawalConfirmRequest: {
@@ -20512,9 +20649,7 @@ interface operations {
20512
20649
  [name: string]: unknown;
20513
20650
  };
20514
20651
  content: {
20515
- "application/json": {
20516
- [key: string]: unknown;
20517
- };
20652
+ "application/json": components["schemas"]["Checkout"];
20518
20653
  };
20519
20654
  };
20520
20655
  /** @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 +20745,7 @@ interface operations {
20610
20745
  [name: string]: unknown;
20611
20746
  };
20612
20747
  content: {
20613
- "application/json": {
20614
- [key: string]: unknown;
20615
- };
20748
+ "application/json": components["schemas"]["Checkout"];
20616
20749
  };
20617
20750
  };
20618
20751
  /** @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 +20951,7 @@ interface operations {
20818
20951
  [name: string]: unknown;
20819
20952
  };
20820
20953
  content: {
20821
- "application/json": {
20822
- [key: string]: unknown;
20823
- };
20954
+ "application/json": components["schemas"]["Checkout"];
20824
20955
  };
20825
20956
  };
20826
20957
  /** @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 +21050,7 @@ interface operations {
20919
21050
  [name: string]: unknown;
20920
21051
  };
20921
21052
  content: {
20922
- "application/json": {
20923
- [key: string]: unknown;
20924
- };
21053
+ "application/json": components["schemas"]["Checkout"];
20925
21054
  };
20926
21055
  };
20927
21056
  /** @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 +21149,7 @@ interface operations {
21020
21149
  [name: string]: unknown;
21021
21150
  };
21022
21151
  content: {
21023
- "application/json": {
21024
- [key: string]: unknown;
21025
- };
21152
+ "application/json": components["schemas"]["Checkout"];
21026
21153
  };
21027
21154
  };
21028
21155
  /** @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 +21242,7 @@ interface operations {
21115
21242
  [name: string]: unknown;
21116
21243
  };
21117
21244
  content: {
21118
- "application/json": {
21119
- [key: string]: unknown;
21120
- };
21245
+ "application/json": components["schemas"]["Checkout"];
21121
21246
  };
21122
21247
  };
21123
21248
  /** @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 +21469,7 @@ interface operations {
21344
21469
  [name: string]: unknown;
21345
21470
  };
21346
21471
  content: {
21347
- "application/json": {
21348
- [key: string]: unknown;
21349
- };
21472
+ "application/json": components["schemas"]["Checkout"];
21350
21473
  };
21351
21474
  };
21352
21475
  /** @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 +21666,7 @@ interface operations {
21543
21666
  [name: string]: unknown;
21544
21667
  };
21545
21668
  content: {
21546
- "application/json": {
21547
- [key: string]: unknown;
21548
- };
21669
+ "application/json": components["schemas"]["Checkout"];
21549
21670
  };
21550
21671
  };
21551
21672
  /** @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 +21765,7 @@ interface operations {
21644
21765
  [name: string]: unknown;
21645
21766
  };
21646
21767
  content: {
21647
- "application/json": {
21648
- [key: string]: unknown;
21649
- };
21768
+ "application/json": components["schemas"]["Checkout"];
21650
21769
  };
21651
21770
  };
21652
21771
  /** @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 +22169,7 @@ interface operations {
22050
22169
  [name: string]: unknown;
22051
22170
  };
22052
22171
  content: {
22053
- "application/json": {
22054
- [key: string]: unknown;
22055
- };
22172
+ "application/json": components["schemas"]["Checkout"];
22056
22173
  };
22057
22174
  };
22058
22175
  /** @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 +22360,7 @@ interface operations {
22243
22360
  [name: string]: unknown;
22244
22361
  };
22245
22362
  content: {
22246
- "application/json": {
22247
- [key: string]: unknown;
22248
- };
22363
+ "application/json": components["schemas"]["Checkout"];
22249
22364
  };
22250
22365
  };
22251
22366
  /** @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 +22453,7 @@ interface operations {
22338
22453
  [name: string]: unknown;
22339
22454
  };
22340
22455
  content: {
22341
- "application/json": {
22342
- [key: string]: unknown;
22343
- };
22456
+ "application/json": components["schemas"]["Checkout"];
22344
22457
  };
22345
22458
  };
22346
22459
  /** @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 +22546,7 @@ interface operations {
22433
22546
  [name: string]: unknown;
22434
22547
  };
22435
22548
  content: {
22436
- "application/json": {
22437
- [key: string]: unknown;
22438
- };
22549
+ "application/json": components["schemas"]["Checkout"];
22439
22550
  };
22440
22551
  };
22441
22552
  /** @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. */
@@ -25649,6 +25760,61 @@ interface operations {
25649
25760
  };
25650
25761
  };
25651
25762
  };
25763
+ discovery_stores_retrieve: {
25764
+ parameters: {
25765
+ query?: never;
25766
+ header?: never;
25767
+ path?: never;
25768
+ cookie?: never;
25769
+ };
25770
+ requestBody?: never;
25771
+ responses: {
25772
+ 200: {
25773
+ headers: {
25774
+ [name: string]: unknown;
25775
+ };
25776
+ content: {
25777
+ "application/json": components["schemas"]["DiscoveryStoreMembership"];
25778
+ };
25779
+ };
25780
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
25781
+ 400: {
25782
+ headers: {
25783
+ [name: string]: unknown;
25784
+ };
25785
+ content: {
25786
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25787
+ };
25788
+ };
25789
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
25790
+ 404: {
25791
+ headers: {
25792
+ [name: string]: unknown;
25793
+ };
25794
+ content: {
25795
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25796
+ };
25797
+ };
25798
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
25799
+ 429: {
25800
+ headers: {
25801
+ [name: string]: unknown;
25802
+ };
25803
+ content: {
25804
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25805
+ };
25806
+ };
25807
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
25808
+ 500: {
25809
+ headers: {
25810
+ [name: string]: unknown;
25811
+ };
25812
+ content: {
25813
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25814
+ };
25815
+ };
25816
+ };
25817
+ };
25652
25818
  fulfillment_address_check_create: {
25653
25819
  parameters: {
25654
25820
  query?: never;
@@ -28144,8 +28310,8 @@ interface operations {
28144
28310
  merchant_comms_storefront_active_list: {
28145
28311
  parameters: {
28146
28312
  query?: {
28147
- /** @description Comma-separated surface types to fetch. */
28148
- surfaces?: "bottom_banner" | "inline_cart" | "inline_checkout" | "modal" | "toast" | "top_banner";
28313
+ /** @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. */
28314
+ surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
28149
28315
  };
28150
28316
  header?: never;
28151
28317
  path?: never;
@@ -31722,7 +31888,11 @@ interface operations {
31722
31888
  };
31723
31889
  pickup_locations_time_slots_retrieve: {
31724
31890
  parameters: {
31725
- query?: {
31891
+ query: {
31892
+ /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
31893
+ date: string;
31894
+ /** @description Set to `local_delivery` to return own-delivery slots. */
31895
+ fulfillment_type?: string;
31726
31896
  /** @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
31897
  lang?: string;
31728
31898
  };
package/dist/index.d.ts CHANGED
@@ -3086,6 +3086,30 @@ interface paths {
3086
3086
  patch?: never;
3087
3087
  trace?: never;
3088
3088
  };
3089
+ "/api/v1/discovery/stores/": {
3090
+ parameters: {
3091
+ query?: never;
3092
+ header?: never;
3093
+ path?: never;
3094
+ cookie?: never;
3095
+ };
3096
+ /**
3097
+ * @description The ``public_id`` of every store on the ExploreSOUS channel.
3098
+ *
3099
+ * A flat membership set, deliberately not a field on the partner index:
3100
+ * that read is brand-grouped and does not say how many locations a brand
3101
+ * has, and this one is a different question. It reveals nothing
3102
+ * ExploreSOUS's sitemap does not, which publishes a URL for every one.
3103
+ */
3104
+ get: operations["discovery_stores_retrieve"];
3105
+ put?: never;
3106
+ post?: never;
3107
+ delete?: never;
3108
+ options?: never;
3109
+ head?: never;
3110
+ patch?: never;
3111
+ trace?: never;
3112
+ };
3089
3113
  "/api/v1/fulfillment/address-check/": {
3090
3114
  parameters: {
3091
3115
  query?: never;
@@ -7451,6 +7475,102 @@ interface components {
7451
7475
  * @enum {string}
7452
7476
  */
7453
7477
  ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
7478
+ /** @description Serialized checkout data for API responses. */
7479
+ Checkout: {
7480
+ id: string;
7481
+ cart_id: string;
7482
+ store_id: number;
7483
+ channel_id: number | null;
7484
+ status: string;
7485
+ currency: string;
7486
+ display_currency: string;
7487
+ fx_rate_to_display: string;
7488
+ email: string | null;
7489
+ shipping_address: {
7490
+ [key: string]: unknown;
7491
+ } | null;
7492
+ billing_address: {
7493
+ [key: string]: unknown;
7494
+ } | null;
7495
+ shipping_method: {
7496
+ [key: string]: string;
7497
+ } | null;
7498
+ payment_method: string | null;
7499
+ payment_status: string | null;
7500
+ line_items: {
7501
+ [key: string]: unknown;
7502
+ }[];
7503
+ tax_components: {
7504
+ [key: string]: unknown;
7505
+ }[];
7506
+ subtotal: string;
7507
+ tax_total: string;
7508
+ shipping_cost: string;
7509
+ surcharge_total: string;
7510
+ display_surcharge_total: string;
7511
+ deposit_total: string;
7512
+ display_deposit_total: string;
7513
+ packaging_choice: string;
7514
+ discount_amount: string;
7515
+ discount_code: string | null;
7516
+ discount_name: string | null;
7517
+ applied_promotion_id: number | null;
7518
+ promotion_discount_amount: string;
7519
+ total: string;
7520
+ service_fees: {
7521
+ [key: string]: unknown;
7522
+ };
7523
+ platform_fee_customer: string;
7524
+ platform_fee_merchant: string;
7525
+ delivery_fee_customer: string;
7526
+ delivery_fee_merchant: string;
7527
+ service_fees_total: string;
7528
+ display_service_fees_total: string;
7529
+ display_subtotal: string;
7530
+ display_tax_total: string;
7531
+ display_shipping_cost: string;
7532
+ display_discount_amount: string;
7533
+ display_promotion_discount_amount: string;
7534
+ display_total: string;
7535
+ fulfillment_slot_id: string | null;
7536
+ service_point_id: string | null;
7537
+ gift_card_details: {
7538
+ [key: string]: unknown;
7539
+ } | null;
7540
+ gift_card_redemptions: {
7541
+ id: number;
7542
+ masked_code: string;
7543
+ amount: string;
7544
+ currency: string;
7545
+ state: string;
7546
+ }[];
7547
+ gift_card_redemption_amount: string;
7548
+ display_gift_card_redemption_amount: string;
7549
+ points_to_redeem: number;
7550
+ points_discount_amount: string;
7551
+ display_points_discount_amount: string;
7552
+ customer_id: number | null;
7553
+ order_number: string | null;
7554
+ purpose: string;
7555
+ attribution: {
7556
+ [key: string]: string;
7557
+ } | null;
7558
+ marketing_consent: {
7559
+ [key: string]: unknown;
7560
+ } | null;
7561
+ warnings: {
7562
+ [key: string]: string;
7563
+ }[];
7564
+ available_payment_gateways: {
7565
+ [key: string]: unknown;
7566
+ }[] | null;
7567
+ created_at: string | null;
7568
+ updated_at: string | null;
7569
+ shipping_groups: {
7570
+ id: string;
7571
+ required_minimum_age: number | null;
7572
+ }[];
7573
+ };
7454
7574
  /**
7455
7575
  * @description Ad-click and campaign identifiers captured by the storefront at landing.
7456
7576
  *
@@ -7925,6 +8045,7 @@ interface components {
7925
8045
  price_band: number | null;
7926
8046
  michelin_stars: number | null;
7927
8047
  tags: string[];
8048
+ book_url: string;
7928
8049
  };
7929
8050
  /**
7930
8051
  * @description The whole directory plus its filter vocabulary, in one read.
@@ -7936,6 +8057,10 @@ interface components {
7936
8057
  tags: components["schemas"]["DiscoveryTag"][];
7937
8058
  partners: components["schemas"]["DiscoveryPartner"][];
7938
8059
  };
8060
+ /** @description The stores ExploreSOUS serves, as ``X-Vendor-ID`` values. */
8061
+ DiscoveryStoreMembership: {
8062
+ store_ids: string[];
8063
+ };
7939
8064
  /** @description One filter option, already named in the reader's language. */
7940
8065
  DiscoveryTag: {
7941
8066
  slug: string;
@@ -11298,9 +11423,21 @@ interface components {
11298
11423
  dismissible?: boolean;
11299
11424
  /** @description How long a dismiss lasts. NULL = permanent until message updated. */
11300
11425
  dismiss_duration?: string | null;
11301
- readonly contents: {
11302
- [key: string]: unknown;
11303
- }[];
11426
+ readonly contents: components["schemas"]["WidgetMessageContent"][];
11427
+ };
11428
+ WidgetMessageContent: {
11429
+ /** Format: uuid */
11430
+ readonly id: string;
11431
+ surface: components["schemas"]["SurfaceEnum"];
11432
+ readonly headline: string;
11433
+ readonly body: string;
11434
+ readonly cta_label: string;
11435
+ /** Format: uri */
11436
+ cta_url?: string;
11437
+ theme?: components["schemas"]["ThemeEnum"];
11438
+ /** @description Optional overrides: {"bg": "#fff", "text": "#000", "accent": "#f00"} */
11439
+ custom_colors?: unknown;
11440
+ extra?: unknown;
11304
11441
  };
11305
11442
  /** @description POST /api/v1/withdrawals/confirm input. */
11306
11443
  WithdrawalConfirmRequest: {
@@ -20512,9 +20649,7 @@ interface operations {
20512
20649
  [name: string]: unknown;
20513
20650
  };
20514
20651
  content: {
20515
- "application/json": {
20516
- [key: string]: unknown;
20517
- };
20652
+ "application/json": components["schemas"]["Checkout"];
20518
20653
  };
20519
20654
  };
20520
20655
  /** @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 +20745,7 @@ interface operations {
20610
20745
  [name: string]: unknown;
20611
20746
  };
20612
20747
  content: {
20613
- "application/json": {
20614
- [key: string]: unknown;
20615
- };
20748
+ "application/json": components["schemas"]["Checkout"];
20616
20749
  };
20617
20750
  };
20618
20751
  /** @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 +20951,7 @@ interface operations {
20818
20951
  [name: string]: unknown;
20819
20952
  };
20820
20953
  content: {
20821
- "application/json": {
20822
- [key: string]: unknown;
20823
- };
20954
+ "application/json": components["schemas"]["Checkout"];
20824
20955
  };
20825
20956
  };
20826
20957
  /** @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 +21050,7 @@ interface operations {
20919
21050
  [name: string]: unknown;
20920
21051
  };
20921
21052
  content: {
20922
- "application/json": {
20923
- [key: string]: unknown;
20924
- };
21053
+ "application/json": components["schemas"]["Checkout"];
20925
21054
  };
20926
21055
  };
20927
21056
  /** @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 +21149,7 @@ interface operations {
21020
21149
  [name: string]: unknown;
21021
21150
  };
21022
21151
  content: {
21023
- "application/json": {
21024
- [key: string]: unknown;
21025
- };
21152
+ "application/json": components["schemas"]["Checkout"];
21026
21153
  };
21027
21154
  };
21028
21155
  /** @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 +21242,7 @@ interface operations {
21115
21242
  [name: string]: unknown;
21116
21243
  };
21117
21244
  content: {
21118
- "application/json": {
21119
- [key: string]: unknown;
21120
- };
21245
+ "application/json": components["schemas"]["Checkout"];
21121
21246
  };
21122
21247
  };
21123
21248
  /** @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 +21469,7 @@ interface operations {
21344
21469
  [name: string]: unknown;
21345
21470
  };
21346
21471
  content: {
21347
- "application/json": {
21348
- [key: string]: unknown;
21349
- };
21472
+ "application/json": components["schemas"]["Checkout"];
21350
21473
  };
21351
21474
  };
21352
21475
  /** @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 +21666,7 @@ interface operations {
21543
21666
  [name: string]: unknown;
21544
21667
  };
21545
21668
  content: {
21546
- "application/json": {
21547
- [key: string]: unknown;
21548
- };
21669
+ "application/json": components["schemas"]["Checkout"];
21549
21670
  };
21550
21671
  };
21551
21672
  /** @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 +21765,7 @@ interface operations {
21644
21765
  [name: string]: unknown;
21645
21766
  };
21646
21767
  content: {
21647
- "application/json": {
21648
- [key: string]: unknown;
21649
- };
21768
+ "application/json": components["schemas"]["Checkout"];
21650
21769
  };
21651
21770
  };
21652
21771
  /** @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 +22169,7 @@ interface operations {
22050
22169
  [name: string]: unknown;
22051
22170
  };
22052
22171
  content: {
22053
- "application/json": {
22054
- [key: string]: unknown;
22055
- };
22172
+ "application/json": components["schemas"]["Checkout"];
22056
22173
  };
22057
22174
  };
22058
22175
  /** @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 +22360,7 @@ interface operations {
22243
22360
  [name: string]: unknown;
22244
22361
  };
22245
22362
  content: {
22246
- "application/json": {
22247
- [key: string]: unknown;
22248
- };
22363
+ "application/json": components["schemas"]["Checkout"];
22249
22364
  };
22250
22365
  };
22251
22366
  /** @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 +22453,7 @@ interface operations {
22338
22453
  [name: string]: unknown;
22339
22454
  };
22340
22455
  content: {
22341
- "application/json": {
22342
- [key: string]: unknown;
22343
- };
22456
+ "application/json": components["schemas"]["Checkout"];
22344
22457
  };
22345
22458
  };
22346
22459
  /** @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 +22546,7 @@ interface operations {
22433
22546
  [name: string]: unknown;
22434
22547
  };
22435
22548
  content: {
22436
- "application/json": {
22437
- [key: string]: unknown;
22438
- };
22549
+ "application/json": components["schemas"]["Checkout"];
22439
22550
  };
22440
22551
  };
22441
22552
  /** @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. */
@@ -25649,6 +25760,61 @@ interface operations {
25649
25760
  };
25650
25761
  };
25651
25762
  };
25763
+ discovery_stores_retrieve: {
25764
+ parameters: {
25765
+ query?: never;
25766
+ header?: never;
25767
+ path?: never;
25768
+ cookie?: never;
25769
+ };
25770
+ requestBody?: never;
25771
+ responses: {
25772
+ 200: {
25773
+ headers: {
25774
+ [name: string]: unknown;
25775
+ };
25776
+ content: {
25777
+ "application/json": components["schemas"]["DiscoveryStoreMembership"];
25778
+ };
25779
+ };
25780
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
25781
+ 400: {
25782
+ headers: {
25783
+ [name: string]: unknown;
25784
+ };
25785
+ content: {
25786
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25787
+ };
25788
+ };
25789
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
25790
+ 404: {
25791
+ headers: {
25792
+ [name: string]: unknown;
25793
+ };
25794
+ content: {
25795
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25796
+ };
25797
+ };
25798
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
25799
+ 429: {
25800
+ headers: {
25801
+ [name: string]: unknown;
25802
+ };
25803
+ content: {
25804
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25805
+ };
25806
+ };
25807
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
25808
+ 500: {
25809
+ headers: {
25810
+ [name: string]: unknown;
25811
+ };
25812
+ content: {
25813
+ "application/json": components["schemas"]["APIErrorEnvelope"];
25814
+ };
25815
+ };
25816
+ };
25817
+ };
25652
25818
  fulfillment_address_check_create: {
25653
25819
  parameters: {
25654
25820
  query?: never;
@@ -28144,8 +28310,8 @@ interface operations {
28144
28310
  merchant_comms_storefront_active_list: {
28145
28311
  parameters: {
28146
28312
  query?: {
28147
- /** @description Comma-separated surface types to fetch. */
28148
- surfaces?: "bottom_banner" | "inline_cart" | "inline_checkout" | "modal" | "toast" | "top_banner";
28313
+ /** @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. */
28314
+ surfaces?: ("top_banner" | "bottom_banner" | "modal" | "toast" | "inline_cart" | "inline_checkout")[];
28149
28315
  };
28150
28316
  header?: never;
28151
28317
  path?: never;
@@ -31722,7 +31888,11 @@ interface operations {
31722
31888
  };
31723
31889
  pickup_locations_time_slots_retrieve: {
31724
31890
  parameters: {
31725
- query?: {
31891
+ query: {
31892
+ /** @description Requested date in ISO-8601 format (YYYY-MM-DD). */
31893
+ date: string;
31894
+ /** @description Set to `local_delivery` to return own-delivery slots. */
31895
+ fulfillment_type?: string;
31726
31896
  /** @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
31897
  lang?: string;
31728
31898
  };
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.1.0",
4
4
  "description": "Type-safe TypeScript SDK for all SOUS Storefront Backend endpoints",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,