increase 1.340.0 → 1.341.0

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 (306) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +48 -27
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +199 -103
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +48 -37
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +124 -75
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +323 -236
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +112 -86
  76. data/lib/increase/models/event.rb +6 -5
  77. data/lib/increase/models/event_list_params.rb +23 -17
  78. data/lib/increase/models/event_subscription.rb +17 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +14 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +33 -21
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -2
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +48 -26
  202. data/lib/increase/models/swift_transfer_create_params.rb +28 -19
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +995 -534
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +6 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +6 -5
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +28 -16
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/check_transfer.rbi +8 -0
  297. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  298. data/rbi/increase/models/entity_list_params.rbi +119 -0
  299. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  300. data/rbi/increase/resources/entities.rbi +3 -0
  301. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  302. data/sig/increase/models/check_transfer.rbs +5 -0
  303. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  304. data/sig/increase/models/entity_list_params.rbs +48 -1
  305. data/sig/increase/resources/entities.rbs +1 -0
  306. metadata +2 -2
@@ -38,9 +38,6 @@ module Increase
38
38
  optional :limit, Integer
39
39
 
40
40
  # @!method initialize(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
41
- # Some parameter documentations has been truncated, see
42
- # {Increase::Models::CardPaymentListParams} for more details.
43
- #
44
41
  # @param account_id [String] Filter Card Payments to ones belonging to the specified Account.
45
42
  #
46
43
  # @param card_id [String] Filter Card Payments to ones belonging to the specified Card.
@@ -49,7 +46,9 @@ module Increase
49
46
  #
50
47
  # @param cursor [String] Return the page of entries after this one.
51
48
  #
52
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
49
+ # @param limit [Integer]
50
+ # Limit the size of the list that is returned. The default (and maximum) is 100
51
+ # objects.
53
52
  #
54
53
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
55
54
 
@@ -83,16 +82,21 @@ module Increase
83
82
  optional :on_or_before, Time
84
83
 
85
84
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
86
- # Some parameter documentations has been truncated, see
87
- # {Increase::Models::CardPaymentListParams::CreatedAt} for more details.
88
- #
89
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
85
+ # @param after [Time]
86
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
87
+ # timestamp.
90
88
  #
91
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
89
+ # @param before [Time]
90
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
91
+ # timestamp.
92
92
  #
93
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
93
+ # @param on_or_after [Time]
94
+ # Return results on or after this
95
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
94
96
  #
95
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
97
+ # @param on_or_before [Time]
98
+ # Return results on or before this
99
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
96
100
  end
97
101
  end
98
102
  end
@@ -50,9 +50,6 @@ module Increase
50
50
  required :type, enum: -> { Increase::CardPurchaseSupplement::Type }
51
51
 
52
52
  # @!method initialize(id:, card_payment_id:, invoice:, line_items:, shipping:, transaction_id:, type:)
53
- # Some parameter documentations has been truncated, see
54
- # {Increase::Models::CardPurchaseSupplement} for more details.
55
- #
56
53
  # Additional information about a card purchase (e.g., settlement or refund), such
57
54
  # as level 3 line item data.
58
55
  #
@@ -60,15 +57,20 @@ module Increase
60
57
  #
61
58
  # @param card_payment_id [String, nil] The ID of the Card Payment this transaction belongs to.
62
59
  #
63
- # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil] Invoice-level information about the payment.
60
+ # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil]
61
+ # Invoice-level information about the payment.
64
62
  #
65
- # @param line_items [Array<Increase::Models::CardPurchaseSupplement::LineItem>, nil] Line item information, such as individual products purchased.
63
+ # @param line_items [Array<Increase::Models::CardPurchaseSupplement::LineItem>, nil]
64
+ # Line item information, such as individual products purchased.
66
65
  #
67
- # @param shipping [Increase::Models::CardPurchaseSupplement::Shipping, nil] Shipping information for the purchase.
66
+ # @param shipping [Increase::Models::CardPurchaseSupplement::Shipping, nil]
67
+ # Shipping information for the purchase.
68
68
  #
