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
@@ -126,43 +126,69 @@ module Increase
126
126
  optional :wire_drawdown_request_id, String
127
127
 
128
128
  # @!method initialize(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
129
- # Some parameter documentations has been truncated, see
130
- # {Increase::Models::Simulations::InboundWireTransferCreateParams} for more
131
- # details.
132
- #
133
129
  # @param account_number_id [String] The identifier of the Account Number the inbound Wire Transfer is for.
134
130
  #
135
131
  # @param amount [Integer] The transfer amount in cents. Must be positive.
136
132
  #
137
- # @param creditor_address_line1 [String] The sending bank will set creditor_address_line1 in production. You can simulate
133
+ # @param creditor_address_line1 [String]
134
+ # The sending bank will set creditor_address_line1 in production. You can simulate
135
+ # any value here.
138
136
  #
139
- # @param creditor_address_line2 [String] The sending bank will set creditor_address_line2 in production. You can simulate
137
+ # @param creditor_address_line2 [String]
138
+ # The sending bank will set creditor_address_line2 in production. You can simulate
139
+ # any value here.
140
140
  #
141
- # @param creditor_address_line3 [String] The sending bank will set creditor_address_line3 in production. You can simulate
141
+ # @param creditor_address_line3 [String]
142
+ # The sending bank will set creditor_address_line3 in production. You can simulate
143
+ # any value here.
142
144
  #
143
- # @param creditor_name [String] The sending bank will set creditor_name in production. You can simulate any valu
145
+ # @param creditor_name [String]
146
+ # The sending bank will set creditor_name in production. You can simulate any
147
+ # value here.
144
148
  #
145
- # @param debtor_address_line1 [String] The sending bank will set debtor_address_line1 in production. You can simulate a
149
+ # @param debtor_address_line1 [String]
150
+ # The sending bank will set debtor_address_line1 in production. You can simulate
151
+ # any value here.
146
152
  #
147
- # @param debtor_address_line2 [String] The sending bank will set debtor_address_line2 in production. You can simulate a
153
+ # @param debtor_address_line2 [String]
154
+ # The sending bank will set debtor_address_line2 in production. You can simulate
155
+ # any value here.
148
156
  #
149
- # @param debtor_address_line3 [String] The sending bank will set debtor_address_line3 in production. You can simulate a
157
+ # @param debtor_address_line3 [String]
158
+ # The sending bank will set debtor_address_line3 in production. You can simulate
159
+ # any value here.
150
160
  #
151
- # @param debtor_name [String] The sending bank will set debtor_name in production. You can simulate any value
161
+ # @param debtor_name [String]
162
+ # The sending bank will set debtor_name in production. You can simulate any value
163
+ # here.
152
164
  #
153
- # @param end_to_end_identification [String] The sending bank will set end_to_end_identification in production. You can simul
165
+ # @param end_to_end_identification [String]
166
+ # The sending bank will set end_to_end_identification in production. You can
167
+ # simulate any value here.
154
168
  #
155
- # @param instructing_agent_routing_number [String] The sending bank will set instructing_agent_routing_number in production. You ca
169
+ # @param instructing_agent_routing_number [String]
170
+ # The sending bank will set instructing_agent_routing_number in production. You
171
+ # can simulate any value here.
156
172
  #
157
- # @param instruction_identification [String] The sending bank will set instruction_identification in production. You can simu
173
+ # @param instruction_identification [String]
174
+ # The sending bank will set instruction_identification in production. You can
175
+ # simulate any value here.
158
176
  #
159
- # @param purpose [String] The sending bank will set purpose in production. You can simulate any value here
177
+ # @param purpose [String]
178
+ # The sending bank will set purpose in production. You can simulate any value
179
+ # here.
160
180
  #
161
- # @param unique_end_to_end_transaction_reference [String] The sending bank will set unique_end_to_end_transaction_reference in production.
181
+ # @param unique_end_to_end_transaction_reference [String]
182
+ # The sending bank will set unique_end_to_end_transaction_reference in production.
183
+ # You can simulate any value here.
162
184
  #
163
- # @param unstructured_remittance_information [String] The sending bank will set unstructured_remittance_information in production. You
185
+ # @param unstructured_remittance_information [String]
186
+ # The sending bank will set unstructured_remittance_information in production. You
187
+ # can simulate any value here.
164
188
  #
165
- # @param wire_drawdown_request_id [String] The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfillin
189
+ # @param wire_drawdown_request_id [String]
190
+ # The identifier of a Wire Drawdown Request the inbound Wire Transfer is
191
+ # fulfilling.
166
192
  #
167
193
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
168
194
  end
