merge_hris_client 1.0.4 → 2.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (203) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -12
  3. data/docs/AccountDetails.md +11 -7
  4. data/docs/AccountDetailsAndActions.md +2 -0
  5. data/docs/AccountDetailsApi.md +10 -7
  6. data/docs/AccountIntegration.md +4 -4
  7. data/docs/AccountTokenApi.md +2 -2
  8. data/docs/AvailableActionsApi.md +2 -2
  9. data/docs/BankInfo.md +1 -1
  10. data/docs/BankInfoApi.md +8 -12
  11. data/docs/Benefit.md +2 -2
  12. data/docs/BenefitsApi.md +4 -4
  13. data/docs/CompaniesApi.md +4 -4
  14. data/docs/Company.md +2 -2
  15. data/docs/DataPassthroughRequest.md +3 -1
  16. data/docs/DebugModeLog.md +22 -0
  17. data/docs/DebugModelLogSummary.md +22 -0
  18. data/docs/Deduction.md +2 -2
  19. data/docs/DeductionsApi.md +4 -4
  20. data/docs/DeleteAccountApi.md +3 -2
  21. data/docs/Earning.md +3 -3
  22. data/docs/EarningTypeEnum.md +15 -0
  23. data/docs/Employee.md +17 -15
  24. data/docs/EmployeeEndpointRequest.md +18 -0
  25. data/docs/EmployeePayrollRun.md +2 -2
  26. data/docs/EmployeePayrollRunsApi.md +4 -4
  27. data/docs/EmployeeRequest.md +70 -0
  28. data/docs/EmployeeResponse.md +24 -0
  29. data/docs/EmployeesApi.md +232 -4
  30. data/docs/Employment.md +6 -4
  31. data/docs/EmploymentsApi.md +5 -4
  32. data/docs/EncodingEnum.md +15 -0
  33. data/docs/EndUserDetailsRequest.md +5 -3
  34. data/docs/ForceResyncApi.md +2 -2
  35. data/docs/GenerateKeyApi.md +2 -2
  36. data/docs/Group.md +28 -0
  37. data/docs/GroupTypeEnum.md +15 -0
  38. data/docs/GroupsApi.md +177 -0
  39. data/docs/IgnoreCommonModel.md +20 -0
  40. data/docs/IssuesApi.md +13 -4
  41. data/docs/LinkTokenApi.md +3 -3
  42. data/docs/LinkedAccountStatus.md +20 -0
  43. data/docs/LinkedAccountsApi.md +2 -2
  44. data/docs/Location.md +3 -1
  45. data/docs/LocationsApi.md +4 -4
  46. data/docs/MetaResponse.md +24 -0
  47. data/docs/MultipartFormFieldRequest.md +26 -0
  48. data/docs/PaginatedGroupList.md +22 -0
  49. data/docs/PassthroughApi.md +2 -2
  50. data/docs/PayGroupsApi.md +4 -4
  51. data/docs/PayrollRunsApi.md +4 -4
  52. data/docs/RegenerateKeyApi.md +2 -2
  53. data/docs/SyncStatusApi.md +0 -1
  54. data/docs/Tax.md +2 -2
  55. data/docs/Team.md +1 -1
  56. data/docs/TeamsApi.md +5 -4
  57. data/docs/TimeOff.md +4 -4
  58. data/docs/TimeOffApi.md +80 -6
  59. data/docs/TimeOffBalance.md +2 -2
  60. data/docs/TimeOffRequest.md +4 -4
  61. data/docs/TimeOffResponse.md +3 -1
  62. data/docs/WebhookReceiver.md +22 -0
  63. data/docs/WebhookReceiverRequest.md +22 -0
  64. data/docs/WebhookReceiversApi.md +153 -0
  65. data/lib/merge_hris_client/api/account_details_api.rb +10 -3
  66. data/lib/merge_hris_client/api/bank_info_api.rb +4 -9
  67. data/lib/merge_hris_client/api/employees_api.rb +216 -2
  68. data/lib/merge_hris_client/api/employments_api.rb +2 -2
  69. data/lib/merge_hris_client/api/groups_api.rb +182 -0
  70. data/lib/merge_hris_client/api/issues_api.rb +12 -0
  71. data/lib/merge_hris_client/api/linked_accounts_api.rb +1 -1
  72. data/lib/merge_hris_client/api/sync_status_api.rb +0 -62
  73. data/lib/merge_hris_client/api/time_off_api.rb +65 -0
  74. data/lib/merge_hris_client/api/webhook_receivers_api.rb +154 -0
  75. data/lib/merge_hris_client/configuration.rb +6 -4
  76. data/lib/merge_hris_client/models/account_details.rb +23 -5
  77. data/lib/merge_hris_client/models/account_details_and_actions.rb +16 -2
  78. data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +1 -1
  79. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +1 -0
  80. data/lib/merge_hris_client/models/account_integration.rb +5 -27
  81. data/lib/merge_hris_client/models/account_token.rb +1 -1
  82. data/lib/merge_hris_client/models/account_type_enum.rb +1 -0
  83. data/lib/merge_hris_client/models/available_actions.rb +1 -1
  84. data/lib/merge_hris_client/models/bank_info.rb +0 -1
  85. data/lib/merge_hris_client/models/benefit.rb +1 -2
  86. data/lib/merge_hris_client/models/categories_enum.rb +1 -0
  87. data/lib/merge_hris_client/models/category_enum.rb +1 -0
  88. data/lib/merge_hris_client/models/company.rb +1 -1
  89. data/lib/merge_hris_client/models/country_enum.rb +1 -0
  90. data/lib/merge_hris_client/models/data_passthrough_request.rb +17 -3
  91. data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
  92. data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
  93. data/lib/merge_hris_client/models/deduction.rb +0 -1
  94. data/lib/merge_hris_client/models/earning.rb +4 -7
  95. data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
  96. data/lib/merge_hris_client/models/employee.rb +14 -9
  97. data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
  98. data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
  99. data/lib/merge_hris_client/models/employee_request.rb +564 -0
  100. data/lib/merge_hris_client/models/employee_response.rb +266 -0
  101. data/lib/merge_hris_client/models/employment.rb +12 -3
  102. data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
  103. data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
  104. data/lib/merge_hris_client/models/encoding_enum.rb +36 -0
  105. data/lib/merge_hris_client/models/end_user_details_request.rb +74 -27
  106. data/lib/merge_hris_client/models/error_validation_problem.rb +1 -1
  107. data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
  108. data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
  109. data/lib/merge_hris_client/models/gender_enum.rb +1 -1
  110. data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -1
  111. data/lib/merge_hris_client/models/group.rb +275 -0
  112. data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
  113. data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
  114. data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
  115. data/lib/merge_hris_client/models/issue.rb +1 -1
  116. data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
  117. data/lib/merge_hris_client/models/link_token.rb +1 -1
  118. data/lib/merge_hris_client/models/linked_account_status.rb +237 -0
  119. data/lib/merge_hris_client/models/location.rb +13 -2
  120. data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
  121. data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
  122. data/lib/merge_hris_client/models/meta_response.rb +262 -0
  123. data/lib/merge_hris_client/models/method_enum.rb +1 -1
  124. data/lib/merge_hris_client/models/model_operation.rb +1 -1
  125. data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
  126. data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +1 -1
  127. data/lib/merge_hris_client/models/paginated_bank_info_list.rb +1 -1
  128. data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
  129. data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
  130. data/lib/merge_hris_client/models/paginated_deduction_list.rb +1 -1
  131. data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
  132. data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
  133. data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
  134. data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
  135. data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
  136. data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
  137. data/lib/merge_hris_client/models/paginated_pay_group_list.rb +1 -1
  138. data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
  139. data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
  140. data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
  141. data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
  142. data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
  143. data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
  144. data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
  145. data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
  146. data/lib/merge_hris_client/models/payroll_run.rb +1 -1
  147. data/lib/merge_hris_client/models/policy_type_enum.rb +1 -0
  148. data/lib/merge_hris_client/models/reason_enum.rb +37 -0
  149. data/lib/merge_hris_client/models/remote_data.rb +1 -1
  150. data/lib/merge_hris_client/models/remote_data_request.rb +1 -1
  151. data/lib/merge_hris_client/models/remote_key.rb +1 -1
  152. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -1
  153. data/lib/merge_hris_client/models/remote_response.rb +1 -1
  154. data/lib/merge_hris_client/models/request_format_enum.rb +2 -0
  155. data/lib/merge_hris_client/models/request_type_enum.rb +1 -0
  156. data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
  157. data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
  158. data/lib/merge_hris_client/models/sync_status.rb +1 -1
  159. data/lib/merge_hris_client/models/sync_status_status_enum.rb +1 -2
  160. data/lib/merge_hris_client/models/tax.rb +3 -6
  161. data/lib/merge_hris_client/models/team.rb +0 -1
  162. data/lib/merge_hris_client/models/time_off.rb +0 -2
  163. data/lib/merge_hris_client/models/time_off_balance.rb +1 -2
  164. data/lib/merge_hris_client/models/time_off_endpoint_request.rb +1 -1
  165. data/lib/merge_hris_client/models/time_off_request.rb +1 -3
  166. data/lib/merge_hris_client/models/time_off_response.rb +16 -5
  167. data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
  168. data/lib/merge_hris_client/models/units_enum.rb +1 -1
  169. data/lib/merge_hris_client/models/validation_problem_source.rb +1 -1
  170. data/lib/merge_hris_client/models/warning_validation_problem.rb +1 -1
  171. data/lib/merge_hris_client/models/webhook_receiver.rb +246 -0
  172. data/lib/merge_hris_client/models/webhook_receiver_request.rb +280 -0
  173. data/lib/merge_hris_client/version.rb +1 -1
  174. data/lib/merge_hris_client.rb +21 -2
  175. data/pull_request_template.md +3 -1
  176. data/spec/api/account_details_api_spec.rb +1 -0
  177. data/spec/api/bank_info_api_spec.rb +2 -4
  178. data/spec/api/employees_api_spec.rb +38 -0
  179. data/spec/api/groups_api_spec.rb +68 -0
  180. data/spec/api/issues_api_spec.rb +4 -0
  181. data/spec/api/time_off_api_spec.rb +12 -0
  182. data/spec/models/account_details_and_actions_spec.rb +6 -0
  183. data/spec/models/account_details_spec.rb +12 -0
  184. data/spec/models/data_passthrough_request_spec.rb +6 -0
  185. data/spec/models/debug_mode_log_spec.rb +46 -0
  186. data/spec/models/debug_model_log_summary_spec.rb +46 -0
  187. data/spec/models/earning_type_enum_spec.rb +28 -0
  188. data/spec/models/employee_endpoint_request_spec.rb +34 -0
  189. data/spec/models/employee_request_spec.rb +190 -0
  190. data/spec/models/employee_response_spec.rb +52 -0
  191. data/spec/models/employee_spec.rb +6 -0
  192. data/spec/models/employment_spec.rb +6 -0
  193. data/spec/models/encoding_enum_spec.rb +28 -0
  194. data/spec/models/end_user_details_request_spec.rb +6 -0
  195. data/spec/models/group_spec.rb +64 -0
  196. data/spec/models/group_type_enum_spec.rb +28 -0
  197. data/spec/models/ignore_common_model_spec.rb +40 -0
  198. data/spec/models/location_spec.rb +6 -0
  199. data/spec/models/multipart_form_field_request_spec.rb +58 -0
  200. data/spec/models/paginated_group_list_spec.rb +46 -0
  201. data/spec/models/time_off_response_spec.rb +6 -0
  202. metadata +153 -89
  203. data/test_ruby.rb +0 -30
