merge_hris_client 3.2.1 → 3.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +49 -16
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +7 -3
- data/docs/AccountIntegration.md +8 -4
- data/docs/AdvancedMetadata.md +28 -0
- data/docs/AuditLogEvent.md +32 -0
- data/docs/AuditTrailApi.md +91 -0
- data/docs/BankInfo.md +6 -4
- data/docs/BankInfoApi.md +4 -4
- data/docs/Benefit.md +6 -4
- data/docs/CommonModelScopeAPI.md +18 -0
- data/docs/Company.md +6 -4
- data/docs/CreateFieldMappingRequest.md +28 -0
- data/docs/DataPassthroughRequest.md +4 -4
- data/docs/DebugModelLogSummary.md +1 -1
- data/docs/Deduction.md +6 -4
- data/docs/Dependent.md +6 -4
- data/docs/Earning.md +6 -4
- data/docs/Employee.md +7 -3
- data/docs/EmployeePayrollRun.md +6 -4
- data/docs/EmployeeRequest.md +2 -0
- data/docs/EmployeesApi.md +10 -4
- data/docs/EmployerBenefit.md +6 -4
- data/docs/Employment.md +6 -4
- data/docs/EmploymentsApi.md +4 -4
- data/docs/EndUserDetailsRequest.md +13 -7
- data/docs/EventTypeEnum.md +15 -0
- data/docs/ExternalTargetFieldAPI.md +22 -0
- data/docs/ExternalTargetFieldAPIResponse.md +48 -0
- data/docs/FieldMappingApi.md +455 -0
- data/docs/FieldMappingApiInstance.md +24 -0
- data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
- data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
- data/docs/FieldMappingApiInstanceResponse.md +48 -0
- data/docs/FieldMappingApiInstanceTargetField.md +22 -0
- data/docs/FieldMappingInstanceResponse.md +24 -0
- data/docs/FieldPermissionDeserializer.md +20 -0
- data/docs/FieldPermissionDeserializerRequest.md +20 -0
- data/docs/ForceResyncApi.md +1 -1
- data/docs/GenerateRemoteKeyRequest.md +1 -1
- data/docs/Group.md +9 -5
- data/docs/GroupsApi.md +8 -4
- data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
- data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
- data/docs/Issue.md +1 -1
- data/docs/IssuesApi.md +5 -3
- data/docs/LinkTokenApi.md +1 -1
- data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +6 -4
- data/docs/LocationsApi.md +6 -4
- data/docs/MetaResponse.md +1 -1
- data/docs/ModelPermissionDeserializer.md +18 -0
- data/docs/ModelPermissionDeserializerRequest.md +18 -0
- data/docs/PaginatedAuditLogEventList.md +22 -0
- data/docs/PaginatedTimesheetEntryList.md +22 -0
- data/docs/PatchedEditFieldMappingRequest.md +22 -0
- data/docs/PayGroup.md +6 -4
- data/docs/PayrollRun.md +6 -4
- data/docs/PayrollRunsApi.md +4 -4
- data/docs/RemoteEndpointInfo.md +22 -0
- data/docs/RemoteFieldAPI.md +28 -0
- data/docs/RemoteFieldAPIResponse.md +48 -0
- data/docs/RemoteKeyForRegenerationRequest.md +1 -1
- data/docs/RoleEnum.md +15 -0
- data/docs/ScopesApi.md +222 -0
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +6 -4
- data/docs/Team.md +6 -4
- data/docs/TimeOff.md +5 -3
- data/docs/TimeOffApi.md +12 -4
- data/docs/TimeOffBalance.md +6 -4
- data/docs/TimeOffBalancesApi.md +4 -4
- data/docs/TimesheetEntriesApi.md +341 -0
- data/docs/TimesheetEntry.md +38 -0
- data/docs/TimesheetEntryEndpointRequest.md +18 -0
- data/docs/TimesheetEntryRequest.md +28 -0
- data/docs/TimesheetEntryResponse.md +24 -0
- data/lib/merge_hris_client/api/audit_trail_api.rb +95 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +4 -4
- data/lib/merge_hris_client/api/employees_api.rb +13 -4
- data/lib/merge_hris_client/api/employments_api.rb +4 -4
- data/lib/merge_hris_client/api/field_mapping_api.rb +424 -0
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +10 -4
- data/lib/merge_hris_client/api/issues_api.rb +7 -4
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_hris_client/api/locations_api.rb +11 -4
- data/lib/merge_hris_client/api/payroll_runs_api.rb +4 -4
- data/lib/merge_hris_client/api/scopes_api.rb +209 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/api/time_off_api.rb +16 -4
- data/lib/merge_hris_client/api/time_off_balances_api.rb +4 -4
- data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
- data/lib/merge_hris_client/configuration.rb +4 -0
- data/lib/merge_hris_client/models/account_details.rb +14 -5
- data/lib/merge_hris_client/models/account_details_and_actions.rb +28 -4
- data/lib/merge_hris_client/models/account_integration.rb +36 -14
- data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
- data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
- data/lib/merge_hris_client/models/bank_info.rb +24 -16
- data/lib/merge_hris_client/models/benefit.rb +24 -16
- data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
- data/lib/merge_hris_client/models/company.rb +24 -16
- data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +3 -0
- data/lib/merge_hris_client/models/deduction.rb +24 -16
- data/lib/merge_hris_client/models/dependent.rb +24 -16
- data/lib/merge_hris_client/models/earning.rb +24 -16
- data/lib/merge_hris_client/models/employee.rb +34 -15
- data/lib/merge_hris_client/models/employee_payroll_run.rb +24 -16
- data/lib/merge_hris_client/models/employee_request.rb +12 -1
- data/lib/merge_hris_client/models/employer_benefit.rb +24 -16
- data/lib/merge_hris_client/models/employment.rb +24 -16
- data/lib/merge_hris_client/models/end_user_details_request.rb +67 -6
- data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
- data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
- data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
- data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
- data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
- data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
- data/lib/merge_hris_client/models/group.rb +34 -15
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
- data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
- data/lib/merge_hris_client/models/location.rb +24 -16
- data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
- data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
- data/lib/merge_hris_client/models/paginated_audit_log_event_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_timesheet_entry_list.rb +240 -0
- data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
- data/lib/merge_hris_client/models/pay_group.rb +24 -16
- data/lib/merge_hris_client/models/payroll_run.rb +24 -16
- data/lib/merge_hris_client/models/remote_endpoint_info.rb +253 -0
- data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
- data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
- data/lib/merge_hris_client/models/role_enum.rb +49 -0
- data/lib/merge_hris_client/models/tax.rb +24 -16
- data/lib/merge_hris_client/models/team.rb +24 -16
- data/lib/merge_hris_client/models/time_off.rb +23 -15
- data/lib/merge_hris_client/models/time_off_balance.rb +24 -16
- data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
- data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
- data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +35 -21
- data/spec/api/audit_trail_api_spec.rb +51 -0
- data/spec/api/bank_info_api_spec.rb +2 -2
- data/spec/api/employees_api_spec.rb +5 -2
- data/spec/api/employments_api_spec.rb +2 -2
- data/spec/api/field_mapping_api_spec.rb +107 -0
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +4 -2
- data/spec/api/issues_api_spec.rb +3 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/locations_api_spec.rb +3 -2
- data/spec/api/payroll_runs_api_spec.rb +2 -2
- data/spec/api/scopes_api_spec.rb +68 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/time_off_api_spec.rb +6 -2
- data/spec/api/time_off_balances_api_spec.rb +2 -2
- data/spec/api/timesheet_entries_api_spec.rb +99 -0
- data/spec/models/account_details_and_actions_spec.rb +12 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/account_integration_spec.rb +14 -2
- data/spec/models/advanced_metadata_spec.rb +64 -0
- data/spec/models/audit_log_event_spec.rb +76 -0
- data/spec/models/bank_info_spec.rb +12 -6
- data/spec/models/benefit_spec.rb +12 -6
- data/spec/models/common_model_scope_api_spec.rb +34 -0
- data/spec/models/company_spec.rb +11 -5
- data/spec/models/create_field_mapping_request_spec.rb +64 -0
- data/spec/models/deduction_spec.rb +12 -6
- data/spec/models/dependent_spec.rb +12 -6
- data/spec/models/earning_spec.rb +11 -5
- data/spec/models/employee_payroll_run_spec.rb +12 -6
- data/spec/models/employee_request_spec.rb +6 -0
- data/spec/models/employee_spec.rb +18 -6
- data/spec/models/employer_benefit_spec.rb +12 -6
- data/spec/models/employment_spec.rb +12 -6
- data/spec/models/end_user_details_request_spec.rb +18 -0
- data/spec/models/event_type_enum_spec.rb +28 -0
- data/spec/models/external_target_field_api_response_spec.rb +124 -0
- data/spec/models/external_target_field_api_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
- data/spec/models/field_mapping_api_instance_spec.rb +52 -0
- data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
- data/spec/models/field_mapping_instance_response_spec.rb +52 -0
- data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
- data/spec/models/field_permission_deserializer_spec.rb +40 -0
- data/spec/models/group_spec.rb +13 -1
- data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
- data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
- data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -0
- data/spec/models/location_spec.rb +12 -6
- data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
- data/spec/models/model_permission_deserializer_spec.rb +34 -0
- data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
- data/spec/models/paginated_timesheet_entry_list_spec.rb +46 -0
- data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +9 -3
- data/spec/models/payroll_run_spec.rb +12 -6
- data/spec/models/remote_endpoint_info_spec.rb +46 -0
- data/spec/models/remote_field_api_response_spec.rb +124 -0
- data/spec/models/remote_field_api_spec.rb +64 -0
- data/spec/models/role_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +12 -6
- data/spec/models/team_spec.rb +10 -4
- data/spec/models/time_off_balance_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +12 -6
- data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
- data/spec/models/timesheet_entry_request_spec.rb +64 -0
- data/spec/models/timesheet_entry_response_spec.rb +52 -0
- data/spec/models/timesheet_entry_spec.rb +94 -0
- metadata +266 -126
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e93ec3d4af4e5d2f97c395bb0094f77fb955c4db7a207473b1883862443ffb90
|
4
|
+
data.tar.gz: 2a80ab23e0e0d9ddb9829f4311c30605aecaf18721282ee9919fe88dfb77373f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cef534d0940d9910a1df0ee1a2c9dac0abbf60e0adcd2067f240baa561e11b8dcd775e53d24c9723db59861c8cc0979f79e12f690d9095cef42bb9a819fd6cf3
|
7
|
+
data.tar.gz: e4a04f527a93453ed0927de63bcc9424b1c29d1e71c4399a35118f036ba5cab24ee1851bef775c916cf382ecefca95c579e27b778a20322634012b753ebc9730
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple HR Information Syst
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 3.2.
|
10
|
+
- Package version: 3.2.2
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_hris_client-3.2.
|
27
|
+
gem install ./merge_hris_client-3.2.2.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_hris_client-3.2.
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-3.2.2.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_hris_client', '~> 3.2.
|
36
|
+
gem 'merge_hris_client', '~> 3.2.2'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
|
|
87
87
|
*MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
|
88
88
|
*MergeHRISClient::AsyncPassthroughApi* | [**async_passthrough_create**](docs/AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough |
|
89
89
|
*MergeHRISClient::AsyncPassthroughApi* | [**async_passthrough_retrieve**](docs/AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} |
|
90
|
+
*MergeHRISClient::AuditTrailApi* | [**audit_trail_list**](docs/AuditTrailApi.md#audit_trail_list) | **GET** /audit-trail |
|
90
91
|
*MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
|
91
92
|
*MergeHRISClient::BankInfoApi* | [**bank_info_list**](docs/BankInfoApi.md#bank_info_list) | **GET** /bank-info |
|
92
93
|
*MergeHRISClient::BankInfoApi* | [**bank_info_retrieve**](docs/BankInfoApi.md#bank_info_retrieve) | **GET** /bank-info/{id} |
|
@@ -108,6 +109,12 @@ Class | Method | HTTP request | Description
|
|
108
109
|
*MergeHRISClient::EmployerBenefitsApi* | [**employer_benefits_retrieve**](docs/EmployerBenefitsApi.md#employer_benefits_retrieve) | **GET** /employer-benefits/{id} |
|
109
110
|
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
110
111
|
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
112
|
+
*MergeHRISClient::FieldMappingApi* | [**field_mappings_create**](docs/FieldMappingApi.md#field_mappings_create) | **POST** /field-mappings |
|
113
|
+
*MergeHRISClient::FieldMappingApi* | [**field_mappings_destroy**](docs/FieldMappingApi.md#field_mappings_destroy) | **DELETE** /field-mappings/{field_mapping_id} |
|
114
|
+
*MergeHRISClient::FieldMappingApi* | [**field_mappings_partial_update**](docs/FieldMappingApi.md#field_mappings_partial_update) | **PATCH** /field-mappings/{field_mapping_id} |
|
115
|
+
*MergeHRISClient::FieldMappingApi* | [**field_mappings_retrieve**](docs/FieldMappingApi.md#field_mappings_retrieve) | **GET** /field-mappings |
|
116
|
+
*MergeHRISClient::FieldMappingApi* | [**remote_fields_retrieve**](docs/FieldMappingApi.md#remote_fields_retrieve) | **GET** /remote-fields |
|
117
|
+
*MergeHRISClient::FieldMappingApi* | [**target_fields_retrieve**](docs/FieldMappingApi.md#target_fields_retrieve) | **GET** /target-fields |
|
111
118
|
*MergeHRISClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
|
112
119
|
*MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
|
113
120
|
*MergeHRISClient::GroupsApi* | [**groups_list**](docs/GroupsApi.md#groups_list) | **GET** /groups |
|
@@ -124,9 +131,9 @@ Class | Method | HTTP request | Description
|
|
124
131
|
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs |
|
125
132
|
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} |
|
126
133
|
*MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |
|
127
|
-
*MergeHRISClient::
|
128
|
-
*MergeHRISClient::
|
129
|
-
*MergeHRISClient::
|
134
|
+
*MergeHRISClient::ScopesApi* | [**default_scopes_retrieve**](docs/ScopesApi.md#default_scopes_retrieve) | **GET** /default-scopes |
|
135
|
+
*MergeHRISClient::ScopesApi* | [**linked_account_scopes_create**](docs/ScopesApi.md#linked_account_scopes_create) | **POST** /linked-account-scopes |
|
136
|
+
*MergeHRISClient::ScopesApi* | [**linked_account_scopes_retrieve**](docs/ScopesApi.md#linked_account_scopes_retrieve) | **GET** /linked-account-scopes |
|
130
137
|
*MergeHRISClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status |
|
131
138
|
*MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams |
|
132
139
|
*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
|
@@ -136,6 +143,10 @@ Class | Method | HTTP request | Description
|
|
136
143
|
*MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |
|
137
144
|
*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_list**](docs/TimeOffBalancesApi.md#time_off_balances_list) | **GET** /time-off-balances |
|
138
145
|
*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_retrieve**](docs/TimeOffBalancesApi.md#time_off_balances_retrieve) | **GET** /time-off-balances/{id} |
|
146
|
+
*MergeHRISClient::TimesheetEntriesApi* | [**timesheet_entries_create**](docs/TimesheetEntriesApi.md#timesheet_entries_create) | **POST** /timesheet-entries |
|
147
|
+
*MergeHRISClient::TimesheetEntriesApi* | [**timesheet_entries_list**](docs/TimesheetEntriesApi.md#timesheet_entries_list) | **GET** /timesheet-entries |
|
148
|
+
*MergeHRISClient::TimesheetEntriesApi* | [**timesheet_entries_meta_post_retrieve**](docs/TimesheetEntriesApi.md#timesheet_entries_meta_post_retrieve) | **GET** /timesheet-entries/meta/post |
|
149
|
+
*MergeHRISClient::TimesheetEntriesApi* | [**timesheet_entries_retrieve**](docs/TimesheetEntriesApi.md#timesheet_entries_retrieve) | **GET** /timesheet-entries/{id} |
|
139
150
|
*MergeHRISClient::WebhookReceiversApi* | [**webhook_receivers_create**](docs/WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers |
|
140
151
|
*MergeHRISClient::WebhookReceiversApi* | [**webhook_receivers_list**](docs/WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers |
|
141
152
|
|
@@ -149,18 +160,20 @@ Class | Method | HTTP request | Description
|
|
149
160
|
- [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
|
150
161
|
- [MergeHRISClient::AccountToken](docs/AccountToken.md)
|
151
162
|
- [MergeHRISClient::AccountTypeEnum](docs/AccountTypeEnum.md)
|
163
|
+
- [MergeHRISClient::AdvancedMetadata](docs/AdvancedMetadata.md)
|
152
164
|
- [MergeHRISClient::AsyncPassthroughReciept](docs/AsyncPassthroughReciept.md)
|
165
|
+
- [MergeHRISClient::AuditLogEvent](docs/AuditLogEvent.md)
|
153
166
|
- [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
|
154
167
|
- [MergeHRISClient::BankInfo](docs/BankInfo.md)
|
155
168
|
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
156
169
|
- [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
|
157
170
|
- [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
|
158
171
|
- [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
|
172
|
+
- [MergeHRISClient::CommonModelScopeAPI](docs/CommonModelScopeAPI.md)
|
159
173
|
- [MergeHRISClient::CommonModelScopesBodyRequest](docs/CommonModelScopesBodyRequest.md)
|
160
174
|
- [MergeHRISClient::Company](docs/Company.md)
|
161
|
-
- [MergeHRISClient::ConditionSchema](docs/ConditionSchema.md)
|
162
|
-
- [MergeHRISClient::ConditionTypeEnum](docs/ConditionTypeEnum.md)
|
163
175
|
- [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
|
176
|
+
- [MergeHRISClient::CreateFieldMappingRequest](docs/CreateFieldMappingRequest.md)
|
164
177
|
- [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
165
178
|
- [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
|
166
179
|
- [MergeHRISClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
|
@@ -182,20 +195,29 @@ Class | Method | HTTP request | Description
|
|
182
195
|
- [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
183
196
|
- [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
|
184
197
|
- [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
|
198
|
+
- [MergeHRISClient::EventTypeEnum](docs/EventTypeEnum.md)
|
199
|
+
- [MergeHRISClient::ExternalTargetFieldAPI](docs/ExternalTargetFieldAPI.md)
|
200
|
+
- [MergeHRISClient::ExternalTargetFieldAPIResponse](docs/ExternalTargetFieldAPIResponse.md)
|
201
|
+
- [MergeHRISClient::FieldMappingApiInstance](docs/FieldMappingApiInstance.md)
|
202
|
+
- [MergeHRISClient::FieldMappingApiInstanceRemoteField](docs/FieldMappingApiInstanceRemoteField.md)
|
203
|
+
- [MergeHRISClient::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo](docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md)
|
204
|
+
- [MergeHRISClient::FieldMappingApiInstanceResponse](docs/FieldMappingApiInstanceResponse.md)
|
205
|
+
- [MergeHRISClient::FieldMappingApiInstanceTargetField](docs/FieldMappingApiInstanceTargetField.md)
|
206
|
+
- [MergeHRISClient::FieldMappingInstanceResponse](docs/FieldMappingInstanceResponse.md)
|
207
|
+
- [MergeHRISClient::FieldPermissionDeserializer](docs/FieldPermissionDeserializer.md)
|
208
|
+
- [MergeHRISClient::FieldPermissionDeserializerRequest](docs/FieldPermissionDeserializerRequest.md)
|
185
209
|
- [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
|
186
210
|
- [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
|
187
211
|
- [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
|
188
212
|
- [MergeHRISClient::Group](docs/Group.md)
|
189
213
|
- [MergeHRISClient::GroupTypeEnum](docs/GroupTypeEnum.md)
|
190
214
|
- [MergeHRISClient::IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
|
215
|
+
- [MergeHRISClient::IndividualCommonModelScopeDeserializer](docs/IndividualCommonModelScopeDeserializer.md)
|
216
|
+
- [MergeHRISClient::IndividualCommonModelScopeDeserializerRequest](docs/IndividualCommonModelScopeDeserializerRequest.md)
|
191
217
|
- [MergeHRISClient::Issue](docs/Issue.md)
|
192
218
|
- [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
193
219
|
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
194
|
-
- [MergeHRISClient::
|
195
|
-
- [MergeHRISClient::LinkedAccountConditionRequest](docs/LinkedAccountConditionRequest.md)
|
196
|
-
- [MergeHRISClient::LinkedAccountSelectiveSyncConfiguration](docs/LinkedAccountSelectiveSyncConfiguration.md)
|
197
|
-
- [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest](docs/LinkedAccountSelectiveSyncConfigurationListRequest.md)
|
198
|
-
- [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest](docs/LinkedAccountSelectiveSyncConfigurationRequest.md)
|
220
|
+
- [MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest](docs/LinkedAccountCommonModelScopeDeserializerRequest.md)
|
199
221
|
- [MergeHRISClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
|
200
222
|
- [MergeHRISClient::Location](docs/Location.md)
|
201
223
|
- [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
|
@@ -203,13 +225,14 @@ Class | Method | HTTP request | Description
|
|
203
225
|
- [MergeHRISClient::MetaResponse](docs/MetaResponse.md)
|
204
226
|
- [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
|
205
227
|
- [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
|
228
|
+
- [MergeHRISClient::ModelPermissionDeserializer](docs/ModelPermissionDeserializer.md)
|
229
|
+
- [MergeHRISClient::ModelPermissionDeserializerRequest](docs/ModelPermissionDeserializerRequest.md)
|
206
230
|
- [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
|
207
|
-
- [MergeHRISClient::OperatorSchema](docs/OperatorSchema.md)
|
208
231
|
- [MergeHRISClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
|
232
|
+
- [MergeHRISClient::PaginatedAuditLogEventList](docs/PaginatedAuditLogEventList.md)
|
209
233
|
- [MergeHRISClient::PaginatedBankInfoList](docs/PaginatedBankInfoList.md)
|
210
234
|
- [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
|
211
235
|
- [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
|
212
|
-
- [MergeHRISClient::PaginatedConditionSchemaList](docs/PaginatedConditionSchemaList.md)
|
213
236
|
- [MergeHRISClient::PaginatedDependentList](docs/PaginatedDependentList.md)
|
214
237
|
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
215
238
|
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
@@ -224,6 +247,8 @@ Class | Method | HTTP request | Description
|
|
224
247
|
- [MergeHRISClient::PaginatedTeamList](docs/PaginatedTeamList.md)
|
225
248
|
- [MergeHRISClient::PaginatedTimeOffBalanceList](docs/PaginatedTimeOffBalanceList.md)
|
226
249
|
- [MergeHRISClient::PaginatedTimeOffList](docs/PaginatedTimeOffList.md)
|
250
|
+
- [MergeHRISClient::PaginatedTimesheetEntryList](docs/PaginatedTimesheetEntryList.md)
|
251
|
+
- [MergeHRISClient::PatchedEditFieldMappingRequest](docs/PatchedEditFieldMappingRequest.md)
|
227
252
|
- [MergeHRISClient::PayCurrencyEnum](docs/PayCurrencyEnum.md)
|
228
253
|
- [MergeHRISClient::PayFrequencyEnum](docs/PayFrequencyEnum.md)
|
229
254
|
- [MergeHRISClient::PayGroup](docs/PayGroup.md)
|
@@ -233,12 +258,16 @@ Class | Method | HTTP request | Description
|
|
233
258
|
- [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
|
234
259
|
- [MergeHRISClient::RelationshipEnum](docs/RelationshipEnum.md)
|
235
260
|
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
261
|
+
- [MergeHRISClient::RemoteEndpointInfo](docs/RemoteEndpointInfo.md)
|
262
|
+
- [MergeHRISClient::RemoteFieldAPI](docs/RemoteFieldAPI.md)
|
263
|
+
- [MergeHRISClient::RemoteFieldAPIResponse](docs/RemoteFieldAPIResponse.md)
|
236
264
|
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
237
265
|
- [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
238
266
|
- [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
|
239
267
|
- [MergeHRISClient::RequestFormatEnum](docs/RequestFormatEnum.md)
|
240
268
|
- [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
|
241
269
|
- [MergeHRISClient::ResponseTypeEnum](docs/ResponseTypeEnum.md)
|
270
|
+
- [MergeHRISClient::RoleEnum](docs/RoleEnum.md)
|
242
271
|
- [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
|
243
272
|
- [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
|
244
273
|
- [MergeHRISClient::SelectiveSyncConfigurationsUsageEnum](docs/SelectiveSyncConfigurationsUsageEnum.md)
|
@@ -252,6 +281,10 @@ Class | Method | HTTP request | Description
|
|
252
281
|
- [MergeHRISClient::TimeOffRequest](docs/TimeOffRequest.md)
|
253
282
|
- [MergeHRISClient::TimeOffResponse](docs/TimeOffResponse.md)
|
254
283
|
- [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
|
284
|
+
- [MergeHRISClient::TimesheetEntry](docs/TimesheetEntry.md)
|
285
|
+
- [MergeHRISClient::TimesheetEntryEndpointRequest](docs/TimesheetEntryEndpointRequest.md)
|
286
|
+
- [MergeHRISClient::TimesheetEntryRequest](docs/TimesheetEntryRequest.md)
|
287
|
+
- [MergeHRISClient::TimesheetEntryResponse](docs/TimesheetEntryResponse.md)
|
255
288
|
- [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
|
256
289
|
- [MergeHRISClient::ValidationProblemSource](docs/ValidationProblemSource.md)
|
257
290
|
- [MergeHRISClient::WarningValidationProblem](docs/WarningValidationProblem.md)
|
data/docs/AccountDetails.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **status** | **String** | | [optional][readonly] |
|
15
15
|
| **webhook_listener_url** | **String** | | [optional][readonly] |
|
16
16
|
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional][readonly] |
|
17
|
+
| **account_type** | **String** | | [optional][readonly] |
|
17
18
|
|
18
19
|
## Example
|
19
20
|
|
@@ -30,7 +31,8 @@ instance = MergeHRISClient::AccountDetails.new(
|
|
30
31
|
end_user_email_address: kendall.roy@waystar-royco.com,
|
31
32
|
status: COMPLETE,
|
32
33
|
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
33
|
-
is_duplicate: true
|
34
|
+
is_duplicate: true,
|
35
|
+
account_type: PRODUCTION
|
34
36
|
)
|
35
37
|
```
|
36
38
|
|
@@ -11,9 +11,11 @@
|
|
11
11
|
| **end_user_origin_id** | **String** | | [optional] |
|
12
12
|
| **end_user_organization_name** | **String** | | |
|
13
13
|
| **end_user_email_address** | **String** | | |
|
14
|
+
| **subdomain** | **String** | The tenant or domain the customer has provided access to. | [optional] |
|
14
15
|
| **webhook_listener_url** | **String** | | |
|
15
16
|
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional] |
|
16
17
|
| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) | | [optional] |
|
18
|
+
| **account_type** | **String** | | |
|
17
19
|
|
18
20
|
## Example
|
19
21
|
|
@@ -23,14 +25,16 @@ require 'merge_hris_client'
|
|
23
25
|
instance = MergeHRISClient::AccountDetailsAndActions.new(
|
24
26
|
id: e59b1821-f85c-4e28-a6b3-1804156f3563,
|
25
27
|
category: hris,
|
26
|
-
status:
|
27
|
-
status_detail:
|
28
|
+
status: INCOMPLETE,
|
29
|
+
status_detail: Invalid login credentials,
|
28
30
|
end_user_origin_id: 3ac95cde-6c7f-4eef-afec-be710b42308d,
|
29
31
|
end_user_organization_name: Foo Bar, LLC,
|
30
32
|
end_user_email_address: hradmin@foobar.dev,
|
33
|
+
subdomain: foobar,
|
31
34
|
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
32
35
|
is_duplicate: true,
|
33
|
-
integration: null
|
36
|
+
integration: null,
|
37
|
+
account_type: PRODUCTION
|
34
38
|
)
|
35
39
|
```
|
36
40
|
|
data/docs/AccountIntegration.md
CHANGED
@@ -5,13 +5,15 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | Company name. | |
|
8
|
-
| **
|
8
|
+
| **abbreviated_name** | **String** | Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).<br><br>Example: <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)</i> | [optional] |
|
9
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris]. | [optional][readonly] |
|
9
10
|
| **image** | **String** | Company logo in rectangular shape. <b>Upload an image with a clear background.</b> | [optional] |
|
10
11
|
| **square_image** | **String** | Company logo in square shape. <b>Upload an image with a white background.</b> | [optional] |
|
11
12
|
| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b> | [optional] |
|
12
13
|
| **slug** | **String** | | [optional][readonly] |
|
13
|
-
| **is_in_beta** | **Boolean** | If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag. | [optional] |
|
14
14
|
| **api_endpoints_to_documentation_urls** | [**Hash<String, AnyType>**](AnyType.md) | Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []} | [optional] |
|
15
|
+
| **webhook_setup_guide_url** | **String** | Setup guide URL for third party webhook creation. Exposed in Merge Docs. | [optional] |
|
16
|
+
| **category_beta_status** | **Object** | Category or categories this integration is in beta status for. | [optional][readonly] |
|
15
17
|
|
16
18
|
## Example
|
17
19
|
|
@@ -20,13 +22,15 @@ require 'merge_hris_client'
|
|
20
22
|
|
21
23
|
instance = MergeHRISClient::AccountIntegration.new(
|
22
24
|
name: null,
|
25
|
+
abbreviated_name: null,
|
23
26
|
categories: null,
|
24
27
|
image: null,
|
25
28
|
square_image: null,
|
26
29
|
color: null,
|
27
30
|
slug: null,
|
28
|
-
|
29
|
-
|
31
|
+
api_endpoints_to_documentation_urls: null,
|
32
|
+
webhook_setup_guide_url: null,
|
33
|
+
category_beta_status: null
|
30
34
|
)
|
31
35
|
```
|
32
36
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MergeHRISClient::AdvancedMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **display_name** | **String** | | [optional] |
|
9
|
+
| **description** | **String** | | [optional] |
|
10
|
+
| **is_required** | **Boolean** | | [optional] |
|
11
|
+
| **is_custom** | **Boolean** | | [optional] |
|
12
|
+
| **field_choices** | [**Array<AnyType>**](AnyType.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'merge_hris_client'
|
18
|
+
|
19
|
+
instance = MergeHRISClient::AdvancedMetadata.new(
|
20
|
+
id: null,
|
21
|
+
display_name: null,
|
22
|
+
description: null,
|
23
|
+
is_required: null,
|
24
|
+
is_custom: null,
|
25
|
+
field_choices: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# MergeHRISClient::AuditLogEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **user_name** | **String** | The User's full name at the time of this Event occurring. | [optional] |
|
9
|
+
| **user_email** | **String** | The User's email at the time of this Event occurring. | [optional] |
|
10
|
+
| **role** | [**RoleEnum**](RoleEnum.md) | Designates the role of the user (or SYSTEM/API if action not taken by a user) at the time of this Event occurring. * `ADMIN` - ADMIN * `DEVELOPER` - DEVELOPER * `MEMBER` - MEMBER * `API` - API * `SYSTEM` - SYSTEM * `MERGE_TEAM` - MERGE_TEAM | |
|
11
|
+
| **ip_address** | **String** | | |
|
12
|
+
| **event_type** | [**EventTypeEnum**](EventTypeEnum.md) | Designates the type of event that occurred. * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY * `INVITED_USER` - INVITED_USER * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT * `CREATED_DESTINATION` - CREATED_DESTINATION * `DELETED_DESTINATION` - DELETED_DESTINATION * `CHANGED_DESTINATION` - CHANGED_DESTINATION * `CHANGED_SCOPES` - CHANGED_SCOPES * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION * `ENABLED_CATEGORY` - ENABLED_CATEGORY * `DISABLED_CATEGORY` - DISABLED_CATEGORY * `CHANGED_PASSWORD` - CHANGED_PASSWORD * `RESET_PASSWORD` - RESET_PASSWORD * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` - CREATED_INTEGRATION_WIDE_FIELD_MAPPING * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - CREATED_LINKED_ACCOUNT_FIELD_MAPPING * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` - CHANGED_INTEGRATION_WIDE_FIELD_MAPPING * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` - DELETED_INTEGRATION_WIDE_FIELD_MAPPING * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - DELETED_LINKED_ACCOUNT_FIELD_MAPPING * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC * `MUTED_ISSUE` - MUTED_ISSUE * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED | |
|
13
|
+
| **event_description** | **String** | | |
|
14
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'merge_hris_client'
|
20
|
+
|
21
|
+
instance = MergeHRISClient::AuditLogEvent.new(
|
22
|
+
id: b5ceea2a-7171-47ce-8090-165cfce5572c,
|
23
|
+
user_name: Gil Feig,
|
24
|
+
user_email: hello@merge.dev,
|
25
|
+
role: ADMIN,
|
26
|
+
ip_address: 192.0.2.123,
|
27
|
+
event_type: CHANGED_SCOPES,
|
28
|
+
event_description: Organization-wide Scopes for model hris.Employee updated from Read to Read+Write,
|
29
|
+
created_at: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,91 @@
|
|
1
|
+
# MergeHRISClient::AuditTrailApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**audit_trail_list**](AuditTrailApi.md#audit_trail_list) | **GET** /audit-trail | |
|
8
|
+
|
9
|
+
|
10
|
+
## audit_trail_list
|
11
|
+
|
12
|
+
> <PaginatedAuditLogEventList> audit_trail_list(opts)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Gets a list of audit trail events.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_hris_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeHRISClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
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'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MergeHRISClient::AuditTrailApi.new
|
32
|
+
opts = {
|
33
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
34
|
+
end_date: 'end_date_example', # String | If included, will only include audit trail events that occurred before this time
|
35
|
+
event_type: 'event_type_example', # String | If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
|
36
|
+
page_size: 56, # Integer | Number of results to return per page.
|
37
|
+
start_date: 'start_date_example', # String | If included, will only include audit trail events that occurred after this time
|
38
|
+
user_email: 'user_email_example' # String | If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
|
43
|
+
result = api_instance.audit_trail_list(opts)
|
44
|
+
p result
|
45
|
+
rescue MergeHRISClient::ApiError => e
|
46
|
+
puts "Error when calling AuditTrailApi->audit_trail_list: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the audit_trail_list_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<PaginatedAuditLogEventList>, Integer, Hash)> audit_trail_list_with_http_info(opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
|
59
|
+
data, status_code, headers = api_instance.audit_trail_list_with_http_info(opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <PaginatedAuditLogEventList>
|
63
|
+
rescue MergeHRISClient::ApiError => e
|
64
|
+
puts "Error when calling AuditTrailApi->audit_trail_list_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
73
|
+
| **end_date** | **String** | If included, will only include audit trail events that occurred before this time | [optional] |
|
74
|
+
| **event_type** | **String** | If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` | [optional] |
|
75
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
76
|
+
| **start_date** | **String** | If included, will only include audit trail events that occurred after this time | [optional] |
|
77
|
+
| **user_email** | **String** | If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. | [optional] |
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
[**PaginatedAuditLogEventList**](PaginatedAuditLogEventList.md)
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[tokenAuth](../README.md#tokenAuth)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: Not defined
|
90
|
+
- **Accept**: application/json
|
91
|
+
|
data/docs/BankInfo.md
CHANGED
@@ -6,15 +6,16 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
+
| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
|
10
|
+
| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
|
9
11
|
| **employee** | **String** | The employee with this bank account. | [optional] |
|
10
12
|
| **account_number** | **String** | The account number. | [optional] |
|
11
13
|
| **routing_number** | **String** | The routing number. | [optional] |
|
12
14
|
| **bank_name** | **String** | The bank name. | [optional] |
|
13
15
|
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING | [optional] |
|
14
16
|
| **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [optional] |
|
15
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
16
|
-
| **
|
17
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
18
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
18
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
20
|
|
20
21
|
## Example
|
@@ -25,6 +26,8 @@ require 'merge_hris_client'
|
|
25
26
|
instance = MergeHRISClient::BankInfo.new(
|
26
27
|
id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
|
27
28
|
remote_id: 123234,
|
29
|
+
created_at: 2021-09-15T00:00Z,
|
30
|
+
modified_at: 2021-10-16T00:00Z,
|
28
31
|
employee: a3617eb4-dfe3-426f-921e-a65fc1661e10,
|
29
32
|
account_number: 439291590,
|
30
33
|
routing_number: 089690059,
|
@@ -32,7 +35,6 @@ instance = MergeHRISClient::BankInfo.new(
|
|
32
35
|
account_type: CHECKING,
|
33
36
|
remote_created_at: 2021-12-06T10:11:26Z,
|
34
37
|
remote_was_deleted: null,
|
35
|
-
modified_at: 2021-10-16T00:00Z,
|
36
38
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
37
39
|
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}]
|
38
40
|
)
|
data/docs/BankInfoApi.md
CHANGED
@@ -47,7 +47,7 @@ opts = {
|
|
47
47
|
page_size: 56, # Integer | Number of results to return per page.
|
48
48
|
remote_fields: 'account_type', # String | Deprecated. Use show_enum_origins.
|
49
49
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
50
|
-
show_enum_origins: 'account_type' # String |
|
50
|
+
show_enum_origins: 'account_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
51
51
|
}
|
52
52
|
|
53
53
|
begin
|
@@ -97,7 +97,7 @@ end
|
|
97
97
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
98
98
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
99
99
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
100
|
-
| **show_enum_origins** | **String** |
|
100
|
+
| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
|
101
101
|
|
102
102
|
### Return type
|
103
103
|
|
@@ -141,7 +141,7 @@ opts = {
|
|
141
141
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
142
142
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
143
143
|
remote_fields: 'account_type', # String | Deprecated. Use show_enum_origins.
|
144
|
-
show_enum_origins: 'account_type' # String |
|
144
|
+
show_enum_origins: 'account_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
145
145
|
}
|
146
146
|
|
147
147
|
begin
|
@@ -180,7 +180,7 @@ end
|
|
180
180
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
181
181
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
182
182
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
183
|
-
| **show_enum_origins** | **String** |
|
183
|
+
| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
|
184
184
|
|
185
185
|
### Return type
|
186
186
|
|
data/docs/Benefit.md
CHANGED
@@ -6,6 +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
|
+
| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
|
10
|
+
| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
|
9
11
|
| **employee** | **String** | The employee on the plan. | [optional] |
|
10
12
|
| **provider_name** | **String** | The name of the benefit provider. | [optional] |
|
11
13
|
| **benefit_plan_type** | **String** | The type of benefit plan | [optional] |
|
@@ -13,10 +15,9 @@
|
|
13
15
|
| **company_contribution** | **Float** | The company's contribution. | [optional] |
|
14
16
|
| **start_date** | **Time** | The day and time the benefit started. | [optional] |
|
15
17
|
| **end_date** | **Time** | The day and time the benefit ended. | [optional] |
|
16
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
18
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
17
19
|
| **employer_benefit** | **String** | The employer benefit plan the employee is enrolled in. | [optional] |
|
18
|
-
| **
|
19
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
20
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
20
21
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
21
22
|
|
22
23
|
## Example
|
@@ -27,6 +28,8 @@ require 'merge_hris_client'
|
|
27
28
|
instance = MergeHRISClient::Benefit.new(
|
28
29
|
id: 3fe5ae7a-f1ba-4529-b7af-84e86dc6d232,
|
29
30
|
remote_id: 19202938,
|
31
|
+
created_at: 2021-09-15T00:00Z,
|
32
|
+
modified_at: 2021-10-16T00:00Z,
|
30
33
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
31
34
|
provider_name: Blue Shield of California,
|
32
35
|
benefit_plan_type: null,
|
@@ -36,7 +39,6 @@ instance = MergeHRISClient::Benefit.new(
|
|
36
39
|
end_date: null,
|
37
40
|
remote_was_deleted: null,
|
38
41
|
employer_benefit: null,
|
39
|
-
modified_at: 2021-10-16T00:00Z,
|
40
42
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
41
43
|
remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
|
42
44
|
)
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::CommonModelScopeAPI
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **common_models** | [**Array<IndividualCommonModelScopeDeserializer>**](IndividualCommonModelScopeDeserializer.md) | The common models you want to update the scopes for | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::CommonModelScopeAPI.new(
|
15
|
+
common_models: [{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled_fields":["avatar","created_at","custom_fields","date_of_birth","first_name","gender","remote_created_at","remote_data"],"disabled_fields":["company","employments","groups","home_location","manager","work_location"]}}]
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/Company.md
CHANGED
@@ -6,12 +6,13 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
+
| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
|
10
|
+
| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
|
9
11
|
| **legal_name** | **String** | The company's legal name. | [optional] |
|
10
12
|
| **display_name** | **String** | The company's display name. | [optional] |
|
11
13
|
| **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
13
|
-
| **
|
14
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
15
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
15
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
@@ -22,11 +23,12 @@ require 'merge_hris_client'
|
|
22
23
|
instance = MergeHRISClient::Company.new(
|
23
24
|
id: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
24
25
|
remote_id: 19202938,
|
26
|
+
created_at: 2021-09-15T00:00Z,
|
27
|
+
modified_at: 2021-10-16T00:00Z,
|
25
28
|
legal_name: Waystar Royco, Inc.,
|
26
29
|
display_name: Waystar Royco,
|
27
30
|
eins: ["12-3456789","12-3451111","11-0011000"],
|
28
31
|
remote_was_deleted: null,
|
29
|
-
modified_at: 2021-10-16T00:00Z,
|
30
32
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
31
33
|
remote_data: [{"path":"/companies","data":["Varies by platform"]}]
|
32
34
|
)
|