Class: Gusto::Employees::JobsAndCompensationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/employees/jobs_and_compensations/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Gusto::Employees::JobsAndCompensationsClient

Parameters:



32
33
34
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 32

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Gusto::RequestClient (readonly)

Returns:



27
28
29
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 27

def request_client
  @request_client
end

Instance Method Details

#create_compensation(job_id:, rate: nil, payment_unit:, effective_date: nil, flsa_status:, adjust_for_minimum_wage: nil, minimum_wages: nil, request_options: nil) ⇒ Object

)



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 324

def create_compensation(job_id:, rate: nil, payment_unit:, effective_date: nil, flsa_status:, adjust_for_minimum_wage: nil, minimum_wages: nil, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), rate: rate, payment_unit: payment_unit, effective_date: effective_date, flsa_status: flsa_status, adjust_for_minimum_wage: adjust_for_minimum_wage, minimum_wages: minimum_wages }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/jobs/#{job_id}/compensations"
end
  Gusto::JobsAndCompensations::Compensation.from_json(json_object: response.body)
end

#create_job(employee_id:, title:, hire_date:, two_percent_shareholder: nil, state_wc_covered: nil, state_wc_class_code: nil, request_options: nil) ⇒ Object

)



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 104

def create_job(employee_id:, title:, hire_date:, two_percent_shareholder: nil, state_wc_covered: nil, state_wc_class_code: nil, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), title: title, hire_date: hire_date, two_percent_shareholder: two_percent_shareholder, state_wc_covered: state_wc_covered, state_wc_class_code: state_wc_class_code }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/jobs"
end
  Gusto::JobsAndCompensations::Job.from_json(json_object: response.body)
end

#delete_compensation(compensation_id:, request_options: nil) ⇒ Object

api.employees.jobs_and_compensations.delete_compensation(compensation_id: “compensation_id”)



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 449

def delete_compensation(compensation_id:, request_options: nil)
  response = @request_client.conn.delete do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/compensations/#{compensation_id}"
end
end

#delete_job(job_id:, request_options: nil) ⇒ Object

api.employees.jobs_and_compensations.delete_job(job_id: “job_id”)



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 223

def delete_job(job_id:, request_options: nil)
  response = @request_client.conn.delete do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/jobs/#{job_id}"
end
end

#get_compensation(compensation_id:, request_options: nil) ⇒ Object

api.employees.jobs_and_compensations.get_compensation(compensation_id: “compensation_id”)



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 359

def get_compensation(compensation_id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/compensations/#{compensation_id}"
end
  Gusto::JobsAndCompensations::Compensation.from_json(json_object: response.body)
end

#get_compensations(job_id:, page: nil, per: nil, include: nil, request_options: nil) ⇒ Object

api.employees.jobs_and_compensations.get_compensations(job_id: “job_id”)



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 271

def get_compensations(job_id:, page: nil, per: nil, include: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "per": per, "include": include }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/jobs/#{job_id}/compensations"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::JobsAndCompensations::Compensation.from_json(json_object: item)
  end
end

#get_job(job_id:, include: nil, request_options: nil) ⇒ Object

api.employees.jobs_and_compensations.get_job(job_id: “job_id”)



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 140

def get_job(job_id:, include: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "include": include }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/jobs/#{job_id}"
end
  Gusto::JobsAndCompensations::Job.from_json(json_object: response.body)
end

#get_jobs(employee_id:, page: nil, per: nil, include: nil, request_options: nil) ⇒ Object

api.employees.jobs_and_compensations.get_jobs(employee_id: “employee_id”)



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 54

def get_jobs(employee_id:, page: nil, per: nil, include: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "per": per, "include": include }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/jobs"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::JobsAndCompensations::Job.from_json(json_object: item)
  end
end

#update_compensation(compensation_id:, version:, rate: nil, payment_unit: nil, flsa_status: nil, adjust_for_minimum_wage: nil, minimum_wages: nil, request_options: nil) ⇒ Object

)



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 413

def update_compensation(compensation_id:, version:, rate: nil, payment_unit: nil, flsa_status: nil, adjust_for_minimum_wage: nil, minimum_wages: nil, request_options: nil)
  response = @request_client.conn.put do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), version: version, rate: rate, payment_unit: payment_unit, flsa_status: flsa_status, adjust_for_minimum_wage: adjust_for_minimum_wage, minimum_wages: minimum_wages }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/compensations/#{compensation_id}"
end
  Gusto::JobsAndCompensations::Compensation.from_json(json_object: response.body)
end

#update_job(job_id:, version:, title: nil, hire_date: nil, two_percent_shareholder: nil, state_wc_covered: nil, state_wc_class_code: nil, request_options: nil) ⇒ Object

)



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/fern_gusto/employees/jobs_and_compensations/client.rb', line 190

def update_job(job_id:, version:, title: nil, hire_date: nil, two_percent_shareholder: nil, state_wc_covered: nil, state_wc_class_code: nil, request_options: nil)
  response = @request_client.conn.put do | req |
  unless request_options&.timeout_in_seconds.nil?
    req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
    req.headers["Authorization"] = request_options.token
  end
  unless request_options&.gusto_api_version.nil?
    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), version: version, title: title, hire_date: hire_date, two_percent_shareholder: two_percent_shareholder, state_wc_covered: state_wc_covered, state_wc_class_code: state_wc_class_code }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/jobs/#{job_id}"
end
  Gusto::JobsAndCompensations::Job.from_json(json_object: response.body)
end