@payabli/sdk-node 0.0.141 → 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 (111) 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/cloud/client/Client.d.ts +4 -0
  6. package/dist/cjs/api/resources/cloud/client/Client.js +4 -0
  7. package/dist/cjs/api/resources/index.d.ts +3 -0
  8. package/dist/cjs/api/resources/index.js +4 -1
  9. package/dist/cjs/api/resources/management/client/Client.d.ts +41 -0
  10. package/dist/cjs/api/resources/management/client/Client.js +131 -0
  11. package/dist/cjs/api/resources/management/client/index.d.ts +1 -0
  12. package/dist/cjs/api/resources/management/client/index.js +17 -0
  13. package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.ts +25 -0
  14. package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.js +3 -0
  15. package/dist/cjs/api/resources/management/client/requests/index.d.ts +1 -0
  16. package/dist/cjs/api/resources/management/client/requests/index.js +2 -0
  17. package/dist/cjs/api/resources/management/exports.d.ts +2 -0
  18. package/dist/cjs/api/resources/management/exports.js +21 -0
  19. package/dist/cjs/api/resources/management/index.d.ts +2 -0
  20. package/dist/cjs/api/resources/management/index.js +18 -0
  21. package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.d.ts +31 -0
  22. package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.js +3 -0
  23. package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.d.ts +9 -0
  24. package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.js +3 -0
  25. package/dist/cjs/api/resources/management/types/index.d.ts +2 -0
  26. package/dist/cjs/api/resources/management/types/index.js +18 -0
  27. package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +1 -1
  28. package/dist/cjs/api/resources/moneyIn/client/Client.js +1 -1
  29. package/dist/cjs/api/resources/moneyIn/types/TransactionDetailPaymentData.d.ts +1 -1
  30. package/dist/cjs/api/resources/query/client/Client.d.ts +42 -0
  31. package/dist/cjs/api/resources/query/client/Client.js +140 -0
  32. package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.d.ts +113 -0
  33. package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.js +3 -0
  34. package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.d.ts +113 -0
  35. package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.js +3 -0
  36. package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +1 -0
  37. package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +1 -0
  38. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  39. package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.d.ts +50 -0
  40. package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.js +3 -0
  41. package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.d.ts +45 -0
  42. package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.js +3 -0
  43. package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
  44. package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
  45. package/dist/cjs/api/types/BinData.d.ts +4 -1
  46. package/dist/cjs/api/types/ProcessingSection.d.ts +5 -0
  47. package/dist/cjs/api/types/QueryChargebacksResponse.d.ts +10 -1
  48. package/dist/cjs/api/types/TemplateElement.d.ts +1 -0
  49. package/dist/cjs/api/types/VCardCardType.d.ts +6 -0
  50. package/dist/cjs/api/types/VCardCardType.js +3 -0
  51. package/dist/cjs/api/types/VCardRecord.d.ts +2 -0
  52. package/dist/cjs/api/types/index.d.ts +1 -0
  53. package/dist/cjs/api/types/index.js +1 -0
  54. package/dist/cjs/version.d.ts +1 -1
  55. package/dist/cjs/version.js +1 -1
  56. package/dist/esm/BaseClient.mjs +2 -2
  57. package/dist/esm/Client.d.mts +3 -0
  58. package/dist/esm/Client.mjs +5 -0
  59. package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -0
  60. package/dist/esm/api/resources/cloud/client/Client.mjs +4 -0
  61. package/dist/esm/api/resources/index.d.mts +3 -0
  62. package/dist/esm/api/resources/index.mjs +3 -0
  63. package/dist/esm/api/resources/management/client/Client.d.mts +41 -0
  64. package/dist/esm/api/resources/management/client/Client.mjs +94 -0
  65. package/dist/esm/api/resources/management/client/index.d.mts +1 -0
  66. package/dist/esm/api/resources/management/client/index.mjs +1 -0
  67. package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.mts +25 -0
  68. package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.mjs +2 -0
  69. package/dist/esm/api/resources/management/client/requests/index.d.mts +1 -0
  70. package/dist/esm/api/resources/management/client/requests/index.mjs +1 -0
  71. package/dist/esm/api/resources/management/exports.d.mts +2 -0
  72. package/dist/esm/api/resources/management/exports.mjs +3 -0
  73. package/dist/esm/api/resources/management/index.d.mts +2 -0
  74. package/dist/esm/api/resources/management/index.mjs +2 -0
  75. package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.d.mts +31 -0
  76. package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.mjs +2 -0
  77. package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.d.mts +9 -0
  78. package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.mjs +2 -0
  79. package/dist/esm/api/resources/management/types/index.d.mts +2 -0
  80. package/dist/esm/api/resources/management/types/index.mjs +2 -0
  81. package/dist/esm/api/resources/moneyIn/client/Client.d.mts +1 -1
  82. package/dist/esm/api/resources/moneyIn/client/Client.mjs +1 -1
  83. package/dist/esm/api/resources/moneyIn/types/TransactionDetailPaymentData.d.mts +1 -1
  84. package/dist/esm/api/resources/query/client/Client.d.mts +42 -0
  85. package/dist/esm/api/resources/query/client/Client.mjs +140 -0
  86. package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.d.mts +113 -0
  87. package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.mjs +2 -0
  88. package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.d.mts +113 -0
  89. package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.mjs +2 -0
  90. package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +1 -0
  91. package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +1 -0
  92. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  93. package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.d.mts +50 -0
  94. package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.mjs +2 -0
  95. package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.d.mts +45 -0
  96. package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.mjs +2 -0
  97. package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
  98. package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
  99. package/dist/esm/api/types/BinData.d.mts +4 -1
  100. package/dist/esm/api/types/ProcessingSection.d.mts +5 -0
  101. package/dist/esm/api/types/QueryChargebacksResponse.d.mts +10 -1
  102. package/dist/esm/api/types/TemplateElement.d.mts +1 -0
  103. package/dist/esm/api/types/VCardCardType.d.mts +6 -0
  104. package/dist/esm/api/types/VCardCardType.mjs +2 -0
  105. package/dist/esm/api/types/VCardRecord.d.mts +2 -0
  106. package/dist/esm/api/types/index.d.mts +1 -0
  107. package/dist/esm/api/types/index.mjs +1 -0
  108. package/dist/esm/version.d.mts +1 -1
  109. package/dist/esm/version.mjs +1 -1
  110. package/package.json +12 -1
  111. package/reference.md +236 -1