@@ -39,18 +39,17 @@ module Increase
39
39
  optional :period_start, Time
40
40
 
41
41
  # @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
42
- # Some parameter documentations has been truncated, see
43
- # {Increase::Models::Simulations::InterestPaymentCreateParams} for more details.
44
- #
45
42
  # @param account_id [String] The identifier of the Account the Interest Payment should be paid to is for.
46
43
  #
47
44
  # @param amount [Integer] The interest amount in cents. Must be positive.
48
45
  #
49
- # @param accrued_on_account_id [String] The identifier of the Account the Interest accrued on. Defaults to `account_id`.
46
+ # @param accrued_on_account_id [String]
47
+ # The identifier of the Account the Interest accrued on. Defaults to `account_id`.
50
48
  #
51
49
  # @param period_end [Time] The end of the interest period. If not provided, defaults to the current time.
52
50
  #
53
- # @param period_start [Time] The start of the interest period. If not provided, defaults to the current time.
51
+ # @param period_start [Time]
52
+ # The start of the interest period. If not provided, defaults to the current time.
54
53
  #
55
54
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
56
55
  end
@@ -16,11 +16,9 @@ module Increase
16
16
  required :pending_transaction_id, String
17
17
 
18
18
  # @!method initialize(pending_transaction_id:, request_options: {})
19
- # Some parameter documentations has been truncated, see
20
- # {Increase::Models::Simulations::PendingTransactionReleaseInboundFundsHoldParams}
21
- # for more details.
22
- #
23
- # @param pending_transaction_id [String] The pending transaction to release. The pending transaction must have a `inbound
19
+ # @param pending_transaction_id [String]
20
+ # The pending transaction to release. The pending transaction must have a
21
+ # `inbound_funds_hold` source.
24
22
  #
25
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
26
24
  end
@@ -24,7 +24,8 @@ module Increase
24
24
  # @!method initialize(physical_card_id:, shipment_status:, request_options: {})
25
25
  # @param physical_card_id [String] The Physical Card you would like to action.
26
26
  #
27
- # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] The shipment status to move the Physical Card to.
27
+ # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus]
28
+ # The shipment status to move the Physical Card to.
28
29
  #
29
30
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
30
31
 
@@ -46,14 +46,14 @@ module Increase
46
46
  optional :state, String
47
47
 
48
48
  # @!method initialize(physical_card_id:, category:, carrier_estimated_delivery_at: nil, city: nil, postal_code: nil, state: nil, request_options: {})
49
- # Some parameter documentations has been truncated, see
50
- # {Increase::Models::Simulations::PhysicalCardCreateParams} for more details.
51
- #
52
49
  # @param physical_card_id [String] The Physical Card you would like to action.
53
50
  #
54
- # @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category] The type of tracking event.
51
+ # @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category]
52
+ # The type of tracking event.
55
53
  #
56
- # @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
54
+ # @param carrier_estimated_delivery_at [Time]
55
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
56
+ # carrier expects the card to be delivered.
57
57
  #
58
58
  # @param city [String] The city where the event took place.
59
59
  #
@@ -35,9 +35,11 @@ module Increase
35
35
  # @!method initialize(name:, bank: nil, lending_maximum_extendable_credit: nil, reserve_account_id: nil, request_options: {})
36
36
  # @param name [String] The name of the program being added.
37
37
  #
38
- # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank] The bank for the program's accounts, defaults to First Internet Bank.
38
+ # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank]
39
+ # The bank for the program's accounts, defaults to First Internet Bank.
39
40
  #
40
- # @param lending_maximum_extendable_credit [Integer] The maximum extendable credit of the program being added.
41
+ # @param lending_maximum_extendable_credit [Integer]
42
+ # The maximum extendable credit of the program being added.
41
43
  #
42
44
  # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
43
45
  #
@@ -21,9 +21,11 @@ module Increase
21
21
  optional :rejection, -> { Increase::Simulations::RealTimePaymentsTransferCompleteParams::Rejection }
22
22
 
23
23
  # @!method initialize(real_time_payments_transfer_id:, rejection: nil, request_options: {})
24
- # @param real_time_payments_transfer_id [String] The identifier of the Real-Time Payments Transfer you wish to complete.
24
+ # @param real_time_payments_transfer_id [String]
25
+ # The identifier of the Real-Time Payments Transfer you wish to complete.
25
26
  #
26
- # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] If set, the simulation will reject the transfer.
27
+ # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection]
28
+ # If set, the simulation will reject the transfer.
27
29
  #
28
30
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
29
31
 
@@ -38,7 +40,8 @@ module Increase
38
40
  # @!method initialize(reject_reason_code:)
