commonlit-clever-ruby 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +129 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +73 -0
  5. data/LICENSE +190 -0
  6. data/Makefile +10 -0
  7. data/README.md +265 -0
  8. data/Rakefile +8 -0
  9. data/clever-ruby.gemspec +46 -0
  10. data/docs/AdminName.md +9 -0
  11. data/docs/BadRequest.md +8 -0
  12. data/docs/Contact.md +17 -0
  13. data/docs/ContactObject.md +8 -0
  14. data/docs/ContactResponse.md +8 -0
  15. data/docs/ContactsCreated.md +11 -0
  16. data/docs/ContactsDeleted.md +11 -0
  17. data/docs/ContactsResponse.md +9 -0
  18. data/docs/ContactsUpdated.md +12 -0
  19. data/docs/Course.md +11 -0
  20. data/docs/CourseObject.md +8 -0
  21. data/docs/CourseResponse.md +8 -0
  22. data/docs/CoursesCreated.md +11 -0
  23. data/docs/CoursesDeleted.md +11 -0
  24. data/docs/CoursesResponse.md +9 -0
  25. data/docs/CoursesUpdated.md +12 -0
  26. data/docs/Credentials.md +8 -0
  27. data/docs/DataApi.md +2852 -0
  28. data/docs/District.md +21 -0
  29. data/docs/DistrictAdmin.md +12 -0
  30. data/docs/DistrictAdminObject.md +8 -0
  31. data/docs/DistrictAdminResponse.md +8 -0
  32. data/docs/DistrictAdminsResponse.md +9 -0
  33. data/docs/DistrictObject.md +8 -0
  34. data/docs/DistrictResponse.md +8 -0
  35. data/docs/DistrictadminsCreated.md +11 -0
  36. data/docs/DistrictadminsDeleted.md +11 -0
  37. data/docs/DistrictadminsUpdated.md +12 -0
  38. data/docs/DistrictsCreated.md +11 -0
  39. data/docs/DistrictsDeleted.md +11 -0
  40. data/docs/DistrictsResponse.md +9 -0
  41. data/docs/DistrictsUpdated.md +12 -0
  42. data/docs/Event.md +10 -0
  43. data/docs/EventResponse.md +8 -0
  44. data/docs/EventsApi.md +121 -0
  45. data/docs/EventsResponse.md +9 -0
  46. data/docs/InternalError.md +8 -0
  47. data/docs/Link.md +9 -0
  48. data/docs/Location.md +13 -0
  49. data/docs/Name.md +10 -0
  50. data/docs/NotFound.md +8 -0
  51. data/docs/Principal.md +9 -0
  52. data/docs/School.md +23 -0
  53. data/docs/SchoolAdmin.md +17 -0
  54. data/docs/SchoolAdminObject.md +8 -0
  55. data/docs/SchoolAdminResponse.md +8 -0
  56. data/docs/SchoolAdminsResponse.md +9 -0
  57. data/docs/SchoolEnrollment.md +10 -0
  58. data/docs/SchoolObject.md +8 -0
  59. data/docs/SchoolResponse.md +8 -0
  60. data/docs/SchooladminsCreated.md +11 -0
  61. data/docs/SchooladminsDeleted.md +11 -0
  62. data/docs/SchooladminsUpdated.md +12 -0
  63. data/docs/SchoolsCreated.md +11 -0
  64. data/docs/SchoolsDeleted.md +11 -0
  65. data/docs/SchoolsResponse.md +9 -0
  66. data/docs/SchoolsUpdated.md +12 -0
  67. data/docs/Section.md +24 -0
  68. data/docs/SectionObject.md +8 -0
  69. data/docs/SectionResponse.md +8 -0
  70. data/docs/SectionsCreated.md +11 -0
  71. data/docs/SectionsDeleted.md +11 -0
  72. data/docs/SectionsResponse.md +9 -0
  73. data/docs/SectionsUpdated.md +12 -0
  74. data/docs/Student.md +33 -0
  75. data/docs/StudentObject.md +8 -0
  76. data/docs/StudentResponse.md +8 -0
  77. data/docs/StudentsCreated.md +11 -0
  78. data/docs/StudentsDeleted.md +11 -0
  79. data/docs/StudentsResponse.md +9 -0
  80. data/docs/StudentsUpdated.md +12 -0
  81. data/docs/Teacher.md +21 -0
  82. data/docs/TeacherObject.md +8 -0
  83. data/docs/TeacherResponse.md +8 -0
  84. data/docs/TeachersCreated.md +11 -0
  85. data/docs/TeachersDeleted.md +11 -0
  86. data/docs/TeachersResponse.md +9 -0
  87. data/docs/TeachersUpdated.md +12 -0
  88. data/docs/Term.md +12 -0
  89. data/docs/TermObject.md +8 -0
  90. data/docs/TermResponse.md +8 -0
  91. data/docs/TermsCreated.md +11 -0
  92. data/docs/TermsDeleted.md +11 -0
  93. data/docs/TermsResponse.md +9 -0
  94. data/docs/TermsUpdated.md +12 -0
  95. data/git_push.sh +55 -0
  96. data/lib/clever-ruby.rb +124 -0
  97. data/lib/clever-ruby/api/data_api.rb +2798 -0
  98. data/lib/clever-ruby/api/events_api.rb +132 -0
  99. data/lib/clever-ruby/api_client.rb +414 -0
  100. data/lib/clever-ruby/api_error.rb +38 -0
  101. data/lib/clever-ruby/configuration.rb +209 -0
  102. data/lib/clever-ruby/models/admin_name.rb +193 -0
  103. data/lib/clever-ruby/models/bad_request.rb +184 -0
  104. data/lib/clever-ruby/models/contact.rb +325 -0
  105. data/lib/clever-ruby/models/contact_object.rb +184 -0
  106. data/lib/clever-ruby/models/contact_response.rb +184 -0
  107. data/lib/clever-ruby/models/contacts_created.rb +221 -0
  108. data/lib/clever-ruby/models/contacts_deleted.rb +221 -0
  109. data/lib/clever-ruby/models/contacts_response.rb +197 -0
  110. data/lib/clever-ruby/models/contacts_updated.rb +221 -0
  111. data/lib/clever-ruby/models/course.rb +211 -0
  112. data/lib/clever-ruby/models/course_object.rb +184 -0
  113. data/lib/clever-ruby/models/course_response.rb +184 -0
  114. data/lib/clever-ruby/models/courses_created.rb +221 -0
  115. data/lib/clever-ruby/models/courses_deleted.rb +221 -0
  116. data/lib/clever-ruby/models/courses_response.rb +197 -0
  117. data/lib/clever-ruby/models/courses_updated.rb +221 -0
  118. data/lib/clever-ruby/models/credentials.rb +184 -0
  119. data/lib/clever-ruby/models/district.rb +337 -0
  120. data/lib/clever-ruby/models/district_admin.rb +220 -0
  121. data/lib/clever-ruby/models/district_admin_object.rb +184 -0
  122. data/lib/clever-ruby/models/district_admin_response.rb +184 -0
  123. data/lib/clever-ruby/models/district_admins_response.rb +197 -0
  124. data/lib/clever-ruby/models/district_object.rb +184 -0
  125. data/lib/clever-ruby/models/district_response.rb +184 -0
  126. data/lib/clever-ruby/models/districtadmins_created.rb +221 -0
  127. data/lib/clever-ruby/models/districtadmins_deleted.rb +221 -0
  128. data/lib/clever-ruby/models/districtadmins_updated.rb +221 -0
  129. data/lib/clever-ruby/models/districts_created.rb +221 -0
  130. data/lib/clever-ruby/models/districts_deleted.rb +221 -0
  131. data/lib/clever-ruby/models/districts_response.rb +197 -0
  132. data/lib/clever-ruby/models/districts_updated.rb +221 -0
  133. data/lib/clever-ruby/models/event.rb +207 -0
  134. data/lib/clever-ruby/models/event_response.rb +184 -0
  135. data/lib/clever-ruby/models/events_response.rb +197 -0
  136. data/lib/clever-ruby/models/internal_error.rb +184 -0
  137. data/lib/clever-ruby/models/link.rb +227 -0
  138. data/lib/clever-ruby/models/location.rb +229 -0
  139. data/lib/clever-ruby/models/name.rb +202 -0
  140. data/lib/clever-ruby/models/not_found.rb +184 -0
  141. data/lib/clever-ruby/models/principal.rb +193 -0
  142. data/lib/clever-ruby/models/school.rb +365 -0
  143. data/lib/clever-ruby/models/school_admin.rb +267 -0
  144. data/lib/clever-ruby/models/school_admin_object.rb +184 -0
  145. data/lib/clever-ruby/models/school_admin_response.rb +184 -0
  146. data/lib/clever-ruby/models/school_admins_response.rb +197 -0
  147. data/lib/clever-ruby/models/school_enrollment.rb +202 -0
  148. data/lib/clever-ruby/models/school_object.rb +184 -0
  149. data/lib/clever-ruby/models/school_response.rb +184 -0
  150. data/lib/clever-ruby/models/schooladmins_created.rb +221 -0
  151. data/lib/clever-ruby/models/schooladmins_deleted.rb +221 -0
  152. data/lib/clever-ruby/models/schooladmins_updated.rb +221 -0
  153. data/lib/clever-ruby/models/schools_created.rb +221 -0
  154. data/lib/clever-ruby/models/schools_deleted.rb +221 -0
  155. data/lib/clever-ruby/models/schools_response.rb +197 -0
  156. data/lib/clever-ruby/models/schools_updated.rb +221 -0
  157. data/lib/clever-ruby/models/section.rb +378 -0
  158. data/lib/clever-ruby/models/section_object.rb +184 -0
  159. data/lib/clever-ruby/models/section_response.rb +184 -0
  160. data/lib/clever-ruby/models/sections_created.rb +221 -0
  161. data/lib/clever-ruby/models/sections_deleted.rb +221 -0
  162. data/lib/clever-ruby/models/sections_response.rb +197 -0
  163. data/lib/clever-ruby/models/sections_updated.rb +221 -0
  164. data/lib/clever-ruby/models/student.rb +507 -0
  165. data/lib/clever-ruby/models/student_object.rb +184 -0
  166. data/lib/clever-ruby/models/student_response.rb +184 -0
  167. data/lib/clever-ruby/models/students_created.rb +221 -0
  168. data/lib/clever-ruby/models/students_deleted.rb +221 -0
  169. data/lib/clever-ruby/models/students_response.rb +197 -0
  170. data/lib/clever-ruby/models/students_updated.rb +221 -0
  171. data/lib/clever-ruby/models/teacher.rb +303 -0
  172. data/lib/clever-ruby/models/teacher_object.rb +184 -0
  173. data/lib/clever-ruby/models/teacher_response.rb +184 -0
  174. data/lib/clever-ruby/models/teachers_created.rb +221 -0
  175. data/lib/clever-ruby/models/teachers_deleted.rb +221 -0
  176. data/lib/clever-ruby/models/teachers_response.rb +197 -0
  177. data/lib/clever-ruby/models/teachers_updated.rb +221 -0
  178. data/lib/clever-ruby/models/term.rb +220 -0
  179. data/lib/clever-ruby/models/term_object.rb +184 -0
  180. data/lib/clever-ruby/models/term_response.rb +184 -0
  181. data/lib/clever-ruby/models/terms_created.rb +221 -0
  182. data/lib/clever-ruby/models/terms_deleted.rb +221 -0
  183. data/lib/clever-ruby/models/terms_response.rb +197 -0
  184. data/lib/clever-ruby/models/terms_updated.rb +221 -0
  185. data/lib/clever-ruby/version.rb +15 -0
  186. data/override/README-extension.md +31 -0
  187. data/override/api_client.rb +414 -0
  188. data/override/models/contacts_created.rb +221 -0
  189. data/override/models/contacts_deleted.rb +221 -0
  190. data/override/models/contacts_updated.rb +221 -0
  191. data/override/models/courses_created.rb +221 -0
  192. data/override/models/courses_deleted.rb +221 -0
  193. data/override/models/courses_updated.rb +221 -0
  194. data/override/models/districtadmins_created.rb +221 -0
  195. data/override/models/districtadmins_deleted.rb +221 -0
  196. data/override/models/districtadmins_updated.rb +221 -0
  197. data/override/models/districts_created.rb +221 -0
  198. data/override/models/districts_deleted.rb +221 -0
  199. data/override/models/districts_updated.rb +221 -0
  200. data/override/models/schooladmins_created.rb +221 -0
  201. data/override/models/schooladmins_deleted.rb +221 -0
  202. data/override/models/schooladmins_updated.rb +221 -0
  203. data/override/models/schools_created.rb +221 -0
  204. data/override/models/schools_deleted.rb +221 -0
  205. data/override/models/schools_updated.rb +221 -0
  206. data/override/models/sections_created.rb +221 -0
  207. data/override/models/sections_deleted.rb +221 -0
  208. data/override/models/sections_updated.rb +221 -0
  209. data/override/models/students_created.rb +221 -0
  210. data/override/models/students_deleted.rb +221 -0
  211. data/override/models/students_updated.rb +221 -0
  212. data/override/models/teachers_created.rb +221 -0
  213. data/override/models/teachers_deleted.rb +221 -0
  214. data/override/models/teachers_updated.rb +221 -0
  215. data/override/models/terms_created.rb +221 -0
  216. data/override/models/terms_deleted.rb +221 -0
  217. data/override/models/terms_updated.rb +221 -0
  218. data/override/override.sh +27 -0
  219. data/sample/sample.rb +16 -0
  220. data/spec/api/data_api_spec.rb +671 -0
  221. data/spec/api/events_api_spec.rb +61 -0
  222. data/spec/api_client_spec.rb +226 -0
  223. data/spec/configuration_spec.rb +42 -0
  224. data/spec/events.json +227 -0
  225. data/spec/models/bad_request_spec.rb +41 -0
  226. data/spec/models/contact_object_spec.rb +41 -0
  227. data/spec/models/contact_response_spec.rb +41 -0
  228. data/spec/models/contact_spec.rb +107 -0
  229. data/spec/models/contacts_created_spec.rb +59 -0
  230. data/spec/models/contacts_deleted_spec.rb +59 -0
  231. data/spec/models/contacts_response_spec.rb +41 -0
  232. data/spec/models/contacts_updated_spec.rb +65 -0
  233. data/spec/models/course_object_spec.rb +41 -0
  234. data/spec/models/course_response_spec.rb +41 -0
  235. data/spec/models/course_spec.rb +59 -0
  236. data/spec/models/courses_created_spec.rb +59 -0
  237. data/spec/models/courses_deleted_spec.rb +59 -0
  238. data/spec/models/courses_response_spec.rb +41 -0
  239. data/spec/models/courses_updated_spec.rb +65 -0
  240. data/spec/models/credentials_spec.rb +41 -0
  241. data/spec/models/district_admin_object_spec.rb +41 -0
  242. data/spec/models/district_admin_response_spec.rb +41 -0
  243. data/spec/models/district_admin_spec.rb +65 -0
  244. data/spec/models/district_admins_response_spec.rb +41 -0
  245. data/spec/models/district_object_spec.rb +41 -0
  246. data/spec/models/district_response_spec.rb +41 -0
  247. data/spec/models/district_spec.rb +123 -0
  248. data/spec/models/districtadmins_created_spec.rb +59 -0
  249. data/spec/models/districtadmins_deleted_spec.rb +59 -0
  250. data/spec/models/districtadmins_updated_spec.rb +65 -0
  251. data/spec/models/districts_created_spec.rb +59 -0
  252. data/spec/models/districts_deleted_spec.rb +59 -0
  253. data/spec/models/districts_response_spec.rb +41 -0
  254. data/spec/models/districts_updated_spec.rb +65 -0
  255. data/spec/models/event_response_spec.rb +41 -0
  256. data/spec/models/event_spec.rb +53 -0
  257. data/spec/models/events_response_spec.rb +41 -0
  258. data/spec/models/internal_error_spec.rb +41 -0
  259. data/spec/models/location_spec.rb +71 -0
  260. data/spec/models/name_spec.rb +53 -0
  261. data/spec/models/not_found_spec.rb +41 -0
  262. data/spec/models/principal_spec.rb +47 -0
  263. data/spec/models/school_admin_object_spec.rb +41 -0
  264. data/spec/models/school_admin_response_spec.rb +41 -0
  265. data/spec/models/school_admin_spec.rb +95 -0
  266. data/spec/models/school_admins_response_spec.rb +41 -0
  267. data/spec/models/school_enrollment_spec.rb +53 -0
  268. data/spec/models/school_object_spec.rb +41 -0
  269. data/spec/models/school_response_spec.rb +41 -0
  270. data/spec/models/school_spec.rb +139 -0
  271. data/spec/models/schooladmins_created_spec.rb +59 -0
  272. data/spec/models/schooladmins_deleted_spec.rb +59 -0
  273. data/spec/models/schooladmins_updated_spec.rb +65 -0
  274. data/spec/models/schools_created_spec.rb +59 -0
  275. data/spec/models/schools_deleted_spec.rb +59 -0
  276. data/spec/models/schools_response_spec.rb +41 -0
  277. data/spec/models/schools_updated_spec.rb +65 -0
  278. data/spec/models/section_object_spec.rb +41 -0
  279. data/spec/models/section_response_spec.rb +41 -0
  280. data/spec/models/section_spec.rb +145 -0
  281. data/spec/models/sections_created_spec.rb +59 -0
  282. data/spec/models/sections_deleted_spec.rb +59 -0
  283. data/spec/models/sections_response_spec.rb +41 -0
  284. data/spec/models/sections_updated_spec.rb +65 -0
  285. data/spec/models/student_object_spec.rb +41 -0
  286. data/spec/models/student_response_spec.rb +41 -0
  287. data/spec/models/student_spec.rb +215 -0
  288. data/spec/models/students_created_spec.rb +59 -0
  289. data/spec/models/students_deleted_spec.rb +59 -0
  290. data/spec/models/students_response_spec.rb +41 -0
  291. data/spec/models/students_updated_spec.rb +65 -0
  292. data/spec/models/teacher_object_spec.rb +41 -0
  293. data/spec/models/teacher_response_spec.rb +41 -0
  294. data/spec/models/teacher_spec.rb +119 -0
  295. data/spec/models/teachers_created_spec.rb +59 -0
  296. data/spec/models/teachers_deleted_spec.rb +59 -0
  297. data/spec/models/teachers_response_spec.rb +41 -0
  298. data/spec/models/teachers_updated_spec.rb +65 -0
  299. data/spec/models/term_object_spec.rb +41 -0
  300. data/spec/models/term_response_spec.rb +41 -0
  301. data/spec/models/term_spec.rb +65 -0
  302. data/spec/models/terms_created_spec.rb +59 -0
  303. data/spec/models/terms_deleted_spec.rb +59 -0
  304. data/spec/models/terms_response_spec.rb +41 -0
  305. data/spec/models/terms_updated_spec.rb +65 -0
  306. data/spec/spec_helper.rb +103 -0
  307. data/tags +1681 -0
  308. metadata +636 -0
