songtradr_api_client_ruby 1.17.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +24 -22
  3. data/README.md +7 -9
  4. data/docs/CategoryMediumDTO.md +3 -3
  5. data/docs/MusicalFeaturesDTO.md +97 -93
  6. data/docs/RecordingApi.md +71 -1
  7. data/docs/RecordingMediumDTO.md +4 -4
  8. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
  9. data/docs/RecordingPartyDTO.md +3 -3
  10. data/docs/RecordingSmallDTO.md +2 -2
  11. data/docs/SearchFilterValuesDTO.md +2 -0
  12. data/docs/UserApi.md +67 -187
  13. data/docs/UserDTO.md +2 -0
  14. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
  15. data/lib/songtradr_api_client_ruby/api/recording_api.rb +74 -5
  16. data/lib/songtradr_api_client_ruby/api/user_api.rb +86 -403
  17. data/lib/songtradr_api_client_ruby/api_client.rb +5 -4
  18. data/lib/songtradr_api_client_ruby/api_error.rb +2 -2
  19. data/lib/songtradr_api_client_ruby/configuration.rb +2 -2
  20. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +17 -17
  21. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
  22. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
  23. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
  24. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
  25. data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
  26. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
  27. data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
  28. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
  29. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +2 -2
  30. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
  31. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
  32. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
  33. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
  34. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
  35. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
  36. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
  37. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +2 -2
  38. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
  39. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
  40. data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
  41. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +610 -579
  42. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
  43. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
  44. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +2 -2
  45. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
  46. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +32 -32
  47. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +17 -17
  48. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
  49. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
  50. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +17 -17
  51. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +14 -14
  52. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
  53. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
  54. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +21 -3
  55. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +2 -2
  56. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
  57. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
  58. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
  59. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
  60. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
  61. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
  62. data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
  63. data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
  64. data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
  65. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
  66. data/lib/songtradr_api_client_ruby/models/user_dto.rb +19 -3
  67. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +2 -2
  68. data/lib/songtradr_api_client_ruby/version.rb +3 -3
  69. data/lib/songtradr_api_client_ruby.rb +2 -5
  70. data/openapi-generator-config.yaml +1 -1
  71. data/songtradr_api_client_ruby.gemspec +3 -2
  72. data/spec/api/allowed_values_api_spec.rb +2 -2
  73. data/spec/api/recording_api_spec.rb +14 -2
  74. data/spec/api/user_api_spec.rb +15 -74
  75. data/spec/models/category_medium_dto_spec.rb +4 -4
  76. data/spec/models/category_minimal_dto_spec.rb +2 -2
  77. data/spec/models/config_access_dto_spec.rb +2 -2
  78. data/spec/models/config_identifier_dto_spec.rb +2 -2
  79. data/spec/models/contributor_type_dto_spec.rb +2 -2
  80. data/spec/models/error_response_spec.rb +2 -2
  81. data/spec/models/field_summary_dto_spec.rb +2 -2
  82. data/spec/models/file_dto_spec.rb +2 -2
  83. data/spec/models/file_list_dto_spec.rb +2 -2
  84. data/spec/models/file_small_dto_spec.rb +2 -2
  85. data/spec/models/file_upload_dto_spec.rb +2 -2
  86. data/spec/models/file_w_ith_url_dto_spec.rb +2 -2
  87. data/spec/models/files_summary_dto_spec.rb +2 -2
  88. data/spec/models/forgot_password_dto_spec.rb +2 -2
  89. data/spec/models/genre_dto_spec.rb +2 -2
  90. data/spec/models/genre_minimal_dto_spec.rb +2 -2
  91. data/spec/models/genres_summary_dto_spec.rb +2 -2
  92. data/spec/models/image_recognition_response_spec.rb +2 -2
  93. data/spec/models/init_put_recording_audio_dto_spec.rb +2 -2
  94. data/spec/models/jwt_token_dto_spec.rb +2 -2
  95. data/spec/models/login_dto_spec.rb +2 -2
  96. data/spec/models/musical_features_dto_spec.rb +204 -188
  97. data/spec/models/party_small_dto_spec.rb +2 -2
  98. data/spec/models/recording_for_similarity_search_dto_spec.rb +2 -2
  99. data/spec/models/recording_genre_prediction_dto_spec.rb +2 -2
  100. data/spec/models/recording_list_dto_spec.rb +2 -2
  101. data/spec/models/recording_medium_dto_spec.rb +5 -5
  102. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +4 -4
  103. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +2 -2
  104. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +2 -2
  105. data/spec/models/recording_party_dto_spec.rb +4 -4
  106. data/spec/models/recording_small_dto_spec.rb +5 -5
  107. data/spec/models/recording_tag_small_dto_spec.rb +2 -2
  108. data/spec/models/save_user_dto_spec.rb +2 -2
  109. data/spec/models/search_filter_values_dto_spec.rb +8 -2
  110. data/spec/models/search_recording_granular_dto_spec.rb +2 -2
  111. data/spec/models/sign_up_dto_spec.rb +2 -2
  112. data/spec/models/tag_dto_spec.rb +2 -2
  113. data/spec/models/tag_small_dto_spec.rb +2 -2
  114. data/spec/models/taggram_dto_spec.rb +2 -2
  115. data/spec/models/tags_summary_dto_spec.rb +2 -2
  116. data/spec/models/tagstrength_dto_spec.rb +2 -2
  117. data/spec/models/title_dto_spec.rb +2 -2
  118. data/spec/models/token_request_spec.rb +2 -2
  119. data/spec/models/track_dto_spec.rb +2 -2
  120. data/spec/models/update_password_dto_spec.rb +2 -2
  121. data/spec/models/user_dto_spec.rb +8 -2
  122. data/spec/models/video_recognition_response_spec.rb +2 -2
  123. data/spec/spec_helper.rb +2 -2
  124. metadata +56 -54
  125. data/docs/CuratePlaylistDTO.md +0 -26
  126. data/docs/CuratePlaylistResponseDTO.md +0 -18
  127. data/docs/PlaylistApi.md +0 -77
  128. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +0 -99
  129. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +0 -256
  130. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +0 -216
  131. data/spec/api/playlist_api_spec.rb +0 -47
  132. data/spec/models/curate_playlist_dto_spec.rb +0 -60
  133. data/spec/models/curate_playlist_response_dto_spec.rb +0 -36
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 27fd7c5e52e178be8eeab432fc7712828524df6b08e46ae9b4794ff02698fea0
4
- data.tar.gz: dc4e3ed9da82140d2241cfba93a659dd53d2bc132584dc802044a85b53f7c557
3
+ metadata.gz: 51ee6271c8b5db9f7941e4b057b6caed6d0514ac530a5a797afc5a08715fded6
4
+ data.tar.gz: 68044e684b4de9d682bca1eb57ad4aaab118f04318bb46fe0906f35e7e9fc766
5
5
  SHA512:
