@wix/pricing-plans 1.0.54 → 1.0.55

package/build/es/src/pricing-plans-v2-plan.universal.d.ts

@@ -1,1176 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/** Information about the pricing plan. */
-export interface Plan {
-    /**
-     * Plan ID.
-     * @readonly
-     */
-    _id?: string;
-    /** Plan name. */
-    name?: string | null;
-    /** Plan description. */
-    description?: string | null;
-    /**
-     * List of text strings that promote what is included with this plan.
-     *
-     * For example, "Plenty of parking" or "Free gift on your birthday".
-     */
-    perks?: StringList;
-    /** Plan price, payment schedule, and expiration. */
-    pricing?: Pricing;
-    /** Whether the plan is public (visible to site visitors and members). */
-    public?: boolean | null;
-    /**
-     * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.
-     * @readonly
-     */
-    archived?: boolean;
-    /**
-     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
-     *
-     * Default: `false`.
-     * @readonly
-     */
-    primary?: boolean;
-    /**
-     * Whether the plan has any orders (including pending and unpaid orders).
-     * @readonly
-     */
-    hasOrders?: boolean;
-    /**
-     * Date plan was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Date plan was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * URL-friendly version of plan name. Unique across all plans in the same site.
-     * @readonly
-     */
-    slug?: string | null;
-    /**
-     * Number of times the same buyer can purchase the plan. Currently limited to support:
-     * - Empty value or a value of `0`, meaning no limitation.
-     * - Value of `1`, meaning limited to one purchase per buyer.
-     */
-    maxPurchasesPerBuyer?: number | null;
-    /**
-     * Whether the buyer can start the plan at a later date.
-     *
-     * Default: `false`.
-     *
-     */
-    allowFutureStartDate?: boolean | null;
-    /**
-     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
-     *
-     * Default: `true`.
-     *
-     */
-    buyerCanCancel?: boolean | null;
-    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
-    termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
-    formId?: string | null;
-}
-/** This wrapper type exist in order to distinguish an empty string list from no list at all in update requests. */
-export interface StringList {
-    /** List of strings */
-    values?: string[];
-}
-/** Plan pricing information. Includes the price of the plan and payment details. */
-export interface Pricing extends PricingPricingModelOneOf {
-    /**
-     * Pricing model indicating that the plan has recurring payments.
-     *
-     * Note: This type of subscription is not a "Wix subscription," which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.
-     */
-    subscription?: Recurrence;
-    /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */
-    singlePaymentForDuration?: Duration;
-    /** Pricing model indicating the plan is paid in one single payment. The plan is valid until canceled.   */
-    singlePaymentUnlimited?: boolean | null;
-    /** Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription.  */
-    price?: Money;
-    /** Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial.  */
-    freeTrialDays?: number | null;
-}
-/** @oneof */
-export interface PricingPricingModelOneOf {
-    /** Plan has recurring payments. */
-    subscription?: Recurrence;
-    /** One time payment, plan is valid for the specified duration. */
-    singlePaymentForDuration?: Duration;
-    /** One time payment, plan is valid until it is canceled. */
-    singlePaymentUnlimited?: boolean | null;
-}
-/** An object specifying how often and for how long payments recur (may be forever). */
-export interface Recurrence {
-    /** Length of one payment cycle. For example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. Currently, only a value of `1` is supported.  */
-    cycleDuration?: Duration;
-    /**
-     * Amount of payment cycles the subscription is valid for.
-     *
-     * `0` for unlimited plans or for plans that are valid until canceled.
-     */
-    cycleCount?: number | null;
-}
-/** A duration expressed in number of time units. */
-export interface Duration {
-    /** Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.  */
-    count?: number | null;
-    /**
-     * Unit of time for the cycle duration.
-     *
-     * Supported values: `"DAY"`, `"WEEK"`, `"MONTH"`, `"YEAR"`.
-     *
-     */
-    unit?: PeriodUnit;
-}
-export declare enum PeriodUnit {
-    UNDEFINED = "UNDEFINED",
-    DAY = "DAY",
-    WEEK = "WEEK",
-    MONTH = "MONTH",
-    YEAR = "YEAR"
-}
-export interface Money {
-    /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Cannot be a negative value.   */
-    value?: string;
-    /**
-     * Currency code. Three-letter currency code in
-     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.
-     */
-    currency?: string;
-}
-export interface FeeConfig {
-    fee?: Fee;
-    /** The time this fee will be charged */
-    appliedAt?: AppliedAt;
-}
-export interface Fee {
-    /** Fee name */
-    name?: string;
-    /** Amount of fee to be charged */
-    amount?: string;
-}
-export declare enum AppliedAt {
-    UNKNOWN_CHARGE_EVENT = "UNKNOWN_CHARGE_EVENT",
-    /** Will charge the fee on first payment. If order has a free trial meaning it will charge after the free trial. */
-    FIRST_PAYMENT = "FIRST_PAYMENT"
-}
-export interface ListPublicPlansRequest {
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
-    limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
-    offset?: number | null;
-    /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
-    planIds?: string[];
-}
-export interface ListPublicPlansResponse {
-    /** List of public pricing plans. */
-    plans?: PublicPlan[];
-    /** Details on the paged set of public pricing plans returned.  */
-    pagingMetadata?: PagingMetadataV2;
-}
-/** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
-export interface PublicPlan {
-    /** Plan ID. */
-    _id?: string;
-    /** Plan name. */
-    name?: string | null;
-    /** Plan description. */
-    description?: string | null;
-    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
-    perks?: StringList;
-    /** Plan price, payment schedule, and expiration. */
-    pricing?: Pricing;
-    /** Whether the plan is marked as primary. */
-    primary?: boolean;
-    /** Date plan was created. */
-    _createdDate?: Date;
-    /** Date plan was last updated. */
-    _updatedDate?: Date;
-    /** URL-friendly version of plan name. Unique across all plans in the same site. */
-    slug?: string | null;
-    /** Number of times the same buyer can purchase the plan. An empty value or a value of zero means no limitation. */
-    maxPurchasesPerBuyer?: number | null;
-    /** Whether the buyer can start the plan at a later date. Defaults to false. */
-    allowFutureStartDate?: boolean | null;
-    /** Whether the buyer is allowed to cancel their plan. Defaults to false. */
-    buyerCanCancel?: boolean | null;
-    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
-    termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
-    formId?: string | null;
-}
-export interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-export interface QueryPublicPlansRequest {
-    query?: QueryV2;
-}
-export interface QueryV2 {
-    /** A filter object. See [supported fields and operators](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans) */
-    filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
-    sort?: Sorting[];
-    /** Pointer to page of results using offset. Can not be used together with 'cursorPaging' */
-    paging?: Paging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface QueryPublicPlansResponse {
-    /** List of public pricing plans that match the specified query. */
-    plans?: PublicPlan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface GetPlanRequest {
-    /** Plan ID. */
-    _id: string;
-}
-export interface GetPlanResponse {
-    /** Pricing plan info.  */
-    plan?: Plan;
-}
-export interface ListPlansRequest {
-    /**
-     * Archived filter.
-     *
-     * Supported values: `"ACTIVE"`, `"ARCHIVED"`, `"ARCHIVED_AND_ACTIVE"`.
-     *
-     * Default: `"ACTIVE"` (not archived).
-     */
-    archived?: ArchivedFilter;
-    /**
-     * Visibility filter.
-     *
-     * Supported values: `"PUBLIC_AND_HIDDEN"`, `"PUBLIC"`, `"HIDDEN"`.
-     *
-     * Default: `"PUBLIC_AND_HIDDEN"` (meaning, both public and hidden plans are listed).
-     *
-     */
-    public?: PublicFilter;
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
-    limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
-    offset?: number | null;
-    /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
-    planIds?: string[];
-}
-export declare enum ArchivedFilter {
-    /** Returns all plans that are active. */
-    ACTIVE = "ACTIVE",
-    /** Returns all plans that are archived. */
-    ARCHIVED = "ARCHIVED",
-    /** Returns all plans that are active and archived. */
-    ARCHIVED_AND_ACTIVE = "ARCHIVED_AND_ACTIVE"
-}
-export declare enum PublicFilter {
-    /** Returns all public and hidden plans. */
-    PUBLIC_AND_HIDDEN = "PUBLIC_AND_HIDDEN",
-    /** Returns only public plans. */
-    PUBLIC = "PUBLIC",
-    /** Returns only hidden plans. */
-    HIDDEN = "HIDDEN"
-}
-export interface ListPlansResponse {
-    /** List of all public and hidden pricing plans. */
-    plans?: Plan[];
-    /** Details on the paged set of pricing plans returned.  */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface GetPlanStatsRequest {
-}
-export interface GetPlanStatsResponse {
-    /** Total number of plans created, including active plans (both public and hidden) and archived plans. */
-    totalPlans?: number;
-}
-export interface CreatePlanRequest {
-    /** Information for the plan being created. */
-    plan: Plan;
-}
-export interface CreatePlanResponse {
-    /** Plan info.  */
-    plan?: Plan;
-}
-export interface UpdatePlanRequest {
-    /** Plan info to update. */
-    plan: Plan;
-}
-export interface UpdatePlanResponse {
-    /** Updated plan info. */
-    plan?: Plan;
-}
-export interface BuyerCanCancelUpdated {
-    plan?: Plan;
-}
-export interface SetPlanVisibilityRequest {
-    /** The ID of the plan to either display or hide on the site page.  */
-    _id: string;
-    /** Whether to set the plan as visible. */
-    visible: boolean;
-}
-export interface SetPlanVisibilityResponse {
-    /** Plan info.  */
-    plan?: Plan;
-}
-export interface MakePlanPrimaryRequest {
-    /** ID of the pricing plan to set as the primary plan. */
-    _id: string;
-}
-export interface MakePlanPrimaryResponse {
-    /** Primary plan info. */
-    plan?: Plan;
-}
-export interface ClearPrimaryRequest {
-}
-export interface ClearPrimaryResponse {
-}
-export interface ArchivePlanRequest {
-    _id: string;
-}
-export interface ArchivePlanResponse {
-    /** Archived plan info.  */
-    plan?: Plan;
-}
-export interface PlanArchived {
-    plan?: Plan;
-}
-export interface BulkArchivePlanRequest {
-    /** List of Plan IDs. */
-    ids?: string[];
-    /** Set to true to return Plan entity in response. */
-    returnFullEntity?: boolean;
-}
-export interface BulkArchivePlanResponse {
-    results?: BulkPlanResult[];
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkPlanResult {
-    itemMetadata?: ItemMetadata;
-    plan?: Plan;
-}
-export 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;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export 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;
-}
-export interface ArrangePlansRequest {
-    /** IDs of all non-archived plans in the order you want them arranged. */
-    ids: string[];
-}
-export interface ArrangePlansResponse {
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    _id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * 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 defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface ListPublicPlansResponseNonNullableFields {
-    plans: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        primary: boolean;
-    }[];
-}
-export interface QueryPublicPlansResponseNonNullableFields {
-    plans: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        primary: boolean;
-    }[];
-}
-export interface GetPlanResponseNonNullableFields {
-    plan?: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    };
-}
-export interface ListPlansResponseNonNullableFields {
-    plans: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    }[];
-}
-export interface GetPlanStatsResponseNonNullableFields {
-    totalPlans: number;
-}
-export interface CreatePlanResponseNonNullableFields {
-    plan?: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    };
-}
-export interface UpdatePlanResponseNonNullableFields {
-    plan?: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    };
-}
-export interface SetPlanVisibilityResponseNonNullableFields {
-    plan?: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    };
-}
-export interface MakePlanPrimaryResponseNonNullableFields {
-    plan?: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    };
-}
-export interface ArchivePlanResponseNonNullableFields {
-    plan?: {
-        _id: string;
-        perks?: {
-            values: string[];
-        };
-        pricing?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            price?: {
-                value: string;
-                currency: string;
-            };
-        };
-        archived: boolean;
-        primary: boolean;
-        hasOrders: boolean;
-    };
-}
-export declare const onPlanUpdated: EventDefinition<DomainUpdatedEvent<Plan>, "wix.pricing_plans.v2.plan_updated">;
-export declare const onPlanCreated: EventDefinition<DomainCreatedEvent<Plan>, "wix.pricing_plans.v2.plan_created">;
-export declare const onPlanBuyerCanCancelUpdated: EventDefinition<DomainActionEvent<BuyerCanCancelUpdated>, "wix.pricing_plans.v2.plan_buyer_can_cancel_updated">;
-export declare const onPlanArchived: EventDefinition<DomainActionEvent<PlanArchived>, "wix.pricing_plans.v2.plan_plan_archived">;
-/**
- * Retrieves a list of public pricing plans.
- *
- *
- * The `listPublicPlans()` function returns a Promise that resolves to a list of up to 100 public pricing plans. Public plans are visible plans that site visitors can see on the site and purchase.
- * @public
- * @param options - Options for filtering and paging the list of public plans.
- * @permissionScope Read Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns Fulfilled - List of public pricing plans.
- */
-export declare function listPublicPlans(options?: ListPublicPlansOptions): Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
-export interface ListPublicPlansOptions {
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
-    limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
-    offset?: number | null;
-    /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
-    planIds?: string[];
-}
-/**
- * Creates a query to retrieve a list of public pricing plans.
- *
- *
- * The `queryPublicPlans()` function builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object.
- *
- * The returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) function.
- *
- * You can refine the query by chaining `PublicPlansQueryBuilder` functions onto the query. `PublicPlansQueryBuilder` functions enable you to sort, filter, and control the results that `queryPublicPlans()` returns.
- *
- * `queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:
- * - [`skip`](#plansquerybuilder/skip): `0`
- * - [`limit`](#plansquerybuilder/limit): `50`
- *
- * The functions that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.
- *
- * The following `PublicPlansQueryBuilder` functions are supported for the `queryPublicPlans()` function. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).
- * @public
- * @permissionScope Read Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function queryPublicPlans(): PlansQueryBuilder;
-interface QueryOffsetResult {
-    currentPage: number | undefined;
-    totalPages: number | undefined;
-    totalCount: number | undefined;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface PlansQueryResult extends QueryOffsetResult {
-    items: PublicPlan[];
-    query: PlansQueryBuilder;
-    next: () => Promise<PlansQueryResult>;
-    prev: () => Promise<PlansQueryResult>;
-}
-export interface PlansQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     */
-    startsWith: (propertyName: '_id' | 'slug', value: string) => PlansQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any[]) => PlansQueryBuilder;
-    in: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
-    exists: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: boolean) => PlansQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    ascending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    descending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => PlansQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results. */
-    skip: (skip: number) => PlansQueryBuilder;
-    find: () => Promise<PlansQueryResult>;
-}
-/**
- * Retrieves a pricing plan by the specified ID.
- *
- * The `getPlan()` function returns a Promise that resolves to a plan whose ID matched the specified ID.
- * @param _id - Plan ID.
- * @public
- * @requiredField _id
- * @permissionScope Read Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - The retrieved plan's information.
- */
-export declare function getPlan(_id: string): Promise<Plan & NonNullable<GetPlanResponseNonNullableFields>['plan']>;
-/**
- * Retrieves a list of pricing plans.
- *
- * The `listPlans()` function returns a Promise that resolves to a list of up to 100 pricing plans. This includes public, hidden, and archived plans.
- * @public
- * @documentationMaturity preview
- * @param options - Options for filtering and paging the list of plans.
- * @permissionScope Read Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - List of plans that match the given criteria.
- */
-export declare function listPlans(options?: ListPlansOptions): Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
-export interface ListPlansOptions {
-    /**
-     * Archived filter.
-     *
-     * Supported values: `"ACTIVE"`, `"ARCHIVED"`, `"ARCHIVED_AND_ACTIVE"`.
-     *
-     * Default: `"ACTIVE"` (not archived).
-     */
-    archived?: ArchivedFilter;
-    /**
-     * Visibility filter.
-     *
-     * Supported values: `"PUBLIC_AND_HIDDEN"`, `"PUBLIC"`, `"HIDDEN"`.
-     *
-     * Default: `"PUBLIC_AND_HIDDEN"` (meaning, both public and hidden plans are listed).
-     *
-     */
-    public?: PublicFilter;
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
-    limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
-    offset?: number | null;
-    /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
-    planIds?: string[];
-}
-/**
- * Retrieves statistics about the pricing plans.
- *
- *
- * The `getPlanStats()` function returns a Promise that resolves to statistics about the plan on the site.
- *
- * Currently this function provides only the total number of pricing plans, including archived plans.
- * @public
- * @permissionScope Read Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - Overall statistics about the pricing plans.
- */
-export declare function getPlanStats(): Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
-/**
- * Creates a pricing plan.
- *
- *
- * The `createPlan()` function returns a Promise that resolves to a newly-created pricing plan after is has successfully been created.
- *
- * The passed `plan` object must contain a [pricing model](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/pricing-models). A pricing model can be one of the following:
- * - **A subscription**: A subscription with recurring payment and how often the plan occurs. Subscriptions can have free trial days.
- * - **A plan that does not renew**: A single payment for a specific duration that doesn't renew.
- * - **An unlimited plan**: A single payment for an unlimited amount of time (until canceled).
- *
- * Pricing plans created by this function are available to the site owner in the Pricing Plans section in the Dashboard.
- * @public
- * @requiredField plan
- * @requiredField plan.name
- * @requiredField plan.pricing
- * @requiredField plan.pricing.singlePaymentForDuration.count
- * @requiredField plan.pricing.subscription.cycleCount
- * @requiredField plan.pricing.subscription.cycleDuration
- * @requiredField plan.pricing.subscription.cycleDuration.count
- * @param plan - Information for the plan being created.
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - The created plan.
- *
- * Rejected - Error message.
- */
-export declare function createPlan(plan: Plan): Promise<Plan & NonNullable<CreatePlanResponseNonNullableFields>['plan']>;
-/**
- * Updates a pricing plan.
- *
- *
- * The `updatePlan()` function returns a Promise that resolves to an updated plan.
- *
- * Updating a plan does not impact existing purchases made for the plan. All purchases keep the details of the original plan that was active at the time of the purchase.
- * @public
- * @requiredField _id
- * @requiredField plan
- * @param _id - ID of the plan to update.
- * @param options - Options for updating the plan.
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - The updated plan.
- *
- * Rejected - Error message.
- */
-export declare function updatePlan(_id: string, plan: UpdatePlan): Promise<Plan & NonNullable<UpdatePlanResponseNonNullableFields>['plan']>;
-export interface UpdatePlan {
-    /**
-     * Plan ID.
-     * @readonly
-     */
-    _id?: string;
-    /** Plan name. */
-    name?: string | null;
-    /** Plan description. */
-    description?: string | null;
-    /**
-     * List of text strings that promote what is included with this plan.
-     *
-     * For example, "Plenty of parking" or "Free gift on your birthday".
-     */
-    perks?: StringList;
-    /** Plan price, payment schedule, and expiration. */
-    pricing?: Pricing;
-    /** Whether the plan is public (visible to site visitors and members). */
-    public?: boolean | null;
-    /**
-     * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.
-     * @readonly
-     */
-    archived?: boolean;
-    /**
-     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
-     *
-     * Default: `false`.
-     * @readonly
-     */
-    primary?: boolean;
-    /**
-     * Whether the plan has any orders (including pending and unpaid orders).
-     * @readonly
-     */
-    hasOrders?: boolean;
-    /**
-     * Date plan was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Date plan was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * URL-friendly version of plan name. Unique across all plans in the same site.
-     * @readonly
-     */
-    slug?: string | null;
-    /**
-     * Number of times the same buyer can purchase the plan. Currently limited to support:
-     * - Empty value or a value of `0`, meaning no limitation.
-     * - Value of `1`, meaning limited to one purchase per buyer.
-     */
-    maxPurchasesPerBuyer?: number | null;
-    /**
-     * Whether the buyer can start the plan at a later date.
-     *
-     * Default: `false`.
-     *
-     */
-    allowFutureStartDate?: boolean | null;
-    /**
-     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
-     *
-     * Default: `true`.
-     *
-     */
-    buyerCanCancel?: boolean | null;
-    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
-    termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
-    formId?: string | null;
-}
-/**
- * Sets visibility for non-archived pricing plans.
- *
- * The `setPlanVisibility()` functions returns a Promise that resolves to a pricing plan when its visibility has successfully been set.
- *
- * By default, pricing plans are public, meaning they are visible. [Plans can be hidden](https://support.wix.com/en/article/pricing-plans-removing-a-plan-from-your-site#hiding-plans) so that site members and visitors cannot see or choose them.
- *
- * As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible).
- *
- * >**Note:** An archived plan always remains archived and cannot be made active again. When archiving a plan, its `public` property is automatically set to `false` so that it is hidden.
- *
- * Changing a plan's visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their terms and payment options.
- * @param visible - Whether to set the plan as visible.
- * @public
- * @requiredField _id
- * @requiredField visible
- * @param _id - The ID of the plan to either display or hide on the site page.
- * @param options - Plan visibility options.
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - The plan's information.
- *
- * Rejected - Error message.
- */
-export declare function setPlanVisibility(_id: string, visible: boolean): Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
-/**
- * Marks a pricing plan as the primary pricing plan.
- *
- *
- * The `makePlanPrimary()` function returns a Promise that resolves to the now primary pricing plan.
- *
- * Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling `makePlanPrimary()` causes the existing primary plan to lose its primary status.
- *
- * When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.
- * @public
- * @requiredField _id
- * @param _id - ID of the pricing plan to set as the primary plan.
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - The primary plan.
- */
-export declare function makePlanPrimary(_id: string): Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
-/**
- * Sets all pricing plans to no longer be primary.
- *
- * The `clearPrimary()` function returns a Promise that is resolved when there are no pricing plans marked as `primary`.
- *
- * After clearing the primary plan, when viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.
- * @public
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- */
-export declare function clearPrimary(): Promise<void>;
-/**
- * Archives a single plan.
- *
- *
- * The `archivePlan()` function returns a Promise that resolves to the newly-archived plan.
- *
- * When a plan is archived, the plan
- * - Is no longer available for display or selection by visitors. This is because the plan's `public` property is automatically set to `false`.
- * - Cannot be purchased.
- * - Cannot be "un-archived", meaning the plan cannot be made active again.
- *
- * Plan archiving does not impact existing purchases made for the plan. All purchases for the plan are still active and keep their payment options and terms.
- *
- * Site owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.
- *
- * >**Note:** An attempt to archive an already-archived plan throws an error.
- * @public
- * @requiredField _id
- * @param _id - ID of the active plan to archive.
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @returns Fulfilled - The archived plan.
- *
- * Rejected - Error message.
- */
-export declare function archivePlan(_id: string): Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
-/**
- * Changes the display order of the pricing plans on the site page and in the Dashboard.
- *
- *
- * The `arrangePlans()` function returns a Promise that resolves when the plans are rearranged on the site page and in the Dashboard.
- *
- * To rearrange the order of the plans, provide a list of the IDs for all non-archived plans in the desired order, including hidden plans.
- *
- * >**Note:** Make sure to provide *all* non-archived plan IDs to avoid unpredictable results.
- * @param ids - IDs of all non-archived plans in the order you want them arranged.
- * @public
- * @requiredField ids
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- */
-export declare function arrangePlans(ids: string[]): Promise<void>;
-export {};