Class: FinancialAccountClient

Inherits:

Object

• Object
• FinancialAccountClient

Defined in:

lib/lockstep_sdk/clients/financial_account_client.rb

Instance Method Summary

• #create_financial_account(body:) ⇒ Object

  Creates a financial account with the specified name.

• #delete_financial_account(id:) ⇒ Object

  Deletes the Financial Account referred to by this unique identifier.

• #initialize(connection) ⇒ FinancialAccountClient constructor

  Initialize the FinancialAccountClient class with an API client instance.

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

  Retrieves the financial account specified by this unique identifier.

• #update_financial_account(id:, body:) ⇒ Object

Constructor Details

#initialize(connection) ⇒ FinancialAccountClient

Initialize the FinancialAccountClient class with an API client instance.

Parameters:

• connection (LockstepApi) —

  The API client object for this connection

# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#create_financial_account(body:) ⇒ Object

Creates a financial account with the specified name.

Parameters:

• body (FinancialAccountModel) —

  Metadata about the financial account to create.

# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 31

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

#delete_financial_account(id:) ⇒ Object

Deletes the Financial Account referred to by this unique identifier.

Parameters:

• id (uuid) —

  The unique Lockstep Platform ID number of the Financial Account to disable; NOT the customer’s ERP key

# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 59

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

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

Parameters:

• filter (string) —

  The filter for this query. See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

• include_param (string) —

  To fetch additional data on this object, specify the list of elements to retrieve.

• order (string) —

  The sort order for this query. See See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

• page_size (int32) —

  The page size for results (default 250, maximum of 500). See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

• page_number (int32) —

  The page number for results (default 0). See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 72

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}
    @connection.request(:get, path, nil, params)
end

#retrieve_financial_account(id:) ⇒ Object

Retrieves the financial account specified by this unique identifier.

Parameters:

• id (uuid) —

  The unique Lockstep Platform ID number of this Account; NOT the customer’s ERP key

# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 40

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

#update_financial_account(id:, body:) ⇒ Object

Parameters:

• id (uuid) —

  The unique Lockstep Platform ID number of the Account to update; NOT the customer’s ERP key

• body (object) —

  A list of changes to apply to this Account

# File 'lib/lockstep_sdk/clients/financial_account_client.rb', line 50

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