69
69
  # @param transaction_id [String] The ID of the transaction.
70
70
  #
71
- # @param type [Symbol, Increase::Models::CardPurchaseSupplement::Type] A constant representing the object's type. For this resource it will always be `
71
+ # @param type [Symbol, Increase::Models::CardPurchaseSupplement::Type]
72
+ # A constant representing the object's type. For this resource it will always be
73
+ # `card_purchase_supplement`.
72
74
 
73
75
  # @see Increase::Models::CardPurchaseSupplement#invoice
74
76
  class Invoice < Increase::Internal::Type::BaseModel
@@ -175,26 +177,28 @@ module Increase
175
177
  required :unique_value_added_tax_invoice_reference, String, nil?: true
176
178
 
177
179
  # @!method initialize(discount_amount:, discount_currency:, discount_treatment_code:, duty_tax_amount:, duty_tax_currency:, order_date:, shipping_amount:, shipping_currency:, shipping_destination_country_code:, shipping_destination_postal_code:, shipping_source_postal_code:, shipping_tax_amount:, shipping_tax_currency:, shipping_tax_rate:, tax_treatments:, unique_value_added_tax_invoice_reference:)
178
- # Some parameter documentations has been truncated, see
179
- # {Increase::Models::CardPurchaseSupplement::Invoice} for more details.
180
- #
181
180
  # Invoice-level information about the payment.
182
181
  #
183
182
  # @param discount_amount [Integer, nil] Discount given to cardholder.
184
183
  #
185
- # @param discount_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
184
+ # @param discount_currency [String, nil]
185
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
186
186
  #
187
- # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil] Indicates how the merchant applied the discount.
187
+ # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil]
188
+ # Indicates how the merchant applied the discount.
188
189
  #
189
190
  # @param duty_tax_amount [Integer, nil] Amount of duty taxes.
190
191
  #
191
- # @param duty_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax.
192
+ # @param duty_tax_currency [String, nil]
193
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax.
192
194
  #
193
195
  # @param order_date [Date, nil] Date the order was taken.
194
196
  #
195
197
  # @param shipping_amount [Integer, nil] The shipping cost.
196
198
  #
197
- # @param shipping_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping cos
199
+ # @param shipping_currency [String, nil]
200
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping
201
+ # cost.
198
202
  #
199
203
  # @param shipping_destination_country_code [String, nil] Country code of the shipping destination.
200
204
  #
@@ -204,11 +208,14 @@ module Increase
204
208
  #
205
209
  # @param shipping_tax_amount [Integer, nil] Taxes paid for freight and shipping.
206
210
  #
207
- # @param shipping_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping tax
211
+ # @param shipping_tax_currency [String, nil]
212
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping
213
+ # tax.
208
214
  #
209
215
  # @param shipping_tax_rate [String, nil] Tax rate for freight and shipping.
210
216
  #
211
- # @param tax_treatments [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil] Indicates how the merchant applied taxes.
217
+ # @param tax_treatments [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil]
218
+ # Indicates how the merchant applied taxes.
212
219
  #
213
220
  # @param unique_value_added_tax_invoice_reference [String, nil] Value added tax invoice reference number.
214
221
 
@@ -367,18 +374,18 @@ module Increase
367
374
  required :unit_of_measure_code, String, nil?: true
368
375
 
369
376
  # @!method initialize(id:, detail_indicator:, discount_amount:, discount_currency:, discount_treatment_code:, item_commodity_code:, item_descriptor:, item_quantity:, product_code:, sales_tax_amount:, sales_tax_currency:, sales_tax_rate:, total_amount:, total_amount_currency:, unit_cost:, unit_cost_currency:, unit_of_measure_code:)
370
- # Some parameter documentations has been truncated, see
371
- # {Increase::Models::CardPurchaseSupplement::LineItem} for more details.
372
- #
373
377
  # @param id [String] The Card Purchase Supplement Line Item identifier.
374
378
  #
