@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,132 +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 */
13
- _createdDate?: Date | null;
14
- /** @readonly */
15
- _updatedDate?: Date | null;
16
21
  /**
17
- * current program state / does participant need it?
22
+ * Date and time the program was created.
18
23
  * @readonly
19
- * @deprecated
20
- * @replacedBy status
21
- * @targetRemovalDate 2025-10-15
22
24
  */
23
- state?: V3StateWithLiterals;
25
+ _createdDate?: Date | null;
24
26
  /**
25
- * current program state in v2 format
27
+ * Date and time the program was last updated.
26
28
  * @readonly
27
29
  */
28
- status?: StatusWithLiterals;
30
+ _updatedDate?: Date | null;
29
31
  /**
30
- * @internal
32
+ * Current program lifecycle status.
31
33
  * @readonly
32
- * @deprecated
33
- * @replacedBy status_updated_date
34
- * @targetRemovalDate 2025-10-15
35
34
  */
36
- stateUpdatedDate?: Date | null;
35
+ status?: StatusWithLiterals;
37
36
  /**
38
- * date of the last status update
39
- * @internal
37
+ * Date and time when `status` last changed.
40
38
  * @readonly
41
39
  */
42
40
  statusUpdatedDate?: Date | null;
43
41
  /**
44
- * assigned categories
42
+ * Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories.
45
43
  * @readonly
46
44
  * @format GUID
47
45
  * @maxSize 10
48
46
  */
49
47
  categoryIds?: string[];
50
- /** general program info. */
48
+ /** Public-facing program title, details, and media. */
51
49
  description?: Description;
52
- /** timeline type -> Self-paced, time-restricted. */
50
+ /** Program timeline settings. Use this to configure self-paced or scheduled programs. */
53
51
  timeline?: Timeline;
54
- /** participant limitation, step-completion pace and etc. */
52
+ /** Program access, participation, and progression rules. */
55
53
  restrictions?: Restrictions;
56
- /** single-payment price. */
54
+ /** Optional one-time payment price for joining the program. */
57
55
  price?: Money;
58
- /** seo settings. */
56
+ /** SEO settings used for the program page. */
59
57
  seo?: Seo;
60
58
  /**
61
- * rewards to be assigned after reaching some of the program milestones.
59
+ * Rewards assigned to participants when they reach configured milestones.
62
60
  * @maxSize 10
63
61
  */
64
62
  rewards?: Reward[];
65
63
  /**
66
- * connected social group.
64
+ * ID of the social group connected to the program, if one exists.
67
65
  * @format GUID
68
66
  */
69
67
  socialGroupId?: string | null;
70
- /**
71
- * join flow options.
72
- * @deprecated
73
- * @replacedBy restrictions.access_type
74
- * @targetRemovalDate 2025-10-15
75
- */
76
- accessType?: AccessTypeWithLiterals;
77
- /** extensible field */
68
+ /** Custom fields for apps that extend the Program entity. */
78
69
  extendedFields?: ExtendedFields;
79
- /** 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. */
80
71
  shouldSendInvoice?: boolean;
81
- /** settings related to video steps in programs */
72
+ /** Settings that control how video steps behave in this program. */
82
73
  videoStepsSettings?: VideoStepsSettings;
83
74
  /**
84
- * number of content entities in program
75
+ * Read-only counts of content entities in the program.
85
76
  * @readonly
86
77
  */
87
78
  contentSummary?: ContentSummary;
88
79
  /**
89
- * user id of owner, who created this program
80
+ * ID of the site user who created the program.
90
81
  * @format GUID
91
82
  * @readonly
92
83
  */
93
84
  ownerUserId?: string | null;
94
85
  }
95
- declare enum V3State {
96
- /** not published program, visible only on BM */
97
- DRAFT = "DRAFT",
98
- /** program visible regarding to restrictions */
99
- PUBLISHED = "PUBLISHED",
100
- /** program isn't available to join. */
101
- ENDED = "ENDED",
102
- /** closed program. Joins and sections/steps are not available for participants. */
103
- ARCHIVED = "ARCHIVED"
104
- }
105
- /** @enumType */
106
- type V3StateWithLiterals = V3State | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
107
86
  declare enum Status {
108
- /** unknown state */
109
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
110
- /** not published program, visible only on BM */
87
+ /** The program is editable and visible only in management contexts. */
111
88
  DRAFT = "DRAFT",
112
- /** program visible regarding to restrictions */
89
+ /** The program is available according to its access restrictions. */
113
90
  PUBLISHED = "PUBLISHED",
114
- /** program isn't available to join. */
91
+ /** The program is no longer available for new participation. */
115
92
  ENDED = "ENDED",
116
- /** closed program. Joins and sections/steps are not available for participants. */
93
+ /** The program is closed and removed from normal public discovery. */
117
94
  ARCHIVED = "ARCHIVED"
118
95
  }
119
96
  /** @enumType */
120
- type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
97
+ type StatusWithLiterals = Status | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
98
+ /** Public program description and media. */
121
99
  interface Description extends DescriptionMediaOneOf {
122
- /** WixMedia image */
100
+ /** Program image. */
123
101
  image?: string;
124
- /** WixMedia video */
102
+ /** Program video. */
125
103
  video?: string;
126
- /** @maxLength 150 */
104
+ /**
105
+ * Program title.
106
+ * @maxLength 150
107
+ */
127
108
  title?: string;
128
- /** @maxLength 8000 */
109
+ /**
110
+ * Detailed program description.
111
+ * @maxLength 8000
112
+ */
129
113
  details?: string | null;
130
114
  }
131
115
  /** @oneof */
132
116
  interface DescriptionMediaOneOf {
133
- /** WixMedia image */
117
+ /** Program image. */
134
118
  image?: string;
135
- /** WixMedia video */
119
+ /** Program video. */
136
120
  video?: string;
137
121
  }
