@wix/auto_sdk_online-programs_participants 1.0.0

package/build/internal/es/meta.d.mts

@@ -0,0 +1,599 @@
+import { JoinProgramRequest as JoinProgramRequest$1, JoinProgramResponse as JoinProgramResponse$1, GetParticipantRequest as GetParticipantRequest$1, GetParticipantResponse as GetParticipantResponse$1, LeaveProgramRequest as LeaveProgramRequest$1, LeaveProgramResponse as LeaveProgramResponse$1, QueryParticipantsRequest as QueryParticipantsRequest$1, QueryParticipantsResponse as QueryParticipantsResponse$1, GetAccessStatusRequest as GetAccessStatusRequest$1, GetAccessStatusResponse as GetAccessStatusResponse$1, ApplyCouponRequest as ApplyCouponRequest$1, ApplyCouponResponse as ApplyCouponResponse$1, RevertCouponRequest as RevertCouponRequest$1, RevertCouponResponse as RevertCouponResponse$1, BulkInviteToProgramRequest as BulkInviteToProgramRequest$1, BulkInviteToProgramResponse as BulkInviteToProgramResponse$1, BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponse$1, BulkAddToProgramRequest as BulkAddToProgramRequest$1, BulkAddToProgramResponse as BulkAddToProgramResponse$1, BulkAddAllToProgramRequest as BulkAddAllToProgramRequest$1, BulkAddAllToProgramResponse as BulkAddAllToProgramResponse$1, BulkApproveParticipantRequest as BulkApproveParticipantRequest$1, BulkApproveParticipantResponse as BulkApproveParticipantResponse$1, BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponse$1, DeleteParticipantRequest as DeleteParticipantRequest$1, DeleteParticipantResponse as DeleteParticipantResponse$1, IssueCertificateRequest as IssueCertificateRequest$1, IssueCertificateResponse as IssueCertificateResponse$1, GetCompletionStatsRequest as GetCompletionStatsRequest$1, GetCompletionStatsResponse as GetCompletionStatsResponse$1, GetPremiumStatsRequest as GetPremiumStatsRequest$1, GetPremiumStatsResponse as GetPremiumStatsResponse$1, ExportParticipantsStatsRequest as ExportParticipantsStatsRequest$1, ExportParticipantsStatsResponse as ExportParticipantsStatsResponse$1 } from './index.typings.mjs';
+import '@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 JoinProgramRequest {
+    /**
+     * Program to join
+     * @format GUID
+     */
+    programId: string;
+}
+interface JoinProgramResponse {
+    /** Created participant with corresponding state */
+    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 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;
+}
+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 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 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 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 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 ExportParticipantsStatsRequest {
+    /**
+     * program id to export data from
+     * @format GUID
+     */
+    programId: string;
+}
+interface ExportParticipantsStatsResponse {
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function joinProgram(): __PublicMethodMetaInfo<'POST', {}, JoinProgramRequest$1, JoinProgramRequest, JoinProgramResponse$1, JoinProgramResponse>;
+declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
+    participantId: string;
+}, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
+declare function leaveProgram(): __PublicMethodMetaInfo<'POST', {
+    participantId: string;
+}, LeaveProgramRequest$1, LeaveProgramRequest, LeaveProgramResponse$1, LeaveProgramResponse>;
+declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
+declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
+declare function applyCoupon(): __PublicMethodMetaInfo<'POST', {
+    participantId: string;
+    couponCode: string;
+}, ApplyCouponRequest$1, ApplyCouponRequest, ApplyCouponResponse$1, ApplyCouponResponse>;
+declare function revertCoupon(): __PublicMethodMetaInfo<'POST', {
+    participantId: string;
+    couponId: string;
+}, RevertCouponRequest$1, RevertCouponRequest, RevertCouponResponse$1, RevertCouponResponse>;
+declare function bulkInviteToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteToProgramRequest$1, BulkInviteToProgramRequest, BulkInviteToProgramResponse$1, BulkInviteToProgramResponse>;
+declare function bulkInviteAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramRequest, BulkInviteAllToProgramResponse$1, BulkInviteAllToProgramResponse>;
+declare function bulkAddToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddToProgramRequest$1, BulkAddToProgramRequest, BulkAddToProgramResponse$1, BulkAddToProgramResponse>;
+declare function bulkAddAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddAllToProgramRequest$1, BulkAddAllToProgramRequest, BulkAddAllToProgramResponse$1, BulkAddAllToProgramResponse>;
+declare function bulkApproveParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveParticipantRequest$1, BulkApproveParticipantRequest, BulkApproveParticipantResponse$1, BulkApproveParticipantResponse>;
+declare function bulkApproveAllParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantRequest, BulkApproveAllParticipantResponse$1, BulkApproveAllParticipantResponse>;
+declare function deleteParticipant(): __PublicMethodMetaInfo<'DELETE', {
+    participantId: string;
+}, DeleteParticipantRequest$1, DeleteParticipantRequest, DeleteParticipantResponse$1, DeleteParticipantResponse>;
+declare function issueCertificate(): __PublicMethodMetaInfo<'POST', {
+    participantId: string;
+}, IssueCertificateRequest$1, IssueCertificateRequest, IssueCertificateResponse$1, IssueCertificateResponse>;
+declare function getCompletionStats(): __PublicMethodMetaInfo<'GET', {
+    programId: string;
+}, GetCompletionStatsRequest$1, GetCompletionStatsRequest, GetCompletionStatsResponse$1, GetCompletionStatsResponse>;
+declare function getPremiumStats(): __PublicMethodMetaInfo<'GET', {}, GetPremiumStatsRequest$1, GetPremiumStatsRequest, GetPremiumStatsResponse$1, GetPremiumStatsResponse>;
+declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
+    programId: string;
+}, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
+
+export { type __PublicMethodMetaInfo, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, exportParticipantsStats, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, queryParticipants, revertCoupon };