375
- # @param detail_indicator [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil] Indicates the type of line item.
379
+ # @param detail_indicator [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil]
380
+ # Indicates the type of line item.
376
381
  #
377
382
  # @param discount_amount [Integer, nil] Discount amount for this specific line item.
378
383
  #
379
- # @param discount_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
384
+ # @param discount_currency [String, nil]
385
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
380
386
  #
381
- # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil] Indicates how the merchant applied the discount for this specific line item.
387
+ # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil]
388
+ # Indicates how the merchant applied the discount for this specific line item.
382
389
  #
383
390
  # @param item_commodity_code [String, nil] Code used to categorize the purchase item.
384
391
  #
@@ -390,17 +397,22 @@ module Increase
390
397
  #
391
398
  # @param sales_tax_amount [Integer, nil] Sales tax amount for this line item.
392
399
  #
393
- # @param sales_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax as
400
+ # @param sales_tax_currency [String, nil]
401
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax
402
+ # assessed.
394
403
  #
395
404
  # @param sales_tax_rate [String, nil] Sales tax rate for this line item.
396
405
  #
397
406
  # @param total_amount [Integer, nil] Total amount of all line items.
398
407
  #
399
- # @param total_amount_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total amount
408
+ # @param total_amount_currency [String, nil]
409
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total
410
+ # amount.
400
411
  #
401
412
  # @param unit_cost [String, nil] Cost of line item per unit of measure, in major units.
402
413
  #
403
- # @param unit_cost_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost.
414
+ # @param unit_cost_currency [String, nil]
415
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost.
404
416
  #
405
417
  # @param unit_of_measure_code [String, nil] Code indicating unit of measure (gallons, etc.).
406
418
 
@@ -33,16 +33,17 @@ module Increase
33
33
  optional :limit, Integer
34
34
 
35
35
  # @!method initialize(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
36
- # Some parameter documentations has been truncated, see
37
- # {Increase::Models::CardPurchaseSupplementListParams} for more details.
38
- #
39
- # @param card_payment_id [String] Filter Card Purchase Supplements to ones belonging to the specified Card Payment
36
+ # @param card_payment_id [String]
37
+ # Filter Card Purchase Supplements to ones belonging to the specified Card
38
+ # Payment.
40
39
  #
41
40
  # @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt]
42
41
  #
43
42
  # @param cursor [String] Return the page of entries after this one.
44
43
  #
45
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
44
+ # @param limit [Integer]
45
+ # Limit the size of the list that is returned. The default (and maximum) is 100
46
+ # objects.
46
47
  #
47
48
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
48
49
 
@@ -76,17 +77,21 @@ module Increase
76
77
  optional :on_or_before, Time
77
78
 
78
79
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
79
- # Some parameter documentations has been truncated, see
80
- # {Increase::Models::CardPurchaseSupplementListParams::CreatedAt} for more
81
- # details.
82
- #
83
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
80
+ # @param after [Time]
81
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
82
+ # timestamp.
84
83
  #
85
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
84
+ # @param before [Time]
85
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
86
+ # timestamp.
86
87
  #
87
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
88
+ # @param on_or_after [Time]
89
+ # Return results on or after this
90
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
88
91
  #
89
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
92
+ # @param on_or_before [Time]
93
+ # Return results on or before this
94
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
90
95
  end
91
96
  end
92
97
  end
@@ -239,62 +239,101 @@ module Increase
239
239
  required :type, enum: -> { Increase::CardPushTransfer::Type }
240
240
 
241
241
  # @!method initialize(id:, acceptance:, account_id:, approval:, business_application_identifier:, cancellation:, card_token_id:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_legal_business_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, merchant_street_address:, presentment_amount:, recipient_address_city:, recipient_address_line1:, recipient_address_postal_code:, recipient_address_state:, recipient_name:, route:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, status:, submission:, type:)
242
- # Some parameter documentations has been truncated, see
243
- # {Increase::Models::CardPushTransfer} for more details.
244
- #
245
242
  # Card Push Transfers send funds to a recipient's payment card in real-time.
