merge_hris_client 1.0.4 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -12
  3. data/docs/AccountDetails.md +7 -7
  4. data/docs/AccountDetailsApi.md +2 -2
  5. data/docs/AccountIntegration.md +4 -4
  6. data/docs/AccountTokenApi.md +2 -2
  7. data/docs/AvailableActionsApi.md +2 -2
  8. data/docs/BankInfo.md +1 -1
  9. data/docs/BankInfoApi.md +8 -12
  10. data/docs/Benefit.md +2 -2
  11. data/docs/BenefitsApi.md +4 -4
  12. data/docs/CompaniesApi.md +4 -4
  13. data/docs/DataPassthroughRequest.md +2 -0
  14. data/docs/DebugModeLog.md +22 -0
  15. data/docs/DebugModelLogSummary.md +22 -0
  16. data/docs/Deduction.md +2 -2
  17. data/docs/DeductionsApi.md +4 -4
  18. data/docs/DeleteAccountApi.md +3 -2
  19. data/docs/Earning.md +3 -3
  20. data/docs/EarningTypeEnum.md +15 -0
  21. data/docs/Employee.md +9 -7
  22. data/docs/EmployeeEndpointRequest.md +18 -0
  23. data/docs/EmployeePayrollRun.md +2 -2
  24. data/docs/EmployeePayrollRunsApi.md +4 -4
  25. data/docs/EmployeeRequest.md +70 -0
  26. data/docs/EmployeeResponse.md +24 -0
  27. data/docs/EmployeesApi.md +158 -4
  28. data/docs/Employment.md +1 -1
  29. data/docs/EmploymentsApi.md +5 -4
  30. data/docs/EncodingEnum.md +15 -0
  31. data/docs/EndUserDetailsRequest.md +3 -1
  32. data/docs/ForceResyncApi.md +2 -2
  33. data/docs/GenerateKeyApi.md +2 -2
  34. data/docs/Group.md +28 -0
  35. data/docs/GroupTypeEnum.md +15 -0
  36. data/docs/GroupsApi.md +177 -0
  37. data/docs/IgnoreCommonModel.md +20 -0
  38. data/docs/IssuesApi.md +5 -4
  39. data/docs/LinkTokenApi.md +3 -3
  40. data/docs/LinkedAccountsApi.md +2 -2
  41. data/docs/Location.md +2 -0
  42. data/docs/LocationsApi.md +4 -4
  43. data/docs/MultipartFormFieldRequest.md +26 -0
  44. data/docs/PaginatedGroupList.md +22 -0
  45. data/docs/PassthroughApi.md +2 -2
  46. data/docs/PayGroupsApi.md +4 -4
  47. data/docs/PayrollRunsApi.md +4 -4
  48. data/docs/RegenerateKeyApi.md +2 -2
  49. data/docs/SyncStatusApi.md +0 -1
  50. data/docs/Tax.md +2 -2
  51. data/docs/Team.md +1 -1
  52. data/docs/TeamsApi.md +5 -4
  53. data/docs/TimeOff.md +2 -2
  54. data/docs/TimeOffApi.md +8 -6
  55. data/docs/TimeOffBalance.md +1 -1
  56. data/docs/TimeOffRequest.md +2 -2
  57. data/docs/TimeOffResponse.md +3 -1
  58. data/lib/merge_hris_client/api/bank_info_api.rb +4 -9
  59. data/lib/merge_hris_client/api/employees_api.rb +147 -2
  60. data/lib/merge_hris_client/api/groups_api.rb +182 -0
  61. data/lib/merge_hris_client/api/sync_status_api.rb +0 -62
  62. data/lib/merge_hris_client/api/time_off_api.rb +3 -0
  63. data/lib/merge_hris_client/configuration.rb +6 -4
  64. data/lib/merge_hris_client/models/account_details.rb +1 -1
  65. data/lib/merge_hris_client/models/account_details_and_actions.rb +1 -1
  66. data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +1 -1
  67. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +1 -0
  68. data/lib/merge_hris_client/models/account_integration.rb +5 -27
  69. data/lib/merge_hris_client/models/account_token.rb +1 -1
  70. data/lib/merge_hris_client/models/account_type_enum.rb +1 -0
  71. data/lib/merge_hris_client/models/available_actions.rb +1 -1
  72. data/lib/merge_hris_client/models/bank_info.rb +0 -1
  73. data/lib/merge_hris_client/models/benefit.rb +1 -2
  74. data/lib/merge_hris_client/models/categories_enum.rb +1 -0
  75. data/lib/merge_hris_client/models/category_enum.rb +1 -0
  76. data/lib/merge_hris_client/models/country_enum.rb +1 -0
  77. data/lib/merge_hris_client/models/data_passthrough_request.rb +16 -3
  78. data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
  79. data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
  80. data/lib/merge_hris_client/models/deduction.rb +0 -1
  81. data/lib/merge_hris_client/models/earning.rb +4 -8
  82. data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
  83. data/lib/merge_hris_client/models/employee.rb +13 -8
  84. data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
  85. data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
  86. data/lib/merge_hris_client/models/employee_request.rb +564 -0
  87. data/lib/merge_hris_client/models/employee_response.rb +266 -0
  88. data/lib/merge_hris_client/models/employment.rb +0 -1
  89. data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
  90. data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
  91. data/lib/merge_hris_client/models/encoding_enum.rb +36 -0
  92. data/lib/merge_hris_client/models/end_user_details_request.rb +40 -27
  93. data/lib/merge_hris_client/models/error_validation_problem.rb +1 -1
  94. data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
  95. data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
  96. data/lib/merge_hris_client/models/gender_enum.rb +1 -1
  97. data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -1
  98. data/lib/merge_hris_client/models/group.rb +275 -0
  99. data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
  100. data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
  101. data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
  102. data/lib/merge_hris_client/models/issue.rb +1 -1
  103. data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
  104. data/lib/merge_hris_client/models/link_token.rb +1 -1
  105. data/lib/merge_hris_client/models/location.rb +12 -1
  106. data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
  107. data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
  108. data/lib/merge_hris_client/models/method_enum.rb +1 -1
  109. data/lib/merge_hris_client/models/model_operation.rb +1 -1
  110. data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
  111. data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +1 -1
  112. data/lib/merge_hris_client/models/paginated_bank_info_list.rb +1 -1
  113. data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
  114. data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
  115. data/lib/merge_hris_client/models/paginated_deduction_list.rb +1 -1
  116. data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
  117. data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
  118. data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
  119. data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
  120. data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
  121. data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
  122. data/lib/merge_hris_client/models/paginated_pay_group_list.rb +1 -1
  123. data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
  124. data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
  125. data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
  126. data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
  127. data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
  128. data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
  129. data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
  130. data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
  131. data/lib/merge_hris_client/models/policy_type_enum.rb +1 -0
  132. data/lib/merge_hris_client/models/reason_enum.rb +37 -0
  133. data/lib/merge_hris_client/models/remote_data.rb +1 -1
  134. data/lib/merge_hris_client/models/remote_data_request.rb +1 -1
  135. data/lib/merge_hris_client/models/remote_key.rb +1 -1
  136. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -1
  137. data/lib/merge_hris_client/models/remote_response.rb +1 -1
  138. data/lib/merge_hris_client/models/request_format_enum.rb +2 -0
  139. data/lib/merge_hris_client/models/request_type_enum.rb +1 -0
  140. data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
  141. data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
  142. data/lib/merge_hris_client/models/sync_status.rb +1 -1
  143. data/lib/merge_hris_client/models/sync_status_status_enum.rb +1 -2
  144. data/lib/merge_hris_client/models/tax.rb +3 -7
  145. data/lib/merge_hris_client/models/team.rb +0 -1
  146. data/lib/merge_hris_client/models/time_off.rb +0 -2
  147. data/lib/merge_hris_client/models/time_off_balance.rb +0 -1
  148. data/lib/merge_hris_client/models/time_off_endpoint_request.rb +1 -1
  149. data/lib/merge_hris_client/models/time_off_request.rb +1 -3
  150. data/lib/merge_hris_client/models/time_off_response.rb +16 -5
  151. data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
  152. data/lib/merge_hris_client/models/units_enum.rb +1 -1
  153. data/lib/merge_hris_client/models/validation_problem_source.rb +1 -1
  154. data/lib/merge_hris_client/models/warning_validation_problem.rb +1 -1
  155. data/lib/merge_hris_client/version.rb +1 -1
  156. data/lib/merge_hris_client.rb +16 -2
  157. data/pull_request_template.md +3 -1
  158. data/spec/api/bank_info_api_spec.rb +2 -4
  159. data/spec/api/employees_api_spec.rb +26 -0
  160. data/spec/api/groups_api_spec.rb +68 -0
  161. data/spec/api/time_off_api_spec.rb +1 -0
  162. data/spec/models/data_passthrough_request_spec.rb +6 -0
  163. data/spec/models/debug_mode_log_spec.rb +46 -0
  164. data/spec/models/debug_model_log_summary_spec.rb +46 -0
  165. data/spec/models/earning_type_enum_spec.rb +28 -0
  166. data/spec/models/employee_endpoint_request_spec.rb +34 -0
  167. data/spec/models/employee_request_spec.rb +190 -0
  168. data/spec/models/employee_response_spec.rb +52 -0
  169. data/spec/models/employee_spec.rb +6 -0
  170. data/spec/models/encoding_enum_spec.rb +28 -0
  171. data/spec/models/end_user_details_request_spec.rb +6 -0
  172. data/spec/models/group_spec.rb +64 -0
  173. data/spec/models/group_type_enum_spec.rb +28 -0
  174. data/spec/models/ignore_common_model_spec.rb +40 -0
  175. data/spec/models/location_spec.rb +6 -0
  176. data/spec/models/multipart_form_field_request_spec.rb +58 -0
  177. data/spec/models/paginated_group_list_spec.rb +46 -0
  178. data/spec/models/time_off_response_spec.rb +6 -0
  179. metadata +57 -2
