songtradr_api_client_ruby 1.12.22 → 1.12.24

Sign up to get free protection for your applications and to get access to all the features.
Files changed (178) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +4 -4
  3. data/README.md +26 -12
  4. data/docs/APIKeysApi.md +217 -0
  5. data/docs/AdminApiUserDTO.md +70 -0
  6. data/docs/AllowedValuesApi.md +2 -2
  7. data/docs/ApiKeyDTO.md +24 -0
  8. data/docs/CreateApiKeyDTO.md +18 -0
  9. data/docs/FileSmallDTO.md +16 -16
  10. data/docs/MusicalFeaturesDTO.md +82 -82
  11. data/docs/PlaylistLargeDTO.md +9 -9
  12. data/docs/ProductMediumDTO.md +2 -2
  13. data/docs/RecordingApi.md +2 -0
  14. data/docs/RecordingGenrePredictionDTO.md +3 -3
  15. data/docs/RecordingLargeDTO.md +11 -11
  16. data/docs/RecordingMediumDTO.md +7 -7
  17. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
  18. data/docs/RecordingPlaylistDTO.md +3 -3
  19. data/docs/RecordingSmallDTO.md +3 -3
  20. data/docs/UserApi.md +4 -0
  21. data/docs/UserDTO.md +20 -0
  22. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +4 -4
  23. data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +213 -0
  24. data/lib/songtradr_api_client_ruby/api/party_api.rb +1 -1
  25. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -1
  26. data/lib/songtradr_api_client_ruby/api/recording_api.rb +4 -1
  27. data/lib/songtradr_api_client_ruby/api/user_api.rb +7 -1
  28. data/lib/songtradr_api_client_ruby/api_client.rb +1 -1
  29. data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
  30. data/lib/songtradr_api_client_ruby/configuration.rb +10 -8
  31. data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +448 -0
  32. data/lib/songtradr_api_client_ruby/models/api_key_dto.rb +262 -0
  33. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +17 -18
  34. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +15 -18
  35. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +17 -18
  36. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +17 -18
  37. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +15 -18
  38. data/lib/songtradr_api_client_ruby/models/create_api_key_dto.rb +214 -0
  39. data/lib/songtradr_api_client_ruby/models/error_response.rb +19 -18
  40. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +19 -18
  41. data/lib/songtradr_api_client_ruby/models/file_dto.rb +23 -18
  42. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +21 -18
  43. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +19 -18
  44. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +81 -76
  45. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +13 -18
  46. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +17 -18
  47. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +15 -18
  48. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +15 -18
  49. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +17 -18
  50. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +15 -18
  51. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +17 -18
  52. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +13 -18
  53. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +17 -18
  54. data/lib/songtradr_api_client_ruby/models/login_dto.rb +17 -18
  55. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +529 -534
  56. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +15 -18
  57. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +15 -18
  58. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +17 -18
  59. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +54 -57
  60. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +35 -28
  61. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +15 -18
  62. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +17 -18
  63. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +37 -36
  64. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +94 -77
  65. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +21 -18
  66. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +64 -51
  67. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +28 -31
  68. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +15 -18
  69. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +15 -18
  70. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +15 -18
  71. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +26 -31
  72. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +36 -31
  73. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +15 -18
  74. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +17 -18
  75. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +21 -18
  76. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +15 -18
  77. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +17 -18
  78. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +17 -18
  79. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +15 -18
  80. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +13 -18
  81. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +13 -18
  82. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +15 -18
  83. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +95 -18
  84. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +15 -18
  85. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +15 -18
  86. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +19 -18
  87. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +17 -18
  88. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +17 -18
  89. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +17 -18
  90. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +17 -18
  91. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +17 -18
  92. data/lib/songtradr_api_client_ruby/models/title_dto.rb +15 -18
  93. data/lib/songtradr_api_client_ruby/models/token_request.rb +15 -18
  94. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +17 -18
  95. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +17 -18
  96. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +13 -18
  97. data/lib/songtradr_api_client_ruby/models/user_dto.rb +210 -19
  98. data/lib/songtradr_api_client_ruby/version.rb +2 -2
  99. data/lib/songtradr_api_client_ruby.rb +5 -1
  100. data/openapi-generator-config.yaml +1 -1
  101. data/songtradr_api_client_ruby.gemspec +1 -1
  102. data/spec/api/allowed_values_api_spec.rb +2 -2
  103. data/spec/api/api_keys_api_spec.rb +70 -0
  104. data/spec/api/party_api_spec.rb +1 -1
  105. data/spec/api/playlist_api_spec.rb +1 -1
  106. data/spec/api/recording_api_spec.rb +2 -1
  107. data/spec/api/user_api_spec.rb +3 -1
  108. data/spec/api_client_spec.rb +1 -1
  109. data/spec/configuration_spec.rb +1 -1
  110. data/spec/models/admin_api_user_dto_spec.rb +190 -0
  111. data/spec/models/api_key_dto_spec.rb +52 -0
  112. data/spec/models/category_medium_dto_spec.rb +1 -1
  113. data/spec/models/category_minimal_dto_spec.rb +1 -1
  114. data/spec/models/config_access_dto_spec.rb +1 -1
  115. data/spec/models/config_identifier_dto_spec.rb +1 -1
  116. data/spec/models/contributor_type_dto_spec.rb +1 -1
  117. data/spec/models/create_api_key_dto_spec.rb +34 -0
  118. data/spec/models/error_response_spec.rb +1 -1
  119. data/spec/models/field_summary_dto_spec.rb +1 -1
  120. data/spec/models/file_dto_spec.rb +1 -1
  121. data/spec/models/file_list_dto_spec.rb +1 -1
  122. data/spec/models/file_minimal_with_url_dto_spec.rb +1 -1
  123. data/spec/models/file_small_dto_spec.rb +15 -15
  124. data/spec/models/file_upload_dto_spec.rb +1 -1
  125. data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
  126. data/spec/models/files_summary_dto_spec.rb +1 -1
  127. data/spec/models/forgot_password_dto_spec.rb +1 -1
  128. data/spec/models/genre_dto_spec.rb +1 -1
  129. data/spec/models/genre_minimal_dto_spec.rb +1 -1
  130. data/spec/models/genres_summary_dto_spec.rb +1 -1
  131. data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
  132. data/spec/models/jwt_token_dto_spec.rb +1 -1
  133. data/spec/models/login_dto_spec.rb +1 -1
  134. data/spec/models/musical_features_dto_spec.rb +175 -175
  135. data/spec/models/p_line_dto_spec.rb +1 -1
  136. data/spec/models/party_large_dto_spec.rb +1 -1
  137. data/spec/models/party_small_dto_spec.rb +1 -1
  138. data/spec/models/playlist_large_dto_spec.rb +10 -10
  139. data/spec/models/product_medium_dto_spec.rb +7 -7
  140. data/spec/models/product_party_dto_spec.rb +1 -1
  141. data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
  142. data/spec/models/recording_genre_prediction_dto_spec.rb +3 -3
  143. data/spec/models/recording_large_dto_spec.rb +12 -12
  144. data/spec/models/recording_list_dto_spec.rb +1 -1
  145. data/spec/models/recording_medium_dto_spec.rb +9 -9
  146. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +3 -3
  147. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
  148. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
  149. data/spec/models/recording_party_dto_spec.rb +1 -1
  150. data/spec/models/recording_playlist_dto_spec.rb +4 -4
  151. data/spec/models/recording_small_dto_spec.rb +4 -4
  152. data/spec/models/recording_tag_small_dto_spec.rb +1 -1
  153. data/spec/models/save_file_recording_dto_spec.rb +1 -1
  154. data/spec/models/save_playlist_dto_spec.rb +1 -1
  155. data/spec/models/save_recording_genre_dto_spec.rb +1 -1
  156. data/spec/models/save_recording_party_dto_spec.rb +1 -1
  157. data/spec/models/save_recording_playlist_dto_spec.rb +1 -1
  158. data/spec/models/save_recording_tag_dto_spec.rb +1 -1
  159. data/spec/models/save_referrer_dto_spec.rb +1 -1
  160. data/spec/models/save_taggrams_dto_spec.rb +1 -1
  161. data/spec/models/save_user_dto_spec.rb +1 -1
  162. data/spec/models/search_filter_values_dto_spec.rb +1 -1
  163. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +1 -1
  164. data/spec/models/search_recording_granular_dto_spec.rb +1 -1
  165. data/spec/models/sign_up_dto_spec.rb +1 -1
  166. data/spec/models/tag_dto_spec.rb +1 -1
  167. data/spec/models/tag_small_dto_spec.rb +1 -1
  168. data/spec/models/taggram_dto_spec.rb +1 -1
  169. data/spec/models/tags_summary_dto_spec.rb +1 -1
  170. data/spec/models/tagstrength_dto_spec.rb +1 -1
  171. data/spec/models/title_dto_spec.rb +1 -1
  172. data/spec/models/token_request_spec.rb +1 -1
  173. data/spec/models/track_to_medium_product_dto_spec.rb +1 -1
  174. data/spec/models/update_password_dto_spec.rb +1 -1
  175. data/spec/models/usage_dto_spec.rb +1 -1
  176. data/spec/models/user_dto_spec.rb +61 -1
  177. data/spec/spec_helper.rb +1 -1
  178. metadata +72 -56
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 1.12.22
6
+ The version of the OpenAPI document: 1.12.24
7
7
  Contact: info@songtradr.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 7.0.0-SNAPSHOT
