@poweredbysous/storefront-all-sdk 3.0.0 → 3.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.
Files changed (3) hide show
  1. package/dist/index.d.cts +1857 -129
  2. package/dist/index.d.ts +1857 -129
  3. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -365,6 +365,38 @@ interface paths {
365
365
  patch: operations["admin_discounts_partial_update"];
366
366
  trace?: never;
367
367
  };
368
+ "/api/v1/admin/locations/delivery-methods/": {
369
+ parameters: {
370
+ query?: never;
371
+ header?: never;
372
+ path?: never;
373
+ cookie?: never;
374
+ };
375
+ /**
376
+ * Summarise delivery-method state for several Locations
377
+ * @description ``GET /api/v1/admin/locations/delivery-methods/?pair=<store>:<location>``.
378
+ *
379
+ * Read-only, many-location counterpart of ``StoreDeliveryMethodListView``
380
+ * for the Portal's Locations list: each method's on/off state and
381
+ * ``disabled_at`` per (store, location) pair, without the retained config.
382
+ * The caller names the pairs (it already knows each Location's Vendors), so
383
+ * this never infers membership from ``LocationStoreLink``, which may not be
384
+ * populated yet for a store — see ``_location_linked_to_store``.
385
+ *
386
+ * Same visibility rules as the single-location list: methods the company
387
+ * hasn't made available are omitted, and a pair whose store belongs to
388
+ * another company is silently dropped rather than reported, so it can't be
389
+ * used to probe for other companies' ids.
390
+ */
391
+ get: operations["admin_locations_delivery_methods_list"];
392
+ put?: never;
393
+ post?: never;
394
+ delete?: never;
395
+ options?: never;
396
+ head?: never;
397
+ patch?: never;
398
+ trace?: never;
399
+ };
368
400
  "/api/v1/admin/pages/": {
369
401
  parameters: {
370
402
  query?: never;
@@ -883,6 +915,50 @@ interface paths {
883
915
  patch?: never;
884
916
  trace?: never;
885
917
  };
918
+ "/api/v1/admin/stores/{store_public_id}/base-coverage/": {
919
+ parameters: {
920
+ query?: never;
921
+ header?: never;
922
+ path?: never;
923
+ cookie?: never;
924
+ };
925
+ /**
926
+ * @description The rule this location's drawn areas are added to.
927
+ *
928
+ * Reuses ``_DrawnShapeViewSet`` for store resolution, the row lock and the
929
+ * shared-provider 409 — the parts that are dangerous and identical — but
930
+ * exposes a single object rather than a collection, because a location has
931
+ * one base coverage, not a list of them.
932
+ *
933
+ * ``mode`` is derived on read rather than stored. The modes are a *reading*
934
+ * of the rules already on the row, so a stored discriminator could disagree
935
+ * with the rules that actually decide coverage, and the rules would win. See
936
+ * ``base_coverage.mode_of``, and the module docstring there for why the
937
+ * portal is allowed to write a field the sync serializer also lists.
938
+ */
939
+ get: operations["admin_stores_base_coverage_retrieve"];
940
+ /**
941
+ * @description The rule this location's drawn areas are added to.
942
+ *
943
+ * Reuses ``_DrawnShapeViewSet`` for store resolution, the row lock and the
944
+ * shared-provider 409 — the parts that are dangerous and identical — but
945
+ * exposes a single object rather than a collection, because a location has
946
+ * one base coverage, not a list of them.
947
+ *
948
+ * ``mode`` is derived on read rather than stored. The modes are a *reading*
949
+ * of the rules already on the row, so a stored discriminator could disagree
950
+ * with the rules that actually decide coverage, and the rules would win. See
951
+ * ``base_coverage.mode_of``, and the module docstring there for why the
952
+ * portal is allowed to write a field the sync serializer also lists.
953
+ */
954
+ put: operations["admin_stores_base_coverage_update"];
955
+ post?: never;
956
+ delete?: never;
957
+ options?: never;
958
+ head?: never;
959
+ patch?: never;
960
+ trace?: never;
961
+ };
886
962
  "/api/v1/admin/stores/{store_public_id}/compliance-defaults/": {
887
963
  parameters: {
888
964
  query?: never;
@@ -944,6 +1020,144 @@ interface paths {
944
1020
  patch?: never;
945
1021
  trace?: never;
946
1022
  };
1023
+ "/api/v1/admin/stores/{store_public_id}/delivery-areas/": {
1024
+ parameters: {
1025
+ query?: never;
1026
+ header?: never;
1027
+ path?: never;
1028
+ cookie?: never;
1029
+ };
1030
+ /** @description List the shapes of this kind stored for the location. */
1031
+ get: operations["admin_stores_delivery_areas_list"];
1032
+ put?: never;
1033
+ /** @description Add one shape, leaving every other entry untouched. */
1034
+ post: operations["admin_stores_delivery_areas_create"];
1035
+ delete?: never;
1036
+ options?: never;
1037
+ head?: never;
1038
+ patch?: never;
1039
+ trace?: never;
1040
+ };
1041
+ "/api/v1/admin/stores/{store_public_id}/delivery-areas/{shape_id}/": {
1042
+ parameters: {
1043
+ query?: never;
1044
+ header?: never;
1045
+ path?: never;
1046
+ cookie?: never;
1047
+ };
1048
+ get?: never;
1049
+ put?: never;
1050
+ post?: never;
1051
+ /** @description Remove one shape, leaving the rest of the coverage intact. */
1052
+ delete: operations["admin_stores_delivery_areas_destroy"];
1053
+ options?: never;
1054
+ head?: never;
1055
+ /** @description Reshape or rename one shape, leaving the others untouched. */
1056
+ patch: operations["admin_stores_delivery_areas_partial_update"];
1057
+ trace?: never;
1058
+ };
1059
+ "/api/v1/admin/stores/{store_public_id}/delivery-exclusions/": {
1060
+ parameters: {
1061
+ query?: never;
1062
+ header?: never;
1063
+ path?: never;
1064
+ cookie?: never;
1065
+ };
1066
+ /** @description List the shapes of this kind stored for the location. */
1067
+ get: operations["admin_stores_delivery_exclusions_list"];
1068
+ put?: never;
1069
+ /** @description Add one shape, leaving every other entry untouched. */
1070
+ post: operations["admin_stores_delivery_exclusions_create"];
1071
+ delete?: never;
1072
+ options?: never;
1073
+ head?: never;
1074
+ patch?: never;
1075
+ trace?: never;
1076
+ };
1077
+ "/api/v1/admin/stores/{store_public_id}/delivery-exclusions/{shape_id}/": {
1078
+ parameters: {
1079
+ query?: never;
1080
+ header?: never;
1081
+ path?: never;
1082
+ cookie?: never;
1083
+ };
1084
+ get?: never;
1085
+ put?: never;
1086
+ post?: never;
1087
+ /** @description Remove one shape, leaving the rest of the coverage intact. */
1088
+ delete: operations["admin_stores_delivery_exclusions_destroy"];
1089
+ options?: never;
1090
+ head?: never;
1091
+ /** @description Reshape or rename one shape, leaving the others untouched. */
1092
+ patch: operations["admin_stores_delivery_exclusions_partial_update"];
1093
+ trace?: never;
1094
+ };
1095
+ "/api/v1/admin/stores/{store_public_id}/delivery-fee/": {
1096
+ parameters: {
1097
+ query?: never;
1098
+ header?: never;
1099
+ path?: never;
1100
+ cookie?: never;
1101
+ };
1102
+ /**
1103
+ * @description What a customer is charged for this location's own delivery.
1104
+ *
1105
+ * A singleton on the same resolution/lock/409 base as the shapes. The
1106
+ * portal may write these for the reason ``base_coverage.py`` gives for the
1107
+ * radius: they are in the sync serializer's field list, but the only thing
1108
+ * that ever sends them is the hand-run ``set_store_delivery_method``
1109
+ * command — the ops task this feature replaces — so there is no routine
1110
+ * second writer.
1111
+ */
1112
+ get: operations["admin_stores_delivery_fee_retrieve"];
1113
+ /**
1114
+ * @description What a customer is charged for this location's own delivery.
1115
+ *
1116
+ * A singleton on the same resolution/lock/409 base as the shapes. The
1117
+ * portal may write these for the reason ``base_coverage.py`` gives for the
1118
+ * radius: they are in the sync serializer's field list, but the only thing
1119
+ * that ever sends them is the hand-run ``set_store_delivery_method``
1120
+ * command — the ops task this feature replaces — so there is no routine
1121
+ * second writer.
1122
+ */
1123
+ put: operations["admin_stores_delivery_fee_update"];
1124
+ post?: never;
1125
+ delete?: never;
1126
+ options?: never;
1127
+ head?: never;
1128
+ patch?: never;
1129
+ trace?: never;
1130
+ };
1131
+ "/api/v1/admin/stores/{store_public_id}/delivery-fee-split/": {
1132
+ parameters: {
1133
+ query?: never;
1134
+ header?: never;
1135
+ path?: never;
1136
+ cookie?: never;
1137
+ };
1138
+ /**
1139
+ * Get a store's delivery-fee split
1140
+ * @description The merchant portal has to show the current split before it can
1141
+ * offer to change it.
1142
+ */
1143
+ get: operations["admin_stores_delivery_fee_split_retrieve"];
1144
+ put?: never;
1145
+ post?: never;
1146
+ delete?: never;
1147
+ options?: never;
1148
+ head?: never;
1149
+ /**
1150
+ * Set a store's delivery-fee split
1151
+ * @description Read/write a store's merchant/customer delivery-fee split.
1152
+ *
1153
+ * Auth and company scoping mirror ``AdminStoreComplianceDefaultsView``:
1154
+ * Firebase merchant auth, store resolved via ``resolve_active_company`` +
1155
+ * ``public_id`` so a merchant can only ever reach their own company's
1156
+ * store, never another company's.
1157
+ */
1158
+ patch: operations["admin_stores_delivery_fee_split_partial_update"];
1159
+ trace?: never;
1160
+ };
947
1161
  "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
948
1162
  parameters: {
949
1163
  query?: never;
@@ -2034,6 +2248,31 @@ interface paths {
2034
2248
  patch?: never;
2035
2249
  trace?: never;
2036
2250
  };
2251
+ "/api/v1/checkout/{checkout_id}/marketing-consent/": {
2252
+ parameters: {
2253
+ query?: never;
2254
+ header?: never;
2255
+ path?: never;
2256
+ cookie?: never;
2257
+ };
2258
+ get?: never;
2259
+ put?: never;
2260
+ post?: never;
2261
+ delete?: never;
2262
+ options?: never;
2263
+ head?: never;
2264
+ /**
2265
+ * @description PATCH /api/v1/checkout/{id}/marketing-consent/ — the customer's opt-in
2266
+ * for special offers and updates.
2267
+ *
2268
+ * Kept off the delivery PATCH deliberately: consent is an independent choice
2269
+ * the customer can toggle at any point in the flow, and folding it into
2270
+ * ``set_delivery`` would force a ``DELIVERY_SET`` transition on a write that
2271
+ * changes no totals. Store-scoped like every other checkout mutation.
2272
+ */
2273
+ patch: operations["checkout_marketing_consent_partial_update"];
2274
+ trace?: never;
2275
+ };
2037
2276
  "/api/v1/checkout/{checkout_id}/packaging-choice/": {
2038
2277
  parameters: {
2039
2278
  query?: never;
@@ -6420,6 +6659,21 @@ interface components {
6420
6659
  */
6421
6660
  reusable_deposit_id?: number | null;
6422
6661
  };
6662
+ /**
6663
+ * @description Read/write view of a store's merchant/customer delivery-fee split.
6664
+ *
6665
+ * ``delivery_fee_customer_pct`` is the fraction (0-1) of the shipping cost
6666
+ * the customer pays; the merchant absorbs the remainder — see
6667
+ * ``core.fees.apply_pass_through``. DRF derives 0-1 bounds validation from
6668
+ * the model field's own validators.
6669
+ */
6670
+ AdminStoreDeliveryFeeSplit: {
6671
+ /**
6672
+ * Format: decimal
6673
+ * @description Fraction of shipping cost the customer pays (0-1). Merchant absorbs the remainder.
6674
+ */
6675
+ delivery_fee_customer_pct?: string;
6676
+ };
6423
6677
  /**
6424
6678
  * @description Per-store fulfilment capability for the merchant offers UI.
6425
6679
  *
@@ -6513,6 +6767,23 @@ interface components {
6513
6767
  masked_code: string;
6514
6768
  requires_security_code: boolean;
6515
6769
  };
6770
+ /**
6771
+ * @description The rule a location's drawn areas are added to.
6772
+ *
6773
+ * ``mode`` is derived from the rules on read (see ``base_coverage.mode_of``)
6774
+ * and drives which of the other fields matters on write — the client sends
6775
+ * the whole shape and the server decides what to keep, so a merchant who
6776
+ * switches from Radius to Postcodes does not leave a stale radius behind
6777
+ * still granting coverage.
6778
+ */
6779
+ BaseCoverage: {
6780
+ mode: components["schemas"]["ModeEnum"];
6781
+ /** Format: decimal */
6782
+ radius_km?: string | null;
6783
+ postcodes?: string[];
6784
+ readonly drawn_area_count: number;
6785
+ readonly origin: components["schemas"]["_Origin"] | null;
6786
+ };
6516
6787
  /**
6517
6788
  * @description * `free` - Free
6518
6789
  * * `percentage` - Percentage Off
@@ -7210,6 +7481,64 @@ interface components {
7210
7481
  /** @default */
7211
7482
  description: string;
7212
7483
  };
7484
+ /**
7485
+ * @description * `before_close` - A notice before the day closes
7486
+ * * `by_day` - A time set for each day
7487
+ * @enum {string}
7488
+ */
7489
+ CutoffModeEnum: "before_close" | "by_day";
7490
+ /**
7491
+ * @description One area a merchant drew on a map.
7492
+ *
7493
+ * ``id`` is read-only: it is minted server-side so that a client cannot
7494
+ * address — or overwrite — an area it does not own, the same discipline the
7495
+ * store id gets on every other company-scoped admin endpoint.
7496
+ */
7497
+ DeliveryArea: {
7498
+ readonly id: string;
7499
+ /** @description What the merchant calls this area, e.g. 'North of the canal'. */
7500
+ name?: string;
7501
+ /** @description A GeoJSON Polygon with a single closed ring, [longitude, latitude], WGS84. A point on the boundary counts as inside. */
7502
+ polygon: unknown;
7503
+ };
7504
+ /**
7505
+ * @description One pocket a merchant cut out of their coverage.
7506
+ *
7507
+ * A separate serializer rather than a flag on :class:`DeliveryAreaSerializer`
7508
+ * because the wire key is what makes a pocket safe: a reader that predates
7509
+ * exclusions must not be able to mistake one for coverage. See the
7510
+ * ``delivery_areas`` module docstring and workspace ADR 0014.
7511
+ */
7512
+ DeliveryExclusion: {
7513
+ readonly id: string;
7514
+ /** @description What the merchant calls this pocket, e.g. 'Canal island'. */
7515
+ name?: string;
7516
+ /** @description A GeoJSON Polygon with a single closed ring, [longitude, latitude], WGS84. Addresses inside it are never delivered to, whatever the location's other coverage rules say. A point on the boundary counts as excluded. */
7517
+ excluded_polygon: unknown;
7518
+ };
7519
+ /**
7520
+ * @description What a customer is charged for this location's own delivery.
7521
+ *
7522
+ * Two numbers, not the customer/restaurant *split* the design also shows.
7523
+ * That division has no field anywhere yet — merchant-portal-backend's
7524
+ * ``delivery_fee_fixed`` is the platform's charge *to* the restaurant, a
7525
+ * finance setting, not the same thing — and it is what PAT-2186 decides.
7526
+ * Until then this exposes the total and the free-delivery threshold, which
7527
+ * the storefront already reads on every rate.
7528
+ */
7529
+ DeliveryFee: {
7530
+ /** Format: decimal */
7531
+ base_delivery_fee: string;
7532
+ /** Format: decimal */
7533
+ free_delivery_threshold?: string | null;
7534
+ };
7535
+ /** @description One method's on/off state at one store+location — the summary's leaf. */
7536
+ DeliveryMethodState: {
7537
+ method: components["schemas"]["MethodEnum"];
7538
+ is_enabled: boolean;
7539
+ /** Format: date-time */
7540
+ disabled_at: string | null;
7541
+ };
7213
7542
  /**
7214
7543
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
7215
7544
  *
@@ -7749,6 +8078,11 @@ interface components {
7749
8078
  LightspeedWebhook: {
7750
8079
  endpoint_id: string;
7751
8080
  };
8081
+ /** @description One location's delivery-method state, grouped by the stores serving it. */
8082
+ LocationDeliveryMethodSummary: {
8083
+ location_public_id: string;
8084
+ stores: components["schemas"]["StoreDeliveryMethodStates"][];
8085
+ };
7752
8086
  /**
7753
8087
  * @description * `single` - Single location
7754
8088
  * * `subset` - Subset of locations
@@ -7962,6 +8296,13 @@ interface components {
7962
8296
  * @enum {string}
7963
8297
  */
7964
8298
  MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
8299
+ /**
8300
+ * @description * `drawn` - drawn
8301
+ * * `radius` - radius
8302
+ * * `postcodes` - postcodes
8303
+ * @enum {string}
8304
+ */
8305
+ ModeEnum: "drawn" | "radius" | "postcodes";
7965
8306
  ModifyLineItem: {
7966
8307
  /** Format: uuid */
7967
8308
  order_line_item_id: string;
@@ -8692,6 +9033,21 @@ interface components {
8692
9033
  */
8693
9034
  reusable_deposit_id?: number | null;
8694
9035
  };
9036
+ /**
9037
+ * @description Read/write view of a store's merchant/customer delivery-fee split.
9038
+ *
9039
+ * ``delivery_fee_customer_pct`` is the fraction (0-1) of the shipping cost
9040
+ * the customer pays; the merchant absorbs the remainder — see
9041
+ * ``core.fees.apply_pass_through``. DRF derives 0-1 bounds validation from
9042
+ * the model field's own validators.
9043
+ */
9044
+ PatchedAdminStoreDeliveryFeeSplit: {
9045
+ /**
9046
+ * Format: decimal
9047
+ * @description Fraction of shipping cost the customer pays (0-1). Merchant absorbs the remainder.
9048
+ */
9049
+ delivery_fee_customer_pct?: string;
9050
+ };
8695
9051
  /**
8696
9052
  * @description Validates the request body for binding a service point to a cart.
8697
9053
  *
@@ -8740,6 +9096,20 @@ interface components {
8740
9096
  /** @default */
8741
9097
  description: string;
8742
9098
  };
9099
+ /** @description A partial edit: rename an area, reshape it, or both. */
9100
+ PatchedDeliveryAreaUpdate: {
9101
+ readonly id?: string;
9102
+ /** @description What the merchant calls this area, e.g. 'North of the canal'. */
9103
+ name?: string;
9104
+ polygon?: unknown;
9105
+ };
9106
+ /** @description A partial edit: rename a pocket, reshape it, or both. */
9107
+ PatchedDeliveryExclusionUpdate: {
9108
+ readonly id?: string;
9109
+ /** @description What the merchant calls this pocket, e.g. 'Canal island'. */
9110
+ name?: string;
9111
+ excluded_polygon?: unknown;
9112
+ };
8743
9113
  /**
8744
9114
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
8745
9115
  *
@@ -8832,6 +9202,24 @@ interface components {
8832
9202
  /** Format: date-time */
8833
9203
  readonly updated_at?: string;
8834
9204
  };
9205
+ /**
9206
+ * @description Marketing consent captured at checkout.
9207
+ *
9208
+ * A single opt-in for special offers and updates (over email, SMS or
9209
+ * WhatsApp), plus the version identifier of the consent copy the customer
9210
+ * saw. Stored on the checkout and copied to the order at creation, then
9211
+ * forwarded to the merchant portal, which persists it onto the customer
9212
+ * record. Unticked by default; the order completes regardless of state.
9213
+ */
9214
+ PatchedMarketingConsentInput: {
9215
+ /** @default false */
9216
+ opted_in: boolean;
9217
+ /**
9218
+ * @description Version id of the consent copy shown to the customer.
9219
+ * @default
9220
+ */
9221
+ version: string;
9222
+ };
8835
9223
  PatchedMessageUpdate: {
8836
9224
  priority?: number;
8837
9225
  /** Format: date-time */
@@ -8961,6 +9349,9 @@ interface components {
8961
9349
  fee_split_percentage?: string | null;
8962
9350
  schedule?: unknown;
8963
9351
  lead_time_minutes?: number | null;
9352
+ cutoff_mode?: components["schemas"]["CutoffModeEnum"];
9353
+ cutoff_minutes?: number | null;
9354
+ cutoff_by_day?: unknown;
8964
9355
  };
8965
9356
  /**
8966
9357
  * @description Read/write serializer for the store-onboarding wizard.
@@ -10038,8 +10429,22 @@ interface components {
10038
10429
  fee_split_percentage: string | null;
10039
10430
  schedule: unknown;
10040
10431
  lead_time_minutes: number | null;
10432
+ cutoff_mode: components["schemas"]["CutoffModeEnum"];
10433
+ /** @description Minutes before a day closes that it stops taking orders. NULL means this location sets no cut-off of its own -- it does NOT mean zero. */
10434
+ cutoff_minutes: number | null;
10435
+ /** @description Weekday -> 'HH:MM', the absolute last-order time per day, read only in by_day mode. Its own field rather than a key inside schedule: the editor writes the times here, and a schedule is hours. */
10436
+ cutoff_by_day: unknown;
10437
+ /** @description Per day, the last-order cut-off actually in force and which setting produced it. Read-only: the merchant's own value may be clamped by the kitchen's schedule, and a screen that shows only what was typed cannot tell a clamped value from one that failed to save. */
10438
+ readonly cutoff_in_force: unknown;
10041
10439
  /** Format: date-time */
10042
10440
  config_updated_at: string | null;
10441
+ /** Format: date-time */
10442
+ disabled_at: string | null;
10443
+ };
10444
+ /** @description Every company-available method's state at one store for one location. */
10445
+ StoreDeliveryMethodStates: {
10446
+ store_public_id: string;
10447
+ methods: components["schemas"]["DeliveryMethodState"][];
10043
10448
  };
10044
10449
  StoreMeResponse: {
10045
10450
  id: number;
@@ -10463,6 +10868,13 @@ interface components {
10463
10868
  order_line_item_id: string;
10464
10869
  quantity?: number;
10465
10870
  };
10871
+ /** @description A point, as ``MerchantShippingProvider`` stores it. */
10872
+ _Origin: {
10873
+ /** Format: decimal */
10874
+ latitude: string;
10875
+ /** Format: decimal */
10876
+ longitude: string;
10877
+ };
10466
10878
  /** @description A product a promotion grants as its benefit (id + translated name). */
10467
10879
  _PromotionBenefitProduct: {
10468
10880
  id: number;
@@ -11708,13 +12120,16 @@ interface operations {
11708
12120
  };
11709
12121
  };
11710
12122
  };
11711
- admin_pages_list: {
12123
+ admin_locations_delivery_methods_list: {
11712
12124
  parameters: {
11713
- query?: {
11714
- /** @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`. */
11715
- lang?: string;
12125
+ query: {
12126
+ /** @description Repeated ``<store_public_id>:<location_public_id>``, one per store serving a location. At most 50. */
12127
+ pair: string[];
12128
+ };
12129
+ header?: {
12130
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
12131
+ "X-Sous-Company-Id"?: number;
11716
12132
  };
11717
- header?: never;
11718
12133
  path?: never;
11719
12134
  cookie?: never;
11720
12135
  };
@@ -11725,12 +12140,10 @@ interface operations {
11725
12140
  [name: string]: unknown;
11726
12141
  };
11727
12142
  content: {
11728
- "application/json": {
11729
- [key: string]: unknown;
11730
- };
12143
+ "application/json": components["schemas"]["LocationDeliveryMethodSummary"][];
11731
12144
  };
11732
12145
  };
11733
- /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_BLOCK_TYPE`. Use `x-error-codes` for machine-readable retryability metadata. */
12146
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
11734
12147
  400: {
11735
12148
  headers: {
11736
12149
  [name: string]: unknown;
@@ -11757,7 +12170,7 @@ interface operations {
11757
12170
  "application/json": components["schemas"]["APIErrorEnvelope"];
11758
12171
  };
11759
12172
  };
11760
- /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PAGE_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `BLOCK_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
12173
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
11761
12174
  404: {
11762
12175
  headers: {
11763
12176
  [name: string]: unknown;
@@ -11786,28 +12199,19 @@ interface operations {
11786
12199
  };
11787
12200
  };
11788
12201
  };
11789
- admin_pages_create: {
12202
+ admin_pages_list: {
11790
12203
  parameters: {
11791
- query?: never;
12204
+ query?: {
12205
+ /** @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`. */
12206
+ lang?: string;
12207
+ };
11792
12208
  header?: never;
11793
12209
  path?: never;
11794
12210
  cookie?: never;
11795
12211
  };
11796
- requestBody?: {
11797
- content: {
11798
- "application/json": {
11799
- [key: string]: unknown;
11800
- };
11801
- "application/x-www-form-urlencoded": {
11802
- [key: string]: unknown;
11803
- };
11804
- "multipart/form-data": {
11805
- [key: string]: unknown;
11806
- };
11807
- };
11808
- };
12212
+ requestBody?: never;
11809
12213
  responses: {
11810
- 201: {
12214
+ 200: {
11811
12215
  headers: {
11812
12216
  [name: string]: unknown;
11813
12217
  };
@@ -11873,15 +12277,102 @@ interface operations {
11873
12277
  };
11874
12278
  };
11875
12279
  };
11876
- admin_pages_detail: {
12280
+ admin_pages_create: {
11877
12281
  parameters: {
11878
- query?: {
11879
- /** @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`. */
11880
- lang?: string;
11881
- };
12282
+ query?: never;
11882
12283
  header?: never;
11883
- path: {
11884
- page_id: string;
12284
+ path?: never;
12285
+ cookie?: never;
12286
+ };
12287
+ requestBody?: {
12288
+ content: {
12289
+ "application/json": {
12290
+ [key: string]: unknown;
12291
+ };
12292
+ "application/x-www-form-urlencoded": {
12293
+ [key: string]: unknown;
12294
+ };
12295
+ "multipart/form-data": {
12296
+ [key: string]: unknown;
12297
+ };
12298
+ };
12299
+ };
12300
+ responses: {
12301
+ 201: {
12302
+ headers: {
12303
+ [name: string]: unknown;
12304
+ };
12305
+ content: {
12306
+ "application/json": {
12307
+ [key: string]: unknown;
12308
+ };
12309
+ };
12310
+ };
12311
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_BLOCK_TYPE`. Use `x-error-codes` for machine-readable retryability metadata. */
12312
+ 400: {
12313
+ headers: {
12314
+ [name: string]: unknown;
12315
+ };
12316
+ content: {
12317
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12318
+ };
12319
+ };
12320
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12321
+ 401: {
12322
+ headers: {
12323
+ [name: string]: unknown;
12324
+ };
12325
+ content: {
12326
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12327
+ };
12328
+ };
12329
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12330
+ 403: {
12331
+ headers: {
12332
+ [name: string]: unknown;
12333
+ };
12334
+ content: {
12335
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12336
+ };
12337
+ };
12338
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PAGE_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `BLOCK_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
12339
+ 404: {
12340
+ headers: {
12341
+ [name: string]: unknown;
12342
+ };
12343
+ content: {
12344
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12345
+ };
12346
+ };
12347
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
12348
+ 429: {
12349
+ headers: {
12350
+ [name: string]: unknown;
12351
+ };
12352
+ content: {
12353
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12354
+ };
12355
+ };
12356
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12357
+ 500: {
12358
+ headers: {
12359
+ [name: string]: unknown;
12360
+ };
12361
+ content: {
12362
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12363
+ };
12364
+ };
12365
+ };
12366
+ };
12367
+ admin_pages_detail: {
12368
+ parameters: {
12369
+ query?: {
12370
+ /** @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`. */
12371
+ lang?: string;
12372
+ };
12373
+ header?: never;
12374
+ path: {
12375
+ page_id: string;
11885
12376
  };
11886
12377
  cookie?: never;
11887
12378
  };
@@ -12813,7 +13304,1131 @@ interface operations {
12813
13304
  [name: string]: unknown;
12814
13305
  };
12815
13306
  content: {
12816
- "application/json": components["schemas"]["ProductAttributeValue"][];
13307
+ "application/json": components["schemas"]["ProductAttributeValue"][];
13308
+ };
13309
+ };
13310
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13311
+ 400: {
13312
+ headers: {
13313
+ [name: string]: unknown;
13314
+ };
13315
+ content: {
13316
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13317
+ };
13318
+ };
13319
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13320
+ 401: {
13321
+ headers: {
13322
+ [name: string]: unknown;
13323
+ };
13324
+ content: {
13325
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13326
+ };
13327
+ };
13328
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13329
+ 403: {
13330
+ headers: {
13331
+ [name: string]: unknown;
13332
+ };
13333
+ content: {
13334
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13335
+ };
13336
+ };
13337
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13338
+ 404: {
13339
+ headers: {
13340
+ [name: string]: unknown;
13341
+ };
13342
+ content: {
13343
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13344
+ };
13345
+ };
13346
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13347
+ 429: {
13348
+ headers: {
13349
+ [name: string]: unknown;
13350
+ };
13351
+ content: {
13352
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13353
+ };
13354
+ };
13355
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13356
+ 500: {
13357
+ headers: {
13358
+ [name: string]: unknown;
13359
+ };
13360
+ content: {
13361
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13362
+ };
13363
+ };
13364
+ };
13365
+ };
13366
+ admin_products_confirm_compliance_retrieve: {
13367
+ parameters: {
13368
+ query?: never;
13369
+ header?: {
13370
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13371
+ "X-Sous-Company-Id"?: number;
13372
+ };
13373
+ path: {
13374
+ product_id: number;
13375
+ };
13376
+ cookie?: never;
13377
+ };
13378
+ requestBody?: never;
13379
+ responses: {
13380
+ 200: {
13381
+ headers: {
13382
+ [name: string]: unknown;
13383
+ };
13384
+ content: {
13385
+ "application/json": components["schemas"]["ComplianceConfirmation"];
13386
+ };
13387
+ };
13388
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13389
+ 400: {
13390
+ headers: {
13391
+ [name: string]: unknown;
13392
+ };
13393
+ content: {
13394
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13395
+ };
13396
+ };
13397
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13398
+ 401: {
13399
+ headers: {
13400
+ [name: string]: unknown;
13401
+ };
13402
+ content: {
13403
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13404
+ };
13405
+ };
13406
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13407
+ 403: {
13408
+ headers: {
13409
+ [name: string]: unknown;
13410
+ };
13411
+ content: {
13412
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13413
+ };
13414
+ };
13415
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13416
+ 404: {
13417
+ headers: {
13418
+ [name: string]: unknown;
13419
+ };
13420
+ content: {
13421
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13422
+ };
13423
+ };
13424
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13425
+ 429: {
13426
+ headers: {
13427
+ [name: string]: unknown;
13428
+ };
13429
+ content: {
13430
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13431
+ };
13432
+ };
13433
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13434
+ 500: {
13435
+ headers: {
13436
+ [name: string]: unknown;
13437
+ };
13438
+ content: {
13439
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13440
+ };
13441
+ };
13442
+ };
13443
+ };
13444
+ admin_products_confirm_compliance_create: {
13445
+ parameters: {
13446
+ query?: never;
13447
+ header?: {
13448
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13449
+ "X-Sous-Company-Id"?: number;
13450
+ };
13451
+ path: {
13452
+ product_id: number;
13453
+ };
13454
+ cookie?: never;
13455
+ };
13456
+ requestBody?: never;
13457
+ responses: {
13458
+ /** @description No response body */
13459
+ 200: {
13460
+ headers: {
13461
+ [name: string]: unknown;
13462
+ };
13463
+ content?: never;
13464
+ };
13465
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13466
+ 400: {
13467
+ headers: {
13468
+ [name: string]: unknown;
13469
+ };
13470
+ content: {
13471
+ "application/json": components["schemas"]["ComplianceIncomplete"];
13472
+ };
13473
+ };
13474
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13475
+ 401: {
13476
+ headers: {
13477
+ [name: string]: unknown;
13478
+ };
13479
+ content: {
13480
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13481
+ };
13482
+ };
13483
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13484
+ 403: {
13485
+ headers: {
13486
+ [name: string]: unknown;
13487
+ };
13488
+ content: {
13489
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13490
+ };
13491
+ };
13492
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13493
+ 404: {
13494
+ headers: {
13495
+ [name: string]: unknown;
13496
+ };
13497
+ content: {
13498
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13499
+ };
13500
+ };
13501
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13502
+ 429: {
13503
+ headers: {
13504
+ [name: string]: unknown;
13505
+ };
13506
+ content: {
13507
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13508
+ };
13509
+ };
13510
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13511
+ 500: {
13512
+ headers: {
13513
+ [name: string]: unknown;
13514
+ };
13515
+ content: {
13516
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13517
+ };
13518
+ };
13519
+ };
13520
+ };
13521
+ admin_products_confirm_compliance_destroy: {
13522
+ parameters: {
13523
+ query?: never;
13524
+ header?: {
13525
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13526
+ "X-Sous-Company-Id"?: number;
13527
+ };
13528
+ path: {
13529
+ product_id: number;
13530
+ };
13531
+ cookie?: never;
13532
+ };
13533
+ requestBody?: never;
13534
+ responses: {
13535
+ /** @description No response body */
13536
+ 204: {
13537
+ headers: {
13538
+ [name: string]: unknown;
13539
+ };
13540
+ content?: never;
13541
+ };
13542
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13543
+ 400: {
13544
+ headers: {
13545
+ [name: string]: unknown;
13546
+ };
13547
+ content: {
13548
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13549
+ };
13550
+ };
13551
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13552
+ 401: {
13553
+ headers: {
13554
+ [name: string]: unknown;
13555
+ };
13556
+ content: {
13557
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13558
+ };
13559
+ };
13560
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13561
+ 403: {
13562
+ headers: {
13563
+ [name: string]: unknown;
13564
+ };
13565
+ content: {
13566
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13567
+ };
13568
+ };
13569
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13570
+ 404: {
13571
+ headers: {
13572
+ [name: string]: unknown;
13573
+ };
13574
+ content: {
13575
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13576
+ };
13577
+ };
13578
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13579
+ 429: {
13580
+ headers: {
13581
+ [name: string]: unknown;
13582
+ };
13583
+ content: {
13584
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13585
+ };
13586
+ };
13587
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13588
+ 500: {
13589
+ headers: {
13590
+ [name: string]: unknown;
13591
+ };
13592
+ content: {
13593
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13594
+ };
13595
+ };
13596
+ };
13597
+ };
13598
+ admin_products_surcharges_update: {
13599
+ parameters: {
13600
+ query?: never;
13601
+ header?: {
13602
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13603
+ "X-Sous-Company-Id"?: number;
13604
+ };
13605
+ path: {
13606
+ product_id: number;
13607
+ };
13608
+ cookie?: never;
13609
+ };
13610
+ requestBody: {
13611
+ content: {
13612
+ "application/json": components["schemas"]["AdminProductSurchargesRequest"];
13613
+ "application/x-www-form-urlencoded": components["schemas"]["AdminProductSurchargesRequest"];
13614
+ "multipart/form-data": components["schemas"]["AdminProductSurchargesRequest"];
13615
+ };
13616
+ };
13617
+ responses: {
13618
+ 200: {
13619
+ headers: {
13620
+ [name: string]: unknown;
13621
+ };
13622
+ content: {
13623
+ "application/json": components["schemas"]["Surcharge"][];
13624
+ };
13625
+ };
13626
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13627
+ 400: {
13628
+ headers: {
13629
+ [name: string]: unknown;
13630
+ };
13631
+ content: {
13632
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13633
+ };
13634
+ };
13635
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13636
+ 401: {
13637
+ headers: {
13638
+ [name: string]: unknown;
13639
+ };
13640
+ content: {
13641
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13642
+ };
13643
+ };
13644
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13645
+ 403: {
13646
+ headers: {
13647
+ [name: string]: unknown;
13648
+ };
13649
+ content: {
13650
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13651
+ };
13652
+ };
13653
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13654
+ 404: {
13655
+ headers: {
13656
+ [name: string]: unknown;
13657
+ };
13658
+ content: {
13659
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13660
+ };
13661
+ };
13662
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13663
+ 429: {
13664
+ headers: {
13665
+ [name: string]: unknown;
13666
+ };
13667
+ content: {
13668
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13669
+ };
13670
+ };
13671
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13672
+ 500: {
13673
+ headers: {
13674
+ [name: string]: unknown;
13675
+ };
13676
+ content: {
13677
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13678
+ };
13679
+ };
13680
+ };
13681
+ };
13682
+ admin_products_shared_create: {
13683
+ parameters: {
13684
+ query?: never;
13685
+ header?: {
13686
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13687
+ "X-Sous-Company-Id"?: number;
13688
+ };
13689
+ path?: never;
13690
+ cookie?: never;
13691
+ };
13692
+ requestBody: {
13693
+ content: {
13694
+ "application/json": components["schemas"]["SharedProductsRequest"];
13695
+ "application/x-www-form-urlencoded": components["schemas"]["SharedProductsRequest"];
13696
+ "multipart/form-data": components["schemas"]["SharedProductsRequest"];
13697
+ };
13698
+ };
13699
+ responses: {
13700
+ 200: {
13701
+ headers: {
13702
+ [name: string]: unknown;
13703
+ };
13704
+ content: {
13705
+ "application/json": components["schemas"]["SharedBrandProduct"][];
13706
+ };
13707
+ };
13708
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13709
+ 400: {
13710
+ headers: {
13711
+ [name: string]: unknown;
13712
+ };
13713
+ content: {
13714
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13715
+ };
13716
+ };
13717
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13718
+ 401: {
13719
+ headers: {
13720
+ [name: string]: unknown;
13721
+ };
13722
+ content: {
13723
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13724
+ };
13725
+ };
13726
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13727
+ 403: {
13728
+ headers: {
13729
+ [name: string]: unknown;
13730
+ };
13731
+ content: {
13732
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13733
+ };
13734
+ };
13735
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13736
+ 404: {
13737
+ headers: {
13738
+ [name: string]: unknown;
13739
+ };
13740
+ content: {
13741
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13742
+ };
13743
+ };
13744
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13745
+ 429: {
13746
+ headers: {
13747
+ [name: string]: unknown;
13748
+ };
13749
+ content: {
13750
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13751
+ };
13752
+ };
13753
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13754
+ 500: {
13755
+ headers: {
13756
+ [name: string]: unknown;
13757
+ };
13758
+ content: {
13759
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13760
+ };
13761
+ };
13762
+ };
13763
+ };
13764
+ admin_promotions_list: {
13765
+ parameters: {
13766
+ query?: {
13767
+ /** @description The pagination cursor value. */
13768
+ cursor?: string;
13769
+ };
13770
+ header?: {
13771
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13772
+ "X-Sous-Company-Id"?: number;
13773
+ };
13774
+ path?: never;
13775
+ cookie?: never;
13776
+ };
13777
+ requestBody?: never;
13778
+ responses: {
13779
+ 200: {
13780
+ headers: {
13781
+ [name: string]: unknown;
13782
+ };
13783
+ content: {
13784
+ "application/json": components["schemas"]["PaginatedAdminPromotionList"];
13785
+ };
13786
+ };
13787
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13788
+ 400: {
13789
+ headers: {
13790
+ [name: string]: unknown;
13791
+ };
13792
+ content: {
13793
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13794
+ };
13795
+ };
13796
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13797
+ 401: {
13798
+ headers: {
13799
+ [name: string]: unknown;
13800
+ };
13801
+ content: {
13802
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13803
+ };
13804
+ };
13805
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13806
+ 403: {
13807
+ headers: {
13808
+ [name: string]: unknown;
13809
+ };
13810
+ content: {
13811
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13812
+ };
13813
+ };
13814
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13815
+ 404: {
13816
+ headers: {
13817
+ [name: string]: unknown;
13818
+ };
13819
+ content: {
13820
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13821
+ };
13822
+ };
13823
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13824
+ 429: {
13825
+ headers: {
13826
+ [name: string]: unknown;
13827
+ };
13828
+ content: {
13829
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13830
+ };
13831
+ };
13832
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13833
+ 500: {
13834
+ headers: {
13835
+ [name: string]: unknown;
13836
+ };
13837
+ content: {
13838
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13839
+ };
13840
+ };
13841
+ };
13842
+ };
13843
+ admin_promotions_create: {
13844
+ parameters: {
13845
+ query?: never;
13846
+ header?: {
13847
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13848
+ "X-Sous-Company-Id"?: number;
13849
+ };
13850
+ path?: never;
13851
+ cookie?: never;
13852
+ };
13853
+ requestBody: {
13854
+ content: {
13855
+ "application/json": components["schemas"]["AdminPromotion"];
13856
+ "application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
13857
+ "multipart/form-data": components["schemas"]["AdminPromotion"];
13858
+ };
13859
+ };
13860
+ responses: {
13861
+ 200: {
13862
+ headers: {
13863
+ [name: string]: unknown;
13864
+ };
13865
+ content: {
13866
+ "application/json": components["schemas"]["AdminPromotion"];
13867
+ };
13868
+ };
13869
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13870
+ 400: {
13871
+ headers: {
13872
+ [name: string]: unknown;
13873
+ };
13874
+ content: {
13875
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13876
+ };
13877
+ };
13878
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13879
+ 401: {
13880
+ headers: {
13881
+ [name: string]: unknown;
13882
+ };
13883
+ content: {
13884
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13885
+ };
13886
+ };
13887
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13888
+ 403: {
13889
+ headers: {
13890
+ [name: string]: unknown;
13891
+ };
13892
+ content: {
13893
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13894
+ };
13895
+ };
13896
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13897
+ 404: {
13898
+ headers: {
13899
+ [name: string]: unknown;
13900
+ };
13901
+ content: {
13902
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13903
+ };
13904
+ };
13905
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13906
+ 429: {
13907
+ headers: {
13908
+ [name: string]: unknown;
13909
+ };
13910
+ content: {
13911
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13912
+ };
13913
+ };
13914
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13915
+ 500: {
13916
+ headers: {
13917
+ [name: string]: unknown;
13918
+ };
13919
+ content: {
13920
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13921
+ };
13922
+ };
13923
+ };
13924
+ };
13925
+ admin_promotions_retrieve: {
13926
+ parameters: {
13927
+ query?: never;
13928
+ header?: {
13929
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13930
+ "X-Sous-Company-Id"?: number;
13931
+ };
13932
+ path: {
13933
+ /** @description A unique integer value identifying this promotion. */
13934
+ id: number;
13935
+ };
13936
+ cookie?: never;
13937
+ };
13938
+ requestBody?: never;
13939
+ responses: {
13940
+ 200: {
13941
+ headers: {
13942
+ [name: string]: unknown;
13943
+ };
13944
+ content: {
13945
+ "application/json": components["schemas"]["AdminPromotion"];
13946
+ };
13947
+ };
13948
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13949
+ 400: {
13950
+ headers: {
13951
+ [name: string]: unknown;
13952
+ };
13953
+ content: {
13954
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13955
+ };
13956
+ };
13957
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13958
+ 401: {
13959
+ headers: {
13960
+ [name: string]: unknown;
13961
+ };
13962
+ content: {
13963
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13964
+ };
13965
+ };
13966
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13967
+ 403: {
13968
+ headers: {
13969
+ [name: string]: unknown;
13970
+ };
13971
+ content: {
13972
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13973
+ };
13974
+ };
13975
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13976
+ 404: {
13977
+ headers: {
13978
+ [name: string]: unknown;
13979
+ };
13980
+ content: {
13981
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13982
+ };
13983
+ };
13984
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13985
+ 429: {
13986
+ headers: {
13987
+ [name: string]: unknown;
13988
+ };
13989
+ content: {
13990
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13991
+ };
13992
+ };
13993
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13994
+ 500: {
13995
+ headers: {
13996
+ [name: string]: unknown;
13997
+ };
13998
+ content: {
13999
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14000
+ };
14001
+ };
14002
+ };
14003
+ };
14004
+ admin_promotions_update: {
14005
+ parameters: {
14006
+ query?: never;
14007
+ header?: {
14008
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14009
+ "X-Sous-Company-Id"?: number;
14010
+ };
14011
+ path: {
14012
+ /** @description A unique integer value identifying this promotion. */
14013
+ id: number;
14014
+ };
14015
+ cookie?: never;
14016
+ };
14017
+ requestBody: {
14018
+ content: {
14019
+ "application/json": components["schemas"]["AdminPromotion"];
14020
+ "application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
14021
+ "multipart/form-data": components["schemas"]["AdminPromotion"];
14022
+ };
14023
+ };
14024
+ responses: {
14025
+ 200: {
14026
+ headers: {
14027
+ [name: string]: unknown;
14028
+ };
14029
+ content: {
14030
+ "application/json": components["schemas"]["AdminPromotion"];
14031
+ };
14032
+ };
14033
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14034
+ 400: {
14035
+ headers: {
14036
+ [name: string]: unknown;
14037
+ };
14038
+ content: {
14039
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14040
+ };
14041
+ };
14042
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14043
+ 401: {
14044
+ headers: {
14045
+ [name: string]: unknown;
14046
+ };
14047
+ content: {
14048
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14049
+ };
14050
+ };
14051
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14052
+ 403: {
14053
+ headers: {
14054
+ [name: string]: unknown;
14055
+ };
14056
+ content: {
14057
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14058
+ };
14059
+ };
14060
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14061
+ 404: {
14062
+ headers: {
14063
+ [name: string]: unknown;
14064
+ };
14065
+ content: {
14066
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14067
+ };
14068
+ };
14069
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14070
+ 429: {
14071
+ headers: {
14072
+ [name: string]: unknown;
14073
+ };
14074
+ content: {
14075
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14076
+ };
14077
+ };
14078
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14079
+ 500: {
14080
+ headers: {
14081
+ [name: string]: unknown;
14082
+ };
14083
+ content: {
14084
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14085
+ };
14086
+ };
14087
+ };
14088
+ };
14089
+ admin_promotions_destroy: {
14090
+ parameters: {
14091
+ query?: never;
14092
+ header?: {
14093
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14094
+ "X-Sous-Company-Id"?: number;
14095
+ };
14096
+ path: {
14097
+ /** @description A unique integer value identifying this promotion. */
14098
+ id: number;
14099
+ };
14100
+ cookie?: never;
14101
+ };
14102
+ requestBody?: never;
14103
+ responses: {
14104
+ /** @description No response body */
14105
+ 204: {
14106
+ headers: {
14107
+ [name: string]: unknown;
14108
+ };
14109
+ content?: never;
14110
+ };
14111
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14112
+ 400: {
14113
+ headers: {
14114
+ [name: string]: unknown;
14115
+ };
14116
+ content: {
14117
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14118
+ };
14119
+ };
14120
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14121
+ 401: {
14122
+ headers: {
14123
+ [name: string]: unknown;
14124
+ };
14125
+ content: {
14126
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14127
+ };
14128
+ };
14129
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14130
+ 403: {
14131
+ headers: {
14132
+ [name: string]: unknown;
14133
+ };
14134
+ content: {
14135
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14136
+ };
14137
+ };
14138
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14139
+ 404: {
14140
+ headers: {
14141
+ [name: string]: unknown;
14142
+ };
14143
+ content: {
14144
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14145
+ };
14146
+ };
14147
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14148
+ 429: {
14149
+ headers: {
14150
+ [name: string]: unknown;
14151
+ };
14152
+ content: {
14153
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14154
+ };
14155
+ };
14156
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14157
+ 500: {
14158
+ headers: {
14159
+ [name: string]: unknown;
14160
+ };
14161
+ content: {
14162
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14163
+ };
14164
+ };
14165
+ };
14166
+ };
14167
+ admin_promotions_partial_update: {
14168
+ parameters: {
14169
+ query?: never;
14170
+ header?: {
14171
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14172
+ "X-Sous-Company-Id"?: number;
14173
+ };
14174
+ path: {
14175
+ /** @description A unique integer value identifying this promotion. */
14176
+ id: number;
14177
+ };
14178
+ cookie?: never;
14179
+ };
14180
+ requestBody?: {
14181
+ content: {
14182
+ "application/json": components["schemas"]["PatchedAdminPromotion"];
14183
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminPromotion"];
14184
+ "multipart/form-data": components["schemas"]["PatchedAdminPromotion"];
14185
+ };
14186
+ };
14187
+ responses: {
14188
+ 200: {
14189
+ headers: {
14190
+ [name: string]: unknown;
14191
+ };
14192
+ content: {
14193
+ "application/json": components["schemas"]["AdminPromotion"];
14194
+ };
14195
+ };
14196
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14197
+ 400: {
14198
+ headers: {
14199
+ [name: string]: unknown;
14200
+ };
14201
+ content: {
14202
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14203
+ };
14204
+ };
14205
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14206
+ 401: {
14207
+ headers: {
14208
+ [name: string]: unknown;
14209
+ };
14210
+ content: {
14211
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14212
+ };
14213
+ };
14214
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14215
+ 403: {
14216
+ headers: {
14217
+ [name: string]: unknown;
14218
+ };
14219
+ content: {
14220
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14221
+ };
14222
+ };
14223
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14224
+ 404: {
14225
+ headers: {
14226
+ [name: string]: unknown;
14227
+ };
14228
+ content: {
14229
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14230
+ };
14231
+ };
14232
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14233
+ 429: {
14234
+ headers: {
14235
+ [name: string]: unknown;
14236
+ };
14237
+ content: {
14238
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14239
+ };
14240
+ };
14241
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14242
+ 500: {
14243
+ headers: {
14244
+ [name: string]: unknown;
14245
+ };
14246
+ content: {
14247
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14248
+ };
14249
+ };
14250
+ };
14251
+ };
14252
+ admin_store_fulfillment_types_list: {
14253
+ parameters: {
14254
+ query?: never;
14255
+ header?: {
14256
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14257
+ "X-Sous-Company-Id"?: number;
14258
+ };
14259
+ path?: never;
14260
+ cookie?: never;
14261
+ };
14262
+ requestBody?: never;
14263
+ responses: {
14264
+ 200: {
14265
+ headers: {
14266
+ [name: string]: unknown;
14267
+ };
14268
+ content: {
14269
+ "application/json": components["schemas"]["AdminStoreFulfillment"][];
14270
+ };
14271
+ };
14272
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14273
+ 400: {
14274
+ headers: {
14275
+ [name: string]: unknown;
14276
+ };
14277
+ content: {
14278
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14279
+ };
14280
+ };
14281
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14282
+ 401: {
14283
+ headers: {
14284
+ [name: string]: unknown;
14285
+ };
14286
+ content: {
14287
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14288
+ };
14289
+ };
14290
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14291
+ 403: {
14292
+ headers: {
14293
+ [name: string]: unknown;
14294
+ };
14295
+ content: {
14296
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14297
+ };
14298
+ };
14299
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14300
+ 404: {
14301
+ headers: {
14302
+ [name: string]: unknown;
14303
+ };
14304
+ content: {
14305
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14306
+ };
14307
+ };
14308
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14309
+ 429: {
14310
+ headers: {
14311
+ [name: string]: unknown;
14312
+ };
14313
+ content: {
14314
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14315
+ };
14316
+ };
14317
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14318
+ 500: {
14319
+ headers: {
14320
+ [name: string]: unknown;
14321
+ };
14322
+ content: {
14323
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14324
+ };
14325
+ };
14326
+ };
14327
+ };
14328
+ admin_stores_base_coverage_retrieve: {
14329
+ parameters: {
14330
+ query?: never;
14331
+ header?: {
14332
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14333
+ "X-Sous-Company-Id"?: number;
14334
+ };
14335
+ path: {
14336
+ store_public_id: string;
14337
+ };
14338
+ cookie?: never;
14339
+ };
14340
+ requestBody?: never;
14341
+ responses: {
14342
+ 200: {
14343
+ headers: {
14344
+ [name: string]: unknown;
14345
+ };
14346
+ content: {
14347
+ "application/json": components["schemas"]["BaseCoverage"];
14348
+ };
14349
+ };
14350
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14351
+ 400: {
14352
+ headers: {
14353
+ [name: string]: unknown;
14354
+ };
14355
+ content: {
14356
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14357
+ };
14358
+ };
14359
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14360
+ 401: {
14361
+ headers: {
14362
+ [name: string]: unknown;
14363
+ };
14364
+ content: {
14365
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14366
+ };
14367
+ };
14368
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14369
+ 403: {
14370
+ headers: {
14371
+ [name: string]: unknown;
14372
+ };
14373
+ content: {
14374
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14375
+ };
14376
+ };
14377
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14378
+ 404: {
14379
+ headers: {
14380
+ [name: string]: unknown;
14381
+ };
14382
+ content: {
14383
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14384
+ };
14385
+ };
14386
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14387
+ 429: {
14388
+ headers: {
14389
+ [name: string]: unknown;
14390
+ };
14391
+ content: {
14392
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14393
+ };
14394
+ };
14395
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14396
+ 500: {
14397
+ headers: {
14398
+ [name: string]: unknown;
14399
+ };
14400
+ content: {
14401
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14402
+ };
14403
+ };
14404
+ };
14405
+ };
14406
+ admin_stores_base_coverage_update: {
14407
+ parameters: {
14408
+ query?: never;
14409
+ header?: {
14410
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14411
+ "X-Sous-Company-Id"?: number;
14412
+ };
14413
+ path: {
14414
+ store_public_id: string;
14415
+ };
14416
+ cookie?: never;
14417
+ };
14418
+ requestBody: {
14419
+ content: {
14420
+ "application/json": components["schemas"]["BaseCoverage"];
14421
+ "application/x-www-form-urlencoded": components["schemas"]["BaseCoverage"];
14422
+ "multipart/form-data": components["schemas"]["BaseCoverage"];
14423
+ };
14424
+ };
14425
+ responses: {
14426
+ 200: {
14427
+ headers: {
14428
+ [name: string]: unknown;
14429
+ };
14430
+ content: {
14431
+ "application/json": components["schemas"]["BaseCoverage"];
12817
14432
  };
12818
14433
  };
12819
14434
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12872,7 +14487,7 @@ interface operations {
12872
14487
  };
12873
14488
  };
12874
14489
  };
12875
- admin_products_confirm_compliance_retrieve: {
14490
+ admin_stores_compliance_defaults_retrieve: {
12876
14491
  parameters: {
12877
14492
  query?: never;
12878
14493
  header?: {
@@ -12880,7 +14495,7 @@ interface operations {
12880
14495
  "X-Sous-Company-Id"?: number;
12881
14496
  };
12882
14497
  path: {
12883
- product_id: number;
14498
+ store_public_id: string;
12884
14499
  };
12885
14500
  cookie?: never;
12886
14501
  };
@@ -12891,7 +14506,7 @@ interface operations {
12891
14506
  [name: string]: unknown;
12892
14507
  };
12893
14508
  content: {
12894
- "application/json": components["schemas"]["ComplianceConfirmation"];
14509
+ "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
12895
14510
  };
12896
14511
  };
12897
14512
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12950,7 +14565,7 @@ interface operations {
12950
14565
  };
12951
14566
  };
12952
14567
  };
12953
- admin_products_confirm_compliance_create: {
14568
+ admin_stores_compliance_defaults_partial_update: {
12954
14569
  parameters: {
12955
14570
  query?: never;
12956
14571
  header?: {
@@ -12958,18 +14573,25 @@ interface operations {
12958
14573
  "X-Sous-Company-Id"?: number;
12959
14574
  };
12960
14575
  path: {
12961
- product_id: number;
14576
+ store_public_id: string;
12962
14577
  };
12963
14578
  cookie?: never;
12964
14579
  };
12965
- requestBody?: never;
14580
+ requestBody?: {
14581
+ content: {
14582
+ "application/json": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
14583
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
14584
+ "multipart/form-data": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
14585
+ };
14586
+ };
12966
14587
  responses: {
12967
- /** @description No response body */
12968
14588
  200: {
12969
14589
  headers: {
12970
14590
  [name: string]: unknown;
12971
14591
  };
12972
- content?: never;
14592
+ content: {
14593
+ "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
14594
+ };
12973
14595
  };
12974
14596
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12975
14597
  400: {
@@ -12977,7 +14599,7 @@ interface operations {
12977
14599
  [name: string]: unknown;
12978
14600
  };
12979
14601
  content: {
12980
- "application/json": components["schemas"]["ComplianceIncomplete"];
14602
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12981
14603
  };
12982
14604
  };
12983
14605
  /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13027,26 +14649,32 @@ interface operations {
13027
14649
  };
13028
14650
  };
13029
14651
  };
13030
- admin_products_confirm_compliance_destroy: {
14652
+ admin_stores_compliance_schema_retrieve: {
13031
14653
  parameters: {
13032
- query?: never;
14654
+ query: {
14655
+ /** @description Language code for translated labels. Defaults to 'en'. */
14656
+ lang?: string;
14657
+ /** @description ProductType slug, e.g. 'product' or 'food-product' (products.constants.PLATFORM_PRODUCT_TYPES). */
14658
+ product_type: string;
14659
+ };
13033
14660
  header?: {
13034
14661
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13035
14662
  "X-Sous-Company-Id"?: number;
13036
14663
  };
13037
14664
  path: {
13038
- product_id: number;
14665
+ store_public_id: string;
13039
14666
  };
13040
14667
  cookie?: never;
13041
14668
  };
13042
14669
  requestBody?: never;
13043
14670
  responses: {
13044
- /** @description No response body */
13045
- 204: {
14671
+ 200: {
13046
14672
  headers: {
13047
14673
  [name: string]: unknown;
13048
14674
  };
13049
- content?: never;
14675
+ content: {
14676
+ "application/json": components["schemas"]["ComplianceSchemaResponse"];
14677
+ };
13050
14678
  };
13051
14679
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13052
14680
  400: {
@@ -13104,7 +14732,7 @@ interface operations {
13104
14732
  };
13105
14733
  };
13106
14734
  };
13107
- admin_products_surcharges_update: {
14735
+ admin_stores_delivery_areas_list: {
13108
14736
  parameters: {
13109
14737
  query?: never;
13110
14738
  header?: {
@@ -13112,24 +14740,18 @@ interface operations {
13112
14740
  "X-Sous-Company-Id"?: number;
13113
14741
  };
13114
14742
  path: {
13115
- product_id: number;
14743
+ store_public_id: string;
13116
14744
  };
13117
14745
  cookie?: never;
13118
14746
  };
13119
- requestBody: {
13120
- content: {
13121
- "application/json": components["schemas"]["AdminProductSurchargesRequest"];
13122
- "application/x-www-form-urlencoded": components["schemas"]["AdminProductSurchargesRequest"];
13123
- "multipart/form-data": components["schemas"]["AdminProductSurchargesRequest"];
13124
- };
13125
- };
14747
+ requestBody?: never;
13126
14748
  responses: {
13127
14749
  200: {
13128
14750
  headers: {
13129
14751
  [name: string]: unknown;
13130
14752
  };
13131
14753
  content: {
13132
- "application/json": components["schemas"]["Surcharge"][];
14754
+ "application/json": components["schemas"]["DeliveryArea"][];
13133
14755
  };
13134
14756
  };
13135
14757
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13188,30 +14810,32 @@ interface operations {
13188
14810
  };
13189
14811
  };
13190
14812
  };
13191
- admin_products_shared_create: {
14813
+ admin_stores_delivery_areas_create: {
13192
14814
  parameters: {
13193
14815
  query?: never;
13194
14816
  header?: {
13195
14817
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13196
14818
  "X-Sous-Company-Id"?: number;
13197
14819
  };
13198
- path?: never;
14820
+ path: {
14821
+ store_public_id: string;
14822
+ };
13199
14823
  cookie?: never;
13200
14824
  };
13201
14825
  requestBody: {
13202
14826
  content: {
13203
- "application/json": components["schemas"]["SharedProductsRequest"];
13204
- "application/x-www-form-urlencoded": components["schemas"]["SharedProductsRequest"];
13205
- "multipart/form-data": components["schemas"]["SharedProductsRequest"];
14827
+ "application/json": components["schemas"]["DeliveryArea"];
14828
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryArea"];
14829
+ "multipart/form-data": components["schemas"]["DeliveryArea"];
13206
14830
  };
13207
14831
  };
13208
14832
  responses: {
13209
- 200: {
14833
+ 201: {
13210
14834
  headers: {
13211
14835
  [name: string]: unknown;
13212
14836
  };
13213
14837
  content: {
13214
- "application/json": components["schemas"]["SharedBrandProduct"][];
14838
+ "application/json": components["schemas"]["DeliveryArea"];
13215
14839
  };
13216
14840
  };
13217
14841
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13270,28 +14894,27 @@ interface operations {
13270
14894
  };
13271
14895
  };
13272
14896
  };
13273
- admin_promotions_list: {
14897
+ admin_stores_delivery_areas_destroy: {
13274
14898
  parameters: {
13275
- query?: {
13276
- /** @description The pagination cursor value. */
13277
- cursor?: string;
13278
- };
14899
+ query?: never;
13279
14900
  header?: {
13280
14901
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13281
14902
  "X-Sous-Company-Id"?: number;
13282
14903
  };
13283
- path?: never;
14904
+ path: {
14905
+ shape_id: string;
14906
+ store_public_id: string;
14907
+ };
13284
14908
  cookie?: never;
13285
14909
  };
13286
14910
  requestBody?: never;
13287
14911
  responses: {
13288
- 200: {
14912
+ /** @description No response body */
14913
+ 204: {
13289
14914
  headers: {
13290
14915
  [name: string]: unknown;
13291
14916
  };
13292
- content: {
13293
- "application/json": components["schemas"]["PaginatedAdminPromotionList"];
13294
- };
14917
+ content?: never;
13295
14918
  };
13296
14919
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13297
14920
  400: {
@@ -13349,21 +14972,24 @@ interface operations {
13349
14972
  };
13350
14973
  };
13351
14974
  };
13352
- admin_promotions_create: {
14975
+ admin_stores_delivery_areas_partial_update: {
13353
14976
  parameters: {
13354
14977
  query?: never;
13355
14978
  header?: {
13356
14979
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13357
14980
  "X-Sous-Company-Id"?: number;
13358
14981
  };
13359
- path?: never;
14982
+ path: {
14983
+ shape_id: string;
14984
+ store_public_id: string;
14985
+ };
13360
14986
  cookie?: never;
13361
14987
  };
13362
- requestBody: {
14988
+ requestBody?: {
13363
14989
  content: {
13364
- "application/json": components["schemas"]["AdminPromotion"];
13365
- "application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
13366
- "multipart/form-data": components["schemas"]["AdminPromotion"];
14990
+ "application/json": components["schemas"]["PatchedDeliveryAreaUpdate"];
14991
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryAreaUpdate"];
14992
+ "multipart/form-data": components["schemas"]["PatchedDeliveryAreaUpdate"];
13367
14993
  };
13368
14994
  };
13369
14995
  responses: {
@@ -13372,7 +14998,7 @@ interface operations {
13372
14998
  [name: string]: unknown;
13373
14999
  };
13374
15000
  content: {
13375
- "application/json": components["schemas"]["AdminPromotion"];
15001
+ "application/json": components["schemas"]["DeliveryArea"];
13376
15002
  };
13377
15003
  };
13378
15004
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13431,7 +15057,7 @@ interface operations {
13431
15057
  };
13432
15058
  };
13433
15059
  };
13434
- admin_promotions_retrieve: {
15060
+ admin_stores_delivery_exclusions_list: {
13435
15061
  parameters: {
13436
15062
  query?: never;
13437
15063
  header?: {
@@ -13439,8 +15065,7 @@ interface operations {
13439
15065
  "X-Sous-Company-Id"?: number;
13440
15066
  };
13441
15067
  path: {
13442
- /** @description A unique integer value identifying this promotion. */
13443
- id: number;
15068
+ store_public_id: string;
13444
15069
  };
13445
15070
  cookie?: never;
13446
15071
  };
@@ -13451,7 +15076,7 @@ interface operations {
13451
15076
  [name: string]: unknown;
13452
15077
  };
13453
15078
  content: {
13454
- "application/json": components["schemas"]["AdminPromotion"];
15079
+ "application/json": components["schemas"]["DeliveryExclusion"][];
13455
15080
  };
13456
15081
  };
13457
15082
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13510,7 +15135,7 @@ interface operations {
13510
15135
  };
13511
15136
  };
13512
15137
  };
13513
- admin_promotions_update: {
15138
+ admin_stores_delivery_exclusions_create: {
13514
15139
  parameters: {
13515
15140
  query?: never;
13516
15141
  header?: {
@@ -13518,25 +15143,24 @@ interface operations {
13518
15143
  "X-Sous-Company-Id"?: number;
13519
15144
  };
13520
15145
  path: {
13521
- /** @description A unique integer value identifying this promotion. */
13522
- id: number;
15146
+ store_public_id: string;
13523
15147
  };
13524
15148
  cookie?: never;
13525
15149
  };
13526
15150
  requestBody: {
13527
15151
  content: {
13528
- "application/json": components["schemas"]["AdminPromotion"];
13529
- "application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
13530
- "multipart/form-data": components["schemas"]["AdminPromotion"];
15152
+ "application/json": components["schemas"]["DeliveryExclusion"];
15153
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryExclusion"];
15154
+ "multipart/form-data": components["schemas"]["DeliveryExclusion"];
13531
15155
  };
13532
15156
  };
13533
15157
  responses: {
13534
- 200: {
15158
+ 201: {
13535
15159
  headers: {
13536
15160
  [name: string]: unknown;
13537
15161
  };
13538
15162
  content: {
13539
- "application/json": components["schemas"]["AdminPromotion"];
15163
+ "application/json": components["schemas"]["DeliveryExclusion"];
13540
15164
  };
13541
15165
  };
13542
15166
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13595,7 +15219,7 @@ interface operations {
13595
15219
  };
13596
15220
  };
13597
15221
  };
13598
- admin_promotions_destroy: {
15222
+ admin_stores_delivery_exclusions_destroy: {
13599
15223
  parameters: {
13600
15224
  query?: never;
13601
15225
  header?: {
@@ -13603,8 +15227,8 @@ interface operations {
13603
15227
  "X-Sous-Company-Id"?: number;
13604
15228
  };
13605
15229
  path: {
13606
- /** @description A unique integer value identifying this promotion. */
13607
- id: number;
15230
+ shape_id: string;
15231
+ store_public_id: string;
13608
15232
  };
13609
15233
  cookie?: never;
13610
15234
  };
@@ -13673,7 +15297,7 @@ interface operations {
13673
15297
  };
13674
15298
  };
13675
15299
  };
13676
- admin_promotions_partial_update: {
15300
+ admin_stores_delivery_exclusions_partial_update: {
13677
15301
  parameters: {
13678
15302
  query?: never;
13679
15303
  header?: {
@@ -13681,16 +15305,16 @@ interface operations {
13681
15305
  "X-Sous-Company-Id"?: number;
13682
15306
  };
13683
15307
  path: {
13684
- /** @description A unique integer value identifying this promotion. */
13685
- id: number;
15308
+ shape_id: string;
15309
+ store_public_id: string;
13686
15310
  };
13687
15311
  cookie?: never;
13688
15312
  };
13689
15313
  requestBody?: {
13690
15314
  content: {
13691
- "application/json": components["schemas"]["PatchedAdminPromotion"];
13692
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminPromotion"];
13693
- "multipart/form-data": components["schemas"]["PatchedAdminPromotion"];
15315
+ "application/json": components["schemas"]["PatchedDeliveryExclusionUpdate"];
15316
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryExclusionUpdate"];
15317
+ "multipart/form-data": components["schemas"]["PatchedDeliveryExclusionUpdate"];
13694
15318
  };
13695
15319
  };
13696
15320
  responses: {
@@ -13699,7 +15323,7 @@ interface operations {
13699
15323
  [name: string]: unknown;
13700
15324
  };
13701
15325
  content: {
13702
- "application/json": components["schemas"]["AdminPromotion"];
15326
+ "application/json": components["schemas"]["DeliveryExclusion"];
13703
15327
  };
13704
15328
  };
13705
15329
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13758,14 +15382,16 @@ interface operations {
13758
15382
  };
13759
15383
  };
13760
15384
  };
13761
- admin_store_fulfillment_types_list: {
15385
+ admin_stores_delivery_fee_retrieve: {
13762
15386
  parameters: {
13763
15387
  query?: never;
13764
15388
  header?: {
13765
15389
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13766
15390
  "X-Sous-Company-Id"?: number;
13767
15391
  };
13768
- path?: never;
15392
+ path: {
15393
+ store_public_id: string;
15394
+ };
13769
15395
  cookie?: never;
13770
15396
  };
13771
15397
  requestBody?: never;
@@ -13775,7 +15401,7 @@ interface operations {
13775
15401
  [name: string]: unknown;
13776
15402
  };
13777
15403
  content: {
13778
- "application/json": components["schemas"]["AdminStoreFulfillment"][];
15404
+ "application/json": components["schemas"]["DeliveryFee"];
13779
15405
  };
13780
15406
  };
13781
15407
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13834,7 +15460,7 @@ interface operations {
13834
15460
  };
13835
15461
  };
13836
15462
  };
13837
- admin_stores_compliance_defaults_retrieve: {
15463
+ admin_stores_delivery_fee_update: {
13838
15464
  parameters: {
13839
15465
  query?: never;
13840
15466
  header?: {
@@ -13846,14 +15472,20 @@ interface operations {
13846
15472
  };
13847
15473
  cookie?: never;
13848
15474
  };
13849
- requestBody?: never;
15475
+ requestBody: {
15476
+ content: {
15477
+ "application/json": components["schemas"]["DeliveryFee"];
15478
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryFee"];
15479
+ "multipart/form-data": components["schemas"]["DeliveryFee"];
15480
+ };
15481
+ };
13850
15482
  responses: {
13851
15483
  200: {
13852
15484
  headers: {
13853
15485
  [name: string]: unknown;
13854
15486
  };
13855
15487
  content: {
13856
- "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
15488
+ "application/json": components["schemas"]["DeliveryFee"];
13857
15489
  };
13858
15490
  };
13859
15491
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13912,7 +15544,7 @@ interface operations {
13912
15544
  };
13913
15545
  };
13914
15546
  };
13915
- admin_stores_compliance_defaults_partial_update: {
15547
+ admin_stores_delivery_fee_split_retrieve: {
13916
15548
  parameters: {
13917
15549
  query?: never;
13918
15550
  header?: {
@@ -13924,20 +15556,14 @@ interface operations {
13924
15556
  };
13925
15557
  cookie?: never;
13926
15558
  };
13927
- requestBody?: {
13928
- content: {
13929
- "application/json": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
13930
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
13931
- "multipart/form-data": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
13932
- };
13933
- };
15559
+ requestBody?: never;
13934
15560
  responses: {
13935
15561
  200: {
13936
15562
  headers: {
13937
15563
  [name: string]: unknown;
13938
15564
  };
13939
15565
  content: {
13940
- "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
15566
+ "application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
13941
15567
  };
13942
15568
  };
13943
15569
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13996,14 +15622,9 @@ interface operations {
13996
15622
  };
13997
15623
  };
13998
15624
  };
13999
- admin_stores_compliance_schema_retrieve: {
15625
+ admin_stores_delivery_fee_split_partial_update: {
14000
15626
  parameters: {
14001
- query: {
14002
- /** @description Language code for translated labels. Defaults to 'en'. */
14003
- lang?: string;
14004
- /** @description ProductType slug, e.g. 'product' or 'food-product' (products.constants.PLATFORM_PRODUCT_TYPES). */
14005
- product_type: string;
14006
- };
15627
+ query?: never;
14007
15628
  header?: {
14008
15629
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14009
15630
  "X-Sous-Company-Id"?: number;
@@ -14013,14 +15634,20 @@ interface operations {
14013
15634
  };
14014
15635
  cookie?: never;
14015
15636
  };
14016
- requestBody?: never;
15637
+ requestBody?: {
15638
+ content: {
15639
+ "application/json": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
15640
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
15641
+ "multipart/form-data": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
15642
+ };
15643
+ };
14017
15644
  responses: {
14018
15645
  200: {
14019
15646
  headers: {
14020
15647
  [name: string]: unknown;
14021
15648
  };
14022
15649
  content: {
14023
- "application/json": components["schemas"]["ComplianceSchemaResponse"];
15650
+ "application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
14024
15651
  };
14025
15652
  };
14026
15653
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -19245,6 +20872,107 @@ interface operations {
19245
20872
  };
19246
20873
  };
19247
20874
  };
20875
+ checkout_marketing_consent_partial_update: {
20876
+ parameters: {
20877
+ query?: never;
20878
+ header?: never;
20879
+ path: {
20880
+ checkout_id: string;
20881
+ };
20882
+ cookie?: never;
20883
+ };
20884
+ requestBody?: {
20885
+ content: {
20886
+ "application/json": components["schemas"]["PatchedMarketingConsentInput"];
20887
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedMarketingConsentInput"];
20888
+ "multipart/form-data": components["schemas"]["PatchedMarketingConsentInput"];
20889
+ };
20890
+ };
20891
+ responses: {
20892
+ 200: {
20893
+ headers: {
20894
+ [name: string]: unknown;
20895
+ };
20896
+ content: {
20897
+ "application/json": {
20898
+ [key: string]: unknown;
20899
+ };
20900
+ };
20901
+ };
20902
+ /** @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. */
20903
+ 400: {
20904
+ headers: {
20905
+ [name: string]: unknown;
20906
+ };
20907
+ content: {
20908
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20909
+ };
20910
+ };
20911
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
20912
+ 401: {
20913
+ headers: {
20914
+ [name: string]: unknown;
20915
+ };
20916
+ content: {
20917
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20918
+ };
20919
+ };
20920
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
20921
+ 403: {
20922
+ headers: {
20923
+ [name: string]: unknown;
20924
+ };
20925
+ content: {
20926
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20927
+ };
20928
+ };
20929
+ /** @description Possible error codes: `CHECKOUT_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_GROUP_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_RATE_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
20930
+ 404: {
20931
+ headers: {
20932
+ [name: string]: unknown;
20933
+ };
20934
+ content: {
20935
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20936
+ };
20937
+ };
20938
+ /** @description Possible error codes: `CHECKOUT_INVALID_STATUS`. Retryable: no. Possible error codes include `CHECKOUT_INVALID_STATUS`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PAYMENT_IN_FLIGHT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `store_closed_for_date`. Use `x-error-codes` for machine-readable retryability metadata. */
20939
+ 409: {
20940
+ headers: {
20941
+ [name: string]: unknown;
20942
+ };
20943
+ content: {
20944
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20945
+ };
20946
+ };
20947
+ /** @description Possible error codes include `SHIPPING_RATE_EXPIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
20948
+ 410: {
20949
+ headers: {
20950
+ [name: string]: unknown;
20951
+ };
20952
+ content: {
20953
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20954
+ };
20955
+ };
20956
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MERCHANT_AT_CAPACITY`. Use `x-error-codes` for machine-readable retryability metadata. */
20957
+ 429: {
20958
+ headers: {
20959
+ [name: string]: unknown;
20960
+ };
20961
+ content: {
20962
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20963
+ };
20964
+ };
20965
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
20966
+ 500: {
20967
+ headers: {
20968
+ [name: string]: unknown;
20969
+ };
20970
+ content: {
20971
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20972
+ };
20973
+ };
20974
+ };
20975
+ };
19248
20976
  checkout_packaging_choice_create: {
19249
20977
  parameters: {
19250
20978
  query?: never;