@wix/auto_sdk_payments_dispute-evidence-documents 1.0.28 → 1.0.30
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 +61 -653
- package/build/cjs/index.js +73 -252
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +810 -1
- package/build/cjs/index.typings.js +0 -215
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +17 -77
- package/build/cjs/meta.js +0 -192
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +61 -653
- package/build/es/index.mjs +70 -248
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +810 -1
- package/build/es/index.typings.mjs +0 -211
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +17 -77
- package/build/es/meta.mjs +0 -188
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +18 -73
- package/build/internal/cjs/index.js +73 -252
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +215 -197
- package/build/internal/cjs/index.typings.js +0 -215
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +16 -77
- package/build/internal/cjs/meta.js +0 -192
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +18 -73
- package/build/internal/es/index.mjs +70 -248
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +215 -197
- package/build/internal/es/index.typings.mjs +0 -211
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +16 -77
- package/build/internal/es/meta.mjs +0 -188
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -8,9 +8,10 @@ interface DisputeEvidenceDocument {
|
|
|
8
8
|
* @readonly
|
|
9
9
|
* @immutable
|
|
10
10
|
*/
|
|
11
|
-
_id?: string
|
|
11
|
+
_id?: string;
|
|
12
12
|
/**
|
|
13
|
-
* Revision number
|
|
13
|
+
* Revision number, which increments by 1 each time the dispute evidence document is updated.
|
|
14
|
+
* To prevent conflicting changes, the existing revision must be specified when updating a dispute evidence document.
|
|
14
15
|
* @readonly
|
|
15
16
|
*/
|
|
16
17
|
revision?: string | null;
|
|
@@ -37,11 +38,9 @@ interface DisputeEvidenceDocument {
|
|
|
37
38
|
*/
|
|
38
39
|
file?: DocumentFile;
|
|
39
40
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
41
|
+
* Custom field data for the dispute evidence document.
|
|
42
|
+
* Extended fields must be configured in the app dashboard before they can be accessed with API calls.
|
|
42
43
|
*/
|
|
43
|
-
submittedDate?: Date | null;
|
|
44
|
-
/** Data Extensions */
|
|
45
44
|
extendedFields?: ExtendedFields;
|
|
46
45
|
/** Tags */
|
|
47
46
|
tags?: Tags;
|
|
@@ -81,6 +80,7 @@ interface ExtendedFields {
|
|
|
81
80
|
* Common object for tags.
|
|
82
81
|
* Should be use as in this example:
|
|
83
82
|
* message Foo {
|
|
83
|
+
* option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
|
|
84
84
|
* string id = 1;
|
|
85
85
|
* ...
|
|
86
86
|
* Tags tags = 5
|
|
@@ -90,7 +90,7 @@ interface ExtendedFields {
|
|
|
90
90
|
* {
|
|
91
91
|
* id: "123"
|
|
92
92
|
* tags: {
|
|
93
|
-
*
|
|
93
|
+
* public_tags: {
|
|
94
94
|
* tag_ids:["11","22"]
|
|
95
95
|
* },
|
|
96
96
|
* private_tags: {
|
|
@@ -100,17 +100,27 @@ interface ExtendedFields {
|
|
|
100
100
|
* }
|
|
101
101
|
*/
|
|
102
102
|
interface Tags {
|
|
103
|
+
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
104
|
+
privateTags?: TagList;
|
|
103
105
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
104
|
-
|
|
106
|
+
publicTags?: TagList;
|
|
105
107
|
}
|
|
106
108
|
interface TagList {
|
|
107
109
|
/**
|
|
108
|
-
* List of tag IDs
|
|
110
|
+
* List of tag IDs.
|
|
109
111
|
* @maxSize 100
|
|
110
112
|
* @maxLength 5
|
|
111
113
|
*/
|
|
112
114
|
tagIds?: string[];
|
|
113
115
|
}
|
|
116
|
+
interface TagsModified {
|
|
117
|
+
/** Updated DisputeEvidenceDocument. */
|
|
118
|
+
disputeEvidenceDocument?: DisputeEvidenceDocument;
|
|
119
|
+
/** Tags that were assigned to the DisputeEvidenceDocument. */
|
|
120
|
+
assignedTags?: Tags;
|
|
121
|
+
/** Tags that were unassigned from the DisputeEvidenceDocument. */
|
|
122
|
+
unassignedTags?: Tags;
|
|
123
|
+
}
|
|
114
124
|
interface CreateDisputeEvidenceDocumentRequest {
|
|
115
125
|
/** DisputeEvidenceDocument to be created. */
|
|
116
126
|
disputeEvidenceDocument: DisputeEvidenceDocument;
|
|
@@ -118,37 +128,11 @@ interface CreateDisputeEvidenceDocumentRequest {
|
|
|
118
128
|
interface CreateDisputeEvidenceDocumentResponse {
|
|
119
129
|
/** The created DisputeEvidenceDocument. */
|
|
120
130
|
disputeEvidenceDocument?: DisputeEvidenceDocument;
|
|
121
|
-
}
|
|
122
|
-
interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
|
|
123
131
|
/**
|
|
124
|
-
*
|
|
125
|
-
* @format GUID
|
|
126
|
-
*/
|
|
127
|
-
disputeEvidenceDocumentId: string;
|
|
128
|
-
/**
|
|
129
|
-
* Name of the uploaded file
|
|
130
|
-
* @minLength 1
|
|
131
|
-
* @maxLength 255
|
|
132
|
-
*/
|
|
133
|
-
filename?: string;
|
|
134
|
-
}
|
|
135
|
-
interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
|
|
136
|
-
/**
|
|
137
|
-
* Evidence Document upload URL
|
|
132
|
+
* Upload URL to upload file evidence
|
|
138
133
|
* @format WEB_URL
|
|
139
134
|
*/
|
|
140
|
-
uploadUrl?: string;
|
|
141
|
-
}
|
|
142
|
-
interface AttachDisputeEvidenceDocumentFileRequest {
|
|
143
|
-
/**
|
|
144
|
-
* Dispute Evidence Document ID
|
|
145
|
-
* @format GUID
|
|
146
|
-
*/
|
|
147
|
-
disputeEvidenceDocumentId: string;
|
|
148
|
-
}
|
|
149
|
-
interface AttachDisputeEvidenceDocumentFileResponse {
|
|
150
|
-
/** Dispute Evidence Document */
|
|
151
|
-
disputeEvidenceDocument?: DisputeEvidenceDocument;
|
|
135
|
+
uploadUrl?: string | null;
|
|
152
136
|
}
|
|
153
137
|
interface GetDisputeEvidenceDocumentRequest {
|
|
154
138
|
/**
|
|
@@ -161,31 +145,6 @@ interface GetDisputeEvidenceDocumentResponse {
|
|
|
161
145
|
/** The requested DisputeEvidenceDocument. */
|
|
162
146
|
disputeEvidenceDocument?: DisputeEvidenceDocument;
|
|
163
147
|
}
|
|
164
|
-
interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
|
|
165
|
-
/**
|
|
166
|
-
* ID of the DisputeEvidenceDocument to generate Download Url.
|
|
167
|
-
* @format GUID
|
|
168
|
-
*/
|
|
169
|
-
disputeEvidenceDocumentId: string;
|
|
170
|
-
}
|
|
171
|
-
interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
|
|
172
|
-
/**
|
|
173
|
-
* Document source URL.
|
|
174
|
-
* @format WEB_URL
|
|
175
|
-
*/
|
|
176
|
-
url?: string | null;
|
|
177
|
-
/** Document source URL expiration date (when relevant). */
|
|
178
|
-
urlExpirationDate?: Date | null;
|
|
179
|
-
}
|
|
180
|
-
interface MarkDisputeEvidenceDocumentSubmittedRequest {
|
|
181
|
-
/**
|
|
182
|
-
* Id of the DisputeEvidenceDocument to mark as submitted.
|
|
183
|
-
* @format GUID
|
|
184
|
-
*/
|
|
185
|
-
disputeEvidenceDocumentId: string;
|
|
186
|
-
}
|
|
187
|
-
interface MarkDisputeEvidenceDocumentSubmittedResponse {
|
|
188
|
-
}
|
|
189
148
|
interface DeleteDisputeEvidenceDocumentRequest {
|
|
190
149
|
/**
|
|
191
150
|
* Id of the DisputeEvidenceDocument to delete.
|
|
@@ -284,50 +243,6 @@ interface Cursors {
|
|
|
284
243
|
*/
|
|
285
244
|
prev?: string | null;
|
|
286
245
|
}
|
|
287
|
-
interface MigrateDisputeEvidenceDocumentRequest {
|
|
288
|
-
/**
|
|
289
|
-
* Dispute Id
|
|
290
|
-
* @format GUID
|
|
291
|
-
*/
|
|
292
|
-
disputeId?: string;
|
|
293
|
-
/**
|
|
294
|
-
* Evidence Id
|
|
295
|
-
* @format GUID
|
|
296
|
-
*/
|
|
297
|
-
evidenceId?: string;
|
|
298
|
-
/**
|
|
299
|
-
* External evidence document Id
|
|
300
|
-
* @minLength 1
|
|
301
|
-
* @maxLength 64
|
|
302
|
-
*/
|
|
303
|
-
evidenceDocumentId?: string;
|
|
304
|
-
/**
|
|
305
|
-
* File hash
|
|
306
|
-
* @minLength 32
|
|
307
|
-
* @maxLength 32
|
|
308
|
-
*/
|
|
309
|
-
hash?: string | null;
|
|
310
|
-
/** Created date */
|
|
311
|
-
_createdDate?: Date | null;
|
|
312
|
-
}
|
|
313
|
-
interface MigrateDisputeEvidenceDocumentResponse {
|
|
314
|
-
}
|
|
315
|
-
interface SubmitMigratedDisputeEvidenceDocumentRequest {
|
|
316
|
-
/**
|
|
317
|
-
* Dispute Id
|
|
318
|
-
* @format GUID
|
|
319
|
-
*/
|
|
320
|
-
disputeId?: string;
|
|
321
|
-
/**
|
|
322
|
-
* Evidence Id
|
|
323
|
-
* @format GUID
|
|
324
|
-
*/
|
|
325
|
-
evidenceId?: string;
|
|
326
|
-
/** Submitted date */
|
|
327
|
-
submittedDate?: Date | null;
|
|
328
|
-
}
|
|
329
|
-
interface SubmitMigratedDisputeEvidenceDocumentResponse {
|
|
330
|
-
}
|
|
331
246
|
interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
|
|
332
247
|
/**
|
|
333
248
|
* List of NileProtoTagsEntities that their tags will update.
|
|
@@ -394,11 +309,115 @@ interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
|
|
|
394
309
|
}
|
|
395
310
|
interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
|
|
396
311
|
/**
|
|
397
|
-
*
|
|
312
|
+
* Pass this ID to Get Async Job
|
|
398
313
|
* @format GUID
|
|
399
314
|
*/
|
|
400
315
|
jobId?: string;
|
|
401
316
|
}
|
|
317
|
+
interface MigrateDisputeEvidenceDocumentRequest {
|
|
318
|
+
/**
|
|
319
|
+
* Dispute Id
|
|
320
|
+
* @format GUID
|
|
321
|
+
*/
|
|
322
|
+
disputeId?: string;
|
|
323
|
+
/**
|
|
324
|
+
* Evidence Id
|
|
325
|
+
* @format GUID
|
|
326
|
+
*/
|
|
327
|
+
evidenceId?: string;
|
|
328
|
+
/**
|
|
329
|
+
* External evidence document Id
|
|
330
|
+
* @minLength 1
|
|
331
|
+
* @maxLength 64
|
|
332
|
+
*/
|
|
333
|
+
evidenceDocumentId?: string;
|
|
334
|
+
/**
|
|
335
|
+
* File hash
|
|
336
|
+
* @minLength 32
|
|
337
|
+
* @maxLength 32
|
|
338
|
+
*/
|
|
339
|
+
hash?: string | null;
|
|
340
|
+
/** Created date */
|
|
341
|
+
_createdDate?: Date | null;
|
|
342
|
+
}
|
|
343
|
+
interface MigrateDisputeEvidenceDocumentResponse {
|
|
344
|
+
}
|
|
345
|
+
interface SubmitMigratedDisputeEvidenceDocumentRequest {
|
|
346
|
+
/**
|
|
347
|
+
* Dispute Id
|
|
348
|
+
* @format GUID
|
|
349
|
+
*/
|
|
350
|
+
disputeId?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Evidence Id
|
|
353
|
+
* @format GUID
|
|
354
|
+
*/
|
|
355
|
+
evidenceId?: string;
|
|
356
|
+
/** Submitted date */
|
|
357
|
+
submittedDate?: Date | null;
|
|
358
|
+
}
|
|
359
|
+
interface SubmitMigratedDisputeEvidenceDocumentResponse {
|
|
360
|
+
}
|
|
361
|
+
interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
|
|
362
|
+
/**
|
|
363
|
+
* Dispute Evidence Document ID
|
|
364
|
+
* @format GUID
|
|
365
|
+
*/
|
|
366
|
+
disputeEvidenceDocumentId?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Name of the uploaded file
|
|
369
|
+
* @minLength 1
|
|
370
|
+
* @maxLength 255
|
|
371
|
+
*/
|
|
372
|
+
filename?: string;
|
|
373
|
+
}
|
|
374
|
+
interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
|
|
375
|
+
/**
|
|
376
|
+
* Evidence Document upload URL
|
|
377
|
+
* @format WEB_URL
|
|
378
|
+
*/
|
|
379
|
+
uploadUrl?: string;
|
|
380
|
+
}
|
|
381
|
+
interface AttachDisputeEvidenceDocumentFileRequest {
|
|
382
|
+
/**
|
|
383
|
+
* Dispute Evidence Document ID
|
|
384
|
+
* @format GUID
|
|
385
|
+
*/
|
|
386
|
+
disputeEvidenceDocumentId?: string;
|
|
387
|
+
}
|
|
388
|
+
interface AttachDisputeEvidenceDocumentFileResponse {
|
|
389
|
+
/** Dispute Evidence Document */
|
|
390
|
+
disputeEvidenceDocument?: DisputeEvidenceDocument;
|
|
391
|
+
}
|
|
392
|
+
/** it will be removed */
|
|
393
|
+
interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
|
|
394
|
+
/**
|
|
395
|
+
* ID of the DisputeEvidenceDocument to generate Download Url.
|
|
396
|
+
* @format GUID
|
|
397
|
+
*/
|
|
398
|
+
disputeEvidenceDocumentId?: string;
|
|
399
|
+
}
|
|
400
|
+
/** it will be removed */
|
|
401
|
+
interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
|
|
402
|
+
/**
|
|
403
|
+
* Document source URL.
|
|
404
|
+
* @format WEB_URL
|
|
405
|
+
*/
|
|
406
|
+
url?: string | null;
|
|
407
|
+
/** Document source URL expiration date (when relevant). */
|
|
408
|
+
urlExpirationDate?: Date | null;
|
|
409
|
+
}
|
|
410
|
+
/** it will be removed */
|
|
411
|
+
interface MarkDisputeEvidenceDocumentSubmittedRequest {
|
|
412
|
+
/**
|
|
413
|
+
* Id of the DisputeEvidenceDocument to mark as submitted.
|
|
414
|
+
* @format GUID
|
|
415
|
+
*/
|
|
416
|
+
disputeEvidenceDocumentId?: string;
|
|
417
|
+
}
|
|
418
|
+
/** it will be removed */
|
|
419
|
+
interface MarkDisputeEvidenceDocumentSubmittedResponse {
|
|
420
|
+
}
|
|
402
421
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
403
422
|
createdEvent?: EntityCreatedEvent;
|
|
404
423
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -534,28 +553,6 @@ declare enum WebhookIdentityType {
|
|
|
534
553
|
/** @enumType */
|
|
535
554
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
536
555
|
/** @docsIgnore */
|
|
537
|
-
type GenerateDisputeEvidenceDocumentUploadUrlApplicationErrors = {
|
|
538
|
-
code?: 'DISPUTE_EVIDENCE_DOCUMENT_FILE_ALREADY_ATTACHED';
|
|
539
|
-
description?: string;
|
|
540
|
-
data?: Record<string, any>;
|
|
541
|
-
};
|
|
542
|
-
/** @docsIgnore */
|
|
543
|
-
type AttachDisputeEvidenceDocumentFileApplicationErrors = {
|
|
544
|
-
code?: 'DISPUTE_EVIDENCE_DOCUMENT_FILE_ALREADY_ATTACHED';
|
|
545
|
-
description?: string;
|
|
546
|
-
data?: Record<string, any>;
|
|
547
|
-
} | {
|
|
548
|
-
code?: 'FILE_NOT_FOUND';
|
|
549
|
-
description?: string;
|
|
550
|
-
data?: Record<string, any>;
|
|
551
|
-
};
|
|
552
|
-
/** @docsIgnore */
|
|
553
|
-
type GenerateDisputeEvidenceDocumentDownloadUrlApplicationErrors = {
|
|
554
|
-
code?: 'FILE_NOT_FOUND';
|
|
555
|
-
description?: string;
|
|
556
|
-
data?: Record<string, any>;
|
|
557
|
-
};
|
|
558
|
-
/** @docsIgnore */
|
|
559
556
|
type DeleteDisputeEvidenceDocumentApplicationErrors = {
|
|
560
557
|
code?: 'DISPUTE_EVIDENCE_DOCUMENT_ALREADY_SUBMITTED';
|
|
561
558
|
description?: string;
|
|
@@ -573,10 +570,87 @@ type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors = {
|
|
|
573
570
|
description?: string;
|
|
574
571
|
data?: Record<string, any>;
|
|
575
572
|
};
|
|
573
|
+
interface BaseEventMetadata {
|
|
574
|
+
/**
|
|
575
|
+
* App instance ID.
|
|
576
|
+
* @format GUID
|
|
577
|
+
*/
|
|
578
|
+
instanceId?: string | null;
|
|
579
|
+
/**
|
|
580
|
+
* Event type.
|
|
581
|
+
* @maxLength 150
|
|
582
|
+
*/
|
|
583
|
+
eventType?: string;
|
|
584
|
+
/** The identification type and identity data. */
|
|
585
|
+
identity?: IdentificationData;
|
|
586
|
+
}
|
|
587
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
588
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
589
|
+
_id?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
592
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
593
|
+
*/
|
|
594
|
+
entityFqdn?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
597
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
598
|
+
*/
|
|
599
|
+
slug?: string;
|
|
600
|
+
/** ID of the entity associated with the event. */
|
|
601
|
+
entityId?: string;
|
|
602
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
603
|
+
eventTime?: Date | null;
|
|
604
|
+
/**
|
|
605
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
606
|
+
* (for example, GDPR).
|
|
607
|
+
*/
|
|
608
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
609
|
+
/** If present, indicates the action that triggered the event. */
|
|
610
|
+
originatedFrom?: string | null;
|
|
611
|
+
/**
|
|
612
|
+
* 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.
|
|
613
|
+
* 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.
|
|
614
|
+
*/
|
|
615
|
+
entityEventSequence?: string | null;
|
|
616
|
+
}
|
|
617
|
+
interface DisputeEvidenceDocumentCreatedEnvelope {
|
|
618
|
+
entity: DisputeEvidenceDocument;
|
|
619
|
+
metadata: EventMetadata;
|
|
620
|
+
}
|
|
621
|
+
/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
|
|
622
|
+
* @webhook
|
|
623
|
+
* @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_created
|
|
624
|
+
* @slug created
|
|
625
|
+
* @documentationMaturity preview
|
|
626
|
+
*/
|
|
627
|
+
declare function onDisputeEvidenceDocumentCreated(handler: (event: DisputeEvidenceDocumentCreatedEnvelope) => void | Promise<void>): void;
|
|
628
|
+
interface DisputeEvidenceDocumentDeletedEnvelope {
|
|
629
|
+
entity: DisputeEvidenceDocument;
|
|
630
|
+
metadata: EventMetadata;
|
|
631
|
+
}
|
|
632
|
+
/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
|
|
633
|
+
* @webhook
|
|
634
|
+
* @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_deleted
|
|
635
|
+
* @slug deleted
|
|
636
|
+
* @documentationMaturity preview
|
|
637
|
+
*/
|
|
638
|
+
declare function onDisputeEvidenceDocumentDeleted(handler: (event: DisputeEvidenceDocumentDeletedEnvelope) => void | Promise<void>): void;
|
|
639
|
+
interface DisputeEvidenceDocumentUpdatedEnvelope {
|
|
640
|
+
entity: DisputeEvidenceDocument;
|
|
641
|
+
metadata: EventMetadata;
|
|
642
|
+
}
|
|
643
|
+
/** @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
|
|
644
|
+
* @webhook
|
|
645
|
+
* @eventType wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_updated
|
|
646
|
+
* @slug updated
|
|
647
|
+
* @documentationMaturity preview
|
|
648
|
+
*/
|
|
649
|
+
declare function onDisputeEvidenceDocumentUpdated(handler: (event: DisputeEvidenceDocumentUpdatedEnvelope) => void | Promise<void>): void;
|
|
576
650
|
/**
|
|
577
651
|
* Creates a DisputeEvidenceDocument.
|
|
578
652
|
* @param disputeEvidenceDocument - DisputeEvidenceDocument to be created.
|
|
579
|
-
* @
|
|
653
|
+
* @public
|
|
580
654
|
* @documentationMaturity preview
|
|
581
655
|
* @requiredField disputeEvidenceDocument
|
|
582
656
|
* @requiredField disputeEvidenceDocument.disputeId
|
|
@@ -584,78 +658,22 @@ type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors = {
|
|
|
584
658
|
* @returns The created DisputeEvidenceDocument.
|
|
585
659
|
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.CreateDisputeEvidenceDocument
|
|
586
660
|
*/
|
|
587
|
-
declare function createDisputeEvidenceDocument(disputeEvidenceDocument: NonNullablePaths<DisputeEvidenceDocument, `disputeId`, 2>): Promise<NonNullablePaths<DisputeEvidenceDocument, `disputeId` | `tags.
|
|
588
|
-
/**
|
|
589
|
-
* Generate upload URL to upload the file and associate it with specific evidence using file id.
|
|
590
|
-
* Note: after uploading file you need to use synchronous call to trigger system directly check uploads [AttachDisputeEvidenceDocumentFile]
|
|
591
|
-
* @param disputeEvidenceDocumentId - Dispute Evidence Document ID
|
|
592
|
-
* @internal
|
|
593
|
-
* @documentationMaturity preview
|
|
594
|
-
* @requiredField disputeEvidenceDocumentId
|
|
595
|
-
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_GENERATE_UPLOAD_URL
|
|
596
|
-
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GenerateDisputeEvidenceDocumentUploadUrl
|
|
597
|
-
*/
|
|
598
|
-
declare function generateDisputeEvidenceDocumentUploadUrl(disputeEvidenceDocumentId: string, options?: GenerateDisputeEvidenceDocumentUploadUrlOptions): Promise<NonNullablePaths<GenerateDisputeEvidenceDocumentUploadUrlResponse, `uploadUrl`, 2> & {
|
|
599
|
-
__applicationErrorsType?: GenerateDisputeEvidenceDocumentUploadUrlApplicationErrors;
|
|
600
|
-
}>;
|
|
601
|
-
interface GenerateDisputeEvidenceDocumentUploadUrlOptions {
|
|
602
|
-
/**
|
|
603
|
-
* Name of the uploaded file
|
|
604
|
-
* @minLength 1
|
|
605
|
-
* @maxLength 255
|
|
606
|
-
*/
|
|
607
|
-
filename?: string;
|
|
608
|
-
}
|
|
609
|
-
/**
|
|
610
|
-
* Synchronously attaches uploaded document to the corresponding evidence document.
|
|
611
|
-
* Note: this call doesn't allow to upload document. To upload document use [GenerateDisputeEvidenceDocumentUploadUrl]
|
|
612
|
-
* @param disputeEvidenceDocumentId - Dispute Evidence Document ID
|
|
613
|
-
* @internal
|
|
614
|
-
* @documentationMaturity preview
|
|
615
|
-
* @requiredField disputeEvidenceDocumentId
|
|
616
|
-
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_ATTACH_FILE
|
|
617
|
-
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.AttachDisputeEvidenceDocumentFile
|
|
618
|
-
*/
|
|
619
|
-
declare function attachDisputeEvidenceDocumentFile(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<AttachDisputeEvidenceDocumentFileResponse, `disputeEvidenceDocument.disputeId` | `disputeEvidenceDocument.tags.tags.tagIds`, 5> & {
|
|
620
|
-
__applicationErrorsType?: AttachDisputeEvidenceDocumentFileApplicationErrors;
|
|
621
|
-
}>;
|
|
661
|
+
declare function createDisputeEvidenceDocument(disputeEvidenceDocument: NonNullablePaths<DisputeEvidenceDocument, `disputeId`, 2>): Promise<NonNullablePaths<DisputeEvidenceDocument, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
|
|
622
662
|
/**
|
|
623
663
|
* Retrieves a DisputeEvidenceDocument.
|
|
624
664
|
* @param disputeEvidenceDocumentId - ID of the DisputeEvidenceDocument to retrieve.
|
|
625
|
-
* @
|
|
665
|
+
* @public
|
|
626
666
|
* @documentationMaturity preview
|
|
627
667
|
* @requiredField disputeEvidenceDocumentId
|
|
628
668
|
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
|
|
629
669
|
* @returns The requested DisputeEvidenceDocument.
|
|
630
670
|
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GetDisputeEvidenceDocument
|
|
631
671
|
*/
|
|
632
|
-
declare function getDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<DisputeEvidenceDocument, `disputeId` | `tags.
|
|
633
|
-
/**
|
|
634
|
-
* Generate DisputeEvidenceDocument Download Url.
|
|
635
|
-
* @param disputeEvidenceDocumentId - ID of the DisputeEvidenceDocument to generate Download Url.
|
|
636
|
-
* @internal
|
|
637
|
-
* @documentationMaturity preview
|
|
638
|
-
* @requiredField disputeEvidenceDocumentId
|
|
639
|
-
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_GENERATE_DOWNLOAD_URL
|
|
640
|
-
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.GenerateDisputeEvidenceDocumentDownloadUrl
|
|
641
|
-
*/
|
|
642
|
-
declare function generateDisputeEvidenceDocumentDownloadUrl(disputeEvidenceDocumentId: string): Promise<GenerateDisputeEvidenceDocumentDownloadUrlResponse & {
|
|
643
|
-
__applicationErrorsType?: GenerateDisputeEvidenceDocumentDownloadUrlApplicationErrors;
|
|
644
|
-
}>;
|
|
645
|
-
/**
|
|
646
|
-
* Mark a DisputeEvidenceDocument as submitted.
|
|
647
|
-
* @param disputeEvidenceDocumentId - Id of the DisputeEvidenceDocument to mark as submitted.
|
|
648
|
-
* @internal
|
|
649
|
-
* @documentationMaturity preview
|
|
650
|
-
* @requiredField disputeEvidenceDocumentId
|
|
651
|
-
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_MARK_SUBMITTED
|
|
652
|
-
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.MarkDisputeEvidenceDocumentSubmitted
|
|
653
|
-
*/
|
|
654
|
-
declare function markDisputeEvidenceDocumentSubmitted(disputeEvidenceDocumentId: string): Promise<void>;
|
|
672
|
+
declare function getDisputeEvidenceDocument(disputeEvidenceDocumentId: string): Promise<NonNullablePaths<DisputeEvidenceDocument, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
|
|
655
673
|
/**
|
|
656
674
|
* Deletes a DisputeEvidenceDocument.
|
|
657
675
|
* @param disputeEvidenceDocumentId - Id of the DisputeEvidenceDocument to delete.
|
|
658
|
-
* @
|
|
676
|
+
* @public
|
|
659
677
|
* @documentationMaturity preview
|
|
660
678
|
* @requiredField disputeEvidenceDocumentId
|
|
661
679
|
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_DELETE
|
|
@@ -666,7 +684,7 @@ declare function deleteDisputeEvidenceDocument(disputeEvidenceDocumentId: string
|
|
|
666
684
|
}>;
|
|
667
685
|
/**
|
|
668
686
|
* Retrieves a list of DisputeEvidenceDocuments, given the provided [paging, filtering, and sorting][1].
|
|
669
|
-
* @
|
|
687
|
+
* @public
|
|
670
688
|
* @documentationMaturity preview
|
|
671
689
|
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_READ
|
|
672
690
|
* @fqn wix.payments.dispute_evidence_documents.v1.DisputeEvidenceDocumentService.QueryDisputeEvidenceDocuments
|
|
@@ -750,10 +768,10 @@ interface DisputeEvidenceDocumentsQueryBuilder {
|
|
|
750
768
|
find: () => Promise<DisputeEvidenceDocumentsQueryResult>;
|
|
751
769
|
}
|
|
752
770
|
/**
|
|
753
|
-
* Synchronously update tags on multiple
|
|
771
|
+
* Synchronously update tags on multiple dispute evidence documents, by list of dispute evidence document ids
|
|
754
772
|
* A tag that appears both in the list of assign and unassign tags, will be assigned
|
|
755
773
|
* @param ids - List of NileProtoTagsEntities that their tags will update.
|
|
756
|
-
* @
|
|
774
|
+
* @public
|
|
757
775
|
* @documentationMaturity preview
|
|
758
776
|
* @requiredField ids
|
|
759
777
|
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_UPDATE_TAGS
|
|
@@ -769,11 +787,11 @@ interface BulkUpdateDisputeEvidenceDocumentTagsOptions {
|
|
|
769
787
|
unassignTags?: Tags;
|
|
770
788
|
}
|
|
771
789
|
/**
|
|
772
|
-
* Asynchronously update tags on multiple
|
|
773
|
-
* An empty filter will update all
|
|
790
|
+
* Asynchronously update tags on multiple dispute evidence documents, by provided filter.
|
|
791
|
+
* An empty filter will update all dispute evidence documents
|
|
774
792
|
* A tag that appears both in the list of assign and unassign tags, will be assigned
|
|
775
793
|
* @param filter - Filter
|
|
776
|
-
* @
|
|
794
|
+
* @public
|
|
777
795
|
* @documentationMaturity preview
|
|
778
796
|
* @requiredField filter
|
|
779
797
|
* @permissionId PAYMENTS.DISPUTE_EVIDENCE_DOCUMENT_UPDATE_TAGS
|
|
@@ -789,4 +807,4 @@ interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
|
|
|
789
807
|
unassignTags?: Tags;
|
|
790
808
|
}
|
|
791
809
|
|
|
792
|
-
export { type ActionEvent, type ApplicationError, type
|
|
810
|
+
export { type ActionEvent, type ApplicationError, type AttachDisputeEvidenceDocumentFileRequest, type AttachDisputeEvidenceDocumentFileResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors, type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors, type BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions, type BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest, type BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, type BulkUpdateDisputeEvidenceDocumentTagsOptions, type BulkUpdateDisputeEvidenceDocumentTagsRequest, type BulkUpdateDisputeEvidenceDocumentTagsResponse, type BulkUpdateDisputeEvidenceDocumentTagsResult, type CreateDisputeEvidenceDocumentRequest, type CreateDisputeEvidenceDocumentResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteDisputeEvidenceDocumentApplicationErrors, type DeleteDisputeEvidenceDocumentRequest, type DeleteDisputeEvidenceDocumentResponse, type DisputeEvidenceDocument, type DisputeEvidenceDocumentCreatedEnvelope, type DisputeEvidenceDocumentDeletedEnvelope, type DisputeEvidenceDocumentUpdatedEnvelope, type DisputeEvidenceDocumentsQueryBuilder, type DisputeEvidenceDocumentsQueryResult, type DocumentFile, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GenerateDisputeEvidenceDocumentDownloadUrlRequest, type GenerateDisputeEvidenceDocumentDownloadUrlResponse, type GenerateDisputeEvidenceDocumentUploadUrlRequest, type GenerateDisputeEvidenceDocumentUploadUrlResponse, type GetDisputeEvidenceDocumentRequest, type GetDisputeEvidenceDocumentResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MarkDisputeEvidenceDocumentSubmittedRequest, type MarkDisputeEvidenceDocumentSubmittedResponse, type MessageEnvelope, type MigrateDisputeEvidenceDocumentRequest, type MigrateDisputeEvidenceDocumentResponse, type QueryDisputeEvidenceDocumentsRequest, type QueryDisputeEvidenceDocumentsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitMigratedDisputeEvidenceDocumentRequest, type SubmitMigratedDisputeEvidenceDocumentResponse, type TagList, type Tags, type TagsModified, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateDisputeEvidenceDocumentTags, bulkUpdateDisputeEvidenceDocumentTagsByFilter, createDisputeEvidenceDocument, deleteDisputeEvidenceDocument, getDisputeEvidenceDocument, onDisputeEvidenceDocumentCreated, onDisputeEvidenceDocumentDeleted, onDisputeEvidenceDocumentUpdated, queryDisputeEvidenceDocuments };
|