Class: Clever::DataApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clever-ruby/api/data_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataApi

Returns a new instance of DataApi.



19
20
21
 
# File 'lib/clever-ruby/api/data_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/clever-ruby/api/data_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_contact(id, opts = {}) ⇒ ContactResponse

Returns a specific student contact

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/clever-ruby/api/data_api.rb', line 26

def get_contact(id, opts = {})
  data, _status_code, _headers = get_contact_with_http_info(id, opts)
  data
end

#get_contact_with_http_info(id, opts = {}) ⇒ Array<(ContactResponse, Fixnum, Hash)>

Returns a specific student contact

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ContactResponse, Fixnum, Hash)>) —

    ContactResponse data, response status code and response headers



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/clever-ruby/api/data_api.rb', line 35

def get_contact_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_contact ...'
  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 DataApi.get_contact"
  end
  # resource path
  local_var_path = '/contacts/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'ContactResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contacts(opts = {}) ⇒ ContactsResponse

Returns a list of student contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



79
80
81
82
 
# File 'lib/clever-ruby/api/data_api.rb', line 79

def get_contacts(opts = {})
  data, _status_code, _headers = get_contacts_with_http_info(opts)
  data
end

#get_contacts_for_student(id, opts = {}) ⇒ ContactsResponse

Returns the contacts for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



138
139
140
141
 
# File 'lib/clever-ruby/api/data_api.rb', line 138

def get_contacts_for_student(id, opts = {})
  data, _status_code, _headers = get_contacts_for_student_with_http_info(id, opts)
  data
end

#get_contacts_for_student_with_http_info(id, opts = {}) ⇒ Array<(ContactsResponse, Fixnum, Hash)>

Returns the contacts for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(ContactsResponse, Fixnum, Hash)>) —

    ContactsResponse data, response status code and response headers



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
 
# File 'lib/clever-ruby/api/data_api.rb', line 150

def get_contacts_for_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_contacts_for_student ...'
  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 DataApi.get_contacts_for_student"
  end
  # resource path
  local_var_path = '/students/{id}/contacts'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'ContactsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_contacts_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contacts_with_http_info(opts = {}) ⇒ Array<(ContactsResponse, Fixnum, Hash)>

Returns a list of student contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(ContactsResponse, Fixnum, Hash)>) —

    ContactsResponse data, response status code and response headers



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
 
# File 'lib/clever-ruby/api/data_api.rb', line 91

def get_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_contacts ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/contacts'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'ContactsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_course(id, opts = {}) ⇒ CourseResponse

Returns a specific course

Parameters:

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

    the optional parameters

Returns:



194
195
196
197
 
# File 'lib/clever-ruby/api/data_api.rb', line 194

def get_course(id, opts = {})
  data, _status_code, _headers = get_course_with_http_info(id, opts)
  data
end

#get_course_for_section(id, opts = {}) ⇒ CourseResponse

Returns the course for a section

Parameters:

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

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/clever-ruby/api/data_api.rb', line 244

def get_course_for_section(id, opts = {})
  data, _status_code, _headers = get_course_for_section_with_http_info(id, opts)
  data
end

#get_course_for_section_with_http_info(id, opts = {}) ⇒ Array<(CourseResponse, Fixnum, Hash)>

Returns the course for a section

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CourseResponse, Fixnum, Hash)>) —

    CourseResponse data, response status code and response headers



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
 
# File 'lib/clever-ruby/api/data_api.rb', line 253

def get_course_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_course_for_section ...'
  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 DataApi.get_course_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/course'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'CourseResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_course_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_course_with_http_info(id, opts = {}) ⇒ Array<(CourseResponse, Fixnum, Hash)>

Returns a specific course

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CourseResponse, Fixnum, Hash)>) —

    CourseResponse data, response status code and response headers



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
233
234
235
236
237
238
239
 
# File 'lib/clever-ruby/api/data_api.rb', line 203

def get_course_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_course ...'
  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 DataApi.get_course"
  end
  # resource path
  local_var_path = '/courses/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'CourseResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_course\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_courses(opts = {}) ⇒ CoursesResponse

Returns a list of courses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



297
298
299
300
 
# File 'lib/clever-ruby/api/data_api.rb', line 297

def get_courses(opts = {})
  data, _status_code, _headers = get_courses_with_http_info(opts)
  data
end

#get_courses_with_http_info(opts = {}) ⇒ Array<(CoursesResponse, Fixnum, Hash)>

Returns a list of courses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(CoursesResponse, Fixnum, Hash)>) —

    CoursesResponse data, response status code and response headers



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/clever-ruby/api/data_api.rb', line 309

def get_courses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_courses ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/courses'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'CoursesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_courses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district(id, opts = {}) ⇒ DistrictResponse

Returns a specific district

Parameters:

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

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/clever-ruby/api/data_api.rb', line 353

def get_district(id, opts = {})
  data, _status_code, _headers = get_district_with_http_info(id, opts)
  data
end

#get_district_admin(id, opts = {}) ⇒ DistrictAdminResponse

