@wix/auto_sdk_online-programs_programs 1.0.42 → 1.0.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +29 -3
- package/build/cjs/index.js +228 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +204 -8
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +465 -232
- package/build/cjs/meta.js +135 -8
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/{online-programs-v3-program-programs.universal-CXWw_Yap.d.ts → online-programs-v3-program-programs.universal-BIitHGTm.d.ts} +591 -236
- package/build/es/index.d.mts +29 -3
- package/build/es/index.mjs +225 -8
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +201 -8
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +465 -232
- package/build/es/meta.mjs +132 -8
- package/build/es/meta.mjs.map +1 -1
- package/build/es/{online-programs-v3-program-programs.universal-CXWw_Yap.d.mts → online-programs-v3-program-programs.universal-BIitHGTm.d.mts} +591 -236
- package/build/internal/cjs/index.d.ts +29 -3
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +527 -294
- package/build/internal/cjs/{online-programs-v3-program-programs.universal-C2QeyOXB.d.ts → online-programs-v3-program-programs.universal-CYvJsYoR.d.ts} +595 -240
- package/build/internal/es/index.d.mts +29 -3
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +527 -294
- package/build/internal/es/{online-programs-v3-program-programs.universal-C2QeyOXB.d.mts → online-programs-v3-program-programs.universal-CYvJsYoR.d.mts} +595 -240
- package/package.json +4 -4
|
@@ -295,73 +295,117 @@ interface Seo {
|
|
|
295
295
|
courseWorkload?: string;
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
|
-
* The SEO
|
|
299
|
-
*
|
|
300
|
-
*
|
|
298
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
299
|
+
*
|
|
300
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
301
|
+
* field set must never change (see the file header). New writers use
|
|
302
|
+
* `SeoSchemaV2`.
|
|
303
|
+
*
|
|
304
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
305
|
+
* visible on the page itself. They override every other source of tags
|
|
306
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
301
307
|
*/
|
|
302
308
|
interface SeoSchema {
|
|
303
|
-
/**
|
|
309
|
+
/**
|
|
310
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
311
|
+
* decided by the renderer, not by position in this list.
|
|
312
|
+
*
|
|
313
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
314
|
+
* a bound added now could reject a page that is already stored.
|
|
315
|
+
*/
|
|
304
316
|
tags?: Tag[];
|
|
305
|
-
/** SEO
|
|
317
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
306
318
|
settings?: Settings;
|
|
307
319
|
}
|
|
320
|
+
/** A keyword term the user is targeting. */
|
|
308
321
|
interface Keyword {
|
|
309
|
-
/**
|
|
322
|
+
/**
|
|
323
|
+
* The term itself, e.g. "trail running shoes".
|
|
324
|
+
*
|
|
325
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
326
|
+
* already stored, and a bound added now could reject a record written
|
|
327
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
328
|
+
* on this field is accepted deliberately.
|
|
329
|
+
*/
|
|
310
330
|
term?: string;
|
|
311
|
-
/** Whether
|
|
331
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
312
332
|
isMain?: boolean;
|
|
313
333
|
/**
|
|
314
|
-
*
|
|
334
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
335
|
+
* attribution in BI. Opaque to the renderer.
|
|
315
336
|
* @maxLength 1000
|
|
316
337
|
*/
|
|
317
338
|
origin?: string | null;
|
|
318
339
|
}
|
|
340
|
+
/**
|
|
341
|
+
* One tag in the page's <head>.
|
|
342
|
+
*
|
|
343
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
344
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
345
|
+
* normalizes both shapes on READ.
|
|
346
|
+
*/
|
|
319
347
|
interface Tag {
|
|
320
348
|
/**
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
349
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
350
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
351
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
325
352
|
*
|
|
326
|
-
* Which of these an API actually accepts depends on where the tag is being
|
|
327
|
-
* list is not a blanket guarantee across every API that reuses
|
|
328
|
-
* Tags in particular accepts only `meta` (see
|
|
329
|
-
* `title`/`script`/`link` with a validation
|
|
330
|
-
*
|
|
331
|
-
*
|
|
353
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
354
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
355
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
356
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
357
|
+
* error even though they appear here — check the field description of the
|
|
358
|
+
* specific `tags`-typed field you are writing to.
|
|
332
359
|
*
|
|
333
360
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
334
|
-
*
|
|
335
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
336
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
337
|
-
* write through the site's Advanced/Custom Tags
|
|
338
|
-
* omit `custom` (or set it to `false`).
|
|
361
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
362
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
363
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
364
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
365
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
366
|
+
*
|
|
367
|
+
* No length limit: this field holds data written years ago by writers we
|
|
368
|
+
* are not migrating. A constraint here could reject a record that is
|
|
369
|
+
* already stored, which is exactly the promise this design makes.
|
|
339
370
|
*/
|
|
340
371
|
type?: string;
|
|
341
372
|
/**
|
|
342
|
-
*
|
|
343
|
-
*
|
|
373
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
374
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
344
375
|
*/
|
|
345
376
|
props?: Record<string, any> | null;
|
|
346
|
-
/**
|
|
377
|
+
/**
|
|
378
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
379
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
380
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
381
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
382
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
383
|
+
* page. See the design log for the full key-by-key mapping.
|
|
384
|
+
*/
|
|
347
385
|
meta?: Record<string, any> | null;
|
|
348
|
-
/**
|
|
386
|
+
/**
|
|
387
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
388
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
389
|
+
* `StructuredDataTag.json_ld`.
|
|
390
|
+
* No length limit, for the same reason as `type` above.
|
|
391
|
+
*/
|
|
349
392
|
children?: string;
|
|
350
393
|
/**
|
|
351
394
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
352
395
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
353
396
|
*
|
|
354
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
355
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
356
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
357
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
358
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
397
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
398
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
399
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
400
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
401
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
359
402
|
*
|
|
360
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
361
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
362
|
-
* for site-wide structured data) unconditionally.
|
|
363
|
-
* site-wide, every-page structured data
|
|
364
|
-
* `script` tag through the Item
|
|
403
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
404
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
405
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
406
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
407
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
408
|
+
* SEO Tags API instead.
|
|
365
409
|
*
|
|
366
410
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
367
411
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -374,22 +418,39 @@ interface Tag {
|
|
|
374
418
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
375
419
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
376
420
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
421
|
+
*
|
|
422
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
377
423
|
*/
|
|
378
424
|
custom?: boolean;
|
|
379
|
-
/**
|
|
425
|
+
/**
|
|
426
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
427
|
+
*
|
|
428
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
429
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
430
|
+
*/
|
|
380
431
|
disabled?: boolean;
|
|
381
432
|
}
|
|
433
|
+
/** Page-level SEO settings that are not tags. */
|
|
382
434
|
interface Settings {
|
|
383
435
|
/**
|
|
384
|
-
* Whether the
|
|
436
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
437
|
+
* its current one after a slug change.
|
|
385
438
|
*
|
|
386
|
-
*
|
|
387
|
-
*
|
|
439
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
440
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
441
|
+
* renaming a stored boolean is not worth the migration.
|
|
388
442
|
*/
|
|
389
443
|
preventAutoRedirect?: boolean;
|
|
390
444
|
/**
|
|
391
|
-
*
|
|
392
|
-
*
|
|
445
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
446
|
+
* assistant and checklist; never rendered into <head>.
|
|
447
|
+
*
|
|
448
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
449
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
450
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
451
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
452
|
+
* something absurd.
|
|
453
|
+
* @maxSize 20
|
|
393
454
|
*/
|
|
394
455
|
keywords?: Keyword[];
|
|
395
456
|
}
|
|
@@ -464,7 +525,371 @@ interface FreemiumSettings {
|
|
|
464
525
|
* @internal
|
|
465
526
|
* @readonly
|
|
466
527
|
*/
|
|
467
|
-
enabled?: boolean;
|
|
528
|
+
enabled?: boolean;
|
|
529
|
+
}
|
|
530
|
+
/** Triggered when a program is published. */
|
|
531
|
+
interface ProgramPublished {
|
|
532
|
+
/** Snapshot of the program after it was published. */
|
|
533
|
+
program?: Program;
|
|
534
|
+
}
|
|
535
|
+
/** Triggered when a program ends, either automatically or manually by the owner. */
|
|
536
|
+
interface ProgramEnded {
|
|
537
|
+
/** Whether the program was ended manually by the owner. */
|
|
538
|
+
endedByOwner?: boolean;
|
|
539
|
+
/** Snapshot of the program after it ended. */
|
|
540
|
+
program?: Program;
|
|
541
|
+
}
|
|
542
|
+
/** Triggered when a program is archived. */
|
|
543
|
+
interface ProgramArchived {
|
|
544
|
+
/** Snapshot of the program after it was archived. */
|
|
545
|
+
program?: Program;
|
|
546
|
+
}
|
|
547
|
+
/** Triggered when a program is duplicated. */
|
|
548
|
+
interface ProgramDuplicated {
|
|
549
|
+
/** Newly created program. */
|
|
550
|
+
program?: Program;
|
|
551
|
+
/** Program that was duplicated. */
|
|
552
|
+
duplicatedFrom?: Program;
|
|
553
|
+
/** Whether the program was cloned from a template. */
|
|
554
|
+
fromTemplate?: boolean;
|
|
555
|
+
}
|
|
556
|
+
/** Triggered when a program's Freemium setting changes to enabled. */
|
|
557
|
+
interface ProgramFreemiumEnabled {
|
|
558
|
+
/**
|
|
559
|
+
* Snapshot of the program after the mode change committed.
|
|
560
|
+
* @internal
|
|
561
|
+
*/
|
|
562
|
+
program?: Program;
|
|
563
|
+
}
|
|
564
|
+
/** Triggered when a program's Freemium setting changes to disabled. */
|
|
565
|
+
interface ProgramFreemiumDisabled {
|
|
566
|
+
/**
|
|
567
|
+
* Snapshot of the program after the mode change committed.
|
|
568
|
+
* @internal
|
|
569
|
+
*/
|
|
570
|
+
program?: Program;
|
|
571
|
+
}
|
|
572
|
+
interface GetPageRequest {
|
|
573
|
+
/**
|
|
574
|
+
* The site's assigned router prefix, including the leading slash.
|
|
575
|
+
* @maxLength 512
|
|
576
|
+
*/
|
|
577
|
+
routerPrefix?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
580
|
+
* @maxLength 4096
|
|
581
|
+
*/
|
|
582
|
+
routerSuffix?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Absolute site URL, including the site base path and requested route.
|
|
585
|
+
* @format WEB_URL
|
|
586
|
+
*/
|
|
587
|
+
fullUrl?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Maps router roles to site-specific installed pages.
|
|
590
|
+
* @maxSize 20
|
|
591
|
+
*/
|
|
592
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
593
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
594
|
+
config?: Record<string, any> | null;
|
|
595
|
+
/** Rendering information; it is not an authorization claim. */
|
|
596
|
+
requestInfo?: Record<string, any> | null;
|
|
597
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
598
|
+
roleVariations?: Record<string, any> | null;
|
|
599
|
+
/**
|
|
600
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
601
|
+
* @maxLength 255
|
|
602
|
+
*/
|
|
603
|
+
dynamicPageIdOverride?: string;
|
|
604
|
+
}
|
|
605
|
+
interface ProgramRouterPageRole {
|
|
606
|
+
/**
|
|
607
|
+
* Site-specific installed page ID.
|
|
608
|
+
* @maxLength 255
|
|
609
|
+
*/
|
|
610
|
+
_id?: string;
|
|
611
|
+
/**
|
|
612
|
+
* Display title of the connected page.
|
|
613
|
+
* @maxLength 1000
|
|
614
|
+
*/
|
|
615
|
+
title?: string;
|
|
616
|
+
}
|
|
617
|
+
interface GetPageResponse {
|
|
618
|
+
/** Page result consumed by the Viewer. Router status is inside this envelope. */
|
|
619
|
+
result?: ProgramRouterPageResult;
|
|
620
|
+
}
|
|
621
|
+
interface ProgramRouterPageResult {
|
|
622
|
+
/**
|
|
623
|
+
* Site response status, such as 200 for a page or 404 for a missing route.
|
|
624
|
+
* @min 100
|
|
625
|
+
* @max 599
|
|
626
|
+
*/
|
|
627
|
+
status?: number;
|
|
628
|
+
/**
|
|
629
|
+
* Site-specific installed page ID selected from the request's page roles.
|
|
630
|
+
* @maxLength 255
|
|
631
|
+
*/
|
|
632
|
+
page?: string;
|
|
633
|
+
/** Minimal program identity and selection; it never contains private content. */
|
|
634
|
+
publicData?: ProgramRouterData;
|
|
635
|
+
/** Platform-supported page head metadata. */
|
|
636
|
+
head?: Record<string, any> | null;
|
|
637
|
+
/**
|
|
638
|
+
* Safe routing-error description without private program content.
|
|
639
|
+
* @maxLength 1000
|
|
640
|
+
*/
|
|
641
|
+
message?: string;
|
|
642
|
+
}
|
|
643
|
+
interface ProgramRouterData extends ProgramRouterDataSelectionOneOf {
|
|
644
|
+
/**
|
|
645
|
+
* Selected step after verifying that it belongs to the program.
|
|
646
|
+
* @format GUID
|
|
647
|
+
*/
|
|
648
|
+
stepId?: string;
|
|
649
|
+
/** Whether the program description was requested. */
|
|
650
|
+
description?: boolean;
|
|
651
|
+
/**
|
|
652
|
+
* Stable program identity resolved within the authenticated site.
|
|
653
|
+
* @format GUID
|
|
654
|
+
*/
|
|
655
|
+
programId?: string;
|
|
656
|
+
}
|
|
657
|
+
/** @oneof */
|
|
658
|
+
interface ProgramRouterDataSelectionOneOf {
|
|
659
|
+
/**
|
|
660
|
+
* Selected step after verifying that it belongs to the program.
|
|
661
|
+
* @format GUID
|
|
662
|
+
*/
|
|
663
|
+
stepId?: string;
|
|
664
|
+
/** Whether the program description was requested. */
|
|
665
|
+
description?: boolean;
|
|
666
|
+
}
|
|
667
|
+
interface GetSitemapRequest {
|
|
668
|
+
/**
|
|
669
|
+
* The site's assigned router prefix, including the leading slash.
|
|
670
|
+
* @maxLength 512
|
|
671
|
+
*/
|
|
672
|
+
routerPrefix?: string;
|
|
673
|
+
/**
|
|
674
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
675
|
+
* @maxLength 4096
|
|
676
|
+
*/
|
|
677
|
+
routerSuffix?: string;
|
|
678
|
+
/**
|
|
679
|
+
* Absolute site URL, including the site base path and requested route.
|
|
680
|
+
* @format WEB_URL
|
|
681
|
+
*/
|
|
682
|
+
fullUrl?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Maps router roles to site-specific installed pages.
|
|
685
|
+
* @maxSize 20
|
|
686
|
+
*/
|
|
687
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
688
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
689
|
+
config?: Record<string, any> | null;
|
|
690
|
+
/** Rendering information; it is not an authorization claim. */
|
|
691
|
+
requestInfo?: Record<string, any> | null;
|
|
692
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
693
|
+
roleVariations?: Record<string, any> | null;
|
|
694
|
+
/**
|
|
695
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
696
|
+
* @maxLength 255
|
|
697
|
+
*/
|
|
698
|
+
dynamicPageIdOverride?: string;
|
|
699
|
+
}
|
|
700
|
+
interface GetSitemapResponse {
|
|
701
|
+
/** Connected Builder routes, including an explicit empty array when no routes are visible. */
|
|
702
|
+
result?: any;
|
|
703
|
+
}
|
|
704
|
+
interface GetSitemapCountRequest {
|
|
705
|
+
/**
|
|
706
|
+
* The site's assigned router prefix, including the leading slash.
|
|
707
|
+
* @maxLength 512
|
|
708
|
+
*/
|
|
709
|
+
routerPrefix?: string;
|
|
710
|
+
/**
|
|
711
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
712
|
+
* @maxLength 4096
|
|
713
|
+
*/
|
|
714
|
+
routerSuffix?: string;
|
|
715
|
+
/**
|
|
716
|
+
* Absolute site URL, including the site base path and requested route.
|
|
717
|
+
* @format WEB_URL
|
|
718
|
+
*/
|
|
719
|
+
fullUrl?: string;
|
|
720
|
+
/**
|
|
721
|
+
* Maps router roles to site-specific installed pages.
|
|
722
|
+
* @maxSize 20
|
|
723
|
+
*/
|
|
724
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
725
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
726
|
+
config?: Record<string, any> | null;
|
|
727
|
+
/** Rendering information; it is not an authorization claim. */
|
|
728
|
+
requestInfo?: Record<string, any> | null;
|
|
729
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
730
|
+
roleVariations?: Record<string, any> | null;
|
|
731
|
+
/**
|
|
732
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
733
|
+
* @maxLength 255
|
|
734
|
+
*/
|
|
735
|
+
dynamicPageIdOverride?: string;
|
|
736
|
+
}
|
|
737
|
+
interface GetSitemapCountResponse {
|
|
738
|
+
/** Per-page route counts, including explicit numeric zeroes and an explicit empty array. */
|
|
739
|
+
result?: any;
|
|
740
|
+
}
|
|
741
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
742
|
+
createdEvent?: EntityCreatedEvent;
|
|
743
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
744
|
+
deletedEvent?: EntityDeletedEvent;
|
|
745
|
+
actionEvent?: ActionEvent;
|
|
746
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
747
|
+
_id?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
750
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
751
|
+
*/
|
|
752
|
+
entityFqdn?: string;
|
|
753
|
+
/**
|
|
754
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
755
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
756
|
+
*/
|
|
757
|
+
slug?: string;
|
|
758
|
+
/** ID of the entity associated with the event. */
|
|
759
|
+
entityId?: string;
|
|
760
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
761
|
+
eventTime?: Date | null;
|
|
762
|
+
/**
|
|
763
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
764
|
+
* (for example, GDPR).
|
|
765
|
+
*/
|
|
766
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
767
|
+
/** If present, indicates the action that triggered the event. */
|
|
768
|
+
originatedFrom?: string | null;
|
|
769
|
+
/**
|
|
770
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
771
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
772
|
+
*/
|
|
773
|
+
entityEventSequence?: string | null;
|
|
774
|
+
}
|
|
775
|
+
/** @oneof */
|
|
776
|
+
interface DomainEventBodyOneOf {
|
|
777
|
+
createdEvent?: EntityCreatedEvent;
|
|
778
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
779
|
+
deletedEvent?: EntityDeletedEvent;
|
|
780
|
+
actionEvent?: ActionEvent;
|
|
781
|
+
}
|
|
782
|
+
interface EntityCreatedEvent {
|
|
783
|
+
entity?: string;
|
|
784
|
+
}
|
|
785
|
+
interface RestoreInfo {
|
|
786
|
+
deletedDate?: Date | null;
|
|
787
|
+
}
|
|
788
|
+
interface EntityUpdatedEvent {
|
|
789
|
+
/**
|
|
790
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
791
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
792
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
793
|
+
*/
|
|
794
|
+
currentEntity?: string;
|
|
795
|
+
}
|
|
796
|
+
interface EntityDeletedEvent {
|
|
797
|
+
/** Entity that was deleted. */
|
|
798
|
+
deletedEntity?: string | null;
|
|
799
|
+
}
|
|
800
|
+
interface ActionEvent {
|
|
801
|
+
body?: string;
|
|
802
|
+
}
|
|
803
|
+
interface MessageEnvelope {
|
|
804
|
+
/**
|
|
805
|
+
* App instance ID.
|
|
806
|
+
* @format GUID
|
|
807
|
+
*/
|
|
808
|
+
instanceId?: string | null;
|
|
809
|
+
/**
|
|
810
|
+
* Event type.
|
|
811
|
+
* @maxLength 150
|
|
812
|
+
*/
|
|
813
|
+
eventType?: string;
|
|
814
|
+
/** The identification type and identity data. */
|
|
815
|
+
identity?: IdentificationData;
|
|
816
|
+
/** Stringify payload. */
|
|
817
|
+
data?: string;
|
|
818
|
+
/** Details related to the account */
|
|
819
|
+
accountInfo?: AccountInfo;
|
|
820
|
+
}
|
|
821
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
822
|
+
/**
|
|
823
|
+
* ID of a site visitor that has not logged in to the site.
|
|
824
|
+
* @format GUID
|
|
825
|
+
*/
|
|
826
|
+
anonymousVisitorId?: string;
|
|
827
|
+
/**
|
|
828
|
+
* ID of a site visitor that has logged in to the site.
|
|
829
|
+
* @format GUID
|
|
830
|
+
*/
|
|
831
|
+
memberId?: string;
|
|
832
|
+
/**
|
|
833
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
834
|
+
* @format GUID
|
|
835
|
+
*/
|
|
836
|
+
wixUserId?: string;
|
|
837
|
+
/**
|
|
838
|
+
* ID of an app.
|
|
839
|
+
* @format GUID
|
|
840
|
+
*/
|
|
841
|
+
appId?: string;
|
|
842
|
+
/** @readonly */
|
|
843
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
844
|
+
}
|
|
845
|
+
/** @oneof */
|
|
846
|
+
interface IdentificationDataIdOneOf {
|
|
847
|
+
/**
|
|
848
|
+
* ID of a site visitor that has not logged in to the site.
|
|
849
|
+
* @format GUID
|
|
850
|
+
*/
|
|
851
|
+
anonymousVisitorId?: string;
|
|
852
|
+
/**
|
|
853
|
+
* ID of a site visitor that has logged in to the site.
|
|
854
|
+
* @format GUID
|
|
855
|
+
*/
|
|
856
|
+
memberId?: string;
|
|
857
|
+
/**
|
|
858
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
859
|
+
* @format GUID
|
|
860
|
+
*/
|
|
861
|
+
wixUserId?: string;
|
|
862
|
+
/**
|
|
863
|
+
* ID of an app.
|
|
864
|
+
* @format GUID
|
|
865
|
+
*/
|
|
866
|
+
appId?: string;
|
|
867
|
+
}
|
|
868
|
+
declare enum WebhookIdentityType {
|
|
869
|
+
UNKNOWN = "UNKNOWN",
|
|
870
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
871
|
+
MEMBER = "MEMBER",
|
|
872
|
+
WIX_USER = "WIX_USER",
|
|
873
|
+
APP = "APP"
|
|
874
|
+
}
|
|
875
|
+
/** @enumType */
|
|
876
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
877
|
+
interface AccountInfo {
|
|
878
|
+
/**
|
|
879
|
+
* ID of the Wix account associated with the event.
|
|
880
|
+
* @format GUID
|
|
881
|
+
*/
|
|
882
|
+
accountId?: string | null;
|
|
883
|
+
/**
|
|
884
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
885
|
+
* @format GUID
|
|
886
|
+
*/
|
|
887
|
+
parentAccountId?: string | null;
|
|
888
|
+
/**
|
|
889
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
890
|
+
* @format GUID
|
|
891
|
+
*/
|
|
892
|
+
siteId?: string | null;
|
|
468
893
|
}
|
|
469
894
|
interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
|
|
470
895
|
/** insert/update documents */
|
|
@@ -763,48 +1188,6 @@ interface Schema {
|
|
|
763
1188
|
label?: string;
|
|
764
1189
|
clusterName?: string;
|
|
765
1190
|
}
|
|
766
|
-
/** Triggered when a program is published. */
|
|
767
|
-
interface ProgramPublished {
|
|
768
|
-
/** Snapshot of the program after it was published. */
|
|
769
|
-
program?: Program;
|
|
770
|
-
}
|
|
771
|
-
/** Triggered when a program ends, either automatically or manually by the owner. */
|
|
772
|
-
interface ProgramEnded {
|
|
773
|
-
/** Whether the program was ended manually by the owner. */
|
|
774
|
-
endedByOwner?: boolean;
|
|
775
|
-
/** Snapshot of the program after it ended. */
|
|
776
|
-
program?: Program;
|
|
777
|
-
}
|
|
778
|
-
/** Triggered when a program is archived. */
|
|
779
|
-
interface ProgramArchived {
|
|
780
|
-
/** Snapshot of the program after it was archived. */
|
|
781
|
-
program?: Program;
|
|
782
|
-
}
|
|
783
|
-
/** Triggered when a program is duplicated. */
|
|
784
|
-
interface ProgramDuplicated {
|
|
785
|
-
/** Newly created program. */
|
|
786
|
-
program?: Program;
|
|
787
|
-
/** Program that was duplicated. */
|
|
788
|
-
duplicatedFrom?: Program;
|
|
789
|
-
/** Whether the program was cloned from a template. */
|
|
790
|
-
fromTemplate?: boolean;
|
|
791
|
-
}
|
|
792
|
-
/** Triggered when a program's Freemium setting changes to enabled. */
|
|
793
|
-
interface ProgramFreemiumEnabled {
|
|
794
|
-
/**
|
|
795
|
-
* Snapshot of the program after the mode change committed.
|
|
796
|
-
* @internal
|
|
797
|
-
*/
|
|
798
|
-
program?: Program;
|
|
799
|
-
}
|
|
800
|
-
/** Triggered when a program's Freemium setting changes to disabled. */
|
|
801
|
-
interface ProgramFreemiumDisabled {
|
|
802
|
-
/**
|
|
803
|
-
* Snapshot of the program after the mode change committed.
|
|
804
|
-
* @internal
|
|
805
|
-
*/
|
|
806
|
-
program?: Program;
|
|
807
|
-
}
|
|
808
1191
|
interface CreateProgramRequest {
|
|
809
1192
|
/** Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. */
|
|
810
1193
|
program: Program;
|
|
@@ -1736,68 +2119,6 @@ interface LabeledProgram {
|
|
|
1736
2119
|
*/
|
|
1737
2120
|
label?: string;
|
|
1738
2121
|
}
|
|
1739
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1740
|
-
createdEvent?: EntityCreatedEvent;
|
|
1741
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1742
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1743
|
-
actionEvent?: ActionEvent;
|
|
1744
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1745
|
-
_id?: string;
|
|
1746
|
-
/**
|
|
1747
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1748
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1749
|
-
*/
|
|
1750
|
-
entityFqdn?: string;
|
|
1751
|
-
/**
|
|
1752
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1753
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1754
|
-
*/
|
|
1755
|
-
slug?: string;
|
|
1756
|
-
/** ID of the entity associated with the event. */
|
|
1757
|
-
entityId?: string;
|
|
1758
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1759
|
-
eventTime?: Date | null;
|
|
1760
|
-
/**
|
|
1761
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1762
|
-
* (for example, GDPR).
|
|
1763
|
-
*/
|
|
1764
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1765
|
-
/** If present, indicates the action that triggered the event. */
|
|
1766
|
-
originatedFrom?: string | null;
|
|
1767
|
-
/**
|
|
1768
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
1769
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1770
|
-
*/
|
|
1771
|
-
entityEventSequence?: string | null;
|
|
1772
|
-
}
|
|
1773
|
-
/** @oneof */
|
|
1774
|
-
interface DomainEventBodyOneOf {
|
|
1775
|
-
createdEvent?: EntityCreatedEvent;
|
|
1776
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1777
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1778
|
-
actionEvent?: ActionEvent;
|
|
1779
|
-
}
|
|
1780
|
-
interface EntityCreatedEvent {
|
|
1781
|
-
entity?: string;
|
|
1782
|
-
}
|
|
1783
|
-
interface RestoreInfo {
|
|
1784
|
-
deletedDate?: Date | null;
|
|
1785
|
-
}
|
|
1786
|
-
interface EntityUpdatedEvent {
|
|
1787
|
-
/**
|
|
1788
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1789
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1790
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1791
|
-
*/
|
|
1792
|
-
currentEntity?: string;
|
|
1793
|
-
}
|
|
1794
|
-
interface EntityDeletedEvent {
|
|
1795
|
-
/** Entity that was deleted. */
|
|
1796
|
-
deletedEntity?: string | null;
|
|
1797
|
-
}
|
|
1798
|
-
interface ActionEvent {
|
|
1799
|
-
body?: string;
|
|
1800
|
-
}
|
|
1801
2122
|
interface Empty {
|
|
1802
2123
|
}
|
|
1803
2124
|
interface ResolveProgramSlugRequest {
|
|
@@ -2634,97 +2955,6 @@ interface ConsentPolicy {
|
|
|
2634
2955
|
/** CCPA compliance flag. */
|
|
2635
2956
|
dataToThirdParty?: boolean | null;
|
|
2636
2957
|
}
|
|
2637
|
-
interface MessageEnvelope {
|
|
2638
|
-
/**
|
|
2639
|
-
* App instance ID.
|
|
2640
|
-
* @format GUID
|
|
2641
|
-
*/
|
|
2642
|
-
instanceId?: string | null;
|
|
2643
|
-
/**
|
|
2644
|
-
* Event type.
|
|
2645
|
-
* @maxLength 150
|
|
2646
|
-
*/
|
|
2647
|
-
eventType?: string;
|
|
2648
|
-
/** The identification type and identity data. */
|
|
2649
|
-
identity?: IdentificationData;
|
|
2650
|
-
/** Stringify payload. */
|
|
2651
|
-
data?: string;
|
|
2652
|
-
/** Details related to the account */
|
|
2653
|
-
accountInfo?: AccountInfo;
|
|
2654
|
-
}
|
|
2655
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2656
|
-
/**
|
|
2657
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2658
|
-
* @format GUID
|
|
2659
|
-
*/
|
|
2660
|
-
anonymousVisitorId?: string;
|
|
2661
|
-
/**
|
|
2662
|
-
* ID of a site visitor that has logged in to the site.
|
|
2663
|
-
* @format GUID
|
|
2664
|
-
*/
|
|
2665
|
-
memberId?: string;
|
|
2666
|
-
/**
|
|
2667
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2668
|
-
* @format GUID
|
|
2669
|
-
*/
|
|
2670
|
-
wixUserId?: string;
|
|
2671
|
-
/**
|
|
2672
|
-
* ID of an app.
|
|
2673
|
-
* @format GUID
|
|
2674
|
-
*/
|
|
2675
|
-
appId?: string;
|
|
2676
|
-
/** @readonly */
|
|
2677
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2678
|
-
}
|
|
2679
|
-
/** @oneof */
|
|
2680
|
-
interface IdentificationDataIdOneOf {
|
|
2681
|
-
/**
|
|
2682
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2683
|
-
* @format GUID
|
|
2684
|
-
*/
|
|
2685
|
-
anonymousVisitorId?: string;
|
|
2686
|
-
/**
|
|
2687
|
-
* ID of a site visitor that has logged in to the site.
|
|
2688
|
-
* @format GUID
|
|
2689
|
-
*/
|
|
2690
|
-
memberId?: string;
|
|
2691
|
-
/**
|
|
2692
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2693
|
-
* @format GUID
|
|
2694
|
-
*/
|
|
2695
|
-
wixUserId?: string;
|
|
2696
|
-
/**
|
|
2697
|
-
* ID of an app.
|
|
2698
|
-
* @format GUID
|
|
2699
|
-
*/
|
|
2700
|
-
appId?: string;
|
|
2701
|
-
}
|
|
2702
|
-
declare enum WebhookIdentityType {
|
|
2703
|
-
UNKNOWN = "UNKNOWN",
|
|
2704
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2705
|
-
MEMBER = "MEMBER",
|
|
2706
|
-
WIX_USER = "WIX_USER",
|
|
2707
|
-
APP = "APP"
|
|
2708
|
-
}
|
|
2709
|
-
/** @enumType */
|
|
2710
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2711
|
-
interface AccountInfo {
|
|
2712
|
-
/**
|
|
2713
|
-
* ID of the Wix account associated with the event.
|
|
2714
|
-
* @format GUID
|
|
2715
|
-
*/
|
|
2716
|
-
accountId?: string | null;
|
|
2717
|
-
/**
|
|
2718
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2719
|
-
* @format GUID
|
|
2720
|
-
*/
|
|
2721
|
-
parentAccountId?: string | null;
|
|
2722
|
-
/**
|
|
2723
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2724
|
-
* @format GUID
|
|
2725
|
-
*/
|
|
2726
|
-
siteId?: string | null;
|
|
2727
|
-
}
|
|
2728
2958
|
/** @docsIgnore */
|
|
2729
2959
|
type UpdateProgramApplicationErrors = {
|
|
2730
2960
|
code?: 'WRONG_STATE';
|
|
@@ -2928,6 +3158,131 @@ interface ProgramUpdatedEnvelope {
|
|
|
2928
3158
|
* @documentationMaturity preview
|
|
2929
3159
|
*/
|
|
2930
3160
|
declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise<void>): void;
|
|
3161
|
+
/**
|
|
3162
|
+
* Resolves an encoded program route to a connected Builder page.
|
|
3163
|
+
* @public
|
|
3164
|
+
* @documentationMaturity preview
|
|
3165
|
+
* @permissionId online_programs:v3:program:router:get_page
|
|
3166
|
+
* @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetPage
|
|
3167
|
+
*/
|
|
3168
|
+
declare function getPage(options?: GetPageOptions): Promise<NonNullablePaths<GetPageResponse, `result.status` | `result.page` | `result.publicData.stepId` | `result.publicData.description` | `result.publicData.programId` | `result.message`, 2>>;
|
|
3169
|
+
interface GetPageOptions {
|
|
3170
|
+
/**
|
|
3171
|
+
* The site's assigned router prefix, including the leading slash.
|
|
3172
|
+
* @maxLength 512
|
|
3173
|
+
*/
|
|
3174
|
+
routerPrefix?: string;
|
|
3175
|
+
/**
|
|
3176
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
3177
|
+
* @maxLength 4096
|
|
3178
|
+
*/
|
|
3179
|
+
routerSuffix?: string;
|
|
3180
|
+
/**
|
|
3181
|
+
* Absolute site URL, including the site base path and requested route.
|
|
3182
|
+
* @format WEB_URL
|
|
3183
|
+
*/
|
|
3184
|
+
fullUrl?: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* Maps router roles to site-specific installed pages.
|
|
3187
|
+
* @maxSize 20
|
|
3188
|
+
*/
|
|
3189
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
3190
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
3191
|
+
config?: Record<string, any> | null;
|
|
3192
|
+
/** Rendering information; it is not an authorization claim. */
|
|
3193
|
+
requestInfo?: Record<string, any> | null;
|
|
3194
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
3195
|
+
roleVariations?: Record<string, any> | null;
|
|
3196
|
+
/**
|
|
3197
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
3198
|
+
* @maxLength 255
|
|
3199
|
+
*/
|
|
3200
|
+
dynamicPageIdOverride?: string;
|
|
3201
|
+
}
|
|
3202
|
+
/**
|
|
3203
|
+
* Lists connected Builder routes for editor navigation, not crawler indexing.
|
|
3204
|
+
* @public
|
|
3205
|
+
* @documentationMaturity preview
|
|
3206
|
+
* @permissionId online_programs:v3:program:router:get_sitemap
|
|
3207
|
+
* @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetSitemap
|
|
3208
|
+
*/
|
|
3209
|
+
declare function getSitemap(options?: GetSitemapOptions): Promise<GetSitemapResponse>;
|
|
3210
|
+
interface GetSitemapOptions {
|
|
3211
|
+
/**
|
|
3212
|
+
* The site's assigned router prefix, including the leading slash.
|
|
3213
|
+
* @maxLength 512
|
|
3214
|
+
*/
|
|
3215
|
+
routerPrefix?: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
3218
|
+
* @maxLength 4096
|
|
3219
|
+
*/
|
|
3220
|
+
routerSuffix?: string;
|
|
3221
|
+
/**
|
|
3222
|
+
* Absolute site URL, including the site base path and requested route.
|
|
3223
|
+
* @format WEB_URL
|
|
3224
|
+
*/
|
|
3225
|
+
fullUrl?: string;
|
|
3226
|
+
/**
|
|
3227
|
+
* Maps router roles to site-specific installed pages.
|
|
3228
|
+
* @maxSize 20
|
|
3229
|
+
*/
|
|
3230
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
3231
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
3232
|
+
config?: Record<string, any> | null;
|
|
3233
|
+
/** Rendering information; it is not an authorization claim. */
|
|
3234
|
+
requestInfo?: Record<string, any> | null;
|
|
3235
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
3236
|
+
roleVariations?: Record<string, any> | null;
|
|
3237
|
+
/**
|
|
3238
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
3239
|
+
* @maxLength 255
|
|
3240
|
+
*/
|
|
3241
|
+
dynamicPageIdOverride?: string;
|
|
3242
|
+
}
|
|
3243
|
+
/**
|
|
3244
|
+
* Counts editor navigation entries using the same visibility policy as sitemap.
|
|
3245
|
+
* NOT-PRECEDENT: `/sitemapCount` is required by the App Router contract:
|
|
3246
|
+
* https://github.com/wix-private/editor-platform/blob/master/packages/platform-editor-sdk/docs/articles/routers.md#sitemap-count-request
|
|
3247
|
+
* @public
|
|
3248
|
+
* @documentationMaturity preview
|
|
3249
|
+
* @permissionId online_programs:v3:program:router:get_sitemap_count
|
|
3250
|
+
* @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetSitemapCount
|
|
3251
|
+
*/
|
|
3252
|
+
declare function getSitemapCount(options?: GetSitemapCountOptions): Promise<GetSitemapCountResponse>;
|
|
3253
|
+
interface GetSitemapCountOptions {
|
|
3254
|
+
/**
|
|
3255
|
+
* The site's assigned router prefix, including the leading slash.
|
|
3256
|
+
* @maxLength 512
|
|
3257
|
+
*/
|
|
3258
|
+
routerPrefix?: string;
|
|
3259
|
+
/**
|
|
3260
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
3261
|
+
* @maxLength 4096
|
|
3262
|
+
*/
|
|
3263
|
+
routerSuffix?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* Absolute site URL, including the site base path and requested route.
|
|
3266
|
+
* @format WEB_URL
|
|
3267
|
+
*/
|
|
3268
|
+
fullUrl?: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* Maps router roles to site-specific installed pages.
|
|
3271
|
+
* @maxSize 20
|
|
3272
|
+
*/
|
|
3273
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
3274
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
3275
|
+
config?: Record<string, any> | null;
|
|
3276
|
+
/** Rendering information; it is not an authorization claim. */
|
|
3277
|
+
requestInfo?: Record<string, any> | null;
|
|
3278
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
3279
|
+
roleVariations?: Record<string, any> | null;
|
|
3280
|
+
/**
|
|
3281
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
3282
|
+
* @maxLength 255
|
|
3283
|
+
*/
|
|
3284
|
+
dynamicPageIdOverride?: string;
|
|
3285
|
+
}
|
|
2931
3286
|
/**
|
|
2932
3287
|
* Creates a draft program.
|
|
2933
3288
|
*
|
|
@@ -3586,4 +3941,4 @@ interface CountProgramsOptions {
|
|
|
3586
3941
|
*/
|
|
3587
3942
|
declare function listSamplePrograms(): Promise<NonNullablePaths<ListSampleProgramsResponse, `programs` | `programs.${number}.program.status` | `programs.${number}.program.description.title` | `programs.${number}.program.timeline.selfPaced` | `programs.${number}.program.restrictions.hideFutureSteps` | `programs.${number}.program.restrictions.resolveStepsInOrder` | `programs.${number}.program.restrictions.shareProgress` | `programs.${number}.program.restrictions.accessType` | `programs.${number}.program.price.value` | `programs.${number}.program.price.currency` | `programs.${number}.program.seo.slug` | `programs.${number}.program.seo.imageAlt` | `programs.${number}.program.seo.courseWorkload` | `programs.${number}.program.shouldSendInvoice` | `programs.${number}.program.videoStepsSettings.autoNavigate` | `programs.${number}.program.videoStepsSettings.requiredCompletionPercentage` | `programs.${number}.program.contentSummary.stepCount` | `programs.${number}.program.contentSummary.sectionCount` | `programs.${number}.label`, 4>>;
|
|
3588
3943
|
|
|
3589
|
-
export {
|
|
3944
|
+
export { DeleteStatus as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, Enum as F, type GetPageOptions as G, BulkActionType as H, SortOrder as I, SortType as J, SortDirection as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, MissingValues as N, ScalarType as O, type Program as P, NestedAggregationType as Q, Interval as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, AggregationType as V, WebhookIdentityType as W, Mode as X, State as Y, SiteCreatedContext as Z, Namespace as _, type GetPageResponse as a, type Pages as a$, SearchIndexingNotificationState as a0, PlacementType as a1, DayOfWeek as a2, ResolutionMethod as a3, type Description as a4, type DescriptionMediaOneOf as a5, type FocalPoint as a6, type VideoResolution as a7, type Timeline as a8, type Restrictions as a9, type DomainEventBodyOneOf as aA, type EntityCreatedEvent as aB, type RestoreInfo as aC, type EntityUpdatedEvent as aD, type EntityDeletedEvent as aE, type ActionEvent as aF, type MessageEnvelope as aG, type IdentificationData as aH, type IdentificationDataIdOneOf as aI, type AccountInfo as aJ, type UpdateDocumentsEvent as aK, type UpdateDocumentsEventOperationOneOf as aL, type DocumentUpdateOperation as aM, type IndexDocument as aN, type DocumentPayload as aO, type DocumentImage as aP, type DeleteByIdsOperation as aQ, type DeleteByFilterOperation as aR, type UpdateByFilterOperation as aS, type UpdateExistingOperation as aT, type InvalidateCache as aU, type InvalidateCacheGetByOneOf as aV, type App as aW, type Page as aX, type URI as aY, type File as aZ, type CustomTag as a_, type Money as aa, type Seo as ab, type SeoSchema as ac, type Keyword as ad, type Tag as ae, type Settings as af, type Reward as ag, type Certificate as ah, type ExtendedFields as ai, type VideoStepsSettings as aj, type ContentSummary as ak, type FreemiumSettings as al, type ProgramPublished as am, type ProgramEnded as an, type ProgramArchived as ao, type ProgramDuplicated as ap, type ProgramFreemiumEnabled as aq, type ProgramFreemiumDisabled as ar, type GetPageRequest as as, type ProgramRouterPageRole as at, type ProgramRouterPageResult as au, type ProgramRouterData as av, type ProgramRouterDataSelectionOneOf as aw, type GetSitemapRequest as ax, type GetSitemapCountRequest as ay, type DomainEvent as az, type GetSitemapOptions as b, type RangeResults as b$, type URIs as b0, type ReindexMessage as b1, type ReindexMessageActionOneOf as b2, type Upsert as b3, type Delete as b4, type Schema as b5, type CreateProgramRequest as b6, type CreateProgramResponse as b7, type BulkCreateProgramsMigrationRequest as b8, type ProgramMigration as b9, type PagingMetadataV2 as bA, type Cursors as bB, type SearchProgramsRequest as bC, type CursorSearch as bD, type CursorSearchPagingMethodOneOf as bE, type Aggregation as bF, type AggregationKindOneOf as bG, type RangeBucket as bH, type IncludeMissingValuesOptions as bI, type ValueAggregation as bJ, type ValueAggregationOptionsOneOf as bK, type RangeAggregation as bL, type ScalarAggregation as bM, type DateHistogramAggregation as bN, type NestedAggregationItem as bO, type NestedAggregationItemKindOneOf as bP, type NestedAggregation as bQ, type GroupByAggregation as bR, type GroupByAggregationKindOneOf as bS, type SearchDetails as bT, type CursorPagingMetadata as bU, type AggregationData as bV, type ValueAggregationResult as bW, type RangeAggregationResult as bX, type NestedAggregationResults as bY, type NestedAggregationResultsResultOneOf as bZ, type ValueResults as b_, type BulkCreateProgramsMigrationResponse as ba, type BulkProgramResult as bb, type ItemMetadata as bc, type ApplicationError as bd, type BulkActionMetadata as be, type DeleteAllProgramsMigrationRequest as bf, type DeleteAllProgramsMigrationResponse as bg, type DuplicateProgramRequest as bh, type GetProgramRequest as bi, type GetProgramResponse as bj, type UpdateProgramRequest as bk, type UpdateProgramResponse as bl, type WrongStateErrorDetails as bm, type WrongStartDateErrorDetails as bn, type WrongParticipantsNumberErrorDetails as bo, type DuplicatedSlugErrorDetails as bp, type TimelineSwitchForbiddenErrorDetails as bq, type DeleteProgramRequest as br, type DeleteProgramResponse as bs, type QueryProgramsRequest as bt, type QueryV2 as bu, type QueryV2PagingMethodOneOf as bv, type Sorting as bw, type Paging as bx, type CursorPaging as by, type QueryProgramsResponse as bz, type GetSitemapResponse as c, type SitePropertiesEvent as c$, type AggregationResultsScalarResult as c0, type NestedValueAggregationResult as c1, type ValueResult as c2, type RangeResult as c3, type ScalarResult as c4, type NestedResultValue as c5, type NestedResultValueResultOneOf as c6, type Results as c7, type DateHistogramResult as c8, type GroupByValueResults as c9, type SitePublished as cA, type SiteUnpublished as cB, type SiteMarkedAsTemplate as cC, type SiteMarkedAsWixSite as cD, type ServiceProvisioned as cE, type ServiceRemoved as cF, type SiteRenamed as cG, type SiteHardDeleted as cH, type NamespaceChanged as cI, type StudioAssigned as cJ, type StudioUnassigned as cK, type SiteUrlChanged as cL, type SitePurgedExternally as cM, type OdeditorAssigned as cN, type OdeditorUnassigned as cO, type PicassoAssigned as cP, type PicassoUnassigned as cQ, type WixelAssigned as cR, type WixelUnassigned as cS, type StudioTwoAssigned as cT, type StudioTwoUnassigned as cU, type UserDomainMediaEnabled as cV, type UserDomainMediaDisabled as cW, type EditorlessAssigned as cX, type EditorlessUnassigned as cY, type SearchIndexingNotification as cZ, type SitePropertiesUpdated as c_, type DateHistogramResults as ca, type NestedResults as cb, type AggregationResults as cc, type AggregationResultsResultOneOf as cd, type PublishProgramRequest as ce, type EndProgramRequest as cf, type ArchiveProgramRequest as cg, type EnableProgramFreemiumRequest as ch, type DisableProgramFreemiumRequest as ci, type BulkUpdateProgramsRequest as cj, type BulkUpdateProgramResult as ck, type CountProgramsRequest as cl, type ListSampleProgramsRequest as cm, type LabeledProgram as cn, type Empty as co, type ResolveProgramSlugRequest as cp, type ResolveProgramSlugResponse as cq, type MissingMetasiteIdErrorDetails as cr, type MetaSiteSpecialEvent as cs, type MetaSiteSpecialEventPayloadOneOf as ct, type Asset as cu, type SiteCreated as cv, type SiteTransferred as cw, type SiteDeleted as cx, type DeleteContext as cy, type SiteUndeleted as cz, type GetSitemapCountOptions as d, archiveProgram as d$, type Properties as d0, type Categories as d1, type Locale as d2, type Address as d3, type AddressHint as d4, type GeoCoordinates as d5, type BusinessSchedule as d6, type TimePeriod as d7, type SpecialHourPeriod as d8, type Multilingual as d9, type SiteCreatedContextWithLiterals as dA, type NamespaceWithLiterals as dB, type DeleteStatusWithLiterals as dC, type SearchIndexingNotificationStateWithLiterals as dD, type PlacementTypeWithLiterals as dE, type DayOfWeekWithLiterals as dF, type ResolutionMethodWithLiterals as dG, type CommonQueryWithEntityContext as dH, type CommonSearchWithEntityContext as dI, onProgramCreated as dJ, onProgramDeleted as dK, onProgramArchived as dL, onProgramDuplicated as dM, onProgramEnded as dN, onProgramPublished as dO, onProgramUpdated as dP, getPage as dQ, getSitemap as dR, getSitemapCount as dS, createProgram as dT, duplicateProgram as dU, getProgram as dV, updateProgram as dW, deleteProgram as dX, queryPrograms as dY, publishProgram as dZ, endProgram as d_, type SupportedLanguage as da, type ConsentPolicy as db, type BaseEventMetadata as dc, type EventMetadata as dd, type AccountInfoMetadata as de, type ProgramsQueryResult as df, type ProgramQuerySpec as dg, type ProgramSearchSpec as dh, utils as di, type StatusWithLiterals as dj, type AccessTypeWithLiterals as dk, type TriggerWithLiterals as dl, type WebhookIdentityTypeWithLiterals as dm, type EnumWithLiterals as dn, type BulkActionTypeWithLiterals as dp, type SortOrderWithLiterals as dq, type SortTypeWithLiterals as dr, type SortDirectionWithLiterals as ds, type MissingValuesWithLiterals as dt, type ScalarTypeWithLiterals as du, type NestedAggregationTypeWithLiterals as dv, type IntervalWithLiterals as dw, type AggregationTypeWithLiterals as dx, type ModeWithLiterals as dy, type StateWithLiterals as dz, type GetSitemapCountResponse as e, enableProgramFreemium as e0, disableProgramFreemium as e1, bulkUpdatePrograms as e2, countPrograms as e3, listSamplePrograms as e4, type UpdateProgramApplicationErrors as f, type ProgramSearch as g, type PublishProgramResponse as h, type PublishProgramApplicationErrors as i, type EnableProgramFreemiumResponse as j, type EnableProgramFreemiumApplicationErrors as k, type DisableProgramFreemiumResponse as l, type BulkUpdateProgramsResponse as m, type CountProgramsResponse as n, type ProgramCreatedEnvelope as o, type ProgramDeletedEnvelope as p, type ProgramArchivedEnvelope as q, type ProgramDuplicatedEnvelope as r, type ProgramEndedEnvelope as s, type ProgramPublishedEnvelope as t, type ProgramUpdatedEnvelope as u, type ProgramsQueryBuilder as v, type ProgramQuery as w, typedQueryPrograms as x, Status as y, AccessType as z };
|