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
@@ -16,7 +16,7 @@ export class RealTimePaymentsTransfers extends APIResource {
16
16
  realTimePaymentsTransferId: string,
17
17
  body: RealTimePaymentsTransferCompleteParams,
18
18
  options?: Core.RequestOptions,
19
- ): Promise<Core.APIResponse<RealTimePaymentsTransfers_.RealTimePaymentsTransfer>> {
19
+ ): Core.APIPromise<RealTimePaymentsTransfers_.RealTimePaymentsTransfer> {
20
20
  return this.post(`/simulations/real_time_payments_transfers/${realTimePaymentsTransferId}/complete`, {
21
21
  body,
22
22
  ...options,
@@ -30,7 +30,7 @@ export class RealTimePaymentsTransfers extends APIResource {
30
30
  createInbound(
31
31
  body: RealTimePaymentsTransferCreateInboundParams,
32
32
  options?: Core.RequestOptions,
33
- ): Promise<Core.APIResponse<InboundRealTimePaymentsTransferSimulationResult>> {
33
+ ): Core.APIPromise<InboundRealTimePaymentsTransferSimulationResult> {
34
34
  return this.post('/simulations/inbound_real_time_payments_transfers', { body, ...options });
35
35
  }
36
36
  }
@@ -150,7 +150,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
150
150
  */
151
151
  export interface Source {
152
152
  /**
153
- * A ACH Decline object. This field will be present in the JSON response if and
153
+ * An ACH Decline object. This field will be present in the JSON response if and
154
154
  * only if `category` is equal to `ach_decline`.
155
155
  */
156
156
  ach_decline: Source.ACHDecline | null;
@@ -162,24 +162,21 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
162
162
  card_decline: Source.CardDecline | null;
163
163
 
164
164
  /**
165
- * The type of decline that took place. We may add additional possible values for
166
- * this enum over time; your application should be able to handle such additions
167
- * gracefully.
165
+ * The type of the resource. We may add additional possible values for this enum
166
+ * over time; your application should be able to handle such additions gracefully.
168
167
  *
169
- * - `ach_decline` - The Declined Transaction was created by a ACH Decline object.
170
- * Details will be under the `ach_decline` object.
171
- * - `card_decline` - The Declined Transaction was created by a Card Decline
172
- * object. Details will be under the `card_decline` object.
173
- * - `check_decline` - The Declined Transaction was created by a Check Decline
174
- * object. Details will be under the `check_decline` object.
175
- * - `inbound_real_time_payments_transfer_decline` - The Declined Transaction was
176
- * created by a Inbound Real Time Payments Transfer Decline object. Details will
177
- * be under the `inbound_real_time_payments_transfer_decline` object.
178
- * - `international_ach_decline` - The Declined Transaction was created by a
179
- * International ACH Decline object. Details will be under the
180
- * `international_ach_decline` object.
181
- * - `wire_decline` - The Declined Transaction was created by a Wire Decline
182
- * object. Details will be under the `wire_decline` object.
168
+ * - `ach_decline` - ACH Decline: details will be under the `ach_decline` object.
169
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
170
+ * object.
171
+ * - `check_decline` - Check Decline: details will be under the `check_decline`
172
+ * object.
173
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
174
+ * Transfer Decline: details will be under the
175
+ * `inbound_real_time_payments_transfer_decline` object.
176
+ * - `international_ach_decline` - International ACH Decline: details will be under
177
+ * the `international_ach_decline` object.
178
+ * - `wire_decline` - Wire Decline: details will be under the `wire_decline`
179
+ * object.
183
180
  * - `other` - The Declined Transaction was made for an undocumented or deprecated
184
181
  * reason.
185
182
  */
@@ -199,14 +196,14 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
199
196
  check_decline: Source.CheckDecline | null;
200
197
 
201
198
  /**
202
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
203
- * in the JSON response if and only if `category` is equal to
199
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
200
+ * present in the JSON response if and only if `category` is equal to
204
201
  * `inbound_real_time_payments_transfer_decline`.
205
202
  */
206
203
  inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
207
204
 
208
205
  /**
209
- * A International ACH Decline object. This field will be present in the JSON
206
+ * An International ACH Decline object. This field will be present in the JSON
210
207
  * response if and only if `category` is equal to `international_ach_decline`.
211
208
  */
212
209
  international_ach_decline: Source.InternationalACHDecline | null;
@@ -220,7 +217,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
220
217
 
221
218
  export namespace Source {
222
219
  /**
223
- * A ACH Decline object. This field will be present in the JSON response if and
220
+ * An ACH Decline object. This field will be present in the JSON response if and
224
221
  * only if `category` is equal to `ach_decline`.
225
222
  */
226
223
  export interface ACHDecline {
@@ -525,8 +522,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
525
522
  }
526
523
 
527
524
  /**
528
- * A Inbound Real Time Payments Transfer Decline object. This field will be present
529
- * in the JSON response if and only if `category` is equal to
525
+ * An Inbound Real Time Payments Transfer Decline object. This field will be
526
+ * present in the JSON response if and only if `category` is equal to
530
527
  * `inbound_real_time_payments_transfer_decline`.
531
528
  */
532
529
  export interface InboundRealTimePaymentsTransferDecline {
@@ -601,7 +598,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
601
598
  }
602
599
 
603
600
  /**
604
- * A International ACH Decline object. This field will be present in the JSON
601
+ * An International ACH Decline object. This field will be present in the JSON
605
602
  * response if and only if `category` is equal to `international_ach_decline`.
606
603
  */
607
604
  export interface InternationalACHDecline {
@@ -832,26 +829,26 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
832
829
  */
833
830
  export interface Source {
834
831
  /**
835
- * A Account Transfer Intention object. This field will be present in the JSON
832
+ * An Account Transfer Intention object. This field will be present in the JSON
836
833
  * response if and only if `category` is equal to `account_transfer_intention`.
837
834
  */
838
835
  account_transfer_intention: Source.AccountTransferIntention | null;
839
836
 
840
837
  /**
841
- * A ACH Transfer Intention object. This field will be present in the JSON response
842
- * if and only if `category` is equal to `ach_transfer_intention`.
838
+ * An ACH Transfer Intention object. This field will be present in the JSON
839
+ * response if and only if `category` is equal to `ach_transfer_intention`.
843
840
  */
844
841
  ach_transfer_intention: Source.ACHTransferIntention | null;
845
842
 
846
843
  /**
847
- * A ACH Transfer Rejection object. This field will be present in the JSON response
848
- * if and only if `category` is equal to `ach_transfer_rejection`.
844
+ * An ACH Transfer Rejection object. This field will be present in the JSON
845
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
849
846
  */
850
847
  ach_transfer_rejection: Source.ACHTransferRejection | null;
851
848
 
852
849
  /**
853
- * A ACH Transfer Return object. This field will be present in the JSON response if
854
- * and only if `category` is equal to `ach_transfer_return`.
850
+ * An ACH Transfer Return object. This field will be present in the JSON response
851
+ * if and only if `category` is equal to `ach_transfer_return`.
855
852
  */
856
853
  ach_transfer_return: Source.ACHTransferReturn | null;
857
854
 
@@ -880,77 +877,69 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
880
877
  card_settlement: Source.CardSettlement | null;
881
878
 
882
879
  /**
883
- * The type of transaction that took place. We may add additional possible values
884
- * for this enum over time; your application should be able to handle such
885
- * additions gracefully.
880
+ * The type of the resource. We may add additional possible values for this enum
881
+ * over time; your application should be able to handle such additions gracefully.
886
882
  *
887
- * - `account_transfer_intention` - The Transaction was created by a Account
888
- * Transfer Intention object. Details will be under the
889
- * `account_transfer_intention` object.
890
- * - `ach_transfer_intention` - The Transaction was created by a ACH Transfer
891
- * Intention object. Details will be under the `ach_transfer_intention` object.
892
- * - `ach_transfer_rejection` - The Transaction was created by a ACH Transfer
893
- * Rejection object. Details will be under the `ach_transfer_rejection` object.
894
- * - `ach_transfer_return` - The Transaction was created by a ACH Transfer Return
895
- * object. Details will be under the `ach_transfer_return` object.
896
- * - `card_dispute_acceptance` - The Transaction was created by a Card Dispute
897
- * Acceptance object. Details will be under the `card_dispute_acceptance` object.
898
- * - `card_refund` - The Transaction was created by a Card Refund object. Details
899
- * will be under the `card_refund` object.
900
- * - `card_revenue_payment` - The Transaction was created by a Card Revenue Payment
901
- * object. Details will be under the `card_revenue_payment` object.
902
- * - `card_settlement` - The Transaction was created by a Card Settlement object.
903
- * Details will be under the `card_settlement` object.
904
- * - `check_deposit_acceptance` - The Transaction was created by a Check Deposit
905
- * Acceptance object. Details will be under the `check_deposit_acceptance`
883
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
884
+ * under the `account_transfer_intention` object.
885
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
886
+ * `ach_transfer_intention` object.
887
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
888
+ * `ach_transfer_rejection` object.
889
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
890
+ * `ach_transfer_return` object.
891
+ * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
892
+ * `card_dispute_acceptance` object.
893
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
894
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
895
+ * `card_revenue_payment` object.
896
+ * - `card_settlement` - Card Settlement: details will be under the
897
+ * `card_settlement` object.
898
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
899
+ * the `check_deposit_acceptance` object.
900
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
901
+ * `check_deposit_return` object.
902
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
903
+ * `check_transfer_deposit` object.
904
+ * - `check_transfer_intention` - Check Transfer Intention: details will be under
905
+ * the `check_transfer_intention` object.
906
+ * - `check_transfer_stop_payment_request` - Check Transfer Stop Payment Request:
907
+ * details will be under the `check_transfer_stop_payment_request` object.
908
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
909
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
910
+ * the `inbound_ach_transfer` object.
911
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
912
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
913
+ * object.
914
+ * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
915
+ * object.
916
+ * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
917
+ * details will be under the `inbound_international_ach_transfer` object.
918
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
919
+ * Payments Transfer Confirmation: details will be under the
920
+ * `inbound_real_time_payments_transfer_confirmation` object.
921
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
922
+ * be under the `inbound_wire_drawdown_payment` object.
923
+ * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
924
+ * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
925
+ * object.
926
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
927
+ * `inbound_wire_reversal` object.
928
+ * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
929
+ * `inbound_wire_transfer` object.
930
+ * - `interest_payment` - Interest Payment: details will be under the
931
+ * `interest_payment` object.
932
+ * - `internal_source` - Internal Source: details will be under the
933
+ * `internal_source` object.
934
+ * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
935
+ * Acknowledgement: details will be under the
936
+ * `real_time_payments_transfer_acknowledgement` object.
937
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
906
938
  * object.
907
- * - `check_deposit_return` - The Transaction was created by a Check Deposit Return
908
- * object. Details will be under the `check_deposit_return` object.
909
- * - `check_transfer_deposit` - The Transaction was created by a Check Transfer
910
- * Deposit object. Details will be under the `check_transfer_deposit` object.
911
- * - `check_transfer_intention` - The Transaction was created by a Check Transfer
912
- * Intention object. Details will be under the `check_transfer_intention` object.
913
- * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
914
- * Transfer Stop Payment Request object. Details will be under the
915
- * `check_transfer_stop_payment_request` object.
916
- * - `fee_payment` - The Transaction was created by a Fee Payment object. Details
917
- * will be under the `fee_payment` object.
918
- * - `inbound_ach_transfer` - The Transaction was created by a Inbound ACH Transfer
919
- * object. Details will be under the `inbound_ach_transfer` object.
920
- * - `inbound_ach_transfer_return_intention` - The Transaction was created by a
921
- * Inbound ACH Transfer Return Intention object. Details will be under the
922
- * `inbound_ach_transfer_return_intention` object.
923
- * - `inbound_check` - The Transaction was created by a Inbound Check object.
924
- * Details will be under the `inbound_check` object.
925
- * - `inbound_international_ach_transfer` - The Transaction was created by a
926
- * Inbound International ACH Transfer object. Details will be under the
927
- * `inbound_international_ach_transfer` object.
928
- * - `inbound_real_time_payments_transfer_confirmation` - The Transaction was
929
- * created by a Inbound Real Time Payments Transfer Confirmation object. Details
930
- * will be under the `inbound_real_time_payments_transfer_confirmation` object.
931
- * - `inbound_wire_drawdown_payment` - The Transaction was created by a Inbound
932
- * Wire Drawdown Payment object. Details will be under the
933
- * `inbound_wire_drawdown_payment` object.
934
- * - `inbound_wire_drawdown_payment_reversal` - The Transaction was created by a
935
- * Inbound Wire Drawdown Payment Reversal object. Details will be under the
936
- * `inbound_wire_drawdown_payment_reversal` object.
937
- * - `inbound_wire_reversal` - The Transaction was created by a Inbound Wire
938
- * Reversal object. Details will be under the `inbound_wire_reversal` object.
939
- * - `inbound_wire_transfer` - The Transaction was created by a Inbound Wire
940
- * Transfer object. Details will be under the `inbound_wire_transfer` object.
941
- * - `interest_payment` - The Transaction was created by a Interest Payment object.
942
- * Details will be under the `interest_payment` object.
943
- * - `internal_source` - The Transaction was created by a Internal Source object.
944
- * Details will be under the `internal_source` object.
945
- * - `real_time_payments_transfer_acknowledgement` - The Transaction was created by
946
- * a Real Time Payments Transfer Acknowledgement object. Details will be under
947
- * the `real_time_payments_transfer_acknowledgement` object.
948
- * - `sample_funds` - The Transaction was created by a Sample Funds object. Details
949
- * will be under the `sample_funds` object.
950
- * - `wire_transfer_intention` - The Transaction was created by a Wire Transfer
951
- * Intention object. Details will be under the `wire_transfer_intention` object.
952
- * - `wire_transfer_rejection` - The Transaction was created by a Wire Transfer
953
- * Rejection object. Details will be under the `wire_transfer_rejection` object.
939
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
940
+ * `wire_transfer_intention` object.
941
+ * - `wire_transfer_rejection` - Wire Transfer Rejection: details will be under the
942
+ * `wire_transfer_rejection` object.
954
943
  * - `other` - The Transaction was made for an undocumented or deprecated reason.
955
944
  */
956
945
  category:
@@ -1023,65 +1012,65 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1023
1012
  fee_payment: Source.FeePayment | null;
1024
1013
 
1025
1014
  /**
1026
- * A Inbound ACH Transfer object. This field will be present in the JSON response
1027
- * if and only if `category` is equal to `inbound_ach_transfer`.
1015
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
1016
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
1028
1017
  */
1029
1018
  inbound_ach_transfer: Source.InboundACHTransfer | null;
1030
1019
 
1031
1020
  /**
1032
- * A Inbound Check object. This field will be present in the JSON response if and
1021
+ * An Inbound Check object. This field will be present in the JSON response if and
1033
1022
  * only if `category` is equal to `inbound_check`.
1034
1023
  */
1035
1024
  inbound_check: Source.InboundCheck | null;
1036
1025
 
1037
1026
  /**
1038
- * A Inbound International ACH Transfer object. This field will be present in the
1027
+ * An Inbound International ACH Transfer object. This field will be present in the
1039
1028
  * JSON response if and only if `category` is equal to
1040
1029
  * `inbound_international_ach_transfer`.
1041
1030
  */
1042
1031
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1043
1032
 
1044
1033
  /**
1045
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
1034
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1046
1035
  * present in the JSON response if and only if `category` is equal to
1047
1036
  * `inbound_real_time_payments_transfer_confirmation`.
1048
1037
  */
1049
1038
  inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
1050
1039
 
1051
1040
  /**
1052
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
1041
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
1053
1042
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1054
1043
  */
1055
1044
  inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
1056
1045
 
1057
1046
  /**
1058
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
1047
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
1059
1048
  * the JSON response if and only if `category` is equal to
1060
1049
  * `inbound_wire_drawdown_payment_reversal`.
1061
1050
  */
1062
1051
  inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
1063
1052
 
1064
1053
  /**
1065
- * A Inbound Wire Reversal object. This field will be present in the JSON response
1054
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
1066
1055
  * if and only if `category` is equal to `inbound_wire_reversal`.
1067
1056
  */
1068
1057
  inbound_wire_reversal: Source.InboundWireReversal | null;
1069
1058
 
1070
1059
  /**
1071
- * A Inbound Wire Transfer object. This field will be present in the JSON response
1060
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
1072
1061
  * if and only if `category` is equal to `inbound_wire_transfer`.
1073
1062
  */
1074
1063
  inbound_wire_transfer: Source.InboundWireTransfer | null;
1075
1064
 
1076
1065
  /**
1077
- * A Interest Payment object. This field will be present in the JSON response if
1066
+ * An Interest Payment object. This field will be present in the JSON response if
1078
1067
  * and only if `category` is equal to `interest_payment`.
1079
1068
  */
1080
1069
  interest_payment: Source.InterestPayment | null;
1081
1070
 
1082
1071
  /**
1083
- * A Internal Source object. This field will be present in the JSON response if and
1084
- * only if `category` is equal to `internal_source`.
1072
+ * An Internal Source object. This field will be present in the JSON response if
1073
+ * and only if `category` is equal to `internal_source`.
1085
1074
  */
1086
1075
  internal_source: Source.InternalSource | null;
1087
1076
 
@@ -1113,7 +1102,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1113
1102
 
1114
1103
  export namespace Source {
1115
1104
  /**
1116
- * A Account Transfer Intention object. This field will be present in the JSON
1105
+ * An Account Transfer Intention object. This field will be present in the JSON
1117
1106
  * response if and only if `category` is equal to `account_transfer_intention`.
1118
1107
  */
1119
1108
  export interface AccountTransferIntention {
@@ -1158,8 +1147,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1158
1147
  }
1159
1148
 
1160
1149
  /**
1161
- * A ACH Transfer Intention object. This field will be present in the JSON response
1162
- * if and only if `category` is equal to `ach_transfer_intention`.
1150
+ * An ACH Transfer Intention object. This field will be present in the JSON
1151
+ * response if and only if `category` is equal to `ach_transfer_intention`.
1163
1152
  */
1164
1153
  export interface ACHTransferIntention {
1165
1154
  account_number: string;
@@ -1181,8 +1170,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1181
1170
  }
1182
1171
 
1183
1172
  /**
1184
- * A ACH Transfer Rejection object. This field will be present in the JSON response
1185
- * if and only if `category` is equal to `ach_transfer_rejection`.
1173
+ * An ACH Transfer Rejection object. This field will be present in the JSON
1174
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
1186
1175
  */
1187
1176
  export interface ACHTransferRejection {
1188
1177
  /**
@@ -1192,8 +1181,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1192
1181
  }
1193
1182
 
1194
1183
  /**
1195
- * A ACH Transfer Return object. This field will be present in the JSON response if
1196
- * and only if `category` is equal to `ach_transfer_return`.
1184
+ * An ACH Transfer Return object. This field will be present in the JSON response
1185
+ * if and only if `category` is equal to `ach_transfer_return`.
1197
1186
  */
1198
1187
  export interface ACHTransferReturn {
1199
1188
  /**
@@ -3016,8 +3005,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3016
3005
  }
3017
3006
 
3018
3007
  /**
3019
- * A Inbound ACH Transfer object. This field will be present in the JSON response
3020
- * if and only if `category` is equal to `inbound_ach_transfer`.
3008
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
3009
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
3021
3010
  */
3022
3011
  export interface InboundACHTransfer {
3023
3012
  /**
@@ -3044,7 +3033,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3044
3033
  }
3045
3034
 
3046
3035
  /**
3047
- * A Inbound Check object. This field will be present in the JSON response if and
3036
+ * An Inbound Check object. This field will be present in the JSON response if and
3048
3037
  * only if `category` is equal to `inbound_check`.
3049
3038
  */
3050
3039
  export interface InboundCheck {
@@ -3075,7 +3064,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3075
3064
  }
3076
3065
 
3077
3066
  /**
3078
- * A Inbound International ACH Transfer object. This field will be present in the
3067
+ * An Inbound International ACH Transfer object. This field will be present in the
3079
3068
  * JSON response if and only if `category` is equal to
3080
3069
  * `inbound_international_ach_transfer`.
3081
3070
  */
@@ -3158,7 +3147,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3158
3147
  }
3159
3148
 
3160
3149
  /**
3161
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
3150
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
3162
3151
  * present in the JSON response if and only if `category` is equal to
3163
3152
  * `inbound_real_time_payments_transfer_confirmation`.
3164
3153
  */
@@ -3214,7 +3203,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3214
3203
  }
3215
3204
 
3216
3205
  /**
3217
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
3206
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
3218
3207
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
3219
3208
  */
3220
3209
  export interface InboundWireDrawdownPayment {
@@ -3250,7 +3239,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3250
3239
  }
3251
3240
 
3252
3241
  /**
3253
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
3242
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
3254
3243
  * the JSON response if and only if `category` is equal to
3255
3244
  * `inbound_wire_drawdown_payment_reversal`.
3256
3245
  */
@@ -3307,7 +3296,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3307
3296
  }
3308
3297
 
3309
3298
  /**
3310
- * A Inbound Wire Reversal object. This field will be present in the JSON response
3299
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
3311
3300
  * if and only if `category` is equal to `inbound_wire_reversal`.
3312
3301
  */
3313
3302
  export interface InboundWireReversal {
@@ -3390,7 +3379,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3390
3379
  }
3391
3380
 
3392
3381
  /**
3393
- * A Inbound Wire Transfer object. This field will be present in the JSON response
3382
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
3394
3383
  * if and only if `category` is equal to `inbound_wire_transfer`.
3395
3384
  */
3396
3385
  export interface InboundWireTransfer {
@@ -3434,7 +3423,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3434
3423
  }
3435
3424
 
3436
3425
  /**
3437
- * A Interest Payment object. This field will be present in the JSON response if
3426
+ * An Interest Payment object. This field will be present in the JSON response if
3438
3427
  * and only if `category` is equal to `interest_payment`.
3439
3428
  */
3440
3429
  export interface InterestPayment {
@@ -3474,8 +3463,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3474
3463
  }
3475
3464
 
3476
3465
  /**
3477
- * A Internal Source object. This field will be present in the JSON response if and
3478
- * only if `category` is equal to `internal_source`.
3466
+ * An Internal Source object. This field will be present in the JSON response if
3467
+ * and only if `category` is equal to `internal_source`.
3479
3468
  */
3480
3469
  export interface InternalSource {
3481
3470
  /**