Class: Gusto::Payroll::PaySchedulesClient

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::PaySchedulesClient

Parameters:



26
27
28
 
# File 'lib/fern_gusto/payroll/pay_schedules/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/payroll/pay_schedules/client.rb', line 21

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

)



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 107

def create(company_id:, frequency:, anchor_pay_date:, anchor_end_of_pay_period:, day1: nil, day2: nil, custom_name: 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 || {}), 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

#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”)



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 44

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

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

)



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/payroll/pay_schedules/client.rb', line 271

def get_pay_periods(company_id:, start_date: nil, end_date: nil, payroll_types: 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 || {}), "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

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

)



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 157

def preview(company_id:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: 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 || {}), "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

#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

)



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/fern_gusto/payroll/pay_schedules/client.rb', line 221

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)
  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