@wix/pricing-plans 1.0.99 → 1.0.100

package/type-bundles/meta.bundle.d.ts

@@ -103,7 +103,7 @@ interface Order$1 {
      * Start date and time for the ordered plan.
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Current end date and time for the ordered plan.
      *
@@ -113,7 +113,7 @@ interface Order$1 {
      * Omitted if the order is valid until canceled and still `ACTIVE`.
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /**
      * List of periods during which the order is paused.
      * @readonly
@@ -132,7 +132,7 @@ interface Order$1 {
      * Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
      * @readonly
      */
-    earliestEndDate?: Date;
+    earliestEndDate?: Date | null;
     /**
      * Current payment cycle for the order.
      *
@@ -159,12 +159,12 @@ interface Order$1 {
      * Date and time the order was created.
      * @readonly
      */
-    createdDate?: Date;
+    createdDate?: Date | null;
     /**
      * Date and time the order was updated.
      * @readonly
      */
-    updatedDate?: Date;
+    updatedDate?: Date | null;
     /**
      * Information about the form submitted during the plan's checkout.
      * @readonly
@@ -382,7 +382,7 @@ declare enum OrderStatus$1 {
 }
 interface Cancellation$1 {
     /** Date and time the cancellation was requested. */
-    requestedDate?: Date;
+    requestedDate?: Date | null;
     /**
      * Reason for the cancellation. One of:
      * + `OWNER_ACTION`: Site owner canceled the order.
@@ -446,13 +446,13 @@ interface PausePeriod$1 {
      */
     status?: Status$1;
     /** Start date and time of the pause period. */
-    pauseDate?: Date;
+    pauseDate?: Date | null;
     /**
      * End date and time of the pause period.
      *
      * Omitted while the pause period remains `ACTIVE`.
      */
-    resumeDate?: Date;
+    resumeDate?: Date | null;
 }
 declare enum Status$1 {
     UNDEFINED = "UNDEFINED",
@@ -473,9 +473,9 @@ interface CurrentCycle$1 {
      */
     index?: number;
     /** Start date and time for the current payment cycle. */
-    startedDate?: Date;
+    startedDate?: Date | null;
     /** End date and time for the current payment cycle. */
-    endedDate?: Date;
+    endedDate?: Date | null;
 }
 interface FormData$1 {
     /**
@@ -600,7 +600,7 @@ interface CreateOfflineOrderRequest$1 {
      *
      * Default: Current date and time
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Whether the order is paid.
      *
@@ -630,7 +630,7 @@ interface GetOfflineOrderPreviewRequest$1 {
      *
      * Default: Current date and time
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
     couponCode?: string | null;
 }
@@ -734,7 +734,7 @@ interface PostponeEndDateRequest$1 {
      *
      * Must be later than the current end date and time.
      */
-    endDate: Date;
+    endDate: Date | null;
 }
 interface PostponeEndDateResponse$1 {
 }
@@ -983,7 +983,7 @@ interface Order {
      * Start date and time for the ordered plan.
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Current end date and time for the ordered plan.
      *
@@ -993,7 +993,7 @@ interface Order {
      * Omitted if the order is valid until canceled and still `ACTIVE`.
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /**
      * List of periods during which the order is paused.
      * @readonly
@@ -1012,7 +1012,7 @@ interface Order {
      * Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
      * @readonly
      */
-    earliestEndDate?: Date;
+    earliestEndDate?: Date | null;
     /**
      * Current payment cycle for the order.
      *
@@ -1039,12 +1039,12 @@ interface Order {
      * Date and time the order was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date and time the order was updated.
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
     /**
      * Information about the form submitted during the plan's checkout.
      * @readonly
@@ -1258,7 +1258,7 @@ declare enum OrderStatus {
 }
 interface Cancellation {
     /** Date and time the cancellation was requested. */
-    requestedDate?: Date;
+    requestedDate?: Date | null;
     /**
      * Reason for the cancellation. One of:
      * + `OWNER_ACTION`: Site owner canceled the order.
@@ -1321,13 +1321,13 @@ interface PausePeriod {
      */
     status?: Status;
     /** Start date and time of the pause period. */
-    pauseDate?: Date;
+    pauseDate?: Date | null;
     /**
      * End date and time of the pause period.
      *
      * Omitted while the pause period remains `ACTIVE`.
      */
-    resumeDate?: Date;
+    resumeDate?: Date | null;
 }
 declare enum Status {
     UNDEFINED = "UNDEFINED",
@@ -1348,9 +1348,9 @@ interface CurrentCycle {
      */
     index?: number;
     /** Start date and time for the current payment cycle. */
-    startedDate?: Date;
+    startedDate?: Date | null;
     /** End date and time for the current payment cycle. */
-    endedDate?: Date;
+    endedDate?: Date | null;
 }
 interface FormData {
     /** ID of the form associated with the plan at checkout. */
@@ -1481,7 +1481,7 @@ interface CreateOfflineOrderRequest {
      *
      * Default: Current date and time
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Whether the order is paid.
      *
@@ -1511,7 +1511,7 @@ interface GetOfflineOrderPreviewRequest {
      *
      * Default: Current date and time
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
     couponCode?: string | null;
 }
@@ -1616,7 +1616,7 @@ interface PostponeEndDateRequest {
      *
      * Must be later than the current end date and time.
      */
-    endDate: Date;
+    endDate: Date | null;
 }
 interface PostponeEndDateResponse {
 }
@@ -1860,12 +1860,12 @@ interface Plan$1 {
      * Date plan was created.
      * @readonly
      */
-    createdDate?: Date;
+    createdDate?: Date | null;
     /**
      * Date plan was last updated.
      * @readonly
      */
-    updatedDate?: Date;
+    updatedDate?: Date | null;
     /**
      * URL-friendly version of plan name. Unique across all plans in the same site.
      * @readonly
@@ -1981,9 +1981,9 @@ interface PublicPlan$1 {
     /** Whether the plan is marked as primary. */
     primary?: boolean;
     /** Date plan was created. */
-    createdDate?: Date;
+    createdDate?: Date | null;
     /** Date plan was last updated. */
-    updatedDate?: Date;
+    updatedDate?: Date | null;
     /** 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. */
@@ -2102,25 +2102,25 @@ interface GetPlanStatsResponse$1 {
     totalPlans?: number;
 }
 interface CreatePlanRequest$1 {
-    /** Plan to be created. */
+    /** Plan info. */
     plan: Plan$1;
 }
 interface CreatePlanResponse$1 {
-    /** Plan that was created. */
+    /** Created plan. */
     plan?: Plan$1;
 }
 interface UpdatePlanRequest$1 {
-    /** Plan to be updated. */
+    /** Plan info. */
     plan: Plan$1;
 }
 interface UpdatePlanResponse$1 {
-    /** Plan that was updated. */
+    /** Updated plan. */
     plan?: Plan$1;
 }
 interface SetPlanVisibilityRequest$1 {
-    /** Plan id. */
+    /** Plan ID. */
     id: string;
-    /** If true, the Pricing Plan is visible. */
+    /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
     visible: boolean;
 }
 interface SetPlanVisibilityResponse$1 {
@@ -2139,6 +2139,7 @@ interface ClearPrimaryRequest$1 {
 interface ClearPrimaryResponse$1 {
 }
 interface ArchivePlanRequest$1 {
+    /** ID of the plan to archive. */
     id: string;
 }
 interface ArchivePlanResponse$1 {
@@ -2259,12 +2260,12 @@ interface Plan {
      * Date plan was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date plan was last updated.
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
     /**
      * URL-friendly version of plan name. Unique across all plans in the same site.
      * @readonly
@@ -2401,9 +2402,9 @@ interface PublicPlan {
     /** Whether the plan is marked as primary. */
     primary?: boolean;
     /** Date plan was created. */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /** Date plan was last updated. */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
     /** 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. */
@@ -2573,6 +2574,7 @@ interface ClearPrimaryRequest {
 interface ClearPrimaryResponse {
 }
 interface ArchivePlanRequest {
+    /** ID of the plan to archive. */
     _id: string;
 }
 interface ArchivePlanResponse {