songtradr_api_client_ruby 1.16.0 → 1.17.0

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 (204) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +5 -30
  4. data/docs/ImageRecognitionResponse.md +2 -2
  5. data/docs/MusicalFeaturesDTO.md +78 -78
  6. data/docs/RecordingGenrePredictionDTO.md +3 -3
  7. data/docs/RecordingMediumDTO.md +4 -4
  8. data/docs/RecordingPartyDTO.md +3 -3
  9. data/docs/RecordingSmallDTO.md +3 -3
  10. data/docs/VideoRecognitionResponse.md +2 -2
  11. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
  12. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +2 -2
  13. data/lib/songtradr_api_client_ruby/api/recording_api.rb +2 -2
  14. data/lib/songtradr_api_client_ruby/api/user_api.rb +2 -2
  15. data/lib/songtradr_api_client_ruby/api_client.rb +4 -4
  16. data/lib/songtradr_api_client_ruby/api_error.rb +2 -2
  17. data/lib/songtradr_api_client_ruby/configuration.rb +2 -2
  18. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
  19. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
  20. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
  21. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
  22. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
  23. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +2 -2
  24. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +2 -2
  25. data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
  26. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
  27. data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
  28. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
  29. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +2 -2
  30. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
  31. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
  32. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
  33. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
  34. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
  35. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
  36. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
  37. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +4 -4
  38. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
  39. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
  40. data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
  41. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +557 -557
  42. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
  43. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
  44. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +22 -22
  45. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
  46. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +35 -35
  47. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +2 -2
  48. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
  49. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
  50. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +17 -17
  51. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +27 -27
  52. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
  53. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
  54. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +2 -2
  55. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +2 -2
  56. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
  57. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
  58. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
  59. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
  60. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
  61. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
  62. data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
  63. data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
  64. data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
  65. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
  66. data/lib/songtradr_api_client_ruby/models/user_dto.rb +2 -2
  67. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +4 -4
  68. data/lib/songtradr_api_client_ruby/version.rb +3 -3
  69. data/lib/songtradr_api_client_ruby.rb +2 -27
  70. data/openapi-generator-config.yaml +1 -1
  71. data/songtradr_api_client_ruby.gemspec +2 -2
  72. data/spec/api/allowed_values_api_spec.rb +2 -2
  73. data/spec/api/playlist_api_spec.rb +2 -2
  74. data/spec/api/recording_api_spec.rb +2 -2
  75. data/spec/api/user_api_spec.rb +2 -2
  76. data/spec/models/category_medium_dto_spec.rb +2 -2
  77. data/spec/models/category_minimal_dto_spec.rb +2 -2
  78. data/spec/models/config_access_dto_spec.rb +2 -2
  79. data/spec/models/config_identifier_dto_spec.rb +2 -2
  80. data/spec/models/contributor_type_dto_spec.rb +2 -2
  81. data/spec/models/curate_playlist_dto_spec.rb +2 -2
  82. data/spec/models/curate_playlist_response_dto_spec.rb +2 -2
  83. data/spec/models/error_response_spec.rb +2 -2
  84. data/spec/models/field_summary_dto_spec.rb +2 -2
  85. data/spec/models/file_dto_spec.rb +2 -2
  86. data/spec/models/file_list_dto_spec.rb +2 -2
  87. data/spec/models/file_small_dto_spec.rb +2 -2
  88. data/spec/models/file_upload_dto_spec.rb +2 -2
  89. data/spec/models/file_w_ith_url_dto_spec.rb +2 -2
  90. data/spec/models/files_summary_dto_spec.rb +2 -2
  91. data/spec/models/forgot_password_dto_spec.rb +2 -2
  92. data/spec/models/genre_dto_spec.rb +2 -2
  93. data/spec/models/genre_minimal_dto_spec.rb +2 -2
  94. data/spec/models/genres_summary_dto_spec.rb +2 -2
  95. data/spec/models/image_recognition_response_spec.rb +2 -2
  96. data/spec/models/init_put_recording_audio_dto_spec.rb +2 -2
  97. data/spec/models/jwt_token_dto_spec.rb +2 -2
  98. data/spec/models/login_dto_spec.rb +2 -2
  99. data/spec/models/musical_features_dto_spec.rb +171 -171
  100. data/spec/models/party_small_dto_spec.rb +2 -2
  101. data/spec/models/recording_for_similarity_search_dto_spec.rb +2 -2
  102. data/spec/models/recording_genre_prediction_dto_spec.rb +5 -5
  103. data/spec/models/recording_list_dto_spec.rb +2 -2
  104. data/spec/models/recording_medium_dto_spec.rb +9 -9
  105. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +2 -2
  106. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +2 -2
  107. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +2 -2
  108. data/spec/models/recording_party_dto_spec.rb +4 -4
  109. data/spec/models/recording_small_dto_spec.rb +5 -5
  110. data/spec/models/recording_tag_small_dto_spec.rb +2 -2
  111. data/spec/models/save_user_dto_spec.rb +2 -2
  112. data/spec/models/search_filter_values_dto_spec.rb +2 -2
  113. data/spec/models/search_recording_granular_dto_spec.rb +2 -2
  114. data/spec/models/sign_up_dto_spec.rb +2 -2
  115. data/spec/models/tag_dto_spec.rb +2 -2
  116. data/spec/models/tag_small_dto_spec.rb +2 -2
  117. data/spec/models/taggram_dto_spec.rb +2 -2
  118. data/spec/models/tags_summary_dto_spec.rb +2 -2
  119. data/spec/models/tagstrength_dto_spec.rb +2 -2
  120. data/spec/models/title_dto_spec.rb +2 -2
  121. data/spec/models/token_request_spec.rb +2 -2
  122. data/spec/models/track_dto_spec.rb +2 -2
  123. data/spec/models/update_password_dto_spec.rb +2 -2
  124. data/spec/models/user_dto_spec.rb +2 -2
  125. data/spec/models/video_recognition_response_spec.rb +2 -2
  126. data/spec/spec_helper.rb +2 -2
  127. metadata +42 -146
  128. data/docs/AgeRange.md +0 -20
  129. data/docs/Beard.md +0 -20
  130. data/docs/BoundingBox.md +0 -24
  131. data/docs/DominantColor.md +0 -30
  132. data/docs/Emotion.md +0 -20
  133. data/docs/EyeDirection.md +0 -22
  134. data/docs/EyeOpen.md +0 -20
  135. data/docs/Eyeglasses.md +0 -20
  136. data/docs/FaceDetail.md +0 -50
  137. data/docs/FaceDetection.md +0 -20
  138. data/docs/FaceOccluded.md +0 -20
  139. data/docs/Gender.md +0 -20
  140. data/docs/ImageQuality.md +0 -20
  141. data/docs/Instance.md +0 -22
  142. data/docs/Label.md +0 -28
  143. data/docs/LabelAlias.md +0 -18
  144. data/docs/LabelCategory.md +0 -18
  145. data/docs/LabelDetection.md +0 -26
  146. data/docs/Landmark.md +0 -22
  147. data/docs/MouthOpen.md +0 -20
  148. data/docs/Mustache.md +0 -20
  149. data/docs/Parent.md +0 -18
  150. data/docs/Pose.md +0 -22
  151. data/docs/Smile.md +0 -20
  152. data/docs/Sunglasses.md +0 -20
  153. data/lib/songtradr_api_client_ruby/models/age_range.rb +0 -223
  154. data/lib/songtradr_api_client_ruby/models/beard.rb +0 -223
  155. data/lib/songtradr_api_client_ruby/models/bounding_box.rb +0 -241
  156. data/lib/songtradr_api_client_ruby/models/dominant_color.rb +0 -268
  157. data/lib/songtradr_api_client_ruby/models/emotion.rb +0 -223
  158. data/lib/songtradr_api_client_ruby/models/eye_direction.rb +0 -232
  159. data/lib/songtradr_api_client_ruby/models/eye_open.rb +0 -223
  160. data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +0 -223
  161. data/lib/songtradr_api_client_ruby/models/face_detail.rb +0 -362
  162. data/lib/songtradr_api_client_ruby/models/face_detection.rb +0 -223
  163. data/lib/songtradr_api_client_ruby/models/face_occluded.rb +0 -223
  164. data/lib/songtradr_api_client_ruby/models/gender.rb +0 -223
  165. data/lib/songtradr_api_client_ruby/models/image_quality.rb +0 -223
  166. data/lib/songtradr_api_client_ruby/models/instance.rb +0 -234
  167. data/lib/songtradr_api_client_ruby/models/label.rb +0 -267
  168. data/lib/songtradr_api_client_ruby/models/label_alias.rb +0 -214
  169. data/lib/songtradr_api_client_ruby/models/label_category.rb +0 -214
  170. data/lib/songtradr_api_client_ruby/models/label_detection.rb +0 -250
  171. data/lib/songtradr_api_client_ruby/models/landmark.rb +0 -232
  172. data/lib/songtradr_api_client_ruby/models/mouth_open.rb +0 -223
  173. data/lib/songtradr_api_client_ruby/models/mustache.rb +0 -223
  174. data/lib/songtradr_api_client_ruby/models/parent.rb +0 -214
  175. data/lib/songtradr_api_client_ruby/models/pose.rb +0 -232
  176. data/lib/songtradr_api_client_ruby/models/smile.rb +0 -223
  177. data/lib/songtradr_api_client_ruby/models/sunglasses.rb +0 -223
  178. data/spec/api_client_spec.rb +0 -223
  179. data/spec/configuration_spec.rb +0 -82
  180. data/spec/models/age_range_spec.rb +0 -42
  181. data/spec/models/beard_spec.rb +0 -42
  182. data/spec/models/bounding_box_spec.rb +0 -54
  183. data/spec/models/dominant_color_spec.rb +0 -72
  184. data/spec/models/emotion_spec.rb +0 -42
  185. data/spec/models/eye_direction_spec.rb +0 -48
  186. data/spec/models/eye_open_spec.rb +0 -42
  187. data/spec/models/eyeglasses_spec.rb +0 -42
  188. data/spec/models/face_detail_spec.rb +0 -132
  189. data/spec/models/face_detection_spec.rb +0 -42
  190. data/spec/models/face_occluded_spec.rb +0 -42
  191. data/spec/models/gender_spec.rb +0 -42
  192. data/spec/models/image_quality_spec.rb +0 -42
  193. data/spec/models/instance_spec.rb +0 -48
  194. data/spec/models/label_alias_spec.rb +0 -36
  195. data/spec/models/label_category_spec.rb +0 -36
  196. data/spec/models/label_detection_spec.rb +0 -60
  197. data/spec/models/label_spec.rb +0 -66
  198. data/spec/models/landmark_spec.rb +0 -48
  199. data/spec/models/mouth_open_spec.rb +0 -42
  200. data/spec/models/mustache_spec.rb +0 -42
  201. data/spec/models/parent_spec.rb +0 -36
  202. data/spec/models/pose_spec.rb +0 -48
  203. data/spec/models/smile_spec.rb +0 -42
  204. data/spec/models/sunglasses_spec.rb +0 -42
