@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
|
@@ -228,73 +228,117 @@ interface Seo {
|
|
|
228
228
|
courseWorkload?: string;
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
|
-
* The SEO
|
|
232
|
-
*
|
|
233
|
-
*
|
|
231
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
232
|
+
*
|
|
233
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
234
|
+
* field set must never change (see the file header). New writers use
|
|
235
|
+
* `SeoSchemaV2`.
|
|
236
|
+
*
|
|
237
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
238
|
+
* visible on the page itself. They override every other source of tags
|
|
239
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
234
240
|
*/
|
|
235
241
|
interface SeoSchema {
|
|
236
|
-
/**
|
|
242
|
+
/**
|
|
243
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
244
|
+
* decided by the renderer, not by position in this list.
|
|
245
|
+
*
|
|
246
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
247
|
+
* a bound added now could reject a page that is already stored.
|
|
248
|
+
*/
|
|
237
249
|
tags?: Tag[];
|
|
238
|
-
/** SEO
|
|
250
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
239
251
|
settings?: Settings;
|
|
240
252
|
}
|
|
253
|
+
/** A keyword term the user is targeting. */
|
|
241
254
|
interface Keyword {
|
|
242
|
-
/**
|
|
255
|
+
/**
|
|
256
|
+
* The term itself, e.g. "trail running shoes".
|
|
257
|
+
*
|
|
258
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
259
|
+
* already stored, and a bound added now could reject a record written
|
|
260
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
261
|
+
* on this field is accepted deliberately.
|
|
262
|
+
*/
|
|
243
263
|
term?: string;
|
|
244
|
-
/** Whether
|
|
264
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
245
265
|
isMain?: boolean;
|
|
246
266
|
/**
|
|
247
|
-
*
|
|
267
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
268
|
+
* attribution in BI. Opaque to the renderer.
|
|
248
269
|
* @maxLength 1000
|
|
249
270
|
*/
|
|
250
271
|
origin?: string | null;
|
|
251
272
|
}
|
|
273
|
+
/**
|
|
274
|
+
* One tag in the page's <head>.
|
|
275
|
+
*
|
|
276
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
277
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
278
|
+
* normalizes both shapes on READ.
|
|
279
|
+
*/
|
|
252
280
|
interface Tag {
|
|
253
281
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
282
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
283
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
284
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
258
285
|
*
|
|
259
|
-
* Which of these an API actually accepts depends on where the tag is being
|
|
260
|
-
* list is not a blanket guarantee across every API that reuses
|
|
261
|
-
* Tags in particular accepts only `meta` (see
|
|
262
|
-
* `title`/`script`/`link` with a validation
|
|
263
|
-
*
|
|
264
|
-
*
|
|
286
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
287
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
288
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
289
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
290
|
+
* error even though they appear here — check the field description of the
|
|
291
|
+
* specific `tags`-typed field you are writing to.
|
|
265
292
|
*
|
|
266
293
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
267
|
-
*
|
|
268
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
269
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
270
|
-
* write through the site's Advanced/Custom Tags
|
|
271
|
-
* omit `custom` (or set it to `false`).
|
|
294
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
295
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
296
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
297
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
298
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
299
|
+
*
|
|
300
|
+
* No length limit: this field holds data written years ago by writers we
|
|
301
|
+
* are not migrating. A constraint here could reject a record that is
|
|
302
|
+
* already stored, which is exactly the promise this design makes.
|
|
272
303
|
*/
|
|
273
304
|
type?: string;
|
|
274
305
|
/**
|
|
275
|
-
*
|
|
276
|
-
*
|
|
306
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
307
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
277
308
|
*/
|
|
278
309
|
props?: Record<string, any> | null;
|
|
279
|
-
/**
|
|
310
|
+
/**
|
|
311
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
312
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
313
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
314
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
315
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
316
|
+
* page. See the design log for the full key-by-key mapping.
|
|
317
|
+
*/
|
|
280
318
|
meta?: Record<string, any> | null;
|
|
281
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
321
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
322
|
+
* `StructuredDataTag.json_ld`.
|
|
323
|
+
* No length limit, for the same reason as `type` above.
|
|
324
|
+
*/
|
|
282
325
|
children?: string;
|
|
283
326
|
/**
|
|
284
327
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
285
328
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
286
329
|
*
|
|
287
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
288
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
289
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
290
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
291
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
330
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
331
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
332
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
333
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
334
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
292
335
|
*
|
|
293
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
294
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
295
|
-
* for site-wide structured data) unconditionally.
|
|
296
|
-
* site-wide, every-page structured data
|
|
297
|
-
* `script` tag through the Item
|
|
336
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
337
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
338
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
339
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
340
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
341
|
+
* SEO Tags API instead.
|
|
298
342
|
*
|
|
299
343
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
300
344
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -307,22 +351,39 @@ interface Tag {
|
|
|
307
351
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
308
352
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
309
353
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
354
|
+
*
|
|
355
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
310
356
|
*/
|
|
311
357
|
custom?: boolean;
|
|
312
|
-
/**
|
|
358
|
+
/**
|
|
359
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
360
|
+
*
|
|
361
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
362
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
363
|
+
*/
|
|
313
364
|
disabled?: boolean;
|
|
314
365
|
}
|
|
366
|
+
/** Page-level SEO settings that are not tags. */
|
|
315
367
|
interface Settings {
|
|
316
368
|
/**
|
|
317
|
-
* Whether the
|
|
369
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
370
|
+
* its current one after a slug change.
|
|
318
371
|
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
372
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
373
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
374
|
+
* renaming a stored boolean is not worth the migration.
|
|
321
375
|
*/
|
|
322
376
|
preventAutoRedirect?: boolean;
|
|
323
377
|
/**
|
|
324
|
-
*
|
|
325
|
-
*
|
|
378
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
379
|
+
* assistant and checklist; never rendered into <head>.
|
|
380
|
+
*
|
|
381
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
382
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
383
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
384
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
385
|
+
* something absurd.
|
|
386
|
+
* @maxSize 20
|
|
326
387
|
*/
|
|
327
388
|
keywords?: Keyword[];
|
|
328
389
|
}
|
|
@@ -383,15 +444,369 @@ interface ContentSummary {
|
|
|
383
444
|
* Number of steps in the program.
|
|
384
445
|
* @max 3000
|
|
385
446
|
*/
|
|
386
|
-
stepCount?: number;
|
|
447
|
+
stepCount?: number;
|
|
448
|
+
/**
|
|
449
|
+
* Number of sections in the program.
|
|
450
|
+
* @max 1000
|
|
451
|
+
*/
|
|
452
|
+
sectionCount?: number;
|
|
453
|
+
}
|
|
454
|
+
/** Program Freemium enablement settings. Divider placement is stored separately. */
|
|
455
|
+
interface FreemiumSettings {
|
|
456
|
+
}
|
|
457
|
+
/** Triggered when a program is published. */
|
|
458
|
+
interface ProgramPublished {
|
|
459
|
+
/** Snapshot of the program after it was published. */
|
|
460
|
+
program?: Program;
|
|
461
|
+
}
|
|
462
|
+
/** Triggered when a program ends, either automatically or manually by the owner. */
|
|
463
|
+
interface ProgramEnded {
|
|
464
|
+
/** Whether the program was ended manually by the owner. */
|
|
465
|
+
endedByOwner?: boolean;
|
|
466
|
+
/** Snapshot of the program after it ended. */
|
|
467
|
+
program?: Program;
|
|
468
|
+
}
|
|
469
|
+
/** Triggered when a program is archived. */
|
|
470
|
+
interface ProgramArchived {
|
|
471
|
+
/** Snapshot of the program after it was archived. */
|
|
472
|
+
program?: Program;
|
|
473
|
+
}
|
|
474
|
+
/** Triggered when a program is duplicated. */
|
|
475
|
+
interface ProgramDuplicated {
|
|
476
|
+
/** Newly created program. */
|
|
477
|
+
program?: Program;
|
|
478
|
+
/** Program that was duplicated. */
|
|
479
|
+
duplicatedFrom?: Program;
|
|
480
|
+
/** Whether the program was cloned from a template. */
|
|
481
|
+
fromTemplate?: boolean;
|
|
482
|
+
}
|
|
483
|
+
/** Triggered when a program's Freemium setting changes to enabled. */
|
|
484
|
+
interface ProgramFreemiumEnabled {
|
|
485
|
+
}
|
|
486
|
+
/** Triggered when a program's Freemium setting changes to disabled. */
|
|
487
|
+
interface ProgramFreemiumDisabled {
|
|
488
|
+
}
|
|
489
|
+
interface GetPageRequest {
|
|
490
|
+
/**
|
|
491
|
+
* The site's assigned router prefix, including the leading slash.
|
|
492
|
+
* @maxLength 512
|
|
493
|
+
*/
|
|
494
|
+
routerPrefix?: string;
|
|
495
|
+
/**
|
|
496
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
497
|
+
* @maxLength 4096
|
|
498
|
+
*/
|
|
499
|
+
routerSuffix?: string;
|
|
500
|
+
/**
|
|
501
|
+
* Absolute site URL, including the site base path and requested route.
|
|
502
|
+
* @format WEB_URL
|
|
503
|
+
*/
|
|
504
|
+
fullUrl?: string;
|
|
505
|
+
/**
|
|
506
|
+
* Maps router roles to site-specific installed pages.
|
|
507
|
+
* @maxSize 20
|
|
508
|
+
*/
|
|
509
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
510
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
511
|
+
config?: Record<string, any> | null;
|
|
512
|
+
/** Rendering information; it is not an authorization claim. */
|
|
513
|
+
requestInfo?: Record<string, any> | null;
|
|
514
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
515
|
+
roleVariations?: Record<string, any> | null;
|
|
516
|
+
/**
|
|
517
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
518
|
+
* @maxLength 255
|
|
519
|
+
*/
|
|
520
|
+
dynamicPageIdOverride?: string;
|
|
521
|
+
}
|
|
522
|
+
interface ProgramRouterPageRole {
|
|
523
|
+
/**
|
|
524
|
+
* Site-specific installed page ID.
|
|
525
|
+
* @maxLength 255
|
|
526
|
+
*/
|
|
527
|
+
_id?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Display title of the connected page.
|
|
530
|
+
* @maxLength 1000
|
|
531
|
+
*/
|
|
532
|
+
title?: string;
|
|
533
|
+
}
|
|
534
|
+
interface GetPageResponse {
|
|
535
|
+
/** Page result consumed by the Viewer. Router status is inside this envelope. */
|
|
536
|
+
result?: ProgramRouterPageResult;
|
|
537
|
+
}
|
|
538
|
+
interface ProgramRouterPageResult {
|
|
539
|
+
/**
|
|
540
|
+
* Site response status, such as 200 for a page or 404 for a missing route.
|
|
541
|
+
* @min 100
|
|
542
|
+
* @max 599
|
|
543
|
+
*/
|
|
544
|
+
status?: number;
|
|
545
|
+
/**
|
|
546
|
+
* Site-specific installed page ID selected from the request's page roles.
|
|
547
|
+
* @maxLength 255
|
|
548
|
+
*/
|
|
549
|
+
page?: string;
|
|
550
|
+
/** Minimal program identity and selection; it never contains private content. */
|
|
551
|
+
publicData?: ProgramRouterData;
|
|
552
|
+
/** Platform-supported page head metadata. */
|
|
553
|
+
head?: Record<string, any> | null;
|
|
554
|
+
/**
|
|
555
|
+
* Safe routing-error description without private program content.
|
|
556
|
+
* @maxLength 1000
|
|
557
|
+
*/
|
|
558
|
+
message?: string;
|
|
559
|
+
}
|
|
560
|
+
interface ProgramRouterData extends ProgramRouterDataSelectionOneOf {
|
|
561
|
+
/**
|
|
562
|
+
* Selected step after verifying that it belongs to the program.
|
|
563
|
+
* @format GUID
|
|
564
|
+
*/
|
|
565
|
+
stepId?: string;
|
|
566
|
+
/** Whether the program description was requested. */
|
|
567
|
+
description?: boolean;
|
|
568
|
+
/**
|
|
569
|
+
* Stable program identity resolved within the authenticated site.
|
|
570
|
+
* @format GUID
|
|
571
|
+
*/
|
|
572
|
+
programId?: string;
|
|
573
|
+
}
|
|
574
|
+
/** @oneof */
|
|
575
|
+
interface ProgramRouterDataSelectionOneOf {
|
|
576
|
+
/**
|
|
577
|
+
* Selected step after verifying that it belongs to the program.
|
|
578
|
+
* @format GUID
|
|
579
|
+
*/
|
|
580
|
+
stepId?: string;
|
|
581
|
+
/** Whether the program description was requested. */
|
|
582
|
+
description?: boolean;
|
|
583
|
+
}
|
|
584
|
+
interface GetSitemapRequest {
|
|
585
|
+
/**
|
|
586
|
+
* The site's assigned router prefix, including the leading slash.
|
|
587
|
+
* @maxLength 512
|
|
588
|
+
*/
|
|
589
|
+
routerPrefix?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
592
|
+
* @maxLength 4096
|
|
593
|
+
*/
|
|
594
|
+
routerSuffix?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Absolute site URL, including the site base path and requested route.
|
|
597
|
+
* @format WEB_URL
|
|
598
|
+
*/
|
|
599
|
+
fullUrl?: string;
|
|
600
|
+
/**
|
|
601
|
+
* Maps router roles to site-specific installed pages.
|
|
602
|
+
* @maxSize 20
|
|
603
|
+
*/
|
|
604
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
605
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
606
|
+
config?: Record<string, any> | null;
|
|
607
|
+
/** Rendering information; it is not an authorization claim. */
|
|
608
|
+
requestInfo?: Record<string, any> | null;
|
|
609
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
610
|
+
roleVariations?: Record<string, any> | null;
|
|
611
|
+
/**
|
|
612
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
613
|
+
* @maxLength 255
|
|
614
|
+
*/
|
|
615
|
+
dynamicPageIdOverride?: string;
|
|
616
|
+
}
|
|
617
|
+
interface GetSitemapResponse {
|
|
618
|
+
/** Connected Builder routes, including an explicit empty array when no routes are visible. */
|
|
619
|
+
result?: any;
|
|
620
|
+
}
|
|
621
|
+
interface GetSitemapCountRequest {
|
|
622
|
+
/**
|
|
623
|
+
* The site's assigned router prefix, including the leading slash.
|
|
624
|
+
* @maxLength 512
|
|
625
|
+
*/
|
|
626
|
+
routerPrefix?: string;
|
|
627
|
+
/**
|
|
628
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
629
|
+
* @maxLength 4096
|
|
630
|
+
*/
|
|
631
|
+
routerSuffix?: string;
|
|
632
|
+
/**
|
|
633
|
+
* Absolute site URL, including the site base path and requested route.
|
|
634
|
+
* @format WEB_URL
|
|
635
|
+
*/
|
|
636
|
+
fullUrl?: string;
|
|
637
|
+
/**
|
|
638
|
+
* Maps router roles to site-specific installed pages.
|
|
639
|
+
* @maxSize 20
|
|
640
|
+
*/
|
|
641
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
642
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
643
|
+
config?: Record<string, any> | null;
|
|
644
|
+
/** Rendering information; it is not an authorization claim. */
|
|
645
|
+
requestInfo?: Record<string, any> | null;
|
|
646
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
647
|
+
roleVariations?: Record<string, any> | null;
|
|
648
|
+
/**
|
|
649
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
650
|
+
* @maxLength 255
|
|
651
|
+
*/
|
|
652
|
+
dynamicPageIdOverride?: string;
|
|
653
|
+
}
|
|
654
|
+
interface GetSitemapCountResponse {
|
|
655
|
+
/** Per-page route counts, including explicit numeric zeroes and an explicit empty array. */
|
|
656
|
+
result?: any;
|
|
657
|
+
}
|
|
658
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
659
|
+
createdEvent?: EntityCreatedEvent;
|
|
660
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
661
|
+
deletedEvent?: EntityDeletedEvent;
|
|
662
|
+
actionEvent?: ActionEvent;
|
|
663
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
664
|
+
_id?: string;
|
|
665
|
+
/**
|
|
666
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
667
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
668
|
+
*/
|
|
669
|
+
entityFqdn?: string;
|
|
670
|
+
/**
|
|
671
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
672
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
673
|
+
*/
|
|
674
|
+
slug?: string;
|
|
675
|
+
/** ID of the entity associated with the event. */
|
|
676
|
+
entityId?: string;
|
|
677
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
678
|
+
eventTime?: Date | null;
|
|
679
|
+
/**
|
|
680
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
681
|
+
* (for example, GDPR).
|
|
682
|
+
*/
|
|
683
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
684
|
+
/** If present, indicates the action that triggered the event. */
|
|
685
|
+
originatedFrom?: string | null;
|
|
686
|
+
/**
|
|
687
|
+
* 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.
|
|
688
|
+
* 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.
|
|
689
|
+
*/
|
|
690
|
+
entityEventSequence?: string | null;
|
|
691
|
+
}
|
|
692
|
+
/** @oneof */
|
|
693
|
+
interface DomainEventBodyOneOf {
|
|
694
|
+
createdEvent?: EntityCreatedEvent;
|
|
695
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
696
|
+
deletedEvent?: EntityDeletedEvent;
|
|
697
|
+
actionEvent?: ActionEvent;
|
|
698
|
+
}
|
|
699
|
+
interface EntityCreatedEvent {
|
|
700
|
+
entity?: string;
|
|
701
|
+
}
|
|
702
|
+
interface RestoreInfo {
|
|
703
|
+
deletedDate?: Date | null;
|
|
704
|
+
}
|
|
705
|
+
interface EntityUpdatedEvent {
|
|
706
|
+
/**
|
|
707
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
708
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
709
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
710
|
+
*/
|
|
711
|
+
currentEntity?: string;
|
|
712
|
+
}
|
|
713
|
+
interface EntityDeletedEvent {
|
|
714
|
+
/** Entity that was deleted. */
|
|
715
|
+
deletedEntity?: string | null;
|
|
716
|
+
}
|
|
717
|
+
interface ActionEvent {
|
|
718
|
+
body?: string;
|
|
719
|
+
}
|
|
720
|
+
interface MessageEnvelope {
|
|
721
|
+
/**
|
|
722
|
+
* App instance ID.
|
|
723
|
+
* @format GUID
|
|
724
|
+
*/
|
|
725
|
+
instanceId?: string | null;
|
|
726
|
+
/**
|
|
727
|
+
* Event type.
|
|
728
|
+
* @maxLength 150
|
|
729
|
+
*/
|
|
730
|
+
eventType?: string;
|
|
731
|
+
/** The identification type and identity data. */
|
|
732
|
+
identity?: IdentificationData;
|
|
733
|
+
/** Stringify payload. */
|
|
734
|
+
data?: string;
|
|
735
|
+
/** Details related to the account */
|
|
736
|
+
accountInfo?: AccountInfo;
|
|
737
|
+
}
|
|
738
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
739
|
+
/**
|
|
740
|
+
* ID of a site visitor that has not logged in to the site.
|
|
741
|
+
* @format GUID
|
|
742
|
+
*/
|
|
743
|
+
anonymousVisitorId?: string;
|
|
744
|
+
/**
|
|
745
|
+
* ID of a site visitor that has logged in to the site.
|
|
746
|
+
* @format GUID
|
|
747
|
+
*/
|
|
748
|
+
memberId?: string;
|
|
749
|
+
/**
|
|
750
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
751
|
+
* @format GUID
|
|
752
|
+
*/
|
|
753
|
+
wixUserId?: string;
|
|
754
|
+
/**
|
|
755
|
+
* ID of an app.
|
|
756
|
+
* @format GUID
|
|
757
|
+
*/
|
|
758
|
+
appId?: string;
|
|
759
|
+
/** @readonly */
|
|
760
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
761
|
+
}
|
|
762
|
+
/** @oneof */
|
|
763
|
+
interface IdentificationDataIdOneOf {
|
|
764
|
+
/**
|
|
765
|
+
* ID of a site visitor that has not logged in to the site.
|
|
766
|
+
* @format GUID
|
|
767
|
+
*/
|
|
768
|
+
anonymousVisitorId?: string;
|
|
769
|
+
/**
|
|
770
|
+
* ID of a site visitor that has logged in to the site.
|
|
771
|
+
* @format GUID
|
|
772
|
+
*/
|
|
773
|
+
memberId?: string;
|
|
774
|
+
/**
|
|
775
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
776
|
+
* @format GUID
|
|
777
|
+
*/
|
|
778
|
+
wixUserId?: string;
|
|
779
|
+
/**
|
|
780
|
+
* ID of an app.
|
|
781
|
+
* @format GUID
|
|
782
|
+
*/
|
|
783
|
+
appId?: string;
|
|
784
|
+
}
|
|
785
|
+
declare enum WebhookIdentityType {
|
|
786
|
+
UNKNOWN = "UNKNOWN",
|
|
787
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
788
|
+
MEMBER = "MEMBER",
|
|
789
|
+
WIX_USER = "WIX_USER",
|
|
790
|
+
APP = "APP"
|
|
791
|
+
}
|
|
792
|
+
/** @enumType */
|
|
793
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
794
|
+
interface AccountInfo {
|
|
795
|
+
/**
|
|
796
|
+
* ID of the Wix account associated with the event.
|
|
797
|
+
* @format GUID
|
|
798
|
+
*/
|
|
799
|
+
accountId?: string | null;
|
|
800
|
+
/**
|
|
801
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
802
|
+
* @format GUID
|
|
803
|
+
*/
|
|
804
|
+
parentAccountId?: string | null;
|
|
387
805
|
/**
|
|
388
|
-
*
|
|
389
|
-
* @
|
|
806
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
807
|
+
* @format GUID
|
|
390
808
|
*/
|
|
391
|
-
|
|
392
|
-
}
|
|
393
|
-
/** Program Freemium enablement settings. Divider placement is stored separately. */
|
|
394
|
-
interface FreemiumSettings {
|
|
809
|
+
siteId?: string | null;
|
|
395
810
|
}
|
|
396
811
|
interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
|
|
397
812
|
/** insert/update documents */
|
|
@@ -690,38 +1105,6 @@ interface Schema {
|
|
|
690
1105
|
label?: string;
|
|
691
1106
|
clusterName?: string;
|
|
692
1107
|
}
|
|
693
|
-
/** Triggered when a program is published. */
|
|
694
|
-
interface ProgramPublished {
|
|
695
|
-
/** Snapshot of the program after it was published. */
|
|
696
|
-
program?: Program;
|
|
697
|
-
}
|
|
698
|
-
/** Triggered when a program ends, either automatically or manually by the owner. */
|
|
699
|
-
interface ProgramEnded {
|
|
700
|
-
/** Whether the program was ended manually by the owner. */
|
|
701
|
-
endedByOwner?: boolean;
|
|
702
|
-
/** Snapshot of the program after it ended. */
|
|
703
|
-
program?: Program;
|
|
704
|
-
}
|
|
705
|
-
/** Triggered when a program is archived. */
|
|
706
|
-
interface ProgramArchived {
|
|
707
|
-
/** Snapshot of the program after it was archived. */
|
|
708
|
-
program?: Program;
|
|
709
|
-
}
|
|
710
|
-
/** Triggered when a program is duplicated. */
|
|
711
|
-
interface ProgramDuplicated {
|
|
712
|
-
/** Newly created program. */
|
|
713
|
-
program?: Program;
|
|
714
|
-
/** Program that was duplicated. */
|
|
715
|
-
duplicatedFrom?: Program;
|
|
716
|
-
/** Whether the program was cloned from a template. */
|
|
717
|
-
fromTemplate?: boolean;
|
|
718
|
-
}
|
|
719
|
-
/** Triggered when a program's Freemium setting changes to enabled. */
|
|
720
|
-
interface ProgramFreemiumEnabled {
|
|
721
|
-
}
|
|
722
|
-
/** Triggered when a program's Freemium setting changes to disabled. */
|
|
723
|
-
interface ProgramFreemiumDisabled {
|
|
724
|
-
}
|
|
725
1108
|
interface CreateProgramRequest {
|
|
726
1109
|
/** Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. */
|
|
727
1110
|
program: Program;
|
|
@@ -1610,68 +1993,6 @@ interface LabeledProgram {
|
|
|
1610
1993
|
*/
|
|
1611
1994
|
label?: string;
|
|
1612
1995
|
}
|
|
1613
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1614
|
-
createdEvent?: EntityCreatedEvent;
|
|
1615
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1616
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1617
|
-
actionEvent?: ActionEvent;
|
|
1618
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1619
|
-
_id?: string;
|
|
1620
|
-
/**
|
|
1621
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1622
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1623
|
-
*/
|
|
1624
|
-
entityFqdn?: string;
|
|
1625
|
-
/**
|
|
1626
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1627
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1628
|
-
*/
|
|
1629
|
-
slug?: string;
|
|
1630
|
-
/** ID of the entity associated with the event. */
|
|
1631
|
-
entityId?: string;
|
|
1632
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1633
|
-
eventTime?: Date | null;
|
|
1634
|
-
/**
|
|
1635
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1636
|
-
* (for example, GDPR).
|
|
1637
|
-
*/
|
|
1638
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1639
|
-
/** If present, indicates the action that triggered the event. */
|
|
1640
|
-
originatedFrom?: string | null;
|
|
1641
|
-
/**
|
|
1642
|
-
* 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.
|
|
1643
|
-
* 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.
|
|
1644
|
-
*/
|
|
1645
|
-
entityEventSequence?: string | null;
|
|
1646
|
-
}
|
|
1647
|
-
/** @oneof */
|
|
1648
|
-
interface DomainEventBodyOneOf {
|
|
1649
|
-
createdEvent?: EntityCreatedEvent;
|
|
1650
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1651
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1652
|
-
actionEvent?: ActionEvent;
|
|
1653
|
-
}
|
|
1654
|
-
interface EntityCreatedEvent {
|
|
1655
|
-
entity?: string;
|
|
1656
|
-
}
|
|
1657
|
-
interface RestoreInfo {
|
|
1658
|
-
deletedDate?: Date | null;
|
|
1659
|
-
}
|
|
1660
|
-
interface EntityUpdatedEvent {
|
|
1661
|
-
/**
|
|
1662
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1663
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1664
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1665
|
-
*/
|
|
1666
|
-
currentEntity?: string;
|
|
1667
|
-
}
|
|
1668
|
-
interface EntityDeletedEvent {
|
|
1669
|
-
/** Entity that was deleted. */
|
|
1670
|
-
deletedEntity?: string | null;
|
|
1671
|
-
}
|
|
1672
|
-
interface ActionEvent {
|
|
1673
|
-
body?: string;
|
|
1674
|
-
}
|
|
1675
1996
|
interface Empty {
|
|
1676
1997
|
}
|
|
1677
1998
|
interface ResolveProgramSlugRequest {
|
|
@@ -2508,97 +2829,6 @@ interface ConsentPolicy {
|
|
|
2508
2829
|
/** CCPA compliance flag. */
|
|
2509
2830
|
dataToThirdParty?: boolean | null;
|
|
2510
2831
|
}
|
|
2511
|
-
interface MessageEnvelope {
|
|
2512
|
-
/**
|
|
2513
|
-
* App instance ID.
|
|
2514
|
-
* @format GUID
|
|
2515
|
-
*/
|
|
2516
|
-
instanceId?: string | null;
|
|
2517
|
-
/**
|
|
2518
|
-
* Event type.
|
|
2519
|
-
* @maxLength 150
|
|
2520
|
-
*/
|
|
2521
|
-
eventType?: string;
|
|
2522
|
-
/** The identification type and identity data. */
|
|
2523
|
-
identity?: IdentificationData;
|
|
2524
|
-
/** Stringify payload. */
|
|
2525
|
-
data?: string;
|
|
2526
|
-
/** Details related to the account */
|
|
2527
|
-
accountInfo?: AccountInfo;
|
|
2528
|
-
}
|
|
2529
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2530
|
-
/**
|
|
2531
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2532
|
-
* @format GUID
|
|
2533
|
-
*/
|
|
2534
|
-
anonymousVisitorId?: string;
|
|
2535
|
-
/**
|
|
2536
|
-
* ID of a site visitor that has logged in to the site.
|
|
2537
|
-
* @format GUID
|
|
2538
|
-
*/
|
|
2539
|
-
memberId?: string;
|
|
2540
|
-
/**
|
|
2541
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2542
|
-
* @format GUID
|
|
2543
|
-
*/
|
|
2544
|
-
wixUserId?: string;
|
|
2545
|
-
/**
|
|
2546
|
-
* ID of an app.
|
|
2547
|
-
* @format GUID
|
|
2548
|
-
*/
|
|
2549
|
-
appId?: string;
|
|
2550
|
-
/** @readonly */
|
|
2551
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2552
|
-
}
|
|
2553
|
-
/** @oneof */
|
|
2554
|
-
interface IdentificationDataIdOneOf {
|
|
2555
|
-
/**
|
|
2556
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2557
|
-
* @format GUID
|
|
2558
|
-
*/
|
|
2559
|
-
anonymousVisitorId?: string;
|
|
2560
|
-
/**
|
|
2561
|
-
* ID of a site visitor that has logged in to the site.
|
|
2562
|
-
* @format GUID
|
|
2563
|
-
*/
|
|
2564
|
-
memberId?: string;
|
|
2565
|
-
/**
|
|
2566
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2567
|
-
* @format GUID
|
|
2568
|
-
*/
|
|
2569
|
-
wixUserId?: string;
|
|
2570
|
-
/**
|
|
2571
|
-
* ID of an app.
|
|
2572
|
-
* @format GUID
|
|
2573
|
-
*/
|
|
2574
|
-
appId?: string;
|
|
2575
|
-
}
|
|
2576
|
-
declare enum WebhookIdentityType {
|
|
2577
|
-
UNKNOWN = "UNKNOWN",
|
|
2578
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2579
|
-
MEMBER = "MEMBER",
|
|
2580
|
-
WIX_USER = "WIX_USER",
|
|
2581
|
-
APP = "APP"
|
|
2582
|
-
}
|
|
2583
|
-
/** @enumType */
|
|
2584
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2585
|
-
interface AccountInfo {
|
|
2586
|
-
/**
|
|
2587
|
-
* ID of the Wix account associated with the event.
|
|
2588
|
-
* @format GUID
|
|
2589
|
-
*/
|
|
2590
|
-
accountId?: string | null;
|
|
2591
|
-
/**
|
|
2592
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
2593
|
-
* @format GUID
|
|
2594
|
-
*/
|
|
2595
|
-
parentAccountId?: string | null;
|
|
2596
|
-
/**
|
|
2597
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
2598
|
-
* @format GUID
|
|
2599
|
-
*/
|
|
2600
|
-
siteId?: string | null;
|
|
2601
|
-
}
|
|
2602
2832
|
/** @docsIgnore */
|
|
2603
2833
|
type UpdateProgramApplicationErrors = {
|
|
2604
2834
|
code?: 'WRONG_STATE';
|
|
@@ -2802,6 +3032,131 @@ interface ProgramUpdatedEnvelope {
|
|
|
2802
3032
|
* @documentationMaturity preview
|
|
2803
3033
|
*/
|
|
2804
3034
|
declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise<void>): void;
|
|
3035
|
+
/**
|
|
3036
|
+
* Resolves an encoded program route to a connected Builder page.
|
|
3037
|
+
* @public
|
|
3038
|
+
* @documentationMaturity preview
|
|
3039
|
+
* @permissionId online_programs:v3:program:router:get_page
|
|
3040
|
+
* @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetPage
|
|
3041
|
+
*/
|
|
3042
|
+
declare function getPage(options?: GetPageOptions): Promise<NonNullablePaths<GetPageResponse, `result.status` | `result.page` | `result.publicData.stepId` | `result.publicData.description` | `result.publicData.programId` | `result.message`, 2>>;
|
|
3043
|
+
interface GetPageOptions {
|
|
3044
|
+
/**
|
|
3045
|
+
* The site's assigned router prefix, including the leading slash.
|
|
3046
|
+
* @maxLength 512
|
|
3047
|
+
*/
|
|
3048
|
+
routerPrefix?: string;
|
|
3049
|
+
/**
|
|
3050
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
3051
|
+
* @maxLength 4096
|
|
3052
|
+
*/
|
|
3053
|
+
routerSuffix?: string;
|
|
3054
|
+
/**
|
|
3055
|
+
* Absolute site URL, including the site base path and requested route.
|
|
3056
|
+
* @format WEB_URL
|
|
3057
|
+
*/
|
|
3058
|
+
fullUrl?: string;
|
|
3059
|
+
/**
|
|
3060
|
+
* Maps router roles to site-specific installed pages.
|
|
3061
|
+
* @maxSize 20
|
|
3062
|
+
*/
|
|
3063
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
3064
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
3065
|
+
config?: Record<string, any> | null;
|
|
3066
|
+
/** Rendering information; it is not an authorization claim. */
|
|
3067
|
+
requestInfo?: Record<string, any> | null;
|
|
3068
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
3069
|
+
roleVariations?: Record<string, any> | null;
|
|
3070
|
+
/**
|
|
3071
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
3072
|
+
* @maxLength 255
|
|
3073
|
+
*/
|
|
3074
|
+
dynamicPageIdOverride?: string;
|
|
3075
|
+
}
|
|
3076
|
+
/**
|
|
3077
|
+
* Lists connected Builder routes for editor navigation, not crawler indexing.
|
|
3078
|
+
* @public
|
|
3079
|
+
* @documentationMaturity preview
|
|
3080
|
+
* @permissionId online_programs:v3:program:router:get_sitemap
|
|
3081
|
+
* @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetSitemap
|
|
3082
|
+
*/
|
|
3083
|
+
declare function getSitemap(options?: GetSitemapOptions): Promise<GetSitemapResponse>;
|
|
3084
|
+
interface GetSitemapOptions {
|
|
3085
|
+
/**
|
|
3086
|
+
* The site's assigned router prefix, including the leading slash.
|
|
3087
|
+
* @maxLength 512
|
|
3088
|
+
*/
|
|
3089
|
+
routerPrefix?: string;
|
|
3090
|
+
/**
|
|
3091
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
3092
|
+
* @maxLength 4096
|
|
3093
|
+
*/
|
|
3094
|
+
routerSuffix?: string;
|
|
3095
|
+
/**
|
|
3096
|
+
* Absolute site URL, including the site base path and requested route.
|
|
3097
|
+
* @format WEB_URL
|
|
3098
|
+
*/
|
|
3099
|
+
fullUrl?: string;
|
|
3100
|
+
/**
|
|
3101
|
+
* Maps router roles to site-specific installed pages.
|
|
3102
|
+
* @maxSize 20
|
|
3103
|
+
*/
|
|
3104
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
3105
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
3106
|
+
config?: Record<string, any> | null;
|
|
3107
|
+
/** Rendering information; it is not an authorization claim. */
|
|
3108
|
+
requestInfo?: Record<string, any> | null;
|
|
3109
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
3110
|
+
roleVariations?: Record<string, any> | null;
|
|
3111
|
+
/**
|
|
3112
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
3113
|
+
* @maxLength 255
|
|
3114
|
+
*/
|
|
3115
|
+
dynamicPageIdOverride?: string;
|
|
3116
|
+
}
|
|
3117
|
+
/**
|
|
3118
|
+
* Counts editor navigation entries using the same visibility policy as sitemap.
|
|
3119
|
+
* NOT-PRECEDENT: `/sitemapCount` is required by the App Router contract:
|
|
3120
|
+
* https://github.com/wix-private/editor-platform/blob/master/packages/platform-editor-sdk/docs/articles/routers.md#sitemap-count-request
|
|
3121
|
+
* @public
|
|
3122
|
+
* @documentationMaturity preview
|
|
3123
|
+
* @permissionId online_programs:v3:program:router:get_sitemap_count
|
|
3124
|
+
* @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetSitemapCount
|
|
3125
|
+
*/
|
|
3126
|
+
declare function getSitemapCount(options?: GetSitemapCountOptions): Promise<GetSitemapCountResponse>;
|
|
3127
|
+
interface GetSitemapCountOptions {
|
|
3128
|
+
/**
|
|
3129
|
+
* The site's assigned router prefix, including the leading slash.
|
|
3130
|
+
* @maxLength 512
|
|
3131
|
+
*/
|
|
3132
|
+
routerPrefix?: string;
|
|
3133
|
+
/**
|
|
3134
|
+
* Encoded path after the prefix. Literal slashes separate route segments.
|
|
3135
|
+
* @maxLength 4096
|
|
3136
|
+
*/
|
|
3137
|
+
routerSuffix?: string;
|
|
3138
|
+
/**
|
|
3139
|
+
* Absolute site URL, including the site base path and requested route.
|
|
3140
|
+
* @format WEB_URL
|
|
3141
|
+
*/
|
|
3142
|
+
fullUrl?: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* Maps router roles to site-specific installed pages.
|
|
3145
|
+
* @maxSize 20
|
|
3146
|
+
*/
|
|
3147
|
+
pageRoles?: Record<string, ProgramRouterPageRole>;
|
|
3148
|
+
/** Platform router configuration; it does not grant access to programs. */
|
|
3149
|
+
config?: Record<string, any> | null;
|
|
3150
|
+
/** Rendering information; it is not an authorization claim. */
|
|
3151
|
+
requestInfo?: Record<string, any> | null;
|
|
3152
|
+
/** Page variations supplied by the Viewer; they do not override program identity. */
|
|
3153
|
+
roleVariations?: Record<string, any> | null;
|
|
3154
|
+
/**
|
|
3155
|
+
* Editor page override supplied by the Viewer, subject to connected-role checks.
|
|
3156
|
+
* @maxLength 255
|
|
3157
|
+
*/
|
|
3158
|
+
dynamicPageIdOverride?: string;
|
|
3159
|
+
}
|
|
2805
3160
|
/**
|
|
2806
3161
|
* Creates a draft program.
|
|
2807
3162
|
*
|
|
@@ -3394,4 +3749,4 @@ interface CountProgramsOptions {
|
|
|
3394
3749
|
*/
|
|
3395
3750
|
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>>;
|
|
3396
3751
|
|
|
3397
|
-
export {
|
|
3752
|
+
export { DayOfWeek as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, SortType as F, type GetPageOptions as G, SortDirection as H, MissingValues as I, ScalarType as J, Interval as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, NestedAggregationType as N, AggregationType as O, type Program as P, Mode as Q, State as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, SiteCreatedContext as V, WebhookIdentityType as W, Namespace as X, DeleteStatus as Y, SearchIndexingNotificationState as Z, PlacementType as _, type GetPageResponse as a, type ReindexMessageActionOneOf as a$, ResolutionMethod as a0, type Description as a1, type DescriptionMediaOneOf as a2, type FocalPoint as a3, type VideoResolution as a4, type Timeline as a5, type Restrictions as a6, type Money as a7, type Seo as a8, type SeoSchema as a9, type EntityUpdatedEvent as aA, type EntityDeletedEvent as aB, type ActionEvent as aC, type MessageEnvelope as aD, type IdentificationData as aE, type IdentificationDataIdOneOf as aF, type AccountInfo as aG, type UpdateDocumentsEvent as aH, type UpdateDocumentsEventOperationOneOf as aI, type DocumentUpdateOperation as aJ, type IndexDocument as aK, type DocumentPayload as aL, type DocumentImage as aM, type DeleteByIdsOperation as aN, type DeleteByFilterOperation as aO, type UpdateByFilterOperation as aP, type UpdateExistingOperation as aQ, type InvalidateCache as aR, type InvalidateCacheGetByOneOf as aS, type App as aT, type Page as aU, type URI as aV, type File as aW, type CustomTag as aX, type Pages as aY, type URIs as aZ, type ReindexMessage as a_, type Keyword as aa, type Tag as ab, type Settings as ac, type Reward as ad, type Certificate as ae, type ExtendedFields as af, type VideoStepsSettings as ag, type ContentSummary as ah, type FreemiumSettings as ai, type ProgramPublished as aj, type ProgramEnded as ak, type ProgramArchived as al, type ProgramDuplicated as am, type ProgramFreemiumEnabled as an, type ProgramFreemiumDisabled as ao, type GetPageRequest as ap, type ProgramRouterPageRole as aq, type ProgramRouterPageResult as ar, type ProgramRouterData as as, type ProgramRouterDataSelectionOneOf as at, type GetSitemapRequest as au, type GetSitemapCountRequest as av, type DomainEvent as aw, type DomainEventBodyOneOf as ax, type EntityCreatedEvent as ay, type RestoreInfo as az, type GetSitemapOptions as b, type ValueResult as b$, type Upsert as b0, type Delete as b1, type Schema as b2, type CreateProgramRequest as b3, type CreateProgramResponse as b4, type BulkCreateProgramsMigrationRequest as b5, type ProgramMigration as b6, type BulkCreateProgramsMigrationResponse as b7, type BulkProgramResult as b8, type ItemMetadata as b9, type CursorSearch as bA, type CursorSearchPagingMethodOneOf as bB, type Aggregation as bC, type AggregationKindOneOf as bD, type RangeBucket as bE, type IncludeMissingValuesOptions as bF, type ValueAggregation as bG, type ValueAggregationOptionsOneOf as bH, type RangeAggregation as bI, type ScalarAggregation as bJ, type DateHistogramAggregation as bK, type NestedAggregationItem as bL, type NestedAggregationItemKindOneOf as bM, type NestedAggregation as bN, type GroupByAggregation as bO, type GroupByAggregationKindOneOf as bP, type SearchDetails as bQ, type CursorPagingMetadata as bR, type AggregationData as bS, type ValueAggregationResult as bT, type RangeAggregationResult as bU, type NestedAggregationResults as bV, type NestedAggregationResultsResultOneOf as bW, type ValueResults as bX, type RangeResults as bY, type AggregationResultsScalarResult as bZ, type NestedValueAggregationResult as b_, type ApplicationError as ba, type BulkActionMetadata as bb, type DeleteAllProgramsMigrationRequest as bc, type DeleteAllProgramsMigrationResponse as bd, type DuplicateProgramRequest as be, type GetProgramRequest as bf, type GetProgramResponse as bg, type UpdateProgramRequest as bh, type UpdateProgramResponse as bi, type WrongStateErrorDetails as bj, type WrongStartDateErrorDetails as bk, type WrongParticipantsNumberErrorDetails as bl, type DuplicatedSlugErrorDetails as bm, type TimelineSwitchForbiddenErrorDetails as bn, type DeleteProgramRequest as bo, type DeleteProgramResponse as bp, type QueryProgramsRequest as bq, type QueryV2 as br, type QueryV2PagingMethodOneOf as bs, type Sorting as bt, type Paging as bu, type CursorPaging as bv, type QueryProgramsResponse as bw, type PagingMetadataV2 as bx, type Cursors as by, type SearchProgramsRequest as bz, type GetSitemapResponse as c, type Properties as c$, type RangeResult as c0, type ScalarResult as c1, type NestedResultValue as c2, type NestedResultValueResultOneOf as c3, type Results as c4, type DateHistogramResult as c5, type GroupByValueResults as c6, type DateHistogramResults as c7, type NestedResults as c8, type AggregationResults as c9, type SiteUnpublished as cA, type SiteMarkedAsTemplate as cB, type SiteMarkedAsWixSite as cC, type ServiceProvisioned as cD, type ServiceRemoved as cE, type SiteRenamed as cF, type SiteHardDeleted as cG, type NamespaceChanged as cH, type StudioAssigned as cI, type StudioUnassigned as cJ, type SiteUrlChanged as cK, type SitePurgedExternally as cL, type OdeditorAssigned as cM, type OdeditorUnassigned as cN, type PicassoAssigned as cO, type PicassoUnassigned as cP, type WixelAssigned as cQ, type WixelUnassigned as cR, type StudioTwoAssigned as cS, type StudioTwoUnassigned as cT, type UserDomainMediaEnabled as cU, type UserDomainMediaDisabled as cV, type EditorlessAssigned as cW, type EditorlessUnassigned as cX, type SearchIndexingNotification as cY, type SitePropertiesUpdated as cZ, type SitePropertiesEvent as c_, type AggregationResultsResultOneOf as ca, type PublishProgramRequest as cb, type EndProgramRequest as cc, type ArchiveProgramRequest as cd, type EnableProgramFreemiumRequest as ce, type EnableProgramFreemiumResponse as cf, type DisableProgramFreemiumRequest as cg, type DisableProgramFreemiumResponse as ch, type BulkUpdateProgramsRequest as ci, type BulkUpdateProgramResult as cj, type CountProgramsRequest as ck, type ListSampleProgramsRequest as cl, type LabeledProgram as cm, type Empty as cn, type ResolveProgramSlugRequest as co, type ResolveProgramSlugResponse as cp, type MissingMetasiteIdErrorDetails as cq, type MetaSiteSpecialEvent as cr, type MetaSiteSpecialEventPayloadOneOf as cs, type Asset as ct, type SiteCreated as cu, type SiteTransferred as cv, type SiteDeleted as cw, type DeleteContext as cx, type SiteUndeleted as cy, type SitePublished as cz, type GetSitemapCountOptions as d, archiveProgram as d$, type Categories as d0, type Locale as d1, type Address as d2, type AddressHint as d3, type GeoCoordinates as d4, type BusinessSchedule as d5, type TimePeriod as d6, type SpecialHourPeriod as d7, type Multilingual as d8, type SupportedLanguage as d9, type NamespaceWithLiterals as dA, type DeleteStatusWithLiterals as dB, type SearchIndexingNotificationStateWithLiterals as dC, type PlacementTypeWithLiterals as dD, type DayOfWeekWithLiterals as dE, type ResolutionMethodWithLiterals as dF, type EnableProgramFreemiumApplicationErrors 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 ConsentPolicy as da, type BaseEventMetadata as db, type EventMetadata as dc, type AccountInfoMetadata as dd, type ProgramsQueryResult as de, type ProgramQuerySpec as df, type ProgramSearchSpec as dg, utils as dh, type StatusWithLiterals as di, type AccessTypeWithLiterals as dj, type TriggerWithLiterals as dk, type WebhookIdentityTypeWithLiterals as dl, type EnumWithLiterals as dm, type BulkActionTypeWithLiterals as dn, type SortOrderWithLiterals as dp, type SortTypeWithLiterals as dq, type SortDirectionWithLiterals as dr, type MissingValuesWithLiterals as ds, type ScalarTypeWithLiterals as dt, type NestedAggregationTypeWithLiterals as du, type IntervalWithLiterals as dv, type AggregationTypeWithLiterals as dw, type ModeWithLiterals as dx, type StateWithLiterals as dy, type SiteCreatedContextWithLiterals as dz, type GetSitemapCountResponse as e, bulkUpdatePrograms as e0, countPrograms as e1, listSamplePrograms as e2, type UpdateProgramApplicationErrors as f, type ProgramSearch as g, type PublishProgramResponse as h, type PublishProgramApplicationErrors as i, type BulkUpdateProgramsResponse as j, type CountProgramsResponse as k, type ProgramCreatedEnvelope as l, type ProgramDeletedEnvelope as m, type ProgramArchivedEnvelope as n, type ProgramDuplicatedEnvelope as o, type ProgramEndedEnvelope as p, type ProgramPublishedEnvelope as q, type ProgramUpdatedEnvelope as r, type ProgramsQueryBuilder as s, type ProgramQuery as t, typedQueryPrograms as u, Status as v, AccessType as w, Enum as x, BulkActionType as y, SortOrder as z };
|