merge_hris_client 2.0.3 → 2.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (97) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/docs/BankInfo.md +1 -1
  4. data/docs/BankInfoApi.md +7 -3
  5. data/docs/Benefit.md +1 -1
  6. data/docs/BenefitsApi.md +2 -2
  7. data/docs/CompaniesApi.md +2 -2
  8. data/docs/Company.md +1 -1
  9. data/docs/DataPassthroughRequest.md +3 -1
  10. data/docs/Deduction.md +1 -1
  11. data/docs/DeductionsApi.md +2 -2
  12. data/docs/Earning.md +1 -1
  13. data/docs/EmployeePayrollRun.md +1 -1
  14. data/docs/EmployeePayrollRunsApi.md +2 -2
  15. data/docs/EmployeesApi.md +7 -3
  16. data/docs/Employment.md +1 -1
  17. data/docs/EmploymentsApi.md +7 -3
  18. data/docs/Group.md +1 -1
  19. data/docs/GroupsApi.md +7 -3
  20. data/docs/Location.md +1 -1
  21. data/docs/LocationsApi.md +7 -3
  22. data/docs/PayGroup.md +1 -1
  23. data/docs/PayGroupsApi.md +2 -2
  24. data/docs/PayrollRun.md +1 -1
  25. data/docs/PayrollRunsApi.md +7 -3
  26. data/docs/RemoteResponse.md +2 -0
  27. data/docs/Tax.md +1 -1
  28. data/docs/Team.md +1 -1
  29. data/docs/TeamsApi.md +2 -2
  30. data/docs/TimeOffApi.md +7 -3
  31. data/docs/TimeOffBalance.md +1 -1
  32. data/docs/TimeOffBalancesApi.md +7 -3
  33. data/lib/merge_hris_client/api/bank_info_api.rb +16 -2
  34. data/lib/merge_hris_client/api/benefits_api.rb +2 -2
  35. data/lib/merge_hris_client/api/companies_api.rb +2 -2
  36. data/lib/merge_hris_client/api/deductions_api.rb +2 -2
  37. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +2 -2
  38. data/lib/merge_hris_client/api/employees_api.rb +16 -2
  39. data/lib/merge_hris_client/api/employments_api.rb +16 -2
  40. data/lib/merge_hris_client/api/groups_api.rb +16 -2
  41. data/lib/merge_hris_client/api/locations_api.rb +16 -2
  42. data/lib/merge_hris_client/api/pay_groups_api.rb +2 -2
  43. data/lib/merge_hris_client/api/payroll_runs_api.rb +16 -2
  44. data/lib/merge_hris_client/api/teams_api.rb +2 -2
  45. data/lib/merge_hris_client/api/time_off_api.rb +16 -2
  46. data/lib/merge_hris_client/api/time_off_balances_api.rb +16 -2
  47. data/lib/merge_hris_client/models/bank_info.rb +1 -1
  48. data/lib/merge_hris_client/models/benefit.rb +1 -1
  49. data/lib/merge_hris_client/models/company.rb +1 -1
  50. data/lib/merge_hris_client/models/data_passthrough_request.rb +14 -5
  51. data/lib/merge_hris_client/models/deduction.rb +1 -1
  52. data/lib/merge_hris_client/models/earning.rb +1 -1
  53. data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -1
  54. data/lib/merge_hris_client/models/employment.rb +1 -1
  55. data/lib/merge_hris_client/models/encoding_enum.rb +1 -0
  56. data/lib/merge_hris_client/models/group.rb +1 -1
  57. data/lib/merge_hris_client/models/location.rb +1 -1
  58. data/lib/merge_hris_client/models/pay_group.rb +1 -1
  59. data/lib/merge_hris_client/models/payroll_run.rb +1 -1
  60. data/lib/merge_hris_client/models/remote_response.rb +13 -2
  61. data/lib/merge_hris_client/models/tax.rb +1 -1
  62. data/lib/merge_hris_client/models/team.rb +1 -1
  63. data/lib/merge_hris_client/models/time_off_balance.rb +1 -1
  64. data/lib/merge_hris_client/version.rb +1 -1
  65. data/spec/api/bank_info_api_spec.rb +3 -1
  66. data/spec/api/benefits_api_spec.rb +1 -1
  67. data/spec/api/companies_api_spec.rb +1 -1
  68. data/spec/api/deductions_api_spec.rb +1 -1
  69. data/spec/api/employee_payroll_runs_api_spec.rb +1 -1
  70. data/spec/api/employees_api_spec.rb +3 -1
  71. data/spec/api/employments_api_spec.rb +3 -1
  72. data/spec/api/groups_api_spec.rb +3 -1
  73. data/spec/api/locations_api_spec.rb +3 -1
  74. data/spec/api/pay_groups_api_spec.rb +1 -1
  75. data/spec/api/payroll_runs_api_spec.rb +3 -1
  76. data/spec/api/teams_api_spec.rb +1 -1
  77. data/spec/api/time_off_api_spec.rb +3 -1
  78. data/spec/api/time_off_balances_api_spec.rb +3 -1
  79. data/spec/models/bank_info_spec.rb +0 -6
  80. data/spec/models/benefit_spec.rb +0 -6
  81. data/spec/models/company_spec.rb +0 -6
  82. data/spec/models/data_passthrough_request_spec.rb +6 -0
  83. data/spec/models/deduction_spec.rb +0 -6
  84. data/spec/models/earning_spec.rb +0 -6
  85. data/spec/models/employee_payroll_run_spec.rb +0 -6
  86. data/spec/models/employee_spec.rb +0 -6
  87. data/spec/models/employment_spec.rb +0 -6
  88. data/spec/models/group_spec.rb +0 -6
  89. data/spec/models/location_spec.rb +0 -6
  90. data/spec/models/pay_group_spec.rb +0 -6
  91. data/spec/models/payroll_run_spec.rb +0 -6
  92. data/spec/models/remote_response_spec.rb +6 -0
  93. data/spec/models/tax_spec.rb +0 -6
  94. data/spec/models/team_spec.rb +0 -6
  95. data/spec/models/time_off_balance_spec.rb +0 -6
  96. data/spec/models/time_off_spec.rb +0 -6
  97. metadata +102 -102
