@wix/auto_sdk_ecom_draft-orders 1.0.56 → 1.0.57
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/index.d.ts +2 -2
- package/build/cjs/index.js +11 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +213 -9
- package/build/cjs/index.typings.js +11 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +713 -7
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +11 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +213 -9
- package/build/es/index.typings.mjs +11 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +713 -7
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js +11 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +152 -94
- package/build/internal/cjs/index.typings.js +11 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +713 -7
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs +11 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +152 -94
- package/build/internal/es/index.typings.mjs +11 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +713 -7
- package/package.json +2 -2
package/build/cjs/meta.d.ts
CHANGED
|
@@ -2668,6 +2668,53 @@ interface Activity extends ActivityContentOneOf {
|
|
|
2668
2668
|
merchantComment?: MerchantComment;
|
|
2669
2669
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2670
2670
|
orderRefunded?: OrderRefunded;
|
|
2671
|
+
/** Details of changes made by the Draft Orders API. */
|
|
2672
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
2673
|
+
/** Details of the payment method saved for order */
|
|
2674
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
2675
|
+
/** Details of an authorized payment created. */
|
|
2676
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
2677
|
+
/** Details of an authorized payment captured. */
|
|
2678
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
2679
|
+
/** Details of an authorized payment voided. */
|
|
2680
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
2681
|
+
/**
|
|
2682
|
+
* Details of an initiated refund process.
|
|
2683
|
+
*
|
|
2684
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
2685
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
2686
|
+
*/
|
|
2687
|
+
refundInitiated?: RefundInitiated;
|
|
2688
|
+
/**
|
|
2689
|
+
* Details of a refunded payment.
|
|
2690
|
+
*
|
|
2691
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
2692
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
2693
|
+
*/
|
|
2694
|
+
paymentRefunded?: PaymentRefunded;
|
|
2695
|
+
/**
|
|
2696
|
+
* Details of a failed payment refund.
|
|
2697
|
+
*
|
|
2698
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
2699
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
2700
|
+
*/
|
|
2701
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
2702
|
+
/** Details of refund to store credit. */
|
|
2703
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
2704
|
+
/** Details of a pending payment. */
|
|
2705
|
+
paymentPending?: PaymentPending;
|
|
2706
|
+
/** Details of a canceled payment. */
|
|
2707
|
+
paymentCanceled?: PaymentCanceled;
|
|
2708
|
+
/** Details of a declined payment. */
|
|
2709
|
+
paymentDeclined?: PaymentDeclined;
|
|
2710
|
+
/** Receipt was added for associated payment. */
|
|
2711
|
+
receiptCreated?: ReceiptCreated;
|
|
2712
|
+
/** Receipt sent to customer. */
|
|
2713
|
+
receiptSent?: ReceiptSent;
|
|
2714
|
+
/** Order received a chargeback for one of its' payments. */
|
|
2715
|
+
chargebackCreated?: ChargebackCreated;
|
|
2716
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
2717
|
+
chargebackReversed?: ChargebackReversed;
|
|
2671
2718
|
/**
|
|
2672
2719
|
* Activity ID.
|
|
2673
2720
|
* @format GUID
|
|
@@ -2696,6 +2743,53 @@ interface ActivityContentOneOf {
|
|
|
2696
2743
|
merchantComment?: MerchantComment;
|
|
2697
2744
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2698
2745
|
orderRefunded?: OrderRefunded;
|
|
2746
|
+
/** Details of changes made by the Draft Orders API. */
|
|
2747
|
+
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
2748
|
+
/** Details of the payment method saved for order */
|
|
2749
|
+
savedPaymentMethod?: SavedPaymentMethod;
|
|
2750
|
+
/** Details of an authorized payment created. */
|
|
2751
|
+
authorizedPaymentCreated?: AuthorizedPaymentCreated;
|
|
2752
|
+
/** Details of an authorized payment captured. */
|
|
2753
|
+
authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
|
|
2754
|
+
/** Details of an authorized payment voided. */
|
|
2755
|
+
authorizedPaymentVoided?: AuthorizedPaymentVoided;
|
|
2756
|
+
/**
|
|
2757
|
+
* Details of an initiated refund process.
|
|
2758
|
+
*
|
|
2759
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
2760
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
2761
|
+
*/
|
|
2762
|
+
refundInitiated?: RefundInitiated;
|
|
2763
|
+
/**
|
|
2764
|
+
* Details of a refunded payment.
|
|
2765
|
+
*
|
|
2766
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
2767
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
2768
|
+
*/
|
|
2769
|
+
paymentRefunded?: PaymentRefunded;
|
|
2770
|
+
/**
|
|
2771
|
+
* Details of a failed payment refund.
|
|
2772
|
+
*
|
|
2773
|
+
* > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
|
|
2774
|
+
* > In these cases, the `refundId` will be identical across the activities.
|
|
2775
|
+
*/
|
|
2776
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
2777
|
+
/** Details of refund to store credit. */
|
|
2778
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
2779
|
+
/** Details of a pending payment. */
|
|
2780
|
+
paymentPending?: PaymentPending;
|
|
2781
|
+
/** Details of a canceled payment. */
|
|
2782
|
+
paymentCanceled?: PaymentCanceled;
|
|
2783
|
+
/** Details of a declined payment. */
|
|
2784
|
+
paymentDeclined?: PaymentDeclined;
|
|
2785
|
+
/** Receipt was added for associated payment. */
|
|
2786
|
+
receiptCreated?: ReceiptCreated;
|
|
2787
|
+
/** Receipt sent to customer. */
|
|
2788
|
+
receiptSent?: ReceiptSent;
|
|
2789
|
+
/** Order received a chargeback for one of its' payments. */
|
|
2790
|
+
chargebackCreated?: ChargebackCreated;
|
|
2791
|
+
/** Chargeback reversed for one of the order's payments. */
|
|
2792
|
+
chargebackReversed?: ChargebackReversed;
|
|
2699
2793
|
}
|
|
2700
2794
|
interface CustomActivity {
|
|
2701
2795
|
/**
|
|
@@ -2731,45 +2825,642 @@ interface OrderRefunded {
|
|
|
2731
2825
|
*/
|
|
2732
2826
|
reason?: string;
|
|
2733
2827
|
}
|
|
2828
|
+
interface DraftOrderChangesApplied {
|
|
2829
|
+
/** Draft order id. */
|
|
2830
|
+
draftOrderId?: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* Reason for edit, given by user (optional).
|
|
2833
|
+
* @maxLength 200
|
|
2834
|
+
*/
|
|
2835
|
+
reason?: string | null;
|
|
2836
|
+
/** Changes applied to order. */
|
|
2837
|
+
changes?: OrderChange[];
|
|
2838
|
+
}
|
|
2839
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
2840
|
+
lineItemChanged?: LineItemChanges;
|
|
2841
|
+
lineItemAdded?: ManagedLineItem;
|
|
2842
|
+
lineItemRemoved?: ManagedLineItem;
|
|
2843
|
+
discountAdded?: ManagedDiscount;
|
|
2844
|
+
discountRemoved?: ManagedDiscount;
|
|
2845
|
+
additionalFeeAdded?: ManagedAdditionalFee;
|
|
2846
|
+
additionalFeeRemoved?: ManagedAdditionalFee;
|
|
2847
|
+
totalPriceChanged?: TotalPriceChange;
|
|
2848
|
+
shippingInformationChanged?: ShippingInformationChange;
|
|
2849
|
+
}
|
|
2850
|
+
/** @oneof */
|
|
2851
|
+
interface OrderChangeValueOneOf {
|
|
2852
|
+
lineItemChanged?: LineItemChanges;
|
|
2853
|
+
lineItemAdded?: ManagedLineItem;
|
|
2854
|
+
lineItemRemoved?: ManagedLineItem;
|
|
2855
|
+
discountAdded?: ManagedDiscount;
|
|
2856
|
+
discountRemoved?: ManagedDiscount;
|
|
2857
|
+
additionalFeeAdded?: ManagedAdditionalFee;
|
|
2858
|
+
additionalFeeRemoved?: ManagedAdditionalFee;
|
|
2859
|
+
totalPriceChanged?: TotalPriceChange;
|
|
2860
|
+
shippingInformationChanged?: ShippingInformationChange;
|
|
2861
|
+
}
|
|
2862
|
+
interface LineItemChanges {
|
|
2863
|
+
/**
|
|
2864
|
+
* Line item ID.
|
|
2865
|
+
* @format GUID
|
|
2866
|
+
*/
|
|
2867
|
+
id?: string;
|
|
2868
|
+
/** Item name. */
|
|
2869
|
+
name?: ProductName;
|
|
2870
|
+
/** Item quantity change. */
|
|
2871
|
+
quantity?: LineItemQuantityChange;
|
|
2872
|
+
/** Item price change. */
|
|
2873
|
+
price?: LineItemPriceChange;
|
|
2874
|
+
}
|
|
2875
|
+
interface LineItemQuantityChange {
|
|
2876
|
+
/**
|
|
2877
|
+
* Item quantity before update.
|
|
2878
|
+
* @max 1000000
|
|
2879
|
+
*/
|
|
2880
|
+
originalQuantity?: number;
|
|
2881
|
+
/**
|
|
2882
|
+
* Item quantity after update.
|
|
2883
|
+
* @max 1000000
|
|
2884
|
+
*/
|
|
2885
|
+
newQuantity?: number;
|
|
2886
|
+
/**
|
|
2887
|
+
* Difference between original and new quantity. Absolute value.
|
|
2888
|
+
* @min 1
|
|
2889
|
+
* @max 1000000
|
|
2890
|
+
*/
|
|
2891
|
+
diff?: number;
|
|
2892
|
+
/** Type of quantity change: increase or decrease. */
|
|
2893
|
+
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
2894
|
+
}
|
|
2895
|
+
declare enum LineItemQuantityChangeType {
|
|
2896
|
+
/** Quantity increased. */
|
|
2897
|
+
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2898
|
+
/** Quantity decreased. */
|
|
2899
|
+
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2900
|
+
}
|
|
2901
|
+
/** @enumType */
|
|
2902
|
+
type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
2903
|
+
interface LineItemPriceChange {
|
|
2904
|
+
/** Item price before update. */
|
|
2905
|
+
originalPrice?: Price;
|
|
2906
|
+
/** Item price after update. */
|
|
2907
|
+
newPrice?: Price;
|
|
2908
|
+
}
|
|
2909
|
+
interface ManagedLineItem {
|
|
2910
|
+
/**
|
|
2911
|
+
* Line item ID.
|
|
2912
|
+
* @format GUID
|
|
2913
|
+
*/
|
|
2914
|
+
id?: string;
|
|
2915
|
+
/** Item name. */
|
|
2916
|
+
name?: ProductName;
|
|
2917
|
+
/**
|
|
2918
|
+
* Added or removed item quantity.
|
|
2919
|
+
* @min 1
|
|
2920
|
+
* @max 1000000
|
|
2921
|
+
*/
|
|
2922
|
+
quantity?: number;
|
|
2923
|
+
}
|
|
2924
|
+
interface ManagedDiscount {
|
|
2925
|
+
/**
|
|
2926
|
+
* Discount id.
|
|
2927
|
+
* @format GUID
|
|
2928
|
+
*/
|
|
2929
|
+
id?: string;
|
|
2930
|
+
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2931
|
+
name?: TranslatedValue;
|
|
2932
|
+
/** Line items discount applies to. */
|
|
2933
|
+
affectedLineItems?: LineItemAmount[];
|
|
2934
|
+
/** Discount amount. */
|
|
2935
|
+
totalAmount?: Price;
|
|
2936
|
+
}
|
|
2937
|
+
interface TranslatedValue {
|
|
2938
|
+
/**
|
|
2939
|
+
* Value in site default language.
|
|
2940
|
+
* @minLength 1
|
|
2941
|
+
*/
|
|
2942
|
+
original?: string;
|
|
2943
|
+
/**
|
|
2944
|
+
* Translated value.
|
|
2945
|
+
* @minLength 1
|
|
2946
|
+
*/
|
|
2947
|
+
translated?: string | null;
|
|
2948
|
+
}
|
|
2949
|
+
interface LineItemAmount {
|
|
2950
|
+
/**
|
|
2951
|
+
* Order line item id
|
|
2952
|
+
* @format GUID
|
|
2953
|
+
*/
|
|
2954
|
+
id?: string;
|
|
2955
|
+
/** Item name. */
|
|
2956
|
+
name?: ProductName;
|
|
2957
|
+
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
2958
|
+
amount?: Price;
|
|
2959
|
+
}
|
|
2960
|
+
interface ManagedAdditionalFee {
|
|
2961
|
+
/**
|
|
2962
|
+
* Additional fee id.
|
|
2963
|
+
* @format GUID
|
|
2964
|
+
*/
|
|
2965
|
+
id?: string;
|
|
2966
|
+
/** Additional fee name. */
|
|
2967
|
+
name?: TranslatedValue;
|
|
2968
|
+
/** Line items additional fee applies to. */
|
|
2969
|
+
affectedLineItems?: LineItemAmount[];
|
|
2970
|
+
/** Additional fee amount. */
|
|
2971
|
+
totalAmount?: Price;
|
|
2972
|
+
}
|
|
2973
|
+
interface TotalPriceChange {
|
|
2974
|
+
/** Order’s total price after discounts and tax. Before update */
|
|
2975
|
+
originalTotal?: Price;
|
|
2976
|
+
/** Order’s total price after discounts and tax. After update */
|
|
2977
|
+
newTotal?: Price;
|
|
2978
|
+
}
|
|
2979
|
+
interface ShippingInformationChange {
|
|
2980
|
+
/** Order’s Shipping Information. Before update */
|
|
2981
|
+
originalShippingInfo?: ShippingInformation;
|
|
2982
|
+
/** Order’s Shipping Information. After update */
|
|
2983
|
+
newShippingInfo?: ShippingInformation;
|
|
2984
|
+
}
|
|
2985
|
+
interface ShippingInformation {
|
|
2986
|
+
/** Order’s shipping price. */
|
|
2987
|
+
total?: Price;
|
|
2988
|
+
/**
|
|
2989
|
+
* Order’s shipping title.
|
|
2990
|
+
* @maxLength 250
|
|
2991
|
+
*/
|
|
2992
|
+
shippingTitle?: string;
|
|
2993
|
+
}
|
|
2994
|
+
/** Payment method is saved for order */
|
|
2995
|
+
interface SavedPaymentMethod {
|
|
2996
|
+
/**
|
|
2997
|
+
* Payment method name
|
|
2998
|
+
* @minLength 1
|
|
2999
|
+
* @maxLength 100
|
|
3000
|
+
*/
|
|
3001
|
+
name?: string;
|
|
3002
|
+
/**
|
|
3003
|
+
* Payment method description
|
|
3004
|
+
* @minLength 1
|
|
3005
|
+
* @maxLength 100
|
|
3006
|
+
*/
|
|
3007
|
+
description?: string | null;
|
|
3008
|
+
}
|
|
3009
|
+
interface AuthorizedPaymentCreated {
|
|
3010
|
+
/**
|
|
3011
|
+
* Payment ID of payment associated with this activity
|
|
3012
|
+
* @format GUID
|
|
3013
|
+
*/
|
|
3014
|
+
paymentId?: string;
|
|
3015
|
+
/** Payment amount */
|
|
3016
|
+
amount?: Price;
|
|
3017
|
+
/**
|
|
3018
|
+
* The last 4 digits of the card number.
|
|
3019
|
+
* @maxLength 4
|
|
3020
|
+
*/
|
|
3021
|
+
lastFourDigits?: string | null;
|
|
3022
|
+
/**
|
|
3023
|
+
* Card issuer's brand.
|
|
3024
|
+
* @maxLength 100
|
|
3025
|
+
*/
|
|
3026
|
+
brand?: string | null;
|
|
3027
|
+
}
|
|
3028
|
+
interface AuthorizedPaymentCaptured {
|
|
3029
|
+
/**
|
|
3030
|
+
* Payment ID of payment associated with this activity
|
|
3031
|
+
* @format GUID
|
|
3032
|
+
*/
|
|
3033
|
+
paymentId?: string;
|
|
3034
|
+
/** Payment amount */
|
|
3035
|
+
amount?: Price;
|
|
3036
|
+
/**
|
|
3037
|
+
* The last 4 digits of the card number.
|
|
3038
|
+
* @maxLength 4
|
|
3039
|
+
*/
|
|
3040
|
+
lastFourDigits?: string | null;
|
|
3041
|
+
/**
|
|
3042
|
+
* Card issuer's brand.
|
|
3043
|
+
* @maxLength 100
|
|
3044
|
+
*/
|
|
3045
|
+
brand?: string | null;
|
|
3046
|
+
}
|
|
3047
|
+
interface AuthorizedPaymentVoided {
|
|
3048
|
+
/**
|
|
3049
|
+
* Payment ID of payment associated with this activity
|
|
3050
|
+
* @format GUID
|
|
3051
|
+
*/
|
|
3052
|
+
paymentId?: string;
|
|
3053
|
+
/** Payment amount */
|
|
3054
|
+
amount?: Price;
|
|
3055
|
+
/**
|
|
3056
|
+
* The last 4 digits of the card number.
|
|
3057
|
+
* @maxLength 4
|
|
3058
|
+
*/
|
|
3059
|
+
lastFourDigits?: string | null;
|
|
3060
|
+
/**
|
|
3061
|
+
* Card issuer's brand.
|
|
3062
|
+
* @maxLength 100
|
|
3063
|
+
*/
|
|
3064
|
+
brand?: string | null;
|
|
3065
|
+
}
|
|
3066
|
+
interface RefundInitiated {
|
|
3067
|
+
/**
|
|
3068
|
+
* Refund ID.
|
|
3069
|
+
* @format GUID
|
|
3070
|
+
*/
|
|
3071
|
+
refundId?: string;
|
|
3072
|
+
/** Refund amount. */
|
|
3073
|
+
amount?: Price;
|
|
3074
|
+
/**
|
|
3075
|
+
* Details about the payments being refunded.
|
|
3076
|
+
* @minSize 1
|
|
3077
|
+
* @maxSize 50
|
|
3078
|
+
*/
|
|
3079
|
+
payments?: RefundedPayment[];
|
|
3080
|
+
/**
|
|
3081
|
+
* Reason for refund.
|
|
3082
|
+
* @maxLength 200
|
|
3083
|
+
*/
|
|
3084
|
+
reason?: string | null;
|
|
3085
|
+
}
|
|
3086
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
3087
|
+
/** Regular payment refund. */
|
|
3088
|
+
regular?: RegularPaymentRefund;
|
|
3089
|
+
/** Gift card payment refund. */
|
|
3090
|
+
giftCard?: GiftCardPaymentRefund;
|
|
3091
|
+
/** Membership payment refund. */
|
|
3092
|
+
membership?: MembershipPaymentRefund;
|
|
3093
|
+
/**
|
|
3094
|
+
* Payment ID.
|
|
3095
|
+
* @format GUID
|
|
3096
|
+
*/
|
|
3097
|
+
paymentId?: string;
|
|
3098
|
+
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
3099
|
+
externalRefund?: boolean;
|
|
3100
|
+
}
|
|
3101
|
+
/** @oneof */
|
|
3102
|
+
interface RefundedPaymentKindOneOf {
|
|
3103
|
+
/** Regular payment refund. */
|
|
3104
|
+
regular?: RegularPaymentRefund;
|
|
3105
|
+
/** Gift card payment refund. */
|
|
3106
|
+
giftCard?: GiftCardPaymentRefund;
|
|
3107
|
+
/** Membership payment refund. */
|
|
3108
|
+
membership?: MembershipPaymentRefund;
|
|
3109
|
+
}
|
|
3110
|
+
interface RegularPaymentRefund {
|
|
3111
|
+
/** Refund amount */
|
|
3112
|
+
amount?: Price;
|
|
3113
|
+
/**
|
|
3114
|
+
* The last 4 digits of the card number.
|
|
3115
|
+
* @maxLength 4
|
|
3116
|
+
*/
|
|
3117
|
+
lastFourDigits?: string | null;
|
|
3118
|
+
/**
|
|
3119
|
+
* Card issuer's brand.
|
|
3120
|
+
* @maxLength 100
|
|
3121
|
+
*/
|
|
3122
|
+
brand?: string | null;
|
|
3123
|
+
}
|
|
3124
|
+
interface GiftCardPaymentRefund {
|
|
3125
|
+
/**
|
|
3126
|
+
* Gift card payment ID
|
|
3127
|
+
* @minLength 1
|
|
3128
|
+
* @maxLength 100
|
|
3129
|
+
*/
|
|
3130
|
+
giftCardPaymentId?: string | null;
|
|
3131
|
+
/** Refund amount */
|
|
3132
|
+
amount?: Price;
|
|
3133
|
+
}
|
|
3134
|
+
interface MembershipPaymentRefund {
|
|
3135
|
+
/**
|
|
3136
|
+
* Membership ID
|
|
3137
|
+
* @minLength 1
|
|
3138
|
+
* @maxLength 100
|
|
3139
|
+
*/
|
|
3140
|
+
membershipId?: string | null;
|
|
3141
|
+
}
|
|
3142
|
+
interface PaymentRefunded {
|
|
3143
|
+
/**
|
|
3144
|
+
* Refund ID.
|
|
3145
|
+
* @format GUID
|
|
3146
|
+
*/
|
|
3147
|
+
refundId?: string;
|
|
3148
|
+
/** Details about the refunded payment. */
|
|
3149
|
+
payment?: RefundedPayment;
|
|
3150
|
+
}
|
|
3151
|
+
interface PaymentRefundFailed {
|
|
3152
|
+
/**
|
|
3153
|
+
* Refund ID.
|
|
3154
|
+
* @format GUID
|
|
3155
|
+
*/
|
|
3156
|
+
refundId?: string;
|
|
3157
|
+
/** Details about the failed payment refund. */
|
|
3158
|
+
payment?: RefundedPayment;
|
|
3159
|
+
}
|
|
3160
|
+
interface RefundedAsStoreCredit {
|
|
3161
|
+
/** Refund amount */
|
|
3162
|
+
amount?: Price;
|
|
3163
|
+
/**
|
|
3164
|
+
* Reason for refund
|
|
3165
|
+
* @maxLength 100
|
|
3166
|
+
*/
|
|
3167
|
+
reason?: string | null;
|
|
3168
|
+
}
|
|
3169
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
3170
|
+
/** Regular payment. */
|
|
3171
|
+
regular?: RegularPayment;
|
|
3172
|
+
/**
|
|
3173
|
+
* Payment ID of payment associated with this activity
|
|
3174
|
+
* @format GUID
|
|
3175
|
+
*/
|
|
3176
|
+
paymentId?: string;
|
|
3177
|
+
}
|
|
3178
|
+
/** @oneof */
|
|
3179
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
3180
|
+
/** Regular payment. */
|
|
3181
|
+
regular?: RegularPayment;
|
|
3182
|
+
}
|
|
3183
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
3184
|
+
/** Whether regular card used */
|
|
3185
|
+
creditCardDetails?: CreditCardDetails;
|
|
3186
|
+
/** Payment amount */
|
|
3187
|
+
amount?: Price;
|
|
3188
|
+
}
|
|
3189
|
+
/** @oneof */
|
|
3190
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
3191
|
+
/** Whether regular card used */
|
|
3192
|
+
creditCardDetails?: CreditCardDetails;
|
|
3193
|
+
}
|
|
3194
|
+
interface CreditCardDetails {
|
|
3195
|
+
/**
|
|
3196
|
+
* The last 4 digits of the card number.
|
|
3197
|
+
* @maxLength 4
|
|
3198
|
+
*/
|
|
3199
|
+
lastFourDigits?: string | null;
|
|
3200
|
+
/**
|
|
3201
|
+
* Card issuer's brand.
|
|
3202
|
+
* @maxLength 100
|
|
3203
|
+
*/
|
|
3204
|
+
brand?: string | null;
|
|
3205
|
+
}
|
|
3206
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
3207
|
+
/** Regular payment. */
|
|
3208
|
+
regular?: RegularPayment;
|
|
3209
|
+
/**
|
|
3210
|
+
* Payment ID of payment associated with this activity
|
|
3211
|
+
* @format GUID
|
|
3212
|
+
*/
|
|
3213
|
+
paymentId?: string;
|
|
3214
|
+
}
|
|
3215
|
+
/** @oneof */
|
|
3216
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
3217
|
+
/** Regular payment. */
|
|
3218
|
+
regular?: RegularPayment;
|
|
3219
|
+
}
|
|
3220
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
3221
|
+
/** Regular payment. */
|
|
3222
|
+
regular?: RegularPayment;
|
|
3223
|
+
/**
|
|
3224
|
+
* Payment ID of payment associated with this activity
|
|
3225
|
+
* @format GUID
|
|
3226
|
+
*/
|
|
3227
|
+
paymentId?: string;
|
|
3228
|
+
}
|
|
3229
|
+
/** @oneof */
|
|
3230
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
3231
|
+
/** Regular payment. */
|
|
3232
|
+
regular?: RegularPayment;
|
|
3233
|
+
}
|
|
3234
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
3235
|
+
/** Receipt created by Wix */
|
|
3236
|
+
wixReceipt?: WixReceipt;
|
|
3237
|
+
/** Receipt created by an external system. */
|
|
3238
|
+
externalReceipt?: ExternalReceipt;
|
|
3239
|
+
/**
|
|
3240
|
+
* Payment ID of payment associated with this activity
|
|
3241
|
+
* @format GUID
|
|
3242
|
+
*/
|
|
3243
|
+
paymentId?: string;
|
|
3244
|
+
}
|
|
3245
|
+
/** @oneof */
|
|
3246
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
3247
|
+
/** Receipt created by Wix */
|
|
3248
|
+
wixReceipt?: WixReceipt;
|
|
3249
|
+
/** Receipt created by an external system. */
|
|
3250
|
+
externalReceipt?: ExternalReceipt;
|
|
3251
|
+
}
|
|
3252
|
+
interface WixReceipt {
|
|
3253
|
+
/**
|
|
3254
|
+
* Receipt ID
|
|
3255
|
+
* @format GUID
|
|
3256
|
+
*/
|
|
3257
|
+
receiptId?: string;
|
|
3258
|
+
/**
|
|
3259
|
+
* Display number of receipt
|
|
3260
|
+
* @minLength 1
|
|
3261
|
+
* @maxLength 40
|
|
3262
|
+
*/
|
|
3263
|
+
displayNumber?: string | null;
|
|
3264
|
+
}
|
|
3265
|
+
interface ExternalReceipt {
|
|
3266
|
+
/**
|
|
3267
|
+
* Receipt ID
|
|
3268
|
+
* @maxLength 100
|
|
3269
|
+
*/
|
|
3270
|
+
receiptId?: string | null;
|
|
3271
|
+
/**
|
|
3272
|
+
* Display number of receipt
|
|
3273
|
+
* @minLength 1
|
|
3274
|
+
* @maxLength 40
|
|
3275
|
+
*/
|
|
3276
|
+
displayNumber?: string | null;
|
|
3277
|
+
}
|
|
3278
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
3279
|
+
/** Receipt created by Wix */
|
|
3280
|
+
wixReceipt?: WixReceipt;
|
|
3281
|
+
/** Receipt created by an external system. */
|
|
3282
|
+
externalReceipt?: ExternalReceipt;
|
|
3283
|
+
/**
|
|
3284
|
+
* Payment ID of payment associated with this activity
|
|
3285
|
+
* @format GUID
|
|
3286
|
+
*/
|
|
3287
|
+
paymentId?: string;
|
|
3288
|
+
}
|
|
3289
|
+
/** @oneof */
|
|
3290
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
3291
|
+
/** Receipt created by Wix */
|
|
3292
|
+
wixReceipt?: WixReceipt;
|
|
3293
|
+
/** Receipt created by an external system. */
|
|
3294
|
+
externalReceipt?: ExternalReceipt;
|
|
3295
|
+
}
|
|
3296
|
+
interface ChargebackCreated {
|
|
3297
|
+
/**
|
|
3298
|
+
* ID of the payment that received a chargeback.
|
|
3299
|
+
* @format GUID
|
|
3300
|
+
*/
|
|
3301
|
+
paymentId?: string;
|
|
3302
|
+
/**
|
|
3303
|
+
* Chargeback ID.
|
|
3304
|
+
* @format GUID
|
|
3305
|
+
*/
|
|
3306
|
+
chargebackId?: string;
|
|
3307
|
+
/** Chargeback amount. */
|
|
3308
|
+
amount?: Price;
|
|
3309
|
+
/** Payment details. */
|
|
3310
|
+
paymentDetails?: RegularPayment;
|
|
3311
|
+
}
|
|
3312
|
+
interface ChargebackReversed {
|
|
3313
|
+
/**
|
|
3314
|
+
* ID of the payment involved with the chargeback.
|
|
3315
|
+
* @format GUID
|
|
3316
|
+
*/
|
|
3317
|
+
paymentId?: string;
|
|
3318
|
+
/**
|
|
3319
|
+
* Chargeback ID.
|
|
3320
|
+
* @format GUID
|
|
3321
|
+
*/
|
|
3322
|
+
chargebackId?: string;
|
|
3323
|
+
/** Chargeback amount. */
|
|
3324
|
+
amount?: Price;
|
|
3325
|
+
/** Chargeback reversal amount. */
|
|
3326
|
+
reversalAmount?: Price;
|
|
3327
|
+
/** Payment details. */
|
|
3328
|
+
paymentDetails?: RegularPayment;
|
|
3329
|
+
}
|
|
2734
3330
|
declare enum ActivityType {
|
|
3331
|
+
/** Order was refunded, either partially or fully. */
|
|
2735
3332
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3333
|
+
/** New order was created and placed. */
|
|
2736
3334
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3335
|
+
/** Order payment was completed and confirmed. */
|
|
2737
3336
|
ORDER_PAID = "ORDER_PAID",
|
|
3337
|
+
/** Order items were marked as fulfilled (shipped or ready for pickup). */
|
|
2738
3338
|
ORDER_FULFILLED = "ORDER_FULFILLED",
|
|
3339
|
+
/** Order fulfillment status was changed to not fulfilled. */
|
|
2739
3340
|
ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
|
|
3341
|
+
/** Order was canceled by merchant or customer. */
|
|
2740
3342
|
ORDER_CANCELED = "ORDER_CANCELED",
|
|
3343
|
+
/** Download link was sent for digital items in the order. */
|
|
2741
3344
|
DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
|
|
3345
|
+
/** Shipping tracking number was added to the order. */
|
|
2742
3346
|
TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
|
|
3347
|
+
/** Existing shipping tracking number was modified. */
|
|
2743
3348
|
TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
|
|
3349
|
+
/** Tracking link for shipment was added to the order. */
|
|
2744
3350
|
TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
|
|
3351
|
+
/** Email confirming shipment was sent to the customer. */
|
|
2745
3352
|
SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
|
|
3353
|
+
/** Invoice document was added to the order. */
|
|
2746
3354
|
INVOICE_ADDED = "INVOICE_ADDED",
|
|
3355
|
+
/** Invoice was removed from the order. */
|
|
2747
3356
|
INVOICE_REMOVED = "INVOICE_REMOVED",
|
|
3357
|
+
/** Invoice was sent to the customer via email. */
|
|
2748
3358
|
INVOICE_SENT = "INVOICE_SENT",
|
|
3359
|
+
/** Notification email was sent to the order fulfiller. */
|
|
2749
3360
|
FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
|
|
3361
|
+
/** Order's shipping address was modified. */
|
|
2750
3362
|
SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
|
|
3363
|
+
/** Order's contact email address was changed. */
|
|
2751
3364
|
EMAIL_EDITED = "EMAIL_EDITED",
|
|
3365
|
+
/** Email notification for pickup readiness was sent. */
|
|
2752
3366
|
PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
|
|
3367
|
+
/** Custom activity created by a third-party application. */
|
|
2753
3368
|
CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
|
|
3369
|
+
/** Comment added to the order by a merchant. */
|
|
2754
3370
|
MERCHANT_COMMENT = "MERCHANT_COMMENT",
|
|
3371
|
+
/** Order was created as a result of an exchange. */
|
|
2755
3372
|
ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
|
|
3373
|
+
/** New exchange order was created from this order. */
|
|
2756
3374
|
NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
|
|
3375
|
+
/** Partial payment was received for the order. */
|
|
2757
3376
|
ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
|
|
3377
|
+
/** Changes were applied to a draft order. */
|
|
2758
3378
|
DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
|
|
3379
|
+
/** Payment method was saved for future use. */
|
|
2759
3380
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
2760
|
-
/**
|
|
3381
|
+
/**
|
|
3382
|
+
* Payment was authorized but not yet captured.
|
|
3383
|
+
* @documentationMaturity preview
|
|
3384
|
+
*/
|
|
3385
|
+
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
3386
|
+
/**
|
|
3387
|
+
* Previously authorized payment was captured.
|
|
3388
|
+
* @documentationMaturity preview
|
|
3389
|
+
*/
|
|
3390
|
+
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
3391
|
+
/**
|
|
3392
|
+
* Previously authorized payment was voided.
|
|
3393
|
+
* @documentationMaturity preview
|
|
3394
|
+
*/
|
|
3395
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
3396
|
+
/**
|
|
3397
|
+
* Refund process was initiated.
|
|
3398
|
+
* @documentationMaturity preview
|
|
3399
|
+
*/
|
|
3400
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
3401
|
+
/**
|
|
3402
|
+
* Payment was successfully refunded.
|
|
3403
|
+
* @documentationMaturity preview
|
|
3404
|
+
*/
|
|
3405
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
3406
|
+
/**
|
|
3407
|
+
* Attempt to refund payment failed.
|
|
3408
|
+
* @documentationMaturity preview
|
|
3409
|
+
*/
|
|
3410
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED",
|
|
3411
|
+
/**
|
|
3412
|
+
* Refund was issued as store credit.
|
|
3413
|
+
* @documentationMaturity preview
|
|
3414
|
+
*/
|
|
3415
|
+
REFUNDED_AS_STORE_CREDIT = "REFUNDED_AS_STORE_CREDIT",
|
|
3416
|
+
/**
|
|
3417
|
+
* Payment is awaiting processing or confirmation.
|
|
3418
|
+
* @documentationMaturity preview
|
|
3419
|
+
*/
|
|
2761
3420
|
PAYMENT_PENDING = "PAYMENT_PENDING",
|
|
2762
|
-
/**
|
|
3421
|
+
/**
|
|
3422
|
+
* Payment was canceled before completion.
|
|
3423
|
+
* @documentationMaturity preview
|
|
3424
|
+
*/
|
|
2763
3425
|
PAYMENT_CANCELED = "PAYMENT_CANCELED",
|
|
2764
|
-
/**
|
|
3426
|
+
/**
|
|
3427
|
+
* Payment was declined by payment provider.
|
|
3428
|
+
* @documentationMaturity preview
|
|
3429
|
+
*/
|
|
2765
3430
|
PAYMENT_DECLINED = "PAYMENT_DECLINED",
|
|
2766
|
-
/**
|
|
3431
|
+
/**
|
|
3432
|
+
* Order is awaiting approval or processing.
|
|
3433
|
+
* @documentationMaturity preview
|
|
3434
|
+
*/
|
|
2767
3435
|
ORDER_PENDING = "ORDER_PENDING",
|
|
2768
|
-
/**
|
|
2769
|
-
|
|
3436
|
+
/**
|
|
3437
|
+
* Order was rejected by merchant.
|
|
3438
|
+
* @documentationMaturity preview
|
|
3439
|
+
*/
|
|
3440
|
+
ORDER_REJECTED = "ORDER_REJECTED",
|
|
3441
|
+
/**
|
|
3442
|
+
* Receipt was generated for a payment.
|
|
3443
|
+
* @documentationMaturity preview
|
|
3444
|
+
*/
|
|
3445
|
+
RECEIPT_CREATED = "RECEIPT_CREATED",
|
|
3446
|
+
/**
|
|
3447
|
+
* Receipt was sent to the customer.
|
|
3448
|
+
* @documentationMaturity preview
|
|
3449
|
+
*/
|
|
3450
|
+
RECEIPT_SENT = "RECEIPT_SENT",
|
|
3451
|
+
/**
|
|
3452
|
+
* Chargeback was created for one of the order's payments.
|
|
3453
|
+
* @documentationMaturity preview
|
|
3454
|
+
*/
|
|
3455
|
+
CHARGEBACK_CREATED = "CHARGEBACK_CREATED",
|
|
3456
|
+
/**
|
|
3457
|
+
* Chargeback was resolved in merchant's favor.
|
|
3458
|
+
* @documentationMaturity preview
|
|
3459
|
+
*/
|
|
3460
|
+
CHARGEBACK_REVERSED = "CHARGEBACK_REVERSED"
|
|
2770
3461
|
}
|
|
2771
3462
|
/** @enumType */
|
|
2772
|
-
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
3463
|
+
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'AUTHORIZED_PAYMENT_CREATED' | 'AUTHORIZED_PAYMENT_CAPTURED' | 'AUTHORIZED_PAYMENT_VOIDED' | 'REFUND_INITIATED' | 'PAYMENT_REFUNDED' | 'PAYMENT_REFUND_FAILED' | 'REFUNDED_AS_STORE_CREDIT' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED' | 'RECEIPT_CREATED' | 'RECEIPT_SENT' | 'CHARGEBACK_CREATED' | 'CHARGEBACK_REVERSED';
|
|
2773
3464
|
declare enum AttributionSource {
|
|
2774
3465
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2775
3466
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
@@ -2914,11 +3605,26 @@ interface V1BalanceSummary {
|
|
|
2914
3605
|
* @readonly
|
|
2915
3606
|
*/
|
|
2916
3607
|
authorized?: Price;
|
|
3608
|
+
/**
|
|
3609
|
+
* Sum of all pending refund transactions.
|
|
3610
|
+
* @readonly
|
|
3611
|
+
*/
|
|
3612
|
+
pendingRefund?: Price;
|
|
2917
3613
|
/**
|
|
2918
3614
|
* Sum of all pending transactions.
|
|
2919
3615
|
* @readonly
|
|
2920
3616
|
*/
|
|
2921
3617
|
pending?: Price;
|
|
3618
|
+
/**
|
|
3619
|
+
* Sum of all transaction chargebacks.
|
|
3620
|
+
* @readonly
|
|
3621
|
+
*/
|
|
3622
|
+
chargeback?: Price;
|
|
3623
|
+
/**
|
|
3624
|
+
* Sum of all chargeback reversals.
|
|
3625
|
+
* @readonly
|
|
3626
|
+
*/
|
|
3627
|
+
chargebackReversal?: Price;
|
|
2922
3628
|
}
|
|
2923
3629
|
/**
|
|
2924
3630
|
* Common object for tags.
|