increase 0.8.1 → 0.9.1

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 (279) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/README.md +31 -11
  3. package/_shims/fetch.d.ts +8 -1
  4. package/_shims/fetch.node.d.ts +11 -1
  5. package/core.d.ts +76 -28
  6. package/core.d.ts.map +1 -1
  7. package/core.js +123 -55
  8. package/core.js.map +1 -1
  9. package/core.mjs +119 -55
  10. package/core.mjs.map +1 -1
  11. package/index.js +3 -2
  12. package/index.js.map +1 -1
  13. package/index.mjs +3 -2
  14. package/index.mjs.map +1 -1
  15. package/package.json +1 -1
  16. package/pagination.d.ts +2 -2
  17. package/pagination.d.ts.map +1 -1
  18. package/pagination.js +4 -4
  19. package/pagination.js.map +1 -1
  20. package/pagination.mjs +4 -4
  21. package/pagination.mjs.map +1 -1
  22. package/resources/account-numbers.d.ts +8 -8
  23. package/resources/account-numbers.d.ts.map +1 -1
  24. package/resources/account-numbers.js.map +1 -1
  25. package/resources/account-numbers.mjs.map +1 -1
  26. package/resources/account-statements.d.ts +3 -6
  27. package/resources/account-statements.d.ts.map +1 -1
  28. package/resources/account-statements.js.map +1 -1
  29. package/resources/account-statements.mjs.map +1 -1
  30. package/resources/account-transfers.d.ts +6 -18
  31. package/resources/account-transfers.d.ts.map +1 -1
  32. package/resources/account-transfers.js.map +1 -1
  33. package/resources/account-transfers.mjs.map +1 -1
  34. package/resources/accounts.d.ts +6 -6
  35. package/resources/accounts.d.ts.map +1 -1
  36. package/resources/ach-prenotifications.d.ts +51 -7
  37. package/resources/ach-prenotifications.d.ts.map +1 -1
  38. package/resources/ach-prenotifications.js.map +1 -1
  39. package/resources/ach-prenotifications.mjs.map +1 -1
  40. package/resources/ach-transfers.d.ts +16 -9
  41. package/resources/ach-transfers.d.ts.map +1 -1
  42. package/resources/ach-transfers.js.map +1 -1
  43. package/resources/ach-transfers.mjs.map +1 -1
  44. package/resources/balance-lookups.d.ts +1 -1
  45. package/resources/balance-lookups.d.ts.map +1 -1
  46. package/resources/bookkeeping-accounts.d.ts +3 -3
  47. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  48. package/resources/bookkeeping-entries.d.ts +2 -2
  49. package/resources/bookkeeping-entries.d.ts.map +1 -1
  50. package/resources/bookkeeping-entry-sets.d.ts +1 -1
  51. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  52. package/resources/card-disputes.d.ts +7 -7
  53. package/resources/card-disputes.d.ts.map +1 -1
  54. package/resources/card-disputes.js.map +1 -1
  55. package/resources/card-disputes.mjs.map +1 -1
  56. package/resources/card-profiles.d.ts +15 -7
  57. package/resources/card-profiles.d.ts.map +1 -1
  58. package/resources/card-profiles.js +6 -0
  59. package/resources/card-profiles.js.map +1 -1
  60. package/resources/card-profiles.mjs +6 -0
  61. package/resources/card-profiles.mjs.map +1 -1
  62. package/resources/card-purchase-supplements.d.ts +3 -3
  63. package/resources/card-purchase-supplements.d.ts.map +1 -1
  64. package/resources/cards.d.ts +6 -13
  65. package/resources/cards.d.ts.map +1 -1
  66. package/resources/cards.js.map +1 -1
  67. package/resources/cards.mjs.map +1 -1
  68. package/resources/check-deposits.d.ts +7 -7
  69. package/resources/check-deposits.d.ts.map +1 -1
  70. package/resources/check-deposits.js.map +1 -1
  71. package/resources/check-deposits.mjs.map +1 -1
  72. package/resources/check-transfers.d.ts +15 -10
  73. package/resources/check-transfers.d.ts.map +1 -1
  74. package/resources/check-transfers.js.map +1 -1
  75. package/resources/check-transfers.mjs.map +1 -1
  76. package/resources/declined-transactions.d.ts +25 -28
  77. package/resources/declined-transactions.d.ts.map +1 -1
  78. package/resources/declined-transactions.js.map +1 -1
  79. package/resources/declined-transactions.mjs.map +1 -1
  80. package/resources/digital-wallet-tokens.d.ts +3 -6
  81. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  82. package/resources/digital-wallet-tokens.js.map +1 -1
  83. package/resources/digital-wallet-tokens.mjs.map +1 -1
  84. package/resources/documents.d.ts +3 -3
  85. package/resources/documents.d.ts.map +1 -1
  86. package/resources/entities/beneficial-owners.d.ts +4 -8
  87. package/resources/entities/beneficial-owners.d.ts.map +1 -1
  88. package/resources/entities/beneficial-owners.js.map +1 -1
  89. package/resources/entities/beneficial-owners.mjs.map +1 -1
  90. package/resources/entities/entities.d.ts +11 -11
  91. package/resources/entities/entities.d.ts.map +1 -1
  92. package/resources/entities/entities.js +6 -0
  93. package/resources/entities/entities.js.map +1 -1
  94. package/resources/entities/entities.mjs +6 -0
  95. package/resources/entities/entities.mjs.map +1 -1
  96. package/resources/entities/supplemental-documents.d.ts +2 -2
  97. package/resources/entities/supplemental-documents.d.ts.map +1 -1
  98. package/resources/event-subscriptions.d.ts +5 -8
  99. package/resources/event-subscriptions.d.ts.map +1 -1
  100. package/resources/event-subscriptions.js.map +1 -1
  101. package/resources/event-subscriptions.mjs.map +1 -1
  102. package/resources/events.d.ts +7 -5
  103. package/resources/events.d.ts.map +1 -1
  104. package/resources/events.js.map +1 -1
  105. package/resources/events.mjs.map +1 -1
  106. package/resources/exports.d.ts +4 -4
  107. package/resources/exports.d.ts.map +1 -1
  108. package/resources/external-accounts.d.ts +5 -11
  109. package/resources/external-accounts.d.ts.map +1 -1
  110. package/resources/external-accounts.js.map +1 -1
  111. package/resources/external-accounts.mjs.map +1 -1
  112. package/resources/files.d.ts +9 -4
  113. package/resources/files.d.ts.map +1 -1
  114. package/resources/files.js +2 -2
  115. package/resources/files.js.map +1 -1
  116. package/resources/files.mjs +2 -2
  117. package/resources/files.mjs.map +1 -1
  118. package/resources/groups.d.ts +1 -1
  119. package/resources/groups.d.ts.map +1 -1
  120. package/resources/inbound-ach-transfer-returns.d.ts +6 -4
  121. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  122. package/resources/inbound-ach-transfer-returns.js.map +1 -1
  123. package/resources/inbound-ach-transfer-returns.mjs.map +1 -1
  124. package/resources/inbound-wire-drawdown-requests.d.ts +5 -3
  125. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  126. package/resources/inbound-wire-drawdown-requests.js.map +1 -1
  127. package/resources/inbound-wire-drawdown-requests.mjs.map +1 -1
  128. package/resources/limits.d.ts +5 -9
  129. package/resources/limits.d.ts.map +1 -1
  130. package/resources/limits.js.map +1 -1
  131. package/resources/limits.mjs.map +1 -1
  132. package/resources/oauth-connections.d.ts +3 -6
  133. package/resources/oauth-connections.d.ts.map +1 -1
  134. package/resources/oauth-connections.js.map +1 -1
  135. package/resources/oauth-connections.mjs.map +1 -1
  136. package/resources/pending-transactions.d.ts +28 -37
  137. package/resources/pending-transactions.d.ts.map +1 -1
  138. package/resources/pending-transactions.js.map +1 -1
  139. package/resources/pending-transactions.mjs.map +1 -1
  140. package/resources/programs.d.ts +3 -3
  141. package/resources/programs.d.ts.map +1 -1
  142. package/resources/real-time-decisions.d.ts +2 -5
  143. package/resources/real-time-decisions.d.ts.map +1 -1
  144. package/resources/real-time-decisions.js.map +1 -1
  145. package/resources/real-time-decisions.mjs.map +1 -1
  146. package/resources/real-time-payments-transfers.d.ts +6 -4
  147. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  148. package/resources/real-time-payments-transfers.js.map +1 -1
  149. package/resources/real-time-payments-transfers.mjs.map +1 -1
  150. package/resources/routing-numbers.d.ts +4 -1
  151. package/resources/routing-numbers.d.ts.map +1 -1
  152. package/resources/routing-numbers.js.map +1 -1
  153. package/resources/routing-numbers.mjs.map +1 -1
  154. package/resources/simulations/account-statements.d.ts +1 -1
  155. package/resources/simulations/account-statements.d.ts.map +1 -1
  156. package/resources/simulations/account-transfers.d.ts +1 -1
  157. package/resources/simulations/account-transfers.d.ts.map +1 -1
  158. package/resources/simulations/ach-transfers.d.ts +124 -138
  159. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  160. package/resources/simulations/ach-transfers.js.map +1 -1
  161. package/resources/simulations/ach-transfers.mjs.map +1 -1
  162. package/resources/simulations/card-disputes.d.ts +1 -1
  163. package/resources/simulations/card-disputes.d.ts.map +1 -1
  164. package/resources/simulations/card-profiles.d.ts +1 -4
  165. package/resources/simulations/card-profiles.d.ts.map +1 -1
  166. package/resources/simulations/card-profiles.js.map +1 -1
  167. package/resources/simulations/card-profiles.mjs.map +1 -1
  168. package/resources/simulations/card-refunds.d.ts +1 -1
  169. package/resources/simulations/card-refunds.d.ts.map +1 -1
  170. package/resources/simulations/cards.d.ts +49 -58
  171. package/resources/simulations/cards.d.ts.map +1 -1
  172. package/resources/simulations/cards.js.map +1 -1
  173. package/resources/simulations/cards.mjs.map +1 -1
  174. package/resources/simulations/check-deposits.d.ts +3 -12
  175. package/resources/simulations/check-deposits.d.ts.map +1 -1
  176. package/resources/simulations/check-transfers.d.ts +2 -2
  177. package/resources/simulations/check-transfers.d.ts.map +1 -1
  178. package/resources/simulations/digital-wallet-token-requests.d.ts +1 -1
  179. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  180. package/resources/simulations/documents.d.ts +1 -4
  181. package/resources/simulations/documents.d.ts.map +1 -1
  182. package/resources/simulations/documents.js.map +1 -1
  183. package/resources/simulations/documents.mjs.map +1 -1
  184. package/resources/simulations/inbound-funds-holds.d.ts +1 -1
  185. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  186. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -1
  187. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  188. package/resources/simulations/interest-payments.d.ts +100 -108
  189. package/resources/simulations/interest-payments.d.ts.map +1 -1
  190. package/resources/simulations/interest-payments.js.map +1 -1
  191. package/resources/simulations/interest-payments.mjs.map +1 -1
  192. package/resources/simulations/programs.d.ts +1 -4
  193. package/resources/simulations/programs.d.ts.map +1 -1
  194. package/resources/simulations/programs.js.map +1 -1
  195. package/resources/simulations/programs.mjs.map +1 -1
  196. package/resources/simulations/real-time-payments-transfers.d.ts +123 -134
  197. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  198. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  199. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  200. package/resources/simulations/wire-transfers.d.ts +100 -108
  201. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  202. package/resources/simulations/wire-transfers.js.map +1 -1
  203. package/resources/simulations/wire-transfers.mjs.map +1 -1
  204. package/resources/transactions.d.ts +105 -110
  205. package/resources/transactions.d.ts.map +1 -1
  206. package/resources/transactions.js.map +1 -1
  207. package/resources/transactions.mjs.map +1 -1
  208. package/resources/wire-drawdown-requests.d.ts +4 -4
  209. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  210. package/resources/wire-transfers.d.ts +11 -11
  211. package/resources/wire-transfers.d.ts.map +1 -1
  212. package/resources/wire-transfers.js.map +1 -1
  213. package/resources/wire-transfers.mjs.map +1 -1
  214. package/src/_shims/fetch.d.ts +8 -1
  215. package/src/_shims/fetch.node.d.ts +11 -1
  216. package/src/core.ts +176 -76
  217. package/src/index.ts +2 -2
  218. package/src/pagination.ts +5 -5
  219. package/src/resources/account-numbers.ts +9 -9
  220. package/src/resources/account-statements.ts +4 -7
  221. package/src/resources/account-transfers.ts +7 -19
  222. package/src/resources/accounts.ts +7 -7
  223. package/src/resources/ach-prenotifications.ts +56 -8
  224. package/src/resources/ach-transfers.ts +18 -10
  225. package/src/resources/balance-lookups.ts +1 -1
  226. package/src/resources/bookkeeping-accounts.ts +4 -4
  227. package/src/resources/bookkeeping-entries.ts +3 -3
  228. package/src/resources/bookkeeping-entry-sets.ts +1 -1
  229. package/src/resources/card-disputes.ts +8 -8
  230. package/src/resources/card-profiles.ts +20 -8
  231. package/src/resources/card-purchase-supplements.ts +4 -4
  232. package/src/resources/cards.ts +7 -14
  233. package/src/resources/check-deposits.ts +8 -8
  234. package/src/resources/check-transfers.ts +17 -11
  235. package/src/resources/declined-transactions.ts +26 -29
  236. package/src/resources/digital-wallet-tokens.ts +4 -7
  237. package/src/resources/documents.ts +4 -4
  238. package/src/resources/entities/beneficial-owners.ts +4 -8
  239. package/src/resources/entities/entities.ts +15 -12
  240. package/src/resources/entities/supplemental-documents.ts +2 -2
  241. package/src/resources/event-subscriptions.ts +6 -9
  242. package/src/resources/events.ts +8 -6
  243. package/src/resources/exports.ts +5 -5
  244. package/src/resources/external-accounts.ts +6 -12
  245. package/src/resources/files.ts +11 -6
  246. package/src/resources/groups.ts +1 -1
  247. package/src/resources/inbound-ach-transfer-returns.ts +7 -5
  248. package/src/resources/inbound-wire-drawdown-requests.ts +6 -4
  249. package/src/resources/limits.ts +6 -10
  250. package/src/resources/oauth-connections.ts +4 -7
  251. package/src/resources/pending-transactions.ts +29 -38
  252. package/src/resources/programs.ts +4 -4
  253. package/src/resources/real-time-decisions.ts +2 -5
  254. package/src/resources/real-time-payments-transfers.ts +7 -5
  255. package/src/resources/routing-numbers.ts +4 -1
  256. package/src/resources/simulations/account-statements.ts +1 -1
  257. package/src/resources/simulations/account-transfers.ts +1 -1
  258. package/src/resources/simulations/ach-transfers.ts +124 -138
  259. package/src/resources/simulations/card-disputes.ts +1 -1
  260. package/src/resources/simulations/card-profiles.ts +1 -4
  261. package/src/resources/simulations/card-refunds.ts +1 -1
  262. package/src/resources/simulations/cards.ts +49 -58
  263. package/src/resources/simulations/check-deposits.ts +3 -3
  264. package/src/resources/simulations/check-transfers.ts +2 -2
  265. package/src/resources/simulations/digital-wallet-token-requests.ts +1 -1
  266. package/src/resources/simulations/documents.ts +1 -4
  267. package/src/resources/simulations/inbound-funds-holds.ts +1 -1
  268. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
  269. package/src/resources/simulations/interest-payments.ts +100 -108
  270. package/src/resources/simulations/programs.ts +1 -4
  271. package/src/resources/simulations/real-time-payments-transfers.ts +123 -134
  272. package/src/resources/simulations/wire-transfers.ts +100 -108
  273. package/src/resources/transactions.ts +106 -111
  274. package/src/resources/wire-drawdown-requests.ts +5 -5
  275. package/src/resources/wire-transfers.ts +12 -12
  276. package/src/version.ts +1 -1
  277. package/version.d.ts +1 -1
  278. package/version.js +1 -1
  279. package/version.mjs +1 -1
