@wix/auto_sdk_online-programs_programs 1.0.0

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 (43) hide show
  1. package/build/cjs/index.d.ts +129 -0
  2. package/build/cjs/index.js +1834 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +19 -0
  5. package/build/cjs/index.typings.js +1725 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1235 -0
  8. package/build/cjs/meta.js +1142 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/online-programs-v3-program-programs.universal-D4bCXD7K.d.ts +2867 -0
  11. package/build/es/index.d.mts +129 -0
  12. package/build/es/index.mjs +1773 -0
  13. package/build/es/index.mjs.map +1 -0
  14. package/build/es/index.typings.d.mts +19 -0
  15. package/build/es/index.typings.mjs +1664 -0
  16. package/build/es/index.typings.mjs.map +1 -0
  17. package/build/es/meta.d.mts +1235 -0
  18. package/build/es/meta.mjs +1103 -0
  19. package/build/es/meta.mjs.map +1 -0
  20. package/build/es/online-programs-v3-program-programs.universal-D4bCXD7K.d.mts +2867 -0
  21. package/build/es/package.json +3 -0
  22. package/build/internal/cjs/index.d.ts +129 -0
  23. package/build/internal/cjs/index.js +1834 -0
  24. package/build/internal/cjs/index.js.map +1 -0
  25. package/build/internal/cjs/index.typings.d.ts +19 -0
  26. package/build/internal/cjs/index.typings.js +1725 -0
  27. package/build/internal/cjs/index.typings.js.map +1 -0
  28. package/build/internal/cjs/meta.d.ts +1235 -0
  29. package/build/internal/cjs/meta.js +1142 -0
  30. package/build/internal/cjs/meta.js.map +1 -0
  31. package/build/internal/cjs/online-programs-v3-program-programs.universal-DOkVx-lj.d.ts +2895 -0
  32. package/build/internal/es/index.d.mts +129 -0
  33. package/build/internal/es/index.mjs +1773 -0
  34. package/build/internal/es/index.mjs.map +1 -0
  35. package/build/internal/es/index.typings.d.mts +19 -0
  36. package/build/internal/es/index.typings.mjs +1664 -0
  37. package/build/internal/es/index.typings.mjs.map +1 -0
  38. package/build/internal/es/meta.d.mts +1235 -0
  39. package/build/internal/es/meta.mjs +1103 -0
  40. package/build/internal/es/meta.mjs.map +1 -0
  41. package/build/internal/es/online-programs-v3-program-programs.universal-DOkVx-lj.d.mts +2895 -0
  42. package/meta/package.json +3 -0
  43. package/package.json +54 -0
