Class: MergeATSClient::JobsApi
- Inherits:
-
Object
- Object
- MergeATSClient::JobsApi
- Defined in:
- lib/merge_ats_client/api/jobs_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ JobsApi
constructor
A new instance of JobsApi.
-
#jobs_list(x_account_token, opts = {}) ⇒ PaginatedJobList
Returns a list of ‘Job` objects.
-
#jobs_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedJobList, Integer, Hash)>
Returns a list of `Job` objects.
-
#jobs_retrieve(x_account_token, id, opts = {}) ⇒ Job
Returns a ‘Job` object with the given `id`.
-
#jobs_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Job, Integer, Hash)>
Returns a `Job` object with the given `id`.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_ats_client/api/jobs_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#jobs_list(x_account_token, opts = {}) ⇒ PaginatedJobList
Returns a list of ‘Job` objects.
38 39 40 41 |
# File 'lib/merge_ats_client/api/jobs_api.rb', line 38 def jobs_list(x_account_token, opts = {}) data, _status_code, _headers = jobs_list_with_http_info(x_account_token, opts) data end |
#jobs_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedJobList, Integer, Hash)>
Returns a list of `Job` objects.
59 60 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 126 |
# File 'lib/merge_ats_client/api/jobs_api.rb', line 59 def jobs_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: JobsApi.jobs_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 JobsApi.jobs_list" end allowable_values = ["departments", "departments,hiring_managers", "departments,hiring_managers,recruiters", "departments,offices", "departments,offices,hiring_managers", "departments,offices,hiring_managers,recruiters", "departments,offices,recruiters", "departments,recruiters", "hiring_managers", "hiring_managers,recruiters", "offices", "offices,hiring_managers", "offices,hiring_managers,recruiters", "offices,recruiters", "recruiters"] 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 allowable_values = ["ARCHIVED", "CLOSED", "DRAFT", "OPEN", "PENDING"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/jobs' # query parameters query_params = opts[:query_params] || {} query_params[:'code'] = opts[:'code'] if !opts[:'code'].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_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].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[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'PaginatedJobList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"JobsApi.jobs_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: JobsApi#jobs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#jobs_retrieve(x_account_token, id, opts = {}) ⇒ Job
Returns a ‘Job` object with the given `id`.
135 136 137 138 |
# File 'lib/merge_ats_client/api/jobs_api.rb', line 135 def jobs_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = jobs_retrieve_with_http_info(x_account_token, id, opts) data end |
#jobs_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Job, Integer, Hash)>
Returns a `Job` object with the given `id`.
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 204 |
# File 'lib/merge_ats_client/api/jobs_api.rb', line 147 def jobs_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: JobsApi.jobs_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 JobsApi.jobs_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 JobsApi.jobs_retrieve" end allowable_values = ["departments", "departments,hiring_managers", "departments,hiring_managers,recruiters", "departments,offices", "departments,offices,hiring_managers", "departments,offices,hiring_managers,recruiters", "departments,offices,recruiters", "departments,recruiters", "hiring_managers", "hiring_managers,recruiters", "offices", "offices,hiring_managers", "offices,hiring_managers,recruiters", "offices,recruiters", "recruiters"] 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 = '/jobs/{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] || 'Job' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"JobsApi.jobs_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: JobsApi#jobs_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |