Class: Veryfi::Api::BankStatementSplit

Inherits:
Object
  • Object
show all
Includes:
FilePayload
Defined in:
lib/veryfi/api/bank_statement_split.rb

Overview

Bank-statement splitting endpoints (/partner/bank-statements-set/).

Use these when you have a single file containing multiple bank statements (e.g. an annual archive PDF). Veryfi will split the file and process each statement separately; you receive a collection that references the individual BankStatement ids it produced.

Constant Summary collapse

ENDPOINT = 
"/partner/bank-statements-set/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request) ⇒ BankStatementSplit

Returns a new instance of BankStatementSplit.



18
19
20
 
# File 'lib/veryfi/api/bank_statement_split.rb', line 18

def initialize(request)
  @request = request
end

Instance Attribute Details

#request ⇒ Object (readonly)

Returns the value of attribute request.



16
17
18
 
# File 'lib/veryfi/api/bank_statement_split.rb', line 16

def request
  @request
end

Instance Method Details

#all(params = {}) ⇒ Veryfi::Resource

List previously processed bank-statement sets.

Parameters:

  • params (Hash) (defaults to: {}) —

    optional query-string parameters

Returns:



26
27
28
 
# File 'lib/veryfi/api/bank_statement_split.rb', line 26

def all(params = {})
  request.get(ENDPOINT, params)
end

#get(id, params = {}) ⇒ Veryfi::Resource

Fetch a single bank-statement set by id.

Parameters:

  • id (Integer)
  • params (Hash) (defaults to: {}) —

    optional query-string parameters

Returns:



35
36
37
 
# File 'lib/veryfi/api/bank_statement_split.rb', line 35

def get(id, params = {})
  request.get("#{ENDPOINT}#{id}", params)
end

#process(raw_params) ⇒ Veryfi::Resource

Upload a multi-statement file and split-and-process it.

Parameters:

  • raw_params (Hash)

Options Hash (raw_params):

  • :file_path (String) —

    required. Local path.

  • :file_name (String) — default: basename of `:file_path`

Returns:



45
46
47
48
49
50
51
52
53
 
# File 'lib/veryfi/api/bank_statement_split.rb', line 45

def process(raw_params)
  params = raw_params.transform_keys(&:to_sym)
  file_path = params.delete(:file_path)
  file_name = params.delete(:file_name)

  payload = file_payload(file_path, file_name).merge(params)

  request.post(ENDPOINT, payload)
end

#process_url(raw_params) ⇒ Veryfi::Resource

URL variant of #process.

Parameters:

  • raw_params (Hash)

Options Hash (raw_params):

  • :file_url (String) —

    single URL

  • :file_urls (Array<String>) —

    list of URLs (alternative to :file_url)

Returns:



61
62
63
 
# File 'lib/veryfi/api/bank_statement_split.rb', line 61

def process_url(raw_params)
  request.post(ENDPOINT, raw_params.transform_keys(&:to_sym))
end