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
|
@@ -23,26 +23,28 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::InboundWireTransferListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Inbound Wire Transfers
|
|
30
27
|
#
|
|
31
28
|
# @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, wire_drawdown_request_id: nil, request_options: {})
|
|
32
29
|
#
|
|
33
30
|
# @param account_id [String] Filter Inbound Wire Transfers to ones belonging to the specified Account.
|
|
34
31
|
#
|
|
35
|
-
# @param account_number_id [String]
|
|
32
|
+
# @param account_number_id [String]
|
|
33
|
+
# Filter Inbound Wire Transfers to ones belonging to the specified Account Number.
|
|
36
34
|
#
|
|
37
35
|
# @param created_at [Increase::Models::InboundWireTransferListParams::CreatedAt]
|
|
38
36
|
#
|
|
39
37
|
# @param cursor [String] Return the page of entries after this one.
|
|
40
38
|
#
|
|
41
|
-
# @param limit [Integer]
|
|
39
|
+
# @param limit [Integer]
|
|
40
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
41
|
+
# objects.
|
|
42
42
|
#
|
|
43
43
|
# @param status [Increase::Models::InboundWireTransferListParams::Status]
|
|
44
44
|
#
|
|
45
|
-
# @param wire_drawdown_request_id [String]
|
|
45
|
+
# @param wire_drawdown_request_id [String]
|
|
46
|
+
# Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown
|
|
47
|
+
# Request.
|
|
46
48
|
#
|
|
47
49
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
48
50
|
#
|
|
@@ -68,7 +70,8 @@ module Increase
|
|
|
68
70
|
#
|
|
69
71
|
# @param inbound_wire_transfer_id [String] The identifier of the Inbound Wire Transfer to reverse.
|
|
70
72
|
#
|
|
71
|
-
# @param reason [Symbol, Increase::Models::InboundWireTransferReverseParams::Reason]
|
|
73
|
+
# @param reason [Symbol, Increase::Models::InboundWireTransferReverseParams::Reason]
|
|
74
|
+
# Reason for the reversal.
|
|
72
75
|
#
|
|
73
76
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
77
|
#
|
|
@@ -31,7 +31,8 @@ module Increase
|
|
|
31
31
|
#
|
|
32
32
|
# @overload retrieve(intrafi_account_enrollment_id, request_options: {})
|
|
33
33
|
#
|
|
34
|
-
# @param intrafi_account_enrollment_id [String]
|
|
34
|
+
# @param intrafi_account_enrollment_id [String]
|
|
35
|
+
# The identifier of the IntraFi Account Enrollment to retrieve.
|
|
35
36
|
#
|
|
36
37
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
37
38
|
#
|
|
@@ -47,9 +48,6 @@ module Increase
|
|
|
47
48
|
)
|
|
48
49
|
end
|
|
49
50
|
|
|
50
|
-
# Some parameter documentations has been truncated, see
|
|
51
|
-
# {Increase::Models::IntrafiAccountEnrollmentListParams} for more details.
|
|
52
|
-
#
|
|
53
51
|
# List IntraFi Account Enrollments
|
|
54
52
|
#
|
|
55
53
|
# @overload list(account_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -58,9 +56,15 @@ module Increase
|
|
|
58
56
|
#
|
|
59
57
|
# @param cursor [String] Return the page of entries after this one.
|
|
60
58
|
#
|
|
61
|
-
# @param idempotency_key [String]
|
|
59
|
+
# @param idempotency_key [String]
|
|
60
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
61
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
62
|
+
# request is only processed once. Learn more about
|
|
63
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
62
64
|
#
|
|
63
|
-
# @param limit [Integer]
|
|
65
|
+
# @param limit [Integer]
|
|
66
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
67
|
+
# objects.
|
|
64
68
|
#
|
|
65
69
|
# @param status [Increase::Models::IntrafiAccountEnrollmentListParams::Status]
|
|
66
70
|
#
|
|
@@ -86,7 +90,8 @@ module Increase
|
|
|
86
90
|
#
|
|
87
91
|
# @overload unenroll(intrafi_account_enrollment_id, request_options: {})
|
|
88
92
|
#
|
|
89
|
-
# @param intrafi_account_enrollment_id [String]
|
|
93
|
+
# @param intrafi_account_enrollment_id [String]
|
|
94
|
+
# The Identifier of the IntraFi Account Enrollment to remove from IntraFi.
|
|
90
95
|
#
|
|
91
96
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
92
97
|
#
|
|
@@ -3,16 +3,17 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class IntrafiExclusions
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::IntrafiExclusionCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an IntraFi Exclusion
|
|
10
7
|
#
|
|
11
8
|
# @overload create(entity_id:, fdic_certificate_number:, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param entity_id [String] The identifier of the Entity whose deposits will be excluded.
|
|
14
11
|
#
|
|
15
|
-
# @param fdic_certificate_number [String]
|
|
12
|
+
# @param fdic_certificate_number [String]
|
|
13
|
+
# The FDIC certificate number of the financial institution to be excluded. An FDIC
|
|
14
|
+
# certificate number uniquely identifies a financial institution, and is different
|
|
15
|
+
# than a routing number. To find one, we recommend searching by Bank Name using
|
|
16
|
+
# the [FDIC's bankfind tool](https://banks.data.fdic.gov/bankfind-suite/bankfind).
|
|
16
17
|
#
|
|
17
18
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
18
19
|
#
|
|
@@ -50,9 +51,6 @@ module Increase
|
|
|
50
51
|
)
|
|
51
52
|
end
|
|
52
53
|
|
|
53
|
-
# Some parameter documentations has been truncated, see
|
|
54
|
-
# {Increase::Models::IntrafiExclusionListParams} for more details.
|
|
55
|
-
#
|
|
56
54
|
# List IntraFi Exclusions
|
|
57
55
|
#
|
|
58
56
|
# @overload list(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -61,9 +59,15 @@ module Increase
|
|
|
61
59
|
#
|
|
62
60
|
# @param entity_id [String] Filter IntraFi Exclusions for those belonging to the specified Entity.
|
|
63
61
|
#
|
|
64
|
-
# @param idempotency_key [String]
|
|
62
|
+
# @param idempotency_key [String]
|
|
63
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
64
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
65
|
+
# request is only processed once. Learn more about
|
|
66
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
65
67
|
#
|
|
66
|
-
# @param limit [Integer]
|
|
68
|
+
# @param limit [Integer]
|
|
69
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
70
|
+
# objects.
|
|
67
71
|
#
|
|
68
72
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
69
73
|
#
|
|
@@ -83,14 +87,14 @@ module Increase
|
|
|
83
87
|
)
|
|
84
88
|
end
|
|
85
89
|
|
|
86
|
-
# Some parameter documentations has been truncated, see
|
|
87
|
-
# {Increase::Models::IntrafiExclusionArchiveParams} for more details.
|
|
88
|
-
#
|
|
89
90
|
# Archive an IntraFi Exclusion
|
|
90
91
|
#
|
|
91
92
|
# @overload archive(intrafi_exclusion_id, request_options: {})
|
|
92
93
|
#
|
|
93
|
-
# @param intrafi_exclusion_id [String]
|
|
94
|
+
# @param intrafi_exclusion_id [String]
|
|
95
|
+
# The identifier of the IntraFi Exclusion request to archive. It may take 5
|
|
96
|
+
# business days for an exclusion removal to be processed. Removing an exclusion
|
|
97
|
+
# does not guarantee that funds will be swept to the previously-excluded bank.
|
|
94
98
|
#
|
|
95
99
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
96
100
|
#
|
|
@@ -56,7 +56,8 @@ module Increase
|
|
|
56
56
|
#
|
|
57
57
|
# @param description [String] The description you choose for the Lockbox Address.
|
|
58
58
|
#
|
|
59
|
-
# @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status]
|
|
59
|
+
# @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status]
|
|
60
|
+
# The status of the Lockbox Address.
|
|
60
61
|
#
|
|
61
62
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
62
63
|
#
|
|
@@ -74,9 +75,6 @@ module Increase
|
|
|
74
75
|
)
|
|
75
76
|
end
|
|
76
77
|
|
|
77
|
-
# Some parameter documentations has been truncated, see
|
|
78
|
-
# {Increase::Models::LockboxAddressListParams} for more details.
|
|
79
|
-
#
|
|
80
78
|
# List Lockbox Addresses
|
|
81
79
|
#
|
|
82
80
|
# @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -85,9 +83,15 @@ module Increase
|
|
|
85
83
|
#
|
|
86
84
|
# @param cursor [String] Return the page of entries after this one.
|
|
87
85
|
#
|
|
88
|
-
# @param idempotency_key [String]
|
|
86
|
+
# @param idempotency_key [String]
|
|
87
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
88
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
89
|
+
# request is only processed once. Learn more about
|
|
90
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
89
91
|
#
|
|
90
|
-
# @param limit [Integer]
|
|
92
|
+
# @param limit [Integer]
|
|
93
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
94
|
+
# objects.
|
|
91
95
|
#
|
|
92
96
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
93
97
|
#
|
|
@@ -3,16 +3,16 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class LockboxRecipients
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::LockboxRecipientCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Lockbox Recipient
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, lockbox_address_id:, description: nil, recipient_name: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param account_id [String]
|
|
10
|
+
# @param account_id [String]
|
|
11
|
+
# The Account that checks sent to this Lockbox Recipient should be deposited into.
|
|
14
12
|
#
|
|
15
|
-
# @param lockbox_address_id [String]
|
|
13
|
+
# @param lockbox_address_id [String]
|
|
14
|
+
# The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
|
|
15
|
+
# Address must have a `status` of `active`.
|
|
16
16
|
#
|
|
17
17
|
# @param description [String] The description you choose for the Lockbox Recipient.
|
|
18
18
|
#
|
|
@@ -64,7 +64,8 @@ module Increase
|
|
|
64
64
|
#
|
|
65
65
|
# @param recipient_name [String] The name of the Lockbox Recipient.
|
|
66
66
|
#
|
|
67
|
-
# @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status]
|
|
67
|
+
# @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status]
|
|
68
|
+
# The status of the Lockbox Recipient.
|
|
68
69
|
#
|
|
69
70
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
70
71
|
#
|
|
@@ -82,9 +83,6 @@ module Increase
|
|
|
82
83
|
)
|
|
83
84
|
end
|
|
84
85
|
|
|
85
|
-
# Some parameter documentations has been truncated, see
|
|
86
|
-
# {Increase::Models::LockboxRecipientListParams} for more details.
|
|
87
|
-
#
|
|
88
86
|
# List Lockbox Recipients
|
|
89
87
|
#
|
|
90
88
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, lockbox_address_id: nil, request_options: {})
|
|
@@ -95,11 +93,18 @@ module Increase
|
|
|
95
93
|
#
|
|
96
94
|
# @param cursor [String] Return the page of entries after this one.
|
|
97
95
|
#
|
|
98
|
-
# @param idempotency_key [String]
|
|
96
|
+
# @param idempotency_key [String]
|
|
97
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
98
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
99
|
+
# request is only processed once. Learn more about
|
|
100
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
99
101
|
#
|
|
100
|
-
# @param limit [Integer]
|
|
102
|
+
# @param limit [Integer]
|
|
103
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
104
|
+
# objects.
|
|
101
105
|
#
|
|
102
|
-
# @param lockbox_address_id [String]
|
|
106
|
+
# @param lockbox_address_id [String]
|
|
107
|
+
# Filter Lockbox Recipients to those associated with the provided Lockbox Address.
|
|
103
108
|
#
|
|
104
109
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
105
110
|
#
|
|
@@ -23,9 +23,6 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::OAuthApplicationListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List OAuth Applications
|
|
30
27
|
#
|
|
31
28
|
# @overload list(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -34,7 +31,9 @@ module Increase
|
|
|
34
31
|
#
|
|
35
32
|
# @param cursor [String] Return the page of entries after this one.
|
|
36
33
|
#
|
|
37
|
-
# @param limit [Integer]
|
|
34
|
+
# @param limit [Integer]
|
|
35
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
36
|
+
# objects.
|
|
38
37
|
#
|
|
39
38
|
# @param status [Increase::Models::OAuthApplicationListParams::Status]
|
|
40
39
|
#
|
|
@@ -23,18 +23,19 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::OAuthConnectionListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List OAuth Connections
|
|
30
27
|
#
|
|
31
28
|
# @overload list(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {})
|
|
32
29
|
#
|
|
33
30
|
# @param cursor [String] Return the page of entries after this one.
|
|
34
31
|
#
|
|
35
|
-
# @param limit [Integer]
|
|
32
|
+
# @param limit [Integer]
|
|
33
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
34
|
+
# objects.
|
|
36
35
|
#
|
|
37
|
-
# @param oauth_application_id [String]
|
|
36
|
+
# @param oauth_application_id [String]
|
|
37
|
+
# Filter results to only include OAuth Connections for a specific OAuth
|
|
38
|
+
# Application.
|
|
38
39
|
#
|
|
39
40
|
# @param status [Increase::Models::OAuthConnectionListParams::Status]
|
|
40
41
|
#
|
|
@@ -3,22 +3,29 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class OAuthTokens
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::OAuthTokenCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an OAuth Token
|
|
10
7
|
#
|
|
11
8
|
# @overload create(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
|
|
10
|
+
# @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
|
|
11
|
+
# The credential you request in exchange for the code. In Production, this is
|
|
12
|
+
# always `authorization_code`. In Sandbox, you can pass either enum value.
|
|
14
13
|
#
|
|
15
14
|
# @param client_id [String] The public identifier for your application.
|
|
16
15
|
#
|
|
17
|
-
# @param client_secret [String]
|
|
16
|
+
# @param client_secret [String]
|
|
17
|
+
# The secret that confirms you own the application. This is redundant given that
|
|
18
|
+
# the request is made with your API key but it's a required component of OAuth
|
|
19
|
+
# 2.0.
|
|
18
20
|
#
|
|
19
|
-
# @param code [String]
|
|
21
|
+
# @param code [String]
|
|
22
|
+
# The authorization code generated by the user and given to you as a query
|
|
23
|
+
# parameter.
|
|
20
24
|
#
|
|
21
|
-
# @param production_token [String]
|
|
25
|
+
# @param production_token [String]
|
|
26
|
+
# The production token you want to exchange for a sandbox token. This is only
|
|
27
|
+
# available in Sandbox. Set `grant_type` to `production_token` to use this
|
|
28
|
+
# parameter.
|
|
22
29
|
#
|
|
23
30
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
31
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class PendingTransactions
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::PendingTransactionCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Creates a pending transaction on an account. This can be useful to hold funds
|
|
10
7
|
# for an external payment or known future transaction outside of Increase (only
|
|
11
8
|
# negative amounts are supported). The resulting Pending Transaction will have a
|
|
@@ -16,7 +13,10 @@ module Increase
|
|
|
16
13
|
#
|
|
17
14
|
# @param account_id [String] The Account to place the hold on.
|
|
18
15
|
#
|
|
19
|
-
# @param amount [Integer]
|
|
16
|
+
# @param amount [Integer]
|
|
17
|
+
# The amount to hold in the minor unit of the account's currency. For dollars, for
|
|
18
|
+
# example, this is cents. This should be a negative amount: To hold $1.00 from the
|
|
19
|
+
# account, pass -100 as `amount`.
|
|
20
20
|
#
|
|
21
21
|
# @param description [String] The description you choose to give the hold.
|
|
22
22
|
#
|
|
@@ -56,9 +56,6 @@ module Increase
|
|
|
56
56
|
)
|
|
57
57
|
end
|
|
58
58
|
|
|
59
|
-
# Some parameter documentations has been truncated, see
|
|
60
|
-
# {Increase::Models::PendingTransactionListParams} for more details.
|
|
61
|
-
#
|
|
62
59
|
# List Pending Transactions
|
|
63
60
|
#
|
|
64
61
|
# @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, status: nil, request_options: {})
|
|
@@ -71,7 +68,9 @@ module Increase
|
|
|
71
68
|
#
|
|
72
69
|
# @param cursor [String] Return the page of entries after this one.
|
|
73
70
|
#
|
|
74
|
-
# @param limit [Integer]
|
|
71
|
+
# @param limit [Integer]
|
|
72
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
73
|
+
# objects.
|
|
75
74
|
#
|
|
76
75
|
# @param route_id [String] Filter pending transactions to those belonging to the specified Route.
|
|
77
76
|
#
|
|
@@ -3,14 +3,12 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class PhysicalCardProfiles
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::PhysicalCardProfileCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Physical Card Profile
|
|
10
7
|
#
|
|
11
8
|
# @overload create(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, front_text: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param carrier_image_file_id [String]
|
|
10
|
+
# @param carrier_image_file_id [String]
|
|
11
|
+
# The identifier of the File containing the physical card's carrier image.
|
|
14
12
|
#
|
|
15
13
|
# @param contact_phone [String] A phone number the user can contact to receive support for their card.
|
|
16
14
|
#
|
|
@@ -20,7 +18,9 @@ module Increase
|
|
|
20
18
|
#
|
|
21
19
|
# @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
|
|
22
20
|
#
|
|
23
|
-
# @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText]
|
|
21
|
+
# @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText]
|
|
22
|
+
# Text printed on the front of the card. Reach out to
|
|
23
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
24
24
|
#
|
|
25
25
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
26
|
#
|
|
@@ -58,18 +58,21 @@ module Increase
|
|
|
58
58
|
)
|
|
59
59
|
end
|
|
60
60
|
|
|
61
|
-
# Some parameter documentations has been truncated, see
|
|
62
|
-
# {Increase::Models::PhysicalCardProfileListParams} for more details.
|
|
63
|
-
#
|
|
64
61
|
# List Physical Card Profiles
|
|
65
62
|
#
|
|
66
63
|
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
67
64
|
#
|
|
68
65
|
# @param cursor [String] Return the page of entries after this one.
|
|
69
66
|
#
|
|
70
|
-
# @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).
|
|
71
72
|
#
|
|
72
|
-
# @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.
|
|
73
76
|
#
|
|
74
77
|
# @param status [Increase::Models::PhysicalCardProfileListParams::Status]
|
|
75
78
|
#
|
|
@@ -111,16 +114,14 @@ module Increase
|
|
|
111
114
|
)
|
|
112
115
|
end
|
|
113
116
|
|
|
114
|
-
# Some parameter documentations has been truncated, see
|
|
115
|
-
# {Increase::Models::PhysicalCardProfileCloneParams} for more details.
|
|
116
|
-
#
|
|
117
117
|
# Clone a Physical Card Profile
|
|
118
118
|
#
|
|
119
119
|
# @overload clone_(physical_card_profile_id, carrier_image_file_id: nil, contact_phone: nil, description: nil, front_image_file_id: nil, front_text: nil, program_id: nil, request_options: {})
|
|
120
120
|
#
|
|
121
121
|
# @param physical_card_profile_id [String] The identifier of the Physical Card Profile to clone.
|
|
122
122
|
#
|
|
123
|
-
# @param carrier_image_file_id [String]
|
|
123
|
+
# @param carrier_image_file_id [String]
|
|
124
|
+
# The identifier of the File containing the physical card's carrier image.
|
|
124
125
|
#
|
|
125
126
|
# @param contact_phone [String] A phone number the user can contact to receive support for their card.
|
|
126
127
|
#
|
|
@@ -128,7 +129,9 @@ module Increase
|
|
|
128
129
|
#
|
|
129
130
|
# @param front_image_file_id [String] The identifier of the File containing the physical card's front image.
|
|
130
131
|
#
|
|
131
|
-
# @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText]
|
|
132
|
+
# @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText]
|
|
133
|
+
# Text printed on the front of the card. Reach out to
|
|
134
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
132
135
|
#
|
|
133
136
|
# @param program_id [String] The identifier of the Program to use for the cloned Physical Card Profile.
|
|
134
137
|
#
|
|
@@ -3,20 +3,21 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class PhysicalCards
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::PhysicalCardCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Physical Card
|
|
10
7
|
#
|
|
11
8
|
# @overload create(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param card_id [String] The underlying card representing this physical card.
|
|
14
11
|
#
|
|
15
|
-
# @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
|
|
12
|
+
# @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
|
|
13
|
+
# Details about the cardholder, as it will appear on the physical card.
|
|
16
14
|
#
|
|
17
|
-
# @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
|
|
15
|
+
# @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
|
|
16
|
+
# The details used to ship this physical card.
|
|
18
17
|
#
|
|
19
|
-
# @param physical_card_profile_id [String]
|
|
18
|
+
# @param physical_card_profile_id [String]
|
|
19
|
+
# The physical card profile to use for this physical card. The latest default
|
|
20
|
+
# physical card profile will be used if not provided.
|
|
20
21
|
#
|
|
21
22
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
23
|
#
|
|
@@ -60,7 +61,8 @@ module Increase
|
|
|
60
61
|
#
|
|
61
62
|
# @param physical_card_id [String] The Physical Card identifier.
|
|
62
63
|
#
|
|
63
|
-
# @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
|
|
64
|
+
# @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
|
|
65
|
+
# The status to update the Physical Card to.
|
|
64
66
|
#
|
|
65
67
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
66
68
|
#
|
|
@@ -78,9 +80,6 @@ module Increase
|
|
|
78
80
|
)
|
|
79
81
|
end
|
|
80
82
|
|
|
81
|
-
# Some parameter documentations has been truncated, see
|
|
82
|
-
# {Increase::Models::PhysicalCardListParams} for more details.
|
|
83
|
-
#
|
|
84
83
|
# List Physical Cards
|
|
85
84
|
#
|
|
86
85
|
# @overload list(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -91,9 +90,15 @@ module Increase
|
|
|
91
90
|
#
|
|
92
91
|
# @param cursor [String] Return the page of entries after this one.
|
|
93
92
|
#
|
|
94
|
-
# @param idempotency_key [String]
|
|
93
|
+
# @param idempotency_key [String]
|
|
94
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
95
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
96
|
+
# request is only processed once. Learn more about
|
|
97
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
95
98
|
#
|
|
96
|
-
# @param limit [Integer]
|
|
99
|
+
# @param limit [Integer]
|
|
100
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
101
|
+
# objects.
|
|
97
102
|
#
|
|
98
103
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
99
104
|
#
|
|
@@ -23,16 +23,15 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::ProgramListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Programs
|
|
30
27
|
#
|
|
31
28
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
|
32
29
|
#
|
|
33
30
|
# @param cursor [String] Return the page of entries after this one.
|
|
34
31
|
#
|
|
35
|
-
# @param limit [Integer]
|
|
32
|
+
# @param limit [Integer]
|
|
33
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
34
|
+
# objects.
|
|
36
35
|
#
|
|
37
36
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
38
37
|
#
|
|
@@ -23,26 +23,35 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::RealTimeDecisionActionParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# Action a Real-Time Decision
|
|
30
27
|
#
|
|
31
28
|
# @overload action(real_time_decision_id, card_authentication: nil, card_authentication_challenge: nil, card_authorization: nil, card_balance_inquiry: nil, digital_wallet_authentication: nil, digital_wallet_token: nil, request_options: {})
|
|
32
29
|
#
|
|
33
30
|
# @param real_time_decision_id [String] The identifier of the Real-Time Decision.
|
|
34
31
|
#
|
|
35
|
-
# @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication]
|
|
32
|
+
# @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication]
|
|
33
|
+
# If the Real-Time Decision relates to a 3DS card authentication attempt, this
|
|
34
|
+
# object contains your response to the authentication.
|
|
36
35
|
#
|
|
37
|
-
# @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge]
|
|
36
|
+
# @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge]
|
|
37
|
+
# If the Real-Time Decision relates to 3DS card authentication challenge delivery,
|
|
38
|
+
# this object contains your response.
|
|
38
39
|
#
|
|
39
|
-
# @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization]
|
|
40
|
+
# @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization]
|
|
41
|
+
# If the Real-Time Decision relates to a card authorization attempt, this object
|
|
42
|
+
# contains your response to the authorization.
|
|
40
43
|
#
|
|
41
|
-
# @param card_balance_inquiry [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry]
|
|
44
|
+
# @param card_balance_inquiry [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry]
|
|
45
|
+
# If the Real-Time Decision relates to a card balance inquiry attempt, this object
|
|
46
|
+
# contains your response to the inquiry.
|
|
42
47
|
#
|
|
43
|
-
# @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication]
|
|
48
|
+
# @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication]
|
|
49
|
+
# If the Real-Time Decision relates to a digital wallet authentication attempt,
|
|
50
|
+
# this object contains your response to the authentication.
|
|
44
51
|
#
|
|
45
|
-
# @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken]
|
|
52
|
+
# @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken]
|
|
53
|
+
# If the Real-Time Decision relates to a digital wallet token provisioning
|
|
54
|
+
# attempt, this object contains your response to the attempt.
|
|
46
55
|
#
|
|
47
56
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
48
57
|
#
|