@@ -25,11 +25,12 @@ module MergeHRISClient
25
25
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
28
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
30
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
31
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
33
34
  # @option opts [String] :remote_id The API provider's ID for the given object.
34
35
  # @return [PaginatedLocationList]
35
36
  def locations_list(x_account_token, opts = {})
@@ -43,11 +44,12 @@ module MergeHRISClient
43
44
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
45
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
46
  # @option opts [String] :cursor The pagination cursor value.
46
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
47
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
48
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
49
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
50
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
50
51
  # @option opts [Integer] :page_size Number of results to return per page.
52
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
51
53
  # @option opts [String] :remote_id The API provider's ID for the given object.
52
54
  # @return [Array<(PaginatedLocationList, Integer, Hash)>] PaginatedLocationList data, response status code and response headers
53
55
  def locations_list_with_http_info(x_account_token, opts = {})
@@ -58,6 +60,10 @@ module MergeHRISClient
58
60
  if @api_client.config.client_side_validation && x_account_token.nil?
59
61
  fail ArgumentError, "Missing the required parameter 'x_account_token' when calling LocationsApi.locations_list"
60
62
  end
63
+ allowable_values = ["location_type"]
64
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
65
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
66
+ end
61
67
  # resource path
62
68
  local_var_path = '/locations'
63
69
 
@@ -71,6 +77,7 @@ module MergeHRISClient
71
77
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
72
78
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
73
79
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
80
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
74
81
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
75
82
 
76
83
  # header parameters
@@ -113,6 +120,7 @@ module MergeHRISClient
113
120
  # @param id [String]
114
121
  # @param [Hash] opts the optional parameters
115
122
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
123
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
116
124
  # @return [Location]
117
125
  def locations_retrieve(x_account_token, id, opts = {})
118
126
  data, _status_code, _headers = locations_retrieve_with_http_info(x_account_token, id, opts)
@@ -124,6 +132,7 @@ module MergeHRISClient
124
132
  # @param id [String]
125
133
  # @param [Hash] opts the optional parameters
126
134
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
135
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
127
136
  # @return [Array<(Location, Integer, Hash)>] Location data, response status code and response headers
128
137
  def locations_retrieve_with_http_info(x_account_token, id, opts = {})
129
138
  if @api_client.config.debugging