@@ -562,6 +562,7 @@ export * from "./UserQueryRecord.mjs";
562
562
  export * from "./UsrAccess.mjs";
563
563
  export * from "./UsrStatus.mjs";
564
564
  export * from "./ValueTemplates.mjs";
565
+ export * from "./VCardCardType.mjs";
565
566
  export * from "./VCardQueryResponse.mjs";
566
567
  export * from "./VCardRecord.mjs";
567
568
  export * from "./VCardSummary.mjs";
@@ -562,6 +562,7 @@ export * from "./UserQueryRecord.mjs";
562
562
  export * from "./UsrAccess.mjs";
563
563
  export * from "./UsrStatus.mjs";
564
564
  export * from "./ValueTemplates.mjs";
565
+ export * from "./VCardCardType.mjs";
565
566
  export * from "./VCardQueryResponse.mjs";
566
567
  export * from "./VCardRecord.mjs";
567
568
  export * from "./VCardSummary.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.141";
1
+ export declare const SDK_VERSION = "0.0.142";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.0.141";
1
+ export const SDK_VERSION = "0.0.142";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@payabli/sdk-node",
3
- "version": "0.0.141",
3
+ "version": "0.0.142",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -154,6 +154,17 @@
154
154
  },
155
155
  "default": "./dist/cjs/api/resources/lineItem/exports.js"
156
156
  },