@@ -0,0 +1,2895 @@
1
+ import { SearchSpec, Search, NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ interface Program {
4
+ /**
5
+ * Program ID.
6
+ * @format GUID
7
+ * @readonly
8
+ */
9
+ _id?: string | null;
10
+ /** @readonly */
11
+ revision?: string | null;
12
+ /** @readonly */
13
+ _createdDate?: Date | null;
14
+ /** @readonly */
15
+ _updatedDate?: Date | null;
16
+ /**
17
+ * current program state / does participant need it?
18
+ * @readonly
19
+ * @deprecated
20
+ * @replacedBy status
21
+ * @targetRemovalDate 2025-10-15
22
+ */
23
+ state?: V3StateWithLiterals;
24
+ /**
25
+ * current program state in v2 format
26
+ * @readonly
27
+ */
28
+ status?: StatusWithLiterals;
29
+ /**
30
+ * @internal
31
+ * @readonly
32
+ * @deprecated
33
+ * @replacedBy status_updated_date
34
+ * @targetRemovalDate 2025-10-15
35
+ */
36
+ stateUpdatedDate?: Date | null;
37
+ /**
38
+ * date of the last status update
39
+ * @internal
40
+ * @readonly
41
+ */
42
+ statusUpdatedDate?: Date | null;
43
+ /**
44
+ * assigned categories
45
+ * @readonly
46
+ * @format GUID
47
+ * @maxSize 10
48
+ */
49
+ categoryIds?: string[];
50
+ /** general program info. */
51
+ description?: Description;
52
+ /** timeline type -> Self-paced, time-restricted. */
53
+ timeline?: Timeline;
54
+ /** participant limitation, step-completion pace and etc. */
55
+ restrictions?: Restrictions;
56
+ /** single-payment price. */
57
+ price?: Money;
58
+ /** seo settings. */
59
+ seo?: Seo;
60
+ /**
61
+ * rewards to be assigned after reaching some of the program milestones.
62
+ * @maxSize 10
63
+ */
64
+ rewards?: Reward[];
65
+ /**
66
+ * connected social group.
67
+ * @format GUID
68
+ */
69
+ 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 */
78
+ extendedFields?: ExtendedFields;
79
+ /** if true -> invoice is sent to the customer who purchased the program via single payment; else -> payment confirmation email is sent */
80
+ shouldSendInvoice?: boolean;
81
+ /** settings related to video steps in programs */
82
+ videoStepsSettings?: VideoStepsSettings;
83
+ /**
84
+ * number of content entities in program
85
+ * @readonly
86
+ */
87
+ contentSummary?: ContentSummary;
88
+ /**
89
+ * user id of owner, who created this program
90
+ * @format GUID
91
+ * @readonly
92
+ */
93
+ ownerUserId?: string | null;
94
+ }
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
+ declare enum Status {
108
+ /** unknown state */
109
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
110
+ /** not published program, visible only on BM */
111
+ DRAFT = "DRAFT",
112
+ /** program visible regarding to restrictions */
113
+ PUBLISHED = "PUBLISHED",
114
+ /** program isn't available to join. */
115
+ ENDED = "ENDED",
116
+ /** closed program. Joins and sections/steps are not available for participants. */
117
+ ARCHIVED = "ARCHIVED"
118
+ }
119
+ /** @enumType */
120
+ type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED';
121
+ interface Description extends DescriptionMediaOneOf {
122
+ /** WixMedia image */
123
+ image?: string;
124
+ /** WixMedia video */
125
+ video?: string;
126
+ /** @maxLength 150 */
127
+ title?: string;
128
+ /** @maxLength 8000 */
129
+ details?: string | null;
130
+ }
131
+ /** @oneof */
132
+ interface DescriptionMediaOneOf {
133
+ /** WixMedia image */
134
+ image?: string;
135
+ /** WixMedia video */
136
+ video?: string;
137
+ }
138
+ interface FocalPoint {
139
+ /** X-coordinate of the focal point. */
140
+ x?: number;
141
+ /** Y-coordinate of the focal point. */
142
+ y?: number;
143
+ /** crop by height */
144
+ height?: number | null;
145
+ /** crop by width */
146
+ width?: number | null;
147
+ }
148
+ interface VideoResolution {
149
+ /** Video URL. */
150
+ url?: string;
151
+ /** Video height. */
152
+ height?: number;
153
+ /** Video width. */
154
+ width?: number;
155
+ /** Video format for example, mp4, hls. */
156
+ format?: string;
157
+ }
158
+ interface Timeline {
159
+ /** are sections/steps evaluated every day? Or can UoU participate in a self paced mode? */
160
+ selfPaced?: boolean;
161
+ /**
162
+ * everyone starts on this day
163
+ * @format LOCAL_DATE
164
+ */
165
+ startDate?: string | null;
166
+ /** duration of program in days (if applicable). */
167
+ durationInDays?: number | null;
168
+ }
169
+ interface Restrictions {
170
+ /**
171
+ * limit of active participants in the program.
172
+ * @min 1
173
+ */
174
+ maxParticipants?: number | null;
175
+ /** hide steps in the Pending state. */
176
+ hideFutureSteps?: boolean;
177
+ /** allow participants complete steps in the certain order. */
178
+ resolveStepsInOrder?: boolean;
179
+ /** allow program participants to share their progress in group */
180
+ shareProgress?: boolean;
181
+ /** access restrictions options regarding visibility. */
182
+ accessType?: RestrictionsAccessTypeWithLiterals;
183
+ }
184
+ declare enum RestrictionsAccessType {
185
+ /** unknown access type */
186
+ UNKNOWN_ACCESS_TYPE = "UNKNOWN_ACCESS_TYPE",
187
+ /** join without approvals */
188
+ PUBLIC = "PUBLIC",
189
+ /** send a join request to the owner and get an approval from him. */
190
+ PRIVATE = "PRIVATE",
191
+ /** join possible only after owner invite. */
192
+ SECRET = "SECRET"
193
+ }
194
+ /** @enumType */
195
+ type RestrictionsAccessTypeWithLiterals = RestrictionsAccessType | 'UNKNOWN_ACCESS_TYPE' | 'PUBLIC' | 'PRIVATE' | 'SECRET';
196
+ /**
197
+ * Money.
198
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
199
+ */
200
+ interface Money {
201
+ /**
202
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
203
+ * @decimalValue options { gt:0.00, maxScale:3 }
204
+ */
205
+ value?: string;
206
+ /**
207
+ * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
208
+ * @format CURRENCY
209
+ * @readonly
210
+ */
211
+ currency?: string;
212
+ }
213
+ interface Seo {
214
+ /**
215
+ * Temporary removed URL_SLUG validation for data migration
216
+ * string slug = 1 [(wix.api.format) = URL_SLUG]; //challenge slug expression
217
+ * @maxLength 300
218
+ */
219
+ slug?: string;
220
+ /** schema used by Seo team */
221
+ seoData?: SeoSchema;
222
+ /**
223
+ * program url
224
+ * @readonly
225
+ */
226
+ url?: string;
227
+ /**
228
+ * image url from description media
229
+ * @format WEB_URL
230
+ */
231
+ imageUrl?: string | null;
232
+ /**
233
+ * alt text of image
234
+ * @maxLength 1000
235
+ */
236
+ imageAlt?: string;
237
+ /**
238
+ * Approximate SEO program duration in Iso-8601
239
+ * @maxLength 100
240
+ * @readonly
241
+ */
242
+ courseWorkload?: string;
243
+ }
244
+ /**
245
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
246
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
247
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
248
+ */
249
+ interface SeoSchema {
250
+ /** SEO tag information. */
251
+ tags?: Tag[];
252
+ /** SEO general settings. */
253
+ settings?: Settings;
254
+ }
255
+ interface Keyword {
256
+ /** Keyword value. */
257
+ term?: string;
258
+ /** Whether the keyword is the main focus keyword. */
259
+ isMain?: boolean;
260
+ /**
261
+ * The source that added the keyword terms to the SEO settings.
262
+ * @maxLength 1000
263
+ */
264
+ origin?: string | null;
265
+ }
266
+ interface Tag {
267
+ /**
268
+ * SEO tag type.
269
+ *
270
+ *
271
+ * Supported values: `title`, `meta`, `script`, `link`.
272
+ */
273
+ type?: string;
274
+ /**
275
+ * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
276
+ * For example: `{"name": "description", "content": "the description itself"}`.
277
+ */
278
+ props?: Record<string, any> | null;
279
+ /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
280
+ meta?: Record<string, any> | null;
281
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
282
+ children?: string;
283
+ /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
284
+ custom?: boolean;
285
+ /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
286
+ disabled?: boolean;
287
+ }
288
+ interface Settings {
289
+ /**
290
+ * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
291
+ *
292
+ *
293
+ * Default: `false` (automatical redirect is enabled).
294
+ */
295
+ preventAutoRedirect?: boolean;
296
+ /**
297
+ * User-selected keyword terms for a specific page.
298
+ * @maxSize 5
299
+ */
300
+ keywords?: Keyword[];
301
+ }
302
+ interface Reward {
303
+ /** on which action rewards must be assigned. */
304
+ trigger?: TriggerWithLiterals;
305
+ /**
306
+ * badges participant will get on program complete
307
+ * @format GUID
308
+ * @maxSize 50
309
+ */
310
+ badgeIds?: string[];
311
+ /** certificate for program. Currently is program GUID */
312
+ certificate?: Certificate;
313
+ }
314
+ declare enum Trigger {
315
+ /** member joins the program */
316
+ JOINED_TO_PROGRAM = "JOINED_TO_PROGRAM",
317
+ /** at least one step completed */
318
+ STEP_COMPLETED = "STEP_COMPLETED",
319
+ /** all steps are completed. */
320
+ ALL_STEPS_COMPLETED = "ALL_STEPS_COMPLETED"
321
+ }
322
+ /** @enumType */
323
+ type TriggerWithLiterals = Trigger | 'JOINED_TO_PROGRAM' | 'STEP_COMPLETED' | 'ALL_STEPS_COMPLETED';
324
+ interface Certificate {
325
+ /**
326
+ * Certificate for program completion. Currently is program GUID
327
+ * @format GUID
328
+ */
329
+ _id?: string;
330
+ /** date it was connected to program */
331
+ connectedDate?: Date | null;
332
+ }
333
+ declare enum AccessType {
334
+ /** join without approvals */
335
+ PUBLIC = "PUBLIC",
336
+ /** send a join request to the owner and get an approval from him. */
337
+ PRIVATE = "PRIVATE",
338
+ /** join possible only after owner invite. */
339
+ SECRET = "SECRET"
340
+ }
341
+ /** @enumType */
342
+ type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET';
343
+ interface ExtendedFields {
344
+ /**
345
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
346
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
347
+ *
348
+ * You can only access fields for which you have the appropriate permissions.
349
+ *
350
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
351
+ */
352
+ namespaces?: Record<string, Record<string, any>>;
353
+ }
354
+ interface VideoStepsSettings {
355
+ /** automatically switch to next video step after finishing current one */
356
+ autoNavigate?: boolean;
357
+ /** how many percents of video need to be watched to complete step */
358
+ requiredCompletionPercentage?: number;
359
+ }
360
+ interface ContentSummary {
361
+ /**
362
+ * number of steps in program
363
+ * @max 3000
364
+ */
365
+ stepCount?: number;
366
+ /**
367
+ * number of sections in program
368
+ * @max 1000
369
+ */
370
+ sectionCount?: number;
371
+ }
372
+ interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
373
+ /** insert/update documents */
374
+ update?: DocumentUpdateOperation;
375
+ /** delete by document ids */
376
+ deleteByIds?: DeleteByIdsOperation;
377
+ /** delete documents matching filter */
378
+ deleteByFilter?: DeleteByFilterOperation;
379
+ /** update documents matching filter */
380
+ updateByFilter?: UpdateByFilterOperation;
381
+ /** update only existing documents */
382
+ updateExisting?: UpdateExistingOperation;
383
+ /**
384
+ * application which owns documents
385
+ * @minLength 2
386
+ */
387
+ appDefId?: string | null;
388
+ /**
389
+ * type of the documents
390
+ * @minLength 2
391
+ */
392
+ documentType?: string | null;
393
+ /**
394
+ * language of the documents
395
+ * @minLength 2
396
+ */
397
+ language?: string | null;
398
+ /**
399
+ * site documents belong to
400
+ * @minLength 2
401
+ */
402
+ msId?: string | null;
403
+ }
404
+ /** @oneof */
405
+ interface UpdateDocumentsEventOperationOneOf {
406
+ /** insert/update documents */
407
+ update?: DocumentUpdateOperation;
408
+ /** delete by document ids */
409
+ deleteByIds?: DeleteByIdsOperation;
410
+ /** delete documents matching filter */
411
+ deleteByFilter?: DeleteByFilterOperation;
412
+ /** update documents matching filter */
413
+ updateByFilter?: UpdateByFilterOperation;
414
+ /** update only existing documents */
415
+ updateExisting?: UpdateExistingOperation;
416
+ }
417
+ interface DocumentUpdateOperation {
418
+ /** documents to index or update */
419
+ documents?: IndexDocument[];
420
+ }
421
+ interface IndexDocument {
422
+ /** data bag with non-searchable fields (url, image) */
423
+ payload?: DocumentPayload;
424
+ /** what type of users should documents be visible to */
425
+ exposure?: EnumWithLiterals;
426
+ /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
427
+ document?: Record<string, any> | null;
428
+ /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
429
+ permittedMemberGroups?: string[];
430
+ /** if true SEO is disabled for this document */
431
+ seoHidden?: boolean | null;
432
+ /** if true the page is a lightbox popup */
433
+ isPopup?: boolean | null;
434
+ }
435
+ interface DocumentPayload {
436
+ /** url of the page representing the document */
437
+ url?: string | null;
438
+ /** image which represents the document */
439
+ documentImage?: DocumentImage;
440
+ }
441
+ interface DocumentImage {
442
+ /** the name of the image */
443
+ name?: string;
444
+ /** the width of the image */
445
+ width?: number;
446
+ /** the height of the image */
447
+ height?: number;
448
+ }
449
+ declare enum Enum {
450
+ /** Default value. Means that permission not set */
451
+ UNKNOWN = "UNKNOWN",
452
+ /** Protected exposure. Exposed to members and owners */
453
+ PROTECTED = "PROTECTED",
454
+ /** Private exposure. Exposed to owners */
455
+ PRIVATE = "PRIVATE",
456
+ /** Public exposure. Visible to everyone */
457
+ PUBLIC = "PUBLIC",
458
+ /** Used for partial updates, to state that exposure is not changing */
459
+ UNCHANGED = "UNCHANGED",
460
+ /** Protected to members of permitted groups and owners */
461
+ GROUP_PROTECTED = "GROUP_PROTECTED"
462
+ }
463
+ /** @enumType */
464
+ type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
465
+ interface DeleteByIdsOperation {
466
+ /** ids of the documents to delete */
467
+ documentIds?: string[];
468
+ }
469
+ interface DeleteByFilterOperation {
470
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
471
+ filter?: Record<string, any> | null;
472
+ }
473
+ interface UpdateByFilterOperation {
474
+ /** documents matching this filter will be updated */
475
+ filter?: Record<string, any> | null;
476
+ /** partial document to apply */
477
+ document?: IndexDocument;
478
+ }
479
+ interface UpdateExistingOperation {
480
+ /** documents to update */
481
+ documents?: IndexDocument[];
482
+ }
483
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
484
+ /**
485
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
486
+ * @format GUID
487
+ */
488
+ metaSiteId?: string;
489
+ /**
490
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
491
+ * @format GUID
492
+ */
493
+ siteId?: string;
494
+ /** Invalidate by App */
495
+ app?: App;
496
+ /** Invalidate by page id */
497
+ page?: Page;
498
+ /** Invalidate by URI path */
499
+ uri?: URI;
500
+ /** Invalidate by file (for media files such as PDFs) */
501
+ file?: File;
502
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
503
+ customTag?: CustomTag;
504
+ /**
505
+ * tell us why you're invalidating the cache. You don't need to add your app name
506
+ * @maxLength 256
507
+ */
508
+ reason?: string | null;
509
+ /** Is local DS */
510
+ localDc?: boolean;
511
+ hardPurge?: boolean;
512
+ }
513
+ /** @oneof */
514
+ interface InvalidateCacheGetByOneOf {
515
+ /**
516
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
517
+ * @format GUID
518
+ */
519
+ metaSiteId?: string;
520
+ /**
521
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
522
+ * @format GUID
523
+ */
524
+ siteId?: string;
525
+ /** Invalidate by App */
526
+ app?: App;
527
+ /** Invalidate by page id */
528
+ page?: Page;
529
+ /** Invalidate by URI path */
530
+ uri?: URI;
531
+ /** Invalidate by file (for media files such as PDFs) */
532
+ file?: File;
533
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
534
+ customTag?: CustomTag;
535
+ }
536
+ interface App {
537
+ /**
538
+ * The AppDefId
539
+ * @minLength 1
540
+ */
541
+ appDefId?: string;
542
+ /**
543
+ * The instance Id
544
+ * @format GUID
545
+ */
546
+ instanceId?: string;
547
+ }
548
+ interface Page {
549
+ /**
550
+ * the msid the page is on
551
+ * @format GUID
552
+ */
553
+ metaSiteId?: string;
554
+ /**
555
+ * Invalidate by Page ID
556
+ * @minLength 1
557
+ */
558
+ pageId?: string;
559
+ }
560
+ interface URI {
561
+ /**
562
+ * the msid the URI is on
563
+ * @format GUID
564
+ */
565
+ metaSiteId?: string;
566
+ /**
567
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
568
+ * @minLength 1
569
+ */
570
+ uriPath?: string;
571
+ }
572
+ interface File {
573
+ /**
574
+ * the msid the file is related to
575
+ * @format GUID
576
+ */
577
+ metaSiteId?: string;
578
+ /**
579
+ * Invalidate by filename (for media files such as PDFs)
580
+ * @minLength 1
581
+ * @maxLength 256
582
+ */
583
+ fileName?: string;
584
+ }
585
+ interface CustomTag {
586
+ /**
587
+ * the msid the tag is related to
588
+ * @format GUID
589
+ */
590
+ metaSiteId?: string;
591
+ /**
592
+ * Tag to invalidate by
593
+ * @minLength 1
594
+ * @maxLength 256
595
+ */
596
+ tag?: string;
597
+ }
598
+ /**
599
+ * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
600
+ * performs context manipulation with adding tenant, provided in message to callscope.
601
+ */
602
+ interface ReindexMessage extends ReindexMessageActionOneOf {
603
+ upsert?: Upsert;
604
+ delete?: Delete;
605
+ entityFqdn?: string;
606
+ tenantId?: string;
607
+ eventTime?: Date | null;
608
+ entityEventSequence?: string | null;
609
+ schema?: Schema;
610
+ }
611
+ /** @oneof */
612
+ interface ReindexMessageActionOneOf {
613
+ upsert?: Upsert;
614
+ delete?: Delete;
615
+ }
616
+ interface Upsert {
617
+ entityId?: string;
618
+ entityAsJson?: string;
619
+ }
620
+ interface Delete {
621
+ entityId?: string;
622
+ }
623
+ interface Schema {
624
+ label?: string;
625
+ clusterName?: string;
626
+ }
627
+ interface ProgramPublished {
628
+ }
629
+ interface ProgramEnded {
630
+ /** true if ended manually by owner */
631
+ endedByOwner?: boolean;
632
+ }
633
+ interface ProgramArchived {
634
+ }
635
+ interface ProgramDuplicated {
636
+ /** Newly created program */
637
+ program?: Program;
638
+ /** Program that was duplicated */
639
+ duplicatedFrom?: Program;
640
+ /** Indicates if the program was cloned from a template */
641
+ fromTemplate?: boolean;
642
+ }
643
+ interface CreateProgramRequest {
644
+ /** Program to be created. */
645
+ program: Program;
646
+ }
647
+ interface CreateProgramResponse {
648
+ /** The created Program. */
649
+ program?: Program;
650
+ }
651
+ interface BulkCreateProgramsMigrationRequest {
652
+ /**
653
+ * List of programs you want to create
654
+ * @minSize 1
655
+ * @maxSize 100
656
+ */
657
+ programs?: ProgramMigration[];
658
+ }
659
+ interface ProgramMigration {
660
+ /** program to create */
661
+ program?: Program;
662
+ /**
663
+ * section ids in program
664
+ * @maxSize 5000
665
+ * @format GUID
666
+ */
667
+ sectionIds?: string[];
668
+ /**
669
+ * step ids in program
670
+ * @maxSize 5000
671
+ * @format GUID
672
+ */
673
+ stepIds?: string[];
674
+ }
675
+ interface BulkCreateProgramsMigrationResponse {
676
+ /** Results of bulk action. */
677
+ results?: BulkProgramResult[];
678
+ /** Metadata about whole bulk action. */
679
+ bulkActionMetadata?: BulkActionMetadata;
680
+ }
681
+ interface BulkProgramResult {
682
+ /** Metadata of item. */
683
+ itemMetadata?: ItemMetadata;
684
+ /** Item itself (empty if return_entity in request is false). */
685
+ item?: Program;
686
+ /** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */
687
+ action?: BulkActionTypeWithLiterals;
688
+ }
689
+ interface ItemMetadata {
690
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
691
+ _id?: string | null;
692
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
693
+ originalIndex?: number;
694
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
695
+ success?: boolean;
696
+ /** Details about the error in case of failure. */
697
+ error?: ApplicationError;
698
+ }
699
+ interface ApplicationError {
700
+ /** Error code. */
701
+ code?: string;
702
+ /** Description of the error. */
703
+ description?: string;
704
+ /** Data related to the error. */
705
+ data?: Record<string, any> | null;
706
+ }
707
+ declare enum BulkActionType {
708
+ /** UNKNOWN_ACTION_TYPE */
709
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
710
+ /** INSERT */
711
+ INSERT = "INSERT",
712
+ /** UPDATE */
713
+ UPDATE = "UPDATE",
714
+ /** DELETE */
715
+ DELETE = "DELETE"
716
+ }
717
+ /** @enumType */
718
+ type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE' | 'DELETE';
719
+ interface BulkActionMetadata {
720
+ /** Number of items that were successfully processed. */
721
+ totalSuccesses?: number;
722
+ /** Number of items that couldn't be processed. */
723
+ totalFailures?: number;
724
+ /** Number of failures without details because detailed failure threshold was exceeded. */
725
+ undetailedFailures?: number;
726
+ }
727
+ interface DeleteAllProgramsMigrationRequest {
728
+ }
729
+ interface DeleteAllProgramsMigrationResponse {
730
+ }
731
+ interface DuplicateProgramRequest {
732
+ /**
733
+ * Program to be duplicated from.
734
+ * @format GUID
735
+ */
736
+ programId: string;
737
+ }
738
+ interface DuplicateProgramResponse {
739
+ /** The created Program. */
740
+ program?: Program;
741
+ }
742
+ interface GetProgramRequest {
743
+ /**
744
+ * ID of the Program to retrieve.
745
+ * @format GUID
746
+ */
747
+ programId: string;
748
+ }
749
+ interface GetProgramResponse {
750
+ /** The requested Program. */
751
+ program?: Program;
752
+ }
753
+ interface UpdateProgramRequest {
754
+ /** Program to be updated, may be partial. */
755
+ program: Program;
756
+ }
757
+ interface UpdateProgramResponse {
758
+ /** Updated Program. */
759
+ program?: Program;
760
+ }
761
+ interface WrongStateErrorDetails {
762
+ }
763
+ interface WrongStartDateErrorDetails {
764
+ }
765
+ interface WrongParticipantsNumberErrorDetails {
766
+ /** Participants that already joined the program */
767
+ activeParticipantsCount?: number;
768
+ }
769
+ interface DuplicatedSlugErrorDetails {
770
+ }
771
+ interface TimelineSwitchForbiddenErrorDetails {
772
+ }
773
+ interface DeleteProgramRequest {
774
+ /**
775
+ * Id of the Program to delete.
776
+ * @format GUID
777
+ */
778
+ programId: string;
779
+ }
780
+ interface DeleteProgramResponse {
781
+ }
782
+ interface QueryProgramsRequest {
783
+ /** Query to filter programs */
784
+ query?: QueryV2;
785
+ }
786
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
787
+ /** Paging options to limit and skip the number of items. */
788
+ paging?: Paging;
789
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
790
+ cursorPaging?: CursorPaging;
791
+ /**
792
+ * Filter object.
793
+ *
794
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
795
+ */
796
+ filter?: Record<string, any> | null;
797
+ /**
798
+ * Sort object.
799
+ *
800
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
801
+ * @maxSize 100
802
+ */
803
+ sort?: Sorting[];
804
+ /**
805
+ * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
806
+ * @maxSize 100
807
+ * @maxLength 1000
808
+ */
809
+ fields?: string[];
810
+ /**
811
+ * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
812
+ * @maxSize 100
813
+ * @maxLength 1000
814
+ */
815
+ fieldsets?: string[];
816
+ }
817
+ /** @oneof */
818
+ interface QueryV2PagingMethodOneOf {
819
+ /** Paging options to limit and skip the number of items. */
820
+ paging?: Paging;
821
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
822
+ cursorPaging?: CursorPaging;
823
+ }
824
+ interface Sorting {
825
+ /**
826
+ * Name of the field to sort by.
827
+ * @maxLength 512
828
+ */
829
+ fieldName?: string;
830
+ /** Sort order. */
831
+ order?: SortOrderWithLiterals;
832
+ }
833
+ declare enum SortOrder {
834
+ ASC = "ASC",
835
+ DESC = "DESC"
836
+ }
837
+ /** @enumType */
838
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
839
+ interface Paging {
840
+ /** Number of items to load. */
841
+ limit?: number | null;
842
+ offset?: number | null;
843
+ }
844
+ interface CursorPaging {
845
+ /**
846
+ * Maximum number of items to return in the results.
847
+ * @max 100
848
+ */
849
+ limit?: number | null;
850
+ /**
851
+ * Pointer to the next or previous page in the list of results.
852
+ *
853
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
854
+ * Not relevant for the first request.
855
+ * @maxLength 16000
856
+ */
857
+ cursor?: string | null;
858
+ }
859
+ interface QueryProgramsResponse {
860
+ /** Found programs */
861
+ programs?: Program[];
862
+ /** paging */
863
+ pagingMetadata?: PagingMetadataV2;
864
+ }
865
+ interface PagingMetadataV2 {
866
+ /** Number of items returned in the response. */
867
+ count?: number | null;
868
+ /** Offset that was requested. */
869
+ offset?: number | null;
870
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
871
+ total?: number | null;
872
+ /** Flag that indicates the server failed to calculate the `total` field. */
873
+ tooManyToCount?: boolean | null;
874
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
875
+ cursors?: Cursors;
876
+ }
877
+ interface Cursors {
878
+ /**
879
+ * Cursor string pointing to the next page in the list of results.
880
+ * @maxLength 16000
881
+ */
882
+ next?: string | null;
883
+ /**
884
+ * Cursor pointing to the previous page in the list of results.
885
+ * @maxLength 16000
886
+ */
887
+ prev?: string | null;
888
+ }
889
+ interface SearchProgramsRequest {
890
+ /** Query to search programs */
891
+ search?: CursorSearch;
892
+ }
893
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
894
+ /**
895
+ * Cursor paging options.
896
+ *
897
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
898
+ */
899
+ cursorPaging?: CursorPaging;
900
+ /**
901
+ * Filter object.
902
+ *
903
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
904
+ */
905
+ filter?: Record<string, any> | null;
906
+ /**
907
+ * List of sort objects.
908
+ *
909
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
910
+ * @maxSize 10
911
+ */
912
+ sort?: Sorting[];
913
+ /**
914
+ * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
915
+ * @maxSize 10
916
+ */
917
+ aggregations?: Aggregation[];
918
+ /** Free text to match in searchable fields. */
919
+ search?: SearchDetails;
920
+ /**
921
+ * UTC offset or IANA time zone. Valid values are
922
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
923
+ * and IANA time zone IDs, such as Europe/Rome.
924
+ *
925
+ * Affects all filters and aggregations returned values.
926
+ * You may override this behavior in a specific filter by providing
927
+ * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
928
+ * @maxLength 50
929
+ */
930
+ timeZone?: string | null;
931
+ }
932
+ /** @oneof */
933
+ interface CursorSearchPagingMethodOneOf {
934
+ /**
935
+ * Cursor paging options.
936
+ *
937
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
938
+ */
939
+ cursorPaging?: CursorPaging;
940
+ }
941
+ interface Aggregation extends AggregationKindOneOf {
942
+ /** Value aggregation. */
943
+ value?: ValueAggregation;
944
+ /** Range aggregation. */
945
+ range?: RangeAggregation;
946
+ /** Scalar aggregation. */
947
+ scalar?: ScalarAggregation;
948
+ /** Date histogram aggregation. */
949
+ dateHistogram?: DateHistogramAggregation;
950
+ /** Nested aggregation. */
951
+ nested?: NestedAggregation;
952
+ /**
953
+ * User-defined name of aggregation, should be unique, will appear in aggregation results.
954
+ * @maxLength 100
955
+ */
956
+ name?: string | null;
957
+ /** Type of aggregation, client must provide matching aggregation field below. */
958
+ type?: AggregationTypeWithLiterals;
959
+ /**
960
+ * Field to aggregate by, use dot notation to specify json path.
961
+ * @maxLength 200
962
+ */
963
+ fieldPath?: string;
964
+ /**
965
+ * Deprecated. Use `nested` instead.
966
+ * @deprecated Deprecated. Use `nested` instead.
967
+ * @replacedBy kind.nested
968
+ * @targetRemovalDate 2024-03-30
969
+ */
970
+ groupBy?: GroupByAggregation;
971
+ }
972
+ /** @oneof */
973
+ interface AggregationKindOneOf {
974
+ /** Value aggregation. */
975
+ value?: ValueAggregation;
976
+ /** Range aggregation. */
977
+ range?: RangeAggregation;
978
+ /** Scalar aggregation. */
979
+ scalar?: ScalarAggregation;
980
+ /** Date histogram aggregation. */
981
+ dateHistogram?: DateHistogramAggregation;
982
+ /** Nested aggregation. */
983
+ nested?: NestedAggregation;
984
+ }
985
+ interface RangeBucket {
986
+ /** Inclusive lower bound of the range. Required if `to` is not provided. */
987
+ from?: number | null;
988
+ /** Exclusive upper bound of the range. Required if `from` is not provided. */
989
+ to?: number | null;
990
+ }
991
+ declare enum SortType {
992
+ /** Sort by number of matches. */
993
+ COUNT = "COUNT",
994
+ /** Sort by value of the field alphabetically. */
995
+ VALUE = "VALUE"
996
+ }
997
+ /** @enumType */
998
+ type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
999
+ declare enum SortDirection {
1000
+ /** Sort in descending order. */
1001
+ DESC = "DESC",
1002
+ /** Sort in ascending order. */
1003
+ ASC = "ASC"
1004
+ }
1005
+ /** @enumType */
1006
+ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
1007
+ declare enum MissingValues {
1008
+ /** Exclude missing values from the aggregation results. */
1009
+ EXCLUDE = "EXCLUDE",
1010
+ /** Include missing values in the aggregation results. */
1011
+ INCLUDE = "INCLUDE"
1012
+ }
1013
+ /** @enumType */
1014
+ type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
1015
+ interface IncludeMissingValuesOptions {
1016
+ /**
1017
+ * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
1018
+ * @maxLength 20
1019
+ */
1020
+ addToBucket?: string;
1021
+ }
1022
+ declare enum ScalarType {
1023
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1024
+ /** Count of distinct values. */
1025
+ COUNT_DISTINCT = "COUNT_DISTINCT",
1026
+ /** Minimum value. */
1027
+ MIN = "MIN",
1028
+ /** Maximum value. */
1029
+ MAX = "MAX"
1030
+ }
1031
+ /** @enumType */
1032
+ type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1033
+ interface ValueAggregation extends ValueAggregationOptionsOneOf {
1034
+ /** Options for including missing values. */
1035
+ includeOptions?: IncludeMissingValuesOptions;
1036
+ /** Whether to sort by number of matches or value of the field. */
1037
+ sortType?: SortTypeWithLiterals;
1038
+ /** Whether to sort in ascending or descending order. */
1039
+ sortDirection?: SortDirectionWithLiterals;
1040
+ /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
1041
+ limit?: number | null;
1042
+ /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
1043
+ missingValues?: MissingValuesWithLiterals;
1044
+ }
1045
+ /** @oneof */
1046
+ interface ValueAggregationOptionsOneOf {
1047
+ /** Options for including missing values. */
1048
+ includeOptions?: IncludeMissingValuesOptions;
1049
+ }
1050
+ declare enum NestedAggregationType {
1051
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1052
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
1053
+ VALUE = "VALUE",
1054
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
1055
+ RANGE = "RANGE",
1056
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
1057
+ SCALAR = "SCALAR",
1058
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
1059
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
1060
+ }
1061
+ /** @enumType */
1062
+ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1063
+ interface RangeAggregation {
1064
+ /**
1065
+ * 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.
1066
+ * @maxSize 50
1067
+ */
1068
+ buckets?: RangeBucket[];
1069
+ }
1070
+ interface ScalarAggregation {
1071
+ /** Define the operator for the scalar aggregation. */
1072
+ type?: ScalarTypeWithLiterals;
1073
+ }
1074
+ interface DateHistogramAggregation {
1075
+ /** Interval for date histogram aggregation. */
1076
+ interval?: IntervalWithLiterals;
1077
+ }
1078
+ declare enum Interval {
1079
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1080
+ /** Yearly interval */
1081
+ YEAR = "YEAR",
1082
+ /** Monthly interval */
1083
+ MONTH = "MONTH",
1084
+ /** Weekly interval */
1085
+ WEEK = "WEEK",
1086
+ /** Daily interval */
1087
+ DAY = "DAY",
1088
+ /** Hourly interval */
1089
+ HOUR = "HOUR",
1090
+ /** Minute interval */
1091
+ MINUTE = "MINUTE",
1092
+ /** Second interval */
1093
+ SECOND = "SECOND"
1094
+ }
1095
+ /** @enumType */
1096
+ type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1097
+ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1098
+ /** Value aggregation. */
1099
+ value?: ValueAggregation;
1100
+ /** Range aggregation. */
1101
+ range?: RangeAggregation;
1102
+ /** Scalar aggregation. */
1103
+ scalar?: ScalarAggregation;
1104
+ /** Date histogram aggregation. */
1105
+ dateHistogram?: DateHistogramAggregation;
1106
+ /**
1107
+ * User-defined name of aggregation, should be unique, will appear in aggregation results.
1108
+ * @maxLength 100
1109
+ */
1110
+ name?: string | null;
1111
+ /** Type of aggregation, client must provide matching aggregation field below. */
1112
+ type?: NestedAggregationTypeWithLiterals;
1113
+ /**
1114
+ * Field to aggregate by, use dot notation to specify json path.
1115
+ * @maxLength 200
1116
+ */
1117
+ fieldPath?: string;
1118
+ }
1119
+ /** @oneof */
1120
+ interface NestedAggregationItemKindOneOf {
1121
+ /** Value aggregation. */
1122
+ value?: ValueAggregation;
1123
+ /** Range aggregation. */
1124
+ range?: RangeAggregation;
1125
+ /** Scalar aggregation. */
1126
+ scalar?: ScalarAggregation;
1127
+ /** Date histogram aggregation. */
1128
+ dateHistogram?: DateHistogramAggregation;
1129
+ }
1130
+ declare enum AggregationType {
1131
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1132
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
1133
+ VALUE = "VALUE",
1134
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
1135
+ RANGE = "RANGE",
1136
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
1137
+ SCALAR = "SCALAR",
1138
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1139
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
1140
+ /** Multi-level aggregation, where each next aggregation is nested within previous one. */
1141
+ NESTED = "NESTED"
1142
+ }
1143
+ /** @enumType */
1144
+ type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1145
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
1146
+ interface NestedAggregation {
1147
+ /**
1148
+ * Flattened list of aggregations, where each next aggregation is nested within previous one.
1149
+ * @minSize 2
1150
+ * @maxSize 3
1151
+ */
1152
+ nestedAggregations?: NestedAggregationItem[];
1153
+ }
1154
+ interface GroupByAggregation extends GroupByAggregationKindOneOf {
1155
+ /** Value aggregation configuration. */
1156
+ value?: ValueAggregation;
1157
+ /**
1158
+ * User-defined name of aggregation, should be unique, will appear in aggregation results.
1159
+ * @maxLength 100
1160
+ */
1161
+ name?: string | null;
1162
+ /**
1163
+ * Field to aggregate by.
1164
+ * @maxLength 200
1165
+ */
1166
+ fieldPath?: string;
1167
+ }
1168
+ /** @oneof */
1169
+ interface GroupByAggregationKindOneOf {
1170
+ /** Value aggregation configuration. */
1171
+ value?: ValueAggregation;
1172
+ }
1173
+ interface SearchDetails {
1174
+ /** Defines how separate search terms in `expression` are combined. */
1175
+ mode?: ModeWithLiterals;
1176
+ /**
1177
+ * Search term or expression.
1178
+ * @maxLength 100
1179
+ */
1180
+ expression?: string | null;
1181
+ /**
1182
+ * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
1183
+ * @maxLength 200
1184
+ * @maxSize 20
1185
+ */
1186
+ fields?: string[];
1187
+ /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
1188
+ fuzzy?: boolean;
1189
+ }
1190
+ declare enum Mode {
1191
+ /** Any of the search terms must be present. */
1192
+ OR = "OR",
1193
+ /** All search terms must be present. */
1194
+ AND = "AND"
1195
+ }
1196
+ /** @enumType */
1197
+ type ModeWithLiterals = Mode | 'OR' | 'AND';
1198
+ interface SearchProgramsResponse {
1199
+ /** Found programs */
1200
+ programs?: Program[];
1201
+ /** paging */
1202
+ pagingMetadata?: CursorPagingMetadata;
1203
+ /** aggregation */
1204
+ aggregationData?: AggregationData;
1205
+ }
1206
+ interface CursorPagingMetadata {
1207
+ /** Number of items returned in current page. */
1208
+ count?: number | null;
1209
+ /** Cursor strings that point to the next page, previous page, or both. */
1210
+ cursors?: Cursors;
1211
+ /**
1212
+ * Whether there are more pages to retrieve following the current page.
1213
+ *
1214
+ * + `true`: Another page of results can be retrieved.
1215
+ * + `false`: This is the last page.
1216
+ */
1217
+ hasNext?: boolean | null;
1218
+ }
1219
+ interface AggregationData {
1220
+ /**
1221
+ * key = aggregation name (as derived from search request).
1222
+ * @maxSize 10000
1223
+ */
1224
+ results?: AggregationResults[];
1225
+ }
1226
+ interface ValueAggregationResult {
1227
+ /**
1228
+ * Value of the field.
1229
+ * @maxLength 100
1230
+ */
1231
+ value?: string;
1232
+ /** Count of entities with this value. */
1233
+ count?: number;
1234
+ }
1235
+ interface RangeAggregationResult {
1236
+ /** Inclusive lower bound of the range. */
1237
+ from?: number | null;
1238
+ /** Exclusive upper bound of the range. */
1239
+ to?: number | null;
1240
+ /** Count of entities in this range. */
1241
+ count?: number;
1242
+ }
1243
+ interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
1244
+ /** Value aggregation results. */
1245
+ values?: ValueResults;
1246
+ /** Range aggregation results. */
1247
+ ranges?: RangeResults;
1248
+ /** Scalar aggregation results. */
1249
+ scalar?: AggregationResultsScalarResult;
1250
+ /**
1251
+ * User-defined name of aggregation, matches the one provided in request.
1252
+ * @maxLength 100
1253
+ */
1254
+ name?: string;
1255
+ /** Type of aggregation that matches result. */
1256
+ type?: AggregationTypeWithLiterals;
1257
+ /**
1258
+ * Field to aggregate by, matches the one provided in request.
1259
+ * @maxLength 200
1260
+ */
1261
+ fieldPath?: string;
1262
+ }
1263
+ /** @oneof */
1264
+ interface NestedAggregationResultsResultOneOf {
1265
+ /** Value aggregation results. */
1266
+ values?: ValueResults;
1267
+ /** Range aggregation results. */
1268
+ ranges?: RangeResults;
1269
+ /** Scalar aggregation results. */
1270
+ scalar?: AggregationResultsScalarResult;
1271
+ }
1272
+ interface ValueResults {
1273
+ /**
1274
+ * List of value aggregations.
1275
+ * @maxSize 250
1276
+ */
1277
+ results?: ValueAggregationResult[];
1278
+ }
1279
+ interface RangeResults {
1280
+ /**
1281
+ * List of ranges returned in same order as requested.
1282
+ * @maxSize 50
1283
+ */
1284
+ results?: RangeAggregationResult[];
1285
+ }
1286
+ interface AggregationResultsScalarResult {
1287
+ /** Type of scalar aggregation. */
1288
+ type?: ScalarTypeWithLiterals;
1289
+ /** Value of the scalar aggregation. */
1290
+ value?: number;
1291
+ }
1292
+ interface NestedValueAggregationResult {
1293
+ /**
1294
+ * Value of the field.
1295
+ * @maxLength 1000
1296
+ */
1297
+ value?: string;
1298
+ /** Nested aggregations. */
1299
+ nestedResults?: NestedAggregationResults;
1300
+ }
1301
+ interface ValueResult {
1302
+ /**
1303
+ * Value of the field.
1304
+ * @maxLength 1000
1305
+ */
1306
+ value?: string;
1307
+ /** Count of entities with this value. */
1308
+ count?: number | null;
1309
+ }
1310
+ interface RangeResult {
1311
+ /** Inclusive lower bound of the range. */
1312
+ from?: number | null;
1313
+ /** Exclusive upper bound of the range. */
1314
+ to?: number | null;
1315
+ /** Count of entities in this range. */
1316
+ count?: number | null;
1317
+ }
1318
+ interface ScalarResult {
1319
+ /** Value of the scalar aggregation. */
1320
+ value?: number;
1321
+ }
1322
+ interface NestedResultValue extends NestedResultValueResultOneOf {
1323
+ /** Value aggregation result. */
1324
+ value?: ValueResult;
1325
+ /** Range aggregation result. */
1326
+ range?: RangeResult;
1327
+ /** Scalar aggregation result. */
1328
+ scalar?: ScalarResult;
1329
+ /** Date histogram aggregation result. */
1330
+ dateHistogram?: ValueResult;
1331
+ }
1332
+ /** @oneof */
1333
+ interface NestedResultValueResultOneOf {
1334
+ /** Value aggregation result. */
1335
+ value?: ValueResult;
1336
+ /** Range aggregation result. */
1337
+ range?: RangeResult;
1338
+ /** Scalar aggregation result. */
1339
+ scalar?: ScalarResult;
1340
+ /** Date histogram aggregation result. */
1341
+ dateHistogram?: ValueResult;
1342
+ }
1343
+ interface Results {
1344
+ /** List of nested aggregations. */
1345
+ results?: Record<string, NestedResultValue>;
1346
+ }
1347
+ interface DateHistogramResult {
1348
+ /**
1349
+ * Date in ISO 8601 format.
1350
+ * @maxLength 100
1351
+ */
1352
+ value?: string;
1353
+ /** Count of documents in the bucket. */
1354
+ count?: number;
1355
+ }
1356
+ interface GroupByValueResults {
1357
+ /**
1358
+ * List of value aggregations.
1359
+ * @maxSize 1000
1360
+ */
1361
+ results?: NestedValueAggregationResult[];
1362
+ }
1363
+ interface DateHistogramResults {
1364
+ /**
1365
+ * List of date histogram aggregations.
1366
+ * @maxSize 200
1367
+ */
1368
+ results?: DateHistogramResult[];
1369
+ }
1370
+ /**
1371
+ * Results of `NESTED` aggregation type in a flattened form.
1372
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
1373
+ */
1374
+ interface NestedResults {
1375
+ /**
1376
+ * List of nested aggregations.
1377
+ * @maxSize 1000
1378
+ */
1379
+ results?: Results[];
1380
+ }
1381
+ interface AggregationResults extends AggregationResultsResultOneOf {
1382
+ /** Value aggregation results. */
1383
+ values?: ValueResults;
1384
+ /** Range aggregation results. */
1385
+ ranges?: RangeResults;
1386
+ /** Scalar aggregation results. */
1387
+ scalar?: AggregationResultsScalarResult;
1388
+ /** Group by value aggregation results. */
1389
+ groupedByValue?: GroupByValueResults;
1390
+ /** Date histogram aggregation results. */
1391
+ dateHistogram?: DateHistogramResults;
1392
+ /** Nested aggregation results. */
1393
+ nested?: NestedResults;
1394
+ /**
1395
+ * User-defined name of aggregation as derived from search request.
1396
+ * @maxLength 100
1397
+ */
1398
+ name?: string;
1399
+ /** Type of aggregation that must match provided kind as derived from search request. */
1400
+ type?: AggregationTypeWithLiterals;
1401
+ /**
1402
+ * Field to aggregate by as derived from search request.
1403
+ * @maxLength 200
1404
+ */
1405
+ fieldPath?: string;
1406
+ }
1407
+ /** @oneof */
1408
+ interface AggregationResultsResultOneOf {
1409
+ /** Value aggregation results. */
1410
+ values?: ValueResults;
1411
+ /** Range aggregation results. */
1412
+ ranges?: RangeResults;
1413
+ /** Scalar aggregation results. */
1414
+ scalar?: AggregationResultsScalarResult;
1415
+ /** Group by value aggregation results. */
1416
+ groupedByValue?: GroupByValueResults;
1417
+ /** Date histogram aggregation results. */
1418
+ dateHistogram?: DateHistogramResults;
1419
+ /** Nested aggregation results. */
1420
+ nested?: NestedResults;
1421
+ }
1422
+ interface PublishProgramRequest {
1423
+ /**
1424
+ * Program to publish
1425
+ * @format GUID
1426
+ */
1427
+ programId: string;
1428
+ }
1429
+ interface PublishProgramResponse {
1430
+ /** Published program */
1431
+ program?: Program;
1432
+ }
1433
+ interface EndProgramRequest {
1434
+ /**
1435
+ * Program to finish
1436
+ * @format GUID
1437
+ */
1438
+ programId: string;
1439
+ }
1440
+ interface EndProgramResponse {
1441
+ /** Finished program */
1442
+ program?: Program;
1443
+ }
1444
+ interface ArchiveProgramRequest {
1445
+ /**
1446
+ * Program to archive
1447
+ * @format GUID
1448
+ */
1449
+ programId: string;
1450
+ }
1451
+ interface ArchiveProgramResponse {
1452
+ /** Archived program */
1453
+ program?: Program;
1454
+ }
1455
+ interface BulkUpdateProgramsRequest {
1456
+ /**
1457
+ * List of programs you want to update
1458
+ * @minSize 1
1459
+ * @maxSize 100
1460
+ */
1461
+ programs: MaskedProgram[];
1462
+ /** set to `true` if you wish to receive back the created programs in the response */
1463
+ returnEntity?: boolean;
1464
+ }
1465
+ interface MaskedProgram {
1466
+ /** Program to be updated, may be partial */
1467
+ program?: Program;
1468
+ /** Explicit list of fields to update. */
1469
+ fieldMask?: string[];
1470
+ }
1471
+ interface BulkUpdateProgramsResponse {
1472
+ /**
1473
+ * @minSize 1
1474
+ * @maxSize 100
1475
+ */
1476
+ results?: BulkUpdateProgramResult[];
1477
+ /** metadata */
1478
+ bulkActionMetadata?: BulkActionMetadata;
1479
+ }
1480
+ interface BulkUpdateProgramResult {
1481
+ /** item metadata */
1482
+ itemMetadata?: ItemMetadata;
1483
+ /** Only exists if `returnEntity` was set to true in the request */
1484
+ item?: Program;
1485
+ }
1486
+ interface CountProgramsRequest {
1487
+ /** filter for which count is requested */
1488
+ filter?: Record<string, any> | null;
1489
+ }
1490
+ interface CountProgramsResponse {
1491
+ /** count of programs matching filter */
1492
+ count?: number;
1493
+ }
1494
+ interface ListSampleProgramsRequest {
1495
+ }
1496
+ interface ListSampleProgramsResponse {
1497
+ /**
1498
+ * sample programs
1499
+ * @maxSize 100
1500
+ */
1501
+ programs?: LabeledProgram[];
1502
+ }
1503
+ interface LabeledProgram {
1504
+ /** sample program */
1505
+ program?: Program;
1506
+ /**
1507
+ * label, showing category for program
1508
+ * @maxLength 1000
1509
+ */
1510
+ label?: string;
1511
+ }
1512
+ interface DomainEvent extends DomainEventBodyOneOf {
1513
+ createdEvent?: EntityCreatedEvent;
1514
+ updatedEvent?: EntityUpdatedEvent;
1515
+ deletedEvent?: EntityDeletedEvent;
1516
+ actionEvent?: ActionEvent;
1517
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1518
+ _id?: string;
1519
+ /**
1520
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1521
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1522
+ */
1523
+ entityFqdn?: string;
1524
+ /**
1525
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1526
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1527
+ */
1528
+ slug?: string;
1529
+ /** ID of the entity associated with the event. */
1530
+ entityId?: string;
1531
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1532
+ eventTime?: Date | null;
1533
+ /**
1534
+ * Whether the event was triggered as a result of a privacy regulation application
1535
+ * (for example, GDPR).
1536
+ */
1537
+ triggeredByAnonymizeRequest?: boolean | null;
1538
+ /** If present, indicates the action that triggered the event. */
1539
+ originatedFrom?: string | null;
1540
+ /**
1541
+ * 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.
1542
+ * 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.
1543
+ */
1544
+ entityEventSequence?: string | null;
1545
+ }
1546
+ /** @oneof */
1547
+ interface DomainEventBodyOneOf {
1548
+ createdEvent?: EntityCreatedEvent;
1549
+ updatedEvent?: EntityUpdatedEvent;
1550
+ deletedEvent?: EntityDeletedEvent;
1551
+ actionEvent?: ActionEvent;
1552
+ }
1553
+ interface EntityCreatedEvent {
1554
+ entity?: string;
1555
+ }
1556
+ interface RestoreInfo {
1557
+ deletedDate?: Date | null;
1558
+ }
1559
+ interface EntityUpdatedEvent {
1560
+ /**
1561
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1562
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1563
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1564
+ */
1565
+ currentEntity?: string;
1566
+ }
1567
+ interface EntityDeletedEvent {
1568
+ /** Entity that was deleted. */
1569
+ deletedEntity?: string | null;
1570
+ }
1571
+ interface ActionEvent {
1572
+ body?: string;
1573
+ }
1574
+ interface Empty {
1575
+ }
1576
+ interface ResolveProgramSlugRequest {
1577
+ /**
1578
+ * seo slug of online program.
1579
+ * @maxLength 1000
1580
+ */
1581
+ slug?: string;
1582
+ }
1583
+ interface ResolveProgramSlugResponse {
1584
+ /** @format GUID */
1585
+ programId?: string;
1586
+ }
1587
+ interface MissingMetasiteIdErrorDetails {
1588
+ }
1589
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1590
+ /** Emitted on a meta site creation. */
1591
+ siteCreated?: SiteCreated;
1592
+ /** Emitted on a meta site transfer completion. */
1593
+ siteTransferred?: SiteTransferred;
1594
+ /** Emitted on a meta site deletion. */
1595
+ siteDeleted?: SiteDeleted;
1596
+ /** Emitted on a meta site restoration. */
1597
+ siteUndeleted?: SiteUndeleted;
1598
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1599
+ sitePublished?: SitePublished;
1600
+ /** Emitted on a meta site unpublish. */
1601
+ siteUnpublished?: SiteUnpublished;
1602
+ /** Emitted when meta site is marked as template. */
1603
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1604
+ /** Emitted when meta site is marked as a WixSite. */
1605
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1606
+ /** Emitted when an application is provisioned (installed). */
1607
+ serviceProvisioned?: ServiceProvisioned;
1608
+ /** Emitted when an application is removed (uninstalled). */
1609
+ serviceRemoved?: ServiceRemoved;
1610
+ /** Emitted when meta site name (URL slug) is changed. */
1611
+ siteRenamedPayload?: SiteRenamed;
1612
+ /** Emitted when meta site was permanently deleted. */
1613
+ hardDeleted?: SiteHardDeleted;
1614
+ /** Emitted on a namespace change. */
1615
+ namespaceChanged?: NamespaceChanged;
1616
+ /** Emitted when Studio is attached. */
1617
+ studioAssigned?: StudioAssigned;
1618
+ /** Emitted when Studio is detached. */
1619
+ studioUnassigned?: StudioUnassigned;
1620
+ /**
1621
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1622
+ * the actual URL.
1623
+ *
1624
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1625
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1626
+ */
1627
+ urlChanged?: SiteUrlChanged;
1628
+ /** Site is marked as PurgedExternally */
1629
+ sitePurgedExternally?: SitePurgedExternally;
1630
+ /** Emitted when Odeditor is attached. */
1631
+ odeditorAssigned?: OdeditorAssigned;
1632
+ /** Emitted when Odeditor is detached. */
1633
+ odeditorUnassigned?: OdeditorUnassigned;
1634
+ /** Emitted when Picasso is attached. */
1635
+ picassoAssigned?: PicassoAssigned;
1636
+ /** Emitted when Picasso is detached. */
1637
+ picassoUnassigned?: PicassoUnassigned;
1638
+ /**
1639
+ * A meta site id.
1640
+ * @format GUID
1641
+ */
1642
+ metaSiteId?: string;
1643
+ /** A meta site version. Monotonically increasing. */
1644
+ version?: string;
1645
+ /** A timestamp of the event. */
1646
+ timestamp?: string;
1647
+ /**
1648
+ * TODO(meta-site): Change validation once validations are disabled for consumers
1649
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
1650
+ * @maxSize 4000
1651
+ */
1652
+ assets?: Asset[];
1653
+ }
1654
+ /** @oneof */
1655
+ interface MetaSiteSpecialEventPayloadOneOf {
1656
+ /** Emitted on a meta site creation. */
1657
+ siteCreated?: SiteCreated;
1658
+ /** Emitted on a meta site transfer completion. */
1659
+ siteTransferred?: SiteTransferred;
1660
+ /** Emitted on a meta site deletion. */
1661
+ siteDeleted?: SiteDeleted;
1662
+ /** Emitted on a meta site restoration. */
1663
+ siteUndeleted?: SiteUndeleted;
1664
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1665
+ sitePublished?: SitePublished;
1666
+ /** Emitted on a meta site unpublish. */
1667
+ siteUnpublished?: SiteUnpublished;
1668
+ /** Emitted when meta site is marked as template. */
1669
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1670
+ /** Emitted when meta site is marked as a WixSite. */
1671
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1672
+ /** Emitted when an application is provisioned (installed). */
1673
+ serviceProvisioned?: ServiceProvisioned;
1674
+ /** Emitted when an application is removed (uninstalled). */
1675
+ serviceRemoved?: ServiceRemoved;
1676
+ /** Emitted when meta site name (URL slug) is changed. */
1677
+ siteRenamedPayload?: SiteRenamed;
1678
+ /** Emitted when meta site was permanently deleted. */
1679
+ hardDeleted?: SiteHardDeleted;
1680
+ /** Emitted on a namespace change. */
1681
+ namespaceChanged?: NamespaceChanged;
1682
+ /** Emitted when Studio is attached. */
1683
+ studioAssigned?: StudioAssigned;
1684
+ /** Emitted when Studio is detached. */
1685
+ studioUnassigned?: StudioUnassigned;
1686
+ /**
1687
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1688
+ * the actual URL.
1689
+ *
1690
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1691
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1692
+ */
1693
+ urlChanged?: SiteUrlChanged;
1694
+ /** Site is marked as PurgedExternally */
1695
+ sitePurgedExternally?: SitePurgedExternally;
1696
+ /** Emitted when Odeditor is attached. */
1697
+ odeditorAssigned?: OdeditorAssigned;
1698
+ /** Emitted when Odeditor is detached. */
1699
+ odeditorUnassigned?: OdeditorUnassigned;
1700
+ /** Emitted when Picasso is attached. */
1701
+ picassoAssigned?: PicassoAssigned;
1702
+ /** Emitted when Picasso is detached. */
1703
+ picassoUnassigned?: PicassoUnassigned;
1704
+ }
1705
+ interface Asset {
1706
+ /**
1707
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1708
+ * @maxLength 36
1709
+ */
1710
+ appDefId?: string;
1711
+ /**
1712
+ * An instance id. For legacy reasons may be UUID or a string.
1713
+ * @maxLength 200
1714
+ */
1715
+ instanceId?: string;
1716
+ /** An application state. */
1717
+ state?: StateWithLiterals;
1718
+ }
1719
+ declare enum State {
1720
+ UNKNOWN = "UNKNOWN",
1721
+ ENABLED = "ENABLED",
1722
+ DISABLED = "DISABLED",
1723
+ PENDING = "PENDING",
1724
+ DEMO = "DEMO"
1725
+ }
1726
+ /** @enumType */
1727
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
1728
+ interface SiteCreated {
1729
+ /**
1730
+ * A template identifier (empty if not created from a template).
1731
+ * @maxLength 36
1732
+ */
1733
+ originTemplateId?: string;
1734
+ /**
1735
+ * An account id of the owner.
1736
+ * @format GUID
1737
+ */
1738
+ ownerId?: string;
1739
+ /** A context in which meta site was created. */
1740
+ context?: SiteCreatedContextWithLiterals;
1741
+ /**
1742
+ * A meta site id from which this site was created.
1743
+ *
1744
+ * In case of a creation from a template it's a template id.
1745
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1746
+ * @format GUID
1747
+ */
1748
+ originMetaSiteId?: string | null;
1749
+ /**
1750
+ * A meta site name (URL slug).
1751
+ * @maxLength 20
1752
+ */
1753
+ siteName?: string;
1754
+ /** A namespace. */
1755
+ namespace?: NamespaceWithLiterals;
1756
+ }
1757
+ declare enum SiteCreatedContext {
1758
+ /** A valid option, we don't expose all reasons why site might be created. */
1759
+ OTHER = "OTHER",
1760
+ /** A meta site was created from template. */
1761
+ FROM_TEMPLATE = "FROM_TEMPLATE",
1762
+ /** A meta site was created by copying of the transfferred meta site. */
1763
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1764
+ /** A copy of existing meta site. */
1765
+ DUPLICATE = "DUPLICATE",
1766
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1767
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1768
+ /** deprecated A meta site was created for Flash editor. */
1769
+ FLASH = "FLASH"
1770
+ }
1771
+ /** @enumType */
1772
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
1773
+ declare enum Namespace {
1774
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1775
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1776
+ WIX = "WIX",
1777
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1778
+ SHOUT_OUT = "SHOUT_OUT",
1779
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1780
+ ALBUMS = "ALBUMS",
1781
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1782
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1783
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1784
+ HOTELS = "HOTELS",
1785
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1786
+ CLUBS = "CLUBS",
1787
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1788
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1789
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1790
+ DEV_SITE = "DEV_SITE",
1791
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1792
+ LOGOS = "LOGOS",
1793
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1794
+ VIDEO_MAKER = "VIDEO_MAKER",
1795
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1796
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1797
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1798
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1799
+ /**
1800
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1801
+ *
1802
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
1803
+ */
1804
+ HTML_DRAFT = "HTML_DRAFT",
1805
+ /**
1806
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1807
+ * Will be accessible from Site List and will not have a website app.
1808
+ * Once the user attaches a site, the site will become a regular wixsite.
1809
+ */
1810
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
1811
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1812
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
1813
+ /** It is to be used in the Business First efforts. */
1814
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
1815
+ /** Bookings business flow with no site. */
1816
+ ANYWHERE = "ANYWHERE",
1817
+ /** Namespace for Headless Backoffice with no editor */
1818
+ HEADLESS = "HEADLESS",
1819
+ /**
1820
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1821
+ * The site will be used for account level CSM feature for enterprise
1822
+ */
1823
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1824
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1825
+ RISE = "RISE",
1826
+ /**
1827
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1828
+ * There's a blank site behind the scene but it's blank).
1829
+ * The Mobile company will be the owner of this namespace.
1830
+ */
1831
+ BRANDED_FIRST = "BRANDED_FIRST",
1832
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
1833
+ NOWNIA = "NOWNIA",
1834
+ /**
1835
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
1836
+ * The Partners company owns this namespace.
1837
+ */
1838
+ UGC_TEMPLATE = "UGC_TEMPLATE",
1839
+ /** Codux Headless Sites */
1840
+ CODUX = "CODUX",
1841
+ /** Bobb - AI Design Creator. */
1842
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1843
+ /**
1844
+ * Shared Blog Site is a unique single site across Enterprise account,
1845
+ * This site will hold all Blog posts related to the Marketing product.
1846
+ */
1847
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
1848
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1849
+ STANDALONE_FORMS = "STANDALONE_FORMS",
1850
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1851
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
1852
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
1853
+ MIMIR = "MIMIR",
1854
+ /** Wix Twins platform. */
1855
+ TWINS = "TWINS",
1856
+ /** Wix Nano. */
1857
+ NANO = "NANO"
1858
+ }
1859
+ /** @enumType */
1860
+ 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';
1861
+ /** Site transferred to another user. */
1862
+ interface SiteTransferred {
1863
+ /**
1864
+ * A previous owner id (user that transfers meta site).
1865
+ * @format GUID
1866
+ */
1867
+ oldOwnerId?: string;
1868
+ /**
1869
+ * A new owner id (user that accepts meta site).
1870
+ * @format GUID
1871
+ */
1872
+ newOwnerId?: string;
1873
+ }
1874
+ /** Soft deletion of the meta site. Could be restored. */
1875
+ interface SiteDeleted {
1876
+ /** A deletion context. */
1877
+ deleteContext?: DeleteContext;
1878
+ }
1879
+ interface DeleteContext {
1880
+ /** When the meta site was deleted. */
1881
+ dateDeleted?: Date | null;
1882
+ /** A status. */
1883
+ deleteStatus?: DeleteStatusWithLiterals;
1884
+ /**
1885
+ * A reason (flow).
1886
+ * @maxLength 255
1887
+ */
1888
+ deleteOrigin?: string;
1889
+ /**
1890
+ * A service that deleted it.
1891
+ * @maxLength 255
1892
+ */
1893
+ initiatorId?: string | null;
1894
+ }
1895
+ declare enum DeleteStatus {
1896
+ UNKNOWN = "UNKNOWN",
1897
+ TRASH = "TRASH",
1898
+ DELETED = "DELETED",
1899
+ PENDING_PURGE = "PENDING_PURGE",
1900
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1901
+ }
1902
+ /** @enumType */
1903
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1904
+ /** Restoration of the meta site. */
1905
+ interface SiteUndeleted {
1906
+ }
1907
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1908
+ interface SitePublished {
1909
+ }
1910
+ interface SiteUnpublished {
1911
+ /**
1912
+ * A list of URLs previously associated with the meta site.
1913
+ * @maxLength 4000
1914
+ * @maxSize 10000
1915
+ */
1916
+ urls?: string[];
1917
+ }
1918
+ interface SiteMarkedAsTemplate {
1919
+ }
1920
+ interface SiteMarkedAsWixSite {
1921
+ }
1922
+ /**
1923
+ * Represents a service provisioned a site.
1924
+ *
1925
+ * Note on `origin_instance_id`:
1926
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1927
+ * This is because of the following scenario:
1928
+ *
1929
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
1930
+ * such as a product catalog. When you create a site from this template, you inherit this
1931
+ * default product catalog. However, if the template's product catalog is modified,
1932
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
1933
+ * your site remains consistent with what you initially received and does not include any
1934
+ * changes made to the original template afterward.
1935
+ * To ensure this, the TPA on the template gets a new instance_id.
1936
+ */
1937
+ interface ServiceProvisioned {
1938
+ /**
1939
+ * Either UUID or EmbeddedServiceType.
1940
+ * @maxLength 36
1941
+ */
1942
+ appDefId?: string;
1943
+ /**
1944
+ * Not only UUID. Something here could be something weird.
1945
+ * @maxLength 36
1946
+ */
1947
+ instanceId?: string;
1948
+ /**
1949
+ * An instance id from which this instance is originated.
1950
+ * @maxLength 36
1951
+ */
1952
+ originInstanceId?: string;
1953
+ /**
1954
+ * A version.
1955
+ * @maxLength 500
1956
+ */
1957
+ version?: string | null;
1958
+ /**
1959
+ * The origin meta site id
1960
+ * @format GUID
1961
+ */
1962
+ originMetaSiteId?: string | null;
1963
+ }
1964
+ interface ServiceRemoved {
1965
+ /**
1966
+ * Either UUID or EmbeddedServiceType.
1967
+ * @maxLength 36
1968
+ */
1969
+ appDefId?: string;
1970
+ /**
1971
+ * Not only UUID. Something here could be something weird.
1972
+ * @maxLength 36
1973
+ */
1974
+ instanceId?: string;
1975
+ /**
1976
+ * A version.
1977
+ * @maxLength 500
1978
+ */
1979
+ version?: string | null;
1980
+ }
1981
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1982
+ interface SiteRenamed {
1983
+ /**
1984
+ * A new meta site name (URL slug).
1985
+ * @maxLength 20
1986
+ */
1987
+ newSiteName?: string;
1988
+ /**
1989
+ * A previous meta site name (URL slug).
1990
+ * @maxLength 255
1991
+ */
1992
+ oldSiteName?: string;
1993
+ }
1994
+ /**
1995
+ * Hard deletion of the meta site.
1996
+ *
1997
+ * Could not be restored. Therefore it's desirable to cleanup data.
1998
+ */
1999
+ interface SiteHardDeleted {
2000
+ /** A deletion context. */
2001
+ deleteContext?: DeleteContext;
2002
+ }
2003
+ interface NamespaceChanged {
2004
+ /** A previous namespace. */
2005
+ oldNamespace?: NamespaceWithLiterals;
2006
+ /** A new namespace. */
2007
+ newNamespace?: NamespaceWithLiterals;
2008
+ }
2009
+ /** Assigned Studio editor */
2010
+ interface StudioAssigned {
2011
+ }
2012
+ /** Unassigned Studio editor */
2013
+ interface StudioUnassigned {
2014
+ }
2015
+ /**
2016
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
2017
+ *
2018
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
2019
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
2020
+ *
2021
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
2022
+ */
2023
+ interface SiteUrlChanged {
2024
+ }
2025
+ /**
2026
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
2027
+ * Consumed by other teams to remove relevant data.
2028
+ */
2029
+ interface SitePurgedExternally {
2030
+ /**
2031
+ * @maxLength 2048
2032
+ * @maxSize 100
2033
+ * @deprecated
2034
+ * @targetRemovalDate 2025-04-15
2035
+ */
2036
+ appDefId?: string[];
2037
+ }
2038
+ /** Assigned Odeditor */
2039
+ interface OdeditorAssigned {
2040
+ }
2041
+ /** Unassigned Odeditor */
2042
+ interface OdeditorUnassigned {
2043
+ }
2044
+ /** Assigned Picasso editor */
2045
+ interface PicassoAssigned {
2046
+ }
2047
+ /** Unassigned Picasso */
2048
+ interface PicassoUnassigned {
2049
+ }
2050
+ interface SearchIndexingNotification {
2051
+ /** new state of indexing for the site specified in ms_id */
2052
+ indexState?: SearchIndexingNotificationStateWithLiterals;
2053
+ /** type of the document the notification is targeted for. Applies to all types if not provided */
2054
+ documentType?: string | null;
2055
+ /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
2056
+ language?: string | null;
2057
+ /**
2058
+ * site for which notification is targeted
2059
+ * @minLength 2
2060
+ */
2061
+ msId?: string | null;
2062
+ }
2063
+ declare enum SearchIndexingNotificationState {
2064
+ /** default state */
2065
+ Unknown = "Unknown",
2066
+ /** metasite does not require site search indexing */
2067
+ Off = "Off",
2068
+ /** metasite requires site search indexing */
2069
+ On = "On"
2070
+ }
2071
+ /** @enumType */
2072
+ type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On';
2073
+ /** Encapsulates all changes when site properties are updated */
2074
+ interface SitePropertiesUpdated {
2075
+ /** ID of the Wix site that has been updated. */
2076
+ metasiteId?: string;
2077
+ /** Update details. */
2078
+ event?: SitePropertiesEvent;
2079
+ }
2080
+ /** The actual update event for a particular notification. */
2081
+ interface SitePropertiesEvent {
2082
+ /** Version of the site's properties represented by this update. */
2083
+ version?: number;
2084
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
2085
+ fields?: string[];
2086
+ /** Updated properties. */
2087
+ properties?: Properties;
2088
+ }
2089
+ interface Properties {
2090
+ /** Site categories. */
2091
+ categories?: Categories;
2092
+ /** Site locale. */
2093
+ locale?: Locale;
2094
+ /**
2095
+ * Site language.
2096
+ *
2097
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
2098
+ */
2099
+ language?: string | null;
2100
+ /**
2101
+ * Site currency format used to bill customers.
2102
+ *
2103
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
2104
+ */
2105
+ paymentCurrency?: string | null;
2106
+ /** Timezone in `America/New_York` format. */
2107
+ timeZone?: string | null;
2108
+ /** Email address. */
2109
+ email?: string | null;
2110
+ /** Phone number. */
2111
+ phone?: string | null;
2112
+ /** Fax number. */
2113
+ fax?: string | null;
2114
+ /** Address. */
2115
+ address?: Address;
2116
+ /** Site display name. */
2117
+ siteDisplayName?: string | null;
2118
+ /** Business name. */
2119
+ businessName?: string | null;
2120
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
2121
+ logo?: string | null;
2122
+ /** Site description. */
2123
+ description?: string | null;
2124
+ /**
2125
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
2126
+ *
2127
+ * __Note:__ Not supported by Wix Bookings.
2128
+ */
2129
+ businessSchedule?: BusinessSchedule;
2130
+ /** Supported languages of a site and the primary language. */
2131
+ multilingual?: Multilingual;
2132
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
2133
+ consentPolicy?: ConsentPolicy;
2134
+ /**
2135
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
2136
+ *
2137
+ * Site business type.
2138
+ */
2139
+ businessConfig?: string | null;
2140
+ /** External site URL that uses Wix as its headless business solution. */
2141
+ externalSiteUrl?: string | null;
2142
+ /** Track clicks analytics. */
2143
+ trackClicksAnalytics?: boolean;
2144
+ }
2145
+ interface Categories {
2146
+ /** Primary site category. */
2147
+ primary?: string;
2148
+ /**
2149
+ * Secondary site category.
2150
+ * @maxSize 50
2151
+ */
2152
+ secondary?: string[];
2153
+ /** Business Term Id */
2154
+ businessTermId?: string | null;
2155
+ }
2156
+ interface Locale {
2157
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
2158
+ languageCode?: string;
2159
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
2160
+ country?: string;
2161
+ }
2162
+ interface Address {
2163
+ /** Street name. */
2164
+ street?: string;
2165
+ /** City name. */
2166
+ city?: string;
2167
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
2168
+ country?: string;
2169
+ /** State. */
2170
+ state?: string;
2171
+ /**
2172
+ * Zip or postal code.
2173
+ * @maxLength 20
2174
+ */
2175
+ zip?: string;
2176
+ /** Extra information to be displayed in the address. */
2177
+ hint?: AddressHint;
2178
+ /** Whether this address represents a physical location. */
2179
+ isPhysical?: boolean;
2180
+ /** Google-formatted version of this address. */
2181
+ googleFormattedAddress?: string;
2182
+ /** Street number. */
2183
+ streetNumber?: string;
2184
+ /** Apartment number. */
2185
+ apartmentNumber?: string;
2186
+ /** Geographic coordinates of location. */
2187
+ coordinates?: GeoCoordinates;
2188
+ }
2189
+ /**
2190
+ * Extra information on displayed addresses.
2191
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
2192
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
2193
+ */
2194
+ interface AddressHint {
2195
+ /** Extra text displayed next to, or instead of, the actual address. */
2196
+ text?: string;
2197
+ /** Where the extra text should be displayed. */
2198
+ placement?: PlacementTypeWithLiterals;
2199
+ }
2200
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
2201
+ declare enum PlacementType {
2202
+ BEFORE = "BEFORE",
2203
+ AFTER = "AFTER",
2204
+ REPLACE = "REPLACE"
2205
+ }
2206
+ /** @enumType */
2207
+ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
2208
+ /** Geocoordinates for a particular address. */
2209
+ interface GeoCoordinates {
2210
+ /** Latitude of the location. Must be between -90 and 90. */
2211
+ latitude?: number;
2212
+ /** Longitude of the location. Must be between -180 and 180. */
2213
+ longitude?: number;
2214
+ }
2215
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
2216
+ interface BusinessSchedule {
2217
+ /**
2218
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
2219
+ * @maxSize 100
2220
+ */
2221
+ periods?: TimePeriod[];
2222
+ /**
2223
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
2224
+ * @maxSize 100
2225
+ */
2226
+ specialHourPeriod?: SpecialHourPeriod[];
2227
+ }
2228
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
2229
+ interface TimePeriod {
2230
+ /** Day of the week the period starts on. */
2231
+ openDay?: DayOfWeekWithLiterals;
2232
+ /**
2233
+ * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
2234
+ * midnight at the end of the specified day.
2235
+ */
2236
+ openTime?: string;
2237
+ /** Day of the week the period ends on. */
2238
+ closeDay?: DayOfWeekWithLiterals;
2239
+ /**
2240
+ * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
2241
+ * midnight at the end of the specified day.
2242
+ *
2243
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
2244
+ */
2245
+ closeTime?: string;
2246
+ }
2247
+ /** Enumerates the days of the week. */
2248
+ declare enum DayOfWeek {
2249
+ MONDAY = "MONDAY",
2250
+ TUESDAY = "TUESDAY",
2251
+ WEDNESDAY = "WEDNESDAY",
2252
+ THURSDAY = "THURSDAY",
2253
+ FRIDAY = "FRIDAY",
2254
+ SATURDAY = "SATURDAY",
2255
+ SUNDAY = "SUNDAY"
2256
+ }
2257
+ /** @enumType */
2258
+ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
2259
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
2260
+ interface SpecialHourPeriod {
2261
+ /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
2262
+ startDate?: string;
2263
+ /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
2264
+ endDate?: string;
2265
+ /**
2266
+ * Whether the business is closed (or the service is not available) during the exception.
2267
+ *
2268
+ * Default: `true`.
2269
+ */
2270
+ isClosed?: boolean;
2271
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
2272
+ comment?: string;
2273
+ }
2274
+ interface Multilingual {
2275
+ /**
2276
+ * Supported languages list.
2277
+ * @maxSize 200
2278
+ */
2279
+ supportedLanguages?: SupportedLanguage[];
2280
+ /** Whether to redirect to user language. */
2281
+ autoRedirect?: boolean;
2282
+ }
2283
+ interface SupportedLanguage {
2284
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
2285
+ languageCode?: string;
2286
+ /** Locale. */
2287
+ locale?: Locale;
2288
+ /** Whether the supported language is the primary language for the site. */
2289
+ isPrimary?: boolean;
2290
+ /** Language icon. */
2291
+ countryCode?: string;
2292
+ /** How the language will be resolved. For internal use. */
2293
+ resolutionMethod?: ResolutionMethodWithLiterals;
2294
+ /** Whether the supported language is the primary language for site visitors. */
2295
+ isVisitorPrimary?: boolean | null;
2296
+ }
2297
+ declare enum ResolutionMethod {
2298
+ QUERY_PARAM = "QUERY_PARAM",
2299
+ SUBDOMAIN = "SUBDOMAIN",
2300
+ SUBDIRECTORY = "SUBDIRECTORY"
2301
+ }
2302
+ /** @enumType */
2303
+ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
2304
+ interface ConsentPolicy {
2305
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
2306
+ essential?: boolean | null;
2307
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
2308
+ functional?: boolean | null;
2309
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
2310
+ analytics?: boolean | null;
2311
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
2312
+ advertising?: boolean | null;
2313
+ /** CCPA compliance flag. */
2314
+ dataToThirdParty?: boolean | null;
2315
+ }
2316
+ interface MessageEnvelope {
2317
+ /**
2318
+ * App instance ID.
2319
+ * @format GUID
2320
+ */
2321
+ instanceId?: string | null;
2322
+ /**
2323
+ * Event type.
2324
+ * @maxLength 150
2325
+ */
2326
+ eventType?: string;
2327
+ /** The identification type and identity data. */
2328
+ identity?: IdentificationData;
2329
+ /** Stringify payload. */
2330
+ data?: string;
2331
+ }
2332
+ interface IdentificationData extends IdentificationDataIdOneOf {
2333
+ /**
2334
+ * ID of a site visitor that has not logged in to the site.
2335
+ * @format GUID
2336
+ */
2337
+ anonymousVisitorId?: string;
2338
+ /**
2339
+ * ID of a site visitor that has logged in to the site.
2340
+ * @format GUID
2341
+ */
2342
+ memberId?: string;
2343
+ /**
2344
+ * ID of a Wix user (site owner, contributor, etc.).
2345
+ * @format GUID
2346
+ */
2347
+ wixUserId?: string;
2348
+ /**
2349
+ * ID of an app.
2350
+ * @format GUID
2351
+ */
2352
+ appId?: string;
2353
+ /** @readonly */
2354
+ identityType?: WebhookIdentityTypeWithLiterals;
2355
+ }
2356
+ /** @oneof */
2357
+ interface IdentificationDataIdOneOf {
2358
+ /**
2359
+ * ID of a site visitor that has not logged in to the site.
2360
+ * @format GUID
2361
+ */
2362
+ anonymousVisitorId?: string;
2363
+ /**
2364
+ * ID of a site visitor that has logged in to the site.
2365
+ * @format GUID
2366
+ */
2367
+ memberId?: string;
2368
+ /**
2369
+ * ID of a Wix user (site owner, contributor, etc.).
2370
+ * @format GUID
2371
+ */
2372
+ wixUserId?: string;
2373
+ /**
2374
+ * ID of an app.
2375
+ * @format GUID
2376
+ */
2377
+ appId?: string;
2378
+ }
2379
+ declare enum WebhookIdentityType {
2380
+ UNKNOWN = "UNKNOWN",
2381
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2382
+ MEMBER = "MEMBER",
2383
+ WIX_USER = "WIX_USER",
2384
+ APP = "APP"
2385
+ }
2386
+ /** @enumType */
2387
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2388
+ /** @docsIgnore */
2389
+ type UpdateProgramApplicationErrors = {
2390
+ code?: 'WRONG_STATE';
2391
+ description?: string;
2392
+ data?: WrongStateErrorDetails;
2393
+ } | {
2394
+ code?: 'WRONG_START_DATE';
2395
+ description?: string;
2396
+ data?: WrongStartDateErrorDetails;
2397
+ } | {
2398
+ code?: 'WRONG_PARTICIPANTS_NUMBER';
2399
+ description?: string;
2400
+ data?: WrongParticipantsNumberErrorDetails;
2401
+ } | {
2402
+ code?: 'DUPLICATED_SLUG';
2403
+ description?: string;
2404
+ data?: DuplicatedSlugErrorDetails;
2405
+ } | {
2406
+ code?: 'TIMELINE_SWITCH_FORBIDDEN';
2407
+ description?: string;
2408
+ data?: TimelineSwitchForbiddenErrorDetails;
2409
+ };
2410
+ /** @docsIgnore */
2411
+ type PublishProgramApplicationErrors = {
2412
+ code?: 'INVALID_START_DATE';
2413
+ description?: string;
2414
+ data?: Record<string, any>;
2415
+ };
2416
+ /**
2417
+ * Creates a Program.
2418
+ * @param program - Program to be created.
2419
+ * @public
2420
+ * @documentationMaturity preview
2421
+ * @requiredField program
2422
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE
2423
+ * @applicableIdentity APP
2424
+ * @returns The created Program.
2425
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.CreateProgram
2426
+ */
2427
+ 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>>;
2428
+ /**
2429
+ * Duplicates the Program. Leaves certificate template, but removes social group.
2430
+ * @param programId - Program to be duplicated from.
2431
+ * @public
2432
+ * @documentationMaturity preview
2433
+ * @requiredField programId
2434
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE
2435
+ * @applicableIdentity APP
2436
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.DuplicateProgram
2437
+ */
2438
+ 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>>;
2439
+ /**
2440
+ * Retrieves a Program.
2441
+ * @param programId - ID of the Program to retrieve.
2442
+ * @public
2443
+ * @documentationMaturity preview
2444
+ * @requiredField programId
2445
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2446
+ * @applicableIdentity APP
2447
+ * @returns The requested Program.
2448
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.GetProgram
2449
+ */
2450
+ 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>>;
2451
+ /**
2452
+ * Updates a Program.
2453
+ * @param _id - Program ID.
2454
+ * @public
2455
+ * @documentationMaturity preview
2456
+ * @requiredField _id
2457
+ * @requiredField program
2458
+ * @requiredField program.revision
2459
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2460
+ * @applicableIdentity APP
2461
+ * @returns Updated Program.
2462
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.UpdateProgram
2463
+ */
2464
+ 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> & {
2465
+ __applicationErrorsType?: UpdateProgramApplicationErrors;
2466
+ }>;
2467
+ interface UpdateProgram {
2468
+ /**
2469
+ * Program ID.
2470
+ * @format GUID
2471
+ * @readonly
2472
+ */
2473
+ _id?: string | null;
2474
+ /** @readonly */
2475
+ revision?: string | null;
2476
+ /** @readonly */
2477
+ _createdDate?: Date | null;
2478
+ /** @readonly */
2479
+ _updatedDate?: Date | null;
2480
+ /**
2481
+ * current program state / does participant need it?
2482
+ * @readonly
2483
+ * @deprecated
2484
+ * @replacedBy status
2485
+ * @targetRemovalDate 2025-10-15
2486
+ */
2487
+ state?: V3StateWithLiterals;
2488
+ /**
2489
+ * current program state in v2 format
2490
+ * @readonly
2491
+ */
2492
+ status?: StatusWithLiterals;
2493
+ /**
2494
+ * @internal
2495
+ * @readonly
2496
+ * @deprecated
2497
+ * @replacedBy status_updated_date
2498
+ * @targetRemovalDate 2025-10-15
2499
+ */
2500
+ stateUpdatedDate?: Date | null;
2501
+ /**
2502
+ * date of the last status update
2503
+ * @internal
2504
+ * @readonly
2505
+ */
2506
+ statusUpdatedDate?: Date | null;
2507
+ /**
2508
+ * assigned categories
2509
+ * @readonly
2510
+ * @format GUID
2511
+ * @maxSize 10
2512
+ */
2513
+ categoryIds?: string[];
2514
+ /** general program info. */
2515
+ description?: Description;
2516
+ /** timeline type -> Self-paced, time-restricted. */
2517
+ timeline?: Timeline;
2518
+ /** participant limitation, step-completion pace and etc. */
2519
+ restrictions?: Restrictions;
2520
+ /** single-payment price. */
2521
+ price?: Money;
2522
+ /** seo settings. */
2523
+ seo?: Seo;
2524
+ /**
2525
+ * rewards to be assigned after reaching some of the program milestones.
2526
+ * @maxSize 10
2527
+ */
2528
+ rewards?: Reward[];
2529
+ /**
2530
+ * connected social group.
2531
+ * @format GUID
2532
+ */
2533
+ socialGroupId?: string | null;
2534
+ /**
2535
+ * join flow options.
2536
+ * @deprecated
2537
+ * @replacedBy restrictions.access_type
2538
+ * @targetRemovalDate 2025-10-15
2539
+ */
2540
+ accessType?: AccessTypeWithLiterals;
2541
+ /** extensible field */
2542
+ extendedFields?: ExtendedFields;
2543
+ /** if true -> invoice is sent to the customer who purchased the program via single payment; else -> payment confirmation email is sent */
2544
+ shouldSendInvoice?: boolean;
2545
+ /** settings related to video steps in programs */
2546
+ videoStepsSettings?: VideoStepsSettings;
2547
+ /**
2548
+ * number of content entities in program
2549
+ * @readonly
2550
+ */
2551
+ contentSummary?: ContentSummary;
2552
+ /**
2553
+ * user id of owner, who created this program
2554
+ * @format GUID
2555
+ * @readonly
2556
+ */
2557
+ ownerUserId?: string | null;
2558
+ }
2559
+ /**
2560
+ * Deletes a Program.
2561
+ * Deleting a Program permanently removes them from the Program List.
2562
+ * @param programId - Id of the Program to delete.
2563
+ * @public
2564
+ * @documentationMaturity preview
2565
+ * @requiredField programId
2566
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_DELETE
2567
+ * @applicableIdentity APP
2568
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.DeleteProgram
2569
+ */
2570
+ declare function deleteProgram(programId: string): Promise<void>;
2571
+ /**
2572
+ * Retrieves a list of Programs
2573
+ * @public
2574
+ * @documentationMaturity preview
2575
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2576
+ * @applicableIdentity APP
2577
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms
2578
+ */
2579
+ declare function queryPrograms(): ProgramsQueryBuilder;
2580
+ interface QueryCursorResult {
2581
+ cursors: Cursors;
2582
+ hasNext: () => boolean;
2583
+ hasPrev: () => boolean;
2584
+ length: number;
2585
+ pageSize: number;
2586
+ }
2587
+ interface ProgramsQueryResult extends QueryCursorResult {
2588
+ items: Program[];
2589
+ query: ProgramsQueryBuilder;
2590
+ next: () => Promise<ProgramsQueryResult>;
2591
+ prev: () => Promise<ProgramsQueryResult>;
2592
+ }
2593
+ interface ProgramsQueryBuilder {
2594
+ /** @param propertyName - Property whose value is compared with `value`.
2595
+ * @param value - Value to compare against.
2596
+ * @documentationMaturity preview
2597
+ */
2598
+ eq: (propertyName: '_id' | 'state' | 'status' | 'timeline.selfPaced' | 'seo.slug' | 'socialGroupId', value: any) => ProgramsQueryBuilder;
2599
+ /** @param propertyName - Property whose value is compared with `values`.
2600
+ * @param values - List of values to compare against.
2601
+ * @documentationMaturity preview
2602
+ */
2603
+ hasSome: (propertyName: string, value: any[]) => ProgramsQueryBuilder;
2604
+ /** @param propertyName - Property whose value is compared with `values`.
2605
+ * @param values - List of values to compare against.
2606
+ * @documentationMaturity preview
2607
+ */
2608
+ hasAll: (propertyName: string, value: any[]) => ProgramsQueryBuilder;
2609
+ /** @documentationMaturity preview */
2610
+ in: (propertyName: '_id' | 'state' | 'status' | 'restrictions.accessType' | 'socialGroupId' | 'accessType', value: any) => ProgramsQueryBuilder;
2611
+ /** @documentationMaturity preview */
2612
+ exists: (propertyName: 'price', value: boolean) => ProgramsQueryBuilder;
2613
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2614
+ * @documentationMaturity preview
2615
+ */
2616
+ ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'status' | 'stateUpdatedDate' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2617
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2618
+ * @documentationMaturity preview
2619
+ */
2620
+ descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'status' | 'stateUpdatedDate' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder;
2621
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2622
+ * @documentationMaturity preview
2623
+ */
2624
+ limit: (limit: number) => ProgramsQueryBuilder;
2625
+ /** @param cursor - A pointer to specific record
2626
+ * @documentationMaturity preview
2627
+ */
2628
+ skipTo: (cursor: string) => ProgramsQueryBuilder;
2629
+ /** @documentationMaturity preview */
2630
+ find: () => Promise<ProgramsQueryResult>;
2631
+ }
2632
+ interface ProgramSearchSpec extends SearchSpec {
2633
+ searchable: ['description.title'];
2634
+ aggregatable: [
2635
+ '_id',
2636
+ 'accessType',
2637
+ 'categoryIds',
2638
+ 'description.title',
2639
+ 'restrictions.accessType',
2640
+ 'state',
2641
+ 'status',
2642
+ 'timeline.selfPaced'
2643
+ ];
2644
+ paging: 'cursor';
2645
+ wql: [
2646
+ {
2647
+ operators: '*';
2648
+ fields: ['_id', 'description.title'];
2649
+ sort: 'BOTH';
2650
+ },
2651
+ {
2652
+ operators: ['$eq', '$in'];
2653
+ fields: ['state'];
2654
+ sort: 'BOTH';
2655
+ },
2656
+ {
2657
+ operators: ['$eq', '$in'];
2658
+ fields: ['status'];
2659
+ sort: 'BOTH';
2660
+ },
2661
+ {
2662
+ operators: [];
2663
+ fields: ['_createdDate'];
2664
+ sort: 'BOTH';
2665
+ },
2666
+ {
2667
+ operators: ['$eq'];
2668
+ fields: ['timeline.selfPaced'];
2669
+ sort: 'NONE';
2670
+ },
2671
+ {
2672
+ operators: ['$in'];
2673
+ fields: ['accessType'];
2674
+ sort: 'NONE';
2675
+ },
2676
+ {
2677
+ operators: ['$in'];
2678
+ fields: ['restrictions.accessType'];
2679
+ sort: 'NONE';
2680
+ },
2681
+ {
2682
+ operators: [];
2683
+ fields: ['_updatedDate'];
2684
+ sort: 'BOTH';
2685
+ },
2686
+ {
2687
+ operators: ['$hasAll', '$hasSome'];
2688
+ fields: ['categoryIds'];
2689
+ sort: 'NONE';
2690
+ }
2691
+ ];
2692
+ }
2693
+ type CommonSearchWithEntityContext = Search<Program, ProgramSearchSpec>;
2694
+ type ProgramSearch = {
2695
+ /**
2696
+ Cursor paging options.
2697
+
2698
+ Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2699
+ */
2700
+ cursorPaging?: {
2701
+ /**
2702
+ Maximum number of items to return in the results.
2703
+ @max: 100
2704
+ */
2705
+ limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
2706
+ /**
2707
+ Pointer to the next or previous page in the list of results.
2708
+
2709
+ Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2710
+ Not relevant for the first request.
2711
+ @maxLength: 16000
2712
+ */
2713
+ cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
2714
+ };
2715
+ /**
2716
+ Filter object.
2717
+
2718
+ Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2719
+ */
2720
+ filter?: CommonSearchWithEntityContext['filter'] | null;
2721
+ /**
2722
+ List of sort objects.
2723
+
2724
+ Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2725
+ @maxSize: 10
2726
+ */
2727
+ sort?: {
2728
+ /**
2729
+ Name of the field to sort by.
2730
+ @maxLength: 512
2731
+ */
2732
+ fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
2733
+ /**
2734
+ Sort order.
2735
+ */
2736
+ order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
2737
+ }[];
2738
+ /**
2739
+ Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
2740
+ @maxSize: 10
2741
+ */
2742
+ aggregations?: {
2743
+ /**
2744
+ Value aggregation.
2745
+ */
2746
+ value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
2747
+ /**
2748
+ Range aggregation.
2749
+ */
2750
+ range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
2751
+ /**
2752
+ Scalar aggregation.
2753
+ */
2754
+ scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
2755
+ /**
2756
+ Date histogram aggregation.
2757
+ */
2758
+ dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
2759
+ /**
2760
+ Nested aggregation.
2761
+ */
2762
+ nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
2763
+ /**
2764
+ User-defined name of aggregation, should be unique, will appear in aggregation results.
2765
+ @maxLength: 100
2766
+ */
2767
+ name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
2768
+ /**
2769
+ Type of aggregation, client must provide matching aggregation field below.
2770
+ */
2771
+ type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
2772
+ /**
2773
+ Field to aggregate by, use dot notation to specify json path.
2774
+ @maxLength: 200
2775
+ */
2776
+ fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
2777
+ /**
2778
+ Deprecated. Use `nested` instead.
2779
+ @deprecated: Deprecated. Use `nested` instead.,
2780
+ @replacedBy: kind.nested,
2781
+ @targetRemovalDate: 2024-03-30
2782
+ */
2783
+ groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
2784
+ }[];
2785
+ /**
2786
+ Free text to match in searchable fields.
2787
+ */
2788
+ search?: {
2789
+ /**
2790
+ Defines how separate search terms in `expression` are combined.
2791
+ */
2792
+ mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
2793
+ /**
2794
+ Search term or expression.
2795
+ @maxLength: 100
2796
+ */
2797
+ expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
2798
+ /**
2799
+ Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
2800
+ @maxLength: 200,
2801
+ @maxSize: 20
2802
+ */
2803
+ fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
2804
+ /**
2805
+ Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm).
2806
+ */
2807
+ fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
2808
+ };
2809
+ /**
2810
+ UTC offset or IANA time zone. Valid values are
2811
+ ISO 8601 UTC offsets, such as +02:00 or -06:00,
2812
+ and IANA time zone IDs, such as Europe/Rome.
2813
+
2814
+ Affects all filters and aggregations returned values.
2815
+ You may override this behavior in a specific filter by providing
2816
+ timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
2817
+ @maxLength: 50
2818
+ */
2819
+ timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
2820
+ };
2821
+ /**
2822
+ * Publishes draft program. In other state returns program as is.
2823
+ * @param programId - Program to publish
2824
+ * @public
2825
+ * @documentationMaturity preview
2826
+ * @requiredField programId
2827
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2828
+ * @applicableIdentity APP
2829
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.PublishProgram
2830
+ */
2831
+ 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> & {
2832
+ __applicationErrorsType?: PublishProgramApplicationErrors;
2833
+ }>;
2834
+ /**
2835
+ * Ends program.
2836
+ * @param programId - Program to finish
2837
+ * @public
2838
+ * @documentationMaturity preview
2839
+ * @requiredField programId
2840
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2841
+ * @applicableIdentity APP
2842
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.EndProgram
2843
+ */
2844
+ 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>>;
2845
+ /**
2846
+ * Archives program
2847
+ * @param programId - Program to archive
2848
+ * @public
2849
+ * @documentationMaturity preview
2850
+ * @requiredField programId
2851
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2852
+ * @applicableIdentity APP
2853
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.ArchiveProgram
2854
+ */
2855
+ 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>>;
2856
+ /**
2857
+ * Update multiple Programs in a single request. Works synchronously.
2858
+ * @param programs - List of programs you want to update
2859
+ * @public
2860
+ * @documentationMaturity preview
2861
+ * @requiredField programs
2862
+ * @requiredField programs.program.revision
2863
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE
2864
+ * @applicableIdentity APP
2865
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.BulkUpdatePrograms
2866
+ */
2867
+ 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>>;
2868
+ interface BulkUpdateProgramsOptions {
2869
+ /** set to `true` if you wish to receive back the created programs in the response */
2870
+ returnEntity?: boolean;
2871
+ }
2872
+ /**
2873
+ * Counts programs matching the filter
2874
+ * @public
2875
+ * @documentationMaturity preview
2876
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2877
+ * @applicableIdentity APP
2878
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.CountPrograms
2879
+ */
2880
+ declare function countPrograms(options?: CountProgramsOptions): Promise<NonNullablePaths<CountProgramsResponse, `count`, 2>>;
2881
+ interface CountProgramsOptions {
2882
+ /** filter for which count is requested */
2883
+ filter?: Record<string, any> | null;
2884
+ }
2885
+ /**
2886
+ * Returns list of sample programs.
2887
+ * @public
2888
+ * @documentationMaturity preview
2889
+ * @permissionId ONLINE_PROGRAMS.PROGRAM_READ
2890
+ * @applicableIdentity APP
2891
+ * @fqn wix.onlineprograms.programs.v3.ProgramsService.ListSamplePrograms
2892
+ */
2893
+ 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>>;
2894
+
2895
+ export { type Settings as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, type Description as F, type DescriptionMediaOneOf as G, type FocalPoint as H, Interval as I, type VideoResolution 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, RestrictionsAccessType as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, V3State 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 SearchProgramsRequest 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 BulkProgramResult as aA, type ItemMetadata as aB, type ApplicationError as aC, type BulkActionMetadata as aD, type DeleteAllProgramsMigrationRequest as aE, type DeleteAllProgramsMigrationResponse as aF, type DuplicateProgramRequest as aG, type GetProgramRequest as aH, type GetProgramResponse as aI, type UpdateProgramRequest as aJ, type UpdateProgramResponse as aK, type WrongStateErrorDetails as aL, type WrongStartDateErrorDetails as aM, type WrongParticipantsNumberErrorDetails as aN, type DuplicatedSlugErrorDetails as aO, type TimelineSwitchForbiddenErrorDetails as aP, type DeleteProgramRequest as aQ, type DeleteProgramResponse as aR, type QueryProgramsRequest as aS, type QueryV2 as aT, type QueryV2PagingMethodOneOf as aU, type Sorting as aV, type Paging as aW, type CursorPaging as aX, type QueryProgramsResponse as aY, type PagingMetadataV2 as aZ, type Cursors 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 ReindexMessage as am, type ReindexMessageActionOneOf as an, type Upsert as ao, type Delete as ap, type Schema as aq, type ProgramPublished as ar, type ProgramEnded as as, type ProgramArchived as at, type ProgramDuplicated as au, type CreateProgramRequest as av, type CreateProgramResponse as aw, type BulkCreateProgramsMigrationRequest as ax, type ProgramMigration as ay, type BulkCreateProgramsMigrationResponse as az, type ProgramsQueryBuilder as b, type SiteDeleted as b$, type CursorSearch as b0, type CursorSearchPagingMethodOneOf as b1, type Aggregation as b2, type AggregationKindOneOf as b3, type RangeBucket as b4, type IncludeMissingValuesOptions as b5, type ValueAggregation as b6, type ValueAggregationOptionsOneOf as b7, type RangeAggregation as b8, type ScalarAggregation as b9, type NestedResults as bA, type AggregationResults as bB, type AggregationResultsResultOneOf as bC, type PublishProgramRequest as bD, type EndProgramRequest as bE, type ArchiveProgramRequest as bF, type BulkUpdateProgramsRequest as bG, type BulkUpdateProgramResult as bH, type CountProgramsRequest as bI, type ListSampleProgramsRequest as bJ, type LabeledProgram as bK, type DomainEvent as bL, type DomainEventBodyOneOf as bM, type EntityCreatedEvent as bN, type RestoreInfo as bO, type EntityUpdatedEvent as bP, type EntityDeletedEvent as bQ, type ActionEvent as bR, type Empty as bS, type ResolveProgramSlugRequest as bT, type ResolveProgramSlugResponse as bU, type MissingMetasiteIdErrorDetails as bV, type MetaSiteSpecialEvent as bW, type MetaSiteSpecialEventPayloadOneOf as bX, type Asset as bY, type SiteCreated as bZ, type SiteTransferred as b_, type DateHistogramAggregation as ba, type NestedAggregationItem as bb, type NestedAggregationItemKindOneOf as bc, type NestedAggregation as bd, type GroupByAggregation as be, type GroupByAggregationKindOneOf as bf, type SearchDetails as bg, type CursorPagingMetadata as bh, type AggregationData as bi, type ValueAggregationResult as bj, type RangeAggregationResult as bk, type NestedAggregationResults as bl, type NestedAggregationResultsResultOneOf as bm, type ValueResults as bn, type RangeResults as bo, type AggregationResultsScalarResult as bp, type NestedValueAggregationResult as bq, type ValueResult as br, type RangeResult as bs, type ScalarResult as bt, type NestedResultValue as bu, type NestedResultValueResultOneOf as bv, type Results as bw, type DateHistogramResult as bx, type GroupByValueResults as by, type DateHistogramResults as bz, type ProgramSearch as c, type WebhookIdentityTypeWithLiterals as c$, type DeleteContext as c0, type SiteUndeleted as c1, type SitePublished as c2, type SiteUnpublished as c3, type SiteMarkedAsTemplate as c4, type SiteMarkedAsWixSite as c5, type ServiceProvisioned as c6, type ServiceRemoved as c7, type SiteRenamed as c8, type SiteHardDeleted as c9, type IdentificationDataIdOneOf as cA, type ProgramsQueryResult as cB, type ProgramSearchSpec as cC, type V3StateWithLiterals as cD, type StatusWithLiterals as cE, type RestrictionsAccessTypeWithLiterals as cF, type TriggerWithLiterals as cG, type AccessTypeWithLiterals as cH, type EnumWithLiterals as cI, type BulkActionTypeWithLiterals as cJ, type SortOrderWithLiterals as cK, type SortTypeWithLiterals as cL, type SortDirectionWithLiterals as cM, type MissingValuesWithLiterals as cN, type ScalarTypeWithLiterals as cO, type NestedAggregationTypeWithLiterals as cP, type IntervalWithLiterals as cQ, type AggregationTypeWithLiterals as cR, type ModeWithLiterals as cS, type StateWithLiterals as cT, type SiteCreatedContextWithLiterals as cU, type NamespaceWithLiterals as cV, type DeleteStatusWithLiterals as cW, type SearchIndexingNotificationStateWithLiterals as cX, type PlacementTypeWithLiterals as cY, type DayOfWeekWithLiterals as cZ, type ResolutionMethodWithLiterals as c_, type NamespaceChanged as ca, type StudioAssigned as cb, type StudioUnassigned as cc, type SiteUrlChanged as cd, type SitePurgedExternally as ce, type OdeditorAssigned as cf, type OdeditorUnassigned as cg, type PicassoAssigned as ch, type PicassoUnassigned as ci, type SearchIndexingNotification as cj, type SitePropertiesUpdated as ck, type SitePropertiesEvent as cl, type Properties as cm, type Categories as cn, type Locale as co, type Address as cp, type AddressHint as cq, type GeoCoordinates as cr, type BusinessSchedule as cs, type TimePeriod as ct, type SpecialHourPeriod as cu, type Multilingual as cv, type SupportedLanguage as cw, type ConsentPolicy as cx, type MessageEnvelope as cy, type IdentificationData as cz, type PublishProgramResponse as d, type CommonSearchWithEntityContext as d0, createProgram as d1, duplicateProgram as d2, getProgram as d3, updateProgram as d4, deleteProgram as d5, queryPrograms as d6, publishProgram as d7, endProgram as d8, archiveProgram as d9, bulkUpdatePrograms as da, countPrograms as db, listSamplePrograms as dc, type PublishProgramApplicationErrors as e, type BulkUpdateProgramsResponse as f, type CountProgramsResponse as g, Status as h, AccessType as i, Enum as j, BulkActionType as k, SortOrder as l, SortType as m, SortDirection as n, MissingValues as o, ScalarType as p, AggregationType as q, Mode as r, State as s, SiteCreatedContext as t, Namespace as u, DeleteStatus as v, SearchIndexingNotificationState as w, PlacementType as x, DayOfWeek as y, ResolutionMethod as z };