@payabli/sdk-node 0.0.140 → 0.0.142

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 (181) hide show
  1. package/README.md +11 -15
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/Client.d.ts +3 -0
  4. package/dist/cjs/Client.js +41 -36
  5. package/dist/cjs/api/resources/bill/types/BillOutData.d.ts +5 -1
  6. package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -0
  7. package/dist/cjs/api/resources/cloud/client/Client.js +4 -0
  8. package/dist/cjs/api/resources/index.d.ts +4 -0
  9. package/dist/cjs/api/resources/index.js +5 -1
  10. package/dist/cjs/api/resources/management/client/Client.d.ts +41 -0
  11. package/dist/cjs/api/resources/management/client/Client.js +131 -0
  12. package/dist/cjs/api/resources/management/client/index.d.ts +1 -0
  13. package/dist/cjs/api/resources/management/client/index.js +17 -0
  14. package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.ts +25 -0
  15. package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.js +3 -0
  16. package/dist/cjs/api/resources/management/client/requests/index.d.ts +1 -0
  17. package/dist/cjs/api/resources/management/client/requests/index.js +2 -0
  18. package/dist/cjs/api/resources/management/exports.d.ts +2 -0
  19. package/dist/cjs/api/resources/management/exports.js +21 -0
  20. package/dist/cjs/api/resources/management/index.d.ts +2 -0
  21. package/dist/cjs/api/resources/management/index.js +18 -0
  22. package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.d.ts +31 -0
  23. package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.js +3 -0
  24. package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.d.ts +9 -0
  25. package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.js +3 -0
  26. package/dist/cjs/api/resources/management/types/index.d.ts +2 -0
  27. package/dist/cjs/api/resources/management/types/index.js +18 -0
  28. package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +1 -1
  29. package/dist/cjs/api/resources/moneyIn/client/Client.js +1 -1
  30. package/dist/cjs/api/resources/moneyIn/types/TransactionDetailPaymentData.d.ts +1 -1
  31. package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +5 -2
  32. package/dist/cjs/api/resources/moneyOut/client/Client.js +5 -2
  33. package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +3 -0
  34. package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +1 -0
  35. package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +7 -0
  36. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +7 -0
  37. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +7 -0
  38. package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +7 -0
  39. package/dist/cjs/api/resources/query/client/Client.d.ts +42 -0
  40. package/dist/cjs/api/resources/query/client/Client.js +140 -0
  41. package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.d.ts +113 -0
  42. package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.js +3 -0
  43. package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.d.ts +113 -0
  44. package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.js +3 -0
  45. package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +1 -0
  46. package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +1 -0
  47. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  48. package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.d.ts +50 -0
  49. package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.js +3 -0
  50. package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.d.ts +45 -0
  51. package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.js +3 -0
  52. package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
  53. package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
  54. package/dist/cjs/api/resources/vendor/client/Client.d.ts +44 -1
  55. package/dist/cjs/api/resources/vendor/client/Client.js +88 -1
  56. package/dist/cjs/api/resources/vendor/index.d.ts +1 -0
  57. package/dist/cjs/api/resources/vendor/index.js +1 -0
  58. package/dist/cjs/api/resources/vendor/types/VendorEnrichRequest.d.ts +20 -0
  59. package/dist/cjs/api/resources/vendor/types/VendorEnrichRequest.js +3 -0
  60. package/dist/cjs/api/resources/vendor/types/VendorEnrichResponse.d.ts +12 -0
  61. package/dist/cjs/api/resources/vendor/types/VendorEnrichResponse.js +3 -0
  62. package/dist/cjs/api/resources/vendor/types/VendorEnrichResponseData.d.ts +16 -0
  63. package/dist/cjs/api/resources/vendor/types/VendorEnrichResponseData.js +3 -0
  64. package/dist/cjs/api/resources/vendor/types/VendorEnrichmentData.d.ts +10 -0
  65. package/dist/cjs/api/resources/vendor/types/VendorEnrichmentData.js +3 -0
  66. package/dist/cjs/api/resources/vendor/types/VendorEnrichmentInvoiceScan.d.ts +35 -0
  67. package/dist/cjs/api/resources/vendor/types/VendorEnrichmentInvoiceScan.js +3 -0
  68. package/dist/cjs/api/resources/vendor/types/VendorEnrichmentWebSearch.d.ts +35 -0
  69. package/dist/cjs/api/resources/vendor/types/VendorEnrichmentWebSearch.js +3 -0
  70. package/dist/cjs/api/resources/vendor/types/index.d.ts +6 -0
  71. package/dist/cjs/api/resources/vendor/types/index.js +22 -0
  72. package/dist/cjs/api/types/AutoCapture.d.ts +4 -0
  73. package/dist/cjs/api/types/AutoCapture.js +3 -0
  74. package/dist/cjs/api/types/BinData.d.ts +4 -1
  75. package/dist/cjs/api/types/NotificationContent.d.ts +0 -1
  76. package/dist/cjs/api/types/NotificationContent.js +0 -1
  77. package/dist/cjs/api/types/NotificationStandardRequest.d.ts +0 -1
  78. package/dist/cjs/api/types/NotificationStandardRequest.js +0 -1
  79. package/dist/cjs/api/types/ProcessingSection.d.ts +5 -0
  80. package/dist/cjs/api/types/QueryChargebacksResponse.d.ts +10 -1
  81. package/dist/cjs/api/types/TemplateElement.d.ts +1 -0
  82. package/dist/cjs/api/types/VCardCardType.d.ts +6 -0
  83. package/dist/cjs/api/types/VCardCardType.js +3 -0
  84. package/dist/cjs/api/types/VCardRecord.d.ts +2 -0
  85. package/dist/cjs/api/types/VendorData.d.ts +12 -0
  86. package/dist/cjs/api/types/VendorQueryRecord.d.ts +21 -0
  87. package/dist/cjs/api/types/index.d.ts +2 -0
  88. package/dist/cjs/api/types/index.js +2 -0
  89. package/dist/cjs/version.d.ts +1 -1
  90. package/dist/cjs/version.js +1 -1
  91. package/dist/esm/BaseClient.mjs +2 -2
  92. package/dist/esm/Client.d.mts +3 -0
  93. package/dist/esm/Client.mjs +5 -0
  94. package/dist/esm/api/resources/bill/types/BillOutData.d.mts +5 -1
  95. package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -0
  96. package/dist/esm/api/resources/cloud/client/Client.mjs +4 -0
  97. package/dist/esm/api/resources/index.d.mts +4 -0
  98. package/dist/esm/api/resources/index.mjs +4 -0
  99. package/dist/esm/api/resources/management/client/Client.d.mts +41 -0
  100. package/dist/esm/api/resources/management/client/Client.mjs +94 -0
  101. package/dist/esm/api/resources/management/client/index.d.mts +1 -0
  102. package/dist/esm/api/resources/management/client/index.mjs +1 -0
  103. package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.mts +25 -0
  104. package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.mjs +2 -0
  105. package/dist/esm/api/resources/management/client/requests/index.d.mts +1 -0
  106. package/dist/esm/api/resources/management/client/requests/index.mjs +1 -0
  107. package/dist/esm/api/resources/management/exports.d.mts +2 -0
  108. package/dist/esm/api/resources/management/exports.mjs +3 -0
  109. package/dist/esm/api/resources/management/index.d.mts +2 -0
  110. package/dist/esm/api/resources/management/index.mjs +2 -0
  111. package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.d.mts +31 -0
  112. package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.mjs +2 -0
  113. package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.d.mts +9 -0
  114. package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.mjs +2 -0
  115. package/dist/esm/api/resources/management/types/index.d.mts +2 -0
  116. package/dist/esm/api/resources/management/types/index.mjs +2 -0
  117. package/dist/esm/api/resources/moneyIn/client/Client.d.mts +1 -1
  118. package/dist/esm/api/resources/moneyIn/client/Client.mjs +1 -1
  119. package/dist/esm/api/resources/moneyIn/types/TransactionDetailPaymentData.d.mts +1 -1
  120. package/dist/esm/api/resources/moneyOut/client/Client.d.mts +5 -2
  121. package/dist/esm/api/resources/moneyOut/client/Client.mjs +5 -2
  122. package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +3 -0
  123. package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +1 -0
  124. package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +7 -0
  125. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +7 -0
  126. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +7 -0
  127. package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +7 -0
  128. package/dist/esm/api/resources/query/client/Client.d.mts +42 -0
  129. package/dist/esm/api/resources/query/client/Client.mjs +140 -0
  130. package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.d.mts +113 -0
  131. package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.mjs +2 -0
  132. package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.d.mts +113 -0
  133. package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.mjs +2 -0
  134. package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +1 -0
  135. package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +1 -0
  136. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  137. package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.d.mts +50 -0
  138. package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.mjs +2 -0
  139. package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.d.mts +45 -0
  140. package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.mjs +2 -0
  141. package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
  142. package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
  143. package/dist/esm/api/resources/vendor/client/Client.d.mts +44 -1
  144. package/dist/esm/api/resources/vendor/client/Client.mjs +88 -1
  145. package/dist/esm/api/resources/vendor/index.d.mts +1 -0
  146. package/dist/esm/api/resources/vendor/index.mjs +1 -0
  147. package/dist/esm/api/resources/vendor/types/VendorEnrichRequest.d.mts +20 -0
  148. package/dist/esm/api/resources/vendor/types/VendorEnrichRequest.mjs +2 -0
  149. package/dist/esm/api/resources/vendor/types/VendorEnrichResponse.d.mts +12 -0
  150. package/dist/esm/api/resources/vendor/types/VendorEnrichResponse.mjs +2 -0
  151. package/dist/esm/api/resources/vendor/types/VendorEnrichResponseData.d.mts +16 -0
  152. package/dist/esm/api/resources/vendor/types/VendorEnrichResponseData.mjs +2 -0
  153. package/dist/esm/api/resources/vendor/types/VendorEnrichmentData.d.mts +10 -0
  154. package/dist/esm/api/resources/vendor/types/VendorEnrichmentData.mjs +2 -0
  155. package/dist/esm/api/resources/vendor/types/VendorEnrichmentInvoiceScan.d.mts +35 -0
  156. package/dist/esm/api/resources/vendor/types/VendorEnrichmentInvoiceScan.mjs +2 -0
  157. package/dist/esm/api/resources/vendor/types/VendorEnrichmentWebSearch.d.mts +35 -0
  158. package/dist/esm/api/resources/vendor/types/VendorEnrichmentWebSearch.mjs +2 -0
  159. package/dist/esm/api/resources/vendor/types/index.d.mts +6 -0
  160. package/dist/esm/api/resources/vendor/types/index.mjs +6 -0
  161. package/dist/esm/api/types/AutoCapture.d.mts +4 -0
  162. package/dist/esm/api/types/AutoCapture.mjs +2 -0
  163. package/dist/esm/api/types/BinData.d.mts +4 -1
  164. package/dist/esm/api/types/NotificationContent.d.mts +0 -1
  165. package/dist/esm/api/types/NotificationContent.mjs +0 -1
  166. package/dist/esm/api/types/NotificationStandardRequest.d.mts +0 -1
  167. package/dist/esm/api/types/NotificationStandardRequest.mjs +0 -1
  168. package/dist/esm/api/types/ProcessingSection.d.mts +5 -0
  169. package/dist/esm/api/types/QueryChargebacksResponse.d.mts +10 -1
  170. package/dist/esm/api/types/TemplateElement.d.mts +1 -0
  171. package/dist/esm/api/types/VCardCardType.d.mts +6 -0
  172. package/dist/esm/api/types/VCardCardType.mjs +2 -0
  173. package/dist/esm/api/types/VCardRecord.d.mts +2 -0
  174. package/dist/esm/api/types/VendorData.d.mts +12 -0
  175. package/dist/esm/api/types/VendorQueryRecord.d.mts +21 -0
  176. package/dist/esm/api/types/index.d.mts +2 -0
  177. package/dist/esm/api/types/index.mjs +2 -0
  178. package/dist/esm/version.d.mts +1 -1
  179. package/dist/esm/version.mjs +1 -1
  180. package/package.json +12 -1
  181. package/reference.md +321 -4
