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
@@ -162,26 +162,42 @@ module Increase
162
162
  optional :require_approval, Increase::Internal::Type::Boolean
163
163
 
164
164
  # @!method initialize(business_application_identifier:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, merchant_legal_business_name: nil, merchant_street_address: nil, recipient_address_city: nil, recipient_address_line1: nil, recipient_address_postal_code: nil, recipient_address_state: nil, require_approval: nil, request_options: {})
165
- # Some parameter documentations has been truncated, see
166
- # {Increase::Models::CardPushTransferCreateParams} for more details.
165
+ # @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier]
166
+ # The Business Application Identifier describes the type of transaction being
167
+ # performed. Your program must be approved for the specified Business Application
168
+ # Identifier in order to use it.
167
169
  #
168
- # @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier] The Business Application Identifier describes the type of transaction being perf
170
+ # @param card_token_id [String]
171
+ # The Increase identifier for the Card Token that represents the card number
172
+ # you're pushing funds to.
169
173
  #
170
- # @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
174
+ # @param merchant_category_code [String]
175
+ # The merchant category code (MCC) of the merchant (generally your business)
176
+ # sending the transfer. This is a four-digit code that describes the type of
177
+ # business or service provided by the merchant. Your program must be approved for
178
+ # the specified MCC in order to use it.
171
179
  #
172
- # @param merchant_category_code [String] The merchant category code (MCC) of the merchant (generally your business) sendi
180
+ # @param merchant_city_name [String]
181
+ # The city name of the merchant (generally your business) sending the transfer.
173
182
  #
174
- # @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
183
+ # @param merchant_name [String]
184
+ # The merchant name shows up as the statement descriptor for the transfer. This is
185
+ # typically the name of your business or organization.
175
186
  #
176
- # @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
187
+ # @param merchant_name_prefix [String]
188
+ # For certain Business Application Identifiers, the statement descriptor is
189
+ # `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
190
+ # four character prefix that identifies the merchant.
177
191
  #
178
- # @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
179
- #
180
- # @param merchant_postal_code [String] The postal code of the merchant (generally your business) sending the transfer.
192
+ # @param merchant_postal_code [String]
193
+ # The postal code of the merchant (generally your business) sending the transfer.
181
194
  #
182
195
  # @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
183
196
  #
184
- # @param presentment_amount [Increase::Models::CardPushTransferCreateParams::PresentmentAmount] The amount to transfer. The receiving bank will convert this to the cardholder's
197
+ # @param presentment_amount [Increase::Models::CardPushTransferCreateParams::PresentmentAmount]
198
+ # The amount to transfer. The receiving bank will convert this to the cardholder's
199
+ # currency. The amount that is applied to your Increase account matches the
200
+ # currency of your account.
185
201
  #
186
202
  # @param recipient_name [String] The name of the funds recipient.
187
203
  #
@@ -195,21 +211,33 @@ module Increase
195
211
  #
196
212
  # @param sender_name [String] The name of the funds originator.
197
213
  #
198
- # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer.
214
+ # @param source_account_number_id [String]
215
+ # The identifier of the Account Number from which to send the transfer.
199
216
  #
200
- # @param merchant_legal_business_name [String] The legal business name of the merchant (generally your business) sending the tr
217
+ # @param merchant_legal_business_name [String]
218
+ # The legal business name of the merchant (generally your business) sending the
219
+ # transfer. Required if the card is issued in Canada.
201
220
  #
202
- # @param merchant_street_address [String] The street address of the merchant (generally your business) sending the transfe
221
+ # @param merchant_street_address [String]
222
+ # The street address of the merchant (generally your business) sending the
223
+ # transfer. Required if the card is issued in Canada.
203
224
  #
204
- # @param recipient_address_city [String] The city of the recipient. Required if the card is issued in Canada.
225
+ # @param recipient_address_city [String]
226
+ # The city of the recipient. Required if the card is issued in Canada.
205
227
  #
206
- # @param recipient_address_line1 [String] The first line of the recipient's address. Required if the card is issued in Can
228
+ # @param recipient_address_line1 [String]
229
+ # The first line of the recipient's address. Required if the card is issued in
230
+ # Canada.
207
231
  #
