@moovio/sdk 0.6.0 → 0.6.2

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 (141) hide show
  1. package/README.md +38 -8
  2. package/bin/mcp-server.js +1122 -258
  3. package/bin/mcp-server.js.map +28 -11
  4. package/docs/sdks/receipts/README.md +189 -0
  5. package/docs/sdks/transfers/README.md +185 -0
  6. package/funcs/receiptsCreate.d.ts +18 -0
  7. package/funcs/receiptsCreate.d.ts.map +1 -0
  8. package/funcs/receiptsCreate.js +133 -0
  9. package/funcs/receiptsCreate.js.map +1 -0
  10. package/funcs/receiptsList.d.ts +16 -0
  11. package/funcs/receiptsList.d.ts.map +1 -0
  12. package/funcs/receiptsList.js +121 -0
  13. package/funcs/receiptsList.js.map +1 -0
  14. package/funcs/transfersCreateCancellation.d.ts +17 -0
  15. package/funcs/transfersCreateCancellation.d.ts.map +1 -0
  16. package/funcs/transfersCreateCancellation.js +128 -0
  17. package/funcs/transfersCreateCancellation.js.map +1 -0
  18. package/funcs/transfersGetCancellation.d.ts +16 -0
  19. package/funcs/transfersGetCancellation.d.ts.map +1 -0
  20. package/funcs/transfersGetCancellation.js +131 -0
  21. package/funcs/transfersGetCancellation.js.map +1 -0
  22. package/jsr.json +1 -1
  23. package/lib/config.d.ts +3 -3
  24. package/lib/config.js +3 -3
  25. package/mcp-server/mcp-server.js +1 -1
  26. package/mcp-server/server.d.ts.map +1 -1
  27. package/mcp-server/server.js +9 -1
  28. package/mcp-server/server.js.map +1 -1
  29. package/mcp-server/tools/receiptsCreate.d.ts +9 -0
  30. package/mcp-server/tools/receiptsCreate.d.ts.map +1 -0
  31. package/mcp-server/tools/receiptsCreate.js +66 -0
  32. package/mcp-server/tools/receiptsCreate.js.map +1 -0
  33. package/mcp-server/tools/receiptsList.d.ts +8 -0
  34. package/mcp-server/tools/receiptsList.d.ts.map +1 -0
  35. package/mcp-server/tools/receiptsList.js +65 -0
  36. package/mcp-server/tools/receiptsList.js.map +1 -0
  37. package/mcp-server/tools/transfersCreateCancellation.d.ts +8 -0
  38. package/mcp-server/tools/transfersCreateCancellation.d.ts.map +1 -0
  39. package/mcp-server/tools/transfersCreateCancellation.js +65 -0
  40. package/mcp-server/tools/transfersCreateCancellation.js.map +1 -0
  41. package/mcp-server/tools/transfersGetCancellation.d.ts +8 -0
  42. package/mcp-server/tools/transfersGetCancellation.d.ts.map +1 -0
  43. package/mcp-server/tools/transfersGetCancellation.js +65 -0
  44. package/mcp-server/tools/transfersGetCancellation.js.map +1 -0
  45. package/models/components/index.d.ts +4 -0
  46. package/models/components/index.d.ts.map +1 -1
  47. package/models/components/index.js +4 -0
  48. package/models/components/index.js.map +1 -1
  49. package/models/components/receiptkind.d.ts +31 -0
  50. package/models/components/receiptkind.d.ts.map +1 -0
  51. package/models/components/receiptkind.js +63 -0
  52. package/models/components/receiptkind.js.map +1 -0
  53. package/models/components/receiptrequest.d.ts +76 -0
  54. package/models/components/receiptrequest.d.ts.map +1 -0
  55. package/models/components/receiptrequest.js +80 -0
  56. package/models/components/receiptrequest.js.map +1 -0
  57. package/models/components/receiptresponse.d.ts +94 -0
  58. package/models/components/receiptresponse.d.ts.map +1 -0
  59. package/models/components/receiptresponse.js +90 -0
  60. package/models/components/receiptresponse.js.map +1 -0
  61. package/models/components/sentreceipt.d.ts +42 -0
  62. package/models/components/sentreceipt.d.ts.map +1 -0
  63. package/models/components/sentreceipt.js +73 -0
  64. package/models/components/sentreceipt.js.map +1 -0
  65. package/models/components/transfer.d.ts +3 -0
  66. package/models/components/transfer.d.ts.map +1 -1
  67. package/models/components/transfer.js +3 -0
  68. package/models/components/transfer.js.map +1 -1
  69. package/models/errors/index.d.ts +1 -0
  70. package/models/errors/index.d.ts.map +1 -1
  71. package/models/errors/index.js +1 -0
  72. package/models/errors/index.js.map +1 -1
  73. package/models/errors/receiptvalidationerror.d.ts +46 -0
  74. package/models/errors/receiptvalidationerror.d.ts.map +1 -0
  75. package/models/errors/receiptvalidationerror.js +98 -0
  76. package/models/errors/receiptvalidationerror.js.map +1 -0
  77. package/models/errors/transfer.d.ts +3 -0
  78. package/models/errors/transfer.d.ts.map +1 -1
  79. package/models/errors/transfer.js +4 -0
  80. package/models/errors/transfer.js.map +1 -1
  81. package/models/operations/createcancellation.d.ts +107 -0
  82. package/models/operations/createcancellation.d.ts.map +1 -0
  83. package/models/operations/createcancellation.js +147 -0
  84. package/models/operations/createcancellation.js.map +1 -0
  85. package/models/operations/createreceipts.d.ts +74 -0
  86. package/models/operations/createreceipts.d.ts.map +1 -0
  87. package/models/operations/createreceipts.js +118 -0
  88. package/models/operations/createreceipts.js.map +1 -0
  89. package/models/operations/getcancellation.d.ts +112 -0
  90. package/models/operations/getcancellation.d.ts.map +1 -0
  91. package/models/operations/getcancellation.js +149 -0
  92. package/models/operations/getcancellation.js.map +1 -0
  93. package/models/operations/index.d.ts +4 -0
  94. package/models/operations/index.d.ts.map +1 -1
  95. package/models/operations/index.js +4 -0
  96. package/models/operations/index.js.map +1 -1
  97. package/models/operations/listreceipts.d.ts +102 -0
  98. package/models/operations/listreceipts.d.ts.map +1 -0
  99. package/models/operations/listreceipts.js +145 -0
  100. package/models/operations/listreceipts.js.map +1 -0
  101. package/package.json +1 -1
  102. package/sdk/receipts.d.ts +20 -0
  103. package/sdk/receipts.d.ts.map +1 -0
  104. package/sdk/receipts.js +32 -0
  105. package/sdk/receipts.js.map +1 -0
  106. package/sdk/sdk.d.ts +3 -0
  107. package/sdk/sdk.d.ts.map +1 -1
  108. package/sdk/sdk.js +4 -0
  109. package/sdk/sdk.js.map +1 -1
  110. package/sdk/transfers.d.ts +14 -0
  111. package/sdk/transfers.d.ts.map +1 -1
  112. package/sdk/transfers.js +20 -0
  113. package/sdk/transfers.js.map +1 -1
  114. package/src/funcs/receiptsCreate.ts +190 -0
  115. package/src/funcs/receiptsList.ts +171 -0
  116. package/src/funcs/transfersCreateCancellation.ts +184 -0
  117. package/src/funcs/transfersGetCancellation.ts +183 -0
  118. package/src/lib/config.ts +3 -3
  119. package/src/mcp-server/mcp-server.ts +1 -1
  120. package/src/mcp-server/server.ts +9 -1
  121. package/src/mcp-server/tools/receiptsCreate.ts +39 -0
  122. package/src/mcp-server/tools/receiptsList.ts +38 -0
  123. package/src/mcp-server/tools/transfersCreateCancellation.ts +38 -0
  124. package/src/mcp-server/tools/transfersGetCancellation.ts +38 -0
  125. package/src/models/components/index.ts +4 -0
  126. package/src/models/components/receiptkind.ts +36 -0
  127. package/src/models/components/receiptrequest.ts +123 -0
  128. package/src/models/components/receiptresponse.ts +157 -0
  129. package/src/models/components/sentreceipt.ts +79 -0
  130. package/src/models/components/transfer.ts +10 -0
  131. package/src/models/errors/index.ts +1 -0
  132. package/src/models/errors/receiptvalidationerror.ts +99 -0
  133. package/src/models/errors/transfer.ts +6 -0
  134. package/src/models/operations/createcancellation.ts +229 -0
  135. package/src/models/operations/createreceipts.ts +161 -0
  136. package/src/models/operations/getcancellation.ts +236 -0
  137. package/src/models/operations/index.ts +4 -0
  138. package/src/models/operations/listreceipts.ts +222 -0
  139. package/src/sdk/receipts.ts +46 -0
  140. package/src/sdk/sdk.ts +6 -0
  141. package/src/sdk/transfers.ts +36 -0
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # moov-sdk
1
+ # Moov TypeScript
2
2
 
