Class: SmartRecruiters::TimeslotsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TimeslotsApi

Returns a new instance of TimeslotsApi.



7
8
9
 
# File 'lib/smart_recruiters/api/timeslots_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/timeslots_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#timeslots_create(body, interview_id, opts = {}) ⇒ Timeslot

Creates a timeslot

Parameters:

  • body —

    Timeslot to be added

  • interview_id —

    ID of the interview

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

    the optional parameters

Returns:



15
16
17
18
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 15

def timeslots_create(body, interview_id, opts = {})
  data, _status_code, _headers = timeslots_create_with_http_info(body, interview_id, opts)
  data
end

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

Creates a timeslot

Parameters:

  • body —

    Timeslot to be added

  • interview_id —

    ID of the interview

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

    the optional parameters

Returns:

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

    Timeslot data, response status code and response headers



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
66
67
68
69
70
71
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 25

def timeslots_create_with_http_info(body, interview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeslotsApi.timeslots_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 TimeslotsApi.timeslots_create"
  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 TimeslotsApi.timeslots_create"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}/timeslots'.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; charset=utf-8', '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] || 'Timeslot' 

  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: TimeslotsApi#timeslots_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#timeslots_delete(interview_id, timeslot_id, opts = {}) ⇒ nil

Deletes a timeslot

Parameters:

  • interview_id —

    ID of the interview

  • timeslot_id —

    ID of the timeslot

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

    the optional parameters

Returns:

  • (nil) 


77
78
79
80
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 77

def timeslots_delete(interview_id, timeslot_id, opts = {})
  timeslots_delete_with_http_info(interview_id, timeslot_id, opts)
  nil
end

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

Deletes a timeslot

Parameters:

  • interview_id —

    ID of the interview

  • timeslot_id —

    ID of the timeslot

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
127
128
129
130
131
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 87

def timeslots_delete_with_http_info(interview_id, timeslot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeslotsApi.timeslots_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 TimeslotsApi.timeslots_delete"
  end
  # verify the required parameter 'timeslot_id' is set
  if @api_client.config.client_side_validation && timeslot_id.nil?
    fail ArgumentError, "Missing the required parameter 'timeslot_id' when calling TimeslotsApi.timeslots_delete"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}/timeslots/{timeslotId}'.sub('{' + 'interviewId' + '}', interview_id.to_s).sub('{' + 'timeslotId' + '}', timeslot_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: TimeslotsApi#timeslots_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#timeslots_get(interview_id, timeslot_id, opts = {}) ⇒ Timeslot

Retrieves a timeslot

Parameters:

  • interview_id —

    ID of the interview

  • timeslot_id —

    ID of the timeslot

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

    the optional parameters

Returns:



137
138
139
140
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 137

def timeslots_get(interview_id, timeslot_id, opts = {})
  data, _status_code, _headers = timeslots_get_with_http_info(interview_id, timeslot_id, opts)
  data
end

#timeslots_get_with_http_info(interview_id, timeslot_id, opts = {}) ⇒ Array<(Timeslot, Integer, Hash)>

Retrieves a timeslot

Parameters:

  • interview_id —

    ID of the interview

  • timeslot_id —

    ID of the timeslot

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

    the optional parameters

Returns:

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

    Timeslot data, response status code and response headers



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

def timeslots_get_with_http_info(interview_id, timeslot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeslotsApi.timeslots_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 TimeslotsApi.timeslots_get"
  end
  # verify the required parameter 'timeslot_id' is set
  if @api_client.config.client_side_validation && timeslot_id.nil?
    fail ArgumentError, "Missing the required parameter 'timeslot_id' when calling TimeslotsApi.timeslots_get"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}/timeslots/{timeslotId}'.sub('{' + 'interviewId' + '}', interview_id.to_s).sub('{' + 'timeslotId' + '}', timeslot_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] || 'Timeslot' 

  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: TimeslotsApi#timeslots_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Modifies a timeslot

Parameters:

  • body —

    Timeslot to be updated

  • interview_id —

    ID of the interview

  • timeslot_id —

    ID of the timeslot

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

    the optional parameters

Returns:

  • (nil) 


198
199
200
201
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 198

def timeslots_update(body, interview_id, timeslot_id, opts = {})
  timeslots_update_with_http_info(body, interview_id, timeslot_id, opts)
  nil
end

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

Modifies a timeslot

Parameters:

  • body —

    Timeslot to be updated

  • interview_id —

    ID of the interview

  • timeslot_id —

    ID of the timeslot

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/smart_recruiters/api/timeslots_api.rb', line 209

def timeslots_update_with_http_info(body, interview_id, timeslot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TimeslotsApi.timeslots_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 TimeslotsApi.timeslots_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 TimeslotsApi.timeslots_update"
  end
  # verify the required parameter 'timeslot_id' is set
  if @api_client.config.client_side_validation && timeslot_id.nil?
    fail ArgumentError, "Missing the required parameter 'timeslot_id' when calling TimeslotsApi.timeslots_update"
  end
  # resource path
  local_var_path = '/interviews/{interviewId}/timeslots/{timeslotId}'.sub('{' + 'interviewId' + '}', interview_id.to_s).sub('{' + 'timeslotId' + '}', timeslot_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: TimeslotsApi#timeslots_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end