208
- # @param recipient_address_postal_code [String] The postal code of the recipient. Required if the card is issued in Canada.
232
+ # @param recipient_address_postal_code [String]
233
+ # The postal code of the recipient. Required if the card is issued in Canada.
209
234
  #
210
- # @param recipient_address_state [String] The state or province of the recipient. Required if the card is issued in Canada
235
+ # @param recipient_address_state [String]
236
+ # The state or province of the recipient. Required if the card is issued in
237
+ # Canada.
211
238
  #
212
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
239
+ # @param require_approval [Boolean]
240
+ # Whether the transfer requires explicit approval via the dashboard or API.
213
241
  #
214
242
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
215
243
 
@@ -283,17 +311,19 @@ module Increase
283
311
  required :value, String
284
312
 
285
313
  # @!method initialize(currency:, value:)
286
- # Some parameter documentations has been truncated, see
287
- # {Increase::Models::CardPushTransferCreateParams::PresentmentAmount} for more
288
- # details.
289
- #
290
314
  # The amount to transfer. The receiving bank will convert this to the cardholder's
291
315
  # currency. The amount that is applied to your Increase account matches the
292
316
  # currency of your account.
293
317
  #
294
- # @param currency [Symbol, Increase::Models::CardPushTransferCreateParams::PresentmentAmount::Currency] The ISO 4217 currency code representing the currency of the amount.
318
+ # @param currency [Symbol, Increase::Models::CardPushTransferCreateParams::PresentmentAmount::Currency]
319
+ # The ISO 4217 currency code representing the currency of the amount.
295
320
  #
296
- # @param value [String] The amount value as a decimal string in the currency's major unit. For example,
321
+ # @param value [String]
322
+ # The amount value as a decimal string in the currency's major unit. For example,
323
+ # for USD, '1234.56' represents 1234 dollars and 56 cents. For JPY, '1234'
324
+ # represents 1234 yen. A currency with minor units requires at least one decimal
325
+ # place and supports up to the number of decimal places defined by the currency's
326
+ # minor units. A currency without minor units does not support any decimal places.
297
327
 
298
328
  # The ISO 4217 currency code representing the currency of the amount.
299
329
  #
@@ -46,18 +46,21 @@ module Increase
46
46
  optional :status, -> { Increase::CardPushTransferListParams::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::CardPushTransferListParams} for more details.
51
- #
52
49
  # @param account_id [String] Filter Card Push Transfers to ones belonging to the specified Account.
53
50
  #
54
51
  # @param created_at [Increase::Models::CardPushTransferListParams::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::CardPushTransferListParams::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::CardPushTransferListParams::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::CardPushTransferListParams::Status} for more details.
123
- #
124
- # @param in_ [Array<Symbol, Increase::Models::CardPushTransferListParams::Status::In>] Filter Card Push Transfers by status. For GET requests, this should be encoded a
129
+ # @param in_ [Array<Symbol, Increase::Models::CardPushTransferListParams::Status::In>]
130
+ # Filter Card Push Transfers by status. For GET requests, this should be encoded
131
+ # as a comma-delimited string, such as `?in=one,two,three`.
125
132
 
126
133
  module In
127
134
  extend Increase::Internal::Type::Enum
@@ -50,17 +50,18 @@ module Increase
50
50
  required :type, enum: -> { Increase::CardToken::Type }
51
51
 
52
52
  # @!method initialize(id:, created_at:, expiration_date:, last4:, length:, prefix:, type:)
53
- # Some parameter documentations has been truncated, see
54
- # {Increase::Models::CardToken} for more details.
55
- #
56
53
  # Card Tokens represent a tokenized card number that can be used for Card Push
57
54
  # Transfers and Card Validations.
58
55
  #
59
56
  # @param id [String] The Card Token's identifier.
60
57
  #
61
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
58
+ # @param created_at [Time]
59
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
60
+ # the card token was created.
62
61
  #
63
- # @param expiration_date [Date] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card expire
62
+ # @param expiration_date [Date]
63
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card
64
+ # expires.
64
65
  #
65
66
  # @param last4 [String] The last 4 digits of the card number.
66
67
  #
@@ -68,7 +69,9 @@ module Increase
68
69
  #
69
70
  # @param prefix [String] The prefix of the card number, usually 8 digits.
70
71
  #
