@poweredbysous/storefront-all-sdk 4.10.0 → 4.11.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 +99 -0
- package/dist/index.d.ts +99 -0
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -3232,6 +3232,31 @@ interface paths {
|
|
|
3232
3232
|
patch?: never;
|
|
3233
3233
|
trace?: never;
|
|
3234
3234
|
};
|
|
3235
|
+
"/api/v1/discovery/shopify-products/{handle}/": {
|
|
3236
|
+
parameters: {
|
|
3237
|
+
query?: never;
|
|
3238
|
+
header?: never;
|
|
3239
|
+
path?: never;
|
|
3240
|
+
cookie?: never;
|
|
3241
|
+
};
|
|
3242
|
+
/**
|
|
3243
|
+
* @description The ExploreSOUS dish an old Shopify product URL now answers with.
|
|
3244
|
+
*
|
|
3245
|
+
* The old storefront served each product at ``/products/<handle>``. The
|
|
3246
|
+
* product import remembers which SOUS product each handle became, so
|
|
3247
|
+
* ExploreSOUS can send that URL, with its search ranking, to the same dish
|
|
3248
|
+
* in one permanent redirect. A 404 is the answer for every handle with no
|
|
3249
|
+
* live dish, and the caller falls back to the partner or a search.
|
|
3250
|
+
*/
|
|
3251
|
+
get: operations["discovery_shopify_products_retrieve"];
|
|
3252
|
+
put?: never;
|
|
3253
|
+
post?: never;
|
|
3254
|
+
delete?: never;
|
|
3255
|
+
options?: never;
|
|
3256
|
+
head?: never;
|
|
3257
|
+
patch?: never;
|
|
3258
|
+
trace?: never;
|
|
3259
|
+
};
|
|
3235
3260
|
"/api/v1/discovery/store-routes/": {
|
|
3236
3261
|
parameters: {
|
|
3237
3262
|
query?: never;
|
|
@@ -6994,6 +7019,8 @@ interface components {
|
|
|
6994
7019
|
available_shipping_providers: components["schemas"]["ShippingProviderOption"][];
|
|
6995
7020
|
pickup_locations: components["schemas"]["AddressCheckPickupLocation"][];
|
|
6996
7021
|
delivery_unavailable: boolean;
|
|
7022
|
+
/** @description ISO country code of the address when the store's nationwide carriers all leave that country out, so the client can say the store does not deliver there. Null otherwise. */
|
|
7023
|
+
unserved_country: string | null;
|
|
6997
7024
|
near_delivery_zone: boolean;
|
|
6998
7025
|
};
|
|
6999
7026
|
AddressLookupResponse: {
|
|
@@ -8375,6 +8402,7 @@ interface components {
|
|
|
8375
8402
|
seo_title: string;
|
|
8376
8403
|
images: string[];
|
|
8377
8404
|
book_url: string;
|
|
8405
|
+
michelin_stars: number | null;
|
|
8378
8406
|
};
|
|
8379
8407
|
DiscoveryCollection: {
|
|
8380
8408
|
slug: string;
|
|
@@ -11442,6 +11470,8 @@ interface components {
|
|
|
11442
11470
|
remaining_for_free_shipping: string | null;
|
|
11443
11471
|
/** @description Products no carrier delivers to this address. The total does not cover them and checkout cannot route them, so the customer must remove them or change the address. Empty when every item ships. */
|
|
11444
11472
|
unshippable_product_ids: number[];
|
|
11473
|
+
/** @description ISO country code of the delivery address when every carrier of the unshippable products leaves that country out, so the client can say the store does not deliver there. Null otherwise. */
|
|
11474
|
+
unserved_country: string | null;
|
|
11445
11475
|
};
|
|
11446
11476
|
/**
|
|
11447
11477
|
* @description One carrier's share of the basket. Documentation only — never used to
|
|
@@ -11468,6 +11498,18 @@ interface components {
|
|
|
11468
11498
|
/** Format: decimal */
|
|
11469
11499
|
free_delivery_threshold: string | null;
|
|
11470
11500
|
};
|
|
11501
|
+
/**
|
|
11502
|
+
* @description Where an old Shopify product URL's dish lives on ExploreSOUS.
|
|
11503
|
+
*
|
|
11504
|
+
* ``/partners/{brand_slug}/{slug}/p/{product_id}`` on the ExploreSOUS site.
|
|
11505
|
+
*/
|
|
11506
|
+
ShopifyProductRoute: {
|
|
11507
|
+
brand_slug: string;
|
|
11508
|
+
slug: string;
|
|
11509
|
+
product_id: number;
|
|
11510
|
+
/** @description The dish's title in the request's language (``?lang=`` or ``Accept-Language``), with the product endpoint's fallback. */
|
|
11511
|
+
title: string;
|
|
11512
|
+
};
|
|
11471
11513
|
/**
|
|
11472
11514
|
* @description * `manual` - Manual
|
|
11473
11515
|
* * `auto` - Auto-translated
|
|
@@ -27034,6 +27076,63 @@ interface operations {
|
|
|
27034
27076
|
};
|
|
27035
27077
|
};
|
|
27036
27078
|
};
|
|
27079
|
+
discovery_shopify_products_retrieve: {
|
|
27080
|
+
parameters: {
|
|
27081
|
+
query?: never;
|
|
27082
|
+
header?: never;
|
|
27083
|
+
path: {
|
|
27084
|
+
handle: string;
|
|
27085
|
+
};
|
|
27086
|
+
cookie?: never;
|
|
27087
|
+
};
|
|
27088
|
+
requestBody?: never;
|
|
27089
|
+
responses: {
|
|
27090
|
+
200: {
|
|
27091
|
+
headers: {
|
|
27092
|
+
[name: string]: unknown;
|
|
27093
|
+
};
|
|
27094
|
+
content: {
|
|
27095
|
+
"application/json": components["schemas"]["ShopifyProductRoute"];
|
|
27096
|
+
};
|
|
27097
|
+
};
|
|
27098
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27099
|
+
400: {
|
|
27100
|
+
headers: {
|
|
27101
|
+
[name: string]: unknown;
|
|
27102
|
+
};
|
|
27103
|
+
content: {
|
|
27104
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27105
|
+
};
|
|
27106
|
+
};
|
|
27107
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27108
|
+
404: {
|
|
27109
|
+
headers: {
|
|
27110
|
+
[name: string]: unknown;
|
|
27111
|
+
};
|
|
27112
|
+
content: {
|
|
27113
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27114
|
+
};
|
|
27115
|
+
};
|
|
27116
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27117
|
+
429: {
|
|
27118
|
+
headers: {
|
|
27119
|
+
[name: string]: unknown;
|
|
27120
|
+
};
|
|
27121
|
+
content: {
|
|
27122
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27123
|
+
};
|
|
27124
|
+
};
|
|
27125
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27126
|
+
500: {
|
|
27127
|
+
headers: {
|
|
27128
|
+
[name: string]: unknown;
|
|
27129
|
+
};
|
|
27130
|
+
content: {
|
|
27131
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27132
|
+
};
|
|
27133
|
+
};
|
|
27134
|
+
};
|
|
27135
|
+
};
|
|
27037
27136
|
discovery_store_routes_retrieve: {
|
|
27038
27137
|
parameters: {
|
|
27039
27138
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -3232,6 +3232,31 @@ interface paths {
|
|
|
3232
3232
|
patch?: never;
|
|
3233
3233
|
trace?: never;
|
|
3234
3234
|
};
|
|
3235
|
+
"/api/v1/discovery/shopify-products/{handle}/": {
|
|
3236
|
+
parameters: {
|
|
3237
|
+
query?: never;
|
|
3238
|
+
header?: never;
|
|
3239
|
+
path?: never;
|
|
3240
|
+
cookie?: never;
|
|
3241
|
+
};
|
|
3242
|
+
/**
|
|
3243
|
+
* @description The ExploreSOUS dish an old Shopify product URL now answers with.
|
|
3244
|
+
*
|
|
3245
|
+
* The old storefront served each product at ``/products/<handle>``. The
|
|
3246
|
+
* product import remembers which SOUS product each handle became, so
|
|
3247
|
+
* ExploreSOUS can send that URL, with its search ranking, to the same dish
|
|
3248
|
+
* in one permanent redirect. A 404 is the answer for every handle with no
|
|
3249
|
+
* live dish, and the caller falls back to the partner or a search.
|
|
3250
|
+
*/
|
|
3251
|
+
get: operations["discovery_shopify_products_retrieve"];
|
|
3252
|
+
put?: never;
|
|
3253
|
+
post?: never;
|
|
3254
|
+
delete?: never;
|
|
3255
|
+
options?: never;
|
|
3256
|
+
head?: never;
|
|
3257
|
+
patch?: never;
|
|
3258
|
+
trace?: never;
|
|
3259
|
+
};
|
|
3235
3260
|
"/api/v1/discovery/store-routes/": {
|
|
3236
3261
|
parameters: {
|
|
3237
3262
|
query?: never;
|
|
@@ -6994,6 +7019,8 @@ interface components {
|
|
|
6994
7019
|
available_shipping_providers: components["schemas"]["ShippingProviderOption"][];
|
|
6995
7020
|
pickup_locations: components["schemas"]["AddressCheckPickupLocation"][];
|
|
6996
7021
|
delivery_unavailable: boolean;
|
|
7022
|
+
/** @description ISO country code of the address when the store's nationwide carriers all leave that country out, so the client can say the store does not deliver there. Null otherwise. */
|
|
7023
|
+
unserved_country: string | null;
|
|
6997
7024
|
near_delivery_zone: boolean;
|
|
6998
7025
|
};
|
|
6999
7026
|
AddressLookupResponse: {
|
|
@@ -8375,6 +8402,7 @@ interface components {
|
|
|
8375
8402
|
seo_title: string;
|
|
8376
8403
|
images: string[];
|
|
8377
8404
|
book_url: string;
|
|
8405
|
+
michelin_stars: number | null;
|
|
8378
8406
|
};
|
|
8379
8407
|
DiscoveryCollection: {
|
|
8380
8408
|
slug: string;
|
|
@@ -11442,6 +11470,8 @@ interface components {
|
|
|
11442
11470
|
remaining_for_free_shipping: string | null;
|
|
11443
11471
|
/** @description Products no carrier delivers to this address. The total does not cover them and checkout cannot route them, so the customer must remove them or change the address. Empty when every item ships. */
|
|
11444
11472
|
unshippable_product_ids: number[];
|
|
11473
|
+
/** @description ISO country code of the delivery address when every carrier of the unshippable products leaves that country out, so the client can say the store does not deliver there. Null otherwise. */
|
|
11474
|
+
unserved_country: string | null;
|
|
11445
11475
|
};
|
|
11446
11476
|
/**
|
|
11447
11477
|
* @description One carrier's share of the basket. Documentation only — never used to
|
|
@@ -11468,6 +11498,18 @@ interface components {
|
|
|
11468
11498
|
/** Format: decimal */
|
|
11469
11499
|
free_delivery_threshold: string | null;
|
|
11470
11500
|
};
|
|
11501
|
+
/**
|
|
11502
|
+
* @description Where an old Shopify product URL's dish lives on ExploreSOUS.
|
|
11503
|
+
*
|
|
11504
|
+
* ``/partners/{brand_slug}/{slug}/p/{product_id}`` on the ExploreSOUS site.
|
|
11505
|
+
*/
|
|
11506
|
+
ShopifyProductRoute: {
|
|
11507
|
+
brand_slug: string;
|
|
11508
|
+
slug: string;
|
|
11509
|
+
product_id: number;
|
|
11510
|
+
/** @description The dish's title in the request's language (``?lang=`` or ``Accept-Language``), with the product endpoint's fallback. */
|
|
11511
|
+
title: string;
|
|
11512
|
+
};
|
|
11471
11513
|
/**
|
|
11472
11514
|
* @description * `manual` - Manual
|
|
11473
11515
|
* * `auto` - Auto-translated
|
|
@@ -27034,6 +27076,63 @@ interface operations {
|
|
|
27034
27076
|
};
|
|
27035
27077
|
};
|
|
27036
27078
|
};
|
|
27079
|
+
discovery_shopify_products_retrieve: {
|
|
27080
|
+
parameters: {
|
|
27081
|
+
query?: never;
|
|
27082
|
+
header?: never;
|
|
27083
|
+
path: {
|
|
27084
|
+
handle: string;
|
|
27085
|
+
};
|
|
27086
|
+
cookie?: never;
|
|
27087
|
+
};
|
|
27088
|
+
requestBody?: never;
|
|
27089
|
+
responses: {
|
|
27090
|
+
200: {
|
|
27091
|
+
headers: {
|
|
27092
|
+
[name: string]: unknown;
|
|
27093
|
+
};
|
|
27094
|
+
content: {
|
|
27095
|
+
"application/json": components["schemas"]["ShopifyProductRoute"];
|
|
27096
|
+
};
|
|
27097
|
+
};
|
|
27098
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27099
|
+
400: {
|
|
27100
|
+
headers: {
|
|
27101
|
+
[name: string]: unknown;
|
|
27102
|
+
};
|
|
27103
|
+
content: {
|
|
27104
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27105
|
+
};
|
|
27106
|
+
};
|
|
27107
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27108
|
+
404: {
|
|
27109
|
+
headers: {
|
|
27110
|
+
[name: string]: unknown;
|
|
27111
|
+
};
|
|
27112
|
+
content: {
|
|
27113
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27114
|
+
};
|
|
27115
|
+
};
|
|
27116
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27117
|
+
429: {
|
|
27118
|
+
headers: {
|
|
27119
|
+
[name: string]: unknown;
|
|
27120
|
+
};
|
|
27121
|
+
content: {
|
|
27122
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27123
|
+
};
|
|
27124
|
+
};
|
|
27125
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27126
|
+
500: {
|
|
27127
|
+
headers: {
|
|
27128
|
+
[name: string]: unknown;
|
|
27129
|
+
};
|
|
27130
|
+
content: {
|
|
27131
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27132
|
+
};
|
|
27133
|
+
};
|
|
27134
|
+
};
|
|
27135
|
+
};
|
|
27037
27136
|
discovery_store_routes_retrieve: {
|
|
27038
27137
|
parameters: {
|
|
27039
27138
|
query?: never;
|