songtradr_api_client_ruby 1.17.0 → 2.0.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +24 -22
- data/README.md +7 -11
- data/docs/FileSmallDTO.md +2 -2
- data/docs/MusicalFeaturesDTO.md +113 -109
- data/docs/RecordingApi.md +71 -69
- data/docs/RecordingMediumDTO.md +2 -2
- data/docs/SearchFilterValuesDTO.md +2 -0
- data/docs/UserApi.md +67 -187
- data/docs/UserDTO.md +2 -0
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +74 -71
- data/lib/songtradr_api_client_ruby/api/user_api.rb +86 -403
- data/lib/songtradr_api_client_ruby/api_client.rb +5 -4
- data/lib/songtradr_api_client_ruby/api_error.rb +2 -2
- data/lib/songtradr_api_client_ruby/configuration.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +14 -14
- data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +662 -631
- data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +24 -24
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +21 -3
- data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/user_dto.rb +19 -3
- data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/version.rb +3 -3
- data/lib/songtradr_api_client_ruby.rb +2 -6
- data/openapi-generator-config.yaml +1 -1
- data/songtradr_api_client_ruby.gemspec +3 -2
- data/spec/api/allowed_values_api_spec.rb +2 -2
- data/spec/api/recording_api_spec.rb +14 -13
- data/spec/api/user_api_spec.rb +15 -74
- data/spec/models/category_medium_dto_spec.rb +2 -2
- data/spec/models/category_minimal_dto_spec.rb +2 -2
- data/spec/models/config_access_dto_spec.rb +2 -2
- data/spec/models/config_identifier_dto_spec.rb +2 -2
- data/spec/models/contributor_type_dto_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/field_summary_dto_spec.rb +2 -2
- data/spec/models/file_dto_spec.rb +2 -2
- data/spec/models/file_list_dto_spec.rb +2 -2
- data/spec/models/file_small_dto_spec.rb +10 -10
- data/spec/models/file_upload_dto_spec.rb +2 -2
- data/spec/models/file_w_ith_url_dto_spec.rb +2 -2
- data/spec/models/files_summary_dto_spec.rb +2 -2
- data/spec/models/forgot_password_dto_spec.rb +2 -2
- data/spec/models/genre_dto_spec.rb +2 -2
- data/spec/models/genre_minimal_dto_spec.rb +2 -2
- data/spec/models/genres_summary_dto_spec.rb +2 -2
- data/spec/models/image_recognition_response_spec.rb +2 -2
- data/spec/models/init_put_recording_audio_dto_spec.rb +2 -2
- data/spec/models/jwt_token_dto_spec.rb +2 -2
- data/spec/models/login_dto_spec.rb +2 -2
- data/spec/models/musical_features_dto_spec.rb +230 -214
- data/spec/models/party_small_dto_spec.rb +2 -2
- data/spec/models/recording_for_similarity_search_dto_spec.rb +2 -2
- data/spec/models/recording_genre_prediction_dto_spec.rb +2 -2
- data/spec/models/recording_list_dto_spec.rb +2 -2
- data/spec/models/recording_medium_dto_spec.rb +8 -8
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +2 -2
- data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +2 -2
- data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +2 -2
- data/spec/models/recording_party_dto_spec.rb +2 -2
- data/spec/models/recording_small_dto_spec.rb +2 -2
- data/spec/models/recording_tag_small_dto_spec.rb +2 -2
- data/spec/models/save_user_dto_spec.rb +2 -2
- data/spec/models/search_filter_values_dto_spec.rb +8 -2
- data/spec/models/sign_up_dto_spec.rb +2 -2
- data/spec/models/tag_dto_spec.rb +2 -2
- data/spec/models/tag_small_dto_spec.rb +2 -2
- data/spec/models/taggram_dto_spec.rb +2 -2
- data/spec/models/tags_summary_dto_spec.rb +2 -2
- data/spec/models/tagstrength_dto_spec.rb +2 -2
- data/spec/models/title_dto_spec.rb +2 -2
- data/spec/models/token_request_spec.rb +2 -2
- data/spec/models/track_dto_spec.rb +2 -2
- data/spec/models/update_password_dto_spec.rb +2 -2
- data/spec/models/user_dto_spec.rb +8 -2
- data/spec/models/video_recognition_response_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +55 -57
- data/docs/CuratePlaylistDTO.md +0 -26
- data/docs/CuratePlaylistResponseDTO.md +0 -18
- data/docs/PlaylistApi.md +0 -77
- data/docs/SearchRecordingGranularDTO.md +0 -20
- data/lib/songtradr_api_client_ruby/api/playlist_api.rb +0 -99
- data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +0 -256
- data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +0 -216
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +0 -232
- data/spec/api/playlist_api_spec.rb +0 -47
- data/spec/models/curate_playlist_dto_spec.rb +0 -60
- data/spec/models/curate_playlist_response_dto_spec.rb +0 -36
- data/spec/models/search_recording_granular_dto_spec.rb +0 -42
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0fc64097c42737defa71590310fe6a1c3e4f80109e6c691537ce516333287175
|
|
4
|
+
data.tar.gz: 9d76335a206fe47a3625e6f3b004bce4af9de09c627cc465eeb3feed2fe68071
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 56aa2d5e2ca85b7fd68a67bbbd7dd124845fcac1643a8a1ddd8c0a4998f666168173177bb347176c9a719322319816d685dcd24d952bd32e727ad6409bbd5b91
|
|
7
|
+
data.tar.gz: 42f0b87da11d80bc35493b07cf381f78912ac954fc9b2a3a170b262d93a5d06ef75543c9e419e64ebec24777ff56f2d28081f98652b26e342a4d884cd2f0ca61
|
data/Gemfile.lock
CHANGED
|
@@ -1,30 +1,31 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
songtradr_api_client_ruby (
|
|
4
|
+
songtradr_api_client_ruby (2.0.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.
|
|
16
|
-
faraday (2.
|
|
17
|
-
|
|
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
|
|
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.
|
|
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.
|
|
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.
|
|
42
|
-
rspec-core (~> 3.
|
|
43
|
-
rspec-expectations (~> 3.
|
|
44
|
-
rspec-mocks (~> 3.
|
|
45
|
-
rspec-core (3.
|
|
46
|
-
rspec-support (~> 3.
|
|
47
|
-
rspec-expectations (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.
|
|
50
|
-
rspec-mocks (3.
|
|
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.
|
|
53
|
-
rspec-support (3.
|
|
53
|
+
rspec-support (~> 3.13.0)
|
|
54
|
+
rspec-support (3.13.1)
|
|
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:
|
|
37
|
-
- Package version:
|
|
36
|
+
- API version: 2.0.0
|
|
37
|
+
- Package version: 2.0.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-
|
|
54
|
+
gem install ./songtradr_api_client_ruby-2.0.0.gem
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
(for development, run `gem install --dev ./songtradr_api_client_ruby-
|
|
57
|
+
(for development, run `gem install --dev ./songtradr_api_client_ruby-2.0.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', '~>
|
|
63
|
+
gem 'songtradr_api_client_ruby', '~> 2.0.0'
|
|
64
64
|
|
|
65
65
|
### Install from Git
|
|
66
66
|
|
|
@@ -108,14 +108,13 @@ 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::
|
|
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.
|
|
115
115
|
*SongtradrApiClientRuby::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.
|
|
116
116
|
*SongtradrApiClientRuby::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.
|
|
117
117
|
*SongtradrApiClientRuby::RecordingApi* | [**search_recordings**](docs/RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more.
|
|
118
|
-
*SongtradrApiClientRuby::RecordingApi* | [**search_recordings_granular**](docs/RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options.
|
|
119
118
|
*SongtradrApiClientRuby::UserApi* | [**delete_user_file**](docs/UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file.
|
|
120
119
|
*SongtradrApiClientRuby::UserApi* | [**edit_me**](docs/UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user
|
|
121
120
|
*SongtradrApiClientRuby::UserApi* | [**forgot_password**](docs/UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email
|
|
@@ -124,9 +123,9 @@ Class | Method | HTTP request | Description
|
|
|
124
123
|
*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
124
|
*SongtradrApiClientRuby::UserApi* | [**login**](docs/UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token.
|
|
126
125
|
*SongtradrApiClientRuby::UserApi* | [**me**](docs/UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user
|
|
126
|
+
*SongtradrApiClientRuby::UserApi* | [**prompt_search_user_files**](docs/UserApi.md#prompt_search_user_files) | **GET** /api/v1/user/promptSearch | Files for query.
|
|
127
127
|
*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
128
|
*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
129
|
*SongtradrApiClientRuby::UserApi* | [**sign_up**](docs/UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user.
|
|
131
130
|
*SongtradrApiClientRuby::UserApi* | [**token**](docs/UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token
|
|
132
131
|
*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 +142,6 @@ Class | Method | HTTP request | Description
|
|
|
143
142
|
- [SongtradrApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
|
|
144
143
|
- [SongtradrApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
|
|
145
144
|
- [SongtradrApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
|
|
146
|
-
- [SongtradrApiClientRuby::CuratePlaylistDTO](docs/CuratePlaylistDTO.md)
|
|
147
|
-
- [SongtradrApiClientRuby::CuratePlaylistResponseDTO](docs/CuratePlaylistResponseDTO.md)
|
|
148
145
|
- [SongtradrApiClientRuby::ErrorResponse](docs/ErrorResponse.md)
|
|
149
146
|
- [SongtradrApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
|
|
150
147
|
- [SongtradrApiClientRuby::FileDTO](docs/FileDTO.md)
|
|
@@ -175,7 +172,6 @@ Class | Method | HTTP request | Description
|
|
|
175
172
|
- [SongtradrApiClientRuby::RecordingTagSmallDTO](docs/RecordingTagSmallDTO.md)
|
|
176
173
|
- [SongtradrApiClientRuby::SaveUserDTO](docs/SaveUserDTO.md)
|
|
177
174
|
- [SongtradrApiClientRuby::SearchFilterValuesDTO](docs/SearchFilterValuesDTO.md)
|
|
178
|
-
- [SongtradrApiClientRuby::SearchRecordingGranularDTO](docs/SearchRecordingGranularDTO.md)
|
|
179
175
|
- [SongtradrApiClientRuby::SignUpDTO](docs/SignUpDTO.md)
|
|
180
176
|
- [SongtradrApiClientRuby::TagDTO](docs/TagDTO.md)
|
|
181
177
|
- [SongtradrApiClientRuby::TagSmallDTO](docs/TagSmallDTO.md)
|
data/docs/FileSmallDTO.md
CHANGED
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
| **extension** | **String** | extension of the file | |
|
|
10
10
|
| **error_message** | **String** | | [optional] |
|
|
11
11
|
| **folder** | **String** | | |
|
|
12
|
+
| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
|
|
12
13
|
| **object_key** | **String** | | |
|
|
13
14
|
| **upload_start_time** | **Time** | | [optional] |
|
|
14
15
|
| **upload_end_time** | **Time** | | [optional] |
|
|
15
|
-
| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
|
|
16
16
|
| **fingerprint_start_time** | **Time** | | [optional] |
|
|
17
17
|
| **fingerprint_end_time** | **Time** | | [optional] |
|
|
18
18
|
| **inference_status** | **String** | status of the auto-tagging | [optional] |
|
|
@@ -31,10 +31,10 @@ instance = SongtradrApiClientRuby::FileSmallDTO.new(
|
|
|
31
31
|
extension: null,
|
|
32
32
|
error_message: null,
|
|
33
33
|
folder: null,
|
|
34
|
+
fingerprint_status: null,
|
|
34
35
|
object_key: null,
|
|
35
36
|
upload_start_time: null,
|
|
36
37
|
upload_end_time: null,
|
|
37
|
-
fingerprint_status: null,
|
|
38
38
|
fingerprint_start_time: null,
|
|
39
39
|
fingerprint_end_time: null,
|
|
40
40
|
inference_status: null,
|
data/docs/MusicalFeaturesDTO.md
CHANGED
|
@@ -5,8 +5,64 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **space** | **String** | Search for space | [optional] |
|
|
8
|
+
| **arousal** | **String** | Search for an arousal | [optional] |
|
|
9
|
+
| **valence_affinity** | **Float** | | [optional] |
|
|
10
|
+
| **arousal_affinity** | **Float** | | [optional] |
|
|
11
|
+
| **pleasantness_affinity** | **Float** | | [optional] |
|
|
12
|
+
| **engagement_affinity** | **Float** | | [optional] |
|
|
13
|
+
| **energy_affinity** | **Float** | | [optional] |
|
|
14
|
+
| **tempo_affinity** | **Float** | | [optional] |
|
|
15
|
+
| **scale_affinity** | **Float** | | [optional] |
|
|
16
|
+
| **timbre_affinity** | **Float** | | [optional] |
|
|
17
|
+
| **roughness_affinity** | **Float** | | [optional] |
|
|
18
|
+
| **harmony_affinity** | **Float** | | [optional] |
|
|
19
|
+
| **texture_affinity** | **Float** | | [optional] |
|
|
20
|
+
| **groovyness_affinity** | **Float** | | [optional] |
|
|
21
|
+
| **space_affinity** | **Float** | | [optional] |
|
|
22
|
+
| **loudness_affinity** | **Float** | | [optional] |
|
|
23
|
+
| **key_affinity** | **Float** | | [optional] |
|
|
24
|
+
| **channel_suitability_affinity** | **Float** | | [optional] |
|
|
25
|
+
| **language_of_performance** | **String** | | [optional] |
|
|
26
|
+
| **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
|
|
27
|
+
| **energy** | **String** | Search for energy | [optional] |
|
|
28
|
+
| **engagement** | **String** | Search for an engagement | [optional] |
|
|
29
|
+
| **groovyness** | **String** | Search for groovyness | [optional] |
|
|
30
|
+
| **harmony** | **String** | Search for a degree of harmoniousness | [optional] |
|
|
31
|
+
| **pleasantness** | **String** | Search for pleasantness | [optional] |
|
|
32
|
+
| **primary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
|
|
33
|
+
| **primary_sound_character** | **String** | Search for a sound character | [optional] |
|
|
34
|
+
| **rhythm** | **String** | Search for rhythm | [optional] |
|
|
35
|
+
| **roughness** | **String** | Search for roughness | [optional] |
|
|
36
|
+
| **scale** | **String** | Search for a tonal scale | [optional] |
|
|
37
|
+
| **key** | **String** | Search for a harmonic key | [optional] |
|
|
38
|
+
| **sound_generation** | **String** | Search for type of sound generation | [optional] |
|
|
39
|
+
| **tempo** | **String** | Search for tempo | [optional] |
|
|
40
|
+
| **texture** | **String** | Search for texture | [optional] |
|
|
41
|
+
| **timbre** | **String** | Search for timbre | [optional] |
|
|
42
|
+
| **tonality** | **String** | Search for tonality | [optional] |
|
|
43
|
+
| **valence** | **String** | Search for a valence | [optional] |
|
|
44
|
+
| **vocals** | **String** | Search for a vocal gender or instrumental songs | [optional] |
|
|
45
|
+
| **origin_decade** | **String** | Search for origin decade | [optional] |
|
|
46
|
+
| **curateability** | **String** | Search for curatebility | [optional] |
|
|
47
|
+
| **use_case** | **String** | Search for use case | [optional] |
|
|
48
|
+
| **channel_suitability** | **String** | Search for social media suitability | [optional] |
|
|
49
|
+
| **loudness** | **String** | Search for loudness | [optional] |
|
|
8
50
|
| **primary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
9
51
|
| **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
|
|
52
|
+
| **secondary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
53
|
+
| **tertiary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
|
|
54
|
+
| **tertiary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
55
|
+
| **vocals_affinity** | **Float** | | [optional] |
|
|
56
|
+
| **dominant_instrument_affinity** | **Float** | | [optional] |
|
|
57
|
+
| **secondary_instrument** | **String** | Search for a dominant instrument | [optional] |
|
|
58
|
+
| **secondary_instrument_affinity** | **Float** | | [optional] |
|
|
59
|
+
| **tertiary_instrument** | **String** | Search for a dominant instrument | [optional] |
|
|
60
|
+
| **tertiary_instrument_affinity** | **Float** | | [optional] |
|
|
61
|
+
| **sound_generation_affinity** | **Float** | | [optional] |
|
|
62
|
+
| **rhythm_affinity** | **Float** | | [optional] |
|
|
63
|
+
| **primary_sound_character_affinity** | **Float** | | [optional] |
|
|
64
|
+
| **tonality_affinity** | **Float** | | [optional] |
|
|
65
|
+
| **bpm** | **Float** | | [optional] |
|
|
10
66
|
| **production_rating** | **String** | | [optional] |
|
|
11
67
|
| **production_rating_affinity** | **Float** | | [optional] |
|
|
12
68
|
| **performance_rating** | **String** | | [optional] |
|
|
@@ -34,61 +90,7 @@
|
|
|
34
90
|
| **use_case_affinity** | **Float** | | [optional] |
|
|
35
91
|
| **industry_suitability** | **String** | Search for Industry suitability | [optional] |
|
|
36
92
|
| **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
93
|
| **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] |
|
|
77
|
-
| **valence_affinity** | **Float** | | [optional] |
|
|
78
|
-
| **arousal_affinity** | **Float** | | [optional] |
|
|
79
|
-
| **pleasantness_affinity** | **Float** | | [optional] |
|
|
80
|
-
| **engagement_affinity** | **Float** | | [optional] |
|
|
81
|
-
| **energy_affinity** | **Float** | | [optional] |
|
|
82
|
-
| **tempo_affinity** | **Float** | | [optional] |
|
|
83
|
-
| **scale_affinity** | **Float** | | [optional] |
|
|
84
|
-
| **timbre_affinity** | **Float** | | [optional] |
|
|
85
|
-
| **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,8 +99,64 @@ require 'songtradr_api_client_ruby'
|
|
|
97
99
|
|
|
98
100
|
instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
99
101
|
space: null,
|
|
102
|
+
arousal: null,
|
|
103
|
+
valence_affinity: null,
|
|
104
|
+
arousal_affinity: null,
|
|
105
|
+
pleasantness_affinity: null,
|
|
106
|
+
engagement_affinity: null,
|
|
107
|
+
energy_affinity: null,
|
|
108
|
+
tempo_affinity: null,
|
|
109
|
+
scale_affinity: null,
|
|
110
|
+
timbre_affinity: null,
|
|
111
|
+
roughness_affinity: null,
|
|
112
|
+
harmony_affinity: null,
|
|
113
|
+
texture_affinity: null,
|
|
114
|
+
groovyness_affinity: null,
|
|
115
|
+
space_affinity: null,
|
|
116
|
+
loudness_affinity: null,
|
|
117
|
+
key_affinity: null,
|
|
118
|
+
channel_suitability_affinity: null,
|
|
119
|
+
language_of_performance: null,
|
|
120
|
+
dominant_instrument: null,
|
|
121
|
+
energy: null,
|
|
122
|
+
engagement: null,
|
|
123
|
+
groovyness: null,
|
|
124
|
+
harmony: null,
|
|
125
|
+
pleasantness: null,
|
|
126
|
+
primary_mood_cluster: null,
|
|
127
|
+
primary_sound_character: null,
|
|
128
|
+
rhythm: null,
|
|
129
|
+
roughness: null,
|
|
130
|
+
scale: null,
|
|
131
|
+
key: null,
|
|
132
|
+
sound_generation: null,
|
|
133
|
+
tempo: null,
|
|
134
|
+
texture: null,
|
|
135
|
+
timbre: null,
|
|
136
|
+
tonality: null,
|
|
137
|
+
valence: null,
|
|
138
|
+
vocals: null,
|
|
139
|
+
origin_decade: null,
|
|
140
|
+
curateability: null,
|
|
141
|
+
use_case: null,
|
|
142
|
+
channel_suitability: null,
|
|
143
|
+
loudness: null,
|
|
100
144
|
primary_mood_cluster_affinity: null,
|
|
101
145
|
secondary_mood_cluster: null,
|
|
146
|
+
secondary_mood_cluster_affinity: null,
|
|
147
|
+
tertiary_mood_cluster: null,
|
|
148
|
+
tertiary_mood_cluster_affinity: null,
|
|
149
|
+
vocals_affinity: null,
|
|
150
|
+
dominant_instrument_affinity: null,
|
|
151
|
+
secondary_instrument: null,
|
|
152
|
+
secondary_instrument_affinity: null,
|
|
153
|
+
tertiary_instrument: null,
|
|
154
|
+
tertiary_instrument_affinity: null,
|
|
155
|
+
sound_generation_affinity: null,
|
|
156
|
+
rhythm_affinity: null,
|
|
157
|
+
primary_sound_character_affinity: null,
|
|
158
|
+
tonality_affinity: null,
|
|
159
|
+
bpm: null,
|
|
102
160
|
production_rating: null,
|
|
103
161
|
production_rating_affinity: null,
|
|
104
162
|
performance_rating: null,
|
|
@@ -126,61 +184,7 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
|
126
184
|
use_case_affinity: null,
|
|
127
185
|
industry_suitability: null,
|
|
128
186
|
industry_suitability_affinity: null,
|
|
129
|
-
|
|
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
|
-
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,
|
|
169
|
-
valence_affinity: null,
|
|
170
|
-
arousal_affinity: null,
|
|
171
|
-
pleasantness_affinity: null,
|
|
172
|
-
engagement_affinity: null,
|
|
173
|
-
energy_affinity: null,
|
|
174
|
-
tempo_affinity: null,
|
|
175
|
-
scale_affinity: null,
|
|
176
|
-
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
|
+
audience_region: null
|
|
184
188
|
)
|
|
185
189
|
```
|
|
186
190
|
|
data/docs/RecordingApi.md
CHANGED
|
@@ -4,13 +4,80 @@ 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. |
|
|
10
11
|
| [**recordings_by_ids_with_tagstrengths**](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. |
|
|
11
12
|
| [**recordings_medium_by_ids**](RecordingApi.md#recordings_medium_by_ids) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response. |
|
|
12
13
|
| [**search_recordings**](RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more. |
|
|
13
|
-
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## prompt_search_recordings
|
|
17
|
+
|
|
18
|
+
> <RecordingListDTO> prompt_search_recordings(query)
|
|
19
|
+
|
|
20
|
+
Recordings for query.
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'time'
|
|
26
|
+
require 'songtradr_api_client_ruby'
|
|
27
|
+
# setup authorization
|
|
28
|
+
SongtradrApiClientRuby.configure do |config|
|
|
29
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
30
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = SongtradrApiClientRuby::RecordingApi.new
|
|
34
|
+
query = 'funk, guitar, drums' # String | Query.
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
# Recordings for query.
|
|
38
|
+
result = api_instance.prompt_search_recordings(query)
|
|
39
|
+
p result
|
|
40
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
41
|
+
puts "Error when calling RecordingApi->prompt_search_recordings: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Using the prompt_search_recordings_with_http_info variant
|
|
46
|
+
|
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
|
48
|
+
|
|
49
|
+
> <Array(<RecordingListDTO>, Integer, Hash)> prompt_search_recordings_with_http_info(query)
|
|
50
|
+
|
|
51
|
+
```ruby
|
|
52
|
+
begin
|
|
53
|
+
# Recordings for query.
|
|
54
|
+
data, status_code, headers = api_instance.prompt_search_recordings_with_http_info(query)
|
|
55
|
+
p status_code # => 2xx
|
|
56
|
+
p headers # => { ... }
|
|
57
|
+
p data # => <RecordingListDTO>
|
|
58
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
59
|
+
puts "Error when calling RecordingApi->prompt_search_recordings_with_http_info: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **query** | **String** | Query. | |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**RecordingListDTO**](RecordingListDTO.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: Not defined
|
|
80
|
+
- **Accept**: application/json
|
|
14
81
|
|
|
15
82
|
|
|
16
83
|
## recordings_by_ids_with_musical_features
|
|
@@ -417,7 +484,7 @@ opts = {
|
|
|
417
484
|
pleasantness: 'very unpleasant', # String | Search for pleasantness.
|
|
418
485
|
engagement: 'very unengaging', # String | Search for an engagement.
|
|
419
486
|
vocals: 'instrumental', # String | Search for a vocals gender or instrumental songs.
|
|
420
|
-
dominant_instrument: '
|
|
487
|
+
dominant_instrument: 'piano', # String | Search for a dominant instrument.
|
|
421
488
|
energy: 'very quiet', # String | Search for energy.
|
|
422
489
|
sound_generation: 'acoustic', # String | Search for type of sound generation.
|
|
423
490
|
tempo: 'very slow', # String | Search for tempo.
|
|
@@ -432,6 +499,7 @@ opts = {
|
|
|
432
499
|
texture: 'very thin', # String | Search for texture.
|
|
433
500
|
groovyness: 'very steady', # String | Search for groovyness.
|
|
434
501
|
space: 'very compact', # String | Search for space.
|
|
502
|
+
loudness: 'very low', # String | Search for loudness.
|
|
435
503
|
origin_decade: 'pre-1950s', # String | Search for origin decade.
|
|
436
504
|
curateability: 'curateable', # String | Search for curateability.
|
|
437
505
|
use_case: 'background', # String | Search for use case.
|
|
@@ -505,6 +573,7 @@ end
|
|
|
505
573
|
| **texture** | **String** | Search for texture. | [optional] |
|
|
506
574
|
| **groovyness** | **String** | Search for groovyness. | [optional] |
|
|
507
575
|
| **space** | **String** | Search for space. | [optional] |
|
|
576
|
+
| **loudness** | **String** | Search for loudness. | [optional] |
|
|
508
577
|
| **origin_decade** | **String** | Search for origin decade. | [optional] |
|
|
509
578
|
| **curateability** | **String** | Search for curateability. | [optional] |
|
|
510
579
|
| **use_case** | **String** | Search for use case. | [optional] |
|
|
@@ -530,70 +599,3 @@ end
|
|
|
530
599
|
- **Content-Type**: Not defined
|
|
531
600
|
- **Accept**: application/json
|
|
532
601
|
|
|
533
|
-
|
|
534
|
-
## search_recordings_granular
|
|
535
|
-
|
|
536
|
-
> <RecordingListDTO> search_recordings_granular(search_recording_granular_dto)
|
|
537
|
-
|
|
538
|
-
Recordings by granular search options.
|
|
539
|
-
|
|
540
|
-
### Examples
|
|
541
|
-
|
|
542
|
-
```ruby
|
|
543
|
-
require 'time'
|
|
544
|
-
require 'songtradr_api_client_ruby'
|
|
545
|
-
# setup authorization
|
|
546
|
-
SongtradrApiClientRuby.configure do |config|
|
|
547
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
548
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
549
|
-
end
|
|
550
|
-
|
|
551
|
-
api_instance = SongtradrApiClientRuby::RecordingApi.new
|
|
552
|
-
search_recording_granular_dto = [SongtradrApiClientRuby::SearchRecordingGranularDTO.new({tag_name: 'tag_name_example'})] # Array<SearchRecordingGranularDTO> |
|
|
553
|
-
|
|
554
|
-
begin
|
|
555
|
-
# Recordings by granular search options.
|
|
556
|
-
result = api_instance.search_recordings_granular(search_recording_granular_dto)
|
|
557
|
-
p result
|
|
558
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
559
|
-
puts "Error when calling RecordingApi->search_recordings_granular: #{e}"
|
|
560
|
-
end
|
|
561
|
-
```
|
|
562
|
-
|
|
563
|
-
#### Using the search_recordings_granular_with_http_info variant
|
|
564
|
-
|
|
565
|
-
This returns an Array which contains the response data, status code and headers.
|
|
566
|
-
|
|
567
|
-
> <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_granular_with_http_info(search_recording_granular_dto)
|
|
568
|
-
|
|
569
|
-
```ruby
|
|
570
|
-
begin
|
|
571
|
-
# Recordings by granular search options.
|
|
572
|
-
data, status_code, headers = api_instance.search_recordings_granular_with_http_info(search_recording_granular_dto)
|
|
573
|
-
p status_code # => 2xx
|
|
574
|
-
p headers # => { ... }
|
|
575
|
-
p data # => <RecordingListDTO>
|
|
576
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
577
|
-
puts "Error when calling RecordingApi->search_recordings_granular_with_http_info: #{e}"
|
|
578
|
-
end
|
|
579
|
-
```
|
|
580
|
-
|
|
581
|
-
### Parameters
|
|
582
|
-
|
|
583
|
-
| Name | Type | Description | Notes |
|
|
584
|
-
| ---- | ---- | ----------- | ----- |
|
|
585
|
-
| **search_recording_granular_dto** | [**Array<SearchRecordingGranularDTO>**](SearchRecordingGranularDTO.md) | | |
|
|
586
|
-
|
|
587
|
-
### Return type
|
|
588
|
-
|
|
589
|
-
[**RecordingListDTO**](RecordingListDTO.md)
|
|
590
|
-
|
|
591
|
-
### Authorization
|
|
592
|
-
|
|
593
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
594
|
-
|
|
595
|
-
### HTTP request headers
|
|
596
|
-
|
|
597
|
-
- **Content-Type**: application/json
|
|
598
|
-
- **Accept**: application/json
|
|
599
|
-
|
data/docs/RecordingMediumDTO.md
CHANGED
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **isrc** | **String** | | |
|
|
8
|
+
| **genres** | [**Array<GenreDTO>**](GenreDTO.md) | | [optional] |
|
|
8
9
|
| **language_of_performance** | **String** | | [optional] |
|
|
9
10
|
| **release_date** | **Time** | | [optional] |
|
|
10
11
|
| **titles** | [**Array<TitleDTO>**](TitleDTO.md) | | [optional] |
|
|
11
12
|
| **tracks** | [**Array<TrackDTO>**](TrackDTO.md) | | [optional] |
|
|
12
13
|
| **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) | | [optional] |
|
|
13
14
|
| **recording_party_entities** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) | | [optional] |
|
|
14
|
-
| **genres** | [**Array<GenreDTO>**](GenreDTO.md) | | [optional] |
|
|
15
15
|
| **spotify_id** | **String** | | [optional] |
|
|
16
16
|
| **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) | | [optional] |
|
|
17
17
|
| **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) | | [optional] |
|
|
@@ -23,13 +23,13 @@ require 'songtradr_api_client_ruby'
|
|
|
23
23
|
|
|
24
24
|
instance = SongtradrApiClientRuby::RecordingMediumDTO.new(
|
|
25
25
|
isrc: null,
|
|
26
|
+
genres: null,
|
|
26
27
|
language_of_performance: null,
|
|
27
28
|
release_date: null,
|
|
28
29
|
titles: null,
|
|
29
30
|
tracks: null,
|
|
30
31
|
musical_features: null,
|
|
31
32
|
recording_party_entities: null,
|
|
32
|
-
genres: null,
|
|
33
33
|
spotify_id: null,
|
|
34
34
|
tags: null,
|
|
35
35
|
genre_predictions: null
|
|
@@ -29,6 +29,7 @@
|
|
|
29
29
|
| **texture** | **Array<String>** | | |
|
|
30
30
|
| **groovyness** | **Array<String>** | | |
|
|
31
31
|
| **space** | **Array<String>** | | |
|
|
32
|
+
| **loudness** | **Array<String>** | | |
|
|
32
33
|
| **production_rating** | **Array<String>** | | |
|
|
33
34
|
| **performance_rating** | **Array<String>** | | |
|
|
34
35
|
| **song_rating** | **Array<String>** | | |
|
|
@@ -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,
|