increase 0.3.2 → 1.0.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/.ignore +2 -0
- data/CHANGELOG.md +807 -56
- data/README.md +213 -254
- data/SECURITY.md +3 -0
- data/lib/increase/client.rb +287 -43
- data/lib/increase/errors.rb +223 -63
- data/lib/increase/file_part.rb +55 -0
- data/lib/increase/internal/page.rb +86 -0
- data/lib/increase/internal/transport/base_client.rb +555 -0
- data/lib/increase/internal/transport/pooled_net_requester.rb +209 -0
- data/lib/increase/internal/type/array_of.rb +162 -0
- data/lib/increase/internal/type/base_model.rb +484 -0
- data/lib/increase/internal/type/base_page.rb +55 -0
- data/lib/increase/internal/type/boolean.rb +71 -0
- data/lib/increase/internal/type/converter.rb +292 -0
- data/lib/increase/internal/type/enum.rb +123 -0
- data/lib/increase/internal/type/file_input.rb +103 -0
- data/lib/increase/internal/type/hash_of.rb +182 -0
- data/lib/increase/internal/type/request_parameters.rb +42 -0
- data/lib/increase/internal/type/union.rb +230 -0
- data/lib/increase/internal/type/unknown.rb +75 -0
- data/lib/increase/internal/util.rb +914 -0
- data/lib/increase/internal.rb +20 -0
- data/lib/increase/models/account.rb +224 -0
- data/lib/increase/models/account_balance_params.rb +22 -0
- data/lib/increase/models/account_close_params.rb +14 -0
- data/lib/increase/models/account_create_params.rb +51 -0
- data/lib/increase/models/account_list_params.rb +155 -0
- data/lib/increase/models/account_number.rb +209 -0
- data/lib/increase/models/account_number_create_params.rb +121 -0
- data/lib/increase/models/account_number_list_params.rb +183 -0
- data/lib/increase/models/account_number_retrieve_params.rb +14 -0
- data/lib/increase/models/account_number_update_params.rb +131 -0
- data/lib/increase/models/account_retrieve_params.rb +14 -0
- data/lib/increase/models/account_statement.rb +105 -0
- data/lib/increase/models/account_statement_list_params.rb +92 -0
- data/lib/increase/models/account_statement_retrieve_params.rb +14 -0
- data/lib/increase/models/account_transfer.rb +389 -0
- data/lib/increase/models/account_transfer_approve_params.rb +14 -0
- data/lib/increase/models/account_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/account_transfer_create_params.rb +58 -0
- data/lib/increase/models/account_transfer_list_params.rb +102 -0
- data/lib/increase/models/account_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/account_update_params.rb +22 -0
- data/lib/increase/models/ach_prenotification.rb +562 -0
- data/lib/increase/models/ach_prenotification_create_params.rb +160 -0
- data/lib/increase/models/ach_prenotification_list_params.rb +94 -0
- data/lib/increase/models/ach_prenotification_retrieve_params.rb +14 -0
- data/lib/increase/models/ach_transfer.rb +1481 -0
- data/lib/increase/models/ach_transfer_approve_params.rb +14 -0
- data/lib/increase/models/ach_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/ach_transfer_create_params.rb +430 -0
- data/lib/increase/models/ach_transfer_list_params.rb +168 -0
- data/lib/increase/models/ach_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/balance_lookup.rb +63 -0
- data/lib/increase/models/bookkeeping_account.rb +104 -0
- data/lib/increase/models/bookkeeping_account_balance_params.rb +22 -0
- data/lib/increase/models/bookkeeping_account_create_params.rb +60 -0
- data/lib/increase/models/bookkeeping_account_list_params.rb +45 -0
- data/lib/increase/models/bookkeeping_account_update_params.rb +22 -0
- data/lib/increase/models/bookkeeping_balance_lookup.rb +54 -0
- data/lib/increase/models/bookkeeping_entry.rb +79 -0
- data/lib/increase/models/bookkeeping_entry_list_params.rb +42 -0
- data/lib/increase/models/bookkeeping_entry_retrieve_params.rb +14 -0
- data/lib/increase/models/bookkeeping_entry_set.rb +116 -0
- data/lib/increase/models/bookkeeping_entry_set_create_params.rb +67 -0
- data/lib/increase/models/bookkeeping_entry_set_list_params.rb +53 -0
- data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb +14 -0
- data/lib/increase/models/card.rb +243 -0
- data/lib/increase/models/card_create_params.rb +145 -0
- data/lib/increase/models/card_details.rb +78 -0
- data/lib/increase/models/card_details_params.rb +14 -0
- data/lib/increase/models/card_dispute.rb +302 -0
- data/lib/increase/models/card_dispute_create_params.rb +45 -0
- data/lib/increase/models/card_dispute_list_params.rb +144 -0
- data/lib/increase/models/card_dispute_retrieve_params.rb +14 -0
- data/lib/increase/models/card_list_params.rb +142 -0
- data/lib/increase/models/card_payment.rb +6511 -0
- data/lib/increase/models/card_payment_list_params.rb +99 -0
- data/lib/increase/models/card_payment_retrieve_params.rb +14 -0
- data/lib/increase/models/card_purchase_supplement.rb +452 -0
- data/lib/increase/models/card_purchase_supplement_list_params.rb +93 -0
- data/lib/increase/models/card_purchase_supplement_retrieve_params.rb +14 -0
- data/lib/increase/models/card_retrieve_params.rb +14 -0
- data/lib/increase/models/card_update_params.rb +158 -0
- data/lib/increase/models/check_deposit.rb +807 -0
- data/lib/increase/models/check_deposit_create_params.rb +57 -0
- data/lib/increase/models/check_deposit_list_params.rb +102 -0
- data/lib/increase/models/check_deposit_retrieve_params.rb +14 -0
- data/lib/increase/models/check_transfer.rb +983 -0
- data/lib/increase/models/check_transfer_approve_params.rb +14 -0
- data/lib/increase/models/check_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/check_transfer_create_params.rb +324 -0
- data/lib/increase/models/check_transfer_list_params.rb +166 -0
- data/lib/increase/models/check_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/check_transfer_stop_payment_params.rb +39 -0
- data/lib/increase/models/declined_transaction.rb +1779 -0
- data/lib/increase/models/declined_transaction_list_params.rb +153 -0
- data/lib/increase/models/declined_transaction_retrieve_params.rb +14 -0
- data/lib/increase/models/digital_card_profile.rb +197 -0
- data/lib/increase/models/digital_card_profile_archive_params.rb +14 -0
- data/lib/increase/models/digital_card_profile_clone_params.rb +115 -0
- data/lib/increase/models/digital_card_profile_create_params.rb +115 -0
- data/lib/increase/models/digital_card_profile_list_params.rb +91 -0
- data/lib/increase/models/digital_card_profile_retrieve_params.rb +14 -0
- data/lib/increase/models/digital_wallet_token.rb +281 -0
- data/lib/increase/models/digital_wallet_token_list_params.rb +91 -0
- data/lib/increase/models/digital_wallet_token_retrieve_params.rb +14 -0
- data/lib/increase/models/document.rb +135 -0
- data/lib/increase/models/document_create_params.rb +62 -0
- data/lib/increase/models/document_list_params.rb +149 -0
- data/lib/increase/models/document_retrieve_params.rb +14 -0
- data/lib/increase/models/entity.rb +1476 -0
- data/lib/increase/models/entity_archive_beneficial_owner_params.rb +26 -0
- data/lib/increase/models/entity_archive_params.rb +14 -0
- data/lib/increase/models/entity_confirm_params.rb +26 -0
- data/lib/increase/models/entity_create_beneficial_owner_params.rb +412 -0
- data/lib/increase/models/entity_create_params.rb +2318 -0
- data/lib/increase/models/entity_list_params.rb +135 -0
- data/lib/increase/models/entity_retrieve_params.rb +14 -0
- data/lib/increase/models/entity_supplemental_document.rb +72 -0
- data/lib/increase/models/entity_update_address_params.rb +76 -0
- data/lib/increase/models/entity_update_beneficial_owner_address_params.rb +95 -0
- data/lib/increase/models/entity_update_industry_code_params.rb +28 -0
- data/lib/increase/models/event.rb +363 -0
- data/lib/increase/models/event_list_params.rb +395 -0
- data/lib/increase/models/event_retrieve_params.rb +14 -0
- data/lib/increase/models/event_subscription.rb +408 -0
- data/lib/increase/models/event_subscription_create_params.rb +334 -0
- data/lib/increase/models/event_subscription_list_params.rb +45 -0
- data/lib/increase/models/event_subscription_retrieve_params.rb +14 -0
- data/lib/increase/models/event_subscription_update_params.rb +39 -0
- data/lib/increase/models/export.rb +152 -0
- data/lib/increase/models/export_create_params.rb +444 -0
- data/lib/increase/models/export_list_params.rb +188 -0
- data/lib/increase/models/export_retrieve_params.rb +14 -0
- data/lib/increase/models/external_account.rb +166 -0
- data/lib/increase/models/external_account_create_params.rb +92 -0
- data/lib/increase/models/external_account_list_params.rb +93 -0
- data/lib/increase/models/external_account_retrieve_params.rb +14 -0
- data/lib/increase/models/external_account_update_params.rb +91 -0
- data/lib/increase/models/file.rb +213 -0
- data/lib/increase/models/file_create_params.rb +99 -0
- data/lib/increase/models/file_link.rb +90 -0
- data/lib/increase/models/file_link_create_params.rb +34 -0
- data/lib/increase/models/file_list_params.rb +203 -0
- data/lib/increase/models/file_retrieve_params.rb +14 -0
- data/lib/increase/models/group.rb +104 -0
- data/lib/increase/models/group_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_ach_transfer.rb +1095 -0
- data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +30 -0
- data/lib/increase/models/inbound_ach_transfer_decline_params.rb +69 -0
- data/lib/increase/models/inbound_ach_transfer_list_params.rb +145 -0
- data/lib/increase/models/inbound_ach_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +67 -0
- data/lib/increase/models/inbound_check_deposit.rb +391 -0
- data/lib/increase/models/inbound_check_deposit_decline_params.rb +14 -0
- data/lib/increase/models/inbound_check_deposit_list_params.rb +100 -0
- data/lib/increase/models/inbound_check_deposit_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_check_deposit_return_params.rb +45 -0
- data/lib/increase/models/inbound_mail_item.rb +132 -0
- data/lib/increase/models/inbound_mail_item_list_params.rb +91 -0
- data/lib/increase/models/inbound_mail_item_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +290 -0
- data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +102 -0
- data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_wire_drawdown_request.rb +221 -0
- data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +34 -0
- data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_wire_transfer.rb +307 -0
- data/lib/increase/models/inbound_wire_transfer_list_params.rb +145 -0
- data/lib/increase/models/inbound_wire_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +36 -0
- data/lib/increase/models/intrafi_account_enrollment.rb +121 -0
- data/lib/increase/models/intrafi_account_enrollment_create_params.rb +30 -0
- data/lib/increase/models/intrafi_account_enrollment_list_params.rb +102 -0
- data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +14 -0
- data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +14 -0
- data/lib/increase/models/intrafi_balance.rb +180 -0
- data/lib/increase/models/intrafi_balance_intrafi_balance_params.rb +14 -0
- data/lib/increase/models/intrafi_exclusion.rb +134 -0
- data/lib/increase/models/intrafi_exclusion_archive_params.rb +14 -0
- data/lib/increase/models/intrafi_exclusion_create_params.rb +30 -0
- data/lib/increase/models/intrafi_exclusion_list_params.rb +53 -0
- data/lib/increase/models/intrafi_exclusion_retrieve_params.rb +14 -0
- data/lib/increase/models/lockbox.rb +182 -0
- data/lib/increase/models/lockbox_create_params.rb +38 -0
- data/lib/increase/models/lockbox_list_params.rb +102 -0
- data/lib/increase/models/lockbox_retrieve_params.rb +14 -0
- data/lib/increase/models/lockbox_update_params.rb +52 -0
- data/lib/increase/models/oauth_application.rb +106 -0
- data/lib/increase/models/oauth_application_list_params.rb +122 -0
- data/lib/increase/models/oauth_application_retrieve_params.rb +14 -0
- data/lib/increase/models/oauth_connection.rb +104 -0
- data/lib/increase/models/oauth_connection_list_params.rb +83 -0
- data/lib/increase/models/oauth_connection_retrieve_params.rb +14 -0
- data/lib/increase/models/oauth_token.rb +67 -0
- data/lib/increase/models/oauth_token_create_params.rb +78 -0
- data/lib/increase/models/pending_transaction.rb +1747 -0
- data/lib/increase/models/pending_transaction_create_params.rb +43 -0
- data/lib/increase/models/pending_transaction_list_params.rb +212 -0
- data/lib/increase/models/pending_transaction_release_params.rb +14 -0
- data/lib/increase/models/pending_transaction_retrieve_params.rb +14 -0
- data/lib/increase/models/physical_card.rb +433 -0
- data/lib/increase/models/physical_card_create_params.rb +185 -0
- data/lib/increase/models/physical_card_list_params.rb +102 -0
- data/lib/increase/models/physical_card_profile.rb +182 -0
- data/lib/increase/models/physical_card_profile_archive_params.rb +14 -0
- data/lib/increase/models/physical_card_profile_clone_params.rb +85 -0
- data/lib/increase/models/physical_card_profile_create_params.rb +93 -0
- data/lib/increase/models/physical_card_profile_list_params.rb +97 -0
- data/lib/increase/models/physical_card_profile_retrieve_params.rb +14 -0
- data/lib/increase/models/physical_card_retrieve_params.rb +14 -0
- data/lib/increase/models/physical_card_update_params.rb +39 -0
- data/lib/increase/models/program.rb +126 -0
- data/lib/increase/models/program_list_params.rb +34 -0
- data/lib/increase/models/program_retrieve_params.rb +14 -0
- data/lib/increase/models/real_time_decision.rb +1303 -0
- data/lib/increase/models/real_time_decision_action_params.rb +351 -0
- data/lib/increase/models/real_time_decision_retrieve_params.rb +14 -0
- data/lib/increase/models/real_time_payments_transfer.rb +622 -0
- data/lib/increase/models/real_time_payments_transfer_approve_params.rb +14 -0
- data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/real_time_payments_transfer_create_params.rb +112 -0
- data/lib/increase/models/real_time_payments_transfer_list_params.rb +169 -0
- data/lib/increase/models/real_time_payments_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models/routing_number_list_params.rb +42 -0
- data/lib/increase/models/routing_number_list_response.rb +125 -0
- data/lib/increase/models/simulations/account_statement_create_params.rb +24 -0
- data/lib/increase/models/simulations/account_transfer_complete_params.rb +16 -0
- data/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb +16 -0
- data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +104 -0
- data/lib/increase/models/simulations/ach_transfer_return_params.rb +250 -0
- data/lib/increase/models/simulations/ach_transfer_settle_params.rb +16 -0
- data/lib/increase/models/simulations/ach_transfer_submit_params.rb +16 -0
- data/lib/increase/models/simulations/card_authorization_create_params.rb +309 -0
- data/lib/increase/models/simulations/card_authorization_create_response.rb +59 -0
- data/lib/increase/models/simulations/card_authorization_expiration_create_params.rb +24 -0
- data/lib/increase/models/simulations/card_dispute_action_params.rb +55 -0
- data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +37 -0
- data/lib/increase/models/simulations/card_increment_create_params.rb +46 -0
- data/lib/increase/models/simulations/card_refund_create_params.rb +28 -0
- data/lib/increase/models/simulations/card_reversal_create_params.rb +36 -0
- data/lib/increase/models/simulations/card_settlement_create_params.rb +45 -0
- data/lib/increase/models/simulations/check_deposit_reject_params.rb +16 -0
- data/lib/increase/models/simulations/check_deposit_return_params.rb +16 -0
- data/lib/increase/models/simulations/check_deposit_submit_params.rb +16 -0
- data/lib/increase/models/simulations/check_transfer_mail_params.rb +16 -0
- data/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb +24 -0
- data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +83 -0
- data/lib/increase/models/simulations/document_create_params.rb +24 -0
- data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +241 -0
- data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +40 -0
- data/lib/increase/models/simulations/inbound_funds_hold_release_params.rb +16 -0
- data/lib/increase/models/simulations/inbound_funds_hold_release_response.rb +161 -0
- data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +44 -0
- data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +77 -0
- data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +186 -0
- data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +171 -0
- data/lib/increase/models/simulations/interest_payment_create_params.rb +59 -0
- data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +57 -0
- data/lib/increase/models/simulations/physical_card_tracking_updates_params.rb +81 -0
- data/lib/increase/models/simulations/program_create_params.rb +32 -0
- data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +113 -0
- data/lib/increase/models/simulations/wire_transfer_reverse_params.rb +16 -0
- data/lib/increase/models/simulations/wire_transfer_submit_params.rb +16 -0
- data/lib/increase/models/supplemental_document_create_params.rb +30 -0
- data/lib/increase/models/supplemental_document_list_params.rb +53 -0
- data/lib/increase/models/transaction.rb +5823 -0
- data/lib/increase/models/transaction_list_params.rb +226 -0
- data/lib/increase/models/transaction_retrieve_params.rb +14 -0
- data/lib/increase/models/wire_drawdown_request.rb +249 -0
- data/lib/increase/models/wire_drawdown_request_create_params.rb +129 -0
- data/lib/increase/models/wire_drawdown_request_list_params.rb +91 -0
- data/lib/increase/models/wire_drawdown_request_retrieve_params.rb +14 -0
- data/lib/increase/models/wire_transfer.rb +677 -0
- data/lib/increase/models/wire_transfer_approve_params.rb +14 -0
- data/lib/increase/models/wire_transfer_cancel_params.rb +14 -0
- data/lib/increase/models/wire_transfer_create_params.rb +151 -0
- data/lib/increase/models/wire_transfer_list_params.rb +110 -0
- data/lib/increase/models/wire_transfer_retrieve_params.rb +14 -0
- data/lib/increase/models.rb +483 -0
- data/lib/increase/request_options.rb +77 -0
- data/lib/increase/resources/account_numbers.rb +130 -13
- data/lib/increase/resources/account_statements.rb +60 -9
- data/lib/increase/resources/account_transfers.rb +135 -15
- data/lib/increase/resources/accounts.rb +168 -15
- data/lib/increase/resources/ach_prenotifications.rb +109 -11
- data/lib/increase/resources/ach_transfers.rb +167 -15
- data/lib/increase/resources/bookkeeping_accounts.rb +120 -0
- data/lib/increase/resources/bookkeeping_entries.rb +64 -0
- data/lib/increase/resources/bookkeeping_entry_sets.rb +95 -0
- data/lib/increase/resources/card_disputes.rb +91 -11
- data/lib/increase/resources/card_payments.rb +68 -0
- data/lib/increase/resources/card_purchase_supplements.rb +66 -0
- data/lib/increase/resources/cards.rb +146 -15
- data/lib/increase/resources/check_deposits.rb +95 -11
- data/lib/increase/resources/check_transfers.rb +167 -17
- data/lib/increase/resources/declined_transactions.rb +64 -9
- data/lib/increase/resources/digital_card_profiles.rb +164 -0
- data/lib/increase/resources/digital_wallet_tokens.rb +60 -9
- data/lib/increase/resources/documents.rb +89 -10
- data/lib/increase/resources/entities.rb +293 -14
- data/lib/increase/resources/event_subscriptions.rb +113 -13
- data/lib/increase/resources/events.rb +62 -9
- data/lib/increase/resources/exports.rb +109 -0
- data/lib/increase/resources/external_accounts.rb +125 -13
- data/lib/increase/resources/file_links.rb +41 -0
- data/lib/increase/resources/files.rb +94 -11
- data/lib/increase/resources/groups.rb +26 -7
- data/lib/increase/resources/inbound_ach_transfers.rb +154 -0
- data/lib/increase/resources/inbound_check_deposits.rb +112 -0
- data/lib/increase/resources/inbound_mail_items.rb +66 -0
- data/lib/increase/resources/inbound_real_time_payments_transfers.rb +68 -0
- data/lib/increase/resources/inbound_wire_drawdown_requests.rb +56 -9
- data/lib/increase/resources/inbound_wire_transfers.rb +94 -0
- data/lib/increase/resources/intrafi_account_enrollments.rb +112 -0
- data/lib/increase/resources/intrafi_balances.rb +36 -0
- data/lib/increase/resources/intrafi_exclusions.rb +113 -0
- data/lib/increase/resources/lockboxes.rb +122 -0
- data/lib/increase/resources/oauth_applications.rb +66 -0
- data/lib/increase/resources/oauth_connections.rb +60 -9
- data/lib/increase/resources/oauth_tokens.rb +47 -0
- data/lib/increase/resources/pending_transactions.rb +122 -10
- data/lib/increase/resources/physical_card_profiles.rb +156 -0
- data/lib/increase/resources/physical_cards.rb +123 -0
- data/lib/increase/resources/programs.rb +62 -0
- data/lib/increase/resources/real_time_decisions.rb +63 -9
- data/lib/increase/resources/real_time_payments_transfers.rb +157 -0
- data/lib/increase/resources/routing_numbers.rb +41 -7
- data/lib/increase/resources/simulations/account_statements.rb +39 -0
- data/lib/increase/resources/simulations/account_transfers.rb +39 -0
- data/lib/increase/resources/simulations/ach_transfers.rb +151 -0
- data/lib/increase/resources/simulations/card_authorization_expirations.rb +38 -0
- data/lib/increase/resources/simulations/card_authorizations.rb +79 -0
- data/lib/increase/resources/simulations/card_disputes.rb +45 -0
- data/lib/increase/resources/simulations/card_fuel_confirmations.rb +46 -0
- data/lib/increase/resources/simulations/card_increments.rb +46 -0
- data/lib/increase/resources/simulations/card_refunds.rb +42 -0
- data/lib/increase/resources/simulations/card_reversals.rb +46 -0
- data/lib/increase/resources/simulations/card_settlements.rb +49 -0
- data/lib/increase/resources/simulations/check_deposits.rb +80 -0
- data/lib/increase/resources/simulations/check_transfers.rb +39 -0
- data/lib/increase/resources/simulations/digital_wallet_token_requests.rb +39 -0
- data/lib/increase/resources/simulations/documents.rb +38 -0
- data/lib/increase/resources/simulations/inbound_ach_transfers.rb +73 -0
- data/lib/increase/resources/simulations/inbound_check_deposits.rb +47 -0
- data/lib/increase/resources/simulations/inbound_funds_holds.rb +37 -0
- data/lib/increase/resources/simulations/inbound_mail_items.rb +46 -0
- data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +56 -0
- data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +81 -0
- data/lib/increase/resources/simulations/inbound_wire_transfers.rb +74 -0
- data/lib/increase/resources/simulations/interest_payments.rb +50 -0
- data/lib/increase/resources/simulations/physical_cards.rb +79 -0
- data/lib/increase/resources/simulations/programs.rb +43 -0
- data/lib/increase/resources/simulations/real_time_payments_transfers.rb +43 -0
- data/lib/increase/resources/simulations/wire_transfers.rb +61 -0
- data/lib/increase/resources/simulations.rb +127 -0
- data/lib/increase/resources/supplemental_documents.rb +70 -0
- data/lib/increase/resources/transactions.rb +64 -9
- data/lib/increase/resources/wire_drawdown_requests.rb +109 -11
- data/lib/increase/resources/wire_transfers.rb +159 -15
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +386 -22
- data/manifest.yaml +15 -0
- data/rbi/increase/client.rbi +221 -0
- data/rbi/increase/errors.rbi +206 -0
- data/rbi/increase/file_part.rbi +37 -0
- data/rbi/increase/internal/page.rbi +22 -0
- data/rbi/increase/internal/transport/base_client.rbi +293 -0
- data/rbi/increase/internal/transport/pooled_net_requester.rbi +79 -0
- data/rbi/increase/internal/type/array_of.rbi +104 -0
- data/rbi/increase/internal/type/base_model.rbi +302 -0
- data/rbi/increase/internal/type/base_page.rbi +42 -0
- data/rbi/increase/internal/type/boolean.rbi +56 -0
- data/rbi/increase/internal/type/converter.rbi +162 -0
- data/rbi/increase/internal/type/enum.rbi +82 -0
- data/rbi/increase/internal/type/file_input.rbi +59 -0
- data/rbi/increase/internal/type/hash_of.rbi +104 -0
- data/rbi/increase/internal/type/request_parameters.rbi +29 -0
- data/rbi/increase/internal/type/union.rbi +116 -0
- data/rbi/increase/internal/type/unknown.rbi +56 -0
- data/rbi/increase/internal/util.rbi +487 -0
- data/rbi/increase/internal.rbi +16 -0
- data/rbi/increase/models/account.rbi +269 -0
- data/rbi/increase/models/account_balance_params.rbi +43 -0
- data/rbi/increase/models/account_close_params.rbi +27 -0
- data/rbi/increase/models/account_create_params.rbi +80 -0
- data/rbi/increase/models/account_list_params.rbi +280 -0
- data/rbi/increase/models/account_number.rbi +348 -0
- data/rbi/increase/models/account_number_create_params.rbi +262 -0
- data/rbi/increase/models/account_number_list_params.rbi +396 -0
- data/rbi/increase/models/account_number_retrieve_params.rbi +30 -0
- data/rbi/increase/models/account_number_update_params.rbi +320 -0
- data/rbi/increase/models/account_retrieve_params.rbi +27 -0
- data/rbi/increase/models/account_statement.rbi +136 -0
- data/rbi/increase/models/account_statement_list_params.rbi +167 -0
- data/rbi/increase/models/account_statement_retrieve_params.rbi +30 -0
- data/rbi/increase/models/account_transfer.rbi +634 -0
- data/rbi/increase/models/account_transfer_approve_params.rbi +30 -0
- data/rbi/increase/models/account_transfer_cancel_params.rbi +30 -0
- data/rbi/increase/models/account_transfer_create_params.rbi +83 -0
- data/rbi/increase/models/account_transfer_list_params.rbi +177 -0
- data/rbi/increase/models/account_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/account_update_params.rbi +43 -0
- data/rbi/increase/models/ach_prenotification.rbi +1094 -0
- data/rbi/increase/models/ach_prenotification_create_params.rbi +294 -0
- data/rbi/increase/models/ach_prenotification_list_params.rbi +168 -0
- data/rbi/increase/models/ach_prenotification_retrieve_params.rbi +30 -0
- data/rbi/increase/models/ach_transfer.rbi +2672 -0
- data/rbi/increase/models/ach_transfer_approve_params.rbi +27 -0
- data/rbi/increase/models/ach_transfer_cancel_params.rbi +27 -0
- data/rbi/increase/models/ach_transfer_create_params.rbi +904 -0
- data/rbi/increase/models/ach_transfer_list_params.rbi +330 -0
- data/rbi/increase/models/ach_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/balance_lookup.rbi +90 -0
- data/rbi/increase/models/bookkeeping_account.rbi +165 -0
- data/rbi/increase/models/bookkeeping_account_balance_params.rbi +46 -0
- data/rbi/increase/models/bookkeeping_account_create_params.rbi +130 -0
- data/rbi/increase/models/bookkeeping_account_list_params.rbi +79 -0
- data/rbi/increase/models/bookkeeping_account_update_params.rbi +43 -0
- data/rbi/increase/models/bookkeeping_balance_lookup.rbi +85 -0
- data/rbi/increase/models/bookkeeping_entry.rbi +108 -0
- data/rbi/increase/models/bookkeeping_entry_list_params.rbi +73 -0
- data/rbi/increase/models/bookkeeping_entry_retrieve_params.rbi +30 -0
- data/rbi/increase/models/bookkeeping_entry_set.rbi +162 -0
- data/rbi/increase/models/bookkeeping_entry_set_create_params.rbi +110 -0
- data/rbi/increase/models/bookkeeping_entry_set_list_params.rbi +90 -0
- data/rbi/increase/models/bookkeeping_entry_set_retrieve_params.rbi +30 -0
- data/rbi/increase/models/card.rbi +317 -0
- data/rbi/increase/models/card_create_params.rbi +241 -0
- data/rbi/increase/models/card_details.rbi +103 -0
- data/rbi/increase/models/card_details_params.rbi +27 -0
- data/rbi/increase/models/card_dispute.rbi +425 -0
- data/rbi/increase/models/card_dispute_create_params.rbi +70 -0
- data/rbi/increase/models/card_dispute_list_params.rbi +289 -0
- data/rbi/increase/models/card_dispute_retrieve_params.rbi +30 -0
- data/rbi/increase/models/card_list_params.rbi +252 -0
- data/rbi/increase/models/card_payment.rbi +11956 -0
- data/rbi/increase/models/card_payment_list_params.rbi +168 -0
- data/rbi/increase/models/card_payment_retrieve_params.rbi +30 -0
- data/rbi/increase/models/card_purchase_supplement.rbi +687 -0
- data/rbi/increase/models/card_purchase_supplement_list_params.rbi +168 -0
- data/rbi/increase/models/card_purchase_supplement_retrieve_params.rbi +30 -0
- data/rbi/increase/models/card_retrieve_params.rbi +27 -0
- data/rbi/increase/models/card_update_params.rbi +267 -0
- data/rbi/increase/models/check_deposit.rbi +1393 -0
- data/rbi/increase/models/check_deposit_create_params.rbi +78 -0
- data/rbi/increase/models/check_deposit_list_params.rbi +174 -0
- data/rbi/increase/models/check_deposit_retrieve_params.rbi +30 -0
- data/rbi/increase/models/check_transfer.rbi +1670 -0
- data/rbi/increase/models/check_transfer_approve_params.rbi +30 -0
- data/rbi/increase/models/check_transfer_cancel_params.rbi +30 -0
- data/rbi/increase/models/check_transfer_create_params.rbi +573 -0
- data/rbi/increase/models/check_transfer_list_params.rbi +332 -0
- data/rbi/increase/models/check_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/check_transfer_stop_payment_params.rbi +99 -0
- data/rbi/increase/models/declined_transaction.rbi +3355 -0
- data/rbi/increase/models/declined_transaction_list_params.rbi +322 -0
- data/rbi/increase/models/declined_transaction_retrieve_params.rbi +30 -0
- data/rbi/increase/models/digital_card_profile.rbi +258 -0
- data/rbi/increase/models/digital_card_profile_archive_params.rbi +30 -0
- data/rbi/increase/models/digital_card_profile_clone_params.rbi +188 -0
- data/rbi/increase/models/digital_card_profile_create_params.rbi +174 -0
- data/rbi/increase/models/digital_card_profile_list_params.rbi +203 -0
- data/rbi/increase/models/digital_card_profile_retrieve_params.rbi +30 -0
- data/rbi/increase/models/digital_wallet_token.rbi +508 -0
- data/rbi/increase/models/digital_wallet_token_list_params.rbi +162 -0
- data/rbi/increase/models/digital_wallet_token_retrieve_params.rbi +30 -0
- data/rbi/increase/models/document.rbi +198 -0
- data/rbi/increase/models/document_create_params.rbi +132 -0
- data/rbi/increase/models/document_list_params.rbi +289 -0
- data/rbi/increase/models/document_retrieve_params.rbi +27 -0
- data/rbi/increase/models/entity.rbi +2531 -0
- data/rbi/increase/models/entity_archive_beneficial_owner_params.rbi +48 -0
- data/rbi/increase/models/entity_archive_params.rbi +27 -0
- data/rbi/increase/models/entity_confirm_params.rbi +45 -0
- data/rbi/increase/models/entity_create_beneficial_owner_params.rbi +764 -0
- data/rbi/increase/models/entity_create_params.rbi +4200 -0
- data/rbi/increase/models/entity_list_params.rbi +256 -0
- data/rbi/increase/models/entity_retrieve_params.rbi +27 -0
- data/rbi/increase/models/entity_supplemental_document.rbi +108 -0
- data/rbi/increase/models/entity_update_address_params.rbi +129 -0
- data/rbi/increase/models/entity_update_beneficial_owner_address_params.rbi +163 -0
- data/rbi/increase/models/entity_update_industry_code_params.rbi +49 -0
- data/rbi/increase/models/event.rbi +698 -0
- data/rbi/increase/models/event_list_params.rbi +862 -0
- data/rbi/increase/models/event_retrieve_params.rbi +27 -0
- data/rbi/increase/models/event_subscription.rbi +833 -0
- data/rbi/increase/models/event_subscription_create_params.rbi +753 -0
- data/rbi/increase/models/event_subscription_list_params.rbi +79 -0
- data/rbi/increase/models/event_subscription_retrieve_params.rbi +30 -0
- data/rbi/increase/models/event_subscription_update_params.rbi +99 -0
- data/rbi/increase/models/export.rbi +196 -0
- data/rbi/increase/models/export_create_params.rbi +933 -0
- data/rbi/increase/models/export_list_params.rbi +386 -0
- data/rbi/increase/models/export_retrieve_params.rbi +27 -0
- data/rbi/increase/models/external_account.rbi +236 -0
- data/rbi/increase/models/external_account_create_params.rbi +191 -0
- data/rbi/increase/models/external_account_list_params.rbi +198 -0
- data/rbi/increase/models/external_account_retrieve_params.rbi +30 -0
- data/rbi/increase/models/external_account_update_params.rbi +223 -0
- data/rbi/increase/models/file.rbi +291 -0
- data/rbi/increase/models/file_create_params.rbi +188 -0
- data/rbi/increase/models/file_link.rbi +115 -0
- data/rbi/increase/models/file_link_create_params.rbi +56 -0
- data/rbi/increase/models/file_list_params.rbi +410 -0
- data/rbi/increase/models/file_retrieve_params.rbi +27 -0
- data/rbi/increase/models/group.rbi +139 -0
- data/rbi/increase/models/group_retrieve_params.rbi +27 -0
- data/rbi/increase/models/inbound_ach_transfer.rbi +1898 -0
- data/rbi/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi +60 -0
- data/rbi/increase/models/inbound_ach_transfer_decline_params.rbi +154 -0
- data/rbi/increase/models/inbound_ach_transfer_list_params.rbi +297 -0
- data/rbi/increase/models/inbound_ach_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_ach_transfer_transfer_return_params.rbi +149 -0
- data/rbi/increase/models/inbound_check_deposit.rbi +609 -0
- data/rbi/increase/models/inbound_check_deposit_decline_params.rbi +30 -0
- data/rbi/increase/models/inbound_check_deposit_list_params.rbi +176 -0
- data/rbi/increase/models/inbound_check_deposit_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_check_deposit_return_params.rbi +104 -0
- data/rbi/increase/models/inbound_mail_item.rbi +201 -0
- data/rbi/increase/models/inbound_mail_item_list_params.rbi +160 -0
- data/rbi/increase/models/inbound_mail_item_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +516 -0
- data/rbi/increase/models/inbound_real_time_payments_transfer_list_params.rbi +184 -0
- data/rbi/increase/models/inbound_real_time_payments_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_wire_drawdown_request.rbi +261 -0
- data/rbi/increase/models/inbound_wire_drawdown_request_list_params.rbi +62 -0
- data/rbi/increase/models/inbound_wire_drawdown_request_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_wire_transfer.rbi +400 -0
- data/rbi/increase/models/inbound_wire_transfer_list_params.rbi +300 -0
- data/rbi/increase/models/inbound_wire_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/inbound_wire_transfer_reverse_params.rbi +84 -0
- data/rbi/increase/models/intrafi_account_enrollment.rbi +185 -0
- data/rbi/increase/models/intrafi_account_enrollment_create_params.rbi +54 -0
- data/rbi/increase/models/intrafi_account_enrollment_list_params.rbi +226 -0
- data/rbi/increase/models/intrafi_account_enrollment_retrieve_params.rbi +30 -0
- data/rbi/increase/models/intrafi_account_enrollment_unenroll_params.rbi +30 -0
- data/rbi/increase/models/intrafi_balance.rbi +262 -0
- data/rbi/increase/models/intrafi_balance_intrafi_balance_params.rbi +30 -0
- data/rbi/increase/models/intrafi_exclusion.rbi +176 -0
- data/rbi/increase/models/intrafi_exclusion_archive_params.rbi +30 -0
- data/rbi/increase/models/intrafi_exclusion_create_params.rbi +54 -0
- data/rbi/increase/models/intrafi_exclusion_list_params.rbi +90 -0
- data/rbi/increase/models/intrafi_exclusion_retrieve_params.rbi +30 -0
- data/rbi/increase/models/lockbox.rbi +232 -0
- data/rbi/increase/models/lockbox_create_params.rbi +65 -0
- data/rbi/increase/models/lockbox_list_params.rbi +172 -0
- data/rbi/increase/models/lockbox_retrieve_params.rbi +27 -0
- data/rbi/increase/models/lockbox_update_params.rbi +97 -0
- data/rbi/increase/models/oauth_application.rbi +146 -0
- data/rbi/increase/models/oauth_application_list_params.rbi +259 -0
- data/rbi/increase/models/oauth_application_retrieve_params.rbi +30 -0
- data/rbi/increase/models/oauth_connection.rbi +142 -0
- data/rbi/increase/models/oauth_connection_list_params.rbi +183 -0
- data/rbi/increase/models/oauth_connection_retrieve_params.rbi +30 -0
- data/rbi/increase/models/oauth_token.rbi +98 -0
- data/rbi/increase/models/oauth_token_create_params.rbi +133 -0
- data/rbi/increase/models/pending_transaction.rbi +3220 -0
- data/rbi/increase/models/pending_transaction_create_params.rbi +69 -0
- data/rbi/increase/models/pending_transaction_list_params.rbi +475 -0
- data/rbi/increase/models/pending_transaction_release_params.rbi +30 -0
- data/rbi/increase/models/pending_transaction_retrieve_params.rbi +30 -0
- data/rbi/increase/models/physical_card.rbi +691 -0
- data/rbi/increase/models/physical_card_create_params.rbi +327 -0
- data/rbi/increase/models/physical_card_list_params.rbi +174 -0
- data/rbi/increase/models/physical_card_profile.rbi +245 -0
- data/rbi/increase/models/physical_card_profile_archive_params.rbi +30 -0
- data/rbi/increase/models/physical_card_profile_clone_params.rbi +143 -0
- data/rbi/increase/models/physical_card_profile_create_params.rbi +139 -0
- data/rbi/increase/models/physical_card_profile_list_params.rbi +219 -0
- data/rbi/increase/models/physical_card_profile_retrieve_params.rbi +30 -0
- data/rbi/increase/models/physical_card_retrieve_params.rbi +30 -0
- data/rbi/increase/models/physical_card_update_params.rbi +83 -0
- data/rbi/increase/models/program.rbi +155 -0
- data/rbi/increase/models/program_list_params.rbi +59 -0
- data/rbi/increase/models/program_retrieve_params.rbi +27 -0
- data/rbi/increase/models/real_time_decision.rbi +2466 -0
- data/rbi/increase/models/real_time_decision_action_params.rbi +806 -0
- data/rbi/increase/models/real_time_decision_retrieve_params.rbi +30 -0
- data/rbi/increase/models/real_time_payments_transfer.rbi +1151 -0
- data/rbi/increase/models/real_time_payments_transfer_approve_params.rbi +30 -0
- data/rbi/increase/models/real_time_payments_transfer_cancel_params.rbi +30 -0
- data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +161 -0
- data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +351 -0
- data/rbi/increase/models/real_time_payments_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models/routing_number_list_params.rbi +67 -0
- data/rbi/increase/models/routing_number_list_response.rbi +246 -0
- data/rbi/increase/models/simulations/account_statement_create_params.rbi +45 -0
- data/rbi/increase/models/simulations/account_transfer_complete_params.rbi +32 -0
- data/rbi/increase/models/simulations/ach_transfer_acknowledge_params.rbi +32 -0
- data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +219 -0
- data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +581 -0
- data/rbi/increase/models/simulations/ach_transfer_settle_params.rbi +32 -0
- data/rbi/increase/models/simulations/ach_transfer_submit_params.rbi +32 -0
- data/rbi/increase/models/simulations/card_authorization_create_params.rbi +648 -0
- data/rbi/increase/models/simulations/card_authorization_create_response.rbi +123 -0
- data/rbi/increase/models/simulations/card_authorization_expiration_create_params.rbi +48 -0
- data/rbi/increase/models/simulations/card_dispute_action_params.rbi +124 -0
- data/rbi/increase/models/simulations/card_fuel_confirmation_create_params.rbi +58 -0
- data/rbi/increase/models/simulations/card_increment_create_params.rbi +73 -0
- data/rbi/increase/models/simulations/card_refund_create_params.rbi +50 -0
- data/rbi/increase/models/simulations/card_reversal_create_params.rbi +61 -0
- data/rbi/increase/models/simulations/card_settlement_create_params.rbi +71 -0
- data/rbi/increase/models/simulations/check_deposit_reject_params.rbi +32 -0
- data/rbi/increase/models/simulations/check_deposit_return_params.rbi +32 -0
- data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +32 -0
- data/rbi/increase/models/simulations/check_transfer_mail_params.rbi +32 -0
- data/rbi/increase/models/simulations/digital_wallet_token_request_create_params.rbi +45 -0
- data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +167 -0
- data/rbi/increase/models/simulations/document_create_params.rbi +45 -0
- data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +508 -0
- data/rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi +64 -0
- data/rbi/increase/models/simulations/inbound_funds_hold_release_params.rbi +32 -0
- data/rbi/increase/models/simulations/inbound_funds_hold_release_response.rbi +280 -0
- data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +69 -0
- data/rbi/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi +113 -0
- data/rbi/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi +248 -0
- data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +251 -0
- data/rbi/increase/models/simulations/interest_payment_create_params.rbi +89 -0
- data/rbi/increase/models/simulations/physical_card_advance_shipment_params.rbi +134 -0
- data/rbi/increase/models/simulations/physical_card_tracking_updates_params.rbi +152 -0
- data/rbi/increase/models/simulations/program_create_params.rbi +59 -0
- data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +277 -0
- data/rbi/increase/models/simulations/wire_transfer_reverse_params.rbi +32 -0
- data/rbi/increase/models/simulations/wire_transfer_submit_params.rbi +32 -0
- data/rbi/increase/models/supplemental_document_create_params.rbi +54 -0
- data/rbi/increase/models/supplemental_document_list_params.rbi +87 -0
- data/rbi/increase/models/transaction.rbi +10456 -0
- data/rbi/increase/models/transaction_list_params.rbi +473 -0
- data/rbi/increase/models/transaction_retrieve_params.rbi +30 -0
- data/rbi/increase/models/wire_drawdown_request.rbi +324 -0
- data/rbi/increase/models/wire_drawdown_request_create_params.rbi +179 -0
- data/rbi/increase/models/wire_drawdown_request_list_params.rbi +205 -0
- data/rbi/increase/models/wire_drawdown_request_retrieve_params.rbi +30 -0
- data/rbi/increase/models/wire_transfer.rbi +974 -0
- data/rbi/increase/models/wire_transfer_approve_params.rbi +30 -0
- data/rbi/increase/models/wire_transfer_cancel_params.rbi +27 -0
- data/rbi/increase/models/wire_transfer_create_params.rbi +211 -0
- data/rbi/increase/models/wire_transfer_list_params.rbi +185 -0
- data/rbi/increase/models/wire_transfer_retrieve_params.rbi +30 -0
- data/rbi/increase/models.rbi +517 -0
- data/rbi/increase/request_options.rbi +59 -0
- data/rbi/increase/resources/account_numbers.rbi +113 -0
- data/rbi/increase/resources/account_statements.rbi +50 -0
- data/rbi/increase/resources/account_transfers.rbi +110 -0
- data/rbi/increase/resources/accounts.rbi +137 -0
- data/rbi/increase/resources/ach_prenotifications.rbi +107 -0
- data/rbi/increase/resources/ach_transfers.rbi +179 -0
- data/rbi/increase/resources/bookkeeping_accounts.rbi +94 -0
- data/rbi/increase/resources/bookkeeping_entries.rbi +47 -0
- data/rbi/increase/resources/bookkeeping_entry_sets.rbi +75 -0
- data/rbi/increase/resources/card_disputes.rbi +78 -0
- data/rbi/increase/resources/card_payments.rbi +52 -0
- data/rbi/increase/resources/card_purchase_supplements.rbi +51 -0
- data/rbi/increase/resources/cards.rbi +134 -0
- data/rbi/increase/resources/check_deposits.rbi +81 -0
- data/rbi/increase/resources/check_transfers.rbi +146 -0
- data/rbi/increase/resources/declined_transactions.rbi +55 -0
- data/rbi/increase/resources/digital_card_profiles.rbi +147 -0
- data/rbi/increase/resources/digital_wallet_tokens.rbi +49 -0
- data/rbi/increase/resources/documents.rbi +75 -0
- data/rbi/increase/resources/entities.rbi +241 -0
- data/rbi/increase/resources/event_subscriptions.rbi +94 -0
- data/rbi/increase/resources/events.rbi +51 -0
- data/rbi/increase/resources/exports.rbi +94 -0
- data/rbi/increase/resources/external_accounts.rbi +110 -0
- data/rbi/increase/resources/file_links.rbi +30 -0
- data/rbi/increase/resources/files.rbi +78 -0
- data/rbi/increase/resources/groups.rbi +21 -0
- data/rbi/increase/resources/inbound_ach_transfers.rbi +114 -0
- data/rbi/increase/resources/inbound_check_deposits.rbi +85 -0
- data/rbi/increase/resources/inbound_mail_items.rbi +49 -0
- data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +57 -0
- data/rbi/increase/resources/inbound_wire_drawdown_requests.rbi +46 -0
- data/rbi/increase/resources/inbound_wire_transfers.rbi +72 -0
- data/rbi/increase/resources/intrafi_account_enrollments.rbi +86 -0
- data/rbi/increase/resources/intrafi_balances.rbi +28 -0
- data/rbi/increase/resources/intrafi_exclusions.rbi +86 -0
- data/rbi/increase/resources/lockboxes.rbi +98 -0
- data/rbi/increase/resources/oauth_applications.rbi +48 -0
- data/rbi/increase/resources/oauth_connections.rbi +50 -0
- data/rbi/increase/resources/oauth_tokens.rbi +44 -0
- data/rbi/increase/resources/pending_transactions.rbi +98 -0
- data/rbi/increase/resources/physical_card_profiles.rbi +128 -0
- data/rbi/increase/resources/physical_cards.rbi +96 -0
- data/rbi/increase/resources/programs.rbi +44 -0
- data/rbi/increase/resources/real_time_decisions.rbi +65 -0
- data/rbi/increase/resources/real_time_payments_transfers.rbi +141 -0
- data/rbi/increase/resources/routing_numbers.rbi +38 -0
- data/rbi/increase/resources/simulations/account_statements.rbi +29 -0
- data/rbi/increase/resources/simulations/account_transfers.rbi +31 -0
- data/rbi/increase/resources/simulations/ach_transfers.rbi +115 -0
- data/rbi/increase/resources/simulations/card_authorization_expirations.rbi +28 -0
- data/rbi/increase/resources/simulations/card_authorizations.rbi +97 -0
- data/rbi/increase/resources/simulations/card_disputes.rbi +38 -0
- data/rbi/increase/resources/simulations/card_fuel_confirmations.rbi +34 -0
- data/rbi/increase/resources/simulations/card_increments.rbi +38 -0
- data/rbi/increase/resources/simulations/card_refunds.rbi +30 -0
- data/rbi/increase/resources/simulations/card_reversals.rbi +35 -0
- data/rbi/increase/resources/simulations/card_settlements.rbi +40 -0
- data/rbi/increase/resources/simulations/check_deposits.rbi +60 -0
- data/rbi/increase/resources/simulations/check_transfers.rbi +31 -0
- data/rbi/increase/resources/simulations/digital_wallet_token_requests.rbi +31 -0
- data/rbi/increase/resources/simulations/documents.rbi +28 -0
- data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +75 -0
- data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +39 -0
- data/rbi/increase/resources/simulations/inbound_funds_holds.rbi +31 -0
- data/rbi/increase/resources/simulations/inbound_mail_items.rbi +36 -0
- data/rbi/increase/resources/simulations/inbound_real_time_payments_transfers.rbi +49 -0
- data/rbi/increase/resources/simulations/inbound_wire_drawdown_requests.rbi +92 -0
- data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +91 -0
- data/rbi/increase/resources/simulations/interest_payments.rbi +41 -0
- data/rbi/increase/resources/simulations/physical_cards.rbi +66 -0
- data/rbi/increase/resources/simulations/programs.rbi +34 -0
- data/rbi/increase/resources/simulations/real_time_payments_transfers.rbi +35 -0
- data/rbi/increase/resources/simulations/wire_transfers.rbi +47 -0
- data/rbi/increase/resources/simulations.rbi +105 -0
- data/rbi/increase/resources/supplemental_documents.rbi +58 -0
- data/rbi/increase/resources/transactions.rbi +55 -0
- data/rbi/increase/resources/wire_drawdown_requests.rbi +110 -0
- data/rbi/increase/resources/wire_transfers.rbi +151 -0
- data/rbi/increase/version.rbi +5 -0
- data/sig/increase/client.rbs +135 -0
- data/sig/increase/errors.rbs +145 -0
- data/sig/increase/file_part.rbs +21 -0
- data/sig/increase/internal/page.rbs +13 -0
- data/sig/increase/internal/transport/base_client.rbs +131 -0
- data/sig/increase/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/increase/internal/type/array_of.rbs +48 -0
- data/sig/increase/internal/type/base_model.rbs +102 -0
- data/sig/increase/internal/type/base_page.rbs +24 -0
- data/sig/increase/internal/type/boolean.rbs +26 -0
- data/sig/increase/internal/type/converter.rbs +56 -0
- data/sig/increase/internal/type/enum.rbs +32 -0
- data/sig/increase/internal/type/file_input.rbs +25 -0
- data/sig/increase/internal/type/hash_of.rbs +48 -0
- data/sig/increase/internal/type/request_parameters.rbs +17 -0
- data/sig/increase/internal/type/union.rbs +52 -0
- data/sig/increase/internal/type/unknown.rbs +26 -0
- data/sig/increase/internal/util.rbs +185 -0
- data/sig/increase/internal.rbs +9 -0
- data/sig/increase/models/account.rbs +157 -0
- data/sig/increase/models/account_balance_params.rbs +25 -0
- data/sig/increase/models/account_close_params.rbs +15 -0
- data/sig/increase/models/account_create_params.rbs +47 -0
- data/sig/increase/models/account_list_params.rbs +149 -0
- data/sig/increase/models/account_number.rbs +157 -0
- data/sig/increase/models/account_number_create_params.rbs +111 -0
- data/sig/increase/models/account_number_list_params.rbs +182 -0
- data/sig/increase/models/account_number_retrieve_params.rbs +15 -0
- data/sig/increase/models/account_number_update_params.rbs +138 -0
- data/sig/increase/models/account_retrieve_params.rbs +15 -0
- data/sig/increase/models/account_statement.rbs +70 -0
- data/sig/increase/models/account_statement_list_params.rbs +86 -0
- data/sig/increase/models/account_statement_retrieve_params.rbs +15 -0
- data/sig/increase/models/account_transfer.rbs +266 -0
- data/sig/increase/models/account_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/account_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/account_transfer_create_params.rbs +48 -0
- data/sig/increase/models/account_transfer_list_params.rbs +93 -0
- data/sig/increase/models/account_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/account_update_params.rbs +25 -0
- data/sig/increase/models/ach_prenotification.rbs +561 -0
- data/sig/increase/models/ach_prenotification_create_params.rbs +148 -0
- data/sig/increase/models/ach_prenotification_list_params.rbs +86 -0
- data/sig/increase/models/ach_prenotification_retrieve_params.rbs +15 -0
- data/sig/increase/models/ach_transfer.rbs +1207 -0
- data/sig/increase/models/ach_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/ach_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/ach_transfer_create_params.rbs +379 -0
- data/sig/increase/models/ach_transfer_list_params.rbs +172 -0
- data/sig/increase/models/ach_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/balance_lookup.rbs +45 -0
- data/sig/increase/models/bookkeeping_account.rbs +74 -0
- data/sig/increase/models/bookkeeping_account_balance_params.rbs +25 -0
- data/sig/increase/models/bookkeeping_account_create_params.rbs +63 -0
- data/sig/increase/models/bookkeeping_account_list_params.rbs +38 -0
- data/sig/increase/models/bookkeeping_account_update_params.rbs +23 -0
- data/sig/increase/models/bookkeeping_balance_lookup.rbs +40 -0
- data/sig/increase/models/bookkeeping_entry.rbs +55 -0
- data/sig/increase/models/bookkeeping_entry_list_params.rbs +38 -0
- data/sig/increase/models/bookkeeping_entry_retrieve_params.rbs +15 -0
- data/sig/increase/models/bookkeeping_entry_set.rbs +78 -0
- data/sig/increase/models/bookkeeping_entry_set_create_params.rbs +52 -0
- data/sig/increase/models/bookkeeping_entry_set_list_params.rbs +49 -0
- data/sig/increase/models/bookkeeping_entry_set_retrieve_params.rbs +15 -0
- data/sig/increase/models/card.rbs +167 -0
- data/sig/increase/models/card_create_params.rbs +126 -0
- data/sig/increase/models/card_details.rbs +55 -0
- data/sig/increase/models/card_details_params.rbs +15 -0
- data/sig/increase/models/card_dispute.rbs +207 -0
- data/sig/increase/models/card_dispute_create_params.rbs +34 -0
- data/sig/increase/models/card_dispute_list_params.rbs +146 -0
- data/sig/increase/models/card_dispute_retrieve_params.rbs +15 -0
- data/sig/increase/models/card_list_params.rbs +138 -0
- data/sig/increase/models/card_payment.rbs +4955 -0
- data/sig/increase/models/card_payment_list_params.rbs +93 -0
- data/sig/increase/models/card_payment_retrieve_params.rbs +15 -0
- data/sig/increase/models/card_purchase_supplement.rbs +329 -0
- data/sig/increase/models/card_purchase_supplement_list_params.rbs +86 -0
- data/sig/increase/models/card_purchase_supplement_retrieve_params.rbs +15 -0
- data/sig/increase/models/card_retrieve_params.rbs +15 -0
- data/sig/increase/models/card_update_params.rbs +147 -0
- data/sig/increase/models/check_deposit.rbs +643 -0
- data/sig/increase/models/check_deposit_create_params.rbs +48 -0
- data/sig/increase/models/check_deposit_list_params.rbs +93 -0
- data/sig/increase/models/check_deposit_retrieve_params.rbs +15 -0
- data/sig/increase/models/check_transfer.rbs +729 -0
- data/sig/increase/models/check_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/check_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/check_transfer_create_params.rbs +262 -0
- data/sig/increase/models/check_transfer_list_params.rbs +169 -0
- data/sig/increase/models/check_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/check_transfer_stop_payment_params.rbs +45 -0
- data/sig/increase/models/declined_transaction.rbs +1469 -0
- data/sig/increase/models/declined_transaction_list_params.rbs +159 -0
- data/sig/increase/models/declined_transaction_retrieve_params.rbs +15 -0
- data/sig/increase/models/digital_card_profile.rbs +129 -0
- data/sig/increase/models/digital_card_profile_archive_params.rbs +15 -0
- data/sig/increase/models/digital_card_profile_clone_params.rbs +100 -0
- data/sig/increase/models/digital_card_profile_create_params.rbs +90 -0
- data/sig/increase/models/digital_card_profile_list_params.rbs +92 -0
- data/sig/increase/models/digital_card_profile_retrieve_params.rbs +15 -0
- data/sig/increase/models/digital_wallet_token.rbs +238 -0
- data/sig/increase/models/digital_wallet_token_list_params.rbs +86 -0
- data/sig/increase/models/digital_wallet_token_retrieve_params.rbs +15 -0
- data/sig/increase/models/document.rbs +103 -0
- data/sig/increase/models/document_create_params.rbs +61 -0
- data/sig/increase/models/document_list_params.rbs +149 -0
- data/sig/increase/models/document_retrieve_params.rbs +15 -0
- data/sig/increase/models/entity.rbs +1170 -0
- data/sig/increase/models/entity_archive_beneficial_owner_params.rbs +24 -0
- data/sig/increase/models/entity_archive_params.rbs +15 -0
- data/sig/increase/models/entity_confirm_params.rbs +25 -0
- data/sig/increase/models/entity_create_beneficial_owner_params.rbs +333 -0
- data/sig/increase/models/entity_create_params.rbs +1889 -0
- data/sig/increase/models/entity_list_params.rbs +131 -0
- data/sig/increase/models/entity_retrieve_params.rbs +15 -0
- data/sig/increase/models/entity_supplemental_document.rbs +50 -0
- data/sig/increase/models/entity_update_address_params.rbs +63 -0
- data/sig/increase/models/entity_update_beneficial_owner_address_params.rbs +81 -0
- data/sig/increase/models/entity_update_industry_code_params.rbs +23 -0
- data/sig/increase/models/event.rbs +423 -0
- data/sig/increase/models/event_list_params.rbs +482 -0
- data/sig/increase/models/event_retrieve_params.rbs +15 -0
- data/sig/increase/models/event_subscription.rbs +453 -0
- data/sig/increase/models/event_subscription_create_params.rbs +417 -0
- data/sig/increase/models/event_subscription_list_params.rbs +38 -0
- data/sig/increase/models/event_subscription_retrieve_params.rbs +15 -0
- data/sig/increase/models/event_subscription_update_params.rbs +45 -0
- data/sig/increase/models/export.rbs +118 -0
- data/sig/increase/models/export_create_params.rbs +427 -0
- data/sig/increase/models/export_list_params.rbs +195 -0
- data/sig/increase/models/export_retrieve_params.rbs +15 -0
- data/sig/increase/models/external_account.rbs +123 -0
- data/sig/increase/models/external_account_create_params.rbs +88 -0
- data/sig/increase/models/external_account_list_params.rbs +93 -0
- data/sig/increase/models/external_account_retrieve_params.rbs +15 -0
- data/sig/increase/models/external_account_update_params.rbs +100 -0
- data/sig/increase/models/file.rbs +196 -0
- data/sig/increase/models/file_create_params.rbs +110 -0
- data/sig/increase/models/file_link.rbs +60 -0
- data/sig/increase/models/file_link_create_params.rbs +30 -0
- data/sig/increase/models/file_list_params.rbs +226 -0
- data/sig/increase/models/file_retrieve_params.rbs +15 -0
- data/sig/increase/models/group.rbs +78 -0
- data/sig/increase/models/group_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_ach_transfer.rbs +886 -0
- data/sig/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbs +32 -0
- data/sig/increase/models/inbound_ach_transfer_decline_params.rbs +76 -0
- data/sig/increase/models/inbound_ach_transfer_list_params.rbs +143 -0
- data/sig/increase/models/inbound_ach_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_ach_transfer_transfer_return_params.rbs +74 -0
- data/sig/increase/models/inbound_check_deposit.rbs +304 -0
- data/sig/increase/models/inbound_check_deposit_decline_params.rbs +15 -0
- data/sig/increase/models/inbound_check_deposit_list_params.rbs +93 -0
- data/sig/increase/models/inbound_check_deposit_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_check_deposit_return_params.rbs +52 -0
- data/sig/increase/models/inbound_mail_item.rbs +100 -0
- data/sig/increase/models/inbound_mail_item_list_params.rbs +86 -0
- data/sig/increase/models/inbound_mail_item_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_real_time_payments_transfer.rbs +222 -0
- data/sig/increase/models/inbound_real_time_payments_transfer_list_params.rbs +93 -0
- data/sig/increase/models/inbound_real_time_payments_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_wire_drawdown_request.rbs +140 -0
- data/sig/increase/models/inbound_wire_drawdown_request_list_params.rbs +32 -0
- data/sig/increase/models/inbound_wire_drawdown_request_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_wire_transfer.rbs +211 -0
- data/sig/increase/models/inbound_wire_transfer_list_params.rbs +143 -0
- data/sig/increase/models/inbound_wire_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/inbound_wire_transfer_reverse_params.rbs +38 -0
- data/sig/increase/models/intrafi_account_enrollment.rbs +88 -0
- data/sig/increase/models/intrafi_account_enrollment_create_params.rbs +28 -0
- data/sig/increase/models/intrafi_account_enrollment_list_params.rbs +107 -0
- data/sig/increase/models/intrafi_account_enrollment_retrieve_params.rbs +15 -0
- data/sig/increase/models/intrafi_account_enrollment_unenroll_params.rbs +15 -0
- data/sig/increase/models/intrafi_balance.rbs +130 -0
- data/sig/increase/models/intrafi_balance_intrafi_balance_params.rbs +15 -0
- data/sig/increase/models/intrafi_exclusion.rbs +92 -0
- data/sig/increase/models/intrafi_exclusion_archive_params.rbs +15 -0
- data/sig/increase/models/intrafi_exclusion_create_params.rbs +28 -0
- data/sig/increase/models/intrafi_exclusion_list_params.rbs +49 -0
- data/sig/increase/models/intrafi_exclusion_retrieve_params.rbs +15 -0
- data/sig/increase/models/lockbox.rbs +126 -0
- data/sig/increase/models/lockbox_create_params.rbs +36 -0
- data/sig/increase/models/lockbox_list_params.rbs +93 -0
- data/sig/increase/models/lockbox_retrieve_params.rbs +15 -0
- data/sig/increase/models/lockbox_update_params.rbs +58 -0
- data/sig/increase/models/oauth_application.rbs +74 -0
- data/sig/increase/models/oauth_application_list_params.rbs +123 -0
- data/sig/increase/models/oauth_application_retrieve_params.rbs +15 -0
- data/sig/increase/models/oauth_connection.rbs +74 -0
- data/sig/increase/models/oauth_connection_list_params.rbs +86 -0
- data/sig/increase/models/oauth_connection_retrieve_params.rbs +15 -0
- data/sig/increase/models/oauth_token.rbs +50 -0
- data/sig/increase/models/oauth_token_create_params.rbs +68 -0
- data/sig/increase/models/pending_transaction.rbs +1266 -0
- data/sig/increase/models/pending_transaction_create_params.rbs +34 -0
- data/sig/increase/models/pending_transaction_list_params.rbs +227 -0
- data/sig/increase/models/pending_transaction_release_params.rbs +15 -0
- data/sig/increase/models/pending_transaction_retrieve_params.rbs +15 -0
- data/sig/increase/models/physical_card.rbs +338 -0
- data/sig/increase/models/physical_card_create_params.rbs +152 -0
- data/sig/increase/models/physical_card_list_params.rbs +93 -0
- data/sig/increase/models/physical_card_profile.rbs +136 -0
- data/sig/increase/models/physical_card_profile_archive_params.rbs +15 -0
- data/sig/increase/models/physical_card_profile_clone_params.rbs +72 -0
- data/sig/increase/models/physical_card_profile_create_params.rbs +69 -0
- data/sig/increase/models/physical_card_profile_list_params.rbs +104 -0
- data/sig/increase/models/physical_card_profile_retrieve_params.rbs +15 -0
- data/sig/increase/models/physical_card_retrieve_params.rbs +15 -0
- data/sig/increase/models/physical_card_update_params.rbs +41 -0
- data/sig/increase/models/program.rbs +87 -0
- data/sig/increase/models/program_list_params.rbs +32 -0
- data/sig/increase/models/program_retrieve_params.rbs +15 -0
- data/sig/increase/models/real_time_decision.rbs +998 -0
- data/sig/increase/models/real_time_decision_action_params.rbs +317 -0
- data/sig/increase/models/real_time_decision_retrieve_params.rbs +15 -0
- data/sig/increase/models/real_time_payments_transfer.rbs +467 -0
- data/sig/increase/models/real_time_payments_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/real_time_payments_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/real_time_payments_transfer_create_params.rbs +90 -0
- data/sig/increase/models/real_time_payments_transfer_list_params.rbs +170 -0
- data/sig/increase/models/real_time_payments_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models/routing_number_list_params.rbs +36 -0
- data/sig/increase/models/routing_number_list_response.rbs +97 -0
- data/sig/increase/models/simulations/account_statement_create_params.rbs +25 -0
- data/sig/increase/models/simulations/account_transfer_complete_params.rbs +17 -0
- data/sig/increase/models/simulations/ach_transfer_acknowledge_params.rbs +17 -0
- data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +117 -0
- data/sig/increase/models/simulations/ach_transfer_return_params.rbs +320 -0
- data/sig/increase/models/simulations/ach_transfer_settle_params.rbs +17 -0
- data/sig/increase/models/simulations/ach_transfer_submit_params.rbs +17 -0
- data/sig/increase/models/simulations/card_authorization_create_params.rbs +314 -0
- data/sig/increase/models/simulations/card_authorization_create_response.rbs +42 -0
- data/sig/increase/models/simulations/card_authorization_expiration_create_params.rbs +26 -0
- data/sig/increase/models/simulations/card_dispute_action_params.rbs +59 -0
- data/sig/increase/models/simulations/card_fuel_confirmation_create_params.rbs +30 -0
- data/sig/increase/models/simulations/card_increment_create_params.rbs +40 -0
- data/sig/increase/models/simulations/card_refund_create_params.rbs +26 -0
- data/sig/increase/models/simulations/card_reversal_create_params.rbs +32 -0
- data/sig/increase/models/simulations/card_settlement_create_params.rbs +36 -0
- data/sig/increase/models/simulations/check_deposit_reject_params.rbs +17 -0
- data/sig/increase/models/simulations/check_deposit_return_params.rbs +17 -0
- data/sig/increase/models/simulations/check_deposit_submit_params.rbs +17 -0
- data/sig/increase/models/simulations/check_transfer_mail_params.rbs +17 -0
- data/sig/increase/models/simulations/digital_wallet_token_request_create_params.rbs +25 -0
- data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +66 -0
- data/sig/increase/models/simulations/document_create_params.rbs +25 -0
- data/sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs +243 -0
- data/sig/increase/models/simulations/inbound_check_deposit_create_params.rbs +34 -0
- data/sig/increase/models/simulations/inbound_funds_hold_release_params.rbs +17 -0
- data/sig/increase/models/simulations/inbound_funds_hold_release_response.rbs +117 -0
- data/sig/increase/models/simulations/inbound_mail_item_create_params.rbs +36 -0
- data/sig/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbs +68 -0
- data/sig/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbs +147 -0
- data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +138 -0
- data/sig/increase/models/simulations/interest_payment_create_params.rbs +54 -0
- data/sig/increase/models/simulations/physical_card_advance_shipment_params.rbs +68 -0
- data/sig/increase/models/simulations/physical_card_tracking_updates_params.rbs +80 -0
- data/sig/increase/models/simulations/program_create_params.rbs +32 -0
- data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +141 -0
- data/sig/increase/models/simulations/wire_transfer_reverse_params.rbs +17 -0
- data/sig/increase/models/simulations/wire_transfer_submit_params.rbs +17 -0
- data/sig/increase/models/supplemental_document_create_params.rbs +28 -0
- data/sig/increase/models/supplemental_document_list_params.rbs +47 -0
- data/sig/increase/models/transaction.rbs +4400 -0
- data/sig/increase/models/transaction_list_params.rbs +253 -0
- data/sig/increase/models/transaction_retrieve_params.rbs +15 -0
- data/sig/increase/models/wire_drawdown_request.rbs +161 -0
- data/sig/increase/models/wire_drawdown_request_create_params.rbs +100 -0
- data/sig/increase/models/wire_drawdown_request_list_params.rbs +93 -0
- data/sig/increase/models/wire_drawdown_request_retrieve_params.rbs +15 -0
- data/sig/increase/models/wire_transfer.rbs +469 -0
- data/sig/increase/models/wire_transfer_approve_params.rbs +15 -0
- data/sig/increase/models/wire_transfer_cancel_params.rbs +15 -0
- data/sig/increase/models/wire_transfer_create_params.rbs +125 -0
- data/sig/increase/models/wire_transfer_list_params.rbs +100 -0
- data/sig/increase/models/wire_transfer_retrieve_params.rbs +15 -0
- data/sig/increase/models.rbs +441 -0
- data/sig/increase/request_options.rbs +34 -0
- data/sig/increase/resources/account_numbers.rbs +40 -0
- data/sig/increase/resources/account_statements.rbs +20 -0
- data/sig/increase/resources/account_transfers.rbs +40 -0
- data/sig/increase/resources/accounts.rbs +49 -0
- data/sig/increase/resources/ach_prenotifications.rbs +37 -0
- data/sig/increase/resources/ach_transfers.rbs +56 -0
- data/sig/increase/resources/bookkeeping_accounts.rbs +34 -0
- data/sig/increase/resources/bookkeeping_entries.rbs +19 -0
- data/sig/increase/resources/bookkeeping_entry_sets.rbs +27 -0
- data/sig/increase/resources/card_disputes.rbs +28 -0
- data/sig/increase/resources/card_payments.rbs +21 -0
- data/sig/increase/resources/card_purchase_supplements.rbs +20 -0
- data/sig/increase/resources/cards.rbs +46 -0
- data/sig/increase/resources/check_deposits.rbs +30 -0
- data/sig/increase/resources/check_transfers.rbs +50 -0
- data/sig/increase/resources/declined_transactions.rbs +22 -0
- data/sig/increase/resources/digital_card_profiles.rbs +52 -0
- data/sig/increase/resources/digital_wallet_tokens.rbs +20 -0
- data/sig/increase/resources/documents.rbs +28 -0
- data/sig/increase/resources/entities.rbs +76 -0
- data/sig/increase/resources/event_subscriptions.rbs +33 -0
- data/sig/increase/resources/events.rbs +21 -0
- data/sig/increase/resources/exports.rbs +33 -0
- data/sig/increase/resources/external_accounts.rbs +39 -0
- data/sig/increase/resources/file_links.rbs +13 -0
- data/sig/increase/resources/files.rbs +28 -0
- data/sig/increase/resources/groups.rbs +11 -0
- data/sig/increase/resources/inbound_ach_transfers.rbs +41 -0
- data/sig/increase/resources/inbound_check_deposits.rbs +32 -0
- data/sig/increase/resources/inbound_mail_items.rbs +20 -0
- data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +21 -0
- data/sig/increase/resources/inbound_wire_drawdown_requests.rbs +18 -0
- data/sig/increase/resources/inbound_wire_transfers.rbs +28 -0
- data/sig/increase/resources/intrafi_account_enrollments.rbs +32 -0
- data/sig/increase/resources/intrafi_balances.rbs +12 -0
- data/sig/increase/resources/intrafi_exclusions.rbs +31 -0
- data/sig/increase/resources/lockboxes.rbs +36 -0
- data/sig/increase/resources/oauth_applications.rbs +20 -0
- data/sig/increase/resources/oauth_connections.rbs +20 -0
- data/sig/increase/resources/oauth_tokens.rbs +16 -0
- data/sig/increase/resources/pending_transactions.rbs +35 -0
- data/sig/increase/resources/physical_card_profiles.rbs +45 -0
- data/sig/increase/resources/physical_cards.rbs +35 -0
- data/sig/increase/resources/programs.rbs +18 -0
- data/sig/increase/resources/real_time_decisions.rbs +22 -0
- data/sig/increase/resources/real_time_payments_transfers.rbs +48 -0
- data/sig/increase/resources/routing_numbers.rbs +14 -0
- data/sig/increase/resources/simulations/account_statements.rbs +14 -0
- data/sig/increase/resources/simulations/account_transfers.rbs +14 -0
- data/sig/increase/resources/simulations/ach_transfers.rbs +37 -0
- data/sig/increase/resources/simulations/card_authorization_expirations.rbs +14 -0
- data/sig/increase/resources/simulations/card_authorizations.rbs +30 -0
- data/sig/increase/resources/simulations/card_disputes.rbs +16 -0
- data/sig/increase/resources/simulations/card_fuel_confirmations.rbs +15 -0
- data/sig/increase/resources/simulations/card_increments.rbs +16 -0
- data/sig/increase/resources/simulations/card_refunds.rbs +14 -0
- data/sig/increase/resources/simulations/card_reversals.rbs +15 -0
- data/sig/increase/resources/simulations/card_settlements.rbs +16 -0
- data/sig/increase/resources/simulations/check_deposits.rbs +24 -0
- data/sig/increase/resources/simulations/check_transfers.rbs +14 -0
- data/sig/increase/resources/simulations/digital_wallet_token_requests.rbs +14 -0
- data/sig/increase/resources/simulations/documents.rbs +14 -0
- data/sig/increase/resources/simulations/inbound_ach_transfers.rbs +25 -0
- data/sig/increase/resources/simulations/inbound_check_deposits.rbs +16 -0
- data/sig/increase/resources/simulations/inbound_funds_holds.rbs +14 -0
- data/sig/increase/resources/simulations/inbound_mail_items.rbs +16 -0
- data/sig/increase/resources/simulations/inbound_real_time_payments_transfers.rbs +20 -0
- data/sig/increase/resources/simulations/inbound_wire_drawdown_requests.rbs +33 -0
- data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +30 -0
- data/sig/increase/resources/simulations/interest_payments.rbs +18 -0
- data/sig/increase/resources/simulations/physical_cards.rbs +25 -0
- data/sig/increase/resources/simulations/programs.rbs +15 -0
- data/sig/increase/resources/simulations/real_time_payments_transfers.rbs +15 -0
- data/sig/increase/resources/simulations/wire_transfers.rbs +19 -0
- data/sig/increase/resources/simulations.rbs +61 -0
- data/sig/increase/resources/supplemental_documents.rbs +21 -0
- data/sig/increase/resources/transactions.rbs +22 -0
- data/sig/increase/resources/wire_drawdown_requests.rbs +37 -0
- data/sig/increase/resources/wire_transfers.rbs +52 -0
- data/sig/increase/version.rbs +3 -0
- metadata +1068 -176
- data/.rspec +0 -3
- data/.standard.yml +0 -3
- data/Gemfile +0 -6
- data/LICENSE.txt +0 -21
- data/OPENAPI_VERSION +0 -1
- data/Rakefile +0 -10
- data/bin/generate +0 -152
- data/bin/setup +0 -8
- data/generate/resource.rb.erb +0 -18
- data/lib/increase/configuration.rb +0 -50
- data/lib/increase/file_upload.rb +0 -57
- data/lib/increase/middleware/encode_json.rb +0 -57
- data/lib/increase/middleware/parse_json.rb +0 -42
- data/lib/increase/middleware/raise_api_error.rb +0 -13
- data/lib/increase/resource.rb +0 -205
- data/lib/increase/resources/card_profiles.rb +0 -17
- data/lib/increase/resources/inbound_ach_transfer_returns.rb +0 -17
- data/lib/increase/resources/limits.rb +0 -19
- data/lib/increase/resources.rb +0 -4
- data/lib/increase/response_array.rb +0 -19
- data/lib/increase/response_hash.rb +0 -15
- data/lib/increase/util.rb +0 -15
- data/lib/increase/webhook/signature.rb +0 -70
- data/openapi.json +0 -32098
- data/sig/increase.rbs +0 -4
@@ -0,0 +1,1476 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Increase
|
4
|
+
module Models
|
5
|
+
# @see Increase::Resources::Entities#create
|
6
|
+
class Entity < Increase::Internal::Type::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
# The entity's identifier.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute corporation
|
14
|
+
# Details of the corporation entity. Will be present if `structure` is equal to
|
15
|
+
# `corporation`.
|
16
|
+
#
|
17
|
+
# @return [Increase::Models::Entity::Corporation, nil]
|
18
|
+
required :corporation, -> { Increase::Entity::Corporation }, nil?: true
|
19
|
+
|
20
|
+
# @!attribute created_at
|
21
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity
|
22
|
+
# was created.
|
23
|
+
#
|
24
|
+
# @return [Time]
|
25
|
+
required :created_at, Time
|
26
|
+
|
27
|
+
# @!attribute description
|
28
|
+
# The entity's description for display purposes.
|
29
|
+
#
|
30
|
+
# @return [String, nil]
|
31
|
+
required :description, String, nil?: true
|
32
|
+
|
33
|
+
# @!attribute details_confirmed_at
|
34
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
|
35
|
+
# Entity's details were most recently confirmed.
|
36
|
+
#
|
37
|
+
# @return [Time, nil]
|
38
|
+
required :details_confirmed_at, Time, nil?: true
|
39
|
+
|
40
|
+
# @!attribute government_authority
|
41
|
+
# Details of the government authority entity. Will be present if `structure` is
|
42
|
+
# equal to `government_authority`.
|
43
|
+
#
|
44
|
+
# @return [Increase::Models::Entity::GovernmentAuthority, nil]
|
45
|
+
required :government_authority, -> { Increase::Entity::GovernmentAuthority }, nil?: true
|
46
|
+
|
47
|
+
# @!attribute idempotency_key
|
48
|
+
# The idempotency key you chose for this object. This value is unique across
|
49
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
50
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
51
|
+
#
|
52
|
+
# @return [String, nil]
|
53
|
+
required :idempotency_key, String, nil?: true
|
54
|
+
|
55
|
+
# @!attribute joint
|
56
|
+
# Details of the joint entity. Will be present if `structure` is equal to `joint`.
|
57
|
+
#
|
58
|
+
# @return [Increase::Models::Entity::Joint, nil]
|
59
|
+
required :joint, -> { Increase::Entity::Joint }, nil?: true
|
60
|
+
|
61
|
+
# @!attribute natural_person
|
62
|
+
# Details of the natural person entity. Will be present if `structure` is equal to
|
63
|
+
# `natural_person`.
|
64
|
+
#
|
65
|
+
# @return [Increase::Models::Entity::NaturalPerson, nil]
|
66
|
+
required :natural_person, -> { Increase::Entity::NaturalPerson }, nil?: true
|
67
|
+
|
68
|
+
# @!attribute status
|
69
|
+
# The status of the entity.
|
70
|
+
#
|
71
|
+
# @return [Symbol, Increase::Models::Entity::Status]
|
72
|
+
required :status, enum: -> { Increase::Entity::Status }
|
73
|
+
|
74
|
+
# @!attribute structure
|
75
|
+
# The entity's legal structure.
|
76
|
+
#
|
77
|
+
# @return [Symbol, Increase::Models::Entity::Structure]
|
78
|
+
required :structure, enum: -> { Increase::Entity::Structure }
|
79
|
+
|
80
|
+
# @!attribute supplemental_documents
|
81
|
+
# Additional documentation associated with the entity. This is limited to the
|
82
|
+
# first 10 documents for an entity. If an entity has more than 10 documents, use
|
83
|
+
# the GET /entity_supplemental_documents list endpoint to retrieve them.
|
84
|
+
#
|
85
|
+
# @return [Array<Increase::Models::EntitySupplementalDocument>]
|
86
|
+
required :supplemental_documents,
|
87
|
+
-> { Increase::Internal::Type::ArrayOf[Increase::EntitySupplementalDocument] }
|
88
|
+
|
89
|
+
# @!attribute third_party_verification
|
90
|
+
# A reference to data stored in a third-party verification service. Your
|
91
|
+
# integration may or may not use this field.
|
92
|
+
#
|
93
|
+
# @return [Increase::Models::Entity::ThirdPartyVerification, nil]
|
94
|
+
required :third_party_verification, -> { Increase::Entity::ThirdPartyVerification }, nil?: true
|
95
|
+
|
96
|
+
# @!attribute trust
|
97
|
+
# Details of the trust entity. Will be present if `structure` is equal to `trust`.
|
98
|
+
#
|
99
|
+
# @return [Increase::Models::Entity::Trust, nil]
|
100
|
+
required :trust, -> { Increase::Entity::Trust }, nil?: true
|
101
|
+
|
102
|
+
# @!attribute type
|
103
|
+
# A constant representing the object's type. For this resource it will always be
|
104
|
+
# `entity`.
|
105
|
+
#
|
106
|
+
# @return [Symbol, Increase::Models::Entity::Type]
|
107
|
+
required :type, enum: -> { Increase::Entity::Type }
|
108
|
+
|
109
|
+
# @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, status:, structure:, supplemental_documents:, third_party_verification:, trust:, type:)
|
110
|
+
# Some parameter documentations has been truncated, see {Increase::Models::Entity}
|
111
|
+
# for more details.
|
112
|
+
#
|
113
|
+
# Entities are the legal entities that own accounts. They can be people,
|
114
|
+
# corporations, partnerships, government authorities, or trusts.
|
115
|
+
#
|
116
|
+
# @param id [String] The entity's identifier.
|
117
|
+
#
|
118
|
+
# @param corporation [Increase::Models::Entity::Corporation, nil] Details of the corporation entity. Will be present if `structure` is equal to `c
|
119
|
+
#
|
120
|
+
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity
|
121
|
+
#
|
122
|
+
# @param description [String, nil] The entity's description for display purposes.
|
123
|
+
#
|
124
|
+
# @param details_confirmed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity'
|
125
|
+
#
|
126
|
+
# @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil] Details of the government authority entity. Will be present if `structure` is eq
|
127
|
+
#
|
128
|
+
# @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
|
129
|
+
#
|
130
|
+
# @param joint [Increase::Models::Entity::Joint, nil] Details of the joint entity. Will be present if `structure` is equal to `joint`.
|
131
|
+
#
|
132
|
+
# @param natural_person [Increase::Models::Entity::NaturalPerson, nil] Details of the natural person entity. Will be present if `structure` is equal to
|
133
|
+
#
|
134
|
+
# @param status [Symbol, Increase::Models::Entity::Status] The status of the entity.
|
135
|
+
#
|
136
|
+
# @param structure [Symbol, Increase::Models::Entity::Structure] The entity's legal structure.
|
137
|
+
#
|
138
|
+
# @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>] Additional documentation associated with the entity. This is limited to the firs
|
139
|
+
#
|
140
|
+
# @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] A reference to data stored in a third-party verification service. Your integrati
|
141
|
+
#
|
142
|
+
# @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`.
|
143
|
+
#
|
144
|
+
# @param type [Symbol, Increase::Models::Entity::Type] A constant representing the object's type. For this resource it will always be `
|
145
|
+
|
146
|
+
# @see Increase::Models::Entity#corporation
|
147
|
+
class Corporation < Increase::Internal::Type::BaseModel
|
148
|
+
# @!attribute address
|
149
|
+
# The corporation's address.
|
150
|
+
#
|
151
|
+
# @return [Increase::Models::Entity::Corporation::Address]
|
152
|
+
required :address, -> { Increase::Entity::Corporation::Address }
|
153
|
+
|
154
|
+
# @!attribute beneficial_owners
|
155
|
+
# The identifying details of anyone controlling or owning 25% or more of the
|
156
|
+
# corporation.
|
157
|
+
#
|
158
|
+
# @return [Array<Increase::Models::Entity::Corporation::BeneficialOwner>]
|
159
|
+
required :beneficial_owners,
|
160
|
+
-> { Increase::Internal::Type::ArrayOf[Increase::Entity::Corporation::BeneficialOwner] }
|
161
|
+
|
162
|
+
# @!attribute incorporation_state
|
163
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the
|
164
|
+
# corporation's state of incorporation.
|
165
|
+
#
|
166
|
+
# @return [String, nil]
|
167
|
+
required :incorporation_state, String, nil?: true
|
168
|
+
|
169
|
+
# @!attribute industry_code
|
170
|
+
# The numeric North American Industry Classification System (NAICS) code submitted
|
171
|
+
# for the corporation.
|
172
|
+
#
|
173
|
+
# @return [String, nil]
|
174
|
+
required :industry_code, String, nil?: true
|
175
|
+
|
176
|
+
# @!attribute name
|
177
|
+
# The legal name of the corporation.
|
178
|
+
#
|
179
|
+
# @return [String]
|
180
|
+
required :name, String
|
181
|
+
|
182
|
+
# @!attribute tax_identifier
|
183
|
+
# The Employer Identification Number (EIN) for the corporation.
|
184
|
+
#
|
185
|
+
# @return [String, nil]
|
186
|
+
required :tax_identifier, String, nil?: true
|
187
|
+
|
188
|
+
# @!attribute website
|
189
|
+
# The website of the corporation.
|
190
|
+
#
|
191
|
+
# @return [String, nil]
|
192
|
+
required :website, String, nil?: true
|
193
|
+
|
194
|
+
# @!method initialize(address:, beneficial_owners:, incorporation_state:, industry_code:, name:, tax_identifier:, website:)
|
195
|
+
# Some parameter documentations has been truncated, see
|
196
|
+
# {Increase::Models::Entity::Corporation} for more details.
|
197
|
+
#
|
198
|
+
# Details of the corporation entity. Will be present if `structure` is equal to
|
199
|
+
# `corporation`.
|
200
|
+
#
|
201
|
+
# @param address [Increase::Models::Entity::Corporation::Address] The corporation's address.
|
202
|
+
#
|
203
|
+
# @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
|
204
|
+
#
|
205
|
+
# @param incorporation_state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the corporat
|
206
|
+
#
|
207
|
+
# @param industry_code [String, nil] The numeric North American Industry Classification System (NAICS) code submitted
|
208
|
+
#
|
209
|
+
# @param name [String] The legal name of the corporation.
|
210
|
+
#
|
211
|
+
# @param tax_identifier [String, nil] The Employer Identification Number (EIN) for the corporation.
|
212
|
+
#
|
213
|
+
# @param website [String, nil] The website of the corporation.
|
214
|
+
|
215
|
+
# @see Increase::Models::Entity::Corporation#address
|
216
|
+
class Address < Increase::Internal::Type::BaseModel
|
217
|
+
# @!attribute city
|
218
|
+
# The city of the address.
|
219
|
+
#
|
220
|
+
# @return [String]
|
221
|
+
required :city, String
|
222
|
+
|
223
|
+
# @!attribute line1
|
224
|
+
# The first line of the address.
|
225
|
+
#
|
226
|
+
# @return [String]
|
227
|
+
required :line1, String
|
228
|
+
|
229
|
+
# @!attribute line2
|
230
|
+
# The second line of the address.
|
231
|
+
#
|
232
|
+
# @return [String, nil]
|
233
|
+
required :line2, String, nil?: true
|
234
|
+
|
235
|
+
# @!attribute state
|
236
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
237
|
+
# the address.
|
238
|
+
#
|
239
|
+
# @return [String]
|
240
|
+
required :state, String
|
241
|
+
|
242
|
+
# @!attribute zip
|
243
|
+
# The ZIP code of the address.
|
244
|
+
#
|
245
|
+
# @return [String]
|
246
|
+
required :zip, String
|
247
|
+
|
248
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
249
|
+
# Some parameter documentations has been truncated, see
|
250
|
+
# {Increase::Models::Entity::Corporation::Address} for more details.
|
251
|
+
#
|
252
|
+
# The corporation's address.
|
253
|
+
#
|
254
|
+
# @param city [String] The city of the address.
|
255
|
+
#
|
256
|
+
# @param line1 [String] The first line of the address.
|
257
|
+
#
|
258
|
+
# @param line2 [String, nil] The second line of the address.
|
259
|
+
#
|
260
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
261
|
+
#
|
262
|
+
# @param zip [String] The ZIP code of the address.
|
263
|
+
end
|
264
|
+
|
265
|
+
class BeneficialOwner < Increase::Internal::Type::BaseModel
|
266
|
+
# @!attribute beneficial_owner_id
|
267
|
+
# The identifier of this beneficial owner.
|
268
|
+
#
|
269
|
+
# @return [String]
|
270
|
+
required :beneficial_owner_id, String
|
271
|
+
|
272
|
+
# @!attribute company_title
|
273
|
+
# This person's role or title within the entity.
|
274
|
+
#
|
275
|
+
# @return [String, nil]
|
276
|
+
required :company_title, String, nil?: true
|
277
|
+
|
278
|
+
# @!attribute individual
|
279
|
+
# Personal details for the beneficial owner.
|
280
|
+
#
|
281
|
+
# @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual]
|
282
|
+
required :individual, -> { Increase::Entity::Corporation::BeneficialOwner::Individual }
|
283
|
+
|
284
|
+
# @!attribute prong
|
285
|
+
# Why this person is considered a beneficial owner of the entity.
|
286
|
+
#
|
287
|
+
# @return [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong]
|
288
|
+
required :prong, enum: -> { Increase::Entity::Corporation::BeneficialOwner::Prong }
|
289
|
+
|
290
|
+
# @!method initialize(beneficial_owner_id:, company_title:, individual:, prong:)
|
291
|
+
# @param beneficial_owner_id [String] The identifier of this beneficial owner.
|
292
|
+
#
|
293
|
+
# @param company_title [String, nil] This person's role or title within the entity.
|
294
|
+
#
|
295
|
+
# @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner.
|
296
|
+
#
|
297
|
+
# @param prong [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong] Why this person is considered a beneficial owner of the entity.
|
298
|
+
|
299
|
+
# @see Increase::Models::Entity::Corporation::BeneficialOwner#individual
|
300
|
+
class Individual < Increase::Internal::Type::BaseModel
|
301
|
+
# @!attribute address
|
302
|
+
# The person's address.
|
303
|
+
#
|
304
|
+
# @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address]
|
305
|
+
required :address, -> { Increase::Entity::Corporation::BeneficialOwner::Individual::Address }
|
306
|
+
|
307
|
+
# @!attribute date_of_birth
|
308
|
+
# The person's date of birth in YYYY-MM-DD format.
|
309
|
+
#
|
310
|
+
# @return [Date]
|
311
|
+
required :date_of_birth, Date
|
312
|
+
|
313
|
+
# @!attribute identification
|
314
|
+
# A means of verifying the person's identity.
|
315
|
+
#
|
316
|
+
# @return [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification]
|
317
|
+
required :identification,
|
318
|
+
-> { Increase::Entity::Corporation::BeneficialOwner::Individual::Identification }
|
319
|
+
|
320
|
+
# @!attribute name
|
321
|
+
# The person's legal name.
|
322
|
+
#
|
323
|
+
# @return [String]
|
324
|
+
required :name, String
|
325
|
+
|
326
|
+
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
327
|
+
# Personal details for the beneficial owner.
|
328
|
+
#
|
329
|
+
# @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] The person's address.
|
330
|
+
#
|
331
|
+
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
332
|
+
#
|
333
|
+
# @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] A means of verifying the person's identity.
|
334
|
+
#
|
335
|
+
# @param name [String] The person's legal name.
|
336
|
+
|
337
|
+
# @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#address
|
338
|
+
class Address < Increase::Internal::Type::BaseModel
|
339
|
+
# @!attribute city
|
340
|
+
# The city, district, town, or village of the address.
|
341
|
+
#
|
342
|
+
# @return [String, nil]
|
343
|
+
required :city, String, nil?: true
|
344
|
+
|
345
|
+
# @!attribute country
|
346
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
347
|
+
#
|
348
|
+
# @return [String]
|
349
|
+
required :country, String
|
350
|
+
|
351
|
+
# @!attribute line1
|
352
|
+
# The first line of the address.
|
353
|
+
#
|
354
|
+
# @return [String]
|
355
|
+
required :line1, String
|
356
|
+
|
357
|
+
# @!attribute line2
|
358
|
+
# The second line of the address.
|
359
|
+
#
|
360
|
+
# @return [String, nil]
|
361
|
+
required :line2, String, nil?: true
|
362
|
+
|
363
|
+
# @!attribute state
|
364
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
365
|
+
# state, province, or region of the address.
|
366
|
+
#
|
367
|
+
# @return [String, nil]
|
368
|
+
required :state, String, nil?: true
|
369
|
+
|
370
|
+
# @!attribute zip
|
371
|
+
# The ZIP or postal code of the address.
|
372
|
+
#
|
373
|
+
# @return [String, nil]
|
374
|
+
required :zip, String, nil?: true
|
375
|
+
|
376
|
+
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
377
|
+
# Some parameter documentations has been truncated, see
|
378
|
+
# {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address}
|
379
|
+
# for more details.
|
380
|
+
#
|
381
|
+
# The person's address.
|
382
|
+
#
|
383
|
+
# @param city [String, nil] The city, district, town, or village of the address.
|
384
|
+
#
|
385
|
+
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
386
|
+
#
|
387
|
+
# @param line1 [String] The first line of the address.
|
388
|
+
#
|
389
|
+
# @param line2 [String, nil] The second line of the address.
|
390
|
+
#
|
391
|
+
# @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
|
392
|
+
#
|
393
|
+
# @param zip [String, nil] The ZIP or postal code of the address.
|
394
|
+
end
|
395
|
+
|
396
|
+
# @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#identification
|
397
|
+
class Identification < Increase::Internal::Type::BaseModel
|
398
|
+
# @!attribute method_
|
399
|
+
# A method that can be used to verify the individual's identity.
|
400
|
+
#
|
401
|
+
# @return [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method]
|
402
|
+
required :method_,
|
403
|
+
enum: -> {
|
404
|
+
Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method
|
405
|
+
},
|
406
|
+
api_name: :method
|
407
|
+
|
408
|
+
# @!attribute number_last4
|
409
|
+
# The last 4 digits of the identification number that can be used to verify the
|
410
|
+
# individual's identity.
|
411
|
+
#
|
412
|
+
# @return [String]
|
413
|
+
required :number_last4, String
|
414
|
+
|
415
|
+
# @!method initialize(method_:, number_last4:)
|
416
|
+
# Some parameter documentations has been truncated, see
|
417
|
+
# {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification}
|
418
|
+
# for more details.
|
419
|
+
#
|
420
|
+
# A means of verifying the person's identity.
|
421
|
+
#
|
422
|
+
# @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
|
423
|
+
#
|
424
|
+
# @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
|
425
|
+
|
426
|
+
# A method that can be used to verify the individual's identity.
|
427
|
+
#
|
428
|
+
# @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification#method_
|
429
|
+
module Method
|
430
|
+
extend Increase::Internal::Type::Enum
|
431
|
+
|
432
|
+
# A social security number.
|
433
|
+
SOCIAL_SECURITY_NUMBER = :social_security_number
|
434
|
+
|
435
|
+
# An individual taxpayer identification number (ITIN).
|
436
|
+
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
437
|
+
|
438
|
+
# A passport number.
|
439
|
+
PASSPORT = :passport
|
440
|
+
|
441
|
+
# A driver's license number.
|
442
|
+
DRIVERS_LICENSE = :drivers_license
|
443
|
+
|
444
|
+
# Another identifying document.
|
445
|
+
OTHER = :other
|
446
|
+
|
447
|
+
# @!method self.values
|
448
|
+
# @return [Array<Symbol>]
|
449
|
+
end
|
450
|
+
end
|
451
|
+
end
|
452
|
+
|
453
|
+
# Why this person is considered a beneficial owner of the entity.
|
454
|
+
#
|
455
|
+
# @see Increase::Models::Entity::Corporation::BeneficialOwner#prong
|
456
|
+
module Prong
|
457
|
+
extend Increase::Internal::Type::Enum
|
458
|
+
|
459
|
+
# A person with 25% or greater direct or indirect ownership of the entity.
|
460
|
+
OWNERSHIP = :ownership
|
461
|
+
|
462
|
+
# A person who manages, directs, or has significant control of the entity.
|
463
|
+
CONTROL = :control
|
464
|
+
|
465
|
+
# @!method self.values
|
466
|
+
# @return [Array<Symbol>]
|
467
|
+
end
|
468
|
+
end
|
469
|
+
end
|
470
|
+
|
471
|
+
# @see Increase::Models::Entity#government_authority
|
472
|
+
class GovernmentAuthority < Increase::Internal::Type::BaseModel
|
473
|
+
# @!attribute address
|
474
|
+
# The government authority's address.
|
475
|
+
#
|
476
|
+
# @return [Increase::Models::Entity::GovernmentAuthority::Address]
|
477
|
+
required :address, -> { Increase::Entity::GovernmentAuthority::Address }
|
478
|
+
|
479
|
+
# @!attribute authorized_persons
|
480
|
+
# The identifying details of authorized persons of the government authority.
|
481
|
+
#
|
482
|
+
# @return [Array<Increase::Models::Entity::GovernmentAuthority::AuthorizedPerson>]
|
483
|
+
required :authorized_persons,
|
484
|
+
-> {
|
485
|
+
Increase::Internal::Type::ArrayOf[Increase::Entity::GovernmentAuthority::AuthorizedPerson]
|
486
|
+
}
|
487
|
+
|
488
|
+
# @!attribute category
|
489
|
+
# The category of the government authority.
|
490
|
+
#
|
491
|
+
# @return [Symbol, Increase::Models::Entity::GovernmentAuthority::Category]
|
492
|
+
required :category, enum: -> { Increase::Entity::GovernmentAuthority::Category }
|
493
|
+
|
494
|
+
# @!attribute name
|
495
|
+
# The government authority's name.
|
496
|
+
#
|
497
|
+
# @return [String]
|
498
|
+
required :name, String
|
499
|
+
|
500
|
+
# @!attribute tax_identifier
|
501
|
+
# The Employer Identification Number (EIN) of the government authority.
|
502
|
+
#
|
503
|
+
# @return [String, nil]
|
504
|
+
required :tax_identifier, String, nil?: true
|
505
|
+
|
506
|
+
# @!attribute website
|
507
|
+
# The government authority's website.
|
508
|
+
#
|
509
|
+
# @return [String, nil]
|
510
|
+
required :website, String, nil?: true
|
511
|
+
|
512
|
+
# @!method initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website:)
|
513
|
+
# Details of the government authority entity. Will be present if `structure` is
|
514
|
+
# equal to `government_authority`.
|
515
|
+
#
|
516
|
+
# @param address [Increase::Models::Entity::GovernmentAuthority::Address] The government authority's address.
|
517
|
+
#
|
518
|
+
# @param authorized_persons [Array<Increase::Models::Entity::GovernmentAuthority::AuthorizedPerson>] The identifying details of authorized persons of the government authority.
|
519
|
+
#
|
520
|
+
# @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category] The category of the government authority.
|
521
|
+
#
|
522
|
+
# @param name [String] The government authority's name.
|
523
|
+
#
|
524
|
+
# @param tax_identifier [String, nil] The Employer Identification Number (EIN) of the government authority.
|
525
|
+
#
|
526
|
+
# @param website [String, nil] The government authority's website.
|
527
|
+
|
528
|
+
# @see Increase::Models::Entity::GovernmentAuthority#address
|
529
|
+
class Address < Increase::Internal::Type::BaseModel
|
530
|
+
# @!attribute city
|
531
|
+
# The city of the address.
|
532
|
+
#
|
533
|
+
# @return [String]
|
534
|
+
required :city, String
|
535
|
+
|
536
|
+
# @!attribute line1
|
537
|
+
# The first line of the address.
|
538
|
+
#
|
539
|
+
# @return [String]
|
540
|
+
required :line1, String
|
541
|
+
|
542
|
+
# @!attribute line2
|
543
|
+
# The second line of the address.
|
544
|
+
#
|
545
|
+
# @return [String, nil]
|
546
|
+
required :line2, String, nil?: true
|
547
|
+
|
548
|
+
# @!attribute state
|
549
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
550
|
+
# the address.
|
551
|
+
#
|
552
|
+
# @return [String]
|
553
|
+
required :state, String
|
554
|
+
|
555
|
+
# @!attribute zip
|
556
|
+
# The ZIP code of the address.
|
557
|
+
#
|
558
|
+
# @return [String]
|
559
|
+
required :zip, String
|
560
|
+
|
561
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
562
|
+
# Some parameter documentations has been truncated, see
|
563
|
+
# {Increase::Models::Entity::GovernmentAuthority::Address} for more details.
|
564
|
+
#
|
565
|
+
# The government authority's address.
|
566
|
+
#
|
567
|
+
# @param city [String] The city of the address.
|
568
|
+
#
|
569
|
+
# @param line1 [String] The first line of the address.
|
570
|
+
#
|
571
|
+
# @param line2 [String, nil] The second line of the address.
|
572
|
+
#
|
573
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
574
|
+
#
|
575
|
+
# @param zip [String] The ZIP code of the address.
|
576
|
+
end
|
577
|
+
|
578
|
+
class AuthorizedPerson < Increase::Internal::Type::BaseModel
|
579
|
+
# @!attribute authorized_person_id
|
580
|
+
# The identifier of this authorized person.
|
581
|
+
#
|
582
|
+
# @return [String]
|
583
|
+
required :authorized_person_id, String
|
584
|
+
|
585
|
+
# @!attribute name
|
586
|
+
# The person's legal name.
|
587
|
+
#
|
588
|
+
# @return [String]
|
589
|
+
required :name, String
|
590
|
+
|
591
|
+
# @!method initialize(authorized_person_id:, name:)
|
592
|
+
# @param authorized_person_id [String] The identifier of this authorized person.
|
593
|
+
#
|
594
|
+
# @param name [String] The person's legal name.
|
595
|
+
end
|
596
|
+
|
597
|
+
# The category of the government authority.
|
598
|
+
#
|
599
|
+
# @see Increase::Models::Entity::GovernmentAuthority#category
|
600
|
+
module Category
|
601
|
+
extend Increase::Internal::Type::Enum
|
602
|
+
|
603
|
+
# The Public Entity is a Municipality.
|
604
|
+
MUNICIPALITY = :municipality
|
605
|
+
|
606
|
+
# @!method self.values
|
607
|
+
# @return [Array<Symbol>]
|
608
|
+
end
|
609
|
+
end
|
610
|
+
|
611
|
+
# @see Increase::Models::Entity#joint
|
612
|
+
class Joint < Increase::Internal::Type::BaseModel
|
613
|
+
# @!attribute individuals
|
614
|
+
# The two individuals that share control of the entity.
|
615
|
+
#
|
616
|
+
# @return [Array<Increase::Models::Entity::Joint::Individual>]
|
617
|
+
required :individuals, -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Joint::Individual] }
|
618
|
+
|
619
|
+
# @!attribute name
|
620
|
+
# The entity's name.
|
621
|
+
#
|
622
|
+
# @return [String]
|
623
|
+
required :name, String
|
624
|
+
|
625
|
+
# @!method initialize(individuals:, name:)
|
626
|
+
# Details of the joint entity. Will be present if `structure` is equal to `joint`.
|
627
|
+
#
|
628
|
+
# @param individuals [Array<Increase::Models::Entity::Joint::Individual>] The two individuals that share control of the entity.
|
629
|
+
#
|
630
|
+
# @param name [String] The entity's name.
|
631
|
+
|
632
|
+
class Individual < Increase::Internal::Type::BaseModel
|
633
|
+
# @!attribute address
|
634
|
+
# The person's address.
|
635
|
+
#
|
636
|
+
# @return [Increase::Models::Entity::Joint::Individual::Address]
|
637
|
+
required :address, -> { Increase::Entity::Joint::Individual::Address }
|
638
|
+
|
639
|
+
# @!attribute date_of_birth
|
640
|
+
# The person's date of birth in YYYY-MM-DD format.
|
641
|
+
#
|
642
|
+
# @return [Date]
|
643
|
+
required :date_of_birth, Date
|
644
|
+
|
645
|
+
# @!attribute identification
|
646
|
+
# A means of verifying the person's identity.
|
647
|
+
#
|
648
|
+
# @return [Increase::Models::Entity::Joint::Individual::Identification]
|
649
|
+
required :identification, -> { Increase::Entity::Joint::Individual::Identification }
|
650
|
+
|
651
|
+
# @!attribute name
|
652
|
+
# The person's legal name.
|
653
|
+
#
|
654
|
+
# @return [String]
|
655
|
+
required :name, String
|
656
|
+
|
657
|
+
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
658
|
+
# @param address [Increase::Models::Entity::Joint::Individual::Address] The person's address.
|
659
|
+
#
|
660
|
+
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
661
|
+
#
|
662
|
+
# @param identification [Increase::Models::Entity::Joint::Individual::Identification] A means of verifying the person's identity.
|
663
|
+
#
|
664
|
+
# @param name [String] The person's legal name.
|
665
|
+
|
666
|
+
# @see Increase::Models::Entity::Joint::Individual#address
|
667
|
+
class Address < Increase::Internal::Type::BaseModel
|
668
|
+
# @!attribute city
|
669
|
+
# The city of the address.
|
670
|
+
#
|
671
|
+
# @return [String]
|
672
|
+
required :city, String
|
673
|
+
|
674
|
+
# @!attribute line1
|
675
|
+
# The first line of the address.
|
676
|
+
#
|
677
|
+
# @return [String]
|
678
|
+
required :line1, String
|
679
|
+
|
680
|
+
# @!attribute line2
|
681
|
+
# The second line of the address.
|
682
|
+
#
|
683
|
+
# @return [String, nil]
|
684
|
+
required :line2, String, nil?: true
|
685
|
+
|
686
|
+
# @!attribute state
|
687
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
688
|
+
# the address.
|
689
|
+
#
|
690
|
+
# @return [String]
|
691
|
+
required :state, String
|
692
|
+
|
693
|
+
# @!attribute zip
|
694
|
+
# The ZIP code of the address.
|
695
|
+
#
|
696
|
+
# @return [String]
|
697
|
+
required :zip, String
|
698
|
+
|
699
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
700
|
+
# Some parameter documentations has been truncated, see
|
701
|
+
# {Increase::Models::Entity::Joint::Individual::Address} for more details.
|
702
|
+
#
|
703
|
+
# The person's address.
|
704
|
+
#
|
705
|
+
# @param city [String] The city of the address.
|
706
|
+
#
|
707
|
+
# @param line1 [String] The first line of the address.
|
708
|
+
#
|
709
|
+
# @param line2 [String, nil] The second line of the address.
|
710
|
+
#
|
711
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
712
|
+
#
|
713
|
+
# @param zip [String] The ZIP code of the address.
|
714
|
+
end
|
715
|
+
|
716
|
+
# @see Increase::Models::Entity::Joint::Individual#identification
|
717
|
+
class Identification < Increase::Internal::Type::BaseModel
|
718
|
+
# @!attribute method_
|
719
|
+
# A method that can be used to verify the individual's identity.
|
720
|
+
#
|
721
|
+
# @return [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method]
|
722
|
+
required :method_,
|
723
|
+
enum: -> { Increase::Entity::Joint::Individual::Identification::Method },
|
724
|
+
api_name: :method
|
725
|
+
|
726
|
+
# @!attribute number_last4
|
727
|
+
# The last 4 digits of the identification number that can be used to verify the
|
728
|
+
# individual's identity.
|
729
|
+
#
|
730
|
+
# @return [String]
|
731
|
+
required :number_last4, String
|
732
|
+
|
733
|
+
# @!method initialize(method_:, number_last4:)
|
734
|
+
# Some parameter documentations has been truncated, see
|
735
|
+
# {Increase::Models::Entity::Joint::Individual::Identification} for more details.
|
736
|
+
#
|
737
|
+
# A means of verifying the person's identity.
|
738
|
+
#
|
739
|
+
# @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] A method that can be used to verify the individual's identity.
|
740
|
+
#
|
741
|
+
# @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
|
742
|
+
|
743
|
+
# A method that can be used to verify the individual's identity.
|
744
|
+
#
|
745
|
+
# @see Increase::Models::Entity::Joint::Individual::Identification#method_
|
746
|
+
module Method
|
747
|
+
extend Increase::Internal::Type::Enum
|
748
|
+
|
749
|
+
# A social security number.
|
750
|
+
SOCIAL_SECURITY_NUMBER = :social_security_number
|
751
|
+
|
752
|
+
# An individual taxpayer identification number (ITIN).
|
753
|
+
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
754
|
+
|
755
|
+
# A passport number.
|
756
|
+
PASSPORT = :passport
|
757
|
+
|
758
|
+
# A driver's license number.
|
759
|
+
DRIVERS_LICENSE = :drivers_license
|
760
|
+
|
761
|
+
# Another identifying document.
|
762
|
+
OTHER = :other
|
763
|
+
|
764
|
+
# @!method self.values
|
765
|
+
# @return [Array<Symbol>]
|
766
|
+
end
|
767
|
+
end
|
768
|
+
end
|
769
|
+
end
|
770
|
+
|
771
|
+
# @see Increase::Models::Entity#natural_person
|
772
|
+
class NaturalPerson < Increase::Internal::Type::BaseModel
|
773
|
+
# @!attribute address
|
774
|
+
# The person's address.
|
775
|
+
#
|
776
|
+
# @return [Increase::Models::Entity::NaturalPerson::Address]
|
777
|
+
required :address, -> { Increase::Entity::NaturalPerson::Address }
|
778
|
+
|
779
|
+
# @!attribute date_of_birth
|
780
|
+
# The person's date of birth in YYYY-MM-DD format.
|
781
|
+
#
|
782
|
+
# @return [Date]
|
783
|
+
required :date_of_birth, Date
|
784
|
+
|
785
|
+
# @!attribute identification
|
786
|
+
# A means of verifying the person's identity.
|
787
|
+
#
|
788
|
+
# @return [Increase::Models::Entity::NaturalPerson::Identification]
|
789
|
+
required :identification, -> { Increase::Entity::NaturalPerson::Identification }
|
790
|
+
|
791
|
+
# @!attribute name
|
792
|
+
# The person's legal name.
|
793
|
+
#
|
794
|
+
# @return [String]
|
795
|
+
required :name, String
|
796
|
+
|
797
|
+
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
798
|
+
# Details of the natural person entity. Will be present if `structure` is equal to
|
799
|
+
# `natural_person`.
|
800
|
+
#
|
801
|
+
# @param address [Increase::Models::Entity::NaturalPerson::Address] The person's address.
|
802
|
+
#
|
803
|
+
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
804
|
+
#
|
805
|
+
# @param identification [Increase::Models::Entity::NaturalPerson::Identification] A means of verifying the person's identity.
|
806
|
+
#
|
807
|
+
# @param name [String] The person's legal name.
|
808
|
+
|
809
|
+
# @see Increase::Models::Entity::NaturalPerson#address
|
810
|
+
class Address < Increase::Internal::Type::BaseModel
|
811
|
+
# @!attribute city
|
812
|
+
# The city of the address.
|
813
|
+
#
|
814
|
+
# @return [String]
|
815
|
+
required :city, String
|
816
|
+
|
817
|
+
# @!attribute line1
|
818
|
+
# The first line of the address.
|
819
|
+
#
|
820
|
+
# @return [String]
|
821
|
+
required :line1, String
|
822
|
+
|
823
|
+
# @!attribute line2
|
824
|
+
# The second line of the address.
|
825
|
+
#
|
826
|
+
# @return [String, nil]
|
827
|
+
required :line2, String, nil?: true
|
828
|
+
|
829
|
+
# @!attribute state
|
830
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
831
|
+
# the address.
|
832
|
+
#
|
833
|
+
# @return [String]
|
834
|
+
required :state, String
|
835
|
+
|
836
|
+
# @!attribute zip
|
837
|
+
# The ZIP code of the address.
|
838
|
+
#
|
839
|
+
# @return [String]
|
840
|
+
required :zip, String
|
841
|
+
|
842
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
843
|
+
# Some parameter documentations has been truncated, see
|
844
|
+
# {Increase::Models::Entity::NaturalPerson::Address} for more details.
|
845
|
+
#
|
846
|
+
# The person's address.
|
847
|
+
#
|
848
|
+
# @param city [String] The city of the address.
|
849
|
+
#
|
850
|
+
# @param line1 [String] The first line of the address.
|
851
|
+
#
|
852
|
+
# @param line2 [String, nil] The second line of the address.
|
853
|
+
#
|
854
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
855
|
+
#
|
856
|
+
# @param zip [String] The ZIP code of the address.
|
857
|
+
end
|
858
|
+
|
859
|
+
# @see Increase::Models::Entity::NaturalPerson#identification
|
860
|
+
class Identification < Increase::Internal::Type::BaseModel
|
861
|
+
# @!attribute method_
|
862
|
+
# A method that can be used to verify the individual's identity.
|
863
|
+
#
|
864
|
+
# @return [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method]
|
865
|
+
required :method_,
|
866
|
+
enum: -> {
|
867
|
+
Increase::Entity::NaturalPerson::Identification::Method
|
868
|
+
},
|
869
|
+
api_name: :method
|
870
|
+
|
871
|
+
# @!attribute number_last4
|
872
|
+
# The last 4 digits of the identification number that can be used to verify the
|
873
|
+
# individual's identity.
|
874
|
+
#
|
875
|
+
# @return [String]
|
876
|
+
required :number_last4, String
|
877
|
+
|
878
|
+
# @!method initialize(method_:, number_last4:)
|
879
|
+
# Some parameter documentations has been truncated, see
|
880
|
+
# {Increase::Models::Entity::NaturalPerson::Identification} for more details.
|
881
|
+
#
|
882
|
+
# A means of verifying the person's identity.
|
883
|
+
#
|
884
|
+
# @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity.
|
885
|
+
#
|
886
|
+
# @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
|
887
|
+
|
888
|
+
# A method that can be used to verify the individual's identity.
|
889
|
+
#
|
890
|
+
# @see Increase::Models::Entity::NaturalPerson::Identification#method_
|
891
|
+
module Method
|
892
|
+
extend Increase::Internal::Type::Enum
|
893
|
+
|
894
|
+
# A social security number.
|
895
|
+
SOCIAL_SECURITY_NUMBER = :social_security_number
|
896
|
+
|
897
|
+
# An individual taxpayer identification number (ITIN).
|
898
|
+
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
899
|
+
|
900
|
+
# A passport number.
|
901
|
+
PASSPORT = :passport
|
902
|
+
|
903
|
+
# A driver's license number.
|
904
|
+
DRIVERS_LICENSE = :drivers_license
|
905
|
+
|
906
|
+
# Another identifying document.
|
907
|
+
OTHER = :other
|
908
|
+
|
909
|
+
# @!method self.values
|
910
|
+
# @return [Array<Symbol>]
|
911
|
+
end
|
912
|
+
end
|
913
|
+
end
|
914
|
+
|
915
|
+
# The status of the entity.
|
916
|
+
#
|
917
|
+
# @see Increase::Models::Entity#status
|
918
|
+
module Status
|
919
|
+
extend Increase::Internal::Type::Enum
|
920
|
+
|
921
|
+
# The entity is active.
|
922
|
+
ACTIVE = :active
|
923
|
+
|
924
|
+
# The entity is archived, and can no longer be used to create accounts.
|
925
|
+
ARCHIVED = :archived
|
926
|
+
|
927
|
+
# The entity is temporarily disabled and cannot be used for financial activity.
|
928
|
+
DISABLED = :disabled
|
929
|
+
|
930
|
+
# @!method self.values
|
931
|
+
# @return [Array<Symbol>]
|
932
|
+
end
|
933
|
+
|
934
|
+
# The entity's legal structure.
|
935
|
+
#
|
936
|
+
# @see Increase::Models::Entity#structure
|
937
|
+
module Structure
|
938
|
+
extend Increase::Internal::Type::Enum
|
939
|
+
|
940
|
+
# A corporation.
|
941
|
+
CORPORATION = :corporation
|
942
|
+
|
943
|
+
# An individual person.
|
944
|
+
NATURAL_PERSON = :natural_person
|
945
|
+
|
946
|
+
# Multiple individual people.
|
947
|
+
JOINT = :joint
|
948
|
+
|
949
|
+
# A trust.
|
950
|
+
TRUST = :trust
|
951
|
+
|
952
|
+
# A government authority.
|
953
|
+
GOVERNMENT_AUTHORITY = :government_authority
|
954
|
+
|
955
|
+
# @!method self.values
|
956
|
+
# @return [Array<Symbol>]
|
957
|
+
end
|
958
|
+
|
959
|
+
# @see Increase::Models::Entity#third_party_verification
|
960
|
+
class ThirdPartyVerification < Increase::Internal::Type::BaseModel
|
961
|
+
# @!attribute reference
|
962
|
+
# The reference identifier for the third party verification.
|
963
|
+
#
|
964
|
+
# @return [String]
|
965
|
+
required :reference, String
|
966
|
+
|
967
|
+
# @!attribute vendor
|
968
|
+
# The vendor that was used to perform the verification.
|
969
|
+
#
|
970
|
+
# @return [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor]
|
971
|
+
required :vendor, enum: -> { Increase::Entity::ThirdPartyVerification::Vendor }
|
972
|
+
|
973
|
+
# @!method initialize(reference:, vendor:)
|
974
|
+
# A reference to data stored in a third-party verification service. Your
|
975
|
+
# integration may or may not use this field.
|
976
|
+
#
|
977
|
+
# @param reference [String] The reference identifier for the third party verification.
|
978
|
+
#
|
979
|
+
# @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
|
980
|
+
|
981
|
+
# The vendor that was used to perform the verification.
|
982
|
+
#
|
983
|
+
# @see Increase::Models::Entity::ThirdPartyVerification#vendor
|
984
|
+
module Vendor
|
985
|
+
extend Increase::Internal::Type::Enum
|
986
|
+
|
987
|
+
# Alloy. See https://alloy.com for more information.
|
988
|
+
ALLOY = :alloy
|
989
|
+
|
990
|
+
# Middesk. See https://middesk.com for more information.
|
991
|
+
MIDDESK = :middesk
|
992
|
+
|
993
|
+
# Oscilar. See https://oscilar.com for more information.
|
994
|
+
OSCILAR = :oscilar
|
995
|
+
|
996
|
+
# @!method self.values
|
997
|
+
# @return [Array<Symbol>]
|
998
|
+
end
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# @see Increase::Models::Entity#trust
|
1002
|
+
class Trust < Increase::Internal::Type::BaseModel
|
1003
|
+
# @!attribute address
|
1004
|
+
# The trust's address.
|
1005
|
+
#
|
1006
|
+
# @return [Increase::Models::Entity::Trust::Address]
|
1007
|
+
required :address, -> { Increase::Entity::Trust::Address }
|
1008
|
+
|
1009
|
+
# @!attribute category
|
1010
|
+
# Whether the trust is `revocable` or `irrevocable`.
|
1011
|
+
#
|
1012
|
+
# @return [Symbol, Increase::Models::Entity::Trust::Category]
|
1013
|
+
required :category, enum: -> { Increase::Entity::Trust::Category }
|
1014
|
+
|
1015
|
+
# @!attribute formation_document_file_id
|
1016
|
+
# The ID for the File containing the formation document of the trust.
|
1017
|
+
#
|
1018
|
+
# @return [String, nil]
|
1019
|
+
required :formation_document_file_id, String, nil?: true
|
1020
|
+
|
1021
|
+
# @!attribute formation_state
|
1022
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state in
|
1023
|
+
# which the trust was formed.
|
1024
|
+
#
|
1025
|
+
# @return [String, nil]
|
1026
|
+
required :formation_state, String, nil?: true
|
1027
|
+
|
1028
|
+
# @!attribute grantor
|
1029
|
+
# The grantor of the trust. Will be present if the `category` is `revocable`.
|
1030
|
+
#
|
1031
|
+
# @return [Increase::Models::Entity::Trust::Grantor, nil]
|
1032
|
+
required :grantor, -> { Increase::Entity::Trust::Grantor }, nil?: true
|
1033
|
+
|
1034
|
+
# @!attribute name
|
1035
|
+
# The trust's name.
|
1036
|
+
#
|
1037
|
+
# @return [String]
|
1038
|
+
required :name, String
|
1039
|
+
|
1040
|
+
# @!attribute tax_identifier
|
1041
|
+
# The Employer Identification Number (EIN) of the trust itself.
|
1042
|
+
#
|
1043
|
+
# @return [String, nil]
|
1044
|
+
required :tax_identifier, String, nil?: true
|
1045
|
+
|
1046
|
+
# @!attribute trustees
|
1047
|
+
# The trustees of the trust.
|
1048
|
+
#
|
1049
|
+
# @return [Array<Increase::Models::Entity::Trust::Trustee>]
|
1050
|
+
required :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Trust::Trustee] }
|
1051
|
+
|
1052
|
+
# @!method initialize(address:, category:, formation_document_file_id:, formation_state:, grantor:, name:, tax_identifier:, trustees:)
|
1053
|
+
# Some parameter documentations has been truncated, see
|
1054
|
+
# {Increase::Models::Entity::Trust} for more details.
|
1055
|
+
#
|
1056
|
+
# Details of the trust entity. Will be present if `structure` is equal to `trust`.
|
1057
|
+
#
|
1058
|
+
# @param address [Increase::Models::Entity::Trust::Address] The trust's address.
|
1059
|
+
#
|
1060
|
+
# @param category [Symbol, Increase::Models::Entity::Trust::Category] Whether the trust is `revocable` or `irrevocable`.
|
1061
|
+
#
|
1062
|
+
# @param formation_document_file_id [String, nil] The ID for the File containing the formation document of the trust.
|
1063
|
+
#
|
1064
|
+
# @param formation_state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the state in
|
1065
|
+
#
|
1066
|
+
# @param grantor [Increase::Models::Entity::Trust::Grantor, nil] The grantor of the trust. Will be present if the `category` is `revocable`.
|
1067
|
+
#
|
1068
|
+
# @param name [String] The trust's name.
|
1069
|
+
#
|
1070
|
+
# @param tax_identifier [String, nil] The Employer Identification Number (EIN) of the trust itself.
|
1071
|
+
#
|
1072
|
+
# @param trustees [Array<Increase::Models::Entity::Trust::Trustee>] The trustees of the trust.
|
1073
|
+
|
1074
|
+
# @see Increase::Models::Entity::Trust#address
|
1075
|
+
class Address < Increase::Internal::Type::BaseModel
|
1076
|
+
# @!attribute city
|
1077
|
+
# The city of the address.
|
1078
|
+
#
|
1079
|
+
# @return [String]
|
1080
|
+
required :city, String
|
1081
|
+
|
1082
|
+
# @!attribute line1
|
1083
|
+
# The first line of the address.
|
1084
|
+
#
|
1085
|
+
# @return [String]
|
1086
|
+
required :line1, String
|
1087
|
+
|
1088
|
+
# @!attribute line2
|
1089
|
+
# The second line of the address.
|
1090
|
+
#
|
1091
|
+
# @return [String, nil]
|
1092
|
+
required :line2, String, nil?: true
|
1093
|
+
|
1094
|
+
# @!attribute state
|
1095
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
1096
|
+
# the address.
|
1097
|
+
#
|
1098
|
+
# @return [String]
|
1099
|
+
required :state, String
|
1100
|
+
|
1101
|
+
# @!attribute zip
|
1102
|
+
# The ZIP code of the address.
|
1103
|
+
#
|
1104
|
+
# @return [String]
|
1105
|
+
required :zip, String
|
1106
|
+
|
1107
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
1108
|
+
# Some parameter documentations has been truncated, see
|
1109
|
+
# {Increase::Models::Entity::Trust::Address} for more details.
|
1110
|
+
#
|
1111
|
+
# The trust's address.
|
1112
|
+
#
|
1113
|
+
# @param city [String] The city of the address.
|
1114
|
+
#
|
1115
|
+
# @param line1 [String] The first line of the address.
|
1116
|
+
#
|
1117
|
+
# @param line2 [String, nil] The second line of the address.
|
1118
|
+
#
|
1119
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
1120
|
+
#
|
1121
|
+
# @param zip [String] The ZIP code of the address.
|
1122
|
+
end
|
1123
|
+
|
1124
|
+
# Whether the trust is `revocable` or `irrevocable`.
|
1125
|
+
#
|
1126
|
+
# @see Increase::Models::Entity::Trust#category
|
1127
|
+
module Category
|
1128
|
+
extend Increase::Internal::Type::Enum
|
1129
|
+
|
1130
|
+
# The trust is revocable by the grantor.
|
1131
|
+
REVOCABLE = :revocable
|
1132
|
+
|
1133
|
+
# The trust cannot be revoked.
|
1134
|
+
IRREVOCABLE = :irrevocable
|
1135
|
+
|
1136
|
+
# @!method self.values
|
1137
|
+
# @return [Array<Symbol>]
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# @see Increase::Models::Entity::Trust#grantor
|
1141
|
+
class Grantor < Increase::Internal::Type::BaseModel
|
1142
|
+
# @!attribute address
|
1143
|
+
# The person's address.
|
1144
|
+
#
|
1145
|
+
# @return [Increase::Models::Entity::Trust::Grantor::Address]
|
1146
|
+
required :address, -> { Increase::Entity::Trust::Grantor::Address }
|
1147
|
+
|
1148
|
+
# @!attribute date_of_birth
|
1149
|
+
# The person's date of birth in YYYY-MM-DD format.
|
1150
|
+
#
|
1151
|
+
# @return [Date]
|
1152
|
+
required :date_of_birth, Date
|
1153
|
+
|
1154
|
+
# @!attribute identification
|
1155
|
+
# A means of verifying the person's identity.
|
1156
|
+
#
|
1157
|
+
# @return [Increase::Models::Entity::Trust::Grantor::Identification]
|
1158
|
+
required :identification, -> { Increase::Entity::Trust::Grantor::Identification }
|
1159
|
+
|
1160
|
+
# @!attribute name
|
1161
|
+
# The person's legal name.
|
1162
|
+
#
|
1163
|
+
# @return [String]
|
1164
|
+
required :name, String
|
1165
|
+
|
1166
|
+
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
1167
|
+
# The grantor of the trust. Will be present if the `category` is `revocable`.
|
1168
|
+
#
|
1169
|
+
# @param address [Increase::Models::Entity::Trust::Grantor::Address] The person's address.
|
1170
|
+
#
|
1171
|
+
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
1172
|
+
#
|
1173
|
+
# @param identification [Increase::Models::Entity::Trust::Grantor::Identification] A means of verifying the person's identity.
|
1174
|
+
#
|
1175
|
+
# @param name [String] The person's legal name.
|
1176
|
+
|
1177
|
+
# @see Increase::Models::Entity::Trust::Grantor#address
|
1178
|
+
class Address < Increase::Internal::Type::BaseModel
|
1179
|
+
# @!attribute city
|
1180
|
+
# The city of the address.
|
1181
|
+
#
|
1182
|
+
# @return [String]
|
1183
|
+
required :city, String
|
1184
|
+
|
1185
|
+
# @!attribute line1
|
1186
|
+
# The first line of the address.
|
1187
|
+
#
|
1188
|
+
# @return [String]
|
1189
|
+
required :line1, String
|
1190
|
+
|
1191
|
+
# @!attribute line2
|
1192
|
+
# The second line of the address.
|
1193
|
+
#
|
1194
|
+
# @return [String, nil]
|
1195
|
+
required :line2, String, nil?: true
|
1196
|
+
|
1197
|
+
# @!attribute state
|
1198
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
1199
|
+
# the address.
|
1200
|
+
#
|
1201
|
+
# @return [String]
|
1202
|
+
required :state, String
|
1203
|
+
|
1204
|
+
# @!attribute zip
|
1205
|
+
# The ZIP code of the address.
|
1206
|
+
#
|
1207
|
+
# @return [String]
|
1208
|
+
required :zip, String
|
1209
|
+
|
1210
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
1211
|
+
# Some parameter documentations has been truncated, see
|
1212
|
+
# {Increase::Models::Entity::Trust::Grantor::Address} for more details.
|
1213
|
+
#
|
1214
|
+
# The person's address.
|
1215
|
+
#
|
1216
|
+
# @param city [String] The city of the address.
|
1217
|
+
#
|
1218
|
+
# @param line1 [String] The first line of the address.
|
1219
|
+
#
|
1220
|
+
# @param line2 [String, nil] The second line of the address.
|
1221
|
+
#
|
1222
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
1223
|
+
#
|
1224
|
+
# @param zip [String] The ZIP code of the address.
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
# @see Increase::Models::Entity::Trust::Grantor#identification
|
1228
|
+
class Identification < Increase::Internal::Type::BaseModel
|
1229
|
+
# @!attribute method_
|
1230
|
+
# A method that can be used to verify the individual's identity.
|
1231
|
+
#
|
1232
|
+
# @return [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method]
|
1233
|
+
required :method_,
|
1234
|
+
enum: -> { Increase::Entity::Trust::Grantor::Identification::Method },
|
1235
|
+
api_name: :method
|
1236
|
+
|
1237
|
+
# @!attribute number_last4
|
1238
|
+
# The last 4 digits of the identification number that can be used to verify the
|
1239
|
+
# individual's identity.
|
1240
|
+
#
|
1241
|
+
# @return [String]
|
1242
|
+
required :number_last4, String
|
1243
|
+
|
1244
|
+
# @!method initialize(method_:, number_last4:)
|
1245
|
+
# Some parameter documentations has been truncated, see
|
1246
|
+
# {Increase::Models::Entity::Trust::Grantor::Identification} for more details.
|
1247
|
+
#
|
1248
|
+
# A means of verifying the person's identity.
|
1249
|
+
#
|
1250
|
+
# @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method] A method that can be used to verify the individual's identity.
|
1251
|
+
#
|
1252
|
+
# @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
|
1253
|
+
|
1254
|
+
# A method that can be used to verify the individual's identity.
|
1255
|
+
#
|
1256
|
+
# @see Increase::Models::Entity::Trust::Grantor::Identification#method_
|
1257
|
+
module Method
|
1258
|
+
extend Increase::Internal::Type::Enum
|
1259
|
+
|
1260
|
+
# A social security number.
|
1261
|
+
SOCIAL_SECURITY_NUMBER = :social_security_number
|
1262
|
+
|
1263
|
+
# An individual taxpayer identification number (ITIN).
|
1264
|
+
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
1265
|
+
|
1266
|
+
# A passport number.
|
1267
|
+
PASSPORT = :passport
|
1268
|
+
|
1269
|
+
# A driver's license number.
|
1270
|
+
DRIVERS_LICENSE = :drivers_license
|
1271
|
+
|
1272
|
+
# Another identifying document.
|
1273
|
+
OTHER = :other
|
1274
|
+
|
1275
|
+
# @!method self.values
|
1276
|
+
# @return [Array<Symbol>]
|
1277
|
+
end
|
1278
|
+
end
|
1279
|
+
end
|
1280
|
+
|
1281
|
+
class Trustee < Increase::Internal::Type::BaseModel
|
1282
|
+
# @!attribute individual
|
1283
|
+
# The individual trustee of the trust. Will be present if the trustee's
|
1284
|
+
# `structure` is equal to `individual`.
|
1285
|
+
#
|
1286
|
+
# @return [Increase::Models::Entity::Trust::Trustee::Individual, nil]
|
1287
|
+
required :individual, -> { Increase::Entity::Trust::Trustee::Individual }, nil?: true
|
1288
|
+
|
1289
|
+
# @!attribute structure
|
1290
|
+
# The structure of the trustee. Will always be equal to `individual`.
|
1291
|
+
#
|
1292
|
+
# @return [Symbol, Increase::Models::Entity::Trust::Trustee::Structure]
|
1293
|
+
required :structure, enum: -> { Increase::Entity::Trust::Trustee::Structure }
|
1294
|
+
|
1295
|
+
# @!method initialize(individual:, structure:)
|
1296
|
+
# Some parameter documentations has been truncated, see
|
1297
|
+
# {Increase::Models::Entity::Trust::Trustee} for more details.
|
1298
|
+
#
|
1299
|
+
# @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil] The individual trustee of the trust. Will be present if the trustee's `structure
|
1300
|
+
#
|
1301
|
+
# @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] The structure of the trustee. Will always be equal to `individual`.
|
1302
|
+
|
1303
|
+
# @see Increase::Models::Entity::Trust::Trustee#individual
|
1304
|
+
class Individual < Increase::Internal::Type::BaseModel
|
1305
|
+
# @!attribute address
|
1306
|
+
# The person's address.
|
1307
|
+
#
|
1308
|
+
# @return [Increase::Models::Entity::Trust::Trustee::Individual::Address]
|
1309
|
+
required :address, -> { Increase::Entity::Trust::Trustee::Individual::Address }
|
1310
|
+
|
1311
|
+
# @!attribute date_of_birth
|
1312
|
+
# The person's date of birth in YYYY-MM-DD format.
|
1313
|
+
#
|
1314
|
+
# @return [Date]
|
1315
|
+
required :date_of_birth, Date
|
1316
|
+
|
1317
|
+
# @!attribute identification
|
1318
|
+
# A means of verifying the person's identity.
|
1319
|
+
#
|
1320
|
+
# @return [Increase::Models::Entity::Trust::Trustee::Individual::Identification]
|
1321
|
+
required :identification, -> { Increase::Entity::Trust::Trustee::Individual::Identification }
|
1322
|
+
|
1323
|
+
# @!attribute name
|
1324
|
+
# The person's legal name.
|
1325
|
+
#
|
1326
|
+
# @return [String]
|
1327
|
+
required :name, String
|
1328
|
+
|
1329
|
+
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
1330
|
+
# The individual trustee of the trust. Will be present if the trustee's
|
1331
|
+
# `structure` is equal to `individual`.
|
1332
|
+
#
|
1333
|
+
# @param address [Increase::Models::Entity::Trust::Trustee::Individual::Address] The person's address.
|
1334
|
+
#
|
1335
|
+
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
1336
|
+
#
|
1337
|
+
# @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification] A means of verifying the person's identity.
|
1338
|
+
#
|
1339
|
+
# @param name [String] The person's legal name.
|
1340
|
+
|
1341
|
+
# @see Increase::Models::Entity::Trust::Trustee::Individual#address
|
1342
|
+
class Address < Increase::Internal::Type::BaseModel
|
1343
|
+
# @!attribute city
|
1344
|
+
# The city of the address.
|
1345
|
+
#
|
1346
|
+
# @return [String]
|
1347
|
+
required :city, String
|
1348
|
+
|
1349
|
+
# @!attribute line1
|
1350
|
+
# The first line of the address.
|
1351
|
+
#
|
1352
|
+
# @return [String]
|
1353
|
+
required :line1, String
|
1354
|
+
|
1355
|
+
# @!attribute line2
|
1356
|
+
# The second line of the address.
|
1357
|
+
#
|
1358
|
+
# @return [String, nil]
|
1359
|
+
required :line2, String, nil?: true
|
1360
|
+
|
1361
|
+
# @!attribute state
|
1362
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
1363
|
+
# the address.
|
1364
|
+
#
|
1365
|
+
# @return [String]
|
1366
|
+
required :state, String
|
1367
|
+
|
1368
|
+
# @!attribute zip
|
1369
|
+
# The ZIP code of the address.
|
1370
|
+
#
|
1371
|
+
# @return [String]
|
1372
|
+
required :zip, String
|
1373
|
+
|
1374
|
+
# @!method initialize(city:, line1:, line2:, state:, zip:)
|
1375
|
+
# Some parameter documentations has been truncated, see
|
1376
|
+
# {Increase::Models::Entity::Trust::Trustee::Individual::Address} for more
|
1377
|
+
# details.
|
1378
|
+
#
|
1379
|
+
# The person's address.
|
1380
|
+
#
|
1381
|
+
# @param city [String] The city of the address.
|
1382
|
+
#
|
1383
|
+
# @param line1 [String] The first line of the address.
|
1384
|
+
#
|
1385
|
+
# @param line2 [String, nil] The second line of the address.
|
1386
|
+
#
|
1387
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
|
1388
|
+
#
|
1389
|
+
# @param zip [String] The ZIP code of the address.
|
1390
|
+
end
|
1391
|
+
|
1392
|
+
# @see Increase::Models::Entity::Trust::Trustee::Individual#identification
|
1393
|
+
class Identification < Increase::Internal::Type::BaseModel
|
1394
|
+
# @!attribute method_
|
1395
|
+
# A method that can be used to verify the individual's identity.
|
1396
|
+
#
|
1397
|
+
# @return [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method]
|
1398
|
+
required :method_,
|
1399
|
+
enum: -> { Increase::Entity::Trust::Trustee::Individual::Identification::Method },
|
1400
|
+
api_name: :method
|
1401
|
+
|
1402
|
+
# @!attribute number_last4
|
1403
|
+
# The last 4 digits of the identification number that can be used to verify the
|
1404
|
+
# individual's identity.
|
1405
|
+
#
|
1406
|
+
# @return [String]
|
1407
|
+
required :number_last4, String
|
1408
|
+
|
1409
|
+
# @!method initialize(method_:, number_last4:)
|
1410
|
+
# Some parameter documentations has been truncated, see
|
1411
|
+
# {Increase::Models::Entity::Trust::Trustee::Individual::Identification} for more
|
1412
|
+
# details.
|
1413
|
+
#
|
1414
|
+
# A means of verifying the person's identity.
|
1415
|
+
#
|
1416
|
+
# @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method] A method that can be used to verify the individual's identity.
|
1417
|
+
#
|
1418
|
+
# @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
|
1419
|
+
|
1420
|
+
# A method that can be used to verify the individual's identity.
|
1421
|
+
#
|
1422
|
+
# @see Increase::Models::Entity::Trust::Trustee::Individual::Identification#method_
|
1423
|
+
module Method
|
1424
|
+
extend Increase::Internal::Type::Enum
|
1425
|
+
|
1426
|
+
# A social security number.
|
1427
|
+
SOCIAL_SECURITY_NUMBER = :social_security_number
|
1428
|
+
|
1429
|
+
# An individual taxpayer identification number (ITIN).
|
1430
|
+
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
1431
|
+
|
1432
|
+
# A passport number.
|
1433
|
+
PASSPORT = :passport
|
1434
|
+
|
1435
|
+
# A driver's license number.
|
1436
|
+
DRIVERS_LICENSE = :drivers_license
|
1437
|
+
|
1438
|
+
# Another identifying document.
|
1439
|
+
OTHER = :other
|
1440
|
+
|
1441
|
+
# @!method self.values
|
1442
|
+
# @return [Array<Symbol>]
|
1443
|
+
end
|
1444
|
+
end
|
1445
|
+
end
|
1446
|
+
|
1447
|
+
# The structure of the trustee. Will always be equal to `individual`.
|
1448
|
+
#
|
1449
|
+
# @see Increase::Models::Entity::Trust::Trustee#structure
|
1450
|
+
module Structure
|
1451
|
+
extend Increase::Internal::Type::Enum
|
1452
|
+
|
1453
|
+
# The trustee is an individual.
|
1454
|
+
INDIVIDUAL = :individual
|
1455
|
+
|
1456
|
+
# @!method self.values
|
1457
|
+
# @return [Array<Symbol>]
|
1458
|
+
end
|
1459
|
+
end
|
1460
|
+
end
|
1461
|
+
|
1462
|
+
# A constant representing the object's type. For this resource it will always be
|
1463
|
+
# `entity`.
|
1464
|
+
#
|
1465
|
+
# @see Increase::Models::Entity#type
|
1466
|
+
module Type
|
1467
|
+
extend Increase::Internal::Type::Enum
|
1468
|
+
|
1469
|
+
ENTITY = :entity
|
1470
|
+
|
1471
|
+
# @!method self.values
|
1472
|
+
# @return [Array<Symbol>]
|
1473
|
+
end
|
1474
|
+
end
|
1475
|
+
end
|
1476
|
+
end
|