138
122
  interface FocalPoint {
@@ -155,44 +139,44 @@ interface VideoResolution {
155
139
  /** Video format for example, mp4, hls. */
156
140
  format?: string;
157
141
  }
142
+ /** Program scheduling settings. */
158
143
  interface Timeline {
159
- /** are sections/steps evaluated every day? Or can UoU participate in a self paced mode? */
144
+ /** Whether participants can progress at their own pace. */
160
145
  selfPaced?: boolean;
161
146
  /**
162
- * everyone starts on this day
147
+ * Local date when the scheduled program starts.
163
148
  * @format LOCAL_DATE
164
149
  */
165
150
  startDate?: string | null;
166
- /** duration of program in days (if applicable). */
151
+ /** Scheduled program duration in days. */
167
152
  durationInDays?: number | null;
168
153
  }
154
+ /** Access and participation restrictions for a program. */
169
155
  interface Restrictions {
170
156
  /**
171
- * limit of active participants in the program.
157
+ * Maximum number of active participants allowed in the program.
172
158
  * @min 1
173
159
  */
174
160
  maxParticipants?: number | null;
175
- /** hide steps in the Pending state. */
161
+ /** Whether future steps are hidden from participants until they become available. */
176
162
  hideFutureSteps?: boolean;
177
- /** allow participants complete steps in the certain order. */
163
+ /** Whether participants must complete steps in order. */
178
164
  resolveStepsInOrder?: boolean;
179
- /** allow program participants to share their progress in group */
165
+ /** Whether participants can share progress in the connected group. */
180
166
  shareProgress?: boolean;
181
- /** access restrictions options regarding visibility. */
182
- accessType?: RestrictionsAccessTypeWithLiterals;
167
+ /** Program discovery and join access. */
168
+ accessType?: AccessTypeWithLiterals;
183
169
  }
184
- declare enum RestrictionsAccessType {
185
- /** unknown access type */
186
- UNKNOWN_ACCESS_TYPE = "UNKNOWN_ACCESS_TYPE",
187
- /** join without approvals */
170
+ declare enum AccessType {
171
+ /** Anyone who can access the site can discover the program and start the join flow. */
188
172
  PUBLIC = "PUBLIC",
189
- /** send a join request to the owner and get an approval from him. */
173
+ /** The program can be discovered, but joining requires owner approval. */
190
174
  PRIVATE = "PRIVATE",
191
- /** join possible only after owner invite. */
175
+ /** The program is hidden from public discovery and visible only to participants, owners, and trusted apps. */
192
176
  SECRET = "SECRET"
193
177
  }
194
178
  /** @enumType */
195
- type RestrictionsAccessTypeWithLiterals = RestrictionsAccessType | 'UNKNOWN_ACCESS_TYPE' | 'PUBLIC' | 'PRIVATE' | 'SECRET';
179
+ type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET';
196
180
  /**
197
181
  * Money.
198
182
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
@@ -210,31 +194,32 @@ interface Money {
210
194
  */
211
195
  currency?: string;
212
196
  }
197
+ /** SEO settings for the program page. */
213
198
  interface Seo {
214
199
  /**
215
- * program slug expression
200
+ * Unique URL slug for the program page.
216
201
  * @format URL_SLUG
217
202
  */
218
203
  slug?: string;
219
- /** schema used by Seo team */
204
+ /** Advanced SEO schema data. */
220
205
  seoData?: SeoSchema;
221
206
  /**
222
- * program url
207
+ * Program page URL.
223
208
  * @readonly
224
209
  */
225
210
  url?: string;
226
211
  /**
227
- * image url from description media
212
+ * Image URL derived from the program description media.
228
213
  * @format WEB_URL
229
214
  */
230
215
  imageUrl?: string | null;
231
216
  /**
232
- * alt text of image
217
+ * Alternative text for the SEO image.
233
218
  * @maxLength 1000
234
219
  */
235
220
  imageAlt?: string;
236
221
  /**
237
- * Approximate SEO program duration in Iso-8601
222
+ * Approximate SEO program duration in ISO 8601 duration format.
238
223
  * @maxLength 100
239
224
  * @readonly
240
225
  */
@@ -298,47 +283,39 @@ interface Settings {
298
283
  */
299
284
  keywords?: Keyword[];
300
285
  }
286
+ /** Reward configuration for a program milestone. */
301
287
  interface Reward {
302
- /** 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. */
303
289
  trigger?: TriggerWithLiterals;
304
290
  /**
305
- * badges participant will get on program complete
291
+ * Badge IDs to assign when the reward is granted.
306
292
  * @format GUID
307
293
  * @maxSize 50
308
294
  */
309
295
  badgeIds?: string[];
310
- /** certificate for program. Currently is program GUID */
296
+ /** Certificate assigned when the reward is granted. */
311
297
  certificate?: Certificate;
312
298
  }
313
299
  declare enum Trigger {
314
- /** member joins the program */
300
+ /** Default trigger for existing rewards. The reward is granted when a member joins the program. */
315
301
  JOINED_TO_PROGRAM = "JOINED_TO_PROGRAM",
316
- /** at least one step completed */
302
+ /** The reward is granted when at least one step is completed. */
317
303
  STEP_COMPLETED = "STEP_COMPLETED",
318
- /** all steps are completed. */
304
+ /** The reward is granted when all required steps are completed. */
319
305
  ALL_STEPS_COMPLETED = "ALL_STEPS_COMPLETED"
320
306
  }
321
307
  /** @enumType */
322
308
  type TriggerWithLiterals = Trigger | 'JOINED_TO_PROGRAM' | 'STEP_COMPLETED' | 'ALL_STEPS_COMPLETED';
309
+ /** Certificate reward metadata. */
323
310
  interface Certificate {
324
311
  /**
325
- * Certificate for program completion. Currently is program GUID
312
+ * Certificate ID. Currently this is the program GUID.
326
313
  * @format GUID
327
314
  */
328
315
  _id?: string;
329
- /** date it was connected to program */
316
+ /** Date and time the certificate was connected to the program. */
330
317
  connectedDate?: Date | null;
331
318
  }
332
- declare enum AccessType {
333
- /** join without approvals */
334
- PUBLIC = "PUBLIC",
335
- /** send a join request to the owner and get an approval from him. */
336
- PRIVATE = "PRIVATE",
337
- /** join possible only after owner invite. */
338
- SECRET = "SECRET"
339
- }
340
- /** @enumType */
341
- type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET';
342
319
  interface ExtendedFields {
343
320
  /**
344
321
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -350,20 +327,22 @@ interface ExtendedFields {
350
327
  */
351
328
  namespaces?: Record<string, Record<string, any>>;
352
329
  }
330
+ /** Video step playback and completion settings. */
353
331
  interface VideoStepsSettings {
354
- /** 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. */
355
333
  autoNavigate?: boolean;
356
- /** 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. */
357
335
  requiredCompletionPercentage?: number;
358
336
  }
337
+ /** Read-only summary of program content. */
359
338
  interface ContentSummary {
360
339
  /**
361
- * number of steps in program
340
+ * Number of steps in the program.
362
341
  * @max 3000
363
342
  */
364
343
  stepCount?: number;
365
344
  /**
366
- * number of sections in program
345
+ * Number of sections in the program.
367
346
  * @max 1000
368
347
  */
369
348
  sectionCount?: number;
@@ -500,6 +479,10 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
500
479
  file?: File;
501
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) */
502
481
  customTag?: CustomTag;
482
+ /** Invalidate by multiple page ids */
483
+ pages?: Pages;
484
+ /** Invalidate by multiple URI paths */
485
+ uris?: URIs;
503
486
  /**
504
487
  * tell us why you're invalidating the cache. You don't need to add your app name
505
488
  * @maxLength 256
@@ -508,6 +491,14 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
508
491
  /** Is local DS */
509
492
  localDc?: boolean;
510
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;
511
502
  }
512
503
  /** @oneof */
513
504
  interface InvalidateCacheGetByOneOf {
@@ -531,6 +522,10 @@ interface InvalidateCacheGetByOneOf {
531
522
  file?: File;
532
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) */
533
524
  customTag?: CustomTag;
525
+ /** Invalidate by multiple page ids */
526
+ pages?: Pages;
527
+ /** Invalidate by multiple URI paths */
528
+ uris?: URIs;
534
529
  }
535
530
  interface App {
536
531
  /**
@@ -594,6 +589,32 @@ interface CustomTag {
594
589
  */
595
590
  tag?: string;
596
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
+ }
597
618
  /**
598
619
  * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
599
620
  * performs context manipulation with adding tenant, provided in message to callscope.
@@ -626,25 +647,25 @@ interface Schema {
626
647
  interface ProgramPublished {
627
648
  }
628
649
  interface ProgramEnded {
629
- /** true if ended manually by owner */
650
+ /** Whether the program was ended manually by the owner. */
630
651
  endedByOwner?: boolean;
631
652
  }
