songtradr_api_client_ruby 1.13.5 → 1.13.6

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 (250) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +12 -36
  4. data/docs/FileSmallDTO.md +5 -5
  5. data/docs/MusicalFeaturesDTO.md +27 -27
  6. data/docs/PlaylistLargeDTO.md +2 -2
  7. data/docs/RecordingGenrePredictionDTO.md +3 -3
  8. data/docs/RecordingLargeDTO.md +2 -2
  9. data/docs/RecordingMediumDTO.md +2 -2
  10. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
  11. data/docs/RecordingSmallDTO.md +3 -3
  12. data/docs/TagDTO.md +3 -3
  13. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
  14. data/lib/songtradr_api_client_ruby/api/party_api.rb +1 -1
  15. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -1
  16. data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -1
  17. data/lib/songtradr_api_client_ruby/api/user_api.rb +1 -1
  18. data/lib/songtradr_api_client_ruby/api_client.rb +1 -1
  19. data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
  20. data/lib/songtradr_api_client_ruby/configuration.rb +1 -1
  21. data/lib/songtradr_api_client_ruby/models/age_range.rb +1 -1
  22. data/lib/songtradr_api_client_ruby/models/beard.rb +1 -1
  23. data/lib/songtradr_api_client_ruby/models/bounding_box.rb +1 -1
  24. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +1 -1
  25. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +1 -1
  26. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +1 -1
  27. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +1 -1
  28. data/lib/songtradr_api_client_ruby/models/context_value.rb +1 -1
  29. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +1 -1
  30. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +1 -1
  31. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +1 -1
  32. data/lib/songtradr_api_client_ruby/models/dominant_color.rb +1 -1
  33. data/lib/songtradr_api_client_ruby/models/emotion.rb +1 -1
  34. data/lib/songtradr_api_client_ruby/models/error_response.rb +1 -1
  35. data/lib/songtradr_api_client_ruby/models/eye_direction.rb +1 -1
  36. data/lib/songtradr_api_client_ruby/models/eye_open.rb +1 -1
  37. data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +1 -1
  38. data/lib/songtradr_api_client_ruby/models/face_detail.rb +1 -1
  39. data/lib/songtradr_api_client_ruby/models/face_detection.rb +1 -1
  40. data/lib/songtradr_api_client_ruby/models/face_occluded.rb +1 -1
  41. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +1 -1
  42. data/lib/songtradr_api_client_ruby/models/file_dto.rb +1 -1
  43. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +1 -1
  44. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +1 -1
  45. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +36 -36
  46. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +1 -1
  47. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +1 -1
  48. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +1 -1
  49. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +1 -1
  50. data/lib/songtradr_api_client_ruby/models/gender.rb +1 -1
  51. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +1 -1
  52. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +1 -1
  53. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +1 -1
  54. data/lib/songtradr_api_client_ruby/models/image_quality.rb +1 -1
  55. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +1 -1
  56. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +1 -1
  57. data/lib/songtradr_api_client_ruby/models/instance.rb +1 -1
  58. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +1 -1
  59. data/lib/songtradr_api_client_ruby/models/label.rb +1 -1
  60. data/lib/songtradr_api_client_ruby/models/label_alias.rb +1 -1
  61. data/lib/songtradr_api_client_ruby/models/label_category.rb +1 -1
  62. data/lib/songtradr_api_client_ruby/models/label_detection.rb +1 -1
  63. data/lib/songtradr_api_client_ruby/models/landmark.rb +1 -1
  64. data/lib/songtradr_api_client_ruby/models/login_dto.rb +1 -1
  65. data/lib/songtradr_api_client_ruby/models/mouth_open.rb +1 -1
  66. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +172 -172
  67. data/lib/songtradr_api_client_ruby/models/mustache.rb +1 -1
  68. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +1 -1
  69. data/lib/songtradr_api_client_ruby/models/parent.rb +1 -1
  70. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +1 -1
  71. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +1 -1
  72. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +11 -11
  73. data/lib/songtradr_api_client_ruby/models/pose.rb +1 -1
  74. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +1 -1
  75. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +1 -1
  76. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +1 -1
  77. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +21 -21
  78. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +13 -13
  79. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +1 -1
  80. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +13 -13
  81. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +16 -16
  82. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +1 -1
  83. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +1 -1
  84. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +1 -1
  85. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +1 -1
  86. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +16 -16
  87. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +1 -1
  88. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +1 -1
  89. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +1 -1
  90. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +1 -1
  91. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +1 -1
  92. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +1 -1
  93. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +1 -1
  94. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +1 -1
  95. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +1 -1
  96. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +1 -1
  97. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +1 -1
  98. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +1 -1
  99. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +1 -1
  100. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +1 -1
  101. data/lib/songtradr_api_client_ruby/models/smile.rb +1 -1
  102. data/lib/songtradr_api_client_ruby/models/sunglasses.rb +1 -1
  103. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +16 -16
  104. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +1 -1
  105. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +1 -1
  106. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +1 -1
  107. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +1 -1
  108. data/lib/songtradr_api_client_ruby/models/title_dto.rb +1 -1
  109. data/lib/songtradr_api_client_ruby/models/token_request.rb +1 -1
  110. data/lib/songtradr_api_client_ruby/models/track_dto.rb +1 -1
  111. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +1 -1
  112. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +1 -1
  113. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +1 -1
  114. data/lib/songtradr_api_client_ruby/models/user_dto.rb +1 -1
  115. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +1 -1
  116. data/lib/songtradr_api_client_ruby/version.rb +2 -2
  117. data/lib/songtradr_api_client_ruby.rb +1 -10
  118. data/openapi-generator-config.yaml +1 -1
  119. data/songtradr_api_client_ruby.gemspec +1 -1
  120. data/spec/api/allowed_values_api_spec.rb +1 -1
  121. data/spec/api/party_api_spec.rb +1 -1
  122. data/spec/api/playlist_api_spec.rb +1 -1
  123. data/spec/api/recording_api_spec.rb +1 -1
  124. data/spec/api/user_api_spec.rb +1 -1
  125. data/spec/api_client_spec.rb +1 -1
  126. data/spec/configuration_spec.rb +1 -1
  127. data/spec/models/age_range_spec.rb +1 -1
  128. data/spec/models/beard_spec.rb +1 -1
  129. data/spec/models/bounding_box_spec.rb +1 -1
  130. data/spec/models/category_medium_dto_spec.rb +1 -1
  131. data/spec/models/category_minimal_dto_spec.rb +1 -1
  132. data/spec/models/config_access_dto_spec.rb +1 -1
  133. data/spec/models/config_identifier_dto_spec.rb +1 -1
  134. data/spec/models/context_value_spec.rb +1 -1
  135. data/spec/models/contributor_type_dto_spec.rb +1 -1
  136. data/spec/models/curate_playlist_dto_spec.rb +1 -1
  137. data/spec/models/curate_playlist_response_dto_spec.rb +1 -1
  138. data/spec/models/dominant_color_spec.rb +1 -1
  139. data/spec/models/emotion_spec.rb +1 -1
  140. data/spec/models/error_response_spec.rb +1 -1
  141. data/spec/models/eye_direction_spec.rb +1 -1
  142. data/spec/models/eye_open_spec.rb +1 -1
  143. data/spec/models/eyeglasses_spec.rb +1 -1
  144. data/spec/models/face_detail_spec.rb +1 -1
  145. data/spec/models/face_detection_spec.rb +1 -1
  146. data/spec/models/face_occluded_spec.rb +1 -1
  147. data/spec/models/field_summary_dto_spec.rb +1 -1
  148. data/spec/models/file_dto_spec.rb +1 -1
  149. data/spec/models/file_list_dto_spec.rb +1 -1
  150. data/spec/models/file_minimal_with_url_dto_spec.rb +1 -1
  151. data/spec/models/file_small_dto_spec.rb +17 -17
  152. data/spec/models/file_upload_dto_spec.rb +1 -1
  153. data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
  154. data/spec/models/files_summary_dto_spec.rb +1 -1
  155. data/spec/models/forgot_password_dto_spec.rb +1 -1
  156. data/spec/models/gender_spec.rb +1 -1
  157. data/spec/models/genre_dto_spec.rb +1 -1
  158. data/spec/models/genre_minimal_dto_spec.rb +1 -1
  159. data/spec/models/genres_summary_dto_spec.rb +1 -1
  160. data/spec/models/image_quality_spec.rb +1 -1
  161. data/spec/models/image_recognition_response_spec.rb +1 -1
  162. data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
  163. data/spec/models/instance_spec.rb +1 -1
  164. data/spec/models/jwt_token_dto_spec.rb +1 -1
  165. data/spec/models/label_alias_spec.rb +1 -1
  166. data/spec/models/label_category_spec.rb +1 -1
  167. data/spec/models/label_detection_spec.rb +1 -1
  168. data/spec/models/label_spec.rb +1 -1
  169. data/spec/models/landmark_spec.rb +1 -1
  170. data/spec/models/login_dto_spec.rb +1 -1
  171. data/spec/models/mouth_open_spec.rb +1 -1
  172. data/spec/models/musical_features_dto_spec.rb +57 -57
  173. data/spec/models/mustache_spec.rb +1 -1
  174. data/spec/models/p_line_dto_spec.rb +1 -1
  175. data/spec/models/parent_spec.rb +1 -1
  176. data/spec/models/party_large_dto_spec.rb +1 -1
  177. data/spec/models/party_small_dto_spec.rb +1 -1
  178. data/spec/models/playlist_large_dto_spec.rb +7 -7
  179. data/spec/models/pose_spec.rb +1 -1
  180. data/spec/models/product_medium_dto_spec.rb +1 -1
  181. data/spec/models/product_party_dto_spec.rb +1 -1
  182. data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
  183. data/spec/models/recording_genre_prediction_dto_spec.rb +4 -4
  184. data/spec/models/recording_large_dto_spec.rb +7 -7
  185. data/spec/models/recording_list_dto_spec.rb +1 -1
  186. data/spec/models/recording_medium_dto_spec.rb +7 -7
  187. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +3 -3
  188. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
  189. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
  190. data/spec/models/recording_party_dto_spec.rb +1 -1
  191. data/spec/models/recording_playlist_dto_spec.rb +1 -1
  192. data/spec/models/recording_small_dto_spec.rb +4 -4
  193. data/spec/models/recording_tag_small_dto_spec.rb +1 -1
  194. data/spec/models/save_file_recording_dto_spec.rb +1 -1
  195. data/spec/models/save_playlist_dto_spec.rb +1 -1
  196. data/spec/models/save_recording_genre_dto_spec.rb +1 -1
  197. data/spec/models/save_recording_party_dto_spec.rb +1 -1
  198. data/spec/models/save_recording_playlist_dto_spec.rb +1 -1
  199. data/spec/models/save_recording_tag_dto_spec.rb +1 -1
  200. data/spec/models/save_referrer_dto_spec.rb +1 -1
  201. data/spec/models/save_taggrams_dto_spec.rb +1 -1
  202. data/spec/models/save_user_dto_spec.rb +1 -1
  203. data/spec/models/search_filter_values_dto_spec.rb +1 -1
  204. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +1 -1
  205. data/spec/models/search_recording_granular_dto_spec.rb +1 -1
  206. data/spec/models/sign_up_dto_spec.rb +1 -1
  207. data/spec/models/smile_spec.rb +1 -1
  208. data/spec/models/sunglasses_spec.rb +1 -1
  209. data/spec/models/tag_dto_spec.rb +3 -3
  210. data/spec/models/tag_small_dto_spec.rb +1 -1
  211. data/spec/models/taggram_dto_spec.rb +1 -1
  212. data/spec/models/tags_summary_dto_spec.rb +1 -1
  213. data/spec/models/tagstrength_dto_spec.rb +1 -1
  214. data/spec/models/title_dto_spec.rb +1 -1
  215. data/spec/models/token_request_spec.rb +1 -1
  216. data/spec/models/track_dto_spec.rb +1 -1
  217. data/spec/models/track_to_medium_product_dto_spec.rb +1 -1
  218. data/spec/models/update_password_dto_spec.rb +1 -1
  219. data/spec/models/usage_dto_spec.rb +1 -1
  220. data/spec/models/user_dto_spec.rb +1 -1
  221. data/spec/models/video_recognition_response_spec.rb +1 -1
  222. data/spec/spec_helper.rb +1 -1
  223. metadata +1 -37
  224. data/docs/APIKeysApi.md +0 -217
  225. data/docs/AdminApiCreateUserDTO.md +0 -76
  226. data/docs/AdminApiUpdateUserDTO.md +0 -76
  227. data/docs/AdminApiUserDTO.md +0 -70
  228. data/docs/AdminUsersControllerApi.md +0 -355
  229. data/docs/ApiKeyDTO.md +0 -24
  230. data/docs/CreateApiKeyDTO.md +0 -18
  231. data/docs/InternalApiApi.md +0 -149
  232. data/docs/SaveFileDTO.md +0 -42
  233. data/lib/songtradr_api_client_ruby/api/admin_users_controller_api.rb +0 -346
  234. data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +0 -213
  235. data/lib/songtradr_api_client_ruby/api/internal_api_api.rb +0 -169
  236. data/lib/songtradr_api_client_ruby/models/admin_api_create_user_dto.rb +0 -489
  237. data/lib/songtradr_api_client_ruby/models/admin_api_update_user_dto.rb +0 -475
  238. data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +0 -448
  239. data/lib/songtradr_api_client_ruby/models/api_key_dto.rb +0 -262
  240. data/lib/songtradr_api_client_ruby/models/create_api_key_dto.rb +0 -214
  241. data/lib/songtradr_api_client_ruby/models/save_file_dto.rb +0 -323
  242. data/spec/api/admin_users_controller_api_spec.rb +0 -93
  243. data/spec/api/api_keys_api_spec.rb +0 -70
  244. data/spec/api/internal_api_api_spec.rb +0 -58
  245. data/spec/models/admin_api_create_user_dto_spec.rb +0 -210
  246. data/spec/models/admin_api_update_user_dto_spec.rb +0 -210
  247. data/spec/models/admin_api_user_dto_spec.rb +0 -192
  248. data/spec/models/api_key_dto_spec.rb +0 -54
  249. data/spec/models/create_api_key_dto_spec.rb +0 -36
  250. data/spec/models/save_file_dto_spec.rb +0 -108