@@ -137,12 +146,17 @@ module MergeHRISClient
137
146
  if @api_client.config.client_side_validation && id.nil?
138
147
  fail ArgumentError, "Missing the required parameter 'id' when calling LocationsApi.locations_retrieve"
139
148
  end
149
+ allowable_values = ["location_type"]
150
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
151
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
152
+ end
140
153
  # resource path
141
154
  local_var_path = '/locations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
142
155
 
143
156
  # query parameters
144
157
  query_params = opts[:query_params] || {}
145
158
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
159
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
146
160
 
147
161
  # header parameters
148
162
  header_params = opts[:header_params] || {}
@@ -25,7 +25,7 @@ module MergeHRISClient
25
25
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
28
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
30
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
31
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -43,7 +43,7 @@ module MergeHRISClient
43
43
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
44
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
45
  # @option opts [String] :cursor The pagination cursor value.
46
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
46
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
47
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
48
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
49
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -27,11 +27,12 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [Time] :ended_after If provided, will only return payroll runs ended after this datetime.
29
29
  # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
30
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
30
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
31
31
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
32
32
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
33
33
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
35
36
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
36
37
  # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;)
37
38
  # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
@@ -50,11 +51,12 @@ module MergeHRISClient
50
51
  # @option opts [String] :cursor The pagination cursor value.
51
52
  # @option opts [Time] :ended_after If provided, will only return payroll runs ended after this datetime.
52
53
  # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
53
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
54
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
54
55
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
55
56
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
56
57
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
57
58
  # @option opts [Integer] :page_size Number of results to return per page.
59
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
58
60
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
59
61
  # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;)
60
62
  # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
@@ -68,6 +70,10 @@ module MergeHRISClient
68
70
  if @api_client.config.client_side_validation && x_account_token.nil?
69
71
  fail ArgumentError, "Missing the required parameter 'x_account_token' when calling PayrollRunsApi.payroll_runs_list"
70
72
  end
73
+ allowable_values = ["run_state", "run_state,run_type", "run_type"]
74
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
75
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
76
+ end
71
77
  allowable_values = ["CORRECTION", "OFF_CYCLE", "REGULAR", "SIGN_ON_BONUS", "TERMINATION"]
72
78
  if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
73
79
  fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
@@ -87,6 +93,7 @@ module MergeHRISClient
87
93
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
88
94
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
89
95
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
96
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
90
97
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
91
98
  query_params[:'run_type'] = opts[:'run_type'] if !opts[:'run_type'].nil?
92
99
  query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
@@ -132,6 +139,7 @@ module MergeHRISClient
132
139
  # @param id [String]
133
140
  # @param [Hash] opts the optional parameters
134
141
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
142
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
135
143
  # @return [PayrollRun]
136
144
  def payroll_runs_retrieve(x_account_token, id, opts = {})
137
145
  data, _status_code, _headers = payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
@@ -143,6 +151,7 @@ module MergeHRISClient
143
151
  # @param id [String]
144
152
  # @param [Hash] opts the optional parameters
145
153
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
154
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
146
155
  # @return [Array<(PayrollRun, Integer, Hash)>] PayrollRun data, response status code and response headers
147
156
  def payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {})
148
157
  if @api_client.config.debugging
@@ -156,12 +165,17 @@ module MergeHRISClient
156
165
  if @api_client.config.client_side_validation && id.nil?
157
166
  fail ArgumentError, "Missing the required parameter 'id' when calling PayrollRunsApi.payroll_runs_retrieve"
158
167
  end
168
+ allowable_values = ["run_state", "run_state,run_type", "run_type"]
169
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
170
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
171
+ end
159
172
  # resource path
160
173
  local_var_path = '/payroll-runs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
161
174
 
162
175
  # query parameters
163
176
  query_params = opts[:query_params] || {}
164
177
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
178
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
165
179
 
166
180
  # header parameters
167
181
  header_params = opts[:header_params] || {}
@@ -26,7 +26,7 @@ module MergeHRISClient
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
29
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
29
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
30
30
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
31
31
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
32
32
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -46,7 +46,7 @@ module MergeHRISClient
46
46
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
47
47
  # @option opts [String] :cursor The pagination cursor value.
48
48
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
49
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
49
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
50
50
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
51
51
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
52
52
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -104,11 +104,12 @@ module MergeHRISClient
104
104
  # @option opts [String] :cursor The pagination cursor value.