Returns a specific district admin

Parameters:

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

    the optional parameters

Returns:



403
404
405
406
 
# File 'lib/clever-ruby/api/data_api.rb', line 403

def get_district_admin(id, opts = {})
  data, _status_code, _headers = get_district_admin_with_http_info(id, opts)
  data
end

#get_district_admin_with_http_info(id, opts = {}) ⇒ Array<(DistrictAdminResponse, Fixnum, Hash)>

Returns a specific district admin

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictAdminResponse, Fixnum, Hash)>) —

    DistrictAdminResponse data, response status code and response headers



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/clever-ruby/api/data_api.rb', line 412

def get_district_admin_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_admin ...'
  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 DataApi.get_district_admin"
  end
  # resource path
  local_var_path = '/district_admins/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictAdminResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_admins(opts = {}) ⇒ DistrictAdminsResponse

Returns a list of district admins

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



456
457
458
459
 
# File 'lib/clever-ruby/api/data_api.rb', line 456

def get_district_admins(opts = {})
  data, _status_code, _headers = get_district_admins_with_http_info(opts)
  data
end

#get_district_admins_with_http_info(opts = {}) ⇒ Array<(DistrictAdminsResponse, Fixnum, Hash)>

Returns a list of district admins

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(DistrictAdminsResponse, Fixnum, Hash)>) —

    DistrictAdminsResponse data, response status code and response headers



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/clever-ruby/api/data_api.rb', line 468

def get_district_admins_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_admins ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/district_admins'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictAdminsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_admins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_contact(id, opts = {}) ⇒ DistrictResponse

Returns the district for a student contact

Parameters:

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

    the optional parameters

Returns:



512
513
514
515
 
# File 'lib/clever-ruby/api/data_api.rb', line 512

def get_district_for_contact(id, opts = {})
  data, _status_code, _headers = get_district_for_contact_with_http_info(id, opts)
  data
end

#get_district_for_contact_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a student contact

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/clever-ruby/api/data_api.rb', line 521

def get_district_for_contact_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_contact ...'
  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 DataApi.get_district_for_contact"
  end
  # resource path
  local_var_path = '/contacts/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_course(id, opts = {}) ⇒ DistrictResponse

Returns the district for a course

Parameters:

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

    the optional parameters

Returns:



562
563
564
565
 
# File 'lib/clever-ruby/api/data_api.rb', line 562

def get_district_for_course(id, opts = {})
  data, _status_code, _headers = get_district_for_course_with_http_info(id, opts)
  data
end

#get_district_for_course_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a course

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/clever-ruby/api/data_api.rb', line 571

def get_district_for_course_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_course ...'
  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 DataApi.get_district_for_course"
  end
  # resource path
  local_var_path = '/courses/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_course\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_district_admin(id, opts = {}) ⇒ DistrictResponse

Returns the district for a district admin

Parameters:

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

    the optional parameters

Returns:



612
613
614
615
 
# File 'lib/clever-ruby/api/data_api.rb', line 612

def get_district_for_district_admin(id, opts = {})
  data, _status_code, _headers = get_district_for_district_admin_with_http_info(id, opts)
  data
end

#get_district_for_district_admin_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a district admin

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/clever-ruby/api/data_api.rb', line 621

def get_district_for_district_admin_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_district_admin ...'
  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 DataApi.get_district_for_district_admin"
  end
  # resource path
  local_var_path = '/district_admins/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_district_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_school(id, opts = {}) ⇒ DistrictResponse

Returns the district for a school

Parameters:

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

    the optional parameters

Returns:



662
663
664
665
 
# File 'lib/clever-ruby/api/data_api.rb', line 662

def get_district_for_school(id, opts = {})
  data, _status_code, _headers = get_district_for_school_with_http_info(id, opts)
  data
end

#get_district_for_school_admin(id, opts = {}) ⇒ DistrictResponse

Returns the district for a school admin

Parameters:

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

    the optional parameters

Returns:



712
713
714
715
 
# File 'lib/clever-ruby/api/data_api.rb', line 712

def get_district_for_school_admin(id, opts = {})
  data, _status_code, _headers = get_district_for_school_admin_with_http_info(id, opts)
  data
end

#get_district_for_school_admin_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a school admin

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/clever-ruby/api/data_api.rb', line 721

def get_district_for_school_admin_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_school_admin ...'
  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 DataApi.get_district_for_school_admin"
  end
  # resource path
  local_var_path = '/school_admins/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_school_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_school_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a school

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/clever-ruby/api/data_api.rb', line 671

def get_district_for_school_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_school ...'
  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 DataApi.get_district_for_school"
  end
  # resource path
  local_var_path = '/schools/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_section(id, opts = {}) ⇒ DistrictResponse

Returns the district for a section

Parameters:

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

    the optional parameters

Returns:



762
763
764
765
 
# File 'lib/clever-ruby/api/data_api.rb', line 762

def get_district_for_section(id, opts = {})
  data, _status_code, _headers = get_district_for_section_with_http_info(id, opts)
  data
