@wix/auto_sdk_online-programs_programs 1.0.18 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/build/cjs/index.d.ts +78 -37
  2. package/build/cjs/index.js +41 -45
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +7 -5
  5. package/build/cjs/index.typings.js +41 -45
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +216 -157
  8. package/build/cjs/meta.js +27 -43
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/{internal/cjs/online-programs-v3-program-programs.universal-DYH-_E7Y.d.ts → cjs/online-programs-v3-program-programs.universal-ClIi92UD.d.ts} +346 -306
  11. package/build/cjs/schemas.d.ts +1895 -0
  12. package/build/cjs/schemas.js +3155 -0
  13. package/build/cjs/schemas.js.map +1 -0
  14. package/build/es/index.d.mts +78 -37
  15. package/build/es/index.mjs +39 -42
  16. package/build/es/index.mjs.map +1 -1
  17. package/build/es/index.typings.d.mts +7 -5
  18. package/build/es/index.typings.mjs +39 -42
  19. package/build/es/index.typings.mjs.map +1 -1
  20. package/build/es/meta.d.mts +216 -157
  21. package/build/es/meta.mjs +27 -41
  22. package/build/es/meta.mjs.map +1 -1
  23. package/build/{internal/es/online-programs-v3-program-programs.universal-DYH-_E7Y.d.mts → es/online-programs-v3-program-programs.universal-ClIi92UD.d.mts} +346 -306
  24. package/build/es/schemas.d.mts +1895 -0
  25. package/build/es/schemas.mjs +3093 -0
  26. package/build/es/schemas.mjs.map +1 -0
  27. package/build/internal/cjs/index.d.ts +78 -37
  28. package/build/internal/cjs/index.js +41 -45
  29. package/build/internal/cjs/index.js.map +1 -1
  30. package/build/internal/cjs/index.typings.d.ts +7 -5
  31. package/build/internal/cjs/index.typings.js +41 -45
  32. package/build/internal/cjs/index.typings.js.map +1 -1
  33. package/build/internal/cjs/meta.d.ts +216 -157
  34. package/build/internal/cjs/meta.js +27 -43
  35. package/build/internal/cjs/meta.js.map +1 -1
  36. package/build/{cjs/online-programs-v3-program-programs.universal-nj9IWrAz.d.ts → internal/cjs/online-programs-v3-program-programs.universal-ClIi92UD.d.ts} +356 -288
  37. package/build/internal/cjs/schemas.d.ts +1895 -0
  38. package/build/internal/cjs/schemas.js +3155 -0
  39. package/build/internal/cjs/schemas.js.map +1 -0
  40. package/build/internal/es/index.d.mts +78 -37
  41. package/build/internal/es/index.mjs +39 -42
  42. package/build/internal/es/index.mjs.map +1 -1
  43. package/build/internal/es/index.typings.d.mts +7 -5
  44. package/build/internal/es/index.typings.mjs +39 -42
  45. package/build/internal/es/index.typings.mjs.map +1 -1
  46. package/build/internal/es/meta.d.mts +216 -157
  47. package/build/internal/es/meta.mjs +27 -41
  48. package/build/internal/es/meta.mjs.map +1 -1
  49. package/build/{es/online-programs-v3-program-programs.universal-nj9IWrAz.d.mts → internal/es/online-programs-v3-program-programs.universal-ClIi92UD.d.mts} +356 -288
  50. package/build/internal/es/schemas.d.mts +1895 -0
  51. package/build/internal/es/schemas.mjs +3093 -0
  52. package/build/internal/es/schemas.mjs.map +1 -0
  53. package/package.json +12 -5
  54. package/schemas/package.json +3 -0
@@ -1,5 +1,11 @@
1
+ import * as _wix_sdk_types from '@wix/sdk-types';
1
2
  import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
2
3
 
4
+ /**
5
+ * A program is an Online Programs course, challenge, or structured journey.
6
+ * Programs contain lifecycle state, public description, timeline, access rules,
7
+ * pricing, SEO, rewards, and summary information for their content.
8
+ */
3
9
  interface Program {
4
10
  /**
5
11
  * Program ID.
@@ -7,118 +13,110 @@ interface Program {
7
13
  * @readonly
8
14
  */
9
15
  _id?: string | null;
10
- /** @readonly */
16
+ /**
17
+ * Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating a program.
18
+ * @readonly
19
+ */
11
20
  revision?: string | null;
12
- /** @readonly */
21
+ /**
22
+ * Date and time the program was created.
23
+ * @readonly
24
+ */
13
25
  _createdDate?: Date | null;
14
- /** @readonly */
15
- _updatedDate?: Date | null;
16
26
  /**
17
- * current program state / does participant need it?
27
+ * Date and time the program was last updated.
18
28
  * @readonly
19
- * @deprecated
20
- * @replacedBy status
21
- * @targetRemovalDate 2025-10-15
22
29
  */
23
- state?: V3StateWithLiterals;
30
+ _updatedDate?: Date | null;
24
31
  /**
25
- * current program state in v2 format
32
+ * Current program lifecycle status.
26
33
  * @readonly
27
34
  */
28
35
  status?: StatusWithLiterals;
29
36
  /**
30
- * assigned categories
37
+ * Date and time when `status` last changed.
38
+ * @readonly
39
+ */
40
+ statusUpdatedDate?: Date | null;
41
+ /**
42
+ * Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories.
31
43
  * @readonly
32
44
  * @format GUID
33
45
  * @maxSize 10
34
46
  */
35
47
  categoryIds?: string[];
36
- /** general program info. */
48
+ /** Public-facing program title, details, and media. */
37
49
  description?: Description;
38
- /** timeline type -> Self-paced, time-restricted. */
50
+ /** Program timeline settings. Use this to configure self-paced or scheduled programs. */
39
51
  timeline?: Timeline;
40
- /** participant limitation, step-completion pace and etc. */
52
+ /** Program access, participation, and progression rules. */
41
53
  restrictions?: Restrictions;
42
- /** single-payment price. */
54
+ /** Optional one-time payment price for joining the program. */
43
55
  price?: Money;
44
- /** seo settings. */
56
+ /** SEO settings used for the program page. */
45
57
  seo?: Seo;
46
58
  /**
47
- * rewards to be assigned after reaching some of the program milestones.
59
+ * Rewards assigned to participants when they reach configured milestones.
48
60
  * @maxSize 10
49
61
  */
50
62
  rewards?: Reward[];
51
63
  /**
52
- * connected social group.
64
+ * ID of the social group connected to the program, if one exists.
53
65
  * @format GUID
54
66
  */
55
67
  socialGroupId?: string | null;
56
- /**
57
- * join flow options.
58
- * @deprecated
59
- * @replacedBy restrictions.access_type
60
- * @targetRemovalDate 2025-10-15
61
- */
62
- accessType?: AccessTypeWithLiterals;
63
- /** extensible field */
68
+ /** Custom fields for apps that extend the Program entity. */
64
69
  extendedFields?: ExtendedFields;
65
- /** if true -> invoice is sent to the customer who purchased the program via single payment; else -> payment confirmation email is sent */
70
+ /** Whether to send an invoice after a single-payment purchase. When false, the buyer receives a payment confirmation email instead. */
66
71
  shouldSendInvoice?: boolean;
67
- /** settings related to video steps in programs */
72
+ /** Settings that control how video steps behave in this program. */
68
73
  videoStepsSettings?: VideoStepsSettings;
69
74
  /**
70
- * number of content entities in program
75
+ * Read-only counts of content entities in the program.
71
76
  * @readonly
72
77
  */
73
78
  contentSummary?: ContentSummary;
74
79
  /**
75
- * user id of owner, who created this program
80
+ * ID of the site user who created the program.
76
81
  * @format GUID
77
82
  * @readonly
78
83
  */
79
84
  ownerUserId?: string | null;
80
85
  }
81
- declare enum V3State {
82
- /** not published program, visible only on BM */
83
- DRAFT = "DRAFT",
84
- /** program visible regarding to restrictions */
85
- PUBLISHED = "PUBLISHED",
86
- /** program isn't available to join. */
87
- ENDED = "ENDED",
88
- /** closed program. Joins and sections/steps are not available for participants. */
89
- ARCHIVED = "ARCHIVED"
90
- }
91
- /** @enumType */
92
- type V3StateWithLiterals = V3State | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
93
86
  declare enum Status {
94
- /** unknown state */
95
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
96
- /** not published program, visible only on BM */
87
+ /** The program is editable and visible only in management contexts. */
97
88
  DRAFT = "DRAFT",
98
- /** program visible regarding to restrictions */
89
+ /** The program is available according to its access restrictions. */
99
90
  PUBLISHED = "PUBLISHED",
100
- /** program isn't available to join. */
91
+ /** The program is no longer available for new participation. */
101
92
  ENDED = "ENDED",
102
- /** closed program. Joins and sections/steps are not available for participants. */
93
+ /** The program is closed and removed from normal public discovery. */
103
94
  ARCHIVED = "ARCHIVED"
104
95
  }
105
96
  /** @enumType */
106
- type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
97
+ type StatusWithLiterals = Status | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
98
+ /** Public program description and media. */
107
99
  interface Description extends DescriptionMediaOneOf {
108
- /** WixMedia image */
100
+ /** Program image. */
109
101
  image?: string;
110
- /** WixMedia video */
102
+ /** Program video. */
111
103
  video?: string;
112
- /** @maxLength 150 */
104
+ /**
105
+ * Program title.
106
+ * @maxLength 150
107
+ */
113
108
  title?: string;
114
- /** @maxLength 8000 */
109
+ /**
110
+ * Detailed program description.
111
+ * @maxLength 8000
112
+ */
115
113
  details?: string | null;
116
114
  }
117
115
  /** @oneof */
118
116
  interface DescriptionMediaOneOf {
119
- /** WixMedia image */
117
+ /** Program image. */
120
118
  image?: string;
121
- /** WixMedia video */
119
+ /** Program video. */
122
120
  video?: string;
123
121
  }