39
41
  # If set, the simulation will reject the transfer.
40
42
  #
41
- # @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode] The reason code that the simulated rejection will have.
43
+ # @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode]
44
+ # The reason code that the simulated rejection will have.
42
45
 
43
46
  # The reason code that the simulated rejection will have.
44
47
  #
@@ -36,16 +36,19 @@ module Increase
36
36
  optional :limit, Integer
37
37
 
38
38
  # @!method initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
39
- # Some parameter documentations has been truncated, see
40
- # {Increase::Models::SupplementalDocumentListParams} for more details.
41
- #
42
39
  # @param entity_id [String] The identifier of the Entity to list supplemental documents for.
43
40
  #
44
41
  # @param cursor [String] Return the page of entries after this one.
45
42
  #
46
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
43
+ # @param idempotency_key [String]
44
+ # Filter records to the one with the specified `idempotency_key` you chose for
45
+ # that object. This value is unique across Increase and is used to ensure that a
46
+ # request is only processed once. Learn more about
47
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
47
48
  #
48
- # @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.
49
52
  #
50
53
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
51
54
  end
@@ -147,9 +147,6 @@ module Increase
147
147
  required :unstructured_remittance_information, String
148
148
 
149
149
  # @!method initialize(id:, account_id:, account_number:, amount:, bank_identification_code:, created_at:, created_by:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, idempotency_key:, instructed_amount:, instructed_currency:, pending_transaction_id:, routing_number:, source_account_number_id:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
150
- # Some parameter documentations has been truncated, see
151
- # {Increase::Models::SwiftTransfer} for more details.
152
- #
153
150
  # Swift Transfers send funds internationally.
154
151
  #
155
152
  # @param id [String] The Swift transfer's identifier.
@@ -162,9 +159,12 @@ module Increase
162
159
  #
163
160
  # @param bank_identification_code [String] The bank identification code (BIC) of the creditor.
164
161
  #
165
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
162
+ # @param created_at [Time]
163
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
164
+ # the transfer was created.
166
165
  #
167
- # @param created_by [Increase::Models::SwiftTransfer::CreatedBy] What object created the transfer, either via the API or the dashboard.
166
+ # @param created_by [Increase::Models::SwiftTransfer::CreatedBy]
167
+ # What object created the transfer, either via the API or the dashboard.
168
168
  #
169
169
  # @param creditor_address [Increase::Models::SwiftTransfer::CreditorAddress] The creditor's address.
170
170
  #
@@ -174,27 +174,45 @@ module Increase
174
174
  #
175
175
  # @param debtor_name [String] The debtor's name.
176
176
  #
177
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
177
+ # @param idempotency_key [String, nil]
178
+ # The idempotency key you chose for this object. This value is unique across
179
+ # Increase and is used to ensure that a request is only processed once. Learn more
180
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
178
181
  #
179
- # @param instructed_amount [Integer] The amount that was instructed to be transferred in minor units of the `instruct
182
+ # @param instructed_amount [Integer]
183
+ # The amount that was instructed to be transferred in minor units of the
184
+ # `instructed_currency`.
180
185
  #
181
- # @param instructed_currency [Symbol, Increase::Models::SwiftTransfer::InstructedCurrency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the inst
186
+ # @param instructed_currency [Symbol, Increase::Models::SwiftTransfer::InstructedCurrency]
187
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
188
+ # instructed amount.
182
189
  #
183
190
  # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer.
184
191
  #
185
- # @param routing_number [String, nil] The creditor's bank account routing or transit number. Required in certain count
192
+ # @param routing_number [String, nil]
193
+ # The creditor's bank account routing or transit number. Required in certain
194
+ # countries.
186
195
  #
187
- # @param source_account_number_id [String] The Account Number included in the transfer as the debtor's account number.
196
+ # @param source_account_number_id [String]
197
+ # The Account Number included in the transfer as the debtor's account number.
188
198
  #
189
199
  # @param status [Symbol, Increase::Models::SwiftTransfer::Status] The lifecycle status of the transfer.
190
200
  #
191
- # @param transaction_id [String, nil] The ID for the transaction funding the transfer. This will be populated after th
201
+ # @param transaction_id [String, nil]
202
+ # The ID for the transaction funding the transfer. This will be populated after
203
+ # the transfer is initiated.
192
204
  #
193
- # @param type [Symbol, Increase::Models::SwiftTransfer::Type] A constant representing the object's type. For this resource it will always be `
205
+ # @param type [Symbol, Increase::Models::SwiftTransfer::Type]
206
+ # A constant representing the object's type. For this resource it will always be
207
+ # `swift_transfer`.
194
208
  #