end

#get_district_for_section_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a section

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/clever-ruby/api/data_api.rb', line 771

def get_district_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_section ...'
  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 DataApi.get_district_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_student(id, opts = {}) ⇒ DistrictResponse

Returns the district for a student

Parameters:

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

    the optional parameters

Returns:



812
813
814
815
 
# File 'lib/clever-ruby/api/data_api.rb', line 812

def get_district_for_student(id, opts = {})
  data, _status_code, _headers = get_district_for_student_with_http_info(id, opts)
  data
end

#get_district_for_student_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a student

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/clever-ruby/api/data_api.rb', line 821

def get_district_for_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_student ...'
  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 DataApi.get_district_for_student"
  end
  # resource path
  local_var_path = '/students/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_teacher(id, opts = {}) ⇒ DistrictResponse

Returns the district for a teacher

Parameters:

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

    the optional parameters

Returns:



862
863
864
865
 
# File 'lib/clever-ruby/api/data_api.rb', line 862

def get_district_for_teacher(id, opts = {})
  data, _status_code, _headers = get_district_for_teacher_with_http_info(id, opts)
  data
end

#get_district_for_teacher_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a teacher

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/clever-ruby/api/data_api.rb', line 871

def get_district_for_teacher_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_teacher ...'
  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 DataApi.get_district_for_teacher"
  end
  # resource path
  local_var_path = '/teachers/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_for_term(id, opts = {}) ⇒ DistrictResponse

Returns the district for a term

Parameters:

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

    the optional parameters

Returns:



912
913
914
915
 
# File 'lib/clever-ruby/api/data_api.rb', line 912

def get_district_for_term(id, opts = {})
  data, _status_code, _headers = get_district_for_term_with_http_info(id, opts)
  data
end

#get_district_for_term_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns the district for a term

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/clever-ruby/api/data_api.rb', line 921

def get_district_for_term_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district_for_term ...'
  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 DataApi.get_district_for_term"
  end
  # resource path
  local_var_path = '/terms/{id}/district'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district_for_term\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_district_with_http_info(id, opts = {}) ⇒ Array<(DistrictResponse, Fixnum, Hash)>

Returns a specific district

Parameters:

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

    the optional parameters

Returns:

  • (Array<(DistrictResponse, Fixnum, Hash)>) —

    DistrictResponse data, response status code and response headers



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/clever-ruby/api/data_api.rb', line 362

def get_district_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_district ...'
  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 DataApi.get_district"
  end
  # resource path
  local_var_path = '/districts/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_district\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_districts(opts = {}) ⇒ DistrictsResponse

Returns a list of districts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :count (String)

Returns:



962
963
964
965
 
# File 'lib/clever-ruby/api/data_api.rb', line 962

def get_districts(opts = {})
  data, _status_code, _headers = get_districts_with_http_info(opts)
  data
end

#get_districts_with_http_info(opts = {}) ⇒ Array<(DistrictsResponse, Fixnum, Hash)>

Returns a list of districts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :count (String)

Returns:

  • (Array<(DistrictsResponse, Fixnum, Hash)>) —

    DistrictsResponse data, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/clever-ruby/api/data_api.rb', line 971

def get_districts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_districts ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/districts'

  # query parameters
  query_params = {}
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'DistrictsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_districts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_school(id, opts = {}) ⇒ SchoolResponse

Returns a specific school

Parameters:

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

    the optional parameters

Returns:



1012
1013
1014
1015
 
# File 'lib/clever-ruby/api/data_api.rb', line 1012

def get_school(id, opts = {})
  data, _status_code, _headers = get_school_with_http_info(id, opts)
  data
end

#get_school_admin(id, opts = {}) ⇒ SchoolAdminResponse

Returns a specific school admin

Parameters:

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

    the optional parameters

Returns:



1062
1063
1064
1065
 
# File 'lib/clever-ruby/api/data_api.rb', line 1062

def get_school_admin(id, opts = {})
  data, _status_code, _headers = get_school_admin_with_http_info(id, opts)
  data
end

#get_school_admin_with_http_info(id, opts = {}) ⇒ Array<(SchoolAdminResponse, Fixnum, Hash)>

Returns a specific school admin

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SchoolAdminResponse, Fixnum, Hash)>) —

    SchoolAdminResponse data, response status code and response headers



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/clever-ruby/api/data_api.rb', line 1071

def get_school_admin_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_school_admin ...'
  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 DataApi.get_school_admin"
  end
  # resource path
  local_var_path = '/school_admins/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolAdminResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_school_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_school_admins(opts = {}) ⇒ SchoolAdminsResponse

Returns a list of school admins

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



1115
1116
1117
1118
 
# File 'lib/clever-ruby/api/data_api.rb', line 1115

def get_school_admins(opts = {})
  data, _status_code, _headers = get_school_admins_with_http_info(opts)
  data
end

#get_school_admins_with_http_info(opts = {}) ⇒ Array<(SchoolAdminsResponse, Fixnum, Hash)>