@@ -68,12 +68,15 @@ module SongtradrApiClientRuby
68
68
 
69
69
  if attributes.key?(:'text')
70
70
  self.text = attributes[:'text']
71
+ else
72
+ self.text = nil
71
73
  end
72
74
  end
73
75
 
74
76
  # Show invalid properties with the reasons. Usually used together with valid?
75
77
  # @return Array for valid properties with the reasons
76
78
  def list_invalid_properties
79
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
77
80
  invalid_properties = Array.new
78
81
  if @text.nil?
79
82
  invalid_properties.push('invalid value for "text", text cannot be nil.')
@@ -85,6 +88,7 @@ module SongtradrApiClientRuby
85
88
  # Check to see if the all the properties in the model are valid
86
89
  # @return true if the model is valid
87
90
  def valid?
91
+ warn '[DEPRECATED] the `valid?` method is obsolete'
88
92
  return false if @text.nil?
89
93
  true
90
94
  end
@@ -114,37 +118,30 @@ module SongtradrApiClientRuby
114
118
  # @param [Hash] attributes Model attributes in the form of hash
115
119
  # @return [Object] Returns the model itself
116
120
  def self.build_from_hash(attributes)
117
- new.build_from_hash(attributes)
118
- end
119
-
120
- # Builds the object from hash
121
- # @param [Hash] attributes Model attributes in the form of hash
122
- # @return [Object] Returns the model itself
123
- def build_from_hash(attributes)
124
121
  return nil unless attributes.is_a?(Hash)