246
243
  #
247
244
  # @param id [String] The Card Push Transfer's identifier.
248
245
  #
249
- # @param acceptance [Increase::Models::CardPushTransfer::Acceptance, nil] If the transfer is accepted by the recipient bank, this will contain supplementa
246
+ # @param acceptance [Increase::Models::CardPushTransfer::Acceptance, nil]
247
+ # If the transfer is accepted by the recipient bank, this will contain
248
+ # supplemental details.
250
249
  #
251
250
  # @param account_id [String] The Account from which the transfer was sent.
252
251
  #
253
- # @param approval [Increase::Models::CardPushTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
252
+ # @param approval [Increase::Models::CardPushTransfer::Approval, nil]
253
+ # If your account requires approvals for transfers and the transfer was approved,
254
+ # this will contain details of the approval.
254
255
  #
255
- # @param business_application_identifier [Symbol, Increase::Models::CardPushTransfer::BusinessApplicationIdentifier] The Business Application Identifier describes the type of transaction being perf
256
+ # @param business_application_identifier [Symbol, Increase::Models::CardPushTransfer::BusinessApplicationIdentifier]
257
+ # The Business Application Identifier describes the type of transaction being
258
+ # performed. Your program must be approved for the specified Business Application
259
+ # Identifier in order to use it.
256
260
  #
257
- # @param cancellation [Increase::Models::CardPushTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
261
+ # @param cancellation [Increase::Models::CardPushTransfer::Cancellation, nil]
262
+ # If your account requires approvals for transfers and the transfer was not
263
+ # approved, this will contain details of the cancellation.
258
264
  #
259
265
  # @param card_token_id [String] The ID of the Card Token that was used to validate the card.
260
266
  #
261
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
267
+ # @param created_at [Time]
268
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
269
+ # the transfer was created.
262
270
  #
263
- # @param created_by [Increase::Models::CardPushTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
271
+ # @param created_by [Increase::Models::CardPushTransfer::CreatedBy, nil]
272
+ # What object created the transfer, either via the API or the dashboard.
264
273
  #
265
- # @param decline [Increase::Models::CardPushTransfer::Decline, nil] If the transfer is rejected by the card network or the destination financial ins
274
+ # @param decline [Increase::Models::CardPushTransfer::Decline, nil]
275
+ # If the transfer is rejected by the card network or the destination financial
276
+ # institution, this will contain supplemental details.
266
277
  #
267
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
278
+ # @param idempotency_key [String, nil]
279
+ # The idempotency key you chose for this object. This value is unique across
280
+ # Increase and is used to ensure that a request is only processed once. Learn more
281
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
268
282
  #
269
- # @param merchant_category_code [String] The merchant category code (MCC) of the merchant (generally your business) sendi
283
+ # @param merchant_category_code [String]
284
+ # The merchant category code (MCC) of the merchant (generally your business)
285
+ # sending the transfer. This is a four-digit code that describes the type of
286
+ # business or service provided by the merchant. Your program must be approved for
287
+ # the specified MCC in order to use it.
270
288
  #
271
- # @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
289
+ # @param merchant_city_name [String]
290
+ # The city name of the merchant (generally your business) sending the transfer.
272
291
  #
273
- # @param merchant_legal_business_name [String, nil] The legal business name of the merchant (generally your business) sending the tr
292
+ # @param merchant_legal_business_name [String, nil]
293
+ # The legal business name of the merchant (generally your business) sending the
294
+ # transfer.
274
295
  #
275
- # @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
296
+ # @param merchant_name [String]
297
+ # The merchant name shows up as the statement descriptor for the transfer. This is
298
+ # typically the name of your business or organization.
276
299
  #
277
- # @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
300
+ # @param merchant_name_prefix [String]
301
+ # For certain Business Application Identifiers, the statement descriptor is
302
+ # `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
303
+ # four character prefix that identifies the merchant.
278
304
  #
279
- # @param merchant_postal_code [String] The postal code of the merchant (generally your business) sending the transfer.
305
+ # @param merchant_postal_code [String]
306
+ # The postal code of the merchant (generally your business) sending the transfer.
280
307
  #
281
308
  # @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
282
309
  #
283
- # @param merchant_street_address [String, nil] The street address of the merchant (generally your business) sending the transfe
310
+ # @param merchant_street_address [String, nil]
311
+ # The street address of the merchant (generally your business) sending the
312
+ # transfer.
284
313
  #
285
- # @param presentment_amount [Increase::Models::CardPushTransfer::PresentmentAmount] The amount that was transferred. The receiving bank will have converted this to
314
+ # @param presentment_amount [Increase::Models::CardPushTransfer::PresentmentAmount]
315
+ # The amount that was transferred. The receiving bank will have converted this to
316
+ # the cardholder's currency. The amount that is applied to your Increase account
317
+ # matches the currency of your account.
286
318
  #
287
- # @param recipient_address_city [String, nil] The city of the recipient. Required if the card is issued in Canada.
319
+ # @param recipient_address_city [String, nil]
320
+ # The city of the recipient. Required if the card is issued in Canada.
288
321
  #
289
- # @param recipient_address_line1 [String, nil] The first line of the recipient's address. Required if the card is issued in Can
322
+ # @param recipient_address_line1 [String, nil]
323
+ # The first line of the recipient's address. Required if the card is issued in
324
+ # Canada.
290
325
  #
291
- # @param recipient_address_postal_code [String, nil] The postal code of the recipient. Required if the card is issued in Canada.
326
+ # @param recipient_address_postal_code [String, nil]
327
+ # The postal code of the recipient. Required if the card is issued in Canada.
292
328
  #
293
- # @param recipient_address_state [String, nil] The state or province of the recipient. Required if the card is issued in Canada
329
+ # @param recipient_address_state [String, nil]
330
+ # The state or province of the recipient. Required if the card is issued in
331
+ # Canada.
294
332
  #
295
333
  # @param recipient_name [String] The name of the funds recipient.
296
334
  #
297
- # @param route [Symbol, Increase::Models::CardPushTransfer::Route] The card network route used for the transfer.
335
+ # @param route [Symbol, Increase::Models::CardPushTransfer::Route]
336
+ # The card network route used for the transfer.
298
337
  #
299
338
  # @param sender_address_city [String] The city of the sender.
300
339
  #
@@ -306,13 +345,18 @@ module Increase
306
345
  #
307
346
  # @param sender_name [String] The name of the funds originator.
308
347
  #
309
- # @param source_account_number_id [String] The Account Number the recipient will see as having sent the transfer.
348
+ # @param source_account_number_id [String]
349
+ # The Account Number the recipient will see as having sent the transfer.
310
350
  #
311
351
  # @param status [Symbol, Increase::Models::CardPushTransfer::Status] The lifecycle status of the transfer.
312
352
  #
313
- # @param submission [Increase::Models::CardPushTransfer::Submission, nil] After the transfer is submitted to the card network, this will contain supplemen
353
+ # @param submission [Increase::Models::CardPushTransfer::Submission, nil]
354
+ # After the transfer is submitted to the card network, this will contain
355
+ # supplemental details.
314
356
  #
315
- # @param type [Symbol, Increase::Models::CardPushTransfer::Type] A constant representing the object's type. For this resource it will always be `
357
+ # @param type [Symbol, Increase::Models::CardPushTransfer::Type]
358
+ # A constant representing the object's type. For this resource it will always be
359
+ # `card_push_transfer`.
316
360
 
317
361
  # @see Increase::Models::CardPushTransfer#acceptance
318
362
  class Acceptance < Increase::Internal::Type::BaseModel
@@ -350,19 +394,21 @@ module Increase
350
394
  required :settlement_amount, Integer
351
395
 
352
396
  # @!method initialize(accepted_at:, authorization_identification_response:, card_verification_value2_result:, network_transaction_identifier:, settlement_amount:)
