merge_hris_client 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +179 -0
- data/Rakefile +10 -0
- data/config.json +1 -0
- data/docs/AccountIntegration.md +28 -0
- data/docs/AccountToken.md +18 -0
- data/docs/AccountTokenApi.md +79 -0
- data/docs/AvailableActions.md +22 -0
- data/docs/AvailableActionsApi.md +79 -0
- data/docs/Benefit.md +32 -0
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/BenefitsApi.md +181 -0
- data/docs/CompaniesApi.md +175 -0
- data/docs/Company.md +28 -0
- data/docs/CountryEnum.md +15 -0
- data/docs/DataPassthrough.md +24 -0
- data/docs/DataPassthroughRequest.md +26 -0
- data/docs/Deduction.md +28 -0
- data/docs/Earning.md +26 -0
- data/docs/Employee.md +66 -0
- data/docs/EmployeePayrollRun.md +42 -0
- data/docs/EmployeePayrollRunsApi.md +183 -0
- data/docs/EmployeesApi.md +187 -0
- data/docs/Employment.md +38 -0
- data/docs/EmploymentStatusEnum.md +15 -0
- data/docs/EmploymentTypeEnum.md +15 -0
- data/docs/EmploymentsApi.md +177 -0
- data/docs/EndUserDetails.md +24 -0
- data/docs/EndUserDetailsRequest.md +26 -0
- data/docs/EthnicityEnum.md +15 -0
- data/docs/FlsaStatusEnum.md +15 -0
- data/docs/GenderEnum.md +15 -0
- data/docs/GenerateKeyApi.md +79 -0
- data/docs/GenerateRemoteKeyRequest.md +18 -0
- data/docs/LinkToken.md +20 -0
- data/docs/LinkTokenApi.md +79 -0
- data/docs/Location.md +36 -0
- data/docs/LocationsApi.md +175 -0
- data/docs/MaritalStatusEnum.md +15 -0
- data/docs/MethodEnum.md +15 -0
- data/docs/ModelOperation.md +22 -0
- data/docs/NullEnum.md +15 -0
- data/docs/PaginatedBenefitList.md +22 -0
- data/docs/PaginatedCompanyList.md +22 -0
- data/docs/PaginatedEmployeeList.md +22 -0
- data/docs/PaginatedEmployeePayrollRunList.md +22 -0
- data/docs/PaginatedEmploymentList.md +22 -0
- data/docs/PaginatedLocationList.md +22 -0
- data/docs/PaginatedPayrollRunList.md +22 -0
- data/docs/PaginatedTeamList.md +22 -0
- data/docs/PaginatedTimeOffList.md +22 -0
- data/docs/PassthroughApi.md +81 -0
- data/docs/PayCurrencyEnum.md +15 -0
- data/docs/PayFrequencyEnum.md +15 -0
- data/docs/PayPeriodEnum.md +15 -0
- data/docs/PayrollRun.md +32 -0
- data/docs/PayrollRunsApi.md +175 -0
- data/docs/RegenerateKeyApi.md +79 -0
- data/docs/RemoteData.md +20 -0
- data/docs/RemoteKey.md +20 -0
- data/docs/RemoteKeyForRegeneration.md +18 -0
- data/docs/RemoteKeyForRegenerationRequest.md +18 -0
- data/docs/RemoteResponse.md +26 -0
- data/docs/RequestTypeEnum.md +15 -0
- data/docs/RunStateEnum.md +15 -0
- data/docs/RunTypeEnum.md +15 -0
- data/docs/StateEnum.md +15 -0
- data/docs/SyncStatus.md +28 -0
- data/docs/SyncStatusApi.md +79 -0
- data/docs/Tax.md +28 -0
- data/docs/Team.md +24 -0
- data/docs/TeamsApi.md +175 -0
- data/docs/TimeOff.md +36 -0
- data/docs/TimeOffApi.md +183 -0
- data/docs/TimeOffStatusEnum.md +15 -0
- data/docs/TypeEnum.md +15 -0
- data/docs/UnitsEnum.md +15 -0
- data/git_push.sh +58 -0
- data/lib/merge_hris_client.rb +110 -0
- data/lib/merge_hris_client/api/account_token_api.rb +83 -0
- data/lib/merge_hris_client/api/available_actions_api.rb +84 -0
- data/lib/merge_hris_client/api/benefits_api.rb +196 -0
- data/lib/merge_hris_client/api/companies_api.rb +179 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +199 -0
- data/lib/merge_hris_client/api/employees_api.rb +205 -0
- data/lib/merge_hris_client/api/employments_api.rb +182 -0
- data/lib/merge_hris_client/api/generate_key_api.rb +85 -0
- data/lib/merge_hris_client/api/link_token_api.rb +85 -0
- data/lib/merge_hris_client/api/locations_api.rb +179 -0
- data/lib/merge_hris_client/api/passthrough_api.rb +92 -0
- data/lib/merge_hris_client/api/payroll_runs_api.rb +179 -0
- data/lib/merge_hris_client/api/regenerate_key_api.rb +85 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +84 -0
- data/lib/merge_hris_client/api/teams_api.rb +179 -0
- data/lib/merge_hris_client/api/time_off_api.rb +199 -0
- data/lib/merge_hris_client/api_client.rb +390 -0
- data/lib/merge_hris_client/api_error.rb +57 -0
- data/lib/merge_hris_client/configuration.rb +279 -0
- data/lib/merge_hris_client/models/account_integration.rb +325 -0
- data/lib/merge_hris_client/models/account_token.rb +223 -0
- data/lib/merge_hris_client/models/available_actions.rb +249 -0
- data/lib/merge_hris_client/models/benefit.rb +297 -0
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +56 -0
- data/lib/merge_hris_client/models/company.rb +277 -0
- data/lib/merge_hris_client/models/country_enum.rb +282 -0
- data/lib/merge_hris_client/models/data_passthrough.rb +262 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +271 -0
- data/lib/merge_hris_client/models/deduction.rb +275 -0
- data/lib/merge_hris_client/models/earning.rb +264 -0
- data/lib/merge_hris_client/models/employee.rb +544 -0
- data/lib/merge_hris_client/models/employee_payroll_run.rb +352 -0
- data/lib/merge_hris_client/models/employment.rb +330 -0
- data/lib/merge_hris_client/models/employment_status_enum.rb +37 -0
- data/lib/merge_hris_client/models/employment_type_enum.rb +39 -0
- data/lib/merge_hris_client/models/end_user_details.rb +289 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +298 -0
- data/lib/merge_hris_client/models/ethnicity_enum.rb +42 -0
- data/lib/merge_hris_client/models/flsa_status_enum.rb +38 -0
- data/lib/merge_hris_client/models/gender_enum.rb +39 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +224 -0
- data/lib/merge_hris_client/models/link_token.rb +237 -0
- data/lib/merge_hris_client/models/location.rb +319 -0
- data/lib/merge_hris_client/models/marital_status_enum.rb +39 -0
- data/lib/merge_hris_client/models/method_enum.rb +41 -0
- data/lib/merge_hris_client/models/model_operation.rb +256 -0
- data/lib/merge_hris_client/models/paginated_benefit_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_company_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employee_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employment_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_location_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_team_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_time_off_list.rb +240 -0
- data/lib/merge_hris_client/models/pay_currency_enum.rb +340 -0
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +43 -0
- data/lib/merge_hris_client/models/pay_period_enum.rb +42 -0
- data/lib/merge_hris_client/models/payroll_run.rb +297 -0
- data/lib/merge_hris_client/models/remote_data.rb +234 -0
- data/lib/merge_hris_client/models/remote_key.rb +238 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration.rb +224 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +224 -0
- data/lib/merge_hris_client/models/remote_response.rb +279 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/run_state_enum.rb +39 -0
- data/lib/merge_hris_client/models/run_type_enum.rb +49 -0
- data/lib/merge_hris_client/models/state_enum.rb +93 -0
- data/lib/merge_hris_client/models/sync_status.rb +294 -0
- data/lib/merge_hris_client/models/tax.rb +275 -0
- data/lib/merge_hris_client/models/team.rb +253 -0
- data/lib/merge_hris_client/models/time_off.rb +319 -0
- data/lib/merge_hris_client/models/time_off_status_enum.rb +39 -0
- data/lib/merge_hris_client/models/type_enum.rb +38 -0
- data/lib/merge_hris_client/models/units_enum.rb +36 -0
- data/lib/merge_hris_client/version.rb +15 -0
- data/merge_hris_client-1.0.0.gem +0 -0
- data/merge_hris_client.gemspec +38 -0
- data/pull_request_template.md +20 -0
- data/spec/api/account_token_api_spec.rb +46 -0
- data/spec/api/available_actions_api_spec.rb +46 -0
- data/spec/api/benefits_api_spec.rb +68 -0
- data/spec/api/companies_api_spec.rb +65 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +69 -0
- data/spec/api/employees_api_spec.rb +71 -0
- data/spec/api/employments_api_spec.rb +66 -0
- data/spec/api/link_token_api_spec.rb +46 -0
- data/spec/api/locations_api_spec.rb +65 -0
- data/spec/api/passthrough_api_spec.rb +48 -0
- data/spec/api/payroll_runs_api_spec.rb +65 -0
- data/spec/api/regenerate_key_api_spec.rb +46 -0
- data/spec/api/teams_api_spec.rb +65 -0
- data/spec/api/time_off_api_spec.rb +69 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_integration_spec.rb +58 -0
- data/spec/models/account_token_spec.rb +34 -0
- data/spec/models/available_actions_spec.rb +34 -0
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +70 -0
- data/spec/models/company_spec.rb +58 -0
- data/spec/models/country_enum_spec.rb +28 -0
- data/spec/models/data_passthrough_request_spec.rb +58 -0
- data/spec/models/data_passthrough_spec.rb +52 -0
- data/spec/models/deduction_spec.rb +58 -0
- data/spec/models/earning_spec.rb +52 -0
- data/spec/models/employee_payroll_run_spec.rb +100 -0
- data/spec/models/employee_spec.rb +166 -0
- data/spec/models/employment_spec.rb +88 -0
- data/spec/models/employment_status_enum_spec.rb +28 -0
- data/spec/models/employment_type_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +56 -0
- data/spec/models/end_user_details_spec.rb +56 -0
- data/spec/models/ethnicity_enum_spec.rb +28 -0
- data/spec/models/flsa_status_enum_spec.rb +28 -0
- data/spec/models/gender_enum_spec.rb +28 -0
- data/spec/models/link_token_spec.rb +40 -0
- data/spec/models/location_spec.rb +82 -0
- data/spec/models/marital_status_enum_spec.rb +28 -0
- data/spec/models/method_enum_spec.rb +28 -0
- data/spec/models/model_operation_spec.rb +40 -0
- data/spec/models/paginated_benefit_list_spec.rb +46 -0
- data/spec/models/paginated_company_list_spec.rb +46 -0
- data/spec/models/paginated_employee_list_spec.rb +46 -0
- data/spec/models/paginated_employee_payroll_run_list_spec.rb +46 -0
- data/spec/models/paginated_employment_list_spec.rb +46 -0
- data/spec/models/paginated_location_list_spec.rb +46 -0
- data/spec/models/paginated_payroll_run_list_spec.rb +46 -0
- data/spec/models/paginated_team_list_spec.rb +46 -0
- data/spec/models/paginated_time_off_list_spec.rb +46 -0
- data/spec/models/pay_currency_enum_spec.rb +28 -0
- data/spec/models/pay_frequency_enum_spec.rb +28 -0
- data/spec/models/pay_period_enum_spec.rb +28 -0
- data/spec/models/payroll_run_spec.rb +70 -0
- data/spec/models/remote_data_spec.rb +40 -0
- data/spec/models/remote_key_for_regeneration_request_spec.rb +34 -0
- data/spec/models/remote_key_for_regeneration_spec.rb +34 -0
- data/spec/models/remote_key_spec.rb +40 -0
- data/spec/models/remote_response_spec.rb +58 -0
- data/spec/models/request_type_enum_spec.rb +28 -0
- data/spec/models/run_state_enum_spec.rb +28 -0
- data/spec/models/run_type_enum_spec.rb +28 -0
- data/spec/models/state_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +58 -0
- data/spec/models/team_spec.rb +46 -0
- data/spec/models/time_off_spec.rb +82 -0
- data/spec/models/time_off_status_enum_spec.rb +28 -0
- data/spec/models/type_enum_spec.rb +28 -0
- data/spec/models/units_enum_spec.rb +28 -0
- data/spec/spec_helper.rb +111 -0
- data/test_ruby.rb +30 -0
- metadata +385 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MergeHRISClient::DataPassthrough
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **method** | [**MethodEnum**](MethodEnum.md) | | |
|
|
8
|
+
| **path** | **String** | | |
|
|
9
|
+
| **data** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
10
|
+
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'merge_hris_client'
|
|
16
|
+
|
|
17
|
+
instance = MergeHRISClient::DataPassthrough.new(
|
|
18
|
+
method: POST,
|
|
19
|
+
path: /scooters,
|
|
20
|
+
data: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
|
21
|
+
headers: {"EXTRA-HEADER":"value"}
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MergeHRISClient::DataPassthroughRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **method** | [**MethodEnum**](MethodEnum.md) | | |
|
|
8
|
+
| **path** | **String** | | |
|
|
9
|
+
| **base_url_override** | **String** | | [optional] |
|
|
10
|
+
| **data** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
11
|
+
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'merge_hris_client'
|
|
17
|
+
|
|
18
|
+
instance = MergeHRISClient::DataPassthroughRequest.new(
|
|
19
|
+
method: POST,
|
|
20
|
+
path: /scooters,
|
|
21
|
+
base_url_override: null,
|
|
22
|
+
data: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
|
23
|
+
headers: {"EXTRA-HEADER":"value"}
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/Deduction.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MergeHRISClient::Deduction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **employee_payroll_run** | **String** | The deduction's employee payroll run. | [optional] |
|
|
9
|
+
| **name** | **String** | The deduction's name. | [optional] |
|
|
10
|
+
| **employee_deduction** | **Float** | The amount the employee is deducting. | [optional] |
|
|
11
|
+
| **company_deduction** | **Float** | The amount the company is deducting. | [optional] |
|
|
12
|
+
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'merge_hris_client'
|
|
18
|
+
|
|
19
|
+
instance = MergeHRISClient::Deduction.new(
|
|
20
|
+
id: 5fd439fc-1b64-4755-b275-64918936c365,
|
|
21
|
+
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
|
22
|
+
name: Social Security,
|
|
23
|
+
employee_deduction: 34.54,
|
|
24
|
+
company_deduction: 78.78,
|
|
25
|
+
remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}]
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/Earning.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MergeHRISClient::Earning
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **employee_payroll_run** | **String** | The earning's employee payroll run. | [optional] |
|
|
9
|
+
| **amount** | **Float** | The amount earned. | [optional] |
|
|
10
|
+
| **type** | [**TypeEnum**](TypeEnum.md) | The type of earning. | [optional] |
|
|
11
|
+
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'merge_hris_client'
|
|
17
|
+
|
|
18
|
+
instance = MergeHRISClient::Earning.new(
|
|
19
|
+
id: babbced6-3a81-4775-8da2-490dc6385259,
|
|
20
|
+
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
|
21
|
+
amount: 1002.34,
|
|
22
|
+
type: SALARY,
|
|
23
|
+
remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}]
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/Employee.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# MergeHRISClient::Employee
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
+
| **company** | **String** | The ID of the Employee's company. | [optional] |
|
|
10
|
+
| **first_name** | **String** | The employee's first name. | [optional] |
|
|
11
|
+
| **last_name** | **String** | The employee's last name. | [optional] |
|
|
12
|
+
| **display_full_name** | **String** | The employee's full name, to use for display purposes. | [optional] |
|
|
13
|
+
| **work_email** | **String** | The employee's work email. | [optional] |
|
|
14
|
+
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
|
15
|
+
| **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
|
|
16
|
+
| **employments** | **Array<String>** | | [optional][readonly] |
|
|
17
|
+
| **home_location** | **String** | The employee's home address. | [optional] |
|
|
18
|
+
| **work_location** | **String** | The employee's work address. | [optional] |
|
|
19
|
+
| **manager** | **String** | The employee ID of the employee's manager. | [optional] |
|
|
20
|
+
| **team** | **String** | The employee's team. | [optional] |
|
|
21
|
+
| **ssn** | **String** | The employee's social security number. | [optional] |
|
|
22
|
+
| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
|
|
23
|
+
| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
|
|
24
|
+
| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
|
|
25
|
+
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
|
26
|
+
| **hire_date** | **Time** | The employee's hire date. | [optional] |
|
|
27
|
+
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
|
28
|
+
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
|
29
|
+
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
|
30
|
+
| **employee_number** | **String** | The identification number for the employee. | [optional] |
|
|
31
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
```ruby
|
|
36
|
+
require 'merge_hris_client'
|
|
37
|
+
|
|
38
|
+
instance = MergeHRISClient::Employee.new(
|
|
39
|
+
id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
|
40
|
+
remote_id: 19202938,
|
|
41
|
+
company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
|
42
|
+
first_name: Jane,
|
|
43
|
+
last_name: Doe,
|
|
44
|
+
display_full_name: Jane Doe,
|
|
45
|
+
work_email: jane@merge.dev,
|
|
46
|
+
personal_email: jane@gmail.com,
|
|
47
|
+
mobile_phone_number: +1234567890,
|
|
48
|
+
employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
|
49
|
+
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
50
|
+
work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
|
51
|
+
manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
|
|
52
|
+
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
|
53
|
+
ssn: 1234567890,
|
|
54
|
+
gender: FEMALE,
|
|
55
|
+
ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
|
|
56
|
+
marital_status: SINGLE,
|
|
57
|
+
date_of_birth: null,
|
|
58
|
+
hire_date: null,
|
|
59
|
+
employment_status: ACTIVE,
|
|
60
|
+
termination_date: null,
|
|
61
|
+
avatar: http://alturl.com/h2h8m,
|
|
62
|
+
employee_number: null,
|
|
63
|
+
remote_data: [{"path":"/people","data":["Varies by platform"]}]
|
|
64
|
+
)
|
|
65
|
+
```
|
|
66
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# MergeHRISClient::EmployeePayrollRun
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
+
| **employee** | **String** | The employee whose payroll is being run. | [optional] |
|
|
10
|
+
| **payroll_run** | **String** | The payroll being run. | [optional] |
|
|
11
|
+
| **gross_pay** | **Float** | The gross pay from the run. | [optional] |
|
|
12
|
+
| **net_pay** | **Float** | The net pay from the run. | [optional] |
|
|
13
|
+
| **start_date** | **Time** | The day and time the payroll run started. | [optional] |
|
|
14
|
+
| **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
|
|
15
|
+
| **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
|
|
16
|
+
| **earnings** | [**Array<Earning>**](Earning.md) | | [optional][readonly] |
|
|
17
|
+
| **deductions** | [**Array<Deduction>**](Deduction.md) | | [optional][readonly] |
|
|
18
|
+
| **taxes** | [**Array<Tax>**](Tax.md) | | [optional][readonly] |
|
|
19
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'merge_hris_client'
|
|
25
|
+
|
|
26
|
+
instance = MergeHRISClient::EmployeePayrollRun.new(
|
|
27
|
+
id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
|
|
28
|
+
remote_id: 19202938,
|
|
29
|
+
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
30
|
+
payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
|
31
|
+
gross_pay: 1342.67,
|
|
32
|
+
net_pay: 865.78,
|
|
33
|
+
start_date: null,
|
|
34
|
+
end_date: null,
|
|
35
|
+
check_date: null,
|
|
36
|
+
earnings: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":1002.34,"type":"SALARY"},{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":8342.34,"type":"OVERTIME"}],
|
|
37
|
+
deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
|
|
38
|
+
taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],
|
|
39
|
+
remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}]
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# MergeHRISClient::EmployeePayrollRunsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**employee_payroll_runs_list**](EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs | |
|
|
8
|
+
| [**employee_payroll_runs_retrieve**](EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} | |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## employee_payroll_runs_list
|
|
12
|
+
|
|
13
|
+
> <PaginatedEmployeePayrollRunList> employee_payroll_runs_list(x_account_token, opts)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
Returns a list of `EmployeePayrollRun` objects.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'merge_hris_client'
|
|
24
|
+
# setup authorization
|
|
25
|
+
MergeHRISClient.configure do |config|
|
|
26
|
+
# Configure API key authorization: tokenAuth
|
|
27
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = MergeHRISClient::EmployeePayrollRunsApi.new
|
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
34
|
+
opts = {
|
|
35
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
|
36
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
37
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
38
|
+
employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
|
|
39
|
+
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
43
|
+
page_size: 56, # Integer | Number of results to return per page.
|
|
44
|
+
payroll_run_id: 'payroll_run_id_example', # String | If provided, will only return employee payroll runs for this employee.
|
|
45
|
+
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
begin
|
|
49
|
+
|
|
50
|
+
result = api_instance.employee_payroll_runs_list(x_account_token, opts)
|
|
51
|
+
p result
|
|
52
|
+
rescue MergeHRISClient::ApiError => e
|
|
53
|
+
puts "Error when calling EmployeePayrollRunsApi->employee_payroll_runs_list: #{e}"
|
|
54
|
+
end
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Using the employee_payroll_runs_list_with_http_info variant
|
|
58
|
+
|
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
|
60
|
+
|
|
61
|
+
> <Array(<PaginatedEmployeePayrollRunList>, Integer, Hash)> employee_payroll_runs_list_with_http_info(x_account_token, opts)
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
begin
|
|
65
|
+
|
|
66
|
+
data, status_code, headers = api_instance.employee_payroll_runs_list_with_http_info(x_account_token, opts)
|
|
67
|
+
p status_code # => 2xx
|
|
68
|
+
p headers # => { ... }
|
|
69
|
+
p data # => <PaginatedEmployeePayrollRunList>
|
|
70
|
+
rescue MergeHRISClient::ApiError => e
|
|
71
|
+
puts "Error when calling EmployeePayrollRunsApi->employee_payroll_runs_list_with_http_info: #{e}"
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
| Name | Type | Description | Notes |
|
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
|
79
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
80
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
|
81
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
82
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
83
|
+
| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
|
|
84
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
85
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
86
|
+
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
87
|
+
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
88
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
89
|
+
| **payroll_run_id** | **String** | If provided, will only return employee payroll runs for this employee. | [optional] |
|
|
90
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
[**PaginatedEmployeePayrollRunList**](PaginatedEmployeePayrollRunList.md)
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: Not defined
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
## employee_payroll_runs_retrieve
|
|
107
|
+
|
|
108
|
+
> <EmployeePayrollRun> employee_payroll_runs_retrieve(x_account_token, id, opts)
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
Returns an `EmployeePayrollRun` object with the given `id`.
|
|
113
|
+
|
|
114
|
+
### Examples
|
|
115
|
+
|
|
116
|
+
```ruby
|
|
117
|
+
require 'time'
|
|
118
|
+
require 'merge_hris_client'
|
|
119
|
+
# setup authorization
|
|
120
|
+
MergeHRISClient.configure do |config|
|
|
121
|
+
# Configure API key authorization: tokenAuth
|
|
122
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
124
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
api_instance = MergeHRISClient::EmployeePayrollRunsApi.new
|
|
128
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
129
|
+
id = TODO # String |
|
|
130
|
+
opts = {
|
|
131
|
+
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
132
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
begin
|
|
136
|
+
|
|
137
|
+
result = api_instance.employee_payroll_runs_retrieve(x_account_token, id, opts)
|
|
138
|
+
p result
|
|
139
|
+
rescue MergeHRISClient::ApiError => e
|
|
140
|
+
puts "Error when calling EmployeePayrollRunsApi->employee_payroll_runs_retrieve: #{e}"
|
|
141
|
+
end
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
#### Using the employee_payroll_runs_retrieve_with_http_info variant
|
|
145
|
+
|
|
146
|
+
This returns an Array which contains the response data, status code and headers.
|
|
147
|
+
|
|
148
|
+
> <Array(<EmployeePayrollRun>, Integer, Hash)> employee_payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
|
|
149
|
+
|
|
150
|
+
```ruby
|
|
151
|
+
begin
|
|
152
|
+
|
|
153
|
+
data, status_code, headers = api_instance.employee_payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
|
|
154
|
+
p status_code # => 2xx
|
|
155
|
+
p headers # => { ... }
|
|
156
|
+
p data # => <EmployeePayrollRun>
|
|
157
|
+
rescue MergeHRISClient::ApiError => e
|
|
158
|
+
puts "Error when calling EmployeePayrollRunsApi->employee_payroll_runs_retrieve_with_http_info: #{e}"
|
|
159
|
+
end
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
| Name | Type | Description | Notes |
|
|
165
|
+
| ---- | ---- | ----------- | ----- |
|
|
166
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
167
|
+
| **id** | [**String**](.md) | | |
|
|
168
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
169
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
[**EmployeePayrollRun**](EmployeePayrollRun.md)
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: Not defined
|
|
182
|
+
- **Accept**: application/json
|
|
183
|
+
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# MergeHRISClient::EmployeesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**employees_list**](EmployeesApi.md#employees_list) | **GET** /employees | |
|
|
8
|
+
| [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## employees_list
|
|
12
|
+
|
|
13
|
+
> <PaginatedEmployeeList> employees_list(x_account_token, opts)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
Returns a list of `Employee` objects.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'merge_hris_client'
|
|
24
|
+
# setup authorization
|
|
25
|
+
MergeHRISClient.configure do |config|
|
|
26
|
+
# Configure API key authorization: tokenAuth
|
|
27
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = MergeHRISClient::EmployeesApi.new
|
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
34
|
+
opts = {
|
|
35
|
+
company_id: 'company_id_example', # String | If provided, will only return employees for this company.
|
|
36
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
|
37
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
38
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
39
|
+
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
41
|
+
manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
|
|
42
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
43
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
44
|
+
page_size: 56, # Integer | Number of results to return per page.
|
|
45
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
|
46
|
+
team_id: 'team_id_example', # String | If provided, will only return employees for this team.
|
|
47
|
+
work_location_id: 'work_location_id_example' # String | If provided, will only return employees for this location.
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
begin
|
|
51
|
+
|
|
52
|
+
result = api_instance.employees_list(x_account_token, opts)
|
|
53
|
+
p result
|
|
54
|
+
rescue MergeHRISClient::ApiError => e
|
|
55
|
+
puts "Error when calling EmployeesApi->employees_list: #{e}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### Using the employees_list_with_http_info variant
|
|
60
|
+
|
|
61
|
+
This returns an Array which contains the response data, status code and headers.
|
|
62
|
+
|
|
63
|
+
> <Array(<PaginatedEmployeeList>, Integer, Hash)> employees_list_with_http_info(x_account_token, opts)
|
|
64
|
+
|
|
65
|
+
```ruby
|
|
66
|
+
begin
|
|
67
|
+
|
|
68
|
+
data, status_code, headers = api_instance.employees_list_with_http_info(x_account_token, opts)
|
|
69
|
+
p status_code # => 2xx
|
|
70
|
+
p headers # => { ... }
|
|
71
|
+
p data # => <PaginatedEmployeeList>
|
|
72
|
+
rescue MergeHRISClient::ApiError => e
|
|
73
|
+
puts "Error when calling EmployeesApi->employees_list_with_http_info: #{e}"
|
|
74
|
+
end
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Parameters
|
|
78
|
+
|
|
79
|
+
| Name | Type | Description | Notes |
|
|
80
|
+
| ---- | ---- | ----------- | ----- |
|
|
81
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
82
|
+
| **company_id** | **String** | If provided, will only return employees for this company. | [optional] |
|
|
83
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
|
84
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
85
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
86
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
87
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
88
|
+
| **manager_id** | **String** | If provided, will only return employees for this manager. | [optional] |
|
|
89
|
+
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
90
|
+
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
91
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
92
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
93
|
+
| **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
|
|
94
|
+
| **work_location_id** | **String** | If provided, will only return employees for this location. | [optional] |
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
[**PaginatedEmployeeList**](PaginatedEmployeeList.md)
|
|
99
|
+
|
|
100
|
+
### Authorization
|
|
101
|
+
|
|
102
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: Not defined
|
|
107
|
+
- **Accept**: application/json
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
## employees_retrieve
|
|
111
|
+
|
|
112
|
+
> <Employee> employees_retrieve(x_account_token, id, opts)
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
Returns an `Employee` object with the given `id`.
|
|
117
|
+
|
|
118
|
+
### Examples
|
|
119
|
+
|
|
120
|
+
```ruby
|
|
121
|
+
require 'time'
|
|
122
|
+
require 'merge_hris_client'
|
|
123
|
+
# setup authorization
|
|
124
|
+
MergeHRISClient.configure do |config|
|
|
125
|
+
# Configure API key authorization: tokenAuth
|
|
126
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
127
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
128
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
api_instance = MergeHRISClient::EmployeesApi.new
|
|
132
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
133
|
+
id = TODO # String |
|
|
134
|
+
opts = {
|
|
135
|
+
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
136
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
begin
|
|
140
|
+
|
|
141
|
+
result = api_instance.employees_retrieve(x_account_token, id, opts)
|
|
142
|
+
p result
|
|
143
|
+
rescue MergeHRISClient::ApiError => e
|
|
144
|
+
puts "Error when calling EmployeesApi->employees_retrieve: #{e}"
|
|
145
|
+
end
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### Using the employees_retrieve_with_http_info variant
|
|
149
|
+
|
|
150
|
+
This returns an Array which contains the response data, status code and headers.
|
|
151
|
+
|
|
152
|
+
> <Array(<Employee>, Integer, Hash)> employees_retrieve_with_http_info(x_account_token, id, opts)
|
|
153
|
+
|
|
154
|
+
```ruby
|
|
155
|
+
begin
|
|
156
|
+
|
|
157
|
+
data, status_code, headers = api_instance.employees_retrieve_with_http_info(x_account_token, id, opts)
|
|
158
|
+
p status_code # => 2xx
|
|
159
|
+
p headers # => { ... }
|
|
160
|
+
p data # => <Employee>
|
|
161
|
+
rescue MergeHRISClient::ApiError => e
|
|
162
|
+
puts "Error when calling EmployeesApi->employees_retrieve_with_http_info: #{e}"
|
|
163
|
+
end
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Parameters
|
|
167
|
+
|
|
168
|
+
| Name | Type | Description | Notes |
|
|
169
|
+
| ---- | ---- | ----------- | ----- |
|
|
170
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
171
|
+
| **id** | [**String**](.md) | | |
|
|
172
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
173
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
174
|
+
|
|
175
|
+
### Return type
|
|
176
|
+
|
|
177
|
+
[**Employee**](Employee.md)
|
|
178
|
+
|
|
179
|
+
### Authorization
|
|
180
|
+
|
|
181
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
182
|
+
|
|
183
|
+
### HTTP request headers
|
|
184
|
+
|
|
185
|
+
- **Content-Type**: Not defined
|
|
186
|
+
- **Accept**: application/json
|
|
187
|
+
|