@wix/auto_sdk_online-programs_participants 1.0.26 → 1.0.27

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-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-Cpkfb79r.js';
-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-Cpkfb79r.js';
+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-4mwuoF9u.js';
+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-4mwuoF9u.js';
 
 declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
 interface CreateParticipantSignature {
@@ -8,9 +8,9 @@ interface CreateParticipantSignature {
      * Creates a participant.
      *
      * Returns an error if the member is already a participant in the specified program.
-     * Use UpdateParticipant to modify existing participants.
-     * @param - Participant to create
-     * @returns Created participant
+     * Use [Update Participant](https://dev.wix.com/docs/api-reference/business-management/online-programs/participants/update-participant) to modify existing participants.
+     * @param - Participant to create.
+     * @returns Created participant.
      */
     (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> & {
         __applicationErrorsType?: CreateParticipantApplicationErrors;
@@ -27,7 +27,7 @@ interface UpdateParticipantSignature {
      * `SUSPENDED` or `JOINED`. To remove a participant, use `DeleteParticipant`.
      * Progress status is calculated from the participant's resolved steps and can't be updated.
      * @param - Participant ID.
-     * @returns Updated participant
+     * @returns Updated participant.
      */
     (_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>>;
 }
@@ -39,10 +39,10 @@ interface BulkCreateParticipantsSignature {
      * All participants in a single bulk create request must belong to the same program.
      * Returns an error if the member is already a participant in the specified program.
      *
-     * When `pricing_type` is `SINGLE_PAYMENT`, provide `single_payment_details`.
-     * When `pricing_type` is `PAID_PLAN`, provide `paid_plan_details`.
-     * When `pricing_type` is `FREE_COUPON`, provide `free_coupon_details`.
-     * Other pricing types (`FREE`, `ADDED_MANUALLY`) do not require details.
+     * When `pricingType` is `SINGLE_PAYMENT`, provide `singlePaymentDetails`.
+     * When `pricingType` is `PAID_PLAN`, provide `paidPlanDetails`.
+     * When `pricingType` is `FREE_COUPON`, provide `freeCouponDetails`.
+     * Other pricing types (`FREE`, `ADDED_MANUALLY`) don't require details.
      * @param - List of participants to create.
      */
     (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> & {
@@ -137,7 +137,7 @@ interface BulkUpdateParticipantTagsSignature {
      * Adds or removes tags on multiple participants.
      *
      * Specify which tags to assign and which tags to unassign. At least one of `assignTags` or `unassignTags` must be provided.
-     * @param - Participant IDs to update tags for (1-100 items)
+     * @param - IDs of the participants to update tags for. Provide 1 to 100 IDs.
      */
     (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> & {
         __applicationErrorsType?: BulkUpdateParticipantTagsApplicationErrors;
@@ -149,7 +149,7 @@ interface BulkUpdateParticipantTagsByFilterSignature {
      * Asynchronously updates tags on multiple participants that match the provided filter criteria.
      *
      * 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).
-     * @param - WQL filter to select Participants
+     * @param - WQL filter that selects the participants to update.
      */
     (filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`, 0> & {
         __applicationErrorsType?: BulkUpdateParticipantTagsByFilterApplicationErrors;