105
105
  # @option opts [String] :employee_id If provided, will only return time off for this employee.
106
106
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
107
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
107
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
108
108
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
109
109
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
110
110
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
111
111
  # @option opts [Integer] :page_size Number of results to return per page.
112
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
112
113
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
113
114
  # @option opts [String] :request_type If provided, will only return TimeOff with this request type. Options: (&#39;VACATION&#39;, &#39;SICK&#39;, &#39;PERSONAL&#39;, &#39;JURY_DUTY&#39;, &#39;VOLUNTEER&#39;, &#39;BEREAVEMENT&#39;)
114
115
  # @option opts [String] :status If provided, will only return TimeOff with this status. Options: (&#39;REQUESTED&#39;, &#39;APPROVED&#39;, &#39;DECLINED&#39;, &#39;CANCELLED&#39;, &#39;DELETED&#39;)
@@ -127,11 +128,12 @@ module MergeHRISClient
127
128
  # @option opts [String] :cursor The pagination cursor value.
128
129
  # @option opts [String] :employee_id If provided, will only return time off for this employee.
129
130
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
130
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
131
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
131
132
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
132
133
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
133
134
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
134
135
  # @option opts [Integer] :page_size Number of results to return per page.
136
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
135
137
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
136
138
  # @option opts [String] :request_type If provided, will only return TimeOff with this request type. Options: (&#39;VACATION&#39;, &#39;SICK&#39;, &#39;PERSONAL&#39;, &#39;JURY_DUTY&#39;, &#39;VOLUNTEER&#39;, &#39;BEREAVEMENT&#39;)
137
139
  # @option opts [String] :status If provided, will only return TimeOff with this status. Options: (&#39;REQUESTED&#39;, &#39;APPROVED&#39;, &#39;DECLINED&#39;, &#39;CANCELLED&#39;, &#39;DELETED&#39;)
@@ -148,6 +150,10 @@ module MergeHRISClient
148
150
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
149
151
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
150
152
  end
153
+ allowable_values = ["request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units"]
154
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
155
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
156
+ end
151
157
  allowable_values = ["BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER"]
152
158
  if @api_client.config.client_side_validation && opts[:'request_type'] && !allowable_values.include?(opts[:'request_type'])
153
159
  fail ArgumentError, "invalid value for \"request_type\", must be one of #{allowable_values}"
@@ -172,6 +178,7 @@ module MergeHRISClient
172
178
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
173
179
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
174
180
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
181
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
175
182
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
176
183
  query_params[:'request_type'] = opts[:'request_type'] if !opts[:'request_type'].nil?
177
184
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
@@ -279,6 +286,7 @@ module MergeHRISClient
279
286
  # @param [Hash] opts the optional parameters
280
287
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
281
288
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
289
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
282
290
  # @return [TimeOff]
283
291
  def time_off_retrieve(x_account_token, id, opts = {})
284
292
  data, _status_code, _headers = time_off_retrieve_with_http_info(x_account_token, id, opts)
@@ -291,6 +299,7 @@ module MergeHRISClient
291
299
  # @param [Hash] opts the optional parameters
292
300
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
293
301
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
302
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
294
303
  # @return [Array<(TimeOff, Integer, Hash)>] TimeOff data, response status code and response headers
295
304
  def time_off_retrieve_with_http_info(x_account_token, id, opts = {})
296
305
  if @api_client.config.debugging
@@ -308,6 +317,10 @@ module MergeHRISClient
308
317
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
309
318
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
310
319
  end
320
+ allowable_values = ["request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units"]
321
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
322
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
323
+ end
311
324
  # resource path
312
325
  local_var_path = '/time-off/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
313
326
 
@@ -315,6 +328,7 @@ module MergeHRISClient
315
328
  query_params = opts[:query_params] || {}
316
329
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
317
330
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
331
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
318
332
 
319
333
  # header parameters
320
334
  header_params = opts[:header_params] || {}
@@ -27,12 +27,13 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [String] :employee_id If provided, will only return time off balances for this employee.
29
29
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
30
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
30
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
31
31
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
32
32
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
33
33
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
35
  # @option opts [String] :policy_type If provided, will only return TimeOffBalance with this policy type. Options: (&#39;VACATION&#39;, &#39;SICK&#39;, &#39;PERSONAL&#39;, &#39;JURY_DUTY&#39;, &#39;VOLUNTEER&#39;, &#39;BEREAVEMENT&#39;)
