Class: Belvo::RiskInsights

Inherits:

Resource

• Object
• Resource
• Belvo::RiskInsights

Defined in:

lib/belvo/resources.rb

Overview

RiskInsights contain relevant metrics about the credit risk of a Link

Instance Attribute Summary

Attributes inherited from Resource

#endpoint

Instance Method Summary

• #initialize(session) ⇒ RiskInsights constructor

  A new instance of RiskInsights.

• #retrieve(link:, options: nil) ⇒ Hash

  Retrieve risk insights information from a specific banking link.

Methods inherited from Resource

#clean, #delete, #detail, #list, #resume

Constructor Details

#initialize(session) ⇒ RiskInsights

Returns a new instance of RiskInsights.

# File 'lib/belvo/resources.rb', line 397

def initialize(session)
  super(session)
  @endpoint = 'api/risk-insights/'
end

Instance Method Details

#retrieve(link:, options: nil) ⇒ Hash

Retrieve risk insights information from a specific banking link

Parameters:

• link (String) —

  Link UUID

• options (RiskInsightsOptions) (defaults to: nil) —

  Configurable properties

Returns:

• (Hash) —

  created RiskInsights details

Raises:

• (RequestError) —

  If response code is different than 2XX

# File 'lib/belvo/resources.rb', line 407

def retrieve(link:, options: nil)
  options = RiskInsightsOptions.from(options)
  body = {
    link: link,
    save_data: options.save_data || true
  }.merge(options)
  body = clean body: body
  @session.post(@endpoint, body)
end