@wix/auto_sdk_online-programs_participants 1.0.26 → 1.0.28

package/build/cjs/meta.d.ts

@@ -1,8 +1,8 @@
-import { ao as CreateParticipantRequest$1, ap as CreateParticipantResponse$1, aq as UpdateParticipantRequest$1, ar as UpdateParticipantResponse$1, as as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, aH as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, aI as DeleteParticipantRequest$1, aJ as DeleteParticipantResponse$1, aK as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aL as GetCertificateDownloadUrlRequest$1, G as GetCertificateDownloadUrlResponse$1, aO as GetPremiumStatsRequest$1, j as GetPremiumStatsResponse$1, aP as GetParticipationStatsRequest$1, k as GetParticipationStatsResponse$1, aR as GetParticipantRequest$1, aS as GetParticipantResponse$1, aT as QueryParticipantsRequest$1, aZ as QueryParticipantsResponse$1, b0 as GetAccessStatusRequest$1, m as GetAccessStatusResponse$1, b1 as BulkUpdateParticipantTagsRequest$1, o as BulkUpdateParticipantTagsResponse$1, b3 as BulkUpdateParticipantTagsByFilterRequest$1, r as BulkUpdateParticipantTagsByFilterResponse$1, b4 as SearchParticipantsRequest$1, u as SearchParticipantsResponse$1, bU as ExportParticipantsStatsRequest$1, bV as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-Cpkfb79r.js';
+import { ao as CreateParticipantRequest$1, ap as CreateParticipantResponse$1, aq as UpdateParticipantRequest$1, ar as UpdateParticipantResponse$1, as as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, aH as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, aI as DeleteParticipantRequest$1, aJ as DeleteParticipantResponse$1, aK as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aL as GetCertificateDownloadUrlRequest$1, G as GetCertificateDownloadUrlResponse$1, aO as GetPremiumStatsRequest$1, j as GetPremiumStatsResponse$1, aP as GetParticipationStatsRequest$1, k as GetParticipationStatsResponse$1, aR as GetParticipantRequest$1, aS as GetParticipantResponse$1, aT as QueryParticipantsRequest$1, aZ as QueryParticipantsResponse$1, b0 as GetAccessStatusRequest$1, m as GetAccessStatusResponse$1, b1 as BulkUpdateParticipantTagsRequest$1, o as BulkUpdateParticipantTagsResponse$1, b3 as BulkUpdateParticipantTagsByFilterRequest$1, r as BulkUpdateParticipantTagsByFilterResponse$1, b4 as SearchParticipantsRequest$1, u as SearchParticipantsResponse$1, bU as ExportParticipantsStatsRequest$1, bV as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-BrdlJaIZ.js';
 import '@wix/sdk-types';
 
 /**
- * Participant entity represents a site member who takes part in a specific Online Program.
+ * A participant entity represents a site member who takes part in a specific Online Program.
  * Participants have access to the program's content and progress through the program by completing its steps.
  * A participant can join through a join application flow or be manually added by the program owner.
  * A participant's status depends on their progress and the program's settings (e.g., start and end dates). Participation may also be temporarily suspended.
@@ -15,17 +15,20 @@ interface Participant {
      */
     id?: string | null;
     /**
-     * Participant revision (for optimistic concurrency control).
+     * Revision number, which increments by 1 each time the participant is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the participant.
+     *
+     * Ignored when creating a participant.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Participant creation date.
+     * Date and time the participant was created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * Date the participant was last updated.
+     * Date and time the participant was updated.
      * @readonly
      */
     updatedDate?: Date | null;
@@ -42,17 +45,19 @@ interface Participant {
      */
     programId?: string;
     /**
-     * Program completion progress. This field is conditional and must be explicitly requested via `fields` parameter.
+     * Program completion progress. This field is conditional and must be explicitly requested using the `fields` parameter.
      * @readonly
      */
     progress?: Progress;
     /**
-     * Certificate info for participant
+     * Information about the participant's certificate.
+     *
+     * Returned only when a certificate has been issued to the participant.
      * @readonly
      */
     certificateInfo?: CertificateInfo;
     /**
-     * Site member info snapshot for the participant
+     * Snapshot of the site member identified by `memberId`, copied from the Members API. It isn't the authoritative member record.
      * @readonly
      */
     member?: Member;
@@ -73,7 +78,11 @@ interface Participant {
     progressStatus?: ProgressStatusWithLiterals;
     /** Additional information about the participant's enrollment and completion timeframe in the program. */
     enrollmentInfo?: EnrollmentInfo;
-    /** Extended fields for participant (can be used for storing custom data). */
+    /**
+     * Custom field data for the participant object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
     extendedFields?: ExtendedFields;
     /** Tags for categorizing and organizing participants. */
     tags?: Tags;
@@ -100,7 +109,9 @@ interface SinglePaymentDetails {
      */
     paymentOrderId?: string;
     /**
-     * ID of the offline transaction if the participant used an offline payment method (e.g., cash, check). Null if online payment was used.
+     * ID of the offline transaction.
+     *
+     * Available only when the participant paid with an offline payment method, such as cash or check.
      * @format GUID
      * @immutable
      */
@@ -128,8 +139,8 @@ interface Progress {
     /** Total number of program steps available to resolve. */
     totalStepsAvailable?: number;
     /**
-     * Participant's completion percentage. For completed participants, this is 100.0. Otherwise, it is calculated as
-     * (total_steps_completed / total_steps_available) * 100, capped at 100, and rounded to 1 decimal place.
+     * Participant's completion percentage. For participants who completed the program, this is `100.0`.
+     * Otherwise, it's calculated as (`totalStepsCompleted` / `totalStepsAvailable`) * 100, capped at `100`, and rounded to 1 decimal place.
      * @max 100
      */
     completionPercentage?: number;
@@ -143,31 +154,41 @@ interface CertificateInfo {
 }
 interface Member {
     /**
-     * First name of the site member. Null if the member has not provided this information in their profile.
+     * First name of the site member.
+     *
+     * Returned only when the member has provided it in their profile.
      * @readonly
      * @maxLength 1000
      */
     firstName?: string | null;
     /**
-     * Last name of the site member. Null if the member has not provided this information in their profile.
+     * Last name of the site member.
+     *
+     * Returned only when the member has provided it in their profile.
      * @readonly
      * @maxLength 1000
      */
     lastName?: string | null;
     /**
-     * Email of the site member. Null if the member has not provided this information in their profile.
+     * Email of the site member.
+     *
+     * Returned only when the member has provided it in their profile.
      * @readonly
      * @format EMAIL
      */
     email?: string | null;
     /**
-     * Contact ID for accessing additional member information via the Contacts API. Use this to retrieve extended contact details like phone numbers, addresses, and custom fields. Null if the member has not provided this information in their profile.
+     * Contact ID for accessing additional member information with the Contacts API, such as phone numbers, addresses, and custom fields.
+     *
+     * Returned only when the member has provided this information in their profile.
      * @format GUID
      * @readonly
      */
     contactId?: string | null;
     /**
-     * Member nickname. Null if the member has not provided this information in their profile.
+     * Member nickname.
+     *
+     * Returned only when the member has provided it in their profile.
      * @readonly
      * @maxLength 1000
      */
@@ -202,7 +223,7 @@ declare enum ProgressStatus {
     COMPLETED = "COMPLETED",
     /** Participant failed to complete the program within the deadline. */
     FAILED = "FAILED",
-    /** Progress tracking is not applicable — participant left, was removed, or was auto-removed. */
+    /** Progress tracking isn't applicable because the participant left, was removed, or was auto-removed. */
     NOT_APPLICABLE = "NOT_APPLICABLE"
 }
 /** @enumType */
@@ -221,7 +242,8 @@ interface EnrollmentInfo extends EnrollmentInfoPricingTypeDetailsOneOf {
      */
     timeZone?: string;
     /**
-     * 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.
+     * Date when the participant's program timeline begins, in `YYYY-MM-DD` format.
+     * If the program's `timeline.startDate` is set, this is that date. Otherwise, it's the local calendar date when the participant is created, based on the site's time zone.
      * @format LOCAL_DATE
      * @readonly
      */
@@ -229,7 +251,9 @@ interface EnrollmentInfo extends EnrollmentInfoPricingTypeDetailsOneOf {
     /** Pricing type used for the participant's enrollment in the program. */
     pricingType?: PricingTypeWithLiterals;
     /**
-     * Date by which the participant must complete the program. Null if the program has no deadline. Set if the program has a fixed end date or a duration-based deadline calculated from the participant's start date.
+     * Date by which the participant must complete the program, in `YYYY-MM-DD` format.
+     *
+     * Returned only when the program has a fixed end date, or a duration-based deadline calculated from the participant's start date.
      * @format LOCAL_DATE
      * @readonly
      */
@@ -321,16 +345,13 @@ interface Schema {
     label?: string;
     clusterName?: string;
 }
-/**
- * Domain event emitted when a participant's tags are modified.
- * Pre-publication rename from TagsModified; no consumers of the legacy FQN are known.
- */
+/** Domain event emitted when a participant's tags are modified. */
 interface ParticipantTagsModified {
-    /** The Participant with updated tags */
+    /** The participant with the updated tags. */
     participant?: Participant;
-    /** Tags that were assigned */
+    /** Tags that were assigned. */
     assignedTags?: Tags;
-    /** Tags that were unassigned */
+    /** Tags that were unassigned. */
     unassignedTags?: Tags;
 }
 /** Domain event emitted when a participant completes a program. */
@@ -434,11 +455,11 @@ interface ParticipantLeft {
     participant?: Participant;
 }
 interface CreateParticipantRequest {
-    /** Participant to create */
+    /** Participant to create. */
     participant: Participant;
     /**
      * Array of conditional fields to include in the response.
-     * Use `RequestedFields.PROGRESS` to include the progress field, which requires calculating completion statistics across all program steps. Only request this field when you need current progress data, as it impacts performance.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which requires calculating completion statistics across all program steps. Only request this field when you need current progress data, as it impacts performance.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -454,7 +475,7 @@ declare enum RequestedFields {
 /** @enumType */
 type RequestedFieldsWithLiterals = RequestedFields | 'PROGRESS';
 interface CreateParticipantResponse {
-    /** Created participant */
+    /** Created participant. */
     participant?: Participant;
 }
 interface UpdateParticipantRequest {
@@ -462,13 +483,13 @@ interface UpdateParticipantRequest {
     participant: Participant;
     /**
      * Array of conditional fields to include in the response.
-     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 interface UpdateParticipantResponse {
-    /** Updated participant */
+    /** Updated participant. */
     participant?: Participant;
 }
 interface BulkCreateParticipantsRequest {
@@ -478,11 +499,11 @@ interface BulkCreateParticipantsRequest {
      * @maxSize 100
      */
     participants: Participant[];
-    /** Whether to return entities in response or not. */
+    /** Whether to return the created participants in the response. */
     returnEntity?: boolean;
     /**
      * Array of conditional fields to include in the response.
-     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -500,7 +521,7 @@ interface BulkCreateParticipantsResponse {
 interface BulkParticipantResult {
     /** Metadata for the item. */
     itemMetadata?: ItemMetadata;
-    /** The participant entity. Empty if `return_entity` is `false`. */
+    /** The participant entity. Empty if `returnEntity` is `false`. */
     item?: Participant;
 }
 interface ItemMetadata {
@@ -560,7 +581,7 @@ interface BulkUpsertParticipantsMigrationResponse {
 interface BulkParticipantMigrationResult {
     /** Metadata for the item. */
     itemMetadata?: ItemMetadata;
-    /** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */
+    /** Action type of the bulk action (INSERT or UPDATE) for that method. */
     action?: BulkActionTypeWithLiterals;
 }
 declare enum BulkActionType {
@@ -596,7 +617,7 @@ interface SynchronizeTimeCapsuleTasksRequest {
 }
 interface SynchronizeTimeCapsuleTasksResponse {
     /**
-     * ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -616,7 +637,7 @@ interface BulkCreateParticipantsForAllMembersRequest {
 }
 interface BulkCreateParticipantsForAllMembersResponse {
     /**
-     * ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -638,13 +659,13 @@ interface IssueCertificateRequest {
     participantId: string;
     /**
      * Array of conditional fields to include in the response.
-     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 interface IssueCertificateResponse {
-    /** Updated participant */
+    /** Updated participant. */
     participant?: Participant;
 }
 interface GetCertificateDownloadUrlRequest {
@@ -671,19 +692,19 @@ interface GetCompletionStatsRequest {
     programId?: string;
 }
 interface GetCompletionStatsResponse {
-    /** Number of participants that completed the program */
+    /** Number of participants who completed the program. */
     completedParticipantsCount?: number;
-    /** Percentage of participants that completed the program */
+    /** Percentage of participants who completed the program. */
     completionRate?: number;
 }
 interface GetPremiumStatsRequest {
 }
 interface GetPremiumStatsResponse {
-    /** True if site has Online Programs premium feature */
+    /** Whether the site has the Online Programs premium feature. */
     premiumEnabled?: boolean;
-    /** Count of active participants on the site */
+    /** Number of active participants on the site. */
     activeParticipantsCount?: number;
-    /** Limit of active participants on a site without premium */
+    /** Maximum number of active participants allowed on a site without premium. */
     activeParticipantsLimit?: number;
 }
 interface GetParticipationStatsRequest {
@@ -721,7 +742,7 @@ interface GetParticipantRequest {
     participantId: string;
     /**
      * Array of conditional fields to include in the response.
-     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -731,11 +752,11 @@ interface GetParticipantResponse {
     participant?: Participant;
 }
 interface QueryParticipantsRequest {
-    /** Platformized query */
+    /** Query options. */
     query?: QueryV2;
     /**
      * Array of conditional fields to include in the response.
-     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -847,47 +868,47 @@ interface Cursors {
 interface GetAccessStatusRequest {
 }
 interface GetAccessStatusResponse {
-    /** True if participants cannot access online programs due to some limitations */
+    /** Whether participants are blocked from accessing online programs because of site limitations. */
     accessBlocked?: boolean;
 }
 interface BulkUpdateParticipantTagsRequest {
     /**
-     * Participant IDs to update tags for (1-100 items)
+     * IDs of the participants to update tags for. Provide 1 to 100 IDs.
      * @minSize 1
      * @maxSize 100
      * @format GUID
      */
     participantIds: string[];
-    /** Tags to assign to the Participants */
+    /** Tags to assign to the participants. */
     assignTags?: Tags;
-    /** Tags to unassign from the Participants */
+    /** Tags to unassign from the participants. */
     unassignTags?: Tags;
 }
 interface BulkUpdateParticipantTagsResponse {
     /**
-     * Results for each Participant
+     * Results for each participant.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkUpdateParticipantTagsResult[];
-    /** Metadata about the bulk operation */
+    /** Metadata about the bulk operation. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUpdateParticipantTagsResult {
-    /** Metadata for this specific item */
+    /** Metadata for this specific item. */
     itemMetadata?: ItemMetadata;
 }
 interface BulkUpdateParticipantTagsByFilterRequest {
-    /** WQL filter to select Participants */
+    /** WQL filter that selects the participants to update. */
     filter: Record<string, any> | null;
-    /** Tags to assign to matching Participants */
+    /** Tags to assign to matching participants. */
     assignTags?: Tags;
-    /** Tags to unassign from matching Participants */
+    /** Tags to unassign from matching participants. */
     unassignTags?: Tags;
 }
 interface BulkUpdateParticipantTagsByFilterResponse {
     /**
-     * Job ID for tracking the async operation. Pass this ID to Get Async Job to track the operation status.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -897,7 +918,7 @@ interface SearchParticipantsRequest {
     search?: CursorSearch;
     /**
      * Array of conditional fields to include in the response.
-     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default.
      * @maxSize 1
      */
     fields?: RequestedFieldsWithLiterals[];