@wix/auto_sdk_online-programs_participants 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,187 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { JoinProgramResponse, Participant, ParticipantsQueryBuilder, GetAccessStatusResponse, ApplyCouponIdentifiers, ApplyCouponResponse, RevertCouponIdentifiers, RevertCouponResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkAddAllToProgramOptions, BulkAddAllToProgramResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, IssueCertificateResponse, GetCompletionStatsResponse, GetPremiumStatsResponse, ParticipantJoinedEnvelope, ParticipantLeftEnvelope, ParticipantDeletedEnvelope, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope, ParticipantRejectedEnvelope } from './index.typings.js';
+export { AccountInfo, ActionEvent, Address, AddressLocation, AddressStreetOneOf, ApplicationError, ApplyCouponRequest, AutoRemovedOptions, BaseEventMetadata, Behavior, BehaviorBehaviorOneOf, Benefit, BenefitNotification, BenefitType, BenefitTypeWithLiterals, BulkActionMetadata, BulkAddAllToProgramRequest, BulkAddToProgramRequest, BulkAddToProgramResult, BulkApproveAllParticipantRequest, BulkApproveParticipantRequest, BulkApproveParticipantResult, BulkInviteAllToProgramRequest, BulkInviteToProgramRequest, BulkInviteToProgramResult, Certificate, CompleteParticipantRequest, CompleteParticipantResponse, CompletedOptions, CreditCardPaymentMethodData, CurrencyAmount, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteParticipantRequest, DeleteParticipantResponse, Discount, DiscountDiscountOneOf, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntryPass, Event, EventMetadata, EventType, EventTypeWithLiterals, EventWithLiterals, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse, ExtendedFields, FailedOptions, FreeCouponOptions, FullAddressContactDetails, GetAccessStatusRequest, GetCompletionStatsRequest, GetParticipantRequest, GetParticipantResponse, GetPremiumStatsRequest, IdentificationData, IdentificationDataIdOneOf, Initiator, InitiatorWithLiterals, IssueCertificateRequest, ItemMetadata, JoinPath, JoinPathWithLiterals, JoinProgramRequest, JoinedOptions, JoinedOptionsJoinPathOptionsOneOf, LeaveProgramRequest, LeaveProgramResponse, MessageEnvelope, OfflinePaymentSent, Order, OrderAdditionalCharges, OrderItem, OrderItemCategory, OrderItemCategoryWithLiterals, PaidPlanOptions, ParticipantAdded, ParticipantApproved, ParticipantExportsFinished, ParticipantInvited, ParticipantJoined, ParticipantLeft, ParticipantRejected, ParticipantStateOptionsOneOf, ParticipantsBulkCompleteEvent, ParticipantsBulkDeleteEvent, ParticipantsQueryResult, PaymentEvent, PaymentEventEventOneOf, PaymentFailed, PaymentPendingOptions, Progress, QueryParticipantsRequest, QueryParticipantsResponse, RecurringPaymentCancellationDetails, RecurringPaymentDetails, RecurringPaymentStatusChangedEvent, Refund, RefundStatus, RefundStatusChangedEvent, RefundStatusWithLiterals, RemovalReason, RemovalReasonWithLiterals, RestoreInfo, RevertCouponRequest, ScheduledAction, ScheduledActionType, ScheduledActionTypeWithLiterals, SinglePaymentConfirmed, SinglePaymentDeclined, SinglePaymentOptions, SortOrder, SortOrderWithLiterals, Sorting, StandardDetails, State, StateWithLiterals, Status, StatusWithLiterals, StreetAddress, Subdivision, SubdivisionType, SubdivisionTypeWithLiterals, SuspendedOptions, Transaction, TransactionCreatedEvent, TransactionPaymentMethodDataOneOf, TransactionStatus, TransactionStatusChangedEvent, TransactionStatusWithLiterals, TransactionUpdatedEvent, VatId, VatType, VatTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function joinProgram$1(httpClient: HttpClient): JoinProgramSignature;
+interface JoinProgramSignature {
+    /**
+     * Member joins the program. By the type of program, participant in corresponding
+     * state will be created.
+     * @param - Program to join
+     */
+    (programId: string): Promise<NonNullablePaths<JoinProgramResponse, `participant.paymentPendingOptions.paidPlanIds` | `participant.joinedOptions.singlePaymentOptions.orderId` | `participant.joinedOptions.paidPlanOptions.planIds` | `participant.joinedOptions.freeCouponOptions.couponId` | `participant.joinedOptions.timeZone` | `participant.joinedOptions.startDate` | `participant.joinedOptions.joinPath` | `participant.completedOptions.startDate` | `participant.failedOptions.startDate` | `participant.suspendedOptions.startDate` | `participant.autoRemovedOptions.startDate` | `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state`, 5>>;
+}
+declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
+interface GetParticipantSignature {
+    /**
+     * Returns participant.
+     * @param - Participant id to fetch
+     * @returns existing participant
+     */
+    (participantId: string): Promise<NonNullablePaths<Participant, `paymentPendingOptions.paidPlanIds` | `joinedOptions.singlePaymentOptions.orderId` | `joinedOptions.paidPlanOptions.planIds` | `joinedOptions.freeCouponOptions.couponId` | `joinedOptions.timeZone` | `joinedOptions.startDate` | `joinedOptions.joinPath` | `completedOptions.startDate` | `failedOptions.startDate` | `suspendedOptions.startDate` | `autoRemovedOptions.startDate` | `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state`, 4>>;
+}
+declare function leaveProgram$1(httpClient: HttpClient): LeaveProgramSignature;
+interface LeaveProgramSignature {
+    /**
+     * Participant leaves program. Entity will be deleted. Idempotent call.
+     * @param - Participant id to leave program
+     */
+    (participantId: string): Promise<void>;
+}
+declare function queryParticipants$1(httpClient: HttpClient): QueryParticipantsSignature;
+interface QueryParticipantsSignature {
+    /**
+     * Query existing participants
+     */
+    (): ParticipantsQueryBuilder;
+}
+declare function getAccessStatus$1(httpClient: HttpClient): GetAccessStatusSignature;
+interface GetAccessStatusSignature {
+    /**
+     * Get access status
+     */
+    (): Promise<NonNullablePaths<GetAccessStatusResponse, `isBlocked`, 2>>;
+}
+declare function applyCoupon$1(httpClient: HttpClient): ApplyCouponSignature;
+interface ApplyCouponSignature {
+    /**
+     * Apply coupon to order
+     */
+    (identifiers: NonNullablePaths<ApplyCouponIdentifiers, `couponCode` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<ApplyCouponResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
+}
+declare function revertCoupon$1(httpClient: HttpClient): RevertCouponSignature;
+interface RevertCouponSignature {
+    /**
+     * Remove coupon from order
+     */
+    (identifiers: NonNullablePaths<RevertCouponIdentifiers, `couponId` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<RevertCouponResponse, `total`, 2>>;
+}
+declare function bulkInviteToProgram$1(httpClient: HttpClient): BulkInviteToProgramSignature;
+interface BulkInviteToProgramSignature {
+    /**
+     * Bulk invites participants to program.
+     * For each member participant in Invited state is created.
+     * @param - Program to which bulk invite participants.
+     */
+    (programId: string, options?: BulkInviteToProgramOptions): Promise<NonNullablePaths<BulkInviteToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.joinedOptions.timeZone` | `results.${number}.item.joinedOptions.startDate` | `results.${number}.item.joinedOptions.joinPath` | `results.${number}.item.completedOptions.startDate` | `results.${number}.item.failedOptions.startDate` | `results.${number}.item.suspendedOptions.startDate` | `results.${number}.item.autoRemovedOptions.startDate` | `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.state` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkInviteAllToProgram$1(httpClient: HttpClient): BulkInviteAllToProgramSignature;
+interface BulkInviteAllToProgramSignature {
+    /**
+     * Bulk invites all participants to program, but not more then 1000.
+     * For each member participant in Invited state is created.
+     * @param - Program to which bulk add participants.
+     */
+    (programId: string, options?: BulkInviteAllToProgramOptions): Promise<NonNullablePaths<BulkInviteAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
+}
+declare function bulkAddToProgram$1(httpClient: HttpClient): BulkAddToProgramSignature;
+interface BulkAddToProgramSignature {
+    /**
+     * Bulk adds participants to program.
+     * Participant will be either created in state Joined, or updated to that state
+     * from pending one.
+     * @param - Program to which bulk add participants.
+     */
+    (programId: string, options?: BulkAddToProgramOptions): Promise<NonNullablePaths<BulkAddToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.joinedOptions.timeZone` | `results.${number}.item.joinedOptions.startDate` | `results.${number}.item.joinedOptions.joinPath` | `results.${number}.item.completedOptions.startDate` | `results.${number}.item.failedOptions.startDate` | `results.${number}.item.suspendedOptions.startDate` | `results.${number}.item.autoRemovedOptions.startDate` | `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.state` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkAddAllToProgram$1(httpClient: HttpClient): BulkAddAllToProgramSignature;
+interface BulkAddAllToProgramSignature {
+    /**
+     * Bulk adds all site members to program, but not more then 1000.
+     * Participant will be either created in state Joined, or updated to that state
+     * from pending one.
+     * @param - Program to which bulk add participants.
+     */
+    (programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
+}
+declare function bulkApproveParticipant$1(httpClient: HttpClient): BulkApproveParticipantSignature;
+interface BulkApproveParticipantSignature {
+    /**
+     * Bulk approves participants, who asked to join private program (aka in
+     * state `APPROVAL_PENDING`). If participant was in other state, no effect and
+     * error returned.
+     * @param - Participants to add
+     */
+    (participantIds: string[], options?: BulkApproveParticipantOptions): Promise<NonNullablePaths<BulkApproveParticipantResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.joinedOptions.timeZone` | `results.${number}.item.joinedOptions.startDate` | `results.${number}.item.joinedOptions.joinPath` | `results.${number}.item.completedOptions.startDate` | `results.${number}.item.failedOptions.startDate` | `results.${number}.item.suspendedOptions.startDate` | `results.${number}.item.autoRemovedOptions.startDate` | `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.state` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkApproveAllParticipant$1(httpClient: HttpClient): BulkApproveAllParticipantSignature;
+interface BulkApproveAllParticipantSignature {
+    /**
+     * Bulk approves all pending participants, who asked to join private program (aka
+     * in state `APPROVAL_PENDING`).
+     */
+    (options?: BulkApproveAllParticipantOptions): Promise<NonNullablePaths<BulkApproveAllParticipantResponse, `jobId`, 2>>;
+}
+declare function deleteParticipant$1(httpClient: HttpClient): DeleteParticipantSignature;
+interface DeleteParticipantSignature {
+    /**
+     * Delete participant from program by owner will. Removes participant from member
+     * group. Leaves him in Social Group.
+     * @param - Participants to delete
+     */
+    (participantId: string): Promise<void>;
+}
+declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
+interface IssueCertificateSignature {
+    /**
+     * Issue certificate by site admin
+     * @param - Participant to get certificate
+     */
+    (participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.paymentPendingOptions.paidPlanIds` | `participant.joinedOptions.singlePaymentOptions.orderId` | `participant.joinedOptions.paidPlanOptions.planIds` | `participant.joinedOptions.freeCouponOptions.couponId` | `participant.joinedOptions.timeZone` | `participant.joinedOptions.startDate` | `participant.joinedOptions.joinPath` | `participant.completedOptions.startDate` | `participant.failedOptions.startDate` | `participant.suspendedOptions.startDate` | `participant.autoRemovedOptions.startDate` | `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state`, 5>>;
+}
+declare function getCompletionStats$1(httpClient: HttpClient): GetCompletionStatsSignature;
+interface GetCompletionStatsSignature {
+    /**
+     * Get program's completion stats
+     * @param - program id to get stats for
+     */
+    (programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
+}
+declare function getPremiumStats$1(httpClient: HttpClient): GetPremiumStatsSignature;
+interface GetPremiumStatsSignature {
+    /**
+     * Get premium stats
+     */
+    (): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
+}
+declare const onParticipantJoined$1: EventDefinition<ParticipantJoinedEnvelope, "wix.online_programs.v3.participant_participant_joined">;
+declare const onParticipantLeft$1: EventDefinition<ParticipantLeftEnvelope, "wix.online_programs.v3.participant_participant_left">;
+declare const onParticipantDeleted$1: EventDefinition<ParticipantDeletedEnvelope, "wix.online_programs.v3.participant_deleted">;
+declare const onParticipantAdded$1: EventDefinition<ParticipantAddedEnvelope, "wix.online_programs.v3.participant_participant_added">;
+declare const onParticipantApproved$1: EventDefinition<ParticipantApprovedEnvelope, "wix.online_programs.v3.participant_participant_approved">;
+declare const onParticipantInvited$1: EventDefinition<ParticipantInvitedEnvelope, "wix.online_programs.v3.participant_participant_invited">;
+declare const onParticipantRejected$1: EventDefinition<ParticipantRejectedEnvelope, "wix.online_programs.v3.participant_participant_rejected">;
+
+declare const joinProgram: MaybeContext<BuildRESTFunction<typeof joinProgram$1> & typeof joinProgram$1>;
+declare const getParticipant: MaybeContext<BuildRESTFunction<typeof getParticipant$1> & typeof getParticipant$1>;
+declare const leaveProgram: MaybeContext<BuildRESTFunction<typeof leaveProgram$1> & typeof leaveProgram$1>;
+declare const queryParticipants: MaybeContext<BuildRESTFunction<typeof queryParticipants$1> & typeof queryParticipants$1>;
+declare const getAccessStatus: MaybeContext<BuildRESTFunction<typeof getAccessStatus$1> & typeof getAccessStatus$1>;
+declare const applyCoupon: MaybeContext<BuildRESTFunction<typeof applyCoupon$1> & typeof applyCoupon$1>;
+declare const revertCoupon: MaybeContext<BuildRESTFunction<typeof revertCoupon$1> & typeof revertCoupon$1>;
+declare const bulkInviteToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteToProgram$1> & typeof bulkInviteToProgram$1>;
+declare const bulkInviteAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteAllToProgram$1> & typeof bulkInviteAllToProgram$1>;
+declare const bulkAddToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddToProgram$1> & typeof bulkAddToProgram$1>;
+declare const bulkAddAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddAllToProgram$1> & typeof bulkAddAllToProgram$1>;
+declare const bulkApproveParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveParticipant$1> & typeof bulkApproveParticipant$1>;
+declare const bulkApproveAllParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveAllParticipant$1> & typeof bulkApproveAllParticipant$1>;
+declare const deleteParticipant: MaybeContext<BuildRESTFunction<typeof deleteParticipant$1> & typeof deleteParticipant$1>;
+declare const issueCertificate: MaybeContext<BuildRESTFunction<typeof issueCertificate$1> & typeof issueCertificate$1>;
+declare const getCompletionStats: MaybeContext<BuildRESTFunction<typeof getCompletionStats$1> & typeof getCompletionStats$1>;
+declare const getPremiumStats: MaybeContext<BuildRESTFunction<typeof getPremiumStats$1> & typeof getPremiumStats$1>;
+/** */
+declare const onParticipantJoined: BuildEventDefinition<typeof onParticipantJoined$1> & typeof onParticipantJoined$1;
+/** */
+declare const onParticipantLeft: BuildEventDefinition<typeof onParticipantLeft$1> & typeof onParticipantLeft$1;
+/** */
+declare const onParticipantDeleted: BuildEventDefinition<typeof onParticipantDeleted$1> & typeof onParticipantDeleted$1;
+/** */
+declare const onParticipantAdded: BuildEventDefinition<typeof onParticipantAdded$1> & typeof onParticipantAdded$1;
+/** */
+declare const onParticipantApproved: BuildEventDefinition<typeof onParticipantApproved$1> & typeof onParticipantApproved$1;
+/** */
+declare const onParticipantInvited: BuildEventDefinition<typeof onParticipantInvited$1> & typeof onParticipantInvited$1;
+/** */
+declare const onParticipantRejected: BuildEventDefinition<typeof onParticipantRejected$1> & typeof onParticipantRejected$1;
+
+export { ApplyCouponIdentifiers, ApplyCouponResponse, BulkAddAllToProgramOptions, BulkAddAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, GetAccessStatusResponse, GetCompletionStatsResponse, GetPremiumStatsResponse, IssueCertificateResponse, JoinProgramResponse, Participant, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantDeletedEnvelope, ParticipantInvitedEnvelope, ParticipantJoinedEnvelope, ParticipantLeftEnvelope, ParticipantRejectedEnvelope, ParticipantsQueryBuilder, RevertCouponIdentifiers, RevertCouponResponse, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, onParticipantAdded, onParticipantApproved, onParticipantDeleted, onParticipantInvited, onParticipantJoined, onParticipantLeft, onParticipantRejected, queryParticipants, revertCoupon };