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:



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

def get_contact(id, opts = {})
  data, _status_code, _headers = get_contact_with_http_info(id, opts)
  return 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



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

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)

Returns:



83
84
85
86
 
# File 'lib/clever-ruby/api/data_api.rb', line 83

def get_contacts(opts = {})
  data, _status_code, _headers = get_contacts_with_http_info(opts)
  return 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:



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

def get_contacts_for_student(id, opts = {})
  data, _status_code, _headers = get_contacts_for_student_with_http_info(id, opts)
  return 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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/clever-ruby/api/data_api.rb', line 153

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)

Returns:

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

    ContactsResponse data, response status code and response headers



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 95

def get_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_contacts ..."
  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?

  # 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:



199
200
201
202
 
# File 'lib/clever-ruby/api/data_api.rb', line 199

def get_course(id, opts = {})
  data, _status_code, _headers = get_course_with_http_info(id, opts)
  return 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:



252
253
254
255
 
# File 'lib/clever-ruby/api/data_api.rb', line 252

def get_course_for_section(id, opts = {})
  data, _status_code, _headers = get_course_for_section_with_http_info(id, opts)
  return 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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/clever-ruby/api/data_api.rb', line 262

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/clever-ruby/api/data_api.rb', line 209

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)

Returns:



307
308
309
310
 
# File 'lib/clever-ruby/api/data_api.rb', line 307

def get_courses(opts = {})
  data, _status_code, _headers = get_courses_with_http_info(opts)
  return 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)

Returns:

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

    CoursesResponse data, response status code and response headers



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
349
350
351
352
353
354
 
# File 'lib/clever-ruby/api/data_api.rb', line 319

def get_courses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_courses ..."
  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?

  # 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:



361
362
363
364
 
# File 'lib/clever-ruby/api/data_api.rb', line 361

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

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

Returns a specific district admin

Parameters:

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

    the optional parameters

Returns:



414
415
416
417
 
# File 'lib/clever-ruby/api/data_api.rb', line 414

def get_district_admin(id, opts = {})
  data, _status_code, _headers = get_district_admin_with_http_info(id, opts)
  return 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



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
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/clever-ruby/api/data_api.rb', line 424

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)

Returns:



469
470
471
472
 
# File 'lib/clever-ruby/api/data_api.rb', line 469

def get_district_admins(opts = {})
  data, _status_code, _headers = get_district_admins_with_http_info(opts)
  return 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)

Returns:

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

    DistrictAdminsResponse data, response status code and response headers



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
508
509
510
511
512
513
514
515
516
 
# File 'lib/clever-ruby/api/data_api.rb', line 481

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
  # 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?

  # 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:



523
524
525
526
 
# File 'lib/clever-ruby/api/data_api.rb', line 523

def get_district_for_contact(id, opts = {})
  data, _status_code, _headers = get_district_for_contact_with_http_info(id, opts)
  return 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



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
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/clever-ruby/api/data_api.rb', line 533

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:



576
577
578
579
 
# File 'lib/clever-ruby/api/data_api.rb', line 576

def get_district_for_course(id, opts = {})
  data, _status_code, _headers = get_district_for_course_with_http_info(id, opts)
  return 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



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/clever-ruby/api/data_api.rb', line 586

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:



629
630
631
632
 
# File 'lib/clever-ruby/api/data_api.rb', line 629

def get_district_for_district_admin(id, opts = {})
  data, _status_code, _headers = get_district_for_district_admin_with_http_info(id, opts)
  return 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



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/clever-ruby/api/data_api.rb', line 639

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:



682
683
684
685
 
# File 'lib/clever-ruby/api/data_api.rb', line 682

def get_district_for_school(id, opts = {})
  data, _status_code, _headers = get_district_for_school_with_http_info(id, opts)
  return 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:



735
736
737
738
 
# File 'lib/clever-ruby/api/data_api.rb', line 735

def get_district_for_school_admin(id, opts = {})
  data, _status_code, _headers = get_district_for_school_admin_with_http_info(id, opts)
  return 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



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/clever-ruby/api/data_api.rb', line 745

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



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/clever-ruby/api/data_api.rb', line 692

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:



