@wix/pricing-plans 1.0.30 → 1.0.32

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

@@ -57,6 +57,12 @@ 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;
+    /**
+     * ID of the plan's checkout form.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
+    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 {
@@ -181,8 +187,11 @@ 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;
-    clientData?: Record<string, string>;
-    /** Reference to a form which is shown in checkout to gather additional data */
+    /**
+     * ID of the plan's checkout form.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 export interface PagingMetadataV2 {
@@ -367,3 +376,290 @@ export interface ArrangePlansRequest {
 }
 export interface ArrangePlansResponse {
 }
+export interface ListPublicPlansResponseNonNullableFields {
+    plans: {
+        id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        primary: boolean;
+    }[];
+}
+export interface QueryPublicPlansResponseNonNullableFields {
+    plans: {
+        id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        primary: boolean;
+    }[];
+}
+export interface GetPlanResponseNonNullableFields {
+    plan?: {
+        id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        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;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        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;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        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;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        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;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        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;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        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;
+            };
+            feeConfigs: {
+                fee?: {
+                    name: string;
+                    amount: string;
+                };
+                appliedAt: AppliedAt;
+            }[];
+        };
+        archived: boolean;
+        primary: boolean;
+        hasOrders: boolean;
+    };
+}

package/build/cjs/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":";;;AAmHA,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,yBAAW,CAAA;IACX,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,2BAAa,CAAA;AACf,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAsBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0DAA6C,CAAA;IAC7C,mHAAmH;IACnH,4CAA+B,CAAA;AACjC,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AA+FD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAuCD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,yCAAyC;IACzC,mCAAiB,CAAA;IACjB,2CAA2C;IAC3C,uCAAqB,CAAA;IACrB,sDAAsD;IACtD,6DAA2C,CAAA;AAC7C,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB;AAED,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2C;IAC3C,uDAAuC,CAAA;IACvC,iCAAiC;IACjC,iCAAiB,CAAA;IACjB,iCAAiC;IACjC,iCAAiB,CAAA;AACnB,CAAC,EAPW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAOvB"}
+{"version":3,"file":"pricing-plans-v2-plan.types.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-plan.types.ts"],"names":[],"mappings":";;;AAyHA,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,yBAAW,CAAA;IACX,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,2BAAa,CAAA;AACf,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAsBD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0DAA6C,CAAA;IAC7C,mHAAmH;IACnH,4CAA+B,CAAA;AACjC,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AAkGD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAuCD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,yCAAyC;IACzC,mCAAiB,CAAA;IACjB,2CAA2C;IAC3C,uCAAqB,CAAA;IACrB,sDAAsD;IACtD,6DAA2C,CAAA;AAC7C,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB;AAED,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,2CAA2C;IAC3C,uDAAuC,CAAA;IACvC,iCAAiC;IACjC,iCAAiB,CAAA;IACjB,iCAAiC;IACjC,iCAAiB,CAAA;AACnB,CAAC,EAPW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAOvB"}

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

@@ -79,6 +79,8 @@ 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;
+    /** Reserved for internal use.  */
+    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 {
@@ -219,9 +221,11 @@ 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 */
+    /**
+     * ID of the plan's checkout form.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 export interface PagingMetadataV2 {
@@ -438,6 +442,230 @@ export interface ArrangePlansRequest {
 }
 export interface ArrangePlansResponse {
 }
+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;
+    };
+}
 /**
  * Retrieves a list of public pricing plans.
  *
@@ -452,7 +680,7 @@ export interface ArrangePlansResponse {
  * @applicableIdentity VISITOR
  * @returns Fulfilled - List of public pricing plans.
  */
-export declare function listPublicPlans(options?: ListPublicPlansOptions): Promise<ListPublicPlansResponse>;
+export declare function listPublicPlans(options?: ListPublicPlansOptions): Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
 export interface ListPublicPlansOptions {
     /**
      * Number of pricing plans to list.
@@ -557,7 +785,7 @@ export interface PlansQueryBuilder {
  * @applicableIdentity APP
  * @returns Fulfilled - The retrieved plan's information.
  */
-export declare function getPlan(_id: string): Promise<Plan>;
+export declare function getPlan(_id: string): Promise<Plan & NonNullable<GetPlanResponseNonNullableFields>['plan']>;
 /**
  * Retrieves a list of pricing plans.
  *
@@ -568,7 +796,7 @@ export declare function getPlan(_id: string): Promise<Plan>;
  * @applicableIdentity APP
  * @returns Fulfilled - List of plans that match the given criteria.
  */
-export declare function listPlans(options?: ListPlansOptions): Promise<ListPlansResponse>;
+export declare function listPlans(options?: ListPlansOptions): Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
 export interface ListPlansOptions {
     /**
      * Archived filter.
@@ -614,7 +842,7 @@ export interface ListPlansOptions {
  * @applicableIdentity APP
  * @returns Fulfilled - Overall statistics about the pricing plans.
  */
-export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
+export declare function getPlanStats(): Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
 /**
  * Creates a pricing plan.
  *
@@ -642,7 +870,7 @@ export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
  *
  * Rejected - Error message.
  */
-export declare function createPlan(plan: Plan): Promise<Plan>;
+export declare function createPlan(plan: Plan): Promise<Plan & NonNullable<CreatePlanResponseNonNullableFields>['plan']>;
 /**
  * Updates a pricing plan.
  *
@@ -661,7 +889,7 @@ export declare function createPlan(plan: Plan): Promise<Plan>;
  *
  * Rejected - Error message.
  */
-export declare function updatePlan(_id: string, plan: UpdatePlan): Promise<Plan>;
+export declare function updatePlan(_id: string, plan: UpdatePlan): Promise<Plan & NonNullable<UpdatePlanResponseNonNullableFields>['plan']>;
 export interface UpdatePlan {
     /**
      * Plan ID.
@@ -736,6 +964,8 @@ export interface UpdatePlan {
     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. */
+    formId?: string | null;
 }
 /**
  * Sets visibility for non-archived pricing plans.
@@ -761,7 +991,7 @@ export interface UpdatePlan {
  *
  * Rejected - Error message.
  */
-export declare function setPlanVisibility(_id: string, visible: boolean): Promise<SetPlanVisibilityResponse>;
+export declare function setPlanVisibility(_id: string, visible: boolean): Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
 /**
  * Marks a pricing plan as the primary pricing plan.
  *
@@ -778,7 +1008,7 @@ export declare function setPlanVisibility(_id: string, visible: boolean): Promis
  * @applicableIdentity APP
  * @returns Fulfilled - The primary plan.
  */
-export declare function makePlanPrimary(_id: string): Promise<MakePlanPrimaryResponse>;
+export declare function makePlanPrimary(_id: string): Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
 /**
  * Sets all pricing plans to no longer be primary.
  *
@@ -815,7 +1045,7 @@ export declare function clearPrimary(): Promise<void>;
  *
  * Rejected - Error message.
  */
-export declare function archivePlan(_id: string): Promise<ArchivePlanResponse>;
+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.
  *