flat_api 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (173) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/README.md +5 -4
  4. data/docs/ScoreRights.md +1 -0
  5. data/flat_api.gemspec +1 -1
  6. data/git_push.sh +1 -1
  7. data/lib/flat_api.rb +1 -1
  8. data/lib/flat_api/api/account_api.rb +1 -1
  9. data/lib/flat_api/api/class_api.rb +1 -1
  10. data/lib/flat_api/api/group_api.rb +1 -1
  11. data/lib/flat_api/api/organization_api.rb +1 -1
  12. data/lib/flat_api/api/score_api.rb +1 -1
  13. data/lib/flat_api/api/user_api.rb +1 -1
  14. data/lib/flat_api/api_client.rb +2 -2
  15. data/lib/flat_api/api_error.rb +1 -1
  16. data/lib/flat_api/configuration.rb +1 -1
  17. data/lib/flat_api/models/assignment.rb +2 -2
  18. data/lib/flat_api/models/assignment_copy.rb +2 -2
  19. data/lib/flat_api/models/assignment_creation.rb +2 -2
  20. data/lib/flat_api/models/assignment_submission.rb +2 -2
  21. data/lib/flat_api/models/assignment_submission_update.rb +2 -2
  22. data/lib/flat_api/models/class_attachment_creation.rb +2 -2
  23. data/lib/flat_api/models/class_creation.rb +2 -2
  24. data/lib/flat_api/models/class_details.rb +2 -2
  25. data/lib/flat_api/models/class_details_canvas.rb +2 -2
  26. data/lib/flat_api/models/class_details_clever.rb +2 -2
  27. data/lib/flat_api/models/class_details_google_classroom.rb +2 -2
  28. data/lib/flat_api/models/class_details_google_drive.rb +2 -2
  29. data/lib/flat_api/models/class_details_lti.rb +2 -2
  30. data/lib/flat_api/models/class_roles.rb +10 -1
  31. data/lib/flat_api/models/class_state.rb +10 -1
  32. data/lib/flat_api/models/class_update.rb +2 -2
  33. data/lib/flat_api/models/flat_error_response.rb +2 -2
  34. data/lib/flat_api/models/flat_locales.rb +10 -1
  35. data/lib/flat_api/models/google_classroom_coursework.rb +2 -2
  36. data/lib/flat_api/models/google_classroom_submission.rb +2 -2
  37. data/lib/flat_api/models/group.rb +2 -2
  38. data/lib/flat_api/models/group_details.rb +2 -2
  39. data/lib/flat_api/models/group_type.rb +10 -1
  40. data/lib/flat_api/models/license_mode.rb +10 -1
  41. data/lib/flat_api/models/license_sources.rb +10 -1
  42. data/lib/flat_api/models/lms_name.rb +10 -1
  43. data/lib/flat_api/models/lti_credentials.rb +2 -2
  44. data/lib/flat_api/models/lti_credentials_creation.rb +2 -2
  45. data/lib/flat_api/models/media_attachment.rb +2 -2
  46. data/lib/flat_api/models/media_score_sharing_mode.rb +10 -1
  47. data/lib/flat_api/models/organization_invitation.rb +2 -2
  48. data/lib/flat_api/models/organization_invitation_creation.rb +2 -2
  49. data/lib/flat_api/models/organization_roles.rb +10 -1
  50. data/lib/flat_api/models/score_collaborator.rb +2 -2
  51. data/lib/flat_api/models/score_collaborator_creation.rb +2 -2
  52. data/lib/flat_api/models/score_comment.rb +2 -2
  53. data/lib/flat_api/models/score_comment_context.rb +2 -2
  54. data/lib/flat_api/models/score_comment_creation.rb +2 -2
  55. data/lib/flat_api/models/score_comment_update.rb +2 -2
  56. data/lib/flat_api/models/score_comments_counts.rb +2 -2
  57. data/lib/flat_api/models/score_creation.rb +2 -2
  58. data/lib/flat_api/models/score_creation_type.rb +10 -1
  59. data/lib/flat_api/models/score_data.rb +2 -2
  60. data/lib/flat_api/models/score_data_encoding.rb +10 -1
  61. data/lib/flat_api/models/score_details.rb +2 -2
  62. data/lib/flat_api/models/score_fork.rb +2 -2
  63. data/lib/flat_api/models/score_license.rb +10 -1
  64. data/lib/flat_api/models/score_likes_counts.rb +2 -2
  65. data/lib/flat_api/models/score_modification.rb +2 -2
  66. data/lib/flat_api/models/score_privacy.rb +10 -1
  67. data/lib/flat_api/models/score_revision.rb +2 -2
  68. data/lib/flat_api/models/score_revision_creation.rb +2 -2
  69. data/lib/flat_api/models/score_revision_statistics.rb +2 -2
  70. data/lib/flat_api/models/score_rights.rb +13 -3
  71. data/lib/flat_api/models/score_source.rb +2 -2
  72. data/lib/flat_api/models/score_summary.rb +2 -2
  73. data/lib/flat_api/models/score_track.rb +2 -2
  74. data/lib/flat_api/models/score_track_creation.rb +2 -2
  75. data/lib/flat_api/models/score_track_point.rb +2 -2
  76. data/lib/flat_api/models/score_track_state.rb +10 -1
  77. data/lib/flat_api/models/score_track_type.rb +10 -1
  78. data/lib/flat_api/models/score_track_update.rb +2 -2
  79. data/lib/flat_api/models/score_views_counts.rb +2 -2
  80. data/lib/flat_api/models/user_admin_update.rb +2 -2
  81. data/lib/flat_api/models/user_basics.rb +2 -2
  82. data/lib/flat_api/models/user_creation.rb +7 -7
  83. data/lib/flat_api/models/user_details.rb +2 -2
  84. data/lib/flat_api/models/user_details_admin.rb +2 -2
  85. data/lib/flat_api/models/user_details_admin_license.rb +2 -2
  86. data/lib/flat_api/models/user_instruments.rb +2 -2
  87. data/lib/flat_api/models/user_public.rb +2 -2
  88. data/lib/flat_api/models/user_public_summary.rb +2 -2
  89. data/lib/flat_api/version.rb +2 -2
  90. metadata +2 -85
  91. data/lib/swagger_client.rb +0 -117
  92. data/lib/swagger_client/api/account_api.rb +0 -72
  93. data/lib/swagger_client/api/class_api.rb +0 -1148
  94. data/lib/swagger_client/api/group_api.rb +0 -191
  95. data/lib/swagger_client/api/organization_api.rb +0 -599
  96. data/lib/swagger_client/api/score_api.rb +0 -1737
  97. data/lib/swagger_client/api/user_api.rb +0 -194
  98. data/lib/swagger_client/api_client.rb +0 -389
  99. data/lib/swagger_client/api_error.rb +0 -38
  100. data/lib/swagger_client/configuration.rb +0 -209
  101. data/lib/swagger_client/models/assignment.rb +0 -323
  102. data/lib/swagger_client/models/assignment_copy.rb +0 -194
  103. data/lib/swagger_client/models/assignment_creation.rb +0 -230
  104. data/lib/swagger_client/models/assignment_submission.rb +0 -299
  105. data/lib/swagger_client/models/assignment_submission_update.rb +0 -220
  106. data/lib/swagger_client/models/class_attachment_creation.rb +0 -242
  107. data/lib/swagger_client/models/class_creation.rb +0 -239
  108. data/lib/swagger_client/models/class_details.rb +0 -351
  109. data/lib/swagger_client/models/class_details_canvas.rb +0 -199
  110. data/lib/swagger_client/models/class_details_clever.rb +0 -282
  111. data/lib/swagger_client/models/class_details_google_classroom.rb +0 -219
  112. data/lib/swagger_client/models/class_details_google_drive.rb +0 -199
  113. data/lib/swagger_client/models/class_details_lti.rb +0 -209
  114. data/lib/swagger_client/models/class_roles.rb +0 -22
  115. data/lib/swagger_client/models/class_state.rb +0 -23
  116. data/lib/swagger_client/models/class_update.rb +0 -231
  117. data/lib/swagger_client/models/flat_error_response.rb +0 -219
  118. data/lib/swagger_client/models/flat_locales.rb +0 -27
  119. data/lib/swagger_client/models/google_classroom_coursework.rb +0 -209
  120. data/lib/swagger_client/models/google_classroom_submission.rb +0 -209
  121. data/lib/swagger_client/models/group.rb +0 -282
  122. data/lib/swagger_client/models/group_details.rb +0 -248
  123. data/lib/swagger_client/models/group_type.rb +0 -23
  124. data/lib/swagger_client/models/license_mode.rb +0 -22
  125. data/lib/swagger_client/models/license_sources.rb +0 -25
  126. data/lib/swagger_client/models/lms_name.rb +0 -27
  127. data/lib/swagger_client/models/lti_credentials.rb +0 -268
  128. data/lib/swagger_client/models/lti_credentials_creation.rb +0 -227
  129. data/lib/swagger_client/models/media_attachment.rb +0 -371
  130. data/lib/swagger_client/models/media_score_sharing_mode.rb +0 -23
  131. data/lib/swagger_client/models/organization_invitation.rb +0 -248
  132. data/lib/swagger_client/models/organization_invitation_creation.rb +0 -198
  133. data/lib/swagger_client/models/organization_roles.rb +0 -24
  134. data/lib/swagger_client/models/score_collaborator.rb +0 -263
  135. data/lib/swagger_client/models/score_collaborator_creation.rb +0 -245
  136. data/lib/swagger_client/models/score_comment.rb +0 -363
  137. data/lib/swagger_client/models/score_comment_context.rb +0 -282
  138. data/lib/swagger_client/models/score_comment_creation.rb +0 -245
  139. data/lib/swagger_client/models/score_comment_update.rb +0 -268
  140. data/lib/swagger_client/models/score_comments_counts.rb +0 -219
  141. data/lib/swagger_client/models/score_creation.rb +0 -240
  142. data/lib/swagger_client/models/score_creation_type.rb +0 -23
  143. data/lib/swagger_client/models/score_data.rb +0 -179
  144. data/lib/swagger_client/models/score_data_encoding.rb +0 -21
  145. data/lib/swagger_client/models/score_details.rb +0 -467
  146. data/lib/swagger_client/models/score_fork.rb +0 -179
  147. data/lib/swagger_client/models/score_license.rb +0 -28
  148. data/lib/swagger_client/models/score_likes_counts.rb +0 -209
  149. data/lib/swagger_client/models/score_modification.rb +0 -270
  150. data/lib/swagger_client/models/score_privacy.rb +0 -24
  151. data/lib/swagger_client/models/score_revision.rb +0 -249
  152. data/lib/swagger_client/models/score_revision_creation.rb +0 -222
  153. data/lib/swagger_client/models/score_revision_statistics.rb +0 -199
  154. data/lib/swagger_client/models/score_rights.rb +0 -203
  155. data/lib/swagger_client/models/score_source.rb +0 -189
  156. data/lib/swagger_client/models/score_summary.rb +0 -237
  157. data/lib/swagger_client/models/score_track.rb +0 -298
  158. data/lib/swagger_client/models/score_track_creation.rb +0 -229
  159. data/lib/swagger_client/models/score_track_point.rb +0 -252
  160. data/lib/swagger_client/models/score_track_state.rb +0 -23
  161. data/lib/swagger_client/models/score_track_type.rb +0 -24
  162. data/lib/swagger_client/models/score_track_update.rb +0 -219
  163. data/lib/swagger_client/models/score_views_counts.rb +0 -209
  164. data/lib/swagger_client/models/user_admin_update.rb +0 -214
  165. data/lib/swagger_client/models/user_basics.rb +0 -239
  166. data/lib/swagger_client/models/user_creation.rb +0 -266
  167. data/lib/swagger_client/models/user_details.rb +0 -418
  168. data/lib/swagger_client/models/user_details_admin.rb +0 -306
  169. data/lib/swagger_client/models/user_details_admin_license.rb +0 -227
  170. data/lib/swagger_client/models/user_instruments.rb +0 -179
  171. data/lib/swagger_client/models/user_public.rb +0 -356
  172. data/lib/swagger_client/models/user_public_summary.rb +0 -277
  173. data/lib/swagger_client/version.rb +0 -15
