@wix/auto_sdk_payments_disputes 1.0.32 → 1.0.34
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 +57 -762
- package/build/cjs/index.js +68 -81
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1014 -1
- package/build/cjs/index.typings.js +15 -73
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +38 -63
- package/build/cjs/meta.js +10 -61
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +57 -762
- package/build/es/index.mjs +65 -79
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1014 -1
- package/build/es/index.typings.mjs +14 -71
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +38 -63
- package/build/es/meta.mjs +9 -59
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +17 -30
- package/build/internal/cjs/index.js +68 -81
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +336 -183
- package/build/internal/cjs/index.typings.js +15 -73
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +37 -63
- package/build/internal/cjs/meta.js +10 -61
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +17 -30
- package/build/internal/es/index.mjs +65 -79
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +336 -183
- package/build/internal/es/index.typings.mjs +14 -71
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +37 -63
- package/build/internal/es/meta.mjs +9 -59
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -47,17 +47,14 @@ interface Dispute {
|
|
|
47
47
|
* @readonly
|
|
48
48
|
*/
|
|
49
49
|
status?: DisputeStatusWithLiterals;
|
|
50
|
-
/** True if the merchant can do the refund with the opened dispute, false otherwise */
|
|
51
|
-
chargeRefundable?: boolean | null;
|
|
52
50
|
/**
|
|
53
51
|
* Seller protection helps protect sellers from financial loss on eligible transactions due to unauthorized payments or claims that items were not received
|
|
54
52
|
* @readonly
|
|
55
53
|
*/
|
|
56
54
|
sellerProtection?: SellerProtectionWithLiterals;
|
|
57
55
|
/**
|
|
58
|
-
*
|
|
59
|
-
* Internal
|
|
60
|
-
* External - this dispute is created on bank side
|
|
56
|
+
* Channel through which the dispute is being processed.
|
|
57
|
+
* Internal disputes are handled by the payment processor, while external disputes go through the card network or issuing bank.
|
|
61
58
|
* @readonly
|
|
62
59
|
*/
|
|
63
60
|
channel?: DisputeChannelWithLiterals;
|
|
@@ -83,15 +80,15 @@ interface Dispute {
|
|
|
83
80
|
*/
|
|
84
81
|
autoDefended?: boolean | null;
|
|
85
82
|
/**
|
|
86
|
-
* The dispute
|
|
83
|
+
* The dispute defended date
|
|
87
84
|
* @readonly
|
|
88
85
|
*/
|
|
89
|
-
|
|
86
|
+
defendedDate?: Date | null;
|
|
90
87
|
/**
|
|
91
88
|
* The dispute acceptance date
|
|
92
89
|
* @readonly
|
|
93
90
|
*/
|
|
94
|
-
|
|
91
|
+
acceptedDate?: Date | null;
|
|
95
92
|
/**
|
|
96
93
|
* The actions that can be perform with the dispute
|
|
97
94
|
* @readonly
|
|
@@ -117,7 +114,7 @@ interface Dispute {
|
|
|
117
114
|
/** Data Extensions */
|
|
118
115
|
extendedFields?: ExtendedFields;
|
|
119
116
|
/** Tags */
|
|
120
|
-
tags?:
|
|
117
|
+
tags?: Tags;
|
|
121
118
|
}
|
|
122
119
|
declare enum DisputeStage {
|
|
123
120
|
UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
|
|
@@ -221,18 +218,282 @@ interface ExtendedFields {
|
|
|
221
218
|
*/
|
|
222
219
|
namespaces?: Record<string, Record<string, any>>;
|
|
223
220
|
}
|
|
224
|
-
|
|
221
|
+
/**
|
|
222
|
+
* Common object for tags.
|
|
223
|
+
* Should be use as in this example:
|
|
224
|
+
* message Foo {
|
|
225
|
+
* option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
|
|
226
|
+
* string id = 1;
|
|
227
|
+
* ...
|
|
228
|
+
* Tags tags = 5
|
|
229
|
+
* }
|
|
230
|
+
*
|
|
231
|
+
* example of taggable entity
|
|
232
|
+
* {
|
|
233
|
+
* id: "123"
|
|
234
|
+
* tags: {
|
|
235
|
+
* public_tags: {
|
|
236
|
+
* tag_ids:["11","22"]
|
|
237
|
+
* },
|
|
238
|
+
* private_tags: {
|
|
239
|
+
* tag_ids: ["33", "44"]
|
|
240
|
+
* }
|
|
241
|
+
* }
|
|
242
|
+
* }
|
|
243
|
+
*/
|
|
244
|
+
interface Tags {
|
|
245
|
+
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
246
|
+
privateTags?: TagList;
|
|
225
247
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
226
|
-
|
|
248
|
+
publicTags?: TagList;
|
|
227
249
|
}
|
|
228
250
|
interface TagList {
|
|
229
251
|
/**
|
|
230
|
-
* List of tag IDs
|
|
252
|
+
* List of tag IDs.
|
|
231
253
|
* @maxSize 100
|
|
232
254
|
* @maxLength 5
|
|
233
255
|
*/
|
|
234
256
|
tagIds?: string[];
|
|
235
257
|
}
|
|
258
|
+
interface TagsModified {
|
|
259
|
+
/** Updated Dispute. */
|
|
260
|
+
dispute?: Dispute;
|
|
261
|
+
/** Tags that were assigned to the Dispute. */
|
|
262
|
+
assignedTags?: Tags;
|
|
263
|
+
/** Tags that were unassigned from the Dispute. */
|
|
264
|
+
unassignedTags?: Tags;
|
|
265
|
+
}
|
|
266
|
+
interface InternalCreateDisputeManuallyRequest {
|
|
267
|
+
/**
|
|
268
|
+
* Dispute Id
|
|
269
|
+
* @format GUID
|
|
270
|
+
*/
|
|
271
|
+
disputeId?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Charge Id
|
|
274
|
+
* @format GUID
|
|
275
|
+
*/
|
|
276
|
+
chargeId?: string;
|
|
277
|
+
/** Open date */
|
|
278
|
+
openDate?: Date | null;
|
|
279
|
+
/**
|
|
280
|
+
* Provider Dispute Id
|
|
281
|
+
* @minLength 1
|
|
282
|
+
* @maxLength 100
|
|
283
|
+
*/
|
|
284
|
+
providerDisputeId?: string;
|
|
285
|
+
/** Dispute stage */
|
|
286
|
+
stage?: DisputeStageWithLiterals;
|
|
287
|
+
/** Dispute reason */
|
|
288
|
+
reason?: DisputeReasonWithLiterals;
|
|
289
|
+
/** Dispute status based on provider dispute status */
|
|
290
|
+
status?: DisputeStatusWithLiterals;
|
|
291
|
+
/** The latest date and time until which the dispute can remain in its current status */
|
|
292
|
+
dueDate?: Date | null;
|
|
293
|
+
/**
|
|
294
|
+
* Dispute currency. Should be the same as the charge currency.
|
|
295
|
+
* @immutable
|
|
296
|
+
* @format CURRENCY
|
|
297
|
+
*/
|
|
298
|
+
currencyCode?: string | null;
|
|
299
|
+
/**
|
|
300
|
+
* Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
|
|
301
|
+
* @immutable
|
|
302
|
+
* @decimalValue options { gt:0, maxScale:8 }
|
|
303
|
+
*/
|
|
304
|
+
amount?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* Network reason code
|
|
307
|
+
* @minLength 1
|
|
308
|
+
* @maxLength 64
|
|
309
|
+
*/
|
|
310
|
+
networkReasonCode?: string | null;
|
|
311
|
+
/** External or Internal */
|
|
312
|
+
external?: boolean | null;
|
|
313
|
+
/**
|
|
314
|
+
* Seller protection
|
|
315
|
+
* @minLength 1
|
|
316
|
+
* @maxLength 64
|
|
317
|
+
*/
|
|
318
|
+
sellerProtection?: string | null;
|
|
319
|
+
/** Is charge refundable */
|
|
320
|
+
chargeRefundable?: boolean | null;
|
|
321
|
+
/** True if dispute is defendable */
|
|
322
|
+
defendable?: boolean | null;
|
|
323
|
+
/** True if it is an auto dispute */
|
|
324
|
+
autoDefended?: boolean | null;
|
|
325
|
+
}
|
|
326
|
+
interface InternalCreateDisputeManuallyResponse {
|
|
327
|
+
}
|
|
328
|
+
interface InternalChangeDisputeStatusManuallyRequest {
|
|
329
|
+
/**
|
|
330
|
+
* Dispute ID
|
|
331
|
+
* @format GUID
|
|
332
|
+
*/
|
|
333
|
+
disputeId?: string;
|
|
334
|
+
/** Changed date */
|
|
335
|
+
changedDate?: Date | null;
|
|
336
|
+
/** Dispute status based on provider dispute status */
|
|
337
|
+
status?: DisputeStatusWithLiterals;
|
|
338
|
+
}
|
|
339
|
+
interface InternalChangeDisputeStatusManuallyResponse {
|
|
340
|
+
}
|
|
341
|
+
interface AcceptDisputeManuallyRequest {
|
|
342
|
+
/**
|
|
343
|
+
* Dispute ID
|
|
344
|
+
* @format GUID
|
|
345
|
+
*/
|
|
346
|
+
disputeId?: string;
|
|
347
|
+
/** Accepted date */
|
|
348
|
+
acceptedDate?: Date | null;
|
|
349
|
+
}
|
|
350
|
+
interface AcceptDisputeManuallyResponse {
|
|
351
|
+
}
|
|
352
|
+
interface DefendDisputeManuallyRequest {
|
|
353
|
+
/**
|
|
354
|
+
* Dispute ID
|
|
355
|
+
* @format GUID
|
|
356
|
+
*/
|
|
357
|
+
disputeId?: string;
|
|
358
|
+
/** Defense date */
|
|
359
|
+
defendedDate?: Date | null;
|
|
360
|
+
}
|
|
361
|
+
interface DefendDisputeManuallyResponse {
|
|
362
|
+
}
|
|
363
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
364
|
+
createdEvent?: EntityCreatedEvent;
|
|
365
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
366
|
+
deletedEvent?: EntityDeletedEvent;
|
|
367
|
+
actionEvent?: ActionEvent;
|
|
368
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
369
|
+
_id?: string;
|
|
370
|
+
/**
|
|
371
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
372
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
373
|
+
*/
|
|
374
|
+
entityFqdn?: string;
|
|
375
|
+
/**
|
|
376
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
377
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
378
|
+
*/
|
|
379
|
+
slug?: string;
|
|
380
|
+
/** ID of the entity associated with the event. */
|
|
381
|
+
entityId?: string;
|
|
382
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
383
|
+
eventTime?: Date | null;
|
|
384
|
+
/**
|
|
385
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
386
|
+
* (for example, GDPR).
|
|
387
|
+
*/
|
|
388
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
389
|
+
/** If present, indicates the action that triggered the event. */
|
|
390
|
+
originatedFrom?: string | null;
|
|
391
|
+
/**
|
|
392
|
+
* 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.
|
|
393
|
+
* 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.
|
|
394
|
+
*/
|
|
395
|
+
entityEventSequence?: string | null;
|
|
396
|
+
}
|
|
397
|
+
/** @oneof */
|
|
398
|
+
interface DomainEventBodyOneOf {
|
|
399
|
+
createdEvent?: EntityCreatedEvent;
|
|
400
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
401
|
+
deletedEvent?: EntityDeletedEvent;
|
|
402
|
+
actionEvent?: ActionEvent;
|
|
403
|
+
}
|
|
404
|
+
interface EntityCreatedEvent {
|
|
405
|
+
entity?: string;
|
|
406
|
+
}
|
|
407
|
+
interface RestoreInfo {
|
|
408
|
+
deletedDate?: Date | null;
|
|
409
|
+
}
|
|
410
|
+
interface EntityUpdatedEvent {
|
|
411
|
+
/**
|
|
412
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
413
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
414
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
415
|
+
*/
|
|
416
|
+
currentEntity?: string;
|
|
417
|
+
}
|
|
418
|
+
interface EntityDeletedEvent {
|
|
419
|
+
/** Entity that was deleted. */
|
|
420
|
+
deletedEntity?: string | null;
|
|
421
|
+
}
|
|
422
|
+
interface ActionEvent {
|
|
423
|
+
body?: string;
|
|
424
|
+
}
|
|
425
|
+
interface MessageEnvelope {
|
|
426
|
+
/**
|
|
427
|
+
* App instance ID.
|
|
428
|
+
* @format GUID
|
|
429
|
+
*/
|
|
430
|
+
instanceId?: string | null;
|
|
431
|
+
/**
|
|
432
|
+
* Event type.
|
|
433
|
+
* @maxLength 150
|
|
434
|
+
*/
|
|
435
|
+
eventType?: string;
|
|
436
|
+
/** The identification type and identity data. */
|
|
437
|
+
identity?: IdentificationData;
|
|
438
|
+
/** Stringify payload. */
|
|
439
|
+
data?: string;
|
|
440
|
+
}
|
|
441
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
442
|
+
/**
|
|
443
|
+
* ID of a site visitor that has not logged in to the site.
|
|
444
|
+
* @format GUID
|
|
445
|
+
*/
|
|
446
|
+
anonymousVisitorId?: string;
|
|
447
|
+
/**
|
|
448
|
+
* ID of a site visitor that has logged in to the site.
|
|
449
|
+
* @format GUID
|
|
450
|
+
*/
|
|
451
|
+
memberId?: string;
|
|
452
|
+
/**
|
|
453
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
454
|
+
* @format GUID
|
|
455
|
+
*/
|
|
456
|
+
wixUserId?: string;
|
|
457
|
+
/**
|
|
458
|
+
* ID of an app.
|
|
459
|
+
* @format GUID
|
|
460
|
+
*/
|
|
461
|
+
appId?: string;
|
|
462
|
+
/** @readonly */
|
|
463
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
464
|
+
}
|
|
465
|
+
/** @oneof */
|
|
466
|
+
interface IdentificationDataIdOneOf {
|
|
467
|
+
/**
|
|
468
|
+
* ID of a site visitor that has not logged in to the site.
|
|
469
|
+
* @format GUID
|
|
470
|
+
*/
|
|
471
|
+
anonymousVisitorId?: string;
|
|
472
|
+
/**
|
|
473
|
+
* ID of a site visitor that has logged in to the site.
|
|
474
|
+
* @format GUID
|
|
475
|
+
*/
|
|
476
|
+
memberId?: string;
|
|
477
|
+
/**
|
|
478
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
479
|
+
* @format GUID
|
|
480
|
+
*/
|
|
481
|
+
wixUserId?: string;
|
|
482
|
+
/**
|
|
483
|
+
* ID of an app.
|
|
484
|
+
* @format GUID
|
|
485
|
+
*/
|
|
486
|
+
appId?: string;
|
|
487
|
+
}
|
|
488
|
+
declare enum WebhookIdentityType {
|
|
489
|
+
UNKNOWN = "UNKNOWN",
|
|
490
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
491
|
+
MEMBER = "MEMBER",
|
|
492
|
+
WIX_USER = "WIX_USER",
|
|
493
|
+
APP = "APP"
|
|
494
|
+
}
|
|
495
|
+
/** @enumType */
|
|
496
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
236
497
|
interface GetDisputeRequest {
|
|
237
498
|
/**
|
|
238
499
|
* ID of the Dispute to retrieve.
|
|
@@ -360,7 +621,7 @@ interface SubmitDisputeEvidenceRequest {
|
|
|
360
621
|
* Dispute ID
|
|
361
622
|
* @format GUID
|
|
362
623
|
*/
|
|
363
|
-
disputeId
|
|
624
|
+
disputeId?: string;
|
|
364
625
|
}
|
|
365
626
|
interface SubmitDisputeEvidenceResponse {
|
|
366
627
|
/** Dispute */
|
|
@@ -454,40 +715,6 @@ interface BulkUpdateDisputeTagsRequest {
|
|
|
454
715
|
/** List of Tags to unAssign */
|
|
455
716
|
unassignTags?: Tags;
|
|
456
717
|
}
|
|
457
|
-
/**
|
|
458
|
-
* Common object for tags.
|
|
459
|
-
* Should be use as in this example:
|
|
460
|
-
* message Foo {
|
|
461
|
-
* string id = 1;
|
|
462
|
-
* ...
|
|
463
|
-
* Tags tags = 5
|
|
464
|
-
* }
|
|
465
|
-
*
|
|
466
|
-
* example of taggable entity
|
|
467
|
-
* {
|
|
468
|
-
* id: "123"
|
|
469
|
-
* tags: {
|
|
470
|
-
* tags: {
|
|
471
|
-
* tag_ids:["11","22"]
|
|
472
|
-
* },
|
|
473
|
-
* private_tags: {
|
|
474
|
-
* tag_ids: ["33", "44"]
|
|
475
|
-
* }
|
|
476
|
-
* }
|
|
477
|
-
* }
|
|
478
|
-
*/
|
|
479
|
-
interface Tags {
|
|
480
|
-
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
481
|
-
tags?: TagsTagList;
|
|
482
|
-
}
|
|
483
|
-
interface TagsTagList {
|
|
484
|
-
/**
|
|
485
|
-
* List of tag IDs
|
|
486
|
-
* @maxSize 100
|
|
487
|
-
* @maxLength 5
|
|
488
|
-
*/
|
|
489
|
-
tagIds?: string[];
|
|
490
|
-
}
|
|
491
718
|
interface BulkUpdateDisputeTagsResponse {
|
|
492
719
|
/**
|
|
493
720
|
* Results
|
|
@@ -541,16 +768,38 @@ interface BulkUpdateDisputeTagsByFilterRequest {
|
|
|
541
768
|
}
|
|
542
769
|
interface BulkUpdateDisputeTagsByFilterResponse {
|
|
543
770
|
/**
|
|
544
|
-
*
|
|
771
|
+
* Pass this ID to Get Async Job
|
|
545
772
|
* @format GUID
|
|
546
773
|
*/
|
|
547
774
|
jobId?: string;
|
|
548
775
|
}
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
776
|
+
/** @docsIgnore */
|
|
777
|
+
type BulkUpdateDisputeTagsApplicationErrors = {
|
|
778
|
+
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
779
|
+
description?: string;
|
|
780
|
+
data?: Record<string, any>;
|
|
781
|
+
};
|
|
782
|
+
/** @docsIgnore */
|
|
783
|
+
type BulkUpdateDisputeTagsByFilterApplicationErrors = {
|
|
784
|
+
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
785
|
+
description?: string;
|
|
786
|
+
data?: Record<string, any>;
|
|
787
|
+
};
|
|
788
|
+
interface BaseEventMetadata {
|
|
789
|
+
/**
|
|
790
|
+
* App instance ID.
|
|
791
|
+
* @format GUID
|
|
792
|
+
*/
|
|
793
|
+
instanceId?: string | null;
|
|
794
|
+
/**
|
|
795
|
+
* Event type.
|
|
796
|
+
* @maxLength 150
|
|
797
|
+
*/
|
|
798
|
+
eventType?: string;
|
|
799
|
+
/** The identification type and identity data. */
|
|
800
|
+
identity?: IdentificationData;
|
|
801
|
+
}
|
|
802
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
554
803
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
555
804
|
_id?: string;
|
|
556
805
|
/**
|
|
@@ -580,132 +829,46 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
580
829
|
*/
|
|
581
830
|
entityEventSequence?: string | null;
|
|
582
831
|
}
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
587
|
-
deletedEvent?: EntityDeletedEvent;
|
|
588
|
-
actionEvent?: ActionEvent;
|
|
832
|
+
interface DisputeCreatedEnvelope {
|
|
833
|
+
entity: Dispute;
|
|
834
|
+
metadata: EventMetadata;
|
|
589
835
|
}
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
currentEntity?: string;
|
|
603
|
-
}
|
|
604
|
-
interface EntityDeletedEvent {
|
|
605
|
-
/** Entity that was deleted. */
|
|
606
|
-
deletedEntity?: string | null;
|
|
607
|
-
}
|
|
608
|
-
interface ActionEvent {
|
|
609
|
-
body?: string;
|
|
610
|
-
}
|
|
611
|
-
interface MessageEnvelope {
|
|
612
|
-
/**
|
|
613
|
-
* App instance ID.
|
|
614
|
-
* @format GUID
|
|
615
|
-
*/
|
|
616
|
-
instanceId?: string | null;
|
|
617
|
-
/**
|
|
618
|
-
* Event type.
|
|
619
|
-
* @maxLength 150
|
|
620
|
-
*/
|
|
621
|
-
eventType?: string;
|
|
622
|
-
/** The identification type and identity data. */
|
|
623
|
-
identity?: IdentificationData;
|
|
624
|
-
/** Stringify payload. */
|
|
625
|
-
data?: string;
|
|
626
|
-
}
|
|
627
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
628
|
-
/**
|
|
629
|
-
* ID of a site visitor that has not logged in to the site.
|
|
630
|
-
* @format GUID
|
|
631
|
-
*/
|
|
632
|
-
anonymousVisitorId?: string;
|
|
633
|
-
/**
|
|
634
|
-
* ID of a site visitor that has logged in to the site.
|
|
635
|
-
* @format GUID
|
|
636
|
-
*/
|
|
637
|
-
memberId?: string;
|
|
638
|
-
/**
|
|
639
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
640
|
-
* @format GUID
|
|
641
|
-
*/
|
|
642
|
-
wixUserId?: string;
|
|
643
|
-
/**
|
|
644
|
-
* ID of an app.
|
|
645
|
-
* @format GUID
|
|
646
|
-
*/
|
|
647
|
-
appId?: string;
|
|
648
|
-
/** @readonly */
|
|
649
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
650
|
-
}
|
|
651
|
-
/** @oneof */
|
|
652
|
-
interface IdentificationDataIdOneOf {
|
|
653
|
-
/**
|
|
654
|
-
* ID of a site visitor that has not logged in to the site.
|
|
655
|
-
* @format GUID
|
|
656
|
-
*/
|
|
657
|
-
anonymousVisitorId?: string;
|
|
658
|
-
/**
|
|
659
|
-
* ID of a site visitor that has logged in to the site.
|
|
660
|
-
* @format GUID
|
|
661
|
-
*/
|
|
662
|
-
memberId?: string;
|
|
663
|
-
/**
|
|
664
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
665
|
-
* @format GUID
|
|
666
|
-
*/
|
|
667
|
-
wixUserId?: string;
|
|
668
|
-
/**
|
|
669
|
-
* ID of an app.
|
|
670
|
-
* @format GUID
|
|
671
|
-
*/
|
|
672
|
-
appId?: string;
|
|
673
|
-
}
|
|
674
|
-
declare enum WebhookIdentityType {
|
|
675
|
-
UNKNOWN = "UNKNOWN",
|
|
676
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
677
|
-
MEMBER = "MEMBER",
|
|
678
|
-
WIX_USER = "WIX_USER",
|
|
679
|
-
APP = "APP"
|
|
836
|
+
/**
|
|
837
|
+
* Fired when a new Dispute is created.
|
|
838
|
+
* @permissionId PAYMENTS.DISPUTE_READ
|
|
839
|
+
* @webhook
|
|
840
|
+
* @eventType wix.payments.disputes.v1.dispute_created
|
|
841
|
+
* @slug created
|
|
842
|
+
* @documentationMaturity preview
|
|
843
|
+
*/
|
|
844
|
+
declare function onDisputeCreated(handler: (event: DisputeCreatedEnvelope) => void | Promise<void>): void;
|
|
845
|
+
interface DisputeUpdatedEnvelope {
|
|
846
|
+
entity: Dispute;
|
|
847
|
+
metadata: EventMetadata;
|
|
680
848
|
}
|
|
681
|
-
/**
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
type BulkUpdateDisputeTagsByFilterApplicationErrors = {
|
|
691
|
-
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
692
|
-
description?: string;
|
|
693
|
-
data?: Record<string, any>;
|
|
694
|
-
};
|
|
849
|
+
/**
|
|
850
|
+
* Fired when a Dispute is updated.
|
|
851
|
+
* @permissionId PAYMENTS.DISPUTE_READ
|
|
852
|
+
* @webhook
|
|
853
|
+
* @eventType wix.payments.disputes.v1.dispute_updated
|
|
854
|
+
* @slug updated
|
|
855
|
+
* @documentationMaturity preview
|
|
856
|
+
*/
|
|
857
|
+
declare function onDisputeUpdated(handler: (event: DisputeUpdatedEnvelope) => void | Promise<void>): void;
|
|
695
858
|
/**
|
|
696
859
|
* Get Dispute by ID
|
|
697
860
|
* @param disputeId - ID of the Dispute to retrieve.
|
|
698
|
-
* @
|
|
861
|
+
* @public
|
|
699
862
|
* @documentationMaturity preview
|
|
700
863
|
* @requiredField disputeId
|
|
701
864
|
* @permissionId PAYMENTS.DISPUTE_READ
|
|
702
865
|
* @returns The requested Dispute.
|
|
703
866
|
* @fqn wix.payments.disputes.v1.DisputeService.GetDispute
|
|
704
867
|
*/
|
|
705
|
-
declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.
|
|
868
|
+
declare function getDispute(disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.privateTags.tagIds`, 4>>;
|
|
706
869
|
/**
|
|
707
870
|
* Retrieves a list of Disputes
|
|
708
|
-
* @
|
|
871
|
+
* @public
|
|
709
872
|
* @documentationMaturity preview
|
|
710
873
|
* @permissionId PAYMENTS.DISPUTE_READ
|
|
711
874
|
* @fqn wix.payments.disputes.v1.DisputeService.QueryDisputes
|
|
@@ -791,38 +954,28 @@ interface DisputesQueryBuilder {
|
|
|
791
954
|
/**
|
|
792
955
|
* Accept Dispute
|
|
793
956
|
* @param disputeId - Dispute ID
|
|
794
|
-
* @
|
|
957
|
+
* @public
|
|
795
958
|
* @documentationMaturity preview
|
|
796
959
|
* @requiredField disputeId
|
|
797
960
|
* @permissionId PAYMENTS.DISPUTE_ACCEPT
|
|
798
961
|
* @fqn wix.payments.disputes.v1.DisputeService.AcceptDispute
|
|
799
962
|
*/
|
|
800
|
-
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.
|
|
963
|
+
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>>;
|
|
801
964
|
/**
|
|
802
965
|
* Defend Dispute
|
|
803
966
|
* @param disputeId - Dispute ID
|
|
804
|
-
* @
|
|
967
|
+
* @public
|
|
805
968
|
* @documentationMaturity preview
|
|
806
969
|
* @requiredField disputeId
|
|
807
970
|
* @permissionId PAYMENTS.DISPUTE_DEFEND
|
|
808
971
|
* @fqn wix.payments.disputes.v1.DisputeService.DefendDispute
|
|
809
972
|
*/
|
|
810
|
-
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.
|
|
811
|
-
/**
|
|
812
|
-
* Dispute Submit Evidence // TODO will be removed in next PR (after removing usage in transaction-service)
|
|
813
|
-
* @param disputeId - Dispute ID
|
|
814
|
-
* @internal
|
|
815
|
-
* @documentationMaturity preview
|
|
816
|
-
* @requiredField disputeId
|
|
817
|
-
* @permissionId PAYMENTS.DISPUTE_SUBMIT_EVIDENCE
|
|
818
|
-
* @fqn wix.payments.disputes.v1.DisputeService.SubmitDisputeEvidence
|
|
819
|
-
*/
|
|
820
|
-
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.tags.tagIds`, 5>>;
|
|
973
|
+
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>>;
|
|
821
974
|
/**
|
|
822
975
|
* Synchronously update tags on multiple Disputes, by list of Disputes ids
|
|
823
976
|
* A tag that appears both in the list of assign and unassign tags, will be assigned
|
|
824
977
|
* @param ids - List of NileProtoTagsEntities that their tags will update.
|
|
825
|
-
* @
|
|
978
|
+
* @public
|
|
826
979
|
* @documentationMaturity preview
|
|
827
980
|
* @requiredField ids
|
|
828
981
|
* @permissionId PAYMENTS.DISPUTE_UPDATE_TAGS
|
|
@@ -842,7 +995,7 @@ interface BulkUpdateDisputeTagsOptions {
|
|
|
842
995
|
* An empty filter will update all Disputes
|
|
843
996
|
* A tag that appears both in the list of assign and unassign tags, will be assigned
|
|
844
997
|
* @param filter - Filter
|
|
845
|
-
* @
|
|
998
|
+
* @public
|
|
846
999
|
* @documentationMaturity preview
|
|
847
1000
|
* @requiredField filter
|
|
848
1001
|
* @permissionId PAYMENTS.DISPUTE_UPDATE_TAGS
|
|
@@ -858,4 +1011,4 @@ interface BulkUpdateDisputeTagsByFilterOptions {
|
|
|
858
1011
|
unassignTags?: Tags;
|
|
859
1012
|
}
|
|
860
1013
|
|
|
861
|
-
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 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
|
|
1014
|
+
export { type AcceptDisputeManuallyRequest, type AcceptDisputeManuallyResponse, type AcceptDisputeRequest, type AcceptDisputeResponse, type ActionEvent, type ApplicationError, type BaseEventMetadata, 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, type DisputeCreatedEnvelope, DisputeReason, type DisputeReasonWithLiterals, DisputeStage, type DisputeStageWithLiterals, DisputeStatus, type DisputeStatusWithLiterals, type DisputeUpdatedEnvelope, type DisputesQueryBuilder, type DisputesQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, 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, onDisputeCreated, onDisputeUpdated, queryDisputes };
|