Class: Merge::Hris::PayrollRunsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



22
23
24
 
# File 'lib/merge_ruby_client/hris/payroll_runs/client.rb', line 22

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::RequestClient (readonly)

Returns:



18
19
20
 
# File 'lib/merge_ruby_client/hris/payroll_runs/client.rb', line 18

def request_client
  @request_client
end

Instance Method Details

#list(created_after: nil, created_before: nil, cursor: nil, ended_after: nil, ended_before: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, run_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, request_options: nil) ⇒ Merge::Hris::PaginatedPayrollRunList

Returns a list of ‘PayrollRun` objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.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.

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

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

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

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

  • 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.

  • remote_fields (Merge::Hris::PayrollRuns::PayrollRunsListRequestRemoteFields) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

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

    The API provider’s ID for the given object.

  • run_type (Merge::Hris::PayrollRuns::PayrollRunsListRequestRunType) (defaults to: nil) —

    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 (Merge::Hris::PayrollRuns::PayrollRunsListRequestShowEnumOrigins) (defaults to: nil) —

    A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

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

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

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

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

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

Returns:



63
64
65
66
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
 
# File 'lib/merge_ruby_client/hris/payroll_runs/client.rb', line 63

def list(created_after: nil, created_before: nil, cursor: nil, ended_after: nil, ended_before: nil,
         include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, run_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, request_options: nil)
  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,
      "ended_after": ended_after,
      "ended_before": ended_before,
      "include_deleted_data": include_deleted_data,
      "include_remote_data": include_remote_data,
      "modified_after": modified_after,
      "modified_before": modified_before,
      "page_size": page_size,
      "remote_fields": remote_fields,
      "remote_id": remote_id,
      "run_type": run_type,
      "show_enum_origins": show_enum_origins,
      "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/payroll-runs"
  end
  Merge::Hris::PaginatedPayrollRunList.from_json(json_object: response.body)
end

#retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Hris::PayrollRun

Returns a ‘PayrollRun` 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.payroll_runs.retrieve(id: "id")

Parameters:

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/merge_ruby_client/hris/payroll_runs/client.rb', line 119

def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
  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 || {}),
      "include_remote_data": include_remote_data,
      "remote_fields": remote_fields,
      "show_enum_origins": show_enum_origins
    }.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/payroll-runs/#{id}"
  end
  Merge::Hris::PayrollRun.from_json(json_object: response.body)
end