songtradr_api_client_ruby 2.0.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +14 -9
- data/docs/FileSmallDTO.md +5 -5
- data/docs/MusicalFeaturesDTO.md +14 -14
- data/docs/RecordingApi.md +36 -36
- data/docs/RecordingMediumDTO.md +2 -2
- data/docs/RecordingSmallDTO.md +3 -3
- 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 -30
- 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 +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 +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 +76 -76
- 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 +27 -27
- 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 -2
- 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 -10
- data/spec/api/user_api_spec.rb +60 -2
- 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 +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 +32 -32
- 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 +5 -5
- 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 -42
data/docs/UserApi.md
CHANGED
@@ -15,6 +15,10 @@ All URIs are relative to *https://api.songtradr.com*
|
|
15
15
|
| [**prompt_search_user_files**](UserApi.md#prompt_search_user_files) | **GET** /api/v1/user/promptSearch | Files for query. |
|
16
16
|
| [**recordings_by_folder_with_taggrams**](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. |
|
17
17
|
| [**recordings_by_folder_with_tagstrengths**](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. |
|
18
|
+
| [**recordings_by_ids_with_similarities**](UserApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/user/recording/{ids}/similarities | Similar recordings for a list of user recordings. |
|
19
|
+
| [**recordings_by_ids_with_taggrams**](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. |
|
20
|
+
| [**recordings_by_ids_with_tagstrengths**](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. |
|
21
|
+
| [**recordings_medium_by_ids**](UserApi.md#recordings_medium_by_ids) | **GET** /api/v1/user/recording/{ids} | Recordings by IDs with a medium sized response. |
|
18
22
|
| [**sign_up**](UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user. |
|
19
23
|
| [**token**](UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token |
|
20
24
|
| [**update_password**](UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token |
|
@@ -802,6 +806,310 @@ end
|
|
802
806
|
- **Accept**: application/json
|
803
807
|
|
804
808
|
|
809
|
+
## recordings_by_ids_with_similarities
|
810
|
+
|
811
|
+
> <Array<RecordingForSimilaritySearchDTO>> recordings_by_ids_with_similarities(ids, opts)
|
812
|
+
|
813
|
+
Similar recordings for a list of user recordings.
|
814
|
+
|
815
|
+
### Examples
|
816
|
+
|
817
|
+
```ruby
|
818
|
+
require 'time'
|
819
|
+
require 'songtradr_api_client_ruby'
|
820
|
+
# setup authorization
|
821
|
+
SongtradrApiClientRuby.configure do |config|
|
822
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
823
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
824
|
+
end
|
825
|
+
|
826
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
827
|
+
ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
828
|
+
opts = {
|
829
|
+
identical_only: true, # Boolean | Whether a result list shall include only identical recordings.
|
830
|
+
usage: 'usage_example' # String | Filter by recording usage.
|
831
|
+
}
|
832
|
+
|
833
|
+
begin
|
834
|
+
# Similar recordings for a list of user recordings.
|
835
|
+
result = api_instance.recordings_by_ids_with_similarities(ids, opts)
|
836
|
+
p result
|
837
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
838
|
+
puts "Error when calling UserApi->recordings_by_ids_with_similarities: #{e}"
|
839
|
+
end
|
840
|
+
```
|
841
|
+
|
842
|
+
#### Using the recordings_by_ids_with_similarities_with_http_info variant
|
843
|
+
|
844
|
+
This returns an Array which contains the response data, status code and headers.
|
845
|
+
|
846
|
+
> <Array(<Array<RecordingForSimilaritySearchDTO>>, Integer, Hash)> recordings_by_ids_with_similarities_with_http_info(ids, opts)
|
847
|
+
|
848
|
+
```ruby
|
849
|
+
begin
|
850
|
+
# Similar recordings for a list of user recordings.
|
851
|
+
data, status_code, headers = api_instance.recordings_by_ids_with_similarities_with_http_info(ids, opts)
|
852
|
+
p status_code # => 2xx
|
853
|
+
p headers # => { ... }
|
854
|
+
p data # => <Array<RecordingForSimilaritySearchDTO>>
|
855
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
856
|
+
puts "Error when calling UserApi->recordings_by_ids_with_similarities_with_http_info: #{e}"
|
857
|
+
end
|
858
|
+
```
|
859
|
+
|
860
|
+
### Parameters
|
861
|
+
|
862
|
+
| Name | Type | Description | Notes |
|
863
|
+
| ---- | ---- | ----------- | ----- |
|
864
|
+
| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
|
865
|
+
| **identical_only** | **Boolean** | Whether a result list shall include only identical recordings. | [optional][default to false] |
|
866
|
+
| **usage** | **String** | Filter by recording usage. | [optional] |
|
867
|
+
|
868
|
+
### Return type
|
869
|
+
|
870
|
+
[**Array<RecordingForSimilaritySearchDTO>**](RecordingForSimilaritySearchDTO.md)
|
871
|
+
|
872
|
+
### Authorization
|
873
|
+
|
874
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
875
|
+
|
876
|
+
### HTTP request headers
|
877
|
+
|
878
|
+
- **Content-Type**: Not defined
|
879
|
+
- **Accept**: application/json
|
880
|
+
|
881
|
+
|
882
|
+
## recordings_by_ids_with_taggrams
|
883
|
+
|
884
|
+
> <Array<RecordingMinimalWithTaggramsDTO>> recordings_by_ids_with_taggrams(ids, opts)
|
885
|
+
|
886
|
+
Timeseries of AI generated moods, musical features and more for a list of recordings.
|
887
|
+
|
888
|
+
### Examples
|
889
|
+
|
890
|
+
```ruby
|
891
|
+
require 'time'
|
892
|
+
require 'songtradr_api_client_ruby'
|
893
|
+
# setup authorization
|
894
|
+
SongtradrApiClientRuby.configure do |config|
|
895
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
896
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
897
|
+
end
|
898
|
+
|
899
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
900
|
+
ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
901
|
+
opts = {
|
902
|
+
category_name: 'instrument', # String | Show only taggrams for one category.
|
903
|
+
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
904
|
+
genre_name: 'Ska', # String | Show only taggrams for one genre.
|
905
|
+
from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
|
906
|
+
to_timestamp: 32.0, # Float | Show only taggrams data before this timestamp in seconds.
|
907
|
+
fill_with_zero: true # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
|
908
|
+
}
|
909
|
+
|
910
|
+
begin
|
911
|
+
# Timeseries of AI generated moods, musical features and more for a list of recordings.
|
912
|
+
result = api_instance.recordings_by_ids_with_taggrams(ids, opts)
|
913
|
+
p result
|
914
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
915
|
+
puts "Error when calling UserApi->recordings_by_ids_with_taggrams: #{e}"
|
916
|
+
end
|
917
|
+
```
|
918
|
+
|
919
|
+
#### Using the recordings_by_ids_with_taggrams_with_http_info variant
|
920
|
+
|
921
|
+
This returns an Array which contains the response data, status code and headers.
|
922
|
+
|
923
|
+
> <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)> recordings_by_ids_with_taggrams_with_http_info(ids, opts)
|
924
|
+
|
925
|
+
```ruby
|
926
|
+
begin
|
927
|
+
# Timeseries of AI generated moods, musical features and more for a list of recordings.
|
928
|
+
data, status_code, headers = api_instance.recordings_by_ids_with_taggrams_with_http_info(ids, opts)
|
929
|
+
p status_code # => 2xx
|
930
|
+
p headers # => { ... }
|
931
|
+
p data # => <Array<RecordingMinimalWithTaggramsDTO>>
|
932
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
933
|
+
puts "Error when calling UserApi->recordings_by_ids_with_taggrams_with_http_info: #{e}"
|
934
|
+
end
|
935
|
+
```
|
936
|
+
|
937
|
+
### Parameters
|
938
|
+
|
939
|
+
| Name | Type | Description | Notes |
|
940
|
+
| ---- | ---- | ----------- | ----- |
|
941
|
+
| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
|
942
|
+
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
943
|
+
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
944
|
+
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
945
|
+
| **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
|
946
|
+
| **to_timestamp** | **Float** | Show only taggrams data before this timestamp in seconds. | [optional] |
|
947
|
+
| **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [optional] |
|
948
|
+
|
949
|
+
### Return type
|
950
|
+
|
951
|
+
[**Array<RecordingMinimalWithTaggramsDTO>**](RecordingMinimalWithTaggramsDTO.md)
|
952
|
+
|
953
|
+
### Authorization
|
954
|
+
|
955
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
956
|
+
|
957
|
+
### HTTP request headers
|
958
|
+
|
959
|
+
- **Content-Type**: Not defined
|
960
|
+
- **Accept**: application/json
|
961
|
+
|
962
|
+
|
963
|
+
## recordings_by_ids_with_tagstrengths
|
964
|
+
|
965
|
+
> <Array<RecordingMinimalWithTagstrengthsDTO>> recordings_by_ids_with_tagstrengths(ids, opts)
|
966
|
+
|
967
|
+
Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
968
|
+
|
969
|
+
### Examples
|
970
|
+
|
971
|
+
```ruby
|
972
|
+
require 'time'
|
973
|
+
require 'songtradr_api_client_ruby'
|
974
|
+
# setup authorization
|
975
|
+
SongtradrApiClientRuby.configure do |config|
|
976
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
977
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
978
|
+
end
|
979
|
+
|
980
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
981
|
+
ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
982
|
+
opts = {
|
983
|
+
category_name: 'instrument', # String | Show only taggrams for one category.
|
984
|
+
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
985
|
+
genre_name: 'Ska' # String | Show only taggrams for one genre.
|
986
|
+
}
|
987
|
+
|
988
|
+
begin
|
989
|
+
# Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
990
|
+
result = api_instance.recordings_by_ids_with_tagstrengths(ids, opts)
|
991
|
+
p result
|
992
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
993
|
+
puts "Error when calling UserApi->recordings_by_ids_with_tagstrengths: #{e}"
|
994
|
+
end
|
995
|
+
```
|
996
|
+
|
997
|
+
#### Using the recordings_by_ids_with_tagstrengths_with_http_info variant
|
998
|
+
|
999
|
+
This returns an Array which contains the response data, status code and headers.
|
1000
|
+
|
1001
|
+
> <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)> recordings_by_ids_with_tagstrengths_with_http_info(ids, opts)
|
1002
|
+
|
1003
|
+
```ruby
|
1004
|
+
begin
|
1005
|
+
# Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
1006
|
+
data, status_code, headers = api_instance.recordings_by_ids_with_tagstrengths_with_http_info(ids, opts)
|
1007
|
+
p status_code # => 2xx
|
1008
|
+
p headers # => { ... }
|
1009
|
+
p data # => <Array<RecordingMinimalWithTagstrengthsDTO>>
|
1010
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
1011
|
+
puts "Error when calling UserApi->recordings_by_ids_with_tagstrengths_with_http_info: #{e}"
|
1012
|
+
end
|
1013
|
+
```
|
1014
|
+
|
1015
|
+
### Parameters
|
1016
|
+
|
1017
|
+
| Name | Type | Description | Notes |
|
1018
|
+
| ---- | ---- | ----------- | ----- |
|
1019
|
+
| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
|
1020
|
+
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
1021
|
+
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
1022
|
+
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
1023
|
+
|
1024
|
+
### Return type
|
1025
|
+
|
1026
|
+
[**Array<RecordingMinimalWithTagstrengthsDTO>**](RecordingMinimalWithTagstrengthsDTO.md)
|
1027
|
+
|
1028
|
+
### Authorization
|
1029
|
+
|
1030
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
1031
|
+
|
1032
|
+
### HTTP request headers
|
1033
|
+
|
1034
|
+
- **Content-Type**: Not defined
|
1035
|
+
- **Accept**: application/json
|
1036
|
+
|
1037
|
+
|
1038
|
+
## recordings_medium_by_ids
|
1039
|
+
|
1040
|
+
> <Array<RecordingMediumDTO>> recordings_medium_by_ids(ids, opts)
|
1041
|
+
|
1042
|
+
Recordings by IDs with a medium sized response.
|
1043
|
+
|
1044
|
+
### Examples
|
1045
|
+
|
1046
|
+
```ruby
|
1047
|
+
require 'time'
|
1048
|
+
require 'songtradr_api_client_ruby'
|
1049
|
+
# setup authorization
|
1050
|
+
SongtradrApiClientRuby.configure do |config|
|
1051
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
1052
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
1053
|
+
end
|
1054
|
+
|
1055
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
1056
|
+
ids = 'GBAHT0108619' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
1057
|
+
opts = {
|
1058
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
1059
|
+
size: 56, # Integer | The size of the page to be returned
|
1060
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
1061
|
+
}
|
1062
|
+
|
1063
|
+
begin
|
1064
|
+
# Recordings by IDs with a medium sized response.
|
1065
|
+
result = api_instance.recordings_medium_by_ids(ids, opts)
|
1066
|
+
p result
|
1067
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
1068
|
+
puts "Error when calling UserApi->recordings_medium_by_ids: #{e}"
|
1069
|
+
end
|
1070
|
+
```
|
1071
|
+
|
1072
|
+
#### Using the recordings_medium_by_ids_with_http_info variant
|
1073
|
+
|
1074
|
+
This returns an Array which contains the response data, status code and headers.
|
1075
|
+
|
1076
|
+
> <Array(<Array<RecordingMediumDTO>>, Integer, Hash)> recordings_medium_by_ids_with_http_info(ids, opts)
|
1077
|
+
|
1078
|
+
```ruby
|
1079
|
+
begin
|
1080
|
+
# Recordings by IDs with a medium sized response.
|
1081
|
+
data, status_code, headers = api_instance.recordings_medium_by_ids_with_http_info(ids, opts)
|
1082
|
+
p status_code # => 2xx
|
1083
|
+
p headers # => { ... }
|
1084
|
+
p data # => <Array<RecordingMediumDTO>>
|
1085
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
1086
|
+
puts "Error when calling UserApi->recordings_medium_by_ids_with_http_info: #{e}"
|
1087
|
+
end
|
1088
|
+
```
|
1089
|
+
|
1090
|
+
### Parameters
|
1091
|
+
|
1092
|
+
| Name | Type | Description | Notes |
|
1093
|
+
| ---- | ---- | ----------- | ----- |
|
1094
|
+
| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
|
1095
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
1096
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
1097
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
1098
|
+
|
1099
|
+
### Return type
|
1100
|
+
|
1101
|
+
[**Array<RecordingMediumDTO>**](RecordingMediumDTO.md)
|
1102
|
+
|
1103
|
+
### Authorization
|
1104
|
+
|
1105
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
1106
|
+
|
1107
|
+
### HTTP request headers
|
1108
|
+
|
1109
|
+
- **Content-Type**: Not defined
|
1110
|
+
- **Accept**: application/json
|
1111
|
+
|
1112
|
+
|
805
1113
|
## sign_up
|
806
1114
|
|
807
1115
|
> <SignUpDTO> sign_up(save_user_dto)
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.1.0
|
7
7
|
Contact: info@songtradr.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
|
9
|
+
Generator version: 7.5.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.
|
6
|
+
The version of the OpenAPI document: 2.1.0
|
7
7
|
Contact: info@songtradr.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
|
9
|
+
Generator version: 7.5.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -148,8 +148,8 @@ module SongtradrApiClientRuby
|
|
148
148
|
# @option opts [Boolean] :identical_only Whether a result list shall include only identical recordings. (default to false)
|
149
149
|
# @option opts [String] :usage Filter by recording usage.
|
150
150
|
# @return [Array<RecordingForSimilaritySearchDTO>]
|
151
|
-
def
|
152
|
-
data, _status_code, _headers =
|
151
|
+
def recordings_by_ids_with_similarities1(ids, opts = {})
|
152
|
+
data, _status_code, _headers = recordings_by_ids_with_similarities1_with_http_info(ids, opts)
|
153
153
|
data
|
154
154
|
end
|
155
155
|
|
@@ -159,13 +159,13 @@ module SongtradrApiClientRuby
|
|
159
159
|
# @option opts [Boolean] :identical_only Whether a result list shall include only identical recordings. (default to false)
|
160
160
|
# @option opts [String] :usage Filter by recording usage.
|
161
161
|
# @return [Array<(Array<RecordingForSimilaritySearchDTO>, Integer, Hash)>] Array<RecordingForSimilaritySearchDTO> data, response status code and response headers
|
162
|
-
def
|
162
|
+
def recordings_by_ids_with_similarities1_with_http_info(ids, opts = {})
|
163
163
|
if @api_client.config.debugging
|
164
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.
|
164
|
+
@api_client.config.logger.debug 'Calling API: RecordingApi.recordings_by_ids_with_similarities1 ...'
|
165
165
|
end
|
166
166
|
# verify the required parameter 'ids' is set
|
167
167
|
if @api_client.config.client_side_validation && ids.nil?
|
168
|
-
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.
|
168
|
+
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_by_ids_with_similarities1"
|
169
169
|
end
|
170
170
|
# resource path
|
171
171
|
local_var_path = '/api/v1/public/recording/{ids}/similarities'.sub('{' + 'ids' + '}', CGI.escape(ids.to_s))
|
@@ -193,7 +193,7 @@ module SongtradrApiClientRuby
|
|
193
193
|
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
194
194
|
|
195
195
|
new_options = opts.merge(
|
196
|
-
:operation => :"RecordingApi.
|
196
|
+
:operation => :"RecordingApi.recordings_by_ids_with_similarities1",
|
197
197
|
:header_params => header_params,
|
198
198
|
:query_params => query_params,
|
199
199
|
:form_params => form_params,
|
@@ -204,7 +204,7 @@ module SongtradrApiClientRuby
|
|
204
204
|
|
205
205
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
206
206
|
if @api_client.config.debugging
|
207
|
-
@api_client.config.logger.debug "API called: RecordingApi#
|
207
|
+
@api_client.config.logger.debug "API called: RecordingApi#recordings_by_ids_with_similarities1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
208
208
|
end
|
209
209
|
return data, status_code, headers
|
210
210
|
end
|
@@ -219,8 +219,8 @@ module SongtradrApiClientRuby
|
|
219
219
|
# @option opts [Float] :to_timestamp Show only taggrams data before this timestamp in seconds.
|
220
220
|
# @option opts [Boolean] :fill_with_zero If set to true, empty timeseries are filled with timeseries of 0.0 values.
|
221
221
|
# @return [Array<RecordingMinimalWithTaggramsDTO>]
|
222
|
-
def
|
223
|
-
data, _status_code, _headers =
|
222
|
+
def recordings_by_ids_with_taggrams1(ids, opts = {})
|
223
|
+
data, _status_code, _headers = recordings_by_ids_with_taggrams1_with_http_info(ids, opts)
|
224
224
|
data
|
225
225
|
end
|
226
226
|
|
@@ -234,13 +234,13 @@ module SongtradrApiClientRuby
|
|
234
234
|
# @option opts [Float] :to_timestamp Show only taggrams data before this timestamp in seconds.
|
235
235
|
# @option opts [Boolean] :fill_with_zero If set to true, empty timeseries are filled with timeseries of 0.0 values.
|
236
236
|
# @return [Array<(Array<RecordingMinimalWithTaggramsDTO>, Integer, Hash)>] Array<RecordingMinimalWithTaggramsDTO> data, response status code and response headers
|
237
|
-
def
|
237
|
+
def recordings_by_ids_with_taggrams1_with_http_info(ids, opts = {})
|
238
238
|
if @api_client.config.debugging
|
239
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.
|
239
|
+
@api_client.config.logger.debug 'Calling API: RecordingApi.recordings_by_ids_with_taggrams1 ...'
|
240
240
|
end
|
241
241
|
# verify the required parameter 'ids' is set
|
242
242
|
if @api_client.config.client_side_validation && ids.nil?
|
243
|
-
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.
|
243
|
+
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_by_ids_with_taggrams1"
|
244
244
|
end
|
245
245
|
allowable_values = ["instrument", "vocals", "energy", "soundGeneration", "rhythm", "songRating", "performanceRating", "productionRating", "moodCluster", "tonality", "arousal", "valence", "pleasantness", "engagement", "timbre", "roughness", "harmony", "texture", "groovyness", "space", "audienceAge", "audienceRegion", "audienceGender", "originRegion", "originDecade", "languageOfPerformance", "level1Genre", "level2Genre", "curateability", "useCase", "channelSuitability", "industrySuitability", "loudness"]
|
246
246
|
if @api_client.config.client_side_validation && opts[:'category_name'] && !allowable_values.include?(opts[:'category_name'])
|
@@ -276,7 +276,7 @@ module SongtradrApiClientRuby
|
|
276
276
|
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
277
277
|
|
278
278
|
new_options = opts.merge(
|
279
|
-
:operation => :"RecordingApi.
|
279
|
+
:operation => :"RecordingApi.recordings_by_ids_with_taggrams1",
|
280
280
|
:header_params => header_params,
|
281
281
|
:query_params => query_params,
|
282
282
|
:form_params => form_params,
|
@@ -287,7 +287,7 @@ module SongtradrApiClientRuby
|
|
287
287
|
|
288
288
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
289
289
|
if @api_client.config.debugging
|
290
|
-
@api_client.config.logger.debug "API called: RecordingApi#
|
290
|
+
@api_client.config.logger.debug "API called: RecordingApi#recordings_by_ids_with_taggrams1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
291
291
|
end
|
292
292
|
return data, status_code, headers
|
293
293
|
end
|
@@ -299,8 +299,8 @@ module SongtradrApiClientRuby
|
|
299
299
|
# @option opts [String] :tag_name Show only taggrams for one tag.
|
300
300
|
# @option opts [String] :genre_name Show only taggrams for one genre.
|
301
301
|
# @return [Array<RecordingMinimalWithTagstrengthsDTO>]
|
302
|
-
def
|
303
|
-
data, _status_code, _headers =
|
302
|
+
def recordings_by_ids_with_tagstrengths1(ids, opts = {})
|
303
|
+
data, _status_code, _headers = recordings_by_ids_with_tagstrengths1_with_http_info(ids, opts)
|
304
304
|
data
|
305
305
|
end
|
306
306
|
|
@@ -311,13 +311,13 @@ module SongtradrApiClientRuby
|
|
311
311
|
# @option opts [String] :tag_name Show only taggrams for one tag.
|
312
312
|
# @option opts [String] :genre_name Show only taggrams for one genre.
|
313
313
|
# @return [Array<(Array<RecordingMinimalWithTagstrengthsDTO>, Integer, Hash)>] Array<RecordingMinimalWithTagstrengthsDTO> data, response status code and response headers
|
314
|
-
def
|
314
|
+
def recordings_by_ids_with_tagstrengths1_with_http_info(ids, opts = {})
|
315
315
|
if @api_client.config.debugging
|
316
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.
|
316
|
+
@api_client.config.logger.debug 'Calling API: RecordingApi.recordings_by_ids_with_tagstrengths1 ...'
|
317
317
|
end
|
318
318
|
# verify the required parameter 'ids' is set
|
319
319
|
if @api_client.config.client_side_validation && ids.nil?
|
320
|
-
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.
|
320
|
+
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_by_ids_with_tagstrengths1"
|
321
321
|
end
|
322
322
|
allowable_values = ["instrument", "vocals", "energy", "soundGeneration", "rhythm", "songRating", "performanceRating", "productionRating", "moodCluster", "tonality", "arousal", "valence", "pleasantness", "engagement", "timbre", "roughness", "harmony", "texture", "groovyness", "space", "audienceAge", "audienceRegion", "audienceGender", "originRegion", "originDecade", "languageOfPerformance", "level1Genre", "level2Genre", "curateability", "useCase", "channelSuitability", "industrySuitability", "loudness"]
|
323
323
|
if @api_client.config.client_side_validation && opts[:'category_name'] && !allowable_values.include?(opts[:'category_name'])
|
@@ -350,7 +350,7 @@ module SongtradrApiClientRuby
|
|
350
350
|
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
351
351
|
|
352
352
|
new_options = opts.merge(
|
353
|
-
:operation => :"RecordingApi.
|
353
|
+
:operation => :"RecordingApi.recordings_by_ids_with_tagstrengths1",
|
354
354
|
:header_params => header_params,
|
355
355
|
:query_params => query_params,
|
356
356
|
:form_params => form_params,
|
@@ -361,7 +361,7 @@ module SongtradrApiClientRuby
|
|
361
361
|
|
362
362
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
363
363
|
if @api_client.config.debugging
|
364
|
-
@api_client.config.logger.debug "API called: RecordingApi#
|
364
|
+
@api_client.config.logger.debug "API called: RecordingApi#recordings_by_ids_with_tagstrengths1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
365
365
|
end
|
366
366
|
return data, status_code, headers
|
367
367
|
end
|
@@ -373,8 +373,8 @@ module SongtradrApiClientRuby
|
|
373
373
|
# @option opts [Integer] :size The size of the page to be returned (default to 20)
|
374
374
|
# @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
375
375
|
# @return [Array<RecordingMediumDTO>]
|
376
|
-
def
|
377
|
-
data, _status_code, _headers =
|
376
|
+
def recordings_medium_by_ids1(ids, opts = {})
|
377
|
+
data, _status_code, _headers = recordings_medium_by_ids1_with_http_info(ids, opts)
|
378
378
|
data
|
379
379
|
end
|
380
380
|
|
@@ -385,13 +385,13 @@ module SongtradrApiClientRuby
|
|
385
385
|
# @option opts [Integer] :size The size of the page to be returned (default to 20)
|
386
386
|
# @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
387
387
|
# @return [Array<(Array<RecordingMediumDTO>, Integer, Hash)>] Array<RecordingMediumDTO> data, response status code and response headers
|
388
|
-
def
|
388
|
+
def recordings_medium_by_ids1_with_http_info(ids, opts = {})
|
389
389
|
if @api_client.config.debugging
|
390
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.
|
390
|
+
@api_client.config.logger.debug 'Calling API: RecordingApi.recordings_medium_by_ids1 ...'
|
391
391
|
end
|
392
392
|
# verify the required parameter 'ids' is set
|
393
393
|
if @api_client.config.client_side_validation && ids.nil?
|
394
|
-
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.
|
394
|
+
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_medium_by_ids1"
|
395
395
|
end
|
396
396
|
# resource path
|
397
397
|
local_var_path = '/api/v1/public/recording/m/{ids}'.sub('{' + 'ids' + '}', CGI.escape(ids.to_s))
|
@@ -420,7 +420,7 @@ module SongtradrApiClientRuby
|
|
420
420
|
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
421
421
|
|
422
422
|
new_options = opts.merge(
|
423
|
-
:operation => :"RecordingApi.
|
423
|
+
:operation => :"RecordingApi.recordings_medium_by_ids1",
|
424
424
|
:header_params => header_params,
|
425
425
|
:query_params => query_params,
|
426
426
|
:form_params => form_params,
|
@@ -431,7 +431,7 @@ module SongtradrApiClientRuby
|
|
431
431
|
|
432
432
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
433
433
|
if @api_client.config.debugging
|
434
|
-
@api_client.config.logger.debug "API called: RecordingApi#
|
434
|
+
@api_client.config.logger.debug "API called: RecordingApi#recordings_medium_by_ids1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
435
435
|
end
|
436
436
|
return data, status_code, headers
|
437
437
|
end
|