@@ -0,0 +1,184 @@
1
+ =begin
2
+ #Clever API
3
+
4
+ #The Clever API
5
+
6
+ OpenAPI spec version: 2.1.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.18
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module Clever
16
+ class Credentials
17
+ attr_accessor :district_username
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'district_username' => :'district_username'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.swagger_types
28
+ {
29
+ :'district_username' => :'String'
30
+ }
31
+ end
32
+
33
+ # Initializes the object
34
+ # @param [Hash] attributes Model attributes in the form of hash
35
+ def initialize(attributes = {})
36
+ return unless attributes.is_a?(Hash)
37
+
38
+ # convert string to symbol for hash key
39
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
40
+
41
+ if attributes.has_key?(:'district_username')
42
+ self.district_username = attributes[:'district_username']
43
+ end
44
+ end
45
+
46
+ # Show invalid properties with the reasons. Usually used together with valid?
47
+ # @return Array for valid properties with the reasons
48
+ def list_invalid_properties
49
+ invalid_properties = Array.new
50
+ invalid_properties
51
+ end
52
+
53
+ # Check to see if the all the properties in the model are valid
54
+ # @return true if the model is valid
55
+ def valid?
56
+ true
57
+ end
58
+
59
+ # Checks equality by comparing each attribute.
60
+ # @param [Object] Object to be compared
61
+ def ==(o)
62
+ return true if self.equal?(o)
63
+ self.class == o.class &&
64
+ district_username == o.district_username
65
+ end
66
+
67
+ # @see the `==` method
68
+ # @param [Object] Object to be compared
69
+ def eql?(o)
70
+ self == o
71
+ end
72
+
73
+ # Calculates hash code according to all attributes.
74
+ # @return [Fixnum] Hash code
75
+ def hash
76
+ [district_username].hash
77
+ end
78
+
79
+ # Builds the object from hash
80
+ # @param [Hash] attributes Model attributes in the form of hash
81
+ # @return [Object] Returns the model itself
82
+ def build_from_hash(attributes)
83
+ return nil unless attributes.is_a?(Hash)
84
+ self.class.swagger_types.each_pair do |key, type|
85
+ if type =~ /\AArray<(.*)>/i
86
+ # check to ensure the input is an array given that the attribute
87
+ # is documented as an array but the input is not
88
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
89
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
90
+ end
91
+ elsif !attributes[self.class.attribute_map[key]].nil?
92
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
93
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
94
+ end
95
+
96
+ self
97
+ end
98
+
99
+ # Deserializes the data based on type
100
+ # @param string type Data type
101
+ # @param string value Value to be deserialized
102
+ # @return [Object] Deserialized data
103
+ def _deserialize(type, value)
104
+ case type.to_sym
105
+ when :DateTime
106
+ DateTime.parse(value)
107
+ when :Date
108
+ Date.parse(value)
109
+ when :String
110
+ value.to_s
111
+ when :Integer
112
+ value.to_i
113
+ when :Float
114
+ value.to_f
115
+ when :BOOLEAN
116
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
117
+ true
118
+ else
119
+ false
120
+ end
121
+ when :Object
122
+ # generic object (usually a Hash), return directly
123
+ value
124
+ when /\AArray<(?<inner_type>.+)>\z/
125
+ inner_type = Regexp.last_match[:inner_type]
126
+ value.map { |v| _deserialize(inner_type, v) }
127
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
128
+ k_type = Regexp.last_match[:k_type]
129
+ v_type = Regexp.last_match[:v_type]
130
+ {}.tap do |hash|
131
+ value.each do |k, v|
132
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
133
+ end
134
+ end
135
+ else # model
136
+ temp_model = Clever.const_get(type).new
137
+ temp_model.build_from_hash(value)
138
+ end
139
+ end
140
+
141
+ # Returns the string representation of the object
142
+ # @return [String] String presentation of the object
143
+ def to_s
144
+ to_hash.to_s
145
+ end
146
+
147
+ # to_body is an alias to to_hash (backward compatibility)
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_body
150
+ to_hash
151
+ end
152
+
153
+ # Returns the object in the form of hash
154
+ # @return [Hash] Returns the object in the form of hash
155
+ def to_hash
156
+ hash = {}
157
+ self.class.attribute_map.each_pair do |attr, param|
158
+ value = self.send(attr)
159
+ next if value.nil?
160
+ hash[param] = _to_hash(value)
161
+ end
162
+ hash
163
+ end
164
+
165
+ # Outputs non-array value in the form of hash
166
+ # For object, use to_hash. Otherwise, just return the value
167
+ # @param [Object] value Any valid value
168
+ # @return [Hash] Returns the value in the form of hash
169
+ def _to_hash(value)
170
+ if value.is_a?(Array)
171
+ value.compact.map { |v| _to_hash(v) }
172
+ elsif value.is_a?(Hash)
173
+ {}.tap do |hash|
174
+ value.each { |k, v| hash[k] = _to_hash(v) }
175
+ end
176
+ elsif value.respond_to? :to_hash
177
+ value.to_hash
178
+ else
179
+ value
180
+ end
181
+ end
182
+
183
+ end
184
+ end
@@ -0,0 +1,337 @@
1
+ =begin
2
+ #Clever API
3
+
4
+ #The Clever API
5
+
6
+ OpenAPI spec version: 2.1.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.18
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module Clever
16
+ class District
17
+ attr_accessor :district_contact
18
+
19
+ attr_accessor :error
20
+
21
+ attr_accessor :id
22
+
23
+ attr_accessor :last_sync
24
+
25
+ attr_accessor :launch_date
26
+
27
+ attr_accessor :login_methods
28
+
29
+ attr_accessor :mdr_number
30
+
31
+ attr_accessor :name
32
+
33
+ attr_accessor :nces_id
34
+
35
+ attr_accessor :pause_end
36
+
37
+ attr_accessor :pause_start
38
+
39
+ attr_accessor :portal_url
40
+
41
+ attr_accessor :sis_type
42
+
43
+ attr_accessor :state
44
+
45
+ class EnumAttributeValidator
46
+ attr_reader :datatype
47
+ attr_reader :allowable_values
48
+
49
+ def initialize(datatype, allowable_values)
50
+ @allowable_values = allowable_values.map do |value|
51
+ case datatype.to_s
52
+ when /Integer/i
53
+ value.to_i
54
+ when /Float/i
55
+ value.to_f
56
+ else
57
+ value
58
+ end
59
+ end
60
+ end
61
+
62
+ def valid?(value)
63
+ !value || allowable_values.include?(value)
64
+ end
65
+ end
66
+
67
+ # Attribute mapping from ruby-style variable name to JSON key.
68
+ def self.attribute_map
69
+ {
70
+ :'district_contact' => :'district_contact',
71
+ :'error' => :'error',
72
+ :'id' => :'id',
73
+ :'last_sync' => :'last_sync',
74
+ :'launch_date' => :'launch_date',
75
+ :'login_methods' => :'login_methods',
76
+ :'mdr_number' => :'mdr_number',
77
+ :'name' => :'name',
78
+ :'nces_id' => :'nces_id',
79
+ :'pause_end' => :'pause_end',
80
+ :'pause_start' => :'pause_start',
81
+ :'portal_url' => :'portal_url',
82
+ :'sis_type' => :'sis_type',
83
+ :'state' => :'state'
84
+ }
85
+ end
86
+
87
+ # Attribute type mapping.
88
+ def self.swagger_types
89
+ {
90
+ :'district_contact' => :'DistrictAdmin',
91
+ :'error' => :'String',
92
+ :'id' => :'String',
93
+ :'last_sync' => :'String',
94
+ :'launch_date' => :'String',
95
+ :'login_methods' => :'Array<String>',
96
+ :'mdr_number' => :'String',
97
+ :'name' => :'String',
98
+ :'nces_id' => :'String',
99
+ :'pause_end' => :'String',
100
+ :'pause_start' => :'String',
101
+ :'portal_url' => :'String',
102
+ :'sis_type' => :'String',
103
+ :'state' => :'String'
104
+ }
105
+ end
106
+
107
+ # Initializes the object
108
+ # @param [Hash] attributes Model attributes in the form of hash
109
+ def initialize(attributes = {})
110
+ return unless attributes.is_a?(Hash)
111
+
112
+ # convert string to symbol for hash key
113
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
114
+
115
+ if attributes.has_key?(:'district_contact')
116
+ self.district_contact = attributes[:'district_contact']
117
+ end
118
+
119
+ if attributes.has_key?(:'error')
120
+ self.error = attributes[:'error']
121
+ end
122
+
123
+ if attributes.has_key?(:'id')
124
+ self.id = attributes[:'id']
125
+ end
126
+
127
+ if attributes.has_key?(:'last_sync')
128
+ self.last_sync = attributes[:'last_sync']
129
+ end
130
+
131
+ if attributes.has_key?(:'launch_date')
132
+ self.launch_date = attributes[:'launch_date']
133
+ end
134
+
135
+ if attributes.has_key?(:'login_methods')
136
+ if (value = attributes[:'login_methods']).is_a?(Array)
137
+ self.login_methods = value
138
+ end
139
+ end
140
+
141
+ if attributes.has_key?(:'mdr_number')
142
+ self.mdr_number = attributes[:'mdr_number']
143
+ end
144
+
145
+ if attributes.has_key?(:'name')
146
+ self.name = attributes[:'name']
147
+ end
148
+
149
+ if attributes.has_key?(:'nces_id')
150
+ self.nces_id = attributes[:'nces_id']
151
+ end
152
+
153
+ if attributes.has_key?(:'pause_end')
154
+ self.pause_end = attributes[:'pause_end']
155
+ end
156
+
157
+ if attributes.has_key?(:'pause_start')
158
+ self.pause_start = attributes[:'pause_start']
159
+ end
160
+
161
+ if attributes.has_key?(:'portal_url')
162
+ self.portal_url = attributes[:'portal_url']
163
+ end
164
+
165
+ if attributes.has_key?(:'sis_type')
166
+ self.sis_type = attributes[:'sis_type']
167
+ end
168
+
169
+ if attributes.has_key?(:'state')
170
+ self.state = attributes[:'state']
171
+ end
172
+ end
173
+
174
+ # Show invalid properties with the reasons. Usually used together with valid?
175
+ # @return Array for valid properties with the reasons
176
+ def list_invalid_properties
177
+ invalid_properties = Array.new
178
+ invalid_properties
179
+ end
180
+
181
+ # Check to see if the all the properties in the model are valid
182
+ # @return true if the model is valid
183
+ def valid?
184
+ state_validator = EnumAttributeValidator.new('String', ['running', 'pending', 'error', 'paused', ''])
185
+ return false unless state_validator.valid?(@state)
186
+ true
187
+ end
188
+
189
+ # Custom attribute writer method checking allowed values (enum).
190
+ # @param [Object] state Object to be assigned
191
+ def state=(state)
192
+ validator = EnumAttributeValidator.new('String', ['running', 'pending', 'error', 'paused', ''])
193
+ unless validator.valid?(state)
194
+ fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
195
+ end
196
+ @state = state
197
+ end
198
+
199
+ # Checks equality by comparing each attribute.
200
+ # @param [Object] Object to be compared
201
+ def ==(o)
202
+ return true if self.equal?(o)
203
+ self.class == o.class &&
204
+ district_contact == o.district_contact &&
205
+ error == o.error &&
206
+ id == o.id &&
207
+ last_sync == o.last_sync &&
208
+ launch_date == o.launch_date &&
209
+ login_methods == o.login_methods &&
210
+ mdr_number == o.mdr_number &&
211
+ name == o.name &&
212
+ nces_id == o.nces_id &&
213
+ pause_end == o.pause_end &&
214
+ pause_start == o.pause_start &&
215
+ portal_url == o.portal_url &&
216
+ sis_type == o.sis_type &&
217
+ state == o.state
218
+ end
219
+
220
+ # @see the `==` method
221
+ # @param [Object] Object to be compared
222
+ def eql?(o)
223
+ self == o
224
+ end
225
+
226
+ # Calculates hash code according to all attributes.
227
+ # @return [Fixnum] Hash code
228
+ def hash
229
+ [district_contact, error, id, last_sync, launch_date, login_methods, mdr_number, name, nces_id, pause_end, pause_start, portal_url, sis_type, state].hash
230
+ end
231
+
232
+ # Builds the object from hash
233
+ # @param [Hash] attributes Model attributes in the form of hash
234
+ # @return [Object] Returns the model itself
235
+ def build_from_hash(attributes)
236
+ return nil unless attributes.is_a?(Hash)
237
+ self.class.swagger_types.each_pair do |key, type|
238
+ if type =~ /\AArray<(.*)>/i
239
+ # check to ensure the input is an array given that the attribute
240
+ # is documented as an array but the input is not
241
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
242
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
243
+ end
244
+ elsif !attributes[self.class.attribute_map[key]].nil?
245
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
246
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
247
+ end
248
+
249
+ self
250
+ end
251
+
252
+ # Deserializes the data based on type
253
+ # @param string type Data type
254
+ # @param string value Value to be deserialized
255
+ # @return [Object] Deserialized data
256
+ def _deserialize(type, value)
257
+ case type.to_sym
258
+ when :DateTime
259
+ DateTime.parse(value)
260
+ when :Date
261
+ Date.parse(value)
262
+ when :String
263
+ value.to_s
264
+ when :Integer
265
+ value.to_i
266
+ when :Float
267
+ value.to_f
268
+ when :BOOLEAN
269
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
270
+ true
271
+ else
272
+ false
273
+ end
274
+ when :Object
275
+ # generic object (usually a Hash), return directly
276
+ value
277
+ when /\AArray<(?<inner_type>.+)>\z/
278
+ inner_type = Regexp.last_match[:inner_type]
279
+ value.map { |v| _deserialize(inner_type, v) }
280
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
281
+ k_type = Regexp.last_match[:k_type]
282
+ v_type = Regexp.last_match[:v_type]
283
+ {}.tap do |hash|
284
+ value.each do |k, v|
285
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
286
+ end
287
+ end
288
+ else # model
289
+ temp_model = Clever.const_get(type).new
290
+ temp_model.build_from_hash(value)
291
+ end
292
+ end
293
+
294
+ # Returns the string representation of the object
295
+ # @return [String] String presentation of the object
296
+ def to_s
297
+ to_hash.to_s
298
+ end
299
+
300
+ # to_body is an alias to to_hash (backward compatibility)
301
+ # @return [Hash] Returns the object in the form of hash
302
+ def to_body
303
+ to_hash
304
+ end
305
+
306
+ # Returns the object in the form of hash
307
+ # @return [Hash] Returns the object in the form of hash
308
+ def to_hash
309
+ hash = {}
310
+ self.class.attribute_map.each_pair do |attr, param|
311
+ value = self.send(attr)
312
+ next if value.nil?
313
+ hash[param] = _to_hash(value)
314
+ end
315
+ hash
316
+ end
317
+
318
+ # Outputs non-array value in the form of hash
319
+ # For object, use to_hash. Otherwise, just return the value
320
+ # @param [Object] value Any valid value
321
+ # @return [Hash] Returns the value in the form of hash
322
+ def _to_hash(value)
323
+ if value.is_a?(Array)
324
+ value.compact.map { |v| _to_hash(v) }
325
+ elsif value.is_a?(Hash)
326
+ {}.tap do |hash|
327
+ value.each { |k, v| hash[k] = _to_hash(v) }
328
+ end
329
+ elsif value.respond_to? :to_hash
330
+ value.to_hash
331
+ else
332
+ value
333
+ end
334
+ end
335
+
336
+ end
337
+ end