195
- # @param unique_end_to_end_transaction_reference [String] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
209
+ # @param unique_end_to_end_transaction_reference [String]
210
+ # The Unique End-to-end Transaction Reference
211
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
212
+ # for the transfer.
196
213
  #
197
- # @param unstructured_remittance_information [String] The unstructured remittance information that was included with the transfer.
214
+ # @param unstructured_remittance_information [String]
215
+ # The unstructured remittance information that was included with the transfer.
198
216
 
199
217
  # @see Increase::Models::SwiftTransfer#created_by
200
218
  class CreatedBy < Increase::Internal::Type::BaseModel
@@ -225,13 +243,17 @@ module Increase
225
243
  # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
226
244
  # What object created the transfer, either via the API or the dashboard.
227
245
  #
228
- # @param category [Symbol, Increase::Models::SwiftTransfer::CreatedBy::Category] The type of object that created this transfer.
246
+ # @param category [Symbol, Increase::Models::SwiftTransfer::CreatedBy::Category]
247
+ # The type of object that created this transfer.
229
248
  #
230
- # @param api_key [Increase::Models::SwiftTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
249
+ # @param api_key [Increase::Models::SwiftTransfer::CreatedBy::APIKey, nil]
250
+ # If present, details about the API key that created the transfer.
231
251
  #
232
- # @param oauth_application [Increase::Models::SwiftTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
252
+ # @param oauth_application [Increase::Models::SwiftTransfer::CreatedBy::OAuthApplication, nil]
253
+ # If present, details about the OAuth Application that created the transfer.
233
254
  #
234
- # @param user [Increase::Models::SwiftTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
255
+ # @param user [Increase::Models::SwiftTransfer::CreatedBy::User, nil]
256
+ # If present, details about the User that created the transfer.
235
257
 
236
258
  # The type of object that created this transfer.
237
259
  #
@@ -336,14 +358,14 @@ module Increase
336
358
  required :state, String, nil?: true
337
359
 
338
360
  # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
339
- # Some parameter documentations has been truncated, see
340
- # {Increase::Models::SwiftTransfer::CreditorAddress} for more details.
341
- #
342
361
  # The creditor's address.
343
362
  #
344
363
  # @param city [String, nil] The city, district, town, or village of the address.
345
364
  #
346
- # @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
365
+ # @param country [String]
366
+ # The two-letter
367
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
368
+ # the country of the address.
347
369
  #
348
370
  # @param line1 [String] The first line of the address.
349
371
  #
@@ -395,14 +417,14 @@ module Increase
395
417
  required :state, String, nil?: true
396
418
 
397
419
  # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
398
- # Some parameter documentations has been truncated, see
399
- # {Increase::Models::SwiftTransfer::DebtorAddress} for more details.
400
- #
401
420
  # The debtor's address.
402
421
  #
403
422
  # @param city [String, nil] The city, district, town, or village of the address.
404
423
  #
405
- # @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
424
+ # @param country [String]
425
+ # The two-letter
426
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
427
+ # the country of the address.
406
428
  #
407
429
  # @param line1 [String] The first line of the address.
408
430
  #
@@ -90,16 +90,17 @@ module Increase
90
90
  optional :routing_number, String
91
91
 
92
92
  # @!method initialize(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
93
- # Some parameter documentations has been truncated, see
94
- # {Increase::Models::SwiftTransferCreateParams} for more details.
95
- #
96
93
  # @param account_id [String] The identifier for the account that will send the transfer.
97
94
  #
98
95
  # @param account_number [String] The creditor's account number.
99
96
  #
100
- # @param bank_identification_code [String] The bank identification code (BIC) of the creditor. If it ends with the three-ch
97
+ # @param bank_identification_code [String]
98
+ # The bank identification code (BIC) of the creditor. If it ends with the
99
+ # three-character branch code, this must be 11 characters long. Otherwise this
100
+ # must be 8 characters and the branch code will be assumed to be `XXX`.
101
101
  #
102
- # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress] The creditor's address.
102
+ # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress]
103
+ # The creditor's address.
103
104
  #
104
105
  # @param creditor_name [String] The creditor's name.
105
106
  #
@@ -107,17 +108,25 @@ module Increase
107
108
  #
108
109
  # @param debtor_name [String] The debtor's name.
109
110
  #
110
- # @param instructed_amount [Integer] The amount, in minor units of `instructed_currency`, to send to the creditor.
111
+ # @param instructed_amount [Integer]
112
+ # The amount, in minor units of `instructed_currency`, to send to the creditor.
111
113
  #
