songtradr_api_client_ruby 1.13.7 → 1.15.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 (241) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -37
  4. data/docs/FileSmallDTO.md +7 -7
  5. data/docs/MusicalFeaturesDTO.md +2 -2
  6. data/docs/PlaylistApi.md +0 -214
  7. data/docs/RecordingApi.md +0 -204
  8. data/docs/RecordingMediumDTO.md +2 -2
  9. data/docs/UserApi.md +0 -456
  10. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
  11. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -201
  12. data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -189
  13. data/lib/songtradr_api_client_ruby/api/user_api.rb +134 -746
  14. data/lib/songtradr_api_client_ruby/api_client.rb +37 -35
  15. data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
  16. data/lib/songtradr_api_client_ruby/configuration.rb +1 -1
  17. data/lib/songtradr_api_client_ruby/models/age_range.rb +2 -2
  18. data/lib/songtradr_api_client_ruby/models/beard.rb +2 -2
  19. data/lib/songtradr_api_client_ruby/models/bounding_box.rb +2 -2
  20. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
  21. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
  22. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
  23. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
  24. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
  25. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +2 -2
  26. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +2 -2
  27. data/lib/songtradr_api_client_ruby/models/dominant_color.rb +2 -2
  28. data/lib/songtradr_api_client_ruby/models/emotion.rb +2 -2
  29. data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
  30. data/lib/songtradr_api_client_ruby/models/eye_direction.rb +2 -2
  31. data/lib/songtradr_api_client_ruby/models/eye_open.rb +2 -2
  32. data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +2 -2
  33. data/lib/songtradr_api_client_ruby/models/face_detail.rb +2 -2
  34. data/lib/songtradr_api_client_ruby/models/face_detection.rb +2 -2
  35. data/lib/songtradr_api_client_ruby/models/face_occluded.rb +2 -2
  36. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
  37. data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
  38. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
  39. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +36 -36
  40. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
  41. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
  42. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
  43. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
  44. data/lib/songtradr_api_client_ruby/models/gender.rb +2 -2
  45. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
  46. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
  47. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
  48. data/lib/songtradr_api_client_ruby/models/image_quality.rb +2 -2
  49. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +2 -2
  50. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
  51. data/lib/songtradr_api_client_ruby/models/instance.rb +2 -2
  52. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
  53. data/lib/songtradr_api_client_ruby/models/label.rb +2 -2
  54. data/lib/songtradr_api_client_ruby/models/label_alias.rb +2 -2
  55. data/lib/songtradr_api_client_ruby/models/label_category.rb +2 -2
  56. data/lib/songtradr_api_client_ruby/models/label_detection.rb +2 -2
  57. data/lib/songtradr_api_client_ruby/models/landmark.rb +2 -2
  58. data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
  59. data/lib/songtradr_api_client_ruby/models/mouth_open.rb +2 -2
  60. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +24 -24
  61. data/lib/songtradr_api_client_ruby/models/mustache.rb +2 -2
  62. data/lib/songtradr_api_client_ruby/models/parent.rb +2 -2
  63. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
  64. data/lib/songtradr_api_client_ruby/models/pose.rb +2 -2
  65. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
  66. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +2 -2
  67. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
  68. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +12 -12
  69. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +2 -2
  70. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
  71. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
  72. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +2 -2
  73. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +2 -2
  74. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
  75. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
  76. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +2 -2
  77. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +2 -2
  78. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
  79. data/lib/songtradr_api_client_ruby/models/smile.rb +2 -2
  80. data/lib/songtradr_api_client_ruby/models/sunglasses.rb +2 -2
  81. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
  82. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
  83. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
  84. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
  85. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
  86. data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
  87. data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
  88. data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
  89. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
  90. data/lib/songtradr_api_client_ruby/models/user_dto.rb +2 -2
  91. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +2 -2
  92. data/lib/songtradr_api_client_ruby/version.rb +2 -2
  93. data/lib/songtradr_api_client_ruby.rb +1 -22
  94. data/openapi-generator-config.yaml +1 -1
  95. data/songtradr_api_client_ruby.gemspec +2 -1
  96. data/spec/api/allowed_values_api_spec.rb +1 -1
  97. data/spec/api/playlist_api_spec.rb +1 -38
  98. data/spec/api/recording_api_spec.rb +1 -34
  99. data/spec/api/user_api_spec.rb +1 -110
  100. data/spec/api_client_spec.rb +1 -1
  101. data/spec/configuration_spec.rb +1 -1
  102. data/spec/models/age_range_spec.rb +1 -1
  103. data/spec/models/beard_spec.rb +1 -1
  104. data/spec/models/bounding_box_spec.rb +1 -1
  105. data/spec/models/category_medium_dto_spec.rb +1 -1
  106. data/spec/models/category_minimal_dto_spec.rb +1 -1
  107. data/spec/models/config_access_dto_spec.rb +1 -1
  108. data/spec/models/config_identifier_dto_spec.rb +1 -1
  109. data/spec/models/contributor_type_dto_spec.rb +1 -1
  110. data/spec/models/curate_playlist_dto_spec.rb +1 -1
  111. data/spec/models/curate_playlist_response_dto_spec.rb +1 -1
  112. data/spec/models/dominant_color_spec.rb +1 -1
  113. data/spec/models/emotion_spec.rb +1 -1
  114. data/spec/models/error_response_spec.rb +1 -1
  115. data/spec/models/eye_direction_spec.rb +1 -1
  116. data/spec/models/eye_open_spec.rb +1 -1
  117. data/spec/models/eyeglasses_spec.rb +1 -1
  118. data/spec/models/face_detail_spec.rb +1 -1
  119. data/spec/models/face_detection_spec.rb +1 -1
  120. data/spec/models/face_occluded_spec.rb +1 -1
  121. data/spec/models/field_summary_dto_spec.rb +1 -1
  122. data/spec/models/file_dto_spec.rb +1 -1
  123. data/spec/models/file_list_dto_spec.rb +1 -1
  124. data/spec/models/file_small_dto_spec.rb +17 -17
  125. data/spec/models/file_upload_dto_spec.rb +1 -1
  126. data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
  127. data/spec/models/files_summary_dto_spec.rb +1 -1
  128. data/spec/models/forgot_password_dto_spec.rb +1 -1
  129. data/spec/models/gender_spec.rb +1 -1
  130. data/spec/models/genre_dto_spec.rb +1 -1
  131. data/spec/models/genre_minimal_dto_spec.rb +1 -1
  132. data/spec/models/genres_summary_dto_spec.rb +1 -1
  133. data/spec/models/image_quality_spec.rb +1 -1
  134. data/spec/models/image_recognition_response_spec.rb +1 -1
  135. data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
  136. data/spec/models/instance_spec.rb +1 -1
  137. data/spec/models/jwt_token_dto_spec.rb +1 -1
  138. data/spec/models/label_alias_spec.rb +1 -1
  139. data/spec/models/label_category_spec.rb +1 -1
  140. data/spec/models/label_detection_spec.rb +1 -1
  141. data/spec/models/label_spec.rb +1 -1
  142. data/spec/models/landmark_spec.rb +1 -1
  143. data/spec/models/login_dto_spec.rb +1 -1
  144. data/spec/models/mouth_open_spec.rb +1 -1
  145. data/spec/models/musical_features_dto_spec.rb +11 -11
  146. data/spec/models/mustache_spec.rb +1 -1
  147. data/spec/models/parent_spec.rb +1 -1
  148. data/spec/models/party_small_dto_spec.rb +1 -1
  149. data/spec/models/pose_spec.rb +1 -1
  150. data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
  151. data/spec/models/recording_genre_prediction_dto_spec.rb +1 -1
  152. data/spec/models/recording_list_dto_spec.rb +1 -1
  153. data/spec/models/recording_medium_dto_spec.rb +3 -3
  154. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +1 -1
  155. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
  156. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
  157. data/spec/models/recording_party_dto_spec.rb +1 -1
  158. data/spec/models/recording_small_dto_spec.rb +1 -1
  159. data/spec/models/recording_tag_small_dto_spec.rb +1 -1
  160. data/spec/models/save_user_dto_spec.rb +1 -1
  161. data/spec/models/search_filter_values_dto_spec.rb +1 -1
  162. data/spec/models/search_recording_granular_dto_spec.rb +1 -1
  163. data/spec/models/sign_up_dto_spec.rb +1 -1
  164. data/spec/models/smile_spec.rb +1 -1
  165. data/spec/models/sunglasses_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_dto_spec.rb +1 -1
  174. data/spec/models/update_password_dto_spec.rb +1 -1
  175. data/spec/models/user_dto_spec.rb +1 -1
  176. data/spec/models/video_recognition_response_spec.rb +1 -1
  177. data/spec/spec_helper.rb +1 -1
  178. metadata +63 -147
  179. data/docs/ContextValue.md +0 -18
  180. data/docs/FileMinimalWithUrlDTO.md +0 -22
  181. data/docs/PLineDTO.md +0 -20
  182. data/docs/PartyApi.md +0 -75
  183. data/docs/PartyLargeDTO.md +0 -32
  184. data/docs/PlaylistLargeDTO.md +0 -38
  185. data/docs/ProductMediumDTO.md +0 -34
  186. data/docs/ProductPartyDTO.md +0 -20
  187. data/docs/RecordingLargeDTO.md +0 -40
  188. data/docs/RecordingPlaylistDTO.md +0 -24
  189. data/docs/SaveFileRecordingDTO.md +0 -240
  190. data/docs/SavePlaylistDTO.md +0 -34
  191. data/docs/SaveRecordingGenreDTO.md +0 -22
  192. data/docs/SaveRecordingPartyDTO.md +0 -20
  193. data/docs/SaveRecordingPlaylistDTO.md +0 -22
  194. data/docs/SaveRecordingTagDTO.md +0 -20
  195. data/docs/SaveReferrerDTO.md +0 -20
  196. data/docs/SaveTaggramsDTO.md +0 -82
  197. data/docs/SearchRecordingGranularAbstractionDTO.md +0 -20
  198. data/docs/TrackToMediumProductDTO.md +0 -22
  199. data/docs/UsageDTO.md +0 -18
  200. data/lib/songtradr_api_client_ruby/api/party_api.rb +0 -84
  201. data/lib/songtradr_api_client_ruby/models/context_value.rb +0 -216
  202. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +0 -254
  203. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +0 -231
  204. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +0 -285
  205. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +0 -350
  206. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +0 -323
  207. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +0 -233
  208. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +0 -383
  209. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +0 -242
  210. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +0 -1864
  211. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +0 -353
  212. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +0 -240
  213. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +0 -272
  214. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +0 -247
  215. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +0 -231
  216. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +0 -224
  217. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +0 -569
  218. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +0 -267
  219. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +0 -247
  220. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +0 -215
  221. data/spec/api/party_api_spec.rb +0 -46
  222. data/spec/models/context_value_spec.rb +0 -36
  223. data/spec/models/file_minimal_with_url_dto_spec.rb +0 -48
  224. data/spec/models/p_line_dto_spec.rb +0 -42
  225. data/spec/models/party_large_dto_spec.rb +0 -78
  226. data/spec/models/playlist_large_dto_spec.rb +0 -100
  227. data/spec/models/product_medium_dto_spec.rb +0 -84
  228. data/spec/models/product_party_dto_spec.rb +0 -42
  229. data/spec/models/recording_large_dto_spec.rb +0 -102
  230. data/spec/models/recording_playlist_dto_spec.rb +0 -54
  231. data/spec/models/save_file_recording_dto_spec.rb +0 -894
  232. data/spec/models/save_playlist_dto_spec.rb +0 -88
  233. data/spec/models/save_recording_genre_dto_spec.rb +0 -48
  234. data/spec/models/save_recording_party_dto_spec.rb +0 -46
  235. data/spec/models/save_recording_playlist_dto_spec.rb +0 -48
  236. data/spec/models/save_recording_tag_dto_spec.rb +0 -42
  237. data/spec/models/save_referrer_dto_spec.rb +0 -42
  238. data/spec/models/save_taggrams_dto_spec.rb +0 -228
  239. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +0 -46
  240. data/spec/models/track_to_medium_product_dto_spec.rb +0 -48
  241. data/spec/models/usage_dto_spec.rb +0 -36