@@ -0,0 +1,70 @@
1
+ # MergeHRISClient::EmployeeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
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** | | [optional] |
10
+ | **first_name** | **String** | The employee's first name. | [optional] |
11
+ | **last_name** | **String** | The employee's last name. | [optional] |
12
+ | **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
13
+ | **groups** | **Array<String>** | | [optional] |
14
+ | **work_email** | **String** | The employee's work email. | [optional] |
15
+ | **personal_email** | **String** | The employee's personal email. | [optional] |
16
+ | **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** | | [optional] |
19
+ | **work_location** | **String** | | [optional] |
20
+ | **manager** | **String** | | [optional] |
21
+ | **team** | **String** | | [optional] |
22
+ | **pay_group** | **String** | | [optional] |
23
+ | **ssn** | **String** | The employee's social security number. | [optional] |
24
+ | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
25
+ | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
26
+ | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
27
+ | **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
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] |
30
+ | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
31
+ | **termination_date** | **Time** | The employee's termination date. | [optional] |
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] |
34
+
35
+ ## Example
36
+
37
+ ```ruby
38
+ require 'merge_hris_client'
39
+
40
+ instance = MergeHRISClient::EmployeeRequest.new(
41
+ remote_id: 19202938,
42
+ employee_number: 2,
43
+ company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
44
+ first_name: Jane,
45
+ last_name: Doe,
46
+ display_full_name: Jane Doe,
47
+ groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
48
+ work_email: jane@merge.dev,
49
+ personal_email: jane@gmail.com,
50
+ mobile_phone_number: +1234567890,
51
+ employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
52
+ home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
53
+ work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
54
+ manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
55
+ team: 249c9faa-3045-4a31-953b-8f22d3613301,
56
+ pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
57
+ ssn: 1234567890,
58
+ gender: FEMALE,
59
+ ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
60
+ marital_status: SINGLE,
61
+ date_of_birth: 1990-11-10T00:00Z,
62
+ hire_date: 2020-10-10T00:00Z,
63
+ start_date: 2020-10-11T00:00Z,
64
+ employment_status: INACTIVE,
65
+ termination_date: 2021-10-12T00:00Z,
66
+ avatar: http://alturl.com/h2h8m,
67
+ custom_fields: null
68
+ )
69
+ ```
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
@@ -4,10 +4,164 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**employees_create**](EmployeesApi.md#employees_create) | **POST** /employees | |
8
+ | [**employees_ignore_create**](EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} | |
7
9
  | [**employees_list**](EmployeesApi.md#employees_list) | **GET** /employees | |
8
10
  | [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | |
9
11
 
10
12
 
13
+ ## employees_create
14
+
15
+ > <EmployeeResponse> employees_create(x_account_token, employee_endpoint_request, opts)
16
+
17
+
18
+
19
+ Creates an `Employee` object with the given values.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'merge_hris_client'
26
+ # setup authorization
27
+ MergeHRISClient.configure do |config|
28
+ # Configure API key authorization: tokenAuth
29
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = MergeHRISClient::EmployeesApi.new
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 |
37
+ opts = {
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.
40
+ }
41
+
42
+ begin
43
+
44
+ result = api_instance.employees_create(x_account_token, employee_endpoint_request, opts)
45
+ p result
46
+ rescue MergeHRISClient::ApiError => e
47
+ puts "Error when calling EmployeesApi->employees_create: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the employees_create_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<EmployeeResponse>, Integer, Hash)> employees_create_with_http_info(x_account_token, employee_endpoint_request, opts)
56
+
57
+ ```ruby
58
+ begin
59
+
60
+ data, status_code, headers = api_instance.employees_create_with_http_info(x_account_token, employee_endpoint_request, opts)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <EmployeeResponse>
64
+ rescue MergeHRISClient::ApiError => e
65
+ puts "Error when calling EmployeesApi->employees_create_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
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] |
76
+ | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
77
+
78
+ ### Return type
79
+
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)
154
+
155
+ ### Authorization
156
+
157
+ [tokenAuth](../README.md#tokenAuth)
158
+
159
+ ### HTTP request headers
160
+
161
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
162
+ - **Accept**: application/json
163
+
164
+
11
165
  ## employees_list
12
166
 
13
167
  > <PaginatedEmployeeList> employees_list(x_account_token, opts)
@@ -24,9 +178,9 @@ require 'merge_hris_client'
24
178
  # setup authorization
25
179
  MergeHRISClient.configure do |config|
26
180
  # Configure API key authorization: tokenAuth
27
- config.api_key['Authorization'] = 'YOUR API KEY'
181
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
28
182
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
- # config.api_key_prefix['Authorization'] = 'Bearer'
183
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
184
  end
31
185
 
32
186
  api_instance = MergeHRISClient::EmployeesApi.new
@@ -133,9 +287,9 @@ require 'merge_hris_client'
133
287
  # setup authorization
134
288
  MergeHRISClient.configure do |config|
135
289
  # Configure API key authorization: tokenAuth
136
- config.api_key['Authorization'] = 'YOUR API KEY'
290
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
137
291
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
138
- # config.api_key_prefix['Authorization'] = 'Bearer'
292
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
139
293
  end
140
294
 
141
295
  api_instance = MergeHRISClient::EmployeesApi.new
data/docs/Employment.md CHANGED
@@ -6,7 +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** | The employee holding this position. | [optional] |
9
+ | **employee** | **String** | | [optional] |
10
10
  | **job_title** | **String** | The position&#39;s title. | [optional] |
11
11
  | **pay_rate** | **Float** | The position&#39;s pay rate in dollars. | [optional] |
12
12
  | **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. | [optional] |
@@ -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['Authorization'] = 'YOUR 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['Authorization'] = 'Bearer'
29
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
30
  end
31
31
 
32
32
  api_instance = MergeHRISClient::EmploymentsApi.new
@@ -121,15 +121,16 @@ require 'merge_hris_client'
121
121
  # setup authorization
122
122
  MergeHRISClient.configure do |config|
123
123
  # Configure API key authorization: tokenAuth
124
- config.api_key['Authorization'] = 'YOUR API KEY'
124
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
125
125
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
126
- # config.api_key_prefix['Authorization'] = 'Bearer'
126
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
127
127
  end
128
128
 
129
129
  api_instance = MergeHRISClient::EmploymentsApi.new
130
130
  x_account_token = 'x_account_token_example' # String | Token identifying the end user.
131
131
  id = TODO # String |
132
132
  opts = {
133
+ expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
133
134
  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
134
135
  }
135
136
 
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::EncodingEnum
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::EncodingEnum.new()
14
+ ```
15
+
@@ -9,6 +9,7 @@
9
9
  | **end_user_origin_id** | **String** | | |
10
10
  | **categories** | [**Array&lt;CategoriesEnum&gt;**](CategoriesEnum.md) | | [optional] |
11
11
  | **integration** | **String** | | [optional] |
12
+ | **link_expiry_mins** | **Integer** | | [optional][default to 30] |
12
13
 
13
14
  ## Example
14
15
 
@@ -20,7 +21,8 @@ instance = MergeHRISClient::EndUserDetailsRequest.new(
20
21
  end_user_organization_name: null,
21
22
  end_user_origin_id: null,
22
23
  categories: null,
23
- integration: null
24
+ integration: null,
25
+ link_expiry_mins: null
24
26
  )
25
27
  ```
26
28
 
@@ -23,9 +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['Authorization'] = 'YOUR API KEY'
26
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
27
27
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- config.api_key_prefix['Authorization'] = 'Bearer'
28
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
29
29
  end
30
30
 
31
31
  api_instance = MergeHRISClient::ForceResyncApi.new
@@ -23,9 +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['Authorization'] = 'YOUR API KEY'
26
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
27
27
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- # config.api_key_prefix['Authorization'] = 'Bearer'
28
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
29
29
  end
30
30
 
31
31
  api_instance = MergeHRISClient::GenerateKeyApi.new
data/docs/Group.md ADDED
@@ -0,0 +1,28 @@
1
+ # MergeHRISClient::Group
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **parent_group** | **String** | The parent group for this group. | [optional] |
10
+ | **name** | **String** | The group name. | [optional] |
11
+ | **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The group type | [optional] |
12
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'merge_hris_client'
18
+
19
+ instance = MergeHRISClient::Group.new(
20
+ id: 134e0111-0f67-44f6-98f0-597000290bb3,
21
+ remote_id: 800293,
22
+ parent_group: 2ef51b11-2c4e-4b02-8d1d-50592d9e96ef,
23
+ name: COST_CENTER_US,
24
+ type: COST_CENTER,
25
+ remote_data: [{&quot;path&quot;:&quot;/group&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
26
+ )
27
+ ```
28
+
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::GroupTypeEnum
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::GroupTypeEnum.new()
14
+ ```
15
+
data/docs/GroupsApi.md ADDED
@@ -0,0 +1,177 @@
1
+ # MergeHRISClient::GroupsApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**groups_list**](GroupsApi.md#groups_list) | **GET** /groups | |
8
+ | [**groups_retrieve**](GroupsApi.md#groups_retrieve) | **GET** /groups/{id} | |
9
+
10
+
11
+ ## groups_list
12
+
13
+ > <PaginatedGroupList> groups_list(x_account_token, opts)
14
+
15
+
16
+
17
+ Returns a list of `Group` objects.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'merge_hris_client'
24
+ # setup authorization
25
+ MergeHRISClient.configure do |config|
26
+ # Configure API key authorization: tokenAuth
27
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
+ end
31
+
32
+ api_instance = MergeHRISClient::GroupsApi.new
33
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
34
+ opts = {
35
+ created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
36
+ created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
37
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
39
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
40
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
41
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
42
+ page_size: 56, # Integer | Number of results to return per page.
43
+ remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
44
+ }
45
+
46
+ begin
47
+
48
+ result = api_instance.groups_list(x_account_token, opts)
49
+ p result
50
+ rescue MergeHRISClient::ApiError => e
51
+ puts "Error when calling GroupsApi->groups_list: #{e}"
52
+ end
53
+ ```
54
+
55
+ #### Using the groups_list_with_http_info variant
56
+
57
+ This returns an Array which contains the response data, status code and headers.
58
+
59
+ > <Array(<PaginatedGroupList>, Integer, Hash)> groups_list_with_http_info(x_account_token, opts)
60
+
61
+ ```ruby
62
+ begin
63
+
64
+ data, status_code, headers = api_instance.groups_list_with_http_info(x_account_token, opts)
65
+ p status_code # => 2xx
66
+ p headers # => { ... }
67
+ p data # => <PaginatedGroupList>
68
+ rescue MergeHRISClient::ApiError => e
69
+ puts "Error when calling GroupsApi->groups_list_with_http_info: #{e}"
70
+ end
71
+ ```
72
+
73
+ ### Parameters
74
+
75
+ | Name | Type | Description | Notes |
76
+ | ---- | ---- | ----------- | ----- |
77
+ | **x_account_token** | **String** | Token identifying the end user. | |
78
+ | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
79
+ | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
80
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
81
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
82
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
83
+ | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
84
+ | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
85
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
86
+ | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
87
+
88
+ ### Return type
89
+
90
+ [**PaginatedGroupList**](PaginatedGroupList.md)
91
+
92
+ ### Authorization
93
+
94
+ [tokenAuth](../README.md#tokenAuth)
95
+
96
+ ### HTTP request headers
97
+
98
+ - **Content-Type**: Not defined
99
+ - **Accept**: application/json
100
+
101
+
102
+ ## groups_retrieve
103
+
104
+ > <Group> groups_retrieve(x_account_token, id, opts)
105
+
106
+
107
+
108
+ Returns a `Group` object with the given `id`.
109
+
110
+ ### Examples
111
+
112
+ ```ruby
113
+ require 'time'
114
+ require 'merge_hris_client'
115
+ # setup authorization
116
+ MergeHRISClient.configure do |config|
117
+ # Configure API key authorization: tokenAuth
118
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
121
+ end
122
+
123
+ api_instance = MergeHRISClient::GroupsApi.new
124
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
125
+ id = TODO # String |
126
+ opts = {
127
+ include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
128
+ }
129
+
130
+ begin
131
+
132
+ result = api_instance.groups_retrieve(x_account_token, id, opts)
133
+ p result
134
+ rescue MergeHRISClient::ApiError => e
135
+ puts "Error when calling GroupsApi->groups_retrieve: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the groups_retrieve_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(<Group>, Integer, Hash)> groups_retrieve_with_http_info(x_account_token, id, opts)
144
+
145
+ ```ruby
146
+ begin
147
+
148
+ data, status_code, headers = api_instance.groups_retrieve_with_http_info(x_account_token, id, opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => <Group>
152
+ rescue MergeHRISClient::ApiError => e
153
+ puts "Error when calling GroupsApi->groups_retrieve_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **x_account_token** | **String** | Token identifying the end user. | |
162
+ | **id** | [**String**](.md) | | |
163
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
164
+
165
+ ### Return type
166
+
167
+ [**Group**](Group.md)
168
+
169
+ ### Authorization
170
+
171
+ [tokenAuth](../README.md#tokenAuth)
172
+
173
+ ### HTTP request headers
174
+
175
+ - **Content-Type**: Not defined
176
+ - **Accept**: application/json
177
+
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::IgnoreCommonModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **reason** | [**ReasonEnum**](ReasonEnum.md) | | |
8
+ | **message** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::IgnoreCommonModel.new(
16
+ reason: GENERAL_CUSTOMER_REQUEST,
17
+ message: deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39
18
+ )
19
+ ```
20
+
data/docs/IssuesApi.md CHANGED
@@ -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['Authorization'] = 'YOUR 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['Authorization'] = 'Bearer'
29
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
30
  end
31
31
 
32
32
  api_instance = MergeHRISClient::IssuesApi.new
@@ -113,8 +113,9 @@ require 'merge_hris_client'
113
113
  # setup authorization
114
114
  MergeHRISClient.configure do |config|
115
115
  # Configure API key authorization: tokenAuth
116
- config.api_key['Authorization'] = 'YOUR API KEY'
117
- config.api_key_prefix['Authorization'] = 'Bearer'
116
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
117
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
118
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
118
119
  end
119
120
 
120
121
  api_instance = MergeHRISClient::IssuesApi.new
data/docs/LinkTokenApi.md CHANGED
@@ -23,13 +23,13 @@ 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['Authorization'] = 'YOUR API KEY'
26
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
27
27
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- # config.api_key_prefix['Authorization'] = 'Bearer'
28
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
29
29
  end
30
30
 
31
31
  api_instance = MergeHRISClient::LinkTokenApi.new
32
- end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: ['hris']}) # EndUserDetailsRequest |
32
+ end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example'}) # EndUserDetailsRequest |
33
33
 
34
34
  begin
35
35