125
122
  attributes = attributes.transform_keys(&:to_sym)
126
- self.class.openapi_types.each_pair do |key, type|
127
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
128
- self.send("#{key}=", nil)
123
+ transformed_hash = {}
124
+ openapi_types.each_pair do |key, type|
125
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
126
+ transformed_hash["#{key}"] = nil
129
127
  elsif type =~ /\AArray<(.*)>/i
130
128
  # check to ensure the input is an array given that the attribute
131
129
  # is documented as an array but the input is not
132
- if attributes[self.class.attribute_map[key]].is_a?(Array)
133
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
130
+ if attributes[attribute_map[key]].is_a?(Array)
131
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
134
132
  end
135
- elsif !attributes[self.class.attribute_map[key]].nil?
136
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
133
+ elsif !attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
137
135
  end
138
136
  end
139
-
140
- self
137
+ new(transformed_hash)
141
138
  end
142
139
 
143
140
  # Deserializes the data based on type
144
141
  # @param string type Data type
145
142
  # @param string value Value to be deserialized
146
143
  # @return [Object] Deserialized data
147
- def _deserialize(type, value)
144
+ def self._deserialize(type, value)
148
145
  case type.to_sym
149
146
  when :Time
150
147
  Time.parse(value)
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 1.12.22
6
+ The version of the OpenAPI document: 1.12.24
7
7
  Contact: info@songtradr.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 7.0.0-SNAPSHOT
