songtradr_api_client_ruby 1.13.7 → 1.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (243) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +5 -37
  4. data/docs/FileSmallDTO.md +2 -2
  5. data/docs/MusicalFeaturesDTO.md +25 -25
  6. data/docs/PlaylistApi.md +0 -214
  7. data/docs/RecordingApi.md +2 -204
  8. data/docs/RecordingGenrePredictionDTO.md +3 -3
  9. data/docs/RecordingMediumDTO.md +2 -2
  10. data/docs/RecordingPartyDTO.md +3 -3
  11. data/docs/UserApi.md +8 -456
  12. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
  13. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +2 -202
  14. data/lib/songtradr_api_client_ruby/api/recording_api.rb +6 -191
  15. data/lib/songtradr_api_client_ruby/api/user_api.rb +161 -749
  16. data/lib/songtradr_api_client_ruby/api_client.rb +38 -36
  17. data/lib/songtradr_api_client_ruby/api_error.rb +2 -2
  18. data/lib/songtradr_api_client_ruby/configuration.rb +2 -2
  19. data/lib/songtradr_api_client_ruby/models/age_range.rb +3 -3
  20. data/lib/songtradr_api_client_ruby/models/beard.rb +3 -3
  21. data/lib/songtradr_api_client_ruby/models/bounding_box.rb +3 -3
  22. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +3 -3
  23. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +3 -3
  24. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +3 -3
  25. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +3 -3
  26. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +3 -3
  27. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +3 -3
  28. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +3 -3
  29. data/lib/songtradr_api_client_ruby/models/dominant_color.rb +3 -3
  30. data/lib/songtradr_api_client_ruby/models/emotion.rb +3 -3
  31. data/lib/songtradr_api_client_ruby/models/error_response.rb +3 -3
  32. data/lib/songtradr_api_client_ruby/models/eye_direction.rb +3 -3
  33. data/lib/songtradr_api_client_ruby/models/eye_open.rb +3 -3
  34. data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +3 -3
  35. data/lib/songtradr_api_client_ruby/models/face_detail.rb +3 -3
  36. data/lib/songtradr_api_client_ruby/models/face_detection.rb +3 -3
  37. data/lib/songtradr_api_client_ruby/models/face_occluded.rb +3 -3
  38. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +3 -3
  39. data/lib/songtradr_api_client_ruby/models/file_dto.rb +3 -3
  40. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +3 -3
  41. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +15 -15
  42. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +3 -3
  43. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +3 -3
  44. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +3 -3
  45. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +3 -3
  46. data/lib/songtradr_api_client_ruby/models/gender.rb +3 -3
  47. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +3 -3
  48. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +3 -3
  49. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +3 -3
  50. data/lib/songtradr_api_client_ruby/models/image_quality.rb +3 -3
  51. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +3 -3
  52. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +3 -3
  53. data/lib/songtradr_api_client_ruby/models/instance.rb +3 -3
  54. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +3 -3
  55. data/lib/songtradr_api_client_ruby/models/label.rb +3 -3
  56. data/lib/songtradr_api_client_ruby/models/label_alias.rb +3 -3
  57. data/lib/songtradr_api_client_ruby/models/label_category.rb +3 -3
  58. data/lib/songtradr_api_client_ruby/models/label_detection.rb +3 -3
  59. data/lib/songtradr_api_client_ruby/models/landmark.rb +3 -3
  60. data/lib/songtradr_api_client_ruby/models/login_dto.rb +3 -3
  61. data/lib/songtradr_api_client_ruby/models/mouth_open.rb +3 -3
  62. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +270 -270
  63. data/lib/songtradr_api_client_ruby/models/mustache.rb +3 -3
  64. data/lib/songtradr_api_client_ruby/models/parent.rb +3 -3
  65. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +3 -3
  66. data/lib/songtradr_api_client_ruby/models/pose.rb +3 -3
  67. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +3 -3
  68. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +23 -23
  69. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +3 -3
  70. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +13 -13
  71. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +3 -3
  72. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +3 -3
  73. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +3 -3
  74. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +18 -18
  75. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +3 -3
  76. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +3 -3
  77. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +3 -3
  78. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +3 -3
  79. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +3 -3
  80. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +3 -3
  81. data/lib/songtradr_api_client_ruby/models/smile.rb +3 -3
  82. data/lib/songtradr_api_client_ruby/models/sunglasses.rb +3 -3
  83. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +3 -3
  84. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +3 -3
  85. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +3 -3
  86. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +3 -3
  87. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +3 -3
  88. data/lib/songtradr_api_client_ruby/models/title_dto.rb +3 -3
  89. data/lib/songtradr_api_client_ruby/models/token_request.rb +3 -3
  90. data/lib/songtradr_api_client_ruby/models/track_dto.rb +3 -3
  91. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +3 -3
  92. data/lib/songtradr_api_client_ruby/models/user_dto.rb +3 -3
  93. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +3 -3
  94. data/lib/songtradr_api_client_ruby/version.rb +3 -3
  95. data/lib/songtradr_api_client_ruby.rb +2 -23
  96. data/openapi-generator-config.yaml +1 -1
  97. data/songtradr_api_client_ruby.gemspec +3 -2
  98. data/spec/api/allowed_values_api_spec.rb +2 -2
  99. data/spec/api/playlist_api_spec.rb +2 -39
  100. data/spec/api/recording_api_spec.rb +3 -35
  101. data/spec/api/user_api_spec.rb +6 -111
  102. data/spec/api_client_spec.rb +2 -2
  103. data/spec/configuration_spec.rb +2 -2
  104. data/spec/models/age_range_spec.rb +2 -2
  105. data/spec/models/beard_spec.rb +2 -2
  106. data/spec/models/bounding_box_spec.rb +2 -2
  107. data/spec/models/category_medium_dto_spec.rb +2 -2
  108. data/spec/models/category_minimal_dto_spec.rb +2 -2
  109. data/spec/models/config_access_dto_spec.rb +2 -2
  110. data/spec/models/config_identifier_dto_spec.rb +2 -2
  111. data/spec/models/contributor_type_dto_spec.rb +2 -2
  112. data/spec/models/curate_playlist_dto_spec.rb +2 -2
  113. data/spec/models/curate_playlist_response_dto_spec.rb +2 -2
  114. data/spec/models/dominant_color_spec.rb +2 -2
  115. data/spec/models/emotion_spec.rb +2 -2
  116. data/spec/models/error_response_spec.rb +2 -2
  117. data/spec/models/eye_direction_spec.rb +2 -2
  118. data/spec/models/eye_open_spec.rb +2 -2
  119. data/spec/models/eyeglasses_spec.rb +2 -2
  120. data/spec/models/face_detail_spec.rb +2 -2
  121. data/spec/models/face_detection_spec.rb +2 -2
  122. data/spec/models/face_occluded_spec.rb +2 -2
  123. data/spec/models/field_summary_dto_spec.rb +2 -2
  124. data/spec/models/file_dto_spec.rb +2 -2
  125. data/spec/models/file_list_dto_spec.rb +2 -2
  126. data/spec/models/file_small_dto_spec.rb +5 -5
  127. data/spec/models/file_upload_dto_spec.rb +2 -2
  128. data/spec/models/file_w_ith_url_dto_spec.rb +2 -2
  129. data/spec/models/files_summary_dto_spec.rb +2 -2
  130. data/spec/models/forgot_password_dto_spec.rb +2 -2
  131. data/spec/models/gender_spec.rb +2 -2
  132. data/spec/models/genre_dto_spec.rb +2 -2
  133. data/spec/models/genre_minimal_dto_spec.rb +2 -2
  134. data/spec/models/genres_summary_dto_spec.rb +2 -2
  135. data/spec/models/image_quality_spec.rb +2 -2
  136. data/spec/models/image_recognition_response_spec.rb +2 -2
  137. data/spec/models/init_put_recording_audio_dto_spec.rb +2 -2
  138. data/spec/models/instance_spec.rb +2 -2
  139. data/spec/models/jwt_token_dto_spec.rb +2 -2
  140. data/spec/models/label_alias_spec.rb +2 -2
  141. data/spec/models/label_category_spec.rb +2 -2
  142. data/spec/models/label_detection_spec.rb +2 -2
  143. data/spec/models/label_spec.rb +2 -2
  144. data/spec/models/landmark_spec.rb +2 -2
  145. data/spec/models/login_dto_spec.rb +2 -2
  146. data/spec/models/mouth_open_spec.rb +2 -2
  147. data/spec/models/musical_features_dto_spec.rb +81 -81
  148. data/spec/models/mustache_spec.rb +2 -2
  149. data/spec/models/parent_spec.rb +2 -2
  150. data/spec/models/party_small_dto_spec.rb +2 -2
  151. data/spec/models/pose_spec.rb +2 -2
  152. data/spec/models/recording_for_similarity_search_dto_spec.rb +2 -2
  153. data/spec/models/recording_genre_prediction_dto_spec.rb +5 -5
  154. data/spec/models/recording_list_dto_spec.rb +2 -2
  155. data/spec/models/recording_medium_dto_spec.rb +4 -4
  156. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +2 -2
  157. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +2 -2
  158. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +2 -2
  159. data/spec/models/recording_party_dto_spec.rb +4 -4
  160. data/spec/models/recording_small_dto_spec.rb +2 -2
  161. data/spec/models/recording_tag_small_dto_spec.rb +2 -2
  162. data/spec/models/save_user_dto_spec.rb +2 -2
  163. data/spec/models/search_filter_values_dto_spec.rb +2 -2
  164. data/spec/models/search_recording_granular_dto_spec.rb +2 -2
  165. data/spec/models/sign_up_dto_spec.rb +2 -2
  166. data/spec/models/smile_spec.rb +2 -2
  167. data/spec/models/sunglasses_spec.rb +2 -2
  168. data/spec/models/tag_dto_spec.rb +2 -2
  169. data/spec/models/tag_small_dto_spec.rb +2 -2
  170. data/spec/models/taggram_dto_spec.rb +2 -2
  171. data/spec/models/tags_summary_dto_spec.rb +2 -2
  172. data/spec/models/tagstrength_dto_spec.rb +2 -2
  173. data/spec/models/title_dto_spec.rb +2 -2
  174. data/spec/models/token_request_spec.rb +2 -2
  175. data/spec/models/track_dto_spec.rb +2 -2
  176. data/spec/models/update_password_dto_spec.rb +2 -2
  177. data/spec/models/user_dto_spec.rb +2 -2
  178. data/spec/models/video_recognition_response_spec.rb +2 -2
  179. data/spec/spec_helper.rb +2 -2
  180. metadata +65 -149
  181. data/docs/ContextValue.md +0 -18
  182. data/docs/FileMinimalWithUrlDTO.md +0 -22
  183. data/docs/PLineDTO.md +0 -20
  184. data/docs/PartyApi.md +0 -75
  185. data/docs/PartyLargeDTO.md +0 -32
  186. data/docs/PlaylistLargeDTO.md +0 -38
  187. data/docs/ProductMediumDTO.md +0 -34
  188. data/docs/ProductPartyDTO.md +0 -20
  189. data/docs/RecordingLargeDTO.md +0 -40
  190. data/docs/RecordingPlaylistDTO.md +0 -24
  191. data/docs/SaveFileRecordingDTO.md +0 -240
  192. data/docs/SavePlaylistDTO.md +0 -34
  193. data/docs/SaveRecordingGenreDTO.md +0 -22
  194. data/docs/SaveRecordingPartyDTO.md +0 -20
  195. data/docs/SaveRecordingPlaylistDTO.md +0 -22
  196. data/docs/SaveRecordingTagDTO.md +0 -20
  197. data/docs/SaveReferrerDTO.md +0 -20
  198. data/docs/SaveTaggramsDTO.md +0 -82
  199. data/docs/SearchRecordingGranularAbstractionDTO.md +0 -20
  200. data/docs/TrackToMediumProductDTO.md +0 -22
  201. data/docs/UsageDTO.md +0 -18
  202. data/lib/songtradr_api_client_ruby/api/party_api.rb +0 -84
  203. data/lib/songtradr_api_client_ruby/models/context_value.rb +0 -216
  204. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +0 -254
  205. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +0 -231
  206. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +0 -285
  207. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +0 -350
  208. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +0 -323
  209. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +0 -233
  210. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +0 -383
  211. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +0 -242
  212. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +0 -1864
  213. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +0 -353
  214. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +0 -240
  215. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +0 -272
  216. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +0 -247
  217. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +0 -231
  218. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +0 -224
  219. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +0 -569
  220. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +0 -267
  221. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +0 -247
  222. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +0 -215
  223. data/spec/api/party_api_spec.rb +0 -46
  224. data/spec/models/context_value_spec.rb +0 -36
  225. data/spec/models/file_minimal_with_url_dto_spec.rb +0 -48
  226. data/spec/models/p_line_dto_spec.rb +0 -42
  227. data/spec/models/party_large_dto_spec.rb +0 -78
  228. data/spec/models/playlist_large_dto_spec.rb +0 -100
  229. data/spec/models/product_medium_dto_spec.rb +0 -84
  230. data/spec/models/product_party_dto_spec.rb +0 -42
  231. data/spec/models/recording_large_dto_spec.rb +0 -102
  232. data/spec/models/recording_playlist_dto_spec.rb +0 -54
  233. data/spec/models/save_file_recording_dto_spec.rb +0 -894
  234. data/spec/models/save_playlist_dto_spec.rb +0 -88
  235. data/spec/models/save_recording_genre_dto_spec.rb +0 -48
  236. data/spec/models/save_recording_party_dto_spec.rb +0 -46
  237. data/spec/models/save_recording_playlist_dto_spec.rb +0 -48
  238. data/spec/models/save_recording_tag_dto_spec.rb +0 -42
  239. data/spec/models/save_referrer_dto_spec.rb +0 -42
  240. data/spec/models/save_taggrams_dto_spec.rb +0 -228
  241. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +0 -46
  242. data/spec/models/track_to_medium_product_dto_spec.rb +0 -48
  243. data/spec/models/usage_dto_spec.rb +0 -36
