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
|
@@ -50,22 +50,24 @@ module Increase
|
|
|
50
50
|
optional :wire_drawdown_request_id, String
|
|
51
51
|
|
|
52
52
|
# @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, wire_drawdown_request_id: nil, request_options: {})
|
|
53
|
-
# Some parameter documentations has been truncated, see
|
|
54
|
-
# {Increase::Models::InboundWireTransferListParams} for more details.
|
|
55
|
-
#
|
|
56
53
|
# @param account_id [String] Filter Inbound Wire Transfers to ones belonging to the specified Account.
|
|
57
54
|
#
|
|
58
|
-
# @param account_number_id [String]
|
|
55
|
+
# @param account_number_id [String]
|
|
56
|
+
# Filter Inbound Wire Transfers to ones belonging to the specified Account Number.
|
|
59
57
|
#
|
|
60
58
|
# @param created_at [Increase::Models::InboundWireTransferListParams::CreatedAt]
|
|
61
59
|
#
|
|
62
60
|
# @param cursor [String] Return the page of entries after this one.
|
|
63
61
|
#
|
|
64
|
-
# @param limit [Integer]
|
|
62
|
+
# @param limit [Integer]
|
|
63
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
64
|
+
# objects.
|
|
65
65
|
#
|
|
66
66
|
# @param status [Increase::Models::InboundWireTransferListParams::Status]
|
|
67
67
|
#
|
|
68
|
-
# @param wire_drawdown_request_id [String]
|
|
68
|
+
# @param wire_drawdown_request_id [String]
|
|
69
|
+
# Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown
|
|
70
|
+
# Request.
|
|
69
71
|
#
|
|
70
72
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
71
73
|
|
|
@@ -99,16 +101,21 @@ module Increase
|
|
|
99
101
|
optional :on_or_before, Time
|
|
100
102
|
|
|
101
103
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
#
|
|
105
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
104
|
+
# @param after [Time]
|
|
105
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
106
|
+
# timestamp.
|
|
106
107
|
#
|
|
107
|
-
# @param before [Time]
|
|
108
|
+
# @param before [Time]
|
|
109
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
110
|
+
# timestamp.
|
|
108
111
|
#
|
|
109
|
-
# @param on_or_after [Time]
|
|
112
|
+
# @param on_or_after [Time]
|
|
113
|
+
# Return results on or after this
|
|
114
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
110
115
|
#
|
|
111
|
-
# @param on_or_before [Time]
|
|
116
|
+
# @param on_or_before [Time]
|
|
117
|
+
# Return results on or before this
|
|
118
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
112
119
|
end
|
|
113
120
|
|
|
114
121
|
class Status < Increase::Internal::Type::BaseModel
|
|
@@ -125,10 +132,10 @@ module Increase
|
|
|
125
132
|
api_name: :in
|
|
126
133
|
|
|
127
134
|
# @!method initialize(in_: nil)
|
|
128
|
-
#
|
|
129
|
-
#
|
|
130
|
-
#
|
|
131
|
-
#
|
|
135
|
+
# @param in_ [Array<Symbol, Increase::Models::InboundWireTransferListParams::Status::In>]
|
|
136
|
+
# Filter Inbound Wire Transfers to those with the specified status. For GET
|
|
137
|
+
# requests, this should be encoded as a comma-delimited string, such as
|
|
138
|
+
# `?in=one,two,three`.
|
|
132
139
|
|
|
133
140
|
module In
|
|
134
141
|
extend Increase::Internal::Type::Enum
|
|
@@ -22,7 +22,8 @@ module Increase
|
|
|
22
22
|
# @!method initialize(inbound_wire_transfer_id:, reason:, request_options: {})
|
|
23
23
|
# @param inbound_wire_transfer_id [String] The identifier of the Inbound Wire Transfer to reverse.
|
|
24
24
|
#
|
|
25
|
-
# @param reason [Symbol, Increase::Models::InboundWireTransferReverseParams::Reason]
|
|
25
|
+
# @param reason [Symbol, Increase::Models::InboundWireTransferReverseParams::Reason]
|
|
26
|
+
# Reason for the reversal.
|
|
26
27
|
#
|
|
27
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
28
29
|
|
|
@@ -59,9 +59,6 @@ module Increase
|
|
|
59
59
|
required :type, enum: -> { Increase::IntrafiAccountEnrollment::Type }
|
|
60
60
|
|
|
61
61
|
# @!method initialize(id:, account_id:, created_at:, email_address:, idempotency_key:, intrafi_id:, status:, type:)
|
|
62
|
-
# Some parameter documentations has been truncated, see
|
|
63
|
-
# {Increase::Models::IntrafiAccountEnrollment} for more details.
|
|
64
|
-
#
|
|
65
62
|
# IntraFi is a
|
|
66
63
|
# [network of financial institutions](https://www.intrafi.com/network-banks) that
|
|
67
64
|
# allows Increase users to sweep funds to multiple banks. This enables accounts to
|
|
@@ -74,17 +71,28 @@ module Increase
|
|
|
74
71
|
#
|
|
75
72
|
# @param account_id [String] The identifier of the Increase Account being swept into the network.
|
|
76
73
|
#
|
|
77
|
-
# @param created_at [Time]
|
|
74
|
+
# @param created_at [Time]
|
|
75
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
76
|
+
# the enrollment was created.
|
|
78
77
|
#
|
|
79
78
|
# @param email_address [String, nil] The contact email for the account owner, to be shared with IntraFi.
|
|
80
79
|
#
|
|
81
|
-
# @param idempotency_key [String, nil]
|
|
80
|
+
# @param idempotency_key [String, nil]
|
|
81
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
82
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
83
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
82
84
|
#
|
|
83
|
-
# @param intrafi_id [String]
|
|
85
|
+
# @param intrafi_id [String]
|
|
86
|
+
# The identifier of the account in IntraFi's system. This identifier will be
|
|
87
|
+
# printed on any IntraFi statements or documents.
|
|
84
88
|
#
|
|
85
|
-
# @param status [Symbol, Increase::Models::IntrafiAccountEnrollment::Status]
|
|
89
|
+
# @param status [Symbol, Increase::Models::IntrafiAccountEnrollment::Status]
|
|
90
|
+
# The status of the account in the network. An account takes about one business
|
|
91
|
+
# day to go from `pending_enrolling` to `enrolled`.
|
|
86
92
|
#
|
|
87
|
-
# @param type [Symbol, Increase::Models::IntrafiAccountEnrollment::Type]
|
|
93
|
+
# @param type [Symbol, Increase::Models::IntrafiAccountEnrollment::Type]
|
|
94
|
+
# A constant representing the object's type. For this resource it will always be
|
|
95
|
+
# `intrafi_account_enrollment`.
|
|
88
96
|
|
|
89
97
|
# The status of the account in the network. An account takes about one business
|
|
90
98
|
# day to go from `pending_enrolling` to `enrolled`.
|
|
@@ -41,16 +41,19 @@ module Increase
|
|
|
41
41
|
optional :status, -> { Increase::IntrafiAccountEnrollmentListParams::Status }
|
|
42
42
|
|
|
43
43
|
# @!method initialize(account_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
44
|
-
# Some parameter documentations has been truncated, see
|
|
45
|
-
# {Increase::Models::IntrafiAccountEnrollmentListParams} for more details.
|
|
46
|
-
#
|
|
47
44
|
# @param account_id [String] Filter IntraFi Account Enrollments to the one belonging to an account.
|
|
48
45
|
#
|
|
49
46
|
# @param cursor [String] Return the page of entries after this one.
|
|
50
47
|
#
|
|
51
|
-
# @param idempotency_key [String]
|
|
48
|
+
# @param idempotency_key [String]
|
|
49
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
50
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
51
|
+
# request is only processed once. Learn more about
|
|
52
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
52
53
|
#
|
|
53
|
-
# @param limit [Integer]
|
|
54
|
+
# @param limit [Integer]
|
|
55
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
56
|
+
# objects.
|
|
54
57
|
#
|
|
55
58
|
# @param status [Increase::Models::IntrafiAccountEnrollmentListParams::Status]
|
|
56
59
|
#
|
|
@@ -70,10 +73,10 @@ module Increase
|
|
|
70
73
|
api_name: :in
|
|
71
74
|
|
|
72
75
|
# @!method initialize(in_: nil)
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
76
|
+
# @param in_ [Array<Symbol, Increase::Models::IntrafiAccountEnrollmentListParams::Status::In>]
|
|
77
|
+
# Filter IntraFi Account Enrollments for those with the specified status or
|
|
78
|
+
# statuses. For GET requests, this should be encoded as a comma-delimited string,
|
|
79
|
+
# such as `?in=one,two,three`.
|
|
77
80
|
|
|
78
81
|
module In
|
|
79
82
|
extend Increase::Internal::Type::Enum
|
|
@@ -14,7 +14,8 @@ module Increase
|
|
|
14
14
|
required :intrafi_account_enrollment_id, String
|
|
15
15
|
|
|
16
16
|
# @!method initialize(intrafi_account_enrollment_id:, request_options: {})
|
|
17
|
-
# @param intrafi_account_enrollment_id [String]
|
|
17
|
+
# @param intrafi_account_enrollment_id [String]
|
|
18
|
+
# The identifier of the IntraFi Account Enrollment to retrieve.
|
|
18
19
|
#
|
|
19
20
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
20
21
|
end
|
|
@@ -14,7 +14,8 @@ module Increase
|
|
|
14
14
|
required :intrafi_account_enrollment_id, String
|
|
15
15
|
|
|
16
16
|
# @!method initialize(intrafi_account_enrollment_id:, request_options: {})
|
|
17
|
-
# @param intrafi_account_enrollment_id [String]
|
|
17
|
+
# @param intrafi_account_enrollment_id [String]
|
|
18
|
+
# The Identifier of the IntraFi Account Enrollment to remove from IntraFi.
|
|
18
19
|
#
|
|
19
20
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
20
21
|
end
|
|
@@ -39,22 +39,27 @@ module Increase
|
|
|
39
39
|
required :type, enum: -> { Increase::IntrafiBalance::Type }
|
|
40
40
|
|
|
41
41
|
# @!method initialize(balances:, currency:, effective_date:, total_balance:, type:)
|
|
42
|
-
# Some parameter documentations has been truncated, see
|
|
43
|
-
# {Increase::Models::IntrafiBalance} for more details.
|
|
44
|
-
#
|
|
45
42
|
# When using IntraFi, each account's balance over the standard FDIC insurance
|
|
46
43
|
# amount is swept to various other institutions. Funds are rebalanced across banks
|
|
47
44
|
# as needed once per business day.
|
|
48
45
|
#
|
|
49
|
-
# @param balances [Array<Increase::Models::IntrafiBalance::Balance>]
|
|
46
|
+
# @param balances [Array<Increase::Models::IntrafiBalance::Balance>]
|
|
47
|
+
# Each entry represents a balance held at a different bank. IntraFi separates the
|
|
48
|
+
# total balance across many participating banks in the network.
|
|
50
49
|
#
|
|
51
|
-
# @param currency [Symbol, Increase::Models::IntrafiBalance::Currency]
|
|
50
|
+
# @param currency [Symbol, Increase::Models::IntrafiBalance::Currency]
|
|
51
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account
|
|
52
|
+
# currency.
|
|
52
53
|
#
|
|
53
54
|
# @param effective_date [Date] The date this balance reflects.
|
|
54
55
|
#
|
|
55
|
-
# @param total_balance [Integer]
|
|
56
|
+
# @param total_balance [Integer]
|
|
57
|
+
# The total balance, in minor units of `currency`. Increase reports this balance
|
|
58
|
+
# to IntraFi daily.
|
|
56
59
|
#
|
|
57
|
-
# @param type [Symbol, Increase::Models::IntrafiBalance::Type]
|
|
60
|
+
# @param type [Symbol, Increase::Models::IntrafiBalance::Type]
|
|
61
|
+
# A constant representing the object's type. For this resource it will always be
|
|
62
|
+
# `intrafi_balance`.
|
|
58
63
|
|
|
59
64
|
class Balance < Increase::Internal::Type::BaseModel
|
|
60
65
|
# @!attribute balance
|
|
@@ -84,16 +89,17 @@ module Increase
|
|
|
84
89
|
required :fdic_certificate_number, String
|
|
85
90
|
|
|
86
91
|
# @!method initialize(balance:, bank:, bank_location:, fdic_certificate_number:)
|
|
87
|
-
# Some parameter documentations has been truncated, see
|
|
88
|
-
# {Increase::Models::IntrafiBalance::Balance} for more details.
|
|
89
|
-
#
|
|
90
92
|
# @param balance [Integer] The balance, in minor units of `currency`, held with this bank.
|
|
91
93
|
#
|
|
92
94
|
# @param bank [String] The name of the bank holding these funds.
|
|
93
95
|
#
|
|
94
|
-
# @param bank_location [Increase::Models::IntrafiBalance::Balance::BankLocation, nil]
|
|
96
|
+
# @param bank_location [Increase::Models::IntrafiBalance::Balance::BankLocation, nil]
|
|
97
|
+
# The primary location of the bank.
|
|
95
98
|
#
|
|
96
|
-
# @param fdic_certificate_number [String]
|
|
99
|
+
# @param fdic_certificate_number [String]
|
|
100
|
+
# The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank.
|
|
101
|
+
# Because many banks have the same or similar names, this can be used to uniquely
|
|
102
|
+
# identify the institution.
|
|
97
103
|
|
|
98
104
|
# @see Increase::Models::IntrafiBalance::Balance#bank_location
|
|
99
105
|
class BankLocation < Increase::Internal::Type::BaseModel
|
|
@@ -70,9 +70,6 @@ module Increase
|
|
|
70
70
|
required :type, enum: -> { Increase::IntrafiExclusion::Type }
|
|
71
71
|
|
|
72
72
|
# @!method initialize(id:, bank_name:, created_at:, entity_id:, excluded_at:, fdic_certificate_number:, idempotency_key:, status:, submitted_at:, type:)
|
|
73
|
-
# Some parameter documentations has been truncated, see
|
|
74
|
-
# {Increase::Models::IntrafiExclusion} for more details.
|
|
75
|
-
#
|
|
76
73
|
# Certain institutions may be excluded per Entity when sweeping funds into the
|
|
77
74
|
# IntraFi network. This is useful when an Entity already has deposits at a
|
|
78
75
|
# particular bank, and does not want to sweep additional funds to it. It may take
|
|
@@ -82,21 +79,30 @@ module Increase
|
|
|
82
79
|
#
|
|
83
80
|
# @param bank_name [String, nil] The name of the excluded institution.
|
|
84
81
|
#
|
|
85
|
-
# @param created_at [Time]
|
|
82
|
+
# @param created_at [Time]
|
|
83
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
84
|
+
# the exclusion was created.
|
|
86
85
|
#
|
|
87
86
|
# @param entity_id [String] The entity for which this institution is excluded.
|
|
88
87
|
#
|
|
89
88
|
# @param excluded_at [Time, nil] When this was exclusion was confirmed by IntraFi.
|
|
90
89
|
#
|
|
91
|
-
# @param fdic_certificate_number [String, nil]
|
|
90
|
+
# @param fdic_certificate_number [String, nil]
|
|
91
|
+
# The Federal Deposit Insurance Corporation's certificate number for the
|
|
92
|
+
# institution.
|
|
92
93
|
#
|
|
93
|
-
# @param idempotency_key [String, nil]
|
|
94
|
+
# @param idempotency_key [String, nil]
|
|
95
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
96
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
97
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
94
98
|
#
|
|
95
99
|
# @param status [Symbol, Increase::Models::IntrafiExclusion::Status] The status of the exclusion request.
|
|
96
100
|
#
|
|
97
101
|
# @param submitted_at [Time, nil] When this was exclusion was submitted to IntraFi by Increase.
|
|
98
102
|
#
|
|
99
|
-
# @param type [Symbol, Increase::Models::IntrafiExclusion::Type]
|
|
103
|
+
# @param type [Symbol, Increase::Models::IntrafiExclusion::Type]
|
|
104
|
+
# A constant representing the object's type. For this resource it will always be
|
|
105
|
+
# `intrafi_exclusion`.
|
|
100
106
|
|
|
101
107
|
# The status of the exclusion request.
|
|
102
108
|
#
|
|
@@ -16,10 +16,10 @@ module Increase
|
|
|
16
16
|
required :intrafi_exclusion_id, String
|
|
17
17
|
|
|
18
18
|
# @!method initialize(intrafi_exclusion_id:, request_options: {})
|
|
19
|
-
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
19
|
+
# @param intrafi_exclusion_id [String]
|
|
20
|
+
# The identifier of the IntraFi Exclusion request to archive. It may take 5
|
|
21
|
+
# business days for an exclusion removal to be processed. Removing an exclusion
|
|
22
|
+
# does not guarantee that funds will be swept to the previously-excluded bank.
|
|
23
23
|
#
|
|
24
24
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
25
25
|
end
|
|
@@ -23,12 +23,13 @@ module Increase
|
|
|
23
23
|
required :fdic_certificate_number, String
|
|
24
24
|
|
|
25
25
|
# @!method initialize(entity_id:, fdic_certificate_number:, request_options: {})
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::IntrafiExclusionCreateParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# @param entity_id [String] The identifier of the Entity whose deposits will be excluded.
|
|
30
27
|
#
|
|
31
|
-
# @param fdic_certificate_number [String]
|
|
28
|
+
# @param fdic_certificate_number [String]
|
|
29
|
+
# The FDIC certificate number of the financial institution to be excluded. An FDIC
|
|
30
|
+
# certificate number uniquely identifies a financial institution, and is different
|
|
31
|
+
# than a routing number. To find one, we recommend searching by Bank Name using
|
|
32
|
+
# the [FDIC's bankfind tool](https://banks.data.fdic.gov/bankfind-suite/bankfind).
|
|
32
33
|
#
|
|
33
34
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
34
35
|
end
|
|
@@ -36,16 +36,19 @@ module Increase
|
|
|
36
36
|
optional :limit, Integer
|
|
37
37
|
|
|
38
38
|
# @!method initialize(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
39
|
-
# Some parameter documentations has been truncated, see
|
|
40
|
-
# {Increase::Models::IntrafiExclusionListParams} for more details.
|
|
41
|
-
#
|
|
42
39
|
# @param cursor [String] Return the page of entries after this one.
|
|
43
40
|
#
|
|
44
41
|
# @param entity_id [String] Filter IntraFi Exclusions for those belonging to the specified Entity.
|
|
45
42
|
#
|
|
46
|
-
# @param idempotency_key [String]
|
|
43
|
+
# @param idempotency_key [String]
|
|
44
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
45
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
46
|
+
# request is only processed once. Learn more about
|
|
47
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
47
48
|
#
|
|
48
|
-
# @param limit [Integer]
|
|
49
|
+
# @param limit [Integer]
|
|
50
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
51
|
+
# objects.
|
|
49
52
|
#
|
|
50
53
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
51
54
|
end
|
|
@@ -52,9 +52,6 @@ module Increase
|
|
|
52
52
|
required :type, enum: -> { Increase::LockboxAddress::Type }
|
|
53
53
|
|
|
54
54
|
# @!method initialize(id:, address:, created_at:, description:, idempotency_key:, status:, type:)
|
|
55
|
-
# Some parameter documentations has been truncated, see
|
|
56
|
-
# {Increase::Models::LockboxAddress} for more details.
|
|
57
|
-
#
|
|
58
55
|
# Lockbox Addresses are physical locations that can receive mail containing paper
|
|
59
56
|
# checks. A Lockbox Address is not itself linked to an Account; Lockbox Recipients
|
|
60
57
|
# determine where checks received at the address are deposited. Lockbox Addresses
|
|
@@ -64,17 +61,26 @@ module Increase
|
|
|
64
61
|
#
|
|
65
62
|
# @param id [String] The Lockbox Address identifier.
|
|
66
63
|
#
|
|
67
|
-
# @param address [Increase::Models::LockboxAddress::Address, nil]
|
|
64
|
+
# @param address [Increase::Models::LockboxAddress::Address, nil]
|
|
65
|
+
# The mailing address for the Lockbox Address. It will be present after Increase
|
|
66
|
+
# generates it.
|
|
68
67
|
#
|
|
69
|
-
# @param created_at [Time]
|
|
68
|
+
# @param created_at [Time]
|
|
69
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
|
|
70
|
+
# Address was created.
|
|
70
71
|
#
|
|
71
72
|
# @param description [String, nil] The description you choose for the Lockbox Address.
|
|
72
73
|
#
|
|
73
|
-
# @param idempotency_key [String, nil]
|
|
74
|
+
# @param idempotency_key [String, nil]
|
|
75
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
76
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
77
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
74
78
|
#
|
|
75
79
|
# @param status [Symbol, Increase::Models::LockboxAddress::Status] The status of the Lockbox Address.
|
|
76
80
|
#
|
|
77
|
-
# @param type [Symbol, Increase::Models::LockboxAddress::Type]
|
|
81
|
+
# @param type [Symbol, Increase::Models::LockboxAddress::Type]
|
|
82
|
+
# A constant representing the object's type. For this resource it will always be
|
|
83
|
+
# `lockbox_address`.
|
|
78
84
|
|
|
79
85
|
# @see Increase::Models::LockboxAddress#address
|
|
80
86
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -110,9 +116,6 @@ module Increase
|
|
|
110
116
|
required :state, String
|
|
111
117
|
|
|
112
118
|
# @!method initialize(city:, line1:, line2:, postal_code:, state:)
|
|
113
|
-
# Some parameter documentations has been truncated, see
|
|
114
|
-
# {Increase::Models::LockboxAddress::Address} for more details.
|
|
115
|
-
#
|
|
116
119
|
# The mailing address for the Lockbox Address. It will be present after Increase
|
|
117
120
|
# generates it.
|
|
118
121
|
#
|
|
@@ -124,7 +127,9 @@ module Increase
|
|
|
124
127
|
#
|
|
125
128
|
# @param postal_code [String] The postal code of the address.
|
|
126
129
|
#
|
|
127
|
-
# @param state [String]
|
|
130
|
+
# @param state [String]
|
|
131
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
132
|
+
# the address.
|
|
128
133
|
end
|
|
129
134
|
|
|
130
135
|
# The status of the Lockbox Address.
|
|
@@ -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::LockboxAddressListParams} for more details.
|
|
40
|
-
#
|
|
41
38
|
# @param created_at [Increase::Models::LockboxAddressListParams::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
|
|
@@ -30,7 +30,8 @@ module Increase
|
|
|
30
30
|
#
|
|
31
31
|
# @param description [String] The description you choose for the Lockbox Address.
|
|
32
32
|
#
|
|
33
|
-
# @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status]
|
|
33
|
+
# @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status]
|
|
34
|
+
# The status of the Lockbox Address.
|
|
34
35
|
#
|
|
35
36
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
36
37
|
|
|
@@ -73,31 +73,43 @@ module Increase
|
|
|
73
73
|
required :type, enum: -> { Increase::LockboxRecipient::Type }
|
|
74
74
|
|
|
75
75
|
# @!method initialize(id:, account_id:, created_at:, description:, idempotency_key:, lockbox_address_id:, mail_stop_code:, recipient_name:, status:, type:)
|
|
76
|
-
# Some parameter documentations has been truncated, see
|
|
77
|
-
# {Increase::Models::LockboxRecipient} for more details.
|
|
78
|
-
#
|
|
79
76
|
# Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for
|
|
80
77
|
# a Lockbox Recipient are deposited into its associated Account.
|
|
81
78
|
#
|
|
82
79
|
# @param id [String] The Lockbox Recipient identifier.
|
|
83
80
|
#
|
|
84
|
-
# @param account_id [String]
|
|
81
|
+
# @param account_id [String]
|
|
82
|
+
# The identifier for the Account that checks sent to this Lockbox Recipient will
|
|
83
|
+
# be deposited into.
|
|
85
84
|
#
|
|
86
|
-
# @param created_at [Time]
|
|
85
|
+
# @param created_at [Time]
|
|
86
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
|
|
87
|
+
# Recipient was created.
|
|
87
88
|
#
|
|
88
89
|
# @param description [String, nil] The description of the Lockbox Recipient.
|
|
89
90
|
#
|
|
90
|
-
# @param idempotency_key [String, nil]
|
|
91
|
+
# @param idempotency_key [String, nil]
|
|
92
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
93
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
94
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
91
95
|
#
|
|
92
|
-
# @param lockbox_address_id [String]
|
|
96
|
+
# @param lockbox_address_id [String]
|
|
97
|
+
# The identifier for the Lockbox Address where this Lockbox Recipient may receive
|
|
98
|
+
# physical mail.
|
|
93
99
|
#
|
|
94
|
-
# @param mail_stop_code [String]
|
|
100
|
+
# @param mail_stop_code [String]
|
|
101
|
+
# The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox
|
|
102
|
+
# Address. It should be included in the mailing address intended for this Lockbox
|
|
103
|
+
# Recipient.
|
|
95
104
|
#
|
|
96
105
|
# @param recipient_name [String, nil] The name of the Lockbox Recipient.
|
|
97
106
|
#
|
|
98
|
-
# @param status [Symbol, Increase::Models::LockboxRecipient::Status, nil]
|
|
107
|
+
# @param status [Symbol, Increase::Models::LockboxRecipient::Status, nil]
|
|
108
|
+
# The status of the Lockbox Recipient.
|
|
99
109
|
#
|
|
100
|
-
# @param type [Symbol, Increase::Models::LockboxRecipient::Type]
|
|
110
|
+
# @param type [Symbol, Increase::Models::LockboxRecipient::Type]
|
|
111
|
+
# A constant representing the object's type. For this resource it will always be
|
|
112
|
+
# `lockbox_recipient`.
|
|
101
113
|
|
|
102
114
|
# The status of the Lockbox Recipient.
|
|
103
115
|
#
|
|
@@ -33,12 +33,12 @@ module Increase
|
|
|
33
33
|
optional :recipient_name, String
|
|
34
34
|
|
|
35
35
|
# @!method initialize(account_id:, lockbox_address_id:, description: nil, recipient_name: nil, request_options: {})
|
|
36
|
-
#
|
|
37
|
-
#
|
|
36
|
+
# @param account_id [String]
|
|
37
|
+
# The Account that checks sent to this Lockbox Recipient should be deposited into.
|
|
38
38
|
#
|
|
39
|
-
# @param
|
|
40
|
-
#
|
|
41
|
-
#
|
|
39
|
+
# @param lockbox_address_id [String]
|
|
40
|
+
# The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
|
|
41
|
+
# Address must have a `status` of `active`.
|
|
42
42
|
#
|
|
43
43
|
# @param description [String] The description you choose for the Lockbox Recipient.
|
|
44
44
|
#
|
|
@@ -47,20 +47,24 @@ module Increase
|
|
|
47
47
|
optional :lockbox_address_id, String
|
|
48
48
|
|
|
49
49
|
# @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, lockbox_address_id: nil, request_options: {})
|
|
50
|
-
# Some parameter documentations has been truncated, see
|
|
51
|
-
# {Increase::Models::LockboxRecipientListParams} for more details.
|
|
52
|
-
#
|
|
53
50
|
# @param account_id [String] Filter Lockbox Recipients to those associated with the provided Account.
|
|
54
51
|
#
|
|
55
52
|
# @param created_at [Increase::Models::LockboxRecipientListParams::CreatedAt]
|
|
56
53
|
#
|
|
57
54
|
# @param cursor [String] Return the page of entries after this one.
|
|
58
55
|
#
|
|
59
|
-
# @param idempotency_key [String]
|
|
56
|
+
# @param idempotency_key [String]
|
|
57
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
58
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
59
|
+
# request is only processed once. Learn more about
|
|
60
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
60
61
|
#
|
|
61
|
-
# @param limit [Integer]
|
|
62
|
+
# @param limit [Integer]
|
|
63
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
64
|
+
# objects.
|
|
62
65
|
#
|
|
63
|
-
# @param lockbox_address_id [String]
|
|
66
|
+
# @param lockbox_address_id [String]
|
|
67
|
+
# Filter Lockbox Recipients to those associated with the provided Lockbox Address.
|
|
64
68
|
#
|
|
65
69
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
66
70
|
|
|
@@ -94,16 +98,21 @@ module Increase
|
|
|
94
98
|
optional :on_or_before, Time
|
|
95
99
|
|
|
96
100
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
97
|
-
#
|
|
98
|
-
#
|
|
99
|
-
#
|
|
100
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
101
|
+
# @param after [Time]
|
|
102
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
103
|
+
# timestamp.
|
|
101
104
|
#
|
|
102
|
-
# @param before [Time]
|
|
105
|
+
# @param before [Time]
|
|
106
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
107
|
+
# timestamp.
|
|
103
108
|
#
|
|
104
|
-
# @param on_or_after [Time]
|
|
109
|
+
# @param on_or_after [Time]
|
|
110
|
+
# Return results on or after this
|
|
111
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
105
112
|
#
|
|
106
|
-
# @param on_or_before [Time]
|
|
113
|
+
# @param on_or_before [Time]
|
|
114
|
+
# Return results on or before this
|
|
115
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
107
116
|
end
|
|
108
117
|
end
|
|
109
118
|
end
|
|
@@ -38,7 +38,8 @@ module Increase
|
|
|
38
38
|
#
|
|
39
39
|
# @param recipient_name [String] The name of the Lockbox Recipient.
|
|
40
40
|
#
|
|
41
|
-
# @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status]
|
|
41
|
+
# @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status]
|
|
42
|
+
# The status of the Lockbox Recipient.
|
|
42
43
|
#
|
|
43
44
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
44
45
|
|