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