@wix/app-management 1.0.46 → 1.0.48

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/app-management",
3
- "version": "1.0.46",
3
+ "version": "1.0.48",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -23,10 +23,10 @@
23
23
  ],
24
24
  "dependencies": {
25
25
  "@wix/app-management_app-instances": "1.0.26",
26
- "@wix/app-management_app-plans": "1.0.24",
26
+ "@wix/app-management_app-plans": "1.0.25",
27
27
  "@wix/app-management_bi-events": "1.0.24",
28
28
  "@wix/app-management_billing": "1.0.24",
29
- "@wix/app-management_custom-charges": "1.0.21",
29
+ "@wix/app-management_custom-charges": "1.0.22",
30
30
  "@wix/app-management_embedded-scripts": "1.0.21"
31
31
  },
32
32
  "devDependencies": {
@@ -52,5 +52,5 @@
52
52
  "fqdn": ""
53
53
  }
54
54
  },
55
- "falconPackageHash": "6100eefd2bc54e1e714c61fe6dbcf46653a60b849aef0d3947db07f5"
55
+ "falconPackageHash": "988821b48c02670ad67ee7a3ccf8a0897e7f768388565e85173ded49"
56
56
  }
@@ -487,13 +487,6 @@ interface AppPlans {
487
487
  */
488
488
  plans?: Plan[];
489
489
  }
