@wix/auto_sdk_online-programs_participants 1.0.23 → 1.0.25
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 +22 -22
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/{online-programs-participants-v3-participant-participants.universal-OD9SM9k8.d.ts → online-programs-participants-v3-participant-participants.universal-DyW-QghG.d.ts} +29 -21
- package/build/es/index.d.mts +22 -22
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/es/{online-programs-participants-v3-participant-participants.universal-OD9SM9k8.d.mts → online-programs-participants-v3-participant-participants.universal-DyW-QghG.d.mts} +29 -21
- package/build/internal/cjs/index.d.ts +22 -22
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +1 -1
- package/build/internal/cjs/{online-programs-participants-v3-participant-participants.universal-5PlgTI6M.d.ts → online-programs-participants-v3-participant-participants.universal-QLVP_V_i.d.ts} +29 -21
- package/build/internal/es/index.d.mts +22 -22
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +1 -1
- package/build/internal/es/{online-programs-participants-v3-participant-participants.universal-5PlgTI6M.d.mts → online-programs-participants-v3-participant-participants.universal-QLVP_V_i.d.mts} +29 -21
- package/package.json +2 -2
|
@@ -1869,7 +1869,7 @@ declare function onParticipantUpdated(handler: (event: ParticipantUpdatedEnvelop
|
|
|
1869
1869
|
* @returns Created participant
|
|
1870
1870
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.CreateParticipant
|
|
1871
1871
|
*/
|
|
1872
|
-
declare function createParticipant(participant: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`,
|
|
1872
|
+
declare function createParticipant(participant: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 1>, options?: CreateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 2> & {
|
|
1873
1873
|
__applicationErrorsType?: CreateParticipantApplicationErrors;
|
|
1874
1874
|
}>;
|
|
1875
1875
|
interface CreateParticipantOptions {
|
|
@@ -1883,7 +1883,9 @@ interface CreateParticipantOptions {
|
|
|
1883
1883
|
/**
|
|
1884
1884
|
* Updates a participant's enrollment status or enrollment pricing details.
|
|
1885
1885
|
*
|
|
1886
|
-
*
|
|
1886
|
+
* Each time the participant is updated, `revision` increments by 1. The current `revision` must be passed when updating the participant. This ensures you're working with the latest participant and prevents unintended overwrites.
|
|
1887
|
+
*
|
|
1888
|
+
* Use this method to suspend or resume a participant by setting `enrollmentStatus` to
|
|
1887
1889
|
* `SUSPENDED` or `JOINED`. To remove a participant, use `DeleteParticipant`.
|
|
1888
1890
|
* Progress status is calculated from the participant's resolved steps and can't be updated.
|
|
1889
1891
|
* @param _id - Participant ID.
|
|
@@ -1897,7 +1899,7 @@ interface CreateParticipantOptions {
|
|
|
1897
1899
|
* @returns Updated participant
|
|
1898
1900
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.UpdateParticipant
|
|
1899
1901
|
*/
|
|
1900
|
-
declare function updateParticipant(_id: string, participant: NonNullablePaths<UpdateParticipant, `revision`,
|
|
1902
|
+
declare function updateParticipant(_id: string, participant: NonNullablePaths<UpdateParticipant, `revision`, 0>, options?: UpdateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 2>>;
|
|
1901
1903
|
interface UpdateParticipant {
|
|
1902
1904
|
/**
|
|
1903
1905
|
* Participant ID.
|
|
@@ -1999,7 +2001,7 @@ interface UpdateParticipantOptions {
|
|
|
1999
2001
|
* @applicableIdentity APP
|
|
2000
2002
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipants
|
|
2001
2003
|
*/
|
|
2002
|
-
declare function bulkCreateParticipants(participants: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`,
|
|
2004
|
+
declare function bulkCreateParticipants(participants: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 1>[], options?: BulkCreateParticipantsOptions): Promise<NonNullablePaths<BulkCreateParticipantsResponse, `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.enrollmentStatus` | `results.${number}.item.progressStatus` | `results.${number}.item.enrollmentInfo.timeZone` | `results.${number}.item.enrollmentInfo.startDate` | `results.${number}.item.enrollmentInfo.pricingType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4> & {
|
|
2003
2005
|
__applicationErrorsType?: BulkCreateParticipantsApplicationErrors;
|
|
2004
2006
|
}>;
|
|
2005
2007
|
interface BulkCreateParticipantsOptions {
|
|
@@ -2026,7 +2028,7 @@ interface BulkCreateParticipantsOptions {
|
|
|
2026
2028
|
* @applicableIdentity APP
|
|
2027
2029
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipantsForAllMembers
|
|
2028
2030
|
*/
|
|
2029
|
-
declare function bulkCreateParticipantsForAllMembers(programId: string, options?: BulkCreateParticipantsForAllMembersOptions): Promise<NonNullablePaths<BulkCreateParticipantsForAllMembersResponse, `jobId`,
|
|
2031
|
+
declare function bulkCreateParticipantsForAllMembers(programId: string, options?: BulkCreateParticipantsForAllMembersOptions): Promise<NonNullablePaths<BulkCreateParticipantsForAllMembersResponse, `jobId`, 0>>;
|
|
2030
2032
|
interface BulkCreateParticipantsForAllMembersOptions {
|
|
2031
2033
|
/**
|
|
2032
2034
|
* Site member IDs to exclude from bulk participant creation. Maximum 100 member IDs can be excluded.
|
|
@@ -2062,7 +2064,7 @@ declare function deleteParticipant(participantId: string): Promise<void>;
|
|
|
2062
2064
|
* @applicableIdentity APP
|
|
2063
2065
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.IssueCertificate
|
|
2064
2066
|
*/
|
|
2065
|
-
declare function issueCertificate(participantId: string, options?: IssueCertificateOptions): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.enrollmentStatus` | `participant.progressStatus` | `participant.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participant.enrollmentInfo.paidPlanDetails.paidPlanId` | `participant.enrollmentInfo.freeCouponDetails.freeCouponId` | `participant.enrollmentInfo.timeZone` | `participant.enrollmentInfo.startDate` | `participant.enrollmentInfo.pricingType` | `participant.tags.privateTags.tagIds`,
|
|
2067
|
+
declare function issueCertificate(participantId: string, options?: IssueCertificateOptions): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.enrollmentStatus` | `participant.progressStatus` | `participant.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participant.enrollmentInfo.paidPlanDetails.paidPlanId` | `participant.enrollmentInfo.freeCouponDetails.freeCouponId` | `participant.enrollmentInfo.timeZone` | `participant.enrollmentInfo.startDate` | `participant.enrollmentInfo.pricingType` | `participant.tags.privateTags.tagIds`, 3> & {
|
|
2066
2068
|
__applicationErrorsType?: IssueCertificateApplicationErrors;
|
|
2067
2069
|
}>;
|
|
2068
2070
|
interface IssueCertificateOptions {
|
|
@@ -2085,7 +2087,7 @@ interface IssueCertificateOptions {
|
|
|
2085
2087
|
* @applicableIdentity APP
|
|
2086
2088
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetCertificateDownloadUrl
|
|
2087
2089
|
*/
|
|
2088
|
-
declare function getCertificateDownloadUrl(participantId: string): Promise<NonNullablePaths<GetCertificateDownloadUrlResponse, `downloadUrl`,
|
|
2090
|
+
declare function getCertificateDownloadUrl(participantId: string): Promise<NonNullablePaths<GetCertificateDownloadUrlResponse, `downloadUrl`, 0> & {
|
|
2089
2091
|
__applicationErrorsType?: GetCertificateDownloadUrlApplicationErrors;
|
|
2090
2092
|
}>;
|
|
2091
2093
|
/**
|
|
@@ -2096,7 +2098,7 @@ declare function getCertificateDownloadUrl(participantId: string): Promise<NonNu
|
|
|
2096
2098
|
* @applicableIdentity APP
|
|
2097
2099
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetPremiumStats
|
|
2098
2100
|
*/
|
|
2099
|
-
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`,
|
|
2101
|
+
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 0>>;
|
|
2100
2102
|
/**
|
|
2101
2103
|
* Retrieves site-wide participant statistics for the requested programs.
|
|
2102
2104
|
*
|
|
@@ -2109,7 +2111,7 @@ declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResp
|
|
|
2109
2111
|
* @applicableIdentity APP
|
|
2110
2112
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipationStats
|
|
2111
2113
|
*/
|
|
2112
|
-
declare function getParticipationStats(programIds: string[]): Promise<NonNullablePaths<GetParticipationStatsResponse, `participationStats` | `participationStats.${number}.programId` | `participationStats.${number}.participantsCount` | `participationStats.${number}.autoRemovedCount`,
|
|
2114
|
+
declare function getParticipationStats(programIds: string[]): Promise<NonNullablePaths<GetParticipationStatsResponse, `participationStats` | `participationStats.${number}.programId` | `participationStats.${number}.participantsCount` | `participationStats.${number}.autoRemovedCount`, 2>>;
|
|
2113
2115
|
/**
|
|
2114
2116
|
* Returns a participant by ID.
|
|
2115
2117
|
* @param participantId - ID of the participant to fetch.
|
|
@@ -2121,7 +2123,7 @@ declare function getParticipationStats(programIds: string[]): Promise<NonNullabl
|
|
|
2121
2123
|
* @returns The retrieved participant.
|
|
2122
2124
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
|
|
2123
2125
|
*/
|
|
2124
|
-
declare function getParticipant(participantId: string, options?: GetParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`,
|
|
2126
|
+
declare function getParticipant(participantId: string, options?: GetParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 2>>;
|
|
2125
2127
|
interface GetParticipantOptions {
|
|
2126
2128
|
/**
|
|
2127
2129
|
* Array of conditional fields to include in the response.
|
|
@@ -2131,7 +2133,15 @@ interface GetParticipantOptions {
|
|
|
2131
2133
|
fields?: RequestedFieldsWithLiterals[];
|
|
2132
2134
|
}
|
|
2133
2135
|
/**
|
|
2134
|
-
*
|
|
2136
|
+
* Retrieves a list of up to 50 participants, given the provided paging, filtering, and sorting.
|
|
2137
|
+
*
|
|
2138
|
+
* Query Participants runs with these defaults, which you can override:
|
|
2139
|
+
*
|
|
2140
|
+
* - `createdDate` is sorted in `DESC` order.
|
|
2141
|
+
* - `paging.limit` is `50`.
|
|
2142
|
+
* - `paging.offset` is `0`.
|
|
2143
|
+
*
|
|
2144
|
+
* To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
|
|
2135
2145
|
* @public
|
|
2136
2146
|
* @documentationMaturity preview
|
|
2137
2147
|
* @permissionId online_programs:participants:v3:participant:query_participants
|
|
@@ -2219,7 +2229,7 @@ interface ParticipantsQueryBuilder {
|
|
|
2219
2229
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
|
|
2220
2230
|
* @requiredField query
|
|
2221
2231
|
*/
|
|
2222
|
-
declare function typedQueryParticipants(query: ParticipantQuery, options?: QueryParticipantsOptions): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.enrollmentStatus` | `participants.${number}.progressStatus` | `participants.${number}.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.enrollmentInfo.paidPlanDetails.paidPlanId` | `participants.${number}.enrollmentInfo.freeCouponDetails.freeCouponId` | `participants.${number}.enrollmentInfo.timeZone` | `participants.${number}.enrollmentInfo.startDate` | `participants.${number}.enrollmentInfo.pricingType`,
|
|
2232
|
+
declare function typedQueryParticipants(query: ParticipantQuery, options?: QueryParticipantsOptions): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.enrollmentStatus` | `participants.${number}.progressStatus` | `participants.${number}.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.enrollmentInfo.paidPlanDetails.paidPlanId` | `participants.${number}.enrollmentInfo.freeCouponDetails.freeCouponId` | `participants.${number}.enrollmentInfo.timeZone` | `participants.${number}.enrollmentInfo.startDate` | `participants.${number}.enrollmentInfo.pricingType`, 4>>;
|
|
2223
2233
|
interface ParticipantQuerySpec extends QuerySpec {
|
|
2224
2234
|
paging: 'cursor';
|
|
2225
2235
|
wql: [
|
|
@@ -2316,12 +2326,11 @@ declare const utils: {
|
|
|
2316
2326
|
* @applicableIdentity APP
|
|
2317
2327
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetAccessStatus
|
|
2318
2328
|
*/
|
|
2319
|
-
declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`,
|
|
2329
|
+
declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`, 0>>;
|
|
2320
2330
|
/**
|
|
2321
|
-
*
|
|
2331
|
+
* Adds or removes tags on multiple participants.
|
|
2322
2332
|
*
|
|
2323
|
-
*
|
|
2324
|
-
* At least one of assign_tags or unassign_tags must be provided.
|
|
2333
|
+
* Specify which tags to assign and which tags to unassign. At least one of `assignTags` or `unassignTags` must be provided.
|
|
2325
2334
|
* @param participantIds - Participant IDs to update tags for (1-100 items)
|
|
2326
2335
|
* @public
|
|
2327
2336
|
* @documentationMaturity preview
|
|
@@ -2330,7 +2339,7 @@ declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResp
|
|
|
2330
2339
|
* @applicableIdentity APP
|
|
2331
2340
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkUpdateParticipantTags
|
|
2332
2341
|
*/
|
|
2333
|
-
declare function bulkUpdateParticipantTags(participantIds: string[], options?: BulkUpdateParticipantTagsOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
2342
|
+
declare function bulkUpdateParticipantTags(participantIds: string[], options?: BulkUpdateParticipantTagsOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4> & {
|
|
2334
2343
|
__applicationErrorsType?: BulkUpdateParticipantTagsApplicationErrors;
|
|
2335
2344
|
}>;
|
|
2336
2345
|
interface BulkUpdateParticipantTagsOptions {
|
|
@@ -2340,10 +2349,9 @@ interface BulkUpdateParticipantTagsOptions {
|
|
|
2340
2349
|
unassignTags?: Tags;
|
|
2341
2350
|
}
|
|
2342
2351
|
/**
|
|
2343
|
-
*
|
|
2352
|
+
* Asynchronously updates tags on multiple participants that match the provided filter criteria.
|
|
2344
2353
|
*
|
|
2345
|
-
*
|
|
2346
|
-
* Returns a job ID for tracking the async operation.
|
|
2354
|
+
* To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
2347
2355
|
* @param filter - WQL filter to select Participants
|
|
2348
2356
|
* @public
|
|
2349
2357
|
* @documentationMaturity preview
|
|
@@ -2352,7 +2360,7 @@ interface BulkUpdateParticipantTagsOptions {
|
|
|
2352
2360
|
* @applicableIdentity APP
|
|
2353
2361
|
* @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkUpdateParticipantTagsByFilter
|
|
2354
2362
|
*/
|
|
2355
|
-
declare function bulkUpdateParticipantTagsByFilter(filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`,
|
|
2363
|
+
declare function bulkUpdateParticipantTagsByFilter(filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`, 0> & {
|
|
2356
2364
|
__applicationErrorsType?: BulkUpdateParticipantTagsByFilterApplicationErrors;
|
|
2357
2365
|
}>;
|
|
2358
2366
|
interface BulkUpdateParticipantTagsByFilterOptions {
|
package/build/es/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { P as Participant, C as CreateParticipantOptions, a as CreateParticipantApplicationErrors, U as UpdateParticipant, b as UpdateParticipantOptions, B as BulkCreateParticipantsOptions, c as BulkCreateParticipantsResponse, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, f as BulkCreateParticipantsForAllMembersResponse, I as IssueCertificateOptions, g as IssueCertificateResponse, h as IssueCertificateApplicationErrors, G as GetCertificateDownloadUrlResponse, i as GetCertificateDownloadUrlApplicationErrors, j as GetPremiumStatsResponse, k as GetParticipationStatsResponse, l as GetParticipantOptions, m as GetAccessStatusResponse, n as BulkUpdateParticipantTagsOptions, o as BulkUpdateParticipantTagsResponse, p as BulkUpdateParticipantTagsApplicationErrors, q as BulkUpdateParticipantTagsByFilterOptions, r as BulkUpdateParticipantTagsByFilterResponse, s as BulkUpdateParticipantTagsByFilterApplicationErrors, t as ParticipantSearch, S as SearchParticipantsOptions, u as SearchParticipantsResponse, v as ParticipantCompletedProgramEnvelope, w as ParticipantCreatedEnvelope, x as ParticipantDeletedEnvelope, y as ParticipantLeftEnvelope, z as ParticipantMissedProgramDeadlineEnvelope, A as ParticipantProgramDurationEndedEnvelope, D as ParticipantRemovedEnvelope, E as ParticipantTagsModifiedEnvelope, F as ParticipantUpdatedEnvelope, H as ParticipantQuery, Q as QueryParticipantsOptions, J as typedQueryParticipants, K as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-
|
|
3
|
-
export { bT as AccountInfo, bY as AccountInfoMetadata, bO as ActionEvent, b7 as Aggregation, bn as AggregationData, b8 as AggregationKindOneOf, bG as AggregationResults, bH as AggregationResultsResultOneOf, bu as AggregationResultsScalarResult, $ as AggregationType, cd as AggregationTypeWithLiterals, av as ApplicationError, bW as BaseEventMetadata, aw as BulkActionMetadata, O as BulkActionType, c5 as BulkActionTypeWithLiterals, aH as BulkCreateParticipantsForAllMembersRequest, as as BulkCreateParticipantsRequest, aA as BulkParticipantMigrationResult, at as BulkParticipantResult, b3 as BulkUpdateParticipantTagsByFilterRequest, b1 as BulkUpdateParticipantTagsRequest, b2 as BulkUpdateParticipantTagsResult, ax as BulkUpsertParticipantsMigrationRequest, az as BulkUpsertParticipantsMigrationResponse, a6 as CertificateInfo, cg as CommonQueryWithEntityContext, ch as CommonSearchWithEntityContext, ao as CreateParticipantRequest, ap as CreateParticipantResponse, aY as CursorPaging, bm as CursorPagingMetadata, b5 as CursorSearch, b6 as CursorSearchPagingMethodOneOf, a$ as Cursors, bf as DateHistogramAggregation, bC as DateHistogramResult, bE as DateHistogramResults, ag as Delete, aB as DeleteAllParticipantsMigrationRequest, aC as DeleteAllParticipantsMigrationResponse, aI as DeleteParticipantRequest, aJ as DeleteParticipantResponse, bI as DomainEvent, bJ as DomainEventBodyOneOf, bP as Empty, a8 as EnrollmentInfo, a9 as EnrollmentInfoPricingTypeDetailsOneOf, M as EnrollmentStatus, c2 as EnrollmentStatusWithLiterals, bK as EntityCreatedEvent, bN as EntityDeletedEvent, bM as EntityUpdatedEvent, bX as EventMetadata, bU as ExportParticipantsStatsRequest, bV as ExportParticipantsStatsResponse, aa as ExtendedFields, a4 as FreeCouponDetails, b0 as GetAccessStatusRequest, aL as GetCertificateDownloadUrlRequest, aM as GetCompletionStatsRequest, aN as GetCompletionStatsResponse, aR as GetParticipantRequest, aS as GetParticipantResponse, aP as GetParticipationStatsRequest, aO as GetPremiumStatsRequest, bj as GroupByAggregation, bk as GroupByAggregationKindOneOf, bD as GroupByValueResults, bR as IdentificationData, bS as IdentificationDataIdOneOf, ba as IncludeMissingValuesOptions, _ as Interval, cc as IntervalWithLiterals, aK as IssueCertificateRequest, au as ItemMetadata, a7 as Member, bQ as MessageEnvelope, X as MissingValues, c9 as MissingValuesWithLiterals, a0 as Mode, ce as ModeWithLiterals, bi as NestedAggregation, bg as NestedAggregationItem, bh as NestedAggregationItemKindOneOf, bq as NestedAggregationResults, br as NestedAggregationResultsResultOneOf, Z as NestedAggregationType, cb as NestedAggregationTypeWithLiterals, bz as NestedResultValue, bA as NestedResultValueResultOneOf, bF as NestedResults, bv as NestedValueAggregationResult, aX as Paging, a_ as PagingMetadataV2, a3 as PaidPlanDetails, aj as ParticipantCompletedProgram, an as ParticipantLeft, ay as ParticipantMigration, ak as ParticipantMissedProgramDeadline, al as ParticipantProgramDurationEnded, b_ as ParticipantQuerySpec, am as ParticipantRemoved, b$ as ParticipantSearchSpec, ai as ParticipantTagsModified, bZ as ParticipantsQueryResult, L as PricingType, c1 as PricingTypeWithLiterals, aQ as ProgramParticipationStats, a5 as Progress, N as ProgressStatus, c3 as ProgressStatusWithLiterals, aT as QueryParticipantsRequest, aZ as QueryParticipantsResponse, aU as QueryV2, aV as QueryV2PagingMethodOneOf, bd as RangeAggregation, bp as RangeAggregationResult, b9 as RangeBucket, bx as RangeResult, bt as RangeResults, ad as ReindexMessage, ae as ReindexMessageActionOneOf, aD as ReindexParticipantsSearchRequest, aE as ReindexParticipantsSearchResponse, R as RequestedFields, c4 as RequestedFieldsWithLiterals, bL as RestoreInfo, bB as Results, be as ScalarAggregation, by as ScalarResult, Y as ScalarType, ca as ScalarTypeWithLiterals, ah as Schema, bl as SearchDetails, b4 as SearchParticipantsRequest, a2 as SinglePaymentDetails, W as SortDirection, c8 as SortDirectionWithLiterals, T as SortOrder, c6 as SortOrderWithLiterals, V as SortType, c7 as SortTypeWithLiterals, aW as Sorting, aF as SynchronizeTimeCapsuleTasksRequest, aG as SynchronizeTimeCapsuleTasksResponse, ac as TagList, ab as Tags, aq as UpdateParticipantRequest, ar as UpdateParticipantResponse, af as Upsert, bb as ValueAggregation, bc as ValueAggregationOptionsOneOf, bo as ValueAggregationResult, bw as ValueResult, bs as ValueResults, a1 as WebhookIdentityType, cf as WebhookIdentityTypeWithLiterals, c0 as utils } from './online-programs-participants-v3-participant-participants.universal-
|
|
2
|
+
import { P as Participant, C as CreateParticipantOptions, a as CreateParticipantApplicationErrors, U as UpdateParticipant, b as UpdateParticipantOptions, B as BulkCreateParticipantsOptions, c as BulkCreateParticipantsResponse, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, f as BulkCreateParticipantsForAllMembersResponse, I as IssueCertificateOptions, g as IssueCertificateResponse, h as IssueCertificateApplicationErrors, G as GetCertificateDownloadUrlResponse, i as GetCertificateDownloadUrlApplicationErrors, j as GetPremiumStatsResponse, k as GetParticipationStatsResponse, l as GetParticipantOptions, m as GetAccessStatusResponse, n as BulkUpdateParticipantTagsOptions, o as BulkUpdateParticipantTagsResponse, p as BulkUpdateParticipantTagsApplicationErrors, q as BulkUpdateParticipantTagsByFilterOptions, r as BulkUpdateParticipantTagsByFilterResponse, s as BulkUpdateParticipantTagsByFilterApplicationErrors, t as ParticipantSearch, S as SearchParticipantsOptions, u as SearchParticipantsResponse, v as ParticipantCompletedProgramEnvelope, w as ParticipantCreatedEnvelope, x as ParticipantDeletedEnvelope, y as ParticipantLeftEnvelope, z as ParticipantMissedProgramDeadlineEnvelope, A as ParticipantProgramDurationEndedEnvelope, D as ParticipantRemovedEnvelope, E as ParticipantTagsModifiedEnvelope, F as ParticipantUpdatedEnvelope, H as ParticipantQuery, Q as QueryParticipantsOptions, J as typedQueryParticipants, K as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-DyW-QghG.mjs';
|
|
3
|
+
export { bT as AccountInfo, bY as AccountInfoMetadata, bO as ActionEvent, b7 as Aggregation, bn as AggregationData, b8 as AggregationKindOneOf, bG as AggregationResults, bH as AggregationResultsResultOneOf, bu as AggregationResultsScalarResult, $ as AggregationType, cd as AggregationTypeWithLiterals, av as ApplicationError, bW as BaseEventMetadata, aw as BulkActionMetadata, O as BulkActionType, c5 as BulkActionTypeWithLiterals, aH as BulkCreateParticipantsForAllMembersRequest, as as BulkCreateParticipantsRequest, aA as BulkParticipantMigrationResult, at as BulkParticipantResult, b3 as BulkUpdateParticipantTagsByFilterRequest, b1 as BulkUpdateParticipantTagsRequest, b2 as BulkUpdateParticipantTagsResult, ax as BulkUpsertParticipantsMigrationRequest, az as BulkUpsertParticipantsMigrationResponse, a6 as CertificateInfo, cg as CommonQueryWithEntityContext, ch as CommonSearchWithEntityContext, ao as CreateParticipantRequest, ap as CreateParticipantResponse, aY as CursorPaging, bm as CursorPagingMetadata, b5 as CursorSearch, b6 as CursorSearchPagingMethodOneOf, a$ as Cursors, bf as DateHistogramAggregation, bC as DateHistogramResult, bE as DateHistogramResults, ag as Delete, aB as DeleteAllParticipantsMigrationRequest, aC as DeleteAllParticipantsMigrationResponse, aI as DeleteParticipantRequest, aJ as DeleteParticipantResponse, bI as DomainEvent, bJ as DomainEventBodyOneOf, bP as Empty, a8 as EnrollmentInfo, a9 as EnrollmentInfoPricingTypeDetailsOneOf, M as EnrollmentStatus, c2 as EnrollmentStatusWithLiterals, bK as EntityCreatedEvent, bN as EntityDeletedEvent, bM as EntityUpdatedEvent, bX as EventMetadata, bU as ExportParticipantsStatsRequest, bV as ExportParticipantsStatsResponse, aa as ExtendedFields, a4 as FreeCouponDetails, b0 as GetAccessStatusRequest, aL as GetCertificateDownloadUrlRequest, aM as GetCompletionStatsRequest, aN as GetCompletionStatsResponse, aR as GetParticipantRequest, aS as GetParticipantResponse, aP as GetParticipationStatsRequest, aO as GetPremiumStatsRequest, bj as GroupByAggregation, bk as GroupByAggregationKindOneOf, bD as GroupByValueResults, bR as IdentificationData, bS as IdentificationDataIdOneOf, ba as IncludeMissingValuesOptions, _ as Interval, cc as IntervalWithLiterals, aK as IssueCertificateRequest, au as ItemMetadata, a7 as Member, bQ as MessageEnvelope, X as MissingValues, c9 as MissingValuesWithLiterals, a0 as Mode, ce as ModeWithLiterals, bi as NestedAggregation, bg as NestedAggregationItem, bh as NestedAggregationItemKindOneOf, bq as NestedAggregationResults, br as NestedAggregationResultsResultOneOf, Z as NestedAggregationType, cb as NestedAggregationTypeWithLiterals, bz as NestedResultValue, bA as NestedResultValueResultOneOf, bF as NestedResults, bv as NestedValueAggregationResult, aX as Paging, a_ as PagingMetadataV2, a3 as PaidPlanDetails, aj as ParticipantCompletedProgram, an as ParticipantLeft, ay as ParticipantMigration, ak as ParticipantMissedProgramDeadline, al as ParticipantProgramDurationEnded, b_ as ParticipantQuerySpec, am as ParticipantRemoved, b$ as ParticipantSearchSpec, ai as ParticipantTagsModified, bZ as ParticipantsQueryResult, L as PricingType, c1 as PricingTypeWithLiterals, aQ as ProgramParticipationStats, a5 as Progress, N as ProgressStatus, c3 as ProgressStatusWithLiterals, aT as QueryParticipantsRequest, aZ as QueryParticipantsResponse, aU as QueryV2, aV as QueryV2PagingMethodOneOf, bd as RangeAggregation, bp as RangeAggregationResult, b9 as RangeBucket, bx as RangeResult, bt as RangeResults, ad as ReindexMessage, ae as ReindexMessageActionOneOf, aD as ReindexParticipantsSearchRequest, aE as ReindexParticipantsSearchResponse, R as RequestedFields, c4 as RequestedFieldsWithLiterals, bL as RestoreInfo, bB as Results, be as ScalarAggregation, by as ScalarResult, Y as ScalarType, ca as ScalarTypeWithLiterals, ah as Schema, bl as SearchDetails, b4 as SearchParticipantsRequest, a2 as SinglePaymentDetails, W as SortDirection, c8 as SortDirectionWithLiterals, T as SortOrder, c6 as SortOrderWithLiterals, V as SortType, c7 as SortTypeWithLiterals, aW as Sorting, aF as SynchronizeTimeCapsuleTasksRequest, aG as SynchronizeTimeCapsuleTasksResponse, ac as TagList, ab as Tags, aq as UpdateParticipantRequest, ar as UpdateParticipantResponse, af as Upsert, bb as ValueAggregation, bc as ValueAggregationOptionsOneOf, bo as ValueAggregationResult, bw as ValueResult, bs as ValueResults, a1 as WebhookIdentityType, cf as WebhookIdentityTypeWithLiterals, c0 as utils } from './online-programs-participants-v3-participant-participants.universal-DyW-QghG.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
|
|
6
6
|
interface CreateParticipantSignature {
|
|
@@ -12,7 +12,7 @@ interface CreateParticipantSignature {
|
|
|
12
12
|
* @param - Participant to create
|
|
13
13
|
* @returns Created participant
|
|
14
14
|
*/
|
|
15
|
-
(participant: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`,
|
|
15
|
+
(participant: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 1>, options?: CreateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 2> & {
|
|
16
16
|
__applicationErrorsType?: CreateParticipantApplicationErrors;
|
|
17
17
|
}>;
|
|
18
18
|
}
|
|
@@ -21,13 +21,15 @@ interface UpdateParticipantSignature {
|
|
|
21
21
|
/**
|
|
22
22
|
* Updates a participant's enrollment status or enrollment pricing details.
|
|
23
23
|
*
|
|
24
|
-
*
|
|
24
|
+
* Each time the participant is updated, `revision` increments by 1. The current `revision` must be passed when updating the participant. This ensures you're working with the latest participant and prevents unintended overwrites.
|
|
25
|
+
*
|
|
26
|
+
* Use this method to suspend or resume a participant by setting `enrollmentStatus` to
|
|
25
27
|
* `SUSPENDED` or `JOINED`. To remove a participant, use `DeleteParticipant`.
|
|
26
28
|
* Progress status is calculated from the participant's resolved steps and can't be updated.
|
|
27
29
|
* @param - Participant ID.
|
|
28
30
|
* @returns Updated participant
|
|
29
31
|
*/
|
|
30
|
-
(_id: string, participant: NonNullablePaths<UpdateParticipant, `revision`,
|
|
32
|
+
(_id: string, participant: NonNullablePaths<UpdateParticipant, `revision`, 0>, options?: UpdateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 2>>;
|
|
31
33
|
}
|
|
32
34
|
declare function bulkCreateParticipants$1(httpClient: HttpClient): BulkCreateParticipantsSignature;
|
|
33
35
|
interface BulkCreateParticipantsSignature {
|
|
@@ -43,7 +45,7 @@ interface BulkCreateParticipantsSignature {
|
|
|
43
45
|
* Other pricing types (`FREE`, `ADDED_MANUALLY`) do not require details.
|
|
44
46
|
* @param - List of participants to create.
|
|
45
47
|
*/
|
|
46
|
-
(participants: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`,
|
|
48
|
+
(participants: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 1>[], options?: BulkCreateParticipantsOptions): Promise<NonNullablePaths<BulkCreateParticipantsResponse, `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.enrollmentStatus` | `results.${number}.item.progressStatus` | `results.${number}.item.enrollmentInfo.timeZone` | `results.${number}.item.enrollmentInfo.startDate` | `results.${number}.item.enrollmentInfo.pricingType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4> & {
|
|
47
49
|
__applicationErrorsType?: BulkCreateParticipantsApplicationErrors;
|
|
48
50
|
}>;
|
|
49
51
|
}
|
|
@@ -57,7 +59,7 @@ interface BulkCreateParticipantsForAllMembersSignature {
|
|
|
57
59
|
* Only members who are not yet participants will be added.
|
|
58
60
|
* @param - ID of the program for which to create participants for all site members in bulk.
|
|
59
61
|
*/
|
|
60
|
-
(programId: string, options?: BulkCreateParticipantsForAllMembersOptions): Promise<NonNullablePaths<BulkCreateParticipantsForAllMembersResponse, `jobId`,
|
|
62
|
+
(programId: string, options?: BulkCreateParticipantsForAllMembersOptions): Promise<NonNullablePaths<BulkCreateParticipantsForAllMembersResponse, `jobId`, 0>>;
|
|
61
63
|
}
|
|
62
64
|
declare function deleteParticipant$1(httpClient: HttpClient): DeleteParticipantSignature;
|
|
63
65
|
interface DeleteParticipantSignature {
|
|
@@ -79,7 +81,7 @@ interface IssueCertificateSignature {
|
|
|
79
81
|
* the participant must have completed the program.
|
|
80
82
|
* @param - ID of the participant to issue the certificate to.
|
|
81
83
|
*/
|
|
82
|
-
(participantId: string, options?: IssueCertificateOptions): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.enrollmentStatus` | `participant.progressStatus` | `participant.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participant.enrollmentInfo.paidPlanDetails.paidPlanId` | `participant.enrollmentInfo.freeCouponDetails.freeCouponId` | `participant.enrollmentInfo.timeZone` | `participant.enrollmentInfo.startDate` | `participant.enrollmentInfo.pricingType` | `participant.tags.privateTags.tagIds`,
|
|
84
|
+
(participantId: string, options?: IssueCertificateOptions): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.enrollmentStatus` | `participant.progressStatus` | `participant.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participant.enrollmentInfo.paidPlanDetails.paidPlanId` | `participant.enrollmentInfo.freeCouponDetails.freeCouponId` | `participant.enrollmentInfo.timeZone` | `participant.enrollmentInfo.startDate` | `participant.enrollmentInfo.pricingType` | `participant.tags.privateTags.tagIds`, 3> & {
|
|
83
85
|
__applicationErrorsType?: IssueCertificateApplicationErrors;
|
|
84
86
|
}>;
|
|
85
87
|
}
|
|
@@ -91,7 +93,7 @@ interface GetCertificateDownloadUrlSignature {
|
|
|
91
93
|
* The URL is returned only after the certificate document finishes rendering.
|
|
92
94
|
* @param - ID of the participant whose certificate download URL to retrieve.
|
|
93
95
|
*/
|
|
94
|
-
(participantId: string): Promise<NonNullablePaths<GetCertificateDownloadUrlResponse, `downloadUrl`,
|
|
96
|
+
(participantId: string): Promise<NonNullablePaths<GetCertificateDownloadUrlResponse, `downloadUrl`, 0> & {
|
|
95
97
|
__applicationErrorsType?: GetCertificateDownloadUrlApplicationErrors;
|
|
96
98
|
}>;
|
|
97
99
|
}
|
|
@@ -100,7 +102,7 @@ interface GetPremiumStatsSignature {
|
|
|
100
102
|
/**
|
|
101
103
|
* Retrieves premium plan statistics for the site.
|
|
102
104
|
*/
|
|
103
|
-
(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`,
|
|
105
|
+
(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 0>>;
|
|
104
106
|
}
|
|
105
107
|
declare function getParticipationStats$1(httpClient: HttpClient): GetParticipationStatsSignature;
|
|
106
108
|
interface GetParticipationStatsSignature {
|
|
@@ -110,7 +112,7 @@ interface GetParticipationStatsSignature {
|
|
|
110
112
|
* The statistics aren't limited to the caller's own participation records.
|
|
111
113
|
* @param - IDs of the programs to retrieve participant statistics for.
|
|
112
114
|
*/
|
|
113
|
-
(programIds: string[]): Promise<NonNullablePaths<GetParticipationStatsResponse, `participationStats` | `participationStats.${number}.programId` | `participationStats.${number}.participantsCount` | `participationStats.${number}.autoRemovedCount`,
|
|
115
|
+
(programIds: string[]): Promise<NonNullablePaths<GetParticipationStatsResponse, `participationStats` | `participationStats.${number}.programId` | `participationStats.${number}.participantsCount` | `participationStats.${number}.autoRemovedCount`, 2>>;
|
|
114
116
|
}
|
|
115
117
|
declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
|
|
116
118
|
interface GetParticipantSignature {
|
|
@@ -119,7 +121,7 @@ interface GetParticipantSignature {
|
|
|
119
121
|
* @param - ID of the participant to fetch.
|
|
120
122
|
* @returns The retrieved participant.
|
|
121
123
|
*/
|
|
122
|
-
(participantId: string, options?: GetParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`,
|
|
124
|
+
(participantId: string, options?: GetParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 2>>;
|
|
123
125
|
}
|
|
124
126
|
declare function getAccessStatus$1(httpClient: HttpClient): GetAccessStatusSignature;
|
|
125
127
|
interface GetAccessStatusSignature {
|
|
@@ -127,31 +129,29 @@ interface GetAccessStatusSignature {
|
|
|
127
129
|
* Retrieves the access status for the current site, indicating whether participants can access
|
|
128
130
|
* online programs or if access is blocked due to plan limitations or other restrictions.
|
|
129
131
|
*/
|
|
130
|
-
(): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`,
|
|
132
|
+
(): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`, 0>>;
|
|
131
133
|
}
|
|
132
134
|
declare function bulkUpdateParticipantTags$1(httpClient: HttpClient): BulkUpdateParticipantTagsSignature;
|
|
133
135
|
interface BulkUpdateParticipantTagsSignature {
|
|
134
136
|
/**
|
|
135
|
-
*
|
|
137
|
+
* Adds or removes tags on multiple participants.
|
|
136
138
|
*
|
|
137
|
-
*
|
|
138
|
-
* At least one of assign_tags or unassign_tags must be provided.
|
|
139
|
+
* Specify which tags to assign and which tags to unassign. At least one of `assignTags` or `unassignTags` must be provided.
|
|
139
140
|
* @param - Participant IDs to update tags for (1-100 items)
|
|
140
141
|
*/
|
|
141
|
-
(participantIds: string[], options?: BulkUpdateParticipantTagsOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`,
|
|
142
|
+
(participantIds: string[], options?: BulkUpdateParticipantTagsOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4> & {
|
|
142
143
|
__applicationErrorsType?: BulkUpdateParticipantTagsApplicationErrors;
|
|
143
144
|
}>;
|
|
144
145
|
}
|
|
145
146
|
declare function bulkUpdateParticipantTagsByFilter$1(httpClient: HttpClient): BulkUpdateParticipantTagsByFilterSignature;
|
|
146
147
|
interface BulkUpdateParticipantTagsByFilterSignature {
|
|
147
148
|
/**
|
|
148
|
-
*
|
|
149
|
+
* Asynchronously updates tags on multiple participants that match the provided filter criteria.
|
|
149
150
|
*
|
|
150
|
-
*
|
|
151
|
-
* Returns a job ID for tracking the async operation.
|
|
151
|
+
* To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
152
152
|
* @param - WQL filter to select Participants
|
|
153
153
|
*/
|
|
154
|
-
(filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`,
|
|
154
|
+
(filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`, 0> & {
|
|
155
155
|
__applicationErrorsType?: BulkUpdateParticipantTagsByFilterApplicationErrors;
|
|
156
156
|
}>;
|
|
157
157
|
}
|
|
@@ -163,7 +163,7 @@ interface SearchParticipantsSignature {
|
|
|
163
163
|
* Results and aggregations include only the participant records that the caller is authorized to access.
|
|
164
164
|
* @param - Query to search participants.
|
|
165
165
|
*/
|
|
166
|
-
(search: ParticipantSearch, options?: SearchParticipantsOptions): Promise<NonNullablePaths<SearchParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.enrollmentStatus` | `participants.${number}.progressStatus` | `participants.${number}.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.enrollmentInfo.paidPlanDetails.paidPlanId` | `participants.${number}.enrollmentInfo.freeCouponDetails.freeCouponId` | `participants.${number}.enrollmentInfo.timeZone` | `participants.${number}.enrollmentInfo.startDate` | `participants.${number}.enrollmentInfo.pricingType` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`,
|
|
166
|
+
(search: ParticipantSearch, options?: SearchParticipantsOptions): Promise<NonNullablePaths<SearchParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.enrollmentStatus` | `participants.${number}.progressStatus` | `participants.${number}.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.enrollmentInfo.paidPlanDetails.paidPlanId` | `participants.${number}.enrollmentInfo.freeCouponDetails.freeCouponId` | `participants.${number}.enrollmentInfo.timeZone` | `participants.${number}.enrollmentInfo.startDate` | `participants.${number}.enrollmentInfo.pricingType` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 4>>;
|
|
167
167
|
}
|
|
168
168
|
declare const onParticipantCompletedProgram$1: EventDefinition<ParticipantCompletedProgramEnvelope, "wix.online_programs.participants.v3.participant_completed_program">;
|
|
169
169
|
declare const onParticipantCreated$1: EventDefinition<ParticipantCreatedEnvelope, "wix.online_programs.participants.v3.participant_created">;
|