353
- # Some parameter documentations has been truncated, see
354
- # {Increase::Models::CardPushTransfer::Acceptance} for more details.
355
- #
356
397
  # If the transfer is accepted by the recipient bank, this will contain
357
398
  # supplemental details.
358
399
  #
359
- # @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
400
+ # @param accepted_at [Time]
401
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
402
+ # the transfer was accepted by the issuing bank.
360
403
  #
361
- # @param authorization_identification_response [String] The authorization identification response from the issuing bank.
404
+ # @param authorization_identification_response [String]
405
+ # The authorization identification response from the issuing bank.
362
406
  #
363
- # @param card_verification_value2_result [Symbol, Increase::Models::CardPushTransfer::Acceptance::CardVerificationValue2Result, nil] The result of the Card Verification Value 2 match.
407
+ # @param card_verification_value2_result [Symbol, Increase::Models::CardPushTransfer::Acceptance::CardVerificationValue2Result, nil]
408
+ # The result of the Card Verification Value 2 match.
364
409
  #
365
- # @param network_transaction_identifier [String, nil] A unique identifier for the transaction on the card network.
410
+ # @param network_transaction_identifier [String, nil]
411
+ # A unique identifier for the transaction on the card network.
366
412
  #
367
413
  # @param settlement_amount [Integer] The transfer amount in USD cents.
368
414
 
@@ -400,15 +446,16 @@ module Increase
400
446
  required :approved_by, String, nil?: true
401
447
 
402
448
  # @!method initialize(approved_at:, approved_by:)
403
- # Some parameter documentations has been truncated, see
404
- # {Increase::Models::CardPushTransfer::Approval} for more details.
405
- #
406
449
  # If your account requires approvals for transfers and the transfer was approved,
407
450
  # this will contain details of the approval.
408
451
  #
409
- # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
452
+ # @param approved_at [Time]
453
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
454
+ # the transfer was approved.
410
455
  #
411
- # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
456
+ # @param approved_by [String, nil]
457
+ # If the Transfer was approved by a user in the dashboard, the email address of
458
+ # that user.
412
459
  end
413
460
 
414
461
  # The Business Application Identifier describes the type of transaction being
@@ -482,15 +529,16 @@ module Increase
482
529
  required :canceled_by, String, nil?: true
483
530
 
484
531
  # @!method initialize(canceled_at:, canceled_by:)
485
- # Some parameter documentations has been truncated, see
486
- # {Increase::Models::CardPushTransfer::Cancellation} for more details.
487
- #
488
532
  # If your account requires approvals for transfers and the transfer was not
489
533
  # approved, this will contain details of the cancellation.
490
534
  #
491
- # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
535
+ # @param canceled_at [Time]
536
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
537
+ # the Transfer was canceled.
492
538
  #
493
- # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
539
+ # @param canceled_by [String, nil]
540
+ # If the Transfer was canceled by a user in the dashboard, the email address of
541
+ # that user.
494
542
  end
495
543
 
496
544
  # @see Increase::Models::CardPushTransfer#created_by
@@ -526,13 +574,17 @@ module Increase
526
574
  # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
527
575
  # What object created the transfer, either via the API or the dashboard.
528
576
  #
529
- # @param category [Symbol, Increase::Models::CardPushTransfer::CreatedBy::Category] The type of object that created this transfer.
577
+ # @param category [Symbol, Increase::Models::CardPushTransfer::CreatedBy::Category]
578
+ # The type of object that created this transfer.
530
579
  #
531
- # @param api_key [Increase::Models::CardPushTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
580
+ # @param api_key [Increase::Models::CardPushTransfer::CreatedBy::APIKey, nil]
581
+ # If present, details about the API key that created the transfer.
532
582
  #
533
- # @param oauth_application [Increase::Models::CardPushTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
583
+ # @param oauth_application [Increase::Models::CardPushTransfer::CreatedBy::OAuthApplication, nil]
584
+ # If present, details about the OAuth Application that created the transfer.
534
585
  #
