@wix/auto_sdk_app-management_app-plans 1.0.13 → 1.0.15

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.
Files changed (130) hide show
  1. package/build/{cjs/src/appmarket-v1-app-plans-app-plans.types.d.ts → appmarket-v1-app-plans-app-plans.universal-DIYQWTDw.d.mts} +34 -34
  2. package/build/{internal/cjs/src/appmarket-v1-app-plans-app-plans.types.d.ts → appmarket-v1-app-plans-app-plans.universal-DIYQWTDw.d.ts} +34 -34
  3. package/build/{cjs/src/appmarket-v1-app-plans-app-plans.public.d.ts → index.d.mts} +9 -7
  4. package/build/{es/src/appmarket-v1-app-plans-app-plans.public.d.ts → index.d.ts} +9 -7
  5. package/build/index.js +253 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +222 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/appmarket-v1-app-plans-app-plans.types.d.ts → internal/appmarket-v1-app-plans-app-plans.universal-BX_XsPPf.d.mts} +40 -33
  10. package/build/internal/{es/src/appmarket-v1-app-plans-app-plans.types.d.ts → appmarket-v1-app-plans-app-plans.universal-BX_XsPPf.d.ts} +40 -33
  11. package/build/internal/{cjs/src/appmarket-v1-app-plans-app-plans.public.d.ts → index.d.mts} +9 -7
  12. package/build/internal/{es/src/appmarket-v1-app-plans-app-plans.public.d.ts → index.d.ts} +9 -7
  13. package/build/internal/index.js +253 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +222 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +299 -0
  18. package/build/internal/meta.d.ts +299 -0
  19. package/build/internal/meta.js +173 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +146 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +299 -0
  24. package/build/meta.d.ts +299 -0
  25. package/build/meta.js +173 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +146 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/appmarket-v1-app-plans-app-plans.context.d.ts +0 -5
  40. package/build/cjs/src/appmarket-v1-app-plans-app-plans.context.js +0 -15
  41. package/build/cjs/src/appmarket-v1-app-plans-app-plans.context.js.map +0 -1
  42. package/build/cjs/src/appmarket-v1-app-plans-app-plans.http.d.ts +0 -23
  43. package/build/cjs/src/appmarket-v1-app-plans-app-plans.http.js +0 -147
  44. package/build/cjs/src/appmarket-v1-app-plans-app-plans.http.js.map +0 -1
  45. package/build/cjs/src/appmarket-v1-app-plans-app-plans.meta.d.ts +0 -15
  46. package/build/cjs/src/appmarket-v1-app-plans-app-plans.meta.js +0 -47
  47. package/build/cjs/src/appmarket-v1-app-plans-app-plans.meta.js.map +0 -1
  48. package/build/cjs/src/appmarket-v1-app-plans-app-plans.public.js +0 -20
  49. package/build/cjs/src/appmarket-v1-app-plans-app-plans.public.js.map +0 -1
  50. package/build/cjs/src/appmarket-v1-app-plans-app-plans.types.js +0 -59
  51. package/build/cjs/src/appmarket-v1-app-plans-app-plans.types.js.map +0 -1
  52. package/build/cjs/src/appmarket-v1-app-plans-app-plans.universal.d.ts +0 -391
  53. package/build/cjs/src/appmarket-v1-app-plans-app-plans.universal.js +0 -136
  54. package/build/cjs/src/appmarket-v1-app-plans-app-plans.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/appmarket-v1-app-plans-app-plans.context.d.ts +0 -5
  66. package/build/es/src/appmarket-v1-app-plans-app-plans.context.js +0 -5
  67. package/build/es/src/appmarket-v1-app-plans-app-plans.context.js.map +0 -1
  68. package/build/es/src/appmarket-v1-app-plans-app-plans.http.d.ts +0 -23
  69. package/build/es/src/appmarket-v1-app-plans-app-plans.http.js +0 -143
  70. package/build/es/src/appmarket-v1-app-plans-app-plans.http.js.map +0 -1
  71. package/build/es/src/appmarket-v1-app-plans-app-plans.meta.d.ts +0 -15
  72. package/build/es/src/appmarket-v1-app-plans-app-plans.meta.js +0 -20
  73. package/build/es/src/appmarket-v1-app-plans-app-plans.meta.js.map +0 -1
  74. package/build/es/src/appmarket-v1-app-plans-app-plans.public.js +0 -9
  75. package/build/es/src/appmarket-v1-app-plans-app-plans.public.js.map +0 -1
  76. package/build/es/src/appmarket-v1-app-plans-app-plans.types.js +0 -56
  77. package/build/es/src/appmarket-v1-app-plans-app-plans.types.js.map +0 -1
  78. package/build/es/src/appmarket-v1-app-plans-app-plans.universal.d.ts +0 -391
  79. package/build/es/src/appmarket-v1-app-plans-app-plans.universal.js +0 -109
  80. package/build/es/src/appmarket-v1-app-plans-app-plans.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.context.d.ts +0 -5
  91. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.context.js +0 -15
  92. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.context.js.map +0 -1
  93. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.http.d.ts +0 -23
  94. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.http.js +0 -147
  95. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.http.js.map +0 -1
  96. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.meta.d.ts +0 -15
  97. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.meta.js +0 -47
  98. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.meta.js.map +0 -1
  99. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.public.js +0 -20
  100. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.public.js.map +0 -1
  101. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.types.js +0 -59
  102. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.types.js.map +0 -1
  103. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.d.ts +0 -396
  104. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.js +0 -136
  105. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.context.d.ts +0 -5
  116. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.context.js +0 -5
  117. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.context.js.map +0 -1
  118. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.d.ts +0 -23
  119. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.js +0 -143
  120. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.js.map +0 -1
  121. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.meta.d.ts +0 -15
  122. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.meta.js +0 -20
  123. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.meta.js.map +0 -1
  124. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.public.js +0 -9
  125. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.public.js.map +0 -1
  126. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.types.js +0 -56
  127. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.types.js.map +0 -1
  128. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.d.ts +0 -396
  129. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.js +0 -109
  130. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.js.map +0 -1