@@ -88,6 +88,8 @@ module SongtradrApiClientRuby
88
88
 
89
89
  if attributes.key?(:'full_name')
90
90
  self.full_name = attributes[:'full_name']
91
+ else
92
+ self.full_name = nil
91
93
  end
92
94
 
93
95
  if attributes.key?(:'birth_date')
@@ -122,6 +124,7 @@ module SongtradrApiClientRuby
122
124
  # Show invalid properties with the reasons. Usually used together with valid?
123
125
  # @return Array for valid properties with the reasons
124
126
  def list_invalid_properties
127
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
125
128
  invalid_properties = Array.new
126
129
  if @full_name.nil?
127
130
  invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
@@ -133,6 +136,7 @@ module SongtradrApiClientRuby
133
136
  # Check to see if the all the properties in the model are valid
134
137
  # @return true if the model is valid
135
138
  def valid?
139
+ warn '[DEPRECATED] the `valid?` method is obsolete'
136
140
  return false if @full_name.nil?
137
141
  true
138
142
  end
@@ -168,37 +172,30 @@ module SongtradrApiClientRuby
168
172
  # @param [Hash] attributes Model attributes in the form of hash
169
173
  # @return [Object] Returns the model itself
170
174
  def self.build_from_hash(attributes)
171
- new.build_from_hash(attributes)
172
- end
173
-
174
- # Builds the object from hash
175
- # @param [Hash] attributes Model attributes in the form of hash
176
- # @return [Object] Returns the model itself
177
- def build_from_hash(attributes)
178
175
  return nil unless attributes.is_a?(Hash)
179
176
  attributes = attributes.transform_keys(&:to_sym)
180
- self.class.openapi_types.each_pair do |key, type|
181
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
182
- self.send("#{key}=", nil)
177
+ transformed_hash = {}
178
+ openapi_types.each_pair do |key, type|
179
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
180
+ transformed_hash["#{key}"] = nil
183
181
  elsif type =~ /\AArray<(.*)>/i
184
182
  # check to ensure the input is an array given that the attribute
185
183
  # is documented as an array but the input is not
186
- if attributes[self.class.attribute_map[key]].is_a?(Array)
187
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
184
+ if attributes[attribute_map[key]].is_a?(Array)
185
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
188
186
  end
189
- elsif !attributes[self.class.attribute_map[key]].nil?
190
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
187
+ elsif !attributes[attribute_map[key]].nil?
188
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
191
189
  end
192
190
  end
193
-
194
- self
191
+ new(transformed_hash)
195
192
  end
196
193
 
197
194
  # Deserializes the data based on type
198
195
  # @param string type Data type
199
196
  # @param string value Value to be deserialized
200
197
  # @return [Object] Deserialized data
201
- def _deserialize(type, value)
198
+ def self._deserialize(type, value)
202
199
  case type.to_sym
203
200
  when :Time
204
201
  Time.parse(value)
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 1.12.22
6
+ The version of the OpenAPI document: 1.12.24
7
7
  Contact: info@songtradr.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 7.0.0-SNAPSHOT
@@ -64,16 +64,21 @@ module SongtradrApiClientRuby
64
64
 