36
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
36
37
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
37
38
  # @return [PaginatedTimeOffBalanceList]
38
39
  def time_off_balances_list(x_account_token, opts = {})
@@ -48,12 +49,13 @@ module MergeHRISClient
48
49
  # @option opts [String] :cursor The pagination cursor value.
49
50
  # @option opts [String] :employee_id If provided, will only return time off balances for this employee.
50
51
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
51
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
52
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
52
53
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
53
54
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
54
55
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
55
56
  # @option opts [Integer] :page_size Number of results to return per page.
56
57
  # @option opts [String] :policy_type If provided, will only return TimeOffBalance with this policy type. Options: (&#39;VACATION&#39;, &#39;SICK&#39;, &#39;PERSONAL&#39;, &#39;JURY_DUTY&#39;, &#39;VOLUNTEER&#39;, &#39;BEREAVEMENT&#39;)
58
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
57
59
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
58
60
  # @return [Array<(PaginatedTimeOffBalanceList, Integer, Hash)>] PaginatedTimeOffBalanceList data, response status code and response headers
59
61
  def time_off_balances_list_with_http_info(x_account_token, opts = {})
@@ -72,6 +74,10 @@ module MergeHRISClient
72
74
  if @api_client.config.client_side_validation && opts[:'policy_type'] && !allowable_values.include?(opts[:'policy_type'])
73
75
  fail ArgumentError, "invalid value for \"policy_type\", must be one of #{allowable_values}"
74
76
  end
77
+ allowable_values = ["policy_type"]
78
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
79
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
80
+ end
75
81
  # resource path
76
82
  local_var_path = '/time-off-balances'
77
83
 
@@ -88,6 +94,7 @@ module MergeHRISClient
88
94
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
89
95
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
90
96
  query_params[:'policy_type'] = opts[:'policy_type'] if !opts[:'policy_type'].nil?
97
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
91
98
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
92
99
 
93
100
  # header parameters
@@ -131,6 +138,7 @@ module MergeHRISClient
131
138
  # @param [Hash] opts the optional parameters
132
139
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
133
140
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
141
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
134
142
  # @return [TimeOffBalance]
135
143
  def time_off_balances_retrieve(x_account_token, id, opts = {})
136
144
  data, _status_code, _headers = time_off_balances_retrieve_with_http_info(x_account_token, id, opts)
@@ -143,6 +151,7 @@ module MergeHRISClient
143
151
  # @param [Hash] opts the optional parameters
144
152
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
145
153
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
154
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
146
155
  # @return [Array<(TimeOffBalance, Integer, Hash)>] TimeOffBalance data, response status code and response headers
147
156
  def time_off_balances_retrieve_with_http_info(x_account_token, id, opts = {})
148
157
  if @api_client.config.debugging
@@ -160,6 +169,10 @@ module MergeHRISClient
160
169
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
161
170
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
162
171
  end
172
+ allowable_values = ["policy_type"]
173
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
174
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
175
+ end
163
176
  # resource path
164
177
  local_var_path = '/time-off-balances/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
165
178
 
@@ -167,6 +180,7 @@ module MergeHRISClient
167
180
  query_params = opts[:query_params] || {}
168
181
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
169
182
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
183
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
170
184
 
171
185
  # header parameters
172
186
  header_params = opts[:header_params] || {}
@@ -40,7 +40,7 @@ module MergeHRISClient
40
40
 
41
41
  attr_accessor :remote_data
42
42
 
43
- # Indicates whether or not this object has been deleted on the third-party.
43
+ # Indicates whether or not this object has been deleted by third party webhooks.
44
44
  attr_accessor :remote_was_deleted
45
45
 
46
46
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -37,7 +37,7 @@ module MergeHRISClient
37
37
 
38
38
  attr_accessor :remote_data
39
39
 
40
- # Indicates whether or not this object has been deleted on the third-party.
40
+ # Indicates whether or not this object has been deleted by third party webhooks.
41
41
  attr_accessor :remote_was_deleted
42
42
 
43
43
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -32,7 +32,7 @@ module MergeHRISClient
32
32
 
