Class: MergeHRISClient::EmployeesApi
- Inherits:
-
Object
- Object
- MergeHRISClient::EmployeesApi
- Defined in:
- lib/merge_hris_client/api/employees_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#employees_list(x_account_token, opts = {}) ⇒ PaginatedEmployeeList
Returns a list of ‘Employee` objects.
-
#employees_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedEmployeeList, Integer, Hash)>
Returns a list of `Employee` objects.
-
#employees_retrieve(x_account_token, id, opts = {}) ⇒ Employee
Returns an ‘Employee` object with the given `id`.
-
#employees_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Employee, Integer, Hash)>
Returns an `Employee` object with the given `id`.
-
#initialize(api_client = ApiClient.default) ⇒ EmployeesApi
constructor
A new instance of EmployeesApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ EmployeesApi
Returns a new instance of EmployeesApi.
19 20 21 |
# File 'lib/merge_hris_client/api/employees_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_hris_client/api/employees_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#employees_list(x_account_token, opts = {}) ⇒ PaginatedEmployeeList
Returns a list of ‘Employee` objects.
39 40 41 42 |
# File 'lib/merge_hris_client/api/employees_api.rb', line 39 def employees_list(x_account_token, opts = {}) data, _status_code, _headers = employees_list_with_http_info(x_account_token, opts) data end |
#employees_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedEmployeeList, Integer, Hash)>
Returns a list of `Employee` objects.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/merge_hris_client/api/employees_api.rb', line 61 def employees_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmployeesApi.employees_list ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployeesApi.employees_list" end allowable_values = ["company", "employments", "employments,company", "employments,home_location", "employments,home_location,company", "employments,home_location,manager", "employments,home_location,manager,company", "employments,home_location,manager,team", "employments,home_location,manager,team,company", "employments,home_location,team", "employments,home_location,team,company", "employments,home_location,work_location", "employments,home_location,work_location,company", "employments,home_location,work_location,manager", "employments,home_location,work_location,manager,company", "employments,home_location,work_location,manager,team", "employments,home_location,work_location,manager,team,company", "employments,home_location,work_location,team", "employments,home_location,work_location,team,company", "employments,manager", "employments,manager,company", "employments,manager,team", "employments,manager,team,company", "employments,team", "employments,team,company", "employments,work_location", "employments,work_location,company", "employments,work_location,manager", "employments,work_location,manager,company", "employments,work_location,manager,team", "employments,work_location,manager,team,company", "employments,work_location,team", "employments,work_location,team,company", "home_location", "home_location,company", "home_location,manager", "home_location,manager,company", "home_location,manager,team", "home_location,manager,team,company", "home_location,team", "home_location,team,company", "home_location,work_location", "home_location,work_location,company", "home_location,work_location,manager", "home_location,work_location,manager,company", "home_location,work_location,manager,team", "home_location,work_location,manager,team,company", "home_location,work_location,team", "home_location,work_location,team,company", "manager", "manager,company", "manager,team", "manager,team,company", "team", "team,company", "work_location", "work_location,company", "work_location,manager", "work_location,manager,company", "work_location,manager,team", "work_location,manager,team,company", "work_location,team", "work_location,team,company"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end # resource path local_var_path = '/employees' # query parameters query_params = opts[:query_params] || {} query_params[:'company_id'] = opts[:'company_id'] if !opts[:'company_id'].nil? query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'manager_id'] = opts[:'manager_id'] if !opts[:'manager_id'].nil? query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil? query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil? query_params[:'work_location_id'] = opts[:'work_location_id'] if !opts[:'work_location_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PaginatedEmployeeList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"EmployeesApi.employees_list", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: EmployeesApi#employees_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#employees_retrieve(x_account_token, id, opts = {}) ⇒ Employee
Returns an ‘Employee` object with the given `id`.
134 135 136 137 |
# File 'lib/merge_hris_client/api/employees_api.rb', line 134 def employees_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = employees_retrieve_with_http_info(x_account_token, id, opts) data end |
#employees_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Employee, Integer, Hash)>
Returns an `Employee` object with the given `id`.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/merge_hris_client/api/employees_api.rb', line 146 def employees_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmployeesApi.employees_retrieve ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployeesApi.employees_retrieve" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling EmployeesApi.employees_retrieve" end allowable_values = ["company", "employments", "employments,company", "employments,home_location", "employments,home_location,company", "employments,home_location,manager", "employments,home_location,manager,company", "employments,home_location,manager,team", "employments,home_location,manager,team,company", "employments,home_location,team", "employments,home_location,team,company", "employments,home_location,work_location", "employments,home_location,work_location,company", "employments,home_location,work_location,manager", "employments,home_location,work_location,manager,company", "employments,home_location,work_location,manager,team", "employments,home_location,work_location,manager,team,company", "employments,home_location,work_location,team", "employments,home_location,work_location,team,company", "employments,manager", "employments,manager,company", "employments,manager,team", "employments,manager,team,company", "employments,team", "employments,team,company", "employments,work_location", "employments,work_location,company", "employments,work_location,manager", "employments,work_location,manager,company", "employments,work_location,manager,team", "employments,work_location,manager,team,company", "employments,work_location,team", "employments,work_location,team,company", "home_location", "home_location,company", "home_location,manager", "home_location,manager,company", "home_location,manager,team", "home_location,manager,team,company", "home_location,team", "home_location,team,company", "home_location,work_location", "home_location,work_location,company", "home_location,work_location,manager", "home_location,work_location,manager,company", "home_location,work_location,manager,team", "home_location,work_location,manager,team,company", "home_location,work_location,team", "home_location,work_location,team,company", "manager", "manager,company", "manager,team", "manager,team,company", "team", "team,company", "work_location", "work_location,company", "work_location,manager", "work_location,manager,company", "work_location,manager,team", "work_location,manager,team,company", "work_location,team", "work_location,team,company"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end # resource path local_var_path = '/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Employee' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"EmployeesApi.employees_retrieve", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: EmployeesApi#employees_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |