merge_hris_client 2.0.0 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -5
  3. data/docs/AccountDetails.md +5 -1
  4. data/docs/AccountDetailsAndActions.md +2 -0
  5. data/docs/AccountDetailsApi.md +8 -5
  6. data/docs/BankInfo.md +3 -1
  7. data/docs/Benefit.md +3 -1
  8. data/docs/Company.md +5 -3
  9. data/docs/DataPassthroughRequest.md +1 -1
  10. data/docs/Deduction.md +3 -1
  11. data/docs/Earning.md +4 -2
  12. data/docs/Employee.md +11 -9
  13. data/docs/EmployeePayrollRun.md +3 -1
  14. data/docs/EmployeeRequest.md +8 -8
  15. data/docs/EmployeesApi.md +86 -4
  16. data/docs/Employment.md +8 -4
  17. data/docs/EndUserDetailsRequest.md +3 -3
  18. data/docs/ForceResyncApi.md +4 -4
  19. data/docs/Group.md +3 -1
  20. data/docs/IssuesApi.md +8 -0
  21. data/docs/LinkTokenApi.md +1 -1
  22. data/docs/LinkedAccountStatus.md +20 -0
  23. data/docs/LinkedAccountsApi.md +14 -14
  24. data/docs/Location.md +5 -3
  25. data/docs/MetaResponse.md +24 -0
  26. data/docs/PayGroup.md +3 -1
  27. data/docs/PayrollRun.md +3 -1
  28. data/docs/Tax.md +4 -2
  29. data/docs/Team.md +3 -1
  30. data/docs/TimeOff.md +5 -3
  31. data/docs/TimeOffApi.md +72 -0
  32. data/docs/TimeOffBalance.md +4 -2
  33. data/docs/TimeOffRequest.md +2 -2
  34. data/docs/WebhookReceiver.md +22 -0
  35. data/docs/WebhookReceiverRequest.md +22 -0
  36. data/docs/WebhookReceiversApi.md +153 -0
  37. data/lib/merge_hris_client/api/account_details_api.rb +10 -3
  38. data/lib/merge_hris_client/api/bank_info_api.rb +0 -1
  39. data/lib/merge_hris_client/api/employees_api.rb +88 -3
  40. data/lib/merge_hris_client/api/employments_api.rb +2 -2
  41. data/lib/merge_hris_client/api/force_resync_api.rb +3 -3
  42. data/lib/merge_hris_client/api/issues_api.rb +12 -0
  43. data/lib/merge_hris_client/api/linked_accounts_api.rb +15 -15
  44. data/lib/merge_hris_client/api/time_off_api.rb +62 -0
  45. data/lib/merge_hris_client/api/webhook_receivers_api.rb +154 -0
  46. data/lib/merge_hris_client/models/account_details.rb +22 -4
  47. data/lib/merge_hris_client/models/account_details_and_actions.rb +15 -1
  48. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +0 -1
  49. data/lib/merge_hris_client/models/account_type_enum.rb +0 -1
  50. data/lib/merge_hris_client/models/bank_info.rb +15 -5
  51. data/lib/merge_hris_client/models/benefit.rb +15 -5
  52. data/lib/merge_hris_client/models/categories_enum.rb +2 -1
  53. data/lib/merge_hris_client/models/category_enum.rb +2 -1
  54. data/lib/merge_hris_client/models/company.rb +16 -6
  55. data/lib/merge_hris_client/models/country_enum.rb +0 -1
  56. data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
  57. data/lib/merge_hris_client/models/deduction.rb +15 -5
  58. data/lib/merge_hris_client/models/earning.rb +18 -5
  59. data/lib/merge_hris_client/models/earning_type_enum.rb +0 -1
  60. data/lib/merge_hris_client/models/employee.rb +15 -6
  61. data/lib/merge_hris_client/models/employee_payroll_run.rb +15 -5
  62. data/lib/merge_hris_client/models/employee_request.rb +1 -1
  63. data/lib/merge_hris_client/models/employment.rb +26 -6
  64. data/lib/merge_hris_client/models/employment_status_enum.rb +0 -1
  65. data/lib/merge_hris_client/models/employment_type_enum.rb +0 -1
  66. data/lib/merge_hris_client/models/encoding_enum.rb +0 -1
  67. data/lib/merge_hris_client/models/end_user_details_request.rb +34 -0
  68. data/lib/merge_hris_client/models/ethnicity_enum.rb +0 -1
  69. data/lib/merge_hris_client/models/flsa_status_enum.rb +0 -1
  70. data/lib/merge_hris_client/models/gender_enum.rb +0 -1
  71. data/lib/merge_hris_client/models/group.rb +16 -6
  72. data/lib/merge_hris_client/models/group_type_enum.rb +0 -1
  73. data/lib/merge_hris_client/models/issue_status_enum.rb +0 -1
  74. data/lib/merge_hris_client/models/{data_passthrough.rb → linked_account_status.rb} +24 -49
  75. data/lib/merge_hris_client/models/location.rb +16 -6
  76. data/lib/merge_hris_client/models/location_type_enum.rb +0 -1
  77. data/lib/merge_hris_client/models/marital_status_enum.rb +0 -1
  78. data/lib/merge_hris_client/models/meta_response.rb +262 -0
  79. data/lib/merge_hris_client/models/method_enum.rb +0 -1
  80. data/lib/merge_hris_client/models/pay_currency_enum.rb +0 -1
  81. data/lib/merge_hris_client/models/pay_frequency_enum.rb +0 -1
  82. data/lib/merge_hris_client/models/pay_group.rb +15 -5
  83. data/lib/merge_hris_client/models/pay_period_enum.rb +0 -1
  84. data/lib/merge_hris_client/models/payroll_run.rb +16 -6
  85. data/lib/merge_hris_client/models/policy_type_enum.rb +0 -1
  86. data/lib/merge_hris_client/models/reason_enum.rb +0 -1
  87. data/lib/merge_hris_client/models/request_format_enum.rb +0 -1
  88. data/lib/merge_hris_client/models/request_type_enum.rb +0 -1
  89. data/lib/merge_hris_client/models/run_state_enum.rb +0 -1
  90. data/lib/merge_hris_client/models/run_type_enum.rb +0 -1
  91. data/lib/merge_hris_client/models/sync_status_status_enum.rb +0 -1
  92. data/lib/merge_hris_client/models/tax.rb +18 -5
  93. data/lib/merge_hris_client/models/team.rb +15 -5
  94. data/lib/merge_hris_client/models/time_off.rb +14 -5
  95. data/lib/merge_hris_client/models/time_off_balance.rb +16 -6
  96. data/lib/merge_hris_client/models/time_off_status_enum.rb +0 -1
  97. data/lib/merge_hris_client/models/units_enum.rb +0 -1
  98. data/lib/merge_hris_client/models/{remote_key_for_regeneration.rb → webhook_receiver.rb} +38 -16
  99. data/lib/merge_hris_client/models/{end_user_details.rb → webhook_receiver_request.rb} +60 -69
  100. data/lib/merge_hris_client/version.rb +1 -1
  101. data/lib/merge_hris_client.rb +5 -0
  102. data/spec/api/account_details_api_spec.rb +1 -0
  103. data/spec/api/employees_api_spec.rb +16 -0
  104. data/spec/api/force_resync_api_spec.rb +1 -1
  105. data/spec/api/issues_api_spec.rb +4 -0
  106. data/spec/api/linked_accounts_api_spec.rb +7 -7
  107. data/spec/api/time_off_api_spec.rb +11 -0
  108. data/spec/api/webhook_receivers_api_spec.rb +58 -0
  109. data/spec/models/account_details_and_actions_spec.rb +6 -0
  110. data/spec/models/account_details_spec.rb +12 -0
  111. data/spec/models/bank_info_spec.rb +6 -0
  112. data/spec/models/benefit_spec.rb +6 -0
  113. data/spec/models/company_spec.rb +6 -0
  114. data/spec/models/deduction_spec.rb +6 -0
  115. data/spec/models/earning_spec.rb +6 -0
  116. data/spec/models/employee_payroll_run_spec.rb +6 -0
  117. data/spec/models/employee_spec.rb +6 -0
  118. data/spec/models/employment_spec.rb +12 -0
  119. data/spec/models/group_spec.rb +6 -0
  120. data/spec/models/linked_account_status_spec.rb +40 -0
  121. data/spec/models/location_spec.rb +6 -0
  122. data/spec/models/meta_response_spec.rb +52 -0
  123. data/spec/models/pay_group_spec.rb +6 -0
  124. data/spec/models/payroll_run_spec.rb +6 -0
  125. data/spec/models/tax_spec.rb +6 -0
  126. data/spec/models/team_spec.rb +6 -0
  127. data/spec/models/time_off_balance_spec.rb +6 -0
  128. data/spec/models/time_off_spec.rb +6 -0
  129. data/spec/models/webhook_receiver_request_spec.rb +46 -0
  130. data/spec/models/webhook_receiver_spec.rb +46 -0
  131. metadata +118 -112
  132. data/docs/BenefitPlanTypeEnum.md +0 -15
  133. data/docs/TypeEnum.md +0 -15
  134. data/lib/merge_hris_client/api/time_off_balance_api.rb +0 -196
  135. data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +0 -56
  136. data/lib/merge_hris_client/models/state_enum.rb +0 -93
  137. data/lib/merge_hris_client/models/type_enum.rb +0 -38
  138. data/spec/models/benefit_plan_type_enum_spec.rb +0 -28
  139. data/spec/models/type_enum_spec.rb +0 -28
  140. data/test_ruby.rb +0 -30
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
9
9
 