33
33
  attr_accessor :remote_data
34
34
 
35
- # Indicates whether or not this object has been deleted on the third-party.
35
+ # Indicates whether or not this object has been deleted by third party webhooks.
36
36
  attr_accessor :remote_was_deleted
37
37
 
38
38
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -32,6 +32,8 @@ module MergeHRISClient
32
32
 
33
33
  attr_accessor :request_format
34
34
 
35
+ attr_accessor :normalize_response
36
+
35
37
  # Attribute mapping from ruby-style variable name to JSON key.
36
38
  def self.attribute_map
37
39
  {
@@ -41,7 +43,8 @@ module MergeHRISClient
41
43
  :'data' => :'data',
42
44
  :'multipart_form_data' => :'multipart_form_data',
43
45
  :'headers' => :'headers',
44
- :'request_format' => :'request_format'
46
+ :'request_format' => :'request_format',
47
+ :'normalize_response' => :'normalize_response'
45
48
  }
46
49
  end
47
50
 
@@ -59,7 +62,8 @@ module MergeHRISClient
59
62
  :'data' => :'String',
60
63
  :'multipart_form_data' => :'Array<MultipartFormFieldRequest>',
61
64
  :'headers' => :'Hash<String, AnyType>',
62
- :'request_format' => :'RequestFormatEnum'
65
+ :'request_format' => :'RequestFormatEnum',
66
+ :'normalize_response' => :'Boolean'
63
67
  }
64
68
  end
65
69
 
@@ -70,7 +74,7 @@ module MergeHRISClient
70
74
  :'data',
71
75
  :'multipart_form_data',
72
76
  :'headers',
73
- :'request_format'
77
+ :'request_format',
74
78
  ])
75
79
  end
76
80
 
@@ -120,6 +124,10 @@ module MergeHRISClient
120
124
  if attributes.key?(:'request_format')
121
125
  self.request_format = attributes[:'request_format']
122
126
  end
127
+
128
+ if attributes.key?(:'normalize_response')
129
+ self.normalize_response = attributes[:'normalize_response']
130
+ end
123
131
  end
124
132
 
125
133
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -205,7 +213,8 @@ module MergeHRISClient
205
213
  data == o.data &&
206
214
  multipart_form_data == o.multipart_form_data &&
207
215
  headers == o.headers &&
208
- request_format == o.request_format
216
+ request_format == o.request_format &&
217
+ normalize_response == o.normalize_response
209
218
  end
210
219
 
211
220
  # @see the `==` method
@@ -217,7 +226,7 @@ module MergeHRISClient
217
226
  # Calculates hash code according to all attributes.
218
227
  # @return [Integer] Hash code
219
228
  def hash
220
- [method, path, base_url_override, data, multipart_form_data, headers, request_format].hash
229
+ [method, path, base_url_override, data, multipart_form_data, headers, request_format, normalize_response].hash
221
230
  end
222
231
 
223
232
  # Builds the object from hash
@@ -31,7 +31,7 @@ module MergeHRISClient
31
31
 
32
32
  attr_accessor :remote_data
33
33
 
34
- # Indicates whether or not this object has been deleted on the third-party.
34
+ # Indicates whether or not this object has been deleted by third party webhooks.
35
35
  attr_accessor :remote_was_deleted
36
36
 
37
37
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,7 +28,7 @@ module MergeHRISClient
28
28
 
29
29
  attr_accessor :remote_data
30
30
 
31
- # Indicates whether or not this object has been deleted on the third-party.
31
+ # Indicates whether or not this object has been deleted by third party webhooks.
32
32
  attr_accessor :remote_was_deleted
33
33
 
34
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -48,7 +48,7 @@ module MergeHRISClient
48
48
 
49
49
  attr_accessor :remote_data
50
50
 
51
- # Indicates whether or not this object has been deleted on the third-party.
51
+ # Indicates whether or not this object has been deleted by third party webhooks.
52
52
  attr_accessor :remote_was_deleted
53
53
 
54
54
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -51,7 +51,7 @@ module MergeHRISClient
51
51
 
52
52
  attr_accessor :remote_data
53
53
 
54
- # Indicates whether or not this object has been deleted on the third-party.
54
+ # Indicates whether or not this object has been deleted by third party webhooks.
55
55
  attr_accessor :remote_was_deleted
