@wix/auto_sdk_payments_dispute-evidence-documents 1.0.29 → 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.
@@ -1,647 +1,80 @@
1
- /** Dispute Evidence Document */
2
- interface DisputeEvidenceDocument {
3
- /**
4
- * DisputeEvidenceDocument ID.
5
- * @format GUID
6
- * @readonly
7
- * @immutable
8
- */
9
- _id?: string | null;
10
- /**
11
- * Revision number
12
- * @readonly
13
- */
14
- revision?: string | null;
15
- /**
16
- * Date and time the DisputeEvidenceDocument was created.
17
- * @readonly
18
- * @immutable
19
- */
20
- _createdDate?: Date | null;
21
- /**
22
- * Date and time the DisputeEvidenceDocument was last updated.
23
- * @readonly
24
- */
25
- _updatedDate?: Date | null;
26
- /**
27
- * Dispute ID
28
- * @format GUID
29
- * @immutable
30
- */
31
- disputeId?: string;
32
- /**
33
- * Document evidence file if it was uploaded and attached
34
- * @readonly
35
- */
36
- file?: DocumentFile;
37
- /**
38
- * Submitted date
39
- * @readonly
40
- */
41
- submittedDate?: Date | null;
42
- /** Data Extensions */
43
- extendedFields?: ExtendedFields;
44
- /** Tags */
45
- tags?: Tags;
46
- }
47
- interface DocumentFile {
48
- /**
49
- * Document filename.
50
- * @readonly
51
- * @maxLength 255
52
- */
53
- filename?: string | null;
54
- /**
55
- * Document size in bytes.
56
- * @readonly
57
- */
58
- sizeInBytes?: string | null;
59
- /**
60
- * Hexadecimal representation of the document's MD5 digest.
61
- * @minLength 32
62
- * @maxLength 32
63
- * @readonly
64
- */
65
- hexMd5Digest?: string | null;
66
- }
67
- interface ExtendedFields {
68
- /**
69
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
70
- * The value of each key is structured according to the schema defined when the extended fields were configured.
71
- *
72
- * You can only access fields for which you have the appropriate permissions.
73
- *
74
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
75
- */
76
- namespaces?: Record<string, Record<string, any>>;
77
- }
78
- /**
79
- * Common object for tags.
80
- * Should be use as in this example:
81
- * message Foo {
82
- * string id = 1;
83
- * ...
84
- * Tags tags = 5
85
- * }
86
- *
87
- * example of taggable entity
88
- * {
89
- * id: "123"
90
- * tags: {
91
- * tags: {
92
- * tag_ids:["11","22"]
93
- * },
94
- * private_tags: {
95
- * tag_ids: ["33", "44"]
96
- * }
97
- * }
98
- * }
99
- */
100
- interface Tags {
101
- /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
102
- tags?: TagList;
103
- }
104
- interface TagList {
105
- /**
106
- * List of tag IDs
107
- * @maxSize 100
108
- * @maxLength 5
109
- */
110
- tagIds?: string[];
111
- }
112
- interface CreateDisputeEvidenceDocumentRequest {
113
- /** DisputeEvidenceDocument to be created. */
114
- disputeEvidenceDocument: DisputeEvidenceDocument;
115
- }
116
- interface CreateDisputeEvidenceDocumentResponse {
117
- /** The created DisputeEvidenceDocument. */
118
- disputeEvidenceDocument?: DisputeEvidenceDocument;
119
- /**
120
- * Evidence Document upload URL
121
- * @format WEB_URL
122
- */
123
- uploadUrl?: string | null;
124
- }
125
- interface GetDisputeEvidenceDocumentRequest {
126
- /**
127
- * ID of the DisputeEvidenceDocument to retrieve.
128
- * @format GUID
129
- */
130
- disputeEvidenceDocumentId: string;
131
- }
132
- interface GetDisputeEvidenceDocumentResponse {
133
- /** The requested DisputeEvidenceDocument. */
134
- disputeEvidenceDocument?: DisputeEvidenceDocument;
135
- }
136
- interface DeleteDisputeEvidenceDocumentRequest {
137
- /**
138
- * Id of the DisputeEvidenceDocument to delete.
139
- * @format GUID
140
- */
141
- disputeEvidenceDocumentId: string;
142
- }
143
- interface DeleteDisputeEvidenceDocumentResponse {
144
- }
145
- interface QueryDisputeEvidenceDocumentsRequest {
146
- /** WQL expression. */
147
- query?: CursorQuery;
148
- }
149
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
150
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
151
- cursorPaging?: CursorPaging;
152
- /**
153
- * Filter object in the following format:
154
- * `"filter" : {
155
- * "fieldName1": "value1",
156
- * "fieldName2":{"$operator":"value2"}
157
- * }`
158
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
159
- */
160
- filter?: Record<string, any> | null;
161
- /**
162
- * Sort object in the following format:
163
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
164
- * @maxSize 5
165
- */
166
- sort?: Sorting[];
167
- }
168
- /** @oneof */
169
- interface CursorQueryPagingMethodOneOf {
170
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
171
- cursorPaging?: CursorPaging;
172
- }
173
- interface Sorting {
174
- /**
175
- * Name of the field to sort by.
176
- * @maxLength 512
177
- */
178
- fieldName?: string;
179
- /** Sort order. */
180
- order?: SortOrderWithLiterals;
181
- }
182
- declare enum SortOrder {
183
- ASC = "ASC",
184
- DESC = "DESC"
185
- }
186
- /** @enumType */
187
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
188
- interface CursorPaging {
189
- /**
190
- * Maximum number of items to return in the results.
191
- * @max 100
192
- */
193
- limit?: number | null;
194
- /**
195
- * Pointer to the next or previous page in the list of results.
196
- *
197
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
198
- * Not relevant for the first request.
199
- * @maxLength 16000
200
- */
201
- cursor?: string | null;
202
- }
203
- interface QueryDisputeEvidenceDocumentsResponse {
204
- /** List of DisputeEvidenceDocuments. */
205
- disputeEvidenceDocuments?: DisputeEvidenceDocument[];
206
- /** Paging metadata */
207
- pagingMetadata?: CursorPagingMetadata;
208
- }
209
- interface CursorPagingMetadata {
210
- /** Number of items returned in the response. */
211
- count?: number | null;
212
- /** Cursor strings that point to the next page, previous page, or both. */
213
- cursors?: Cursors;
214
- /**
215
- * Whether there are more pages to retrieve following the current page.
216
- *
217
- * + `true`: Another page of results can be retrieved.
218
- * + `false`: This is the last page.
219
- */
220
- hasNext?: boolean | null;
221
- }
222
- interface Cursors {
223
- /**
224
- * Cursor string pointing to the next page in the list of results.
225
- * @maxLength 16000
226
- */
227
- next?: string | null;
228
- /**
229
- * Cursor pointing to the previous page in the list of results.
230
- * @maxLength 16000
231
- */
232
- prev?: string | null;
233
- }
234
- interface BulkUpdateDisputeEvidenceDocumentTagsRequest {
235
- /**
236
- * List of NileProtoTagsEntities that their tags will update.
237
- * @minSize 1
238
- * @maxSize 100
239
- * @format GUID
240
- */
241
- ids: string[];
242
- /** List of Tags to assign */
243
- assignTags?: Tags;
244
- /** List of Tags to unAssign */
245
- unassignTags?: Tags;
246
- }
247
- interface BulkUpdateDisputeEvidenceDocumentTagsResponse {
248
- /**
249
- * Results
250
- * @minSize 1
251
- * @maxSize 100
252
- */
253
- results?: BulkUpdateDisputeEvidenceDocumentTagsResult[];
254
- /** Metadata regarding the bulk update operation */
255
- bulkActionMetadata?: BulkActionMetadata;
256
- }
257
- interface ItemMetadata {
258
- /**
259
- * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
260
- * @format GUID
261
- */
262
- _id?: string | null;
263
- /** Index of the item within the request array. Allows for correlation between request and response items. */
264
- originalIndex?: number;
265
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
266
- success?: boolean;
267
- /** Details about the error in case of failure. */
268
- error?: ApplicationError;
269
- }
270
- interface ApplicationError {
271
- /** Error code. */
272
- code?: string;
273
- /** Description of the error. */
274
- description?: string;
275
- /** Data related to the error. */
276
- data?: Record<string, any> | null;
277
- }
278
- interface BulkUpdateDisputeEvidenceDocumentTagsResult {
279
- /** Metadata regarding the specific single update operation */
280
- itemMetadata?: ItemMetadata;
281
- }
282
- interface BulkActionMetadata {
283
- /** Number of items that were successfully processed. */
284
- totalSuccesses?: number;
285
- /** Number of items that couldn't be processed. */
286
- totalFailures?: number;
287
- /** Number of failures without details because detailed failure threshold was exceeded. */
288
- undetailedFailures?: number;
289
- }
290
- interface BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest {
291
- /** Filter */
292
- filter: Record<string, any> | null;
293
- /** List of Tags to assign */
294
- assignTags?: Tags;
295
- /** List of Tags to unAssign */
296
- unassignTags?: Tags;
297
- }
298
- interface BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse {
299
- /**
300
- * Job ID
301
- * @format GUID
302
- */
303
- jobId?: string;
304
- }
305
- interface MigrateDisputeEvidenceDocumentRequest {
306
- /**
307
- * Dispute Id
308
- * @format GUID
309
- */
310
- disputeId?: string;
311
- /**
312
- * Evidence Id
313
- * @format GUID
314
- */
315
- evidenceId?: string;
316
- /**
317
- * External evidence document Id
318
- * @minLength 1
319
- * @maxLength 64
320
- */
321
- evidenceDocumentId?: string;
322
- /**
323
- * File hash
324
- * @minLength 32
325
- * @maxLength 32
326
- */
327
- hash?: string | null;
328
- /** Created date */
329
- _createdDate?: Date | null;
330
- }
331
- interface MigrateDisputeEvidenceDocumentResponse {
332
- }
333
- interface SubmitMigratedDisputeEvidenceDocumentRequest {
334
- /**
335
- * Dispute Id
336
- * @format GUID
337
- */
338
- disputeId?: string;
339
- /**
340
- * Evidence Id
341
- * @format GUID
342
- */
343
- evidenceId?: string;
344
- /** Submitted date */
345
- submittedDate?: Date | null;
346
- }
347
- interface SubmitMigratedDisputeEvidenceDocumentResponse {
348
- }
349
- interface GenerateDisputeEvidenceDocumentUploadUrlRequest {
350
- /**
351
- * Dispute Evidence Document ID
352
- * @format GUID
353
- */
354
- disputeEvidenceDocumentId?: string;
355
- /**
356
- * Name of the uploaded file
357
- * @minLength 1
358
- * @maxLength 255
359
- */
360
- filename?: string;
361
- }
362
- interface GenerateDisputeEvidenceDocumentUploadUrlResponse {
363
- /**
364
- * Evidence Document upload URL
365
- * @format WEB_URL
366
- */
367
- uploadUrl?: string;
368
- }
369
- interface AttachDisputeEvidenceDocumentFileRequest {
1
+ import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
+ import { DisputeEvidenceDocument, DeleteDisputeEvidenceDocumentApplicationErrors, DisputeEvidenceDocumentsQueryBuilder, BulkUpdateDisputeEvidenceDocumentTagsOptions, BulkUpdateDisputeEvidenceDocumentTagsResponse, BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors, BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions, BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors, DisputeEvidenceDocumentCreatedEnvelope, DisputeEvidenceDocumentDeletedEnvelope, DisputeEvidenceDocumentUpdatedEnvelope } from './index.typings.js';
3
+ export { ActionEvent, ApplicationError, AttachDisputeEvidenceDocumentFileRequest, AttachDisputeEvidenceDocumentFileResponse, BaseEventMetadata, BulkActionMetadata, BulkUpdateDisputeEvidenceDocumentTagsByFilterRequest, BulkUpdateDisputeEvidenceDocumentTagsRequest, BulkUpdateDisputeEvidenceDocumentTagsResult, CreateDisputeEvidenceDocumentRequest, CreateDisputeEvidenceDocumentResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteDisputeEvidenceDocumentRequest, DeleteDisputeEvidenceDocumentResponse, DisputeEvidenceDocumentsQueryResult, DocumentFile, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GenerateDisputeEvidenceDocumentDownloadUrlRequest, GenerateDisputeEvidenceDocumentDownloadUrlResponse, GenerateDisputeEvidenceDocumentUploadUrlRequest, GenerateDisputeEvidenceDocumentUploadUrlResponse, GetDisputeEvidenceDocumentRequest, GetDisputeEvidenceDocumentResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MarkDisputeEvidenceDocumentSubmittedRequest, MarkDisputeEvidenceDocumentSubmittedResponse, MessageEnvelope, MigrateDisputeEvidenceDocumentRequest, MigrateDisputeEvidenceDocumentResponse, QueryDisputeEvidenceDocumentsRequest, QueryDisputeEvidenceDocumentsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, SubmitMigratedDisputeEvidenceDocumentRequest, SubmitMigratedDisputeEvidenceDocumentResponse, TagList, Tags, TagsModified, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
4
+
5
+ declare function createDisputeEvidenceDocument$1(httpClient: HttpClient): CreateDisputeEvidenceDocumentSignature;
6
+ interface CreateDisputeEvidenceDocumentSignature {
370
7
  /**
371
- * Dispute Evidence Document ID
372
- * @format GUID
8
+ * Creates a DisputeEvidenceDocument.
9
+ * @param - DisputeEvidenceDocument to be created.
10
+ * @returns The created DisputeEvidenceDocument.
373
11
  */
374
- disputeEvidenceDocumentId?: string;
12
+ (disputeEvidenceDocument: NonNullablePaths<DisputeEvidenceDocument, `disputeId`, 2>): Promise<NonNullablePaths<DisputeEvidenceDocument, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
375
13
  }
376
- interface AttachDisputeEvidenceDocumentFileResponse {
377
- /** Dispute Evidence Document */
378
- disputeEvidenceDocument?: DisputeEvidenceDocument;
379
- }
380
- interface GenerateDisputeEvidenceDocumentDownloadUrlRequest {
14
+ declare function getDisputeEvidenceDocument$1(httpClient: HttpClient): GetDisputeEvidenceDocumentSignature;
15
+ interface GetDisputeEvidenceDocumentSignature {
381
16
  /**
382
- * ID of the DisputeEvidenceDocument to generate Download Url.
383
- * @format GUID
17
+ * Retrieves a DisputeEvidenceDocument.
18
+ * @param - ID of the DisputeEvidenceDocument to retrieve.
19
+ * @returns The requested DisputeEvidenceDocument.
384
20
  */
385
- disputeEvidenceDocumentId?: string;
21
+ (disputeEvidenceDocumentId: string): Promise<NonNullablePaths<DisputeEvidenceDocument, `_id` | `disputeId` | `tags.privateTags.tagIds`, 4>>;
386
22
  }
387
- interface GenerateDisputeEvidenceDocumentDownloadUrlResponse {
23
+ declare function deleteDisputeEvidenceDocument$1(httpClient: HttpClient): DeleteDisputeEvidenceDocumentSignature;
24
+ interface DeleteDisputeEvidenceDocumentSignature {
388
25
  /**
389
- * Document source URL.
390
- * @format WEB_URL
26
+ * Deletes a DisputeEvidenceDocument.
27
+ * @param - Id of the DisputeEvidenceDocument to delete.
391
28
  */
392
- url?: string | null;
393
- /** Document source URL expiration date (when relevant). */
394
- urlExpirationDate?: Date | null;
29
+ (disputeEvidenceDocumentId: string): Promise<void & {
30
+ __applicationErrorsType?: DeleteDisputeEvidenceDocumentApplicationErrors;
31
+ }>;
395
32
  }
396
- interface MarkDisputeEvidenceDocumentSubmittedRequest {
33
+ declare function queryDisputeEvidenceDocuments$1(httpClient: HttpClient): QueryDisputeEvidenceDocumentsSignature;
34
+ interface QueryDisputeEvidenceDocumentsSignature {
397
35
  /**
398
- * Id of the DisputeEvidenceDocument to mark as submitted.
399
- * @format GUID
36
+ * Retrieves a list of DisputeEvidenceDocuments, given the provided [paging, filtering, and sorting][1].
400
37
  */
401
- disputeEvidenceDocumentId?: string;
402
- }
403
- interface MarkDisputeEvidenceDocumentSubmittedResponse {
38
+ (): DisputeEvidenceDocumentsQueryBuilder;
404
39
  }
405
- interface DomainEvent extends DomainEventBodyOneOf {
406
- createdEvent?: EntityCreatedEvent;
407
- updatedEvent?: EntityUpdatedEvent;
408
- deletedEvent?: EntityDeletedEvent;
409
- actionEvent?: ActionEvent;
410
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
411
- _id?: string;
412
- /**
413
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
414
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
415
- */
416
- entityFqdn?: string;
417
- /**
418
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
419
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
420
- */
421
- slug?: string;
422
- /** ID of the entity associated with the event. */
423
- entityId?: string;
424
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
425
- eventTime?: Date | null;
426
- /**
427
- * Whether the event was triggered as a result of a privacy regulation application
428
- * (for example, GDPR).
429
- */
430
- triggeredByAnonymizeRequest?: boolean | null;
431
- /** If present, indicates the action that triggered the event. */
432
- originatedFrom?: string | null;
40
+ declare function bulkUpdateDisputeEvidenceDocumentTags$1(httpClient: HttpClient): BulkUpdateDisputeEvidenceDocumentTagsSignature;
41
+ interface BulkUpdateDisputeEvidenceDocumentTagsSignature {
433
42
  /**
434
- * 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.
435
- * 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.
43
+ * Synchronously update tags on multiple dispute evidence documents, by list of dispute evidence document ids
44
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
45
+ * @param - List of NileProtoTagsEntities that their tags will update.
436
46
  */
437
- entityEventSequence?: string | null;
438
- }
439
- /** @oneof */
440
- interface DomainEventBodyOneOf {
441
- createdEvent?: EntityCreatedEvent;
442
- updatedEvent?: EntityUpdatedEvent;
443
- deletedEvent?: EntityDeletedEvent;
444
- actionEvent?: ActionEvent;
445
- }
446
- interface EntityCreatedEvent {
447
- entity?: string;
47
+ (ids: string[], options?: BulkUpdateDisputeEvidenceDocumentTagsOptions): Promise<NonNullablePaths<BulkUpdateDisputeEvidenceDocumentTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
48
+ __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors;
49
+ }>;
448
50
  }
449
- interface RestoreInfo {
450
- deletedDate?: Date | null;
451
- }
452
- interface EntityUpdatedEvent {
51
+ declare function bulkUpdateDisputeEvidenceDocumentTagsByFilter$1(httpClient: HttpClient): BulkUpdateDisputeEvidenceDocumentTagsByFilterSignature;
52
+ interface BulkUpdateDisputeEvidenceDocumentTagsByFilterSignature {
453
53
  /**
454
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
455
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
456
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
54
+ * Asynchronously update tags on multiple dispute evidence documents, by provided filter.
55
+ * An empty filter will update all dispute evidence documents
56
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
57
+ * @param - Filter
457
58
  */
458
- currentEntity?: string;
459
- }
460
- interface EntityDeletedEvent {
461
- /** Entity that was deleted. */
462
- deletedEntity?: string | null;
463
- }
464
- interface ActionEvent {
465
- body?: string;
466
- }
467
- interface MessageEnvelope {
468
- /**
469
- * App instance ID.
470
- * @format GUID
471
- */
472
- instanceId?: string | null;
473
- /**
474
- * Event type.
475
- * @maxLength 150
476
- */
477
- eventType?: string;
478
- /** The identification type and identity data. */
479
- identity?: IdentificationData;
480
- /** Stringify payload. */
481
- data?: string;
482
- }
483
- interface IdentificationData extends IdentificationDataIdOneOf {
484
- /**
485
- * ID of a site visitor that has not logged in to the site.
486
- * @format GUID
487
- */
488
- anonymousVisitorId?: string;
489
- /**
490
- * ID of a site visitor that has logged in to the site.
491
- * @format GUID
492
- */
493
- memberId?: string;
494
- /**
495
- * ID of a Wix user (site owner, contributor, etc.).
496
- * @format GUID
497
- */
498
- wixUserId?: string;
499
- /**
500
- * ID of an app.
501
- * @format GUID
502
- */
503
- appId?: string;
504
- /** @readonly */
505
- identityType?: WebhookIdentityTypeWithLiterals;
506
- }
507
- /** @oneof */
508
- interface IdentificationDataIdOneOf {
509
- /**
510
- * ID of a site visitor that has not logged in to the site.
511
- * @format GUID
512
- */
513
- anonymousVisitorId?: string;
514
- /**
515
- * ID of a site visitor that has logged in to the site.
516
- * @format GUID
517
- */
518
- memberId?: string;
519
- /**
520
- * ID of a Wix user (site owner, contributor, etc.).
521
- * @format GUID
522
- */
523
- wixUserId?: string;
524
- /**
525
- * ID of an app.
526
- * @format GUID
527
- */
528
- appId?: string;
529
- }
530
- declare enum WebhookIdentityType {
531
- UNKNOWN = "UNKNOWN",
532
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
533
- MEMBER = "MEMBER",
534
- WIX_USER = "WIX_USER",
535
- APP = "APP"
536
- }
537
- /** @enumType */
538
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
539
- /** @docsIgnore */
540
- type DeleteDisputeEvidenceDocumentApplicationErrors = {
541
- code?: 'DISPUTE_EVIDENCE_DOCUMENT_ALREADY_SUBMITTED';
542
- description?: string;
543
- data?: Record<string, any>;
544
- };
545
- /** @docsIgnore */
546
- type BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors = {
547
- code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
548
- description?: string;
549
- data?: Record<string, any>;
550
- };
551
- /** @docsIgnore */
552
- type BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors = {
553
- code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
554
- description?: string;
555
- data?: Record<string, any>;
556
- };
557
- interface QueryCursorResult {
558
- cursors: Cursors;
559
- hasNext: () => boolean;
560
- hasPrev: () => boolean;
561
- length: number;
562
- pageSize: number;
563
- }
564
- interface DisputeEvidenceDocumentsQueryResult extends QueryCursorResult {
565
- items: DisputeEvidenceDocument[];
566
- query: DisputeEvidenceDocumentsQueryBuilder;
567
- next: () => Promise<DisputeEvidenceDocumentsQueryResult>;
568
- prev: () => Promise<DisputeEvidenceDocumentsQueryResult>;
569
- }
570
- interface DisputeEvidenceDocumentsQueryBuilder {
571
- /** @param propertyName - Property whose value is compared with `value`.
572
- * @param value - Value to compare against.
573
- * @documentationMaturity preview
574
- */
575
- eq: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
576
- /** @param propertyName - Property whose value is compared with `value`.
577
- * @param value - Value to compare against.
578
- * @documentationMaturity preview
579
- */
580
- ne: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
581
- /** @param propertyName - Property whose value is compared with `value`.
582
- * @param value - Value to compare against.
583
- * @documentationMaturity preview
584
- */
585
- ge: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
586
- /** @param propertyName - Property whose value is compared with `value`.
587
- * @param value - Value to compare against.
588
- * @documentationMaturity preview
589
- */
590
- gt: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
591
- /** @param propertyName - Property whose value is compared with `value`.
592
- * @param value - Value to compare against.
593
- * @documentationMaturity preview
594
- */
595
- le: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
596
- /** @param propertyName - Property whose value is compared with `value`.
597
- * @param value - Value to compare against.
598
- * @documentationMaturity preview
599
- */
600
- lt: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
601
- /** @param propertyName - Property whose value is compared with `string`.
602
- * @param string - String to compare against. Case-insensitive.
603
- * @documentationMaturity preview
604
- */
605
- startsWith: (propertyName: 'disputeId', value: string) => DisputeEvidenceDocumentsQueryBuilder;
606
- /** @param propertyName - Property whose value is compared with `values`.
607
- * @param values - List of values to compare against.
608
- * @documentationMaturity preview
609
- */
610
- hasSome: (propertyName: 'disputeId', value: any[]) => DisputeEvidenceDocumentsQueryBuilder;
611
- /** @documentationMaturity preview */
612
- in: (propertyName: 'disputeId', value: any) => DisputeEvidenceDocumentsQueryBuilder;
613
- /** @documentationMaturity preview */
614
- exists: (propertyName: 'disputeId', value: boolean) => DisputeEvidenceDocumentsQueryBuilder;
615
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
616
- * @documentationMaturity preview
617
- */
618
- ascending: (...propertyNames: Array<'disputeId'>) => DisputeEvidenceDocumentsQueryBuilder;
619
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
620
- * @documentationMaturity preview
621
- */
622
- descending: (...propertyNames: Array<'disputeId'>) => DisputeEvidenceDocumentsQueryBuilder;
623
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
624
- * @documentationMaturity preview
625
- */
626
- limit: (limit: number) => DisputeEvidenceDocumentsQueryBuilder;
627
- /** @param cursor - A pointer to specific record
628
- * @documentationMaturity preview
629
- */
630
- skipTo: (cursor: string) => DisputeEvidenceDocumentsQueryBuilder;
631
- /** @documentationMaturity preview */
632
- find: () => Promise<DisputeEvidenceDocumentsQueryResult>;
633
- }
634
- interface BulkUpdateDisputeEvidenceDocumentTagsOptions {
635
- /** List of Tags to assign */
636
- assignTags?: Tags;
637
- /** List of Tags to unAssign */
638
- unassignTags?: Tags;
639
- }
640
- interface BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions {
641
- /** List of Tags to assign */
642
- assignTags?: Tags;
643
- /** List of Tags to unAssign */
644
- unassignTags?: Tags;
59
+ (filter: Record<string, any>, options?: BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, `jobId`, 2> & {
60
+ __applicationErrorsType?: BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors;
61
+ }>;
645
62
  }
63
+ declare const onDisputeEvidenceDocumentCreated$1: EventDefinition<DisputeEvidenceDocumentCreatedEnvelope, "wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_created">;
64
+ declare const onDisputeEvidenceDocumentDeleted$1: EventDefinition<DisputeEvidenceDocumentDeletedEnvelope, "wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_deleted">;
65
+ declare const onDisputeEvidenceDocumentUpdated$1: EventDefinition<DisputeEvidenceDocumentUpdatedEnvelope, "wix.payments.dispute_evidence_documents.v1.dispute_evidence_document_updated">;
66
+
67
+ declare const createDisputeEvidenceDocument: MaybeContext<BuildRESTFunction<typeof createDisputeEvidenceDocument$1> & typeof createDisputeEvidenceDocument$1>;
68
+ declare const getDisputeEvidenceDocument: MaybeContext<BuildRESTFunction<typeof getDisputeEvidenceDocument$1> & typeof getDisputeEvidenceDocument$1>;
69
+ declare const deleteDisputeEvidenceDocument: MaybeContext<BuildRESTFunction<typeof deleteDisputeEvidenceDocument$1> & typeof deleteDisputeEvidenceDocument$1>;
70
+ declare const queryDisputeEvidenceDocuments: MaybeContext<BuildRESTFunction<typeof queryDisputeEvidenceDocuments$1> & typeof queryDisputeEvidenceDocuments$1>;
71
+ declare const bulkUpdateDisputeEvidenceDocumentTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateDisputeEvidenceDocumentTags$1> & typeof bulkUpdateDisputeEvidenceDocumentTags$1>;
72
+ declare const bulkUpdateDisputeEvidenceDocumentTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateDisputeEvidenceDocumentTagsByFilter$1> & typeof bulkUpdateDisputeEvidenceDocumentTagsByFilter$1>;
73
+ /** */
74
+ declare const onDisputeEvidenceDocumentCreated: BuildEventDefinition<typeof onDisputeEvidenceDocumentCreated$1> & typeof onDisputeEvidenceDocumentCreated$1;
75
+ /** */
76
+ declare const onDisputeEvidenceDocumentDeleted: BuildEventDefinition<typeof onDisputeEvidenceDocumentDeleted$1> & typeof onDisputeEvidenceDocumentDeleted$1;
77
+ /** */
78
+ declare const onDisputeEvidenceDocumentUpdated: BuildEventDefinition<typeof onDisputeEvidenceDocumentUpdated$1> & typeof onDisputeEvidenceDocumentUpdated$1;
646
79
 
647
- export { type ActionEvent, type ApplicationError, type AttachDisputeEvidenceDocumentFileRequest, type AttachDisputeEvidenceDocumentFileResponse, 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 DisputeEvidenceDocumentsQueryBuilder, type DisputeEvidenceDocumentsQueryResult, type DocumentFile, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, 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, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };
80
+ export { BulkUpdateDisputeEvidenceDocumentTagsApplicationErrors, BulkUpdateDisputeEvidenceDocumentTagsByFilterApplicationErrors, BulkUpdateDisputeEvidenceDocumentTagsByFilterOptions, BulkUpdateDisputeEvidenceDocumentTagsByFilterResponse, BulkUpdateDisputeEvidenceDocumentTagsOptions, BulkUpdateDisputeEvidenceDocumentTagsResponse, DeleteDisputeEvidenceDocumentApplicationErrors, DisputeEvidenceDocument, DisputeEvidenceDocumentCreatedEnvelope, DisputeEvidenceDocumentDeletedEnvelope, DisputeEvidenceDocumentUpdatedEnvelope, DisputeEvidenceDocumentsQueryBuilder, bulkUpdateDisputeEvidenceDocumentTags, bulkUpdateDisputeEvidenceDocumentTagsByFilter, createDisputeEvidenceDocument, deleteDisputeEvidenceDocument, getDisputeEvidenceDocument, onDisputeEvidenceDocumentCreated, onDisputeEvidenceDocumentDeleted, onDisputeEvidenceDocumentUpdated, queryDisputeEvidenceDocuments };