535
- # @param user [Increase::Models::CardPushTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
586
+ # @param user [Increase::Models::CardPushTransfer::CreatedBy::User, nil]
587
+ # If present, details about the User that created the transfer.
536
588
 
537
589
  # The type of object that created this transfer.
538
590
  #
@@ -618,17 +670,18 @@ module Increase
618
670
  required :reason, enum: -> { Increase::CardPushTransfer::Decline::Reason }
619
671
 
620
672
  # @!method initialize(declined_at:, network_transaction_identifier:, reason:)
621
- # Some parameter documentations has been truncated, see
622
- # {Increase::Models::CardPushTransfer::Decline} for more details.
623
- #
624
673
  # If the transfer is rejected by the card network or the destination financial
625
674
  # institution, this will contain supplemental details.
626
675
  #
627
- # @param declined_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
676
+ # @param declined_at [Time]
677
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
678
+ # the transfer declined.
628
679
  #
629
- # @param network_transaction_identifier [String, nil] A unique identifier for the transaction on the card network.
680
+ # @param network_transaction_identifier [String, nil]
681
+ # A unique identifier for the transaction on the card network.
630
682
  #
631
- # @param reason [Symbol, Increase::Models::CardPushTransfer::Decline::Reason] The reason why the transfer was declined.
683
+ # @param reason [Symbol, Increase::Models::CardPushTransfer::Decline::Reason]
684
+ # The reason why the transfer was declined.
632
685
 
633
686
  # The reason why the transfer was declined.
634
687
  #
@@ -847,16 +900,16 @@ module Increase
847
900
  required :value, String
848
901
 
849
902
  # @!method initialize(currency:, value:)
850
- # Some parameter documentations has been truncated, see
851
- # {Increase::Models::CardPushTransfer::PresentmentAmount} for more details.
852
- #
853
903
  # The amount that was transferred. The receiving bank will have converted this to
854
904
  # the cardholder's currency. The amount that is applied to your Increase account
855
905
  # matches the currency of your account.
856
906
  #
857
- # @param currency [Symbol, Increase::Models::CardPushTransfer::PresentmentAmount::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
907
+ # @param currency [Symbol, Increase::Models::CardPushTransfer::PresentmentAmount::Currency]
908
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
858
909
  #
859
- # @param value [String] The amount value represented as a string containing a decimal number in major un
910
+ # @param value [String]
911
+ # The amount value represented as a string containing a decimal number in major
912
+ # units (so e.g., "12.34" for $12.34).
860
913
 
861
914
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
862
915
  #
@@ -1432,19 +1485,22 @@ module Increase
1432
1485
  required :trace_number, String
1433
1486
 
1434
1487
  # @!method initialize(retrieval_reference_number:, sender_reference:, submitted_at:, trace_number:)
1435
- # Some parameter documentations has been truncated, see
1436
- # {Increase::Models::CardPushTransfer::Submission} for more details.
1437
- #
1438
1488
  # After the transfer is submitted to the card network, this will contain
1439
1489
  # supplemental details.
1440
1490
  #
1441
- # @param retrieval_reference_number [String] A 12-digit retrieval reference number that identifies the transfer. Usually a co
1491
+ # @param retrieval_reference_number [String]
1492
+ # A 12-digit retrieval reference number that identifies the transfer. Usually a
1493
+ # combination of a timestamp and the trace number.
1442
1494
  #
1443
1495
  # @param sender_reference [String] A unique reference for the transfer.
1444
1496
  #
1445
- # @param submitted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1497
+ # @param submitted_at [Time]
1498
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1499
+ # the transfer was submitted to the card network.
1446
1500
  #
1447
- # @param trace_number [String] A 6-digit trace number that identifies the transfer within a small window of tim
1501
+ # @param trace_number [String]
1502
+ # A 6-digit trace number that identifies the transfer within a small window of
1503
+ # time.
1448
1504
  end
1449
1505
 
1450
1506
  # A constant representing the object's type. For this resource it will always be