@poweredbysous/storefront-admin-sdk 4.2.0 → 4.3.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 +382 -0
- package/dist/index.d.ts +382 -0
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -476,6 +476,63 @@ interface paths {
|
|
|
476
476
|
patch?: never;
|
|
477
477
|
trace?: never;
|
|
478
478
|
};
|
|
479
|
+
"/api/v1/admin/printing/jobs/": {
|
|
480
|
+
parameters: {
|
|
481
|
+
query?: never;
|
|
482
|
+
header?: never;
|
|
483
|
+
path?: never;
|
|
484
|
+
cookie?: never;
|
|
485
|
+
};
|
|
486
|
+
/** @description The latest print job per printer for an order: did it print? */
|
|
487
|
+
get: operations["admin_printing_order_jobs"];
|
|
488
|
+
put?: never;
|
|
489
|
+
post?: never;
|
|
490
|
+
delete?: never;
|
|
491
|
+
options?: never;
|
|
492
|
+
head?: never;
|
|
493
|
+
patch?: never;
|
|
494
|
+
trace?: never;
|
|
495
|
+
};
|
|
496
|
+
"/api/v1/admin/printing/print-order/": {
|
|
497
|
+
parameters: {
|
|
498
|
+
query?: never;
|
|
499
|
+
header?: never;
|
|
500
|
+
path?: never;
|
|
501
|
+
cookie?: never;
|
|
502
|
+
};
|
|
503
|
+
get?: never;
|
|
504
|
+
put?: never;
|
|
505
|
+
/**
|
|
506
|
+
* @description Print an order again on the store's cloud printers.
|
|
507
|
+
*
|
|
508
|
+
* 202 with the jobs created (or, for a repeated ``request_id``, the jobs the
|
|
509
|
+
* first request created). 409 when the store has no enabled printer for the
|
|
510
|
+
* order's kitchen, so the portal can fall back to printing locally.
|
|
511
|
+
*/
|
|
512
|
+
post: operations["admin_printing_print_order"];
|
|
513
|
+
delete?: never;
|
|
514
|
+
options?: never;
|
|
515
|
+
head?: never;
|
|
516
|
+
patch?: never;
|
|
517
|
+
trace?: never;
|
|
518
|
+
};
|
|
519
|
+
"/api/v1/admin/printing/stores/{store_public_id}/devices/": {
|
|
520
|
+
parameters: {
|
|
521
|
+
query?: never;
|
|
522
|
+
header?: never;
|
|
523
|
+
path?: never;
|
|
524
|
+
cookie?: never;
|
|
525
|
+
};
|
|
526
|
+
/** @description The store's enabled cloud printers. An empty list: no cloud printing. */
|
|
527
|
+
get: operations["admin_printing_store_devices"];
|
|
528
|
+
put?: never;
|
|
529
|
+
post?: never;
|
|
530
|
+
delete?: never;
|
|
531
|
+
options?: never;
|
|
532
|
+
head?: never;
|
|
533
|
+
patch?: never;
|
|
534
|
+
trace?: never;
|
|
535
|
+
};
|
|
479
536
|
"/api/v1/admin/products/": {
|
|
480
537
|
parameters: {
|
|
481
538
|
query?: never;
|
|
@@ -3462,6 +3519,12 @@ interface components {
|
|
|
3462
3519
|
public_id: string;
|
|
3463
3520
|
fulfillment_types: string[];
|
|
3464
3521
|
};
|
|
3522
|
+
/**
|
|
3523
|
+
* @description * `ok` - ok
|
|
3524
|
+
* * `alerting` - alerting
|
|
3525
|
+
* @enum {string}
|
|
3526
|
+
*/
|
|
3527
|
+
AlertStateEnum: "ok" | "alerting";
|
|
3465
3528
|
/**
|
|
3466
3529
|
* @description * `order` - Entire Order
|
|
3467
3530
|
* * `shipping` - Shipping
|
|
@@ -4159,6 +4222,23 @@ interface components {
|
|
|
4159
4222
|
/** Format: date-time */
|
|
4160
4223
|
readonly updated_at: string;
|
|
4161
4224
|
};
|
|
4225
|
+
/**
|
|
4226
|
+
* @description A merchant pressed Print on an order in the merchant portal.
|
|
4227
|
+
*
|
|
4228
|
+
* ``order_id`` is the storefront Order PK and ``store_id`` the storefront
|
|
4229
|
+
* ``Store.id``, as merchant-portal-backend records them on its order
|
|
4230
|
+
* (``external_id``, ``metadata.store_id``). The store must be the merchant's
|
|
4231
|
+
* and must own the order. ``request_id`` is generated per click: a retry
|
|
4232
|
+
* with the same id prints nothing new. Who asked is read from the login
|
|
4233
|
+
* token, not from the body.
|
|
4234
|
+
*/
|
|
4235
|
+
MerchantPrintOrderRequest: {
|
|
4236
|
+
/** Format: uuid */
|
|
4237
|
+
order_id: string;
|
|
4238
|
+
store_id: number;
|
|
4239
|
+
/** Format: uuid */
|
|
4240
|
+
request_id: string;
|
|
4241
|
+
};
|
|
4162
4242
|
MessageContent: {
|
|
4163
4243
|
/** Format: uuid */
|
|
4164
4244
|
readonly id: string;
|
|
@@ -5195,6 +5275,47 @@ interface components {
|
|
|
5195
5275
|
[key: string]: unknown;
|
|
5196
5276
|
}[];
|
|
5197
5277
|
};
|
|
5278
|
+
PrintDevice: {
|
|
5279
|
+
id: number;
|
|
5280
|
+
name: string;
|
|
5281
|
+
/**
|
|
5282
|
+
* @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
|
|
5283
|
+
*
|
|
5284
|
+
* * `ok` - ok
|
|
5285
|
+
* * `alerting` - alerting
|
|
5286
|
+
*/
|
|
5287
|
+
alert_state: components["schemas"]["AlertStateEnum"];
|
|
5288
|
+
/** Format: date-time */
|
|
5289
|
+
last_seen_at: string | null;
|
|
5290
|
+
};
|
|
5291
|
+
PrintDevicesResponse: {
|
|
5292
|
+
devices: components["schemas"]["PrintDevice"][];
|
|
5293
|
+
};
|
|
5294
|
+
PrintJob: {
|
|
5295
|
+
/** Format: uuid */
|
|
5296
|
+
id: string;
|
|
5297
|
+
device_id: number;
|
|
5298
|
+
device_name: string;
|
|
5299
|
+
trigger: components["schemas"]["TriggerEnum"];
|
|
5300
|
+
status: components["schemas"]["PrintJobStatusEnum"];
|
|
5301
|
+
failure_reason: string;
|
|
5302
|
+
/** Format: date-time */
|
|
5303
|
+
queued_at: string;
|
|
5304
|
+
/** Format: date-time */
|
|
5305
|
+
printed_at: string | null;
|
|
5306
|
+
};
|
|
5307
|
+
/**
|
|
5308
|
+
* @description * `queued` - queued
|
|
5309
|
+
* * `announced` - announced
|
|
5310
|
+
* * `collected` - collected
|
|
5311
|
+
* * `printed` - printed
|
|
5312
|
+
* * `failed` - failed
|
|
5313
|
+
* @enum {string}
|
|
5314
|
+
*/
|
|
5315
|
+
PrintJobStatusEnum: "queued" | "announced" | "collected" | "printed" | "failed";
|
|
5316
|
+
PrintJobsResponse: {
|
|
5317
|
+
jobs: components["schemas"]["PrintJob"][];
|
|
5318
|
+
};
|
|
5198
5319
|
/** @description Write serializer for merchant-initiated or merchant-approved refunds. */
|
|
5199
5320
|
ProcessRefund: {
|
|
5200
5321
|
/** Format: uuid */
|
|
@@ -6033,6 +6154,12 @@ interface components {
|
|
|
6033
6154
|
/** Format: date-time */
|
|
6034
6155
|
readonly created_at: string;
|
|
6035
6156
|
};
|
|
6157
|
+
/**
|
|
6158
|
+
* @description * `auto` - auto
|
|
6159
|
+
* * `manual` - manual
|
|
6160
|
+
* @enum {string}
|
|
6161
|
+
*/
|
|
6162
|
+
TriggerEnum: "auto" | "manual";
|
|
6036
6163
|
/**
|
|
6037
6164
|
* @description * `authorization_request` - Authorization Request
|
|
6038
6165
|
* * `authorization_success` - Authorization Success
|
|
@@ -8293,6 +8420,261 @@ interface operations {
|
|
|
8293
8420
|
};
|
|
8294
8421
|
};
|
|
8295
8422
|
};
|
|
8423
|
+
admin_printing_order_jobs: {
|
|
8424
|
+
parameters: {
|
|
8425
|
+
query: {
|
|
8426
|
+
order_id: string;
|
|
8427
|
+
store_id: number;
|
|
8428
|
+
};
|
|
8429
|
+
header?: {
|
|
8430
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
8431
|
+
"X-Sous-Company-Id"?: number;
|
|
8432
|
+
};
|
|
8433
|
+
path?: never;
|
|
8434
|
+
cookie?: never;
|
|
8435
|
+
};
|
|
8436
|
+
requestBody?: never;
|
|
8437
|
+
responses: {
|
|
8438
|
+
200: {
|
|
8439
|
+
headers: {
|
|
8440
|
+
[name: string]: unknown;
|
|
8441
|
+
};
|
|
8442
|
+
content: {
|
|
8443
|
+
"application/json": components["schemas"]["PrintJobsResponse"];
|
|
8444
|
+
};
|
|
8445
|
+
};
|
|
8446
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8447
|
+
400: {
|
|
8448
|
+
headers: {
|
|
8449
|
+
[name: string]: unknown;
|
|
8450
|
+
};
|
|
8451
|
+
content: {
|
|
8452
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8453
|
+
};
|
|
8454
|
+
};
|
|
8455
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8456
|
+
401: {
|
|
8457
|
+
headers: {
|
|
8458
|
+
[name: string]: unknown;
|
|
8459
|
+
};
|
|
8460
|
+
content: {
|
|
8461
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8462
|
+
};
|
|
8463
|
+
};
|
|
8464
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8465
|
+
403: {
|
|
8466
|
+
headers: {
|
|
8467
|
+
[name: string]: unknown;
|
|
8468
|
+
};
|
|
8469
|
+
content: {
|
|
8470
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8471
|
+
};
|
|
8472
|
+
};
|
|
8473
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8474
|
+
404: {
|
|
8475
|
+
headers: {
|
|
8476
|
+
[name: string]: unknown;
|
|
8477
|
+
};
|
|
8478
|
+
content: {
|
|
8479
|
+
"application/json": {
|
|
8480
|
+
[key: string]: unknown;
|
|
8481
|
+
};
|
|
8482
|
+
};
|
|
8483
|
+
};
|
|
8484
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8485
|
+
429: {
|
|
8486
|
+
headers: {
|
|
8487
|
+
[name: string]: unknown;
|
|
8488
|
+
};
|
|
8489
|
+
content: {
|
|
8490
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8491
|
+
};
|
|
8492
|
+
};
|
|
8493
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8494
|
+
500: {
|
|
8495
|
+
headers: {
|
|
8496
|
+
[name: string]: unknown;
|
|
8497
|
+
};
|
|
8498
|
+
content: {
|
|
8499
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8500
|
+
};
|
|
8501
|
+
};
|
|
8502
|
+
};
|
|
8503
|
+
};
|
|
8504
|
+
admin_printing_print_order: {
|
|
8505
|
+
parameters: {
|
|
8506
|
+
query?: never;
|
|
8507
|
+
header?: {
|
|
8508
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
8509
|
+
"X-Sous-Company-Id"?: number;
|
|
8510
|
+
};
|
|
8511
|
+
path?: never;
|
|
8512
|
+
cookie?: never;
|
|
8513
|
+
};
|
|
8514
|
+
requestBody: {
|
|
8515
|
+
content: {
|
|
8516
|
+
"application/json": components["schemas"]["MerchantPrintOrderRequest"];
|
|
8517
|
+
"application/x-www-form-urlencoded": components["schemas"]["MerchantPrintOrderRequest"];
|
|
8518
|
+
"multipart/form-data": components["schemas"]["MerchantPrintOrderRequest"];
|
|
8519
|
+
};
|
|
8520
|
+
};
|
|
8521
|
+
responses: {
|
|
8522
|
+
202: {
|
|
8523
|
+
headers: {
|
|
8524
|
+
[name: string]: unknown;
|
|
8525
|
+
};
|
|
8526
|
+
content: {
|
|
8527
|
+
"application/json": components["schemas"]["PrintJobsResponse"];
|
|
8528
|
+
};
|
|
8529
|
+
};
|
|
8530
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8531
|
+
400: {
|
|
8532
|
+
headers: {
|
|
8533
|
+
[name: string]: unknown;
|
|
8534
|
+
};
|
|
8535
|
+
content: {
|
|
8536
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8537
|
+
};
|
|
8538
|
+
};
|
|
8539
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8540
|
+
401: {
|
|
8541
|
+
headers: {
|
|
8542
|
+
[name: string]: unknown;
|
|
8543
|
+
};
|
|
8544
|
+
content: {
|
|
8545
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8546
|
+
};
|
|
8547
|
+
};
|
|
8548
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8549
|
+
403: {
|
|
8550
|
+
headers: {
|
|
8551
|
+
[name: string]: unknown;
|
|
8552
|
+
};
|
|
8553
|
+
content: {
|
|
8554
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8555
|
+
};
|
|
8556
|
+
};
|
|
8557
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8558
|
+
404: {
|
|
8559
|
+
headers: {
|
|
8560
|
+
[name: string]: unknown;
|
|
8561
|
+
};
|
|
8562
|
+
content: {
|
|
8563
|
+
"application/json": {
|
|
8564
|
+
[key: string]: unknown;
|
|
8565
|
+
};
|
|
8566
|
+
};
|
|
8567
|
+
};
|
|
8568
|
+
409: {
|
|
8569
|
+
headers: {
|
|
8570
|
+
[name: string]: unknown;
|
|
8571
|
+
};
|
|
8572
|
+
content: {
|
|
8573
|
+
"application/json": {
|
|
8574
|
+
[key: string]: unknown;
|
|
8575
|
+
};
|
|
8576
|
+
};
|
|
8577
|
+
};
|
|
8578
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8579
|
+
429: {
|
|
8580
|
+
headers: {
|
|
8581
|
+
[name: string]: unknown;
|
|
8582
|
+
};
|
|
8583
|
+
content: {
|
|
8584
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8585
|
+
};
|
|
8586
|
+
};
|
|
8587
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8588
|
+
500: {
|
|
8589
|
+
headers: {
|
|
8590
|
+
[name: string]: unknown;
|
|
8591
|
+
};
|
|
8592
|
+
content: {
|
|
8593
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8594
|
+
};
|
|
8595
|
+
};
|
|
8596
|
+
};
|
|
8597
|
+
};
|
|
8598
|
+
admin_printing_store_devices: {
|
|
8599
|
+
parameters: {
|
|
8600
|
+
query?: never;
|
|
8601
|
+
header?: {
|
|
8602
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
8603
|
+
"X-Sous-Company-Id"?: number;
|
|
8604
|
+
};
|
|
8605
|
+
path: {
|
|
8606
|
+
store_public_id: string;
|
|
8607
|
+
};
|
|
8608
|
+
cookie?: never;
|
|
8609
|
+
};
|
|
8610
|
+
requestBody?: never;
|
|
8611
|
+
responses: {
|
|
8612
|
+
200: {
|
|
8613
|
+
headers: {
|
|
8614
|
+
[name: string]: unknown;
|
|
8615
|
+
};
|
|
8616
|
+
content: {
|
|
8617
|
+
"application/json": components["schemas"]["PrintDevicesResponse"];
|
|
8618
|
+
};
|
|
8619
|
+
};
|
|
8620
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8621
|
+
400: {
|
|
8622
|
+
headers: {
|
|
8623
|
+
[name: string]: unknown;
|
|
8624
|
+
};
|
|
8625
|
+
content: {
|
|
8626
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8627
|
+
};
|
|
8628
|
+
};
|
|
8629
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8630
|
+
401: {
|
|
8631
|
+
headers: {
|
|
8632
|
+
[name: string]: unknown;
|
|
8633
|
+
};
|
|
8634
|
+
content: {
|
|
8635
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8636
|
+
};
|
|
8637
|
+
};
|
|
8638
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8639
|
+
403: {
|
|
8640
|
+
headers: {
|
|
8641
|
+
[name: string]: unknown;
|
|
8642
|
+
};
|
|
8643
|
+
content: {
|
|
8644
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8645
|
+
};
|
|
8646
|
+
};
|
|
8647
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8648
|
+
404: {
|
|
8649
|
+
headers: {
|
|
8650
|
+
[name: string]: unknown;
|
|
8651
|
+
};
|
|
8652
|
+
content: {
|
|
8653
|
+
"application/json": {
|
|
8654
|
+
[key: string]: unknown;
|
|
8655
|
+
};
|
|
8656
|
+
};
|
|
8657
|
+
};
|
|
8658
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8659
|
+
429: {
|
|
8660
|
+
headers: {
|
|
8661
|
+
[name: string]: unknown;
|
|
8662
|
+
};
|
|
8663
|
+
content: {
|
|
8664
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8665
|
+
};
|
|
8666
|
+
};
|
|
8667
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8668
|
+
500: {
|
|
8669
|
+
headers: {
|
|
8670
|
+
[name: string]: unknown;
|
|
8671
|
+
};
|
|
8672
|
+
content: {
|
|
8673
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8674
|
+
};
|
|
8675
|
+
};
|
|
8676
|
+
};
|
|
8677
|
+
};
|
|
8296
8678
|
admin_products_list: {
|
|
8297
8679
|
parameters: {
|
|
8298
8680
|
query?: {
|
package/dist/index.d.ts
CHANGED
|
@@ -476,6 +476,63 @@ interface paths {
|
|
|
476
476
|
patch?: never;
|
|
477
477
|
trace?: never;
|
|
478
478
|
};
|
|
479
|
+
"/api/v1/admin/printing/jobs/": {
|
|
480
|
+
parameters: {
|
|
481
|
+
query?: never;
|
|
482
|
+
header?: never;
|
|
483
|
+
path?: never;
|
|
484
|
+
cookie?: never;
|
|
485
|
+
};
|
|
486
|
+
/** @description The latest print job per printer for an order: did it print? */
|
|
487
|
+
get: operations["admin_printing_order_jobs"];
|
|
488
|
+
put?: never;
|
|
489
|
+
post?: never;
|
|
490
|
+
delete?: never;
|
|
491
|
+
options?: never;
|
|
492
|
+
head?: never;
|
|
493
|
+
patch?: never;
|
|
494
|
+
trace?: never;
|
|
495
|
+
};
|
|
496
|
+
"/api/v1/admin/printing/print-order/": {
|
|
497
|
+
parameters: {
|
|
498
|
+
query?: never;
|
|
499
|
+
header?: never;
|
|
500
|
+
path?: never;
|
|
501
|
+
cookie?: never;
|
|
502
|
+
};
|
|
503
|
+
get?: never;
|
|
504
|
+
put?: never;
|
|
505
|
+
/**
|
|
506
|
+
* @description Print an order again on the store's cloud printers.
|
|
507
|
+
*
|
|
508
|
+
* 202 with the jobs created (or, for a repeated ``request_id``, the jobs the
|
|
509
|
+
* first request created). 409 when the store has no enabled printer for the
|
|
510
|
+
* order's kitchen, so the portal can fall back to printing locally.
|
|
511
|
+
*/
|
|
512
|
+
post: operations["admin_printing_print_order"];
|
|
513
|
+
delete?: never;
|
|
514
|
+
options?: never;
|
|
515
|
+
head?: never;
|
|
516
|
+
patch?: never;
|
|
517
|
+
trace?: never;
|
|
518
|
+
};
|
|
519
|
+
"/api/v1/admin/printing/stores/{store_public_id}/devices/": {
|
|
520
|
+
parameters: {
|
|
521
|
+
query?: never;
|
|
522
|
+
header?: never;
|
|
523
|
+
path?: never;
|
|
524
|
+
cookie?: never;
|
|
525
|
+
};
|
|
526
|
+
/** @description The store's enabled cloud printers. An empty list: no cloud printing. */
|
|
527
|
+
get: operations["admin_printing_store_devices"];
|
|
528
|
+
put?: never;
|
|
529
|
+
post?: never;
|
|
530
|
+
delete?: never;
|
|
531
|
+
options?: never;
|
|
532
|
+
head?: never;
|
|
533
|
+
patch?: never;
|
|
534
|
+
trace?: never;
|
|
535
|
+
};
|
|
479
536
|
"/api/v1/admin/products/": {
|
|
480
537
|
parameters: {
|
|
481
538
|
query?: never;
|
|
@@ -3462,6 +3519,12 @@ interface components {
|
|
|
3462
3519
|
public_id: string;
|
|
3463
3520
|
fulfillment_types: string[];
|
|
3464
3521
|
};
|
|
3522
|
+
/**
|
|
3523
|
+
* @description * `ok` - ok
|
|
3524
|
+
* * `alerting` - alerting
|
|
3525
|
+
* @enum {string}
|
|
3526
|
+
*/
|
|
3527
|
+
AlertStateEnum: "ok" | "alerting";
|
|
3465
3528
|
/**
|
|
3466
3529
|
* @description * `order` - Entire Order
|
|
3467
3530
|
* * `shipping` - Shipping
|
|
@@ -4159,6 +4222,23 @@ interface components {
|
|
|
4159
4222
|
/** Format: date-time */
|
|
4160
4223
|
readonly updated_at: string;
|
|
4161
4224
|
};
|
|
4225
|
+
/**
|
|
4226
|
+
* @description A merchant pressed Print on an order in the merchant portal.
|
|
4227
|
+
*
|
|
4228
|
+
* ``order_id`` is the storefront Order PK and ``store_id`` the storefront
|
|
4229
|
+
* ``Store.id``, as merchant-portal-backend records them on its order
|
|
4230
|
+
* (``external_id``, ``metadata.store_id``). The store must be the merchant's
|
|
4231
|
+
* and must own the order. ``request_id`` is generated per click: a retry
|
|
4232
|
+
* with the same id prints nothing new. Who asked is read from the login
|
|
4233
|
+
* token, not from the body.
|
|
4234
|
+
*/
|
|
4235
|
+
MerchantPrintOrderRequest: {
|
|
4236
|
+
/** Format: uuid */
|
|
4237
|
+
order_id: string;
|
|
4238
|
+
store_id: number;
|
|
4239
|
+
/** Format: uuid */
|
|
4240
|
+
request_id: string;
|
|
4241
|
+
};
|
|
4162
4242
|
MessageContent: {
|
|
4163
4243
|
/** Format: uuid */
|
|
4164
4244
|
readonly id: string;
|
|
@@ -5195,6 +5275,47 @@ interface components {
|
|
|
5195
5275
|
[key: string]: unknown;
|
|
5196
5276
|
}[];
|
|
5197
5277
|
};
|
|
5278
|
+
PrintDevice: {
|
|
5279
|
+
id: number;
|
|
5280
|
+
name: string;
|
|
5281
|
+
/**
|
|
5282
|
+
* @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
|
|
5283
|
+
*
|
|
5284
|
+
* * `ok` - ok
|
|
5285
|
+
* * `alerting` - alerting
|
|
5286
|
+
*/
|
|
5287
|
+
alert_state: components["schemas"]["AlertStateEnum"];
|
|
5288
|
+
/** Format: date-time */
|
|
5289
|
+
last_seen_at: string | null;
|
|
5290
|
+
};
|
|
5291
|
+
PrintDevicesResponse: {
|
|
5292
|
+
devices: components["schemas"]["PrintDevice"][];
|
|
5293
|
+
};
|
|
5294
|
+
PrintJob: {
|
|
5295
|
+
/** Format: uuid */
|
|
5296
|
+
id: string;
|
|
5297
|
+
device_id: number;
|
|
5298
|
+
device_name: string;
|
|
5299
|
+
trigger: components["schemas"]["TriggerEnum"];
|
|
5300
|
+
status: components["schemas"]["PrintJobStatusEnum"];
|
|
5301
|
+
failure_reason: string;
|
|
5302
|
+
/** Format: date-time */
|
|
5303
|
+
queued_at: string;
|
|
5304
|
+
/** Format: date-time */
|
|
5305
|
+
printed_at: string | null;
|
|
5306
|
+
};
|
|
5307
|
+
/**
|
|
5308
|
+
* @description * `queued` - queued
|
|
5309
|
+
* * `announced` - announced
|
|
5310
|
+
* * `collected` - collected
|
|
5311
|
+
* * `printed` - printed
|
|
5312
|
+
* * `failed` - failed
|
|
5313
|
+
* @enum {string}
|
|
5314
|
+
*/
|
|
5315
|
+
PrintJobStatusEnum: "queued" | "announced" | "collected" | "printed" | "failed";
|
|
5316
|
+
PrintJobsResponse: {
|
|
5317
|
+
jobs: components["schemas"]["PrintJob"][];
|
|
5318
|
+
};
|
|
5198
5319
|
/** @description Write serializer for merchant-initiated or merchant-approved refunds. */
|
|
5199
5320
|
ProcessRefund: {
|
|
5200
5321
|
/** Format: uuid */
|
|
@@ -6033,6 +6154,12 @@ interface components {
|
|
|
6033
6154
|
/** Format: date-time */
|
|
6034
6155
|
readonly created_at: string;
|
|
6035
6156
|
};
|
|
6157
|
+
/**
|
|
6158
|
+
* @description * `auto` - auto
|
|
6159
|
+
* * `manual` - manual
|
|
6160
|
+
* @enum {string}
|
|
6161
|
+
*/
|
|
6162
|
+
TriggerEnum: "auto" | "manual";
|
|
6036
6163
|
/**
|
|
6037
6164
|
* @description * `authorization_request` - Authorization Request
|
|
6038
6165
|
* * `authorization_success` - Authorization Success
|
|
@@ -8293,6 +8420,261 @@ interface operations {
|
|
|
8293
8420
|
};
|
|
8294
8421
|
};
|
|
8295
8422
|
};
|
|
8423
|
+
admin_printing_order_jobs: {
|
|
8424
|
+
parameters: {
|
|
8425
|
+
query: {
|
|
8426
|
+
order_id: string;
|
|
8427
|
+
store_id: number;
|
|
8428
|
+
};
|
|
8429
|
+
header?: {
|
|
8430
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
8431
|
+
"X-Sous-Company-Id"?: number;
|
|
8432
|
+
};
|
|
8433
|
+
path?: never;
|
|
8434
|
+
cookie?: never;
|
|
8435
|
+
};
|
|
8436
|
+
requestBody?: never;
|
|
8437
|
+
responses: {
|
|
8438
|
+
200: {
|
|
8439
|
+
headers: {
|
|
8440
|
+
[name: string]: unknown;
|
|
8441
|
+
};
|
|
8442
|
+
content: {
|
|
8443
|
+
"application/json": components["schemas"]["PrintJobsResponse"];
|
|
8444
|
+
};
|
|
8445
|
+
};
|
|
8446
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8447
|
+
400: {
|
|
8448
|
+
headers: {
|
|
8449
|
+
[name: string]: unknown;
|
|
8450
|
+
};
|
|
8451
|
+
content: {
|
|
8452
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8453
|
+
};
|
|
8454
|
+
};
|
|
8455
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8456
|
+
401: {
|
|
8457
|
+
headers: {
|
|
8458
|
+
[name: string]: unknown;
|
|
8459
|
+
};
|
|
8460
|
+
content: {
|
|
8461
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8462
|
+
};
|
|
8463
|
+
};
|
|
8464
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8465
|
+
403: {
|
|
8466
|
+
headers: {
|
|
8467
|
+
[name: string]: unknown;
|
|
8468
|
+
};
|
|
8469
|
+
content: {
|
|
8470
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8471
|
+
};
|
|
8472
|
+
};
|
|
8473
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8474
|
+
404: {
|
|
8475
|
+
headers: {
|
|
8476
|
+
[name: string]: unknown;
|
|
8477
|
+
};
|
|
8478
|
+
content: {
|
|
8479
|
+
"application/json": {
|
|
8480
|
+
[key: string]: unknown;
|
|
8481
|
+
};
|
|
8482
|
+
};
|
|
8483
|
+
};
|
|
8484
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8485
|
+
429: {
|
|
8486
|
+
headers: {
|
|
8487
|
+
[name: string]: unknown;
|
|
8488
|
+
};
|
|
8489
|
+
content: {
|
|
8490
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8491
|
+
};
|
|
8492
|
+
};
|
|
8493
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8494
|
+
500: {
|
|
8495
|
+
headers: {
|
|
8496
|
+
[name: string]: unknown;
|
|
8497
|
+
};
|
|
8498
|
+
content: {
|
|
8499
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8500
|
+
};
|
|
8501
|
+
};
|
|
8502
|
+
};
|
|
8503
|
+
};
|
|
8504
|
+
admin_printing_print_order: {
|
|
8505
|
+
parameters: {
|
|
8506
|
+
query?: never;
|
|
8507
|
+
header?: {
|
|
8508
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
8509
|
+
"X-Sous-Company-Id"?: number;
|
|
8510
|
+
};
|
|
8511
|
+
path?: never;
|
|
8512
|
+
cookie?: never;
|
|
8513
|
+
};
|
|
8514
|
+
requestBody: {
|
|
8515
|
+
content: {
|
|
8516
|
+
"application/json": components["schemas"]["MerchantPrintOrderRequest"];
|
|
8517
|
+
"application/x-www-form-urlencoded": components["schemas"]["MerchantPrintOrderRequest"];
|
|
8518
|
+
"multipart/form-data": components["schemas"]["MerchantPrintOrderRequest"];
|
|
8519
|
+
};
|
|
8520
|
+
};
|
|
8521
|
+
responses: {
|
|
8522
|
+
202: {
|
|
8523
|
+
headers: {
|
|
8524
|
+
[name: string]: unknown;
|
|
8525
|
+
};
|
|
8526
|
+
content: {
|
|
8527
|
+
"application/json": components["schemas"]["PrintJobsResponse"];
|
|
8528
|
+
};
|
|
8529
|
+
};
|
|
8530
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8531
|
+
400: {
|
|
8532
|
+
headers: {
|
|
8533
|
+
[name: string]: unknown;
|
|
8534
|
+
};
|
|
8535
|
+
content: {
|
|
8536
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8537
|
+
};
|
|
8538
|
+
};
|
|
8539
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8540
|
+
401: {
|
|
8541
|
+
headers: {
|
|
8542
|
+
[name: string]: unknown;
|
|
8543
|
+
};
|
|
8544
|
+
content: {
|
|
8545
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8546
|
+
};
|
|
8547
|
+
};
|
|
8548
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8549
|
+
403: {
|
|
8550
|
+
headers: {
|
|
8551
|
+
[name: string]: unknown;
|
|
8552
|
+
};
|
|
8553
|
+
content: {
|
|
8554
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8555
|
+
};
|
|
8556
|
+
};
|
|
8557
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8558
|
+
404: {
|
|
8559
|
+
headers: {
|
|
8560
|
+
[name: string]: unknown;
|
|
8561
|
+
};
|
|
8562
|
+
content: {
|
|
8563
|
+
"application/json": {
|
|
8564
|
+
[key: string]: unknown;
|
|
8565
|
+
};
|
|
8566
|
+
};
|
|
8567
|
+
};
|
|
8568
|
+
409: {
|
|
8569
|
+
headers: {
|
|
8570
|
+
[name: string]: unknown;
|
|
8571
|
+
};
|
|
8572
|
+
content: {
|
|
8573
|
+
"application/json": {
|
|
8574
|
+
[key: string]: unknown;
|
|
8575
|
+
};
|
|
8576
|
+
};
|
|
8577
|
+
};
|
|
8578
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8579
|
+
429: {
|
|
8580
|
+
headers: {
|
|
8581
|
+
[name: string]: unknown;
|
|
8582
|
+
};
|
|
8583
|
+
content: {
|
|
8584
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8585
|
+
};
|
|
8586
|
+
};
|
|
8587
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8588
|
+
500: {
|
|
8589
|
+
headers: {
|
|
8590
|
+
[name: string]: unknown;
|
|
8591
|
+
};
|
|
8592
|
+
content: {
|
|
8593
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8594
|
+
};
|
|
8595
|
+
};
|
|
8596
|
+
};
|
|
8597
|
+
};
|
|
8598
|
+
admin_printing_store_devices: {
|
|
8599
|
+
parameters: {
|
|
8600
|
+
query?: never;
|
|
8601
|
+
header?: {
|
|
8602
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
8603
|
+
"X-Sous-Company-Id"?: number;
|
|
8604
|
+
};
|
|
8605
|
+
path: {
|
|
8606
|
+
store_public_id: string;
|
|
8607
|
+
};
|
|
8608
|
+
cookie?: never;
|
|
8609
|
+
};
|
|
8610
|
+
requestBody?: never;
|
|
8611
|
+
responses: {
|
|
8612
|
+
200: {
|
|
8613
|
+
headers: {
|
|
8614
|
+
[name: string]: unknown;
|
|
8615
|
+
};
|
|
8616
|
+
content: {
|
|
8617
|
+
"application/json": components["schemas"]["PrintDevicesResponse"];
|
|
8618
|
+
};
|
|
8619
|
+
};
|
|
8620
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8621
|
+
400: {
|
|
8622
|
+
headers: {
|
|
8623
|
+
[name: string]: unknown;
|
|
8624
|
+
};
|
|
8625
|
+
content: {
|
|
8626
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8627
|
+
};
|
|
8628
|
+
};
|
|
8629
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8630
|
+
401: {
|
|
8631
|
+
headers: {
|
|
8632
|
+
[name: string]: unknown;
|
|
8633
|
+
};
|
|
8634
|
+
content: {
|
|
8635
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8636
|
+
};
|
|
8637
|
+
};
|
|
8638
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8639
|
+
403: {
|
|
8640
|
+
headers: {
|
|
8641
|
+
[name: string]: unknown;
|
|
8642
|
+
};
|
|
8643
|
+
content: {
|
|
8644
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8645
|
+
};
|
|
8646
|
+
};
|
|
8647
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8648
|
+
404: {
|
|
8649
|
+
headers: {
|
|
8650
|
+
[name: string]: unknown;
|
|
8651
|
+
};
|
|
8652
|
+
content: {
|
|
8653
|
+
"application/json": {
|
|
8654
|
+
[key: string]: unknown;
|
|
8655
|
+
};
|
|
8656
|
+
};
|
|
8657
|
+
};
|
|
8658
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8659
|
+
429: {
|
|
8660
|
+
headers: {
|
|
8661
|
+
[name: string]: unknown;
|
|
8662
|
+
};
|
|
8663
|
+
content: {
|
|
8664
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8665
|
+
};
|
|
8666
|
+
};
|
|
8667
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
8668
|
+
500: {
|
|
8669
|
+
headers: {
|
|
8670
|
+
[name: string]: unknown;
|
|
8671
|
+
};
|
|
8672
|
+
content: {
|
|
8673
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
8674
|
+
};
|
|
8675
|
+
};
|
|
8676
|
+
};
|
|
8677
|
+
};
|
|
8296
8678
|
admin_products_list: {
|
|
8297
8679
|
parameters: {
|
|
8298
8680
|
query?: {
|