Class: FinancialAccountClient

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

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ FinancialAccountClient

Initialize the FinancialAccountClient class with a lockstepsdk instance.



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

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#create_financial_account(body:) ⇒ Object

Creates a financial account with the specified name.



33
34
35
36
# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 33

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

#deletes_financial_account(id:) ⇒ Object

Deletes the Financial Account referred to by this unique identifier.



61
62
63
64
# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 61

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

#query_financial_accounts(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object



74
75
76
77
78
# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 74

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

#retrieve_financial_account(id:) ⇒ Object

Retrieves the financial account specified by this unique identifier.



42
43
44
45
# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 42

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

#update_financial_account(id:, body:) ⇒ Object



52
53
54
55
# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 52

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