@poweredbysous/storefront-all-sdk 2.0.0 → 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 +515 -5
- package/dist/index.d.ts +515 -5
- 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
|
/**
|
|
@@ -6603,6 +6693,7 @@ interface components {
|
|
|
6603
6693
|
version?: number;
|
|
6604
6694
|
readonly item_count: number;
|
|
6605
6695
|
readonly line_items: components["schemas"]["CartLineItem"][];
|
|
6696
|
+
/** @description The discount coming off this cart, code-entered or auto-applied. */
|
|
6606
6697
|
readonly discount: {
|
|
6607
6698
|
[key: string]: unknown;
|
|
6608
6699
|
} | null;
|
|
@@ -6789,7 +6880,7 @@ interface components {
|
|
|
6789
6880
|
id: string;
|
|
6790
6881
|
/**
|
|
6791
6882
|
* Format: int64
|
|
6792
|
-
* @description
|
|
6883
|
+
* @description Store.id from the authenticated merchant
|
|
6793
6884
|
*/
|
|
6794
6885
|
store_id: number;
|
|
6795
6886
|
/**
|
|
@@ -6888,6 +6979,13 @@ interface components {
|
|
|
6888
6979
|
landing_path?: string;
|
|
6889
6980
|
referrer_host?: string;
|
|
6890
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
|
+
};
|
|
6891
6989
|
ComplianceChoice: {
|
|
6892
6990
|
slug: string;
|
|
6893
6991
|
label: string;
|
|
@@ -7345,7 +7443,7 @@ interface components {
|
|
|
7345
7443
|
id: string;
|
|
7346
7444
|
/**
|
|
7347
7445
|
* Format: int64
|
|
7348
|
-
* @description
|
|
7446
|
+
* @description Store.id from the authenticated merchant
|
|
7349
7447
|
*/
|
|
7350
7448
|
store_id: number;
|
|
7351
7449
|
/** @description 6-character alphanumeric code for sharing */
|
|
@@ -7857,6 +7955,13 @@ interface components {
|
|
|
7857
7955
|
* @enum {string}
|
|
7858
7956
|
*/
|
|
7859
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";
|
|
7860
7965
|
ModifyLineItem: {
|
|
7861
7966
|
/** Format: uuid */
|
|
7862
7967
|
order_line_item_id: string;
|
|
@@ -7930,7 +8035,7 @@ interface components {
|
|
|
7930
8035
|
order_number: string;
|
|
7931
8036
|
/**
|
|
7932
8037
|
* Format: int64
|
|
7933
|
-
* @description
|
|
8038
|
+
* @description Store.id from the authenticated merchant
|
|
7934
8039
|
*/
|
|
7935
8040
|
store_id: number;
|
|
7936
8041
|
/**
|
|
@@ -8812,6 +8917,10 @@ interface components {
|
|
|
8812
8917
|
timezone?: string;
|
|
8813
8918
|
is_active?: boolean;
|
|
8814
8919
|
};
|
|
8920
|
+
/** @description PATCH body for the company owner's availability switch. */
|
|
8921
|
+
PatchedSetCompanyAvailability: {
|
|
8922
|
+
is_available?: boolean;
|
|
8923
|
+
};
|
|
8815
8924
|
/**
|
|
8816
8925
|
* @description Validates the request body for setting delivery on a checkout.
|
|
8817
8926
|
*
|
|
@@ -8836,6 +8945,23 @@ interface components {
|
|
|
8836
8945
|
fulfillment_slot_id?: string;
|
|
8837
8946
|
pickup_location_id?: number;
|
|
8838
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
|
+
};
|
|
8839
8965
|
/**
|
|
8840
8966
|
* @description Read/write serializer for the store-onboarding wizard.
|
|
8841
8967
|
*
|
|
@@ -8989,6 +9115,29 @@ interface components {
|
|
|
8989
9115
|
value_reference?: number | null;
|
|
8990
9116
|
readonly selected_choices: components["schemas"]["AttributeChoice"][];
|
|
8991
9117
|
};
|
|
9118
|
+
/**
|
|
9119
|
+
* @description Display-only auto-applied-discount badge attached to a product.
|
|
9120
|
+
*
|
|
9121
|
+
* Named ``auto_discount`` rather than ``discount`` deliberately. The
|
|
9122
|
+
* storefront already has a per-product ``discount`` concept -- a unit-price
|
|
9123
|
+
* reduction that drives the effective price and the strikethrough -- and
|
|
9124
|
+
* reusing the name would have fed this badge straight into that
|
|
9125
|
+
* calculation.
|
|
9126
|
+
*
|
|
9127
|
+
* Shape-only serializer used for OpenAPI generation; the value is a plain
|
|
9128
|
+
* dict injected via serializer context (``product_discounts``) by the
|
|
9129
|
+
* ``core.product_context`` seam, not a model instance.
|
|
9130
|
+
*/
|
|
9131
|
+
ProductAutoDiscount: {
|
|
9132
|
+
id: string;
|
|
9133
|
+
name: string;
|
|
9134
|
+
discount_type: string;
|
|
9135
|
+
/** Format: decimal */
|
|
9136
|
+
value: string;
|
|
9137
|
+
currency: string;
|
|
9138
|
+
product_ids: number[];
|
|
9139
|
+
restrictions: components["schemas"]["_DiscountRestrictions"];
|
|
9140
|
+
};
|
|
8992
9141
|
ProductChannelListing: {
|
|
8993
9142
|
readonly id: number;
|
|
8994
9143
|
readonly product_id: number;
|
|
@@ -9069,6 +9218,7 @@ interface components {
|
|
|
9069
9218
|
readonly is_trending: boolean | null;
|
|
9070
9219
|
readonly trend_score: string | null;
|
|
9071
9220
|
readonly promotion: components["schemas"]["ProductPromotion"] | null;
|
|
9221
|
+
readonly auto_discount: components["schemas"]["ProductAutoDiscount"] | null;
|
|
9072
9222
|
/** Format: date-time */
|
|
9073
9223
|
readonly created_at: string;
|
|
9074
9224
|
/** Format: date-time */
|
|
@@ -9139,6 +9289,7 @@ interface components {
|
|
|
9139
9289
|
readonly is_trending: boolean | null;
|
|
9140
9290
|
readonly trend_score: string | null;
|
|
9141
9291
|
readonly promotion: components["schemas"]["ProductPromotion"] | null;
|
|
9292
|
+
readonly auto_discount: components["schemas"]["ProductAutoDiscount"] | null;
|
|
9142
9293
|
readonly images: components["schemas"]["ProductImage"][];
|
|
9143
9294
|
/** Format: date-time */
|
|
9144
9295
|
readonly created_at: string;
|
|
@@ -9876,6 +10027,20 @@ interface components {
|
|
|
9876
10027
|
readonly offers_reusable_packaging: boolean;
|
|
9877
10028
|
readonly reusable_deposit_amount?: string | null;
|
|
9878
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
|
+
};
|
|
9879
10044
|
StoreMeResponse: {
|
|
9880
10045
|
id: number;
|
|
9881
10046
|
public_id: string;
|
|
@@ -10124,10 +10289,11 @@ interface components {
|
|
|
10124
10289
|
* * `chargeback` - Chargeback
|
|
10125
10290
|
* * `refund_reverse` - Refund Reverse
|
|
10126
10291
|
* * `authorization_adjustment` - Authorization Adjustment
|
|
10292
|
+
* * `processing` - Processing
|
|
10127
10293
|
* * `info` - Info
|
|
10128
10294
|
* @enum {string}
|
|
10129
10295
|
*/
|
|
10130
|
-
TypeEnum: "authorization_request" | "authorization_success" | "authorization_failure" | "charge_request" | "charge_success" | "charge_failure" | "refund_request" | "refund_success" | "refund_failure" | "cancel_request" | "cancel_success" | "cancel_failure" | "chargeback" | "refund_reverse" | "authorization_adjustment" | "info";
|
|
10296
|
+
TypeEnum: "authorization_request" | "authorization_success" | "authorization_failure" | "charge_request" | "charge_success" | "charge_failure" | "refund_request" | "refund_success" | "refund_failure" | "cancel_request" | "cancel_success" | "cancel_failure" | "chargeback" | "refund_reverse" | "authorization_adjustment" | "processing" | "info";
|
|
10131
10297
|
/**
|
|
10132
10298
|
* @description * `kg` - kg
|
|
10133
10299
|
* * `l` - l
|
|
@@ -10274,6 +10440,23 @@ interface components {
|
|
|
10274
10440
|
euro_per_step: string;
|
|
10275
10441
|
balance_value: string;
|
|
10276
10442
|
};
|
|
10443
|
+
/** @description Schedule/scope block the storefront re-judges at render time. */
|
|
10444
|
+
_DiscountRestrictions: {
|
|
10445
|
+
/** @description IANA name the backend judges the schedule in. Re-judge the window against this, not against the browser clock or a locally configured merchant timezone. Null when this store has no usable configured timezone - keep your own fallback in that case, rather than treating the absence as a value. */
|
|
10446
|
+
timezone: string | null;
|
|
10447
|
+
/** Format: date-time */
|
|
10448
|
+
start_date: string | null;
|
|
10449
|
+
/** Format: date-time */
|
|
10450
|
+
end_date: string | null;
|
|
10451
|
+
allowed_fulfillment_types: string[];
|
|
10452
|
+
schedule_weekdays: number[];
|
|
10453
|
+
/** Format: time */
|
|
10454
|
+
schedule_start_time: string | null;
|
|
10455
|
+
/** Format: time */
|
|
10456
|
+
schedule_end_time: string | null;
|
|
10457
|
+
/** Format: decimal */
|
|
10458
|
+
min_order_amount: string | null;
|
|
10459
|
+
};
|
|
10277
10460
|
/** @description Nested serializer for line item entries in ProcessRefundSerializer. */
|
|
10278
10461
|
_LineItemInput: {
|
|
10279
10462
|
/** Format: uuid */
|
|
@@ -10292,6 +10475,8 @@ interface components {
|
|
|
10292
10475
|
* scope, channel) are added here without reshaping the top-level payload.
|
|
10293
10476
|
*/
|
|
10294
10477
|
_PromotionRestrictions: {
|
|
10478
|
+
/** @description IANA name the backend judges the schedule in. Re-judge the window against this, not against the browser clock or a locally configured merchant timezone. Null when this store has no usable configured timezone - keep your own fallback in that case, rather than treating the absence as a value. */
|
|
10479
|
+
timezone: string | null;
|
|
10295
10480
|
/** Format: date-time */
|
|
10296
10481
|
start_date: string | null;
|
|
10297
10482
|
/** Format: date-time */
|
|
@@ -10875,6 +11060,166 @@ interface operations {
|
|
|
10875
11060
|
};
|
|
10876
11061
|
};
|
|
10877
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
|
+
};
|
|
10878
11223
|
admin_discounts_list: {
|
|
10879
11224
|
parameters: {
|
|
10880
11225
|
query?: {
|
|
@@ -13734,6 +14079,171 @@ interface operations {
|
|
|
13734
14079
|
};
|
|
13735
14080
|
};
|
|
13736
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
|
+
};
|
|
13737
14247
|
admin_stores_surcharges_list: {
|
|
13738
14248
|
parameters: {
|
|
13739
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
|
/**
|
|
@@ -6603,6 +6693,7 @@ interface components {
|
|
|
6603
6693
|
version?: number;
|
|
6604
6694
|
readonly item_count: number;
|
|
6605
6695
|
readonly line_items: components["schemas"]["CartLineItem"][];
|
|
6696
|
+
/** @description The discount coming off this cart, code-entered or auto-applied. */
|
|
6606
6697
|
readonly discount: {
|
|
6607
6698
|
[key: string]: unknown;
|
|
6608
6699
|
} | null;
|
|
@@ -6789,7 +6880,7 @@ interface components {
|
|
|
6789
6880
|
id: string;
|
|
6790
6881
|
/**
|
|
6791
6882
|
* Format: int64
|
|
6792
|
-
* @description
|
|
6883
|
+
* @description Store.id from the authenticated merchant
|
|
6793
6884
|
*/
|
|
6794
6885
|
store_id: number;
|
|
6795
6886
|
/**
|
|
@@ -6888,6 +6979,13 @@ interface components {
|
|
|
6888
6979
|
landing_path?: string;
|
|
6889
6980
|
referrer_host?: string;
|
|
6890
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
|
+
};
|
|
6891
6989
|
ComplianceChoice: {
|
|
6892
6990
|
slug: string;
|
|
6893
6991
|
label: string;
|
|
@@ -7345,7 +7443,7 @@ interface components {
|
|
|
7345
7443
|
id: string;
|
|
7346
7444
|
/**
|
|
7347
7445
|
* Format: int64
|
|
7348
|
-
* @description
|
|
7446
|
+
* @description Store.id from the authenticated merchant
|
|
7349
7447
|
*/
|
|
7350
7448
|
store_id: number;
|
|
7351
7449
|
/** @description 6-character alphanumeric code for sharing */
|
|
@@ -7857,6 +7955,13 @@ interface components {
|
|
|
7857
7955
|
* @enum {string}
|
|
7858
7956
|
*/
|
|
7859
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";
|
|
7860
7965
|
ModifyLineItem: {
|
|
7861
7966
|
/** Format: uuid */
|
|
7862
7967
|
order_line_item_id: string;
|
|
@@ -7930,7 +8035,7 @@ interface components {
|
|
|
7930
8035
|
order_number: string;
|
|
7931
8036
|
/**
|
|
7932
8037
|
* Format: int64
|
|
7933
|
-
* @description
|
|
8038
|
+
* @description Store.id from the authenticated merchant
|
|
7934
8039
|
*/
|
|
7935
8040
|
store_id: number;
|
|
7936
8041
|
/**
|
|
@@ -8812,6 +8917,10 @@ interface components {
|
|
|
8812
8917
|
timezone?: string;
|
|
8813
8918
|
is_active?: boolean;
|
|
8814
8919
|
};
|
|
8920
|
+
/** @description PATCH body for the company owner's availability switch. */
|
|
8921
|
+
PatchedSetCompanyAvailability: {
|
|
8922
|
+
is_available?: boolean;
|
|
8923
|
+
};
|
|
8815
8924
|
/**
|
|
8816
8925
|
* @description Validates the request body for setting delivery on a checkout.
|
|
8817
8926
|
*
|
|
@@ -8836,6 +8945,23 @@ interface components {
|
|
|
8836
8945
|
fulfillment_slot_id?: string;
|
|
8837
8946
|
pickup_location_id?: number;
|
|
8838
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
|
+
};
|
|
8839
8965
|
/**
|
|
8840
8966
|
* @description Read/write serializer for the store-onboarding wizard.
|
|
8841
8967
|
*
|
|
@@ -8989,6 +9115,29 @@ interface components {
|
|
|
8989
9115
|
value_reference?: number | null;
|
|
8990
9116
|
readonly selected_choices: components["schemas"]["AttributeChoice"][];
|
|
8991
9117
|
};
|
|
9118
|
+
/**
|
|
9119
|
+
* @description Display-only auto-applied-discount badge attached to a product.
|
|
9120
|
+
*
|
|
9121
|
+
* Named ``auto_discount`` rather than ``discount`` deliberately. The
|
|
9122
|
+
* storefront already has a per-product ``discount`` concept -- a unit-price
|
|
9123
|
+
* reduction that drives the effective price and the strikethrough -- and
|
|
9124
|
+
* reusing the name would have fed this badge straight into that
|
|
9125
|
+
* calculation.
|
|
9126
|
+
*
|
|
9127
|
+
* Shape-only serializer used for OpenAPI generation; the value is a plain
|
|
9128
|
+
* dict injected via serializer context (``product_discounts``) by the
|
|
9129
|
+
* ``core.product_context`` seam, not a model instance.
|
|
9130
|
+
*/
|
|
9131
|
+
ProductAutoDiscount: {
|
|
9132
|
+
id: string;
|
|
9133
|
+
name: string;
|
|
9134
|
+
discount_type: string;
|
|
9135
|
+
/** Format: decimal */
|
|
9136
|
+
value: string;
|
|
9137
|
+
currency: string;
|
|
9138
|
+
product_ids: number[];
|
|
9139
|
+
restrictions: components["schemas"]["_DiscountRestrictions"];
|
|
9140
|
+
};
|
|
8992
9141
|
ProductChannelListing: {
|
|
8993
9142
|
readonly id: number;
|
|
8994
9143
|
readonly product_id: number;
|
|
@@ -9069,6 +9218,7 @@ interface components {
|
|
|
9069
9218
|
readonly is_trending: boolean | null;
|
|
9070
9219
|
readonly trend_score: string | null;
|
|
9071
9220
|
readonly promotion: components["schemas"]["ProductPromotion"] | null;
|
|
9221
|
+
readonly auto_discount: components["schemas"]["ProductAutoDiscount"] | null;
|
|
9072
9222
|
/** Format: date-time */
|
|
9073
9223
|
readonly created_at: string;
|
|
9074
9224
|
/** Format: date-time */
|
|
@@ -9139,6 +9289,7 @@ interface components {
|
|
|
9139
9289
|
readonly is_trending: boolean | null;
|
|
9140
9290
|
readonly trend_score: string | null;
|
|
9141
9291
|
readonly promotion: components["schemas"]["ProductPromotion"] | null;
|
|
9292
|
+
readonly auto_discount: components["schemas"]["ProductAutoDiscount"] | null;
|
|
9142
9293
|
readonly images: components["schemas"]["ProductImage"][];
|
|
9143
9294
|
/** Format: date-time */
|
|
9144
9295
|
readonly created_at: string;
|
|
@@ -9876,6 +10027,20 @@ interface components {
|
|
|
9876
10027
|
readonly offers_reusable_packaging: boolean;
|
|
9877
10028
|
readonly reusable_deposit_amount?: string | null;
|
|
9878
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
|
+
};
|
|
9879
10044
|
StoreMeResponse: {
|
|
9880
10045
|
id: number;
|
|
9881
10046
|
public_id: string;
|
|
@@ -10124,10 +10289,11 @@ interface components {
|
|
|
10124
10289
|
* * `chargeback` - Chargeback
|
|
10125
10290
|
* * `refund_reverse` - Refund Reverse
|
|
10126
10291
|
* * `authorization_adjustment` - Authorization Adjustment
|
|
10292
|
+
* * `processing` - Processing
|
|
10127
10293
|
* * `info` - Info
|
|
10128
10294
|
* @enum {string}
|
|
10129
10295
|
*/
|
|
10130
|
-
TypeEnum: "authorization_request" | "authorization_success" | "authorization_failure" | "charge_request" | "charge_success" | "charge_failure" | "refund_request" | "refund_success" | "refund_failure" | "cancel_request" | "cancel_success" | "cancel_failure" | "chargeback" | "refund_reverse" | "authorization_adjustment" | "info";
|
|
10296
|
+
TypeEnum: "authorization_request" | "authorization_success" | "authorization_failure" | "charge_request" | "charge_success" | "charge_failure" | "refund_request" | "refund_success" | "refund_failure" | "cancel_request" | "cancel_success" | "cancel_failure" | "chargeback" | "refund_reverse" | "authorization_adjustment" | "processing" | "info";
|
|
10131
10297
|
/**
|
|
10132
10298
|
* @description * `kg` - kg
|
|
10133
10299
|
* * `l` - l
|
|
@@ -10274,6 +10440,23 @@ interface components {
|
|
|
10274
10440
|
euro_per_step: string;
|
|
10275
10441
|
balance_value: string;
|
|
10276
10442
|
};
|
|
10443
|
+
/** @description Schedule/scope block the storefront re-judges at render time. */
|
|
10444
|
+
_DiscountRestrictions: {
|
|
10445
|
+
/** @description IANA name the backend judges the schedule in. Re-judge the window against this, not against the browser clock or a locally configured merchant timezone. Null when this store has no usable configured timezone - keep your own fallback in that case, rather than treating the absence as a value. */
|
|
10446
|
+
timezone: string | null;
|
|
10447
|
+
/** Format: date-time */
|
|
10448
|
+
start_date: string | null;
|
|
10449
|
+
/** Format: date-time */
|
|
10450
|
+
end_date: string | null;
|
|
10451
|
+
allowed_fulfillment_types: string[];
|
|
10452
|
+
schedule_weekdays: number[];
|
|
10453
|
+
/** Format: time */
|
|
10454
|
+
schedule_start_time: string | null;
|
|
10455
|
+
/** Format: time */
|
|
10456
|
+
schedule_end_time: string | null;
|
|
10457
|
+
/** Format: decimal */
|
|
10458
|
+
min_order_amount: string | null;
|
|
10459
|
+
};
|
|
10277
10460
|
/** @description Nested serializer for line item entries in ProcessRefundSerializer. */
|
|
10278
10461
|
_LineItemInput: {
|
|
10279
10462
|
/** Format: uuid */
|
|
@@ -10292,6 +10475,8 @@ interface components {
|
|
|
10292
10475
|
* scope, channel) are added here without reshaping the top-level payload.
|
|
10293
10476
|
*/
|
|
10294
10477
|
_PromotionRestrictions: {
|
|
10478
|
+
/** @description IANA name the backend judges the schedule in. Re-judge the window against this, not against the browser clock or a locally configured merchant timezone. Null when this store has no usable configured timezone - keep your own fallback in that case, rather than treating the absence as a value. */
|
|
10479
|
+
timezone: string | null;
|
|
10295
10480
|
/** Format: date-time */
|
|
10296
10481
|
start_date: string | null;
|
|
10297
10482
|
/** Format: date-time */
|
|
@@ -10875,6 +11060,166 @@ interface operations {
|
|
|
10875
11060
|
};
|
|
10876
11061
|
};
|
|
10877
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
|
+
};
|
|
10878
11223
|
admin_discounts_list: {
|
|
10879
11224
|
parameters: {
|
|
10880
11225
|
query?: {
|
|
@@ -13734,6 +14079,171 @@ interface operations {
|
|
|
13734
14079
|
};
|
|
13735
14080
|
};
|
|
13736
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
|
+
};
|
|
13737
14247
|
admin_stores_surcharges_list: {
|
|
13738
14248
|
parameters: {
|
|
13739
14249
|
query?: never;
|