songtradr_api_client_ruby 1.18.0 → 2.1.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 +4 -4
- data/README.md +14 -11
- data/docs/CategoryMediumDTO.md +3 -3
- data/docs/FileSmallDTO.md +5 -5
- data/docs/MusicalFeaturesDTO.md +37 -37
- data/docs/RecordingApi.md +36 -104
- data/docs/RecordingMediumDTO.md +4 -4
- data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
- data/docs/RecordingPartyDTO.md +3 -3
- data/docs/RecordingSmallDTO.md +5 -5
- data/docs/UserApi.md +308 -0
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +30 -96
- data/lib/songtradr_api_client_ruby/api/user_api.rb +296 -2
- data/lib/songtradr_api_client_ruby/api_client.rb +4 -5
- 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 +17 -17
- 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 +44 -44
- 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 +168 -168
- 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 +35 -35
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +17 -17
- 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 +17 -17
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +38 -38
- 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 +2 -2
- 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 +2 -2
- 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 -3
- data/openapi-generator-config.yaml +1 -1
- data/songtradr_api_client_ruby.gemspec +3 -3
- data/spec/api/allowed_values_api_spec.rb +2 -2
- data/spec/api/recording_api_spec.rb +10 -21
- data/spec/api/user_api_spec.rb +60 -2
- data/spec/models/category_medium_dto_spec.rb +4 -4
- 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 +18 -18
- 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 +110 -110
- 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 +10 -10
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +4 -4
- 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 +4 -4
- data/spec/models/recording_small_dto_spec.rb +6 -6
- 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 +2 -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 +2 -2
- data/spec/models/video_recognition_response_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +42 -46
- data/docs/SearchRecordingGranularDTO.md +0 -20
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +0 -232
- 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: 6cc51278a185fece7b225910b9bfdf6c365e614aa7287786d8604d76204b0491
|
|
4
|
+
data.tar.gz: 7bd8f055da156e04ab5945b291e7cd029ed0299c5f7bcfed93907a2bee8dc6b0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3c30a43829bfaa166681c6ab256636589f357874727377fbe93b8aaa62d97d73b14f05aff564e45ff2d78c643341fbfd8ee4b1a0dfe5013dbd711a04b7db907d
|
|
7
|
+
data.tar.gz: 0c703df8ccbd408c7e71e95561443640e013b3ec167511ca6e8640648474e11853a8f35d87b6a276ed258ce337917efdcf97cab4bc2e2155593b497643e16661
|
data/Gemfile.lock
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
songtradr_api_client_ruby (1.
|
|
4
|
+
songtradr_api_client_ruby (2.1.0)
|
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
|
6
6
|
faraday-multipart
|
|
7
|
-
|
|
7
|
+
marcel
|
|
8
8
|
|
|
9
9
|
GEM
|
|
10
10
|
remote: https://rubygems.org/
|
|
@@ -20,6 +20,7 @@ GEM
|
|
|
20
20
|
faraday-net_http (3.1.0)
|
|
21
21
|
net-http
|
|
22
22
|
jaro_winkler (1.5.6)
|
|
23
|
+
marcel (1.0.4)
|
|
23
24
|
method_source (1.0.0)
|
|
24
25
|
multipart-post (2.4.0)
|
|
25
26
|
net-http (0.4.1)
|
|
@@ -51,7 +52,7 @@ GEM
|
|
|
51
52
|
rspec-mocks (3.13.0)
|
|
52
53
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
53
54
|
rspec-support (~> 3.13.0)
|
|
54
|
-
rspec-support (3.13.
|
|
55
|
+
rspec-support (3.13.1)
|
|
55
56
|
rubocop (0.66.0)
|
|
56
57
|
jaro_winkler (~> 1.5.1)
|
|
57
58
|
parallel (~> 1.10)
|
|
@@ -60,7 +61,6 @@ GEM
|
|
|
60
61
|
rainbow (>= 2.2.2, < 4.0)
|
|
61
62
|
ruby-progressbar (~> 1.7)
|
|
62
63
|
unicode-display_width (>= 1.4.0, < 1.6)
|
|
63
|
-
ruby-filemagic (0.7.3)
|
|
64
64
|
ruby-progressbar (1.13.0)
|
|
65
65
|
stringio (3.1.0)
|
|
66
66
|
unicode-display_width (1.5.0)
|
data/README.md
CHANGED
|
@@ -33,8 +33,9 @@ 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.
|
|
37
|
-
- Package version: 1.
|
|
36
|
+
- API version: 2.1.0
|
|
37
|
+
- Package version: 2.1.0
|
|
38
|
+
- Generator version: 7.5.0-SNAPSHOT
|
|
38
39
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
39
40
|
For more information, please visit [https://songtradr.com](https://songtradr.com)
|
|
40
41
|
|
|
@@ -51,16 +52,16 @@ gem build songtradr_api_client_ruby.gemspec
|
|
|
51
52
|
Then either install the gem locally:
|
|
52
53
|
|
|
53
54
|
```shell
|
|
54
|
-
gem install ./songtradr_api_client_ruby-1.
|
|
55
|
+
gem install ./songtradr_api_client_ruby-2.1.0.gem
|
|
55
56
|
```
|
|
56
57
|
|
|
57
|
-
(for development, run `gem install --dev ./songtradr_api_client_ruby-1.
|
|
58
|
+
(for development, run `gem install --dev ./songtradr_api_client_ruby-2.1.0.gem` to install the development dependencies)
|
|
58
59
|
|
|
59
60
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
60
61
|
|
|
61
62
|
Finally add this to the Gemfile:
|
|
62
63
|
|
|
63
|
-
gem 'songtradr_api_client_ruby', '~> 1.
|
|
64
|
+
gem 'songtradr_api_client_ruby', '~> 2.1.0'
|
|
64
65
|
|
|
65
66
|
### Install from Git
|
|
66
67
|
|
|
@@ -110,12 +111,11 @@ Class | Method | HTTP request | Description
|
|
|
110
111
|
*SongtradrApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
|
|
111
112
|
*SongtradrApiClientRuby::RecordingApi* | [**prompt_search_recordings**](docs/RecordingApi.md#prompt_search_recordings) | **GET** /api/v1/public/recording/promptSearch | Recordings for query.
|
|
112
113
|
*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
|
-
*SongtradrApiClientRuby::RecordingApi* | [**
|
|
114
|
-
*SongtradrApiClientRuby::RecordingApi* | [**
|
|
115
|
-
*SongtradrApiClientRuby::RecordingApi* | [**
|
|
116
|
-
*SongtradrApiClientRuby::RecordingApi* | [**
|
|
114
|
+
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_similarities1**](docs/RecordingApi.md#recordings_by_ids_with_similarities1) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings.
|
|
115
|
+
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_taggrams1**](docs/RecordingApi.md#recordings_by_ids_with_taggrams1) | **GET** /api/v1/public/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings.
|
|
116
|
+
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_tagstrengths1**](docs/RecordingApi.md#recordings_by_ids_with_tagstrengths1) | **GET** /api/v1/public/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
|
117
|
+
*SongtradrApiClientRuby::RecordingApi* | [**recordings_medium_by_ids1**](docs/RecordingApi.md#recordings_medium_by_ids1) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response.
|
|
117
118
|
*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
119
|
*SongtradrApiClientRuby::UserApi* | [**delete_user_file**](docs/UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file.
|
|
120
120
|
*SongtradrApiClientRuby::UserApi* | [**edit_me**](docs/UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user
|
|
121
121
|
*SongtradrApiClientRuby::UserApi* | [**forgot_password**](docs/UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email
|
|
@@ -127,6 +127,10 @@ Class | Method | HTTP request | Description
|
|
|
127
127
|
*SongtradrApiClientRuby::UserApi* | [**prompt_search_user_files**](docs/UserApi.md#prompt_search_user_files) | **GET** /api/v1/user/promptSearch | Files for query.
|
|
128
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.
|
|
129
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.
|
|
130
|
+
*SongtradrApiClientRuby::UserApi* | [**recordings_by_ids_with_similarities**](docs/UserApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/user/recording/{ids}/similarities | Similar recordings for a list of user recordings.
|
|
131
|
+
*SongtradrApiClientRuby::UserApi* | [**recordings_by_ids_with_taggrams**](docs/UserApi.md#recordings_by_ids_with_taggrams) | **GET** /api/v1/user/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings.
|
|
132
|
+
*SongtradrApiClientRuby::UserApi* | [**recordings_by_ids_with_tagstrengths**](docs/UserApi.md#recordings_by_ids_with_tagstrengths) | **GET** /api/v1/user/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
|
133
|
+
*SongtradrApiClientRuby::UserApi* | [**recordings_medium_by_ids**](docs/UserApi.md#recordings_medium_by_ids) | **GET** /api/v1/user/recording/{ids} | Recordings by IDs with a medium sized response.
|
|
130
134
|
*SongtradrApiClientRuby::UserApi* | [**sign_up**](docs/UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user.
|
|
131
135
|
*SongtradrApiClientRuby::UserApi* | [**token**](docs/UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token
|
|
132
136
|
*SongtradrApiClientRuby::UserApi* | [**update_password**](docs/UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token
|
|
@@ -173,7 +177,6 @@ Class | Method | HTTP request | Description
|
|
|
173
177
|
- [SongtradrApiClientRuby::RecordingTagSmallDTO](docs/RecordingTagSmallDTO.md)
|
|
174
178
|
- [SongtradrApiClientRuby::SaveUserDTO](docs/SaveUserDTO.md)
|
|
175
179
|
- [SongtradrApiClientRuby::SearchFilterValuesDTO](docs/SearchFilterValuesDTO.md)
|
|
176
|
-
- [SongtradrApiClientRuby::SearchRecordingGranularDTO](docs/SearchRecordingGranularDTO.md)
|
|
177
180
|
- [SongtradrApiClientRuby::SignUpDTO](docs/SignUpDTO.md)
|
|
178
181
|
- [SongtradrApiClientRuby::TagDTO](docs/TagDTO.md)
|
|
179
182
|
- [SongtradrApiClientRuby::TagSmallDTO](docs/TagSmallDTO.md)
|
data/docs/CategoryMediumDTO.md
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **Integer** | | |
|
|
8
|
-
| **tags** | [**Array<TagSmallDTO>**](TagSmallDTO.md) | | [optional] |
|
|
9
8
|
| **name** | **String** | | |
|
|
9
|
+
| **tags** | [**Array<TagSmallDTO>**](TagSmallDTO.md) | | [optional] |
|
|
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
|
-
|
|
19
|
-
|
|
18
|
+
name: null,
|
|
19
|
+
tags: null
|
|
20
20
|
)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/FileSmallDTO.md
CHANGED
|
@@ -4,21 +4,21 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **folder** | **String** | | |
|
|
7
8
|
| **name** | **String** | | |
|
|
8
9
|
| **id** | **Integer** | | |
|
|
9
10
|
| **extension** | **String** | extension of the file | |
|
|
10
11
|
| **error_message** | **String** | | [optional] |
|
|
11
|
-
| **folder** | **String** | | |
|
|
12
12
|
| **object_key** | **String** | | |
|
|
13
13
|
| **upload_start_time** | **Time** | | [optional] |
|
|
14
14
|
| **upload_end_time** | **Time** | | [optional] |
|
|
15
|
-
| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
|
|
16
15
|
| **fingerprint_start_time** | **Time** | | [optional] |
|
|
17
16
|
| **fingerprint_end_time** | **Time** | | [optional] |
|
|
18
17
|
| **inference_status** | **String** | status of the auto-tagging | [optional] |
|
|
19
18
|
| **inference_start_time** | **Time** | | [optional] |
|
|
20
19
|
| **inference_end_time** | **Time** | | [optional] |
|
|
21
20
|
| **error_time** | **Time** | | [optional] |
|
|
21
|
+
| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -26,21 +26,21 @@
|
|
|
26
26
|
require 'songtradr_api_client_ruby'
|
|
27
27
|
|
|
28
28
|
instance = SongtradrApiClientRuby::FileSmallDTO.new(
|
|
29
|
+
folder: null,
|
|
29
30
|
name: null,
|
|
30
31
|
id: null,
|
|
31
32
|
extension: null,
|
|
32
33
|
error_message: null,
|
|
33
|
-
folder: null,
|
|
34
34
|
object_key: null,
|
|
35
35
|
upload_start_time: null,
|
|
36
36
|
upload_end_time: null,
|
|
37
|
-
fingerprint_status: null,
|
|
38
37
|
fingerprint_start_time: null,
|
|
39
38
|
fingerprint_end_time: null,
|
|
40
39
|
inference_status: null,
|
|
41
40
|
inference_start_time: null,
|
|
42
41
|
inference_end_time: null,
|
|
43
|
-
error_time: null
|
|
42
|
+
error_time: null,
|
|
43
|
+
fingerprint_status: null
|
|
44
44
|
)
|
|
45
45
|
```
|
|
46
46
|
|
data/docs/MusicalFeaturesDTO.md
CHANGED
|
@@ -5,6 +5,22 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **space** | **String** | Search for space | [optional] |
|
|
8
|
+
| **groovyness_affinity** | **Float** | | [optional] |
|
|
9
|
+
| **space_affinity** | **Float** | | [optional] |
|
|
10
|
+
| **loudness_affinity** | **Float** | | [optional] |
|
|
11
|
+
| **key_affinity** | **Float** | | [optional] |
|
|
12
|
+
| **channel_suitability_affinity** | **Float** | | [optional] |
|
|
13
|
+
| **valence_affinity** | **Float** | | [optional] |
|
|
14
|
+
| **arousal_affinity** | **Float** | | [optional] |
|
|
15
|
+
| **pleasantness_affinity** | **Float** | | [optional] |
|
|
16
|
+
| **engagement_affinity** | **Float** | | [optional] |
|
|
17
|
+
| **energy_affinity** | **Float** | | [optional] |
|
|
18
|
+
| **tempo_affinity** | **Float** | | [optional] |
|
|
19
|
+
| **scale_affinity** | **Float** | | [optional] |
|
|
20
|
+
| **timbre_affinity** | **Float** | | [optional] |
|
|
21
|
+
| **roughness_affinity** | **Float** | | [optional] |
|
|
22
|
+
| **harmony_affinity** | **Float** | | [optional] |
|
|
23
|
+
| **texture_affinity** | **Float** | | [optional] |
|
|
8
24
|
| **language_of_performance** | **String** | | [optional] |
|
|
9
25
|
| **arousal** | **String** | Search for an arousal | [optional] |
|
|
10
26
|
| **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
|
|
@@ -31,6 +47,8 @@
|
|
|
31
47
|
| **use_case** | **String** | Search for use case | [optional] |
|
|
32
48
|
| **channel_suitability** | **String** | Search for social media suitability | [optional] |
|
|
33
49
|
| **loudness** | **String** | Search for loudness | [optional] |
|
|
50
|
+
| **bpm** | **Float** | | [optional] |
|
|
51
|
+
| **primary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
34
52
|
| **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
|
|
35
53
|
| **secondary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
36
54
|
| **tertiary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
|
|
@@ -45,14 +63,12 @@
|
|
|
45
63
|
| **rhythm_affinity** | **Float** | | [optional] |
|
|
46
64
|
| **primary_sound_character_affinity** | **Float** | | [optional] |
|
|
47
65
|
| **tonality_affinity** | **Float** | | [optional] |
|
|
48
|
-
| **bpm** | **Float** | | [optional] |
|
|
49
66
|
| **production_rating** | **String** | | [optional] |
|
|
50
67
|
| **production_rating_affinity** | **Float** | | [optional] |
|
|
51
68
|
| **performance_rating** | **String** | | [optional] |
|
|
52
69
|
| **performance_rating_affinity** | **Float** | | [optional] |
|
|
53
70
|
| **song_rating** | **String** | | [optional] |
|
|
54
71
|
| **song_rating_affinity** | **Float** | | [optional] |
|
|
55
|
-
| **primary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
56
72
|
| **audience_age** | **String** | | [optional] |
|
|
57
73
|
| **audience_age_affinity** | **Float** | | [optional] |
|
|
58
74
|
| **secondary_audience_age** | **String** | | [optional] |
|
|
@@ -75,22 +91,6 @@
|
|
|
75
91
|
| **industry_suitability** | **String** | Search for Industry suitability | [optional] |
|
|
76
92
|
| **industry_suitability_affinity** | **Float** | | [optional] |
|
|
77
93
|
| **audience_region** | **String** | | [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] |
|
|
85
|
-
| **valence_affinity** | **Float** | | [optional] |
|
|
86
|
-
| **arousal_affinity** | **Float** | | [optional] |
|
|
87
|
-
| **pleasantness_affinity** | **Float** | | [optional] |
|
|
88
|
-
| **engagement_affinity** | **Float** | | [optional] |
|
|
89
|
-
| **energy_affinity** | **Float** | | [optional] |
|
|
90
|
-
| **tempo_affinity** | **Float** | | [optional] |
|
|
91
|
-
| **scale_affinity** | **Float** | | [optional] |
|
|
92
|
-
| **timbre_affinity** | **Float** | | [optional] |
|
|
93
|
-
| **roughness_affinity** | **Float** | | [optional] |
|
|
94
94
|
|
|
95
95
|
## Example
|
|
96
96
|
|
|
@@ -99,6 +99,22 @@ require 'songtradr_api_client_ruby'
|
|
|
99
99
|
|
|
100
100
|
instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
101
101
|
space: null,
|
|
102
|
+
groovyness_affinity: null,
|
|
103
|
+
space_affinity: null,
|
|
104
|
+
loudness_affinity: null,
|
|
105
|
+
key_affinity: null,
|
|
106
|
+
channel_suitability_affinity: null,
|
|
107
|
+
valence_affinity: null,
|
|
108
|
+
arousal_affinity: null,
|
|
109
|
+
pleasantness_affinity: null,
|
|
110
|
+
engagement_affinity: null,
|
|
111
|
+
energy_affinity: null,
|
|
112
|
+
tempo_affinity: null,
|
|
113
|
+
scale_affinity: null,
|
|
114
|
+
timbre_affinity: null,
|
|
115
|
+
roughness_affinity: null,
|
|
116
|
+
harmony_affinity: null,
|
|
117
|
+
texture_affinity: null,
|
|
102
118
|
language_of_performance: null,
|
|
103
119
|
arousal: null,
|
|
104
120
|
dominant_instrument: null,
|
|
@@ -125,6 +141,8 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
|
125
141
|
use_case: null,
|
|
126
142
|
channel_suitability: null,
|
|
127
143
|
loudness: null,
|
|
144
|
+
bpm: null,
|
|
145
|
+
primary_mood_cluster_affinity: null,
|
|
128
146
|
secondary_mood_cluster: null,
|
|
129
147
|
secondary_mood_cluster_affinity: null,
|
|
130
148
|
tertiary_mood_cluster: null,
|
|
@@ -139,14 +157,12 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
|
139
157
|
rhythm_affinity: null,
|
|
140
158
|
primary_sound_character_affinity: null,
|
|
141
159
|
tonality_affinity: null,
|
|
142
|
-
bpm: null,
|
|
143
160
|
production_rating: null,
|
|
144
161
|
production_rating_affinity: null,
|
|
145
162
|
performance_rating: null,
|
|
146
163
|
performance_rating_affinity: null,
|
|
147
164
|
song_rating: null,
|
|
148
165
|
song_rating_affinity: null,
|
|
149
|
-
primary_mood_cluster_affinity: null,
|
|
150
166
|
audience_age: null,
|
|
151
167
|
audience_age_affinity: null,
|
|
152
168
|
secondary_audience_age: null,
|
|
@@ -168,23 +184,7 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
|
168
184
|
use_case_affinity: null,
|
|
169
185
|
industry_suitability: null,
|
|
170
186
|
industry_suitability_affinity: null,
|
|
171
|
-
audience_region: 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,
|
|
179
|
-
valence_affinity: null,
|
|
180
|
-
arousal_affinity: null,
|
|
181
|
-
pleasantness_affinity: null,
|
|
182
|
-
engagement_affinity: null,
|
|
183
|
-
energy_affinity: null,
|
|
184
|
-
tempo_affinity: null,
|
|
185
|
-
scale_affinity: null,
|
|
186
|
-
timbre_affinity: null,
|
|
187
|
-
roughness_affinity: null
|
|
187
|
+
audience_region: null
|
|
188
188
|
)
|
|
189
189
|
```
|
|
190
190
|
|
data/docs/RecordingApi.md
CHANGED
|
@@ -6,12 +6,11 @@ All URIs are relative to *https://api.songtradr.com*
|
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**prompt_search_recordings**](RecordingApi.md#prompt_search_recordings) | **GET** /api/v1/public/recording/promptSearch | Recordings for query. |
|
|
8
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. |
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
9
|
+
| [**recordings_by_ids_with_similarities1**](RecordingApi.md#recordings_by_ids_with_similarities1) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings. |
|
|
10
|
+
| [**recordings_by_ids_with_taggrams1**](RecordingApi.md#recordings_by_ids_with_taggrams1) | **GET** /api/v1/public/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings. |
|
|
11
|
+
| [**recordings_by_ids_with_tagstrengths1**](RecordingApi.md#recordings_by_ids_with_tagstrengths1) | **GET** /api/v1/public/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings. |
|
|
12
|
+
| [**recordings_medium_by_ids1**](RecordingApi.md#recordings_medium_by_ids1) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response. |
|
|
13
13
|
| [**search_recordings**](RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more. |
|
|
14
|
-
| [**search_recordings_granular**](RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options. |
|
|
15
14
|
|
|
16
15
|
|
|
17
16
|
## prompt_search_recordings
|
|
@@ -148,9 +147,9 @@ end
|
|
|
148
147
|
- **Accept**: application/json
|
|
149
148
|
|
|
150
149
|
|
|
151
|
-
##
|
|
150
|
+
## recordings_by_ids_with_similarities1
|
|
152
151
|
|
|
153
|
-
> <Array<RecordingForSimilaritySearchDTO>>
|
|
152
|
+
> <Array<RecordingForSimilaritySearchDTO>> recordings_by_ids_with_similarities1(ids, opts)
|
|
154
153
|
|
|
155
154
|
Similar recordings for a list of recordings.
|
|
156
155
|
|
|
@@ -174,28 +173,28 @@ opts = {
|
|
|
174
173
|
|
|
175
174
|
begin
|
|
176
175
|
# Similar recordings for a list of recordings.
|
|
177
|
-
result = api_instance.
|
|
176
|
+
result = api_instance.recordings_by_ids_with_similarities1(ids, opts)
|
|
178
177
|
p result
|
|
179
178
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
180
|
-
puts "Error when calling RecordingApi->
|
|
179
|
+
puts "Error when calling RecordingApi->recordings_by_ids_with_similarities1: #{e}"
|
|
181
180
|
end
|
|
182
181
|
```
|
|
183
182
|
|
|
184
|
-
#### Using the
|
|
183
|
+
#### Using the recordings_by_ids_with_similarities1_with_http_info variant
|
|
185
184
|
|
|
186
185
|
This returns an Array which contains the response data, status code and headers.
|
|
187
186
|
|
|
188
|
-
> <Array(<Array<RecordingForSimilaritySearchDTO>>, Integer, Hash)>
|
|
187
|
+
> <Array(<Array<RecordingForSimilaritySearchDTO>>, Integer, Hash)> recordings_by_ids_with_similarities1_with_http_info(ids, opts)
|
|
189
188
|
|
|
190
189
|
```ruby
|
|
191
190
|
begin
|
|
192
191
|
# Similar recordings for a list of recordings.
|
|
193
|
-
data, status_code, headers = api_instance.
|
|
192
|
+
data, status_code, headers = api_instance.recordings_by_ids_with_similarities1_with_http_info(ids, opts)
|
|
194
193
|
p status_code # => 2xx
|
|
195
194
|
p headers # => { ... }
|
|
196
195
|
p data # => <Array<RecordingForSimilaritySearchDTO>>
|
|
197
196
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
198
|
-
puts "Error when calling RecordingApi->
|
|
197
|
+
puts "Error when calling RecordingApi->recordings_by_ids_with_similarities1_with_http_info: #{e}"
|
|
199
198
|
end
|
|
200
199
|
```
|
|
201
200
|
|
|
@@ -221,9 +220,9 @@ end
|
|
|
221
220
|
- **Accept**: application/json
|
|
222
221
|
|
|
223
222
|
|
|
224
|
-
##
|
|
223
|
+
## recordings_by_ids_with_taggrams1
|
|
225
224
|
|
|
226
|
-
> <Array<RecordingMinimalWithTaggramsDTO>>
|
|
225
|
+
> <Array<RecordingMinimalWithTaggramsDTO>> recordings_by_ids_with_taggrams1(ids, opts)
|
|
227
226
|
|
|
228
227
|
Timeseries of AI generated moods, musical features and more for a list of recordings.
|
|
229
228
|
|
|
@@ -251,28 +250,28 @@ opts = {
|
|
|
251
250
|
|
|
252
251
|
begin
|
|
253
252
|
# Timeseries of AI generated moods, musical features and more for a list of recordings.
|
|
254
|
-
result = api_instance.
|
|
253
|
+
result = api_instance.recordings_by_ids_with_taggrams1(ids, opts)
|
|
255
254
|
p result
|
|
256
255
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
257
|
-
puts "Error when calling RecordingApi->
|
|
256
|
+
puts "Error when calling RecordingApi->recordings_by_ids_with_taggrams1: #{e}"
|
|
258
257
|
end
|
|
259
258
|
```
|
|
260
259
|
|
|
261
|
-
#### Using the
|
|
260
|
+
#### Using the recordings_by_ids_with_taggrams1_with_http_info variant
|
|
262
261
|
|
|
263
262
|
This returns an Array which contains the response data, status code and headers.
|
|
264
263
|
|
|
265
|
-
> <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)>
|
|
264
|
+
> <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)> recordings_by_ids_with_taggrams1_with_http_info(ids, opts)
|
|
266
265
|
|
|
267
266
|
```ruby
|
|
268
267
|
begin
|
|
269
268
|
# Timeseries of AI generated moods, musical features and more for a list of recordings.
|
|
270
|
-
data, status_code, headers = api_instance.
|
|
269
|
+
data, status_code, headers = api_instance.recordings_by_ids_with_taggrams1_with_http_info(ids, opts)
|
|
271
270
|
p status_code # => 2xx
|
|
272
271
|
p headers # => { ... }
|
|
273
272
|
p data # => <Array<RecordingMinimalWithTaggramsDTO>>
|
|
274
273
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
275
|
-
puts "Error when calling RecordingApi->
|
|
274
|
+
puts "Error when calling RecordingApi->recordings_by_ids_with_taggrams1_with_http_info: #{e}"
|
|
276
275
|
end
|
|
277
276
|
```
|
|
278
277
|
|
|
@@ -302,9 +301,9 @@ end
|
|
|
302
301
|
- **Accept**: application/json
|
|
303
302
|
|
|
304
303
|
|
|
305
|
-
##
|
|
304
|
+
## recordings_by_ids_with_tagstrengths1
|
|
306
305
|
|
|
307
|
-
> <Array<RecordingMinimalWithTagstrengthsDTO>>
|
|
306
|
+
> <Array<RecordingMinimalWithTagstrengthsDTO>> recordings_by_ids_with_tagstrengths1(ids, opts)
|
|
308
307
|
|
|
309
308
|
Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
|
310
309
|
|
|
@@ -329,28 +328,28 @@ opts = {
|
|
|
329
328
|
|
|
330
329
|
begin
|
|
331
330
|
# Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
|
332
|
-
result = api_instance.
|
|
331
|
+
result = api_instance.recordings_by_ids_with_tagstrengths1(ids, opts)
|
|
333
332
|
p result
|
|
334
333
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
335
|
-
puts "Error when calling RecordingApi->
|
|
334
|
+
puts "Error when calling RecordingApi->recordings_by_ids_with_tagstrengths1: #{e}"
|
|
336
335
|
end
|
|
337
336
|
```
|
|
338
337
|
|
|
339
|
-
#### Using the
|
|
338
|
+
#### Using the recordings_by_ids_with_tagstrengths1_with_http_info variant
|
|
340
339
|
|
|
341
340
|
This returns an Array which contains the response data, status code and headers.
|
|
342
341
|
|
|
343
|
-
> <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)>
|
|
342
|
+
> <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)> recordings_by_ids_with_tagstrengths1_with_http_info(ids, opts)
|
|
344
343
|
|
|
345
344
|
```ruby
|
|
346
345
|
begin
|
|
347
346
|
# Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
|
348
|
-
data, status_code, headers = api_instance.
|
|
347
|
+
data, status_code, headers = api_instance.recordings_by_ids_with_tagstrengths1_with_http_info(ids, opts)
|
|
349
348
|
p status_code # => 2xx
|
|
350
349
|
p headers # => { ... }
|
|
351
350
|
p data # => <Array<RecordingMinimalWithTagstrengthsDTO>>
|
|
352
351
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
353
|
-
puts "Error when calling RecordingApi->
|
|
352
|
+
puts "Error when calling RecordingApi->recordings_by_ids_with_tagstrengths1_with_http_info: #{e}"
|
|
354
353
|
end
|
|
355
354
|
```
|
|
356
355
|
|
|
@@ -377,9 +376,9 @@ end
|
|
|
377
376
|
- **Accept**: application/json
|
|
378
377
|
|
|
379
378
|
|
|
380
|
-
##
|
|
379
|
+
## recordings_medium_by_ids1
|
|
381
380
|
|
|
382
|
-
> <Array<RecordingMediumDTO>>
|
|
381
|
+
> <Array<RecordingMediumDTO>> recordings_medium_by_ids1(ids, opts)
|
|
383
382
|
|
|
384
383
|
Recordings by IDs with a medium sized response.
|
|
385
384
|
|
|
@@ -404,28 +403,28 @@ opts = {
|
|
|
404
403
|
|
|
405
404
|
begin
|
|
406
405
|
# Recordings by IDs with a medium sized response.
|
|
407
|
-
result = api_instance.
|
|
406
|
+
result = api_instance.recordings_medium_by_ids1(ids, opts)
|
|
408
407
|
p result
|
|
409
408
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
410
|
-
puts "Error when calling RecordingApi->
|
|
409
|
+
puts "Error when calling RecordingApi->recordings_medium_by_ids1: #{e}"
|
|
411
410
|
end
|
|
412
411
|
```
|
|
413
412
|
|
|
414
|
-
#### Using the
|
|
413
|
+
#### Using the recordings_medium_by_ids1_with_http_info variant
|
|
415
414
|
|
|
416
415
|
This returns an Array which contains the response data, status code and headers.
|
|
417
416
|
|
|
418
|
-
> <Array(<Array<RecordingMediumDTO>>, Integer, Hash)>
|
|
417
|
+
> <Array(<Array<RecordingMediumDTO>>, Integer, Hash)> recordings_medium_by_ids1_with_http_info(ids, opts)
|
|
419
418
|
|
|
420
419
|
```ruby
|
|
421
420
|
begin
|
|
422
421
|
# Recordings by IDs with a medium sized response.
|
|
423
|
-
data, status_code, headers = api_instance.
|
|
422
|
+
data, status_code, headers = api_instance.recordings_medium_by_ids1_with_http_info(ids, opts)
|
|
424
423
|
p status_code # => 2xx
|
|
425
424
|
p headers # => { ... }
|
|
426
425
|
p data # => <Array<RecordingMediumDTO>>
|
|
427
426
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
428
|
-
puts "Error when calling RecordingApi->
|
|
427
|
+
puts "Error when calling RecordingApi->recordings_medium_by_ids1_with_http_info: #{e}"
|
|
429
428
|
end
|
|
430
429
|
```
|
|
431
430
|
|
|
@@ -600,70 +599,3 @@ end
|
|
|
600
599
|
- **Content-Type**: Not defined
|
|
601
600
|
- **Accept**: application/json
|
|
602
601
|
|
|
603
|
-
|
|
604
|
-
## search_recordings_granular
|
|
605
|
-
|
|
606
|
-
> <RecordingListDTO> search_recordings_granular(search_recording_granular_dto)
|
|
607
|
-
|
|
608
|
-
Recordings by granular search options.
|
|
609
|
-
|
|
610
|
-
### Examples
|
|
611
|
-
|
|
612
|
-
```ruby
|
|
613
|
-
require 'time'
|
|
614
|
-
require 'songtradr_api_client_ruby'
|
|
615
|
-
# setup authorization
|
|
616
|
-
SongtradrApiClientRuby.configure do |config|
|
|
617
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
618
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
619
|
-
end
|
|
620
|
-
|
|
621
|
-
api_instance = SongtradrApiClientRuby::RecordingApi.new
|
|
622
|
-
search_recording_granular_dto = [SongtradrApiClientRuby::SearchRecordingGranularDTO.new({tag_name: 'tag_name_example'})] # Array<SearchRecordingGranularDTO> |
|
|
623
|
-
|
|
624
|
-
begin
|
|
625
|
-
# Recordings by granular search options.
|
|
626
|
-
result = api_instance.search_recordings_granular(search_recording_granular_dto)
|
|
627
|
-
p result
|
|
628
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
629
|
-
puts "Error when calling RecordingApi->search_recordings_granular: #{e}"
|
|
630
|
-
end
|
|
631
|
-
```
|
|
632
|
-
|
|
633
|
-
#### Using the search_recordings_granular_with_http_info variant
|
|
634
|
-
|
|
635
|
-
This returns an Array which contains the response data, status code and headers.
|
|
636
|
-
|
|
637
|
-
> <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_granular_with_http_info(search_recording_granular_dto)
|
|
638
|
-
|
|
639
|
-
```ruby
|
|
640
|
-
begin
|
|
641
|
-
# Recordings by granular search options.
|
|
642
|
-
data, status_code, headers = api_instance.search_recordings_granular_with_http_info(search_recording_granular_dto)
|
|
643
|
-
p status_code # => 2xx
|
|
644
|
-
p headers # => { ... }
|
|
645
|
-
p data # => <RecordingListDTO>
|
|
646
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
647
|
-
puts "Error when calling RecordingApi->search_recordings_granular_with_http_info: #{e}"
|
|
648
|
-
end
|
|
649
|
-
```
|
|
650
|
-
|
|
651
|
-
### Parameters
|
|
652
|
-
|
|
653
|
-
| Name | Type | Description | Notes |
|
|
654
|
-
| ---- | ---- | ----------- | ----- |
|
|
655
|
-
| **search_recording_granular_dto** | [**Array<SearchRecordingGranularDTO>**](SearchRecordingGranularDTO.md) | | |
|
|
656
|
-
|
|
657
|
-
### Return type
|
|
658
|
-
|
|
659
|
-
[**RecordingListDTO**](RecordingListDTO.md)
|
|
660
|
-
|
|
661
|
-
### Authorization
|
|
662
|
-
|
|
663
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
664
|
-
|
|
665
|
-
### HTTP request headers
|
|
666
|
-
|
|
667
|
-
- **Content-Type**: application/json
|
|
668
|
-
- **Accept**: application/json
|
|
669
|
-
|
data/docs/RecordingMediumDTO.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **isrc** | **String** | | |
|
|
8
|
+
| **recording_party_entities** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) | | [optional] |
|
|
7
9
|
| **genres** | [**Array<GenreDTO>**](GenreDTO.md) | | [optional] |
|
|
8
10
|
| **language_of_performance** | **String** | | [optional] |
|
|
9
11
|
| **release_date** | **Time** | | [optional] |
|
|
10
12
|
| **titles** | [**Array<TitleDTO>**](TitleDTO.md) | | [optional] |
|
|
11
13
|
| **tracks** | [**Array<TrackDTO>**](TrackDTO.md) | | [optional] |
|
|
12
14
|
| **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) | | [optional] |
|
|
13
|
-
| **isrc** | **String** | | |
|
|
14
|
-
| **recording_party_entities** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.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] |
|
|
@@ -22,14 +22,14 @@
|
|
|
22
22
|
require 'songtradr_api_client_ruby'
|
|
23
23
|
|
|
24
24
|
instance = SongtradrApiClientRuby::RecordingMediumDTO.new(
|
|
25
|
+
isrc: null,
|
|
26
|
+
recording_party_entities: null,
|
|
25
27
|
genres: null,
|
|
26
28
|
language_of_performance: null,
|
|
27
29
|
release_date: null,
|
|
28
30
|
titles: null,
|
|
29
31
|
tracks: null,
|
|
30
32
|
musical_features: null,
|
|
31
|
-
isrc: null,
|
|
32
|
-
recording_party_entities: 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
|
-
| **musical_features** | [**Array<MusicalFeaturesDTO>**](MusicalFeaturesDTO.md) | | [optional] |
|
|
8
7
|
| **isrc** | **String** | | |
|
|
8
|
+
| **musical_features** | [**Array<MusicalFeaturesDTO>**](MusicalFeaturesDTO.md) | | [optional] |
|
|
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
|
-
|
|
17
|
-
|
|
16
|
+
isrc: null,
|
|
17
|
+
musical_features: null
|
|
18
18
|
)
|
|
19
19
|
```
|
|
20
20
|
|