71
- # @param type [Symbol, Increase::Models::CardToken::Type] A constant representing the object's type. For this resource it will always be `
72
+ # @param type [Symbol, Increase::Models::CardToken::Type]
73
+ # A constant representing the object's type. For this resource it will always be
74
+ # `card_token`.
72
75
 
73
76
  # A constant representing the object's type. For this resource it will always be
74
77
  # `card_token`.
@@ -18,16 +18,16 @@ module Increase
18
18
  required :type, enum: -> { Increase::CardTokenCapabilities::Type }
19
19
 
20
20
  # @!method initialize(routes:, type:)
21
- # Some parameter documentations has been truncated, see
22
- # {Increase::Models::CardTokenCapabilities} for more details.
23
- #
24
21
  # The capabilities of a Card Token describe whether the card can be used for
25
22
  # specific operations, such as Card Push Transfers. The capabilities can change
26
23
  # over time based on the issuing bank's configuration of the card range.
27
24
  #
28
- # @param routes [Array<Increase::Models::CardTokenCapabilities::Route>] Each route represent a path e.g., a push transfer can take.
25
+ # @param routes [Array<Increase::Models::CardTokenCapabilities::Route>]
26
+ # Each route represent a path e.g., a push transfer can take.
29
27
  #
30
- # @param type [Symbol, Increase::Models::CardTokenCapabilities::Type] A constant representing the object's type. For this resource it will always be `
28
+ # @param type [Symbol, Increase::Models::CardTokenCapabilities::Type]
29
+ # A constant representing the object's type. For this resource it will always be
30
+ # `card_token_capabilities`.
31
31
 
32
32
  class Route < Increase::Internal::Type::BaseModel
33
33
  # @!attribute cross_border_push_transfers
@@ -57,13 +57,16 @@ module Increase
57
57
  required :route, enum: -> { Increase::CardTokenCapabilities::Route::Route }
58
58
 
59
59
  # @!method initialize(cross_border_push_transfers:, domestic_push_transfers:, issuer_country:, route:)
60
- # @param cross_border_push_transfers [Symbol, Increase::Models::CardTokenCapabilities::Route::CrossBorderPushTransfers] Whether you can push funds to the card using cross-border Card Push Transfers.
60
+ # @param cross_border_push_transfers [Symbol, Increase::Models::CardTokenCapabilities::Route::CrossBorderPushTransfers]
61
+ # Whether you can push funds to the card using cross-border Card Push Transfers.
61
62
  #
62
- # @param domestic_push_transfers [Symbol, Increase::Models::CardTokenCapabilities::Route::DomesticPushTransfers] Whether you can push funds to the card using domestic Card Push Transfers.
63
+ # @param domestic_push_transfers [Symbol, Increase::Models::CardTokenCapabilities::Route::DomesticPushTransfers]
64
+ # Whether you can push funds to the card using domestic Card Push Transfers.
63
65
  #
64
66
  # @param issuer_country [String] The ISO-3166-1 alpha-2 country code of the card's issuing bank.
65
67
  #
66
- # @param route [Symbol, Increase::Models::CardTokenCapabilities::Route::Route] The card network route the capabilities apply to.
68
+ # @param route [Symbol, Increase::Models::CardTokenCapabilities::Route::Route]
69
+ # The card network route the capabilities apply to.
67
70
 
68
71
  # Whether you can push funds to the card using cross-border Card Push Transfers.
69
72
  #
@@ -26,14 +26,13 @@ module Increase
26
26
  optional :limit, Integer
27
27
 
28
28
  # @!method initialize(created_at: nil, cursor: nil, limit: nil, request_options: {})
29
- # Some parameter documentations has been truncated, see
30
- # {Increase::Models::CardTokenListParams} for more details.
31
- #
32
29
  # @param created_at [Increase::Models::CardTokenListParams::CreatedAt]
33
30
  #
34
31
  # @param cursor [String] Return the page of entries after this one.
35
32
  #
36
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
33
+ # @param limit [Integer]
34
+ # Limit the size of the list that is returned. The default (and maximum) is 100
35
+ # objects.
37
36
  #
38
37
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
39
38
 
@@ -67,16 +66,21 @@ module Increase
67
66
  optional :on_or_before, Time
68
67
 
69
68
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
70
- # Some parameter documentations has been truncated, see
71
- # {Increase::Models::CardTokenListParams::CreatedAt} for more details.
72
- #
73
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
69
+ # @param after [Time]
70
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
71
+ # timestamp.
74
72
  #
