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
|
@@ -15,8 +15,8 @@ module Increase
|
|
|
15
15
|
|
|
16
16
|
# @!attribute amount
|
|
17
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
|
|
19
|
-
#
|
|
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
|
# @return [Integer]
|
|
22
22
|
required :amount, Integer
|
|
@@ -28,12 +28,12 @@ module Increase
|
|
|
28
28
|
optional :description, String
|
|
29
29
|
|
|
30
30
|
# @!method initialize(account_id:, amount:, description: nil, request_options: {})
|
|
31
|
-
# Some parameter documentations has been truncated, see
|
|
32
|
-
# {Increase::Models::PendingTransactionCreateParams} for more details.
|
|
33
|
-
#
|
|
34
31
|
# @param account_id [String] The Account to place the hold on.
|
|
35
32
|
#
|
|
36
|
-
# @param amount [Integer]
|
|
33
|
+
# @param amount [Integer]
|
|
34
|
+
# The amount to hold in the minor unit of the account's currency. For dollars, for
|
|
35
|
+
# example, this is cents. This should be a negative amount: To hold $1.00 from the
|
|
36
|
+
# account, pass -100 as `amount`.
|
|
37
37
|
#
|
|
38
38
|
# @param description [String] The description you choose to give the hold.
|
|
39
39
|
#
|
|
@@ -48,9 +48,6 @@ module Increase
|
|
|
48
48
|
optional :status, -> { Increase::PendingTransactionListParams::Status }
|
|
49
49
|
|
|
50
50
|
# @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, status: nil, request_options: {})
|
|
51
|
-
# Some parameter documentations has been truncated, see
|
|
52
|
-
# {Increase::Models::PendingTransactionListParams} for more details.
|
|
53
|
-
#
|
|
54
51
|
# @param account_id [String] Filter pending transactions to those belonging to the specified Account.
|
|
55
52
|
#
|
|
56
53
|
# @param category [Increase::Models::PendingTransactionListParams::Category]
|
|
@@ -59,7 +56,9 @@ module Increase
|
|
|
59
56
|
#
|
|
60
57
|
# @param cursor [String] Return the page of entries after this one.
|
|
61
58
|
#
|
|
62
|
-
# @param limit [Integer]
|
|
59
|
+
# @param limit [Integer]
|
|
60
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
61
|
+
# objects.
|
|
63
62
|
#
|
|
64
63
|
# @param route_id [String] Filter pending transactions to those belonging to the specified Route.
|
|
65
64
|
#
|
|
@@ -80,10 +79,9 @@ module Increase
|
|
|
80
79
|
api_name: :in
|
|
81
80
|
|
|
82
81
|
# @!method initialize(in_: nil)
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
# @param in_ [Array<Symbol, Increase::Models::PendingTransactionListParams::Category::In>] Return results whose value is in the provided list. For GET requests, this shoul
|
|
82
|
+
# @param in_ [Array<Symbol, Increase::Models::PendingTransactionListParams::Category::In>]
|
|
83
|
+
# Return results whose value is in the provided list. For GET requests, this
|
|
84
|
+
# should be encoded as a comma-delimited string, such as `?in=one,two,three`.
|
|
87
85
|
|
|
88
86
|
module In
|
|
89
87
|
extend Increase::Internal::Type::Enum
|
|
@@ -171,16 +169,21 @@ module Increase
|
|
|
171
169
|
optional :on_or_before, Time
|
|
172
170
|
|
|
173
171
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
174
|
-
#
|
|
175
|
-
#
|
|
172
|
+
# @param after [Time]
|
|
173
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
174
|
+
# timestamp.
|
|
176
175
|
#
|
|
177
|
-
# @param
|
|
176
|
+
# @param before [Time]
|
|
177
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
178
|
+
# timestamp.
|
|
178
179
|
#
|
|
179
|
-
# @param
|
|
180
|
+
# @param on_or_after [Time]
|
|
181
|
+
# Return results on or after this
|
|
182
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
180
183
|
#
|
|
181
|
-
# @param
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
+
# @param on_or_before [Time]
|
|
185
|
+
# Return results on or before this
|
|
186
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
184
187
|
end
|
|
185
188
|
|
|
186
189
|
class Status < Increase::Internal::Type::BaseModel
|
|
@@ -198,10 +201,11 @@ module Increase
|
|
|
198
201
|
api_name: :in
|
|
199
202
|
|
|
200
203
|
# @!method initialize(in_: nil)
|
|
201
|
-
#
|
|
202
|
-
#
|
|
203
|
-
#
|
|
204
|
-
#
|
|
204
|
+
# @param in_ [Array<Symbol, Increase::Models::PendingTransactionListParams::Status::In>]
|
|
205
|
+
# Filter Pending Transactions for those with the specified status. By default only
|
|
206
|
+
# Pending Transactions in with status `pending` will be returned. For GET
|
|
207
|
+
# requests, this should be encoded as a comma-delimited string, such as
|
|
208
|
+
# `?in=one,two,three`.
|
|
205
209
|
|
|
206
210
|
module In
|
|
207
211
|
extend Increase::Internal::Type::Enum
|
|
@@ -63,9 +63,6 @@ module Increase
|
|
|
63
63
|
required :type, enum: -> { Increase::PhysicalCard::Type }
|
|
64
64
|
|
|
65
65
|
# @!method initialize(id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
|
|
66
|
-
# Some parameter documentations has been truncated, see
|
|
67
|
-
# {Increase::Models::PhysicalCard} for more details.
|
|
68
|
-
#
|
|
69
66
|
# Custom physical Visa cards that are shipped to your customers. The artwork is
|
|
70
67
|
# configurable by a connected [Card Profile](/documentation/api#card-profiles).
|
|
71
68
|
# The same Card can be used for multiple Physical Cards. Printing cards incurs a
|
|
@@ -76,11 +73,17 @@ module Increase
|
|
|
76
73
|
#
|
|
77
74
|
# @param card_id [String] The identifier for the Card this Physical Card represents.
|
|
78
75
|
#
|
|
79
|
-
# @param cardholder [Increase::Models::PhysicalCard::Cardholder]
|
|
76
|
+
# @param cardholder [Increase::Models::PhysicalCard::Cardholder]
|
|
77
|
+
# Details about the cardholder, as it appears on the printed card.
|
|
80
78
|
#
|
|
81
|
-
# @param created_at [Time]
|
|
79
|
+
# @param created_at [Time]
|
|
80
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
81
|
+
# the Physical Card was created.
|
|
82
82
|
#
|
|
83
|
-
# @param idempotency_key [String, nil]
|
|
83
|
+
# @param idempotency_key [String, nil]
|
|
84
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
85
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
86
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
84
87
|
#
|
|
85
88
|
# @param physical_card_profile_id [String, nil] The Physical Card Profile used for this Physical Card.
|
|
86
89
|
#
|
|
@@ -88,7 +91,9 @@ module Increase
|
|
|
88
91
|
#
|
|
89
92
|
# @param status [Symbol, Increase::Models::PhysicalCard::Status] The status of the Physical Card.
|
|
90
93
|
#
|
|
91
|
-
# @param type [Symbol, Increase::Models::PhysicalCard::Type]
|
|
94
|
+
# @param type [Symbol, Increase::Models::PhysicalCard::Type]
|
|
95
|
+
# A constant representing the object's type. For this resource it will always be
|
|
96
|
+
# `physical_card`.
|
|
92
97
|
|
|
93
98
|
# @see Increase::Models::PhysicalCard#cardholder
|
|
94
99
|
class Cardholder < Increase::Internal::Type::BaseModel
|
|
@@ -149,20 +154,24 @@ module Increase
|
|
|
149
154
|
required :tracking, -> { Increase::PhysicalCard::Shipment::Tracking }, nil?: true
|
|
150
155
|
|
|
151
156
|
# @!method initialize(address:, method_:, schedule:, status:, tracking:)
|
|
152
|
-
# Some parameter documentations has been truncated, see
|
|
153
|
-
# {Increase::Models::PhysicalCard::Shipment} for more details.
|
|
154
|
-
#
|
|
155
157
|
# The details used to ship this physical card.
|
|
156
158
|
#
|
|
157
|
-
# @param address [Increase::Models::PhysicalCard::Shipment::Address]
|
|
159
|
+
# @param address [Increase::Models::PhysicalCard::Shipment::Address]
|
|
160
|
+
# The location to where the card's packing label is addressed.
|
|
158
161
|
#
|
|
159
162
|
# @param method_ [Symbol, Increase::Models::PhysicalCard::Shipment::Method] The shipping method.
|
|
160
163
|
#
|
|
161
|
-
# @param schedule [Symbol, Increase::Models::PhysicalCard::Shipment::Schedule]
|
|
164
|
+
# @param schedule [Symbol, Increase::Models::PhysicalCard::Shipment::Schedule]
|
|
165
|
+
# When this physical card should be produced by the card printer. The default
|
|
166
|
+
# timeline is the day after the card printer receives the order, except for
|
|
167
|
+
# `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster
|
|
168
|
+
# production methods, please reach out to
|
|
169
|
+
# [support@increase.com](mailto:support@increase.com).
|
|
162
170
|
#
|
|
163
171
|
# @param status [Symbol, Increase::Models::PhysicalCard::Shipment::Status] The status of this shipment.
|
|
164
172
|
#
|
|
165
|
-
# @param tracking [Increase::Models::PhysicalCard::Shipment::Tracking, nil]
|
|
173
|
+
# @param tracking [Increase::Models::PhysicalCard::Shipment::Tracking, nil]
|
|
174
|
+
# Tracking details for the shipment.
|
|
166
175
|
|
|
167
176
|
# @see Increase::Models::PhysicalCard::Shipment#address
|
|
168
177
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -346,9 +355,6 @@ module Increase
|
|
|
346
355
|
-> { Increase::Internal::Type::ArrayOf[Increase::PhysicalCard::Shipment::Tracking::Update] }
|
|
347
356
|
|
|
348
357
|
# @!method initialize(number:, return_number:, return_reason:, shipped_at:, updates:)
|
|
349
|
-
# Some parameter documentations has been truncated, see
|
|
350
|
-
# {Increase::Models::PhysicalCard::Shipment::Tracking} for more details.
|
|
351
|
-
#
|
|
352
358
|
# Tracking details for the shipment.
|
|
353
359
|
#
|
|
354
360
|
# @param number [String, nil] The tracking number. Not available for USPS shipments.
|
|
@@ -357,9 +363,13 @@ module Increase
|
|
|
357
363
|
#
|
|
358
364
|
# @param return_reason [String, nil] For returned shipments, this describes why the package was returned.
|
|
359
365
|
#
|
|
360
|
-
# @param shipped_at [Time]
|
|
366
|
+
# @param shipped_at [Time]
|
|
367
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
368
|
+
# the fulfillment provider marked the card as ready for pick-up by the shipment
|
|
369
|
+
# carrier.
|
|
361
370
|
#
|
|
362
|
-
# @param updates [Array<Increase::Models::PhysicalCard::Shipment::Tracking::Update>]
|
|
371
|
+
# @param updates [Array<Increase::Models::PhysicalCard::Shipment::Tracking::Update>]
|
|
372
|
+
# Tracking updates relating to the physical card's delivery.
|
|
363
373
|
|
|
364
374
|
class Update < Increase::Internal::Type::BaseModel
|
|
365
375
|
# @!attribute carrier_estimated_delivery_at
|
|
@@ -401,16 +411,18 @@ module Increase
|
|
|
401
411
|
required :state, String, nil?: true
|
|
402
412
|
|
|
403
413
|
# @!method initialize(carrier_estimated_delivery_at:, category:, city:, created_at:, postal_code:, state:)
|
|
404
|
-
#
|
|
405
|
-
#
|
|
406
|
-
#
|
|
407
|
-
# @param carrier_estimated_delivery_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
|
|
414
|
+
# @param carrier_estimated_delivery_at [Time, nil]
|
|
415
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
|
|
416
|
+
# carrier expects the card to be delivered.
|
|
408
417
|
#
|
|
409
|
-
# @param category [Symbol, Increase::Models::PhysicalCard::Shipment::Tracking::Update::Category]
|
|
418
|
+
# @param category [Symbol, Increase::Models::PhysicalCard::Shipment::Tracking::Update::Category]
|
|
419
|
+
# The type of tracking event.
|
|
410
420
|
#
|
|
411
421
|
# @param city [String, nil] The city where the event took place.
|
|
412
422
|
#
|
|
413
|
-
# @param created_at [Time]
|
|
423
|
+
# @param created_at [Time]
|
|
424
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
425
|
+
# the tracking event took place.
|
|
414
426
|
#
|
|
415
427
|
# @param postal_code [String, nil] The postal code where the event took place.
|
|
416
428
|
#
|
|
@@ -33,16 +33,17 @@ module Increase
|
|
|
33
33
|
optional :physical_card_profile_id, String
|
|
34
34
|
|
|
35
35
|
# @!method initialize(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {})
|
|
36
|
-
# Some parameter documentations has been truncated, see
|
|
37
|
-
# {Increase::Models::PhysicalCardCreateParams} for more details.
|
|
38
|
-
#
|
|
39
36
|
# @param card_id [String] The underlying card representing this physical card.
|
|
40
37
|
#
|
|
41
|
-
# @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
|
|
38
|
+
# @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
|
|
39
|
+
# Details about the cardholder, as it will appear on the physical card.
|
|
42
40
|
#
|
|
43
|
-
# @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
|
|
41
|
+
# @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
|
|
42
|
+
# The details used to ship this physical card.
|
|
44
43
|
#
|
|
45
|
-
# @param physical_card_profile_id [String]
|
|
44
|
+
# @param physical_card_profile_id [String]
|
|
45
|
+
# The physical card profile to use for this physical card. The latest default
|
|
46
|
+
# physical card profile will be used if not provided.
|
|
46
47
|
#
|
|
47
48
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
48
49
|
|
|
@@ -95,16 +96,20 @@ module Increase
|
|
|
95
96
|
optional :schedule, enum: -> { Increase::PhysicalCardCreateParams::Shipment::Schedule }
|
|
96
97
|
|
|
97
98
|
# @!method initialize(address:, method_:, schedule: nil)
|
|
98
|
-
# Some parameter documentations has been truncated, see
|
|
99
|
-
# {Increase::Models::PhysicalCardCreateParams::Shipment} for more details.
|
|
100
|
-
#
|
|
101
99
|
# The details used to ship this physical card.
|
|
102
100
|
#
|
|
103
|
-
# @param address [Increase::Models::PhysicalCardCreateParams::Shipment::Address]
|
|
101
|
+
# @param address [Increase::Models::PhysicalCardCreateParams::Shipment::Address]
|
|
102
|
+
# The address to where the card should be shipped.
|
|
104
103
|
#
|
|
105
|
-
# @param method_ [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method]
|
|
104
|
+
# @param method_ [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method]
|
|
105
|
+
# The shipping method to use.
|
|
106
106
|
#
|
|
107
|
-
# @param schedule [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Schedule]
|
|
107
|
+
# @param schedule [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Schedule]
|
|
108
|
+
# When this physical card should be produced by the card printer. The default
|
|
109
|
+
# timeline is the day after the card printer receives the order, except for
|
|
110
|
+
# `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster
|
|
111
|
+
# production methods, please reach out to
|
|
112
|
+
# [support@increase.com](mailto:support@increase.com).
|
|
108
113
|
|
|
109
114
|
# @see Increase::Models::PhysicalCardCreateParams::Shipment#address
|
|
110
115
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -166,10 +171,6 @@ module Increase
|
|
|
166
171
|
optional :phone_number, String
|
|
167
172
|
|
|
168
173
|
# @!method initialize(city:, line1:, name:, postal_code:, state:, country: nil, line2: nil, line3: nil, phone_number: nil)
|
|
169
|
-
# Some parameter documentations has been truncated, see
|
|
170
|
-
# {Increase::Models::PhysicalCardCreateParams::Shipment::Address} for more
|
|
171
|
-
# details.
|
|
172
|
-
#
|
|
173
174
|
# The address to where the card should be shipped.
|
|
174
175
|
#
|
|
175
176
|
# @param city [String] The city of the shipping address.
|
|
@@ -182,7 +183,11 @@ module Increase
|
|
|
182
183
|
#
|
|
183
184
|
# @param state [String] The state of the shipping address.
|
|
184
185
|
#
|
|
185
|
-
# @param country [String]
|
|
186
|
+
# @param country [String]
|
|
187
|
+
# The two-character ISO 3166-1 code of the country where the card should be
|
|
188
|
+
# shipped (e.g., `US`). Please reach out to
|
|
189
|
+
# [support@increase.com](mailto:support@increase.com) to ship cards
|
|
190
|
+
# internationally.
|
|
186
191
|
#
|
|
187
192
|
# @param line2 [String] The second line of the shipping address.
|
|
188
193
|
#
|
|
@@ -41,18 +41,21 @@ module Increase
|
|
|
41
41
|
optional :limit, Integer
|
|
42
42
|
|
|
43
43
|
# @!method initialize(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
44
|
-
# Some parameter documentations has been truncated, see
|
|
45
|
-
# {Increase::Models::PhysicalCardListParams} for more details.
|
|
46
|
-
#
|
|
47
44
|
# @param card_id [String] Filter Physical Cards to ones belonging to the specified Card.
|
|
48
45
|
#
|
|
49
46
|
# @param created_at [Increase::Models::PhysicalCardListParams::CreatedAt]
|
|
50
47
|
#
|
|
51
48
|
# @param cursor [String] Return the page of entries after this one.
|
|
52
49
|
#
|
|
53
|
-
# @param idempotency_key [String]
|
|
50
|
+
# @param idempotency_key [String]
|
|
51
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
52
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
53
|
+
# request is only processed once. Learn more about
|
|
54
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
54
55
|
#
|
|
55
|
-
# @param limit [Integer]
|
|
56
|
+
# @param limit [Integer]
|
|
57
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
58
|
+
# objects.
|
|
56
59
|
#
|
|
57
60
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
58
61
|
|
|
@@ -86,16 +89,21 @@ module Increase
|
|
|
86
89
|
optional :on_or_before, Time
|
|
87
90
|
|
|
88
91
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
#
|
|
92
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
92
|
+
# @param after [Time]
|
|
93
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
94
|
+
# timestamp.
|
|
93
95
|
#
|
|
94
|
-
# @param before [Time]
|
|
96
|
+
# @param before [Time]
|
|
97
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
98
|
+
# timestamp.
|
|
95
99
|
#
|
|
96
|
-
# @param on_or_after [Time]
|
|
100
|
+
# @param on_or_after [Time]
|
|
101
|
+
# Return results on or after this
|
|
102
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
97
103
|
#
|
|
98
|
-
# @param on_or_before [Time]
|
|
104
|
+
# @param on_or_before [Time]
|
|
105
|
+
# Return results on or before this
|
|
106
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
99
107
|
end
|
|
100
108
|
end
|
|
101
109
|
end
|
|
@@ -98,40 +98,56 @@ module Increase
|
|
|
98
98
|
required :type, enum: -> { Increase::PhysicalCardProfile::Type }
|
|
99
99
|
|
|
100
100
|
# @!method initialize(id:, back_image_file_id:, carrier_image_file_id:, contact_phone:, created_at:, creator:, description:, front_image_file_id:, front_text:, idempotency_key:, is_default:, program_id:, status:, type:)
|
|
101
|
-
# Some parameter documentations has been truncated, see
|
|
102
|
-
# {Increase::Models::PhysicalCardProfile} for more details.
|
|
103
|
-
#
|
|
104
101
|
# This contains artwork and metadata relating to a Physical Card's appearance. For
|
|
105
102
|
# more information, see our guide on
|
|
106
103
|
# [physical card artwork](https://increase.com/documentation/card-art-physical-cards).
|
|
107
104
|
#
|
|
108
105
|
# @param id [String] The Card Profile identifier.
|
|
109
106
|
#
|
|
110
|
-
# @param back_image_file_id [String, nil]
|
|
107
|
+
# @param back_image_file_id [String, nil]
|
|
108
|
+
# The identifier of the File containing the physical card's back image. This will
|
|
109
|
+
# be missing until the image has been post-processed.
|
|
111
110
|
#
|
|
112
|
-
# @param carrier_image_file_id [String, nil]
|
|
111
|
+
# @param carrier_image_file_id [String, nil]
|
|
112
|
+
# The identifier of the File containing the physical card's carrier image. This
|
|
113
|
+
# will be missing until the image has been post-processed.
|
|
113
114
|
#
|
|
114
115
|
# @param contact_phone [String, nil] A phone number the user can contact to receive support for their card.
|
|
115
116
|
#
|
|
116
|
-
# @param created_at [Time]
|
|
117
|
+
# @param created_at [Time]
|
|
118
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
119
|
+
# the Physical Card Profile was created.
|
|
117
120
|
#
|
|
118
|
-
# @param creator [Symbol, Increase::Models::PhysicalCardProfile::Creator]
|
|
121
|
+
# @param creator [Symbol, Increase::Models::PhysicalCardProfile::Creator]
|
|
122
|
+
# The creator of this Physical Card Profile.
|
|
119
123
|
#
|
|
120
124
|
# @param description [String] A description you can use to identify the Physical Card Profile.
|
|
121
125
|
#
|
|
122
|
-
# @param front_image_file_id [String, nil]
|
|
126
|
+
# @param front_image_file_id [String, nil]
|
|
127
|
+
# The identifier of the File containing the physical card's front image. This will
|
|
128
|
+
# be missing until the image has been post-processed.
|
|
123
129
|
#
|
|
124
|
-
# @param front_text [Increase::Models::PhysicalCardProfile::FrontText, nil]
|
|
130
|
+
# @param front_text [Increase::Models::PhysicalCardProfile::FrontText, nil]
|
|
131
|
+
# Text printed on the front of the card. Reach out to
|
|
132
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
125
133
|
#
|
|
126
|
-
# @param idempotency_key [String, nil]
|
|
134
|
+
# @param idempotency_key [String, nil]
|
|
135
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
136
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
137
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
127
138
|
#
|
|
128
|
-
# @param is_default [Boolean]
|
|
139
|
+
# @param is_default [Boolean]
|
|
140
|
+
# Whether this Physical Card Profile is the default for all cards in its Increase
|
|
141
|
+
# group.
|
|
129
142
|
#
|
|
130
143
|
# @param program_id [String] The identifier for the Program this Physical Card Profile belongs to.
|
|
131
144
|
#
|
|
132
|
-
# @param status [Symbol, Increase::Models::PhysicalCardProfile::Status]
|
|
145
|
+
# @param status [Symbol, Increase::Models::PhysicalCardProfile::Status]
|
|
146
|
+
# The status of the Physical Card Profile.
|
|
133
147
|
#
|
|
134
|
-
# @param type [Symbol, Increase::Models::PhysicalCardProfile::Type]
|
|
148
|
+
# @param type [Symbol, Increase::Models::PhysicalCardProfile::Type]
|
|
149
|
+
# A constant representing the object's type. For this resource it will always be
|
|
150
|
+
# `physical_card_profile`.
|
|
135
151
|
|
|
136
152
|
# The creator of this Physical Card Profile.
|
|
137
153
|
#
|
|
@@ -166,15 +182,15 @@ module Increase
|
|
|
166
182
|
required :line2, String, nil?: true
|
|
167
183
|
|
|
168
184
|
# @!method initialize(line1:, line2:)
|
|
169
|
-
# Some parameter documentations has been truncated, see
|
|
170
|
-
# {Increase::Models::PhysicalCardProfile::FrontText} for more details.
|
|
171
|
-
#
|
|
172
185
|
# Text printed on the front of the card. Reach out to
|
|
173
186
|
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
174
187
|
#
|
|
175
188
|
# @param line1 [String] The first line of text on the front of the card.
|
|
176
189
|
#
|
|
177
|
-
# @param line2 [String, nil]
|
|
190
|
+
# @param line2 [String, nil]
|
|
191
|
+
# The second line of text on the front of the card. Providing a second line moves
|
|
192
|
+
# the first line slightly higher and prints the second line in the spot where the
|
|
193
|
+
# first line would have otherwise been printed.
|
|
178
194
|
end
|
|
179
195
|
|
|
180
196
|
# The status of the Physical Card Profile.
|
|
@@ -51,12 +51,10 @@ module Increase
|
|
|
51
51
|
optional :program_id, String
|
|
52
52
|
|
|
53
53
|
# @!method initialize(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: {})
|
|
54
|
-
# Some parameter documentations has been truncated, see
|
|
55
|
-
# {Increase::Models::PhysicalCardProfileCloneParams} for more details.
|
|
56
|
-
#
|
|
57
54
|
# @param physical_card_profile_id [String] The identifier of the Physical Card Profile to clone.
|
|
58
55
|
#
|
|
59
|
-
# @param carrier_image_file_id [String]
|
|
56
|
+
# @param carrier_image_file_id [String]
|
|
57
|
+
# The identifier of the File containing the physical card's carrier image.
|
|
60
58
|
#
|
|
61
59
|
# @param contact_phone [String] A phone number the user can contact to receive support for their card.
|
|
62
60
|
#
|
|
@@ -64,7 +62,9 @@ module Increase
|
|
|
64
62
|
#
|
|
65
63
|
# @param front_image_file_id [String] The identifier of the File containing the physical card's front image.
|
|
66
64
|
#
|
|
67
|
-
# @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText]
|
|
65
|
+
# @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText]
|
|
66
|
+
# Text printed on the front of the card. Reach out to
|
|
67
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
68
68
|
#
|
|
69
69
|
# @param program_id [String] The identifier of the Program to use for the cloned Physical Card Profile.
|
|
70
70
|
#
|
|
@@ -86,15 +86,15 @@ module Increase
|
|
|
86
86
|
optional :line2, String
|
|
87
87
|
|
|
88
88
|
# @!method initialize(line1:, line2: nil)
|
|
89
|
-
# Some parameter documentations has been truncated, see
|
|
90
|
-
# {Increase::Models::PhysicalCardProfileCloneParams::FrontText} for more details.
|
|
91
|
-
#
|
|
92
89
|
# Text printed on the front of the card. Reach out to
|
|
93
90
|
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
94
91
|
#
|
|
95
92
|
# @param line1 [String] The first line of text on the front of the card.
|
|
96
93
|
#
|
|
97
|
-
# @param line2 [String]
|
|
94
|
+
# @param line2 [String]
|
|
95
|
+
# The second line of text on the front of the card. Providing a second line moves
|
|
96
|
+
# the first line slightly higher and prints the second line in the spot where the
|
|
97
|
+
# first line would have otherwise been printed.
|
|
98
98
|
end
|
|
99
99
|
end
|
|
100
100
|
end
|
|
@@ -45,10 +45,8 @@ module Increase
|
|
|
45
45
|
optional :front_text, -> { Increase::PhysicalCardProfileCreateParams::FrontText }
|
|
46
46
|
|
|
47
47
|
# @!method initialize(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, front_text: nil, request_options: {})
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
#
|
|
51
|
-
# @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image.
|
|
48
|
+
# @param carrier_image_file_id [String]
|
|
49
|
+
# The identifier of the File containing the physical card's carrier image.
|
|
52
50
|
#
|
|
53
51
|
# @param contact_phone [String] A phone number the user can contact to receive support for their card.
|
|
54
52
|
#
|
|
@@ -58,7 +56,9 @@ module Increase
|
|
|
58
56
|
#
|
|
59
57
|
# @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
|
|
60
58
|
#
|
|
61
|
-
# @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText]
|
|
59
|
+
# @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText]
|
|
60
|
+
# Text printed on the front of the card. Reach out to
|
|
61
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
62
62
|
#
|
|
63
63
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
64
64
|
|
|
@@ -78,15 +78,15 @@ module Increase
|
|
|
78
78
|
optional :line2, String
|
|
79
79
|
|
|
80
80
|
# @!method initialize(line1:, line2: nil)
|
|
81
|
-
# Some parameter documentations has been truncated, see
|
|
82
|
-
# {Increase::Models::PhysicalCardProfileCreateParams::FrontText} for more details.
|
|
83
|
-
#
|
|
84
81
|
# Text printed on the front of the card. Reach out to
|
|
85
82
|
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
86
83
|
#
|
|
87
84
|
# @param line1 [String] The first line of text on the front of the card.
|
|
88
85
|
#
|
|
89
|
-
# @param line2 [String]
|
|
86
|
+
# @param line2 [String]
|
|
87
|
+
# The second line of text on the front of the card. Providing a second line moves
|
|
88
|
+
# the first line slightly higher and prints the second line in the spot where the
|
|
89
|
+
# first line would have otherwise been printed.
|
|
90
90
|
end
|
|
91
91
|
end
|
|
92
92
|
end
|
|
@@ -35,14 +35,17 @@ module Increase
|
|
|
35
35
|
optional :status, -> { Increase::PhysicalCardProfileListParams::Status }
|
|
36
36
|
|
|
37
37
|
# @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
38
|
-
# Some parameter documentations has been truncated, see
|
|
39
|
-
# {Increase::Models::PhysicalCardProfileListParams} for more details.
|
|
40
|
-
#
|
|
41
38
|
# @param cursor [String] Return the page of entries after this one.
|
|
42
39
|
#
|
|
43
|
-
# @param idempotency_key [String]
|
|
40
|
+
# @param idempotency_key [String]
|
|
41
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
42
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
43
|
+
# request is only processed once. Learn more about
|
|
44
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
44
45
|
#
|
|
45
|
-
# @param limit [Integer]
|
|
46
|
+
# @param limit [Integer]
|
|
47
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
48
|
+
# objects.
|
|
46
49
|
#
|
|
47
50
|
# @param status [Increase::Models::PhysicalCardProfileListParams::Status]
|
|
48
51
|
#
|
|
@@ -62,10 +65,10 @@ module Increase
|
|
|
62
65
|
api_name: :in
|
|
63
66
|
|
|
64
67
|
# @!method initialize(in_: nil)
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
68
|
+
# @param in_ [Array<Symbol, Increase::Models::PhysicalCardProfileListParams::Status::In>]
|
|
69
|
+
# Filter Physical Card Profiles for those with the specified statuses. For GET
|
|
70
|
+
# requests, this should be encoded as a comma-delimited string, such as
|
|
71
|
+
# `?in=one,two,three`.
|
|
69
72
|
|
|
70
73
|
module In
|
|
71
74
|
extend Increase::Internal::Type::Enum
|
|
@@ -22,7 +22,8 @@ module Increase
|
|
|
22
22
|
# @!method initialize(physical_card_id:, status:, request_options: {})
|
|
23
23
|
# @param physical_card_id [String] The Physical Card identifier.
|
|
24
24
|
#
|
|
25
|
-
# @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
|
|
25
|
+
# @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
|
|
26
|
+
# The status to update the Physical Card to.
|
|
26
27
|
#
|
|
27
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
28
29
|
|
|
@@ -70,9 +70,6 @@ module Increase
|
|
|
70
70
|
required :updated_at, Time
|
|
71
71
|
|
|
72
72
|
# @!method initialize(id:, bank:, billing_account_id:, created_at:, default_digital_card_profile_id:, interest_rate:, lending:, name:, type:, updated_at:)
|
|
73
|
-
# Some parameter documentations has been truncated, see
|
|
74
|
-
# {Increase::Models::Program} for more details.
|
|
75
|
-
#
|
|
76
73
|
# Programs determine the compliance and commercial terms of Accounts. By default,
|
|
77
74
|
# you have a Commercial Banking program for managing your own funds. If you are
|
|
78
75
|
# lending or managing funds on behalf of your customers, or otherwise engaged in
|
|
@@ -84,19 +81,29 @@ module Increase
|
|
|
84
81
|
#
|
|
85
82
|
# @param billing_account_id [String, nil] The Program billing account.
|
|
86
83
|
#
|
|
87
|
-
# @param created_at [Time]
|
|
84
|
+
# @param created_at [Time]
|
|
85
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
|
|
86
|
+
# was created.
|
|
88
87
|
#
|
|
89
|
-
# @param default_digital_card_profile_id [String, nil]
|
|
88
|
+
# @param default_digital_card_profile_id [String, nil]
|
|
89
|
+
# The default configuration for digital cards attached to this Program.
|
|
90
90
|
#
|
|
91
|
-
# @param interest_rate [String]
|
|
91
|
+
# @param interest_rate [String]
|
|
92
|
+
# The Interest Rate currently being earned on the accounts in this program, as a
|
|
93
|
+
# string containing a decimal number. For example, a 1% interest rate would be
|
|
94
|
+
# represented as "0.01".
|
|
92
95
|
#
|
|
93
96
|
# @param lending [Increase::Models::Program::Lending, nil] The lending details for the program.
|
|
94
97
|
#
|
|
95
98
|
# @param name [String] The name of the Program.
|
|
96
99
|
#
|
|
97
|
-
# @param type [Symbol, Increase::Models::Program::Type]
|
|
100
|
+
# @param type [Symbol, Increase::Models::Program::Type]
|
|
101
|
+
# A constant representing the object's type. For this resource it will always be
|
|
102
|
+
# `program`.
|
|
98
103
|
#
|
|
99
|
-
# @param updated_at [Time]
|
|
104
|
+
# @param updated_at [Time]
|
|
105
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
|
|
106
|
+
# was last updated.
|
|
100
107
|
|
|
101
108
|
# The Bank the Program is with.
|
|
102
109
|
#
|