@wix/app-management 1.0.48 → 1.0.50

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.
@@ -1,1633 +0,0 @@
1
- interface AppPlans$1 {
2
- /** App ID, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view). */
3
- id?: string;
4
- /**
5
- * List of the app's pricing plans.
6
- *
7
- * Min: `0` plans
8
- * Max: `50` plans
9
- */
10
- plans?: Plan$1[];
11
- }
12
- declare enum SaleType$1 {
13
- /** Default value, can be used when no specific sale is associated. */
14
- SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
15
- CYBER_MONDAY = "CYBER_MONDAY",
16
- NOVEMBER_SALE = "NOVEMBER_SALE",
17
- BLACK_FRIDAY = "BLACK_FRIDAY",
18
- DEVELOPER_SALE = "DEVELOPER_SALE"
19
- }
20
- declare enum DiscountType$1 {
21
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
22
- /** Discount is a fixed amount in USD. */
23
- FIXED_AMOUNT = "FIXED_AMOUNT",
24
- /** Discount is a percentage of the total price. */
25
- PERCENTAGE = "PERCENTAGE"
26
- }
27
- declare enum SourceType$1 {
28
- /** Default value, can be used when no specific source is associated. */
29
- SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
30
- /** Discount is due to Wix/Developer Sale */
31
- SALE = "SALE",
32
- /** Discount is due to App Benefit */
33
- APP_BENEFIT = "APP_BENEFIT"
34
- }
35
- interface SaleSource$1 {
36
- saleId?: string | null;
37
- saleType?: SaleType$1;
38
- }
39
- interface Cycle$1 {
40
- /**
41
- * Type of the billing cycle.
42
- *
43
- * + `"UNKNOWN_UNIT"`: There is no information about the billing cycle.
44
- * + `"ONE_TIME"`: The customer pays for unlimited usage of the app with a single payment.
45
- * + `"RECURRING"`: The customer pays for a subscription to the app on a recurring schedule.
46
- */
47
- cycleType?: CycleType$1;
48
- /** Duration of the billing cycle. Available only for `{"cycleType": "RECURRING"}`. */
49
- cycleDuration?: Duration$1;
50
- }
51
- declare enum DurationUnit$1 {
52
- /** unknown interval unit */
53
- UNKNOWN_UNIT = "UNKNOWN_UNIT",
54
- /** month */
55
- MONTH = "MONTH",
56
- /** year */
57
- YEAR = "YEAR"
58
- }
59
- declare enum CycleType$1 {
60
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
61
- ONE_TIME = "ONE_TIME",
62
- RECURRING = "RECURRING"
63
- }
64
- interface Duration$1 {
65
- /** Unit of the billing cycle. */
66
- unit?: DurationUnit$1;
67
- /** Count of units that make up the billing cycle. */
68
- count?: number;
69
- }
70
- interface UsageBasedDetails$1 {
71
- /**
72
- * Smallest possible amount that your app charges customers in usage-based
73
- * pricing. For example, the price of a single SMS message if your
74
- * app charges customers for sending text messages. Always in
75
- * [USD](https://en.wikipedia.org/wiki/United_States_dollar).
76
- *
77
- * Min: `0.00`
78
- * Max: 1024 characters
79
- */
80
- minimumChargeIncrement?: string | null;
81
- /**
82
- * Recurring, monthly base fee in usage-based pricing that your app
83
- * charges customers regardless of how much they use your app.
84
- *
85
- * Min: `0.00`
86
- * Max: 1024 characters
87
- */
88
- monthlyBaseFee?: string | null;
89
- /**
90
- * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
91
- *
92
- * Max: 1024 characters
93
- */
94
- customChargeDescription?: string | null;
95
- }
96
- interface Discount$1 extends DiscountSourceDataOneOf$1 {
97
- /** Sale type */
98
- saleOptions?: SaleSource$1;
99
- type?: DiscountType$1;
100
- /** Discount amount */
101
- amount?: string;
102
- /**
103
- * if a discount is applied to a specific sale
104
- * @deprecated if a discount is applied to a specific sale
105
- * @targetRemovalDate 2025-01-14
106
- */
107
- saleId?: string | null;
108
- /**
109
- * Price without taxes. For yearly plans, Wix calculates and returns the
110
- * average price per month. You can get the full price by multiplying the
111
- * returned price with 12.
112
- * Min: `0.00`
113
- * Max: 1024 characters
114
- */
115
- priceBeforeTax?: string;
116
- /**
117
- * Total price including taxes.
118
- * Min: `0.00`
119
- * Max: 1024 characters
120
- */
121
- totalPrice?: string;
122
- /**
123
- * @deprecated
124
- * @targetRemovalDate 2025-01-14
125
- */
126
- saleType?: SaleType$1;
127
- sourceType?: SourceType$1;
128
- }
129
- /** @oneof */
130
- interface DiscountSourceDataOneOf$1 {
131
- /** Sale type */
132
- saleOptions?: SaleSource$1;
133
- }
134
- declare enum BillingSource$1 {
135
- UNKNOWN = "UNKNOWN",
136
- /** plan billing and charges is managed by Wix */
137
- WIX = "WIX",
138
- /** plan billing and charges is managed by the app */
139
- EXTERNAL = "EXTERNAL"
140
- }
141
- interface Price$1 {
142
- /**
143
- * Price without taxes. For yearly plans, Wix calculates and returns the
144
- * average price per month. You can get the full price by multiplying the
145
- * returned price by 12.
146
- *
147
- * Min: `0.00`
148
- * Max: 1024 characters
149
- */
150
- priceBeforeTax?: string;
151
- /**
152
- * Total price including taxes.
153
- *
154
- * Min: `0.00`
155
- * Max: 1024 characters
156
- */
157
- totalPrice?: string;
158
- /** Information about the plan's recurring billing cycle or single payment. */
159
- billingCycle?: Cycle$1;
160
- /**
161
- * Details about the plan's usage-based pricing.
162
- * Available only for plans with
163
- * [usage-based pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/usage-based-pricing).
164
- */
165
- usageBaseOptions?: UsageBasedDetails$1;
166
- discount?: Discount$1;
167
- billingSource?: BillingSource$1;
168
- /** Can be shown instead of plan price - used for dynamic plans */
169
- customPaymentTitle?: string | null;
170
- }
171
- interface Plan$1 {
172
- /**
173
- * ID of the app plan.
174
- * @readonly
175
- */
176
- id?: string;
177
- /**
178
- * ID of your app's pricing plan, as displayed in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
179
- * Identical to `vendorProductId` in the
180
- * [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
181
- */
182
- vendorId?: string;
183
- /** 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). */
184
- name?: string;
185
- /**
186
- * 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).
187
- * Currently, the benefits are available only in English.
188
- *
189
- * Min: `0` benefits
190
- * Max: `4` benefits
191
- * Max per benefit: 1024 characters
192
- */
193
- benefits?: string[];
194
- /**
195
- * List of the plan's prices. Available only when the plan's prices are managed
196
- * by Wix and not externally.
197
- *
198
- * Min: `0` prices
199
- * Max: `10` prices
200
- */
201
- prices?: Price$1[];
202
- }
203
- interface ListAppPlansByAppIdRequest$1 {
204
- /**
205
- * List of app IDs to retrieve plans for.
206
- *
207
- * Min: 1 app ID
208
- * Max: 100 app IDs
209
- */
210
- appIds: string[];
211
- }
212
- interface ListAppPlansByAppIdResponse$1 {
213
- /**
214
- * Tax settings. Wix calculates the tax settings based on the country code that
215
- * you pass in the call's header. If you don't pass a country code in the header,
216
- * Wix calculates the tax settings based on the caller's IP address. Note that the
217
- * tax settings may not resolve properly if you call through a VPN.
218
- */
219
- taxSettings?: TaxSettings$1;
220
- /**
221
- * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
222
- * format. Wix calculates the currency based on the country code that
223
- * you pass in the call's header. If you don't pass a country code in the header,
224
- * Wix calculates the currency based on the caller's IP address. Note that the
225
- * currency may not resolve properly if you call through a VPN.
226
- */
227
- currency?: string;
228
- /**
229
- * Currency symbol in decimal HTML entity format. For example, `$` for $
230
- * (United States Dollar). Wix calculates the currency symbol based on the
231
- * country code that you pass in the call's header. If you don't pass a country
232
- * code in the header, Wix calculates the tax settings based on the caller's IP
233
- * address. Note that the currency symbol may not resolve properly if you call
234
- * through a VPN.
235
- */
236
- currencySymbol?: string;
237
- /**
238
- * Retrieved app plans.
239
- *
240
- * Min: 0 plans
241
- * Max: 50 plans
242
- */
243
- appPlans?: AppPlans$1[];
244
- }
245
- interface TaxSettings$1 {
246
- /**
247
- * Whether you must display the total price including taxes in the given
248
- * country.
249
- */
250
- showPriceWithTax?: boolean;
251
- /**
252
- * Tax rate for the given country as percentage. Returned as `0` when
253
- * `{"showPriceWithTax": false}`.
254
- */
255
- percentage?: string | null;
256
- /**
257
- * Type of tax required in the given country.
258
- *
259
- * + `"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.
260
- * + `"VAT"`: The given country requires that you display the total price including [value-added tax (VAT)](https://en.wikipedia.org/wiki/Value-added_tax).
261
- * + `"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).
262
- */
263
- taxType?: TaxType$1;
264
- }
265
- declare enum TaxType$1 {
266
- NOT_APPLICABLE = "NOT_APPLICABLE",
267
- VAT = "VAT",
268
- GST = "GST"
269
- }
270
- interface TaxSettingsNonNullableFields$1 {
271
- showPriceWithTax: boolean;
272
- taxType: TaxType$1;
273
- }
274
- interface DurationNonNullableFields$1 {
275
- unit: DurationUnit$1;
276
- count: number;
277
- }
278
- interface CycleNonNullableFields$1 {
279
- cycleType: CycleType$1;
280
- cycleDuration?: DurationNonNullableFields$1;
281
- }
282
- interface SaleSourceNonNullableFields$1 {
283
- saleType: SaleType$1;
284
- }
285
- interface DiscountNonNullableFields$1 {
286
- saleOptions?: SaleSourceNonNullableFields$1;
287
- type: DiscountType$1;
288
- amount: string;
289
- priceBeforeTax: string;
290
- totalPrice: string;
291
- saleType: SaleType$1;
292
- sourceType: SourceType$1;
293
- }
294
- interface PriceNonNullableFields$1 {
295
- priceBeforeTax: string;
296
- totalPrice: string;
297
- billingCycle?: CycleNonNullableFields$1;
298
- discount?: DiscountNonNullableFields$1;
299
- billingSource: BillingSource$1;
300
- }
301
- interface PlanNonNullableFields$1 {
302
- id: string;
303
- vendorId: string;
304
- name: string;
305
- benefits: string[];
306
- prices: PriceNonNullableFields$1[];
307
- }
308
- interface AppPlansNonNullableFields$1 {
309
- id: string;
310
- plans: PlanNonNullableFields$1[];
311
- }
312
- interface ListAppPlansByAppIdResponseNonNullableFields$1 {
313
- taxSettings?: TaxSettingsNonNullableFields$1;
314
- currency: string;
315
- currencySymbol: string;
316
- appPlans: AppPlansNonNullableFields$1[];
317
- }
318
-
319
- interface AppPlans {
320
- /** App ID, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view). */
321
- _id?: string;
322
- /**
323
- * List of the app's pricing plans.
324
- *
325
- * Min: `0` plans
326
- * Max: `50` plans
327
- */
328
- plans?: Plan[];
329
- }
330
- declare enum SaleType {
331
- /** Default value, can be used when no specific sale is associated. */
332
- SALE_TYPE_UNSPECIFIED = "SALE_TYPE_UNSPECIFIED",
333
- CYBER_MONDAY = "CYBER_MONDAY",
334
- NOVEMBER_SALE = "NOVEMBER_SALE",
335
- BLACK_FRIDAY = "BLACK_FRIDAY",
336
- DEVELOPER_SALE = "DEVELOPER_SALE"
337
- }
338
- declare enum DiscountType {
339
- DISCOUNT_TYPE_UNSPECIFIED = "DISCOUNT_TYPE_UNSPECIFIED",
340
- /** Discount is a fixed amount in USD. */
341
- FIXED_AMOUNT = "FIXED_AMOUNT",
342
- /** Discount is a percentage of the total price. */
343
- PERCENTAGE = "PERCENTAGE"
344
- }
345
- declare enum SourceType {
346
- /** Default value, can be used when no specific source is associated. */
347
- SOURCE_TYPE_UNSPECIFIED = "SOURCE_TYPE_UNSPECIFIED",
348
- /** Discount is due to Wix/Developer Sale */
349
- SALE = "SALE",
350
- /** Discount is due to App Benefit */
351
- APP_BENEFIT = "APP_BENEFIT"
352
- }
353
- interface SaleSource {
354
- saleId?: string | null;
355
- saleType?: SaleType;
356
- }
357
- interface Cycle {
358
- /**
359
- * Type of the billing cycle.
360
- *
361
- * + `"UNKNOWN_UNIT"`: There is no information about the billing cycle.
362
- * + `"ONE_TIME"`: The customer pays for unlimited usage of the app with a single payment.
363
- * + `"RECURRING"`: The customer pays for a subscription to the app on a recurring schedule.
364
- */
365
- cycleType?: CycleType;
366
- /** Duration of the billing cycle. Available only for `{"cycleType": "RECURRING"}`. */
367
- cycleDuration?: Duration;
368
- }
369
- declare enum DurationUnit {
370
- /** unknown interval unit */
371
- UNKNOWN_UNIT = "UNKNOWN_UNIT",
372
- /** month */
373
- MONTH = "MONTH",
374
- /** year */
375
- YEAR = "YEAR"
376
- }
377
- declare enum CycleType {
378
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
379
- ONE_TIME = "ONE_TIME",
380
- RECURRING = "RECURRING"
381
- }
382
- interface Duration {
383
- /** Unit of the billing cycle. */
384
- unit?: DurationUnit;
385
- /** Count of units that make up the billing cycle. */
386
- count?: number;
387
- }
388
- interface UsageBasedDetails {
389
- /**
390
- * Smallest possible amount that your app charges customers in usage-based
391
- * pricing. For example, the price of a single SMS message if your
392
- * app charges customers for sending text messages. Always in
393
- * [USD](https://en.wikipedia.org/wiki/United_States_dollar).
394
- *
395
- * Min: `0.00`
396
- * Max: 1024 characters
397
- */
398
- minimumChargeIncrement?: string | null;
399
- /**
400
- * Recurring, monthly base fee in usage-based pricing that your app
401
- * charges customers regardless of how much they use your app.
402
- *
403
- * Min: `0.00`
404
- * Max: 1024 characters
405
- */
406
- monthlyBaseFee?: string | null;
407
- /**
408
- * Description of the usage-based pricing plan, as defined in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
409
- *
410
- * Max: 1024 characters
411
- */
412
- customChargeDescription?: string | null;
413
- }
414
- interface Discount extends DiscountSourceDataOneOf {
415
- /** Sale type */
416
- saleOptions?: SaleSource;
417
- type?: DiscountType;
418
- /** Discount amount */
419
- amount?: string;
420
- /**
421
- * if a discount is applied to a specific sale
422
- * @deprecated if a discount is applied to a specific sale
423
- * @targetRemovalDate 2025-01-14
424
- */
425
- saleId?: string | null;
426
- /**
427
- * Price without taxes. For yearly plans, Wix calculates and returns the
428
- * average price per month. You can get the full price by multiplying the
429
- * returned price with 12.
430
- * Min: `0.00`
431
- * Max: 1024 characters
432
- */
433
- priceBeforeTax?: string;
434
- /**
435
- * Total price including taxes.
436
- * Min: `0.00`
437
- * Max: 1024 characters
438
- */
439
- totalPrice?: string;
440
- /**
441
- * @deprecated
442
- * @targetRemovalDate 2025-01-14
443
- */
444
- saleType?: SaleType;
445
- sourceType?: SourceType;
446
- }
447
- /** @oneof */
448
- interface DiscountSourceDataOneOf {
449
- /** Sale type */
450
- saleOptions?: SaleSource;
451
- }
452
- declare enum BillingSource {
453
- UNKNOWN = "UNKNOWN",
454
- /** plan billing and charges is managed by Wix */
455
- WIX = "WIX",
456
- /** plan billing and charges is managed by the app */
457
- EXTERNAL = "EXTERNAL"
458
- }
459
- interface Price {
460
- /**
461
- * Price without taxes. For yearly plans, Wix calculates and returns the
462
- * average price per month. You can get the full price by multiplying the
463
- * returned price by 12.
464
- *
465
- * Min: `0.00`
466
- * Max: 1024 characters
467
- */
468
- priceBeforeTax?: string;
469
- /**
470
- * Total price including taxes.
471
- *
472
- * Min: `0.00`
473
- * Max: 1024 characters
474
- */
475
- totalPrice?: string;
476
- /** Information about the plan's recurring billing cycle or single payment. */
477
- billingCycle?: Cycle;
478
- /**
479
- * Details about the plan's usage-based pricing.
480
- * Available only for plans with
481
- * [usage-based pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/usage-based-pricing).
482
- */
483
- usageBaseOptions?: UsageBasedDetails;
484
- discount?: Discount;
485
- billingSource?: BillingSource;
486
- /** Can be shown instead of plan price - used for dynamic plans */
487
- customPaymentTitle?: string | null;
488
- }
489
- interface Plan {
490
- /**
491
- * ID of the app plan.
492
- * @readonly
493
- */
494
- _id?: string;
495
- /**
496
- * ID of your app's pricing plan, as displayed in the [app dashboard](https://dev.wix.com/apps/my-apps?viewId=active-apps-view).
497
- * Identical to `vendorProductId` in the
498
- * [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
499
- */
500
- vendorId?: string;
501
- /** 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). */
502
- name?: string;
503
- /**
504
- * 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).
505
- * Currently, the benefits are available only in English.
506
- *
507
- * Min: `0` benefits
508
- * Max: `4` benefits
509
- * Max per benefit: 1024 characters
510
- */
511
- benefits?: string[];
512
- /**
513
- * List of the plan's prices. Available only when the plan's prices are managed
514
- * by Wix and not externally.
515
- *
516
- * Min: `0` prices
517
- * Max: `10` prices
518
- */
519
- prices?: Price[];
520
- }
521
- interface ListAppPlansByAppIdRequest {
522
- /**
523
- * List of app IDs to retrieve plans for.
524
- *
525
- * Min: 1 app ID
526
- * Max: 100 app IDs
527
- */
528
- appIds: string[];
529
- }
530
- interface ListAppPlansByAppIdResponse {
531
- /**
532
- * Tax settings. Wix calculates the tax settings based on the country code that
533
- * you pass in the call's header. If you don't pass a country code in the header,
534
- * Wix calculates the tax settings based on the caller's IP address. Note that the
535
- * tax settings may not resolve properly if you call through a VPN.
536
- */
537
- taxSettings?: TaxSettings;
538
- /**
539
- * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
540
- * format. Wix calculates the currency based on the country code that
541
- * you pass in the call's header. If you don't pass a country code in the header,
542
- * Wix calculates the currency based on the caller's IP address. Note that the
543
- * currency may not resolve properly if you call through a VPN.
544
- */
545
- currency?: string;
546
- /**
547
- * Currency symbol in decimal HTML entity format. For example, `$` for $
548
- * (United States Dollar). Wix calculates the currency symbol based on the
549
- * country code that you pass in the call's header. If you don't pass a country
550
- * code in the header, Wix calculates the tax settings based on the caller's IP
551
- * address. Note that the currency symbol may not resolve properly if you call
552
- * through a VPN.
553
- */
554
- currencySymbol?: string;
555
- /**
556
- * Retrieved app plans.
557
- *
558
- * Min: 0 plans
559
- * Max: 50 plans
560
- */
561
- appPlans?: AppPlans[];
562
- }
563
- interface TaxSettings {
564
- /**
565
- * Whether you must display the total price including taxes in the given
566
- * country.
567
- */
568
- showPriceWithTax?: boolean;
569
- /**
570
- * Tax rate for the given country as percentage. Returned as `0` when
571
- * `{"showPriceWithTax": false}`.
572
- */
573
- percentage?: string | null;
574
- /**
575
- * Type of tax required in the given country.
576
- *
577
- * + `"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.
578
- * + `"VAT"`: The given country requires that you display the total price including [value-added tax (VAT)](https://en.wikipedia.org/wiki/Value-added_tax).
579
- * + `"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).
580
- */
581
- taxType?: TaxType;
582
- }
583
- declare enum TaxType {
584
- NOT_APPLICABLE = "NOT_APPLICABLE",
585
- VAT = "VAT",
586
- GST = "GST"
587
- }
588
- interface TaxSettingsNonNullableFields {
589
- showPriceWithTax: boolean;
590
- taxType: TaxType;
591
- }
592
- interface DurationNonNullableFields {
593
- unit: DurationUnit;
594
- count: number;
595
- }
596
- interface CycleNonNullableFields {
597
- cycleType: CycleType;
598
- cycleDuration?: DurationNonNullableFields;
599
- }
600
- interface SaleSourceNonNullableFields {
601
- saleType: SaleType;
602
- }
603
- interface DiscountNonNullableFields {
604
- saleOptions?: SaleSourceNonNullableFields;
605
- type: DiscountType;
606
- amount: string;
607
- priceBeforeTax: string;
608
- totalPrice: string;
609
- saleType: SaleType;
610
- sourceType: SourceType;
611
- }
612
- interface PriceNonNullableFields {
613
- priceBeforeTax: string;
614
- totalPrice: string;
615
- billingCycle?: CycleNonNullableFields;
616
- discount?: DiscountNonNullableFields;
617
- billingSource: BillingSource;
618
- }
619
- interface PlanNonNullableFields {
620
- _id: string;
621
- vendorId: string;
622
- name: string;
623
- benefits: string[];
624
- prices: PriceNonNullableFields[];
625
- }
626
- interface AppPlansNonNullableFields {
627
- _id: string;
628
- plans: PlanNonNullableFields[];
629
- }
630
- interface ListAppPlansByAppIdResponseNonNullableFields {
631
- taxSettings?: TaxSettingsNonNullableFields;
632
- currency: string;
633
- currencySymbol: string;
634
- appPlans: AppPlansNonNullableFields[];
635
- }
636
-
637
- type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
638
- getUrl: (context: any) => string;
639
- httpMethod: K;
640
- path: string;
641
- pathParams: M;
642
- __requestType: T;
643
- __originalRequestType: S;
644
- __responseType: Q;
645
- __originalResponseType: R;
646
- };
647
- declare function listAppPlansByAppId(): __PublicMethodMetaInfo$4<'GET', {
648
- appIds: string;
649
- }, ListAppPlansByAppIdRequest, ListAppPlansByAppIdRequest$1, ListAppPlansByAppIdResponse & ListAppPlansByAppIdResponseNonNullableFields, ListAppPlansByAppIdResponse$1 & ListAppPlansByAppIdResponseNonNullableFields$1>;
650
-
651
- declare const meta$4_listAppPlansByAppId: typeof listAppPlansByAppId;
652
- declare namespace meta$4 {
653
- export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_listAppPlansByAppId as listAppPlansByAppId };
654
- }
655
-
656
- /**
657
- * An app instance is a specific occurrence of your app on a particular Wix site.
658
- * When a site owner installs your app, a unique instance is generated for that
659
- * specific site. Use the `instanceId` to keep track of the individual data
660
- * associated with each app instance.
661
- */
662
- interface AppInstance$1 {
663
- /**
664
- * ID of the app instance. You can use it to keep track of the individual
665
- * data that's associated with the specific occurence of your app that's
666
- * installed on a Wix site.
667
- */
668
- instanceId?: string;
669
- /**
670
- * App name, as set by you in the Customs Apps page during the app creation
671
- * process.
672
- */
673
- appName?: string;
674
- /** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
675
- appVersion?: string | null;
676
- /**
677
- * Whether the site owners have installed a free or paid version of your app
678
- * on their site.
679
- */
680
- isFree?: boolean;
681
- /**
682
- * Billing information for the app instance. Available only in case
683
- * `{"isFree": false}`.
684
- */
685
- billing?: BillingInfo$1;
686
- /**
687
- * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
688
- * that the site owners have granted your app. You set the list of permissions that
689
- * your app requires from the site owners in your app's Permissions page during the
690
- * app creation process.
691
- */
692
- permissions?: string[];
693
- /** Plans available to this app instance. */
694
- availablePlans?: AvailablePlan$1[];
695
- /**
696
- * ID of the Wix site from which the instance of your app has been cloned.
697
- * Available only in case `{"copiedFromTemplate": true}`.
698
- * All visual settings of the Wix site and app data are duplicated during the
699
- * cloning process. Wix also notifies you in case there is any additional
700
- * external functionality for the original site.
701
- */
702
- originInstanceId?: string | null;
703
- /**
704
- * __Deprecated__. This parameter will be removed on March 30, 2023. Use
705
- * `copiedFromTemplate` instead.
706
- * @deprecated
707
- */
708
- isOriginSiteTemplate?: boolean;
709
- /** Whether the app instance was created when another Wix site was cloned. */
710
- copiedFromTemplate?: boolean;
711
- /** Whether the app instance includes a free trial that hasn't started yet. */
712
- freeTrialAvailable?: boolean;
713
- }
714
- interface BillingInfo$1 {
715
- /** Name of the package that the site owner has paid for. */
716
- packageName?: string;
717
- /**
718
- * Interval of the billing cycle. `"ONE_TIME"` means that site owners have
719
- * purchased unlimited access to the app with a single, upfront payment.
720
- */
721
- billingCycle?: PaymentCycle$3;
722
- /**
723
- * Date and time the site owners have purchased the app's paid plan in
724
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
725
- */
726
- timeStamp?: string;
727
- /**
728
- * Date and time the app's current billing cycle ends in
729
- * `YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and
730
- * multi-yearly plans.
731
- */
732
- expirationDate?: string | null;
733
- /**
734
- * Whether the app's subscription automatically renews at the end of the
735
- * current billing cycle.
736
- */
737
- autoRenewing?: boolean | null;
738
- /** ID of the invoice for the current billing cycle. */
739
- invoiceId?: string | null;
740
- /**
741
- * Information about any discounts applied to the app instance's current billing cycle.
742
- * If the site owners applied a developer coupon or Wix Voucher
743
- * when installing the paid version of your app, this field holds the coupon's
744
- * name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when
745
- * upgrading their Wix subscription. If there is no discount for the
746
- * current billing cycle, the field is an empty string.
747
- */
748
- source?: string | null;
749
- /** Information about the free trial applied, if relevant. */
750
- freeTrialInfo?: FreeTrialInfo$1;
751
- }
752
- declare enum PaymentCycle$3 {
753
- NO_CYCLE = "NO_CYCLE",
754
- MONTHLY = "MONTHLY",
755
- YEARLY = "YEARLY",
756
- ONE_TIME = "ONE_TIME",
757
- TWO_YEARS = "TWO_YEARS",
758
- THREE_YEARS = "THREE_YEARS",
759
- FOUR_YEARS = "FOUR_YEARS",
760
- FIVE_YEARS = "FIVE_YEARS"
761
- }
762
- interface FreeTrialInfo$1 {
763
- /**
764
- * Current free trial status.
765
- * @readonly
766
- */
767
- status?: FreeTrialStatus$1;
768
- /**
769
- * When the free trial has ended. Populated only once the free trial is over.
770
- * @readonly
771
- */
772
- endDate?: Date | null;
773
- }
774
- declare enum FreeTrialStatus$1 {
775
- /** Unknown trial status. */
776
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
777
- /** The free trial is currently in progress. */
778
- IN_PROGRESS = "IN_PROGRESS",
779
- /** The free trial has ended. */
780
- ENDED = "ENDED",
781
- /** No free trial was applied, as none was available. */
782
- NOT_AVAILABLE = "NOT_AVAILABLE"
783
- }
784
- interface AvailablePlan$1 {
785
- /** Package name of the available plan. */
786
- packageName?: string;
787
- /** Source of the available plan. Can be a bundle or 3rd-party app. */
788
- source?: string;
789
- }
790
- interface GetAppInstanceRequest$1 {
791
- }
792
- interface GetAppInstanceResponse$1 {
793
- /** Retrieved app instance. */
794
- instance?: AppInstance$1;
795
- /** Information about the corresponding Wix site. */
796
- site?: SiteInfo$1;
797
- }
798
- interface SiteInfo$1 {
799
- /** Display name of the site. */
800
- siteDisplayName?: string | null;
801
- /**
802
- * 2-letter language code of the site's locale in
803
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
804
- */
805
- locale?: string;
806
- /**
807
- * 3-letter currency code for the site's billing in
808
- * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
809
- */
810
- paymentCurrency?: string;
811
- /** Information about the site's supported languages. */
812
- multilingual?: Multilingual$1;
813
- /** URL of the site. Available only in case the site has been published. */
814
- url?: string | null;
815
- /** Description of the site. */
816
- description?: string | null;
817
- /** Wix apps that are installed on the site. */
818
- installedWixApps?: string[];
819
- /**
820
- * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
821
- * @deprecated
822
- */
823
- ownerEmail?: string | null;
824
- /**
825
- * Information about the site owner. Available only when calling
826
- * _Get App Instance_ with the __Read Site Owner Email__ permission scope.
827
- */
828
- ownerInfo?: OwnerInfo$1;
829
- /** Site ID. */
830
- siteId?: string;
831
- }
832
- interface Multilingual$1 {
833
- /** Whether the site supports more than a single language. */
834
- isMultiLingual?: boolean;
835
- /** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
836
- supportedLanguages?: SupportedLanguage$1[];
837
- }
838
- interface SupportedLanguage$1 {
839
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
840
- languageCode?: string;
841
- /** Locale. */
842
- locale?: Locale$1;
843
- /** Whether the supported language is the primary language for the site. */
844
- isPrimary?: boolean;
845
- /** Language icon. */
846
- countryCode?: string;
847
- /** How the language will be resolved. For internal use. */
848
- resolutionMethod?: ResolutionMethod$1;
849
- }
850
- interface Locale$1 {
851
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
852
- languageCode?: string;
853
- /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
854
- country?: string;
855
- }
856
- declare enum ResolutionMethod$1 {
857
- QUERY_PARAM = "QUERY_PARAM",
858
- SUBDOMAIN = "SUBDOMAIN",
859
- SUBDIRECTORY = "SUBDIRECTORY"
860
- }
861
- interface OwnerInfo$1 {
862
- /** Site owner's email address. Identical to the site owner's login email. */
863
- email?: string;
864
- /**
865
- * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
866
- * `NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.
867
- *
868
- * Whether the site owner has verified their email and whether they have chosen
869
- * to receive email notifications from Wix.
870
- */
871
- emailStatus?: string;
872
- }
873
- interface FreeTrialInfoNonNullableFields$1 {
874
- status: FreeTrialStatus$1;
875
- }
876
- interface BillingInfoNonNullableFields$1 {
877
- packageName: string;
878
- billingCycle: PaymentCycle$3;
879
- timeStamp: string;
880
- freeTrialInfo?: FreeTrialInfoNonNullableFields$1;
881
- }
882
- interface AvailablePlanNonNullableFields$1 {
883
- packageName: string;
884
- source: string;
885
- }
886
- interface AppInstanceNonNullableFields$1 {
887
- instanceId: string;
888
- appName: string;
889
- isFree: boolean;
890
- billing?: BillingInfoNonNullableFields$1;
891
- permissions: string[];
892
- availablePlans: AvailablePlanNonNullableFields$1[];
893
- isOriginSiteTemplate: boolean;
894
- copiedFromTemplate: boolean;
895
- freeTrialAvailable: boolean;
896
- }
897
- interface LocaleNonNullableFields$1 {
898
- languageCode: string;
899
- country: string;
900
- }
901
- interface SupportedLanguageNonNullableFields$1 {
902
- languageCode: string;
903
- locale?: LocaleNonNullableFields$1;
904
- isPrimary: boolean;
905
- countryCode: string;
906
- resolutionMethod: ResolutionMethod$1;
907
- }
908
- interface MultilingualNonNullableFields$1 {
909
- isMultiLingual: boolean;
910
- supportedLanguages: SupportedLanguageNonNullableFields$1[];
911
- }
912
- interface OwnerInfoNonNullableFields$1 {
913
- email: string;
914
- emailStatus: string;
915
- }
916
- interface SiteInfoNonNullableFields$1 {
917
- locale: string;
918
- paymentCurrency: string;
919
- multilingual?: MultilingualNonNullableFields$1;
920
- installedWixApps: string[];
921
- ownerInfo?: OwnerInfoNonNullableFields$1;
922
- siteId: string;
923
- }
924
- interface GetAppInstanceResponseNonNullableFields$1 {
925
- instance?: AppInstanceNonNullableFields$1;
926
- site?: SiteInfoNonNullableFields$1;
927
- }
928
-
929
- /**
930
- * An app instance is a specific occurrence of your app on a particular Wix site.
931
- * When a site owner installs your app, a unique instance is generated for that
932
- * specific site. Use the `instanceId` to keep track of the individual data
933
- * associated with each app instance.
934
- */
935
- interface AppInstance {
936
- /**
937
- * ID of the app instance. You can use it to keep track of the individual
938
- * data that's associated with the specific occurence of your app that's
939
- * installed on a Wix site.
940
- */
941
- instanceId?: string;
942
- /**
943
- * App name, as set by you in the Customs Apps page during the app creation
944
- * process.
945
- */
946
- appName?: string;
947
- /** Version of your app that's installed on the Wix site, as set by you during the app creation process. */
948
- appVersion?: string | null;
949
- /**
950
- * Whether the site owners have installed a free or paid version of your app
951
- * on their site.
952
- */
953
- isFree?: boolean;
954
- /**
955
- * Billing information for the app instance. Available only in case
956
- * `{"isFree": false}`.
957
- */
958
- billing?: BillingInfo;
959
- /**
960
- * List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app#4-add-permissions)
961
- * that the site owners have granted your app. You set the list of permissions that
962
- * your app requires from the site owners in your app's Permissions page during the
963
- * app creation process.
964
- */
965
- permissions?: string[];
966
- /** Plans available to this app instance. */
967
- availablePlans?: AvailablePlan[];
968
- /**
969
- * ID of the Wix site from which the instance of your app has been cloned.
970
- * Available only in case `{"copiedFromTemplate": true}`.
971
- * All visual settings of the Wix site and app data are duplicated during the
972
- * cloning process. Wix also notifies you in case there is any additional
973
- * external functionality for the original site.
974
- */
975
- originInstanceId?: string | null;
976
- /**
977
- * __Deprecated__. This parameter will be removed on March 30, 2023. Use
978
- * `copiedFromTemplate` instead.
979
- * @deprecated
980
- */
981
- isOriginSiteTemplate?: boolean;
982
- /** Whether the app instance was created when another Wix site was cloned. */
983
- copiedFromTemplate?: boolean;
984
- /** Whether the app instance includes a free trial that hasn't started yet. */
985
- freeTrialAvailable?: boolean;
986
- }
987
- interface BillingInfo {
988
- /** Name of the package that the site owner has paid for. */
989
- packageName?: string;
990
- /**
991
- * Interval of the billing cycle. `"ONE_TIME"` means that site owners have
992
- * purchased unlimited access to the app with a single, upfront payment.
993
- */
994
- billingCycle?: PaymentCycle$2;
995
- /**
996
- * Date and time the site owners have purchased the app's paid plan in
997
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
998
- */
999
- timeStamp?: string;
1000
- /**
1001
- * Date and time the app's current billing cycle ends in
1002
- * `YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and
1003
- * multi-yearly plans.
1004
- */
1005
- expirationDate?: string | null;
1006
- /**
1007
- * Whether the app's subscription automatically renews at the end of the
1008
- * current billing cycle.
1009
- */
1010
- autoRenewing?: boolean | null;
1011
- /** ID of the invoice for the current billing cycle. */
1012
- invoiceId?: string | null;
1013
- /**
1014
- * Information about any discounts applied to the app instance's current billing cycle.
1015
- * If the site owners applied a developer coupon or Wix Voucher
1016
- * when installing the paid version of your app, this field holds the coupon's
1017
- * name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when
1018
- * upgrading their Wix subscription. If there is no discount for the
1019
- * current billing cycle, the field is an empty string.
1020
- */
1021
- source?: string | null;
1022
- /** Information about the free trial applied, if relevant. */
1023
- freeTrialInfo?: FreeTrialInfo;
1024
- }
1025
- declare enum PaymentCycle$2 {
1026
- NO_CYCLE = "NO_CYCLE",
1027
- MONTHLY = "MONTHLY",
1028
- YEARLY = "YEARLY",
1029
- ONE_TIME = "ONE_TIME",
1030
- TWO_YEARS = "TWO_YEARS",
1031
- THREE_YEARS = "THREE_YEARS",
1032
- FOUR_YEARS = "FOUR_YEARS",
1033
- FIVE_YEARS = "FIVE_YEARS"
1034
- }
1035
- interface FreeTrialInfo {
1036
- /**
1037
- * Current free trial status.
1038
- * @readonly
1039
- */
1040
- status?: FreeTrialStatus;
1041
- /**
1042
- * When the free trial has ended. Populated only once the free trial is over.
1043
- * @readonly
1044
- */
1045
- endDate?: Date | null;
1046
- }
1047
- declare enum FreeTrialStatus {
1048
- /** Unknown trial status. */
1049
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
1050
- /** The free trial is currently in progress. */
1051
- IN_PROGRESS = "IN_PROGRESS",
1052
- /** The free trial has ended. */
1053
- ENDED = "ENDED",
1054
- /** No free trial was applied, as none was available. */
1055
- NOT_AVAILABLE = "NOT_AVAILABLE"
1056
- }
1057
- interface AvailablePlan {
1058
- /** Package name of the available plan. */
1059
- packageName?: string;
1060
- /** Source of the available plan. Can be a bundle or 3rd-party app. */
1061
- source?: string;
1062
- }
1063
- interface GetAppInstanceRequest {
1064
- }
1065
- interface GetAppInstanceResponse {
1066
- /** Retrieved app instance. */
1067
- instance?: AppInstance;
1068
- /** Information about the corresponding Wix site. */
1069
- site?: SiteInfo;
1070
- }
1071
- interface SiteInfo {
1072
- /** Display name of the site. */
1073
- siteDisplayName?: string | null;
1074
- /**
1075
- * 2-letter language code of the site's locale in
1076
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1077
- */
1078
- locale?: string;
1079
- /**
1080
- * 3-letter currency code for the site's billing in
1081
- * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1082
- */
1083
- paymentCurrency?: string;
1084
- /** Information about the site's supported languages. */
1085
- multilingual?: Multilingual;
1086
- /** URL of the site. Available only in case the site has been published. */
1087
- url?: string | null;
1088
- /** Description of the site. */
1089
- description?: string | null;
1090
- /** Wix apps that are installed on the site. */
1091
- installedWixApps?: string[];
1092
- /**
1093
- * > **Deprecation Notice:** This parameter will be removed on June 30, 2022. Use `ownerInfo` instead.
1094
- * @deprecated
1095
- */
1096
- ownerEmail?: string | null;
1097
- /**
1098
- * Information about the site owner. Available only when calling
1099
- * _Get App Instance_ with the __Read Site Owner Email__ permission scope.
1100
- */
1101
- ownerInfo?: OwnerInfo;
1102
- /** Site ID. */
1103
- siteId?: string;
1104
- }
1105
- interface Multilingual {
1106
- /** Whether the site supports more than a single language. */
1107
- isMultiLingual?: boolean;
1108
- /** List of supported languages. Returned only when `{"isMultiLingual": true}`. */
1109
- supportedLanguages?: SupportedLanguage[];
1110
- }
1111
- interface SupportedLanguage {
1112
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1113
- languageCode?: string;
1114
- /** Locale. */
1115
- locale?: Locale;
1116
- /** Whether the supported language is the primary language for the site. */
1117
- isPrimary?: boolean;
1118
- /** Language icon. */
1119
- countryCode?: string;
1120
- /** How the language will be resolved. For internal use. */
1121
- resolutionMethod?: ResolutionMethod;
1122
- }
1123
- interface Locale {
1124
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1125
- languageCode?: string;
1126
- /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1127
- country?: string;
1128
- }
1129
- declare enum ResolutionMethod {
1130
- QUERY_PARAM = "QUERY_PARAM",
1131
- SUBDOMAIN = "SUBDOMAIN",
1132
- SUBDIRECTORY = "SUBDIRECTORY"
1133
- }
1134
- interface OwnerInfo {
1135
- /** Site owner's email address. Identical to the site owner's login email. */
1136
- email?: string;
1137
- /**
1138
- * Supported values: `VERIFIED_OPT_IN`, `VERIFIED_OPT_OUT`,
1139
- * `NOT_VERIFIED_OPT_IN`, `NOT_VERIFIED_OPT_OUT`.
1140
- *
1141
- * Whether the site owner has verified their email and whether they have chosen
1142
- * to receive email notifications from Wix.
1143
- */
1144
- emailStatus?: string;
1145
- }
1146
- interface FreeTrialInfoNonNullableFields {
1147
- status: FreeTrialStatus;
1148
- }
1149
- interface BillingInfoNonNullableFields {
1150
- packageName: string;
1151
- billingCycle: PaymentCycle$2;
1152
- timeStamp: string;
1153
- freeTrialInfo?: FreeTrialInfoNonNullableFields;
1154
- }
1155
- interface AvailablePlanNonNullableFields {
1156
- packageName: string;
1157
- source: string;
1158
- }
1159
- interface AppInstanceNonNullableFields {
1160
- instanceId: string;
1161
- appName: string;
1162
- isFree: boolean;
1163
- billing?: BillingInfoNonNullableFields;
1164
- permissions: string[];
1165
- availablePlans: AvailablePlanNonNullableFields[];
1166
- isOriginSiteTemplate: boolean;
1167
- copiedFromTemplate: boolean;
1168
- freeTrialAvailable: boolean;
1169
- }
1170
- interface LocaleNonNullableFields {
1171
- languageCode: string;
1172
- country: string;
1173
- }
1174
- interface SupportedLanguageNonNullableFields {
1175
- languageCode: string;
1176
- locale?: LocaleNonNullableFields;
1177
- isPrimary: boolean;
1178
- countryCode: string;
1179
- resolutionMethod: ResolutionMethod;
1180
- }
1181
- interface MultilingualNonNullableFields {
1182
- isMultiLingual: boolean;
1183
- supportedLanguages: SupportedLanguageNonNullableFields[];
1184
- }
1185
- interface OwnerInfoNonNullableFields {
1186
- email: string;
1187
- emailStatus: string;
1188
- }
1189
- interface SiteInfoNonNullableFields {
1190
- locale: string;
1191
- paymentCurrency: string;
1192
- multilingual?: MultilingualNonNullableFields;
1193
- installedWixApps: string[];
1194
- ownerInfo?: OwnerInfoNonNullableFields;
1195
- siteId: string;
1196
- }
1197
- interface GetAppInstanceResponseNonNullableFields {
1198
- instance?: AppInstanceNonNullableFields;
1199
- site?: SiteInfoNonNullableFields;
1200
- }
1201
-
1202
- type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1203
- getUrl: (context: any) => string;
1204
- httpMethod: K;
1205
- path: string;
1206
- pathParams: M;
1207
- __requestType: T;
1208
- __originalRequestType: S;
1209
- __responseType: Q;
1210
- __originalResponseType: R;
1211
- };
1212
- declare function getAppInstance(): __PublicMethodMetaInfo$3<'GET', {}, GetAppInstanceRequest, GetAppInstanceRequest$1, GetAppInstanceResponse & GetAppInstanceResponseNonNullableFields, GetAppInstanceResponse$1 & GetAppInstanceResponseNonNullableFields$1>;
1213
-
1214
- declare const meta$3_getAppInstance: typeof getAppInstance;
1215
- declare namespace meta$3 {
1216
- export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_getAppInstance as getAppInstance };
1217
- }
1218
-
1219
- interface SendBIEventResponse$1 {
1220
- }
1221
- interface SendBIEventRequest$1 {
1222
- /** Name of the event that's triggered in your app. */
1223
- eventName?: EventName$1;
1224
- /**
1225
- * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
1226
- *
1227
- * Min: 2 characters
1228
- */
1229
- customEventName?: string | null;
1230
- /**
1231
- * Supported values include: `"cycle_name"`, `"currency"`, `"sum"`, `"reason"`, `"app_plan_id"`.
1232
- * You may also submit data with keys that aren't listed here.
1233
- *
1234
- * Additional data about your app's event.
1235
- *
1236
- * + `"cycle_name"`: Supported values: `"monthly"`, `"yearly"`, `"2 years"`, `"one time"`.
1237
- * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1238
- * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
1239
- * + `"reason"`: Information about why the event was triggered in your app.
1240
- * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
1241
- */
1242
- eventData?: Record<string, string>;
1243
- }
1244
- declare enum EventName$1 {
1245
- /** Unknown event name. */
1246
- UNKNOWN = "UNKNOWN",
1247
- /** A site owner or contributor loads your app's dashboard. */
1248
- APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
1249
- /** The site owner completes all required configurations for your app in your app's dashboard. */
1250
- APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
1251
- /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
1252
- APP_UPGRADED = "APP_UPGRADED",
1253
- /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
1254
- PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
1255
- /** Any event that's not listed here. Make sure to also send `customEventName`. */
1256
- CUSTOM = "CUSTOM",
1257
- /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
1258
- CHARGE = "CHARGE",
1259
- /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
1260
- FUNDS_RETURNED = "FUNDS_RETURNED",
1261
- /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
1262
- APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
1263
- /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
1264
- APP_DEPLOYED = "APP_DEPLOYED",
1265
- /** The site owner completes your app's required business setup. */
1266
- APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
1267
- }
1268
-
1269
- interface SendBIEventResponse {
1270
- }
1271
- interface SendBIEventRequest {
1272
- /** Name of the event that's triggered in your app. */
1273
- eventName?: EventName;
1274
- /**
1275
- * Name of your app's custom event that was triggered. Required when `{"eventName": "CUSTOM"}`.
1276
- *
1277
- * Min: 2 characters
1278
- */
1279
- customEventName?: string | null;
1280
- /**
1281
- * Supported values include: `"cycle_name"`, `"currency"`, `"sum"`, `"reason"`, `"app_plan_id"`.
1282
- * You may also submit data with keys that aren't listed here.
1283
- *
1284
- * Additional data about your app's event.
1285
- *
1286
- * + `"cycle_name"`: Supported values: `"monthly"`, `"yearly"`, `"2 years"`, `"one time"`.
1287
- * + `"currency"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1288
- * + `"sum"`: Amount of money. Required for `{"eventName": "CHARGE"}` and `{"eventName": "FUNDS_RETURNED"}`.
1289
- * + `"reason"`: Information about why the event was triggered in your app.
1290
- * + `"app_plan_id"`: ID of the your app's plan as displayed in your app's dashboard. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).
1291
- */
1292
- eventData?: Record<string, string>;
1293
- }
1294
- declare enum EventName {
1295
- /** Unknown event name. */
1296
- UNKNOWN = "UNKNOWN",
1297
- /** A site owner or contributor loads your app's dashboard. */
1298
- APP_DASHBOARD_LOADED = "APP_DASHBOARD_LOADED",
1299
- /** The site owner completes all required configurations for your app in your app's dashboard. */
1300
- APP_FINISHED_CONFIGURATION = "APP_FINISHED_CONFIGURATION",
1301
- /** The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side. */
1302
- APP_UPGRADED = "APP_UPGRADED",
1303
- /** A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app. */
1304
- PRIMARY_ACTION_PERFORMED = "PRIMARY_ACTION_PERFORMED",
1305
- /** Any event that's not listed here. Make sure to also send `customEventName`. */
1306
- CUSTOM = "CUSTOM",
1307
- /** You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`. */
1308
- CHARGE = "CHARGE",
1309
- /** Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{"eventData": {"sum": "5.99"}}`. */
1310
- FUNDS_RETURNED = "FUNDS_RETURNED",
1311
- /** __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `"APP_SETUP_FINISHED"` instead. */
1312
- APP_FINISH_BUSINESS_SETUP = "APP_FINISH_BUSINESS_SETUP",
1313
- /** Your app’s internal code implementation is changed and might affect user flows or cause a regression. */
1314
- APP_DEPLOYED = "APP_DEPLOYED",
1315
- /** The site owner completes your app's required business setup. */
1316
- APP_SETUP_FINISHED = "APP_SETUP_FINISHED"
1317
- }
1318
-
1319
- type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1320
- getUrl: (context: any) => string;
1321
- httpMethod: K;
1322
- path: string;
1323
- pathParams: M;
1324
- __requestType: T;
1325
- __originalRequestType: S;
1326
- __responseType: Q;
1327
- __originalResponseType: R;
1328
- };
1329
- declare function sendBiEvent(): __PublicMethodMetaInfo$2<'POST', {}, SendBIEventRequest, SendBIEventRequest$1, SendBIEventResponse, SendBIEventResponse$1>;
1330
-
1331
- declare const meta$2_sendBiEvent: typeof sendBiEvent;
1332
- declare namespace meta$2 {
1333
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_sendBiEvent as sendBiEvent };
1334
- }
1335
-
1336
- interface PurchasedItem$1 {
1337
- /** ID of your app's paid plan. */
1338
- productId?: string;
1339
- /** Price of your app's paid plan. For example, `9.95`. */
1340
- price?: string;
1341
- /**
1342
- * 3-letter currency code in
1343
- * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1344
- */
1345
- currency?: string;
1346
- /** Information about the billing cycle for your app's paid plan. */
1347
- billingCycle?: PaymentCycle$1;
1348
- /**
1349
- * Date and time the site onwers have purchased your app's paid plan in
1350
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1351
- */
1352
- dateCreated?: Date | null;
1353
- }
1354
- declare enum PaymentCycle$1 {
1355
- NO_CYCLE = "NO_CYCLE",
1356
- MONTHLY = "MONTHLY",
1357
- YEARLY = "YEARLY",
1358
- ONE_TIME = "ONE_TIME",
1359
- TWO_YEARS = "TWO_YEARS",
1360
- THREE_YEARS = "THREE_YEARS",
1361
- FOUR_YEARS = "FOUR_YEARS",
1362
- FIVE_YEARS = "FIVE_YEARS"
1363
- }
1364
- interface GetUrlRequest$1 {
1365
- /**
1366
- * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
1367
- * for a list of your app's supported product IDs.
1368
- */
1369
- productId: string;
1370
- /**
1371
- * URL for the Wix checkout page. Redirect site owners to this URL after
1372
- * they've successfully purchased a paid plan for your app.
1373
- */
1374
- successUrl?: string | null;
1375
- /**
1376
- * Whether the checkout is for testing purposes only. Testing is mainly
1377
- * relevant for in-app purchase flows. When `true`, Wix charges the site
1378
- * owners an amount of `0.00`.
1379
- */
1380
- testCheckout?: boolean;
1381
- /** Information about the paid plan's billing cycle. */
1382
- billingCycle?: PaymentCycle$1;
1383
- /**
1384
- * 2-letter country code in
1385
- * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
1386
- * format.
1387
- *
1388
- * Default: `"US"`
1389
- */
1390
- countryCode?: string | null;
1391
- /**
1392
- * 2-letter language code in
1393
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1394
- *
1395
- * Default: `"EN"`
1396
- */
1397
- languageCode?: string | null;
1398
- /** Coupon code for the paid plan. Available only in case there is a discount. */
1399
- couponCode?: string | null;
1400
- }
1401
- interface GetUrlResponse$1 {
1402
- /** URL for the Wix checkout page. */
1403
- checkoutUrl?: string;
1404
- /**
1405
- * Token for the Wix checkout page. The token holds all data about the order
1406
- * you're creating a checkout for. It is [signed](),
1407
- * so you can verify that it comes from Wix.
1408
- */
1409
- token?: string | null;
1410
- }
1411
- interface GetPurchaseHistoryRequest$1 {
1412
- }
1413
- interface GetPurchaseHistoryResponse$1 {
1414
- /** Retrieved purchases the site owners have completed for you app. */
1415
- purchases?: PurchasedItem$1[];
1416
- }
1417
- interface GetUrlResponseNonNullableFields$1 {
1418
- checkoutUrl: string;
1419
- }
1420
- interface PurchasedItemNonNullableFields$1 {
1421
- productId: string;
1422
- price: string;
1423
- currency: string;
1424
- billingCycle: PaymentCycle$1;
1425
- }
1426
- interface GetPurchaseHistoryResponseNonNullableFields$1 {
1427
- purchases: PurchasedItemNonNullableFields$1[];
1428
- }
1429
-
1430
- interface PurchasedItem {
1431
- /** ID of your app's paid plan. */
1432
- productId?: string;
1433
- /** Price of your app's paid plan. For example, `9.95`. */
1434
- price?: string;
1435
- /**
1436
- * 3-letter currency code in
1437
- * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1438
- */
1439
- currency?: string;
1440
- /** Information about the billing cycle for your app's paid plan. */
1441
- billingCycle?: PaymentCycle;
1442
- /**
1443
- * Date and time the site onwers have purchased your app's paid plan in
1444
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1445
- */
1446
- dateCreated?: Date | null;
1447
- }
1448
- declare enum PaymentCycle {
1449
- NO_CYCLE = "NO_CYCLE",
1450
- MONTHLY = "MONTHLY",
1451
- YEARLY = "YEARLY",
1452
- ONE_TIME = "ONE_TIME",
1453
- TWO_YEARS = "TWO_YEARS",
1454
- THREE_YEARS = "THREE_YEARS",
1455
- FOUR_YEARS = "FOUR_YEARS",
1456
- FIVE_YEARS = "FIVE_YEARS"
1457
- }
1458
- interface GetUrlRequest {
1459
- /**
1460
- * ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard
1461
- * for a list of your app's supported product IDs.
1462
- */
1463
- productId: string;
1464
- /**
1465
- * URL for the Wix checkout page. Redirect site owners to this URL after
1466
- * they've successfully purchased a paid plan for your app.
1467
- */
1468
- successUrl?: string | null;
1469
- /**
1470
- * Whether the checkout is for testing purposes only. Testing is mainly
1471
- * relevant for in-app purchase flows. When `true`, Wix charges the site
1472
- * owners an amount of `0.00`.
1473
- */
1474
- testCheckout?: boolean;
1475
- /** Information about the paid plan's billing cycle. */
1476
- billingCycle?: PaymentCycle;
1477
- /**
1478
- * 2-letter country code in
1479
- * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
1480
- * format.
1481
- *
1482
- * Default: `"US"`
1483
- */
1484
- countryCode?: string | null;
1485
- /**
1486
- * 2-letter language code in
1487
- * [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1488
- *
1489
- * Default: `"EN"`
1490
- */
1491
- languageCode?: string | null;
1492
- /** Coupon code for the paid plan. Available only in case there is a discount. */
1493
- couponCode?: string | null;
1494
- }
1495
- interface GetUrlResponse {
1496
- /** URL for the Wix checkout page. */
1497
- checkoutUrl?: string;
1498
- /**
1499
- * Token for the Wix checkout page. The token holds all data about the order
1500
- * you're creating a checkout for. It is [signed](),
1501
- * so you can verify that it comes from Wix.
1502
- */
1503
- token?: string | null;
1504
- }
1505
- interface GetPurchaseHistoryRequest {
1506
- }
1507
- interface GetPurchaseHistoryResponse {
1508
- /** Retrieved purchases the site owners have completed for you app. */
1509
- purchases?: PurchasedItem[];
1510
- }
1511
- interface GetUrlResponseNonNullableFields {
1512
- checkoutUrl: string;
1513
- }
1514
- interface PurchasedItemNonNullableFields {
1515
- productId: string;
1516
- price: string;
1517
- currency: string;
1518
- billingCycle: PaymentCycle;
1519
- }
1520
- interface GetPurchaseHistoryResponseNonNullableFields {
1521
- purchases: PurchasedItemNonNullableFields[];
1522
- }
1523
-
1524
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1525
- getUrl: (context: any) => string;
1526
- httpMethod: K;
1527
- path: string;
1528
- pathParams: M;
1529
- __requestType: T;
1530
- __originalRequestType: S;
1531
- __responseType: Q;
1532
- __originalResponseType: R;
1533
- };
1534
- declare function getUrl(): __PublicMethodMetaInfo$1<'POST', {}, GetUrlRequest, GetUrlRequest$1, GetUrlResponse & GetUrlResponseNonNullableFields, GetUrlResponse$1 & GetUrlResponseNonNullableFields$1>;
1535
- declare function getPurchaseHistory(): __PublicMethodMetaInfo$1<'GET', {}, GetPurchaseHistoryRequest, GetPurchaseHistoryRequest$1, GetPurchaseHistoryResponse & GetPurchaseHistoryResponseNonNullableFields, GetPurchaseHistoryResponse$1 & GetPurchaseHistoryResponseNonNullableFields$1>;
1536
-
1537
- declare const meta$1_getPurchaseHistory: typeof getPurchaseHistory;
1538
- declare const meta$1_getUrl: typeof getUrl;
1539
- declare namespace meta$1 {
1540
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_getPurchaseHistory as getPurchaseHistory, meta$1_getUrl as getUrl };
1541
- }
1542
-
1543
- /** Embedded script data */
1544
- interface ScriptProperties$1 {
1545
- /** Script parameters */
1546
- parameters?: Record<string, string>;
1547
- /** Whether script is disabled or not, defaults to false (not disabled) */
1548
- disabled?: boolean;
1549
- }
1550
- interface EmbedScriptRequest$1 {
1551
- /** Details of the script to embed. */
1552
- properties: ScriptProperties$1;
1553
- /** ID of the corresponding embedded script component. */
1554
- componentId?: string | null;
1555
- }
1556
- interface EmbedScriptResponse$1 {
1557
- /** Details of the embedded script. */
1558
- properties?: ScriptProperties$1;
1559
- }
1560
- interface GetEmbeddedScriptRequest$1 {
1561
- /** Component ID of the embedded script to retrieve. */
1562
- componentId?: string | null;
1563
- }
1564
- interface GetEmbeddedScriptResponse$1 {
1565
- /** Details of the retrieved embedded script. */
1566
- properties?: ScriptProperties$1;
1567
- }
1568
- interface ScriptPropertiesNonNullableFields$1 {
1569
- disabled: boolean;
1570
- }
1571
- interface EmbedScriptResponseNonNullableFields$1 {
1572
- properties?: ScriptPropertiesNonNullableFields$1;
1573
- }
1574
- interface GetEmbeddedScriptResponseNonNullableFields$1 {
1575
- properties?: ScriptPropertiesNonNullableFields$1;
1576
- }
1577
-
1578
- /** Embedded script data */
1579
- interface ScriptProperties {
1580
- /** Script parameters */
1581
- parameters?: Record<string, string>;
1582
- /** Whether script is disabled or not, defaults to false (not disabled) */
1583
- disabled?: boolean;
1584
- }
1585
- interface EmbedScriptRequest {
1586
- /** Details of the script to embed. */
1587
- properties: ScriptProperties;
1588
- /** ID of the corresponding embedded script component. */
1589
- componentId?: string | null;
1590
- }
1591
- interface EmbedScriptResponse {
1592
- /** Details of the embedded script. */
1593
- properties?: ScriptProperties;
1594
- }
1595
- interface GetEmbeddedScriptRequest {
1596
- /** Component ID of the embedded script to retrieve. */
1597
- componentId?: string | null;
1598
- }
1599
- interface GetEmbeddedScriptResponse {
1600
- /** Details of the retrieved embedded script. */
1601
- properties?: ScriptProperties;
1602
- }
1603
- interface ScriptPropertiesNonNullableFields {
1604
- disabled: boolean;
1605
- }
1606
- interface EmbedScriptResponseNonNullableFields {
1607
- properties?: ScriptPropertiesNonNullableFields;
1608
- }
1609
- interface GetEmbeddedScriptResponseNonNullableFields {
1610
- properties?: ScriptPropertiesNonNullableFields;
1611
- }
1612
-
1613
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1614
- getUrl: (context: any) => string;
1615
- httpMethod: K;
1616
- path: string;
1617
- pathParams: M;
1618
- __requestType: T;
1619
- __originalRequestType: S;
1620
- __responseType: Q;
1621
- __originalResponseType: R;
1622
- };
1623
- declare function embedScript(): __PublicMethodMetaInfo<'POST', {}, EmbedScriptRequest, EmbedScriptRequest$1, EmbedScriptResponse & EmbedScriptResponseNonNullableFields, EmbedScriptResponse$1 & EmbedScriptResponseNonNullableFields$1>;
1624
- declare function getEmbeddedScript(): __PublicMethodMetaInfo<'GET', {}, GetEmbeddedScriptRequest, GetEmbeddedScriptRequest$1, GetEmbeddedScriptResponse & GetEmbeddedScriptResponseNonNullableFields, GetEmbeddedScriptResponse$1 & GetEmbeddedScriptResponseNonNullableFields$1>;
1625
-
1626
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1627
- declare const meta_embedScript: typeof embedScript;
1628
- declare const meta_getEmbeddedScript: typeof getEmbeddedScript;
1629
- declare namespace meta {
1630
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_embedScript as embedScript, meta_getEmbeddedScript as getEmbeddedScript };
1631
- }
1632
-
1633
- export { meta$3 as appInstances, meta$4 as appPlans, meta$2 as biEvents, meta$1 as billing, meta as embeddedScripts };