@wix/pricing-plans 1.0.8 → 1.0.10

package/build/es/src/pricing-plans-v2-plan.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"pricing-plans-v2-plan.public.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,IAAI,wBAAwB,EAC3C,gBAAgB,IAAI,yBAAyB,EAC7C,OAAO,IAAI,gBAAgB,EAC3B,SAAS,IAAI,kBAAkB,EAC/B,YAAY,IAAI,qBAAqB,EACrC,UAAU,IAAI,mBAAmB,EACjC,UAAU,IAAI,mBAAmB,EACjC,iBAAiB,IAAI,0BAA0B,EAC/C,eAAe,IAAI,wBAAwB,EAC3C,YAAY,IAAI,qBAAqB,EACrC,WAAW,IAAI,oBAAoB,EACnC,YAAY,IAAI,qBAAqB,GAQtC,MAAM,mCAAmC,CAAC;AAE3C,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,OAAiC,EAAE,EAAE,CAC3C,yBAAyB,CACvB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,gBAAgB,CACd,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,OAA0B,EAAE,EAAE,CACpC,kBAAkB,CAChB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,IAAU,EAAE,EAAE,CACpB,mBAAmB,CACjB,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAW,EAAE,OAA2B,EAAE,EAAE,CAClD,mBAAmB,CACjB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,GAAW,EAAE,OAAkC,EAAE,EAAE,CACzD,0BAA0B,CACxB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,wBAAwB,CACtB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,oBAAoB,CAClB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAA6B,EAAE,EAAE,CACvC,qBAAqB,CACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,UAAU,EACV,SAAS,EACT,cAAc,EACd,YAAY,GACb,MAAM,mCAAmC,CAAC"}
+{"version":3,"file":"pricing-plans-v2-plan.public.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,IAAI,wBAAwB,EAC3C,gBAAgB,IAAI,yBAAyB,EAC7C,OAAO,IAAI,gBAAgB,EAC3B,SAAS,IAAI,kBAAkB,EAC/B,YAAY,IAAI,qBAAqB,EACrC,UAAU,IAAI,mBAAmB,EACjC,UAAU,IAAI,mBAAmB,EACjC,iBAAiB,IAAI,0BAA0B,EAC/C,eAAe,IAAI,wBAAwB,EAC3C,YAAY,IAAI,qBAAqB,EACrC,WAAW,IAAI,oBAAoB,EACnC,YAAY,IAAI,qBAAqB,GAMtC,MAAM,mCAAmC,CAAC;AAE3C,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,GAAG,EAAE,CACV,yBAAyB;IACvB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,gBAAgB,CACd,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,OAA0B,EAAE,EAAE,CACpC,kBAAkB,CAChB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,IAAU,EAAE,EAAE,CACpB,mBAAmB,CACjB,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAW,EAAE,IAAgB,EAAE,OAA2B,EAAE,EAAE,CACpE,mBAAmB,CACjB,GAAG,EACH,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,GAAW,EAAE,OAAgB,EAAE,EAAE,CACvC,0BAA0B,CACxB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,wBAAwB,CACtB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,GAAG,EAAE,CACV,qBAAqB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,oBAAoB,CAClB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,GAAa,EAAE,EAAE,CACvB,qBAAqB,CACnB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,UAAU,EACV,SAAS,EACT,cAAc,EACd,YAAY,GACb,MAAM,mCAAmC,CAAC"}

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

@@ -57,9 +57,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 {
@@ -278,7 +275,7 @@ export interface CreatePlanResponse {
     plan?: Plan;
 }
 export interface UpdatePlanRequest {
-    plan?: Plan;
+    plan: Plan;
     fieldMask?: string[];
 }
 export interface UpdatePlanResponse {
@@ -286,7 +283,7 @@ export interface UpdatePlanResponse {
 }
 export interface SetPlanVisibilityRequest {
     id: string;
-    visible?: boolean;
+    visible: boolean;
 }
 export interface SetPlanVisibilityResponse {
     plan?: Plan;
@@ -351,7 +348,7 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface ArrangePlansRequest {
-    ids?: string[];
+    ids: string[];
 }
 export interface ArrangePlansResponse {
 }

package/build/es/src/pricing-plans-v2-plan.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"pricing-plans-v2-plan.types.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan.types.ts"],"names":[],"mappings":"AAsHA,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,yBAAW,CAAA;IACX,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,2BAAa,CAAA;AACf,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAsGD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAuCD,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,yCAAyC;IACzC,mCAAiB,CAAA;IACjB,2CAA2C;IAC3C,uCAAqB,CAAA;IACrB,sDAAsD;IACtD,6DAA2C,CAAA;AAC7C,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2C;IAC3C,uDAAuC,CAAA;IACvC,iCAAiC;IACjC,iCAAiB,CAAA;IACjB,iCAAiC;IACjC,iCAAiB,CAAA;AACnB,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB"}
+{"version":3,"file":"pricing-plans-v2-plan.types.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan.types.ts"],"names":[],"mappings":"AAmHA,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,yBAAW,CAAA;IACX,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,2BAAa,CAAA;AACf,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAsGD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAuCD,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,yCAAyC;IACzC,mCAAiB,CAAA;IACjB,2CAA2C;IAC3C,uCAAqB,CAAA;IACrB,sDAAsD;IACtD,6DAA2C,CAAA;AAC7C,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2C;IAC3C,uDAAuC,CAAA;IACvC,iCAAiC;IACjC,iCAAiB,CAAA;IACjB,iCAAiC;IACjC,iCAAiB,CAAA;AACnB,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB"}

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

