musicube_api_client_ruby 1.1.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (227) hide show
  1. checksums.yaml +7 -0
  2. data/CODE_OF_CONDUCT.md +84 -0
  3. data/Gemfile +9 -0
  4. data/README.md +223 -0
  5. data/Rakefile +10 -0
  6. data/bin/console +15 -0
  7. data/bin/setup +8 -0
  8. data/docs/AllowedValuesApi.md +200 -0
  9. data/docs/CategoryMediumDTO.md +22 -0
  10. data/docs/CategoryMinimalDTO.md +18 -0
  11. data/docs/ConfigAccessDTO.md +20 -0
  12. data/docs/ConfigIdentifierDTO.md +20 -0
  13. data/docs/ContributorTypeDTO.md +18 -0
  14. data/docs/ErrorResponse.md +26 -0
  15. data/docs/FieldSummaryDTO.md +22 -0
  16. data/docs/FileDTO.md +50 -0
  17. data/docs/FileListDTO.md +24 -0
  18. data/docs/FileMinimalWithUrlDTO.md +22 -0
  19. data/docs/FileSmallDTO.md +46 -0
  20. data/docs/FileUploadDTO.md +22 -0
  21. data/docs/FileWIthUrlDTO.md +20 -0
  22. data/docs/FilesSummaryDTO.md +30 -0
  23. data/docs/ForgotPasswordDTO.md +20 -0
  24. data/docs/GenreDTO.md +20 -0
  25. data/docs/GenreMinimalDTO.md +18 -0
  26. data/docs/GenresSummaryDTO.md +22 -0
  27. data/docs/InitPutRecordingAudioDTO.md +22 -0
  28. data/docs/JwtTokenDTO.md +22 -0
  29. data/docs/LoginDTO.md +24 -0
  30. data/docs/MusicalFeaturesDTO.md +186 -0
  31. data/docs/PLineDTO.md +20 -0
  32. data/docs/PartyApi.md +75 -0
  33. data/docs/PartyLargeDTO.md +32 -0
  34. data/docs/PartySmallDTO.md +20 -0
  35. data/docs/PlaylistApi.md +221 -0
  36. data/docs/PlaylistLargeDTO.md +38 -0
  37. data/docs/ProductMediumDTO.md +34 -0
  38. data/docs/ProductPartyDTO.md +20 -0
  39. data/docs/RecordingApi.md +789 -0
  40. data/docs/RecordingForSimilaritySearchDTO.md +20 -0
  41. data/docs/RecordingGenrePredictionDTO.md +22 -0
  42. data/docs/RecordingLargeDTO.md +40 -0
  43. data/docs/RecordingListDTO.md +24 -0
  44. data/docs/RecordingMediumDTO.md +36 -0
  45. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +20 -0
  46. data/docs/RecordingMinimalWithTaggramsDTO.md +22 -0
  47. data/docs/RecordingMinimalWithTagstrengthsDTO.md +20 -0
  48. data/docs/RecordingPartyDTO.md +20 -0
  49. data/docs/RecordingPlaylistDTO.md +24 -0
  50. data/docs/RecordingSmallDTO.md +24 -0
  51. data/docs/RecordingTagSmallDTO.md +18 -0
  52. data/docs/SaveFileRecordingDTO.md +236 -0
  53. data/docs/SavePlaylistDTO.md +34 -0
  54. data/docs/SaveRecordingGenreDTO.md +22 -0
  55. data/docs/SaveRecordingPartyDTO.md +20 -0
  56. data/docs/SaveRecordingPlaylistDTO.md +22 -0
  57. data/docs/SaveRecordingTagDTO.md +20 -0
  58. data/docs/SaveReferrerDTO.md +20 -0
  59. data/docs/SaveTaggramsDTO.md +82 -0
  60. data/docs/SaveUserDTO.md +28 -0
  61. data/docs/SearchFilterValuesDTO.md +98 -0
  62. data/docs/SearchRecordingGranularAbstractionDTO.md +20 -0
  63. data/docs/SearchRecordingGranularDTO.md +22 -0
  64. data/docs/SignUpDTO.md +24 -0
  65. data/docs/TagDTO.md +22 -0
  66. data/docs/TagSmallDTO.md +20 -0
  67. data/docs/TaggramDTO.md +26 -0
  68. data/docs/TagsSummaryDTO.md +22 -0
  69. data/docs/TagstrengthDTO.md +26 -0
  70. data/docs/TitleDTO.md +18 -0
  71. data/docs/TokenRequest.md +18 -0
  72. data/docs/TrackToMediumProductDTO.md +22 -0
  73. data/docs/UpdatePasswordDTO.md +20 -0
  74. data/docs/UsageDTO.md +18 -0
  75. data/docs/UserApi.md +1936 -0
  76. data/docs/UserDTO.md +56 -0
  77. data/git_push.sh +57 -0
  78. data/lib/musicube_api_client_ruby/api/allowed_values_api.rb +213 -0
  79. data/lib/musicube_api_client_ruby/api/party_api.rb +84 -0
  80. data/lib/musicube_api_client_ruby/api/playlist_api.rb +222 -0
  81. data/lib/musicube_api_client_ruby/api/recording_api.rb +900 -0
  82. data/lib/musicube_api_client_ruby/api/user_api.rb +2642 -0
  83. data/lib/musicube_api_client_ruby/api_client.rb +428 -0
  84. data/lib/musicube_api_client_ruby/api_error.rb +58 -0
  85. data/lib/musicube_api_client_ruby/configuration.rb +380 -0
  86. data/lib/musicube_api_client_ruby/models/category_medium_dto.rb +250 -0
  87. data/lib/musicube_api_client_ruby/models/category_minimal_dto.rb +225 -0
  88. data/lib/musicube_api_client_ruby/models/config_access_dto.rb +287 -0
  89. data/lib/musicube_api_client_ruby/models/config_identifier_dto.rb +239 -0
  90. data/lib/musicube_api_client_ruby/models/contributor_type_dto.rb +225 -0
  91. data/lib/musicube_api_client_ruby/models/error_response.rb +276 -0
  92. data/lib/musicube_api_client_ruby/models/field_summary_dto.rb +253 -0
  93. data/lib/musicube_api_client_ruby/models/file_dto.rb +450 -0
  94. data/lib/musicube_api_client_ruby/models/file_list_dto.rb +269 -0
  95. data/lib/musicube_api_client_ruby/models/file_minimal_with_url_dto.rb +253 -0
  96. data/lib/musicube_api_client_ruby/models/file_small_dto.rb +432 -0
  97. data/lib/musicube_api_client_ruby/models/file_upload_dto.rb +244 -0
  98. data/lib/musicube_api_client_ruby/models/file_w_ith_url_dto.rb +239 -0
  99. data/lib/musicube_api_client_ruby/models/files_summary_dto.rb +287 -0
  100. data/lib/musicube_api_client_ruby/models/forgot_password_dto.rb +267 -0
  101. data/lib/musicube_api_client_ruby/models/genre_dto.rb +239 -0
  102. data/lib/musicube_api_client_ruby/models/genre_minimal_dto.rb +225 -0
  103. data/lib/musicube_api_client_ruby/models/genres_summary_dto.rb +248 -0
  104. data/lib/musicube_api_client_ruby/models/init_put_recording_audio_dto.rb +238 -0
  105. data/lib/musicube_api_client_ruby/models/jwt_token_dto.rb +248 -0
  106. data/lib/musicube_api_client_ruby/models/login_dto.rb +257 -0
  107. data/lib/musicube_api_client_ruby/models/musical_features_dto.rb +1532 -0
  108. data/lib/musicube_api_client_ruby/models/p_line_dto.rb +234 -0
  109. data/lib/musicube_api_client_ruby/models/party_large_dto.rb +288 -0
  110. data/lib/musicube_api_client_ruby/models/party_small_dto.rb +239 -0
  111. data/lib/musicube_api_client_ruby/models/playlist_large_dto.rb +353 -0
  112. data/lib/musicube_api_client_ruby/models/product_medium_dto.rb +316 -0
  113. data/lib/musicube_api_client_ruby/models/product_party_dto.rb +236 -0
  114. data/lib/musicube_api_client_ruby/models/recording_for_similarity_search_dto.rb +239 -0
  115. data/lib/musicube_api_client_ruby/models/recording_genre_prediction_dto.rb +253 -0
  116. data/lib/musicube_api_client_ruby/models/recording_large_dto.rb +366 -0
  117. data/lib/musicube_api_client_ruby/models/recording_list_dto.rb +269 -0
  118. data/lib/musicube_api_client_ruby/models/recording_medium_dto.rb +340 -0
  119. data/lib/musicube_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +236 -0
  120. data/lib/musicube_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +248 -0
  121. data/lib/musicube_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +236 -0
  122. data/lib/musicube_api_client_ruby/models/recording_party_dto.rb +236 -0
  123. data/lib/musicube_api_client_ruby/models/recording_playlist_dto.rb +247 -0
  124. data/lib/musicube_api_client_ruby/models/recording_small_dto.rb +268 -0
  125. data/lib/musicube_api_client_ruby/models/recording_tag_small_dto.rb +225 -0
  126. data/lib/musicube_api_client_ruby/models/save_file_recording_dto.rb +1847 -0
  127. data/lib/musicube_api_client_ruby/models/save_playlist_dto.rb +350 -0
  128. data/lib/musicube_api_client_ruby/models/save_recording_genre_dto.rb +243 -0
  129. data/lib/musicube_api_client_ruby/models/save_recording_party_dto.rb +273 -0
  130. data/lib/musicube_api_client_ruby/models/save_recording_playlist_dto.rb +248 -0
  131. data/lib/musicube_api_client_ruby/models/save_recording_tag_dto.rb +234 -0
  132. data/lib/musicube_api_client_ruby/models/save_referrer_dto.rb +229 -0
  133. data/lib/musicube_api_client_ruby/models/save_taggrams_dto.rb +574 -0
  134. data/lib/musicube_api_client_ruby/models/save_user_dto.rb +317 -0
  135. data/lib/musicube_api_client_ruby/models/search_filter_values_dto.rb +867 -0
  136. data/lib/musicube_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +270 -0
  137. data/lib/musicube_api_client_ruby/models/search_recording_granular_dto.rb +245 -0
  138. data/lib/musicube_api_client_ruby/models/sign_up_dto.rb +262 -0
  139. data/lib/musicube_api_client_ruby/models/tag_dto.rb +250 -0
  140. data/lib/musicube_api_client_ruby/models/tag_small_dto.rb +239 -0
  141. data/lib/musicube_api_client_ruby/models/taggram_dto.rb +271 -0
  142. data/lib/musicube_api_client_ruby/models/tags_summary_dto.rb +250 -0
  143. data/lib/musicube_api_client_ruby/models/tagstrength_dto.rb +269 -0
  144. data/lib/musicube_api_client_ruby/models/title_dto.rb +225 -0
  145. data/lib/musicube_api_client_ruby/models/token_request.rb +224 -0
  146. data/lib/musicube_api_client_ruby/models/track_to_medium_product_dto.rb +248 -0
  147. data/lib/musicube_api_client_ruby/models/update_password_dto.rb +238 -0
  148. data/lib/musicube_api_client_ruby/models/usage_dto.rb +220 -0
  149. data/lib/musicube_api_client_ruby/models/user_dto.rb +481 -0
  150. data/lib/musicube_api_client_ruby/version.rb +15 -0
  151. data/lib/musicube_api_client_ruby.rb +108 -0
  152. data/musicube_api_client_ruby.gemspec +39 -0
  153. data/openapi-generator-config.yaml +9 -0
  154. data/spec/api/allowed_values_api_spec.rb +68 -0
  155. data/spec/api/party_api_spec.rb +46 -0
  156. data/spec/api/playlist_api_spec.rb +72 -0
  157. data/spec/api/recording_api_spec.rb +192 -0
  158. data/spec/api/user_api_spec.rb +507 -0
  159. data/spec/api_client_spec.rb +223 -0
  160. data/spec/configuration_spec.rb +82 -0
  161. data/spec/models/category_medium_dto_spec.rb +46 -0
  162. data/spec/models/category_minimal_dto_spec.rb +34 -0
  163. data/spec/models/config_access_dto_spec.rb +48 -0
  164. data/spec/models/config_identifier_dto_spec.rb +40 -0
  165. data/spec/models/contributor_type_dto_spec.rb +34 -0
  166. data/spec/models/error_response_spec.rb +58 -0
  167. data/spec/models/field_summary_dto_spec.rb +46 -0
  168. data/spec/models/file_dto_spec.rb +142 -0
  169. data/spec/models/file_list_dto_spec.rb +52 -0
  170. data/spec/models/file_minimal_with_url_dto_spec.rb +46 -0
  171. data/spec/models/file_small_dto_spec.rb +130 -0
  172. data/spec/models/file_upload_dto_spec.rb +46 -0
  173. data/spec/models/file_w_ith_url_dto_spec.rb +40 -0
  174. data/spec/models/files_summary_dto_spec.rb +70 -0
  175. data/spec/models/forgot_password_dto_spec.rb +44 -0
  176. data/spec/models/genre_dto_spec.rb +40 -0
  177. data/spec/models/genre_minimal_dto_spec.rb +34 -0
  178. data/spec/models/genres_summary_dto_spec.rb +46 -0
  179. data/spec/models/init_put_recording_audio_dto_spec.rb +46 -0
  180. data/spec/models/jwt_token_dto_spec.rb +46 -0
  181. data/spec/models/login_dto_spec.rb +52 -0
  182. data/spec/models/musical_features_dto_spec.rb +706 -0
  183. data/spec/models/p_line_dto_spec.rb +40 -0
  184. data/spec/models/party_large_dto_spec.rb +76 -0
  185. data/spec/models/party_small_dto_spec.rb +40 -0
  186. data/spec/models/playlist_large_dto_spec.rb +98 -0
  187. data/spec/models/product_medium_dto_spec.rb +82 -0
  188. data/spec/models/product_party_dto_spec.rb +40 -0
  189. data/spec/models/recording_for_similarity_search_dto_spec.rb +40 -0
  190. data/spec/models/recording_genre_prediction_dto_spec.rb +46 -0
  191. data/spec/models/recording_large_dto_spec.rb +100 -0
  192. data/spec/models/recording_list_dto_spec.rb +52 -0
  193. data/spec/models/recording_medium_dto_spec.rb +88 -0
  194. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +40 -0
  195. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +46 -0
  196. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +40 -0
  197. data/spec/models/recording_party_dto_spec.rb +40 -0
  198. data/spec/models/recording_playlist_dto_spec.rb +52 -0
  199. data/spec/models/recording_small_dto_spec.rb +52 -0
  200. data/spec/models/recording_tag_small_dto_spec.rb +34 -0
  201. data/spec/models/save_file_recording_dto_spec.rb +880 -0
  202. data/spec/models/save_playlist_dto_spec.rb +86 -0
  203. data/spec/models/save_recording_genre_dto_spec.rb +46 -0
  204. data/spec/models/save_recording_party_dto_spec.rb +44 -0
  205. data/spec/models/save_recording_playlist_dto_spec.rb +46 -0
  206. data/spec/models/save_recording_tag_dto_spec.rb +40 -0
  207. data/spec/models/save_referrer_dto_spec.rb +40 -0
  208. data/spec/models/save_taggrams_dto_spec.rb +226 -0
  209. data/spec/models/save_user_dto_spec.rb +72 -0
  210. data/spec/models/search_filter_values_dto_spec.rb +274 -0
  211. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +44 -0
  212. data/spec/models/search_recording_granular_dto_spec.rb +46 -0
  213. data/spec/models/sign_up_dto_spec.rb +52 -0
  214. data/spec/models/tag_dto_spec.rb +46 -0
  215. data/spec/models/tag_small_dto_spec.rb +40 -0
  216. data/spec/models/taggram_dto_spec.rb +58 -0
  217. data/spec/models/tags_summary_dto_spec.rb +46 -0
  218. data/spec/models/tagstrength_dto_spec.rb +58 -0
  219. data/spec/models/title_dto_spec.rb +34 -0
  220. data/spec/models/token_request_spec.rb +34 -0
  221. data/spec/models/track_to_medium_product_dto_spec.rb +46 -0
  222. data/spec/models/update_password_dto_spec.rb +40 -0
  223. data/spec/models/usage_dto_spec.rb +34 -0
  224. data/spec/models/user_dto_spec.rb +148 -0
  225. data/spec/musicube_api_client_ruby_spec.rb +11 -0
  226. data/spec/spec_helper.rb +111 -0
  227. metadata +415 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c1a1e63eb87e9e9bf13d54ad532db199516ffb282c585c76481859e0e8b1653f