112
- # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the inst
114
+ # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency]
115
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
116
+ # instructed amount.
113
117
  #
114
- # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
118
+ # @param source_account_number_id [String]
119
+ # The Account Number to include in the transfer as the debtor's account number.
115
120
  #
116
- # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
121
+ # @param unstructured_remittance_information [String]
122
+ # Unstructured remittance information to include in the transfer.
117
123
  #
118
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
124
+ # @param require_approval [Boolean]
125
+ # Whether the transfer requires explicit approval via the dashboard or API.
119
126
  #
120
- # @param routing_number [String] The creditor's bank account routing or transit number. Required in certain count
127
+ # @param routing_number [String]
128
+ # The creditor's bank account routing or transit number. Required in certain
129
+ # countries.
121
130
  #
122
131
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
123
132
 
@@ -161,14 +170,14 @@ module Increase
161
170
  optional :state, String
162
171
 
163
172
  # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
164
- # Some parameter documentations has been truncated, see
165
- # {Increase::Models::SwiftTransferCreateParams::CreditorAddress} for more details.
166
- #
167
173
  # The creditor's address.
168
174
  #
169
175
  # @param city [String] The city, district, town, or village of the address.
170
176
  #
171
- # @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
177
+ # @param country [String]
178
+ # The two-letter
179
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
180
+ # the country of the address.
172
181
  #
173
182
  # @param line1 [String] The first line of the address. This is usually the street number and street.
174
183
  #
@@ -219,14 +228,14 @@ module Increase
219
228
  optional :state, String
220
229
 
221
230
  # @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
222
- # Some parameter documentations has been truncated, see
223
- # {Increase::Models::SwiftTransferCreateParams::DebtorAddress} for more details.
224
- #
225
231
  # The debtor's address.
226
232
  #
227
233
  # @param city [String] The city, district, town, or village of the address.
228
234
  #
229
- # @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
235
+ # @param country [String]
236
+ # The two-letter
237
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
238
+ # the country of the address.
230
239
  #
231
240
  # @param line1 [String] The first line of the address. This is usually the street number and street.
232
241
  #
@@ -46,18 +46,21 @@ module Increase
46
46
  optional :status, -> { Increase::SwiftTransferListParams::Status }
47
47
 
48
48
  # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
49
- # Some parameter documentations has been truncated, see
50
- # {Increase::Models::SwiftTransferListParams} for more details.
51
- #
52
49
  # @param account_id [String] Filter Swift Transfers to those that originated from the specified Account.
53
50
  #
54
51
  # @param created_at [Increase::Models::SwiftTransferListParams::CreatedAt]
55
52
  #
56
53
  # @param cursor [String] Return the page of entries after this one.
57
54
  #
58
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
55
+ # @param idempotency_key [String]
56
+ # Filter records to the one with the specified `idempotency_key` you chose for
57
+ # that object. This value is unique across Increase and is used to ensure that a
58
+ # request is only processed once. Learn more about
59
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
59
60
  #
60
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
61
+ # @param limit [Integer]
62
+ # Limit the size of the list that is returned. The default (and maximum) is 100
63
+ # objects.
61
64
  #
62
65
  # @param status [Increase::Models::SwiftTransferListParams::Status]
63
66
  #
@@ -93,16 +96,21 @@ module Increase
93
96
  optional :on_or_before, Time
94
97
 
95
98
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
96
- # Some parameter documentations has been truncated, see
97
- # {Increase::Models::SwiftTransferListParams::CreatedAt} for more details.
98
- #
99
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
99
+ # @param after [Time]
100
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
101
+ # timestamp.
100
102
  #
101
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
103
+ # @param before [Time]
104
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
105
+ # timestamp.
102
106
  #
103
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
107
+ # @param on_or_after [Time]
108
+ # Return results on or after this
109
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
104
110
  #
105
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
111
+ # @param on_or_before [Time]
112
+ # Return results on or before this
113
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
106
114
  end
107
115
 
108
116
  class Status < Increase::Internal::Type::BaseModel
@@ -118,10 +126,9 @@ module Increase
118
126
  api_name: :in
119
127
 
120
128
  # @!method initialize(in_: nil)
121
- # Some parameter documentations has been truncated, see
122
- # {Increase::Models::SwiftTransferListParams::Status} for more details.
123
- #
124
- # @param in_ [Array<Symbol, Increase::Models::SwiftTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
129
+ # @param in_ [Array<Symbol, Increase::Models::SwiftTransferListParams::Status::In>]
130
+ # Return results whose value is in the provided list. For GET requests, this
131
+ # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
125
132
 
126
133
  module In
127
134
  extend Increase::Internal::Type::Enum