6
- metadata.gz: bf8e3579006330b20f00fee4c18e9bb573eed2e66bf4bad68f5967060717965939ca70232a9ea488c5a9ac988e1bc6884c4fdd4fb7398f03fb854e6b118a9dc3
7
- data.tar.gz: 7be09dcbf79d5a9e7e0dc429d813bf0e94720899ed72f34f0873123124fe8776d48d4556bd20873863669851f7ec440a0ebbfdaf16c21bcbfe6f1d299a2b4f67
6
+ metadata.gz: 7a11c2193ddb4599190909ee94c4bf0f1583bd7098b49b22252adda7553ec13f22f34314be0441412e4993073800ce0e075f2dea281f014c9d00cf7e19346e43
7
+ data.tar.gz: c375c42065a08bdc37b785a81cfd577d5b23f0b9670259e0df2ecf7e1641229dce2679e241aa409aa39351e8ce6e7eec9e5fa78a58fc6342fcf62857570f466b
data/Gemfile.lock CHANGED
@@ -1,30 +1,31 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- songtradr_api_client_ruby (1.17.0)
4
+ songtradr_api_client_ruby (1.18.0)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
+ ruby-filemagic
7
8
 
8
9
  GEM
9
10
  remote: https://rubygems.org/
10
11
  specs:
11
12
  ast (2.4.2)
12
- base64 (0.2.0)
13
13
  byebug (11.1.3)
14
14
  coderay (1.1.3)
15
- diff-lcs (1.5.0)
16
- faraday (2.8.1)
17
- base64
18
- faraday-net_http (>= 2.0, < 3.1)
19
- ruby2_keywords (>= 0.0.4)
15
+ diff-lcs (1.5.1)
16
+ faraday (2.9.0)
17
+ faraday-net_http (>= 2.0, < 3.2)
20
18
  faraday-multipart (1.0.4)
21
19
  multipart-post (~> 2)
22
- faraday-net_http (3.0.2)
20
+ faraday-net_http (3.1.0)
21
+ net-http
23
22
  jaro_winkler (1.5.6)
24
23
  method_source (1.0.0)
25
- multipart-post (2.3.0)
24
+ multipart-post (2.4.0)
25
+ net-http (0.4.1)
26
+ uri
26
27
  parallel (1.24.0)
27
- parser (3.3.0.2)
28
+ parser (3.3.0.5)
28
29
  ast (~> 2.4.1)
29
30
  racc
30
31
  pry (0.14.2)
@@ -38,19 +39,19 @@ GEM
38
39
  racc (1.7.3)
39
40
  rainbow (3.1.1)
40
41
  rake (13.0.6)
