Skip to content

Latest commit

 

History

History
263 lines (164 loc) · 12.4 KB

README.md

File metadata and controls

263 lines (164 loc) · 12.4 KB

Employee

(employee)

Overview

Available Operations

create_hris_employee

Create an employee

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.employee.create_hris_employee(connection_id="<id>", hris_employee=::UnifiedRubySDK::Shared::HrisEmployee.new(), fields_=[
  "<value>",
])

if ! res.hris_employee.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
hris_employee T.nilable(::UnifiedRubySDK::Shared::HrisEmployee) ➖ N/A
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateHrisEmployeeResponse)

get_hris_employee

Retrieve an employee

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.employee.get_hris_employee(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.hris_employee.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Employee
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetHrisEmployeeResponse)

list_hris_employees

List all employees

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListHrisEmployeesRequest.new(
  connection_id: "<id>",
)
    
res = s.employee.list_hris_employees(req)

if ! res.hris_employees.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::UnifiedRubySDK::Operations::ListHrisEmployeesRequest ✔️ The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListHrisEmployeesResponse)

patch_hris_employee

Update an employee

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.employee.patch_hris_employee(connection_id="<id>", id="<id>", hris_employee=::UnifiedRubySDK::Shared::HrisEmployee.new(), fields_=[
  "<value>",
])

if ! res.hris_employee.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Employee
hris_employee T.nilable(::UnifiedRubySDK::Shared::HrisEmployee) ➖ N/A
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchHrisEmployeeResponse)

remove_hris_employee

Remove an employee

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.employee.remove_hris_employee(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Employee

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveHrisEmployeeResponse)

update_hris_employee

Update an employee

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.employee.update_hris_employee(connection_id="<id>", id="<id>", hris_employee=::UnifiedRubySDK::Shared::HrisEmployee.new(), fields_=[
  "<value>",
])

if ! res.hris_employee.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the Employee
hris_employee T.nilable(::UnifiedRubySDK::Shared::HrisEmployee) ➖ N/A
fields_ T::Array<::String> ➖ Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateHrisEmployeeResponse)