Class: Merge::Hris::AsyncEmployeesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



341
342
343
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 341

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



337
338
339
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 337

def request_client
  @request_client
end

Instance Method Details

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

Creates an ‘Employee` 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.employees.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::EmployeeRequest, as a Hash

    • :employee_number (String)

    • :company (Hash)

    • :first_name (String)

    • :last_name (String)

    • :preferred_name (String)

    • :display_full_name (String)

    • :username (String)

    • :groups (Array<Merge::Hris::EmployeeRequestGroupsItem>)

    • :work_email (String)

    • :personal_email (String)

    • :mobile_phone_number (String)

    • :employments (Array<Merge::Hris::EmployeeRequestEmploymentsItem>)

    • :home_location (Hash)

    • :work_location (Hash)

    • :manager (Hash)

    • :team (Hash)

    • :pay_group (Hash)

    • :ssn (String)

    • :gender (Merge::Hris::GenderEnum)

    • :ethnicity (Merge::Hris::EthnicityEnum)

    • :marital_status (Merge::Hris::MaritalStatusEnum)

    • :date_of_birth (DateTime)

    • :hire_date (DateTime)

    • :start_date (DateTime)

    • :employment_status (Merge::Hris::EmploymentStatusEnum)

    • :termination_date (DateTime)

    • :avatar (String)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

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

Returns:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 509

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/employees"
    end
    Merge::Hris::EmployeeResponse.from_json(json_object: response.body)
  end
end

#ignore_create(model_id:, reason:, message: nil, request_options: nil) ⇒ Void

Ignores a specific row based on the ‘model_id` in the url. These records will

have their properties set to null, and will not be updated in future syncs. The
"reason" and "message" fields in the request body will be stored for audit
purposes.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.employees.ignore_create(model_id: "model_id", reason: GENERAL_CUSTOMER_REQUEST)

Parameters:

Returns:

  • (Void) 


603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 603

def ignore_create(model_id:, reason:, message: nil, request_options: nil)
  Async do
    @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
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      req.body = {
        **(request_options&.additional_body_parameters || {}),
        reason: reason,
        message: message
      }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/hris/v1/employees/ignore/#{model_id}"
    end
  end
end

#list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, display_full_name: nil, employee_number: nil, employment_status: nil, employment_type: nil, expand: nil, first_name: nil, groups: nil, home_location_id: nil, include_deleted_data: nil, include_remote_data: nil, include_sensitive_fields: nil, include_shell_data: nil, job_title: nil, last_name: nil, manager_id: nil, modified_after: nil, modified_before: nil, page_size: nil, pay_group_id: nil, personal_email: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, started_after: nil, started_before: nil, team_id: nil, terminated_after: nil, terminated_before: nil, work_email: nil, work_location_id: nil, request_options: nil) ⇒ Merge::Hris::PaginatedEmployeeList

Returns a list of ‘Employee` objects.

Examples:

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

Parameters:

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

    If provided, will only return employees for this company.

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

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

    If provided, will only return employees with this display name.

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

    If provided, will only return employees with this employee number.

  • employment_status (Merge::Hris::Employees::EmployeesListRequestEmploymentStatus) (defaults to: nil) —

    If provided, will only return employees with this employment status.

    • ‘ACTIVE` - ACTIVE

    • ‘PENDING` - PENDING

    • ‘INACTIVE` - INACTIVE

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

    If provided, will only return employees that have an employment of the specified employment_type.

  • expand (Merge::Hris::Employees::EmployeesListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

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

    If provided, will only return employees with this first name.

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

    If provided, will only return employees matching the group ids; multiple groups can be separated by commas.

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

    If provided, will only return employees for this home location.

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

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

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

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

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

    Whether to include sensitive fields (such as social security numbers) in the response.

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

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

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

    If provided, will only return employees that have an employment of the specified job_title.

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

    If provided, will only return employees with this last name.

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

    If provided, will only return employees for this manager.

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

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

    If provided, will only return employees for this pay group

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

    If provided, will only return Employees with this personal email

  • remote_fields (Merge::Hris::Employees::EmployeesListRequestRemoteFields) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

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

    The API provider’s ID for the given object.

  • show_enum_origins (Merge::Hris::Employees::EmployeesListRequestShowEnumOrigins) (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 employees that started after this datetime.

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

    If provided, will only return employees that started before this datetime.

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

    If provided, will only return employees for this team.

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

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

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

    If provided, will only return employees that were terminated before this datetime.

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

    If provided, will only return Employees with this work email

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

    If provided, will only return employees for this location.

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

Returns:



408
409
410
411
412
413
414
415
416
417
418
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 408

def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, display_full_name: nil,
         employee_number: nil, employment_status: nil, employment_type: nil, expand: nil, first_name: nil, groups: nil, home_location_id: nil, include_deleted_data: nil, include_remote_data: nil, include_sensitive_fields: nil, include_shell_data: nil, job_title: nil, last_name: nil, manager_id: nil, modified_after: nil, modified_before: nil, page_size: nil, pay_group_id: nil, personal_email: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, started_after: nil, started_before: nil, team_id: nil, terminated_after: nil, terminated_before: nil, work_email: nil, work_location_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 || {}),
        "company_id": company_id,
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "display_full_name": display_full_name,
        "employee_number": employee_number,
        "employment_status": employment_status,
        "employment_type": employment_type,
        "expand": expand,
        "first_name": first_name,
        "groups": groups,
        "home_location_id": home_location_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,
        "job_title": job_title,
        "last_name": last_name,
        "manager_id": manager_id,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "pay_group_id": pay_group_id,
        "personal_email": personal_email,
        "remote_fields": remote_fields,
        "remote_id": remote_id,
        "show_enum_origins": show_enum_origins,
        "started_after": started_after,
        "started_before": started_before,
        "team_id": team_id,
        "terminated_after": terminated_after,
        "terminated_before": terminated_before,
        "work_email": work_email,
        "work_location_id": work_location_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/employees"
    end
    Merge::Hris::PaginatedEmployeeList.from_json(json_object: response.body)
  end
end

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

Returns metadata for ‘Employee` POSTs.

Examples:

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

Parameters:

Returns:



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 638

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/employees/meta/post"
    end
    Merge::Hris::MetaResponse.from_json(json_object: response.body)
  end
end

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

Returns an ‘Employee` 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.employees.retrieve(id: "id")

Parameters:

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/merge_ruby_client/hris/employees/client.rb', line 556

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