@wix/auto_sdk_online-programs_participants 1.0.16 → 1.0.18

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 GetPremiumStatsResponse, i as GetParticipantOptions, j as GetAccessStatusResponse, k as BulkUpdateParticipantTagsOptions, l as BulkUpdateParticipantTagsResponse, m as BulkUpdateParticipantTagsApplicationErrors, n as BulkUpdateParticipantTagsByFilterOptions, o as BulkUpdateParticipantTagsByFilterResponse, p as BulkUpdateParticipantTagsByFilterApplicationErrors, q as ParticipantSearch, S as SearchParticipantsOptions, r as SearchParticipantsResponse, s as ParticipantCompletedProgramEnvelope, t as ParticipantCreatedEnvelope, u as ParticipantDeletedEnvelope, v as ParticipantLeftEnvelope, w as ParticipantMissedProgramDeadlineEnvelope, x as ParticipantProgramDurationEndedEnvelope, y as ParticipantRemovedEnvelope, z as ParticipantTagsModifiedEnvelope, A as ParticipantUpdatedEnvelope, D as ParticipantQuery, Q as QueryParticipantsOptions, E as typedQueryParticipants, F as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.js';
-export { bO as AccountInfo, bT as AccountInfoMetadata, bJ as ActionEvent, b2 as Aggregation, bi as AggregationData, b3 as AggregationKindOneOf, bB as AggregationResults, bC as AggregationResultsResultOneOf, bp as AggregationResultsScalarResult, Y as AggregationType, c8 as AggregationTypeWithLiterals, at as ApplicationError, bR as BaseEventMetadata, au as BulkActionMetadata, L as BulkActionType, c0 as BulkActionTypeWithLiterals, aF as BulkCreateParticipantsForAllMembersRequest, aq as BulkCreateParticipantsRequest, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, a_ as BulkUpdateParticipantTagsByFilterRequest, aY as BulkUpdateParticipantTagsRequest, aZ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a3 as CertificateInfo, cb as CommonQueryWithEntityContext, cc as CommonSearchWithEntityContext, am as CreateParticipantRequest, an as CreateParticipantResponse, aT as CursorPaging, bh as CursorPagingMetadata, b0 as CursorSearch, b1 as CursorSearchPagingMethodOneOf, aW as Cursors, ba as DateHistogramAggregation, bx as DateHistogramResult, bz as DateHistogramResults, ad as Delete, az as DeleteAllParticipantsMigrationRequest, aA as DeleteAllParticipantsMigrationResponse, aG as DeleteParticipantRequest, aH as DeleteParticipantResponse, bD as DomainEvent, bE as DomainEventBodyOneOf, bK as Empty, a5 as EnrollmentInfo, a6 as EnrollmentInfoPricingTypeDetailsOneOf, J as EnrollmentStatus, bZ as EnrollmentStatusWithLiterals, bF as EntityCreatedEvent, bI as EntityDeletedEvent, bH as EntityUpdatedEvent, bS as EventMetadata, bP as ExportParticipantsStatsRequest, bQ as ExportParticipantsStatsResponse, a7 as ExtendedFields, a1 as FreeCouponDetails, aX as GetAccessStatusRequest, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, aM as GetParticipantRequest, aN as GetParticipantResponse, aL as GetPremiumStatsRequest, be as GroupByAggregation, bf as GroupByAggregationKindOneOf, by as GroupByValueResults, bM as IdentificationData, bN as IdentificationDataIdOneOf, b5 as IncludeMissingValuesOptions, X as Interval, c7 as IntervalWithLiterals, aI as IssueCertificateRequest, as as ItemMetadata, a4 as Member, bL as MessageEnvelope, T as MissingValues, c4 as MissingValuesWithLiterals, Z as Mode, c9 as ModeWithLiterals, bd as NestedAggregation, bb as NestedAggregationItem, bc as NestedAggregationItemKindOneOf, bl as NestedAggregationResults, bm as NestedAggregationResultsResultOneOf, W as NestedAggregationType, c6 as NestedAggregationTypeWithLiterals, bu as NestedResultValue, bv as NestedResultValueResultOneOf, bA as NestedResults, bq as NestedValueAggregationResult, aS as Paging, aV as PagingMetadataV2, a0 as PaidPlanDetails, ag as ParticipantCompletedProgram, al as ParticipantExportsFinished, ak as ParticipantLeft, aw as ParticipantMigration, ah as ParticipantMissedProgramDeadline, ai as ParticipantProgramDurationEnded, bV as ParticipantQuerySpec, aj as ParticipantRemoved, bW as ParticipantSearchSpec, af as ParticipantTagsModified, bU as ParticipantsQueryResult, H as PricingType, bY as PricingTypeWithLiterals, a2 as Progress, K as ProgressStatus, b_ as ProgressStatusWithLiterals, aO as QueryParticipantsRequest, aU as QueryParticipantsResponse, aP as QueryV2, aQ as QueryV2PagingMethodOneOf, b8 as RangeAggregation, bk as RangeAggregationResult, b4 as RangeBucket, bs as RangeResult, bo as RangeResults, aa as ReindexMessage, ab as ReindexMessageActionOneOf, aB as ReindexParticipantsSearchRequest, aC as ReindexParticipantsSearchResponse, R as RequestedFields, b$ as RequestedFieldsWithLiterals, bG as RestoreInfo, bw as Results, b9 as ScalarAggregation, bt as ScalarResult, V as ScalarType, c5 as ScalarTypeWithLiterals, ae as Schema, bg as SearchDetails, a$ as SearchParticipantsRequest, $ as SinglePaymentDetails, O as SortDirection, c3 as SortDirectionWithLiterals, M as SortOrder, c1 as SortOrderWithLiterals, N as SortType, c2 as SortTypeWithLiterals, aR as Sorting, aD as SynchronizeTimeCapsuleTasksRequest, aE as SynchronizeTimeCapsuleTasksResponse, a9 as TagList, a8 as Tags, ao as UpdateParticipantRequest, ap as UpdateParticipantResponse, ac as Upsert, b6 as ValueAggregation, b7 as ValueAggregationOptionsOneOf, bj as ValueAggregationResult, br as ValueResult, bn as ValueResults, _ as WebhookIdentityType, ca as WebhookIdentityTypeWithLiterals, bX as utils } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.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 GetPremiumStatsResponse, i as GetParticipantOptions, j as GetAccessStatusResponse, k as BulkUpdateParticipantTagsOptions, l as BulkUpdateParticipantTagsResponse, m as BulkUpdateParticipantTagsApplicationErrors, n as BulkUpdateParticipantTagsByFilterOptions, o as BulkUpdateParticipantTagsByFilterResponse, p as BulkUpdateParticipantTagsByFilterApplicationErrors, q as ParticipantSearch, S as SearchParticipantsOptions, r as SearchParticipantsResponse, s as ParticipantCompletedProgramEnvelope, t as ParticipantCreatedEnvelope, u as ParticipantDeletedEnvelope, v as ParticipantLeftEnvelope, w as ParticipantMissedProgramDeadlineEnvelope, x as ParticipantProgramDurationEndedEnvelope, y as ParticipantRemovedEnvelope, z as ParticipantTagsModifiedEnvelope, A as ParticipantUpdatedEnvelope, D as ParticipantQuery, Q as QueryParticipantsOptions, E as typedQueryParticipants, F as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-B3XNf_Rk.js';
+export { bN as AccountInfo, bS as AccountInfoMetadata, bI as ActionEvent, b1 as Aggregation, bh as AggregationData, b2 as AggregationKindOneOf, bA as AggregationResults, bB as AggregationResultsResultOneOf, bo as AggregationResultsScalarResult, Y as AggregationType, c7 as AggregationTypeWithLiterals, as as ApplicationError, bQ as BaseEventMetadata, at as BulkActionMetadata, L as BulkActionType, b$ as BulkActionTypeWithLiterals, aE as BulkCreateParticipantsForAllMembersRequest, ap as BulkCreateParticipantsRequest, ax as BulkParticipantMigrationResult, aq as BulkParticipantResult, aZ as BulkUpdateParticipantTagsByFilterRequest, aX as BulkUpdateParticipantTagsRequest, aY as BulkUpdateParticipantTagsResult, au as BulkUpsertParticipantsMigrationRequest, aw as BulkUpsertParticipantsMigrationResponse, a3 as CertificateInfo, ca as CommonQueryWithEntityContext, cb as CommonSearchWithEntityContext, al as CreateParticipantRequest, am as CreateParticipantResponse, aS as CursorPaging, bg as CursorPagingMetadata, a$ as CursorSearch, b0 as CursorSearchPagingMethodOneOf, aV as Cursors, b9 as DateHistogramAggregation, bw as DateHistogramResult, by as DateHistogramResults, ad as Delete, ay as DeleteAllParticipantsMigrationRequest, az as DeleteAllParticipantsMigrationResponse, aF as DeleteParticipantRequest, aG as DeleteParticipantResponse, bC as DomainEvent, bD as DomainEventBodyOneOf, bJ as Empty, a5 as EnrollmentInfo, a6 as EnrollmentInfoPricingTypeDetailsOneOf, J as EnrollmentStatus, bY as EnrollmentStatusWithLiterals, bE as EntityCreatedEvent, bH as EntityDeletedEvent, bG as EntityUpdatedEvent, bR as EventMetadata, bO as ExportParticipantsStatsRequest, bP as ExportParticipantsStatsResponse, a7 as ExtendedFields, a1 as FreeCouponDetails, aW as GetAccessStatusRequest, aI as GetCompletionStatsRequest, aJ as GetCompletionStatsResponse, aL as GetParticipantRequest, aM as GetParticipantResponse, aK as GetPremiumStatsRequest, bd as GroupByAggregation, be as GroupByAggregationKindOneOf, bx as GroupByValueResults, bL as IdentificationData, bM as IdentificationDataIdOneOf, b4 as IncludeMissingValuesOptions, X as Interval, c6 as IntervalWithLiterals, aH as IssueCertificateRequest, ar as ItemMetadata, a4 as Member, bK as MessageEnvelope, T as MissingValues, c3 as MissingValuesWithLiterals, Z as Mode, c8 as ModeWithLiterals, bc as NestedAggregation, ba as NestedAggregationItem, bb as NestedAggregationItemKindOneOf, bk as NestedAggregationResults, bl as NestedAggregationResultsResultOneOf, W as NestedAggregationType, c5 as NestedAggregationTypeWithLiterals, bt as NestedResultValue, bu as NestedResultValueResultOneOf, bz as NestedResults, bp as NestedValueAggregationResult, aR as Paging, aU as PagingMetadataV2, a0 as PaidPlanDetails, ag as ParticipantCompletedProgram, ak as ParticipantLeft, av as ParticipantMigration, ah as ParticipantMissedProgramDeadline, ai as ParticipantProgramDurationEnded, bU as ParticipantQuerySpec, aj as ParticipantRemoved, bV as ParticipantSearchSpec, af as ParticipantTagsModified, bT as ParticipantsQueryResult, H as PricingType, bX as PricingTypeWithLiterals, a2 as Progress, K as ProgressStatus, bZ as ProgressStatusWithLiterals, aN as QueryParticipantsRequest, aT as QueryParticipantsResponse, aO as QueryV2, aP as QueryV2PagingMethodOneOf, b7 as RangeAggregation, bj as RangeAggregationResult, b3 as RangeBucket, br as RangeResult, bn as RangeResults, aa as ReindexMessage, ab as ReindexMessageActionOneOf, aA as ReindexParticipantsSearchRequest, aB as ReindexParticipantsSearchResponse, R as RequestedFields, b_ as RequestedFieldsWithLiterals, bF as RestoreInfo, bv as Results, b8 as ScalarAggregation, bs as ScalarResult, V as ScalarType, c4 as ScalarTypeWithLiterals, ae as Schema, bf as SearchDetails, a_ as SearchParticipantsRequest, $ as SinglePaymentDetails, O as SortDirection, c2 as SortDirectionWithLiterals, M as SortOrder, c0 as SortOrderWithLiterals, N as SortType, c1 as SortTypeWithLiterals, aQ as Sorting, aC as SynchronizeTimeCapsuleTasksRequest, aD as SynchronizeTimeCapsuleTasksResponse, a9 as TagList, a8 as Tags, an as UpdateParticipantRequest, ao as UpdateParticipantResponse, ac as Upsert, b5 as ValueAggregation, b6 as ValueAggregationOptionsOneOf, bi as ValueAggregationResult, bq as ValueResult, bm as ValueResults, _ as WebhookIdentityType, c9 as WebhookIdentityTypeWithLiterals, bW as utils } from './online-programs-participants-v3-participant-participants.universal-B3XNf_Rk.js';
 
 declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
 interface CreateParticipantSignature {
@@ -19,7 +19,11 @@ interface CreateParticipantSignature {
 declare function updateParticipant$1(httpClient: HttpClient): UpdateParticipantSignature;
 interface UpdateParticipantSignature {
     /**
-     * Updates a participant's enrollment status, progress status, or enrollment pricing details.
+     * Updates a participant's enrollment status or enrollment pricing details.
+     *
+     * Use this method to suspend or resume a participant by setting `enrollment_status` to
+     * `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
      */