@wix/auto_sdk_app-management_app-plans 1.0.0 → 1.0.2

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 (33) hide show
  1. package/build/cjs/src/appmarket-v1-app-plans-app-plans.http.d.ts +2 -2
  2. package/build/cjs/src/appmarket-v1-app-plans-app-plans.http.js +2 -2
  3. package/build/cjs/src/appmarket-v1-app-plans-app-plans.public.d.ts +2 -2
  4. package/build/cjs/src/appmarket-v1-app-plans-app-plans.types.d.ts +52 -5
  5. package/build/cjs/src/appmarket-v1-app-plans-app-plans.types.js.map +1 -1
  6. package/build/cjs/src/appmarket-v1-app-plans-app-plans.universal.d.ts +54 -7
  7. package/build/cjs/src/appmarket-v1-app-plans-app-plans.universal.js +2 -2
  8. package/build/cjs/src/appmarket-v1-app-plans-app-plans.universal.js.map +1 -1
  9. package/build/es/src/appmarket-v1-app-plans-app-plans.http.d.ts +2 -2
  10. package/build/es/src/appmarket-v1-app-plans-app-plans.http.js +2 -2
  11. package/build/es/src/appmarket-v1-app-plans-app-plans.public.d.ts +2 -2
  12. package/build/es/src/appmarket-v1-app-plans-app-plans.types.d.ts +52 -5
  13. package/build/es/src/appmarket-v1-app-plans-app-plans.types.js.map +1 -1
  14. package/build/es/src/appmarket-v1-app-plans-app-plans.universal.d.ts +54 -7
  15. package/build/es/src/appmarket-v1-app-plans-app-plans.universal.js +2 -2
  16. package/build/es/src/appmarket-v1-app-plans-app-plans.universal.js.map +1 -1
  17. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.http.d.ts +2 -2
  18. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.http.js +2 -2
  19. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.public.d.ts +2 -2
  20. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.types.d.ts +52 -5
  21. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.types.js.map +1 -1
  22. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.d.ts +54 -7
  23. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.js +2 -2
  24. package/build/internal/cjs/src/appmarket-v1-app-plans-app-plans.universal.js.map +1 -1
  25. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.d.ts +2 -2
  26. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.http.js +2 -2
  27. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.public.d.ts +2 -2
  28. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.types.d.ts +52 -5
  29. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.types.js.map +1 -1
  30. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.d.ts +54 -7
  31. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.js +2 -2
  32. package/build/internal/es/src/appmarket-v1-app-plans-app-plans.universal.js.map +1 -1
  33. package/package.json +2 -2
@@ -13,11 +13,11 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
13
13
  * Prices for plans that are managed outside of Wix aren't returned.
14
14
  *
15
15
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
16
- * For these plans this endpoint returns the price that the consumer must pay every
16
+ * For these plans this method returns the price that the consumer must pay every
17
17
  * month and not the total price for the entire year.
18
18
  *
19
19
  * > **Notes:**
20
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 endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
21
+ * > - This method only returns app plans that have been activated.
22
22
  */
23
23
  export declare function listAppPlansByAppId(payload: object): RequestOptionsFactory<any>;
@@ -109,12 +109,12 @@ const PACKAGE_NAME = '@wix/auto_sdk_app-management_app-plans';
109
109
  * Prices for plans that are managed outside of Wix aren't returned.
110
110
  *
111
111
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
112
- * For these plans this endpoint returns the price that the consumer must pay every
112
+ * For these plans this method returns the price that the consumer must pay every
113
113
  * month and not the total price for the entire year.
114
114
  *
115
115
  * > **Notes:**
116
116
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
117
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
117
+ * > - This method only returns app plans that have been activated.
118
118
  */
