class MergeHRISClient::EmployeePayrollRunsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/merge_hris_client/api/employee_payroll_runs_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

employee_payroll_runs_list(x_account_token, opts = {}) click to toggle source

Returns a list of `EmployeePayrollRun` objects. @param x_account_token [String] Token identifying the end user. @param [Hash] opts the optional parameters @option opts [Time] :created_after If provided, will only return objects created after this datetime. @option opts [Time] :created_before If provided, will only return objects created before this datetime. @option opts [String] :cursor The pagination cursor value. @option opts [String] :employee_id If provided, will only return time off for this employee. @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @option opts [Time] :modified_after If provided, will only return objects modified after this datetime. @option opts [Time] :modified_before If provided, will only return objects modified before this datetime. @option opts [Integer] :page_size Number of results to return per page. @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee. @option opts [String] :remote_id The API provider's ID for the given object. @return [PaginatedEmployeePayrollRunList]

# File lib/merge_hris_client/api/employee_payroll_runs_api.rb, line 37
def employee_payroll_runs_list(x_account_token, opts = {})
  data, _status_code, _headers = employee_payroll_runs_list_with_http_info(x_account_token, opts)
  data
end
employee_payroll_runs_list_with_http_info(x_account_token, opts = {}) click to toggle source

Returns a list of &#x60;EmployeePayrollRun&#x60; objects. @param x_account_token [String] Token identifying the end user. @param [Hash] opts the optional parameters @option opts [Time] :created_after If provided, will only return objects created after this datetime. @option opts [Time] :created_before If provided, will only return objects created before this datetime. @option opts [String] :cursor The pagination cursor value. @option opts [String] :employee_id If provided, will only return time off for this employee. @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @option opts [Time] :modified_after If provided, will only return objects modified after this datetime. @option opts [Time] :modified_before If provided, will only return objects modified before this datetime. @option opts [Integer] :page_size Number of results to return per page. @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee. @option opts [String] :remote_id The API provider&#39;s ID for the given object. @return [Array<(PaginatedEmployeePayrollRunList, Integer, Hash)>] PaginatedEmployeePayrollRunList data, response status code and response headers

# File lib/merge_hris_client/api/employee_payroll_runs_api.rb, line 57
def employee_payroll_runs_list_with_http_info(x_account_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeePayrollRunsApi.employee_payroll_runs_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && x_account_token.nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployeePayrollRunsApi.employee_payroll_runs_list"
  end
  allowable_values = ["employee", "employee,payroll_run", "payroll_run"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/employee-payroll-runs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'payroll_run_id'] = opts[:'payroll_run_id'] if !opts[:'payroll_run_id'].nil?
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = x_account_token

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedEmployeePayrollRunList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"EmployeePayrollRunsApi.employee_payroll_runs_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeePayrollRunsApi#employee_payroll_runs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
employee_payroll_runs_retrieve(x_account_token, id, opts = {}) click to toggle source

Returns an `EmployeePayrollRun` object with the given `id`. @param x_account_token [String] Token identifying the end user. @param id [String] @param [Hash] opts the optional parameters @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @return [EmployeePayrollRun]

# File lib/merge_hris_client/api/employee_payroll_runs_api.rb, line 128
def employee_payroll_runs_retrieve(x_account_token, id, opts = {})
  data, _status_code, _headers = employee_payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
  data
end
employee_payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {}) click to toggle source

Returns an &#x60;EmployeePayrollRun&#x60; object with the given &#x60;id&#x60;. @param x_account_token [String] Token identifying the end user. @param id [String] @param [Hash] opts the optional parameters @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @return [Array<(EmployeePayrollRun, Integer, Hash)>] EmployeePayrollRun data, response status code and response headers

# File lib/merge_hris_client/api/employee_payroll_runs_api.rb, line 140
def employee_payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeePayrollRunsApi.employee_payroll_runs_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && x_account_token.nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployeePayrollRunsApi.employee_payroll_runs_retrieve"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EmployeePayrollRunsApi.employee_payroll_runs_retrieve"
  end
  allowable_values = ["employee", "employee,payroll_run", "payroll_run"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/employee-payroll-runs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = x_account_token

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmployeePayrollRun'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"EmployeePayrollRunsApi.employee_payroll_runs_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeePayrollRunsApi#employee_payroll_runs_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end