@wix/pricing-plans 1.0.9 → 1.0.11

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

@@ -71,7 +71,7 @@ export interface Plan {
      */
     allowFutureStartDate?: boolean | null;
     /**
-     * Whether the buyer is allowed to cancel their plan. If `false`, calling the `cancelOrder()` function returns an error.
+     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`cancelOrder()`](#cancelorder) function returns an error.
      *
      * Default: `false`.
      *
@@ -79,9 +79,6 @@ export interface Plan {
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
-    clientData?: Record<string, string>;
-    /** Reference to a form which is shown in checkout to gather additional data */
-    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 {
@@ -169,7 +166,7 @@ export interface ListPublicPlansRequest {
      * 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](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** 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 {
@@ -206,6 +203,7 @@ export interface PublicPlan {
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
+    /** Reserved for internal use. */
     clientData?: Record<string, string>;
     /** Reference to a form which is shown in checkout to gather additional data */
     formId?: string | null;
@@ -299,7 +297,7 @@ export interface ListPlansRequest {
      * 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](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** 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 {
@@ -340,7 +338,7 @@ export interface CreatePlanResponse {
 }
 export interface UpdatePlanRequest {
     /** Plan info to update. */
-    plan?: Plan;
+    plan: Plan;
     fieldMask?: string[];
 }
 export interface UpdatePlanResponse {
@@ -351,7 +349,7 @@ 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;
+    visible: boolean;
 }
 export interface SetPlanVisibilityResponse {
     /** Plan info.  */
@@ -421,7 +419,7 @@ export interface BulkActionMetadata {
 }
 export interface ArrangePlansRequest {
     /** IDs of all non-archived plans in the order you want them arranged. */
-    ids?: string[];
+    ids: string[];
 }
 export interface ArrangePlansResponse {
 }
@@ -430,10 +428,7 @@ export interface ArrangePlansResponse {
  *
  *
  * 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.
- *
- * You do not need "Manage Pricing Plans" permissions to list public plans.
  * @public
- * @documentationMaturity preview
  * @param options - Options for filtering and paging the list of public plans.
  * @returns Fulfilled - List of public pricing plans.
  */
@@ -451,55 +446,95 @@ export interface ListPublicPlansOptions {
      * 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](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** 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`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder) object.
+ * The `queryPublicPlans()` function builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#publicplansquerybuilder) object.
  *
- * The returned object contains the query definition which is typically used to run the query using the [`find()`]() function.
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](#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`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder/skip): `0`
- * - [`limit`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder/limit): `50`
+ * - [`skip`](#skip): `0`
+ * - [`limit`](#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`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansqueryresult/items) property in [`PublicPlansQueryResult`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansqueryresult).
- * @public
- * @documentationMaturity preview
- * @returns Fulfilled - The query definition used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder/find) function.
- */
-export declare function queryPublicPlans(options?: QueryPublicPlansOptions): Promise<QueryPublicPlansResponse>;
-export interface QueryPublicPlansOptions {
-    query?: QueryV2;
+ * 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`](#items) property in [`PublicPlansQueryResult`](#publicplansqueryresult).
+ * @public */
+export declare function queryPublicPlans(): PlansQueryBuilder;
+interface QueryOffsetResult {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    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.
+     */
+    gt: (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.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” permissions can use this function to get a plan.
  * @param _id - Plan ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - The retrieved plan's information.
  */
-export declare function getPlan(_id: string): Promise<GetPlanResponse>;
+export declare function getPlan(_id: string): Promise<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.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” permissions can use this function to list plans.
  * @public
- * @documentationMaturity preview
  * @param options - Options for filtering and paging the list of plans.
  * @returns Fulfilled - List of plans that match the given criteria.
  */
@@ -534,7 +569,7 @@ export interface ListPlansOptions {
      * 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](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** 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[];
 }
 /**
@@ -544,10 +579,7 @@ export interface ListPlansOptions {
  * 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.
- *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can get plan statistics.
  * @public
- * @documentationMaturity preview
  * @returns Fulfilled - Overall statistics about the pricing plans.
  */
 export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
@@ -563,10 +595,7 @@ export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
  * - **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.
- *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can create plans.
  * @public
- * @documentationMaturity preview
  * @requiredField plan
  * @requiredField plan.name
  * @requiredField plan.pricing
@@ -579,7 +608,7 @@ export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
  *
  * Rejected - Error message.
  */
-export declare function createPlan(plan: Plan): Promise<CreatePlanResponse>;
+export declare function createPlan(plan: Plan): Promise<Plan>;
 /**
  * Updates a pricing plan.
  *
@@ -587,93 +616,92 @@ export declare function createPlan(plan: Plan): Promise<CreatePlanResponse>;
  * 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.
- *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update plans.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @requiredField plan
  * @param _id - ID of the plan to update.
  * @param options - Options for updating the plan.
  * @returns Fulfilled - The updated plan.
  *
  * Rejected - Error message.
  */
-export declare function updatePlan(_id: string, options?: UpdatePlanOptions): Promise<UpdatePlanResponse>;
+export declare function updatePlan(_id: string, plan: UpdatePlan, options?: UpdatePlanOptions): Promise<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 [`cancelOrder()`](#cancelorder) function returns an error.
+     *
+     * Default: `false`.
+     *
+     */
+    buyerCanCancel?: boolean | null;
+    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    termsAndConditions?: string | null;
+}
 export interface UpdatePlanOptions {
-    /** Plan info to update. */
-    plan: {
-        /**
-         * ID of the plan to update.
-         * @readonly
-         */
-        _id?: string;
-        /** Plan name. */
-        name?: string | null;
-        /** Plan description. */
-        description?: string | null;
-        /** List of text strings that promote the pricing 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.
-         *
-         * Default: `false`.
-         *
-         */
-        buyerCanCancel?: boolean | null;
-        /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
-        termsAndConditions?: string | null;
-        clientData?: Record<string, string>;
-        /** Reference to a form which is shown in checkout to gather additional data */
-        formId?: string | null;
-    };
     fieldMask?: string[];
 }
 /**
@@ -688,22 +716,17 @@ export interface UpdatePlanOptions {
  * >**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.
- *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can change a plans visibility.
+ * @param visible - Whether to set the plan as visible.
  * @public
- * @documentationMaturity preview
  * @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.
  * @returns Fulfilled - The plan's information.
  *
  * Rejected - Error message.
  */
-export declare function setPlanVisibility(_id: string, options?: SetPlanVisibilityOptions): Promise<SetPlanVisibilityResponse>;
-export interface SetPlanVisibilityOptions {
-    /** Whether to set the plan as visible.  */
-    visible?: boolean;
-}
+export declare function setPlanVisibility(_id: string, visible: boolean): Promise<SetPlanVisibilityResponse>;
 /**
  * Marks a pricing plan as the primary pricing plan.
  *
@@ -713,10 +736,7 @@ export interface SetPlanVisibilityOptions {
  * 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.
- *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can mark a plan as a primary plan.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @param _id - ID of the pricing plan to set as the primary plan.
  * @returns Fulfilled - The primary plan.
@@ -728,11 +748,7 @@ export declare function makePlanPrimary(_id: string): Promise<MakePlanPrimaryRes
  * 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.
- *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can clear the primary plan.
- * @public
- * @documentationMaturity preview
- */
+ * @public */
 export declare function clearPrimary(): Promise<void>;
 /**
  * Archives a single plan.
@@ -749,11 +765,8 @@ export declare function clearPrimary(): Promise<void>;
  *
  * Site owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.
  *
- * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can archive plans.
- *
  * >**Note:** An attempt to archive an already-archived plan throws an error.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @param _id - ID of the active plan to archive.
  * @returns Fulfilled - The archived plan.
@@ -769,14 +782,10 @@ export declare function archivePlan(_id: string): Promise<ArchivePlanResponse>;
  *
  * 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.
  *
- * Only users with "Managing Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can arrange 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
- * @documentationMaturity preview
+ * @requiredField ids
  */
-export declare function arrangePlans(options?: ArrangePlansOptions): Promise<void>;
-export interface ArrangePlansOptions {
-    /** IDs of all non-archived plans in the order you want them arranged.  */
-    ids?: string[];
-}
+export declare function arrangePlans(ids: string[]): Promise<void>;
+export {};