75
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
73
+ # @param before [Time]
74
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
75
+ # timestamp.
76
76
  #
77
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
77
+ # @param on_or_after [Time]
78
+ # Return results on or after this
79
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
78
80
  #
79
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
81
+ # @param on_or_before [Time]
82
+ # Return results on or before this
83
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
80
84
  end
81
85
  end
82
86
  end
@@ -53,20 +53,24 @@ module Increase
53
53
  optional :status, enum: -> { Increase::CardUpdateParams::Status }
54
54
 
55
55
  # @!method initialize(card_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
56
- # Some parameter documentations has been truncated, see
57
- # {Increase::Models::CardUpdateParams} for more details.
58
- #
59
56
  # @param card_id [String] The card identifier.
60
57
  #
61
- # @param authorization_controls [Increase::Models::CardUpdateParams::AuthorizationControls] Controls that restrict how this card can be used.
58
+ # @param authorization_controls [Increase::Models::CardUpdateParams::AuthorizationControls]
59
+ # Controls that restrict how this card can be used.
62
60
  #
63
- # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] The card's updated billing address.
61
+ # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
62
+ # The card's updated billing address.
64
63
  #
65
64
  # @param description [String] The description you choose to give the card.
66
65
  #
67
- # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre
66
+ # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet]
67
+ # The contact information used in the two-factor steps for digital wallet card
68
+ # creation. At least one field must be present to complete the digital wallet
69
+ # steps.
68
70
  #
69
- # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
71
+ # @param entity_id [String]
72
+ # The Entity the card belongs to. You only need to supply this in rare situations
73
+ # when the card is not for the Account holder.
70
74
  #
71
75
  # @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
72
76
  #
@@ -103,18 +107,22 @@ module Increase
103
107
  optional :usage, -> { Increase::CardUpdateParams::AuthorizationControls::Usage }
104
108
 
105
109
  # @!method initialize(merchant_acceptor_identifier: nil, merchant_category_code: nil, merchant_country: nil, usage: nil)
106
- # Some parameter documentations has been truncated, see
107
- # {Increase::Models::CardUpdateParams::AuthorizationControls} for more details.
108
- #
109
110
  # Controls that restrict how this card can be used.
110
111
  #
111
- # @param merchant_acceptor_identifier [Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier] Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
112
+ # @param merchant_acceptor_identifier [Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier]
113
+ # Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
114
+ # on this card.
112
115
  #
113
- # @param merchant_category_code [Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode] Restricts which Merchant Category Codes are allowed or blocked for authorization
116
+ # @param merchant_category_code [Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode]
117
+ # Restricts which Merchant Category Codes are allowed or blocked for
118
+ # authorizations on this card.
114
119
  #
115
- # @param merchant_country [Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry] Restricts which merchant countries are allowed or blocked for authorizations on
120
+ # @param merchant_country [Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry]
121
+ # Restricts which merchant countries are allowed or blocked for authorizations on
122
+ # this card.
116
123
  #
117
- # @param usage [Increase::Models::CardUpdateParams::AuthorizationControls::Usage] Controls how many times this card can be used.
124
+ # @param usage [Increase::Models::CardUpdateParams::AuthorizationControls::Usage]
125
+ # Controls how many times this card can be used.
118
126
 
119
127
  # @see Increase::Models::CardUpdateParams::AuthorizationControls#merchant_acceptor_identifier
120
128
  class MerchantAcceptorIdentifier < Increase::Internal::Type::BaseModel
@@ -135,16 +143,16 @@ module Increase
135
143
  -> { Increase::Internal::Type::ArrayOf[Increase::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier::Blocked] }
136
144
 
137
145
  # @!method initialize(allowed: nil, blocked: nil)
138
- # Some parameter documentations has been truncated, see
139
- # {Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier}
140
- # for more details.
141
- #
142
146
  # Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
143
147
  # on this card.
144
148
  #
145
- # @param allowed [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>] The Merchant Acceptor IDs that are allowed for authorizations on this card. Auth
149
+ # @param allowed [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>]
150
+ # The Merchant Acceptor IDs that are allowed for authorizations on this card.
151
+ # Authorizations with Merchant Acceptor IDs not in this list will be declined.
146
152
  #
