@wix/auto_sdk_online-programs_participants 1.0.7 → 1.0.8

package/build/cjs/index.typings.d.ts

@@ -32,11 +32,11 @@ interface Participant {
     progress?: Progress;
     /** state of participation in the program */
     state?: StateWithLiterals;
-    /** Certificate issued to participant */
+    /**
+     * Certificate issued to participant
+     * @readonly
+     */
     certificate?: Certificate;
-    /** @readonly */
-    paymentInfo?: PaymentInfo;
-    /** @readonly */
     joinedInfo?: JoinedInfo;
     /** @readonly */
     member?: Member;
@@ -59,6 +59,20 @@ declare enum JoinPath {
 }
 /** @enumType */
 type JoinPathWithLiterals = JoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
+interface SinglePaymentDetails {
+    /** @format GUID */
+    paymentOrderId?: string;
+    /** @format GUID */
+    offlineTransactionId?: string | null;
+}
+interface PaidPlanDetails {
+    /** @format GUID */
+    paidPlanId?: string;
+}
+interface FreeCouponDetails {
+    /** @format GUID */
+    freeCouponId?: string;
+}
 interface Progress {
     /** Number of program steps completed by member */
     totalStepsCompleted?: number;
@@ -97,26 +111,32 @@ interface Certificate {
      */
     issuedDate?: Date | null;
 }
-interface PaymentInfo {
-    /** @format GUID */
-    paymentOrderId?: string | null;
-    /** @format GUID */
-    offlineTrxId?: string | null;
-    /** @format GUID */
-    paidPlanId?: string | null;
-    /** @format GUID */
-    freeCouponId?: string | null;
-}
-interface JoinedInfo {
-    /** @maxLength 50 */
+interface JoinedInfo extends JoinedInfoJoinPathDetailsOneOf {
+    singlePaymentDetails?: SinglePaymentDetails;
+    paidPlanDetails?: PaidPlanDetails;
+    freeCouponDetails?: FreeCouponDetails;
+    /**
+     * @maxLength 50
+     * @readonly
+     */
     timeZone?: string;
-    /** @format LOCAL_DATE */
+    /**
+     * @format LOCAL_DATE
+     * @readonly
+     */
     startDate?: string;
     joinPath?: JoinPathWithLiterals;
-    /** @format LOCAL_DATE */
+    /**
+     * @format LOCAL_DATE
+     * @readonly
+     */
     finishDate?: string | null;
-    /** @readonly */
-    joinedAt?: Date | null;
+}
+/** @oneof */
+interface JoinedInfoJoinPathDetailsOneOf {
+    singlePaymentDetails?: SinglePaymentDetails;
+    paidPlanDetails?: PaidPlanDetails;
+    freeCouponDetails?: FreeCouponDetails;
 }
 interface Member {
     /**
@@ -833,6 +853,12 @@ interface ParticipantExportsFinished {
     /** days url will be downloadable */
     downloadUrlTtlDays?: number;
 }
+/** @docsIgnore */
+type CreateParticipantApplicationErrors = {
+    code?: 'INVALID_PAYMENT_INFO';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -926,7 +952,9 @@ declare function onParticipantInvited(handler: (event: ParticipantInvitedEnvelop
  * @returns Created participant
  * @fqn wix.onlineprograms.participants.v3.ParticipantsService.CreateParticipant
  */
-declare function createParticipant(participant: Participant): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 3>>;
+declare function createParticipant(participant: Participant): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 4> & {
+    __applicationErrorsType?: CreateParticipantApplicationErrors;
+}>;
 /**
  * Creates participants in bulk.
  * @param participants - List of participants you want to create
@@ -983,7 +1011,7 @@ declare function deleteParticipant(participantId: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.onlineprograms.participants.v3.ParticipantsService.IssueCertificate
  */
-declare function issueCertificate(participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId`, 4>>;
+declare function issueCertificate(participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state` | `participant.joinedInfo.singlePaymentDetails.paymentOrderId` | `participant.joinedInfo.paidPlanDetails.paidPlanId` | `participant.joinedInfo.freeCouponDetails.freeCouponId` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId`, 5>>;
 /**
  * Get program's completion stats
  * @param programId - program id to get stats for
@@ -1016,7 +1044,7 @@ declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResp
  * @returns existing participant
  * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
  */
-declare function getParticipant(participantId: string): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 3>>;
+declare function getParticipant(participantId: string): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 4>>;
 /**
  * Query existing participants
  * @public
@@ -1092,7 +1120,7 @@ interface ParticipantsQueryBuilder {
  * @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
  * @requiredField query
  */
-declare function typedQueryParticipants(query: CursorQuery): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.state` | `participants.${number}.joinedInfo.timeZone` | `participants.${number}.joinedInfo.startDate` | `participants.${number}.joinedInfo.joinPath` | `participants.${number}.member.contactId`, 5>>;
+declare function typedQueryParticipants(query: CursorQuery): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.state` | `participants.${number}.joinedInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.joinedInfo.paidPlanDetails.paidPlanId` | `participants.${number}.joinedInfo.freeCouponDetails.freeCouponId` | `participants.${number}.joinedInfo.timeZone` | `participants.${number}.joinedInfo.startDate` | `participants.${number}.joinedInfo.joinPath` | `participants.${number}.member.contactId`, 6>>;
 /**
  * Get access status
  * @public
@@ -1214,4 +1242,4 @@ interface BulkApproveAllParticipantOptions {
     excludeParticipantIds?: string[];
 }
 
-export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type Behavior, type BehaviorBehaviorOneOf, type Benefit, type BenefitNotification, BenefitType, type BenefitTypeWithLiterals, type BulkActionMetadata, type BulkAddAllToProgramOptions, type BulkAddAllToProgramRequest, type BulkAddAllToProgramResponse, type BulkAddToProgramOptions, type BulkAddToProgramRequest, type BulkAddToProgramResponse, type BulkAddToProgramResult, type BulkApproveAllParticipantOptions, type BulkApproveAllParticipantRequest, type BulkApproveAllParticipantResponse, type BulkApproveParticipantOptions, type BulkApproveParticipantRequest, type BulkApproveParticipantResponse, type BulkApproveParticipantResult, type BulkCreateParticipantOptions, type BulkCreateParticipantRequest, type BulkCreateParticipantResponse, type BulkInviteAllToProgramOptions, type BulkInviteAllToProgramRequest, type BulkInviteAllToProgramResponse, type BulkInviteToProgramOptions, type BulkInviteToProgramRequest, type BulkInviteToProgramResponse, type BulkInviteToProgramResult, type BulkParticipantResult, type Certificate, type CommonBulkActionMetadata, type CommonItemMetadata, type CreateParticipantRequest, type CreateParticipantResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteParticipantRequest, type DeleteParticipantResponse, type Discount, type DiscountDiscountOneOf, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntryPass, Event, type EventMetadata, type EventWithLiterals, type ExportParticipantsStatsRequest, type ExportParticipantsStatsResponse, type ExtendedFields, type GetAccessStatusRequest, type GetAccessStatusResponse, type GetCompletionStatsRequest, type GetCompletionStatsResponse, type GetParticipantRequest, type GetParticipantResponse, type GetPremiumStatsRequest, type GetPremiumStatsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IssueCertificateRequest, type IssueCertificateResponse, type ItemMetadata, JoinPath, type JoinPathWithLiterals, type JoinedInfo, type Member, type MessageEnvelope, type Participant, type ParticipantAdded, type ParticipantAddedEnvelope, type ParticipantApproved, type ParticipantApprovedEnvelope, type ParticipantExportsFinished, type ParticipantInvited, type ParticipantInvitedEnvelope, type ParticipantsQueryBuilder, type ParticipantsQueryResult, type PaymentInfo, type Progress, type QueryParticipantsRequest, type QueryParticipantsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkCreateParticipant, bulkInviteAllToProgram, bulkInviteToProgram, createParticipant, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, onParticipantAdded, onParticipantApproved, onParticipantInvited, queryParticipants, typedQueryParticipants };
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type Behavior, type BehaviorBehaviorOneOf, type Benefit, type BenefitNotification, BenefitType, type BenefitTypeWithLiterals, type BulkActionMetadata, type BulkAddAllToProgramOptions, type BulkAddAllToProgramRequest, type BulkAddAllToProgramResponse, type BulkAddToProgramOptions, type BulkAddToProgramRequest, type BulkAddToProgramResponse, type BulkAddToProgramResult, type BulkApproveAllParticipantOptions, type BulkApproveAllParticipantRequest, type BulkApproveAllParticipantResponse, type BulkApproveParticipantOptions, type BulkApproveParticipantRequest, type BulkApproveParticipantResponse, type BulkApproveParticipantResult, type BulkCreateParticipantOptions, type BulkCreateParticipantRequest, type BulkCreateParticipantResponse, type BulkInviteAllToProgramOptions, type BulkInviteAllToProgramRequest, type BulkInviteAllToProgramResponse, type BulkInviteToProgramOptions, type BulkInviteToProgramRequest, type BulkInviteToProgramResponse, type BulkInviteToProgramResult, type BulkParticipantResult, type Certificate, type CommonBulkActionMetadata, type CommonItemMetadata, type CreateParticipantApplicationErrors, type CreateParticipantRequest, type CreateParticipantResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteParticipantRequest, type DeleteParticipantResponse, type Discount, type DiscountDiscountOneOf, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntryPass, Event, type EventMetadata, type EventWithLiterals, type ExportParticipantsStatsRequest, type ExportParticipantsStatsResponse, type ExtendedFields, type FreeCouponDetails, type GetAccessStatusRequest, type GetAccessStatusResponse, type GetCompletionStatsRequest, type GetCompletionStatsResponse, type GetParticipantRequest, type GetParticipantResponse, type GetPremiumStatsRequest, type GetPremiumStatsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IssueCertificateRequest, type IssueCertificateResponse, type ItemMetadata, JoinPath, type JoinPathWithLiterals, type JoinedInfo, type JoinedInfoJoinPathDetailsOneOf, type Member, type MessageEnvelope, type PaidPlanDetails, type Participant, type ParticipantAdded, type ParticipantAddedEnvelope, type ParticipantApproved, type ParticipantApprovedEnvelope, type ParticipantExportsFinished, type ParticipantInvited, type ParticipantInvitedEnvelope, type ParticipantsQueryBuilder, type ParticipantsQueryResult, type Progress, type QueryParticipantsRequest, type QueryParticipantsResponse, type RestoreInfo, type SinglePaymentDetails, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkCreateParticipant, bulkInviteAllToProgram, bulkInviteToProgram, createParticipant, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, onParticipantAdded, onParticipantApproved, onParticipantInvited, queryParticipants, typedQueryParticipants };

package/build/cjs/index.typings.js

@@ -264,8 +264,7 @@ function createParticipant(payload) {
           { path: "participant.createdDate" },
           { path: "participant.updatedDate" },
           { path: "participant.lastActivityDate" },
-          { path: "participant.certificate.issuedDate" },
-          { path: "participant.joinedInfo.joinedAt" }
+          { path: "participant.certificate.issuedDate" }
         ]
       },
       {
@@ -294,8 +293,7 @@ function createParticipant(payload) {
             { path: "participant.createdDate" },
             { path: "participant.updatedDate" },
             { path: "participant.lastActivityDate" },
-            { path: "participant.certificate.issuedDate" },
-            { path: "participant.joinedInfo.joinedAt" }
+            { path: "participant.certificate.issuedDate" }
           ]
         },
         {
@@ -317,8 +315,7 @@ function bulkCreateParticipant(payload) {
           { path: "participants.createdDate" },
           { path: "participants.updatedDate" },
           { path: "participants.lastActivityDate" },
-          { path: "participants.certificate.issuedDate" },
-          { path: "participants.joinedInfo.joinedAt" }
+          { path: "participants.certificate.issuedDate" }
         ]
       },
       {
@@ -347,8 +344,7 @@ function bulkCreateParticipant(payload) {
             { path: "results.item.createdDate" },
             { path: "results.item.updatedDate" },
             { path: "results.item.lastActivityDate" },
-            { path: "results.item.certificate.issuedDate" },
-            { path: "results.item.joinedInfo.joinedAt" }
+            { path: "results.item.certificate.issuedDate" }
           ]
         },
         {
@@ -426,8 +422,7 @@ function issueCertificate(payload) {
             { path: "participant.createdDate" },
             { path: "participant.updatedDate" },
             { path: "participant.lastActivityDate" },
-            { path: "participant.certificate.issuedDate" },
-            { path: "participant.joinedInfo.joinedAt" }
+            { path: "participant.certificate.issuedDate" }
           ]
         },
         {
@@ -511,8 +506,7 @@ function getParticipant(payload) {
             { path: "participant.createdDate" },
             { path: "participant.updatedDate" },
             { path: "participant.lastActivityDate" },
-            { path: "participant.certificate.issuedDate" },
-            { path: "participant.joinedInfo.joinedAt" }
+            { path: "participant.certificate.issuedDate" }
           ]
         },
         {
@@ -548,8 +542,7 @@ function queryParticipants(payload) {
             { path: "participants.createdDate" },
             { path: "participants.updatedDate" },
             { path: "participants.lastActivityDate" },
-            { path: "participants.certificate.issuedDate" },
-            { path: "participants.joinedInfo.joinedAt" }
+            { path: "participants.certificate.issuedDate" }
           ]
         },
         {
@@ -606,8 +599,7 @@ function bulkInviteToProgram(payload) {
             { path: "results.item.createdDate" },
             { path: "results.item.updatedDate" },
             { path: "results.item.lastActivityDate" },
-            { path: "results.item.certificate.issuedDate" },
-            { path: "results.item.joinedInfo.joinedAt" }
+            { path: "results.item.certificate.issuedDate" }
           ]
         },
         {
@@ -664,8 +656,7 @@ function bulkAddToProgram(payload) {
             { path: "results.item.createdDate" },
             { path: "results.item.updatedDate" },
             { path: "results.item.lastActivityDate" },
-            { path: "results.item.certificate.issuedDate" },
-            { path: "results.item.joinedInfo.joinedAt" }
+            { path: "results.item.certificate.issuedDate" }
           ]
         },
         {
@@ -701,8 +692,7 @@ function bulkApproveParticipant(payload) {
             { path: "results.item.createdDate" },
             { path: "results.item.updatedDate" },
             { path: "results.item.lastActivityDate" },
-            { path: "results.item.certificate.issuedDate" },
-            { path: "results.item.joinedInfo.joinedAt" }
+            { path: "results.item.certificate.issuedDate" }
           ]
         },
         {