@@ -8,6 +8,8 @@ export type { ListChargebacksOrgRequest } from "./ListChargebacksOrgRequest.mjs"
8
8
  export type { ListChargebacksRequest } from "./ListChargebacksRequest.mjs";
9
9
  export type { ListCustomersOrgRequest } from "./ListCustomersOrgRequest.mjs";
10
10
  export type { ListCustomersRequest } from "./ListCustomersRequest.mjs";
11
+ export type { ListDevicesOrgRequest } from "./ListDevicesOrgRequest.mjs";
12
+ export type { ListDevicesRequest } from "./ListDevicesRequest.mjs";
11
13
  export type { ListNotificationReportsOrgRequest } from "./ListNotificationReportsOrgRequest.mjs";
12
14
  export type { ListNotificationReportsRequest } from "./ListNotificationReportsRequest.mjs";
13
15
  export type { ListNotificationsOrgRequest } from "./ListNotificationsOrgRequest.mjs";
@@ -0,0 +1,50 @@
1
+ export interface DeviceQueryRecord {
2
+ /** Unique identifier for the cloud device. */
3
+ deviceId: string | null;
4
+ /** Internal cloud device record ID. */
5
+ idCloud: number | null;
6
+ /** Description of the device. */
7
+ description: string | null;
8
+ /** Serial number of the device. */
9
+ serialNumber: string | null;
10
+ /** Human-readable name for the device. */
11
+ friendlyName: string | null;
12
+ /** Manufacturer of the device. */
13
+ make: string | null;
14
+ /** Model name of the device. */
15
+ model: string | null;
16
+ /** Type of device. */
17
+ deviceType: number | null;
18
+ /** Current status of the device. */
19
+ deviceStatus: number | null;
20
+ /** Operating system of the device. */
21
+ deviceOs: number | null;
22
+ /** MAC address of the device. */
23
+ macAddress: string | null;
24
+ /** Timestamp of the last health check from the device. */
25
+ lastHealthCheck: string | null;
26
+ /** Registration code used to activate the device. */
27
+ registrationCode: string | null;
28
+ /** Number of activation attempts for the device. */
29
+ activationAttempts: number | null;
30
+ /** Expiration timestamp for the device activation code. */
31
+ activationCodeExpiry: string | null;
32
+ /** Timestamp when the device record was created. */
33
+ createdAt: string | null;
34
+ /** Timestamp when the device record was last updated. */
35
+ updatedAt: string | null;
36
+ /** Numeric identifier for the paypoint. */
37
+ paypointId: number | null;
38
+ /** DBA name for the paypoint. */
39
+ paypointDba: string | null;
40
+ /** Legal name for the paypoint. */
41
+ paypointLegal: string | null;
42
+ /** Entry identifier for the paypoint. */
43
+ paypointEntry: string | null;
44
+ /** External identifier for the paypoint. */
45
+ externalPaypointId: string | null;
46
+ /** Numeric identifier for the parent organization. */
47
+ parentOrgId: number | null;
48
+ /** Name of the parent organization. */
49
+ parentOrgName: string | null;
50
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,45 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Response body for queries about cloud devices.
4
+ *
5
+ * @example
6
+ * {
7
+ * Summary: {
8
+ * pageSize: 20,
9
+ * totalAmount: 0,
10
+ * totalNetAmount: 0,
11
+ * totalPages: 2,
12
+ * totalRecords: 28
13
+ * },
14
+ * Records: [{
15
+ * deviceId: "DEV-A1B2C3D4",
16
+ * idCloud: 142,
17
+ * description: "Front Counter Terminal",
18
+ * serialNumber: "SN-90210-XR",
19
+ * friendlyName: "Front Counter Terminal",
20
+ * make: "Ingenico",
21
+ * model: "LK2500",
22
+ * deviceType: 1,
23
+ * deviceStatus: 1,
24
+ * deviceOs: null,
25
+ * macAddress: "1A2B3C4D5E6F",
26
+ * lastHealthCheck: "2026-04-09T14:49:42Z",
27
+ * registrationCode: "REG-A1B2C3D4",
28
+ * activationAttempts: 0,
29
+ * activationCodeExpiry: "2026-04-09T14:49:42Z",
30
+ * createdAt: "2026-04-09T01:14:37Z",
31
+ * updatedAt: "2026-04-09T14:49:42Z",
32
+ * paypointId: 12345,
33
+ * paypointDba: "Gruzya Adventure Outfitters",
34
+ * paypointLegal: "Gruzya Adventure Outfitters, LLC",
35
+ * paypointEntry: "8cfec329267",
36
+ * externalPaypointId: "GRUZYA-01",
37
+ * parentOrgId: 100,
38
+ * parentOrgName: "Example Corp"
39
+ * }]
40
+ * }
41
+ */
42
+ export interface QueryDeviceResponse {
43
+ Summary: Payabli.QuerySummary;
44
+ Records: Payabli.DeviceQueryRecord[];
45
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,8 +1,10 @@
1
+ export * from "./DeviceQueryRecord.mjs";
1
2
  export * from "./LimitRecord.mjs";
2
3
  export * from "./ListOrganizationsResponse.mjs";
3
4
  export * from "./QueryBatchesDetailResponse.mjs";
4
5
  export * from "./QueryBatchesResponse.mjs";
5
6
  export * from "./QueryBatchesTransfer.mjs";
7
+ export * from "./QueryDeviceResponse.mjs";
6
8
  export * from "./QueryTransferDetailResponse.mjs";
7
9
  export * from "./QueryTransferResponse.mjs";
8
10
  export * from "./QueryTransferSummary.mjs";
@@ -1,8 +1,10 @@
1
+ export * from "./DeviceQueryRecord.mjs";
1
2
  export * from "./LimitRecord.mjs";
2
3
  export * from "./ListOrganizationsResponse.mjs";
3
4
  export * from "./QueryBatchesDetailResponse.mjs";
4
5
  export * from "./QueryBatchesResponse.mjs";
5
6
  export * from "./QueryBatchesTransfer.mjs";
7
+ export * from "./QueryDeviceResponse.mjs";
6
8
  export * from "./QueryTransferDetailResponse.mjs";
7
9
  export * from "./QueryTransferResponse.mjs";
8
10
  export * from "./QueryTransferSummary.mjs";
@@ -106,7 +106,7 @@ export declare class VendorClient {
106
106
  editVendor(idVendor: number, request: Payabli.VendorData, requestOptions?: VendorClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseVendors>;
107
107
  private __editVendor;
108
108
  /**
109
- * Retrieves a vendor's details.
109
+ * Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
110
110
  *
111
111
  * @param {number} idVendor - Vendor ID.
112
112
  * @param {VendorClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -116,4 +116,47 @@ export declare class VendorClient {
116
116
  */
117
117
  getVendor(idVendor: number, requestOptions?: VendorClient.RequestOptions): core.HttpResponsePromise<Payabli.VendorQueryRecord>;
118
118
  private __getVendor;
119
+ /**
120
+ * Triggers AI-powered vendor enrichment for an existing vendor. Runs one or more enrichment stages (invoice scan, web search) based on the `scope` parameter. Can automatically apply extracted payment acceptance info and vendor contact information to the vendor record, or return raw results for manual review. Contact Payabli to enable this feature.
121
+ *
122
+ * @param {string} entry - Entrypoint identifier.
123
+ * @param {Payabli.VendorEnrichRequest} request
124
+ * @param {VendorClient.RequestOptions} requestOptions - Request-specific configuration.
125
+ *
126
+ * @throws {@link Payabli.BadRequestError}
127
+ * @throws {@link Payabli.UnauthorizedError}
128
+ * @throws {@link Payabli.InternalServerError}
129
+ * @throws {@link Payabli.ServiceUnavailableError}
130
+ *
131
+ * @example
132
+ * await client.vendor.enrichVendor("8cfec329267", {
133
+ * vendorId: 3890,
134
+ * scope: ["invoice_scan"],
135
+ * applyEnrichmentData: false,
136
+ * fallbackMethod: "check",
137
+ * invoiceFile: {
138
+ * ftype: "pdf",
139
+ * filename: "invoice-2026-001.pdf",
140
+ * fContent: "<base64-encoded-pdf>"
141
+ * }
142
+ * })
143
+ *
144
+ * @example
145
+ * await client.vendor.enrichVendor("8cfec329267", {
146
+ * vendorId: 3891,
147
+ * scope: ["web_search"],
148
+ * applyEnrichmentData: false,
149
+ * fallbackMethod: "check"
150
+ * })
151
+ *
152
+ * @example
153
+ * await client.vendor.enrichVendor("8cfec329267", {
154
+ * vendorId: 3891,
155
+ * scope: ["web_search"],
156
+ * applyEnrichmentData: true,
157
+ * fallbackMethod: "check"
158
+ * })
159
+ */
160
+ enrichVendor(entry: string, request: Payabli.VendorEnrichRequest, requestOptions?: VendorClient.RequestOptions): core.HttpResponsePromise<Payabli.VendorEnrichResponse>;
161
+ private __enrichVendor;
119
162
  }
@@ -244,7 +244,7 @@ export class VendorClient {
244
244
  });
245
245
  }
246
246
  /**
247
- * Retrieves a vendor's details.
247
+ * Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
248
248
  *
249
249
  * @param {number} idVendor - Vendor ID.
250
250
  * @param {VendorClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -284,4 +284,91 @@ export class VendorClient {
284
284
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Vendor/{idVendor}");
285
285
  });
286
286
  }
287
+ /**
288
+ * Triggers AI-powered vendor enrichment for an existing vendor. Runs one or more enrichment stages (invoice scan, web search) based on the `scope` parameter. Can automatically apply extracted payment acceptance info and vendor contact information to the vendor record, or return raw results for manual review. Contact Payabli to enable this feature.
289
+ *
290
+ * @param {string} entry - Entrypoint identifier.
291
+ * @param {Payabli.VendorEnrichRequest} request
292
+ * @param {VendorClient.RequestOptions} requestOptions - Request-specific configuration.
293
+ *
294
+ * @throws {@link Payabli.BadRequestError}
295
+ * @throws {@link Payabli.UnauthorizedError}
296
+ * @throws {@link Payabli.InternalServerError}
297
+ * @throws {@link Payabli.ServiceUnavailableError}
298
+ *
299
+ * @example
300
+ * await client.vendor.enrichVendor("8cfec329267", {
301
+ * vendorId: 3890,
302
+ * scope: ["invoice_scan"],
303
+ * applyEnrichmentData: false,
304
+ * fallbackMethod: "check",
305
+ * invoiceFile: {
306
+ * ftype: "pdf",
307
+ * filename: "invoice-2026-001.pdf",
308
+ * fContent: "<base64-encoded-pdf>"
309
+ * }
310
+ * })
311
+ *
312
+ * @example
313
+ * await client.vendor.enrichVendor("8cfec329267", {
314
+ * vendorId: 3891,
315
+ * scope: ["web_search"],
316
+ * applyEnrichmentData: false,
317
+ * fallbackMethod: "check"
318
+ * })
319
+ *
320
+ * @example
321
+ * await client.vendor.enrichVendor("8cfec329267", {
322
+ * vendorId: 3891,
323
+ * scope: ["web_search"],
324
+ * applyEnrichmentData: true,
325
+ * fallbackMethod: "check"
326
+ * })
327
+ */
328
+ enrichVendor(entry, request, requestOptions) {
329
+ return core.HttpResponsePromise.fromPromise(this.__enrichVendor(entry, request, requestOptions));
330
+ }
331
+ __enrichVendor(entry, request, requestOptions) {
332
+ return __awaiter(this, void 0, void 0, function* () {
333
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
334
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
335
+ const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
336
+ const _response = yield core.fetcher({
337
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Vendor/enrich/${core.url.encodePathParam(entry)}`),
338
+ method: "POST",
339
+ headers: _headers,
340
+ contentType: "application/json",
341
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
342
+ requestType: "json",
343
+ body: request,
344
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
345
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
346
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
347
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
348
+ logging: this._options.logging,
349
+ });
350
+ if (_response.ok) {
351
+ return { data: _response.body, rawResponse: _response.rawResponse };
352
+ }
353
+ if (_response.error.reason === "status-code") {
354
+ switch (_response.error.statusCode) {
355
+ case 400:
356
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
357
+ case 401:
358
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
359
+ case 500:
360
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
361
+ case 503:
362
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
363
+ default:
364
+ throw new errors.PayabliError({
365
+ statusCode: _response.error.statusCode,
366
+ body: _response.error.body,
367
+ rawResponse: _response.rawResponse,
368
+ });
369
+ }
370
+ }
371
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/Vendor/enrich/{entry}");
372
+ });
373
+ }
287
374
  }
@@ -1 +1,2 @@
1
1
  export * from "./client/index.mjs";
2
+ export * from "./types/index.mjs";
@@ -1 +1,2 @@
1
1
  export * from "./client/index.mjs";
2
+ export * from "./types/index.mjs";
@@ -0,0 +1,20 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Request body for the vendor enrichment endpoint.
4
+ */
5
+ export interface VendorEnrichRequest {
6
+ /** ID of the vendor to enrich. Must be active and belong to the given entrypoint. */
7
+ vendorId: number;
8
+ /** Enrichment stages to run. Valid values are `invoice_scan` and `web_search`. Stages run in order: invoice scan first, then web search. If the vendor becomes payout-ready after invoice scan, web search is skipped. */
9
+ scope?: string[] | undefined;
10
+ /** When `true` (the default), extracted data is automatically written to the vendor record. Only empty fields are populated, existing values are never overwritten. When `false`, the vendor record isn't modified. In both cases, `enrichmentData` in the response contains the extracted results. Use `false` for UI flows where users review and confirm changes before applying them with the update vendor endpoint. */
11
+ applyEnrichmentData?: boolean | undefined;
12
+ /** When `true`, triggers an AI outreach call if enrichment stages return insufficient payment acceptance info. This feature is currently in development. */
13
+ scheduleCallIfNeeded?: boolean | undefined;
14
+ /** PDF invoice file, Base64-encoded. Required when `scope` includes `invoice_scan`. */
15
+ invoiceFile?: Payabli.FileContent | undefined;
16
+ /** Bill ID to associate with this enrichment request. */
17
+ billId?: number | undefined;
18
+ /** Payment method to apply if enrichment can't find payment details. Values are `check`, `ach`, or `card`. */
19
+ fallbackMethod?: string | undefined;
20
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,12 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Response from the vendor enrichment endpoint.
4
+ */
5
+ export interface VendorEnrichResponse {
6
+ responseCode?: Payabli.Responsecode | undefined;
7
+ pageIdentifier?: Payabli.PageIdentifier | undefined;
8
+ roomId?: Payabli.RoomIdNotInUse | undefined;
9
+ isSuccess?: Payabli.IsSuccess | undefined;
10
+ responseText: Payabli.ResponseText;
11
+ responseData?: Payabli.VendorEnrichResponseData | undefined;
12
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,16 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Enrichment result details.
4
+ */
5
+ export interface VendorEnrichResponseData {
6
+ /** Unique identifier for this enrichment run. Format: `enrich-{vendorId}-{8-char hex}`. */
7
+ enrichmentId?: string | undefined;
8
+ /** Final enrichment status. Values are `completed` (vendor is payout-ready), `completed_from_network` (vendor was already enriched in the Payabli vendor network, no AI processing needed), or `insufficient` (all stages ran but the vendor still lacks sufficient payment data). */
9
+ status?: string | undefined;
10
+ /** Stages that ran successfully. A stage is only listed here if it returned a successful response. Failed stages are excluded. */
11
+ stagesTriggered?: string[] | undefined;
12
+ /** `true` if the vendor now has sufficient payment data to process a payout (ACH, card email, or check remit address). */
13
+ vendorPayoutReady?: boolean | undefined;
14
+ /** Raw extraction results from the enrichment stages that ran. */
15
+ enrichmentData?: Payabli.VendorEnrichmentData | undefined;
16
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,10 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Container for enrichment stage results.
4
+ */
5
+ export interface VendorEnrichmentData {
6
+ /** Results from the invoice scan stage, if it ran. */
7
+ invoiceScan?: Payabli.VendorEnrichmentInvoiceScan | undefined;
8
+ /** Results from the web search stage, if it ran. */
9
+ webSearch?: Payabli.VendorEnrichmentWebSearch | undefined;
10
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Vendor contact information and payment acceptance info extracted from an invoice.
3
+ */
4
+ export interface VendorEnrichmentInvoiceScan {
5
+ /** Vendor name extracted from the invoice. */
6
+ vendorName?: string | undefined;
7
+ /** Street address. */
8
+ street?: string | undefined;
9
+ /** City. */
10
+ city?: string | undefined;
11
+ /** State (two-letter abbreviation). */
12
+ state?: string | undefined;
13
+ /** ZIP code. */
14
+ zipCode?: string | undefined;
15
+ /** Country code. */
16
+ country?: string | undefined;
17
+ /** Phone number. Format isn't guaranteed and is extracted as-is from the invoice. */
18
+ phone?: string | undefined;
19
+ /** Email address. */
20
+ email?: string | undefined;
21
+ /** Payment portal URL, if found on the invoice. */
22
+ paymentLink?: string | undefined;
23
+ /** Whether the vendor accepts card payments. Values are `yes`, `no`, or `unable to determine`. */
24
+ cardAccepted?: string | undefined;
25
+ /** Whether the vendor accepts ACH payments. Values are `yes`, `no`, or `unable to determine`. */
26
+ achAccepted?: string | undefined;
27
+ /** Whether the vendor accepts check payments. Values are `yes`, `no`, or `unable to determine`. */
28
+ checkAccepted?: string | undefined;
29
+ /** Invoice number extracted from the document. */
30
+ invoiceNumber?: string | undefined;
31
+ /** Invoice amount due in USD. */
32
+ amountDue?: number | undefined;
33
+ /** Payment due date. Format is `YYYY-MM-DD`. */
34
+ dueDate?: string | undefined;
35
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Vendor contact information and payment acceptance info found through web search.
3
+ */
4
+ export interface VendorEnrichmentWebSearch {
5
+ /** Phone number found through web search. Format isn't guaranteed. */
6
+ phone?: string | undefined;
7
+ /** Phone classification. Values are `main`, `billing`, or `customer_service`. */
8
+ phoneType?: string | undefined;
9
+ /** Email address. */
10
+ email?: string | undefined;
11
+ /** Email classification. Values are `billing`, `general`, or `customer_service`. */
12
+ emailType?: string | undefined;
13
+ /** Street address. */
14
+ street?: string | undefined;
15
+ /** City. */
16
+ city?: string | undefined;
17
+ /** State (two-letter abbreviation). */
18
+ state?: string | undefined;
19
+ /** ZIP code. */
20
+ zipCode?: string | undefined;
21
+ /** Country code. */
22
+ country?: string | undefined;
23
+ /** Address classification. Values are `business`, `headquarters`, or `mailing`. */
24
+ addressType?: string | undefined;
25
+ /** Payment portal URL. */
26
+ paymentLink?: string | undefined;
27
+ /** Link classification. Values are `payment_portal`, `billing_page`, or `general_website`. */
28
+ paymentLinkType?: string | undefined;
29
+ /** Whether the vendor accepts card payments. Values are `yes`, `no`, or `unable to determine`. */
30
+ cardAccepted?: string | undefined;
31
+ /** Whether the vendor accepts ACH payments. Values are `yes`, `no`, or `unable to determine`. */
32
+ achAccepted?: string | undefined;
33
+ /** Whether the vendor accepts check payments. Values are `yes`, `no`, or `unable to determine`. */
34
+ checkAccepted?: string | undefined;
35
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ export * from "./VendorEnrichmentData.mjs";
2
+ export * from "./VendorEnrichmentInvoiceScan.mjs";
3
+ export * from "./VendorEnrichmentWebSearch.mjs";
4
+ export * from "./VendorEnrichRequest.mjs";
5
+ export * from "./VendorEnrichResponse.mjs";
6
+ export * from "./VendorEnrichResponseData.mjs";
@@ -0,0 +1,6 @@
1
+ export * from "./VendorEnrichmentData.mjs";
2
+ export * from "./VendorEnrichmentInvoiceScan.mjs";
3
+ export * from "./VendorEnrichmentWebSearch.mjs";
4
+ export * from "./VendorEnrichRequest.mjs";
5
+ export * from "./VendorEnrichResponse.mjs";
6
+ export * from "./VendorEnrichResponseData.mjs";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * When `true`, the transaction is automatically captured after a successful authorization. When `false`, you must manually capture the transaction after a successful authorization. Defaults to `false`. See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage) for more information.
3
+ */
4
+ export type AutoCapture = boolean;
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -46,7 +46,10 @@ export interface BinData {
46
46
  * Discover.
47
47
  */
48
48
  binCardBrand?: string | undefined;
49
- /** The type of card: Credit or Debit. */
49
+ /**
50
+ * The type of card: `Credit` or `Debit`. Case can vary between
51
+ * processors, so compare this value case-insensitively.
52
+ */
50
53
  binCardType?: string | undefined;
51
54
  /** The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`. */
52
55
  binCardCategory?: string | undefined;
@@ -49,7 +49,6 @@ export declare namespace NotificationContent {
49
49
  readonly ApprovedApplication: "ApprovedApplication";
50
50
  readonly FailedBoardingApplication: "FailedBoardingApplication";
51
51
  readonly SubmittedApplication: "SubmittedApplication";
52
- readonly UnderWritingApplication: "UnderWritingApplication";
53
52
  readonly ActivatedMerchant: "ActivatedMerchant";
54
53
  readonly ReceivedChargeBack: "ReceivedChargeBack";
55
54
  readonly ChargebackUpdated: "ChargebackUpdated";
@@ -32,7 +32,6 @@ export var NotificationContent;
32
32
  ApprovedApplication: "ApprovedApplication",
33
33
  FailedBoardingApplication: "FailedBoardingApplication",
34
34
  SubmittedApplication: "SubmittedApplication",
35
- UnderWritingApplication: "UnderWritingApplication",
36
35
  ActivatedMerchant: "ActivatedMerchant",
37
36
  ReceivedChargeBack: "ReceivedChargeBack",
38
37
  ChargebackUpdated: "ChargebackUpdated",
@@ -108,7 +108,6 @@ export declare namespace NotificationStandardRequest {
108
108
  readonly ApprovedApplication: "ApprovedApplication";
109
109
  readonly FailedBoardingApplication: "FailedBoardingApplication";
110
110
  readonly SubmittedApplication: "SubmittedApplication";
111
- readonly UnderWritingApplication: "UnderWritingApplication";
112
111
  readonly ActivatedMerchant: "ActivatedMerchant";
113
112
  readonly ReceivedChargeBack: "ReceivedChargeBack";
114
113
  readonly ChargebackUpdated: "ChargebackUpdated";
@@ -80,7 +80,6 @@ export var NotificationStandardRequest;
80
80
  ApprovedApplication: "ApprovedApplication",
81
81
  FailedBoardingApplication: "FailedBoardingApplication",
82
82
  SubmittedApplication: "SubmittedApplication",
83
- UnderWritingApplication: "UnderWritingApplication",
84
83
  ActivatedMerchant: "ActivatedMerchant",
85
84
  ReceivedChargeBack: "ReceivedChargeBack",
86
85
  ChargebackUpdated: "ChargebackUpdated",
@@ -15,4 +15,9 @@ export interface ProcessingSection {
15
15
  whenDelivered?: Payabli.TemplateElement | undefined;
16
16
  whenProvided?: Payabli.TemplateElement | undefined;
17
17
  whenRefunded?: Payabli.TemplateElement | undefined;
18
+ CombinedBatches?: Payabli.TemplateElement | undefined;
19
+ payoutAverageMonthlyVolume?: Payabli.TemplateElement | undefined;
20
+ payoutHighTicketAmount?: Payabli.TemplateElement | undefined;
21
+ payoutAverageTicketAmount?: Payabli.TemplateElement | undefined;
22
+ payoutCreditLimit?: Payabli.TemplateElement | undefined;
18
23
  }
@@ -51,7 +51,16 @@ export declare namespace QueryChargebacksResponse {
51
51
  Responses?: string | undefined;
52
52
  /** Reference for any scheduled transactions. */
53
53
  ScheduleReference?: number | undefined;
54
- /** Status of the transaction. */
54
+ /**
55
+ * Status of the chargeback or ACH return.
56
+ *
57
+ * - 0: Open (chargebacks only)
58
+ * - 1: Pending (chargebacks only)
59
+ * - 2: ClosedWon (chargebacks only)
60
+ * - 3: ClosedLost (chargebacks only)
61
+ * - 4: ACH return (any Nacha return code except R29)
62
+ * - 5: AchDispute (R29 only — debit block)
63
+ */
55
64
  Status?: number | undefined;
56
65
  Transaction?: Payabli.TransactionQueryRecords | undefined;
57
66
  TransactionTime?: Payabli.TransactionTime | undefined;
@@ -5,4 +5,5 @@ export interface TemplateElement {
5
5
  readOnly?: Payabli.ReadOnly | undefined;
6
6
  value?: Payabli.ValueTemplates | undefined;
7
7
  visible?: Payabli.Visible | undefined;
8
+ required?: Payabli.RequiredElement | undefined;
8
9
  }
@@ -0,0 +1,6 @@
1
+ /**
2
+ * The type of virtual card:
3
+ * - Single-use virtual card: 0
4
+ * - Ghost card: 2
5
+ */
6
+ export type VCardCardType = number;
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -3,6 +3,7 @@ import type * as Payabli from "../index.mjs";
3
3
  * @example
4
4
  * {
5
5
  * vcardSent: true,
6
+ * cardType: 0,
6
7
  * cardToken: "vcrd_5Ty8NrBzXjKuqHm9DwElfP",
7
8
  * cardNumber: "44XX XXXX XXXX 1234",
8
9
  * cvc: "XXX",
@@ -43,6 +44,7 @@ import type * as Payabli from "../index.mjs";
43
44
  export interface VCardRecord {
44
45
  /** When `true`, the vCard has been sent. */
45
46
  vcardSent?: boolean | undefined;
47
+ cardType?: Payabli.VCardCardType | undefined;
46
48
  cardToken?: string | undefined;
47
49
  /** The vCard number. */
48
50
  cardNumber?: string | undefined;
@@ -45,4 +45,16 @@ export interface VendorData {
45
45
  vendorStatus?: Payabli.Vendorstatus | undefined;
46
46
  /** Vendor's ZIP or postal code. Required if any address field is provided. For US addresses, use five digits (`12345`) or ZIP+4 format (`12345-6789`). */
47
47
  zip?: string | undefined;
48
+ /** Identifier for the vendor's default stored payment method. */
49
+ defaultMethodId?: string | undefined;
50
+ /**
51
+ * PDF invoice attachment for AI-powered vendor enrichment.
52
+ * When this feature is enabled and you include an attachment, the invoice is scanned and extracted vendor information is merged into the request.
53
+ * Fields in the request body take precedence over extracted data.
54
+ * If the scan fails, vendor creation proceeds with the original request data.
55
+ *
56
+ * See the [vendor enrichment guide](/guides/pay-out-vendor-enrichment-overview) for details.
57
+ * Contact Payabli to enable this feature.
58
+ */
59
+ attachment?: Payabli.FileContent | undefined;
48
60
  }