147
- # @param blocked [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>] The Merchant Acceptor IDs that are blocked for authorizations on this card. Auth
153
+ # @param blocked [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>]
154
+ # The Merchant Acceptor IDs that are blocked for authorizations on this card.
155
+ # Authorizations with Merchant Acceptor IDs in this list will be declined.
148
156
 
149
157
  class Allowed < Increase::Internal::Type::BaseModel
150
158
  # @!attribute identifier
@@ -188,16 +196,16 @@ module Increase
188
196
  -> { Increase::Internal::Type::ArrayOf[Increase::CardUpdateParams::AuthorizationControls::MerchantCategoryCode::Blocked] }
189
197
 
190
198
  # @!method initialize(allowed: nil, blocked: nil)
191
- # Some parameter documentations has been truncated, see
192
- # {Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode}
193
- # for more details.
194
- #
195
199
  # Restricts which Merchant Category Codes are allowed or blocked for
196
200
  # authorizations on this card.
197
201
  #
198
- # @param allowed [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode::Allowed>] The Merchant Category Codes that are allowed for authorizations on this card. Au
202
+ # @param allowed [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode::Allowed>]
203
+ # The Merchant Category Codes that are allowed for authorizations on this card.
204
+ # Authorizations with Merchant Category Codes not in this list will be declined.
199
205
  #
200
- # @param blocked [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode::Blocked>] The Merchant Category Codes that are blocked for authorizations on this card. Au
206
+ # @param blocked [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCategoryCode::Blocked>]
207
+ # The Merchant Category Codes that are blocked for authorizations on this card.
208
+ # Authorizations with Merchant Category Codes in this list will be declined.
201
209
 
202
210
  class Allowed < Increase::Internal::Type::BaseModel
203
211
  # @!attribute code
@@ -241,16 +249,16 @@ module Increase
241
249
  -> { Increase::Internal::Type::ArrayOf[Increase::CardUpdateParams::AuthorizationControls::MerchantCountry::Blocked] }
242
250
 
243
251
  # @!method initialize(allowed: nil, blocked: nil)
244
- # Some parameter documentations has been truncated, see
245
- # {Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry} for
246
- # more details.
247
- #
248
252
  # Restricts which merchant countries are allowed or blocked for authorizations on
249
253
  # this card.
250
254
  #
251
- # @param allowed [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry::Allowed>] The merchant countries that are allowed for authorizations on this card. Authori
255
+ # @param allowed [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry::Allowed>]
256
+ # The merchant countries that are allowed for authorizations on this card.
257
+ # Authorizations with merchant countries not in this list will be declined.
252
258
  #
253
- # @param blocked [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry::Blocked>] The merchant countries that are blocked for authorizations on this card. Authori
259
+ # @param blocked [Array<Increase::Models::CardUpdateParams::AuthorizationControls::MerchantCountry::Blocked>]
260
+ # The merchant countries that are blocked for authorizations on this card.
261
+ # Authorizations with merchant countries in this list will be declined.
254
262
 
255
263
  class Allowed < Increase::Internal::Type::BaseModel
256
264
  # @!attribute country
@@ -297,17 +305,17 @@ module Increase
297
305
  optional :single_use, -> { Increase::CardUpdateParams::AuthorizationControls::Usage::SingleUse }
298
306
 
299
307
  # @!method initialize(category:, multi_use: nil, single_use: nil)
300
- # Some parameter documentations has been truncated, see
301
- # {Increase::Models::CardUpdateParams::AuthorizationControls::Usage} for more
302
- # details.
303
- #
304
308
  # Controls how many times this card can be used.
305
309
  #
306
- # @param category [Symbol, Increase::Models::CardUpdateParams::AuthorizationControls::Usage::Category] Whether the card is for a single use or multiple uses.
310
+ # @param category [Symbol, Increase::Models::CardUpdateParams::AuthorizationControls::Usage::Category]
311
+ # Whether the card is for a single use or multiple uses.
307
312
  #
308
- # @param multi_use [Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse] Controls for multi-use cards. Required if and only if `category` is `multi_use`.
313
+ # @param multi_use [Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse]
314
+ # Controls for multi-use cards. Required if and only if `category` is `multi_use`.
309
315
  #