65
65
  if attributes.key?(:'id')
66
66
  self.id = attributes[:'id']
67
+ else
68
+ self.id = nil
67
69
  end
68
70
 
69
71
  if attributes.key?(:'full_name')
70
72
  self.full_name = attributes[:'full_name']
73
+ else
74
+ self.full_name = nil
71
75
  end
72
76
  end
73
77
 
74
78
  # Show invalid properties with the reasons. Usually used together with valid?
75
79
  # @return Array for valid properties with the reasons
76
80
  def list_invalid_properties
81
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
77
82
  invalid_properties = Array.new
78
83
  if @id.nil?
79
84
  invalid_properties.push('invalid value for "id", id cannot be nil.')
@@ -89,6 +94,7 @@ module SongtradrApiClientRuby
89
94
  # Check to see if the all the properties in the model are valid
90
95
  # @return true if the model is valid
91
96
  def valid?
97
+ warn '[DEPRECATED] the `valid?` method is obsolete'
92
98
  return false if @id.nil?
93
99
  return false if @full_name.nil?
94
100
  true
@@ -119,37 +125,30 @@ module SongtradrApiClientRuby
119
125
  # @param [Hash] attributes Model attributes in the form of hash
120
126
  # @return [Object] Returns the model itself
121
127
  def self.build_from_hash(attributes)
122
- new.build_from_hash(attributes)
123
- end
124
-
125
- # Builds the object from hash
126
- # @param [Hash] attributes Model attributes in the form of hash
127
- # @return [Object] Returns the model itself
128
- def build_from_hash(attributes)
129
128
  return nil unless attributes.is_a?(Hash)
130
129
  attributes = attributes.transform_keys(&:to_sym)
131
- self.class.openapi_types.each_pair do |key, type|
132
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
133
- self.send("#{key}=", nil)
130
+ transformed_hash = {}
131
+ openapi_types.each_pair do |key, type|
132
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
133
+ transformed_hash["#{key}"] = nil
134
134
  elsif type =~ /\AArray<(.*)>/i
135
135
  # check to ensure the input is an array given that the attribute
136
136
  # is documented as an array but the input is not
137
- if attributes[self.class.attribute_map[key]].is_a?(Array)
138
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
137
+ if attributes[attribute_map[key]].is_a?(Array)
138
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
139
139
  end
140
- elsif !attributes[self.class.attribute_map[key]].nil?
141
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
140
+ elsif !attributes[attribute_map[key]].nil?
141
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
142
142
  end
143
143
  end
144
-
145
- self
144
+ new(transformed_hash)
146
145
  end
147
146
 
148
147
  # Deserializes the data based on type
149
148
  # @param string type Data type
150
149
  # @param string value Value to be deserialized
151
150
  # @return [Object] Deserialized data
152
- def _deserialize(type, value)
151
+ def self._deserialize(type, value)
153
152
  case type.to_sym
154
153
  when :Time
155
154
  Time.parse(value)
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 1.12.22
6
+ The version of the OpenAPI document: 1.12.24
7
7
  Contact: info@songtradr.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 7.0.0-SNAPSHOT
@@ -20,24 +20,24 @@ module SongtradrApiClientRuby
20
20
 
21
21
  attr_accessor :state
22
22
 
23
- attr_accessor :description
24
-
25
23
  attr_accessor :usages
26
24
 
27
- attr_accessor :created
28
-
29
- attr_accessor :updated
25
+ attr_accessor :description
30
26
 
31
27
  attr_accessor :songtradr_playlist_guid
32
28
 
33
- attr_accessor :tracks
34
-
35
29
  attr_accessor :asset_url
36
30
 
37
31
  attr_accessor :pretzel_tier
38
32
 
39
33
  attr_accessor :usage
40
34
 
35
+ attr_accessor :tracks
36
+
37
+ attr_accessor :created
38
+
39
+ attr_accessor :updated
40
+
41
41
  class EnumAttributeValidator