788
789
790
791
 
# File 'lib/clever-ruby/api/data_api.rb', line 788

def get_district_for_section(id, opts = {})
  data, _status_code, _headers = get_district_for_section_with_http_info(id, opts)
  return 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



798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/clever-ruby/api/data_api.rb', line 798

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:



841
842
843
844
 
# File 'lib/clever-ruby/api/data_api.rb', line 841

def get_district_for_student(id, opts = {})
  data, _status_code, _headers = get_district_for_student_with_http_info(id, opts)
  return 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



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/clever-ruby/api/data_api.rb', line 851

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:



894
895
896
897
 
# File 'lib/clever-ruby/api/data_api.rb', line 894

def get_district_for_teacher(id, opts = {})
  data, _status_code, _headers = get_district_for_teacher_with_http_info(id, opts)
  return 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



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/clever-ruby/api/data_api.rb', line 904

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:



947
948
949
950
 
# File 'lib/clever-ruby/api/data_api.rb', line 947

def get_district_for_term(id, opts = {})
  data, _status_code, _headers = get_district_for_term_with_http_info(id, opts)
  return 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



957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
 
# File 'lib/clever-ruby/api/data_api.rb', line 957

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



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
399
400
401
402
403
404
405
406
407
 
# File 'lib/clever-ruby/api/data_api.rb', line 371

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

Returns:



999
1000
1001
1002
 
# File 'lib/clever-ruby/api/data_api.rb', line 999

def get_districts(opts = {})
  data, _status_code, _headers = get_districts_with_http_info(opts)
  return 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

Returns:

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

    DistrictsResponse data, response status code and response headers



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/clever-ruby/api/data_api.rb', line 1008

def get_districts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_districts ..."
  end
  # resource path
  local_var_path = "/districts"

  # 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 => '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:



1047
1048
1049
1050
 
# File 'lib/clever-ruby/api/data_api.rb', line 1047

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

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

Returns a specific school admin

Parameters:

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

    the optional parameters

Returns:



1100
1101
1102
1103
 
# File 'lib/clever-ruby/api/data_api.rb', line 1100

def get_school_admin(id, opts = {})
  data, _status_code, _headers = get_school_admin_with_http_info(id, opts)
  return 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



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/clever-ruby/api/data_api.rb', line 1110

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)

Returns:



1155
1156
1157
1158
 
# File 'lib/clever-ruby/api/data_api.rb', line 1155

def get_school_admins(opts = {})
  data, _status_code, _headers = get_school_admins_with_http_info(opts)
  return 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)

Returns:

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

    SchoolAdminsResponse data, response status code and response headers



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/clever-ruby/api/data_api.rb', line 1167

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
  # 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?

  # 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:



1209
1210
1211
1212
 
# File 'lib/clever-ruby/api/data_api.rb', line 1209

def get_school_for_section(id, opts = {})
  data, _status_code, _headers = get_school_for_section_with_http_info(id, opts)
  return 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



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 1219

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:



1262
1263
1264
1265
 
# File 'lib/clever-ruby/api/data_api.rb', line 1262

def get_school_for_student(id, opts = {})
  data, _status_code, _headers = get_school_for_student_with_http_info(id, opts)
  return 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



1272
1273
1274
1275
1276
1277
1278
1279
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 1272

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:



1315
1316
1317
1318
 
# File 'lib/clever-ruby/api/data_api.rb', line 1315

def get_school_for_teacher(id, opts = {})
  data, _status_code, _headers = get_school_for_teacher_with_http_info(id, opts)
  return 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



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 1325

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



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/clever-ruby/api/data_api.rb', line 1057

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)

Returns:



1370
1371
1372
1373
 
# File 'lib/clever-ruby/api/data_api.rb', line 1370

def get_schools(opts = {})
  data, _status_code, _headers = get_schools_with_http_info(opts)
  return 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:



1427
1428
1429
1430
 
# File 'lib/clever-ruby/api/data_api.rb', line 1427

