@wix/auto_sdk_online-programs_participants 1.0.24 → 1.0.26

package/build/cjs/{online-programs-participants-v3-participant-participants.universal-CJ9C9r0a.d.ts → online-programs-participants-v3-participant-participants.universal-Cpkfb79r.d.ts}

@@ -221,7 +221,7 @@ interface EnrollmentInfo extends EnrollmentInfoPricingTypeDetailsOneOf {
      */
     timeZone?: string;
     /**
-     * Date when the participant starts the program. Equals the participant's `created_date` if the program has no configured start date; otherwise, equals the program's start date if the participant enrolled before it began.
+     * Date when the participant's program timeline begins. If the program's `timeline.startDate` is set, this is that date. Otherwise, it is the local calendar date when the participant is created, based on the site's time zone.
      * @format LOCAL_DATE
      * @readonly
      */
@@ -1883,7 +1883,9 @@ interface CreateParticipantOptions {
 /**
  * Updates a participant's enrollment status or enrollment pricing details.
  *
- * Use this method to suspend or resume a participant by setting `enrollment_status` to
+ * 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.
+ *
+ * Use this method to suspend or resume a participant by setting `enrollmentStatus` 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 _id - Participant ID.
@@ -2131,7 +2133,15 @@ interface GetParticipantOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * Queries existing participants.
+ * Retrieves a list of up to 50 participants, given the provided paging, filtering, and sorting.
+ *
+ * Query Participants runs with these defaults, which you can override:
+ *
+ * - `createdDate` is sorted in `DESC` order.
+ * - `paging.limit` is `50`.
+ * - `paging.offset` is `0`.
+ *
+ * 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).
  * @public
  * @documentationMaturity preview
  * @permissionId online_programs:participants:v3:participant:query_participants
@@ -2318,10 +2328,9 @@ declare const utils: {
  */
 declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`, 0>>;
 /**
- * Updates tags for multiple Participants by IDs.
+ * Adds or removes tags on multiple participants.
  *
- * Allows assigning and/or unassigning tags in a single operation.
- * At least one of assign_tags or unassign_tags must be provided.
+ * Specify which tags to assign and which tags to unassign. At least one of `assignTags` or `unassignTags` must be provided.
  * @param participantIds - Participant IDs to update tags for (1-100 items)
  * @public
  * @documentationMaturity preview
@@ -2340,10 +2349,9 @@ interface BulkUpdateParticipantTagsOptions {
     unassignTags?: Tags;
 }
 /**
- * Updates tags for Participants matching a filter.
+ * Asynchronously updates tags on multiple participants that match the provided filter criteria.
  *
- * Allows assigning and/or unassigning tags for all Participants matching the filter.
- * Returns a job ID for tracking the async operation.
+ * 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 filter - WQL filter to select Participants
  * @public
  * @documentationMaturity preview

package/build/es/index.d.mts

@@ -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-CJ9C9r0a.mjs';
-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-CJ9C9r0a.mjs';
+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.mjs';
+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.mjs';
 
 declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
 interface CreateParticipantSignature {
@@ -21,7 +21,9 @@ interface UpdateParticipantSignature {
     /**
      * Updates a participant's enrollment status or enrollment pricing details.
      *
-     * Use this method to suspend or resume a participant by setting `enrollment_status` to
+     * 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.
+     *
+     * Use this method to suspend or resume a participant by setting `enrollmentStatus` 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.
@@ -132,10 +134,9 @@ interface GetAccessStatusSignature {
 declare function bulkUpdateParticipantTags$1(httpClient: HttpClient): BulkUpdateParticipantTagsSignature;
 interface BulkUpdateParticipantTagsSignature {
     /**
-     * Updates tags for multiple Participants by IDs.
+     * Adds or removes tags on multiple participants.
      *
-     * Allows assigning and/or unassigning tags in a single operation.
-     * At least one of assign_tags or unassign_tags must be provided.
+     * 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)
      */
     (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> & {
@@ -145,10 +146,9 @@ interface BulkUpdateParticipantTagsSignature {
 declare function bulkUpdateParticipantTagsByFilter$1(httpClient: HttpClient): BulkUpdateParticipantTagsByFilterSignature;
 interface BulkUpdateParticipantTagsByFilterSignature {
     /**
-     * Updates tags for Participants matching a filter.
+     * Asynchronously updates tags on multiple participants that match the provided filter criteria.
      *
-     * Allows assigning and/or unassigning tags for all Participants matching the filter.
-     * Returns a job ID for tracking the async operation.
+     * 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
      */
     (filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`, 0> & {