@poweredbysous/storefront-admin-sdk 4.4.0 → 4.6.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
@@ -547,16 +547,38 @@ interface paths {
547
547
  path?: never;
548
548
  cookie?: never;
549
549
  };
550
- /** @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
+ */
551
555
  get: operations["admin_printing_store_devices"];
552
556
  put?: never;
553
- 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"];
554
559
  delete?: never;
555
560
  options?: never;
556
561
  head?: never;
557
562
  patch?: never;
558
563
  trace?: never;
559
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
+ };
560
582
  "/api/v1/admin/products/": {
561
583
  parameters: {
562
584
  query?: never;
@@ -2854,6 +2876,28 @@ interface paths {
2854
2876
  patch?: never;
2855
2877
  trace?: never;
2856
2878
  };
2879
+ "/api/v1/products/{id}/orderable-dates/": {
2880
+ parameters: {
2881
+ query?: never;
2882
+ header?: never;
2883
+ path?: never;
2884
+ cookie?: never;
2885
+ };
2886
+ /**
2887
+ * @description The dates this product can be ordered for, within the location's
2888
+ * pre-order horizon, as the cart's ``fulfilment-dates`` lists them for
2889
+ * a basket holding only this product's line, so the storefront can tell
2890
+ * a customer when a product it hides for their date is available.
2891
+ */
2892
+ get: operations["products_orderable_dates_retrieve"];
2893
+ put?: never;
2894
+ post?: never;
2895
+ delete?: never;
2896
+ options?: never;
2897
+ head?: never;
2898
+ patch?: never;
2899
+ trace?: never;
2900
+ };
2857
2901
  "/api/v1/products/{id}/suggestions/": {
2858
2902
  parameters: {
2859
2903
  query?: never;
@@ -4401,6 +4445,8 @@ interface components {
4401
4445
  /** @description Whether any of the company's stores ships nationwide. */
4402
4446
  is_enabled: boolean;
4403
4447
  };
4448
+ /** @enum {unknown} */
4449
+ NullEnum: null;
4404
4450
  /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
4405
4451
  OpenStatus: {
4406
4452
  open: boolean;
@@ -5170,6 +5216,9 @@ interface components {
5170
5216
  dismiss_duration?: string | null;
5171
5217
  targeting?: unknown;
5172
5218
  };
5219
+ PatchedPrintDeviceUpdateRequest: {
5220
+ copies?: number;
5221
+ };
5173
5222
  PatchedProductChannelListing: {
5174
5223
  readonly id?: number;
5175
5224
  readonly product_id?: number;
@@ -5312,6 +5361,10 @@ interface components {
5312
5361
  PrintDevice: {
5313
5362
  id: number;
5314
5363
  name: string;
5364
+ /** @description The printer's serial number (Sunmi: the MSN on its label). */
5365
+ device_identifier: string;
5366
+ /** @description Tickets per automatic print. A manual print is always one. */
5367
+ copies: number;
5315
5368
  /**
5316
5369
  * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
5317
5370
  *
@@ -5321,6 +5374,25 @@ interface components {
5321
5374
  alert_state: components["schemas"]["AlertStateEnum"];
5322
5375
  /** Format: date-time */
5323
5376
  last_seen_at: string | null;
5377
+ /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
5378
+ online: boolean | null;
5379
+ /**
5380
+ * Format: date-time
5381
+ * @description When that check ran.
5382
+ */
5383
+ online_checked_at: string | null;
5384
+ };
5385
+ /** @description A backoffice user adds a printer to the store in the URL. */
5386
+ PrintDeviceCreateRequest: {
5387
+ /** @description Serial from the printer's label, e.g. N439259A11700. */
5388
+ device_identifier: string;
5389
+ /** @description e.g. "Kitchen" */
5390
+ name: string;
5391
+ /**
5392
+ * @description Tickets per automatic print.
5393
+ * @default 1
5394
+ */
5395
+ copies: number;
5324
5396
  };
5325
5397
  PrintDevicesResponse: {
5326
5398
  devices: components["schemas"]["PrintDevice"][];
@@ -5537,6 +5609,19 @@ interface components {
5537
5609
  /** Format: date-time */
5538
5610
  readonly updated_at: string;
5539
5611
  };
5612
+ /**
5613
+ * @description The dates one product can be ordered for, within the location's
5614
+ * pre-order horizon (``ProductViewSet.orderable_dates``).
5615
+ */
5616
+ ProductFulfilmentDates: {
5617
+ dates: string[];
5618
+ reason: (components["schemas"]["ProductFulfilmentDatesReasonEnum"] | components["schemas"]["NullEnum"]) | null;
5619
+ };
5620
+ /**
5621
+ * @description * `no_dates` - no_dates
5622
+ * @enum {string}
5623
+ */
5624
+ ProductFulfilmentDatesReasonEnum: "no_dates";
5540
5625
  ProductImage: {
5541
5626
  readonly id: number;
5542
5627
  /** Format: uri */
@@ -8885,6 +8970,223 @@ interface operations {
8885
8970
  };
8886
8971
  };
8887
8972
  };
8973
+ admin_printing_add_store_device: {
8974
+ parameters: {
8975
+ query?: never;
8976
+ header?: {
8977
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
8978
+ "X-Sous-Company-Id"?: number;
8979
+ };
8980
+ path: {
8981
+ store_public_id: string;
8982
+ };
8983
+ cookie?: never;
8984
+ };
8985
+ requestBody: {
8986
+ content: {
8987
+ "application/json": components["schemas"]["PrintDeviceCreateRequest"];
8988
+ "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
8989
+ "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
8990
+ };
8991
+ };
8992
+ responses: {
8993
+ 201: {
8994
+ headers: {
8995
+ [name: string]: unknown;
8996
+ };
8997
+ content: {
8998
+ "application/json": components["schemas"]["PrintDevice"];
8999
+ };
9000
+ };
9001
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9002
+ 400: {
9003
+ headers: {
9004
+ [name: string]: unknown;
9005
+ };
9006
+ content: {
9007
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9008
+ };
9009
+ };
9010
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9011
+ 401: {
9012
+ headers: {
9013
+ [name: string]: unknown;
9014
+ };
9015
+ content: {
9016
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9017
+ };
9018
+ };
9019
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9020
+ 403: {
9021
+ headers: {
9022
+ [name: string]: unknown;
9023
+ };
9024
+ content: {
9025
+ "application/json": {
9026
+ [key: string]: unknown;
9027
+ };
9028
+ };
9029
+ };
9030
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9031
+ 404: {
9032
+ headers: {
9033
+ [name: string]: unknown;
9034
+ };
9035
+ content: {
9036
+ "application/json": {
9037
+ [key: string]: unknown;
9038
+ };
9039
+ };
9040
+ };
9041
+ 409: {
9042
+ headers: {
9043
+ [name: string]: unknown;
9044
+ };
9045
+ content: {
9046
+ "application/json": {
9047
+ [key: string]: unknown;
9048
+ };
9049
+ };
9050
+ };
9051
+ 422: {
9052
+ headers: {
9053
+ [name: string]: unknown;
9054
+ };
9055
+ content: {
9056
+ "application/json": {
9057
+ [key: string]: unknown;
9058
+ };
9059
+ };
9060
+ };
9061
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9062
+ 429: {
9063
+ headers: {
9064
+ [name: string]: unknown;
9065
+ };
9066
+ content: {
9067
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9068
+ };
9069
+ };
9070
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9071
+ 500: {
9072
+ headers: {
9073
+ [name: string]: unknown;
9074
+ };
9075
+ content: {
9076
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9077
+ };
9078
+ };
9079
+ 502: {
9080
+ headers: {
9081
+ [name: string]: unknown;
9082
+ };
9083
+ content: {
9084
+ "application/json": {
9085
+ [key: string]: unknown;
9086
+ };
9087
+ };
9088
+ };
9089
+ 503: {
9090
+ headers: {
9091
+ [name: string]: unknown;
9092
+ };
9093
+ content: {
9094
+ "application/json": {
9095
+ [key: string]: unknown;
9096
+ };
9097
+ };
9098
+ };
9099
+ };
9100
+ };
9101
+ admin_printing_update_store_device: {
9102
+ parameters: {
9103
+ query?: never;
9104
+ header?: {
9105
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9106
+ "X-Sous-Company-Id"?: number;
9107
+ };
9108
+ path: {
9109
+ device_id: number;
9110
+ store_public_id: string;
9111
+ };
9112
+ cookie?: never;
9113
+ };
9114
+ requestBody?: {
9115
+ content: {
9116
+ "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9117
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9118
+ "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9119
+ };
9120
+ };
9121
+ responses: {
9122
+ 200: {
9123
+ headers: {
9124
+ [name: string]: unknown;
9125
+ };
9126
+ content: {
9127
+ "application/json": components["schemas"]["PrintDevice"];
9128
+ };
9129
+ };
9130
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9131
+ 400: {
9132
+ headers: {
9133
+ [name: string]: unknown;
9134
+ };
9135
+ content: {
9136
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9137
+ };
9138
+ };
9139
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9140
+ 401: {
9141
+ headers: {
9142
+ [name: string]: unknown;
9143
+ };
9144
+ content: {
9145
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9146
+ };
9147
+ };
9148
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9149
+ 403: {
9150
+ headers: {
9151
+ [name: string]: unknown;
9152
+ };
9153
+ content: {
9154
+ "application/json": {
9155
+ [key: string]: unknown;
9156
+ };
9157
+ };
9158
+ };
9159
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9160
+ 404: {
9161
+ headers: {
9162
+ [name: string]: unknown;
9163
+ };
9164
+ content: {
9165
+ "application/json": {
9166
+ [key: string]: unknown;
9167
+ };
9168
+ };
9169
+ };
9170
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9171
+ 429: {
9172
+ headers: {
9173
+ [name: string]: unknown;
9174
+ };
9175
+ content: {
9176
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9177
+ };
9178
+ };
9179
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9180
+ 500: {
9181
+ headers: {
9182
+ [name: string]: unknown;
9183
+ };
9184
+ content: {
9185
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9186
+ };
9187
+ };
9188
+ };
9189
+ };
8888
9190
  admin_products_list: {
8889
9191
  parameters: {
8890
9192
  query?: {
@@ -19919,6 +20221,8 @@ interface operations {
19919
20221
  query?: {
19920
20222
  /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE), used with latitude and longitude. A nationwide carrier that declares per-country service areas only offers its products once the country is known. Case-insensitive; any other value is treated as no country. */
19921
20223
  country?: string;
20224
+ /** @description The pickup or delivery date the customer has chosen (YYYY-MM-DD). Lists only the products that can be ordered today for that date by their own dates: weekly days, included and excluded dates, and order-until. Whether the store is open that day is the time-slots endpoint's answer, not this filter's. An unreadable value is ignored. */
20225
+ handover_date?: string;
19922
20226
  /** @description Sort order for products. Use '-popularity' for most popular first. */
19923
20227
  ordering?: "-popularity" | "-position" | "position";
19924
20228
  /** @description A page number within the paginated result set. */
@@ -20155,6 +20459,91 @@ interface operations {
20155
20459
  };
20156
20460
  };
20157
20461
  };
20462
+ products_orderable_dates_retrieve: {
20463
+ parameters: {
20464
+ query: {
20465
+ /** @description For type=delivery: the customer's delivery types in order of preference, comma-separated (local_delivery, nationwide_delivery). The product's schedule follows the first of them it offers, the type its cart line would get; without one it follows the delivery types the product offers. */
20466
+ fulfillment_types?: string;
20467
+ /** @description Pickup location id, as the pickup time-slots endpoint takes it. Defaults to the store's active pickup location. */
20468
+ location?: number;
20469
+ /** @description Fulfilment type the dates are for. */
20470
+ type: "delivery" | "pickup";
20471
+ /** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
20472
+ lang?: string;
20473
+ };
20474
+ header?: never;
20475
+ path: {
20476
+ /** @description A unique integer value identifying this product. */
20477
+ id: number;
20478
+ };
20479
+ cookie?: never;
20480
+ };
20481
+ requestBody?: never;
20482
+ responses: {
20483
+ 200: {
20484
+ headers: {
20485
+ [name: string]: unknown;
20486
+ };
20487
+ content: {
20488
+ "application/json": components["schemas"]["ProductFulfilmentDates"];
20489
+ };
20490
+ };
20491
+ /** @description Possible error codes: `VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
20492
+ 400: {
20493
+ headers: {
20494
+ [name: string]: unknown;
20495
+ };
20496
+ content: {
20497
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20498
+ };
20499
+ };
20500
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
20501
+ 401: {
20502
+ headers: {
20503
+ [name: string]: unknown;
20504
+ };
20505
+ content: {
20506
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20507
+ };
20508
+ };
20509
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
20510
+ 403: {
20511
+ headers: {
20512
+ [name: string]: unknown;
20513
+ };
20514
+ content: {
20515
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20516
+ };
20517
+ };
20518
+ /** @description Possible error codes: `NOT_FOUND`, `LOCATION_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LOCATION_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
20519
+ 404: {
20520
+ headers: {
20521
+ [name: string]: unknown;
20522
+ };
20523
+ content: {
20524
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20525
+ };
20526
+ };
20527
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
20528
+ 429: {
20529
+ headers: {
20530
+ [name: string]: unknown;
20531
+ };
20532
+ content: {
20533
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20534
+ };
20535
+ };
20536
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
20537
+ 500: {
20538
+ headers: {
20539
+ [name: string]: unknown;
20540
+ };
20541
+ content: {
20542
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20543
+ };
20544
+ };
20545
+ };
20546
+ };
20158
20547
  products_suggestions_list: {
20159
20548
  parameters: {
20160
20549
  query?: {
package/dist/index.d.ts CHANGED
@@ -547,16 +547,38 @@ interface paths {
547
547
  path?: never;
548
548
  cookie?: never;
549
549
  };
550
- /** @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
+ */
551
555
  get: operations["admin_printing_store_devices"];
552
556
  put?: never;
553
- 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"];
554
559
  delete?: never;
555
560
  options?: never;
556
561
  head?: never;
557
562
  patch?: never;
558
563
  trace?: never;
559
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
+ };
560
582
  "/api/v1/admin/products/": {
561
583
  parameters: {
562
584
  query?: never;
@@ -2854,6 +2876,28 @@ interface paths {
2854
2876
  patch?: never;
2855
2877
  trace?: never;
2856
2878
  };
2879
+ "/api/v1/products/{id}/orderable-dates/": {
2880
+ parameters: {
2881
+ query?: never;
2882
+ header?: never;
2883
+ path?: never;
2884
+ cookie?: never;
2885
+ };
2886
+ /**
2887
+ * @description The dates this product can be ordered for, within the location's
2888
+ * pre-order horizon, as the cart's ``fulfilment-dates`` lists them for
2889
+ * a basket holding only this product's line, so the storefront can tell
2890
+ * a customer when a product it hides for their date is available.
2891
+ */
2892
+ get: operations["products_orderable_dates_retrieve"];
2893
+ put?: never;
2894
+ post?: never;
2895
+ delete?: never;
2896
+ options?: never;
2897
+ head?: never;
2898
+ patch?: never;
2899
+ trace?: never;
2900
+ };
2857
2901
  "/api/v1/products/{id}/suggestions/": {
2858
2902
  parameters: {
2859
2903
  query?: never;
@@ -4401,6 +4445,8 @@ interface components {
4401
4445
  /** @description Whether any of the company's stores ships nationwide. */
4402
4446
  is_enabled: boolean;
4403
4447
  };
4448
+ /** @enum {unknown} */
4449
+ NullEnum: null;
4404
4450
  /** @description Render-ready open/closed badge — see ``availability.get_open_status``. */
4405
4451
  OpenStatus: {
4406
4452
  open: boolean;
@@ -5170,6 +5216,9 @@ interface components {
5170
5216
  dismiss_duration?: string | null;
5171
5217
  targeting?: unknown;
5172
5218
  };
5219
+ PatchedPrintDeviceUpdateRequest: {
5220
+ copies?: number;
5221
+ };
5173
5222
  PatchedProductChannelListing: {
5174
5223
  readonly id?: number;
5175
5224
  readonly product_id?: number;
@@ -5312,6 +5361,10 @@ interface components {
5312
5361
  PrintDevice: {
5313
5362
  id: number;
5314
5363
  name: string;
5364
+ /** @description The printer's serial number (Sunmi: the MSN on its label). */
5365
+ device_identifier: string;
5366
+ /** @description Tickets per automatic print. A manual print is always one. */
5367
+ copies: number;
5315
5368
  /**
5316
5369
  * @description `alerting`: the printer recently failed to print and the merchant was emailed. Cleared by its next successful print.
5317
5370
  *
@@ -5321,6 +5374,25 @@ interface components {
5321
5374
  alert_state: components["schemas"]["AlertStateEnum"];
5322
5375
  /** Format: date-time */
5323
5376
  last_seen_at: string | null;
5377
+ /** @description The last online check run by Sous staff: true online, false offline, null never checked. Not live. */
5378
+ online: boolean | null;
5379
+ /**
5380
+ * Format: date-time
5381
+ * @description When that check ran.
5382
+ */
5383
+ online_checked_at: string | null;
5384
+ };
5385
+ /** @description A backoffice user adds a printer to the store in the URL. */
5386
+ PrintDeviceCreateRequest: {
5387
+ /** @description Serial from the printer's label, e.g. N439259A11700. */
5388
+ device_identifier: string;
5389
+ /** @description e.g. "Kitchen" */
5390
+ name: string;
5391
+ /**
5392
+ * @description Tickets per automatic print.
5393
+ * @default 1
5394
+ */
5395
+ copies: number;
5324
5396
  };
5325
5397
  PrintDevicesResponse: {
5326
5398
  devices: components["schemas"]["PrintDevice"][];
@@ -5537,6 +5609,19 @@ interface components {
5537
5609
  /** Format: date-time */
5538
5610
  readonly updated_at: string;
5539
5611
  };
5612
+ /**
5613
+ * @description The dates one product can be ordered for, within the location's
5614
+ * pre-order horizon (``ProductViewSet.orderable_dates``).
5615
+ */
5616
+ ProductFulfilmentDates: {
5617
+ dates: string[];
5618
+ reason: (components["schemas"]["ProductFulfilmentDatesReasonEnum"] | components["schemas"]["NullEnum"]) | null;
5619
+ };
5620
+ /**
5621
+ * @description * `no_dates` - no_dates
5622
+ * @enum {string}
5623
+ */
5624
+ ProductFulfilmentDatesReasonEnum: "no_dates";
5540
5625
  ProductImage: {
5541
5626
  readonly id: number;
5542
5627
  /** Format: uri */
@@ -8885,6 +8970,223 @@ interface operations {
8885
8970
  };
8886
8971
  };
8887
8972
  };
8973
+ admin_printing_add_store_device: {
8974
+ parameters: {
8975
+ query?: never;
8976
+ header?: {
8977
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
8978
+ "X-Sous-Company-Id"?: number;
8979
+ };
8980
+ path: {
8981
+ store_public_id: string;
8982
+ };
8983
+ cookie?: never;
8984
+ };
8985
+ requestBody: {
8986
+ content: {
8987
+ "application/json": components["schemas"]["PrintDeviceCreateRequest"];
8988
+ "application/x-www-form-urlencoded": components["schemas"]["PrintDeviceCreateRequest"];
8989
+ "multipart/form-data": components["schemas"]["PrintDeviceCreateRequest"];
8990
+ };
8991
+ };
8992
+ responses: {
8993
+ 201: {
8994
+ headers: {
8995
+ [name: string]: unknown;
8996
+ };
8997
+ content: {
8998
+ "application/json": components["schemas"]["PrintDevice"];
8999
+ };
9000
+ };
9001
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9002
+ 400: {
9003
+ headers: {
9004
+ [name: string]: unknown;
9005
+ };
9006
+ content: {
9007
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9008
+ };
9009
+ };
9010
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9011
+ 401: {
9012
+ headers: {
9013
+ [name: string]: unknown;
9014
+ };
9015
+ content: {
9016
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9017
+ };
9018
+ };
9019
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9020
+ 403: {
9021
+ headers: {
9022
+ [name: string]: unknown;
9023
+ };
9024
+ content: {
9025
+ "application/json": {
9026
+ [key: string]: unknown;
9027
+ };
9028
+ };
9029
+ };
9030
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9031
+ 404: {
9032
+ headers: {
9033
+ [name: string]: unknown;
9034
+ };
9035
+ content: {
9036
+ "application/json": {
9037
+ [key: string]: unknown;
9038
+ };
9039
+ };
9040
+ };
9041
+ 409: {
9042
+ headers: {
9043
+ [name: string]: unknown;
9044
+ };
9045
+ content: {
9046
+ "application/json": {
9047
+ [key: string]: unknown;
9048
+ };
9049
+ };
9050
+ };
9051
+ 422: {
9052
+ headers: {
9053
+ [name: string]: unknown;
9054
+ };
9055
+ content: {
9056
+ "application/json": {
9057
+ [key: string]: unknown;
9058
+ };
9059
+ };
9060
+ };
9061
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9062
+ 429: {
9063
+ headers: {
9064
+ [name: string]: unknown;
9065
+ };
9066
+ content: {
9067
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9068
+ };
9069
+ };
9070
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9071
+ 500: {
9072
+ headers: {
9073
+ [name: string]: unknown;
9074
+ };
9075
+ content: {
9076
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9077
+ };
9078
+ };
9079
+ 502: {
9080
+ headers: {
9081
+ [name: string]: unknown;
9082
+ };
9083
+ content: {
9084
+ "application/json": {
9085
+ [key: string]: unknown;
9086
+ };
9087
+ };
9088
+ };
9089
+ 503: {
9090
+ headers: {
9091
+ [name: string]: unknown;
9092
+ };
9093
+ content: {
9094
+ "application/json": {
9095
+ [key: string]: unknown;
9096
+ };
9097
+ };
9098
+ };
9099
+ };
9100
+ };
9101
+ admin_printing_update_store_device: {
9102
+ parameters: {
9103
+ query?: never;
9104
+ header?: {
9105
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9106
+ "X-Sous-Company-Id"?: number;
9107
+ };
9108
+ path: {
9109
+ device_id: number;
9110
+ store_public_id: string;
9111
+ };
9112
+ cookie?: never;
9113
+ };
9114
+ requestBody?: {
9115
+ content: {
9116
+ "application/json": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9117
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9118
+ "multipart/form-data": components["schemas"]["PatchedPrintDeviceUpdateRequest"];
9119
+ };
9120
+ };
9121
+ responses: {
9122
+ 200: {
9123
+ headers: {
9124
+ [name: string]: unknown;
9125
+ };
9126
+ content: {
9127
+ "application/json": components["schemas"]["PrintDevice"];
9128
+ };
9129
+ };
9130
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9131
+ 400: {
9132
+ headers: {
9133
+ [name: string]: unknown;
9134
+ };
9135
+ content: {
9136
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9137
+ };
9138
+ };
9139
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9140
+ 401: {
9141
+ headers: {
9142
+ [name: string]: unknown;
9143
+ };
9144
+ content: {
9145
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9146
+ };
9147
+ };
9148
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9149
+ 403: {
9150
+ headers: {
9151
+ [name: string]: unknown;
9152
+ };
9153
+ content: {
9154
+ "application/json": {
9155
+ [key: string]: unknown;
9156
+ };
9157
+ };
9158
+ };
9159
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9160
+ 404: {
9161
+ headers: {
9162
+ [name: string]: unknown;
9163
+ };
9164
+ content: {
9165
+ "application/json": {
9166
+ [key: string]: unknown;
9167
+ };
9168
+ };
9169
+ };
9170
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9171
+ 429: {
9172
+ headers: {
9173
+ [name: string]: unknown;
9174
+ };
9175
+ content: {
9176
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9177
+ };
9178
+ };
9179
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9180
+ 500: {
9181
+ headers: {
9182
+ [name: string]: unknown;
9183
+ };
9184
+ content: {
9185
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9186
+ };
9187
+ };
9188
+ };
9189
+ };
8888
9190
  admin_products_list: {
8889
9191
  parameters: {
8890
9192
  query?: {
@@ -19919,6 +20221,8 @@ interface operations {
19919
20221
  query?: {
19920
20222
  /** @description Delivery destination country as ISO 3166-1 alpha-2 (e.g. NL, BE), used with latitude and longitude. A nationwide carrier that declares per-country service areas only offers its products once the country is known. Case-insensitive; any other value is treated as no country. */
19921
20223
  country?: string;
20224
+ /** @description The pickup or delivery date the customer has chosen (YYYY-MM-DD). Lists only the products that can be ordered today for that date by their own dates: weekly days, included and excluded dates, and order-until. Whether the store is open that day is the time-slots endpoint's answer, not this filter's. An unreadable value is ignored. */
20225
+ handover_date?: string;
19922
20226
  /** @description Sort order for products. Use '-popularity' for most popular first. */
19923
20227
  ordering?: "-popularity" | "-position" | "position";
19924
20228
  /** @description A page number within the paginated result set. */
@@ -20155,6 +20459,91 @@ interface operations {
20155
20459
  };
20156
20460
  };
20157
20461
  };
20462
+ products_orderable_dates_retrieve: {
20463
+ parameters: {
20464
+ query: {
20465
+ /** @description For type=delivery: the customer's delivery types in order of preference, comma-separated (local_delivery, nationwide_delivery). The product's schedule follows the first of them it offers, the type its cart line would get; without one it follows the delivery types the product offers. */
20466
+ fulfillment_types?: string;
20467
+ /** @description Pickup location id, as the pickup time-slots endpoint takes it. Defaults to the store's active pickup location. */
20468
+ location?: number;
20469
+ /** @description Fulfilment type the dates are for. */
20470
+ type: "delivery" | "pickup";
20471
+ /** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
20472
+ lang?: string;
20473
+ };
20474
+ header?: never;
20475
+ path: {
20476
+ /** @description A unique integer value identifying this product. */
20477
+ id: number;
20478
+ };
20479
+ cookie?: never;
20480
+ };
20481
+ requestBody?: never;
20482
+ responses: {
20483
+ 200: {
20484
+ headers: {
20485
+ [name: string]: unknown;
20486
+ };
20487
+ content: {
20488
+ "application/json": components["schemas"]["ProductFulfilmentDates"];
20489
+ };
20490
+ };
20491
+ /** @description Possible error codes: `VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
20492
+ 400: {
20493
+ headers: {
20494
+ [name: string]: unknown;
20495
+ };
20496
+ content: {
20497
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20498
+ };
20499
+ };
20500
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
20501
+ 401: {
20502
+ headers: {
20503
+ [name: string]: unknown;
20504
+ };
20505
+ content: {
20506
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20507
+ };
20508
+ };
20509
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
20510
+ 403: {
20511
+ headers: {
20512
+ [name: string]: unknown;
20513
+ };
20514
+ content: {
20515
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20516
+ };
20517
+ };
20518
+ /** @description Possible error codes: `NOT_FOUND`, `LOCATION_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LOCATION_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
20519
+ 404: {
20520
+ headers: {
20521
+ [name: string]: unknown;
20522
+ };
20523
+ content: {
20524
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20525
+ };
20526
+ };
20527
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
20528
+ 429: {
20529
+ headers: {
20530
+ [name: string]: unknown;
20531
+ };
20532
+ content: {
20533
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20534
+ };
20535
+ };
20536
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
20537
+ 500: {
20538
+ headers: {
20539
+ [name: string]: unknown;
20540
+ };
20541
+ content: {
20542
+ "application/json": components["schemas"]["APIErrorEnvelope"];
20543
+ };
20544
+ };
20545
+ };
20546
+ };
20158
20547
  products_suggestions_list: {
20159
20548
  parameters: {
20160
20549
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-admin-sdk",
3
- "version": "4.4.0",
3
+ "version": "4.6.0",
4
4
  "description": "Type-safe TypeScript SDK for SOUS Storefront Backend admin endpoints",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,