merge_hris_client 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +33 -9
- data/docs/AccountDetails.md +30 -0
- data/docs/AccountDetailsAndActions.md +32 -0
- data/docs/AccountDetailsAndActionsIntegration.md +32 -0
- data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
- data/docs/AccountDetailsApi.md +76 -0
- data/docs/AccountTypeEnum.md +15 -0
- data/docs/BankInfo.md +34 -0
- data/docs/BankInfoApi.md +193 -0
- data/docs/BenefitsApi.md +2 -78
- data/docs/{StateEnum.md → CategoriesEnum.md} +2 -2
- data/docs/{NullEnum.md → CategoryEnum.md} +2 -2
- data/docs/CompaniesApi.md +3 -1
- data/docs/DataPassthroughRequest.md +5 -3
- data/docs/DeductionsApi.md +179 -0
- data/docs/Employee.md +12 -8
- data/docs/EmployeePayrollRun.md +3 -3
- data/docs/EmployeePayrollRunsApi.md +13 -3
- data/docs/EmployeesApi.md +12 -82
- data/docs/Employment.md +3 -1
- data/docs/EmploymentsApi.md +7 -78
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/ErrorValidationProblem.md +24 -0
- data/docs/ForceResyncApi.md +79 -0
- data/docs/IssuesApi.md +11 -10
- data/docs/LinkedAccountsApi.md +103 -0
- data/docs/Location.md +2 -0
- data/docs/LocationsApi.md +2 -0
- data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
- data/docs/PaginatedBankInfoList.md +22 -0
- data/docs/PaginatedDeductionList.md +22 -0
- data/docs/PaginatedIssueList.md +2 -2
- data/docs/PaginatedPayGroupList.md +22 -0
- data/docs/PaginatedSyncStatusList.md +2 -2
- data/docs/PayGroup.md +24 -0
- data/docs/PayGroupsApi.md +177 -0
- data/docs/PayrollRun.md +3 -3
- data/docs/PayrollRunsApi.md +13 -1
- data/docs/PolicyTypeEnum.md +15 -0
- data/docs/RequestFormatEnum.md +15 -0
- data/docs/SyncStatusApi.md +3 -74
- data/docs/TeamsApi.md +7 -2
- data/docs/TimeOff.md +3 -3
- data/docs/TimeOffApi.md +88 -4
- data/docs/TimeOffBalance.md +4 -2
- data/docs/{TimeOffBalanceApi.md → TimeOffBalancesApi.md} +26 -22
- data/docs/TimeOffEndpointRequest.md +18 -0
- data/docs/TimeOffRequest.md +36 -0
- data/docs/TimeOffResponse.md +22 -0
- data/docs/ValidationProblemSource.md +18 -0
- data/docs/WarningValidationProblem.md +24 -0
- data/lib/merge_hris_client/api/account_details_api.rb +77 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +222 -0
- data/lib/merge_hris_client/api/benefits_api.rb +3 -69
- data/lib/merge_hris_client/api/companies_api.rb +3 -0
- data/lib/merge_hris_client/api/deductions_api.rb +185 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +17 -2
- data/lib/merge_hris_client/api/employees_api.rb +18 -75
- data/lib/merge_hris_client/api/employments_api.rb +24 -69
- data/lib/merge_hris_client/api/force_resync_api.rb +84 -0
- data/lib/merge_hris_client/api/issues_api.rb +10 -10
- data/lib/merge_hris_client/api/linked_accounts_api.rb +117 -0
- data/lib/merge_hris_client/api/locations_api.rb +3 -0
- data/lib/merge_hris_client/api/pay_groups_api.rb +182 -0
- data/lib/merge_hris_client/api/payroll_runs_api.rb +22 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +4 -4
- data/lib/merge_hris_client/api/teams_api.rb +17 -0
- data/lib/merge_hris_client/api/time_off_api.rb +92 -2
- data/lib/merge_hris_client/api/time_off_balances_api.rb +206 -0
- data/lib/merge_hris_client/models/account_details.rb +273 -0
- data/lib/merge_hris_client/models/account_details_and_actions.rb +302 -0
- data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +310 -0
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +36 -0
- data/lib/merge_hris_client/models/account_integration.rb +1 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +35 -0
- data/lib/merge_hris_client/models/bank_info.rb +323 -0
- data/lib/merge_hris_client/models/categories_enum.rb +36 -0
- data/lib/merge_hris_client/models/category_enum.rb +36 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +66 -9
- data/lib/merge_hris_client/models/employee.rb +32 -8
- data/lib/merge_hris_client/models/employment.rb +12 -1
- data/lib/merge_hris_client/models/end_user_details_request.rb +73 -1
- data/lib/merge_hris_client/models/error_validation_problem.rb +260 -0
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +19 -0
- data/lib/merge_hris_client/models/location.rb +12 -1
- data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_bank_info_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_deduction_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_pay_group_list.rb +240 -0
- data/lib/merge_hris_client/models/{benefit_request.rb → pay_group.rb} +31 -54
- data/lib/merge_hris_client/models/policy_type_enum.rb +39 -0
- data/lib/merge_hris_client/models/remote_data_request.rb +19 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +19 -0
- data/lib/merge_hris_client/models/request_format_enum.rb +35 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +2 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -0
- data/lib/merge_hris_client/models/time_off_balance.rb +14 -3
- data/lib/merge_hris_client/models/time_off_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/{employment_request.rb → time_off_request.rb} +80 -69
- data/lib/merge_hris_client/models/time_off_response.rb +255 -0
- data/lib/merge_hris_client/models/validation_problem_source.rb +223 -0
- data/lib/merge_hris_client/models/warning_validation_problem.rb +260 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +28 -4
- data/spec/api/account_details_api_spec.rb +45 -0
- data/spec/api/account_token_api_spec.rb +1 -1
- data/spec/api/available_actions_api_spec.rb +1 -1
- data/spec/api/bank_info_api_spec.rb +76 -0
- data/spec/api/benefits_api_spec.rb +4 -1
- data/spec/api/companies_api_spec.rb +4 -1
- data/spec/api/deductions_api_spec.rb +69 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +9 -2
- data/spec/api/employees_api_spec.rb +9 -1
- data/spec/api/employments_api_spec.rb +7 -1
- data/spec/api/force_resync_api_spec.rb +46 -0
- data/spec/api/issues_api_spec.rb +5 -5
- data/spec/api/link_token_api_spec.rb +2 -2
- data/spec/api/linked_accounts_api_spec.rb +57 -0
- data/spec/api/locations_api_spec.rb +4 -1
- data/spec/api/passthrough_api_spec.rb +2 -3
- data/spec/api/pay_groups_api_spec.rb +68 -0
- data/spec/api/payroll_runs_api_spec.rb +9 -1
- data/spec/api/regenerate_key_api_spec.rb +2 -2
- data/spec/api/sync_status_api_spec.rb +2 -13
- data/spec/api/teams_api_spec.rb +7 -1
- data/spec/api/time_off_api_spec.rb +20 -2
- data/spec/api/{time_off_balance_api_spec.rb → time_off_balances_api_spec.rb} +13 -11
- data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
- data/spec/models/account_details_and_actions_spec.rb +76 -0
- data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
- data/spec/models/{benefit_request_spec.rb → account_details_spec.rb} +18 -12
- data/spec/models/account_integration_spec.rb +7 -1
- data/spec/models/account_token_spec.rb +7 -1
- data/spec/models/account_type_enum_spec.rb +28 -0
- data/spec/models/available_actions_spec.rb +13 -1
- data/spec/models/{employment_request_spec.rb → bank_info_spec.rb} +15 -15
- data/spec/models/benefit_plan_type_enum_spec.rb +1 -1
- data/spec/models/benefit_spec.rb +7 -1
- data/spec/models/categories_enum_spec.rb +28 -0
- data/spec/models/{state_enum_spec.rb → category_enum_spec.rb} +7 -7
- data/spec/models/company_spec.rb +7 -1
- data/spec/models/country_enum_spec.rb +1 -1
- data/spec/models/data_passthrough_request_spec.rb +7 -1
- data/spec/models/deduction_spec.rb +7 -1
- data/spec/models/earning_spec.rb +7 -1
- data/spec/models/employee_payroll_run_spec.rb +7 -1
- data/spec/models/employee_spec.rb +31 -1
- data/spec/models/employment_spec.rb +13 -1
- data/spec/models/employment_status_enum_spec.rb +1 -1
- data/spec/models/employment_type_enum_spec.rb +1 -1
- data/spec/models/end_user_details_request_spec.rb +7 -5
- data/spec/models/{end_user_details_spec.rb → error_validation_problem_spec.rb} +11 -15
- data/spec/models/ethnicity_enum_spec.rb +1 -1
- data/spec/models/flsa_status_enum_spec.rb +1 -1
- data/spec/models/gender_enum_spec.rb +1 -1
- data/spec/models/link_token_spec.rb +1 -1
- data/spec/models/location_spec.rb +13 -1
- data/spec/models/marital_status_enum_spec.rb +1 -1
- data/spec/models/method_enum_spec.rb +1 -1
- data/spec/models/model_operation_spec.rb +13 -1
- data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
- data/spec/models/paginated_bank_info_list_spec.rb +46 -0
- data/spec/models/paginated_benefit_list_spec.rb +1 -1
- data/spec/models/paginated_company_list_spec.rb +1 -1
- data/spec/models/paginated_deduction_list_spec.rb +46 -0
- data/spec/models/paginated_employee_list_spec.rb +1 -1
- data/spec/models/paginated_employee_payroll_run_list_spec.rb +1 -1
- data/spec/models/paginated_employment_list_spec.rb +1 -1
- data/spec/models/paginated_location_list_spec.rb +1 -1
- data/spec/models/paginated_pay_group_list_spec.rb +46 -0
- data/spec/models/paginated_payroll_run_list_spec.rb +1 -1
- data/spec/models/paginated_team_list_spec.rb +1 -1
- data/spec/models/paginated_time_off_list_spec.rb +1 -1
- data/spec/models/pay_currency_enum_spec.rb +1 -1
- data/spec/models/pay_frequency_enum_spec.rb +1 -1
- data/spec/models/{data_passthrough_spec.rb → pay_group_spec.rb} +11 -11
- data/spec/models/pay_period_enum_spec.rb +1 -1
- data/spec/models/payroll_run_spec.rb +7 -1
- data/spec/models/policy_type_enum_spec.rb +28 -0
- data/spec/models/remote_data_spec.rb +1 -1
- data/spec/models/remote_key_for_regeneration_request_spec.rb +1 -1
- data/spec/models/remote_key_spec.rb +1 -1
- data/spec/models/remote_response_spec.rb +1 -1
- data/spec/models/request_format_enum_spec.rb +28 -0
- data/spec/models/request_type_enum_spec.rb +1 -1
- data/spec/models/run_state_enum_spec.rb +1 -1
- data/spec/models/run_type_enum_spec.rb +1 -1
- data/spec/models/tax_spec.rb +7 -1
- data/spec/models/team_spec.rb +13 -1
- data/spec/models/time_off_balance_spec.rb +6 -0
- data/spec/models/{remote_key_for_regeneration_spec.rb → time_off_endpoint_request_spec.rb} +8 -8
- data/spec/models/time_off_request_spec.rb +88 -0
- data/spec/models/time_off_response_spec.rb +46 -0
- data/spec/models/time_off_spec.rb +19 -1
- data/spec/models/time_off_status_enum_spec.rb +1 -1
- data/spec/models/type_enum_spec.rb +1 -1
- data/spec/models/units_enum_spec.rb +1 -1
- data/spec/models/validation_problem_source_spec.rb +34 -0
- data/spec/models/warning_validation_problem_spec.rb +52 -0
- data/test_ruby.rb +11 -14
- metadata +115 -33
- data/docs/BenefitRequest.md +0 -28
- data/docs/DataPassthrough.md +0 -24
- data/docs/EmployeeRequest.md +0 -62
- data/docs/EmploymentRequest.md +0 -34
- data/docs/EndUserDetails.md +0 -24
- data/docs/RemoteKeyForRegeneration.md +0 -18
- data/lib/merge_hris_client/models/employee_request.rb +0 -523
- data/merge_hris_client-1.0.0.gem +0 -0
- data/merge_hris_client-1.0.1.gem +0 -0
- data/spec/models/employee_request_spec.rb +0 -160
@@ -25,11 +25,17 @@ 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 [Time] :ended_after If provided, will only return payroll runs ended after this datetime.
|
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.
|
28
31
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
29
32
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
30
33
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
31
34
|
# @option opts [Integer] :page_size Number of results to return per page.
|
32
35
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
36
|
+
# @option opts [String] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
|
37
|
+
# @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
|
38
|
+
# @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
|
33
39
|
# @return [PaginatedPayrollRunList]
|
34
40
|
def payroll_runs_list(x_account_token, opts = {})
|
35
41
|
data, _status_code, _headers = payroll_runs_list_with_http_info(x_account_token, opts)
|
@@ -42,11 +48,17 @@ module MergeHRISClient
|
|
42
48
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
43
49
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
44
50
|
# @option opts [String] :cursor The pagination cursor value.
|
51
|
+
# @option opts [Time] :ended_after If provided, will only return payroll runs ended after this datetime.
|
52
|
+
# @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.
|
45
54
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
46
55
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
47
56
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
48
57
|
# @option opts [Integer] :page_size Number of results to return per page.
|
49
58
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
59
|
+
# @option opts [String] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
|
60
|
+
# @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
|
61
|
+
# @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
|
50
62
|
# @return [Array<(PaginatedPayrollRunList, Integer, Hash)>] PaginatedPayrollRunList data, response status code and response headers
|
51
63
|
def payroll_runs_list_with_http_info(x_account_token, opts = {})
|
52
64
|
if @api_client.config.debugging
|
@@ -56,6 +68,10 @@ module MergeHRISClient
|
|
56
68
|
if @api_client.config.client_side_validation && x_account_token.nil?
|
57
69
|
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling PayrollRunsApi.payroll_runs_list"
|
58
70
|
end
|
71
|
+
allowable_values = ["CORRECTION", "OFF_CYCLE", "REGULAR", "SIGN_ON_BONUS", "TERMINATION"]
|
72
|
+
if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
|
73
|
+
fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
|
74
|
+
end
|
59
75
|
# resource path
|
60
76
|
local_var_path = '/payroll-runs'
|
61
77
|
|
@@ -64,11 +80,17 @@ module MergeHRISClient
|
|
64
80
|
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
65
81
|
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
66
82
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
83
|
+
query_params[:'ended_after'] = opts[:'ended_after'] if !opts[:'ended_after'].nil?
|
84
|
+
query_params[:'ended_before'] = opts[:'ended_before'] if !opts[:'ended_before'].nil?
|
85
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
67
86
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
68
87
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
69
88
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
70
89
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
71
90
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
91
|
+
query_params[:'run_type'] = opts[:'run_type'] if !opts[:'run_type'].nil?
|
92
|
+
query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
|
93
|
+
query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil?
|
72
94
|
|
73
95
|
# header parameters
|
74
96
|
header_params = opts[:header_params] || {}
|
@@ -19,10 +19,10 @@ module MergeHRISClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Get syncing status.
|
22
|
+
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
23
23
|
# @param x_account_token [String] Token identifying the end user.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [
|
25
|
+
# @option opts [String] :cursor The pagination cursor value.
|
26
26
|
# @option opts [Integer] :page_size Number of results to return per page.
|
27
27
|
# @return [PaginatedSyncStatusList]
|
28
28
|
def sync_status_list(x_account_token, opts = {})
|
@@ -30,10 +30,10 @@ module MergeHRISClient
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
# Get syncing status.
|
33
|
+
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
34
34
|
# @param x_account_token [String] Token identifying the end user.
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
|
-
# @option opts [
|
36
|
+
# @option opts [String] :cursor The pagination cursor value.
|
37
37
|
# @option opts [Integer] :page_size Number of results to return per page.
|
38
38
|
# @return [Array<(PaginatedSyncStatusList, Integer, Hash)>] PaginatedSyncStatusList data, response status code and response headers
|
39
39
|
def sync_status_list_with_http_info(x_account_token, opts = {})
|
@@ -25,6 +25,8 @@ 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 [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.
|
28
30
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
29
31
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
30
32
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -43,6 +45,8 @@ module MergeHRISClient
|
|
43
45
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
44
46
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
45
47
|
# @option opts [String] :cursor The pagination cursor value.
|
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.
|
46
50
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
47
51
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
48
52
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -58,6 +62,10 @@ module MergeHRISClient
|
|
58
62
|
if @api_client.config.client_side_validation && x_account_token.nil?
|
59
63
|
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TeamsApi.teams_list"
|
60
64
|
end
|
65
|
+
allowable_values = ["parent_team"]
|
66
|
+
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
67
|
+
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
68
|
+
end
|
61
69
|
# resource path
|
62
70
|
local_var_path = '/teams'
|
63
71
|
|
@@ -66,6 +74,8 @@ module MergeHRISClient
|
|
66
74
|
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
67
75
|
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
68
76
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
77
|
+
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
78
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
69
79
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
70
80
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
71
81
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
@@ -112,6 +122,7 @@ module MergeHRISClient
|
|
112
122
|
# @param x_account_token [String] Token identifying the end user.
|
113
123
|
# @param id [String]
|
114
124
|
# @param [Hash] opts the optional parameters
|
125
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
115
126
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
116
127
|
# @return [Team]
|
117
128
|
def teams_retrieve(x_account_token, id, opts = {})
|
@@ -123,6 +134,7 @@ module MergeHRISClient
|
|
123
134
|
# @param x_account_token [String] Token identifying the end user.
|
124
135
|
# @param id [String]
|
125
136
|
# @param [Hash] opts the optional parameters
|
137
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
126
138
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
127
139
|
# @return [Array<(Team, Integer, Hash)>] Team data, response status code and response headers
|
128
140
|
def teams_retrieve_with_http_info(x_account_token, id, opts = {})
|
@@ -137,11 +149,16 @@ module MergeHRISClient
|
|
137
149
|
if @api_client.config.client_side_validation && id.nil?
|
138
150
|
fail ArgumentError, "Missing the required parameter 'id' when calling TeamsApi.teams_retrieve"
|
139
151
|
end
|
152
|
+
allowable_values = ["parent_team"]
|
153
|
+
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
154
|
+
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
155
|
+
end
|
140
156
|
# resource path
|
141
157
|
local_var_path = '/teams/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
142
158
|
|
143
159
|
# query parameters
|
144
160
|
query_params = opts[:query_params] || {}
|
161
|
+
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
145
162
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
146
163
|
|
147
164
|
# header parameters
|
@@ -19,6 +19,79 @@ module MergeHRISClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Creates a `TimeOff` object with the given values.
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
24
|
+
# @param time_off_endpoint_request [TimeOffEndpointRequest]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
|
27
|
+
# @return [TimeOffResponse]
|
28
|
+
def time_off_create(x_account_token, time_off_endpoint_request, opts = {})
|
29
|
+
data, _status_code, _headers = time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Creates a `TimeOff` object with the given values.
|
34
|
+
# @param x_account_token [String] Token identifying the end user.
|
35
|
+
# @param time_off_endpoint_request [TimeOffEndpointRequest]
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
|
38
|
+
# @return [Array<(TimeOffResponse, Integer, Hash)>] TimeOffResponse data, response status code and response headers
|
39
|
+
def time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: TimeOffApi.time_off_create ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'x_account_token' is set
|
44
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffApi.time_off_create"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'time_off_endpoint_request' is set
|
48
|
+
if @api_client.config.client_side_validation && time_off_endpoint_request.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'time_off_endpoint_request' when calling TimeOffApi.time_off_create"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/time-off'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
|
57
|
+
|
58
|
+
# header parameters
|
59
|
+
header_params = opts[:header_params] || {}
|
60
|
+
# HTTP header 'Accept' (if needed)
|
61
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
62
|
+
# HTTP header 'Content-Type'
|
63
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
64
|
+
header_params[:'X-Account-Token'] = x_account_token
|
65
|
+
|
66
|
+
# form parameters
|
67
|
+
form_params = opts[:form_params] || {}
|
68
|
+
|
69
|
+
# http body (model)
|
70
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(time_off_endpoint_request)
|
71
|
+
|
72
|
+
# return_type
|
73
|
+
return_type = opts[:debug_return_type] || 'TimeOffResponse'
|
74
|
+
|
75
|
+
# auth_names
|
76
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
77
|
+
|
78
|
+
new_options = opts.merge(
|
79
|
+
:operation => :"TimeOffApi.time_off_create",
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => return_type
|
86
|
+
)
|
87
|
+
|
88
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: TimeOffApi#time_off_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
|
22
95
|
# Returns a list of `TimeOff` objects.
|
23
96
|
# @param x_account_token [String] Token identifying the end user.
|
24
97
|
# @param [Hash] opts the optional parameters
|
@@ -28,11 +101,14 @@ module MergeHRISClient
|
|
28
101
|
# @option opts [String] :cursor The pagination cursor value.
|
29
102
|
# @option opts [String] :employee_id If provided, will only return time off for this employee.
|
30
103
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
104
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
|
31
105
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
32
106
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
33
107
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
34
108
|
# @option opts [Integer] :page_size Number of results to return per page.
|
35
109
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
110
|
+
# @option opts [String] :request_type If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
111
|
+
# @option opts [String] :status If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
|
36
112
|
# @return [PaginatedTimeOffList]
|
37
113
|
def time_off_list(x_account_token, opts = {})
|
38
114
|
data, _status_code, _headers = time_off_list_with_http_info(x_account_token, opts)
|
@@ -48,11 +124,14 @@ module MergeHRISClient
|
|
48
124
|
# @option opts [String] :cursor The pagination cursor value.
|
49
125
|
# @option opts [String] :employee_id If provided, will only return time off for this employee.
|
50
126
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
127
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
|
51
128
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
52
129
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
53
130
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
54
131
|
# @option opts [Integer] :page_size Number of results to return per page.
|
55
132
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
133
|
+
# @option opts [String] :request_type If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
134
|
+
# @option opts [String] :status If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
|
56
135
|
# @return [Array<(PaginatedTimeOffList, Integer, Hash)>] PaginatedTimeOffList data, response status code and response headers
|
57
136
|
def time_off_list_with_http_info(x_account_token, opts = {})
|
58
137
|
if @api_client.config.debugging
|
@@ -66,6 +145,14 @@ module MergeHRISClient
|
|
66
145
|
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
67
146
|
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
68
147
|
end
|
148
|
+
allowable_values = ["BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER"]
|
149
|
+
if @api_client.config.client_side_validation && opts[:'request_type'] && !allowable_values.include?(opts[:'request_type'])
|
150
|
+
fail ArgumentError, "invalid value for \"request_type\", must be one of #{allowable_values}"
|
151
|
+
end
|
152
|
+
allowable_values = ["APPROVED", "CANCELLED", "DECLINED", "DELETED", "REQUESTED"]
|
153
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
154
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
155
|
+
end
|
69
156
|
# resource path
|
70
157
|
local_var_path = '/time-off'
|
71
158
|
|
@@ -77,11 +164,14 @@ module MergeHRISClient
|
|
77
164
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
78
165
|
query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
|
79
166
|
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
167
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
80
168
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
81
169
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
82
170
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
83
171
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
84
172
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
173
|
+
query_params[:'request_type'] = opts[:'request_type'] if !opts[:'request_type'].nil?
|
174
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
85
175
|
|
86
176
|
# header parameters
|
87
177
|
header_params = opts[:header_params] || {}
|
@@ -118,7 +208,7 @@ module MergeHRISClient
|
|
118
208
|
return data, status_code, headers
|
119
209
|
end
|
120
210
|
|
121
|
-
# Returns
|
211
|
+
# Returns a `TimeOff` object with the given `id`.
|
122
212
|
# @param x_account_token [String] Token identifying the end user.
|
123
213
|
# @param id [String]
|
124
214
|
# @param [Hash] opts the optional parameters
|
@@ -130,7 +220,7 @@ module MergeHRISClient
|
|
130
220
|
data
|
131
221
|
end
|
132
222
|
|
133
|
-
# Returns
|
223
|
+
# Returns a `TimeOff` object with the given `id`.
|
134
224
|
# @param x_account_token [String] Token identifying the end user.
|
135
225
|
# @param id [String]
|
136
226
|
# @param [Hash] opts the optional parameters
|
@@ -0,0 +1,206 @@
|
|
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 TimeOffBalancesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Returns a list of `TimeOffBalance` objects.
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
|
+
# @option opts [String] :cursor The pagination cursor value.
|
28
|
+
# @option opts [String] :employee_id If provided, will only return time off balances for this employee.
|
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.
|
31
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
32
|
+
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
33
|
+
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
34
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
35
|
+
# @option opts [String] :policy_type If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
36
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
37
|
+
# @return [PaginatedTimeOffBalanceList]
|
38
|
+
def time_off_balances_list(x_account_token, opts = {})
|
39
|
+
data, _status_code, _headers = time_off_balances_list_with_http_info(x_account_token, opts)
|
40
|
+
data
|
41
|
+
end
|
42
|
+
|
43
|
+
# Returns a list of `TimeOffBalance` objects.
|
44
|
+
# @param x_account_token [String] Token identifying the end user.
|
45
|
+
# @param [Hash] opts the optional parameters
|
46
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
47
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
48
|
+
# @option opts [String] :cursor The pagination cursor value.
|
49
|
+
# @option opts [String] :employee_id If provided, will only return time off balances for this employee.
|
50
|
+
# @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
53
|
+
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
54
|
+
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
55
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
56
|
+
# @option opts [String] :policy_type If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
57
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
58
|
+
# @return [Array<(PaginatedTimeOffBalanceList, Integer, Hash)>] PaginatedTimeOffBalanceList data, response status code and response headers
|
59
|
+
def time_off_balances_list_with_http_info(x_account_token, opts = {})
|
60
|
+
if @api_client.config.debugging
|
61
|
+
@api_client.config.logger.debug 'Calling API: TimeOffBalancesApi.time_off_balances_list ...'
|
62
|
+
end
|
63
|
+
# verify the required parameter 'x_account_token' is set
|
64
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
65
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffBalancesApi.time_off_balances_list"
|
66
|
+
end
|
67
|
+
allowable_values = ["employee"]
|
68
|
+
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
69
|
+
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
70
|
+
end
|
71
|
+
allowable_values = ["BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER"]
|
72
|
+
if @api_client.config.client_side_validation && opts[:'policy_type'] && !allowable_values.include?(opts[:'policy_type'])
|
73
|
+
fail ArgumentError, "invalid value for \"policy_type\", must be one of #{allowable_values}"
|
74
|
+
end
|
75
|
+
# resource path
|
76
|
+
local_var_path = '/time-off-balances'
|
77
|
+
|
78
|
+
# query parameters
|
79
|
+
query_params = opts[:query_params] || {}
|
80
|
+
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
81
|
+
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
82
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
83
|
+
query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
|
84
|
+
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
85
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
86
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
87
|
+
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
88
|
+
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
89
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
90
|
+
query_params[:'policy_type'] = opts[:'policy_type'] if !opts[:'policy_type'].nil?
|
91
|
+
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
92
|
+
|
93
|
+
# header parameters
|
94
|
+
header_params = opts[:header_params] || {}
|
95
|
+
# HTTP header 'Accept' (if needed)
|
96
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
97
|
+
header_params[:'X-Account-Token'] = x_account_token
|
98
|
+
|
99
|
+
# form parameters
|
100
|
+
form_params = opts[:form_params] || {}
|
101
|
+
|
102
|
+
# http body (model)
|
103
|
+
post_body = opts[:debug_body]
|
104
|
+
|
105
|
+
# return_type
|
106
|
+
return_type = opts[:debug_return_type] || 'PaginatedTimeOffBalanceList'
|
107
|
+
|
108
|
+
# auth_names
|
109
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
110
|
+
|
111
|
+
new_options = opts.merge(
|
112
|
+
:operation => :"TimeOffBalancesApi.time_off_balances_list",
|
113
|
+
:header_params => header_params,
|
114
|
+
:query_params => query_params,
|
115
|
+
:form_params => form_params,
|
116
|
+
:body => post_body,
|
117
|
+
:auth_names => auth_names,
|
118
|
+
:return_type => return_type
|
119
|
+
)
|
120
|
+
|
121
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
122
|
+
if @api_client.config.debugging
|
123
|
+
@api_client.config.logger.debug "API called: TimeOffBalancesApi#time_off_balances_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
124
|
+
end
|
125
|
+
return data, status_code, headers
|
126
|
+
end
|
127
|
+
|
128
|
+
# Returns a `TimeOffBalance` object with the given `id`.
|
129
|
+
# @param x_account_token [String] Token identifying the end user.
|
130
|
+
# @param id [String]
|
131
|
+
# @param [Hash] opts the optional parameters
|
132
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
133
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
134
|
+
# @return [TimeOffBalance]
|
135
|
+
def time_off_balances_retrieve(x_account_token, id, opts = {})
|
136
|
+
data, _status_code, _headers = time_off_balances_retrieve_with_http_info(x_account_token, id, opts)
|
137
|
+
data
|
138
|
+
end
|
139
|
+
|
140
|
+
# Returns a `TimeOffBalance` object with the given `id`.
|
141
|
+
# @param x_account_token [String] Token identifying the end user.
|
142
|
+
# @param id [String]
|
143
|
+
# @param [Hash] opts the optional parameters
|
144
|
+
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
145
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
146
|
+
# @return [Array<(TimeOffBalance, Integer, Hash)>] TimeOffBalance data, response status code and response headers
|
147
|
+
def time_off_balances_retrieve_with_http_info(x_account_token, id, opts = {})
|
148
|
+
if @api_client.config.debugging
|
149
|
+
@api_client.config.logger.debug 'Calling API: TimeOffBalancesApi.time_off_balances_retrieve ...'
|
150
|
+
end
|
151
|
+
# verify the required parameter 'x_account_token' is set
|
152
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
153
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffBalancesApi.time_off_balances_retrieve"
|
154
|
+
end
|
155
|
+
# verify the required parameter 'id' is set
|
156
|
+
if @api_client.config.client_side_validation && id.nil?
|
157
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TimeOffBalancesApi.time_off_balances_retrieve"
|
158
|
+
end
|
159
|
+
allowable_values = ["employee"]
|
160
|
+
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
161
|
+
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
162
|
+
end
|
163
|
+
# resource path
|
164
|
+
local_var_path = '/time-off-balances/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
165
|
+
|
166
|
+
# query parameters
|
167
|
+
query_params = opts[:query_params] || {}
|
168
|
+
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
169
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
170
|
+
|
171
|
+
# header parameters
|
172
|
+
header_params = opts[:header_params] || {}
|
173
|
+
# HTTP header 'Accept' (if needed)
|
174
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
175
|
+
header_params[:'X-Account-Token'] = x_account_token
|
176
|
+
|
177
|
+
# form parameters
|
178
|
+
form_params = opts[:form_params] || {}
|
179
|
+
|
180
|
+
# http body (model)
|
181
|
+
post_body = opts[:debug_body]
|
182
|
+
|
183
|
+
# return_type
|
184
|
+
return_type = opts[:debug_return_type] || 'TimeOffBalance'
|
185
|
+
|
186
|
+
# auth_names
|
187
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
188
|
+
|
189
|
+
new_options = opts.merge(
|
190
|
+
:operation => :"TimeOffBalancesApi.time_off_balances_retrieve",
|
191
|
+
:header_params => header_params,
|
192
|
+
:query_params => query_params,
|
193
|
+
:form_params => form_params,
|
194
|
+
:body => post_body,
|
195
|
+
:auth_names => auth_names,
|
196
|
+
:return_type => return_type
|
197
|
+
)
|
198
|
+
|
199
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
200
|
+
if @api_client.config.debugging
|
201
|
+
@api_client.config.logger.debug "API called: TimeOffBalancesApi#time_off_balances_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
202
|
+
end
|
203
|
+
return data, status_code, headers
|
204
|
+
end
|
205
|
+
end
|
206
|
+
end
|