Class: ProfilesCompaniesClient

Inherits:

Object

• Object
• ProfilesCompaniesClient

Defined in:

lib/lockstep_sdk/clients/profiles_companies_client.rb

Instance Method Summary

• #initialize(connection) ⇒ ProfilesCompaniesClient constructor

  Initialize the ProfilesCompaniesClient class with an API client instance.

• #query_public_company_profiles(filter:, order:, page_size:, page_number:) ⇒ Object

  Queries Public Company Profiles.

• #retrieve_public_company_profile(url_slug:) ⇒ Object

  Retrieves the Public Company Profile specified by the public url slug.

Constructor Details

#initialize(connection) ⇒ ProfilesCompaniesClient

Initialize the ProfilesCompaniesClient class with an API client instance.

Parameters:

• connection (LockstepApi) —

  The API client object for this connection

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

def initialize(connection)
    @connection = connection
end

Instance Method Details

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

Queries Public Company Profiles

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 Public Company Profile makes available the following information:

<ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>

Parameters:

• filter (string) —

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

• order (string) —

  The sort order for the results, in the [Searchlight order syntax](github.com/tspence/csharp-searchlight).

• page_size (int32) —

  The page size for results (default 250, maximum of 500)

• page_number (int32) —

  The page number for results (default 0)

# File 'lib/lockstep_sdk/clients/profiles_companies_client.rb', line 51

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

#retrieve_public_company_profile(url_slug:) ⇒ Object

Retrieves the Public Company Profile specified by the public url slug.

A Public Company Profile makes available the following information: <ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>

Parameters:

• url_slug (string)

# File 'lib/lockstep_sdk/clients/profiles_companies_client.rb', line 33

def retrieve_public_company_profile(url_slug:)
    path = "/api/v1/profiles/companies/#{urlSlug}"
    @connection.request(:get, path, nil, nil)
end