@@ -1,277 +0,0 @@
1
- =begin
2
- #Flat API
3
-
4
- #The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
5
-
6
- OpenAPI spec version: 2.5.0
7
- Contact: developers@flat.io
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
-
15
- module SwaggerClient
16
- # Public User details summary
17
- class UserPublicSummary
18
- # The user unique identifier
19
- attr_accessor :id
20
-
21
- # The user name (unique for the organization)
22
- attr_accessor :username
23
-
24
- # A displayable name for the user
25
- attr_accessor :name
26
-
27
- # The name that can be directly printed (name or username)
28
- attr_accessor :printable_name
29
-
30
- # User pictue
31
- attr_accessor :picture
32
-
33
- # User license status. 'True' if user is an individual Power user
34
- attr_accessor :is_power_user
35
-
36
- # Organization ID (for Edu users only)
37
- attr_accessor :organization
38
-
39
- attr_accessor :organization_role
40
-
41
- attr_accessor :class_role
42
-
43
- # Link to user profile (for Indiv. users only)
44
- attr_accessor :html_url
45
-
46
-
47
- # Attribute mapping from ruby-style variable name to JSON key.
48
- def self.attribute_map
49
- {
50
- :'id' => :'id',
51
- :'username' => :'username',
52
- :'name' => :'name',
53
- :'printable_name' => :'printableName',
54
- :'picture' => :'picture',
55
- :'is_power_user' => :'isPowerUser',
56
- :'organization' => :'organization',
57
- :'organization_role' => :'organizationRole',
58
- :'class_role' => :'classRole',
59
- :'html_url' => :'htmlUrl'
60
- }
61
- end
62
-
63
- # Attribute type mapping.
64
- def self.swagger_types
65
- {
66
- :'id' => :'String',
67
- :'username' => :'String',
68
- :'name' => :'String',
69
- :'printable_name' => :'String',
70
- :'picture' => :'String',
71
- :'is_power_user' => :'BOOLEAN',
72
- :'organization' => :'String',
73
- :'organization_role' => :'OrganizationRoles',
74
- :'class_role' => :'ClassRoles',
75
- :'html_url' => :'String'
76
- }
77
- end
78
-
79
- # Initializes the object
80
- # @param [Hash] attributes Model attributes in the form of hash
81
- def initialize(attributes = {})
82
- return unless attributes.is_a?(Hash)
83
-
84
- # convert string to symbol for hash key
85
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
86
-
87
- if attributes.has_key?(:'id')
88
- self.id = attributes[:'id']
89
- end
90
-
91
- if attributes.has_key?(:'username')
92
- self.username = attributes[:'username']
93
- end
94
-
95
- if attributes.has_key?(:'name')
96
- self.name = attributes[:'name']
97
- end
98
-
99
- if attributes.has_key?(:'printableName')
100
- self.printable_name = attributes[:'printableName']
101
- end
102
-
103
- if attributes.has_key?(:'picture')
104
- self.picture = attributes[:'picture']
105
- end
106
-
107
- if attributes.has_key?(:'isPowerUser')
108
- self.is_power_user = attributes[:'isPowerUser']
109
- end
110
-
111
- if attributes.has_key?(:'organization')
112
- self.organization = attributes[:'organization']
113
- end
114
-
115
- if attributes.has_key?(:'organizationRole')
116
- self.organization_role = attributes[:'organizationRole']
117
- end
118
-
119
- if attributes.has_key?(:'classRole')
120
- self.class_role = attributes[:'classRole']
121
- end
122
-
123
- if attributes.has_key?(:'htmlUrl')
124
- self.html_url = attributes[:'htmlUrl']
125
- end
126
-
127
- end
128
-
129
- # Show invalid properties with the reasons. Usually used together with valid?
130
- # @return Array for valid properies with the reasons
131
- def list_invalid_properties
132
- invalid_properties = Array.new
133
- return invalid_properties
134
- end
135
-
136
- # Check to see if the all the properties in the model are valid
137
- # @return true if the model is valid
138
- def valid?
139
- return true
140
- end
141
-
142
- # Checks equality by comparing each attribute.
143
- # @param [Object] Object to be compared
144
- def ==(o)
145
- return true if self.equal?(o)
146
- self.class == o.class &&
147
- id == o.id &&
148
- username == o.username &&
149
- name == o.name &&
150
- printable_name == o.printable_name &&
151
- picture == o.picture &&
152
- is_power_user == o.is_power_user &&
153
- organization == o.organization &&
154
- organization_role == o.organization_role &&
155
- class_role == o.class_role &&
156
- html_url == o.html_url
157
- end
158
-
159
- # @see the `==` method
160
- # @param [Object] Object to be compared
161
- def eql?(o)
162
- self == o
163
- end
164
-
165
- # Calculates hash code according to all attributes.
166
- # @return [Fixnum] Hash code
167
- def hash
168
- [id, username, name, printable_name, picture, is_power_user, organization, organization_role, class_role, html_url].hash
169
- end
170
-
171
- # Builds the object from hash
172
- # @param [Hash] attributes Model attributes in the form of hash
173
- # @return [Object] Returns the model itself
174
- def build_from_hash(attributes)
175
- return nil unless attributes.is_a?(Hash)
176
- self.class.swagger_types.each_pair do |key, type|
177
- if type =~ /\AArray<(.*)>/i
178
- # check to ensure the input is an array given that the the attribute
179
- # is documented as an array but the input is not
180
- if attributes[self.class.attribute_map[key]].is_a?(Array)
181
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
182
- end
183
- elsif !attributes[self.class.attribute_map[key]].nil?
184
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
185
- end # or else data not found in attributes(hash), not an issue as the data can be optional
186
- end
187
-
188
- self
189
- end
190
-
191
- # Deserializes the data based on type
192
- # @param string type Data type
193
- # @param string value Value to be deserialized
194
- # @return [Object] Deserialized data
195
- def _deserialize(type, value)
196
- case type.to_sym
197
- when :DateTime
198
- DateTime.parse(value)
199
- when :Date
200
- Date.parse(value)
201
- when :String
202
- value.to_s
203
- when :Integer
204
- value.to_i
205
- when :Float
206
- value.to_f
207
- when :BOOLEAN
208
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
209
- true
210
- else
211
- false
212
- end
213
- when :Object
214
- # generic object (usually a Hash), return directly
215
- value
216
- when /\AArray<(?<inner_type>.+)>\z/
217
- inner_type = Regexp.last_match[:inner_type]
218
- value.map { |v| _deserialize(inner_type, v) }
219
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
220
- k_type = Regexp.last_match[:k_type]
221
- v_type = Regexp.last_match[:v_type]
222
- {}.tap do |hash|
223
- value.each do |k, v|
224
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
225
- end
226
- end
227
- else # model
228
- temp_model = SwaggerClient.const_get(type).new
229
- temp_model.build_from_hash(value)
230
- end
231
- end
232
-
233
- # Returns the string representation of the object
234
- # @return [String] String presentation of the object
235
- def to_s
236
- to_hash.to_s
237
- end
238
-
239
- # to_body is an alias to to_hash (backward compatibility)
240
- # @return [Hash] Returns the object in the form of hash
241
- def to_body
242
- to_hash
243
- end
244
-
245
- # Returns the object in the form of hash
246
- # @return [Hash] Returns the object in the form of hash
247
- def to_hash
248
- hash = {}
249
- self.class.attribute_map.each_pair do |attr, param|
250
- value = self.send(attr)
251
- next if value.nil?
252
- hash[param] = _to_hash(value)
253
- end
254
- hash
255
- end
256
-
257
- # Outputs non-array value in the form of hash
258
- # For object, use to_hash. Otherwise, just return the value
259
- # @param [Object] value Any valid value
260
- # @return [Hash] Returns the value in the form of hash
261
- def _to_hash(value)
262
- if value.is_a?(Array)
263
- value.compact.map{ |v| _to_hash(v) }
264
- elsif value.is_a?(Hash)
265
- {}.tap do |hash|
266
- value.each { |k, v| hash[k] = _to_hash(v) }
267
- end
268
- elsif value.respond_to? :to_hash
269
- value.to_hash
270
- else
271
- value
272
- end
273
- end
274
-
275
- end
276
-
277
- end
@@ -1,15 +0,0 @@
1
- =begin
2
- #Flat API
3
-
4
- #The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
5
-
6
- OpenAPI spec version: 2.5.0
7
- Contact: developers@flat.io
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.2.3-SNAPSHOT
10
-
11
- =end
12
-
13
- module SwaggerClient
14
- VERSION = "1.0.0"
15
- end