157
+ "./management": {
158
+ "import": {
159
+ "types": "./dist/esm/api/resources/management/exports.d.mts",
160
+ "default": "./dist/esm/api/resources/management/exports.mjs"
161
+ },
162
+ "require": {
163
+ "types": "./dist/cjs/api/resources/management/exports.d.ts",
164
+ "default": "./dist/cjs/api/resources/management/exports.js"
165
+ },
166
+ "default": "./dist/cjs/api/resources/management/exports.js"
167
+ },
157
168
  "./moneyIn": {
158
169
  "import": {
159
170
  "types": "./dist/esm/api/resources/moneyIn/exports.d.mts",
package/reference.md CHANGED
@@ -2179,6 +2179,8 @@ await client.cloud.historyDevice("8cfec329267", "WXGDWB");
2179
2179
  <dl>
2180
2180
  <dd>
2181
2181
 
2182
+ Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
2183
+
2182
2184
  Get a list of cloud devices registered to an entrypoint.
2183
2185
  </dd>
2184
2186
  </dl>
@@ -6952,6 +6954,89 @@ await client.lineItem.updateItem(700, {
6952
6954
  </dl>
6953
6955
 
6954
6956
 
6957
+ </dd>
6958
+ </dl>
6959
+ </details>
6960
+
6961
+ ## Management
6962
+ <details><summary><code>client.management.<a href="/src/api/resources/management/client/Client.ts">verifyAccountDetails</a>(entry, { ...params }) -> Payabli.VerifyAccountDetailsResponse</code></summary>
6963
+ <dl>
6964
+ <dd>
6965
+
6966
+ #### 📝 Description
6967
+
6968
+ <dl>
6969
+ <dd>
6970
+
6971
+ <dl>
6972
+ <dd>
6973
+
6974
+ Verifies a bank account and returns detailed verification results from the verification network, including bank name, account status, and response codes. Unlike a pass/fail verification, this endpoint returns granular data to support decision-making and troubleshooting.
6975
+
6976
+ When bank authentication is enabled for the paypoint's organization, the endpoint performs an identity verification check on the account holder. Otherwise, it performs an account existence check. When bank authentication is enabled, the `accountHolderType` and `holderName` fields are required.
6977
+
6978
+ Requires `inboundpayments_create` or `outboundpayments_create` permission.
6979
+ </dd>
6980
+ </dl>
6981
+ </dd>
6982
+ </dl>
6983
+
6984
+ #### 🔌 Usage
6985
+
6986
+ <dl>
6987
+ <dd>
6988
+
6989
+ <dl>
6990
+ <dd>
6991
+
6992
+ ```typescript
6993
+ await client.management.verifyAccountDetails("entry752", {
6994
+ routingNumber: "122105278",
6995
+ accountNumber: "0000000016",
6996
+ accountType: "Checking",
6997
+ country: "US",
6998
+ accountHolderType: "personal",
6999
+ holderName: "Jane Doe"
7000
+ });
7001
+
7002
+ ```
7003
+ </dd>
7004
+ </dl>
7005
+ </dd>
7006
+ </dl>
7007
+
7008
+ #### ⚙️ Parameters
7009
+
7010
+ <dl>
7011
+ <dd>
7012
+
7013
+ <dl>
7014
+ <dd>
7015
+
7016
+ **entry:** `string` — The paypoint's entry name identifier.
7017
+
7018
+ </dd>
7019
+ </dl>
7020
+
7021
+ <dl>
7022
+ <dd>
7023
+
7024
+ **request:** `Payabli.VerifyAccountDetailsRequest`
7025
+
7026
+ </dd>
7027
+ </dl>
7028
+
7029
+ <dl>
7030
+ <dd>
7031
+
7032
+ **requestOptions:** `ManagementClient.RequestOptions`
7033
+
7034
+ </dd>
7035
+ </dl>
7036
+ </dd>
7037
+ </dl>
7038
+
7039
+
6955
7040
  </dd>
6956
7041
  </dl>
6957
7042
  </details>
@@ -7449,7 +7534,7 @@ await client.moneyIn.getpaid({
7449
7534
  <dl>
7450
7535
  <dd>
7451
7536
 
7452
- A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not.
7537
+ A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
7453
7538
  </dd>
7454
7539
  </dl>
7455
7540
  </dd>
@@ -13649,6 +13734,156 @@ await client.query.listCustomersOrg(123, {
13649
13734
  </dl>
13650
13735
 
13651
13736
 
13737
+ </dd>
13738
+ </dl>
13739
+ </details>
13740
+
13741
+ <details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listDevices</a>(entry, { ...params }) -> Payabli.QueryDeviceResponse</code></summary>
13742
+ <dl>
13743
+ <dd>
13744
+
13745
+ #### 📝 Description
13746
+
13747
+ <dl>
13748
+ <dd>
13749
+
13750
+ <dl>
13751
+ <dd>
13752
+
13753
+ Returns a list of cloud devices for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
13754
+ </dd>
13755
+ </dl>
13756
+ </dd>
13757
+ </dl>
13758
+
13759
+ #### 🔌 Usage
13760
+
13761
+ <dl>
13762
+ <dd>
13763
+
13764
+ <dl>
13765
+ <dd>
13766
+
13767
+ ```typescript
13768
+ await client.query.listDevices("8cfec329267", {
13769
+ fromRecord: 0,
13770
+ limitRecord: 20,
13771
+ sortBy: "desc(createdAt)"
13772
+ });
13773
+
13774
+ ```
13775
+ </dd>
13776
+ </dl>
13777
+ </dd>
13778
+ </dl>
13779
+
13780
+ #### ⚙️ Parameters
13781
+
13782
+ <dl>
13783
+ <dd>
13784
+
13785
+ <dl>
13786
+ <dd>
13787
+
13788
+ **entry:** `Payabli.Entry`
13789
+
13790
+ </dd>
13791
+ </dl>
13792
+
13793
+ <dl>
13794
+ <dd>
13795
+
13796
+ **request:** `Payabli.ListDevicesRequest`
13797
+
13798
+ </dd>
13799
+ </dl>
13800
+
13801
+ <dl>
13802
+ <dd>
13803
+
13804
+ **requestOptions:** `QueryClient.RequestOptions`
13805
+
13806
+ </dd>
13807
+ </dl>
13808
+ </dd>
13809
+ </dl>
13810
+
13811
+
13812
+ </dd>
13813
+ </dl>
13814
+ </details>
13815
+
13816
+ <details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listDevicesOrg</a>(orgId, { ...params }) -> Payabli.QueryDeviceResponse</code></summary>
13817
+ <dl>
13818
+ <dd>
13819
+
13820
+ #### 📝 Description
13821
+
13822
+ <dl>
13823
+ <dd>
13824
+
13825
+ <dl>
13826
+ <dd>
13827
+
13828
+ Returns a list of cloud devices for a single organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
13829
+ </dd>
13830
+ </dl>
13831
+ </dd>
13832
+ </dl>
13833
+
13834
+ #### 🔌 Usage
13835
+
13836
+ <dl>
13837
+ <dd>
13838
+
13839
+ <dl>
13840
+ <dd>
13841
+
13842
+ ```typescript
13843
+ await client.query.listDevicesOrg(100, {
13844
+ fromRecord: 0,
13845
+ limitRecord: 20,
13846
+ sortBy: "desc(createdAt)"
13847
+ });
13848
+
13849
+ ```
13850
+ </dd>
13851
+ </dl>
13852
+ </dd>
13853
+ </dl>
13854
+
13855
+ #### ⚙️ Parameters
13856
+
13857
+ <dl>
13858
+ <dd>
13859
+
13860
+ <dl>
13861
+ <dd>
13862
+
13863
+ **orgId:** `number` — The numeric identifier for organization, assigned by Payabli.
13864
+
13865
+ </dd>
13866
+ </dl>
13867
+
13868
+ <dl>
13869
+ <dd>
13870
+
13871
+ **request:** `Payabli.ListDevicesOrgRequest`
13872
+
13873
+ </dd>
13874
+ </dl>
13875
+
13876
+ <dl>
13877
+ <dd>
13878
+
13879
+ **requestOptions:** `QueryClient.RequestOptions`
13880
+
13881
+ </dd>
13882
+ </dl>
13883
+ </dd>
13884
+ </dl>
13885
+
13886
+
13652
13887
  </dd>
13653
13888
  </dl>
13654
13889
  </details>