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.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/increase/client.rb +8 -6
- data/lib/increase/internal/type/converter.rb +13 -12
- data/lib/increase/models/account.rb +40 -19
- data/lib/increase/models/account_create_params.rb +14 -11
- data/lib/increase/models/account_list_params.rb +25 -17
- data/lib/increase/models/account_number.rb +22 -14
- data/lib/increase/models/account_number_create_params.rb +12 -13
- data/lib/increase/models/account_number_list_params.rb +26 -20
- data/lib/increase/models/account_number_update_params.rb +12 -11
- data/lib/increase/models/account_statement.rb +15 -11
- data/lib/increase/models/account_statement_list_params.rb +15 -12
- data/lib/increase/models/account_transfer.rb +58 -29
- data/lib/increase/models/account_transfer_create_params.rb +12 -7
- data/lib/increase/models/account_transfer_list_params.rb +20 -12
- data/lib/increase/models/ach_prenotification.rb +48 -27
- data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
- data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
- data/lib/increase/models/ach_transfer.rb +199 -103
- data/lib/increase/models/ach_transfer_create_params.rb +110 -61
- data/lib/increase/models/ach_transfer_list_params.rb +23 -16
- data/lib/increase/models/balance_lookup.rb +14 -11
- data/lib/increase/models/beneficial_owner_create_params.rb +48 -37
- data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
- data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
- data/lib/increase/models/card.rb +69 -47
- data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
- data/lib/increase/models/card_create_params.rb +65 -56
- data/lib/increase/models/card_details.rb +7 -5
- data/lib/increase/models/card_dispute.rb +530 -306
- data/lib/increase/models/card_dispute_create_params.rb +271 -175
- data/lib/increase/models/card_dispute_list_params.rb +24 -16
- data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
- data/lib/increase/models/card_iframe_url.rb +3 -4
- data/lib/increase/models/card_list_params.rb +23 -16
- data/lib/increase/models/card_payment.rb +1941 -1200
- data/lib/increase/models/card_payment_list_params.rb +15 -11
- data/lib/increase/models/card_purchase_supplement.rb +37 -25
- data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
- data/lib/increase/models/card_push_transfer.rb +121 -65
- data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
- data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
- data/lib/increase/models/card_token.rb +9 -6
- data/lib/increase/models/card_token_capabilities.rb +11 -8
- data/lib/increase/models/card_token_list_params.rb +15 -11
- data/lib/increase/models/card_update_params.rb +65 -57
- data/lib/increase/models/card_validation.rb +76 -43
- data/lib/increase/models/card_validation_create_params.rb +11 -7
- data/lib/increase/models/card_validation_list_params.rb +23 -16
- data/lib/increase/models/check_deposit.rb +103 -52
- data/lib/increase/models/check_deposit_create_params.rb +2 -4
- data/lib/increase/models/check_deposit_list_params.rb +20 -12
- data/lib/increase/models/check_transfer.rb +124 -75
- data/lib/increase/models/check_transfer_create_params.rb +91 -51
- data/lib/increase/models/check_transfer_list_params.rb +24 -16
- data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
- data/lib/increase/models/declined_transaction.rb +339 -206
- data/lib/increase/models/declined_transaction_list_params.rb +18 -15
- data/lib/increase/models/digital_card_profile.rb +16 -9
- data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
- data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
- data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
- data/lib/increase/models/digital_wallet_token.rb +26 -17
- data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
- data/lib/increase/models/entity.rb +175 -135
- data/lib/increase/models/entity_archive_params.rb +3 -4
- data/lib/increase/models/entity_beneficial_owner.rb +24 -19
- data/lib/increase/models/entity_create_params.rb +323 -236
- data/lib/increase/models/entity_list_params.rb +67 -16
- data/lib/increase/models/entity_onboarding_session.rb +25 -11
- data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
- data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
- data/lib/increase/models/entity_supplemental_document.rb +10 -6
- data/lib/increase/models/entity_update_params.rb +112 -86
- data/lib/increase/models/event.rb +6 -5
- data/lib/increase/models/event_list_params.rb +23 -17
- data/lib/increase/models/event_subscription.rb +17 -9
- data/lib/increase/models/event_subscription_create_params.rb +14 -8
- data/lib/increase/models/event_subscription_list_params.rb +8 -5
- data/lib/increase/models/event_subscription_update_params.rb +2 -1
- data/lib/increase/models/export.rb +69 -30
- data/lib/increase/models/export_create_params.rb +76 -46
- data/lib/increase/models/export_list_params.rb +26 -17
- data/lib/increase/models/external_account.rb +14 -8
- data/lib/increase/models/external_account_create_params.rb +7 -6
- data/lib/increase/models/external_account_list_params.rb +12 -9
- data/lib/increase/models/external_account_update_params.rb +6 -3
- data/lib/increase/models/fednow_transfer.rb +62 -32
- data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
- data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
- data/lib/increase/models/file.rb +13 -7
- data/lib/increase/models/file_create_params.rb +6 -5
- data/lib/increase/models/file_link.rb +17 -8
- data/lib/increase/models/file_link_create_params.rb +3 -4
- data/lib/increase/models/file_list_params.rb +23 -16
- data/lib/increase/models/group.rb +6 -5
- data/lib/increase/models/inbound_ach_transfer.rb +115 -51
- data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
- data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
- data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
- data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
- data/lib/increase/models/inbound_check_deposit.rb +46 -19
- data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
- data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
- data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
- data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
- data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_mail_item.rb +13 -8
- data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
- data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
- data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
- data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
- data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
- data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_wire_transfer.rb +33 -21
- data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
- data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
- data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
- data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
- data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
- data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
- data/lib/increase/models/intrafi_balance.rb +18 -12
- data/lib/increase/models/intrafi_exclusion.rb +13 -7
- data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
- data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
- data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
- data/lib/increase/models/lockbox_address.rb +16 -11
- data/lib/increase/models/lockbox_address_list_params.rb +20 -12
- data/lib/increase/models/lockbox_address_update_params.rb +2 -1
- data/lib/increase/models/lockbox_recipient.rb +22 -10
- data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
- data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
- data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
- data/lib/increase/models/oauth_application.rb +12 -7
- data/lib/increase/models/oauth_application_list_params.rb +18 -15
- data/lib/increase/models/oauth_connection.rb +9 -6
- data/lib/increase/models/oauth_connection_list_params.rb +10 -9
- data/lib/increase/models/oauth_token.rb +6 -5
- data/lib/increase/models/oauth_token_create_params.rb +14 -7
- data/lib/increase/models/pending_transaction.rb +392 -239
- data/lib/increase/models/pending_transaction_create_params.rb +6 -6
- data/lib/increase/models/pending_transaction_list_params.rb +23 -19
- data/lib/increase/models/physical_card.rb +36 -24
- data/lib/increase/models/physical_card_create_params.rb +22 -17
- data/lib/increase/models/physical_card_list_params.rb +20 -12
- data/lib/increase/models/physical_card_profile.rb +33 -17
- data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
- data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
- data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
- data/lib/increase/models/physical_card_update_params.rb +2 -1
- data/lib/increase/models/program.rb +15 -8
- data/lib/increase/models/program_list_params.rb +3 -4
- data/lib/increase/models/real_time_decision.rb +561 -370
- data/lib/increase/models/real_time_decision_action_params.rb +86 -75
- data/lib/increase/models/real_time_payments_transfer.rb +90 -47
- data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
- data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
- data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
- data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
- data/lib/increase/models/routing_number_list_params.rb +3 -4
- data/lib/increase/models/routing_number_list_response.rb +11 -8
- data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
- data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
- data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
- data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
- data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
- data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
- data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
- data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
- data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
- data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
- data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
- data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
- data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
- data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
- data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
- data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
- data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
- data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
- data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
- data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
- data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
- data/lib/increase/models/simulations/export_create_params.rb +5 -5
- data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
- data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
- data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
- data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
- data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
- data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
- data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
- data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
- data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
- data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
- data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
- data/lib/increase/models/simulations/program_create_params.rb +4 -2
- data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
- data/lib/increase/models/supplemental_document_list_params.rb +8 -5
- data/lib/increase/models/swift_transfer.rb +48 -26
- data/lib/increase/models/swift_transfer_create_params.rb +28 -19
- data/lib/increase/models/swift_transfer_list_params.rb +23 -16
- data/lib/increase/models/transaction.rb +995 -534
- data/lib/increase/models/transaction_list_params.rb +21 -16
- data/lib/increase/models/unwrap_webhook_event.rb +6 -5
- data/lib/increase/models/wire_drawdown_request.rb +44 -26
- data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
- data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
- data/lib/increase/models/wire_transfer.rb +100 -55
- data/lib/increase/models/wire_transfer_create_params.rb +43 -26
- data/lib/increase/models/wire_transfer_list_params.rb +23 -16
- data/lib/increase/resources/account_numbers.rb +20 -16
- data/lib/increase/resources/account_statements.rb +3 -4
- data/lib/increase/resources/account_transfers.rb +20 -12
- data/lib/increase/resources/accounts.rb +19 -12
- data/lib/increase/resources/ach_prenotifications.rb +23 -13
- data/lib/increase/resources/ach_transfers.rb +93 -43
- data/lib/increase/resources/beneficial_owners.rb +35 -19
- data/lib/increase/resources/card_disputes.rb +43 -22
- data/lib/increase/resources/card_payments.rb +3 -4
- data/lib/increase/resources/card_purchase_supplements.rb +6 -5
- data/lib/increase/resources/card_push_transfers.rb +55 -24
- data/lib/increase/resources/card_tokens.rb +3 -4
- data/lib/increase/resources/card_validations.rb +19 -12
- data/lib/increase/resources/cards.rb +33 -22
- data/lib/increase/resources/check_deposits.rb +10 -9
- data/lib/increase/resources/check_transfers.rb +37 -17
- data/lib/increase/resources/declined_transactions.rb +3 -4
- data/lib/increase/resources/digital_card_profiles.rb +12 -7
- data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
- data/lib/increase/resources/entities.rb +69 -33
- data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
- data/lib/increase/resources/event_subscriptions.rb +22 -13
- data/lib/increase/resources/events.rb +10 -9
- data/lib/increase/resources/exports.rb +40 -22
- data/lib/increase/resources/external_accounts.rb +21 -14
- data/lib/increase/resources/fednow_transfers.rb +21 -14
- data/lib/increase/resources/file_links.rb +3 -4
- data/lib/increase/resources/files.rb +14 -10
- data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
- data/lib/increase/resources/inbound_check_deposits.rb +8 -6
- data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
- data/lib/increase/resources/inbound_mail_items.rb +7 -6
- data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
- data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
- data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
- data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
- data/lib/increase/resources/intrafi_exclusions.rb +17 -13
- data/lib/increase/resources/lockbox_addresses.rb +10 -6
- data/lib/increase/resources/lockbox_recipients.rb +17 -12
- data/lib/increase/resources/oauth_applications.rb +3 -4
- data/lib/increase/resources/oauth_connections.rb +6 -5
- data/lib/increase/resources/oauth_tokens.rb +14 -7
- data/lib/increase/resources/pending_transactions.rb +7 -8
- data/lib/increase/resources/physical_card_profiles.rb +18 -15
- data/lib/increase/resources/physical_cards.rb +17 -12
- data/lib/increase/resources/programs.rb +3 -4
- data/lib/increase/resources/real_time_decisions.rb +18 -9
- data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
- data/lib/increase/resources/routing_numbers.rb +3 -4
- data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
- data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
- data/lib/increase/resources/simulations/card_authentications.rb +10 -8
- data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
- data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
- data/lib/increase/resources/simulations/card_disputes.rb +6 -5
- data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
- data/lib/increase/resources/simulations/card_increments.rb +5 -4
- data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
- data/lib/increase/resources/simulations/card_refunds.rb +10 -6
- data/lib/increase/resources/simulations/card_reversals.rb +3 -4
- data/lib/increase/resources/simulations/card_settlements.rb +6 -5
- data/lib/increase/resources/simulations/card_tokens.rb +6 -3
- data/lib/increase/resources/simulations/check_deposits.rb +11 -9
- data/lib/increase/resources/simulations/entities.rb +3 -4
- data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
- data/lib/increase/resources/simulations/exports.rb +5 -5
- data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
- data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
- data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
- data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
- data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
- data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
- data/lib/increase/resources/simulations/interest_payments.rb +4 -5
- data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
- data/lib/increase/resources/simulations/physical_cards.rb +7 -6
- data/lib/increase/resources/simulations/programs.rb +4 -2
- data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
- data/lib/increase/resources/supplemental_documents.rb +8 -5
- data/lib/increase/resources/swift_transfers.rb +28 -16
- data/lib/increase/resources/transactions.rb +6 -5
- data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
- data/lib/increase/resources/wire_transfers.rb +29 -16
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/check_transfer.rbi +8 -0
- data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
- data/rbi/increase/models/entity_list_params.rbi +119 -0
- data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
- data/rbi/increase/resources/entities.rbi +3 -0
- data/rbi/increase/resources/pending_transactions.rbi +2 -2
- data/sig/increase/models/check_transfer.rbs +5 -0
- data/sig/increase/models/check_transfer_create_params.rbs +12 -9
- data/sig/increase/models/entity_list_params.rbs +48 -1
- data/sig/increase/resources/entities.rbs +1 -0
- metadata +2 -2
|
@@ -69,9 +69,6 @@ module Increase
|
|
|
69
69
|
required :type, enum: -> { Increase::AccountStatement::Type }
|
|
70
70
|
|
|
71
71
|
# @!method initialize(id:, account_id:, created_at:, ending_balance:, file_id:, loan:, starting_balance:, statement_period_end:, statement_period_start:, type:)
|
|
72
|
-
# Some parameter documentations has been truncated, see
|
|
73
|
-
# {Increase::Models::AccountStatement} for more details.
|
|
74
|
-
#
|
|
75
72
|
# Account Statements are generated monthly for every active Account. You can
|
|
76
73
|
# access the statement's data via the API or retrieve a PDF with its details via
|
|
77
74
|
# its associated File.
|
|
@@ -80,7 +77,9 @@ module Increase
|
|
|
80
77
|
#
|
|
81
78
|
# @param account_id [String] The identifier for the Account this Account Statement belongs to.
|
|
82
79
|
#
|
|
83
|
-
# @param created_at [Time]
|
|
80
|
+
# @param created_at [Time]
|
|
81
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
|
|
82
|
+
# Statement was created.
|
|
84
83
|
#
|
|
85
84
|
# @param ending_balance [Integer] The Account's balance at the end of its statement period.
|
|
86
85
|
#
|
|
@@ -90,11 +89,17 @@ module Increase
|
|
|
90
89
|
#
|
|
91
90
|
# @param starting_balance [Integer] The Account's balance at the start of its statement period.
|
|
92
91
|
#
|
|
93
|
-
# @param statement_period_end [Time]
|
|
92
|
+
# @param statement_period_end [Time]
|
|
93
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
|
|
94
|
+
# of the period the Account Statement covers.
|
|
94
95
|
#
|
|
95
|
-
# @param statement_period_start [Time]
|
|
96
|
+
# @param statement_period_start [Time]
|
|
97
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
|
|
98
|
+
# start of the period the Account Statement covers.
|
|
96
99
|
#
|
|
97
|
-
# @param type [Symbol, Increase::Models::AccountStatement::Type]
|
|
100
|
+
# @param type [Symbol, Increase::Models::AccountStatement::Type]
|
|
101
|
+
# A constant representing the object's type. For this resource it will always be
|
|
102
|
+
# `account_statement`.
|
|
98
103
|
|
|
99
104
|
# @see Increase::Models::AccountStatement#loan
|
|
100
105
|
class Loan < Increase::Internal::Type::BaseModel
|
|
@@ -118,12 +123,11 @@ module Increase
|
|
|
118
123
|
required :past_due_balance, Integer
|
|
119
124
|
|
|
120
125
|
# @!method initialize(due_at:, due_balance:, past_due_balance:)
|
|
121
|
-
# Some parameter documentations has been truncated, see
|
|
122
|
-
# {Increase::Models::AccountStatement::Loan} for more details.
|
|
123
|
-
#
|
|
124
126
|
# The loan balances.
|
|
125
127
|
#
|
|
126
|
-
# @param due_at [Time, nil]
|
|
128
|
+
# @param due_at [Time, nil]
|
|
129
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
|
|
130
|
+
# payment is due.
|
|
127
131
|
#
|
|
128
132
|
# @param due_balance [Integer] The total amount due on the loan.
|
|
129
133
|
#
|
|
@@ -32,14 +32,13 @@ module Increase
|
|
|
32
32
|
optional :statement_period_start, -> { Increase::AccountStatementListParams::StatementPeriodStart }
|
|
33
33
|
|
|
34
34
|
# @!method initialize(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {})
|
|
35
|
-
# Some parameter documentations has been truncated, see
|
|
36
|
-
# {Increase::Models::AccountStatementListParams} for more details.
|
|
37
|
-
#
|
|
38
35
|
# @param account_id [String] Filter Account Statements to those belonging to the specified Account.
|
|
39
36
|
#
|
|
40
37
|
# @param cursor [String] Return the page of entries after this one.
|
|
41
38
|
#
|
|
42
|
-
# @param limit [Integer]
|
|
39
|
+
# @param limit [Integer]
|
|
40
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
41
|
+
# objects.
|
|
43
42
|
#
|
|
44
43
|
# @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart]
|
|
45
44
|
#
|
|
@@ -75,17 +74,21 @@ module Increase
|
|
|
75
74
|
optional :on_or_before, Time
|
|
76
75
|
|
|
77
76
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
77
|
+
# @param after [Time]
|
|
78
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
79
|
+
# timestamp.
|
|
83
80
|
#
|
|
84
|
-
# @param before [Time]
|
|
81
|
+
# @param before [Time]
|
|
82
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
83
|
+
# timestamp.
|
|
85
84
|
#
|
|
86
|
-
# @param on_or_after [Time]
|
|
85
|
+
# @param on_or_after [Time]
|
|
86
|
+
# Return results on or after this
|
|
87
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
87
88
|
#
|
|
88
|
-
# @param on_or_before [Time]
|
|
89
|
+
# @param on_or_before [Time]
|
|
90
|
+
# Return results on or before this
|
|
91
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
89
92
|
end
|
|
90
93
|
end
|
|
91
94
|
end
|
|
@@ -115,9 +115,6 @@ module Increase
|
|
|
115
115
|
required :type, enum: -> { Increase::AccountTransfer::Type }
|
|
116
116
|
|
|
117
117
|
# @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, pending_transaction_id:, status:, transaction_id:, type:)
|
|
118
|
-
# Some parameter documentations has been truncated, see
|
|
119
|
-
# {Increase::Models::AccountTransfer} for more details.
|
|
120
|
-
#
|
|
121
118
|
# Account transfers move funds between your own accounts at Increase (accounting
|
|
122
119
|
# systems often refer to these as Book Transfers). Account Transfers are free and
|
|
123
120
|
# synchronous. Upon creation they create two Transactions, one negative on the
|
|
@@ -129,33 +126,59 @@ module Increase
|
|
|
129
126
|
#
|
|
130
127
|
# @param account_id [String] The Account from which the transfer originated.
|
|
131
128
|
#
|
|
132
|
-
# @param amount [Integer]
|
|
129
|
+
# @param amount [Integer]
|
|
130
|
+
# The transfer amount in cents. This will always be positive and indicates the
|
|
131
|
+
# amount of money leaving the originating account.
|
|
133
132
|
#
|
|
134
|
-
# @param approval [Increase::Models::AccountTransfer::Approval, nil]
|
|
133
|
+
# @param approval [Increase::Models::AccountTransfer::Approval, nil]
|
|
134
|
+
# If your account requires approvals for transfers and the transfer was approved,
|
|
135
|
+
# this will contain details of the approval.
|
|
135
136
|
#
|
|
136
|
-
# @param cancellation [Increase::Models::AccountTransfer::Cancellation, nil]
|
|
137
|
+
# @param cancellation [Increase::Models::AccountTransfer::Cancellation, nil]
|
|
138
|
+
# If your account requires approvals for transfers and the transfer was not
|
|
139
|
+
# approved, this will contain details of the cancellation.
|
|
137
140
|
#
|
|
138
|
-
# @param created_at [Time]
|
|
141
|
+
# @param created_at [Time]
|
|
142
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
143
|
+
# the transfer was created.
|
|
139
144
|
#
|
|
140
|
-
# @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil]
|
|
145
|
+
# @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil]
|
|
146
|
+
# What object created the transfer, either via the API or the dashboard.
|
|
141
147
|
#
|
|
142
|
-
# @param currency [Symbol, Increase::Models::AccountTransfer::Currency]
|
|
148
|
+
# @param currency [Symbol, Increase::Models::AccountTransfer::Currency]
|
|
149
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
|
150
|
+
# currency.
|
|
143
151
|
#
|
|
144
|
-
# @param description [String]
|
|
152
|
+
# @param description [String]
|
|
153
|
+
# An internal-facing description for the transfer for display in the API and
|
|
154
|
+
# dashboard. This will also show in the description of the created Transactions.
|
|
145
155
|
#
|
|
146
156
|
# @param destination_account_id [String] The destination Account's identifier.
|
|
147
157
|
#
|
|
148
|
-
# @param destination_transaction_id [String, nil]
|
|
158
|
+
# @param destination_transaction_id [String, nil]
|
|
159
|
+
# The identifier of the Transaction on the destination Account representing the
|
|
160
|
+
# received funds.
|
|
149
161
|
#
|
|
150
|
-
# @param idempotency_key [String, nil]
|
|
162
|
+
# @param idempotency_key [String, nil]
|
|
163
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
164
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
165
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
151
166
|
#
|
|
152
|
-
# @param pending_transaction_id [String, nil]
|
|
167
|
+
# @param pending_transaction_id [String, nil]
|
|
168
|
+
# The ID for the pending transaction representing the transfer. A pending
|
|
169
|
+
# transaction is created when the transfer
|
|
170
|
+
# [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
|
171
|
+
# by someone else in your organization.
|
|
153
172
|
#
|
|
154
173
|
# @param status [Symbol, Increase::Models::AccountTransfer::Status] The lifecycle status of the transfer.
|
|
155
174
|
#
|
|
156
|
-
# @param transaction_id [String, nil]
|
|
175
|
+
# @param transaction_id [String, nil]
|
|
176
|
+
# The identifier of the Transaction on the originating account representing the
|
|
177
|
+
# transferred funds.
|
|
157
178
|
#
|
|
158
|
-
# @param type [Symbol, Increase::Models::AccountTransfer::Type]
|
|
179
|
+
# @param type [Symbol, Increase::Models::AccountTransfer::Type]
|
|
180
|
+
# A constant representing the object's type. For this resource it will always be
|
|
181
|
+
# `account_transfer`.
|
|
159
182
|
|
|
160
183
|
# @see Increase::Models::AccountTransfer#approval
|
|
161
184
|
class Approval < Increase::Internal::Type::BaseModel
|
|
@@ -174,15 +197,16 @@ module Increase
|
|
|
174
197
|
required :approved_by, String, nil?: true
|
|
175
198
|
|
|
176
199
|
# @!method initialize(approved_at:, approved_by:)
|
|
177
|
-
# Some parameter documentations has been truncated, see
|
|
178
|
-
# {Increase::Models::AccountTransfer::Approval} for more details.
|
|
179
|
-
#
|
|
180
200
|
# If your account requires approvals for transfers and the transfer was approved,
|
|
181
201
|
# this will contain details of the approval.
|
|
182
202
|
#
|
|
183
|
-
# @param approved_at [Time]
|
|
203
|
+
# @param approved_at [Time]
|
|
204
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
205
|
+
# the transfer was approved.
|
|
184
206
|
#
|
|
185
|
-
# @param approved_by [String, nil]
|
|
207
|
+
# @param approved_by [String, nil]
|
|
208
|
+
# If the Transfer was approved by a user in the dashboard, the email address of
|
|
209
|
+
# that user.
|
|
186
210
|
end
|
|
187
211
|
|
|
188
212
|
# @see Increase::Models::AccountTransfer#cancellation
|
|
@@ -202,15 +226,16 @@ module Increase
|
|
|
202
226
|
required :canceled_by, String, nil?: true
|
|
203
227
|
|
|
204
228
|
# @!method initialize(canceled_at:, canceled_by:)
|
|
205
|
-
# Some parameter documentations has been truncated, see
|
|
206
|
-
# {Increase::Models::AccountTransfer::Cancellation} for more details.
|
|
207
|
-
#
|
|
208
229
|
# If your account requires approvals for transfers and the transfer was not
|
|
209
230
|
# approved, this will contain details of the cancellation.
|
|
210
231
|
#
|
|
211
|
-
# @param canceled_at [Time]
|
|
232
|
+
# @param canceled_at [Time]
|
|
233
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
234
|
+
# the Transfer was canceled.
|
|
212
235
|
#
|
|
213
|
-
# @param canceled_by [String, nil]
|
|
236
|
+
# @param canceled_by [String, nil]
|
|
237
|
+
# If the Transfer was canceled by a user in the dashboard, the email address of
|
|
238
|
+
# that user.
|
|
214
239
|
end
|
|
215
240
|
|
|
216
241
|
# @see Increase::Models::AccountTransfer#created_by
|
|
@@ -242,13 +267,17 @@ module Increase
|
|
|
242
267
|
# @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
|
|
243
268
|
# What object created the transfer, either via the API or the dashboard.
|
|
244
269
|
#
|
|
245
|
-
# @param category [Symbol, Increase::Models::AccountTransfer::CreatedBy::Category]
|
|
270
|
+
# @param category [Symbol, Increase::Models::AccountTransfer::CreatedBy::Category]
|
|
271
|
+
# The type of object that created this transfer.
|
|
246
272
|
#
|
|
247
|
-
# @param api_key [Increase::Models::AccountTransfer::CreatedBy::APIKey, nil]
|
|
273
|
+
# @param api_key [Increase::Models::AccountTransfer::CreatedBy::APIKey, nil]
|
|
274
|
+
# If present, details about the API key that created the transfer.
|
|
248
275
|
#
|
|
249
|
-
# @param oauth_application [Increase::Models::AccountTransfer::CreatedBy::OAuthApplication, nil]
|
|
276
|
+
# @param oauth_application [Increase::Models::AccountTransfer::CreatedBy::OAuthApplication, nil]
|
|
277
|
+
# If present, details about the OAuth Application that created the transfer.
|
|
250
278
|
#
|
|
251
|
-
# @param user [Increase::Models::AccountTransfer::CreatedBy::User, nil]
|
|
279
|
+
# @param user [Increase::Models::AccountTransfer::CreatedBy::User, nil]
|
|
280
|
+
# If present, details about the User that created the transfer.
|
|
252
281
|
|
|
253
282
|
# The type of object that created this transfer.
|
|
254
283
|
#
|
|
@@ -42,18 +42,23 @@ module Increase
|
|
|
42
42
|
optional :require_approval, Increase::Internal::Type::Boolean
|
|
43
43
|
|
|
44
44
|
# @!method initialize(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {})
|
|
45
|
-
# Some parameter documentations has been truncated, see
|
|
46
|
-
# {Increase::Models::AccountTransferCreateParams} for more details.
|
|
47
|
-
#
|
|
48
45
|
# @param account_id [String] The identifier for the originating Account that will send the transfer.
|
|
49
46
|
#
|
|
50
|
-
# @param amount [Integer]
|
|
47
|
+
# @param amount [Integer]
|
|
48
|
+
# The transfer amount in the minor unit of the account currency. For dollars, for
|
|
49
|
+
# example, this is cents.
|
|
51
50
|
#
|
|
52
|
-
# @param description [String]
|
|
51
|
+
# @param description [String]
|
|
52
|
+
# An internal-facing description for the transfer for display in the API and
|
|
53
|
+
# dashboard. This will also show in the description of the created Transactions.
|
|
53
54
|
#
|
|
54
|
-
# @param destination_account_id [String]
|
|
55
|
+
# @param destination_account_id [String]
|
|
56
|
+
# The identifier for the destination Account that will receive the transfer.
|
|
55
57
|
#
|
|
56
|
-
# @param require_approval [Boolean]
|
|
58
|
+
# @param require_approval [Boolean]
|
|
59
|
+
# Whether the transfer should require explicit approval via the dashboard or API.
|
|
60
|
+
# For more information, see
|
|
61
|
+
# [Transfer Approvals](/documentation/transfer-approvals).
|
|
57
62
|
#
|
|
58
63
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
59
64
|
end
|
|
@@ -41,18 +41,21 @@ module Increase
|
|
|
41
41
|
optional :limit, Integer
|
|
42
42
|
|
|
43
43
|
# @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
44
|
-
# Some parameter documentations has been truncated, see
|
|
45
|
-
# {Increase::Models::AccountTransferListParams} for more details.
|
|
46
|
-
#
|
|
47
44
|
# @param account_id [String] Filter Account Transfers to those that originated from the specified Account.
|
|
48
45
|
#
|
|
49
46
|
# @param created_at [Increase::Models::AccountTransferListParams::CreatedAt]
|
|
50
47
|
#
|
|
51
48
|
# @param cursor [String] Return the page of entries after this one.
|
|
52
49
|
#
|
|
53
|
-
# @param idempotency_key [String]
|
|
50
|
+
# @param idempotency_key [String]
|
|
51
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
52
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
53
|
+
# request is only processed once. Learn more about
|
|
54
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
54
55
|
#
|
|
55
|
-
# @param limit [Integer]
|
|
56
|
+
# @param limit [Integer]
|
|
57
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
58
|
+
# objects.
|
|
56
59
|
#
|
|
57
60
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
58
61
|
|
|
@@ -86,16 +89,21 @@ module Increase
|
|
|
86
89
|
optional :on_or_before, Time
|
|
87
90
|
|
|
88
91
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
#
|
|
92
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
92
|
+
# @param after [Time]
|
|
93
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
94
|
+
# timestamp.
|
|
93
95
|
#
|
|
94
|
-
# @param before [Time]
|
|
96
|
+
# @param before [Time]
|
|
97
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
98
|
+
# timestamp.
|
|
95
99
|
#
|
|
96
|
-
# @param on_or_after [Time]
|
|
100
|
+
# @param on_or_after [Time]
|
|
101
|
+
# Return results on or after this
|
|
102
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
97
103
|
#
|
|
98
|
-
# @param on_or_before [Time]
|
|
104
|
+
# @param on_or_before [Time]
|
|
105
|
+
# Return results on or before this
|
|
106
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
99
107
|
end
|
|
100
108
|
end
|
|
101
109
|
end
|
|
@@ -138,9 +138,6 @@ module Increase
|
|
|
138
138
|
required :type, enum: -> { Increase::ACHPrenotification::Type }
|
|
139
139
|
|
|
140
140
|
# @!method initialize(id:, account_id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, individual_id:, individual_name:, notifications_of_change:, prenotification_return:, routing_number:, standard_entry_class_code:, status:, type:)
|
|
141
|
-
# Some parameter documentations has been truncated, see
|
|
142
|
-
# {Increase::Models::ACHPrenotification} for more details.
|
|
143
|
-
#
|
|
144
141
|
# ACH Prenotifications are one way you can verify account and routing numbers by
|
|
145
142
|
# Automated Clearing House (ACH).
|
|
146
143
|
#
|
|
@@ -160,29 +157,47 @@ module Increase
|
|
|
160
157
|
#
|
|
161
158
|
# @param company_name [String, nil] The name by which you know the company.
|
|
162
159
|
#
|
|
163
|
-
# @param created_at [Time]
|
|
160
|
+
# @param created_at [Time]
|
|
161
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
162
|
+
# the prenotification was created.
|
|
164
163
|
#
|
|
165
|
-
# @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil]
|
|
164
|
+
# @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil]
|
|
165
|
+
# If the notification is for a future credit or debit.
|
|
166
166
|
#
|
|
167
|
-
# @param effective_date [Time, nil]
|
|
167
|
+
# @param effective_date [Time, nil]
|
|
168
|
+
# The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
168
169
|
#
|
|
169
|
-
# @param idempotency_key [String, nil]
|
|
170
|
+
# @param idempotency_key [String, nil]
|
|
171
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
172
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
173
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
170
174
|
#
|
|
171
175
|
# @param individual_id [String, nil] Your identifier for the recipient.
|
|
172
176
|
#
|
|
173
|
-
# @param individual_name [String, nil]
|
|
177
|
+
# @param individual_name [String, nil]
|
|
178
|
+
# The name of the recipient. This value is informational and not verified by the
|
|
179
|
+
# recipient's bank.
|
|
174
180
|
#
|
|
175
|
-
# @param notifications_of_change [Array<Increase::Models::ACHPrenotification::NotificationsOfChange>]
|
|
181
|
+
# @param notifications_of_change [Array<Increase::Models::ACHPrenotification::NotificationsOfChange>]
|
|
182
|
+
# If the receiving bank notifies that future transfers should use different
|
|
183
|
+
# details, this will contain those details.
|
|
176
184
|
#
|
|
177
|
-
# @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil]
|
|
185
|
+
# @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil]
|
|
186
|
+
# If your prenotification is returned, this will contain details of the return.
|
|
178
187
|
#
|
|
179
188
|
# @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
|
|
180
189
|
#
|
|
181
|
-
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil]
|
|
190
|
+
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil]
|
|
191
|
+
# The
|
|
192
|
+
# [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
|
|
193
|
+
# to use for the ACH Prenotification.
|
|
182
194
|
#
|
|
183
|
-
# @param status [Symbol, Increase::Models::ACHPrenotification::Status]
|
|
195
|
+
# @param status [Symbol, Increase::Models::ACHPrenotification::Status]
|
|
196
|
+
# The lifecycle status of the ACH Prenotification.
|
|
184
197
|
#
|
|
185
|
-
# @param type [Symbol, Increase::Models::ACHPrenotification::Type]
|
|
198
|
+
# @param type [Symbol, Increase::Models::ACHPrenotification::Type]
|
|
199
|
+
# A constant representing the object's type. For this resource it will always be
|
|
200
|
+
# `ach_prenotification`.
|
|
186
201
|
|
|
187
202
|
# If the notification is for a future credit or debit.
|
|
188
203
|
#
|
|
@@ -243,20 +258,26 @@ module Increase
|
|
|
243
258
|
required :created_at, Time
|
|
244
259
|
|
|
245
260
|
# @!method initialize(change_code:, corrected_account_funding:, corrected_account_number:, corrected_individual_id:, corrected_routing_number:, created_at:)
|
|
246
|
-
#
|
|
247
|
-
#
|
|
248
|
-
#
|
|
249
|
-
# @param change_code [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode] The required type of change that is being signaled by the receiving financial in
|
|
261
|
+
# @param change_code [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode]
|
|
262
|
+
# The required type of change that is being signaled by the receiving financial
|
|
263
|
+
# institution.
|
|
250
264
|
#
|
|
251
|
-
# @param corrected_account_funding [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::CorrectedAccountFunding, nil]
|
|
265
|
+
# @param corrected_account_funding [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::CorrectedAccountFunding, nil]
|
|
266
|
+
# The corrected account funding type that should be used in future ACHs to this
|
|
267
|
+
# account. This is derived from the corrected transaction code.
|
|
252
268
|
#
|
|
253
|
-
# @param corrected_account_number [String, nil]
|
|
269
|
+
# @param corrected_account_number [String, nil]
|
|
270
|
+
# The corrected account number that should be used in future ACHs to this account.
|
|
254
271
|
#
|
|
255
|
-
# @param corrected_individual_id [String, nil]
|
|
272
|
+
# @param corrected_individual_id [String, nil]
|
|
273
|
+
# The corrected individual identifier that should be used in future ACHs.
|
|
256
274
|
#
|
|
257
|
-
# @param corrected_routing_number [String, nil]
|
|
275
|
+
# @param corrected_routing_number [String, nil]
|
|
276
|
+
# The corrected routing number that should be used in future ACHs to this account.
|
|
258
277
|
#
|
|
259
|
-
# @param created_at [Time]
|
|
278
|
+
# @param created_at [Time]
|
|
279
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
280
|
+
# the notification occurred.
|
|
260
281
|
|
|
261
282
|
# The required type of change that is being signaled by the receiving financial
|
|
262
283
|
# institution.
|
|
@@ -373,14 +394,14 @@ module Increase
|
|
|
373
394
|
enum: -> { Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode }
|
|
374
395
|
|
|
375
396
|
# @!method initialize(created_at:, return_reason_code:)
|
|
376
|
-
# Some parameter documentations has been truncated, see
|
|
377
|
-
# {Increase::Models::ACHPrenotification::PrenotificationReturn} for more details.
|
|
378
|
-
#
|
|
379
397
|
# If your prenotification is returned, this will contain details of the return.
|
|
380
398
|
#
|
|
381
|
-
# @param created_at [Time]
|
|
399
|
+
# @param created_at [Time]
|
|
400
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
401
|
+
# the Prenotification was returned.
|
|
382
402
|
#
|
|
383
|
-
# @param return_reason_code [Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode]
|
|
403
|
+
# @param return_reason_code [Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode]
|
|
404
|
+
# Why the Prenotification was returned.
|
|
384
405
|
|
|
385
406
|
# Why the Prenotification was returned.
|
|
386
407
|
#
|
|
@@ -93,14 +93,13 @@ module Increase
|
|
|
93
93
|
enum: -> { Increase::ACHPrenotificationCreateParams::StandardEntryClassCode }
|
|
94
94
|
|
|
95
95
|
# @!method initialize(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {})
|
|
96
|
-
# Some parameter documentations has been truncated, see
|
|
97
|
-
# {Increase::Models::ACHPrenotificationCreateParams} for more details.
|
|
98
|
-
#
|
|
99
96
|
# @param account_id [String] The Increase identifier for the account that will send the ACH Prenotification.
|
|
100
97
|
#
|
|
101
98
|
# @param account_number [String] The account number for the destination account.
|
|
102
99
|
#
|
|
103
|
-
# @param routing_number [String]
|
|
100
|
+
# @param routing_number [String]
|
|
101
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
102
|
+
# destination account.
|
|
104
103
|
#
|
|
105
104
|
# @param addendum [String] Additional information that will be sent to the recipient.
|
|
106
105
|
#
|
|
@@ -112,15 +111,23 @@ module Increase
|
|
|
112
111
|
#
|
|
113
112
|
# @param company_name [String] The name by which the recipient knows you.
|
|
114
113
|
#
|
|
115
|
-
# @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator]
|
|
114
|
+
# @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator]
|
|
115
|
+
# Whether the Prenotification is for a future debit or credit.
|
|
116
116
|
#
|
|
117
|
-
# @param effective_date [Date]
|
|
117
|
+
# @param effective_date [Date]
|
|
118
|
+
# The ACH Prenotification effective date in
|
|
119
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
118
120
|
#
|
|
119
121
|
# @param individual_id [String] Your identifier for the recipient.
|
|
120
122
|
#
|
|
121
|
-
# @param individual_name [String]
|
|
123
|
+
# @param individual_name [String]
|
|
124
|
+
# The name of therecipient. This value is informational and not verified by the
|
|
125
|
+
# recipient's bank.
|
|
122
126
|
#
|
|
123
|
-
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
|
|
127
|
+
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
|
|
128
|
+
# The
|
|
129
|
+
# [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
|
|
130
|
+
# to use for the ACH Prenotification.
|
|
124
131
|
#
|
|
125
132
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
126
133
|
|
|
@@ -35,16 +35,19 @@ module Increase
|
|
|
35
35
|
optional :limit, Integer
|
|
36
36
|
|
|
37
37
|
# @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
38
|
-
# Some parameter documentations has been truncated, see
|
|
39
|
-
# {Increase::Models::ACHPrenotificationListParams} for more details.
|
|
40
|
-
#
|
|
41
38
|
# @param created_at [Increase::Models::ACHPrenotificationListParams::CreatedAt]
|
|
42
39
|
#
|
|
43
40
|
# @param cursor [String] Return the page of entries after this one.
|
|
44
41
|
#
|
|
45
|
-
# @param idempotency_key [String]
|
|
42
|
+
# @param idempotency_key [String]
|
|
43
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
44
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
45
|
+
# request is only processed once. Learn more about
|
|
46
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
46
47
|
#
|
|
47
|
-
# @param limit [Integer]
|
|
48
|
+
# @param limit [Integer]
|
|
49
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
50
|
+
# objects.
|
|
48
51
|
#
|
|
49
52
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
50
53
|
|
|
@@ -78,16 +81,21 @@ module Increase
|
|
|
78
81
|
optional :on_or_before, Time
|
|
79
82
|
|
|
80
83
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
81
|
-
#
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
84
|
+
# @param after [Time]
|
|
85
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
86
|
+
# timestamp.
|
|
85
87
|
#
|
|
86
|
-
# @param before [Time]
|
|
88
|
+
# @param before [Time]
|
|
89
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
90
|
+
# timestamp.
|
|
87
91
|
#
|
|
88
|
-
# @param on_or_after [Time]
|
|
92
|
+
# @param on_or_after [Time]
|
|
93
|
+
# Return results on or after this
|
|
94
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
89
95
|
#
|
|
90
|
-
# @param on_or_before [Time]
|
|
96
|
+
# @param on_or_before [Time]
|
|
97
|
+
# Return results on or before this
|
|
98
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
91
99
|
end
|
|
92
100
|
end
|
|
93
101
|
end
|