Class: Increase::Resources::AccountNumbers

Inherits:

Object

• Object
• Increase::Resources::AccountNumbers

Defined in:

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

Instance Method Summary

• #create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}) ⇒ Increase::Models::AccountNumber

  Create an Account Number.

• #initialize(client:) ⇒ AccountNumbers constructor private

  A new instance of AccountNumbers.

• #list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::AccountNumber>

  List Account Numbers.

• #retrieve(account_number_id, request_options: {}) ⇒ Increase::Models::AccountNumber

  Retrieve an Account Number.

• #update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}) ⇒ Increase::Models::AccountNumber

  Update an Account Number.

Constructor Details

#initialize(client:) ⇒ AccountNumbers

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 AccountNumbers.

Parameters:

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

# File 'lib/increase/resources/account_numbers.rb', line 136

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}) ⇒ Increase::Models::AccountNumber

Create an Account Number

Parameters:

• account_id (String) —

  The Account the Account Number should belong to.

• name (String) —

  The name you choose for the Account Number.

• inbound_ach (Increase::Models::AccountNumberCreateParams::InboundACH) —

  Options related to how this Account Number should handle inbound ACH transfers.

• inbound_checks (Increase::Models::AccountNumberCreateParams::InboundChecks) —

  Options related to how this Account Number should handle inbound check withdrawals.

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

Returns:

• (Increase::Models::AccountNumber)

See Also:

• Models::AccountNumberCreateParams

# File 'lib/increase/resources/account_numbers.rb', line 26

def create(params)
  parsed, options = Increase::AccountNumberCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "account_numbers",
    body: parsed,
    model: Increase::AccountNumber,
    options: options
  )
end

#list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::AccountNumber>

List Account Numbers

Parameters:

• account_id (String) —

  Filter Account Numbers to those belonging to the specified Account.

• ach_debit_status (Increase::Models::AccountNumberListParams::ACHDebitStatus)
• created_at (Increase::Models::AccountNumberListParams::CreatedAt)
• 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.

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

Returns:

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

See Also:

• Models::AccountNumberListParams

# File 'lib/increase/resources/account_numbers.rb', line 120

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

#retrieve(account_number_id, request_options: {}) ⇒ Increase::Models::AccountNumber

Retrieve an Account Number

Parameters:

• account_number_id (String) —

  The identifier of the Account Number to retrieve.

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

Returns:

• (Increase::Models::AccountNumber)

See Also:

• Models::AccountNumberRetrieveParams

# File 'lib/increase/resources/account_numbers.rb', line 48

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

#update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}) ⇒ Increase::Models::AccountNumber

Update an Account Number

Parameters:

• account_number_id (String) —

  The identifier of the Account Number.

• inbound_ach (Increase::Models::AccountNumberUpdateParams::InboundACH) —

  Options related to how this Account Number handles inbound ACH transfers.

• inbound_checks (Increase::Models::AccountNumberUpdateParams::InboundChecks) —

  Options related to how this Account Number should handle inbound check withdrawals.

• name (String) —

  The name you choose for the Account Number.

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

  This indicates if transfers can be made to the Account Number.

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

Returns:

• (Increase::Models::AccountNumber)

See Also:

• Models::AccountNumberUpdateParams

# File 'lib/increase/resources/account_numbers.rb', line 80

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