@@ -1,241 +0,0 @@
1
- =begin
2
- #Songtradr API
3
-
4
- #This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
5
-
6
- The version of the OpenAPI document: 1.16.0
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module SongtradrApiClientRuby
17
- class BoundingBox
18
- attr_accessor :width
19
-
20
- attr_accessor :height
21
-
22
- attr_accessor :left
23
-
24
- attr_accessor :top
25
-
26
- # Attribute mapping from ruby-style variable name to JSON key.
27
- def self.attribute_map
28
- {
29
- :'width' => :'width',
30
- :'height' => :'height',
31
- :'left' => :'left',
32
- :'top' => :'top'
33
- }
34
- end
35
-
36
- # Returns all the JSON keys this model knows about
37
- def self.acceptable_attributes
38
- attribute_map.values
39
- end
40
-
41
- # Attribute type mapping.
42
- def self.openapi_types
43
- {
44
- :'width' => :'Float',
45
- :'height' => :'Float',
46
- :'left' => :'Float',
47
- :'top' => :'Float'
48
- }
49
- end
50
-
51
- # List of attributes with nullable: true
52
- def self.openapi_nullable
53
- Set.new([
54
- ])
55
- end
56
-
57
- # Initializes the object
58
- # @param [Hash] attributes Model attributes in the form of hash
59
- def initialize(attributes = {})
60
- if (!attributes.is_a?(Hash))
61
- fail ArgumentError, "The input argument (attributes) must be a hash in `SongtradrApiClientRuby::BoundingBox` initialize method"
62
- end
63
-
64
- # check to see if the attribute exists and convert string to symbol for hash key
65
- attributes = attributes.each_with_object({}) { |(k, v), h|
66
- if (!self.class.attribute_map.key?(k.to_sym))
67
- fail ArgumentError, "`#{k}` is not a valid attribute in `SongtradrApiClientRuby::BoundingBox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
68
- end
69
- h[k.to_sym] = v
70
- }
71
-
72
- if attributes.key?(:'width')
73
- self.width = attributes[:'width']
74
- end
75
-
76
- if attributes.key?(:'height')
77
- self.height = attributes[:'height']
78
- end
79
-
80
- if attributes.key?(:'left')
81
- self.left = attributes[:'left']
82
- end
83
-
84
- if attributes.key?(:'top')
85
- self.top = attributes[:'top']
86
- end
87
- end
88
-
89
- # Show invalid properties with the reasons. Usually used together with valid?
90
- # @return Array for valid properties with the reasons
91
- def list_invalid_properties
92
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
93
- invalid_properties = Array.new
94
- invalid_properties
95
- end
96
-
97
- # Check to see if the all the properties in the model are valid
98
- # @return true if the model is valid
99
- def valid?
100
- warn '[DEPRECATED] the `valid?` method is obsolete'
101
- true
102
- end
103
-
104
- # Checks equality by comparing each attribute.
105
- # @param [Object] Object to be compared
106
- def ==(o)
107
- return true if self.equal?(o)
108
- self.class == o.class &&
109
- width == o.width &&
110
- height == o.height &&
111
- left == o.left &&
112
- top == o.top
113
- end
114
-
115
- # @see the `==` method
116
- # @param [Object] Object to be compared
117
- def eql?(o)
118
- self == o
119
- end
120
-
121
- # Calculates hash code according to all attributes.
122
- # @return [Integer] Hash code
123
- def hash
124
- [width, height, left, top].hash
125
- end
126
-
127
- # Builds the object from hash
128
- # @param [Hash] attributes Model attributes in the form of hash
129
- # @return [Object] Returns the model itself
130
- def self.build_from_hash(attributes)
131
- return nil unless attributes.is_a?(Hash)
132
- attributes = attributes.transform_keys(&:to_sym)
133
- transformed_hash = {}
134
- openapi_types.each_pair do |key, type|
135
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
136
- transformed_hash["#{key}"] = nil
137
- elsif type =~ /\AArray<(.*)>/i
138
- # check to ensure the input is an array given that the attribute
139
- # is documented as an array but the input is not
140
- if attributes[attribute_map[key]].is_a?(Array)
141
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
142
- end
143
- elsif !attributes[attribute_map[key]].nil?
144
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
145
- end
146
- end
147
- new(transformed_hash)
148
- end
149
-
150
- # Deserializes the data based on type
151
- # @param string type Data type
152
- # @param string value Value to be deserialized
153
- # @return [Object] Deserialized data
154
- def self._deserialize(type, value)
155
- case type.to_sym
156
- when :Time
157
- Time.parse(value)
158
- when :Date
159
- Date.parse(value)
160
- when :String
161
- value.to_s
162
- when :Integer
163
- value.to_i
164
- when :Float
165
- value.to_f
166
- when :Boolean
167
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
- true
169
- else
170
- false
171
- end
172
- when :Object
173
- # generic object (usually a Hash), return directly
174
- value
175
- when /\AArray<(?<inner_type>.+)>\z/
176
- inner_type = Regexp.last_match[:inner_type]
177
- value.map { |v| _deserialize(inner_type, v) }
178
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
- k_type = Regexp.last_match[:k_type]
180
- v_type = Regexp.last_match[:v_type]
181
- {}.tap do |hash|
182
- value.each do |k, v|
183
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
- end
185
- end
186
- else # model
187
- # models (e.g. Pet) or oneOf
188
- klass = SongtradrApiClientRuby.const_get(type)
189
- klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
190
- end
191
- end
192
-
193
- # Returns the string representation of the object
194
- # @return [String] String presentation of the object
195
- def to_s
196
- to_hash.to_s
197
- end
198
-
199
- # to_body is an alias to to_hash (backward compatibility)
200
- # @return [Hash] Returns the object in the form of hash
201
- def to_body
202
- to_hash
203
- end
204
-
205
- # Returns the object in the form of hash
206
- # @return [Hash] Returns the object in the form of hash
207
- def to_hash
208
- hash = {}
209
- self.class.attribute_map.each_pair do |attr, param|
210
- value = self.send(attr)
211
- if value.nil?
212
- is_nullable = self.class.openapi_nullable.include?(attr)
213
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
214
- end
215
-
216
- hash[param] = _to_hash(value)
217
- end
218
- hash
219
- end
220
-
221
- # Outputs non-array value in the form of hash
222
- # For object, use to_hash. Otherwise, just return the value
223
- # @param [Object] value Any valid value
224
- # @return [Hash] Returns the value in the form of hash
225
- def _to_hash(value)
226
- if value.is_a?(Array)
227
- value.compact.map { |v| _to_hash(v) }
228
- elsif value.is_a?(Hash)
229
- {}.tap do |hash|
230
- value.each { |k, v| hash[k] = _to_hash(v) }
231
- end
232
- elsif value.respond_to? :to_hash
233
- value.to_hash
234
- else
235
- value
236
- end
237
- end
238
-
239
- end
240
-
241
- end
@@ -1,268 +0,0 @@
1
- =begin
2
- #Songtradr API
3
-
4
- #This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
5
-
6
- The version of the OpenAPI document: 1.16.0
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.2.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module SongtradrApiClientRuby
17
- class DominantColor
18
- attr_accessor :red
19
-
20
- attr_accessor :blue
21
-
22
- attr_accessor :green
23
-
24
- attr_accessor :hex_code
25
-
26
- attr_accessor :simplified_color
27
-
28
- attr_accessor :pixel_percent
29
-
30
- attr_accessor :csscolor
31
-
32
- # Attribute mapping from ruby-style variable name to JSON key.
33
- def self.attribute_map
34
- {
35
- :'red' => :'red',
36
- :'blue' => :'blue',
37
- :'green' => :'green',
38
- :'hex_code' => :'hexCode',
39
- :'simplified_color' => :'simplifiedColor',
40
- :'pixel_percent' => :'pixelPercent',
41
- :'csscolor' => :'csscolor'
42
- }
43
- end
44
-
45
- # Returns all the JSON keys this model knows about
46
- def self.acceptable_attributes
47
- attribute_map.values
48
- end
49
-
50
- # Attribute type mapping.
51
- def self.openapi_types
52
- {
53
- :'red' => :'Integer',
54
- :'blue' => :'Integer',
55
- :'green' => :'Integer',
56
- :'hex_code' => :'String',
57
- :'simplified_color' => :'String',
58
- :'pixel_percent' => :'Float',
59
- :'csscolor' => :'String'
60
- }
61
- end
62
-
63
- # List of attributes with nullable: true
64
- def self.openapi_nullable
65
- Set.new([
66
- ])
67
- end
68
-
69
- # Initializes the object
70
- # @param [Hash] attributes Model attributes in the form of hash
71
- def initialize(attributes = {})
72
- if (!attributes.is_a?(Hash))
73
- fail ArgumentError, "The input argument (attributes) must be a hash in `SongtradrApiClientRuby::DominantColor` initialize method"
74
- end
75
-
76
- # check to see if the attribute exists and convert string to symbol for hash key
77
- attributes = attributes.each_with_object({}) { |(k, v), h|
78
- if (!self.class.attribute_map.key?(k.to_sym))
79
- fail ArgumentError, "`#{k}` is not a valid attribute in `SongtradrApiClientRuby::DominantColor`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
80
- end
81
- h[k.to_sym] = v
82
- }
83
-
84
- if attributes.key?(:'red')
85
- self.red = attributes[:'red']
86
- end
87
-
88
- if attributes.key?(:'blue')
89
- self.blue = attributes[:'blue']
90
- end
91
-
92
- if attributes.key?(:'green')
93
- self.green = attributes[:'green']
94
- end
95
-
96
- if attributes.key?(:'hex_code')
97
- self.hex_code = attributes[:'hex_code']
98
- end
99
-
100
- if attributes.key?(:'simplified_color')
101
- self.simplified_color = attributes[:'simplified_color']
102
- end
103
-
104
- if attributes.key?(:'pixel_percent')
105
- self.pixel_percent = attributes[:'pixel_percent']
106
- end
107
-
108
- if attributes.key?(:'csscolor')
109
- self.csscolor = attributes[:'csscolor']
110
- end
111
- end
112
-
113
- # Show invalid properties with the reasons. Usually used together with valid?
114
- # @return Array for valid properties with the reasons
115
- def list_invalid_properties
116
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
117
- invalid_properties = Array.new
118
- invalid_properties
119
- end
120
-
121
- # Check to see if the all the properties in the model are valid
122
- # @return true if the model is valid
123
- def valid?
124
- warn '[DEPRECATED] the `valid?` method is obsolete'
125
- true
126
- end
127
-
128
- # Checks equality by comparing each attribute.
129
- # @param [Object] Object to be compared
130
- def ==(o)
131
- return true if self.equal?(o)
132
- self.class == o.class &&
133
- red == o.red &&
134
- blue == o.blue &&
135
- green == o.green &&
136
- hex_code == o.hex_code &&
137
- simplified_color == o.simplified_color &&
138
- pixel_percent == o.pixel_percent &&
139
- csscolor == o.csscolor
140
- end
141
-
142
- # @see the `==` method
143
- # @param [Object] Object to be compared
144
- def eql?(o)
145
- self == o
146
- end
147
-
148
- # Calculates hash code according to all attributes.
149
- # @return [Integer] Hash code
150
- def hash
151
- [red, blue, green, hex_code, simplified_color, pixel_percent, csscolor].hash
152
- end
153
-
154
- # Builds the object from hash
155
- # @param [Hash] attributes Model attributes in the form of hash
156
- # @return [Object] Returns the model itself
157
- def self.build_from_hash(attributes)
158
- return nil unless attributes.is_a?(Hash)
159
- attributes = attributes.transform_keys(&:to_sym)
160
- transformed_hash = {}
161
- openapi_types.each_pair do |key, type|
162
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
163
- transformed_hash["#{key}"] = nil
164
- elsif type =~ /\AArray<(.*)>/i
165
- # check to ensure the input is an array given that the attribute
166
- # is documented as an array but the input is not
167
- if attributes[attribute_map[key]].is_a?(Array)
168
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
169
- end
170
- elsif !attributes[attribute_map[key]].nil?
171
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
172
- end
173
- end
174
- new(transformed_hash)
175
- end
176
-
177
- # Deserializes the data based on type
178
- # @param string type Data type
179
- # @param string value Value to be deserialized
180
- # @return [Object] Deserialized data
181
- def self._deserialize(type, value)
182
- case type.to_sym
183
- when :Time
184
- Time.parse(value)
185
- when :Date
186
- Date.parse(value)
187
- when :String
188
- value.to_s
189
- when :Integer
190
- value.to_i
191
- when :Float
192
- value.to_f
193
- when :Boolean
194
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
195
- true
196
- else
197
- false
198
- end
199
- when :Object
200
- # generic object (usually a Hash), return directly
201
- value
202
- when /\AArray<(?<inner_type>.+)>\z/
203
- inner_type = Regexp.last_match[:inner_type]
204
- value.map { |v| _deserialize(inner_type, v) }
205
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
206
- k_type = Regexp.last_match[:k_type]
207
- v_type = Regexp.last_match[:v_type]
208
- {}.tap do |hash|
209
- value.each do |k, v|
210
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
211
- end
212
- end
213
- else # model
214
- # models (e.g. Pet) or oneOf
215
- klass = SongtradrApiClientRuby.const_get(type)
216
- klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
217
- end
218
- end
219
-
220
- # Returns the string representation of the object
221
- # @return [String] String presentation of the object
222
- def to_s
223
- to_hash.to_s
224
- end
225
-
226
- # to_body is an alias to to_hash (backward compatibility)
227
- # @return [Hash] Returns the object in the form of hash
228
- def to_body
229
- to_hash
230
- end
231
-
232
- # Returns the object in the form of hash
233
- # @return [Hash] Returns the object in the form of hash
234
- def to_hash
235
- hash = {}
236
- self.class.attribute_map.each_pair do |attr, param|
237
- value = self.send(attr)
238
- if value.nil?
239
- is_nullable = self.class.openapi_nullable.include?(attr)
240
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
241
- end
242
-
243
- hash[param] = _to_hash(value)
244
- end
245
- hash
246
- end
247
-
248
- # Outputs non-array value in the form of hash
249
- # For object, use to_hash. Otherwise, just return the value
250
- # @param [Object] value Any valid value
251
- # @return [Hash] Returns the value in the form of hash
252
- def _to_hash(value)
253
- if value.is_a?(Array)
254
- value.compact.map { |v| _to_hash(v) }
255
- elsif value.is_a?(Hash)
256
- {}.tap do |hash|
257
- value.each { |k, v| hash[k] = _to_hash(v) }
258
- end
259
- elsif value.respond_to? :to_hash
260
- value.to_hash
261
- else
262
- value
263
- end
264
- end
265
-
266
- end
267
-
268
- end