Class: Gusto::Companies::ExternalPayrollsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/companies/external_payrolls/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Gusto::Companies::ExternalPayrollsClient

Parameters:



27
28
29
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 27

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Gusto::RequestClient (readonly)

Returns:



22
23
24
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 22

def request_client
  @request_client
end

Instance Method Details

#delete(company_uuid:, external_payroll_id:, request_options: nil) ⇒ Object

api.companies.external_payrolls.delete(company_uuid: “company_uuid”, external_payroll_id: “external_payroll_id”)



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 126

def delete(company_uuid:, external_payroll_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/companies/#{company_uuid}/external_payrolls/#{external_payroll_id}"
end
end

#finalize_tax_liabilities(company_uuid:, request_options: nil) ⇒ Object

api.companies.external_payrolls.finalize_tax_liabilities(company_uuid: “company_uuid”)



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 283

def finalize_tax_liabilities(company_uuid:, 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
  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_uuid}/external_payrolls/tax_liabilities/finish"
end
end

#get(company_uuid:, external_payroll_id:, request_options: nil) ⇒ Object

api.companies.external_payrolls.get(company_uuid: “company_uuid”, external_payroll_id: “external_payroll_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/companies/external_payrolls/client.rb', line 44

def get(company_uuid:, external_payroll_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_uuid}/external_payrolls/#{external_payroll_id}"
end
  Gusto::ExternalPayrolls::ExternalPayroll.from_json(json_object: response.body)
end

#get_tax_liabilities(company_uuid:, request_options: nil) ⇒ Object

api.companies.external_payrolls.get_tax_liabilities(company_uuid: “company_uuid”)



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 202

def get_tax_liabilities(company_uuid:, 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_uuid}/external_payrolls/tax_liabilities"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::ExternalPayrolls::TaxLiabilitiesSelections.from_json(json_object: item)
  end
end

#get_tax_suggestions(company_uuid:, external_payroll_id:, request_options: nil) ⇒ Object

api.companies.external_payrolls.get_tax_suggestions(company_uuid: “company_uuid”, external_payroll_id: “external_payroll_id”)



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 163

def get_tax_suggestions(company_uuid:, external_payroll_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_uuid}/external_payrolls/#{external_payroll_id}/calculate_taxes"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::ExternalPayrolls::ExternalPayrollTaxSuggestions.from_json(json_object: item)
  end
end

#update(company_uuid:, external_payroll_id:, replace_fields: nil, external_payroll_items: nil, request_options: nil) ⇒ Object

)



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 92

def update(company_uuid:, external_payroll_id:, replace_fields: nil, external_payroll_items: 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 || {}), replace_fields: replace_fields, external_payroll_items: external_payroll_items }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/external_payrolls/#{external_payroll_id}"
end
  Gusto::ExternalPayrolls::ExternalPayroll.from_json(json_object: response.body)
end

#update_tax_liabilities(company_uuid:, liability_selections: nil, request_options: nil) ⇒ Object

api.companies.external_payrolls.update_tax_liabilities(company_uuid: “company_uuid”, liability_selections: [{ tax_id: 1, last_unpaid_external_payroll_uuid: “7985032c-ee3a-4e98-af27-d56551eb5f1c”, unpaid_liability_amount: 50 }, { tax_id: 2, last_unpaid_external_payroll_uuid: “5ed14dbb-958f-47c8-b16e-c4fed82dc486”, unpaid_liability_amount: 400 }, { tax_id: 8, unpaid_liability_amount: 0 }])



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/fern_gusto/companies/external_payrolls/client.rb', line 245

def update_tax_liabilities(company_uuid:, liability_selections: 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 || {}), liability_selections: liability_selections }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/external_payrolls/tax_liabilities"
end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do | item |
    item = item.to_json
    Gusto::ExternalPayrolls::TaxLiabilitiesSelections.from_json(json_object: item)
  end
end