Returns a list of school admins

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(SchoolAdminsResponse, Fixnum, Hash)>) —

    SchoolAdminsResponse data, response status code and response headers



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/clever-ruby/api/data_api.rb', line 1127

def get_school_admins_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_school_admins ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/school_admins'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolAdminsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_school_admins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_school_for_section(id, opts = {}) ⇒ SchoolResponse

Returns the school for a section

Parameters:

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

    the optional parameters

Returns:



1171
1172
1173
1174
 
# File 'lib/clever-ruby/api/data_api.rb', line 1171

def get_school_for_section(id, opts = {})
  data, _status_code, _headers = get_school_for_section_with_http_info(id, opts)
  data
end

#get_school_for_section_with_http_info(id, opts = {}) ⇒ Array<(SchoolResponse, Fixnum, Hash)>

Returns the school for a section

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SchoolResponse, Fixnum, Hash)>) —

    SchoolResponse data, response status code and response headers



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/clever-ruby/api/data_api.rb', line 1180

def get_school_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_school_for_section ...'
  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 DataApi.get_school_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/school'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_school_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_school_for_student(id, opts = {}) ⇒ SchoolResponse

Returns the primary school for a student

Parameters:

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

    the optional parameters

Returns:



1221
1222
1223
1224
 
# File 'lib/clever-ruby/api/data_api.rb', line 1221

def get_school_for_student(id, opts = {})
  data, _status_code, _headers = get_school_for_student_with_http_info(id, opts)
  data
end

#get_school_for_student_with_http_info(id, opts = {}) ⇒ Array<(SchoolResponse, Fixnum, Hash)>

Returns the primary school for a student

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SchoolResponse, Fixnum, Hash)>) —

    SchoolResponse data, response status code and response headers



1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/clever-ruby/api/data_api.rb', line 1230

def get_school_for_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_school_for_student ...'
  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 DataApi.get_school_for_student"
  end
  # resource path
  local_var_path = '/students/{id}/school'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_school_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_school_for_teacher(id, opts = {}) ⇒ SchoolResponse

Retrieves school info for a teacher.

Parameters:

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

    the optional parameters

Returns:



1271
1272
1273
1274
 
# File 'lib/clever-ruby/api/data_api.rb', line 1271

def get_school_for_teacher(id, opts = {})
  data, _status_code, _headers = get_school_for_teacher_with_http_info(id, opts)
  data
end

#get_school_for_teacher_with_http_info(id, opts = {}) ⇒ Array<(SchoolResponse, Fixnum, Hash)>

Retrieves school info for a teacher.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SchoolResponse, Fixnum, Hash)>) —

    SchoolResponse data, response status code and response headers



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/clever-ruby/api/data_api.rb', line 1280

def get_school_for_teacher_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_school_for_teacher ...'
  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 DataApi.get_school_for_teacher"
  end
  # resource path
  local_var_path = '/teachers/{id}/school'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_school_for_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_school_with_http_info(id, opts = {}) ⇒ Array<(SchoolResponse, Fixnum, Hash)>

Returns a specific school

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SchoolResponse, Fixnum, Hash)>) —

    SchoolResponse data, response status code and response headers



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/clever-ruby/api/data_api.rb', line 1021

def get_school_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_school ...'
  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 DataApi.get_school"
  end
  # resource path
  local_var_path = '/schools/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schools(opts = {}) ⇒ SchoolsResponse

Returns a list of schools

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



1324
1325
1326
1327
 
# File 'lib/clever-ruby/api/data_api.rb', line 1324

def get_schools(opts = {})
  data, _status_code, _headers = get_schools_with_http_info(opts)
  data
end

#get_schools_for_school_admin(id, opts = {}) ⇒ SchoolsResponse

Returns the schools for a school admin

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1383
1384
1385
1386
 
# File 'lib/clever-ruby/api/data_api.rb', line 1383

def get_schools_for_school_admin(id, opts = {})
  data, _status_code, _headers = get_schools_for_school_admin_with_http_info(id, opts)
  data
end

#get_schools_for_school_admin_with_http_info(id, opts = {}) ⇒ Array<(SchoolsResponse, Fixnum, Hash)>

Returns the schools for a school admin

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SchoolsResponse, Fixnum, Hash)>) —

    SchoolsResponse data, response status code and response headers



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
 
# File 'lib/clever-ruby/api/data_api.rb', line 1395

def get_schools_for_school_admin_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_schools_for_school_admin ...'
  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 DataApi.get_schools_for_school_admin"
  end
  # resource path
  local_var_path = '/school_admins/{id}/schools'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_schools_for_school_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schools_for_student(id, opts = {}) ⇒ SchoolsResponse

Returns the schools for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1442
1443
1444
1445
 
# File 'lib/clever-ruby/api/data_api.rb', line 1442

def get_schools_for_student(id, opts = {})
  data, _status_code, _headers = get_schools_for_student_with_http_info(id, opts)
  data
end

#get_schools_for_student_with_http_info(id, opts = {}) ⇒ Array<(SchoolsResponse, Fixnum, Hash)>