@@ -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 {
@@ -340,7 +337,7 @@ export interface CreatePlanResponse {
 }
 export interface UpdatePlanRequest {
     /** Plan info to update. */
-    plan?: Plan;
+    plan: Plan;
     fieldMask?: string[];
 }
 export interface UpdatePlanResponse {
@@ -351,7 +348,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 +418,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 {
 }
@@ -473,11 +470,76 @@ export interface ListPublicPlansOptions {
  * 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;
+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.
+     * @documentationMaturity preview
+     */
+    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.
+     * @documentationMaturity preview
+     */
+    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.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'slug', value: string) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any[]) => PlansQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @documentationMaturity preview */
+    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.
+     * @documentationMaturity preview
+     */
+    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.
+     * @documentationMaturity preview
+     */
+    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.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PlansQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results.
+     * @documentationMaturity preview
+     */
+    skip: (skip: number) => PlansQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PlansQueryResult>;
 }
 /**
  * Retrieves a pricing plan by the specified ID.
@@ -491,7 +553,7 @@ export interface QueryPublicPlansOptions {
  * @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.
  *
@@ -579,7 +641,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.
  *
@@ -592,88 +654,90 @@ export declare function createPlan(plan: Plan): Promise<CreatePlanResponse>;
  * @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()` 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[];
 }
 /**
@@ -690,20 +754,18 @@ export interface UpdatePlanOptions {
  * 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.
  *
@@ -772,11 +834,10 @@ export declare function archivePlan(_id: string): Promise<ArchivePlanResponse>;
  * 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 {};

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

@@ -7,8 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { serializer, transformError } from '@wix/metro-runtime/velo';
+import { serializer, transformError, resolveQueryFieldsTransformationPaths, } from '@wix/metro-runtime/velo';
 import * as ambassadorWixPricingPlansV2Plan from './pricing-plans-v2-plan.http';
+// @ts-ignore
+import { wrapWithQueryBuilder } from '@wix/motion-edm-autogen-query-wrapper';
 let __verbose = false;
 function __log(...args) {
     __verbose && console.log(...args);
@@ -157,50 +159,57 @@ export function listPublicPlans(options) {
  * 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 function queryPublicPlans(options) {
-    var _a, _b, _c;
-    return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = { query: '$[0].query' };
-        const responseTransformation = '$';
-        // @ts-ignore
-        const { httpClient, sideEffects } = arguments[1];
-        const { toAmbassadorRequest } = serializer({
-            rootSchema: _queryPublicPlansRequest,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _fromVeloEntity,
-            },
-            customTransformation: requestTransformation,
-        });
-        const { fromJSON } = serializer({
-            rootSchema: _queryPublicPlansResponse,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _toVeloEntity,
-            },
-            customTransformation: responseTransformation,
-        });
-        const payload = toAmbassadorRequest([options]);
-        const reqOpts = ambassadorWixPricingPlansV2Plan.queryPublicPlans(payload);
-        __log(`"QueryPublicPlans" sending request with: ${__inspect(reqOpts)}`);
-        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
-        try {
-            const result = yield httpClient.request(reqOpts);
-            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
-            return fromJSON(result.data);
-        }
-        catch (err) {
-            const transformedError = transformError(err, requestTransformation, [
-                'options',
-            ]);
-            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
-            throw transformedError;
-        }
+export function queryPublicPlans() {
+    const requestTransformation = { '*': '$[1]', query: '$[0]' };
+    const responseTransformation = {
+        items: '$.plans',
+        pagingMetadata: '$.pagingMetadata',
+    };
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const { toAmbassadorRequest } = serializer({
+        rootSchema: _queryPublicPlansRequest,
+        depSchemas: {},
+        fqdnTransformation: {
+            paths: [],
+            transformation: _fromVeloEntity,
+        },
+        customTransformation: requestTransformation,
     });
+    const { fromJSON } = serializer({
+        rootSchema: _queryPublicPlansResponse,
+        depSchemas: {},
+        fqdnTransformation: {
+            paths: [],
+            transformation: _toVeloEntity,
+        },
+        customTransformation: responseTransformation,
+    });
+    return wrapWithQueryBuilder({
+        func: (payload) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const reqOpts = ambassadorWixPricingPlansV2Plan.queryPublicPlans(payload);
+            (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+            try {
+                const result = yield httpClient.request(reqOpts);
+                (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+                return result;
+            }
+            catch (err) {
+                (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+                throw err;
+            }
+        }),
+        requestTransformer: (...args) => toAmbassadorRequest(args),
+        responseTransformer: ({ data }) => fromJSON(data),
+        errorTransformer: (err) => {
+            const transformedError = transformError(err, requestTransformation);
+            throw transformedError;
+        },
+        pagingMethod: 'OFFSET',
+        transformationPaths: resolveQueryFieldsTransformationPaths(_toVeloEntity),
+    })({ cursorWithEmptyFilterAndSort: true });
 }
 /**
  * Retrieves a pricing plan by the specified ID.
@@ -218,7 +227,7 @@ export function getPlan(_id) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = { id: '$[0]' };
-        const responseTransformation = '$';
+        const responseTransformation = '$.plan';
         // @ts-ignore
         const { httpClient, sideEffects } = arguments[1];
         const { toAmbassadorRequest } = serializer({
@@ -403,7 +412,7 @@ export function createPlan(plan) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = { plan: '$[0]' };
-        const responseTransformation = '$';
+        const responseTransformation = '$.plan';
         // @ts-ignore
         const { httpClient, sideEffects } = arguments[1];
         const { toAmbassadorRequest } = serializer({
@@ -454,22 +463,23 @@ export function createPlan(plan) {
  * @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 function updatePlan(_id, options) {
+export function updatePlan(_id, plan, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
-            plan: { '*': '$[1].plan', id: '$[0]' },
-            fieldMask: '$[1].fieldMask',
+            plan: { '*': '$[1]', id: '$[0]' },
+            fieldMask: '$[2].fieldMask',
         };
-        const responseTransformation = '$';
+        const responseTransformation = '$.plan';
         // @ts-ignore
-        const { httpClient, sideEffects } = arguments[2];
+        const { httpClient, sideEffects } = arguments[3];
         const { toAmbassadorRequest } = serializer({
             rootSchema: _updatePlanRequest,
             depSchemas: {},
@@ -488,7 +498,7 @@ export function updatePlan(_id, options) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([_id, options]);
+        const payload = toAmbassadorRequest([_id, plan, options]);
         const reqOpts = ambassadorWixPricingPlansV2Plan.updatePlan(payload);
         __log(`"UpdatePlan" sending request with: ${__inspect(reqOpts)}`);
         (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
@@ -500,6 +510,7 @@ export function updatePlan(_id, options) {
         catch (err) {
             const transformedError = transformError(err, requestTransformation, [
                 '_id',
+                'plan',
                 'options',
             ]);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
@@ -521,19 +532,21 @@ export function updatePlan(_id, options) {
  * 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 function setPlanVisibility(_id, options) {
+export function setPlanVisibility(_id, visible) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = { id: '$[0]', visible: '$[1].visible' };
+        const requestTransformation = { id: '$[0]', visible: '$[1]' };
         const responseTransformation = '$';
         // @ts-ignore
         const { httpClient, sideEffects } = arguments[2];
@@ -555,7 +568,7 @@ export function setPlanVisibility(_id, options) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([_id, options]);
+        const payload = toAmbassadorRequest([_id, visible]);
         const reqOpts = ambassadorWixPricingPlansV2Plan.setPlanVisibility(payload);
         __log(`"SetPlanVisibility" sending request with: ${__inspect(reqOpts)}`);
         (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
@@ -567,7 +580,7 @@ export function setPlanVisibility(_id, options) {
         catch (err) {
             const transformedError = transformError(err, requestTransformation, [
                 '_id',
-                'options',
+                'visible',
             ]);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;
@@ -766,13 +779,15 @@ export function archivePlan(_id) {
  * 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 function arrangePlans(options) {
+export function arrangePlans(ids) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = { ids: '$[0].ids' };
+        const requestTransformation = { ids: '$[0]' };
         const responseTransformation = '$';
         // @ts-ignore
         const { httpClient, sideEffects } = arguments[1];
@@ -794,7 +809,7 @@ export function arrangePlans(options) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([options]);
+        const payload = toAmbassadorRequest([ids]);
         const reqOpts = ambassadorWixPricingPlansV2Plan.arrangePlans(payload);
         __log(`"ArrangePlans" sending request with: ${__inspect(reqOpts)}`);
         (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
@@ -805,7 +820,7 @@ export function arrangePlans(options) {
         }
         catch (err) {
             const transformedError = transformError(err, requestTransformation, [
-                'options',
+                'ids',
             ]);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
             throw transformedError;