3
- Developer-friendly & type-safe Typescript SDK specifically catered to leverage *moov-sdk* API.
3
+ The official TypeScript SDK for using the Moov API.
4
4
 
5
5
  <div align="left">
6
6
  <a href="https://www.speakeasy.com/?utm_source=moov-sdk&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -9,11 +9,6 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
9
9
  </a>
10
10
  </div>
11
11
 
12
-
13
- <br /><br />
14
- > [!IMPORTANT]
15
- > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/moov/moov). Delete this section before > publishing to a package manager.
16
-
17
12
  <!-- Start Summary [summary] -->
18
13
  ## Summary
19
14
 
@@ -26,7 +21,7 @@ works at a high level, read our [concepts](https://docs.moov.io/guides/get-start
26
21
  <!-- Start Table of Contents [toc] -->
27
22
  ## Table of Contents
28
23
  <!-- $toc-max-depth=2 -->
29
- * [moov-sdk](#moov-sdk)
24
+ * [Moov TypeScript](#moov-typescript)
30
25
  * [SDK Installation](#sdk-installation)
31
26
  * [Requirements](#requirements)
32
27
  * [SDK Example Usage](#sdk-example-usage)
@@ -964,6 +959,17 @@ you'll need to specify the `/accounts/{accountID}/payment-methods.read` scope.
964
959
  To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
965
960
  you'll need to specify the `/ping.read` scope.
966
961
 
962
+ ### [receipts](docs/sdks/receipts/README.md)
963
+
964
+ * [create](docs/sdks/receipts/README.md#create) - Create receipts for transfers and scheduled transfers.
965
+
966
+ To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
967
+ you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
968
+ * [list](docs/sdks/receipts/README.md#list) - List receipts by trasnferID, scheduleID, or occurrenceID.
969
+
970
+ To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
971
+ you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
972
+
967
973
  ### [representatives](docs/sdks/representatives/README.md)
968
974
 
969
975
  * [create](docs/sdks/representatives/README.md#create) - Moov accounts associated with businesses require information regarding individuals who represent the business.
@@ -1110,6 +1116,14 @@ Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/o
1110
1116
 
1111
1117
  To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
1112
1118
  you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
1119
+ * [createCancellation](docs/sdks/transfers/README.md#createcancellation) - Initiate a cancellation for a card, ACH, or queued transfer.
1120
+
1121
+ To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
1122
+ to specify the `/accounts/{accountID}/transfers.write` scope.
1123
+ * [getCancellation](docs/sdks/transfers/README.md#getcancellation) - Get details of a cancellation for a transfer.
1124
+
1125
+ To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
1126
+ to specify the `/accounts/{accountID}/transfers.read` scope.
1113
1127
  * [initiateRefund](docs/sdks/transfers/README.md#initiaterefund) - Initiate a refund for a card transfer.
1114
1128
 
1115
1129
  **Use the [Cancel or refund a card transfer](https://docs.moov.io/api/money-movement/refunds/cancel/) endpoint for more comprehensive cancel and refund options.**
@@ -1715,6 +1729,14 @@ you'll need to specify the `/accounts/{accountID}/payment-methods.read` scope.
1715
1729
 
1716
1730
  To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
1717
1731
  you'll need to specify the `/ping.read` scope.
1732
+ - [`receiptsCreate`](docs/sdks/receipts/README.md#create) - Create receipts for transfers and scheduled transfers.
1733
+
1734
+ To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
1735
+ you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
1736
+ - [`receiptsList`](docs/sdks/receipts/README.md#list) - List receipts by trasnferID, scheduleID, or occurrenceID.
1737
+
1738
+ To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
1739
+ you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
1718
1740
  - [`representativesCreate`](docs/sdks/representatives/README.md#create) - Moov accounts associated with businesses require information regarding individuals who represent the business.
1719
1741
  You can provide this information by creating a representative. Each account is allowed a maximum of 7 representatives.
1720
1742
  Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.
@@ -1823,6 +1845,10 @@ Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/o
1823
1845
 
1824
1846
  To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
1825
1847
  you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
1848
+ - [`transfersCreateCancellation`](docs/sdks/transfers/README.md#createcancellation) - Initiate a cancellation for a card, ACH, or queued transfer.
1849
+
1850
+ To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
1851
+ to specify the `/accounts/{accountID}/transfers.write` scope.
1826
1852
  - [`transfersCreateReversal`](docs/sdks/transfers/README.md#createreversal) - Reverses a card transfer by initiating a cancellation or refund depending on the transaction status.
1827
1853
  Read our [reversals guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/)
1828
1854
  to learn more.
@@ -1843,6 +1869,10 @@ to learn more.
1843
1869
 
1844
1870
  To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
1845
1871
  you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
1872
+ - [`transfersGetCancellation`](docs/sdks/transfers/README.md#getcancellation) - Get details of a cancellation for a transfer.
1873
+
1874
+ To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
1875
+ to specify the `/accounts/{accountID}/transfers.read` scope.
1846
1876
  - [`transfersGetRefund`](docs/sdks/transfers/README.md#getrefund) - Get details of a refund for a card transfer.
1847
1877
 
1848
1878
  To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)