42
42
  attr_reader :datatype
43
43
  attr_reader :allowable_values
@@ -65,15 +65,15 @@ module SongtradrApiClientRuby
65
65
  {
66
66
  :'name' => :'name',
67
67
  :'state' => :'state',
68
- :'description' => :'description',
69
68
  :'usages' => :'usages',
70
- :'created' => :'created',
71
- :'updated' => :'updated',
69
+ :'description' => :'description',
72
70
  :'songtradr_playlist_guid' => :'songtradrPlaylistGuid',
73
- :'tracks' => :'tracks',
74
71
  :'asset_url' => :'assetURL',
75
72
  :'pretzel_tier' => :'pretzelTier',
76
- :'usage' => :'usage'
73
+ :'usage' => :'usage',
74
+ :'tracks' => :'tracks',
75
+ :'created' => :'created',
76
+ :'updated' => :'updated'
77
77
  }
78
78
  end
79
79
 
@@ -87,15 +87,15 @@ module SongtradrApiClientRuby
87
87
  {
88
88
  :'name' => :'String',
89
89
  :'state' => :'String',
90
- :'description' => :'String',
91
90
  :'usages' => :'Array<UsageDTO>',
92
- :'created' => :'Time',
93
- :'updated' => :'Time',
91
+ :'description' => :'String',
94
92
  :'songtradr_playlist_guid' => :'String',
95
- :'tracks' => :'Array<RecordingPlaylistDTO>',
96
93
  :'asset_url' => :'String',
97
94
  :'pretzel_tier' => :'String',
98
- :'usage' => :'String'
95
+ :'usage' => :'String',
96
+ :'tracks' => :'Array<RecordingPlaylistDTO>',
97
+ :'created' => :'Time',
98
+ :'updated' => :'Time'
99
99
  }
100
100
  end
101
101
 
@@ -122,40 +122,28 @@ module SongtradrApiClientRuby
122
122
 
123
123
  if attributes.key?(:'name')
124
124
  self.name = attributes[:'name']
125
+ else
126
+ self.name = nil
125
127
  end
126
128
 
127
129
  if attributes.key?(:'state')
128
130
  self.state = attributes[:'state']
129
131
  end
130
132
 
131
- if attributes.key?(:'description')
132
- self.description = attributes[:'description']
133
- end
134
-
135
133
  if attributes.key?(:'usages')
136
134
  if (value = attributes[:'usages']).is_a?(Array)
137
135
  self.usages = value
138
136
  end
139
137
  end
140
138
 
141
- if attributes.key?(:'created')
142
- self.created = attributes[:'created']
143
- end
144
-
145
- if attributes.key?(:'updated')
146
- self.updated = attributes[:'updated']
139
+ if attributes.key?(:'description')
140
+ self.description = attributes[:'description']
147
141
  end
148
142
 
149
143
  if attributes.key?(:'songtradr_playlist_guid')
150
144
  self.songtradr_playlist_guid = attributes[:'songtradr_playlist_guid']
151
145
  end
152
146
 
153
- if attributes.key?(:'tracks')
154
- if (value = attributes[:'tracks']).is_a?(Array)
155
- self.tracks = value
156
- end
157
- end
158
-
159
147
  if attributes.key?(:'asset_url')
160
148
  self.asset_url = attributes[:'asset_url']
161
149
  end
@@ -167,11 +155,26 @@ module SongtradrApiClientRuby
167
155
  if attributes.key?(:'usage')
168
156
  self.usage = attributes[:'usage']
169
157
  end
158
+
159
+ if attributes.key?(:'tracks')
160
+ if (value = attributes[:'tracks']).is_a?(Array)
161
+ self.tracks = value
162
+ end
163
+ end
164
+
165
+ if attributes.key?(:'created')
166
+ self.created = attributes[:'created']
167
+ end
168
+
169
+ if attributes.key?(:'updated')
170
+ self.updated = attributes[:'updated']
171
+ end
170
172
  end
