@wix/auto_sdk_online-programs_participants 1.0.4 → 1.0.6
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 +71 -103
- package/build/cjs/index.js +490 -706
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +295 -914
- package/build/cjs/index.typings.js +370 -501
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +213 -757
- package/build/cjs/meta.js +277 -418
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +71 -103
- package/build/es/index.mjs +495 -695
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +295 -914
- package/build/es/index.typings.mjs +391 -511
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +213 -757
- package/build/es/meta.mjs +261 -390
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +71 -103
- package/build/internal/cjs/index.js +490 -706
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +295 -914
- package/build/internal/cjs/index.typings.js +370 -501
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +213 -757
- package/build/internal/cjs/meta.js +277 -418
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +71 -103
- package/build/internal/es/index.mjs +495 -695
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +295 -914
- package/build/internal/es/index.typings.mjs +391 -511
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +213 -757
- package/build/internal/es/meta.mjs +261 -390
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
-
interface Participant
|
|
4
|
-
paymentPendingOptions?: PaymentPendingOptions;
|
|
5
|
-
joinedOptions?: JoinedOptions;
|
|
6
|
-
completedOptions?: CompletedOptions;
|
|
7
|
-
failedOptions?: FailedOptions;
|
|
8
|
-
suspendedOptions?: SuspendedOptions;
|
|
9
|
-
/** options for auto removed participant */
|
|
10
|
-
autoRemovedOptions?: AutoRemovedOptions;
|
|
3
|
+
interface Participant {
|
|
11
4
|
/**
|
|
12
5
|
* Participant ID.
|
|
13
6
|
* @format GUID
|
|
@@ -41,18 +34,16 @@ interface Participant extends ParticipantStateOptionsOneOf {
|
|
|
41
34
|
state?: StateWithLiterals;
|
|
42
35
|
/** Certificate issued to participant */
|
|
43
36
|
certificate?: Certificate;
|
|
37
|
+
/** @readonly */
|
|
38
|
+
paymentInfo?: PaymentInfo;
|
|
39
|
+
/** @readonly */
|
|
40
|
+
joinedInfo?: JoinedInfo;
|
|
41
|
+
/** @readonly */
|
|
42
|
+
member?: Member;
|
|
43
|
+
/** @readonly */
|
|
44
|
+
lastActivityDate?: Date | null;
|
|
44
45
|
extendedFields?: ExtendedFields;
|
|
45
46
|
}
|
|
46
|
-
/** @oneof */
|
|
47
|
-
interface ParticipantStateOptionsOneOf {
|
|
48
|
-
paymentPendingOptions?: PaymentPendingOptions;
|
|
49
|
-
joinedOptions?: JoinedOptions;
|
|
50
|
-
completedOptions?: CompletedOptions;
|
|
51
|
-
failedOptions?: FailedOptions;
|
|
52
|
-
suspendedOptions?: SuspendedOptions;
|
|
53
|
-
/** options for auto removed participant */
|
|
54
|
-
autoRemovedOptions?: AutoRemovedOptions;
|
|
55
|
-
}
|
|
56
47
|
declare enum JoinPath {
|
|
57
48
|
UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
|
|
58
49
|
/** Member joined to the program for free */
|
|
@@ -68,16 +59,6 @@ declare enum JoinPath {
|
|
|
68
59
|
}
|
|
69
60
|
/** @enumType */
|
|
70
61
|
type JoinPathWithLiterals = JoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
|
|
71
|
-
interface SinglePaymentOptions {
|
|
72
|
-
orderId?: string;
|
|
73
|
-
}
|
|
74
|
-
interface PaidPlanOptions {
|
|
75
|
-
/** @maxSize 10 */
|
|
76
|
-
planIds?: string[];
|
|
77
|
-
}
|
|
78
|
-
interface FreeCouponOptions {
|
|
79
|
-
couponId?: string;
|
|
80
|
-
}
|
|
81
62
|
interface Progress {
|
|
82
63
|
/** Number of program steps completed by member */
|
|
83
64
|
totalStepsCompleted?: number;
|
|
@@ -92,11 +73,6 @@ interface Progress {
|
|
|
92
73
|
declare enum State {
|
|
93
74
|
/** Unknown state */
|
|
94
75
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
95
|
-
/** Member invited to participate in program */
|
|
96
|
-
INVITED = "INVITED",
|
|
97
|
-
/** Member asked owner to participate in program */
|
|
98
|
-
APPROVAL_PENDING = "APPROVAL_PENDING",
|
|
99
|
-
PAYMENT_PENDING = "PAYMENT_PENDING",
|
|
100
76
|
/** Member joined the program and became participant */
|
|
101
77
|
JOINED = "JOINED",
|
|
102
78
|
/** Participant completed the program, and could join again */
|
|
@@ -106,10 +82,14 @@ declare enum State {
|
|
|
106
82
|
/** Participant with ended pricing plan (PP), will be joined as renew PP */
|
|
107
83
|
SUSPENDED = "SUSPENDED",
|
|
108
84
|
/** Participant removed automatically after some program condition */
|
|
109
|
-
AUTO_REMOVED = "AUTO_REMOVED"
|
|
85
|
+
AUTO_REMOVED = "AUTO_REMOVED",
|
|
86
|
+
/** Participant removed by site owner */
|
|
87
|
+
REMOVED = "REMOVED",
|
|
88
|
+
/** Participant left the program by himself */
|
|
89
|
+
LEFT = "LEFT"
|
|
110
90
|
}
|
|
111
91
|
/** @enumType */
|
|
112
|
-
type StateWithLiterals = State | 'UNKNOWN_STATE' | '
|
|
92
|
+
type StateWithLiterals = State | 'UNKNOWN_STATE' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
|
|
113
93
|
interface Certificate {
|
|
114
94
|
/**
|
|
115
95
|
* when certificate was issued, UTC
|
|
@@ -117,6 +97,51 @@ interface Certificate {
|
|
|
117
97
|
*/
|
|
118
98
|
issuedDate?: Date | null;
|
|
119
99
|
}
|
|
100
|
+
interface PaymentInfo {
|
|
101
|
+
/** @format GUID */
|
|
102
|
+
paymentOrderId?: string | null;
|
|
103
|
+
/** @format GUID */
|
|
104
|
+
offlineTrxId?: string | null;
|
|
105
|
+
/** @format GUID */
|
|
106
|
+
paidPlanId?: string | null;
|
|
107
|
+
/** @format GUID */
|
|
108
|
+
freeCouponId?: string | null;
|
|
109
|
+
}
|
|
110
|
+
interface JoinedInfo {
|
|
111
|
+
/** @maxLength 50 */
|
|
112
|
+
timeZone?: string;
|
|
113
|
+
/** @format LOCAL_DATE */
|
|
114
|
+
startDate?: string;
|
|
115
|
+
joinPath?: JoinPathWithLiterals;
|
|
116
|
+
/** @format LOCAL_DATE */
|
|
117
|
+
finishDate?: string | null;
|
|
118
|
+
/** @readonly */
|
|
119
|
+
joinedAt?: Date | null;
|
|
120
|
+
}
|
|
121
|
+
interface Member {
|
|
122
|
+
/**
|
|
123
|
+
* @readonly
|
|
124
|
+
* @maxLength 100
|
|
125
|
+
*/
|
|
126
|
+
firstName?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* @readonly
|
|
129
|
+
* @maxLength 100
|
|
130
|
+
*/
|
|
131
|
+
lastName?: string | null;
|
|
132
|
+
/**
|
|
133
|
+
* @readonly
|
|
134
|
+
* @format EMAIL
|
|
135
|
+
*/
|
|
136
|
+
email?: string | null;
|
|
137
|
+
/** @format GUID */
|
|
138
|
+
contactId?: string;
|
|
139
|
+
/**
|
|
140
|
+
* @readonly
|
|
141
|
+
* @format WEB_URL
|
|
142
|
+
*/
|
|
143
|
+
profileImageUrl?: string | null;
|
|
144
|
+
}
|
|
120
145
|
interface ExtendedFields {
|
|
121
146
|
/**
|
|
122
147
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -128,158 +153,184 @@ interface ExtendedFields {
|
|
|
128
153
|
*/
|
|
129
154
|
namespaces?: Record<string, Record<string, any>>;
|
|
130
155
|
}
|
|
131
|
-
interface
|
|
132
|
-
/**
|
|
133
|
-
* Payment order
|
|
134
|
-
* @format GUID
|
|
135
|
-
*/
|
|
136
|
-
paymentOrderId?: string | null;
|
|
156
|
+
interface ParticipantAdded {
|
|
137
157
|
/**
|
|
138
|
-
*
|
|
158
|
+
* Program ID which participant was added
|
|
139
159
|
* @format GUID
|
|
140
160
|
*/
|
|
141
|
-
|
|
161
|
+
programId?: string;
|
|
142
162
|
/**
|
|
143
|
-
*
|
|
163
|
+
* Member ID of participant on site
|
|
144
164
|
* @format GUID
|
|
145
|
-
* @maxSize 10
|
|
146
165
|
*/
|
|
147
|
-
|
|
166
|
+
memberId?: string;
|
|
148
167
|
}
|
|
149
|
-
interface
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
freeCouponOptions?: FreeCouponOptions;
|
|
153
|
-
timeZone?: string;
|
|
154
|
-
/** @format LOCAL_DATE */
|
|
155
|
-
startDate?: string;
|
|
156
|
-
joinPath?: JoinPathWithLiterals;
|
|
168
|
+
interface CreateParticipantRequest {
|
|
169
|
+
/** Participant to create */
|
|
170
|
+
participant: Participant;
|
|
157
171
|
}
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
paidPlanOptions?: PaidPlanOptions;
|
|
162
|
-
freeCouponOptions?: FreeCouponOptions;
|
|
172
|
+
interface CreateParticipantResponse {
|
|
173
|
+
/** Created participant */
|
|
174
|
+
participant?: Participant;
|
|
163
175
|
}
|
|
164
|
-
interface
|
|
176
|
+
interface BulkCreateParticipantRequest {
|
|
165
177
|
/**
|
|
166
|
-
*
|
|
167
|
-
* @
|
|
178
|
+
* List of participants you want to create
|
|
179
|
+
* @minSize 1
|
|
180
|
+
* @maxSize 100
|
|
168
181
|
*/
|
|
169
|
-
|
|
182
|
+
participants: Participant[];
|
|
183
|
+
/** Whether to return entities in response or not. */
|
|
184
|
+
returnEntity?: boolean;
|
|
170
185
|
}
|
|
171
|
-
interface
|
|
186
|
+
interface BulkCreateParticipantResponse {
|
|
172
187
|
/**
|
|
173
|
-
*
|
|
174
|
-
* @
|
|
188
|
+
* Results of bulk action.
|
|
189
|
+
* @minSize 1
|
|
190
|
+
* @maxSize 100
|
|
175
191
|
*/
|
|
176
|
-
|
|
192
|
+
results?: BulkParticipantResult[];
|
|
193
|
+
/** Metadata about whole bulk action. */
|
|
194
|
+
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
195
|
+
}
|
|
196
|
+
interface BulkParticipantResult {
|
|
197
|
+
/** Metadata of item. */
|
|
198
|
+
itemMetadata?: CommonItemMetadata;
|
|
199
|
+
/** Item itself (empty if return_entity in request is false). */
|
|
200
|
+
item?: Participant;
|
|
201
|
+
}
|
|
202
|
+
interface CommonItemMetadata {
|
|
203
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
204
|
+
_id?: string | null;
|
|
205
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
206
|
+
originalIndex?: number;
|
|
207
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
208
|
+
success?: boolean;
|
|
209
|
+
/** Details about the error in case of failure. */
|
|
210
|
+
error?: ApplicationError;
|
|
211
|
+
}
|
|
212
|
+
interface ApplicationError {
|
|
213
|
+
/** Error code. */
|
|
214
|
+
code?: string;
|
|
215
|
+
/** Description of the error. */
|
|
216
|
+
description?: string;
|
|
217
|
+
/** Data related to the error. */
|
|
218
|
+
data?: Record<string, any> | null;
|
|
219
|
+
}
|
|
220
|
+
interface CommonBulkActionMetadata {
|
|
221
|
+
/** Number of items that were successfully processed. */
|
|
222
|
+
totalSuccesses?: number;
|
|
223
|
+
/** Number of items that couldn't be processed. */
|
|
224
|
+
totalFailures?: number;
|
|
225
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
226
|
+
undetailedFailures?: number;
|
|
177
227
|
}
|
|
178
|
-
interface
|
|
228
|
+
interface BulkAddAllToProgramRequest {
|
|
179
229
|
/**
|
|
180
|
-
*
|
|
181
|
-
* @format
|
|
230
|
+
* Program to which bulk add participants.
|
|
231
|
+
* @format GUID
|
|
182
232
|
*/
|
|
183
|
-
|
|
184
|
-
}
|
|
185
|
-
interface AutoRemovedOptions {
|
|
233
|
+
programId: string;
|
|
186
234
|
/**
|
|
187
|
-
*
|
|
188
|
-
* @format
|
|
235
|
+
* Exclude site members.
|
|
236
|
+
* @format GUID
|
|
237
|
+
* @maxSize 100
|
|
189
238
|
*/
|
|
190
|
-
|
|
239
|
+
excludeMemberIds?: string[];
|
|
191
240
|
}
|
|
192
|
-
interface
|
|
241
|
+
interface BulkAddAllToProgramResponse {
|
|
193
242
|
/**
|
|
194
|
-
*
|
|
243
|
+
* Async infra job id which will process the request.
|
|
195
244
|
* @format GUID
|
|
196
245
|
*/
|
|
197
|
-
|
|
198
|
-
}
|
|
199
|
-
interface JoinProgramResponse {
|
|
200
|
-
/** Created participant with corresponding state */
|
|
201
|
-
participant?: Participant;
|
|
202
|
-
}
|
|
203
|
-
interface ParticipantJoined {
|
|
204
|
-
/** Joined participant */
|
|
205
|
-
participant?: Participant;
|
|
246
|
+
jobId?: string;
|
|
206
247
|
}
|
|
207
|
-
interface
|
|
248
|
+
interface DeleteParticipantRequest {
|
|
208
249
|
/**
|
|
209
|
-
*
|
|
250
|
+
* Participants to delete
|
|
210
251
|
* @format GUID
|
|
211
252
|
*/
|
|
212
253
|
participantId: string;
|
|
213
254
|
}
|
|
214
|
-
interface
|
|
215
|
-
/** existing participant */
|
|
216
|
-
participant?: Participant;
|
|
255
|
+
interface DeleteParticipantResponse {
|
|
217
256
|
}
|
|
218
|
-
interface
|
|
257
|
+
interface IssueCertificateRequest {
|
|
219
258
|
/**
|
|
220
|
-
* Participant
|
|
259
|
+
* Participant to get certificate
|
|
221
260
|
* @format GUID
|
|
222
261
|
*/
|
|
223
262
|
participantId: string;
|
|
224
263
|
}
|
|
225
|
-
interface
|
|
264
|
+
interface IssueCertificateResponse {
|
|
265
|
+
/** Updated participant */
|
|
266
|
+
participant?: Participant;
|
|
226
267
|
}
|
|
227
|
-
interface
|
|
228
|
-
/**
|
|
229
|
-
* Participant id who left
|
|
230
|
-
* @format GUID
|
|
231
|
-
*/
|
|
232
|
-
participantId?: string;
|
|
268
|
+
interface GetCompletionStatsRequest {
|
|
233
269
|
/**
|
|
234
|
-
*
|
|
270
|
+
* program id to get stats for
|
|
235
271
|
* @format GUID
|
|
236
272
|
*/
|
|
237
|
-
programId
|
|
273
|
+
programId: string;
|
|
274
|
+
}
|
|
275
|
+
interface GetCompletionStatsResponse {
|
|
276
|
+
/** Number of participants that completed the program */
|
|
277
|
+
completedAll?: number;
|
|
278
|
+
/** Percentage of participants that completed the program */
|
|
279
|
+
completionRate?: number;
|
|
280
|
+
}
|
|
281
|
+
interface GetPremiumStatsRequest {
|
|
282
|
+
}
|
|
283
|
+
interface GetPremiumStatsResponse {
|
|
284
|
+
/** True if site has Online Programs premium feature */
|
|
285
|
+
hasPremium?: boolean;
|
|
286
|
+
/** Count of active participants on the site */
|
|
287
|
+
activeParticipantsCount?: number;
|
|
288
|
+
/** Limit of active participants on a site without premium */
|
|
289
|
+
activeParticipantsLimit?: number;
|
|
290
|
+
}
|
|
291
|
+
interface GetParticipantRequest {
|
|
238
292
|
/**
|
|
239
|
-
* Participant
|
|
293
|
+
* Participant id to fetch
|
|
240
294
|
* @format GUID
|
|
241
295
|
*/
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
/** Default for backward compatibility */
|
|
248
|
-
UNKNOWN_REMOVAL_REASON = "UNKNOWN_REMOVAL_REASON",
|
|
249
|
-
/** User-initiated leave */
|
|
250
|
-
LEGITIMATE_LEAVE = "LEGITIMATE_LEAVE",
|
|
251
|
-
/** Cleanup during rejoin flow */
|
|
252
|
-
CLEANUP_FOR_REJOIN = "CLEANUP_FOR_REJOIN",
|
|
253
|
-
/** Cleanup during manual addition */
|
|
254
|
-
CLEANUP_FOR_MANUAL_ADD = "CLEANUP_FOR_MANUAL_ADD"
|
|
296
|
+
participantId: string;
|
|
297
|
+
}
|
|
298
|
+
interface GetParticipantResponse {
|
|
299
|
+
/** existing participant */
|
|
300
|
+
participant?: Participant;
|
|
255
301
|
}
|
|
256
|
-
/** @enumType */
|
|
257
|
-
type RemovalReasonWithLiterals = RemovalReason | 'UNKNOWN_REMOVAL_REASON' | 'LEGITIMATE_LEAVE' | 'CLEANUP_FOR_REJOIN' | 'CLEANUP_FOR_MANUAL_ADD';
|
|
258
302
|
interface QueryParticipantsRequest {
|
|
259
303
|
/** Platformized query */
|
|
260
304
|
query?: CursorQuery;
|
|
261
305
|
}
|
|
262
306
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
263
|
-
/**
|
|
307
|
+
/**
|
|
308
|
+
* Cursor paging options.
|
|
309
|
+
*
|
|
310
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
311
|
+
*/
|
|
264
312
|
cursorPaging?: CursorPaging;
|
|
265
313
|
/**
|
|
266
|
-
* Filter object
|
|
267
|
-
*
|
|
268
|
-
*
|
|
269
|
-
* "fieldName2":{"$operator":"value2"}
|
|
270
|
-
* }`
|
|
271
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
314
|
+
* Filter object.
|
|
315
|
+
*
|
|
316
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
272
317
|
*/
|
|
273
318
|
filter?: Record<string, any> | null;
|
|
274
319
|
/**
|
|
275
|
-
* Sort object
|
|
276
|
-
*
|
|
320
|
+
* Sort object.
|
|
321
|
+
*
|
|
322
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
323
|
+
* @maxSize 5
|
|
277
324
|
*/
|
|
278
325
|
sort?: Sorting[];
|
|
279
326
|
}
|
|
280
327
|
/** @oneof */
|
|
281
328
|
interface CursorQueryPagingMethodOneOf {
|
|
282
|
-
/**
|
|
329
|
+
/**
|
|
330
|
+
* Cursor paging options.
|
|
331
|
+
*
|
|
332
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
333
|
+
*/
|
|
283
334
|
cursorPaging?: CursorPaging;
|
|
284
335
|
}
|
|
285
336
|
interface Sorting {
|
|
@@ -299,16 +350,16 @@ declare enum SortOrder {
|
|
|
299
350
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
300
351
|
interface CursorPaging {
|
|
301
352
|
/**
|
|
302
|
-
*
|
|
353
|
+
* Maximum number of items to return in the results.
|
|
303
354
|
* @max 100
|
|
304
355
|
*/
|
|
305
356
|
limit?: number | null;
|
|
306
357
|
/**
|
|
307
358
|
* Pointer to the next or previous page in the list of results.
|
|
308
359
|
*
|
|
309
|
-
*
|
|
310
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
360
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
311
361
|
* Not relevant for the first request.
|
|
362
|
+
* @maxLength 16000
|
|
312
363
|
*/
|
|
313
364
|
cursor?: string | null;
|
|
314
365
|
}
|
|
@@ -319,21 +370,28 @@ interface QueryParticipantsResponse {
|
|
|
319
370
|
pagingMetadata?: CursorPagingMetadata;
|
|
320
371
|
}
|
|
321
372
|
interface CursorPagingMetadata {
|
|
322
|
-
/** Number of items returned in
|
|
373
|
+
/** Number of items returned in current page. */
|
|
323
374
|
count?: number | null;
|
|
324
|
-
/**
|
|
375
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
325
376
|
cursors?: Cursors;
|
|
326
377
|
/**
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
*
|
|
378
|
+
* Whether there are more pages to retrieve following the current page.
|
|
379
|
+
*
|
|
380
|
+
* + `true`: Another page of results can be retrieved.
|
|
381
|
+
* + `false`: This is the last page.
|
|
330
382
|
*/
|
|
331
383
|
hasNext?: boolean | null;
|
|
332
384
|
}
|
|
333
385
|
interface Cursors {
|
|
334
|
-
/**
|
|
386
|
+
/**
|
|
387
|
+
* Cursor string pointing to the next page in the list of results.
|
|
388
|
+
* @maxLength 16000
|
|
389
|
+
*/
|
|
335
390
|
next?: string | null;
|
|
336
|
-
/**
|
|
391
|
+
/**
|
|
392
|
+
* Cursor pointing to the previous page in the list of results.
|
|
393
|
+
* @maxLength 16000
|
|
394
|
+
*/
|
|
337
395
|
prev?: string | null;
|
|
338
396
|
}
|
|
339
397
|
interface GetAccessStatusRequest {
|
|
@@ -342,508 +400,6 @@ interface GetAccessStatusResponse {
|
|
|
342
400
|
/** True if participants cannot access online programs due to some limitations */
|
|
343
401
|
isBlocked?: boolean;
|
|
344
402
|
}
|
|
345
|
-
interface ApplyCouponRequest {
|
|
346
|
-
/** @format GUID */
|
|
347
|
-
participantId: string;
|
|
348
|
-
/** @format GUID */
|
|
349
|
-
orderId: string;
|
|
350
|
-
couponCode: string;
|
|
351
|
-
}
|
|
352
|
-
interface ApplyCouponResponse {
|
|
353
|
-
/** @format GUID */
|
|
354
|
-
couponId?: string;
|
|
355
|
-
subTotal?: number;
|
|
356
|
-
discount?: number;
|
|
357
|
-
total?: number;
|
|
358
|
-
}
|
|
359
|
-
interface RevertCouponRequest {
|
|
360
|
-
/** @format GUID */
|
|
361
|
-
participantId: string;
|
|
362
|
-
/** @format GUID */
|
|
363
|
-
orderId: string;
|
|
364
|
-
/** @format GUID */
|
|
365
|
-
couponId: string;
|
|
366
|
-
}
|
|
367
|
-
interface RevertCouponResponse {
|
|
368
|
-
total?: number;
|
|
369
|
-
}
|
|
370
|
-
/** This webhook is triggered whenever a payment transaction is updated (including refunds) via specific [Wix Apps](https://dev.wix.com/api/rest/wix-payments/about-wix-payments). */
|
|
371
|
-
interface PaymentEvent extends PaymentEventEventOneOf {
|
|
372
|
-
/** `TRANSACTION_STATUS_CHANGED` event details. */
|
|
373
|
-
transactionStatusChangedEvent?: TransactionStatusChangedEvent;
|
|
374
|
-
/** `REFUND_STATUS_CHANGED` event details. */
|
|
375
|
-
refundStatusChangedEvent?: RefundStatusChangedEvent;
|
|
376
|
-
/**
|
|
377
|
-
* `RECURRING_PAYMENT_STATUS_CHANGED` event details.
|
|
378
|
-
* @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
|
|
379
|
-
* @targetRemovalDate 2026-06-30
|
|
380
|
-
*/
|
|
381
|
-
recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
|
|
382
|
-
/** `TRANSACTION_UPDATED` event details. */
|
|
383
|
-
transactionUpdatedEvent?: TransactionUpdatedEvent;
|
|
384
|
-
/** `TRANSACTION_CREATED` event details. */
|
|
385
|
-
transactionCreatedEvent?: TransactionCreatedEvent;
|
|
386
|
-
/**
|
|
387
|
-
* Unique event ID.
|
|
388
|
-
* @format GUID
|
|
389
|
-
*/
|
|
390
|
-
_id?: string;
|
|
391
|
-
/** Event timestamp */
|
|
392
|
-
eventTime?: Date | null;
|
|
393
|
-
/**
|
|
394
|
-
* ID of the [Wix app](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions) that triggered this event.
|
|
395
|
-
* @maxLength 100
|
|
396
|
-
*/
|
|
397
|
-
wixAppId?: string;
|
|
398
|
-
/**
|
|
399
|
-
* Unique ID assigned to each Wix app in each site.
|
|
400
|
-
* @format GUID
|
|
401
|
-
*/
|
|
402
|
-
wixAppInstanceId?: string;
|
|
403
|
-
/** Event type. */
|
|
404
|
-
eventType?: EventTypeWithLiterals;
|
|
405
|
-
/**
|
|
406
|
-
* ID of Wix app that mediated between Wix Payments and the Wix app that triggered the event (if relevant).
|
|
407
|
-
* @maxLength 100
|
|
408
|
-
*/
|
|
409
|
-
managingWixAppId?: string | null;
|
|
410
|
-
}
|
|
411
|
-
/** @oneof */
|
|
412
|
-
interface PaymentEventEventOneOf {
|
|
413
|
-
/** `TRANSACTION_STATUS_CHANGED` event details. */
|
|
414
|
-
transactionStatusChangedEvent?: TransactionStatusChangedEvent;
|
|
415
|
-
/** `REFUND_STATUS_CHANGED` event details. */
|
|
416
|
-
refundStatusChangedEvent?: RefundStatusChangedEvent;
|
|
417
|
-
/**
|
|
418
|
-
* `RECURRING_PAYMENT_STATUS_CHANGED` event details.
|
|
419
|
-
* @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
|
|
420
|
-
* @targetRemovalDate 2026-06-30
|
|
421
|
-
*/
|
|
422
|
-
recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
|
|
423
|
-
/** `TRANSACTION_UPDATED` event details. */
|
|
424
|
-
transactionUpdatedEvent?: TransactionUpdatedEvent;
|
|
425
|
-
/** `TRANSACTION_CREATED` event details. */
|
|
426
|
-
transactionCreatedEvent?: TransactionCreatedEvent;
|
|
427
|
-
}
|
|
428
|
-
declare enum EventType {
|
|
429
|
-
UNDEFINED = "UNDEFINED",
|
|
430
|
-
/** Fired when a transaction's status changes. */
|
|
431
|
-
TRANSACTION_STATUS_CHANGED = "TRANSACTION_STATUS_CHANGED",
|
|
432
|
-
/** Fired when a refund's status changes. */
|
|
433
|
-
REFUND_STATUS_CHANGED = "REFUND_STATUS_CHANGED",
|
|
434
|
-
/** Fired when a legacy subscription's status changes. */
|
|
435
|
-
RECURRING_PAYMENT_STATUS_CHANGED = "RECURRING_PAYMENT_STATUS_CHANGED",
|
|
436
|
-
/** Fired when a transaction is updated. */
|
|
437
|
-
TRANSACTION_UPDATED = "TRANSACTION_UPDATED",
|
|
438
|
-
/** Fired when a transaction is created. */
|
|
439
|
-
TRANSACTION_CREATED = "TRANSACTION_CREATED"
|
|
440
|
-
}
|
|
441
|
-
/** @enumType */
|
|
442
|
-
type EventTypeWithLiterals = EventType | 'UNDEFINED' | 'TRANSACTION_STATUS_CHANGED' | 'REFUND_STATUS_CHANGED' | 'RECURRING_PAYMENT_STATUS_CHANGED' | 'TRANSACTION_UPDATED' | 'TRANSACTION_CREATED';
|
|
443
|
-
interface TransactionStatusChangedEvent {
|
|
444
|
-
/** Order details (limited to 30 items). */
|
|
445
|
-
order?: Order;
|
|
446
|
-
/** New transaction details. */
|
|
447
|
-
transaction?: Transaction;
|
|
448
|
-
/** Previous transaction status. */
|
|
449
|
-
previousStatus?: TransactionStatusWithLiterals;
|
|
450
|
-
}
|
|
451
|
-
interface Order {
|
|
452
|
-
_id?: string;
|
|
453
|
-
/** Wix app order ID */
|
|
454
|
-
wixAppOrderId?: string;
|
|
455
|
-
/** Wix app buyer ID */
|
|
456
|
-
wixAppBuyerId?: string | null;
|
|
457
|
-
/** Items included in the order */
|
|
458
|
-
items?: OrderItem[];
|
|
459
|
-
/**
|
|
460
|
-
* total number of items in order
|
|
461
|
-
* items_total_count > `items`.size if `items` doesn't contain all items
|
|
462
|
-
*/
|
|
463
|
-
itemsTotalCount?: number;
|
|
464
|
-
/** Additional charges to the order - e.g., tax, shipping or discount (optional) */
|
|
465
|
-
additionalCharges?: OrderAdditionalCharges;
|
|
466
|
-
/** Customer's shipping address (optional) */
|
|
467
|
-
shippingAddress?: Address;
|
|
468
|
-
/** Customer's shipping address details (optional) */
|
|
469
|
-
shippingAddressContacts?: FullAddressContactDetails;
|
|
470
|
-
/** Order creation date */
|
|
471
|
-
createdAt?: Date | null;
|
|
472
|
-
/** External data which is stored with the order */
|
|
473
|
-
externalData?: Record<string, string>;
|
|
474
|
-
/**
|
|
475
|
-
* Vertical invoice ID
|
|
476
|
-
* @maxLength 200
|
|
477
|
-
*/
|
|
478
|
-
verticalInvoiceId?: string | null;
|
|
479
|
-
/** the part of total amount taken by platform from the amount sent to merchant */
|
|
480
|
-
platformFee?: number | null;
|
|
481
|
-
}
|
|
482
|
-
/** Item included in order */
|
|
483
|
-
interface OrderItem {
|
|
484
|
-
/** Order item ID (required) */
|
|
485
|
-
_id?: string;
|
|
486
|
-
/** Order item name (required) */
|
|
487
|
-
name?: string;
|
|
488
|
-
/** Quantity (required) */
|
|
489
|
-
quantity?: number;
|
|
490
|
-
/** Total price charged for this item in the order - quantity * price (required) */
|
|
491
|
-
price?: number;
|
|
492
|
-
/** Order item description */
|
|
493
|
-
description?: string;
|
|
494
|
-
/** Weight of one item */
|
|
495
|
-
weightInKg?: number;
|
|
496
|
-
/** Whether the item is a physical a digital product */
|
|
497
|
-
category?: OrderItemCategoryWithLiterals;
|
|
498
|
-
}
|
|
499
|
-
/** Order item type */
|
|
500
|
-
declare enum OrderItemCategory {
|
|
501
|
-
UNDEFINED = "UNDEFINED",
|
|
502
|
-
/** Physical product */
|
|
503
|
-
PHYSICAL = "PHYSICAL",
|
|
504
|
-
/** Digital product */
|
|
505
|
-
DIGITAL = "DIGITAL"
|
|
506
|
-
}
|
|
507
|
-
/** @enumType */
|
|
508
|
-
type OrderItemCategoryWithLiterals = OrderItemCategory | 'UNDEFINED' | 'PHYSICAL' | 'DIGITAL';
|
|
509
|
-
/** Describing any additional charges in the order. They are not required, but can't be added later. */
|
|
510
|
-
interface OrderAdditionalCharges {
|
|
511
|
-
/** Absolute taxes charged to the order */
|
|
512
|
-
tax?: number;
|
|
513
|
-
/** Shipping cost charged to the order */
|
|
514
|
-
shipping?: number;
|
|
515
|
-
/** Discount amount applied to the order */
|
|
516
|
-
discount?: number;
|
|
517
|
-
/**
|
|
518
|
-
* Application fee
|
|
519
|
-
* @deprecated Application fee
|
|
520
|
-
* @replacedBy order.platform_fee
|
|
521
|
-
* @targetRemovalDate 2025-12-01
|
|
522
|
-
*/
|
|
523
|
-
applicationFee?: number;
|
|
524
|
-
}
|
|
525
|
-
/** Physical address */
|
|
526
|
-
interface Address extends AddressStreetOneOf {
|
|
527
|
-
/** Street name and number. */
|
|
528
|
-
streetAddress?: StreetAddress;
|
|
529
|
-
/** Main address line, usually street and number as free text. */
|
|
530
|
-
addressLine1?: string | null;
|
|
531
|
-
/**
|
|
532
|
-
* Country code.
|
|
533
|
-
* @format COUNTRY
|
|
534
|
-
*/
|
|
535
|
-
country?: string | null;
|
|
536
|
-
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
537
|
-
subdivision?: string | null;
|
|
538
|
-
/** City name. */
|
|
539
|
-
city?: string | null;
|
|
540
|
-
/** Zip/postal code. */
|
|
541
|
-
postalCode?: string | null;
|
|
542
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
543
|
-
addressLine2?: string | null;
|
|
544
|
-
}
|
|
545
|
-
/** @oneof */
|
|
546
|
-
interface AddressStreetOneOf {
|
|
547
|
-
/** Street name and number. */
|
|
548
|
-
streetAddress?: StreetAddress;
|
|
549
|
-
/** Main address line, usually street and number as free text. */
|
|
550
|
-
addressLine?: string | null;
|
|
551
|
-
}
|
|
552
|
-
interface StreetAddress {
|
|
553
|
-
/** Street number. */
|
|
554
|
-
number?: string;
|
|
555
|
-
/** Street name. */
|
|
556
|
-
name?: string;
|
|
557
|
-
}
|
|
558
|
-
interface AddressLocation {
|
|
559
|
-
/** Address latitude. */
|
|
560
|
-
latitude?: number | null;
|
|
561
|
-
/** Address longitude. */
|
|
562
|
-
longitude?: number | null;
|
|
563
|
-
}
|
|
564
|
-
interface Subdivision {
|
|
565
|
-
/** Short subdivision code. */
|
|
566
|
-
code?: string;
|
|
567
|
-
/** Subdivision full name. */
|
|
568
|
-
name?: string;
|
|
569
|
-
}
|
|
570
|
-
declare enum SubdivisionType {
|
|
571
|
-
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
572
|
-
/** State */
|
|
573
|
-
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
574
|
-
/** County */
|
|
575
|
-
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
576
|
-
/** City/town */
|
|
577
|
-
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
578
|
-
/** Neighborhood/quarter */
|
|
579
|
-
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
580
|
-
/** Street/block */
|
|
581
|
-
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
582
|
-
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
583
|
-
COUNTRY = "COUNTRY"
|
|
584
|
-
}
|
|
585
|
-
/** @enumType */
|
|
586
|
-
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
587
|
-
/** Subdivision Concordance values */
|
|
588
|
-
interface StandardDetails {
|
|
589
|
-
/**
|
|
590
|
-
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
|
|
591
|
-
* @maxLength 20
|
|
592
|
-
*/
|
|
593
|
-
iso31662?: string | null;
|
|
594
|
-
}
|
|
595
|
-
/** Full contact details for an address */
|
|
596
|
-
interface FullAddressContactDetails {
|
|
597
|
-
/** Contact's first name. */
|
|
598
|
-
firstName?: string | null;
|
|
599
|
-
/** Contact's last name. */
|
|
600
|
-
lastName?: string | null;
|
|
601
|
-
/**
|
|
602
|
-
* Contact's phone number.
|
|
603
|
-
* @format PHONE
|
|
604
|
-
*/
|
|
605
|
-
phone?: string | null;
|
|
606
|
-
/** Contact's company name. */
|
|
607
|
-
company?: string | null;
|
|
608
|
-
/**
|
|
609
|
-
* Email associated with the address.
|
|
610
|
-
* @format EMAIL
|
|
611
|
-
*/
|
|
612
|
-
email?: string | null;
|
|
613
|
-
/** Tax info. Currently usable only in Brazil. */
|
|
614
|
-
vatId?: VatId;
|
|
615
|
-
}
|
|
616
|
-
interface VatId {
|
|
617
|
-
/** Customer's tax ID. */
|
|
618
|
-
_id?: string;
|
|
619
|
-
/**
|
|
620
|
-
* Tax type.
|
|
621
|
-
*
|
|
622
|
-
* Supported values:
|
|
623
|
-
* + `CPF`: for individual tax payers
|
|
624
|
-
* + `CNPJ`: for corporations
|
|
625
|
-
*/
|
|
626
|
-
type?: VatTypeWithLiterals;
|
|
627
|
-
}
|
|
628
|
-
/** tax info types */
|
|
629
|
-
declare enum VatType {
|
|
630
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
631
|
-
/** CPF - for individual tax payers. */
|
|
632
|
-
CPF = "CPF",
|
|
633
|
-
/** CNPJ - for corporations */
|
|
634
|
-
CNPJ = "CNPJ"
|
|
635
|
-
}
|
|
636
|
-
/** @enumType */
|
|
637
|
-
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
638
|
-
interface Transaction extends TransactionPaymentMethodDataOneOf {
|
|
639
|
-
creditCardPaymentMethodData?: CreditCardPaymentMethodData;
|
|
640
|
-
/** Transaction ID */
|
|
641
|
-
_id?: string;
|
|
642
|
-
/** Provider transaction ID */
|
|
643
|
-
providerTransactionId?: string | null;
|
|
644
|
-
/** Amount and currency of transaction */
|
|
645
|
-
amount?: CurrencyAmount;
|
|
646
|
-
/** Refunded amount and currency of transaction */
|
|
647
|
-
refundedAmount?: CurrencyAmount;
|
|
648
|
-
/** Updated transaction status */
|
|
649
|
-
status?: TransactionStatusWithLiterals;
|
|
650
|
-
/** Reason provided for status change */
|
|
651
|
-
reasonCode?: string | null;
|
|
652
|
-
/** Payment method */
|
|
653
|
-
paymentMethod?: string;
|
|
654
|
-
/** Payment service provider */
|
|
655
|
-
paymentProvider?: string;
|
|
656
|
-
/** Customer's billing address (optional) */
|
|
657
|
-
billingAddress?: Address;
|
|
658
|
-
/** Customer's billing address - contact details (optional) */
|
|
659
|
-
billingAddressContacts?: FullAddressContactDetails;
|
|
660
|
-
/** Details of subscription, which (if) the transaction is a part of */
|
|
661
|
-
recurringPaymentDetails?: RecurringPaymentDetails;
|
|
662
|
-
/** The details of a payment method account. */
|
|
663
|
-
paymentMethodAccountInfo?: AccountInfo;
|
|
664
|
-
/** Transaction creation date */
|
|
665
|
-
createdAt?: Date | null;
|
|
666
|
-
/** Total number of installments */
|
|
667
|
-
installments?: number;
|
|
668
|
-
/** Scheduled action for this transaction */
|
|
669
|
-
scheduledAction?: ScheduledAction;
|
|
670
|
-
/**
|
|
671
|
-
* order id associated with the transaction on the vertical side
|
|
672
|
-
* @minLength 1
|
|
673
|
-
* @maxLength 100
|
|
674
|
-
*/
|
|
675
|
-
verticalOrderId?: string | null;
|
|
676
|
-
}
|
|
677
|
-
/** @oneof */
|
|
678
|
-
interface TransactionPaymentMethodDataOneOf {
|
|
679
|
-
creditCardPaymentMethodData?: CreditCardPaymentMethodData;
|
|
680
|
-
}
|
|
681
|
-
interface CurrencyAmount {
|
|
682
|
-
/** Amount */
|
|
683
|
-
amount?: number;
|
|
684
|
-
currency?: string;
|
|
685
|
-
}
|
|
686
|
-
declare enum TransactionStatus {
|
|
687
|
-
UNDEFINED = "UNDEFINED",
|
|
688
|
-
APPROVED = "APPROVED",
|
|
689
|
-
PENDING = "PENDING",
|
|
690
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
691
|
-
CANCELED = "CANCELED",
|
|
692
|
-
DECLINED = "DECLINED",
|
|
693
|
-
REFUNDED = "REFUNDED",
|
|
694
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
695
|
-
AUTHORIZED = "AUTHORIZED",
|
|
696
|
-
VOIDED = "VOIDED"
|
|
697
|
-
}
|
|
698
|
-
/** @enumType */
|
|
699
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
700
|
-
interface RecurringPaymentDetails {
|
|
701
|
-
/** Current cycle number (Recurring payments only) */
|
|
702
|
-
cycleNumber?: number;
|
|
703
|
-
}
|
|
704
|
-
interface CreditCardPaymentMethodData {
|
|
705
|
-
/** Card issuing network */
|
|
706
|
-
network?: string;
|
|
707
|
-
/** Card number with only bin and last4 positions showed (non-PCI data) */
|
|
708
|
-
maskedCreditCard?: string;
|
|
709
|
-
/** Card holder's full name specified on the card. */
|
|
710
|
-
holderName?: string;
|
|
711
|
-
/** Card expiration month. */
|
|
712
|
-
expiryMonth?: string;
|
|
713
|
-
/**
|
|
714
|
-
* Card expiration year.
|
|
715
|
-
* @minLength 4
|
|
716
|
-
* @maxLength 4
|
|
717
|
-
*/
|
|
718
|
-
expiryYear?: string | null;
|
|
719
|
-
/**
|
|
720
|
-
* Card last 4 digits.
|
|
721
|
-
* @minLength 4
|
|
722
|
-
* @maxLength 4
|
|
723
|
-
*/
|
|
724
|
-
lastFourDigits?: string | null;
|
|
725
|
-
/**
|
|
726
|
-
* Card BIN (Bank Identification Number). It's the first 4-8 digits of a card number.
|
|
727
|
-
* @minLength 4
|
|
728
|
-
* @maxLength 8
|
|
729
|
-
*/
|
|
730
|
-
bin?: string | null;
|
|
731
|
-
}
|
|
732
|
-
interface AccountInfo {
|
|
733
|
-
/**
|
|
734
|
-
* The email of an Account used by Payment Method
|
|
735
|
-
* @format EMAIL
|
|
736
|
-
*/
|
|
737
|
-
email?: string | null;
|
|
738
|
-
}
|
|
739
|
-
interface ScheduledAction {
|
|
740
|
-
/** type of the action */
|
|
741
|
-
type?: ScheduledActionTypeWithLiterals;
|
|
742
|
-
/** the date and time of the action */
|
|
743
|
-
executionDate?: Date | null;
|
|
744
|
-
}
|
|
745
|
-
declare enum ScheduledActionType {
|
|
746
|
-
VOID = "VOID",
|
|
747
|
-
CAPTURE = "CAPTURE"
|
|
748
|
-
}
|
|
749
|
-
/** @enumType */
|
|
750
|
-
type ScheduledActionTypeWithLiterals = ScheduledActionType | 'VOID' | 'CAPTURE';
|
|
751
|
-
interface RefundStatusChangedEvent {
|
|
752
|
-
/** Order details (limited to 30 items). */
|
|
753
|
-
order?: Order;
|
|
754
|
-
/** Updated transaction details. */
|
|
755
|
-
transaction?: Transaction;
|
|
756
|
-
/** Updated refund details. */
|
|
757
|
-
refund?: Refund;
|
|
758
|
-
/** Previous refund status. */
|
|
759
|
-
previousStatus?: RefundStatusWithLiterals;
|
|
760
|
-
}
|
|
761
|
-
interface Refund {
|
|
762
|
-
_id?: string;
|
|
763
|
-
/** Amount and currency of refund */
|
|
764
|
-
amount?: CurrencyAmount;
|
|
765
|
-
/** Updated refund status */
|
|
766
|
-
status?: RefundStatusWithLiterals;
|
|
767
|
-
/** Reason provided for status change */
|
|
768
|
-
reasonCode?: string | null;
|
|
769
|
-
/** Refund creation date */
|
|
770
|
-
createdAt?: Date | null;
|
|
771
|
-
}
|
|
772
|
-
declare enum RefundStatus {
|
|
773
|
-
UNDEFINED = "UNDEFINED",
|
|
774
|
-
APPROVED = "APPROVED",
|
|
775
|
-
PENDING = "PENDING",
|
|
776
|
-
DECLINED = "DECLINED"
|
|
777
|
-
}
|
|
778
|
-
/** @enumType */
|
|
779
|
-
type RefundStatusWithLiterals = RefundStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'DECLINED';
|
|
780
|
-
interface RecurringPaymentStatusChangedEvent {
|
|
781
|
-
/** Order details(limited to 30 items). */
|
|
782
|
-
order?: Order;
|
|
783
|
-
/** Recurring payment status. */
|
|
784
|
-
status?: StatusWithLiterals;
|
|
785
|
-
/** Previous recurring payment status. */
|
|
786
|
-
previousStatus?: StatusWithLiterals;
|
|
787
|
-
/** Details of RecurringPayment cancellation (empty if `status` is not CANCELLED). */
|
|
788
|
-
cancellationDetails?: RecurringPaymentCancellationDetails;
|
|
789
|
-
}
|
|
790
|
-
declare enum Status {
|
|
791
|
-
UNDEFINED = "UNDEFINED",
|
|
792
|
-
PENDING = "PENDING",
|
|
793
|
-
ACTIVE = "ACTIVE",
|
|
794
|
-
CANCELLED = "CANCELLED",
|
|
795
|
-
FINISHED = "FINISHED",
|
|
796
|
-
SUSPENDED = "SUSPENDED"
|
|
797
|
-
}
|
|
798
|
-
/** @enumType */
|
|
799
|
-
type StatusWithLiterals = Status | 'UNDEFINED' | 'PENDING' | 'ACTIVE' | 'CANCELLED' | 'FINISHED' | 'SUSPENDED';
|
|
800
|
-
interface RecurringPaymentCancellationDetails {
|
|
801
|
-
/** Initiator of cancellation */
|
|
802
|
-
initiator?: InitiatorWithLiterals;
|
|
803
|
-
/** Successfully paid recurring cycles count before the cancellation */
|
|
804
|
-
paidRegularCycleCount?: number;
|
|
805
|
-
}
|
|
806
|
-
declare enum Initiator {
|
|
807
|
-
UNDEFINED = "UNDEFINED",
|
|
808
|
-
BUYER = "BUYER",
|
|
809
|
-
MERCHANT = "MERCHANT",
|
|
810
|
-
PAYMENT = "PAYMENT",
|
|
811
|
-
SETUP = "SETUP"
|
|
812
|
-
}
|
|
813
|
-
/** @enumType */
|
|
814
|
-
type InitiatorWithLiterals = Initiator | 'UNDEFINED' | 'BUYER' | 'MERCHANT' | 'PAYMENT' | 'SETUP';
|
|
815
|
-
interface TransactionUpdatedEvent {
|
|
816
|
-
/** Order details (limited to 30 items). */
|
|
817
|
-
order?: Order;
|
|
818
|
-
/** Updated transaction details. */
|
|
819
|
-
transaction?: Transaction;
|
|
820
|
-
/** Is event triggered by request to clean user data */
|
|
821
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
822
|
-
}
|
|
823
|
-
interface TransactionCreatedEvent {
|
|
824
|
-
/** Order details (limited to 30 items). */
|
|
825
|
-
order?: Order;
|
|
826
|
-
/** Updated transaction details. */
|
|
827
|
-
transaction?: Transaction;
|
|
828
|
-
}
|
|
829
|
-
interface Empty {
|
|
830
|
-
}
|
|
831
|
-
interface OfflinePaymentSent {
|
|
832
|
-
/** Participant who started offline payment */
|
|
833
|
-
participant?: Participant;
|
|
834
|
-
}
|
|
835
|
-
interface PaymentFailed {
|
|
836
|
-
/** Participant whose payment was failed */
|
|
837
|
-
participant?: Participant;
|
|
838
|
-
}
|
|
839
|
-
interface SinglePaymentConfirmed {
|
|
840
|
-
/** Participant whose payment was confirmed */
|
|
841
|
-
participant?: Participant;
|
|
842
|
-
}
|
|
843
|
-
interface SinglePaymentDeclined {
|
|
844
|
-
/** Participant whose payment was declined */
|
|
845
|
-
participant?: Participant;
|
|
846
|
-
}
|
|
847
403
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
848
404
|
createdEvent?: EntityCreatedEvent;
|
|
849
405
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -906,6 +462,8 @@ interface EntityDeletedEvent {
|
|
|
906
462
|
interface ActionEvent {
|
|
907
463
|
body?: string;
|
|
908
464
|
}
|
|
465
|
+
interface Empty {
|
|
466
|
+
}
|
|
909
467
|
interface BenefitNotification {
|
|
910
468
|
/**
|
|
911
469
|
* Plan unique ID
|
|
@@ -1117,14 +675,6 @@ interface ItemMetadata {
|
|
|
1117
675
|
/** Details about the error in case of failure. */
|
|
1118
676
|
error?: ApplicationError;
|
|
1119
677
|
}
|
|
1120
|
-
interface ApplicationError {
|
|
1121
|
-
/** Error code. */
|
|
1122
|
-
code?: string;
|
|
1123
|
-
/** Description of the error. */
|
|
1124
|
-
description?: string;
|
|
1125
|
-
/** Data related to the error. */
|
|
1126
|
-
data?: Record<string, any> | null;
|
|
1127
|
-
}
|
|
1128
678
|
interface BulkInviteToProgramResult {
|
|
1129
679
|
/** Invited participant metadata. */
|
|
1130
680
|
itemMetadata?: ItemMetadata;
|
|
@@ -1196,35 +746,6 @@ interface BulkAddToProgramResult {
|
|
|
1196
746
|
/** Added participant */
|
|
1197
747
|
item?: Participant;
|
|
1198
748
|
}
|
|
1199
|
-
interface ParticipantAdded {
|
|
1200
|
-
/**
|
|
1201
|
-
* Program ID which participant was added
|
|
1202
|
-
* @format GUID
|
|
1203
|
-
*/
|
|
1204
|
-
programId?: string;
|
|
1205
|
-
/**
|
|
1206
|
-
* Member ID of participant on site
|
|
1207
|
-
* @format GUID
|
|
1208
|
-
*/
|
|
1209
|
-
memberId?: string;
|
|
1210
|
-
}
|
|
1211
|
-
interface BulkAddAllToProgramRequest {
|
|
1212
|
-
/**
|
|
1213
|
-
* Program to which bulk add participants.
|
|
1214
|
-
* @format GUID
|
|
1215
|
-
*/
|
|
1216
|
-
programId: string;
|
|
1217
|
-
/**
|
|
1218
|
-
* Exclude site members.
|
|
1219
|
-
* @format GUID
|
|
1220
|
-
* @maxSize 100
|
|
1221
|
-
*/
|
|
1222
|
-
excludeMemberIds?: string[];
|
|
1223
|
-
}
|
|
1224
|
-
interface BulkAddAllToProgramResponse {
|
|
1225
|
-
/** Bulk action metadata. */
|
|
1226
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1227
|
-
}
|
|
1228
749
|
interface BulkApproveParticipantRequest {
|
|
1229
750
|
/**
|
|
1230
751
|
* Participants to add
|
|
@@ -1284,61 +805,6 @@ interface BulkApproveAllParticipantResponse {
|
|
|
1284
805
|
*/
|
|
1285
806
|
jobId?: string;
|
|
1286
807
|
}
|
|
1287
|
-
interface DeleteParticipantRequest {
|
|
1288
|
-
/**
|
|
1289
|
-
* Participants to delete
|
|
1290
|
-
* @format GUID
|
|
1291
|
-
*/
|
|
1292
|
-
participantId: string;
|
|
1293
|
-
}
|
|
1294
|
-
interface DeleteParticipantResponse {
|
|
1295
|
-
}
|
|
1296
|
-
interface ParticipantRejected {
|
|
1297
|
-
/**
|
|
1298
|
-
* Program ID which participant rejected
|
|
1299
|
-
* @format GUID
|
|
1300
|
-
*/
|
|
1301
|
-
programId?: string;
|
|
1302
|
-
/**
|
|
1303
|
-
* Member ID of participant rejected
|
|
1304
|
-
* @format GUID
|
|
1305
|
-
*/
|
|
1306
|
-
memberId?: string;
|
|
1307
|
-
}
|
|
1308
|
-
interface IssueCertificateRequest {
|
|
1309
|
-
/**
|
|
1310
|
-
* Participant to get certificate
|
|
1311
|
-
* @format GUID
|
|
1312
|
-
*/
|
|
1313
|
-
participantId: string;
|
|
1314
|
-
}
|
|
1315
|
-
interface IssueCertificateResponse {
|
|
1316
|
-
/** Updated participant */
|
|
1317
|
-
participant?: Participant;
|
|
1318
|
-
}
|
|
1319
|
-
interface GetCompletionStatsRequest {
|
|
1320
|
-
/**
|
|
1321
|
-
* program id to get stats for
|
|
1322
|
-
* @format GUID
|
|
1323
|
-
*/
|
|
1324
|
-
programId: string;
|
|
1325
|
-
}
|
|
1326
|
-
interface GetCompletionStatsResponse {
|
|
1327
|
-
/** Number of participants that completed the program */
|
|
1328
|
-
completedAll?: number;
|
|
1329
|
-
/** Percentage of participants that completed the program */
|
|
1330
|
-
completionRate?: number;
|
|
1331
|
-
}
|
|
1332
|
-
interface GetPremiumStatsRequest {
|
|
1333
|
-
}
|
|
1334
|
-
interface GetPremiumStatsResponse {
|
|
1335
|
-
/** True if site has Online Programs premium feature */
|
|
1336
|
-
hasPremium?: boolean;
|
|
1337
|
-
/** Count of active participants on the site */
|
|
1338
|
-
activeParticipantsCount?: number;
|
|
1339
|
-
/** Limit of active participants on a site without premium */
|
|
1340
|
-
activeParticipantsLimit?: number;
|
|
1341
|
-
}
|
|
1342
808
|
interface ExportParticipantsStatsRequest {
|
|
1343
809
|
/**
|
|
1344
810
|
* program id to export data from
|
|
@@ -1411,45 +877,6 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1411
877
|
*/
|
|
1412
878
|
entityEventSequence?: string | null;
|
|
1413
879
|
}
|
|
1414
|
-
interface ParticipantJoinedEnvelope {
|
|
1415
|
-
data: ParticipantJoined;
|
|
1416
|
-
metadata: EventMetadata;
|
|
1417
|
-
}
|
|
1418
|
-
/** @permissionScope Manage Challenges
|
|
1419
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1420
|
-
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
1421
|
-
* @webhook
|
|
1422
|
-
* @eventType wix.online_programs.v3.participant_participant_joined
|
|
1423
|
-
* @serviceIdentifier wix.onlineprograms.participants.v3.ParticipantsService
|
|
1424
|
-
* @slug participant_joined
|
|
1425
|
-
* @documentationMaturity preview
|
|
1426
|
-
*/
|
|
1427
|
-
declare function onParticipantJoined(handler: (event: ParticipantJoinedEnvelope) => void | Promise<void>): void;
|
|
1428
|
-
interface ParticipantLeftEnvelope {
|
|
1429
|
-
data: ParticipantLeft;
|
|
1430
|
-
metadata: EventMetadata;
|
|
1431
|
-
}
|
|
1432
|
-
/** @permissionScope Manage Challenges
|
|
1433
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1434
|
-
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
1435
|
-
* @webhook
|
|
1436
|
-
* @eventType wix.online_programs.v3.participant_participant_left
|
|
1437
|
-
* @serviceIdentifier wix.onlineprograms.participants.v3.ParticipantsService
|
|
1438
|
-
* @slug participant_left
|
|
1439
|
-
* @documentationMaturity preview
|
|
1440
|
-
*/
|
|
1441
|
-
declare function onParticipantLeft(handler: (event: ParticipantLeftEnvelope) => void | Promise<void>): void;
|
|
1442
|
-
interface ParticipantDeletedEnvelope {
|
|
1443
|
-
entity: Participant;
|
|
1444
|
-
metadata: EventMetadata;
|
|
1445
|
-
}
|
|
1446
|
-
/** @webhook
|
|
1447
|
-
* @eventType wix.online_programs.v3.participant_deleted
|
|
1448
|
-
* @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
|
|
1449
|
-
* @slug deleted
|
|
1450
|
-
* @documentationMaturity preview
|
|
1451
|
-
*/
|
|
1452
|
-
declare function onParticipantDeleted(handler: (event: ParticipantDeletedEnvelope) => void | Promise<void>): void;
|
|
1453
880
|
interface ParticipantAddedEnvelope {
|
|
1454
881
|
data: ParticipantAdded;
|
|
1455
882
|
metadata: EventMetadata;
|
|
@@ -1458,9 +885,8 @@ interface ParticipantAddedEnvelope {
|
|
|
1458
885
|
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1459
886
|
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
1460
887
|
* @webhook
|
|
1461
|
-
* @eventType wix.online_programs.v3.
|
|
1462
|
-
* @
|
|
1463
|
-
* @slug participant_added
|
|
888
|
+
* @eventType wix.online_programs.v3.participant_added
|
|
889
|
+
* @slug added
|
|
1464
890
|
* @documentationMaturity preview
|
|
1465
891
|
*/
|
|
1466
892
|
declare function onParticipantAdded(handler: (event: ParticipantAddedEnvelope) => void | Promise<void>): void;
|
|
@@ -1492,58 +918,105 @@ interface ParticipantInvitedEnvelope {
|
|
|
1492
918
|
* @documentationMaturity preview
|
|
1493
919
|
*/
|
|
1494
920
|
declare function onParticipantInvited(handler: (event: ParticipantInvitedEnvelope) => void | Promise<void>): void;
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
* @
|
|
1501
|
-
* @
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
*
|
|
921
|
+
/** @param participant - Participant to create
|
|
922
|
+
* @public
|
|
923
|
+
* @documentationMaturity preview
|
|
924
|
+
* @requiredField participant
|
|
925
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_CREATE
|
|
926
|
+
* @returns Created participant
|
|
927
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.CreateParticipant
|
|
928
|
+
*/
|
|
929
|
+
declare function createParticipant(participant: Participant): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 3>>;
|
|
930
|
+
/**
|
|
931
|
+
* Creates participants in bulk.
|
|
932
|
+
* @param participants - List of participants you want to create
|
|
933
|
+
* @public
|
|
1506
934
|
* @documentationMaturity preview
|
|
935
|
+
* @requiredField participants
|
|
936
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_CREATE
|
|
937
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipant
|
|
1507
938
|
*/
|
|
1508
|
-
declare function
|
|
939
|
+
declare function bulkCreateParticipant(participants: Participant[], options?: BulkCreateParticipantOptions): Promise<NonNullablePaths<BulkCreateParticipantResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
940
|
+
interface BulkCreateParticipantOptions {
|
|
941
|
+
/** Whether to return entities in response or not. */
|
|
942
|
+
returnEntity?: boolean;
|
|
943
|
+
}
|
|
1509
944
|
/**
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
945
|
+
* Bulk adds all site members to program, but not more then 1000.
|
|
946
|
+
* Participant will be either created in state Joined, or updated to that state
|
|
947
|
+
* from pending one.
|
|
948
|
+
* @param programId - Program to which bulk add participants.
|
|
1513
949
|
* @public
|
|
1514
950
|
* @documentationMaturity preview
|
|
1515
951
|
* @requiredField programId
|
|
1516
|
-
* @permissionId ONLINE_PROGRAMS.
|
|
952
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1517
953
|
* @applicableIdentity APP
|
|
1518
|
-
* @
|
|
1519
|
-
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.JoinProgram
|
|
954
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkAddAllToProgram
|
|
1520
955
|
*/
|
|
1521
|
-
declare function
|
|
956
|
+
declare function bulkAddAllToProgram(programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `jobId`, 2>>;
|
|
957
|
+
interface BulkAddAllToProgramOptions {
|
|
958
|
+
/**
|
|
959
|
+
* Exclude site members.
|
|
960
|
+
* @format GUID
|
|
961
|
+
* @maxSize 100
|
|
962
|
+
*/
|
|
963
|
+
excludeMemberIds?: string[];
|
|
964
|
+
}
|
|
1522
965
|
/**
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
966
|
+
* Delete participant from program. Removes participant from member
|
|
967
|
+
* group. Leaves him in Social Group.
|
|
968
|
+
* @param participantId - Participants to delete
|
|
1525
969
|
* @public
|
|
1526
970
|
* @documentationMaturity preview
|
|
1527
971
|
* @requiredField participantId
|
|
1528
|
-
* @permissionId ONLINE_PROGRAMS.
|
|
972
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_DELETE
|
|
973
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.DeleteParticipant
|
|
974
|
+
*/
|
|
975
|
+
declare function deleteParticipant(participantId: string): Promise<void>;
|
|
976
|
+
/**
|
|
977
|
+
* Issue certificate by site admin
|
|
978
|
+
* @param participantId - Participant to get certificate
|
|
979
|
+
* @public
|
|
980
|
+
* @documentationMaturity preview
|
|
981
|
+
* @requiredField participantId
|
|
982
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
|
|
1529
983
|
* @applicableIdentity APP
|
|
1530
|
-
* @
|
|
1531
|
-
* @returns existing participant
|
|
1532
|
-
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
|
|
984
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.IssueCertificate
|
|
1533
985
|
*/
|
|
1534
|
-
declare function
|
|
986
|
+
declare function issueCertificate(participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId`, 4>>;
|
|
1535
987
|
/**
|
|
1536
|
-
*
|
|
1537
|
-
* @param
|
|
988
|
+
* Get program's completion stats
|
|
989
|
+
* @param programId - program id to get stats for
|
|
990
|
+
* @public
|
|
991
|
+
* @documentationMaturity preview
|
|
992
|
+
* @requiredField programId
|
|
993
|
+
* @permissionId ONLINE_PROGRAMS.STATS_READ
|
|
994
|
+
* @applicableIdentity APP
|
|
995
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetCompletionStats
|
|
996
|
+
*/
|
|
997
|
+
declare function getCompletionStats(programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
|
|
998
|
+
/**
|
|
999
|
+
* Get premium stats
|
|
1000
|
+
* @public
|
|
1001
|
+
* @documentationMaturity preview
|
|
1002
|
+
* @permissionId ONLINE_PROGRAMS.STATS_READ
|
|
1003
|
+
* @applicableIdentity APP
|
|
1004
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetPremiumStats
|
|
1005
|
+
*/
|
|
1006
|
+
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
|
|
1007
|
+
/**
|
|
1008
|
+
* Returns participant.
|
|
1009
|
+
* @param participantId - Participant id to fetch
|
|
1538
1010
|
* @public
|
|
1539
1011
|
* @documentationMaturity preview
|
|
1540
1012
|
* @requiredField participantId
|
|
1541
|
-
* @permissionId ONLINE_PROGRAMS.
|
|
1013
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
1542
1014
|
* @applicableIdentity APP
|
|
1543
1015
|
* @applicableIdentity MEMBER
|
|
1544
|
-
* @
|
|
1016
|
+
* @returns existing participant
|
|
1017
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
|
|
1545
1018
|
*/
|
|
1546
|
-
declare function
|
|
1019
|
+
declare function getParticipant(participantId: string): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 3>>;
|
|
1547
1020
|
/**
|
|
1548
1021
|
* Query existing participants
|
|
1549
1022
|
* @public
|
|
@@ -1577,32 +1050,32 @@ interface ParticipantsQueryBuilder {
|
|
|
1577
1050
|
* @param value - Value to compare against.
|
|
1578
1051
|
* @documentationMaturity preview
|
|
1579
1052
|
*/
|
|
1580
|
-
ge: (propertyName: '
|
|
1053
|
+
ge: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
|
|
1581
1054
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1582
1055
|
* @param value - Value to compare against.
|
|
1583
1056
|
* @documentationMaturity preview
|
|
1584
1057
|
*/
|
|
1585
|
-
gt: (propertyName: '
|
|
1058
|
+
gt: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
|
|
1586
1059
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1587
1060
|
* @param value - Value to compare against.
|
|
1588
1061
|
* @documentationMaturity preview
|
|
1589
1062
|
*/
|
|
1590
|
-
le: (propertyName: '
|
|
1063
|
+
le: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
|
|
1591
1064
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1592
1065
|
* @param value - Value to compare against.
|
|
1593
1066
|
* @documentationMaturity preview
|
|
1594
1067
|
*/
|
|
1595
|
-
lt: (propertyName: '
|
|
1068
|
+
lt: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
|
|
1596
1069
|
/** @documentationMaturity preview */
|
|
1597
1070
|
in: (propertyName: '_id' | 'memberId' | 'state', value: any) => ParticipantsQueryBuilder;
|
|
1598
1071
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1599
1072
|
* @documentationMaturity preview
|
|
1600
1073
|
*/
|
|
1601
|
-
ascending: (...propertyNames: Array<'
|
|
1074
|
+
ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'joinedInfo.startDate'>) => ParticipantsQueryBuilder;
|
|
1602
1075
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1603
1076
|
* @documentationMaturity preview
|
|
1604
1077
|
*/
|
|
1605
|
-
descending: (...propertyNames: Array<'
|
|
1078
|
+
descending: (...propertyNames: Array<'_id' | '_createdDate' | 'state' | 'joinedInfo.startDate'>) => ParticipantsQueryBuilder;
|
|
1606
1079
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1607
1080
|
* @documentationMaturity preview
|
|
1608
1081
|
*/
|
|
@@ -1614,6 +1087,12 @@ interface ParticipantsQueryBuilder {
|
|
|
1614
1087
|
/** @documentationMaturity preview */
|
|
1615
1088
|
find: () => Promise<ParticipantsQueryResult>;
|
|
1616
1089
|
}
|
|
1090
|
+
/**
|
|
1091
|
+
* @hidden
|
|
1092
|
+
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
|
|
1093
|
+
* @requiredField query
|
|
1094
|
+
*/
|
|
1095
|
+
declare function typedQueryParticipants(query: CursorQuery): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.state` | `participants.${number}.joinedInfo.timeZone` | `participants.${number}.joinedInfo.startDate` | `participants.${number}.joinedInfo.joinPath` | `participants.${number}.member.contactId`, 5>>;
|
|
1617
1096
|
/**
|
|
1618
1097
|
* Get access status
|
|
1619
1098
|
* @public
|
|
@@ -1624,41 +1103,6 @@ interface ParticipantsQueryBuilder {
|
|
|
1624
1103
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetAccessStatus
|
|
1625
1104
|
*/
|
|
1626
1105
|
declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `isBlocked`, 2>>;
|
|
1627
|
-
/**
|
|
1628
|
-
* Apply coupon to order
|
|
1629
|
-
* @public
|
|
1630
|
-
* @documentationMaturity preview
|
|
1631
|
-
* @requiredField identifiers
|
|
1632
|
-
* @requiredField identifiers.couponCode
|
|
1633
|
-
* @requiredField identifiers.participantId
|
|
1634
|
-
* @requiredField orderId
|
|
1635
|
-
* @permissionId ONLINE_PROGRAMS.COUPON_APPLY
|
|
1636
|
-
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.ApplyCoupon
|
|
1637
|
-
*/
|
|
1638
|
-
declare function applyCoupon(identifiers: NonNullablePaths<ApplyCouponIdentifiers, `couponCode` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<ApplyCouponResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
|
|
1639
|
-
interface ApplyCouponIdentifiers {
|
|
1640
|
-
/** @format GUID */
|
|
1641
|
-
participantId: string;
|
|
1642
|
-
couponCode: string;
|
|
1643
|
-
}
|
|
1644
|
-
/**
|
|
1645
|
-
* Remove coupon from order
|
|
1646
|
-
* @public
|
|
1647
|
-
* @documentationMaturity preview
|
|
1648
|
-
* @requiredField identifiers
|
|
1649
|
-
* @requiredField identifiers.couponId
|
|
1650
|
-
* @requiredField identifiers.participantId
|
|
1651
|
-
* @requiredField orderId
|
|
1652
|
-
* @permissionId ONLINE_PROGRAMS.COUPON_REVERT
|
|
1653
|
-
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.RevertCoupon
|
|
1654
|
-
*/
|
|
1655
|
-
declare function revertCoupon(identifiers: NonNullablePaths<RevertCouponIdentifiers, `couponId` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<RevertCouponResponse, `total`, 2>>;
|
|
1656
|
-
interface RevertCouponIdentifiers {
|
|
1657
|
-
/** @format GUID */
|
|
1658
|
-
participantId: string;
|
|
1659
|
-
/** @format GUID */
|
|
1660
|
-
couponId: string;
|
|
1661
|
-
}
|
|
1662
1106
|
/**
|
|
1663
1107
|
* Bulk invites participants to program.
|
|
1664
1108
|
* For each member participant in Invited state is created.
|
|
@@ -1670,7 +1114,7 @@ interface RevertCouponIdentifiers {
|
|
|
1670
1114
|
* @applicableIdentity APP
|
|
1671
1115
|
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkInviteToProgram
|
|
1672
1116
|
*/
|
|
1673
|
-
declare function bulkInviteToProgram(programId: string, options?: BulkInviteToProgramOptions): Promise<NonNullablePaths<BulkInviteToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.
|
|
1117
|
+
declare function bulkInviteToProgram(programId: string, options?: BulkInviteToProgramOptions): Promise<NonNullablePaths<BulkInviteToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
1674
1118
|
interface BulkInviteToProgramOptions {
|
|
1675
1119
|
/**
|
|
1676
1120
|
* Return added participants in the response or not.
|
|
@@ -1714,7 +1158,7 @@ interface BulkInviteAllToProgramOptions {
|
|
|
1714
1158
|
* @applicableIdentity APP
|
|
1715
1159
|
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkAddToProgram
|
|
1716
1160
|
*/
|
|
1717
|
-
declare function bulkAddToProgram(programId: string, options?: BulkAddToProgramOptions): Promise<NonNullablePaths<BulkAddToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.
|
|
1161
|
+
declare function bulkAddToProgram(programId: string, options?: BulkAddToProgramOptions): Promise<NonNullablePaths<BulkAddToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
1718
1162
|
interface BulkAddToProgramOptions {
|
|
1719
1163
|
/**
|
|
1720
1164
|
* Site members.
|
|
@@ -1726,27 +1170,6 @@ interface BulkAddToProgramOptions {
|
|
|
1726
1170
|
/** Return added participants in the response or not. */
|
|
1727
1171
|
returnEntity?: boolean;
|
|
1728
1172
|
}
|
|
1729
|
-
/**
|
|
1730
|
-
* Bulk adds all site members to program, but not more then 1000.
|
|
1731
|
-
* Participant will be either created in state Joined, or updated to that state
|
|
1732
|
-
* from pending one.
|
|
1733
|
-
* @param programId - Program to which bulk add participants.
|
|
1734
|
-
* @public
|
|
1735
|
-
* @documentationMaturity preview
|
|
1736
|
-
* @requiredField programId
|
|
1737
|
-
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1738
|
-
* @applicableIdentity APP
|
|
1739
|
-
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkAddAllToProgram
|
|
1740
|
-
*/
|
|
1741
|
-
declare function bulkAddAllToProgram(programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
|
|
1742
|
-
interface BulkAddAllToProgramOptions {
|
|
1743
|
-
/**
|
|
1744
|
-
* Exclude site members.
|
|
1745
|
-
* @format GUID
|
|
1746
|
-
* @maxSize 100
|
|
1747
|
-
*/
|
|
1748
|
-
excludeMemberIds?: string[];
|
|
1749
|
-
}
|
|
1750
1173
|
/**
|
|
1751
1174
|
* Bulk approves participants, who asked to join private program (aka in
|
|
1752
1175
|
* state `APPROVAL_PENDING`). If participant was in other state, no effect and
|
|
@@ -1758,7 +1181,7 @@ interface BulkAddAllToProgramOptions {
|
|
|
1758
1181
|
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_APPROVE
|
|
1759
1182
|
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkApproveParticipant
|
|
1760
1183
|
*/
|
|
1761
|
-
declare function bulkApproveParticipant(participantIds: string[], options?: BulkApproveParticipantOptions): Promise<NonNullablePaths<BulkApproveParticipantResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.
|
|
1184
|
+
declare function bulkApproveParticipant(participantIds: string[], options?: BulkApproveParticipantOptions): Promise<NonNullablePaths<BulkApproveParticipantResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
1762
1185
|
interface BulkApproveParticipantOptions {
|
|
1763
1186
|
/**
|
|
1764
1187
|
* program to approve participant
|
|
@@ -1790,48 +1213,6 @@ interface BulkApproveAllParticipantOptions {
|
|
|
1790
1213
|
*/
|
|
1791
1214
|
excludeParticipantIds?: string[];
|
|
1792
1215
|
}
|
|
1793
|
-
/**
|
|
1794
|
-
* Delete participant from program by owner will. Removes participant from member
|
|
1795
|
-
* group. Leaves him in Social Group.
|
|
1796
|
-
* @param participantId - Participants to delete
|
|
1797
|
-
* @public
|
|
1798
|
-
* @documentationMaturity preview
|
|
1799
|
-
* @requiredField participantId
|
|
1800
|
-
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_DELETE
|
|
1801
|
-
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.DeleteParticipant
|
|
1802
|
-
*/
|
|
1803
|
-
declare function deleteParticipant(participantId: string): Promise<void>;
|
|
1804
|
-
/**
|
|
1805
|
-
* Issue certificate by site admin
|
|
1806
|
-
* @param participantId - Participant to get certificate
|
|
1807
|
-
* @public
|
|
1808
|
-
* @documentationMaturity preview
|
|
1809
|
-
* @requiredField participantId
|
|
1810
|
-
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
|
|
1811
|
-
* @applicableIdentity APP
|
|
1812
|
-
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.IssueCertificate
|
|
1813
|
-
*/
|
|
1814
|
-
declare function issueCertificate(participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.paymentPendingOptions.paidPlanIds` | `participant.joinedOptions.singlePaymentOptions.orderId` | `participant.joinedOptions.paidPlanOptions.planIds` | `participant.joinedOptions.freeCouponOptions.couponId` | `participant.joinedOptions.timeZone` | `participant.joinedOptions.startDate` | `participant.joinedOptions.joinPath` | `participant.completedOptions.startDate` | `participant.failedOptions.startDate` | `participant.suspendedOptions.startDate` | `participant.autoRemovedOptions.startDate` | `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state`, 5>>;
|
|
1815
|
-
/**
|
|
1816
|
-
* Get program's completion stats
|
|
1817
|
-
* @param programId - program id to get stats for
|
|
1818
|
-
* @public
|
|
1819
|
-
* @documentationMaturity preview
|
|
1820
|
-
* @requiredField programId
|
|
1821
|
-
* @permissionId ONLINE_PROGRAMS.STATS_READ
|
|
1822
|
-
* @applicableIdentity APP
|
|
1823
|
-
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.GetCompletionStats
|
|
1824
|
-
*/
|
|
1825
|
-
declare function getCompletionStats(programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
|
|
1826
|
-
/**
|
|
1827
|
-
* Get premium stats
|
|
1828
|
-
* @public
|
|
1829
|
-
* @documentationMaturity preview
|
|
1830
|
-
* @permissionId ONLINE_PROGRAMS.STATS_READ
|
|
1831
|
-
* @applicableIdentity APP
|
|
1832
|
-
* @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.GetPremiumStats
|
|
1833
|
-
*/
|
|
1834
|
-
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
|
|
1835
1216
|
/**
|
|
1836
1217
|
* Exports data about participants as well as resolved steps in program.
|
|
1837
1218
|
* @param programId - program id to export data from
|
|
@@ -1843,4 +1224,4 @@ declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResp
|
|
|
1843
1224
|
*/
|
|
1844
1225
|
declare function exportParticipantsStats(programId: string): Promise<void>;
|
|
1845
1226
|
|
|
1846
|
-
export { type
|
|
1227
|
+
export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type Behavior, type BehaviorBehaviorOneOf, type Benefit, type BenefitNotification, BenefitType, type BenefitTypeWithLiterals, type BulkActionMetadata, type BulkAddAllToProgramOptions, type BulkAddAllToProgramRequest, type BulkAddAllToProgramResponse, type BulkAddToProgramOptions, type BulkAddToProgramRequest, type BulkAddToProgramResponse, type BulkAddToProgramResult, type BulkApproveAllParticipantOptions, type BulkApproveAllParticipantRequest, type BulkApproveAllParticipantResponse, type BulkApproveParticipantOptions, type BulkApproveParticipantRequest, type BulkApproveParticipantResponse, type BulkApproveParticipantResult, type BulkCreateParticipantOptions, type BulkCreateParticipantRequest, type BulkCreateParticipantResponse, type BulkInviteAllToProgramOptions, type BulkInviteAllToProgramRequest, type BulkInviteAllToProgramResponse, type BulkInviteToProgramOptions, type BulkInviteToProgramRequest, type BulkInviteToProgramResponse, type BulkInviteToProgramResult, type BulkParticipantResult, type Certificate, type CommonBulkActionMetadata, type CommonItemMetadata, type CreateParticipantRequest, type CreateParticipantResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteParticipantRequest, type DeleteParticipantResponse, type Discount, type DiscountDiscountOneOf, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntryPass, Event, type EventMetadata, type EventWithLiterals, type ExportParticipantsStatsRequest, type ExportParticipantsStatsResponse, type ExtendedFields, type GetAccessStatusRequest, type GetAccessStatusResponse, type GetCompletionStatsRequest, type GetCompletionStatsResponse, type GetParticipantRequest, type GetParticipantResponse, type GetPremiumStatsRequest, type GetPremiumStatsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IssueCertificateRequest, type IssueCertificateResponse, type ItemMetadata, JoinPath, type JoinPathWithLiterals, type JoinedInfo, type Member, type MessageEnvelope, type Participant, type ParticipantAdded, type ParticipantAddedEnvelope, type ParticipantApproved, type ParticipantApprovedEnvelope, type ParticipantExportsFinished, type ParticipantInvited, type ParticipantInvitedEnvelope, type ParticipantsQueryBuilder, type ParticipantsQueryResult, type PaymentInfo, type Progress, type QueryParticipantsRequest, type QueryParticipantsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkCreateParticipant, bulkInviteAllToProgram, bulkInviteToProgram, createParticipant, deleteParticipant, exportParticipantsStats, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, onParticipantAdded, onParticipantApproved, onParticipantInvited, queryParticipants, typedQueryParticipants };
|