632
653
  interface ProgramArchived {
633
654
  }
634
655
  interface ProgramDuplicated {
635
- /** Newly created program */
656
+ /** Newly created program. */
636
657
  program?: Program;
637
- /** Program that was duplicated */
658
+ /** Program that was duplicated. */
638
659
  duplicatedFrom?: Program;
639
- /** Indicates if the program was cloned from a template */
660
+ /** Whether the program was cloned from a template. */
640
661
  fromTemplate?: boolean;
641
662
  }
642
663
  interface CreateProgramRequest {
643
- /** 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. */
644
665
  program: Program;
645
666
  }
646
667
  interface CreateProgramResponse {
647
- /** The created Program. */
668
+ /** Created draft program. */
648
669
  program?: Program;
649
670
  }
650
671
  interface BulkCreateProgramsMigrationRequest {
@@ -729,32 +750,32 @@ interface DeleteAllProgramsMigrationResponse {
729
750
  }
730
751
  interface DuplicateProgramRequest {
731
752
  /**
732
- * Program to be duplicated from.
753
+ * ID of the program to duplicate.
733
754
  * @format GUID
734
755
  */
735
756
  programId: string;
736
757
  }
737
758
  interface DuplicateProgramResponse {
738
- /** The created Program. */
759
+ /** New draft program created from the source program. */
739
760
  program?: Program;
740
761
  }
741
762
  interface GetProgramRequest {
742
763
  /**
743
- * ID of the Program to retrieve.
764
+ * ID of the program to retrieve.
744
765
  * @format GUID
745
766
  */
746
767
  programId: string;
747
768
  }
748
769
  interface GetProgramResponse {
749
- /** The requested Program. */
770
+ /** Requested program. */
750
771
  program?: Program;
751
772
  }
752
773
  interface UpdateProgramRequest {
753
- /** Program to be updated, may be partial. */
774
+ /** Program fields to update. Include `id` and the latest `revision`. */
754
775
  program: Program;
755
776
  }
756
777
  interface UpdateProgramResponse {
757
- /** Updated Program. */
778
+ /** Updated program. */
758
779
  program?: Program;
759
780
  }
760
781
  interface WrongStateErrorDetails {
@@ -762,7 +783,7 @@ interface WrongStateErrorDetails {
762
783
  interface WrongStartDateErrorDetails {
763
784
  }
764
785
  interface WrongParticipantsNumberErrorDetails {
765
- /** Participants that already joined the program */
786
+ /** Number of active participants already in the program. */
766
787
  activeParticipantsCount?: number;
767
788
  }
768
789
  interface DuplicatedSlugErrorDetails {
@@ -771,7 +792,7 @@ interface TimelineSwitchForbiddenErrorDetails {
771
792
  }
772
793
  interface DeleteProgramRequest {
773
794
  /**
774
- * Id of the Program to delete.
795
+ * ID of the program to delete.
775
796
  * @format GUID
776
797
  */
777
798
  programId: string;
@@ -779,7 +800,7 @@ interface DeleteProgramRequest {
779
800
  interface DeleteProgramResponse {
780
801
  }
781
802
  interface QueryProgramsRequest {
782
- /** Query to filter programs */
803
+ /** Query used to filter, sort, and page programs. */
783
804
  query?: QueryV2;
784
805
  }
785
806
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -790,13 +811,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
790
811
  /**
791
812
  * Filter object.
792
813
  *
793
- * 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).
794
815
  */
795
816
  filter?: Record<string, any> | null;
796
817
  /**
797
818
  * Sort object.
798
819
  *
799
- * 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).
800
821
  * @maxSize 100
801
822
  */
802
823
  sort?: Sorting[];
@@ -856,9 +877,9 @@ interface CursorPaging {
856
877
  cursor?: string | null;
857
878
  }
858
879
  interface QueryProgramsResponse {
859
- /** Found programs */
880
+ /** Programs that match the query and caller visibility. */
860
881
  programs?: Program[];
861
- /** paging */
882
+ /** Paging metadata for the query response. */
862
883
  pagingMetadata?: PagingMetadataV2;
863
884
  }
864
885
  interface PagingMetadataV2 {
@@ -886,26 +907,26 @@ interface Cursors {
886
907
  prev?: string | null;
887
908
  }
888
909
  interface SearchProgramsRequest {
889
- /** Query to search programs */
910
+ /** Search expression, filters, sorting, and cursor paging options. */
890
911
  search?: CursorSearch;
891
912
  }
892
913
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
893
914
  /**
894
915
  * Cursor paging options.
895
916
  *
896
- * 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).
897
918
  */
898
919
  cursorPaging?: CursorPaging;
899
920
  /**
900
921
  * Filter object.
901
922
  *
902
- * 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).
903
924
  */
904
925
  filter?: Record<string, any> | null;
905
926
  /**
906
927
  * List of sort objects.
907
928
  *
908
- * 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).
909
930
  * @maxSize 10
910
931
  */
911
932
  sort?: Sorting[];
@@ -933,7 +954,7 @@ interface CursorSearchPagingMethodOneOf {
933
954
  /**
934
955
  * Cursor paging options.
935
956
  *
936
- * 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).
937
958
  */
938
959
  cursorPaging?: CursorPaging;
939
960
  }
@@ -1019,7 +1040,6 @@ interface IncludeMissingValuesOptions {
1019
1040
  addToBucket?: string;
1020
1041
  }
1021
1042
  declare enum ScalarType {
1022
- UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1023
1043
  /** Count of distinct values. */
1024
1044
  COUNT_DISTINCT = "COUNT_DISTINCT",
1025
1045
  /** Minimum value. */
@@ -1028,7 +1048,7 @@ declare enum ScalarType {
1028
1048
  MAX = "MAX"
1029
1049
  }
1030
1050
  /** @enumType */
1031
- type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1051
+ type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1032
1052
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
1033
1053
  /** Options for including missing values. */
1034
1054
  includeOptions?: IncludeMissingValuesOptions;
@@ -1047,7 +1067,6 @@ interface ValueAggregationOptionsOneOf {
1047
1067
  includeOptions?: IncludeMissingValuesOptions;
1048
1068
  }
1049
1069
  declare enum NestedAggregationType {
1050
- UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1051
1070
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1052
1071
  VALUE = "VALUE",
1053
1072
  /** An aggregation, where user can define set of ranges - each representing a bucket. */
@@ -1058,7 +1077,7 @@ declare enum NestedAggregationType {
1058
1077
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1059
1078
  }
1060
1079
  /** @enumType */
1061
- type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1080
+ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1062
1081
  interface RangeAggregation {
1063
1082
  /**
1064
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.
@@ -1075,7 +1094,6 @@ interface DateHistogramAggregation {
1075
1094
  interval?: IntervalWithLiterals;
1076
1095
  }
1077
1096
  declare enum Interval {
1078
- UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1079
1097
  /** Yearly interval */
1080
1098
  YEAR = "YEAR",
1081
1099
  /** Monthly interval */
@@ -1092,7 +1110,7 @@ declare enum Interval {
1092
1110
  SECOND = "SECOND"
1093
1111
  }
1094
1112
  /** @enumType */
1095
- type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1113
+ type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1096
1114
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1097
1115
  /** Value aggregation. */
1098
1116
  value?: ValueAggregation;
@@ -1127,7 +1145,6 @@ interface NestedAggregationItemKindOneOf {
1127
1145
  dateHistogram?: DateHistogramAggregation;
1128
1146
  }
1129
1147
  declare enum AggregationType {
1130
- UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1131
1148
  /** An aggregation where result buckets are dynamically built - one per unique value. */
1132
1149
  VALUE = "VALUE",
1133
1150
  /** An aggregation, where user can define set of ranges - each representing a bucket. */
@@ -1140,7 +1157,7 @@ declare enum AggregationType {
1140
1157
  NESTED = "NESTED"
1141
1158
  }
1142
1159
  /** @enumType */
1143
- type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1160
+ type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1144
1161
  /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
1145
1162
  interface NestedAggregation {
1146
1163
  /**
@@ -1195,11 +1212,11 @@ declare enum Mode {
1195
1212
  /** @enumType */
1196
1213
  type ModeWithLiterals = Mode | 'OR' | 'AND';
1197
1214
  interface SearchProgramsResponse {
1198
- /** Found programs */
1215
+ /** Programs that match the search and caller visibility. */
1199
1216
  programs?: Program[];
1200
- /** paging */
1217
+ /** Cursor paging metadata. */
1201
1218
  pagingMetadata?: CursorPagingMetadata;
1202
- /** aggregation */
1219
+ /** Aggregation data returned by the search backend. */
1203
1220
  aggregationData?: AggregationData;
1204
1221
  }
1205
1222
  interface CursorPagingMetadata {
@@ -1420,90 +1437,91 @@ interface AggregationResultsResultOneOf {
1420
1437
  }
1421
1438
  interface PublishProgramRequest {
1422
1439
  /**
1423
- * Program to publish
1440
+ * ID of the draft program to publish.
1424
1441
  * @format GUID
1425
1442
  */
1426
1443
  programId: string;
1427
1444
  }
1428
1445
  interface PublishProgramResponse {
1429
- /** Published program */
1446
+ /** Published program. */
1430
1447
  program?: Program;
1431
1448
  }
1432
1449
  interface EndProgramRequest {
1433
1450
  /**
1434
- * Program to finish
1451
+ * ID of the published program to end.
1435
1452
  * @format GUID
1436
1453
  */
1437
1454
  programId: string;
1438
1455
  }
1439
1456
  interface EndProgramResponse {
1440
- /** Finished program */
1457
+ /** Ended program. */
1441
1458
  program?: Program;
1442
1459
  }
1443
1460
  interface ArchiveProgramRequest {
1444
1461
  /**
1445
- * Program to archive
1462
+ * ID of the program to archive.
1446
1463
  * @format GUID
1447
1464
  */
1448
1465
  programId: string;
1449
1466
  }
1450
1467
  interface ArchiveProgramResponse {
1451
- /** Archived program */
1468
+ /** Archived program. */
1452
1469
  program?: Program;
1453
1470
  }
1454
1471
  interface BulkUpdateProgramsRequest {
1455
1472
  /**
1456
- * List of programs you want to update
1473
+ * Programs to update. Each item contains partial program data.
1457
1474
  * @minSize 1
1458
1475
  * @maxSize 100
1459
1476
  */
1460
1477
  programs: MaskedProgram[];
1461
- /** set to `true` if you wish to receive back the created programs in the response */
1478
+ /** Whether to return updated programs in the response. */
1462
1479
  returnEntity?: boolean;
1463
1480
  }
1464
1481
  interface MaskedProgram {
1465
- /** Program to be updated, may be partial */
1482
+ /** Partial program to update. Include `id` and the latest `revision`. */
1466
1483
  program?: Program;
1467
- /** 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. */
1468
1485
  fieldMask?: string[];
1469
1486
  }
1470
1487
  interface BulkUpdateProgramsResponse {
1471
1488
  /**
1489
+ * Per-item update results.
1472
1490
  * @minSize 1
1473
1491
  * @maxSize 100
1474
1492
  */
1475
1493
  results?: BulkUpdateProgramResult[];
1476
- /** metadata */
1494
+ /** Summary metadata for the bulk update. */
1477
1495
  bulkActionMetadata?: BulkActionMetadata;
1478
1496
  }
1479
1497
  interface BulkUpdateProgramResult {
1480
- /** item metadata */
1498
+ /** Result metadata for this item. */
1481
1499
  itemMetadata?: ItemMetadata;
1482
- /** Only exists if `returnEntity` was set to true in the request */
1500
+ /** Updated program. This is returned only when `return_entity` is true. */
1483
1501
  item?: Program;
1484
1502
  }
1485
1503
  interface CountProgramsRequest {
1486
- /** filter for which count is requested */
1504
+ /** WQL filter for the programs to count. */
1487
1505
  filter?: Record<string, any> | null;
1488
1506
  }
1489
1507
  interface CountProgramsResponse {
1490
- /** count of programs matching filter */
1508
+ /** Number of programs matching the filter and caller visibility. */
1491
1509
  count?: number;
1492
1510
  }
1493
1511
  interface ListSampleProgramsRequest {
1494
1512
  }
1495
1513
  interface ListSampleProgramsResponse {
1496
1514
  /**
1497
- * sample programs
1515
+ * Sample programs available as templates.
1498
1516
  * @maxSize 100
1499
1517
  */
1500
1518
  programs?: LabeledProgram[];
1501
1519
  }
1502
1520
  interface LabeledProgram {
1503
- /** sample program */
1521
+ /** Sample program. */
1504
1522
  program?: Program;
1505
1523
  /**
1506
- * label, showing category for program
1524
+ * Display label for the sample program.
1507
1525
  * @maxLength 1000
1508
1526
  */
1509
1527
  label?: string;
@@ -1537,7 +1555,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
1537
1555
  /** If present, indicates the action that triggered the event. */
1538
1556
  originatedFrom?: string | null;
1539
1557
  /**
1540
- * 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.
1541
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.
1542
1560
  */
1543
1561
  entityEventSequence?: string | null;
@@ -1646,6 +1664,10 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1646
1664
  userDomainMediaEnabled?: UserDomainMediaEnabled;
1647
1665
  /** Emitted when media from user domain is disabled. */
1648
1666
  userDomainMediaDisabled?: UserDomainMediaDisabled;
1667
+ /** Emitted when Editorless is attached. */
1668
+ editorlessAssigned?: EditorlessAssigned;
1669
+ /** Emitted when Editorless is detached. */
1670
+ editorlessUnassigned?: EditorlessUnassigned;
1649
1671
  /**
1650
1672
  * A meta site id.
1651
1673
  * @format GUID
@@ -1724,6 +1746,10 @@ interface MetaSiteSpecialEventPayloadOneOf {
1724
1746
  userDomainMediaEnabled?: UserDomainMediaEnabled;
1725
1747
  /** Emitted when media from user domain is disabled. */
1726
1748
  userDomainMediaDisabled?: UserDomainMediaDisabled;
1749
+ /** Emitted when Editorless is attached. */
1750
+ editorlessAssigned?: EditorlessAssigned;
1751
+ /** Emitted when Editorless is detached. */
1752
+ editorlessUnassigned?: EditorlessUnassigned;
1727
1753
  }
1728
1754
  interface Asset {
1729
1755
  /**
@@ -1881,10 +1907,19 @@ declare enum Namespace {
1881
1907
  /** Base44 headless sites. */
1882
1908
  BASE44 = "BASE44",
1883
1909
  /** Wix Channels Sites */
1884
- 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"
1885
1920
  }
1886
1921
  /** @enumType */
1887
- 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';
1888
1923
  /** Site transferred to another user. */
1889
1924
  interface SiteTransferred {
1890
1925
  /**
@@ -2092,6 +2127,12 @@ interface UserDomainMediaEnabled {
2092
2127
  /** Media from user domain is disabled. */
2093
2128
  interface UserDomainMediaDisabled {
2094
2129
  }
2130
+ /** Assigned Editorless */
2131
+ interface EditorlessAssigned {
2132
+ }
2133
+ /** Unassigned Editorless */
2134
+ interface EditorlessUnassigned {
2135
+ }
2095
2136
  interface SearchIndexingNotification {
2096
2137
  /** new state of indexing for the site specified in ms_id */
2097
2138
  indexState?: SearchIndexingNotificationStateWithLiterals;
@@ -2186,6 +2227,11 @@ interface Properties {
2186
2227
  externalSiteUrl?: string | null;
2187
2228
  /** Track clicks analytics. */
2188
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;
2189
2235
  }
2190
2236
  interface Categories {
2191
2237
  /** Primary site category. */
@@ -2478,54 +2524,71 @@ type PublishProgramApplicationErrors = {
2478
2524
  data?: Record<string, any>;
2479
2525
  };
2480
2526
  /**
2481
- * Creates a Program.
2482
- * @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.
2483
2533
  * @public
2484
- * @documentationMaturity preview
2485
2534
  * @requiredField program
2486
2535
  * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE
2487
2536
  * @applicableIdentity APP
2488
- * @returns The created Program.
2537
+ * @returns Created draft program.
2489
2538
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.CreateProgram
2490
2539
  */
2491
- 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>>;
2492
2541
  /**
2493
- * Duplicates the Program. Leaves certificate template, but removes social group.
2494
- * @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.
2495
2549
  * @public
2496
- * @documentationMaturity preview
2497
2550
  * @requiredField programId
2498
2551
  * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE
2499
2552
  * @applicableIdentity APP
2500
2553
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.DuplicateProgram
2501
2554
  */
2502
- 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>>;
2503
2556
  /**
2504
- * Retrieves a Program.
2505
- * @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.
2506
2564
  * @public
2507
- * @documentationMaturity preview
2508
2565
  * @requiredField programId
2509
2566
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2510
2567
  * @applicableIdentity APP
2511
- * @returns The requested Program.
2568
+ * @returns Requested program.
2512
2569
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.GetProgram
2513
2570
  */
2514
- 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>>;
2515
2572
  /**
2516
- * 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.
2517
2581
  * @param _id - Program ID.
2518
2582
  * @public
2519
- * @documentationMaturity preview
2520
2583
  * @requiredField _id
2521
2584
  * @requiredField program
2522
2585
  * @requiredField program.revision
2523
2586
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2524
2587
  * @applicableIdentity APP
2525
- * @returns Updated Program.
2588
+ * @returns Updated program.
2526
2589
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.UpdateProgram
2527
2590
  */
2528
- 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> & {
2529
2592
  __applicationErrorsType?: UpdateProgramApplicationErrors;
2530
2593
  }>;
2531
2594
  interface UpdateProgram {
@@ -2535,97 +2598,83 @@ interface UpdateProgram {
2535
2598
  * @readonly
2536
2599
  */
2537
2600
  _id?: string | null;
2538
- /** @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
+ */
2539
2605
  revision?: string | null;
2540
- /** @readonly */
2541
- _createdDate?: Date | null;
2542
- /** @readonly */
2543
- _updatedDate?: Date | null;
2544
2606
  /**
2545
- * current program state / does participant need it?
2607
+ * Date and time the program was created.
2546
2608
  * @readonly
2547
- * @deprecated
2548
- * @replacedBy status
2549
- * @targetRemovalDate 2025-10-15
2550
2609
  */
2551
- state?: V3StateWithLiterals;
2610
+ _createdDate?: Date | null;
2552
2611
  /**
2553
- * current program state in v2 format
2612
+ * Date and time the program was last updated.
2554
2613
  * @readonly
2555
2614
  */
2556
- status?: StatusWithLiterals;
2615
+ _updatedDate?: Date | null;
2557
2616
  /**
2558
- * @internal
2617
+ * Current program lifecycle status.
2559
2618
  * @readonly
2560
- * @deprecated
2561
- * @replacedBy status_updated_date
2562
- * @targetRemovalDate 2025-10-15
2563
2619
  */
2564
- stateUpdatedDate?: Date | null;
2620
+ status?: StatusWithLiterals;
2565
2621
  /**
2566
- * date of the last status update
2567
- * @internal
2622
+ * Date and time when `status` last changed.
2568
2623
  * @readonly
2569
2624
  */
2570
2625
  statusUpdatedDate?: Date | null;
2571
2626
  /**
2572
- * assigned categories
2627
+ * Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories.
2573
2628
  * @readonly
2574
2629
  * @format GUID
2575
2630
  * @maxSize 10
2576
2631
  */
2577
2632
  categoryIds?: string[];
2578
- /** general program info. */
2633
+ /** Public-facing program title, details, and media. */
2579
2634
  description?: Description;
2580
- /** timeline type -> Self-paced, time-restricted. */
2635
+ /** Program timeline settings. Use this to configure self-paced or scheduled programs. */
2581
2636
  timeline?: Timeline;
2582
- /** participant limitation, step-completion pace and etc. */
2637
+ /** Program access, participation, and progression rules. */
2583
2638
  restrictions?: Restrictions;
2584
- /** single-payment price. */
2639
+ /** Optional one-time payment price for joining the program. */
2585
2640
  price?: Money;
2586
- /** seo settings. */
2641
+ /** SEO settings used for the program page. */
2587
2642
  seo?: Seo;
2588
2643
  /**
2589
- * rewards to be assigned after reaching some of the program milestones.
2644
+ * Rewards assigned to participants when they reach configured milestones.
2590
2645
  * @maxSize 10
2591
2646
  */
2592
2647
  rewards?: Reward[];
2593
2648
  /**
2594
- * connected social group.
2649
+ * ID of the social group connected to the program, if one exists.
2595
2650
  * @format GUID
2596
2651
  */
2597
2652
  socialGroupId?: string | null;
2598
- /**
2599
- * join flow options.
2600
- * @deprecated
2601
- * @replacedBy restrictions.access_type
2602
- * @targetRemovalDate 2025-10-15
2603
- */
2604
- accessType?: AccessTypeWithLiterals;
2605
- /** extensible field */
2653
+ /** Custom fields for apps that extend the Program entity. */
2606
2654
  extendedFields?: ExtendedFields;
2607
- /** 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. */
2608
2656
  shouldSendInvoice?: boolean;
2609
- /** settings related to video steps in programs */
2657
+ /** Settings that control how video steps behave in this program. */
2610
2658
  videoStepsSettings?: VideoStepsSettings;
2611
2659
  /**
2612
- * number of content entities in program
2660
+ * Read-only counts of content entities in the program.
2613
2661
  * @readonly
2614
2662
  */
2615
2663
  contentSummary?: ContentSummary;
2616
2664
  /**
2617
- * user id of owner, who created this program
2665
+ * ID of the site user who created the program.
2618
2666
  * @format GUID
2619
2667
  * @readonly
2620
2668
  */
2621
2669
  ownerUserId?: string | null;
2622
2670
  }
2623
2671
  /**
2624
- * Deletes a Program.
2625
- * Deleting a Program permanently removes them from the Program List.
2626
- * @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.
2627
2677
  * @public
2628
- * @documentationMaturity preview
2629
2678
  * @requiredField programId
2630
2679
  * @permissionId ONLINE_PROGRAMS.PROGRAM_DELETE
2631
2680
  * @applicableIdentity APP
@@ -2633,9 +2682,18 @@ interface UpdateProgram {
2633
2682
  */
2634
2683
  declare function deleteProgram(programId: string): Promise<void>;
2635
2684
  /**
2636
- * 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.
2637
2696
  * @public
2638
- * @documentationMaturity preview
2639
2697
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2640
2698
  * @applicableIdentity APP
2641
2699
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms
@@ -2657,40 +2715,26 @@ interface ProgramsQueryResult extends QueryCursorResult {
2657
2715
  interface ProgramsQueryBuilder {
2658
2716
  /** @param propertyName - Property whose value is compared with `value`.
2659
2717
  * @param value - Value to compare against.
2660
- * @documentationMaturity preview
2661
2718
  */
2662
- 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;
2663
2720
  /** @param propertyName - Property whose value is compared with `values`.
2664
2721
  * @param values - List of values to compare against.
2665
- * @documentationMaturity preview
2666
2722
  */
2667
2723
  hasSome: (propertyName: string, value: any[]) => ProgramsQueryBuilder;
2668
2724
  /** @param propertyName - Property whose value is compared with `values`.
2669
2725
  * @param values - List of values to compare against.
2670
- * @documentationMaturity preview
2671
2726
  */
2672
2727
  hasAll: (propertyName: string, value: any[]) => ProgramsQueryBuilder;
2673
- /** @documentationMaturity preview */
2674
- in: (propertyName: '_id' | 'state' | 'status' | 'restrictions.accessType' | 'socialGroupId' | 'accessType', value: any) => ProgramsQueryBuilder;
2675
- /** @documentationMaturity preview */
2728
+ in: (propertyName: '_id' | 'status' | 'restrictions.accessType' | 'socialGroupId', value: any) => ProgramsQueryBuilder;
2676
2729
  exists: (propertyName: 'price', value: boolean) => ProgramsQueryBuilder;
2677
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2678
- * @documentationMaturity preview
2679
- */
2680
- ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'status' | 'stateUpdatedDate' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2681
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2682
- * @documentationMaturity preview
2683
- */
2684
- descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'status' | 'stateUpdatedDate' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2685
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2686
- * @documentationMaturity preview
2687
- */
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. */
2688
2735
  limit: (limit: number) => ProgramsQueryBuilder;
2689
- /** @param cursor - A pointer to specific record
2690
- * @documentationMaturity preview
2691
- */
2736
+ /** @param cursor - A pointer to specific record */
2692
2737
  skipTo: (cursor: string) => ProgramsQueryBuilder;
2693
- /** @documentationMaturity preview */
2694
2738
  find: () => Promise<ProgramsQueryResult>;
2695
2739
  }
2696
2740
  /**
@@ -2698,7 +2742,7 @@ interface ProgramsQueryBuilder {
2698
2742
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms
2699
2743
  * @requiredField query
2700
2744
  */
2701
- 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>>;
2702
2746
  interface ProgramQuerySpec extends QuerySpec {
2703
2747
  paging: 'cursor';
2704
2748
  wql: [
@@ -2707,11 +2751,6 @@ interface ProgramQuerySpec extends QuerySpec {
2707
2751
  operators: ['$eq', '$in'];
2708
2752
  sort: 'BOTH';
2709
2753
  },
2710
- {
2711
- fields: ['state'];
2712
- operators: ['$eq', '$in'];
2713
- sort: 'BOTH';
2714
- },
2715
2754
  {
2716
2755
  fields: ['status'];
2717
2756
  operators: ['$eq', '$in'];
@@ -2732,11 +2771,6 @@ interface ProgramQuerySpec extends QuerySpec {
2732
2771
  operators: [];
2733
2772
  sort: 'BOTH';
2734
2773
  },
2735
- {
2736
- fields: ['stateUpdatedDate'];
2737
- operators: [];
2738
- sort: 'BOTH';
2739
- },
2740
2774
  {
2741
2775
  fields: ['statusUpdatedDate'];
2742
2776
  operators: [];
@@ -2757,11 +2791,6 @@ interface ProgramQuerySpec extends QuerySpec {
2757
2791
  operators: ['$exists'];
2758
2792
  sort: 'NONE';
2759
2793
  },
2760
- {
2761
- fields: ['accessType'];
2762
- operators: ['$in'];
2763
- sort: 'NONE';
2764
- },
2765
2794
  {
2766
2795
  fields: ['restrictions.accessType'];
2767
2796
  operators: ['$in'];
@@ -2797,13 +2826,13 @@ type ProgramQuery = {
2797
2826
  /**
2798
2827
  Filter object.
2799
2828
 
2800
- 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).
2801
2830
  */
2802
2831
  filter?: CommonQueryWithEntityContext['filter'] | null;
2803
2832
  /**
2804
2833
  Sort object.
2805
2834
 
2806
- 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).
2807
2836
  @maxSize: 100
2808
2837
  */
2809
2838
  sort?: {
@@ -2818,15 +2847,27 @@ type ProgramQuery = {
2818
2847
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
2819
2848
  }[];
2820
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
+ };
2821
2864
  interface ProgramSearchSpec extends SearchSpec {
2822
2865
  searchable: ['description.title'];
2823
2866
  aggregatable: [
2824
2867
  '_id',
2825
- 'accessType',
2826
2868
  'categoryIds',
2827
2869
  'description.title',
2828
2870
  'restrictions.accessType',
2829
- 'state',
2830
2871
  'status',
2831
2872
  'timeline.selfPaced'
2832
2873
  ];
@@ -2837,11 +2878,6 @@ interface ProgramSearchSpec extends SearchSpec {
2837
2878
  fields: ['_id', 'description.title'];
2838
2879
  sort: 'BOTH';
2839
2880
  },
2840
- {
2841
- operators: ['$eq', '$in'];
2842
- fields: ['state'];
2843
- sort: 'BOTH';
2844
- },
2845
2881
  {
2846
2882
  operators: ['$eq', '$in'];
2847
2883
  fields: ['status'];
@@ -2857,11 +2893,6 @@ interface ProgramSearchSpec extends SearchSpec {
2857
2893
  fields: ['timeline.selfPaced'];
2858
2894
  sort: 'NONE';
2859
2895
  },
2860
- {
2861
- operators: ['$in'];
2862
- fields: ['accessType'];
2863
- sort: 'NONE';
2864
- },
2865
2896
  {
2866
2897
  operators: ['$in'];
2867
2898
  fields: ['restrictions.accessType'];
@@ -2884,7 +2915,7 @@ type ProgramSearch = {
2884
2915
  /**
2885
2916
  Cursor paging options.
2886
2917
 
2887
- 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).
2888
2919
  */
2889
2920
  cursorPaging?: {
2890
2921
  /**
@@ -2904,13 +2935,13 @@ type ProgramSearch = {
2904
2935
  /**
2905
2936
  Filter object.
2906
2937
 
2907
- 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).
2908
2939
  */
2909
2940
  filter?: CommonSearchWithEntityContext['filter'] | null;
2910
2941
  /**
2911
2942
  List of sort objects.
2912
2943
 
2913
- 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).
2914
2945
  @maxSize: 10
2915
2946
  */
2916
2947
  sort?: {
@@ -3008,77 +3039,86 @@ type ProgramSearch = {
3008
3039
  timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
3009
3040
  };
3010
3041
  /**
3011
- * Publishes draft program. In other state returns program as is.
3012
- * @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.
3013
3048
  * @public
3014
- * @documentationMaturity preview
3015
3049
  * @requiredField programId
3016
3050
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3017
3051
  * @applicableIdentity APP
3018
3052
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.PublishProgram
3019
3053
  */
3020
- 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> & {
3021
3055
  __applicationErrorsType?: PublishProgramApplicationErrors;
3022
3056
  }>;
3023
3057
  /**
3024
- * Ends program.
3025
- * @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.
3026
3063
  * @public
3027
- * @documentationMaturity preview
3028
3064
  * @requiredField programId
3029
3065
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3030
3066
  * @applicableIdentity APP
3031
3067
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.EndProgram
3032
3068
  */
3033
- 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>>;
3034
3070
  /**
3035
- * Archives program
3036
- * @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.
3037
3076
  * @public
3038
- * @documentationMaturity preview
3039
3077
  * @requiredField programId
3040
3078
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3041
3079
  * @applicableIdentity APP
3042
3080
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.ArchiveProgram
3043
3081
  */
3044
- 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>>;
3045
3083
  /**
3046
- * Update multiple Programs in a single request. Works synchronously.
3047
- * @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.
3048
3089
  * @public
3049
- * @documentationMaturity preview
3050
3090
  * @requiredField programs
3051
3091
  * @requiredField programs.program.revision
3052
3092
  * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
3053
3093
  * @applicableIdentity APP
3054
3094
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.BulkUpdatePrograms
3055
3095
  */
3056
- 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>>;
3057
3097
  interface BulkUpdateProgramsOptions {
3058
- /** set to `true` if you wish to receive back the created programs in the response */
3098
+ /** Whether to return updated programs in the response. */
3059
3099
  returnEntity?: boolean;
3060
3100
  }
3061
3101
  /**
3062
- * Counts programs matching the filter
3102
+ * Counts programs that match a filter.
3103
+ *
3104
+ * Results use the same visibility rules as `QueryPrograms`.
3063
3105
  * @public
3064
- * @documentationMaturity preview
3065
3106
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
3066
3107
  * @applicableIdentity APP
3067
3108
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.CountPrograms
3068
3109
  */
3069
3110
  declare function countPrograms(options?: CountProgramsOptions): Promise<NonNullablePaths<CountProgramsResponse, `count`, 2>>;
3070
3111
  interface CountProgramsOptions {
3071
- /** filter for which count is requested */
3112
+ /** WQL filter for the programs to count. */
3072
3113
  filter?: Record<string, any> | null;
3073
3114
  }
3074
3115
  /**
3075
- * Returns list of sample programs.
3116
+ * Lists sample programs used as templates for creating new programs.
3076
3117
  * @public
3077
- * @documentationMaturity preview
3078
3118
  * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
3079
3119
  * @applicableIdentity APP
3080
3120
  * @fqn wix.onlineprograms.programs.v3.ProgramsService.ListSamplePrograms
3081
3121
  */
3082
- 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>>;
3083
3123
 
3084
- 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 };