10
10
  ## sync_status_resync_create
11
11
 
12
- > <SyncStatus> sync_status_resync_create(x_account_token)
12
+ > <Array<SyncStatus>> sync_status_resync_create(x_account_token)
13
13
 
14
14
 
15
15
 
@@ -44,7 +44,7 @@ end
44
44
 
45
45
  This returns an Array which contains the response data, status code and headers.
46
46
 
47
- > <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
47
+ > <Array(<Array<SyncStatus>>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
48
48
 
49
49
  ```ruby
50
50
  begin
@@ -52,7 +52,7 @@ begin
52
52
  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
53
53
  p status_code # => 2xx
54
54
  p headers # => { ... }
55
- p data # => <SyncStatus>
55
+ p data # => <Array<SyncStatus>>
56
56
  rescue MergeHRISClient::ApiError => e
57
57
  puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
58
58
  end
@@ -66,7 +66,7 @@ end
66
66
 
67
67
  ### Return type
68
68
 
69
- [**SyncStatus**](SyncStatus.md)
69
+ [**Array&lt;SyncStatus&gt;**](SyncStatus.md)
70
70
 
71
71
  ### Authorization
72
72
 
data/docs/Group.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | **name** | **String** | The group name. | [optional] |
11
11
  | **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The group type | [optional] |
12
12
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
13
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = MergeHRISClient::Group.new(
22
23
  parent_group: 2ef51b11-2c4e-4b02-8d1d-50592d9e96ef,
23
24
  name: COST_CENTER_US,
24
25
  type: COST_CENTER,
25
- remote_data: [{&quot;path&quot;:&quot;/group&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
26
+ remote_data: [{&quot;path&quot;:&quot;/group&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
27
+ remote_was_deleted: null
26
28
  )
27
29
  ```
28
30
 
data/docs/IssuesApi.md CHANGED
@@ -35,8 +35,12 @@ opts = {
35
35
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
36
36
  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
37
37
  end_user_organization_name: 'end_user_organization_name_example', # String |
38
+ first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
39
+ first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
38
40
  include_muted: 'include_muted_example', # String | If True, will include muted issues
39
41
  integration_name: 'integration_name_example', # String |
42
+ last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
43
+ last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
40
44
  page_size: 56, # Integer | Number of results to return per page.
41
45
  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
42
46
  status: 'ONGOING' # String |
@@ -77,8 +81,12 @@ end
77
81
  | **cursor** | **String** | The pagination cursor value. | [optional] |
78
82
  | **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
79
83
  | **end_user_organization_name** | **String** | | [optional] |
84
+ | **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
85
+ | **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
80
86
  | **include_muted** | **String** | If True, will include muted issues | [optional] |
81
87
  | **integration_name** | **String** | | [optional] |
88
+ | **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
89
+ | **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
82
90
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
83
91
  | **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
84
92
  | **status** | **String** | | [optional] |
data/docs/LinkTokenApi.md CHANGED
@@ -29,7 +29,7 @@ MergeHRISClient.configure do |config|
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'}) # 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', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest |
33
33
 
34
34
  begin
35
35
 
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::LinkedAccountStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **linked_account_status** | **String** | | |
8
+ | **can_make_request** | **Boolean** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::LinkedAccountStatus.new(
16
+ linked_account_status: null,
17
+ can_make_request: null
18
+ )
19
+ ```
20
+
@@ -32,14 +32,14 @@ api_instance = MergeHRISClient::LinkedAccountsApi.new
32
32
  opts = {
33
33
  category: 'accounting', # String |
34
34
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
35
- end_user_email_address: 'end_user_email_address_example', # String |
36
- end_user_organization_name: 'end_user_organization_name_example', # String |
37
- end_user_origin_id: 'end_user_origin_id_example', # String |
38
- end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once
35
+ end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
36
+ end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
37
+ end_user_origin_id: 'end_user_origin_id_example', # String | If provided, will only return linked accounts associated with the given origin ID.
38
+ end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
39
39
  id: TODO, # String |
40
- ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once
41
- integration_name: 'integration_name_example', # String |
42
- is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts
40
+ ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
41
+ integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
42
+ is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
43
43
  page_size: 56, # Integer | Number of results to return per page.
44
44
  status: 'status_example' # String | Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
45
45
  }
@@ -77,14 +77,14 @@ end
77
77
  | ---- | ---- | ----------- | ----- |
78
78
  | **category** | **String** | | [optional] |
79
79
  | **cursor** | **String** | The pagination cursor value. | [optional] |
80
- | **end_user_email_address** | **String** | | [optional] |
81
- | **end_user_organization_name** | **String** | | [optional] |
82
- | **end_user_origin_id** | **String** | | [optional] |
83
- | **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once | [optional] |
80
+ | **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
81
+ | **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
82
+ | **end_user_origin_id** | **String** | If provided, will only return linked accounts associated with the given origin ID. | [optional] |
83
+ | **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
84
84
  | **id** | [**String**](.md) | | [optional] |
85
- | **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once | [optional] |
86
- | **integration_name** | **String** | | [optional] |
87
- | **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts | [optional] |
85
+ | **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
86
+ | **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
87
+ | **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
88
88
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
89
89
  | **status** | **String** | Filter by status. Options: &#x60;COMPLETE&#x60;, &#x60;INCOMPLETE&#x60;, &#x60;RELINK_NEEDED&#x60; | [optional] |
90
90
 
data/docs/Location.md CHANGED
@@ -12,10 +12,11 @@
12
12
  | **street_2** | **String** | Line 2 of the location&#39;s street address. | [optional] |
13
13
  | **city** | **String** | The location&#39;s city. | [optional] |
14
14
  | **state** | **String** | The location&#39;s state. Represents a region if outside of the US. | [optional] |
15
- | **zip_code** | **String** | The location&#39;s zip code. | [optional] |
15
+ | **zip_code** | **String** | The location&#39;s zip code or postal code. | [optional] |
16
16
  | **country** | [**CountryEnum**](CountryEnum.md) | The location&#39;s country. | [optional] |
17
17
  | **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location&#39;s type. Can be either WORK or HOME | [optional] |
18
18
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
19
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
19
20
 
20
21
  ## Example
21
22
 
@@ -23,7 +24,7 @@
23
24
  require 'merge_hris_client'
24
25
 
25
26
  instance = MergeHRISClient::Location.new(
26
- id: null,
27
+ id: f5e6a151-f44e-449a-afb1-8fd781905958,
27
28
  remote_id: 93018402,
28
29
  name: NYC Office,
29
30
  phone_number: +1111111111,
@@ -34,7 +35,8 @@ instance = MergeHRISClient::Location.new(
34
35
  zip_code: 10027,
35
36
  country: USA,
36
37
  location_type: WORK,
37
- remote_data: [{&quot;path&quot;:&quot;/locations&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
38
+ remote_data: [{&quot;path&quot;:&quot;/locations&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
39
+ remote_was_deleted: null
38
40
  )
39
41
  ```
40
42
 
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::MetaResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_schema** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | |
8
+ | **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
9
+ | **has_conditional_params** | **Boolean** | | |
10
+ | **has_required_linked_account_params** | **Boolean** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::MetaResponse.new(
18
+ request_schema: null,
19
+ status: null,
20
+ has_conditional_params: null,
21
+ has_required_linked_account_params: null
22
+ )
23
+ ```
24
+
data/docs/PayGroup.md CHANGED
@@ -8,6 +8,7 @@
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
9
  | **pay_group_name** | **String** | The pay group name. | [optional] |
10
10
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
11
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = MergeHRISClient::PayGroup.new(
18
19
  id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
19
20
  remote_id: 800293,
20
21
  pay_group_name: contractor,
21
- remote_data: [{&quot;path&quot;:&quot;/pay-group&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
22
+ remote_data: [{&quot;path&quot;:&quot;/pay-group&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
23
+ remote_was_deleted: null
22
24
  )
23
25
  ```
24
26
 
data/docs/PayrollRun.md CHANGED
@@ -12,6 +12,7 @@
12
12
  | **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
13
13
  | **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
14
14
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
15
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
15
16
 
16
17
  ## Example
17
18
 
@@ -26,7 +27,8 @@ instance = MergeHRISClient::PayrollRun.new(
26
27
  start_date: 2020-11-08T00:00Z,
27
28
  end_date: 2020-11-15T00:00Z,
28
29
  check_date: 2020-11-15T00:00Z,
29
- remote_data: [{&quot;path&quot;:&quot;/payroll&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
30
+ remote_data: [{&quot;path&quot;:&quot;/payroll&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
31
+ remote_was_deleted: null
30
32
  )
31
33
  ```
32
34
 
data/docs/Tax.md CHANGED
@@ -9,7 +9,8 @@
9
9
  | **name** | **String** | The tax&#39;s name. | [optional] |
10
10
  | **amount** | **Float** | The tax amount. | [optional] |
11
11
  | **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
12
- | **remote_data** | **String** | | [optional][readonly] |
12
+ | **remote_data** | **Array&lt;Hash&lt;String, AnyType&gt;&gt;** | | [optional] |
13
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = MergeHRISClient::Tax.new(
22
23
  name: California State Income Tax,
23
24
  amount: 100.25,
24
25
  employer_tax: false,
25
- remote_data: [{&quot;path&quot;:&quot;/tax&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
26
+ remote_data: [{&quot;path&quot;:&quot;/tax&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
27
+ remote_was_deleted: null
26
28
  )
27
29
  ```
28
30
 
data/docs/Team.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | **name** | **String** | The team&#39;s name. | [optional] |
10
10
  | **parent_team** | **String** | | [optional] |
11
11
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
12
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
12
13
 
13
14
  ## Example
14
15
 
@@ -20,7 +21,8 @@ instance = MergeHRISClient::Team.new(
20
21
  remote_id: 19202938,
21
22
  name: Engineering,
22
23
  parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
23
- remote_data: [{&quot;path&quot;:&quot;/teams&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
24
+ remote_data: [{&quot;path&quot;:&quot;/teams&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
25
+ remote_was_deleted: null
24
26
  )
25
27
  ```
26
28
 
data/docs/TimeOff.md CHANGED
@@ -16,6 +16,7 @@
16
16
  | **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
17
17
  | **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
18
18
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
19
+ | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
19
20
 
20
21
  ## Example
21
22
 
@@ -28,13 +29,14 @@ instance = MergeHRISClient::TimeOff.new(
28
29
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
29
30
  approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
30
31
  status: APPROVED,
31
- employee_note: Trip to Iowa. Miss those cornfields!,
32
+ employee_note: Moving into the new apartment Kendall Roy gave me!,
32
33
  units: DAYS,
33
- amount: 7,
34
+ amount: 3,
34
35
  request_type: VACATION,
35
36
  start_time: 2020-11-10T00:00Z,
36
37
  end_time: 2020-11-17T00:00Z,
37
- remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
38
+ remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
39
+ remote_was_deleted: null
38
40
  )
39
41
  ```
40
42
 
data/docs/TimeOffApi.md CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**time_off_create**](TimeOffApi.md#time_off_create) | **POST** /time-off | |
8
8
  | [**time_off_list**](TimeOffApi.md#time_off_list) | **GET** /time-off | |
9
+ | [**time_off_meta_post_retrieve**](TimeOffApi.md#time_off_meta_post_retrieve) | **GET** /time-off/meta/post | |
9
10
  | [**time_off_retrieve**](TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} | |
10
11
 
11
12
 
@@ -189,6 +190,77 @@ end
189
190
  - **Accept**: application/json
190
191
 
191
192
 
193
+ ## time_off_meta_post_retrieve
194
+
195
+ > <MetaResponse> time_off_meta_post_retrieve(x_account_token)
196
+
197
+
198
+
199
+ Returns metadata for `TimeOff` POSTs.
200
+
201
+ ### Examples
202
+
203
+ ```ruby
204
+ require 'time'
205
+ require 'merge_hris_client'
206
+ # setup authorization
207
+ MergeHRISClient.configure do |config|
208
+ # Configure API key authorization: tokenAuth
209
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
210
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
211
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
212
+ end
213
+
214
+ api_instance = MergeHRISClient::TimeOffApi.new
215
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
216
+
217
+ begin
218
+
219
+ result = api_instance.time_off_meta_post_retrieve(x_account_token)
220
+ p result
221
+ rescue MergeHRISClient::ApiError => e
222
+ puts "Error when calling TimeOffApi->time_off_meta_post_retrieve: #{e}"
223
+ end
224
+ ```
225
+
226
+ #### Using the time_off_meta_post_retrieve_with_http_info variant
227
+
228
+ This returns an Array which contains the response data, status code and headers.
229
+
230
+ > <Array(<MetaResponse>, Integer, Hash)> time_off_meta_post_retrieve_with_http_info(x_account_token)
231
+
232
+ ```ruby
233
+ begin
234
+
235
+ data, status_code, headers = api_instance.time_off_meta_post_retrieve_with_http_info(x_account_token)
236
+ p status_code # => 2xx
237
+ p headers # => { ... }
238
+ p data # => <MetaResponse>
239
+ rescue MergeHRISClient::ApiError => e
240
+ puts "Error when calling TimeOffApi->time_off_meta_post_retrieve_with_http_info: #{e}"
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ | Name | Type | Description | Notes |
247
+ | ---- | ---- | ----------- | ----- |
248
+ | **x_account_token** | **String** | Token identifying the end user. | |
249
+
250
+ ### Return type
251
+
252
+ [**MetaResponse**](MetaResponse.md)
253
+
254
+ ### Authorization
255
+
256
+ [tokenAuth](../README.md#tokenAuth)
257
+
258
+ ### HTTP request headers
259
+
260
+ - **Content-Type**: Not defined
261
+ - **Accept**: application/json
262
+
263
+
192
264
  ## time_off_retrieve
193
265
 
194
266
  > <TimeOff> time_off_retrieve(x_account_token, id, opts)
@@ -7,10 +7,11 @@
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
9
  | **employee** | **String** | | [optional] |
10
- | **balance** | **Float** | The current PTO balance in terms of hours. | [optional] |
10
+ | **balance** | **Float** | The current remaining PTO balance in terms of hours. This does not represent the starting PTO balance. If the API provider only provides PTO balance in terms of days, we estimate 8 hours per day. | [optional] |
11
11
  | **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
12
12
  | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
13
13
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
14
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
14
15
 
15
16
  ## Example
16
17
 
@@ -24,7 +25,8 @@ instance = MergeHRISClient::TimeOffBalance.new(
24
25
  balance: 60.0,
25
26
  used: 45.0,
26
27
  policy_type: VACATION,
27
- remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
28
+ remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
29
+ remote_was_deleted: null
28
30
  )
29
31
  ```
30
32
 
@@ -25,9 +25,9 @@ instance = MergeHRISClient::TimeOffRequest.new(
25
25
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
26
26
  approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
27
27
  status: APPROVED,
28
- employee_note: Trip to Iowa. Miss those cornfields!,
28
+ employee_note: Moving into the new apartment Kendall Roy gave me!,
29
29
  units: DAYS,
30
- amount: 7,
30
+ amount: 3,
31
31
  request_type: VACATION,
32
32
  start_time: 2020-11-10T00:00Z,
33
33
  end_time: 2020-11-17T00:00Z
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::WebhookReceiver
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **event** | **String** | | |
8
+ | **is_active** | **Boolean** | | |
9
+ | **key** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::WebhookReceiver.new(
17
+ event: null,
18
+ is_active: null,
19
+ key: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::WebhookReceiverRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **event** | **String** | | |
8
+ | **is_active** | **Boolean** | | |
9
+ | **key** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::WebhookReceiverRequest.new(
17
+ event: null,
18
+ is_active: null,
19
+ key: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,153 @@
1
+ # MergeHRISClient::WebhookReceiversApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**webhook_receivers_create**](WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers | |
8
+ | [**webhook_receivers_list**](WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers | |
9
+
10
+
11
+ ## webhook_receivers_create
12
+
13
+ > <WebhookReceiver> webhook_receivers_create(x_account_token, webhook_receiver_request)
14
+
15
+
16
+
17
+ Creates a `WebhookReceiver` object with the given values.
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::WebhookReceiversApi.new
33
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
34
+ webhook_receiver_request = MergeHRISClient::WebhookReceiverRequest.new({event: 'event_example', is_active: false}) # WebhookReceiverRequest |
35
+
36
+ begin
37
+
38
+ result = api_instance.webhook_receivers_create(x_account_token, webhook_receiver_request)
39
+ p result
40
+ rescue MergeHRISClient::ApiError => e
41
+ puts "Error when calling WebhookReceiversApi->webhook_receivers_create: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the webhook_receivers_create_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<WebhookReceiver>, Integer, Hash)> webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request)
50
+
51
+ ```ruby
52
+ begin
53
+
54
+ data, status_code, headers = api_instance.webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <WebhookReceiver>
58
+ rescue MergeHRISClient::ApiError => e
59
+ puts "Error when calling WebhookReceiversApi->webhook_receivers_create_with_http_info: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **x_account_token** | **String** | Token identifying the end user. | |
68
+ | **webhook_receiver_request** | [**WebhookReceiverRequest**](WebhookReceiverRequest.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**WebhookReceiver**](WebhookReceiver.md)
73
+
74
+ ### Authorization
75
+
76
+ [tokenAuth](../README.md#tokenAuth)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## webhook_receivers_list
85
+
86
+ > <Array<WebhookReceiver>> webhook_receivers_list(x_account_token)
87
+
88
+
89
+
90
+ Returns a list of `WebhookReceiver` objects.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'merge_hris_client'
97
+ # setup authorization
98
+ MergeHRISClient.configure do |config|
99
+ # Configure API key authorization: tokenAuth
100
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
101
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
102
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
103
+ end
104
+
105
+ api_instance = MergeHRISClient::WebhookReceiversApi.new
106
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
107
+
108
+ begin
109
+
110
+ result = api_instance.webhook_receivers_list(x_account_token)
111
+ p result
112
+ rescue MergeHRISClient::ApiError => e
113
+ puts "Error when calling WebhookReceiversApi->webhook_receivers_list: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the webhook_receivers_list_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<Array<WebhookReceiver>>, Integer, Hash)> webhook_receivers_list_with_http_info(x_account_token)
122
+
123
+ ```ruby
124
+ begin
125
+
126
+ data, status_code, headers = api_instance.webhook_receivers_list_with_http_info(x_account_token)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <Array<WebhookReceiver>>
130
+ rescue MergeHRISClient::ApiError => e
131
+ puts "Error when calling WebhookReceiversApi->webhook_receivers_list_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **x_account_token** | **String** | Token identifying the end user. | |
140
+
141
+ ### Return type
142
+
143
+ [**Array&lt;WebhookReceiver&gt;**](WebhookReceiver.md)
144
+
145
+ ### Authorization
146
+
147
+ [tokenAuth](../README.md#tokenAuth)
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+