@poweredbysous/storefront-all-sdk 4.7.0 → 4.9.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 +980 -39
- package/dist/index.d.ts +980 -39
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -520,6 +520,63 @@ interface paths {
|
|
|
520
520
|
patch?: never;
|
|
521
521
|
trace?: never;
|
|
522
522
|
};
|
|
523
|
+
"/api/v1/admin/printing/jobs/": {
|
|
524
|
+
parameters: {
|
|
525
|
+
query?: never;
|
|
526
|
+
header?: never;
|
|
527
|
+
path?: never;
|
|
528
|
+
cookie?: never;
|
|
529
|
+
};
|
|
530
|
+
/** @description The latest print job per printer for an order: did it print? */
|
|
531
|
+
get: operations["admin_printing_order_jobs"];
|
|
532
|
+
put?: never;
|
|
533
|
+
post?: never;
|
|
534
|
+
delete?: never;
|
|
535
|
+
options?: never;
|
|
536
|
+
head?: never;
|
|
537
|
+
patch?: never;
|
|
538
|
+
trace?: never;
|
|
539
|
+
};
|
|
540
|
+
"/api/v1/admin/printing/print-order/": {
|
|
541
|
+
parameters: {
|
|
542
|
+
query?: never;
|
|
543
|
+
header?: never;
|
|
544
|
+
path?: never;
|
|
545
|
+
cookie?: never;
|
|
546
|
+
};
|
|
547
|
+
get?: never;
|
|
548
|
+
put?: never;
|
|
549
|
+
/**
|
|
550
|
+
* @description Print an order again on the store's cloud printers.
|
|
551
|
+
*
|
|
552
|
+
* 202 with the jobs created (or, for a repeated ``request_id``, the jobs the
|
|
553
|
+
* first request created). 409 when the store has no enabled printer for the
|
|
554
|
+
* order's kitchen, so the portal can fall back to printing locally.
|
|
555
|
+
*/
|
|
556
|
+
post: operations["admin_printing_print_order"];
|
|
557
|
+
delete?: never;
|
|
558
|
+
options?: never;
|
|
559
|
+
head?: never;
|
|
560
|
+
patch?: never;
|
|
561
|
+
trace?: never;
|
|
562
|
+
};
|
|
563
|
+
"/api/v1/admin/printing/stores/{store_public_id}/devices/": {
|
|
564
|
+
parameters: {
|
|
565
|
+
query?: never;
|
|
566
|
+
header?: never;
|
|
567
|
+
path?: never;
|
|
568
|
+
cookie?: never;
|
|
569
|
+
};
|
|
570
|
+
/** @description The store's enabled cloud printers. An empty list: no cloud printing. */
|
|
571
|
+
get: operations["admin_printing_store_devices"];
|
|
572
|
+
put?: never;
|
|
573
|
+
post?: never;
|
|
574
|
+
delete?: never;
|
|
575
|
+
options?: never;
|
|
576
|
+
head?: never;
|
|
577
|
+
patch?: never;
|
|
578
|
+
trace?: never;
|
|
579
|
+
};
|
|
523
580
|
"/api/v1/admin/products/": {
|
|
524
581
|
parameters: {
|
|
525
582
|
query?: never;
|
|
@@ -3192,6 +3249,107 @@ interface paths {
|
|
|
3192
3249
|
patch?: never;
|
|
3193
3250
|
trace?: never;
|
|
3194
3251
|
};
|
|
3252
|
+
"/api/v1/exploresous/consent/": {
|
|
3253
|
+
parameters: {
|
|
3254
|
+
query?: never;
|
|
3255
|
+
header?: never;
|
|
3256
|
+
path?: never;
|
|
3257
|
+
cookie?: never;
|
|
3258
|
+
};
|
|
3259
|
+
/**
|
|
3260
|
+
* @description GET / PUT /api/v1/exploresous/consent/ - the signed-in customer's choices.
|
|
3261
|
+
*
|
|
3262
|
+
* Always the account the token belongs to; no id is read from the request.
|
|
3263
|
+
*/
|
|
3264
|
+
get: operations["exploresous_consent_retrieve"];
|
|
3265
|
+
/**
|
|
3266
|
+
* @description GET / PUT /api/v1/exploresous/consent/ - the signed-in customer's choices.
|
|
3267
|
+
*
|
|
3268
|
+
* Always the account the token belongs to; no id is read from the request.
|
|
3269
|
+
*/
|
|
3270
|
+
put: operations["exploresous_consent_update"];
|
|
3271
|
+
post?: never;
|
|
3272
|
+
delete?: never;
|
|
3273
|
+
options?: never;
|
|
3274
|
+
head?: never;
|
|
3275
|
+
patch?: never;
|
|
3276
|
+
trace?: never;
|
|
3277
|
+
};
|
|
3278
|
+
"/api/v1/exploresous/history/": {
|
|
3279
|
+
parameters: {
|
|
3280
|
+
query?: never;
|
|
3281
|
+
header?: never;
|
|
3282
|
+
path?: never;
|
|
3283
|
+
cookie?: never;
|
|
3284
|
+
};
|
|
3285
|
+
/**
|
|
3286
|
+
* @description GET /api/v1/exploresous/history/ - the signed-in customer's imported orders.
|
|
3287
|
+
*
|
|
3288
|
+
* The account comes from the verified token only; no id in the query or body
|
|
3289
|
+
* is read. ``history_available`` is false until the history is signed off.
|
|
3290
|
+
*/
|
|
3291
|
+
get: operations["exploresous_history_retrieve"];
|
|
3292
|
+
put?: never;
|
|
3293
|
+
post?: never;
|
|
3294
|
+
delete?: never;
|
|
3295
|
+
options?: never;
|
|
3296
|
+
head?: never;
|
|
3297
|
+
patch?: never;
|
|
3298
|
+
trace?: never;
|
|
3299
|
+
};
|
|
3300
|
+
"/api/v1/exploresous/link/": {
|
|
3301
|
+
parameters: {
|
|
3302
|
+
query?: never;
|
|
3303
|
+
header?: never;
|
|
3304
|
+
path?: never;
|
|
3305
|
+
cookie?: never;
|
|
3306
|
+
};
|
|
3307
|
+
get?: never;
|
|
3308
|
+
put?: never;
|
|
3309
|
+
/**
|
|
3310
|
+
* @description POST /api/v1/exploresous/link/ - link the WorkOS sign-in to a SOUS account.
|
|
3311
|
+
*
|
|
3312
|
+
* Authenticates the token without requiring an existing link: this is the call
|
|
3313
|
+
* that creates it. 200 ``linked``, or 409 ``held`` with a message for the
|
|
3314
|
+
* customer; the reason is logged, never returned.
|
|
3315
|
+
*/
|
|
3316
|
+
post: operations["exploresous_link_create"];
|
|
3317
|
+
delete?: never;
|
|
3318
|
+
options?: never;
|
|
3319
|
+
head?: never;
|
|
3320
|
+
patch?: never;
|
|
3321
|
+
trace?: never;
|
|
3322
|
+
};
|
|
3323
|
+
"/api/v1/exploresous/unsubscribe/": {
|
|
3324
|
+
parameters: {
|
|
3325
|
+
query?: never;
|
|
3326
|
+
header?: never;
|
|
3327
|
+
path?: never;
|
|
3328
|
+
cookie?: never;
|
|
3329
|
+
};
|
|
3330
|
+
/**
|
|
3331
|
+
* @description /api/v1/exploresous/unsubscribe/ - login-free one-click unsubscribe.
|
|
3332
|
+
*
|
|
3333
|
+
* POST withdraws the channel the signed token names. GET only describes it, so
|
|
3334
|
+
* a mail scanner prefetching the link cannot unsubscribe anyone; the
|
|
3335
|
+
* storefront page confirms and POSTs.
|
|
3336
|
+
*/
|
|
3337
|
+
get: operations["exploresous_unsubscribe_retrieve"];
|
|
3338
|
+
put?: never;
|
|
3339
|
+
/**
|
|
3340
|
+
* @description /api/v1/exploresous/unsubscribe/ - login-free one-click unsubscribe.
|
|
3341
|
+
*
|
|
3342
|
+
* POST withdraws the channel the signed token names. GET only describes it, so
|
|
3343
|
+
* a mail scanner prefetching the link cannot unsubscribe anyone; the
|
|
3344
|
+
* storefront page confirms and POSTs.
|
|
3345
|
+
*/
|
|
3346
|
+
post: operations["exploresous_unsubscribe_create"];
|
|
3347
|
+
delete?: never;
|
|
3348
|
+
options?: never;
|
|
3349
|
+
head?: never;
|
|
3350
|
+
patch?: never;
|
|
3351
|
+
trace?: never;
|
|
3352
|
+
};
|
|
3195
3353
|
"/api/v1/fulfillment/address-check/": {
|
|
3196
3354
|
parameters: {
|
|
3197
3355
|
query?: never;
|
|
@@ -7582,6 +7740,12 @@ interface components {
|
|
|
7582
7740
|
/** Format: date-time */
|
|
7583
7741
|
readonly created_at: string;
|
|
7584
7742
|
};
|
|
7743
|
+
/**
|
|
7744
|
+
* @description * `email` - Email
|
|
7745
|
+
* * `sms` - SMS
|
|
7746
|
+
* @enum {string}
|
|
7747
|
+
*/
|
|
7748
|
+
ChannelEnum: "email" | "sms";
|
|
7585
7749
|
/**
|
|
7586
7750
|
* @description * `own_website` - Own Website
|
|
7587
7751
|
* * `uber_eats` - Uber Eats
|
|
@@ -7791,6 +7955,26 @@ interface components {
|
|
|
7791
7955
|
/** @default */
|
|
7792
7956
|
payment_data: string;
|
|
7793
7957
|
};
|
|
7958
|
+
/** @description The customer's choice for one channel. */
|
|
7959
|
+
ConsentChoice: {
|
|
7960
|
+
channel: components["schemas"]["ChannelEnum"];
|
|
7961
|
+
status: components["schemas"]["ConsentChoiceStatusEnum"];
|
|
7962
|
+
phone?: string;
|
|
7963
|
+
};
|
|
7964
|
+
/**
|
|
7965
|
+
* @description * `active` - Active
|
|
7966
|
+
* * `withdrawn` - Withdrawn
|
|
7967
|
+
* @enum {string}
|
|
7968
|
+
*/
|
|
7969
|
+
ConsentChoiceStatusEnum: "active" | "withdrawn";
|
|
7970
|
+
ConsentRow: {
|
|
7971
|
+
channel: string;
|
|
7972
|
+
status: string;
|
|
7973
|
+
};
|
|
7974
|
+
/** @description The customer's ExploreSOUS consent, per channel. */
|
|
7975
|
+
Consents: {
|
|
7976
|
+
consents: components["schemas"]["ConsentRow"][];
|
|
7977
|
+
};
|
|
7794
7978
|
ContentTranslation: {
|
|
7795
7979
|
language_code: string;
|
|
7796
7980
|
headline?: string;
|
|
@@ -8412,6 +8596,45 @@ interface components {
|
|
|
8412
8596
|
* @enum {string}
|
|
8413
8597
|
*/
|
|
8414
8598
|
HealthStatusEnum: "champion" | "loyal" | "potential_loyal" | "new" | "promising" | "needs_attention" | "about_to_sleep" | "at_risk" | "cant_lose" | "hibernating" | "lost";
|
|
8599
|
+
/** @description The history endpoint's response. */
|
|
8600
|
+
History: {
|
|
8601
|
+
history_available: boolean;
|
|
8602
|
+
orders: components["schemas"]["HistoryOrder"][];
|
|
8603
|
+
};
|
|
8604
|
+
/** @description One line of a past order, as ``projection._lines`` stores it. */
|
|
8605
|
+
HistoryLineItem: {
|
|
8606
|
+
title: string;
|
|
8607
|
+
variant_title: string;
|
|
8608
|
+
quantity: number;
|
|
8609
|
+
unit_price: string | null;
|
|
8610
|
+
vendor: string;
|
|
8611
|
+
partner_name: string;
|
|
8612
|
+
store_id: number | null;
|
|
8613
|
+
};
|
|
8614
|
+
/** @description One past order, as ``history.HistoryOrder``. */
|
|
8615
|
+
HistoryOrder: {
|
|
8616
|
+
name: string;
|
|
8617
|
+
/** Format: date-time */
|
|
8618
|
+
placed_at: string | null;
|
|
8619
|
+
/** Format: date-time */
|
|
8620
|
+
cancelled_at: string | null;
|
|
8621
|
+
financial_status: string;
|
|
8622
|
+
fulfilment_status: string;
|
|
8623
|
+
currency: string;
|
|
8624
|
+
/** Format: decimal */
|
|
8625
|
+
total_amount: string | null;
|
|
8626
|
+
/** Format: decimal */
|
|
8627
|
+
subtotal_amount: string | null;
|
|
8628
|
+
/** Format: decimal */
|
|
8629
|
+
shipping_amount: string | null;
|
|
8630
|
+
/** Format: decimal */
|
|
8631
|
+
tax_amount: string | null;
|
|
8632
|
+
/** Format: decimal */
|
|
8633
|
+
discount_amount: string | null;
|
|
8634
|
+
/** Format: decimal */
|
|
8635
|
+
refunded_amount: string | null;
|
|
8636
|
+
line_items: components["schemas"]["HistoryLineItem"][];
|
|
8637
|
+
};
|
|
8415
8638
|
/**
|
|
8416
8639
|
* @description * `customer` - Customer
|
|
8417
8640
|
* * `merchant` - Merchant
|
|
@@ -8673,6 +8896,12 @@ interface components {
|
|
|
8673
8896
|
LightspeedWebhook: {
|
|
8674
8897
|
endpoint_id: string;
|
|
8675
8898
|
};
|
|
8899
|
+
/** @description The link endpoint's answer: linked, or held with a message for the customer. */
|
|
8900
|
+
LinkOutcome: {
|
|
8901
|
+
outcome: components["schemas"]["OutcomeEnum"];
|
|
8902
|
+
user_id?: number;
|
|
8903
|
+
detail?: string;
|
|
8904
|
+
};
|
|
8676
8905
|
/** @description One location's delivery-method state, grouped by the stores serving it. */
|
|
8677
8906
|
LocationDeliveryMethodSummary: {
|
|
8678
8907
|
location_public_id: string;
|
|
@@ -8831,6 +9060,23 @@ interface components {
|
|
|
8831
9060
|
/** Format: date-time */
|
|
8832
9061
|
readonly updated_at: string;
|
|
8833
9062
|
};
|
|
9063
|
+
/**
|
|
9064
|
+
* @description A merchant pressed Print on an order in the merchant portal.
|
|
9065
|
+
*
|
|
9066
|
+
* ``order_id`` is the storefront Order PK and ``store_id`` the storefront
|
|
9067
|
+
* ``Store.id``, as merchant-portal-backend records them on its order
|
|
9068
|
+
* (``external_id``, ``metadata.store_id``). The store must be the merchant's
|
|
9069
|
+
* and must own the order. ``request_id`` is generated per click: a retry
|
|
9070
|
+
* with the same id prints nothing new. Who asked is read from the login
|
|
9071
|
+
* token, not from the body.
|
|
9072
|
+
*/
|
|
9073
|
+
MerchantPrintOrderRequest: {
|
|
9074
|
+
/** Format: uuid */
|
|
9075
|
+
order_id: string;
|
|
9076
|
+
store_id: number;
|
|
9077
|
+
/** Format: uuid */
|
|
9078
|
+
request_id: string;
|
|
9079
|
+
};
|
|
8834
9080
|
/**
|
|
8835
9081
|
* @description The merchant pastes the restaurant id Mergeport gave them.
|
|
8836
9082
|
*
|
|
@@ -9335,6 +9581,12 @@ interface components {
|
|
|
9335
9581
|
/** Format: date-time */
|
|
9336
9582
|
readonly updated_at: string;
|
|
9337
9583
|
};
|
|
9584
|
+
/**
|
|
9585
|
+
* @description * `linked` - linked
|
|
9586
|
+
* * `held` - held
|
|
9587
|
+
* @enum {string}
|
|
9588
|
+
*/
|
|
9589
|
+
OutcomeEnum: "linked" | "held";
|
|
9338
9590
|
/** @description One POS catalogue item with drift classification. */
|
|
9339
9591
|
POSCatalogueItem: {
|
|
9340
9592
|
sku: string;
|
|
@@ -11613,6 +11865,16 @@ interface components {
|
|
|
11613
11865
|
slug: string;
|
|
11614
11866
|
abbreviation: string;
|
|
11615
11867
|
};
|
|
11868
|
+
/** @description The signed token from the unsubscribe link (body or query). */
|
|
11869
|
+
UnsubscribeToken: {
|
|
11870
|
+
token: string;
|
|
11871
|
+
};
|
|
11872
|
+
/** @description What an unsubscribe link covers, and for POST the resulting status. */
|
|
11873
|
+
Unsubscribed: {
|
|
11874
|
+
channel: string;
|
|
11875
|
+
scope: string;
|
|
11876
|
+
status?: string;
|
|
11877
|
+
};
|
|
11616
11878
|
User: {
|
|
11617
11879
|
/** @description Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */
|
|
11618
11880
|
username: string;
|
|
@@ -14029,15 +14291,11 @@ interface operations {
|
|
|
14029
14291
|
};
|
|
14030
14292
|
};
|
|
14031
14293
|
};
|
|
14032
|
-
|
|
14294
|
+
admin_printing_order_jobs: {
|
|
14033
14295
|
parameters: {
|
|
14034
|
-
query
|
|
14035
|
-
|
|
14036
|
-
|
|
14037
|
-
/** @description Restrict to one store by numeric Store.id. Must belong to the authenticated company; an unrelated id yields an empty list. */
|
|
14038
|
-
store_id?: number;
|
|
14039
|
-
/** @description Restrict to one store by its public_id (the stable, cross-system store key the merchant portal holds). Must belong to the authenticated company; an unrelated value yields an empty list. Preferred over store_id. */
|
|
14040
|
-
store_public_id?: string;
|
|
14296
|
+
query: {
|
|
14297
|
+
order_id: string;
|
|
14298
|
+
store_id: number;
|
|
14041
14299
|
};
|
|
14042
14300
|
header?: {
|
|
14043
14301
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
@@ -14053,7 +14311,7 @@ interface operations {
|
|
|
14053
14311
|
[name: string]: unknown;
|
|
14054
14312
|
};
|
|
14055
14313
|
content: {
|
|
14056
|
-
"application/json": components["schemas"]["
|
|
14314
|
+
"application/json": components["schemas"]["PrintJobsResponse"];
|
|
14057
14315
|
};
|
|
14058
14316
|
};
|
|
14059
14317
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14089,7 +14347,9 @@ interface operations {
|
|
|
14089
14347
|
[name: string]: unknown;
|
|
14090
14348
|
};
|
|
14091
14349
|
content: {
|
|
14092
|
-
"application/json":
|
|
14350
|
+
"application/json": {
|
|
14351
|
+
[key: string]: unknown;
|
|
14352
|
+
};
|
|
14093
14353
|
};
|
|
14094
14354
|
};
|
|
14095
14355
|
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14112,26 +14372,30 @@ interface operations {
|
|
|
14112
14372
|
};
|
|
14113
14373
|
};
|
|
14114
14374
|
};
|
|
14115
|
-
|
|
14375
|
+
admin_printing_print_order: {
|
|
14116
14376
|
parameters: {
|
|
14117
14377
|
query?: never;
|
|
14118
14378
|
header?: {
|
|
14119
14379
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14120
14380
|
"X-Sous-Company-Id"?: number;
|
|
14121
14381
|
};
|
|
14122
|
-
path
|
|
14123
|
-
product_id: number;
|
|
14124
|
-
};
|
|
14382
|
+
path?: never;
|
|
14125
14383
|
cookie?: never;
|
|
14126
14384
|
};
|
|
14127
|
-
requestBody
|
|
14385
|
+
requestBody: {
|
|
14386
|
+
content: {
|
|
14387
|
+
"application/json": components["schemas"]["MerchantPrintOrderRequest"];
|
|
14388
|
+
"application/x-www-form-urlencoded": components["schemas"]["MerchantPrintOrderRequest"];
|
|
14389
|
+
"multipart/form-data": components["schemas"]["MerchantPrintOrderRequest"];
|
|
14390
|
+
};
|
|
14391
|
+
};
|
|
14128
14392
|
responses: {
|
|
14129
|
-
|
|
14393
|
+
202: {
|
|
14130
14394
|
headers: {
|
|
14131
14395
|
[name: string]: unknown;
|
|
14132
14396
|
};
|
|
14133
14397
|
content: {
|
|
14134
|
-
"application/json": components["schemas"]["
|
|
14398
|
+
"application/json": components["schemas"]["PrintJobsResponse"];
|
|
14135
14399
|
};
|
|
14136
14400
|
};
|
|
14137
14401
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14167,7 +14431,19 @@ interface operations {
|
|
|
14167
14431
|
[name: string]: unknown;
|
|
14168
14432
|
};
|
|
14169
14433
|
content: {
|
|
14170
|
-
"application/json":
|
|
14434
|
+
"application/json": {
|
|
14435
|
+
[key: string]: unknown;
|
|
14436
|
+
};
|
|
14437
|
+
};
|
|
14438
|
+
};
|
|
14439
|
+
409: {
|
|
14440
|
+
headers: {
|
|
14441
|
+
[name: string]: unknown;
|
|
14442
|
+
};
|
|
14443
|
+
content: {
|
|
14444
|
+
"application/json": {
|
|
14445
|
+
[key: string]: unknown;
|
|
14446
|
+
};
|
|
14171
14447
|
};
|
|
14172
14448
|
};
|
|
14173
14449
|
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14190,7 +14466,7 @@ interface operations {
|
|
|
14190
14466
|
};
|
|
14191
14467
|
};
|
|
14192
14468
|
};
|
|
14193
|
-
|
|
14469
|
+
admin_printing_store_devices: {
|
|
14194
14470
|
parameters: {
|
|
14195
14471
|
query?: never;
|
|
14196
14472
|
header?: {
|
|
@@ -14198,24 +14474,18 @@ interface operations {
|
|
|
14198
14474
|
"X-Sous-Company-Id"?: number;
|
|
14199
14475
|
};
|
|
14200
14476
|
path: {
|
|
14201
|
-
|
|
14477
|
+
store_public_id: string;
|
|
14202
14478
|
};
|
|
14203
14479
|
cookie?: never;
|
|
14204
14480
|
};
|
|
14205
|
-
requestBody
|
|
14206
|
-
content: {
|
|
14207
|
-
"application/json": components["schemas"]["AdminAttributeValuesRequest"];
|
|
14208
|
-
"application/x-www-form-urlencoded": components["schemas"]["AdminAttributeValuesRequest"];
|
|
14209
|
-
"multipart/form-data": components["schemas"]["AdminAttributeValuesRequest"];
|
|
14210
|
-
};
|
|
14211
|
-
};
|
|
14481
|
+
requestBody?: never;
|
|
14212
14482
|
responses: {
|
|
14213
14483
|
200: {
|
|
14214
14484
|
headers: {
|
|
14215
14485
|
[name: string]: unknown;
|
|
14216
14486
|
};
|
|
14217
14487
|
content: {
|
|
14218
|
-
"application/json": components["schemas"]["
|
|
14488
|
+
"application/json": components["schemas"]["PrintDevicesResponse"];
|
|
14219
14489
|
};
|
|
14220
14490
|
};
|
|
14221
14491
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14251,7 +14521,9 @@ interface operations {
|
|
|
14251
14521
|
[name: string]: unknown;
|
|
14252
14522
|
};
|
|
14253
14523
|
content: {
|
|
14254
|
-
"application/json":
|
|
14524
|
+
"application/json": {
|
|
14525
|
+
[key: string]: unknown;
|
|
14526
|
+
};
|
|
14255
14527
|
};
|
|
14256
14528
|
};
|
|
14257
14529
|
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14274,16 +14546,21 @@ interface operations {
|
|
|
14274
14546
|
};
|
|
14275
14547
|
};
|
|
14276
14548
|
};
|
|
14277
|
-
|
|
14549
|
+
admin_products_list: {
|
|
14278
14550
|
parameters: {
|
|
14279
|
-
query?:
|
|
14551
|
+
query?: {
|
|
14552
|
+
/** @description Restrict to the product carrying this external_id (the merchant-portal Menu.id mirrored across the sync). Narrows the company-scoped list and never widens it, so an id belonging to another company yields an empty list — as does an unmatched or non-numeric value. Lets the portal resolve one product without downloading the store's catalogue to search it client-side. */
|
|
14553
|
+
external_id?: number;
|
|
14554
|
+
/** @description Restrict to one store by numeric Store.id. Must belong to the authenticated company; an unrelated id yields an empty list. */
|
|
14555
|
+
store_id?: number;
|
|
14556
|
+
/** @description Restrict to one store by its public_id (the stable, cross-system store key the merchant portal holds). Must belong to the authenticated company; an unrelated value yields an empty list. Preferred over store_id. */
|
|
14557
|
+
store_public_id?: string;
|
|
14558
|
+
};
|
|
14280
14559
|
header?: {
|
|
14281
14560
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14282
14561
|
"X-Sous-Company-Id"?: number;
|
|
14283
14562
|
};
|
|
14284
|
-
path
|
|
14285
|
-
product_id: number;
|
|
14286
|
-
};
|
|
14563
|
+
path?: never;
|
|
14287
14564
|
cookie?: never;
|
|
14288
14565
|
};
|
|
14289
14566
|
requestBody?: never;
|
|
@@ -14293,7 +14570,7 @@ interface operations {
|
|
|
14293
14570
|
[name: string]: unknown;
|
|
14294
14571
|
};
|
|
14295
14572
|
content: {
|
|
14296
|
-
"application/json": components["schemas"]["
|
|
14573
|
+
"application/json": components["schemas"]["AdminProductOption"][];
|
|
14297
14574
|
};
|
|
14298
14575
|
};
|
|
14299
14576
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -14352,7 +14629,7 @@ interface operations {
|
|
|
14352
14629
|
};
|
|
14353
14630
|
};
|
|
14354
14631
|
};
|
|
14355
|
-
|
|
14632
|
+
admin_products_attribute_values_list: {
|
|
14356
14633
|
parameters: {
|
|
14357
14634
|
query?: never;
|
|
14358
14635
|
header?: {
|
|
@@ -14366,12 +14643,13 @@ interface operations {
|
|
|
14366
14643
|
};
|
|
14367
14644
|
requestBody?: never;
|
|
14368
14645
|
responses: {
|
|
14369
|
-
/** @description No response body */
|
|
14370
14646
|
200: {
|
|
14371
14647
|
headers: {
|
|
14372
14648
|
[name: string]: unknown;
|
|
14373
14649
|
};
|
|
14374
|
-
content
|
|
14650
|
+
content: {
|
|
14651
|
+
"application/json": components["schemas"]["ProductAttributeValue"][];
|
|
14652
|
+
};
|
|
14375
14653
|
};
|
|
14376
14654
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14377
14655
|
400: {
|
|
@@ -14379,7 +14657,246 @@ interface operations {
|
|
|
14379
14657
|
[name: string]: unknown;
|
|
14380
14658
|
};
|
|
14381
14659
|
content: {
|
|
14382
|
-
"application/json": components["schemas"]["
|
|
14660
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14661
|
+
};
|
|
14662
|
+
};
|
|
14663
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14664
|
+
401: {
|
|
14665
|
+
headers: {
|
|
14666
|
+
[name: string]: unknown;
|
|
14667
|
+
};
|
|
14668
|
+
content: {
|
|
14669
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14670
|
+
};
|
|
14671
|
+
};
|
|
14672
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14673
|
+
403: {
|
|
14674
|
+
headers: {
|
|
14675
|
+
[name: string]: unknown;
|
|
14676
|
+
};
|
|
14677
|
+
content: {
|
|
14678
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14679
|
+
};
|
|
14680
|
+
};
|
|
14681
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14682
|
+
404: {
|
|
14683
|
+
headers: {
|
|
14684
|
+
[name: string]: unknown;
|
|
14685
|
+
};
|
|
14686
|
+
content: {
|
|
14687
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14688
|
+
};
|
|
14689
|
+
};
|
|
14690
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14691
|
+
429: {
|
|
14692
|
+
headers: {
|
|
14693
|
+
[name: string]: unknown;
|
|
14694
|
+
};
|
|
14695
|
+
content: {
|
|
14696
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14697
|
+
};
|
|
14698
|
+
};
|
|
14699
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14700
|
+
500: {
|
|
14701
|
+
headers: {
|
|
14702
|
+
[name: string]: unknown;
|
|
14703
|
+
};
|
|
14704
|
+
content: {
|
|
14705
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14706
|
+
};
|
|
14707
|
+
};
|
|
14708
|
+
};
|
|
14709
|
+
};
|
|
14710
|
+
admin_products_attribute_values_update: {
|
|
14711
|
+
parameters: {
|
|
14712
|
+
query?: never;
|
|
14713
|
+
header?: {
|
|
14714
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14715
|
+
"X-Sous-Company-Id"?: number;
|
|
14716
|
+
};
|
|
14717
|
+
path: {
|
|
14718
|
+
product_id: number;
|
|
14719
|
+
};
|
|
14720
|
+
cookie?: never;
|
|
14721
|
+
};
|
|
14722
|
+
requestBody: {
|
|
14723
|
+
content: {
|
|
14724
|
+
"application/json": components["schemas"]["AdminAttributeValuesRequest"];
|
|
14725
|
+
"application/x-www-form-urlencoded": components["schemas"]["AdminAttributeValuesRequest"];
|
|
14726
|
+
"multipart/form-data": components["schemas"]["AdminAttributeValuesRequest"];
|
|
14727
|
+
};
|
|
14728
|
+
};
|
|
14729
|
+
responses: {
|
|
14730
|
+
200: {
|
|
14731
|
+
headers: {
|
|
14732
|
+
[name: string]: unknown;
|
|
14733
|
+
};
|
|
14734
|
+
content: {
|
|
14735
|
+
"application/json": components["schemas"]["ProductAttributeValue"][];
|
|
14736
|
+
};
|
|
14737
|
+
};
|
|
14738
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14739
|
+
400: {
|
|
14740
|
+
headers: {
|
|
14741
|
+
[name: string]: unknown;
|
|
14742
|
+
};
|
|
14743
|
+
content: {
|
|
14744
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14745
|
+
};
|
|
14746
|
+
};
|
|
14747
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14748
|
+
401: {
|
|
14749
|
+
headers: {
|
|
14750
|
+
[name: string]: unknown;
|
|
14751
|
+
};
|
|
14752
|
+
content: {
|
|
14753
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14754
|
+
};
|
|
14755
|
+
};
|
|
14756
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14757
|
+
403: {
|
|
14758
|
+
headers: {
|
|
14759
|
+
[name: string]: unknown;
|
|
14760
|
+
};
|
|
14761
|
+
content: {
|
|
14762
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14763
|
+
};
|
|
14764
|
+
};
|
|
14765
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14766
|
+
404: {
|
|
14767
|
+
headers: {
|
|
14768
|
+
[name: string]: unknown;
|
|
14769
|
+
};
|
|
14770
|
+
content: {
|
|
14771
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14772
|
+
};
|
|
14773
|
+
};
|
|
14774
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14775
|
+
429: {
|
|
14776
|
+
headers: {
|
|
14777
|
+
[name: string]: unknown;
|
|
14778
|
+
};
|
|
14779
|
+
content: {
|
|
14780
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14781
|
+
};
|
|
14782
|
+
};
|
|
14783
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14784
|
+
500: {
|
|
14785
|
+
headers: {
|
|
14786
|
+
[name: string]: unknown;
|
|
14787
|
+
};
|
|
14788
|
+
content: {
|
|
14789
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14790
|
+
};
|
|
14791
|
+
};
|
|
14792
|
+
};
|
|
14793
|
+
};
|
|
14794
|
+
admin_products_confirm_compliance_retrieve: {
|
|
14795
|
+
parameters: {
|
|
14796
|
+
query?: never;
|
|
14797
|
+
header?: {
|
|
14798
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14799
|
+
"X-Sous-Company-Id"?: number;
|
|
14800
|
+
};
|
|
14801
|
+
path: {
|
|
14802
|
+
product_id: number;
|
|
14803
|
+
};
|
|
14804
|
+
cookie?: never;
|
|
14805
|
+
};
|
|
14806
|
+
requestBody?: never;
|
|
14807
|
+
responses: {
|
|
14808
|
+
200: {
|
|
14809
|
+
headers: {
|
|
14810
|
+
[name: string]: unknown;
|
|
14811
|
+
};
|
|
14812
|
+
content: {
|
|
14813
|
+
"application/json": components["schemas"]["ComplianceConfirmation"];
|
|
14814
|
+
};
|
|
14815
|
+
};
|
|
14816
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14817
|
+
400: {
|
|
14818
|
+
headers: {
|
|
14819
|
+
[name: string]: unknown;
|
|
14820
|
+
};
|
|
14821
|
+
content: {
|
|
14822
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14823
|
+
};
|
|
14824
|
+
};
|
|
14825
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14826
|
+
401: {
|
|
14827
|
+
headers: {
|
|
14828
|
+
[name: string]: unknown;
|
|
14829
|
+
};
|
|
14830
|
+
content: {
|
|
14831
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14832
|
+
};
|
|
14833
|
+
};
|
|
14834
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14835
|
+
403: {
|
|
14836
|
+
headers: {
|
|
14837
|
+
[name: string]: unknown;
|
|
14838
|
+
};
|
|
14839
|
+
content: {
|
|
14840
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14841
|
+
};
|
|
14842
|
+
};
|
|
14843
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14844
|
+
404: {
|
|
14845
|
+
headers: {
|
|
14846
|
+
[name: string]: unknown;
|
|
14847
|
+
};
|
|
14848
|
+
content: {
|
|
14849
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14850
|
+
};
|
|
14851
|
+
};
|
|
14852
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14853
|
+
429: {
|
|
14854
|
+
headers: {
|
|
14855
|
+
[name: string]: unknown;
|
|
14856
|
+
};
|
|
14857
|
+
content: {
|
|
14858
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14859
|
+
};
|
|
14860
|
+
};
|
|
14861
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14862
|
+
500: {
|
|
14863
|
+
headers: {
|
|
14864
|
+
[name: string]: unknown;
|
|
14865
|
+
};
|
|
14866
|
+
content: {
|
|
14867
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14868
|
+
};
|
|
14869
|
+
};
|
|
14870
|
+
};
|
|
14871
|
+
};
|
|
14872
|
+
admin_products_confirm_compliance_create: {
|
|
14873
|
+
parameters: {
|
|
14874
|
+
query?: never;
|
|
14875
|
+
header?: {
|
|
14876
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14877
|
+
"X-Sous-Company-Id"?: number;
|
|
14878
|
+
};
|
|
14879
|
+
path: {
|
|
14880
|
+
product_id: number;
|
|
14881
|
+
};
|
|
14882
|
+
cookie?: never;
|
|
14883
|
+
};
|
|
14884
|
+
requestBody?: never;
|
|
14885
|
+
responses: {
|
|
14886
|
+
/** @description No response body */
|
|
14887
|
+
200: {
|
|
14888
|
+
headers: {
|
|
14889
|
+
[name: string]: unknown;
|
|
14890
|
+
};
|
|
14891
|
+
content?: never;
|
|
14892
|
+
};
|
|
14893
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14894
|
+
400: {
|
|
14895
|
+
headers: {
|
|
14896
|
+
[name: string]: unknown;
|
|
14897
|
+
};
|
|
14898
|
+
content: {
|
|
14899
|
+
"application/json": components["schemas"]["ComplianceIncomplete"];
|
|
14383
14900
|
};
|
|
14384
14901
|
};
|
|
14385
14902
|
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -26533,6 +27050,430 @@ interface operations {
|
|
|
26533
27050
|
};
|
|
26534
27051
|
};
|
|
26535
27052
|
};
|
|
27053
|
+
exploresous_consent_retrieve: {
|
|
27054
|
+
parameters: {
|
|
27055
|
+
query?: never;
|
|
27056
|
+
header?: never;
|
|
27057
|
+
path?: never;
|
|
27058
|
+
cookie?: never;
|
|
27059
|
+
};
|
|
27060
|
+
requestBody?: never;
|
|
27061
|
+
responses: {
|
|
27062
|
+
200: {
|
|
27063
|
+
headers: {
|
|
27064
|
+
[name: string]: unknown;
|
|
27065
|
+
};
|
|
27066
|
+
content: {
|
|
27067
|
+
"application/json": components["schemas"]["Consents"];
|
|
27068
|
+
};
|
|
27069
|
+
};
|
|
27070
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27071
|
+
400: {
|
|
27072
|
+
headers: {
|
|
27073
|
+
[name: string]: unknown;
|
|
27074
|
+
};
|
|
27075
|
+
content: {
|
|
27076
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27077
|
+
};
|
|
27078
|
+
};
|
|
27079
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27080
|
+
401: {
|
|
27081
|
+
headers: {
|
|
27082
|
+
[name: string]: unknown;
|
|
27083
|
+
};
|
|
27084
|
+
content: {
|
|
27085
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27086
|
+
};
|
|
27087
|
+
};
|
|
27088
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27089
|
+
403: {
|
|
27090
|
+
headers: {
|
|
27091
|
+
[name: string]: unknown;
|
|
27092
|
+
};
|
|
27093
|
+
content: {
|
|
27094
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27095
|
+
};
|
|
27096
|
+
};
|
|
27097
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27098
|
+
404: {
|
|
27099
|
+
headers: {
|
|
27100
|
+
[name: string]: unknown;
|
|
27101
|
+
};
|
|
27102
|
+
content: {
|
|
27103
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27104
|
+
};
|
|
27105
|
+
};
|
|
27106
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27107
|
+
429: {
|
|
27108
|
+
headers: {
|
|
27109
|
+
[name: string]: unknown;
|
|
27110
|
+
};
|
|
27111
|
+
content: {
|
|
27112
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27113
|
+
};
|
|
27114
|
+
};
|
|
27115
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27116
|
+
500: {
|
|
27117
|
+
headers: {
|
|
27118
|
+
[name: string]: unknown;
|
|
27119
|
+
};
|
|
27120
|
+
content: {
|
|
27121
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27122
|
+
};
|
|
27123
|
+
};
|
|
27124
|
+
};
|
|
27125
|
+
};
|
|
27126
|
+
exploresous_consent_update: {
|
|
27127
|
+
parameters: {
|
|
27128
|
+
query?: never;
|
|
27129
|
+
header?: never;
|
|
27130
|
+
path?: never;
|
|
27131
|
+
cookie?: never;
|
|
27132
|
+
};
|
|
27133
|
+
requestBody: {
|
|
27134
|
+
content: {
|
|
27135
|
+
"application/json": components["schemas"]["ConsentChoice"];
|
|
27136
|
+
"application/x-www-form-urlencoded": components["schemas"]["ConsentChoice"];
|
|
27137
|
+
"multipart/form-data": components["schemas"]["ConsentChoice"];
|
|
27138
|
+
};
|
|
27139
|
+
};
|
|
27140
|
+
responses: {
|
|
27141
|
+
200: {
|
|
27142
|
+
headers: {
|
|
27143
|
+
[name: string]: unknown;
|
|
27144
|
+
};
|
|
27145
|
+
content: {
|
|
27146
|
+
"application/json": components["schemas"]["Consents"];
|
|
27147
|
+
};
|
|
27148
|
+
};
|
|
27149
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27150
|
+
400: {
|
|
27151
|
+
headers: {
|
|
27152
|
+
[name: string]: unknown;
|
|
27153
|
+
};
|
|
27154
|
+
content: {
|
|
27155
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27156
|
+
};
|
|
27157
|
+
};
|
|
27158
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27159
|
+
401: {
|
|
27160
|
+
headers: {
|
|
27161
|
+
[name: string]: unknown;
|
|
27162
|
+
};
|
|
27163
|
+
content: {
|
|
27164
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27165
|
+
};
|
|
27166
|
+
};
|
|
27167
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27168
|
+
403: {
|
|
27169
|
+
headers: {
|
|
27170
|
+
[name: string]: unknown;
|
|
27171
|
+
};
|
|
27172
|
+
content: {
|
|
27173
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27174
|
+
};
|
|
27175
|
+
};
|
|
27176
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27177
|
+
404: {
|
|
27178
|
+
headers: {
|
|
27179
|
+
[name: string]: unknown;
|
|
27180
|
+
};
|
|
27181
|
+
content: {
|
|
27182
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27183
|
+
};
|
|
27184
|
+
};
|
|
27185
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27186
|
+
429: {
|
|
27187
|
+
headers: {
|
|
27188
|
+
[name: string]: unknown;
|
|
27189
|
+
};
|
|
27190
|
+
content: {
|
|
27191
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27192
|
+
};
|
|
27193
|
+
};
|
|
27194
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27195
|
+
500: {
|
|
27196
|
+
headers: {
|
|
27197
|
+
[name: string]: unknown;
|
|
27198
|
+
};
|
|
27199
|
+
content: {
|
|
27200
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27201
|
+
};
|
|
27202
|
+
};
|
|
27203
|
+
};
|
|
27204
|
+
};
|
|
27205
|
+
exploresous_history_retrieve: {
|
|
27206
|
+
parameters: {
|
|
27207
|
+
query?: never;
|
|
27208
|
+
header?: never;
|
|
27209
|
+
path?: never;
|
|
27210
|
+
cookie?: never;
|
|
27211
|
+
};
|
|
27212
|
+
requestBody?: never;
|
|
27213
|
+
responses: {
|
|
27214
|
+
200: {
|
|
27215
|
+
headers: {
|
|
27216
|
+
[name: string]: unknown;
|
|
27217
|
+
};
|
|
27218
|
+
content: {
|
|
27219
|
+
"application/json": components["schemas"]["History"];
|
|
27220
|
+
};
|
|
27221
|
+
};
|
|
27222
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27223
|
+
400: {
|
|
27224
|
+
headers: {
|
|
27225
|
+
[name: string]: unknown;
|
|
27226
|
+
};
|
|
27227
|
+
content: {
|
|
27228
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27229
|
+
};
|
|
27230
|
+
};
|
|
27231
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27232
|
+
401: {
|
|
27233
|
+
headers: {
|
|
27234
|
+
[name: string]: unknown;
|
|
27235
|
+
};
|
|
27236
|
+
content: {
|
|
27237
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27238
|
+
};
|
|
27239
|
+
};
|
|
27240
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27241
|
+
403: {
|
|
27242
|
+
headers: {
|
|
27243
|
+
[name: string]: unknown;
|
|
27244
|
+
};
|
|
27245
|
+
content: {
|
|
27246
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27247
|
+
};
|
|
27248
|
+
};
|
|
27249
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27250
|
+
404: {
|
|
27251
|
+
headers: {
|
|
27252
|
+
[name: string]: unknown;
|
|
27253
|
+
};
|
|
27254
|
+
content: {
|
|
27255
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27256
|
+
};
|
|
27257
|
+
};
|
|
27258
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27259
|
+
429: {
|
|
27260
|
+
headers: {
|
|
27261
|
+
[name: string]: unknown;
|
|
27262
|
+
};
|
|
27263
|
+
content: {
|
|
27264
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27265
|
+
};
|
|
27266
|
+
};
|
|
27267
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27268
|
+
500: {
|
|
27269
|
+
headers: {
|
|
27270
|
+
[name: string]: unknown;
|
|
27271
|
+
};
|
|
27272
|
+
content: {
|
|
27273
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27274
|
+
};
|
|
27275
|
+
};
|
|
27276
|
+
};
|
|
27277
|
+
};
|
|
27278
|
+
exploresous_link_create: {
|
|
27279
|
+
parameters: {
|
|
27280
|
+
query?: never;
|
|
27281
|
+
header?: never;
|
|
27282
|
+
path?: never;
|
|
27283
|
+
cookie?: never;
|
|
27284
|
+
};
|
|
27285
|
+
requestBody?: never;
|
|
27286
|
+
responses: {
|
|
27287
|
+
200: {
|
|
27288
|
+
headers: {
|
|
27289
|
+
[name: string]: unknown;
|
|
27290
|
+
};
|
|
27291
|
+
content: {
|
|
27292
|
+
"application/json": components["schemas"]["LinkOutcome"];
|
|
27293
|
+
};
|
|
27294
|
+
};
|
|
27295
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27296
|
+
400: {
|
|
27297
|
+
headers: {
|
|
27298
|
+
[name: string]: unknown;
|
|
27299
|
+
};
|
|
27300
|
+
content: {
|
|
27301
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27302
|
+
};
|
|
27303
|
+
};
|
|
27304
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27305
|
+
401: {
|
|
27306
|
+
headers: {
|
|
27307
|
+
[name: string]: unknown;
|
|
27308
|
+
};
|
|
27309
|
+
content: {
|
|
27310
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27311
|
+
};
|
|
27312
|
+
};
|
|
27313
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27314
|
+
403: {
|
|
27315
|
+
headers: {
|
|
27316
|
+
[name: string]: unknown;
|
|
27317
|
+
};
|
|
27318
|
+
content: {
|
|
27319
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27320
|
+
};
|
|
27321
|
+
};
|
|
27322
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27323
|
+
404: {
|
|
27324
|
+
headers: {
|
|
27325
|
+
[name: string]: unknown;
|
|
27326
|
+
};
|
|
27327
|
+
content: {
|
|
27328
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27329
|
+
};
|
|
27330
|
+
};
|
|
27331
|
+
409: {
|
|
27332
|
+
headers: {
|
|
27333
|
+
[name: string]: unknown;
|
|
27334
|
+
};
|
|
27335
|
+
content: {
|
|
27336
|
+
"application/json": components["schemas"]["LinkOutcome"];
|
|
27337
|
+
};
|
|
27338
|
+
};
|
|
27339
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27340
|
+
429: {
|
|
27341
|
+
headers: {
|
|
27342
|
+
[name: string]: unknown;
|
|
27343
|
+
};
|
|
27344
|
+
content: {
|
|
27345
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27346
|
+
};
|
|
27347
|
+
};
|
|
27348
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27349
|
+
500: {
|
|
27350
|
+
headers: {
|
|
27351
|
+
[name: string]: unknown;
|
|
27352
|
+
};
|
|
27353
|
+
content: {
|
|
27354
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27355
|
+
};
|
|
27356
|
+
};
|
|
27357
|
+
};
|
|
27358
|
+
};
|
|
27359
|
+
exploresous_unsubscribe_retrieve: {
|
|
27360
|
+
parameters: {
|
|
27361
|
+
query: {
|
|
27362
|
+
token: string;
|
|
27363
|
+
};
|
|
27364
|
+
header?: never;
|
|
27365
|
+
path?: never;
|
|
27366
|
+
cookie?: never;
|
|
27367
|
+
};
|
|
27368
|
+
requestBody?: never;
|
|
27369
|
+
responses: {
|
|
27370
|
+
200: {
|
|
27371
|
+
headers: {
|
|
27372
|
+
[name: string]: unknown;
|
|
27373
|
+
};
|
|
27374
|
+
content: {
|
|
27375
|
+
"application/json": components["schemas"]["Unsubscribed"];
|
|
27376
|
+
};
|
|
27377
|
+
};
|
|
27378
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27379
|
+
400: {
|
|
27380
|
+
headers: {
|
|
27381
|
+
[name: string]: unknown;
|
|
27382
|
+
};
|
|
27383
|
+
content: {
|
|
27384
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27385
|
+
};
|
|
27386
|
+
};
|
|
27387
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27388
|
+
404: {
|
|
27389
|
+
headers: {
|
|
27390
|
+
[name: string]: unknown;
|
|
27391
|
+
};
|
|
27392
|
+
content: {
|
|
27393
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27394
|
+
};
|
|
27395
|
+
};
|
|
27396
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27397
|
+
429: {
|
|
27398
|
+
headers: {
|
|
27399
|
+
[name: string]: unknown;
|
|
27400
|
+
};
|
|
27401
|
+
content: {
|
|
27402
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27403
|
+
};
|
|
27404
|
+
};
|
|
27405
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27406
|
+
500: {
|
|
27407
|
+
headers: {
|
|
27408
|
+
[name: string]: unknown;
|
|
27409
|
+
};
|
|
27410
|
+
content: {
|
|
27411
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27412
|
+
};
|
|
27413
|
+
};
|
|
27414
|
+
};
|
|
27415
|
+
};
|
|
27416
|
+
exploresous_unsubscribe_create: {
|
|
27417
|
+
parameters: {
|
|
27418
|
+
query?: never;
|
|
27419
|
+
header?: never;
|
|
27420
|
+
path?: never;
|
|
27421
|
+
cookie?: never;
|
|
27422
|
+
};
|
|
27423
|
+
requestBody: {
|
|
27424
|
+
content: {
|
|
27425
|
+
"application/json": components["schemas"]["UnsubscribeToken"];
|
|
27426
|
+
"application/x-www-form-urlencoded": components["schemas"]["UnsubscribeToken"];
|
|
27427
|
+
"multipart/form-data": components["schemas"]["UnsubscribeToken"];
|
|
27428
|
+
};
|
|
27429
|
+
};
|
|
27430
|
+
responses: {
|
|
27431
|
+
200: {
|
|
27432
|
+
headers: {
|
|
27433
|
+
[name: string]: unknown;
|
|
27434
|
+
};
|
|
27435
|
+
content: {
|
|
27436
|
+
"application/json": components["schemas"]["Unsubscribed"];
|
|
27437
|
+
};
|
|
27438
|
+
};
|
|
27439
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27440
|
+
400: {
|
|
27441
|
+
headers: {
|
|
27442
|
+
[name: string]: unknown;
|
|
27443
|
+
};
|
|
27444
|
+
content: {
|
|
27445
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27446
|
+
};
|
|
27447
|
+
};
|
|
27448
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27449
|
+
404: {
|
|
27450
|
+
headers: {
|
|
27451
|
+
[name: string]: unknown;
|
|
27452
|
+
};
|
|
27453
|
+
content: {
|
|
27454
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27455
|
+
};
|
|
27456
|
+
};
|
|
27457
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27458
|
+
429: {
|
|
27459
|
+
headers: {
|
|
27460
|
+
[name: string]: unknown;
|
|
27461
|
+
};
|
|
27462
|
+
content: {
|
|
27463
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27464
|
+
};
|
|
27465
|
+
};
|
|
27466
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
27467
|
+
500: {
|
|
27468
|
+
headers: {
|
|
27469
|
+
[name: string]: unknown;
|
|
27470
|
+
};
|
|
27471
|
+
content: {
|
|
27472
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
27473
|
+
};
|
|
27474
|
+
};
|
|
27475
|
+
};
|
|
27476
|
+
};
|
|
26536
27477
|
fulfillment_address_check_create: {
|
|
26537
27478
|
parameters: {
|
|
26538
27479
|
query?: never;
|