Class: Lithic::Resources::FinancialAccounts::CreditConfiguration

Inherits:

Object

• Object
• Lithic::Resources::FinancialAccounts::CreditConfiguration

Defined in:

lib/lithic/resources/financial_accounts/credit_configuration.rb

Instance Method Summary

• #initialize(client:) ⇒ CreditConfiguration constructor private

  A new instance of CreditConfiguration.

• #retrieve(financial_account_token, request_options: {}) ⇒ Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig

  Get an Account’s credit configuration.

• #update(financial_account_token, auto_collection_configuration: nil, credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {}) ⇒ Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig

  Update an account’s credit configuration.

Constructor Details

#initialize(client:) ⇒ CreditConfiguration

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

Parameters:

• client (Lithic::Client)

# File 'lib/lithic/resources/financial_accounts/credit_configuration.rb', line 62

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(financial_account_token, request_options: {}) ⇒ Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig

Get an Account’s credit configuration

Parameters:

• financial_account_token (String) —

  Globally unique identifier for financial account.

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

Returns:

• (Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig)

See Also:

• Models::FinancialAccounts::CreditConfigurationRetrieveParams

# File 'lib/lithic/resources/financial_accounts/credit_configuration.rb', line 18

def retrieve(financial_account_token, params = {})
  @client.request(
    method: :get,
    path: ["v1/financial_accounts/%1$s/credit_configuration", financial_account_token],
    model: Lithic::FinancialAccounts::FinancialAccountCreditConfig,
    options: params[:request_options]
  )
end

#update(financial_account_token, auto_collection_configuration: nil, credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {}) ⇒ Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig

Update an account’s credit configuration

Parameters:

• financial_account_token (String) —

  Globally unique identifier for financial account.

• auto_collection_configuration (Lithic::Models::FinancialAccounts::CreditConfigurationUpdateParams::AutoCollectionConfiguration)
• credit_limit (Integer)
• credit_product_token (String) —

  Globally unique identifier for the credit product

• external_bank_account_token (String)
• tier (String) —

  Tier to assign to a financial account

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

Returns:

• (Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig)

See Also:

• Models::FinancialAccounts::CreditConfigurationUpdateParams

# File 'lib/lithic/resources/financial_accounts/credit_configuration.rb', line 48

def update(financial_account_token, params = {})
  parsed, options = Lithic::FinancialAccounts::CreditConfigurationUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["v1/financial_accounts/%1$s/credit_configuration", financial_account_token],
    body: parsed,
    model: Lithic::FinancialAccounts::FinancialAccountCreditConfig,
    options: options
  )
end