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
|
@@ -3,24 +3,29 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class Cards
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::CardCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Card
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param account_id [String] The Account the card should belong to.
|
|
14
11
|
#
|
|
15
|
-
# @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
|
|
12
|
+
# @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
|
|
13
|
+
# Controls that restrict how this card can be used.
|
|
16
14
|
#
|
|
17
15
|
# @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
|
|
18
16
|
#
|
|
19
17
|
# @param description [String] The description you choose to give the card.
|
|
20
18
|
#
|
|
21
|
-
# @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
|
|
19
|
+
# @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
|
|
20
|
+
# The contact information used in the two-factor steps for digital wallet card
|
|
21
|
+
# creation. To add the card to a digital wallet, you may supply an email or phone
|
|
22
|
+
# number with this request. Otherwise, subscribe and then action a Real Time
|
|
23
|
+
# Decision with the category `digital_wallet_token_requested` or
|
|
24
|
+
# `digital_wallet_authentication_requested`.
|
|
22
25
|
#
|
|
23
|
-
# @param entity_id [String]
|
|
26
|
+
# @param entity_id [String]
|
|
27
|
+
# The Entity the card belongs to. You only need to supply this in rare situations
|
|
28
|
+
# when the card is not for the Account holder.
|
|
24
29
|
#
|
|
25
30
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
31
|
#
|
|
@@ -52,24 +57,28 @@ module Increase
|
|
|
52
57
|
)
|
|
53
58
|
end
|
|
54
59
|
|
|
55
|
-
# Some parameter documentations has been truncated, see
|
|
56
|
-
# {Increase::Models::CardUpdateParams} for more details.
|
|
57
|
-
#
|
|
58
60
|
# Update a Card
|
|
59
61
|
#
|
|
60
62
|
# @overload update(card_id, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
|
|
61
63
|
#
|
|
62
64
|
# @param card_id [String] The card identifier.
|
|
63
65
|
#
|
|
64
|
-
# @param authorization_controls [Increase::Models::CardUpdateParams::AuthorizationControls]
|
|
66
|
+
# @param authorization_controls [Increase::Models::CardUpdateParams::AuthorizationControls]
|
|
67
|
+
# Controls that restrict how this card can be used.
|
|
65
68
|
#
|
|
66
|
-
# @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
|
|
69
|
+
# @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
|
|
70
|
+
# The card's updated billing address.
|
|
67
71
|
#
|
|
68
72
|
# @param description [String] The description you choose to give the card.
|
|
69
73
|
#
|
|
70
|
-
# @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet]
|
|
74
|
+
# @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet]
|
|
75
|
+
# The contact information used in the two-factor steps for digital wallet card
|
|
76
|
+
# creation. At least one field must be present to complete the digital wallet
|
|
77
|
+
# steps.
|
|
71
78
|
#
|
|
72
|
-
# @param entity_id [String]
|
|
79
|
+
# @param entity_id [String]
|
|
80
|
+
# The Entity the card belongs to. You only need to supply this in rare situations
|
|
81
|
+
# when the card is not for the Account holder.
|
|
73
82
|
#
|
|
74
83
|
# @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
|
|
75
84
|
#
|
|
@@ -89,9 +98,6 @@ module Increase
|
|
|
89
98
|
)
|
|
90
99
|
end
|
|
91
100
|
|
|
92
|
-
# Some parameter documentations has been truncated, see
|
|
93
|
-
# {Increase::Models::CardListParams} for more details.
|
|
94
|
-
#
|
|
95
101
|
# List Cards
|
|
96
102
|
#
|
|
97
103
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -102,9 +108,15 @@ module Increase
|
|
|
102
108
|
#
|
|
103
109
|
# @param cursor [String] Return the page of entries after this one.
|
|
104
110
|
#
|
|
105
|
-
# @param idempotency_key [String]
|
|
111
|
+
# @param idempotency_key [String]
|
|
112
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
113
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
114
|
+
# request is only processed once. Learn more about
|
|
115
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
106
116
|
#
|
|
107
|
-
# @param limit [Integer]
|
|
117
|
+
# @param limit [Integer]
|
|
118
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
119
|
+
# objects.
|
|
108
120
|
#
|
|
109
121
|
# @param status [Increase::Models::CardListParams::Status]
|
|
110
122
|
#
|
|
@@ -126,9 +138,6 @@ module Increase
|
|
|
126
138
|
)
|
|
127
139
|
end
|
|
128
140
|
|
|
129
|
-
# Some parameter documentations has been truncated, see
|
|
130
|
-
# {Increase::Models::CardCreateDetailsIframeParams} for more details.
|
|
131
|
-
#
|
|
132
141
|
# Create an iframe URL for a Card to display the card details. More details about
|
|
133
142
|
# styling and usage can be found in the
|
|
134
143
|
# [documentation](/documentation/embedded-card-component).
|
|
@@ -137,7 +146,9 @@ module Increase
|
|
|
137
146
|
#
|
|
138
147
|
# @param card_id [String] The identifier of the Card to create an iframe for.
|
|
139
148
|
#
|
|
140
|
-
# @param physical_card_id [String]
|
|
149
|
+
# @param physical_card_id [String]
|
|
150
|
+
# The identifier of the Physical Card to create an iframe for. This will inform
|
|
151
|
+
# the appearance of the card rendered in the iframe.
|
|
141
152
|
#
|
|
142
153
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
143
154
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class CheckDeposits
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::CheckDepositCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Check Deposit
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {})
|
|
@@ -18,7 +15,8 @@ module Increase
|
|
|
18
15
|
#
|
|
19
16
|
# @param front_image_file_id [String] The File containing the check's front image.
|
|
20
17
|
#
|
|
21
|
-
# @param description [String]
|
|
18
|
+
# @param description [String]
|
|
19
|
+
# The description you choose to give the Check Deposit, for display purposes only.
|
|
22
20
|
#
|
|
23
21
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
22
|
#
|
|
@@ -56,9 +54,6 @@ module Increase
|
|
|
56
54
|
)
|
|
57
55
|
end
|
|
58
56
|
|
|
59
|
-
# Some parameter documentations has been truncated, see
|
|
60
|
-
# {Increase::Models::CheckDepositListParams} for more details.
|
|
61
|
-
#
|
|
62
57
|
# List Check Deposits
|
|
63
58
|
#
|
|
64
59
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -69,9 +64,15 @@ module Increase
|
|
|
69
64
|
#
|
|
70
65
|
# @param cursor [String] Return the page of entries after this one.
|
|
71
66
|
#
|
|
72
|
-
# @param idempotency_key [String]
|
|
67
|
+
# @param idempotency_key [String]
|
|
68
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
69
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
70
|
+
# request is only processed once. Learn more about
|
|
71
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
73
72
|
#
|
|
74
|
-
# @param limit [Integer]
|
|
73
|
+
# @param limit [Integer]
|
|
74
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
75
|
+
# objects.
|
|
75
76
|
#
|
|
76
77
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
77
78
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class CheckTransfers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::CheckTransferCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Check Transfer
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, balance_check: nil, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, valid_until_date: nil, request_options: {})
|
|
@@ -14,21 +11,40 @@ module Increase
|
|
|
14
11
|
#
|
|
15
12
|
# @param amount [Integer] The transfer amount in USD cents.
|
|
16
13
|
#
|
|
17
|
-
# @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod]
|
|
14
|
+
# @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod]
|
|
15
|
+
# Whether Increase will print and mail the check or if you will do it yourself.
|
|
18
16
|
#
|
|
19
|
-
# @param source_account_number_id [String]
|
|
17
|
+
# @param source_account_number_id [String]
|
|
18
|
+
# The identifier of the Account Number from which to send the transfer and print
|
|
19
|
+
# on the check.
|
|
20
20
|
#
|
|
21
|
-
# @param balance_check [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck]
|
|
21
|
+
# @param balance_check [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck]
|
|
22
|
+
# How the account's available balance should be checked. If omitted, the default
|
|
23
|
+
# behavior is `balance_check: full`.
|
|
22
24
|
#
|
|
23
|
-
# @param check_number [String]
|
|
25
|
+
# @param check_number [String]
|
|
26
|
+
# The check number Increase should use for the check. This should not contain
|
|
27
|
+
# leading zeroes and must be unique across the `source_account_number`. If this is
|
|
28
|
+
# omitted, Increase will generate a check number for you.
|
|
24
29
|
#
|
|
25
|
-
# @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck]
|
|
30
|
+
# @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck]
|
|
31
|
+
# Details relating to the physical check that Increase will print and mail. This
|
|
32
|
+
# is required if `fulfillment_method` is equal to `physical_check`. It must not be
|
|
33
|
+
# included if any other `fulfillment_method` is provided.
|
|
26
34
|
#
|
|
27
|
-
# @param require_approval [Boolean]
|
|
35
|
+
# @param require_approval [Boolean]
|
|
36
|
+
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
28
37
|
#
|
|
29
|
-
# @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty]
|
|
38
|
+
# @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty]
|
|
39
|
+
# Details relating to the custom fulfillment you will perform. This is required if
|
|
40
|
+
# `fulfillment_method` is equal to `third_party`. It must not be included if any
|
|
41
|
+
# other `fulfillment_method` is provided.
|
|
30
42
|
#
|
|
31
|
-
# @param valid_until_date [Date]
|
|
43
|
+
# @param valid_until_date [Date]
|
|
44
|
+
# If provided, the check will be valid on or before this date. After this date,
|
|
45
|
+
# the check transfer will be automatically stopped and deposits will not be
|
|
46
|
+
# accepted. For checks printed by Increase, this date is included on the check as
|
|
47
|
+
# its expiry.
|
|
32
48
|
#
|
|
33
49
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
34
50
|
#
|
|
@@ -66,9 +82,6 @@ module Increase
|
|
|
66
82
|
)
|
|
67
83
|
end
|
|
68
84
|
|
|
69
|
-
# Some parameter documentations has been truncated, see
|
|
70
|
-
# {Increase::Models::CheckTransferListParams} for more details.
|
|
71
|
-
#
|
|
72
85
|
# List Check Transfers
|
|
73
86
|
#
|
|
74
87
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -79,9 +92,15 @@ module Increase
|
|
|
79
92
|
#
|
|
80
93
|
# @param cursor [String] Return the page of entries after this one.
|
|
81
94
|
#
|
|
82
|
-
# @param idempotency_key [String]
|
|
95
|
+
# @param idempotency_key [String]
|
|
96
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
97
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
98
|
+
# request is only processed once. Learn more about
|
|
99
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
83
100
|
#
|
|
84
|
-
# @param limit [Integer]
|
|
101
|
+
# @param limit [Integer]
|
|
102
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
103
|
+
# objects.
|
|
85
104
|
#
|
|
86
105
|
# @param status [Increase::Models::CheckTransferListParams::Status]
|
|
87
106
|
#
|
|
@@ -150,7 +169,8 @@ module Increase
|
|
|
150
169
|
#
|
|
151
170
|
# @param check_transfer_id [String] The identifier of the Check Transfer.
|
|
152
171
|
#
|
|
153
|
-
# @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason]
|
|
172
|
+
# @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason]
|
|
173
|
+
# The reason why this transfer should be stopped.
|
|
154
174
|
#
|
|
155
175
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
156
176
|
#
|
|
@@ -23,9 +23,6 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::DeclinedTransactionListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Declined Transactions
|
|
30
27
|
#
|
|
31
28
|
# @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
|
|
@@ -38,7 +35,9 @@ module Increase
|
|
|
38
35
|
#
|
|
39
36
|
# @param cursor [String] Return the page of entries after this one.
|
|
40
37
|
#
|
|
41
|
-
# @param limit [Integer]
|
|
38
|
+
# @param limit [Integer]
|
|
39
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
40
|
+
# objects.
|
|
42
41
|
#
|
|
43
42
|
# @param route_id [String] Filter Declined Transactions to those belonging to the specified route.
|
|
44
43
|
#
|
|
@@ -23,7 +23,8 @@ module Increase
|
|
|
23
23
|
#
|
|
24
24
|
# @param contact_website [String] A website the user can visit to view and receive support for their card.
|
|
25
25
|
#
|
|
26
|
-
# @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor]
|
|
26
|
+
# @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor]
|
|
27
|
+
# The Card's text color, specified as an RGB triple. The default is white.
|
|
27
28
|
#
|
|
28
29
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
29
30
|
#
|
|
@@ -61,18 +62,21 @@ module Increase
|
|
|
61
62
|
)
|
|
62
63
|
end
|
|
63
64
|
|
|
64
|
-
# Some parameter documentations has been truncated, see
|
|
65
|
-
# {Increase::Models::DigitalCardProfileListParams} for more details.
|
|
66
|
-
#
|
|
67
65
|
# List Card Profiles
|
|
68
66
|
#
|
|
69
67
|
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
70
68
|
#
|
|
71
69
|
# @param cursor [String] Return the page of entries after this one.
|
|
72
70
|
#
|
|
73
|
-
# @param idempotency_key [String]
|
|
71
|
+
# @param idempotency_key [String]
|
|
72
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
73
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
74
|
+
# request is only processed once. Learn more about
|
|
75
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
74
76
|
#
|
|
75
|
-
# @param limit [Integer]
|
|
77
|
+
# @param limit [Integer]
|
|
78
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
79
|
+
# objects.
|
|
76
80
|
#
|
|
77
81
|
# @param status [Increase::Models::DigitalCardProfileListParams::Status]
|
|
78
82
|
#
|
|
@@ -136,7 +140,8 @@ module Increase
|
|
|
136
140
|
#
|
|
137
141
|
# @param issuer_name [String] A user-facing description for whoever is issuing the card.
|
|
138
142
|
#
|
|
139
|
-
# @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor]
|
|
143
|
+
# @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor]
|
|
144
|
+
# The Card's text color, specified as an RGB triple. The default is white.
|
|
140
145
|
#
|
|
141
146
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
142
147
|
#
|
|
@@ -23,9 +23,6 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::DigitalWalletTokenListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Digital Wallet Tokens
|
|
30
27
|
#
|
|
31
28
|
# @overload list(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
|
|
@@ -36,7 +33,9 @@ module Increase
|
|
|
36
33
|
#
|
|
37
34
|
# @param cursor [String] Return the page of entries after this one.
|
|
38
35
|
#
|
|
39
|
-
# @param limit [Integer]
|
|
36
|
+
# @param limit [Integer]
|
|
37
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
38
|
+
# objects.
|
|
40
39
|
#
|
|
41
40
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
42
41
|
#
|
|
@@ -3,34 +3,51 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class Entities
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::EntityCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an Entity
|
|
10
7
|
#
|
|
11
8
|
# @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
|
|
14
11
|
#
|
|
15
|
-
# @param corporation [Increase::Models::EntityCreateParams::Corporation]
|
|
12
|
+
# @param corporation [Increase::Models::EntityCreateParams::Corporation]
|
|
13
|
+
# Details of the corporation entity to create. Required if `structure` is equal to
|
|
14
|
+
# `corporation`.
|
|
16
15
|
#
|
|
17
16
|
# @param description [String] The description you choose to give the entity.
|
|
18
17
|
#
|
|
19
|
-
# @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
|
|
18
|
+
# @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
|
|
19
|
+
# Details of the Government Authority entity to create. Required if `structure` is
|
|
20
|
+
# equal to `government_authority`.
|
|
20
21
|
#
|
|
21
|
-
# @param joint [Increase::Models::EntityCreateParams::Joint]
|
|
22
|
+
# @param joint [Increase::Models::EntityCreateParams::Joint]
|
|
23
|
+
# Details of the joint entity to create. Required if `structure` is equal to
|
|
24
|
+
# `joint`.
|
|
22
25
|
#
|
|
23
|
-
# @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson]
|
|
26
|
+
# @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson]
|
|
27
|
+
# Details of the natural person entity to create. Required if `structure` is equal
|
|
28
|
+
# to `natural_person`. Natural people entities should be submitted with
|
|
29
|
+
# `social_security_number` or `individual_taxpayer_identification_number`
|
|
30
|
+
# identification methods.
|
|
24
31
|
#
|
|
25
|
-
# @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
|
|
32
|
+
# @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
|
|
33
|
+
# An assessment of the entity's potential risk of involvement in financial crimes,
|
|
34
|
+
# such as money laundering.
|
|
26
35
|
#
|
|
27
|
-
# @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
|
|
36
|
+
# @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
|
|
37
|
+
# Additional documentation associated with the entity.
|
|
28
38
|
#
|
|
29
|
-
# @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>]
|
|
39
|
+
# @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>]
|
|
40
|
+
# The terms that the Entity agreed to. Not all programs are required to submit
|
|
41
|
+
# this data.
|
|
30
42
|
#
|
|
31
|
-
# @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification]
|
|
43
|
+
# @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification]
|
|
44
|
+
# If you are using a third-party service for identity verification, you can use
|
|
45
|
+
# this field to associate this Entity with the identifier that represents them in
|
|
46
|
+
# that service.
|
|
32
47
|
#
|
|
33
|
-
# @param trust [Increase::Models::EntityCreateParams::Trust]
|
|
48
|
+
# @param trust [Increase::Models::EntityCreateParams::Trust]
|
|
49
|
+
# Details of the trust entity to create. Required if `structure` is equal to
|
|
50
|
+
# `trust`.
|
|
34
51
|
#
|
|
35
52
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
36
53
|
#
|
|
@@ -68,30 +85,45 @@ module Increase
|
|
|
68
85
|
)
|
|
69
86
|
end
|
|
70
87
|
|
|
71
|
-
# Some parameter documentations has been truncated, see
|
|
72
|
-
# {Increase::Models::EntityUpdateParams} for more details.
|
|
73
|
-
#
|
|
74
88
|
# Update an Entity
|
|
75
89
|
#
|
|
76
90
|
# @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
|
|
77
91
|
#
|
|
78
92
|
# @param entity_id [String] The entity identifier.
|
|
79
93
|
#
|
|
80
|
-
# @param corporation [Increase::Models::EntityUpdateParams::Corporation]
|
|
94
|
+
# @param corporation [Increase::Models::EntityUpdateParams::Corporation]
|
|
95
|
+
# Details of the corporation entity to update. If you specify this parameter and
|
|
96
|
+
# the entity is not a corporation, the request will fail.
|
|
81
97
|
#
|
|
82
|
-
# @param details_confirmed_at [Time]
|
|
98
|
+
# @param details_confirmed_at [Time]
|
|
99
|
+
# When your user last confirmed the Entity's details. Depending on your program,
|
|
100
|
+
# you may be required to affirmatively confirm details with your users on an
|
|
101
|
+
# annual basis.
|
|
83
102
|
#
|
|
84
|
-
# @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority]
|
|
103
|
+
# @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority]
|
|
104
|
+
# Details of the government authority entity to update. If you specify this
|
|
105
|
+
# parameter and the entity is not a government authority, the request will fail.
|
|
85
106
|
#
|
|
86
|
-
# @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson]
|
|
107
|
+
# @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson]
|
|
108
|
+
# Details of the natural person entity to update. If you specify this parameter
|
|
109
|
+
# and the entity is not a natural person, the request will fail.
|
|
87
110
|
#
|
|
88
|
-
# @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
|
|
111
|
+
# @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
|
|
112
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
|
113
|
+
# such as money laundering.
|
|
89
114
|
#
|
|
90
|
-
# @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>]
|
|
115
|
+
# @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>]
|
|
116
|
+
# New terms that the Entity agreed to. Not all programs are required to submit
|
|
117
|
+
# this data. This will not archive previously submitted terms.
|
|
91
118
|
#
|
|
92
|
-
# @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification]
|
|
119
|
+
# @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification]
|
|
120
|
+
# If you are using a third-party service for identity verification, you can use
|
|
121
|
+
# this field to associate this Entity with the identifier that represents them in
|
|
122
|
+
# that service.
|
|
93
123
|
#
|
|
94
|
-
# @param trust [Increase::Models::EntityUpdateParams::Trust]
|
|
124
|
+
# @param trust [Increase::Models::EntityUpdateParams::Trust]
|
|
125
|
+
# Details of the trust entity to update. If you specify this parameter and the
|
|
126
|
+
# entity is not a trust, the request will fail.
|
|
95
127
|
#
|
|
96
128
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
97
129
|
#
|
|
@@ -109,23 +141,28 @@ module Increase
|
|
|
109
141
|
)
|
|
110
142
|
end
|
|
111
143
|
|
|
112
|
-
# Some parameter documentations has been truncated, see
|
|
113
|
-
# {Increase::Models::EntityListParams} for more details.
|
|
114
|
-
#
|
|
115
144
|
# List Entities
|
|
116
145
|
#
|
|
117
|
-
# @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
146
|
+
# @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, validation_status: nil, request_options: {})
|
|
118
147
|
#
|
|
119
148
|
# @param created_at [Increase::Models::EntityListParams::CreatedAt]
|
|
120
149
|
#
|
|
121
150
|
# @param cursor [String] Return the page of entries after this one.
|
|
122
151
|
#
|
|
123
|
-
# @param idempotency_key [String]
|
|
152
|
+
# @param idempotency_key [String]
|
|
153
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
154
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
155
|
+
# request is only processed once. Learn more about
|
|
156
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
124
157
|
#
|
|
125
|
-
# @param limit [Integer]
|
|
158
|
+
# @param limit [Integer]
|
|
159
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
160
|
+
# objects.
|
|
126
161
|
#
|
|
127
162
|
# @param status [Increase::Models::EntityListParams::Status]
|
|
128
163
|
#
|
|
164
|
+
# @param validation_status [Increase::Models::EntityListParams::ValidationStatus]
|
|
165
|
+
#
|
|
129
166
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
130
167
|
#
|
|
131
168
|
# @return [Increase::Internal::Page<Increase::Models::Entity>]
|
|
@@ -144,14 +181,13 @@ module Increase
|
|
|
144
181
|
)
|
|
145
182
|
end
|
|
146
183
|
|
|
147
|
-
# Some parameter documentations has been truncated, see
|
|
148
|
-
# {Increase::Models::EntityArchiveParams} for more details.
|
|
149
|
-
#
|
|
150
184
|
# Archive an Entity
|
|
151
185
|
#
|
|
152
186
|
# @overload archive(entity_id, request_options: {})
|
|
153
187
|
#
|
|
154
|
-
# @param entity_id [String]
|
|
188
|
+
# @param entity_id [String]
|
|
189
|
+
# The identifier of the Entity to archive. Any accounts associated with an entity
|
|
190
|
+
# must be closed before the entity can be archived.
|
|
155
191
|
#
|
|
156
192
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
157
193
|
#
|
|
@@ -3,18 +3,21 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class EntityOnboardingSessions
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::EntityOnboardingSessionCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an Entity Onboarding Session
|
|
10
7
|
#
|
|
11
8
|
# @overload create(program_id:, redirect_url:, entity_id: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param program_id [String] The identifier of the Program the Entity will be onboarded to.
|
|
14
11
|
#
|
|
15
|
-
# @param redirect_url [String]
|
|
12
|
+
# @param redirect_url [String]
|
|
13
|
+
# The URL to redirect the customer to after they complete the onboarding form. The
|
|
14
|
+
# redirect will include `entity_onboarding_session_id` and `entity_id` query
|
|
15
|
+
# parameters.
|
|
16
16
|
#
|
|
17
|
-
# @param entity_id [String]
|
|
17
|
+
# @param entity_id [String]
|
|
18
|
+
# The identifier of an existing Entity to associate with the onboarding session.
|
|
19
|
+
# If provided, the onboarding form will display any outstanding tasks required to
|
|
20
|
+
# complete the Entity's onboarding.
|
|
18
21
|
#
|
|
19
22
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
20
23
|
#
|
|
@@ -52,18 +55,21 @@ module Increase
|
|
|
52
55
|
)
|
|
53
56
|
end
|
|
54
57
|
|
|
55
|
-
# Some parameter documentations has been truncated, see
|
|
56
|
-
# {Increase::Models::EntityOnboardingSessionListParams} for more details.
|
|
57
|
-
#
|
|
58
58
|
# List Entity Onboarding Session
|
|
59
59
|
#
|
|
60
60
|
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
61
61
|
#
|
|
62
62
|
# @param cursor [String] Return the page of entries after this one.
|
|
63
63
|
#
|
|
64
|
-
# @param idempotency_key [String]
|
|
64
|
+
# @param idempotency_key [String]
|
|
65
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
66
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
67
|
+
# request is only processed once. Learn more about
|
|
68
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
65
69
|
#
|
|
66
|
-
# @param limit [Integer]
|
|
70
|
+
# @param limit [Integer]
|
|
71
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
72
|
+
# objects.
|
|
67
73
|
#
|
|
68
74
|
# @param status [Increase::Models::EntityOnboardingSessionListParams::Status]
|
|
69
75
|
#
|
|
@@ -3,22 +3,27 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class EventSubscriptions
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::EventSubscriptionCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an Event Subscription
|
|
10
7
|
#
|
|
11
8
|
# @overload create(url:, oauth_connection_id: nil, selected_event_categories: nil, shared_secret: nil, status: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param url [String] The URL you'd like us to send webhooks to.
|
|
14
11
|
#
|
|
15
|
-
# @param oauth_connection_id [String]
|
|
12
|
+
# @param oauth_connection_id [String]
|
|
13
|
+
# If specified, this subscription will only receive webhooks for Events associated
|
|
14
|
+
# with the specified OAuth Connection.
|
|
16
15
|
#
|
|
17
|
-
# @param selected_event_categories [Array<Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory>]
|
|
16
|
+
# @param selected_event_categories [Array<Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory>]
|
|
17
|
+
# If specified, this subscription will only receive webhooks for Events with the
|
|
18
|
+
# specified `category`. If specifying a Real-Time Decision event category, only
|
|
19
|
+
# one Event Category can be specified for the Event Subscription.
|
|
18
20
|
#
|
|
19
|
-
# @param shared_secret [String]
|
|
21
|
+
# @param shared_secret [String]
|
|
22
|
+
# The key that will be used to sign webhooks. If no value is passed, a random
|
|
23
|
+
# string will be used as default.
|
|
20
24
|
#
|
|
21
|
-
# @param status [Symbol, Increase::Models::EventSubscriptionCreateParams::Status]
|
|
25
|
+
# @param status [Symbol, Increase::Models::EventSubscriptionCreateParams::Status]
|
|
26
|
+
# The status of the event subscription. Defaults to `active` if not specified.
|
|
22
27
|
#
|
|
23
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
29
|
#
|
|
@@ -62,7 +67,8 @@ module Increase
|
|
|
62
67
|
#
|
|
63
68
|
# @param event_subscription_id [String] The identifier of the Event Subscription.
|
|
64
69
|
#
|
|
65
|
-
# @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status]
|
|
70
|
+
# @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status]
|
|
71
|
+
# The status to update the Event Subscription with.
|
|
66
72
|
#
|
|
67
73
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
68
74
|
#
|
|
@@ -80,18 +86,21 @@ module Increase
|
|
|
80
86
|
)
|
|
81
87
|
end
|
|
82
88
|
|
|
83
|
-
# Some parameter documentations has been truncated, see
|
|
84
|
-
# {Increase::Models::EventSubscriptionListParams} for more details.
|
|
85
|
-
#
|
|
86
89
|
# List Event Subscriptions
|
|
87
90
|
#
|
|
88
91
|
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
89
92
|
#
|
|
90
93
|
# @param cursor [String] Return the page of entries after this one.
|
|
91
94
|
#
|
|
92
|
-
# @param idempotency_key [String]
|
|
95
|
+
# @param idempotency_key [String]
|
|
96
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
97
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
98
|
+
# request is only processed once. Learn more about
|
|
99
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
93
100
|
#
|
|
94
|
-
# @param limit [Integer]
|
|
101
|
+
# @param limit [Integer]
|
|
102
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
103
|
+
# objects.
|
|
95
104
|
#
|
|
96
105
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
97
106
|
#
|