41
- rspec (3.12.0)
42
- rspec-core (~> 3.12.0)
43
- rspec-expectations (~> 3.12.0)
44
- rspec-mocks (~> 3.12.0)
45
- rspec-core (3.12.2)
46
- rspec-support (~> 3.12.0)
47
- rspec-expectations (3.12.3)
42
+ rspec (3.13.0)
43
+ rspec-core (~> 3.13.0)
44
+ rspec-expectations (~> 3.13.0)
45
+ rspec-mocks (~> 3.13.0)
46
+ rspec-core (3.13.0)
47
+ rspec-support (~> 3.13.0)
48
+ rspec-expectations (3.13.0)
48
49
  diff-lcs (>= 1.2.0, < 2.0)
49
- rspec-support (~> 3.12.0)
50
- rspec-mocks (3.12.6)
50
+ rspec-support (~> 3.13.0)
51
+ rspec-mocks (3.13.0)
51
52
  diff-lcs (>= 1.2.0, < 2.0)
52
- rspec-support (~> 3.12.0)
53
- rspec-support (3.12.1)
53
+ rspec-support (~> 3.13.0)
54
+ rspec-support (3.13.0)
54
55
  rubocop (0.66.0)
55
56
  jaro_winkler (~> 1.5.1)
56
57
  parallel (~> 1.10)
@@ -59,10 +60,11 @@ GEM
59
60
  rainbow (>= 2.2.2, < 4.0)
60
61
  ruby-progressbar (~> 1.7)
61
62
  unicode-display_width (>= 1.4.0, < 1.6)
63
+ ruby-filemagic (0.7.3)
62
64
  ruby-progressbar (1.13.0)
63
- ruby2_keywords (0.0.5)
64
65
  stringio (3.1.0)
65
66
  unicode-display_width (1.5.0)
67
+ uri (0.13.0)
66
68
 
67
69
  PLATFORMS
68
70
  x86_64-linux
data/README.md CHANGED
@@ -33,8 +33,8 @@ You can either search the released music via the /public/recording endpoints or
33
33
 
34
34
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
35
35
 