@@ -1,346 +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.5
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 AdminUsersControllerApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # create a user
23
- # @param admin_api_create_user_dto [AdminApiCreateUserDTO]
24
- # @param [Hash] opts the optional parameters
25
- # @return [AdminApiUserDTO]
26
- def create_user(admin_api_create_user_dto, opts = {})
27
- data, _status_code, _headers = create_user_with_http_info(admin_api_create_user_dto, opts)
28
- data
29
- end
30
-
31
- # create a user
32
- # @param admin_api_create_user_dto [AdminApiCreateUserDTO]
33
- # @param [Hash] opts the optional parameters
34
- # @return [Array<(AdminApiUserDTO, Integer, Hash)>] AdminApiUserDTO data, response status code and response headers
35
- def create_user_with_http_info(admin_api_create_user_dto, opts = {})
36
- if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: AdminUsersControllerApi.create_user ...'
38
- end
39
- # verify the required parameter 'admin_api_create_user_dto' is set
40
- if @api_client.config.client_side_validation && admin_api_create_user_dto.nil?
41
- fail ArgumentError, "Missing the required parameter 'admin_api_create_user_dto' when calling AdminUsersControllerApi.create_user"
42
- end
43
- # resource path
44
- local_var_path = '/api/v1/admin/users'
45
-
46
- # query parameters
47
- query_params = opts[:query_params] || {}
48
-
49
- # header parameters
50
- header_params = opts[:header_params] || {}
51
- # HTTP header 'Accept' (if needed)
52
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
- # HTTP header 'Content-Type'
54
- content_type = @api_client.select_header_content_type(['application/json'])
55
- if !content_type.nil?
56
- header_params['Content-Type'] = content_type
57
- end
58
-
59
- # form parameters
60
- form_params = opts[:form_params] || {}
61
-
62
- # http body (model)
63
- post_body = opts[:debug_body] || @api_client.object_to_http_body(admin_api_create_user_dto)
64
-
65
- # return_type
66
- return_type = opts[:debug_return_type] || 'AdminApiUserDTO'
67
-
68
- # auth_names
69
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
70
-
71
- new_options = opts.merge(
72
- :operation => :"AdminUsersControllerApi.create_user",
73
- :header_params => header_params,
74
- :query_params => query_params,
75
- :form_params => form_params,
76
- :body => post_body,
77
- :auth_names => auth_names,
78
- :return_type => return_type
79
- )
80
-
81
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
82
- if @api_client.config.debugging
83
- @api_client.config.logger.debug "API called: AdminUsersControllerApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
- end
85
- return data, status_code, headers
86
- end
87
-
88
- # delete a user
89
- # @param id [Integer]
90
- # @param [Hash] opts the optional parameters
91
- # @return [Object]
92
- def delete_user(id, opts = {})
93
- data, _status_code, _headers = delete_user_with_http_info(id, opts)
94
- data
95
- end
96
-
97
- # delete a user
98
- # @param id [Integer]
99
- # @param [Hash] opts the optional parameters
100
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
101
- def delete_user_with_http_info(id, opts = {})
102
- if @api_client.config.debugging
103
- @api_client.config.logger.debug 'Calling API: AdminUsersControllerApi.delete_user ...'
104
- end
105
- # verify the required parameter 'id' is set
106
- if @api_client.config.client_side_validation && id.nil?
107
- fail ArgumentError, "Missing the required parameter 'id' when calling AdminUsersControllerApi.delete_user"
108
- end
109
- # resource path
110
- local_var_path = '/api/v1/admin/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
111
-
112
- # query parameters
113
- query_params = opts[:query_params] || {}
114
-
115
- # header parameters
116
- header_params = opts[:header_params] || {}
117
- # HTTP header 'Accept' (if needed)
118
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
119
-
120
- # form parameters
121
- form_params = opts[:form_params] || {}
122
-
123
- # http body (model)
124
- post_body = opts[:debug_body]
125
-
126
- # return_type
127
- return_type = opts[:debug_return_type] || 'Object'
128
-
129
- # auth_names
130
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
131
-
132
- new_options = opts.merge(
133
- :operation => :"AdminUsersControllerApi.delete_user",
134
- :header_params => header_params,
135
- :query_params => query_params,
136
- :form_params => form_params,
137
- :body => post_body,
138
- :auth_names => auth_names,
139
- :return_type => return_type
140
- )
141
-
142
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
143
- if @api_client.config.debugging
144
- @api_client.config.logger.debug "API called: AdminUsersControllerApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
145
- end
146
- return data, status_code, headers
147
- end
148
-
149
- # show details of a user
150
- # @param id [Integer]
151
- # @param [Hash] opts the optional parameters
152
- # @return [AdminApiUserDTO]
153
- def get_user(id, opts = {})
154
- data, _status_code, _headers = get_user_with_http_info(id, opts)
155
- data
156
- end
157
-
158
- # show details of a user
159
- # @param id [Integer]
160
- # @param [Hash] opts the optional parameters
161
- # @return [Array<(AdminApiUserDTO, Integer, Hash)>] AdminApiUserDTO data, response status code and response headers
162
- def get_user_with_http_info(id, opts = {})
163
- if @api_client.config.debugging
164
- @api_client.config.logger.debug 'Calling API: AdminUsersControllerApi.get_user ...'
165
- end
166
- # verify the required parameter 'id' is set
167
- if @api_client.config.client_side_validation && id.nil?
168
- fail ArgumentError, "Missing the required parameter 'id' when calling AdminUsersControllerApi.get_user"
169
- end
170
- # resource path
171
- local_var_path = '/api/v1/admin/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
172
-
173
- # query parameters
174
- query_params = opts[:query_params] || {}
175
-
176
- # header parameters
177
- header_params = opts[:header_params] || {}
178
- # HTTP header 'Accept' (if needed)
179
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
180
-
181
- # form parameters
182
- form_params = opts[:form_params] || {}
183
-
184
- # http body (model)
185
- post_body = opts[:debug_body]
186
-
187
- # return_type
188
- return_type = opts[:debug_return_type] || 'AdminApiUserDTO'
189
-
190
- # auth_names
191
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
192
-
193
- new_options = opts.merge(
194
- :operation => :"AdminUsersControllerApi.get_user",
195
- :header_params => header_params,
196
- :query_params => query_params,
197
- :form_params => form_params,
198
- :body => post_body,
199
- :auth_names => auth_names,
200
- :return_type => return_type
201
- )
202
-
203
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
204
- if @api_client.config.debugging
205
- @api_client.config.logger.debug "API called: AdminUsersControllerApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
206
- end
207
- return data, status_code, headers
208
- end
209
-
210
- # List users
211
- # @param [Hash] opts the optional parameters
212
- # @option opts [Integer] :page Zero-based page index (0..N) (default to 0)
213
- # @option opts [Integer] :size The size of the page to be returned (default to 20)
214
- # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
215
- # @return [AdminApiUserDTO]
216
- def get_users(opts = {})
217
- data, _status_code, _headers = get_users_with_http_info(opts)
218
- data
219
- end
220
-
221
- # List users
222
- # @param [Hash] opts the optional parameters
223
- # @option opts [Integer] :page Zero-based page index (0..N) (default to 0)
224
- # @option opts [Integer] :size The size of the page to be returned (default to 20)
225
- # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
226
- # @return [Array<(AdminApiUserDTO, Integer, Hash)>] AdminApiUserDTO data, response status code and response headers
227
- def get_users_with_http_info(opts = {})
228
- if @api_client.config.debugging
229
- @api_client.config.logger.debug 'Calling API: AdminUsersControllerApi.get_users ...'
230
- end
231
- # resource path
232
- local_var_path = '/api/v1/admin/users'
233
-
234
- # query parameters
235
- query_params = opts[:query_params] || {}
236
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
237
- query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
238
- query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
239
-
240
- # header parameters
241
- header_params = opts[:header_params] || {}
242
- # HTTP header 'Accept' (if needed)
243
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
244
-
245
- # form parameters
246
- form_params = opts[:form_params] || {}
247
-
248
- # http body (model)
249
- post_body = opts[:debug_body]
250
-
251
- # return_type
252
- return_type = opts[:debug_return_type] || 'AdminApiUserDTO'
253
-
254
- # auth_names
255
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
256
-
257
- new_options = opts.merge(
258
- :operation => :"AdminUsersControllerApi.get_users",
259
- :header_params => header_params,
260
- :query_params => query_params,
261
- :form_params => form_params,
262
- :body => post_body,
263
- :auth_names => auth_names,
264
- :return_type => return_type
265
- )
266
-
267
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
268
- if @api_client.config.debugging
269
- @api_client.config.logger.debug "API called: AdminUsersControllerApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
270
- end
271
- return data, status_code, headers
272
- end
273
-
274
- # update a user
275
- # @param id [Integer]
276
- # @param admin_api_update_user_dto [AdminApiUpdateUserDTO]
277
- # @param [Hash] opts the optional parameters
278
- # @return [AdminApiUserDTO]
279
- def update_user(id, admin_api_update_user_dto, opts = {})
280
- data, _status_code, _headers = update_user_with_http_info(id, admin_api_update_user_dto, opts)
281
- data
282
- end
283
-
284
- # update a user
285
- # @param id [Integer]
286
- # @param admin_api_update_user_dto [AdminApiUpdateUserDTO]
287
- # @param [Hash] opts the optional parameters
288
- # @return [Array<(AdminApiUserDTO, Integer, Hash)>] AdminApiUserDTO data, response status code and response headers
289
- def update_user_with_http_info(id, admin_api_update_user_dto, opts = {})
290
- if @api_client.config.debugging
291
- @api_client.config.logger.debug 'Calling API: AdminUsersControllerApi.update_user ...'
292
- end
293
- # verify the required parameter 'id' is set
294
- if @api_client.config.client_side_validation && id.nil?
295
- fail ArgumentError, "Missing the required parameter 'id' when calling AdminUsersControllerApi.update_user"
296
- end
297
- # verify the required parameter 'admin_api_update_user_dto' is set
298
- if @api_client.config.client_side_validation && admin_api_update_user_dto.nil?
299
- fail ArgumentError, "Missing the required parameter 'admin_api_update_user_dto' when calling AdminUsersControllerApi.update_user"
300
- end
301
- # resource path
302
- local_var_path = '/api/v1/admin/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
303
-
304
- # query parameters
305
- query_params = opts[:query_params] || {}
306
-
307
- # header parameters
308
- header_params = opts[:header_params] || {}
309
- # HTTP header 'Accept' (if needed)
310
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
311
- # HTTP header 'Content-Type'
312
- content_type = @api_client.select_header_content_type(['application/json'])
313
- if !content_type.nil?
314
- header_params['Content-Type'] = content_type
315
- end
316
-
317
- # form parameters
318
- form_params = opts[:form_params] || {}
319
-
320
- # http body (model)
321
- post_body = opts[:debug_body] || @api_client.object_to_http_body(admin_api_update_user_dto)
322
-
323
- # return_type
324
- return_type = opts[:debug_return_type] || 'AdminApiUserDTO'
325
-
326
- # auth_names
327
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
328
-
329
- new_options = opts.merge(
330
- :operation => :"AdminUsersControllerApi.update_user",
331
- :header_params => header_params,
332
- :query_params => query_params,
333
- :form_params => form_params,
334
- :body => post_body,
335
- :auth_names => auth_names,
336
- :return_type => return_type
337
- )
338
-
339
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
340
- if @api_client.config.debugging
341
- @api_client.config.logger.debug "API called: AdminUsersControllerApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
342
- end
343
- return data, status_code, headers
344
- end
345
- end
346
- end
@@ -1,213 +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.5
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 APIKeysApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # create an API key
23
- # @param create_api_key_dto [CreateApiKeyDTO]
24
- # @param [Hash] opts the optional parameters
25
- # @return [AdminApiUserDTO]
26
- def create_api_key(create_api_key_dto, opts = {})
27
- data, _status_code, _headers = create_api_key_with_http_info(create_api_key_dto, opts)
28
- data
29
- end
30
-
31
- # create an API key
32
- # @param create_api_key_dto [CreateApiKeyDTO]
33
- # @param [Hash] opts the optional parameters
34
- # @return [Array<(AdminApiUserDTO, Integer, Hash)>] AdminApiUserDTO data, response status code and response headers
35
- def create_api_key_with_http_info(create_api_key_dto, opts = {})
36
- if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: APIKeysApi.create_api_key ...'
38
- end
39
- # verify the required parameter 'create_api_key_dto' is set
40
- if @api_client.config.client_side_validation && create_api_key_dto.nil?
41
- fail ArgumentError, "Missing the required parameter 'create_api_key_dto' when calling APIKeysApi.create_api_key"
42
- end
43
- # resource path
44
- local_var_path = '/api/v1/user/apiKeys'
45
-
46
- # query parameters
47
- query_params = opts[:query_params] || {}
48
-
49
- # header parameters
50
- header_params = opts[:header_params] || {}
51
- # HTTP header 'Accept' (if needed)
52
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
- # HTTP header 'Content-Type'
54
- content_type = @api_client.select_header_content_type(['application/json'])
55
- if !content_type.nil?
56
- header_params['Content-Type'] = content_type
57
- end
58
-
59
- # form parameters
60
- form_params = opts[:form_params] || {}
61
-
62
- # http body (model)
63
- post_body = opts[:debug_body] || @api_client.object_to_http_body(create_api_key_dto)
64
-
65
- # return_type
66
- return_type = opts[:debug_return_type] || 'AdminApiUserDTO'
67
-
68
- # auth_names
69
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
70
-
71
- new_options = opts.merge(
72
- :operation => :"APIKeysApi.create_api_key",
73
- :header_params => header_params,
74
- :query_params => query_params,
75
- :form_params => form_params,
76
- :body => post_body,
77
- :auth_names => auth_names,
78
- :return_type => return_type
79
- )
80
-
81
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
82
- if @api_client.config.debugging
83
- @api_client.config.logger.debug "API called: APIKeysApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
- end
85
- return data, status_code, headers
86
- end
87
-
88
- # delete an API key
89
- # @param id [String]
90
- # @param [Hash] opts the optional parameters
91
- # @return [Object]
92
- def delete_api_key(id, opts = {})
93
- data, _status_code, _headers = delete_api_key_with_http_info(id, opts)
94
- data
95
- end
96
-
97
- # delete an API key
98
- # @param id [String]
99
- # @param [Hash] opts the optional parameters
100
- # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
101
- def delete_api_key_with_http_info(id, opts = {})
102
- if @api_client.config.debugging
103
- @api_client.config.logger.debug 'Calling API: APIKeysApi.delete_api_key ...'
104
- end
105
- # verify the required parameter 'id' is set
106
- if @api_client.config.client_side_validation && id.nil?
107
- fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysApi.delete_api_key"
108
- end
109
- # resource path
110
- local_var_path = '/api/v1/user/apiKeys/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
111
-
112
- # query parameters
113
- query_params = opts[:query_params] || {}
114
-
115
- # header parameters
116
- header_params = opts[:header_params] || {}
117
- # HTTP header 'Accept' (if needed)
118
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
119
-
120
- # form parameters
121
- form_params = opts[:form_params] || {}
122
-
123
- # http body (model)
124
- post_body = opts[:debug_body]
125
-
126
- # return_type
127
- return_type = opts[:debug_return_type] || 'Object'
128
-
129
- # auth_names
130
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
131
-
132
- new_options = opts.merge(
133
- :operation => :"APIKeysApi.delete_api_key",
134
- :header_params => header_params,
135
- :query_params => query_params,
136
- :form_params => form_params,
137
- :body => post_body,
138
- :auth_names => auth_names,
139
- :return_type => return_type
140
- )
141
-
142
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
143
- if @api_client.config.debugging
144
- @api_client.config.logger.debug "API called: APIKeysApi#delete_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
145
- end
146
- return data, status_code, headers
147
- end
148
-
149
- # list API keys
150
- # @param [Hash] opts the optional parameters
151
- # @option opts [Integer] :page Zero-based page index (0..N) (default to 0)
152
- # @option opts [Integer] :size The size of the page to be returned (default to 20)
153
- # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
154
- # @return [Array<ApiKeyDTO>]
155
- def get_api_keys(opts = {})
156
- data, _status_code, _headers = get_api_keys_with_http_info(opts)
157
- data
158
- end
159
-
160
- # list API keys
161
- # @param [Hash] opts the optional parameters
162
- # @option opts [Integer] :page Zero-based page index (0..N) (default to 0)
163
- # @option opts [Integer] :size The size of the page to be returned (default to 20)
164
- # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
165
- # @return [Array<(Array<ApiKeyDTO>, Integer, Hash)>] Array<ApiKeyDTO> data, response status code and response headers
166
- def get_api_keys_with_http_info(opts = {})
167
- if @api_client.config.debugging
168
- @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_keys ...'
169
- end
170
- # resource path
171
- local_var_path = '/api/v1/user/apiKeys'
172
-
173
- # query parameters
174
- query_params = opts[:query_params] || {}
175
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
176
- query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
177
- query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
178
-
179
- # header parameters
180
- header_params = opts[:header_params] || {}
181
- # HTTP header 'Accept' (if needed)
182
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
183
-
184
- # form parameters
185
- form_params = opts[:form_params] || {}
186
-
187
- # http body (model)
188
- post_body = opts[:debug_body]
189
-
190
- # return_type
191
- return_type = opts[:debug_return_type] || 'Array<ApiKeyDTO>'
192
-
193
- # auth_names
194
- auth_names = opts[:debug_auth_names] || ['bearer-jwt']
195
-
196
- new_options = opts.merge(
197
- :operation => :"APIKeysApi.get_api_keys",
198
- :header_params => header_params,
199
- :query_params => query_params,
200
- :form_params => form_params,
201
- :body => post_body,
202
- :auth_names => auth_names,
203
- :return_type => return_type
204
- )
205
-
206
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
207
- if @api_client.config.debugging
208
- @api_client.config.logger.debug "API called: APIKeysApi#get_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
209
- end
210
- return data, status_code, headers
211
- end
212
- end
213
- end