124
122
  interface FocalPoint {
@@ -141,44 +139,44 @@ interface VideoResolution {
141
139
  /** Video format for example, mp4, hls. */
142
140
  format?: string;
143
141
  }
142
+ /** Program scheduling settings. */
144
143
  interface Timeline {
145
- /** are sections/steps evaluated every day? Or can UoU participate in a self paced mode? */
144
+ /** Whether participants can progress at their own pace. */
146
145
  selfPaced?: boolean;
147
146
  /**
148
- * everyone starts on this day
147
+ * Local date when the scheduled program starts.
149
148
  * @format LOCAL_DATE
150
149
  */
151
150
  startDate?: string | null;
152
- /** duration of program in days (if applicable). */
151
+ /** Scheduled program duration in days. */
153
152
  durationInDays?: number | null;
154
153
  }
154
+ /** Access and participation restrictions for a program. */
155
155
  interface Restrictions {
156
156
  /**
157
- * limit of active participants in the program.
157
+ * Maximum number of active participants allowed in the program.
158
158
  * @min 1
159
159
  */
160
160
  maxParticipants?: number | null;
161
- /** hide steps in the Pending state. */
161
+ /** Whether future steps are hidden from participants until they become available. */
162
162
  hideFutureSteps?: boolean;
163
- /** allow participants complete steps in the certain order. */
163
+ /** Whether participants must complete steps in order. */
164
164
  resolveStepsInOrder?: boolean;
165
- /** allow program participants to share their progress in group */
165
+ /** Whether participants can share progress in the connected group. */
166
166
  shareProgress?: boolean;
167
- /** access restrictions options regarding visibility. */
168
- accessType?: RestrictionsAccessTypeWithLiterals;
167
+ /** Program discovery and join access. */
168
+ accessType?: AccessTypeWithLiterals;
169
169
  }
170
- declare enum RestrictionsAccessType {
171
- /** unknown access type */
172
- UNKNOWN_ACCESS_TYPE = "UNKNOWN_ACCESS_TYPE",
173
- /** join without approvals */
170
+ declare enum AccessType {
171
+ /** Anyone who can access the site can discover the program and start the join flow. */
174
172
  PUBLIC = "PUBLIC",
175
- /** send a join request to the owner and get an approval from him. */
173
+ /** The program can be discovered, but joining requires owner approval. */
176
174
  PRIVATE = "PRIVATE",
177
- /** join possible only after owner invite. */
175
+ /** The program is hidden from public discovery and visible only to participants, owners, and trusted apps. */
178
176
  SECRET = "SECRET"
179
177
  }
180
178
  /** @enumType */
181
- type RestrictionsAccessTypeWithLiterals = RestrictionsAccessType | 'UNKNOWN_ACCESS_TYPE' | 'PUBLIC' | 'PRIVATE' | 'SECRET';
179
+ type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET';
182
180
  /**
183
181
  * Money.
184
182
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
@@ -196,31 +194,32 @@ interface Money {
196
194
  */
197
195
  currency?: string;
198
196
  }
197
+ /** SEO settings for the program page. */
199
198
  interface Seo {
200
199
  /**
201
- * program slug expression
200
+ * Unique URL slug for the program page.
202
201
  * @format URL_SLUG
203
202
  */
204
203
  slug?: string;
205
- /** schema used by Seo team */
204
+ /** Advanced SEO schema data. */
206
205
  seoData?: SeoSchema;
207
206
  /**
208
- * program url
207
+ * Program page URL.
209
208
  * @readonly
210
209
  */
211
210
  url?: string;
212
211
  /**
213
- * image url from description media
212
+ * Image URL derived from the program description media.
214
213
  * @format WEB_URL
215
214
  */
216
215
  imageUrl?: string | null;
217
216
  /**
218
- * alt text of image
217
+ * Alternative text for the SEO image.
219
218
  * @maxLength 1000
220
219
  */
221
220
  imageAlt?: string;
222
221
  /**
223
- * Approximate SEO program duration in Iso-8601
222
+ * Approximate SEO program duration in ISO 8601 duration format.
224
223
  * @maxLength 100
225
224
  * @readonly
226
225
  */
@@ -284,47 +283,39 @@ interface Settings {
284
283
  */
285
284
  keywords?: Keyword[];
286
285
  }
286
+ /** Reward configuration for a program milestone. */
287
287
  interface Reward {
288
- /** on which action rewards must be assigned. */
288
+ /** Program milestone that grants the reward. If omitted, the trigger defaults to `JOINED_TO_PROGRAM` for compatibility with existing rewards. */
289
289
  trigger?: TriggerWithLiterals;
290
290
  /**
291
- * badges participant will get on program complete
291
+ * Badge IDs to assign when the reward is granted.
292
292
  * @format GUID
293
293
  * @maxSize 50
294
294
  */
295
295
  badgeIds?: string[];
296
- /** certificate for program. Currently is program GUID */
296
+ /** Certificate assigned when the reward is granted. */
297
297
  certificate?: Certificate;
298
298
  }
299
299
  declare enum Trigger {
300
- /** member joins the program */
300
+ /** Default trigger for existing rewards. The reward is granted when a member joins the program. */
301
301
  JOINED_TO_PROGRAM = "JOINED_TO_PROGRAM",
302
- /** at least one step completed */
302
+ /** The reward is granted when at least one step is completed. */
303
303
  STEP_COMPLETED = "STEP_COMPLETED",
304
- /** all steps are completed. */
304
+ /** The reward is granted when all required steps are completed. */
305
305
  ALL_STEPS_COMPLETED = "ALL_STEPS_COMPLETED"
306
306
  }
307
307
  /** @enumType */
308
308
  type TriggerWithLiterals = Trigger | 'JOINED_TO_PROGRAM' | 'STEP_COMPLETED' | 'ALL_STEPS_COMPLETED';
309
+ /** Certificate reward metadata. */
309
310
  interface Certificate {
310
311
  /**
311
- * Certificate for program completion. Currently is program GUID
312
+ * Certificate ID. Currently this is the program GUID.
312
313
  * @format GUID
313
314
  */
314
315
  _id?: string;
315
- /** date it was connected to program */
316
+ /** Date and time the certificate was connected to the program. */
316
317
  connectedDate?: Date | null;
317
318
  }
318
- declare enum AccessType {
319
- /** join without approvals */
320
- PUBLIC = "PUBLIC",
321
- /** send a join request to the owner and get an approval from him. */
322
- PRIVATE = "PRIVATE",
323
- /** join possible only after owner invite. */
324
- SECRET = "SECRET"
325
- }
326
- /** @enumType */
327
- type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET';
328
319
  interface ExtendedFields {
329
320
  /**
330
321
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -336,20 +327,22 @@ interface ExtendedFields {
336
327
  */
337
328
  namespaces?: Record<string, Record<string, any>>;
338
329
  }
330
+ /** Video step playback and completion settings. */
339
331
  interface VideoStepsSettings {
340
- /** automatically switch to next video step after finishing current one */
332
+ /** Whether the participant is automatically moved to the next video step after finishing the current one. */
341
333
  autoNavigate?: boolean;
342
- /** how many percents of video need to be watched to complete step */
334
+ /** Percentage of a video that must be watched to complete a video step. */
343
335
  requiredCompletionPercentage?: number;
344
336
  }
337
+ /** Read-only summary of program content. */
345
338
  interface ContentSummary {
346
339
  /**
347
- * number of steps in program
340
+ * Number of steps in the program.
348
341
  * @max 3000
349
342
  */
350
343
  stepCount?: number;
351
344
  /**
352
- * number of sections in program
345
+ * Number of sections in the program.
353
346
  * @max 1000
354
347
  */
355
348
  sectionCount?: number;
@@ -486,6 +479,10 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
486
479
  file?: File;
487
480
  /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
488
481
  customTag?: CustomTag;
482
+ /** Invalidate by multiple page ids */
483
+ pages?: Pages;
484
+ /** Invalidate by multiple URI paths */
485
+ uris?: URIs;
489
486
  /**
490
487
  * tell us why you're invalidating the cache. You don't need to add your app name
491
488
  * @maxLength 256
@@ -494,6 +491,14 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
494
491
  /** Is local DS */
495
492
  localDc?: boolean;
496
493
  hardPurge?: boolean;
494
+ /**
495
+ * Optional caller-provided ID for tracking this invalidation through the system.
496
+ * When set, the corresponding CDN purge completion event will include this ID,
497
+ * allowing you to confirm when the invalidation has fully propagated.
498
+ * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
499
+ * @maxLength 256
500
+ */
501
+ correlationId?: string | null;
497
502
  }
498
503
  /** @oneof */
499
504
  interface InvalidateCacheGetByOneOf {
@@ -517,6 +522,10 @@ interface InvalidateCacheGetByOneOf {
517
522
  file?: File;
518
523
  /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
519
524
  customTag?: CustomTag;
525
+ /** Invalidate by multiple page ids */
526
+ pages?: Pages;
527
+ /** Invalidate by multiple URI paths */
528
+ uris?: URIs;
520
529
  }
521
530
  interface App {
522
531
  /**
@@ -580,6 +589,32 @@ interface CustomTag {
580
589
  */
581
590
  tag?: string;
582
591
  }
592
+ interface Pages {
593
+ /**
594
+ * the msid the pages are on
595
+ * @format GUID
596
+ */
597
+ metaSiteId?: string;
598
+ /**
599
+ * Invalidate by multiple Page IDs in a single message
600
+ * @maxSize 100
601
+ * @minLength 1
602
+ */
603
+ pageIds?: string[];
604
+ }
605
+ interface URIs {
606
+ /**
607
+ * the msid the URIs are on
608
+ * @format GUID
609
+ */
610
+ metaSiteId?: string;
611
+ /**
612
+ * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
613
+ * @maxSize 100
614
+ * @minLength 1
615
+ */
616
+ uriPaths?: string[];
617
+ }
583
618
  /**
584
619
  * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
585
620
  * performs context manipulation with adding tenant, provided in message to callscope.
@@ -612,25 +647,25 @@ interface Schema {
612
647
  interface ProgramPublished {
613
648
  }
614
649
  interface ProgramEnded {
615
- /** true if ended manually by owner */
650
+ /** Whether the program was ended manually by the owner. */
616
651
  endedByOwner?: boolean;
617
652
  }
618
653
  interface ProgramArchived {
619
654
  }
620
655
  interface ProgramDuplicated {
621
- /** Newly created program */
656
+ /** Newly created program. */
622
657
  program?: Program;
623
- /** Program that was duplicated */
658
+ /** Program that was duplicated. */
624
659
  duplicatedFrom?: Program;
625
- /** Indicates if the program was cloned from a template */
660
+ /** Whether the program was cloned from a template. */
626
661
  fromTemplate?: boolean;
627
662
  }
628
663
  interface CreateProgramRequest {
629
- /** Program to be created. */
664
+ /** Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. */
630
665
  program: Program;
631
666
  }
632
667
  interface CreateProgramResponse {
633
- /** The created Program. */
668
+ /** Created draft program. */
634
669
  program?: Program;
635
670
  }
636
671
  interface BulkCreateProgramsMigrationRequest {
@@ -715,32 +750,32 @@ interface DeleteAllProgramsMigrationResponse {
715
750
  }
716
751
  interface DuplicateProgramRequest {
717
752
  /**
718
- * Program to be duplicated from.
753
+ * ID of the program to duplicate.
719
754
  * @format GUID
720
755
  */
721
756
  programId: string;
722
757
  }
723
758
  interface DuplicateProgramResponse {
724
- /** The created Program. */
759
+ /** New draft program created from the source program. */
725
760
  program?: Program;
726
761
  }
727
762
  interface GetProgramRequest {
728
763
  /**
729
- * ID of the Program to retrieve.
764
+ * ID of the program to retrieve.
730
765
  * @format GUID
731
766
  */
732
767
  programId: string;
733
768
  }
734
769
  interface GetProgramResponse {
735
- /** The requested Program. */
770
+ /** Requested program. */
736
771
  program?: Program;
737
772
  }
738
773
  interface UpdateProgramRequest {
739
- /** Program to be updated, may be partial. */
774
+ /** Program fields to update. Include `id` and the latest `revision`. */
740
775
  program: Program;
741
776
  }
742
777
  interface UpdateProgramResponse {
743
- /** Updated Program. */
778
+ /** Updated program. */
744
779
  program?: Program;
745
780
  }
746
781
  interface WrongStateErrorDetails {
@@ -748,7 +783,7 @@ interface WrongStateErrorDetails {
748
783
  interface WrongStartDateErrorDetails {
749
784
  }
750
785
  interface WrongParticipantsNumberErrorDetails {
751
- /** Participants that already joined the program */
786
+ /** Number of active participants already in the program. */
752
787
  activeParticipantsCount?: number;
753
788
  }
754
789
  interface DuplicatedSlugErrorDetails {
@@ -757,7 +792,7 @@ interface TimelineSwitchForbiddenErrorDetails {
757
792
  }
758
793
  interface DeleteProgramRequest {
759
794
  /**
760
- * Id of the Program to delete.
795
+ * ID of the program to delete.
761
796
  * @format GUID
762
797
  */
763
798
  programId: string;
@@ -765,7 +800,7 @@ interface DeleteProgramRequest {
765
800
  interface DeleteProgramResponse {
766
801
  }
767
802
  interface QueryProgramsRequest {
768
- /** Query to filter programs */
803
+ /** Query used to filter, sort, and page programs. */
769
804
  query?: QueryV2;
770
805
  }
771
806
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -776,13 +811,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
776
811
  /**
777
812
  * Filter object.
778
813
  *
779
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
814
+ * Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
780
815
  */
781
816
  filter?: Record<string, any> | null;
782
817
  /**
783
818
  * Sort object.
784
819
  *
785
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
820
+ * Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
786
821
  * @maxSize 100
787
822
  */
788
823
  sort?: Sorting[];
@@ -842,9 +877,9 @@ interface CursorPaging {
842
877
  cursor?: string | null;
843
878
  }
844
879
  interface QueryProgramsResponse {
845
- /** Found programs */
880
+ /** Programs that match the query and caller visibility. */
846
881
  programs?: Program[];
847
- /** paging */
882
+ /** Paging metadata for the query response. */
848
883
  pagingMetadata?: PagingMetadataV2;
849
884
  }
850
885
  interface PagingMetadataV2 {
@@ -872,26 +907,26 @@ interface Cursors {
872
907
  prev?: string | null;
873
908
  }
874
909
  interface SearchProgramsRequest {
875
- /** Query to search programs */
910
+ /** Search expression, filters, sorting, and cursor paging options. */
876
911
  search?: CursorSearch;
877
912
  }
878
913
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
879
914
  /**
880
915
  * Cursor paging options.
881
916
  *
882
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
917
+ * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
883
918
  */
884
919
  cursorPaging?: CursorPaging;
885
920
  /**
886
921
  * Filter object.
887
922
  *
888
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
923
+ * Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
889
924
  */
890
925
  filter?: Record<string, any> | null;
891
926
  /**
892
927
  * List of sort objects.
893
928
  *
894
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
929
+ * Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
895
930
  * @maxSize 10
896
931
  */
897
932
  sort?: Sorting[];
@@ -919,7 +954,7 @@ interface CursorSearchPagingMethodOneOf {
919
954
  /**
920
955
  * Cursor paging options.
921
956
  *
922
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
957
+ * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
923
958
  */
924
959
  cursorPaging?: CursorPaging;
925
960
  }
@@ -1005,7 +1040,6 @@ interface IncludeMissingValuesOptions {
1005
1040
  addToBucket?: string;
1006
1041
  }
1007
1042
  declare enum ScalarType {
1008
- UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1009
1043
  /** Count of distinct values. */
1010
1044
  COUNT_DISTINCT = "COUNT_DISTINCT",
1011
1045
  /** Minimum value. */
@@ -1014,7 +1048,7 @@ declare enum ScalarType {
1014
1048
  MAX = "MAX"
1015
1049
  }
1016
1050
  /** @enumType */
1017
- type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1051
+ type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1018
1052
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
1019
1053
  /** Options for including missing values. */
1020
1054
  includeOptions?: IncludeMissingValuesOptions;
@@ -1033,7 +1067,6 @@ interface ValueAggregationOptionsOneOf {
1033
1067
  includeOptions?: IncludeMissingValuesOptions;
1034
1068
  }
1035
1069
  declare enum NestedAggregationType {
1036
- UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1037
1070
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1038
1071
  VALUE = "VALUE",
1039
1072
  /** An aggregation, where user can define set of ranges - each representing a bucket. */
@@ -1044,7 +1077,7 @@ declare enum NestedAggregationType {
1044
1077
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1045
1078
  }
1046
1079
  /** @enumType */
1047
- type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1080
+ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1048
1081
  interface RangeAggregation {
1049
1082
  /**
1050
1083
  * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
@@ -1061,7 +1094,6 @@ interface DateHistogramAggregation {
1061
1094
  interval?: IntervalWithLiterals;
1062
1095
  }
1063
1096
  declare enum Interval {
1064
- UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1065
1097
  /** Yearly interval */
1066
1098
  YEAR = "YEAR",
1067
1099
  /** Monthly interval */
@@ -1078,7 +1110,7 @@ declare enum Interval {
1078
1110
  SECOND = "SECOND"
1079
1111
  }
1080
1112
  /** @enumType */
1081
- type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1113
+ type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1082
1114
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1083
1115
  /** Value aggregation. */
1084
1116
  value?: ValueAggregation;
@@ -1113,7 +1145,6 @@ interface NestedAggregationItemKindOneOf {
1113
1145
  dateHistogram?: DateHistogramAggregation;
1114
1146
  }
1115
1147
  declare enum AggregationType {
1116
- UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1117
1148
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1118
1149
  VALUE = "VALUE",
1119
1150
  /** An aggregation, where user can define set of ranges - each representing a bucket. */
@@ -1126,7 +1157,7 @@ declare enum AggregationType {
1126
1157
  NESTED = "NESTED"
1127
1158
  }
1128
1159
  /** @enumType */
1129
- type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1160
+ type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1130
1161
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
1131
1162
  interface NestedAggregation {
1132
1163
  /**
@@ -1181,11 +1212,11 @@ declare enum Mode {
1181
1212
  /** @enumType */
1182
1213
  type ModeWithLiterals = Mode | 'OR' | 'AND';
1183
1214
  interface SearchProgramsResponse {
1184
- /** Found programs */
1215
+ /** Programs that match the search and caller visibility. */
1185
1216
  programs?: Program[];
1186
- /** paging */
1217
+ /** Cursor paging metadata. */
1187
1218
  pagingMetadata?: CursorPagingMetadata;
1188
- /** aggregation */
1219
+ /** Aggregation data returned by the search backend. */
1189
1220
  aggregationData?: AggregationData;
1190
1221
  }
1191
1222
  interface CursorPagingMetadata {
@@ -1406,90 +1437,91 @@ interface AggregationResultsResultOneOf {
1406
1437
  }
1407
1438
  interface PublishProgramRequest {
1408
1439
  /**
1409
- * Program to publish
1440
+ * ID of the draft program to publish.
1410
1441
  * @format GUID
1411
1442
  */
1412
1443
  programId: string;
1413
1444
  }
1414
1445
  interface PublishProgramResponse {
1415
- /** Published program */
1446
+ /** Published program. */
1416
1447
  program?: Program;
1417
1448
  }
1418
1449
  interface EndProgramRequest {
1419
1450
  /**
1420
- * Program to finish
1451
+ * ID of the published program to end.
1421
1452
  * @format GUID
1422
1453
  */
1423
1454
  programId: string;
1424
1455
  }
1425
1456
  interface EndProgramResponse {
1426
- /** Finished program */
1457
+ /** Ended program. */
1427
1458
  program?: Program;
1428
1459
  }
1429
1460
  interface ArchiveProgramRequest {
1430
1461
  /**
1431
- * Program to archive
1462
+ * ID of the program to archive.
1432
1463
  * @format GUID
1433
1464
  */
1434
1465
  programId: string;
1435
1466
  }
1436
1467
  interface ArchiveProgramResponse {
1437
- /** Archived program */
1468
+ /** Archived program. */
1438
1469
  program?: Program;
1439
1470
  }
1440
1471
  interface BulkUpdateProgramsRequest {
1441
1472
  /**
1442
- * List of programs you want to update
1473
+ * Programs to update. Each item contains partial program data.
1443
1474
  * @minSize 1
1444
1475
  * @maxSize 100
1445
1476
  */
1446
1477
  programs: MaskedProgram[];
1447
- /** set to `true` if you wish to receive back the created programs in the response */
1478
+ /** Whether to return updated programs in the response. */
1448
1479
  returnEntity?: boolean;
1449
1480
  }
1450
1481
  interface MaskedProgram {
1451
- /** Program to be updated, may be partial */
1482
+ /** Partial program to update. Include `id` and the latest `revision`. */
1452
1483
  program?: Program;
1453
- /** Explicit list of fields to update. */
1484
+ /** The list of fields to update for this program. For REST requests, this list is inferred from the request body. */
1454
1485
  fieldMask?: string[];
1455
1486
  }
1456
1487
  interface BulkUpdateProgramsResponse {
1457
1488
  /**
1489
+ * Per-item update results.
1458
1490
  * @minSize 1
1459
1491
  * @maxSize 100
1460
1492
  */
1461
1493
  results?: BulkUpdateProgramResult[];
1462
- /** metadata */
1494
+ /** Summary metadata for the bulk update. */
1463
1495
  bulkActionMetadata?: BulkActionMetadata;
1464
1496
  }
1465
1497
  interface BulkUpdateProgramResult {
1466
- /** item metadata */
1498
+ /** Result metadata for this item. */
1467
1499
  itemMetadata?: ItemMetadata;
1468
- /** Only exists if `returnEntity` was set to true in the request */
1500
+ /** Updated program. This is returned only when `return_entity` is true. */
1469
1501
  item?: Program;
1470
1502
  }
1471
1503
  interface CountProgramsRequest {
1472
- /** filter for which count is requested */
1504
+ /** WQL filter for the programs to count. */
1473
1505
  filter?: Record<string, any> | null;
1474
1506
  }
1475
1507
  interface CountProgramsResponse {
1476
- /** count of programs matching filter */
1508
+ /** Number of programs matching the filter and caller visibility. */
1477
1509
  count?: number;
1478
1510
  }
1479
1511
  interface ListSampleProgramsRequest {
1480
1512
  }
1481
1513
  interface ListSampleProgramsResponse {
1482
1514
  /**
1483
- * sample programs
1515
+ * Sample programs available as templates.
1484
1516
  * @maxSize 100
1485
1517
  */
1486
1518
  programs?: LabeledProgram[];
1487
1519
  }
1488
1520
  interface LabeledProgram {
1489
- /** sample program */
1521
+ /** Sample program. */
1490
1522
  program?: Program;
1491
1523
  /**
1492
- * label, showing category for program
1524
+ * Display label for the sample program.
1493
1525
  * @maxLength 1000
1494
1526
  */
1495
1527
  label?: string;
@@ -1523,7 +1555,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
1523
1555
  /** If present, indicates the action that triggered the event. */
1524
1556
  originatedFrom?: string | null;
1525
1557
  /**
1526
- * 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.
1558
+ * 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.
1527
1559
  * 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.
1528
1560
  */
1529
1561
  entityEventSequence?: string | null;
@@ -1632,6 +1664,10 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1632
1664
  userDomainMediaEnabled?: UserDomainMediaEnabled;
1633
1665
  /** Emitted when media from user domain is disabled. */
1634
1666
  userDomainMediaDisabled?: UserDomainMediaDisabled;
1667
+ /** Emitted when Editorless is attached. */
1668
+ editorlessAssigned?: EditorlessAssigned;
1669
+ /** Emitted when Editorless is detached. */
1670
+ editorlessUnassigned?: EditorlessUnassigned;
1635
1671
  /**
1636
1672
  * A meta site id.
1637
1673
  * @format GUID
@@ -1710,6 +1746,10 @@ interface MetaSiteSpecialEventPayloadOneOf {
1710
1746
  userDomainMediaEnabled?: UserDomainMediaEnabled;
1711
1747
  /** Emitted when media from user domain is disabled. */
1712
1748
  userDomainMediaDisabled?: UserDomainMediaDisabled;
1749
+ /** Emitted when Editorless is attached. */
1750
+ editorlessAssigned?: EditorlessAssigned;
1751
+ /** Emitted when Editorless is detached. */
1752
+ editorlessUnassigned?: EditorlessUnassigned;
1713
1753
  }
1714
1754
  interface Asset {
1715
1755
  /**
@@ -1867,10 +1907,19 @@ declare enum Namespace {
1867
1907
  /** Base44 headless sites. */
1868
1908
  BASE44 = "BASE44",
1869
1909
  /** Wix Channels Sites */
1870
- CHANNELS = "CHANNELS"
1910
+ CHANNELS = "CHANNELS",
1911
+ /** Nautilus platform. */
1912
+ NAUTILUS = "NAUTILUS",
1913
+ /**
1914
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
1915
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
1916
+ */
1917
+ SYMPHONY = "SYMPHONY",
1918
+ /** Nautilus platform app. */
1919
+ NAUTILUS_APPS = "NAUTILUS_APPS"
1871
1920
  }
1872
1921
  /** @enumType */
1873
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS';
1922
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS';
1874
1923
  /** Site transferred to another user. */
1875
1924
  interface SiteTransferred {
1876
1925
  /**
@@ -2078,6 +2127,12 @@ interface UserDomainMediaEnabled {
2078
2127
  /** Media from user domain is disabled. */
2079
2128
  interface UserDomainMediaDisabled {
2080
2129
  }
2130
+ /** Assigned Editorless */
2131
+ interface EditorlessAssigned {
2132
+ }
2133
+ /** Unassigned Editorless */
2134
+ interface EditorlessUnassigned {
2135
+ }
2081
2136
  interface SearchIndexingNotification {
2082
2137
  /** new state of indexing for the site specified in ms_id */
2083
2138
  indexState?: SearchIndexingNotificationStateWithLiterals;
@@ -2172,6 +2227,11 @@ interface Properties {
2172
2227
  externalSiteUrl?: string | null;
2173
2228
  /** Track clicks analytics. */
2174
2229
  trackClicksAnalytics?: boolean;
2230
+ /**
2231
+ * Company ID issued to the business by local authorities. Appears on invoices and price quotes.
2232
+ * @maxLength 50
2233
+ */
2234
+ companyId?: string | null;
2175
2235
  }
2176
2236
  interface Categories {
2177
2237
  /** Primary site category. */
@@ -2464,54 +2524,71 @@ type PublishProgramApplicationErrors = {
2464
2524
  data?: Record<string, any>;
2465
2525
  };
2466
2526
  /**
2467
- * Creates a Program.
2468
- * @param program - Program to be created.
2527
+ * Creates a draft program.
2528
+ *
2529
+ * The service sets the program ID, revision, creation dates, owner, and initial
2530
+ * `DRAFT` status. Publish the program when it's ready to be visible
2531
+ * according to its access restrictions.
2532
+ * @param program - Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create.
2469
2533
  * @public
2470
- * @documentationMaturity preview
2471
2534
  * @requiredField program
2472
2535
  * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE
2473
2536
  * @applicableIdentity APP
2474
- * @returns The created Program.
2537
+ * @returns Created draft program.
2475
2538
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.CreateProgram
2476
2539
  */
2477
- declare function createProgram(program: Program): Promise<NonNullablePaths<Program, `state` | `status` | `categoryIds` | `description.title` | `timeline.selfPaced` | `restrictions.hideFutureSteps` | `restrictions.resolveStepsInOrder` | `restrictions.shareProgress` | `restrictions.accessType` | `price.value` | `price.currency` | `seo.slug` | `seo.seoData.tags` | `seo.seoData.tags.${number}.type` | `seo.seoData.tags.${number}.children` | `seo.seoData.tags.${number}.custom` | `seo.seoData.tags.${number}.disabled` | `seo.seoData.settings.preventAutoRedirect` | `seo.seoData.settings.keywords` | `seo.seoData.settings.keywords.${number}.term` | `seo.seoData.settings.keywords.${number}.isMain` | `seo.imageAlt` | `seo.courseWorkload` | `rewards` | `rewards.${number}.trigger` | `rewards.${number}.certificate._id` | `accessType` | `shouldSendInvoice` | `videoStepsSettings.autoNavigate` | `videoStepsSettings.requiredCompletionPercentage` | `contentSummary.stepCount` | `contentSummary.sectionCount`, 7>>;
2540
+ declare function createProgram(program: Program): Promise<NonNullablePaths<Program, `status` | `categoryIds` | `description.title` | `timeline.selfPaced` | `restrictions.hideFutureSteps` | `restrictions.resolveStepsInOrder` | `restrictions.shareProgress` | `restrictions.accessType` | `price.value` | `price.currency` | `seo.slug` | `seo.seoData.tags` | `seo.seoData.tags.${number}.type` | `seo.seoData.tags.${number}.children` | `seo.seoData.tags.${number}.custom` | `seo.seoData.tags.${number}.disabled` | `seo.seoData.settings.preventAutoRedirect` | `seo.seoData.settings.keywords` | `seo.seoData.settings.keywords.${number}.term` | `seo.seoData.settings.keywords.${number}.isMain` | `seo.imageAlt` | `seo.courseWorkload` | `rewards` | `rewards.${number}.trigger` | `rewards.${number}.certificate._id` | `shouldSendInvoice` | `videoStepsSettings.autoNavigate` | `videoStepsSettings.requiredCompletionPercentage` | `contentSummary.stepCount` | `contentSummary.sectionCount`, 7>>;
2478
2541
  /**
2479
- * Duplicates the Program. Leaves certificate template, but removes social group.
2480
- * @param programId - Program to be duplicated from.
2542
+ * Duplicates a program as a new draft.
2543
+ *
2544
+ * The duplicated program gets a new ID and owner, starts in `DRAFT` status,
2545
+ * keeps category assignments and translation content, resets the SEO slug to
2546
+ * the duplicated program ID, clears the connected social group, and doesn't
2547
+ * copy section or step references.
2548
+ * @param programId - ID of the program to duplicate.
2481
2549
  * @public
2482
- * @documentationMaturity preview
2483
2550
  * @requiredField programId
2484
2551
  * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE
2485
2552
  * @applicableIdentity APP
2486
2553
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.DuplicateProgram
2487
2554
  */
2488
- declare function duplicateProgram(programId: string): Promise<NonNullablePaths<DuplicateProgramResponse, `program.state` | `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.accessType` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8>>;
2555
+ declare function duplicateProgram(programId: string): Promise<NonNullablePaths<DuplicateProgramResponse, `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8>>;
2489
2556
  /**
2490
- * Retrieves a Program.
2491
- * @param programId - ID of the Program to retrieve.
2557
+ * Retrieves a program by ID.
2558
+ *
2559
+ * Visibility depends on caller identity and program access settings. Public
2560
+ * callers can retrieve published and ended non-secret programs. Site members
2561
+ * can retrieve secret programs only when they participate in them. Trusted apps
2562
+ * and services can retrieve management views.
2563
+ * @param programId - ID of the program to retrieve.
2492
2564
  * @public
2493
- * @documentationMaturity preview
2494
2565
  * @requiredField programId
2495
2566
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2496
2567
  * @applicableIdentity APP
2497
- * @returns The requested Program.
2568
+ * @returns Requested program.
2498
2569
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.GetProgram
2499
2570
  */
2500
- declare function getProgram(programId: string): Promise<NonNullablePaths<Program, `state` | `status` | `categoryIds` | `description.title` | `timeline.selfPaced` | `restrictions.hideFutureSteps` | `restrictions.resolveStepsInOrder` | `restrictions.shareProgress` | `restrictions.accessType` | `price.value` | `price.currency` | `seo.slug` | `seo.seoData.tags` | `seo.seoData.tags.${number}.type` | `seo.seoData.tags.${number}.children` | `seo.seoData.tags.${number}.custom` | `seo.seoData.tags.${number}.disabled` | `seo.seoData.settings.preventAutoRedirect` | `seo.seoData.settings.keywords` | `seo.seoData.settings.keywords.${number}.term` | `seo.seoData.settings.keywords.${number}.isMain` | `seo.imageAlt` | `seo.courseWorkload` | `rewards` | `rewards.${number}.trigger` | `rewards.${number}.certificate._id` | `accessType` | `shouldSendInvoice` | `videoStepsSettings.autoNavigate` | `videoStepsSettings.requiredCompletionPercentage` | `contentSummary.stepCount` | `contentSummary.sectionCount`, 7>>;
2571
+ declare function getProgram(programId: string): Promise<NonNullablePaths<Program, `status` | `categoryIds` | `description.title` | `timeline.selfPaced` | `restrictions.hideFutureSteps` | `restrictions.resolveStepsInOrder` | `restrictions.shareProgress` | `restrictions.accessType` | `price.value` | `price.currency` | `seo.slug` | `seo.seoData.tags` | `seo.seoData.tags.${number}.type` | `seo.seoData.tags.${number}.children` | `seo.seoData.tags.${number}.custom` | `seo.seoData.tags.${number}.disabled` | `seo.seoData.settings.preventAutoRedirect` | `seo.seoData.settings.keywords` | `seo.seoData.settings.keywords.${number}.term` | `seo.seoData.settings.keywords.${number}.isMain` | `seo.imageAlt` | `seo.courseWorkload` | `rewards` | `rewards.${number}.trigger` | `rewards.${number}.certificate._id` | `shouldSendInvoice` | `videoStepsSettings.autoNavigate` | `videoStepsSettings.requiredCompletionPercentage` | `contentSummary.stepCount` | `contentSummary.sectionCount`, 7>>;
2501
2572
  /**
2502
- * Updates a Program.
2573
+ * Updates selected fields of a program.
2574
+ *
2575
+ * Each time the program is updated, `revision` increments by 1. The current
2576
+ * `revision` must be passed when updating the program. This ensures you're
2577
+ * working with the latest program and prevents unintended overwrites.
2578
+ *
2579
+ * Ended and archived programs can't be updated. Timeline changes are blocked
2580
+ * when the program has active participants.
2503
2581
  * @param _id - Program ID.
2504
2582
  * @public
2505
- * @documentationMaturity preview
2506
2583
  * @requiredField _id
2507
2584
  * @requiredField program
2508
2585
  * @requiredField program.revision
2509
2586
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2510
2587
  * @applicableIdentity APP
2511
- * @returns Updated Program.
2588
+ * @returns Updated program.
2512
2589
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.UpdateProgram
2513
2590
  */
2514
- declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`, 2>): Promise<NonNullablePaths<Program, `state` | `status` | `categoryIds` | `description.title` | `timeline.selfPaced` | `restrictions.hideFutureSteps` | `restrictions.resolveStepsInOrder` | `restrictions.shareProgress` | `restrictions.accessType` | `price.value` | `price.currency` | `seo.slug` | `seo.seoData.tags` | `seo.seoData.tags.${number}.type` | `seo.seoData.tags.${number}.children` | `seo.seoData.tags.${number}.custom` | `seo.seoData.tags.${number}.disabled` | `seo.seoData.settings.preventAutoRedirect` | `seo.seoData.settings.keywords` | `seo.seoData.settings.keywords.${number}.term` | `seo.seoData.settings.keywords.${number}.isMain` | `seo.imageAlt` | `seo.courseWorkload` | `rewards` | `rewards.${number}.trigger` | `rewards.${number}.certificate._id` | `accessType` | `shouldSendInvoice` | `videoStepsSettings.autoNavigate` | `videoStepsSettings.requiredCompletionPercentage` | `contentSummary.stepCount` | `contentSummary.sectionCount`, 7> & {
2591
+ declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`, 2>): Promise<NonNullablePaths<Program, `status` | `categoryIds` | `description.title` | `timeline.selfPaced` | `restrictions.hideFutureSteps` | `restrictions.resolveStepsInOrder` | `restrictions.shareProgress` | `restrictions.accessType` | `price.value` | `price.currency` | `seo.slug` | `seo.seoData.tags` | `seo.seoData.tags.${number}.type` | `seo.seoData.tags.${number}.children` | `seo.seoData.tags.${number}.custom` | `seo.seoData.tags.${number}.disabled` | `seo.seoData.settings.preventAutoRedirect` | `seo.seoData.settings.keywords` | `seo.seoData.settings.keywords.${number}.term` | `seo.seoData.settings.keywords.${number}.isMain` | `seo.imageAlt` | `seo.courseWorkload` | `rewards` | `rewards.${number}.trigger` | `rewards.${number}.certificate._id` | `shouldSendInvoice` | `videoStepsSettings.autoNavigate` | `videoStepsSettings.requiredCompletionPercentage` | `contentSummary.stepCount` | `contentSummary.sectionCount`, 7> & {
2515
2592
  __applicationErrorsType?: UpdateProgramApplicationErrors;
2516
2593
  }>;
2517
2594
  interface UpdateProgram {
@@ -2521,83 +2598,83 @@ interface UpdateProgram {
2521
2598
  * @readonly
2522
2599
  */
2523
2600
  _id?: string | null;
2524
- /** @readonly */
2601
+ /**
2602
+ * Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating a program.
2603
+ * @readonly
2604
+ */
2525
2605
  revision?: string | null;
2526
- /** @readonly */
2606
+ /**
2607
+ * Date and time the program was created.
2608
+ * @readonly
2609
+ */
2527
2610
  _createdDate?: Date | null;
2528
- /** @readonly */
2529
- _updatedDate?: Date | null;
2530
2611
  /**
2531
- * current program state / does participant need it?
2612
+ * Date and time the program was last updated.
2532
2613
  * @readonly
2533
- * @deprecated
2534
- * @replacedBy status
2535
- * @targetRemovalDate 2025-10-15
2536
2614
  */
2537
- state?: V3StateWithLiterals;
2615
+ _updatedDate?: Date | null;
2538
2616
  /**
2539
- * current program state in v2 format
2617
+ * Current program lifecycle status.
2540
2618
  * @readonly
2541
2619
  */
2542
2620
  status?: StatusWithLiterals;
2543
2621
  /**
2544
- * assigned categories
2622
+ * Date and time when `status` last changed.
2623
+ * @readonly
2624
+ */
2625
+ statusUpdatedDate?: Date | null;
2626
+ /**
2627
+ * Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories.
2545
2628
  * @readonly
2546
2629
  * @format GUID
2547
2630
  * @maxSize 10
2548
2631
  */
2549
2632
  categoryIds?: string[];
2550
- /** general program info. */
2633
+ /** Public-facing program title, details, and media. */
2551
2634
  description?: Description;
2552
- /** timeline type -> Self-paced, time-restricted. */
2635
+ /** Program timeline settings. Use this to configure self-paced or scheduled programs. */
2553
2636
  timeline?: Timeline;
2554
- /** participant limitation, step-completion pace and etc. */
2637
+ /** Program access, participation, and progression rules. */
2555
2638
  restrictions?: Restrictions;
2556
- /** single-payment price. */
2639
+ /** Optional one-time payment price for joining the program. */
2557
2640
  price?: Money;
2558
- /** seo settings. */
2641
+ /** SEO settings used for the program page. */
2559
2642
  seo?: Seo;
2560
2643
  /**
2561
- * rewards to be assigned after reaching some of the program milestones.
2644
+ * Rewards assigned to participants when they reach configured milestones.
2562
2645
  * @maxSize 10
2563
2646
  */
2564
2647
  rewards?: Reward[];
2565
2648
  /**
2566
- * connected social group.
2649
+ * ID of the social group connected to the program, if one exists.
2567
2650
  * @format GUID
2568
2651
  */
2569
2652
  socialGroupId?: string | null;
2570
- /**
2571
- * join flow options.
2572
- * @deprecated
2573
- * @replacedBy restrictions.access_type
2574
- * @targetRemovalDate 2025-10-15
2575
- */
2576
- accessType?: AccessTypeWithLiterals;
2577
- /** extensible field */
2653
+ /** Custom fields for apps that extend the Program entity. */
2578
2654
  extendedFields?: ExtendedFields;
2579
- /** if true -> invoice is sent to the customer who purchased the program via single payment; else -> payment confirmation email is sent */
2655
+ /** Whether to send an invoice after a single-payment purchase. When false, the buyer receives a payment confirmation email instead. */
2580
2656
  shouldSendInvoice?: boolean;
2581
- /** settings related to video steps in programs */
2657
+ /** Settings that control how video steps behave in this program. */
2582
2658
  videoStepsSettings?: VideoStepsSettings;
2583
2659
  /**
2584
- * number of content entities in program
2660
+ * Read-only counts of content entities in the program.
2585
2661
  * @readonly
2586
2662
  */
2587
2663
  contentSummary?: ContentSummary;
2588
2664
  /**
2589
- * user id of owner, who created this program
2665
+ * ID of the site user who created the program.
2590
2666
  * @format GUID
2591
2667
  * @readonly
2592
2668
  */
2593
2669
  ownerUserId?: string | null;
2594
2670
  }
2595
2671
  /**
2596
- * Deletes a Program.
2597
- * Deleting a Program permanently removes them from the Program List.
2598
- * @param programId - Id of the Program to delete.
2672
+ * Deletes a program.
2673
+ *
2674
+ * Deleting a program permanently removes it from the program list, cancels its
2675
+ * scheduled end task, removes related member groups, and removes it from search.
2676
+ * @param programId - ID of the program to delete.
2599
2677
  * @public
2600
- * @documentationMaturity preview
2601
2678
  * @requiredField programId
2602
2679
  * @permissionId ONLINE_PROGRAMS.PROGRAM_DELETE
2603
2680
  * @applicableIdentity APP
@@ -2605,9 +2682,18 @@ interface UpdateProgram {
2605
2682
  */
2606
2683
  declare function deleteProgram(programId: string): Promise<void>;
2607
2684
  /**
2608
- * Retrieves a list of Programs
2685
+ * Retrieves a list of up to 50 programs, given the provided paging, filtering, and sorting.
2686
+ *
2687
+ * Query Programs runs with these defaults, which you can override:
2688
+ *
2689
+ * - `createdDate` is sorted in `DESC` order.
2690
+ * - `paging.limit` is `50`.
2691
+ * - `paging.offset` is `0`.
2692
+ *
2693
+ * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
2694
+ *
2695
+ * Results are visibility-filtered according to the caller identity.
2609
2696
  * @public
2610
- * @documentationMaturity preview
2611
2697
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2612
2698
  * @applicableIdentity APP
2613
2699
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms
@@ -2629,40 +2715,26 @@ interface ProgramsQueryResult extends QueryCursorResult {
2629
2715
  interface ProgramsQueryBuilder {
2630
2716
  /** @param propertyName - Property whose value is compared with `value`.
2631
2717
  * @param value - Value to compare against.
2632
- * @documentationMaturity preview
2633
2718
  */
2634
- eq: (propertyName: '_id' | 'state' | 'status' | 'timeline.selfPaced' | 'seo.slug' | 'socialGroupId', value: any) => ProgramsQueryBuilder;
2719
+ eq: (propertyName: '_id' | 'status' | 'timeline.selfPaced' | 'seo.slug' | 'socialGroupId', value: any) => ProgramsQueryBuilder;
2635
2720
  /** @param propertyName - Property whose value is compared with `values`.
2636
2721
  * @param values - List of values to compare against.
2637
- * @documentationMaturity preview
2638
2722
  */
2639
2723
  hasSome: (propertyName: string, value: any[]) => ProgramsQueryBuilder;
2640
2724
  /** @param propertyName - Property whose value is compared with `values`.
2641
2725
  * @param values - List of values to compare against.
2642
- * @documentationMaturity preview
2643
2726
  */
2644
2727
  hasAll: (propertyName: string, value: any[]) => ProgramsQueryBuilder;
2645
- /** @documentationMaturity preview */
2646
- in: (propertyName: '_id' | 'state' | 'status' | 'restrictions.accessType' | 'socialGroupId' | 'accessType', value: any) => ProgramsQueryBuilder;
2647
- /** @documentationMaturity preview */
2728
+ in: (propertyName: '_id' | 'status' | 'restrictions.accessType' | 'socialGroupId', value: any) => ProgramsQueryBuilder;
2648
2729
  exists: (propertyName: 'price', value: boolean) => ProgramsQueryBuilder;
2649
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2650
- * @documentationMaturity preview
2651
- */
2652
- ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'status' | 'stateUpdatedDate' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2653
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2654
- * @documentationMaturity preview
2655
- */
2656
- descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'status' | 'stateUpdatedDate' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2657
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2658
- * @documentationMaturity preview
2659
- */
2730
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2731
+ ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'status' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2732
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2733
+ descending: (...propertyNames: Array<'_id' | '_createdDate' | 'status' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2734
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
2660
2735
  limit: (limit: number) => ProgramsQueryBuilder;
2661
- /** @param cursor - A pointer to specific record
2662
- * @documentationMaturity preview
2663
- */
2736
+ /** @param cursor - A pointer to specific record */
2664
2737
  skipTo: (cursor: string) => ProgramsQueryBuilder;
2665
- /** @documentationMaturity preview */
2666
2738
  find: () => Promise<ProgramsQueryResult>;
2667
2739
  }
2668
2740
  /**
@@ -2670,7 +2742,7 @@ interface ProgramsQueryBuilder {
2670
2742
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms
2671
2743
  * @requiredField query
2672
2744
  */
2673
- declare function typedQueryPrograms(query: ProgramQuery): Promise<NonNullablePaths<QueryProgramsResponse, `programs` | `programs.${number}.state` | `programs.${number}.status` | `programs.${number}.description.title` | `programs.${number}.timeline.selfPaced` | `programs.${number}.restrictions.hideFutureSteps` | `programs.${number}.restrictions.resolveStepsInOrder` | `programs.${number}.restrictions.shareProgress` | `programs.${number}.restrictions.accessType` | `programs.${number}.price.value` | `programs.${number}.price.currency` | `programs.${number}.seo.slug` | `programs.${number}.seo.imageAlt` | `programs.${number}.seo.courseWorkload` | `programs.${number}.accessType` | `programs.${number}.shouldSendInvoice` | `programs.${number}.videoStepsSettings.autoNavigate` | `programs.${number}.videoStepsSettings.requiredCompletionPercentage` | `programs.${number}.contentSummary.stepCount` | `programs.${number}.contentSummary.sectionCount`, 5>>;
2745
+ declare function typedQueryPrograms(query: ProgramQuery): Promise<NonNullablePaths<QueryProgramsResponse, `programs` | `programs.${number}.status` | `programs.${number}.description.title` | `programs.${number}.timeline.selfPaced` | `programs.${number}.restrictions.hideFutureSteps` | `programs.${number}.restrictions.resolveStepsInOrder` | `programs.${number}.restrictions.shareProgress` | `programs.${number}.restrictions.accessType` | `programs.${number}.price.value` | `programs.${number}.price.currency` | `programs.${number}.seo.slug` | `programs.${number}.seo.imageAlt` | `programs.${number}.seo.courseWorkload` | `programs.${number}.shouldSendInvoice` | `programs.${number}.videoStepsSettings.autoNavigate` | `programs.${number}.videoStepsSettings.requiredCompletionPercentage` | `programs.${number}.contentSummary.stepCount` | `programs.${number}.contentSummary.sectionCount`, 5>>;
2674
2746
  interface ProgramQuerySpec extends QuerySpec {
2675
2747
  paging: 'cursor';
2676
2748
  wql: [
@@ -2679,11 +2751,6 @@ interface ProgramQuerySpec extends QuerySpec {
2679
2751
  operators: ['$eq', '$in'];
2680
2752
  sort: 'BOTH';
2681
2753
  },
2682
- {
2683
- fields: ['state'];
2684
- operators: ['$eq', '$in'];
2685
- sort: 'BOTH';
2686
- },
2687
2754
  {
2688
2755
  fields: ['status'];
2689
2756
  operators: ['$eq', '$in'];
@@ -2704,11 +2771,6 @@ interface ProgramQuerySpec extends QuerySpec {
2704
2771
  operators: [];
2705
2772
  sort: 'BOTH';
2706
2773
  },
2707
- {
2708
- fields: ['stateUpdatedDate'];
2709
- operators: [];
2710
- sort: 'BOTH';
2711
- },
2712
2774
  {
2713
2775
  fields: ['statusUpdatedDate'];
2714
2776
  operators: [];
@@ -2729,11 +2791,6 @@ interface ProgramQuerySpec extends QuerySpec {
2729
2791
  operators: ['$exists'];
2730
2792
  sort: 'NONE';
2731
2793
  },
2732
- {
2733
- fields: ['accessType'];
2734
- operators: ['$in'];
2735
- sort: 'NONE';
2736
- },
2737
2794
  {
2738
2795
  fields: ['restrictions.accessType'];
2739
2796
  operators: ['$in'];
@@ -2769,13 +2826,13 @@ type ProgramQuery = {
2769
2826
  /**
2770
2827
  Filter object.
2771
2828
 
2772
- Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2829
+ Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
2773
2830
  */
2774
2831
  filter?: CommonQueryWithEntityContext['filter'] | null;
2775
2832
  /**
2776
2833
  Sort object.
2777
2834
 
2778
- Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2835
+ Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
2779
2836
  @maxSize: 100
2780
2837
  */
2781
2838
  sort?: {
@@ -2790,15 +2847,27 @@ type ProgramQuery = {
2790
2847
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
2791
2848
  }[];
2792
2849
  };
2850
+ declare const utils: {
2851
+ query: {
2852
+ QueryBuilder: () => _wix_sdk_types.QueryBuilder<Program, ProgramQuerySpec, ProgramQuery>;
2853
+ Filter: _wix_sdk_types.FilterFactory<Program, ProgramQuerySpec>;
2854
+ Sort: _wix_sdk_types.SortFactory<ProgramQuerySpec>;
2855
+ };
2856
+ search: {
2857
+ SearchBuilder: () => _wix_sdk_types.SearchBuilder<Program, ProgramSearchSpec, ProgramSearch>;
2858
+ Filter: _wix_sdk_types.FilterFactory<Program, ProgramSearchSpec>;
2859
+ Sort: _wix_sdk_types.SortFactory<ProgramSearchSpec>;
2860
+ SearchParams: _wix_sdk_types.SearchParamsFactory<ProgramSearchSpec>;
2861
+ Aggregation: _wix_sdk_types.AggregationFactory<ProgramSearchSpec>;
2862
+ };
2863
+ };
2793
2864
  interface ProgramSearchSpec extends SearchSpec {
2794
2865
  searchable: ['description.title'];
2795
2866
  aggregatable: [
2796
2867
  '_id',
2797
- 'accessType',
2798
2868
  'categoryIds',
2799
2869
  'description.title',
2800
2870
  'restrictions.accessType',
2801
- 'state',
2802
2871
  'status',
2803
2872
  'timeline.selfPaced'
2804
2873
  ];
@@ -2809,11 +2878,6 @@ interface ProgramSearchSpec extends SearchSpec {
2809
2878
  fields: ['_id', 'description.title'];
2810
2879
  sort: 'BOTH';
2811
2880
  },
2812
- {
2813
- operators: ['$eq', '$in'];
2814
- fields: ['state'];
2815
- sort: 'BOTH';
2816
- },
2817
2881
  {
2818
2882
  operators: ['$eq', '$in'];
2819
2883
  fields: ['status'];
@@ -2829,11 +2893,6 @@ interface ProgramSearchSpec extends SearchSpec {
2829
2893
  fields: ['timeline.selfPaced'];
2830
2894
  sort: 'NONE';
2831
2895
  },
2832
- {
2833
- operators: ['$in'];
2834
- fields: ['accessType'];
2835
- sort: 'NONE';
2836
- },
2837
2896
  {
2838
2897
  operators: ['$in'];
2839
2898
  fields: ['restrictions.accessType'];
@@ -2856,7 +2915,7 @@ type ProgramSearch = {
2856
2915
  /**
2857
2916
  Cursor paging options.
2858
2917
 
2859
- Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2918
+ Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
2860
2919
  */
2861
2920
  cursorPaging?: {
2862
2921
  /**
@@ -2876,13 +2935,13 @@ type ProgramSearch = {
2876
2935
  /**
2877
2936
  Filter object.
2878
2937
 
2879
- Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2938
+ Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
2880
2939
  */
2881
2940
  filter?: CommonSearchWithEntityContext['filter'] | null;
2882
2941
  /**
2883
2942
  List of sort objects.
2884
2943
 
2885
- Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2944
+ Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
2886
2945
  @maxSize: 10
2887
2946
  */
2888
2947
  sort?: {
@@ -2980,77 +3039,86 @@ type ProgramSearch = {
2980
3039
  timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
2981
3040
  };
2982
3041
  /**
2983
- * Publishes draft program. In other state returns program as is.
2984
- * @param programId - Program to publish
3042
+ * Publishes a draft program.
3043
+ *
3044
+ * A scheduled program can't be published when its start date is in the past.
3045
+ * If the program has an end date, the service schedules an automatic transition
3046
+ * to `ENDED` using the site's timezone.
3047
+ * @param programId - ID of the draft program to publish.
2985
3048
  * @public
2986
- * @documentationMaturity preview
2987
3049
  * @requiredField programId
2988
3050
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2989
3051
  * @applicableIdentity APP
2990
3052
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.PublishProgram
2991
3053
  */
2992
- declare function publishProgram(programId: string): Promise<NonNullablePaths<PublishProgramResponse, `program.state` | `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.accessType` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8> & {
3054
+ declare function publishProgram(programId: string): Promise<NonNullablePaths<PublishProgramResponse, `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8> & {
2993
3055
  __applicationErrorsType?: PublishProgramApplicationErrors;
2994
3056
  }>;
2995
3057
  /**
2996
- * Ends program.
2997
- * @param programId - Program to finish
3058
+ * Ends a published program.
3059
+ *
3060
+ * Ending a program changes its status to `ENDED` and cancels any scheduled end
3061
+ * task. The operation succeeds only for currently published programs.
3062
+ * @param programId - ID of the published program to end.
2998
3063
  * @public
2999
- * @documentationMaturity preview
3000
3064
  * @requiredField programId
3001
3065
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3002
3066
  * @applicableIdentity APP
3003
3067
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.EndProgram
3004
3068
  */
3005
- declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `program.state` | `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.accessType` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8>>;
3069
+ declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8>>;
3006
3070
  /**
3007
- * Archives program
3008
- * @param programId - Program to archive
3071
+ * Archives a program.
3072
+ *
3073
+ * Archiving closes the program, removes it from normal public discovery, and
3074
+ * replaces its SEO slug with the program ID so the previous slug can be reused.
3075
+ * @param programId - ID of the program to archive.
3009
3076
  * @public
3010
- * @documentationMaturity preview
3011
3077
  * @requiredField programId
3012
3078
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3013
3079
  * @applicableIdentity APP
3014
3080
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.ArchiveProgram
3015
3081
  */
3016
- declare function archiveProgram(programId: string): Promise<NonNullablePaths<ArchiveProgramResponse, `program.state` | `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.accessType` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8>>;
3082
+ declare function archiveProgram(programId: string): Promise<NonNullablePaths<ArchiveProgramResponse, `program.status` | `program.categoryIds` | `program.description.title` | `program.timeline.selfPaced` | `program.restrictions.hideFutureSteps` | `program.restrictions.resolveStepsInOrder` | `program.restrictions.shareProgress` | `program.restrictions.accessType` | `program.price.value` | `program.price.currency` | `program.seo.slug` | `program.seo.seoData.tags` | `program.seo.seoData.tags.${number}.type` | `program.seo.seoData.tags.${number}.children` | `program.seo.seoData.tags.${number}.custom` | `program.seo.seoData.tags.${number}.disabled` | `program.seo.seoData.settings.preventAutoRedirect` | `program.seo.seoData.settings.keywords` | `program.seo.seoData.settings.keywords.${number}.term` | `program.seo.seoData.settings.keywords.${number}.isMain` | `program.seo.imageAlt` | `program.seo.courseWorkload` | `program.rewards` | `program.rewards.${number}.trigger` | `program.rewards.${number}.certificate._id` | `program.shouldSendInvoice` | `program.videoStepsSettings.autoNavigate` | `program.videoStepsSettings.requiredCompletionPercentage` | `program.contentSummary.stepCount` | `program.contentSummary.sectionCount`, 8>>;
3017
3083
  /**
3018
- * Update multiple Programs in a single request. Works synchronously.
3019
- * @param programs - List of programs you want to update
3084
+ * Updates multiple programs in a single synchronous request.
3085
+ *
3086
+ * Each item includes its own program data and revision. Set `returnEntity` to
3087
+ * return updated programs in the response.
3088
+ * @param programs - Programs to update. Each item contains partial program data.
3020
3089
  * @public
3021
- * @documentationMaturity preview
3022
3090
  * @requiredField programs
3023
3091
  * @requiredField programs.program.revision
3024
3092
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3025
3093
  * @applicableIdentity APP
3026
3094
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.BulkUpdatePrograms
3027
3095
  */
3028
- declare function bulkUpdatePrograms(programs: NonNullablePaths<MaskedProgram, `program.revision`, 3>[], options?: BulkUpdateProgramsOptions): Promise<NonNullablePaths<BulkUpdateProgramsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.state` | `results.${number}.item.status` | `results.${number}.item.description.title` | `results.${number}.item.timeline.selfPaced` | `results.${number}.item.restrictions.hideFutureSteps` | `results.${number}.item.restrictions.resolveStepsInOrder` | `results.${number}.item.restrictions.shareProgress` | `results.${number}.item.restrictions.accessType` | `results.${number}.item.price.value` | `results.${number}.item.price.currency` | `results.${number}.item.seo.slug` | `results.${number}.item.seo.imageAlt` | `results.${number}.item.seo.courseWorkload` | `results.${number}.item.accessType` | `results.${number}.item.shouldSendInvoice` | `results.${number}.item.videoStepsSettings.autoNavigate` | `results.${number}.item.videoStepsSettings.requiredCompletionPercentage` | `results.${number}.item.contentSummary.stepCount` | `results.${number}.item.contentSummary.sectionCount` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
3096
+ declare function bulkUpdatePrograms(programs: NonNullablePaths<MaskedProgram, `program.revision`, 3>[], options?: BulkUpdateProgramsOptions): Promise<NonNullablePaths<BulkUpdateProgramsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.status` | `results.${number}.item.description.title` | `results.${number}.item.timeline.selfPaced` | `results.${number}.item.restrictions.hideFutureSteps` | `results.${number}.item.restrictions.resolveStepsInOrder` | `results.${number}.item.restrictions.shareProgress` | `results.${number}.item.restrictions.accessType` | `results.${number}.item.price.value` | `results.${number}.item.price.currency` | `results.${number}.item.seo.slug` | `results.${number}.item.seo.imageAlt` | `results.${number}.item.seo.courseWorkload` | `results.${number}.item.shouldSendInvoice` | `results.${number}.item.videoStepsSettings.autoNavigate` | `results.${number}.item.videoStepsSettings.requiredCompletionPercentage` | `results.${number}.item.contentSummary.stepCount` | `results.${number}.item.contentSummary.sectionCount` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
3029
3097
  interface BulkUpdateProgramsOptions {
3030
- /** set to `true` if you wish to receive back the created programs in the response */
3098
+ /** Whether to return updated programs in the response. */
3031
3099
  returnEntity?: boolean;
3032
3100
  }
3033
3101
  /**
3034
- * Counts programs matching the filter
3102
+ * Counts programs that match a filter.
3103
+ *
3104
+ * Results use the same visibility rules as `QueryPrograms`.
3035
3105
  * @public
3036
- * @documentationMaturity preview
3037
3106
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
3038
3107
  * @applicableIdentity APP
3039
3108
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.CountPrograms
3040
3109
  */
3041
3110
  declare function countPrograms(options?: CountProgramsOptions): Promise<NonNullablePaths<CountProgramsResponse, `count`, 2>>;
3042
3111
  interface CountProgramsOptions {
3043
- /** filter for which count is requested */
3112
+ /** WQL filter for the programs to count. */
3044
3113
  filter?: Record<string, any> | null;
3045
3114
  }
3046
3115
  /**
3047
- * Returns list of sample programs.
3116
+ * Lists sample programs used as templates for creating new programs.
3048
3117
  * @public
3049
- * @documentationMaturity preview
3050
3118
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
3051
3119
  * @applicableIdentity APP
3052
3120
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.ListSamplePrograms
3053
3121
  */
3054
- declare function listSamplePrograms(): Promise<NonNullablePaths<ListSampleProgramsResponse, `programs` | `programs.${number}.program.state` | `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.accessType` | `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`, 6>>;
3122
+ 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`, 6>>;
3055
3123
 
3056
- export { type Keyword as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, DayOfWeek as F, ResolutionMethod as G, type Description as H, Interval as I, type DescriptionMediaOneOf as J, type FocalPoint as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, NestedAggregationType as N, type VideoResolution as O, type Program as P, type Timeline as Q, RestrictionsAccessType as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, V3State as V, WebhookIdentityType as W, type Restrictions as X, type Money as Y, type Seo as Z, type SeoSchema as _, type UpdateProgramApplicationErrors as a, type PagingMetadataV2 as a$, type Tag as a0, type Settings as a1, type Reward as a2, type Certificate as a3, type ExtendedFields as a4, type VideoStepsSettings as a5, type ContentSummary as a6, type UpdateDocumentsEvent as a7, type UpdateDocumentsEventOperationOneOf as a8, type DocumentUpdateOperation as a9, type ProgramMigration as aA, type BulkCreateProgramsMigrationResponse as aB, type BulkProgramResult as aC, type ItemMetadata as aD, type ApplicationError as aE, type BulkActionMetadata as aF, type DeleteAllProgramsMigrationRequest as aG, type DeleteAllProgramsMigrationResponse as aH, type DuplicateProgramRequest as aI, type GetProgramRequest as aJ, type GetProgramResponse as aK, type UpdateProgramRequest as aL, type UpdateProgramResponse as aM, type WrongStateErrorDetails as aN, type WrongStartDateErrorDetails as aO, type WrongParticipantsNumberErrorDetails as aP, type DuplicatedSlugErrorDetails as aQ, type TimelineSwitchForbiddenErrorDetails as aR, type DeleteProgramRequest as aS, type DeleteProgramResponse as aT, type QueryProgramsRequest as aU, type QueryV2 as aV, type QueryV2PagingMethodOneOf as aW, type Sorting as aX, type Paging as aY, type CursorPaging as aZ, type QueryProgramsResponse as a_, type IndexDocument as aa, type DocumentPayload as ab, type DocumentImage as ac, type DeleteByIdsOperation as ad, type DeleteByFilterOperation as ae, type UpdateByFilterOperation as af, type UpdateExistingOperation as ag, type InvalidateCache as ah, type InvalidateCacheGetByOneOf as ai, type App as aj, type Page as ak, type URI as al, type File as am, type CustomTag as an, type ReindexMessage as ao, type ReindexMessageActionOneOf as ap, type Upsert as aq, type Delete as ar, type Schema as as, type ProgramPublished as at, type ProgramEnded as au, type ProgramArchived as av, type ProgramDuplicated as aw, type CreateProgramRequest as ax, type CreateProgramResponse as ay, type BulkCreateProgramsMigrationRequest as az, type ProgramSearch as b, type SiteCreated as b$, type Cursors as b0, type SearchProgramsRequest as b1, type CursorSearch as b2, type CursorSearchPagingMethodOneOf as b3, type Aggregation as b4, type AggregationKindOneOf as b5, type RangeBucket as b6, type IncludeMissingValuesOptions as b7, type ValueAggregation as b8, type ValueAggregationOptionsOneOf as b9, type GroupByValueResults as bA, type DateHistogramResults as bB, type NestedResults as bC, type AggregationResults as bD, type AggregationResultsResultOneOf as bE, type PublishProgramRequest as bF, type EndProgramRequest as bG, type ArchiveProgramRequest as bH, type BulkUpdateProgramsRequest as bI, type BulkUpdateProgramResult as bJ, type CountProgramsRequest as bK, type ListSampleProgramsRequest as bL, type LabeledProgram as bM, type DomainEvent as bN, type DomainEventBodyOneOf as bO, type EntityCreatedEvent as bP, type RestoreInfo as bQ, type EntityUpdatedEvent as bR, type EntityDeletedEvent as bS, type ActionEvent as bT, type Empty as bU, type ResolveProgramSlugRequest as bV, type ResolveProgramSlugResponse as bW, type MissingMetasiteIdErrorDetails as bX, type MetaSiteSpecialEvent as bY, type MetaSiteSpecialEventPayloadOneOf as bZ, type Asset as b_, type RangeAggregation as ba, type ScalarAggregation as bb, type DateHistogramAggregation as bc, type NestedAggregationItem as bd, type NestedAggregationItemKindOneOf as be, type NestedAggregation as bf, type GroupByAggregation as bg, type GroupByAggregationKindOneOf as bh, type SearchDetails as bi, type CursorPagingMetadata as bj, type AggregationData as bk, type ValueAggregationResult as bl, type RangeAggregationResult as bm, type NestedAggregationResults as bn, type NestedAggregationResultsResultOneOf as bo, type ValueResults as bp, type RangeResults as bq, type AggregationResultsScalarResult as br, type NestedValueAggregationResult as bs, type ValueResult as bt, type RangeResult as bu, type ScalarResult as bv, type NestedResultValue as bw, type NestedResultValueResultOneOf as bx, type Results as by, type DateHistogramResult as bz, type PublishProgramResponse as c, type AggregationTypeWithLiterals as c$, type SiteTransferred as c0, type SiteDeleted as c1, type DeleteContext as c2, type SiteUndeleted as c3, type SitePublished as c4, type SiteUnpublished as c5, type SiteMarkedAsTemplate as c6, type SiteMarkedAsWixSite as c7, type ServiceProvisioned as c8, type ServiceRemoved as c9, type BusinessSchedule as cA, type TimePeriod as cB, type SpecialHourPeriod as cC, type Multilingual as cD, type SupportedLanguage as cE, type ConsentPolicy as cF, type MessageEnvelope as cG, type IdentificationData as cH, type IdentificationDataIdOneOf as cI, type AccountInfo as cJ, type ProgramsQueryResult as cK, type ProgramQuerySpec as cL, type ProgramSearchSpec as cM, type V3StateWithLiterals as cN, type StatusWithLiterals as cO, type RestrictionsAccessTypeWithLiterals as cP, type TriggerWithLiterals as cQ, type AccessTypeWithLiterals as cR, type EnumWithLiterals as cS, type BulkActionTypeWithLiterals as cT, type SortOrderWithLiterals as cU, type SortTypeWithLiterals as cV, type SortDirectionWithLiterals as cW, type MissingValuesWithLiterals as cX, type ScalarTypeWithLiterals as cY, type NestedAggregationTypeWithLiterals as cZ, type IntervalWithLiterals as c_, type SiteRenamed as ca, type SiteHardDeleted as cb, type NamespaceChanged as cc, type StudioAssigned as cd, type StudioUnassigned as ce, type SiteUrlChanged as cf, type SitePurgedExternally as cg, type OdeditorAssigned as ch, type OdeditorUnassigned as ci, type PicassoAssigned as cj, type PicassoUnassigned as ck, type WixelAssigned as cl, type WixelUnassigned as cm, type StudioTwoAssigned as cn, type StudioTwoUnassigned as co, type UserDomainMediaEnabled as cp, type UserDomainMediaDisabled as cq, type SearchIndexingNotification as cr, type SitePropertiesUpdated as cs, type SitePropertiesEvent as ct, type Properties as cu, type Categories as cv, type Locale as cw, type Address as cx, type AddressHint as cy, type GeoCoordinates as cz, type PublishProgramApplicationErrors as d, type ModeWithLiterals as d0, type StateWithLiterals as d1, type SiteCreatedContextWithLiterals as d2, type NamespaceWithLiterals as d3, type DeleteStatusWithLiterals as d4, type SearchIndexingNotificationStateWithLiterals as d5, type PlacementTypeWithLiterals as d6, type DayOfWeekWithLiterals as d7, type ResolutionMethodWithLiterals as d8, type WebhookIdentityTypeWithLiterals as d9, type CommonQueryWithEntityContext as da, type CommonSearchWithEntityContext as db, createProgram as dc, duplicateProgram as dd, getProgram as de, updateProgram as df, deleteProgram as dg, queryPrograms as dh, publishProgram as di, endProgram as dj, archiveProgram as dk, bulkUpdatePrograms as dl, countPrograms as dm, listSamplePrograms as dn, type BulkUpdateProgramsResponse as e, type CountProgramsResponse as f, type ProgramsQueryBuilder as g, type ProgramQuery as h, Status as i, AccessType as j, Enum as k, BulkActionType as l, SortOrder as m, SortType as n, SortDirection as o, MissingValues as p, ScalarType as q, AggregationType as r, Mode as s, typedQueryPrograms as t, State as u, SiteCreatedContext as v, Namespace as w, DeleteStatus as x, SearchIndexingNotificationState as y, PlacementType as z };
3124
+ export { type Settings as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, DayOfWeek as F, type Description as G, type DescriptionMediaOneOf as H, Interval as I, type FocalPoint as J, type Timeline as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, NestedAggregationType as N, type Restrictions as O, type Program as P, type Money as Q, ResolutionMethod as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, type VideoResolution as V, WebhookIdentityType as W, type Seo as X, type SeoSchema as Y, type Keyword as Z, type Tag as _, type UpdateProgramApplicationErrors as a, type PagingMetadataV2 as a$, type Reward as a0, type Certificate as a1, type ExtendedFields as a2, type VideoStepsSettings as a3, type ContentSummary as a4, type UpdateDocumentsEvent as a5, type UpdateDocumentsEventOperationOneOf as a6, type DocumentUpdateOperation as a7, type IndexDocument as a8, type DocumentPayload as a9, type ProgramMigration as aA, type BulkCreateProgramsMigrationResponse as aB, type BulkProgramResult as aC, type ItemMetadata as aD, type ApplicationError as aE, type BulkActionMetadata as aF, type DeleteAllProgramsMigrationRequest as aG, type DeleteAllProgramsMigrationResponse as aH, type DuplicateProgramRequest as aI, type GetProgramRequest as aJ, type GetProgramResponse as aK, type UpdateProgramRequest as aL, type UpdateProgramResponse as aM, type WrongStateErrorDetails as aN, type WrongStartDateErrorDetails as aO, type WrongParticipantsNumberErrorDetails as aP, type DuplicatedSlugErrorDetails as aQ, type TimelineSwitchForbiddenErrorDetails as aR, type DeleteProgramRequest as aS, type DeleteProgramResponse as aT, type QueryProgramsRequest as aU, type QueryV2 as aV, type QueryV2PagingMethodOneOf as aW, type Sorting as aX, type Paging as aY, type CursorPaging as aZ, type QueryProgramsResponse as a_, type DocumentImage as aa, type DeleteByIdsOperation as ab, type DeleteByFilterOperation as ac, type UpdateByFilterOperation as ad, type UpdateExistingOperation as ae, type InvalidateCache as af, type InvalidateCacheGetByOneOf as ag, type App as ah, type Page as ai, type URI as aj, type File as ak, type CustomTag as al, type Pages as am, type URIs as an, type ReindexMessage as ao, type ReindexMessageActionOneOf as ap, type Upsert as aq, type Delete as ar, type Schema as as, type ProgramPublished as at, type ProgramEnded as au, type ProgramArchived as av, type ProgramDuplicated as aw, type CreateProgramRequest as ax, type CreateProgramResponse as ay, type BulkCreateProgramsMigrationRequest as az, type ProgramSearch as b, type SiteCreated as b$, type Cursors as b0, type SearchProgramsRequest as b1, type CursorSearch as b2, type CursorSearchPagingMethodOneOf as b3, type Aggregation as b4, type AggregationKindOneOf as b5, type RangeBucket as b6, type IncludeMissingValuesOptions as b7, type ValueAggregation as b8, type ValueAggregationOptionsOneOf as b9, type GroupByValueResults as bA, type DateHistogramResults as bB, type NestedResults as bC, type AggregationResults as bD, type AggregationResultsResultOneOf as bE, type PublishProgramRequest as bF, type EndProgramRequest as bG, type ArchiveProgramRequest as bH, type BulkUpdateProgramsRequest as bI, type BulkUpdateProgramResult as bJ, type CountProgramsRequest as bK, type ListSampleProgramsRequest as bL, type LabeledProgram as bM, type DomainEvent as bN, type DomainEventBodyOneOf as bO, type EntityCreatedEvent as bP, type RestoreInfo as bQ, type EntityUpdatedEvent as bR, type EntityDeletedEvent as bS, type ActionEvent as bT, type Empty as bU, type ResolveProgramSlugRequest as bV, type ResolveProgramSlugResponse as bW, type MissingMetasiteIdErrorDetails as bX, type MetaSiteSpecialEvent as bY, type MetaSiteSpecialEventPayloadOneOf as bZ, type Asset as b_, type RangeAggregation as ba, type ScalarAggregation as bb, type DateHistogramAggregation as bc, type NestedAggregationItem as bd, type NestedAggregationItemKindOneOf as be, type NestedAggregation as bf, type GroupByAggregation as bg, type GroupByAggregationKindOneOf as bh, type SearchDetails as bi, type CursorPagingMetadata as bj, type AggregationData as bk, type ValueAggregationResult as bl, type RangeAggregationResult as bm, type NestedAggregationResults as bn, type NestedAggregationResultsResultOneOf as bo, type ValueResults as bp, type RangeResults as bq, type AggregationResultsScalarResult as br, type NestedValueAggregationResult as bs, type ValueResult as bt, type RangeResult as bu, type ScalarResult as bv, type NestedResultValue as bw, type NestedResultValueResultOneOf as bx, type Results as by, type DateHistogramResult as bz, type PublishProgramResponse as c, type IntervalWithLiterals as c$, type SiteTransferred as c0, type SiteDeleted as c1, type DeleteContext as c2, type SiteUndeleted as c3, type SitePublished as c4, type SiteUnpublished as c5, type SiteMarkedAsTemplate as c6, type SiteMarkedAsWixSite as c7, type ServiceProvisioned as c8, type ServiceRemoved as c9, type AddressHint as cA, type GeoCoordinates as cB, type BusinessSchedule as cC, type TimePeriod as cD, type SpecialHourPeriod as cE, type Multilingual as cF, type SupportedLanguage as cG, type ConsentPolicy as cH, type MessageEnvelope as cI, type IdentificationData as cJ, type IdentificationDataIdOneOf as cK, type AccountInfo as cL, type ProgramsQueryResult as cM, type ProgramQuerySpec as cN, type ProgramSearchSpec as cO, utils as cP, type StatusWithLiterals as cQ, type AccessTypeWithLiterals as cR, type TriggerWithLiterals as cS, type EnumWithLiterals as cT, type BulkActionTypeWithLiterals as cU, type SortOrderWithLiterals as cV, type SortTypeWithLiterals as cW, type SortDirectionWithLiterals as cX, type MissingValuesWithLiterals as cY, type ScalarTypeWithLiterals as cZ, type NestedAggregationTypeWithLiterals as c_, type SiteRenamed as ca, type SiteHardDeleted as cb, type NamespaceChanged as cc, type StudioAssigned as cd, type StudioUnassigned as ce, type SiteUrlChanged as cf, type SitePurgedExternally as cg, type OdeditorAssigned as ch, type OdeditorUnassigned as ci, type PicassoAssigned as cj, type PicassoUnassigned as ck, type WixelAssigned as cl, type WixelUnassigned as cm, type StudioTwoAssigned as cn, type StudioTwoUnassigned as co, type UserDomainMediaEnabled as cp, type UserDomainMediaDisabled as cq, type EditorlessAssigned as cr, type EditorlessUnassigned as cs, type SearchIndexingNotification as ct, type SitePropertiesUpdated as cu, type SitePropertiesEvent as cv, type Properties as cw, type Categories as cx, type Locale as cy, type Address as cz, type PublishProgramApplicationErrors as d, type AggregationTypeWithLiterals as d0, type ModeWithLiterals as d1, type StateWithLiterals as d2, type SiteCreatedContextWithLiterals as d3, type NamespaceWithLiterals as d4, type DeleteStatusWithLiterals as d5, type SearchIndexingNotificationStateWithLiterals as d6, type PlacementTypeWithLiterals as d7, type DayOfWeekWithLiterals as d8, type ResolutionMethodWithLiterals as d9, type WebhookIdentityTypeWithLiterals as da, type CommonQueryWithEntityContext as db, type CommonSearchWithEntityContext 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, bulkUpdatePrograms as dm, countPrograms as dn, listSamplePrograms as dp, type BulkUpdateProgramsResponse as e, type CountProgramsResponse as f, type ProgramsQueryBuilder as g, type ProgramQuery as h, Status as i, AccessType as j, Enum as k, BulkActionType as l, SortOrder as m, SortType as n, SortDirection as o, MissingValues as p, ScalarType as q, AggregationType as r, Mode as s, typedQueryPrograms as t, State as u, SiteCreatedContext as v, Namespace as w, DeleteStatus as x, SearchIndexingNotificationState as y, PlacementType as z };