@@ -1,22 +0,0 @@
1
- # SongtradrApiClientRuby::TrackToMediumProductDTO
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **product** | [**ProductMediumDTO**](ProductMediumDTO.md) | | |
8
- | **track_no** | **String** | | |
9
- | **set_no** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'songtradr_api_client_ruby'
15
-
16
- instance = SongtradrApiClientRuby::TrackToMediumProductDTO.new(
17
- product: null,
18
- track_no: null,
19
- set_no: null
20
- )
21
- ```
22
-
data/docs/UsageDTO.md DELETED
@@ -1,18 +0,0 @@
1
- # SongtradrApiClientRuby::UsageDTO
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'songtradr_api_client_ruby'
13
-
14
- instance = SongtradrApiClientRuby::UsageDTO.new(
15
- name: null
16
- )
17
- ```
18
-
@@ -1,84 +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.13.7
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'cgi'
14
-
15
- module SongtradrApiClientRuby
16
- class PartyApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # Information on a person, group or company.
23
- # @param full_name [String] Full Name of the person, group, company or organisation.
24
- # @param [Hash] opts the optional parameters
25
- # @return [PartyLargeDTO]
26
- def party(full_name, opts = {})
27
- data, _status_code, _headers = party_with_http_info(full_name, opts)
28
- data
29
- end
30
-
31
- # Information on a person, group or company.
32
- # @param full_name [String] Full Name of the person, group, company or organisation.
33
- # @param [Hash] opts the optional parameters
34
- # @return [Array<(PartyLargeDTO, Integer, Hash)>] PartyLargeDTO data, response status code and response headers
35
- def party_with_http_info(full_name, opts = {})
36
- if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: PartyApi.party ...'
38
- end
39
- # verify the required parameter 'full_name' is set
40
- if @api_client.config.client_side_validation && full_name.nil?
41
- fail ArgumentError, "Missing the required parameter 'full_name' when calling PartyApi.party"
42
- end
43
- # resource path
44
- local_var_path = '/api/v1/party'
45
-
46
- # query parameters
47
- query_params = opts[:query_params] || {}
48
- query_params[:'fullName'] = full_name
49
-
50
- # header parameters
51
- header_params = opts[:header_params] || {}
52
- # HTTP header 'Accept' (if needed)
53
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
54
-
55
- # form parameters
56
- form_params = opts[:form_params] || {}
57
-
58
- # http body (model)
59
- post_body = opts[:debug_body]
60
-
61
- # return_type
62
- return_type = opts[:debug_return_type] || 'PartyLargeDTO'
63
-
64
- # auth_names
65
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
66
-
67
- new_options = opts.merge(
68
- :operation => :"PartyApi.party",
69
- :header_params => header_params,
70
- :query_params => query_params,
71
- :form_params => form_params,
72
- :body => post_body,
73
- :auth_names => auth_names,
74
- :return_type => return_type
75
- )
76
-
77
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
78
- if @api_client.config.debugging
79
- @api_client.config.logger.debug "API called: PartyApi#party\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
- end
81
- return data, status_code, headers
82
- end
83
- end
84
- end
@@ -1,216 +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.13.7
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module SongtradrApiClientRuby
17
- class ContextValue
18
- attr_accessor :trackids
19
-
20
- # Attribute mapping from ruby-style variable name to JSON key.
21
- def self.attribute_map
22
- {
23
- :'trackids' => :'trackids'
24
- }
25
- end
26
-
27
- # Returns all the JSON keys this model knows about
28
- def self.acceptable_attributes
29
- attribute_map.values
30
- end
31
-
32
- # Attribute type mapping.
33
- def self.openapi_types
34
- {
35
- :'trackids' => :'Array<Integer>'
36
- }
37
- end
38
-
39
- # List of attributes with nullable: true
40
- def self.openapi_nullable
41
- Set.new([
42
- ])
43
- end
44
-
45
- # Initializes the object
46
- # @param [Hash] attributes Model attributes in the form of hash
47
- def initialize(attributes = {})
48
- if (!attributes.is_a?(Hash))
49
- fail ArgumentError, "The input argument (attributes) must be a hash in `SongtradrApiClientRuby::ContextValue` initialize method"
50
- end
51
-
52
- # check to see if the attribute exists and convert string to symbol for hash key
53
- attributes = attributes.each_with_object({}) { |(k, v), h|
54
- if (!self.class.attribute_map.key?(k.to_sym))
55
- fail ArgumentError, "`#{k}` is not a valid attribute in `SongtradrApiClientRuby::ContextValue`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
56
- end
57
- h[k.to_sym] = v
58
- }
59
-
60
- if attributes.key?(:'trackids')
61
- if (value = attributes[:'trackids']).is_a?(Array)
62
- self.trackids = value
63
- end
64
- end
65
- end
66
-
67
- # Show invalid properties with the reasons. Usually used together with valid?
68
- # @return Array for valid properties with the reasons
69
- def list_invalid_properties
70
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
71
- invalid_properties = Array.new
72
- invalid_properties
73
- end
74
-
75
- # Check to see if the all the properties in the model are valid
76
- # @return true if the model is valid
77
- def valid?
78
- warn '[DEPRECATED] the `valid?` method is obsolete'
79
- true
80
- end
81
-
82
- # Checks equality by comparing each attribute.
83
- # @param [Object] Object to be compared
84
- def ==(o)
85
- return true if self.equal?(o)
86
- self.class == o.class &&
87
- trackids == o.trackids
88
- end
89
-
90
- # @see the `==` method
91
- # @param [Object] Object to be compared
92
- def eql?(o)
93
- self == o
94
- end
95
-
96
- # Calculates hash code according to all attributes.
97
- # @return [Integer] Hash code
98
- def hash
99
- [trackids].hash
100
- end
101
-
102
- # Builds the object from hash
103
- # @param [Hash] attributes Model attributes in the form of hash
104
- # @return [Object] Returns the model itself
105
- def self.build_from_hash(attributes)
106
- return nil unless attributes.is_a?(Hash)
107
- attributes = attributes.transform_keys(&:to_sym)
108
- transformed_hash = {}
109
- openapi_types.each_pair do |key, type|
110
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
111
- transformed_hash["#{key}"] = nil
112
- elsif type =~ /\AArray<(.*)>/i
113
- # check to ensure the input is an array given that the attribute
114
- # is documented as an array but the input is not
115
- if attributes[attribute_map[key]].is_a?(Array)
116
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
117
- end
118
- elsif !attributes[attribute_map[key]].nil?
119
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
120
- end
121
- end
122
- new(transformed_hash)
123
- end
124
-
125
- # Deserializes the data based on type
126
- # @param string type Data type
127
- # @param string value Value to be deserialized
128
- # @return [Object] Deserialized data
129
- def self._deserialize(type, value)
130
- case type.to_sym
131
- when :Time
132
- Time.parse(value)
133
- when :Date
134
- Date.parse(value)
135
- when :String
136
- value.to_s
137
- when :Integer
138
- value.to_i
139
- when :Float
140
- value.to_f
141
- when :Boolean
142
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
143
- true
144
- else
145
- false
146
- end
147
- when :Object
148
- # generic object (usually a Hash), return directly
149
- value
150
- when /\AArray<(?<inner_type>.+)>\z/
151
- inner_type = Regexp.last_match[:inner_type]
152
- value.map { |v| _deserialize(inner_type, v) }
153
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
154
- k_type = Regexp.last_match[:k_type]
155
- v_type = Regexp.last_match[:v_type]
156
- {}.tap do |hash|
157
- value.each do |k, v|
158
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
159
- end
160
- end
161
- else # model
162
- # models (e.g. Pet) or oneOf
163
- klass = SongtradrApiClientRuby.const_get(type)
164
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
165
- end
166
- end
167
-
168
- # Returns the string representation of the object
169
- # @return [String] String presentation of the object
170
- def to_s
171
- to_hash.to_s
172
- end
173
-
174
- # to_body is an alias to to_hash (backward compatibility)
175
- # @return [Hash] Returns the object in the form of hash
176
- def to_body
177
- to_hash
178
- end
179
-
180
- # Returns the object in the form of hash
181
- # @return [Hash] Returns the object in the form of hash
182
- def to_hash
183
- hash = {}
184
- self.class.attribute_map.each_pair do |attr, param|
185
- value = self.send(attr)
186
- if value.nil?
187
- is_nullable = self.class.openapi_nullable.include?(attr)
188
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
189
- end
190
-
191
- hash[param] = _to_hash(value)
192
- end
193
- hash
194
- end
195
-
196
- # Outputs non-array value in the form of hash
197
- # For object, use to_hash. Otherwise, just return the value
198
- # @param [Object] value Any valid value
199
- # @return [Hash] Returns the value in the form of hash
200
- def _to_hash(value)
201
- if value.is_a?(Array)
202
- value.compact.map { |v| _to_hash(v) }
203
- elsif value.is_a?(Hash)
204
- {}.tap do |hash|
205
- value.each { |k, v| hash[k] = _to_hash(v) }
206
- end
207
- elsif value.respond_to? :to_hash
208
- value.to_hash
209
- else
210
- value
211
- end
212
- end
213
-
214
- end
215
-
216
- end
@@ -1,254 +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.13.7
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module SongtradrApiClientRuby
17
- # Minimal infos on a file that has been uploaded for auto-tagging or audio-recognition purposes. including download path.
18
- class FileMinimalWithUrlDTO
19
- attr_accessor :file_name
20
-
21
- attr_accessor :url
22
-
23
- attr_accessor :isrc
24
-
25
- # Attribute mapping from ruby-style variable name to JSON key.
26
- def self.attribute_map
27
- {
28
- :'file_name' => :'fileName',
29
- :'url' => :'url',
30
- :'isrc' => :'isrc'
31
- }
32
- end
33
-
34
- # Returns all the JSON keys this model knows about
35
- def self.acceptable_attributes
36
- attribute_map.values
37
- end
38
-
39
- # Attribute type mapping.
40
- def self.openapi_types
41
- {
42
- :'file_name' => :'String',
43
- :'url' => :'String',
44
- :'isrc' => :'String'
45
- }
46
- end
47
-
48
- # List of attributes with nullable: true
49
- def self.openapi_nullable
50
- Set.new([
51
- ])
52
- end
53
-
54
- # Initializes the object
55
- # @param [Hash] attributes Model attributes in the form of hash
56
- def initialize(attributes = {})
57
- if (!attributes.is_a?(Hash))
58
- fail ArgumentError, "The input argument (attributes) must be a hash in `SongtradrApiClientRuby::FileMinimalWithUrlDTO` initialize method"
59
- end
60
-
61
- # check to see if the attribute exists and convert string to symbol for hash key
62
- attributes = attributes.each_with_object({}) { |(k, v), h|
63
- if (!self.class.attribute_map.key?(k.to_sym))
64
- fail ArgumentError, "`#{k}` is not a valid attribute in `SongtradrApiClientRuby::FileMinimalWithUrlDTO`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
65
- end
66
- h[k.to_sym] = v
67
- }
68
-
69
- if attributes.key?(:'file_name')
70
- self.file_name = attributes[:'file_name']
71
- else
72
- self.file_name = nil
73
- end
74
-
75
- if attributes.key?(:'url')
76
- self.url = attributes[:'url']
77
- else
78
- self.url = nil
79
- end
80
-
81
- if attributes.key?(:'isrc')
82
- self.isrc = attributes[:'isrc']
83
- else
84
- self.isrc = nil
85
- end
86
- end
87
-
88
- # Show invalid properties with the reasons. Usually used together with valid?
89
- # @return Array for valid properties with the reasons
90
- def list_invalid_properties
91
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
92
- invalid_properties = Array.new
93
- if @file_name.nil?
94
- invalid_properties.push('invalid value for "file_name", file_name cannot be nil.')
95
- end
96
-
97
- if @url.nil?
98
- invalid_properties.push('invalid value for "url", url cannot be nil.')
99
- end
100
-
101
- if @isrc.nil?
102
- invalid_properties.push('invalid value for "isrc", isrc cannot be nil.')
103
- end
104
-
105
- invalid_properties
106
- end
107
-
108
- # Check to see if the all the properties in the model are valid
109
- # @return true if the model is valid
110
- def valid?
111
- warn '[DEPRECATED] the `valid?` method is obsolete'
112
- return false if @file_name.nil?
113
- return false if @url.nil?
114
- return false if @isrc.nil?
115
- true
116
- end
117
-
118
- # Checks equality by comparing each attribute.
119
- # @param [Object] Object to be compared
120
- def ==(o)
121
- return true if self.equal?(o)
122
- self.class == o.class &&
123
- file_name == o.file_name &&
124
- url == o.url &&
125
- isrc == o.isrc
126
- end
127
-
128
- # @see the `==` method
129
- # @param [Object] Object to be compared
130
- def eql?(o)
131
- self == o
132
- end
133
-
134
- # Calculates hash code according to all attributes.
135
- # @return [Integer] Hash code
136
- def hash
137
- [file_name, url, isrc].hash
138
- end
139
-
140
- # Builds the object from hash
141
- # @param [Hash] attributes Model attributes in the form of hash
142
- # @return [Object] Returns the model itself
143
- def self.build_from_hash(attributes)
144
- return nil unless attributes.is_a?(Hash)
145
- attributes = attributes.transform_keys(&:to_sym)
146
- transformed_hash = {}
147
- openapi_types.each_pair do |key, type|
148
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
149
- transformed_hash["#{key}"] = nil
150
- elsif type =~ /\AArray<(.*)>/i
151
- # check to ensure the input is an array given that the attribute
152
- # is documented as an array but the input is not
153
- if attributes[attribute_map[key]].is_a?(Array)
154
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
155
- end
156
- elsif !attributes[attribute_map[key]].nil?
157
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
158
- end
159
- end
160
- new(transformed_hash)
161
- end
162
-
163
- # Deserializes the data based on type
164
- # @param string type Data type
165
- # @param string value Value to be deserialized
166
- # @return [Object] Deserialized data
167
- def self._deserialize(type, value)
168
- case type.to_sym
169
- when :Time
170
- Time.parse(value)
171
- when :Date
172
- Date.parse(value)
173
- when :String
174
- value.to_s
175
- when :Integer
176
- value.to_i
177
- when :Float
178
- value.to_f
179
- when :Boolean
180
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
181
- true
182
- else
183
- false
184
- end
185
- when :Object
186
- # generic object (usually a Hash), return directly
187
- value
188
- when /\AArray<(?<inner_type>.+)>\z/
189
- inner_type = Regexp.last_match[:inner_type]
190
- value.map { |v| _deserialize(inner_type, v) }
191
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
192
- k_type = Regexp.last_match[:k_type]
193
- v_type = Regexp.last_match[:v_type]
194
- {}.tap do |hash|
195
- value.each do |k, v|
196
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
197
- end
198
- end
199
- else # model
200
- # models (e.g. Pet) or oneOf
201
- klass = SongtradrApiClientRuby.const_get(type)
202
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
203
- end
204
- end
205
-
206
- # Returns the string representation of the object
207
- # @return [String] String presentation of the object
208
- def to_s
209
- to_hash.to_s
210
- end
211
-
212
- # to_body is an alias to to_hash (backward compatibility)
213
- # @return [Hash] Returns the object in the form of hash
214
- def to_body
215
- to_hash
216
- end
217
-
218
- # Returns the object in the form of hash
219
- # @return [Hash] Returns the object in the form of hash
220
- def to_hash
221
- hash = {}
222
- self.class.attribute_map.each_pair do |attr, param|
223
- value = self.send(attr)
224
- if value.nil?
225
- is_nullable = self.class.openapi_nullable.include?(attr)
226
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
227
- end
228
-
229
- hash[param] = _to_hash(value)
230
- end
231
- hash
232
- end
233
-
234
- # Outputs non-array value in the form of hash
235
- # For object, use to_hash. Otherwise, just return the value
236
- # @param [Object] value Any valid value
237
- # @return [Hash] Returns the value in the form of hash
238
- def _to_hash(value)
239
- if value.is_a?(Array)
240
- value.compact.map { |v| _to_hash(v) }
241
- elsif value.is_a?(Hash)
242
- {}.tap do |hash|
243
- value.each { |k, v| hash[k] = _to_hash(v) }
244
- end
245
- elsif value.respond_to? :to_hash
246
- value.to_hash
247
- else
248
- value
249
- end
250
- end
251
-
252
- end
253
-
254
- end