class MergeATSClient::InterviewsApi
Attributes
Public Class Methods
# File lib/merge_ats_client/api/interviews_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Returns a list of `ScheduledInterview` objects. @param x_account_token [String] Token identifying the end user. @param [Hash] opts the optional parameters @option opts [String] :application_id If provided, will only return interviews for this application. @option opts [Time] :created_after If provided, will only return objects created after this datetime. @option opts [Time] :created_before If provided, will only return objects created before this datetime. @option opts [String] :cursor The pagination cursor value. @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @option opts [String] :job_interview_stage_id If provided, will only return interviews at this stage. @option opts [Time] :modified_after If provided, will only return objects modified after this datetime. @option opts [Time] :modified_before If provided, will only return objects modified before this datetime. @option opts [String] :organizer_id If provided, will only return interviews organized by this user. @option opts [Integer] :page_size Number of results to return per page. @option opts [String] :remote_id The API provider's ID for the given object. @return [PaginatedScheduledInterviewList]
# File lib/merge_ats_client/api/interviews_api.rb, line 38 def interviews_list(x_account_token, opts = {}) data, _status_code, _headers = interviews_list_with_http_info(x_account_token, opts) data end
Returns a list of `ScheduledInterview` objects. @param x_account_token [String] Token identifying the end user. @param [Hash] opts the optional parameters @option opts [String] :application_id If provided, will only return interviews for this application. @option opts [Time] :created_after If provided, will only return objects created after this datetime. @option opts [Time] :created_before If provided, will only return objects created before this datetime. @option opts [String] :cursor The pagination cursor value. @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @option opts [String] :job_interview_stage_id If provided, will only return interviews at this stage. @option opts [Time] :modified_after If provided, will only return objects modified after this datetime. @option opts [Time] :modified_before If provided, will only return objects modified before this datetime. @option opts [String] :organizer_id If provided, will only return interviews organized by this user. @option opts [Integer] :page_size Number of results to return per page. @option opts [String] :remote_id The API provider's ID for the given object. @return [Array<(PaginatedScheduledInterviewList
, Integer, Hash)>] PaginatedScheduledInterviewList
data, response status code and response headers
# File lib/merge_ats_client/api/interviews_api.rb, line 59 def interviews_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_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 InterviewsApi.interviews_list" end allowable_values = ["application", "application,job_interview_stage", "interviewers", "interviewers,application", "interviewers,application,job_interview_stage", "interviewers,job_interview_stage", "interviewers,organizer", "interviewers,organizer,application", "interviewers,organizer,application,job_interview_stage", "interviewers,organizer,job_interview_stage", "job_interview_stage", "organizer", "organizer,application", "organizer,application,job_interview_stage", "organizer,job_interview_stage"] 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 = '/interviews' # query parameters query_params = opts[:query_params] || {} query_params[:'application_id'] = opts[:'application_id'] if !opts[:'application_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[:'job_interview_stage_id'] = opts[:'job_interview_stage_id'] if !opts[:'job_interview_stage_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[:'organizer_id'] = opts[:'organizer_id'] if !opts[:'organizer_id'].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? # 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] || 'PaginatedScheduledInterviewList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] new_options = opts.merge( :operation => :"InterviewsApi.interviews_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, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: InterviewsApi#interviews_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a `ScheduledInterview` object with the given `id`. @param x_account_token [String] Token identifying the end user. @param id [String] @param [Hash] opts the optional parameters @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @return [ScheduledInterview]
# File lib/merge_ats_client/api/interviews_api.rb, line 131 def interviews_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = interviews_retrieve_with_http_info(x_account_token, id, opts) data end
Returns a `ScheduledInterview` object with the given `id`. @param x_account_token [String] Token identifying the end user. @param id [String] @param [Hash] opts the optional parameters @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models. @return [Array<(ScheduledInterview
, Integer, Hash)>] ScheduledInterview
data, response status code and response headers
# File lib/merge_ats_client/api/interviews_api.rb, line 143 def interviews_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_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 InterviewsApi.interviews_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 InterviewsApi.interviews_retrieve" end allowable_values = ["application", "application,job_interview_stage", "interviewers", "interviewers,application", "interviewers,application,job_interview_stage", "interviewers,job_interview_stage", "interviewers,organizer", "interviewers,organizer,application", "interviewers,organizer,application,job_interview_stage", "interviewers,organizer,job_interview_stage", "job_interview_stage", "organizer", "organizer,application", "organizer,application,job_interview_stage", "organizer,job_interview_stage"] 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 = '/interviews/{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] || 'ScheduledInterview' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] new_options = opts.merge( :operation => :"InterviewsApi.interviews_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, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: InterviewsApi#interviews_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end