Class: MergeHRISClient::PayrollRunsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/api/payroll_runs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayrollRunsApi

Returns a new instance of PayrollRunsApi.



19
20
21
 
# File 'lib/merge_hris_client/api/payroll_runs_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/merge_hris_client/api/payroll_runs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#payroll_runs_list(x_account_token, opts = {}) ⇒ PaginatedPayrollRunList

Returns a list of ‘PayrollRun` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :created_after (Time) —

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

  • :created_before (Time) —

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

  • :cursor (String) —

    The pagination cursor value.

  • :ended_after (Time) —

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

  • :ended_before (Time) —

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

  • :include_deleted_data (Boolean) —

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

  • :include_remote_data (Boolean) —

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

  • :modified_after (Time) —

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

  • :modified_before (Time) —

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

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :remote_id (String) —

    The API provider's ID for the given object.

  • :run_type (String) —

    If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

  • :started_after (Time) —

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

  • :started_before (Time) —

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

Returns:



42
43
44
45
 
# File 'lib/merge_hris_client/api/payroll_runs_api.rb', line 42

def payroll_runs_list(, opts = {})
  data, _status_code, _headers = payroll_runs_list_with_http_info(, opts)
  data
end

#payroll_runs_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedPayrollRunList, Integer, Hash)>

Returns a list of &#x60;PayrollRun&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :created_after (Time) —

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

  • :created_before (Time) —

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

  • :cursor (String) —

    The pagination cursor value.

  • :ended_after (Time) —

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

  • :ended_before (Time) —

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

  • :include_deleted_data (Boolean) —

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

  • :include_remote_data (Boolean) —

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

  • :modified_after (Time) —

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

  • :modified_before (Time) —

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

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

  • :run_type (String) —

    If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;) * &#x60;REGULAR&#x60; - REGULAR * &#x60;OFF_CYCLE&#x60; - OFF_CYCLE * &#x60;CORRECTION&#x60; - CORRECTION * &#x60;TERMINATION&#x60; - TERMINATION * &#x60;SIGN_ON_BONUS&#x60; - SIGN_ON_BONUS

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

  • :started_after (Time) —

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

  • :started_before (Time) —

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

Returns:

  • (Array<(PaginatedPayrollRunList, Integer, Hash)>) —

    PaginatedPayrollRunList data, response status code and response headers



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/merge_hris_client/api/payroll_runs_api.rb', line 67

def payroll_runs_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollRunsApi.payroll_runs_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling PayrollRunsApi.payroll_runs_list"
  end
  allowable_values = ["run_state", "run_state,run_type", "run_type"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  allowable_values = ["CORRECTION", "OFF_CYCLE", "REGULAR", "SIGN_ON_BONUS", "TERMINATION"]
  if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
    fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["run_state", "run_state,run_type", "run_type"]
  if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
    fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/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[:'ended_after'] = opts[:'ended_after'] if !opts[:'ended_after'].nil?
  query_params[:'ended_before'] = opts[:'ended_before'] if !opts[:'ended_before'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].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[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
  query_params[:'run_type'] = opts[:'run_type'] if !opts[:'run_type'].nil?
  query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
  query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
  query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].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'] = 

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

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

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

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

  new_options = opts.merge(
    :operation => :"PayrollRunsApi.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: PayrollRunsApi#payroll_runs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payroll_runs_retrieve(x_account_token, id, opts = {}) ⇒ PayrollRun

Returns a ‘PayrollRun` object with the given `id`.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_remote_data (Boolean) —

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

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

Returns:



152
153
154
155
 
# File 'lib/merge_hris_client/api/payroll_runs_api.rb', line 152

def payroll_runs_retrieve(, id, opts = {})
  data, _status_code, _headers = payroll_runs_retrieve_with_http_info(, id, opts)
  data
end

#payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(PayrollRun, Integer, Hash)>

Returns a &#x60;PayrollRun&#x60; object with the given &#x60;id&#x60;.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_remote_data (Boolean) —

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

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

Returns:

  • (Array<(PayrollRun, Integer, Hash)>) —

    PayrollRun data, response status code and response headers



165
166
167
168
169
170
171
172
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/merge_hris_client/api/payroll_runs_api.rb', line 165

def payroll_runs_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollRunsApi.payroll_runs_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling PayrollRunsApi.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 PayrollRunsApi.payroll_runs_retrieve"
  end
  allowable_values = ["run_state", "run_state,run_type", "run_type"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  allowable_values = ["run_state", "run_state,run_type", "run_type"]
  if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
    fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/payroll-runs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
  query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].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'] = 

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

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

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

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

  new_options = opts.merge(
    :operation => :"PayrollRunsApi.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: PayrollRunsApi#payroll_runs_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end