@wix/auto_sdk_payments_tax-documents 1.0.2 → 1.0.4

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 (42) hide show
  1. package/build/cjs/index.d.ts +2 -2
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +2 -2
  4. package/build/cjs/index.typings.js.map +1 -1
  5. package/build/cjs/meta.js.map +1 -1
  6. package/build/es/index.d.mts +2 -2
  7. package/build/es/index.mjs.map +1 -1
  8. package/build/es/index.typings.d.mts +2 -2
  9. package/build/es/index.typings.mjs.map +1 -1
  10. package/build/es/meta.mjs.map +1 -1
  11. package/build/internal/cjs/index.d.ts +2 -2
  12. package/build/internal/cjs/index.typings.d.ts +46 -2
  13. package/build/internal/cjs/meta.d.ts +86 -0
  14. package/build/internal/es/index.d.mts +2 -2
  15. package/build/internal/es/index.typings.d.mts +46 -2
  16. package/build/internal/es/meta.d.mts +86 -0
  17. package/package.json +5 -12
  18. package/build/cjs/schemas.d.ts +0 -85
  19. package/build/cjs/schemas.js +0 -183
  20. package/build/cjs/schemas.js.map +0 -1
  21. package/build/es/schemas.d.mts +0 -85
  22. package/build/es/schemas.mjs +0 -141
  23. package/build/es/schemas.mjs.map +0 -1
  24. package/build/internal/cjs/index.js +0 -342
  25. package/build/internal/cjs/index.js.map +0 -1
  26. package/build/internal/cjs/index.typings.js +0 -312
  27. package/build/internal/cjs/index.typings.js.map +0 -1
  28. package/build/internal/cjs/meta.js +0 -274
  29. package/build/internal/cjs/meta.js.map +0 -1
  30. package/build/internal/cjs/schemas.d.ts +0 -85
  31. package/build/internal/cjs/schemas.js +0 -183
  32. package/build/internal/cjs/schemas.js.map +0 -1
  33. package/build/internal/es/index.mjs +0 -313
  34. package/build/internal/es/index.mjs.map +0 -1
  35. package/build/internal/es/index.typings.mjs +0 -283
  36. package/build/internal/es/index.typings.mjs.map +0 -1
  37. package/build/internal/es/meta.mjs +0 -242
  38. package/build/internal/es/meta.mjs.map +0 -1
  39. package/build/internal/es/schemas.d.mts +0 -85
  40. package/build/internal/es/schemas.mjs +0 -141
  41. package/build/internal/es/schemas.mjs.map +0 -1
  42. package/schemas/package.json +0 -3
@@ -33,6 +33,13 @@ interface TaxDocument {
33
33
  * @immutable
34
34
  */
35
35
  accountId?: string;
36
+ /**
37
+ * ID of the Wix Payments account profile the tax document belongs to. A profile is a sub-account of a Wix Payments account. Most accounts have a single profile.
38
+ * @internal
39
+ * @format GUID
40
+ * @immutable
41
+ */
42
+ accountProfileId?: string;
36
43
  /**
37
44
  * Type of tax document.
38
45
  * @immutable
@@ -55,6 +62,12 @@ interface TaxDocument {
55
62
  * At least one of `downloadable` and `problematic` is always `true`, and both can be `true` at the same time.
56
63
  */
57
64
  problematic?: boolean;
65
+ /**
66
+ * Whether the tax document is shown to the merchant in their Wix dashboard. A hidden tax document (`false`) is in an internal state and typically shouldn't be surfaced to the merchant.
67
+ * @internal
68
+ * @readonly
69
+ */
70
+ visible?: boolean;
58
71
  /**
59
72
  * How the tax document's amounts are aggregated.
60
73
  * @readonly
@@ -67,6 +80,20 @@ interface TaxDocument {
67
80
  * @maxLength 1000
68
81
  */
69
82
  displayName?: string | null;
83
+ /**
84
+ * Whether the tax document's file has been replaced at least once since it was first created.
85
+ * @internal
86
+ * @readonly
87
+ */
88
+ fileEdited?: boolean;
89
+ /**
90
+ * [Internal] Reference to Adyen legal entity. Cant be removed any time
91
+ * @internal
92
+ * @readonly
93
+ * @minLength 1
94
+ * @maxLength 100
95
+ */
96
+ kycReference?: string | null;
70
97
  }