171
173
 
172
174
  # Show invalid properties with the reasons. Usually used together with valid?
173
175
  # @return Array for valid properties with the reasons
174
176
  def list_invalid_properties
177
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
175
178
  invalid_properties = Array.new
176
179
  if @name.nil?
177
180
  invalid_properties.push('invalid value for "name", name cannot be nil.')
@@ -183,6 +186,7 @@ module SongtradrApiClientRuby
183
186
  # Check to see if the all the properties in the model are valid
184
187
  # @return true if the model is valid
185
188
  def valid?
189
+ warn '[DEPRECATED] the `valid?` method is obsolete'
186
190
  return false if @name.nil?
187
191
  state_validator = EnumAttributeValidator.new('String', ["active", "draft"])
188
192
  return false unless state_validator.valid?(@state)
@@ -206,15 +210,15 @@ module SongtradrApiClientRuby
206
210
  self.class == o.class &&
207
211
  name == o.name &&
208
212
  state == o.state &&
209
- description == o.description &&
210
213
  usages == o.usages &&
211
- created == o.created &&
212
- updated == o.updated &&
214
+ description == o.description &&
213
215
  songtradr_playlist_guid == o.songtradr_playlist_guid &&
214
- tracks == o.tracks &&
215
216
  asset_url == o.asset_url &&
216
217
  pretzel_tier == o.pretzel_tier &&
217
- usage == o.usage
218
+ usage == o.usage &&
219
+ tracks == o.tracks &&
220
+ created == o.created &&
221
+ updated == o.updated
218
222
  end
219
223
 
220
224
  # @see the `==` method
@@ -226,44 +230,37 @@ module SongtradrApiClientRuby
226
230
  # Calculates hash code according to all attributes.
227
231
  # @return [Integer] Hash code
228
232
  def hash
229
- [name, state, description, usages, created, updated, songtradr_playlist_guid, tracks, asset_url, pretzel_tier, usage].hash
233
+ [name, state, usages, description, songtradr_playlist_guid, asset_url, pretzel_tier, usage, tracks, created, updated].hash
230
234
  end
231
235
 
232
236
  # Builds the object from hash
233
237
  # @param [Hash] attributes Model attributes in the form of hash
234
238
  # @return [Object] Returns the model itself
235
239
  def self.build_from_hash(attributes)
236
- new.build_from_hash(attributes)
237
- end
238
-
239
- # Builds the object from hash
240
- # @param [Hash] attributes Model attributes in the form of hash
241
- # @return [Object] Returns the model itself
242
- def build_from_hash(attributes)
243
240
  return nil unless attributes.is_a?(Hash)
244
241
  attributes = attributes.transform_keys(&:to_sym)
245
- self.class.openapi_types.each_pair do |key, type|
246
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
247
- self.send("#{key}=", nil)
242
+ transformed_hash = {}
243
+ openapi_types.each_pair do |key, type|
244
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
245
+ transformed_hash["#{key}"] = nil
248
246
  elsif type =~ /\AArray<(.*)>/i
249
247
  # check to ensure the input is an array given that the attribute
250
248
  # is documented as an array but the input is not
251
- if attributes[self.class.attribute_map[key]].is_a?(Array)
252
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
249
+ if attributes[attribute_map[key]].is_a?(Array)
250
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
253
251
  end
254
- elsif !attributes[self.class.attribute_map[key]].nil?
255
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
252
+ elsif !attributes[attribute_map[key]].nil?
253
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
256
254
  end
257
255
  end
258
-
259
- self
256
+ new(transformed_hash)
260
257
  end
261
258
 
262
259
  # Deserializes the data based on type
263
260
  # @param string type Data type
264
261
  # @param string value Value to be deserialized
265
262
  # @return [Object] Deserialized data
266
- def _deserialize(type, value)
263
+ def self._deserialize(type, value)
267
264
  case type.to_sym
268
265
  when :Time
269
266
  Time.parse(value)