@wix/auto_sdk_online-programs_programs 1.0.41 → 1.0.43
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 +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +112 -45
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/{online-programs-v3-program-programs.universal-jF7XKDI_.d.ts → online-programs-v3-program-programs.universal-Lt33oe5u.d.ts} +111 -44
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +112 -45
- package/build/es/meta.mjs.map +1 -1
- package/build/es/{online-programs-v3-program-programs.universal-jF7XKDI_.d.mts → online-programs-v3-program-programs.universal-Lt33oe5u.d.mts} +111 -44
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +122 -45
- package/build/internal/cjs/{online-programs-v3-program-programs.universal-C1gLuVO0.d.ts → online-programs-v3-program-programs.universal-DJ1omkE9.d.ts} +121 -44
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +122 -45
- package/build/internal/es/{online-programs-v3-program-programs.universal-C1gLuVO0.d.mts → online-programs-v3-program-programs.universal-DJ1omkE9.d.mts} +121 -44
- package/package.json +4 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { aK as CreateProgramRequest$1, aL as CreateProgramResponse$1, aV as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aW as GetProgramRequest$1, aX as GetProgramResponse$1, aY as UpdateProgramRequest$1, aZ as UpdateProgramResponse$1, b3 as DeleteProgramRequest$1, b4 as DeleteProgramResponse$1, b5 as QueryProgramsRequest$1, bb as QueryProgramsResponse$1, be as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bS as PublishProgramRequest$1, c as PublishProgramResponse$1, bT as EndProgramRequest$1, E as EndProgramResponse$1, bU as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bV as EnableProgramFreemiumRequest$1, e as EnableProgramFreemiumResponse$1, bW as DisableProgramFreemiumRequest$1, g as DisableProgramFreemiumResponse$1, bX as BulkUpdateProgramsRequest$1, h as BulkUpdateProgramsResponse$1, bZ as CountProgramsRequest$1, i as CountProgramsResponse$1, b_ as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-DJ1omkE9.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -405,73 +405,117 @@ interface Seo {
|
|
|
405
405
|
courseWorkload?: string;
|
|
406
406
|
}
|
|
407
407
|
/**
|
|
408
|
-
* The SEO
|
|
409
|
-
*
|
|
410
|
-
*
|
|
408
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
409
|
+
*
|
|
410
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
411
|
+
* field set must never change (see the file header). New writers use
|
|
412
|
+
* `SeoSchemaV2`.
|
|
413
|
+
*
|
|
414
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
415
|
+
* visible on the page itself. They override every other source of tags
|
|
416
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
411
417
|
*/
|
|
412
418
|
interface SeoSchema {
|
|
413
|
-
/**
|
|
419
|
+
/**
|
|
420
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
421
|
+
* decided by the renderer, not by position in this list.
|
|
422
|
+
*
|
|
423
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
424
|
+
* a bound added now could reject a page that is already stored.
|
|
425
|
+
*/
|
|
414
426
|
tags?: Tag[];
|
|
415
|
-
/** SEO
|
|
427
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
416
428
|
settings?: Settings;
|
|
417
429
|
}
|
|
430
|
+
/** A keyword term the user is targeting. */
|
|
418
431
|
interface Keyword {
|
|
419
|
-
/**
|
|
432
|
+
/**
|
|
433
|
+
* The term itself, e.g. "trail running shoes".
|
|
434
|
+
*
|
|
435
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
436
|
+
* already stored, and a bound added now could reject a record written
|
|
437
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
438
|
+
* on this field is accepted deliberately.
|
|
439
|
+
*/
|
|
420
440
|
term?: string;
|
|
421
|
-
/** Whether
|
|
441
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
422
442
|
isMain?: boolean;
|
|
423
443
|
/**
|
|
424
|
-
*
|
|
444
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
445
|
+
* attribution in BI. Opaque to the renderer.
|
|
425
446
|
* @maxLength 1000
|
|
426
447
|
*/
|
|
427
448
|
origin?: string | null;
|
|
428
449
|
}
|
|
450
|
+
/**
|
|
451
|
+
* One tag in the page's <head>.
|
|
452
|
+
*
|
|
453
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
454
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
455
|
+
* normalizes both shapes on READ.
|
|
456
|
+
*/
|
|
429
457
|
interface Tag {
|
|
430
458
|
/**
|
|
431
|
-
*
|
|
432
|
-
*
|
|
459
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
460
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
461
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
433
462
|
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
* `
|
|
440
|
-
* check the field description of the specific `tags`-typed field you're writing to
|
|
441
|
-
* for the types it actually supports and the error it returns.
|
|
463
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
464
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
465
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
466
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
467
|
+
* error even though they appear here — check the field description of the
|
|
468
|
+
* specific `tags`-typed field you are writing to.
|
|
442
469
|
*
|
|
443
470
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
444
|
-
*
|
|
445
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
446
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
447
|
-
* write through the site's Advanced/Custom Tags
|
|
448
|
-
* omit `custom` (or set it to `false`).
|
|
471
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
472
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
473
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
474
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
475
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
476
|
+
*
|
|
477
|
+
* No length limit: this field holds data written years ago by writers we
|
|
478
|
+
* are not migrating. A constraint here could reject a record that is
|
|
479
|
+
* already stored, which is exactly the promise this design makes.
|
|
449
480
|
*/
|
|
450
481
|
type?: string;
|
|
451
482
|
/**
|
|
452
|
-
*
|
|
453
|
-
*
|
|
483
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
484
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
454
485
|
*/
|
|
455
486
|
props?: Record<string, any> | null;
|
|
456
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
489
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
490
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
491
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
492
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
493
|
+
* page. See the design log for the full key-by-key mapping.
|
|
494
|
+
*/
|
|
457
495
|
meta?: Record<string, any> | null;
|
|
458
|
-
/**
|
|
496
|
+
/**
|
|
497
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
498
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
499
|
+
* `StructuredDataTag.json_ld`.
|
|
500
|
+
* No length limit, for the same reason as `type` above.
|
|
501
|
+
*/
|
|
459
502
|
children?: string;
|
|
460
503
|
/**
|
|
461
504
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
462
505
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
463
506
|
*
|
|
464
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
465
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
466
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
467
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
468
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
507
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
508
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
509
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
510
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
511
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
469
512
|
*
|
|
470
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
471
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
472
|
-
* for site-wide structured data) unconditionally.
|
|
473
|
-
* site-wide, every-page structured data
|
|
474
|
-
* `script` tag through the Item
|
|
513
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
514
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
515
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
516
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
517
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
518
|
+
* SEO Tags API instead.
|
|
475
519
|
*
|
|
476
520
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
477
521
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -484,22 +528,39 @@ interface Tag {
|
|
|
484
528
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
485
529
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
486
530
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
531
|
+
*
|
|
532
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
487
533
|
*/
|
|
488
534
|
custom?: boolean;
|
|
489
|
-
/**
|
|
535
|
+
/**
|
|
536
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
537
|
+
*
|
|
538
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
539
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
540
|
+
*/
|
|
490
541
|
disabled?: boolean;
|
|
491
542
|
}
|
|
543
|
+
/** Page-level SEO settings that are not tags. */
|
|
492
544
|
interface Settings {
|
|
493
545
|
/**
|
|
494
|
-
* Whether the
|
|
495
|
-
*
|
|
546
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
547
|
+
* its current one after a slug change.
|
|
496
548
|
*
|
|
497
|
-
* Default
|
|
549
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
550
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
551
|
+
* renaming a stored boolean is not worth the migration.
|
|
498
552
|
*/
|
|
499
553
|
preventAutoRedirect?: boolean;
|
|
500
554
|
/**
|
|
501
|
-
*
|
|
502
|
-
*
|
|
555
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
556
|
+
* assistant and checklist; never rendered into <head>.
|
|
557
|
+
*
|
|
558
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
559
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
560
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
561
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
562
|
+
* something absurd.
|
|
563
|
+
* @maxSize 20
|
|
503
564
|
*/
|
|
504
565
|
keywords?: Keyword[];
|
|
505
566
|
}
|
|
@@ -905,6 +966,22 @@ interface ProgramDuplicated {
|
|
|
905
966
|
/** Whether the program was cloned from a template. */
|
|
906
967
|
fromTemplate?: boolean;
|
|
907
968
|
}
|
|
969
|
+
/** Triggered when a program's Freemium setting changes to enabled. */
|
|
970
|
+
interface ProgramFreemiumEnabled {
|
|
971
|
+
/**
|
|
972
|
+
* Snapshot of the program after the mode change committed.
|
|
973
|
+
* @internal
|
|
974
|
+
*/
|
|
975
|
+
program?: Program;
|
|
976
|
+
}
|
|
977
|
+
/** Triggered when a program's Freemium setting changes to disabled. */
|
|
978
|
+
interface ProgramFreemiumDisabled {
|
|
979
|
+
/**
|
|
980
|
+
* Snapshot of the program after the mode change committed.
|
|
981
|
+
* @internal
|
|
982
|
+
*/
|
|
983
|
+
program?: Program;
|
|
984
|
+
}
|
|
908
985
|
interface CreateProgramRequest {
|
|
909
986
|
/** Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. */
|
|
910
987
|
program: Program;
|
|
@@ -2956,4 +3033,4 @@ declare function bulkUpdatePrograms(): __PublicMethodMetaInfo<'POST', {}, BulkUp
|
|
|
2956
3033
|
declare function countPrograms(): __PublicMethodMetaInfo<'POST', {}, CountProgramsRequest$1, CountProgramsRequest, CountProgramsResponse$1, CountProgramsResponse>;
|
|
2957
3034
|
declare function listSamplePrograms(): __PublicMethodMetaInfo<'GET', {}, ListSampleProgramsRequest$1, ListSampleProgramsRequest, ListSampleProgramsResponse$1, ListSampleProgramsResponse>;
|
|
2958
3035
|
|
|
2959
|
-
export { AccessType as AccessTypeOriginal, type AccessTypeWithLiterals as AccessTypeWithLiteralsOriginal, type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type ArchiveProgramRequest as ArchiveProgramRequestOriginal, type ArchiveProgramResponse as ArchiveProgramResponseOriginal, type Asset as AssetOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCreateProgramsMigrationRequest as BulkCreateProgramsMigrationRequestOriginal, type BulkCreateProgramsMigrationResponse as BulkCreateProgramsMigrationResponseOriginal, type BulkProgramResult as BulkProgramResultOriginal, type BulkUpdateProgramResult as BulkUpdateProgramResultOriginal, type BulkUpdateProgramsRequest as BulkUpdateProgramsRequestOriginal, type BulkUpdateProgramsResponse as BulkUpdateProgramsResponseOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type Certificate as CertificateOriginal, type ConsentPolicy as ConsentPolicyOriginal, type ContentSummary as ContentSummaryOriginal, type CountProgramsRequest as CountProgramsRequestOriginal, type CountProgramsResponse as CountProgramsResponseOriginal, type CreateProgramRequest as CreateProgramRequestOriginal, type CreateProgramResponse as CreateProgramResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteAllProgramsMigrationRequest as DeleteAllProgramsMigrationRequestOriginal, type DeleteAllProgramsMigrationResponse as DeleteAllProgramsMigrationResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, type Delete as DeleteOriginal, type DeleteProgramRequest as DeleteProgramRequestOriginal, type DeleteProgramResponse as DeleteProgramResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DescriptionMediaOneOf as DescriptionMediaOneOfOriginal, type Description as DescriptionOriginal, type DisableProgramFreemiumRequest as DisableProgramFreemiumRequestOriginal, type DisableProgramFreemiumResponse as DisableProgramFreemiumResponseOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateProgramRequest as DuplicateProgramRequestOriginal, type DuplicateProgramResponse as DuplicateProgramResponseOriginal, type DuplicatedSlugErrorDetails as DuplicatedSlugErrorDetailsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EnableProgramFreemiumApplicationErrors as EnableProgramFreemiumApplicationErrorsOriginal, type EnableProgramFreemiumRequest as EnableProgramFreemiumRequestOriginal, type EnableProgramFreemiumResponse as EnableProgramFreemiumResponseOriginal, type EndProgramRequest as EndProgramRequestOriginal, type EndProgramResponse as EndProgramResponseOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type FocalPoint as FocalPointOriginal, type FreemiumSettings as FreemiumSettingsOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetProgramRequest as GetProgramRequestOriginal, type GetProgramResponse as GetProgramResponseOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type IndexDocument as IndexDocumentOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type LabeledProgram as LabeledProgramOriginal, type ListSampleProgramsRequest as ListSampleProgramsRequestOriginal, type ListSampleProgramsResponse as ListSampleProgramsResponseOriginal, type Locale as LocaleOriginal, type MaskedProgram as MaskedProgramOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MissingMetasiteIdErrorDetails as MissingMetasiteIdErrorDetailsOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type Money as MoneyOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Page as PageOriginal, type PageUrl as PageUrlOriginal, type Pages as PagesOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type ProgramArchived as ProgramArchivedOriginal, type ProgramDuplicated as ProgramDuplicatedOriginal, type ProgramEnded as ProgramEndedOriginal, type ProgramMigration as ProgramMigrationOriginal, type Program as ProgramOriginal, type ProgramPublished as ProgramPublishedOriginal, type Properties as PropertiesOriginal, type PublishProgramApplicationErrors as PublishProgramApplicationErrorsOriginal, type PublishProgramRequest as PublishProgramRequestOriginal, type PublishProgramResponse as PublishProgramResponseOriginal, type QueryProgramsRequest as QueryProgramsRequestOriginal, type QueryProgramsResponse as QueryProgramsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type ReindexMessageActionOneOf as ReindexMessageActionOneOfOriginal, type ReindexMessage as ReindexMessageOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type ResolveProgramSlugRequest as ResolveProgramSlugRequestOriginal, type ResolveProgramSlugResponse as ResolveProgramSlugResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type Restrictions as RestrictionsOriginal, type Results as ResultsOriginal, type Reward as RewardOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type Schema as SchemaOriginal, type SearchDetails as SearchDetailsOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SearchProgramsRequest as SearchProgramsRequestOriginal, type SearchProgramsResponse as SearchProgramsResponseOriginal, type Seo as SeoOriginal, type SeoSchema as SeoSchemaOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type Settings as SettingsOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesUpdated as SitePropertiesUpdatedOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type Tag as TagOriginal, type TimePeriod as TimePeriodOriginal, type Timeline as TimelineOriginal, type TimelineSwitchForbiddenErrorDetails as TimelineSwitchForbiddenErrorDetailsOriginal, Trigger as TriggerOriginal, type TriggerWithLiterals as TriggerWithLiteralsOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateProgramApplicationErrors as UpdateProgramApplicationErrorsOriginal, type UpdateProgramRequest as UpdateProgramRequestOriginal, type UpdateProgramResponse as UpdateProgramResponseOriginal, type Upsert as UpsertOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, type VideoResolution as VideoResolutionOriginal, type VideoStepsSettings as VideoStepsSettingsOriginal, type VideoV2 as VideoV2Original, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type WrongParticipantsNumberErrorDetails as WrongParticipantsNumberErrorDetailsOriginal, type WrongStartDateErrorDetails as WrongStartDateErrorDetailsOriginal, type WrongStateErrorDetails as WrongStateErrorDetailsOriginal, type __PublicMethodMetaInfo, archiveProgram, bulkUpdatePrograms, countPrograms, createProgram, deleteProgram, disableProgramFreemium, duplicateProgram, enableProgramFreemium, endProgram, getProgram, listSamplePrograms, publishProgram, queryPrograms, searchPrograms, updateProgram };
|
|
3036
|
+
export { AccessType as AccessTypeOriginal, type AccessTypeWithLiterals as AccessTypeWithLiteralsOriginal, type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type ArchiveProgramRequest as ArchiveProgramRequestOriginal, type ArchiveProgramResponse as ArchiveProgramResponseOriginal, type Asset as AssetOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCreateProgramsMigrationRequest as BulkCreateProgramsMigrationRequestOriginal, type BulkCreateProgramsMigrationResponse as BulkCreateProgramsMigrationResponseOriginal, type BulkProgramResult as BulkProgramResultOriginal, type BulkUpdateProgramResult as BulkUpdateProgramResultOriginal, type BulkUpdateProgramsRequest as BulkUpdateProgramsRequestOriginal, type BulkUpdateProgramsResponse as BulkUpdateProgramsResponseOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type Certificate as CertificateOriginal, type ConsentPolicy as ConsentPolicyOriginal, type ContentSummary as ContentSummaryOriginal, type CountProgramsRequest as CountProgramsRequestOriginal, type CountProgramsResponse as CountProgramsResponseOriginal, type CreateProgramRequest as CreateProgramRequestOriginal, type CreateProgramResponse as CreateProgramResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteAllProgramsMigrationRequest as DeleteAllProgramsMigrationRequestOriginal, type DeleteAllProgramsMigrationResponse as DeleteAllProgramsMigrationResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, type Delete as DeleteOriginal, type DeleteProgramRequest as DeleteProgramRequestOriginal, type DeleteProgramResponse as DeleteProgramResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DescriptionMediaOneOf as DescriptionMediaOneOfOriginal, type Description as DescriptionOriginal, type DisableProgramFreemiumRequest as DisableProgramFreemiumRequestOriginal, type DisableProgramFreemiumResponse as DisableProgramFreemiumResponseOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateProgramRequest as DuplicateProgramRequestOriginal, type DuplicateProgramResponse as DuplicateProgramResponseOriginal, type DuplicatedSlugErrorDetails as DuplicatedSlugErrorDetailsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EnableProgramFreemiumApplicationErrors as EnableProgramFreemiumApplicationErrorsOriginal, type EnableProgramFreemiumRequest as EnableProgramFreemiumRequestOriginal, type EnableProgramFreemiumResponse as EnableProgramFreemiumResponseOriginal, type EndProgramRequest as EndProgramRequestOriginal, type EndProgramResponse as EndProgramResponseOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type FocalPoint as FocalPointOriginal, type FreemiumSettings as FreemiumSettingsOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetProgramRequest as GetProgramRequestOriginal, type GetProgramResponse as GetProgramResponseOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type IndexDocument as IndexDocumentOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type LabeledProgram as LabeledProgramOriginal, type ListSampleProgramsRequest as ListSampleProgramsRequestOriginal, type ListSampleProgramsResponse as ListSampleProgramsResponseOriginal, type Locale as LocaleOriginal, type MaskedProgram as MaskedProgramOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MissingMetasiteIdErrorDetails as MissingMetasiteIdErrorDetailsOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type Money as MoneyOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Page as PageOriginal, type PageUrl as PageUrlOriginal, type Pages as PagesOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type ProgramArchived as ProgramArchivedOriginal, type ProgramDuplicated as ProgramDuplicatedOriginal, type ProgramEnded as ProgramEndedOriginal, type ProgramFreemiumDisabled as ProgramFreemiumDisabledOriginal, type ProgramFreemiumEnabled as ProgramFreemiumEnabledOriginal, type ProgramMigration as ProgramMigrationOriginal, type Program as ProgramOriginal, type ProgramPublished as ProgramPublishedOriginal, type Properties as PropertiesOriginal, type PublishProgramApplicationErrors as PublishProgramApplicationErrorsOriginal, type PublishProgramRequest as PublishProgramRequestOriginal, type PublishProgramResponse as PublishProgramResponseOriginal, type QueryProgramsRequest as QueryProgramsRequestOriginal, type QueryProgramsResponse as QueryProgramsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type ReindexMessageActionOneOf as ReindexMessageActionOneOfOriginal, type ReindexMessage as ReindexMessageOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type ResolveProgramSlugRequest as ResolveProgramSlugRequestOriginal, type ResolveProgramSlugResponse as ResolveProgramSlugResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type Restrictions as RestrictionsOriginal, type Results as ResultsOriginal, type Reward as RewardOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type Schema as SchemaOriginal, type SearchDetails as SearchDetailsOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, SearchIndexingNotificationState as SearchIndexingNotificationStateOriginal, type SearchIndexingNotificationStateWithLiterals as SearchIndexingNotificationStateWithLiteralsOriginal, type SearchProgramsRequest as SearchProgramsRequestOriginal, type SearchProgramsResponse as SearchProgramsResponseOriginal, type Seo as SeoOriginal, type SeoSchema as SeoSchemaOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type Settings as SettingsOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesUpdated as SitePropertiesUpdatedOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type Tag as TagOriginal, type TimePeriod as TimePeriodOriginal, type Timeline as TimelineOriginal, type TimelineSwitchForbiddenErrorDetails as TimelineSwitchForbiddenErrorDetailsOriginal, Trigger as TriggerOriginal, type TriggerWithLiterals as TriggerWithLiteralsOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateProgramApplicationErrors as UpdateProgramApplicationErrorsOriginal, type UpdateProgramRequest as UpdateProgramRequestOriginal, type UpdateProgramResponse as UpdateProgramResponseOriginal, type Upsert as UpsertOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, type VideoResolution as VideoResolutionOriginal, type VideoStepsSettings as VideoStepsSettingsOriginal, type VideoV2 as VideoV2Original, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type WrongParticipantsNumberErrorDetails as WrongParticipantsNumberErrorDetailsOriginal, type WrongStartDateErrorDetails as WrongStartDateErrorDetailsOriginal, type WrongStateErrorDetails as WrongStateErrorDetailsOriginal, type __PublicMethodMetaInfo, archiveProgram, bulkUpdatePrograms, countPrograms, createProgram, deleteProgram, disableProgramFreemium, duplicateProgram, enableProgramFreemium, endProgram, getProgram, listSamplePrograms, publishProgram, queryPrograms, searchPrograms, updateProgram };
|
|
@@ -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
|
-
*
|
|
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.
|
|
323
352
|
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
* `
|
|
330
|
-
* check the field description of the specific `tags`-typed field you're writing to
|
|
331
|
-
* for the types it actually supports and the error it returns.
|
|
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
|
|
385
|
-
*
|
|
436
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
437
|
+
* its current one after a slug change.
|
|
386
438
|
*
|
|
387
|
-
* Default
|
|
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
|
}
|
|
@@ -789,6 +850,22 @@ interface ProgramDuplicated {
|
|
|
789
850
|
/** Whether the program was cloned from a template. */
|
|
790
851
|
fromTemplate?: boolean;
|
|
791
852
|
}
|
|
853
|
+
/** Triggered when a program's Freemium setting changes to enabled. */
|
|
854
|
+
interface ProgramFreemiumEnabled {
|
|
855
|
+
/**
|
|
856
|
+
* Snapshot of the program after the mode change committed.
|
|
857
|
+
* @internal
|
|
858
|
+
*/
|
|
859
|
+
program?: Program;
|
|
860
|
+
}
|
|
861
|
+
/** Triggered when a program's Freemium setting changes to disabled. */
|
|
862
|
+
interface ProgramFreemiumDisabled {
|
|
863
|
+
/**
|
|
864
|
+
* Snapshot of the program after the mode change committed.
|
|
865
|
+
* @internal
|
|
866
|
+
*/
|
|
867
|
+
program?: Program;
|
|
868
|
+
}
|
|
792
869
|
interface CreateProgramRequest {
|
|
793
870
|
/** Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. */
|
|
794
871
|
program: Program;
|
|
@@ -3570,4 +3647,4 @@ interface CountProgramsOptions {
|
|
|
3570
3647
|
*/
|
|
3571
3648
|
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>>;
|
|
3572
3649
|
|
|
3573
|
-
export { type DescriptionMediaOneOf as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, MissingValues as F, ScalarType as G, AggregationType as H, Interval as I, Mode as J, State as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, NestedAggregationType as N, SiteCreatedContext as O, type Program as P, Namespace as Q, DeleteStatus as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, SearchIndexingNotificationState as V, PlacementType as W, DayOfWeek as X, ResolutionMethod as Y, WebhookIdentityType as Z, type Description as _, type UpdateProgramApplicationErrors as a, type
|
|
3650
|
+
export { type DescriptionMediaOneOf as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, MissingValues as F, ScalarType as G, AggregationType as H, Interval as I, Mode as J, State as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, NestedAggregationType as N, SiteCreatedContext as O, type Program as P, Namespace as Q, DeleteStatus as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, SearchIndexingNotificationState as V, PlacementType as W, DayOfWeek as X, ResolutionMethod as Y, WebhookIdentityType as Z, type Description as _, type UpdateProgramApplicationErrors as a, type WrongStartDateErrorDetails as a$, type FocalPoint as a0, type VideoResolution as a1, type Timeline as a2, type Restrictions as a3, type Money as a4, type Seo as a5, type SeoSchema as a6, type Keyword as a7, type Tag as a8, type Settings as a9, type ReindexMessageActionOneOf as aA, type Upsert as aB, type Delete as aC, type Schema as aD, type ProgramPublished as aE, type ProgramEnded as aF, type ProgramArchived as aG, type ProgramDuplicated as aH, type ProgramFreemiumEnabled as aI, type ProgramFreemiumDisabled as aJ, type CreateProgramRequest as aK, type CreateProgramResponse as aL, type BulkCreateProgramsMigrationRequest as aM, type ProgramMigration as aN, type BulkCreateProgramsMigrationResponse as aO, type BulkProgramResult as aP, type ItemMetadata as aQ, type ApplicationError as aR, type BulkActionMetadata as aS, type DeleteAllProgramsMigrationRequest as aT, type DeleteAllProgramsMigrationResponse as aU, type DuplicateProgramRequest as aV, type GetProgramRequest as aW, type GetProgramResponse as aX, type UpdateProgramRequest as aY, type UpdateProgramResponse as aZ, type WrongStateErrorDetails as a_, type Reward as aa, type Certificate as ab, type ExtendedFields as ac, type VideoStepsSettings as ad, type ContentSummary as ae, type FreemiumSettings as af, type UpdateDocumentsEvent as ag, type UpdateDocumentsEventOperationOneOf as ah, type DocumentUpdateOperation as ai, type IndexDocument as aj, type DocumentPayload as ak, type DocumentImage as al, type DeleteByIdsOperation as am, type DeleteByFilterOperation as an, type UpdateByFilterOperation as ao, type UpdateExistingOperation as ap, type InvalidateCache as aq, type InvalidateCacheGetByOneOf as ar, type App as as, type Page as at, type URI as au, type File as av, type CustomTag as aw, type Pages as ax, type URIs as ay, type ReindexMessage as az, type ProgramSearch as b, type LabeledProgram as b$, type WrongParticipantsNumberErrorDetails as b0, type DuplicatedSlugErrorDetails as b1, type TimelineSwitchForbiddenErrorDetails as b2, type DeleteProgramRequest as b3, type DeleteProgramResponse as b4, type QueryProgramsRequest as b5, type QueryV2 as b6, type QueryV2PagingMethodOneOf as b7, type Sorting as b8, type Paging as b9, type NestedAggregationResults as bA, type NestedAggregationResultsResultOneOf as bB, type ValueResults as bC, type RangeResults as bD, type AggregationResultsScalarResult as bE, type NestedValueAggregationResult as bF, type ValueResult as bG, type RangeResult as bH, type ScalarResult as bI, type NestedResultValue as bJ, type NestedResultValueResultOneOf as bK, type Results as bL, type DateHistogramResult as bM, type GroupByValueResults as bN, type DateHistogramResults as bO, type NestedResults as bP, type AggregationResults as bQ, type AggregationResultsResultOneOf as bR, type PublishProgramRequest as bS, type EndProgramRequest as bT, type ArchiveProgramRequest as bU, type EnableProgramFreemiumRequest as bV, type DisableProgramFreemiumRequest as bW, type BulkUpdateProgramsRequest as bX, type BulkUpdateProgramResult as bY, type CountProgramsRequest as bZ, type ListSampleProgramsRequest as b_, type CursorPaging as ba, type QueryProgramsResponse as bb, type PagingMetadataV2 as bc, type Cursors as bd, type SearchProgramsRequest as be, type CursorSearch as bf, type CursorSearchPagingMethodOneOf as bg, type Aggregation as bh, type AggregationKindOneOf as bi, type RangeBucket as bj, type IncludeMissingValuesOptions as bk, type ValueAggregation as bl, type ValueAggregationOptionsOneOf as bm, type RangeAggregation as bn, type ScalarAggregation as bo, type DateHistogramAggregation as bp, type NestedAggregationItem as bq, type NestedAggregationItemKindOneOf as br, type NestedAggregation as bs, type GroupByAggregation as bt, type GroupByAggregationKindOneOf as bu, type SearchDetails as bv, type CursorPagingMetadata as bw, type AggregationData as bx, type ValueAggregationResult as by, type RangeAggregationResult as bz, type PublishProgramResponse as c, type BaseEventMetadata as c$, type DomainEvent as c0, type DomainEventBodyOneOf as c1, type EntityCreatedEvent as c2, type RestoreInfo as c3, type EntityUpdatedEvent as c4, type EntityDeletedEvent as c5, type ActionEvent as c6, type Empty as c7, type ResolveProgramSlugRequest as c8, type ResolveProgramSlugResponse as c9, type WixelAssigned as cA, type WixelUnassigned as cB, type StudioTwoAssigned as cC, type StudioTwoUnassigned as cD, type UserDomainMediaEnabled as cE, type UserDomainMediaDisabled as cF, type EditorlessAssigned as cG, type EditorlessUnassigned as cH, type SearchIndexingNotification as cI, type SitePropertiesUpdated as cJ, type SitePropertiesEvent as cK, type Properties as cL, type Categories as cM, type Locale as cN, type Address as cO, type AddressHint as cP, type GeoCoordinates as cQ, type BusinessSchedule as cR, type TimePeriod as cS, type SpecialHourPeriod as cT, type Multilingual as cU, type SupportedLanguage as cV, type ConsentPolicy as cW, type MessageEnvelope as cX, type IdentificationData as cY, type IdentificationDataIdOneOf as cZ, type AccountInfo as c_, type MissingMetasiteIdErrorDetails as ca, type MetaSiteSpecialEvent as cb, type MetaSiteSpecialEventPayloadOneOf as cc, type Asset as cd, type SiteCreated as ce, type SiteTransferred as cf, type SiteDeleted as cg, type DeleteContext as ch, type SiteUndeleted as ci, type SitePublished as cj, type SiteUnpublished as ck, type SiteMarkedAsTemplate as cl, type SiteMarkedAsWixSite as cm, type ServiceProvisioned as cn, type ServiceRemoved as co, type SiteRenamed as cp, type SiteHardDeleted as cq, type NamespaceChanged as cr, type StudioAssigned as cs, type StudioUnassigned as ct, type SiteUrlChanged as cu, type SitePurgedExternally as cv, type OdeditorAssigned as cw, type OdeditorUnassigned as cx, type PicassoAssigned as cy, type PicassoUnassigned as cz, type PublishProgramApplicationErrors as d, type EventMetadata as d0, type AccountInfoMetadata as d1, type ProgramsQueryResult as d2, type ProgramQuerySpec as d3, type ProgramSearchSpec as d4, utils as d5, type StatusWithLiterals as d6, type AccessTypeWithLiterals as d7, type TriggerWithLiterals as d8, type EnumWithLiterals as d9, onProgramEnded as dA, onProgramPublished as dB, onProgramUpdated as dC, createProgram as dD, duplicateProgram as dE, getProgram as dF, updateProgram as dG, deleteProgram as dH, queryPrograms as dI, publishProgram as dJ, endProgram as dK, archiveProgram as dL, enableProgramFreemium as dM, disableProgramFreemium as dN, bulkUpdatePrograms as dO, countPrograms as dP, listSamplePrograms as dQ, type BulkActionTypeWithLiterals as da, type SortOrderWithLiterals as db, type SortTypeWithLiterals as dc, type SortDirectionWithLiterals as dd, type MissingValuesWithLiterals as de, type ScalarTypeWithLiterals as df, type NestedAggregationTypeWithLiterals as dg, type IntervalWithLiterals as dh, type AggregationTypeWithLiterals as di, type ModeWithLiterals as dj, type StateWithLiterals as dk, type SiteCreatedContextWithLiterals as dl, type NamespaceWithLiterals as dm, type DeleteStatusWithLiterals as dn, type SearchIndexingNotificationStateWithLiterals as dp, type PlacementTypeWithLiterals as dq, type DayOfWeekWithLiterals as dr, type ResolutionMethodWithLiterals as ds, type WebhookIdentityTypeWithLiterals as dt, type CommonQueryWithEntityContext as du, type CommonSearchWithEntityContext as dv, onProgramCreated as dw, onProgramDeleted as dx, onProgramArchived as dy, onProgramDuplicated as dz, type EnableProgramFreemiumResponse as e, type EnableProgramFreemiumApplicationErrors as f, type DisableProgramFreemiumResponse as g, type BulkUpdateProgramsResponse as h, type CountProgramsResponse as i, type ProgramCreatedEnvelope as j, type ProgramDeletedEnvelope as k, type ProgramArchivedEnvelope as l, type ProgramDuplicatedEnvelope as m, type ProgramEndedEnvelope as n, type ProgramPublishedEnvelope as o, type ProgramUpdatedEnvelope as p, type ProgramsQueryBuilder as q, type ProgramQuery as r, Status as s, typedQueryPrograms as t, AccessType as u, Enum as v, BulkActionType as w, SortOrder as x, SortType as y, SortDirection as z };
|