71
98
  /** Type of tax document. */
72
99
  declare enum TaxDocumentType {
@@ -154,6 +181,11 @@ interface GenerateHistoryFileDownloadInfoResponse {
154
181
  interface UpdateTaxDocumentRequest {
155
182
  /** Tax document to update. */
156
183
  taxDocument?: TaxDocument;
184
+ /**
185
+ * Field mask.
186
+ * @internal
187
+ */
188
+ fieldMask?: string[];
157
189
  }
158
190
  interface UpdateTaxDocumentResponse {
159
191
  /** Updated tax document. */
@@ -381,6 +413,11 @@ interface ListTaxDocumentsRequest {
381
413
  paging?: CursorPaging;
382
414
  /** Filters the retrieved tax documents by type. When omitted, tax documents of all types are returned. */
383
415
  type?: TaxDocumentTypeWithLiterals;
416
+ /**
417
+ * Filters the retrieved tax documents by whether they're visible to the merchant. When omitted, both visible and hidden tax documents are returned.
418
+ * @internal
419
+ */
420
+ visible?: boolean | null;
384
421
  }
385
422
  interface CursorPaging {
386
423
  /**
@@ -415,6 +452,13 @@ interface PagingMetadataV2 {
415
452
  tooManyToCount?: boolean | null;
416
453
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
417
454
  cursors?: Cursors;
455
+ /**
456
+ * Indicates if there are more results after the current page.
457
+ * If `true`, another page of results can be retrieved.
458
+ * If `false`, this is the last page.
459
+ * @internal
460
+ */
461
+ hasNext?: boolean | null;
418
462
  }
419
463
  interface Cursors {
420
464
  /**
@@ -450,7 +494,7 @@ interface GenerateFileDownloadInfoResponse {
450
494
  * @returns Retrieved tax document.
451
495
  * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.GetTaxDocument
452
496
  */
453
- declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 4>>;
497
+ declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 2>>;
454
498
  /**
455
499
  * Retrieves a list of tax documents that belong to a Wix Payments account.
456
500
  *
@@ -467,7 +511,7 @@ declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths
467
511
  * @applicableIdentity APP
468
512
  * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.ListTaxDocuments
469
513
  */
470
- declare function listTaxDocuments(accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 6>>;
514
+ declare function listTaxDocuments(accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 4>>;
471
515
  interface ListTaxDocumentsOptions {
472
516
  /** Cursor paging options. */
473
517
  paging?: CursorPaging;
@@ -34,6 +34,13 @@ interface TaxDocument {
34
34
  * @immutable
35
35
  */
36
36
  accountId?: string;
37
+ /**
38
+ * ID of the Wix Payments account profile the tax document belongs to. A profile is a sub-account of a Wix Payments account. Most accounts have a single profile.
39
+ * @internal
40
+ * @format GUID
41
+ * @immutable
42
+ */
43
+ accountProfileId?: string;
37
44
  /**
38
45
  * Type of tax document.
39
46
  * @immutable
@@ -56,6 +63,12 @@ interface TaxDocument {
56
63
  * At least one of `downloadable` and `problematic` is always `true`, and both can be `true` at the same time.
57
64
  */
58
65
  problematic?: boolean;
66
+ /**
67
+ * Whether the tax document is shown to the merchant in their Wix dashboard. A hidden tax document (`false`) is in an internal state and typically shouldn't be surfaced to the merchant.
68
+ * @internal
69
+ * @readonly
70
+ */
71
+ visible?: boolean;
59
72
  /**
60
73
  * How the tax document's amounts are aggregated.
61
74
  * @readonly
@@ -68,6 +81,20 @@ interface TaxDocument {
68
81
  * @maxLength 1000
69
82
  */
70
83
  displayName?: string | null;
84
+ /**
85
+ * Whether the tax document's file has been replaced at least once since it was first created.
86
+ * @internal
87
+ * @readonly
88
+ */
89
+ fileEdited?: boolean;
90
+ /**
91
+ * [Internal] Reference to Adyen legal entity. Cant be removed any time
92
+ * @internal
93
+ * @readonly
94
+ * @minLength 1
95
+ * @maxLength 100
96
+ */
97
+ kycReference?: string | null;
71
98
  }
72
99
  /** Type of tax document. */
73
100
  declare enum TaxDocumentType {
@@ -176,6 +203,11 @@ interface Document {
176
203
  interface UpdateTaxDocumentRequest {
177
204
  /** Tax document to update. */
178
205
  taxDocument?: TaxDocument;
206
+ /**
207
+ * Field mask.
208
+ * @internal
209
+ */
210
+ fieldMask?: string[];
179
211
  }
180
212
  interface UpdateTaxDocumentResponse {
181
213
  /** Updated tax document. */
@@ -272,8 +304,18 @@ interface DomainEventBodyOneOf {
272
304
  }
273
305
  interface EntityCreatedEvent {
274
306
  entityAsJson?: string;
307
+ /**
308
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
309
+ * @internal
310
+ */
311
+ triggeredByUndelete?: boolean | null;
275
312
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
276
313
  restoreInfo?: RestoreInfo;
314
+ /**
315
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
316
+ * @internal
317
+ */
318
+ additionalMetadataAsJson?: string | null;
277
319
  }
278
320
  interface RestoreInfo {
279
321
  deletedDate?: Date | null;
@@ -285,10 +327,42 @@ interface EntityUpdatedEvent {
285
327
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
286
328
  */
287
329
  currentEntityAsJson?: string;
330
+ /**
331
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
332
+ * wont populate it / have any reference to it in the API.
333
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
334
+ * the developer should send only the new (current) entity.
335
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
336
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
337
+ * @internal
338
+ * @deprecated
339
+ */
340
+ previousEntityAsJson?: string | null;
341
+ /**
342
+ * Map of fully qualified field paths to their previous values for fields that changed.
343
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
344
+ * @internal
345
+ */
346
+ modifiedFields?: Record<string, any>;
347
+ /**
348
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
349
+ * @internal
350
+ */
351
+ additionalMetadataAsJson?: string | null;
288
352
  }
289
353
  interface EntityDeletedEvent {
354
+ /**
355
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
356
+ * @internal
357
+ */
358
+ movedToTrash?: boolean | null;
290
359
  /** Entity that was deleted. */
291
360
  deletedEntityAsJson?: string | null;
361
+ /**
362
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
363
+ * @internal
364
+ */
365
+ additionalMetadataAsJson?: string | null;
292
366
  }
293
367
  interface ActionEvent {
294
368
  bodyAsJson?: string;
@@ -405,6 +479,11 @@ interface ListTaxDocumentsRequest {
405
479
  paging?: CursorPaging;
406
480
  /** Filters the retrieved tax documents by type. When omitted, tax documents of all types are returned. */
407
481
  type?: TaxDocumentTypeWithLiterals;
482
+ /**
483
+ * Filters the retrieved tax documents by whether they're visible to the merchant. When omitted, both visible and hidden tax documents are returned.
484
+ * @internal
485
+ */
486
+ visible?: boolean | null;
408
487
  }
409
488
  interface CursorPaging {
410
489
  /**
@@ -439,6 +518,13 @@ interface PagingMetadataV2 {
439
518
  tooManyToCount?: boolean | null;
440
519
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
441
520
  cursors?: Cursors;
521
+ /**
522
+ * Indicates if there are more results after the current page.
523
+ * If `true`, another page of results can be retrieved.
524
+ * If `false`, this is the last page.
525
+ * @internal
526
+ */
527
+ hasNext?: boolean | null;
442
528
  }
443
529
  interface Cursors {
444
530
  /**
@@ -9,7 +9,7 @@ interface GetTaxDocumentSignature {
9
9
  * @param - ID of the tax document to retrieve.
10
10
  * @returns Retrieved tax document.
11
11
  */
12
- (taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 4>>;
12
+ (taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 2>>;
13
13
  }
14
14
  declare function listTaxDocuments$1(httpClient: HttpClient): ListTaxDocumentsSignature;
15
15
  interface ListTaxDocumentsSignature {
@@ -23,7 +23,7 @@ interface ListTaxDocumentsSignature {
23
23
  * When `type` is omitted, tax documents of all types are returned.
24
24
  * @param - ID of the Wix Payments account whose tax documents are retrieved.
25
25
  */
26
- (accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 6>>;
26
+ (accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 4>>;
27
27
  }
28
28
  declare function generateFileDownloadInfo$1(httpClient: HttpClient): GenerateFileDownloadInfoSignature;
29
29
  interface GenerateFileDownloadInfoSignature {
@@ -33,6 +33,13 @@ interface TaxDocument {
33
33
  * @immutable
34
34
  */
35
35
  accountId?: string;
36
+ /**
37
+ * ID of the Wix Payments account profile the tax document belongs to. A profile is a sub-account of a Wix Payments account. Most accounts have a single profile.
38
+ * @internal
39
+ * @format GUID
40
+ * @immutable
41
+ */
42
+ accountProfileId?: string;
36
43
  /**
37
44
  * Type of tax document.
38
45
  * @immutable
@@ -55,6 +62,12 @@ interface TaxDocument {
55
62
  * At least one of `downloadable` and `problematic` is always `true`, and both can be `true` at the same time.
56
63
  */
57
64
  problematic?: boolean;
65
+ /**
66
+ * Whether the tax document is shown to the merchant in their Wix dashboard. A hidden tax document (`false`) is in an internal state and typically shouldn't be surfaced to the merchant.
67
+ * @internal
68
+ * @readonly
69
+ */
70
+ visible?: boolean;
58
71
  /**
59
72
  * How the tax document's amounts are aggregated.
60
73
  * @readonly
@@ -67,6 +80,20 @@ interface TaxDocument {
67
80
  * @maxLength 1000
68
81
  */
69
82
  displayName?: string | null;
83
+ /**
84
+ * Whether the tax document's file has been replaced at least once since it was first created.
85
+ * @internal
86
+ * @readonly
87
+ */
88
+ fileEdited?: boolean;
89
+ /**
90
+ * [Internal] Reference to Adyen legal entity. Cant be removed any time
91
+ * @internal
92
+ * @readonly
93
+ * @minLength 1
94
+ * @maxLength 100
95
+ */
96
+ kycReference?: string | null;
70
97
  }
71
98
  /** Type of tax document. */
72
99
  declare enum TaxDocumentType {
@@ -154,6 +181,11 @@ interface GenerateHistoryFileDownloadInfoResponse {
154
181
  interface UpdateTaxDocumentRequest {
155
182
  /** Tax document to update. */
156
183
  taxDocument?: TaxDocument;
184
+ /**
185
+ * Field mask.
186
+ * @internal
187
+ */
188
+ fieldMask?: string[];
157
189
  }
158
190
  interface UpdateTaxDocumentResponse {
159
191
  /** Updated tax document. */
@@ -381,6 +413,11 @@ interface ListTaxDocumentsRequest {
381
413
  paging?: CursorPaging;
382
414
  /** Filters the retrieved tax documents by type. When omitted, tax documents of all types are returned. */
383
415
  type?: TaxDocumentTypeWithLiterals;
416
+ /**
417
+ * Filters the retrieved tax documents by whether they're visible to the merchant. When omitted, both visible and hidden tax documents are returned.
418
+ * @internal
419
+ */
420
+ visible?: boolean | null;
384
421
  }
385
422
  interface CursorPaging {
386
423
  /**
@@ -415,6 +452,13 @@ interface PagingMetadataV2 {
415
452
  tooManyToCount?: boolean | null;
416
453
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
417
454
  cursors?: Cursors;
455
+ /**
456
+ * Indicates if there are more results after the current page.
457
+ * If `true`, another page of results can be retrieved.
458
+ * If `false`, this is the last page.
459
+ * @internal
460
+ */
461
+ hasNext?: boolean | null;
418
462
  }
419
463
  interface Cursors {
420
464
  /**
@@ -450,7 +494,7 @@ interface GenerateFileDownloadInfoResponse {
450
494
  * @returns Retrieved tax document.
451
495
  * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.GetTaxDocument
452
496
  */
453
- declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 4>>;
497
+ declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths<TaxDocument, `revision` | `accountId` | `type` | `period.yearPeriod.year` | `downloadable` | `problematic` | `sourceType`, 2>>;
454
498
  /**
455
499
  * Retrieves a list of tax documents that belong to a Wix Payments account.
456
500
  *
@@ -467,7 +511,7 @@ declare function getTaxDocument(taxDocumentId: string): Promise<NonNullablePaths
467
511
  * @applicableIdentity APP
468
512
  * @fqn wix.payments.tax_documents.v1.TaxDocumentsService.ListTaxDocuments
469
513
  */
470
- declare function listTaxDocuments(accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 6>>;
514
+ declare function listTaxDocuments(accountId: string, options?: ListTaxDocumentsOptions): Promise<NonNullablePaths<ListTaxDocumentsResponse, `taxDocuments` | `taxDocuments.${number}.revision` | `taxDocuments.${number}.accountId` | `taxDocuments.${number}.type` | `taxDocuments.${number}.period.yearPeriod.year` | `taxDocuments.${number}.downloadable` | `taxDocuments.${number}.problematic` | `taxDocuments.${number}.sourceType`, 4>>;
471
515
  interface ListTaxDocumentsOptions {
472
516
  /** Cursor paging options. */
473
517
  paging?: CursorPaging;
@@ -34,6 +34,13 @@ interface TaxDocument {
34
34
  * @immutable
35
35
  */
36
36
  accountId?: string;
37
+ /**
38
+ * ID of the Wix Payments account profile the tax document belongs to. A profile is a sub-account of a Wix Payments account. Most accounts have a single profile.
39
+ * @internal
40
+ * @format GUID
41
+ * @immutable
42
+ */
43
+ accountProfileId?: string;
37
44
  /**
38
45
  * Type of tax document.
39
46
  * @immutable
@@ -56,6 +63,12 @@ interface TaxDocument {
56
63
  * At least one of `downloadable` and `problematic` is always `true`, and both can be `true` at the same time.
57
64
  */
58
65
  problematic?: boolean;
66
+ /**
67
+ * Whether the tax document is shown to the merchant in their Wix dashboard. A hidden tax document (`false`) is in an internal state and typically shouldn't be surfaced to the merchant.
68
+ * @internal
69
+ * @readonly
70
+ */
71
+ visible?: boolean;
59
72
  /**
60
73
  * How the tax document's amounts are aggregated.
61
74
  * @readonly
@@ -68,6 +81,20 @@ interface TaxDocument {
68
81
  * @maxLength 1000
69
82
  */
70
83
  displayName?: string | null;
84
+ /**
85
+ * Whether the tax document's file has been replaced at least once since it was first created.
86
+ * @internal
87
+ * @readonly
88
+ */
89
+ fileEdited?: boolean;
90
+ /**
91
+ * [Internal] Reference to Adyen legal entity. Cant be removed any time
92
+ * @internal
93
+ * @readonly
94
+ * @minLength 1
95
+ * @maxLength 100
96
+ */
97
+ kycReference?: string | null;
71
98
  }
72
99
  /** Type of tax document. */
73
100
  declare enum TaxDocumentType {
@@ -176,6 +203,11 @@ interface Document {
176
203
  interface UpdateTaxDocumentRequest {
177
204
  /** Tax document to update. */
178
205
  taxDocument?: TaxDocument;
206
+ /**
207
+ * Field mask.
208
+ * @internal
209
+ */
210
+ fieldMask?: string[];
179
211
  }
180
212
  interface UpdateTaxDocumentResponse {
181
213
  /** Updated tax document. */
@@ -272,8 +304,18 @@ interface DomainEventBodyOneOf {
272
304
  }
273
305
  interface EntityCreatedEvent {
274
306
  entityAsJson?: string;
307
+ /**
308
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
309
+ * @internal
310
+ */
311
+ triggeredByUndelete?: boolean | null;
275
312
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
276
313
  restoreInfo?: RestoreInfo;
314
+ /**
315
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
316
+ * @internal
317
+ */
318
+ additionalMetadataAsJson?: string | null;
277
319
  }
278
320
  interface RestoreInfo {
279
321
  deletedDate?: Date | null;
@@ -285,10 +327,42 @@ interface EntityUpdatedEvent {
285
327
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
286
328
  */
287
329
  currentEntityAsJson?: string;
330
+ /**
331
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
332
+ * wont populate it / have any reference to it in the API.
333
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
334
+ * the developer should send only the new (current) entity.
335
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
336
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
337
+ * @internal
338
+ * @deprecated
339
+ */
340
+ previousEntityAsJson?: string | null;
341
+ /**
342
+ * Map of fully qualified field paths to their previous values for fields that changed.
343
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
344
+ * @internal
345
+ */
346
+ modifiedFields?: Record<string, any>;
347
+ /**
348
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
349
+ * @internal
350
+ */
351
+ additionalMetadataAsJson?: string | null;
288
352
  }
289
353
  interface EntityDeletedEvent {
354
+ /**
355
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
356
+ * @internal
357
+ */
358
+ movedToTrash?: boolean | null;
290
359
  /** Entity that was deleted. */
291
360
  deletedEntityAsJson?: string | null;
361
+ /**
362
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
363
+ * @internal
364
+ */
365
+ additionalMetadataAsJson?: string | null;
292
366
  }
293
367
  interface ActionEvent {
294
368
  bodyAsJson?: string;
@@ -405,6 +479,11 @@ interface ListTaxDocumentsRequest {
405
479
  paging?: CursorPaging;
406
480
  /** Filters the retrieved tax documents by type. When omitted, tax documents of all types are returned. */
407
481
  type?: TaxDocumentTypeWithLiterals;
482
+ /**
483
+ * Filters the retrieved tax documents by whether they're visible to the merchant. When omitted, both visible and hidden tax documents are returned.
484
+ * @internal
485
+ */
486
+ visible?: boolean | null;
408
487
  }
409
488
  interface CursorPaging {
410
489
  /**
@@ -439,6 +518,13 @@ interface PagingMetadataV2 {
439
518
  tooManyToCount?: boolean | null;
440
519
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
441
520
  cursors?: Cursors;
521
+ /**
522
+ * Indicates if there are more results after the current page.
523
+ * If `true`, another page of results can be retrieved.
524
+ * If `false`, this is the last page.
525
+ * @internal
526
+ */
527
+ hasNext?: boolean | null;
442
528
  }
443
529
  interface Cursors {
444
530
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_payments_tax-documents",
3
- "version": "1.0.2",
3
+ "version": "1.0.4",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -21,23 +21,16 @@
21
21
  "import": "./build/es/meta.mjs",
22
22
  "require": "./build/cjs/meta.js",
23
23
  "types": "./build/es/meta.d.mts"
24
- },
25
- "./schemas": {
26
- "import": "./build/es/schemas.mjs",
27
- "require": "./build/cjs/schemas.js",
28
- "types": "./build/es/schemas.d.mts"
29
24
  }
30
25
  },
31
26
  "files": [
32
27
  "build",
33
28
  "meta",
34
- "service-plugins",
35
- "schemas"
29
+ "service-plugins"
36
30
  ],
37
31
  "dependencies": {
38
- "@wix/sdk-runtime": "^1.0.12",
39
- "@wix/sdk-types": "^1.17.7",
40
- "zod": "^4.3.6"
32
+ "@wix/sdk-runtime": "^1.0.24",
33
+ "@wix/sdk-types": "^1.17.11"
41
34
  },
42
35
  "devDependencies": {
43
36
  "tsup": "^8.4.0",
@@ -57,5 +50,5 @@
57
50
  "fqdn": "wix.payments.tax_documents.v1.tax_document"
58
51
  }
59
52
  },
60
- "falconPackageHash": "0d742026ea0cca18a8f7afcb34cc58bd9bedd7ea54624cb4cf8f20fd"
53
+ "falconPackageHash": "723fac78325af33062cba1c19e15acdcffce96fd7854aae368c45e83"
61
54
  }
@@ -1,85 +0,0 @@
1
- import * as z from 'zod';
2
-
3
- declare const GetTaxDocumentRequest: z.ZodObject<{
4
- taxDocumentId: z.ZodString;
5
- }, z.core.$strip>;
6
- declare const GetTaxDocumentResponse: z.ZodObject<{
7
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
8
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
9
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
10
- revision: z.ZodOptional<z.ZodString>;
11
- accountId: z.ZodOptional<z.ZodString>;
12
- type: z.ZodOptional<z.ZodEnum<{
13
- FORM_1099_K: "FORM_1099_K";
14
- }>>;
15
- period: z.ZodOptional<z.ZodIntersection<z.ZodObject<{}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
16
- yearPeriod: z.ZodOptional<z.ZodNever>;
17
- }, z.core.$strip>, z.ZodObject<{
18
- yearPeriod: z.ZodObject<{
19
- year: z.ZodOptional<z.ZodNumber>;
20
- }, z.core.$strip>;
21
- }, z.core.$strip>]>>>;
22
- downloadable: z.ZodOptional<z.ZodBoolean>;
23
- problematic: z.ZodOptional<z.ZodBoolean>;
24
- sourceType: z.ZodOptional<z.ZodEnum<{
25
- PAYMENT: "PAYMENT";
26
- PAYOUT: "PAYOUT";
27
- }>>;
28
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
29
- }, z.core.$strip>;
30
- declare const ListTaxDocumentsRequest: z.ZodObject<{
31
- accountId: z.ZodString;
32
- options: z.ZodOptional<z.ZodObject<{
33
- paging: z.ZodOptional<z.ZodObject<{
34
- limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
35
- cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
36
- }, z.core.$strip>>;
37
- type: z.ZodOptional<z.ZodEnum<{
38
- FORM_1099_K: "FORM_1099_K";
39
- }>>;
40
- }, z.core.$strip>>;
41
- }, z.core.$strip>;
42
- declare const ListTaxDocumentsResponse: z.ZodObject<{
43
- taxDocuments: z.ZodOptional<z.ZodArray<z.ZodObject<{
44
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
45
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
46
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
47
- revision: z.ZodOptional<z.ZodString>;
48
- accountId: z.ZodOptional<z.ZodString>;
49
- type: z.ZodOptional<z.ZodEnum<{
50
- FORM_1099_K: "FORM_1099_K";
51
- }>>;
52
- period: z.ZodOptional<z.ZodIntersection<z.ZodObject<{}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
53
- yearPeriod: z.ZodOptional<z.ZodNever>;
54
- }, z.core.$strip>, z.ZodObject<{
55
- yearPeriod: z.ZodObject<{
56
- year: z.ZodOptional<z.ZodNumber>;
57
- }, z.core.$strip>;
58
- }, z.core.$strip>]>>>;
59
- downloadable: z.ZodOptional<z.ZodBoolean>;
60
- problematic: z.ZodOptional<z.ZodBoolean>;
61
- sourceType: z.ZodOptional<z.ZodEnum<{
62
- PAYMENT: "PAYMENT";
63
- PAYOUT: "PAYOUT";
64
- }>>;
65
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
66
- }, z.core.$strip>>>;
67
- pagingMetadata: z.ZodOptional<z.ZodObject<{
68
- count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
69
- offset: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
70
- total: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
71
- tooManyToCount: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
72
- cursors: z.ZodOptional<z.ZodObject<{
73
- next: z.ZodNullable<z.ZodOptional<z.ZodString>>;
74
- prev: z.ZodNullable<z.ZodOptional<z.ZodString>>;
75
- }, z.core.$strip>>;
76
- }, z.core.$strip>>;
77
- }, z.core.$strip>;
78
- declare const GenerateFileDownloadInfoRequest: z.ZodObject<{
79
- taxDocumentId: z.ZodString;
80
- }, z.core.$strip>;
81
- declare const GenerateFileDownloadInfoResponse: z.ZodObject<{
82
- downloadInfo: z.ZodOptional<z.ZodString>;
83
- }, z.core.$strip>;
84
-
85
- export { GenerateFileDownloadInfoRequest, GenerateFileDownloadInfoResponse, GetTaxDocumentRequest, GetTaxDocumentResponse, ListTaxDocumentsRequest, ListTaxDocumentsResponse };