36
- - API version: 1.17.0
37
- - Package version: 1.17.0
36
+ - API version: 1.18.0
37
+ - Package version: 1.18.0
38
38
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
39
39
  For more information, please visit [https://songtradr.com](https://songtradr.com)
40
40
 
@@ -51,16 +51,16 @@ gem build songtradr_api_client_ruby.gemspec
51
51
  Then either install the gem locally:
52
52
 
53
53
  ```shell
54
- gem install ./songtradr_api_client_ruby-1.17.0.gem
54
+ gem install ./songtradr_api_client_ruby-1.18.0.gem
55
55
  ```
56
56
 
57
- (for development, run `gem install --dev ./songtradr_api_client_ruby-1.17.0.gem` to install the development dependencies)
57
+ (for development, run `gem install --dev ./songtradr_api_client_ruby-1.18.0.gem` to install the development dependencies)
58
58
 
59
59
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
60
60
 
61
61
  Finally add this to the Gemfile:
62
62
 
63
- gem 'songtradr_api_client_ruby', '~> 1.17.0'
63
+ gem 'songtradr_api_client_ruby', '~> 1.18.0'
64
64
 
65
65
  ### Install from Git
66
66
 
@@ -108,7 +108,7 @@ Class | Method | HTTP request | Description
108
108
  *SongtradrApiClientRuby::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
109
  *SongtradrApiClientRuby::AllowedValuesApi* | [**genres**](docs/AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres.
110
110
  *SongtradrApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
111
- *SongtradrApiClientRuby::PlaylistApi* | [**curate_playlist**](docs/PlaylistApi.md#curate_playlist) | **POST** /api/v1/playlist/{methodName} | Curate playlist.
111
+ *SongtradrApiClientRuby::RecordingApi* | [**prompt_search_recordings**](docs/RecordingApi.md#prompt_search_recordings) | **GET** /api/v1/public/recording/promptSearch | Recordings for query.
112
112
  *SongtradrApiClientRuby::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.
113
113
  *SongtradrApiClientRuby::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.
114
114
  *SongtradrApiClientRuby::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.
@@ -124,9 +124,9 @@ Class | Method | HTTP request | Description
124
124
  *SongtradrApiClientRuby::UserApi* | [**initiate_user_image_upload**](docs/UserApi.md#initiate_user_image_upload) | **POST** /api/v1/user/file/{name}/initImageUpload | Recognise and upload image. Responds with an object with recognition result.
125
125
  *SongtradrApiClientRuby::UserApi* | [**login**](docs/UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token.
126
126
  *SongtradrApiClientRuby::UserApi* | [**me**](docs/UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user
127
+ *SongtradrApiClientRuby::UserApi* | [**prompt_search_user_files**](docs/UserApi.md#prompt_search_user_files) | **GET** /api/v1/user/promptSearch | Files for query.
127
128
  *SongtradrApiClientRuby::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.
128
129
  *SongtradrApiClientRuby::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.
129
- *SongtradrApiClientRuby::UserApi* | [**save_playlist**](docs/UserApi.md#save_playlist) | **POST** /api/v1/user/savePlaylist | List, search and create playlist of your own files.
130
130
  *SongtradrApiClientRuby::UserApi* | [**sign_up**](docs/UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user.
131
131
  *SongtradrApiClientRuby::UserApi* | [**token**](docs/UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token
132
132
  *SongtradrApiClientRuby::UserApi* | [**update_password**](docs/UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token
@@ -143,8 +143,6 @@ Class | Method | HTTP request | Description
143
143
  - [SongtradrApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
144
144
  - [SongtradrApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
145
145
  - [SongtradrApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
146
- - [SongtradrApiClientRuby::CuratePlaylistDTO](docs/CuratePlaylistDTO.md)
147
- - [SongtradrApiClientRuby::CuratePlaylistResponseDTO](docs/CuratePlaylistResponseDTO.md)
148
146
  - [SongtradrApiClientRuby::ErrorResponse](docs/ErrorResponse.md)
149
147
  - [SongtradrApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
150
148
  - [SongtradrApiClientRuby::FileDTO](docs/FileDTO.md)
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **Integer** | | |
8
- | **name** | **String** | | |
9
8
  | **tags** | [**Array&lt;TagSmallDTO&gt;**](TagSmallDTO.md) | | [optional] |
9
+ | **name** | **String** | | |
10
10
 
11
11
  ## Example
12
12
 
@@ -15,8 +15,8 @@ require 'songtradr_api_client_ruby'
15
15
 
16
16
  instance = SongtradrApiClientRuby::CategoryMediumDTO.new(
17
17
  id: null,
18
- name: null,
19
- tags: null
18
+ tags: null,
19
+ name: null
20
20
  )
21
21
  ```
22
22
 
@@ -5,14 +5,54 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **space** | **String** | Search for space | [optional] |
8
- | **primary_mood_cluster_affinity** | **Float** | | [optional] |
8
+ | **language_of_performance** | **String** | | [optional] |
9
+ | **arousal** | **String** | Search for an arousal | [optional] |
10
+ | **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
11
+ | **energy** | **String** | Search for energy | [optional] |
12
+ | **engagement** | **String** | Search for an engagement | [optional] |
13
+ | **groovyness** | **String** | Search for groovyness | [optional] |
14
+ | **harmony** | **String** | Search for a degree of harmoniousness | [optional] |
15
+ | **pleasantness** | **String** | Search for pleasantness | [optional] |
16
+ | **primary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
17
+ | **primary_sound_character** | **String** | Search for a sound character | [optional] |
18
+ | **rhythm** | **String** | Search for rhythm | [optional] |
19
+ | **roughness** | **String** | Search for roughness | [optional] |
20
+ | **scale** | **String** | Search for a tonal scale | [optional] |
21
+ | **key** | **String** | Search for a harmonic key | [optional] |
22
+ | **sound_generation** | **String** | Search for type of sound generation | [optional] |
23
+ | **tempo** | **String** | Search for tempo | [optional] |
24
+ | **texture** | **String** | Search for texture | [optional] |
25
+ | **timbre** | **String** | Search for timbre | [optional] |
26
+ | **tonality** | **String** | Search for tonality | [optional] |
27
+ | **valence** | **String** | Search for a valence | [optional] |
28
+ | **vocals** | **String** | Search for a vocal gender or instrumental songs | [optional] |
29
+ | **origin_decade** | **String** | Search for origin decade | [optional] |
30
+ | **curateability** | **String** | Search for curatebility | [optional] |
31
+ | **use_case** | **String** | Search for use case | [optional] |
32
+ | **channel_suitability** | **String** | Search for social media suitability | [optional] |
33
+ | **loudness** | **String** | Search for loudness | [optional] |
9
34
  | **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
35
+ | **secondary_mood_cluster_affinity** | **Float** | | [optional] |
36
+ | **tertiary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
37
+ | **tertiary_mood_cluster_affinity** | **Float** | | [optional] |
38
+ | **vocals_affinity** | **Float** | | [optional] |
39
+ | **dominant_instrument_affinity** | **Float** | | [optional] |
40
+ | **secondary_instrument** | **String** | Search for a dominant instrument | [optional] |
41
+ | **secondary_instrument_affinity** | **Float** | | [optional] |
42
+ | **tertiary_instrument** | **String** | Search for a dominant instrument | [optional] |
43
+ | **tertiary_instrument_affinity** | **Float** | | [optional] |
44
+ | **sound_generation_affinity** | **Float** | | [optional] |
45
+ | **rhythm_affinity** | **Float** | | [optional] |
46
+ | **primary_sound_character_affinity** | **Float** | | [optional] |
47
+ | **tonality_affinity** | **Float** | | [optional] |
48
+ | **bpm** | **Float** | | [optional] |
10
49
  | **production_rating** | **String** | | [optional] |
11
50
  | **production_rating_affinity** | **Float** | | [optional] |
12
51
  | **performance_rating** | **String** | | [optional] |
13
52
  | **performance_rating_affinity** | **Float** | | [optional] |
14
53
  | **song_rating** | **String** | | [optional] |
15
54
  | **song_rating_affinity** | **Float** | | [optional] |
55
+ | **primary_mood_cluster_affinity** | **Float** | | [optional] |
16
56
  | **audience_age** | **String** | | [optional] |
17
57
  | **audience_age_affinity** | **Float** | | [optional] |
18
58
  | **secondary_audience_age** | **String** | | [optional] |
@@ -34,46 +74,14 @@
34
74
  | **use_case_affinity** | **Float** | | [optional] |
35
75
  | **industry_suitability** | **String** | Search for Industry suitability | [optional] |
36
76
  | **industry_suitability_affinity** | **Float** | | [optional] |
37
- | **secondary_mood_cluster_affinity** | **Float** | | [optional] |
38
- | **tertiary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
39
- | **tertiary_mood_cluster_affinity** | **Float** | | [optional] |
40
- | **vocals_affinity** | **Float** | | [optional] |
41
- | **dominant_instrument_affinity** | **Float** | | [optional] |
42
- | **secondary_instrument** | **String** | Search for a dominant instrument | [optional] |
43
- | **secondary_instrument_affinity** | **Float** | | [optional] |
44
- | **tertiary_instrument** | **String** | Search for a dominant instrument | [optional] |
45
- | **tertiary_instrument_affinity** | **Float** | | [optional] |
46
- | **sound_generation_affinity** | **Float** | | [optional] |
47
- | **rhythm_affinity** | **Float** | | [optional] |
48
- | **primary_sound_character_affinity** | **Float** | | [optional] |
49
- | **tonality_affinity** | **Float** | | [optional] |
50
- | **bpm** | **Float** | | [optional] |
51
77
  | **audience_region** | **String** | | [optional] |
52
- | **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
53
- | **energy** | **String** | Search for energy | [optional] |
54
- | **engagement** | **String** | Search for an engagement | [optional] |
55
- | **groovyness** | **String** | Search for groovyness | [optional] |
56
- | **harmony** | **String** | Search for a degree of harmoniousness | [optional] |
57
- | **pleasantness** | **String** | Search for pleasantness | [optional] |
58
- | **primary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
59
- | **primary_sound_character** | **String** | Search for a sound character | [optional] |
60
- | **rhythm** | **String** | Search for rhythm | [optional] |
61
- | **roughness** | **String** | Search for roughness | [optional] |
62
- | **scale** | **String** | Search for a tonal scale | [optional] |
63
- | **key** | **String** | Search for a harmonic key | [optional] |
64
- | **sound_generation** | **String** | Search for type of sound generation | [optional] |
65
- | **tempo** | **String** | Search for tempo | [optional] |
66
- | **texture** | **String** | Search for texture | [optional] |
67
- | **timbre** | **String** | Search for timbre | [optional] |
68
- | **tonality** | **String** | Search for tonality | [optional] |
69
- | **valence** | **String** | Search for a valence | [optional] |
70
- | **vocals** | **String** | Search for a vocal gender or instrumental songs | [optional] |
71
- | **origin_decade** | **String** | Search for origin decade | [optional] |
72
- | **curateability** | **String** | Search for curatebility | [optional] |
73
- | **use_case** | **String** | Search for use case | [optional] |
74
- | **channel_suitability** | **String** | Search for social media suitability | [optional] |
75
- | **language_of_performance** | **String** | | [optional] |
76
- | **arousal** | **String** | Search for an arousal | [optional] |
78
+ | **harmony_affinity** | **Float** | | [optional] |
79
+ | **texture_affinity** | **Float** | | [optional] |
80
+ | **groovyness_affinity** | **Float** | | [optional] |
81
+ | **space_affinity** | **Float** | | [optional] |
82
+ | **loudness_affinity** | **Float** | | [optional] |
83
+ | **key_affinity** | **Float** | | [optional] |
84
+ | **channel_suitability_affinity** | **Float** | | [optional] |
77
85
  | **valence_affinity** | **Float** | | [optional] |
78
86
  | **arousal_affinity** | **Float** | | [optional] |
79
87
  | **pleasantness_affinity** | **Float** | | [optional] |
@@ -83,12 +91,6 @@
83
91
  | **scale_affinity** | **Float** | | [optional] |
84
92
  | **timbre_affinity** | **Float** | | [optional] |
85
93
  | **roughness_affinity** | **Float** | | [optional] |
86
- | **harmony_affinity** | **Float** | | [optional] |
87
- | **texture_affinity** | **Float** | | [optional] |
88
- | **groovyness_affinity** | **Float** | | [optional] |
89
- | **space_affinity** | **Float** | | [optional] |
90
- | **key_affinity** | **Float** | | [optional] |
91
- | **channel_suitability_affinity** | **Float** | | [optional] |
92
94
 
93
95
  ## Example
94
96
 
@@ -97,14 +99,54 @@ require 'songtradr_api_client_ruby'
97
99
 
98
100
  instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
99
101
  space: null,
100
- primary_mood_cluster_affinity: null,
102
+ language_of_performance: null,
103
+ arousal: null,
104
+ dominant_instrument: null,
105
+ energy: null,
106
+ engagement: null,
107
+ groovyness: null,
108
+ harmony: null,
109
+ pleasantness: null,
110
+ primary_mood_cluster: null,
111
+ primary_sound_character: null,
112
+ rhythm: null,
113
+ roughness: null,
114
+ scale: null,
115
+ key: null,
116
+ sound_generation: null,
117
+ tempo: null,
118
+ texture: null,
119
+ timbre: null,
120
+ tonality: null,
121
+ valence: null,
122
+ vocals: null,
123
+ origin_decade: null,
124
+ curateability: null,
125
+ use_case: null,
126
+ channel_suitability: null,
127
+ loudness: null,
101
128
  secondary_mood_cluster: null,
129
+ secondary_mood_cluster_affinity: null,
130
+ tertiary_mood_cluster: null,
131
+ tertiary_mood_cluster_affinity: null,
132
+ vocals_affinity: null,
133
+ dominant_instrument_affinity: null,
134
+ secondary_instrument: null,
135
+ secondary_instrument_affinity: null,
136
+ tertiary_instrument: null,
137
+ tertiary_instrument_affinity: null,
138
+ sound_generation_affinity: null,
139
+ rhythm_affinity: null,
140
+ primary_sound_character_affinity: null,
141
+ tonality_affinity: null,
142
+ bpm: null,
102
143
  production_rating: null,
103
144
  production_rating_affinity: null,
104
145
  performance_rating: null,
105
146
  performance_rating_affinity: null,
106
147
  song_rating: null,
107
148
  song_rating_affinity: null,
149
+ primary_mood_cluster_affinity: null,
108
150
  audience_age: null,
109
151
  audience_age_affinity: null,
110
152
  secondary_audience_age: null,
@@ -126,46 +168,14 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
126
168
  use_case_affinity: null,
127
169
  industry_suitability: null,
128
170
  industry_suitability_affinity: null,
129
- secondary_mood_cluster_affinity: null,
130
- tertiary_mood_cluster: null,
131
- tertiary_mood_cluster_affinity: null,
132
- vocals_affinity: null,
133
- dominant_instrument_affinity: null,
134
- secondary_instrument: null,
135
- secondary_instrument_affinity: null,
136
- tertiary_instrument: null,
137
- tertiary_instrument_affinity: null,
138
- sound_generation_affinity: null,
139
- rhythm_affinity: null,
140
- primary_sound_character_affinity: null,
141
- tonality_affinity: null,
142
- bpm: null,
143
171
  audience_region: null,
144
- dominant_instrument: null,
145
- energy: null,
146
- engagement: null,
147
- groovyness: null,
148
- harmony: null,
149
- pleasantness: null,
150
- primary_mood_cluster: null,
151
- primary_sound_character: null,
152
- rhythm: null,
153
- roughness: null,
154
- scale: null,
155
- key: null,
156
- sound_generation: null,
157
- tempo: null,
158
- texture: null,
159
- timbre: null,
160
- tonality: null,
161
- valence: null,
162
- vocals: null,
163
- origin_decade: null,
164
- curateability: null,
165
- use_case: null,
166
- channel_suitability: null,
167
- language_of_performance: null,
168
- arousal: null,
172
+ harmony_affinity: null,
173
+ texture_affinity: null,
174
+ groovyness_affinity: null,
175
+ space_affinity: null,
176
+ loudness_affinity: null,
177
+ key_affinity: null,
178
+ channel_suitability_affinity: null,
169
179
  valence_affinity: null,
170
180
  arousal_affinity: null,
171
181
  pleasantness_affinity: null,
@@ -174,13 +184,7 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
174
184
  tempo_affinity: null,
175
185
  scale_affinity: null,
176
186
  timbre_affinity: null,
177
- roughness_affinity: null,
178
- harmony_affinity: null,
179
- texture_affinity: null,
180
- groovyness_affinity: null,
181
- space_affinity: null,
182
- key_affinity: null,
183
- channel_suitability_affinity: null
187
+ roughness_affinity: null
184
188
  )
185
189
  ```
186
190
 
data/docs/RecordingApi.md CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.songtradr.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**prompt_search_recordings**](RecordingApi.md#prompt_search_recordings) | **GET** /api/v1/public/recording/promptSearch | Recordings for query. |
7
8
  | [**recordings_by_ids_with_musical_features**](RecordingApi.md#recordings_by_ids_with_musical_features) | **GET** /api/v1/public/recording/{ids}/musicalFeatures | AI generated moods, musical features and more for recordings. |
8
9
  | [**recordings_by_ids_with_similarities**](RecordingApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings. |
9
10
  | [**recordings_by_ids_with_taggrams**](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. |
@@ -13,6 +14,73 @@ All URIs are relative to *https://api.songtradr.com*
13
14
  | [**search_recordings_granular**](RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options. |
14
15
 
15
16
 
17
+ ## prompt_search_recordings
18
+
19
+ > <RecordingListDTO> prompt_search_recordings(query)
20
+
21
+ Recordings for query.
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'songtradr_api_client_ruby'
28
+ # setup authorization
29
+ SongtradrApiClientRuby.configure do |config|
30
+ # Configure Bearer authorization (JWT): bearer-jwt
31
+ config.access_token = 'YOUR_BEARER_TOKEN'
32
+ end
33
+
34
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
35
+ query = 'funk, guitar, drums' # String | Query.
36
+
37
+ begin
38
+ # Recordings for query.
39
+ result = api_instance.prompt_search_recordings(query)
40
+ p result
41
+ rescue SongtradrApiClientRuby::ApiError => e
42
+ puts "Error when calling RecordingApi->prompt_search_recordings: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the prompt_search_recordings_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<RecordingListDTO>, Integer, Hash)> prompt_search_recordings_with_http_info(query)
51
+
52
+ ```ruby
53
+ begin
54
+ # Recordings for query.
55
+ data, status_code, headers = api_instance.prompt_search_recordings_with_http_info(query)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <RecordingListDTO>
59
+ rescue SongtradrApiClientRuby::ApiError => e
60
+ puts "Error when calling RecordingApi->prompt_search_recordings_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **query** | **String** | Query. | |
69
+
70
+ ### Return type
71
+
72
+ [**RecordingListDTO**](RecordingListDTO.md)
73
+
74
+ ### Authorization
75
+
76
+ [bearer-jwt](../README.md#bearer-jwt)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: Not defined
81
+ - **Accept**: application/json
82
+
83
+
16
84
  ## recordings_by_ids_with_musical_features
17
85
 
18
86
  > <Array<RecordingMinimalWithMusicalFeaturesDTO>> recordings_by_ids_with_musical_features(ids)
@@ -417,7 +485,7 @@ opts = {
417
485
  pleasantness: 'very unpleasant', # String | Search for pleasantness.
418
486
  engagement: 'very unengaging', # String | Search for an engagement.
419
487
  vocals: 'instrumental', # String | Search for a vocals gender or instrumental songs.
420
- dominant_instrument: 'electric guitar', # String | Search for a dominant instrument.
488
+ dominant_instrument: 'piano', # String | Search for a dominant instrument.
421
489
  energy: 'very quiet', # String | Search for energy.
422
490
  sound_generation: 'acoustic', # String | Search for type of sound generation.
423
491
  tempo: 'very slow', # String | Search for tempo.
@@ -432,6 +500,7 @@ opts = {
432
500
  texture: 'very thin', # String | Search for texture.
433
501
  groovyness: 'very steady', # String | Search for groovyness.
434
502
  space: 'very compact', # String | Search for space.
503
+ loudness: 'very low', # String | Search for loudness.
435
504
  origin_decade: 'pre-1950s', # String | Search for origin decade.
436
505
  curateability: 'curateable', # String | Search for curateability.
437
506
  use_case: 'background', # String | Search for use case.
@@ -505,6 +574,7 @@ end
505
574
  | **texture** | **String** | Search for texture. | [optional] |
506
575
  | **groovyness** | **String** | Search for groovyness. | [optional] |
507
576
  | **space** | **String** | Search for space. | [optional] |
577
+ | **loudness** | **String** | Search for loudness. | [optional] |
508
578
  | **origin_decade** | **String** | Search for origin decade. | [optional] |
509
579
  | **curateability** | **String** | Search for curateability. | [optional] |
510
580
  | **use_case** | **String** | Search for use case. | [optional] |
@@ -4,14 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **isrc** | **String** | | |
7
+ | **genres** | [**Array&lt;GenreDTO&gt;**](GenreDTO.md) | | [optional] |
8
8
  | **language_of_performance** | **String** | | [optional] |
9
9
  | **release_date** | **Time** | | [optional] |
10
10
  | **titles** | [**Array&lt;TitleDTO&gt;**](TitleDTO.md) | | [optional] |
11
11
  | **tracks** | [**Array&lt;TrackDTO&gt;**](TrackDTO.md) | | [optional] |
12
12
  | **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) | | [optional] |
13
+ | **isrc** | **String** | | |
13
14
  | **recording_party_entities** | [**Array&lt;RecordingPartyDTO&gt;**](RecordingPartyDTO.md) | | [optional] |
14
- | **genres** | [**Array&lt;GenreDTO&gt;**](GenreDTO.md) | | [optional] |
15
15
  | **spotify_id** | **String** | | [optional] |
16
16
  | **tags** | [**Array&lt;RecordingTagSmallDTO&gt;**](RecordingTagSmallDTO.md) | | [optional] |
17
17
  | **genre_predictions** | [**Array&lt;RecordingGenrePredictionDTO&gt;**](RecordingGenrePredictionDTO.md) | | [optional] |
@@ -22,14 +22,14 @@
22
22
  require 'songtradr_api_client_ruby'
23
23
 
24
24
  instance = SongtradrApiClientRuby::RecordingMediumDTO.new(
25
- isrc: null,
25
+ genres: null,
26
26
  language_of_performance: null,
27
27
  release_date: null,
28
28
  titles: null,
29
29
  tracks: null,
30
30
  musical_features: null,
31
+ isrc: null,
31
32
  recording_party_entities: null,
32
- genres: null,
33
33
  spotify_id: null,
34
34
  tags: null,
35
35
  genre_predictions: null
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **isrc** | **String** | | |
8
7
  | **musical_features** | [**Array&lt;MusicalFeaturesDTO&gt;**](MusicalFeaturesDTO.md) | | [optional] |
8
+ | **isrc** | **String** | | |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,8 +13,8 @@
13
13
  require 'songtradr_api_client_ruby'
14
14
 
15
15
  instance = SongtradrApiClientRuby::RecordingMinimalWithMusicalFeaturesDTO.new(
16
- isrc: null,
17
- musical_features: null
16
+ musical_features: null,
17
+ isrc: null
18
18
  )
19
19
  ```
20
20
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **party** | [**PartySmallDTO**](PartySmallDTO.md) | | |
8
7
  | **contributor_types** | [**Array&lt;ContributorTypeDTO&gt;**](ContributorTypeDTO.md) | | [optional] |
8
+ | **party** | [**PartySmallDTO**](PartySmallDTO.md) | | |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,8 +13,8 @@
13
13
  require 'songtradr_api_client_ruby'
14
14
 
15
15
  instance = SongtradrApiClientRuby::RecordingPartyDTO.new(
16
- party: null,
17
- contributor_types: null
16
+ contributor_types: null,
17
+ party: null
18
18
  )
19
19
  ```
20
20
 
@@ -5,9 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **duration** | **Integer** | | [optional] |
8
- | **isrc** | **String** | | |
9
8
  | **titles** | [**Array&lt;TitleDTO&gt;**](TitleDTO.md) | | [optional] |
10
9
  | **tracks** | [**Array&lt;TrackDTO&gt;**](TrackDTO.md) | | [optional] |
10
+ | **isrc** | **String** | | |
11
11
  | **parties** | [**Array&lt;RecordingPartyDTO&gt;**](RecordingPartyDTO.md) | | [optional] |
12
12
 
13
13
  ## Example
@@ -17,9 +17,9 @@ require 'songtradr_api_client_ruby'
17
17
 
18
18
  instance = SongtradrApiClientRuby::RecordingSmallDTO.new(
19
19
  duration: null,
20
- isrc: null,
21
20
  titles: null,
22
21
  tracks: null,
22
+ isrc: null,
23
23
  parties: null
24
24
  )
25
25
  ```
@@ -29,6 +29,7 @@
29
29
  | **texture** | **Array&lt;String&gt;** | | |
30
30
  | **groovyness** | **Array&lt;String&gt;** | | |
31
31
  | **space** | **Array&lt;String&gt;** | | |
32
+ | **loudness** | **Array&lt;String&gt;** | | |
32
33
  | **production_rating** | **Array&lt;String&gt;** | | |
33
34
  | **performance_rating** | **Array&lt;String&gt;** | | |
34
35
  | **song_rating** | **Array&lt;String&gt;** | | |
@@ -77,6 +78,7 @@ instance = SongtradrApiClientRuby::SearchFilterValuesDTO.new(
77
78
  texture: null,
78
79
  groovyness: null,
79
80
  space: null,
81
+ loudness: null,
80
82
  production_rating: null,
81
83
  performance_rating: null,
82
84
  song_rating: null,