data/docs/UserApi.md CHANGED
@@ -4,7 +4,6 @@ All URIs are relative to *https://api.songtradr.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_user_referrer**](UserApi.md#create_user_referrer) | **POST** /api/v1/user/referrers/new | |
8
7
  | [**delete_user_file**](UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file. |
9
8
  | [**edit_me**](UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user |
10
9
  | [**forgot_password**](UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email |
@@ -19,81 +18,10 @@ All URIs are relative to *https://api.songtradr.com*
19
18
  | [**sign_up**](UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user. |
20
19
  | [**token**](UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token |
21
20
  | [**update_password**](UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token |
22
- | [**update_user_file_recording**](UserApi.md#update_user_file_recording) | **POST** /api/v1/user/file/{objectKey} | Create and edit metadata of your files. |
23
21
  | [**user_file**](UserApi.md#user_file) | **GET** /api/v1/user/file/{objectKey} | Details and a download link for a file. |
24
22
  | [**user_files**](UserApi.md#user_files) | **GET** /api/v1/user/files | List and search your own files. |
25
- | [**user_files_download**](UserApi.md#user_files_download) | **GET** /api/v1/user/filesDownload | Download links for your files |
26
23
  | [**user_files_status**](UserApi.md#user_files_status) | **GET** /api/v1/user/filesStatus | Status details for files. |
27
24
  | [**user_files_summary**](UserApi.md#user_files_summary) | **GET** /api/v1/user/filesSummary | Summary fo your files. |
28
- | [**user_folders**](UserApi.md#user_folders) | **GET** /api/v1/user/folders | Your Folders |
29
- | [**user_referrers**](UserApi.md#user_referrers) | **GET** /api/v1/user/referrers/{username} | |
30
-
31
-
32
- ## create_user_referrer
33
-
34
- > Object create_user_referrer(save_referrer_dto)
35
-
36
-
37
-
38
- ### Examples
39
-
40
- ```ruby
41
- require 'time'
42
- require 'songtradr_api_client_ruby'
43
- # setup authorization
44
- SongtradrApiClientRuby.configure do |config|
45
- # Configure Bearer authorization (JWT): bearer-jwt
46
- config.access_token = 'YOUR_BEARER_TOKEN'
47
- end
48
-
49
- api_instance = SongtradrApiClientRuby::UserApi.new
50
- save_referrer_dto = SongtradrApiClientRuby::SaveReferrerDTO.new # SaveReferrerDTO |
51
-
52
- begin
53
-
54
- result = api_instance.create_user_referrer(save_referrer_dto)
55
- p result
56
- rescue SongtradrApiClientRuby::ApiError => e
57
- puts "Error when calling UserApi->create_user_referrer: #{e}"
58
- end
59
- ```
60
-
61
- #### Using the create_user_referrer_with_http_info variant
62
-
63
- This returns an Array which contains the response data, status code and headers.
64
-
65
- > <Array(Object, Integer, Hash)> create_user_referrer_with_http_info(save_referrer_dto)
66
-
67
- ```ruby
68
- begin
69
-
70
- data, status_code, headers = api_instance.create_user_referrer_with_http_info(save_referrer_dto)
71
- p status_code # => 2xx
72
- p headers # => { ... }
73
- p data # => Object
74
- rescue SongtradrApiClientRuby::ApiError => e
75
- puts "Error when calling UserApi->create_user_referrer_with_http_info: #{e}"
76
- end
77
- ```
78
-
79
- ### Parameters
80
-
81
- | Name | Type | Description | Notes |
82
- | ---- | ---- | ----------- | ----- |
83
- | **save_referrer_dto** | [**SaveReferrerDTO**](SaveReferrerDTO.md) | | |
84
-
85
- ### Return type
86
-
87
- **Object**
88
-
89
- ### Authorization
90
-
91
- [bearer-jwt](../README.md#bearer-jwt)
92
-
93
- ### HTTP request headers
94
-
95
- - **Content-Type**: application/json
96
- - **Accept**: application/json
97
25
 
98
26
 
99
27
  ## delete_user_file
@@ -663,6 +591,7 @@ opts = {
663
591
  tag_name: 'energetic', # String | Show only taggrams for one tag.
664
592
  genre_name: 'Ska', # String | Show only taggrams for one genre.
665
593
  from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
594
+ to_timestamp: 32.0, # Float | Show only taggrams data before this timestamp in seconds.
666
595
  fill_with_zero: true, # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
667
596
  page: 56, # Integer | Zero-based page index (0..N)
668
597
  size: 56, # Integer | The size of the page to be returned
@@ -705,6 +634,7 @@ end
705
634
  | **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
706
635
  | **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
707
636
  | **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
637
+ | **to_timestamp** | **Float** | Show only taggrams data before this timestamp in seconds. | [optional] |
708
638
  | **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [optional] |
709
639
  | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
710
640
  | **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
@@ -849,6 +779,7 @@ opts = {
849
779
  sound_generation: 'acoustic', # String |
850
780
  tempo: 'very slow', # String |
851
781
  scale: 'major key', # String |
782
+ key: 'C', # String |
852
783
  rhythm: 'common time', # String |
853
784
  primary_sound_character: 'aggressive', # String |
854
785
  timbre: 'very warm', # String |
@@ -943,6 +874,7 @@ end
943
874
  | **sound_generation** | **String** | | [optional] |
944
875
  | **tempo** | **String** | | [optional] |
945
876
  | **scale** | **String** | | [optional] |
877
+ | **key** | **String** | | [optional] |
946
878
  | **rhythm** | **String** | | [optional] |
947
879
  | **primary_sound_character** | **String** | | [optional] |
948
880
  | **timbre** | **String** | | [optional] |
@@ -1195,75 +1127,6 @@ end
1195
1127
  - **Accept**: application/hal+json, application/json
1196
1128
 
1197
1129
 
1198
- ## update_user_file_recording
1199
-
1200
- > Object update_user_file_recording(object_key, save_file_recording_dto)
1201
-
1202
- Create and edit metadata of your files.
1203
-
1204
- ### Examples
1205
-
1206
- ```ruby
1207
- require 'time'
1208
- require 'songtradr_api_client_ruby'
1209
- # setup authorization
1210
- SongtradrApiClientRuby.configure do |config|
1211
- # Configure Bearer authorization (JWT): bearer-jwt
1212
- config.access_token = 'YOUR_BEARER_TOKEN'
1213
- end
1214
-
1215
- api_instance = SongtradrApiClientRuby::UserApi.new
1216
- object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be edited.
1217
- save_file_recording_dto = SongtradrApiClientRuby::SaveFileRecordingDTO.new({isrc: 'isrc_example', created_by_version: 'created_by_version_example'}) # SaveFileRecordingDTO |
1218
-
1219
- begin
1220
- # Create and edit metadata of your files.
1221
- result = api_instance.update_user_file_recording(object_key, save_file_recording_dto)
1222
- p result
1223
- rescue SongtradrApiClientRuby::ApiError => e
1224
- puts "Error when calling UserApi->update_user_file_recording: #{e}"
1225
- end
1226
- ```
1227
-
1228
- #### Using the update_user_file_recording_with_http_info variant
1229
-
1230
- This returns an Array which contains the response data, status code and headers.
1231
-
1232
- > <Array(Object, Integer, Hash)> update_user_file_recording_with_http_info(object_key, save_file_recording_dto)
1233
-
1234
- ```ruby
1235
- begin
1236
- # Create and edit metadata of your files.
1237
- data, status_code, headers = api_instance.update_user_file_recording_with_http_info(object_key, save_file_recording_dto)
1238
- p status_code # => 2xx
1239
- p headers # => { ... }
1240
- p data # => Object
1241
- rescue SongtradrApiClientRuby::ApiError => e
1242
- puts "Error when calling UserApi->update_user_file_recording_with_http_info: #{e}"
1243
- end
1244
- ```
1245
-
1246
- ### Parameters
1247
-
1248
- | Name | Type | Description | Notes |
1249
- | ---- | ---- | ----------- | ----- |
1250
- | **object_key** | **String** | ObjectKey of the file that should be edited. | |
1251
- | **save_file_recording_dto** | [**SaveFileRecordingDTO**](SaveFileRecordingDTO.md) | | |
1252
-
1253
- ### Return type
1254
-
1255
- **Object**
1256
-
1257
- ### Authorization
1258
-
1259
- [bearer-jwt](../README.md#bearer-jwt)
1260
-
1261
- ### HTTP request headers
1262
-
1263
- - **Content-Type**: application/json
1264
- - **Accept**: application/json
1265
-
1266
-
1267
1130
  ## user_file
1268
1131
 
1269
1132
  > <FileWIthUrlDTO> user_file(object_key)
@@ -1375,6 +1238,7 @@ opts = {
1375
1238
  sound_generation: 'acoustic', # String |
1376
1239
  tempo: 'very slow', # String |
1377
1240
  scale: 'major key', # String |
1241
+ key: 'C', # String |
1378
1242
  rhythm: 'common time', # String |
1379
1243
  primary_sound_character: 'aggressive', # String |
1380
1244
  timbre: 'very warm', # String |
@@ -1468,6 +1332,7 @@ end
1468
1332
  | **sound_generation** | **String** | | [optional] |
1469
1333
  | **tempo** | **String** | | [optional] |
1470
1334
  | **scale** | **String** | | [optional] |
1335
+ | **key** | **String** | | [optional] |
1471
1336
  | **rhythm** | **String** | | [optional] |
1472
1337
  | **primary_sound_character** | **String** | | [optional] |
1473
1338
  | **timbre** | **String** | | [optional] |
@@ -1518,181 +1383,6 @@ end
1518
1383
  - **Accept**: application/json
1519
1384
 
1520
1385
 
1521
- ## user_files_download
1522
-
1523
- > <Array<FileMinimalWithUrlDTO>> user_files_download(opts)
1524
-
1525
- Download links for your files
1526
-
1527
- ### Examples
1528
-
1529
- ```ruby
1530
- require 'time'
1531
- require 'songtradr_api_client_ruby'
1532
- # setup authorization
1533
- SongtradrApiClientRuby.configure do |config|
1534
- # Configure Bearer authorization (JWT): bearer-jwt
1535
- config.access_token = 'YOUR_BEARER_TOKEN'
1536
- end
1537
-
1538
- api_instance = SongtradrApiClientRuby::UserApi.new
1539
- opts = {
1540
- isrc: 'isrc_example', # String |
1541
- contributor: 'contributor_example', # String |
1542
- main_artist: 'main_artist_example', # String |
1543
- composer: 'composer_example', # String |
1544
- title: 'title_example', # String |
1545
- language: 'language_example', # String |
1546
- genre_names: ['inner_example'], # Array<String> |
1547
- tag_names: ['inner_example'], # Array<String> |
1548
- release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
1549
- primary_mood_cluster: 'aggressive', # String |
1550
- secondary_mood_cluster: 'aggressive', # String |
1551
- tertiary_mood_cluster: 'aggressive', # String |
1552
- valence: 'very sad', # String |
1553
- arousal: 'very calm', # String |
1554
- pleasantness: 'very unpleasant', # String |
1555
- engagement: 'very unengaging', # String |
1556
- vocals: 'instrumental', # String |
1557
- dominant_instrument: 'electric guitar', # String |
1558
- secondary_instrument: 'electric guitar', # String |
1559
- tertiary_instrument: 'electric guitar', # String |
1560
- energy: 'very quiet', # String |
1561
- sound_generation: 'acoustic', # String |
1562
- tempo: 'very slow', # String |
1563
- scale: 'major key', # String |
1564
- rhythm: 'common time', # String |
1565
- primary_sound_character: 'aggressive', # String |
1566
- timbre: 'very warm', # String |
1567
- roughness: 'very clear', # String |
1568
- tonality: 'monotonous', # String |
1569
- harmony: 'very dissonant', # String |
1570
- texture: 'very thin', # String |
1571
- groovyness: 'very steady', # String |
1572
- space: 'very compact', # String |
1573
- production_rating: 'low production quality', # String |
1574
- performance_rating: 'low performance quality', # String |
1575
- song_rating: 'low song quality', # String |
1576
- audience_age: 'Generation Z', # String |
1577
- audience_region: 'Australia and New Zealand', # String |
1578
- audience_gender: 'male', # String |
1579
- songtradr_track_id: 'songtradr_track_id_example', # String |
1580
- usage_name: 'usage_name_example', # String |
1581
- bpm_min: 56, # Integer |
1582
- bpm_max: 56, # Integer |
1583
- name: 'name_example', # String |
1584
- folder: 'folder_example', # String |
1585
- extension: 'extension_example', # String |
1586
- upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
1587
- min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
1588
- max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
1589
- fingerprint_status: 'fingerprint_status_example', # String |
1590
- inference_status: 'inference_status_example', # String |
1591
- page: 56, # Integer | Zero-based page index (0..N)
1592
- size: 56, # Integer | The size of the page to be returned
1593
- sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
1594
- }
1595
-
1596
- begin
1597
- # Download links for your files
1598
- result = api_instance.user_files_download(opts)
1599
- p result
1600
- rescue SongtradrApiClientRuby::ApiError => e
1601
- puts "Error when calling UserApi->user_files_download: #{e}"
1602
- end
1603
- ```
1604
-
1605
- #### Using the user_files_download_with_http_info variant
1606
-
1607
- This returns an Array which contains the response data, status code and headers.
1608
-
1609
- > <Array(<Array<FileMinimalWithUrlDTO>>, Integer, Hash)> user_files_download_with_http_info(opts)
1610
-
1611
- ```ruby
1612
- begin
1613
- # Download links for your files
1614
- data, status_code, headers = api_instance.user_files_download_with_http_info(opts)
1615
- p status_code # => 2xx
1616
- p headers # => { ... }
1617
- p data # => <Array<FileMinimalWithUrlDTO>>
1618
- rescue SongtradrApiClientRuby::ApiError => e
1619
- puts "Error when calling UserApi->user_files_download_with_http_info: #{e}"
1620
- end
1621
- ```
1622
-
1623
- ### Parameters
1624
-
1625
- | Name | Type | Description | Notes |
1626
- | ---- | ---- | ----------- | ----- |
1627
- | **isrc** | **String** | | [optional] |
1628
- | **contributor** | **String** | | [optional] |
1629
- | **main_artist** | **String** | | [optional] |
1630
- | **composer** | **String** | | [optional] |
1631
- | **title** | **String** | | [optional] |
1632
- | **language** | **String** | | [optional] |
1633
- | **genre_names** | [**Array&lt;String&gt;**](String.md) | | [optional] |
1634
- | **tag_names** | [**Array&lt;String&gt;**](String.md) | | [optional] |
1635
- | **release_date** | **Time** | | [optional] |
1636
- | **primary_mood_cluster** | **String** | | [optional] |
1637
- | **secondary_mood_cluster** | **String** | | [optional] |
1638
- | **tertiary_mood_cluster** | **String** | | [optional] |
1639
- | **valence** | **String** | | [optional] |
1640
- | **arousal** | **String** | | [optional] |
1641
- | **pleasantness** | **String** | | [optional] |
1642
- | **engagement** | **String** | | [optional] |
1643
- | **vocals** | **String** | | [optional] |
1644
- | **dominant_instrument** | **String** | | [optional] |
1645
- | **secondary_instrument** | **String** | | [optional] |
1646
- | **tertiary_instrument** | **String** | | [optional] |
1647
- | **energy** | **String** | | [optional] |
1648
- | **sound_generation** | **String** | | [optional] |
1649
- | **tempo** | **String** | | [optional] |
1650
- | **scale** | **String** | | [optional] |
1651
- | **rhythm** | **String** | | [optional] |
1652
- | **primary_sound_character** | **String** | | [optional] |
1653
- | **timbre** | **String** | | [optional] |
1654
- | **roughness** | **String** | | [optional] |
1655
- | **tonality** | **String** | | [optional] |
1656
- | **harmony** | **String** | | [optional] |
1657
- | **texture** | **String** | | [optional] |
1658
- | **groovyness** | **String** | | [optional] |
1659
- | **space** | **String** | | [optional] |
1660
- | **production_rating** | **String** | | [optional] |
1661
- | **performance_rating** | **String** | | [optional] |
1662
- | **song_rating** | **String** | | [optional] |
1663
- | **audience_age** | **String** | | [optional] |
1664
- | **audience_region** | **String** | | [optional] |
1665
- | **audience_gender** | **String** | | [optional] |
1666
- | **songtradr_track_id** | **String** | | [optional] |
1667
- | **usage_name** | **String** | | [optional] |
1668
- | **bpm_min** | **Integer** | | [optional] |
1669
- | **bpm_max** | **Integer** | | [optional] |
1670
- | **name** | **String** | | [optional] |
1671
- | **folder** | **String** | | [optional] |
1672
- | **extension** | **String** | | [optional] |
1673
- | **upload_end_time** | **Time** | | [optional] |
1674
- | **min_upload_end_time** | **Time** | | [optional] |
1675
- | **max_upload_end_time** | **Time** | | [optional] |
1676
- | **fingerprint_status** | **String** | | [optional] |
1677
- | **inference_status** | **String** | | [optional] |
1678
- | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
1679
- | **size** | **Integer** | The size of the page to be returned | [optional][default to 100] |
1680
- | **sort** | [**Array&lt;String&gt;**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
1681
-
1682
- ### Return type
1683
-
1684
- [**Array&lt;FileMinimalWithUrlDTO&gt;**](FileMinimalWithUrlDTO.md)
1685
-
1686
- ### Authorization
1687
-
1688
- [bearer-jwt](../README.md#bearer-jwt)
1689
-
1690
- ### HTTP request headers
1691
-
1692
- - **Content-Type**: Not defined
1693
- - **Accept**: application/json
1694
-
1695
-
1696
1386
  ## user_files_status
1697
1387
 
1698
1388
  > <Array<FileSmallDTO>> user_files_status(object_keys)
@@ -1803,6 +1493,7 @@ opts = {
1803
1493
  sound_generation: 'acoustic', # String |
1804
1494
  tempo: 'very slow', # String |
1805
1495
  scale: 'major key', # String |
1496
+ key: 'C', # String |
1806
1497
  rhythm: 'common time', # String |
1807
1498
  primary_sound_character: 'aggressive', # String |
1808
1499
  timbre: 'very warm', # String |
@@ -1892,6 +1583,7 @@ end
1892
1583
  | **sound_generation** | **String** | | [optional] |
1893
1584
  | **tempo** | **String** | | [optional] |
1894
1585
  | **scale** | **String** | | [optional] |
1586
+ | **key** | **String** | | [optional] |
1895
1587
  | **rhythm** | **String** | | [optional] |
1896
1588
  | **primary_sound_character** | **String** | | [optional] |
1897
1589
  | **timbre** | **String** | | [optional] |
@@ -1938,143 +1630,3 @@ end
1938
1630
  - **Content-Type**: Not defined
1939
1631
  - **Accept**: application/json
1940
1632
 
1941
-
1942
- ## user_folders
1943
-
1944
- > Array&lt;String&gt; user_folders(opts)
1945
-
1946
- Your Folders
1947
-
1948
- ### Examples
1949
-
1950
- ```ruby
1951
- require 'time'
1952
- require 'songtradr_api_client_ruby'
1953
- # setup authorization
1954
- SongtradrApiClientRuby.configure do |config|
1955
- # Configure Bearer authorization (JWT): bearer-jwt
1956
- config.access_token = 'YOUR_BEARER_TOKEN'
1957
- end
1958
-
1959
- api_instance = SongtradrApiClientRuby::UserApi.new
1960
- opts = {
1961
- page: 56, # Integer | Zero-based page index (0..N)
1962
- size: 56, # Integer | The size of the page to be returned
1963
- sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
1964
- }
1965
-
1966
- begin
1967
- # Your Folders
1968
- result = api_instance.user_folders(opts)
1969
- p result
1970
- rescue SongtradrApiClientRuby::ApiError => e
1971
- puts "Error when calling UserApi->user_folders: #{e}"
1972
- end
1973
- ```
1974
-
1975
- #### Using the user_folders_with_http_info variant
1976
-
1977
- This returns an Array which contains the response data, status code and headers.
1978
-
1979
- > <Array(Array&lt;String&gt;, Integer, Hash)> user_folders_with_http_info(opts)
1980
-
1981
- ```ruby
1982
- begin
1983
- # Your Folders
1984
- data, status_code, headers = api_instance.user_folders_with_http_info(opts)
1985
- p status_code # => 2xx
1986
- p headers # => { ... }
1987
- p data # => Array&lt;String&gt;
1988
- rescue SongtradrApiClientRuby::ApiError => e
1989
- puts "Error when calling UserApi->user_folders_with_http_info: #{e}"
1990
- end
1991
- ```
1992
-
1993
- ### Parameters
1994
-
1995
- | Name | Type | Description | Notes |
1996
- | ---- | ---- | ----------- | ----- |
1997
- | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
1998
- | **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
1999
- | **sort** | [**Array&lt;String&gt;**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
2000
-
2001
- ### Return type
2002
-
2003
- **Array&lt;String&gt;**
2004
-
2005
- ### Authorization
2006
-
2007
- [bearer-jwt](../README.md#bearer-jwt)
2008
-
2009
- ### HTTP request headers
2010
-
2011
- - **Content-Type**: Not defined
2012
- - **Accept**: application/json
2013
-
2014
-
2015
- ## user_referrers
2016
-
2017
- > Array&lt;String&gt; user_referrers(username)
2018
-
2019
-
2020
-
2021
- ### Examples
2022
-
2023
- ```ruby
2024
- require 'time'
2025
- require 'songtradr_api_client_ruby'
2026
- # setup authorization
2027
- SongtradrApiClientRuby.configure do |config|
2028
- # Configure Bearer authorization (JWT): bearer-jwt
2029
- config.access_token = 'YOUR_BEARER_TOKEN'
2030
- end
2031
-
2032
- api_instance = SongtradrApiClientRuby::UserApi.new
2033
- username = 'username_example' # String |
2034
-
2035
- begin
2036
-
2037
- result = api_instance.user_referrers(username)
2038
- p result
2039
- rescue SongtradrApiClientRuby::ApiError => e
2040
- puts "Error when calling UserApi->user_referrers: #{e}"
2041
- end
2042
- ```
2043
-
2044
- #### Using the user_referrers_with_http_info variant
2045
-
2046
- This returns an Array which contains the response data, status code and headers.
2047
-
2048
- > <Array(Array&lt;String&gt;, Integer, Hash)> user_referrers_with_http_info(username)
2049
-
2050
- ```ruby
2051
- begin
2052
-
2053
- data, status_code, headers = api_instance.user_referrers_with_http_info(username)
2054
- p status_code # => 2xx
2055
- p headers # => { ... }
2056
- p data # => Array&lt;String&gt;
2057
- rescue SongtradrApiClientRuby::ApiError => e
2058
- puts "Error when calling UserApi->user_referrers_with_http_info: #{e}"
2059
- end
2060
- ```
2061
-
2062
- ### Parameters
2063
-
2064
- | Name | Type | Description | Notes |
2065
- | ---- | ---- | ----------- | ----- |
2066
- | **username** | **String** | | |
2067
-
2068
- ### Return type
2069
-
2070
- **Array&lt;String&gt;**
2071
-
2072
- ### Authorization
2073
-
2074
- [bearer-jwt](../README.md#bearer-jwt)
2075
-
2076
- ### HTTP request headers
2077
-
2078
- - **Content-Type**: Not defined
2079
- - **Accept**: application/json
2080
-
@@ -3,10 +3,10 @@
3
3
 
4
4
  #This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
5
5
 
6
- The version of the OpenAPI document: 1.13.7
6
+ The version of the OpenAPI document: 1.16.0
7
7
  Contact: info@songtradr.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.2.0-SNAPSHOT
10
10
 
11
11
  =end
12
12