@poweredbysous/storefront-all-sdk 2.0.1 → 3.0.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 +468 -4
- package/dist/index.d.ts +468 -4
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -134,6 +134,46 @@ interface paths {
|
|
|
134
134
|
patch?: never;
|
|
135
135
|
trace?: never;
|
|
136
136
|
};
|
|
137
|
+
"/api/v1/admin/delivery-methods/": {
|
|
138
|
+
parameters: {
|
|
139
|
+
query?: never;
|
|
140
|
+
header?: never;
|
|
141
|
+
path?: never;
|
|
142
|
+
cookie?: never;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* List the company's delivery-method availability
|
|
146
|
+
* @description ``GET /api/v1/admin/delivery-methods/`` — every method's company availability.
|
|
147
|
+
*/
|
|
148
|
+
get: operations["admin_delivery_methods_list"];
|
|
149
|
+
put?: never;
|
|
150
|
+
post?: never;
|
|
151
|
+
delete?: never;
|
|
152
|
+
options?: never;
|
|
153
|
+
head?: never;
|
|
154
|
+
patch?: never;
|
|
155
|
+
trace?: never;
|
|
156
|
+
};
|
|
157
|
+
"/api/v1/admin/delivery-methods/{method}/": {
|
|
158
|
+
parameters: {
|
|
159
|
+
query?: never;
|
|
160
|
+
header?: never;
|
|
161
|
+
path?: never;
|
|
162
|
+
cookie?: never;
|
|
163
|
+
};
|
|
164
|
+
get?: never;
|
|
165
|
+
put?: never;
|
|
166
|
+
post?: never;
|
|
167
|
+
delete?: never;
|
|
168
|
+
options?: never;
|
|
169
|
+
head?: never;
|
|
170
|
+
/**
|
|
171
|
+
* Set the company's availability for one delivery method
|
|
172
|
+
* @description ``PATCH /api/v1/admin/delivery-methods/<method>/`` — the owner's switch.
|
|
173
|
+
*/
|
|
174
|
+
patch: operations["admin_delivery_methods_partial_update"];
|
|
175
|
+
trace?: never;
|
|
176
|
+
};
|
|
137
177
|
"/api/v1/admin/discounts/": {
|
|
138
178
|
parameters: {
|
|
139
179
|
query?: never;
|
|
@@ -904,6 +944,56 @@ interface paths {
|
|
|
904
944
|
patch?: never;
|
|
905
945
|
trace?: never;
|
|
906
946
|
};
|
|
947
|
+
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
|
|
948
|
+
parameters: {
|
|
949
|
+
query?: never;
|
|
950
|
+
header?: never;
|
|
951
|
+
path?: never;
|
|
952
|
+
cookie?: never;
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* List a Location's delivery-method config
|
|
956
|
+
* @description ``GET .../stores/<store_public_id>/locations/<location_public_id>/
|
|
957
|
+
* delivery-methods/``.
|
|
958
|
+
*
|
|
959
|
+
* Config for methods the company has made available, for one Location.
|
|
960
|
+
* A method the company hasn't switched on at all is omitted entirely, not
|
|
961
|
+
* returned disabled — "hidden, not greyed out": a Location cannot see, let
|
|
962
|
+
* alone enable, something its company hasn't agreed to.
|
|
963
|
+
*/
|
|
964
|
+
get: operations["admin_stores_locations_delivery_methods_list"];
|
|
965
|
+
put?: never;
|
|
966
|
+
post?: never;
|
|
967
|
+
delete?: never;
|
|
968
|
+
options?: never;
|
|
969
|
+
head?: never;
|
|
970
|
+
patch?: never;
|
|
971
|
+
trace?: never;
|
|
972
|
+
};
|
|
973
|
+
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/{method}/": {
|
|
974
|
+
parameters: {
|
|
975
|
+
query?: never;
|
|
976
|
+
header?: never;
|
|
977
|
+
path?: never;
|
|
978
|
+
cookie?: never;
|
|
979
|
+
};
|
|
980
|
+
get?: never;
|
|
981
|
+
put?: never;
|
|
982
|
+
post?: never;
|
|
983
|
+
delete?: never;
|
|
984
|
+
options?: never;
|
|
985
|
+
head?: never;
|
|
986
|
+
/**
|
|
987
|
+
* Set a Location's switch/config for one delivery method
|
|
988
|
+
* @description ``PATCH .../stores/<store_public_id>/locations/<location_public_id>/
|
|
989
|
+
* delivery-methods/<method>/``.
|
|
990
|
+
*
|
|
991
|
+
* One Location's own switch and/or its retained config. At least one of
|
|
992
|
+
* ``is_enabled`` or a config field is required; either can be sent alone.
|
|
993
|
+
*/
|
|
994
|
+
patch: operations["admin_stores_locations_delivery_methods_partial_update"];
|
|
995
|
+
trace?: never;
|
|
996
|
+
};
|
|
907
997
|
"/api/v1/admin/stores/{store_public_id}/surcharges/": {
|
|
908
998
|
parameters: {
|
|
909
999
|
query?: never;
|
|
@@ -6575,7 +6665,7 @@ interface components {
|
|
|
6575
6665
|
id: string;
|
|
6576
6666
|
/**
|
|
6577
6667
|
* Format: int64
|
|
6578
|
-
* @description
|
|
6668
|
+
* @description Store.id from the authenticated merchant
|
|
6579
6669
|
*/
|
|
6580
6670
|
store_id: number;
|
|
6581
6671
|
/**
|
|
@@ -6790,7 +6880,7 @@ interface components {
|
|
|
6790
6880
|
id: string;
|
|
6791
6881
|
/**
|
|
6792
6882
|
* Format: int64
|
|
6793
|
-
* @description
|
|
6883
|
+
* @description Store.id from the authenticated merchant
|
|
6794
6884
|
*/
|
|
6795
6885
|
store_id: number;
|
|
6796
6886
|
/**
|
|
@@ -6889,6 +6979,13 @@ interface components {
|
|
|
6889
6979
|
landing_path?: string;
|
|
6890
6980
|
referrer_host?: string;
|
|
6891
6981
|
};
|
|
6982
|
+
/** @description One row of the company availability list: a method and its on/off state. */
|
|
6983
|
+
CompanyDeliveryMethodAvailability: {
|
|
6984
|
+
method: components["schemas"]["MethodEnum"];
|
|
6985
|
+
is_available: boolean;
|
|
6986
|
+
/** Format: date-time */
|
|
6987
|
+
updated_at: string | null;
|
|
6988
|
+
};
|
|
6892
6989
|
ComplianceChoice: {
|
|
6893
6990
|
slug: string;
|
|
6894
6991
|
label: string;
|
|
@@ -7346,7 +7443,7 @@ interface components {
|
|
|
7346
7443
|
id: string;
|
|
7347
7444
|
/**
|
|
7348
7445
|
* Format: int64
|
|
7349
|
-
* @description
|
|
7446
|
+
* @description Store.id from the authenticated merchant
|
|
7350
7447
|
*/
|
|
7351
7448
|
store_id: number;
|
|
7352
7449
|
/** @description 6-character alphanumeric code for sharing */
|
|
@@ -7858,6 +7955,13 @@ interface components {
|
|
|
7858
7955
|
* @enum {string}
|
|
7859
7956
|
*/
|
|
7860
7957
|
MessageStatusEnum: "draft" | "active" | "paused" | "archived";
|
|
7958
|
+
/**
|
|
7959
|
+
* @description * `own_delivery` - Own Delivery
|
|
7960
|
+
* * `uber_direct` - Uber Direct
|
|
7961
|
+
* * `lieferando` - Lieferando
|
|
7962
|
+
* @enum {string}
|
|
7963
|
+
*/
|
|
7964
|
+
MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
|
|
7861
7965
|
ModifyLineItem: {
|
|
7862
7966
|
/** Format: uuid */
|
|
7863
7967
|
order_line_item_id: string;
|
|
@@ -7931,7 +8035,7 @@ interface components {
|
|
|
7931
8035
|
order_number: string;
|
|
7932
8036
|
/**
|
|
7933
8037
|
* Format: int64
|
|
7934
|
-
* @description
|
|
8038
|
+
* @description Store.id from the authenticated merchant
|
|
7935
8039
|
*/
|
|
7936
8040
|
store_id: number;
|
|
7937
8041
|
/**
|
|
@@ -8813,6 +8917,10 @@ interface components {
|
|
|
8813
8917
|
timezone?: string;
|
|
8814
8918
|
is_active?: boolean;
|
|
8815
8919
|
};
|
|
8920
|
+
/** @description PATCH body for the company owner's availability switch. */
|
|
8921
|
+
PatchedSetCompanyAvailability: {
|
|
8922
|
+
is_available?: boolean;
|
|
8923
|
+
};
|
|
8816
8924
|
/**
|
|
8817
8925
|
* @description Validates the request body for setting delivery on a checkout.
|
|
8818
8926
|
*
|
|
@@ -8837,6 +8945,23 @@ interface components {
|
|
|
8837
8945
|
fulfillment_slot_id?: string;
|
|
8838
8946
|
pickup_location_id?: number;
|
|
8839
8947
|
};
|
|
8948
|
+
/**
|
|
8949
|
+
* @description PATCH body for a store's delivery-method row.
|
|
8950
|
+
*
|
|
8951
|
+
* ``is_enabled`` and the retained config fields are all optional so a
|
|
8952
|
+
* caller can flip the switch alone, without resending config it isn't
|
|
8953
|
+
* changing — but at least one field must be present.
|
|
8954
|
+
*/
|
|
8955
|
+
PatchedSetStoreDeliveryMethod: {
|
|
8956
|
+
is_enabled?: boolean;
|
|
8957
|
+
delivery_area?: unknown;
|
|
8958
|
+
/** Format: decimal */
|
|
8959
|
+
base_fee?: string | null;
|
|
8960
|
+
/** Format: decimal */
|
|
8961
|
+
fee_split_percentage?: string | null;
|
|
8962
|
+
schedule?: unknown;
|
|
8963
|
+
lead_time_minutes?: number | null;
|
|
8964
|
+
};
|
|
8840
8965
|
/**
|
|
8841
8966
|
* @description Read/write serializer for the store-onboarding wizard.
|
|
8842
8967
|
*
|
|
@@ -9902,6 +10027,20 @@ interface components {
|
|
|
9902
10027
|
readonly offers_reusable_packaging: boolean;
|
|
9903
10028
|
readonly reusable_deposit_amount?: string | null;
|
|
9904
10029
|
};
|
|
10030
|
+
/** @description One row of the store config list: a method's switch plus retained config. */
|
|
10031
|
+
StoreDeliveryMethodConfig: {
|
|
10032
|
+
method: components["schemas"]["MethodEnum"];
|
|
10033
|
+
is_enabled: boolean;
|
|
10034
|
+
delivery_area: unknown;
|
|
10035
|
+
/** Format: decimal */
|
|
10036
|
+
base_fee: string | null;
|
|
10037
|
+
/** Format: decimal */
|
|
10038
|
+
fee_split_percentage: string | null;
|
|
10039
|
+
schedule: unknown;
|
|
10040
|
+
lead_time_minutes: number | null;
|
|
10041
|
+
/** Format: date-time */
|
|
10042
|
+
config_updated_at: string | null;
|
|
10043
|
+
};
|
|
9905
10044
|
StoreMeResponse: {
|
|
9906
10045
|
id: number;
|
|
9907
10046
|
public_id: string;
|
|
@@ -10921,6 +11060,166 @@ interface operations {
|
|
|
10921
11060
|
};
|
|
10922
11061
|
};
|
|
10923
11062
|
};
|
|
11063
|
+
admin_delivery_methods_list: {
|
|
11064
|
+
parameters: {
|
|
11065
|
+
query?: never;
|
|
11066
|
+
header?: {
|
|
11067
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
11068
|
+
"X-Sous-Company-Id"?: number;
|
|
11069
|
+
};
|
|
11070
|
+
path?: never;
|
|
11071
|
+
cookie?: never;
|
|
11072
|
+
};
|
|
11073
|
+
requestBody?: never;
|
|
11074
|
+
responses: {
|
|
11075
|
+
200: {
|
|
11076
|
+
headers: {
|
|
11077
|
+
[name: string]: unknown;
|
|
11078
|
+
};
|
|
11079
|
+
content: {
|
|
11080
|
+
"application/json": components["schemas"]["CompanyDeliveryMethodAvailability"][];
|
|
11081
|
+
};
|
|
11082
|
+
};
|
|
11083
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11084
|
+
400: {
|
|
11085
|
+
headers: {
|
|
11086
|
+
[name: string]: unknown;
|
|
11087
|
+
};
|
|
11088
|
+
content: {
|
|
11089
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11090
|
+
};
|
|
11091
|
+
};
|
|
11092
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11093
|
+
401: {
|
|
11094
|
+
headers: {
|
|
11095
|
+
[name: string]: unknown;
|
|
11096
|
+
};
|
|
11097
|
+
content: {
|
|
11098
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11099
|
+
};
|
|
11100
|
+
};
|
|
11101
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11102
|
+
403: {
|
|
11103
|
+
headers: {
|
|
11104
|
+
[name: string]: unknown;
|
|
11105
|
+
};
|
|
11106
|
+
content: {
|
|
11107
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11108
|
+
};
|
|
11109
|
+
};
|
|
11110
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11111
|
+
404: {
|
|
11112
|
+
headers: {
|
|
11113
|
+
[name: string]: unknown;
|
|
11114
|
+
};
|
|
11115
|
+
content: {
|
|
11116
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11117
|
+
};
|
|
11118
|
+
};
|
|
11119
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11120
|
+
429: {
|
|
11121
|
+
headers: {
|
|
11122
|
+
[name: string]: unknown;
|
|
11123
|
+
};
|
|
11124
|
+
content: {
|
|
11125
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11126
|
+
};
|
|
11127
|
+
};
|
|
11128
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11129
|
+
500: {
|
|
11130
|
+
headers: {
|
|
11131
|
+
[name: string]: unknown;
|
|
11132
|
+
};
|
|
11133
|
+
content: {
|
|
11134
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11135
|
+
};
|
|
11136
|
+
};
|
|
11137
|
+
};
|
|
11138
|
+
};
|
|
11139
|
+
admin_delivery_methods_partial_update: {
|
|
11140
|
+
parameters: {
|
|
11141
|
+
query?: never;
|
|
11142
|
+
header?: {
|
|
11143
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
11144
|
+
"X-Sous-Company-Id"?: number;
|
|
11145
|
+
};
|
|
11146
|
+
path: {
|
|
11147
|
+
method: string;
|
|
11148
|
+
};
|
|
11149
|
+
cookie?: never;
|
|
11150
|
+
};
|
|
11151
|
+
requestBody?: {
|
|
11152
|
+
content: {
|
|
11153
|
+
"application/json": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
11154
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
11155
|
+
"multipart/form-data": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
11156
|
+
};
|
|
11157
|
+
};
|
|
11158
|
+
responses: {
|
|
11159
|
+
200: {
|
|
11160
|
+
headers: {
|
|
11161
|
+
[name: string]: unknown;
|
|
11162
|
+
};
|
|
11163
|
+
content: {
|
|
11164
|
+
"application/json": components["schemas"]["CompanyDeliveryMethodAvailability"];
|
|
11165
|
+
};
|
|
11166
|
+
};
|
|
11167
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11168
|
+
400: {
|
|
11169
|
+
headers: {
|
|
11170
|
+
[name: string]: unknown;
|
|
11171
|
+
};
|
|
11172
|
+
content: {
|
|
11173
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11174
|
+
};
|
|
11175
|
+
};
|
|
11176
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11177
|
+
401: {
|
|
11178
|
+
headers: {
|
|
11179
|
+
[name: string]: unknown;
|
|
11180
|
+
};
|
|
11181
|
+
content: {
|
|
11182
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11183
|
+
};
|
|
11184
|
+
};
|
|
11185
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11186
|
+
403: {
|
|
11187
|
+
headers: {
|
|
11188
|
+
[name: string]: unknown;
|
|
11189
|
+
};
|
|
11190
|
+
content: {
|
|
11191
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11192
|
+
};
|
|
11193
|
+
};
|
|
11194
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11195
|
+
404: {
|
|
11196
|
+
headers: {
|
|
11197
|
+
[name: string]: unknown;
|
|
11198
|
+
};
|
|
11199
|
+
content: {
|
|
11200
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11201
|
+
};
|
|
11202
|
+
};
|
|
11203
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11204
|
+
429: {
|
|
11205
|
+
headers: {
|
|
11206
|
+
[name: string]: unknown;
|
|
11207
|
+
};
|
|
11208
|
+
content: {
|
|
11209
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11210
|
+
};
|
|
11211
|
+
};
|
|
11212
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11213
|
+
500: {
|
|
11214
|
+
headers: {
|
|
11215
|
+
[name: string]: unknown;
|
|
11216
|
+
};
|
|
11217
|
+
content: {
|
|
11218
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11219
|
+
};
|
|
11220
|
+
};
|
|
11221
|
+
};
|
|
11222
|
+
};
|
|
10924
11223
|
admin_discounts_list: {
|
|
10925
11224
|
parameters: {
|
|
10926
11225
|
query?: {
|
|
@@ -13780,6 +14079,171 @@ interface operations {
|
|
|
13780
14079
|
};
|
|
13781
14080
|
};
|
|
13782
14081
|
};
|
|
14082
|
+
admin_stores_locations_delivery_methods_list: {
|
|
14083
|
+
parameters: {
|
|
14084
|
+
query?: never;
|
|
14085
|
+
header?: {
|
|
14086
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14087
|
+
"X-Sous-Company-Id"?: number;
|
|
14088
|
+
};
|
|
14089
|
+
path: {
|
|
14090
|
+
location_public_id: string;
|
|
14091
|
+
store_public_id: string;
|
|
14092
|
+
};
|
|
14093
|
+
cookie?: never;
|
|
14094
|
+
};
|
|
14095
|
+
requestBody?: never;
|
|
14096
|
+
responses: {
|
|
14097
|
+
200: {
|
|
14098
|
+
headers: {
|
|
14099
|
+
[name: string]: unknown;
|
|
14100
|
+
};
|
|
14101
|
+
content: {
|
|
14102
|
+
"application/json": components["schemas"]["StoreDeliveryMethodConfig"][];
|
|
14103
|
+
};
|
|
14104
|
+
};
|
|
14105
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14106
|
+
400: {
|
|
14107
|
+
headers: {
|
|
14108
|
+
[name: string]: unknown;
|
|
14109
|
+
};
|
|
14110
|
+
content: {
|
|
14111
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14112
|
+
};
|
|
14113
|
+
};
|
|
14114
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14115
|
+
401: {
|
|
14116
|
+
headers: {
|
|
14117
|
+
[name: string]: unknown;
|
|
14118
|
+
};
|
|
14119
|
+
content: {
|
|
14120
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14121
|
+
};
|
|
14122
|
+
};
|
|
14123
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14124
|
+
403: {
|
|
14125
|
+
headers: {
|
|
14126
|
+
[name: string]: unknown;
|
|
14127
|
+
};
|
|
14128
|
+
content: {
|
|
14129
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14130
|
+
};
|
|
14131
|
+
};
|
|
14132
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14133
|
+
404: {
|
|
14134
|
+
headers: {
|
|
14135
|
+
[name: string]: unknown;
|
|
14136
|
+
};
|
|
14137
|
+
content: {
|
|
14138
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14139
|
+
};
|
|
14140
|
+
};
|
|
14141
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14142
|
+
429: {
|
|
14143
|
+
headers: {
|
|
14144
|
+
[name: string]: unknown;
|
|
14145
|
+
};
|
|
14146
|
+
content: {
|
|
14147
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14148
|
+
};
|
|
14149
|
+
};
|
|
14150
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14151
|
+
500: {
|
|
14152
|
+
headers: {
|
|
14153
|
+
[name: string]: unknown;
|
|
14154
|
+
};
|
|
14155
|
+
content: {
|
|
14156
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14157
|
+
};
|
|
14158
|
+
};
|
|
14159
|
+
};
|
|
14160
|
+
};
|
|
14161
|
+
admin_stores_locations_delivery_methods_partial_update: {
|
|
14162
|
+
parameters: {
|
|
14163
|
+
query?: never;
|
|
14164
|
+
header?: {
|
|
14165
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14166
|
+
"X-Sous-Company-Id"?: number;
|
|
14167
|
+
};
|
|
14168
|
+
path: {
|
|
14169
|
+
location_public_id: string;
|
|
14170
|
+
method: string;
|
|
14171
|
+
store_public_id: string;
|
|
14172
|
+
};
|
|
14173
|
+
cookie?: never;
|
|
14174
|
+
};
|
|
14175
|
+
requestBody?: {
|
|
14176
|
+
content: {
|
|
14177
|
+
"application/json": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
14178
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
14179
|
+
"multipart/form-data": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
14180
|
+
};
|
|
14181
|
+
};
|
|
14182
|
+
responses: {
|
|
14183
|
+
200: {
|
|
14184
|
+
headers: {
|
|
14185
|
+
[name: string]: unknown;
|
|
14186
|
+
};
|
|
14187
|
+
content: {
|
|
14188
|
+
"application/json": components["schemas"]["StoreDeliveryMethodConfig"];
|
|
14189
|
+
};
|
|
14190
|
+
};
|
|
14191
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14192
|
+
400: {
|
|
14193
|
+
headers: {
|
|
14194
|
+
[name: string]: unknown;
|
|
14195
|
+
};
|
|
14196
|
+
content: {
|
|
14197
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14198
|
+
};
|
|
14199
|
+
};
|
|
14200
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14201
|
+
401: {
|
|
14202
|
+
headers: {
|
|
14203
|
+
[name: string]: unknown;
|
|
14204
|
+
};
|
|
14205
|
+
content: {
|
|
14206
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14207
|
+
};
|
|
14208
|
+
};
|
|
14209
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14210
|
+
403: {
|
|
14211
|
+
headers: {
|
|
14212
|
+
[name: string]: unknown;
|
|
14213
|
+
};
|
|
14214
|
+
content: {
|
|
14215
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14216
|
+
};
|
|
14217
|
+
};
|
|
14218
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14219
|
+
404: {
|
|
14220
|
+
headers: {
|
|
14221
|
+
[name: string]: unknown;
|
|
14222
|
+
};
|
|
14223
|
+
content: {
|
|
14224
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14225
|
+
};
|
|
14226
|
+
};
|
|
14227
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14228
|
+
429: {
|
|
14229
|
+
headers: {
|
|
14230
|
+
[name: string]: unknown;
|
|
14231
|
+
};
|
|
14232
|
+
content: {
|
|
14233
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14234
|
+
};
|
|
14235
|
+
};
|
|
14236
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14237
|
+
500: {
|
|
14238
|
+
headers: {
|
|
14239
|
+
[name: string]: unknown;
|
|
14240
|
+
};
|
|
14241
|
+
content: {
|
|
14242
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14243
|
+
};
|
|
14244
|
+
};
|
|
14245
|
+
};
|
|
14246
|
+
};
|
|
13783
14247
|
admin_stores_surcharges_list: {
|
|
13784
14248
|
parameters: {
|
|
13785
14249
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -134,6 +134,46 @@ interface paths {
|
|
|
134
134
|
patch?: never;
|
|
135
135
|
trace?: never;
|
|
136
136
|
};
|
|
137
|
+
"/api/v1/admin/delivery-methods/": {
|
|
138
|
+
parameters: {
|
|
139
|
+
query?: never;
|
|
140
|
+
header?: never;
|
|
141
|
+
path?: never;
|
|
142
|
+
cookie?: never;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* List the company's delivery-method availability
|
|
146
|
+
* @description ``GET /api/v1/admin/delivery-methods/`` — every method's company availability.
|
|
147
|
+
*/
|
|
148
|
+
get: operations["admin_delivery_methods_list"];
|
|
149
|
+
put?: never;
|
|
150
|
+
post?: never;
|
|
151
|
+
delete?: never;
|
|
152
|
+
options?: never;
|
|
153
|
+
head?: never;
|
|
154
|
+
patch?: never;
|
|
155
|
+
trace?: never;
|
|
156
|
+
};
|
|
157
|
+
"/api/v1/admin/delivery-methods/{method}/": {
|
|
158
|
+
parameters: {
|
|
159
|
+
query?: never;
|
|
160
|
+
header?: never;
|
|
161
|
+
path?: never;
|
|
162
|
+
cookie?: never;
|
|
163
|
+
};
|
|
164
|
+
get?: never;
|
|
165
|
+
put?: never;
|
|
166
|
+
post?: never;
|
|
167
|
+
delete?: never;
|
|
168
|
+
options?: never;
|
|
169
|
+
head?: never;
|
|
170
|
+
/**
|
|
171
|
+
* Set the company's availability for one delivery method
|
|
172
|
+
* @description ``PATCH /api/v1/admin/delivery-methods/<method>/`` — the owner's switch.
|
|
173
|
+
*/
|
|
174
|
+
patch: operations["admin_delivery_methods_partial_update"];
|
|
175
|
+
trace?: never;
|
|
176
|
+
};
|
|
137
177
|
"/api/v1/admin/discounts/": {
|
|
138
178
|
parameters: {
|
|
139
179
|
query?: never;
|
|
@@ -904,6 +944,56 @@ interface paths {
|
|
|
904
944
|
patch?: never;
|
|
905
945
|
trace?: never;
|
|
906
946
|
};
|
|
947
|
+
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
|
|
948
|
+
parameters: {
|
|
949
|
+
query?: never;
|
|
950
|
+
header?: never;
|
|
951
|
+
path?: never;
|
|
952
|
+
cookie?: never;
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* List a Location's delivery-method config
|
|
956
|
+
* @description ``GET .../stores/<store_public_id>/locations/<location_public_id>/
|
|
957
|
+
* delivery-methods/``.
|
|
958
|
+
*
|
|
959
|
+
* Config for methods the company has made available, for one Location.
|
|
960
|
+
* A method the company hasn't switched on at all is omitted entirely, not
|
|
961
|
+
* returned disabled — "hidden, not greyed out": a Location cannot see, let
|
|
962
|
+
* alone enable, something its company hasn't agreed to.
|
|
963
|
+
*/
|
|
964
|
+
get: operations["admin_stores_locations_delivery_methods_list"];
|
|
965
|
+
put?: never;
|
|
966
|
+
post?: never;
|
|
967
|
+
delete?: never;
|
|
968
|
+
options?: never;
|
|
969
|
+
head?: never;
|
|
970
|
+
patch?: never;
|
|
971
|
+
trace?: never;
|
|
972
|
+
};
|
|
973
|
+
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/{method}/": {
|
|
974
|
+
parameters: {
|
|
975
|
+
query?: never;
|
|
976
|
+
header?: never;
|
|
977
|
+
path?: never;
|
|
978
|
+
cookie?: never;
|
|
979
|
+
};
|
|
980
|
+
get?: never;
|
|
981
|
+
put?: never;
|
|
982
|
+
post?: never;
|
|
983
|
+
delete?: never;
|
|
984
|
+
options?: never;
|
|
985
|
+
head?: never;
|
|
986
|
+
/**
|
|
987
|
+
* Set a Location's switch/config for one delivery method
|
|
988
|
+
* @description ``PATCH .../stores/<store_public_id>/locations/<location_public_id>/
|
|
989
|
+
* delivery-methods/<method>/``.
|
|
990
|
+
*
|
|
991
|
+
* One Location's own switch and/or its retained config. At least one of
|
|
992
|
+
* ``is_enabled`` or a config field is required; either can be sent alone.
|
|
993
|
+
*/
|
|
994
|
+
patch: operations["admin_stores_locations_delivery_methods_partial_update"];
|
|
995
|
+
trace?: never;
|
|
996
|
+
};
|
|
907
997
|
"/api/v1/admin/stores/{store_public_id}/surcharges/": {
|
|
908
998
|
parameters: {
|
|
909
999
|
query?: never;
|
|
@@ -6575,7 +6665,7 @@ interface components {
|
|
|
6575
6665
|
id: string;
|
|
6576
6666
|
/**
|
|
6577
6667
|
* Format: int64
|
|
6578
|
-
* @description
|
|
6668
|
+
* @description Store.id from the authenticated merchant
|
|
6579
6669
|
*/
|
|
6580
6670
|
store_id: number;
|
|
6581
6671
|
/**
|
|
@@ -6790,7 +6880,7 @@ interface components {
|
|
|
6790
6880
|
id: string;
|
|
6791
6881
|
/**
|
|
6792
6882
|
* Format: int64
|
|
6793
|
-
* @description
|
|
6883
|
+
* @description Store.id from the authenticated merchant
|
|
6794
6884
|
*/
|
|
6795
6885
|
store_id: number;
|
|
6796
6886
|
/**
|
|
@@ -6889,6 +6979,13 @@ interface components {
|
|
|
6889
6979
|
landing_path?: string;
|
|
6890
6980
|
referrer_host?: string;
|
|
6891
6981
|
};
|
|
6982
|
+
/** @description One row of the company availability list: a method and its on/off state. */
|
|
6983
|
+
CompanyDeliveryMethodAvailability: {
|
|
6984
|
+
method: components["schemas"]["MethodEnum"];
|
|
6985
|
+
is_available: boolean;
|
|
6986
|
+
/** Format: date-time */
|
|
6987
|
+
updated_at: string | null;
|
|
6988
|
+
};
|
|
6892
6989
|
ComplianceChoice: {
|
|
6893
6990
|
slug: string;
|
|
6894
6991
|
label: string;
|
|
@@ -7346,7 +7443,7 @@ interface components {
|
|
|
7346
7443
|
id: string;
|
|
7347
7444
|
/**
|
|
7348
7445
|
* Format: int64
|
|
7349
|
-
* @description
|
|
7446
|
+
* @description Store.id from the authenticated merchant
|
|
7350
7447
|
*/
|
|
7351
7448
|
store_id: number;
|
|
7352
7449
|
/** @description 6-character alphanumeric code for sharing */
|
|
@@ -7858,6 +7955,13 @@ interface components {
|
|
|
7858
7955
|
* @enum {string}
|
|
7859
7956
|
*/
|
|
7860
7957
|
MessageStatusEnum: "draft" | "active" | "paused" | "archived";
|
|
7958
|
+
/**
|
|
7959
|
+
* @description * `own_delivery` - Own Delivery
|
|
7960
|
+
* * `uber_direct` - Uber Direct
|
|
7961
|
+
* * `lieferando` - Lieferando
|
|
7962
|
+
* @enum {string}
|
|
7963
|
+
*/
|
|
7964
|
+
MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
|
|
7861
7965
|
ModifyLineItem: {
|
|
7862
7966
|
/** Format: uuid */
|
|
7863
7967
|
order_line_item_id: string;
|
|
@@ -7931,7 +8035,7 @@ interface components {
|
|
|
7931
8035
|
order_number: string;
|
|
7932
8036
|
/**
|
|
7933
8037
|
* Format: int64
|
|
7934
|
-
* @description
|
|
8038
|
+
* @description Store.id from the authenticated merchant
|
|
7935
8039
|
*/
|
|
7936
8040
|
store_id: number;
|
|
7937
8041
|
/**
|
|
@@ -8813,6 +8917,10 @@ interface components {
|
|
|
8813
8917
|
timezone?: string;
|
|
8814
8918
|
is_active?: boolean;
|
|
8815
8919
|
};
|
|
8920
|
+
/** @description PATCH body for the company owner's availability switch. */
|
|
8921
|
+
PatchedSetCompanyAvailability: {
|
|
8922
|
+
is_available?: boolean;
|
|
8923
|
+
};
|
|
8816
8924
|
/**
|
|
8817
8925
|
* @description Validates the request body for setting delivery on a checkout.
|
|
8818
8926
|
*
|
|
@@ -8837,6 +8945,23 @@ interface components {
|
|
|
8837
8945
|
fulfillment_slot_id?: string;
|
|
8838
8946
|
pickup_location_id?: number;
|
|
8839
8947
|
};
|
|
8948
|
+
/**
|
|
8949
|
+
* @description PATCH body for a store's delivery-method row.
|
|
8950
|
+
*
|
|
8951
|
+
* ``is_enabled`` and the retained config fields are all optional so a
|
|
8952
|
+
* caller can flip the switch alone, without resending config it isn't
|
|
8953
|
+
* changing — but at least one field must be present.
|
|
8954
|
+
*/
|
|
8955
|
+
PatchedSetStoreDeliveryMethod: {
|
|
8956
|
+
is_enabled?: boolean;
|
|
8957
|
+
delivery_area?: unknown;
|
|
8958
|
+
/** Format: decimal */
|
|
8959
|
+
base_fee?: string | null;
|
|
8960
|
+
/** Format: decimal */
|
|
8961
|
+
fee_split_percentage?: string | null;
|
|
8962
|
+
schedule?: unknown;
|
|
8963
|
+
lead_time_minutes?: number | null;
|
|
8964
|
+
};
|
|
8840
8965
|
/**
|
|
8841
8966
|
* @description Read/write serializer for the store-onboarding wizard.
|
|
8842
8967
|
*
|
|
@@ -9902,6 +10027,20 @@ interface components {
|
|
|
9902
10027
|
readonly offers_reusable_packaging: boolean;
|
|
9903
10028
|
readonly reusable_deposit_amount?: string | null;
|
|
9904
10029
|
};
|
|
10030
|
+
/** @description One row of the store config list: a method's switch plus retained config. */
|
|
10031
|
+
StoreDeliveryMethodConfig: {
|
|
10032
|
+
method: components["schemas"]["MethodEnum"];
|
|
10033
|
+
is_enabled: boolean;
|
|
10034
|
+
delivery_area: unknown;
|
|
10035
|
+
/** Format: decimal */
|
|
10036
|
+
base_fee: string | null;
|
|
10037
|
+
/** Format: decimal */
|
|
10038
|
+
fee_split_percentage: string | null;
|
|
10039
|
+
schedule: unknown;
|
|
10040
|
+
lead_time_minutes: number | null;
|
|
10041
|
+
/** Format: date-time */
|
|
10042
|
+
config_updated_at: string | null;
|
|
10043
|
+
};
|
|
9905
10044
|
StoreMeResponse: {
|
|
9906
10045
|
id: number;
|
|
9907
10046
|
public_id: string;
|
|
@@ -10921,6 +11060,166 @@ interface operations {
|
|
|
10921
11060
|
};
|
|
10922
11061
|
};
|
|
10923
11062
|
};
|
|
11063
|
+
admin_delivery_methods_list: {
|
|
11064
|
+
parameters: {
|
|
11065
|
+
query?: never;
|
|
11066
|
+
header?: {
|
|
11067
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
11068
|
+
"X-Sous-Company-Id"?: number;
|
|
11069
|
+
};
|
|
11070
|
+
path?: never;
|
|
11071
|
+
cookie?: never;
|
|
11072
|
+
};
|
|
11073
|
+
requestBody?: never;
|
|
11074
|
+
responses: {
|
|
11075
|
+
200: {
|
|
11076
|
+
headers: {
|
|
11077
|
+
[name: string]: unknown;
|
|
11078
|
+
};
|
|
11079
|
+
content: {
|
|
11080
|
+
"application/json": components["schemas"]["CompanyDeliveryMethodAvailability"][];
|
|
11081
|
+
};
|
|
11082
|
+
};
|
|
11083
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11084
|
+
400: {
|
|
11085
|
+
headers: {
|
|
11086
|
+
[name: string]: unknown;
|
|
11087
|
+
};
|
|
11088
|
+
content: {
|
|
11089
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11090
|
+
};
|
|
11091
|
+
};
|
|
11092
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11093
|
+
401: {
|
|
11094
|
+
headers: {
|
|
11095
|
+
[name: string]: unknown;
|
|
11096
|
+
};
|
|
11097
|
+
content: {
|
|
11098
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11099
|
+
};
|
|
11100
|
+
};
|
|
11101
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11102
|
+
403: {
|
|
11103
|
+
headers: {
|
|
11104
|
+
[name: string]: unknown;
|
|
11105
|
+
};
|
|
11106
|
+
content: {
|
|
11107
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11108
|
+
};
|
|
11109
|
+
};
|
|
11110
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11111
|
+
404: {
|
|
11112
|
+
headers: {
|
|
11113
|
+
[name: string]: unknown;
|
|
11114
|
+
};
|
|
11115
|
+
content: {
|
|
11116
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11117
|
+
};
|
|
11118
|
+
};
|
|
11119
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11120
|
+
429: {
|
|
11121
|
+
headers: {
|
|
11122
|
+
[name: string]: unknown;
|
|
11123
|
+
};
|
|
11124
|
+
content: {
|
|
11125
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11126
|
+
};
|
|
11127
|
+
};
|
|
11128
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11129
|
+
500: {
|
|
11130
|
+
headers: {
|
|
11131
|
+
[name: string]: unknown;
|
|
11132
|
+
};
|
|
11133
|
+
content: {
|
|
11134
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11135
|
+
};
|
|
11136
|
+
};
|
|
11137
|
+
};
|
|
11138
|
+
};
|
|
11139
|
+
admin_delivery_methods_partial_update: {
|
|
11140
|
+
parameters: {
|
|
11141
|
+
query?: never;
|
|
11142
|
+
header?: {
|
|
11143
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
11144
|
+
"X-Sous-Company-Id"?: number;
|
|
11145
|
+
};
|
|
11146
|
+
path: {
|
|
11147
|
+
method: string;
|
|
11148
|
+
};
|
|
11149
|
+
cookie?: never;
|
|
11150
|
+
};
|
|
11151
|
+
requestBody?: {
|
|
11152
|
+
content: {
|
|
11153
|
+
"application/json": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
11154
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
11155
|
+
"multipart/form-data": components["schemas"]["PatchedSetCompanyAvailability"];
|
|
11156
|
+
};
|
|
11157
|
+
};
|
|
11158
|
+
responses: {
|
|
11159
|
+
200: {
|
|
11160
|
+
headers: {
|
|
11161
|
+
[name: string]: unknown;
|
|
11162
|
+
};
|
|
11163
|
+
content: {
|
|
11164
|
+
"application/json": components["schemas"]["CompanyDeliveryMethodAvailability"];
|
|
11165
|
+
};
|
|
11166
|
+
};
|
|
11167
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11168
|
+
400: {
|
|
11169
|
+
headers: {
|
|
11170
|
+
[name: string]: unknown;
|
|
11171
|
+
};
|
|
11172
|
+
content: {
|
|
11173
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11174
|
+
};
|
|
11175
|
+
};
|
|
11176
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11177
|
+
401: {
|
|
11178
|
+
headers: {
|
|
11179
|
+
[name: string]: unknown;
|
|
11180
|
+
};
|
|
11181
|
+
content: {
|
|
11182
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11183
|
+
};
|
|
11184
|
+
};
|
|
11185
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11186
|
+
403: {
|
|
11187
|
+
headers: {
|
|
11188
|
+
[name: string]: unknown;
|
|
11189
|
+
};
|
|
11190
|
+
content: {
|
|
11191
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11192
|
+
};
|
|
11193
|
+
};
|
|
11194
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11195
|
+
404: {
|
|
11196
|
+
headers: {
|
|
11197
|
+
[name: string]: unknown;
|
|
11198
|
+
};
|
|
11199
|
+
content: {
|
|
11200
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11201
|
+
};
|
|
11202
|
+
};
|
|
11203
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11204
|
+
429: {
|
|
11205
|
+
headers: {
|
|
11206
|
+
[name: string]: unknown;
|
|
11207
|
+
};
|
|
11208
|
+
content: {
|
|
11209
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11210
|
+
};
|
|
11211
|
+
};
|
|
11212
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
11213
|
+
500: {
|
|
11214
|
+
headers: {
|
|
11215
|
+
[name: string]: unknown;
|
|
11216
|
+
};
|
|
11217
|
+
content: {
|
|
11218
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
11219
|
+
};
|
|
11220
|
+
};
|
|
11221
|
+
};
|
|
11222
|
+
};
|
|
10924
11223
|
admin_discounts_list: {
|
|
10925
11224
|
parameters: {
|
|
10926
11225
|
query?: {
|
|
@@ -13780,6 +14079,171 @@ interface operations {
|
|
|
13780
14079
|
};
|
|
13781
14080
|
};
|
|
13782
14081
|
};
|
|
14082
|
+
admin_stores_locations_delivery_methods_list: {
|
|
14083
|
+
parameters: {
|
|
14084
|
+
query?: never;
|
|
14085
|
+
header?: {
|
|
14086
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14087
|
+
"X-Sous-Company-Id"?: number;
|
|
14088
|
+
};
|
|
14089
|
+
path: {
|
|
14090
|
+
location_public_id: string;
|
|
14091
|
+
store_public_id: string;
|
|
14092
|
+
};
|
|
14093
|
+
cookie?: never;
|
|
14094
|
+
};
|
|
14095
|
+
requestBody?: never;
|
|
14096
|
+
responses: {
|
|
14097
|
+
200: {
|
|
14098
|
+
headers: {
|
|
14099
|
+
[name: string]: unknown;
|
|
14100
|
+
};
|
|
14101
|
+
content: {
|
|
14102
|
+
"application/json": components["schemas"]["StoreDeliveryMethodConfig"][];
|
|
14103
|
+
};
|
|
14104
|
+
};
|
|
14105
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14106
|
+
400: {
|
|
14107
|
+
headers: {
|
|
14108
|
+
[name: string]: unknown;
|
|
14109
|
+
};
|
|
14110
|
+
content: {
|
|
14111
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14112
|
+
};
|
|
14113
|
+
};
|
|
14114
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14115
|
+
401: {
|
|
14116
|
+
headers: {
|
|
14117
|
+
[name: string]: unknown;
|
|
14118
|
+
};
|
|
14119
|
+
content: {
|
|
14120
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14121
|
+
};
|
|
14122
|
+
};
|
|
14123
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14124
|
+
403: {
|
|
14125
|
+
headers: {
|
|
14126
|
+
[name: string]: unknown;
|
|
14127
|
+
};
|
|
14128
|
+
content: {
|
|
14129
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14130
|
+
};
|
|
14131
|
+
};
|
|
14132
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14133
|
+
404: {
|
|
14134
|
+
headers: {
|
|
14135
|
+
[name: string]: unknown;
|
|
14136
|
+
};
|
|
14137
|
+
content: {
|
|
14138
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14139
|
+
};
|
|
14140
|
+
};
|
|
14141
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14142
|
+
429: {
|
|
14143
|
+
headers: {
|
|
14144
|
+
[name: string]: unknown;
|
|
14145
|
+
};
|
|
14146
|
+
content: {
|
|
14147
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14148
|
+
};
|
|
14149
|
+
};
|
|
14150
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14151
|
+
500: {
|
|
14152
|
+
headers: {
|
|
14153
|
+
[name: string]: unknown;
|
|
14154
|
+
};
|
|
14155
|
+
content: {
|
|
14156
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14157
|
+
};
|
|
14158
|
+
};
|
|
14159
|
+
};
|
|
14160
|
+
};
|
|
14161
|
+
admin_stores_locations_delivery_methods_partial_update: {
|
|
14162
|
+
parameters: {
|
|
14163
|
+
query?: never;
|
|
14164
|
+
header?: {
|
|
14165
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14166
|
+
"X-Sous-Company-Id"?: number;
|
|
14167
|
+
};
|
|
14168
|
+
path: {
|
|
14169
|
+
location_public_id: string;
|
|
14170
|
+
method: string;
|
|
14171
|
+
store_public_id: string;
|
|
14172
|
+
};
|
|
14173
|
+
cookie?: never;
|
|
14174
|
+
};
|
|
14175
|
+
requestBody?: {
|
|
14176
|
+
content: {
|
|
14177
|
+
"application/json": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
14178
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
14179
|
+
"multipart/form-data": components["schemas"]["PatchedSetStoreDeliveryMethod"];
|
|
14180
|
+
};
|
|
14181
|
+
};
|
|
14182
|
+
responses: {
|
|
14183
|
+
200: {
|
|
14184
|
+
headers: {
|
|
14185
|
+
[name: string]: unknown;
|
|
14186
|
+
};
|
|
14187
|
+
content: {
|
|
14188
|
+
"application/json": components["schemas"]["StoreDeliveryMethodConfig"];
|
|
14189
|
+
};
|
|
14190
|
+
};
|
|
14191
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14192
|
+
400: {
|
|
14193
|
+
headers: {
|
|
14194
|
+
[name: string]: unknown;
|
|
14195
|
+
};
|
|
14196
|
+
content: {
|
|
14197
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14198
|
+
};
|
|
14199
|
+
};
|
|
14200
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14201
|
+
401: {
|
|
14202
|
+
headers: {
|
|
14203
|
+
[name: string]: unknown;
|
|
14204
|
+
};
|
|
14205
|
+
content: {
|
|
14206
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14207
|
+
};
|
|
14208
|
+
};
|
|
14209
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14210
|
+
403: {
|
|
14211
|
+
headers: {
|
|
14212
|
+
[name: string]: unknown;
|
|
14213
|
+
};
|
|
14214
|
+
content: {
|
|
14215
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14216
|
+
};
|
|
14217
|
+
};
|
|
14218
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14219
|
+
404: {
|
|
14220
|
+
headers: {
|
|
14221
|
+
[name: string]: unknown;
|
|
14222
|
+
};
|
|
14223
|
+
content: {
|
|
14224
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14225
|
+
};
|
|
14226
|
+
};
|
|
14227
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14228
|
+
429: {
|
|
14229
|
+
headers: {
|
|
14230
|
+
[name: string]: unknown;
|
|
14231
|
+
};
|
|
14232
|
+
content: {
|
|
14233
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14234
|
+
};
|
|
14235
|
+
};
|
|
14236
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14237
|
+
500: {
|
|
14238
|
+
headers: {
|
|
14239
|
+
[name: string]: unknown;
|
|
14240
|
+
};
|
|
14241
|
+
content: {
|
|
14242
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14243
|
+
};
|
|
14244
|
+
};
|
|
14245
|
+
};
|
|
14246
|
+
};
|
|
13783
14247
|
admin_stores_surcharges_list: {
|
|
13784
14248
|
parameters: {
|
|
13785
14249
|
query?: never;
|