490
- declare enum DiscountType {
491
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
492
- /** Discount is a fixed amount in USD. */
493
- FIXED_AMOUNT = "FIXED_AMOUNT",
494
- /** Discount is a percentage of the total price. */
495
- PERCENTAGE = "PERCENTAGE"
496
- }
497
490
  declare enum SaleType {
498
491
  /** Default value, can be used when no specific sale is associated. */
499
492
  SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
@@ -502,6 +495,25 @@ declare enum SaleType {
502
495
  BLACK_FRIDAY = "BLACK_FRIDAY",
503
496
  DEVELOPER_SALE = "DEVELOPER_SALE"
504
497
  }
498
+ declare enum DiscountType {
499
+ DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
500
+ /** Discount is a fixed amount in USD. */
501
+ FIXED_AMOUNT = "FIXED_AMOUNT",
502
+ /** Discount is a percentage of the total price. */
503
+ PERCENTAGE = "PERCENTAGE"
504
+ }
505
+ declare enum SourceType {
506
+ /** Default value, can be used when no specific source is associated. */
507
+ SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
508
+ /** Discount is due to Wix/Developer Sale */
509
+ SALE = "SALE",
510
+ /** Discount is due to App Benefit */
511
+ APP_BENEFIT = "APP_BENEFIT"
512
+ }
513
+ interface SaleSource {
514
+ saleId?: string | null;
515
+ saleType?: SaleType;
516
+ }
505
517
  interface Cycle {
506
518
  /**
507
519
  * Type of the billing cycle.
@@ -545,7 +557,7 @@ interface UsageBasedDetails {
545
557
  */
546
558
  minimumChargeIncrement?: string | null;
547
559
  /**
548
- * Recurring, monthly base fee in usaged-based pricing that your app
560
+ * Recurring, monthly base fee in usage-based pricing that your app
549
561
  * charges customers regardless of how much they use your app.
550
562
  *
551
563
  * Min: `0.00`
@@ -553,20 +565,27 @@ interface UsageBasedDetails {
553
565
  */
554
566
  monthlyBaseFee?: string | null;
555
567
  /**
556
- * Description of the usaged-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
568
+ * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
557
569
  *
558
570
  * Max: 1024 characters
559
571
  */
560
572
  customChargeDescription?: string | null;
561
573
  }
562
- interface Discount {
574
+ interface Discount extends DiscountSourceDataOneOf {
575
+ /** Sale type */
576
+ saleOptions?: SaleSource;
563
577
  type?: DiscountType;
564
578
  /** Discount amount */
565
579
  amount?: string;
580
+ /**
581
+ * if a discount is applied to a specific sale
582
+ * @deprecated if a discount is applied to a specific sale
583
+ * @targetRemovalDate 2025-01-14
584
+ */
566
585
  saleId?: string | null;
567
586
  /**
568
587
  * Price without taxes. For yearly plans, Wix calculates and returns the
569
- * average price per month. You can get thefull price by multiplying the
588
+ * average price per month. You can get the full price by multiplying the
570
589
  * returned price with 12.
571
590
  * Min: `0.00`
572
591
  * Max: 1024 characters
@@ -578,7 +597,17 @@ interface Discount {
578
597
  * Max: 1024 characters
579
598
  */
580
599
  totalPrice?: string;
600
+ /**
601
+ * @deprecated
602
+ * @targetRemovalDate 2025-01-14
603
+ */
581
604
  saleType?: SaleType;
605
+ sourceType?: SourceType;
606
+ }
607
+ /** @oneof */
608
+ interface DiscountSourceDataOneOf {
609
+ /** Sale type */
610
+ saleOptions?: SaleSource;
582
611
  }
583
612
  declare enum BillingSource {
584
613
  UNKNOWN = "UNKNOWN",
@@ -590,8 +619,8 @@ declare enum BillingSource {
590
619
  interface Price {
591
620
  /**
592
621
  * Price without taxes. For yearly plans, Wix calculates and returns the
593
- * average price per month. You can get thefull price by multiplying the
594
- * returned price with 12.
622
+ * average price per month. You can get the full price by multiplying the
623
+ * returned price by 12.
595
624
  *
596
625
  * Min: `0.00`
597
626
  * Max: 1024 characters
@@ -728,12 +757,17 @@ interface CycleNonNullableFields {
728
757
  cycleType: CycleType;
729
758
  cycleDuration?: DurationNonNullableFields;
730
759
  }
760
+ interface SaleSourceNonNullableFields {
761
+ saleType: SaleType;
762
+ }
731
763
  interface DiscountNonNullableFields {
764
+ saleOptions?: SaleSourceNonNullableFields;
732
765
  type: DiscountType;
733
766
  amount: string;
734
767
  priceBeforeTax: string;
735
768
  totalPrice: string;
736
769
  saleType: SaleType;
770
+ sourceType: SourceType;
737
771
  }
738
772
  interface PriceNonNullableFields {
739
773
  priceBeforeTax: string;
@@ -803,6 +837,7 @@ type context$4_Cycle = Cycle;
803
837
  type context$4_CycleType = CycleType;
804
838
  declare const context$4_CycleType: typeof CycleType;
805
839
  type context$4_Discount = Discount;
840
+ type context$4_DiscountSourceDataOneOf = DiscountSourceDataOneOf;
806
841
  type context$4_DiscountType = DiscountType;
807
842
  declare const context$4_DiscountType: typeof DiscountType;
808
843
  type context$4_Duration = Duration;
@@ -813,15 +848,18 @@ type context$4_ListAppPlansByAppIdResponse = ListAppPlansByAppIdResponse;
813
848
  type context$4_ListAppPlansByAppIdResponseNonNullableFields = ListAppPlansByAppIdResponseNonNullableFields;
814
849
  type context$4_Plan = Plan;
815
850
  type context$4_Price = Price;
851
+ type context$4_SaleSource = SaleSource;
816
852
  type context$4_SaleType = SaleType;
817
853
  declare const context$4_SaleType: typeof SaleType;
854
+ type context$4_SourceType = SourceType;
855
+ declare const context$4_SourceType: typeof SourceType;
818
856
  type context$4_TaxSettings = TaxSettings;
819
857
  type context$4_TaxType = TaxType;
820
858
  declare const context$4_TaxType: typeof TaxType;
821
859
  type context$4_UsageBasedDetails = UsageBasedDetails;
822
860
  declare const context$4_listAppPlansByAppId: typeof listAppPlansByAppId;
823
861
  declare namespace context$4 {
824
- export { type context$4_AppPlans as AppPlans, context$4_BillingSource as BillingSource, type context$4_Cycle as Cycle, context$4_CycleType as CycleType, type context$4_Discount as Discount, context$4_DiscountType as DiscountType, type context$4_Duration as Duration, context$4_DurationUnit as DurationUnit, type context$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type context$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type context$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type context$4_Plan as Plan, type context$4_Price as Price, context$4_SaleType as SaleType, type context$4_TaxSettings as TaxSettings, context$4_TaxType as TaxType, type context$4_UsageBasedDetails as UsageBasedDetails, context$4_listAppPlansByAppId as listAppPlansByAppId };
862
+ export { type context$4_AppPlans as AppPlans, context$4_BillingSource as BillingSource, type context$4_Cycle as Cycle, context$4_CycleType as CycleType, type context$4_Discount as Discount, type context$4_DiscountSourceDataOneOf as DiscountSourceDataOneOf, context$4_DiscountType as DiscountType, type context$4_Duration as Duration, context$4_DurationUnit as DurationUnit, type context$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type context$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type context$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type context$4_Plan as Plan, type context$4_Price as Price, type context$4_SaleSource as SaleSource, context$4_SaleType as SaleType, context$4_SourceType as SourceType, type context$4_TaxSettings as TaxSettings, context$4_TaxType as TaxType, type context$4_UsageBasedDetails as UsageBasedDetails, context$4_listAppPlansByAppId as listAppPlansByAppId };
825
863
  }
826
864
 
827
865
  /**
@@ -487,13 +487,6 @@ interface AppPlans {
487
487
  */
488
488
  plans?: Plan[];
489
489
  }
490
- declare enum DiscountType {
491
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
492
- /** Discount is a fixed amount in USD. */
493
- FIXED_AMOUNT = "FIXED_AMOUNT",
494
- /** Discount is a percentage of the total price. */
495
- PERCENTAGE = "PERCENTAGE"
496
- }
497
490
  declare enum SaleType {
498
491
  /** Default value, can be used when no specific sale is associated. */
499
492
  SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
@@ -502,6 +495,25 @@ declare enum SaleType {
502
495
  BLACK_FRIDAY = "BLACK_FRIDAY",
503
496
  DEVELOPER_SALE = "DEVELOPER_SALE"
504
497
  }
498
+ declare enum DiscountType {
499
+ DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
500
+ /** Discount is a fixed amount in USD. */
501
+ FIXED_AMOUNT = "FIXED_AMOUNT",
502
+ /** Discount is a percentage of the total price. */
503
+ PERCENTAGE = "PERCENTAGE"
504
+ }
505
+ declare enum SourceType {
506
+ /** Default value, can be used when no specific source is associated. */
507
+ SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
508
+ /** Discount is due to Wix/Developer Sale */
509
+ SALE = "SALE",
510
+ /** Discount is due to App Benefit */
511
+ APP_BENEFIT = "APP_BENEFIT"
512
+ }
513
+ interface SaleSource {
514
+ saleId?: string | null;
515
+ saleType?: SaleType;
516
+ }
505
517
  interface Cycle {
506
518
  /**
507
519
  * Type of the billing cycle.
@@ -545,7 +557,7 @@ interface UsageBasedDetails {
545
557
  */
546
558
  minimumChargeIncrement?: string | null;
547
559
  /**
548
- * Recurring, monthly base fee in usaged-based pricing that your app
560
+ * Recurring, monthly base fee in usage-based pricing that your app
549
561
  * charges customers regardless of how much they use your app.
550
562
  *
551
563
  * Min: `0.00`
@@ -553,20 +565,27 @@ interface UsageBasedDetails {
553
565
  */
554
566
  monthlyBaseFee?: string | null;
555
567
  /**
556
- * Description of the usaged-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
568
+ * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
557
569
  *
558
570
  * Max: 1024 characters
559
571
  */
560
572
  customChargeDescription?: string | null;
561
573
  }
562
- interface Discount {
574
+ interface Discount extends DiscountSourceDataOneOf {
575
+ /** Sale type */
576
+ saleOptions?: SaleSource;
563
577
  type?: DiscountType;
564
578
  /** Discount amount */
565
579
  amount?: string;
580
+ /**
581
+ * if a discount is applied to a specific sale
582
+ * @deprecated if a discount is applied to a specific sale
583
+ * @targetRemovalDate 2025-01-14
584
+ */
566
585
  saleId?: string | null;
567
586
  /**
568
587
  * Price without taxes. For yearly plans, Wix calculates and returns the
569
- * average price per month. You can get thefull price by multiplying the
588
+ * average price per month. You can get the full price by multiplying the
570
589
  * returned price with 12.
571
590
  * Min: `0.00`
572
591
  * Max: 1024 characters
@@ -578,7 +597,17 @@ interface Discount {
578
597
  * Max: 1024 characters
579
598
  */
580
599
  totalPrice?: string;
600
+ /**
601
+ * @deprecated
602
+ * @targetRemovalDate 2025-01-14
603
+ */
581
604
  saleType?: SaleType;
605
+ sourceType?: SourceType;
606
+ }
607
+ /** @oneof */
608
+ interface DiscountSourceDataOneOf {
609
+ /** Sale type */
610
+ saleOptions?: SaleSource;
582
611
  }
583
612
  declare enum BillingSource {
584
613
  UNKNOWN = "UNKNOWN",
@@ -590,8 +619,8 @@ declare enum BillingSource {
590
619
  interface Price {
591
620
  /**
592
621
  * Price without taxes. For yearly plans, Wix calculates and returns the
593
- * average price per month. You can get thefull price by multiplying the
594
- * returned price with 12.
622
+ * average price per month. You can get the full price by multiplying the
623
+ * returned price by 12.
595
624
  *
596
625
  * Min: `0.00`
597
626
  * Max: 1024 characters
@@ -728,12 +757,17 @@ interface CycleNonNullableFields {
728
757
  cycleType: CycleType;
729
758
  cycleDuration?: DurationNonNullableFields;
730
759
  }
760
+ interface SaleSourceNonNullableFields {
761
+ saleType: SaleType;
762
+ }
731
763
  interface DiscountNonNullableFields {
764
+ saleOptions?: SaleSourceNonNullableFields;
732
765
  type: DiscountType;
733
766
  amount: string;
734
767
  priceBeforeTax: string;
735
768
  totalPrice: string;
736
769
  saleType: SaleType;
770
+ sourceType: SourceType;
737
771
  }
738
772
  interface PriceNonNullableFields {
739
773
  priceBeforeTax: string;
@@ -803,6 +837,7 @@ type index_d$4_Cycle = Cycle;
803
837
  type index_d$4_CycleType = CycleType;
804
838
  declare const index_d$4_CycleType: typeof CycleType;
805
839
  type index_d$4_Discount = Discount;
840
+ type index_d$4_DiscountSourceDataOneOf = DiscountSourceDataOneOf;
806
841
  type index_d$4_DiscountType = DiscountType;
807
842
  declare const index_d$4_DiscountType: typeof DiscountType;
808
843
  type index_d$4_Duration = Duration;
@@ -813,15 +848,18 @@ type index_d$4_ListAppPlansByAppIdResponse = ListAppPlansByAppIdResponse;
813
848
  type index_d$4_ListAppPlansByAppIdResponseNonNullableFields = ListAppPlansByAppIdResponseNonNullableFields;
814
849
  type index_d$4_Plan = Plan;
815
850
  type index_d$4_Price = Price;
851
+ type index_d$4_SaleSource = SaleSource;
816
852
  type index_d$4_SaleType = SaleType;
817
853
  declare const index_d$4_SaleType: typeof SaleType;
854
+ type index_d$4_SourceType = SourceType;
855
+ declare const index_d$4_SourceType: typeof SourceType;
818
856
  type index_d$4_TaxSettings = TaxSettings;
819
857
  type index_d$4_TaxType = TaxType;
820
858
  declare const index_d$4_TaxType: typeof TaxType;
821
859
  type index_d$4_UsageBasedDetails = UsageBasedDetails;
822
860
  declare const index_d$4_listAppPlansByAppId: typeof listAppPlansByAppId;
823
861
  declare namespace index_d$4 {
824
- export { type index_d$4_AppPlans as AppPlans, index_d$4_BillingSource as BillingSource, type index_d$4_Cycle as Cycle, index_d$4_CycleType as CycleType, type index_d$4_Discount as Discount, index_d$4_DiscountType as DiscountType, type index_d$4_Duration as Duration, index_d$4_DurationUnit as DurationUnit, type index_d$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type index_d$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type index_d$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type index_d$4_Plan as Plan, type index_d$4_Price as Price, index_d$4_SaleType as SaleType, type index_d$4_TaxSettings as TaxSettings, index_d$4_TaxType as TaxType, type index_d$4_UsageBasedDetails as UsageBasedDetails, index_d$4_listAppPlansByAppId as listAppPlansByAppId };
862
+ export { type index_d$4_AppPlans as AppPlans, index_d$4_BillingSource as BillingSource, type index_d$4_Cycle as Cycle, index_d$4_CycleType as CycleType, type index_d$4_Discount as Discount, type index_d$4_DiscountSourceDataOneOf as DiscountSourceDataOneOf, index_d$4_DiscountType as DiscountType, type index_d$4_Duration as Duration, index_d$4_DurationUnit as DurationUnit, type index_d$4_ListAppPlansByAppIdRequest as ListAppPlansByAppIdRequest, type index_d$4_ListAppPlansByAppIdResponse as ListAppPlansByAppIdResponse, type index_d$4_ListAppPlansByAppIdResponseNonNullableFields as ListAppPlansByAppIdResponseNonNullableFields, type index_d$4_Plan as Plan, type index_d$4_Price as Price, type index_d$4_SaleSource as SaleSource, index_d$4_SaleType as SaleType, index_d$4_SourceType as SourceType, type index_d$4_TaxSettings as TaxSettings, index_d$4_TaxType as TaxType, type index_d$4_UsageBasedDetails as UsageBasedDetails, index_d$4_listAppPlansByAppId as listAppPlansByAppId };
825
863
  }
826
864
 
827
865
  /**
@@ -9,13 +9,6 @@ interface AppPlans$1 {
9
9
  */
10
10
  plans?: Plan$1[];
11
11
  }
12
- declare enum DiscountType$1 {
13
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
14
- /** Discount is a fixed amount in USD. */
15
- FIXED_AMOUNT = "FIXED_AMOUNT",
16
- /** Discount is a percentage of the total price. */
17
- PERCENTAGE = "PERCENTAGE"
18
- }
19
12
  declare enum SaleType$1 {
20
13
  /** Default value, can be used when no specific sale is associated. */
21
14
  SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
@@ -24,6 +17,25 @@ declare enum SaleType$1 {
24
17
  BLACK_FRIDAY = "BLACK_FRIDAY",
25
18
  DEVELOPER_SALE = "DEVELOPER_SALE"
26
19
  }
20
+ declare enum DiscountType$1 {
21
+ DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
22
+ /** Discount is a fixed amount in USD. */
23
+ FIXED_AMOUNT = "FIXED_AMOUNT",
24
+ /** Discount is a percentage of the total price. */
25
+ PERCENTAGE = "PERCENTAGE"
26
+ }
27
+ declare enum SourceType$1 {
28
+ /** Default value, can be used when no specific source is associated. */
29
+ SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
30
+ /** Discount is due to Wix/Developer Sale */
31
+ SALE = "SALE",
32
+ /** Discount is due to App Benefit */
33
+ APP_BENEFIT = "APP_BENEFIT"
34
+ }
35
+ interface SaleSource$1 {
36
+ saleId?: string | null;
37
+ saleType?: SaleType$1;
38
+ }
27
39
  interface Cycle$1 {
28
40
  /**
29
41
  * Type of the billing cycle.
@@ -67,7 +79,7 @@ interface UsageBasedDetails$1 {
67
79
  */
68
80
  minimumChargeIncrement?: string | null;
69
81
  /**
70
- * Recurring, monthly base fee in usaged-based pricing that your app
82
+ * Recurring, monthly base fee in usage-based pricing that your app
71
83
  * charges customers regardless of how much they use your app.
72
84
  *
73
85
  * Min: `0.00`
@@ -75,20 +87,27 @@ interface UsageBasedDetails$1 {
75
87
  */
76
88
  monthlyBaseFee?: string | null;
77
89
  /**
78
- * Description of the usaged-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
90
+ * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
79
91
  *
80
92
  * Max: 1024 characters
81
93
  */
82
94
  customChargeDescription?: string | null;
83
95
  }
84
- interface Discount$1 {
96
+ interface Discount$1 extends DiscountSourceDataOneOf$1 {
97
+ /** Sale type */
98
+ saleOptions?: SaleSource$1;
85
99
  type?: DiscountType$1;
86
100
  /** Discount amount */
87
101
  amount?: string;
102
+ /**
103
+ * if a discount is applied to a specific sale
104
+ * @deprecated if a discount is applied to a specific sale
105
+ * @targetRemovalDate 2025-01-14
106
+ */
88
107
  saleId?: string | null;
89
108
  /**
90
109
  * Price without taxes. For yearly plans, Wix calculates and returns the
91
- * average price per month. You can get thefull price by multiplying the
110
+ * average price per month. You can get the full price by multiplying the
92
111
  * returned price with 12.
93
112
  * Min: `0.00`
94
113
  * Max: 1024 characters
@@ -100,7 +119,17 @@ interface Discount$1 {
100
119
  * Max: 1024 characters
101
120
  */
102
121
  totalPrice?: string;
122
+ /**
123
+ * @deprecated
124
+ * @targetRemovalDate 2025-01-14
125
+ */
103
126
  saleType?: SaleType$1;
127
+ sourceType?: SourceType$1;
128
+ }
129
+ /** @oneof */
130
+ interface DiscountSourceDataOneOf$1 {
131
+ /** Sale type */
132
+ saleOptions?: SaleSource$1;
104
133
  }
105
134
  declare enum BillingSource$1 {
106
135
  UNKNOWN = "UNKNOWN",
@@ -112,8 +141,8 @@ declare enum BillingSource$1 {
112
141
  interface Price$1 {
113
142
  /**
114
143
  * Price without taxes. For yearly plans, Wix calculates and returns the
115
- * average price per month. You can get thefull price by multiplying the
116
- * returned price with 12.
144
+ * average price per month. You can get the full price by multiplying the
145
+ * returned price by 12.
117
146
  *
118
147
  * Min: `0.00`
119
148
  * Max: 1024 characters
@@ -250,12 +279,17 @@ interface CycleNonNullableFields$1 {
250
279
  cycleType: CycleType$1;
251
280
  cycleDuration?: DurationNonNullableFields$1;
252
281
  }
282
+ interface SaleSourceNonNullableFields$1 {
283
+ saleType: SaleType$1;
284
+ }
253
285
  interface DiscountNonNullableFields$1 {
286
+ saleOptions?: SaleSourceNonNullableFields$1;
254
287
  type: DiscountType$1;
255
288
  amount: string;
256
289
  priceBeforeTax: string;
257
290
  totalPrice: string;
258
291
  saleType: SaleType$1;
292
+ sourceType: SourceType$1;
259
293
  }
260
294
  interface PriceNonNullableFields$1 {
261
295
  priceBeforeTax: string;
@@ -293,13 +327,6 @@ interface AppPlans {
293
327
  */
294
328
  plans?: Plan[];
295
329
  }
296
- declare enum DiscountType {
297
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
298
- /** Discount is a fixed amount in USD. */
299
- FIXED_AMOUNT = "FIXED_AMOUNT",
300
- /** Discount is a percentage of the total price. */
301
- PERCENTAGE = "PERCENTAGE"
302
- }
303
330
  declare enum SaleType {
304
331
  /** Default value, can be used when no specific sale is associated. */
305
332
  SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
@@ -308,6 +335,25 @@ declare enum SaleType {
308
335
  BLACK_FRIDAY = "BLACK_FRIDAY",
309
336
  DEVELOPER_SALE = "DEVELOPER_SALE"
310
337
  }
338
+ declare enum DiscountType {
339
+ DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
340
+ /** Discount is a fixed amount in USD. */
341
+ FIXED_AMOUNT = "FIXED_AMOUNT",
342
+ /** Discount is a percentage of the total price. */
343
+ PERCENTAGE = "PERCENTAGE"
344
+ }
345
+ declare enum SourceType {
346
+ /** Default value, can be used when no specific source is associated. */
347
+ SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
348
+ /** Discount is due to Wix/Developer Sale */
349
+ SALE = "SALE",
350
+ /** Discount is due to App Benefit */
351
+ APP_BENEFIT = "APP_BENEFIT"
352
+ }
353
+ interface SaleSource {
354
+ saleId?: string | null;
355
+ saleType?: SaleType;
356
+ }
311
357
  interface Cycle {
312
358
  /**
313
359
  * Type of the billing cycle.
@@ -351,7 +397,7 @@ interface UsageBasedDetails {
351
397
  */
352
398
  minimumChargeIncrement?: string | null;
353
399
  /**
354
- * Recurring, monthly base fee in usaged-based pricing that your app
400
+ * Recurring, monthly base fee in usage-based pricing that your app
355
401
  * charges customers regardless of how much they use your app.
356
402
  *
357
403
  * Min: `0.00`
@@ -359,20 +405,27 @@ interface UsageBasedDetails {
359
405
  */
360
406
  monthlyBaseFee?: string | null;
361
407
  /**
362
- * Description of the usaged-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
408
+ * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
363
409
  *
364
410
  * Max: 1024 characters
365
411
  */
366
412
  customChargeDescription?: string | null;
367
413
  }
368
- interface Discount {
414
+ interface Discount extends DiscountSourceDataOneOf {
415
+ /** Sale type */
416
+ saleOptions?: SaleSource;
369
417
  type?: DiscountType;
370
418
  /** Discount amount */
371
419
  amount?: string;
420
+ /**
421
+ * if a discount is applied to a specific sale
422
+ * @deprecated if a discount is applied to a specific sale
423
+ * @targetRemovalDate 2025-01-14
424
+ */
372
425
  saleId?: string | null;
373
426
  /**
374
427
  * Price without taxes. For yearly plans, Wix calculates and returns the
375
- * average price per month. You can get thefull price by multiplying the
428
+ * average price per month. You can get the full price by multiplying the
376
429
  * returned price with 12.
377
430
  * Min: `0.00`
378
431
  * Max: 1024 characters
@@ -384,7 +437,17 @@ interface Discount {
384
437
  * Max: 1024 characters
385
438
  */
386
439
  totalPrice?: string;
440
+ /**
441
+ * @deprecated
442
+ * @targetRemovalDate 2025-01-14
443
+ */
387
444
  saleType?: SaleType;
445
+ sourceType?: SourceType;
446
+ }
447
+ /** @oneof */
448
+ interface DiscountSourceDataOneOf {
449
+ /** Sale type */
450
+ saleOptions?: SaleSource;
388
451
  }
389
452
  declare enum BillingSource {
390
453
  UNKNOWN = "UNKNOWN",
@@ -396,8 +459,8 @@ declare enum BillingSource {
396
459
  interface Price {
397
460
  /**
398
461
  * Price without taxes. For yearly plans, Wix calculates and returns the
399
- * average price per month. You can get thefull price by multiplying the
400
- * returned price with 12.
462
+ * average price per month. You can get the full price by multiplying the
463
+ * returned price by 12.
401
464
  *
402
465
  * Min: `0.00`
403
466
  * Max: 1024 characters
@@ -534,12 +597,17 @@ interface CycleNonNullableFields {
534
597
  cycleType: CycleType;
535
598
  cycleDuration?: DurationNonNullableFields;
536
599
  }
600
+ interface SaleSourceNonNullableFields {
601
+ saleType: SaleType;
602
+ }
537
603
  interface DiscountNonNullableFields {
604
+ saleOptions?: SaleSourceNonNullableFields;
538
605
  type: DiscountType;
539
606
  amount: string;
540
607
  priceBeforeTax: string;
541
608
  totalPrice: string;
542
609
  saleType: SaleType;
610
+ sourceType: SourceType;
543
611
  }
544
612
  interface PriceNonNullableFields {
545
613
  priceBeforeTax: string;
@@ -48,18 +48,13 @@ interface ListChargesRequest {
48
48
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
49
49
  */
50
50
  periodEnd?: Date | null;
51
- /**
52
- * Information about what Wix intends to do with the retrieved charges.
53
- *
54
- * + `"DISPLAY_ONLY"`: Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice.
55
- * + `"CREATE_INVOICE"`: Create an invoice for the customer.
56
- */
51
+ /** Information about what Wix intends to do with the retrieved charges. */
57
52
  intent?: Intent;
58
53
  }
59
54
  declare enum Intent {
60
- /** retrieving the current charges for display purposes only */
55
+ /** Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice. */
61
56
  DISPLAY_ONLY = "DISPLAY_ONLY",
62
- /** retrieving the current charges with the intention of creating an invoice and billing the user */
57
+ /** Create an invoice for the customer. */
63
58
  CREATE_INVOICE = "CREATE_INVOICE"
64
59
  }
65
60
  interface ListChargesResponse {
@@ -121,19 +116,18 @@ interface ChargesRejectedRequest {
121
116
  /**
122
117
  * Information about why Wix has rejected your app's charges.
123
118
  *
124
- * + `"UNKNOWN_REASON"`: There is no information about why Wix has rejected the charges.
125
- * + `"CHARGE_LIMIT_EXCEEDED"`: The sum of the charges is higher than the limit that you may charge the customer per billing cycle.
126
- * + `"TOO_MANY_CHARGES"`: You can't provide more than 5 charges per invoice.
127
- * + `"INVALID_FORMAT"`: You must submit charges as whole numbers or use a dot to separate major and minor units. For example, `10` or `1.50`. Currently, Wix doesn't validate whether the submitted number of decimals for the minor unit is supported for the given currency.
128
- *
129
119
  * Max: 20 reasons
130
120
  */
131
121
  reasons?: ChargesRejectedReason[];
132
122
  }
133
123
  declare enum ChargesRejectedReason {
124
+ /** There is no information about why Wix has rejected the charges. */
134
125
  UNKNOWN = "UNKNOWN",
126
+ /** The sum of the charges is higher than the limit that you may charge the customer per billing cycle. */
135
127
  CHARGE_LIMIT_EXCEEDED = "CHARGE_LIMIT_EXCEEDED",
128
+ /** You can't provide more than 5 charges per invoice. */
136
129
  TOO_MANY_CHARGES = "TOO_MANY_CHARGES",
130
+ /** You must submit charges as whole numbers or use a dot to separate major and minor units. For example, `10` or `1.50`. Currently, Wix doesn't validate whether the submitted number of decimals for the minor unit is supported for the given currency. */
137
131
  INVALID_FORMAT = "INVALID_FORMAT"
138
132
  }
139
133
  interface ChargesRejectedResponse {
@@ -48,18 +48,13 @@ interface ListChargesRequest {
48
48
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
49
49
  */
50
50
  periodEnd?: Date | null;
51
- /**
52
- * Information about what Wix intends to do with the retrieved charges.
53
- *
54
- * + `"DISPLAY_ONLY"`: Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice.
55
- * + `"CREATE_INVOICE"`: Create an invoice for the customer.
56
- */
51
+ /** Information about what Wix intends to do with the retrieved charges. */
57
52
  intent?: Intent;
58
53
  }
59
54
  declare enum Intent {
60
- /** retrieving the current charges for display purposes only */
55
+ /** Inform the customer about how much your app would charge them at the moment. Wix doesn't create an invoice. */
61
56
  DISPLAY_ONLY = "DISPLAY_ONLY",
62
- /** retrieving the current charges with the intention of creating an invoice and billing the user */
57
+ /** Create an invoice for the customer. */
63
58
  CREATE_INVOICE = "CREATE_INVOICE"
64
59
  }
65
60
  interface ListChargesResponse {
@@ -121,19 +116,18 @@ interface ChargesRejectedRequest {
121
116
  /**
122
117
  * Information about why Wix has rejected your app's charges.
123
118
  *
124
- * + `"UNKNOWN_REASON"`: There is no information about why Wix has rejected the charges.
125
- * + `"CHARGE_LIMIT_EXCEEDED"`: The sum of the charges is higher than the limit that you may charge the customer per billing cycle.
126
- * + `"TOO_MANY_CHARGES"`: You can't provide more than 5 charges per invoice.
127
- * + `"INVALID_FORMAT"`: You must submit charges as whole numbers or use a dot to separate major and minor units. For example, `10` or `1.50`. Currently, Wix doesn't validate whether the submitted number of decimals for the minor unit is supported for the given currency.
128
- *
129
119
  * Max: 20 reasons
130
120
  */
131
121
  reasons?: ChargesRejectedReason[];
132
122
  }
133
123
  declare enum ChargesRejectedReason {
124
+ /** There is no information about why Wix has rejected the charges. */
134
125
  UNKNOWN = "UNKNOWN",
126
+ /** The sum of the charges is higher than the limit that you may charge the customer per billing cycle. */
135
127
  CHARGE_LIMIT_EXCEEDED = "CHARGE_LIMIT_EXCEEDED",
128
+ /** You can't provide more than 5 charges per invoice. */
136
129
  TOO_MANY_CHARGES = "TOO_MANY_CHARGES",
130
+ /** You must submit charges as whole numbers or use a dot to separate major and minor units. For example, `10` or `1.50`. Currently, Wix doesn't validate whether the submitted number of decimals for the minor unit is supported for the given currency. */
137
131
  INVALID_FORMAT = "INVALID_FORMAT"
138
132
  }
139
133
  interface ChargesRejectedResponse {