merge_hris_client 3.2.1 → 3.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +49 -16
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +7 -3
- data/docs/AccountIntegration.md +8 -4
- data/docs/AdvancedMetadata.md +28 -0
- data/docs/AuditLogEvent.md +32 -0
- data/docs/AuditTrailApi.md +91 -0
- data/docs/BankInfo.md +6 -4
- data/docs/BankInfoApi.md +4 -4
- data/docs/Benefit.md +6 -4
- data/docs/CommonModelScopeAPI.md +18 -0
- data/docs/Company.md +6 -4
- data/docs/CreateFieldMappingRequest.md +28 -0
- data/docs/DataPassthroughRequest.md +4 -4
- data/docs/DebugModelLogSummary.md +1 -1
- data/docs/Deduction.md +6 -4
- data/docs/Dependent.md +6 -4
- data/docs/Earning.md +6 -4
- data/docs/Employee.md +7 -3
- data/docs/EmployeePayrollRun.md +6 -4
- data/docs/EmployeeRequest.md +2 -0
- data/docs/EmployeesApi.md +10 -4
- data/docs/EmployerBenefit.md +6 -4
- data/docs/Employment.md +6 -4
- data/docs/EmploymentsApi.md +4 -4
- data/docs/EndUserDetailsRequest.md +13 -7
- data/docs/EventTypeEnum.md +15 -0
- data/docs/ExternalTargetFieldAPI.md +22 -0
- data/docs/ExternalTargetFieldAPIResponse.md +48 -0
- data/docs/FieldMappingApi.md +455 -0
- data/docs/FieldMappingApiInstance.md +24 -0
- data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
- data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
- data/docs/FieldMappingApiInstanceResponse.md +48 -0
- data/docs/FieldMappingApiInstanceTargetField.md +22 -0
- data/docs/FieldMappingInstanceResponse.md +24 -0
- data/docs/FieldPermissionDeserializer.md +20 -0
- data/docs/FieldPermissionDeserializerRequest.md +20 -0
- data/docs/ForceResyncApi.md +1 -1
- data/docs/GenerateRemoteKeyRequest.md +1 -1
- data/docs/Group.md +9 -5
- data/docs/GroupsApi.md +8 -4
- data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
- data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
- data/docs/Issue.md +1 -1
- data/docs/IssuesApi.md +5 -3
- data/docs/LinkTokenApi.md +1 -1
- data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +6 -4
- data/docs/LocationsApi.md +6 -4
- data/docs/MetaResponse.md +1 -1
- data/docs/ModelPermissionDeserializer.md +18 -0
- data/docs/ModelPermissionDeserializerRequest.md +18 -0
- data/docs/PaginatedAuditLogEventList.md +22 -0
- data/docs/PaginatedTimesheetEntryList.md +22 -0
- data/docs/PatchedEditFieldMappingRequest.md +22 -0
- data/docs/PayGroup.md +6 -4
- data/docs/PayrollRun.md +6 -4
- data/docs/PayrollRunsApi.md +4 -4
- data/docs/RemoteEndpointInfo.md +22 -0
- data/docs/RemoteFieldAPI.md +28 -0
- data/docs/RemoteFieldAPIResponse.md +48 -0
- data/docs/RemoteKeyForRegenerationRequest.md +1 -1
- data/docs/RoleEnum.md +15 -0
- data/docs/ScopesApi.md +222 -0
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +6 -4
- data/docs/Team.md +6 -4
- data/docs/TimeOff.md +5 -3
- data/docs/TimeOffApi.md +12 -4
- data/docs/TimeOffBalance.md +6 -4
- data/docs/TimeOffBalancesApi.md +4 -4
- data/docs/TimesheetEntriesApi.md +341 -0
- data/docs/TimesheetEntry.md +38 -0
- data/docs/TimesheetEntryEndpointRequest.md +18 -0
- data/docs/TimesheetEntryRequest.md +28 -0
- data/docs/TimesheetEntryResponse.md +24 -0
- data/lib/merge_hris_client/api/audit_trail_api.rb +95 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +4 -4
- data/lib/merge_hris_client/api/employees_api.rb +13 -4
- data/lib/merge_hris_client/api/employments_api.rb +4 -4
- data/lib/merge_hris_client/api/field_mapping_api.rb +424 -0
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +10 -4
- data/lib/merge_hris_client/api/issues_api.rb +7 -4
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_hris_client/api/locations_api.rb +11 -4
- data/lib/merge_hris_client/api/payroll_runs_api.rb +4 -4
- data/lib/merge_hris_client/api/scopes_api.rb +209 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/api/time_off_api.rb +16 -4
- data/lib/merge_hris_client/api/time_off_balances_api.rb +4 -4
- data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
- data/lib/merge_hris_client/configuration.rb +4 -0
- data/lib/merge_hris_client/models/account_details.rb +14 -5
- data/lib/merge_hris_client/models/account_details_and_actions.rb +28 -4
- data/lib/merge_hris_client/models/account_integration.rb +36 -14
- data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
- data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
- data/lib/merge_hris_client/models/bank_info.rb +24 -16
- data/lib/merge_hris_client/models/benefit.rb +24 -16
- data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
- data/lib/merge_hris_client/models/company.rb +24 -16
- data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +3 -0
- data/lib/merge_hris_client/models/deduction.rb +24 -16
- data/lib/merge_hris_client/models/dependent.rb +24 -16
- data/lib/merge_hris_client/models/earning.rb +24 -16
- data/lib/merge_hris_client/models/employee.rb +34 -15
- data/lib/merge_hris_client/models/employee_payroll_run.rb +24 -16
- data/lib/merge_hris_client/models/employee_request.rb +12 -1
- data/lib/merge_hris_client/models/employer_benefit.rb +24 -16
- data/lib/merge_hris_client/models/employment.rb +24 -16
- data/lib/merge_hris_client/models/end_user_details_request.rb +67 -6
- data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
- data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
- data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
- data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
- data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
- data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
- data/lib/merge_hris_client/models/group.rb +34 -15
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
- data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
- data/lib/merge_hris_client/models/location.rb +24 -16
- data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
- data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
- data/lib/merge_hris_client/models/paginated_audit_log_event_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_timesheet_entry_list.rb +240 -0
- data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
- data/lib/merge_hris_client/models/pay_group.rb +24 -16
- data/lib/merge_hris_client/models/payroll_run.rb +24 -16
- data/lib/merge_hris_client/models/remote_endpoint_info.rb +253 -0
- data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
- data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
- data/lib/merge_hris_client/models/role_enum.rb +49 -0
- data/lib/merge_hris_client/models/tax.rb +24 -16
- data/lib/merge_hris_client/models/team.rb +24 -16
- data/lib/merge_hris_client/models/time_off.rb +23 -15
- data/lib/merge_hris_client/models/time_off_balance.rb +24 -16
- data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
- data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
- data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +35 -21
- data/spec/api/audit_trail_api_spec.rb +51 -0
- data/spec/api/bank_info_api_spec.rb +2 -2
- data/spec/api/employees_api_spec.rb +5 -2
- data/spec/api/employments_api_spec.rb +2 -2
- data/spec/api/field_mapping_api_spec.rb +107 -0
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +4 -2
- data/spec/api/issues_api_spec.rb +3 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/locations_api_spec.rb +3 -2
- data/spec/api/payroll_runs_api_spec.rb +2 -2
- data/spec/api/scopes_api_spec.rb +68 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/time_off_api_spec.rb +6 -2
- data/spec/api/time_off_balances_api_spec.rb +2 -2
- data/spec/api/timesheet_entries_api_spec.rb +99 -0
- data/spec/models/account_details_and_actions_spec.rb +12 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/account_integration_spec.rb +14 -2
- data/spec/models/advanced_metadata_spec.rb +64 -0
- data/spec/models/audit_log_event_spec.rb +76 -0
- data/spec/models/bank_info_spec.rb +12 -6
- data/spec/models/benefit_spec.rb +12 -6
- data/spec/models/common_model_scope_api_spec.rb +34 -0
- data/spec/models/company_spec.rb +11 -5
- data/spec/models/create_field_mapping_request_spec.rb +64 -0
- data/spec/models/deduction_spec.rb +12 -6
- data/spec/models/dependent_spec.rb +12 -6
- data/spec/models/earning_spec.rb +11 -5
- data/spec/models/employee_payroll_run_spec.rb +12 -6
- data/spec/models/employee_request_spec.rb +6 -0
- data/spec/models/employee_spec.rb +18 -6
- data/spec/models/employer_benefit_spec.rb +12 -6
- data/spec/models/employment_spec.rb +12 -6
- data/spec/models/end_user_details_request_spec.rb +18 -0
- data/spec/models/event_type_enum_spec.rb +28 -0
- data/spec/models/external_target_field_api_response_spec.rb +124 -0
- data/spec/models/external_target_field_api_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
- data/spec/models/field_mapping_api_instance_spec.rb +52 -0
- data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
- data/spec/models/field_mapping_instance_response_spec.rb +52 -0
- data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
- data/spec/models/field_permission_deserializer_spec.rb +40 -0
- data/spec/models/group_spec.rb +13 -1
- data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
- data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
- data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -0
- data/spec/models/location_spec.rb +12 -6
- data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
- data/spec/models/model_permission_deserializer_spec.rb +34 -0
- data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
- data/spec/models/paginated_timesheet_entry_list_spec.rb +46 -0
- data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +9 -3
- data/spec/models/payroll_run_spec.rb +12 -6
- data/spec/models/remote_endpoint_info_spec.rb +46 -0
- data/spec/models/remote_field_api_response_spec.rb +124 -0
- data/spec/models/remote_field_api_spec.rb +64 -0
- data/spec/models/role_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +12 -6
- data/spec/models/team_spec.rb +10 -4
- data/spec/models/time_off_balance_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +12 -6
- data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
- data/spec/models/timesheet_entry_request_spec.rb +64 -0
- data/spec/models/timesheet_entry_response_spec.rb +52 -0
- data/spec/models/timesheet_entry_spec.rb +94 -0
- metadata +266 -126
@@ -19,7 +19,7 @@ module MergeHRISClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Gets issues.
|
22
|
+
# Gets all issues for Organization.
|
23
23
|
# @param [Hash] opts the optional parameters
|
24
24
|
# @option opts [String] :account_token
|
25
25
|
# @option opts [String] :cursor The pagination cursor value.
|
@@ -27,10 +27,11 @@ module MergeHRISClient
|
|
27
27
|
# @option opts [String] :end_user_organization_name
|
28
28
|
# @option opts [Time] :first_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
|
29
29
|
# @option opts [Time] :first_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
|
30
|
-
# @option opts [String] :include_muted If
|
30
|
+
# @option opts [String] :include_muted If true, will include muted issues
|
31
31
|
# @option opts [String] :integration_name
|
32
32
|
# @option opts [Time] :last_incident_time_after If provided, will only return issues whose last incident time was after this datetime.
|
33
33
|
# @option opts [Time] :last_incident_time_before If provided, will only return issues whose last incident time was before this datetime.
|
34
|
+
# @option opts [String] :linked_account_id If provided, will only include issues pertaining to the linked account passed in.
|
34
35
|
# @option opts [Integer] :page_size Number of results to return per page.
|
35
36
|
# @option opts [String] :start_date If included, will only include issues whose most recent action occurred after this time
|
36
37
|
# @option opts [String] :status Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
|
@@ -40,7 +41,7 @@ module MergeHRISClient
|
|
40
41
|
data
|
41
42
|
end
|
42
43
|
|
43
|
-
# Gets issues.
|
44
|
+
# Gets all issues for Organization.
|
44
45
|
# @param [Hash] opts the optional parameters
|
45
46
|
# @option opts [String] :account_token
|
46
47
|
# @option opts [String] :cursor The pagination cursor value.
|
@@ -48,10 +49,11 @@ module MergeHRISClient
|
|
48
49
|
# @option opts [String] :end_user_organization_name
|
49
50
|
# @option opts [Time] :first_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
|
50
51
|
# @option opts [Time] :first_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
|
51
|
-
# @option opts [String] :include_muted If
|
52
|
+
# @option opts [String] :include_muted If true, will include muted issues
|
52
53
|
# @option opts [String] :integration_name
|
53
54
|
# @option opts [Time] :last_incident_time_after If provided, will only return issues whose last incident time was after this datetime.
|
54
55
|
# @option opts [Time] :last_incident_time_before If provided, will only return issues whose last incident time was before this datetime.
|
56
|
+
# @option opts [String] :linked_account_id If provided, will only include issues pertaining to the linked account passed in.
|
55
57
|
# @option opts [Integer] :page_size Number of results to return per page.
|
56
58
|
# @option opts [String] :start_date If included, will only include issues whose most recent action occurred after this time
|
57
59
|
# @option opts [String] :status Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
|
@@ -79,6 +81,7 @@ module MergeHRISClient
|
|
79
81
|
query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
|
80
82
|
query_params[:'last_incident_time_after'] = opts[:'last_incident_time_after'] if !opts[:'last_incident_time_after'].nil?
|
81
83
|
query_params[:'last_incident_time_before'] = opts[:'last_incident_time_before'] if !opts[:'last_incident_time_before'].nil?
|
84
|
+
query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].nil?
|
82
85
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
83
86
|
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
84
87
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
@@ -21,7 +21,7 @@ module MergeHRISClient
|
|
21
21
|
end
|
22
22
|
# List linked accounts for your organization.
|
23
23
|
# @param [Hash] opts the optional parameters
|
24
|
-
# @option opts [String] :category Options:
|
24
|
+
# @option opts [String] :category Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse
|
25
25
|
# @option opts [String] :cursor The pagination cursor value.
|
26
26
|
# @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
|
27
27
|
# @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
|
@@ -42,7 +42,7 @@ module MergeHRISClient
|
|
42
42
|
|
43
43
|
# List linked accounts for your organization.
|
44
44
|
# @param [Hash] opts the optional parameters
|
45
|
-
# @option opts [String] :category Options:
|
45
|
+
# @option opts [String] :category Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse
|
46
46
|
# @option opts [String] :cursor The pagination cursor value.
|
47
47
|
# @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
|
48
48
|
# @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
|
@@ -60,7 +60,7 @@ module MergeHRISClient
|
|
60
60
|
if @api_client.config.debugging
|
61
61
|
@api_client.config.logger.debug 'Calling API: LinkedAccountsApi.linked_accounts_list ...'
|
62
62
|
end
|
63
|
-
allowable_values = ["accounting", "ats", "crm", "filestorage", "hris", "mktg", "ticketing"]
|
63
|
+
allowable_values = ["accounting", "ats", "crm", "datawarehouse", "filestorage", "hris", "mktg", "ticketing"]
|
64
64
|
if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
|
65
65
|
fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
|
66
66
|
end
|
@@ -27,12 +27,13 @@ module MergeHRISClient
|
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
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
|
+
# @option opts [String] :location_type If provided, will only return locations with this location_type * `HOME` - HOME * `WORK` - WORK
|
30
31
|
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
31
32
|
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
32
33
|
# @option opts [Integer] :page_size Number of results to return per page.
|
33
34
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
34
35
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
35
|
-
# @option opts [String] :show_enum_origins
|
36
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
36
37
|
# @return [PaginatedLocationList]
|
37
38
|
def locations_list(x_account_token, opts = {})
|
38
39
|
data, _status_code, _headers = locations_list_with_http_info(x_account_token, opts)
|
@@ -47,12 +48,13 @@ module MergeHRISClient
|
|
47
48
|
# @option opts [String] :cursor The pagination cursor value.
|
48
49
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
49
50
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
51
|
+
# @option opts [String] :location_type If provided, will only return locations with this location_type * `HOME` - HOME * `WORK` - WORK
|
50
52
|
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
51
53
|
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
52
54
|
# @option opts [Integer] :page_size Number of results to return per page.
|
53
55
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
54
56
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
55
|
-
# @option opts [String] :show_enum_origins
|
57
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
56
58
|
# @return [Array<(PaginatedLocationList, Integer, Hash)>] PaginatedLocationList data, response status code and response headers
|
57
59
|
def locations_list_with_http_info(x_account_token, opts = {})
|
58
60
|
if @api_client.config.debugging
|
@@ -62,6 +64,10 @@ module MergeHRISClient
|
|
62
64
|
if @api_client.config.client_side_validation && x_account_token.nil?
|
63
65
|
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling LocationsApi.locations_list"
|
64
66
|
end
|
67
|
+
allowable_values = ["HOME", "WORK"]
|
68
|
+
if @api_client.config.client_side_validation && opts[:'location_type'] && !allowable_values.include?(opts[:'location_type'])
|
69
|
+
fail ArgumentError, "invalid value for \"location_type\", must be one of #{allowable_values}"
|
70
|
+
end
|
65
71
|
allowable_values = ["location_type"]
|
66
72
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
67
73
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
@@ -80,6 +86,7 @@ module MergeHRISClient
|
|
80
86
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
81
87
|
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
82
88
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
89
|
+
query_params[:'location_type'] = opts[:'location_type'] if !opts[:'location_type'].nil?
|
83
90
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
84
91
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
85
92
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
@@ -128,7 +135,7 @@ module MergeHRISClient
|
|
128
135
|
# @param [Hash] opts the optional parameters
|
129
136
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
130
137
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
131
|
-
# @option opts [String] :show_enum_origins
|
138
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
132
139
|
# @return [Location]
|
133
140
|
def locations_retrieve(x_account_token, id, opts = {})
|
134
141
|
data, _status_code, _headers = locations_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -141,7 +148,7 @@ module MergeHRISClient
|
|
141
148
|
# @param [Hash] opts the optional parameters
|
142
149
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
143
150
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
144
|
-
# @option opts [String] :show_enum_origins
|
151
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
145
152
|
# @return [Array<(Location, Integer, Hash)>] Location data, response status code and response headers
|
146
153
|
def locations_retrieve_with_http_info(x_account_token, id, opts = {})
|
147
154
|
if @api_client.config.debugging
|
@@ -35,7 +35,7 @@ module MergeHRISClient
|
|
35
35
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
36
36
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
37
37
|
# @option opts [String] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
|
38
|
-
# @option opts [String] :show_enum_origins
|
38
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
39
39
|
# @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
|
40
40
|
# @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
|
41
41
|
# @return [PaginatedPayrollRunList]
|
@@ -60,7 +60,7 @@ module MergeHRISClient
|
|
60
60
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
61
61
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
62
62
|
# @option opts [String] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
|
63
|
-
# @option opts [String] :show_enum_origins
|
63
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
64
64
|
# @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
|
65
65
|
# @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
|
66
66
|
# @return [Array<(PaginatedPayrollRunList, Integer, Hash)>] PaginatedPayrollRunList data, response status code and response headers
|
@@ -147,7 +147,7 @@ module MergeHRISClient
|
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
149
149
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
150
|
-
# @option opts [String] :show_enum_origins
|
150
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
151
151
|
# @return [PayrollRun]
|
152
152
|
def payroll_runs_retrieve(x_account_token, id, opts = {})
|
153
153
|
data, _status_code, _headers = payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -160,7 +160,7 @@ module MergeHRISClient
|
|
160
160
|
# @param [Hash] opts the optional parameters
|
161
161
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
162
162
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
163
|
-
# @option opts [String] :show_enum_origins
|
163
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
164
164
|
# @return [Array<(PayrollRun, Integer, Hash)>] PayrollRun data, response status code and response headers
|
165
165
|
def payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {})
|
166
166
|
if @api_client.config.debugging
|
@@ -0,0 +1,209 @@
|
|
1
|
+
=begin
|
2
|
+
#Merge HRIS API
|
3
|
+
|
4
|
+
#The unified API for building rich integrations with multiple HR Information System platforms.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0
|
7
|
+
Contact: hello@merge.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MergeHRISClient
|
16
|
+
class ScopesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @return [CommonModelScopeAPI]
|
25
|
+
def default_scopes_retrieve(opts = {})
|
26
|
+
data, _status_code, _headers = default_scopes_retrieve_with_http_info(opts)
|
27
|
+
data
|
28
|
+
end
|
29
|
+
|
30
|
+
# Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
|
31
|
+
# @param [Hash] opts the optional parameters
|
32
|
+
# @return [Array<(CommonModelScopeAPI, Integer, Hash)>] CommonModelScopeAPI data, response status code and response headers
|
33
|
+
def default_scopes_retrieve_with_http_info(opts = {})
|
34
|
+
if @api_client.config.debugging
|
35
|
+
@api_client.config.logger.debug 'Calling API: ScopesApi.default_scopes_retrieve ...'
|
36
|
+
end
|
37
|
+
# resource path
|
38
|
+
local_var_path = '/default-scopes'
|
39
|
+
|
40
|
+
# query parameters
|
41
|
+
query_params = opts[:query_params] || {}
|
42
|
+
|
43
|
+
# header parameters
|
44
|
+
header_params = opts[:header_params] || {}
|
45
|
+
# HTTP header 'Accept' (if needed)
|
46
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
47
|
+
|
48
|
+
# form parameters
|
49
|
+
form_params = opts[:form_params] || {}
|
50
|
+
|
51
|
+
# http body (model)
|
52
|
+
post_body = opts[:debug_body]
|
53
|
+
|
54
|
+
# return_type
|
55
|
+
return_type = opts[:debug_return_type] || 'CommonModelScopeAPI'
|
56
|
+
|
57
|
+
# auth_names
|
58
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
59
|
+
|
60
|
+
new_options = opts.merge(
|
61
|
+
:operation => :"ScopesApi.default_scopes_retrieve",
|
62
|
+
:header_params => header_params,
|
63
|
+
:query_params => query_params,
|
64
|
+
:form_params => form_params,
|
65
|
+
:body => post_body,
|
66
|
+
:auth_names => auth_names,
|
67
|
+
:return_type => return_type
|
68
|
+
)
|
69
|
+
|
70
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
71
|
+
if @api_client.config.debugging
|
72
|
+
@api_client.config.logger.debug "API called: ScopesApi#default_scopes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
73
|
+
end
|
74
|
+
return data, status_code, headers
|
75
|
+
end
|
76
|
+
|
77
|
+
# Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
|
78
|
+
# @param x_account_token [String] Token identifying the end user.
|
79
|
+
# @param linked_account_common_model_scope_deserializer_request [LinkedAccountCommonModelScopeDeserializerRequest]
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @return [CommonModelScopeAPI]
|
82
|
+
def linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request, opts = {})
|
83
|
+
data, _status_code, _headers = linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request, opts)
|
84
|
+
data
|
85
|
+
end
|
86
|
+
|
87
|
+
# Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
|
88
|
+
# @param x_account_token [String] Token identifying the end user.
|
89
|
+
# @param linked_account_common_model_scope_deserializer_request [LinkedAccountCommonModelScopeDeserializerRequest]
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [Array<(CommonModelScopeAPI, Integer, Hash)>] CommonModelScopeAPI data, response status code and response headers
|
92
|
+
def linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request, opts = {})
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug 'Calling API: ScopesApi.linked_account_scopes_create ...'
|
95
|
+
end
|
96
|
+
# verify the required parameter 'x_account_token' is set
|
97
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
98
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ScopesApi.linked_account_scopes_create"
|
99
|
+
end
|
100
|
+
# verify the required parameter 'linked_account_common_model_scope_deserializer_request' is set
|
101
|
+
if @api_client.config.client_side_validation && linked_account_common_model_scope_deserializer_request.nil?
|
102
|
+
fail ArgumentError, "Missing the required parameter 'linked_account_common_model_scope_deserializer_request' when calling ScopesApi.linked_account_scopes_create"
|
103
|
+
end
|
104
|
+
# resource path
|
105
|
+
local_var_path = '/linked-account-scopes'
|
106
|
+
|
107
|
+
# query parameters
|
108
|
+
query_params = opts[:query_params] || {}
|
109
|
+
|
110
|
+
# header parameters
|
111
|
+
header_params = opts[:header_params] || {}
|
112
|
+
# HTTP header 'Accept' (if needed)
|
113
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
114
|
+
# HTTP header 'Content-Type'
|
115
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
116
|
+
header_params[:'X-Account-Token'] = x_account_token
|
117
|
+
|
118
|
+
# form parameters
|
119
|
+
form_params = opts[:form_params] || {}
|
120
|
+
|
121
|
+
# http body (model)
|
122
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(linked_account_common_model_scope_deserializer_request)
|
123
|
+
|
124
|
+
# return_type
|
125
|
+
return_type = opts[:debug_return_type] || 'CommonModelScopeAPI'
|
126
|
+
|
127
|
+
# auth_names
|
128
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
129
|
+
|
130
|
+
new_options = opts.merge(
|
131
|
+
:operation => :"ScopesApi.linked_account_scopes_create",
|
132
|
+
:header_params => header_params,
|
133
|
+
:query_params => query_params,
|
134
|
+
:form_params => form_params,
|
135
|
+
:body => post_body,
|
136
|
+
:auth_names => auth_names,
|
137
|
+
:return_type => return_type
|
138
|
+
)
|
139
|
+
|
140
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
141
|
+
if @api_client.config.debugging
|
142
|
+
@api_client.config.logger.debug "API called: ScopesApi#linked_account_scopes_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
143
|
+
end
|
144
|
+
return data, status_code, headers
|
145
|
+
end
|
146
|
+
|
147
|
+
# Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
|
148
|
+
# @param x_account_token [String] Token identifying the end user.
|
149
|
+
# @param [Hash] opts the optional parameters
|
150
|
+
# @return [CommonModelScopeAPI]
|
151
|
+
def linked_account_scopes_retrieve(x_account_token, opts = {})
|
152
|
+
data, _status_code, _headers = linked_account_scopes_retrieve_with_http_info(x_account_token, opts)
|
153
|
+
data
|
154
|
+
end
|
155
|
+
|
156
|
+
# Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
|
157
|
+
# @param x_account_token [String] Token identifying the end user.
|
158
|
+
# @param [Hash] opts the optional parameters
|
159
|
+
# @return [Array<(CommonModelScopeAPI, Integer, Hash)>] CommonModelScopeAPI data, response status code and response headers
|
160
|
+
def linked_account_scopes_retrieve_with_http_info(x_account_token, opts = {})
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug 'Calling API: ScopesApi.linked_account_scopes_retrieve ...'
|
163
|
+
end
|
164
|
+
# verify the required parameter 'x_account_token' is set
|
165
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
166
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ScopesApi.linked_account_scopes_retrieve"
|
167
|
+
end
|
168
|
+
# resource path
|
169
|
+
local_var_path = '/linked-account-scopes'
|
170
|
+
|
171
|
+
# query parameters
|
172
|
+
query_params = opts[:query_params] || {}
|
173
|
+
|
174
|
+
# header parameters
|
175
|
+
header_params = opts[:header_params] || {}
|
176
|
+
# HTTP header 'Accept' (if needed)
|
177
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
178
|
+
header_params[:'X-Account-Token'] = x_account_token
|
179
|
+
|
180
|
+
# form parameters
|
181
|
+
form_params = opts[:form_params] || {}
|
182
|
+
|
183
|
+
# http body (model)
|
184
|
+
post_body = opts[:debug_body]
|
185
|
+
|
186
|
+
# return_type
|
187
|
+
return_type = opts[:debug_return_type] || 'CommonModelScopeAPI'
|
188
|
+
|
189
|
+
# auth_names
|
190
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
191
|
+
|
192
|
+
new_options = opts.merge(
|
193
|
+
:operation => :"ScopesApi.linked_account_scopes_retrieve",
|
194
|
+
:header_params => header_params,
|
195
|
+
:query_params => query_params,
|
196
|
+
:form_params => form_params,
|
197
|
+
:body => post_body,
|
198
|
+
:auth_names => auth_names,
|
199
|
+
:return_type => return_type
|
200
|
+
)
|
201
|
+
|
202
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
203
|
+
if @api_client.config.debugging
|
204
|
+
@api_client.config.logger.debug "API called: ScopesApi#linked_account_scopes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
205
|
+
end
|
206
|
+
return data, status_code, headers
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
@@ -19,7 +19,7 @@ module MergeHRISClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING
|
22
|
+
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
|
23
23
|
# @param x_account_token [String] Token identifying the end user.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @option opts [String] :cursor The pagination cursor value.
|
@@ -30,7 +30,7 @@ module MergeHRISClient
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`
|
33
|
+
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
|
34
34
|
# @param x_account_token [String] Token identifying the end user.
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @option opts [String] :cursor The pagination cursor value.
|
@@ -103,6 +103,8 @@ module MergeHRISClient
|
|
103
103
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
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
|
+
# @option opts [Time] :ended_after If provided, will only return employees that ended after this datetime.
|
107
|
+
# @option opts [Time] :ended_before If provided, will only return time-offs that ended before this datetime.
|
106
108
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
107
109
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
108
110
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
@@ -112,7 +114,9 @@ module MergeHRISClient
|
|
112
114
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
113
115
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
114
116
|
# @option opts [String] :request_type If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
115
|
-
# @option opts [String] :show_enum_origins
|
117
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
118
|
+
# @option opts [Time] :started_after If provided, will only return time-offs that started after this datetime.
|
119
|
+
# @option opts [Time] :started_before If provided, will only return time-offs that started before this datetime.
|
116
120
|
# @option opts [String] :status If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
|
117
121
|
# @return [PaginatedTimeOffList]
|
118
122
|
def time_off_list(x_account_token, opts = {})
|
@@ -128,6 +132,8 @@ module MergeHRISClient
|
|
128
132
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
129
133
|
# @option opts [String] :cursor The pagination cursor value.
|
130
134
|
# @option opts [String] :employee_id If provided, will only return time off for this employee.
|
135
|
+
# @option opts [Time] :ended_after If provided, will only return employees that ended after this datetime.
|
136
|
+
# @option opts [Time] :ended_before If provided, will only return time-offs that ended before this datetime.
|
131
137
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
132
138
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
133
139
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
@@ -137,7 +143,9 @@ module MergeHRISClient
|
|
137
143
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
138
144
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
139
145
|
# @option opts [String] :request_type If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
140
|
-
# @option opts [String] :show_enum_origins
|
146
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
147
|
+
# @option opts [Time] :started_after If provided, will only return time-offs that started after this datetime.
|
148
|
+
# @option opts [Time] :started_before If provided, will only return time-offs that started before this datetime.
|
141
149
|
# @option opts [String] :status If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
|
142
150
|
# @return [Array<(PaginatedTimeOffList, Integer, Hash)>] PaginatedTimeOffList data, response status code and response headers
|
143
151
|
def time_off_list_with_http_info(x_account_token, opts = {})
|
@@ -178,6 +186,8 @@ module MergeHRISClient
|
|
178
186
|
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
179
187
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
180
188
|
query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
|
189
|
+
query_params[:'ended_after'] = opts[:'ended_after'] if !opts[:'ended_after'].nil?
|
190
|
+
query_params[:'ended_before'] = opts[:'ended_before'] if !opts[:'ended_before'].nil?
|
181
191
|
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
182
192
|
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
183
193
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
@@ -188,6 +198,8 @@ module MergeHRISClient
|
|
188
198
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
189
199
|
query_params[:'request_type'] = opts[:'request_type'] if !opts[:'request_type'].nil?
|
190
200
|
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
201
|
+
query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
|
202
|
+
query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil?
|
191
203
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
192
204
|
|
193
205
|
# header parameters
|
@@ -294,7 +306,7 @@ module MergeHRISClient
|
|
294
306
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
295
307
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
296
308
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
297
|
-
# @option opts [String] :show_enum_origins
|
309
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
298
310
|
# @return [TimeOff]
|
299
311
|
def time_off_retrieve(x_account_token, id, opts = {})
|
300
312
|
data, _status_code, _headers = time_off_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -308,7 +320,7 @@ module MergeHRISClient
|
|
308
320
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
309
321
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
310
322
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
311
|
-
# @option opts [String] :show_enum_origins
|
323
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
312
324
|
# @return [Array<(TimeOff, Integer, Hash)>] TimeOff data, response status code and response headers
|
313
325
|
def time_off_retrieve_with_http_info(x_account_token, id, opts = {})
|
314
326
|
if @api_client.config.debugging
|
@@ -35,7 +35,7 @@ module MergeHRISClient
|
|
35
35
|
# @option opts [String] :policy_type If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
36
36
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
37
37
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
38
|
-
# @option opts [String] :show_enum_origins
|
38
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
39
39
|
# @return [PaginatedTimeOffBalanceList]
|
40
40
|
def time_off_balances_list(x_account_token, opts = {})
|
41
41
|
data, _status_code, _headers = time_off_balances_list_with_http_info(x_account_token, opts)
|
@@ -58,7 +58,7 @@ module MergeHRISClient
|
|
58
58
|
# @option opts [String] :policy_type If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
59
59
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
60
60
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
61
|
-
# @option opts [String] :show_enum_origins
|
61
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
62
62
|
# @return [Array<(PaginatedTimeOffBalanceList, Integer, Hash)>] PaginatedTimeOffBalanceList data, response status code and response headers
|
63
63
|
def time_off_balances_list_with_http_info(x_account_token, opts = {})
|
64
64
|
if @api_client.config.debugging
|
@@ -146,7 +146,7 @@ module MergeHRISClient
|
|
146
146
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
147
147
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
148
148
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
149
|
-
# @option opts [String] :show_enum_origins
|
149
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
150
150
|
# @return [TimeOffBalance]
|
151
151
|
def time_off_balances_retrieve(x_account_token, id, opts = {})
|
152
152
|
data, _status_code, _headers = time_off_balances_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -160,7 +160,7 @@ module MergeHRISClient
|
|
160
160
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
161
161
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
162
162
|
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
163
|
-
# @option opts [String] :show_enum_origins
|
163
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
164
164
|
# @return [Array<(TimeOffBalance, Integer, Hash)>] TimeOffBalance data, response status code and response headers
|
165
165
|
def time_off_balances_retrieve_with_http_info(x_account_token, id, opts = {})
|
166
166
|
if @api_client.config.debugging
|