Class: GustoEmbedded::ExternalPayrolls

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/gusto_embedded/externalpayrolls.rb

Instance Method Summary collapse

Constructor Details

#initialize(sdk_config) ⇒ ExternalPayrolls

Returns a new instance of ExternalPayrolls.



17
18
19
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 17

def initialize(sdk_config)
  @sdk_configuration = sdk_config
end

Instance Method Details

#calculate_taxes(company_uuid, external_payroll_id, x_gusto_api_version = nil) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 284

def calculate_taxes(company_uuid, external_payroll_id, x_gusto_api_version = nil)
  # calculate_taxes - Get tax suggestions for an external payroll
  # Get tax suggestions for an external payroll. Earnings and/or benefits
  # data must be saved prior to the calculation in order to retrieve accurate
  # tax calculation.
  # 
  # scope: `external_payrolls:read`
  request = ::GustoEmbedded::Operations::GetV1ExternalPayrollCalculateTaxesRequest.new(
    
    company_uuid: company_uuid,
    external_payroll_id: external_payroll_id,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::GetV1ExternalPayrollCalculateTaxesRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}/calculate_taxes',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::GetV1ExternalPayrollCalculateTaxesResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), T::Array[::GustoEmbedded::Shared::ExternalPayrollTaxSuggestions])
      res.external_payroll_tax_suggestions_list = out
    end
  elsif r.status == 404
  end

  res
end

#create(company_uuid, request_body, x_gusto_api_version = nil) ⇒ Object

Raises:

  • (StandardError) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 23

def create(company_uuid, request_body, x_gusto_api_version = nil)
  # create - Create a new external payroll for a company
  # Creates a new external payroll for the company.
  # 
  # scope: `external_payrolls:write`
  request = ::GustoEmbedded::Operations::PostV1ExternalPayrollRequest.new(
    
    company_uuid: company_uuid,
    request_body: request_body,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::PostV1ExternalPayrollRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls',
    request
  )
  headers = Utils.get_headers(request)
  req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
  headers['content-type'] = req_content_type
  raise StandardError, 'request body is required' if data.nil? && form.nil?
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.post(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
    if form
      req.body = Utils.encode_form(form)
    elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
      req.body = URI.encode_www_form(data)
    else
      req.body = data
    end
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::PostV1ExternalPayrollResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::ExternalPayroll)
      res.external_payroll = out
    end
  elsif r.status == 404
  elsif r.status == 422
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::UnprocessableEntityErrorObject)
      res.unprocessable_entity_error_object = out
    end
  end

  res
end

#delete(company_uuid, external_payroll_id, x_gusto_api_version = nil) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 178

