@kanorio/sdk 0.0.0-stage → 1.0.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.
Files changed (84) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +66 -2
  3. package/dist/customer-oauth.d.ts +86 -0
  4. package/dist/customer-oauth.js +112 -0
  5. package/dist/customer.d.ts +176 -0
  6. package/dist/customer.js +116 -0
  7. package/dist/delivery.d.ts +35 -0
  8. package/dist/delivery.js +49 -0
  9. package/dist/edge.d.ts +104 -0
  10. package/dist/edge.js +287 -0
  11. package/dist/forms.d.ts +123 -0
  12. package/dist/forms.js +130 -0
  13. package/dist/generated/customer.d.ts +3157 -0
  14. package/dist/generated/delivery.d.ts +2380 -0
  15. package/dist/generated/management.d.ts +38248 -0
  16. package/dist/http.d.ts +73 -0
  17. package/dist/http.js +162 -0
  18. package/dist/index.d.ts +16 -0
  19. package/dist/index.js +17 -0
  20. package/dist/locales.d.ts +80 -0
  21. package/dist/locales.js +81 -0
  22. package/dist/management.d.ts +19 -0
  23. package/dist/management.js +22 -0
  24. package/dist/paginate.d.ts +18 -0
  25. package/dist/paginate.js +27 -0
  26. package/dist/preview.d.ts +40 -0
  27. package/dist/preview.js +131 -0
  28. package/dist/protection.d.ts +74 -0
  29. package/dist/protection.js +68 -0
  30. package/dist/revalidate.d.ts +84 -0
  31. package/dist/revalidate.js +143 -0
  32. package/dist/seo.d.ts +120 -0
  33. package/dist/seo.js +125 -0
  34. package/dist/server-key.d.ts +71 -0
  35. package/dist/server-key.js +103 -0
  36. package/dist/shared/api/delivery/cache-tags.d.ts +142 -0
  37. package/dist/shared/api/delivery/cache-tags.js +212 -0
  38. package/dist/shared/api/server-key.d.ts +86 -0
  39. package/dist/shared/api/server-key.js +252 -0
  40. package/dist/shared/business-registry/attribution.d.ts +14 -0
  41. package/dist/shared/business-registry/attribution.js +28 -0
  42. package/dist/shared/business-registry/define.d.ts +3 -0
  43. package/dist/shared/business-registry/define.js +4 -0
  44. package/dist/shared/business-registry/formats/eu-vat.d.ts +2 -0
  45. package/dist/shared/business-registry/formats/eu-vat.js +54 -0
  46. package/dist/shared/business-registry/formats/hk-br.d.ts +5 -0
  47. package/dist/shared/business-registry/formats/hk-br.js +23 -0
  48. package/dist/shared/business-registry/formats/jp-trn.d.ts +6 -0
  49. package/dist/shared/business-registry/formats/jp-trn.js +23 -0
  50. package/dist/shared/business-registry/formats/kr-brn.d.ts +6 -0
  51. package/dist/shared/business-registry/formats/kr-brn.js +30 -0
  52. package/dist/shared/business-registry/formats/my.d.ts +7 -0
  53. package/dist/shared/business-registry/formats/my.js +32 -0
  54. package/dist/shared/business-registry/formats/sg-uen.d.ts +1 -0
  55. package/dist/shared/business-registry/formats/sg-uen.js +21 -0
  56. package/dist/shared/business-registry/formats/tw-vat.d.ts +10 -0
  57. package/dist/shared/business-registry/formats/tw-vat.js +32 -0
  58. package/dist/shared/business-registry/index.d.ts +9 -0
  59. package/dist/shared/business-registry/index.js +10 -0
  60. package/dist/shared/business-registry/lookup-wire.d.ts +33 -0
  61. package/dist/shared/business-registry/lookup-wire.js +8 -0
  62. package/dist/shared/business-registry/normalize.d.ts +7 -0
  63. package/dist/shared/business-registry/normalize.js +12 -0
  64. package/dist/shared/business-registry/registry.d.ts +26 -0
  65. package/dist/shared/business-registry/registry.js +67 -0
  66. package/dist/shared/business-registry/types.d.ts +60 -0
  67. package/dist/shared/business-registry/types.js +10 -0
  68. package/dist/shared/localization/locale-path.d.ts +38 -0
  69. package/dist/shared/localization/locale-path.js +76 -0
  70. package/dist/shared/localization/request-locale.d.ts +42 -0
  71. package/dist/shared/localization/request-locale.js +61 -0
  72. package/dist/shared/seo/alternates.d.ts +61 -0
  73. package/dist/shared/seo/alternates.js +71 -0
  74. package/dist/shared/types/forms-logic.d.ts +96 -0
  75. package/dist/shared/types/forms-logic.js +209 -0
  76. package/dist/shared/types/number-input.d.ts +5 -0
  77. package/dist/shared/types/number-input.js +16 -0
  78. package/dist/shared/utils/redirect-matching.d.ts +67 -0
  79. package/dist/shared/utils/redirect-matching.js +148 -0
  80. package/dist/tax-id.d.ts +7 -0
  81. package/dist/tax-id.js +6 -0
  82. package/dist/typed.d.ts +85 -0
  83. package/dist/typed.js +28 -0
  84. package/package.json +86 -3