Returns the schools for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SchoolsResponse, Fixnum, Hash)>) —

    SchoolsResponse data, response status code and response headers



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'lib/clever-ruby/api/data_api.rb', line 1454

def get_schools_for_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_schools_for_student ...'
  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 DataApi.get_schools_for_student"
  end
  # resource path
  local_var_path = '/students/{id}/schools'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_schools_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schools_for_teacher(id, opts = {}) ⇒ SchoolsResponse

Returns the schools for a teacher

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1501
1502
1503
1504
 
# File 'lib/clever-ruby/api/data_api.rb', line 1501

def get_schools_for_teacher(id, opts = {})
  data, _status_code, _headers = get_schools_for_teacher_with_http_info(id, opts)
  data
end

#get_schools_for_teacher_with_http_info(id, opts = {}) ⇒ Array<(SchoolsResponse, Fixnum, Hash)>

Returns the schools for a teacher

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SchoolsResponse, Fixnum, Hash)>) —

    SchoolsResponse data, response status code and response headers



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/clever-ruby/api/data_api.rb', line 1513

def get_schools_for_teacher_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_schools_for_teacher ...'
  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 DataApi.get_schools_for_teacher"
  end
  # resource path
  local_var_path = '/teachers/{id}/schools'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_schools_for_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schools_with_http_info(opts = {}) ⇒ Array<(SchoolsResponse, Fixnum, Hash)>

Returns a list of schools

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(SchoolsResponse, Fixnum, Hash)>) —

    SchoolsResponse data, response status code and response headers



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/clever-ruby/api/data_api.rb', line 1336

def get_schools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_schools ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/schools'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SchoolsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_schools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_section(id, opts = {}) ⇒ SectionResponse

Returns a specific section

Parameters:

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

    the optional parameters

Returns:



1557
1558
1559
1560
 
# File 'lib/clever-ruby/api/data_api.rb', line 1557

def get_section(id, opts = {})
  data, _status_code, _headers = get_section_with_http_info(id, opts)
  data
end

#get_section_with_http_info(id, opts = {}) ⇒ Array<(SectionResponse, Fixnum, Hash)>

Returns a specific section

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SectionResponse, Fixnum, Hash)>) —

    SectionResponse data, response status code and response headers



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/clever-ruby/api/data_api.rb', line 1566

def get_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_section ...'
  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 DataApi.get_section"
  end
  # resource path
  local_var_path = '/sections/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sections(opts = {}) ⇒ SectionsResponse

Returns a list of sections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



1610
1611
1612
1613
 
# File 'lib/clever-ruby/api/data_api.rb', line 1610

def get_sections(opts = {})
  data, _status_code, _headers = get_sections_with_http_info(opts)
  data
end

#get_sections_for_course(id, opts = {}) ⇒ SectionsResponse

Returns the sections for a Courses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1669
1670
1671
1672
 
# File 'lib/clever-ruby/api/data_api.rb', line 1669

def get_sections_for_course(id, opts = {})
  data, _status_code, _headers = get_sections_for_course_with_http_info(id, opts)
  data
end

#get_sections_for_course_with_http_info(id, opts = {}) ⇒ Array<(SectionsResponse, Fixnum, Hash)>

Returns the sections for a Courses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SectionsResponse, Fixnum, Hash)>) —

    SectionsResponse data, response status code and response headers



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
 
# File 'lib/clever-ruby/api/data_api.rb', line 1681

def get_sections_for_course_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_sections_for_course ...'
  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 DataApi.get_sections_for_course"
  end
  # resource path
  local_var_path = '/courses/{id}/sections'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_sections_for_course\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sections_for_school(id, opts = {}) ⇒ SectionsResponse

Returns the sections for a school

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1728
1729
1730
1731
 
# File 'lib/clever-ruby/api/data_api.rb', line 1728

def get_sections_for_school(id, opts = {})
  data, _status_code, _headers = get_sections_for_school_with_http_info(id, opts)
  data
end

#get_sections_for_school_with_http_info(id, opts = {}) ⇒ Array<(SectionsResponse, Fixnum, Hash)>

Returns the sections for a school

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SectionsResponse, Fixnum, Hash)>) —

    SectionsResponse data, response status code and response headers



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'lib/clever-ruby/api/data_api.rb', line 1740

def get_sections_for_school_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_sections_for_school ...'
  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 DataApi.get_sections_for_school"
  end
  # resource path
  local_var_path = '/schools/{id}/sections'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_sections_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sections_for_student(id, opts = {}) ⇒ SectionsResponse

Returns the sections for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1787
1788
1789
1790
 
# File 'lib/clever-ruby/api/data_api.rb', line 1787

def get_sections_for_student(id, opts = {})
  data, _status_code, _headers = get_sections_for_student_with_http_info(id, opts)
  data
end

#get_sections_for_student_with_http_info(id, opts = {}) ⇒ Array<(SectionsResponse, Fixnum, Hash)>

Returns the sections for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SectionsResponse, Fixnum, Hash)>) —

    SectionsResponse data, response status code and response headers



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/clever-ruby/api/data_api.rb', line 1799

