@wix/auto_sdk_ecom_order-transactions 1.0.19 → 1.0.21
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/ecom-v1-order-transactions-order-transactions.types.d.ts → ecom-v1-order-transactions-order-transactions.universal-DRvhf2o2.d.mts} +246 -224
- package/build/{internal/cjs/src/ecom-v1-order-transactions-order-transactions.types.d.ts → ecom-v1-order-transactions-order-transactions.universal-DRvhf2o2.d.ts} +246 -224
- package/build/index.d.mts +69 -0
- package/build/index.d.ts +69 -0
- package/build/index.js +942 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +887 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/ecom-v1-order-transactions-order-transactions.types.d.ts → internal/ecom-v1-order-transactions-order-transactions.universal-aENRFMbJ.d.mts} +330 -224
- package/build/internal/{es/src/ecom-v1-order-transactions-order-transactions.types.d.ts → ecom-v1-order-transactions-order-transactions.universal-aENRFMbJ.d.ts} +330 -224
- package/build/internal/index.d.mts +118 -0
- package/build/internal/index.d.ts +118 -0
- package/build/internal/index.js +942 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +887 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +614 -0
- package/build/internal/meta.d.ts +614 -0
- package/build/internal/meta.js +566 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +533 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +614 -0
- package/build/meta.d.ts +614 -0
- package/build/meta.js +566 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +533 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -9
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.context.js +0 -41
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.http.js +0 -466
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -161
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -63
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.public.js +0 -76
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.types.js +0 -303
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2589
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -695
- package/build/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -9
- package/build/es/src/ecom-v1-order-transactions-order-transactions.context.js +0 -13
- package/build/es/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
- package/build/es/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
- package/build/es/src/ecom-v1-order-transactions-order-transactions.http.js +0 -456
- package/build/es/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
- package/build/es/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
- package/build/es/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -128
- package/build/es/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
- package/build/es/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -63
- package/build/es/src/ecom-v1-order-transactions-order-transactions.public.js +0 -41
- package/build/es/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
- package/build/es/src/ecom-v1-order-transactions-order-transactions.types.js +0 -300
- package/build/es/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
- package/build/es/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2589
- package/build/es/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -662
- package/build/es/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -13
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.context.js +0 -41
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.http.js +0 -466
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -161
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -108
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.public.js +0 -76
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.types.js +0 -303
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2740
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -695
- package/build/internal/cjs/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.context.d.ts +0 -13
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.context.js +0 -13
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.http.d.ts +0 -73
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.http.js +0 -456
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.meta.d.ts +0 -30
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.meta.js +0 -128
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.public.d.ts +0 -108
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.public.js +0 -41
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.types.js +0 -300
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.universal.d.ts +0 -2740
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.universal.js +0 -662
- package/build/internal/es/src/ecom-v1-order-transactions-order-transactions.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface OrderTransactions {
|
|
2
2
|
/**
|
|
3
3
|
* Order ID.
|
|
4
4
|
* @format GUID
|
|
@@ -15,24 +15,34 @@ export interface OrderTransactions {
|
|
|
15
15
|
*/
|
|
16
16
|
refunds?: Refund[];
|
|
17
17
|
}
|
|
18
|
-
|
|
18
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
19
19
|
/** Regular payment details. */
|
|
20
20
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
21
21
|
/** Gift card payment details. */
|
|
22
22
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
23
|
+
/**
|
|
24
|
+
* Receipt created by Wix
|
|
25
|
+
* @internal
|
|
26
|
+
*/
|
|
27
|
+
wixReceipt?: WixReceiptInfo;
|
|
28
|
+
/**
|
|
29
|
+
* Receipt created by an external system.
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
23
33
|
/**
|
|
24
34
|
* Payment ID.
|
|
25
35
|
* @format GUID
|
|
26
36
|
* @readonly
|
|
27
37
|
*/
|
|
28
|
-
|
|
38
|
+
_id?: string | null;
|
|
29
39
|
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
30
|
-
|
|
40
|
+
_createdDate?: Date | null;
|
|
31
41
|
/**
|
|
32
42
|
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
33
43
|
* @readonly
|
|
34
44
|
*/
|
|
35
|
-
|
|
45
|
+
_updatedDate?: Date | null;
|
|
36
46
|
/** Payment amount. */
|
|
37
47
|
amount?: Price;
|
|
38
48
|
/**
|
|
@@ -41,18 +51,36 @@ export interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoO
|
|
|
41
51
|
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
42
52
|
*/
|
|
43
53
|
refundDisabled?: boolean;
|
|
54
|
+
/**
|
|
55
|
+
* Whether receipt generation for this payment are allowed.
|
|
56
|
+
* + `true`: This payment supports receipt generation.
|
|
57
|
+
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
58
|
+
* @internal
|
|
59
|
+
* @readonly
|
|
60
|
+
*/
|
|
61
|
+
supportReceiptGeneration?: boolean;
|
|
44
62
|
}
|
|
45
63
|
/** @oneof */
|
|
46
|
-
|
|
64
|
+
interface PaymentPaymentDetailsOneOf {
|
|
47
65
|
/** Regular payment details. */
|
|
48
66
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
49
67
|
/** Gift card payment details. */
|
|
50
68
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
51
69
|
}
|
|
52
70
|
/** @oneof */
|
|
53
|
-
|
|
71
|
+
interface PaymentReceiptInfoOneOf {
|
|
72
|
+
/**
|
|
73
|
+
* Receipt created by Wix
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
wixReceipt?: WixReceiptInfo;
|
|
77
|
+
/**
|
|
78
|
+
* Receipt created by an external system.
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
54
82
|
}
|
|
55
|
-
|
|
83
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
56
84
|
/** Whether regular card used */
|
|
57
85
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
58
86
|
/**
|
|
@@ -88,13 +116,19 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
|
|
|
88
116
|
savedPaymentMethod?: boolean;
|
|
89
117
|
/** Authorization details. */
|
|
90
118
|
authorizationDetails?: AuthorizationDetails;
|
|
119
|
+
/**
|
|
120
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
121
|
+
* @internal
|
|
122
|
+
* @maxLength 300
|
|
123
|
+
*/
|
|
124
|
+
paymentProvider?: string | null;
|
|
91
125
|
}
|
|
92
126
|
/** @oneof */
|
|
93
|
-
|
|
127
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
94
128
|
/** Whether regular card used */
|
|
95
129
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
96
130
|
}
|
|
97
|
-
|
|
131
|
+
declare enum TransactionStatus {
|
|
98
132
|
UNDEFINED = "UNDEFINED",
|
|
99
133
|
APPROVED = "APPROVED",
|
|
100
134
|
PENDING = "PENDING",
|
|
@@ -107,8 +141,8 @@ export declare enum TransactionStatus {
|
|
|
107
141
|
VOIDED = "VOIDED"
|
|
108
142
|
}
|
|
109
143
|
/** @enumType */
|
|
110
|
-
|
|
111
|
-
|
|
144
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
145
|
+
interface CreditCardPaymentMethodDetails {
|
|
112
146
|
/**
|
|
113
147
|
* The last 4 digits of the card number.
|
|
114
148
|
* @maxLength 4
|
|
@@ -120,7 +154,7 @@ export interface CreditCardPaymentMethodDetails {
|
|
|
120
154
|
*/
|
|
121
155
|
brand?: string | null;
|
|
122
156
|
}
|
|
123
|
-
|
|
157
|
+
interface AuthorizationDetails {
|
|
124
158
|
/**
|
|
125
159
|
* Whether the authorized payment is of a delayed capture.
|
|
126
160
|
* @readonly
|
|
@@ -139,13 +173,13 @@ export interface AuthorizationDetails {
|
|
|
139
173
|
/** Scheduled action for this transaction */
|
|
140
174
|
scheduledAction?: ScheduledAction;
|
|
141
175
|
}
|
|
142
|
-
|
|
176
|
+
interface AuthorizationCapture {
|
|
143
177
|
/**
|
|
144
178
|
* Capture ID.
|
|
145
179
|
* @format GUID
|
|
146
180
|
* @readonly
|
|
147
181
|
*/
|
|
148
|
-
|
|
182
|
+
_id?: string | null;
|
|
149
183
|
/** Status of this capture action */
|
|
150
184
|
status?: AuthorizationCaptureStatusWithLiterals;
|
|
151
185
|
/**
|
|
@@ -154,11 +188,11 @@ export interface AuthorizationCapture {
|
|
|
154
188
|
*/
|
|
155
189
|
amount?: Price;
|
|
156
190
|
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
157
|
-
|
|
191
|
+
_createdDate?: Date | null;
|
|
158
192
|
/** In case of status is FAILED may contain failure details */
|
|
159
193
|
failureDetails?: AuthorizationActionFailureDetails;
|
|
160
194
|
}
|
|
161
|
-
|
|
195
|
+
declare enum AuthorizationCaptureStatus {
|
|
162
196
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
163
197
|
/** Capture operation still in progress. */
|
|
164
198
|
PENDING = "PENDING",
|
|
@@ -168,8 +202,8 @@ export declare enum AuthorizationCaptureStatus {
|
|
|
168
202
|
FAILED = "FAILED"
|
|
169
203
|
}
|
|
170
204
|
/** @enumType */
|
|
171
|
-
|
|
172
|
-
|
|
205
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
206
|
+
interface Price {
|
|
173
207
|
/**
|
|
174
208
|
* Amount.
|
|
175
209
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -181,11 +215,11 @@ export interface Price {
|
|
|
181
215
|
*/
|
|
182
216
|
formattedAmount?: string;
|
|
183
217
|
}
|
|
184
|
-
|
|
218
|
+
interface AuthorizationActionFailureDetails {
|
|
185
219
|
/** @maxLength 100 */
|
|
186
220
|
failureCode?: string;
|
|
187
221
|
}
|
|
188
|
-
|
|
222
|
+
interface AuthorizationVoid {
|
|
189
223
|
/** Status of this void action */
|
|
190
224
|
status?: AuthorizationVoidStatusWithLiterals;
|
|
191
225
|
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
@@ -195,7 +229,7 @@ export interface AuthorizationVoid {
|
|
|
195
229
|
/** Reason of void action */
|
|
196
230
|
reason?: ReasonWithLiterals;
|
|
197
231
|
}
|
|
198
|
-
|
|
232
|
+
declare enum AuthorizationVoidStatus {
|
|
199
233
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
200
234
|
/** Void operation still in progress. */
|
|
201
235
|
PENDING = "PENDING",
|
|
@@ -205,9 +239,9 @@ export declare enum AuthorizationVoidStatus {
|
|
|
205
239
|
FAILED = "FAILED"
|
|
206
240
|
}
|
|
207
241
|
/** @enumType */
|
|
208
|
-
|
|
242
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
209
243
|
/** Reason the authorization was voided. */
|
|
210
|
-
|
|
244
|
+
declare enum Reason {
|
|
211
245
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
212
246
|
/** Authorization was voided by user. */
|
|
213
247
|
MANUAL = "MANUAL",
|
|
@@ -215,21 +249,21 @@ export declare enum Reason {
|
|
|
215
249
|
SCHEDULED = "SCHEDULED"
|
|
216
250
|
}
|
|
217
251
|
/** @enumType */
|
|
218
|
-
|
|
219
|
-
|
|
252
|
+
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
253
|
+
interface ScheduledAction {
|
|
220
254
|
/** Type of the action. */
|
|
221
255
|
actionType?: ActionTypeWithLiterals;
|
|
222
256
|
/** The date and time of the action. */
|
|
223
257
|
executionDate?: Date | null;
|
|
224
258
|
}
|
|
225
|
-
|
|
259
|
+
declare enum ActionType {
|
|
226
260
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
227
261
|
VOID = "VOID",
|
|
228
262
|
CAPTURE = "CAPTURE"
|
|
229
263
|
}
|
|
230
264
|
/** @enumType */
|
|
231
|
-
|
|
232
|
-
|
|
265
|
+
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
266
|
+
interface GiftCardPaymentDetails {
|
|
233
267
|
/**
|
|
234
268
|
* Gift card payment ID.
|
|
235
269
|
* @minLength 1
|
|
@@ -246,8 +280,15 @@ export interface GiftCardPaymentDetails {
|
|
|
246
280
|
* @readonly
|
|
247
281
|
*/
|
|
248
282
|
voided?: boolean;
|
|
283
|
+
/**
|
|
284
|
+
* Gift card obfuscated code.
|
|
285
|
+
* @internal
|
|
286
|
+
* @maxLength 30
|
|
287
|
+
* @immutable
|
|
288
|
+
*/
|
|
289
|
+
obfuscatedCode?: string | null;
|
|
249
290
|
}
|
|
250
|
-
|
|
291
|
+
interface MembershipPaymentDetails {
|
|
251
292
|
/**
|
|
252
293
|
* Membership ID.
|
|
253
294
|
* @minLength 1
|
|
@@ -281,15 +322,15 @@ export interface MembershipPaymentDetails {
|
|
|
281
322
|
*/
|
|
282
323
|
providerAppId?: string;
|
|
283
324
|
}
|
|
284
|
-
|
|
325
|
+
declare enum MembershipPaymentStatus {
|
|
285
326
|
/** Payment was charged. */
|
|
286
327
|
CHARGED = "CHARGED",
|
|
287
328
|
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
288
329
|
CHARGE_FAILED = "CHARGE_FAILED"
|
|
289
330
|
}
|
|
290
331
|
/** @enumType */
|
|
291
|
-
|
|
292
|
-
|
|
332
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
333
|
+
interface MembershipName {
|
|
293
334
|
/**
|
|
294
335
|
* Membership name.
|
|
295
336
|
* @maxLength 100
|
|
@@ -301,7 +342,7 @@ export interface MembershipName {
|
|
|
301
342
|
*/
|
|
302
343
|
translated?: string | null;
|
|
303
344
|
}
|
|
304
|
-
|
|
345
|
+
interface WixReceiptInfo {
|
|
305
346
|
/**
|
|
306
347
|
* Receipt ID
|
|
307
348
|
* @format GUID
|
|
@@ -314,7 +355,7 @@ export interface WixReceiptInfo {
|
|
|
314
355
|
*/
|
|
315
356
|
displayNumber?: string | null;
|
|
316
357
|
}
|
|
317
|
-
|
|
358
|
+
interface ExternalReceiptInfo {
|
|
318
359
|
/**
|
|
319
360
|
* External receipt ID
|
|
320
361
|
* @maxLength 100
|
|
@@ -332,13 +373,13 @@ export interface ExternalReceiptInfo {
|
|
|
332
373
|
*/
|
|
333
374
|
displayNumber?: string | null;
|
|
334
375
|
}
|
|
335
|
-
|
|
376
|
+
interface Refund {
|
|
336
377
|
/**
|
|
337
378
|
* Refund ID.
|
|
338
379
|
* @format GUID
|
|
339
380
|
* @readonly
|
|
340
381
|
*/
|
|
341
|
-
|
|
382
|
+
_id?: string;
|
|
342
383
|
/**
|
|
343
384
|
* List of transactions.
|
|
344
385
|
* @maxSize 50
|
|
@@ -351,7 +392,7 @@ export interface Refund {
|
|
|
351
392
|
* @readonly
|
|
352
393
|
* @immutable
|
|
353
394
|
*/
|
|
354
|
-
|
|
395
|
+
_createdDate?: Date | null;
|
|
355
396
|
/**
|
|
356
397
|
* Aggregated refund summary.
|
|
357
398
|
* @readonly
|
|
@@ -365,7 +406,7 @@ export interface Refund {
|
|
|
365
406
|
*/
|
|
366
407
|
requestingServiceAppId?: string | null;
|
|
367
408
|
}
|
|
368
|
-
|
|
409
|
+
interface RefundTransaction {
|
|
369
410
|
/**
|
|
370
411
|
* ID of the payment associated with this refund.
|
|
371
412
|
* @format GUID
|
|
@@ -396,7 +437,7 @@ export interface RefundTransaction {
|
|
|
396
437
|
externalRefund?: boolean;
|
|
397
438
|
}
|
|
398
439
|
/** Refund transaction status. */
|
|
399
|
-
|
|
440
|
+
declare enum RefundStatus {
|
|
400
441
|
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
401
442
|
PENDING = "PENDING",
|
|
402
443
|
/** Refund transaction succeeded. */
|
|
@@ -409,8 +450,8 @@ export declare enum RefundStatus {
|
|
|
409
450
|
STARTED = "STARTED"
|
|
410
451
|
}
|
|
411
452
|
/** @enumType */
|
|
412
|
-
|
|
413
|
-
|
|
453
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
454
|
+
interface RefundStatusInfo {
|
|
414
455
|
/**
|
|
415
456
|
* Reason code for the refund's current status.
|
|
416
457
|
*
|
|
@@ -427,7 +468,7 @@ export interface RefundStatusInfo {
|
|
|
427
468
|
description?: string | null;
|
|
428
469
|
}
|
|
429
470
|
/** Business model of a refund request */
|
|
430
|
-
|
|
471
|
+
interface RefundDetails {
|
|
431
472
|
/**
|
|
432
473
|
* Order line item IDs and quantities that were refunded.
|
|
433
474
|
* @maxSize 300
|
|
@@ -453,7 +494,7 @@ export interface RefundDetails {
|
|
|
453
494
|
/** Shipping amount that was refunded. */
|
|
454
495
|
shipping?: ShippingRefund;
|
|
455
496
|
}
|
|
456
|
-
|
|
497
|
+
interface RefundItem {
|
|
457
498
|
/**
|
|
458
499
|
* Line item ID the refunded line item.
|
|
459
500
|
* @format GUID
|
|
@@ -466,7 +507,7 @@ export interface RefundItem {
|
|
|
466
507
|
*/
|
|
467
508
|
quantity?: number;
|
|
468
509
|
}
|
|
469
|
-
|
|
510
|
+
interface LineItemRefund {
|
|
470
511
|
/**
|
|
471
512
|
* Line item ID.
|
|
472
513
|
* @format GUID
|
|
@@ -481,7 +522,7 @@ export interface LineItemRefund {
|
|
|
481
522
|
*/
|
|
482
523
|
quantity?: number;
|
|
483
524
|
}
|
|
484
|
-
|
|
525
|
+
interface AdditionalFeeRefund {
|
|
485
526
|
/**
|
|
486
527
|
* Additional fee ID.
|
|
487
528
|
* @format GUID
|
|
@@ -494,14 +535,14 @@ export interface AdditionalFeeRefund {
|
|
|
494
535
|
*/
|
|
495
536
|
amount?: Price;
|
|
496
537
|
}
|
|
497
|
-
|
|
538
|
+
interface ShippingRefund {
|
|
498
539
|
/**
|
|
499
540
|
* Refund amount.
|
|
500
541
|
* @immutable
|
|
501
542
|
*/
|
|
502
543
|
amount?: Price;
|
|
503
544
|
}
|
|
504
|
-
|
|
545
|
+
interface AggregatedRefundSummary {
|
|
505
546
|
/** Total amount requested for refund. */
|
|
506
547
|
requestedRefund?: Price;
|
|
507
548
|
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
@@ -515,14 +556,14 @@ export interface AggregatedRefundSummary {
|
|
|
515
556
|
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
516
557
|
breakdown?: RefundItemsBreakdown;
|
|
517
558
|
}
|
|
518
|
-
|
|
559
|
+
interface RefundItemsBreakdown {
|
|
519
560
|
/**
|
|
520
561
|
* Refunded line items and the amount refunded for each.
|
|
521
562
|
* @maxSize 300
|
|
522
563
|
*/
|
|
523
564
|
lineItems?: LineItemRefundSummary[];
|
|
524
565
|
}
|
|
525
|
-
|
|
566
|
+
interface LineItemRefundSummary {
|
|
526
567
|
/**
|
|
527
568
|
* ID of the refunded line item.
|
|
528
569
|
* @format GUID
|
|
@@ -531,16 +572,16 @@ export interface LineItemRefundSummary {
|
|
|
531
572
|
/** Total refunded amount for the line item. */
|
|
532
573
|
totalRefundedAmount?: Price;
|
|
533
574
|
}
|
|
534
|
-
|
|
535
|
-
|
|
575
|
+
interface SnapshotMessage {
|
|
576
|
+
_id?: string;
|
|
536
577
|
opType?: number;
|
|
537
578
|
}
|
|
538
|
-
|
|
539
|
-
|
|
579
|
+
interface IndexingMessage {
|
|
580
|
+
_id?: string;
|
|
540
581
|
opType?: number;
|
|
541
582
|
requiredVersions?: string[];
|
|
542
583
|
}
|
|
543
|
-
|
|
584
|
+
interface DiffmatokyPayload {
|
|
544
585
|
left?: string;
|
|
545
586
|
right?: string;
|
|
546
587
|
compareChannel?: string;
|
|
@@ -548,10 +589,10 @@ export interface DiffmatokyPayload {
|
|
|
548
589
|
errorInformation?: ErrorInformation;
|
|
549
590
|
tags?: string[];
|
|
550
591
|
}
|
|
551
|
-
|
|
592
|
+
interface ErrorInformation {
|
|
552
593
|
stackTrace?: string;
|
|
553
594
|
}
|
|
554
|
-
|
|
595
|
+
interface OrderRefunded {
|
|
555
596
|
/**
|
|
556
597
|
* Refund ID.
|
|
557
598
|
* @readonly
|
|
@@ -563,13 +604,13 @@ export interface OrderRefunded {
|
|
|
563
604
|
*/
|
|
564
605
|
order?: Order;
|
|
565
606
|
}
|
|
566
|
-
|
|
607
|
+
interface Order {
|
|
567
608
|
/**
|
|
568
609
|
* Order ID (auto-generated upon order creation).
|
|
569
610
|
* @format GUID
|
|
570
611
|
* @readonly
|
|
571
612
|
*/
|
|
572
|
-
|
|
613
|
+
_id?: string | null;
|
|
573
614
|
/**
|
|
574
615
|
* Order number displayed in the owner's store (auto-generated).
|
|
575
616
|
* @readonly
|
|
@@ -678,12 +719,12 @@ export interface Order {
|
|
|
678
719
|
refunds?: V2Refund[];
|
|
679
720
|
}
|
|
680
721
|
/** Buyer Info */
|
|
681
|
-
|
|
722
|
+
interface BuyerInfo {
|
|
682
723
|
/**
|
|
683
724
|
* Wix customer ID
|
|
684
725
|
* @format GUID
|
|
685
726
|
*/
|
|
686
|
-
|
|
727
|
+
_id?: string | null;
|
|
687
728
|
/**
|
|
688
729
|
* Deprecated (use identityType instead)
|
|
689
730
|
* @readonly
|
|
@@ -713,7 +754,7 @@ export interface BuyerInfo {
|
|
|
713
754
|
*/
|
|
714
755
|
email?: string;
|
|
715
756
|
}
|
|
716
|
-
|
|
757
|
+
declare enum IdentityType {
|
|
717
758
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
718
759
|
/** Site member */
|
|
719
760
|
MEMBER = "MEMBER",
|
|
@@ -721,8 +762,8 @@ export declare enum IdentityType {
|
|
|
721
762
|
CONTACT = "CONTACT"
|
|
722
763
|
}
|
|
723
764
|
/** @enumType */
|
|
724
|
-
|
|
725
|
-
|
|
765
|
+
type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
|
|
766
|
+
declare enum WeightUnit {
|
|
726
767
|
/** Weight unit can't be classified due to an error. */
|
|
727
768
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
728
769
|
/** Kilograms. */
|
|
@@ -731,8 +772,8 @@ export declare enum WeightUnit {
|
|
|
731
772
|
LB = "LB"
|
|
732
773
|
}
|
|
733
774
|
/** @enumType */
|
|
734
|
-
|
|
735
|
-
|
|
775
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
776
|
+
interface Totals {
|
|
736
777
|
/**
|
|
737
778
|
* Subtotal of all the line items, before tax.
|
|
738
779
|
* @format DECIMAL_VALUE
|
|
@@ -780,7 +821,7 @@ export interface Totals {
|
|
|
780
821
|
*/
|
|
781
822
|
giftCard?: string | null;
|
|
782
823
|
}
|
|
783
|
-
|
|
824
|
+
interface BillingInfo {
|
|
784
825
|
/**
|
|
785
826
|
* Payment method used for this order
|
|
786
827
|
* @maxLength 50
|
|
@@ -812,7 +853,7 @@ export interface BillingInfo {
|
|
|
812
853
|
/** Whether order can be refunded by payment provider (manually or automatic) */
|
|
813
854
|
refundableByPaymentProvider?: boolean | null;
|
|
814
855
|
}
|
|
815
|
-
|
|
856
|
+
interface Address extends AddressAddressLine1OptionsOneOf {
|
|
816
857
|
/**
|
|
817
858
|
* Address line 1 (free text)
|
|
818
859
|
* @maxLength 1000
|
|
@@ -866,7 +907,7 @@ export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
|
866
907
|
vatId?: VatId;
|
|
867
908
|
}
|
|
868
909
|
/** @oneof */
|
|
869
|
-
|
|
910
|
+
interface AddressAddressLine1OptionsOneOf {
|
|
870
911
|
/**
|
|
871
912
|
* Address line 1 (free text)
|
|
872
913
|
* @maxLength 1000
|
|
@@ -875,7 +916,7 @@ export interface AddressAddressLine1OptionsOneOf {
|
|
|
875
916
|
/** Address line 1 (street) */
|
|
876
917
|
street?: Street;
|
|
877
918
|
}
|
|
878
|
-
|
|
919
|
+
interface FullName {
|
|
879
920
|
/**
|
|
880
921
|
* Customer's first name
|
|
881
922
|
* @maxLength 1000
|
|
@@ -887,7 +928,7 @@ export interface FullName {
|
|
|
887
928
|
*/
|
|
888
929
|
lastName?: string;
|
|
889
930
|
}
|
|
890
|
-
|
|
931
|
+
interface Street {
|
|
891
932
|
/**
|
|
892
933
|
* Street number
|
|
893
934
|
* @maxLength 500
|
|
@@ -899,7 +940,7 @@ export interface Street {
|
|
|
899
940
|
*/
|
|
900
941
|
name?: string;
|
|
901
942
|
}
|
|
902
|
-
|
|
943
|
+
interface VatId {
|
|
903
944
|
/**
|
|
904
945
|
* Customer's tax ID.
|
|
905
946
|
* @maxLength 50
|
|
@@ -913,7 +954,7 @@ export interface VatId {
|
|
|
913
954
|
type?: VatTypeWithLiterals;
|
|
914
955
|
}
|
|
915
956
|
/** Brazilian tax info types */
|
|
916
|
-
|
|
957
|
+
declare enum VatType {
|
|
917
958
|
/** When the tax info type can't be classified, due to an error */
|
|
918
959
|
UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
|
|
919
960
|
/** CPF - for individual tax payers */
|
|
@@ -922,8 +963,8 @@ export declare enum VatType {
|
|
|
922
963
|
CNPJ = "CNPJ"
|
|
923
964
|
}
|
|
924
965
|
/** @enumType */
|
|
925
|
-
|
|
926
|
-
|
|
966
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
|
|
967
|
+
interface ShippingInfo extends ShippingInfoDetailsOneOf {
|
|
927
968
|
/** Shipment details (when this object describes shipment). */
|
|
928
969
|
shipmentDetails?: ShipmentDetails;
|
|
929
970
|
/** Pickup details (when this object describes pickup). */
|
|
@@ -956,13 +997,13 @@ export interface ShippingInfo extends ShippingInfoDetailsOneOf {
|
|
|
956
997
|
code?: string | null;
|
|
957
998
|
}
|
|
958
999
|
/** @oneof */
|
|
959
|
-
|
|
1000
|
+
interface ShippingInfoDetailsOneOf {
|
|
960
1001
|
/** Shipment details (when this object describes shipment). */
|
|
961
1002
|
shipmentDetails?: ShipmentDetails;
|
|
962
1003
|
/** Pickup details (when this object describes pickup). */
|
|
963
1004
|
pickupDetails?: PickupDetails;
|
|
964
1005
|
}
|
|
965
|
-
|
|
1006
|
+
interface ShipmentDetails {
|
|
966
1007
|
/** Shipping destination address. */
|
|
967
1008
|
address?: Address;
|
|
968
1009
|
/**
|
|
@@ -984,7 +1025,7 @@ export interface ShipmentDetails {
|
|
|
984
1025
|
/** Price data. */
|
|
985
1026
|
priceData?: ShippingPriceData;
|
|
986
1027
|
}
|
|
987
|
-
|
|
1028
|
+
interface TrackingInfo {
|
|
988
1029
|
/**
|
|
989
1030
|
* Tracking number
|
|
990
1031
|
* @maxLength 100
|
|
@@ -1004,7 +1045,7 @@ export interface TrackingInfo {
|
|
|
1004
1045
|
*/
|
|
1005
1046
|
trackingLink?: string | null;
|
|
1006
1047
|
}
|
|
1007
|
-
|
|
1048
|
+
interface ShippingPriceData {
|
|
1008
1049
|
/** Whether tax is included in the price. */
|
|
1009
1050
|
taxIncludedInPrice?: boolean;
|
|
1010
1051
|
/**
|
|
@@ -1013,7 +1054,7 @@ export interface ShippingPriceData {
|
|
|
1013
1054
|
*/
|
|
1014
1055
|
price?: string | null;
|
|
1015
1056
|
}
|
|
1016
|
-
|
|
1057
|
+
interface PickupDetails {
|
|
1017
1058
|
/** Pickup address. */
|
|
1018
1059
|
pickupAddress?: PickupAddress;
|
|
1019
1060
|
/**
|
|
@@ -1028,7 +1069,7 @@ export interface PickupDetails {
|
|
|
1028
1069
|
*/
|
|
1029
1070
|
pickupInstructions?: string | null;
|
|
1030
1071
|
}
|
|
1031
|
-
|
|
1072
|
+
interface PickupAddress {
|
|
1032
1073
|
/** Country code (3 letters) */
|
|
1033
1074
|
country?: string;
|
|
1034
1075
|
/**
|
|
@@ -1052,7 +1093,7 @@ export interface PickupAddress {
|
|
|
1052
1093
|
*/
|
|
1053
1094
|
zipCode?: string;
|
|
1054
1095
|
}
|
|
1055
|
-
|
|
1096
|
+
interface BuyerDetails {
|
|
1056
1097
|
/** Addressee name */
|
|
1057
1098
|
fullName?: FullName;
|
|
1058
1099
|
/**
|
|
@@ -1069,7 +1110,7 @@ export interface BuyerDetails {
|
|
|
1069
1110
|
phone?: string;
|
|
1070
1111
|
}
|
|
1071
1112
|
/** This might be extended in the future with pending orders statuses */
|
|
1072
|
-
|
|
1113
|
+
declare enum PaymentStatus {
|
|
1073
1114
|
/** Payment status can't be classified, due to an error */
|
|
1074
1115
|
UNSPECIFIED_PAYMENT_STATUS = "UNSPECIFIED_PAYMENT_STATUS",
|
|
1075
1116
|
/** Order is pending response from the payment provider */
|
|
@@ -1086,8 +1127,8 @@ export declare enum PaymentStatus {
|
|
|
1086
1127
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
1087
1128
|
}
|
|
1088
1129
|
/** @enumType */
|
|
1089
|
-
|
|
1090
|
-
|
|
1130
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED_PAYMENT_STATUS' | 'PENDING' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PARTIALLY_PAID';
|
|
1131
|
+
declare enum FulfillmentStatus {
|
|
1091
1132
|
/** None of the order items are fulfilled */
|
|
1092
1133
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
1093
1134
|
/**
|
|
@@ -1101,8 +1142,8 @@ export declare enum FulfillmentStatus {
|
|
|
1101
1142
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
1102
1143
|
}
|
|
1103
1144
|
/** @enumType */
|
|
1104
|
-
|
|
1105
|
-
|
|
1145
|
+
type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'CANCELED' | 'PARTIALLY_FULFILLED';
|
|
1146
|
+
interface LineItem {
|
|
1106
1147
|
/**
|
|
1107
1148
|
* Line item ID (auto-generated, stable within this order only)
|
|
1108
1149
|
* @readonly
|
|
@@ -1201,7 +1242,7 @@ export interface LineItem {
|
|
|
1201
1242
|
/** Price data */
|
|
1202
1243
|
priceData?: LineItemPriceData;
|
|
1203
1244
|
}
|
|
1204
|
-
|
|
1245
|
+
declare enum LineItemType {
|
|
1205
1246
|
/** Line item type can't be classified, due to an error */
|
|
1206
1247
|
UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
|
|
1207
1248
|
/** Physical item type */
|
|
@@ -1212,8 +1253,8 @@ export declare enum LineItemType {
|
|
|
1212
1253
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
1213
1254
|
}
|
|
1214
1255
|
/** @enumType */
|
|
1215
|
-
|
|
1216
|
-
|
|
1256
|
+
type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
|
|
1257
|
+
interface OptionSelection {
|
|
1217
1258
|
/**
|
|
1218
1259
|
* Option name
|
|
1219
1260
|
* @maxLength 1000
|
|
@@ -1225,7 +1266,7 @@ export interface OptionSelection {
|
|
|
1225
1266
|
*/
|
|
1226
1267
|
selection?: string;
|
|
1227
1268
|
}
|
|
1228
|
-
|
|
1269
|
+
interface CustomTextFieldSelection {
|
|
1229
1270
|
/**
|
|
1230
1271
|
* Custom text field name
|
|
1231
1272
|
* @maxLength 1000
|
|
@@ -1237,7 +1278,7 @@ export interface CustomTextFieldSelection {
|
|
|
1237
1278
|
*/
|
|
1238
1279
|
value?: string;
|
|
1239
1280
|
}
|
|
1240
|
-
|
|
1281
|
+
interface MediaItem {
|
|
1241
1282
|
/**
|
|
1242
1283
|
* Media type
|
|
1243
1284
|
* @readonly
|
|
@@ -1265,7 +1306,7 @@ export interface MediaItem {
|
|
|
1265
1306
|
*/
|
|
1266
1307
|
mediaId?: string | null;
|
|
1267
1308
|
/** Media ID (for media items previously saved in Wix Media) */
|
|
1268
|
-
|
|
1309
|
+
_id?: string | null;
|
|
1269
1310
|
/** Media external URL */
|
|
1270
1311
|
externalImageUrl?: string | null;
|
|
1271
1312
|
/**
|
|
@@ -1274,15 +1315,15 @@ export interface MediaItem {
|
|
|
1274
1315
|
*/
|
|
1275
1316
|
altText?: string | null;
|
|
1276
1317
|
}
|
|
1277
|
-
|
|
1318
|
+
declare enum MediaItemType {
|
|
1278
1319
|
/** Media item type can't be classified, due to an error */
|
|
1279
1320
|
UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
|
|
1280
1321
|
/** Image item type */
|
|
1281
1322
|
IMAGE = "IMAGE"
|
|
1282
1323
|
}
|
|
1283
1324
|
/** @enumType */
|
|
1284
|
-
|
|
1285
|
-
|
|
1325
|
+
type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
|
|
1326
|
+
interface LineItemPriceData {
|
|
1286
1327
|
/** Whether tax is included in the price set for this line item */
|
|
1287
1328
|
taxIncludedInPrice?: boolean;
|
|
1288
1329
|
/**
|
|
@@ -1297,7 +1338,7 @@ export interface LineItemPriceData {
|
|
|
1297
1338
|
*/
|
|
1298
1339
|
totalPrice?: string | null;
|
|
1299
1340
|
}
|
|
1300
|
-
|
|
1341
|
+
interface DigitalFile {
|
|
1301
1342
|
/**
|
|
1302
1343
|
* id of the secure file in media
|
|
1303
1344
|
* @minLength 1
|
|
@@ -1305,7 +1346,7 @@ export interface DigitalFile {
|
|
|
1305
1346
|
*/
|
|
1306
1347
|
fileId?: string;
|
|
1307
1348
|
}
|
|
1308
|
-
|
|
1349
|
+
interface Activity {
|
|
1309
1350
|
/**
|
|
1310
1351
|
* Activity item type
|
|
1311
1352
|
* @readonly
|
|
@@ -1329,7 +1370,7 @@ export interface Activity {
|
|
|
1329
1370
|
*/
|
|
1330
1371
|
timestamp?: Date | null;
|
|
1331
1372
|
}
|
|
1332
|
-
|
|
1373
|
+
declare enum ActivityType {
|
|
1333
1374
|
/** Activity item type can't be classified, due to an error */
|
|
1334
1375
|
UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE = "UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE",
|
|
1335
1376
|
/** Store owner added a comment */
|
|
@@ -1370,31 +1411,31 @@ export declare enum ActivityType {
|
|
|
1370
1411
|
ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID"
|
|
1371
1412
|
}
|
|
1372
1413
|
/** @enumType */
|
|
1373
|
-
|
|
1374
|
-
|
|
1414
|
+
type ActivityTypeWithLiterals = ActivityType | 'UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE' | 'MERCHANT_COMMENT' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'DOWNLOAD_LINK_SENT' | 'PICKUP_READY_EMAIL_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_WAS_SET' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_WAS_SET' | 'INVOICE_WAS_REMOVED' | 'INVOICE_WAS_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'ORDER_PARTIALLY_PAID';
|
|
1415
|
+
interface V2InvoiceInfo {
|
|
1375
1416
|
/**
|
|
1376
1417
|
* Invoice ID
|
|
1377
1418
|
* @maxLength 100
|
|
1378
1419
|
*/
|
|
1379
|
-
|
|
1420
|
+
_id?: string;
|
|
1380
1421
|
/** Invoice source */
|
|
1381
1422
|
source?: InvoiceSourceWithLiterals;
|
|
1382
1423
|
}
|
|
1383
|
-
|
|
1424
|
+
declare enum InvoiceSource {
|
|
1384
1425
|
/** Invoice source can't be classified, due to an error */
|
|
1385
1426
|
UNSPECIFIED_INVOICE_SOURCE = "UNSPECIFIED_INVOICE_SOURCE",
|
|
1386
1427
|
/** Invoice created using the Invoices API */
|
|
1387
1428
|
WIX = "WIX"
|
|
1388
1429
|
}
|
|
1389
1430
|
/** @enumType */
|
|
1390
|
-
|
|
1391
|
-
|
|
1431
|
+
type InvoiceSourceWithLiterals = InvoiceSource | 'UNSPECIFIED_INVOICE_SOURCE' | 'WIX';
|
|
1432
|
+
interface Fulfillment {
|
|
1392
1433
|
/**
|
|
1393
1434
|
* Fulfillment ID (auto generated upon fulfillment creation).
|
|
1394
1435
|
* @format GUID
|
|
1395
1436
|
* @readonly
|
|
1396
1437
|
*/
|
|
1397
|
-
|
|
1438
|
+
_id?: string | null;
|
|
1398
1439
|
/**
|
|
1399
1440
|
* Fulfillment creation date and time.
|
|
1400
1441
|
* @readonly
|
|
@@ -1409,7 +1450,7 @@ export interface Fulfillment {
|
|
|
1409
1450
|
/** Tracking information. */
|
|
1410
1451
|
trackingInfo?: FulfillmentTrackingInfo;
|
|
1411
1452
|
}
|
|
1412
|
-
|
|
1453
|
+
interface FulfillmentLineItem {
|
|
1413
1454
|
/**
|
|
1414
1455
|
* Line item ID (mirrors the line item index of the order).
|
|
1415
1456
|
* @min 1
|
|
@@ -1426,7 +1467,7 @@ export interface FulfillmentLineItem {
|
|
|
1426
1467
|
*/
|
|
1427
1468
|
quantity?: number | null;
|
|
1428
1469
|
}
|
|
1429
|
-
|
|
1470
|
+
interface FulfillmentTrackingInfo {
|
|
1430
1471
|
/**
|
|
1431
1472
|
* Tracking number.
|
|
1432
1473
|
* @minLength 1
|
|
@@ -1452,7 +1493,7 @@ export interface FulfillmentTrackingInfo {
|
|
|
1452
1493
|
*/
|
|
1453
1494
|
trackingLink?: string | null;
|
|
1454
1495
|
}
|
|
1455
|
-
|
|
1496
|
+
interface Discount {
|
|
1456
1497
|
/**
|
|
1457
1498
|
* Deprecated (use Totals.discount instead)
|
|
1458
1499
|
* @readonly
|
|
@@ -1462,7 +1503,7 @@ export interface Discount {
|
|
|
1462
1503
|
/** Applied coupon */
|
|
1463
1504
|
appliedCoupon?: AppliedCoupon;
|
|
1464
1505
|
}
|
|
1465
|
-
|
|
1506
|
+
interface AppliedCoupon {
|
|
1466
1507
|
/**
|
|
1467
1508
|
* Coupon ID
|
|
1468
1509
|
* @minLength 1
|
|
@@ -1481,7 +1522,7 @@ export interface AppliedCoupon {
|
|
|
1481
1522
|
code?: string;
|
|
1482
1523
|
}
|
|
1483
1524
|
/** Custom field */
|
|
1484
|
-
|
|
1525
|
+
interface CustomField {
|
|
1485
1526
|
/**
|
|
1486
1527
|
* Free text that the customer entered in the custom field during the checkout process
|
|
1487
1528
|
* @maxLength 2000
|
|
@@ -1498,7 +1539,7 @@ export interface CustomField {
|
|
|
1498
1539
|
*/
|
|
1499
1540
|
translatedTitle?: string;
|
|
1500
1541
|
}
|
|
1501
|
-
|
|
1542
|
+
interface ChannelInfo {
|
|
1502
1543
|
/** Sales channel that submitted the order */
|
|
1503
1544
|
type?: ChannelTypeWithLiterals;
|
|
1504
1545
|
/**
|
|
@@ -1512,7 +1553,7 @@ export interface ChannelInfo {
|
|
|
1512
1553
|
*/
|
|
1513
1554
|
externalOrderUrl?: string | null;
|
|
1514
1555
|
}
|
|
1515
|
-
|
|
1556
|
+
declare enum ChannelType {
|
|
1516
1557
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1517
1558
|
WEB = "WEB",
|
|
1518
1559
|
POS = "POS",
|
|
@@ -1531,26 +1572,26 @@ export declare enum ChannelType {
|
|
|
1531
1572
|
FAIRE_COM = "FAIRE_COM"
|
|
1532
1573
|
}
|
|
1533
1574
|
/** @enumType */
|
|
1534
|
-
|
|
1535
|
-
|
|
1575
|
+
type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
1576
|
+
interface EnteredBy {
|
|
1536
1577
|
/** @format GUID */
|
|
1537
|
-
|
|
1578
|
+
_id?: string;
|
|
1538
1579
|
identityType?: EnteredByIdentityTypeWithLiterals;
|
|
1539
1580
|
}
|
|
1540
|
-
|
|
1581
|
+
declare enum EnteredByIdentityType {
|
|
1541
1582
|
USER = "USER",
|
|
1542
1583
|
MEMBER = "MEMBER",
|
|
1543
1584
|
CONTACT = "CONTACT",
|
|
1544
1585
|
APP = "APP"
|
|
1545
1586
|
}
|
|
1546
1587
|
/** @enumType */
|
|
1547
|
-
|
|
1548
|
-
|
|
1588
|
+
type EnteredByIdentityTypeWithLiterals = EnteredByIdentityType | 'USER' | 'MEMBER' | 'CONTACT' | 'APP';
|
|
1589
|
+
interface SubscriptionInfo {
|
|
1549
1590
|
/**
|
|
1550
1591
|
* Subscription ID.
|
|
1551
1592
|
* @format GUID
|
|
1552
1593
|
*/
|
|
1553
|
-
|
|
1594
|
+
_id?: string | null;
|
|
1554
1595
|
/**
|
|
1555
1596
|
* Current cycle number. For example, if the subscription is in the 3rd month of a 4-month subscription, the value will be `3`.
|
|
1556
1597
|
* @min 1
|
|
@@ -1561,7 +1602,7 @@ export interface SubscriptionInfo {
|
|
|
1561
1602
|
/** Subscription options info. */
|
|
1562
1603
|
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
1563
1604
|
}
|
|
1564
|
-
|
|
1605
|
+
interface SubscriptionSettings {
|
|
1565
1606
|
/** Frequency of recurring payment. */
|
|
1566
1607
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
1567
1608
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
@@ -1574,7 +1615,7 @@ export interface SubscriptionSettings {
|
|
|
1574
1615
|
billingCycles?: number | null;
|
|
1575
1616
|
}
|
|
1576
1617
|
/** Frequency unit of recurring payment */
|
|
1577
|
-
|
|
1618
|
+
declare enum SubscriptionFrequency {
|
|
1578
1619
|
UNDEFINED = "UNDEFINED",
|
|
1579
1620
|
DAY = "DAY",
|
|
1580
1621
|
WEEK = "WEEK",
|
|
@@ -1582,8 +1623,8 @@ export declare enum SubscriptionFrequency {
|
|
|
1582
1623
|
YEAR = "YEAR"
|
|
1583
1624
|
}
|
|
1584
1625
|
/** @enumType */
|
|
1585
|
-
|
|
1586
|
-
|
|
1626
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
1627
|
+
interface SubscriptionOptionInfo {
|
|
1587
1628
|
/**
|
|
1588
1629
|
* Subscription option title.
|
|
1589
1630
|
* @minLength 1
|
|
@@ -1596,7 +1637,7 @@ export interface SubscriptionOptionInfo {
|
|
|
1596
1637
|
*/
|
|
1597
1638
|
description?: string | null;
|
|
1598
1639
|
}
|
|
1599
|
-
|
|
1640
|
+
interface V2Refund {
|
|
1600
1641
|
/** Refund created timestamp. */
|
|
1601
1642
|
dateCreated?: Date | null;
|
|
1602
1643
|
/**
|
|
@@ -1612,11 +1653,11 @@ export interface V2Refund {
|
|
|
1612
1653
|
* Refund ID.
|
|
1613
1654
|
* @format GUID
|
|
1614
1655
|
*/
|
|
1615
|
-
|
|
1656
|
+
_id?: string;
|
|
1616
1657
|
/** Whether refund was made externally (on the payment provider's side). */
|
|
1617
1658
|
externalRefund?: boolean;
|
|
1618
1659
|
}
|
|
1619
|
-
|
|
1660
|
+
interface GiftCard {
|
|
1620
1661
|
/**
|
|
1621
1662
|
* @minLength 1
|
|
1622
1663
|
* @maxLength 100
|
|
@@ -1628,7 +1669,7 @@ export interface GiftCard {
|
|
|
1628
1669
|
* @deprecated giftcard internal ID
|
|
1629
1670
|
* @targetRemovalDate 2024-12-31
|
|
1630
1671
|
*/
|
|
1631
|
-
|
|
1672
|
+
_id?: string;
|
|
1632
1673
|
/**
|
|
1633
1674
|
* giftcard provider appid
|
|
1634
1675
|
* @format GUID
|
|
@@ -1641,7 +1682,7 @@ export interface GiftCard {
|
|
|
1641
1682
|
amount?: string;
|
|
1642
1683
|
}
|
|
1643
1684
|
/** Triggered when a payment is updated. */
|
|
1644
|
-
|
|
1685
|
+
interface PaymentsUpdated {
|
|
1645
1686
|
/** Updated order transactions. */
|
|
1646
1687
|
orderTransactions?: OrderTransactions;
|
|
1647
1688
|
/**
|
|
@@ -1656,7 +1697,7 @@ export interface PaymentsUpdated {
|
|
|
1656
1697
|
refundIds?: string[];
|
|
1657
1698
|
}
|
|
1658
1699
|
/** Triggered when a payment is updated. */
|
|
1659
|
-
|
|
1700
|
+
interface PaymentDetailsUpdated {
|
|
1660
1701
|
/** Updated order transactions. */
|
|
1661
1702
|
orderTransactions?: OrderTransactions;
|
|
1662
1703
|
/**
|
|
@@ -1673,7 +1714,7 @@ export interface PaymentDetailsUpdated {
|
|
|
1673
1714
|
refundIds?: string[];
|
|
1674
1715
|
}
|
|
1675
1716
|
/** Triggered when a refund is created. */
|
|
1676
|
-
|
|
1717
|
+
interface RefundCreated {
|
|
1677
1718
|
/** Updated order transactions. */
|
|
1678
1719
|
orderTransactions?: OrderTransactions;
|
|
1679
1720
|
/** ID of the created refund. */
|
|
@@ -1687,7 +1728,7 @@ export interface RefundCreated {
|
|
|
1687
1728
|
/** Refunded line items and quantities that are part of the created refund. */
|
|
1688
1729
|
refundItems?: RefundItem[];
|
|
1689
1730
|
}
|
|
1690
|
-
|
|
1731
|
+
interface RestockInfo {
|
|
1691
1732
|
/** Restock type. */
|
|
1692
1733
|
type?: RestockTypeWithLiterals;
|
|
1693
1734
|
/**
|
|
@@ -1696,14 +1737,14 @@ export interface RestockInfo {
|
|
|
1696
1737
|
*/
|
|
1697
1738
|
items?: RestockItem[];
|
|
1698
1739
|
}
|
|
1699
|
-
|
|
1740
|
+
declare enum RestockType {
|
|
1700
1741
|
NO_ITEMS = "NO_ITEMS",
|
|
1701
1742
|
ALL_ITEMS = "ALL_ITEMS",
|
|
1702
1743
|
SOME_ITEMS = "SOME_ITEMS"
|
|
1703
1744
|
}
|
|
1704
1745
|
/** @enumType */
|
|
1705
|
-
|
|
1706
|
-
|
|
1746
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
1747
|
+
interface RestockItem {
|
|
1707
1748
|
/**
|
|
1708
1749
|
* ID of the line item being restocked.
|
|
1709
1750
|
* @format GUID
|
|
@@ -1716,7 +1757,7 @@ export interface RestockItem {
|
|
|
1716
1757
|
*/
|
|
1717
1758
|
quantity?: number;
|
|
1718
1759
|
}
|
|
1719
|
-
|
|
1760
|
+
interface RefundCompleted {
|
|
1720
1761
|
/**
|
|
1721
1762
|
* Order ID.
|
|
1722
1763
|
* @format GUID
|
|
@@ -1729,7 +1770,7 @@ export interface RefundCompleted {
|
|
|
1729
1770
|
/** Order transactions after refund is completed. */
|
|
1730
1771
|
orderTransactions?: OrderTransactions;
|
|
1731
1772
|
}
|
|
1732
|
-
|
|
1773
|
+
interface RefundSideEffects {
|
|
1733
1774
|
/** Inventory restock details as part of this refund. */
|
|
1734
1775
|
restockInfo?: RestockInfo;
|
|
1735
1776
|
/** Whether to send a refund confirmation email to the customer. */
|
|
@@ -1741,7 +1782,7 @@ export interface RefundSideEffects {
|
|
|
1741
1782
|
*/
|
|
1742
1783
|
customMessage?: string | null;
|
|
1743
1784
|
}
|
|
1744
|
-
|
|
1785
|
+
interface ListTransactionsForSingleOrderRequest {
|
|
1745
1786
|
/**
|
|
1746
1787
|
* Order ID.
|
|
1747
1788
|
* @minLength 1
|
|
@@ -1749,11 +1790,11 @@ export interface ListTransactionsForSingleOrderRequest {
|
|
|
1749
1790
|
*/
|
|
1750
1791
|
orderId: string;
|
|
1751
1792
|
}
|
|
1752
|
-
|
|
1793
|
+
interface ListTransactionsForSingleOrderResponse {
|
|
1753
1794
|
/** Order ID and its associated transactions. */
|
|
1754
1795
|
orderTransactions?: OrderTransactions;
|
|
1755
1796
|
}
|
|
1756
|
-
|
|
1797
|
+
interface ListTransactionsForMultipleOrdersRequest {
|
|
1757
1798
|
/**
|
|
1758
1799
|
* Order IDs for which to retrieve transactions.
|
|
1759
1800
|
* @minSize 1
|
|
@@ -1763,11 +1804,11 @@ export interface ListTransactionsForMultipleOrdersRequest {
|
|
|
1763
1804
|
*/
|
|
1764
1805
|
orderIds: string[];
|
|
1765
1806
|
}
|
|
1766
|
-
|
|
1807
|
+
interface ListTransactionsForMultipleOrdersResponse {
|
|
1767
1808
|
/** List of order IDs and their associated transactions. */
|
|
1768
1809
|
orderTransactions?: OrderTransactions[];
|
|
1769
1810
|
}
|
|
1770
|
-
|
|
1811
|
+
interface AddPaymentsRequest {
|
|
1771
1812
|
/**
|
|
1772
1813
|
* Order ID.
|
|
1773
1814
|
* @format GUID
|
|
@@ -1780,13 +1821,13 @@ export interface AddPaymentsRequest {
|
|
|
1780
1821
|
*/
|
|
1781
1822
|
payments: Payment[];
|
|
1782
1823
|
}
|
|
1783
|
-
|
|
1824
|
+
interface AddPaymentsResponse {
|
|
1784
1825
|
/** Order ID and its associated transactions. */
|
|
1785
1826
|
orderTransactions?: OrderTransactions;
|
|
1786
1827
|
/** IDs of added order payments. */
|
|
1787
1828
|
paymentsIds?: string[];
|
|
1788
1829
|
}
|
|
1789
|
-
|
|
1830
|
+
interface AddRefundRequest {
|
|
1790
1831
|
/**
|
|
1791
1832
|
* Order ID this refunds related to
|
|
1792
1833
|
* @minLength 1
|
|
@@ -1798,13 +1839,13 @@ export interface AddRefundRequest {
|
|
|
1798
1839
|
/** Side effect details related to refund */
|
|
1799
1840
|
sideEffects?: RefundSideEffects;
|
|
1800
1841
|
}
|
|
1801
|
-
|
|
1842
|
+
interface AddRefundResponse {
|
|
1802
1843
|
/** Order ID and its associated transactions. */
|
|
1803
1844
|
orderTransactions?: OrderTransactions;
|
|
1804
1845
|
/** Created refund ID */
|
|
1805
1846
|
refundId?: string;
|
|
1806
1847
|
}
|
|
1807
|
-
|
|
1848
|
+
interface UpdatePaymentStatusRequest {
|
|
1808
1849
|
/**
|
|
1809
1850
|
* Order ID.
|
|
1810
1851
|
* @format GUID
|
|
@@ -1818,11 +1859,11 @@ export interface UpdatePaymentStatusRequest {
|
|
|
1818
1859
|
/** Payment status. */
|
|
1819
1860
|
status?: TransactionStatusWithLiterals;
|
|
1820
1861
|
}
|
|
1821
|
-
|
|
1862
|
+
interface UpdatePaymentStatusResponse {
|
|
1822
1863
|
/** Order ID and its associated transactions after update. */
|
|
1823
1864
|
orderTransactions?: OrderTransactions;
|
|
1824
1865
|
}
|
|
1825
|
-
|
|
1866
|
+
interface BulkUpdatePaymentStatusesRequest {
|
|
1826
1867
|
/**
|
|
1827
1868
|
* Order and payment IDs for which to update payment status.
|
|
1828
1869
|
* @minSize 1
|
|
@@ -1834,7 +1875,7 @@ export interface BulkUpdatePaymentStatusesRequest {
|
|
|
1834
1875
|
/** Payment status. */
|
|
1835
1876
|
status?: TransactionStatusWithLiterals;
|
|
1836
1877
|
}
|
|
1837
|
-
|
|
1878
|
+
interface PaymentAndOrderId {
|
|
1838
1879
|
/**
|
|
1839
1880
|
* Order ID.
|
|
1840
1881
|
* @format GUID
|
|
@@ -1846,21 +1887,21 @@ export interface PaymentAndOrderId {
|
|
|
1846
1887
|
*/
|
|
1847
1888
|
paymentId?: string;
|
|
1848
1889
|
}
|
|
1849
|
-
|
|
1890
|
+
interface BulkUpdatePaymentStatusesResponse {
|
|
1850
1891
|
/** Bulk operation results. */
|
|
1851
1892
|
results?: BulkPaymentResult[];
|
|
1852
1893
|
/** Bulk operation metadata. */
|
|
1853
1894
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1854
1895
|
}
|
|
1855
|
-
|
|
1896
|
+
interface BulkPaymentResult {
|
|
1856
1897
|
/** Item metadata. */
|
|
1857
1898
|
itemMetadata?: ItemMetadata;
|
|
1858
1899
|
/** Updated payment. Returned if `return_full_entity` set to `true`. */
|
|
1859
1900
|
item?: Payment;
|
|
1860
1901
|
}
|
|
1861
|
-
|
|
1902
|
+
interface ItemMetadata {
|
|
1862
1903
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1863
|
-
|
|
1904
|
+
_id?: string | null;
|
|
1864
1905
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1865
1906
|
originalIndex?: number;
|
|
1866
1907
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -1868,7 +1909,7 @@ export interface ItemMetadata {
|
|
|
1868
1909
|
/** Details about the error in case of failure. */
|
|
1869
1910
|
error?: ApplicationError;
|
|
1870
1911
|
}
|
|
1871
|
-
|
|
1912
|
+
interface ApplicationError {
|
|
1872
1913
|
/** Error code. */
|
|
1873
1914
|
code?: string;
|
|
1874
1915
|
/** Description of the error. */
|
|
@@ -1876,7 +1917,7 @@ export interface ApplicationError {
|
|
|
1876
1917
|
/** Data related to the error. */
|
|
1877
1918
|
data?: Record<string, any> | null;
|
|
1878
1919
|
}
|
|
1879
|
-
|
|
1920
|
+
interface BulkActionMetadata {
|
|
1880
1921
|
/** Number of items that were successfully processed. */
|
|
1881
1922
|
totalSuccesses?: number;
|
|
1882
1923
|
/** Number of items that couldn't be processed. */
|
|
@@ -1884,7 +1925,7 @@ export interface BulkActionMetadata {
|
|
|
1884
1925
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1885
1926
|
undetailedFailures?: number;
|
|
1886
1927
|
}
|
|
1887
|
-
|
|
1928
|
+
interface UpdateRefundRequest {
|
|
1888
1929
|
/**
|
|
1889
1930
|
* Order ID.
|
|
1890
1931
|
* @format GUID
|
|
@@ -1893,25 +1934,57 @@ export interface UpdateRefundRequest {
|
|
|
1893
1934
|
/** Refund with updated field values. */
|
|
1894
1935
|
refund?: Refund;
|
|
1895
1936
|
}
|
|
1896
|
-
|
|
1937
|
+
interface UpdateRefundResponse {
|
|
1897
1938
|
/** Refund after update. */
|
|
1898
1939
|
refund?: Refund;
|
|
1899
1940
|
/** Order transactions after update. */
|
|
1900
1941
|
orderTransactions?: OrderTransactions;
|
|
1901
1942
|
}
|
|
1902
|
-
|
|
1943
|
+
interface UpdateRefundTransactionRequest {
|
|
1944
|
+
/**
|
|
1945
|
+
* Order ID.
|
|
1946
|
+
* @internal
|
|
1947
|
+
* @format GUID
|
|
1948
|
+
*/
|
|
1949
|
+
orderId: string;
|
|
1950
|
+
/**
|
|
1951
|
+
* Payment ID.
|
|
1952
|
+
* @internal
|
|
1953
|
+
* @format GUID
|
|
1954
|
+
*/
|
|
1955
|
+
refundId: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* Updated refund transaction
|
|
1958
|
+
* @internal
|
|
1959
|
+
*/
|
|
1960
|
+
transaction: RefundTransaction;
|
|
1903
1961
|
}
|
|
1904
|
-
|
|
1962
|
+
interface UpdateRefundTransactionResponse {
|
|
1963
|
+
/**
|
|
1964
|
+
* OrderTransactions with updated refund transaction
|
|
1965
|
+
* @internal
|
|
1966
|
+
*/
|
|
1967
|
+
orderTransactions?: OrderTransactions;
|
|
1905
1968
|
}
|
|
1906
|
-
|
|
1969
|
+
interface UpdatePaymentsRequest {
|
|
1907
1970
|
}
|
|
1908
|
-
|
|
1971
|
+
interface MaskedPayment {
|
|
1909
1972
|
}
|
|
1910
|
-
|
|
1973
|
+
interface UpdatePaymentsResponse {
|
|
1974
|
+
/**
|
|
1975
|
+
* OrderTransactions with updated payments
|
|
1976
|
+
* @internal
|
|
1977
|
+
*/
|
|
1978
|
+
orderTransactions?: OrderTransactions;
|
|
1911
1979
|
}
|
|
1912
|
-
|
|
1980
|
+
interface QueryOrderTransactionsRequest {
|
|
1981
|
+
/**
|
|
1982
|
+
* Query options.
|
|
1983
|
+
* @internal
|
|
1984
|
+
*/
|
|
1985
|
+
query?: CursorQuery;
|
|
1913
1986
|
}
|
|
1914
|
-
|
|
1987
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1915
1988
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1916
1989
|
cursorPaging?: CursorPaging;
|
|
1917
1990
|
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
@@ -1924,11 +1997,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1924
1997
|
sort?: Sorting[];
|
|
1925
1998
|
}
|
|
1926
1999
|
/** @oneof */
|
|
1927
|
-
|
|
2000
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1928
2001
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1929
2002
|
cursorPaging?: CursorPaging;
|
|
1930
2003
|
}
|
|
1931
|
-
|
|
2004
|
+
interface Sorting {
|
|
1932
2005
|
/**
|
|
1933
2006
|
* Name of the field to sort by.
|
|
1934
2007
|
* @maxLength 512
|
|
@@ -1937,15 +2010,15 @@ export interface Sorting {
|
|
|
1937
2010
|
/** Sort order. */
|
|
1938
2011
|
order?: SortOrderWithLiterals;
|
|
1939
2012
|
}
|
|
1940
|
-
|
|
2013
|
+
declare enum SortOrder {
|
|
1941
2014
|
/** Ascending order. */
|
|
1942
2015
|
ASC = "ASC",
|
|
1943
2016
|
/** Descending order. */
|
|
1944
2017
|
DESC = "DESC"
|
|
1945
2018
|
}
|
|
1946
2019
|
/** @enumType */
|
|
1947
|
-
|
|
1948
|
-
|
|
2020
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2021
|
+
interface CursorPaging {
|
|
1949
2022
|
/**
|
|
1950
2023
|
* Maximum number of items to return in the results.
|
|
1951
2024
|
* @max 100
|
|
@@ -1960,9 +2033,20 @@ export interface CursorPaging {
|
|
|
1960
2033
|
*/
|
|
1961
2034
|
cursor?: string | null;
|
|
1962
2035
|
}
|
|
1963
|
-
|
|
2036
|
+
interface QueryOrderTransactionsResponse {
|
|
2037
|
+
/**
|
|
2038
|
+
* Order transactions.
|
|
2039
|
+
* @internal
|
|
2040
|
+
* @maxSize 100
|
|
2041
|
+
*/
|
|
2042
|
+
orderTransactions?: OrderTransactions[];
|
|
2043
|
+
/**
|
|
2044
|
+
* Details on the paged set of results returned.
|
|
2045
|
+
* @internal
|
|
2046
|
+
*/
|
|
2047
|
+
metadata?: CursorPagingMetadata;
|
|
1964
2048
|
}
|
|
1965
|
-
|
|
2049
|
+
interface CursorPagingMetadata {
|
|
1966
2050
|
/** Number of items returned in the response. */
|
|
1967
2051
|
count?: number | null;
|
|
1968
2052
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1975,7 +2059,7 @@ export interface CursorPagingMetadata {
|
|
|
1975
2059
|
*/
|
|
1976
2060
|
hasNext?: boolean | null;
|
|
1977
2061
|
}
|
|
1978
|
-
|
|
2062
|
+
interface Cursors {
|
|
1979
2063
|
/**
|
|
1980
2064
|
* Cursor string pointing to the next page in the list of results.
|
|
1981
2065
|
* @maxLength 16000
|
|
@@ -1987,7 +2071,7 @@ export interface Cursors {
|
|
|
1987
2071
|
*/
|
|
1988
2072
|
prev?: string | null;
|
|
1989
2073
|
}
|
|
1990
|
-
|
|
2074
|
+
interface TriggerRefundRequest {
|
|
1991
2075
|
/**
|
|
1992
2076
|
* The order this refund related to
|
|
1993
2077
|
* @minLength 1
|
|
@@ -2014,7 +2098,7 @@ export interface TriggerRefundRequest {
|
|
|
2014
2098
|
*/
|
|
2015
2099
|
customMessage?: string | null;
|
|
2016
2100
|
}
|
|
2017
|
-
|
|
2101
|
+
interface PaymentRefund {
|
|
2018
2102
|
/**
|
|
2019
2103
|
* Specific payment within the order to refund
|
|
2020
2104
|
* @format GUID
|
|
@@ -2029,13 +2113,13 @@ export interface PaymentRefund {
|
|
|
2029
2113
|
*/
|
|
2030
2114
|
externalRefund?: boolean;
|
|
2031
2115
|
}
|
|
2032
|
-
|
|
2116
|
+
interface TriggerRefundResponse {
|
|
2033
2117
|
/** All order's transactions after the refunds were added */
|
|
2034
2118
|
orderTransactions?: OrderTransactions;
|
|
2035
2119
|
/** Created refund ID */
|
|
2036
2120
|
refundId?: string;
|
|
2037
2121
|
}
|
|
2038
|
-
|
|
2122
|
+
interface CalculateRefundRequest {
|
|
2039
2123
|
/**
|
|
2040
2124
|
* Order ID
|
|
2041
2125
|
* @minLength 1
|
|
@@ -2050,7 +2134,7 @@ export interface CalculateRefundRequest {
|
|
|
2050
2134
|
/** Should include shipping in refund calculation */
|
|
2051
2135
|
refundShipping?: boolean;
|
|
2052
2136
|
}
|
|
2053
|
-
|
|
2137
|
+
interface CalculateRefundItemRequest {
|
|
2054
2138
|
/**
|
|
2055
2139
|
* ID of the line item being refunded
|
|
2056
2140
|
* @format GUID
|
|
@@ -2065,7 +2149,7 @@ export interface CalculateRefundItemRequest {
|
|
|
2065
2149
|
/** Should this item be restocked (used for validation purposes) */
|
|
2066
2150
|
restock?: boolean;
|
|
2067
2151
|
}
|
|
2068
|
-
|
|
2152
|
+
interface CalculateRefundResponse {
|
|
2069
2153
|
/**
|
|
2070
2154
|
* Total refundable amount
|
|
2071
2155
|
* @format DECIMAL_VALUE
|
|
@@ -2094,13 +2178,13 @@ export interface CalculateRefundResponse {
|
|
|
2094
2178
|
/** The refundable items of that order */
|
|
2095
2179
|
items?: CalculateRefundItemResponse[];
|
|
2096
2180
|
}
|
|
2097
|
-
|
|
2181
|
+
interface CalculateRefundItemResponse {
|
|
2098
2182
|
/** Line item ID */
|
|
2099
2183
|
lineItemId?: string;
|
|
2100
2184
|
/** The line item's price */
|
|
2101
2185
|
lineItemPrice?: number;
|
|
2102
2186
|
}
|
|
2103
|
-
|
|
2187
|
+
interface GetRefundabilityStatusRequest {
|
|
2104
2188
|
/**
|
|
2105
2189
|
* Order ID.
|
|
2106
2190
|
* @minLength 1
|
|
@@ -2108,7 +2192,7 @@ export interface GetRefundabilityStatusRequest {
|
|
|
2108
2192
|
*/
|
|
2109
2193
|
orderId?: string;
|
|
2110
2194
|
}
|
|
2111
|
-
|
|
2195
|
+
interface GetRefundabilityStatusResponse {
|
|
2112
2196
|
/**
|
|
2113
2197
|
* Refundability details.
|
|
2114
2198
|
* @maxSize 1
|
|
@@ -2117,7 +2201,7 @@ export interface GetRefundabilityStatusResponse {
|
|
|
2117
2201
|
/** Whether the order supports refunding per item. */
|
|
2118
2202
|
refundablePerItem?: boolean;
|
|
2119
2203
|
}
|
|
2120
|
-
|
|
2204
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2121
2205
|
/** Reason why payment is not refundable. */
|
|
2122
2206
|
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2123
2207
|
/** Reason why payment is only refundable manually. */
|
|
@@ -2130,13 +2214,13 @@ export interface Refundability extends RefundabilityAdditionalRefundabilityInfoO
|
|
|
2130
2214
|
providerLink?: string | null;
|
|
2131
2215
|
}
|
|
2132
2216
|
/** @oneof */
|
|
2133
|
-
|
|
2217
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2134
2218
|
/** Reason why payment is not refundable. */
|
|
2135
2219
|
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2136
2220
|
/** Reason why payment is only refundable manually. */
|
|
2137
2221
|
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2138
2222
|
}
|
|
2139
|
-
|
|
2223
|
+
declare enum RefundableStatus {
|
|
2140
2224
|
/** Not refundable. */
|
|
2141
2225
|
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2142
2226
|
/** Refundable manually. */
|
|
@@ -2145,8 +2229,8 @@ export declare enum RefundableStatus {
|
|
|
2145
2229
|
REFUNDABLE = "REFUNDABLE"
|
|
2146
2230
|
}
|
|
2147
2231
|
/** @enumType */
|
|
2148
|
-
|
|
2149
|
-
|
|
2232
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2233
|
+
declare enum NonRefundableReason {
|
|
2150
2234
|
/** No reason. */
|
|
2151
2235
|
NONE = "NONE",
|
|
2152
2236
|
/** Payment already refunded. */
|
|
@@ -2173,8 +2257,8 @@ export declare enum NonRefundableReason {
|
|
|
2173
2257
|
FORBIDDEN = "FORBIDDEN"
|
|
2174
2258
|
}
|
|
2175
2259
|
/** @enumType */
|
|
2176
|
-
|
|
2177
|
-
|
|
2260
|
+
type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PARTIALLY_PAID' | 'DEPOSIT_ONLINE_ITEM' | 'PENDING_REFUND' | 'FORBIDDEN';
|
|
2261
|
+
declare enum ManuallyRefundableReason {
|
|
2178
2262
|
/** Payment expired. */
|
|
2179
2263
|
EXPIRED = "EXPIRED",
|
|
2180
2264
|
/** Payment method not supported. */
|
|
@@ -2187,8 +2271,8 @@ export declare enum ManuallyRefundableReason {
|
|
|
2187
2271
|
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2188
2272
|
}
|
|
2189
2273
|
/** @enumType */
|
|
2190
|
-
|
|
2191
|
-
|
|
2274
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'NOT_FOUND' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2275
|
+
interface ListInvoicesForSingleOrderRequest {
|
|
2192
2276
|
/**
|
|
2193
2277
|
* Order ID.
|
|
2194
2278
|
* @minLength 1
|
|
@@ -2196,13 +2280,13 @@ export interface ListInvoicesForSingleOrderRequest {
|
|
|
2196
2280
|
*/
|
|
2197
2281
|
orderId?: string;
|
|
2198
2282
|
}
|
|
2199
|
-
|
|
2283
|
+
interface ListInvoicesForSingleOrderResponse {
|
|
2200
2284
|
/** List of invoices. */
|
|
2201
2285
|
invoices?: InvoiceInfo[];
|
|
2202
2286
|
}
|
|
2203
|
-
|
|
2287
|
+
interface InvoiceInfo {
|
|
2204
2288
|
/** Invoice ID. */
|
|
2205
|
-
|
|
2289
|
+
_id?: string;
|
|
2206
2290
|
/** ID of the app that set the invoice. */
|
|
2207
2291
|
appId?: string;
|
|
2208
2292
|
/**
|
|
@@ -2214,9 +2298,9 @@ export interface InvoiceInfo {
|
|
|
2214
2298
|
* Invoice creation date and time.
|
|
2215
2299
|
* @deprecated
|
|
2216
2300
|
*/
|
|
2217
|
-
|
|
2301
|
+
_createdDate?: Date | null;
|
|
2218
2302
|
}
|
|
2219
|
-
|
|
2303
|
+
interface ListInvoicesForMultipleOrdersRequest {
|
|
2220
2304
|
/**
|
|
2221
2305
|
* Order IDs for which to retrieve invoices.
|
|
2222
2306
|
* @maxSize 300
|
|
@@ -2225,17 +2309,17 @@ export interface ListInvoicesForMultipleOrdersRequest {
|
|
|
2225
2309
|
*/
|
|
2226
2310
|
orderIds?: string[];
|
|
2227
2311
|
}
|
|
2228
|
-
|
|
2312
|
+
interface ListInvoicesForMultipleOrdersResponse {
|
|
2229
2313
|
/** List of order IDs and their associated invoices. */
|
|
2230
2314
|
invoicesForOrder?: InvoicesForOrder[];
|
|
2231
2315
|
}
|
|
2232
|
-
|
|
2316
|
+
interface InvoicesForOrder {
|
|
2233
2317
|
/** Order ID. */
|
|
2234
2318
|
orderId?: string;
|
|
2235
2319
|
/** Invoices info. */
|
|
2236
2320
|
invoicesInfo?: InvoiceInfo[];
|
|
2237
2321
|
}
|
|
2238
|
-
|
|
2322
|
+
interface GenerateInvoiceRequest {
|
|
2239
2323
|
/**
|
|
2240
2324
|
* Order ID.
|
|
2241
2325
|
* @minLength 1
|
|
@@ -2243,11 +2327,11 @@ export interface GenerateInvoiceRequest {
|
|
|
2243
2327
|
*/
|
|
2244
2328
|
orderId?: string;
|
|
2245
2329
|
}
|
|
2246
|
-
|
|
2330
|
+
interface GenerateInvoiceResponse {
|
|
2247
2331
|
/** Invoice ID. */
|
|
2248
2332
|
invoiceId?: string;
|
|
2249
2333
|
}
|
|
2250
|
-
|
|
2334
|
+
interface BulkGenerateInvoicesRequest {
|
|
2251
2335
|
/**
|
|
2252
2336
|
* Order IDs.
|
|
2253
2337
|
* @minSize 1
|
|
@@ -2257,21 +2341,21 @@ export interface BulkGenerateInvoicesRequest {
|
|
|
2257
2341
|
*/
|
|
2258
2342
|
orderIds?: string[];
|
|
2259
2343
|
}
|
|
2260
|
-
|
|
2344
|
+
interface BulkGenerateInvoicesResponse {
|
|
2261
2345
|
results?: BulkInvoiceResult[];
|
|
2262
2346
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2263
2347
|
}
|
|
2264
|
-
|
|
2348
|
+
interface BulkInvoiceResult {
|
|
2265
2349
|
itemMetadata?: ItemMetadata;
|
|
2266
2350
|
item?: InvoiceForOrder;
|
|
2267
2351
|
}
|
|
2268
|
-
|
|
2352
|
+
interface InvoiceForOrder {
|
|
2269
2353
|
/** Order ID. */
|
|
2270
2354
|
orderId?: string;
|
|
2271
2355
|
/** Invoice ID. */
|
|
2272
2356
|
invoiceId?: string;
|
|
2273
2357
|
}
|
|
2274
|
-
|
|
2358
|
+
interface AddInvoiceToOrderRequest {
|
|
2275
2359
|
/**
|
|
2276
2360
|
* Order ID.
|
|
2277
2361
|
* @minLength 1
|
|
@@ -2281,17 +2365,17 @@ export interface AddInvoiceToOrderRequest {
|
|
|
2281
2365
|
/** Invoice info. */
|
|
2282
2366
|
invoiceInfo?: InvoiceInfo;
|
|
2283
2367
|
}
|
|
2284
|
-
|
|
2368
|
+
interface AddInvoiceToOrderResponse {
|
|
2285
2369
|
/** List of order invoices. */
|
|
2286
2370
|
orderInvoices?: InvoiceInfo[];
|
|
2287
2371
|
}
|
|
2288
|
-
|
|
2372
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2289
2373
|
createdEvent?: EntityCreatedEvent;
|
|
2290
2374
|
updatedEvent?: EntityUpdatedEvent;
|
|
2291
2375
|
deletedEvent?: EntityDeletedEvent;
|
|
2292
2376
|
actionEvent?: ActionEvent;
|
|
2293
2377
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2294
|
-
|
|
2378
|
+
_id?: string;
|
|
2295
2379
|
/**
|
|
2296
2380
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2297
2381
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -2320,36 +2404,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2320
2404
|
entityEventSequence?: string | null;
|
|
2321
2405
|
}
|
|
2322
2406
|
/** @oneof */
|
|
2323
|
-
|
|
2407
|
+
interface DomainEventBodyOneOf {
|
|
2324
2408
|
createdEvent?: EntityCreatedEvent;
|
|
2325
2409
|
updatedEvent?: EntityUpdatedEvent;
|
|
2326
2410
|
deletedEvent?: EntityDeletedEvent;
|
|
2327
2411
|
actionEvent?: ActionEvent;
|
|
2328
2412
|
}
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2332
|
-
restoreInfo?: RestoreInfo;
|
|
2413
|
+
interface EntityCreatedEvent {
|
|
2414
|
+
entity?: string;
|
|
2333
2415
|
}
|
|
2334
|
-
|
|
2416
|
+
interface RestoreInfo {
|
|
2335
2417
|
deletedDate?: Date | null;
|
|
2336
2418
|
}
|
|
2337
|
-
|
|
2419
|
+
interface EntityUpdatedEvent {
|
|
2338
2420
|
/**
|
|
2339
2421
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2340
2422
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2341
2423
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2342
2424
|
*/
|
|
2343
|
-
|
|
2425
|
+
currentEntity?: string;
|
|
2344
2426
|
}
|
|
2345
|
-
|
|
2427
|
+
interface EntityDeletedEvent {
|
|
2346
2428
|
/** Entity that was deleted. */
|
|
2347
|
-
|
|
2429
|
+
deletedEntity?: string | null;
|
|
2348
2430
|
}
|
|
2349
|
-
|
|
2350
|
-
|
|
2431
|
+
interface ActionEvent {
|
|
2432
|
+
body?: string;
|
|
2351
2433
|
}
|
|
2352
|
-
|
|
2434
|
+
interface MessageEnvelope {
|
|
2353
2435
|
/**
|
|
2354
2436
|
* App instance ID.
|
|
2355
2437
|
* @format GUID
|
|
@@ -2365,7 +2447,7 @@ export interface MessageEnvelope {
|
|
|
2365
2447
|
/** Stringify payload. */
|
|
2366
2448
|
data?: string;
|
|
2367
2449
|
}
|
|
2368
|
-
|
|
2450
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2369
2451
|
/**
|
|
2370
2452
|
* ID of a site visitor that has not logged in to the site.
|
|
2371
2453
|
* @format GUID
|
|
@@ -2390,7 +2472,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2390
2472
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2391
2473
|
}
|
|
2392
2474
|
/** @oneof */
|
|
2393
|
-
|
|
2475
|
+
interface IdentificationDataIdOneOf {
|
|
2394
2476
|
/**
|
|
2395
2477
|
* ID of a site visitor that has not logged in to the site.
|
|
2396
2478
|
* @format GUID
|
|
@@ -2412,7 +2494,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
2412
2494
|
*/
|
|
2413
2495
|
appId?: string;
|
|
2414
2496
|
}
|
|
2415
|
-
|
|
2497
|
+
declare enum WebhookIdentityType {
|
|
2416
2498
|
UNKNOWN = "UNKNOWN",
|
|
2417
2499
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2418
2500
|
MEMBER = "MEMBER",
|
|
@@ -2420,4 +2502,28 @@ export declare enum WebhookIdentityType {
|
|
|
2420
2502
|
APP = "APP"
|
|
2421
2503
|
}
|
|
2422
2504
|
/** @enumType */
|
|
2423
|
-
|
|
2505
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2506
|
+
interface UpdatePaymentStatusIdentifiers {
|
|
2507
|
+
/**
|
|
2508
|
+
* Payment ID.
|
|
2509
|
+
* @format GUID
|
|
2510
|
+
*/
|
|
2511
|
+
paymentId: string;
|
|
2512
|
+
/**
|
|
2513
|
+
* Order ID.
|
|
2514
|
+
* @format GUID
|
|
2515
|
+
*/
|
|
2516
|
+
orderId: string;
|
|
2517
|
+
}
|
|
2518
|
+
interface UpdatePaymentStatusOptions {
|
|
2519
|
+
/** Payment status. */
|
|
2520
|
+
status?: TransactionStatusWithLiterals;
|
|
2521
|
+
}
|
|
2522
|
+
interface BulkUpdatePaymentStatusesOptions {
|
|
2523
|
+
/** Whether to return the full payment entity (`results.item`) in the response. */
|
|
2524
|
+
returnFullEntity?: boolean;
|
|
2525
|
+
/** Payment status. */
|
|
2526
|
+
status?: TransactionStatusWithLiterals;
|
|
2527
|
+
}
|
|
2528
|
+
|
|
2529
|
+
export { type RefundTransaction as $, type AddPaymentsResponse as A, type BulkUpdatePaymentStatusesOptions as B, ChannelType as C, type Price as D, EnteredByIdentityType as E, FulfillmentStatus as F, type AuthorizationActionFailureDetails as G, type AuthorizationVoid as H, IdentityType as I, type ScheduledAction as J, type GiftCardPaymentDetails as K, type ListTransactionsForSingleOrderResponse as L, MembershipPaymentStatus as M, NonRefundableReason as N, type OrderTransactions as O, type Payment as P, type MembershipPaymentDetails as Q, Reason as R, SubscriptionFrequency as S, TransactionStatus as T, type UpdatePaymentStatusIdentifiers as U, VatType as V, WeightUnit as W, type MembershipName as X, type WixReceiptInfo as Y, type ExternalReceiptInfo as Z, type Refund as _, type ListTransactionsForMultipleOrdersResponse as a, type AddRefundResponse as a$, type RefundStatusInfo as a0, type RefundDetails as a1, type RefundItem as a2, type LineItemRefund as a3, type AdditionalFeeRefund as a4, type ShippingRefund as a5, type AggregatedRefundSummary as a6, type RefundItemsBreakdown as a7, type LineItemRefundSummary as a8, type SnapshotMessage as a9, type DigitalFile as aA, type Activity as aB, type V2InvoiceInfo as aC, type Fulfillment as aD, type FulfillmentLineItem as aE, type FulfillmentTrackingInfo as aF, type Discount as aG, type AppliedCoupon as aH, type CustomField as aI, type ChannelInfo as aJ, type EnteredBy as aK, type SubscriptionInfo as aL, type SubscriptionSettings as aM, type SubscriptionOptionInfo as aN, type V2Refund as aO, type GiftCard as aP, type PaymentsUpdated as aQ, type PaymentDetailsUpdated as aR, type RefundCreated as aS, type RestockInfo as aT, type RestockItem as aU, type RefundCompleted as aV, type RefundSideEffects as aW, type ListTransactionsForSingleOrderRequest as aX, type ListTransactionsForMultipleOrdersRequest as aY, type AddPaymentsRequest as aZ, type AddRefundRequest as a_, type IndexingMessage as aa, type DiffmatokyPayload as ab, type ErrorInformation as ac, type OrderRefunded as ad, type Order as ae, type BuyerInfo as af, type Totals as ag, type BillingInfo as ah, type Address as ai, type AddressAddressLine1OptionsOneOf as aj, type FullName as ak, type Street as al, type VatId as am, type ShippingInfo as an, type ShippingInfoDetailsOneOf as ao, type ShipmentDetails as ap, type TrackingInfo as aq, type ShippingPriceData as ar, type PickupDetails as as, type PickupAddress as at, type BuyerDetails as au, type LineItem as av, type OptionSelection as aw, type CustomTextFieldSelection as ax, type MediaItem as ay, type LineItemPriceData as az, type UpdatePaymentStatusOptions as b, type UpdatePaymentStatusRequest as b0, type BulkUpdatePaymentStatusesRequest as b1, type BulkPaymentResult as b2, type ItemMetadata as b3, type ApplicationError as b4, type BulkActionMetadata as b5, type UpdateRefundRequest as b6, type UpdateRefundResponse as b7, type UpdateRefundTransactionRequest as b8, type UpdateRefundTransactionResponse as b9, type ListInvoicesForMultipleOrdersResponse as bA, type InvoicesForOrder as bB, type GenerateInvoiceRequest as bC, type GenerateInvoiceResponse as bD, type BulkGenerateInvoicesRequest as bE, type BulkGenerateInvoicesResponse as bF, type BulkInvoiceResult as bG, type InvoiceForOrder as bH, type AddInvoiceToOrderRequest as bI, type AddInvoiceToOrderResponse as bJ, type DomainEvent as bK, type DomainEventBodyOneOf as bL, type EntityCreatedEvent as bM, type RestoreInfo as bN, type EntityUpdatedEvent as bO, type EntityDeletedEvent as bP, type ActionEvent as bQ, type MessageEnvelope as bR, type IdentificationData as bS, type IdentificationDataIdOneOf as bT, type UpdatePaymentsRequest as ba, type MaskedPayment as bb, type UpdatePaymentsResponse as bc, type QueryOrderTransactionsRequest as bd, type CursorQuery as be, type CursorQueryPagingMethodOneOf as bf, type Sorting as bg, type CursorPaging as bh, type QueryOrderTransactionsResponse as bi, type CursorPagingMetadata as bj, type Cursors as bk, type TriggerRefundRequest as bl, type PaymentRefund as bm, type TriggerRefundResponse as bn, type CalculateRefundRequest as bo, type CalculateRefundItemRequest as bp, type CalculateRefundResponse as bq, type CalculateRefundItemResponse as br, type GetRefundabilityStatusRequest as bs, type GetRefundabilityStatusResponse as bt, type Refundability as bu, type RefundabilityAdditionalRefundabilityInfoOneOf as bv, type ListInvoicesForSingleOrderRequest as bw, type ListInvoicesForSingleOrderResponse as bx, type InvoiceInfo as by, type ListInvoicesForMultipleOrdersRequest as bz, type UpdatePaymentStatusResponse as c, type PaymentAndOrderId as d, type BulkUpdatePaymentStatusesResponse as e, AuthorizationCaptureStatus as f, AuthorizationVoidStatus as g, ActionType as h, RefundStatus as i, PaymentStatus as j, LineItemType as k, MediaItemType as l, ActivityType as m, InvoiceSource as n, RestockType as o, SortOrder as p, RefundableStatus as q, ManuallyRefundableReason as r, WebhookIdentityType as s, type PaymentPaymentDetailsOneOf as t, type PaymentReceiptInfoOneOf as u, type RegularPaymentDetails as v, type RegularPaymentDetailsPaymentMethodDetailsOneOf as w, type CreditCardPaymentMethodDetails as x, type AuthorizationDetails as y, type AuthorizationCapture as z };
|