Class: CompaniesClient

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

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ CompaniesClient

Initialize the CompaniesClient class with a lockstepsdk instance.



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

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#create_companies(body:) ⇒ Object

Creates one or more Companies from a given model.

A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



81
82
83
84
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 81

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

#disable_company(id:) ⇒ Object

Disable the Company referred to by this unique identifier.

A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



68
69
70
71
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 68

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

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

Queries Companies for this account 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.

A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



100
101
102
103
104
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 100

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

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

Queries Customer Summaries for this account 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.

The Customer Summary View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Customer Summary Model.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



120
121
122
123
124
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 120

def query_customer_summary(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/Companies/views/customer-summary"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @lockstepsdk.request(:get, path, nil, params)
end

#retrieve_company(id:, include_param:) ⇒ Object

Retrieves the Company specified by this unique identifier, optionally including nested data sets.

A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



38
39
40
41
42
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 38

def retrieve_company(id:, include_param:)
    path = "/api/v1/Companies/#{id}"
    params = {:include => include_param}
    @lockstepsdk.request(:get, path, nil, params)
end

#retrieve_customer_detail(id:) ⇒ Object

Retrieves the Customer Details specified by this unique identifier, optionally including nested data sets.

The Customer Detail View represents a slightly different view of the data and includes some extra fields that might be useful. For more information, see the data format of the Customer Detail Model.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



134
135
136
137
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 134

def retrieve_customer_detail(id:)
    path = "/api/v1/Companies/views/customer-details/#{id}"
    @lockstepsdk.request(:get, path, nil, nil)
end

#update_company(id:, body:) ⇒ Object

Updates a Company 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 Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.

See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.



55
56
57
58
 
# File 'lib/lockstep_sdk/clients/companies_client.rb', line 55

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