Class: DefinitionsClient

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

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ DefinitionsClient

Initialize the DefinitionsClient class with a lockstepsdk instance.

Parameters:

  • lockstepsdk (LockstepApi) —

    The Lockstep API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/definitions.rb', line 22

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#query_countries(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object

Queries the ISO3166 List of Countries using the specified filtering, sorting, nested fetch, 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. Your program may want to show a list of countries. The ISO maintains a list of countries called [ISO3166](www.iso.org/iso-3166-country-codes.html). For convenience, this list is available in the API.

Parameters:



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

def query_countries(filter:, include_param:, order:, pageSize:, pageNumber:)
    path = "/api/v1/Definitions/countries"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => pageSize, :pageNumber => pageNumber}
    @lockstepsdk.request(:get, path, nil, params)
end

#query_currencies(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object

Queries Currencies on the Lockstep Platform using the specified filtering, sorting, nested fetch, 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.

Your app may wish to make use of a reference list that contains names and attributes for all ISO-4217 defined currency codes. This information is provided via a query endpoint so that you can use this API to provide a user selection screen.

Parameters:



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

def query_currencies(filter:, include_param:, order:, pageSize:, pageNumber:)
    path = "/api/v1/Definitions/currencies"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => pageSize, :pageNumber => pageNumber}
    @lockstepsdk.request(:get, path, nil, params)
end

#query_financial_systems(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object

Queries a list of financial systems using the specified filtering, sorting, nested fetch, 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. Lockstep provides a list of financial systems that may be useful as a selection screen that allows customers to select from a list. You can query these items by name or attributes and use this data source to help users complete a selection.

Parameters:



79
80
81
82
83
 
# File 'lib/lockstep_sdk/clients/definitions.rb', line 79

def query_financial_systems(filter:, include_param:, order:, pageSize:, pageNumber:)
    path = "/api/v1/Definitions/financialsystems"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => pageSize, :pageNumber => pageNumber}
    @lockstepsdk.request(:get, path, nil, params)
end

#query_states(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object

Queries the list of States in the United States using the specified filtering, sorting, nested fetch, 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. Your app may wish to make use of a reference list that contains names and codes for all states in the United States. This information is provided for the United States since many financial systems require mailing addresses that use codes for states.

Parameters:



65
66
67
68
69
 
# File 'lib/lockstep_sdk/clients/definitions.rb', line 65

def query_states(filter:, include_param:, order:, pageSize:, pageNumber:)
    path = "/api/v1/Definitions/states"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => pageSize, :pageNumber => pageNumber}
    @lockstepsdk.request(:get, path, nil, params)
end