data/docs/Employee.md CHANGED
@@ -6,20 +6,21 @@
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_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. | [optional] |
10
- | **company** | **String** | The ID of the employee's company. | [optional] |
9
+ | **employee_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers. | [optional] |
10
+ | **company** | **String** | | [optional] |
11
11
  | **first_name** | **String** | The employee's first name. | [optional] |
12
12
  | **last_name** | **String** | The employee's last name. | [optional] |
13
13
  | **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
14
+ | **groups** | **Array<String>** | | [optional] |
14
15
  | **work_email** | **String** | The employee's work email. | [optional] |
15
16
  | **personal_email** | **String** | The employee's personal email. | [optional] |
16
17
  | **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
17
- | **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional][readonly] |
18
- | **home_location** | **String** | The employee's home address. | [optional] |
19
- | **work_location** | **String** | The employee's work address. | [optional] |
20
- | **manager** | **String** | The employee ID of the employee's manager. | [optional] |
21
- | **team** | **String** | The employee's team. | [optional] |
22
- | **pay_group** | **String** | The employee's pay group | [optional] |
18
+ | **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
19
+ | **home_location** | **String** | | [optional] |
20
+ | **work_location** | **String** | | [optional] |
21
+ | **manager** | **String** | | [optional] |
22
+ | **team** | **String** | | [optional] |
23
+ | **pay_group** | **String** | | [optional] |
23
24
  | **ssn** | **String** | The employee's social security number. | [optional] |
