@poweredbysous/storefront-all-sdk 2.0.1 → 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 +2442 -250
  2. package/dist/index.d.ts +2442 -250
  3. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -134,6 +134,46 @@ interface paths {
134
134
  patch?: never;
135
135
  trace?: never;
136
136
  };
137
+ "/api/v1/admin/delivery-methods/": {
138
+ parameters: {
139
+ query?: never;
140
+ header?: never;
141
+ path?: never;
142
+ cookie?: never;
143
+ };
144
+ /**
145
+ * List the company's delivery-method availability
146
+ * @description ``GET /api/v1/admin/delivery-methods/`` — every method's company availability.
147
+ */
148
+ get: operations["admin_delivery_methods_list"];
149
+ put?: never;
150
+ post?: never;
151
+ delete?: never;
152
+ options?: never;
153
+ head?: never;
154
+ patch?: never;
155
+ trace?: never;
156
+ };
157
+ "/api/v1/admin/delivery-methods/{method}/": {
158
+ parameters: {
159
+ query?: never;
160
+ header?: never;
161
+ path?: never;
162
+ cookie?: never;
163
+ };
164
+ get?: never;
165
+ put?: never;
166
+ post?: never;
167
+ delete?: never;
168
+ options?: never;
169
+ head?: never;
170
+ /**
171
+ * Set the company's availability for one delivery method
172
+ * @description ``PATCH /api/v1/admin/delivery-methods/<method>/`` — the owner's switch.
173
+ */
174
+ patch: operations["admin_delivery_methods_partial_update"];
175
+ trace?: never;
176
+ };
137
177
  "/api/v1/admin/discounts/": {
138
178
  parameters: {
139
179
  query?: never;
@@ -325,6 +365,38 @@ interface paths {
325
365
  patch: operations["admin_discounts_partial_update"];
326
366
  trace?: never;
327
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
+ };
328
400
  "/api/v1/admin/pages/": {
329
401
  parameters: {
330
402
  query?: never;
@@ -843,6 +915,50 @@ interface paths {
843
915
  patch?: never;
844
916
  trace?: never;
845
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
+ };
846
962
  "/api/v1/admin/stores/{store_public_id}/compliance-defaults/": {
847
963
  parameters: {
848
964
  query?: never;
@@ -904,6 +1020,194 @@ interface paths {
904
1020
  patch?: never;
905
1021
  trace?: never;
906
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
+ };
1161
+ "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
1162
+ parameters: {
1163
+ query?: never;
1164
+ header?: never;
1165
+ path?: never;
1166
+ cookie?: never;
1167
+ };
1168
+ /**
1169
+ * List a Location's delivery-method config
1170
+ * @description ``GET .../stores/<store_public_id>/locations/<location_public_id>/
1171
+ * delivery-methods/``.
1172
+ *
1173
+ * Config for methods the company has made available, for one Location.
1174
+ * A method the company hasn't switched on at all is omitted entirely, not
1175
+ * returned disabled — "hidden, not greyed out": a Location cannot see, let
1176
+ * alone enable, something its company hasn't agreed to.
1177
+ */
1178
+ get: operations["admin_stores_locations_delivery_methods_list"];
1179
+ put?: never;
1180
+ post?: never;
1181
+ delete?: never;
1182
+ options?: never;
1183
+ head?: never;
1184
+ patch?: never;
1185
+ trace?: never;
1186
+ };
1187
+ "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/{method}/": {
1188
+ parameters: {
1189
+ query?: never;
1190
+ header?: never;
1191
+ path?: never;
1192
+ cookie?: never;
1193
+ };
1194
+ get?: never;
1195
+ put?: never;
1196
+ post?: never;
1197
+ delete?: never;
1198
+ options?: never;
1199
+ head?: never;
1200
+ /**
1201
+ * Set a Location's switch/config for one delivery method
1202
+ * @description ``PATCH .../stores/<store_public_id>/locations/<location_public_id>/
1203
+ * delivery-methods/<method>/``.
1204
+ *
1205
+ * One Location's own switch and/or its retained config. At least one of
1206
+ * ``is_enabled`` or a config field is required; either can be sent alone.
1207
+ */
1208
+ patch: operations["admin_stores_locations_delivery_methods_partial_update"];
1209
+ trace?: never;
1210
+ };
907
1211
  "/api/v1/admin/stores/{store_public_id}/surcharges/": {
908
1212
  parameters: {
909
1213
  query?: never;
@@ -1944,6 +2248,31 @@ interface paths {
1944
2248
  patch?: never;
1945
2249
  trace?: never;
1946
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
+ };
1947
2276
  "/api/v1/checkout/{checkout_id}/packaging-choice/": {
1948
2277
  parameters: {
1949
2278
  query?: never;
@@ -6330,6 +6659,21 @@ interface components {
6330
6659
  */
6331
6660
  reusable_deposit_id?: number | null;
6332
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
+ };
6333
6677
  /**
6334
6678
  * @description Per-store fulfilment capability for the merchant offers UI.
6335
6679
  *
@@ -6423,6 +6767,23 @@ interface components {
6423
6767
  masked_code: string;
6424
6768
  requires_security_code: boolean;
6425
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
+ };
6426
6787
  /**
6427
6788
  * @description * `free` - Free
6428
6789
  * * `percentage` - Percentage Off
@@ -6575,7 +6936,7 @@ interface components {
6575
6936
  id: string;
6576
6937
  /**
6577
6938
  * Format: int64
6578
- * @description company_id from the authenticated merchant
6939
+ * @description Store.id from the authenticated merchant
6579
6940
  */
6580
6941
  store_id: number;
6581
6942
  /**
@@ -6790,7 +7151,7 @@ interface components {
6790
7151
  id: string;
6791
7152
  /**
6792
7153
  * Format: int64
6793
- * @description company_id from the authenticated merchant
7154
+ * @description Store.id from the authenticated merchant
6794
7155
  */
6795
7156
  store_id: number;
6796
7157
  /**
@@ -6889,6 +7250,13 @@ interface components {
6889
7250
  landing_path?: string;
6890
7251
  referrer_host?: string;
6891
7252
  };
7253
+ /** @description One row of the company availability list: a method and its on/off state. */
7254
+ CompanyDeliveryMethodAvailability: {
7255
+ method: components["schemas"]["MethodEnum"];
7256
+ is_available: boolean;
7257
+ /** Format: date-time */
7258
+ updated_at: string | null;
7259
+ };
6892
7260
  ComplianceChoice: {
6893
7261
  slug: string;
6894
7262
  label: string;
@@ -7113,6 +7481,64 @@ interface components {
7113
7481
  /** @default */
7114
7482
  description: string;
7115
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
+ };
7116
7542
  /**
7117
7543
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
7118
7544
  *
@@ -7346,7 +7772,7 @@ interface components {
7346
7772
  id: string;
7347
7773
  /**
7348
7774
  * Format: int64
7349
- * @description company_id from the authenticated merchant
7775
+ * @description Store.id from the authenticated merchant
7350
7776
  */
7351
7777
  store_id: number;
7352
7778
  /** @description 6-character alphanumeric code for sharing */
@@ -7652,6 +8078,11 @@ interface components {
7652
8078
  LightspeedWebhook: {
7653
8079
  endpoint_id: string;
7654
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
+ };
7655
8086
  /**
7656
8087
  * @description * `single` - Single location
7657
8088
  * * `subset` - Subset of locations
@@ -7858,6 +8289,20 @@ interface components {
7858
8289
  * @enum {string}
7859
8290
  */
7860
8291
  MessageStatusEnum: "draft" | "active" | "paused" | "archived";
8292
+ /**
8293
+ * @description * `own_delivery` - Own Delivery
8294
+ * * `uber_direct` - Uber Direct
8295
+ * * `lieferando` - Lieferando
8296
+ * @enum {string}
8297
+ */
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";
7861
8306
  ModifyLineItem: {
7862
8307
  /** Format: uuid */
7863
8308
  order_line_item_id: string;
@@ -7931,7 +8376,7 @@ interface components {
7931
8376
  order_number: string;
7932
8377
  /**
7933
8378
  * Format: int64
7934
- * @description company_id from the authenticated merchant
8379
+ * @description Store.id from the authenticated merchant
7935
8380
  */
7936
8381
  store_id: number;
7937
8382
  /**
@@ -8588,6 +9033,21 @@ interface components {
8588
9033
  */
8589
9034
  reusable_deposit_id?: number | null;
8590
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
+ };
8591
9051
  /**
8592
9052
  * @description Validates the request body for binding a service point to a cart.
8593
9053
  *
@@ -8636,9 +9096,23 @@ interface components {
8636
9096
  /** @default */
8637
9097
  description: string;
8638
9098
  };
8639
- /**
8640
- * @description Merchant-facing CRUD serializer for :class:`Discount`.
8641
- *
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
+ };
9113
+ /**
9114
+ * @description Merchant-facing CRUD serializer for :class:`Discount`.
9115
+ *
8642
9116
  * Lives behind ``/api/v1/admin/discounts/`` (admin SDK audience). The
8643
9117
  * serializer validates the ``location_scope`` ↔ ``store_id`` / ``store_ids``
8644
9118
  * coherence rules at the boundary so a 400 with structured field errors is
@@ -8728,6 +9202,24 @@ interface components {
8728
9202
  /** Format: date-time */
8729
9203
  readonly updated_at?: string;
8730
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
+ };
8731
9223
  PatchedMessageUpdate: {
8732
9224
  priority?: number;
8733
9225
  /** Format: date-time */
@@ -8813,6 +9305,10 @@ interface components {
8813
9305
  timezone?: string;
8814
9306
  is_active?: boolean;
8815
9307
  };
9308
+ /** @description PATCH body for the company owner's availability switch. */
9309
+ PatchedSetCompanyAvailability: {
9310
+ is_available?: boolean;
9311
+ };
8816
9312
  /**
8817
9313
  * @description Validates the request body for setting delivery on a checkout.
8818
9314
  *
@@ -8837,6 +9333,26 @@ interface components {
8837
9333
  fulfillment_slot_id?: string;
8838
9334
  pickup_location_id?: number;
8839
9335
  };
9336
+ /**
9337
+ * @description PATCH body for a store's delivery-method row.
9338
+ *
9339
+ * ``is_enabled`` and the retained config fields are all optional so a
9340
+ * caller can flip the switch alone, without resending config it isn't
9341
+ * changing — but at least one field must be present.
9342
+ */
9343
+ PatchedSetStoreDeliveryMethod: {
9344
+ is_enabled?: boolean;
9345
+ delivery_area?: unknown;
9346
+ /** Format: decimal */
9347
+ base_fee?: string | null;
9348
+ /** Format: decimal */
9349
+ fee_split_percentage?: string | null;
9350
+ schedule?: unknown;
9351
+ lead_time_minutes?: number | null;
9352
+ cutoff_mode?: components["schemas"]["CutoffModeEnum"];
9353
+ cutoff_minutes?: number | null;
9354
+ cutoff_by_day?: unknown;
9355
+ };
8840
9356
  /**
8841
9357
  * @description Read/write serializer for the store-onboarding wizard.
8842
9358
  *
@@ -9902,6 +10418,34 @@ interface components {
9902
10418
  readonly offers_reusable_packaging: boolean;
9903
10419
  readonly reusable_deposit_amount?: string | null;
9904
10420
  };
10421
+ /** @description One row of the store config list: a method's switch plus retained config. */
10422
+ StoreDeliveryMethodConfig: {
10423
+ method: components["schemas"]["MethodEnum"];
10424
+ is_enabled: boolean;
10425
+ delivery_area: unknown;
10426
+ /** Format: decimal */
10427
+ base_fee: string | null;
10428
+ /** Format: decimal */
10429
+ fee_split_percentage: string | null;
10430
+ schedule: unknown;
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;
10439
+ /** Format: date-time */
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"][];
10448
+ };
9905
10449
  StoreMeResponse: {
9906
10450
  id: number;
9907
10451
  public_id: string;
@@ -10324,6 +10868,13 @@ interface components {
10324
10868
  order_line_item_id: string;
10325
10869
  quantity?: number;
10326
10870
  };
10871
+ /** @description A point, as ``MerchantShippingProvider`` stores it. */
10872
+ _Origin: {
10873
+ /** Format: decimal */
10874
+ latitude: string;
10875
+ /** Format: decimal */
10876
+ longitude: string;
10877
+ };
10327
10878
  /** @description A product a promotion grants as its benefit (id + translated name). */
10328
10879
  _PromotionBenefitProduct: {
10329
10880
  id: number;
@@ -10921,12 +11472,9 @@ interface operations {
10921
11472
  };
10922
11473
  };
10923
11474
  };
10924
- admin_discounts_list: {
11475
+ admin_delivery_methods_list: {
10925
11476
  parameters: {
10926
- query?: {
10927
- /** @description The pagination cursor value. */
10928
- cursor?: string;
10929
- };
11477
+ query?: never;
10930
11478
  header?: {
10931
11479
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10932
11480
  "X-Sous-Company-Id"?: number;
@@ -10941,7 +11489,7 @@ interface operations {
10941
11489
  [name: string]: unknown;
10942
11490
  };
10943
11491
  content: {
10944
- "application/json": components["schemas"]["PaginatedDiscountList"];
11492
+ "application/json": components["schemas"]["CompanyDeliveryMethodAvailability"][];
10945
11493
  };
10946
11494
  };
10947
11495
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11000,21 +11548,23 @@ interface operations {
11000
11548
  };
11001
11549
  };
11002
11550
  };
11003
- admin_discounts_create: {
11551
+ admin_delivery_methods_partial_update: {
11004
11552
  parameters: {
11005
11553
  query?: never;
11006
11554
  header?: {
11007
11555
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
11008
11556
  "X-Sous-Company-Id"?: number;
11009
11557
  };
11010
- path?: never;
11558
+ path: {
11559
+ method: string;
11560
+ };
11011
11561
  cookie?: never;
11012
11562
  };
11013
- requestBody: {
11563
+ requestBody?: {
11014
11564
  content: {
11015
- "application/json": components["schemas"]["Discount"];
11016
- "application/x-www-form-urlencoded": components["schemas"]["Discount"];
11017
- "multipart/form-data": components["schemas"]["Discount"];
11565
+ "application/json": components["schemas"]["PatchedSetCompanyAvailability"];
11566
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetCompanyAvailability"];
11567
+ "multipart/form-data": components["schemas"]["PatchedSetCompanyAvailability"];
11018
11568
  };
11019
11569
  };
11020
11570
  responses: {
@@ -11023,7 +11573,7 @@ interface operations {
11023
11573
  [name: string]: unknown;
11024
11574
  };
11025
11575
  content: {
11026
- "application/json": components["schemas"]["Discount"];
11576
+ "application/json": components["schemas"]["CompanyDeliveryMethodAvailability"];
11027
11577
  };
11028
11578
  };
11029
11579
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11082,17 +11632,17 @@ interface operations {
11082
11632
  };
11083
11633
  };
11084
11634
  };
11085
- admin_discounts_retrieve: {
11635
+ admin_discounts_list: {
11086
11636
  parameters: {
11087
- query?: never;
11637
+ query?: {
11638
+ /** @description The pagination cursor value. */
11639
+ cursor?: string;
11640
+ };
11088
11641
  header?: {
11089
11642
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
11090
11643
  "X-Sous-Company-Id"?: number;
11091
11644
  };
11092
- path: {
11093
- /** @description A UUID string identifying this discount. */
11094
- id: string;
11095
- };
11645
+ path?: never;
11096
11646
  cookie?: never;
11097
11647
  };
11098
11648
  requestBody?: never;
@@ -11102,7 +11652,7 @@ interface operations {
11102
11652
  [name: string]: unknown;
11103
11653
  };
11104
11654
  content: {
11105
- "application/json": components["schemas"]["Discount"];
11655
+ "application/json": components["schemas"]["PaginatedDiscountList"];
11106
11656
  };
11107
11657
  };
11108
11658
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -11161,17 +11711,14 @@ interface operations {
11161
11711
  };
11162
11712
  };
11163
11713
  };
11164
- admin_discounts_update: {
11714
+ admin_discounts_create: {
11165
11715
  parameters: {
11166
11716
  query?: never;
11167
11717
  header?: {
11168
11718
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
11169
11719
  "X-Sous-Company-Id"?: number;
11170
11720
  };
11171
- path: {
11172
- /** @description A UUID string identifying this discount. */
11173
- id: string;
11174
- };
11721
+ path?: never;
11175
11722
  cookie?: never;
11176
11723
  };
11177
11724
  requestBody: {
@@ -11246,7 +11793,7 @@ interface operations {
11246
11793
  };
11247
11794
  };
11248
11795
  };
11249
- admin_discounts_destroy: {
11796
+ admin_discounts_retrieve: {
11250
11797
  parameters: {
11251
11798
  query?: never;
11252
11799
  header?: {
@@ -11261,12 +11808,13 @@ interface operations {
11261
11808
  };
11262
11809
  requestBody?: never;
11263
11810
  responses: {
11264
- /** @description No response body */
11265
- 204: {
11811
+ 200: {
11266
11812
  headers: {
11267
11813
  [name: string]: unknown;
11268
11814
  };
11269
- content?: never;
11815
+ content: {
11816
+ "application/json": components["schemas"]["Discount"];
11817
+ };
11270
11818
  };
11271
11819
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
11272
11820
  400: {
@@ -11324,7 +11872,7 @@ interface operations {
11324
11872
  };
11325
11873
  };
11326
11874
  };
11327
- admin_discounts_partial_update: {
11875
+ admin_discounts_update: {
11328
11876
  parameters: {
11329
11877
  query?: never;
11330
11878
  header?: {
@@ -11337,11 +11885,11 @@ interface operations {
11337
11885
  };
11338
11886
  cookie?: never;
11339
11887
  };
11340
- requestBody?: {
11888
+ requestBody: {
11341
11889
  content: {
11342
- "application/json": components["schemas"]["PatchedDiscount"];
11343
- "application/x-www-form-urlencoded": components["schemas"]["PatchedDiscount"];
11344
- "multipart/form-data": components["schemas"]["PatchedDiscount"];
11890
+ "application/json": components["schemas"]["Discount"];
11891
+ "application/x-www-form-urlencoded": components["schemas"]["Discount"];
11892
+ "multipart/form-data": components["schemas"]["Discount"];
11345
11893
  };
11346
11894
  };
11347
11895
  responses: {
@@ -11409,29 +11957,29 @@ interface operations {
11409
11957
  };
11410
11958
  };
11411
11959
  };
11412
- admin_pages_list: {
11960
+ admin_discounts_destroy: {
11413
11961
  parameters: {
11414
- query?: {
11415
- /** @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`. */
11416
- lang?: string;
11962
+ query?: never;
11963
+ header?: {
11964
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
11965
+ "X-Sous-Company-Id"?: number;
11966
+ };
11967
+ path: {
11968
+ /** @description A UUID string identifying this discount. */
11969
+ id: string;
11417
11970
  };
11418
- header?: never;
11419
- path?: never;
11420
11971
  cookie?: never;
11421
11972
  };
11422
11973
  requestBody?: never;
11423
11974
  responses: {
11424
- 200: {
11975
+ /** @description No response body */
11976
+ 204: {
11425
11977
  headers: {
11426
11978
  [name: string]: unknown;
11427
11979
  };
11428
- content: {
11429
- "application/json": {
11430
- [key: string]: unknown;
11431
- };
11432
- };
11980
+ content?: never;
11433
11981
  };
11434
- /** @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. */
11982
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
11435
11983
  400: {
11436
11984
  headers: {
11437
11985
  [name: string]: unknown;
@@ -11458,7 +12006,7 @@ interface operations {
11458
12006
  "application/json": components["schemas"]["APIErrorEnvelope"];
11459
12007
  };
11460
12008
  };
11461
- /** @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. */
12009
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
11462
12010
  404: {
11463
12011
  headers: {
11464
12012
  [name: string]: unknown;
@@ -11487,38 +12035,36 @@ interface operations {
11487
12035
  };
11488
12036
  };
11489
12037
  };
11490
- admin_pages_create: {
12038
+ admin_discounts_partial_update: {
11491
12039
  parameters: {
11492
12040
  query?: never;
11493
- header?: never;
11494
- path?: never;
12041
+ header?: {
12042
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
12043
+ "X-Sous-Company-Id"?: number;
12044
+ };
12045
+ path: {
12046
+ /** @description A UUID string identifying this discount. */
12047
+ id: string;
12048
+ };
11495
12049
  cookie?: never;
11496
12050
  };
11497
12051
  requestBody?: {
11498
12052
  content: {
11499
- "application/json": {
11500
- [key: string]: unknown;
11501
- };
11502
- "application/x-www-form-urlencoded": {
11503
- [key: string]: unknown;
11504
- };
11505
- "multipart/form-data": {
11506
- [key: string]: unknown;
11507
- };
12053
+ "application/json": components["schemas"]["PatchedDiscount"];
12054
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDiscount"];
12055
+ "multipart/form-data": components["schemas"]["PatchedDiscount"];
11508
12056
  };
11509
12057
  };
11510
12058
  responses: {
11511
- 201: {
12059
+ 200: {
11512
12060
  headers: {
11513
12061
  [name: string]: unknown;
11514
12062
  };
11515
12063
  content: {
11516
- "application/json": {
11517
- [key: string]: unknown;
11518
- };
12064
+ "application/json": components["schemas"]["Discount"];
11519
12065
  };
11520
12066
  };
11521
- /** @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. */
12067
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
11522
12068
  400: {
11523
12069
  headers: {
11524
12070
  [name: string]: unknown;
@@ -11545,7 +12091,7 @@ interface operations {
11545
12091
  "application/json": components["schemas"]["APIErrorEnvelope"];
11546
12092
  };
11547
12093
  };
11548
- /** @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. */
12094
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
11549
12095
  404: {
11550
12096
  headers: {
11551
12097
  [name: string]: unknown;
@@ -11574,16 +12120,17 @@ interface operations {
11574
12120
  };
11575
12121
  };
11576
12122
  };
11577
- admin_pages_detail: {
12123
+ admin_locations_delivery_methods_list: {
11578
12124
  parameters: {
11579
- query?: {
11580
- /** @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`. */
11581
- 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[];
11582
12128
  };
11583
- header?: never;
11584
- path: {
11585
- page_id: string;
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;
11586
12132
  };
12133
+ path?: never;
11587
12134
  cookie?: never;
11588
12135
  };
11589
12136
  requestBody?: never;
@@ -11593,12 +12140,10 @@ interface operations {
11593
12140
  [name: string]: unknown;
11594
12141
  };
11595
12142
  content: {
11596
- "application/json": {
11597
- [key: string]: unknown;
11598
- };
12143
+ "application/json": components["schemas"]["LocationDeliveryMethodSummary"][];
11599
12144
  };
11600
12145
  };
11601
- /** @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. */
11602
12147
  400: {
11603
12148
  headers: {
11604
12149
  [name: string]: unknown;
@@ -11625,7 +12170,7 @@ interface operations {
11625
12170
  "application/json": components["schemas"]["APIErrorEnvelope"];
11626
12171
  };
11627
12172
  };
11628
- /** @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. */
11629
12174
  404: {
11630
12175
  headers: {
11631
12176
  [name: string]: unknown;
@@ -11654,23 +12199,27 @@ interface operations {
11654
12199
  };
11655
12200
  };
11656
12201
  };
11657
- admin_pages_destroy: {
12202
+ admin_pages_list: {
11658
12203
  parameters: {
11659
- query?: never;
11660
- header?: never;
11661
- path: {
11662
- page_id: string;
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;
11663
12207
  };
12208
+ header?: never;
12209
+ path?: never;
11664
12210
  cookie?: never;
11665
12211
  };
11666
12212
  requestBody?: never;
11667
12213
  responses: {
11668
- /** @description No response body */
11669
- 204: {
12214
+ 200: {
11670
12215
  headers: {
11671
12216
  [name: string]: unknown;
11672
12217
  };
11673
- content?: never;
12218
+ content: {
12219
+ "application/json": {
12220
+ [key: string]: unknown;
12221
+ };
12222
+ };
11674
12223
  };
11675
12224
  /** @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. */
11676
12225
  400: {
@@ -11728,13 +12277,11 @@ interface operations {
11728
12277
  };
11729
12278
  };
11730
12279
  };
11731
- admin_pages_partial_update: {
12280
+ admin_pages_create: {
11732
12281
  parameters: {
11733
12282
  query?: never;
11734
12283
  header?: never;
11735
- path: {
11736
- page_id: string;
11737
- };
12284
+ path?: never;
11738
12285
  cookie?: never;
11739
12286
  };
11740
12287
  requestBody?: {
@@ -11751,7 +12298,7 @@ interface operations {
11751
12298
  };
11752
12299
  };
11753
12300
  responses: {
11754
- 200: {
12301
+ 201: {
11755
12302
  headers: {
11756
12303
  [name: string]: unknown;
11757
12304
  };
@@ -11817,30 +12364,21 @@ interface operations {
11817
12364
  };
11818
12365
  };
11819
12366
  };
11820
- admin_pages_blocks_create: {
12367
+ admin_pages_detail: {
11821
12368
  parameters: {
11822
- query?: never;
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
+ };
11823
12373
  header?: never;
11824
12374
  path: {
11825
12375
  page_id: string;
11826
12376
  };
11827
12377
  cookie?: never;
11828
12378
  };
11829
- requestBody?: {
11830
- content: {
11831
- "application/json": {
11832
- [key: string]: unknown;
11833
- };
11834
- "application/x-www-form-urlencoded": {
11835
- [key: string]: unknown;
11836
- };
11837
- "multipart/form-data": {
11838
- [key: string]: unknown;
11839
- };
11840
- };
11841
- };
12379
+ requestBody?: never;
11842
12380
  responses: {
11843
- 201: {
12381
+ 200: {
11844
12382
  headers: {
11845
12383
  [name: string]: unknown;
11846
12384
  };
@@ -11906,12 +12444,11 @@ interface operations {
11906
12444
  };
11907
12445
  };
11908
12446
  };
11909
- admin_pages_blocks_destroy: {
12447
+ admin_pages_destroy: {
11910
12448
  parameters: {
11911
12449
  query?: never;
11912
12450
  header?: never;
11913
12451
  path: {
11914
- block_id: string;
11915
12452
  page_id: string;
11916
12453
  };
11917
12454
  cookie?: never;
@@ -11981,12 +12518,11 @@ interface operations {
11981
12518
  };
11982
12519
  };
11983
12520
  };
11984
- admin_pages_blocks_partial_update: {
12521
+ admin_pages_partial_update: {
11985
12522
  parameters: {
11986
12523
  query?: never;
11987
12524
  header?: never;
11988
12525
  path: {
11989
- block_id: string;
11990
12526
  page_id: string;
11991
12527
  };
11992
12528
  cookie?: never;
@@ -12071,7 +12607,7 @@ interface operations {
12071
12607
  };
12072
12608
  };
12073
12609
  };
12074
- admin_pages_blocks_reorder_update: {
12610
+ admin_pages_blocks_create: {
12075
12611
  parameters: {
12076
12612
  query?: never;
12077
12613
  header?: never;
@@ -12094,7 +12630,7 @@ interface operations {
12094
12630
  };
12095
12631
  };
12096
12632
  responses: {
12097
- 200: {
12633
+ 201: {
12098
12634
  headers: {
12099
12635
  [name: string]: unknown;
12100
12636
  };
@@ -12160,26 +12696,24 @@ interface operations {
12160
12696
  };
12161
12697
  };
12162
12698
  };
12163
- admin_pages_duplicate_create: {
12699
+ admin_pages_blocks_destroy: {
12164
12700
  parameters: {
12165
12701
  query?: never;
12166
12702
  header?: never;
12167
12703
  path: {
12704
+ block_id: string;
12168
12705
  page_id: string;
12169
12706
  };
12170
12707
  cookie?: never;
12171
12708
  };
12172
12709
  requestBody?: never;
12173
12710
  responses: {
12174
- 201: {
12711
+ /** @description No response body */
12712
+ 204: {
12175
12713
  headers: {
12176
12714
  [name: string]: unknown;
12177
12715
  };
12178
- content: {
12179
- "application/json": {
12180
- [key: string]: unknown;
12181
- };
12182
- };
12716
+ content?: never;
12183
12717
  };
12184
12718
  /** @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. */
12185
12719
  400: {
@@ -12237,11 +12771,12 @@ interface operations {
12237
12771
  };
12238
12772
  };
12239
12773
  };
12240
- admin_pages_publish_create: {
12774
+ admin_pages_blocks_partial_update: {
12241
12775
  parameters: {
12242
12776
  query?: never;
12243
12777
  header?: never;
12244
12778
  path: {
12779
+ block_id: string;
12245
12780
  page_id: string;
12246
12781
  };
12247
12782
  cookie?: never;
@@ -12276,9 +12811,7 @@ interface operations {
12276
12811
  [name: string]: unknown;
12277
12812
  };
12278
12813
  content: {
12279
- "application/json": {
12280
- [key: string]: unknown;
12281
- };
12814
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12282
12815
  };
12283
12816
  };
12284
12817
  /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12328,16 +12861,1397 @@ interface operations {
12328
12861
  };
12329
12862
  };
12330
12863
  };
12331
- admin_products_list: {
12864
+ admin_pages_blocks_reorder_update: {
12865
+ parameters: {
12866
+ query?: never;
12867
+ header?: never;
12868
+ path: {
12869
+ page_id: string;
12870
+ };
12871
+ cookie?: never;
12872
+ };
12873
+ requestBody?: {
12874
+ content: {
12875
+ "application/json": {
12876
+ [key: string]: unknown;
12877
+ };
12878
+ "application/x-www-form-urlencoded": {
12879
+ [key: string]: unknown;
12880
+ };
12881
+ "multipart/form-data": {
12882
+ [key: string]: unknown;
12883
+ };
12884
+ };
12885
+ };
12886
+ responses: {
12887
+ 200: {
12888
+ headers: {
12889
+ [name: string]: unknown;
12890
+ };
12891
+ content: {
12892
+ "application/json": {
12893
+ [key: string]: unknown;
12894
+ };
12895
+ };
12896
+ };
12897
+ /** @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. */
12898
+ 400: {
12899
+ headers: {
12900
+ [name: string]: unknown;
12901
+ };
12902
+ content: {
12903
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12904
+ };
12905
+ };
12906
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12907
+ 401: {
12908
+ headers: {
12909
+ [name: string]: unknown;
12910
+ };
12911
+ content: {
12912
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12913
+ };
12914
+ };
12915
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12916
+ 403: {
12917
+ headers: {
12918
+ [name: string]: unknown;
12919
+ };
12920
+ content: {
12921
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12922
+ };
12923
+ };
12924
+ /** @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. */
12925
+ 404: {
12926
+ headers: {
12927
+ [name: string]: unknown;
12928
+ };
12929
+ content: {
12930
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12931
+ };
12932
+ };
12933
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
12934
+ 429: {
12935
+ headers: {
12936
+ [name: string]: unknown;
12937
+ };
12938
+ content: {
12939
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12940
+ };
12941
+ };
12942
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12943
+ 500: {
12944
+ headers: {
12945
+ [name: string]: unknown;
12946
+ };
12947
+ content: {
12948
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12949
+ };
12950
+ };
12951
+ };
12952
+ };
12953
+ admin_pages_duplicate_create: {
12954
+ parameters: {
12955
+ query?: never;
12956
+ header?: never;
12957
+ path: {
12958
+ page_id: string;
12959
+ };
12960
+ cookie?: never;
12961
+ };
12962
+ requestBody?: never;
12963
+ responses: {
12964
+ 201: {
12965
+ headers: {
12966
+ [name: string]: unknown;
12967
+ };
12968
+ content: {
12969
+ "application/json": {
12970
+ [key: string]: unknown;
12971
+ };
12972
+ };
12973
+ };
12974
+ /** @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. */
12975
+ 400: {
12976
+ headers: {
12977
+ [name: string]: unknown;
12978
+ };
12979
+ content: {
12980
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12981
+ };
12982
+ };
12983
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
12984
+ 401: {
12985
+ headers: {
12986
+ [name: string]: unknown;
12987
+ };
12988
+ content: {
12989
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12990
+ };
12991
+ };
12992
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
12993
+ 403: {
12994
+ headers: {
12995
+ [name: string]: unknown;
12996
+ };
12997
+ content: {
12998
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12999
+ };
13000
+ };
13001
+ /** @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. */
13002
+ 404: {
13003
+ headers: {
13004
+ [name: string]: unknown;
13005
+ };
13006
+ content: {
13007
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13008
+ };
13009
+ };
13010
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13011
+ 429: {
13012
+ headers: {
13013
+ [name: string]: unknown;
13014
+ };
13015
+ content: {
13016
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13017
+ };
13018
+ };
13019
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13020
+ 500: {
13021
+ headers: {
13022
+ [name: string]: unknown;
13023
+ };
13024
+ content: {
13025
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13026
+ };
13027
+ };
13028
+ };
13029
+ };
13030
+ admin_pages_publish_create: {
13031
+ parameters: {
13032
+ query?: never;
13033
+ header?: never;
13034
+ path: {
13035
+ page_id: string;
13036
+ };
13037
+ cookie?: never;
13038
+ };
13039
+ requestBody?: {
13040
+ content: {
13041
+ "application/json": {
13042
+ [key: string]: unknown;
13043
+ };
13044
+ "application/x-www-form-urlencoded": {
13045
+ [key: string]: unknown;
13046
+ };
13047
+ "multipart/form-data": {
13048
+ [key: string]: unknown;
13049
+ };
13050
+ };
13051
+ };
13052
+ responses: {
13053
+ 200: {
13054
+ headers: {
13055
+ [name: string]: unknown;
13056
+ };
13057
+ content: {
13058
+ "application/json": {
13059
+ [key: string]: unknown;
13060
+ };
13061
+ };
13062
+ };
13063
+ /** @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. */
13064
+ 400: {
13065
+ headers: {
13066
+ [name: string]: unknown;
13067
+ };
13068
+ content: {
13069
+ "application/json": {
13070
+ [key: string]: unknown;
13071
+ };
13072
+ };
13073
+ };
13074
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13075
+ 401: {
13076
+ headers: {
13077
+ [name: string]: unknown;
13078
+ };
13079
+ content: {
13080
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13081
+ };
13082
+ };
13083
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13084
+ 403: {
13085
+ headers: {
13086
+ [name: string]: unknown;
13087
+ };
13088
+ content: {
13089
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13090
+ };
13091
+ };
13092
+ /** @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. */
13093
+ 404: {
13094
+ headers: {
13095
+ [name: string]: unknown;
13096
+ };
13097
+ content: {
13098
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13099
+ };
13100
+ };
13101
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13102
+ 429: {
13103
+ headers: {
13104
+ [name: string]: unknown;
13105
+ };
13106
+ content: {
13107
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13108
+ };
13109
+ };
13110
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13111
+ 500: {
13112
+ headers: {
13113
+ [name: string]: unknown;
13114
+ };
13115
+ content: {
13116
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13117
+ };
13118
+ };
13119
+ };
13120
+ };
13121
+ admin_products_list: {
13122
+ parameters: {
13123
+ query?: {
13124
+ /** @description Restrict to the product carrying this external_id (the merchant-portal Menu.id mirrored across the sync). Narrows the company-scoped list and never widens it, so an id belonging to another company yields an empty list — as does an unmatched or non-numeric value. Lets the portal resolve one product without downloading the store's catalogue to search it client-side. */
13125
+ external_id?: number;
13126
+ /** @description Restrict to one store by numeric Store.id. Must belong to the authenticated company; an unrelated id yields an empty list. */
13127
+ store_id?: number;
13128
+ /** @description Restrict to one store by its public_id (the stable, cross-system store key the merchant portal holds). Must belong to the authenticated company; an unrelated value yields an empty list. Preferred over store_id. */
13129
+ store_public_id?: string;
13130
+ };
13131
+ header?: {
13132
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13133
+ "X-Sous-Company-Id"?: number;
13134
+ };
13135
+ path?: never;
13136
+ cookie?: never;
13137
+ };
13138
+ requestBody?: never;
13139
+ responses: {
13140
+ 200: {
13141
+ headers: {
13142
+ [name: string]: unknown;
13143
+ };
13144
+ content: {
13145
+ "application/json": components["schemas"]["AdminProductOption"][];
13146
+ };
13147
+ };
13148
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13149
+ 400: {
13150
+ headers: {
13151
+ [name: string]: unknown;
13152
+ };
13153
+ content: {
13154
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13155
+ };
13156
+ };
13157
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13158
+ 401: {
13159
+ headers: {
13160
+ [name: string]: unknown;
13161
+ };
13162
+ content: {
13163
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13164
+ };
13165
+ };
13166
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13167
+ 403: {
13168
+ headers: {
13169
+ [name: string]: unknown;
13170
+ };
13171
+ content: {
13172
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13173
+ };
13174
+ };
13175
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13176
+ 404: {
13177
+ headers: {
13178
+ [name: string]: unknown;
13179
+ };
13180
+ content: {
13181
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13182
+ };
13183
+ };
13184
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13185
+ 429: {
13186
+ headers: {
13187
+ [name: string]: unknown;
13188
+ };
13189
+ content: {
13190
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13191
+ };
13192
+ };
13193
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13194
+ 500: {
13195
+ headers: {
13196
+ [name: string]: unknown;
13197
+ };
13198
+ content: {
13199
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13200
+ };
13201
+ };
13202
+ };
13203
+ };
13204
+ admin_products_attribute_values_list: {
13205
+ parameters: {
13206
+ query?: never;
13207
+ header?: {
13208
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13209
+ "X-Sous-Company-Id"?: number;
13210
+ };
13211
+ path: {
13212
+ product_id: number;
13213
+ };
13214
+ cookie?: never;
13215
+ };
13216
+ requestBody?: never;
13217
+ responses: {
13218
+ 200: {
13219
+ headers: {
13220
+ [name: string]: unknown;
13221
+ };
13222
+ content: {
13223
+ "application/json": components["schemas"]["ProductAttributeValue"][];
13224
+ };
13225
+ };
13226
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13227
+ 400: {
13228
+ headers: {
13229
+ [name: string]: unknown;
13230
+ };
13231
+ content: {
13232
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13233
+ };
13234
+ };
13235
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
13236
+ 401: {
13237
+ headers: {
13238
+ [name: string]: unknown;
13239
+ };
13240
+ content: {
13241
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13242
+ };
13243
+ };
13244
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
13245
+ 403: {
13246
+ headers: {
13247
+ [name: string]: unknown;
13248
+ };
13249
+ content: {
13250
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13251
+ };
13252
+ };
13253
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
13254
+ 404: {
13255
+ headers: {
13256
+ [name: string]: unknown;
13257
+ };
13258
+ content: {
13259
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13260
+ };
13261
+ };
13262
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
13263
+ 429: {
13264
+ headers: {
13265
+ [name: string]: unknown;
13266
+ };
13267
+ content: {
13268
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13269
+ };
13270
+ };
13271
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13272
+ 500: {
13273
+ headers: {
13274
+ [name: string]: unknown;
13275
+ };
13276
+ content: {
13277
+ "application/json": components["schemas"]["APIErrorEnvelope"];
13278
+ };
13279
+ };
13280
+ };
13281
+ };
13282
+ admin_products_attribute_values_update: {
13283
+ parameters: {
13284
+ query?: never;
13285
+ header?: {
13286
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13287
+ "X-Sous-Company-Id"?: number;
13288
+ };
13289
+ path: {
13290
+ product_id: number;
13291
+ };
13292
+ cookie?: never;
13293
+ };
13294
+ requestBody: {
13295
+ content: {
13296
+ "application/json": components["schemas"]["AdminAttributeValuesRequest"];
13297
+ "application/x-www-form-urlencoded": components["schemas"]["AdminAttributeValuesRequest"];
13298
+ "multipart/form-data": components["schemas"]["AdminAttributeValuesRequest"];
13299
+ };
13300
+ };
13301
+ responses: {
13302
+ 200: {
13303
+ headers: {
13304
+ [name: string]: unknown;
13305
+ };
13306
+ content: {
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: {
12332
14005
  parameters: {
12333
- query?: {
12334
- /** @description Restrict to the product carrying this external_id (the merchant-portal Menu.id mirrored across the sync). Narrows the company-scoped list and never widens it, so an id belonging to another company yields an empty list — as does an unmatched or non-numeric value. Lets the portal resolve one product without downloading the store's catalogue to search it client-side. */
12335
- external_id?: number;
12336
- /** @description Restrict to one store by numeric Store.id. Must belong to the authenticated company; an unrelated id yields an empty list. */
12337
- store_id?: number;
12338
- /** @description Restrict to one store by its public_id (the stable, cross-system store key the merchant portal holds). Must belong to the authenticated company; an unrelated value yields an empty list. Preferred over store_id. */
12339
- store_public_id?: string;
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;
12340
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;
12341
14255
  header?: {
12342
14256
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
12343
14257
  "X-Sous-Company-Id"?: number;
@@ -12352,7 +14266,7 @@ interface operations {
12352
14266
  [name: string]: unknown;
12353
14267
  };
12354
14268
  content: {
12355
- "application/json": components["schemas"]["AdminProductOption"][];
14269
+ "application/json": components["schemas"]["AdminStoreFulfillment"][];
12356
14270
  };
12357
14271
  };
12358
14272
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12411,7 +14325,7 @@ interface operations {
12411
14325
  };
12412
14326
  };
12413
14327
  };
12414
- admin_products_attribute_values_list: {
14328
+ admin_stores_base_coverage_retrieve: {
12415
14329
  parameters: {
12416
14330
  query?: never;
12417
14331
  header?: {
@@ -12419,7 +14333,7 @@ interface operations {
12419
14333
  "X-Sous-Company-Id"?: number;
12420
14334
  };
12421
14335
  path: {
12422
- product_id: number;
14336
+ store_public_id: string;
12423
14337
  };
12424
14338
  cookie?: never;
12425
14339
  };
@@ -12430,7 +14344,7 @@ interface operations {
12430
14344
  [name: string]: unknown;
12431
14345
  };
12432
14346
  content: {
12433
- "application/json": components["schemas"]["ProductAttributeValue"][];
14347
+ "application/json": components["schemas"]["BaseCoverage"];
12434
14348
  };
12435
14349
  };
12436
14350
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12489,7 +14403,7 @@ interface operations {
12489
14403
  };
12490
14404
  };
12491
14405
  };
12492
- admin_products_attribute_values_update: {
14406
+ admin_stores_base_coverage_update: {
12493
14407
  parameters: {
12494
14408
  query?: never;
12495
14409
  header?: {
@@ -12497,15 +14411,15 @@ interface operations {
12497
14411
  "X-Sous-Company-Id"?: number;
12498
14412
  };
12499
14413
  path: {
12500
- product_id: number;
14414
+ store_public_id: string;
12501
14415
  };
12502
14416
  cookie?: never;
12503
14417
  };
12504
14418
  requestBody: {
12505
14419
  content: {
12506
- "application/json": components["schemas"]["AdminAttributeValuesRequest"];
12507
- "application/x-www-form-urlencoded": components["schemas"]["AdminAttributeValuesRequest"];
12508
- "multipart/form-data": components["schemas"]["AdminAttributeValuesRequest"];
14420
+ "application/json": components["schemas"]["BaseCoverage"];
14421
+ "application/x-www-form-urlencoded": components["schemas"]["BaseCoverage"];
14422
+ "multipart/form-data": components["schemas"]["BaseCoverage"];
12509
14423
  };
12510
14424
  };
12511
14425
  responses: {
@@ -12514,7 +14428,7 @@ interface operations {
12514
14428
  [name: string]: unknown;
12515
14429
  };
12516
14430
  content: {
12517
- "application/json": components["schemas"]["ProductAttributeValue"][];
14431
+ "application/json": components["schemas"]["BaseCoverage"];
12518
14432
  };
12519
14433
  };
12520
14434
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12573,7 +14487,85 @@ interface operations {
12573
14487
  };
12574
14488
  };
12575
14489
  };
12576
- admin_products_confirm_compliance_retrieve: {
14490
+ admin_stores_compliance_defaults_retrieve: {
14491
+ parameters: {
14492
+ query?: never;
14493
+ header?: {
14494
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14495
+ "X-Sous-Company-Id"?: number;
14496
+ };
14497
+ path: {
14498
+ store_public_id: string;
14499
+ };
14500
+ cookie?: never;
14501
+ };
14502
+ requestBody?: never;
14503
+ responses: {
14504
+ 200: {
14505
+ headers: {
14506
+ [name: string]: unknown;
14507
+ };
14508
+ content: {
14509
+ "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
14510
+ };
14511
+ };
14512
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14513
+ 400: {
14514
+ headers: {
14515
+ [name: string]: unknown;
14516
+ };
14517
+ content: {
14518
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14519
+ };
14520
+ };
14521
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14522
+ 401: {
14523
+ headers: {
14524
+ [name: string]: unknown;
14525
+ };
14526
+ content: {
14527
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14528
+ };
14529
+ };
14530
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14531
+ 403: {
14532
+ headers: {
14533
+ [name: string]: unknown;
14534
+ };
14535
+ content: {
14536
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14537
+ };
14538
+ };
14539
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14540
+ 404: {
14541
+ headers: {
14542
+ [name: string]: unknown;
14543
+ };
14544
+ content: {
14545
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14546
+ };
14547
+ };
14548
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14549
+ 429: {
14550
+ headers: {
14551
+ [name: string]: unknown;
14552
+ };
14553
+ content: {
14554
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14555
+ };
14556
+ };
14557
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14558
+ 500: {
14559
+ headers: {
14560
+ [name: string]: unknown;
14561
+ };
14562
+ content: {
14563
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14564
+ };
14565
+ };
14566
+ };
14567
+ };
14568
+ admin_stores_compliance_defaults_partial_update: {
12577
14569
  parameters: {
12578
14570
  query?: never;
12579
14571
  header?: {
@@ -12581,7 +14573,96 @@ interface operations {
12581
14573
  "X-Sous-Company-Id"?: number;
12582
14574
  };
12583
14575
  path: {
12584
- product_id: number;
14576
+ store_public_id: string;
14577
+ };
14578
+ cookie?: never;
14579
+ };
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
+ };
14587
+ responses: {
14588
+ 200: {
14589
+ headers: {
14590
+ [name: string]: unknown;
14591
+ };
14592
+ content: {
14593
+ "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
14594
+ };
14595
+ };
14596
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14597
+ 400: {
14598
+ headers: {
14599
+ [name: string]: unknown;
14600
+ };
14601
+ content: {
14602
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14603
+ };
14604
+ };
14605
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
14606
+ 401: {
14607
+ headers: {
14608
+ [name: string]: unknown;
14609
+ };
14610
+ content: {
14611
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14612
+ };
14613
+ };
14614
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
14615
+ 403: {
14616
+ headers: {
14617
+ [name: string]: unknown;
14618
+ };
14619
+ content: {
14620
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14621
+ };
14622
+ };
14623
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
14624
+ 404: {
14625
+ headers: {
14626
+ [name: string]: unknown;
14627
+ };
14628
+ content: {
14629
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14630
+ };
14631
+ };
14632
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
14633
+ 429: {
14634
+ headers: {
14635
+ [name: string]: unknown;
14636
+ };
14637
+ content: {
14638
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14639
+ };
14640
+ };
14641
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
14642
+ 500: {
14643
+ headers: {
14644
+ [name: string]: unknown;
14645
+ };
14646
+ content: {
14647
+ "application/json": components["schemas"]["APIErrorEnvelope"];
14648
+ };
14649
+ };
14650
+ };
14651
+ };
14652
+ admin_stores_compliance_schema_retrieve: {
14653
+ parameters: {
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
+ };
14660
+ header?: {
14661
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
14662
+ "X-Sous-Company-Id"?: number;
14663
+ };
14664
+ path: {
14665
+ store_public_id: string;
12585
14666
  };
12586
14667
  cookie?: never;
12587
14668
  };
@@ -12592,7 +14673,7 @@ interface operations {
12592
14673
  [name: string]: unknown;
12593
14674
  };
12594
14675
  content: {
12595
- "application/json": components["schemas"]["ComplianceConfirmation"];
14676
+ "application/json": components["schemas"]["ComplianceSchemaResponse"];
12596
14677
  };
12597
14678
  };
12598
14679
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12651,7 +14732,7 @@ interface operations {
12651
14732
  };
12652
14733
  };
12653
14734
  };
12654
- admin_products_confirm_compliance_create: {
14735
+ admin_stores_delivery_areas_list: {
12655
14736
  parameters: {
12656
14737
  query?: never;
12657
14738
  header?: {
@@ -12659,18 +14740,19 @@ interface operations {
12659
14740
  "X-Sous-Company-Id"?: number;
12660
14741
  };
12661
14742
  path: {
12662
- product_id: number;
14743
+ store_public_id: string;
12663
14744
  };
12664
14745
  cookie?: never;
12665
14746
  };
12666
14747
  requestBody?: never;
12667
14748
  responses: {
12668
- /** @description No response body */
12669
14749
  200: {
12670
14750
  headers: {
12671
14751
  [name: string]: unknown;
12672
14752
  };
12673
- content?: never;
14753
+ content: {
14754
+ "application/json": components["schemas"]["DeliveryArea"][];
14755
+ };
12674
14756
  };
12675
14757
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12676
14758
  400: {
@@ -12678,7 +14760,7 @@ interface operations {
12678
14760
  [name: string]: unknown;
12679
14761
  };
12680
14762
  content: {
12681
- "application/json": components["schemas"]["ComplianceIncomplete"];
14763
+ "application/json": components["schemas"]["APIErrorEnvelope"];
12682
14764
  };
12683
14765
  };
12684
14766
  /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12728,7 +14810,7 @@ interface operations {
12728
14810
  };
12729
14811
  };
12730
14812
  };
12731
- admin_products_confirm_compliance_destroy: {
14813
+ admin_stores_delivery_areas_create: {
12732
14814
  parameters: {
12733
14815
  query?: never;
12734
14816
  header?: {
@@ -12736,18 +14818,25 @@ interface operations {
12736
14818
  "X-Sous-Company-Id"?: number;
12737
14819
  };
12738
14820
  path: {
12739
- product_id: number;
14821
+ store_public_id: string;
12740
14822
  };
12741
14823
  cookie?: never;
12742
14824
  };
12743
- requestBody?: never;
14825
+ requestBody: {
14826
+ content: {
14827
+ "application/json": components["schemas"]["DeliveryArea"];
14828
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryArea"];
14829
+ "multipart/form-data": components["schemas"]["DeliveryArea"];
14830
+ };
14831
+ };
12744
14832
  responses: {
12745
- /** @description No response body */
12746
- 204: {
14833
+ 201: {
12747
14834
  headers: {
12748
14835
  [name: string]: unknown;
12749
14836
  };
12750
- content?: never;
14837
+ content: {
14838
+ "application/json": components["schemas"]["DeliveryArea"];
14839
+ };
12751
14840
  };
12752
14841
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12753
14842
  400: {
@@ -12805,7 +14894,7 @@ interface operations {
12805
14894
  };
12806
14895
  };
12807
14896
  };
12808
- admin_products_surcharges_update: {
14897
+ admin_stores_delivery_areas_destroy: {
12809
14898
  parameters: {
12810
14899
  query?: never;
12811
14900
  header?: {
@@ -12813,25 +14902,19 @@ interface operations {
12813
14902
  "X-Sous-Company-Id"?: number;
12814
14903
  };
12815
14904
  path: {
12816
- product_id: number;
14905
+ shape_id: string;
14906
+ store_public_id: string;
12817
14907
  };
12818
14908
  cookie?: never;
12819
14909
  };
12820
- requestBody: {
12821
- content: {
12822
- "application/json": components["schemas"]["AdminProductSurchargesRequest"];
12823
- "application/x-www-form-urlencoded": components["schemas"]["AdminProductSurchargesRequest"];
12824
- "multipart/form-data": components["schemas"]["AdminProductSurchargesRequest"];
12825
- };
12826
- };
14910
+ requestBody?: never;
12827
14911
  responses: {
12828
- 200: {
14912
+ /** @description No response body */
14913
+ 204: {
12829
14914
  headers: {
12830
14915
  [name: string]: unknown;
12831
14916
  };
12832
- content: {
12833
- "application/json": components["schemas"]["Surcharge"][];
12834
- };
14917
+ content?: never;
12835
14918
  };
12836
14919
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
12837
14920
  400: {
@@ -12889,21 +14972,24 @@ interface operations {
12889
14972
  };
12890
14973
  };
12891
14974
  };
12892
- admin_products_shared_create: {
14975
+ admin_stores_delivery_areas_partial_update: {
12893
14976
  parameters: {
12894
14977
  query?: never;
12895
14978
  header?: {
12896
14979
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
12897
14980
  "X-Sous-Company-Id"?: number;
12898
14981
  };
12899
- path?: never;
14982
+ path: {
14983
+ shape_id: string;
14984
+ store_public_id: string;
14985
+ };
12900
14986
  cookie?: never;
12901
14987
  };
12902
- requestBody: {
14988
+ requestBody?: {
12903
14989
  content: {
12904
- "application/json": components["schemas"]["SharedProductsRequest"];
12905
- "application/x-www-form-urlencoded": components["schemas"]["SharedProductsRequest"];
12906
- "multipart/form-data": components["schemas"]["SharedProductsRequest"];
14990
+ "application/json": components["schemas"]["PatchedDeliveryAreaUpdate"];
14991
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryAreaUpdate"];
14992
+ "multipart/form-data": components["schemas"]["PatchedDeliveryAreaUpdate"];
12907
14993
  };
12908
14994
  };
12909
14995
  responses: {
@@ -12912,7 +14998,7 @@ interface operations {
12912
14998
  [name: string]: unknown;
12913
14999
  };
12914
15000
  content: {
12915
- "application/json": components["schemas"]["SharedBrandProduct"][];
15001
+ "application/json": components["schemas"]["DeliveryArea"];
12916
15002
  };
12917
15003
  };
12918
15004
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -12971,17 +15057,16 @@ interface operations {
12971
15057
  };
12972
15058
  };
12973
15059
  };
12974
- admin_promotions_list: {
15060
+ admin_stores_delivery_exclusions_list: {
12975
15061
  parameters: {
12976
- query?: {
12977
- /** @description The pagination cursor value. */
12978
- cursor?: string;
12979
- };
15062
+ query?: never;
12980
15063
  header?: {
12981
15064
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
12982
15065
  "X-Sous-Company-Id"?: number;
12983
15066
  };
12984
- path?: never;
15067
+ path: {
15068
+ store_public_id: string;
15069
+ };
12985
15070
  cookie?: never;
12986
15071
  };
12987
15072
  requestBody?: never;
@@ -12991,7 +15076,7 @@ interface operations {
12991
15076
  [name: string]: unknown;
12992
15077
  };
12993
15078
  content: {
12994
- "application/json": components["schemas"]["PaginatedAdminPromotionList"];
15079
+ "application/json": components["schemas"]["DeliveryExclusion"][];
12995
15080
  };
12996
15081
  };
12997
15082
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13050,30 +15135,32 @@ interface operations {
13050
15135
  };
13051
15136
  };
13052
15137
  };
13053
- admin_promotions_create: {
15138
+ admin_stores_delivery_exclusions_create: {
13054
15139
  parameters: {
13055
15140
  query?: never;
13056
15141
  header?: {
13057
15142
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13058
15143
  "X-Sous-Company-Id"?: number;
13059
15144
  };
13060
- path?: never;
15145
+ path: {
15146
+ store_public_id: string;
15147
+ };
13061
15148
  cookie?: never;
13062
15149
  };
13063
15150
  requestBody: {
13064
15151
  content: {
13065
- "application/json": components["schemas"]["AdminPromotion"];
13066
- "application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
13067
- "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"];
13068
15155
  };
13069
15156
  };
13070
15157
  responses: {
13071
- 200: {
15158
+ 201: {
13072
15159
  headers: {
13073
15160
  [name: string]: unknown;
13074
15161
  };
13075
15162
  content: {
13076
- "application/json": components["schemas"]["AdminPromotion"];
15163
+ "application/json": components["schemas"]["DeliveryExclusion"];
13077
15164
  };
13078
15165
  };
13079
15166
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13132,7 +15219,7 @@ interface operations {
13132
15219
  };
13133
15220
  };
13134
15221
  };
13135
- admin_promotions_retrieve: {
15222
+ admin_stores_delivery_exclusions_destroy: {
13136
15223
  parameters: {
13137
15224
  query?: never;
13138
15225
  header?: {
@@ -13140,20 +15227,19 @@ interface operations {
13140
15227
  "X-Sous-Company-Id"?: number;
13141
15228
  };
13142
15229
  path: {
13143
- /** @description A unique integer value identifying this promotion. */
13144
- id: number;
15230
+ shape_id: string;
15231
+ store_public_id: string;
13145
15232
  };
13146
15233
  cookie?: never;
13147
15234
  };
13148
15235
  requestBody?: never;
13149
15236
  responses: {
13150
- 200: {
15237
+ /** @description No response body */
15238
+ 204: {
13151
15239
  headers: {
13152
15240
  [name: string]: unknown;
13153
15241
  };
13154
- content: {
13155
- "application/json": components["schemas"]["AdminPromotion"];
13156
- };
15242
+ content?: never;
13157
15243
  };
13158
15244
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13159
15245
  400: {
@@ -13211,7 +15297,7 @@ interface operations {
13211
15297
  };
13212
15298
  };
13213
15299
  };
13214
- admin_promotions_update: {
15300
+ admin_stores_delivery_exclusions_partial_update: {
13215
15301
  parameters: {
13216
15302
  query?: never;
13217
15303
  header?: {
@@ -13219,16 +15305,16 @@ interface operations {
13219
15305
  "X-Sous-Company-Id"?: number;
13220
15306
  };
13221
15307
  path: {
13222
- /** @description A unique integer value identifying this promotion. */
13223
- id: number;
15308
+ shape_id: string;
15309
+ store_public_id: string;
13224
15310
  };
13225
15311
  cookie?: never;
13226
15312
  };
13227
- requestBody: {
15313
+ requestBody?: {
13228
15314
  content: {
13229
- "application/json": components["schemas"]["AdminPromotion"];
13230
- "application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
13231
- "multipart/form-data": components["schemas"]["AdminPromotion"];
15315
+ "application/json": components["schemas"]["PatchedDeliveryExclusionUpdate"];
15316
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryExclusionUpdate"];
15317
+ "multipart/form-data": components["schemas"]["PatchedDeliveryExclusionUpdate"];
13232
15318
  };
13233
15319
  };
13234
15320
  responses: {
@@ -13237,7 +15323,7 @@ interface operations {
13237
15323
  [name: string]: unknown;
13238
15324
  };
13239
15325
  content: {
13240
- "application/json": components["schemas"]["AdminPromotion"];
15326
+ "application/json": components["schemas"]["DeliveryExclusion"];
13241
15327
  };
13242
15328
  };
13243
15329
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13296,7 +15382,7 @@ interface operations {
13296
15382
  };
13297
15383
  };
13298
15384
  };
13299
- admin_promotions_destroy: {
15385
+ admin_stores_delivery_fee_retrieve: {
13300
15386
  parameters: {
13301
15387
  query?: never;
13302
15388
  header?: {
@@ -13304,19 +15390,19 @@ interface operations {
13304
15390
  "X-Sous-Company-Id"?: number;
13305
15391
  };
13306
15392
  path: {
13307
- /** @description A unique integer value identifying this promotion. */
13308
- id: number;
15393
+ store_public_id: string;
13309
15394
  };
13310
15395
  cookie?: never;
13311
15396
  };
13312
15397
  requestBody?: never;
13313
15398
  responses: {
13314
- /** @description No response body */
13315
- 204: {
15399
+ 200: {
13316
15400
  headers: {
13317
15401
  [name: string]: unknown;
13318
15402
  };
13319
- content?: never;
15403
+ content: {
15404
+ "application/json": components["schemas"]["DeliveryFee"];
15405
+ };
13320
15406
  };
13321
15407
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
13322
15408
  400: {
@@ -13374,7 +15460,7 @@ interface operations {
13374
15460
  };
13375
15461
  };
13376
15462
  };
13377
- admin_promotions_partial_update: {
15463
+ admin_stores_delivery_fee_update: {
13378
15464
  parameters: {
13379
15465
  query?: never;
13380
15466
  header?: {
@@ -13382,16 +15468,15 @@ interface operations {
13382
15468
  "X-Sous-Company-Id"?: number;
13383
15469
  };
13384
15470
  path: {
13385
- /** @description A unique integer value identifying this promotion. */
13386
- id: number;
15471
+ store_public_id: string;
13387
15472
  };
13388
15473
  cookie?: never;
13389
15474
  };
13390
- requestBody?: {
15475
+ requestBody: {
13391
15476
  content: {
13392
- "application/json": components["schemas"]["PatchedAdminPromotion"];
13393
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminPromotion"];
13394
- "multipart/form-data": components["schemas"]["PatchedAdminPromotion"];
15477
+ "application/json": components["schemas"]["DeliveryFee"];
15478
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryFee"];
15479
+ "multipart/form-data": components["schemas"]["DeliveryFee"];
13395
15480
  };
13396
15481
  };
13397
15482
  responses: {
@@ -13400,7 +15485,7 @@ interface operations {
13400
15485
  [name: string]: unknown;
13401
15486
  };
13402
15487
  content: {
13403
- "application/json": components["schemas"]["AdminPromotion"];
15488
+ "application/json": components["schemas"]["DeliveryFee"];
13404
15489
  };
13405
15490
  };
13406
15491
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13459,14 +15544,16 @@ interface operations {
13459
15544
  };
13460
15545
  };
13461
15546
  };
13462
- admin_store_fulfillment_types_list: {
15547
+ admin_stores_delivery_fee_split_retrieve: {
13463
15548
  parameters: {
13464
15549
  query?: never;
13465
15550
  header?: {
13466
15551
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13467
15552
  "X-Sous-Company-Id"?: number;
13468
15553
  };
13469
- path?: never;
15554
+ path: {
15555
+ store_public_id: string;
15556
+ };
13470
15557
  cookie?: never;
13471
15558
  };
13472
15559
  requestBody?: never;
@@ -13476,7 +15563,7 @@ interface operations {
13476
15563
  [name: string]: unknown;
13477
15564
  };
13478
15565
  content: {
13479
- "application/json": components["schemas"]["AdminStoreFulfillment"][];
15566
+ "application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
13480
15567
  };
13481
15568
  };
13482
15569
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13535,7 +15622,7 @@ interface operations {
13535
15622
  };
13536
15623
  };
13537
15624
  };
13538
- admin_stores_compliance_defaults_retrieve: {
15625
+ admin_stores_delivery_fee_split_partial_update: {
13539
15626
  parameters: {
13540
15627
  query?: never;
13541
15628
  header?: {
@@ -13547,14 +15634,20 @@ interface operations {
13547
15634
  };
13548
15635
  cookie?: never;
13549
15636
  };
13550
- 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
+ };
13551
15644
  responses: {
13552
15645
  200: {
13553
15646
  headers: {
13554
15647
  [name: string]: unknown;
13555
15648
  };
13556
15649
  content: {
13557
- "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
15650
+ "application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
13558
15651
  };
13559
15652
  };
13560
15653
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13613,7 +15706,7 @@ interface operations {
13613
15706
  };
13614
15707
  };
13615
15708
  };
13616
- admin_stores_compliance_defaults_partial_update: {
15709
+ admin_stores_locations_delivery_methods_list: {
13617
15710
  parameters: {
13618
15711
  query?: never;
13619
15712
  header?: {
@@ -13621,24 +15714,19 @@ interface operations {
13621
15714
  "X-Sous-Company-Id"?: number;
13622
15715
  };
13623
15716
  path: {
15717
+ location_public_id: string;
13624
15718
  store_public_id: string;
13625
15719
  };
13626
15720
  cookie?: never;
13627
15721
  };
13628
- requestBody?: {
13629
- content: {
13630
- "application/json": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
13631
- "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
13632
- "multipart/form-data": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
13633
- };
13634
- };
15722
+ requestBody?: never;
13635
15723
  responses: {
13636
15724
  200: {
13637
15725
  headers: {
13638
15726
  [name: string]: unknown;
13639
15727
  };
13640
15728
  content: {
13641
- "application/json": components["schemas"]["AdminStoreComplianceDefaults"];
15729
+ "application/json": components["schemas"]["StoreDeliveryMethodConfig"][];
13642
15730
  };
13643
15731
  };
13644
15732
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -13697,31 +15785,34 @@ interface operations {
13697
15785
  };
13698
15786
  };
13699
15787
  };
13700
- admin_stores_compliance_schema_retrieve: {
15788
+ admin_stores_locations_delivery_methods_partial_update: {
13701
15789
  parameters: {
13702
- query: {
13703
- /** @description Language code for translated labels. Defaults to 'en'. */
13704
- lang?: string;
13705
- /** @description ProductType slug, e.g. 'product' or 'food-product' (products.constants.PLATFORM_PRODUCT_TYPES). */
13706
- product_type: string;
13707
- };
15790
+ query?: never;
13708
15791
  header?: {
13709
15792
  /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
13710
15793
  "X-Sous-Company-Id"?: number;
13711
15794
  };
13712
15795
  path: {
15796
+ location_public_id: string;
15797
+ method: string;
13713
15798
  store_public_id: string;
13714
15799
  };
13715
15800
  cookie?: never;
13716
15801
  };
13717
- requestBody?: never;
15802
+ requestBody?: {
15803
+ content: {
15804
+ "application/json": components["schemas"]["PatchedSetStoreDeliveryMethod"];
15805
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetStoreDeliveryMethod"];
15806
+ "multipart/form-data": components["schemas"]["PatchedSetStoreDeliveryMethod"];
15807
+ };
15808
+ };
13718
15809
  responses: {
13719
15810
  200: {
13720
15811
  headers: {
13721
15812
  [name: string]: unknown;
13722
15813
  };
13723
15814
  content: {
13724
- "application/json": components["schemas"]["ComplianceSchemaResponse"];
15815
+ "application/json": components["schemas"]["StoreDeliveryMethodConfig"];
13725
15816
  };
13726
15817
  };
13727
15818
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
@@ -18781,6 +20872,107 @@ interface operations {
18781
20872
  };
18782
20873
  };
18783
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
+ };
18784
20976
  checkout_packaging_choice_create: {
18785
20977
  parameters: {
18786
20978
  query?: never;