@@ -18,7 +18,7 @@ export class ACHTransfers extends APIResource {
18
18
  createInbound(
19
19
  body: ACHTransferCreateInboundParams,
20
20
  options?: Core.RequestOptions,
21
- ): Promise<Core.APIResponse<ACHTransferSimulation>> {
21
+ ): Core.APIPromise<ACHTransferSimulation> {
22
22
  return this.post('/simulations/inbound_ach_transfers', { body, ...options });
23
23
  }
24
24
 
@@ -31,7 +31,7 @@ export class ACHTransfers extends APIResource {
31
31
  achTransferId: string,
32
32
  body: ACHTransferReturnParams,
33
33
  options?: Core.RequestOptions,
34
- ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>> {
34
+ ): Core.APIPromise<ACHTransfers_.ACHTransfer> {
35
35
  return this.post(`/simulations/ach_transfers/${achTransferId}/return`, { body, ...options });
36
36
  }
37
37
 
@@ -43,10 +43,7 @@ export class ACHTransfers extends APIResource {
43
43
  * not submitted to the Federal Reserve, this endpoint allows you to skip that
44
44
  * delay and transition the ACH Transfer to a status of `submitted`.
45
45
  */
46
- submit(
47
- achTransferId: string,
48
- options?: Core.RequestOptions,
49
- ): Promise<Core.APIResponse<ACHTransfers_.ACHTransfer>> {
46
+ submit(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfers_.ACHTransfer> {
50
47
  return this.post(`/simulations/ach_transfers/${achTransferId}/submit`, options);
51
48
  }
52
49
  }
@@ -164,7 +161,7 @@ export namespace ACHTransferSimulation {
164
161
  */
165
162
  export interface Source {
166
163
  /**
167
- * A ACH Decline object. This field will be present in the JSON response if and
164
+ * An ACH Decline object. This field will be present in the JSON response if and
168
165
  * only if `category` is equal to `ach_decline`.
169
166
  */
170
167
  ach_decline: Source.ACHDecline | null;
@@ -176,24 +173,21 @@ export namespace ACHTransferSimulation {
176
173
  card_decline: Source.CardDecline | null;
177
174
 
178
175
  /**
179
- * The type of decline that took place. We may add additional possible values for
180
- * this enum over time; your application should be able to handle such additions
181
- * gracefully.
176
+ * The type of the resource. We may add additional possible values for this enum
177
+ * over time; your application should be able to handle such additions gracefully.
182
178
  *
183
- * - `ach_decline` - The Declined Transaction was created by a ACH Decline object.
184
- * Details will be under the `ach_decline` object.
185
- * - `card_decline` - The Declined Transaction was created by a Card Decline
186
- * object. Details will be under the `card_decline` object.
187
- * - `check_decline` - The Declined Transaction was created by a Check Decline
188
- * object. Details will be under the `check_decline` object.
189
- * - `inbound_real_time_payments_transfer_decline` - The Declined Transaction was
190
- * created by a Inbound Real Time Payments Transfer Decline object. Details will
191
- * be under the `inbound_real_time_payments_transfer_decline` object.
192
- * - `international_ach_decline` - The Declined Transaction was created by a
193
- * International ACH Decline object. Details will be under the
194
- * `international_ach_decline` object.
195
- * - `wire_decline` - The Declined Transaction was created by a Wire Decline
196
- * object. Details will be under the `wire_decline` object.
179
+ * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
180
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
181
+ * object.
182
+ * - `check_decline` - Check Decline: details will be under the `check_decline`
183
+ * object.
184
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
185
+ * Transfer Decline: details will be under the
186
+ * `inbound_real_time_payments_transfer_decline` object.
187
+ * - `international_ach_decline` - International ACH Decline: details will be under
188
+ * the `international_ach_decline` object.
189
+ * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
190
+ * object.
197
191
  * - `other` - The Declined Transaction was made for an undocumented or deprecated
198
192
  * reason.
199
193
  */
@@ -213,14 +207,14 @@ export namespace ACHTransferSimulation {
213
207
  check_decline: Source.CheckDecline | null;
214
208
 
215
209
  /**
216
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
217
- * in the JSON response if and only if `category` is equal to
210
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
211
+ * present in the JSON response if and only if `category` is equal to
218
212
  * `inbound_real_time_payments_transfer_decline`.
219
213
  */
220
214
  inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
221
215
 
222
216
  /**
223
- * A International ACH Decline object. This field will be present in the JSON
217
+ * An International ACH Decline object. This field will be present in the JSON
224
218
  * response if and only if `category` is equal to `international_ach_decline`.
225
219
  */
226
220
  international_ach_decline: Source.InternationalACHDecline | null;
@@ -234,7 +228,7 @@ export namespace ACHTransferSimulation {
234
228
 
235
229
  export namespace Source {
236
230
  /**
237
- * A ACH Decline object. This field will be present in the JSON response if and
231
+ * An ACH Decline object. This field will be present in the JSON response if and
238
232
  * only if `category` is equal to `ach_decline`.
239
233
  */
240
234
  export interface ACHDecline {
@@ -539,8 +533,8 @@ export namespace ACHTransferSimulation {
539
533
  }
540
534
 
541
535
  /**
542
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
543
- * in the JSON response if and only if `category` is equal to
536
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
537
+ * present in the JSON response if and only if `category` is equal to
544
538
  * `inbound_real_time_payments_transfer_decline`.
545
539
  */
546
540
  export interface InboundRealTimePaymentsTransferDecline {
@@ -615,7 +609,7 @@ export namespace ACHTransferSimulation {
615
609
  }
616
610
 
617
611
  /**
618
- * A International ACH Decline object. This field will be present in the JSON
612
+ * An International ACH Decline object. This field will be present in the JSON
619
613
  * response if and only if `category` is equal to `international_ach_decline`.
620
614
  */
621
615
  export interface InternationalACHDecline {
@@ -846,26 +840,26 @@ export namespace ACHTransferSimulation {
846
840
  */
847
841
  export interface Source {
848
842
  /**
849
- * A Account Transfer Intention object. This field will be present in the JSON
843
+ * An Account Transfer Intention object. This field will be present in the JSON
850
844
  * response if and only if `category` is equal to `account_transfer_intention`.
851
845
  */
852
846
  account_transfer_intention: Source.AccountTransferIntention | null;
853
847
 
854
848
  /**
855
- * A ACH Transfer Intention object. This field will be present in the JSON response
856
- * if and only if `category` is equal to `ach_transfer_intention`.
849
+ * An ACH Transfer Intention object. This field will be present in the JSON
850
+ * response if and only if `category` is equal to `ach_transfer_intention`.
857
851
  */
858
852
  ach_transfer_intention: Source.ACHTransferIntention | null;
859
853
 
860
854
  /**
861
- * A ACH Transfer Rejection object. This field will be present in the JSON response
862
- * if and only if `category` is equal to `ach_transfer_rejection`.
855
+ * An ACH Transfer Rejection object. This field will be present in the JSON
856
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
863
857
  */
864
858
  ach_transfer_rejection: Source.ACHTransferRejection | null;
865
859
 
866
860
  /**
867
- * A ACH Transfer Return object. This field will be present in the JSON response if
868
- * and only if `category` is equal to `ach_transfer_return`.
861
+ * An ACH Transfer Return object. This field will be present in the JSON response
862
+ * if and only if `category` is equal to `ach_transfer_return`.
869
863
  */
870
864
  ach_transfer_return: Source.ACHTransferReturn | null;
871
865
 
@@ -894,77 +888,69 @@ export namespace ACHTransferSimulation {
894
888
  card_settlement: Source.CardSettlement | null;
895
889
 
896
890
  /**
897
- * The type of transaction that took place. We may add additional possible values
898
- * for this enum over time; your application should be able to handle such
899
- * additions gracefully.
891
+ * The type of the resource. We may add additional possible values for this enum
892
+ * over time; your application should be able to handle such additions gracefully.
900
893
  *
901
- * - `account_transfer_intention` - The Transaction was created by a Account
902
- * Transfer Intention object. Details will be under the
903
- * `account_transfer_intention` object.
904
- * - `ach_transfer_intention` - The Transaction was created by a ACH Transfer
905
- * Intention object. Details will be under the `ach_transfer_intention` object.
906
- * - `ach_transfer_rejection` - The Transaction was created by a ACH Transfer
907
- * Rejection object. Details will be under the `ach_transfer_rejection` object.
908
- * - `ach_transfer_return` - The Transaction was created by a ACH Transfer Return
909
- * object. Details will be under the `ach_transfer_return` object.
910
- * - `card_dispute_acceptance` - The Transaction was created by a Card Dispute
911
- * Acceptance object. Details will be under the `card_dispute_acceptance` object.
912
- * - `card_refund` - The Transaction was created by a Card Refund object. Details
913
- * will be under the `card_refund` object.
914
- * - `card_revenue_payment` - The Transaction was created by a Card Revenue Payment
915
- * object. Details will be under the `card_revenue_payment` object.
916
- * - `card_settlement` - The Transaction was created by a Card Settlement object.
917
- * Details will be under the `card_settlement` object.
918
- * - `check_deposit_acceptance` - The Transaction was created by a Check Deposit
919
- * Acceptance object. Details will be under the `check_deposit_acceptance`
894
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
895
+ * under the `account_transfer_intention` object.
896
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
897
+ * `ach_transfer_intention` object.
898
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
899
+ * `ach_transfer_rejection` object.
900
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
901
+ * `ach_transfer_return` object.
902
+ * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
903
+ * `card_dispute_acceptance` object.
904
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
905
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
906
+ * `card_revenue_payment` object.
907
+ * - `card_settlement` - Card Settlement: details will be under the
908
+ * `card_settlement` object.
909
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
910
+ * the `check_deposit_acceptance` object.
911
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
912
+ * `check_deposit_return` object.
913
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
914
+ * `check_transfer_deposit` object.
915
+ * - `check_transfer_intention` - Check Transfer Intention: details will be under
916
+ * the `check_transfer_intention` object.
917
+ * - `check_transfer_stop_payment_request` - Check Transfer Stop Payment Request:
918
+ * details will be under the `check_transfer_stop_payment_request` object.
919
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
920
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
921
+ * the `inbound_ach_transfer` object.
922
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
923
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
924
+ * object.
925
+ * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
926
+ * object.
927
+ * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
928
+ * details will be under the `inbound_international_ach_transfer` object.
929
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
930
+ * Payments Transfer Confirmation: details will be under the
931
+ * `inbound_real_time_payments_transfer_confirmation` object.
932
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
933
+ * be under the `inbound_wire_drawdown_payment` object.
934
+ * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
935
+ * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
936
+ * object.
937
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
938
+ * `inbound_wire_reversal` object.
939
+ * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
940
+ * `inbound_wire_transfer` object.
941
+ * - `interest_payment` - Interest Payment: details will be under the
942
+ * `interest_payment` object.
943
+ * - `internal_source` - Internal Source: details will be under the
944
+ * `internal_source` object.
945
+ * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
946
+ * Acknowledgement: details will be under the
947
+ * `real_time_payments_transfer_acknowledgement` object.
948
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
920
949
  * object.
921
- * - `check_deposit_return` - The Transaction was created by a Check Deposit Return
922
- * object. Details will be under the `check_deposit_return` object.
923
- * - `check_transfer_deposit` - The Transaction was created by a Check Transfer
924
- * Deposit object. Details will be under the `check_transfer_deposit` object.
925
- * - `check_transfer_intention` - The Transaction was created by a Check Transfer
926
- * Intention object. Details will be under the `check_transfer_intention` object.
927
- * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
928
- * Transfer Stop Payment Request object. Details will be under the
929
- * `check_transfer_stop_payment_request` object.
930
- * - `fee_payment` - The Transaction was created by a Fee Payment object. Details
931
- * will be under the `fee_payment` object.
932
- * - `inbound_ach_transfer` - The Transaction was created by a Inbound ACH Transfer
933
- * object. Details will be under the `inbound_ach_transfer` object.
934
- * - `inbound_ach_transfer_return_intention` - The Transaction was created by a
935
- * Inbound ACH Transfer Return Intention object. Details will be under the
936
- * `inbound_ach_transfer_return_intention` object.
937
- * - `inbound_check` - The Transaction was created by a Inbound Check object.
938
- * Details will be under the `inbound_check` object.
939
- * - `inbound_international_ach_transfer` - The Transaction was created by a
940
- * Inbound International ACH Transfer object. Details will be under the
941
- * `inbound_international_ach_transfer` object.
942
- * - `inbound_real_time_payments_transfer_confirmation` - The Transaction was
943
- * created by a Inbound Real Time Payments Transfer Confirmation object. Details
944
- * will be under the `inbound_real_time_payments_transfer_confirmation` object.
945
- * - `inbound_wire_drawdown_payment` - The Transaction was created by a Inbound
946
- * Wire Drawdown Payment object. Details will be under the
947
- * `inbound_wire_drawdown_payment` object.
948
- * - `inbound_wire_drawdown_payment_reversal` - The Transaction was created by a
949
- * Inbound Wire Drawdown Payment Reversal object. Details will be under the
950
- * `inbound_wire_drawdown_payment_reversal` object.
951
- * - `inbound_wire_reversal` - The Transaction was created by a Inbound Wire
952
- * Reversal object. Details will be under the `inbound_wire_reversal` object.
953
- * - `inbound_wire_transfer` - The Transaction was created by a Inbound Wire
954
- * Transfer object. Details will be under the `inbound_wire_transfer` object.
955
- * - `interest_payment` - The Transaction was created by a Interest Payment object.
956
- * Details will be under the `interest_payment` object.
957
- * - `internal_source` - The Transaction was created by a Internal Source object.
958
- * Details will be under the `internal_source` object.
959
- * - `real_time_payments_transfer_acknowledgement` - The Transaction was created by
960
- * a Real Time Payments Transfer Acknowledgement object. Details will be under
961
- * the `real_time_payments_transfer_acknowledgement` object.
962
- * - `sample_funds` - The Transaction was created by a Sample Funds object. Details
963
- * will be under the `sample_funds` object.
964
- * - `wire_transfer_intention` - The Transaction was created by a Wire Transfer
965
- * Intention object. Details will be under the `wire_transfer_intention` object.
966
- * - `wire_transfer_rejection` - The Transaction was created by a Wire Transfer
967
- * Rejection object. Details will be under the `wire_transfer_rejection` object.
950
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
951
+ * `wire_transfer_intention` object.
952
+ * - `wire_transfer_rejection` - Wire Transfer Rejection: details will be under the
953
+ * `wire_transfer_rejection` object.
968
954
  * - `other` - The Transaction was made for an undocumented or deprecated reason.
969
955
  */
970
956
  category:
@@ -1037,65 +1023,65 @@ export namespace ACHTransferSimulation {
1037
1023
  fee_payment: Source.FeePayment | null;
1038
1024
 
1039
1025
  /**
1040
- * A Inbound ACH Transfer object. This field will be present in the JSON response
1041
- * if and only if `category` is equal to `inbound_ach_transfer`.
1026
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
1027
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
1042
1028
  */
1043
1029
  inbound_ach_transfer: Source.InboundACHTransfer | null;
1044
1030
 
1045
1031
  /**
1046
- * A Inbound Check object. This field will be present in the JSON response if and
1032
+ * An Inbound Check object. This field will be present in the JSON response if and
1047
1033
  * only if `category` is equal to `inbound_check`.
1048
1034
  */
1049
1035
  inbound_check: Source.InboundCheck | null;
1050
1036
 
1051
1037
  /**
1052
- * A Inbound International ACH Transfer object. This field will be present in the
1038
+ * An Inbound International ACH Transfer object. This field will be present in the
1053
1039
  * JSON response if and only if `category` is equal to
1054
1040
  * `inbound_international_ach_transfer`.
1055
1041
  */
1056
1042
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1057
1043
 
1058
1044
  /**
1059
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1045
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1060
1046
  * present in the JSON response if and only if `category` is equal to
1061
1047
  * `inbound_real_time_payments_transfer_confirmation`.
1062
1048
  */
1063
1049
  inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
1064
1050
 
1065
1051
  /**
1066
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1052
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
1067
1053
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1068
1054
  */
1069
1055
  inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
1070
1056
 
1071
1057
  /**
1072
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1058
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
1073
1059
  * the JSON response if and only if `category` is equal to
1074
1060
  * `inbound_wire_drawdown_payment_reversal`.
1075
1061
  */
1076
1062
  inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
1077
1063
 
1078
1064
  /**
1079
- * A Inbound Wire Reversal object. This field will be present in the JSON response
1065
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
1080
1066
  * if and only if `category` is equal to `inbound_wire_reversal`.
1081
1067
  */
1082
1068
  inbound_wire_reversal: Source.InboundWireReversal | null;
1083
1069
 
1084
1070
  /**
1085
- * A Inbound Wire Transfer object. This field will be present in the JSON response
1071
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
1086
1072
  * if and only if `category` is equal to `inbound_wire_transfer`.
1087
1073
  */
1088
1074
  inbound_wire_transfer: Source.InboundWireTransfer | null;
1089
1075
 
1090
1076
  /**
1091
- * A Interest Payment object. This field will be present in the JSON response if
1077
+ * An Interest Payment object. This field will be present in the JSON response if
1092
1078
  * and only if `category` is equal to `interest_payment`.
1093
1079
  */
1094
1080
  interest_payment: Source.InterestPayment | null;
1095
1081
 
1096
1082
  /**
1097
- * A Internal Source object. This field will be present in the JSON response if and
1098
- * only if `category` is equal to `internal_source`.
1083
+ * An Internal Source object. This field will be present in the JSON response if
1084
+ * and only if `category` is equal to `internal_source`.
1099
1085
  */
1100
1086
  internal_source: Source.InternalSource | null;
1101
1087
 
@@ -1127,7 +1113,7 @@ export namespace ACHTransferSimulation {
1127
1113
 
1128
1114
  export namespace Source {
1129
1115
  /**
1130
- * A Account Transfer Intention object. This field will be present in the JSON
1116
+ * An Account Transfer Intention object. This field will be present in the JSON
1131
1117
  * response if and only if `category` is equal to `account_transfer_intention`.
1132
1118
  */
1133
1119
  export interface AccountTransferIntention {
@@ -1172,8 +1158,8 @@ export namespace ACHTransferSimulation {
1172
1158
  }
1173
1159
 
1174
1160
  /**
1175
- * A ACH Transfer Intention object. This field will be present in the JSON response
1176
- * if and only if `category` is equal to `ach_transfer_intention`.
1161
+ * An ACH Transfer Intention object. This field will be present in the JSON
1162
+ * response if and only if `category` is equal to `ach_transfer_intention`.
1177
1163
  */
1178
1164
  export interface ACHTransferIntention {
1179
1165
  account_number: string;
@@ -1195,8 +1181,8 @@ export namespace ACHTransferSimulation {
1195
1181
  }
1196
1182
 
1197
1183
  /**
1198
- * A ACH Transfer Rejection object. This field will be present in the JSON response
1199
- * if and only if `category` is equal to `ach_transfer_rejection`.
1184
+ * An ACH Transfer Rejection object. This field will be present in the JSON
1185
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
1200
1186
  */
1201
1187
  export interface ACHTransferRejection {
1202
1188
  /**
@@ -1206,8 +1192,8 @@ export namespace ACHTransferSimulation {
1206
1192
  }
1207
1193
 
1208
1194
  /**
1209
- * A ACH Transfer Return object. This field will be present in the JSON response if
1210
- * and only if `category` is equal to `ach_transfer_return`.
1195
+ * An ACH Transfer Return object. This field will be present in the JSON response
1196
+ * if and only if `category` is equal to `ach_transfer_return`.
1211
1197
  */
1212
1198
  export interface ACHTransferReturn {
1213
1199
  /**
@@ -3030,8 +3016,8 @@ export namespace ACHTransferSimulation {
3030
3016
  }
3031
3017
 
3032
3018
  /**
3033
- * A Inbound ACH Transfer object. This field will be present in the JSON response
3034
- * if and only if `category` is equal to `inbound_ach_transfer`.
3019
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
3020
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
3035
3021
  */
3036
3022
  export interface InboundACHTransfer {
3037
3023
  /**
@@ -3058,7 +3044,7 @@ export namespace ACHTransferSimulation {
3058
3044
  }
3059
3045
 
3060
3046
  /**
3061
- * A Inbound Check object. This field will be present in the JSON response if and
3047
+ * An Inbound Check object. This field will be present in the JSON response if and
3062
3048
  * only if `category` is equal to `inbound_check`.
3063
3049
  */
3064
3050
  export interface InboundCheck {
@@ -3089,7 +3075,7 @@ export namespace ACHTransferSimulation {
3089
3075
  }
3090
3076
 
3091
3077
  /**
3092
- * A Inbound International ACH Transfer object. This field will be present in the
3078
+ * An Inbound International ACH Transfer object. This field will be present in the
3093
3079
  * JSON response if and only if `category` is equal to
3094
3080
  * `inbound_international_ach_transfer`.
3095
3081
  */
@@ -3172,7 +3158,7 @@ export namespace ACHTransferSimulation {
3172
3158
  }
3173
3159
 
3174
3160
  /**
3175
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
3161
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
3176
3162
  * present in the JSON response if and only if `category` is equal to
3177
3163
  * `inbound_real_time_payments_transfer_confirmation`.
3178
3164
  */
@@ -3228,7 +3214,7 @@ export namespace ACHTransferSimulation {
3228
3214
  }
3229
3215
 
3230
3216
  /**
3231
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
3217
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
3232
3218
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
3233
3219
  */
3234
3220
  export interface InboundWireDrawdownPayment {
@@ -3264,7 +3250,7 @@ export namespace ACHTransferSimulation {
3264
3250
  }
3265
3251
 
3266
3252
  /**
3267
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
3253
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
3268
3254
  * the JSON response if and only if `category` is equal to
3269
3255
  * `inbound_wire_drawdown_payment_reversal`.
3270
3256
  */
@@ -3321,7 +3307,7 @@ export namespace ACHTransferSimulation {
3321
3307
  }
3322
3308
 
3323
3309
  /**
3324
- * A Inbound Wire Reversal object. This field will be present in the JSON response
3310
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
3325
3311
  * if and only if `category` is equal to `inbound_wire_reversal`.
3326
3312
  */
3327
3313
  export interface InboundWireReversal {
@@ -3404,7 +3390,7 @@ export namespace ACHTransferSimulation {
3404
3390
  }
3405
3391
 
3406
3392
  /**
3407
- * A Inbound Wire Transfer object. This field will be present in the JSON response
3393
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
3408
3394
  * if and only if `category` is equal to `inbound_wire_transfer`.
3409
3395
  */
3410
3396
  export interface InboundWireTransfer {
@@ -3448,7 +3434,7 @@ export namespace ACHTransferSimulation {
3448
3434
  }
3449
3435
 
3450
3436
  /**
3451
- * A Interest Payment object. This field will be present in the JSON response if
3437
+ * An Interest Payment object. This field will be present in the JSON response if
3452
3438
  * and only if `category` is equal to `interest_payment`.
3453
3439
  */
3454
3440
  export interface InterestPayment {
@@ -3488,8 +3474,8 @@ export namespace ACHTransferSimulation {
3488
3474
  }
3489
3475
 
3490
3476
  /**
3491
- * A Internal Source object. This field will be present in the JSON response if and
3492
- * only if `category` is equal to `internal_source`.
3477
+ * An Internal Source object. This field will be present in the JSON response if
3478
+ * and only if `category` is equal to `internal_source`.
3493
3479
  */
3494
3480
  export interface InternalSource {
3495
3481
  /**
@@ -16,7 +16,7 @@ export class CardDisputes extends APIResource {
16
16
  cardDisputeId: string,
17
17
  body: CardDisputeActionParams,
18
18
  options?: Core.RequestOptions,
19
- ): Promise<Core.APIResponse<CardDisputes_.CardDispute>> {
19
+ ): Core.APIPromise<CardDisputes_.CardDispute> {
20
20
  return this.post(`/simulations/card_disputes/${cardDisputeId}/action`, { body, ...options });
21
21
  }
22
22
  }
@@ -12,10 +12,7 @@ export class CardProfiles extends APIResource {
12
12
  * the webhooks Increase sends when the Card Profile is approved and updates the
13
13
  * status of the Card Profile.
14
14
  */
15
- approve(
16
- cardProfileId: string,
17
- options?: Core.RequestOptions,
18
- ): Promise<Core.APIResponse<CardProfiles_.CardProfile>> {
15
+ approve(cardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<CardProfiles_.CardProfile> {
19
16
  return this.post(`/simulations/card_profiles/${cardProfileId}/approve`, options);
20
17
  }
21
18
  }
@@ -13,7 +13,7 @@ export class CardRefunds extends APIResource {
13
13
  create(
14
14
  body: CardRefundCreateParams,
15
15
  options?: Core.RequestOptions,
16
- ): Promise<Core.APIResponse<Transactions.Transaction>> {
16
+ ): Core.APIPromise<Transactions.Transaction> {
17
17
  return this.post('/simulations/card_refunds', { body, ...options });
18
18
  }
19
19
  }