@poweredbysous/storefront-admin-sdk 4.6.2 → 4.7.1
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 +1661 -8
- package/dist/index.d.ts +1661 -8
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1311,6 +1311,186 @@ interface paths {
|
|
|
1311
1311
|
patch: operations["admin_stores_locations_delivery_methods_partial_update"];
|
|
1312
1312
|
trace?: never;
|
|
1313
1313
|
};
|
|
1314
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/": {
|
|
1315
|
+
parameters: {
|
|
1316
|
+
query?: never;
|
|
1317
|
+
header?: never;
|
|
1318
|
+
path?: never;
|
|
1319
|
+
cookie?: never;
|
|
1320
|
+
};
|
|
1321
|
+
/**
|
|
1322
|
+
* @description Whether the store is on the library, and how big it is.
|
|
1323
|
+
*
|
|
1324
|
+
* The portal asks this first: a 404 means it shows today's screens.
|
|
1325
|
+
*/
|
|
1326
|
+
get: operations["admin_stores_options_library_retrieve"];
|
|
1327
|
+
put?: never;
|
|
1328
|
+
post?: never;
|
|
1329
|
+
delete?: never;
|
|
1330
|
+
options?: never;
|
|
1331
|
+
head?: never;
|
|
1332
|
+
patch?: never;
|
|
1333
|
+
trace?: never;
|
|
1334
|
+
};
|
|
1335
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/channels/": {
|
|
1336
|
+
parameters: {
|
|
1337
|
+
query?: never;
|
|
1338
|
+
header?: never;
|
|
1339
|
+
path?: never;
|
|
1340
|
+
cookie?: never;
|
|
1341
|
+
};
|
|
1342
|
+
/** @description The marketplaces a snooze does not reach: the ones the store sold on lately. */
|
|
1343
|
+
get: operations["admin_stores_options_library_channels_retrieve"];
|
|
1344
|
+
put?: never;
|
|
1345
|
+
post?: never;
|
|
1346
|
+
delete?: never;
|
|
1347
|
+
options?: never;
|
|
1348
|
+
head?: never;
|
|
1349
|
+
patch?: never;
|
|
1350
|
+
trace?: never;
|
|
1351
|
+
};
|
|
1352
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/groups/": {
|
|
1353
|
+
parameters: {
|
|
1354
|
+
query?: never;
|
|
1355
|
+
header?: never;
|
|
1356
|
+
path?: never;
|
|
1357
|
+
cookie?: never;
|
|
1358
|
+
};
|
|
1359
|
+
/** @description The store's library groups (the Groups tab). */
|
|
1360
|
+
get: operations["admin_stores_options_library_groups_list"];
|
|
1361
|
+
put?: never;
|
|
1362
|
+
/** @description The store's library groups (the Groups tab). */
|
|
1363
|
+
post: operations["admin_stores_options_library_groups_create"];
|
|
1364
|
+
delete?: never;
|
|
1365
|
+
options?: never;
|
|
1366
|
+
head?: never;
|
|
1367
|
+
patch?: never;
|
|
1368
|
+
trace?: never;
|
|
1369
|
+
};
|
|
1370
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/groups/{group_id}/": {
|
|
1371
|
+
parameters: {
|
|
1372
|
+
query?: never;
|
|
1373
|
+
header?: never;
|
|
1374
|
+
path?: never;
|
|
1375
|
+
cookie?: never;
|
|
1376
|
+
};
|
|
1377
|
+
get?: never;
|
|
1378
|
+
put?: never;
|
|
1379
|
+
post?: never;
|
|
1380
|
+
/** @description Edit or delete one library group: the change reaches every product. */
|
|
1381
|
+
delete: operations["admin_stores_options_library_groups_destroy"];
|
|
1382
|
+
options?: never;
|
|
1383
|
+
head?: never;
|
|
1384
|
+
/** @description Edit or delete one library group: the change reaches every product. */
|
|
1385
|
+
patch: operations["admin_stores_options_library_groups_partial_update"];
|
|
1386
|
+
trace?: never;
|
|
1387
|
+
};
|
|
1388
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/options/": {
|
|
1389
|
+
parameters: {
|
|
1390
|
+
query?: never;
|
|
1391
|
+
header?: never;
|
|
1392
|
+
path?: never;
|
|
1393
|
+
cookie?: never;
|
|
1394
|
+
};
|
|
1395
|
+
/** @description The store's library options (the Options tab). */
|
|
1396
|
+
get: operations["admin_stores_options_library_options_list"];
|
|
1397
|
+
put?: never;
|
|
1398
|
+
/** @description The store's library options (the Options tab). */
|
|
1399
|
+
post: operations["admin_stores_options_library_options_create"];
|
|
1400
|
+
delete?: never;
|
|
1401
|
+
options?: never;
|
|
1402
|
+
head?: never;
|
|
1403
|
+
patch?: never;
|
|
1404
|
+
trace?: never;
|
|
1405
|
+
};
|
|
1406
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/options/{option_id}/": {
|
|
1407
|
+
parameters: {
|
|
1408
|
+
query?: never;
|
|
1409
|
+
header?: never;
|
|
1410
|
+
path?: never;
|
|
1411
|
+
cookie?: never;
|
|
1412
|
+
};
|
|
1413
|
+
get?: never;
|
|
1414
|
+
put?: never;
|
|
1415
|
+
post?: never;
|
|
1416
|
+
/** @description Edit, hide or delete one library option. */
|
|
1417
|
+
delete: operations["admin_stores_options_library_options_destroy"];
|
|
1418
|
+
options?: never;
|
|
1419
|
+
head?: never;
|
|
1420
|
+
/** @description Edit, hide or delete one library option. */
|
|
1421
|
+
patch: operations["admin_stores_options_library_options_partial_update"];
|
|
1422
|
+
trace?: never;
|
|
1423
|
+
};
|
|
1424
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/products/{product_id}/groups/": {
|
|
1425
|
+
parameters: {
|
|
1426
|
+
query?: never;
|
|
1427
|
+
header?: never;
|
|
1428
|
+
path?: never;
|
|
1429
|
+
cookie?: never;
|
|
1430
|
+
};
|
|
1431
|
+
/** @description A product's option groups, each linked to a library group. */
|
|
1432
|
+
get: operations["admin_stores_options_library_products_groups_list"];
|
|
1433
|
+
put?: never;
|
|
1434
|
+
/** @description A product's option groups, each linked to a library group. */
|
|
1435
|
+
post: operations["admin_stores_options_library_products_groups_create"];
|
|
1436
|
+
delete?: never;
|
|
1437
|
+
options?: never;
|
|
1438
|
+
head?: never;
|
|
1439
|
+
patch?: never;
|
|
1440
|
+
trace?: never;
|
|
1441
|
+
};
|
|
1442
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/products/{product_id}/groups/{modifier_group_id}/": {
|
|
1443
|
+
parameters: {
|
|
1444
|
+
query?: never;
|
|
1445
|
+
header?: never;
|
|
1446
|
+
path?: never;
|
|
1447
|
+
cookie?: never;
|
|
1448
|
+
};
|
|
1449
|
+
get?: never;
|
|
1450
|
+
put?: never;
|
|
1451
|
+
post?: never;
|
|
1452
|
+
/** @description Remove one linked group from a product; the library keeps it. */
|
|
1453
|
+
delete: operations["admin_stores_options_library_products_groups_destroy"];
|
|
1454
|
+
options?: never;
|
|
1455
|
+
head?: never;
|
|
1456
|
+
patch?: never;
|
|
1457
|
+
trace?: never;
|
|
1458
|
+
};
|
|
1459
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/snoozes/": {
|
|
1460
|
+
parameters: {
|
|
1461
|
+
query?: never;
|
|
1462
|
+
header?: never;
|
|
1463
|
+
path?: never;
|
|
1464
|
+
cookie?: never;
|
|
1465
|
+
};
|
|
1466
|
+
/** @description Everything snoozed at the store (the "Snoozed now" chip and view). */
|
|
1467
|
+
get: operations["admin_stores_options_library_snoozes_list"];
|
|
1468
|
+
put?: never;
|
|
1469
|
+
post?: never;
|
|
1470
|
+
delete?: never;
|
|
1471
|
+
options?: never;
|
|
1472
|
+
head?: never;
|
|
1473
|
+
patch?: never;
|
|
1474
|
+
trace?: never;
|
|
1475
|
+
};
|
|
1476
|
+
"/api/v1/admin/stores/{store_public_id}/options-library/snoozes/{item_type}/{item_id}/": {
|
|
1477
|
+
parameters: {
|
|
1478
|
+
query?: never;
|
|
1479
|
+
header?: never;
|
|
1480
|
+
path?: never;
|
|
1481
|
+
cookie?: never;
|
|
1482
|
+
};
|
|
1483
|
+
get?: never;
|
|
1484
|
+
/** @description Snooze one product or library option, or switch it back on. */
|
|
1485
|
+
put: operations["admin_stores_options_library_snoozes_update"];
|
|
1486
|
+
post?: never;
|
|
1487
|
+
/** @description Snooze one product or library option, or switch it back on. */
|
|
1488
|
+
delete: operations["admin_stores_options_library_snoozes_destroy"];
|
|
1489
|
+
options?: never;
|
|
1490
|
+
head?: never;
|
|
1491
|
+
patch?: never;
|
|
1492
|
+
trace?: never;
|
|
1493
|
+
};
|
|
1314
1494
|
"/api/v1/admin/stores/{store_public_id}/surcharges/": {
|
|
1315
1495
|
parameters: {
|
|
1316
1496
|
query?: never;
|
|
@@ -3502,6 +3682,8 @@ interface components {
|
|
|
3502
3682
|
end_date?: string | null;
|
|
3503
3683
|
/** @description Total redemption limit (null=unlimited) */
|
|
3504
3684
|
max_redemptions?: number | null;
|
|
3685
|
+
/** @description Combines with other discounts. */
|
|
3686
|
+
combinable?: boolean;
|
|
3505
3687
|
readonly redemption_count: number;
|
|
3506
3688
|
is_active?: boolean;
|
|
3507
3689
|
/** @description Fulfillment types this promotion applies to (empty = all). */
|
|
@@ -3608,6 +3790,11 @@ interface components {
|
|
|
3608
3790
|
* @enum {string}
|
|
3609
3791
|
*/
|
|
3610
3792
|
AssetTypeEnum: "logo" | "hero" | "favicon" | "og_image";
|
|
3793
|
+
/** @description Either a library group to add, or a new group to create and add. */
|
|
3794
|
+
AttachGroup: {
|
|
3795
|
+
library_group_id?: number;
|
|
3796
|
+
group?: components["schemas"]["GroupWrite"];
|
|
3797
|
+
};
|
|
3611
3798
|
Attribute: {
|
|
3612
3799
|
readonly id: number;
|
|
3613
3800
|
readonly name: string;
|
|
@@ -3765,6 +3952,12 @@ interface components {
|
|
|
3765
3952
|
*/
|
|
3766
3953
|
readonly product_count: number;
|
|
3767
3954
|
};
|
|
3955
|
+
/**
|
|
3956
|
+
* @description * `manual` - Manual
|
|
3957
|
+
* * `required_group` - Required group
|
|
3958
|
+
* @enum {string}
|
|
3959
|
+
*/
|
|
3960
|
+
CauseEnum: "manual" | "required_group";
|
|
3768
3961
|
/**
|
|
3769
3962
|
* @description * `add` - Add
|
|
3770
3963
|
* * `remove` - Remove
|
|
@@ -3791,6 +3984,10 @@ interface components {
|
|
|
3791
3984
|
* @enum {string}
|
|
3792
3985
|
*/
|
|
3793
3986
|
ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
|
|
3987
|
+
/** @description The marketplaces a snooze does not reach, for the channel note (C3, C4). */
|
|
3988
|
+
Channels: {
|
|
3989
|
+
platforms: string[];
|
|
3990
|
+
};
|
|
3794
3991
|
/** @description One row of the company availability list: a method and its on/off state. */
|
|
3795
3992
|
CompanyDeliveryMethodAvailability: {
|
|
3796
3993
|
method: components["schemas"]["MethodEnum"];
|
|
@@ -4078,6 +4275,8 @@ interface components {
|
|
|
4078
4275
|
readonly used_count: number;
|
|
4079
4276
|
/** @description Per-customer redemption limit (null=unlimited) */
|
|
4080
4277
|
max_uses_per_customer?: number | null;
|
|
4278
|
+
/** @description Combines with other discounts. */
|
|
4279
|
+
combinable?: boolean;
|
|
4081
4280
|
/**
|
|
4082
4281
|
* Format: date-time
|
|
4083
4282
|
* @description When discount becomes active
|
|
@@ -4157,6 +4356,48 @@ interface components {
|
|
|
4157
4356
|
* @enum {string}
|
|
4158
4357
|
*/
|
|
4159
4358
|
FulfillmentStatusEnum: "pending" | "fulfilled" | "failed";
|
|
4359
|
+
GroupEditResult: {
|
|
4360
|
+
products_affected: number;
|
|
4361
|
+
group: components["schemas"]["LibraryGroup"];
|
|
4362
|
+
};
|
|
4363
|
+
GroupItem: {
|
|
4364
|
+
option_id: number;
|
|
4365
|
+
title: string;
|
|
4366
|
+
/** Format: decimal */
|
|
4367
|
+
price_modifier: string;
|
|
4368
|
+
is_default: boolean;
|
|
4369
|
+
position: number;
|
|
4370
|
+
visible: boolean;
|
|
4371
|
+
snoozable: boolean;
|
|
4372
|
+
snoozed: boolean;
|
|
4373
|
+
};
|
|
4374
|
+
GroupItemWrite: {
|
|
4375
|
+
option_id: number;
|
|
4376
|
+
/**
|
|
4377
|
+
* Format: decimal
|
|
4378
|
+
* @default 0.00
|
|
4379
|
+
*/
|
|
4380
|
+
price_modifier: string;
|
|
4381
|
+
/** @default false */
|
|
4382
|
+
is_default: boolean;
|
|
4383
|
+
};
|
|
4384
|
+
/** @description What the Create / Edit group dialog sends. All optional on PATCH. */
|
|
4385
|
+
GroupWrite: {
|
|
4386
|
+
title: string;
|
|
4387
|
+
description?: string;
|
|
4388
|
+
selection_type: components["schemas"]["GroupWriteSelectionTypeEnum"];
|
|
4389
|
+
min_selections: number;
|
|
4390
|
+
max_selections: number | null;
|
|
4391
|
+
items: components["schemas"]["GroupItemWrite"][];
|
|
4392
|
+
required: boolean;
|
|
4393
|
+
};
|
|
4394
|
+
/**
|
|
4395
|
+
* @description * `single` - single
|
|
4396
|
+
* * `multiple` - multiple
|
|
4397
|
+
* * `quantity` - quantity
|
|
4398
|
+
* @enum {string}
|
|
4399
|
+
*/
|
|
4400
|
+
GroupWriteSelectionTypeEnum: "single" | "multiple" | "quantity";
|
|
4160
4401
|
/**
|
|
4161
4402
|
* @description * `champion` - Champion
|
|
4162
4403
|
* * `loyal` - Loyal
|
|
@@ -4243,6 +4484,48 @@ interface components {
|
|
|
4243
4484
|
* @enum {string}
|
|
4244
4485
|
*/
|
|
4245
4486
|
InvoiceStatusEnum: "draft" | "issued" | "paid" | "cancelled";
|
|
4487
|
+
/**
|
|
4488
|
+
* @description * `product` - Product
|
|
4489
|
+
* * `option` - Option
|
|
4490
|
+
* @enum {string}
|
|
4491
|
+
*/
|
|
4492
|
+
ItemTypeEnum: "product" | "option";
|
|
4493
|
+
LibraryGroup: {
|
|
4494
|
+
id: number;
|
|
4495
|
+
title: string;
|
|
4496
|
+
description: string;
|
|
4497
|
+
selection_type: string;
|
|
4498
|
+
min_selections: number;
|
|
4499
|
+
max_selections: number | null;
|
|
4500
|
+
items: components["schemas"]["GroupItem"][];
|
|
4501
|
+
used_in: components["schemas"]["UsedInProduct"][];
|
|
4502
|
+
required: boolean;
|
|
4503
|
+
};
|
|
4504
|
+
LibraryOption: {
|
|
4505
|
+
id: number;
|
|
4506
|
+
title: string;
|
|
4507
|
+
description: string;
|
|
4508
|
+
image_url: string;
|
|
4509
|
+
/** Format: decimal */
|
|
4510
|
+
vat_rate: string;
|
|
4511
|
+
visible: boolean;
|
|
4512
|
+
snoozable: boolean;
|
|
4513
|
+
snoozed: boolean;
|
|
4514
|
+
groups: components["schemas"]["OptionInGroup"][];
|
|
4515
|
+
used_in: components["schemas"]["UsedInProduct"][];
|
|
4516
|
+
};
|
|
4517
|
+
LibrarySummary: {
|
|
4518
|
+
enabled: boolean;
|
|
4519
|
+
option_count: number;
|
|
4520
|
+
group_count: number;
|
|
4521
|
+
};
|
|
4522
|
+
/** @description Which discount or promotion a line discount came from. */
|
|
4523
|
+
LineDiscountRef: {
|
|
4524
|
+
id: string;
|
|
4525
|
+
/** @description "discount" or "promotion". */
|
|
4526
|
+
kind: string;
|
|
4527
|
+
name: string;
|
|
4528
|
+
};
|
|
4246
4529
|
/** @description One location's delivery-method state, grouped by the stores serving it. */
|
|
4247
4530
|
LocationDeliveryMethodSummary: {
|
|
4248
4531
|
location_public_id: string;
|
|
@@ -4453,6 +4736,21 @@ interface components {
|
|
|
4453
4736
|
until: string | null;
|
|
4454
4737
|
opens_at: string | null;
|
|
4455
4738
|
};
|
|
4739
|
+
OptionInGroup: {
|
|
4740
|
+
group_id: number;
|
|
4741
|
+
group_title: string;
|
|
4742
|
+
/** Format: decimal */
|
|
4743
|
+
price_modifier: string;
|
|
4744
|
+
};
|
|
4745
|
+
/** @description What the Create / Edit option dialog sends. All optional on PATCH. */
|
|
4746
|
+
OptionWrite: {
|
|
4747
|
+
title: string;
|
|
4748
|
+
description?: string;
|
|
4749
|
+
/** Format: uri */
|
|
4750
|
+
image_url?: string;
|
|
4751
|
+
visible?: boolean;
|
|
4752
|
+
snoozable?: boolean;
|
|
4753
|
+
};
|
|
4456
4754
|
Order: {
|
|
4457
4755
|
id: string;
|
|
4458
4756
|
order_number: string;
|
|
@@ -4495,11 +4793,19 @@ interface components {
|
|
|
4495
4793
|
subtotal: string;
|
|
4496
4794
|
/** Format: decimal */
|
|
4497
4795
|
tax_total: string;
|
|
4796
|
+
tax_total_includes_charges?: boolean;
|
|
4498
4797
|
/** Format: decimal */
|
|
4499
4798
|
shipping_cost: string;
|
|
4500
4799
|
/** Format: decimal */
|
|
4501
4800
|
discount_amount?: string;
|
|
4502
4801
|
discount_code?: string;
|
|
4802
|
+
/**
|
|
4803
|
+
* Format: decimal
|
|
4804
|
+
* @description Sum of the lines' line discounts.
|
|
4805
|
+
*/
|
|
4806
|
+
line_discount_total?: string;
|
|
4807
|
+
/** Format: decimal */
|
|
4808
|
+
readonly order_discount_total: string;
|
|
4503
4809
|
/**
|
|
4504
4810
|
* Format: decimal
|
|
4505
4811
|
* @description Aggregated non-discountable surcharges (VAT-inclusive)
|
|
@@ -4665,6 +4971,13 @@ interface components {
|
|
|
4665
4971
|
fulfillment_date?: string | null;
|
|
4666
4972
|
options?: unknown;
|
|
4667
4973
|
readonly surcharges: components["schemas"]["OrderLineItemSurcharge"][];
|
|
4974
|
+
/** Format: decimal */
|
|
4975
|
+
readonly line_discount_amount: string;
|
|
4976
|
+
readonly line_discount: components["schemas"]["LineDiscountRef"] | null;
|
|
4977
|
+
/** Format: decimal */
|
|
4978
|
+
readonly discounted_line_total: string;
|
|
4979
|
+
/** Format: decimal */
|
|
4980
|
+
readonly discounted_tax_amount: string;
|
|
4668
4981
|
};
|
|
4669
4982
|
/**
|
|
4670
4983
|
* @description The published shape of one entry in a line's surcharge snapshot.
|
|
@@ -4995,6 +5308,8 @@ interface components {
|
|
|
4995
5308
|
end_date?: string | null;
|
|
4996
5309
|
/** @description Total redemption limit (null=unlimited) */
|
|
4997
5310
|
max_redemptions?: number | null;
|
|
5311
|
+
/** @description Combines with other discounts. */
|
|
5312
|
+
combinable?: boolean;
|
|
4998
5313
|
readonly redemption_count?: number;
|
|
4999
5314
|
is_active?: boolean;
|
|
5000
5315
|
/** @description Fulfillment types this promotion applies to (empty = all). */
|
|
@@ -5171,6 +5486,8 @@ interface components {
|
|
|
5171
5486
|
readonly used_count?: number;
|
|
5172
5487
|
/** @description Per-customer redemption limit (null=unlimited) */
|
|
5173
5488
|
max_uses_per_customer?: number | null;
|
|
5489
|
+
/** @description Combines with other discounts. */
|
|
5490
|
+
combinable?: boolean;
|
|
5174
5491
|
/**
|
|
5175
5492
|
* Format: date-time
|
|
5176
5493
|
* @description When discount becomes active
|
|
@@ -5208,6 +5525,16 @@ interface components {
|
|
|
5208
5525
|
/** Format: date-time */
|
|
5209
5526
|
readonly updated_at?: string;
|
|
5210
5527
|
};
|
|
5528
|
+
/** @description What the Create / Edit group dialog sends. All optional on PATCH. */
|
|
5529
|
+
PatchedGroupWrite: {
|
|
5530
|
+
title?: string;
|
|
5531
|
+
description?: string;
|
|
5532
|
+
selection_type?: components["schemas"]["GroupWriteSelectionTypeEnum"];
|
|
5533
|
+
min_selections?: number;
|
|
5534
|
+
max_selections?: number | null;
|
|
5535
|
+
items?: components["schemas"]["GroupItemWrite"][];
|
|
5536
|
+
required?: boolean;
|
|
5537
|
+
};
|
|
5211
5538
|
PatchedMessageUpdate: {
|
|
5212
5539
|
priority?: number;
|
|
5213
5540
|
/** Format: date-time */
|
|
@@ -5218,6 +5545,15 @@ interface components {
|
|
|
5218
5545
|
dismiss_duration?: string | null;
|
|
5219
5546
|
targeting?: unknown;
|
|
5220
5547
|
};
|
|
5548
|
+
/** @description What the Create / Edit option dialog sends. All optional on PATCH. */
|
|
5549
|
+
PatchedOptionWrite: {
|
|
5550
|
+
title?: string;
|
|
5551
|
+
description?: string;
|
|
5552
|
+
/** Format: uri */
|
|
5553
|
+
image_url?: string;
|
|
5554
|
+
visible?: boolean;
|
|
5555
|
+
snoozable?: boolean;
|
|
5556
|
+
};
|
|
5221
5557
|
PatchedPrintDeviceUpdateRequest: {
|
|
5222
5558
|
copies?: number;
|
|
5223
5559
|
};
|
|
@@ -5606,6 +5942,9 @@ interface components {
|
|
|
5606
5942
|
readonly trend_score: string | null;
|
|
5607
5943
|
readonly promotion: components["schemas"]["ProductPromotion"] | null;
|
|
5608
5944
|
readonly auto_discount: components["schemas"]["ProductAutoDiscount"] | null;
|
|
5945
|
+
/** Format: decimal */
|
|
5946
|
+
readonly customer_service_fee: string | null;
|
|
5947
|
+
readonly peak_delivery_dates: string[];
|
|
5609
5948
|
/** Format: date-time */
|
|
5610
5949
|
readonly created_at: string;
|
|
5611
5950
|
/** Format: date-time */
|
|
@@ -5624,6 +5963,10 @@ interface components {
|
|
|
5624
5963
|
* @enum {string}
|
|
5625
5964
|
*/
|
|
5626
5965
|
ProductFulfilmentDatesReasonEnum: "no_dates";
|
|
5966
|
+
ProductGroup: {
|
|
5967
|
+
modifier_group_id: number;
|
|
5968
|
+
library_group: components["schemas"]["LibraryGroup"];
|
|
5969
|
+
};
|
|
5627
5970
|
ProductImage: {
|
|
5628
5971
|
readonly id: number;
|
|
5629
5972
|
/** Format: uri */
|
|
@@ -5694,13 +6037,20 @@ interface components {
|
|
|
5694
6037
|
ProductModifierGroup: {
|
|
5695
6038
|
readonly id: number;
|
|
5696
6039
|
readonly title: string;
|
|
5697
|
-
selection_type: components["schemas"]["
|
|
6040
|
+
selection_type: components["schemas"]["ProductModifierGroupSelectionTypeEnum"];
|
|
5698
6041
|
required?: boolean;
|
|
5699
6042
|
min_selections?: number;
|
|
5700
6043
|
max_selections?: number | null;
|
|
5701
6044
|
position?: number;
|
|
5702
6045
|
readonly modifiers: components["schemas"]["ProductModifier"][];
|
|
5703
6046
|
};
|
|
6047
|
+
/**
|
|
6048
|
+
* @description * `single` - Single
|
|
6049
|
+
* * `multiple` - Multiple
|
|
6050
|
+
* * `quantity` - Quantity
|
|
6051
|
+
* @enum {string}
|
|
6052
|
+
*/
|
|
6053
|
+
ProductModifierGroupSelectionTypeEnum: "single" | "multiple" | "quantity";
|
|
5704
6054
|
/** @description The closest pickup location: the same shape ``address-check`` returns. */
|
|
5705
6055
|
ProductNearestPickup: {
|
|
5706
6056
|
id: number;
|
|
@@ -5765,6 +6115,9 @@ interface components {
|
|
|
5765
6115
|
position?: number;
|
|
5766
6116
|
readonly attribute_values: components["schemas"]["VariantAttributeValue"][];
|
|
5767
6117
|
};
|
|
6118
|
+
ProductsAffected: {
|
|
6119
|
+
products_affected: number;
|
|
6120
|
+
};
|
|
5768
6121
|
Promotion: {
|
|
5769
6122
|
readonly id: number;
|
|
5770
6123
|
/** @description Per-location id (PAT-1306). Required when location_scope=SINGLE; NULL for SUBSET and ALL_LOCATIONS. */
|
|
@@ -5983,13 +6336,6 @@ interface components {
|
|
|
5983
6336
|
* @enum {string}
|
|
5984
6337
|
*/
|
|
5985
6338
|
SegmentTypeEnum: "system" | "custom" | "manual";
|
|
5986
|
-
/**
|
|
5987
|
-
* @description * `single` - Single
|
|
5988
|
-
* * `multiple` - Multiple
|
|
5989
|
-
* * `quantity` - Quantity
|
|
5990
|
-
* @enum {string}
|
|
5991
|
-
*/
|
|
5992
|
-
SelectionTypeEnum: "single" | "multiple" | "quantity";
|
|
5993
6339
|
SetDelivery: {
|
|
5994
6340
|
shipping_address?: unknown;
|
|
5995
6341
|
shipping_method?: unknown;
|
|
@@ -6023,6 +6369,16 @@ interface components {
|
|
|
6023
6369
|
SharedProductsRequest: {
|
|
6024
6370
|
store_public_ids: string[];
|
|
6025
6371
|
};
|
|
6372
|
+
/** @description One snoozed item. ``sold_out_options`` explains a ``required_group`` one. */
|
|
6373
|
+
Snooze: {
|
|
6374
|
+
item_type: components["schemas"]["ItemTypeEnum"];
|
|
6375
|
+
item_id: number;
|
|
6376
|
+
title: string;
|
|
6377
|
+
cause: components["schemas"]["CauseEnum"];
|
|
6378
|
+
/** Format: date-time */
|
|
6379
|
+
started_at: string;
|
|
6380
|
+
sold_out_options: string[];
|
|
6381
|
+
};
|
|
6026
6382
|
/**
|
|
6027
6383
|
* @description * `manual` - Manual
|
|
6028
6384
|
* * `auto` - Auto-translated
|
|
@@ -6331,6 +6687,14 @@ interface components {
|
|
|
6331
6687
|
slug: string;
|
|
6332
6688
|
abbreviation: string;
|
|
6333
6689
|
};
|
|
6690
|
+
/** @description ``minutes_snoozed`` is null when the item was not snoozed by hand. */
|
|
6691
|
+
UnsnoozeResult: {
|
|
6692
|
+
minutes_snoozed: number | null;
|
|
6693
|
+
};
|
|
6694
|
+
UsedInProduct: {
|
|
6695
|
+
product_id: number;
|
|
6696
|
+
title: string;
|
|
6697
|
+
};
|
|
6334
6698
|
User: {
|
|
6335
6699
|
/** @description Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */
|
|
6336
6700
|
username: string;
|
|
@@ -12104,6 +12468,1295 @@ interface operations {
|
|
|
12104
12468
|
};
|
|
12105
12469
|
};
|
|
12106
12470
|
};
|
|
12471
|
+
admin_stores_options_library_retrieve: {
|
|
12472
|
+
parameters: {
|
|
12473
|
+
query?: never;
|
|
12474
|
+
header?: {
|
|
12475
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12476
|
+
"X-Sous-Company-Id"?: number;
|
|
12477
|
+
};
|
|
12478
|
+
path: {
|
|
12479
|
+
store_public_id: string;
|
|
12480
|
+
};
|
|
12481
|
+
cookie?: never;
|
|
12482
|
+
};
|
|
12483
|
+
requestBody?: never;
|
|
12484
|
+
responses: {
|
|
12485
|
+
200: {
|
|
12486
|
+
headers: {
|
|
12487
|
+
[name: string]: unknown;
|
|
12488
|
+
};
|
|
12489
|
+
content: {
|
|
12490
|
+
"application/json": components["schemas"]["LibrarySummary"];
|
|
12491
|
+
};
|
|
12492
|
+
};
|
|
12493
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12494
|
+
400: {
|
|
12495
|
+
headers: {
|
|
12496
|
+
[name: string]: unknown;
|
|
12497
|
+
};
|
|
12498
|
+
content: {
|
|
12499
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12500
|
+
};
|
|
12501
|
+
};
|
|
12502
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12503
|
+
401: {
|
|
12504
|
+
headers: {
|
|
12505
|
+
[name: string]: unknown;
|
|
12506
|
+
};
|
|
12507
|
+
content: {
|
|
12508
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12509
|
+
};
|
|
12510
|
+
};
|
|
12511
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12512
|
+
403: {
|
|
12513
|
+
headers: {
|
|
12514
|
+
[name: string]: unknown;
|
|
12515
|
+
};
|
|
12516
|
+
content: {
|
|
12517
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12518
|
+
};
|
|
12519
|
+
};
|
|
12520
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12521
|
+
404: {
|
|
12522
|
+
headers: {
|
|
12523
|
+
[name: string]: unknown;
|
|
12524
|
+
};
|
|
12525
|
+
content: {
|
|
12526
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12527
|
+
};
|
|
12528
|
+
};
|
|
12529
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12530
|
+
429: {
|
|
12531
|
+
headers: {
|
|
12532
|
+
[name: string]: unknown;
|
|
12533
|
+
};
|
|
12534
|
+
content: {
|
|
12535
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12536
|
+
};
|
|
12537
|
+
};
|
|
12538
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12539
|
+
500: {
|
|
12540
|
+
headers: {
|
|
12541
|
+
[name: string]: unknown;
|
|
12542
|
+
};
|
|
12543
|
+
content: {
|
|
12544
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12545
|
+
};
|
|
12546
|
+
};
|
|
12547
|
+
};
|
|
12548
|
+
};
|
|
12549
|
+
admin_stores_options_library_channels_retrieve: {
|
|
12550
|
+
parameters: {
|
|
12551
|
+
query?: never;
|
|
12552
|
+
header?: {
|
|
12553
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12554
|
+
"X-Sous-Company-Id"?: number;
|
|
12555
|
+
};
|
|
12556
|
+
path: {
|
|
12557
|
+
store_public_id: string;
|
|
12558
|
+
};
|
|
12559
|
+
cookie?: never;
|
|
12560
|
+
};
|
|
12561
|
+
requestBody?: never;
|
|
12562
|
+
responses: {
|
|
12563
|
+
200: {
|
|
12564
|
+
headers: {
|
|
12565
|
+
[name: string]: unknown;
|
|
12566
|
+
};
|
|
12567
|
+
content: {
|
|
12568
|
+
"application/json": components["schemas"]["Channels"];
|
|
12569
|
+
};
|
|
12570
|
+
};
|
|
12571
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12572
|
+
400: {
|
|
12573
|
+
headers: {
|
|
12574
|
+
[name: string]: unknown;
|
|
12575
|
+
};
|
|
12576
|
+
content: {
|
|
12577
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12578
|
+
};
|
|
12579
|
+
};
|
|
12580
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12581
|
+
401: {
|
|
12582
|
+
headers: {
|
|
12583
|
+
[name: string]: unknown;
|
|
12584
|
+
};
|
|
12585
|
+
content: {
|
|
12586
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12587
|
+
};
|
|
12588
|
+
};
|
|
12589
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12590
|
+
403: {
|
|
12591
|
+
headers: {
|
|
12592
|
+
[name: string]: unknown;
|
|
12593
|
+
};
|
|
12594
|
+
content: {
|
|
12595
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12596
|
+
};
|
|
12597
|
+
};
|
|
12598
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12599
|
+
404: {
|
|
12600
|
+
headers: {
|
|
12601
|
+
[name: string]: unknown;
|
|
12602
|
+
};
|
|
12603
|
+
content: {
|
|
12604
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12605
|
+
};
|
|
12606
|
+
};
|
|
12607
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12608
|
+
429: {
|
|
12609
|
+
headers: {
|
|
12610
|
+
[name: string]: unknown;
|
|
12611
|
+
};
|
|
12612
|
+
content: {
|
|
12613
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12614
|
+
};
|
|
12615
|
+
};
|
|
12616
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12617
|
+
500: {
|
|
12618
|
+
headers: {
|
|
12619
|
+
[name: string]: unknown;
|
|
12620
|
+
};
|
|
12621
|
+
content: {
|
|
12622
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12623
|
+
};
|
|
12624
|
+
};
|
|
12625
|
+
};
|
|
12626
|
+
};
|
|
12627
|
+
admin_stores_options_library_groups_list: {
|
|
12628
|
+
parameters: {
|
|
12629
|
+
query?: never;
|
|
12630
|
+
header?: {
|
|
12631
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12632
|
+
"X-Sous-Company-Id"?: number;
|
|
12633
|
+
};
|
|
12634
|
+
path: {
|
|
12635
|
+
store_public_id: string;
|
|
12636
|
+
};
|
|
12637
|
+
cookie?: never;
|
|
12638
|
+
};
|
|
12639
|
+
requestBody?: never;
|
|
12640
|
+
responses: {
|
|
12641
|
+
200: {
|
|
12642
|
+
headers: {
|
|
12643
|
+
[name: string]: unknown;
|
|
12644
|
+
};
|
|
12645
|
+
content: {
|
|
12646
|
+
"application/json": components["schemas"]["LibraryGroup"][];
|
|
12647
|
+
};
|
|
12648
|
+
};
|
|
12649
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12650
|
+
400: {
|
|
12651
|
+
headers: {
|
|
12652
|
+
[name: string]: unknown;
|
|
12653
|
+
};
|
|
12654
|
+
content: {
|
|
12655
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12656
|
+
};
|
|
12657
|
+
};
|
|
12658
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12659
|
+
401: {
|
|
12660
|
+
headers: {
|
|
12661
|
+
[name: string]: unknown;
|
|
12662
|
+
};
|
|
12663
|
+
content: {
|
|
12664
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12665
|
+
};
|
|
12666
|
+
};
|
|
12667
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12668
|
+
403: {
|
|
12669
|
+
headers: {
|
|
12670
|
+
[name: string]: unknown;
|
|
12671
|
+
};
|
|
12672
|
+
content: {
|
|
12673
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12674
|
+
};
|
|
12675
|
+
};
|
|
12676
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12677
|
+
404: {
|
|
12678
|
+
headers: {
|
|
12679
|
+
[name: string]: unknown;
|
|
12680
|
+
};
|
|
12681
|
+
content: {
|
|
12682
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12683
|
+
};
|
|
12684
|
+
};
|
|
12685
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12686
|
+
429: {
|
|
12687
|
+
headers: {
|
|
12688
|
+
[name: string]: unknown;
|
|
12689
|
+
};
|
|
12690
|
+
content: {
|
|
12691
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12692
|
+
};
|
|
12693
|
+
};
|
|
12694
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12695
|
+
500: {
|
|
12696
|
+
headers: {
|
|
12697
|
+
[name: string]: unknown;
|
|
12698
|
+
};
|
|
12699
|
+
content: {
|
|
12700
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12701
|
+
};
|
|
12702
|
+
};
|
|
12703
|
+
};
|
|
12704
|
+
};
|
|
12705
|
+
admin_stores_options_library_groups_create: {
|
|
12706
|
+
parameters: {
|
|
12707
|
+
query?: never;
|
|
12708
|
+
header?: {
|
|
12709
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12710
|
+
"X-Sous-Company-Id"?: number;
|
|
12711
|
+
};
|
|
12712
|
+
path: {
|
|
12713
|
+
store_public_id: string;
|
|
12714
|
+
};
|
|
12715
|
+
cookie?: never;
|
|
12716
|
+
};
|
|
12717
|
+
requestBody: {
|
|
12718
|
+
content: {
|
|
12719
|
+
"application/json": components["schemas"]["GroupWrite"];
|
|
12720
|
+
"application/x-www-form-urlencoded": components["schemas"]["GroupWrite"];
|
|
12721
|
+
"multipart/form-data": components["schemas"]["GroupWrite"];
|
|
12722
|
+
};
|
|
12723
|
+
};
|
|
12724
|
+
responses: {
|
|
12725
|
+
201: {
|
|
12726
|
+
headers: {
|
|
12727
|
+
[name: string]: unknown;
|
|
12728
|
+
};
|
|
12729
|
+
content: {
|
|
12730
|
+
"application/json": components["schemas"]["LibraryGroup"];
|
|
12731
|
+
};
|
|
12732
|
+
};
|
|
12733
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12734
|
+
400: {
|
|
12735
|
+
headers: {
|
|
12736
|
+
[name: string]: unknown;
|
|
12737
|
+
};
|
|
12738
|
+
content: {
|
|
12739
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12740
|
+
};
|
|
12741
|
+
};
|
|
12742
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12743
|
+
401: {
|
|
12744
|
+
headers: {
|
|
12745
|
+
[name: string]: unknown;
|
|
12746
|
+
};
|
|
12747
|
+
content: {
|
|
12748
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12749
|
+
};
|
|
12750
|
+
};
|
|
12751
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12752
|
+
403: {
|
|
12753
|
+
headers: {
|
|
12754
|
+
[name: string]: unknown;
|
|
12755
|
+
};
|
|
12756
|
+
content: {
|
|
12757
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12758
|
+
};
|
|
12759
|
+
};
|
|
12760
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12761
|
+
404: {
|
|
12762
|
+
headers: {
|
|
12763
|
+
[name: string]: unknown;
|
|
12764
|
+
};
|
|
12765
|
+
content: {
|
|
12766
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12767
|
+
};
|
|
12768
|
+
};
|
|
12769
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12770
|
+
429: {
|
|
12771
|
+
headers: {
|
|
12772
|
+
[name: string]: unknown;
|
|
12773
|
+
};
|
|
12774
|
+
content: {
|
|
12775
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12776
|
+
};
|
|
12777
|
+
};
|
|
12778
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12779
|
+
500: {
|
|
12780
|
+
headers: {
|
|
12781
|
+
[name: string]: unknown;
|
|
12782
|
+
};
|
|
12783
|
+
content: {
|
|
12784
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12785
|
+
};
|
|
12786
|
+
};
|
|
12787
|
+
};
|
|
12788
|
+
};
|
|
12789
|
+
admin_stores_options_library_groups_destroy: {
|
|
12790
|
+
parameters: {
|
|
12791
|
+
query?: never;
|
|
12792
|
+
header?: {
|
|
12793
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12794
|
+
"X-Sous-Company-Id"?: number;
|
|
12795
|
+
};
|
|
12796
|
+
path: {
|
|
12797
|
+
group_id: number;
|
|
12798
|
+
store_public_id: string;
|
|
12799
|
+
};
|
|
12800
|
+
cookie?: never;
|
|
12801
|
+
};
|
|
12802
|
+
requestBody?: never;
|
|
12803
|
+
responses: {
|
|
12804
|
+
200: {
|
|
12805
|
+
headers: {
|
|
12806
|
+
[name: string]: unknown;
|
|
12807
|
+
};
|
|
12808
|
+
content: {
|
|
12809
|
+
"application/json": components["schemas"]["ProductsAffected"];
|
|
12810
|
+
};
|
|
12811
|
+
};
|
|
12812
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12813
|
+
400: {
|
|
12814
|
+
headers: {
|
|
12815
|
+
[name: string]: unknown;
|
|
12816
|
+
};
|
|
12817
|
+
content: {
|
|
12818
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12819
|
+
};
|
|
12820
|
+
};
|
|
12821
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12822
|
+
401: {
|
|
12823
|
+
headers: {
|
|
12824
|
+
[name: string]: unknown;
|
|
12825
|
+
};
|
|
12826
|
+
content: {
|
|
12827
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12828
|
+
};
|
|
12829
|
+
};
|
|
12830
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12831
|
+
403: {
|
|
12832
|
+
headers: {
|
|
12833
|
+
[name: string]: unknown;
|
|
12834
|
+
};
|
|
12835
|
+
content: {
|
|
12836
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12837
|
+
};
|
|
12838
|
+
};
|
|
12839
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12840
|
+
404: {
|
|
12841
|
+
headers: {
|
|
12842
|
+
[name: string]: unknown;
|
|
12843
|
+
};
|
|
12844
|
+
content: {
|
|
12845
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12846
|
+
};
|
|
12847
|
+
};
|
|
12848
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12849
|
+
429: {
|
|
12850
|
+
headers: {
|
|
12851
|
+
[name: string]: unknown;
|
|
12852
|
+
};
|
|
12853
|
+
content: {
|
|
12854
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12855
|
+
};
|
|
12856
|
+
};
|
|
12857
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12858
|
+
500: {
|
|
12859
|
+
headers: {
|
|
12860
|
+
[name: string]: unknown;
|
|
12861
|
+
};
|
|
12862
|
+
content: {
|
|
12863
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12864
|
+
};
|
|
12865
|
+
};
|
|
12866
|
+
};
|
|
12867
|
+
};
|
|
12868
|
+
admin_stores_options_library_groups_partial_update: {
|
|
12869
|
+
parameters: {
|
|
12870
|
+
query?: never;
|
|
12871
|
+
header?: {
|
|
12872
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12873
|
+
"X-Sous-Company-Id"?: number;
|
|
12874
|
+
};
|
|
12875
|
+
path: {
|
|
12876
|
+
group_id: number;
|
|
12877
|
+
store_public_id: string;
|
|
12878
|
+
};
|
|
12879
|
+
cookie?: never;
|
|
12880
|
+
};
|
|
12881
|
+
requestBody?: {
|
|
12882
|
+
content: {
|
|
12883
|
+
"application/json": components["schemas"]["PatchedGroupWrite"];
|
|
12884
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedGroupWrite"];
|
|
12885
|
+
"multipart/form-data": components["schemas"]["PatchedGroupWrite"];
|
|
12886
|
+
};
|
|
12887
|
+
};
|
|
12888
|
+
responses: {
|
|
12889
|
+
200: {
|
|
12890
|
+
headers: {
|
|
12891
|
+
[name: string]: unknown;
|
|
12892
|
+
};
|
|
12893
|
+
content: {
|
|
12894
|
+
"application/json": components["schemas"]["GroupEditResult"];
|
|
12895
|
+
};
|
|
12896
|
+
};
|
|
12897
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12898
|
+
400: {
|
|
12899
|
+
headers: {
|
|
12900
|
+
[name: string]: unknown;
|
|
12901
|
+
};
|
|
12902
|
+
content: {
|
|
12903
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12904
|
+
};
|
|
12905
|
+
};
|
|
12906
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12907
|
+
401: {
|
|
12908
|
+
headers: {
|
|
12909
|
+
[name: string]: unknown;
|
|
12910
|
+
};
|
|
12911
|
+
content: {
|
|
12912
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12913
|
+
};
|
|
12914
|
+
};
|
|
12915
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12916
|
+
403: {
|
|
12917
|
+
headers: {
|
|
12918
|
+
[name: string]: unknown;
|
|
12919
|
+
};
|
|
12920
|
+
content: {
|
|
12921
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12922
|
+
};
|
|
12923
|
+
};
|
|
12924
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12925
|
+
404: {
|
|
12926
|
+
headers: {
|
|
12927
|
+
[name: string]: unknown;
|
|
12928
|
+
};
|
|
12929
|
+
content: {
|
|
12930
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12931
|
+
};
|
|
12932
|
+
};
|
|
12933
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12934
|
+
429: {
|
|
12935
|
+
headers: {
|
|
12936
|
+
[name: string]: unknown;
|
|
12937
|
+
};
|
|
12938
|
+
content: {
|
|
12939
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12940
|
+
};
|
|
12941
|
+
};
|
|
12942
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12943
|
+
500: {
|
|
12944
|
+
headers: {
|
|
12945
|
+
[name: string]: unknown;
|
|
12946
|
+
};
|
|
12947
|
+
content: {
|
|
12948
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12949
|
+
};
|
|
12950
|
+
};
|
|
12951
|
+
};
|
|
12952
|
+
};
|
|
12953
|
+
admin_stores_options_library_options_list: {
|
|
12954
|
+
parameters: {
|
|
12955
|
+
query?: never;
|
|
12956
|
+
header?: {
|
|
12957
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12958
|
+
"X-Sous-Company-Id"?: number;
|
|
12959
|
+
};
|
|
12960
|
+
path: {
|
|
12961
|
+
store_public_id: string;
|
|
12962
|
+
};
|
|
12963
|
+
cookie?: never;
|
|
12964
|
+
};
|
|
12965
|
+
requestBody?: never;
|
|
12966
|
+
responses: {
|
|
12967
|
+
200: {
|
|
12968
|
+
headers: {
|
|
12969
|
+
[name: string]: unknown;
|
|
12970
|
+
};
|
|
12971
|
+
content: {
|
|
12972
|
+
"application/json": components["schemas"]["LibraryOption"][];
|
|
12973
|
+
};
|
|
12974
|
+
};
|
|
12975
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12976
|
+
400: {
|
|
12977
|
+
headers: {
|
|
12978
|
+
[name: string]: unknown;
|
|
12979
|
+
};
|
|
12980
|
+
content: {
|
|
12981
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12982
|
+
};
|
|
12983
|
+
};
|
|
12984
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12985
|
+
401: {
|
|
12986
|
+
headers: {
|
|
12987
|
+
[name: string]: unknown;
|
|
12988
|
+
};
|
|
12989
|
+
content: {
|
|
12990
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12991
|
+
};
|
|
12992
|
+
};
|
|
12993
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12994
|
+
403: {
|
|
12995
|
+
headers: {
|
|
12996
|
+
[name: string]: unknown;
|
|
12997
|
+
};
|
|
12998
|
+
content: {
|
|
12999
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13000
|
+
};
|
|
13001
|
+
};
|
|
13002
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13003
|
+
404: {
|
|
13004
|
+
headers: {
|
|
13005
|
+
[name: string]: unknown;
|
|
13006
|
+
};
|
|
13007
|
+
content: {
|
|
13008
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13009
|
+
};
|
|
13010
|
+
};
|
|
13011
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13012
|
+
429: {
|
|
13013
|
+
headers: {
|
|
13014
|
+
[name: string]: unknown;
|
|
13015
|
+
};
|
|
13016
|
+
content: {
|
|
13017
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13018
|
+
};
|
|
13019
|
+
};
|
|
13020
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13021
|
+
500: {
|
|
13022
|
+
headers: {
|
|
13023
|
+
[name: string]: unknown;
|
|
13024
|
+
};
|
|
13025
|
+
content: {
|
|
13026
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13027
|
+
};
|
|
13028
|
+
};
|
|
13029
|
+
};
|
|
13030
|
+
};
|
|
13031
|
+
admin_stores_options_library_options_create: {
|
|
13032
|
+
parameters: {
|
|
13033
|
+
query?: never;
|
|
13034
|
+
header?: {
|
|
13035
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13036
|
+
"X-Sous-Company-Id"?: number;
|
|
13037
|
+
};
|
|
13038
|
+
path: {
|
|
13039
|
+
store_public_id: string;
|
|
13040
|
+
};
|
|
13041
|
+
cookie?: never;
|
|
13042
|
+
};
|
|
13043
|
+
requestBody: {
|
|
13044
|
+
content: {
|
|
13045
|
+
"application/json": components["schemas"]["OptionWrite"];
|
|
13046
|
+
"application/x-www-form-urlencoded": components["schemas"]["OptionWrite"];
|
|
13047
|
+
"multipart/form-data": components["schemas"]["OptionWrite"];
|
|
13048
|
+
};
|
|
13049
|
+
};
|
|
13050
|
+
responses: {
|
|
13051
|
+
201: {
|
|
13052
|
+
headers: {
|
|
13053
|
+
[name: string]: unknown;
|
|
13054
|
+
};
|
|
13055
|
+
content: {
|
|
13056
|
+
"application/json": components["schemas"]["LibraryOption"];
|
|
13057
|
+
};
|
|
13058
|
+
};
|
|
13059
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13060
|
+
400: {
|
|
13061
|
+
headers: {
|
|
13062
|
+
[name: string]: unknown;
|
|
13063
|
+
};
|
|
13064
|
+
content: {
|
|
13065
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13066
|
+
};
|
|
13067
|
+
};
|
|
13068
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13069
|
+
401: {
|
|
13070
|
+
headers: {
|
|
13071
|
+
[name: string]: unknown;
|
|
13072
|
+
};
|
|
13073
|
+
content: {
|
|
13074
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13075
|
+
};
|
|
13076
|
+
};
|
|
13077
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13078
|
+
403: {
|
|
13079
|
+
headers: {
|
|
13080
|
+
[name: string]: unknown;
|
|
13081
|
+
};
|
|
13082
|
+
content: {
|
|
13083
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13084
|
+
};
|
|
13085
|
+
};
|
|
13086
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13087
|
+
404: {
|
|
13088
|
+
headers: {
|
|
13089
|
+
[name: string]: unknown;
|
|
13090
|
+
};
|
|
13091
|
+
content: {
|
|
13092
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13093
|
+
};
|
|
13094
|
+
};
|
|
13095
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13096
|
+
429: {
|
|
13097
|
+
headers: {
|
|
13098
|
+
[name: string]: unknown;
|
|
13099
|
+
};
|
|
13100
|
+
content: {
|
|
13101
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13102
|
+
};
|
|
13103
|
+
};
|
|
13104
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13105
|
+
500: {
|
|
13106
|
+
headers: {
|
|
13107
|
+
[name: string]: unknown;
|
|
13108
|
+
};
|
|
13109
|
+
content: {
|
|
13110
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13111
|
+
};
|
|
13112
|
+
};
|
|
13113
|
+
};
|
|
13114
|
+
};
|
|
13115
|
+
admin_stores_options_library_options_destroy: {
|
|
13116
|
+
parameters: {
|
|
13117
|
+
query?: never;
|
|
13118
|
+
header?: {
|
|
13119
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13120
|
+
"X-Sous-Company-Id"?: number;
|
|
13121
|
+
};
|
|
13122
|
+
path: {
|
|
13123
|
+
option_id: number;
|
|
13124
|
+
store_public_id: string;
|
|
13125
|
+
};
|
|
13126
|
+
cookie?: never;
|
|
13127
|
+
};
|
|
13128
|
+
requestBody?: never;
|
|
13129
|
+
responses: {
|
|
13130
|
+
200: {
|
|
13131
|
+
headers: {
|
|
13132
|
+
[name: string]: unknown;
|
|
13133
|
+
};
|
|
13134
|
+
content: {
|
|
13135
|
+
"application/json": components["schemas"]["ProductsAffected"];
|
|
13136
|
+
};
|
|
13137
|
+
};
|
|
13138
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13139
|
+
400: {
|
|
13140
|
+
headers: {
|
|
13141
|
+
[name: string]: unknown;
|
|
13142
|
+
};
|
|
13143
|
+
content: {
|
|
13144
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13145
|
+
};
|
|
13146
|
+
};
|
|
13147
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13148
|
+
401: {
|
|
13149
|
+
headers: {
|
|
13150
|
+
[name: string]: unknown;
|
|
13151
|
+
};
|
|
13152
|
+
content: {
|
|
13153
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13154
|
+
};
|
|
13155
|
+
};
|
|
13156
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13157
|
+
403: {
|
|
13158
|
+
headers: {
|
|
13159
|
+
[name: string]: unknown;
|
|
13160
|
+
};
|
|
13161
|
+
content: {
|
|
13162
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13163
|
+
};
|
|
13164
|
+
};
|
|
13165
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13166
|
+
404: {
|
|
13167
|
+
headers: {
|
|
13168
|
+
[name: string]: unknown;
|
|
13169
|
+
};
|
|
13170
|
+
content: {
|
|
13171
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13172
|
+
};
|
|
13173
|
+
};
|
|
13174
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13175
|
+
429: {
|
|
13176
|
+
headers: {
|
|
13177
|
+
[name: string]: unknown;
|
|
13178
|
+
};
|
|
13179
|
+
content: {
|
|
13180
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13181
|
+
};
|
|
13182
|
+
};
|
|
13183
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13184
|
+
500: {
|
|
13185
|
+
headers: {
|
|
13186
|
+
[name: string]: unknown;
|
|
13187
|
+
};
|
|
13188
|
+
content: {
|
|
13189
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13190
|
+
};
|
|
13191
|
+
};
|
|
13192
|
+
};
|
|
13193
|
+
};
|
|
13194
|
+
admin_stores_options_library_options_partial_update: {
|
|
13195
|
+
parameters: {
|
|
13196
|
+
query?: never;
|
|
13197
|
+
header?: {
|
|
13198
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13199
|
+
"X-Sous-Company-Id"?: number;
|
|
13200
|
+
};
|
|
13201
|
+
path: {
|
|
13202
|
+
option_id: number;
|
|
13203
|
+
store_public_id: string;
|
|
13204
|
+
};
|
|
13205
|
+
cookie?: never;
|
|
13206
|
+
};
|
|
13207
|
+
requestBody?: {
|
|
13208
|
+
content: {
|
|
13209
|
+
"application/json": components["schemas"]["PatchedOptionWrite"];
|
|
13210
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedOptionWrite"];
|
|
13211
|
+
"multipart/form-data": components["schemas"]["PatchedOptionWrite"];
|
|
13212
|
+
};
|
|
13213
|
+
};
|
|
13214
|
+
responses: {
|
|
13215
|
+
200: {
|
|
13216
|
+
headers: {
|
|
13217
|
+
[name: string]: unknown;
|
|
13218
|
+
};
|
|
13219
|
+
content: {
|
|
13220
|
+
"application/json": components["schemas"]["LibraryOption"];
|
|
13221
|
+
};
|
|
13222
|
+
};
|
|
13223
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13224
|
+
400: {
|
|
13225
|
+
headers: {
|
|
13226
|
+
[name: string]: unknown;
|
|
13227
|
+
};
|
|
13228
|
+
content: {
|
|
13229
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13230
|
+
};
|
|
13231
|
+
};
|
|
13232
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13233
|
+
401: {
|
|
13234
|
+
headers: {
|
|
13235
|
+
[name: string]: unknown;
|
|
13236
|
+
};
|
|
13237
|
+
content: {
|
|
13238
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13239
|
+
};
|
|
13240
|
+
};
|
|
13241
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13242
|
+
403: {
|
|
13243
|
+
headers: {
|
|
13244
|
+
[name: string]: unknown;
|
|
13245
|
+
};
|
|
13246
|
+
content: {
|
|
13247
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13248
|
+
};
|
|
13249
|
+
};
|
|
13250
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13251
|
+
404: {
|
|
13252
|
+
headers: {
|
|
13253
|
+
[name: string]: unknown;
|
|
13254
|
+
};
|
|
13255
|
+
content: {
|
|
13256
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13257
|
+
};
|
|
13258
|
+
};
|
|
13259
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13260
|
+
429: {
|
|
13261
|
+
headers: {
|
|
13262
|
+
[name: string]: unknown;
|
|
13263
|
+
};
|
|
13264
|
+
content: {
|
|
13265
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13266
|
+
};
|
|
13267
|
+
};
|
|
13268
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13269
|
+
500: {
|
|
13270
|
+
headers: {
|
|
13271
|
+
[name: string]: unknown;
|
|
13272
|
+
};
|
|
13273
|
+
content: {
|
|
13274
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13275
|
+
};
|
|
13276
|
+
};
|
|
13277
|
+
};
|
|
13278
|
+
};
|
|
13279
|
+
admin_stores_options_library_products_groups_list: {
|
|
13280
|
+
parameters: {
|
|
13281
|
+
query?: never;
|
|
13282
|
+
header?: {
|
|
13283
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13284
|
+
"X-Sous-Company-Id"?: number;
|
|
13285
|
+
};
|
|
13286
|
+
path: {
|
|
13287
|
+
product_id: number;
|
|
13288
|
+
store_public_id: string;
|
|
13289
|
+
};
|
|
13290
|
+
cookie?: never;
|
|
13291
|
+
};
|
|
13292
|
+
requestBody?: never;
|
|
13293
|
+
responses: {
|
|
13294
|
+
200: {
|
|
13295
|
+
headers: {
|
|
13296
|
+
[name: string]: unknown;
|
|
13297
|
+
};
|
|
13298
|
+
content: {
|
|
13299
|
+
"application/json": components["schemas"]["ProductGroup"][];
|
|
13300
|
+
};
|
|
13301
|
+
};
|
|
13302
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13303
|
+
400: {
|
|
13304
|
+
headers: {
|
|
13305
|
+
[name: string]: unknown;
|
|
13306
|
+
};
|
|
13307
|
+
content: {
|
|
13308
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13309
|
+
};
|
|
13310
|
+
};
|
|
13311
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13312
|
+
401: {
|
|
13313
|
+
headers: {
|
|
13314
|
+
[name: string]: unknown;
|
|
13315
|
+
};
|
|
13316
|
+
content: {
|
|
13317
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13318
|
+
};
|
|
13319
|
+
};
|
|
13320
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13321
|
+
403: {
|
|
13322
|
+
headers: {
|
|
13323
|
+
[name: string]: unknown;
|
|
13324
|
+
};
|
|
13325
|
+
content: {
|
|
13326
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13327
|
+
};
|
|
13328
|
+
};
|
|
13329
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13330
|
+
404: {
|
|
13331
|
+
headers: {
|
|
13332
|
+
[name: string]: unknown;
|
|
13333
|
+
};
|
|
13334
|
+
content: {
|
|
13335
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13336
|
+
};
|
|
13337
|
+
};
|
|
13338
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13339
|
+
429: {
|
|
13340
|
+
headers: {
|
|
13341
|
+
[name: string]: unknown;
|
|
13342
|
+
};
|
|
13343
|
+
content: {
|
|
13344
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13345
|
+
};
|
|
13346
|
+
};
|
|
13347
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13348
|
+
500: {
|
|
13349
|
+
headers: {
|
|
13350
|
+
[name: string]: unknown;
|
|
13351
|
+
};
|
|
13352
|
+
content: {
|
|
13353
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13354
|
+
};
|
|
13355
|
+
};
|
|
13356
|
+
};
|
|
13357
|
+
};
|
|
13358
|
+
admin_stores_options_library_products_groups_create: {
|
|
13359
|
+
parameters: {
|
|
13360
|
+
query?: never;
|
|
13361
|
+
header?: {
|
|
13362
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13363
|
+
"X-Sous-Company-Id"?: number;
|
|
13364
|
+
};
|
|
13365
|
+
path: {
|
|
13366
|
+
product_id: number;
|
|
13367
|
+
store_public_id: string;
|
|
13368
|
+
};
|
|
13369
|
+
cookie?: never;
|
|
13370
|
+
};
|
|
13371
|
+
requestBody?: {
|
|
13372
|
+
content: {
|
|
13373
|
+
"application/json": components["schemas"]["AttachGroup"];
|
|
13374
|
+
"application/x-www-form-urlencoded": components["schemas"]["AttachGroup"];
|
|
13375
|
+
"multipart/form-data": components["schemas"]["AttachGroup"];
|
|
13376
|
+
};
|
|
13377
|
+
};
|
|
13378
|
+
responses: {
|
|
13379
|
+
201: {
|
|
13380
|
+
headers: {
|
|
13381
|
+
[name: string]: unknown;
|
|
13382
|
+
};
|
|
13383
|
+
content: {
|
|
13384
|
+
"application/json": components["schemas"]["ProductGroup"];
|
|
13385
|
+
};
|
|
13386
|
+
};
|
|
13387
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13388
|
+
400: {
|
|
13389
|
+
headers: {
|
|
13390
|
+
[name: string]: unknown;
|
|
13391
|
+
};
|
|
13392
|
+
content: {
|
|
13393
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13394
|
+
};
|
|
13395
|
+
};
|
|
13396
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13397
|
+
401: {
|
|
13398
|
+
headers: {
|
|
13399
|
+
[name: string]: unknown;
|
|
13400
|
+
};
|
|
13401
|
+
content: {
|
|
13402
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13403
|
+
};
|
|
13404
|
+
};
|
|
13405
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13406
|
+
403: {
|
|
13407
|
+
headers: {
|
|
13408
|
+
[name: string]: unknown;
|
|
13409
|
+
};
|
|
13410
|
+
content: {
|
|
13411
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13412
|
+
};
|
|
13413
|
+
};
|
|
13414
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13415
|
+
404: {
|
|
13416
|
+
headers: {
|
|
13417
|
+
[name: string]: unknown;
|
|
13418
|
+
};
|
|
13419
|
+
content: {
|
|
13420
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13421
|
+
};
|
|
13422
|
+
};
|
|
13423
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13424
|
+
429: {
|
|
13425
|
+
headers: {
|
|
13426
|
+
[name: string]: unknown;
|
|
13427
|
+
};
|
|
13428
|
+
content: {
|
|
13429
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13430
|
+
};
|
|
13431
|
+
};
|
|
13432
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13433
|
+
500: {
|
|
13434
|
+
headers: {
|
|
13435
|
+
[name: string]: unknown;
|
|
13436
|
+
};
|
|
13437
|
+
content: {
|
|
13438
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13439
|
+
};
|
|
13440
|
+
};
|
|
13441
|
+
};
|
|
13442
|
+
};
|
|
13443
|
+
admin_stores_options_library_products_groups_destroy: {
|
|
13444
|
+
parameters: {
|
|
13445
|
+
query?: never;
|
|
13446
|
+
header?: {
|
|
13447
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13448
|
+
"X-Sous-Company-Id"?: number;
|
|
13449
|
+
};
|
|
13450
|
+
path: {
|
|
13451
|
+
modifier_group_id: number;
|
|
13452
|
+
product_id: number;
|
|
13453
|
+
store_public_id: string;
|
|
13454
|
+
};
|
|
13455
|
+
cookie?: never;
|
|
13456
|
+
};
|
|
13457
|
+
requestBody?: never;
|
|
13458
|
+
responses: {
|
|
13459
|
+
/** @description No response body */
|
|
13460
|
+
204: {
|
|
13461
|
+
headers: {
|
|
13462
|
+
[name: string]: unknown;
|
|
13463
|
+
};
|
|
13464
|
+
content?: never;
|
|
13465
|
+
};
|
|
13466
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13467
|
+
400: {
|
|
13468
|
+
headers: {
|
|
13469
|
+
[name: string]: unknown;
|
|
13470
|
+
};
|
|
13471
|
+
content: {
|
|
13472
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13473
|
+
};
|
|
13474
|
+
};
|
|
13475
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13476
|
+
401: {
|
|
13477
|
+
headers: {
|
|
13478
|
+
[name: string]: unknown;
|
|
13479
|
+
};
|
|
13480
|
+
content: {
|
|
13481
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13482
|
+
};
|
|
13483
|
+
};
|
|
13484
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13485
|
+
403: {
|
|
13486
|
+
headers: {
|
|
13487
|
+
[name: string]: unknown;
|
|
13488
|
+
};
|
|
13489
|
+
content: {
|
|
13490
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13491
|
+
};
|
|
13492
|
+
};
|
|
13493
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13494
|
+
404: {
|
|
13495
|
+
headers: {
|
|
13496
|
+
[name: string]: unknown;
|
|
13497
|
+
};
|
|
13498
|
+
content: {
|
|
13499
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13500
|
+
};
|
|
13501
|
+
};
|
|
13502
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13503
|
+
429: {
|
|
13504
|
+
headers: {
|
|
13505
|
+
[name: string]: unknown;
|
|
13506
|
+
};
|
|
13507
|
+
content: {
|
|
13508
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13509
|
+
};
|
|
13510
|
+
};
|
|
13511
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13512
|
+
500: {
|
|
13513
|
+
headers: {
|
|
13514
|
+
[name: string]: unknown;
|
|
13515
|
+
};
|
|
13516
|
+
content: {
|
|
13517
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13518
|
+
};
|
|
13519
|
+
};
|
|
13520
|
+
};
|
|
13521
|
+
};
|
|
13522
|
+
admin_stores_options_library_snoozes_list: {
|
|
13523
|
+
parameters: {
|
|
13524
|
+
query?: never;
|
|
13525
|
+
header?: {
|
|
13526
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13527
|
+
"X-Sous-Company-Id"?: number;
|
|
13528
|
+
};
|
|
13529
|
+
path: {
|
|
13530
|
+
store_public_id: string;
|
|
13531
|
+
};
|
|
13532
|
+
cookie?: never;
|
|
13533
|
+
};
|
|
13534
|
+
requestBody?: never;
|
|
13535
|
+
responses: {
|
|
13536
|
+
200: {
|
|
13537
|
+
headers: {
|
|
13538
|
+
[name: string]: unknown;
|
|
13539
|
+
};
|
|
13540
|
+
content: {
|
|
13541
|
+
"application/json": components["schemas"]["Snooze"][];
|
|
13542
|
+
};
|
|
13543
|
+
};
|
|
13544
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13545
|
+
400: {
|
|
13546
|
+
headers: {
|
|
13547
|
+
[name: string]: unknown;
|
|
13548
|
+
};
|
|
13549
|
+
content: {
|
|
13550
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13551
|
+
};
|
|
13552
|
+
};
|
|
13553
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13554
|
+
401: {
|
|
13555
|
+
headers: {
|
|
13556
|
+
[name: string]: unknown;
|
|
13557
|
+
};
|
|
13558
|
+
content: {
|
|
13559
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13560
|
+
};
|
|
13561
|
+
};
|
|
13562
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13563
|
+
403: {
|
|
13564
|
+
headers: {
|
|
13565
|
+
[name: string]: unknown;
|
|
13566
|
+
};
|
|
13567
|
+
content: {
|
|
13568
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13569
|
+
};
|
|
13570
|
+
};
|
|
13571
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13572
|
+
404: {
|
|
13573
|
+
headers: {
|
|
13574
|
+
[name: string]: unknown;
|
|
13575
|
+
};
|
|
13576
|
+
content: {
|
|
13577
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13578
|
+
};
|
|
13579
|
+
};
|
|
13580
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13581
|
+
429: {
|
|
13582
|
+
headers: {
|
|
13583
|
+
[name: string]: unknown;
|
|
13584
|
+
};
|
|
13585
|
+
content: {
|
|
13586
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13587
|
+
};
|
|
13588
|
+
};
|
|
13589
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13590
|
+
500: {
|
|
13591
|
+
headers: {
|
|
13592
|
+
[name: string]: unknown;
|
|
13593
|
+
};
|
|
13594
|
+
content: {
|
|
13595
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13596
|
+
};
|
|
13597
|
+
};
|
|
13598
|
+
};
|
|
13599
|
+
};
|
|
13600
|
+
admin_stores_options_library_snoozes_update: {
|
|
13601
|
+
parameters: {
|
|
13602
|
+
query?: never;
|
|
13603
|
+
header?: {
|
|
13604
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13605
|
+
"X-Sous-Company-Id"?: number;
|
|
13606
|
+
};
|
|
13607
|
+
path: {
|
|
13608
|
+
item_id: number;
|
|
13609
|
+
item_type: string;
|
|
13610
|
+
store_public_id: string;
|
|
13611
|
+
};
|
|
13612
|
+
cookie?: never;
|
|
13613
|
+
};
|
|
13614
|
+
requestBody?: never;
|
|
13615
|
+
responses: {
|
|
13616
|
+
200: {
|
|
13617
|
+
headers: {
|
|
13618
|
+
[name: string]: unknown;
|
|
13619
|
+
};
|
|
13620
|
+
content: {
|
|
13621
|
+
"application/json": components["schemas"]["Snooze"];
|
|
13622
|
+
};
|
|
13623
|
+
};
|
|
13624
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13625
|
+
400: {
|
|
13626
|
+
headers: {
|
|
13627
|
+
[name: string]: unknown;
|
|
13628
|
+
};
|
|
13629
|
+
content: {
|
|
13630
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13631
|
+
};
|
|
13632
|
+
};
|
|
13633
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13634
|
+
401: {
|
|
13635
|
+
headers: {
|
|
13636
|
+
[name: string]: unknown;
|
|
13637
|
+
};
|
|
13638
|
+
content: {
|
|
13639
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13640
|
+
};
|
|
13641
|
+
};
|
|
13642
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13643
|
+
403: {
|
|
13644
|
+
headers: {
|
|
13645
|
+
[name: string]: unknown;
|
|
13646
|
+
};
|
|
13647
|
+
content: {
|
|
13648
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13649
|
+
};
|
|
13650
|
+
};
|
|
13651
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13652
|
+
404: {
|
|
13653
|
+
headers: {
|
|
13654
|
+
[name: string]: unknown;
|
|
13655
|
+
};
|
|
13656
|
+
content: {
|
|
13657
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13658
|
+
};
|
|
13659
|
+
};
|
|
13660
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13661
|
+
429: {
|
|
13662
|
+
headers: {
|
|
13663
|
+
[name: string]: unknown;
|
|
13664
|
+
};
|
|
13665
|
+
content: {
|
|
13666
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13667
|
+
};
|
|
13668
|
+
};
|
|
13669
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13670
|
+
500: {
|
|
13671
|
+
headers: {
|
|
13672
|
+
[name: string]: unknown;
|
|
13673
|
+
};
|
|
13674
|
+
content: {
|
|
13675
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13676
|
+
};
|
|
13677
|
+
};
|
|
13678
|
+
};
|
|
13679
|
+
};
|
|
13680
|
+
admin_stores_options_library_snoozes_destroy: {
|
|
13681
|
+
parameters: {
|
|
13682
|
+
query?: never;
|
|
13683
|
+
header?: {
|
|
13684
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13685
|
+
"X-Sous-Company-Id"?: number;
|
|
13686
|
+
};
|
|
13687
|
+
path: {
|
|
13688
|
+
item_id: number;
|
|
13689
|
+
item_type: string;
|
|
13690
|
+
store_public_id: string;
|
|
13691
|
+
};
|
|
13692
|
+
cookie?: never;
|
|
13693
|
+
};
|
|
13694
|
+
requestBody?: never;
|
|
13695
|
+
responses: {
|
|
13696
|
+
200: {
|
|
13697
|
+
headers: {
|
|
13698
|
+
[name: string]: unknown;
|
|
13699
|
+
};
|
|
13700
|
+
content: {
|
|
13701
|
+
"application/json": components["schemas"]["UnsnoozeResult"];
|
|
13702
|
+
};
|
|
13703
|
+
};
|
|
13704
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13705
|
+
400: {
|
|
13706
|
+
headers: {
|
|
13707
|
+
[name: string]: unknown;
|
|
13708
|
+
};
|
|
13709
|
+
content: {
|
|
13710
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13711
|
+
};
|
|
13712
|
+
};
|
|
13713
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13714
|
+
401: {
|
|
13715
|
+
headers: {
|
|
13716
|
+
[name: string]: unknown;
|
|
13717
|
+
};
|
|
13718
|
+
content: {
|
|
13719
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13720
|
+
};
|
|
13721
|
+
};
|
|
13722
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13723
|
+
403: {
|
|
13724
|
+
headers: {
|
|
13725
|
+
[name: string]: unknown;
|
|
13726
|
+
};
|
|
13727
|
+
content: {
|
|
13728
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13729
|
+
};
|
|
13730
|
+
};
|
|
13731
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13732
|
+
404: {
|
|
13733
|
+
headers: {
|
|
13734
|
+
[name: string]: unknown;
|
|
13735
|
+
};
|
|
13736
|
+
content: {
|
|
13737
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13738
|
+
};
|
|
13739
|
+
};
|
|
13740
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13741
|
+
429: {
|
|
13742
|
+
headers: {
|
|
13743
|
+
[name: string]: unknown;
|
|
13744
|
+
};
|
|
13745
|
+
content: {
|
|
13746
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13747
|
+
};
|
|
13748
|
+
};
|
|
13749
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13750
|
+
500: {
|
|
13751
|
+
headers: {
|
|
13752
|
+
[name: string]: unknown;
|
|
13753
|
+
};
|
|
13754
|
+
content: {
|
|
13755
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13756
|
+
};
|
|
13757
|
+
};
|
|
13758
|
+
};
|
|
13759
|
+
};
|
|
12107
13760
|
admin_stores_surcharges_list: {
|
|
12108
13761
|
parameters: {
|
|
12109
13762
|
query?: never;
|