@wix/pricing-plans 1.0.99 → 1.0.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -103,7 +103,7 @@ interface Order$1 {
103
103
  * Start date and time for the ordered plan.
104
104
  * @readonly
105
105
  */
106
- startDate?: Date;
106
+ startDate?: Date | null;
107
107
  /**
108
108
  * Current end date and time for the ordered plan.
109
109
  *
@@ -113,7 +113,7 @@ interface Order$1 {
113
113
  * Omitted if the order is valid until canceled and still `ACTIVE`.
114
114
  * @readonly
115
115
  */
116
- endDate?: Date;
116
+ endDate?: Date | null;
117
117
  /**
118
118
  * List of periods during which the order is paused.
119
119
  * @readonly
@@ -132,7 +132,7 @@ interface Order$1 {
132
132
  * Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
133
133
  * @readonly
134
134
  */
135
- earliestEndDate?: Date;
135
+ earliestEndDate?: Date | null;
136
136
  /**
137
137
  * Current payment cycle for the order.
138
138
  *
@@ -159,12 +159,12 @@ interface Order$1 {
159
159
  * Date and time the order was created.
160
160
  * @readonly
161
161
  */
162
- createdDate?: Date;
162
+ createdDate?: Date | null;
163
163
  /**
164
164
  * Date and time the order was updated.
165
165
  * @readonly
166
166
  */
167
- updatedDate?: Date;
167
+ updatedDate?: Date | null;
168
168
  /**
169
169
  * Information about the form submitted during the plan's checkout.
170
170
  * @readonly
@@ -382,7 +382,7 @@ declare enum OrderStatus$1 {
382
382
  }
383
383
  interface Cancellation$1 {
384
384
  /** Date and time the cancellation was requested. */
385
- requestedDate?: Date;
385
+ requestedDate?: Date | null;
386
386
  /**
387
387
  * Reason for the cancellation. One of:
388
388
  * + `OWNER_ACTION`: Site owner canceled the order.
@@ -446,13 +446,13 @@ interface PausePeriod$1 {
446
446
  */
447
447
  status?: Status$1;
448
448
  /** Start date and time of the pause period. */
449
- pauseDate?: Date;
449
+ pauseDate?: Date | null;
450
450
  /**
451
451
  * End date and time of the pause period.
452
452
  *
453
453
  * Omitted while the pause period remains `ACTIVE`.
454
454
  */
455
- resumeDate?: Date;
455
+ resumeDate?: Date | null;
456
456
  }
