@poweredbysous/storefront-all-sdk 4.9.0 → 4.10.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 -5
- package/dist/index.d.ts +99 -5
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -3154,6 +3154,13 @@ interface paths {
|
|
|
3154
3154
|
*
|
|
3155
3155
|
* Meilisearch unreachable answers 502 rather than an empty page, so
|
|
3156
3156
|
* "nothing matches" and "search is down" never look the same.
|
|
3157
|
+
*
|
|
3158
|
+
* A 200 is cacheable by shared caches for a minute (``CACHE_CONTROL_OK``).
|
|
3159
|
+
* That is safe because the body is a function of the URL and the language
|
|
3160
|
+
* only: there are no authentication classes, no cookie is read or set, and
|
|
3161
|
+
* the store ids it may carry are public identifiers. Search staleness is
|
|
3162
|
+
* acceptable by contract (add-to-cart re-checks fulfilment). Anything that
|
|
3163
|
+
* is not a 200 is ``no-store`` so an outage is never replayed from a cache.
|
|
3157
3164
|
*/
|
|
3158
3165
|
get: operations["discovery_marketplace_retrieve"];
|
|
3159
3166
|
put?: never;
|
|
@@ -3225,6 +3232,29 @@ interface paths {
|
|
|
3225
3232
|
patch?: never;
|
|
3226
3233
|
trace?: never;
|
|
3227
3234
|
};
|
|
3235
|
+
"/api/v1/discovery/store-routes/": {
|
|
3236
|
+
parameters: {
|
|
3237
|
+
query?: never;
|
|
3238
|
+
header?: never;
|
|
3239
|
+
path?: never;
|
|
3240
|
+
cookie?: never;
|
|
3241
|
+
};
|
|
3242
|
+
/**
|
|
3243
|
+
* @description Each ExploreSOUS store's brand and location slug, for its page URL.
|
|
3244
|
+
*
|
|
3245
|
+
* ExploreSOUS serves a store at ``/brands/{brand_slug}/{slug}`` and resolves
|
|
3246
|
+
* both ways with this: a segment pair to the store, and an old
|
|
3247
|
+
* ``/stores/{public_id}`` link to its new address.
|
|
3248
|
+
*/
|
|
3249
|
+
get: operations["discovery_store_routes_retrieve"];
|
|
3250
|
+
put?: never;
|
|
3251
|
+
post?: never;
|
|
3252
|
+
delete?: never;
|
|
3253
|
+
options?: never;
|
|
3254
|
+
head?: never;
|
|
3255
|
+
patch?: never;
|
|
3256
|
+
trace?: never;
|
|
3257
|
+
};
|
|
3228
3258
|
"/api/v1/discovery/stores/": {
|
|
3229
3259
|
parameters: {
|
|
3230
3260
|
query?: never;
|
|
@@ -7659,12 +7689,12 @@ interface components {
|
|
|
7659
7689
|
[key: string]: unknown;
|
|
7660
7690
|
}[];
|
|
7661
7691
|
/**
|
|
7662
|
-
* @description How many products this category shows, descendants included.
|
|
7692
|
+
* @description How many products this category's listing shows, descendants included.
|
|
7663
7693
|
*
|
|
7664
|
-
*
|
|
7665
|
-
* (``views._build_product_counts``) and
|
|
7666
|
-
*
|
|
7667
|
-
*
|
|
7694
|
+
* Precomputed for every category in one pass
|
|
7695
|
+
* (``views._build_product_counts``) and passed in context, on both list
|
|
7696
|
+
* and retrieve: counting here instead would count products the listing
|
|
7697
|
+
* leaves out.
|
|
7668
7698
|
*/
|
|
7669
7699
|
readonly product_count: number;
|
|
7670
7700
|
};
|
|
@@ -8385,6 +8415,15 @@ interface components {
|
|
|
8385
8415
|
DiscoveryStoreMembership: {
|
|
8386
8416
|
store_ids: string[];
|
|
8387
8417
|
};
|
|
8418
|
+
DiscoveryStoreRoute: {
|
|
8419
|
+
public_id: string;
|
|
8420
|
+
brand_slug: string | null;
|
|
8421
|
+
slug: string | null;
|
|
8422
|
+
};
|
|
8423
|
+
/** @description Each ExploreSOUS store's ``/brands/{brand_slug}/{slug}`` address. */
|
|
8424
|
+
DiscoveryStoreRoutes: {
|
|
8425
|
+
stores: components["schemas"]["DiscoveryStoreRoute"][];
|
|
8426
|
+
};
|
|
8388
8427
|
/** @description One filter option, already named in the reader's language. */
|
|
8389
8428
|
DiscoveryTag: {
|
|
8390
8429
|
slug: string;
|
|
@@ -26995,6 +27034,61 @@ interface operations {
|
|
|
26995
27034
|
};
|
|
26996
27035
|
};
|
|
26997
27036
|
};
|
|
27037
|
+
discovery_store_routes_retrieve: {
|
|
27038
|
+
parameters: {
|
|
27039
|
+
query?: never;
|
|
27040
|
+
header?: never;
|
|
27041
|
+
path?: never;
|
|
27042
|
+
cookie?: never;
|
|
27043
|
+
};
|
|
27044
|
+
requestBody?: never;
|
|
27045
|
+
responses: {
|
|
27046
|
+
200: {
|
|
27047
|
+
headers: {
|
|
27048
|
+
[name: string]: unknown;
|
|
27049
|
+
};
|
|
27050
|
+
content: {
|
|
27051
|
+
"application/json": components["schemas"]["DiscoveryStoreRoutes"];
|
|
27052
|
+
};
|
|
27053
|
+
};
|
|
27054
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27055
|
+
400: {
|
|
27056
|
+
headers: {
|
|
27057
|
+
[name: string]: unknown;
|
|
27058
|
+
};
|
|
27059
|
+
content: {
|
|
27060
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27061
|
+
};
|
|
27062
|
+
};
|
|
27063
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27064
|
+
404: {
|
|
27065
|
+
headers: {
|
|
27066
|
+
[name: string]: unknown;
|
|
27067
|
+
};
|
|
27068
|
+
content: {
|
|
27069
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27070
|
+
};
|
|
27071
|
+
};
|
|
27072
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27073
|
+
429: {
|
|
27074
|
+
headers: {
|
|
27075
|
+
[name: string]: unknown;
|
|
27076
|
+
};
|
|
27077
|
+
content: {
|
|
27078
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27079
|
+
};
|
|
27080
|
+
};
|
|
27081
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27082
|
+
500: {
|
|
27083
|
+
headers: {
|
|
27084
|
+
[name: string]: unknown;
|
|
27085
|
+
};
|
|
27086
|
+
content: {
|
|
27087
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27088
|
+
};
|
|
27089
|
+
};
|
|
27090
|
+
};
|
|
27091
|
+
};
|
|
26998
27092
|
discovery_stores_retrieve: {
|
|
26999
27093
|
parameters: {
|
|
27000
27094
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -3154,6 +3154,13 @@ interface paths {
|
|
|
3154
3154
|
*
|
|
3155
3155
|
* Meilisearch unreachable answers 502 rather than an empty page, so
|
|
3156
3156
|
* "nothing matches" and "search is down" never look the same.
|
|
3157
|
+
*
|
|
3158
|
+
* A 200 is cacheable by shared caches for a minute (``CACHE_CONTROL_OK``).
|
|
3159
|
+
* That is safe because the body is a function of the URL and the language
|
|
3160
|
+
* only: there are no authentication classes, no cookie is read or set, and
|
|
3161
|
+
* the store ids it may carry are public identifiers. Search staleness is
|
|
3162
|
+
* acceptable by contract (add-to-cart re-checks fulfilment). Anything that
|
|
3163
|
+
* is not a 200 is ``no-store`` so an outage is never replayed from a cache.
|
|
3157
3164
|
*/
|
|
3158
3165
|
get: operations["discovery_marketplace_retrieve"];
|
|
3159
3166
|
put?: never;
|
|
@@ -3225,6 +3232,29 @@ interface paths {
|
|
|
3225
3232
|
patch?: never;
|
|
3226
3233
|
trace?: never;
|
|
3227
3234
|
};
|
|
3235
|
+
"/api/v1/discovery/store-routes/": {
|
|
3236
|
+
parameters: {
|
|
3237
|
+
query?: never;
|
|
3238
|
+
header?: never;
|
|
3239
|
+
path?: never;
|
|
3240
|
+
cookie?: never;
|
|
3241
|
+
};
|
|
3242
|
+
/**
|
|
3243
|
+
* @description Each ExploreSOUS store's brand and location slug, for its page URL.
|
|
3244
|
+
*
|
|
3245
|
+
* ExploreSOUS serves a store at ``/brands/{brand_slug}/{slug}`` and resolves
|
|
3246
|
+
* both ways with this: a segment pair to the store, and an old
|
|
3247
|
+
* ``/stores/{public_id}`` link to its new address.
|
|
3248
|
+
*/
|
|
3249
|
+
get: operations["discovery_store_routes_retrieve"];
|
|
3250
|
+
put?: never;
|
|
3251
|
+
post?: never;
|
|
3252
|
+
delete?: never;
|
|
3253
|
+
options?: never;
|
|
3254
|
+
head?: never;
|
|
3255
|
+
patch?: never;
|
|
3256
|
+
trace?: never;
|
|
3257
|
+
};
|
|
3228
3258
|
"/api/v1/discovery/stores/": {
|
|
3229
3259
|
parameters: {
|
|
3230
3260
|
query?: never;
|
|
@@ -7659,12 +7689,12 @@ interface components {
|
|
|
7659
7689
|
[key: string]: unknown;
|
|
7660
7690
|
}[];
|
|
7661
7691
|
/**
|
|
7662
|
-
* @description How many products this category shows, descendants included.
|
|
7692
|
+
* @description How many products this category's listing shows, descendants included.
|
|
7663
7693
|
*
|
|
7664
|
-
*
|
|
7665
|
-
* (``views._build_product_counts``) and
|
|
7666
|
-
*
|
|
7667
|
-
*
|
|
7694
|
+
* Precomputed for every category in one pass
|
|
7695
|
+
* (``views._build_product_counts``) and passed in context, on both list
|
|
7696
|
+
* and retrieve: counting here instead would count products the listing
|
|
7697
|
+
* leaves out.
|
|
7668
7698
|
*/
|
|
7669
7699
|
readonly product_count: number;
|
|
7670
7700
|
};
|
|
@@ -8385,6 +8415,15 @@ interface components {
|
|
|
8385
8415
|
DiscoveryStoreMembership: {
|
|
8386
8416
|
store_ids: string[];
|
|
8387
8417
|
};
|
|
8418
|
+
DiscoveryStoreRoute: {
|
|
8419
|
+
public_id: string;
|
|
8420
|
+
brand_slug: string | null;
|
|
8421
|
+
slug: string | null;
|
|
8422
|
+
};
|
|
8423
|
+
/** @description Each ExploreSOUS store's ``/brands/{brand_slug}/{slug}`` address. */
|
|
8424
|
+
DiscoveryStoreRoutes: {
|
|
8425
|
+
stores: components["schemas"]["DiscoveryStoreRoute"][];
|
|
8426
|
+
};
|
|
8388
8427
|
/** @description One filter option, already named in the reader's language. */
|
|
8389
8428
|
DiscoveryTag: {
|
|
8390
8429
|
slug: string;
|
|
@@ -26995,6 +27034,61 @@ interface operations {
|
|
|
26995
27034
|
};
|
|
26996
27035
|
};
|
|
26997
27036
|
};
|
|
27037
|
+
discovery_store_routes_retrieve: {
|
|
27038
|
+
parameters: {
|
|
27039
|
+
query?: never;
|
|
27040
|
+
header?: never;
|
|
27041
|
+
path?: never;
|
|
27042
|
+
cookie?: never;
|
|
27043
|
+
};
|
|
27044
|
+
requestBody?: never;
|
|
27045
|
+
responses: {
|
|
27046
|
+
200: {
|
|
27047
|
+
headers: {
|
|
27048
|
+
[name: string]: unknown;
|
|
27049
|
+
};
|
|
27050
|
+
content: {
|
|
27051
|
+
"application/json": components["schemas"]["DiscoveryStoreRoutes"];
|
|
27052
|
+
};
|
|
27053
|
+
};
|
|
27054
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27055
|
+
400: {
|
|
27056
|
+
headers: {
|
|
27057
|
+
[name: string]: unknown;
|
|
27058
|
+
};
|
|
27059
|
+
content: {
|
|
27060
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27061
|
+
};
|
|
27062
|
+
};
|
|
27063
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27064
|
+
404: {
|
|
27065
|
+
headers: {
|
|
27066
|
+
[name: string]: unknown;
|
|
27067
|
+
};
|
|
27068
|
+
content: {
|
|
27069
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27070
|
+
};
|
|
27071
|
+
};
|
|
27072
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27073
|
+
429: {
|
|
27074
|
+
headers: {
|
|
27075
|
+
[name: string]: unknown;
|
|
27076
|
+
};
|
|
27077
|
+
content: {
|
|
27078
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27079
|
+
};
|
|
27080
|
+
};
|
|
27081
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27082
|
+
500: {
|
|
27083
|
+
headers: {
|
|
27084
|
+
[name: string]: unknown;
|
|
27085
|
+
};
|
|
27086
|
+
content: {
|
|
27087
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27088
|
+
};
|
|
27089
|
+
};
|
|
27090
|
+
};
|
|
27091
|
+
};
|
|
26998
27092
|
discovery_stores_retrieve: {
|
|
26999
27093
|
parameters: {
|
|
27000
27094
|
query?: never;
|