def get_sections_for_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_sections_for_student ...'
  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 DataApi.get_sections_for_student"
  end
  # resource path
  local_var_path = '/students/{id}/sections'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_sections_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sections_for_teacher(id, opts = {}) ⇒ SectionsResponse

Returns the sections for a teacher

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1846
1847
1848
1849
 
# File 'lib/clever-ruby/api/data_api.rb', line 1846

def get_sections_for_teacher(id, opts = {})
  data, _status_code, _headers = get_sections_for_teacher_with_http_info(id, opts)
  data
end

#get_sections_for_teacher_with_http_info(id, opts = {}) ⇒ Array<(SectionsResponse, Fixnum, Hash)>

Returns the sections for a teacher

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SectionsResponse, Fixnum, Hash)>) —

    SectionsResponse data, response status code and response headers



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'lib/clever-ruby/api/data_api.rb', line 1858

def get_sections_for_teacher_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_sections_for_teacher ...'
  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 DataApi.get_sections_for_teacher"
  end
  # resource path
  local_var_path = '/teachers/{id}/sections'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_sections_for_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sections_for_term(id, opts = {}) ⇒ SectionsResponse

Returns the sections for a term

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



1905
1906
1907
1908
 
# File 'lib/clever-ruby/api/data_api.rb', line 1905

def get_sections_for_term(id, opts = {})
  data, _status_code, _headers = get_sections_for_term_with_http_info(id, opts)
  data
end

#get_sections_for_term_with_http_info(id, opts = {}) ⇒ Array<(SectionsResponse, Fixnum, Hash)>

Returns the sections for a term

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(SectionsResponse, Fixnum, Hash)>) —

    SectionsResponse data, response status code and response headers



1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
 
# File 'lib/clever-ruby/api/data_api.rb', line 1917

def get_sections_for_term_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_sections_for_term ...'
  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 DataApi.get_sections_for_term"
  end
  # resource path
  local_var_path = '/terms/{id}/sections'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_sections_for_term\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sections_with_http_info(opts = {}) ⇒ Array<(SectionsResponse, Fixnum, Hash)>

Returns a list of sections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(SectionsResponse, Fixnum, Hash)>) —

    SectionsResponse data, response status code and response headers



1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/clever-ruby/api/data_api.rb', line 1622

def get_sections_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_sections ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/sections'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'SectionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_sections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_student(id, opts = {}) ⇒ StudentResponse

Returns a specific student

Parameters:

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

    the optional parameters

Returns:



1961
1962
1963
1964
 
# File 'lib/clever-ruby/api/data_api.rb', line 1961

def get_student(id, opts = {})
  data, _status_code, _headers = get_student_with_http_info(id, opts)
  data
end

#get_student_with_http_info(id, opts = {}) ⇒ Array<(StudentResponse, Fixnum, Hash)>

Returns a specific student

Parameters:

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

    the optional parameters

Returns:

  • (Array<(StudentResponse, Fixnum, Hash)>) —

    StudentResponse data, response status code and response headers



1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/clever-ruby/api/data_api.rb', line 1970

def get_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_student ...'
  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 DataApi.get_student"
  end
  # resource path
  local_var_path = '/students/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'StudentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students(opts = {}) ⇒ StudentsResponse

Returns a list of students

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



2014
2015
2016
2017
 
# File 'lib/clever-ruby/api/data_api.rb', line 2014

def get_students(opts = {})
  data, _status_code, _headers = get_students_with_http_info(opts)
  data
end

#get_students_for_contact(id, opts = {}) ⇒ StudentsResponse

Returns the students for a student contact

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2073
2074
2075
2076
 
# File 'lib/clever-ruby/api/data_api.rb', line 2073

def get_students_for_contact(id, opts = {})
  data, _status_code, _headers = get_students_for_contact_with_http_info(id, opts)
  data
end

#get_students_for_contact_with_http_info(id, opts = {}) ⇒ Array<(StudentsResponse, Fixnum, Hash)>

Returns the students for a student contact

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(StudentsResponse, Fixnum, Hash)>) —

    StudentsResponse data, response status code and response headers



2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
 
# File 'lib/clever-ruby/api/data_api.rb', line 2085

def get_students_for_contact_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_students_for_contact ...'
  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 DataApi.get_students_for_contact"
  end
  # resource path
  local_var_path = '/contacts/{id}/students'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'StudentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_students_for_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_for_school(id, opts = {}) ⇒ StudentsResponse

Returns the students for a school

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2132
2133
2134
2135
 
# File 'lib/clever-ruby/api/data_api.rb', line 2132

def get_students_for_school(id, opts = {})
  data, _status_code, _headers = get_students_for_school_with_http_info(id, opts)
  data
end

#get_students_for_school_with_http_info(id, opts = {}) ⇒ Array<(StudentsResponse, Fixnum, Hash)>

Returns the students for a school

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(StudentsResponse, Fixnum, Hash)>) —

    StudentsResponse data, response status code and response headers



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
 
