Class: Increase::Resources::ExternalAccounts

Inherits:

Object

• Object
• Increase::Resources::ExternalAccounts

Defined in:

lib/increase/resources/external_accounts.rb,
sig/increase/resources/external_accounts.rbs

Instance Method Summary

• #create(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {}) ⇒ Increase::Models::ExternalAccount

  Create an External Account.

• #initialize(client:) ⇒ ExternalAccounts constructor private

  A new instance of ExternalAccounts.

• #list(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::ExternalAccount>

  List External Accounts.

• #retrieve(external_account_id, request_options: {}) ⇒ Increase::Models::ExternalAccount

  Retrieve an External Account.

• #update(external_account_id, account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}) ⇒ Increase::Models::ExternalAccount

  Update an External Account.

Constructor Details

#initialize(client:) ⇒ ExternalAccounts

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ExternalAccounts.

Parameters:

• client (Increase::Client)
• client: (Increase::Client)

# File 'lib/increase/resources/external_accounts.rb', line 134

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {}) ⇒ Increase::Models::ExternalAccount

Create an External Account

Parameters:

• account_number (String) —

  The account number for the destination account.

• description (String) —

  The name you choose for the Account.

• routing_number (String) —

  The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

• account_holder (Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder) —

  The type of entity that owns the External Account.

• funding (Symbol, Increase::Models::ExternalAccountCreateParams::Funding) —

  The type of the destination account. Defaults to checking.

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Models::ExternalAccount)

See Also:

• Models::ExternalAccountCreateParams

# File 'lib/increase/resources/external_accounts.rb', line 29

def create(params)
  parsed, options = Increase::ExternalAccountCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "external_accounts",
    body: parsed,
    model: Increase::ExternalAccount,
    options: options
  )
end

#list(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::ExternalAccount>

List External Accounts

Parameters:

• cursor (String) —

  Return the page of entries after this one.

• idempotency_key (String) —

  Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

• limit (Integer) —

  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

• routing_number (String) —

  Filter External Accounts to those with the specified Routing Number.

• status (Increase::Models::ExternalAccountListParams::Status)
• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Internal::Page<Increase::Models::ExternalAccount>)

See Also:

• Models::ExternalAccountListParams

# File 'lib/increase/resources/external_accounts.rb', line 118

def list(params = {})
  parsed, options = Increase::ExternalAccountListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "external_accounts",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::ExternalAccount,
    options: options
  )
end

#retrieve(external_account_id, request_options: {}) ⇒ Increase::Models::ExternalAccount

Retrieve an External Account

Parameters:

• external_account_id (String) —

  The identifier of the External Account.

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Models::ExternalAccount)

See Also:

• Models::ExternalAccountRetrieveParams

# File 'lib/increase/resources/external_accounts.rb', line 51

def retrieve(external_account_id, params = {})
  @client.request(
    method: :get,
    path: ["external_accounts/%1$s", external_account_id],
    model: Increase::ExternalAccount,
    options: params[:request_options]
  )
end

#update(external_account_id, account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}) ⇒ Increase::Models::ExternalAccount

Update an External Account

Parameters:

• external_account_id (String) —

  The external account identifier.

• account_holder (Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder) —

  The type of entity that owns the External Account.

• description (String) —

  The description you choose to give the external account.

• funding (Symbol, Increase::Models::ExternalAccountUpdateParams::Funding) —

  The funding type of the External Account.

• status (Symbol, Increase::Models::ExternalAccountUpdateParams::Status) —

  The status of the External Account.

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Models::ExternalAccount)

See Also:

• Models::ExternalAccountUpdateParams

# File 'lib/increase/resources/external_accounts.rb', line 82

def update(external_account_id, params = {})
  parsed, options = Increase::ExternalAccountUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["external_accounts/%1$s", external_account_id],
    body: parsed,
    model: Increase::ExternalAccount,
    options: options
  )
end