@@ -0,0 +1,2380 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/openapi.json": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /** OpenAPI 3.1 specification for this site's Content Delivery API */
15
+ get: operations["delivery_openapi"];
16
+ put?: never;
17
+ post?: never;
18
+ delete?: never;
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
23
+ };
24
+ "/site": {
25
+ parameters: {
26
+ query?: never;
27
+ header?: never;
28
+ path?: never;
29
+ cookie?: never;
30
+ };
31
+ /** Public site meta */
32
+ get: operations["delivery_site"];
33
+ put?: never;
34
+ post?: never;
35
+ delete?: never;
36
+ options?: never;
37
+ head?: never;
38
+ patch?: never;
39
+ trace?: never;
40
+ };
41
+ "/redirects": {
42
+ parameters: {
43
+ query?: never;
44
+ header?: never;
45
+ path?: never;
46
+ cookie?: never;
47
+ };
48
+ /** Enabled redirect rules (owner-defined and system 301s from page renames) for the external front end to apply */
49
+ get: operations["delivery_redirects"];
50
+ put?: never;
51
+ post?: never;
52
+ delete?: never;
53
+ options?: never;
54
+ head?: never;
55
+ patch?: never;
56
+ trace?: never;
57
+ };
58
+ "/pages": {
59
+ parameters: {
60
+ query?: never;
61
+ header?: never;
62
+ path?: never;
63
+ cookie?: never;
64
+ };
65
+ /** Published pages and hierarchy tree (paths, parentSlug, breadcrumbs, SEO) */
66
+ get: operations["delivery_pages_list"];
67
+ put?: never;
68
+ post?: never;
69
+ delete?: never;
70
+ options?: never;
71
+ head?: never;
72
+ patch?: never;
73
+ trace?: never;
74
+ };
75
+ "/pages/{slug}": {
76
+ parameters: {
77
+ query?: never;
78
+ header?: never;
79
+ path?: never;
80
+ cookie?: never;
81
+ };
82
+ /** One published page by slug (supports 2-level path and 'home' alias) with sections and assets map */
83
+ get: operations["delivery_page_get"];
84
+ put?: never;
85
+ post?: never;
86
+ delete?: never;
87
+ options?: never;
88
+ head?: never;
89
+ patch?: never;
90
+ trace?: never;
91
+ };
92
+ "/globals/headers/{key}": {
93
+ parameters: {
94
+ query?: never;
95
+ header?: never;
96
+ path?: never;
97
+ cookie?: never;
98
+ };
99
+ /** Global header navigation by key ('primary' or secondary header key) with siteSettings and assets */
100
+ get: operations["delivery_globals_header_get"];
101
+ put?: never;
102
+ post?: never;
103
+ delete?: never;
104
+ options?: never;
105
+ head?: never;
106
+ patch?: never;
107
+ trace?: never;
108
+ };
109
+ "/globals/footer": {
110
+ parameters: {
111
+ query?: never;
112
+ header?: never;
113
+ path?: never;
114
+ cookie?: never;
115
+ };
116
+ /** Global footer navigation and siteSettings with assets */
117
+ get: operations["delivery_globals_footer_get"];
118
+ put?: never;
119
+ post?: never;
120
+ delete?: never;
121
+ options?: never;
122
+ head?: never;
123
+ patch?: never;
124
+ trace?: never;
125
+ };
126
+ "/collections": {
127
+ parameters: {
128
+ query?: never;
129
+ header?: never;
130
+ path?: never;
131
+ cookie?: never;
132
+ };
133
+ /** Collections and their fields (self-describing). System collections also list virtualFields (projection-only fields such as blog segments/toc/contentHtml and taxonomy counts) with scope item|fieldData and a TypeScript type literal. */
134
+ get: operations["delivery_collections_list"];
135
+ put?: never;
136
+ post?: never;
137
+ delete?: never;
138
+ options?: never;
139
+ head?: never;
140
+ patch?: never;
141
+ trace?: never;
142
+ };
143
+ "/collections/{key}/items": {
144
+ parameters: {
145
+ query?: never;
146
+ header?: never;
147
+ path?: never;
148
+ cookie?: never;
149
+ };
150
+ /** Published items of a collection */
151
+ get: operations["delivery_collection_items"];
152
+ put?: never;
153
+ post?: never;
154
+ delete?: never;
155
+ options?: never;
156
+ head?: never;
157
+ patch?: never;
158
+ trace?: never;
159
+ };
160
+ "/collections/{key}/items/{slug}": {
161
+ parameters: {
162
+ query?: never;
163
+ header?: never;
164
+ path?: never;
165
+ cookie?: never;
166
+ };
167
+ /** One published item by slug */
168
+ get: operations["delivery_collection_item"];
169
+ put?: never;
170
+ post?: never;
171
+ delete?: never;
172
+ options?: never;
173
+ head?: never;
174
+ patch?: never;
175
+ trace?: never;
176
+ };
177
+ "/feed": {
178
+ parameters: {
179
+ query?: never;
180
+ header?: never;
181
+ path?: never;
182
+ cookie?: never;
183
+ };
184
+ /** Blog RSS 2.0 feed (respects blog collection accessPolicy) */
185
+ get: operations["delivery_blog_feed_rss"];
186
+ put?: never;
187
+ post?: never;
188
+ delete?: never;
189
+ options?: never;
190
+ head?: never;
191
+ patch?: never;
192
+ trace?: never;
193
+ };
194
+ "/feed.atom": {
195
+ parameters: {
196
+ query?: never;
197
+ header?: never;
198
+ path?: never;
199
+ cookie?: never;
200
+ };
201
+ /** Blog Atom 1.0 feed (respects blog collection accessPolicy) */
202
+ get: operations["delivery_blog_feed_atom"];
203
+ put?: never;
204
+ post?: never;
205
+ delete?: never;
206
+ options?: never;
207
+ head?: never;
208
+ patch?: never;
209
+ trace?: never;
210
+ };
211
+ "/seo/llms.txt": {
212
+ parameters: {
213
+ query?: never;
214
+ header?: never;
215
+ path?: never;
216
+ cookie?: never;
217
+ };
218
+ /** AI / LLM site index (llms.txt) using externalStorefrontUrl as the base URL */
219
+ get: operations["delivery_seo_llms_txt"];
220
+ put?: never;
221
+ post?: never;
222
+ delete?: never;
223
+ options?: never;
224
+ head?: never;
225
+ patch?: never;
226
+ trace?: never;
227
+ };
228
+ "/seo/llms-full.txt": {
229
+ parameters: {
230
+ query?: never;
231
+ header?: never;
232
+ path?: never;
233
+ cookie?: never;
234
+ };
235
+ /** Full site Markdown content (llms-full.txt) using externalStorefrontUrl as the base URL */
236
+ get: operations["delivery_seo_llms_full_txt"];
237
+ put?: never;
238
+ post?: never;
239
+ delete?: never;
240
+ options?: never;
241
+ head?: never;
242
+ patch?: never;
243
+ trace?: never;
244
+ };
245
+ "/seo/sitemap.xml": {
246
+ parameters: {
247
+ query?: never;
248
+ header?: never;
249
+ path?: never;
250
+ cookie?: never;
251
+ };
252
+ /**
253
+ * XML sitemap using externalStorefrontUrl as the base URL
254
+ * @description Published pages, blog posts, the listing pages you declared, products, and items of collections that have a pathTemplate. For the same list as data, use /seo/sitemap.
255
+ */
256
+ get: operations["delivery_seo_sitemap_xml"];
257
+ put?: never;
258
+ post?: never;
259
+ delete?: never;
260
+ options?: never;
261
+ head?: never;
262
+ patch?: never;
263
+ trace?: never;
264
+ };
265
+ "/seo/sitemap": {
266
+ parameters: {
267
+ query?: never;
268
+ header?: never;
269
+ path?: never;
270
+ cookie?: never;
271
+ };
272
+ /**
273
+ * Sitemap entries as JSON, for frontends that build their own sitemap
274
+ * @description The same URLs as /seo/sitemap.xml, as data. Use it when only part of your site is on Kanorio: merge these entries with your own URLs in your sitemap generator (for example Next.js app/sitemap.ts) instead of proxying the XML. Lists published pages, blog posts, the listing pages you declared, products, and items of collections that have a pathTemplate.
275
+ */
276
+ get: operations["delivery_seo_sitemap"];
277
+ put?: never;
278
+ post?: never;
279
+ delete?: never;
280
+ options?: never;
281
+ head?: never;
282
+ patch?: never;
283
+ trace?: never;
284
+ };
285
+ "/seo/robots.txt": {
286
+ parameters: {
287
+ query?: never;
288
+ header?: never;
289
+ path?: never;
290
+ cookie?: never;
291
+ };
292
+ /** robots.txt including AI crawler block rules and Sitemap pointing to externalStorefrontUrl */
293
+ get: operations["delivery_seo_robots_txt"];
294
+ put?: never;
295
+ post?: never;
296
+ delete?: never;
297
+ options?: never;
298
+ head?: never;
299
+ patch?: never;
300
+ trace?: never;
301
+ };
302
+ "/seo/indexnow-key.txt": {
303
+ parameters: {
304
+ query?: never;
305
+ header?: never;
306
+ path?: never;
307
+ cookie?: never;
308
+ };
309
+ /** IndexNow key verification file content; external frontends rewrite `/<key>.txt` to this endpoint so Bing/Naver/Seznam/Yandex can verify ownership of the external storefront domain */
310
+ get: operations["delivery_seo_indexnow_key"];
311
+ put?: never;
312
+ post?: never;
313
+ delete?: never;
314
+ options?: never;
315
+ head?: never;
316
+ patch?: never;
317
+ trace?: never;
318
+ };
319
+ "/seo/jsonld": {
320
+ parameters: {
321
+ query?: never;
322
+ header?: never;
323
+ path?: never;
324
+ cookie?: never;
325
+ };
326
+ /** Schema.org JSON-LD @graph for a given page path */
327
+ get: operations["delivery_seo_jsonld"];
328
+ put?: never;
329
+ post?: never;
330
+ delete?: never;
331
+ options?: never;
332
+ head?: never;
333
+ patch?: never;
334
+ trace?: never;
335
+ };
336
+ "/analytics/pageview": {
337
+ parameters: {
338
+ query?: never;
339
+ header?: never;
340
+ path?: never;
341
+ cookie?: never;
342
+ };
343
+ get?: never;
344
+ put?: never;
345
+ /** Record an anonymous pageview from an external storefront (per-IP rate-limited) */
346
+ post: operations["delivery_analytics_pageview"];
347
+ delete?: never;
348
+ options?: never;
349
+ head?: never;
350
+ patch?: never;
351
+ trace?: never;
352
+ };
353
+ "/analytics/bot-hit": {
354
+ parameters: {
355
+ query?: never;
356
+ header?: never;
357
+ path?: never;
358
+ cookie?: never;
359
+ };
360
+ get?: never;
361
+ put?: never;
362
+ /** Record an AI crawler visit from an external storefront edge middleware (per-IP rate-limited) */
363
+ post: operations["delivery_analytics_bot_hit"];
364
+ delete?: never;
365
+ options?: never;
366
+ head?: never;
367
+ patch?: never;
368
+ trace?: never;
369
+ };
370
+ "/forms/{id}": {
371
+ parameters: {
372
+ query?: never;
373
+ header?: never;
374
+ path?: never;
375
+ cookie?: never;
376
+ };
377
+ /**
378
+ * Public online form definition (fields, availability, consent)
379
+ * @description The form definition grows over time: new values of `fields[].type` and new keys under `fields[]` and `settings` can appear without a version bump. Render the question types you know and skip the rest (treat an unknown type as optional and send no answer for it); ignore keys you do not recognise. A submit can also return per-question error codes you have not seen; show a generic "please check this answer" for those.
380
+ */
381
+ get: operations["delivery_form_get"];
382
+ put?: never;
383
+ post?: never;
384
+ delete?: never;
385
+ options?: never;
386
+ head?: never;
387
+ patch?: never;
388
+ trace?: never;
389
+ };
390
+ "/forms/{id}/challenge": {
391
+ parameters: {
392
+ query?: never;
393
+ header?: never;
394
+ path?: never;
395
+ cookie?: never;
396
+ };
397
+ /** Get the bot check for submitting a form (built-in proof-of-work or the site's third-party widget) */
398
+ get: operations["delivery_form_challenge"];
399
+ put?: never;
400
+ post?: never;
401
+ delete?: never;
402
+ options?: never;
403
+ head?: never;
404
+ patch?: never;
405
+ trace?: never;
406
+ };
407
+ "/forms/{id}/upload-request": {
408
+ parameters: {
409
+ query?: never;
410
+ header?: never;
411
+ path?: never;
412
+ cookie?: never;
413
+ };
414
+ get?: never;
415
+ put?: never;
416
+ /** Request a signed upload ticket for a form file attachment field */
417
+ post: operations["delivery_form_upload_request"];
418
+ delete?: never;
419
+ options?: never;
420
+ head?: never;
421
+ patch?: never;
422
+ trace?: never;
423
+ };
424
+ "/forms/{id}/tax-id-lookup": {
425
+ parameters: {
426
+ query?: never;
427
+ header?: never;
428
+ path?: never;
429
+ cookie?: never;
430
+ };
431
+ get?: never;
432
+ put?: never;
433
+ /** Look up the public business registry for a tax ID question, to prefill the business name. Works only for a tax_id question on a form that is currently open, and only reads Kanorio's own registry snapshot. The result is advisory: a number that is not found is not invalid, and nothing here should block a submission */
434
+ post: operations["delivery_form_tax_id_lookup"];
435
+ delete?: never;
436
+ options?: never;
437
+ head?: never;
438
+ patch?: never;
439
+ trace?: never;
440
+ };
441
+ "/forms/{id}/submit": {
442
+ parameters: {
443
+ query?: never;
444
+ header?: never;
445
+ path?: never;
446
+ cookie?: never;
447
+ };
448
+ get?: never;
449
+ put?: never;
450
+ /** Submit answers to an online form */
451
+ post: operations["delivery_form_submit"];
452
+ delete?: never;
453
+ options?: never;
454
+ head?: never;
455
+ patch?: never;
456
+ trace?: never;
457
+ };
458
+ "/search": {
459
+ parameters: {
460
+ query?: never;
461
+ header?: never;
462
+ path?: never;
463
+ cookie?: never;
464
+ };
465
+ /** Site search */
466
+ get: operations["delivery_search"];
467
+ put?: never;
468
+ post?: never;
469
+ delete?: never;
470
+ options?: never;
471
+ head?: never;
472
+ patch?: never;
473
+ trace?: never;
474
+ };
475
+ "/products": {
476
+ parameters: {
477
+ query?: never;
478
+ header?: never;
479
+ path?: never;
480
+ cookie?: never;
481
+ };
482
+ /** Published products listed in the shop (no deliverable outline) */
483
+ get: operations["delivery_products_list"];
484
+ put?: never;
485
+ post?: never;
486
+ delete?: never;
487
+ options?: never;
488
+ head?: never;
489
+ patch?: never;
490
+ trace?: never;
491
+ };
492
+ "/products/{slug}": {
493
+ parameters: {
494
+ query?: never;
495
+ header?: never;
496
+ path?: never;
497
+ cookie?: never;
498
+ };
499
+ /** One product, including the public outline of its deliverables */
500
+ get: operations["delivery_products_get"];
501
+ put?: never;
502
+ post?: never;
503
+ delete?: never;
504
+ options?: never;
505
+ head?: never;
506
+ patch?: never;
507
+ trace?: never;
508
+ };
509
+ "/units/{id}/open": {
510
+ parameters: {
511
+ query?: never;
512
+ header?: never;
513
+ path?: never;
514
+ cookie?: never;
515
+ };
516
+ get?: never;
517
+ put?: never;
518
+ /** Open a free-preview unit anonymously (isPreview only) */
519
+ post: operations["delivery_units_open_preview"];
520
+ delete?: never;
521
+ options?: never;
522
+ head?: never;
523
+ patch?: never;
524
+ trace?: never;
525
+ };
526
+ "/reviews": {
527
+ parameters: {
528
+ query?: never;
529
+ header?: never;
530
+ path?: never;
531
+ cookie?: never;
532
+ };
533
+ /**
534
+ * Approved reviews for a product
535
+ * @description Newest first, cursor-paginated. Only approved and published reviews are returned; 404 when the target does not exist, is not published, or has reviews turned off. verified is true only for reviews tied to a paid order (imported reviews are never verified).
536
+ */
537
+ get: operations["delivery_reviews_list"];
538
+ put?: never;
539
+ post?: never;
540
+ delete?: never;
541
+ options?: never;
542
+ head?: never;
543
+ patch?: never;
544
+ trace?: never;
545
+ };
546
+ "/reviews/summary": {
547
+ parameters: {
548
+ query?: never;
549
+ header?: never;
550
+ path?: never;
551
+ cookie?: never;
552
+ };
553
+ /**
554
+ * Rating summary for a product
555
+ * @description The blended average rating and the number of reviews, after the store's visibility rule (for example “show once there are 10 reviews”). When visible is false, render nothing.
556
+ */
557
+ get: operations["delivery_reviews_summary"];
558
+ put?: never;
559
+ post?: never;
560
+ delete?: never;
561
+ options?: never;
562
+ head?: never;
563
+ patch?: never;
564
+ trace?: never;
565
+ };
566
+ }
567
+ export type webhooks = Record<string, never>;
568
+ export interface components {
569
+ schemas: {
570
+ ErrorEnvelope: {
571
+ error: {
572
+ code: components["schemas"]["ErrorCode"];
573
+ /** @description English, one sentence. */
574
+ message: string;
575
+ /** @description Structured details for the code (e.g. retryAfter, availableAt, issues). */
576
+ details?: unknown;
577
+ };
578
+ };
579
+ /** @enum {string} */
580
+ ErrorCode: "BAD_HOST" | "COLLECTION_NOT_FOUND" | "DUPLICATE_SUBMISSION" | "FILE_TOO_LARGE" | "FILE_TYPE_NOT_ALLOWED" | "FORBIDDEN" | "FORM_NOT_FOUND" | "HEADER_NOT_FOUND" | "INVALID_ANSWERS" | "INVALID_BODY" | "INVALID_CURSOR" | "INVALID_KIND" | "INVALID_LIMIT" | "INVALID_PATH" | "INVALID_QUERY" | "ITEM_NOT_FOUND" | "NOT_PREVIEW" | "PAGE_NOT_FOUND" | "PAYLOAD_TOO_LARGE" | "PRODUCT_NOT_FOUND" | "QUERY_REQUIRED" | "QUERY_TIMEOUT" | "QUERY_TOO_LONG" | "QUERY_TOO_SHORT" | "RATE_LIMITED" | "SEARCH_BUSY" | "SITE_NOT_FOUND" | "TOO_MANY_PARAMS" | "UNAUTHORIZED" | "UNIT_NOT_FOUND" | "UNKNOWN_BOT" | "UNSUPPORTED_LOCALE" | "UPLOAD_UNAVAILABLE" | "UPSTREAM_UNAVAILABLE" | "VALIDATION" | "VERIFICATION_EXPIRED";
581
+ SiteLocale: {
582
+ /** @description BCP 47 locale code (`en-US`, `zh-Hant`); pass it (or `pathPrefix`) as `?locale=` */
583
+ locale: string;
584
+ isPrimary: boolean;
585
+ /** @description Language name written in that language (`English`, `Deutsch`, `Français`), for a language switcher */
586
+ label: string;
587
+ /** @description URL path prefix of this locale without slashes (`en`, `en-gb`, or a custom word); null for the primary locale, which has no prefix. Hosted pages, sitemaps and hreflang use the same prefix, so a custom frontend should route `/{pathPrefix}/…` to this locale. */
588
+ pathPrefix: string | null;
589
+ };
590
+ SiteMeta: {
591
+ id: string;
592
+ name: string | null;
593
+ description: string | null;
594
+ locale: string | null;
595
+ /** @description Primary locale code; its pages have no URL prefix */
596
+ primaryLocale?: string | null;
597
+ /** @description Published locales (primary first). Each secondary locale lives under `/{pathPrefix}/`. */
598
+ locales?: components["schemas"]["SiteLocale"][];
599
+ timezone: string | null;
600
+ currency: string | null;
601
+ /** @enum {string} */
602
+ frontendMode: "HOSTED" | "HEADLESS";
603
+ homeUrl: string | null;
604
+ publicVersion: string | null;
605
+ brand: components["schemas"]["SiteBrand"];
606
+ /** @description The owner's media protection settings. allowDownload: visitors may download images from the lightbox; deterrence: block right-click, drag and long-press on images and hide lightbox download and share (overrides allowDownload); keepCopyright: downloaded images keep the copyright field; watermark: a watermark is active (watermarked image URLs are already in content and assets). */
607
+ mediaProtection?: {
608
+ allowDownload: boolean;
609
+ keepCopyright: boolean;
610
+ deterrence: boolean;
611
+ watermark: boolean;
612
+ };
613
+ /** @description Customer sign-in settings the sign-in panel needs before anyone is signed in. methods: the sign-in methods this site has turned on and the platform can provide right now, in display order (passkey, google, ..., email_code, email_link; email_code is always present); showNavEntry: whether signed-out visitors should see a sign-in entry; allowSignup: whether visitors without a purchase may register with their email. */
614
+ customerAccess: {
615
+ showNavEntry: boolean;
616
+ allowSignup: boolean;
617
+ methods: ("passkey" | "google" | "apple" | "line" | "kakao" | "external_oidc" | "email_code" | "email_link")[];
618
+ };
619
+ /** @description Bot protection the site uses for anonymous forms and customer sign-in. provider is kanorio (built-in proof-of-work: fetch the challenge from GET /forms/{id}/challenge or GET /customer/auth/protection) or the third-party service the owner picked with their own keys: turnstile, recaptcha or hcaptcha. For a third-party provider, render that provider's widget with entries.<entry>.siteKey and entries.<entry>.action (forms, customer_login) and send its token as captchaToken; the server decides the provider from the site settings. recaptchaVersion is v2 (checkbox) or v3 (score) for recaptcha, otherwise null. */
620
+ botProtection: {
621
+ /** @enum {string} */
622
+ provider: "kanorio" | "turnstile" | "recaptcha" | "hcaptcha";
623
+ /** @enum {string|null} */
624
+ recaptchaVersion: "v2" | "v3" | null;
625
+ /** @description Per entry point (forms, customer_login): the widget site key and the action to pass to the widget. Empty when provider is kanorio. */
626
+ entries: {
627
+ [key: string]: {
628
+ siteKey: string;
629
+ action: string;
630
+ };
631
+ };
632
+ };
633
+ /** @description AI crawler block rules for @kanorio/sdk/edge middleware (invalidated via the ai-crawler-rules cache tag) */
634
+ crawlerRules?: {
635
+ blockedTokens?: string[];
636
+ listVersion?: string;
637
+ };
638
+ /** @description IndexNow key (public by protocol; served at /<key>.txt). @kanorio/sdk/edge uses it to answer the key verification file on an external storefront domain. null until the first IndexNow notification is sent. */
639
+ indexNowKey?: string | null;
640
+ /** @description State of the Kanorio-managed listing pages (blog home, post category/tag/author pages, shop home, product category pages). live: served and has content, index it; empty: served but nothing to list yet, render it with robots noindex (seo.listingRobots in @kanorio/sdk does this); off: not served (hidden by the owner, or not declared in externalListings on a HEADLESS site), do not link to it. Kanorio's sitemap.xml, IndexNow notifications and llms.txt only include live listings. */
641
+ listings?: {
642
+ blogIndex: components["schemas"]["ListingState"];
643
+ blogCategory: components["schemas"]["ListingState"];
644
+ blogTag: components["schemas"]["ListingState"];
645
+ blogAuthor: components["schemas"]["ListingState"];
646
+ shopIndex: components["schemas"]["ListingState"];
647
+ productCategory: components["schemas"]["ListingState"];
648
+ };
649
+ };
650
+ /** @description One brand logo asset: an uploaded image (`url`) or a Lucide icon name (`icon`). */
651
+ SiteBrandLogo: {
652
+ /** @enum {string} */
653
+ type: "image" | "icon";
654
+ /** @description Image URL, when `type` is `image` */
655
+ url?: string;
656
+ /** @description Lucide icon name, when `type` is `icon` */
657
+ icon?: string;
658
+ };
659
+ SiteBrandColor: {
660
+ /** @description Hex brand color for buttons, links and highlights */
661
+ background: string;
662
+ /** @description Hex text color that stays readable on `background` (the owner's choice, or a WCAG-contrast black or white) */
663
+ foreground: string;
664
+ };
665
+ SiteBrandFont: {
666
+ /** @description Font id, as referenced by `typography` */
667
+ id: string;
668
+ /** @description Ready-to-use `font-family` value, fallbacks included */
669
+ family: string;
670
+ /** @description Stylesheet with the `@font-face` rules; null for system fonts */
671
+ stylesheetUrl: string | null;
672
+ /** @description Locales this font is used for (`en`, `zh-Hant`, `zh-Hans`, `ja`, `ko`) */
673
+ locales: string[];
674
+ };
675
+ /** @description Brand identity set under Site settings › Brand: the same colors, logo, fonts, corner radius and color scheme Kanorio applies to the hosted checkout, sign-in, customer account and emails. Values are resolved, so a front end can use them directly; `@kanorio/elements` applies them automatically. Changes take effect immediately, without publishing. */
676
+ SiteBrand: {
677
+ displayName: string | null;
678
+ /** @description The logo to show on a light background and on a dark background (the same asset when the owner uploaded only one) */
679
+ logo: {
680
+ light: components["schemas"]["SiteBrandLogo"] | null;
681
+ dark: components["schemas"]["SiteBrandLogo"] | null;
682
+ };
683
+ colors: {
684
+ /** @description Brand color for light and dark color schemes */
685
+ primary: {
686
+ light: components["schemas"]["SiteBrandColor"];
687
+ dark: components["schemas"]["SiteBrandColor"];
688
+ };
689
+ };
690
+ /** @enum {string} */
691
+ cornerRadius: "soft" | "normal" | "sharp";
692
+ /**
693
+ * @description Color scheme the owner chose: `system` follows the visitor's device; `light` or `dark` fixes Kanorio's hosted checkout, sign-in and customer account to that scheme, and `logo` then returns that scheme's logo for both backgrounds
694
+ * @enum {string}
695
+ */
696
+ colorScheme: "system" | "light" | "dark";
697
+ /** @description CSS lengths for the corner radius scale (`sm`, `md`, `lg`, `xl`, `2xl`, `3xl`, `card`, `media`, `button`); Kanorio-hosted pages expose the same values as `--site-radius-*` */
698
+ radius: {
699
+ [key: string]: string;
700
+ };
701
+ /** @description Font id per locale group */
702
+ typography: {
703
+ bodyEnFontId: string;
704
+ bodyZhHantFontId: string;
705
+ bodyZhHansFontId: string;
706
+ bodyJaFontId: string;
707
+ bodyKoFontId: string;
708
+ };
709
+ /** @description The fonts `typography` refers to, deduplicated, with their stylesheets */
710
+ fonts: components["schemas"]["SiteBrandFont"][];
711
+ };
712
+ /** @enum {string} */
713
+ ListingState: "live" | "empty" | "off";
714
+ ReviewItem: {
715
+ id: string;
716
+ authorName: string;
717
+ rating: number;
718
+ content: string | null;
719
+ /** Format: date-time */
720
+ publishedAt: string;
721
+ /** @description True when the review is tied to a paid order; imported reviews are never verified. */
722
+ verified: boolean;
723
+ /** @description The store's public reply, if any. */
724
+ reply: {
725
+ body: string;
726
+ /** Format: date-time */
727
+ repliedAt: string;
728
+ } | null;
729
+ };
730
+ ReviewList: {
731
+ data: components["schemas"]["ReviewItem"][];
732
+ hasMore: boolean;
733
+ nextCursor: string | null;
734
+ /** @description True when the overall rating blends in reviews carried over from another platform. */
735
+ hasHistoricalRating: boolean;
736
+ };
737
+ ReviewSummary: {
738
+ /** @description product:<id> */
739
+ target: string;
740
+ /** @description Blended average, 1–5; null when hidden. */
741
+ rating: number | null;
742
+ /** @description Reviews counted toward the rating; 0 when hidden. */
743
+ count: number;
744
+ /** @description False when the store hides the rating (disabled or below its threshold). */
745
+ visible: boolean;
746
+ hasHistoricalRating: boolean;
747
+ };
748
+ Redirect: {
749
+ /** @description Path on the site, starts with / */
750
+ sourcePath: string;
751
+ /** @description Relative path or absolute URL */
752
+ targetUrl: string;
753
+ /** @enum {integer} */
754
+ statusCode: 301 | 302;
755
+ /** @enum {string} */
756
+ source: "user" | "system";
757
+ /** @description Null for rules that apply in every locale (matched against the path without the locale prefix). A locale code for rules that belong to one locale, such as a changed translated slug or a retired locale prefix: match these against the full path including the prefix and use targetUrl as is. */
758
+ locale?: string | null;
759
+ /** Format: date-time */
760
+ updatedAt: string;
761
+ };
762
+ PageSummary: {
763
+ /** @description Multilingual sites only: the locale this page was delivered in (the requested locale when it has a published translation, otherwise the primary locale). */
764
+ resolvedLocale?: string;
765
+ /** @description Multilingual sites only: locales with a published translation of this page (the primary locale is not listed). Use it for hreflang and canonical. */
766
+ availableLocales?: string[];
767
+ /** @description Multilingual sites only: this page's path in every live locale, keyed by locale code, without the locale prefix (each locale can have its own translated slug). Use it for hreflang, a language switcher and sitemap alternates. */
768
+ localePaths?: {
769
+ [key: string]: string;
770
+ };
771
+ id: string;
772
+ /** @description The page's path in the page tree ("/" for the home page). For system pages (shop, blog and their archive templates) this is an internal key, not a URL: route by address instead. */
773
+ slug: string;
774
+ /** @description slug split into segments ([] for the home page, ["services", "haircut"] for "/services/haircut"). */
775
+ path: string[];
776
+ /** @description Where this page lives on the site, without the locale prefix. Use it for routing instead of slug or path: a system page's slug is an internal key ("/shop/category" is not a page you can open). */
777
+ address: {
778
+ /** @enum {string} */
779
+ kind: "path";
780
+ /** @description The page's own path. Regular pages: the same as slug. Shop and blog index pages: built from the site's permalink settings. */
781
+ path: string;
782
+ } | {
783
+ /** @enum {string} */
784
+ kind: "template";
785
+ /** @description Prefix shared by every URL this template serves; the URL of one term is basePath + "/" + the term's slug. */
786
+ basePath: string;
787
+ /**
788
+ * @description Which list supplies the terms: blog categories, blog tags, blog authors or product categories.
789
+ * @enum {string}
790
+ */
791
+ termKind: "category" | "tag" | "author" | "product-category";
792
+ } | {
793
+ /** @enum {string} */
794
+ kind: "none";
795
+ };
796
+ parentSlug: string | null;
797
+ isDirectory: boolean;
798
+ depth: number;
799
+ ancestors: {
800
+ slug: string;
801
+ path: string;
802
+ title: string;
803
+ }[];
804
+ breadcrumbs: {
805
+ label: string;
806
+ href: string;
807
+ }[];
808
+ /** @enum {string} */
809
+ breadcrumbSource: "path" | "override";
810
+ title: string;
811
+ pageType: string;
812
+ isHomePage: boolean;
813
+ order: number;
814
+ globalHeaderId?: string | null;
815
+ globalFooterId?: string | null;
816
+ seo: {
817
+ /** @description Optional presentation framing for the share image (fitMode, padColor, focus, screens). */
818
+ ogImageFraming?: Record<string, never> | null;
819
+ } & {
820
+ [key: string]: unknown;
821
+ };
822
+ publishedAt?: string | null;
823
+ updatedAt?: string;
824
+ } & {
825
+ [key: string]: unknown;
826
+ };
827
+ PageDetail: components["schemas"]["PageSummary"] & {
828
+ sections: {
829
+ [key: string]: unknown;
830
+ }[];
831
+ };
832
+ Asset: {
833
+ assetId: string;
834
+ url: string;
835
+ width?: number | null;
836
+ height?: number | null;
837
+ /** @description Alternative text: the alt written where the image is used, otherwise the asset's default alt text set in the media library; null when neither exists. */
838
+ alt?: string | null;
839
+ /** @description true when url is the watermarked version of the image (the site has a watermark on and the image is used where it applies). For images uploaded or replaced with a new version after the watermark was turned on, url is a low-resolution placeholder (or empty) until the watermarked version is ready; the original is never returned. */
840
+ watermarked?: boolean;
841
+ /** @description Default focal point of an image set in the media library, as 0-1 coordinates on the original. Use it for object-position or crop gravity when the field has no framing of its own; null when unset or centered. */
842
+ focus?: {
843
+ x: number;
844
+ y: number;
845
+ } | null;
846
+ /** @description Low-quality image placeholder as a data URL (16px WebP); feed it to Next.js blurDataURL. null for SVG, animated images and legacy uploads not yet backfilled. */
847
+ placeholder?: string | null;
848
+ /** @description Solid border color (#rrggbb) when all four edges of the image share a uniform opaque color (for example a white-background product photo). Use it as background-color when rendering with object-fit: contain; null for transparent or multi-colored images, in which case placeholder can be used as a blurred backdrop. */
849
+ edgeColor?: string | null;
850
+ /**
851
+ * @description Background processing of the file itself (thumbnails, transcoding): ready means the file and its derived versions are usable; processing means url is the original while derived versions are still being produced; waiting_storage means the file is fine and url plays as usual, but derived versions are paused until the site has storage space again (they resume automatically); failed means derived versions will not appear. Subscribe to the media.asset.ready / media.asset.failed webhooks instead of polling.
852
+ * @enum {string}
853
+ */
854
+ processing?: "ready" | "processing" | "waiting_storage" | "failed";
855
+ /** @description Caption tracks of a public video or audio file, one WebVTT per language (hidden tracks are left out; an uploaded track replaces the auto-generated one in the same language). Keep captions off until the viewer turns on CC. media.asset.ready fires with processingKind MEDIA_CAPTIONS when tracks change. */
856
+ captions?: {
857
+ /** @description BCP 47 language tag of the subtitle track. */
858
+ locale: string;
859
+ /** Format: uri */
860
+ url: string;
861
+ /** @enum {string} */
862
+ mimeType: "text/vtt";
863
+ /**
864
+ * @description ai = generated by Kanorio, upload = subtitle file uploaded by the site owner, translation = machine-translated from another track by Kanorio (edited = the site owner corrected it).
865
+ * @enum {string}
866
+ */
867
+ source: "ai" | "upload" | "translation";
868
+ /** @description The site owner corrected the text. */
869
+ edited: boolean;
870
+ }[];
871
+ /** @description Chapter track of a public video or audio file (WebVTT, kind=chapters): generated once for recordings of 10 minutes or more, editable by the site owner. Use it to segment the progress bar and label the seek preview. */
872
+ chapters?: {
873
+ /** Format: uri */
874
+ url: string;
875
+ /** @enum {string} */
876
+ mimeType: "text/vtt";
877
+ };
878
+ mimeType?: string | null;
879
+ fileSize?: number | null;
880
+ kind?: string;
881
+ };
882
+ ItemsPage: {
883
+ data: {
884
+ [key: string]: unknown;
885
+ }[];
886
+ /** @description True when another page exists; pass nextCursor to fetch it. */
887
+ hasMore: boolean;
888
+ /** @description Cursor for the next page, or null on the last page. */
889
+ nextCursor: string | null;
890
+ /** @description Number of matching items; only present when the request sets total=true. */
891
+ total?: number;
892
+ assets: {
893
+ [key: string]: components["schemas"]["Asset"];
894
+ };
895
+ access?: components["schemas"]["AccessSummary"];
896
+ };
897
+ /** @description Field-level access summary. At the top level it describes the collection policy for the current viewer (anonymous or the bearer of a Customer Access Token); per-item access may differ when the collection sets itemOverrideField, so render per item from items[].access. */
898
+ AccessSummary: {
899
+ granted: boolean;
900
+ gated: string[];
901
+ requires: {
902
+ /** @enum {string} */
903
+ kind?: "customer" | "entitlement";
904
+ featureKey?: string;
905
+ } | null;
906
+ };
907
+ PublicDeliverableOutlineUnit: {
908
+ id: string;
909
+ parentId: string | null;
910
+ order: number;
911
+ kind: string;
912
+ title: string | null;
913
+ description: string | null;
914
+ isPreview: boolean;
915
+ /** @description false = bonus unit: not counted toward completion. */
916
+ countsTowardCompletion?: boolean;
917
+ /** Format: date-time */
918
+ releaseAt: string | null;
919
+ duration: number | null;
920
+ pageCount: number | null;
921
+ };
922
+ PublicDeliverableOutline: {
923
+ /** @description Deliverable id. Pass it to <kanorio-curriculum deliverable> or the Customer API. */
924
+ id: string;
925
+ title: string;
926
+ description: string | null;
927
+ /** @enum {string} */
928
+ structure: "COURSE" | "DOWNLOAD";
929
+ coverAssetId: string | null;
930
+ /** @description Cover image of the deliverable (null when unset or the image is in the trash). */
931
+ cover?: {
932
+ url: string;
933
+ width: number | null;
934
+ height: number | null;
935
+ alt: string | null;
936
+ /** @description 16px WebP data URL */
937
+ placeholder: string | null;
938
+ } | null;
939
+ /** @description Authors/instructors in the owner's order (shared site author list). Older servers omit it. */
940
+ authors?: {
941
+ id: string;
942
+ name: string;
943
+ /** @description Job title or credential, e.g. Head Chef */
944
+ title: string | null;
945
+ /** @description Displayable image URL */
946
+ avatar: string | null;
947
+ bio: string | null;
948
+ url: string | null;
949
+ }[];
950
+ unitCount: number;
951
+ totalDurationSeconds: number | null;
952
+ units: components["schemas"]["PublicDeliverableOutlineUnit"][];
953
+ };
954
+ ProductOption: {
955
+ /** @description Stable option id (the key for option translations) */
956
+ id?: string;
957
+ name: string;
958
+ values: string[];
959
+ };
960
+ Product: {
961
+ /** @description Multilingual sites only: the locale this product was delivered in (the requested locale when it has a published translation, otherwise the primary locale). */
962
+ resolvedLocale?: string;
963
+ /** @description Multilingual sites only: locales with a published translation of this product (the primary locale is not listed). Use it for hreflang and canonical. */
964
+ availableLocales?: string[];
965
+ /** @description Multilingual sites only: this product's path in every live locale, keyed by locale code, without the locale prefix (each locale can have its own translated slug). Use it for hreflang, a language switcher and sitemap alternates. */
966
+ localePaths?: {
967
+ [key: string]: string;
968
+ };
969
+ id: string;
970
+ slug: string;
971
+ title: string;
972
+ description?: string | null;
973
+ type?: string;
974
+ currency: string;
975
+ images?: {
976
+ [key: string]: unknown;
977
+ }[];
978
+ /** @description Option dimensions (0–3). Each pricing tier's `optionValues` lists one value per option, in this order. With `locale`, `name` and `values` are translated and tier `optionValues` use the same translated strings. */
979
+ options?: components["schemas"]["ProductOption"][];
980
+ pricingTiers: {
981
+ [key: string]: unknown;
982
+ }[];
983
+ allowCustomAmount?: boolean;
984
+ canPurchase: boolean;
985
+ deliverables?: components["schemas"]["PublicDeliverableOutline"][];
986
+ updatedAt?: string;
987
+ /** @description Product SEO (title, description, Open Graph, robots). Null when unset. */
988
+ seo?: {
989
+ [key: string]: unknown;
990
+ } | null;
991
+ /** @description Alias of seo, kept for the hosted storefront. */
992
+ pageSeo?: {
993
+ [key: string]: unknown;
994
+ } | null;
995
+ } & {
996
+ [key: string]: unknown;
997
+ };
998
+ OpenUnitRendition: {
999
+ /** @enum {string} */
1000
+ kind: "original" | "mp4" | "hls" | "poster" | "thumbnails" | "captions" | "chapters";
1001
+ /** Format: uri */
1002
+ url: string;
1003
+ mimeType: string;
1004
+ /** @description captions only: BCP 47 language tag of the subtitle track. */
1005
+ locale?: string;
1006
+ /**
1007
+ * @description captions only: ai = generated by Kanorio, upload = subtitle file uploaded by the site owner, translation = machine-translated from another track by Kanorio (edited = the site owner corrected it).
1008
+ * @enum {string}
1009
+ */
1010
+ source?: "ai" | "upload" | "translation";
1011
+ /** @description captions only: the site owner corrected the text. */
1012
+ edited?: boolean;
1013
+ width?: number;
1014
+ height?: number;
1015
+ bytes?: number;
1016
+ };
1017
+ OpenUnitResponse: {
1018
+ /** @enum {string} */
1019
+ mode: "read" | "download";
1020
+ /**
1021
+ * Format: uri
1022
+ * @description Signed URL of the original file (download, or playback when there is no streaming version).
1023
+ */
1024
+ url: string;
1025
+ /** @description Seconds. Videos: 1.5 × duration + 10 minutes, between 15 minutes and 4 hours; other files: 600. */
1026
+ expiresIn: number;
1027
+ title: string | null;
1028
+ fileName: string;
1029
+ mimeType: string | null;
1030
+ allowDownload: boolean;
1031
+ /** @description Playback sources: original, plus hls (adaptive-streaming master manifest on a signed path, play this one when present), thumbnails (progress-bar storyboard VTT) and poster for transcoded videos, and captions (one WebVTT track per language with locale, source and edited; keep them off until the viewer turns on CC). Same validity as expiresIn. */
1032
+ renditions?: components["schemas"]["OpenUnitRendition"][];
1033
+ /** Format: uri */
1034
+ poster?: string | null;
1035
+ /** Format: uri */
1036
+ thumbnails?: string | null;
1037
+ /**
1038
+ * @description partial: some qualities are in the manifest (the lowest first) while the rest are still being produced, or are waiting for storage when processing is waiting_storage; ready: all qualities. media.asset.ready fires once all qualities are done.
1039
+ * @enum {string}
1040
+ */
1041
+ streaming?: "none" | "partial" | "ready";
1042
+ };
1043
+ };
1044
+ responses: {
1045
+ /** @description Error (400) */
1046
+ Error400: {
1047
+ headers: {
1048
+ [name: string]: unknown;
1049
+ };
1050
+ content: {
1051
+ "application/json": components["schemas"]["ErrorEnvelope"];
1052
+ };
1053
+ };
1054
+ /** @description Error (401) */
1055
+ Error401: {
1056
+ headers: {
1057
+ [name: string]: unknown;
1058
+ };
1059
+ content: {
1060
+ "application/json": components["schemas"]["ErrorEnvelope"];
1061
+ };
1062
+ };
1063
+ /** @description Error (403) */
1064
+ Error403: {
1065
+ headers: {
1066
+ [name: string]: unknown;
1067
+ };
1068
+ content: {
1069
+ "application/json": components["schemas"]["ErrorEnvelope"];
1070
+ };
1071
+ };
1072
+ /** @description Error (404) */
1073
+ Error404: {
1074
+ headers: {
1075
+ [name: string]: unknown;
1076
+ };
1077
+ content: {
1078
+ "application/json": components["schemas"]["ErrorEnvelope"];
1079
+ };
1080
+ };
1081
+ /** @description Error (405) */
1082
+ Error405: {
1083
+ headers: {
1084
+ [name: string]: unknown;
1085
+ };
1086
+ content: {
1087
+ "application/json": components["schemas"]["ErrorEnvelope"];
1088
+ };
1089
+ };
1090
+ /** @description Error (409) */
1091
+ Error409: {
1092
+ headers: {
1093
+ [name: string]: unknown;
1094
+ };
1095
+ content: {
1096
+ "application/json": components["schemas"]["ErrorEnvelope"];
1097
+ };
1098
+ };
1099
+ /** @description Error (413) */
1100
+ Error413: {
1101
+ headers: {
1102
+ [name: string]: unknown;
1103
+ };
1104
+ content: {
1105
+ "application/json": components["schemas"]["ErrorEnvelope"];
1106
+ };
1107
+ };
1108
+ /** @description Error (422) */
1109
+ Error422: {
1110
+ headers: {
1111
+ [name: string]: unknown;
1112
+ };
1113
+ content: {
1114
+ "application/json": components["schemas"]["ErrorEnvelope"];
1115
+ };
1116
+ };
1117
+ /** @description Error (429) */
1118
+ Error429: {
1119
+ headers: {
1120
+ [name: string]: unknown;
1121
+ };
1122
+ content: {
1123
+ "application/json": components["schemas"]["ErrorEnvelope"];
1124
+ };
1125
+ };
1126
+ /** @description Error (502) */
1127
+ Error502: {
1128
+ headers: {
1129
+ [name: string]: unknown;
1130
+ };
1131
+ content: {
1132
+ "application/json": components["schemas"]["ErrorEnvelope"];
1133
+ };
1134
+ };
1135
+ /** @description Error (503) */
1136
+ Error503: {
1137
+ headers: {
1138
+ [name: string]: unknown;
1139
+ };
1140
+ content: {
1141
+ "application/json": components["schemas"]["ErrorEnvelope"];
1142
+ };
1143
+ };
1144
+ };
1145
+ parameters: never;
1146
+ requestBodies: never;
1147
+ headers: never;
1148
+ pathItems: never;
1149
+ }
1150
+ export type $defs = Record<string, never>;
1151
+ export interface operations {
1152
+ delivery_openapi: {
1153
+ parameters: {
1154
+ query?: never;
1155
+ header?: never;
1156
+ path?: never;
1157
+ cookie?: never;
1158
+ };
1159
+ requestBody?: never;
1160
+ responses: {
1161
+ /** @description OK */
1162
+ 200: {
1163
+ headers: {
1164
+ [name: string]: unknown;
1165
+ };
1166
+ content: {
1167
+ "application/json": {
1168
+ [key: string]: unknown;
1169
+ };
1170
+ };
1171
+ };
1172
+ 400: components["responses"]["Error400"];
1173
+ 404: components["responses"]["Error404"];
1174
+ 429: components["responses"]["Error429"];
1175
+ 503: components["responses"]["Error503"];
1176
+ };
1177
+ };
1178
+ delivery_site: {
1179
+ parameters: {
1180
+ query?: {
1181
+ /** @description Pass `preview=1` with `X-Kanorio-Preview: knr_pv_<token>` to check a preview token before entering preview mode: the token's signature, expiry and site are verified at the edge and an invalid token gets `401`. Site meta has no draft, so the body is the same as without it (`Cache-Control: no-store`). Used by `createPreviewRouteHandler` in `@kanorio/sdk/preview`. */
1182
+ preview?: "1";
1183
+ };
1184
+ header?: never;
1185
+ path?: never;
1186
+ cookie?: never;
1187
+ };
1188
+ requestBody?: never;
1189
+ responses: {
1190
+ /** @description OK */
1191
+ 200: {
1192
+ headers: {
1193
+ [name: string]: unknown;
1194
+ };
1195
+ content: {
1196
+ "application/json": components["schemas"]["SiteMeta"];
1197
+ };
1198
+ };
1199
+ 400: components["responses"]["Error400"];
1200
+ 404: components["responses"]["Error404"];
1201
+ 429: components["responses"]["Error429"];
1202
+ 503: components["responses"]["Error503"];
1203
+ };
1204
+ };
1205
+ delivery_redirects: {
1206
+ parameters: {
1207
+ query?: never;
1208
+ header?: never;
1209
+ path?: never;
1210
+ cookie?: never;
1211
+ };
1212
+ requestBody?: never;
1213
+ responses: {
1214
+ /** @description OK. Every redirect rule in one page (hasMore is always false). */
1215
+ 200: {
1216
+ headers: {
1217
+ [name: string]: unknown;
1218
+ };
1219
+ content: {
1220
+ "application/json": {
1221
+ data: components["schemas"]["Redirect"][];
1222
+ /** @description True when another page exists; pass nextCursor to fetch it. */
1223
+ hasMore: boolean;
1224
+ /** @description Cursor for the next page, or null on the last page. */
1225
+ nextCursor: string | null;
1226
+ };
1227
+ };
1228
+ };
1229
+ 400: components["responses"]["Error400"];
1230
+ 404: components["responses"]["Error404"];
1231
+ 429: components["responses"]["Error429"];
1232
+ 503: components["responses"]["Error503"];
1233
+ };
1234
+ };
1235
+ delivery_pages_list: {
1236
+ parameters: {
1237
+ query?: {
1238
+ /** @description Locale for page titles and SEO fields. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. On multilingual sites each page carries resolvedLocale and availableLocales. Slugs stay in the primary locale's path space; prefix them with the locale's pathPrefix. */
1239
+ locale?: string;
1240
+ /** @description Maximum number of items to return, 1-100. Defaults to 20. */
1241
+ limit?: number;
1242
+ /** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
1243
+ cursor?: string;
1244
+ };
1245
+ header?: never;
1246
+ path?: never;
1247
+ cookie?: never;
1248
+ };
1249
+ requestBody?: never;
1250
+ responses: {
1251
+ /** @description OK */
1252
+ 200: {
1253
+ headers: {
1254
+ [name: string]: unknown;
1255
+ };
1256
+ content: {
1257
+ "application/json": {
1258
+ data: components["schemas"]["PageSummary"][];
1259
+ /** @description True when another page exists; pass nextCursor to fetch it. */
1260
+ hasMore: boolean;
1261
+ /** @description Cursor for the next page, or null on the last page. */
1262
+ nextCursor: string | null;
1263
+ };
1264
+ };
1265
+ };
1266
+ 400: components["responses"]["Error400"];
1267
+ 404: components["responses"]["Error404"];
1268
+ 429: components["responses"]["Error429"];
1269
+ 503: components["responses"]["Error503"];
1270
+ };
1271
+ };
1272
+ delivery_page_get: {
1273
+ parameters: {
1274
+ query?: {
1275
+ /** @description Locale for the page title, SEO fields and section text. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. On multilingual sites the page carries resolvedLocale and availableLocales (use them for canonical and hreflang). Slugs and in-content links stay in the primary locale's path space; prefix them with the locale's pathPrefix. */
1276
+ locale?: string;
1277
+ };
1278
+ header?: never;
1279
+ path: {
1280
+ slug: string;
1281
+ };
1282
+ cookie?: never;
1283
+ };
1284
+ requestBody?: never;
1285
+ responses: {
1286
+ /** @description OK */
1287
+ 200: {
1288
+ headers: {
1289
+ [name: string]: unknown;
1290
+ };
1291
+ content: {
1292
+ "application/json": {
1293
+ page: components["schemas"]["PageDetail"];
1294
+ assets: {
1295
+ [key: string]: components["schemas"]["Asset"];
1296
+ };
1297
+ };
1298
+ };
1299
+ };
1300
+ 400: components["responses"]["Error400"];
1301
+ 404: components["responses"]["Error404"];
1302
+ 429: components["responses"]["Error429"];
1303
+ 503: components["responses"]["Error503"];
1304
+ };
1305
+ };
1306
+ delivery_globals_header_get: {
1307
+ parameters: {
1308
+ query?: {
1309
+ /** @description Locale for the header text and the site settings copy (address, hours, copyright, buttons). One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. */
1310
+ locale?: string;
1311
+ };
1312
+ header?: never;
1313
+ path: {
1314
+ key: string;
1315
+ };
1316
+ cookie?: never;
1317
+ };
1318
+ requestBody?: never;
1319
+ responses: {
1320
+ /** @description OK */
1321
+ 200: {
1322
+ headers: {
1323
+ [name: string]: unknown;
1324
+ };
1325
+ content: {
1326
+ "application/json": {
1327
+ key: string;
1328
+ isPrimary: boolean;
1329
+ header: {
1330
+ [key: string]: unknown;
1331
+ };
1332
+ siteSettings: {
1333
+ [key: string]: unknown;
1334
+ } | null;
1335
+ assets: {
1336
+ [key: string]: components["schemas"]["Asset"];
1337
+ };
1338
+ };
1339
+ };
1340
+ };
1341
+ 400: components["responses"]["Error400"];
1342
+ 404: components["responses"]["Error404"];
1343
+ 429: components["responses"]["Error429"];
1344
+ 503: components["responses"]["Error503"];
1345
+ };
1346
+ };
1347
+ delivery_globals_footer_get: {
1348
+ parameters: {
1349
+ query?: {
1350
+ /** @description Locale for the footer text and the site settings copy (address, hours, copyright, buttons). One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. */
1351
+ locale?: string;
1352
+ };
1353
+ header?: never;
1354
+ path?: never;
1355
+ cookie?: never;
1356
+ };
1357
+ requestBody?: never;
1358
+ responses: {
1359
+ /** @description OK */
1360
+ 200: {
1361
+ headers: {
1362
+ [name: string]: unknown;
1363
+ };
1364
+ content: {
1365
+ "application/json": {
1366
+ footer: {
1367
+ [key: string]: unknown;
1368
+ };
1369
+ siteSettings: {
1370
+ [key: string]: unknown;
1371
+ } | null;
1372
+ assets: {
1373
+ [key: string]: components["schemas"]["Asset"];
1374
+ };
1375
+ };
1376
+ };
1377
+ };
1378
+ 400: components["responses"]["Error400"];
1379
+ 404: components["responses"]["Error404"];
1380
+ 429: components["responses"]["Error429"];
1381
+ 503: components["responses"]["Error503"];
1382
+ };
1383
+ };
1384
+ delivery_collections_list: {
1385
+ parameters: {
1386
+ query?: never;
1387
+ header?: never;
1388
+ path?: never;
1389
+ cookie?: never;
1390
+ };
1391
+ requestBody?: never;
1392
+ responses: {
1393
+ /** @description OK. Every collection in one page (hasMore is always false). */
1394
+ 200: {
1395
+ headers: {
1396
+ [name: string]: unknown;
1397
+ };
1398
+ content: {
1399
+ "application/json": {
1400
+ data: {
1401
+ [key: string]: unknown;
1402
+ }[];
1403
+ /** @description True when another page exists; pass nextCursor to fetch it. */
1404
+ hasMore: boolean;
1405
+ /** @description Cursor for the next page, or null on the last page. */
1406
+ nextCursor: string | null;
1407
+ };
1408
+ };
1409
+ };
1410
+ 400: components["responses"]["Error400"];
1411
+ 404: components["responses"]["Error404"];
1412
+ 429: components["responses"]["Error429"];
1413
+ 503: components["responses"]["Error503"];
1414
+ };
1415
+ };
1416
+ delivery_collection_items: {
1417
+ parameters: {
1418
+ query?: {
1419
+ /** @description Bracket-notation filter conditions (up to 10 conditions combined with AND, plus 2-level OR groups via filter[any][0][field][op]=value). Shorthand filter[field]=value equals filter[field][eq]=value. 15 operators by field type: eq, ne, in, nin (up to 100 comma-separated values), gt, gte, lt, lte, contains, ncontains, match (multi-word substring match on text/rich_text, max 1 per query and 8 words), exists (true|false), has (multi_select/multi_reference), eq_slug (reference), has_slug (multi_reference). Item-level attributes slug, publishedAt, createdAt, updatedAt are also filterable. Date/datetime fields accept relative expressions: now or now[+-]<N><s|m|h|d|w|M|y> (e.g. filter[publishedAt][gte]=now-30d). */
1420
+ filter?: {
1421
+ [key: string]: unknown;
1422
+ };
1423
+ /** @description Comma-separated sort fields (up to 3 fields), prefix with `-` for descending (e.g. `sort=-publishedAt,title`), or bracket form `sort[field]=asc|desc`. Sortable: scalar fields and item attributes (`slug`, `publishedAt`, `createdAt`, `updatedAt`); `rich_text`, `json`, `image`, `gallery`, `file`, and `multi_*` are not sortable. */
1424
+ sort?: string;
1425
+ /** @description Maximum number of items to return, 1-100. Defaults to 20. */
1426
+ limit?: number;
1427
+ /** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
1428
+ cursor?: string;
1429
+ /** @description true adds total (the number of matching items) to the response; it costs an extra count query. */
1430
+ total?: boolean;
1431
+ /** @description Comma-separated `fieldData` field IDs to project (top-level item metadata `id`, `slug`, `publishedAt`, `updatedAt` are always returned). */
1432
+ fields?: string;
1433
+ /** @description Comma-separated `reference` or `multi_reference` field IDs (plus `primary_author`, `primary_category` on `blog`) to expand 1 layer into `item.expanded[fieldId]`. Referenced media assets are automatically included in the top-level `assets` map (trashed, missing, or private-bucket assets are filtered out). */
1434
+ expand?: string;
1435
+ /** @description Reference include depth. Only 1 is accepted in v1. */
1436
+ includeDepth?: 1;
1437
+ /** @description Comma-separated blog content formats: markdown, html, plaintext */
1438
+ formats?: string;
1439
+ /** @description Locale for item fields marked localized; for the blog, blog_categories, blog_tags and authors collections, the post, category, tag and author translations (titles, excerpts, bodies, SEO fields). Expanded references are translated too. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. On multilingual sites each item carries resolvedLocale and availableLocales. */
1440
+ locale?: string;
1441
+ /** @description Pass `preview=1` with `X-Kanorio-Preview: knr_pv_<token>` (or a server-held PAT with `collections:view`) to read unpublished draft `fieldData` (`Cache-Control: no-store`). */
1442
+ preview?: "1";
1443
+ };
1444
+ header?: never;
1445
+ path: {
1446
+ key: string;
1447
+ };
1448
+ cookie?: never;
1449
+ };
1450
+ requestBody?: never;
1451
+ responses: {
1452
+ /** @description OK */
1453
+ 200: {
1454
+ headers: {
1455
+ [name: string]: unknown;
1456
+ };
1457
+ content: {
1458
+ "application/json": components["schemas"]["ItemsPage"];
1459
+ };
1460
+ };
1461
+ 400: components["responses"]["Error400"];
1462
+ 404: components["responses"]["Error404"];
1463
+ 429: components["responses"]["Error429"];
1464
+ 503: components["responses"]["Error503"];
1465
+ };
1466
+ };
1467
+ delivery_collection_item: {
1468
+ parameters: {
1469
+ query?: {
1470
+ fields?: string;
1471
+ expand?: string;
1472
+ /** @description Comma-separated blog content formats: markdown, html, plaintext */
1473
+ formats?: string;
1474
+ preview?: "1";
1475
+ /** @description Reference include depth. Only 1 is accepted in v1. */
1476
+ includeDepth?: 1;
1477
+ /** @description Locale for the item, the same as the list endpoint (system collections use the post, category, tag and author translations; expanded references are translated too). One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. On multilingual sites the item carries resolvedLocale and availableLocales. */
1478
+ locale?: string;
1479
+ };
1480
+ header?: never;
1481
+ path: {
1482
+ key: string;
1483
+ slug: string;
1484
+ };
1485
+ cookie?: never;
1486
+ };
1487
+ requestBody?: never;
1488
+ responses: {
1489
+ /** @description OK */
1490
+ 200: {
1491
+ headers: {
1492
+ [name: string]: unknown;
1493
+ };
1494
+ content: {
1495
+ "application/json": {
1496
+ item: {
1497
+ [key: string]: unknown;
1498
+ };
1499
+ assets: {
1500
+ [key: string]: components["schemas"]["Asset"];
1501
+ };
1502
+ access?: components["schemas"]["AccessSummary"];
1503
+ };
1504
+ };
1505
+ };
1506
+ 400: components["responses"]["Error400"];
1507
+ 404: components["responses"]["Error404"];
1508
+ 429: components["responses"]["Error429"];
1509
+ 503: components["responses"]["Error503"];
1510
+ };
1511
+ };
1512
+ delivery_blog_feed_rss: {
1513
+ parameters: {
1514
+ query?: {
1515
+ /** @description Filter by blog_tags slug */
1516
+ tag?: string;
1517
+ /** @description Filter by authors slug (the shared author list; blog_authors is the legacy key) */
1518
+ author?: string;
1519
+ limit?: number;
1520
+ /** @description Locale of the feed: post titles and summaries from that locale's published translations, links with the locale's URL prefix, and the feed language. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. */
1521
+ locale?: string;
1522
+ };
1523
+ header?: never;
1524
+ path?: never;
1525
+ cookie?: never;
1526
+ };
1527
+ requestBody?: never;
1528
+ responses: {
1529
+ /** @description RSS 2.0 XML */
1530
+ 200: {
1531
+ headers: {
1532
+ [name: string]: unknown;
1533
+ };
1534
+ content: {
1535
+ "application/rss+xml": string;
1536
+ };
1537
+ };
1538
+ 400: components["responses"]["Error400"];
1539
+ 404: components["responses"]["Error404"];
1540
+ 429: components["responses"]["Error429"];
1541
+ 503: components["responses"]["Error503"];
1542
+ };
1543
+ };
1544
+ delivery_blog_feed_atom: {
1545
+ parameters: {
1546
+ query?: {
1547
+ /** @description Filter by blog_tags slug */
1548
+ tag?: string;
1549
+ /** @description Filter by authors slug (the shared author list; blog_authors is the legacy key) */
1550
+ author?: string;
1551
+ limit?: number;
1552
+ /** @description Locale of the feed: post titles and summaries from that locale's published translations, links with the locale's URL prefix, and the feed language. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. */
1553
+ locale?: string;
1554
+ };
1555
+ header?: never;
1556
+ path?: never;
1557
+ cookie?: never;
1558
+ };
1559
+ requestBody?: never;
1560
+ responses: {
1561
+ /** @description Atom 1.0 XML */
1562
+ 200: {
1563
+ headers: {
1564
+ [name: string]: unknown;
1565
+ };
1566
+ content: {
1567
+ "application/atom+xml": string;
1568
+ };
1569
+ };
1570
+ 400: components["responses"]["Error400"];
1571
+ 404: components["responses"]["Error404"];
1572
+ 429: components["responses"]["Error429"];
1573
+ 503: components["responses"]["Error503"];
1574
+ };
1575
+ };
1576
+ delivery_seo_llms_txt: {
1577
+ parameters: {
1578
+ query?: {
1579
+ /** @description Locale of the file: page and post titles and summaries from that locale's published translations, URLs with the locale's URL prefix, and a Languages section linking the other locales' files at /{prefix}/llms.txt. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. A custom llms.txt applies to the primary locale only. Rewrite /{prefix}/llms.txt on your front end to this endpoint with locale={prefix}. */
1580
+ locale?: string;
1581
+ };
1582
+ header?: never;
1583
+ path?: never;
1584
+ cookie?: never;
1585
+ };
1586
+ requestBody?: never;
1587
+ responses: {
1588
+ /** @description Plain-text llms.txt */
1589
+ 200: {
1590
+ headers: {
1591
+ [name: string]: unknown;
1592
+ };
1593
+ content: {
1594
+ "text/plain": string;
1595
+ };
1596
+ };
1597
+ 400: components["responses"]["Error400"];
1598
+ 404: components["responses"]["Error404"];
1599
+ 429: components["responses"]["Error429"];
1600
+ 503: components["responses"]["Error503"];
1601
+ };
1602
+ };
1603
+ delivery_seo_llms_full_txt: {
1604
+ parameters: {
1605
+ query?: {
1606
+ /** @description Locale of the file: page sections and post bodies from that locale's published translations, URLs with the locale's URL prefix, and links to the other locales' files. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. A custom llms-full.txt applies to the primary locale only. */
1607
+ locale?: string;
1608
+ };
1609
+ header?: never;
1610
+ path?: never;
1611
+ cookie?: never;
1612
+ };
1613
+ requestBody?: never;
1614
+ responses: {
1615
+ /** @description Plain-text llms-full.txt */
1616
+ 200: {
1617
+ headers: {
1618
+ [name: string]: unknown;
1619
+ };
1620
+ content: {
1621
+ "text/plain": string;
1622
+ };
1623
+ };
1624
+ 400: components["responses"]["Error400"];
1625
+ 404: components["responses"]["Error404"];
1626
+ 429: components["responses"]["Error429"];
1627
+ 503: components["responses"]["Error503"];
1628
+ };
1629
+ };
1630
+ delivery_seo_sitemap_xml: {
1631
+ parameters: {
1632
+ query?: never;
1633
+ header?: never;
1634
+ path?: never;
1635
+ cookie?: never;
1636
+ };
1637
+ requestBody?: never;
1638
+ responses: {
1639
+ /** @description Sitemap XML */
1640
+ 200: {
1641
+ headers: {
1642
+ [name: string]: unknown;
1643
+ };
1644
+ content: {
1645
+ "application/xml": string;
1646
+ };
1647
+ };
1648
+ 400: components["responses"]["Error400"];
1649
+ 404: components["responses"]["Error404"];
1650
+ 429: components["responses"]["Error429"];
1651
+ 503: components["responses"]["Error503"];
1652
+ };
1653
+ };
1654
+ delivery_seo_sitemap: {
1655
+ parameters: {
1656
+ query?: never;
1657
+ header?: never;
1658
+ path?: never;
1659
+ cookie?: never;
1660
+ };
1661
+ requestBody?: never;
1662
+ responses: {
1663
+ /** @description Sitemap entries */
1664
+ 200: {
1665
+ headers: {
1666
+ [name: string]: unknown;
1667
+ };
1668
+ content: {
1669
+ "application/json": {
1670
+ /** @description Base URL the entries are built on (externalStorefrontUrl when set), without a trailing slash. */
1671
+ siteUrl: string;
1672
+ urls: {
1673
+ /** @description Absolute URL. */
1674
+ url: string;
1675
+ /** @description Path on the site, starting with /. */
1676
+ path: string;
1677
+ /** @description Date (YYYY-MM-DD). */
1678
+ lastModified: string;
1679
+ changeFrequency: string;
1680
+ priority: number;
1681
+ /**
1682
+ * @description What the URL is. collection-item: an item of a custom collection that has a pathTemplate.
1683
+ * @enum {string}
1684
+ */
1685
+ kind: "page" | "page-anchor" | "blog-index" | "blog-post" | "blog-category" | "blog-tag" | "blog-author" | "shop-index" | "product" | "product-category" | "collection-item";
1686
+ /** @description Locale of this URL (multilingual sites only). */
1687
+ locale?: string;
1688
+ /** @description Every locale version of the same page, including x-default (multilingual sites only). */
1689
+ alternates?: {
1690
+ hreflang: string;
1691
+ href: string;
1692
+ }[];
1693
+ }[];
1694
+ };
1695
+ };
1696
+ };
1697
+ 400: components["responses"]["Error400"];
1698
+ 404: components["responses"]["Error404"];
1699
+ 429: components["responses"]["Error429"];
1700
+ 503: components["responses"]["Error503"];
1701
+ };
1702
+ };
1703
+ delivery_seo_robots_txt: {
1704
+ parameters: {
1705
+ query?: never;
1706
+ header?: never;
1707
+ path?: never;
1708
+ cookie?: never;
1709
+ };
1710
+ requestBody?: never;
1711
+ responses: {
1712
+ /** @description Plain-text robots.txt */
1713
+ 200: {
1714
+ headers: {
1715
+ [name: string]: unknown;
1716
+ };
1717
+ content: {
1718
+ "text/plain": string;
1719
+ };
1720
+ };
1721
+ 400: components["responses"]["Error400"];
1722
+ 404: components["responses"]["Error404"];
1723
+ 429: components["responses"]["Error429"];
1724
+ 503: components["responses"]["Error503"];
1725
+ };
1726
+ };
1727
+ delivery_seo_indexnow_key: {
1728
+ parameters: {
1729
+ query?: never;
1730
+ header?: never;
1731
+ path?: never;
1732
+ cookie?: never;
1733
+ };
1734
+ requestBody?: never;
1735
+ responses: {
1736
+ /** @description Plain-text IndexNow key */
1737
+ 200: {
1738
+ headers: {
1739
+ [name: string]: unknown;
1740
+ };
1741
+ content: {
1742
+ "text/plain": string;
1743
+ };
1744
+ };
1745
+ 400: components["responses"]["Error400"];
1746
+ 404: components["responses"]["Error404"];
1747
+ 429: components["responses"]["Error429"];
1748
+ 503: components["responses"]["Error503"];
1749
+ };
1750
+ };
1751
+ delivery_seo_jsonld: {
1752
+ parameters: {
1753
+ query?: {
1754
+ /** @description Relative page path starting with / (e.g. /, /about, /blog, /blog/my-post). A path Kanorio does not manage (a page that lives only in your own frontend) returns the site-level nodes only: Organization with @id `{siteUrl}/#organization` and WebSite with @id `{siteUrl}/#website`. Reference those @ids from your own page-level nodes instead of repeating them. An unknown slug under the blog path returns 404 PAGE_NOT_FOUND. */
1755
+ path?: string;
1756
+ /** @description Locale of the structured data: inLanguage, page and post names and descriptions from that locale's published translations, and page URLs with the locale's URL prefix. Pass path in the primary locale's path space (strip the locale prefix). One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. */
1757
+ locale?: string;
1758
+ };
1759
+ header?: never;
1760
+ path?: never;
1761
+ cookie?: never;
1762
+ };
1763
+ requestBody?: never;
1764
+ responses: {
1765
+ /** @description JSON-LD document */
1766
+ 200: {
1767
+ headers: {
1768
+ [name: string]: unknown;
1769
+ };
1770
+ content: {
1771
+ "application/json": {
1772
+ [key: string]: unknown;
1773
+ };
1774
+ };
1775
+ };
1776
+ 400: components["responses"]["Error400"];
1777
+ 404: components["responses"]["Error404"];
1778
+ 429: components["responses"]["Error429"];
1779
+ 503: components["responses"]["Error503"];
1780
+ };
1781
+ };
1782
+ delivery_analytics_pageview: {
1783
+ parameters: {
1784
+ query?: never;
1785
+ header?: never;
1786
+ path?: never;
1787
+ cookie?: never;
1788
+ };
1789
+ requestBody: {
1790
+ content: {
1791
+ "application/json": {
1792
+ /** @description Relative path starting with / */
1793
+ path: string;
1794
+ referrer?: string;
1795
+ title?: string;
1796
+ /** @enum {string} */
1797
+ uaCategory?: "desktop" | "mobile" | "tablet" | "bot";
1798
+ };
1799
+ };
1800
+ };
1801
+ responses: {
1802
+ /** @description Recorded */
1803
+ 200: {
1804
+ headers: {
1805
+ [name: string]: unknown;
1806
+ };
1807
+ content: {
1808
+ "application/json": {
1809
+ uaCategory?: string;
1810
+ };
1811
+ };
1812
+ };
1813
+ 400: components["responses"]["Error400"];
1814
+ 401: components["responses"]["Error401"];
1815
+ 403: components["responses"]["Error403"];
1816
+ 404: components["responses"]["Error404"];
1817
+ 429: components["responses"]["Error429"];
1818
+ 503: components["responses"]["Error503"];
1819
+ };
1820
+ };
1821
+ delivery_analytics_bot_hit: {
1822
+ parameters: {
1823
+ query?: never;
1824
+ header?: never;
1825
+ path?: never;
1826
+ cookie?: never;
1827
+ };
1828
+ requestBody: {
1829
+ content: {
1830
+ "application/json": {
1831
+ /** @description Recognized crawler token (e.g. GPTBot, ClaudeBot, PerplexityBot) */
1832
+ botToken?: string;
1833
+ /** @description Relative path starting with / */
1834
+ path: string;
1835
+ userAgent?: string;
1836
+ };
1837
+ };
1838
+ };
1839
+ responses: {
1840
+ /** @description Recorded */
1841
+ 200: {
1842
+ headers: {
1843
+ [name: string]: unknown;
1844
+ };
1845
+ content: {
1846
+ "application/json": Record<string, never>;
1847
+ };
1848
+ };
1849
+ 400: components["responses"]["Error400"];
1850
+ 401: components["responses"]["Error401"];
1851
+ 403: components["responses"]["Error403"];
1852
+ 404: components["responses"]["Error404"];
1853
+ 429: components["responses"]["Error429"];
1854
+ 503: components["responses"]["Error503"];
1855
+ };
1856
+ };
1857
+ delivery_form_get: {
1858
+ parameters: {
1859
+ query?: {
1860
+ /** @description Locale for the form name, description, question labels, hints, choice labels, submit button and success message. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. Field and choice ids are locale-independent, so submissions are unaffected. */
1861
+ locale?: string;
1862
+ };
1863
+ header?: never;
1864
+ path: {
1865
+ id: string;
1866
+ };
1867
+ cookie?: never;
1868
+ };
1869
+ requestBody?: never;
1870
+ responses: {
1871
+ /** @description OK */
1872
+ 200: {
1873
+ headers: {
1874
+ [name: string]: unknown;
1875
+ };
1876
+ content: {
1877
+ "application/json": {
1878
+ form: {
1879
+ [key: string]: unknown;
1880
+ };
1881
+ };
1882
+ };
1883
+ };
1884
+ 400: components["responses"]["Error400"];
1885
+ 404: components["responses"]["Error404"];
1886
+ 429: components["responses"]["Error429"];
1887
+ 503: components["responses"]["Error503"];
1888
+ };
1889
+ };
1890
+ delivery_form_challenge: {
1891
+ parameters: {
1892
+ query?: never;
1893
+ header?: never;
1894
+ path: {
1895
+ id: string;
1896
+ };
1897
+ cookie?: never;
1898
+ };
1899
+ requestBody?: never;
1900
+ responses: {
1901
+ /** @description OK */
1902
+ 200: {
1903
+ headers: {
1904
+ [name: string]: unknown;
1905
+ };
1906
+ content: {
1907
+ "application/json": {
1908
+ /** @enum {string} */
1909
+ provider: "kanorio" | "turnstile" | "recaptcha" | "hcaptcha";
1910
+ /** @enum {string} */
1911
+ entry: "forms" | "customer_login";
1912
+ /** @description Built-in proof-of-work challenge (provider kanorio only). */
1913
+ altcha?: {
1914
+ algorithm: string;
1915
+ challenge: string;
1916
+ maxnumber?: number;
1917
+ salt: string;
1918
+ signature: string;
1919
+ };
1920
+ /** @description Widget site key (third-party providers). */
1921
+ siteKey?: string;
1922
+ /** @description Pass this as the widget action; the server checks it. */
1923
+ action?: string;
1924
+ /** @description Turnstile cData to pass to the widget; null for other providers. */
1925
+ cData?: string | null;
1926
+ /** @enum {string|null} */
1927
+ recaptchaVersion?: "v2" | "v3" | null;
1928
+ /** @description When true, show the check to the visitor instead of running it silently (the site is seeing unusual sign-in volume). */
1929
+ visible?: boolean;
1930
+ /** @description Forms with a third-party provider only: send this as _tk (with _ctx set to the form id) when requesting file upload tickets. The widget token is single-use, so it is checked on submit instead. */
1931
+ uploadToken?: string;
1932
+ };
1933
+ };
1934
+ };
1935
+ 400: components["responses"]["Error400"];
1936
+ 404: components["responses"]["Error404"];
1937
+ 429: components["responses"]["Error429"];
1938
+ 503: components["responses"]["Error503"];
1939
+ };
1940
+ };
1941
+ delivery_form_upload_request: {
1942
+ parameters: {
1943
+ query?: never;
1944
+ header?: never;
1945
+ path: {
1946
+ id: string;
1947
+ };
1948
+ cookie?: never;
1949
+ };
1950
+ requestBody: {
1951
+ content: {
1952
+ "application/json": {
1953
+ fieldId: string;
1954
+ fileName: string;
1955
+ mimeType: string;
1956
+ fileSize: number;
1957
+ /** @description Honeypot. Send an empty string; any value marks the request as automated. */
1958
+ _hp?: string;
1959
+ /** @description Second honeypot. Send an empty string. */
1960
+ _wp?: string;
1961
+ /** @description Third honeypot. Send an empty string. */
1962
+ _co?: string;
1963
+ /** @description When the form was rendered, in Unix milliseconds. */
1964
+ _ts?: number;
1965
+ /** @description Built-in bot check: the solved ALTCHA payload for the challenge (provider kanorio). */
1966
+ _tk?: string;
1967
+ /** @description What the built-in challenge was issued for: the form id, or customer-login:{siteId}. */
1968
+ _ctx?: string;
1969
+ /** @description Third-party bot check: the token from the provider's widget (provider turnstile, recaptcha or hcaptcha). */
1970
+ captchaToken?: string;
1971
+ };
1972
+ };
1973
+ };
1974
+ responses: {
1975
+ /** @description Upload ticket: PUT the file to uploadUrl with the given headers, then send uploadId as the field's answer */
1976
+ 200: {
1977
+ headers: {
1978
+ [name: string]: unknown;
1979
+ };
1980
+ content: {
1981
+ "application/json": {
1982
+ uploadId: string;
1983
+ uploadUrl: string;
1984
+ headers?: {
1985
+ [key: string]: string;
1986
+ };
1987
+ expiresIn: number;
1988
+ };
1989
+ };
1990
+ };
1991
+ 400: components["responses"]["Error400"];
1992
+ 401: components["responses"]["Error401"];
1993
+ 403: components["responses"]["Error403"];
1994
+ 404: components["responses"]["Error404"];
1995
+ 413: components["responses"]["Error413"];
1996
+ 429: components["responses"]["Error429"];
1997
+ 503: components["responses"]["Error503"];
1998
+ };
1999
+ };
2000
+ delivery_form_tax_id_lookup: {
2001
+ parameters: {
2002
+ query?: never;
2003
+ header?: never;
2004
+ path: {
2005
+ id: string;
2006
+ };
2007
+ cookie?: never;
2008
+ };
2009
+ requestBody: {
2010
+ content: {
2011
+ "application/json": {
2012
+ /** @description Id of the tax_id question. */
2013
+ fieldId: string;
2014
+ /** @description ISO 3166-1 alpha-2 country of the tax ID. */
2015
+ country: string;
2016
+ /** @description Tax ID type (tw_vat, hk_br, jp_trn, kr_brn, eu_vat, ...). Defaults to the country's first type. */
2017
+ type?: string;
2018
+ /** @description The tax ID as typed; full-width digits and separators are normalised. */
2019
+ value: string;
2020
+ /** @description Honeypot. Send an empty string; any value marks the request as automated. */
2021
+ _hp?: string;
2022
+ /** @description Second honeypot. Send an empty string. */
2023
+ _wp?: string;
2024
+ /** @description Third honeypot. Send an empty string. */
2025
+ _co?: string;
2026
+ /** @description When the form was rendered, in Unix milliseconds. */
2027
+ _ts?: number;
2028
+ /** @description Built-in bot check: the solved ALTCHA payload for the challenge (provider kanorio). */
2029
+ _tk?: string;
2030
+ /** @description What the built-in challenge was issued for: the form id, or customer-login:{siteId}. */
2031
+ _ctx?: string;
2032
+ /** @description Third-party bot check: the token from the provider's widget (provider turnstile, recaptcha or hcaptcha). */
2033
+ captchaToken?: string;
2034
+ };
2035
+ };
2036
+ };
2037
+ responses: {
2038
+ /** @description The lookup outcome. Every status is a normal outcome; only VERIFIED carries registry data. Show nothing to the visitor for the others */
2039
+ 200: {
2040
+ headers: {
2041
+ [name: string]: unknown;
2042
+ };
2043
+ content: {
2044
+ "application/json": {
2045
+ /**
2046
+ * @description VERIFIED: the registry has this number (see registry). NOT_FOUND: no public record was found, which does not mean the number is invalid. VALID_FORMAT: the format is correct and this type has no registry to check. UNAVAILABLE: no lookup was done (see reason).
2047
+ * @enum {string}
2048
+ */
2049
+ status: "VERIFIED" | "NOT_FOUND" | "VALID_FORMAT" | "UNAVAILABLE";
2050
+ /**
2051
+ * @description Present when status is UNAVAILABLE. invalid_tax_id: format or check digit is wrong; unavailable: the form has no such tax_id question, is not open, verification failed or the registry is not reachable; rate_limited: too many lookups.
2052
+ * @enum {string}
2053
+ */
2054
+ reason?: "invalid_tax_id" | "unavailable" | "rate_limited";
2055
+ country?: string;
2056
+ type?: string;
2057
+ /** @description The tax ID in normalised form. */
2058
+ normalized?: string;
2059
+ /** @description Present when status is VERIFIED. */
2060
+ registry?: {
2061
+ name: string;
2062
+ address?: string;
2063
+ /** @description ACTIVE, SUSPENDED, CLOSED or UNKNOWN. UNKNOWN means the source did not say; do not treat it as active. */
2064
+ registryStatus: string;
2065
+ /** @description The name contains characters most fonts cannot display; do not prefill it. */
2066
+ nameHasPrivateUse?: boolean;
2067
+ };
2068
+ /** @description Source of the registry data. Open government data requires showing the provider next to the data. */
2069
+ attribution?: {
2070
+ provider?: string;
2071
+ providerEn?: string;
2072
+ license?: string;
2073
+ licenseUrl?: string;
2074
+ dataDate?: string;
2075
+ };
2076
+ };
2077
+ };
2078
+ };
2079
+ 400: components["responses"]["Error400"];
2080
+ 401: components["responses"]["Error401"];
2081
+ 403: components["responses"]["Error403"];
2082
+ 404: components["responses"]["Error404"];
2083
+ 429: components["responses"]["Error429"];
2084
+ 503: components["responses"]["Error503"];
2085
+ };
2086
+ };
2087
+ delivery_form_submit: {
2088
+ parameters: {
2089
+ query?: never;
2090
+ header?: never;
2091
+ path: {
2092
+ id: string;
2093
+ };
2094
+ cookie?: never;
2095
+ };
2096
+ requestBody: {
2097
+ content: {
2098
+ "application/json": {
2099
+ /** @description Answers keyed by question id (from GET /forms/{id}). Values for the form's hidden fields (`settings.hiddenFields[].id`) go here too, as strings; keys the form does not declare are dropped. */
2100
+ answers: {
2101
+ [key: string]: unknown;
2102
+ };
2103
+ /** @description Where this visit came from, for the submission record. Only the listed keys are kept, and values are cleaned. */
2104
+ attribution?: {
2105
+ /** @description utm_source, utm_medium, utm_campaign, utm_content, utm_term, gclid, fbclid, oppref. */
2106
+ utm?: {
2107
+ [key: string]: string;
2108
+ };
2109
+ /** @description Host name of the external referrer. */
2110
+ referrerHost?: string;
2111
+ /** @description Path of the first page of the visit. */
2112
+ landingPath?: string;
2113
+ };
2114
+ /**
2115
+ * @description How the visitor agreed: ticked the consent box, or submitted under a consent statement. Omit when the form asks for no consent.
2116
+ * @enum {string}
2117
+ */
2118
+ consent?: "checked" | "submit_statement";
2119
+ /** @description Id of the consent text the visitor saw (from GET /forms/{id}). */
2120
+ consentTextId?: string;
2121
+ locale?: string;
2122
+ /** @description Path of the page the form was on, for the submission record. */
2123
+ pagePath?: string;
2124
+ /** @description Honeypot. Send an empty string; any value marks the request as automated. */
2125
+ _hp?: string;
2126
+ /** @description Second honeypot. Send an empty string. */
2127
+ _wp?: string;
2128
+ /** @description Third honeypot. Send an empty string. */
2129
+ _co?: string;
2130
+ /** @description When the form was rendered, in Unix milliseconds. */
2131
+ _ts?: number;
2132
+ /** @description Built-in bot check: the solved ALTCHA payload for the challenge (provider kanorio). */
2133
+ _tk?: string;
2134
+ /** @description What the built-in challenge was issued for: the form id, or customer-login:{siteId}. */
2135
+ _ctx?: string;
2136
+ /** @description Third-party bot check: the token from the provider's widget (provider turnstile, recaptcha or hcaptcha). */
2137
+ captchaToken?: string;
2138
+ };
2139
+ };
2140
+ };
2141
+ responses: {
2142
+ /** @description OK */
2143
+ 200: {
2144
+ headers: {
2145
+ [name: string]: unknown;
2146
+ };
2147
+ content: {
2148
+ "application/json": {
2149
+ /** @enum {string} */
2150
+ state?: "closed" | "not_open" | "full";
2151
+ };
2152
+ };
2153
+ };
2154
+ 400: components["responses"]["Error400"];
2155
+ 401: components["responses"]["Error401"];
2156
+ 403: components["responses"]["Error403"];
2157
+ 404: components["responses"]["Error404"];
2158
+ 409: components["responses"]["Error409"];
2159
+ 413: components["responses"]["Error413"];
2160
+ 429: components["responses"]["Error429"];
2161
+ 503: components["responses"]["Error503"];
2162
+ };
2163
+ };
2164
+ delivery_search: {
2165
+ parameters: {
2166
+ query: {
2167
+ q: string;
2168
+ kind?: string;
2169
+ /** @description Maximum number of results, 1-20. Defaults to 20. */
2170
+ limit?: number;
2171
+ /** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
2172
+ cursor?: string;
2173
+ /** @description Locale to search. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Titles, excerpts, snippets and `url` (with the locale's URL prefix) come from that locale's published translations; untranslated text stays in the primary locale. `resolvedLocale` in the response is the locale actually searched. A cursor only works with the same locale. */
2174
+ locale?: string;
2175
+ /** @description true adds total (the number of matching results across all pages) to the response, for a results count such as "12 results". It is counted in the same query as the results, so it adds no extra request. */
2176
+ total?: boolean;
2177
+ };
2178
+ header?: never;
2179
+ path?: never;
2180
+ cookie?: never;
2181
+ };
2182
+ requestBody?: never;
2183
+ responses: {
2184
+ /** @description OK */
2185
+ 200: {
2186
+ headers: {
2187
+ [name: string]: unknown;
2188
+ };
2189
+ content: {
2190
+ "application/json": {
2191
+ data: {
2192
+ [key: string]: unknown;
2193
+ }[];
2194
+ /** @description True when another page exists; pass nextCursor to fetch it. */
2195
+ hasMore: boolean;
2196
+ /** @description Cursor for the next page, or null on the last page. */
2197
+ nextCursor: string | null;
2198
+ q: string;
2199
+ tokens: string[];
2200
+ /** @description Locale actually searched: the requested locale when it is one of the site's published locales, otherwise the primary locale. */
2201
+ resolvedLocale?: string;
2202
+ /** @description Number of matching results across all pages. Present only when total=true. */
2203
+ total?: number;
2204
+ };
2205
+ };
2206
+ };
2207
+ 400: components["responses"]["Error400"];
2208
+ 404: components["responses"]["Error404"];
2209
+ 429: components["responses"]["Error429"];
2210
+ 503: components["responses"]["Error503"];
2211
+ };
2212
+ };
2213
+ delivery_products_list: {
2214
+ parameters: {
2215
+ query?: {
2216
+ /** @description Maximum number of items to return, 1-100. Defaults to 20. */
2217
+ limit?: number;
2218
+ /** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
2219
+ cursor?: string;
2220
+ category?: string;
2221
+ /** @description Author/instructor slug (system collection authors). Returns only products linked to an active deliverable this person teaches; use it to list a person's courses on an instructor page. */
2222
+ author?: string;
2223
+ /** @description Locale for product names, descriptions, options and the category record, and for promotion badge text. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. */
2224
+ locale?: string;
2225
+ };
2226
+ header?: never;
2227
+ path?: never;
2228
+ cookie?: never;
2229
+ };
2230
+ requestBody?: never;
2231
+ responses: {
2232
+ /** @description OK */
2233
+ 200: {
2234
+ headers: {
2235
+ [name: string]: unknown;
2236
+ };
2237
+ content: {
2238
+ "application/json": {
2239
+ data: components["schemas"]["Product"][];
2240
+ /** @description True when another page exists; pass nextCursor to fetch it. */
2241
+ hasMore: boolean;
2242
+ /** @description Cursor for the next page, or null on the last page. */
2243
+ nextCursor: string | null;
2244
+ };
2245
+ };
2246
+ };
2247
+ 400: components["responses"]["Error400"];
2248
+ 404: components["responses"]["Error404"];
2249
+ 429: components["responses"]["Error429"];
2250
+ 503: components["responses"]["Error503"];
2251
+ };
2252
+ };
2253
+ delivery_products_get: {
2254
+ parameters: {
2255
+ query?: {
2256
+ /** @description Locale for the product name, description, SEO fields, options and deliverable outline, and for promotion badge text. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Untranslated fields fall back to the primary locale. On multilingual sites the product carries resolvedLocale and availableLocales. */
2257
+ locale?: string;
2258
+ };
2259
+ header?: never;
2260
+ path: {
2261
+ slug: string;
2262
+ };
2263
+ cookie?: never;
2264
+ };
2265
+ requestBody?: never;
2266
+ responses: {
2267
+ /** @description OK */
2268
+ 200: {
2269
+ headers: {
2270
+ [name: string]: unknown;
2271
+ };
2272
+ content: {
2273
+ "application/json": {
2274
+ product: components["schemas"]["Product"];
2275
+ };
2276
+ };
2277
+ };
2278
+ 400: components["responses"]["Error400"];
2279
+ 404: components["responses"]["Error404"];
2280
+ 429: components["responses"]["Error429"];
2281
+ 503: components["responses"]["Error503"];
2282
+ };
2283
+ };
2284
+ delivery_units_open_preview: {
2285
+ parameters: {
2286
+ query?: never;
2287
+ header?: never;
2288
+ path: {
2289
+ id: string;
2290
+ };
2291
+ cookie?: never;
2292
+ };
2293
+ requestBody?: {
2294
+ content: {
2295
+ "application/json": {
2296
+ /**
2297
+ * @default read
2298
+ * @enum {string}
2299
+ */
2300
+ mode?: "read" | "download";
2301
+ };
2302
+ };
2303
+ };
2304
+ responses: {
2305
+ /** @description Signed URL */
2306
+ 200: {
2307
+ headers: {
2308
+ [name: string]: unknown;
2309
+ };
2310
+ content: {
2311
+ "application/json": components["schemas"]["OpenUnitResponse"];
2312
+ };
2313
+ };
2314
+ 400: components["responses"]["Error400"];
2315
+ 401: components["responses"]["Error401"];
2316
+ 403: components["responses"]["Error403"];
2317
+ 404: components["responses"]["Error404"];
2318
+ 429: components["responses"]["Error429"];
2319
+ 503: components["responses"]["Error503"];
2320
+ };
2321
+ };
2322
+ delivery_reviews_list: {
2323
+ parameters: {
2324
+ query: {
2325
+ /** @description product:<id> */
2326
+ target: string;
2327
+ /** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
2328
+ cursor?: string;
2329
+ /** @description Maximum number of items to return, 1-100. Defaults to 20. */
2330
+ limit?: number;
2331
+ };
2332
+ header?: never;
2333
+ path?: never;
2334
+ cookie?: never;
2335
+ };
2336
+ requestBody?: never;
2337
+ responses: {
2338
+ /** @description OK */
2339
+ 200: {
2340
+ headers: {
2341
+ [name: string]: unknown;
2342
+ };
2343
+ content: {
2344
+ "application/json": components["schemas"]["ReviewList"];
2345
+ };
2346
+ };
2347
+ 400: components["responses"]["Error400"];
2348
+ 404: components["responses"]["Error404"];
2349
+ 429: components["responses"]["Error429"];
2350
+ 503: components["responses"]["Error503"];
2351
+ };
2352
+ };
2353
+ delivery_reviews_summary: {
2354
+ parameters: {
2355
+ query: {
2356
+ /** @description product:<id> */
2357
+ target: string;
2358
+ };
2359
+ header?: never;
2360
+ path?: never;
2361
+ cookie?: never;
2362
+ };
2363
+ requestBody?: never;
2364
+ responses: {
2365
+ /** @description OK */
2366
+ 200: {
2367
+ headers: {
2368
+ [name: string]: unknown;
2369
+ };
2370
+ content: {
2371
+ "application/json": components["schemas"]["ReviewSummary"];
2372
+ };
2373
+ };
2374
+ 400: components["responses"]["Error400"];
2375
+ 404: components["responses"]["Error404"];
2376
+ 429: components["responses"]["Error429"];
2377
+ 503: components["responses"]["Error503"];
2378
+ };
2379
+ };
2380
+ }