4
+ data.tar.gz: f2c9bd45074d1a8979ef3c66dbcbca101cbc6a40bc8d598c5819274c1e02ee53
5
+ SHA512:
6
+ metadata.gz: 5b66e2013651ef35f62442d0338cc6772641bfdda675e048bd3655161f1fd60e5dc716c6f9c5e4c0758b1bc3d3c5197c8b1c5e13bbb514fa2d6449b93506487b
7
+ data.tar.gz: f1968223e6ff144d932a885f27cebf0d8064aa3b98b80c64b4b5c4c09b93138e0d788af3cba5a60e8ca28ec3fe3c649b0e97b852c7929a7e9314dadcf9ed3eb2
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at darylfindlay@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 13.0.1'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/README.md ADDED
@@ -0,0 +1,223 @@
1
+ # musicube_api_client_ruby
2
+
3
+ MusicubeApiClientRuby - the Ruby gem for the Songtradr API
4
+
5
+ This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging.
6
+
7
+ You can also use the API to manage your account and musicube cloud data.
8
+
9
+ **Authentication**
10
+
11
+ 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up.
12
+
13
+ 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint.
14
+
15
+ 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token.
16
+
17
+ **Rate Limiting**
18
+
19
+ The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more.
20
+
21
+ **Getting Started with auto-tagging**
22
+
23
+ 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.
24
+ 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint.
25
+ 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint.
26
+
27
+ **Getting Started with search**
28
+
29
+ You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints.
30
+
31
+ 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.
32
+ 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.
33
+
34
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
35
+
36
+ - API version: 1.12.21
37
+ - Package version: 1.1.5
38
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
39
+ For more information, please visit [https://songtradr.com](https://songtradr.com)
40
+
41
+ ## Installation
42
+
43
+ ### Build a gem
44
+
45
+ To build the Ruby code into a gem:
46
+
47
+ ```shell
48
+ gem build musicube_api_client_ruby.gemspec
49
+ ```
50
+
51
+ Then either install the gem locally:
52
+
53
+ ```shell
54
+ gem install ./musicube_api_client_ruby-1.1.5.gem
55
+ ```
56
+
57
+ (for development, run `gem install --dev ./musicube_api_client_ruby-1.1.5.gem` to install the development dependencies)
58
+
59
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
60
+
61
+ Finally add this to the Gemfile:
62
+
63
+ gem 'musicube_api_client_ruby', '~> 1.1.5'
64
+
65
+ ### Install from Git
66
+
67
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
68
+
69
+ gem 'musicube_api_client_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
70
+
71
+ ### Include the Ruby code directly
72
+
73
+ Include the Ruby code directly using `-I` as follows:
74
+
75
+ ```shell
76
+ ruby -Ilib script.rb
77
+ ```
78
+
79
+ ## Getting Started
80
+
81
+ Please follow the [installation](#installation) procedure and then run the following code:
82
+
83
+ ```ruby
84
+ # Load the gem
85
+ require 'musicube_api_client_ruby'
86
+
87
+ api_instance = MusicubeApiClientRuby::AllowedValuesApi.new
88
+ opts = {
89
+ response_size: 's' # String | Size the response should have.
90
+ }
91
+
92
+ begin
93
+ #Allowed values for music descriptive parameters to be used in the searchAll endpoint.
94
+ result = api_instance.allowed_musical_features(opts)
95
+ p result
96
+ rescue MusicubeApiClientRuby::ApiError => e
97
+ puts "Exception when calling AllowedValuesApi->allowed_musical_features: #{e}"
98
+ end
99
+
100
+ ```
101
+
102
+ ## Documentation for API Endpoints
103
+
104
+ All URIs are relative to *https://api.songtradr.com*
105
+
106
+ Class | Method | HTTP request | Description
107
+ ------------ | ------------- | ------------- | -------------
108
+ *MusicubeApiClientRuby::AllowedValuesApi* | [**allowed_musical_features**](docs/AllowedValuesApi.md#allowed_musical_features) | **GET** /api/v1/allowedValues/musicalFeatures | Allowed values for music descriptive parameters to be used in the searchAll endpoint.
109
+ *MusicubeApiClientRuby::AllowedValuesApi* | [**genres**](docs/AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres.
110
+ *MusicubeApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
111
+ *MusicubeApiClientRuby::PartyApi* | [**party**](docs/PartyApi.md#party) | **GET** /api/v1/party | Information on a person, group or company.
112
+ *MusicubeApiClientRuby::PlaylistApi* | [**all_playlists**](docs/PlaylistApi.md#all_playlists) | **GET** /api/v1/playlist | All playlists.
113
+ *MusicubeApiClientRuby::PlaylistApi* | [**create_or_update_playlist**](docs/PlaylistApi.md#create_or_update_playlist) | **POST** /api/v1/playlist | Create and edit playlist.
114
+ *MusicubeApiClientRuby::PlaylistApi* | [**delete_playlist**](docs/PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist.
115
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_by_ids_with_musical_features**](docs/RecordingApi.md#recordings_by_ids_with_musical_features) | **GET** /api/v1/public/recording/{ids}/musicalFeatures | AI generated moods, musical features and more for recordings.
116
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_by_ids_with_similarities**](docs/RecordingApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings.
117
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_by_ids_with_taggrams**](docs/RecordingApi.md#recordings_by_ids_with_taggrams) | **GET** /api/v1/public/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings.
118
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_by_ids_with_tagstrengths**](docs/RecordingApi.md#recordings_by_ids_with_tagstrengths) | **GET** /api/v1/public/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings.
119
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_large_by_ids**](docs/RecordingApi.md#recordings_large_by_ids) | **GET** /api/v1/public/recording/l/{ids} | Recordings by IDs with a large response.
120
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_medium_by_ids**](docs/RecordingApi.md#recordings_medium_by_ids) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response.
121
+ *MusicubeApiClientRuby::RecordingApi* | [**recordings_small_by_ids**](docs/RecordingApi.md#recordings_small_by_ids) | **GET** /api/v1/public/recording/s/{ids} | Recordings by IDs with a small response.
122
+ *MusicubeApiClientRuby::RecordingApi* | [**search_recordings**](docs/RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more.
123
+ *MusicubeApiClientRuby::RecordingApi* | [**search_recordings_granular**](docs/RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options.
124
+ *MusicubeApiClientRuby::RecordingApi* | [**search_recordings_granular_abstraction**](docs/RecordingApi.md#search_recordings_granular_abstraction) | **POST** /api/v1/public/recording/searchGranularAbstraction | Recordings by abstracted wordings and granular search options.
125
+ *MusicubeApiClientRuby::UserApi* | [**create_user_referrer**](docs/UserApi.md#create_user_referrer) | **POST** /api/v1/user/referrers/new |
126
+ *MusicubeApiClientRuby::UserApi* | [**delete_user_file**](docs/UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file.
127
+ *MusicubeApiClientRuby::UserApi* | [**edit_me**](docs/UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user
128
+ *MusicubeApiClientRuby::UserApi* | [**forgot_password**](docs/UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email
129
+ *MusicubeApiClientRuby::UserApi* | [**initiate_user_file_upload**](docs/UserApi.md#initiate_user_file_upload) | **POST** /api/v1/user/file/{name}/initUpload | Initialize a file upload. Responds with an URL where the file can be uploaded.
130
+ *MusicubeApiClientRuby::UserApi* | [**login**](docs/UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token.
131
+ *MusicubeApiClientRuby::UserApi* | [**me**](docs/UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user
132
+ *MusicubeApiClientRuby::UserApi* | [**recordings_by_folder_with_taggrams**](docs/UserApi.md#recordings_by_folder_with_taggrams) | **GET** /api/v1/user/folder/{folderName}/taggrams | Timeseries of AI generated moods, musical features and more for recordings in your folder.
133
+ *MusicubeApiClientRuby::UserApi* | [**recordings_by_folder_with_tagstrengths**](docs/UserApi.md#recordings_by_folder_with_tagstrengths) | **GET** /api/v1/user/folder/{folderName}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
134
+ *MusicubeApiClientRuby::UserApi* | [**save_playlist**](docs/UserApi.md#save_playlist) | **POST** /api/v1/user/savePlaylist | List, search and create playlist of your own files.
135
+ *MusicubeApiClientRuby::UserApi* | [**sign_up**](docs/UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user.
136
+ *MusicubeApiClientRuby::UserApi* | [**token**](docs/UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token
137
+ *MusicubeApiClientRuby::UserApi* | [**update_password**](docs/UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token
138
+ *MusicubeApiClientRuby::UserApi* | [**update_user_file_recording**](docs/UserApi.md#update_user_file_recording) | **POST** /api/v1/user/file/{objectKey} | Create and edit metadata of your files.
139
+ *MusicubeApiClientRuby::UserApi* | [**user_file**](docs/UserApi.md#user_file) | **GET** /api/v1/user/file/{objectKey} | Details and a download link for a file.
140
+ *MusicubeApiClientRuby::UserApi* | [**user_files**](docs/UserApi.md#user_files) | **GET** /api/v1/user/files | List and search your own files.
141
+ *MusicubeApiClientRuby::UserApi* | [**user_files_download**](docs/UserApi.md#user_files_download) | **GET** /api/v1/user/filesDownload | Download links for your files
142
+ *MusicubeApiClientRuby::UserApi* | [**user_files_status**](docs/UserApi.md#user_files_status) | **GET** /api/v1/user/filesStatus | Status details for files.
143
+ *MusicubeApiClientRuby::UserApi* | [**user_files_summary**](docs/UserApi.md#user_files_summary) | **GET** /api/v1/user/filesSummary | Summary fo your files.
144
+ *MusicubeApiClientRuby::UserApi* | [**user_folders**](docs/UserApi.md#user_folders) | **GET** /api/v1/user/folders | Your Folders
145
+ *MusicubeApiClientRuby::UserApi* | [**user_referrers**](docs/UserApi.md#user_referrers) | **GET** /api/v1/user/referrers/{username} |
146
+
147
+
148
+ ## Documentation for Models
149
+
150
+ - [MusicubeApiClientRuby::CategoryMediumDTO](docs/CategoryMediumDTO.md)
151
+ - [MusicubeApiClientRuby::CategoryMinimalDTO](docs/CategoryMinimalDTO.md)
152
+ - [MusicubeApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
153
+ - [MusicubeApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
154
+ - [MusicubeApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
155
+ - [MusicubeApiClientRuby::ErrorResponse](docs/ErrorResponse.md)
156
+ - [MusicubeApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
157
+ - [MusicubeApiClientRuby::FileDTO](docs/FileDTO.md)
158
+ - [MusicubeApiClientRuby::FileListDTO](docs/FileListDTO.md)
159
+ - [MusicubeApiClientRuby::FileMinimalWithUrlDTO](docs/FileMinimalWithUrlDTO.md)
160
+ - [MusicubeApiClientRuby::FileSmallDTO](docs/FileSmallDTO.md)
161
+ - [MusicubeApiClientRuby::FileUploadDTO](docs/FileUploadDTO.md)
162
+ - [MusicubeApiClientRuby::FileWIthUrlDTO](docs/FileWIthUrlDTO.md)
163
+ - [MusicubeApiClientRuby::FilesSummaryDTO](docs/FilesSummaryDTO.md)
164
+ - [MusicubeApiClientRuby::ForgotPasswordDTO](docs/ForgotPasswordDTO.md)
165
+ - [MusicubeApiClientRuby::GenreDTO](docs/GenreDTO.md)
166
+ - [MusicubeApiClientRuby::GenreMinimalDTO](docs/GenreMinimalDTO.md)
167
+ - [MusicubeApiClientRuby::GenresSummaryDTO](docs/GenresSummaryDTO.md)
168
+ - [MusicubeApiClientRuby::InitPutRecordingAudioDTO](docs/InitPutRecordingAudioDTO.md)
169
+ - [MusicubeApiClientRuby::JwtTokenDTO](docs/JwtTokenDTO.md)
170
+ - [MusicubeApiClientRuby::LoginDTO](docs/LoginDTO.md)
171
+ - [MusicubeApiClientRuby::MusicalFeaturesDTO](docs/MusicalFeaturesDTO.md)
172
+ - [MusicubeApiClientRuby::PLineDTO](docs/PLineDTO.md)
173
+ - [MusicubeApiClientRuby::PartyLargeDTO](docs/PartyLargeDTO.md)
174
+ - [MusicubeApiClientRuby::PartySmallDTO](docs/PartySmallDTO.md)
175
+ - [MusicubeApiClientRuby::PlaylistLargeDTO](docs/PlaylistLargeDTO.md)
176
+ - [MusicubeApiClientRuby::ProductMediumDTO](docs/ProductMediumDTO.md)
177
+ - [MusicubeApiClientRuby::ProductPartyDTO](docs/ProductPartyDTO.md)
178
+ - [MusicubeApiClientRuby::RecordingForSimilaritySearchDTO](docs/RecordingForSimilaritySearchDTO.md)
179
+ - [MusicubeApiClientRuby::RecordingGenrePredictionDTO](docs/RecordingGenrePredictionDTO.md)
180
+ - [MusicubeApiClientRuby::RecordingLargeDTO](docs/RecordingLargeDTO.md)
181
+ - [MusicubeApiClientRuby::RecordingListDTO](docs/RecordingListDTO.md)
182
+ - [MusicubeApiClientRuby::RecordingMediumDTO](docs/RecordingMediumDTO.md)
183
+ - [MusicubeApiClientRuby::RecordingMinimalWithMusicalFeaturesDTO](docs/RecordingMinimalWithMusicalFeaturesDTO.md)
184
+ - [MusicubeApiClientRuby::RecordingMinimalWithTaggramsDTO](docs/RecordingMinimalWithTaggramsDTO.md)
185
+ - [MusicubeApiClientRuby::RecordingMinimalWithTagstrengthsDTO](docs/RecordingMinimalWithTagstrengthsDTO.md)
186
+ - [MusicubeApiClientRuby::RecordingPartyDTO](docs/RecordingPartyDTO.md)
187
+ - [MusicubeApiClientRuby::RecordingPlaylistDTO](docs/RecordingPlaylistDTO.md)
188
+ - [MusicubeApiClientRuby::RecordingSmallDTO](docs/RecordingSmallDTO.md)
189
+ - [MusicubeApiClientRuby::RecordingTagSmallDTO](docs/RecordingTagSmallDTO.md)
190
+ - [MusicubeApiClientRuby::SaveFileRecordingDTO](docs/SaveFileRecordingDTO.md)
191
+ - [MusicubeApiClientRuby::SavePlaylistDTO](docs/SavePlaylistDTO.md)
192
+ - [MusicubeApiClientRuby::SaveRecordingGenreDTO](docs/SaveRecordingGenreDTO.md)
193
+ - [MusicubeApiClientRuby::SaveRecordingPartyDTO](docs/SaveRecordingPartyDTO.md)
194
+ - [MusicubeApiClientRuby::SaveRecordingPlaylistDTO](docs/SaveRecordingPlaylistDTO.md)
195
+ - [MusicubeApiClientRuby::SaveRecordingTagDTO](docs/SaveRecordingTagDTO.md)
196
+ - [MusicubeApiClientRuby::SaveReferrerDTO](docs/SaveReferrerDTO.md)
197
+ - [MusicubeApiClientRuby::SaveTaggramsDTO](docs/SaveTaggramsDTO.md)
198
+ - [MusicubeApiClientRuby::SaveUserDTO](docs/SaveUserDTO.md)
199
+ - [MusicubeApiClientRuby::SearchFilterValuesDTO](docs/SearchFilterValuesDTO.md)
200
+ - [MusicubeApiClientRuby::SearchRecordingGranularAbstractionDTO](docs/SearchRecordingGranularAbstractionDTO.md)
201
+ - [MusicubeApiClientRuby::SearchRecordingGranularDTO](docs/SearchRecordingGranularDTO.md)
202
+ - [MusicubeApiClientRuby::SignUpDTO](docs/SignUpDTO.md)
203
+ - [MusicubeApiClientRuby::TagDTO](docs/TagDTO.md)
204
+ - [MusicubeApiClientRuby::TagSmallDTO](docs/TagSmallDTO.md)
205
+ - [MusicubeApiClientRuby::TaggramDTO](docs/TaggramDTO.md)
206
+ - [MusicubeApiClientRuby::TagsSummaryDTO](docs/TagsSummaryDTO.md)
207
+ - [MusicubeApiClientRuby::TagstrengthDTO](docs/TagstrengthDTO.md)
208
+ - [MusicubeApiClientRuby::TitleDTO](docs/TitleDTO.md)
209
+ - [MusicubeApiClientRuby::TokenRequest](docs/TokenRequest.md)
210
+ - [MusicubeApiClientRuby::TrackToMediumProductDTO](docs/TrackToMediumProductDTO.md)
211
+ - [MusicubeApiClientRuby::UpdatePasswordDTO](docs/UpdatePasswordDTO.md)
212
+ - [MusicubeApiClientRuby::UsageDTO](docs/UsageDTO.md)
213
+ - [MusicubeApiClientRuby::UserDTO](docs/UserDTO.md)
214
+
215
+
216
+ ## Documentation for Authorization
217
+
218
+
219
+ Authentication schemes defined for the API:
220
+ ### bearer-jwt
221
+
222
+ - **Type**: Bearer authentication (JWT)
223
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "bundler/setup"
5
+ require "musicube_api_client_ruby"
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require "irb"
15
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,200 @@
1
+ # MusicubeApiClientRuby::AllowedValuesApi
2
+
3
+ All URIs are relative to *https://api.songtradr.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**allowed_musical_features**](AllowedValuesApi.md#allowed_musical_features) | **GET** /api/v1/allowedValues/musicalFeatures | Allowed values for music descriptive parameters to be used in the searchAll endpoint. |
8
+ | [**genres**](AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres. |
9
+ | [**tags**](AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories. |
10
+
11
+
12
+ ## allowed_musical_features
13
+
14
+ > <SearchFilterValuesDTO> allowed_musical_features(opts)
15
+
16
+ Allowed values for music descriptive parameters to be used in the searchAll endpoint.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'musicube_api_client_ruby'
23
+
24
+ api_instance = MusicubeApiClientRuby::AllowedValuesApi.new
25
+ opts = {
26
+ response_size: 's' # String | Size the response should have.
27
+ }
28
+
29
+ begin
30
+ # Allowed values for music descriptive parameters to be used in the searchAll endpoint.
31
+ result = api_instance.allowed_musical_features(opts)
32
+ p result
33
+ rescue MusicubeApiClientRuby::ApiError => e
34
+ puts "Error when calling AllowedValuesApi->allowed_musical_features: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the allowed_musical_features_with_http_info variant
39
+
40
+ This returns an Array which contains the response data, status code and headers.
41
+
42
+ > <Array(<SearchFilterValuesDTO>, Integer, Hash)> allowed_musical_features_with_http_info(opts)
43
+
44
+ ```ruby
45
+ begin
46
+ # Allowed values for music descriptive parameters to be used in the searchAll endpoint.
47
+ data, status_code, headers = api_instance.allowed_musical_features_with_http_info(opts)
48
+ p status_code # => 2xx
49
+ p headers # => { ... }
50
+ p data # => <SearchFilterValuesDTO>
51
+ rescue MusicubeApiClientRuby::ApiError => e
52
+ puts "Error when calling AllowedValuesApi->allowed_musical_features_with_http_info: #{e}"
53
+ end
54
+ ```
55
+
56
+ ### Parameters
57
+
58
+ | Name | Type | Description | Notes |
59
+ | ---- | ---- | ----------- | ----- |
60
+ | **response_size** | **String** | Size the response should have. | [optional][default to &#39;s&#39;] |
61
+
62
+ ### Return type
63
+
64
+ [**SearchFilterValuesDTO**](SearchFilterValuesDTO.md)
65
+
66
+ ### Authorization
67
+
68
+ No authorization required
69
+
70
+ ### HTTP request headers
71
+
72
+ - **Content-Type**: Not defined
73
+ - **Accept**: application/json
74
+
75
+
76
+ ## genres
77
+
78
+ > <Array<GenreDTO>> genres(genre_type)
79
+
80
+ Allowed values for genres.
81
+
82
+ ### Examples
83
+
84
+ ```ruby
85
+ require 'time'
86
+ require 'musicube_api_client_ruby'
87
+
88
+ api_instance = MusicubeApiClientRuby::AllowedValuesApi.new
89
+ genre_type = 'level1Genre' # String | Type of the response should have.
90
+
91
+ begin
92
+ # Allowed values for genres.
93
+ result = api_instance.genres(genre_type)
94
+ p result
95
+ rescue MusicubeApiClientRuby::ApiError => e
96
+ puts "Error when calling AllowedValuesApi->genres: #{e}"
97
+ end
98
+ ```
99
+
100
+ #### Using the genres_with_http_info variant
101
+
102
+ This returns an Array which contains the response data, status code and headers.
103
+
104
+ > <Array(<Array<GenreDTO>>, Integer, Hash)> genres_with_http_info(genre_type)
105
+
106
+ ```ruby
107
+ begin
108
+ # Allowed values for genres.
109
+ data, status_code, headers = api_instance.genres_with_http_info(genre_type)
110
+ p status_code # => 2xx
111
+ p headers # => { ... }
112
+ p data # => <Array<GenreDTO>>
113
+ rescue MusicubeApiClientRuby::ApiError => e
114
+ puts "Error when calling AllowedValuesApi->genres_with_http_info: #{e}"
115
+ end
116
+ ```
117
+
118
+ ### Parameters
119
+
120
+ | Name | Type | Description | Notes |
121
+ | ---- | ---- | ----------- | ----- |
122
+ | **genre_type** | **String** | Type of the response should have. | |
123
+
124
+ ### Return type
125
+
126
+ [**Array&lt;GenreDTO&gt;**](GenreDTO.md)
127
+
128
+ ### Authorization
129
+
130
+ No authorization required
131
+
132
+ ### HTTP request headers
133
+
134
+ - **Content-Type**: Not defined
135
+ - **Accept**: application/json
136
+
137
+
138
+ ## tags
139
+
140
+ > <Array<CategoryMediumDTO>> tags(opts)
141
+
142
+ All descriptive tags inside of tag-categories.
143
+
144
+ ### Examples
145
+
146
+ ```ruby
147
+ require 'time'
148
+ require 'musicube_api_client_ruby'
149
+
150
+ api_instance = MusicubeApiClientRuby::AllowedValuesApi.new
151
+ opts = {
152
+ category_name: 'mood' # String | Filters tags for one category only
153
+ }
154
+
155
+ begin
156
+ # All descriptive tags inside of tag-categories.
157
+ result = api_instance.tags(opts)
158
+ p result
159
+ rescue MusicubeApiClientRuby::ApiError => e
160
+ puts "Error when calling AllowedValuesApi->tags: #{e}"
161
+ end
162
+ ```
163
+
164
+ #### Using the tags_with_http_info variant
165
+
166
+ This returns an Array which contains the response data, status code and headers.
167
+
168
+ > <Array(<Array<CategoryMediumDTO>>, Integer, Hash)> tags_with_http_info(opts)
169
+
170
+ ```ruby
171
+ begin
172
+ # All descriptive tags inside of tag-categories.
173
+ data, status_code, headers = api_instance.tags_with_http_info(opts)
174
+ p status_code # => 2xx
175
+ p headers # => { ... }
176
+ p data # => <Array<CategoryMediumDTO>>
177
+ rescue MusicubeApiClientRuby::ApiError => e
178
+ puts "Error when calling AllowedValuesApi->tags_with_http_info: #{e}"
179
+ end
180
+ ```
181
+
182
+ ### Parameters
183
+
184
+ | Name | Type | Description | Notes |
185
+ | ---- | ---- | ----------- | ----- |
186
+ | **category_name** | **String** | Filters tags for one category only | [optional] |
187
+
188
+ ### Return type
189
+
190
+ [**Array&lt;CategoryMediumDTO&gt;**](CategoryMediumDTO.md)
191
+
192
+ ### Authorization
193
+
194
+ No authorization required
195
+
196
+ ### HTTP request headers
197
+
198
+ - **Content-Type**: Not defined
199
+ - **Accept**: application/json
200
+
@@ -0,0 +1,22 @@
1
+ # MusicubeApiClientRuby::CategoryMediumDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | | |
8
+ | **tags** | [**Array&lt;TagSmallDTO&gt;**](TagSmallDTO.md) | | [optional] |
9
+ | **name** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'musicube_api_client_ruby'
15
+
16
+ instance = MusicubeApiClientRuby::CategoryMediumDTO.new(
17
+ id: null,
18
+ tags: null,
19
+ name: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # MusicubeApiClientRuby::CategoryMinimalDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category_name** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'musicube_api_client_ruby'
13
+
14
+ instance = MusicubeApiClientRuby::CategoryMinimalDTO.new(
15
+ category_name: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # MusicubeApiClientRuby::ConfigAccessDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **accessor_id** | **String** | ID of the accessing entity | |
8
+ | **rights** | **String** | access rights to a resource | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'musicube_api_client_ruby'
14
+
15
+ instance = MusicubeApiClientRuby::ConfigAccessDTO.new(
16
+ accessor_id: null,
17
+ rights: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # MusicubeApiClientRuby::ConfigIdentifierDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **identifier_type** | **String** | | |
8
+ | **identifier_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'musicube_api_client_ruby'
14
+
15
+ instance = MusicubeApiClientRuby::ConfigIdentifierDTO.new(
16
+ identifier_type: null,
17
+ identifier_value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # MusicubeApiClientRuby::ContributorTypeDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type_name** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'musicube_api_client_ruby'
13
+
14
+ instance = MusicubeApiClientRuby::ContributorTypeDTO.new(
15
+ type_name: null
16
+ )
17
+ ```
18
+