# File 'lib/clever-ruby/api/data_api.rb', line 2144

def get_students_for_school_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_students_for_school ...'
  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 DataApi.get_students_for_school"
  end
  # resource path
  local_var_path = '/schools/{id}/students'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'StudentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_students_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_for_section(id, opts = {}) ⇒ StudentsResponse

Returns the students for a section

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2191
2192
2193
2194
 
# File 'lib/clever-ruby/api/data_api.rb', line 2191

def get_students_for_section(id, opts = {})
  data, _status_code, _headers = get_students_for_section_with_http_info(id, opts)
  data
end

#get_students_for_section_with_http_info(id, opts = {}) ⇒ Array<(StudentsResponse, Fixnum, Hash)>

Returns the students for a section

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(StudentsResponse, Fixnum, Hash)>) —

    StudentsResponse data, response status code and response headers



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/clever-ruby/api/data_api.rb', line 2203

def get_students_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_students_for_section ...'
  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 DataApi.get_students_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/students'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'StudentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_students_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_for_teacher(id, opts = {}) ⇒ StudentsResponse

Returns the students for a teacher

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2250
2251
2252
2253
 
# File 'lib/clever-ruby/api/data_api.rb', line 2250

def get_students_for_teacher(id, opts = {})
  data, _status_code, _headers = get_students_for_teacher_with_http_info(id, opts)
  data
end

#get_students_for_teacher_with_http_info(id, opts = {}) ⇒ Array<(StudentsResponse, Fixnum, Hash)>

Returns the students for a teacher

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(StudentsResponse, Fixnum, Hash)>) —

    StudentsResponse data, response status code and response headers



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
 
# File 'lib/clever-ruby/api/data_api.rb', line 2262

def get_students_for_teacher_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_students_for_teacher ...'
  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 DataApi.get_students_for_teacher"
  end
  # resource path
  local_var_path = '/teachers/{id}/students'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'StudentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_students_for_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_with_http_info(opts = {}) ⇒ Array<(StudentsResponse, Fixnum, Hash)>

Returns a list of students

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(StudentsResponse, Fixnum, Hash)>) —

    StudentsResponse data, response status code and response headers



2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/clever-ruby/api/data_api.rb', line 2026

def get_students_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_students ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/students'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'StudentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_students\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_teacher(id, opts = {}) ⇒ TeacherResponse

Returns a specific teacher

Parameters:

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

    the optional parameters

Returns:



2306
2307
2308
2309
 
# File 'lib/clever-ruby/api/data_api.rb', line 2306

def get_teacher(id, opts = {})
  data, _status_code, _headers = get_teacher_with_http_info(id, opts)
  data
end

#get_teacher_for_section(id, opts = {}) ⇒ TeacherResponse

Returns the primary teacher for a section

Parameters:

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

    the optional parameters

Returns:



2356
2357
2358
2359
 
# File 'lib/clever-ruby/api/data_api.rb', line 2356

def get_teacher_for_section(id, opts = {})
  data, _status_code, _headers = get_teacher_for_section_with_http_info(id, opts)
  data
end

#get_teacher_for_section_with_http_info(id, opts = {}) ⇒ Array<(TeacherResponse, Fixnum, Hash)>

Returns the primary teacher for a section

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TeacherResponse, Fixnum, Hash)>) —

    TeacherResponse data, response status code and response headers



2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/clever-ruby/api/data_api.rb', line 2365

def get_teacher_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_teacher_for_section ...'
  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 DataApi.get_teacher_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/teacher'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TeacherResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_teacher_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_teacher_with_http_info(id, opts = {}) ⇒ Array<(TeacherResponse, Fixnum, Hash)>

Returns a specific teacher

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TeacherResponse, Fixnum, Hash)>) —

    TeacherResponse data, response status code and response headers



2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
 
# File 'lib/clever-ruby/api/data_api.rb', line 2315

def get_teacher_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_teacher ...'
  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 DataApi.get_teacher"
  end
  # resource path
  local_var_path = '/teachers/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TeacherResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_teachers(opts = {}) ⇒ TeachersResponse

Returns a list of teachers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



2409
2410
2411
2412
 
# File 'lib/clever-ruby/api/data_api.rb', line 2409

def get_teachers(opts = {})
  data, _status_code, _headers = get_teachers_with_http_info(opts)
  data
end

#get_teachers_for_school(id, opts = {}) ⇒ TeachersResponse

Returns the teachers for a school

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2468
2469
2470
2471
 
# File 'lib/clever-ruby/api/data_api.rb', line 2468

def get_teachers_for_school(id, opts = {})
  data, _status_code, _headers = get_teachers_for_school_with_http_info(id, opts)
  data
end

#get_teachers_for_school_with_http_info(id, opts = {}) ⇒ Array<(TeachersResponse, Fixnum, Hash)>

Returns the teachers for a school

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(TeachersResponse, Fixnum, Hash)>) —

    TeachersResponse data, response status code and response headers



2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
 
# File 'lib/clever-ruby/api/data_api.rb', line 2480

