@poweredbysous/storefront-admin-sdk 4.3.1 → 4.5.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 CHANGED
@@ -353,6 +353,30 @@ interface paths {
353
353
  patch?: never;
354
354
  trace?: never;
355
355
  };
356
+ "/api/v1/admin/nationwide-shipping/": {
357
+ parameters: {
358
+ query?: never;
359
+ header?: never;
360
+ path?: never;
361
+ cookie?: never;
362
+ };
363
+ /**
364
+ * Read the company's nationwide-shipping switch
365
+ * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
366
+ */
367
+ get: operations["admin_nationwide_shipping_retrieve"];
368
+ put?: never;
369
+ post?: never;
370
+ delete?: never;
371
+ options?: never;
372
+ head?: never;
373
+ /**
374
+ * Switch nationwide shipping on or off for every store of the company
375
+ * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
376
+ */
377
+ patch: operations["admin_nationwide_shipping_partial_update"];
378
+ trace?: never;
379
+ };
356
380
  "/api/v1/admin/pages/": {
357
381
  parameters: {
358
382
  query?: never;
@@ -523,16 +547,38 @@ interface paths {
523
547
  path?: never;
524
548
  cookie?: never;
525
549
  };
526
- /** @description The store's enabled cloud printers. An empty list: no cloud printing. */
550
+ /**
551
+ * @description The store's enabled cloud printers (an empty list: no cloud printing).
552
+ *
553
+ * Backoffice can add one.
554
+ */
527
555
  get: operations["admin_printing_store_devices"];
528
556
  put?: never;
529
- post?: never;
557
+ /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
558
+ post: operations["admin_printing_add_store_device"];
530
559
  delete?: never;
531
560
  options?: never;
532
561
  head?: never;
533
562
  patch?: never;
534
563
  trace?: never;
535
564
  };
565
+ "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/": {
566
+ parameters: {
567
+ query?: never;
568
+ header?: never;
569
+ path?: never;
570
+ cookie?: never;
571
+ };
572
+ get?: never;
573
+ put?: never;
574
+ post?: never;
575
+ delete?: never;
576
+ options?: never;
577
+ head?: never;
578
+ /** @description One printer of the store: change its tickets per order (backoffice only). */
579
+ patch: operations["admin_printing_update_store_device"];
580
+ trace?: never;
581
+ };
536
582
  "/api/v1/admin/products/": {
537
583
  parameters: {
538
584
  query?: never;
@@ -4370,6 +4416,13 @@ interface components {
4370
4416
  * @enum {string}
4371
4417
  */
4372
4418
  NamespaceEnum: "merchant" | "product" | "category" | "collection" | "geocoding" | "shipping" | "translation" | "keycloak" | "segment" | "page" | "channel";
4419
+ /** @description The company's nationwide-shipping switch (exploreSOUS). */
4420
+ NationwideShipping: {
4421
+ /** @description Whether the company is on exploreSOUS and so has the switch. */
4422
+ is_available: boolean;
4423
+ /** @description Whether any of the company's stores ships nationwide. */
4424
+ is_enabled: boolean;
4425
+ };
4373
4426
  /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
4374
4427
  OpenStatus: {
4375
4428
  open: boolean;
@@ -5139,6 +5192,9 @@ interface components {
5139
5192
  dismiss_duration?: string | null;
5140
5193
  targeting?: unknown;
5141
5194
  };
5195
+ PatchedPrintDeviceUpdateRequest: {
5196
+ copies?: number;
5197
+ };
5142
5198
  PatchedProductChannelListing: {
5143
5199
  readonly id?: number;
5144
5200
  readonly product_id?: number;
@@ -5207,6 +5263,9 @@ interface components {
5207
5263
  PatchedSetCompanyAvailability: {
5208
5264
  is_available?: boolean;
5209
5265
  };
5266
+ PatchedSetNationwideShipping: {
5267
+ is_enabled?: boolean;
5268
+ };
5210
5269
  /**
5211
5270
  * @description PATCH body for a store's delivery-method row.
5212
5271
  *
@@ -5278,6 +5337,10 @@ interface components {
5278
5337
  PrintDevice: {
5279
5338
  id: number;
5280
5339
  name: string;
5340
+ /** @description The printer's serial number (Sunmi: the MSN on its label). */
5341
+ device_identifier: string;
5342
+ /** @description Tickets per automatic print. A manual print is always one. */
5343
+ copies: number;
5281
5344
  /**
5282
5345
  * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
5283
5346
  *
@@ -5287,6 +5350,25 @@ interface components {
5287
5350
  alert_state: components["schemas"]["AlertStateEnum"];
5288
5351
  /** Format: date-time */
5289
5352
  last_seen_at: string | null;
5353
+ /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
5354
+ online: boolean | null;
5355
+ /**
5356
+ * Format: date-time
5357
+ * @description When that check ran.
5358
+ */
5359
+ online_checked_at: string | null;
5360
+ };
5361
+ /** @description A backoffice user adds a printer to the store in the URL. */
5362
+ PrintDeviceCreateRequest: {
5363
+ /** @description Serial from the printer's label, e.g. N439259A11700. */
5364
+ device_identifier: string;
5365
+ /** @description e.g. "Kitchen" */
5366
+ name: string;
5367
+ /**
5368
+ * @description Tickets per automatic print.
5369
+ * @default 1
5370
+ */
5371
+ copies: number;
5290
5372
  };
5291
5373
  PrintDevicesResponse: {
5292
5374
  devices: components["schemas"]["PrintDevice"][];
@@ -7501,6 +7583,182 @@ interface operations {
7501
7583
  };
7502
7584
  };
7503
7585
  };
7586
+ admin_nationwide_shipping_retrieve: {
7587
+ parameters: {
7588
+ query?: never;
7589
+ header?: {
7590
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
7591
+ "X-Sous-Company-Id"?: number;
7592
+ };
7593
+ path?: never;
7594
+ cookie?: never;
7595
+ };
7596
+ requestBody?: never;
7597
+ responses: {
7598
+ 200: {
7599
+ headers: {
7600
+ [name: string]: unknown;
7601
+ };
7602
+ content: {
7603
+ "application/json": components["schemas"]["NationwideShipping"];
7604
+ };
7605
+ };
7606
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7607
+ 400: {
7608
+ headers: {
7609
+ [name: string]: unknown;
7610
+ };
7611
+ content: {
7612
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7613
+ };
7614
+ };
7615
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
7616
+ 401: {
7617
+ headers: {
7618
+ [name: string]: unknown;
7619
+ };
7620
+ content: {
7621
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7622
+ };
7623
+ };
7624
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
7625
+ 403: {
7626
+ headers: {
7627
+ [name: string]: unknown;
7628
+ };
7629
+ content: {
7630
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7631
+ };
7632
+ };
7633
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
7634
+ 404: {
7635
+ headers: {
7636
+ [name: string]: unknown;
7637
+ };
7638
+ content: {
7639
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7640
+ };
7641
+ };
7642
+ /** @description Possible error codes include `NATIONWIDE_CARRIER_UNCLEAR`. Use `x-error-codes` for machine-readable retryability metadata. */
7643
+ 409: {
7644
+ headers: {
7645
+ [name: string]: unknown;
7646
+ };
7647
+ content: {
7648
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7649
+ };
7650
+ };
7651
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
7652
+ 429: {
7653
+ headers: {
7654
+ [name: string]: unknown;
7655
+ };
7656
+ content: {
7657
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7658
+ };
7659
+ };
7660
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7661
+ 500: {
7662
+ headers: {
7663
+ [name: string]: unknown;
7664
+ };
7665
+ content: {
7666
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7667
+ };
7668
+ };
7669
+ };
7670
+ };
7671
+ admin_nationwide_shipping_partial_update: {
7672
+ parameters: {
7673
+ query?: never;
7674
+ header?: {
7675
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
7676
+ "X-Sous-Company-Id"?: number;
7677
+ };
7678
+ path?: never;
7679
+ cookie?: never;
7680
+ };
7681
+ requestBody?: {
7682
+ content: {
7683
+ "application/json": components["schemas"]["PatchedSetNationwideShipping"];
7684
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetNationwideShipping"];
7685
+ "multipart/form-data": components["schemas"]["PatchedSetNationwideShipping"];
7686
+ };
7687
+ };
7688
+ responses: {
7689
+ 200: {
7690
+ headers: {
7691
+ [name: string]: unknown;
7692
+ };
7693
+ content: {
7694
+ "application/json": components["schemas"]["NationwideShipping"];
7695
+ };
7696
+ };
7697
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7698
+ 400: {
7699
+ headers: {
7700
+ [name: string]: unknown;
7701
+ };
7702
+ content: {
7703
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7704
+ };
7705
+ };
7706
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
7707
+ 401: {
7708
+ headers: {
7709
+ [name: string]: unknown;
7710
+ };
7711
+ content: {
7712
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7713
+ };
7714
+ };
7715
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
7716
+ 403: {
7717
+ headers: {
7718
+ [name: string]: unknown;
7719
+ };
7720
+ content: {
7721
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7722
+ };
7723
+ };
7724
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
7725
+ 404: {
7726
+ headers: {
7727
+ [name: string]: unknown;
7728
+ };
7729
+ content: {
7730
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7731
+ };
7732
+ };
7733
+ /** @description Possible error codes include `NATIONWIDE_CARRIER_UNCLEAR`. Use `x-error-codes` for machine-readable retryability metadata. */
7734
+ 409: {
7735
+ headers: {
7736
+ [name: string]: unknown;
7737
+ };
7738
+ content: {
7739
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7740
+ };
7741
+ };
7742
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
7743
+ 429: {
7744
+ headers: {
7745
+ [name: string]: unknown;
7746
+ };
7747
+ content: {
7748
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7749
+ };
7750
+ };
7751
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7752
+ 500: {
7753
+ headers: {
7754
+ [name: string]: unknown;
7755
+ };
7756
+ content: {
7757
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7758
+ };
7759
+ };
7760
+ };
7761
+ };
7504
7762
  admin_pages_list: {
7505
7763
  parameters: {
7506
7764
  query?: {
@@ -8675,6 +8933,223 @@ interface operations {
8675
8933
  };
8676
8934
  };
8677
8935
  };
8936
+ admin_printing_add_store_device: {
8937
+ parameters: {
8938
+ query?: never;
8939
+ header?: {
8940
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
8941
+ "X-Sous-Company-Id"?: number;
8942
+ };
8943
+ path: {
8944
+ store_public_id: string;
8945
+ };
8946
+ cookie?: never;
8947
+ };
8948
+ requestBody: {
8949
+ content: {
8950
+ "application/json": components["schemas"]["PrintDeviceCreateRequest"];
8951
+ "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
8952
+ "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
8953
+ };
8954
+ };
8955
+ responses: {
8956
+ 201: {
8957
+ headers: {
8958
+ [name: string]: unknown;
8959
+ };
8960
+ content: {
8961
+ "application/json": components["schemas"]["PrintDevice"];
8962
+ };
8963
+ };
8964
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
8965
+ 400: {
8966
+ headers: {
8967
+ [name: string]: unknown;
8968
+ };
8969
+ content: {
8970
+ "application/json": components["schemas"]["APIErrorEnvelope"];
8971
+ };
8972
+ };
8973
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
8974
+ 401: {
8975
+ headers: {
8976
+ [name: string]: unknown;
8977
+ };
8978
+ content: {
8979
+ "application/json": components["schemas"]["APIErrorEnvelope"];
8980
+ };
8981
+ };
8982
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
8983
+ 403: {
8984
+ headers: {
8985
+ [name: string]: unknown;
8986
+ };
8987
+ content: {
8988
+ "application/json": {
8989
+ [key: string]: unknown;
8990
+ };
8991
+ };
8992
+ };
8993
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
8994
+ 404: {
8995
+ headers: {
8996
+ [name: string]: unknown;
8997
+ };
8998
+ content: {
8999
+ "application/json": {
9000
+ [key: string]: unknown;
9001
+ };
9002
+ };
9003
+ };
9004
+ 409: {
9005
+ headers: {
9006
+ [name: string]: unknown;
9007
+ };
9008
+ content: {
9009
+ "application/json": {
9010
+ [key: string]: unknown;
9011
+ };
9012
+ };
9013
+ };
9014
+ 422: {
9015
+ headers: {
9016
+ [name: string]: unknown;
9017
+ };
9018
+ content: {
9019
+ "application/json": {
9020
+ [key: string]: unknown;
9021
+ };
9022
+ };
9023
+ };
9024
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9025
+ 429: {
9026
+ headers: {
9027
+ [name: string]: unknown;
9028
+ };
9029
+ content: {
9030
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9031
+ };
9032
+ };
9033
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9034
+ 500: {
9035
+ headers: {
9036
+ [name: string]: unknown;
9037
+ };
9038
+ content: {
9039
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9040
+ };
9041
+ };
9042
+ 502: {
9043
+ headers: {
9044
+ [name: string]: unknown;
9045
+ };
9046
+ content: {
9047
+ "application/json": {
9048
+ [key: string]: unknown;
9049
+ };
9050
+ };
9051
+ };
9052
+ 503: {
9053
+ headers: {
9054
+ [name: string]: unknown;
9055
+ };
9056
+ content: {
9057
+ "application/json": {
9058
+ [key: string]: unknown;
9059
+ };
9060
+ };
9061
+ };
9062
+ };
9063
+ };
9064
+ admin_printing_update_store_device: {
9065
+ parameters: {
9066
+ query?: never;
9067
+ header?: {
9068
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9069
+ "X-Sous-Company-Id"?: number;
9070
+ };
9071
+ path: {
9072
+ device_id: number;
9073
+ store_public_id: string;
9074
+ };
9075
+ cookie?: never;
9076
+ };
9077
+ requestBody?: {
9078
+ content: {
9079
+ "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9080
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9081
+ "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9082
+ };
9083
+ };
9084
+ responses: {
9085
+ 200: {
9086
+ headers: {
9087
+ [name: string]: unknown;
9088
+ };
9089
+ content: {
9090
+ "application/json": components["schemas"]["PrintDevice"];
9091
+ };
9092
+ };
9093
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9094
+ 400: {
9095
+ headers: {
9096
+ [name: string]: unknown;
9097
+ };
9098
+ content: {
9099
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9100
+ };
9101
+ };
9102
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9103
+ 401: {
9104
+ headers: {
9105
+ [name: string]: unknown;
9106
+ };
9107
+ content: {
9108
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9109
+ };
9110
+ };
9111
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9112
+ 403: {
9113
+ headers: {
9114
+ [name: string]: unknown;
9115
+ };
9116
+ content: {
9117
+ "application/json": {
9118
+ [key: string]: unknown;
9119
+ };
9120
+ };
9121
+ };
9122
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9123
+ 404: {
9124
+ headers: {
9125
+ [name: string]: unknown;
9126
+ };
9127
+ content: {
9128
+ "application/json": {
9129
+ [key: string]: unknown;
9130
+ };
9131
+ };
9132
+ };
9133
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9134
+ 429: {
9135
+ headers: {
9136
+ [name: string]: unknown;
9137
+ };
9138
+ content: {
9139
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9140
+ };
9141
+ };
9142
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9143
+ 500: {
9144
+ headers: {
9145
+ [name: string]: unknown;
9146
+ };
9147
+ content: {
9148
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9149
+ };
9150
+ };
9151
+ };
9152
+ };
8678
9153
  admin_products_list: {
8679
9154
  parameters: {
8680
9155
  query?: {
package/dist/index.d.ts CHANGED
@@ -353,6 +353,30 @@ interface paths {
353
353
  patch?: never;
354
354
  trace?: never;
355
355
  };
356
+ "/api/v1/admin/nationwide-shipping/": {
357
+ parameters: {
358
+ query?: never;
359
+ header?: never;
360
+ path?: never;
361
+ cookie?: never;
362
+ };
363
+ /**
364
+ * Read the company's nationwide-shipping switch
365
+ * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
366
+ */
367
+ get: operations["admin_nationwide_shipping_retrieve"];
368
+ put?: never;
369
+ post?: never;
370
+ delete?: never;
371
+ options?: never;
372
+ head?: never;
373
+ /**
374
+ * Switch nationwide shipping on or off for every store of the company
375
+ * @description ``GET``/``PATCH /api/v1/admin/nationwide-shipping/``: the company's switch.
376
+ */
377
+ patch: operations["admin_nationwide_shipping_partial_update"];
378
+ trace?: never;
379
+ };
356
380
  "/api/v1/admin/pages/": {
357
381
  parameters: {
358
382
  query?: never;
@@ -523,16 +547,38 @@ interface paths {
523
547
  path?: never;
524
548
  cookie?: never;
525
549
  };
526
- /** @description The store's enabled cloud printers. An empty list: no cloud printing. */
550
+ /**
551
+ * @description The store's enabled cloud printers (an empty list: no cloud printing).
552
+ *
553
+ * Backoffice can add one.
554
+ */
527
555
  get: operations["admin_printing_store_devices"];
528
556
  put?: never;
529
- post?: never;
557
+ /** @description Bind a printer in Sunmi for this store and save it (backoffice only). */
558
+ post: operations["admin_printing_add_store_device"];
530
559
  delete?: never;
531
560
  options?: never;
532
561
  head?: never;
533
562
  patch?: never;
534
563
  trace?: never;
535
564
  };
565
+ "/api/v1/admin/printing/stores/{store_public_id}/devices/{device_id}/": {
566
+ parameters: {
567
+ query?: never;
568
+ header?: never;
569
+ path?: never;
570
+ cookie?: never;
571
+ };
572
+ get?: never;
573
+ put?: never;
574
+ post?: never;
575
+ delete?: never;
576
+ options?: never;
577
+ head?: never;
578
+ /** @description One printer of the store: change its tickets per order (backoffice only). */
579
+ patch: operations["admin_printing_update_store_device"];
580
+ trace?: never;
581
+ };
536
582
  "/api/v1/admin/products/": {
537
583
  parameters: {
538
584
  query?: never;
@@ -4370,6 +4416,13 @@ interface components {
4370
4416
  * @enum {string}
4371
4417
  */
4372
4418
  NamespaceEnum: "merchant" | "product" | "category" | "collection" | "geocoding" | "shipping" | "translation" | "keycloak" | "segment" | "page" | "channel";
4419
+ /** @description The company's nationwide-shipping switch (exploreSOUS). */
4420
+ NationwideShipping: {
4421
+ /** @description Whether the company is on exploreSOUS and so has the switch. */
4422
+ is_available: boolean;
4423
+ /** @description Whether any of the company's stores ships nationwide. */
4424
+ is_enabled: boolean;
4425
+ };
4373
4426
  /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
4374
4427
  OpenStatus: {
4375
4428
  open: boolean;
@@ -5139,6 +5192,9 @@ interface components {
5139
5192
  dismiss_duration?: string | null;
5140
5193
  targeting?: unknown;
5141
5194
  };
5195
+ PatchedPrintDeviceUpdateRequest: {
5196
+ copies?: number;
5197
+ };
5142
5198
  PatchedProductChannelListing: {
5143
5199
  readonly id?: number;
5144
5200
  readonly product_id?: number;
@@ -5207,6 +5263,9 @@ interface components {
5207
5263
  PatchedSetCompanyAvailability: {
5208
5264
  is_available?: boolean;
5209
5265
  };
5266
+ PatchedSetNationwideShipping: {
5267
+ is_enabled?: boolean;
5268
+ };
5210
5269
  /**
5211
5270
  * @description PATCH body for a store's delivery-method row.
5212
5271
  *
@@ -5278,6 +5337,10 @@ interface components {
5278
5337
  PrintDevice: {
5279
5338
  id: number;
5280
5339
  name: string;
5340
+ /** @description The printer's serial number (Sunmi: the MSN on its label). */
5341
+ device_identifier: string;
5342
+ /** @description Tickets per automatic print. A manual print is always one. */
5343
+ copies: number;
5281
5344
  /**
5282
5345
  * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
5283
5346
  *
@@ -5287,6 +5350,25 @@ interface components {
5287
5350
  alert_state: components["schemas"]["AlertStateEnum"];
5288
5351
  /** Format: date-time */
5289
5352
  last_seen_at: string | null;
5353
+ /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
5354
+ online: boolean | null;
5355
+ /**
5356
+ * Format: date-time
5357
+ * @description When that check ran.
5358
+ */
5359
+ online_checked_at: string | null;
5360
+ };
5361
+ /** @description A backoffice user adds a printer to the store in the URL. */
5362
+ PrintDeviceCreateRequest: {
5363
+ /** @description Serial from the printer's label, e.g. N439259A11700. */
5364
+ device_identifier: string;
5365
+ /** @description e.g. "Kitchen" */
5366
+ name: string;
5367
+ /**
5368
+ * @description Tickets per automatic print.
5369
+ * @default 1
5370
+ */
5371
+ copies: number;
5290
5372
  };
5291
5373
  PrintDevicesResponse: {
5292
5374
  devices: components["schemas"]["PrintDevice"][];
@@ -7501,6 +7583,182 @@ interface operations {
7501
7583
  };
7502
7584
  };
7503
7585
  };
7586
+ admin_nationwide_shipping_retrieve: {
7587
+ parameters: {
7588
+ query?: never;
7589
+ header?: {
7590
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
7591
+ "X-Sous-Company-Id"?: number;
7592
+ };
7593
+ path?: never;
7594
+ cookie?: never;
7595
+ };
7596
+ requestBody?: never;
7597
+ responses: {
7598
+ 200: {
7599
+ headers: {
7600
+ [name: string]: unknown;
7601
+ };
7602
+ content: {
7603
+ "application/json": components["schemas"]["NationwideShipping"];
7604
+ };
7605
+ };
7606
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7607
+ 400: {
7608
+ headers: {
7609
+ [name: string]: unknown;
7610
+ };
7611
+ content: {
7612
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7613
+ };
7614
+ };
7615
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
7616
+ 401: {
7617
+ headers: {
7618
+ [name: string]: unknown;
7619
+ };
7620
+ content: {
7621
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7622
+ };
7623
+ };
7624
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
7625
+ 403: {
7626
+ headers: {
7627
+ [name: string]: unknown;
7628
+ };
7629
+ content: {
7630
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7631
+ };
7632
+ };
7633
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
7634
+ 404: {
7635
+ headers: {
7636
+ [name: string]: unknown;
7637
+ };
7638
+ content: {
7639
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7640
+ };
7641
+ };
7642
+ /** @description Possible error codes include `NATIONWIDE_CARRIER_UNCLEAR`. Use `x-error-codes` for machine-readable retryability metadata. */
7643
+ 409: {
7644
+ headers: {
7645
+ [name: string]: unknown;
7646
+ };
7647
+ content: {
7648
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7649
+ };
7650
+ };
7651
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
7652
+ 429: {
7653
+ headers: {
7654
+ [name: string]: unknown;
7655
+ };
7656
+ content: {
7657
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7658
+ };
7659
+ };
7660
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7661
+ 500: {
7662
+ headers: {
7663
+ [name: string]: unknown;
7664
+ };
7665
+ content: {
7666
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7667
+ };
7668
+ };
7669
+ };
7670
+ };
7671
+ admin_nationwide_shipping_partial_update: {
7672
+ parameters: {
7673
+ query?: never;
7674
+ header?: {
7675
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
7676
+ "X-Sous-Company-Id"?: number;
7677
+ };
7678
+ path?: never;
7679
+ cookie?: never;
7680
+ };
7681
+ requestBody?: {
7682
+ content: {
7683
+ "application/json": components["schemas"]["PatchedSetNationwideShipping"];
7684
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetNationwideShipping"];
7685
+ "multipart/form-data": components["schemas"]["PatchedSetNationwideShipping"];
7686
+ };
7687
+ };
7688
+ responses: {
7689
+ 200: {
7690
+ headers: {
7691
+ [name: string]: unknown;
7692
+ };
7693
+ content: {
7694
+ "application/json": components["schemas"]["NationwideShipping"];
7695
+ };
7696
+ };
7697
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7698
+ 400: {
7699
+ headers: {
7700
+ [name: string]: unknown;
7701
+ };
7702
+ content: {
7703
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7704
+ };
7705
+ };
7706
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
7707
+ 401: {
7708
+ headers: {
7709
+ [name: string]: unknown;
7710
+ };
7711
+ content: {
7712
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7713
+ };
7714
+ };
7715
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `EXPLORESOUS_CHANNEL_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
7716
+ 403: {
7717
+ headers: {
7718
+ [name: string]: unknown;
7719
+ };
7720
+ content: {
7721
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7722
+ };
7723
+ };
7724
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
7725
+ 404: {
7726
+ headers: {
7727
+ [name: string]: unknown;
7728
+ };
7729
+ content: {
7730
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7731
+ };
7732
+ };
7733
+ /** @description Possible error codes include `NATIONWIDE_CARRIER_UNCLEAR`. Use `x-error-codes` for machine-readable retryability metadata. */
7734
+ 409: {
7735
+ headers: {
7736
+ [name: string]: unknown;
7737
+ };
7738
+ content: {
7739
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7740
+ };
7741
+ };
7742
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
7743
+ 429: {
7744
+ headers: {
7745
+ [name: string]: unknown;
7746
+ };
7747
+ content: {
7748
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7749
+ };
7750
+ };
7751
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
7752
+ 500: {
7753
+ headers: {
7754
+ [name: string]: unknown;
7755
+ };
7756
+ content: {
7757
+ "application/json": components["schemas"]["APIErrorEnvelope"];
7758
+ };
7759
+ };
7760
+ };
7761
+ };
7504
7762
  admin_pages_list: {
7505
7763
  parameters: {
7506
7764
  query?: {
@@ -8675,6 +8933,223 @@ interface operations {
8675
8933
  };
8676
8934
  };
8677
8935
  };
8936
+ admin_printing_add_store_device: {
8937
+ parameters: {
8938
+ query?: never;
8939
+ header?: {
8940
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
8941
+ "X-Sous-Company-Id"?: number;
8942
+ };
8943
+ path: {
8944
+ store_public_id: string;
8945
+ };
8946
+ cookie?: never;
8947
+ };
8948
+ requestBody: {
8949
+ content: {
8950
+ "application/json": components["schemas"]["PrintDeviceCreateRequest"];
8951
+ "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
8952
+ "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
8953
+ };
8954
+ };
8955
+ responses: {
8956
+ 201: {
8957
+ headers: {
8958
+ [name: string]: unknown;
8959
+ };
8960
+ content: {
8961
+ "application/json": components["schemas"]["PrintDevice"];
8962
+ };
8963
+ };
8964
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
8965
+ 400: {
8966
+ headers: {
8967
+ [name: string]: unknown;
8968
+ };
8969
+ content: {
8970
+ "application/json": components["schemas"]["APIErrorEnvelope"];
8971
+ };
8972
+ };
8973
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
8974
+ 401: {
8975
+ headers: {
8976
+ [name: string]: unknown;
8977
+ };
8978
+ content: {
8979
+ "application/json": components["schemas"]["APIErrorEnvelope"];
8980
+ };
8981
+ };
8982
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
8983
+ 403: {
8984
+ headers: {
8985
+ [name: string]: unknown;
8986
+ };
8987
+ content: {
8988
+ "application/json": {
8989
+ [key: string]: unknown;
8990
+ };
8991
+ };
8992
+ };
8993
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
8994
+ 404: {
8995
+ headers: {
8996
+ [name: string]: unknown;
8997
+ };
8998
+ content: {
8999
+ "application/json": {
9000
+ [key: string]: unknown;
9001
+ };
9002
+ };
9003
+ };
9004
+ 409: {
9005
+ headers: {
9006
+ [name: string]: unknown;
9007
+ };
9008
+ content: {
9009
+ "application/json": {
9010
+ [key: string]: unknown;
9011
+ };
9012
+ };
9013
+ };
9014
+ 422: {
9015
+ headers: {
9016
+ [name: string]: unknown;
9017
+ };
9018
+ content: {
9019
+ "application/json": {
9020
+ [key: string]: unknown;
9021
+ };
9022
+ };
9023
+ };
9024
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9025
+ 429: {
9026
+ headers: {
9027
+ [name: string]: unknown;
9028
+ };
9029
+ content: {
9030
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9031
+ };
9032
+ };
9033
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9034
+ 500: {
9035
+ headers: {
9036
+ [name: string]: unknown;
9037
+ };
9038
+ content: {
9039
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9040
+ };
9041
+ };
9042
+ 502: {
9043
+ headers: {
9044
+ [name: string]: unknown;
9045
+ };
9046
+ content: {
9047
+ "application/json": {
9048
+ [key: string]: unknown;
9049
+ };
9050
+ };
9051
+ };
9052
+ 503: {
9053
+ headers: {
9054
+ [name: string]: unknown;
9055
+ };
9056
+ content: {
9057
+ "application/json": {
9058
+ [key: string]: unknown;
9059
+ };
9060
+ };
9061
+ };
9062
+ };
9063
+ };
9064
+ admin_printing_update_store_device: {
9065
+ parameters: {
9066
+ query?: never;
9067
+ header?: {
9068
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9069
+ "X-Sous-Company-Id"?: number;
9070
+ };
9071
+ path: {
9072
+ device_id: number;
9073
+ store_public_id: string;
9074
+ };
9075
+ cookie?: never;
9076
+ };
9077
+ requestBody?: {
9078
+ content: {
9079
+ "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9080
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9081
+ "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9082
+ };
9083
+ };
9084
+ responses: {
9085
+ 200: {
9086
+ headers: {
9087
+ [name: string]: unknown;
9088
+ };
9089
+ content: {
9090
+ "application/json": components["schemas"]["PrintDevice"];
9091
+ };
9092
+ };
9093
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9094
+ 400: {
9095
+ headers: {
9096
+ [name: string]: unknown;
9097
+ };
9098
+ content: {
9099
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9100
+ };
9101
+ };
9102
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9103
+ 401: {
9104
+ headers: {
9105
+ [name: string]: unknown;
9106
+ };
9107
+ content: {
9108
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9109
+ };
9110
+ };
9111
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9112
+ 403: {
9113
+ headers: {
9114
+ [name: string]: unknown;
9115
+ };
9116
+ content: {
9117
+ "application/json": {
9118
+ [key: string]: unknown;
9119
+ };
9120
+ };
9121
+ };
9122
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9123
+ 404: {
9124
+ headers: {
9125
+ [name: string]: unknown;
9126
+ };
9127
+ content: {
9128
+ "application/json": {
9129
+ [key: string]: unknown;
9130
+ };
9131
+ };
9132
+ };
9133
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9134
+ 429: {
9135
+ headers: {
9136
+ [name: string]: unknown;
9137
+ };
9138
+ content: {
9139
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9140
+ };
9141
+ };
9142
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9143
+ 500: {
9144
+ headers: {
9145
+ [name: string]: unknown;
9146
+ };
9147
+ content: {
9148
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9149
+ };
9150
+ };
9151
+ };
9152
+ };
8678
9153
  admin_products_list: {
8679
9154
  parameters: {
8680
9155
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-admin-sdk",
3
- "version": "4.3.1",
3
+ "version": "4.5.0",
4
4
  "description": "Type-safe TypeScript SDK for SOUS Storefront Backend admin endpoints",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,