119
119
  function listAppPlansByAppId(payload) {
120
120
  function __listAppPlansByAppId({ host }) {
@@ -19,12 +19,12 @@ interface ListAppPlansByAppIdSignature {
19
19
  * Prices for plans that are managed outside of Wix aren't returned.
20
20
  *
21
21
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
22
- * For these plans this endpoint returns the price that the consumer must pay every
22
+ * For these plans this method returns the price that the consumer must pay every
23
23
  * month and not the total price for the entire year.
24
24
  *
25
25
  * > **Notes:**
26
26
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
27
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
27
+ * > - This method only returns app plans that have been activated.
28
28
  * @param - List of app IDs to retrieve plans for.
29
29
  *
30
30
  * Min: 1 app ID
@@ -6,6 +6,7 @@ export interface AppPlans {
6
6
  *
7
7
  * Min: `0` plans
8
8
  * Max: `50` plans
9
+ * @maxSize 50
9
10
  */
10
11
  plans?: Plan[];
11
12
  }
@@ -33,6 +34,7 @@ export declare enum SourceType {
33
34
  APP_BENEFIT = "APP_BENEFIT"
34
35
  }
35
36
  export interface SaleSource {
37
+ /** @format GUID */
36
38
  saleId?: string | null;
37
39
  saleType?: SaleType;
38
40
  startDate?: Date | null;
@@ -78,6 +80,9 @@ export interface UsageBasedDetails {
78
80
  *
79
81
  * Min: `0.00`
80
82
  * Max: 1024 characters
83
+ * @format DECIMAL_VALUE
84
+ * @decimalValue options { gte:0.00 }
85
+ * @maxLength 1024
81
86
  */
82
87
  minimumChargeIncrement?: string | null;
83
88
  /**
@@ -86,6 +91,9 @@ export interface UsageBasedDetails {
86
91
  *
87
92
  * Min: `0.00`
88
93
  * Max: 1024 characters
94
+ * @format DECIMAL_VALUE
95
+ * @decimalValue options { gte:0.00 }
96
+ * @maxLength 1024
89
97
  */
90
98
  monthlyBaseFee?: string | null;
91
99
  /**
@@ -97,7 +105,12 @@ export interface UsageBasedDetails {
97
105
  }
98
106
  export interface Discount extends DiscountSourceDataOneOf {
99
107
  type?: DiscountType;
100
- /** Discount amount */
108
+ /**
109
+ * Discount amount
110
+ * @format DECIMAL_VALUE
111
+ * @decimalValue options { gte:0.00, maxScale:2 }
112
+ * @maxLength 1024
113
+ */
101
114
  amount?: string;
102
115
  /**
103
116
  * Price without taxes. For yearly plans, Wix calculates and returns the
@@ -105,12 +118,18 @@ export interface Discount extends DiscountSourceDataOneOf {
105
118
  * returned price with 12.
106
119
  * Min: `0.00`
107
120
  * Max: 1024 characters
121
+ * @format DECIMAL_VALUE
122
+ * @decimalValue options { gte:0.00, maxScale:2 }
123
+ * @maxLength 1024
108
124
  */
109
125
  priceBeforeTax?: string;
110
126
  /**
111
127
  * Total price including taxes.
112
128
  * Min: `0.00`
113
129
  * Max: 1024 characters
130
+ * @format DECIMAL_VALUE
131
+ * @decimalValue options { gte:0.00, maxScale:2 }
132
+ * @maxLength 1024
114
133
  */
115
134
  totalPrice?: string;
116
135
  }
@@ -132,6 +151,9 @@ export interface Price {
132
151
  *
133
152
  * Min: `0.00`
134
153
  * Max: 1024 characters
154
+ * @format DECIMAL_VALUE
155
+ * @decimalValue options { gte:0.00 }
156
+ * @maxLength 1024
135
157
  */
136
158
  priceBeforeTax?: string;
137
159
  /**
@@ -139,6 +161,9 @@ export interface Price {
139
161
  *
140
162
  * Min: `0.00`
141
163
  * Max: 1024 characters
164
+ * @format DECIMAL_VALUE
165
+ * @decimalValue options { gte:0.00 }
166
+ * @maxLength 1024
142
167
  */
143
168
  totalPrice?: string;
144
169
  /** Information about the plan's recurring billing cycle or single payment. */
@@ -151,12 +176,16 @@ export interface Price {
151
176
  usageBaseOptions?: UsageBasedDetails;
152
177
  discount?: Discount;
153
178
  billingSource?: BillingSource;
154
- /** Can be shown instead of plan price - used for dynamic plans */
179
+ /**
180
+ * Can be shown instead of plan price - used for dynamic plans
181
+ * @maxLength 140
182
+ */
155
183
  customPaymentTitle?: string | null;
156
184
  }
157
185
  export interface Plan {
158
186
  /**
159
187
  * ID of the app plan.
188
+ * @format GUID
160
189
  * @readonly
161
190
  */
162
191
  id?: string;
@@ -175,6 +204,8 @@ export interface Plan {
175
204
  * Min: `0` benefits
176
205
  * Max: `4` benefits
177
206
  * Max per benefit: 1024 characters
207
+ * @maxSize 4
208
+ * @maxLength 1024
178
209
  */
179
210
  benefits?: string[];
180
211
  /**
@@ -183,6 +214,7 @@ export interface Plan {
183
214
  *
184
215
  * Min: `0` prices
185
216
  * Max: `10` prices
217
+ * @maxSize 10
186
218
  */
187
219
  prices?: Price[];
188
220
  }
@@ -192,6 +224,8 @@ export interface ListAppPlansByAppIdRequest {
192
224
  *
193
225
  * Min: 1 app ID
194
226
  * Max: 100 app IDs
227
+ * @minSize 1
228
+ * @maxSize 100
195
229
  */
196
230
  appIds: string[];
197
231
  }
@@ -209,6 +243,7 @@ export interface ListAppPlansByAppIdResponse {
209
243
  * you pass in the call's header. If you don't pass a country code in the header,
210
244
  * Wix calculates the currency based on the caller's IP address. Note that the
211
245
  * currency may not resolve properly if you call through a VPN.
246
+ * @format CURRENCY
212
247
  */
213
248
  currency?: string;
214
249
  /**
@@ -227,6 +262,7 @@ export interface ListAppPlansByAppIdResponse {
227
262
  * Max: 50 plans
228
263
  *
229
264
  * If any plans aren't returned, it's likely because they haven't been activated yet.
265
+ * @maxSize 50
230
266
  */
231
267
  appPlans?: AppPlans[];
232
268
  }
@@ -239,6 +275,7 @@ export interface TaxSettings {
239
275
  /**
240
276
  * Tax rate for the given country as percentage. Returned as `0` when
241
277
  * `{"showPriceWithTax": false}`.
278
+ * @format DECIMAL_VALUE
242
279
  */
243
280
  percentage?: string | null;
244
281
  /**
@@ -256,7 +293,10 @@ export declare enum TaxType {
256
293
  GST = "GST"
257
294
  }
258
295
  export interface GetAvailableAppPlansRequest {
259
- /** AppId to get the available app plans for. */
296
+ /**
297
+ * AppId to get the available app plans for.
298
+ * @format GUID
299
+ */
260
300
  appId?: string;
261
301
  /** The specific app plan info to retrieve the available app plans for. */
262
302
  appPlanInfo?: AppPlanInfo;
@@ -270,6 +310,7 @@ export interface AppPlanInfo {
270
310
  * The app plan's vendorId to retrieve the response for.
271
311
  *
272
312
  * Max: 100 characters
313
+ * @maxLength 100
273
314
  */
274
315
  vendorId?: string;
275
316
  /** The app plan cycle to retrieve the response for. */
@@ -284,13 +325,19 @@ export interface GetAvailableAppPlansResponse {
284
325
  currentPlan?: Plan;
285
326
  }
286
327
  export interface GetPricingPageUrlRequest {
287
- /** AppId to get the pricing page url for. */
328
+ /**
329
+ * AppId to get the pricing page url for.
330
+ * @format GUID
331
+ */
288
332
  appId?: string;
289
333
  /** The specific app plan to retrieve the pricing page url for. */
290
334
  appPlanInfo?: AppPlanInfo;
291
335
  }
292
336
  export interface GetPricingPageUrlResponse {
293
- /** the pricing page url, if there is a app plan that is upgradable. */
337
+ /**
338
+ * the pricing page url, if there is a app plan that is upgradable.
339
+ * @format WEB_URL
340
+ */
294
341
  packagePickerUrl?: string | null;
295
342
  }
296
343
  interface TaxSettingsNonNullableFields {
@@ -1 +1 @@
1
- {"version":3,"file":"appmarket-v1-app-plans-app-plans.types.js","sourceRoot":"","sources":["../../../src/appmarket-v1-app-plans-app-plans.types.ts"],"names":[],"mappings":";;;AAYA,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;AAED,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;AAED,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;AAsBD,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;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AA2DD,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;AAqID,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB"}
1
+ {"version":3,"file":"appmarket-v1-app-plans-app-plans.types.js","sourceRoot":"","sources":["../../../src/appmarket-v1-app-plans-app-plans.types.ts"],"names":[],"mappings":";;;AAaA,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;AAED,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;AAED,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;AAuBD,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;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AA4ED,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;AAuJD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB"}
@@ -6,6 +6,7 @@ export interface AppPlans {
6
6
  *
7
7
  * Min: `0` plans
8
8
  * Max: `50` plans
9
+ * @maxSize 50
9
10
  */
10
11
  plans?: Plan[];
11
12
  }
@@ -33,6 +34,7 @@ export declare enum SourceType {
33
34
  APP_BENEFIT = "APP_BENEFIT"
34
35
  }
35
36
  export interface SaleSource {
37
+ /** @format GUID */
36
38
  saleId?: string | null;
37
39
  saleType?: SaleType;
38
40
  startDate?: Date | null;
@@ -78,6 +80,9 @@ export interface UsageBasedDetails {
78
80
  *
79
81
  * Min: `0.00`
80
82
  * Max: 1024 characters
83
+ * @format DECIMAL_VALUE
84
+ * @decimalValue options { gte:0.00 }
85
+ * @maxLength 1024
81
86
  */
82
87
  minimumChargeIncrement?: string | null;
83
88
  /**
@@ -86,6 +91,9 @@ export interface UsageBasedDetails {
86
91
  *
87
92
  * Min: `0.00`
88
93
  * Max: 1024 characters
94
+ * @format DECIMAL_VALUE
95
+ * @decimalValue options { gte:0.00 }
96
+ * @maxLength 1024
89
97
  */
90
98
  monthlyBaseFee?: string | null;
91
99
  /**
@@ -97,7 +105,12 @@ export interface UsageBasedDetails {
97
105
  }
98
106
  export interface Discount extends DiscountSourceDataOneOf {
99
107
  type?: DiscountType;
100
- /** Discount amount */
108
+ /**
109
+ * Discount amount
110
+ * @format DECIMAL_VALUE
111
+ * @decimalValue options { gte:0.00, maxScale:2 }
112
+ * @maxLength 1024
113
+ */
101
114
  amount?: string;
102
115
  /**
103
116
  * Price without taxes. For yearly plans, Wix calculates and returns the
@@ -105,12 +118,18 @@ export interface Discount extends DiscountSourceDataOneOf {
105
118
  * returned price with 12.
106
119
  * Min: `0.00`
107
120
  * Max: 1024 characters
121
+ * @format DECIMAL_VALUE
122
+ * @decimalValue options { gte:0.00, maxScale:2 }
123
+ * @maxLength 1024
108
124
  */
109
125
  priceBeforeTax?: string;
110
126
  /**
111
127
  * Total price including taxes.
112
128
  * Min: `0.00`
113
129
  * Max: 1024 characters
130
+ * @format DECIMAL_VALUE
131
+ * @decimalValue options { gte:0.00, maxScale:2 }
132
+ * @maxLength 1024
114
133
  */
115
134
  totalPrice?: string;
116
135
  }
@@ -132,6 +151,9 @@ export interface Price {
132
151
  *
133
152
  * Min: `0.00`
134
153
  * Max: 1024 characters
154
+ * @format DECIMAL_VALUE
155
+ * @decimalValue options { gte:0.00 }
156
+ * @maxLength 1024
135
157
  */
136
158
  priceBeforeTax?: string;
137
159
  /**
@@ -139,6 +161,9 @@ export interface Price {
139
161
  *
140
162
  * Min: `0.00`
141
163
  * Max: 1024 characters
164
+ * @format DECIMAL_VALUE
165
+ * @decimalValue options { gte:0.00 }
166
+ * @maxLength 1024
142
167
  */
143
168
  totalPrice?: string;
144
169
  /** Information about the plan's recurring billing cycle or single payment. */
@@ -151,12 +176,16 @@ export interface Price {
151
176
  usageBaseOptions?: UsageBasedDetails;
152
177
  discount?: Discount;
153
178
  billingSource?: BillingSource;
154
- /** Can be shown instead of plan price - used for dynamic plans */
179
+ /**
180
+ * Can be shown instead of plan price - used for dynamic plans
181
+ * @maxLength 140
182
+ */
155
183
  customPaymentTitle?: string | null;
156
184
  }
157
185
  export interface Plan {
158
186
  /**
159
187
  * ID of the app plan.
188
+ * @format GUID
160
189
  * @readonly
161
190
  */
162
191
  _id?: string;
@@ -175,6 +204,8 @@ export interface Plan {
175
204
  * Min: `0` benefits
176
205
  * Max: `4` benefits
177
206
  * Max per benefit: 1024 characters
207
+ * @maxSize 4
208
+ * @maxLength 1024
178
209
  */
179
210
  benefits?: string[];
180
211
  /**
@@ -183,6 +214,7 @@ export interface Plan {
183
214
  *
184
215
  * Min: `0` prices
185
216
  * Max: `10` prices
217
+ * @maxSize 10
186
218
  */
187
219
  prices?: Price[];
188
220
  }
@@ -192,6 +224,8 @@ export interface ListAppPlansByAppIdRequest {
192
224
  *
193
225
  * Min: 1 app ID
194
226
  * Max: 100 app IDs
227
+ * @minSize 1
228
+ * @maxSize 100
195
229
  */
196
230
  appIds: string[];
197
231
  }
@@ -209,6 +243,7 @@ export interface ListAppPlansByAppIdResponse {
209
243
  * you pass in the call's header. If you don't pass a country code in the header,
210
244
  * Wix calculates the currency based on the caller's IP address. Note that the
211
245
  * currency may not resolve properly if you call through a VPN.
246
+ * @format CURRENCY
212
247
  */
213
248
  currency?: string;
214
249
  /**
@@ -227,6 +262,7 @@ export interface ListAppPlansByAppIdResponse {
227
262
  * Max: 50 plans
228
263
  *
229
264
  * If any plans aren't returned, it's likely because they haven't been activated yet.
265
+ * @maxSize 50
230
266
  */
231
267
  appPlans?: AppPlans[];
232
268
  }
@@ -239,6 +275,7 @@ export interface TaxSettings {
239
275
  /**
240
276
  * Tax rate for the given country as percentage. Returned as `0` when
241
277
  * `{"showPriceWithTax": false}`.
278
+ * @format DECIMAL_VALUE
242
279
  */
243
280
  percentage?: string | null;
244
281
  /**
@@ -256,7 +293,10 @@ export declare enum TaxType {
256
293
  GST = "GST"
257
294
  }
258
295
  export interface GetAvailableAppPlansRequest {
259
- /** AppId to get the available app plans for. */
296
+ /**
297
+ * AppId to get the available app plans for.
298
+ * @format GUID
299
+ */
260
300
  appId?: string;
261
301
  /** The specific app plan info to retrieve the available app plans for. */
262
302
  appPlanInfo?: AppPlanInfo;
@@ -270,6 +310,7 @@ export interface AppPlanInfo {
270
310
  * The app plan's vendorId to retrieve the response for.
271
311
  *
272
312
  * Max: 100 characters
313
+ * @maxLength 100
273
314
  */
274
315
  vendorId?: string;
275
316
  /** The app plan cycle to retrieve the response for. */
@@ -284,13 +325,19 @@ export interface GetAvailableAppPlansResponse {
284
325
  currentPlan?: Plan;
285
326
  }
286
327
  export interface GetPricingPageUrlRequest {
287
- /** AppId to get the pricing page url for. */
328
+ /**
329
+ * AppId to get the pricing page url for.
330
+ * @format GUID
331
+ */
288
332
  appId?: string;
289
333
  /** The specific app plan to retrieve the pricing page url for. */
290
334
  appPlanInfo?: AppPlanInfo;
291
335
  }
292
336
  export interface GetPricingPageUrlResponse {
293
- /** the pricing page url, if there is a app plan that is upgradable. */
337
+ /**
338
+ * the pricing page url, if there is a app plan that is upgradable.
339
+ * @format WEB_URL
340
+ */
294
341
  packagePickerUrl?: string | null;
295
342
  }
296
343
  interface TaxSettingsNonNullableFields {
@@ -353,12 +400,12 @@ export interface ListAppPlansByAppIdResponseNonNullableFields {
353
400
  * Prices for plans that are managed outside of Wix aren't returned.
354
401
  *
355
402
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
356
- * For these plans this endpoint returns the price that the consumer must pay every
403
+ * For these plans this method returns the price that the consumer must pay every
357
404
  * month and not the total price for the entire year.
358
405
  *
359
406
  * > **Notes:**
360
407
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
361
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
408
+ * > - This method only returns app plans that have been activated.
362
409
  * @param appIds - List of app IDs to retrieve plans for.
363
410
  *
364
411
  * Min: 1 app ID
@@ -96,12 +96,12 @@ var TaxType;
96
96
  * Prices for plans that are managed outside of Wix aren't returned.
97
97
  *
98
98
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
99
- * For these plans this endpoint returns the price that the consumer must pay every
99
+ * For these plans this method returns the price that the consumer must pay every
100
100
  * month and not the total price for the entire year.
101
101
  *
102
102
  * > **Notes:**
103
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 endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
104
+ * > - This method only returns app plans that have been activated.
105
105
  * @param appIds - List of app IDs to retrieve plans for.
106
106
  *
107
107
  * Min: 1 app ID
@@ -1 +1 @@
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;AAc/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;AAED,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;AAED,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;AAsBD,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;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAgED,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;AAqID,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAsGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAIhB,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;AAnCD,kDAmCC"}
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;AAED,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;AAED,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;AAuBD,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;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAiFD,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;AAuJD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAgHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAIhB,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;AAnCD,kDAmCC"}
@@ -13,11 +13,11 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
13
13
  * Prices for plans that are managed outside of Wix aren't returned.
14
14
  *
15
15
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
16
- * For these plans this endpoint returns the price that the consumer must pay every
16
+ * For these plans this method returns the price that the consumer must pay every
17
17
  * month and not the total price for the entire year.
18
18
  *
19
19
  * > **Notes:**
20
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 endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
21
+ * > - This method only returns app plans that have been activated.
22
22
  */
23
23
  export declare function listAppPlansByAppId(payload: object): RequestOptionsFactory<any>;
@@ -106,12 +106,12 @@ const PACKAGE_NAME = '@wix/auto_sdk_app-management_app-plans';
106
106
  * Prices for plans that are managed outside of Wix aren't returned.
107
107
  *
108
108
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
109
- * For these plans this endpoint returns the price that the consumer must pay every
109
+ * For these plans this method returns the price that the consumer must pay every
110
110
  * month and not the total price for the entire year.
111
111
  *
112
112
  * > **Notes:**
113
113
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
114
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
114
+ * > - This method only returns app plans that have been activated.
115
115
  */
116
116
  export function listAppPlansByAppId(payload) {
117
117
  function __listAppPlansByAppId({ host }) {
@@ -19,12 +19,12 @@ interface ListAppPlansByAppIdSignature {
19
19
  * Prices for plans that are managed outside of Wix aren't returned.
20
20
  *
21
21
  * Consumers must pay for yearly and multi-yearly plans of your app every month.
22
- * For these plans this endpoint returns the price that the consumer must pay every
22
+ * For these plans this method returns the price that the consumer must pay every
23
23
  * month and not the total price for the entire year.
24
24
  *
25
25
  * > **Notes:**
26
26
  * > - The App Plans API doesn't follow any tenancy model. You don't need any permissions to call `List App Plans by App ID`.
27
- * > - This endpoint only returns app plans that have been activated. ([REST](https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/introduction#before-you-begin)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-plans/introduction)).
27
+ * > - This method only returns app plans that have been activated.
28
28
  * @param - List of app IDs to retrieve plans for.
29
29
  *
30
30
  * Min: 1 app ID