Class: Gusto::Employees::BenefitsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



26
27
28
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 26

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Gusto::RequestClient (readonly)

Returns:



21
22
23
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 21

def request_client
  @request_client
end

Instance Method Details

#add_ytd_benefit_amounts(employee_id:, benefit_type: nil, tax_year:, ytd_employee_deduction_amount:, ytd_company_contribution_amount:, request_options: nil) ⇒ Object

)



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 311

def add_ytd_benefit_amounts(employee_id:, benefit_type: nil, tax_year:, ytd_employee_deduction_amount:, ytd_company_contribution_amount:, 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 || {}), benefit_type: benefit_type, tax_year: tax_year, ytd_employee_deduction_amount: ytd_employee_deduction_amount, ytd_company_contribution_amount: ytd_company_contribution_amount }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/ytd_benefit_amounts_from_different_company"
end
end

#create(employee_id:, company_benefit_uuid:, active: nil, employee_deduction: nil, deduct_as_percentage: nil, employee_deduction_annual_maximum: nil, contribution: nil, elective: nil, company_contribution_annual_maximum: nil, limit_option: nil, catch_up: nil, coverage_amount: nil, coverage_salary_multiplier: nil, deduction_reduces_taxable_income: nil, company_contribution: nil, contribute_as_percentage: nil, request_options: nil) ⇒ Object

)



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 123

def create(employee_id:, company_benefit_uuid:, active: nil, employee_deduction: nil, deduct_as_percentage: nil, employee_deduction_annual_maximum: nil, contribution: nil, elective: nil, company_contribution_annual_maximum: nil, limit_option: nil, catch_up: nil, coverage_amount: nil, coverage_salary_multiplier: nil, deduction_reduces_taxable_income: nil, company_contribution: nil, contribute_as_percentage: 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 || {}), company_benefit_uuid: company_benefit_uuid, active: active, employee_deduction: employee_deduction, deduct_as_percentage: deduct_as_percentage, employee_deduction_annual_maximum: employee_deduction_annual_maximum, contribution: contribution, elective: elective, company_contribution_annual_maximum: company_contribution_annual_maximum, limit_option: limit_option, catch_up: catch_up, coverage_amount: coverage_amount, coverage_salary_multiplier: coverage_salary_multiplier, deduction_reduces_taxable_income: deduction_reduces_taxable_income, company_contribution: company_contribution, contribute_as_percentage: contribute_as_percentage }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/employee_benefits"
end
  Gusto::EmployeeBenefit.from_json(json_object: response.body)
end

#delete(employee_benefit_id:, request_options: nil) ⇒ Object

api.employees.benefits.delete(employee_benefit_id: “employee_benefit_id”)



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 265

def delete(employee_benefit_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/employee_benefits/#{employee_benefit_id}"
end
end

#get(employee_benefit_id:, request_options: nil) ⇒ Object

api.employees.benefits.get(employee_benefit_id: “employee_benefit_id”)



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 159

def get(employee_benefit_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/employee_benefits/#{employee_benefit_id}"
end
  Gusto::EmployeeBenefit.from_json(json_object: response.body)
end

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

api.employees.benefits.list(employee_id: “employee_id”)



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 49

def list(employee_id:, page: nil, per: 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 }.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}/employee_benefits"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::EmployeeBenefit.from_json(json_object: item)
  end
end

#update(employee_benefit_id:, version:, active: nil, employee_deduction: nil, deduct_as_percentage: nil, employee_deduction_annual_maximum: nil, contribution: nil, elective: nil, company_contribution_annual_maximum: nil, limit_option: nil, catch_up: nil, coverage_amount: nil, deduction_reduces_taxable_income: nil, coverage_salary_multiplier: nil, company_contribution: nil, contribute_as_percentage: nil, request_options: nil) ⇒ Object

)



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/fern_gusto/employees/benefits/client.rb', line 231

def update(employee_benefit_id:, version:, active: nil, employee_deduction: nil, deduct_as_percentage: nil, employee_deduction_annual_maximum: nil, contribution: nil, elective: nil, company_contribution_annual_maximum: nil, limit_option: nil, catch_up: nil, coverage_amount: nil, deduction_reduces_taxable_income: nil, coverage_salary_multiplier: nil, company_contribution: nil, contribute_as_percentage: 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, active: active, employee_deduction: employee_deduction, deduct_as_percentage: deduct_as_percentage, employee_deduction_annual_maximum: employee_deduction_annual_maximum, contribution: contribution, elective: elective, company_contribution_annual_maximum: company_contribution_annual_maximum, limit_option: limit_option, catch_up: catch_up, coverage_amount: coverage_amount, deduction_reduces_taxable_income: deduction_reduces_taxable_income, coverage_salary_multiplier: coverage_salary_multiplier, company_contribution: company_contribution, contribute_as_percentage: contribute_as_percentage }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employee_benefits/#{employee_benefit_id}"
end
  Gusto::EmployeeBenefit.from_json(json_object: response.body)
end