def get_schools_for_school_admin(id, opts = {})
  data, _status_code, _headers = get_schools_for_school_admin_with_http_info(id, opts)
  return 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



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 1440

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:



1489
1490
1491
1492
 
# File 'lib/clever-ruby/api/data_api.rb', line 1489

def get_schools_for_student(id, opts = {})
  data, _status_code, _headers = get_schools_for_student_with_http_info(id, opts)
  return 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



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 1502

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:



1551
1552
1553
1554
 
# File 'lib/clever-ruby/api/data_api.rb', line 1551

def get_schools_for_teacher(id, opts = {})
  data, _status_code, _headers = get_schools_for_teacher_with_http_info(id, opts)
  return 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



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

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)

Returns:

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

    SchoolsResponse data, response status code and response headers



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/clever-ruby/api/data_api.rb', line 1382

def get_schools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_schools ..."
  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?

  # 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:



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

def get_section(id, opts = {})
  data, _status_code, _headers = get_section_with_http_info(id, opts)
  return 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



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

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)

Returns:



1665
1666
1667
1668
 
# File 'lib/clever-ruby/api/data_api.rb', line 1665

def get_sections(opts = {})
  data, _status_code, _headers = get_sections_with_http_info(opts)
  return 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:



1722
1723
1724
1725
 
# File 'lib/clever-ruby/api/data_api.rb', line 1722

def get_sections_for_course(id, opts = {})
  data, _status_code, _headers = get_sections_for_course_with_http_info(id, opts)
  return 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



1735
1736
1737
1738
1739
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 1735

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:



1784
1785
1786
1787
 
# File 'lib/clever-ruby/api/data_api.rb', line 1784

def get_sections_for_school(id, opts = {})
  data, _status_code, _headers = get_sections_for_school_with_http_info(id, opts)
  return 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



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

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:



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

def get_sections_for_student(id, opts = {})
  data, _status_code, _headers = get_sections_for_student_with_http_info(id, opts)
  return 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



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

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:



1908
1909
1910
1911
 
# File 'lib/clever-ruby/api/data_api.rb', line 1908

def get_sections_for_teacher(id, opts = {})
  data, _status_code, _headers = get_sections_for_teacher_with_http_info(id, opts)
  return 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



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
1957
1958
1959
1960
 
# File 'lib/clever-ruby/api/data_api.rb', line 1921

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:



1970
1971
1972
1973
 
# File 'lib/clever-ruby/api/data_api.rb', line 1970

def get_sections_for_term(id, opts = {})
  data, _status_code, _headers = get_sections_for_term_with_http_info(id, opts)
  return 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



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 
# File 'lib/clever-ruby/api/data_api.rb', line 1983

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)

Returns:

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

    SectionsResponse data, response status code and response headers



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

def get_sections_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_sections ..."
  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?

  # 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:



2029
2030
2031
2032
 
# File 'lib/clever-ruby/api/data_api.rb', line 2029

def get_student(id, opts = {})
  data, _status_code, _headers = get_student_with_http_info(id, opts)
  return 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



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
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
 
# File 'lib/clever-ruby/api/data_api.rb', line 2039

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)

Returns:



2084
2085
2086
2087
 
# File 'lib/clever-ruby/api/data_api.rb', line 2084

def get_students(opts = {})
  data, _status_code, _headers = get_students_with_http_info(opts)
  return 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:



2141
2142
2143
2144
 
# File 'lib/clever-ruby/api/data_api.rb', line 2141

def get_students_for_contact(id, opts = {})
  data, _status_code, _headers = get_students_for_contact_with_http_info(id, opts)
  return 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



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
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
 
# File 'lib/clever-ruby/api/data_api.rb', line 2154

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:



2203
2204
2205
2206
 
# File 'lib/clever-ruby/api/data_api.rb', line 2203

def get_students_for_school(id, opts = {})
  data, _status_code, _headers = get_students_for_school_with_http_info(id, opts)
  return 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



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
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
 
# File 'lib/clever-ruby/api/data_api.rb', line 2216

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:



2265
2266
2267
2268
 
