Class: Merge::Hris::AsyncDependentsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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



135
136
137
 
# File 'lib/merge_ruby_client/hris/dependents/client.rb', line 135

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly) 



131
132
133
 
# File 'lib/merge_ruby_client/hris/dependents/client.rb', line 131

def request_client
  @request_client
end

Instance Method Details

#list(created_after: nil, created_before: nil, cursor: nil, employee_id: nil, include_deleted_data: nil, include_remote_data: nil, include_sensitive_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil) ⇒ Merge::Hris::PaginatedDependentList

Returns a list of ‘Dependent` objects.

Examples:

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



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
 
# File 'lib/merge_ruby_client/hris/dependents/client.rb', line 169

def list(created_after: nil, created_before: nil, cursor: nil, employee_id: nil, include_deleted_data: nil,
         include_remote_data: nil, include_sensitive_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: 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,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_sensitive_fields": include_sensitive_fields,
        "include_shell_data": include_shell_data,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "remote_id": remote_id
      }.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/dependents"
    end
    Merge::Hris::PaginatedDependentList.from_json(json_object: response.body)
  end
end

#retrieve(id:, include_remote_data: nil, include_sensitive_fields: nil, include_shell_data: nil, request_options: nil) ⇒ Merge::Hris::Dependent

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/merge_ruby_client/hris/dependents/client.rb', line 223

def retrieve(id:, include_remote_data: nil, include_sensitive_fields: nil, include_shell_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 || {}),
        "include_remote_data": include_remote_data,
        "include_sensitive_fields": include_sensitive_fields,
        "include_shell_data": include_shell_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/dependents/#{id}"
    end
    Merge::Hris::Dependent.from_json(json_object: response.body)
  end
end