457
457
  declare enum Status$1 {
458
458
  UNDEFINED = "UNDEFINED",
@@ -473,9 +473,9 @@ interface CurrentCycle$1 {
473
473
  */
474
474
  index?: number;
475
475
  /** Start date and time for the current payment cycle. */
476
- startedDate?: Date;
476
+ startedDate?: Date | null;
477
477
  /** End date and time for the current payment cycle. */
478
- endedDate?: Date;
478
+ endedDate?: Date | null;
479
479
  }
480
480
  interface FormData$1 {
481
481
  /**
@@ -600,7 +600,7 @@ interface CreateOfflineOrderRequest$1 {
600
600
  *
601
601
  * Default: Current date and time
602
602
  */
603
- startDate?: Date;
603
+ startDate?: Date | null;
604
604
  /**
605
605
  * Whether the order is paid.
606
606
  *
@@ -630,7 +630,7 @@ interface GetOfflineOrderPreviewRequest$1 {
630
630
  *
631
631
  * Default: Current date and time
632
632
  */
633
- startDate?: Date;
633
+ startDate?: Date | null;
634
634
  /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
635
635
  couponCode?: string | null;
636
636
  }
@@ -734,7 +734,7 @@ interface PostponeEndDateRequest$1 {
734
734
  *
735
735
  * Must be later than the current end date and time.
736
736
  */
737
- endDate: Date;
737
+ endDate: Date | null;
738
738
  }
739
739
  interface PostponeEndDateResponse$1 {
740
740
  }
@@ -983,7 +983,7 @@ interface Order {
983
983
  * Start date and time for the ordered plan.
984
984
  * @readonly
985
985
  */
986
- startDate?: Date;
986
+ startDate?: Date | null;
987
987
  /**
988
988
  * Current end date and time for the ordered plan.
989
989
  *
@@ -993,7 +993,7 @@ interface Order {
993
993
  * Omitted if the order is valid until canceled and still `ACTIVE`.
994
994
  * @readonly
995
995
  */
996
- endDate?: Date;
996
+ endDate?: Date | null;
997
997
  /**
998
998
  * List of periods during which the order is paused.
999
999
  * @readonly
@@ -1012,7 +1012,7 @@ interface Order {
1012
1012
  * Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
1013
1013
  * @readonly
1014
1014
  */
1015
- earliestEndDate?: Date;
1015
+ earliestEndDate?: Date | null;
1016
1016
  /**
1017
1017
  * Current payment cycle for the order.
1018
1018
  *
@@ -1039,12 +1039,12 @@ interface Order {
1039
1039
  * Date and time the order was created.
1040
1040
  * @readonly
1041
1041
  */
1042
- _createdDate?: Date;
1042
+ _createdDate?: Date | null;
1043
1043
  /**
1044
1044
  * Date and time the order was updated.
1045
1045
  * @readonly
1046
1046
  */
1047
- _updatedDate?: Date;
1047
+ _updatedDate?: Date | null;
1048
1048
  /**
1049
1049
  * Information about the form submitted during the plan's checkout.
1050
1050
  * @readonly
@@ -1258,7 +1258,7 @@ declare enum OrderStatus {
1258
1258
  }
1259
1259
  interface Cancellation {
1260
1260
  /** Date and time the cancellation was requested. */
1261
- requestedDate?: Date;
1261
+ requestedDate?: Date | null;
1262
1262
  /**
1263
1263
  * Reason for the cancellation. One of:
1264
1264
  * + `OWNER_ACTION`: Site owner canceled the order.
@@ -1321,13 +1321,13 @@ interface PausePeriod {
1321
1321
  */
1322
1322
  status?: Status;
1323
1323
  /** Start date and time of the pause period. */
1324
- pauseDate?: Date;
1324
+ pauseDate?: Date | null;
1325
1325
  /**
1326
1326
  * End date and time of the pause period.
1327
1327
  *
1328
1328
  * Omitted while the pause period remains `ACTIVE`.
1329
1329
  */
1330
- resumeDate?: Date;
1330
+ resumeDate?: Date | null;
1331
1331
  }
1332
1332
  declare enum Status {
1333
1333
  UNDEFINED = "UNDEFINED",
@@ -1348,9 +1348,9 @@ interface CurrentCycle {
1348
1348
  */
1349
1349
  index?: number;
1350
1350
  /** Start date and time for the current payment cycle. */
1351
- startedDate?: Date;
1351
+ startedDate?: Date | null;
1352
1352
  /** End date and time for the current payment cycle. */
1353
- endedDate?: Date;
1353
+ endedDate?: Date | null;
1354
1354
  }
1355
1355
  interface FormData {
1356
1356
  /** ID of the form associated with the plan at checkout. */
@@ -1481,7 +1481,7 @@ interface CreateOfflineOrderRequest {
1481
1481
  *
1482
1482
  * Default: Current date and time
1483
1483
  */
1484
- startDate?: Date;
1484
+ startDate?: Date | null;
1485
1485
  /**
1486
1486
  * Whether the order is paid.
1487
1487
  *
@@ -1511,7 +1511,7 @@ interface GetOfflineOrderPreviewRequest {
1511
1511
  *
1512
1512
  * Default: Current date and time
1513
1513
  */
1514
- startDate?: Date;
1514
+ startDate?: Date | null;
1515
1515
  /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
1516
1516
  couponCode?: string | null;
1517
1517
  }
@@ -1616,7 +1616,7 @@ interface PostponeEndDateRequest {
1616
1616
  *
1617
1617
  * Must be later than the current end date and time.
1618
1618
  */
1619
- endDate: Date;
1619
+ endDate: Date | null;
1620
1620
  }
1621
1621
  interface PostponeEndDateResponse {
1622
1622
  }
@@ -1860,12 +1860,12 @@ interface Plan$1 {
1860
1860
  * Date plan was created.
1861
1861
  * @readonly
1862
1862
  */
1863
- createdDate?: Date;
1863
+ createdDate?: Date | null;
1864
1864
  /**
1865
1865
  * Date plan was last updated.
1866
1866
  * @readonly
1867
1867
  */
1868
- updatedDate?: Date;
1868
+ updatedDate?: Date | null;
1869
1869
  /**
1870
1870
  * URL-friendly version of plan name. Unique across all plans in the same site.
1871
1871
  * @readonly
@@ -1981,9 +1981,9 @@ interface PublicPlan$1 {
1981
1981
  /** Whether the plan is marked as primary. */
1982
1982
  primary?: boolean;
1983
1983
  /** Date plan was created. */
1984
- createdDate?: Date;
1984
+ createdDate?: Date | null;
1985
1985
  /** Date plan was last updated. */
1986
- updatedDate?: Date;
1986
+ updatedDate?: Date | null;
1987
1987
  /** URL-friendly version of plan name. Unique across all plans in the same site. */
1988
1988
  slug?: string | null;
1989
1989
  /** 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 {
2102
2102
  totalPlans?: number;
2103
2103
  }
2104
2104
  interface CreatePlanRequest$1 {
2105
- /** Plan to be created. */
2105
+ /** Plan info. */
2106
2106
  plan: Plan$1;
2107
2107
  }
2108
2108
  interface CreatePlanResponse$1 {
2109
- /** Plan that was created. */
2109
+ /** Created plan. */
2110
2110
  plan?: Plan$1;
2111
2111
  }
2112
2112
  interface UpdatePlanRequest$1 {
2113
- /** Plan to be updated. */
2113
+ /** Plan info. */
2114
2114
  plan: Plan$1;
2115
2115
  }
2116
2116
  interface UpdatePlanResponse$1 {
2117
- /** Plan that was updated. */
2117
+ /** Updated plan. */
2118
2118
  plan?: Plan$1;
2119
2119
  }
2120
2120
  interface SetPlanVisibilityRequest$1 {
2121
- /** Plan id. */
2121
+ /** Plan ID. */
2122
2122
  id: string;
2123
- /** If true, the Pricing Plan is visible. */
2123
+ /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
2124
2124
  visible: boolean;
2125
2125
  }
2126
2126
  interface SetPlanVisibilityResponse$1 {
@@ -2139,6 +2139,7 @@ interface ClearPrimaryRequest$1 {
2139
2139
  interface ClearPrimaryResponse$1 {
2140
2140
  }
2141
2141
  interface ArchivePlanRequest$1 {
2142
+ /** ID of the plan to archive. */
2142
2143
  id: string;
2143
2144
  }
2144
2145
  interface ArchivePlanResponse$1 {
@@ -2259,12 +2260,12 @@ interface Plan {
2259
2260
  * Date plan was created.
2260
2261
  * @readonly
2261
2262
  */
2262
- _createdDate?: Date;
2263
+ _createdDate?: Date | null;
2263
2264
  /**
2264
2265
  * Date plan was last updated.
2265
2266
  * @readonly
2266
2267
  */
2267
- _updatedDate?: Date;
2268
+ _updatedDate?: Date | null;
2268
2269
  /**
2269
2270
  * URL-friendly version of plan name. Unique across all plans in the same site.
2270
2271
  * @readonly
@@ -2401,9 +2402,9 @@ interface PublicPlan {
2401
2402
  /** Whether the plan is marked as primary. */
2402
2403
  primary?: boolean;
2403
2404
  /** Date plan was created. */
2404
- _createdDate?: Date;
2405
+ _createdDate?: Date | null;
2405
2406
  /** Date plan was last updated. */
2406
- _updatedDate?: Date;
2407
+ _updatedDate?: Date | null;
2407
2408
  /** URL-friendly version of plan name. Unique across all plans in the same site. */
2408
2409
  slug?: string | null;
2409
2410
  /** 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 {
2573
2574
  interface ClearPrimaryResponse {
2574
2575
  }
2575
2576
  interface ArchivePlanRequest {
2577
+ /** ID of the plan to archive. */
2576
2578
  _id: string;
2577
2579
  }
2578
2580
  interface ArchivePlanResponse {