@wix/auto_sdk_online-programs_participants 1.0.11 → 1.0.13
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 +6 -134
- package/build/cjs/index.js +161 -1489
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +691 -12
- package/build/cjs/index.typings.js +174 -1372
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +184 -1274
- package/build/cjs/meta.js +19 -1060
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +6 -134
- package/build/es/index.mjs +144 -1446
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +691 -12
- package/build/es/index.typings.mjs +166 -1337
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +184 -1274
- package/build/es/meta.mjs +10 -1025
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +6 -145
- package/build/internal/cjs/index.js +161 -1489
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +691 -12
- package/build/internal/cjs/index.typings.js +174 -1372
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +184 -1274
- package/build/internal/cjs/meta.js +19 -1060
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +6 -145
- package/build/internal/es/index.mjs +144 -1446
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +691 -12
- package/build/internal/es/index.typings.mjs +166 -1337
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +184 -1274
- package/build/internal/es/meta.mjs +10 -1025
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
- package/build/cjs/online-programs-v3-participant-participants.universal-DRubTE1O.d.ts +0 -2228
- package/build/es/online-programs-v3-participant-participants.universal-DRubTE1O.d.mts +0 -2228
- package/build/internal/cjs/online-programs-v3-participant-participants.universal-DUdmZP01.d.ts +0 -2238
- package/build/internal/es/online-programs-v3-participant-participants.universal-DUdmZP01.d.mts +0 -2238
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BulkInviteToProgramRequest as BulkInviteToProgramRequest$1, BulkInviteToProgramResponse as BulkInviteToProgramResponse$1, BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponse$1, BulkAddToProgramRequest as BulkAddToProgramRequest$1, BulkAddToProgramResponse as BulkAddToProgramResponse$1, BulkApproveParticipantRequest as BulkApproveParticipantRequest$1, BulkApproveParticipantResponse as BulkApproveParticipantResponse$1, BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Participant {
|
|
@@ -8,20 +8,11 @@ interface Participant {
|
|
|
8
8
|
* @readonly
|
|
9
9
|
*/
|
|
10
10
|
id?: string | null;
|
|
11
|
-
/**
|
|
12
|
-
* Participant revision (for optimistic concurrency control).
|
|
13
|
-
* @readonly
|
|
14
|
-
*/
|
|
11
|
+
/** @readonly */
|
|
15
12
|
revision?: string | null;
|
|
16
|
-
/**
|
|
17
|
-
* Participant creation date
|
|
18
|
-
* @readonly
|
|
19
|
-
*/
|
|
13
|
+
/** @readonly */
|
|
20
14
|
createdDate?: Date | null;
|
|
21
|
-
/**
|
|
22
|
-
* Participant last update date
|
|
23
|
-
* @readonly
|
|
24
|
-
*/
|
|
15
|
+
/** @readonly */
|
|
25
16
|
updatedDate?: Date | null;
|
|
26
17
|
/**
|
|
27
18
|
* Member ID of participant on site
|
|
@@ -40,143 +31,103 @@ interface Participant {
|
|
|
40
31
|
* @readonly
|
|
41
32
|
*/
|
|
42
33
|
progress?: Progress;
|
|
43
|
-
/**
|
|
44
|
-
|
|
45
|
-
* @readonly
|
|
46
|
-
*/
|
|
47
|
-
status?: StatusWithLiterals;
|
|
34
|
+
/** state of participation in the program */
|
|
35
|
+
state?: StateWithLiterals;
|
|
48
36
|
/**
|
|
49
37
|
* Certificate issued to participant
|
|
50
38
|
* @readonly
|
|
51
39
|
*/
|
|
52
40
|
certificate?: Certificate;
|
|
53
|
-
/** Additional info about when and how participant joined the program and which timeframes participant has to complete program. */
|
|
54
41
|
joinedInfo?: JoinedInfo;
|
|
55
|
-
/**
|
|
56
|
-
* Site member info snapshot for the participant
|
|
57
|
-
* @readonly
|
|
58
|
-
*/
|
|
42
|
+
/** @readonly */
|
|
59
43
|
member?: Member;
|
|
60
|
-
/**
|
|
61
|
-
* Last activity date of the participant in the program (can either be status change or step resolution).
|
|
62
|
-
* @readonly
|
|
63
|
-
*/
|
|
44
|
+
/** @readonly */
|
|
64
45
|
lastActivityDate?: Date | null;
|
|
65
|
-
/** Extended fields for participant (can be used for storing custom data). */
|
|
66
46
|
extendedFields?: ExtendedFields;
|
|
67
|
-
/** Tags for categorizing and organizing participants. */
|
|
68
|
-
tags?: Tags;
|
|
69
47
|
}
|
|
70
48
|
declare enum JoinPath {
|
|
71
|
-
/** Default value. This value is unused. */
|
|
72
49
|
UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
|
|
73
|
-
/** Member joined to the program for free
|
|
50
|
+
/** Member joined to the program for free */
|
|
74
51
|
FREE = "FREE",
|
|
75
|
-
/** Member was added to the program by site owner
|
|
52
|
+
/** Member was added to the program by site owner */
|
|
76
53
|
ADDED = "ADDED",
|
|
77
|
-
/** Member paid once to join the program
|
|
54
|
+
/** Member paid once to join the program */
|
|
78
55
|
SINGLE_PAYMENT = "SINGLE_PAYMENT",
|
|
79
|
-
/** Member has Paid Plan to join
|
|
56
|
+
/** Member has Paid Plan to join */
|
|
80
57
|
PAID_PLAN = "PAID_PLAN",
|
|
81
|
-
/** Member joined with the Free Coupon
|
|
58
|
+
/** Member joined with the Free Coupon */
|
|
82
59
|
FREE_COUPON = "FREE_COUPON"
|
|
83
60
|
}
|
|
84
61
|
/** @enumType */
|
|
85
62
|
type JoinPathWithLiterals = JoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
|
|
86
63
|
interface SinglePaymentDetails {
|
|
87
|
-
/**
|
|
88
|
-
* ID of the cashier order which was used to pay for joining the program.
|
|
89
|
-
* @format GUID
|
|
90
|
-
* @immutable
|
|
91
|
-
*/
|
|
64
|
+
/** @format GUID */
|
|
92
65
|
paymentOrderId?: string;
|
|
93
|
-
/**
|
|
94
|
-
* ID of the offline transaction if offline payment flow from cashier was used.
|
|
95
|
-
* @format GUID
|
|
96
|
-
* @immutable
|
|
97
|
-
*/
|
|
66
|
+
/** @format GUID */
|
|
98
67
|
offlineTransactionId?: string | null;
|
|
99
68
|
}
|
|
100
69
|
interface PaidPlanDetails {
|
|
101
|
-
/**
|
|
102
|
-
* ID of the Paid Plan for which member has paid to join the program.
|
|
103
|
-
* @format GUID
|
|
104
|
-
* @immutable
|
|
105
|
-
*/
|
|
70
|
+
/** @format GUID */
|
|
106
71
|
paidPlanId?: string;
|
|
107
72
|
}
|
|
108
73
|
interface FreeCouponDetails {
|
|
109
|
-
/**
|
|
110
|
-
* ID of the coupon which was applied and gave 100% discount to join the program for free.
|
|
111
|
-
* @format GUID
|
|
112
|
-
* @immutable
|
|
113
|
-
*/
|
|
74
|
+
/** @format GUID */
|
|
114
75
|
freeCouponId?: string;
|
|
115
76
|
}
|
|
116
77
|
interface Progress {
|
|
117
|
-
/** Number of program steps completed by member
|
|
78
|
+
/** Number of program steps completed by member */
|
|
118
79
|
totalStepsCompleted?: number;
|
|
119
|
-
/** Total number of program steps available to resolve
|
|
80
|
+
/** Total number of program steps available to resolve */
|
|
120
81
|
totalStepsAvailable?: number;
|
|
121
82
|
/**
|
|
122
|
-
* Completion percentage
|
|
83
|
+
* Completion percentage
|
|
123
84
|
* @max 100
|
|
124
85
|
*/
|
|
125
86
|
completionPercentage?: number;
|
|
126
87
|
}
|
|
127
|
-
declare enum
|
|
128
|
-
/**
|
|
129
|
-
|
|
130
|
-
/** Member joined the program and became participant
|
|
88
|
+
declare enum State {
|
|
89
|
+
/** Unknown state */
|
|
90
|
+
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
91
|
+
/** Member joined the program and became participant */
|
|
131
92
|
JOINED = "JOINED",
|
|
132
|
-
/** Participant completed the program, and could join again
|
|
93
|
+
/** Participant completed the program, and could join again */
|
|
133
94
|
COMPLETED = "COMPLETED",
|
|
134
|
-
/** Participant failed to complete the program, and could join again
|
|
95
|
+
/** Participant failed to complete the program, and could join again */
|
|
135
96
|
FAILED = "FAILED",
|
|
136
|
-
/** Participant with ended pricing plan (PP), will be joined as renew PP
|
|
97
|
+
/** Participant with ended pricing plan (PP), will be joined as renew PP */
|
|
137
98
|
SUSPENDED = "SUSPENDED",
|
|
138
|
-
/** Participant removed automatically after some program condition
|
|
99
|
+
/** Participant removed automatically after some program condition */
|
|
139
100
|
AUTO_REMOVED = "AUTO_REMOVED",
|
|
140
|
-
/** Participant removed by site owner
|
|
101
|
+
/** Participant removed by site owner */
|
|
141
102
|
REMOVED = "REMOVED",
|
|
142
|
-
/** Participant left the program by himself
|
|
103
|
+
/** Participant left the program by himself */
|
|
143
104
|
LEFT = "LEFT"
|
|
144
105
|
}
|
|
145
106
|
/** @enumType */
|
|
146
|
-
type
|
|
107
|
+
type StateWithLiterals = State | 'UNKNOWN_STATE' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
|
|
147
108
|
interface Certificate {
|
|
148
109
|
/**
|
|
149
|
-
* when certificate was issued, UTC
|
|
110
|
+
* when certificate was issued, UTC
|
|
150
111
|
* @readonly
|
|
151
112
|
*/
|
|
152
113
|
issuedDate?: Date | null;
|
|
153
114
|
}
|
|
154
115
|
interface JoinedInfo extends JoinedInfoJoinPathDetailsOneOf {
|
|
155
|
-
/** Details about Single Payment join path. */
|
|
156
116
|
singlePaymentDetails?: SinglePaymentDetails;
|
|
157
|
-
/** Details about Paid Plan join path. */
|
|
158
117
|
paidPlanDetails?: PaidPlanDetails;
|
|
159
|
-
/** Details about Free Coupon join path. */
|
|
160
118
|
freeCouponDetails?: FreeCouponDetails;
|
|
161
119
|
/**
|
|
162
|
-
* Time zone for site on which member joined the program.
|
|
163
120
|
* @maxLength 50
|
|
164
121
|
* @readonly
|
|
165
122
|
*/
|
|
166
123
|
timeZone?: string;
|
|
167
124
|
/**
|
|
168
|
-
* Date when participant starts the program (is the same as join date if program does not have start date, otherwise can be later).
|
|
169
125
|
* @format LOCAL_DATE
|
|
170
126
|
* @readonly
|
|
171
127
|
*/
|
|
172
128
|
startDate?: string;
|
|
173
|
-
/**
|
|
174
|
-
* How participant joined the program.
|
|
175
|
-
* @immutable
|
|
176
|
-
*/
|
|
177
129
|
joinPath?: JoinPathWithLiterals;
|
|
178
130
|
/**
|
|
179
|
-
* Date before which participant has to finish the program (is not empty only if program itself has finish date).
|
|
180
131
|
* @format LOCAL_DATE
|
|
181
132
|
* @readonly
|
|
182
133
|
*/
|
|
@@ -184,40 +135,29 @@ interface JoinedInfo extends JoinedInfoJoinPathDetailsOneOf {
|
|
|
184
135
|
}
|
|
185
136
|
/** @oneof */
|
|
186
137
|
interface JoinedInfoJoinPathDetailsOneOf {
|
|
187
|
-
/** Details about Single Payment join path. */
|
|
188
138
|
singlePaymentDetails?: SinglePaymentDetails;
|
|
189
|
-
/** Details about Paid Plan join path. */
|
|
190
139
|
paidPlanDetails?: PaidPlanDetails;
|
|
191
|
-
/** Details about Free Coupon join path. */
|
|
192
140
|
freeCouponDetails?: FreeCouponDetails;
|
|
193
141
|
}
|
|
194
142
|
interface Member {
|
|
195
143
|
/**
|
|
196
|
-
* First name of the site member.
|
|
197
144
|
* @readonly
|
|
198
|
-
* @maxLength
|
|
145
|
+
* @maxLength 100
|
|
199
146
|
*/
|
|
200
147
|
firstName?: string | null;
|
|
201
148
|
/**
|
|
202
|
-
* Last name of the site member.
|
|
203
149
|
* @readonly
|
|
204
|
-
* @maxLength
|
|
150
|
+
* @maxLength 100
|
|
205
151
|
*/
|
|
206
152
|
lastName?: string | null;
|
|
207
153
|
/**
|
|
208
|
-
* Email of the site member.
|
|
209
154
|
* @readonly
|
|
210
155
|
* @format EMAIL
|
|
211
156
|
*/
|
|
212
157
|
email?: string | null;
|
|
213
|
-
/**
|
|
214
|
-
* Contact ID of the site member.
|
|
215
|
-
* @format GUID
|
|
216
|
-
* @readonly
|
|
217
|
-
*/
|
|
158
|
+
/** @format GUID */
|
|
218
159
|
contactId?: string;
|
|
219
160
|
/**
|
|
220
|
-
* Profile image URL of the site member.
|
|
221
161
|
* @readonly
|
|
222
162
|
* @format WEB_URL
|
|
223
163
|
*/
|
|
@@ -234,43 +174,6 @@ interface ExtendedFields {
|
|
|
234
174
|
*/
|
|
235
175
|
namespaces?: Record<string, Record<string, any>>;
|
|
236
176
|
}
|
|
237
|
-
/**
|
|
238
|
-
* Common object for tags.
|
|
239
|
-
* Should be use as in this example:
|
|
240
|
-
* message Foo {
|
|
241
|
-
* option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
|
|
242
|
-
* string id = 1;
|
|
243
|
-
* ...
|
|
244
|
-
* Tags tags = 5
|
|
245
|
-
* }
|
|
246
|
-
*
|
|
247
|
-
* example of taggable entity
|
|
248
|
-
* {
|
|
249
|
-
* id: "123"
|
|
250
|
-
* tags: {
|
|
251
|
-
* public_tags: {
|
|
252
|
-
* tag_ids:["11","22"]
|
|
253
|
-
* },
|
|
254
|
-
* private_tags: {
|
|
255
|
-
* tag_ids: ["33", "44"]
|
|
256
|
-
* }
|
|
257
|
-
* }
|
|
258
|
-
* }
|
|
259
|
-
*/
|
|
260
|
-
interface Tags {
|
|
261
|
-
/** Tags that require an additional permission in order to access them, typically restricted from site members and visitors. */
|
|
262
|
-
privateTags?: TagList;
|
|
263
|
-
/** Tags that are exposed to anyone with access to the entity, including site members and visitors. */
|
|
264
|
-
publicTags?: TagList;
|
|
265
|
-
}
|
|
266
|
-
interface TagList {
|
|
267
|
-
/**
|
|
268
|
-
* List of tag IDs.
|
|
269
|
-
* @maxSize 100
|
|
270
|
-
* @maxLength 5
|
|
271
|
-
*/
|
|
272
|
-
tagIds?: string[];
|
|
273
|
-
}
|
|
274
177
|
interface ParticipantAdded {
|
|
275
178
|
/**
|
|
276
179
|
* Program ID which participant was added
|
|
@@ -283,50 +186,29 @@ interface ParticipantAdded {
|
|
|
283
186
|
*/
|
|
284
187
|
memberId?: string;
|
|
285
188
|
}
|
|
286
|
-
|
|
287
|
-
interface TagsModified {
|
|
288
|
-
/** The Participant with updated tags */
|
|
289
|
-
participant?: Participant;
|
|
290
|
-
/** Tags that were assigned */
|
|
291
|
-
assignedTags?: Tags;
|
|
292
|
-
/** Tags that were unassigned */
|
|
293
|
-
unassignedTags?: Tags;
|
|
294
|
-
}
|
|
295
|
-
interface CreateParticipantRequest {
|
|
296
|
-
/** Participant to create */
|
|
297
|
-
participant: Participant;
|
|
298
|
-
}
|
|
299
|
-
interface CreateParticipantResponse {
|
|
300
|
-
/** Created participant */
|
|
301
|
-
participant?: Participant;
|
|
302
|
-
}
|
|
303
|
-
interface BulkCreateParticipantRequest {
|
|
189
|
+
interface BulkInviteToProgramRequest {
|
|
304
190
|
/**
|
|
305
|
-
*
|
|
306
|
-
* @
|
|
307
|
-
* @maxSize 100
|
|
191
|
+
* Program to which bulk invite participants.
|
|
192
|
+
* @format GUID
|
|
308
193
|
*/
|
|
309
|
-
|
|
310
|
-
/** Whether to return entities in response or not. */
|
|
311
|
-
returnEntity?: boolean;
|
|
312
|
-
}
|
|
313
|
-
interface BulkCreateParticipantResponse {
|
|
194
|
+
programId: string;
|
|
314
195
|
/**
|
|
315
|
-
*
|
|
196
|
+
* Return added participants in the response or not.
|
|
197
|
+
* @format GUID
|
|
316
198
|
* @minSize 1
|
|
317
199
|
* @maxSize 100
|
|
318
200
|
*/
|
|
319
|
-
|
|
320
|
-
/**
|
|
321
|
-
|
|
201
|
+
memberIds?: string[];
|
|
202
|
+
/** Return invited participants in the response or not. */
|
|
203
|
+
returnEntity?: boolean;
|
|
322
204
|
}
|
|
323
|
-
interface
|
|
324
|
-
/**
|
|
325
|
-
|
|
326
|
-
/**
|
|
327
|
-
|
|
205
|
+
interface BulkInviteToProgramResponse {
|
|
206
|
+
/** Participants created by bulk action */
|
|
207
|
+
results?: BulkInviteToProgramResult[];
|
|
208
|
+
/** Bulk action metadata. */
|
|
209
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
328
210
|
}
|
|
329
|
-
interface
|
|
211
|
+
interface ItemMetadata {
|
|
330
212
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
331
213
|
id?: string | null;
|
|
332
214
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -344,7 +226,13 @@ interface ApplicationError {
|
|
|
344
226
|
/** Data related to the error. */
|
|
345
227
|
data?: Record<string, any> | null;
|
|
346
228
|
}
|
|
347
|
-
interface
|
|
229
|
+
interface BulkInviteToProgramResult {
|
|
230
|
+
/** Invited participant metadata. */
|
|
231
|
+
itemMetadata?: ItemMetadata;
|
|
232
|
+
/** Invited participant */
|
|
233
|
+
item?: Participant;
|
|
234
|
+
}
|
|
235
|
+
interface BulkActionMetadata {
|
|
348
236
|
/** Number of items that were successfully processed. */
|
|
349
237
|
totalSuccesses?: number;
|
|
350
238
|
/** Number of items that couldn't be processed. */
|
|
@@ -352,921 +240,195 @@ interface CommonBulkActionMetadata {
|
|
|
352
240
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
353
241
|
undetailedFailures?: number;
|
|
354
242
|
}
|
|
355
|
-
interface
|
|
243
|
+
interface ParticipantInvited {
|
|
356
244
|
/**
|
|
357
|
-
* Program to which bulk
|
|
245
|
+
* Program to which bulk invite participants.
|
|
358
246
|
* @format GUID
|
|
359
247
|
*/
|
|
360
|
-
programId
|
|
248
|
+
programId?: string;
|
|
361
249
|
/**
|
|
362
|
-
*
|
|
250
|
+
* Invited member to program
|
|
363
251
|
* @format GUID
|
|
364
|
-
* @maxSize 100
|
|
365
252
|
*/
|
|
366
|
-
|
|
253
|
+
memberId?: string;
|
|
367
254
|
}
|
|
368
|
-
interface
|
|
255
|
+
interface BulkInviteAllToProgramRequest {
|
|
369
256
|
/**
|
|
370
|
-
*
|
|
257
|
+
* Program to which bulk add participants.
|
|
371
258
|
* @format GUID
|
|
372
259
|
*/
|
|
373
|
-
|
|
374
|
-
}
|
|
375
|
-
interface DeleteParticipantRequest {
|
|
260
|
+
programId: string;
|
|
376
261
|
/**
|
|
377
|
-
*
|
|
262
|
+
* Exclude site members.
|
|
378
263
|
* @format GUID
|
|
264
|
+
* @maxSize 100
|
|
379
265
|
*/
|
|
380
|
-
|
|
266
|
+
excludeMemberIds?: string[];
|
|
381
267
|
}
|
|
382
|
-
interface
|
|
268
|
+
interface BulkInviteAllToProgramResponse {
|
|
269
|
+
/** Bulk action metadata. */
|
|
270
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
383
271
|
}
|
|
384
|
-
interface
|
|
272
|
+
interface BulkAddToProgramRequest {
|
|
385
273
|
/**
|
|
386
|
-
*
|
|
274
|
+
* Program to which bulk add participants.
|
|
387
275
|
* @format GUID
|
|
388
276
|
*/
|
|
389
|
-
|
|
390
|
-
}
|
|
391
|
-
interface IssueCertificateResponse {
|
|
392
|
-
/** Updated participant */
|
|
393
|
-
participant?: Participant;
|
|
394
|
-
}
|
|
395
|
-
interface GetCompletionStatsRequest {
|
|
277
|
+
programId: string;
|
|
396
278
|
/**
|
|
397
|
-
*
|
|
279
|
+
* Site members.
|
|
398
280
|
* @format GUID
|
|
281
|
+
* @minSize 1
|
|
282
|
+
* @maxSize 1000
|
|
399
283
|
*/
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
/** Number of participants that completed the program */
|
|
404
|
-
completedAll?: number;
|
|
405
|
-
/** Percentage of participants that completed the program */
|
|
406
|
-
completionRate?: number;
|
|
284
|
+
memberIds?: string[];
|
|
285
|
+
/** Return added participants in the response or not. */
|
|
286
|
+
returnEntity?: boolean;
|
|
407
287
|
}
|
|
408
|
-
interface
|
|
288
|
+
interface BulkAddToProgramResponse {
|
|
289
|
+
/** Participants created by bulk action */
|
|
290
|
+
results?: BulkAddToProgramResult[];
|
|
291
|
+
/** Bulk action metadata. */
|
|
292
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
409
293
|
}
|
|
410
|
-
interface
|
|
411
|
-
/**
|
|
412
|
-
|
|
413
|
-
/**
|
|
414
|
-
|
|
415
|
-
/** Limit of active participants on a site without premium */
|
|
416
|
-
activeParticipantsLimit?: number;
|
|
294
|
+
interface BulkAddToProgramResult {
|
|
295
|
+
/** Added participant metadata. */
|
|
296
|
+
itemMetadata?: ItemMetadata;
|
|
297
|
+
/** Added participant */
|
|
298
|
+
item?: Participant;
|
|
417
299
|
}
|
|
418
|
-
interface
|
|
300
|
+
interface BulkApproveParticipantRequest {
|
|
301
|
+
/**
|
|
302
|
+
* Participants to add
|
|
303
|
+
* @format GUID
|
|
304
|
+
* @maxSize 100
|
|
305
|
+
*/
|
|
306
|
+
participantIds: string[];
|
|
419
307
|
/**
|
|
420
|
-
*
|
|
308
|
+
* program to approve participant
|
|
421
309
|
* @format GUID
|
|
422
310
|
*/
|
|
423
|
-
|
|
311
|
+
programId?: string;
|
|
312
|
+
/** Return approved participants in the response or not */
|
|
313
|
+
returnEntity?: boolean;
|
|
424
314
|
}
|
|
425
|
-
interface
|
|
426
|
-
/**
|
|
427
|
-
|
|
315
|
+
interface BulkApproveParticipantResponse {
|
|
316
|
+
/** Participants approved by bulk action */
|
|
317
|
+
results?: BulkApproveParticipantResult[];
|
|
318
|
+
/** Bulk action metadata */
|
|
319
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
428
320
|
}
|
|
429
|
-
interface
|
|
430
|
-
/**
|
|
431
|
-
|
|
321
|
+
interface BulkApproveParticipantResult {
|
|
322
|
+
/** Approved participant metadata */
|
|
323
|
+
itemMetadata?: ItemMetadata;
|
|
324
|
+
/** Approved or existing participant */
|
|
325
|
+
item?: Participant;
|
|
432
326
|
}
|
|
433
|
-
interface
|
|
434
|
-
/**
|
|
435
|
-
* Cursor paging options.
|
|
436
|
-
*
|
|
437
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
438
|
-
*/
|
|
439
|
-
cursorPaging?: CursorPaging;
|
|
327
|
+
interface ParticipantApproved {
|
|
440
328
|
/**
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
329
|
+
* Program ID which participant approved
|
|
330
|
+
* @format GUID
|
|
444
331
|
*/
|
|
445
|
-
|
|
332
|
+
programId?: string;
|
|
446
333
|
/**
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
450
|
-
* @maxSize 5
|
|
334
|
+
* Member ID of participant approved
|
|
335
|
+
* @format GUID
|
|
451
336
|
*/
|
|
452
|
-
|
|
337
|
+
memberId?: string;
|
|
453
338
|
}
|
|
454
|
-
|
|
455
|
-
interface CursorQueryPagingMethodOneOf {
|
|
339
|
+
interface BulkApproveAllParticipantRequest {
|
|
456
340
|
/**
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
341
|
+
* Program to approve all participants.
|
|
342
|
+
* @format GUID
|
|
460
343
|
*/
|
|
461
|
-
|
|
462
|
-
}
|
|
463
|
-
interface Sorting {
|
|
344
|
+
programId?: string;
|
|
464
345
|
/**
|
|
465
|
-
*
|
|
466
|
-
* @
|
|
346
|
+
* Exclude site members.
|
|
347
|
+
* @format GUID
|
|
348
|
+
* @maxSize 100
|
|
467
349
|
*/
|
|
468
|
-
|
|
469
|
-
/** Sort order. */
|
|
470
|
-
order?: SortOrderWithLiterals;
|
|
471
|
-
}
|
|
472
|
-
declare enum SortOrder {
|
|
473
|
-
ASC = "ASC",
|
|
474
|
-
DESC = "DESC"
|
|
350
|
+
excludeParticipantIds?: string[];
|
|
475
351
|
}
|
|
476
|
-
|
|
477
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
478
|
-
interface CursorPaging {
|
|
352
|
+
interface BulkApproveAllParticipantResponse {
|
|
479
353
|
/**
|
|
480
|
-
*
|
|
481
|
-
* @
|
|
354
|
+
* Job id with async process
|
|
355
|
+
* @format GUID
|
|
482
356
|
*/
|
|
483
|
-
|
|
357
|
+
jobId?: string;
|
|
358
|
+
}
|
|
359
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
360
|
+
createdEvent?: EntityCreatedEvent;
|
|
361
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
362
|
+
deletedEvent?: EntityDeletedEvent;
|
|
363
|
+
actionEvent?: ActionEvent;
|
|
364
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
365
|
+
id?: string;
|
|
484
366
|
/**
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
488
|
-
* Not relevant for the first request.
|
|
489
|
-
* @maxLength 16000
|
|
367
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
368
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
490
369
|
*/
|
|
491
|
-
|
|
492
|
-
}
|
|
493
|
-
interface QueryParticipantsResponse {
|
|
494
|
-
/** found participants */
|
|
495
|
-
participants?: Participant[];
|
|
496
|
-
/** paging metadata */
|
|
497
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
498
|
-
}
|
|
499
|
-
interface CursorPagingMetadata {
|
|
500
|
-
/** Number of items returned in current page. */
|
|
501
|
-
count?: number | null;
|
|
502
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
503
|
-
cursors?: Cursors;
|
|
370
|
+
entityFqdn?: string;
|
|
504
371
|
/**
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
* + `true`: Another page of results can be retrieved.
|
|
508
|
-
* + `false`: This is the last page.
|
|
372
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
373
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
509
374
|
*/
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
375
|
+
slug?: string;
|
|
376
|
+
/** ID of the entity associated with the event. */
|
|
377
|
+
entityId?: string;
|
|
378
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
379
|
+
eventTime?: Date | null;
|
|
513
380
|
/**
|
|
514
|
-
*
|
|
515
|
-
*
|
|
381
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
382
|
+
* (for example, GDPR).
|
|
516
383
|
*/
|
|
517
|
-
|
|
384
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
385
|
+
/** If present, indicates the action that triggered the event. */
|
|
386
|
+
originatedFrom?: string | null;
|
|
518
387
|
/**
|
|
519
|
-
*
|
|
520
|
-
*
|
|
388
|
+
* 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.
|
|
389
|
+
* 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.
|
|
521
390
|
*/
|
|
522
|
-
|
|
391
|
+
entityEventSequence?: string | null;
|
|
523
392
|
}
|
|
524
|
-
|
|
393
|
+
/** @oneof */
|
|
394
|
+
interface DomainEventBodyOneOf {
|
|
395
|
+
createdEvent?: EntityCreatedEvent;
|
|
396
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
397
|
+
deletedEvent?: EntityDeletedEvent;
|
|
398
|
+
actionEvent?: ActionEvent;
|
|
525
399
|
}
|
|
526
|
-
interface
|
|
527
|
-
|
|
528
|
-
|
|
400
|
+
interface EntityCreatedEvent {
|
|
401
|
+
entityAsJson?: string;
|
|
402
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
403
|
+
restoreInfo?: RestoreInfo;
|
|
529
404
|
}
|
|
530
|
-
interface
|
|
531
|
-
|
|
532
|
-
* Participant IDs to update tags for (1-100 items)
|
|
533
|
-
* @minSize 1
|
|
534
|
-
* @maxSize 100
|
|
535
|
-
* @format GUID
|
|
536
|
-
*/
|
|
537
|
-
participantIds: string[];
|
|
538
|
-
/** Tags to assign to the Participants */
|
|
539
|
-
assignTags?: Tags;
|
|
540
|
-
/** Tags to unassign from the Participants */
|
|
541
|
-
unassignTags?: Tags;
|
|
405
|
+
interface RestoreInfo {
|
|
406
|
+
deletedDate?: Date | null;
|
|
542
407
|
}
|
|
543
|
-
interface
|
|
408
|
+
interface EntityUpdatedEvent {
|
|
544
409
|
/**
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
410
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
411
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
412
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
548
413
|
*/
|
|
549
|
-
|
|
550
|
-
/** Metadata about the bulk operation */
|
|
551
|
-
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
414
|
+
currentEntityAsJson?: string;
|
|
552
415
|
}
|
|
553
|
-
interface
|
|
554
|
-
/**
|
|
555
|
-
|
|
416
|
+
interface EntityDeletedEvent {
|
|
417
|
+
/** Entity that was deleted. */
|
|
418
|
+
deletedEntityAsJson?: string | null;
|
|
556
419
|
}
|
|
557
|
-
interface
|
|
558
|
-
|
|
559
|
-
filter: Record<string, any> | null;
|
|
560
|
-
/** Tags to assign to matching Participants */
|
|
561
|
-
assignTags?: Tags;
|
|
562
|
-
/** Tags to unassign from matching Participants */
|
|
563
|
-
unassignTags?: Tags;
|
|
420
|
+
interface ActionEvent {
|
|
421
|
+
bodyAsJson?: string;
|
|
564
422
|
}
|
|
565
|
-
interface
|
|
423
|
+
interface MessageEnvelope {
|
|
566
424
|
/**
|
|
567
|
-
*
|
|
425
|
+
* App instance ID.
|
|
568
426
|
* @format GUID
|
|
569
427
|
*/
|
|
570
|
-
|
|
571
|
-
}
|
|
572
|
-
interface SearchParticipantsRequest {
|
|
573
|
-
/** Query to search programs */
|
|
574
|
-
search?: CursorSearch;
|
|
575
|
-
}
|
|
576
|
-
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
428
|
+
instanceId?: string | null;
|
|
577
429
|
/**
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
581
|
-
*/
|
|
582
|
-
cursorPaging?: CursorPaging;
|
|
583
|
-
/**
|
|
584
|
-
* Filter object.
|
|
585
|
-
*
|
|
586
|
-
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
587
|
-
*/
|
|
588
|
-
filter?: Record<string, any> | null;
|
|
589
|
-
/**
|
|
590
|
-
* List of sort objects.
|
|
591
|
-
*
|
|
592
|
-
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
593
|
-
* @maxSize 10
|
|
594
|
-
*/
|
|
595
|
-
sort?: Sorting[];
|
|
596
|
-
/**
|
|
597
|
-
* Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
|
|
598
|
-
* @maxSize 10
|
|
599
|
-
*/
|
|
600
|
-
aggregations?: Aggregation[];
|
|
601
|
-
/** Free text to match in searchable fields. */
|
|
602
|
-
search?: SearchDetails;
|
|
603
|
-
/**
|
|
604
|
-
* Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
|
|
605
|
-
* Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
|
|
606
|
-
* @maxLength 50
|
|
607
|
-
*/
|
|
608
|
-
timeZone?: string | null;
|
|
609
|
-
}
|
|
610
|
-
/** @oneof */
|
|
611
|
-
interface CursorSearchPagingMethodOneOf {
|
|
612
|
-
/**
|
|
613
|
-
* Cursor paging options.
|
|
614
|
-
*
|
|
615
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
616
|
-
*/
|
|
617
|
-
cursorPaging?: CursorPaging;
|
|
618
|
-
}
|
|
619
|
-
interface Aggregation extends AggregationKindOneOf {
|
|
620
|
-
/** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
|
|
621
|
-
value?: ValueAggregation;
|
|
622
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
623
|
-
range?: RangeAggregation;
|
|
624
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
625
|
-
scalar?: ScalarAggregation;
|
|
626
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
627
|
-
dateHistogram?: DateHistogramAggregation;
|
|
628
|
-
/** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
|
|
629
|
-
nested?: NestedAggregation;
|
|
630
|
-
/**
|
|
631
|
-
* Aggregation name, returned in `aggregations.results.name`.
|
|
632
|
-
* @maxLength 100
|
|
633
|
-
*/
|
|
634
|
-
name?: string | null;
|
|
635
|
-
/** Type of aggregation to perform. Must align with the corresponding aggregation field. */
|
|
636
|
-
type?: AggregationTypeWithLiterals;
|
|
637
|
-
/**
|
|
638
|
-
* Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
639
|
-
* @maxLength 200
|
|
640
|
-
*/
|
|
641
|
-
fieldPath?: string;
|
|
642
|
-
/**
|
|
643
|
-
* Deprecated. Use `nested` instead.
|
|
644
|
-
* @deprecated Deprecated. Use `nested` instead.
|
|
645
|
-
* @replacedBy kind.nested
|
|
646
|
-
* @targetRemovalDate 2024-03-30
|
|
647
|
-
*/
|
|
648
|
-
groupBy?: GroupByAggregation;
|
|
649
|
-
}
|
|
650
|
-
/** @oneof */
|
|
651
|
-
interface AggregationKindOneOf {
|
|
652
|
-
/** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
|
|
653
|
-
value?: ValueAggregation;
|
|
654
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
655
|
-
range?: RangeAggregation;
|
|
656
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
657
|
-
scalar?: ScalarAggregation;
|
|
658
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
659
|
-
dateHistogram?: DateHistogramAggregation;
|
|
660
|
-
/** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
|
|
661
|
-
nested?: NestedAggregation;
|
|
662
|
-
}
|
|
663
|
-
interface RangeBucket {
|
|
664
|
-
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
665
|
-
from?: number | null;
|
|
666
|
-
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
667
|
-
to?: number | null;
|
|
668
|
-
}
|
|
669
|
-
declare enum SortType {
|
|
670
|
-
/** Number of matches in the results. */
|
|
671
|
-
COUNT = "COUNT",
|
|
672
|
-
/** Alphabetically by the field value. */
|
|
673
|
-
VALUE = "VALUE"
|
|
674
|
-
}
|
|
675
|
-
/** @enumType */
|
|
676
|
-
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
677
|
-
declare enum SortDirection {
|
|
678
|
-
/** Descending order. */
|
|
679
|
-
DESC = "DESC",
|
|
680
|
-
/** Ascending order. */
|
|
681
|
-
ASC = "ASC"
|
|
682
|
-
}
|
|
683
|
-
/** @enumType */
|
|
684
|
-
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
685
|
-
declare enum MissingValues {
|
|
686
|
-
/** Exclude missing values from the aggregation results. */
|
|
687
|
-
EXCLUDE = "EXCLUDE",
|
|
688
|
-
/** Include missing values in the aggregation results. */
|
|
689
|
-
INCLUDE = "INCLUDE"
|
|
690
|
-
}
|
|
691
|
-
/** @enumType */
|
|
692
|
-
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
693
|
-
interface IncludeMissingValuesOptions {
|
|
694
|
-
/**
|
|
695
|
-
* Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
|
|
696
|
-
* @maxLength 20
|
|
697
|
-
*/
|
|
698
|
-
addToBucket?: string;
|
|
699
|
-
}
|
|
700
|
-
declare enum ScalarType {
|
|
701
|
-
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
702
|
-
/** Total number of distinct values. */
|
|
703
|
-
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
704
|
-
/** Minimum value. */
|
|
705
|
-
MIN = "MIN",
|
|
706
|
-
/** Maximum value. */
|
|
707
|
-
MAX = "MAX"
|
|
708
|
-
}
|
|
709
|
-
/** @enumType */
|
|
710
|
-
type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
711
|
-
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
712
|
-
/** Options for including missing values in results. */
|
|
713
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
714
|
-
/** Sort type. */
|
|
715
|
-
sortType?: SortTypeWithLiterals;
|
|
716
|
-
/** Sort direction. */
|
|
717
|
-
sortDirection?: SortDirectionWithLiterals;
|
|
718
|
-
/**
|
|
719
|
-
* Number of aggregation results to return.
|
|
720
|
-
* Min: `1`
|
|
721
|
-
* Max: `250`
|
|
722
|
-
* Default: `10`
|
|
723
|
-
*/
|
|
724
|
-
limit?: number | null;
|
|
725
|
-
/**
|
|
726
|
-
* Whether to include or exclude missing values in the aggregation results.
|
|
727
|
-
* Default: `EXCLUDE`.
|
|
728
|
-
*/
|
|
729
|
-
missingValues?: MissingValuesWithLiterals;
|
|
730
|
-
}
|
|
731
|
-
/** @oneof */
|
|
732
|
-
interface ValueAggregationOptionsOneOf {
|
|
733
|
-
/** Options for including missing values in results. */
|
|
734
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
735
|
-
}
|
|
736
|
-
declare enum NestedAggregationType {
|
|
737
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
738
|
-
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
739
|
-
VALUE = "VALUE",
|
|
740
|
-
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
741
|
-
RANGE = "RANGE",
|
|
742
|
-
/** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
743
|
-
SCALAR = "SCALAR",
|
|
744
|
-
/** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
|
|
745
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
746
|
-
}
|
|
747
|
-
/** @enumType */
|
|
748
|
-
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
749
|
-
interface RangeAggregation {
|
|
750
|
-
/**
|
|
751
|
-
* List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
|
|
752
|
-
* @maxSize 50
|
|
753
|
-
*/
|
|
754
|
-
buckets?: RangeBucket[];
|
|
755
|
-
}
|
|
756
|
-
interface ScalarAggregation {
|
|
757
|
-
/** Operator type for the scalar aggregation. */
|
|
758
|
-
type?: ScalarTypeWithLiterals;
|
|
759
|
-
}
|
|
760
|
-
interface DateHistogramAggregation {
|
|
761
|
-
/** Interval for date histogram aggregation. */
|
|
762
|
-
interval?: IntervalWithLiterals;
|
|
763
|
-
}
|
|
764
|
-
declare enum Interval {
|
|
765
|
-
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
766
|
-
YEAR = "YEAR",
|
|
767
|
-
MONTH = "MONTH",
|
|
768
|
-
WEEK = "WEEK",
|
|
769
|
-
DAY = "DAY",
|
|
770
|
-
HOUR = "HOUR",
|
|
771
|
-
MINUTE = "MINUTE",
|
|
772
|
-
SECOND = "SECOND"
|
|
773
|
-
}
|
|
774
|
-
/** @enumType */
|
|
775
|
-
type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
776
|
-
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
777
|
-
/** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
|
|
778
|
-
value?: ValueAggregation;
|
|
779
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
780
|
-
range?: RangeAggregation;
|
|
781
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
782
|
-
scalar?: ScalarAggregation;
|
|
783
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
784
|
-
dateHistogram?: DateHistogramAggregation;
|
|
785
|
-
/**
|
|
786
|
-
* Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
787
|
-
* @maxLength 100
|
|
788
|
-
*/
|
|
789
|
-
name?: string | null;
|
|
790
|
-
/** Type of aggregation to perform. The matching aggregation field must be passed. */
|
|
791
|
-
type?: NestedAggregationTypeWithLiterals;
|
|
792
|
-
/**
|
|
793
|
-
* Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
794
|
-
* @maxLength 200
|
|
795
|
-
*/
|
|
796
|
-
fieldPath?: string;
|
|
797
|
-
}
|
|
798
|
-
/** @oneof */
|
|
799
|
-
interface NestedAggregationItemKindOneOf {
|
|
800
|
-
/** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
|
|
801
|
-
value?: ValueAggregation;
|
|
802
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
803
|
-
range?: RangeAggregation;
|
|
804
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
805
|
-
scalar?: ScalarAggregation;
|
|
806
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
807
|
-
dateHistogram?: DateHistogramAggregation;
|
|
808
|
-
}
|
|
809
|
-
declare enum AggregationType {
|
|
810
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
811
|
-
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
812
|
-
VALUE = "VALUE",
|
|
813
|
-
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
814
|
-
RANGE = "RANGE",
|
|
815
|
-
/** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
816
|
-
SCALAR = "SCALAR",
|
|
817
|
-
/** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
|
|
818
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
819
|
-
/** Flattened list of aggregations, where each aggregation is nested within previous one. */
|
|
820
|
-
NESTED = "NESTED"
|
|
821
|
-
}
|
|
822
|
-
/** @enumType */
|
|
823
|
-
type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
824
|
-
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
825
|
-
interface NestedAggregation {
|
|
826
|
-
/**
|
|
827
|
-
* Flattened list of aggregations, where each aggregation is nested within previous one.
|
|
828
|
-
* @minSize 2
|
|
829
|
-
* @maxSize 3
|
|
830
|
-
*/
|
|
831
|
-
nestedAggregations?: NestedAggregationItem[];
|
|
832
|
-
}
|
|
833
|
-
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
834
|
-
/** Value aggregation configuration. */
|
|
835
|
-
value?: ValueAggregation;
|
|
836
|
-
/**
|
|
837
|
-
* Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
838
|
-
* @maxLength 100
|
|
839
|
-
*/
|
|
840
|
-
name?: string | null;
|
|
841
|
-
/**
|
|
842
|
-
* Field to aggregate by.
|
|
843
|
-
* @maxLength 200
|
|
844
|
-
*/
|
|
845
|
-
fieldPath?: string;
|
|
846
|
-
}
|
|
847
|
-
/** @oneof */
|
|
848
|
-
interface GroupByAggregationKindOneOf {
|
|
849
|
-
/** Value aggregation configuration. */
|
|
850
|
-
value?: ValueAggregation;
|
|
851
|
-
}
|
|
852
|
-
interface SearchDetails {
|
|
853
|
-
/** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
|
|
854
|
-
mode?: ModeWithLiterals;
|
|
855
|
-
/**
|
|
856
|
-
* Search term or expression.
|
|
857
|
-
* @maxLength 100
|
|
858
|
-
*/
|
|
859
|
-
expression?: string | null;
|
|
860
|
-
/**
|
|
861
|
-
* Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
862
|
-
* @maxLength 200
|
|
863
|
-
* @maxSize 20
|
|
864
|
-
*/
|
|
865
|
-
fields?: string[];
|
|
866
|
-
/** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
|
|
867
|
-
fuzzy?: boolean;
|
|
868
|
-
}
|
|
869
|
-
declare enum Mode {
|
|
870
|
-
/** At least one of the search terms must be present. */
|
|
871
|
-
OR = "OR",
|
|
872
|
-
/** All search terms must be present. */
|
|
873
|
-
AND = "AND"
|
|
874
|
-
}
|
|
875
|
-
/** @enumType */
|
|
876
|
-
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
877
|
-
interface SearchParticipantsResponse {
|
|
878
|
-
/** Participants matching the search criteria. */
|
|
879
|
-
participants?: Participant[];
|
|
880
|
-
/** Paging metadata. */
|
|
881
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
882
|
-
/** Aggregation data in case aggregations were requested. */
|
|
883
|
-
aggregationData?: AggregationData;
|
|
884
|
-
}
|
|
885
|
-
interface AggregationData {
|
|
886
|
-
/**
|
|
887
|
-
* key = aggregation name (as derived from search request).
|
|
888
|
-
* @maxSize 10000
|
|
889
|
-
*/
|
|
890
|
-
results?: AggregationResults[];
|
|
891
|
-
}
|
|
892
|
-
interface ValueAggregationResult {
|
|
893
|
-
/**
|
|
894
|
-
* Value of the field.
|
|
895
|
-
* @maxLength 100
|
|
896
|
-
*/
|
|
897
|
-
value?: string;
|
|
898
|
-
/** Count of entities with this value. */
|
|
899
|
-
count?: number;
|
|
900
|
-
}
|
|
901
|
-
interface RangeAggregationResult {
|
|
902
|
-
/** Inclusive lower bound of the range. */
|
|
903
|
-
from?: number | null;
|
|
904
|
-
/** Exclusive upper bound of the range. */
|
|
905
|
-
to?: number | null;
|
|
906
|
-
/** Count of entities in this range. */
|
|
907
|
-
count?: number;
|
|
908
|
-
}
|
|
909
|
-
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
910
|
-
/** Value aggregation results. */
|
|
911
|
-
values?: ValueResults;
|
|
912
|
-
/** Range aggregation results. */
|
|
913
|
-
ranges?: RangeResults;
|
|
914
|
-
/** Scalar aggregation results. */
|
|
915
|
-
scalar?: AggregationResultsScalarResult;
|
|
916
|
-
/**
|
|
917
|
-
* User-defined name of aggregation, matches the one provided in request.
|
|
918
|
-
* @maxLength 100
|
|
919
|
-
*/
|
|
920
|
-
name?: string;
|
|
921
|
-
/** Type of aggregation that matches result. */
|
|
922
|
-
type?: AggregationTypeWithLiterals;
|
|
923
|
-
/**
|
|
924
|
-
* Field to aggregate by, matches the one provided in request.
|
|
925
|
-
* @maxLength 200
|
|
926
|
-
*/
|
|
927
|
-
fieldPath?: string;
|
|
928
|
-
}
|
|
929
|
-
/** @oneof */
|
|
930
|
-
interface NestedAggregationResultsResultOneOf {
|
|
931
|
-
/** Value aggregation results. */
|
|
932
|
-
values?: ValueResults;
|
|
933
|
-
/** Range aggregation results. */
|
|
934
|
-
ranges?: RangeResults;
|
|
935
|
-
/** Scalar aggregation results. */
|
|
936
|
-
scalar?: AggregationResultsScalarResult;
|
|
937
|
-
}
|
|
938
|
-
interface ValueResults {
|
|
939
|
-
/**
|
|
940
|
-
* List of value aggregations.
|
|
941
|
-
* @maxSize 250
|
|
942
|
-
*/
|
|
943
|
-
results?: ValueAggregationResult[];
|
|
944
|
-
}
|
|
945
|
-
interface RangeResults {
|
|
946
|
-
/**
|
|
947
|
-
* List of ranges returned in same order as requested.
|
|
948
|
-
* @maxSize 50
|
|
949
|
-
*/
|
|
950
|
-
results?: RangeAggregationResult[];
|
|
951
|
-
}
|
|
952
|
-
interface AggregationResultsScalarResult {
|
|
953
|
-
/** Type of scalar aggregation. */
|
|
954
|
-
type?: ScalarTypeWithLiterals;
|
|
955
|
-
/** Value of the scalar aggregation. */
|
|
956
|
-
value?: number;
|
|
957
|
-
}
|
|
958
|
-
interface NestedValueAggregationResult {
|
|
959
|
-
/**
|
|
960
|
-
* Value of the field.
|
|
961
|
-
* @maxLength 1000
|
|
962
|
-
*/
|
|
963
|
-
value?: string;
|
|
964
|
-
/** Nested aggregations. */
|
|
965
|
-
nestedResults?: NestedAggregationResults;
|
|
966
|
-
}
|
|
967
|
-
interface ValueResult {
|
|
968
|
-
/**
|
|
969
|
-
* Value of the field.
|
|
970
|
-
* @maxLength 1000
|
|
971
|
-
*/
|
|
972
|
-
value?: string;
|
|
973
|
-
/** Count of entities with this value. */
|
|
974
|
-
count?: number | null;
|
|
975
|
-
}
|
|
976
|
-
interface RangeResult {
|
|
977
|
-
/** Inclusive lower bound of the range. */
|
|
978
|
-
from?: number | null;
|
|
979
|
-
/** Exclusive upper bound of the range. */
|
|
980
|
-
to?: number | null;
|
|
981
|
-
/** Count of entities in this range. */
|
|
982
|
-
count?: number | null;
|
|
983
|
-
}
|
|
984
|
-
interface ScalarResult {
|
|
985
|
-
/** Value of the scalar aggregation. */
|
|
986
|
-
value?: number;
|
|
987
|
-
}
|
|
988
|
-
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
989
|
-
/** Value aggregation result. */
|
|
990
|
-
value?: ValueResult;
|
|
991
|
-
/** Range aggregation result. */
|
|
992
|
-
range?: RangeResult;
|
|
993
|
-
/** Scalar aggregation result. */
|
|
994
|
-
scalar?: ScalarResult;
|
|
995
|
-
/** Date histogram aggregation result. */
|
|
996
|
-
dateHistogram?: ValueResult;
|
|
997
|
-
}
|
|
998
|
-
/** @oneof */
|
|
999
|
-
interface NestedResultValueResultOneOf {
|
|
1000
|
-
/** Value aggregation result. */
|
|
1001
|
-
value?: ValueResult;
|
|
1002
|
-
/** Range aggregation result. */
|
|
1003
|
-
range?: RangeResult;
|
|
1004
|
-
/** Scalar aggregation result. */
|
|
1005
|
-
scalar?: ScalarResult;
|
|
1006
|
-
/** Date histogram aggregation result. */
|
|
1007
|
-
dateHistogram?: ValueResult;
|
|
1008
|
-
}
|
|
1009
|
-
interface Results {
|
|
1010
|
-
/** List of nested aggregations. */
|
|
1011
|
-
results?: Record<string, NestedResultValue>;
|
|
1012
|
-
}
|
|
1013
|
-
interface DateHistogramResult {
|
|
1014
|
-
/**
|
|
1015
|
-
* Date in ISO 8601 format.
|
|
1016
|
-
* @maxLength 100
|
|
1017
|
-
*/
|
|
1018
|
-
value?: string;
|
|
1019
|
-
/** Count of documents in the bucket. */
|
|
1020
|
-
count?: number;
|
|
1021
|
-
}
|
|
1022
|
-
interface GroupByValueResults {
|
|
1023
|
-
/**
|
|
1024
|
-
* List of value aggregations.
|
|
1025
|
-
* @maxSize 1000
|
|
1026
|
-
*/
|
|
1027
|
-
results?: NestedValueAggregationResult[];
|
|
1028
|
-
}
|
|
1029
|
-
interface DateHistogramResults {
|
|
1030
|
-
/**
|
|
1031
|
-
* List of date histogram aggregations.
|
|
1032
|
-
* @maxSize 200
|
|
1033
|
-
*/
|
|
1034
|
-
results?: DateHistogramResult[];
|
|
1035
|
-
}
|
|
1036
|
-
/**
|
|
1037
|
-
* Results of `NESTED` aggregation type in a flattened form.
|
|
1038
|
-
* Aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1039
|
-
*/
|
|
1040
|
-
interface NestedResults {
|
|
1041
|
-
/**
|
|
1042
|
-
* List of nested aggregations.
|
|
1043
|
-
* @maxSize 1000
|
|
1044
|
-
*/
|
|
1045
|
-
results?: Results[];
|
|
1046
|
-
}
|
|
1047
|
-
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1048
|
-
/** Value aggregation results. */
|
|
1049
|
-
values?: ValueResults;
|
|
1050
|
-
/** Range aggregation results. */
|
|
1051
|
-
ranges?: RangeResults;
|
|
1052
|
-
/** Scalar aggregation results. */
|
|
1053
|
-
scalar?: AggregationResultsScalarResult;
|
|
1054
|
-
/** Group by value aggregation results. */
|
|
1055
|
-
groupedByValue?: GroupByValueResults;
|
|
1056
|
-
/** Date histogram aggregation results. */
|
|
1057
|
-
dateHistogram?: DateHistogramResults;
|
|
1058
|
-
/** Nested aggregation results. */
|
|
1059
|
-
nested?: NestedResults;
|
|
1060
|
-
/**
|
|
1061
|
-
* User-defined name of aggregation as derived from search request.
|
|
1062
|
-
* @maxLength 100
|
|
1063
|
-
*/
|
|
1064
|
-
name?: string;
|
|
1065
|
-
/** Type of aggregation that must match provided kind as derived from search request. */
|
|
1066
|
-
type?: AggregationTypeWithLiterals;
|
|
1067
|
-
/**
|
|
1068
|
-
* Field to aggregate by as derived from search request.
|
|
1069
|
-
* @maxLength 200
|
|
1070
|
-
*/
|
|
1071
|
-
fieldPath?: string;
|
|
1072
|
-
}
|
|
1073
|
-
/** @oneof */
|
|
1074
|
-
interface AggregationResultsResultOneOf {
|
|
1075
|
-
/** Value aggregation results. */
|
|
1076
|
-
values?: ValueResults;
|
|
1077
|
-
/** Range aggregation results. */
|
|
1078
|
-
ranges?: RangeResults;
|
|
1079
|
-
/** Scalar aggregation results. */
|
|
1080
|
-
scalar?: AggregationResultsScalarResult;
|
|
1081
|
-
/** Group by value aggregation results. */
|
|
1082
|
-
groupedByValue?: GroupByValueResults;
|
|
1083
|
-
/** Date histogram aggregation results. */
|
|
1084
|
-
dateHistogram?: DateHistogramResults;
|
|
1085
|
-
/** Nested aggregation results. */
|
|
1086
|
-
nested?: NestedResults;
|
|
1087
|
-
}
|
|
1088
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1089
|
-
createdEvent?: EntityCreatedEvent;
|
|
1090
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1091
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1092
|
-
actionEvent?: ActionEvent;
|
|
1093
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1094
|
-
id?: string;
|
|
1095
|
-
/**
|
|
1096
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1097
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1098
|
-
*/
|
|
1099
|
-
entityFqdn?: string;
|
|
1100
|
-
/**
|
|
1101
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1102
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1103
|
-
*/
|
|
1104
|
-
slug?: string;
|
|
1105
|
-
/** ID of the entity associated with the event. */
|
|
1106
|
-
entityId?: string;
|
|
1107
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1108
|
-
eventTime?: Date | null;
|
|
1109
|
-
/**
|
|
1110
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1111
|
-
* (for example, GDPR).
|
|
1112
|
-
*/
|
|
1113
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1114
|
-
/** If present, indicates the action that triggered the event. */
|
|
1115
|
-
originatedFrom?: string | null;
|
|
1116
|
-
/**
|
|
1117
|
-
* 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.
|
|
1118
|
-
* 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.
|
|
1119
|
-
*/
|
|
1120
|
-
entityEventSequence?: string | null;
|
|
1121
|
-
}
|
|
1122
|
-
/** @oneof */
|
|
1123
|
-
interface DomainEventBodyOneOf {
|
|
1124
|
-
createdEvent?: EntityCreatedEvent;
|
|
1125
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1126
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1127
|
-
actionEvent?: ActionEvent;
|
|
1128
|
-
}
|
|
1129
|
-
interface EntityCreatedEvent {
|
|
1130
|
-
entityAsJson?: string;
|
|
1131
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1132
|
-
restoreInfo?: RestoreInfo;
|
|
1133
|
-
}
|
|
1134
|
-
interface RestoreInfo {
|
|
1135
|
-
deletedDate?: Date | null;
|
|
1136
|
-
}
|
|
1137
|
-
interface EntityUpdatedEvent {
|
|
1138
|
-
/**
|
|
1139
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1140
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1141
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1142
|
-
*/
|
|
1143
|
-
currentEntityAsJson?: string;
|
|
1144
|
-
}
|
|
1145
|
-
interface EntityDeletedEvent {
|
|
1146
|
-
/** Entity that was deleted. */
|
|
1147
|
-
deletedEntityAsJson?: string | null;
|
|
1148
|
-
}
|
|
1149
|
-
interface ActionEvent {
|
|
1150
|
-
bodyAsJson?: string;
|
|
1151
|
-
}
|
|
1152
|
-
interface Empty {
|
|
1153
|
-
}
|
|
1154
|
-
interface BenefitNotification {
|
|
1155
|
-
/**
|
|
1156
|
-
* Plan unique ID
|
|
1157
|
-
* @format GUID
|
|
1158
|
-
*/
|
|
1159
|
-
planId?: string;
|
|
1160
|
-
/**
|
|
1161
|
-
* App def ID
|
|
1162
|
-
* @format GUID
|
|
1163
|
-
*/
|
|
1164
|
-
appDefId?: string;
|
|
1165
|
-
/** Current benefit details */
|
|
1166
|
-
benefit?: Benefit;
|
|
1167
|
-
/** Previous benefit */
|
|
1168
|
-
prevBenefit?: Benefit;
|
|
1169
|
-
/** Notification event */
|
|
1170
|
-
event?: EventWithLiterals;
|
|
1171
|
-
}
|
|
1172
|
-
interface Benefit {
|
|
1173
|
-
/**
|
|
1174
|
-
* Benefit unique ID
|
|
1175
|
-
* @format GUID
|
|
1176
|
-
* @readonly
|
|
1177
|
-
*/
|
|
1178
|
-
id?: string | null;
|
|
1179
|
-
/** Benefit Type */
|
|
1180
|
-
benefitType?: BenefitTypeWithLiterals;
|
|
1181
|
-
/**
|
|
1182
|
-
* Resource IDs that serves by this benefit
|
|
1183
|
-
* @format GUID
|
|
1184
|
-
*/
|
|
1185
|
-
resourceIds?: string[];
|
|
1186
|
-
/** Amount of credits that provided by this benefit */
|
|
1187
|
-
creditAmount?: number | null;
|
|
1188
|
-
/**
|
|
1189
|
-
* additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
|
|
1190
|
-
* @maxSize 20
|
|
1191
|
-
*/
|
|
1192
|
-
customFields?: Record<string, string>;
|
|
1193
|
-
/** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
|
|
1194
|
-
editable?: boolean | null;
|
|
1195
|
-
/** Benefit behavior */
|
|
1196
|
-
behavior?: Behavior;
|
|
1197
|
-
/**
|
|
1198
|
-
* Id of the app associated with this benefit
|
|
1199
|
-
* @format GUID
|
|
1200
|
-
* @readonly
|
|
1201
|
-
*/
|
|
1202
|
-
appDefId?: string | null;
|
|
1203
|
-
}
|
|
1204
|
-
interface EntryPass {
|
|
1205
|
-
}
|
|
1206
|
-
interface Discount extends DiscountDiscountOneOf {
|
|
1207
|
-
/**
|
|
1208
|
-
* Fixed-rate percent off discount
|
|
1209
|
-
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
1210
|
-
*/
|
|
1211
|
-
percentOffRate?: string;
|
|
1212
|
-
/**
|
|
1213
|
-
* Absolute amount discount
|
|
1214
|
-
* @decimalValue options { gt:0, maxScale:2 }
|
|
1215
|
-
*/
|
|
1216
|
-
moneyOffAmount?: string;
|
|
1217
|
-
}
|
|
1218
|
-
/** @oneof */
|
|
1219
|
-
interface DiscountDiscountOneOf {
|
|
1220
|
-
/**
|
|
1221
|
-
* Fixed-rate percent off discount
|
|
1222
|
-
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
1223
|
-
*/
|
|
1224
|
-
percentOffRate?: string;
|
|
1225
|
-
/**
|
|
1226
|
-
* Absolute amount discount
|
|
1227
|
-
* @decimalValue options { gt:0, maxScale:2 }
|
|
1228
|
-
*/
|
|
1229
|
-
moneyOffAmount?: string;
|
|
1230
|
-
}
|
|
1231
|
-
declare enum BenefitType {
|
|
1232
|
-
/** Should never be used */
|
|
1233
|
-
UNDEFINED = "UNDEFINED",
|
|
1234
|
-
/** Limited benefit type */
|
|
1235
|
-
LIMITED = "LIMITED",
|
|
1236
|
-
/** Unlimited benefit type */
|
|
1237
|
-
UNLIMITED = "UNLIMITED"
|
|
1238
|
-
}
|
|
1239
|
-
/** @enumType */
|
|
1240
|
-
type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
|
|
1241
|
-
interface Behavior extends BehaviorBehaviorOneOf {
|
|
1242
|
-
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
1243
|
-
defaultBehavior?: EntryPass;
|
|
1244
|
-
/** Discount applied to paid resources */
|
|
1245
|
-
discount?: Discount;
|
|
1246
|
-
}
|
|
1247
|
-
/** @oneof */
|
|
1248
|
-
interface BehaviorBehaviorOneOf {
|
|
1249
|
-
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
1250
|
-
defaultBehavior?: EntryPass;
|
|
1251
|
-
/** Discount applied to paid resources */
|
|
1252
|
-
discount?: Discount;
|
|
1253
|
-
}
|
|
1254
|
-
declare enum Event {
|
|
1255
|
-
Updated = "Updated",
|
|
1256
|
-
Deleted = "Deleted",
|
|
1257
|
-
Created = "Created"
|
|
1258
|
-
}
|
|
1259
|
-
/** @enumType */
|
|
1260
|
-
type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
|
|
1261
|
-
interface MessageEnvelope {
|
|
1262
|
-
/**
|
|
1263
|
-
* App instance ID.
|
|
1264
|
-
* @format GUID
|
|
1265
|
-
*/
|
|
1266
|
-
instanceId?: string | null;
|
|
1267
|
-
/**
|
|
1268
|
-
* Event type.
|
|
1269
|
-
* @maxLength 150
|
|
430
|
+
* Event type.
|
|
431
|
+
* @maxLength 150
|
|
1270
432
|
*/
|
|
1271
433
|
eventType?: string;
|
|
1272
434
|
/** The identification type and identity data. */
|
|
@@ -1330,234 +492,6 @@ declare enum WebhookIdentityType {
|
|
|
1330
492
|
}
|
|
1331
493
|
/** @enumType */
|
|
1332
494
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1333
|
-
declare enum State {
|
|
1334
|
-
/** Unknown state */
|
|
1335
|
-
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
1336
|
-
/** Member joined the program and became participant */
|
|
1337
|
-
JOINED = "JOINED",
|
|
1338
|
-
/** Participant completed the program, and could join again */
|
|
1339
|
-
COMPLETED = "COMPLETED",
|
|
1340
|
-
/** Participant failed to complete the program, and could join again */
|
|
1341
|
-
FAILED = "FAILED",
|
|
1342
|
-
/** Participant with ended pricing plan (PP), will be joined as renew PP */
|
|
1343
|
-
SUSPENDED = "SUSPENDED",
|
|
1344
|
-
/** Participant removed automatically after some program condition */
|
|
1345
|
-
AUTO_REMOVED = "AUTO_REMOVED",
|
|
1346
|
-
/** Participant removed by site owner */
|
|
1347
|
-
REMOVED = "REMOVED",
|
|
1348
|
-
/** Participant left the program by himself */
|
|
1349
|
-
LEFT = "LEFT"
|
|
1350
|
-
}
|
|
1351
|
-
/** @enumType */
|
|
1352
|
-
type StateWithLiterals = State | 'UNKNOWN_STATE' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
|
|
1353
|
-
interface BulkInviteToProgramRequest {
|
|
1354
|
-
/**
|
|
1355
|
-
* Program to which bulk invite participants.
|
|
1356
|
-
* @format GUID
|
|
1357
|
-
*/
|
|
1358
|
-
programId: string;
|
|
1359
|
-
/**
|
|
1360
|
-
* Return added participants in the response or not.
|
|
1361
|
-
* @format GUID
|
|
1362
|
-
* @minSize 1
|
|
1363
|
-
* @maxSize 100
|
|
1364
|
-
*/
|
|
1365
|
-
memberIds?: string[];
|
|
1366
|
-
/** Return invited participants in the response or not. */
|
|
1367
|
-
returnEntity?: boolean;
|
|
1368
|
-
}
|
|
1369
|
-
interface BulkInviteToProgramResponse {
|
|
1370
|
-
/** Participants created by bulk action */
|
|
1371
|
-
results?: BulkInviteToProgramResult[];
|
|
1372
|
-
/** Bulk action metadata. */
|
|
1373
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1374
|
-
}
|
|
1375
|
-
interface ItemMetadata {
|
|
1376
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1377
|
-
id?: string | null;
|
|
1378
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1379
|
-
originalIndex?: number;
|
|
1380
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1381
|
-
success?: boolean;
|
|
1382
|
-
/** Details about the error in case of failure. */
|
|
1383
|
-
error?: ApplicationError;
|
|
1384
|
-
}
|
|
1385
|
-
interface BulkInviteToProgramResult {
|
|
1386
|
-
/** Invited participant metadata. */
|
|
1387
|
-
itemMetadata?: ItemMetadata;
|
|
1388
|
-
/** Invited participant */
|
|
1389
|
-
item?: Participant;
|
|
1390
|
-
}
|
|
1391
|
-
interface BulkActionMetadata {
|
|
1392
|
-
/** Number of items that were successfully processed. */
|
|
1393
|
-
totalSuccesses?: number;
|
|
1394
|
-
/** Number of items that couldn't be processed. */
|
|
1395
|
-
totalFailures?: number;
|
|
1396
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1397
|
-
undetailedFailures?: number;
|
|
1398
|
-
}
|
|
1399
|
-
interface ParticipantInvited {
|
|
1400
|
-
/**
|
|
1401
|
-
* Program to which bulk invite participants.
|
|
1402
|
-
* @format GUID
|
|
1403
|
-
*/
|
|
1404
|
-
programId?: string;
|
|
1405
|
-
/**
|
|
1406
|
-
* Invited member to program
|
|
1407
|
-
* @format GUID
|
|
1408
|
-
*/
|
|
1409
|
-
memberId?: string;
|
|
1410
|
-
}
|
|
1411
|
-
interface BulkInviteAllToProgramRequest {
|
|
1412
|
-
/**
|
|
1413
|
-
* Program to which bulk add participants.
|
|
1414
|
-
* @format GUID
|
|
1415
|
-
*/
|
|
1416
|
-
programId: string;
|
|
1417
|
-
/**
|
|
1418
|
-
* Exclude site members.
|
|
1419
|
-
* @format GUID
|
|
1420
|
-
* @maxSize 100
|
|
1421
|
-
*/
|
|
1422
|
-
excludeMemberIds?: string[];
|
|
1423
|
-
}
|
|
1424
|
-
interface BulkInviteAllToProgramResponse {
|
|
1425
|
-
/** Bulk action metadata. */
|
|
1426
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1427
|
-
}
|
|
1428
|
-
interface BulkAddToProgramRequest {
|
|
1429
|
-
/**
|
|
1430
|
-
* Program to which bulk add participants.
|
|
1431
|
-
* @format GUID
|
|
1432
|
-
*/
|
|
1433
|
-
programId: string;
|
|
1434
|
-
/**
|
|
1435
|
-
* Site members.
|
|
1436
|
-
* @format GUID
|
|
1437
|
-
* @minSize 1
|
|
1438
|
-
* @maxSize 1000
|
|
1439
|
-
*/
|
|
1440
|
-
memberIds?: string[];
|
|
1441
|
-
/** Return added participants in the response or not. */
|
|
1442
|
-
returnEntity?: boolean;
|
|
1443
|
-
}
|
|
1444
|
-
interface BulkAddToProgramResponse {
|
|
1445
|
-
/** Participants created by bulk action */
|
|
1446
|
-
results?: BulkAddToProgramResult[];
|
|
1447
|
-
/** Bulk action metadata. */
|
|
1448
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1449
|
-
}
|
|
1450
|
-
interface BulkAddToProgramResult {
|
|
1451
|
-
/** Added participant metadata. */
|
|
1452
|
-
itemMetadata?: ItemMetadata;
|
|
1453
|
-
/** Added participant */
|
|
1454
|
-
item?: Participant;
|
|
1455
|
-
}
|
|
1456
|
-
interface BulkApproveParticipantRequest {
|
|
1457
|
-
/**
|
|
1458
|
-
* Participants to add
|
|
1459
|
-
* @format GUID
|
|
1460
|
-
* @maxSize 100
|
|
1461
|
-
*/
|
|
1462
|
-
participantIds: string[];
|
|
1463
|
-
/**
|
|
1464
|
-
* program to approve participant
|
|
1465
|
-
* @format GUID
|
|
1466
|
-
*/
|
|
1467
|
-
programId?: string;
|
|
1468
|
-
/** Return approved participants in the response or not */
|
|
1469
|
-
returnEntity?: boolean;
|
|
1470
|
-
}
|
|
1471
|
-
interface BulkApproveParticipantResponse {
|
|
1472
|
-
/** Participants approved by bulk action */
|
|
1473
|
-
results?: BulkApproveParticipantResult[];
|
|
1474
|
-
/** Bulk action metadata */
|
|
1475
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1476
|
-
}
|
|
1477
|
-
interface BulkApproveParticipantResult {
|
|
1478
|
-
/** Approved participant metadata */
|
|
1479
|
-
itemMetadata?: ItemMetadata;
|
|
1480
|
-
/** Approved or existing participant */
|
|
1481
|
-
item?: Participant;
|
|
1482
|
-
}
|
|
1483
|
-
interface ParticipantApproved {
|
|
1484
|
-
/**
|
|
1485
|
-
* Program ID which participant approved
|
|
1486
|
-
* @format GUID
|
|
1487
|
-
*/
|
|
1488
|
-
programId?: string;
|
|
1489
|
-
/**
|
|
1490
|
-
* Member ID of participant approved
|
|
1491
|
-
* @format GUID
|
|
1492
|
-
*/
|
|
1493
|
-
memberId?: string;
|
|
1494
|
-
}
|
|
1495
|
-
interface BulkApproveAllParticipantRequest {
|
|
1496
|
-
/**
|
|
1497
|
-
* Program to approve all participants.
|
|
1498
|
-
* @format GUID
|
|
1499
|
-
*/
|
|
1500
|
-
programId?: string;
|
|
1501
|
-
/**
|
|
1502
|
-
* Exclude site members.
|
|
1503
|
-
* @format GUID
|
|
1504
|
-
* @maxSize 100
|
|
1505
|
-
*/
|
|
1506
|
-
excludeParticipantIds?: string[];
|
|
1507
|
-
}
|
|
1508
|
-
interface BulkApproveAllParticipantResponse {
|
|
1509
|
-
/**
|
|
1510
|
-
* Job id with async process
|
|
1511
|
-
* @format GUID
|
|
1512
|
-
*/
|
|
1513
|
-
jobId?: string;
|
|
1514
|
-
}
|
|
1515
|
-
interface ExportParticipantsStatsRequest {
|
|
1516
|
-
/**
|
|
1517
|
-
* program id to export data from
|
|
1518
|
-
* @format GUID
|
|
1519
|
-
*/
|
|
1520
|
-
programId: string;
|
|
1521
|
-
}
|
|
1522
|
-
interface ExportParticipantsStatsResponse {
|
|
1523
|
-
}
|
|
1524
|
-
interface ParticipantExportsFinished {
|
|
1525
|
-
/**
|
|
1526
|
-
* program id from which stats were exported
|
|
1527
|
-
* @format GUID
|
|
1528
|
-
*/
|
|
1529
|
-
programId?: string;
|
|
1530
|
-
/**
|
|
1531
|
-
* user id of program owner
|
|
1532
|
-
* @format GUID
|
|
1533
|
-
*/
|
|
1534
|
-
userId?: string;
|
|
1535
|
-
/**
|
|
1536
|
-
* url to download report
|
|
1537
|
-
* @format WEB_URL
|
|
1538
|
-
*/
|
|
1539
|
-
downloadUrl?: string;
|
|
1540
|
-
/** days url will be downloadable */
|
|
1541
|
-
downloadUrlTtlDays?: number;
|
|
1542
|
-
}
|
|
1543
|
-
/** @docsIgnore */
|
|
1544
|
-
type CreateParticipantApplicationErrors = {
|
|
1545
|
-
code?: 'INVALID_PAYMENT_INFO';
|
|
1546
|
-
description?: string;
|
|
1547
|
-
data?: Record<string, any>;
|
|
1548
|
-
};
|
|
1549
|
-
/** @docsIgnore */
|
|
1550
|
-
type BulkUpdateParticipantTagsApplicationErrors = {
|
|
1551
|
-
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
1552
|
-
description?: string;
|
|
1553
|
-
data?: Record<string, any>;
|
|
1554
|
-
};
|
|
1555
|
-
/** @docsIgnore */
|
|
1556
|
-
type BulkUpdateParticipantTagsByFilterApplicationErrors = {
|
|
1557
|
-
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
1558
|
-
description?: string;
|
|
1559
|
-
data?: Record<string, any>;
|
|
1560
|
-
};
|
|
1561
495
|
|
|
1562
496
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1563
497
|
getUrl: (context: any) => string;
|
|
@@ -1569,34 +503,10 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
1569
503
|
__responseType: Q;
|
|
1570
504
|
__originalResponseType: R;
|
|
1571
505
|
};
|
|
1572
|
-
declare function createParticipant(): __PublicMethodMetaInfo<'POST', {}, CreateParticipantRequest$1, CreateParticipantRequest, CreateParticipantResponse$1, CreateParticipantResponse>;
|
|
1573
|
-
declare function bulkCreateParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantRequest$1, BulkCreateParticipantRequest, BulkCreateParticipantResponse$1, BulkCreateParticipantResponse>;
|
|
1574
|
-
declare function bulkAddAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddAllToProgramRequest$1, BulkAddAllToProgramRequest, BulkAddAllToProgramResponse$1, BulkAddAllToProgramResponse>;
|
|
1575
|
-
declare function deleteParticipant(): __PublicMethodMetaInfo<'DELETE', {
|
|
1576
|
-
participantId: string;
|
|
1577
|
-
}, DeleteParticipantRequest$1, DeleteParticipantRequest, DeleteParticipantResponse$1, DeleteParticipantResponse>;
|
|
1578
|
-
declare function issueCertificate(): __PublicMethodMetaInfo<'POST', {
|
|
1579
|
-
participantId: string;
|
|
1580
|
-
}, IssueCertificateRequest$1, IssueCertificateRequest, IssueCertificateResponse$1, IssueCertificateResponse>;
|
|
1581
|
-
declare function getCompletionStats(): __PublicMethodMetaInfo<'GET', {
|
|
1582
|
-
programId: string;
|
|
1583
|
-
}, GetCompletionStatsRequest$1, GetCompletionStatsRequest, GetCompletionStatsResponse$1, GetCompletionStatsResponse>;
|
|
1584
|
-
declare function getPremiumStats(): __PublicMethodMetaInfo<'GET', {}, GetPremiumStatsRequest$1, GetPremiumStatsRequest, GetPremiumStatsResponse$1, GetPremiumStatsResponse>;
|
|
1585
|
-
declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
|
|
1586
|
-
participantId: string;
|
|
1587
|
-
}, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
|
|
1588
|
-
declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
|
|
1589
|
-
declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
|
|
1590
|
-
declare function bulkUpdateParticipantTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateParticipantTagsRequest$1, BulkUpdateParticipantTagsRequest, BulkUpdateParticipantTagsResponse$1, BulkUpdateParticipantTagsResponse>;
|
|
1591
|
-
declare function bulkUpdateParticipantTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateParticipantTagsByFilterRequest$1, BulkUpdateParticipantTagsByFilterRequest, BulkUpdateParticipantTagsByFilterResponse$1, BulkUpdateParticipantTagsByFilterResponse>;
|
|
1592
|
-
declare function searchParticipants(): __PublicMethodMetaInfo<'POST', {}, SearchParticipantsRequest$1, SearchParticipantsRequest, SearchParticipantsResponse$1, SearchParticipantsResponse>;
|
|
1593
506
|
declare function bulkInviteToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteToProgramRequest$1, BulkInviteToProgramRequest, BulkInviteToProgramResponse$1, BulkInviteToProgramResponse>;
|
|
1594
507
|
declare function bulkInviteAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramRequest, BulkInviteAllToProgramResponse$1, BulkInviteAllToProgramResponse>;
|
|
1595
508
|
declare function bulkAddToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddToProgramRequest$1, BulkAddToProgramRequest, BulkAddToProgramResponse$1, BulkAddToProgramResponse>;
|
|
1596
509
|
declare function bulkApproveParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveParticipantRequest$1, BulkApproveParticipantRequest, BulkApproveParticipantResponse$1, BulkApproveParticipantResponse>;
|
|
1597
510
|
declare function bulkApproveAllParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantRequest, BulkApproveAllParticipantResponse$1, BulkApproveAllParticipantResponse>;
|
|
1598
|
-
declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
|
|
1599
|
-
programId: string;
|
|
1600
|
-
}, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
|
|
1601
511
|
|
|
1602
|
-
export { type ActionEvent as ActionEventOriginal, type
|
|
512
|
+
export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddToProgramRequest as BulkAddToProgramRequestOriginal, type BulkAddToProgramResponse as BulkAddToProgramResponseOriginal, type BulkAddToProgramResult as BulkAddToProgramResultOriginal, type BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequestOriginal, type BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponseOriginal, type BulkApproveParticipantRequest as BulkApproveParticipantRequestOriginal, type BulkApproveParticipantResponse as BulkApproveParticipantResponseOriginal, type BulkApproveParticipantResult as BulkApproveParticipantResultOriginal, type BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequestOriginal, type BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponseOriginal, type BulkInviteToProgramRequest as BulkInviteToProgramRequestOriginal, type BulkInviteToProgramResponse as BulkInviteToProgramResponseOriginal, type BulkInviteToProgramResult as BulkInviteToProgramResultOriginal, type Certificate as CertificateOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FreeCouponDetails as FreeCouponDetailsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, JoinPath as JoinPathOriginal, type JoinPathWithLiterals as JoinPathWithLiteralsOriginal, type JoinedInfoJoinPathDetailsOneOf as JoinedInfoJoinPathDetailsOneOfOriginal, type JoinedInfo as JoinedInfoOriginal, type Member as MemberOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PaidPlanDetails as PaidPlanDetailsOriginal, type ParticipantAdded as ParticipantAddedOriginal, type ParticipantApproved as ParticipantApprovedOriginal, type ParticipantInvited as ParticipantInvitedOriginal, type Participant as ParticipantOriginal, type Progress as ProgressOriginal, type RestoreInfo as RestoreInfoOriginal, type SinglePaymentDetails as SinglePaymentDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram };
|