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
|
@@ -52,20 +52,28 @@ module Increase
|
|
|
52
52
|
-> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerUpdateParams::Prong] }
|
|
53
53
|
|
|
54
54
|
# @!method initialize(entity_beneficial_owner_id:, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, prongs: nil, request_options: {})
|
|
55
|
-
# Some parameter documentations has been truncated, see
|
|
56
|
-
# {Increase::Models::BeneficialOwnerUpdateParams} for more details.
|
|
57
|
-
#
|
|
58
55
|
# @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
|
|
59
56
|
#
|
|
60
|
-
# @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
|
|
57
|
+
# @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
|
|
58
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
59
|
+
# PMB's are disallowed.
|
|
61
60
|
#
|
|
62
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
61
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
62
|
+
# The identification method for an individual can only be a passport, driver's
|
|
63
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
64
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
65
|
+
# Number).
|
|
63
66
|
#
|
|
64
|
-
# @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
|
|
67
|
+
# @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
|
|
68
|
+
# A means of verifying the person's identity.
|
|
65
69
|
#
|
|
66
70
|
# @param name [String] The individual's legal name.
|
|
67
71
|
#
|
|
68
|
-
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>]
|
|
72
|
+
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>]
|
|
73
|
+
# Why this person is considered a beneficial owner of the entity. At least one
|
|
74
|
+
# option is required, if a person is both a control person and owner, submit an
|
|
75
|
+
# array containing both. Providing this replaces the beneficial owner's current
|
|
76
|
+
# prongs.
|
|
69
77
|
#
|
|
70
78
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
71
79
|
|
|
@@ -108,9 +116,6 @@ module Increase
|
|
|
108
116
|
optional :zip, String
|
|
109
117
|
|
|
110
118
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
111
|
-
# Some parameter documentations has been truncated, see
|
|
112
|
-
# {Increase::Models::BeneficialOwnerUpdateParams::Address} for more details.
|
|
113
|
-
#
|
|
114
119
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
115
120
|
# PMB's are disallowed.
|
|
116
121
|
#
|
|
@@ -122,7 +127,9 @@ module Increase
|
|
|
122
127
|
#
|
|
123
128
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
124
129
|
#
|
|
125
|
-
# @param state [String]
|
|
130
|
+
# @param state [String]
|
|
131
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
132
|
+
# state, province, or region of the address. Required in certain countries.
|
|
126
133
|
#
|
|
127
134
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
128
135
|
end
|
|
@@ -168,21 +175,29 @@ module Increase
|
|
|
168
175
|
optional :passport, -> { Increase::BeneficialOwnerUpdateParams::Identification::Passport }
|
|
169
176
|
|
|
170
177
|
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
171
|
-
# Some parameter documentations has been truncated, see
|
|
172
|
-
# {Increase::Models::BeneficialOwnerUpdateParams::Identification} for more
|
|
173
|
-
# details.
|
|
174
|
-
#
|
|
175
178
|
# A means of verifying the person's identity.
|
|
176
179
|
#
|
|
177
|
-
# @param method_ [Symbol, Increase::Models::BeneficialOwnerUpdateParams::Identification::Method]
|
|
180
|
+
# @param method_ [Symbol, Increase::Models::BeneficialOwnerUpdateParams::Identification::Method]
|
|
181
|
+
# A method that can be used to verify the individual's identity.
|
|
178
182
|
#
|
|
179
|
-
# @param number [String]
|
|
183
|
+
# @param number [String]
|
|
184
|
+
# An identification number that can be used to verify the individual's identity,
|
|
185
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
186
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
187
|
+
# separators. When testing in sandbox, use one of our
|
|
188
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
180
189
|
#
|
|
181
|
-
# @param drivers_license [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense]
|
|
190
|
+
# @param drivers_license [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense]
|
|
191
|
+
# Information about the United States driver's license used for identification.
|
|
192
|
+
# Required if `method` is equal to `drivers_license`.
|
|
182
193
|
#
|
|
183
|
-
# @param other [Increase::Models::BeneficialOwnerUpdateParams::Identification::Other]
|
|
194
|
+
# @param other [Increase::Models::BeneficialOwnerUpdateParams::Identification::Other]
|
|
195
|
+
# Information about the identification document provided. Required if `method` is
|
|
196
|
+
# equal to `other`.
|
|
184
197
|
#
|
|
185
|
-
# @param passport [Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport]
|
|
198
|
+
# @param passport [Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport]
|
|
199
|
+
# Information about the passport used for identification. Required if `method` is
|
|
200
|
+
# equal to `passport`.
|
|
186
201
|
|
|
187
202
|
# A method that can be used to verify the individual's identity.
|
|
188
203
|
#
|
|
@@ -283,20 +298,20 @@ module Increase
|
|
|
283
298
|
optional :expiration_date, Date
|
|
284
299
|
|
|
285
300
|
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
286
|
-
# Some parameter documentations has been truncated, see
|
|
287
|
-
# {Increase::Models::BeneficialOwnerUpdateParams::Identification::Other} for more
|
|
288
|
-
# details.
|
|
289
|
-
#
|
|
290
301
|
# Information about the identification document provided. Required if `method` is
|
|
291
302
|
# equal to `other`.
|
|
292
303
|
#
|
|
293
|
-
# @param country [String]
|
|
304
|
+
# @param country [String]
|
|
305
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
306
|
+
# document (e.g., `US`).
|
|
294
307
|
#
|
|
295
308
|
# @param description [String] A description of the document submitted.
|
|
296
309
|
#
|
|
297
310
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
298
311
|
#
|
|
299
|
-
# @param back_file_id [String]
|
|
312
|
+
# @param back_file_id [String]
|
|
313
|
+
# The identifier of the File containing the back of the document. Not every
|
|
314
|
+
# document has a reverse side.
|
|
300
315
|
#
|
|
301
316
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
302
317
|
end
|
|
@@ -323,14 +338,12 @@ module Increase
|
|
|
323
338
|
required :file_id, String
|
|
324
339
|
|
|
325
340
|
# @!method initialize(country:, expiration_date:, file_id:)
|
|
326
|
-
# Some parameter documentations has been truncated, see
|
|
327
|
-
# {Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport} for
|
|
328
|
-
# more details.
|
|
329
|
-
#
|
|
330
341
|
# Information about the passport used for identification. Required if `method` is
|
|
331
342
|
# equal to `passport`.
|
|
332
343
|
#
|
|
333
|
-
# @param country [String]
|
|
344
|
+
# @param country [String]
|
|
345
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
346
|
+
# document (e.g., `US`).
|
|
334
347
|
#
|
|
335
348
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
336
349
|
#
|
data/lib/increase/models/card.rb
CHANGED
|
@@ -101,9 +101,6 @@ module Increase
|
|
|
101
101
|
required :type, enum: -> { Increase::Card::Type }
|
|
102
102
|
|
|
103
103
|
# @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
|
|
104
|
-
# Some parameter documentations has been truncated, see {Increase::Models::Card}
|
|
105
|
-
# for more details.
|
|
106
|
-
#
|
|
107
104
|
# Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work
|
|
108
105
|
# for online purchases after you create them. All cards work on a good funds
|
|
109
106
|
# model, and maintain a maximum limit of 100% of the Account’s available balance
|
|
@@ -114,17 +111,23 @@ module Increase
|
|
|
114
111
|
#
|
|
115
112
|
# @param account_id [String] The identifier for the account this card belongs to.
|
|
116
113
|
#
|
|
117
|
-
# @param authorization_controls [Increase::Models::Card::AuthorizationControls, nil]
|
|
114
|
+
# @param authorization_controls [Increase::Models::Card::AuthorizationControls, nil]
|
|
115
|
+
# Controls that restrict how this card can be used.
|
|
118
116
|
#
|
|
119
117
|
# @param billing_address [Increase::Models::Card::BillingAddress] The Card's billing address.
|
|
120
118
|
#
|
|
121
119
|
# @param bin [String] The Bank Identification Number (BIN) of the Card.
|
|
122
120
|
#
|
|
123
|
-
# @param created_at [Time]
|
|
121
|
+
# @param created_at [Time]
|
|
122
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
123
|
+
# the Card was created.
|
|
124
124
|
#
|
|
125
125
|
# @param description [String, nil] The card's description for display purposes.
|
|
126
126
|
#
|
|
127
|
-
# @param digital_wallet [Increase::Models::Card::DigitalWallet, nil]
|
|
127
|
+
# @param digital_wallet [Increase::Models::Card::DigitalWallet, nil]
|
|
128
|
+
# The contact information used in the two-factor steps for digital wallet card
|
|
129
|
+
# creation. At least one field must be present to complete the digital wallet
|
|
130
|
+
# steps.
|
|
128
131
|
#
|
|
129
132
|
# @param entity_id [String, nil] The identifier for the entity associated with this card.
|
|
130
133
|
#
|
|
@@ -132,13 +135,19 @@ module Increase
|
|
|
132
135
|
#
|
|
133
136
|
# @param expiration_year [Integer] The year the card expires in YYYY format (e.g., 2025).
|
|
134
137
|
#
|
|
135
|
-
# @param idempotency_key [String, nil]
|
|
138
|
+
# @param idempotency_key [String, nil]
|
|
139
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
140
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
141
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
136
142
|
#
|
|
137
143
|
# @param last4 [String] The last 4 digits of the Card's Primary Account Number.
|
|
138
144
|
#
|
|
139
|
-
# @param status [Symbol, Increase::Models::Card::Status]
|
|
145
|
+
# @param status [Symbol, Increase::Models::Card::Status]
|
|
146
|
+
# This indicates if payments can be made with the card.
|
|
140
147
|
#
|
|
141
|
-
# @param type [Symbol, Increase::Models::Card::Type]
|
|
148
|
+
# @param type [Symbol, Increase::Models::Card::Type]
|
|
149
|
+
# A constant representing the object's type. For this resource it will always be
|
|
150
|
+
# `card`.
|
|
142
151
|
|
|
143
152
|
# @see Increase::Models::Card#authorization_controls
|
|
144
153
|
class AuthorizationControls < Increase::Internal::Type::BaseModel
|
|
@@ -174,18 +183,22 @@ module Increase
|
|
|
174
183
|
required :usage, -> { Increase::Card::AuthorizationControls::Usage }, nil?: true
|
|
175
184
|
|
|
176
185
|
# @!method initialize(merchant_acceptor_identifier:, merchant_category_code:, merchant_country:, usage:)
|
|
177
|
-
# Some parameter documentations has been truncated, see
|
|
178
|
-
# {Increase::Models::Card::AuthorizationControls} for more details.
|
|
179
|
-
#
|
|
180
186
|
# Controls that restrict how this card can be used.
|
|
181
187
|
#
|
|
182
|
-
# @param merchant_acceptor_identifier [Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier, nil]
|
|
188
|
+
# @param merchant_acceptor_identifier [Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier, nil]
|
|
189
|
+
# Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
|
|
190
|
+
# on this card.
|
|
183
191
|
#
|
|
184
|
-
# @param merchant_category_code [Increase::Models::Card::AuthorizationControls::MerchantCategoryCode, nil]
|
|
192
|
+
# @param merchant_category_code [Increase::Models::Card::AuthorizationControls::MerchantCategoryCode, nil]
|
|
193
|
+
# Restricts which Merchant Category Codes are allowed or blocked for
|
|
194
|
+
# authorizations on this card.
|
|
185
195
|
#
|
|
186
|
-
# @param merchant_country [Increase::Models::Card::AuthorizationControls::MerchantCountry, nil]
|
|
196
|
+
# @param merchant_country [Increase::Models::Card::AuthorizationControls::MerchantCountry, nil]
|
|
197
|
+
# Restricts which merchant countries are allowed or blocked for authorizations on
|
|
198
|
+
# this card.
|
|
187
199
|
#
|
|
188
|
-
# @param usage [Increase::Models::Card::AuthorizationControls::Usage, nil]
|
|
200
|
+
# @param usage [Increase::Models::Card::AuthorizationControls::Usage, nil]
|
|
201
|
+
# Controls how many times this card can be used.
|
|
189
202
|
|
|
190
203
|
# @see Increase::Models::Card::AuthorizationControls#merchant_acceptor_identifier
|
|
191
204
|
class MerchantAcceptorIdentifier < Increase::Internal::Type::BaseModel
|
|
@@ -213,9 +226,11 @@ module Increase
|
|
|
213
226
|
# Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
|
|
214
227
|
# on this card.
|
|
215
228
|
#
|
|
216
|
-
# @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>, nil]
|
|
229
|
+
# @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>, nil]
|
|
230
|
+
# The Merchant Acceptor IDs that are allowed for authorizations on this card.
|
|
217
231
|
#
|
|
218
|
-
# @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>, nil]
|
|
232
|
+
# @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>, nil]
|
|
233
|
+
# The Merchant Acceptor IDs that are blocked for authorizations on this card.
|
|
219
234
|
|
|
220
235
|
class Allowed < Increase::Internal::Type::BaseModel
|
|
221
236
|
# @!attribute identifier
|
|
@@ -266,9 +281,11 @@ module Increase
|
|
|
266
281
|
# Restricts which Merchant Category Codes are allowed or blocked for
|
|
267
282
|
# authorizations on this card.
|
|
268
283
|
#
|
|
269
|
-
# @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Allowed>, nil]
|
|
284
|
+
# @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Allowed>, nil]
|
|
285
|
+
# The Merchant Category Codes that are allowed for authorizations on this card.
|
|
270
286
|
#
|
|
271
|
-
# @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Blocked>, nil]
|
|
287
|
+
# @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Blocked>, nil]
|
|
288
|
+
# The Merchant Category Codes that are blocked for authorizations on this card.
|
|
272
289
|
|
|
273
290
|
class Allowed < Increase::Internal::Type::BaseModel
|
|
274
291
|
# @!attribute code
|
|
@@ -319,9 +336,11 @@ module Increase
|
|
|
319
336
|
# Restricts which merchant countries are allowed or blocked for authorizations on
|
|
320
337
|
# this card.
|
|
321
338
|
#
|
|
322
|
-
# @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Allowed>, nil]
|
|
339
|
+
# @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Allowed>, nil]
|
|
340
|
+
# The merchant countries that are allowed for authorizations on this card.
|
|
323
341
|
#
|
|
324
|
-
# @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Blocked>, nil]
|
|
342
|
+
# @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Blocked>, nil]
|
|
343
|
+
# The merchant countries that are blocked for authorizations on this card.
|
|
325
344
|
|
|
326
345
|
class Allowed < Increase::Internal::Type::BaseModel
|
|
327
346
|
# @!attribute country
|
|
@@ -368,16 +387,17 @@ module Increase
|
|
|
368
387
|
required :single_use, -> { Increase::Card::AuthorizationControls::Usage::SingleUse }, nil?: true
|
|
369
388
|
|
|
370
389
|
# @!method initialize(category:, multi_use:, single_use:)
|
|
371
|
-
# Some parameter documentations has been truncated, see
|
|
372
|
-
# {Increase::Models::Card::AuthorizationControls::Usage} for more details.
|
|
373
|
-
#
|
|
374
390
|
# Controls how many times this card can be used.
|
|
375
391
|
#
|
|
376
|
-
# @param category [Symbol, Increase::Models::Card::AuthorizationControls::Usage::Category]
|
|
392
|
+
# @param category [Symbol, Increase::Models::Card::AuthorizationControls::Usage::Category]
|
|
393
|
+
# Whether the card is for a single use or multiple uses.
|
|
377
394
|
#
|
|
378
|
-
# @param multi_use [Increase::Models::Card::AuthorizationControls::Usage::MultiUse, nil]
|
|
395
|
+
# @param multi_use [Increase::Models::Card::AuthorizationControls::Usage::MultiUse, nil]
|
|
396
|
+
# Controls for multi-use cards. Required if and only if `category` is `multi_use`.
|
|
379
397
|
#
|
|
380
|
-
# @param single_use [Increase::Models::Card::AuthorizationControls::Usage::SingleUse, nil]
|
|
398
|
+
# @param single_use [Increase::Models::Card::AuthorizationControls::Usage::SingleUse, nil]
|
|
399
|
+
# Controls for single-use cards. Required if and only if `category` is
|
|
400
|
+
# `single_use`.
|
|
381
401
|
|
|
382
402
|
# Whether the card is for a single use or multiple uses.
|
|
383
403
|
#
|
|
@@ -409,13 +429,11 @@ module Increase
|
|
|
409
429
|
nil?: true
|
|
410
430
|
|
|
411
431
|
# @!method initialize(spending_limits:)
|
|
412
|
-
# Some parameter documentations has been truncated, see
|
|
413
|
-
# {Increase::Models::Card::AuthorizationControls::Usage::MultiUse} for more
|
|
414
|
-
# details.
|
|
415
|
-
#
|
|
416
432
|
# Controls for multi-use cards. Required if and only if `category` is `multi_use`.
|
|
417
433
|
#
|
|
418
|
-
# @param spending_limits [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit>, nil]
|
|
434
|
+
# @param spending_limits [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit>, nil]
|
|
435
|
+
# Spending limits for this card. The most restrictive limit applies if multiple
|
|
436
|
+
# limits match.
|
|
419
437
|
|
|
420
438
|
class SpendingLimit < Increase::Internal::Type::BaseModel
|
|
421
439
|
# @!attribute interval
|
|
@@ -443,13 +461,12 @@ module Increase
|
|
|
443
461
|
required :settlement_amount, Integer
|
|
444
462
|
|
|
445
463
|
# @!method initialize(interval:, merchant_category_codes:, settlement_amount:)
|
|
446
|
-
#
|
|
447
|
-
#
|
|
448
|
-
# for more details.
|
|
449
|
-
#
|
|
450
|
-
# @param interval [Symbol, Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval] The interval at which the spending limit is enforced.
|
|
464
|
+
# @param interval [Symbol, Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval]
|
|
465
|
+
# The interval at which the spending limit is enforced.
|
|
451
466
|
#
|
|
452
|
-
# @param merchant_category_codes [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>, nil]
|
|
467
|
+
# @param merchant_category_codes [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>, nil]
|
|
468
|
+
# The Merchant Category Codes (MCCs) this spending limit applies to. If not set,
|
|
469
|
+
# the limit applies to all transactions.
|
|
453
470
|
#
|
|
454
471
|
# @param settlement_amount [Integer] The maximum settlement amount permitted in the given interval.
|
|
455
472
|
|
|
@@ -504,7 +521,8 @@ module Increase
|
|
|
504
521
|
# Controls for single-use cards. Required if and only if `category` is
|
|
505
522
|
# `single_use`.
|
|
506
523
|
#
|
|
507
|
-
# @param settlement_amount [Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount]
|
|
524
|
+
# @param settlement_amount [Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount]
|
|
525
|
+
# The settlement amount constraint for this single-use card.
|
|
508
526
|
|
|
509
527
|
# @see Increase::Models::Card::AuthorizationControls::Usage::SingleUse#settlement_amount
|
|
510
528
|
class SettlementAmount < Increase::Internal::Type::BaseModel
|
|
@@ -524,7 +542,8 @@ module Increase
|
|
|
524
542
|
# @!method initialize(comparison:, value:)
|
|
525
543
|
# The settlement amount constraint for this single-use card.
|
|
526
544
|
#
|
|
527
|
-
# @param comparison [Symbol, Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison]
|
|
545
|
+
# @param comparison [Symbol, Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison]
|
|
546
|
+
# The operator used to compare the settlement amount.
|
|
528
547
|
#
|
|
529
548
|
# @param value [Integer] The settlement amount value.
|
|
530
549
|
|
|
@@ -618,18 +637,21 @@ module Increase
|
|
|
618
637
|
required :phone, String, nil?: true
|
|
619
638
|
|
|
620
639
|
# @!method initialize(digital_card_profile_id:, email:, phone:)
|
|
621
|
-
# Some parameter documentations has been truncated, see
|
|
622
|
-
# {Increase::Models::Card::DigitalWallet} for more details.
|
|
623
|
-
#
|
|
624
640
|
# The contact information used in the two-factor steps for digital wallet card
|
|
625
641
|
# creation. At least one field must be present to complete the digital wallet
|
|
626
642
|
# steps.
|
|
627
643
|
#
|
|
628
|
-
# @param digital_card_profile_id [String, nil]
|
|
644
|
+
# @param digital_card_profile_id [String, nil]
|
|
645
|
+
# The digital card profile assigned to this digital card. Card profiles may also
|
|
646
|
+
# be assigned at the program level.
|
|
629
647
|
#
|
|
630
|
-
# @param email [String, nil]
|
|
648
|
+
# @param email [String, nil]
|
|
649
|
+
# An email address that can be used to verify the cardholder via one-time passcode
|
|
650
|
+
# over email.
|
|
631
651
|
#
|
|
632
|
-
# @param phone [String, nil]
|
|
652
|
+
# @param phone [String, nil]
|
|
653
|
+
# A phone number that can be used to verify the cardholder via one-time passcode
|
|
654
|
+
# over SMS.
|
|
633
655
|
end
|
|
634
656
|
|
|
635
657
|
# This indicates if payments can be made with the card.
|
|
@@ -21,12 +21,11 @@ module Increase
|
|
|
21
21
|
optional :physical_card_id, String
|
|
22
22
|
|
|
23
23
|
# @!method initialize(card_id:, physical_card_id: nil, request_options: {})
|
|
24
|
-
# Some parameter documentations has been truncated, see
|
|
25
|
-
# {Increase::Models::CardCreateDetailsIframeParams} for more details.
|
|
26
|
-
#
|
|
27
24
|
# @param card_id [String] The identifier of the Card to create an iframe for.
|
|
28
25
|
#
|
|
29
|
-
# @param physical_card_id [String]
|
|
26
|
+
# @param physical_card_id [String]
|
|
27
|
+
# The identifier of the Physical Card to create an iframe for. This will inform
|
|
28
|
+
# the appearance of the card rendered in the iframe.
|
|
30
29
|
#
|
|
31
30
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
32
31
|
end
|
|
@@ -49,20 +49,25 @@ module Increase
|
|
|
49
49
|
optional :entity_id, String
|
|
50
50
|
|
|
51
51
|
# @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
|
|
52
|
-
# Some parameter documentations has been truncated, see
|
|
53
|
-
# {Increase::Models::CardCreateParams} for more details.
|
|
54
|
-
#
|
|
55
52
|
# @param account_id [String] The Account the card should belong to.
|
|
56
53
|
#
|
|
57
|
-
# @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
|
|
54
|
+
# @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
|
|
55
|
+
# Controls that restrict how this card can be used.
|
|
58
56
|
#
|
|
59
57
|
# @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
|
|
60
58
|
#
|
|
61
59
|
# @param description [String] The description you choose to give the card.
|
|
62
60
|
#
|
|
63
|
-
# @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
|
|
61
|
+
# @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
|
|
62
|
+
# The contact information used in the two-factor steps for digital wallet card
|
|
63
|
+
# creation. To add the card to a digital wallet, you may supply an email or phone
|
|
64
|
+
# number with this request. Otherwise, subscribe and then action a Real Time
|
|
65
|
+
# Decision with the category `digital_wallet_token_requested` or
|
|
66
|
+
# `digital_wallet_authentication_requested`.
|
|
64
67
|
#
|
|
65
|
-
# @param entity_id [String]
|
|
68
|
+
# @param entity_id [String]
|
|
69
|
+
# The Entity the card belongs to. You only need to supply this in rare situations
|
|
70
|
+
# when the card is not for the Account holder.
|
|
66
71
|
#
|
|
67
72
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
68
73
|
|
|
@@ -97,18 +102,22 @@ module Increase
|
|
|
97
102
|
optional :usage, -> { Increase::CardCreateParams::AuthorizationControls::Usage }
|
|
98
103
|
|
|
99
104
|
# @!method initialize(merchant_acceptor_identifier: nil, merchant_category_code: nil, merchant_country: nil, usage: nil)
|
|
100
|
-
# Some parameter documentations has been truncated, see
|
|
101
|
-
# {Increase::Models::CardCreateParams::AuthorizationControls} for more details.
|
|
102
|
-
#
|
|
103
105
|
# Controls that restrict how this card can be used.
|
|
104
106
|
#
|
|
105
|
-
# @param merchant_acceptor_identifier [Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier]
|
|
107
|
+
# @param merchant_acceptor_identifier [Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier]
|
|
108
|
+
# Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
|
|
109
|
+
# on this card.
|
|
106
110
|
#
|
|
107
|
-
# @param merchant_category_code [Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode]
|
|
111
|
+
# @param merchant_category_code [Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode]
|
|
112
|
+
# Restricts which Merchant Category Codes are allowed or blocked for
|
|
113
|
+
# authorizations on this card.
|
|
108
114
|
#
|
|
109
|
-
# @param merchant_country [Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry]
|
|
115
|
+
# @param merchant_country [Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry]
|
|
116
|
+
# Restricts which merchant countries are allowed or blocked for authorizations on
|
|
117
|
+
# this card.
|
|
110
118
|
#
|
|
111
|
-
# @param usage [Increase::Models::CardCreateParams::AuthorizationControls::Usage]
|
|
119
|
+
# @param usage [Increase::Models::CardCreateParams::AuthorizationControls::Usage]
|
|
120
|
+
# Controls how many times this card can be used.
|
|
112
121
|
|
|
113
122
|
# @see Increase::Models::CardCreateParams::AuthorizationControls#merchant_acceptor_identifier
|
|
114
123
|
class MerchantAcceptorIdentifier < Increase::Internal::Type::BaseModel
|
|
@@ -129,16 +138,16 @@ module Increase
|
|
|
129
138
|
-> { Increase::Internal::Type::ArrayOf[Increase::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier::Blocked] }
|
|
130
139
|
|
|
131
140
|
# @!method initialize(allowed: nil, blocked: nil)
|
|
132
|
-
# Some parameter documentations has been truncated, see
|
|
133
|
-
# {Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier}
|
|
134
|
-
# for more details.
|
|
135
|
-
#
|
|
136
141
|
# Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
|
|
137
142
|
# on this card.
|
|
138
143
|
#
|
|
139
|
-
# @param allowed [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>]
|
|
144
|
+
# @param allowed [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>]
|
|
145
|
+
# The Merchant Acceptor IDs that are allowed for authorizations on this card.
|
|
146
|
+
# Authorizations with Merchant Acceptor IDs not in this list will be declined.
|
|
140
147
|
#
|
|
141
|
-
# @param blocked [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>]
|
|
148
|
+
# @param blocked [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>]
|
|
149
|
+
# The Merchant Acceptor IDs that are blocked for authorizations on this card.
|
|
150
|
+
# Authorizations with Merchant Acceptor IDs in this list will be declined.
|
|
142
151
|
|
|
143
152
|
class Allowed < Increase::Internal::Type::BaseModel
|
|
144
153
|
# @!attribute identifier
|
|
@@ -182,16 +191,16 @@ module Increase
|
|
|
182
191
|
-> { Increase::Internal::Type::ArrayOf[Increase::CardCreateParams::AuthorizationControls::MerchantCategoryCode::Blocked] }
|
|
183
192
|
|
|
184
193
|
# @!method initialize(allowed: nil, blocked: nil)
|
|
185
|
-
# Some parameter documentations has been truncated, see
|
|
186
|
-
# {Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode}
|
|
187
|
-
# for more details.
|
|
188
|
-
#
|
|
189
194
|
# Restricts which Merchant Category Codes are allowed or blocked for
|
|
190
195
|
# authorizations on this card.
|
|
191
196
|
#
|
|
192
|
-
# @param allowed [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode::Allowed>]
|
|
197
|
+
# @param allowed [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode::Allowed>]
|
|
198
|
+
# The Merchant Category Codes that are allowed for authorizations on this card.
|
|
199
|
+
# Authorizations with Merchant Category Codes not in this list will be declined.
|
|
193
200
|
#
|
|
194
|
-
# @param blocked [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode::Blocked>]
|
|
201
|
+
# @param blocked [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCategoryCode::Blocked>]
|
|
202
|
+
# The Merchant Category Codes that are blocked for authorizations on this card.
|
|
203
|
+
# Authorizations with Merchant Category Codes in this list will be declined.
|
|
195
204
|
|
|
196
205
|
class Allowed < Increase::Internal::Type::BaseModel
|
|
197
206
|
# @!attribute code
|
|
@@ -235,16 +244,16 @@ module Increase
|
|
|
235
244
|
-> { Increase::Internal::Type::ArrayOf[Increase::CardCreateParams::AuthorizationControls::MerchantCountry::Blocked] }
|
|
236
245
|
|
|
237
246
|
# @!method initialize(allowed: nil, blocked: nil)
|
|
238
|
-
# Some parameter documentations has been truncated, see
|
|
239
|
-
# {Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry} for
|
|
240
|
-
# more details.
|
|
241
|
-
#
|
|
242
247
|
# Restricts which merchant countries are allowed or blocked for authorizations on
|
|
243
248
|
# this card.
|
|
244
249
|
#
|
|
245
|
-
# @param allowed [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry::Allowed>]
|
|
250
|
+
# @param allowed [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry::Allowed>]
|
|
251
|
+
# The merchant countries that are allowed for authorizations on this card.
|
|
252
|
+
# Authorizations with merchant countries not in this list will be declined.
|
|
246
253
|
#
|
|
247
|
-
# @param blocked [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry::Blocked>]
|
|
254
|
+
# @param blocked [Array<Increase::Models::CardCreateParams::AuthorizationControls::MerchantCountry::Blocked>]
|
|
255
|
+
# The merchant countries that are blocked for authorizations on this card.
|
|
256
|
+
# Authorizations with merchant countries in this list will be declined.
|
|
248
257
|
|
|
249
258
|
class Allowed < Increase::Internal::Type::BaseModel
|
|
250
259
|
# @!attribute country
|
|
@@ -291,17 +300,17 @@ module Increase
|
|
|
291
300
|
optional :single_use, -> { Increase::CardCreateParams::AuthorizationControls::Usage::SingleUse }
|
|
292
301
|
|
|
293
302
|
# @!method initialize(category:, multi_use: nil, single_use: nil)
|
|
294
|
-
# Some parameter documentations has been truncated, see
|
|
295
|
-
# {Increase::Models::CardCreateParams::AuthorizationControls::Usage} for more
|
|
296
|
-
# details.
|
|
297
|
-
#
|
|
298
303
|
# Controls how many times this card can be used.
|
|
299
304
|
#
|
|
300
|
-
# @param category [Symbol, Increase::Models::CardCreateParams::AuthorizationControls::Usage::Category]
|
|
305
|
+
# @param category [Symbol, Increase::Models::CardCreateParams::AuthorizationControls::Usage::Category]
|
|
306
|
+
# Whether the card is for a single use or multiple uses.
|
|
301
307
|
#
|
|
302
|
-
# @param multi_use [Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse]
|
|
308
|
+
# @param multi_use [Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse]
|
|
309
|
+
# Controls for multi-use cards. Required if and only if `category` is `multi_use`.
|
|
303
310
|
#
|
|
304
|
-
# @param single_use [Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse]
|
|
311
|
+
# @param single_use [Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse]
|
|
312
|
+
# Controls for single-use cards. Required if and only if `category` is
|
|
313
|
+
# `single_use`.
|
|
305
314
|
|
|
306
315
|
# Whether the card is for a single use or multiple uses.
|
|
307
316
|
#
|
|
@@ -330,13 +339,11 @@ module Increase
|
|
|
330
339
|
-> { Increase::Internal::Type::ArrayOf[Increase::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit] }
|
|
331
340
|
|
|
332
341
|
# @!method initialize(spending_limits: nil)
|
|
333
|
-
# Some parameter documentations has been truncated, see
|
|
334
|
-
# {Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse} for
|
|
335
|
-
# more details.
|
|
336
|
-
#
|
|
337
342
|
# Controls for multi-use cards. Required if and only if `category` is `multi_use`.
|
|
338
343
|
#
|
|
339
|
-
# @param spending_limits [Array<Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit>]
|
|
344
|
+
# @param spending_limits [Array<Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit>]
|
|
345
|
+
# Spending limits for this card. The most restrictive limit applies if multiple
|
|
346
|
+
# limits match.
|
|
340
347
|
|
|
341
348
|
class SpendingLimit < Increase::Internal::Type::BaseModel
|
|
342
349
|
# @!attribute interval
|
|
@@ -361,15 +368,14 @@ module Increase
|
|
|
361
368
|
-> { Increase::Internal::Type::ArrayOf[Increase::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode] }
|
|
362
369
|
|
|
363
370
|
# @!method initialize(interval:, settlement_amount:, merchant_category_codes: nil)
|
|
364
|
-
#
|
|
365
|
-
#
|
|
366
|
-
# for more details.
|
|
367
|
-
#
|
|
368
|
-
# @param interval [Symbol, Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval] The interval at which the spending limit is enforced.
|
|
371
|
+
# @param interval [Symbol, Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval]
|
|
372
|
+
# The interval at which the spending limit is enforced.
|
|
369
373
|
#
|
|
370
374
|
# @param settlement_amount [Integer] The maximum settlement amount permitted in the given interval.
|
|
371
375
|
#
|
|
372
|
-
# @param merchant_category_codes [Array<Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>]
|
|
376
|
+
# @param merchant_category_codes [Array<Increase::Models::CardCreateParams::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>]
|
|
377
|
+
# The Merchant Category Codes this spending limit applies to. If not set, the
|
|
378
|
+
# limit applies to all transactions.
|
|
373
379
|
|
|
374
380
|
# The interval at which the spending limit is enforced.
|
|
375
381
|
#
|
|
@@ -422,7 +428,8 @@ module Increase
|
|
|
422
428
|
# Controls for single-use cards. Required if and only if `category` is
|
|
423
429
|
# `single_use`.
|
|
424
430
|
#
|
|
425
|
-
# @param settlement_amount [Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount]
|
|
431
|
+
# @param settlement_amount [Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount]
|
|
432
|
+
# The settlement amount constraint for this single-use card.
|
|
426
433
|
|
|
427
434
|
# @see Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse#settlement_amount
|
|
428
435
|
class SettlementAmount < Increase::Internal::Type::BaseModel
|
|
@@ -442,7 +449,8 @@ module Increase
|
|
|
442
449
|
# @!method initialize(comparison:, value:)
|
|
443
450
|
# The settlement amount constraint for this single-use card.
|
|
444
451
|
#
|
|
445
|
-
# @param comparison [Symbol, Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison]
|
|
452
|
+
# @param comparison [Symbol, Increase::Models::CardCreateParams::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison]
|
|
453
|
+
# The operator used to compare the settlement amount.
|
|
446
454
|
#
|
|
447
455
|
# @param value [Integer] The settlement amount value.
|
|
448
456
|
|
|
@@ -533,9 +541,6 @@ module Increase
|
|
|
533
541
|
optional :phone, String
|
|
534
542
|
|
|
535
543
|
# @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil)
|
|
536
|
-
# Some parameter documentations has been truncated, see
|
|
537
|
-
# {Increase::Models::CardCreateParams::DigitalWallet} for more details.
|
|
538
|
-
#
|
|
539
544
|
# The contact information used in the two-factor steps for digital wallet card
|
|
540
545
|
# creation. To add the card to a digital wallet, you may supply an email or phone
|
|
541
546
|
# number with this request. Otherwise, subscribe and then action a Real Time
|
|
@@ -544,9 +549,13 @@ module Increase
|
|
|
544
549
|
#
|
|
545
550
|
# @param digital_card_profile_id [String] The digital card profile assigned to this digital card.
|
|
546
551
|
#
|
|
547
|
-
# @param email [String]
|
|
552
|
+
# @param email [String]
|
|
553
|
+
# An email address that can be used to contact and verify the cardholder via
|
|
554
|
+
# one-time passcode over email.
|
|
548
555
|
#
|
|
549
|
-
# @param phone [String]
|
|
556
|
+
# @param phone [String]
|
|
557
|
+
# A phone number that can be used to contact and verify the cardholder via
|
|
558
|
+
# one-time passcode over SMS.
|
|
550
559
|
end
|
|
551
560
|
end
|
|
552
561
|
end
|