@wix/auto_sdk_online-programs_participants 1.0.0

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

@@ -0,0 +1,1866 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface Participant extends ParticipantStateOptionsOneOf {
+    paymentPendingOptions?: PaymentPendingOptions;
+    joinedOptions?: JoinedOptions;
+    completedOptions?: CompletedOptions;
+    failedOptions?: FailedOptions;
+    suspendedOptions?: SuspendedOptions;
+    /** options for auto removed participant */
+    autoRemovedOptions?: AutoRemovedOptions;
+    /**
+     * Participant ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /** @readonly */
+    revision?: string | null;
+    /** @readonly */
+    _createdDate?: Date | null;
+    /** @readonly */
+    _updatedDate?: Date | null;
+    /**
+     * Member ID of participant on site
+     * @format GUID
+     * @readonly
+     */
+    memberId?: string;
+    /**
+     * Program ID which participant participates in
+     * @format GUID
+     * @readonly
+     */
+    programId?: string;
+    /**
+     * Program completion progress
+     * @readonly
+     */
+    progress?: Progress;
+    /** state of participation in the program */
+    state?: StateWithLiterals;
+    /** Certificate issued to participant */
+    certificate?: Certificate;
+    extendedFields?: ExtendedFields;
+}
+/** @oneof */
+interface ParticipantStateOptionsOneOf {
+    paymentPendingOptions?: PaymentPendingOptions;
+    joinedOptions?: JoinedOptions;
+    completedOptions?: CompletedOptions;
+    failedOptions?: FailedOptions;
+    suspendedOptions?: SuspendedOptions;
+    /** options for auto removed participant */
+    autoRemovedOptions?: AutoRemovedOptions;
+}
+declare enum JoinPath {
+    UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
+    /** Member joined to the program for free */
+    FREE = "FREE",
+    /** Member was added to the program by site owner */
+    ADDED = "ADDED",
+    /** Member paid once to join the program */
+    SINGLE_PAYMENT = "SINGLE_PAYMENT",
+    /** Member has Paid Plan to join */
+    PAID_PLAN = "PAID_PLAN",
+    /** Member joined with the Free Coupon */
+    FREE_COUPON = "FREE_COUPON"
+}
+/** @enumType */
+type JoinPathWithLiterals = JoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
+interface SinglePaymentOptions {
+    orderId?: string;
+}
+interface PaidPlanOptions {
+    /** @maxSize 10 */
+    planIds?: string[];
+}
+interface FreeCouponOptions {
+    couponId?: string;
+}
+interface Progress {
+    /** Number of program steps completed by member */
+    totalStepsCompleted?: number;
+    /** Total number of program steps available to resolve */
+    totalStepsAvailable?: number;
+    /**
+     * Completion percentage
+     * @max 100
+     */
+    completionPercentage?: number;
+}
+declare enum State {
+    /** Unknown state */
+    UNKNOWN_STATE = "UNKNOWN_STATE",
+    /** Member invited to participate in program */
+    INVITED = "INVITED",
+    /** Member asked owner to participate in program */
+    APPROVAL_PENDING = "APPROVAL_PENDING",
+    PAYMENT_PENDING = "PAYMENT_PENDING",
+    /** Member joined the program and became participant */
+    JOINED = "JOINED",
+    /** Participant completed the program, and could join again */
+    COMPLETED = "COMPLETED",
+    /** Participant failed to complete the program, and could join again */
+    FAILED = "FAILED",
+    /** Participant with ended pricing plan (PP), will be joined as renew PP */
+    SUSPENDED = "SUSPENDED",
+    /** Participant removed automatically after some program condition */
+    AUTO_REMOVED = "AUTO_REMOVED"
+}
+/** @enumType */
+type StateWithLiterals = State | 'UNKNOWN_STATE' | 'INVITED' | 'APPROVAL_PENDING' | 'PAYMENT_PENDING' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED';
+interface Certificate {
+    /**
+     * when certificate was issued, UTC
+     * @readonly
+     */
+    issuedDate?: Date | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface PaymentPendingOptions {
+    /**
+     * Payment order
+     * @format GUID
+     */
+    paymentOrderId?: string | null;
+    /**
+     * Offline payment transaction
+     * @format GUID
+     */
+    offlineTrxId?: string | null;
+    /**
+     * Pricing plans
+     * @format GUID
+     * @maxSize 10
+     */
+    paidPlanIds?: string[];
+}
+interface JoinedOptions extends JoinedOptionsJoinPathOptionsOneOf {
+    singlePaymentOptions?: SinglePaymentOptions;
+    paidPlanOptions?: PaidPlanOptions;
+    freeCouponOptions?: FreeCouponOptions;
+    timeZone?: string;
+    /** @format LOCAL_DATE */
+    startDate?: string;
+    joinPath?: JoinPathWithLiterals;
+}
+/** @oneof */
+interface JoinedOptionsJoinPathOptionsOneOf {
+    singlePaymentOptions?: SinglePaymentOptions;
+    paidPlanOptions?: PaidPlanOptions;
+    freeCouponOptions?: FreeCouponOptions;
+}
+interface CompletedOptions {
+    /**
+     * date participant started the program
+     * @format LOCAL_DATE
+     */
+    startDate?: string;
+}
+interface FailedOptions {
+    /**
+     * date participant started the program
+     * @format LOCAL_DATE
+     */
+    startDate?: string;
+}
+interface SuspendedOptions {
+    /**
+     * date participant started the program
+     * @format LOCAL_DATE
+     */
+    startDate?: string;
+}
+interface AutoRemovedOptions {
+    /**
+     * date participant started the program
+     * @format LOCAL_DATE
+     */
+    startDate?: string;
+}
+interface ParticipantsBulkCompleteEvent {
+    /**
+     * Program ID
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Optional cursor for the next result page
+     * @maxLength 16000
+     */
+    cursorNext?: string | null;
+}
+interface ParticipantsBulkDeleteEvent {
+    /**
+     * Program ID
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Optional cursor for the next result page
+     * @maxLength 16000
+     */
+    cursorNext?: string | null;
+}
+interface JoinProgramRequest {
+    /**
+     * Program to join
+     * @format GUID
+     */
+    programId: string;
+}
+interface JoinProgramResponse {
+    /** Created participant with corresponding state */
+    participant?: Participant;
+}
+interface ParticipantJoined {
+    /** Joined participant */
+    participant?: Participant;
+}
+interface GetParticipantRequest {
+    /**
+     * Participant id to fetch
+     * @format GUID
+     */
+    participantId: string;
+}
+interface GetParticipantResponse {
+    /** existing participant */
+    participant?: Participant;
+}
+interface LeaveProgramRequest {
+    /**
+     * Participant id to leave program
+     * @format GUID
+     */
+    participantId: string;
+}
+interface LeaveProgramResponse {
+}
+interface ParticipantLeft {
+    /**
+     * Participant id who left
+     * @format GUID
+     */
+    participantId?: string;
+    /**
+     * Program id participant left
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Participant's member id
+     * @format GUID
+     */
+    memberId?: string;
+    /** Reason for removal */
+    removalReason?: RemovalReasonWithLiterals;
+}
+declare enum RemovalReason {
+    /** Default for backward compatibility */
+    UNKNOWN_REMOVAL_REASON = "UNKNOWN_REMOVAL_REASON",
+    /** User-initiated leave */
+    LEGITIMATE_LEAVE = "LEGITIMATE_LEAVE",
+    /** Cleanup during rejoin flow */
+    CLEANUP_FOR_REJOIN = "CLEANUP_FOR_REJOIN",
+    /** Cleanup during manual addition */
+    CLEANUP_FOR_MANUAL_ADD = "CLEANUP_FOR_MANUAL_ADD"
+}
+/** @enumType */
+type RemovalReasonWithLiterals = RemovalReason | 'UNKNOWN_REMOVAL_REASON' | 'LEGITIMATE_LEAVE' | 'CLEANUP_FOR_REJOIN' | 'CLEANUP_FOR_MANUAL_ADD';
+interface QueryParticipantsRequest {
+    /** Platformized query */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryParticipantsResponse {
+    /** found participants */
+    participants?: Participant[];
+    /** paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface GetAccessStatusRequest {
+}
+interface GetAccessStatusResponse {
+    /** True if participants cannot access online programs due to some limitations */
+    isBlocked?: boolean;
+}
+interface ApplyCouponRequest {
+    /** @format GUID */
+    participantId: string;
+    /** @format GUID */
+    orderId: string;
+    couponCode: string;
+}
+interface ApplyCouponResponse {
+    /** @format GUID */
+    couponId?: string;
+    subTotal?: number;
+    discount?: number;
+    total?: number;
+}
+interface RevertCouponRequest {
+    /** @format GUID */
+    participantId: string;
+    /** @format GUID */
+    orderId: string;
+    /** @format GUID */
+    couponId: string;
+}
+interface RevertCouponResponse {
+    total?: number;
+}
+/** This webhook is triggered whenever a payment transaction is updated (including refunds) via specific [Wix Apps](https://dev.wix.com/api/rest/wix-payments/about-wix-payments). */
+interface PaymentEvent extends PaymentEventEventOneOf {
+    /** `TRANSACTION_STATUS_CHANGED` event details. */
+    transactionStatusChangedEvent?: TransactionStatusChangedEvent;
+    /** `REFUND_STATUS_CHANGED` event details. */
+    refundStatusChangedEvent?: RefundStatusChangedEvent;
+    /**
+     * `RECURRING_PAYMENT_STATUS_CHANGED` event details.
+     * @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
+     * @targetRemovalDate 2026-06-30
+     */
+    recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
+    /** `TRANSACTION_UPDATED` event details. */
+    transactionUpdatedEvent?: TransactionUpdatedEvent;
+    /** `TRANSACTION_CREATED` event details. */
+    transactionCreatedEvent?: TransactionCreatedEvent;
+    /**
+     * Unique event ID.
+     * @format GUID
+     */
+    _id?: string;
+    /** Event timestamp */
+    eventTime?: Date | null;
+    /**
+     * ID of the [Wix app](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions) that triggered this event.
+     * @maxLength 100
+     */
+    wixAppId?: string;
+    /**
+     * Unique ID assigned to each Wix app in each site.
+     * @format GUID
+     */
+    wixAppInstanceId?: string;
+    /** Event type. */
+    eventType?: EventTypeWithLiterals;
+    /**
+     * ID of Wix app that mediated between Wix Payments and the Wix app that triggered the event (if relevant).
+     * @maxLength 100
+     */
+    managingWixAppId?: string | null;
+}
+/** @oneof */
+interface PaymentEventEventOneOf {
+    /** `TRANSACTION_STATUS_CHANGED` event details. */
+    transactionStatusChangedEvent?: TransactionStatusChangedEvent;
+    /** `REFUND_STATUS_CHANGED` event details. */
+    refundStatusChangedEvent?: RefundStatusChangedEvent;
+    /**
+     * `RECURRING_PAYMENT_STATUS_CHANGED` event details.
+     * @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
+     * @targetRemovalDate 2026-06-30
+     */
+    recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
+    /** `TRANSACTION_UPDATED` event details. */
+    transactionUpdatedEvent?: TransactionUpdatedEvent;
+    /** `TRANSACTION_CREATED` event details. */
+    transactionCreatedEvent?: TransactionCreatedEvent;
+}
+declare enum EventType {
+    UNDEFINED = "UNDEFINED",
+    /** Fired when a transaction's status changes. */
+    TRANSACTION_STATUS_CHANGED = "TRANSACTION_STATUS_CHANGED",
+    /** Fired when a refund's status changes. */
+    REFUND_STATUS_CHANGED = "REFUND_STATUS_CHANGED",
+    /** Fired when a legacy subscription's status changes. */
+    RECURRING_PAYMENT_STATUS_CHANGED = "RECURRING_PAYMENT_STATUS_CHANGED",
+    /** Fired when a transaction is updated. */
+    TRANSACTION_UPDATED = "TRANSACTION_UPDATED",
+    /** Fired when a transaction is created. */
+    TRANSACTION_CREATED = "TRANSACTION_CREATED"
+}
+/** @enumType */
+type EventTypeWithLiterals = EventType | 'UNDEFINED' | 'TRANSACTION_STATUS_CHANGED' | 'REFUND_STATUS_CHANGED' | 'RECURRING_PAYMENT_STATUS_CHANGED' | 'TRANSACTION_UPDATED' | 'TRANSACTION_CREATED';
+interface TransactionStatusChangedEvent {
+    /** Order details (limited to 30 items). */
+    order?: Order;
+    /** New transaction details. */
+    transaction?: Transaction;
+    /** Previous transaction status. */
+    previousStatus?: TransactionStatusWithLiterals;
+}
+interface Order {
+    _id?: string;
+    /** Wix app order ID */
+    wixAppOrderId?: string;
+    /** Wix app buyer ID */
+    wixAppBuyerId?: string | null;
+    /** Items included in the order */
+    items?: OrderItem[];
+    /**
+     * total number of items in order
+     * items_total_count > `items`.size if `items` doesn't contain all items
+     */
+    itemsTotalCount?: number;
+    /** Additional charges to the order - e.g., tax, shipping or discount (optional) */
+    additionalCharges?: OrderAdditionalCharges;
+    /** Customer's shipping address (optional) */
+    shippingAddress?: Address;
+    /** Customer's shipping address details (optional) */
+    shippingAddressContacts?: FullAddressContactDetails;
+    /** Order creation date */
+    createdAt?: Date | null;
+    /** External data which is stored with the order */
+    externalData?: Record<string, string>;
+    /**
+     * Vertical invoice ID
+     * @maxLength 200
+     */
+    verticalInvoiceId?: string | null;
+    /** the part of total amount taken by platform from the amount sent to merchant */
+    platformFee?: number | null;
+}
+/** Item included in order */
+interface OrderItem {
+    /** Order item ID (required) */
+    _id?: string;
+    /** Order item name (required) */
+    name?: string;
+    /** Quantity (required) */
+    quantity?: number;
+    /** Total price charged for this item in the order - quantity * price (required) */
+    price?: number;
+    /** Order item description */
+    description?: string;
+    /** Weight of one item */
+    weightInKg?: number;
+    /** Whether the item is a physical a digital product */
+    category?: OrderItemCategoryWithLiterals;
+}
+/** Order item type */
+declare enum OrderItemCategory {
+    UNDEFINED = "UNDEFINED",
+    /** Physical product */
+    PHYSICAL = "PHYSICAL",
+    /** Digital product */
+    DIGITAL = "DIGITAL"
+}
+/** @enumType */
+type OrderItemCategoryWithLiterals = OrderItemCategory | 'UNDEFINED' | 'PHYSICAL' | 'DIGITAL';
+/** Describing any additional charges in the order. They are not required, but can't be added later. */
+interface OrderAdditionalCharges {
+    /** Absolute taxes charged to the order */
+    tax?: number;
+    /** Shipping cost charged to the order */
+    shipping?: number;
+    /** Discount amount applied to the order */
+    discount?: number;
+    /** Application fee */
+    applicationFee?: number;
+}
+/** Physical address */
+interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /**
+     * Country code.
+     * @format COUNTRY
+     */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+/** @enumType */
+type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
+/** Subdivision Concordance values */
+interface StandardDetails {
+    /**
+     * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
+     * @maxLength 20
+     */
+    iso31662?: string | null;
+}
+/** Full contact details for an address */
+interface FullAddressContactDetails {
+    /** Contact's first name. */
+    firstName?: string | null;
+    /** Contact's last name. */
+    lastName?: string | null;
+    /**
+     * Contact's phone number.
+     * @format PHONE
+     */
+    phone?: string | null;
+    /** Contact's company name. */
+    company?: string | null;
+    /**
+     * Email associated with the address.
+     * @format EMAIL
+     */
+    email?: string | null;
+    /** Tax info. Currently usable only in Brazil. */
+    vatId?: VatId;
+}
+interface VatId {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatTypeWithLiterals;
+}
+/** tax info types */
+declare enum VatType {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+/** @enumType */
+type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
+interface Transaction extends TransactionPaymentMethodDataOneOf {
+    creditCardPaymentMethodData?: CreditCardPaymentMethodData;
+    /** Transaction ID */
+    _id?: string;
+    /** Provider transaction ID */
+    providerTransactionId?: string | null;
+    /** Amount and currency of transaction */
+    amount?: CurrencyAmount;
+    /** Refunded amount and currency of transaction */
+    refundedAmount?: CurrencyAmount;
+    /** Updated transaction status */
+    status?: TransactionStatusWithLiterals;
+    /** Reason provided for status change */
+    reasonCode?: string | null;
+    /** Payment method */
+    paymentMethod?: string;
+    /** Payment service provider */
+    paymentProvider?: string;
+    /** Customer's billing address (optional) */
+    billingAddress?: Address;
+    /** Customer's billing address - contact details (optional) */
+    billingAddressContacts?: FullAddressContactDetails;
+    /** Details of subscription, which (if) the transaction is a part of */
+    recurringPaymentDetails?: RecurringPaymentDetails;
+    /** The details of a payment method account. */
+    paymentMethodAccountInfo?: AccountInfo;
+    /** Transaction creation date */
+    createdAt?: Date | null;
+    /** Total number of installments */
+    installments?: number;
+    /** Scheduled action for this transaction */
+    scheduledAction?: ScheduledAction;
+    /**
+     * order id associated with the transaction on the vertical side
+     * @minLength 1
+     * @maxLength 100
+     */
+    verticalOrderId?: string | null;
+}
+/** @oneof */
+interface TransactionPaymentMethodDataOneOf {
+    creditCardPaymentMethodData?: CreditCardPaymentMethodData;
+}
+interface CurrencyAmount {
+    /** Amount */
+    amount?: number;
+    currency?: string;
+}
+declare enum TransactionStatus {
+    UNDEFINED = "UNDEFINED",
+    APPROVED = "APPROVED",
+    PENDING = "PENDING",
+    PENDING_MERCHANT = "PENDING_MERCHANT",
+    CANCELED = "CANCELED",
+    DECLINED = "DECLINED",
+    REFUNDED = "REFUNDED",
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    AUTHORIZED = "AUTHORIZED",
+    VOIDED = "VOIDED"
+}
+/** @enumType */
+type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
+interface RecurringPaymentDetails {
+    /** Current cycle number (Recurring payments only) */
+    cycleNumber?: number;
+}
+interface CreditCardPaymentMethodData {
+    /** Card issuing network */
+    network?: string;
+    /** Card number with only bin and last4 positions showed (non-PCI data) */
+    maskedCreditCard?: string;
+    /** Card holder's full name specified on the card. */
+    holderName?: string;
+    /** Card expiration month. */
+    expiryMonth?: string;
+    /**
+     * Card expiration year.
+     * @minLength 4
+     * @maxLength 4
+     */
+    expiryYear?: string | null;
+    /**
+     * Card last 4 digits.
+     * @minLength 4
+     * @maxLength 4
+     */
+    lastFourDigits?: string | null;
+    /**
+     * Card BIN (Bank Identification Number). It's the first 4-8 digits of a card number.
+     * @minLength 4
+     * @maxLength 8
+     */
+    bin?: string | null;
+}
+interface AccountInfo {
+    /**
+     * The email of an Account used by Payment Method
+     * @format EMAIL
+     */
+    email?: string | null;
+}
+interface ScheduledAction {
+    /** type of the action */
+    type?: ScheduledActionTypeWithLiterals;
+    /** the date and time of the action */
+    executionDate?: Date | null;
+}
+declare enum ScheduledActionType {
+    VOID = "VOID",
+    CAPTURE = "CAPTURE"
+}
+/** @enumType */
+type ScheduledActionTypeWithLiterals = ScheduledActionType | 'VOID' | 'CAPTURE';
+interface RefundStatusChangedEvent {
+    /** Order details (limited to 30 items). */
+    order?: Order;
+    /** Updated transaction details. */
+    transaction?: Transaction;
+    /** Updated refund details. */
+    refund?: Refund;
+    /** Previous refund status. */
+    previousStatus?: RefundStatusWithLiterals;
+}
+interface Refund {
+    _id?: string;
+    /** Amount and currency of refund */
+    amount?: CurrencyAmount;
+    /** Updated refund status */
+    status?: RefundStatusWithLiterals;
+    /** Reason provided for status change */
+    reasonCode?: string | null;
+    /** Refund creation date */
+    createdAt?: Date | null;
+}
+declare enum RefundStatus {
+    UNDEFINED = "UNDEFINED",
+    APPROVED = "APPROVED",
+    PENDING = "PENDING",
+    DECLINED = "DECLINED"
+}
+/** @enumType */
+type RefundStatusWithLiterals = RefundStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'DECLINED';
+interface RecurringPaymentStatusChangedEvent {
+    /** Order details(limited to 30 items). */
+    order?: Order;
+    /** Recurring payment status. */
+    status?: StatusWithLiterals;
+    /** Previous recurring payment status. */
+    previousStatus?: StatusWithLiterals;
+    /** Details of RecurringPayment cancellation (empty if `status` is not CANCELLED). */
+    cancellationDetails?: RecurringPaymentCancellationDetails;
+}
+declare enum Status {
+    UNDEFINED = "UNDEFINED",
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    CANCELLED = "CANCELLED",
+    FINISHED = "FINISHED",
+    SUSPENDED = "SUSPENDED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNDEFINED' | 'PENDING' | 'ACTIVE' | 'CANCELLED' | 'FINISHED' | 'SUSPENDED';
+interface RecurringPaymentCancellationDetails {
+    /** Initiator of cancellation */
+    initiator?: InitiatorWithLiterals;
+    /** Successfully paid recurring cycles count before the cancellation */
+    paidRegularCycleCount?: number;
+}
+declare enum Initiator {
+    UNDEFINED = "UNDEFINED",
+    BUYER = "BUYER",
+    MERCHANT = "MERCHANT",
+    PAYMENT = "PAYMENT",
+    SETUP = "SETUP"
+}
+/** @enumType */
+type InitiatorWithLiterals = Initiator | 'UNDEFINED' | 'BUYER' | 'MERCHANT' | 'PAYMENT' | 'SETUP';
+interface TransactionUpdatedEvent {
+    /** Order details (limited to 30 items). */
+    order?: Order;
+    /** Updated transaction details. */
+    transaction?: Transaction;
+    /** Is event triggered by request to clean user data */
+    triggeredByAnonymizeRequest?: boolean | null;
+}
+interface TransactionCreatedEvent {
+    /** Order details (limited to 30 items). */
+    order?: Order;
+    /** Updated transaction details. */
+    transaction?: Transaction;
+}
+interface Empty {
+}
+interface OfflinePaymentSent {
+    /** Participant who started offline payment */
+    participant?: Participant;
+}
+interface PaymentFailed {
+    /** Participant whose payment was failed */
+    participant?: Participant;
+}
+interface SinglePaymentConfirmed {
+    /** Participant whose payment was confirmed */
+    participant?: Participant;
+}
+interface SinglePaymentDeclined {
+    /** Participant whose payment was declined */
+    participant?: Participant;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface BenefitNotification {
+    /**
+     * Plan unique ID
+     * @format GUID
+     */
+    planId?: string;
+    /**
+     * App def ID
+     * @format GUID
+     */
+    appDefId?: string;
+    /** Current benefit details */
+    benefit?: Benefit;
+    /** Previous benefit */
+    prevBenefit?: Benefit;
+    /** Notification event */
+    event?: EventWithLiterals;
+}
+interface Benefit {
+    /**
+     * Benefit unique ID
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /** Benefit Type */
+    benefitType?: BenefitTypeWithLiterals;
+    /**
+     * Resource IDs that serves by this benefit
+     * @format GUID
+     */
+    resourceIds?: string[];
+    /** Amount of credits that provided by this benefit */
+    creditAmount?: number | null;
+    /**
+     * additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
+     * @maxSize 20
+     */
+    customFields?: Record<string, string>;
+    /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
+    editable?: boolean | null;
+    /** Benefit behavior */
+    behavior?: Behavior;
+    /**
+     * Id of the app associated with this benefit
+     * @format GUID
+     * @readonly
+     */
+    appDefId?: string | null;
+}
+interface EntryPass {
+}
+interface Discount extends DiscountDiscountOneOf {
+    /**
+     * Fixed-rate percent off discount
+     * @decimalValue options { gt:0, lte:100, maxScale:2 }
+     */
+    percentOffRate?: string;
+    /**
+     * Absolute amount discount
+     * @decimalValue options { gt:0, maxScale:2 }
+     */
+    moneyOffAmount?: string;
+}
+/** @oneof */
+interface DiscountDiscountOneOf {
+    /**
+     * Fixed-rate percent off discount
+     * @decimalValue options { gt:0, lte:100, maxScale:2 }
+     */
+    percentOffRate?: string;
+    /**
+     * Absolute amount discount
+     * @decimalValue options { gt:0, maxScale:2 }
+     */
+    moneyOffAmount?: string;
+}
+declare enum BenefitType {
+    /** Should never be used */
+    UNDEFINED = "UNDEFINED",
+    /** Limited benefit type */
+    LIMITED = "LIMITED",
+    /** Unlimited benefit type */
+    UNLIMITED = "UNLIMITED"
+}
+/** @enumType */
+type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
+interface Behavior extends BehaviorBehaviorOneOf {
+    /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
+    defaultBehavior?: EntryPass;
+    /** Discount applied to paid resources */
+    discount?: Discount;
+}
+/** @oneof */
+interface BehaviorBehaviorOneOf {
+    /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
+    defaultBehavior?: EntryPass;
+    /** Discount applied to paid resources */
+    discount?: Discount;
+}
+declare enum Event {
+    Updated = "Updated",
+    Deleted = "Deleted",
+    Created = "Created"
+}
+/** @enumType */
+type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BulkInviteToProgramRequest {
+    /**
+     * Program to which bulk invite participants.
+     * @format GUID
+     */
+    programId: string;
+    /**
+     * Return added participants in the response or not.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    memberIds?: string[];
+    /** Return invited participants in the response or not. */
+    returnEntity?: boolean;
+}
+interface BulkInviteToProgramResponse {
+    /** Participants created by bulk action */
+    results?: BulkInviteToProgramResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkInviteToProgramResult {
+    /** Invited participant metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Invited participant */
+    item?: Participant;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface ParticipantInvited {
+    /**
+     * Program to which bulk invite participants.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Invited member to program
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface BulkInviteAllToProgramRequest {
+    /**
+     * Program to which bulk add participants.
+     * @format GUID
+     */
+    programId: string;
+    /**
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeMemberIds?: string[];
+}
+interface BulkInviteAllToProgramResponse {
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkAddToProgramRequest {
+    /**
+     * Program to which bulk add participants.
+     * @format GUID
+     */
+    programId: string;
+    /**
+     * Site members.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
+    memberIds?: string[];
+    /** Return added participants in the response or not. */
+    returnEntity?: boolean;
+}
+interface BulkAddToProgramResponse {
+    /** Participants created by bulk action */
+    results?: BulkAddToProgramResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkAddToProgramResult {
+    /** Added participant metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Added participant */
+    item?: Participant;
+}
+interface ParticipantAdded {
+    /**
+     * Program ID which participant was added
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of participant on site
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface BulkAddAllToProgramRequest {
+    /**
+     * Program to which bulk add participants.
+     * @format GUID
+     */
+    programId: string;
+    /**
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeMemberIds?: string[];
+}
+interface BulkAddAllToProgramResponse {
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkApproveParticipantRequest {
+    /**
+     * Participants to add
+     * @format GUID
+     * @maxSize 100
+     */
+    participantIds: string[];
+    /**
+     * program to approve participant
+     * @format GUID
+     */
+    programId?: string;
+    /** Return approved participants in the response or not */
+    returnEntity?: boolean;
+}
+interface BulkApproveParticipantResponse {
+    /** Participants approved by bulk action */
+    results?: BulkApproveParticipantResult[];
+    /** Bulk action metadata */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkApproveParticipantResult {
+    /** Approved participant metadata */
+    itemMetadata?: ItemMetadata;
+    /** Approved or existing participant */
+    item?: Participant;
+}
+interface ParticipantApproved {
+    /**
+     * Program ID which participant approved
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of participant approved
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface BulkApproveAllParticipantRequest {
+    /**
+     * Program to approve all participants.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeParticipantIds?: string[];
+}
+interface BulkApproveAllParticipantResponse {
+    /**
+     * Job id with async process
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface DeleteParticipantRequest {
+    /**
+     * Participants to delete
+     * @format GUID
+     */
+    participantId: string;
+}
+interface DeleteParticipantResponse {
+}
+interface ParticipantRejected {
+    /**
+     * Program ID which participant rejected
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of participant rejected
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface IssueCertificateRequest {
+    /**
+     * Participant to get certificate
+     * @format GUID
+     */
+    participantId: string;
+}
+interface IssueCertificateResponse {
+    /** Updated participant */
+    participant?: Participant;
+}
+interface GetCompletionStatsRequest {
+    /**
+     * program id to get stats for
+     * @format GUID
+     */
+    programId: string;
+}
+interface GetCompletionStatsResponse {
+    /** Number of participants that completed the program */
+    completedAll?: number;
+    /** Percentage of participants that completed the program */
+    completionRate?: number;
+}
+interface GetPremiumStatsRequest {
+}
+interface GetPremiumStatsResponse {
+    /** True if site has Online Programs premium feature */
+    hasPremium?: boolean;
+    /** Count of active participants on the site */
+    activeParticipantsCount?: number;
+    /** Limit of active participants on a site without premium */
+    activeParticipantsLimit?: number;
+}
+interface CompleteParticipantRequest {
+    /**
+     * ID of participant
+     * @format GUID
+     */
+    participantId?: string;
+}
+interface CompleteParticipantResponse {
+    /** Updated participant */
+    participant?: Participant;
+}
+interface ExportParticipantsStatsRequest {
+    /**
+     * program id to export data from
+     * @format GUID
+     */
+    programId: string;
+}
+interface ExportParticipantsStatsResponse {
+}
+interface ParticipantExportsFinished {
+    /**
+     * program id from which stats were exported
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * user id of program owner
+     * @format GUID
+     */
+    userId?: string;
+    /**
+     * url to download report
+     * @format WEB_URL
+     */
+    downloadUrl?: string;
+    /** days url will be downloadable */
+    downloadUrlTtlDays?: number;
+}
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface ParticipantJoinedEnvelope {
+    data: ParticipantJoined;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.participant_participant_joined
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ParticipantsService
+ * @slug participant_joined
+ * @documentationMaturity preview
+ */
+declare function onParticipantJoined(handler: (event: ParticipantJoinedEnvelope) => void | Promise<void>): void;
+interface ParticipantLeftEnvelope {
+    data: ParticipantLeft;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.participant_participant_left
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ParticipantsService
+ * @slug participant_left
+ * @documentationMaturity preview
+ */
+declare function onParticipantLeft(handler: (event: ParticipantLeftEnvelope) => void | Promise<void>): void;
+interface ParticipantDeletedEnvelope {
+    entity: Participant;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.online_programs.v3.participant_deleted
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onParticipantDeleted(handler: (event: ParticipantDeletedEnvelope) => void | Promise<void>): void;
+interface ParticipantAddedEnvelope {
+    data: ParticipantAdded;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.participant_participant_added
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
+ * @slug participant_added
+ * @documentationMaturity preview
+ */
+declare function onParticipantAdded(handler: (event: ParticipantAddedEnvelope) => void | Promise<void>): void;
+interface ParticipantApprovedEnvelope {
+    data: ParticipantApproved;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.participant_participant_approved
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
+ * @slug participant_approved
+ * @documentationMaturity preview
+ */
+declare function onParticipantApproved(handler: (event: ParticipantApprovedEnvelope) => void | Promise<void>): void;
+interface ParticipantInvitedEnvelope {
+    data: ParticipantInvited;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.participant_participant_invited
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
+ * @slug participant_invited
+ * @documentationMaturity preview
+ */
+declare function onParticipantInvited(handler: (event: ParticipantInvitedEnvelope) => void | Promise<void>): void;
+interface ParticipantRejectedEnvelope {
+    data: ParticipantRejected;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @webhook
+ * @eventType wix.online_programs.v3.participant_participant_rejected
+ * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
+ * @slug participant_rejected
+ * @documentationMaturity preview
+ */
+declare function onParticipantRejected(handler: (event: ParticipantRejectedEnvelope) => void | Promise<void>): void;
+/**
+ * Member joins the program. By the type of program, participant in corresponding
+ * state will be created.
+ * @param programId - Program to join
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.JoinProgram
+ */
+declare function joinProgram(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>>;
+/**
+ * Returns participant.
+ * @param participantId - Participant id to fetch
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns existing participant
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
+ */
+declare function getParticipant(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>>;
+/**
+ * Participant leaves program. Entity will be deleted. Idempotent call.
+ * @param participantId - Participant id to leave program
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_LEAVE
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.LeaveProgram
+ */
+declare function leaveProgram(participantId: string): Promise<void>;
+/**
+ * Query existing participants
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
+ */
+declare function queryParticipants(): ParticipantsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ParticipantsQueryResult extends QueryCursorResult {
+    items: Participant[];
+    query: ParticipantsQueryBuilder;
+    next: () => Promise<ParticipantsQueryResult>;
+    prev: () => Promise<ParticipantsQueryResult>;
+}
+interface ParticipantsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'memberId' | 'programId' | 'state', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: 'joinedOptions.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: 'joinedOptions.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: 'joinedOptions.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: 'joinedOptions.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'memberId' | 'state', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'joinedOptions.startDate' | '_id' | '_createdDate' | 'state'>) => ParticipantsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'joinedOptions.startDate' | '_id' | '_createdDate' | 'state'>) => ParticipantsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ParticipantsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ParticipantsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ParticipantsQueryResult>;
+}
+/**
+ * Get access status
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetAccessStatus
+ */
+declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `isBlocked`, 2>>;
+/**
+ * Apply coupon to order
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.couponCode
+ * @requiredField identifiers.participantId
+ * @requiredField orderId
+ * @permissionId ONLINE_PROGRAMS.COUPON_APPLY
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.ApplyCoupon
+ */
+declare function applyCoupon(identifiers: NonNullablePaths<ApplyCouponIdentifiers, `couponCode` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<ApplyCouponResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
+interface ApplyCouponIdentifiers {
+    /** @format GUID */
+    participantId: string;
+    couponCode: string;
+}
+/**
+ * Remove coupon from order
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.couponId
+ * @requiredField identifiers.participantId
+ * @requiredField orderId
+ * @permissionId ONLINE_PROGRAMS.COUPON_REVERT
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.RevertCoupon
+ */
+declare function revertCoupon(identifiers: NonNullablePaths<RevertCouponIdentifiers, `couponId` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<RevertCouponResponse, `total`, 2>>;
+interface RevertCouponIdentifiers {
+    /** @format GUID */
+    participantId: string;
+    /** @format GUID */
+    couponId: string;
+}
+/**
+ * Bulk invites participants to program.
+ * For each member participant in Invited state is created.
+ * @param programId - Program to which bulk invite participants.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_INVITE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkInviteToProgram
+ */
+declare function bulkInviteToProgram(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>>;
+interface BulkInviteToProgramOptions {
+    /**
+     * Return added participants in the response or not.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    memberIds?: string[];
+    /** Return invited participants in the response or not. */
+    returnEntity?: boolean;
+}
+/**
+ * Bulk invites all participants to program, but not more then 1000.
+ * For each member participant in Invited state is created.
+ * @param programId - Program to which bulk add participants.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_INVITE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkInviteAllToProgram
+ */
+declare function bulkInviteAllToProgram(programId: string, options?: BulkInviteAllToProgramOptions): Promise<NonNullablePaths<BulkInviteAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
+interface BulkInviteAllToProgramOptions {
+    /**
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeMemberIds?: string[];
+}
+/**
+ * Bulk adds participants to program.
+ * Participant will be either created in state Joined, or updated to that state
+ * from pending one.
+ * @param programId - Program to which bulk add participants.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkAddToProgram
+ */
+declare function bulkAddToProgram(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>>;
+interface BulkAddToProgramOptions {
+    /**
+     * Site members.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
+    memberIds?: string[];
+    /** Return added participants in the response or not. */
+    returnEntity?: boolean;
+}
+/**
+ * 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 programId - Program to which bulk add participants.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkAddAllToProgram
+ */
+declare function bulkAddAllToProgram(programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
+interface BulkAddAllToProgramOptions {
+    /**
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeMemberIds?: string[];
+}
+/**
+ * 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 participantIds - Participants to add
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantIds
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_APPROVE
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkApproveParticipant
+ */
+declare function bulkApproveParticipant(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>>;
+interface BulkApproveParticipantOptions {
+    /**
+     * program to approve participant
+     * @format GUID
+     */
+    programId?: string;
+    /** Return approved participants in the response or not */
+    returnEntity?: boolean;
+}
+/**
+ * Bulk approves all pending participants, who asked to join private program (aka
+ * in state `APPROVAL_PENDING`).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_APPROVE
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkApproveAllParticipant
+ */
+declare function bulkApproveAllParticipant(options?: BulkApproveAllParticipantOptions): Promise<NonNullablePaths<BulkApproveAllParticipantResponse, `jobId`, 2>>;
+interface BulkApproveAllParticipantOptions {
+    /**
+     * Program to approve all participants.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeParticipantIds?: string[];
+}
+/**
+ * Delete participant from program by owner will. Removes participant from member
+ * group. Leaves him in Social Group.
+ * @param participantId - Participants to delete
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_DELETE
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.DeleteParticipant
+ */
+declare function deleteParticipant(participantId: string): Promise<void>;
+/**
+ * Issue certificate by site admin
+ * @param participantId - Participant to get certificate
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.IssueCertificate
+ */
+declare function issueCertificate(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>>;
+/**
+ * Get program's completion stats
+ * @param programId - program id to get stats for
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId ONLINE_PROGRAMS.STATS_READ
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.GetCompletionStats
+ */
+declare function getCompletionStats(programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
+/**
+ * Get premium stats
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ONLINE_PROGRAMS.STATS_READ
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.GetPremiumStats
+ */
+declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
+
+export { type AccountInfo, type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type ApplicationError, type ApplyCouponIdentifiers, type ApplyCouponRequest, type ApplyCouponResponse, type AutoRemovedOptions, 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 BulkInviteAllToProgramOptions, type BulkInviteAllToProgramRequest, type BulkInviteAllToProgramResponse, type BulkInviteToProgramOptions, type BulkInviteToProgramRequest, type BulkInviteToProgramResponse, type BulkInviteToProgramResult, type Certificate, type CompleteParticipantRequest, type CompleteParticipantResponse, type CompletedOptions, type CreditCardPaymentMethodData, type CurrencyAmount, 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, EventType, type EventTypeWithLiterals, type EventWithLiterals, type ExportParticipantsStatsRequest, type ExportParticipantsStatsResponse, type ExtendedFields, type FailedOptions, type FreeCouponOptions, type FullAddressContactDetails, type GetAccessStatusRequest, type GetAccessStatusResponse, type GetCompletionStatsRequest, type GetCompletionStatsResponse, type GetParticipantRequest, type GetParticipantResponse, type GetPremiumStatsRequest, type GetPremiumStatsResponse, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type IssueCertificateRequest, type IssueCertificateResponse, type ItemMetadata, JoinPath, type JoinPathWithLiterals, type JoinProgramRequest, type JoinProgramResponse, type JoinedOptions, type JoinedOptionsJoinPathOptionsOneOf, type LeaveProgramRequest, type LeaveProgramResponse, type MessageEnvelope, type OfflinePaymentSent, type Order, type OrderAdditionalCharges, type OrderItem, OrderItemCategory, type OrderItemCategoryWithLiterals, type PaidPlanOptions, type Participant, type ParticipantAdded, type ParticipantAddedEnvelope, type ParticipantApproved, type ParticipantApprovedEnvelope, type ParticipantDeletedEnvelope, type ParticipantExportsFinished, type ParticipantInvited, type ParticipantInvitedEnvelope, type ParticipantJoined, type ParticipantJoinedEnvelope, type ParticipantLeft, type ParticipantLeftEnvelope, type ParticipantRejected, type ParticipantRejectedEnvelope, type ParticipantStateOptionsOneOf, type ParticipantsBulkCompleteEvent, type ParticipantsBulkDeleteEvent, type ParticipantsQueryBuilder, type ParticipantsQueryResult, type PaymentEvent, type PaymentEventEventOneOf, type PaymentFailed, type PaymentPendingOptions, type Progress, type QueryParticipantsRequest, type QueryParticipantsResponse, type RecurringPaymentCancellationDetails, type RecurringPaymentDetails, type RecurringPaymentStatusChangedEvent, type Refund, RefundStatus, type RefundStatusChangedEvent, type RefundStatusWithLiterals, RemovalReason, type RemovalReasonWithLiterals, type RestoreInfo, type RevertCouponIdentifiers, type RevertCouponRequest, type RevertCouponResponse, type ScheduledAction, ScheduledActionType, type ScheduledActionTypeWithLiterals, type SinglePaymentConfirmed, type SinglePaymentDeclined, type SinglePaymentOptions, SortOrder, type SortOrderWithLiterals, type Sorting, type StandardDetails, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type SuspendedOptions, type Transaction, type TransactionCreatedEvent, type TransactionPaymentMethodDataOneOf, TransactionStatus, type TransactionStatusChangedEvent, type TransactionStatusWithLiterals, type TransactionUpdatedEvent, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, onParticipantAdded, onParticipantApproved, onParticipantDeleted, onParticipantInvited, onParticipantJoined, onParticipantLeft, onParticipantRejected, queryParticipants, revertCoupon };