@wix/auto_sdk_payments_disputes 1.0.31 → 1.0.33
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 +338 -209
- package/build/cjs/index.js +53 -34
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js +48 -29
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +102 -79
- package/build/cjs/meta.js +45 -26
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +338 -209
- package/build/es/index.mjs +52 -33
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs +47 -28
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +102 -79
- package/build/es/meta.mjs +44 -25
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +16 -16
- package/build/internal/cjs/index.js +53 -34
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +349 -220
- package/build/internal/cjs/index.typings.js +48 -29
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +102 -79
- package/build/internal/cjs/meta.js +45 -26
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +16 -16
- package/build/internal/es/index.mjs +52 -33
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +349 -220
- package/build/internal/es/index.typings.mjs +47 -28
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +102 -79
- package/build/internal/es/meta.mjs +44 -25
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -20,9 +20,15 @@ interface Dispute {
|
|
|
20
20
|
* @immutable
|
|
21
21
|
*/
|
|
22
22
|
providerDisputeId?: string;
|
|
23
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Dispute stage
|
|
25
|
+
* @readonly
|
|
26
|
+
*/
|
|
24
27
|
stage?: DisputeStageWithLiterals;
|
|
25
|
-
/**
|
|
28
|
+
/**
|
|
29
|
+
* Dispute reason
|
|
30
|
+
* @readonly
|
|
31
|
+
*/
|
|
26
32
|
reason?: DisputeReasonWithLiterals;
|
|
27
33
|
/**
|
|
28
34
|
* Dispute currency. Should be the same as the charge currency.
|
|
@@ -36,33 +42,62 @@ interface Dispute {
|
|
|
36
42
|
* @decimalValue options { gt:0, maxScale:8 }
|
|
37
43
|
*/
|
|
38
44
|
amount?: string | null;
|
|
39
|
-
/**
|
|
45
|
+
/**
|
|
46
|
+
* Dispute status based on provider dispute status
|
|
47
|
+
* @readonly
|
|
48
|
+
*/
|
|
40
49
|
status?: DisputeStatusWithLiterals;
|
|
41
50
|
/** True if the merchant can do the refund with the opened dispute, false otherwise */
|
|
42
51
|
chargeRefundable?: boolean | null;
|
|
43
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* Seller protection helps protect sellers from financial loss on eligible transactions due to unauthorized payments or claims that items were not received
|
|
54
|
+
* @readonly
|
|
55
|
+
*/
|
|
44
56
|
sellerProtection?: SellerProtectionWithLiterals;
|
|
45
57
|
/**
|
|
46
58
|
* Dispute Channel
|
|
47
59
|
* Internal - this dispute is created on provider side
|
|
48
60
|
* External - this dispute is created on bank side
|
|
61
|
+
* @readonly
|
|
49
62
|
*/
|
|
50
63
|
channel?: DisputeChannelWithLiterals;
|
|
51
|
-
/**
|
|
64
|
+
/**
|
|
65
|
+
* The latest date and time until which the dispute can remain in its current status
|
|
66
|
+
* @readonly
|
|
67
|
+
*/
|
|
52
68
|
dueDate?: Date | null;
|
|
53
69
|
/**
|
|
54
70
|
* Network reason code
|
|
55
|
-
* https://docs.stripe.com/disputes/reason-codes-defense-requirements?card-network=visa
|
|
56
|
-
* https://docs.stripe.com/disputes/reason-codes-defense-requirements?card-network=mastercard
|
|
57
|
-
* https://docs.stripe.com/disputes/reason-codes-defense-requirements?card-network=amex
|
|
58
71
|
* @minLength 1
|
|
59
72
|
* @maxLength 64
|
|
60
73
|
*/
|
|
61
74
|
networkReasonCode?: string | null;
|
|
62
|
-
/**
|
|
75
|
+
/**
|
|
76
|
+
* True if dispute is defendable
|
|
77
|
+
* @readonly
|
|
78
|
+
*/
|
|
63
79
|
defendable?: boolean | null;
|
|
64
|
-
/**
|
|
80
|
+
/**
|
|
81
|
+
* True if it is an auto dispute
|
|
82
|
+
* @readonly
|
|
83
|
+
*/
|
|
65
84
|
autoDefended?: boolean | null;
|
|
85
|
+
/**
|
|
86
|
+
* The dispute defense date
|
|
87
|
+
* @readonly
|
|
88
|
+
*/
|
|
89
|
+
defenseDate?: Date | null;
|
|
90
|
+
/**
|
|
91
|
+
* The dispute acceptance date
|
|
92
|
+
* @readonly
|
|
93
|
+
*/
|
|
94
|
+
acceptanceDate?: Date | null;
|
|
95
|
+
/**
|
|
96
|
+
* The actions that can be perform with the dispute
|
|
97
|
+
* @readonly
|
|
98
|
+
* @maxSize 20
|
|
99
|
+
*/
|
|
100
|
+
actions?: DisputeAction[];
|
|
66
101
|
/**
|
|
67
102
|
* The dispute created date
|
|
68
103
|
* @readonly
|
|
@@ -82,7 +117,7 @@ interface Dispute {
|
|
|
82
117
|
/** Data Extensions */
|
|
83
118
|
extendedFields?: ExtendedFields;
|
|
84
119
|
/** Tags */
|
|
85
|
-
tags?:
|
|
120
|
+
tags?: Tags;
|
|
86
121
|
}
|
|
87
122
|
declare enum DisputeStage {
|
|
88
123
|
UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
|
|
@@ -124,7 +159,7 @@ declare enum DisputeStatus {
|
|
|
124
159
|
UNKNOWN_DISPUTE_STATUS = "UNKNOWN_DISPUTE_STATUS",
|
|
125
160
|
/** Waiting for some merchant action */
|
|
126
161
|
WAITING_MERCHANT = "WAITING_MERCHANT",
|
|
127
|
-
/** Dispute is under review by PSP
|
|
162
|
+
/** Dispute is under review by PSP or Bank */
|
|
128
163
|
UNDER_REVIEW = "UNDER_REVIEW",
|
|
129
164
|
/** Waiting for some buyer action */
|
|
130
165
|
WAITING_BUYER = "WAITING_BUYER",
|
|
@@ -159,6 +194,22 @@ declare enum DisputeChannel {
|
|
|
159
194
|
}
|
|
160
195
|
/** @enumType */
|
|
161
196
|
type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | 'INTERNAL' | 'EXTERNAL';
|
|
197
|
+
interface DisputeAction {
|
|
198
|
+
/** Dispute Action type */
|
|
199
|
+
type?: DisputeActionTypeWithLiterals;
|
|
200
|
+
/** The latest date and time until which the action can be performed */
|
|
201
|
+
dueDate?: Date | null;
|
|
202
|
+
}
|
|
203
|
+
declare enum DisputeActionType {
|
|
204
|
+
/** Unknown dispute status */
|
|
205
|
+
UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
|
|
206
|
+
/** Accept dispute */
|
|
207
|
+
ACCEPT = "ACCEPT",
|
|
208
|
+
/** Defend evidence */
|
|
209
|
+
DEFEND = "DEFEND"
|
|
210
|
+
}
|
|
211
|
+
/** @enumType */
|
|
212
|
+
type DisputeActionTypeWithLiterals = DisputeActionType | 'UNKNOWN_DISPUTE_ACTION' | 'ACCEPT' | 'DEFEND';
|
|
162
213
|
interface ExtendedFields {
|
|
163
214
|
/**
|
|
164
215
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -170,18 +221,282 @@ interface ExtendedFields {
|
|
|
170
221
|
*/
|
|
171
222
|
namespaces?: Record<string, Record<string, any>>;
|
|
172
223
|
}
|
|
173
|
-
|
|
224
|
+
/**
|
|
225
|
+
* Common object for tags.
|
|
226
|
+
* Should be use as in this example:
|
|
227
|
+
* message Foo {
|
|
228
|
+
* option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
|
|
229
|
+
* string id = 1;
|
|
230
|
+
* ...
|
|
231
|
+
* Tags tags = 5
|
|
232
|
+
* }
|
|
233
|
+
*
|
|
234
|
+
* example of taggable entity
|
|
235
|
+
* {
|
|
236
|
+
* id: "123"
|
|
237
|
+
* tags: {
|
|
238
|
+
* public_tags: {
|
|
239
|
+
* tag_ids:["11","22"]
|
|
240
|
+
* },
|
|
241
|
+
* private_tags: {
|
|
242
|
+
* tag_ids: ["33", "44"]
|
|
243
|
+
* }
|
|
244
|
+
* }
|
|
245
|
+
* }
|
|
246
|
+
*/
|
|
247
|
+
interface Tags {
|
|
248
|
+
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
249
|
+
privateTags?: TagList;
|
|
174
250
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
175
|
-
|
|
251
|
+
publicTags?: TagList;
|
|
176
252
|
}
|
|
177
253
|
interface TagList {
|
|
178
254
|
/**
|
|
179
|
-
* List of tag IDs
|
|
255
|
+
* List of tag IDs.
|
|
180
256
|
* @maxSize 100
|
|
181
257
|
* @maxLength 5
|
|
182
258
|
*/
|
|
183
259
|
tagIds?: string[];
|
|
184
260
|
}
|
|
261
|
+
interface TagsModified {
|
|
262
|
+
/** Updated Dispute. */
|
|
263
|
+
dispute?: Dispute;
|
|
264
|
+
/** Tags that were assigned to the Dispute. */
|
|
265
|
+
assignedTags?: Tags;
|
|
266
|
+
/** Tags that were unassigned from the Dispute. */
|
|
267
|
+
unassignedTags?: Tags;
|
|
268
|
+
}
|
|
269
|
+
interface InternalCreateDisputeManuallyRequest {
|
|
270
|
+
/**
|
|
271
|
+
* Dispute Id
|
|
272
|
+
* @format GUID
|
|
273
|
+
*/
|
|
274
|
+
disputeId?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Charge Id
|
|
277
|
+
* @format GUID
|
|
278
|
+
*/
|
|
279
|
+
chargeId?: string;
|
|
280
|
+
/** Open date */
|
|
281
|
+
openDate?: Date | null;
|
|
282
|
+
/**
|
|
283
|
+
* Provider Dispute Id
|
|
284
|
+
* @minLength 1
|
|
285
|
+
* @maxLength 100
|
|
286
|
+
*/
|
|
287
|
+
providerDisputeId?: string;
|
|
288
|
+
/** Dispute stage */
|
|
289
|
+
stage?: DisputeStageWithLiterals;
|
|
290
|
+
/** Dispute reason */
|
|
291
|
+
reason?: DisputeReasonWithLiterals;
|
|
292
|
+
/** Dispute status based on provider dispute status */
|
|
293
|
+
status?: DisputeStatusWithLiterals;
|
|
294
|
+
/** The latest date and time until which the dispute can remain in its current status */
|
|
295
|
+
dueDate?: Date | null;
|
|
296
|
+
/**
|
|
297
|
+
* Dispute currency. Should be the same as the charge currency.
|
|
298
|
+
* @immutable
|
|
299
|
+
* @format CURRENCY
|
|
300
|
+
*/
|
|
301
|
+
currencyCode?: string | null;
|
|
302
|
+
/**
|
|
303
|
+
* Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
|
|
304
|
+
* @immutable
|
|
305
|
+
* @decimalValue options { gt:0, maxScale:8 }
|
|
306
|
+
*/
|
|
307
|
+
amount?: string | null;
|
|
308
|
+
/**
|
|
309
|
+
* Network reason code
|
|
310
|
+
* @minLength 1
|
|
311
|
+
* @maxLength 64
|
|
312
|
+
*/
|
|
313
|
+
networkReasonCode?: string | null;
|
|
314
|
+
/** External or Internal */
|
|
315
|
+
external?: boolean | null;
|
|
316
|
+
/**
|
|
317
|
+
* Seller protection
|
|
318
|
+
* @minLength 1
|
|
319
|
+
* @maxLength 64
|
|
320
|
+
*/
|
|
321
|
+
sellerProtection?: string | null;
|
|
322
|
+
/** Is charge refundable */
|
|
323
|
+
chargeRefundable?: boolean | null;
|
|
324
|
+
/** True if dispute is defendable */
|
|
325
|
+
defendable?: boolean | null;
|
|
326
|
+
/** True if it is an auto dispute */
|
|
327
|
+
autoDefended?: boolean | null;
|
|
328
|
+
}
|
|
329
|
+
interface InternalCreateDisputeManuallyResponse {
|
|
330
|
+
}
|
|
331
|
+
interface InternalChangeDisputeStatusManuallyRequest {
|
|
332
|
+
/**
|
|
333
|
+
* Dispute ID
|
|
334
|
+
* @format GUID
|
|
335
|
+
*/
|
|
336
|
+
disputeId?: string;
|
|
337
|
+
/** Changed date */
|
|
338
|
+
changedDate?: Date | null;
|
|
339
|
+
/** Dispute status based on provider dispute status */
|
|
340
|
+
status?: DisputeStatusWithLiterals;
|
|
341
|
+
}
|
|
342
|
+
interface InternalChangeDisputeStatusManuallyResponse {
|
|
343
|
+
}
|
|
344
|
+
interface AcceptDisputeManuallyRequest {
|
|
345
|
+
/**
|
|
346
|
+
* Dispute ID
|
|
347
|
+
* @format GUID
|
|
348
|
+
*/
|
|
349
|
+
disputeId?: string;
|
|
350
|
+
/** Acceptance date */
|
|
351
|
+
acceptanceDate?: Date | null;
|
|
352
|
+
}
|
|
353
|
+
interface AcceptDisputeManuallyResponse {
|
|
354
|
+
}
|
|
355
|
+
interface DefendDisputeManuallyRequest {
|
|
356
|
+
/**
|
|
357
|
+
* Dispute ID
|
|
358
|
+
* @format GUID
|
|
359
|
+
*/
|
|
360
|
+
disputeId?: string;
|
|
361
|
+
/** Defense date */
|
|
362
|
+
defenseDate?: Date | null;
|
|
363
|
+
}
|
|
364
|
+
interface DefendDisputeManuallyResponse {
|
|
365
|
+
}
|
|
366
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
367
|
+
createdEvent?: EntityCreatedEvent;
|
|
368
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
369
|
+
deletedEvent?: EntityDeletedEvent;
|
|
370
|
+
actionEvent?: ActionEvent;
|
|
371
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
372
|
+
_id?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
375
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
376
|
+
*/
|
|
377
|
+
entityFqdn?: string;
|
|
378
|
+
/**
|
|
379
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
380
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
381
|
+
*/
|
|
382
|
+
slug?: string;
|
|
383
|
+
/** ID of the entity associated with the event. */
|
|
384
|
+
entityId?: string;
|
|
385
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
386
|
+
eventTime?: Date | null;
|
|
387
|
+
/**
|
|
388
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
389
|
+
* (for example, GDPR).
|
|
390
|
+
*/
|
|
391
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
392
|
+
/** If present, indicates the action that triggered the event. */
|
|
393
|
+
originatedFrom?: string | null;
|
|
394
|
+
/**
|
|
395
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
396
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
397
|
+
*/
|
|
398
|
+
entityEventSequence?: string | null;
|
|
399
|
+
}
|
|
400
|
+
/** @oneof */
|
|
401
|
+
interface DomainEventBodyOneOf {
|
|
402
|
+
createdEvent?: EntityCreatedEvent;
|
|
403
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
404
|
+
deletedEvent?: EntityDeletedEvent;
|
|
405
|
+
actionEvent?: ActionEvent;
|
|
406
|
+
}
|
|
407
|
+
interface EntityCreatedEvent {
|
|
408
|
+
entity?: string;
|
|
409
|
+
}
|
|
410
|
+
interface RestoreInfo {
|
|
411
|
+
deletedDate?: Date | null;
|
|
412
|
+
}
|
|
413
|
+
interface EntityUpdatedEvent {
|
|
414
|
+
/**
|
|
415
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
416
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
417
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
418
|
+
*/
|
|
419
|
+
currentEntity?: string;
|
|
420
|
+
}
|
|
421
|
+
interface EntityDeletedEvent {
|
|
422
|
+
/** Entity that was deleted. */
|
|
423
|
+
deletedEntity?: string | null;
|
|
424
|
+
}
|
|
425
|
+
interface ActionEvent {
|
|
426
|
+
body?: string;
|
|
427
|
+
}
|
|
428
|
+
interface MessageEnvelope {
|
|
429
|
+
/**
|
|
430
|
+
* App instance ID.
|
|
431
|
+
* @format GUID
|
|
432
|
+
*/
|
|
433
|
+
instanceId?: string | null;
|
|
434
|
+
/**
|
|
435
|
+
* Event type.
|
|
436
|
+
* @maxLength 150
|
|
437
|
+
*/
|
|
438
|
+
eventType?: string;
|
|
439
|
+
/** The identification type and identity data. */
|
|
440
|
+
identity?: IdentificationData;
|
|
441
|
+
/** Stringify payload. */
|
|
442
|
+
data?: string;
|
|
443
|
+
}
|
|
444
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
445
|
+
/**
|
|
446
|
+
* ID of a site visitor that has not logged in to the site.
|
|
447
|
+
* @format GUID
|
|
448
|
+
*/
|
|
449
|
+
anonymousVisitorId?: string;
|
|
450
|
+
/**
|
|
451
|
+
* ID of a site visitor that has logged in to the site.
|
|
452
|
+
* @format GUID
|
|
453
|
+
*/
|
|
454
|
+
memberId?: string;
|
|
455
|
+
/**
|
|
456
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
457
|
+
* @format GUID
|
|
458
|
+
*/
|
|
459
|
+
wixUserId?: string;
|
|
460
|
+
/**
|
|
461
|
+
* ID of an app.
|
|
462
|
+
* @format GUID
|
|
463
|
+
*/
|
|
464
|
+
appId?: string;
|
|
465
|
+
/** @readonly */
|
|
466
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
467
|
+
}
|
|
468
|
+
/** @oneof */
|
|
469
|
+
interface IdentificationDataIdOneOf {
|
|
470
|
+
/**
|
|
471
|
+
* ID of a site visitor that has not logged in to the site.
|
|
472
|
+
* @format GUID
|
|
473
|
+
*/
|
|
474
|
+
anonymousVisitorId?: string;
|
|
475
|
+
/**
|
|
476
|
+
* ID of a site visitor that has logged in to the site.
|
|
477
|
+
* @format GUID
|
|
478
|
+
*/
|
|
479
|
+
memberId?: string;
|
|
480
|
+
/**
|
|
481
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
482
|
+
* @format GUID
|
|
483
|
+
*/
|
|
484
|
+
wixUserId?: string;
|
|
485
|
+
/**
|
|
486
|
+
* ID of an app.
|
|
487
|
+
* @format GUID
|
|
488
|
+
*/
|
|
489
|
+
appId?: string;
|
|
490
|
+
}
|
|
491
|
+
declare enum WebhookIdentityType {
|
|
492
|
+
UNKNOWN = "UNKNOWN",
|
|
493
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
494
|
+
MEMBER = "MEMBER",
|
|
495
|
+
WIX_USER = "WIX_USER",
|
|
496
|
+
APP = "APP"
|
|
497
|
+
}
|
|
498
|
+
/** @enumType */
|
|
499
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
185
500
|
interface GetDisputeRequest {
|
|
186
501
|
/**
|
|
187
502
|
* ID of the Dispute to retrieve.
|
|
@@ -282,44 +597,25 @@ interface Cursors {
|
|
|
282
597
|
*/
|
|
283
598
|
prev?: string | null;
|
|
284
599
|
}
|
|
285
|
-
interface
|
|
600
|
+
interface AcceptDisputeRequest {
|
|
286
601
|
/**
|
|
287
602
|
* Dispute ID
|
|
288
603
|
* @format GUID
|
|
289
604
|
*/
|
|
290
605
|
disputeId: string;
|
|
291
606
|
}
|
|
292
|
-
interface
|
|
293
|
-
/**
|
|
294
|
-
|
|
295
|
-
* @maxSize 20
|
|
296
|
-
*/
|
|
297
|
-
actions?: DisputeAction[];
|
|
298
|
-
}
|
|
299
|
-
interface DisputeAction {
|
|
300
|
-
/** Dispute Action type */
|
|
301
|
-
type?: DisputeActionTypeWithLiterals;
|
|
302
|
-
/** The latest date and time until which the action can be performed */
|
|
303
|
-
dueDate?: Date | null;
|
|
304
|
-
}
|
|
305
|
-
declare enum DisputeActionType {
|
|
306
|
-
/** Unknown dispute status */
|
|
307
|
-
UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
|
|
308
|
-
/** Accept dispute */
|
|
309
|
-
ACCEPT = "ACCEPT",
|
|
310
|
-
/** Submit evidence */
|
|
311
|
-
SUBMIT_EVIDENCE = "SUBMIT_EVIDENCE"
|
|
607
|
+
interface AcceptDisputeResponse {
|
|
608
|
+
/** Dispute */
|
|
609
|
+
dispute?: Dispute;
|
|
312
610
|
}
|
|
313
|
-
|
|
314
|
-
type DisputeActionTypeWithLiterals = DisputeActionType | 'UNKNOWN_DISPUTE_ACTION' | 'ACCEPT' | 'SUBMIT_EVIDENCE';
|
|
315
|
-
interface AcceptDisputeRequest {
|
|
611
|
+
interface DefendDisputeRequest {
|
|
316
612
|
/**
|
|
317
613
|
* Dispute ID
|
|
318
614
|
* @format GUID
|
|
319
615
|
*/
|
|
320
616
|
disputeId: string;
|
|
321
617
|
}
|
|
322
|
-
interface
|
|
618
|
+
interface DefendDisputeResponse {
|
|
323
619
|
/** Dispute */
|
|
324
620
|
dispute?: Dispute;
|
|
325
621
|
}
|
|
@@ -359,6 +655,7 @@ interface CreateDisputeManuallyRequest {
|
|
|
359
655
|
reason?: DisputeReasonWithLiterals;
|
|
360
656
|
/** Dispute status based on provider dispute status */
|
|
361
657
|
status?: DisputeStatusWithLiterals;
|
|
658
|
+
/** The latest date and time until which the dispute can remain in its current status */
|
|
362
659
|
dueDate?: Date | null;
|
|
363
660
|
/**
|
|
364
661
|
* Dispute currency. Should be the same as the charge currency.
|
|
@@ -421,40 +718,6 @@ interface BulkUpdateDisputeTagsRequest {
|
|
|
421
718
|
/** List of Tags to unAssign */
|
|
422
719
|
unassignTags?: Tags;
|
|
423
720
|
}
|
|
424
|
-
/**
|
|
425
|
-
* Common object for tags.
|
|
426
|
-
* Should be use as in this example:
|
|
427
|
-
* message Foo {
|
|
428
|
-
* string id = 1;
|
|
429
|
-
* ...
|
|
430
|
-
* Tags tags = 5
|
|
431
|
-
* }
|
|
432
|
-
*
|
|
433
|
-
* example of taggable entity
|
|
434
|
-
* {
|
|
435
|
-
* id: "123"
|
|
436
|
-
* tags: {
|
|
437
|
-
* tags: {
|
|
438
|
-
* tag_ids:["11","22"]
|
|
439
|
-
* },
|
|
440
|
-
* private_tags: {
|
|
441
|
-
* tag_ids: ["33", "44"]
|
|
442
|
-
* }
|
|
443
|
-
* }
|
|
444
|
-
* }
|
|
445
|
-
*/
|
|
446
|
-
interface Tags {
|
|
447
|
-
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
448
|
-
tags?: TagsTagList;
|
|
449
|
-
}
|
|
450
|
-
interface TagsTagList {
|
|
451
|
-
/**
|
|
452
|
-
* List of tag IDs
|
|
453
|
-
* @maxSize 100
|
|
454
|
-
* @maxLength 5
|
|
455
|
-
*/
|
|
456
|
-
tagIds?: string[];
|
|
457
|
-
}
|
|
458
721
|
interface BulkUpdateDisputeTagsResponse {
|
|
459
722
|
/**
|
|
460
723
|
* Results
|
|
@@ -513,140 +776,6 @@ interface BulkUpdateDisputeTagsByFilterResponse {
|
|
|
513
776
|
*/
|
|
514
777
|
jobId?: string;
|
|
515
778
|
}
|
|
516
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
517
|
-
createdEvent?: EntityCreatedEvent;
|
|
518
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
519
|
-
deletedEvent?: EntityDeletedEvent;
|
|
520
|
-
actionEvent?: ActionEvent;
|
|
521
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
522
|
-
_id?: string;
|
|
523
|
-
/**
|
|
524
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
525
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
526
|
-
*/
|
|
527
|
-
entityFqdn?: string;
|
|
528
|
-
/**
|
|
529
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
530
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
531
|
-
*/
|
|
532
|
-
slug?: string;
|
|
533
|
-
/** ID of the entity associated with the event. */
|
|
534
|
-
entityId?: string;
|
|
535
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
536
|
-
eventTime?: Date | null;
|
|
537
|
-
/**
|
|
538
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
539
|
-
* (for example, GDPR).
|
|
540
|
-
*/
|
|
541
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
542
|
-
/** If present, indicates the action that triggered the event. */
|
|
543
|
-
originatedFrom?: string | null;
|
|
544
|
-
/**
|
|
545
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
546
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
547
|
-
*/
|
|
548
|
-
entityEventSequence?: string | null;
|
|
549
|
-
}
|
|
550
|
-
/** @oneof */
|
|
551
|
-
interface DomainEventBodyOneOf {
|
|
552
|
-
createdEvent?: EntityCreatedEvent;
|
|
553
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
554
|
-
deletedEvent?: EntityDeletedEvent;
|
|
555
|
-
actionEvent?: ActionEvent;
|
|
556
|
-
}
|
|
557
|
-
interface EntityCreatedEvent {
|
|
558
|
-
entity?: string;
|
|
559
|
-
}
|
|
560
|
-
interface RestoreInfo {
|
|
561
|
-
deletedDate?: Date | null;
|
|
562
|
-
}
|
|
563
|
-
interface EntityUpdatedEvent {
|
|
564
|
-
/**
|
|
565
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
566
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
567
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
568
|
-
*/
|
|
569
|
-
currentEntity?: string;
|
|
570
|
-
}
|
|
571
|
-
interface EntityDeletedEvent {
|
|
572
|
-
/** Entity that was deleted. */
|
|
573
|
-
deletedEntity?: string | null;
|
|
574
|
-
}
|
|
575
|
-
interface ActionEvent {
|
|
576
|
-
body?: string;
|
|
577
|
-
}
|
|
578
|
-
interface MessageEnvelope {
|
|
579
|
-
/**
|
|
580
|
-
* App instance ID.
|
|
581
|
-
* @format GUID
|
|
582
|
-
*/
|
|
583
|
-
instanceId?: string | null;
|
|
584
|
-
/**
|
|
585
|
-
* Event type.
|
|
586
|
-
* @maxLength 150
|
|
587
|
-
*/
|
|
588
|
-
eventType?: string;
|
|
589
|
-
/** The identification type and identity data. */
|
|
590
|
-
identity?: IdentificationData;
|
|
591
|
-
/** Stringify payload. */
|
|
592
|
-
data?: string;
|
|
593
|
-
}
|
|
594
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
595
|
-
/**
|
|
596
|
-
* ID of a site visitor that has not logged in to the site.
|
|
597
|
-
* @format GUID
|
|
598
|
-
*/
|
|
599
|
-
anonymousVisitorId?: string;
|
|
600
|
-
/**
|
|
601
|
-
* ID of a site visitor that has logged in to the site.
|
|
602
|
-
* @format GUID
|
|
603
|
-
*/
|
|
604
|
-
memberId?: string;
|
|
605
|
-
/**
|
|
606
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
607
|
-
* @format GUID
|
|
608
|
-
*/
|
|
609
|
-
wixUserId?: string;
|
|
610
|
-
/**
|
|
611
|
-
* ID of an app.
|
|
612
|
-
* @format GUID
|
|
613
|
-
*/
|
|
614
|
-
appId?: string;
|
|
615
|
-
/** @readonly */
|
|
616
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
617
|
-
}
|
|
618
|
-
/** @oneof */
|
|
619
|
-
interface IdentificationDataIdOneOf {
|
|
620
|
-
/**
|
|
621
|
-
* ID of a site visitor that has not logged in to the site.
|
|
622
|
-
* @format GUID
|
|
623
|
-
*/
|
|
624
|
-
anonymousVisitorId?: string;
|
|
625
|
-
/**
|
|
626
|
-
* ID of a site visitor that has logged in to the site.
|
|
627
|
-
* @format GUID
|
|
628
|
-
*/
|
|
629
|
-
memberId?: string;
|
|
630
|
-
/**
|
|
631
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
632
|
-
* @format GUID
|
|
633
|
-
*/
|
|
634
|
-
wixUserId?: string;
|
|
635
|
-
/**
|
|
636
|
-
* ID of an app.
|
|
637
|
-
* @format GUID
|
|
638
|
-
*/
|
|
639
|
-
appId?: string;
|
|
640
|
-
}
|
|
641
|
-
declare enum WebhookIdentityType {
|
|
642
|
-
UNKNOWN = "UNKNOWN",
|
|
643
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
644
|
-
MEMBER = "MEMBER",
|
|
645
|
-
WIX_USER = "WIX_USER",
|
|
646
|
-
APP = "APP"
|
|
647
|
-
}
|
|
648
|
-
/** @enumType */
|
|
649
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
650
779
|
/** @docsIgnore */
|
|
651
780
|
type BulkUpdateDisputeTagsApplicationErrors = {
|
|
652
781
|
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
@@ -669,7 +798,7 @@ type BulkUpdateDisputeTagsByFilterApplicationErrors = {
|
|
|
669
798
|
* @returns The requested Dispute.
|
|
670
799
|
* @fqn wix.payments.disputes.v1.DisputeService.GetDispute
|
|
671
800
|
*/
|
|
672
|
-
declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `
|
|
801
|
+
declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.privateTags.tagIds`, 4>>;
|
|
673
802
|
/**
|
|
674
803
|
* Retrieves a list of Disputes
|
|
675
804
|
* @internal
|
|
@@ -756,27 +885,27 @@ interface DisputesQueryBuilder {
|
|
|
756
885
|
find: () => Promise<DisputesQueryResult>;
|
|
757
886
|
}
|
|
758
887
|
/**
|
|
759
|
-
*
|
|
888
|
+
* Accept Dispute
|
|
760
889
|
* @param disputeId - Dispute ID
|
|
761
890
|
* @internal
|
|
762
891
|
* @documentationMaturity preview
|
|
763
892
|
* @requiredField disputeId
|
|
764
|
-
* @permissionId PAYMENTS.
|
|
765
|
-
* @fqn wix.payments.disputes.v1.DisputeService.
|
|
893
|
+
* @permissionId PAYMENTS.DISPUTE_ACCEPT
|
|
894
|
+
* @fqn wix.payments.disputes.v1.DisputeService.AcceptDispute
|
|
766
895
|
*/
|
|
767
|
-
declare function
|
|
896
|
+
declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<AcceptDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
|
|
768
897
|
/**
|
|
769
|
-
* Dispute
|
|
898
|
+
* Defend Dispute
|
|
770
899
|
* @param disputeId - Dispute ID
|
|
771
900
|
* @internal
|
|
772
901
|
* @documentationMaturity preview
|
|
773
902
|
* @requiredField disputeId
|
|
774
|
-
* @permissionId PAYMENTS.
|
|
775
|
-
* @fqn wix.payments.disputes.v1.DisputeService.
|
|
903
|
+
* @permissionId PAYMENTS.DISPUTE_DEFEND
|
|
904
|
+
* @fqn wix.payments.disputes.v1.DisputeService.DefendDispute
|
|
776
905
|
*/
|
|
777
|
-
declare function
|
|
906
|
+
declare function defendDispute(disputeId: string): Promise<NonNullablePaths<DefendDisputeResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
|
|
778
907
|
/**
|
|
779
|
-
* Dispute Submit Evidence
|
|
908
|
+
* Dispute Submit Evidence // TODO will be removed in next PR (after removing usage in transaction-service)
|
|
780
909
|
* @param disputeId - Dispute ID
|
|
781
910
|
* @internal
|
|
782
911
|
* @documentationMaturity preview
|
|
@@ -784,7 +913,7 @@ declare function acceptDispute(disputeId: string): Promise<NonNullablePaths<Acce
|
|
|
784
913
|
* @permissionId PAYMENTS.DISPUTE_SUBMIT_EVIDENCE
|
|
785
914
|
* @fqn wix.payments.disputes.v1.DisputeService.SubmitDisputeEvidence
|
|
786
915
|
*/
|
|
787
|
-
declare function submitDisputeEvidence(disputeId: string): Promise<NonNullablePaths<SubmitDisputeEvidenceResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.
|
|
916
|
+
declare function submitDisputeEvidence(disputeId: string): Promise<NonNullablePaths<SubmitDisputeEvidenceResponse, `dispute._id` | `dispute.chargeId` | `dispute.providerDisputeId` | `dispute.stage` | `dispute.reason` | `dispute.status` | `dispute.sellerProtection` | `dispute.channel` | `dispute.actions` | `dispute.actions.${number}.type` | `dispute.tags.privateTags.tagIds`, 5>>;
|
|
788
917
|
/**
|
|
789
918
|
* Synchronously update tags on multiple Disputes, by list of Disputes ids
|
|
790
919
|
* A tag that appears both in the list of assign and unassign tags, will be assigned
|
|
@@ -825,4 +954,4 @@ interface BulkUpdateDisputeTagsByFilterOptions {
|
|
|
825
954
|
unassignTags?: Tags;
|
|
826
955
|
}
|
|
827
956
|
|
|
828
|
-
export { type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type
|
|
957
|
+
export { type AcceptDisputeManuallyRequest, type AcceptDisputeManuallyResponse, type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkUpdateDisputeTagsApplicationErrors, type BulkUpdateDisputeTagsByFilterApplicationErrors, type BulkUpdateDisputeTagsByFilterOptions, type BulkUpdateDisputeTagsByFilterRequest, type BulkUpdateDisputeTagsByFilterResponse, type BulkUpdateDisputeTagsOptions, type BulkUpdateDisputeTagsRequest, type BulkUpdateDisputeTagsResponse, type BulkUpdateDisputeTagsResult, type ChangeDisputeStatusManuallyRequest, type ChangeDisputeStatusManuallyResponse, type CreateDisputeManuallyRequest, type CreateDisputeManuallyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DefendDisputeManuallyRequest, type DefendDisputeManuallyResponse, type DefendDisputeRequest, type DefendDisputeResponse, type Dispute, type DisputeAction, DisputeActionType, type DisputeActionTypeWithLiterals, DisputeChannel, type DisputeChannelWithLiterals, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDisputeRequest, type GetDisputeResponse, type IdentificationData, type IdentificationDataIdOneOf, type InternalChangeDisputeStatusManuallyRequest, type InternalChangeDisputeStatusManuallyResponse, type InternalCreateDisputeManuallyRequest, type InternalCreateDisputeManuallyResponse, type ItemMetadata, type MessageEnvelope, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitDisputeEvidenceRequest, type SubmitDisputeEvidenceResponse, type TagList, type Tags, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, defendDispute, getDispute, queryDisputes, submitDisputeEvidence };
|