@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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +57 -762
  2. package/build/cjs/index.js +68 -81
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +1014 -1
  5. package/build/cjs/index.typings.js +15 -73
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +38 -63
  8. package/build/cjs/meta.js +10 -61
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +57 -762
  11. package/build/es/index.mjs +65 -79
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +1014 -1
  14. package/build/es/index.typings.mjs +14 -71
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +38 -63
  17. package/build/es/meta.mjs +9 -59
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +17 -30
  20. package/build/internal/cjs/index.js +68 -81
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +336 -183
  23. package/build/internal/cjs/index.typings.js +15 -73
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +37 -63
  26. package/build/internal/cjs/meta.js +10 -61
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +17 -30
  29. package/build/internal/es/index.mjs +65 -79
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +336 -183
  32. package/build/internal/es/index.typings.mjs +14 -71
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +37 -63
  35. package/build/internal/es/meta.mjs +9 -59
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -1,783 +1,78 @@
1
- /** Dispute. A dispute occurs when an account owner contacts their PSP or bank to contest a payment to you for a number of possible reasons. */
2
- interface Dispute {
3
- /**
4
- * Dispute ID
5
- * @format GUID
6
- * @immutable
7
- */
8
- _id?: string;
9
- /**
10
- * Charge ID
11
- * @format GUID
12
- * @immutable
13
- */
14
- chargeId?: string;
15
- /**
16
- * Provider Dispute ID
17
- * @format GUID
18
- * @immutable
19
- */
20
- providerDisputeId?: string;
21
- /**
22
- * Dispute stage
23
- * @readonly
24
- */
25
- stage?: DisputeStageWithLiterals;
26
- /**
27
- * Dispute reason
28
- * @readonly
29
- */
30
- reason?: DisputeReasonWithLiterals;
31
- /**
32
- * Dispute currency. Should be the same as the charge currency.
33
- * @immutable
34
- * @format CURRENCY
35
- */
36
- currencyCode?: string | null;
37
- /**
38
- * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
39
- * @immutable
40
- * @decimalValue options { gt:0, maxScale:8 }
41
- */
42
- amount?: string | null;
43
- /**
44
- * Dispute status based on provider dispute status
45
- * @readonly
46
- */
47
- status?: DisputeStatusWithLiterals;
48
- /** True if the merchant can do the refund with the opened dispute, false otherwise */
49
- chargeRefundable?: boolean | null;
50
- /**
51
- * Seller protection helps protect sellers from financial loss on eligible transactions due to unauthorized payments or claims that items were not received
52
- * @readonly
53
- */
54
- sellerProtection?: SellerProtectionWithLiterals;
55
- /**
56
- * Dispute Channel
57
- * Internal - this dispute is created on provider side
58
- * External - this dispute is created on bank side
59
- * @readonly
60
- */
61
- channel?: DisputeChannelWithLiterals;
62
- /**
63
- * The latest date and time until which the dispute can remain in its current status
64
- * @readonly
65
- */
66
- dueDate?: Date | null;
67
- /**
68
- * Network reason code
69
- * @minLength 1
70
- * @maxLength 64
71
- */
72
- networkReasonCode?: string | null;
73
- /**
74
- * True if dispute is defendable
75
- * @readonly
76
- */
77
- defendable?: boolean | null;
78
- /**
79
- * True if it is an auto dispute
80
- * @readonly
81
- */
82
- autoDefended?: boolean | null;
83
- /**
84
- * The dispute defense date
85
- * @readonly
86
- */
87
- defenseDate?: Date | null;
88
- /**
89
- * The dispute acceptance date
90
- * @readonly
91
- */
92
- acceptanceDate?: Date | null;
93
- /**
94
- * The actions that can be perform with the dispute
95
- * @readonly
96
- * @maxSize 20
97
- */
98
- actions?: DisputeAction[];
99
- /**
100
- * The dispute created date
101
- * @readonly
102
- * @immutable
103
- */
104
- _createdDate?: Date | null;
105
- /**
106
- * The dispute updated date
107
- * @readonly
108
- */
109
- _updatedDate?: Date | null;
110
- /**
111
- * Revision number, which increments by 1 each time the Dispute is updated.
112
- * @readonly
113
- */
114
- revision?: string | null;
115
- /** Data Extensions */
116
- extendedFields?: ExtendedFields;
117
- /** Tags */
118
- tags?: PublicTags;
119
- }
120
- declare enum DisputeStage {
121
- UNKNOWN_DISPUTE_STAGE = "UNKNOWN_DISPUTE_STAGE",
122
- /** Chargeback */
123
- CHARGEBACK = "CHARGEBACK",
124
- /** Inquiry (Request for Information) */
125
- INQUIRY = "INQUIRY"
126
- }
127
- /** @enumType */
128
- type DisputeStageWithLiterals = DisputeStage | 'UNKNOWN_DISPUTE_STAGE' | 'CHARGEBACK' | 'INQUIRY';
129
- declare enum DisputeReason {
130
- /** Unknown reason */
131
- UNKNOWN_DISPUTE_REASON = "UNKNOWN_DISPUTE_REASON",
132
- /** Fraud card */
133
- FRAUD_CARD_PRESENT = "FRAUD_CARD_PRESENT",
134
- /** Card absent */
135
- FRAUD_CARD_ABSENT = "FRAUD_CARD_ABSENT",
136
- /** DUPLICATE */
137
- DUPLICATE_PROCESSING = "DUPLICATE_PROCESSING",
138
- /** Service not provided */
139
- SERVICES_NOT_PROVIDED = "SERVICES_NOT_PROVIDED",
140
- /** Canceled Recurring */
141
- CANCELED_RECURRING = "CANCELED_RECURRING",
142
- /** Item not as describe */
143
- NOT_AS_DESCRIBED = "NOT_AS_DESCRIBED",
144
- /** Counterfeit */
145
- COUNTERFEIT = "COUNTERFEIT",
146
- /** Misrepresentation */
147
- MISREPRESENTATION = "MISREPRESENTATION",
148
- /** Canceled */
149
- CANCELED = "CANCELED",
150
- /** Other reason */
151
- OTHER = "OTHER"
152
- }
153
- /** @enumType */
154
- type DisputeReasonWithLiterals = DisputeReason | 'UNKNOWN_DISPUTE_REASON' | 'FRAUD_CARD_PRESENT' | 'FRAUD_CARD_ABSENT' | 'DUPLICATE_PROCESSING' | 'SERVICES_NOT_PROVIDED' | 'CANCELED_RECURRING' | 'NOT_AS_DESCRIBED' | 'COUNTERFEIT' | 'MISREPRESENTATION' | 'CANCELED' | 'OTHER';
155
- declare enum DisputeStatus {
156
- /** Unknown status */
157
- UNKNOWN_DISPUTE_STATUS = "UNKNOWN_DISPUTE_STATUS",
158
- /** Waiting for some merchant action */
159
- WAITING_MERCHANT = "WAITING_MERCHANT",
160
- /** Dispute is under review by PSP or Bank */
161
- UNDER_REVIEW = "UNDER_REVIEW",
162
- /** Waiting for some buyer action */
163
- WAITING_BUYER = "WAITING_BUYER",
164
- /** Dispute won */
165
- WON = "WON",
166
- /** Dispute lost */
167
- LOST = "LOST",
168
- /** Evidence were submitted and are being processed on provider side */
169
- PROCESSING_EVIDENCE_SUBMISSION = "PROCESSING_EVIDENCE_SUBMISSION",
170
- /** The dispute was accepted and the acceptance is being processed on provider side */
171
- PROCESSING_ACCEPTANCE = "PROCESSING_ACCEPTANCE"
172
- }
173
- /** @enumType */
174
- type DisputeStatusWithLiterals = DisputeStatus | 'UNKNOWN_DISPUTE_STATUS' | 'WAITING_MERCHANT' | 'UNDER_REVIEW' | 'WAITING_BUYER' | 'WON' | 'LOST' | 'PROCESSING_EVIDENCE_SUBMISSION' | 'PROCESSING_ACCEPTANCE';
175
- declare enum SellerProtection {
176
- UNKNOWN_SELLER_PROTECTION = "UNKNOWN_SELLER_PROTECTION",
177
- /** Not Eligible */
178
- NOT_ELIGIBLE = "NOT_ELIGIBLE",
179
- /** Eligible */
180
- ELIGIBLE = "ELIGIBLE",
181
- /** Extended seller protection */
182
- EXTENDED = "EXTENDED"
183
- }
184
- /** @enumType */
185
- type SellerProtectionWithLiterals = SellerProtection | 'UNKNOWN_SELLER_PROTECTION' | 'NOT_ELIGIBLE' | 'ELIGIBLE' | 'EXTENDED';
186
- declare enum DisputeChannel {
187
- UNKNOWN_DISPUTE_CHANNEL = "UNKNOWN_DISPUTE_CHANNEL",
188
- /** Internal, the dispute is reviewed by PSP */
189
- INTERNAL = "INTERNAL",
190
- /** External, the dispute is reviewed by bank (or other financial institution) */
191
- EXTERNAL = "EXTERNAL"
192
- }
193
- /** @enumType */
194
- type DisputeChannelWithLiterals = DisputeChannel | 'UNKNOWN_DISPUTE_CHANNEL' | 'INTERNAL' | 'EXTERNAL';
195
- interface DisputeAction {
196
- /** Dispute Action type */
197
- type?: DisputeActionTypeWithLiterals;
198
- /** The latest date and time until which the action can be performed */
199
- dueDate?: Date | null;
200
- }
201
- declare enum DisputeActionType {
202
- /** Unknown dispute status */
203
- UNKNOWN_DISPUTE_ACTION = "UNKNOWN_DISPUTE_ACTION",
204
- /** Accept dispute */
205
- ACCEPT = "ACCEPT",
206
- /** Defend evidence */
207
- DEFEND = "DEFEND"
208
- }
209
- /** @enumType */
210
- type DisputeActionTypeWithLiterals = DisputeActionType | 'UNKNOWN_DISPUTE_ACTION' | 'ACCEPT' | 'DEFEND';
211
- interface ExtendedFields {
212
- /**
213
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
214
- * The value of each key is structured according to the schema defined when the extended fields were configured.
215
- *
216
- * You can only access fields for which you have the appropriate permissions.
217
- *
218
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
219
- */
220
- namespaces?: Record<string, Record<string, any>>;
221
- }
222
- interface PublicTags {
223
- /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
224
- tags?: TagList;
225
- }
226
- interface TagList {
227
- /**
228
- * List of tag IDs
229
- * @maxSize 100
230
- * @maxLength 5
231
- */
232
- tagIds?: string[];
233
- }
234
- interface GetDisputeRequest {
235
- /**
236
- * ID of the Dispute to retrieve.
237
- * @format GUID
238
- */
239
- disputeId: string;
240
- }
241
- interface GetDisputeResponse {
242
- /** The requested Dispute. */
243
- dispute?: Dispute;
244
- }
245
- interface QueryDisputesRequest {
246
- /** WQL expression. */
247
- query?: CursorQuery;
248
- }
249
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
250
- /** 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`. */
251
- cursorPaging?: CursorPaging;
252
- /**
253
- * Filter object in the following format:
254
- * `"filter" : {
255
- * "fieldName1": "value1",
256
- * "fieldName2":{"$operator":"value2"}
257
- * }`
258
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
259
- */
260
- filter?: Record<string, any> | null;
261
- /**
262
- * Sort object in the following format:
263
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
264
- * @maxSize 5
265
- */
266
- sort?: Sorting[];
267
- }
268
- /** @oneof */
269
- interface CursorQueryPagingMethodOneOf {
270
- /** 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`. */
271
- cursorPaging?: CursorPaging;
272
- }
273
- interface Sorting {
274
- /**
275
- * Name of the field to sort by.
276
- * @maxLength 512
277
- */
278
- fieldName?: string;
279
- /** Sort order. */
280
- order?: SortOrderWithLiterals;
281
- }
282
- declare enum SortOrder {
283
- ASC = "ASC",
284
- DESC = "DESC"
285
- }
286
- /** @enumType */
287
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
288
- interface CursorPaging {
289
- /**
290
- * Maximum number of items to return in the results.
291
- * @max 100
292
- */
293
- limit?: number | null;
294
- /**
295
- * Pointer to the next or previous page in the list of results.
296
- *
297
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
298
- * Not relevant for the first request.
299
- * @maxLength 16000
300
- */
301
- cursor?: string | null;
302
- }
303
- interface QueryDisputesResponse {
304
- /** List of Disputes. */
305
- disputes?: Dispute[];
306
- /** Paging metadata */
307
- pagingMetadata?: CursorPagingMetadata;
308
- }
309
- interface CursorPagingMetadata {
310
- /** Number of items returned in the response. */
311
- count?: number | null;
312
- /** Cursor strings that point to the next page, previous page, or both. */
313
- cursors?: Cursors;
314
- /**
315
- * Whether there are more pages to retrieve following the current page.
316
- *
317
- * + `true`: Another page of results can be retrieved.
318
- * + `false`: This is the last page.
319
- */
320
- hasNext?: boolean | null;
321
- }
322
- interface Cursors {
323
- /**
324
- * Cursor string pointing to the next page in the list of results.
325
- * @maxLength 16000
326
- */
327
- next?: string | null;
1
+ import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
+ import { Dispute, DisputesQueryBuilder, AcceptDisputeResponse, DefendDisputeResponse, BulkUpdateDisputeTagsOptions, BulkUpdateDisputeTagsResponse, BulkUpdateDisputeTagsApplicationErrors, BulkUpdateDisputeTagsByFilterOptions, BulkUpdateDisputeTagsByFilterResponse, BulkUpdateDisputeTagsByFilterApplicationErrors, DisputeCreatedEnvelope, DisputeUpdatedEnvelope } from './index.typings.mjs';
3
+ export { AcceptDisputeManuallyRequest, AcceptDisputeManuallyResponse, AcceptDisputeRequest, ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkUpdateDisputeTagsByFilterRequest, BulkUpdateDisputeTagsRequest, BulkUpdateDisputeTagsResult, ChangeDisputeStatusManuallyRequest, ChangeDisputeStatusManuallyResponse, CreateDisputeManuallyRequest, CreateDisputeManuallyResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DefendDisputeManuallyRequest, DefendDisputeManuallyResponse, DefendDisputeRequest, DisputeAction, DisputeActionType, DisputeActionTypeWithLiterals, DisputeChannel, DisputeChannelWithLiterals, DisputeReason, DisputeReasonWithLiterals, DisputeStage, DisputeStageWithLiterals, DisputeStatus, DisputeStatusWithLiterals, DisputesQueryResult, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetDisputeRequest, GetDisputeResponse, IdentificationData, IdentificationDataIdOneOf, InternalChangeDisputeStatusManuallyRequest, InternalChangeDisputeStatusManuallyResponse, InternalCreateDisputeManuallyRequest, InternalCreateDisputeManuallyResponse, ItemMetadata, MessageEnvelope, QueryDisputesRequest, QueryDisputesResponse, RestoreInfo, SellerProtection, SellerProtectionWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, SubmitDisputeEvidenceRequest, SubmitDisputeEvidenceResponse, TagList, Tags, TagsModified, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
4
+
5
+ declare function getDispute$1(httpClient: HttpClient): GetDisputeSignature;
6
+ interface GetDisputeSignature {
328
7
  /**
329
- * Cursor pointing to the previous page in the list of results.
330
- * @maxLength 16000
8
+ * Get Dispute by ID
9
+ * @param - ID of the Dispute to retrieve.
10
+ * @returns The requested Dispute.
331
11
  */
332
- prev?: string | null;
12
+ (disputeId: string): Promise<NonNullablePaths<Dispute, `_id` | `chargeId` | `providerDisputeId` | `stage` | `reason` | `status` | `sellerProtection` | `channel` | `actions` | `actions.${number}.type` | `tags.privateTags.tagIds`, 4>>;
333
13
  }
334
- interface AcceptDisputeRequest {
14
+ declare function queryDisputes$1(httpClient: HttpClient): QueryDisputesSignature;
15
+ interface QueryDisputesSignature {
335
16
  /**
336
- * Dispute ID
337
- * @format GUID
17
+ * Retrieves a list of Disputes
338
18
  */
339
- disputeId: string;
19
+ (): DisputesQueryBuilder;
340
20
  }
341
- interface AcceptDisputeResponse {
342
- /** Dispute */
343
- dispute?: Dispute;
344
- }
345
- interface DefendDisputeRequest {
21
+ declare function acceptDispute$1(httpClient: HttpClient): AcceptDisputeSignature;
22
+ interface AcceptDisputeSignature {
346
23
  /**
347
- * Dispute ID
348
- * @format GUID
24
+ * Accept Dispute
25
+ * @param - Dispute ID
349
26
  */
350
- disputeId: string;
351
- }
352
- interface DefendDisputeResponse {
353
- /** Dispute */
354
- dispute?: Dispute;
27
+ (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>>;
355
28
  }
356
- interface SubmitDisputeEvidenceRequest {
357
- /**
358
- * Dispute ID
359
- * @format GUID
360
- */
361
- disputeId: string;
362
- }
363
- interface SubmitDisputeEvidenceResponse {
364
- /** Dispute */
365
- dispute?: Dispute;
366
- }
367
- interface CreateDisputeManuallyRequest {
368
- /**
369
- * Dispute Id
370
- * @format GUID
371
- */
372
- disputeId?: string;
29
+ declare function defendDispute$1(httpClient: HttpClient): DefendDisputeSignature;
30
+ interface DefendDisputeSignature {
373
31
  /**
374
- * Charge Id
375
- * @format GUID
32
+ * Defend Dispute
33
+ * @param - Dispute ID
376
34
  */
377
- chargeId?: string;
378
- /** Open date */
379
- openDate?: Date | null;
380
- /**
381
- * Provider Dispute Id
382
- * @minLength 1
383
- * @maxLength 100
384
- */
385
- providerDisputeId?: string;
386
- /** Dispute stage */
387
- stage?: DisputeStageWithLiterals;
388
- /** Dispute reason */
389
- reason?: DisputeReasonWithLiterals;
390
- /** Dispute status based on provider dispute status */
391
- status?: DisputeStatusWithLiterals;
392
- /** The latest date and time until which the dispute can remain in its current status */
393
- dueDate?: Date | null;
394
- /**
395
- * Dispute currency. Should be the same as the charge currency.
396
- * @immutable
397
- * @format CURRENCY
398
- */
399
- currencyCode?: string | null;
400
- /**
401
- * Dispute Amount in currency's main units (such as dollars or euros). For example, `"12.95"`.
402
- * @immutable
403
- * @decimalValue options { gt:0, maxScale:8 }
404
- */
405
- amount?: string | null;
406
- /**
407
- * Network reason code
408
- * @minLength 1
409
- * @maxLength 64
410
- */
411
- networkReasonCode?: string | null;
412
- /** External or Internal */
413
- external?: boolean | null;
414
- /**
415
- * Seller protection
416
- * @minLength 1
417
- * @maxLength 64
418
- */
419
- sellerProtection?: string | null;
420
- /** Is charge refundable */
421
- chargeRefundable?: boolean | null;
422
- /** True if dispute is defendable */
423
- defendable?: boolean | null;
424
- /** True if it is an auto dispute */
425
- autoDefended?: boolean | null;
426
- }
427
- interface CreateDisputeManuallyResponse {
35
+ (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>>;
428
36
  }
429
- interface ChangeDisputeStatusManuallyRequest {
37
+ declare function bulkUpdateDisputeTags$1(httpClient: HttpClient): BulkUpdateDisputeTagsSignature;
38
+ interface BulkUpdateDisputeTagsSignature {
430
39
  /**
431
- * Dispute ID
432
- * @format GUID
40
+ * Synchronously update tags on multiple Disputes, by list of Disputes ids
41
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
42
+ * @param - List of NileProtoTagsEntities that their tags will update.
433
43
  */
434
- disputeId?: string;
435
- /** Changed date */
436
- changedDate?: Date | null;
437
- /** Dispute status based on provider dispute status */
438
- status?: DisputeStatusWithLiterals;
439
- }
440
- interface ChangeDisputeStatusManuallyResponse {
44
+ (ids: string[], options?: BulkUpdateDisputeTagsOptions): Promise<NonNullablePaths<BulkUpdateDisputeTagsResponse, `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> & {
45
+ __applicationErrorsType?: BulkUpdateDisputeTagsApplicationErrors;
46
+ }>;
441
47
  }
442
- interface BulkUpdateDisputeTagsRequest {
48
+ declare function bulkUpdateDisputeTagsByFilter$1(httpClient: HttpClient): BulkUpdateDisputeTagsByFilterSignature;
49
+ interface BulkUpdateDisputeTagsByFilterSignature {
443
50
  /**
444
- * List of NileProtoTagsEntities that their tags will update.
445
- * @minSize 1
446
- * @maxSize 100
447
- * @format GUID
51
+ * Asynchronously update tags on multiple Disputes, by provided filter
52
+ * An empty filter will update all Disputes
53
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
54
+ * @param - Filter
448
55
  */
449
- ids: string[];
450
- /** List of Tags to assign */
451
- assignTags?: Tags;
452
- /** List of Tags to unAssign */
453
- unassignTags?: Tags;
56
+ (filter: Record<string, any>, options?: BulkUpdateDisputeTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateDisputeTagsByFilterResponse, `jobId`, 2> & {
57
+ __applicationErrorsType?: BulkUpdateDisputeTagsByFilterApplicationErrors;
58
+ }>;
454
59
  }
60
+ declare const onDisputeCreated$1: EventDefinition<DisputeCreatedEnvelope, "wix.payments.disputes.v1.dispute_created">;
61
+ declare const onDisputeUpdated$1: EventDefinition<DisputeUpdatedEnvelope, "wix.payments.disputes.v1.dispute_updated">;
62
+
63
+ declare const getDispute: MaybeContext<BuildRESTFunction<typeof getDispute$1> & typeof getDispute$1>;
64
+ declare const queryDisputes: MaybeContext<BuildRESTFunction<typeof queryDisputes$1> & typeof queryDisputes$1>;
65
+ declare const acceptDispute: MaybeContext<BuildRESTFunction<typeof acceptDispute$1> & typeof acceptDispute$1>;
66
+ declare const defendDispute: MaybeContext<BuildRESTFunction<typeof defendDispute$1> & typeof defendDispute$1>;
67
+ declare const bulkUpdateDisputeTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateDisputeTags$1> & typeof bulkUpdateDisputeTags$1>;
68
+ declare const bulkUpdateDisputeTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateDisputeTagsByFilter$1> & typeof bulkUpdateDisputeTagsByFilter$1>;
455
69
  /**
456
- * Common object for tags.
457
- * Should be use as in this example:
458
- * message Foo {
459
- * string id = 1;
460
- * ...
461
- * Tags tags = 5
462
- * }
463
- *
464
- * example of taggable entity
465
- * {
466
- * id: "123"
467
- * tags: {
468
- * tags: {
469
- * tag_ids:["11","22"]
470
- * },
471
- * private_tags: {
472
- * tag_ids: ["33", "44"]
473
- * }
474
- * }
475
- * }
70
+ * Fired when a new Dispute is created.
476
71
  */
477
- interface Tags {
478
- /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
479
- tags?: TagsTagList;
480
- }
481
- interface TagsTagList {
482
- /**
483
- * List of tag IDs
484
- * @maxSize 100
485
- * @maxLength 5
486
- */
487
- tagIds?: string[];
488
- }
489
- interface BulkUpdateDisputeTagsResponse {
490
- /**
491
- * Results
492
- * @minSize 1
493
- * @maxSize 100
494
- */
495
- results?: BulkUpdateDisputeTagsResult[];
496
- /** Metadata regarding the bulk update operation */
497
- bulkActionMetadata?: BulkActionMetadata;
498
- }
499
- interface ItemMetadata {
500
- /**
501
- * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
502
- * @format GUID
503
- */
504
- _id?: string | null;
505
- /** Index of the item within the request array. Allows for correlation between request and response items. */
506
- originalIndex?: number;
507
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
508
- success?: boolean;
509
- /** Details about the error in case of failure. */
510
- error?: ApplicationError;
511
- }
512
- interface ApplicationError {
513
- /** Error code. */
514
- code?: string;
515
- /** Description of the error. */
516
- description?: string;
517
- /** Data related to the error. */
518
- data?: Record<string, any> | null;
519
- }
520
- interface BulkUpdateDisputeTagsResult {
521
- /** Metadata regarding the specific single update operation */
522
- itemMetadata?: ItemMetadata;
523
- }
524
- interface BulkActionMetadata {
525
- /** Number of items that were successfully processed. */
526
- totalSuccesses?: number;
527
- /** Number of items that couldn't be processed. */
528
- totalFailures?: number;
529
- /** Number of failures without details because detailed failure threshold was exceeded. */
530
- undetailedFailures?: number;
531
- }
532
- interface BulkUpdateDisputeTagsByFilterRequest {
533
- /** Filter */
534
- filter: Record<string, any> | null;
535
- /** List of Tags to assign */
536
- assignTags?: Tags;
537
- /** List of Tags to unAssign */
538
- unassignTags?: Tags;
539
- }
540
- interface BulkUpdateDisputeTagsByFilterResponse {
541
- /**
542
- * Job ID
543
- * @format GUID
544
- */
545
- jobId?: string;
546
- }
547
- interface DomainEvent extends DomainEventBodyOneOf {
548
- createdEvent?: EntityCreatedEvent;
549
- updatedEvent?: EntityUpdatedEvent;
550
- deletedEvent?: EntityDeletedEvent;
551
- actionEvent?: ActionEvent;
552
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
553
- _id?: string;
554
- /**
555
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
556
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
557
- */
558
- entityFqdn?: string;
559
- /**
560
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
561
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
562
- */
563
- slug?: string;
564
- /** ID of the entity associated with the event. */
565
- entityId?: string;
566
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
567
- eventTime?: Date | null;
568
- /**
569
- * Whether the event was triggered as a result of a privacy regulation application
570
- * (for example, GDPR).
571
- */
572
- triggeredByAnonymizeRequest?: boolean | null;
573
- /** If present, indicates the action that triggered the event. */
574
- originatedFrom?: string | null;
575
- /**
576
- * 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.
577
- * 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.
578
- */
579
- entityEventSequence?: string | null;
580
- }
581
- /** @oneof */
582
- interface DomainEventBodyOneOf {
583
- createdEvent?: EntityCreatedEvent;
584
- updatedEvent?: EntityUpdatedEvent;
585
- deletedEvent?: EntityDeletedEvent;
586
- actionEvent?: ActionEvent;
587
- }
588
- interface EntityCreatedEvent {
589
- entity?: string;
590
- }
591
- interface RestoreInfo {
592
- deletedDate?: Date | null;
593
- }
594
- interface EntityUpdatedEvent {
595
- /**
596
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
597
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
598
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
599
- */
600
- currentEntity?: string;
601
- }
602
- interface EntityDeletedEvent {
603
- /** Entity that was deleted. */
604
- deletedEntity?: string | null;
605
- }
606
- interface ActionEvent {
607
- body?: string;
608
- }
609
- interface MessageEnvelope {
610
- /**
611
- * App instance ID.
612
- * @format GUID
613
- */
614
- instanceId?: string | null;
615
- /**
616
- * Event type.
617
- * @maxLength 150
618
- */
619
- eventType?: string;
620
- /** The identification type and identity data. */
621
- identity?: IdentificationData;
622
- /** Stringify payload. */
623
- data?: string;
624
- }
625
- interface IdentificationData extends IdentificationDataIdOneOf {
626
- /**
627
- * ID of a site visitor that has not logged in to the site.
628
- * @format GUID
629
- */
630
- anonymousVisitorId?: string;
631
- /**
632
- * ID of a site visitor that has logged in to the site.
633
- * @format GUID
634
- */
635
- memberId?: string;
636
- /**
637
- * ID of a Wix user (site owner, contributor, etc.).
638
- * @format GUID
639
- */
640
- wixUserId?: string;
641
- /**
642
- * ID of an app.
643
- * @format GUID
644
- */
645
- appId?: string;
646
- /** @readonly */
647
- identityType?: WebhookIdentityTypeWithLiterals;
648
- }
649
- /** @oneof */
650
- interface IdentificationDataIdOneOf {
651
- /**
652
- * ID of a site visitor that has not logged in to the site.
653
- * @format GUID
654
- */
655
- anonymousVisitorId?: string;
656
- /**
657
- * ID of a site visitor that has logged in to the site.
658
- * @format GUID
659
- */
660
- memberId?: string;
661
- /**
662
- * ID of a Wix user (site owner, contributor, etc.).
663
- * @format GUID
664
- */
665
- wixUserId?: string;
666
- /**
667
- * ID of an app.
668
- * @format GUID
669
- */
670
- appId?: string;
671
- }
672
- declare enum WebhookIdentityType {
673
- UNKNOWN = "UNKNOWN",
674
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
675
- MEMBER = "MEMBER",
676
- WIX_USER = "WIX_USER",
677
- APP = "APP"
678
- }
679
- /** @enumType */
680
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
681
- /** @docsIgnore */
682
- type BulkUpdateDisputeTagsApplicationErrors = {
683
- code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
684
- description?: string;
685
- data?: Record<string, any>;
686
- };
687
- /** @docsIgnore */
688
- type BulkUpdateDisputeTagsByFilterApplicationErrors = {
689
- code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
690
- description?: string;
691
- data?: Record<string, any>;
692
- };
693
- interface QueryCursorResult {
694
- cursors: Cursors;
695
- hasNext: () => boolean;
696
- hasPrev: () => boolean;
697
- length: number;
698
- pageSize: number;
699
- }
700
- interface DisputesQueryResult extends QueryCursorResult {
701
- items: Dispute[];
702
- query: DisputesQueryBuilder;
703
- next: () => Promise<DisputesQueryResult>;
704
- prev: () => Promise<DisputesQueryResult>;
705
- }
706
- interface DisputesQueryBuilder {
707
- /** @param propertyName - Property whose value is compared with `value`.
708
- * @param value - Value to compare against.
709
- * @documentationMaturity preview
710
- */
711
- eq: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
712
- /** @param propertyName - Property whose value is compared with `value`.
713
- * @param value - Value to compare against.
714
- * @documentationMaturity preview
715
- */
716
- ne: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
717
- /** @param propertyName - Property whose value is compared with `value`.
718
- * @param value - Value to compare against.
719
- * @documentationMaturity preview
720
- */
721
- ge: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
722
- /** @param propertyName - Property whose value is compared with `value`.
723
- * @param value - Value to compare against.
724
- * @documentationMaturity preview
725
- */
726
- gt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
727
- /** @param propertyName - Property whose value is compared with `value`.
728
- * @param value - Value to compare against.
729
- * @documentationMaturity preview
730
- */
731
- le: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
732
- /** @param propertyName - Property whose value is compared with `value`.
733
- * @param value - Value to compare against.
734
- * @documentationMaturity preview
735
- */
736
- lt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
737
- /** @param propertyName - Property whose value is compared with `string`.
738
- * @param string - String to compare against. Case-insensitive.
739
- * @documentationMaturity preview
740
- */
741
- startsWith: (propertyName: '_id', value: string) => DisputesQueryBuilder;
742
- /** @param propertyName - Property whose value is compared with `values`.
743
- * @param values - List of values to compare against.
744
- * @documentationMaturity preview
745
- */
746
- hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any[]) => DisputesQueryBuilder;
747
- /** @documentationMaturity preview */
748
- in: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => DisputesQueryBuilder;
749
- /** @documentationMaturity preview */
750
- exists: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: boolean) => DisputesQueryBuilder;
751
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
752
- * @documentationMaturity preview
753
- */
754
- ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => DisputesQueryBuilder;
755
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
756
- * @documentationMaturity preview
757
- */
758
- descending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => DisputesQueryBuilder;
759
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
760
- * @documentationMaturity preview
761
- */
762
- limit: (limit: number) => DisputesQueryBuilder;
763
- /** @param cursor - A pointer to specific record
764
- * @documentationMaturity preview
765
- */
766
- skipTo: (cursor: string) => DisputesQueryBuilder;
767
- /** @documentationMaturity preview */
768
- find: () => Promise<DisputesQueryResult>;
769
- }
770
- interface BulkUpdateDisputeTagsOptions {
771
- /** List of Tags to assign */
772
- assignTags?: Tags;
773
- /** List of Tags to unAssign */
774
- unassignTags?: Tags;
775
- }
776
- interface BulkUpdateDisputeTagsByFilterOptions {
777
- /** List of Tags to assign */
778
- assignTags?: Tags;
779
- /** List of Tags to unAssign */
780
- unassignTags?: Tags;
781
- }
72
+ declare const onDisputeCreated: BuildEventDefinition<typeof onDisputeCreated$1> & typeof onDisputeCreated$1;
73
+ /**
74
+ * Fired when a Dispute is updated.
75
+ */
76
+ declare const onDisputeUpdated: BuildEventDefinition<typeof onDisputeUpdated$1> & typeof onDisputeUpdated$1;
782
77
 
783
- 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 ItemMetadata, type MessageEnvelope, type PublicTags, type QueryDisputesRequest, type QueryDisputesResponse, type RestoreInfo, SellerProtection, type SellerProtectionWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SubmitDisputeEvidenceRequest, type SubmitDisputeEvidenceResponse, type TagList, type Tags, type TagsTagList, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };
78
+ export { AcceptDisputeResponse, BulkUpdateDisputeTagsApplicationErrors, BulkUpdateDisputeTagsByFilterApplicationErrors, BulkUpdateDisputeTagsByFilterOptions, BulkUpdateDisputeTagsByFilterResponse, BulkUpdateDisputeTagsOptions, BulkUpdateDisputeTagsResponse, DefendDisputeResponse, Dispute, DisputeCreatedEnvelope, DisputeUpdatedEnvelope, DisputesQueryBuilder, acceptDispute, bulkUpdateDisputeTags, bulkUpdateDisputeTagsByFilter, defendDispute, getDispute, onDisputeCreated, onDisputeUpdated, queryDisputes };