@@ -1,391 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface AppPlans {
3
- /** App ID, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view). */
4
- _id?: string;
5
- /**
6
- * List of the app's pricing plans.
7
- *
8
- * Min: `0` plans
9
- * Max: `50` plans
10
- * @maxSize 50
11
- */
12
- plans?: Plan[];
13
- }
14
- export declare enum SaleType {
15
- /** Default value, can be used when no specific sale is associated. */
16
- SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
17
- CYBER_MONDAY = "CYBER_MONDAY",
18
- NOVEMBER_SALE = "NOVEMBER_SALE",
19
- BLACK_FRIDAY = "BLACK_FRIDAY",
20
- DEVELOPER_SALE = "DEVELOPER_SALE"
21
- }
22
- /** @enumType */
23
- export type SaleTypeWithLiterals = SaleType | 'SALE_TYPE_UNSPECIFIED' | 'CYBER_MONDAY' | 'NOVEMBER_SALE' | 'BLACK_FRIDAY' | 'DEVELOPER_SALE';
24
- export declare enum DiscountType {
25
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
26
- /** Discount is a fixed amount in USD. */
27
- FIXED_AMOUNT = "FIXED_AMOUNT",
28
- /** Discount is a percentage of the total price. */
29
- PERCENTAGE = "PERCENTAGE"
30
- }
31
- /** @enumType */
32
- export type DiscountTypeWithLiterals = DiscountType | 'DISCOUNT_TYPE_UNSPECIFIED' | 'FIXED_AMOUNT' | 'PERCENTAGE';
33
- export declare enum SourceType {
34
- /** Default value, can be used when no specific source is associated. */
35
- SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
36
- /** Discount is due to Wix/Developer Sale */
37
- SALE = "SALE",
38
- /** Discount is due to App Benefit */
39
- APP_BENEFIT = "APP_BENEFIT"
40
- }
41
- /** @enumType */
42
- export type SourceTypeWithLiterals = SourceType | 'SOURCE_TYPE_UNSPECIFIED' | 'SALE' | 'APP_BENEFIT';
43
- export interface SaleSource {
44
- /** @format GUID */
45
- saleId?: string | null;
46
- saleType?: SaleTypeWithLiterals;
47
- startDate?: Date | null;
48
- endDate?: Date | null;
49
- }
50
- export interface Cycle {
51
- /**
52
- * Type of the billing cycle.
53
- *
54
- * + `"UNKNOWN_UNIT"`: There is no information about the billing cycle.
55
- * + `"ONE_TIME"`: The customer pays for unlimited usage of the app with a single payment.
56
- * + `"RECURRING"`: The customer pays for a subscription to the app on a recurring schedule.
57
- */
58
- cycleType?: CycleTypeWithLiterals;
59
- /** Duration of the billing cycle. Available only for `{"cycleType": "RECURRING"}`. */
60
- cycleDuration?: Duration;
61
- }
62
- export declare enum DurationUnit {
63
- /** unknown interval unit */
64
- UNKNOWN_UNIT = "UNKNOWN_UNIT",
65
- /** month */
66
- MONTH = "MONTH",
67
- /** year */
68
- YEAR = "YEAR"
69
- }
70
- /** @enumType */
71
- export type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_UNIT' | 'MONTH' | 'YEAR';
72
- export declare enum CycleType {
73
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
74
- ONE_TIME = "ONE_TIME",
75
- RECURRING = "RECURRING"
76
- }
77
- /** @enumType */
78
- export type CycleTypeWithLiterals = CycleType | 'UNKNOWN_TYPE' | 'ONE_TIME' | 'RECURRING';
79
- export interface Duration {
80
- /** Unit of the billing cycle. */
81
- unit?: DurationUnitWithLiterals;
82
- /** Count of units that make up the billing cycle. */
83
- count?: number;
84
- }
85
- export interface UsageBasedDetails {
86
- /**
87
- * Smallest possible amount that your app charges customers in usage-based
88
- * pricing. For example, the price of a single SMS message if your
89
- * app charges customers for sending text messages. Always in
90
- * [USD](https://en.wikipedia.org/wiki/United_States_dollar).
91
- *
92
- * Min: `0.00`
93
- * Max: 1024 characters
94
- * @format DECIMAL_VALUE
95
- * @decimalValue options { gte:0.00 }
96
- * @maxLength 1024
97
- */
98
- minimumChargeIncrement?: string | null;
99
- /**
100
- * Recurring, monthly base fee in usage-based pricing that your app
101
- * charges customers regardless of how much they use your app.
102
- *
103
- * Min: `0.00`
104
- * Max: 1024 characters
105
- * @format DECIMAL_VALUE
106
- * @decimalValue options { gte:0.00 }
107
- * @maxLength 1024
108
- */
109
- monthlyBaseFee?: string | null;
110
- /**
111
- * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
112
- *
113
- * Max: 1024 characters
114
- */
115
- customChargeDescription?: string | null;
116
- }
117
- export interface Discount extends DiscountSourceDataOneOf {
118
- type?: DiscountTypeWithLiterals;
119
- /**
120
- * Discount amount
121
- * @format DECIMAL_VALUE
122
- * @decimalValue options { gte:0.00, maxScale:2 }
123
- * @maxLength 1024
124
- */
125
- amount?: string;
126
- /**
127
- * Price without taxes. For yearly plans, Wix calculates and returns the
128
- * average price per month. You can get the full price by multiplying the
129
- * returned price with 12.
130
- * Min: `0.00`
131
- * Max: 1024 characters
132
- * @format DECIMAL_VALUE
133
- * @decimalValue options { gte:0.00, maxScale:2 }
134
- * @maxLength 1024
135
- */
136
- priceBeforeTax?: string;
137
- /**
138
- * Total price including taxes.
139
- * Min: `0.00`
140
- * Max: 1024 characters
141
- * @format DECIMAL_VALUE
142
- * @decimalValue options { gte:0.00, maxScale:2 }
143
- * @maxLength 1024
144
- */
145
- totalPrice?: string;
146
- }
147
- /** @oneof */
148
- export interface DiscountSourceDataOneOf {
149
- }
150
- export declare enum BillingSource {
151
- UNKNOWN = "UNKNOWN",
152
- /** plan billing and charges is managed by Wix */
153
- WIX = "WIX",
154
- /** plan billing and charges is managed by the app */
155
- EXTERNAL = "EXTERNAL"
156
- }
157
- /** @enumType */
158
- export type BillingSourceWithLiterals = BillingSource | 'UNKNOWN' | 'WIX' | 'EXTERNAL';
159
- export interface Price {
160
- /**
161
- * Price without taxes. For yearly plans, Wix calculates and returns the
162
- * average price per month. You can get the full price by multiplying the
163
- * returned price by 12.
164
- *
165
- * Min: `0.00`
166
- * Max: 1024 characters
167
- * @format DECIMAL_VALUE
168
- * @decimalValue options { gte:0.00 }
169
- * @maxLength 1024
170
- */
171
- priceBeforeTax?: string;
172
- /**
173
- * Total price including taxes.
174
- *
175
- * Min: `0.00`
176
- * Max: 1024 characters
177
- * @format DECIMAL_VALUE
178
- * @decimalValue options { gte:0.00 }
179
- * @maxLength 1024
180
- */
181
- totalPrice?: string;
182
- /** Information about the plan's recurring billing cycle or single payment. */
183
- billingCycle?: Cycle;
184
- /**
185
- * Details about the plan's usage-based pricing.
186
- * Available only for plans with
187
- * [usage-based pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/usage-based-pricing).
188
- */
189
- usageBaseOptions?: UsageBasedDetails;
190
- discount?: Discount;
191
- billingSource?: BillingSourceWithLiterals;
192
- /**
193
- * Can be shown instead of plan price - used for dynamic plans
194
- * @maxLength 140
195
- */
196
- customPaymentTitle?: string | null;
197
- }
198
- export interface Plan {
199
- /**
200
- * ID of the app plan.
201
- * @format GUID
202
- * @readonly
203
- */
204
- _id?: string;
205
- /**
206
- * ID of your app's pricing plan, as displayed in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
207
- * Identical to `vendorProductId` in the
208
- * [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
209
- */
210
- vendorId?: string;
211
- /** Name of your app's pricing plan, as defined by you in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view). */
212
- name?: string;
213
- /**
214
- * List of your plan's benefits, as defined by you in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
215
- * Currently, the benefits are available only in English.
216
- *
217
- * Min: `0` benefits
218
- * Max: `4` benefits
219
- * Max per benefit: 1024 characters
220
- * @maxSize 4
221
- * @maxLength 1024
222
- */
223
- benefits?: string[];
224
- /**
225
- * List of the plan's prices. Available only when the plan's prices are managed
226
- * by Wix and not externally.
227
- *
228
- * Min: `0` prices
229
- * Max: `10` prices
230
- * @maxSize 10
231
- */
232
- prices?: Price[];
233
- }
234
- export interface ListAppPlansByAppIdRequest {
235
- /**
236
- * List of app IDs to retrieve plans for.
237
- *
238
- * Min: 1 app ID
239
- * Max: 100 app IDs
240
- * @minSize 1
241
- * @maxSize 100
242
- */
243
- appIds: string[];
244
- }
245
- export interface ListAppPlansByAppIdResponse {
246
- /**
247
- * Tax settings. Wix calculates the tax settings based on the country code that
248
- * you pass in the call's header. If you don't pass a country code in the header,
249
- * Wix calculates the tax settings based on the caller's IP address. Note that the
250
- * tax settings may not resolve properly if you call through a VPN.
251
- */
252
- taxSettings?: TaxSettings;
253
- /**
254
- * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
255
- * format. Wix calculates the currency based on the country code that
256
- * you pass in the call's header. If you don't pass a country code in the header,
257
- * Wix calculates the currency based on the caller's IP address. Note that the
258
- * currency may not resolve properly if you call through a VPN.
259
- * @format CURRENCY
260
- */
261
- currency?: string;
262
- /**
263
- * Currency symbol in decimal HTML entity format. For example, `$` for $
264
- * (United States Dollar). Wix calculates the currency symbol based on the
265
- * country code that you pass in the call's header. If you don't pass a country
266
- * code in the header, Wix calculates the tax settings based on the caller's IP
267
- * address. Note that the currency symbol may not resolve properly if you call
268
- * through a VPN.
269
- */
270
- currencySymbol?: string;
271
- /**
272
- * Retrieved app plans.
273
- *
274
- * Min: 0 plans
275
- * Max: 50 plans
276
- *
277
- * If any plans aren't returned, it's likely because they haven't been activated yet.
278
- * @maxSize 50
279
- */
280
- appPlans?: AppPlans[];
281
- }
282
- export interface TaxSettings {
283
- /**
284
- * Whether you must display the total price including taxes in the given
285
- * country.
286
- */
287
- showPriceWithTax?: boolean;
288
- /**
289
- * Tax rate for the given country as percentage. Returned as `0` when
290
- * `{"showPriceWithTax": false}`.
291
- * @format DECIMAL_VALUE
292
- */
293
- percentage?: string | null;
294
- /**
295
- * Type of tax required in the given country.
296
- *
297
- * + `"NOT_APPLICABLE"`: The country doesn't require that you display the total price including taxes, or Wix failed to calculate the country based on the call's IP address.
298
- * + `"VAT"`: The given country requires that you display the total price including [value-added tax (VAT)](https://en.wikipedia.org/wiki/Value-added_tax).
299
- * + `"GST"`: The given country requires that you display the total price including [generation-skipping transfer tax (GST)](https://en.wikipedia.org/wiki/Generation-skipping_transfer_tax).
300
- */
301
- taxType?: TaxTypeWithLiterals;
302
- }
303
- export declare enum TaxType {
304
- NOT_APPLICABLE = "NOT_APPLICABLE",
305
- VAT = "VAT",
306
- GST = "GST"
307
- }
308
- /** @enumType */
309
- export type TaxTypeWithLiterals = TaxType | 'NOT_APPLICABLE' | 'VAT' | 'GST';
310
- export interface GetAvailableAppPlansRequest {
311
- /**
312
- * AppId to get the available app plans for.
313
- * @format GUID
314
- */
315
- appId?: string;
316
- /** The specific app plan info to retrieve the available app plans for. */
317
- appPlanInfo?: AppPlanInfo;
318
- }
319
- /**
320
- * An `AppPlanInfo` object describes which app plan you want to retrieve data for.
321
- * Every plan in an app is identified by a unique combination of `productId` and `billingCycle`.
322
- */
323
- export interface AppPlanInfo {
324
- /**
325
- * The app plan's vendorId to retrieve the response for.
326
- *
327
- * Max: 100 characters
328
- * @maxLength 100
329
- */
330
- vendorId?: string;
331
- /** The app plan cycle to retrieve the response for. */
332
- billingCycle?: Cycle;
333
- }
334
- export interface GetAvailableAppPlansResponse {
335
- /** The available upgrades for the given app plan. */
336
- availableUpgrades?: AppPlans;
337
- /** The available downgrades for the given app plan. */
338
- availableDowngrades?: AppPlans;
339
- /** The current app plan. */
340
- currentPlan?: Plan;
341
- }
342
- export interface GetPricingPageUrlRequest {
343
- /**
344
- * AppId to get the pricing page url for.
345
- * @format GUID
346
- */
347
- appId?: string;
348
- /** The specific app plan to retrieve the pricing page url for. */
349
- appPlanInfo?: AppPlanInfo;
350
- }
351
- export interface GetPricingPageUrlResponse {
352
- /**
353
- * the pricing page url, if there is a app plan that is upgradable.
354
- * @format WEB_URL
355
- */
356
- packagePickerUrl?: string | null;
357
- }
358
- type AppPlansNonNullablePaths = `_id` | `plans` | `plans.${number}._id` | `plans.${number}.vendorId` | `plans.${number}.name`;
359
- /**
360
- * Retrieves plans for the given apps.
361
- *
362
- *
363
- * Also returns tax settings and currency details. Wix calculates this information
364
- * based on the 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
365
- * format that you pass in the call's header. If you don't pass a country code in
366
- * the header, Wix calculates the tax settings and currency details based on the
367
- * call's IP address. Note that the tax settings and currency details may not resolve
368
- * properly if you call through a VPN.
369
- *
370
- * Prices for plans that are managed outside of Wix aren't returned.
371
- *
372
- * Consumers must pay for yearly and multi-yearly plans of your app every month.
373
- * For these plans this method returns the price that the consumer must pay every
374
- * month and not the total price for the entire year.
375
- *
376
- * > **Notes:**
377
- * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
378
- * > - This method only returns app plans that have been activated.
379
- * @param appIds - List of app IDs to retrieve plans for.
380
- *
381
- * Min: 1 app ID
382
- * Max: 100 app IDs
383
- * @public
384
- * @documentationMaturity preview
385
- * @requiredField appIds
386
- * @fqn wix.appmarket.app_plans.v1.AppsPlans.ListAppPlansByAppId
387
- */
388
- export declare function listAppPlansByAppId(appIds: string[]): Promise<NonNullablePaths<ListAppPlansByAppIdResponse, `taxSettings.showPriceWithTax` | `taxSettings.taxType` | `currency` | `currencySymbol` | {
389
- [P in AppPlansNonNullablePaths]: `appPlans.${number}.${P}`;
390
- }[AppPlansNonNullablePaths]>>;
391
- export {};
@@ -1,136 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.listAppPlansByAppId = exports.TaxType = exports.BillingSource = exports.CycleType = exports.DurationUnit = exports.SourceType = exports.DiscountType = exports.SaleType = void 0;
27
- const transform_error_1 = require("@wix/sdk-runtime/transform-error");
28
- const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
29
- const ambassadorWixAppmarketV1AppPlans = __importStar(require("./appmarket-v1-app-plans-app-plans.http.js"));
30
- var SaleType;
31
- (function (SaleType) {
32
- /** Default value, can be used when no specific sale is associated. */
33
- SaleType["SALE_TYPE_UNSPECIFIED"] = "SALE_TYPE_UNSPECIFIED";
34
- SaleType["CYBER_MONDAY"] = "CYBER_MONDAY";
35
- SaleType["NOVEMBER_SALE"] = "NOVEMBER_SALE";
36
- SaleType["BLACK_FRIDAY"] = "BLACK_FRIDAY";
37
- SaleType["DEVELOPER_SALE"] = "DEVELOPER_SALE";
38
- })(SaleType || (exports.SaleType = SaleType = {}));
39
- var DiscountType;
40
- (function (DiscountType) {
41
- DiscountType["DISCOUNT_TYPE_UNSPECIFIED"] = "DISCOUNT_TYPE_UNSPECIFIED";
42
- /** Discount is a fixed amount in USD. */
43
- DiscountType["FIXED_AMOUNT"] = "FIXED_AMOUNT";
44
- /** Discount is a percentage of the total price. */
45
- DiscountType["PERCENTAGE"] = "PERCENTAGE";
46
- })(DiscountType || (exports.DiscountType = DiscountType = {}));
47
- var SourceType;
48
- (function (SourceType) {
49
- /** Default value, can be used when no specific source is associated. */
50
- SourceType["SOURCE_TYPE_UNSPECIFIED"] = "SOURCE_TYPE_UNSPECIFIED";
51
- /** Discount is due to Wix/Developer Sale */
52
- SourceType["SALE"] = "SALE";
53
- /** Discount is due to App Benefit */
54
- SourceType["APP_BENEFIT"] = "APP_BENEFIT";
55
- })(SourceType || (exports.SourceType = SourceType = {}));
56
- var DurationUnit;
57
- (function (DurationUnit) {
58
- /** unknown interval unit */
59
- DurationUnit["UNKNOWN_UNIT"] = "UNKNOWN_UNIT";
60
- /** month */
61
- DurationUnit["MONTH"] = "MONTH";
62
- /** year */
63
- DurationUnit["YEAR"] = "YEAR";
64
- })(DurationUnit || (exports.DurationUnit = DurationUnit = {}));
65
- var CycleType;
66
- (function (CycleType) {
67
- CycleType["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
68
- CycleType["ONE_TIME"] = "ONE_TIME";
69
- CycleType["RECURRING"] = "RECURRING";
70
- })(CycleType || (exports.CycleType = CycleType = {}));
71
- var BillingSource;
72
- (function (BillingSource) {
73
- BillingSource["UNKNOWN"] = "UNKNOWN";
74
- /** plan billing and charges is managed by Wix */
75
- BillingSource["WIX"] = "WIX";
76
- /** plan billing and charges is managed by the app */
77
- BillingSource["EXTERNAL"] = "EXTERNAL";
78
- })(BillingSource || (exports.BillingSource = BillingSource = {}));
79
- var TaxType;
80
- (function (TaxType) {
81
- TaxType["NOT_APPLICABLE"] = "NOT_APPLICABLE";
82
- TaxType["VAT"] = "VAT";
83
- TaxType["GST"] = "GST";
84
- })(TaxType || (exports.TaxType = TaxType = {}));
85
- /**
86
- * Retrieves plans for the given apps.
87
- *
88
- *
89
- * Also returns tax settings and currency details. Wix calculates this information
90
- * based on the 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
91
- * format that you pass in the call's header. If you don't pass a country code in
92
- * the header, Wix calculates the tax settings and currency details based on the
93
- * call's IP address. Note that the tax settings and currency details may not resolve
94
- * properly if you call through a VPN.
95
- *
96
- * Prices for plans that are managed outside of Wix aren't returned.
97
- *
98
- * Consumers must pay for yearly and multi-yearly plans of your app every month.
99
- * For these plans this method returns the price that the consumer must pay every
100
- * month and not the total price for the entire year.
101
- *
102
- * > **Notes:**
103
- * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
104
- * > - This method only returns app plans that have been activated.
105
- * @param appIds - List of app IDs to retrieve plans for.
106
- *
107
- * Min: 1 app ID
108
- * Max: 100 app IDs
109
- * @public
110
- * @documentationMaturity preview
111
- * @requiredField appIds
112
- * @fqn wix.appmarket.app_plans.v1.AppsPlans.ListAppPlansByAppId
113
- */
114
- async function listAppPlansByAppId(appIds) {
115
- // @ts-ignore
116
- const { httpClient, sideEffects } = arguments[1];
117
- const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({ appIds: appIds });
118
- const reqOpts = ambassadorWixAppmarketV1AppPlans.listAppPlansByAppId(payload);
119
- sideEffects?.onSiteCall?.();
120
- try {
121
- const result = await httpClient.request(reqOpts);
122
- sideEffects?.onSuccess?.(result);
123
- return (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(result.data);
124
- }
125
- catch (err) {
126
- const transformedError = (0, transform_error_1.transformError)(err, {
127
- spreadPathsToArguments: {},
128
- explicitPathsToArguments: { appIds: '$[0]' },
129
- singleArgumentUnchanged: false,
130
- }, ['appIds']);
131
- sideEffects?.onError?.(err);
132
- throw transformedError;
133
- }
134
- }
135
- exports.listAppPlansByAppId = listAppPlansByAppId;
136
- //# sourceMappingURL=appmarket-v1-app-plans-app-plans.universal.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"appmarket-v1-app-plans-app-plans.universal.js","sourceRoot":"","sources":["../../../src/appmarket-v1-app-plans-app-plans.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,6GAA+F;AAe/F,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,2DAA+C,CAAA;IAC/C,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAWD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AASD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA8BD,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AASD,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAwFD,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,6BAAb,aAAa,QAMxB;AA8JD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAiED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAahB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1E,MAAM,OAAO,GAAG,gCAAgC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;YAC5C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA5CD,kDA4CC"}
@@ -1 +0,0 @@
1
- export * from './src/appmarket-v1-app-plans-app-plans.context.js';
package/build/es/index.js DELETED
@@ -1,2 +0,0 @@
1
- export * from './src/appmarket-v1-app-plans-app-plans.context.js';
2
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,mDAAmD,CAAC"}
@@ -1 +0,0 @@
1
- export * from './src/appmarket-v1-app-plans-app-plans.universal.js';
@@ -1,2 +0,0 @@
1
- export * from './src/appmarket-v1-app-plans-app-plans.universal.js';
2
- //# sourceMappingURL=index.typings.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":"AAAA,cAAc,qDAAqD,CAAC"}
@@ -1 +0,0 @@
1
- export * from './src/appmarket-v1-app-plans-app-plans.meta.js';
package/build/es/meta.js DELETED
@@ -1,2 +0,0 @@
1
- export * from './src/appmarket-v1-app-plans-app-plans.meta.js';
2
- //# sourceMappingURL=meta.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,cAAc,gDAAgD,CAAC"}
@@ -1,3 +0,0 @@
1
- {
2
- "type": "module"
3
- }
@@ -1,5 +0,0 @@
1
- import { listAppPlansByAppId as publicListAppPlansByAppId } from './appmarket-v1-app-plans-app-plans.public.js';
2
- import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
3
- export declare const listAppPlansByAppId: MaybeContext<BuildRESTFunction<typeof publicListAppPlansByAppId> & typeof publicListAppPlansByAppId>;
4
- export { SaleType, DiscountType, SourceType, DurationUnit, CycleType, BillingSource, TaxType, } from './appmarket-v1-app-plans-app-plans.universal.js';
5
- export { AppPlans, SaleSource, Cycle, Duration, UsageBasedDetails, Discount, DiscountSourceDataOneOf, Price, Plan, ListAppPlansByAppIdRequest, ListAppPlansByAppIdResponse, TaxSettings, GetAvailableAppPlansRequest, AppPlanInfo, GetAvailableAppPlansResponse, GetPricingPageUrlRequest, GetPricingPageUrlResponse, } from './appmarket-v1-app-plans-app-plans.universal.js';
@@ -1,5 +0,0 @@
1
- import { listAppPlansByAppId as publicListAppPlansByAppId } from './appmarket-v1-app-plans-app-plans.public.js';
2
- import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
3
- export const listAppPlansByAppId = /*#__PURE__*/ createRESTModule(publicListAppPlansByAppId);
4
- export { SaleType, DiscountType, SourceType, DurationUnit, CycleType, BillingSource, TaxType, } from './appmarket-v1-app-plans-app-plans.universal.js';
5
- //# sourceMappingURL=appmarket-v1-app-plans-app-plans.context.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"appmarket-v1-app-plans-app-plans.context.js","sourceRoot":"","sources":["../../../src/appmarket-v1-app-plans-app-plans.context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,IAAI,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AAChH,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGjE,MAAM,CAAC,MAAM,mBAAmB,GAG5B,aAAa,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;AAE9D,OAAO,EACL,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACb,OAAO,GACR,MAAM,iDAAiD,CAAC"}
@@ -1,23 +0,0 @@
1
- import { RequestOptionsFactory } from '@wix/sdk-types';
2
- /**
3
- * Retrieves plans for the given apps.
4
- *
5
- *
6
- * Also returns tax settings and currency details. Wix calculates this information
7
- * based on the 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
8
- * format that you pass in the call's header. If you don't pass a country code in
9
- * the header, Wix calculates the tax settings and currency details based on the
10
- * call's IP address. Note that the tax settings and currency details may not resolve
11
- * properly if you call through a VPN.
12
- *
13
- * Prices for plans that are managed outside of Wix aren't returned.
14
- *
15
- * Consumers must pay for yearly and multi-yearly plans of your app every month.
16
- * For these plans this method returns the price that the consumer must pay every
17
- * month and not the total price for the entire year.
18
- *
19
- * > **Notes:**
20
- * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
21
- * > - This method only returns app plans that have been activated.
22
- */
23
- export declare function listAppPlansByAppId(payload: object): RequestOptionsFactory<any>;