Class: Pinnacle::CompanyClient
- Inherits:
-
Object
- Object
- Pinnacle::CompanyClient
- Defined in:
- lib/rcs/company/client.rb
Instance Attribute Summary collapse
Instance Method Summary collapse
-
#get(company_id: nil, company_name: nil, request_options: nil) ⇒ Array<Pinnacle::Company>
Retrieve the company’s information (i.e. approval status, company name, etc.).
- #initialize(request_client:) ⇒ Pinnacle::CompanyClient constructor
-
#register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, request_options: nil) ⇒ Pinnacle::Company::CompanyRegisterResponse
Register a company for RCS with the Pinnacle platform.
-
#update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil, request_options: nil) ⇒ Pinnacle::Company::CompanyUpdateResponse
Update a company on the Pinnacle platform.
Constructor Details
#initialize(request_client:) ⇒ Pinnacle::CompanyClient
22 23 24 |
# File 'lib/rcs/company/client.rb', line 22 def initialize(request_client:) @request_client = request_client end |
Instance Attribute Details
#request_client ⇒ Pinnacle::RequestClient (readonly)
18 19 20 |
# File 'lib/rcs/company/client.rb', line 18 def request_client @request_client end |
Instance Method Details
#get(company_id: nil, company_name: nil, request_options: nil) ⇒ Array<Pinnacle::Company>
Retrieve the company’s information (i.e. approval status, company name, etc.).
Search by company ID or company name.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/rcs/company/client.rb', line 40 def get(company_id: nil, company_name: nil, request_options: nil) response = @request_client.conn.get do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["PINNACLE-API-Key"] = .api_key unless &.api_key.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact req.params = { **(&.additional_query_parameters || {}), "companyId": company_id, "companyName": company_name }.compact unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/company" end parsed_json = JSON.parse(response.body) parsed_json&.map do |item| item = item.to_json Pinnacle::Company.from_json(json_object: item) end end |
#register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, request_options: nil) ⇒ Pinnacle::Company::CompanyRegisterResponse
Register a company for RCS with the Pinnacle platform
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/rcs/company/client.rb', line 120 def register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, request_options: nil) response = @request_client.conn.post do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["PINNACLE-API-Key"] = .api_key unless &.api_key.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end req.body = { **(&.additional_body_parameters || {}), company: company, companyContact: company_contact, messaging: messaging, pointOfContact: point_of_contact, optionals: optionals }.compact req.url "#{@request_client.get_url(request_options: )}/company/register" end Pinnacle::Company::CompanyRegisterResponse.from_json(json_object: response.body) end |
#update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil, request_options: nil) ⇒ Pinnacle::Company::CompanyUpdateResponse
Update a company on the Pinnacle platform
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/rcs/company/client.rb', line 213 def update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil, request_options: nil) response = @request_client.conn.post do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["PINNACLE-API-Key"] = .api_key unless &.api_key.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end req.body = { **(&.additional_body_parameters || {}), companyId: company_id, company: company, companyContact: company_contact, messaging: messaging, pointOfContact: point_of_contact, optionals: optionals }.compact req.url "#{@request_client.get_url(request_options: )}/company/update" end Pinnacle::Company::CompanyUpdateResponse.from_json(json_object: response.body) end |