def delete(company_uuid, external_payroll_id, x_gusto_api_version = nil)
  # delete - Delete an external payroll
  # Delete an external payroll.
  # 
  # scope: `external_payrolls:write`
  request = ::GustoEmbedded::Operations::DeleteV1ExternalPayrollRequest.new(
    
    company_uuid: company_uuid,
    external_payroll_id: external_payroll_id,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::DeleteV1ExternalPayrollRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = '*/*'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.delete(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::DeleteV1ExternalPayrollResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 204
  elsif r.status == 404
  end

  res
end

#finalize_tax_liabilities(company_uuid, x_gusto_api_version = nil) ⇒ Object 



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 441

def finalize_tax_liabilities(company_uuid, x_gusto_api_version = nil)
  # finalize_tax_liabilities - Finalize tax liabilities options and convert into processed payrolls
  # Finalizes tax liabilities for a company. All external payrolls edit action will be disabled.
  # 
  # scope: `external_payrolls:write`
  request = ::GustoEmbedded::Operations::PutV1TaxLiabilitiesFinishRequest.new(
    
    company_uuid: company_uuid,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::PutV1TaxLiabilitiesFinishRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/tax_liabilities/finish',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.put(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::PutV1TaxLiabilitiesFinishResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 202
  elsif r.status == 404
  elsif r.status == 422
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::UnprocessableEntityErrorObject)
      res.unprocessable_entity_error_object = out
    end
  end

  res
end

#get(company_uuid, x_gusto_api_version = nil) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 85

def get(company_uuid, x_gusto_api_version = nil)
  # get - Get external payrolls for a company
  # Get an external payroll for a given company.
  # 
  # scope: `external_payrolls:read`
  request = ::GustoEmbedded::Operations::GetV1CompanyExternalPayrollsRequest.new(
    
    company_uuid: company_uuid,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::GetV1CompanyExternalPayrollsRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::GetV1CompanyExternalPayrollsResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), T::Array[::GustoEmbedded::Shared::ExternalPayrollBasic])
      res.external_payroll_list = out
    end
  elsif r.status == 404
  end

  res
end

#list_tax_liabilities(company_uuid, x_gusto_api_version = nil) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 333

def list_tax_liabilities(company_uuid, x_gusto_api_version = nil)
  # list_tax_liabilities - Get tax liabilities
  # Get tax liabilities from aggregate external payrolls for a company.
  # 
  # scope: `external_payrolls:read`
  request = ::GustoEmbedded::Operations::GetV1TaxLiabilitiesRequest.new(
    
    company_uuid: company_uuid,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::GetV1TaxLiabilitiesRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/tax_liabilities',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::GetV1TaxLiabilitiesResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), T::Array[T::Array[::GustoEmbedded::Shared::TaxLiabilitiesSelections]])
      res.tax_liabilities_list = out
    end
  elsif r.status == 404
  end

  res
end

#retrieve(company_uuid, external_payroll_id, x_gusto_api_version = nil) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 131

def retrieve(company_uuid, external_payroll_id, x_gusto_api_version = nil)
  # retrieve - Get an external payroll
  # Get an external payroll for a given company.
  # 
  # scope: `external_payrolls:read`
  request = ::GustoEmbedded::Operations::GetV1ExternalPayrollRequest.new(
    
    company_uuid: company_uuid,
    external_payroll_id: external_payroll_id,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::GetV1ExternalPayrollRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}',
    request
  )
  headers = Utils.get_headers(request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::GetV1ExternalPayrollResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::ExternalPayroll)
      res.external_payroll = out
    end
  elsif r.status == 404
  end

  res
end

#update(company_uuid, external_payroll_id, request_body, x_gusto_api_version = nil) ⇒ Object

Raises:

  • (StandardError) 


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 221

def update(company_uuid, external_payroll_id, request_body, x_gusto_api_version = nil)
  # update - Update an external payroll
  # Update an external payroll with a list of external payroll items
  # 
  # scope: `external_payrolls:write`
  request = ::GustoEmbedded::Operations::PutV1ExternalPayrollRequest.new(
    
    company_uuid: company_uuid,
    external_payroll_id: external_payroll_id,
    request_body: request_body,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::PutV1ExternalPayrollRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/{external_payroll_id}',
    request
  )
  headers = Utils.get_headers(request)
  req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
  headers['content-type'] = req_content_type
  raise StandardError, 'request body is required' if data.nil? && form.nil?
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.put(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
    if form
      req.body = Utils.encode_form(form)
    elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
      req.body = URI.encode_www_form(data)
    else
      req.body = data
    end
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::PutV1ExternalPayrollResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::ExternalPayroll)
      res.external_payroll = out
    end
  elsif r.status == 404
  elsif r.status == 422
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::UnprocessableEntityErrorObject)
      res.unprocessable_entity_error_object = out
    end
  end

  res
end

#update_tax_liabilities(company_uuid, request_body, x_gusto_api_version = nil) ⇒ Object

Raises:

  • (StandardError) 


379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/gusto_embedded/externalpayrolls.rb', line 379

def update_tax_liabilities(company_uuid, request_body, x_gusto_api_version = nil)
  # update_tax_liabilities - Update tax liabilities
  # Update tax liabilities for a company.
  # 
  # scope: `external_payrolls:write`
  request = ::GustoEmbedded::Operations::PutV1TaxLiabilitiesRequest.new(
    
    company_uuid: company_uuid,
    request_body: request_body,
    x_gusto_api_version: x_gusto_api_version
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::GustoEmbedded::Operations::PutV1TaxLiabilitiesRequest,
    base_url,
    '/v1/companies/{company_uuid}/external_payrolls/tax_liabilities',
    request
  )
  headers = Utils.get_headers(request)
  req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
  headers['content-type'] = req_content_type
  raise StandardError, 'request body is required' if data.nil? && form.nil?
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.put(url) do |req|
    req.headers = headers
    security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
    Utils.configure_request_security(req, security) if !security.nil?
    if form
      req.body = Utils.encode_form(form)
    elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
      req.body = URI.encode_www_form(data)
    else
      req.body = data
    end
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::GustoEmbedded::Operations::PutV1TaxLiabilitiesResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), T::Array[T::Array[::GustoEmbedded::Shared::TaxLiabilitiesSelections]])
      res.tax_liabilities_list = out
    end
  elsif r.status == 404
  elsif r.status == 422
    if Utils.match_content_type(content_type, 'application/json')
      out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::GustoEmbedded::Shared::UnprocessableEntityErrorObject)
      res.unprocessable_entity_error_object = out
    end
  end

  res
end