Class: Gusto::Payroll::AsyncPaySchedulesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/payroll/pay_schedules/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Gusto::Payroll::AsyncPaySchedulesClient

Parameters:



303
304
305
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 303

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Gusto::AsyncRequestClient (readonly)

Returns:



298
299
300
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 298

def request_client
  @request_client
end

Instance Method Details

#create(company_id:, frequency:, anchor_pay_date:, anchor_end_of_pay_period:, day1: nil, day2: nil, custom_name: nil, request_options: nil) ⇒ Object

)



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 386

def create(company_id:, frequency:, anchor_pay_date:, anchor_end_of_pay_period:, day1: nil, day2: nil, custom_name: nil, request_options: nil)
  Async do
    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 || {}), frequency: frequency, anchor_pay_date: anchor_pay_date, anchor_end_of_pay_period: anchor_end_of_pay_period, day_1: day1, day_2: day2, custom_name: custom_name }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/pay_schedules"
end
    Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
  end
end

#get(company_id:, pay_schedule_id:, request_options: nil) ⇒ Object

api.payroll.pay_schedules.get(company_id: “company_id”, pay_schedule_id: “pay_schedule_id”)



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 321

def get(company_id:, pay_schedule_id:, request_options: nil)
  Async do
    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/companies/#{company_id}/pay_schedules/#{pay_schedule_id}"
end
    Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
  end
end

#get_pay_periods(company_id:, start_date: nil, end_date: nil, payroll_types: nil, request_options: nil) ⇒ Object

)



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 556

def get_pay_periods(company_id:, start_date: nil, end_date: nil, payroll_types: nil, request_options: nil)
  Async do
    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 || {}), "start_date": start_date, "end_date": end_date, "payroll_types": payroll_types }.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/companies/#{company_id}/pay_periods"
end
    parsed_json = JSON.parse(response.body)
    parsed_json&.map do | item |
      item = item.to_json
      Gusto::Payrolls::PayPeriod.from_json(json_object: item)
    end
  end
end

#preview(company_id:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: nil, request_options: nil) ⇒ Object

)



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 438

def preview(company_id:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: nil, request_options: nil)
  Async do
    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 || {}), "frequency": frequency, "anchor_pay_date": anchor_pay_date, "anchor_end_of_pay_period": anchor_end_of_pay_period, "day_1": day1, "day_2": day2 }.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/companies/#{company_id}/pay_schedules/preview"
end
    Gusto::Payroll::PaySchedules::PaySchedulesPreviewResponse.from_json(json_object: response.body)
  end
end

#update(company_id:, pay_schedule_id:, version:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: nil, custom_name: nil, auto_pilot: nil, request_options: nil) ⇒ Object

)



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 504

def update(company_id:, pay_schedule_id:, version:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: nil, custom_name: nil, auto_pilot: nil, request_options: nil)
  Async do
    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, frequency: frequency, anchor_pay_date: anchor_pay_date, anchor_end_of_pay_period: anchor_end_of_pay_period, day_1: day1, day_2: day2, custom_name: custom_name, auto_pilot: auto_pilot }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/pay_schedules/#{pay_schedule_id}"
end
    Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
  end
end