Class: Merge::Hris::AsyncTimeOffClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



254
255
256
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 254

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



250
251
252
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 250

def request_client
  @request_client
end

Instance Method Details

#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Hris::TimeOffResponse

Creates a ‘TimeOff` object with the given values.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.time_off.create(model: {  })

Parameters:

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

    Whether to include debug fields (such as log file links) in the response.

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

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Hris::TimeOffRequest, as a Hash

    • :employee (Hash)

    • :approver (Hash)

    • :status (Merge::Hris::TimeOffStatusEnum)

    • :employee_note (String)

    • :units (Merge::Hris::UnitsEnum)

    • :amount (Float)

    • :request_type (Merge::Hris::RequestTypeEnum)

    • :start_time (DateTime)

    • :end_time (DateTime)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

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

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 376

def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  Async do
    response = @request_client.conn.post 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 || {}),
        "is_debug_mode": is_debug_mode,
        "run_async": run_async
      }.compact
      req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/hris/v1/time-off"
    end
    Merge::Hris::TimeOffResponse.from_json(json_object: response.body)
  end
end

#list(approver_id: nil, 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, remote_fields: nil, remote_id: nil, request_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, status: nil, request_options: nil) ⇒ Merge::Hris::PaginatedTimeOffList

Returns a list of ‘TimeOff` objects.

Examples:

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

Parameters:

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

    If provided, will only return time off for this approver.

  • 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 time off for this employee.

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

    If provided, will only return employees that ended after this datetime.

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

    If provided, will only return time-offs that ended before this datetime.

  • expand (Merge::Hris::TimeOff::TimeOffListRequestExpand) (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.

  • remote_fields (Merge::Hris::TimeOff::TimeOffListRequestRemoteFields) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

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

    The API provider’s ID for the given object.

  • request_type (Merge::Hris::TimeOff::TimeOffListRequestRequestType) (defaults to: nil) —

    If provided, will only return TimeOff with this request type. Options: (‘VACATION’, ‘SICK’, ‘PERSONAL’, ‘JURY_DUTY’, ‘VOLUNTEER’, ‘BEREAVEMENT’)

    • ‘VACATION` - VACATION

    • ‘SICK` - SICK

    • ‘PERSONAL` - PERSONAL

    • ‘JURY_DUTY` - JURY_DUTY

    • ‘VOLUNTEER` - VOLUNTEER

    • ‘BEREAVEMENT` - BEREAVEMENT

  • show_enum_origins (Merge::Hris::TimeOff::TimeOffListRequestShowEnumOrigins) (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 time-offs that started after this datetime.

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

    If provided, will only return time-offs that started before this datetime.

  • status (Merge::Hris::TimeOff::TimeOffListRequestStatus) (defaults to: nil) —

    If provided, will only return TimeOff with this status. Options: (‘REQUESTED’, ‘APPROVED’, ‘DECLINED’, ‘CANCELLED’, ‘DELETED’)

    • ‘REQUESTED` - REQUESTED

    • ‘APPROVED` - APPROVED

    • ‘DECLINED` - DECLINED

    • ‘CANCELLED` - CANCELLED

    • ‘DELETED` - DELETED

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

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 307

def list(approver_id: nil, 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, remote_fields: nil, remote_id: nil, request_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, status: 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 || {}),
        "approver_id": approver_id,
        "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,
        "remote_fields": remote_fields,
        "remote_id": remote_id,
        "request_type": request_type,
        "show_enum_origins": show_enum_origins,
        "started_after": started_after,
        "started_before": started_before,
        "status": status
      }.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/time-off"
    end
    Merge::Hris::PaginatedTimeOffList.from_json(json_object: response.body)
  end
end

#meta_post_retrieve(request_options: nil) ⇒ Merge::Hris::MetaResponse

Returns metadata for ‘TimeOff` POSTs.

Examples:

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

Parameters:

Returns:



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 458

def meta_post_retrieve(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
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      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/time-off/meta/post"
    end
    Merge::Hris::MetaResponse.from_json(json_object: response.body)
  end
end

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

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

Parameters:

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 419

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