merge_hris_client 1.0.2 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +59 -19
- data/docs/AccountDetails.md +30 -0
- data/docs/AccountDetailsAndActions.md +32 -0
- data/docs/AccountDetailsAndActionsIntegration.md +32 -0
- data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
- data/docs/AccountDetailsApi.md +76 -0
- data/docs/AccountIntegration.md +4 -4
- data/docs/AccountTokenApi.md +2 -2
- data/docs/AccountTypeEnum.md +15 -0
- data/docs/AvailableActionsApi.md +2 -2
- data/docs/BankInfo.md +34 -0
- data/docs/BankInfoApi.md +189 -0
- data/docs/Benefit.md +2 -2
- data/docs/BenefitsApi.md +6 -82
- data/docs/CategoriesEnum.md +15 -0
- data/docs/{StateEnum.md → CategoryEnum.md} +2 -2
- data/docs/CompaniesApi.md +6 -4
- data/docs/DataPassthroughRequest.md +7 -3
- data/docs/DebugModeLog.md +22 -0
- data/docs/DebugModelLogSummary.md +22 -0
- data/docs/Deduction.md +2 -2
- data/docs/DeductionsApi.md +179 -0
- data/docs/DeleteAccountApi.md +3 -2
- data/docs/Earning.md +3 -3
- data/docs/EarningTypeEnum.md +15 -0
- data/docs/Employee.md +20 -14
- data/docs/EmployeeEndpointRequest.md +18 -0
- data/docs/EmployeePayrollRun.md +5 -5
- data/docs/EmployeePayrollRunsApi.md +17 -7
- data/docs/EmployeeRequest.md +21 -13
- data/docs/EmployeeResponse.md +24 -0
- data/docs/EmployeesApi.md +101 -17
- data/docs/Employment.md +3 -1
- data/docs/EmploymentsApi.md +12 -82
- data/docs/EncodingEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +4 -2
- data/docs/ErrorValidationProblem.md +24 -0
- data/docs/ForceResyncApi.md +79 -0
- data/docs/GenerateKeyApi.md +2 -2
- data/docs/Group.md +28 -0
- data/docs/GroupTypeEnum.md +15 -0
- data/docs/GroupsApi.md +177 -0
- data/docs/IgnoreCommonModel.md +20 -0
- data/docs/IgnoreCommonModelRequest.md +20 -0
- data/docs/IssuesApi.md +16 -14
- data/docs/LinkTokenApi.md +3 -3
- data/docs/LinkedAccountsApi.md +103 -0
- data/docs/Location.md +4 -0
- data/docs/LocationTypeEnum.md +15 -0
- data/docs/LocationsApi.md +6 -4
- data/docs/MultipartFormFieldRequest.md +26 -0
- data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
- data/docs/PaginatedBankInfoList.md +22 -0
- data/docs/PaginatedDeductionList.md +22 -0
- data/docs/PaginatedGroupList.md +22 -0
- data/docs/PaginatedIssueList.md +2 -2
- data/docs/PaginatedPayGroupList.md +22 -0
- data/docs/PaginatedSyncStatusList.md +2 -2
- data/docs/PassthroughApi.md +2 -2
- data/docs/PayGroup.md +24 -0
- data/docs/PayGroupsApi.md +177 -0
- data/docs/PayrollRun.md +3 -3
- data/docs/PayrollRunsApi.md +17 -5
- data/docs/PolicyTypeEnum.md +15 -0
- data/docs/{NullEnum.md → ReasonEnum.md} +2 -2
- data/docs/RegenerateKeyApi.md +2 -2
- data/docs/RequestFormatEnum.md +15 -0
- data/docs/SyncStatusApi.md +3 -75
- data/docs/Tax.md +2 -2
- data/docs/Team.md +1 -1
- data/docs/TeamsApi.md +12 -6
- data/docs/TimeOff.md +5 -5
- data/docs/TimeOffApi.md +92 -6
- data/docs/TimeOffBalance.md +5 -3
- data/docs/{TimeOffBalanceApi.md → TimeOffBalancesApi.md} +26 -22
- data/docs/TimeOffEndpointRequest.md +18 -0
- data/docs/TimeOffRequest.md +36 -0
- data/docs/TimeOffResponse.md +24 -0
- data/docs/ValidationProblemSource.md +18 -0
- data/docs/WarningValidationProblem.md +24 -0
- data/lib/merge_hris_client/api/account_details_api.rb +77 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +217 -0
- data/lib/merge_hris_client/api/benefits_api.rb +3 -69
- data/lib/merge_hris_client/api/companies_api.rb +3 -0
- data/lib/merge_hris_client/api/deductions_api.rb +185 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +17 -2
- data/lib/merge_hris_client/api/employees_api.rb +103 -15
- data/lib/merge_hris_client/api/employments_api.rb +24 -69
- data/lib/merge_hris_client/api/force_resync_api.rb +84 -0
- data/lib/merge_hris_client/api/groups_api.rb +182 -0
- data/lib/merge_hris_client/api/issues_api.rb +10 -10
- data/lib/merge_hris_client/api/linked_accounts_api.rb +117 -0
- data/lib/merge_hris_client/api/locations_api.rb +3 -0
- data/lib/merge_hris_client/api/pay_groups_api.rb +182 -0
- data/lib/merge_hris_client/api/payroll_runs_api.rb +22 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +4 -66
- data/lib/merge_hris_client/api/teams_api.rb +17 -0
- data/lib/merge_hris_client/api/time_off_api.rb +95 -2
- data/lib/merge_hris_client/api/time_off_balances_api.rb +206 -0
- data/lib/merge_hris_client/configuration.rb +6 -4
- data/lib/merge_hris_client/models/account_details.rb +273 -0
- data/lib/merge_hris_client/models/account_details_and_actions.rb +302 -0
- data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +310 -0
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +37 -0
- data/lib/merge_hris_client/models/account_integration.rb +6 -28
- data/lib/merge_hris_client/models/account_token.rb +1 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +36 -0
- data/lib/merge_hris_client/models/available_actions.rb +1 -1
- data/lib/merge_hris_client/models/bank_info.rb +322 -0
- data/lib/merge_hris_client/models/benefit.rb +2 -3
- data/lib/merge_hris_client/models/categories_enum.rb +37 -0
- data/lib/merge_hris_client/models/category_enum.rb +37 -0
- data/lib/merge_hris_client/models/company.rb +1 -1
- data/lib/merge_hris_client/models/country_enum.rb +1 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +79 -9
- data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
- data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
- data/lib/merge_hris_client/models/deduction.rb +1 -2
- data/lib/merge_hris_client/models/earning.rb +4 -8
- data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/employee.rb +43 -14
- data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
- data/lib/merge_hris_client/models/employee_request.rb +55 -14
- data/lib/merge_hris_client/models/employee_response.rb +266 -0
- data/lib/merge_hris_client/models/employment.rb +12 -2
- data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/encoding_enum.rb +36 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +113 -28
- data/lib/merge_hris_client/models/error_validation_problem.rb +260 -0
- data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
- data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/gender_enum.rb +1 -1
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +20 -1
- data/lib/merge_hris_client/models/{benefit_request.rb → group.rb} +48 -49
- data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
- data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
- data/lib/merge_hris_client/models/issue.rb +1 -1
- data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/link_token.rb +1 -1
- data/lib/merge_hris_client/models/location.rb +24 -2
- data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
- data/lib/merge_hris_client/models/marital_status_enum.rb +2 -2
- data/lib/merge_hris_client/models/method_enum.rb +1 -1
- data/lib/merge_hris_client/models/model_operation.rb +1 -1
- data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
- data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_bank_info_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_deduction_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_pay_group_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
- data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
- data/lib/merge_hris_client/models/pay_group.rb +253 -0
- data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
- data/lib/merge_hris_client/models/payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/policy_type_enum.rb +40 -0
- data/lib/merge_hris_client/models/reason_enum.rb +37 -0
- data/lib/merge_hris_client/models/remote_data.rb +1 -1
- data/lib/merge_hris_client/models/remote_data_request.rb +20 -1
- data/lib/merge_hris_client/models/remote_key.rb +1 -1
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +20 -1
- data/lib/merge_hris_client/models/remote_response.rb +1 -1
- data/lib/merge_hris_client/models/request_format_enum.rb +37 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +3 -1
- data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
- data/lib/merge_hris_client/models/sync_status.rb +1 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +3 -2
- data/lib/merge_hris_client/models/tax.rb +3 -7
- data/lib/merge_hris_client/models/team.rb +1 -2
- data/lib/merge_hris_client/models/time_off.rb +1 -3
- data/lib/merge_hris_client/models/time_off_balance.rb +15 -5
- data/lib/merge_hris_client/models/time_off_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/{employment_request.rb → time_off_request.rb} +79 -70
- data/lib/merge_hris_client/models/time_off_response.rb +266 -0
- data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/units_enum.rb +1 -1
- data/lib/merge_hris_client/models/validation_problem_source.rb +223 -0
- data/lib/merge_hris_client/models/warning_validation_problem.rb +260 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +43 -5
- data/pull_request_template.md +3 -1
- data/spec/api/account_details_api_spec.rb +45 -0
- data/spec/api/account_token_api_spec.rb +1 -1
- data/spec/api/available_actions_api_spec.rb +1 -1
- data/spec/api/bank_info_api_spec.rb +74 -0
- data/spec/api/benefits_api_spec.rb +4 -1
- data/spec/api/companies_api_spec.rb +4 -1
- data/spec/api/deductions_api_spec.rb +69 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +9 -2
- data/spec/api/employees_api_spec.rb +35 -1
- data/spec/api/employments_api_spec.rb +7 -1
- data/spec/api/force_resync_api_spec.rb +46 -0
- data/spec/api/groups_api_spec.rb +68 -0
- data/spec/api/issues_api_spec.rb +5 -5
- data/spec/api/link_token_api_spec.rb +2 -2
- data/spec/api/linked_accounts_api_spec.rb +57 -0
- data/spec/api/locations_api_spec.rb +4 -1
- data/spec/api/passthrough_api_spec.rb +2 -3
- data/spec/api/pay_groups_api_spec.rb +68 -0
- data/spec/api/payroll_runs_api_spec.rb +9 -1
- data/spec/api/regenerate_key_api_spec.rb +2 -2
- data/spec/api/sync_status_api_spec.rb +2 -13
- data/spec/api/teams_api_spec.rb +7 -1
- data/spec/api/time_off_api_spec.rb +21 -2
- data/spec/api/{time_off_balance_api_spec.rb → time_off_balances_api_spec.rb} +13 -11
- data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
- data/spec/models/account_details_and_actions_spec.rb +76 -0
- data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
- data/spec/models/account_details_spec.rb +70 -0
- data/spec/models/account_integration_spec.rb +7 -1
- data/spec/models/account_token_spec.rb +7 -1
- data/spec/models/account_type_enum_spec.rb +28 -0
- data/spec/models/available_actions_spec.rb +13 -1
- data/spec/models/{employment_request_spec.rb → bank_info_spec.rb} +15 -15
- data/spec/models/benefit_plan_type_enum_spec.rb +1 -1
- data/spec/models/benefit_spec.rb +7 -1
- data/spec/models/categories_enum_spec.rb +28 -0
- data/spec/models/category_enum_spec.rb +28 -0
- data/spec/models/company_spec.rb +7 -1
- data/spec/models/country_enum_spec.rb +1 -1
- data/spec/models/data_passthrough_request_spec.rb +13 -1
- data/spec/models/debug_mode_log_spec.rb +46 -0
- data/spec/models/debug_model_log_summary_spec.rb +46 -0
- data/spec/models/deduction_spec.rb +7 -1
- data/spec/models/earning_spec.rb +7 -1
- data/spec/models/earning_type_enum_spec.rb +28 -0
- data/spec/models/{remote_key_for_regeneration_spec.rb → employee_endpoint_request_spec.rb} +8 -8
- data/spec/models/employee_payroll_run_spec.rb +7 -1
- data/spec/models/employee_request_spec.rb +30 -0
- data/spec/models/{end_user_details_spec.rb → employee_response_spec.rb} +11 -15
- data/spec/models/employee_spec.rb +37 -1
- data/spec/models/employment_spec.rb +13 -1
- data/spec/models/employment_status_enum_spec.rb +1 -1
- data/spec/models/employment_type_enum_spec.rb +1 -1
- data/spec/models/encoding_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +13 -5
- data/spec/models/error_validation_problem_spec.rb +52 -0
- data/spec/models/ethnicity_enum_spec.rb +1 -1
- data/spec/models/flsa_status_enum_spec.rb +1 -1
- data/spec/models/gender_enum_spec.rb +1 -1
- data/spec/models/{benefit_request_spec.rb → group_spec.rb} +12 -12
- data/spec/models/group_type_enum_spec.rb +28 -0
- data/spec/models/ignore_common_model_request_spec.rb +40 -0
- data/spec/models/ignore_common_model_spec.rb +40 -0
- data/spec/models/link_token_spec.rb +1 -1
- data/spec/models/location_spec.rb +19 -1
- data/spec/models/location_type_enum_spec.rb +28 -0
- data/spec/models/marital_status_enum_spec.rb +1 -1
- data/spec/models/method_enum_spec.rb +1 -1
- data/spec/models/model_operation_spec.rb +13 -1
- data/spec/models/multipart_form_field_request_spec.rb +58 -0
- data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
- data/spec/models/paginated_bank_info_list_spec.rb +46 -0
- data/spec/models/paginated_benefit_list_spec.rb +1 -1
- data/spec/models/paginated_company_list_spec.rb +1 -1
- data/spec/models/paginated_deduction_list_spec.rb +46 -0
- data/spec/models/paginated_employee_list_spec.rb +1 -1
- data/spec/models/paginated_employee_payroll_run_list_spec.rb +1 -1
- data/spec/models/paginated_employment_list_spec.rb +1 -1
- data/spec/models/paginated_group_list_spec.rb +46 -0
- data/spec/models/paginated_location_list_spec.rb +1 -1
- data/spec/models/paginated_pay_group_list_spec.rb +46 -0
- data/spec/models/paginated_payroll_run_list_spec.rb +1 -1
- data/spec/models/paginated_team_list_spec.rb +1 -1
- data/spec/models/paginated_time_off_list_spec.rb +1 -1
- data/spec/models/pay_currency_enum_spec.rb +1 -1
- data/spec/models/pay_frequency_enum_spec.rb +1 -1
- data/spec/models/{data_passthrough_spec.rb → pay_group_spec.rb} +11 -11
- data/spec/models/pay_period_enum_spec.rb +1 -1
- data/spec/models/payroll_run_spec.rb +7 -1
- data/spec/models/policy_type_enum_spec.rb +28 -0
- data/spec/models/{state_enum_spec.rb → reason_enum_spec.rb} +7 -7
- data/spec/models/remote_data_spec.rb +1 -1
- data/spec/models/remote_key_for_regeneration_request_spec.rb +1 -1
- data/spec/models/remote_key_spec.rb +1 -1
- data/spec/models/remote_response_spec.rb +1 -1
- data/spec/models/request_format_enum_spec.rb +28 -0
- data/spec/models/request_type_enum_spec.rb +1 -1
- data/spec/models/run_state_enum_spec.rb +1 -1
- data/spec/models/run_type_enum_spec.rb +1 -1
- data/spec/models/tax_spec.rb +7 -1
- data/spec/models/team_spec.rb +13 -1
- data/spec/models/time_off_balance_spec.rb +6 -0
- data/spec/models/time_off_endpoint_request_spec.rb +34 -0
- data/spec/models/time_off_request_spec.rb +88 -0
- data/spec/models/time_off_response_spec.rb +52 -0
- data/spec/models/time_off_spec.rb +19 -1
- data/spec/models/time_off_status_enum_spec.rb +1 -1
- data/spec/models/type_enum_spec.rb +1 -1
- data/spec/models/units_enum_spec.rb +1 -1
- data/spec/models/validation_problem_source_spec.rb +34 -0
- data/spec/models/warning_validation_problem_spec.rb +52 -0
- data/test_ruby.rb +11 -14
- metadata +175 -29
- data/docs/BenefitRequest.md +0 -28
- data/docs/DataPassthrough.md +0 -24
- data/docs/EmploymentRequest.md +0 -34
- data/docs/EndUserDetails.md +0 -24
- data/docs/RemoteKeyForRegeneration.md +0 -18
- data/merge_hris_client-1.0.0.gem +0 -0
- data/merge_hris_client-1.0.1.gem +0 -0
data/docs/DeleteAccountApi.md
CHANGED
@@ -23,8 +23,9 @@ require 'merge_hris_client'
|
|
23
23
|
# setup authorization
|
24
24
|
MergeHRISClient.configure do |config|
|
25
25
|
# Configure API key authorization: tokenAuth
|
26
|
-
config.api_key['
|
27
|
-
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
28
29
|
end
|
29
30
|
|
30
31
|
api_instance = MergeHRISClient::DeleteAccountApi.new
|
data/docs/Earning.md
CHANGED
@@ -5,10 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
|
-
| **employee_payroll_run** | **String** |
|
8
|
+
| **employee_payroll_run** | **String** | | [optional] |
|
9
9
|
| **amount** | **Float** | The amount earned. | [optional] |
|
10
|
-
| **type** | [**
|
11
|
-
| **remote_data** | **
|
10
|
+
| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
|
11
|
+
| **remote_data** | **String** | | [optional][readonly] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::EarningTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_hris_client'
|
12
|
+
|
13
|
+
instance = MergeHRISClient::EarningTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/Employee.md
CHANGED
@@ -7,29 +7,32 @@
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **employee_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. | [optional] |
|
10
|
-
| **company** | **String** |
|
10
|
+
| **company** | **String** | | [optional] |
|
11
11
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
12
12
|
| **last_name** | **String** | The employee's last name. | [optional] |
|
13
|
-
| **display_full_name** | **String** | The employee's full name, to use for display purposes. | [optional] |
|
13
|
+
| **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
|
14
|
+
| **groups** | **Array<String>** | | [optional] |
|
14
15
|
| **work_email** | **String** | The employee's work email. | [optional] |
|
15
16
|
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
16
17
|
| **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
|
17
|
-
| **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional]
|
18
|
-
| **home_location** | **String** |
|
19
|
-
| **work_location** | **String** |
|
20
|
-
| **manager** | **String** |
|
21
|
-
| **team** | **String** |
|
18
|
+
| **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
|
19
|
+
| **home_location** | **String** | | [optional] |
|
20
|
+
| **work_location** | **String** | | [optional] |
|
21
|
+
| **manager** | **String** | | [optional] |
|
22
|
+
| **team** | **String** | | [optional] |
|
23
|
+
| **pay_group** | **String** | | [optional] |
|
22
24
|
| **ssn** | **String** | The employee's social security number. | [optional] |
|
23
25
|
| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
|
24
26
|
| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
|
25
27
|
| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
|
26
28
|
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
27
|
-
| **hire_date** | **Time** | The employee
|
28
|
-
| **start_date** | **Time** | The employee
|
29
|
+
| **hire_date** | **Time** | The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. | [optional] |
|
30
|
+
| **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
|
29
31
|
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
30
32
|
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
31
33
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
32
34
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
35
|
+
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
33
36
|
|
34
37
|
## Example
|
35
38
|
|
@@ -44,6 +47,7 @@ instance = MergeHRISClient::Employee.new(
|
|
44
47
|
first_name: Jane,
|
45
48
|
last_name: Doe,
|
46
49
|
display_full_name: Jane Doe,
|
50
|
+
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
47
51
|
work_email: jane@merge.dev,
|
48
52
|
personal_email: jane@gmail.com,
|
49
53
|
mobile_phone_number: +1234567890,
|
@@ -52,17 +56,19 @@ instance = MergeHRISClient::Employee.new(
|
|
52
56
|
work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
53
57
|
manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
|
54
58
|
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
59
|
+
pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
|
55
60
|
ssn: 1234567890,
|
56
61
|
gender: FEMALE,
|
57
62
|
ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
|
58
63
|
marital_status: SINGLE,
|
59
|
-
date_of_birth:
|
60
|
-
hire_date:
|
61
|
-
start_date:
|
64
|
+
date_of_birth: 1990-11-10T00:00Z,
|
65
|
+
hire_date: 2020-10-10T00:00Z,
|
66
|
+
start_date: 2020-10-11T00:00Z,
|
62
67
|
employment_status: INACTIVE,
|
63
|
-
termination_date:
|
68
|
+
termination_date: 2021-10-12T00:00Z,
|
64
69
|
avatar: http://alturl.com/h2h8m,
|
65
|
-
remote_data: [{"path":"/people","data":["Varies by platform"]}]
|
70
|
+
remote_data: [{"path":"/people","data":["Varies by platform"]}],
|
71
|
+
custom_fields: null
|
66
72
|
)
|
67
73
|
```
|
68
74
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::EmployeeEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**EmployeeRequest**](EmployeeRequest.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::EmployeeEndpointRequest.new(
|
15
|
+
model: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/EmployeePayrollRun.md
CHANGED
@@ -6,8 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **employee** | **String** |
|
10
|
-
| **payroll_run** | **String** |
|
9
|
+
| **employee** | **String** | | [optional] |
|
10
|
+
| **payroll_run** | **String** | | [optional] |
|
11
11
|
| **gross_pay** | **Float** | The gross pay from the run. | [optional] |
|
12
12
|
| **net_pay** | **Float** | The net pay from the run. | [optional] |
|
13
13
|
| **start_date** | **Time** | The day and time the payroll run started. | [optional] |
|
@@ -30,9 +30,9 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
|
|
30
30
|
payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
31
31
|
gross_pay: 1342.67,
|
32
32
|
net_pay: 865.78,
|
33
|
-
start_date:
|
34
|
-
end_date:
|
35
|
-
check_date:
|
33
|
+
start_date: 2020-11-08T00:00Z,
|
34
|
+
end_date: 2020-11-09T00:00Z,
|
35
|
+
check_date: 2020-11-10T00:00Z,
|
36
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
37
|
deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
|
38
38
|
taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],
|
@@ -24,9 +24,9 @@ require 'merge_hris_client'
|
|
24
24
|
# setup authorization
|
25
25
|
MergeHRISClient.configure do |config|
|
26
26
|
# Configure API key authorization: tokenAuth
|
27
|
-
config.api_key['
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
-
# config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
30
|
end
|
31
31
|
|
32
32
|
api_instance = MergeHRISClient::EmployeePayrollRunsApi.new
|
@@ -35,14 +35,19 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
employee_id: 'employee_id_example', # String | If provided, will only return
|
38
|
+
employee_id: 'employee_id_example', # String | If provided, will only return employee payroll runs for this employee.
|
39
|
+
ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs ended after this datetime.
|
40
|
+
ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs ended before this datetime.
|
39
41
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
42
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
40
43
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
44
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
45
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
46
|
page_size: 56, # Integer | Number of results to return per page.
|
44
47
|
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.
|
48
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
49
|
+
started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs started after this datetime.
|
50
|
+
started_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return employee payroll runs started before this datetime.
|
46
51
|
}
|
47
52
|
|
48
53
|
begin
|
@@ -80,14 +85,19 @@ end
|
|
80
85
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
81
86
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
82
87
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
|
-
| **employee_id** | **String** | If provided, will only return
|
88
|
+
| **employee_id** | **String** | If provided, will only return employee payroll runs for this employee. | [optional] |
|
89
|
+
| **ended_after** | **Time** | If provided, will only return employee payroll runs ended after this datetime. | [optional] |
|
90
|
+
| **ended_before** | **Time** | If provided, will only return employee payroll runs ended before this datetime. | [optional] |
|
84
91
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
92
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
85
93
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
86
94
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
87
95
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
88
96
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
89
97
|
| **payroll_run_id** | **String** | If provided, will only return employee payroll runs for this employee. | [optional] |
|
90
98
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
99
|
+
| **started_after** | **Time** | If provided, will only return employee payroll runs started after this datetime. | [optional] |
|
100
|
+
| **started_before** | **Time** | If provided, will only return employee payroll runs started before this datetime. | [optional] |
|
91
101
|
|
92
102
|
### Return type
|
93
103
|
|
@@ -119,9 +129,9 @@ require 'merge_hris_client'
|
|
119
129
|
# setup authorization
|
120
130
|
MergeHRISClient.configure do |config|
|
121
131
|
# Configure API key authorization: tokenAuth
|
122
|
-
config.api_key['
|
132
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
123
133
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
-
# config.api_key_prefix['
|
134
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
125
135
|
end
|
126
136
|
|
127
137
|
api_instance = MergeHRISClient::EmployeePayrollRunsApi.new
|
data/docs/EmployeeRequest.md
CHANGED
@@ -6,27 +6,31 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
8
|
| **employee_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. | [optional] |
|
9
|
-
| **company** | **String** |
|
9
|
+
| **company** | **String** | | [optional] |
|
10
10
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
11
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] |
|
12
|
+
| **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
|
13
|
+
| **groups** | **Array<String>** | | [optional] |
|
13
14
|
| **work_email** | **String** | The employee's work email. | [optional] |
|
14
15
|
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
15
16
|
| **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
|
16
|
-
| **
|
17
|
-
| **
|
18
|
-
| **
|
19
|
-
| **
|
17
|
+
| **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
|
18
|
+
| **home_location** | **String** | | [optional] |
|
19
|
+
| **work_location** | **String** | | [optional] |
|
20
|
+
| **manager** | **String** | | [optional] |
|
21
|
+
| **team** | **String** | | [optional] |
|
22
|
+
| **pay_group** | **String** | | [optional] |
|
20
23
|
| **ssn** | **String** | The employee's social security number. | [optional] |
|
21
24
|
| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
|
22
25
|
| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
|
23
26
|
| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
|
24
27
|
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
25
|
-
| **hire_date** | **Time** | The employee
|
26
|
-
| **start_date** | **Time** | The employee
|
28
|
+
| **hire_date** | **Time** | The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. | [optional] |
|
29
|
+
| **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
|
27
30
|
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
28
31
|
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
29
32
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
33
|
+
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
30
34
|
|
31
35
|
## Example
|
32
36
|
|
@@ -40,23 +44,27 @@ instance = MergeHRISClient::EmployeeRequest.new(
|
|
40
44
|
first_name: Jane,
|
41
45
|
last_name: Doe,
|
42
46
|
display_full_name: Jane Doe,
|
47
|
+
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
43
48
|
work_email: jane@merge.dev,
|
44
49
|
personal_email: jane@gmail.com,
|
45
50
|
mobile_phone_number: +1234567890,
|
51
|
+
employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
46
52
|
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
47
53
|
work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
48
54
|
manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
|
49
55
|
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
56
|
+
pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
|
50
57
|
ssn: 1234567890,
|
51
58
|
gender: FEMALE,
|
52
59
|
ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
|
53
60
|
marital_status: SINGLE,
|
54
|
-
date_of_birth:
|
55
|
-
hire_date:
|
56
|
-
start_date:
|
61
|
+
date_of_birth: 1990-11-10T00:00Z,
|
62
|
+
hire_date: 2020-10-10T00:00Z,
|
63
|
+
start_date: 2020-10-11T00:00Z,
|
57
64
|
employment_status: INACTIVE,
|
58
|
-
termination_date:
|
59
|
-
avatar: http://alturl.com/h2h8m
|
65
|
+
termination_date: 2021-10-12T00:00Z,
|
66
|
+
avatar: http://alturl.com/h2h8m,
|
67
|
+
custom_fields: null
|
60
68
|
)
|
61
69
|
```
|
62
70
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeHRISClient::EmployeeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**Employee**](Employee.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_hris_client'
|
16
|
+
|
17
|
+
instance = MergeHRISClient::EmployeeResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/EmployeesApi.md
CHANGED
@@ -5,13 +5,14 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**employees_create**](EmployeesApi.md#employees_create) | **POST** /employees | |
|
8
|
+
| [**employees_ignore_create**](EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} | |
|
8
9
|
| [**employees_list**](EmployeesApi.md#employees_list) | **GET** /employees | |
|
9
10
|
| [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | |
|
10
11
|
|
11
12
|
|
12
13
|
## employees_create
|
13
14
|
|
14
|
-
> <
|
15
|
+
> <EmployeeResponse> employees_create(x_account_token, employee_endpoint_request, opts)
|
15
16
|
|
16
17
|
|
17
18
|
|
@@ -32,14 +33,15 @@ end
|
|
32
33
|
|
33
34
|
api_instance = MergeHRISClient::EmployeesApi.new
|
34
35
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
employee_endpoint_request = MergeHRISClient::EmployeeEndpointRequest.new({model: MergeHRISClient::EmployeeRequest.new}) # EmployeeEndpointRequest |
|
35
37
|
opts = {
|
36
|
-
|
37
|
-
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
38
40
|
}
|
39
41
|
|
40
42
|
begin
|
41
43
|
|
42
|
-
result = api_instance.employees_create(x_account_token, opts)
|
44
|
+
result = api_instance.employees_create(x_account_token, employee_endpoint_request, opts)
|
43
45
|
p result
|
44
46
|
rescue MergeHRISClient::ApiError => e
|
45
47
|
puts "Error when calling EmployeesApi->employees_create: #{e}"
|
@@ -50,15 +52,15 @@ end
|
|
50
52
|
|
51
53
|
This returns an Array which contains the response data, status code and headers.
|
52
54
|
|
53
|
-
> <Array(<
|
55
|
+
> <Array(<EmployeeResponse>, Integer, Hash)> employees_create_with_http_info(x_account_token, employee_endpoint_request, opts)
|
54
56
|
|
55
57
|
```ruby
|
56
58
|
begin
|
57
59
|
|
58
|
-
data, status_code, headers = api_instance.employees_create_with_http_info(x_account_token, opts)
|
60
|
+
data, status_code, headers = api_instance.employees_create_with_http_info(x_account_token, employee_endpoint_request, opts)
|
59
61
|
p status_code # => 2xx
|
60
62
|
p headers # => { ... }
|
61
|
-
p data # => <
|
63
|
+
p data # => <EmployeeResponse>
|
62
64
|
rescue MergeHRISClient::ApiError => e
|
63
65
|
puts "Error when calling EmployeesApi->employees_create_with_http_info: #{e}"
|
64
66
|
end
|
@@ -69,12 +71,86 @@ end
|
|
69
71
|
| Name | Type | Description | Notes |
|
70
72
|
| ---- | ---- | ----------- | ----- |
|
71
73
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **employee_endpoint_request** | [**EmployeeEndpointRequest**](EmployeeEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
72
76
|
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
73
|
-
| **employee_request** | [**EmployeeRequest**](EmployeeRequest.md) | | [optional] |
|
74
77
|
|
75
78
|
### Return type
|
76
79
|
|
77
|
-
[**
|
80
|
+
[**EmployeeResponse**](EmployeeResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
92
|
+
## employees_ignore_create
|
93
|
+
|
94
|
+
> <IgnoreCommonModel> employees_ignore_create(model_id, ignore_common_model_request)
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
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.
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'merge_hris_client'
|
105
|
+
# setup authorization
|
106
|
+
MergeHRISClient.configure do |config|
|
107
|
+
# Configure API key authorization: tokenAuth
|
108
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
110
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = MergeHRISClient::EmployeesApi.new
|
114
|
+
model_id = TODO # String |
|
115
|
+
ignore_common_model_request = MergeHRISClient::IgnoreCommonModelRequest.new({reason: MergeHRISClient::ReasonEnum::GENERAL_CUSTOMER_REQUEST}) # IgnoreCommonModelRequest |
|
116
|
+
|
117
|
+
begin
|
118
|
+
|
119
|
+
result = api_instance.employees_ignore_create(model_id, ignore_common_model_request)
|
120
|
+
p result
|
121
|
+
rescue MergeHRISClient::ApiError => e
|
122
|
+
puts "Error when calling EmployeesApi->employees_ignore_create: #{e}"
|
123
|
+
end
|
124
|
+
```
|
125
|
+
|
126
|
+
#### Using the employees_ignore_create_with_http_info variant
|
127
|
+
|
128
|
+
This returns an Array which contains the response data, status code and headers.
|
129
|
+
|
130
|
+
> <Array(<IgnoreCommonModel>, Integer, Hash)> employees_ignore_create_with_http_info(model_id, ignore_common_model_request)
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
begin
|
134
|
+
|
135
|
+
data, status_code, headers = api_instance.employees_ignore_create_with_http_info(model_id, ignore_common_model_request)
|
136
|
+
p status_code # => 2xx
|
137
|
+
p headers # => { ... }
|
138
|
+
p data # => <IgnoreCommonModel>
|
139
|
+
rescue MergeHRISClient::ApiError => e
|
140
|
+
puts "Error when calling EmployeesApi->employees_ignore_create_with_http_info: #{e}"
|
141
|
+
end
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
| Name | Type | Description | Notes |
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
148
|
+
| **model_id** | [**String**](.md) | | |
|
149
|
+
| **ignore_common_model_request** | [**IgnoreCommonModelRequest**](IgnoreCommonModelRequest.md) | | |
|
150
|
+
|
151
|
+
### Return type
|
152
|
+
|
153
|
+
[**IgnoreCommonModel**](IgnoreCommonModel.md)
|
78
154
|
|
79
155
|
### Authorization
|
80
156
|
|
@@ -102,9 +178,9 @@ require 'merge_hris_client'
|
|
102
178
|
# setup authorization
|
103
179
|
MergeHRISClient.configure do |config|
|
104
180
|
# Configure API key authorization: tokenAuth
|
105
|
-
config.api_key['
|
181
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
106
182
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
107
|
-
# config.api_key_prefix['
|
183
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
108
184
|
end
|
109
185
|
|
110
186
|
api_instance = MergeHRISClient::EmployeesApi.new
|
@@ -115,14 +191,18 @@ opts = {
|
|
115
191
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
116
192
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
117
193
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
194
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
118
195
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
119
|
-
include_sensitive_fields: true, # Boolean | Whether to include
|
196
|
+
include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
120
197
|
manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
|
121
198
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
122
199
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
123
200
|
page_size: 56, # Integer | Number of results to return per page.
|
201
|
+
pay_group_id: 'pay_group_id_example', # String | If provided, will only return employees for this pay group
|
202
|
+
personal_email: TODO, # String | If provided, will only return Employees with this personal email
|
124
203
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
125
204
|
team_id: 'team_id_example', # String | If provided, will only return employees for this team.
|
205
|
+
work_email: TODO, # String | If provided, will only return Employees with this work email
|
126
206
|
work_location_id: 'work_location_id_example' # String | If provided, will only return employees for this location.
|
127
207
|
}
|
128
208
|
|
@@ -163,14 +243,18 @@ end
|
|
163
243
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
164
244
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
165
245
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
246
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
166
247
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
-
| **include_sensitive_fields** | **Boolean** | Whether to include
|
248
|
+
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
168
249
|
| **manager_id** | **String** | If provided, will only return employees for this manager. | [optional] |
|
169
250
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
170
251
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
171
252
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
253
|
+
| **pay_group_id** | **String** | If provided, will only return employees for this pay group | [optional] |
|
254
|
+
| **personal_email** | [**String**](.md) | If provided, will only return Employees with this personal email | [optional] |
|
172
255
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
173
256
|
| **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
|
257
|
+
| **work_email** | [**String**](.md) | If provided, will only return Employees with this work email | [optional] |
|
174
258
|
| **work_location_id** | **String** | If provided, will only return employees for this location. | [optional] |
|
175
259
|
|
176
260
|
### Return type
|
@@ -203,9 +287,9 @@ require 'merge_hris_client'
|
|
203
287
|
# setup authorization
|
204
288
|
MergeHRISClient.configure do |config|
|
205
289
|
# Configure API key authorization: tokenAuth
|
206
|
-
config.api_key['
|
290
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
207
291
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
208
|
-
# config.api_key_prefix['
|
292
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
209
293
|
end
|
210
294
|
|
211
295
|
api_instance = MergeHRISClient::EmployeesApi.new
|
@@ -214,7 +298,7 @@ id = TODO # String |
|
|
214
298
|
opts = {
|
215
299
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
216
300
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
217
|
-
include_sensitive_fields: true # Boolean | Whether to include
|
301
|
+
include_sensitive_fields: true # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
218
302
|
}
|
219
303
|
|
220
304
|
begin
|
@@ -252,7 +336,7 @@ end
|
|
252
336
|
| **id** | [**String**](.md) | | |
|
253
337
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
254
338
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
255
|
-
| **include_sensitive_fields** | **Boolean** | Whether to include
|
339
|
+
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
256
340
|
|
257
341
|
### Return type
|
258
342
|
|
data/docs/Employment.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
+
| **employee** | **String** | | [optional] |
|
9
10
|
| **job_title** | **String** | The position's title. | [optional] |
|
10
11
|
| **pay_rate** | **Float** | The position's pay rate in dollars. | [optional] |
|
11
12
|
| **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. | [optional] |
|
@@ -24,13 +25,14 @@ require 'merge_hris_client'
|
|
24
25
|
instance = MergeHRISClient::Employment.new(
|
25
26
|
id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
|
26
27
|
remote_id: 19202938,
|
28
|
+
employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
27
29
|
job_title: Software Engineer,
|
28
30
|
pay_rate: 80000.00,
|
29
31
|
pay_period: YEAR,
|
30
32
|
pay_frequency: BIWEEKLY,
|
31
33
|
pay_currency: USD,
|
32
34
|
flsa_status: EXEMPT,
|
33
|
-
effective_date:
|
35
|
+
effective_date: 2020-10-06T18:42:34Z,
|
34
36
|
employment_type: FULL TIME,
|
35
37
|
remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
|
36
38
|
)
|