24
25
  | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
25
26
  | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
@@ -43,11 +44,12 @@ instance = MergeHRISClient::Employee.new(
43
44
  remote_id: 19202938,
44
45
  employee_number: 2,
45
46
  company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
46
- first_name: Jane,
47
- last_name: Doe,
48
- display_full_name: Jane Doe,
49
- work_email: jane@merge.dev,
50
- personal_email: jane@gmail.com,
47
+ first_name: Greg,
48
+ last_name: Hirsch,
49
+ display_full_name: Cousin Greg Hirsch,
50
+ groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
51
+ work_email: greg@merge.dev,
52
+ personal_email: greg@gmail.com,
51
53
  mobile_phone_number: +1234567890,
52
54
  employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
53
55
  home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
@@ -56,8 +58,8 @@ instance = MergeHRISClient::Employee.new(
56
58
  team: 249c9faa-3045-4a31-953b-8f22d3613301,
57
59
  pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
58
60
  ssn: 1234567890,
59
- gender: FEMALE,
60
- ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
61
+ gender: MALE,
62
+ ethnicity: WHITE,
61
63
  marital_status: SINGLE,
62
64
  date_of_birth: 1990-11-10T00:00Z,
63
65
  hire_date: 2020-10-10T00:00Z,
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::EmployeeEndpointRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**EmployeeRequest**](EmployeeRequest.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::EmployeeEndpointRequest.new(
15
+ model: null
16
+ )
17
+ ```
18
+
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **employee** | **String** | The employee whose payroll is being run. | [optional] |
10
- | **payroll_run** | **String** | The payroll being run. | [optional] |
9
+ | **employee** | **String** | | [optional] |
10
+ | **payroll_run** | **String** | | [optional] |
11
11
  | **gross_pay** | **Float** | The gross pay from the run. | [optional] |
12
12
  | **net_pay** | **Float** | The net pay from the run. | [optional] |
13
13
  | **start_date** | **Time** | The day and time the payroll run started. | [optional] |
@@ -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::EmployeePayrollRunsApi.new
@@ -129,9 +129,9 @@ require 'merge_hris_client'
129
129
  # setup authorization
130
130
  MergeHRISClient.configure do |config|
131
131
  # Configure API key authorization: tokenAuth
132
- config.api_key['Authorization'] = 'YOUR API KEY'
132
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
133
133
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
134
- # config.api_key_prefix['Authorization'] = 'Bearer'
134
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
135
135
  end
136
136
 
137
137
  api_instance = MergeHRISClient::EmployeePayrollRunsApi.new
@@ -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. This value can also change in many API providers. | [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: Greg,
45
+ last_name: Hirsch,
46
+ display_full_name: Cousin Greg Hirsch,
47
+ groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
48
+ work_email: greg@merge.dev,
49
+ personal_email: greg@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: MALE,
59
+ ethnicity: WHITE,
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,167 @@ 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 | |
10
+ | [**employees_meta_post_retrieve**](EmployeesApi.md#employees_meta_post_retrieve) | **GET** /employees/meta/post | |
8
11
  | [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | |
9
12
 
10
13
 
14
+ ## employees_create
15
+
16
+ > <EmployeeResponse> employees_create(x_account_token, employee_endpoint_request, opts)
17
+
18
+
19
+
20
+ Creates an `Employee` object with the given values.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'merge_hris_client'
27
+ # setup authorization
28
+ MergeHRISClient.configure do |config|
29
+ # Configure API key authorization: tokenAuth
30
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
33
+ end
34
+
35
+ api_instance = MergeHRISClient::EmployeesApi.new
36
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
37
+ employee_endpoint_request = MergeHRISClient::EmployeeEndpointRequest.new({model: MergeHRISClient::EmployeeRequest.new}) # EmployeeEndpointRequest |
38
+ opts = {
39
+ is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
40
+ run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
41
+ }
42
+
43
+ begin
44
+
45
+ result = api_instance.employees_create(x_account_token, employee_endpoint_request, opts)
46
+ p result
47
+ rescue MergeHRISClient::ApiError => e
48
+ puts "Error when calling EmployeesApi->employees_create: #{e}"
49
+ end
50
+ ```
51
+
52
+ #### Using the employees_create_with_http_info variant
53
+
54
+ This returns an Array which contains the response data, status code and headers.
55
+
56
+ > <Array(<EmployeeResponse>, Integer, Hash)> employees_create_with_http_info(x_account_token, employee_endpoint_request, opts)
57
+
58
+ ```ruby
59
+ begin
60
+
61
+ data, status_code, headers = api_instance.employees_create_with_http_info(x_account_token, employee_endpoint_request, opts)
62
+ p status_code # => 2xx
63
+ p headers # => { ... }
64
+ p data # => <EmployeeResponse>
65
+ rescue MergeHRISClient::ApiError => e
66
+ puts "Error when calling EmployeesApi->employees_create_with_http_info: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ | Name | Type | Description | Notes |
73
+ | ---- | ---- | ----------- | ----- |
74
+ | **x_account_token** | **String** | Token identifying the end user. | |
75
+ | **employee_endpoint_request** | [**EmployeeEndpointRequest**](EmployeeEndpointRequest.md) | | |
76
+ | **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
77
+ | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
78
+
79
+ ### Return type
80
+
81
+ [**EmployeeResponse**](EmployeeResponse.md)
82
+
83
+ ### Authorization
84
+
85
+ [tokenAuth](../README.md#tokenAuth)
86
+
87
+ ### HTTP request headers
88
+
89
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
90
+ - **Accept**: application/json
91
+
92
+
93
+ ## employees_ignore_create
94
+
95
+ > <IgnoreCommonModel> employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
96
+
97
+
98
+
99
+ 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.
100
+
101
+ ### Examples
102
+
103
+ ```ruby
104
+ require 'time'
105
+ require 'merge_hris_client'
106
+ # setup authorization
107
+ MergeHRISClient.configure do |config|
108
+ # Configure API key authorization: tokenAuth
109
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
110
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
111
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
112
+ end
113
+
114
+ api_instance = MergeHRISClient::EmployeesApi.new
115
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
116
+ model_id = TODO # String |
117
+ ignore_common_model_request = MergeHRISClient::IgnoreCommonModelRequest.new({reason: MergeHRISClient::ReasonEnum::GENERAL_CUSTOMER_REQUEST}) # IgnoreCommonModelRequest |
118
+
119
+ begin
120
+
121
+ result = api_instance.employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
122
+ p result
123
+ rescue MergeHRISClient::ApiError => e
124
+ puts "Error when calling EmployeesApi->employees_ignore_create: #{e}"
125
+ end
126
+ ```
127
+
128
+ #### Using the employees_ignore_create_with_http_info variant
129
+
130
+ This returns an Array which contains the response data, status code and headers.
131
+
132
+ > <Array(<IgnoreCommonModel>, Integer, Hash)> employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
133
+
134
+ ```ruby
135
+ begin
136
+
137
+ data, status_code, headers = api_instance.employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
138
+ p status_code # => 2xx
139
+ p headers # => { ... }
140
+ p data # => <IgnoreCommonModel>
141
+ rescue MergeHRISClient::ApiError => e
142
+ puts "Error when calling EmployeesApi->employees_ignore_create_with_http_info: #{e}"
143
+ end
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ | Name | Type | Description | Notes |
149
+ | ---- | ---- | ----------- | ----- |
150
+ | **x_account_token** | **String** | Token identifying the end user. | |
151
+ | **model_id** | [**String**](.md) | | |
152
+ | **ignore_common_model_request** | [**IgnoreCommonModelRequest**](IgnoreCommonModelRequest.md) | | |
153
+
154
+ ### Return type
155
+
156
+ [**IgnoreCommonModel**](IgnoreCommonModel.md)
157
+
158
+ ### Authorization
159
+
160
+ [tokenAuth](../README.md#tokenAuth)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
165
+ - **Accept**: application/json
166
+
167
+
11
168
  ## employees_list
12
169
 
13
170
  > <PaginatedEmployeeList> employees_list(x_account_token, opts)
@@ -24,9 +181,9 @@ require 'merge_hris_client'
24
181
  # setup authorization
25
182
  MergeHRISClient.configure do |config|
26
183
  # Configure API key authorization: tokenAuth
27
- config.api_key['Authorization'] = 'YOUR API KEY'
184
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
28
185
  # 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'
186
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
187
  end
31
188
 
32
189
  api_instance = MergeHRISClient::EmployeesApi.new
@@ -117,6 +274,77 @@ end
117
274
  - **Accept**: application/json
118
275
 
119
276
 
277
+ ## employees_meta_post_retrieve
278
+
279
+ > <MetaResponse> employees_meta_post_retrieve(x_account_token)
280
+
281
+
282
+
283
+ Returns metadata for `Employee` POSTs.
284
+
285
+ ### Examples
286
+
287
+ ```ruby
288
+ require 'time'
289
+ require 'merge_hris_client'
290
+ # setup authorization
291
+ MergeHRISClient.configure do |config|
292
+ # Configure API key authorization: tokenAuth
293
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
294
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
295
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
296
+ end
297
+
298
+ api_instance = MergeHRISClient::EmployeesApi.new
299
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
300
+
301
+ begin
302
+
303
+ result = api_instance.employees_meta_post_retrieve(x_account_token)
304
+ p result
305
+ rescue MergeHRISClient::ApiError => e
306
+ puts "Error when calling EmployeesApi->employees_meta_post_retrieve: #{e}"
307
+ end
308
+ ```
309
+
310
+ #### Using the employees_meta_post_retrieve_with_http_info variant
311
+
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<MetaResponse>, Integer, Hash)> employees_meta_post_retrieve_with_http_info(x_account_token)
315
+
316
+ ```ruby
317
+ begin
318
+
319
+ data, status_code, headers = api_instance.employees_meta_post_retrieve_with_http_info(x_account_token)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <MetaResponse>
323
+ rescue MergeHRISClient::ApiError => e
324
+ puts "Error when calling EmployeesApi->employees_meta_post_retrieve_with_http_info: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+ | **x_account_token** | **String** | Token identifying the end user. | |
333
+
334
+ ### Return type
335
+
336
+ [**MetaResponse**](MetaResponse.md)
337
+
338
+ ### Authorization
339
+
340
+ [tokenAuth](../README.md#tokenAuth)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: Not defined
345
+ - **Accept**: application/json
346
+
347
+
120
348
  ## employees_retrieve
121
349
 
122
350
  > <Employee> employees_retrieve(x_account_token, id, opts)
@@ -133,9 +361,9 @@ require 'merge_hris_client'
133
361
  # setup authorization
134
362
  MergeHRISClient.configure do |config|
135
363
  # Configure API key authorization: tokenAuth
136
- config.api_key['Authorization'] = 'YOUR API KEY'
364
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
137
365
  # 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'
366
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
139
367
  end
140
368
 
141
369
  api_instance = MergeHRISClient::EmployeesApi.new
data/docs/Employment.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
- | **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] |
13
13
  | **pay_frequency** | [**PayFrequencyEnum**](PayFrequencyEnum.md) | The position&#39;s pay frequency. | [optional] |
14
14
  | **pay_currency** | [**PayCurrencyEnum**](PayCurrencyEnum.md) | The position&#39;s currency code. | [optional] |
15
+ | **pay_group** | **String** | | [optional] |
15
16
  | **flsa_status** | [**FlsaStatusEnum**](FlsaStatusEnum.md) | The position&#39;s FLSA status. | [optional] |
16
17
  | **effective_date** | **Time** | The position&#39;s effective date. | [optional] |
17
18
  | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position&#39;s type of employment. | [optional] |
@@ -26,13 +27,14 @@ instance = MergeHRISClient::Employment.new(
26
27
  id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
27
28
  remote_id: 19202938,
28
29
  employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
29
- job_title: Software Engineer,
30
- pay_rate: 80000.00,
30
+ job_title: Executive Assistant to Tom Wambsgans,
31
+ pay_rate: 500.00,
31
32
  pay_period: YEAR,
32
33
  pay_frequency: BIWEEKLY,
33
34
  pay_currency: USD,
35
+ pay_group: d4e4837f-9900-484c-ac40-528365bb08ef,
34
36
  flsa_status: EXEMPT,
35
- effective_date: 2020-10-06T18:42:34Z,
37
+ effective_date: 2023-10-06T18:42:34Z,
36
38
  employment_type: FULL TIME,
37
39
  remote_data: [{&quot;path&quot;:&quot;/jobs&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
38
40
  )
@@ -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
+
@@ -7,8 +7,9 @@
7
7
  | **end_user_email_address** | **String** | | |
8
8
  | **end_user_organization_name** | **String** | | |
9
9
  | **end_user_origin_id** | **String** | | |
10
- | **categories** | [**Array&lt;CategoriesEnum&gt;**](CategoriesEnum.md) | | [optional] |
11
- | **integration** | **String** | | [optional] |
10
+ | **categories** | [**Array&lt;Categories143Enum&gt;**](Categories143Enum.md) | | |
11
+ | **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata | [optional] |
12
+ | **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [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
+