56
56
 
57
57
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,6 +17,7 @@ module MergeHRISClient
17
17
  class EncodingEnum
18
18
  RAW = "RAW".freeze
19
19
  BASE64 = "BASE64".freeze
20
+ GZIP_BASE64 = "GZIP_BASE64".freeze
20
21
 
21
22
  # Builds the enum from string
22
23
  # @param [String] The enum value in the form of the string
@@ -32,7 +32,7 @@ module MergeHRISClient
32
32
 
33
33
  attr_accessor :remote_data
34
34
 
35
- # Indicates whether or not this object has been deleted on the third-party.
35
+ # Indicates whether or not this object has been deleted by third party webhooks.
36
36
  attr_accessor :remote_was_deleted
37
37
 
38
38
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,7 +50,7 @@ module MergeHRISClient
50
50
 
51
51
  attr_accessor :remote_data
52
52
 
53
- # Indicates whether or not this object has been deleted on the third-party.
53
+ # Indicates whether or not this object has been deleted by third party webhooks.
54
54
  attr_accessor :remote_was_deleted
55
55
 
56
56
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -26,7 +26,7 @@ module MergeHRISClient
26
26
 
27
27
  attr_accessor :remote_data
28
28
 
29
- # Indicates whether or not this object has been deleted on the third-party.
29
+ # Indicates whether or not this object has been deleted by third party webhooks.
30
30
  attr_accessor :remote_was_deleted
31
31
 
32
32
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,7 +38,7 @@ module MergeHRISClient
38
38
 
39
39
  attr_accessor :remote_data
40
40
 
41
- # Indicates whether or not this object has been deleted on the third-party.
41
+ # Indicates whether or not this object has been deleted by third party webhooks.
42
42
  attr_accessor :remote_was_deleted
43
43
 
44
44
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -24,6 +24,8 @@ module MergeHRISClient
24
24
 
25
25
  attr_accessor :response
26
26
 
27
+ attr_accessor :response_headers
28
+
27
29
  attr_accessor :headers
28
30
 
29
31
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,6 +35,7 @@ module MergeHRISClient
33
35
  :'path' => :'path',
34
36
  :'status' => :'status',
35
37
  :'response' => :'response',
38
+ :'response_headers' => :'response_headers',
36
39
  :'headers' => :'headers'
37
40
  }
38
41
  end
@@ -49,7 +52,8 @@ module MergeHRISClient
49
52
  :'path' => :'String',
50
53
  :'status' => :'Integer',
51
54
  :'response' => :'Hash<String, Object>',
52
- :'headers' => :'Hash<String, Object>'
55
+ :'response_headers' => :'Hash<String, Object>',
56
+ :'headers' => :'Hash<String, AnyType>'
53
57
  }
54
58
  end
55
59
 
@@ -92,6 +96,12 @@ module MergeHRISClient
92
96
  end
93
97
  end
94
98
 
99
+ if attributes.key?(:'response_headers')
100
+ if (value = attributes[:'response_headers']).is_a?(Hash)
101
+ self.response_headers = value
102
+ end
103
+ end
104
+
95
105
  if attributes.key?(:'headers')
96
106
  if (value = attributes[:'headers']).is_a?(Hash)
97
107
  self.headers = value
@@ -141,6 +151,7 @@ module MergeHRISClient
141
151
  path == o.path &&
142
152
  status == o.status &&
143
153
  response == o.response &&
154
+ response_headers == o.response_headers &&
144
155
  headers == o.headers
145
156
  end
146
157
 
@@ -153,7 +164,7 @@ module MergeHRISClient
153
164
  # Calculates hash code according to all attributes.
154
165
  # @return [Integer] Hash code
155
166
  def hash
156
- [method, path, status, response, headers].hash
167
+ [method, path, status, response, response_headers, headers].hash
157
168
  end
158
169
 
159
170
  # Builds the object from hash
@@ -31,7 +31,7 @@ module MergeHRISClient
31
31
 
32
32
  attr_accessor :remote_data
33
33
 
34
- # Indicates whether or not this object has been deleted on the third-party.
34
+ # Indicates whether or not this object has been deleted by third party webhooks.
35
35
  attr_accessor :remote_was_deleted
36
36
 
37
37
  # Attribute mapping from ruby-style variable name to JSON key.