Class: Merge::Hris::AsyncEmployeePayrollRunsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/employee_payroll_runs/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Hris::AsyncEmployeePayrollRunsClient

Parameters:



138
139
140
 
# File 'lib/merge_ruby_client/hris/employee_payroll_runs/client.rb', line 138

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



134
135
136
 
# File 'lib/merge_ruby_client/hris/employee_payroll_runs/client.rb', line 134

def request_client
  @request_client
end

Instance Method Details

#list(created_after: nil, created_before: nil, cursor: nil, employee_id: nil, ended_after: nil, ended_before: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, payroll_run_id: nil, remote_id: nil, started_after: nil, started_before: nil, request_options: nil) ⇒ Merge::Hris::PaginatedEmployeePayrollRunList

Returns a list of ‘EmployeePayrollRun` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.employee_payroll_runs.list

Parameters:

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • employee_id (String) (defaults to: nil) —

    If provided, will only return employee payroll runs for this employee.

  • ended_after (DateTime) (defaults to: nil) —

    If provided, will only return employee payroll runs ended after this datetime.

  • ended_before (DateTime) (defaults to: nil) —

    If provided, will only return employee payroll runs ended before this datetime.

  • expand (Merge::Hris::EmployeePayrollRuns::EmployeePayrollRunsListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_deleted_data (Boolean) (defaults to: nil) —

    Whether to include data that was marked as deleted by third party webhooks.

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • payroll_run_id (String) (defaults to: nil) —

    If provided, will only return employee payroll runs for this employee.

  • remote_id (String) (defaults to: nil) —

    The API provider’s ID for the given object.

  • started_after (DateTime) (defaults to: nil) —

    If provided, will only return employee payroll runs started after this datetime.

  • started_before (DateTime) (defaults to: nil) —

    If provided, will only return employee payroll runs started before this datetime.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



173
174
175
176
177
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
 
# File 'lib/merge_ruby_client/hris/employee_payroll_runs/client.rb', line 173

def list(created_after: nil, created_before: nil, cursor: nil, employee_id: nil, ended_after: nil,
         ended_before: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, payroll_run_id: nil, remote_id: nil, started_after: nil, started_before: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "employee_id": employee_id,
        "ended_after": ended_after,
        "ended_before": ended_before,
        "expand": expand,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "payroll_run_id": payroll_run_id,
        "remote_id": remote_id,
        "started_after": started_after,
        "started_before": started_before
      }.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)}/hris/v1/employee-payroll-runs"
    end
    Merge::Hris::PaginatedEmployeePayrollRunList.from_json(json_object: response.body)
  end
end

#retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil) ⇒ Merge::Hris::EmployeePayrollRun

Returns an ‘EmployeePayrollRun` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.employee_payroll_runs.retrieve(id: "id")

Parameters:

Returns:



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/merge_ruby_client/hris/employee_payroll_runs/client.rb', line 229

def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "expand": expand,
        "include_remote_data": include_remote_data
      }.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)}/hris/v1/employee-payroll-runs/#{id}"
    end
    Merge::Hris::EmployeePayrollRun.from_json(json_object: response.body)
  end
end