310
- # @param single_use [Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse] Controls for single-use cards. Required if and only if `category` is `single_use
316
+ # @param single_use [Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse]
317
+ # Controls for single-use cards. Required if and only if `category` is
318
+ # `single_use`.
311
319
 
312
320
  # Whether the card is for a single use or multiple uses.
313
321
  #
@@ -336,13 +344,11 @@ module Increase
336
344
  -> { Increase::Internal::Type::ArrayOf[Increase::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit] }
337
345
 
338
346
  # @!method initialize(spending_limits: nil)
339
- # Some parameter documentations has been truncated, see
340
- # {Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse} for
341
- # more details.
342
- #
343
347
  # Controls for multi-use cards. Required if and only if `category` is `multi_use`.
344
348
  #
345
- # @param spending_limits [Array<Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit>] Spending limits for this card. The most restrictive limit applies if multiple li
349
+ # @param spending_limits [Array<Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit>]
350
+ # Spending limits for this card. The most restrictive limit applies if multiple
351
+ # limits match.
346
352
 
347
353
  class SpendingLimit < Increase::Internal::Type::BaseModel
348
354
  # @!attribute interval
@@ -367,15 +373,14 @@ module Increase
367
373
  -> { Increase::Internal::Type::ArrayOf[Increase::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode] }
368
374
 
369
375
  # @!method initialize(interval:, settlement_amount:, merchant_category_codes: nil)
370
- # Some parameter documentations has been truncated, see
371
- # {Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit}
372
- # for more details.
373
- #
374
- # @param interval [Symbol, Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval] The interval at which the spending limit is enforced.
376
+ # @param interval [Symbol, Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval]
377
+ # The interval at which the spending limit is enforced.
375
378
  #
376
379
  # @param settlement_amount [Integer] The maximum settlement amount permitted in the given interval.
377
380
  #
378
- # @param merchant_category_codes [Array<Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>] The Merchant Category Codes this spending limit applies to. If not set, the limi
381
+ # @param merchant_category_codes [Array<Increase::Models::CardUpdateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>]
382
+ # The Merchant Category Codes this spending limit applies to. If not set, the
383
+ # limit applies to all transactions.
379
384
 
380
385
  # The interval at which the spending limit is enforced.
381
386
  #
@@ -428,7 +433,8 @@ module Increase
428
433
  # Controls for single-use cards. Required if and only if `category` is
429
434
  # `single_use`.
430
435
  #
431
- # @param settlement_amount [Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount] The settlement amount constraint for this single-use card.
436
+ # @param settlement_amount [Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount]
437
+ # The settlement amount constraint for this single-use card.
432
438
 
433
439
  # @see Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse#settlement_amount
434
440
  class SettlementAmount < Increase::Internal::Type::BaseModel
@@ -448,7 +454,8 @@ module Increase
448
454
  # @!method initialize(comparison:, value:)
449
455
  # The settlement amount constraint for this single-use card.
450
456
  #
451
- # @param comparison [Symbol, Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison] The operator used to compare the settlement amount.
457
+ # @param comparison [Symbol, Increase::Models::CardUpdateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison]
458
+ # The operator used to compare the settlement amount.
452
459
  #
453
460
  # @param value [Integer] The settlement amount value.
454
461
 
@@ -539,18 +546,19 @@ module Increase
539
546
  optional :phone, String
540
547
 
541
548
  # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil)
542
- # Some parameter documentations has been truncated, see
543
- # {Increase::Models::CardUpdateParams::DigitalWallet} for more details.
544
- #
545
549
  # The contact information used in the two-factor steps for digital wallet card
546
550
  # creation. At least one field must be present to complete the digital wallet
547
551
  # steps.
548
552
  #
549
553
  # @param digital_card_profile_id [String] The digital card profile assigned to this digital card.
550
554
  #
551
- # @param email [String] An email address that can be used to verify the cardholder via one-time passcode
555
+ # @param email [String]
556
+ # An email address that can be used to verify the cardholder via one-time passcode
557
+ # over email.
552
558
  #
553
- # @param phone [String] A phone number that can be used to verify the cardholder via one-time passcode o
559
+ # @param phone [String]
560
+ # A phone number that can be used to verify the cardholder via one-time passcode
561
+ # over SMS.
554
562
  end
555
563
 
556
564
  # The status to update the Card with.