Class: SmartRecruiters::InterviewsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smart_recruiters/api/interviews_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InterviewsApi

Returns a new instance of InterviewsApi.



7
8
9
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#interviews_create(body, opts = {}) ⇒ Interview

Creates an interview

Parameters:

  • body —

    Interview to be added

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



14
15
16
17
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 14

def interviews_create(body, opts = {})
  data, _status_code, _headers = interviews_create_with_http_info(body, opts)
  data
end

#interviews_create_with_http_info(body, opts = {}) ⇒ Array<(Interview, Integer, Hash)>

Creates an interview

Parameters:

  • body —

    Interview to be added

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Interview, Integer, Hash)>) —

    Interview data, response status code and response headers



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 23

def interviews_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling InterviewsApi.interviews_create"
  end
  # resource path
  local_var_path = '/interviews'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'Interview' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InterviewsApi#interviews_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#interviews_delete(interview_id, opts = {}) ⇒ nil

Deletes an interview

Parameters:

  • interview_id —

    ID of the interview

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


70
71
72
73
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 70

def interviews_delete(interview_id, opts = {})
  interviews_delete_with_http_info(interview_id, opts)
  nil
end

#interviews_delete_with_http_info(interview_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes an interview

Parameters:

  • interview_id —

    ID of the interview

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 79

def interviews_delete_with_http_info(interview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_delete ...'
  end
  # verify the required parameter 'interview_id' is set
  if @api_client.config.client_side_validation && interview_id.nil?
    fail ArgumentError, "Missing the required parameter 'interview_id' when calling InterviewsApi.interviews_delete"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}'.sub('{' + 'interviewId' + '}', interview_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InterviewsApi#interviews_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#interviews_get(interview_id, opts = {}) ⇒ Interview

Retrieves an interview Interview details

Parameters:

  • interview_id —

    ID of the interview

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



125
126
127
128
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 125

def interviews_get(interview_id, opts = {})
  data, _status_code, _headers = interviews_get_with_http_info(interview_id, opts)
  data
end

#interviews_get_list(application_id, opts = {}) ⇒ InterviewsList

Retrieves a list of interviews List of interviews

Parameters:

  • application_id —

    ID of the application

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 181

def interviews_get_list(application_id, opts = {})
  data, _status_code, _headers = interviews_get_list_with_http_info(application_id, opts)
  data
end

#interviews_get_list_with_http_info(application_id, opts = {}) ⇒ Array<(InterviewsList, Integer, Hash)>

Retrieves a list of interviews List of interviews

Parameters:

  • application_id —

    ID of the application

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InterviewsList, Integer, Hash)>) —

    InterviewsList data, response status code and response headers



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 191

def interviews_get_list_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_get_list ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling InterviewsApi.interviews_get_list"
  end
  # resource path
  local_var_path = '/interviews'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'applicationId'] = application_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'InterviewsList' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InterviewsApi#interviews_get_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#interviews_get_with_http_info(interview_id, opts = {}) ⇒ Array<(Interview, Integer, Hash)>

Retrieves an interview Interview details

Parameters:

  • interview_id —

    ID of the interview

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Interview, Integer, Hash)>) —

    Interview data, response status code and response headers



135
136
137
138
139
140
141
142
143
144
145
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
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 135

def interviews_get_with_http_info(interview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_get ...'
  end
  # verify the required parameter 'interview_id' is set
  if @api_client.config.client_side_validation && interview_id.nil?
    fail ArgumentError, "Missing the required parameter 'interview_id' when calling InterviewsApi.interviews_get"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}'.sub('{' + 'interviewId' + '}', interview_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Interview' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InterviewsApi#interviews_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#interviews_update(body, interview_id, opts = {}) ⇒ nil

Modifies an interview

Parameters:

  • body —

    Interview to be updated

  • interview_id —

    ID of the interview

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


238
239
240
241
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 238

def interviews_update(body, interview_id, opts = {})
  interviews_update_with_http_info(body, interview_id, opts)
  nil
end

#interviews_update_with_http_info(body, interview_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Modifies an interview

Parameters:

  • body —

    Interview to be updated

  • interview_id —

    ID of the interview

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/smart_recruiters/api/interviews_api.rb', line 248

def interviews_update_with_http_info(body, interview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InterviewsApi.interviews_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling InterviewsApi.interviews_update"
  end
  # verify the required parameter 'interview_id' is set
  if @api_client.config.client_side_validation && interview_id.nil?
    fail ArgumentError, "Missing the required parameter 'interview_id' when calling InterviewsApi.interviews_update"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}'.sub('{' + 'interviewId' + '}', interview_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InterviewsApi#interviews_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end