# File 'lib/clever-ruby/api/data_api.rb', line 2265

def get_students_for_section(id, opts = {})
  data, _status_code, _headers = get_students_for_section_with_http_info(id, opts)
  return 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



2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
 
# File 'lib/clever-ruby/api/data_api.rb', line 2278

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:



2327
2328
2329
2330
 
# File 'lib/clever-ruby/api/data_api.rb', line 2327

def get_students_for_teacher(id, opts = {})
  data, _status_code, _headers = get_students_for_teacher_with_http_info(id, opts)
  return 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



2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
 
# File 'lib/clever-ruby/api/data_api.rb', line 2340

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)

Returns:

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

    StudentsResponse data, response status code and response headers



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
2125
2126
2127
2128
2129
2130
2131
 
# File 'lib/clever-ruby/api/data_api.rb', line 2096

def get_students_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_students ..."
  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?

  # 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:



2386
2387
2388
2389
 
# File 'lib/clever-ruby/api/data_api.rb', line 2386

def get_teacher(id, opts = {})
  data, _status_code, _headers = get_teacher_with_http_info(id, opts)
  return 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:



2439
2440
2441
2442
 
# File 'lib/clever-ruby/api/data_api.rb', line 2439

def get_teacher_for_section(id, opts = {})
  data, _status_code, _headers = get_teacher_for_section_with_http_info(id, opts)
  return 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



2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
 
# File 'lib/clever-ruby/api/data_api.rb', line 2449

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



2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'lib/clever-ruby/api/data_api.rb', line 2396

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)

Returns:



2494
2495
2496
2497
 
# File 'lib/clever-ruby/api/data_api.rb', line 2494

def get_teachers(opts = {})
  data, _status_code, _headers = get_teachers_with_http_info(opts)
  return 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:



2551
2552
2553
2554
 
# File 'lib/clever-ruby/api/data_api.rb', line 2551

def get_teachers_for_school(id, opts = {})
  data, _status_code, _headers = get_teachers_for_school_with_http_info(id, opts)
  return 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



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
 
# File 'lib/clever-ruby/api/data_api.rb', line 2564

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:



2613
2614
2615
2616
 
# File 'lib/clever-ruby/api/data_api.rb', line 2613

def get_teachers_for_section(id, opts = {})
  data, _status_code, _headers = get_teachers_for_section_with_http_info(id, opts)
  return 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



2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
 
# File 'lib/clever-ruby/api/data_api.rb', line 2626

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:



2675
2676
2677
2678
 
# File 'lib/clever-ruby/api/data_api.rb', line 2675

def get_teachers_for_student(id, opts = {})
  data, _status_code, _headers = get_teachers_for_student_with_http_info(id, opts)
  return 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



2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
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
 
# File 'lib/clever-ruby/api/data_api.rb', line 2688

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)

Returns:

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

    TeachersResponse data, response status code and response headers



2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/clever-ruby/api/data_api.rb', line 2506

def get_teachers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_teachers ..."
  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?

  # 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:



2734
2735
2736
2737
 
# File 'lib/clever-ruby/api/data_api.rb', line 2734

def get_term(id, opts = {})
  data, _status_code, _headers = get_term_with_http_info(id, opts)
  return 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:



2787
2788
2789
2790
 
# File 'lib/clever-ruby/api/data_api.rb', line 2787

def get_term_for_section(id, opts = {})
  data, _status_code, _headers = get_term_for_section_with_http_info(id, opts)
  return 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



2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
 
# File 'lib/clever-ruby/api/data_api.rb', line 2797

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



2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
 
# File 'lib/clever-ruby/api/data_api.rb', line 2744

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)

Returns:



2842
2843
2844
2845
 
# File 'lib/clever-ruby/api/data_api.rb', line 2842

def get_terms(opts = {})
  data, _status_code, _headers = get_terms_with_http_info(opts)
  return 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)

Returns:

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

    TermsResponse data, response status code and response headers



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
 
# File 'lib/clever-ruby/api/data_api.rb', line 2854

def get_terms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataApi.get_terms ..."
  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?

  # 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