@wix/auto_sdk_ecom_payment-settings 1.0.16 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/service-plugins-types.d.ts → index.d.mts} +280 -252
- package/build/{internal/cjs/src/service-plugins-types.d.ts → index.d.ts} +280 -252
- package/build/index.js +561 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +500 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/service-plugins-types.d.ts → internal/index.d.mts} +280 -252
- package/build/internal/{es/src/service-plugins-types.d.ts → index.d.ts} +280 -252
- package/build/internal/index.js +561 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +500 -0
- package/build/internal/index.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -2
- package/build/cjs/index.js +0 -19
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -13
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
- package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -9
- package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
- package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
- package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -161
- package/build/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
- package/build/cjs/src/service-plugins-types.js +0 -417
- package/build/cjs/src/service-plugins-types.js.map +0 -1
- package/build/es/index.d.ts +0 -2
- package/build/es/index.js +0 -3
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -13
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
- package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -6
- package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
- package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
- package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -158
- package/build/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
- package/build/es/src/service-plugins-types.js +0 -414
- package/build/es/src/service-plugins-types.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -2
- package/build/internal/cjs/index.js +0 -19
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -13
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
- package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -9
- package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
- package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
- package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -161
- package/build/internal/cjs/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
- package/build/internal/cjs/src/service-plugins-types.js +0 -417
- package/build/internal/cjs/src/service-plugins-types.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -2
- package/build/internal/es/index.js +0 -3
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -13
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.d.ts +0 -5
- package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js +0 -6
- package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.context.js.map +0 -1
- package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.d.ts +0 -22
- package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js +0 -158
- package/build/internal/es/src/interfaces-ecommerce-v1-payment-settings-provider.public.js.map +0 -1
- package/build/internal/es/src/service-plugins-types.js +0 -414
- package/build/internal/es/src/service-plugins-types.js.map +0 -1
|
@@ -1,8 +1,11 @@
|
|
|
1
|
-
|
|
1
|
+
import { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';
|
|
2
|
+
import { ServicePluginDefinition } from '@wix/sdk-types';
|
|
3
|
+
|
|
4
|
+
interface GetPaymentSettingsRequest {
|
|
2
5
|
/** Order. */
|
|
3
6
|
order?: Order;
|
|
4
7
|
}
|
|
5
|
-
|
|
8
|
+
interface Order {
|
|
6
9
|
/**
|
|
7
10
|
* Order ID.
|
|
8
11
|
* @format GUID
|
|
@@ -170,7 +173,7 @@ export interface Order {
|
|
|
170
173
|
/** Order Location */
|
|
171
174
|
businessLocation?: Location;
|
|
172
175
|
}
|
|
173
|
-
|
|
176
|
+
interface OrderLineItem {
|
|
174
177
|
/**
|
|
175
178
|
* Line item ID.
|
|
176
179
|
* @immutable
|
|
@@ -287,7 +290,7 @@ export interface OrderLineItem {
|
|
|
287
290
|
*/
|
|
288
291
|
extendedFields?: ExtendedFields;
|
|
289
292
|
}
|
|
290
|
-
|
|
293
|
+
interface ProductName {
|
|
291
294
|
/**
|
|
292
295
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
293
296
|
*
|
|
@@ -309,7 +312,7 @@ export interface ProductName {
|
|
|
309
312
|
translated?: string | null;
|
|
310
313
|
}
|
|
311
314
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
312
|
-
|
|
315
|
+
interface CatalogReference {
|
|
313
316
|
/**
|
|
314
317
|
* ID of the item within the catalog it belongs to.
|
|
315
318
|
* @minLength 1
|
|
@@ -335,7 +338,7 @@ export interface CatalogReference {
|
|
|
335
338
|
*/
|
|
336
339
|
options?: Record<string, any> | null;
|
|
337
340
|
}
|
|
338
|
-
|
|
341
|
+
interface Price {
|
|
339
342
|
/**
|
|
340
343
|
* Amount.
|
|
341
344
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -347,7 +350,7 @@ export interface Price {
|
|
|
347
350
|
*/
|
|
348
351
|
formattedAmount?: string;
|
|
349
352
|
}
|
|
350
|
-
|
|
353
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
351
354
|
/** Description line plain text value. */
|
|
352
355
|
plainText?: PlainTextValue;
|
|
353
356
|
/** Description line color value. */
|
|
@@ -356,16 +359,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
356
359
|
name?: DescriptionLineName;
|
|
357
360
|
}
|
|
358
361
|
/** @oneof */
|
|
359
|
-
|
|
362
|
+
interface DescriptionLineValueOneOf {
|
|
360
363
|
/** Description line plain text value. */
|
|
361
364
|
plainText?: PlainTextValue;
|
|
362
365
|
/** Description line color value. */
|
|
363
366
|
colorInfo?: Color;
|
|
364
367
|
}
|
|
365
368
|
/** @oneof */
|
|
366
|
-
|
|
369
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
367
370
|
}
|
|
368
|
-
|
|
371
|
+
interface DescriptionLineName {
|
|
369
372
|
/**
|
|
370
373
|
* Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
371
374
|
* @maxLength 100
|
|
@@ -379,7 +382,7 @@ export interface DescriptionLineName {
|
|
|
379
382
|
*/
|
|
380
383
|
translated?: string | null;
|
|
381
384
|
}
|
|
382
|
-
|
|
385
|
+
interface PlainTextValue {
|
|
383
386
|
/**
|
|
384
387
|
* Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
385
388
|
* @maxLength 600
|
|
@@ -393,7 +396,7 @@ export interface PlainTextValue {
|
|
|
393
396
|
*/
|
|
394
397
|
translated?: string | null;
|
|
395
398
|
}
|
|
396
|
-
|
|
399
|
+
interface Color {
|
|
397
400
|
/**
|
|
398
401
|
* Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
399
402
|
* @maxLength 500
|
|
@@ -409,7 +412,7 @@ export interface Color {
|
|
|
409
412
|
/** HEX or RGB color code for display. */
|
|
410
413
|
code?: string | null;
|
|
411
414
|
}
|
|
412
|
-
|
|
415
|
+
declare enum DescriptionLineType {
|
|
413
416
|
/** Unrecognized type. */
|
|
414
417
|
UNRECOGNISED = "UNRECOGNISED",
|
|
415
418
|
/** Plain text type. */
|
|
@@ -417,7 +420,7 @@ export declare enum DescriptionLineType {
|
|
|
417
420
|
/** Color type. */
|
|
418
421
|
COLOR = "COLOR"
|
|
419
422
|
}
|
|
420
|
-
|
|
423
|
+
interface FocalPoint {
|
|
421
424
|
/** X-coordinate of the focal point. */
|
|
422
425
|
x?: number;
|
|
423
426
|
/** Y-coordinate of the focal point. */
|
|
@@ -427,7 +430,7 @@ export interface FocalPoint {
|
|
|
427
430
|
/** crop by width */
|
|
428
431
|
width?: number | null;
|
|
429
432
|
}
|
|
430
|
-
|
|
433
|
+
interface PhysicalProperties {
|
|
431
434
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
432
435
|
weight?: number | null;
|
|
433
436
|
/**
|
|
@@ -438,20 +441,20 @@ export interface PhysicalProperties {
|
|
|
438
441
|
/** Whether this line item is shippable. */
|
|
439
442
|
shippable?: boolean;
|
|
440
443
|
}
|
|
441
|
-
|
|
444
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
442
445
|
/** Preset item type. */
|
|
443
446
|
preset?: ItemTypeItemType;
|
|
444
447
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
445
448
|
custom?: string;
|
|
446
449
|
}
|
|
447
450
|
/** @oneof */
|
|
448
|
-
|
|
451
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
449
452
|
/** Preset item type. */
|
|
450
453
|
preset?: ItemTypeItemType;
|
|
451
454
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
452
455
|
custom?: string;
|
|
453
456
|
}
|
|
454
|
-
|
|
457
|
+
declare enum ItemTypeItemType {
|
|
455
458
|
UNRECOGNISED = "UNRECOGNISED",
|
|
456
459
|
PHYSICAL = "PHYSICAL",
|
|
457
460
|
DIGITAL = "DIGITAL",
|
|
@@ -459,7 +462,7 @@ export declare enum ItemTypeItemType {
|
|
|
459
462
|
SERVICE = "SERVICE"
|
|
460
463
|
}
|
|
461
464
|
/** Type of selected payment option for catalog item */
|
|
462
|
-
|
|
465
|
+
declare enum PaymentOptionType {
|
|
463
466
|
/** The entire payment for this item happens as part of the checkout. */
|
|
464
467
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
465
468
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -471,7 +474,7 @@ export declare enum PaymentOptionType {
|
|
|
471
474
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
472
475
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
473
476
|
}
|
|
474
|
-
|
|
477
|
+
interface ItemTaxFullDetails {
|
|
475
478
|
/** Taxable amount of this line item. */
|
|
476
479
|
taxableAmount?: Price;
|
|
477
480
|
/**
|
|
@@ -482,7 +485,7 @@ export interface ItemTaxFullDetails {
|
|
|
482
485
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
483
486
|
totalTax?: Price;
|
|
484
487
|
}
|
|
485
|
-
|
|
488
|
+
interface LineItemTaxInfo {
|
|
486
489
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
487
490
|
taxAmount?: Price;
|
|
488
491
|
/** Amount for which tax is calculated. */
|
|
@@ -510,7 +513,7 @@ export interface LineItemTaxInfo {
|
|
|
510
513
|
* TaxBreakdown represents tax information for a line item.
|
|
511
514
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
512
515
|
*/
|
|
513
|
-
|
|
516
|
+
interface LineItemTaxBreakdown {
|
|
514
517
|
/**
|
|
515
518
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
516
519
|
* @maxLength 200
|
|
@@ -543,7 +546,7 @@ export interface LineItemTaxBreakdown {
|
|
|
543
546
|
taxableAmount?: Price;
|
|
544
547
|
}
|
|
545
548
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
546
|
-
|
|
549
|
+
declare enum JurisdictionType {
|
|
547
550
|
UNDEFINED = "UNDEFINED",
|
|
548
551
|
COUNTRY = "COUNTRY",
|
|
549
552
|
STATE = "STATE",
|
|
@@ -551,7 +554,7 @@ export declare enum JurisdictionType {
|
|
|
551
554
|
CITY = "CITY",
|
|
552
555
|
SPECIAL = "SPECIAL"
|
|
553
556
|
}
|
|
554
|
-
|
|
557
|
+
interface DigitalFile {
|
|
555
558
|
/**
|
|
556
559
|
* ID of the secure file in media.
|
|
557
560
|
* @minLength 1
|
|
@@ -571,7 +574,7 @@ export interface DigitalFile {
|
|
|
571
574
|
*/
|
|
572
575
|
expirationDate?: Date | null;
|
|
573
576
|
}
|
|
574
|
-
|
|
577
|
+
interface SubscriptionInfo {
|
|
575
578
|
/**
|
|
576
579
|
* Subscription ID.
|
|
577
580
|
* @format GUID
|
|
@@ -604,7 +607,7 @@ export interface SubscriptionInfo {
|
|
|
604
607
|
*/
|
|
605
608
|
subscriptionSettings?: SubscriptionSettings;
|
|
606
609
|
}
|
|
607
|
-
|
|
610
|
+
interface SubscriptionTitle {
|
|
608
611
|
/**
|
|
609
612
|
* Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
610
613
|
* @minLength 1
|
|
@@ -620,7 +623,7 @@ export interface SubscriptionTitle {
|
|
|
620
623
|
*/
|
|
621
624
|
translated?: string | null;
|
|
622
625
|
}
|
|
623
|
-
|
|
626
|
+
interface SubscriptionDescription {
|
|
624
627
|
/**
|
|
625
628
|
* Subscription option description.
|
|
626
629
|
* @maxLength 500
|
|
@@ -632,7 +635,7 @@ export interface SubscriptionDescription {
|
|
|
632
635
|
*/
|
|
633
636
|
translated?: string | null;
|
|
634
637
|
}
|
|
635
|
-
|
|
638
|
+
interface SubscriptionSettings {
|
|
636
639
|
/** Frequency of recurring payment. */
|
|
637
640
|
frequency?: SubscriptionFrequency;
|
|
638
641
|
/**
|
|
@@ -650,14 +653,14 @@ export interface SubscriptionSettings {
|
|
|
650
653
|
billingCycles?: number | null;
|
|
651
654
|
}
|
|
652
655
|
/** Frequency unit of recurring payment */
|
|
653
|
-
|
|
656
|
+
declare enum SubscriptionFrequency {
|
|
654
657
|
UNDEFINED = "UNDEFINED",
|
|
655
658
|
DAY = "DAY",
|
|
656
659
|
WEEK = "WEEK",
|
|
657
660
|
MONTH = "MONTH",
|
|
658
661
|
YEAR = "YEAR"
|
|
659
662
|
}
|
|
660
|
-
|
|
663
|
+
interface FreeTrialPeriod {
|
|
661
664
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
662
665
|
frequency?: SubscriptionFrequency;
|
|
663
666
|
/**
|
|
@@ -667,20 +670,20 @@ export interface FreeTrialPeriod {
|
|
|
667
670
|
*/
|
|
668
671
|
interval?: number;
|
|
669
672
|
}
|
|
670
|
-
|
|
673
|
+
interface BillingAdjustment {
|
|
671
674
|
/** The type of adjustment. */
|
|
672
675
|
type?: AdjustmentType;
|
|
673
676
|
/** Summary of the prorated adjustment amount. */
|
|
674
677
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
675
678
|
}
|
|
676
|
-
|
|
679
|
+
declare enum AdjustmentType {
|
|
677
680
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
678
681
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
679
682
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
680
683
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
681
684
|
CREDIT = "CREDIT"
|
|
682
685
|
}
|
|
683
|
-
|
|
686
|
+
interface BillingAdjustmentPriceSummary {
|
|
684
687
|
/** Subtotal of adjustment, before tax. */
|
|
685
688
|
subtotal?: Price;
|
|
686
689
|
/** Tax on adjustment. */
|
|
@@ -688,7 +691,7 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
688
691
|
/** Total price after tax. */
|
|
689
692
|
total?: Price;
|
|
690
693
|
}
|
|
691
|
-
|
|
694
|
+
interface PriceDescription {
|
|
692
695
|
/**
|
|
693
696
|
* __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
694
697
|
* @minLength 1
|
|
@@ -704,7 +707,7 @@ export interface PriceDescription {
|
|
|
704
707
|
*/
|
|
705
708
|
translated?: string | null;
|
|
706
709
|
}
|
|
707
|
-
|
|
710
|
+
interface LocationAndQuantity {
|
|
708
711
|
/**
|
|
709
712
|
* Location id in the associated owner app.
|
|
710
713
|
* @format GUID
|
|
@@ -730,22 +733,22 @@ export interface LocationAndQuantity {
|
|
|
730
733
|
*/
|
|
731
734
|
name?: string | null;
|
|
732
735
|
}
|
|
733
|
-
|
|
736
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
734
737
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
735
738
|
addressType?: TaxableAddressType;
|
|
736
739
|
}
|
|
737
740
|
/** @oneof */
|
|
738
|
-
|
|
741
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
739
742
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
740
743
|
addressType?: TaxableAddressType;
|
|
741
744
|
}
|
|
742
|
-
|
|
745
|
+
declare enum TaxableAddressType {
|
|
743
746
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
744
747
|
BUSINESS = "BUSINESS",
|
|
745
748
|
BILLING = "BILLING",
|
|
746
749
|
SHIPPING = "SHIPPING"
|
|
747
750
|
}
|
|
748
|
-
|
|
751
|
+
interface ExtendedFields {
|
|
749
752
|
/**
|
|
750
753
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
751
754
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -757,7 +760,7 @@ export interface ExtendedFields {
|
|
|
757
760
|
namespaces?: Record<string, Record<string, any>>;
|
|
758
761
|
}
|
|
759
762
|
/** Buyer Info */
|
|
760
|
-
|
|
763
|
+
interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
761
764
|
/**
|
|
762
765
|
* Visitor ID (if site visitor is not a member).
|
|
763
766
|
* @format GUID
|
|
@@ -780,7 +783,7 @@ export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
|
780
783
|
email?: string | null;
|
|
781
784
|
}
|
|
782
785
|
/** @oneof */
|
|
783
|
-
|
|
786
|
+
interface V1BuyerInfoIdOneOf {
|
|
784
787
|
/**
|
|
785
788
|
* Visitor ID (if site visitor is not a member).
|
|
786
789
|
* @format GUID
|
|
@@ -792,7 +795,7 @@ export interface V1BuyerInfoIdOneOf {
|
|
|
792
795
|
*/
|
|
793
796
|
memberId?: string;
|
|
794
797
|
}
|
|
795
|
-
|
|
798
|
+
declare enum PaymentStatus {
|
|
796
799
|
UNSPECIFIED = "UNSPECIFIED",
|
|
797
800
|
/**
|
|
798
801
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -833,7 +836,7 @@ export declare enum PaymentStatus {
|
|
|
833
836
|
*/
|
|
834
837
|
DECLINED = "DECLINED"
|
|
835
838
|
}
|
|
836
|
-
|
|
839
|
+
declare enum FulfillmentStatus {
|
|
837
840
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
838
841
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
839
842
|
/**
|
|
@@ -844,7 +847,7 @@ export declare enum FulfillmentStatus {
|
|
|
844
847
|
/** Some, but not all, of the order items are fulfilled. */
|
|
845
848
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
846
849
|
}
|
|
847
|
-
|
|
850
|
+
declare enum WeightUnit {
|
|
848
851
|
/** Weight unit can't be classified due to an error. */
|
|
849
852
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
850
853
|
/** Kilograms. */
|
|
@@ -852,7 +855,7 @@ export declare enum WeightUnit {
|
|
|
852
855
|
/** Pounds. */
|
|
853
856
|
LB = "LB"
|
|
854
857
|
}
|
|
855
|
-
|
|
858
|
+
interface CurrencyConversionDetails {
|
|
856
859
|
/**
|
|
857
860
|
* Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
858
861
|
* @readonly
|
|
@@ -868,7 +871,7 @@ export interface CurrencyConversionDetails {
|
|
|
868
871
|
*/
|
|
869
872
|
conversionRate?: string | null;
|
|
870
873
|
}
|
|
871
|
-
|
|
874
|
+
interface PriceSummary {
|
|
872
875
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
873
876
|
subtotal?: Price;
|
|
874
877
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -883,14 +886,14 @@ export interface PriceSummary {
|
|
|
883
886
|
totalAdditionalFees?: Price;
|
|
884
887
|
}
|
|
885
888
|
/** Billing Info and shipping details */
|
|
886
|
-
|
|
889
|
+
interface ApiAddressWithContact {
|
|
887
890
|
/** Address. */
|
|
888
891
|
address?: Address;
|
|
889
892
|
/** Contact details. */
|
|
890
893
|
contactDetails?: FullAddressContactDetails;
|
|
891
894
|
}
|
|
892
895
|
/** Physical address */
|
|
893
|
-
|
|
896
|
+
interface Address {
|
|
894
897
|
/**
|
|
895
898
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
896
899
|
* @format COUNTRY
|
|
@@ -934,20 +937,20 @@ export interface Address {
|
|
|
934
937
|
*/
|
|
935
938
|
subdivisionFullname?: string | null;
|
|
936
939
|
}
|
|
937
|
-
|
|
940
|
+
interface StreetAddress {
|
|
938
941
|
/** Street number. */
|
|
939
942
|
number?: string;
|
|
940
943
|
/** Street name. */
|
|
941
944
|
name?: string;
|
|
942
945
|
}
|
|
943
|
-
|
|
946
|
+
interface AddressLocation {
|
|
944
947
|
/** Address latitude. */
|
|
945
948
|
latitude?: number | null;
|
|
946
949
|
/** Address longitude. */
|
|
947
950
|
longitude?: number | null;
|
|
948
951
|
}
|
|
949
952
|
/** Full contact details for an address */
|
|
950
|
-
|
|
953
|
+
interface FullAddressContactDetails {
|
|
951
954
|
/**
|
|
952
955
|
* First name.
|
|
953
956
|
* @maxLength 100
|
|
@@ -971,7 +974,7 @@ export interface FullAddressContactDetails {
|
|
|
971
974
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
972
975
|
vatId?: VatId;
|
|
973
976
|
}
|
|
974
|
-
|
|
977
|
+
interface VatId {
|
|
975
978
|
/** Customer's tax ID. */
|
|
976
979
|
_id?: string;
|
|
977
980
|
/**
|
|
@@ -984,14 +987,14 @@ export interface VatId {
|
|
|
984
987
|
type?: VatType;
|
|
985
988
|
}
|
|
986
989
|
/** tax info types */
|
|
987
|
-
|
|
990
|
+
declare enum VatType {
|
|
988
991
|
UNSPECIFIED = "UNSPECIFIED",
|
|
989
992
|
/** CPF - for individual tax payers. */
|
|
990
993
|
CPF = "CPF",
|
|
991
994
|
/** CNPJ - for corporations */
|
|
992
995
|
CNPJ = "CNPJ"
|
|
993
996
|
}
|
|
994
|
-
|
|
997
|
+
interface V1ShippingInformation {
|
|
995
998
|
/**
|
|
996
999
|
* App Def Id of external provider which was a source of shipping info
|
|
997
1000
|
* @minLength 1
|
|
@@ -1017,7 +1020,7 @@ export interface V1ShippingInformation {
|
|
|
1017
1020
|
/** Shipping region. */
|
|
1018
1021
|
region?: ShippingRegion;
|
|
1019
1022
|
}
|
|
1020
|
-
|
|
1023
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1021
1024
|
/** Shipping address and contact details. */
|
|
1022
1025
|
shippingDestination?: ApiAddressWithContact;
|
|
1023
1026
|
/** Pickup details. */
|
|
@@ -1041,20 +1044,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1041
1044
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1042
1045
|
}
|
|
1043
1046
|
/** @oneof */
|
|
1044
|
-
|
|
1047
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
1045
1048
|
/** Shipping address and contact details. */
|
|
1046
1049
|
shippingDestination?: ApiAddressWithContact;
|
|
1047
1050
|
/** Pickup details. */
|
|
1048
1051
|
pickupDetails?: PickupDetails;
|
|
1049
1052
|
}
|
|
1050
|
-
|
|
1053
|
+
interface PickupDetails {
|
|
1051
1054
|
/** Pickup address. */
|
|
1052
1055
|
address?: PickupAddress;
|
|
1053
1056
|
/** Pickup method */
|
|
1054
1057
|
pickupMethod?: PickupMethod;
|
|
1055
1058
|
}
|
|
1056
1059
|
/** Physical address */
|
|
1057
|
-
|
|
1060
|
+
interface PickupAddress {
|
|
1058
1061
|
/**
|
|
1059
1062
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1060
1063
|
* @format COUNTRY
|
|
@@ -1098,18 +1101,18 @@ export interface PickupAddress {
|
|
|
1098
1101
|
*/
|
|
1099
1102
|
subdivisionFullname?: string | null;
|
|
1100
1103
|
}
|
|
1101
|
-
|
|
1104
|
+
declare enum PickupMethod {
|
|
1102
1105
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1103
1106
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1104
1107
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1105
1108
|
}
|
|
1106
|
-
|
|
1109
|
+
interface DeliveryTimeSlot {
|
|
1107
1110
|
/** Delivery slot starting time. */
|
|
1108
1111
|
from?: Date | null;
|
|
1109
1112
|
/** Delivery slot ending time. */
|
|
1110
1113
|
to?: Date | null;
|
|
1111
1114
|
}
|
|
1112
|
-
|
|
1115
|
+
interface ShippingPrice {
|
|
1113
1116
|
/** Shipping price for display purposes. */
|
|
1114
1117
|
price?: Price;
|
|
1115
1118
|
/**
|
|
@@ -1130,14 +1133,14 @@ export interface ShippingPrice {
|
|
|
1130
1133
|
*/
|
|
1131
1134
|
discount?: Price;
|
|
1132
1135
|
}
|
|
1133
|
-
|
|
1136
|
+
interface ShippingRegion {
|
|
1134
1137
|
/**
|
|
1135
1138
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1136
1139
|
* @maxLength 100
|
|
1137
1140
|
*/
|
|
1138
1141
|
name?: string | null;
|
|
1139
1142
|
}
|
|
1140
|
-
|
|
1143
|
+
declare enum OrderStatus {
|
|
1141
1144
|
/** Order created, but not yet approved or canceled. */
|
|
1142
1145
|
INITIALIZED = "INITIALIZED",
|
|
1143
1146
|
/**
|
|
@@ -1162,14 +1165,14 @@ export declare enum OrderStatus {
|
|
|
1162
1165
|
*/
|
|
1163
1166
|
REJECTED = "REJECTED"
|
|
1164
1167
|
}
|
|
1165
|
-
|
|
1168
|
+
interface TaxSummary {
|
|
1166
1169
|
/**
|
|
1167
1170
|
* Total tax.
|
|
1168
1171
|
* @readonly
|
|
1169
1172
|
*/
|
|
1170
1173
|
totalTax?: Price;
|
|
1171
1174
|
}
|
|
1172
|
-
|
|
1175
|
+
interface OrderTaxInfo {
|
|
1173
1176
|
/** Calculated tax, added from line items. */
|
|
1174
1177
|
totalTax?: Price;
|
|
1175
1178
|
/**
|
|
@@ -1189,7 +1192,7 @@ export interface OrderTaxInfo {
|
|
|
1189
1192
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1190
1193
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1191
1194
|
*/
|
|
1192
|
-
|
|
1195
|
+
interface OrderTaxBreakdown {
|
|
1193
1196
|
/**
|
|
1194
1197
|
* The name of the tax against which this tax amount was calculated.
|
|
1195
1198
|
* @maxLength 200
|
|
@@ -1216,7 +1219,7 @@ export interface OrderTaxBreakdown {
|
|
|
1216
1219
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1217
1220
|
aggregatedTaxAmount?: Price;
|
|
1218
1221
|
}
|
|
1219
|
-
|
|
1222
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1220
1223
|
/** Applied coupon info. */
|
|
1221
1224
|
coupon?: Coupon;
|
|
1222
1225
|
/** Merchant discount. */
|
|
@@ -1249,7 +1252,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1249
1252
|
_id?: string | null;
|
|
1250
1253
|
}
|
|
1251
1254
|
/** @oneof */
|
|
1252
|
-
|
|
1255
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1253
1256
|
/** Applied coupon info. */
|
|
1254
1257
|
coupon?: Coupon;
|
|
1255
1258
|
/** Merchant discount. */
|
|
@@ -1257,13 +1260,13 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1257
1260
|
/** Automatic Discount */
|
|
1258
1261
|
discountRule?: DiscountRule;
|
|
1259
1262
|
}
|
|
1260
|
-
|
|
1263
|
+
declare enum DiscountType {
|
|
1261
1264
|
GLOBAL = "GLOBAL",
|
|
1262
1265
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1263
1266
|
SHIPPING = "SHIPPING"
|
|
1264
1267
|
}
|
|
1265
1268
|
/** Coupon */
|
|
1266
|
-
|
|
1269
|
+
interface Coupon {
|
|
1267
1270
|
/** Coupon ID. */
|
|
1268
1271
|
_id?: string;
|
|
1269
1272
|
/** Coupon code. */
|
|
@@ -1273,7 +1276,7 @@ export interface Coupon {
|
|
|
1273
1276
|
/** Coupon value. */
|
|
1274
1277
|
amount?: Price;
|
|
1275
1278
|
}
|
|
1276
|
-
|
|
1279
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1277
1280
|
/**
|
|
1278
1281
|
* Pre-defined discount reason (optional).
|
|
1279
1282
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1288,7 +1291,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1288
1291
|
amount?: Price;
|
|
1289
1292
|
}
|
|
1290
1293
|
/** @oneof */
|
|
1291
|
-
|
|
1294
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1292
1295
|
/**
|
|
1293
1296
|
* Pre-defined discount reason (optional).
|
|
1294
1297
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1300,12 +1303,12 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1300
1303
|
*/
|
|
1301
1304
|
description?: string | null;
|
|
1302
1305
|
}
|
|
1303
|
-
|
|
1306
|
+
declare enum DiscountReason {
|
|
1304
1307
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1305
1308
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1306
1309
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1307
1310
|
}
|
|
1308
|
-
|
|
1311
|
+
interface DiscountRule {
|
|
1309
1312
|
/**
|
|
1310
1313
|
* Discount rule ID
|
|
1311
1314
|
* @format GUID
|
|
@@ -1316,7 +1319,7 @@ export interface DiscountRule {
|
|
|
1316
1319
|
/** Discount value. */
|
|
1317
1320
|
amount?: Price;
|
|
1318
1321
|
}
|
|
1319
|
-
|
|
1322
|
+
interface DiscountRuleName {
|
|
1320
1323
|
/**
|
|
1321
1324
|
* Original discount rule name (in site's default language).
|
|
1322
1325
|
* @minLength 1
|
|
@@ -1330,7 +1333,7 @@ export interface DiscountRuleName {
|
|
|
1330
1333
|
*/
|
|
1331
1334
|
translated?: string | null;
|
|
1332
1335
|
}
|
|
1333
|
-
|
|
1336
|
+
interface LineItemDiscount {
|
|
1334
1337
|
/**
|
|
1335
1338
|
* ID of line item the discount applies to.
|
|
1336
1339
|
* @format GUID
|
|
@@ -1339,7 +1342,7 @@ export interface LineItemDiscount {
|
|
|
1339
1342
|
/** Total discount for this line item. */
|
|
1340
1343
|
totalDiscount?: Price;
|
|
1341
1344
|
}
|
|
1342
|
-
|
|
1345
|
+
interface Activity extends ActivityContentOneOf {
|
|
1343
1346
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1344
1347
|
customActivity?: CustomActivity;
|
|
1345
1348
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -1367,7 +1370,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
1367
1370
|
type?: ActivityType;
|
|
1368
1371
|
}
|
|
1369
1372
|
/** @oneof */
|
|
1370
|
-
|
|
1373
|
+
interface ActivityContentOneOf {
|
|
1371
1374
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1372
1375
|
customActivity?: CustomActivity;
|
|
1373
1376
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -1375,7 +1378,7 @@ export interface ActivityContentOneOf {
|
|
|
1375
1378
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1376
1379
|
orderRefunded?: OrderRefunded;
|
|
1377
1380
|
}
|
|
1378
|
-
|
|
1381
|
+
interface CustomActivity {
|
|
1379
1382
|
/**
|
|
1380
1383
|
* ID of the app that created the custom activity.
|
|
1381
1384
|
* @format GUID
|
|
@@ -1390,7 +1393,7 @@ export interface CustomActivity {
|
|
|
1390
1393
|
additionalData?: Record<string, string>;
|
|
1391
1394
|
}
|
|
1392
1395
|
/** Store owner added a comment */
|
|
1393
|
-
|
|
1396
|
+
interface MerchantComment {
|
|
1394
1397
|
/**
|
|
1395
1398
|
* Merchant comment message.
|
|
1396
1399
|
* @minLength 1
|
|
@@ -1398,7 +1401,7 @@ export interface MerchantComment {
|
|
|
1398
1401
|
*/
|
|
1399
1402
|
message?: string;
|
|
1400
1403
|
}
|
|
1401
|
-
|
|
1404
|
+
interface OrderRefunded {
|
|
1402
1405
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
1403
1406
|
manual?: boolean;
|
|
1404
1407
|
/** Refund amount. */
|
|
@@ -1409,14 +1412,14 @@ export interface OrderRefunded {
|
|
|
1409
1412
|
*/
|
|
1410
1413
|
reason?: string;
|
|
1411
1414
|
}
|
|
1412
|
-
|
|
1415
|
+
interface OrderCreatedFromExchange {
|
|
1413
1416
|
/**
|
|
1414
1417
|
* ID of the original order for which the exchange happened.
|
|
1415
1418
|
* @format GUID
|
|
1416
1419
|
*/
|
|
1417
1420
|
originalOrderId?: string;
|
|
1418
1421
|
}
|
|
1419
|
-
|
|
1422
|
+
interface NewExchangeOrderCreated {
|
|
1420
1423
|
/**
|
|
1421
1424
|
* ID of the new order created as a result of an exchange of items.
|
|
1422
1425
|
* @format GUID
|
|
@@ -1429,7 +1432,7 @@ export interface NewExchangeOrderCreated {
|
|
|
1429
1432
|
*/
|
|
1430
1433
|
lineItems?: LineItemExchangeData[];
|
|
1431
1434
|
}
|
|
1432
|
-
|
|
1435
|
+
interface LineItemExchangeData {
|
|
1433
1436
|
/**
|
|
1434
1437
|
* ID of the exchanged line item.
|
|
1435
1438
|
* @format GUID
|
|
@@ -1442,7 +1445,7 @@ export interface LineItemExchangeData {
|
|
|
1442
1445
|
*/
|
|
1443
1446
|
quantity?: number;
|
|
1444
1447
|
}
|
|
1445
|
-
|
|
1448
|
+
interface DraftOrderChangesApplied {
|
|
1446
1449
|
/** Draft order id. */
|
|
1447
1450
|
draftOrderId?: string;
|
|
1448
1451
|
/**
|
|
@@ -1453,7 +1456,7 @@ export interface DraftOrderChangesApplied {
|
|
|
1453
1456
|
/** Changes applied to order. */
|
|
1454
1457
|
changes?: OrderChange[];
|
|
1455
1458
|
}
|
|
1456
|
-
|
|
1459
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
1457
1460
|
lineItemChanged?: LineItemChanges;
|
|
1458
1461
|
lineItemAdded?: ManagedLineItem;
|
|
1459
1462
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1465,7 +1468,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
1465
1468
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1466
1469
|
}
|
|
1467
1470
|
/** @oneof */
|
|
1468
|
-
|
|
1471
|
+
interface OrderChangeValueOneOf {
|
|
1469
1472
|
lineItemChanged?: LineItemChanges;
|
|
1470
1473
|
lineItemAdded?: ManagedLineItem;
|
|
1471
1474
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1476,7 +1479,7 @@ export interface OrderChangeValueOneOf {
|
|
|
1476
1479
|
totalPriceChanged?: TotalPriceChange;
|
|
1477
1480
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1478
1481
|
}
|
|
1479
|
-
|
|
1482
|
+
interface LineItemChanges {
|
|
1480
1483
|
/**
|
|
1481
1484
|
* Line item ID.
|
|
1482
1485
|
* @format GUID
|
|
@@ -1489,7 +1492,7 @@ export interface LineItemChanges {
|
|
|
1489
1492
|
/** Item price change. */
|
|
1490
1493
|
price?: LineItemPriceChange;
|
|
1491
1494
|
}
|
|
1492
|
-
|
|
1495
|
+
interface LineItemQuantityChange {
|
|
1493
1496
|
/**
|
|
1494
1497
|
* Item quantity before update.
|
|
1495
1498
|
* @max 1000000
|
|
@@ -1509,19 +1512,19 @@ export interface LineItemQuantityChange {
|
|
|
1509
1512
|
/** Type of quantity change: increase or decrease. */
|
|
1510
1513
|
deltaType?: LineItemQuantityChangeType;
|
|
1511
1514
|
}
|
|
1512
|
-
|
|
1515
|
+
declare enum LineItemQuantityChangeType {
|
|
1513
1516
|
/** Quantity increased. */
|
|
1514
1517
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
1515
1518
|
/** Quantity decreased. */
|
|
1516
1519
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1517
1520
|
}
|
|
1518
|
-
|
|
1521
|
+
interface LineItemPriceChange {
|
|
1519
1522
|
/** Item price before update. */
|
|
1520
1523
|
originalPrice?: Price;
|
|
1521
1524
|
/** Item price after update. */
|
|
1522
1525
|
newPrice?: Price;
|
|
1523
1526
|
}
|
|
1524
|
-
|
|
1527
|
+
interface ManagedLineItem {
|
|
1525
1528
|
/**
|
|
1526
1529
|
* Line item ID.
|
|
1527
1530
|
* @format GUID
|
|
@@ -1536,7 +1539,7 @@ export interface ManagedLineItem {
|
|
|
1536
1539
|
*/
|
|
1537
1540
|
quantity?: number;
|
|
1538
1541
|
}
|
|
1539
|
-
|
|
1542
|
+
interface ManagedDiscount {
|
|
1540
1543
|
/**
|
|
1541
1544
|
* Discount id.
|
|
1542
1545
|
* @format GUID
|
|
@@ -1549,7 +1552,7 @@ export interface ManagedDiscount {
|
|
|
1549
1552
|
/** Discount amount. */
|
|
1550
1553
|
totalAmount?: Price;
|
|
1551
1554
|
}
|
|
1552
|
-
|
|
1555
|
+
interface TranslatedValue {
|
|
1553
1556
|
/**
|
|
1554
1557
|
* Value in site default language.
|
|
1555
1558
|
* @minLength 1
|
|
@@ -1561,7 +1564,7 @@ export interface TranslatedValue {
|
|
|
1561
1564
|
*/
|
|
1562
1565
|
translated?: string | null;
|
|
1563
1566
|
}
|
|
1564
|
-
|
|
1567
|
+
interface LineItemAmount {
|
|
1565
1568
|
/**
|
|
1566
1569
|
* Order line item id
|
|
1567
1570
|
* @format GUID
|
|
@@ -1572,7 +1575,7 @@ export interface LineItemAmount {
|
|
|
1572
1575
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
1573
1576
|
amount?: Price;
|
|
1574
1577
|
}
|
|
1575
|
-
|
|
1578
|
+
interface ManagedAdditionalFee {
|
|
1576
1579
|
/**
|
|
1577
1580
|
* Additional fee id.
|
|
1578
1581
|
* @format GUID
|
|
@@ -1585,19 +1588,19 @@ export interface ManagedAdditionalFee {
|
|
|
1585
1588
|
/** Additional fee amount. */
|
|
1586
1589
|
totalAmount?: Price;
|
|
1587
1590
|
}
|
|
1588
|
-
|
|
1591
|
+
interface TotalPriceChange {
|
|
1589
1592
|
/** Order’s total price after discounts and tax. Before update */
|
|
1590
1593
|
originalTotal?: Price;
|
|
1591
1594
|
/** Order’s total price after discounts and tax. After update */
|
|
1592
1595
|
newTotal?: Price;
|
|
1593
1596
|
}
|
|
1594
|
-
|
|
1597
|
+
interface ShippingInformationChange {
|
|
1595
1598
|
/** Order’s Shipping Information. Before update */
|
|
1596
1599
|
originalShippingInfo?: ShippingInformation;
|
|
1597
1600
|
/** Order’s Shipping Information. After update */
|
|
1598
1601
|
newShippingInfo?: ShippingInformation;
|
|
1599
1602
|
}
|
|
1600
|
-
|
|
1603
|
+
interface ShippingInformation {
|
|
1601
1604
|
/** Order’s shipping price. */
|
|
1602
1605
|
total?: Price;
|
|
1603
1606
|
/**
|
|
@@ -1607,7 +1610,7 @@ export interface ShippingInformation {
|
|
|
1607
1610
|
shippingTitle?: string;
|
|
1608
1611
|
}
|
|
1609
1612
|
/** Payment method is saved for order */
|
|
1610
|
-
|
|
1613
|
+
interface SavedPaymentMethod {
|
|
1611
1614
|
/**
|
|
1612
1615
|
* Payment method name
|
|
1613
1616
|
* @minLength 1
|
|
@@ -1621,7 +1624,7 @@ export interface SavedPaymentMethod {
|
|
|
1621
1624
|
*/
|
|
1622
1625
|
description?: string | null;
|
|
1623
1626
|
}
|
|
1624
|
-
|
|
1627
|
+
interface AuthorizedPaymentCreated {
|
|
1625
1628
|
/**
|
|
1626
1629
|
* Payment ID of payment associated with this activity
|
|
1627
1630
|
* @format GUID
|
|
@@ -1640,7 +1643,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
1640
1643
|
*/
|
|
1641
1644
|
brand?: string | null;
|
|
1642
1645
|
}
|
|
1643
|
-
|
|
1646
|
+
interface AuthorizedPaymentCaptured {
|
|
1644
1647
|
/**
|
|
1645
1648
|
* Payment ID of payment associated with this activity
|
|
1646
1649
|
* @format GUID
|
|
@@ -1659,7 +1662,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
1659
1662
|
*/
|
|
1660
1663
|
brand?: string | null;
|
|
1661
1664
|
}
|
|
1662
|
-
|
|
1665
|
+
interface AuthorizedPaymentVoided {
|
|
1663
1666
|
/**
|
|
1664
1667
|
* Payment ID of payment associated with this activity
|
|
1665
1668
|
* @format GUID
|
|
@@ -1678,7 +1681,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
1678
1681
|
*/
|
|
1679
1682
|
brand?: string | null;
|
|
1680
1683
|
}
|
|
1681
|
-
|
|
1684
|
+
interface RefundInitiated {
|
|
1682
1685
|
/**
|
|
1683
1686
|
* Refund ID.
|
|
1684
1687
|
* @format GUID
|
|
@@ -1698,7 +1701,7 @@ export interface RefundInitiated {
|
|
|
1698
1701
|
*/
|
|
1699
1702
|
reason?: string | null;
|
|
1700
1703
|
}
|
|
1701
|
-
|
|
1704
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
1702
1705
|
/** Regular payment refund. */
|
|
1703
1706
|
regular?: RegularPaymentRefund;
|
|
1704
1707
|
/** Gift card payment refund. */
|
|
@@ -1714,7 +1717,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
1714
1717
|
externalRefund?: boolean;
|
|
1715
1718
|
}
|
|
1716
1719
|
/** @oneof */
|
|
1717
|
-
|
|
1720
|
+
interface RefundedPaymentKindOneOf {
|
|
1718
1721
|
/** Regular payment refund. */
|
|
1719
1722
|
regular?: RegularPaymentRefund;
|
|
1720
1723
|
/** Gift card payment refund. */
|
|
@@ -1722,7 +1725,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
1722
1725
|
/** Membership payment refund. */
|
|
1723
1726
|
membership?: MembershipPaymentRefund;
|
|
1724
1727
|
}
|
|
1725
|
-
|
|
1728
|
+
interface RegularPaymentRefund {
|
|
1726
1729
|
/** Refund amount */
|
|
1727
1730
|
amount?: Price;
|
|
1728
1731
|
/**
|
|
@@ -1736,7 +1739,7 @@ export interface RegularPaymentRefund {
|
|
|
1736
1739
|
*/
|
|
1737
1740
|
brand?: string | null;
|
|
1738
1741
|
}
|
|
1739
|
-
|
|
1742
|
+
interface GiftCardPaymentRefund {
|
|
1740
1743
|
/**
|
|
1741
1744
|
* Gift card payment ID
|
|
1742
1745
|
* @minLength 1
|
|
@@ -1746,7 +1749,7 @@ export interface GiftCardPaymentRefund {
|
|
|
1746
1749
|
/** Refund amount */
|
|
1747
1750
|
amount?: Price;
|
|
1748
1751
|
}
|
|
1749
|
-
|
|
1752
|
+
interface MembershipPaymentRefund {
|
|
1750
1753
|
/**
|
|
1751
1754
|
* Membership ID
|
|
1752
1755
|
* @minLength 1
|
|
@@ -1754,7 +1757,7 @@ export interface MembershipPaymentRefund {
|
|
|
1754
1757
|
*/
|
|
1755
1758
|
membershipId?: string | null;
|
|
1756
1759
|
}
|
|
1757
|
-
|
|
1760
|
+
interface PaymentRefunded {
|
|
1758
1761
|
/**
|
|
1759
1762
|
* Refund ID.
|
|
1760
1763
|
* @format GUID
|
|
@@ -1763,7 +1766,7 @@ export interface PaymentRefunded {
|
|
|
1763
1766
|
/** Details about the refunded payment. */
|
|
1764
1767
|
payment?: RefundedPayment;
|
|
1765
1768
|
}
|
|
1766
|
-
|
|
1769
|
+
interface PaymentRefundFailed {
|
|
1767
1770
|
/**
|
|
1768
1771
|
* Refund ID.
|
|
1769
1772
|
* @format GUID
|
|
@@ -1772,7 +1775,7 @@ export interface PaymentRefundFailed {
|
|
|
1772
1775
|
/** Details about the failed payment refund. */
|
|
1773
1776
|
payment?: RefundedPayment;
|
|
1774
1777
|
}
|
|
1775
|
-
|
|
1778
|
+
interface RefundedAsStoreCredit {
|
|
1776
1779
|
/** Refund amount */
|
|
1777
1780
|
amount?: Price;
|
|
1778
1781
|
/**
|
|
@@ -1781,7 +1784,7 @@ export interface RefundedAsStoreCredit {
|
|
|
1781
1784
|
*/
|
|
1782
1785
|
reason?: string | null;
|
|
1783
1786
|
}
|
|
1784
|
-
|
|
1787
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
1785
1788
|
/** Regular payment. */
|
|
1786
1789
|
regular?: RegularPayment;
|
|
1787
1790
|
/**
|
|
@@ -1791,22 +1794,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
1791
1794
|
paymentId?: string;
|
|
1792
1795
|
}
|
|
1793
1796
|
/** @oneof */
|
|
1794
|
-
|
|
1797
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
1795
1798
|
/** Regular payment. */
|
|
1796
1799
|
regular?: RegularPayment;
|
|
1797
1800
|
}
|
|
1798
|
-
|
|
1801
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
1799
1802
|
/** Whether regular card used */
|
|
1800
1803
|
creditCardDetails?: CreditCardDetails;
|
|
1801
1804
|
/** Payment amount */
|
|
1802
1805
|
amount?: Price;
|
|
1803
1806
|
}
|
|
1804
1807
|
/** @oneof */
|
|
1805
|
-
|
|
1808
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
1806
1809
|
/** Whether regular card used */
|
|
1807
1810
|
creditCardDetails?: CreditCardDetails;
|
|
1808
1811
|
}
|
|
1809
|
-
|
|
1812
|
+
interface CreditCardDetails {
|
|
1810
1813
|
/**
|
|
1811
1814
|
* The last 4 digits of the card number.
|
|
1812
1815
|
* @maxLength 4
|
|
@@ -1818,7 +1821,7 @@ export interface CreditCardDetails {
|
|
|
1818
1821
|
*/
|
|
1819
1822
|
brand?: string | null;
|
|
1820
1823
|
}
|
|
1821
|
-
|
|
1824
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
1822
1825
|
/** Regular payment. */
|
|
1823
1826
|
regular?: RegularPayment;
|
|
1824
1827
|
/**
|
|
@@ -1828,11 +1831,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
1828
1831
|
paymentId?: string;
|
|
1829
1832
|
}
|
|
1830
1833
|
/** @oneof */
|
|
1831
|
-
|
|
1834
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
1832
1835
|
/** Regular payment. */
|
|
1833
1836
|
regular?: RegularPayment;
|
|
1834
1837
|
}
|
|
1835
|
-
|
|
1838
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
1836
1839
|
/** Regular payment. */
|
|
1837
1840
|
regular?: RegularPayment;
|
|
1838
1841
|
/**
|
|
@@ -1842,11 +1845,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
1842
1845
|
paymentId?: string;
|
|
1843
1846
|
}
|
|
1844
1847
|
/** @oneof */
|
|
1845
|
-
|
|
1848
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
1846
1849
|
/** Regular payment. */
|
|
1847
1850
|
regular?: RegularPayment;
|
|
1848
1851
|
}
|
|
1849
|
-
|
|
1852
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
1850
1853
|
/** Receipt created by Wix */
|
|
1851
1854
|
wixReceipt?: WixReceipt;
|
|
1852
1855
|
/** Receipt created by an external system. */
|
|
@@ -1858,13 +1861,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
1858
1861
|
paymentId?: string;
|
|
1859
1862
|
}
|
|
1860
1863
|
/** @oneof */
|
|
1861
|
-
|
|
1864
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
1862
1865
|
/** Receipt created by Wix */
|
|
1863
1866
|
wixReceipt?: WixReceipt;
|
|
1864
1867
|
/** Receipt created by an external system. */
|
|
1865
1868
|
externalReceipt?: ExternalReceipt;
|
|
1866
1869
|
}
|
|
1867
|
-
|
|
1870
|
+
interface WixReceipt {
|
|
1868
1871
|
/**
|
|
1869
1872
|
* Receipt ID
|
|
1870
1873
|
* @format GUID
|
|
@@ -1877,7 +1880,7 @@ export interface WixReceipt {
|
|
|
1877
1880
|
*/
|
|
1878
1881
|
displayNumber?: string | null;
|
|
1879
1882
|
}
|
|
1880
|
-
|
|
1883
|
+
interface ExternalReceipt {
|
|
1881
1884
|
/**
|
|
1882
1885
|
* Receipt ID
|
|
1883
1886
|
* @maxLength 100
|
|
@@ -1890,7 +1893,7 @@ export interface ExternalReceipt {
|
|
|
1890
1893
|
*/
|
|
1891
1894
|
displayNumber?: string | null;
|
|
1892
1895
|
}
|
|
1893
|
-
|
|
1896
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
1894
1897
|
/** Receipt created by Wix */
|
|
1895
1898
|
wixReceipt?: WixReceipt;
|
|
1896
1899
|
/** Receipt created by an external system. */
|
|
@@ -1902,13 +1905,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
1902
1905
|
paymentId?: string;
|
|
1903
1906
|
}
|
|
1904
1907
|
/** @oneof */
|
|
1905
|
-
|
|
1908
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
1906
1909
|
/** Receipt created by Wix */
|
|
1907
1910
|
wixReceipt?: WixReceipt;
|
|
1908
1911
|
/** Receipt created by an external system. */
|
|
1909
1912
|
externalReceipt?: ExternalReceipt;
|
|
1910
1913
|
}
|
|
1911
|
-
|
|
1914
|
+
declare enum ActivityType {
|
|
1912
1915
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
1913
1916
|
ORDER_PLACED = "ORDER_PLACED",
|
|
1914
1917
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -1945,11 +1948,11 @@ export declare enum ActivityType {
|
|
|
1945
1948
|
/** @documentationMaturity preview */
|
|
1946
1949
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
1947
1950
|
}
|
|
1948
|
-
|
|
1951
|
+
declare enum AttributionSource {
|
|
1949
1952
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1950
1953
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
1951
1954
|
}
|
|
1952
|
-
|
|
1955
|
+
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
1953
1956
|
/**
|
|
1954
1957
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1955
1958
|
* For example, via POS (point of service).
|
|
@@ -1973,7 +1976,7 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
1973
1976
|
appId?: string;
|
|
1974
1977
|
}
|
|
1975
1978
|
/** @oneof */
|
|
1976
|
-
|
|
1979
|
+
interface V1CreatedByStringOneOf {
|
|
1977
1980
|
/**
|
|
1978
1981
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1979
1982
|
* For example, via POS (point of service).
|
|
@@ -1996,7 +1999,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
1996
1999
|
*/
|
|
1997
2000
|
appId?: string;
|
|
1998
2001
|
}
|
|
1999
|
-
|
|
2002
|
+
interface ChannelInfo {
|
|
2000
2003
|
/** Sales channel that submitted the order. */
|
|
2001
2004
|
type?: ChannelType;
|
|
2002
2005
|
/**
|
|
@@ -2010,7 +2013,7 @@ export interface ChannelInfo {
|
|
|
2010
2013
|
*/
|
|
2011
2014
|
externalOrderUrl?: string | null;
|
|
2012
2015
|
}
|
|
2013
|
-
|
|
2016
|
+
declare enum ChannelType {
|
|
2014
2017
|
/** Unspecified sales channel. This value is not supported. */
|
|
2015
2018
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2016
2019
|
/** A web client. */
|
|
@@ -2044,7 +2047,7 @@ export declare enum ChannelType {
|
|
|
2044
2047
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2045
2048
|
FAIRE_COM = "FAIRE_COM"
|
|
2046
2049
|
}
|
|
2047
|
-
|
|
2050
|
+
interface CustomField {
|
|
2048
2051
|
/** Custom field value. */
|
|
2049
2052
|
value?: any;
|
|
2050
2053
|
/**
|
|
@@ -2060,7 +2063,7 @@ export interface CustomField {
|
|
|
2060
2063
|
*/
|
|
2061
2064
|
translatedTitle?: string | null;
|
|
2062
2065
|
}
|
|
2063
|
-
|
|
2066
|
+
interface BalanceSummary {
|
|
2064
2067
|
/**
|
|
2065
2068
|
* Current amount left to pay.
|
|
2066
2069
|
* @readonly
|
|
@@ -2096,7 +2099,7 @@ export interface BalanceSummary {
|
|
|
2096
2099
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
2097
2100
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
2098
2101
|
*/
|
|
2099
|
-
|
|
2102
|
+
interface Balance {
|
|
2100
2103
|
/**
|
|
2101
2104
|
* Balance amount.
|
|
2102
2105
|
*
|
|
@@ -2111,7 +2114,7 @@ export interface Balance {
|
|
|
2111
2114
|
*/
|
|
2112
2115
|
formattedAmount?: string;
|
|
2113
2116
|
}
|
|
2114
|
-
|
|
2117
|
+
interface AdditionalFee {
|
|
2115
2118
|
/**
|
|
2116
2119
|
* Additional fee's unique code for future processing.
|
|
2117
2120
|
* @minLength 1
|
|
@@ -2150,7 +2153,7 @@ export interface AdditionalFee {
|
|
|
2150
2153
|
*/
|
|
2151
2154
|
lineItemIds?: string[];
|
|
2152
2155
|
}
|
|
2153
|
-
|
|
2156
|
+
interface FulfillmentStatusesAggregate {
|
|
2154
2157
|
/** Unique string values based on Fulfillment entities statuses */
|
|
2155
2158
|
statuses?: string[] | null;
|
|
2156
2159
|
}
|
|
@@ -2176,13 +2179,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
2176
2179
|
* }
|
|
2177
2180
|
* }
|
|
2178
2181
|
*/
|
|
2179
|
-
|
|
2182
|
+
interface Tags {
|
|
2180
2183
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
2181
2184
|
privateTags?: TagList;
|
|
2182
2185
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
2183
2186
|
tags?: TagList;
|
|
2184
2187
|
}
|
|
2185
|
-
|
|
2188
|
+
interface TagList {
|
|
2186
2189
|
/**
|
|
2187
2190
|
* List of tag IDs
|
|
2188
2191
|
* @maxSize 100
|
|
@@ -2190,7 +2193,7 @@ export interface TagList {
|
|
|
2190
2193
|
*/
|
|
2191
2194
|
tagIds?: string[];
|
|
2192
2195
|
}
|
|
2193
|
-
|
|
2196
|
+
interface Location {
|
|
2194
2197
|
/**
|
|
2195
2198
|
* Location ID.
|
|
2196
2199
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -2205,11 +2208,11 @@ export interface Location {
|
|
|
2205
2208
|
*/
|
|
2206
2209
|
name?: string;
|
|
2207
2210
|
}
|
|
2208
|
-
|
|
2211
|
+
interface GetPaymentSettingsResponse {
|
|
2209
2212
|
/** Retrieved payment settings. */
|
|
2210
2213
|
paymentSettings?: PaymentSettings;
|
|
2211
2214
|
}
|
|
2212
|
-
|
|
2215
|
+
interface PaymentSettings {
|
|
2213
2216
|
/**
|
|
2214
2217
|
* Whether to apply [3D Secure](https://support.wix.com/en/article/about-3d-secure-3ds-payments-with-third-party-payment-providers) during the payment process.
|
|
2215
2218
|
*
|
|
@@ -2219,11 +2222,11 @@ export interface PaymentSettings {
|
|
|
2219
2222
|
*/
|
|
2220
2223
|
requires3dSecure?: boolean | null;
|
|
2221
2224
|
}
|
|
2222
|
-
|
|
2225
|
+
interface GetPaymentSettingsForCheckoutRequest {
|
|
2223
2226
|
/** Checkout. */
|
|
2224
2227
|
checkout?: Checkout;
|
|
2225
2228
|
}
|
|
2226
|
-
|
|
2229
|
+
interface Checkout {
|
|
2227
2230
|
/**
|
|
2228
2231
|
* Checkout ID.
|
|
2229
2232
|
* @format GUID
|
|
@@ -2401,7 +2404,7 @@ export interface Checkout {
|
|
|
2401
2404
|
*/
|
|
2402
2405
|
businessLocationId?: string | null;
|
|
2403
2406
|
}
|
|
2404
|
-
|
|
2407
|
+
interface LineItem {
|
|
2405
2408
|
/**
|
|
2406
2409
|
* Line item ID.
|
|
2407
2410
|
* @format GUID
|
|
@@ -2567,7 +2570,7 @@ export interface LineItem {
|
|
|
2567
2570
|
*/
|
|
2568
2571
|
savePaymentMethod?: boolean;
|
|
2569
2572
|
}
|
|
2570
|
-
|
|
2573
|
+
interface MultiCurrencyPrice {
|
|
2571
2574
|
/**
|
|
2572
2575
|
* Amount.
|
|
2573
2576
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -2590,7 +2593,7 @@ export interface MultiCurrencyPrice {
|
|
|
2590
2593
|
*/
|
|
2591
2594
|
formattedConvertedAmount?: string;
|
|
2592
2595
|
}
|
|
2593
|
-
|
|
2596
|
+
interface V1ItemTaxFullDetails {
|
|
2594
2597
|
/** Amount for which tax is calculated. */
|
|
2595
2598
|
taxableAmount?: MultiCurrencyPrice;
|
|
2596
2599
|
/**
|
|
@@ -2607,7 +2610,7 @@ export interface V1ItemTaxFullDetails {
|
|
|
2607
2610
|
*/
|
|
2608
2611
|
rateBreakdown?: TaxRateBreakdown[];
|
|
2609
2612
|
}
|
|
2610
|
-
|
|
2613
|
+
interface TaxRateBreakdown {
|
|
2611
2614
|
/**
|
|
2612
2615
|
* Name of tax against which the calculation was performed.
|
|
2613
2616
|
* @maxLength 100
|
|
@@ -2625,7 +2628,7 @@ export interface TaxRateBreakdown {
|
|
|
2625
2628
|
* TaxBreakdown represents tax information for a line item.
|
|
2626
2629
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
2627
2630
|
*/
|
|
2628
|
-
|
|
2631
|
+
interface TaxBreakdown {
|
|
2629
2632
|
/**
|
|
2630
2633
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
2631
2634
|
* @maxLength 200
|
|
@@ -2657,7 +2660,7 @@ export interface TaxBreakdown {
|
|
|
2657
2660
|
jurisdictionType?: V1JurisdictionType;
|
|
2658
2661
|
}
|
|
2659
2662
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
2660
|
-
|
|
2663
|
+
declare enum V1JurisdictionType {
|
|
2661
2664
|
UNDEFINED = "UNDEFINED",
|
|
2662
2665
|
COUNTRY = "COUNTRY",
|
|
2663
2666
|
STATE = "STATE",
|
|
@@ -2665,13 +2668,13 @@ export declare enum V1JurisdictionType {
|
|
|
2665
2668
|
CITY = "CITY",
|
|
2666
2669
|
SPECIAL = "SPECIAL"
|
|
2667
2670
|
}
|
|
2668
|
-
|
|
2671
|
+
interface ItemAvailabilityInfo {
|
|
2669
2672
|
/** Item availability status. */
|
|
2670
2673
|
status?: ItemAvailabilityStatus;
|
|
2671
2674
|
/** Quantity available. */
|
|
2672
2675
|
quantityAvailable?: number | null;
|
|
2673
2676
|
}
|
|
2674
|
-
|
|
2677
|
+
declare enum ItemAvailabilityStatus {
|
|
2675
2678
|
AVAILABLE = "AVAILABLE",
|
|
2676
2679
|
/** Item does not exist. */
|
|
2677
2680
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -2680,19 +2683,19 @@ export declare enum ItemAvailabilityStatus {
|
|
|
2680
2683
|
/** Available quantity is less than requested. */
|
|
2681
2684
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
2682
2685
|
}
|
|
2683
|
-
|
|
2686
|
+
interface Scope {
|
|
2684
2687
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
2685
2688
|
namespace?: string;
|
|
2686
2689
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
2687
2690
|
group?: Group;
|
|
2688
2691
|
}
|
|
2689
|
-
|
|
2692
|
+
interface Group {
|
|
2690
2693
|
/** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
|
|
2691
2694
|
name?: string;
|
|
2692
2695
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
2693
2696
|
entityId?: string | null;
|
|
2694
2697
|
}
|
|
2695
|
-
|
|
2698
|
+
interface SubscriptionOptionInfo {
|
|
2696
2699
|
/** Subscription option settings. */
|
|
2697
2700
|
subscriptionSettings?: V1SubscriptionSettings;
|
|
2698
2701
|
/** Subscription option title. */
|
|
@@ -2700,7 +2703,7 @@ export interface SubscriptionOptionInfo {
|
|
|
2700
2703
|
/** Subscription option description. */
|
|
2701
2704
|
description?: Description;
|
|
2702
2705
|
}
|
|
2703
|
-
|
|
2706
|
+
interface V1SubscriptionSettings {
|
|
2704
2707
|
/** Frequency of recurring payment. */
|
|
2705
2708
|
frequency?: SubscriptionFrequency;
|
|
2706
2709
|
/**
|
|
@@ -2720,7 +2723,7 @@ export interface V1SubscriptionSettings {
|
|
|
2720
2723
|
*/
|
|
2721
2724
|
billingCycles?: number | null;
|
|
2722
2725
|
}
|
|
2723
|
-
|
|
2726
|
+
interface V1FreeTrialPeriod {
|
|
2724
2727
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
2725
2728
|
frequency?: SubscriptionFrequency;
|
|
2726
2729
|
/**
|
|
@@ -2730,7 +2733,7 @@ export interface V1FreeTrialPeriod {
|
|
|
2730
2733
|
*/
|
|
2731
2734
|
interval?: number;
|
|
2732
2735
|
}
|
|
2733
|
-
|
|
2736
|
+
interface Title {
|
|
2734
2737
|
/**
|
|
2735
2738
|
* Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
2736
2739
|
* @minLength 1
|
|
@@ -2746,7 +2749,7 @@ export interface Title {
|
|
|
2746
2749
|
*/
|
|
2747
2750
|
translated?: string | null;
|
|
2748
2751
|
}
|
|
2749
|
-
|
|
2752
|
+
interface Description {
|
|
2750
2753
|
/**
|
|
2751
2754
|
* Subscription option description.
|
|
2752
2755
|
* @maxLength 500
|
|
@@ -2758,7 +2761,7 @@ export interface Description {
|
|
|
2758
2761
|
*/
|
|
2759
2762
|
translated?: string | null;
|
|
2760
2763
|
}
|
|
2761
|
-
|
|
2764
|
+
interface SecuredMedia {
|
|
2762
2765
|
/**
|
|
2763
2766
|
* Media ID in Wix Media Manager.
|
|
2764
2767
|
* @minLength 1
|
|
@@ -2774,7 +2777,7 @@ export interface SecuredMedia {
|
|
|
2774
2777
|
/** File type. */
|
|
2775
2778
|
fileType?: FileType;
|
|
2776
2779
|
}
|
|
2777
|
-
|
|
2780
|
+
declare enum FileType {
|
|
2778
2781
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2779
2782
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
2780
2783
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -2782,7 +2785,7 @@ export declare enum FileType {
|
|
|
2782
2785
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
2783
2786
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2784
2787
|
}
|
|
2785
|
-
|
|
2788
|
+
interface ServiceProperties {
|
|
2786
2789
|
/**
|
|
2787
2790
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2788
2791
|
* For example, the start time of a class.
|
|
@@ -2795,7 +2798,7 @@ export interface ServiceProperties {
|
|
|
2795
2798
|
*/
|
|
2796
2799
|
numberOfParticipants?: number | null;
|
|
2797
2800
|
}
|
|
2798
|
-
|
|
2801
|
+
interface CatalogOverrideFields {
|
|
2799
2802
|
/** Item name. */
|
|
2800
2803
|
productName?: ProductName;
|
|
2801
2804
|
/**
|
|
@@ -2832,7 +2835,7 @@ export interface CatalogOverrideFields {
|
|
|
2832
2835
|
*/
|
|
2833
2836
|
savePaymentMethod?: boolean | null;
|
|
2834
2837
|
}
|
|
2835
|
-
|
|
2838
|
+
interface PaymentOption {
|
|
2836
2839
|
/**
|
|
2837
2840
|
* Type of selected payment option for current item.
|
|
2838
2841
|
*
|
|
@@ -2840,7 +2843,7 @@ export interface PaymentOption {
|
|
|
2840
2843
|
*/
|
|
2841
2844
|
value?: PaymentOptionType;
|
|
2842
2845
|
}
|
|
2843
|
-
|
|
2846
|
+
interface Policy {
|
|
2844
2847
|
/**
|
|
2845
2848
|
* Policy title - should be translated
|
|
2846
2849
|
* @minLength 1
|
|
@@ -2854,7 +2857,7 @@ export interface Policy {
|
|
|
2854
2857
|
*/
|
|
2855
2858
|
content?: string;
|
|
2856
2859
|
}
|
|
2857
|
-
|
|
2860
|
+
interface ModifierGroup {
|
|
2858
2861
|
/**
|
|
2859
2862
|
* Modifier group id.
|
|
2860
2863
|
* @minLength 1
|
|
@@ -2870,7 +2873,7 @@ export interface ModifierGroup {
|
|
|
2870
2873
|
*/
|
|
2871
2874
|
modifiers?: ItemModifier[];
|
|
2872
2875
|
}
|
|
2873
|
-
|
|
2876
|
+
interface TranslatableString {
|
|
2874
2877
|
/**
|
|
2875
2878
|
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
2876
2879
|
*
|
|
@@ -2891,7 +2894,7 @@ export interface TranslatableString {
|
|
|
2891
2894
|
*/
|
|
2892
2895
|
translated?: string | null;
|
|
2893
2896
|
}
|
|
2894
|
-
|
|
2897
|
+
interface ItemModifier {
|
|
2895
2898
|
/**
|
|
2896
2899
|
* Modifier ID.
|
|
2897
2900
|
* @minLength 1
|
|
@@ -2912,13 +2915,13 @@ export interface ItemModifier {
|
|
|
2912
2915
|
price?: MultiCurrencyPrice;
|
|
2913
2916
|
}
|
|
2914
2917
|
/** Billing Info and shipping details */
|
|
2915
|
-
|
|
2918
|
+
interface AddressWithContact {
|
|
2916
2919
|
/** Address. */
|
|
2917
2920
|
address?: Address;
|
|
2918
2921
|
/** Contact details. */
|
|
2919
2922
|
contactDetails?: FullAddressContactDetails;
|
|
2920
2923
|
}
|
|
2921
|
-
|
|
2924
|
+
interface ShippingInfo {
|
|
2922
2925
|
/** Shipping address and contact details. */
|
|
2923
2926
|
shippingDestination?: AddressWithContact;
|
|
2924
2927
|
/** Selected option out of the options allowed for the `region`. */
|
|
@@ -2934,7 +2937,7 @@ export interface ShippingInfo {
|
|
|
2934
2937
|
*/
|
|
2935
2938
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
2936
2939
|
}
|
|
2937
|
-
|
|
2940
|
+
interface SelectedCarrierServiceOption {
|
|
2938
2941
|
/**
|
|
2939
2942
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
2940
2943
|
* @maxLength 100
|
|
@@ -2977,7 +2980,7 @@ export interface SelectedCarrierServiceOption {
|
|
|
2977
2980
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
2978
2981
|
partial?: boolean | null;
|
|
2979
2982
|
}
|
|
2980
|
-
|
|
2983
|
+
interface V1DeliveryLogistics {
|
|
2981
2984
|
/**
|
|
2982
2985
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
2983
2986
|
* @maxLength 500
|
|
@@ -2991,7 +2994,7 @@ export interface V1DeliveryLogistics {
|
|
|
2991
2994
|
/** Pickup details. */
|
|
2992
2995
|
pickupDetails?: V1PickupDetails;
|
|
2993
2996
|
}
|
|
2994
|
-
|
|
2997
|
+
interface V1PickupDetails {
|
|
2995
2998
|
/** Pickup address. */
|
|
2996
2999
|
address?: Address;
|
|
2997
3000
|
/**
|
|
@@ -3002,18 +3005,18 @@ export interface V1PickupDetails {
|
|
|
3002
3005
|
/** Pickup method */
|
|
3003
3006
|
pickupMethod?: PickupDetailsPickupMethod;
|
|
3004
3007
|
}
|
|
3005
|
-
|
|
3008
|
+
declare enum PickupDetailsPickupMethod {
|
|
3006
3009
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
3007
3010
|
STORE_PICKUP = "STORE_PICKUP",
|
|
3008
3011
|
PICKUP_POINT = "PICKUP_POINT"
|
|
3009
3012
|
}
|
|
3010
|
-
|
|
3013
|
+
interface V1DeliveryTimeSlot {
|
|
3011
3014
|
/** starting time of the delivery time slot */
|
|
3012
3015
|
from?: Date | null;
|
|
3013
3016
|
/** ending time of the delivery time slot */
|
|
3014
3017
|
to?: Date | null;
|
|
3015
3018
|
}
|
|
3016
|
-
|
|
3019
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
3017
3020
|
/** Total shipping price, after discount and after tax. */
|
|
3018
3021
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
3019
3022
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -3025,7 +3028,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
3025
3028
|
/** Shipping price before discount and before tax. */
|
|
3026
3029
|
price?: MultiCurrencyPrice;
|
|
3027
3030
|
}
|
|
3028
|
-
|
|
3031
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
3029
3032
|
/** Type of additional cost. */
|
|
3030
3033
|
type?: ChargeType;
|
|
3031
3034
|
/**
|
|
@@ -3036,11 +3039,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
3036
3039
|
/** Price of added charge. */
|
|
3037
3040
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
3038
3041
|
}
|
|
3039
|
-
|
|
3042
|
+
declare enum ChargeType {
|
|
3040
3043
|
HANDLING_FEE = "HANDLING_FEE",
|
|
3041
3044
|
INSURANCE = "INSURANCE"
|
|
3042
3045
|
}
|
|
3043
|
-
|
|
3046
|
+
interface DeliveryAllocation {
|
|
3044
3047
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
3045
3048
|
deliveryCarrier?: Carrier;
|
|
3046
3049
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -3048,7 +3051,7 @@ export interface DeliveryAllocation {
|
|
|
3048
3051
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
3049
3052
|
applicableLineItems?: ApplicableLineItems;
|
|
3050
3053
|
}
|
|
3051
|
-
|
|
3054
|
+
interface Carrier {
|
|
3052
3055
|
/**
|
|
3053
3056
|
* The carrier app id
|
|
3054
3057
|
* @format GUID
|
|
@@ -3060,7 +3063,7 @@ export interface Carrier {
|
|
|
3060
3063
|
*/
|
|
3061
3064
|
code?: string;
|
|
3062
3065
|
}
|
|
3063
|
-
|
|
3066
|
+
interface Region {
|
|
3064
3067
|
/**
|
|
3065
3068
|
* The delivery region id.
|
|
3066
3069
|
* @format GUID
|
|
@@ -3072,7 +3075,7 @@ export interface Region {
|
|
|
3072
3075
|
*/
|
|
3073
3076
|
name?: string | null;
|
|
3074
3077
|
}
|
|
3075
|
-
|
|
3078
|
+
interface ApplicableLineItems {
|
|
3076
3079
|
/**
|
|
3077
3080
|
* Line items that the delivery solution is for.
|
|
3078
3081
|
* @maxSize 300
|
|
@@ -3081,7 +3084,7 @@ export interface ApplicableLineItems {
|
|
|
3081
3084
|
*/
|
|
3082
3085
|
lineItemIds?: string[];
|
|
3083
3086
|
}
|
|
3084
|
-
|
|
3087
|
+
interface V1ShippingRegion {
|
|
3085
3088
|
/**
|
|
3086
3089
|
* Shipping region ID.
|
|
3087
3090
|
* @format GUID
|
|
@@ -3094,7 +3097,7 @@ export interface V1ShippingRegion {
|
|
|
3094
3097
|
*/
|
|
3095
3098
|
name?: string;
|
|
3096
3099
|
}
|
|
3097
|
-
|
|
3100
|
+
interface CarrierServiceOption {
|
|
3098
3101
|
/**
|
|
3099
3102
|
* Carrier ID.
|
|
3100
3103
|
* @format GUID
|
|
@@ -3103,7 +3106,7 @@ export interface CarrierServiceOption {
|
|
|
3103
3106
|
/** Shipping options offered by this carrier for this request. */
|
|
3104
3107
|
shippingOptions?: ShippingOption[];
|
|
3105
3108
|
}
|
|
3106
|
-
|
|
3109
|
+
interface ShippingOption {
|
|
3107
3110
|
/**
|
|
3108
3111
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
3109
3112
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -3128,19 +3131,19 @@ export interface ShippingOption {
|
|
|
3128
3131
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
3129
3132
|
partial?: boolean | null;
|
|
3130
3133
|
}
|
|
3131
|
-
|
|
3134
|
+
interface V1ShippingPrice {
|
|
3132
3135
|
/** Shipping price. */
|
|
3133
3136
|
price?: MultiCurrencyPrice;
|
|
3134
3137
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
3135
3138
|
otherCharges?: OtherCharge[];
|
|
3136
3139
|
}
|
|
3137
|
-
|
|
3140
|
+
interface OtherCharge {
|
|
3138
3141
|
/** Type of additional cost. */
|
|
3139
3142
|
type?: ChargeType;
|
|
3140
3143
|
/** Price of added cost. */
|
|
3141
3144
|
price?: MultiCurrencyPrice;
|
|
3142
3145
|
}
|
|
3143
|
-
|
|
3146
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
3144
3147
|
/**
|
|
3145
3148
|
* Visitor ID (if site visitor is **not** a member).
|
|
3146
3149
|
* @format GUID
|
|
@@ -3166,7 +3169,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
3166
3169
|
email?: string | null;
|
|
3167
3170
|
}
|
|
3168
3171
|
/** @oneof */
|
|
3169
|
-
|
|
3172
|
+
interface BuyerInfoIdOneOf {
|
|
3170
3173
|
/**
|
|
3171
3174
|
* Visitor ID (if site visitor is **not** a member).
|
|
3172
3175
|
* @format GUID
|
|
@@ -3180,7 +3183,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
3180
3183
|
*/
|
|
3181
3184
|
memberId?: string;
|
|
3182
3185
|
}
|
|
3183
|
-
|
|
3186
|
+
interface V1PriceSummary {
|
|
3184
3187
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
3185
3188
|
subtotal?: MultiCurrencyPrice;
|
|
3186
3189
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -3194,7 +3197,7 @@ export interface V1PriceSummary {
|
|
|
3194
3197
|
/** Total additional fees price before tax. */
|
|
3195
3198
|
additionalFees?: MultiCurrencyPrice;
|
|
3196
3199
|
}
|
|
3197
|
-
|
|
3200
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
3198
3201
|
/** General shipping calculation error. */
|
|
3199
3202
|
generalShippingCalculationError?: Details;
|
|
3200
3203
|
/** Carrier errors. */
|
|
@@ -3216,13 +3219,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
3216
3219
|
discountsCalculationError?: Details;
|
|
3217
3220
|
}
|
|
3218
3221
|
/** @oneof */
|
|
3219
|
-
|
|
3222
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
3220
3223
|
/** General shipping calculation error. */
|
|
3221
3224
|
generalShippingCalculationError?: Details;
|
|
3222
3225
|
/** Carrier errors. */
|
|
3223
3226
|
carrierErrors?: CarrierErrors;
|
|
3224
3227
|
}
|
|
3225
|
-
|
|
3228
|
+
interface Details extends DetailsKindOneOf {
|
|
3226
3229
|
applicationError?: ApplicationError;
|
|
3227
3230
|
validationError?: ValidationError;
|
|
3228
3231
|
systemError?: SystemError;
|
|
@@ -3233,12 +3236,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
3233
3236
|
tracing?: Record<string, string>;
|
|
3234
3237
|
}
|
|
3235
3238
|
/** @oneof */
|
|
3236
|
-
|
|
3239
|
+
interface DetailsKindOneOf {
|
|
3237
3240
|
applicationError?: ApplicationError;
|
|
3238
3241
|
validationError?: ValidationError;
|
|
3239
3242
|
systemError?: SystemError;
|
|
3240
3243
|
}
|
|
3241
|
-
|
|
3244
|
+
interface ApplicationError {
|
|
3242
3245
|
/** Error code. */
|
|
3243
3246
|
code?: string;
|
|
3244
3247
|
/** Description of the error. */
|
|
@@ -3278,10 +3281,10 @@ export interface ApplicationError {
|
|
|
3278
3281
|
* ]
|
|
3279
3282
|
* }
|
|
3280
3283
|
*/
|
|
3281
|
-
|
|
3284
|
+
interface ValidationError {
|
|
3282
3285
|
fieldViolations?: FieldViolation[];
|
|
3283
3286
|
}
|
|
3284
|
-
|
|
3287
|
+
declare enum RuleType {
|
|
3285
3288
|
VALIDATION = "VALIDATION",
|
|
3286
3289
|
OTHER = "OTHER",
|
|
3287
3290
|
MAX = "MAX",
|
|
@@ -3304,7 +3307,7 @@ export declare enum RuleType {
|
|
|
3304
3307
|
EXACT_SIZE = "EXACT_SIZE",
|
|
3305
3308
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
3306
3309
|
}
|
|
3307
|
-
|
|
3310
|
+
interface FieldViolation {
|
|
3308
3311
|
field?: string;
|
|
3309
3312
|
description?: string;
|
|
3310
3313
|
violatedRule?: RuleType;
|
|
@@ -3312,21 +3315,21 @@ export interface FieldViolation {
|
|
|
3312
3315
|
ruleName?: string | null;
|
|
3313
3316
|
data?: Record<string, any> | null;
|
|
3314
3317
|
}
|
|
3315
|
-
|
|
3318
|
+
interface SystemError {
|
|
3316
3319
|
/** Error code. */
|
|
3317
3320
|
errorCode?: string | null;
|
|
3318
3321
|
}
|
|
3319
|
-
|
|
3322
|
+
interface CarrierErrors {
|
|
3320
3323
|
/** Carrier errors. */
|
|
3321
3324
|
errors?: CarrierError[];
|
|
3322
3325
|
}
|
|
3323
|
-
|
|
3326
|
+
interface CarrierError {
|
|
3324
3327
|
/** Carrier ID. */
|
|
3325
3328
|
carrierId?: string;
|
|
3326
3329
|
/** Error details. */
|
|
3327
3330
|
error?: Details;
|
|
3328
3331
|
}
|
|
3329
|
-
|
|
3332
|
+
interface GiftCard {
|
|
3330
3333
|
/**
|
|
3331
3334
|
* Gift Card ID.
|
|
3332
3335
|
* @deprecated
|
|
@@ -3349,7 +3352,7 @@ export interface GiftCard {
|
|
|
3349
3352
|
*/
|
|
3350
3353
|
externalId?: string | null;
|
|
3351
3354
|
}
|
|
3352
|
-
|
|
3355
|
+
interface V1AppliedDiscount extends V1AppliedDiscountDiscountSourceOneOf {
|
|
3353
3356
|
/** Coupon details. */
|
|
3354
3357
|
coupon?: V1Coupon;
|
|
3355
3358
|
/** Merchant discount. */
|
|
@@ -3368,7 +3371,7 @@ export interface V1AppliedDiscount extends V1AppliedDiscountDiscountSourceOneOf
|
|
|
3368
3371
|
lineItemIds?: string[];
|
|
3369
3372
|
}
|
|
3370
3373
|
/** @oneof */
|
|
3371
|
-
|
|
3374
|
+
interface V1AppliedDiscountDiscountSourceOneOf {
|
|
3372
3375
|
/** Coupon details. */
|
|
3373
3376
|
coupon?: V1Coupon;
|
|
3374
3377
|
/** Merchant discount. */
|
|
@@ -3376,13 +3379,13 @@ export interface V1AppliedDiscountDiscountSourceOneOf {
|
|
|
3376
3379
|
/** Discount rule */
|
|
3377
3380
|
discountRule?: V1DiscountRule;
|
|
3378
3381
|
}
|
|
3379
|
-
|
|
3382
|
+
declare enum AppliedDiscountDiscountType {
|
|
3380
3383
|
GLOBAL = "GLOBAL",
|
|
3381
3384
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
3382
3385
|
SHIPPING = "SHIPPING"
|
|
3383
3386
|
}
|
|
3384
3387
|
/** Coupon */
|
|
3385
|
-
|
|
3388
|
+
interface V1Coupon {
|
|
3386
3389
|
/** Coupon ID. */
|
|
3387
3390
|
_id?: string;
|
|
3388
3391
|
/** Coupon code. */
|
|
@@ -3392,7 +3395,7 @@ export interface V1Coupon {
|
|
|
3392
3395
|
/** Coupon name. */
|
|
3393
3396
|
name?: string;
|
|
3394
3397
|
}
|
|
3395
|
-
|
|
3398
|
+
interface V1MerchantDiscount {
|
|
3396
3399
|
/** Discount value. */
|
|
3397
3400
|
amount?: MultiCurrencyPrice;
|
|
3398
3401
|
/**
|
|
@@ -3402,7 +3405,7 @@ export interface V1MerchantDiscount {
|
|
|
3402
3405
|
*/
|
|
3403
3406
|
percentage?: number | null;
|
|
3404
3407
|
}
|
|
3405
|
-
|
|
3408
|
+
interface V1DiscountRule {
|
|
3406
3409
|
/**
|
|
3407
3410
|
* Discount rule ID
|
|
3408
3411
|
* @format GUID
|
|
@@ -3413,7 +3416,7 @@ export interface V1DiscountRule {
|
|
|
3413
3416
|
/** Discount value. */
|
|
3414
3417
|
amount?: MultiCurrencyPrice;
|
|
3415
3418
|
}
|
|
3416
|
-
|
|
3419
|
+
interface V1DiscountRuleName {
|
|
3417
3420
|
/**
|
|
3418
3421
|
* Original discount rule name (in site's default language).
|
|
3419
3422
|
* @minLength 1
|
|
@@ -3427,7 +3430,7 @@ export interface V1DiscountRuleName {
|
|
|
3427
3430
|
*/
|
|
3428
3431
|
translated?: string | null;
|
|
3429
3432
|
}
|
|
3430
|
-
|
|
3433
|
+
interface V1LineItemDiscount {
|
|
3431
3434
|
/**
|
|
3432
3435
|
* ID of line item the discount applies to.
|
|
3433
3436
|
* @format GUID
|
|
@@ -3436,7 +3439,7 @@ export interface V1LineItemDiscount {
|
|
|
3436
3439
|
/** Discount value. */
|
|
3437
3440
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
3438
3441
|
}
|
|
3439
|
-
|
|
3442
|
+
interface V1TaxSummary {
|
|
3440
3443
|
/**
|
|
3441
3444
|
* Amount for which tax is calculated, added from line items.
|
|
3442
3445
|
* @readonly
|
|
@@ -3453,7 +3456,7 @@ export interface V1TaxSummary {
|
|
|
3453
3456
|
*/
|
|
3454
3457
|
calculationDetails?: TaxCalculationDetails;
|
|
3455
3458
|
}
|
|
3456
|
-
|
|
3459
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
3457
3460
|
/** Reason the manual calculation was used. */
|
|
3458
3461
|
manualRateReason?: ManualCalculationReason;
|
|
3459
3462
|
/** Details of the fallback rate calculation. */
|
|
@@ -3462,13 +3465,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
|
|
|
3462
3465
|
rateType?: RateType;
|
|
3463
3466
|
}
|
|
3464
3467
|
/** @oneof */
|
|
3465
|
-
|
|
3468
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
3466
3469
|
/** Reason the manual calculation was used. */
|
|
3467
3470
|
manualRateReason?: ManualCalculationReason;
|
|
3468
3471
|
/** Details of the fallback rate calculation. */
|
|
3469
3472
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
3470
3473
|
}
|
|
3471
|
-
|
|
3474
|
+
declare enum RateType {
|
|
3472
3475
|
/** no tax being collected for this request due to location of purchase */
|
|
3473
3476
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
3474
3477
|
/** manual rate used for calculation */
|
|
@@ -3478,19 +3481,19 @@ export declare enum RateType {
|
|
|
3478
3481
|
/** fallback rate used for calculation */
|
|
3479
3482
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
3480
3483
|
}
|
|
3481
|
-
|
|
3484
|
+
declare enum ManualCalculationReason {
|
|
3482
3485
|
/** user set calculator in Business Manager to be Manual */
|
|
3483
3486
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
3484
3487
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
3485
3488
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
3486
3489
|
}
|
|
3487
|
-
|
|
3490
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
3488
3491
|
/** reason for fallback */
|
|
3489
3492
|
fallbackReason?: FallbackReason;
|
|
3490
3493
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
3491
3494
|
error?: ApplicationError;
|
|
3492
3495
|
}
|
|
3493
|
-
|
|
3496
|
+
declare enum FallbackReason {
|
|
3494
3497
|
/** auto-tax failed to be calculated */
|
|
3495
3498
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
3496
3499
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
@@ -3500,7 +3503,7 @@ export declare enum FallbackReason {
|
|
|
3500
3503
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
3501
3504
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
3502
3505
|
*/
|
|
3503
|
-
|
|
3506
|
+
interface AggregatedTaxBreakdown {
|
|
3504
3507
|
/**
|
|
3505
3508
|
* The name of the tax against which this tax amount was calculated.
|
|
3506
3509
|
* @maxLength 200
|
|
@@ -3526,7 +3529,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
3526
3529
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
3527
3530
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
3528
3531
|
}
|
|
3529
|
-
|
|
3532
|
+
interface CreatedBy extends CreatedByIdOneOf {
|
|
3530
3533
|
/**
|
|
3531
3534
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
3532
3535
|
* For example, via POS (point of service).
|
|
@@ -3550,7 +3553,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
3550
3553
|
appId?: string;
|
|
3551
3554
|
}
|
|
3552
3555
|
/** @oneof */
|
|
3553
|
-
|
|
3556
|
+
interface CreatedByIdOneOf {
|
|
3554
3557
|
/**
|
|
3555
3558
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
3556
3559
|
* For example, via POS (point of service).
|
|
@@ -3574,7 +3577,7 @@ export interface CreatedByIdOneOf {
|
|
|
3574
3577
|
appId?: string;
|
|
3575
3578
|
}
|
|
3576
3579
|
/** Reserved for internal use. */
|
|
3577
|
-
|
|
3580
|
+
interface MembershipOptions {
|
|
3578
3581
|
/**
|
|
3579
3582
|
* Reserved for internal use.
|
|
3580
3583
|
* @readonly
|
|
@@ -3590,7 +3593,7 @@ export interface MembershipOptions {
|
|
|
3590
3593
|
/** Selected membership to apply to this checkout. */
|
|
3591
3594
|
selectedMemberships?: SelectedMemberships;
|
|
3592
3595
|
}
|
|
3593
|
-
|
|
3596
|
+
interface Membership {
|
|
3594
3597
|
/**
|
|
3595
3598
|
* Membership ID.
|
|
3596
3599
|
* @minLength 1
|
|
@@ -3619,7 +3622,7 @@ export interface Membership {
|
|
|
3619
3622
|
/** Additional data about this membership. */
|
|
3620
3623
|
additionalData?: Record<string, any> | null;
|
|
3621
3624
|
}
|
|
3622
|
-
|
|
3625
|
+
interface MembershipName {
|
|
3623
3626
|
/**
|
|
3624
3627
|
* Membership name.
|
|
3625
3628
|
* @maxLength 100
|
|
@@ -3631,7 +3634,7 @@ export interface MembershipName {
|
|
|
3631
3634
|
*/
|
|
3632
3635
|
translated?: string | null;
|
|
3633
3636
|
}
|
|
3634
|
-
|
|
3637
|
+
interface MembershipPaymentCredits {
|
|
3635
3638
|
/**
|
|
3636
3639
|
* Membership's total amount of credits.
|
|
3637
3640
|
* @min 1
|
|
@@ -3640,7 +3643,7 @@ export interface MembershipPaymentCredits {
|
|
|
3640
3643
|
/** Membership's remaining amount of credits. */
|
|
3641
3644
|
remaining?: number;
|
|
3642
3645
|
}
|
|
3643
|
-
|
|
3646
|
+
interface InvalidMembership {
|
|
3644
3647
|
/** Membership details. */
|
|
3645
3648
|
membership?: Membership;
|
|
3646
3649
|
/**
|
|
@@ -3650,14 +3653,14 @@ export interface InvalidMembership {
|
|
|
3650
3653
|
*/
|
|
3651
3654
|
reason?: string;
|
|
3652
3655
|
}
|
|
3653
|
-
|
|
3656
|
+
interface SelectedMemberships {
|
|
3654
3657
|
/**
|
|
3655
3658
|
* Selected memberships.
|
|
3656
3659
|
* @maxSize 300
|
|
3657
3660
|
*/
|
|
3658
3661
|
memberships?: SelectedMembership[];
|
|
3659
3662
|
}
|
|
3660
|
-
|
|
3663
|
+
interface SelectedMembership {
|
|
3661
3664
|
/**
|
|
3662
3665
|
* Membership ID.
|
|
3663
3666
|
* @minLength 1
|
|
@@ -3678,7 +3681,7 @@ export interface SelectedMembership {
|
|
|
3678
3681
|
*/
|
|
3679
3682
|
lineItemIds?: string[];
|
|
3680
3683
|
}
|
|
3681
|
-
|
|
3684
|
+
interface V1AdditionalFee {
|
|
3682
3685
|
/**
|
|
3683
3686
|
* Additional fee's unique code (or ID) for future processing.
|
|
3684
3687
|
* @minLength 1
|
|
@@ -3714,7 +3717,7 @@ export interface V1AdditionalFee {
|
|
|
3714
3717
|
/** the source the additional fee was added from */
|
|
3715
3718
|
source?: AdditionalFeeSource;
|
|
3716
3719
|
}
|
|
3717
|
-
|
|
3720
|
+
declare enum AdditionalFeeSource {
|
|
3718
3721
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
3719
3722
|
/** The additional fee was added by an additional fee service plugin */
|
|
3720
3723
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -3723,7 +3726,7 @@ export declare enum AdditionalFeeSource {
|
|
|
3723
3726
|
/** The additional fee was added manually on the request */
|
|
3724
3727
|
MANUAL = "MANUAL"
|
|
3725
3728
|
}
|
|
3726
|
-
|
|
3729
|
+
interface ConversionInfo {
|
|
3727
3730
|
/**
|
|
3728
3731
|
* The site currency.
|
|
3729
3732
|
* @readonly
|
|
@@ -3737,7 +3740,7 @@ export interface ConversionInfo {
|
|
|
3737
3740
|
*/
|
|
3738
3741
|
conversionRate?: string;
|
|
3739
3742
|
}
|
|
3740
|
-
|
|
3743
|
+
interface Violation {
|
|
3741
3744
|
/** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
|
|
3742
3745
|
severity?: Severity;
|
|
3743
3746
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -3749,7 +3752,7 @@ export interface Violation {
|
|
|
3749
3752
|
*/
|
|
3750
3753
|
description?: string | null;
|
|
3751
3754
|
}
|
|
3752
|
-
|
|
3755
|
+
declare enum Severity {
|
|
3753
3756
|
/** The user is allowed to move forward in the flow. */
|
|
3754
3757
|
WARNING = "WARNING",
|
|
3755
3758
|
/**
|
|
@@ -3758,48 +3761,48 @@ export declare enum Severity {
|
|
|
3758
3761
|
*/
|
|
3759
3762
|
ERROR = "ERROR"
|
|
3760
3763
|
}
|
|
3761
|
-
|
|
3764
|
+
interface Target extends TargetTargetTypeOneOf {
|
|
3762
3765
|
/** General (other) violation. */
|
|
3763
3766
|
other?: Other;
|
|
3764
3767
|
/** Specific line item violation. */
|
|
3765
3768
|
lineItem?: TargetLineItem;
|
|
3766
3769
|
}
|
|
3767
3770
|
/** @oneof */
|
|
3768
|
-
|
|
3771
|
+
interface TargetTargetTypeOneOf {
|
|
3769
3772
|
/** General (other) violation. */
|
|
3770
3773
|
other?: Other;
|
|
3771
3774
|
/** Specific line item violation. */
|
|
3772
3775
|
lineItem?: TargetLineItem;
|
|
3773
3776
|
}
|
|
3774
3777
|
/** Available locations on the webpage */
|
|
3775
|
-
|
|
3778
|
+
declare enum NameInOther {
|
|
3776
3779
|
/** Default location, in case no specific location is specified. */
|
|
3777
3780
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
3778
3781
|
}
|
|
3779
3782
|
/** Available locations on the line item */
|
|
3780
|
-
|
|
3783
|
+
declare enum NameInLineItem {
|
|
3781
3784
|
/** Default location, in case no specific location is specified. */
|
|
3782
3785
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
3783
3786
|
}
|
|
3784
|
-
|
|
3787
|
+
declare enum SuggestedFix {
|
|
3785
3788
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
3786
3789
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
3787
3790
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
3788
3791
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
3789
3792
|
}
|
|
3790
3793
|
/** General (other) violation. */
|
|
3791
|
-
|
|
3794
|
+
interface Other {
|
|
3792
3795
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
3793
3796
|
name?: NameInOther;
|
|
3794
3797
|
}
|
|
3795
3798
|
/** Specific line item violation. */
|
|
3796
|
-
|
|
3799
|
+
interface TargetLineItem {
|
|
3797
3800
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
3798
3801
|
name?: NameInLineItem;
|
|
3799
3802
|
/** ID of the line item containing the violation. */
|
|
3800
3803
|
_id?: string | null;
|
|
3801
3804
|
}
|
|
3802
|
-
|
|
3805
|
+
interface CustomSettings {
|
|
3803
3806
|
/**
|
|
3804
3807
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
3805
3808
|
*
|
|
@@ -3825,7 +3828,7 @@ export interface CustomSettings {
|
|
|
3825
3828
|
*/
|
|
3826
3829
|
disabledManualPayment?: boolean;
|
|
3827
3830
|
}
|
|
3828
|
-
|
|
3831
|
+
interface CustomContentReference {
|
|
3829
3832
|
/**
|
|
3830
3833
|
* ID of the app providing the content.
|
|
3831
3834
|
*
|
|
@@ -3841,7 +3844,7 @@ export interface CustomContentReference {
|
|
|
3841
3844
|
*/
|
|
3842
3845
|
componentId?: string;
|
|
3843
3846
|
}
|
|
3844
|
-
|
|
3847
|
+
interface ExternalReference {
|
|
3845
3848
|
/**
|
|
3846
3849
|
* ID of the app associated with the purchase flow.
|
|
3847
3850
|
* For example, the Wix Pay Links app ID.
|
|
@@ -3858,7 +3861,7 @@ export interface ExternalReference {
|
|
|
3858
3861
|
*/
|
|
3859
3862
|
resourceId?: string | null;
|
|
3860
3863
|
}
|
|
3861
|
-
|
|
3864
|
+
interface SubscriptionCharges {
|
|
3862
3865
|
/**
|
|
3863
3866
|
* ids of the items the subscription is defined on
|
|
3864
3867
|
* @format GUID
|
|
@@ -3878,7 +3881,7 @@ export interface SubscriptionCharges {
|
|
|
3878
3881
|
*/
|
|
3879
3882
|
charges?: Charge[];
|
|
3880
3883
|
}
|
|
3881
|
-
|
|
3884
|
+
interface Charge {
|
|
3882
3885
|
/** The cycle number from which the charge starts. */
|
|
3883
3886
|
cycleFrom?: number;
|
|
3884
3887
|
/** The number of cycles for which the charge is applicable. */
|
|
@@ -3888,15 +3891,15 @@ export interface Charge {
|
|
|
3888
3891
|
/** The billing date from which the charge starts. */
|
|
3889
3892
|
cycleBillingDate?: Date | null;
|
|
3890
3893
|
}
|
|
3891
|
-
|
|
3894
|
+
interface GetPaymentSettingsForCheckoutResponse {
|
|
3892
3895
|
/** Blocked payment options. */
|
|
3893
3896
|
blockedPaymentOptions?: V1PaymentOption[];
|
|
3894
3897
|
}
|
|
3895
|
-
|
|
3898
|
+
declare enum V1PaymentOption {
|
|
3896
3899
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
3897
3900
|
MANUAL = "MANUAL"
|
|
3898
3901
|
}
|
|
3899
|
-
|
|
3902
|
+
interface PaymentSettingsSPIConfig {
|
|
3900
3903
|
/**
|
|
3901
3904
|
* *Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
|
|
3902
3905
|
* For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
|
|
@@ -3929,7 +3932,7 @@ export interface PaymentSettingsSPIConfig {
|
|
|
3929
3932
|
* }
|
|
3930
3933
|
* ```
|
|
3931
3934
|
*/
|
|
3932
|
-
|
|
3935
|
+
interface Context {
|
|
3933
3936
|
/** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
|
|
3934
3937
|
requestId?: string | null;
|
|
3935
3938
|
/**
|
|
@@ -3947,14 +3950,14 @@ export interface Context {
|
|
|
3947
3950
|
*/
|
|
3948
3951
|
instanceId?: string | null;
|
|
3949
3952
|
}
|
|
3950
|
-
|
|
3953
|
+
declare enum IdentityType {
|
|
3951
3954
|
UNKNOWN = "UNKNOWN",
|
|
3952
3955
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3953
3956
|
MEMBER = "MEMBER",
|
|
3954
3957
|
WIX_USER = "WIX_USER",
|
|
3955
3958
|
APP = "APP"
|
|
3956
3959
|
}
|
|
3957
|
-
|
|
3960
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3958
3961
|
/**
|
|
3959
3962
|
* ID of a site visitor that has not logged in to the site.
|
|
3960
3963
|
* @format GUID
|
|
@@ -3979,7 +3982,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3979
3982
|
identityType?: IdentityType;
|
|
3980
3983
|
}
|
|
3981
3984
|
/** @oneof */
|
|
3982
|
-
|
|
3985
|
+
interface IdentificationDataIdOneOf {
|
|
3983
3986
|
/**
|
|
3984
3987
|
* ID of a site visitor that has not logged in to the site.
|
|
3985
3988
|
* @format GUID
|
|
@@ -4001,3 +4004,28 @@ export interface IdentificationDataIdOneOf {
|
|
|
4001
4004
|
*/
|
|
4002
4005
|
appId?: string;
|
|
4003
4006
|
}
|
|
4007
|
+
|
|
4008
|
+
interface GetPaymentSettingsEnvelope {
|
|
4009
|
+
request: GetPaymentSettingsRequest;
|
|
4010
|
+
metadata: Context;
|
|
4011
|
+
}
|
|
4012
|
+
interface GetPaymentSettingsForCheckoutEnvelope {
|
|
4013
|
+
request: GetPaymentSettingsForCheckoutRequest;
|
|
4014
|
+
metadata: Context;
|
|
4015
|
+
}
|
|
4016
|
+
declare const provideHandlers$1: ServicePluginDefinition<{
|
|
4017
|
+
/**
|
|
4018
|
+
*
|
|
4019
|
+
* This method retrieves payment settings from your app.
|
|
4020
|
+
*
|
|
4021
|
+
* Wix calls this method during the payment process. For example, when a customer inserts credit card details and places an order.
|
|
4022
|
+
* This method retrieves the payment settings to apply, and Wix passes on the settings to the payment provider. */
|
|
4023
|
+
getPaymentSettings(payload: GetPaymentSettingsEnvelope): GetPaymentSettingsResponse | Promise<GetPaymentSettingsResponse>;
|
|
4024
|
+
/**
|
|
4025
|
+
* Returns payment settings for provided Checkout entity. */
|
|
4026
|
+
getPaymentSettingsForCheckout(payload: GetPaymentSettingsForCheckoutEnvelope): GetPaymentSettingsForCheckoutResponse | Promise<GetPaymentSettingsForCheckoutResponse>;
|
|
4027
|
+
}>;
|
|
4028
|
+
|
|
4029
|
+
declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;
|
|
4030
|
+
|
|
4031
|
+
export { type Activity, type ActivityContentOneOf, ActivityType, type AdditionalFee, AdditionalFeeSource, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AggregatedTaxBreakdown, type ApiAddressWithContact, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, AttributionSource, type AuthorizedPaymentCaptured, type AuthorizedPaymentCreated, type AuthorizedPaymentVoided, type AutoTaxFallbackCalculationDetails, type Balance, type BalanceSummary, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BuyerInfo, type BuyerInfoIdOneOf, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type CatalogOverrideFields, type CatalogReference, type ChannelInfo, ChannelType, type Charge, ChargeType, type Checkout, type Color, type Context, type ConversionInfo, type Coupon, type CreatedBy, type CreatedByIdOneOf, type CreditCardDetails, type CurrencyConversionDetails, type CustomActivity, type CustomContentReference, type CustomField, type CustomSettings, type DeliveryAllocation, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type DigitalFile, DiscountReason, type DiscountRule, type DiscountRuleName, DiscountType, type DraftOrderChangesApplied, type ExtendedFields, type ExternalReceipt, type ExternalReference, FallbackReason, type FieldViolation, FileType, type FocalPoint, type FreeTrialPeriod, FulfillmentStatus, type FulfillmentStatusesAggregate, type FullAddressContactDetails, type GetPaymentSettingsForCheckoutRequest, type GetPaymentSettingsForCheckoutResponse, type GetPaymentSettingsRequest, type GetPaymentSettingsResponse, type GiftCard, type GiftCardPaymentRefund, type Group, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemModifier, type ItemTaxFullDetails, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, JurisdictionType, type LineItem, type LineItemAmount, type LineItemChanges, type LineItemDiscount, type LineItemExchangeData, type LineItemPriceChange, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, ManualCalculationReason, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MembershipPaymentRefund, type MerchantComment, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, NameInOther, type NewExchangeOrderCreated, type Order, type OrderChange, type OrderChangeValueOneOf, type OrderCreatedFromExchange, type OrderLineItem, type OrderRefunded, OrderStatus, type OrderTaxBreakdown, type OrderTaxInfo, type Other, type OtherCharge, type PaymentCanceled, type PaymentCanceledPaymentDetailsOneOf, type PaymentDeclined, type PaymentDeclinedPaymentDetailsOneOf, type PaymentOption, PaymentOptionType, type PaymentPending, type PaymentPendingPaymentDetailsOneOf, type PaymentRefundFailed, type PaymentRefunded, type PaymentSettings, type PaymentSettingsSPIConfig, PaymentStatus, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupDetailsPickupMethod, PickupMethod, type PlainTextValue, type Policy, type Price, type PriceDescription, type PriceSummary, type ProductName, RateType, type ReceiptCreated, type ReceiptCreatedReceiptInfoOneOf, type ReceiptSent, type ReceiptSentReceiptInfoOneOf, type RefundInitiated, type RefundedAsStoreCredit, type RefundedPayment, type RefundedPaymentKindOneOf, type Region, type RegularPayment, type RegularPaymentPaymentMethodDetailsOneOf, type RegularPaymentRefund, RuleType, type SavedPaymentMethod, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type ServiceProperties, Severity, type ShippingInfo, type ShippingInformation, type ShippingInformationChange, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, type SubscriptionCharges, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionInfo, type SubscriptionOptionInfo, type SubscriptionSettings, type SubscriptionTitle, SuggestedFix, type SystemError, type TagList, type Tags, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type Title, type TotalPriceChange, type TranslatableString, type TranslatedValue, type V1AdditionalFee, type V1AppliedDiscount, type V1AppliedDiscountDiscountSourceOneOf, type V1BuyerInfo, type V1BuyerInfoIdOneOf, type V1Coupon, type V1CreatedBy, type V1CreatedByStringOneOf, type V1DeliveryLogistics, type V1DeliveryTimeSlot, type V1DiscountRule, type V1DiscountRuleName, type V1FreeTrialPeriod, type V1ItemTaxFullDetails, V1JurisdictionType, type V1LineItemDiscount, type V1MerchantDiscount, V1PaymentOption, type V1PickupDetails, type V1PriceSummary, type V1ShippingInformation, type V1ShippingPrice, type V1ShippingRegion, type V1SubscriptionSettings, type V1TaxSummary, type ValidationError, type VatId, VatType, type Violation, WeightUnit, type WixReceipt, provideHandlers, provideHandlers$1 as publicProvideHandlers };
|