def get_teachers_for_school_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_teachers_for_school ...'
  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 DataApi.get_teachers_for_school"
  end
  # resource path
  local_var_path = '/schools/{id}/teachers'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TeachersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_teachers_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_teachers_for_section(id, opts = {}) ⇒ TeachersResponse

Returns the teachers for a section

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2527
2528
2529
2530
 
# File 'lib/clever-ruby/api/data_api.rb', line 2527

def get_teachers_for_section(id, opts = {})
  data, _status_code, _headers = get_teachers_for_section_with_http_info(id, opts)
  data
end

#get_teachers_for_section_with_http_info(id, opts = {}) ⇒ Array<(TeachersResponse, Fixnum, Hash)>

Returns the teachers for a section

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(TeachersResponse, Fixnum, Hash)>) —

    TeachersResponse data, response status code and response headers



2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'lib/clever-ruby/api/data_api.rb', line 2539

def get_teachers_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_teachers_for_section ...'
  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 DataApi.get_teachers_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/teachers'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TeachersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_teachers_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_teachers_for_student(id, opts = {}) ⇒ TeachersResponse

Returns the teachers for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:



2586
2587
2588
2589
 
# File 'lib/clever-ruby/api/data_api.rb', line 2586

def get_teachers_for_student(id, opts = {})
  data, _status_code, _headers = get_teachers_for_student_with_http_info(id, opts)
  data
end

#get_teachers_for_student_with_http_info(id, opts = {}) ⇒ Array<(TeachersResponse, Fixnum, Hash)>

Returns the teachers for a student

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)

Returns:

  • (Array<(TeachersResponse, Fixnum, Hash)>) —

    TeachersResponse data, response status code and response headers



2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
 
# File 'lib/clever-ruby/api/data_api.rb', line 2598

def get_teachers_for_student_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_teachers_for_student ...'
  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 DataApi.get_teachers_for_student"
  end
  # resource path
  local_var_path = '/students/{id}/teachers'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TeachersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_teachers_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_teachers_with_http_info(opts = {}) ⇒ Array<(TeachersResponse, Fixnum, Hash)>

Returns a list of teachers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(TeachersResponse, Fixnum, Hash)>) —

    TeachersResponse data, response status code and response headers



2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/clever-ruby/api/data_api.rb', line 2421

def get_teachers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_teachers ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/teachers'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TeachersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_teachers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_term(id, opts = {}) ⇒ TermResponse

Returns a specific term

Parameters:

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

    the optional parameters

Returns:



2642
2643
2644
2645
 
# File 'lib/clever-ruby/api/data_api.rb', line 2642

def get_term(id, opts = {})
  data, _status_code, _headers = get_term_with_http_info(id, opts)
  data
end

#get_term_for_section(id, opts = {}) ⇒ TermResponse

Returns the term for a section

Parameters:

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

    the optional parameters

Returns:



2692
2693
2694
2695
 
# File 'lib/clever-ruby/api/data_api.rb', line 2692

def get_term_for_section(id, opts = {})
  data, _status_code, _headers = get_term_for_section_with_http_info(id, opts)
  data
end

#get_term_for_section_with_http_info(id, opts = {}) ⇒ Array<(TermResponse, Fixnum, Hash)>

Returns the term for a section

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TermResponse, Fixnum, Hash)>) —

    TermResponse data, response status code and response headers



2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
 
# File 'lib/clever-ruby/api/data_api.rb', line 2701

def get_term_for_section_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_term_for_section ...'
  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 DataApi.get_term_for_section"
  end
  # resource path
  local_var_path = '/sections/{id}/term'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TermResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_term_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_term_with_http_info(id, opts = {}) ⇒ Array<(TermResponse, Fixnum, Hash)>

Returns a specific term

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TermResponse, Fixnum, Hash)>) —

    TermResponse data, response status code and response headers



2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/clever-ruby/api/data_api.rb', line 2651

def get_term_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_term ...'
  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 DataApi.get_term"
  end
  # resource path
  local_var_path = '/terms/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TermResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_term\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_terms(opts = {}) ⇒ TermsResponse

Returns a list of terms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:



2745
2746
2747
2748
 
# File 'lib/clever-ruby/api/data_api.rb', line 2745

def get_terms(opts = {})
  data, _status_code, _headers = get_terms_with_http_info(opts)
  data
end

#get_terms_with_http_info(opts = {}) ⇒ Array<(TermsResponse, Fixnum, Hash)>

Returns a list of terms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :starting_after (String)
  • :ending_before (String)
  • :count (String)

Returns:

  • (Array<(TermsResponse, Fixnum, Hash)>) —

    TermsResponse data, response status code and response headers



2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'lib/clever-ruby/api/data_api.rb', line 2757

def get_terms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataApi.get_terms ...'
  end
  if @api_client.config.client_side_validation && opts[:'count'] && !['', 'true'].include?(opts[:'count'])
    fail ArgumentError, 'invalid value for "count", must be one of , true'
  end
  # resource path
  local_var_path = '/terms'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TermsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataApi#get_terms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end