Class: FinancialAccountBalanceHistoryClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/financial_account_balance_history_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ FinancialAccountBalanceHistoryClient

Initialize the FinancialAccountBalanceHistoryClient class with a lockstepsdk instance.



24
25
26
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 24

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#create_balance_history(body:) ⇒ Object

Creates a Financial Account Balance History from a given model.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.



71
72
73
74
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 71

def create_balance_history(body:)
    path = "/api/v1/FinancialAccountBalanceHistory"
    @lockstepsdk.request(:post, path, body, nil)
end

#delete_balance_history(id:) ⇒ Object

Delete the Financial Account Balance History referred to by this unique identifier.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.



60
61
62
63
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 60

def delete_balance_history(id:)
    path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
    @lockstepsdk.request(:delete, path, nil, nil)
end

#query_balance_history(filter:, order:, page_size:, page_number:) ⇒ Object

Queries Financial Account Balance History for this account using the specified filtering, sorting, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.



87
88
89
90
91
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 87

def query_balance_history(filter:, order:, page_size:, page_number:)
    path = "/api/v1/FinancialAccountBalanceHistory/query"
    params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @lockstepsdk.request(:get, path, nil, params)
end

#retrieve_balance_history(id:) ⇒ Object

Retrieves the Financial Account Balance History specified by this unique identifier.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.



35
36
37
38
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 35

def retrieve_balance_history(id:)
    path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
    @lockstepsdk.request(:get, path, nil, nil)
end

#update_balance_history(id:, body:) ⇒ Object

Updates a Financial Account Balance History that matches the specified id with the requested information.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A Financial Account Balance History records either the current or end of period balance for a corresponding financial account.



49
50
51
52
 
# File 'lib/lockstep_sdk/clients/financial_account_balance_history_client.rb', line 49

def update_balance_history(id:, body:)
    path = "/api/v1/FinancialAccountBalanceHistory/#{id}"
    @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
end