@poweredbysous/storefront-admin-sdk 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.cts +1621 -37
  2. package/dist/index.d.ts +1621 -37
  3. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -321,6 +321,38 @@ interface paths {
321
321
  patch: operations["admin_discounts_partial_update"];
322
322
  trace?: never;
323
323
  };
324
+ "/api/v1/admin/locations/delivery-methods/": {
325
+ parameters: {
326
+ query?: never;
327
+ header?: never;
328
+ path?: never;
329
+ cookie?: never;
330
+ };
331
+ /**
332
+ * Summarise delivery-method state for several Locations
333
+ * @description ``GET /api/v1/admin/locations/delivery-methods/?pair=<store>:<location>``.
334
+ *
335
+ * Read-only, many-location counterpart of ``StoreDeliveryMethodListView``
336
+ * for the Portal's Locations list: each method's on/off state and
337
+ * ``disabled_at`` per (store, location) pair, without the retained config.
338
+ * The caller names the pairs (it already knows each Location's Vendors), so
339
+ * this never infers membership from ``LocationStoreLink``, which may not be
340
+ * populated yet for a store — see ``_location_linked_to_store``.
341
+ *
342
+ * Same visibility rules as the single-location list: methods the company
343
+ * hasn't made available are omitted, and a pair whose store belongs to
344
+ * another company is silently dropped rather than reported, so it can't be
345
+ * used to probe for other companies' ids.
346
+ */
347
+ get: operations["admin_locations_delivery_methods_list"];
348
+ put?: never;
349
+ post?: never;
350
+ delete?: never;
351
+ options?: never;
352
+ head?: never;
353
+ patch?: never;
354
+ trace?: never;
355
+ };
324
356
  "/api/v1/admin/pages/": {
325
357
  parameters: {
326
358
  query?: never;
@@ -839,6 +871,50 @@ interface paths {
839
871
  patch?: never;
840
872
  trace?: never;
841
873
  };
874
+ "/api/v1/admin/stores/{store_public_id}/base-coverage/": {
875
+ parameters: {
876
+ query?: never;
877
+ header?: never;
878
+ path?: never;
879
+ cookie?: never;
880
+ };
881
+ /**
882
+ * @description The rule this location's drawn areas are added to.
883
+ *
884
+ * Reuses ``_DrawnShapeViewSet`` for store resolution, the row lock and the
885
+ * shared-provider 409 — the parts that are dangerous and identical — but
886
+ * exposes a single object rather than a collection, because a location has
887
+ * one base coverage, not a list of them.
888
+ *
889
+ * ``mode`` is derived on read rather than stored. The modes are a *reading*
890
+ * of the rules already on the row, so a stored discriminator could disagree
891
+ * with the rules that actually decide coverage, and the rules would win. See
892
+ * ``base_coverage.mode_of``, and the module docstring there for why the
893
+ * portal is allowed to write a field the sync serializer also lists.
894
+ */
895
+ get: operations["admin_stores_base_coverage_retrieve"];
896
+ /**
897
+ * @description The rule this location's drawn areas are added to.
898
+ *
899
+ * Reuses ``_DrawnShapeViewSet`` for store resolution, the row lock and the
900
+ * shared-provider 409 — the parts that are dangerous and identical — but
901
+ * exposes a single object rather than a collection, because a location has
902
+ * one base coverage, not a list of them.
903
+ *
904
+ * ``mode`` is derived on read rather than stored. The modes are a *reading*
905
+ * of the rules already on the row, so a stored discriminator could disagree
906
+ * with the rules that actually decide coverage, and the rules would win. See
907
+ * ``base_coverage.mode_of``, and the module docstring there for why the
908
+ * portal is allowed to write a field the sync serializer also lists.
909
+ */
910
+ put: operations["admin_stores_base_coverage_update"];
911
+ post?: never;
912
+ delete?: never;
913
+ options?: never;
914
+ head?: never;
915
+ patch?: never;
916
+ trace?: never;
917
+ };
842
918
  "/api/v1/admin/stores/{store_public_id}/compliance-defaults/": {
843
919
  parameters: {
844
920
  query?: never;
@@ -900,6 +976,144 @@ interface paths {
900
976
  patch?: never;
901
977
  trace?: never;
902
978
  };
979
+ "/api/v1/admin/stores/{store_public_id}/delivery-areas/": {
980
+ parameters: {
981
+ query?: never;
982
+ header?: never;
983
+ path?: never;
984
+ cookie?: never;
985
+ };
986
+ /** @description List the shapes of this kind stored for the location. */
987
+ get: operations["admin_stores_delivery_areas_list"];
988
+ put?: never;
989
+ /** @description Add one shape, leaving every other entry untouched. */
990
+ post: operations["admin_stores_delivery_areas_create"];
991
+ delete?: never;
992
+ options?: never;
993
+ head?: never;
994
+ patch?: never;
995
+ trace?: never;
996
+ };
997
+ "/api/v1/admin/stores/{store_public_id}/delivery-areas/{shape_id}/": {
998
+ parameters: {
999
+ query?: never;
1000
+ header?: never;
1001
+ path?: never;
1002
+ cookie?: never;
1003
+ };
1004
+ get?: never;
1005
+ put?: never;
1006
+ post?: never;
1007
+ /** @description Remove one shape, leaving the rest of the coverage intact. */
1008
+ delete: operations["admin_stores_delivery_areas_destroy"];
1009
+ options?: never;
1010
+ head?: never;
1011
+ /** @description Reshape or rename one shape, leaving the others untouched. */
1012
+ patch: operations["admin_stores_delivery_areas_partial_update"];
1013
+ trace?: never;
1014
+ };
1015
+ "/api/v1/admin/stores/{store_public_id}/delivery-exclusions/": {
1016
+ parameters: {
1017
+ query?: never;
1018
+ header?: never;
1019
+ path?: never;
1020
+ cookie?: never;
1021
+ };
1022
+ /** @description List the shapes of this kind stored for the location. */
1023
+ get: operations["admin_stores_delivery_exclusions_list"];
1024
+ put?: never;
1025
+ /** @description Add one shape, leaving every other entry untouched. */
1026
+ post: operations["admin_stores_delivery_exclusions_create"];
1027
+ delete?: never;
1028
+ options?: never;
1029
+ head?: never;
1030
+ patch?: never;
1031
+ trace?: never;
1032
+ };
1033
+ "/api/v1/admin/stores/{store_public_id}/delivery-exclusions/{shape_id}/": {
1034
+ parameters: {
1035
+ query?: never;
1036
+ header?: never;
1037
+ path?: never;
1038
+ cookie?: never;
1039
+ };
1040
+ get?: never;
1041
+ put?: never;
1042
+ post?: never;
1043
+ /** @description Remove one shape, leaving the rest of the coverage intact. */
1044
+ delete: operations["admin_stores_delivery_exclusions_destroy"];
1045
+ options?: never;
1046
+ head?: never;
1047
+ /** @description Reshape or rename one shape, leaving the others untouched. */
1048
+ patch: operations["admin_stores_delivery_exclusions_partial_update"];
1049
+ trace?: never;
1050
+ };
1051
+ "/api/v1/admin/stores/{store_public_id}/delivery-fee/": {
1052
+ parameters: {
1053
+ query?: never;
1054
+ header?: never;
1055
+ path?: never;
1056
+ cookie?: never;
1057
+ };
1058
+ /**
1059
+ * @description What a customer is charged for this location's own delivery.
1060
+ *
1061
+ * A singleton on the same resolution/lock/409 base as the shapes. The
1062
+ * portal may write these for the reason ``base_coverage.py`` gives for the
1063
+ * radius: they are in the sync serializer's field list, but the only thing
1064
+ * that ever sends them is the hand-run ``set_store_delivery_method``
1065
+ * command — the ops task this feature replaces — so there is no routine
1066
+ * second writer.
1067
+ */
1068
+ get: operations["admin_stores_delivery_fee_retrieve"];
1069
+ /**
1070
+ * @description What a customer is charged for this location's own delivery.
1071
+ *
1072
+ * A singleton on the same resolution/lock/409 base as the shapes. The
1073
+ * portal may write these for the reason ``base_coverage.py`` gives for the
1074
+ * radius: they are in the sync serializer's field list, but the only thing
1075
+ * that ever sends them is the hand-run ``set_store_delivery_method``
1076
+ * command — the ops task this feature replaces — so there is no routine
1077
+ * second writer.
1078
+ */
1079
+ put: operations["admin_stores_delivery_fee_update"];
1080
+ post?: never;
1081
+ delete?: never;
1082
+ options?: never;
1083
+ head?: never;
1084
+ patch?: never;
1085
+ trace?: never;
1086
+ };
1087
+ "/api/v1/admin/stores/{store_public_id}/delivery-fee-split/": {
1088
+ parameters: {
1089
+ query?: never;
1090
+ header?: never;
1091
+ path?: never;
1092
+ cookie?: never;
1093
+ };
1094
+ /**
1095
+ * Get a store's delivery-fee split
1096
+ * @description The merchant portal has to show the current split before it can
1097
+ * offer to change it.
1098
+ */
1099
+ get: operations["admin_stores_delivery_fee_split_retrieve"];
1100
+ put?: never;
1101
+ post?: never;
1102
+ delete?: never;
1103
+ options?: never;
1104
+ head?: never;
1105
+ /**
1106
+ * Set a store's delivery-fee split
1107
+ * @description Read/write a store's merchant/customer delivery-fee split.
1108
+ *
1109
+ * Auth and company scoping mirror ``AdminStoreComplianceDefaultsView``:
1110
+ * Firebase merchant auth, store resolved via ``resolve_active_company`` +
1111
+ * ``public_id`` so a merchant can only ever reach their own company's
1112
+ * store, never another company's.
1113
+ */
1114
+ patch: operations["admin_stores_delivery_fee_split_partial_update"];
1115
+ trace?: never;
1116
+ };
903
1117
  "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
904
1118
  parameters: {
905
1119
  query?: never;
@@ -3129,6 +3343,21 @@ interface components {
3129
3343
  */
3130
3344
  reusable_deposit_id?: number | null;
3131
3345
  };
3346
+ /**
3347
+ * @description Read/write view of a store's merchant/customer delivery-fee split.
3348
+ *
3349
+ * ``delivery_fee_customer_pct`` is the fraction (0-1) of the shipping cost
3350
+ * the customer pays; the merchant absorbs the remainder — see
3351
+ * ``core.fees.apply_pass_through``. DRF derives 0-1 bounds validation from
3352
+ * the model field's own validators.
3353
+ */
3354
+ AdminStoreDeliveryFeeSplit: {
3355
+ /**
3356
+ * Format: decimal
3357
+ * @description Fraction of shipping cost the customer pays (0-1). Merchant absorbs the remainder.
3358
+ */
3359
+ delivery_fee_customer_pct?: string;
3360
+ };
3132
3361
  /**
3133
3362
  * @description Per-store fulfilment capability for the merchant offers UI.
3134
3363
  *
@@ -3175,6 +3404,23 @@ interface components {
3175
3404
  slug: string;
3176
3405
  position?: number;
3177
3406
  };
3407
+ /**
3408
+ * @description The rule a location's drawn areas are added to.
3409
+ *
3410
+ * ``mode`` is derived from the rules on read (see ``base_coverage.mode_of``)
3411
+ * and drives which of the other fields matters on write — the client sends
3412
+ * the whole shape and the server decides what to keep, so a merchant who
3413
+ * switches from Radius to Postcodes does not leave a stale radius behind
3414
+ * still granting coverage.
3415
+ */
3416
+ BaseCoverage: {
3417
+ mode: components["schemas"]["ModeEnum"];
3418
+ /** Format: decimal */
3419
+ radius_km?: string | null;
3420
+ postcodes?: string[];
3421
+ readonly drawn_area_count: number;
3422
+ readonly origin: components["schemas"]["_Origin"] | null;
3423
+ };
3178
3424
  /**
3179
3425
  * @description * `free` - Free
3180
3426
  * * `percentage` - Percentage Off
@@ -3501,6 +3747,64 @@ interface components {
3501
3747
  /** @default */
3502
3748
  description: string;
3503
3749
  };
3750
+ /**
3751
+ * @description * `before_close` - A notice before the day closes
3752
+ * * `by_day` - A time set for each day
3753
+ * @enum {string}
3754
+ */
3755
+ CutoffModeEnum: "before_close" | "by_day";
3756
+ /**
3757
+ * @description One area a merchant drew on a map.
3758
+ *
3759
+ * ``id`` is read-only: it is minted server-side so that a client cannot
3760
+ * address — or overwrite — an area it does not own, the same discipline the
3761
+ * store id gets on every other company-scoped admin endpoint.
3762
+ */
3763
+ DeliveryArea: {
3764
+ readonly id: string;
3765
+ /** @description What the merchant calls this area, e.g. 'North of the canal'. */
3766
+ name?: string;
3767
+ /** @description A GeoJSON Polygon with a single closed ring, [longitude, latitude], WGS84. A point on the boundary counts as inside. */
3768
+ polygon: unknown;
3769
+ };
3770
+ /**
3771
+ * @description One pocket a merchant cut out of their coverage.
3772
+ *
3773
+ * A separate serializer rather than a flag on :class:`DeliveryAreaSerializer`
3774
+ * because the wire key is what makes a pocket safe: a reader that predates
3775
+ * exclusions must not be able to mistake one for coverage. See the
3776
+ * ``delivery_areas`` module docstring and workspace ADR 0014.
3777
+ */
3778
+ DeliveryExclusion: {
3779
+ readonly id: string;
3780
+ /** @description What the merchant calls this pocket, e.g. 'Canal island'. */
3781
+ name?: string;
3782
+ /** @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. */
3783
+ excluded_polygon: unknown;
3784
+ };
3785
+ /**
3786
+ * @description What a customer is charged for this location's own delivery.
3787
+ *
3788
+ * Two numbers, not the customer/restaurant *split* the design also shows.
3789
+ * That division has no field anywhere yet — merchant-portal-backend's
3790
+ * ``delivery_fee_fixed`` is the platform's charge *to* the restaurant, a
3791
+ * finance setting, not the same thing — and it is what PAT-2186 decides.
3792
+ * Until then this exposes the total and the free-delivery threshold, which
3793
+ * the storefront already reads on every rate.
3794
+ */
3795
+ DeliveryFee: {
3796
+ /** Format: decimal */
3797
+ base_delivery_fee: string;
3798
+ /** Format: decimal */
3799
+ free_delivery_threshold?: string | null;
3800
+ };
3801
+ /** @description One method's on/off state at one store+location — the summary's leaf. */
3802
+ DeliveryMethodState: {
3803
+ method: components["schemas"]["MethodEnum"];
3804
+ is_enabled: boolean;
3805
+ /** Format: date-time */
3806
+ disabled_at: string | null;
3807
+ };
3504
3808
  /**
3505
3809
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
3506
3810
  *
@@ -3719,6 +4023,11 @@ interface components {
3719
4023
  * @enum {string}
3720
4024
  */
3721
4025
  InvoiceStatusEnum: "draft" | "issued" | "paid" | "cancelled";
4026
+ /** @description One location's delivery-method state, grouped by the stores serving it. */
4027
+ LocationDeliveryMethodSummary: {
4028
+ location_public_id: string;
4029
+ stores: components["schemas"]["StoreDeliveryMethodStates"][];
4030
+ };
3722
4031
  /**
3723
4032
  * @description * `single` - Single location
3724
4033
  * * `subset` - Subset of locations
@@ -3865,6 +4174,13 @@ interface components {
3865
4174
  * @enum {string}
3866
4175
  */
3867
4176
  MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
4177
+ /**
4178
+ * @description * `drawn` - drawn
4179
+ * * `radius` - radius
4180
+ * * `postcodes` - postcodes
4181
+ * @enum {string}
4182
+ */
4183
+ ModeEnum: "drawn" | "radius" | "postcodes";
3868
4184
  ModifyLineItem: {
3869
4185
  /** Format: uuid */
3870
4186
  order_line_item_id: string;
@@ -4478,6 +4794,21 @@ interface components {
4478
4794
  */
4479
4795
  reusable_deposit_id?: number | null;
4480
4796
  };
4797
+ /**
4798
+ * @description Read/write view of a store's merchant/customer delivery-fee split.
4799
+ *
4800
+ * ``delivery_fee_customer_pct`` is the fraction (0-1) of the shipping cost
4801
+ * the customer pays; the merchant absorbs the remainder — see
4802
+ * ``core.fees.apply_pass_through``. DRF derives 0-1 bounds validation from
4803
+ * the model field's own validators.
4804
+ */
4805
+ PatchedAdminStoreDeliveryFeeSplit: {
4806
+ /**
4807
+ * Format: decimal
4808
+ * @description Fraction of shipping cost the customer pays (0-1). Merchant absorbs the remainder.
4809
+ */
4810
+ delivery_fee_customer_pct?: string;
4811
+ };
4481
4812
  PatchedBusinessAccountMemberUpdate: {
4482
4813
  name?: string;
4483
4814
  /** Format: decimal */
@@ -4513,6 +4844,20 @@ interface components {
4513
4844
  /** @default */
4514
4845
  description: string;
4515
4846
  };
4847
+ /** @description A partial edit: rename an area, reshape it, or both. */
4848
+ PatchedDeliveryAreaUpdate: {
4849
+ readonly id?: string;
4850
+ /** @description What the merchant calls this area, e.g. 'North of the canal'. */
4851
+ name?: string;
4852
+ polygon?: unknown;
4853
+ };
4854
+ /** @description A partial edit: rename a pocket, reshape it, or both. */
4855
+ PatchedDeliveryExclusionUpdate: {
4856
+ readonly id?: string;
4857
+ /** @description What the merchant calls this pocket, e.g. 'Canal island'. */
4858
+ name?: string;
4859
+ excluded_polygon?: unknown;
4860
+ };
4516
4861
  /**
4517
4862
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
4518
4863
  *
@@ -4699,6 +5044,9 @@ interface components {
4699
5044
  fee_split_percentage?: string | null;
4700
5045
  schedule?: unknown;
4701
5046
  lead_time_minutes?: number | null;
5047
+ cutoff_mode?: components["schemas"]["CutoffModeEnum"];
5048
+ cutoff_minutes?: number | null;
5049
+ cutoff_by_day?: unknown;
4702
5050
  };
4703
5051
  PatchedSurcharge: {
4704
5052
  readonly id?: number;
@@ -5362,8 +5710,22 @@ interface components {
5362
5710
  fee_split_percentage: string | null;
5363
5711
  schedule: unknown;
5364
5712
  lead_time_minutes: number | null;
5713
+ cutoff_mode: components["schemas"]["CutoffModeEnum"];
5714
+ /** @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. */
5715
+ cutoff_minutes: number | null;
5716
+ /** @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. */
5717
+ cutoff_by_day: unknown;
5718
+ /** @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. */
5719
+ readonly cutoff_in_force: unknown;
5365
5720
  /** Format: date-time */
5366
5721
  config_updated_at: string | null;
5722
+ /** Format: date-time */
5723
+ disabled_at: string | null;
5724
+ };
5725
+ /** @description Every company-available method's state at one store for one location. */
5726
+ StoreDeliveryMethodStates: {
5727
+ store_public_id: string;
5728
+ methods: components["schemas"]["DeliveryMethodState"][];
5367
5729
  };
5368
5730
  StoreMeResponse: {
5369
5731
  id: number;
@@ -5657,6 +6019,13 @@ interface components {
5657
6019
  order_line_item_id: string;
5658
6020
  quantity?: number;
5659
6021
  };
6022
+ /** @description A point, as ``MerchantShippingProvider`` stores it. */
6023
+ _Origin: {
6024
+ /** Format: decimal */
6025
+ latitude: string;
6026
+ /** Format: decimal */
6027
+ longitude: string;
6028
+ };
5660
6029
  /** @description A product a promotion grants as its benefit (id + translated name). */
5661
6030
  _PromotionBenefitProduct: {
5662
6031
  id: number;
@@ -6761,13 +7130,16 @@ interface operations {
6761
7130
  };
6762
7131
  };
6763
7132
  };
6764
- admin_pages_list: {
7133
+ admin_locations_delivery_methods_list: {
6765
7134
  parameters: {
6766
- query?: {
6767
- /** @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`. */
6768
- lang?: string;
7135
+ query: {
7136
+ /** @description Repeated ``<store_public_id>:<location_public_id>``, one per store serving a location. At most 50. */
7137
+ pair: string[];
7138
+ };
7139
+ header?: {
7140
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
7141
+ "X-Sous-Company-Id"?: number;
6769
7142
  };
6770
- header?: never;
6771
7143
  path?: never;
6772
7144
  cookie?: never;
6773
7145
  };
@@ -6778,12 +7150,10 @@ interface operations {
6778
7150
  [name: string]: unknown;
6779
7151
  };
6780
7152
  content: {
6781
- "application/json": {
6782
- [key: string]: unknown;
6783
- };
7153
+ "application/json": components["schemas"]["LocationDeliveryMethodSummary"][];
6784
7154
  };
6785
7155
  };
6786
- /** @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. */
7156
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6787
7157
  400: {
6788
7158
  headers: {
6789
7159
  [name: string]: unknown;
@@ -6810,7 +7180,7 @@ interface operations {
6810
7180
  "application/json": components["schemas"]["APIErrorEnvelope"];
6811
7181
  };
6812
7182
  };
6813
- /** @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. */
7183
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
6814
7184
  404: {
6815
7185
  headers: {
6816
7186
  [name: string]: unknown;
@@ -6839,28 +7209,19 @@ interface operations {
6839
7209
  };
6840
7210
  };
6841
7211
  };
6842
- admin_pages_create: {
7212
+ admin_pages_list: {
6843
7213
  parameters: {
6844
- query?: never;
7214
+ query?: {
7215
+ /** @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`. */
7216
+ lang?: string;
7217
+ };
6845
7218
  header?: never;
6846
7219
  path?: never;
6847
7220
  cookie?: never;
6848
7221
  };
6849
- requestBody?: {
6850
- content: {
6851
- "application/json": {
6852
- [key: string]: unknown;
6853
- };
6854
- "application/x-www-form-urlencoded": {
6855
- [key: string]: unknown;
6856
- };
6857
- "multipart/form-data": {
6858
- [key: string]: unknown;
6859
- };
6860
- };
6861
- };
7222
+ requestBody?: never;
6862
7223
  responses: {
6863
- 201: {
7224
+ 200: {
6864
7225
  headers: {
6865
7226
  [name: string]: unknown;
6866
7227
  };
@@ -6926,21 +7287,28 @@ interface operations {
6926
7287
  };
6927
7288
  };
6928
7289
  };
6929
- admin_pages_detail: {
7290
+ admin_pages_create: {
6930
7291
  parameters: {
6931
- query?: {
6932
- /** @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`. */
6933
- lang?: string;
6934
- };
7292
+ query?: never;
6935
7293
  header?: never;
6936
- path: {
6937
- page_id: string;
6938
- };
7294
+ path?: never;
6939
7295
  cookie?: never;
6940
7296
  };
6941
- requestBody?: never;
7297
+ requestBody?: {
7298
+ content: {
7299
+ "application/json": {
7300
+ [key: string]: unknown;
7301
+ };
7302
+ "application/x-www-form-urlencoded": {
7303
+ [key: string]: unknown;
7304
+ };
7305
+ "multipart/form-data": {
7306
+ [key: string]: unknown;
7307
+ };
7308
+ };
7309
+ };
6942
7310
  responses: {
6943
- 200: {
7311
+ 201: {
6944
7312
  headers: {
6945
7313
  [name: string]: unknown;
6946
7314
  };
@@ -7006,7 +7374,87 @@ interface operations {
7006
7374
  };
7007
7375
  };
7008
7376
  };
7009
- admin_pages_destroy: {
7377
+ admin_pages_detail: {
7378
+ parameters: {
7379
+ query?: {
7380
+ /** @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`. */
7381
+ lang?: string;
7382
+ };
7383
+ header?: never;
7384
+ path: {
7385
+ page_id: string;
7386
+ };
7387
+ cookie?: never;
7388
+ };
7389
+ requestBody?: never;
7390
+ responses: {
7391
+ 200: {
7392
+ headers: {
7393
+ [name: string]: unknown;
7394
+ };
7395
+ content: {
7396
+ "application/json": {
7397
+ [key: string]: unknown;
7398
+ };
7399
+ };
7400
+ };
7401
+ /** @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. */
7402
+ 400: {
7403
+ headers: {
7404
+ [name: string]: unknown;
7405
+ };
7406
+ content: {
7407
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7408
+ };
7409
+ };
7410
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
7411
+ 401: {
7412
+ headers: {
7413
+ [name: string]: unknown;
7414
+ };
7415
+ content: {
7416
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7417
+ };
7418
+ };
7419
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
7420
+ 403: {
7421
+ headers: {
7422
+ [name: string]: unknown;
7423
+ };
7424
+ content: {
7425
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7426
+ };
7427
+ };
7428
+ /** @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. */
7429
+ 404: {
7430
+ headers: {
7431
+ [name: string]: unknown;
7432
+ };
7433
+ content: {
7434
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7435
+ };
7436
+ };
7437
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
7438
+ 429: {
7439
+ headers: {
7440
+ [name: string]: unknown;
7441
+ };
7442
+ content: {
7443
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7444
+ };
7445
+ };
7446
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7447
+ 500: {
7448
+ headers: {
7449
+ [name: string]: unknown;
7450
+ };
7451
+ content: {
7452
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7453
+ };
7454
+ };
7455
+ };
7456
+ };
7457
+ admin_pages_destroy: {
7010
7458
  parameters: {
7011
7459
  query?: never;
7012
7460
  header?: never;
@@ -8887,6 +9335,168 @@ interface operations {
8887
9335
  };
8888
9336
  };
8889
9337
  };
9338
+ admin_stores_base_coverage_retrieve: {
9339
+ parameters: {
9340
+ query?: never;
9341
+ header?: {
9342
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9343
+ "X-Sous-Company-Id"?: number;
9344
+ };
9345
+ path: {
9346
+ store_public_id: string;
9347
+ };
9348
+ cookie?: never;
9349
+ };
9350
+ requestBody?: never;
9351
+ responses: {
9352
+ 200: {
9353
+ headers: {
9354
+ [name: string]: unknown;
9355
+ };
9356
+ content: {
9357
+ "application/json": components["schemas"]["BaseCoverage"];
9358
+ };
9359
+ };
9360
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9361
+ 400: {
9362
+ headers: {
9363
+ [name: string]: unknown;
9364
+ };
9365
+ content: {
9366
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9367
+ };
9368
+ };
9369
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9370
+ 401: {
9371
+ headers: {
9372
+ [name: string]: unknown;
9373
+ };
9374
+ content: {
9375
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9376
+ };
9377
+ };
9378
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9379
+ 403: {
9380
+ headers: {
9381
+ [name: string]: unknown;
9382
+ };
9383
+ content: {
9384
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9385
+ };
9386
+ };
9387
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9388
+ 404: {
9389
+ headers: {
9390
+ [name: string]: unknown;
9391
+ };
9392
+ content: {
9393
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9394
+ };
9395
+ };
9396
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9397
+ 429: {
9398
+ headers: {
9399
+ [name: string]: unknown;
9400
+ };
9401
+ content: {
9402
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9403
+ };
9404
+ };
9405
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9406
+ 500: {
9407
+ headers: {
9408
+ [name: string]: unknown;
9409
+ };
9410
+ content: {
9411
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9412
+ };
9413
+ };
9414
+ };
9415
+ };
9416
+ admin_stores_base_coverage_update: {
9417
+ parameters: {
9418
+ query?: never;
9419
+ header?: {
9420
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9421
+ "X-Sous-Company-Id"?: number;
9422
+ };
9423
+ path: {
9424
+ store_public_id: string;
9425
+ };
9426
+ cookie?: never;
9427
+ };
9428
+ requestBody: {
9429
+ content: {
9430
+ "application/json": components["schemas"]["BaseCoverage"];
9431
+ "application/x-www-form-urlencoded": components["schemas"]["BaseCoverage"];
9432
+ "multipart/form-data": components["schemas"]["BaseCoverage"];
9433
+ };
9434
+ };
9435
+ responses: {
9436
+ 200: {
9437
+ headers: {
9438
+ [name: string]: unknown;
9439
+ };
9440
+ content: {
9441
+ "application/json": components["schemas"]["BaseCoverage"];
9442
+ };
9443
+ };
9444
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9445
+ 400: {
9446
+ headers: {
9447
+ [name: string]: unknown;
9448
+ };
9449
+ content: {
9450
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9451
+ };
9452
+ };
9453
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9454
+ 401: {
9455
+ headers: {
9456
+ [name: string]: unknown;
9457
+ };
9458
+ content: {
9459
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9460
+ };
9461
+ };
9462
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9463
+ 403: {
9464
+ headers: {
9465
+ [name: string]: unknown;
9466
+ };
9467
+ content: {
9468
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9469
+ };
9470
+ };
9471
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9472
+ 404: {
9473
+ headers: {
9474
+ [name: string]: unknown;
9475
+ };
9476
+ content: {
9477
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9478
+ };
9479
+ };
9480
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9481
+ 429: {
9482
+ headers: {
9483
+ [name: string]: unknown;
9484
+ };
9485
+ content: {
9486
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9487
+ };
9488
+ };
9489
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9490
+ 500: {
9491
+ headers: {
9492
+ [name: string]: unknown;
9493
+ };
9494
+ content: {
9495
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9496
+ };
9497
+ };
9498
+ };
9499
+ };
8890
9500
  admin_stores_compliance_defaults_retrieve: {
8891
9501
  parameters: {
8892
9502
  query?: never;
@@ -9132,6 +9742,980 @@ interface operations {
9132
9742
  };
9133
9743
  };
9134
9744
  };
9745
+ admin_stores_delivery_areas_list: {
9746
+ parameters: {
9747
+ query?: never;
9748
+ header?: {
9749
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9750
+ "X-Sous-Company-Id"?: number;
9751
+ };
9752
+ path: {
9753
+ store_public_id: string;
9754
+ };
9755
+ cookie?: never;
9756
+ };
9757
+ requestBody?: never;
9758
+ responses: {
9759
+ 200: {
9760
+ headers: {
9761
+ [name: string]: unknown;
9762
+ };
9763
+ content: {
9764
+ "application/json": components["schemas"]["DeliveryArea"][];
9765
+ };
9766
+ };
9767
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9768
+ 400: {
9769
+ headers: {
9770
+ [name: string]: unknown;
9771
+ };
9772
+ content: {
9773
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9774
+ };
9775
+ };
9776
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9777
+ 401: {
9778
+ headers: {
9779
+ [name: string]: unknown;
9780
+ };
9781
+ content: {
9782
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9783
+ };
9784
+ };
9785
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9786
+ 403: {
9787
+ headers: {
9788
+ [name: string]: unknown;
9789
+ };
9790
+ content: {
9791
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9792
+ };
9793
+ };
9794
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9795
+ 404: {
9796
+ headers: {
9797
+ [name: string]: unknown;
9798
+ };
9799
+ content: {
9800
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9801
+ };
9802
+ };
9803
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9804
+ 429: {
9805
+ headers: {
9806
+ [name: string]: unknown;
9807
+ };
9808
+ content: {
9809
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9810
+ };
9811
+ };
9812
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9813
+ 500: {
9814
+ headers: {
9815
+ [name: string]: unknown;
9816
+ };
9817
+ content: {
9818
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9819
+ };
9820
+ };
9821
+ };
9822
+ };
9823
+ admin_stores_delivery_areas_create: {
9824
+ parameters: {
9825
+ query?: never;
9826
+ header?: {
9827
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9828
+ "X-Sous-Company-Id"?: number;
9829
+ };
9830
+ path: {
9831
+ store_public_id: string;
9832
+ };
9833
+ cookie?: never;
9834
+ };
9835
+ requestBody: {
9836
+ content: {
9837
+ "application/json": components["schemas"]["DeliveryArea"];
9838
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryArea"];
9839
+ "multipart/form-data": components["schemas"]["DeliveryArea"];
9840
+ };
9841
+ };
9842
+ responses: {
9843
+ 201: {
9844
+ headers: {
9845
+ [name: string]: unknown;
9846
+ };
9847
+ content: {
9848
+ "application/json": components["schemas"]["DeliveryArea"];
9849
+ };
9850
+ };
9851
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9852
+ 400: {
9853
+ headers: {
9854
+ [name: string]: unknown;
9855
+ };
9856
+ content: {
9857
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9858
+ };
9859
+ };
9860
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9861
+ 401: {
9862
+ headers: {
9863
+ [name: string]: unknown;
9864
+ };
9865
+ content: {
9866
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9867
+ };
9868
+ };
9869
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9870
+ 403: {
9871
+ headers: {
9872
+ [name: string]: unknown;
9873
+ };
9874
+ content: {
9875
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9876
+ };
9877
+ };
9878
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9879
+ 404: {
9880
+ headers: {
9881
+ [name: string]: unknown;
9882
+ };
9883
+ content: {
9884
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9885
+ };
9886
+ };
9887
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9888
+ 429: {
9889
+ headers: {
9890
+ [name: string]: unknown;
9891
+ };
9892
+ content: {
9893
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9894
+ };
9895
+ };
9896
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9897
+ 500: {
9898
+ headers: {
9899
+ [name: string]: unknown;
9900
+ };
9901
+ content: {
9902
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9903
+ };
9904
+ };
9905
+ };
9906
+ };
9907
+ admin_stores_delivery_areas_destroy: {
9908
+ parameters: {
9909
+ query?: never;
9910
+ header?: {
9911
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9912
+ "X-Sous-Company-Id"?: number;
9913
+ };
9914
+ path: {
9915
+ shape_id: string;
9916
+ store_public_id: string;
9917
+ };
9918
+ cookie?: never;
9919
+ };
9920
+ requestBody?: never;
9921
+ responses: {
9922
+ /** @description No response body */
9923
+ 204: {
9924
+ headers: {
9925
+ [name: string]: unknown;
9926
+ };
9927
+ content?: never;
9928
+ };
9929
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9930
+ 400: {
9931
+ headers: {
9932
+ [name: string]: unknown;
9933
+ };
9934
+ content: {
9935
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9936
+ };
9937
+ };
9938
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9939
+ 401: {
9940
+ headers: {
9941
+ [name: string]: unknown;
9942
+ };
9943
+ content: {
9944
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9945
+ };
9946
+ };
9947
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9948
+ 403: {
9949
+ headers: {
9950
+ [name: string]: unknown;
9951
+ };
9952
+ content: {
9953
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9954
+ };
9955
+ };
9956
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9957
+ 404: {
9958
+ headers: {
9959
+ [name: string]: unknown;
9960
+ };
9961
+ content: {
9962
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9963
+ };
9964
+ };
9965
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9966
+ 429: {
9967
+ headers: {
9968
+ [name: string]: unknown;
9969
+ };
9970
+ content: {
9971
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9972
+ };
9973
+ };
9974
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9975
+ 500: {
9976
+ headers: {
9977
+ [name: string]: unknown;
9978
+ };
9979
+ content: {
9980
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9981
+ };
9982
+ };
9983
+ };
9984
+ };
9985
+ admin_stores_delivery_areas_partial_update: {
9986
+ parameters: {
9987
+ query?: never;
9988
+ header?: {
9989
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9990
+ "X-Sous-Company-Id"?: number;
9991
+ };
9992
+ path: {
9993
+ shape_id: string;
9994
+ store_public_id: string;
9995
+ };
9996
+ cookie?: never;
9997
+ };
9998
+ requestBody?: {
9999
+ content: {
10000
+ "application/json": components["schemas"]["PatchedDeliveryAreaUpdate"];
10001
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryAreaUpdate"];
10002
+ "multipart/form-data": components["schemas"]["PatchedDeliveryAreaUpdate"];
10003
+ };
10004
+ };
10005
+ responses: {
10006
+ 200: {
10007
+ headers: {
10008
+ [name: string]: unknown;
10009
+ };
10010
+ content: {
10011
+ "application/json": components["schemas"]["DeliveryArea"];
10012
+ };
10013
+ };
10014
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10015
+ 400: {
10016
+ headers: {
10017
+ [name: string]: unknown;
10018
+ };
10019
+ content: {
10020
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10021
+ };
10022
+ };
10023
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10024
+ 401: {
10025
+ headers: {
10026
+ [name: string]: unknown;
10027
+ };
10028
+ content: {
10029
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10030
+ };
10031
+ };
10032
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10033
+ 403: {
10034
+ headers: {
10035
+ [name: string]: unknown;
10036
+ };
10037
+ content: {
10038
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10039
+ };
10040
+ };
10041
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10042
+ 404: {
10043
+ headers: {
10044
+ [name: string]: unknown;
10045
+ };
10046
+ content: {
10047
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10048
+ };
10049
+ };
10050
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10051
+ 429: {
10052
+ headers: {
10053
+ [name: string]: unknown;
10054
+ };
10055
+ content: {
10056
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10057
+ };
10058
+ };
10059
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10060
+ 500: {
10061
+ headers: {
10062
+ [name: string]: unknown;
10063
+ };
10064
+ content: {
10065
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10066
+ };
10067
+ };
10068
+ };
10069
+ };
10070
+ admin_stores_delivery_exclusions_list: {
10071
+ parameters: {
10072
+ query?: never;
10073
+ header?: {
10074
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10075
+ "X-Sous-Company-Id"?: number;
10076
+ };
10077
+ path: {
10078
+ store_public_id: string;
10079
+ };
10080
+ cookie?: never;
10081
+ };
10082
+ requestBody?: never;
10083
+ responses: {
10084
+ 200: {
10085
+ headers: {
10086
+ [name: string]: unknown;
10087
+ };
10088
+ content: {
10089
+ "application/json": components["schemas"]["DeliveryExclusion"][];
10090
+ };
10091
+ };
10092
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10093
+ 400: {
10094
+ headers: {
10095
+ [name: string]: unknown;
10096
+ };
10097
+ content: {
10098
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10099
+ };
10100
+ };
10101
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10102
+ 401: {
10103
+ headers: {
10104
+ [name: string]: unknown;
10105
+ };
10106
+ content: {
10107
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10108
+ };
10109
+ };
10110
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10111
+ 403: {
10112
+ headers: {
10113
+ [name: string]: unknown;
10114
+ };
10115
+ content: {
10116
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10117
+ };
10118
+ };
10119
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10120
+ 404: {
10121
+ headers: {
10122
+ [name: string]: unknown;
10123
+ };
10124
+ content: {
10125
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10126
+ };
10127
+ };
10128
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10129
+ 429: {
10130
+ headers: {
10131
+ [name: string]: unknown;
10132
+ };
10133
+ content: {
10134
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10135
+ };
10136
+ };
10137
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10138
+ 500: {
10139
+ headers: {
10140
+ [name: string]: unknown;
10141
+ };
10142
+ content: {
10143
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10144
+ };
10145
+ };
10146
+ };
10147
+ };
10148
+ admin_stores_delivery_exclusions_create: {
10149
+ parameters: {
10150
+ query?: never;
10151
+ header?: {
10152
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10153
+ "X-Sous-Company-Id"?: number;
10154
+ };
10155
+ path: {
10156
+ store_public_id: string;
10157
+ };
10158
+ cookie?: never;
10159
+ };
10160
+ requestBody: {
10161
+ content: {
10162
+ "application/json": components["schemas"]["DeliveryExclusion"];
10163
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryExclusion"];
10164
+ "multipart/form-data": components["schemas"]["DeliveryExclusion"];
10165
+ };
10166
+ };
10167
+ responses: {
10168
+ 201: {
10169
+ headers: {
10170
+ [name: string]: unknown;
10171
+ };
10172
+ content: {
10173
+ "application/json": components["schemas"]["DeliveryExclusion"];
10174
+ };
10175
+ };
10176
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10177
+ 400: {
10178
+ headers: {
10179
+ [name: string]: unknown;
10180
+ };
10181
+ content: {
10182
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10183
+ };
10184
+ };
10185
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10186
+ 401: {
10187
+ headers: {
10188
+ [name: string]: unknown;
10189
+ };
10190
+ content: {
10191
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10192
+ };
10193
+ };
10194
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10195
+ 403: {
10196
+ headers: {
10197
+ [name: string]: unknown;
10198
+ };
10199
+ content: {
10200
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10201
+ };
10202
+ };
10203
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10204
+ 404: {
10205
+ headers: {
10206
+ [name: string]: unknown;
10207
+ };
10208
+ content: {
10209
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10210
+ };
10211
+ };
10212
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10213
+ 429: {
10214
+ headers: {
10215
+ [name: string]: unknown;
10216
+ };
10217
+ content: {
10218
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10219
+ };
10220
+ };
10221
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10222
+ 500: {
10223
+ headers: {
10224
+ [name: string]: unknown;
10225
+ };
10226
+ content: {
10227
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10228
+ };
10229
+ };
10230
+ };
10231
+ };
10232
+ admin_stores_delivery_exclusions_destroy: {
10233
+ parameters: {
10234
+ query?: never;
10235
+ header?: {
10236
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10237
+ "X-Sous-Company-Id"?: number;
10238
+ };
10239
+ path: {
10240
+ shape_id: string;
10241
+ store_public_id: string;
10242
+ };
10243
+ cookie?: never;
10244
+ };
10245
+ requestBody?: never;
10246
+ responses: {
10247
+ /** @description No response body */
10248
+ 204: {
10249
+ headers: {
10250
+ [name: string]: unknown;
10251
+ };
10252
+ content?: never;
10253
+ };
10254
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10255
+ 400: {
10256
+ headers: {
10257
+ [name: string]: unknown;
10258
+ };
10259
+ content: {
10260
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10261
+ };
10262
+ };
10263
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10264
+ 401: {
10265
+ headers: {
10266
+ [name: string]: unknown;
10267
+ };
10268
+ content: {
10269
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10270
+ };
10271
+ };
10272
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10273
+ 403: {
10274
+ headers: {
10275
+ [name: string]: unknown;
10276
+ };
10277
+ content: {
10278
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10279
+ };
10280
+ };
10281
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10282
+ 404: {
10283
+ headers: {
10284
+ [name: string]: unknown;
10285
+ };
10286
+ content: {
10287
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10288
+ };
10289
+ };
10290
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10291
+ 429: {
10292
+ headers: {
10293
+ [name: string]: unknown;
10294
+ };
10295
+ content: {
10296
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10297
+ };
10298
+ };
10299
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10300
+ 500: {
10301
+ headers: {
10302
+ [name: string]: unknown;
10303
+ };
10304
+ content: {
10305
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10306
+ };
10307
+ };
10308
+ };
10309
+ };
10310
+ admin_stores_delivery_exclusions_partial_update: {
10311
+ parameters: {
10312
+ query?: never;
10313
+ header?: {
10314
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10315
+ "X-Sous-Company-Id"?: number;
10316
+ };
10317
+ path: {
10318
+ shape_id: string;
10319
+ store_public_id: string;
10320
+ };
10321
+ cookie?: never;
10322
+ };
10323
+ requestBody?: {
10324
+ content: {
10325
+ "application/json": components["schemas"]["PatchedDeliveryExclusionUpdate"];
10326
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryExclusionUpdate"];
10327
+ "multipart/form-data": components["schemas"]["PatchedDeliveryExclusionUpdate"];
10328
+ };
10329
+ };
10330
+ responses: {
10331
+ 200: {
10332
+ headers: {
10333
+ [name: string]: unknown;
10334
+ };
10335
+ content: {
10336
+ "application/json": components["schemas"]["DeliveryExclusion"];
10337
+ };
10338
+ };
10339
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10340
+ 400: {
10341
+ headers: {
10342
+ [name: string]: unknown;
10343
+ };
10344
+ content: {
10345
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10346
+ };
10347
+ };
10348
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10349
+ 401: {
10350
+ headers: {
10351
+ [name: string]: unknown;
10352
+ };
10353
+ content: {
10354
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10355
+ };
10356
+ };
10357
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10358
+ 403: {
10359
+ headers: {
10360
+ [name: string]: unknown;
10361
+ };
10362
+ content: {
10363
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10364
+ };
10365
+ };
10366
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10367
+ 404: {
10368
+ headers: {
10369
+ [name: string]: unknown;
10370
+ };
10371
+ content: {
10372
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10373
+ };
10374
+ };
10375
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10376
+ 429: {
10377
+ headers: {
10378
+ [name: string]: unknown;
10379
+ };
10380
+ content: {
10381
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10382
+ };
10383
+ };
10384
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10385
+ 500: {
10386
+ headers: {
10387
+ [name: string]: unknown;
10388
+ };
10389
+ content: {
10390
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10391
+ };
10392
+ };
10393
+ };
10394
+ };
10395
+ admin_stores_delivery_fee_retrieve: {
10396
+ parameters: {
10397
+ query?: never;
10398
+ header?: {
10399
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10400
+ "X-Sous-Company-Id"?: number;
10401
+ };
10402
+ path: {
10403
+ store_public_id: string;
10404
+ };
10405
+ cookie?: never;
10406
+ };
10407
+ requestBody?: never;
10408
+ responses: {
10409
+ 200: {
10410
+ headers: {
10411
+ [name: string]: unknown;
10412
+ };
10413
+ content: {
10414
+ "application/json": components["schemas"]["DeliveryFee"];
10415
+ };
10416
+ };
10417
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10418
+ 400: {
10419
+ headers: {
10420
+ [name: string]: unknown;
10421
+ };
10422
+ content: {
10423
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10424
+ };
10425
+ };
10426
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10427
+ 401: {
10428
+ headers: {
10429
+ [name: string]: unknown;
10430
+ };
10431
+ content: {
10432
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10433
+ };
10434
+ };
10435
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10436
+ 403: {
10437
+ headers: {
10438
+ [name: string]: unknown;
10439
+ };
10440
+ content: {
10441
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10442
+ };
10443
+ };
10444
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10445
+ 404: {
10446
+ headers: {
10447
+ [name: string]: unknown;
10448
+ };
10449
+ content: {
10450
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10451
+ };
10452
+ };
10453
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10454
+ 429: {
10455
+ headers: {
10456
+ [name: string]: unknown;
10457
+ };
10458
+ content: {
10459
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10460
+ };
10461
+ };
10462
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10463
+ 500: {
10464
+ headers: {
10465
+ [name: string]: unknown;
10466
+ };
10467
+ content: {
10468
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10469
+ };
10470
+ };
10471
+ };
10472
+ };
10473
+ admin_stores_delivery_fee_update: {
10474
+ parameters: {
10475
+ query?: never;
10476
+ header?: {
10477
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10478
+ "X-Sous-Company-Id"?: number;
10479
+ };
10480
+ path: {
10481
+ store_public_id: string;
10482
+ };
10483
+ cookie?: never;
10484
+ };
10485
+ requestBody: {
10486
+ content: {
10487
+ "application/json": components["schemas"]["DeliveryFee"];
10488
+ "application/x-www-form-urlencoded": components["schemas"]["DeliveryFee"];
10489
+ "multipart/form-data": components["schemas"]["DeliveryFee"];
10490
+ };
10491
+ };
10492
+ responses: {
10493
+ 200: {
10494
+ headers: {
10495
+ [name: string]: unknown;
10496
+ };
10497
+ content: {
10498
+ "application/json": components["schemas"]["DeliveryFee"];
10499
+ };
10500
+ };
10501
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10502
+ 400: {
10503
+ headers: {
10504
+ [name: string]: unknown;
10505
+ };
10506
+ content: {
10507
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10508
+ };
10509
+ };
10510
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10511
+ 401: {
10512
+ headers: {
10513
+ [name: string]: unknown;
10514
+ };
10515
+ content: {
10516
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10517
+ };
10518
+ };
10519
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10520
+ 403: {
10521
+ headers: {
10522
+ [name: string]: unknown;
10523
+ };
10524
+ content: {
10525
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10526
+ };
10527
+ };
10528
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10529
+ 404: {
10530
+ headers: {
10531
+ [name: string]: unknown;
10532
+ };
10533
+ content: {
10534
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10535
+ };
10536
+ };
10537
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10538
+ 429: {
10539
+ headers: {
10540
+ [name: string]: unknown;
10541
+ };
10542
+ content: {
10543
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10544
+ };
10545
+ };
10546
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10547
+ 500: {
10548
+ headers: {
10549
+ [name: string]: unknown;
10550
+ };
10551
+ content: {
10552
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10553
+ };
10554
+ };
10555
+ };
10556
+ };
10557
+ admin_stores_delivery_fee_split_retrieve: {
10558
+ parameters: {
10559
+ query?: never;
10560
+ header?: {
10561
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10562
+ "X-Sous-Company-Id"?: number;
10563
+ };
10564
+ path: {
10565
+ store_public_id: string;
10566
+ };
10567
+ cookie?: never;
10568
+ };
10569
+ requestBody?: never;
10570
+ responses: {
10571
+ 200: {
10572
+ headers: {
10573
+ [name: string]: unknown;
10574
+ };
10575
+ content: {
10576
+ "application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
10577
+ };
10578
+ };
10579
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10580
+ 400: {
10581
+ headers: {
10582
+ [name: string]: unknown;
10583
+ };
10584
+ content: {
10585
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10586
+ };
10587
+ };
10588
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10589
+ 401: {
10590
+ headers: {
10591
+ [name: string]: unknown;
10592
+ };
10593
+ content: {
10594
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10595
+ };
10596
+ };
10597
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10598
+ 403: {
10599
+ headers: {
10600
+ [name: string]: unknown;
10601
+ };
10602
+ content: {
10603
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10604
+ };
10605
+ };
10606
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10607
+ 404: {
10608
+ headers: {
10609
+ [name: string]: unknown;
10610
+ };
10611
+ content: {
10612
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10613
+ };
10614
+ };
10615
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10616
+ 429: {
10617
+ headers: {
10618
+ [name: string]: unknown;
10619
+ };
10620
+ content: {
10621
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10622
+ };
10623
+ };
10624
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10625
+ 500: {
10626
+ headers: {
10627
+ [name: string]: unknown;
10628
+ };
10629
+ content: {
10630
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10631
+ };
10632
+ };
10633
+ };
10634
+ };
10635
+ admin_stores_delivery_fee_split_partial_update: {
10636
+ parameters: {
10637
+ query?: never;
10638
+ header?: {
10639
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
10640
+ "X-Sous-Company-Id"?: number;
10641
+ };
10642
+ path: {
10643
+ store_public_id: string;
10644
+ };
10645
+ cookie?: never;
10646
+ };
10647
+ requestBody?: {
10648
+ content: {
10649
+ "application/json": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
10650
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
10651
+ "multipart/form-data": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
10652
+ };
10653
+ };
10654
+ responses: {
10655
+ 200: {
10656
+ headers: {
10657
+ [name: string]: unknown;
10658
+ };
10659
+ content: {
10660
+ "application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
10661
+ };
10662
+ };
10663
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10664
+ 400: {
10665
+ headers: {
10666
+ [name: string]: unknown;
10667
+ };
10668
+ content: {
10669
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10670
+ };
10671
+ };
10672
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
10673
+ 401: {
10674
+ headers: {
10675
+ [name: string]: unknown;
10676
+ };
10677
+ content: {
10678
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10679
+ };
10680
+ };
10681
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
10682
+ 403: {
10683
+ headers: {
10684
+ [name: string]: unknown;
10685
+ };
10686
+ content: {
10687
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10688
+ };
10689
+ };
10690
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
10691
+ 404: {
10692
+ headers: {
10693
+ [name: string]: unknown;
10694
+ };
10695
+ content: {
10696
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10697
+ };
10698
+ };
10699
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
10700
+ 429: {
10701
+ headers: {
10702
+ [name: string]: unknown;
10703
+ };
10704
+ content: {
10705
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10706
+ };
10707
+ };
10708
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
10709
+ 500: {
10710
+ headers: {
10711
+ [name: string]: unknown;
10712
+ };
10713
+ content: {
10714
+ "application/json": components["schemas"]["APIErrorEnvelope"];
10715
+ };
10716
+ };
10717
+ };
10718
+ };
9135
10719
  admin_stores_locations_delivery_methods_list: {
9136
10720
  parameters: {
9137
10721
  query?: never;