@wix/auto_sdk_app-management_app-plans 1.0.1 → 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.
@@ -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.universal.js","sourceRoot":"","sources":["../../../src/appmarket-v1-app-plans-app-plans.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,gCAAgC,MAAM,4CAA4C,CAAC;AAc/F,MAAM,CAAN,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,KAAR,QAAQ,QAOnB;AAED,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAsBD,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAgED,MAAM,CAAN,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,KAAb,aAAa,QAMxB;AAqID,MAAM,CAAN,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,KAAP,OAAO,QAIlB;AAsGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAIhB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,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,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,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"}
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,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,gCAAgC,MAAM,4CAA4C,CAAC;AAe/F,MAAM,CAAN,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,KAAR,QAAQ,QAOnB;AAED,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,yCAAyC;IACzC,6CAA6B,CAAA;IAC7B,mDAAmD;IACnD,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,wEAAwE;IACxE,iEAAmD,CAAA;IACnD,4CAA4C;IAC5C,2BAAa,CAAA;IACb,qCAAqC;IACrC,yCAA2B,CAAA;AAC7B,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAuBD,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,6CAA6B,CAAA;IAC7B,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,kCAAqB,CAAA;IACrB,oCAAuB,CAAA;AACzB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAiFD,MAAM,CAAN,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,iDAAiD;IACjD,4BAAW,CAAA;IACX,qDAAqD;IACrD,sCAAqB,CAAA;AACvB,CAAC,EANW,aAAa,KAAb,aAAa,QAMxB;AAuJD,MAAM,CAAN,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;IACX,sBAAW,CAAA;AACb,CAAC,EAJW,OAAO,KAAP,OAAO,QAIlB;AAgHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,MAAgB;IAIhB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,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,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,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"}
@@ -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
  /**
@@ -137,6 +156,9 @@ export interface Price {
137
156
  *
138
157
  * Min: `0.00`
139
158
  * Max: 1024 characters
159
+ * @format DECIMAL_VALUE
160
+ * @decimalValue options { gte:0.00 }
161
+ * @maxLength 1024
140
162
  */
141
163
  priceBeforeTax?: string;
142
164
  /**
@@ -144,6 +166,9 @@ export interface Price {
144
166
  *
145
167
  * Min: `0.00`
146
168
  * Max: 1024 characters
169
+ * @format DECIMAL_VALUE
170
+ * @decimalValue options { gte:0.00 }
171
+ * @maxLength 1024
147
172
  */
148
173
  totalPrice?: string;
149
174
  /** Information about the plan's recurring billing cycle or single payment. */
@@ -156,12 +181,16 @@ export interface Price {
156
181
  usageBaseOptions?: UsageBasedDetails;
157
182
  discount?: Discount;
158
183
  billingSource?: BillingSource;
159
- /** Can be shown instead of plan price - used for dynamic plans */
184
+ /**
185
+ * Can be shown instead of plan price - used for dynamic plans
186
+ * @maxLength 140
187
+ */
160
188
  customPaymentTitle?: string | null;
161
189
  }
162
190
  export interface Plan {
163
191
  /**
164
192
  * ID of the app plan.
193
+ * @format GUID
165
194
  * @readonly
166
195
  */
167
196
  _id?: string;
@@ -180,6 +209,8 @@ export interface Plan {
180
209
  * Min: `0` benefits
181
210
  * Max: `4` benefits
182
211
  * Max per benefit: 1024 characters
212
+ * @maxSize 4
213
+ * @maxLength 1024
183
214
  */
184
215
  benefits?: string[];
185
216
  /**
@@ -188,6 +219,7 @@ export interface Plan {
188
219
  *
189
220
  * Min: `0` prices
190
221
  * Max: `10` prices
222
+ * @maxSize 10
191
223
  */
192
224
  prices?: Price[];
193
225
  }
@@ -197,6 +229,8 @@ export interface ListAppPlansByAppIdRequest {
197
229
  *
198
230
  * Min: 1 app ID
199
231
  * Max: 100 app IDs
232
+ * @minSize 1
233
+ * @maxSize 100
200
234
  */
201
235
  appIds: string[];
202
236
  }
@@ -214,6 +248,7 @@ export interface ListAppPlansByAppIdResponse {
214
248
  * you pass in the call's header. If you don't pass a country code in the header,
215
249
  * Wix calculates the currency based on the caller's IP address. Note that the
216
250
  * currency may not resolve properly if you call through a VPN.
251
+ * @format CURRENCY
217
252
  */
218
253
  currency?: string;
219
254
  /**
@@ -232,6 +267,7 @@ export interface ListAppPlansByAppIdResponse {
232
267
  * Max: 50 plans
233
268
  *
234
269
  * If any plans aren't returned, it's likely because they haven't been activated yet.
270
+ * @maxSize 50
235
271
  */
236
272
  appPlans?: AppPlans[];
237
273
  }
@@ -244,6 +280,7 @@ export interface TaxSettings {
244
280
  /**
245
281
  * Tax rate for the given country as percentage. Returned as `0` when
246
282
  * `{"showPriceWithTax": false}`.
283
+ * @format DECIMAL_VALUE
247
284
  */
248
285
  percentage?: string | null;
249
286
  /**
@@ -261,7 +298,10 @@ export declare enum TaxType {
261
298
  GST = "GST"
262
299
  }
263
300
  export interface GetAvailableAppPlansRequest {
264
- /** AppId to get the available app plans for. */
301
+ /**
302
+ * AppId to get the available app plans for.
303
+ * @format GUID
304
+ */
265
305
  appId?: string;
266
306
  /** The specific app plan info to retrieve the available app plans for. */
267
307
  appPlanInfo?: AppPlanInfo;
@@ -275,6 +315,7 @@ export interface AppPlanInfo {
275
315
  * The app plan's vendorId to retrieve the response for.
276
316
  *
277
317
  * Max: 100 characters
318
+ * @maxLength 100
278
319
  */
279
320
  vendorId?: string;
280
321
  /** The app plan cycle to retrieve the response for. */
@@ -289,13 +330,19 @@ export interface GetAvailableAppPlansResponse {
289
330
  currentPlan?: Plan;
290
331
  }
291
332
  export interface GetPricingPageUrlRequest {
292
- /** AppId to get the pricing page url for. */
333
+ /**
334
+ * AppId to get the pricing page url for.
335
+ * @format GUID
336
+ */
293
337
  appId?: string;
294
338
  /** The specific app plan to retrieve the pricing page url for. */
295
339
  appPlanInfo?: AppPlanInfo;
296
340
  }
297
341
  export interface GetPricingPageUrlResponse {
298
- /** the pricing page url, if there is a app plan that is upgradable. */
342
+ /**
343
+ * the pricing page url, if there is a app plan that is upgradable.
344
+ * @format WEB_URL
345
+ */
299
346
  packagePickerUrl?: string | null;
300
347
  }
301
348
  interface TaxSettingsNonNullableFields {
@@ -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"}