@poweredbysous/storefront-admin-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.
- package/dist/index.d.cts +2060 -12
- package/dist/index.d.ts +2060 -12
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -90,6 +90,46 @@ interface paths {
|
|
|
90
90
|
patch?: never;
|
|
91
91
|
trace?: never;
|
|
92
92
|
};
|
|
93
|
+
"/api/v1/admin/delivery-methods/": {
|
|
94
|
+
parameters: {
|
|
95
|
+
query?: never;
|
|
96
|
+
header?: never;
|
|
97
|
+
path?: never;
|
|
98
|
+
cookie?: never;
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* List the company's delivery-method availability
|
|
102
|
+
* @description ``GET /api/v1/admin/delivery-methods/`` — every method's company availability.
|
|
103
|
+
*/
|
|
104
|
+
get: operations["admin_delivery_methods_list"];
|
|
105
|
+
put?: never;
|
|
106
|
+
post?: never;
|
|
107
|
+
delete?: never;
|
|
108
|
+
options?: never;
|
|
109
|
+
head?: never;
|
|
110
|
+
patch?: never;
|
|
111
|
+
trace?: never;
|
|
112
|
+
};
|
|
113
|
+
"/api/v1/admin/delivery-methods/{method}/": {
|
|
114
|
+
parameters: {
|
|
115
|
+
query?: never;
|
|
116
|
+
header?: never;
|
|
117
|
+
path?: never;
|
|
118
|
+
cookie?: never;
|
|
119
|
+
};
|
|
120
|
+
get?: never;
|
|
121
|
+
put?: never;
|
|
122
|
+
post?: never;
|
|
123
|
+
delete?: never;
|
|
124
|
+
options?: never;
|
|
125
|
+
head?: never;
|
|
126
|
+
/**
|
|
127
|
+
* Set the company's availability for one delivery method
|
|
128
|
+
* @description ``PATCH /api/v1/admin/delivery-methods/<method>/`` — the owner's switch.
|
|
129
|
+
*/
|
|
130
|
+
patch: operations["admin_delivery_methods_partial_update"];
|
|
131
|
+
trace?: never;
|
|
132
|
+
};
|
|
93
133
|
"/api/v1/admin/discounts/": {
|
|
94
134
|
parameters: {
|
|
95
135
|
query?: never;
|
|
@@ -281,6 +321,38 @@ interface paths {
|
|
|
281
321
|
patch: operations["admin_discounts_partial_update"];
|
|
282
322
|
trace?: never;
|
|
283
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
|
+
};
|
|
284
356
|
"/api/v1/admin/pages/": {
|
|
285
357
|
parameters: {
|
|
286
358
|
query?: never;
|
|
@@ -799,6 +871,50 @@ interface paths {
|
|
|
799
871
|
patch?: never;
|
|
800
872
|
trace?: never;
|
|
801
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
|
+
};
|
|
802
918
|
"/api/v1/admin/stores/{store_public_id}/compliance-defaults/": {
|
|
803
919
|
parameters: {
|
|
804
920
|
query?: never;
|
|
@@ -860,6 +976,194 @@ interface paths {
|
|
|
860
976
|
patch?: never;
|
|
861
977
|
trace?: never;
|
|
862
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
|
+
};
|
|
1117
|
+
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
|
|
1118
|
+
parameters: {
|
|
1119
|
+
query?: never;
|
|
1120
|
+
header?: never;
|
|
1121
|
+
path?: never;
|
|
1122
|
+
cookie?: never;
|
|
1123
|
+
};
|
|
1124
|
+
/**
|
|
1125
|
+
* List a Location's delivery-method config
|
|
1126
|
+
* @description ``GET .../stores/<store_public_id>/locations/<location_public_id>/
|
|
1127
|
+
* delivery-methods/``.
|
|
1128
|
+
*
|
|
1129
|
+
* Config for methods the company has made available, for one Location.
|
|
1130
|
+
* A method the company hasn't switched on at all is omitted entirely, not
|
|
1131
|
+
* returned disabled — "hidden, not greyed out": a Location cannot see, let
|
|
1132
|
+
* alone enable, something its company hasn't agreed to.
|
|
1133
|
+
*/
|
|
1134
|
+
get: operations["admin_stores_locations_delivery_methods_list"];
|
|
1135
|
+
put?: never;
|
|
1136
|
+
post?: never;
|
|
1137
|
+
delete?: never;
|
|
1138
|
+
options?: never;
|
|
1139
|
+
head?: never;
|
|
1140
|
+
patch?: never;
|
|
1141
|
+
trace?: never;
|
|
1142
|
+
};
|
|
1143
|
+
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/{method}/": {
|
|
1144
|
+
parameters: {
|
|
1145
|
+
query?: never;
|
|
1146
|
+
header?: never;
|
|
1147
|
+
path?: never;
|
|
1148
|
+
cookie?: never;
|
|
1149
|
+
};
|
|
1150
|
+
get?: never;
|
|
1151
|
+
put?: never;
|
|
1152
|
+
post?: never;
|
|
1153
|
+
delete?: never;
|
|
1154
|
+
options?: never;
|
|
1155
|
+
head?: never;
|
|
1156
|
+
/**
|
|
1157
|
+
* Set a Location's switch/config for one delivery method
|
|
1158
|
+
* @description ``PATCH .../stores/<store_public_id>/locations/<location_public_id>/
|
|
1159
|
+
* delivery-methods/<method>/``.
|
|
1160
|
+
*
|
|
1161
|
+
* One Location's own switch and/or its retained config. At least one of
|
|
1162
|
+
* ``is_enabled`` or a config field is required; either can be sent alone.
|
|
1163
|
+
*/
|
|
1164
|
+
patch: operations["admin_stores_locations_delivery_methods_partial_update"];
|
|
1165
|
+
trace?: never;
|
|
1166
|
+
};
|
|
863
1167
|
"/api/v1/admin/stores/{store_public_id}/surcharges/": {
|
|
864
1168
|
parameters: {
|
|
865
1169
|
query?: never;
|
|
@@ -3039,6 +3343,21 @@ interface components {
|
|
|
3039
3343
|
*/
|
|
3040
3344
|
reusable_deposit_id?: number | null;
|
|
3041
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
|
+
};
|
|
3042
3361
|
/**
|
|
3043
3362
|
* @description Per-store fulfilment capability for the merchant offers UI.
|
|
3044
3363
|
*
|
|
@@ -3085,6 +3404,23 @@ interface components {
|
|
|
3085
3404
|
slug: string;
|
|
3086
3405
|
position?: number;
|
|
3087
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
|
+
};
|
|
3088
3424
|
/**
|
|
3089
3425
|
* @description * `free` - Free
|
|
3090
3426
|
* * `percentage` - Percentage Off
|
|
@@ -3247,6 +3583,13 @@ interface components {
|
|
|
3247
3583
|
* @enum {string}
|
|
3248
3584
|
*/
|
|
3249
3585
|
ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
|
|
3586
|
+
/** @description One row of the company availability list: a method and its on/off state. */
|
|
3587
|
+
CompanyDeliveryMethodAvailability: {
|
|
3588
|
+
method: components["schemas"]["MethodEnum"];
|
|
3589
|
+
is_available: boolean;
|
|
3590
|
+
/** Format: date-time */
|
|
3591
|
+
updated_at: string | null;
|
|
3592
|
+
};
|
|
3250
3593
|
ComplianceChoice: {
|
|
3251
3594
|
slug: string;
|
|
3252
3595
|
label: string;
|
|
@@ -3404,6 +3747,64 @@ interface components {
|
|
|
3404
3747
|
/** @default */
|
|
3405
3748
|
description: string;
|
|
3406
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
|
+
};
|
|
3407
3808
|
/**
|
|
3408
3809
|
* @description Merchant-facing CRUD serializer for :class:`Discount`.
|
|
3409
3810
|
*
|
|
@@ -3622,6 +4023,11 @@ interface components {
|
|
|
3622
4023
|
* @enum {string}
|
|
3623
4024
|
*/
|
|
3624
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
|
+
};
|
|
3625
4031
|
/**
|
|
3626
4032
|
* @description * `single` - Single location
|
|
3627
4033
|
* * `subset` - Subset of locations
|
|
@@ -3761,6 +4167,20 @@ interface components {
|
|
|
3761
4167
|
* @enum {string}
|
|
3762
4168
|
*/
|
|
3763
4169
|
MessageStatusEnum: "draft" | "active" | "paused" | "archived";
|
|
4170
|
+
/**
|
|
4171
|
+
* @description * `own_delivery` - Own Delivery
|
|
4172
|
+
* * `uber_direct` - Uber Direct
|
|
4173
|
+
* * `lieferando` - Lieferando
|
|
4174
|
+
* @enum {string}
|
|
4175
|
+
*/
|
|
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";
|
|
3764
4184
|
ModifyLineItem: {
|
|
3765
4185
|
/** Format: uuid */
|
|
3766
4186
|
order_line_item_id: string;
|
|
@@ -3792,7 +4212,7 @@ interface components {
|
|
|
3792
4212
|
order_number: string;
|
|
3793
4213
|
/**
|
|
3794
4214
|
* Format: int64
|
|
3795
|
-
* @description
|
|
4215
|
+
* @description Store.id from the authenticated merchant
|
|
3796
4216
|
*/
|
|
3797
4217
|
store_id: number;
|
|
3798
4218
|
/**
|
|
@@ -4374,6 +4794,21 @@ interface components {
|
|
|
4374
4794
|
*/
|
|
4375
4795
|
reusable_deposit_id?: number | null;
|
|
4376
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
|
+
};
|
|
4377
4812
|
PatchedBusinessAccountMemberUpdate: {
|
|
4378
4813
|
name?: string;
|
|
4379
4814
|
/** Format: decimal */
|
|
@@ -4409,6 +4844,20 @@ interface components {
|
|
|
4409
4844
|
/** @default */
|
|
4410
4845
|
description: string;
|
|
4411
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
|
+
};
|
|
4412
4861
|
/**
|
|
4413
4862
|
* @description Merchant-facing CRUD serializer for :class:`Discount`.
|
|
4414
4863
|
*
|
|
@@ -4575,11 +5024,35 @@ interface components {
|
|
|
4575
5024
|
/** Format: date-time */
|
|
4576
5025
|
readonly updated_at?: string;
|
|
4577
5026
|
};
|
|
4578
|
-
|
|
4579
|
-
|
|
4580
|
-
|
|
4581
|
-
|
|
4582
|
-
|
|
5027
|
+
/** @description PATCH body for the company owner's availability switch. */
|
|
5028
|
+
PatchedSetCompanyAvailability: {
|
|
5029
|
+
is_available?: boolean;
|
|
5030
|
+
};
|
|
5031
|
+
/**
|
|
5032
|
+
* @description PATCH body for a store's delivery-method row.
|
|
5033
|
+
*
|
|
5034
|
+
* ``is_enabled`` and the retained config fields are all optional so a
|
|
5035
|
+
* caller can flip the switch alone, without resending config it isn't
|
|
5036
|
+
* changing — but at least one field must be present.
|
|
5037
|
+
*/
|
|
5038
|
+
PatchedSetStoreDeliveryMethod: {
|
|
5039
|
+
is_enabled?: boolean;
|
|
5040
|
+
delivery_area?: unknown;
|
|
5041
|
+
/** Format: decimal */
|
|
5042
|
+
base_fee?: string | null;
|
|
5043
|
+
/** Format: decimal */
|
|
5044
|
+
fee_split_percentage?: string | null;
|
|
5045
|
+
schedule?: unknown;
|
|
5046
|
+
lead_time_minutes?: number | null;
|
|
5047
|
+
cutoff_mode?: components["schemas"]["CutoffModeEnum"];
|
|
5048
|
+
cutoff_minutes?: number | null;
|
|
5049
|
+
cutoff_by_day?: unknown;
|
|
5050
|
+
};
|
|
5051
|
+
PatchedSurcharge: {
|
|
5052
|
+
readonly id?: number;
|
|
5053
|
+
/** @description Internal name (e.g. 'SUP Fee') */
|
|
5054
|
+
name?: string;
|
|
5055
|
+
/** @description Customer-facing label (e.g. 'Single-use plastic surcharge') */
|
|
4583
5056
|
label?: string;
|
|
4584
5057
|
/**
|
|
4585
5058
|
* Format: decimal
|
|
@@ -5226,6 +5699,34 @@ interface components {
|
|
|
5226
5699
|
readonly offers_reusable_packaging: boolean;
|
|
5227
5700
|
readonly reusable_deposit_amount?: string | null;
|
|
5228
5701
|
};
|
|
5702
|
+
/** @description One row of the store config list: a method's switch plus retained config. */
|
|
5703
|
+
StoreDeliveryMethodConfig: {
|
|
5704
|
+
method: components["schemas"]["MethodEnum"];
|
|
5705
|
+
is_enabled: boolean;
|
|
5706
|
+
delivery_area: unknown;
|
|
5707
|
+
/** Format: decimal */
|
|
5708
|
+
base_fee: string | null;
|
|
5709
|
+
/** Format: decimal */
|
|
5710
|
+
fee_split_percentage: string | null;
|
|
5711
|
+
schedule: unknown;
|
|
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;
|
|
5720
|
+
/** Format: date-time */
|
|
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"][];
|
|
5729
|
+
};
|
|
5229
5730
|
StoreMeResponse: {
|
|
5230
5731
|
id: number;
|
|
5231
5732
|
public_id: string;
|
|
@@ -5518,6 +6019,13 @@ interface components {
|
|
|
5518
6019
|
order_line_item_id: string;
|
|
5519
6020
|
quantity?: number;
|
|
5520
6021
|
};
|
|
6022
|
+
/** @description A point, as ``MerchantShippingProvider`` stores it. */
|
|
6023
|
+
_Origin: {
|
|
6024
|
+
/** Format: decimal */
|
|
6025
|
+
latitude: string;
|
|
6026
|
+
/** Format: decimal */
|
|
6027
|
+
longitude: string;
|
|
6028
|
+
};
|
|
5521
6029
|
/** @description A product a promotion grants as its benefit (id + translated name). */
|
|
5522
6030
|
_PromotionBenefitProduct: {
|
|
5523
6031
|
id: number;
|
|
@@ -5974,6 +6482,166 @@ interface operations {
|
|
|
5974
6482
|
};
|
|
5975
6483
|
};
|
|
5976
6484
|
};
|
|
6485
|
+
admin_delivery_methods_list: {
|
|
6486
|
+
parameters: {
|
|
6487
|
+
query?: never;
|
|
6488
|
+
header?: {
|
|
6489
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
6490
|
+
"X-Sous-Company-Id"?: number;
|
|
6491
|
+
};
|
|
6492
|
+
path?: never;
|
|
6493
|
+
cookie?: never;
|
|
6494
|
+
};
|
|
6495
|
+
requestBody?: never;
|
|
6496
|
+
responses: {
|
|
6497
|
+
200: {
|
|
6498
|
+
headers: {
|
|
6499
|
+
[name: string]: unknown;
|
|
6500
|
+
};
|
|
6501
|
+
content: {
|
|
6502
|
+
"application/json": components["schemas"]["CompanyDeliveryMethodAvailability"][];
|
|
6503
|
+
};
|
|
6504
|
+
};
|
|
6505
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6506
|
+
400: {
|
|
6507
|
+
headers: {
|
|
6508
|
+
[name: string]: unknown;
|
|
6509
|
+
};
|
|
6510
|
+
content: {
|
|
6511
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6512
|
+
};
|
|
6513
|
+
};
|
|
6514
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6515
|
+
401: {
|
|
6516
|
+
headers: {
|
|
6517
|
+
[name: string]: unknown;
|
|
6518
|
+
};
|
|
6519
|
+
content: {
|
|
6520
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6521
|
+
};
|
|
6522
|
+
};
|
|
6523
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6524
|
+
403: {
|
|
6525
|
+
headers: {
|
|
6526
|
+
[name: string]: unknown;
|
|
6527
|
+
};
|
|
6528
|
+
content: {
|
|
6529
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6530
|
+
};
|
|
6531
|
+
};
|
|
6532
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6533
|
+
404: {
|
|
6534
|
+
headers: {
|
|
6535
|
+
[name: string]: unknown;
|
|
6536
|
+
};
|
|
6537
|
+
content: {
|
|
6538
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6539
|
+
};
|
|
6540
|
+
};
|
|
6541
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6542
|
+
429: {
|
|
6543
|
+
headers: {
|
|
6544
|
+
[name: string]: unknown;
|
|
6545
|
+
};
|
|
6546
|
+
content: {
|
|
6547
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6548
|
+
};
|
|
6549
|
+
};
|
|
6550
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6551
|
+
500: {
|
|
6552
|
+
headers: {
|
|
6553
|
+
[name: string]: unknown;
|
|
6554
|
+
};
|
|
6555
|
+
content: {
|
|
6556
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6557
|
+
};
|
|
6558
|
+
};
|
|
6559
|
+
};
|
|
6560
|
+
};
|
|
6561
|
+
admin_delivery_methods_partial_update: {
|
|
6562
|
+
parameters: {
|
|
6563
|
+
query?: never;
|
|
6564
|
+
header?: {
|
|
6565
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
6566
|
+
"X-Sous-Company-Id"?: number;
|
|
6567
|
+
};
|
|
6568
|
+
path: {
|
|
6569
|
+
method: string;
|
|
6570
|
+
};
|
|
6571
|
+
cookie?: never;
|
|
6572
|
+
};
|
|
6573
|
+
requestBody?: {
|
|
6574
|
+
content: {
|
|
6575
|
+
"application/json": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
6576
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
6577
|
+
"multipart/form-data": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
6578
|
+
};
|
|
6579
|
+
};
|
|
6580
|
+
responses: {
|
|
6581
|
+
200: {
|
|
6582
|
+
headers: {
|
|
6583
|
+
[name: string]: unknown;
|
|
6584
|
+
};
|
|
6585
|
+
content: {
|
|
6586
|
+
"application/json": components["schemas"]["CompanyDeliveryMethodAvailability"];
|
|
6587
|
+
};
|
|
6588
|
+
};
|
|
6589
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6590
|
+
400: {
|
|
6591
|
+
headers: {
|
|
6592
|
+
[name: string]: unknown;
|
|
6593
|
+
};
|
|
6594
|
+
content: {
|
|
6595
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6596
|
+
};
|
|
6597
|
+
};
|
|
6598
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6599
|
+
401: {
|
|
6600
|
+
headers: {
|
|
6601
|
+
[name: string]: unknown;
|
|
6602
|
+
};
|
|
6603
|
+
content: {
|
|
6604
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6605
|
+
};
|
|
6606
|
+
};
|
|
6607
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6608
|
+
403: {
|
|
6609
|
+
headers: {
|
|
6610
|
+
[name: string]: unknown;
|
|
6611
|
+
};
|
|
6612
|
+
content: {
|
|
6613
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6614
|
+
};
|
|
6615
|
+
};
|
|
6616
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6617
|
+
404: {
|
|
6618
|
+
headers: {
|
|
6619
|
+
[name: string]: unknown;
|
|
6620
|
+
};
|
|
6621
|
+
content: {
|
|
6622
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6623
|
+
};
|
|
6624
|
+
};
|
|
6625
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6626
|
+
429: {
|
|
6627
|
+
headers: {
|
|
6628
|
+
[name: string]: unknown;
|
|
6629
|
+
};
|
|
6630
|
+
content: {
|
|
6631
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6632
|
+
};
|
|
6633
|
+
};
|
|
6634
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6635
|
+
500: {
|
|
6636
|
+
headers: {
|
|
6637
|
+
[name: string]: unknown;
|
|
6638
|
+
};
|
|
6639
|
+
content: {
|
|
6640
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
6641
|
+
};
|
|
6642
|
+
};
|
|
6643
|
+
};
|
|
6644
|
+
};
|
|
5977
6645
|
admin_discounts_list: {
|
|
5978
6646
|
parameters: {
|
|
5979
6647
|
query?: {
|
|
@@ -6462,6 +7130,85 @@ interface operations {
|
|
|
6462
7130
|
};
|
|
6463
7131
|
};
|
|
6464
7132
|
};
|
|
7133
|
+
admin_locations_delivery_methods_list: {
|
|
7134
|
+
parameters: {
|
|
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;
|
|
7142
|
+
};
|
|
7143
|
+
path?: never;
|
|
7144
|
+
cookie?: never;
|
|
7145
|
+
};
|
|
7146
|
+
requestBody?: never;
|
|
7147
|
+
responses: {
|
|
7148
|
+
200: {
|
|
7149
|
+
headers: {
|
|
7150
|
+
[name: string]: unknown;
|
|
7151
|
+
};
|
|
7152
|
+
content: {
|
|
7153
|
+
"application/json": components["schemas"]["LocationDeliveryMethodSummary"][];
|
|
7154
|
+
};
|
|
7155
|
+
};
|
|
7156
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7157
|
+
400: {
|
|
7158
|
+
headers: {
|
|
7159
|
+
[name: string]: unknown;
|
|
7160
|
+
};
|
|
7161
|
+
content: {
|
|
7162
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7163
|
+
};
|
|
7164
|
+
};
|
|
7165
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7166
|
+
401: {
|
|
7167
|
+
headers: {
|
|
7168
|
+
[name: string]: unknown;
|
|
7169
|
+
};
|
|
7170
|
+
content: {
|
|
7171
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7172
|
+
};
|
|
7173
|
+
};
|
|
7174
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7175
|
+
403: {
|
|
7176
|
+
headers: {
|
|
7177
|
+
[name: string]: unknown;
|
|
7178
|
+
};
|
|
7179
|
+
content: {
|
|
7180
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7181
|
+
};
|
|
7182
|
+
};
|
|
7183
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7184
|
+
404: {
|
|
7185
|
+
headers: {
|
|
7186
|
+
[name: string]: unknown;
|
|
7187
|
+
};
|
|
7188
|
+
content: {
|
|
7189
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7190
|
+
};
|
|
7191
|
+
};
|
|
7192
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7193
|
+
429: {
|
|
7194
|
+
headers: {
|
|
7195
|
+
[name: string]: unknown;
|
|
7196
|
+
};
|
|
7197
|
+
content: {
|
|
7198
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7199
|
+
};
|
|
7200
|
+
};
|
|
7201
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7202
|
+
500: {
|
|
7203
|
+
headers: {
|
|
7204
|
+
[name: string]: unknown;
|
|
7205
|
+
};
|
|
7206
|
+
content: {
|
|
7207
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7208
|
+
};
|
|
7209
|
+
};
|
|
7210
|
+
};
|
|
7211
|
+
};
|
|
6465
7212
|
admin_pages_list: {
|
|
6466
7213
|
parameters: {
|
|
6467
7214
|
query?: {
|
|
@@ -8588,7 +9335,7 @@ interface operations {
|
|
|
8588
9335
|
};
|
|
8589
9336
|
};
|
|
8590
9337
|
};
|
|
8591
|
-
|
|
9338
|
+
admin_stores_base_coverage_retrieve: {
|
|
8592
9339
|
parameters: {
|
|
8593
9340
|
query?: never;
|
|
8594
9341
|
header?: {
|
|
@@ -8607,7 +9354,7 @@ interface operations {
|
|
|
8607
9354
|
[name: string]: unknown;
|
|
8608
9355
|
};
|
|
8609
9356
|
content: {
|
|
8610
|
-
"application/json": components["schemas"]["
|
|
9357
|
+
"application/json": components["schemas"]["BaseCoverage"];
|
|
8611
9358
|
};
|
|
8612
9359
|
};
|
|
8613
9360
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -8666,7 +9413,7 @@ interface operations {
|
|
|
8666
9413
|
};
|
|
8667
9414
|
};
|
|
8668
9415
|
};
|
|
8669
|
-
|
|
9416
|
+
admin_stores_base_coverage_update: {
|
|
8670
9417
|
parameters: {
|
|
8671
9418
|
query?: never;
|
|
8672
9419
|
header?: {
|
|
@@ -8678,10 +9425,172 @@ interface operations {
|
|
|
8678
9425
|
};
|
|
8679
9426
|
cookie?: never;
|
|
8680
9427
|
};
|
|
8681
|
-
requestBody
|
|
9428
|
+
requestBody: {
|
|
8682
9429
|
content: {
|
|
8683
|
-
"application/json": components["schemas"]["
|
|
8684
|
-
"application/x-www-form-urlencoded": components["schemas"]["
|
|
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
|
+
};
|
|
9500
|
+
admin_stores_compliance_defaults_retrieve: {
|
|
9501
|
+
parameters: {
|
|
9502
|
+
query?: never;
|
|
9503
|
+
header?: {
|
|
9504
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
9505
|
+
"X-Sous-Company-Id"?: number;
|
|
9506
|
+
};
|
|
9507
|
+
path: {
|
|
9508
|
+
store_public_id: string;
|
|
9509
|
+
};
|
|
9510
|
+
cookie?: never;
|
|
9511
|
+
};
|
|
9512
|
+
requestBody?: never;
|
|
9513
|
+
responses: {
|
|
9514
|
+
200: {
|
|
9515
|
+
headers: {
|
|
9516
|
+
[name: string]: unknown;
|
|
9517
|
+
};
|
|
9518
|
+
content: {
|
|
9519
|
+
"application/json": components["schemas"]["AdminStoreComplianceDefaults"];
|
|
9520
|
+
};
|
|
9521
|
+
};
|
|
9522
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9523
|
+
400: {
|
|
9524
|
+
headers: {
|
|
9525
|
+
[name: string]: unknown;
|
|
9526
|
+
};
|
|
9527
|
+
content: {
|
|
9528
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9529
|
+
};
|
|
9530
|
+
};
|
|
9531
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9532
|
+
401: {
|
|
9533
|
+
headers: {
|
|
9534
|
+
[name: string]: unknown;
|
|
9535
|
+
};
|
|
9536
|
+
content: {
|
|
9537
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9538
|
+
};
|
|
9539
|
+
};
|
|
9540
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9541
|
+
403: {
|
|
9542
|
+
headers: {
|
|
9543
|
+
[name: string]: unknown;
|
|
9544
|
+
};
|
|
9545
|
+
content: {
|
|
9546
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9547
|
+
};
|
|
9548
|
+
};
|
|
9549
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9550
|
+
404: {
|
|
9551
|
+
headers: {
|
|
9552
|
+
[name: string]: unknown;
|
|
9553
|
+
};
|
|
9554
|
+
content: {
|
|
9555
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9556
|
+
};
|
|
9557
|
+
};
|
|
9558
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9559
|
+
429: {
|
|
9560
|
+
headers: {
|
|
9561
|
+
[name: string]: unknown;
|
|
9562
|
+
};
|
|
9563
|
+
content: {
|
|
9564
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9565
|
+
};
|
|
9566
|
+
};
|
|
9567
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9568
|
+
500: {
|
|
9569
|
+
headers: {
|
|
9570
|
+
[name: string]: unknown;
|
|
9571
|
+
};
|
|
9572
|
+
content: {
|
|
9573
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9574
|
+
};
|
|
9575
|
+
};
|
|
9576
|
+
};
|
|
9577
|
+
};
|
|
9578
|
+
admin_stores_compliance_defaults_partial_update: {
|
|
9579
|
+
parameters: {
|
|
9580
|
+
query?: never;
|
|
9581
|
+
header?: {
|
|
9582
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
9583
|
+
"X-Sous-Company-Id"?: number;
|
|
9584
|
+
};
|
|
9585
|
+
path: {
|
|
9586
|
+
store_public_id: string;
|
|
9587
|
+
};
|
|
9588
|
+
cookie?: never;
|
|
9589
|
+
};
|
|
9590
|
+
requestBody?: {
|
|
9591
|
+
content: {
|
|
9592
|
+
"application/json": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
9593
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
8685
9594
|
"multipart/form-data": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
8686
9595
|
};
|
|
8687
9596
|
};
|
|
@@ -8833,6 +9742,1145 @@ interface operations {
|
|
|
8833
9742
|
};
|
|
8834
9743
|
};
|
|
8835
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
|
+
};
|
|
10719
|
+
admin_stores_locations_delivery_methods_list: {
|
|
10720
|
+
parameters: {
|
|
10721
|
+
query?: never;
|
|
10722
|
+
header?: {
|
|
10723
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
10724
|
+
"X-Sous-Company-Id"?: number;
|
|
10725
|
+
};
|
|
10726
|
+
path: {
|
|
10727
|
+
location_public_id: string;
|
|
10728
|
+
store_public_id: string;
|
|
10729
|
+
};
|
|
10730
|
+
cookie?: never;
|
|
10731
|
+
};
|
|
10732
|
+
requestBody?: never;
|
|
10733
|
+
responses: {
|
|
10734
|
+
200: {
|
|
10735
|
+
headers: {
|
|
10736
|
+
[name: string]: unknown;
|
|
10737
|
+
};
|
|
10738
|
+
content: {
|
|
10739
|
+
"application/json": components["schemas"]["StoreDeliveryMethodConfig"][];
|
|
10740
|
+
};
|
|
10741
|
+
};
|
|
10742
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10743
|
+
400: {
|
|
10744
|
+
headers: {
|
|
10745
|
+
[name: string]: unknown;
|
|
10746
|
+
};
|
|
10747
|
+
content: {
|
|
10748
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10749
|
+
};
|
|
10750
|
+
};
|
|
10751
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10752
|
+
401: {
|
|
10753
|
+
headers: {
|
|
10754
|
+
[name: string]: unknown;
|
|
10755
|
+
};
|
|
10756
|
+
content: {
|
|
10757
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10758
|
+
};
|
|
10759
|
+
};
|
|
10760
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10761
|
+
403: {
|
|
10762
|
+
headers: {
|
|
10763
|
+
[name: string]: unknown;
|
|
10764
|
+
};
|
|
10765
|
+
content: {
|
|
10766
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10767
|
+
};
|
|
10768
|
+
};
|
|
10769
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10770
|
+
404: {
|
|
10771
|
+
headers: {
|
|
10772
|
+
[name: string]: unknown;
|
|
10773
|
+
};
|
|
10774
|
+
content: {
|
|
10775
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10776
|
+
};
|
|
10777
|
+
};
|
|
10778
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10779
|
+
429: {
|
|
10780
|
+
headers: {
|
|
10781
|
+
[name: string]: unknown;
|
|
10782
|
+
};
|
|
10783
|
+
content: {
|
|
10784
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10785
|
+
};
|
|
10786
|
+
};
|
|
10787
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10788
|
+
500: {
|
|
10789
|
+
headers: {
|
|
10790
|
+
[name: string]: unknown;
|
|
10791
|
+
};
|
|
10792
|
+
content: {
|
|
10793
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10794
|
+
};
|
|
10795
|
+
};
|
|
10796
|
+
};
|
|
10797
|
+
};
|
|
10798
|
+
admin_stores_locations_delivery_methods_partial_update: {
|
|
10799
|
+
parameters: {
|
|
10800
|
+
query?: never;
|
|
10801
|
+
header?: {
|
|
10802
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
10803
|
+
"X-Sous-Company-Id"?: number;
|
|
10804
|
+
};
|
|
10805
|
+
path: {
|
|
10806
|
+
location_public_id: string;
|
|
10807
|
+
method: string;
|
|
10808
|
+
store_public_id: string;
|
|
10809
|
+
};
|
|
10810
|
+
cookie?: never;
|
|
10811
|
+
};
|
|
10812
|
+
requestBody?: {
|
|
10813
|
+
content: {
|
|
10814
|
+
"application/json": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
10815
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
10816
|
+
"multipart/form-data": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
10817
|
+
};
|
|
10818
|
+
};
|
|
10819
|
+
responses: {
|
|
10820
|
+
200: {
|
|
10821
|
+
headers: {
|
|
10822
|
+
[name: string]: unknown;
|
|
10823
|
+
};
|
|
10824
|
+
content: {
|
|
10825
|
+
"application/json": components["schemas"]["StoreDeliveryMethodConfig"];
|
|
10826
|
+
};
|
|
10827
|
+
};
|
|
10828
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10829
|
+
400: {
|
|
10830
|
+
headers: {
|
|
10831
|
+
[name: string]: unknown;
|
|
10832
|
+
};
|
|
10833
|
+
content: {
|
|
10834
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10835
|
+
};
|
|
10836
|
+
};
|
|
10837
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10838
|
+
401: {
|
|
10839
|
+
headers: {
|
|
10840
|
+
[name: string]: unknown;
|
|
10841
|
+
};
|
|
10842
|
+
content: {
|
|
10843
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10844
|
+
};
|
|
10845
|
+
};
|
|
10846
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10847
|
+
403: {
|
|
10848
|
+
headers: {
|
|
10849
|
+
[name: string]: unknown;
|
|
10850
|
+
};
|
|
10851
|
+
content: {
|
|
10852
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10853
|
+
};
|
|
10854
|
+
};
|
|
10855
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10856
|
+
404: {
|
|
10857
|
+
headers: {
|
|
10858
|
+
[name: string]: unknown;
|
|
10859
|
+
};
|
|
10860
|
+
content: {
|
|
10861
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10862
|
+
};
|
|
10863
|
+
};
|
|
10864
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10865
|
+
429: {
|
|
10866
|
+
headers: {
|
|
10867
|
+
[name: string]: unknown;
|
|
10868
|
+
};
|
|
10869
|
+
content: {
|
|
10870
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10871
|
+
};
|
|
10872
|
+
};
|
|
10873
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
10874
|
+
500: {
|
|
10875
|
+
headers: {
|
|
10876
|
+
[name: string]: unknown;
|
|
10877
|
+
};
|
|
10878
|
+
content: {
|
|
10879
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
10880
|
+
};
|
|
10881
|
+
};
|
|
10882
|
+
};
|
|
10883
|
+
};
|
|
8836
10884
|
admin_stores_surcharges_list: {
|
|
8837
10885
|
parameters: {
|
|
8838
10886
|
query?: never;
|