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
data/docs/UserApi.md
CHANGED
|
@@ -12,9 +12,9 @@ All URIs are relative to *https://api.songtradr.com*
|
|
|
12
12
|
| [**initiate_user_image_upload**](UserApi.md#initiate_user_image_upload) | **POST** /api/v1/user/file/{name}/initImageUpload | Recognise and upload image. Responds with an object with recognition result. |
|
|
13
13
|
| [**login**](UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token. |
|
|
14
14
|
| [**me**](UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user |
|
|
15
|
+
| [**prompt_search_user_files**](UserApi.md#prompt_search_user_files) | **GET** /api/v1/user/promptSearch | Files for query. |
|
|
15
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. |
|
|
16
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. |
|
|
17
|
-
| [**save_playlist**](UserApi.md#save_playlist) | **POST** /api/v1/user/savePlaylist | List, search and create playlist of your own files. |
|
|
18
18
|
| [**sign_up**](UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user. |
|
|
19
19
|
| [**token**](UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token |
|
|
20
20
|
| [**update_password**](UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token |
|
|
@@ -567,11 +567,11 @@ This endpoint does not need any parameter.
|
|
|
567
567
|
- **Accept**: application/json
|
|
568
568
|
|
|
569
569
|
|
|
570
|
-
##
|
|
570
|
+
## prompt_search_user_files
|
|
571
571
|
|
|
572
|
-
> <
|
|
572
|
+
> <FileListDTO> prompt_search_user_files(query)
|
|
573
573
|
|
|
574
|
-
|
|
574
|
+
Files for query.
|
|
575
575
|
|
|
576
576
|
### Examples
|
|
577
577
|
|
|
@@ -585,43 +585,32 @@ SongtradrApiClientRuby.configure do |config|
|
|
|
585
585
|
end
|
|
586
586
|
|
|
587
587
|
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
588
|
-
|
|
589
|
-
opts = {
|
|
590
|
-
category_name: 'instrument', # String | Show only taggrams for one category.
|
|
591
|
-
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
|
592
|
-
genre_name: 'Ska', # String | Show only taggrams for one genre.
|
|
593
|
-
from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
|
|
594
|
-
to_timestamp: 32.0, # Float | Show only taggrams data before this timestamp in seconds.
|
|
595
|
-
fill_with_zero: true, # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
|
|
596
|
-
page: 56, # Integer | Zero-based page index (0..N)
|
|
597
|
-
size: 56, # Integer | The size of the page to be returned
|
|
598
|
-
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
599
|
-
}
|
|
588
|
+
query = 'funk, guitar, drums' # String | Query.
|
|
600
589
|
|
|
601
590
|
begin
|
|
602
|
-
#
|
|
603
|
-
result = api_instance.
|
|
591
|
+
# Files for query.
|
|
592
|
+
result = api_instance.prompt_search_user_files(query)
|
|
604
593
|
p result
|
|
605
594
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
606
|
-
puts "Error when calling UserApi->
|
|
595
|
+
puts "Error when calling UserApi->prompt_search_user_files: #{e}"
|
|
607
596
|
end
|
|
608
597
|
```
|
|
609
598
|
|
|
610
|
-
#### Using the
|
|
599
|
+
#### Using the prompt_search_user_files_with_http_info variant
|
|
611
600
|
|
|
612
601
|
This returns an Array which contains the response data, status code and headers.
|
|
613
602
|
|
|
614
|
-
> <Array(<
|
|
603
|
+
> <Array(<FileListDTO>, Integer, Hash)> prompt_search_user_files_with_http_info(query)
|
|
615
604
|
|
|
616
605
|
```ruby
|
|
617
606
|
begin
|
|
618
|
-
#
|
|
619
|
-
data, status_code, headers = api_instance.
|
|
607
|
+
# Files for query.
|
|
608
|
+
data, status_code, headers = api_instance.prompt_search_user_files_with_http_info(query)
|
|
620
609
|
p status_code # => 2xx
|
|
621
610
|
p headers # => { ... }
|
|
622
|
-
p data # => <
|
|
611
|
+
p data # => <FileListDTO>
|
|
623
612
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
624
|
-
puts "Error when calling UserApi->
|
|
613
|
+
puts "Error when calling UserApi->prompt_search_user_files_with_http_info: #{e}"
|
|
625
614
|
end
|
|
626
615
|
```
|
|
627
616
|
|
|
@@ -629,20 +618,11 @@ end
|
|
|
629
618
|
|
|
630
619
|
| Name | Type | Description | Notes |
|
|
631
620
|
| ---- | ---- | ----------- | ----- |
|
|
632
|
-
| **
|
|
633
|
-
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
|
634
|
-
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
|
635
|
-
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
|
636
|
-
| **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
|
|
637
|
-
| **to_timestamp** | **Float** | Show only taggrams data before this timestamp in seconds. | [optional] |
|
|
638
|
-
| **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [optional] |
|
|
639
|
-
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
640
|
-
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
641
|
-
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
621
|
+
| **query** | **String** | Query. | |
|
|
642
622
|
|
|
643
623
|
### Return type
|
|
644
624
|
|
|
645
|
-
[**
|
|
625
|
+
[**FileListDTO**](FileListDTO.md)
|
|
646
626
|
|
|
647
627
|
### Authorization
|
|
648
628
|
|
|
@@ -654,11 +634,11 @@ end
|
|
|
654
634
|
- **Accept**: application/json
|
|
655
635
|
|
|
656
636
|
|
|
657
|
-
##
|
|
637
|
+
## recordings_by_folder_with_taggrams
|
|
658
638
|
|
|
659
|
-
> <Array<
|
|
639
|
+
> <Array<RecordingMinimalWithTaggramsDTO>> recordings_by_folder_with_taggrams(folder_name, opts)
|
|
660
640
|
|
|
661
|
-
|
|
641
|
+
Timeseries of AI generated moods, musical features and more for recordings in your folder.
|
|
662
642
|
|
|
663
643
|
### Examples
|
|
664
644
|
|
|
@@ -677,35 +657,38 @@ opts = {
|
|
|
677
657
|
category_name: 'instrument', # String | Show only taggrams for one category.
|
|
678
658
|
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
|
679
659
|
genre_name: 'Ska', # String | Show only taggrams for one genre.
|
|
660
|
+
from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
|
|
661
|
+
to_timestamp: 32.0, # Float | Show only taggrams data before this timestamp in seconds.
|
|
662
|
+
fill_with_zero: true, # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
|
|
680
663
|
page: 56, # Integer | Zero-based page index (0..N)
|
|
681
664
|
size: 56, # Integer | The size of the page to be returned
|
|
682
665
|
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
683
666
|
}
|
|
684
667
|
|
|
685
668
|
begin
|
|
686
|
-
#
|
|
687
|
-
result = api_instance.
|
|
669
|
+
# Timeseries of AI generated moods, musical features and more for recordings in your folder.
|
|
670
|
+
result = api_instance.recordings_by_folder_with_taggrams(folder_name, opts)
|
|
688
671
|
p result
|
|
689
672
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
690
|
-
puts "Error when calling UserApi->
|
|
673
|
+
puts "Error when calling UserApi->recordings_by_folder_with_taggrams: #{e}"
|
|
691
674
|
end
|
|
692
675
|
```
|
|
693
676
|
|
|
694
|
-
#### Using the
|
|
677
|
+
#### Using the recordings_by_folder_with_taggrams_with_http_info variant
|
|
695
678
|
|
|
696
679
|
This returns an Array which contains the response data, status code and headers.
|
|
697
680
|
|
|
698
|
-
> <Array(<Array<
|
|
681
|
+
> <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)> recordings_by_folder_with_taggrams_with_http_info(folder_name, opts)
|
|
699
682
|
|
|
700
683
|
```ruby
|
|
701
684
|
begin
|
|
702
|
-
#
|
|
703
|
-
data, status_code, headers = api_instance.
|
|
685
|
+
# Timeseries of AI generated moods, musical features and more for recordings in your folder.
|
|
686
|
+
data, status_code, headers = api_instance.recordings_by_folder_with_taggrams_with_http_info(folder_name, opts)
|
|
704
687
|
p status_code # => 2xx
|
|
705
688
|
p headers # => { ... }
|
|
706
|
-
p data # => <Array<
|
|
689
|
+
p data # => <Array<RecordingMinimalWithTaggramsDTO>>
|
|
707
690
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
708
|
-
puts "Error when calling UserApi->
|
|
691
|
+
puts "Error when calling UserApi->recordings_by_folder_with_taggrams_with_http_info: #{e}"
|
|
709
692
|
end
|
|
710
693
|
```
|
|
711
694
|
|
|
@@ -717,13 +700,16 @@ end
|
|
|
717
700
|
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
|
718
701
|
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
|
719
702
|
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
|
703
|
+
| **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
|
|
704
|
+
| **to_timestamp** | **Float** | Show only taggrams data before this timestamp in seconds. | [optional] |
|
|
705
|
+
| **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [optional] |
|
|
720
706
|
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
721
707
|
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
722
708
|
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
723
709
|
|
|
724
710
|
### Return type
|
|
725
711
|
|
|
726
|
-
[**Array<
|
|
712
|
+
[**Array<RecordingMinimalWithTaggramsDTO>**](RecordingMinimalWithTaggramsDTO.md)
|
|
727
713
|
|
|
728
714
|
### Authorization
|
|
729
715
|
|
|
@@ -735,11 +721,11 @@ end
|
|
|
735
721
|
- **Accept**: application/json
|
|
736
722
|
|
|
737
723
|
|
|
738
|
-
##
|
|
724
|
+
## recordings_by_folder_with_tagstrengths
|
|
739
725
|
|
|
740
|
-
> <
|
|
726
|
+
> <Array<RecordingMinimalWithTagstrengthsDTO>> recordings_by_folder_with_tagstrengths(folder_name, opts)
|
|
741
727
|
|
|
742
|
-
|
|
728
|
+
Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
|
|
743
729
|
|
|
744
730
|
### Examples
|
|
745
731
|
|
|
@@ -753,95 +739,40 @@ SongtradrApiClientRuby.configure do |config|
|
|
|
753
739
|
end
|
|
754
740
|
|
|
755
741
|
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
742
|
+
folder_name = 'Default' # String | Folder name
|
|
756
743
|
opts = {
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
composer: 'John Cale', # String | Search for a composer.
|
|
761
|
-
title: 'Highway To Hell', # String | Search for a title.
|
|
762
|
-
party_and_title: 'The Beatles yesterday', # String | Search for party and title.
|
|
763
|
-
language: 'en', # String | Search for a language of the lyrics.
|
|
764
|
-
genre_names: ['inner_example'], # Array<String> |
|
|
765
|
-
tag_names: ['inner_example'], # Array<String> |
|
|
766
|
-
release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
767
|
-
primary_mood_cluster: 'aggressive', # String |
|
|
768
|
-
secondary_mood_cluster: 'aggressive', # String |
|
|
769
|
-
tertiary_mood_cluster: 'aggressive', # String |
|
|
770
|
-
valence: 'very sad', # String |
|
|
771
|
-
arousal: 'very calm', # String |
|
|
772
|
-
pleasantness: 'very unpleasant', # String |
|
|
773
|
-
engagement: 'very unengaging', # String |
|
|
774
|
-
vocals: 'instrumental', # String |
|
|
775
|
-
dominant_instrument: 'electric guitar', # String |
|
|
776
|
-
secondary_instrument: 'electric guitar', # String |
|
|
777
|
-
tertiary_instrument: 'electric guitar', # String |
|
|
778
|
-
energy: 'very quiet', # String |
|
|
779
|
-
sound_generation: 'acoustic', # String |
|
|
780
|
-
tempo: 'very slow', # String |
|
|
781
|
-
scale: 'major key', # String |
|
|
782
|
-
key: 'C', # String |
|
|
783
|
-
rhythm: 'common time', # String |
|
|
784
|
-
primary_sound_character: 'aggressive', # String |
|
|
785
|
-
timbre: 'very warm', # String |
|
|
786
|
-
roughness: 'very clear', # String |
|
|
787
|
-
tonality: 'monotonous', # String |
|
|
788
|
-
harmony: 'very dissonant', # String |
|
|
789
|
-
texture: 'very thin', # String |
|
|
790
|
-
groovyness: 'very steady', # String |
|
|
791
|
-
space: 'very compact', # String |
|
|
792
|
-
production_rating: 'low production quality', # String |
|
|
793
|
-
performance_rating: 'low performance quality', # String |
|
|
794
|
-
song_rating: 'low song quality', # String |
|
|
795
|
-
audience_age: 'Generation Z', # String |
|
|
796
|
-
audience_region: 'Australia and New Zealand', # String |
|
|
797
|
-
audience_gender: 'male', # String |
|
|
798
|
-
origin_decade: 'pre-1950s', # String |
|
|
799
|
-
curateability: 'curateable', # String |
|
|
800
|
-
use_case: 'background', # String |
|
|
801
|
-
channel_suitability: 'Spotify', # String |
|
|
802
|
-
similar_to_recording: 'similar_to_recording_example', # String |
|
|
803
|
-
create_playlist_with_name: 'PlaylistName', # String |
|
|
804
|
-
songtradr_track_id: 'songtradr_track_id_example', # String |
|
|
805
|
-
usage_name: 'usage_name_example', # String |
|
|
806
|
-
bpm_min: 50, # Integer | Search for a minimal bpm.
|
|
807
|
-
bpm_max: 210, # Integer | Search for a maximal bpm.
|
|
808
|
-
name: 'Groove.mp3', # String | Search for a file name.
|
|
809
|
-
folder: 'defaultFolder', # String | Search for a folder.
|
|
810
|
-
extension: '.mp3', # String | Search for a file extension.
|
|
811
|
-
upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
812
|
-
min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
813
|
-
max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
814
|
-
fingerprint_status: 'done', # String | Search for a fingerprint status.
|
|
815
|
-
inference_status: 'done', # String | Search for a inference status.
|
|
744
|
+
category_name: 'instrument', # String | Show only taggrams for one category.
|
|
745
|
+
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
|
746
|
+
genre_name: 'Ska', # String | Show only taggrams for one genre.
|
|
816
747
|
page: 56, # Integer | Zero-based page index (0..N)
|
|
817
748
|
size: 56, # Integer | The size of the page to be returned
|
|
818
749
|
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
819
750
|
}
|
|
820
751
|
|
|
821
752
|
begin
|
|
822
|
-
#
|
|
823
|
-
result = api_instance.
|
|
753
|
+
# Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
|
|
754
|
+
result = api_instance.recordings_by_folder_with_tagstrengths(folder_name, opts)
|
|
824
755
|
p result
|
|
825
756
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
826
|
-
puts "Error when calling UserApi->
|
|
757
|
+
puts "Error when calling UserApi->recordings_by_folder_with_tagstrengths: #{e}"
|
|
827
758
|
end
|
|
828
759
|
```
|
|
829
760
|
|
|
830
|
-
#### Using the
|
|
761
|
+
#### Using the recordings_by_folder_with_tagstrengths_with_http_info variant
|
|
831
762
|
|
|
832
763
|
This returns an Array which contains the response data, status code and headers.
|
|
833
764
|
|
|
834
|
-
> <Array(<
|
|
765
|
+
> <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)> recordings_by_folder_with_tagstrengths_with_http_info(folder_name, opts)
|
|
835
766
|
|
|
836
767
|
```ruby
|
|
837
768
|
begin
|
|
838
|
-
#
|
|
839
|
-
data, status_code, headers = api_instance.
|
|
769
|
+
# Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
|
|
770
|
+
data, status_code, headers = api_instance.recordings_by_folder_with_tagstrengths_with_http_info(folder_name, opts)
|
|
840
771
|
p status_code # => 2xx
|
|
841
772
|
p headers # => { ... }
|
|
842
|
-
p data # => <
|
|
773
|
+
p data # => <Array<RecordingMinimalWithTagstrengthsDTO>>
|
|
843
774
|
rescue SongtradrApiClientRuby::ApiError => e
|
|
844
|
-
puts "Error when calling UserApi->
|
|
775
|
+
puts "Error when calling UserApi->recordings_by_folder_with_tagstrengths_with_http_info: #{e}"
|
|
845
776
|
end
|
|
846
777
|
```
|
|
847
778
|
|
|
@@ -849,72 +780,17 @@ end
|
|
|
849
780
|
|
|
850
781
|
| Name | Type | Description | Notes |
|
|
851
782
|
| ---- | ---- | ----------- | ----- |
|
|
852
|
-
| **
|
|
853
|
-
| **
|
|
854
|
-
| **
|
|
855
|
-
| **
|
|
856
|
-
| **title** | **String** | Search for a title. | [optional] |
|
|
857
|
-
| **party_and_title** | **String** | Search for party and title. | [optional] |
|
|
858
|
-
| **language** | **String** | Search for a language of the lyrics. | [optional] |
|
|
859
|
-
| **genre_names** | [**Array<String>**](String.md) | | [optional] |
|
|
860
|
-
| **tag_names** | [**Array<String>**](String.md) | | [optional] |
|
|
861
|
-
| **release_date** | **Time** | | [optional] |
|
|
862
|
-
| **primary_mood_cluster** | **String** | | [optional] |
|
|
863
|
-
| **secondary_mood_cluster** | **String** | | [optional] |
|
|
864
|
-
| **tertiary_mood_cluster** | **String** | | [optional] |
|
|
865
|
-
| **valence** | **String** | | [optional] |
|
|
866
|
-
| **arousal** | **String** | | [optional] |
|
|
867
|
-
| **pleasantness** | **String** | | [optional] |
|
|
868
|
-
| **engagement** | **String** | | [optional] |
|
|
869
|
-
| **vocals** | **String** | | [optional] |
|
|
870
|
-
| **dominant_instrument** | **String** | | [optional] |
|
|
871
|
-
| **secondary_instrument** | **String** | | [optional] |
|
|
872
|
-
| **tertiary_instrument** | **String** | | [optional] |
|
|
873
|
-
| **energy** | **String** | | [optional] |
|
|
874
|
-
| **sound_generation** | **String** | | [optional] |
|
|
875
|
-
| **tempo** | **String** | | [optional] |
|
|
876
|
-
| **scale** | **String** | | [optional] |
|
|
877
|
-
| **key** | **String** | | [optional] |
|
|
878
|
-
| **rhythm** | **String** | | [optional] |
|
|
879
|
-
| **primary_sound_character** | **String** | | [optional] |
|
|
880
|
-
| **timbre** | **String** | | [optional] |
|
|
881
|
-
| **roughness** | **String** | | [optional] |
|
|
882
|
-
| **tonality** | **String** | | [optional] |
|
|
883
|
-
| **harmony** | **String** | | [optional] |
|
|
884
|
-
| **texture** | **String** | | [optional] |
|
|
885
|
-
| **groovyness** | **String** | | [optional] |
|
|
886
|
-
| **space** | **String** | | [optional] |
|
|
887
|
-
| **production_rating** | **String** | | [optional] |
|
|
888
|
-
| **performance_rating** | **String** | | [optional] |
|
|
889
|
-
| **song_rating** | **String** | | [optional] |
|
|
890
|
-
| **audience_age** | **String** | | [optional] |
|
|
891
|
-
| **audience_region** | **String** | | [optional] |
|
|
892
|
-
| **audience_gender** | **String** | | [optional] |
|
|
893
|
-
| **origin_decade** | **String** | | [optional] |
|
|
894
|
-
| **curateability** | **String** | | [optional] |
|
|
895
|
-
| **use_case** | **String** | | [optional] |
|
|
896
|
-
| **channel_suitability** | **String** | | [optional] |
|
|
897
|
-
| **similar_to_recording** | **String** | | [optional] |
|
|
898
|
-
| **create_playlist_with_name** | **String** | | [optional] |
|
|
899
|
-
| **songtradr_track_id** | **String** | | [optional] |
|
|
900
|
-
| **usage_name** | **String** | | [optional] |
|
|
901
|
-
| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
|
|
902
|
-
| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
|
|
903
|
-
| **name** | **String** | Search for a file name. | [optional] |
|
|
904
|
-
| **folder** | **String** | Search for a folder. | [optional] |
|
|
905
|
-
| **extension** | **String** | Search for a file extension. | [optional] |
|
|
906
|
-
| **upload_end_time** | **Time** | | [optional] |
|
|
907
|
-
| **min_upload_end_time** | **Time** | | [optional] |
|
|
908
|
-
| **max_upload_end_time** | **Time** | | [optional] |
|
|
909
|
-
| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
|
|
910
|
-
| **inference_status** | **String** | Search for a inference status. | [optional] |
|
|
783
|
+
| **folder_name** | **String** | Folder name | |
|
|
784
|
+
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
|
785
|
+
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
|
786
|
+
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
|
911
787
|
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
912
|
-
| **size** | **Integer** | The size of the page to be returned | [optional][default to
|
|
788
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
913
789
|
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
914
790
|
|
|
915
791
|
### Return type
|
|
916
792
|
|
|
917
|
-
[**
|
|
793
|
+
[**Array<RecordingMinimalWithTagstrengthsDTO>**](RecordingMinimalWithTagstrengthsDTO.md)
|
|
918
794
|
|
|
919
795
|
### Authorization
|
|
920
796
|
|
|
@@ -1231,9 +1107,9 @@ opts = {
|
|
|
1231
1107
|
pleasantness: 'very unpleasant', # String |
|
|
1232
1108
|
engagement: 'very unengaging', # String |
|
|
1233
1109
|
vocals: 'instrumental', # String |
|
|
1234
|
-
dominant_instrument: '
|
|
1235
|
-
secondary_instrument: '
|
|
1236
|
-
tertiary_instrument: '
|
|
1110
|
+
dominant_instrument: 'piano', # String |
|
|
1111
|
+
secondary_instrument: 'piano', # String |
|
|
1112
|
+
tertiary_instrument: 'piano', # String |
|
|
1237
1113
|
energy: 'very quiet', # String |
|
|
1238
1114
|
sound_generation: 'acoustic', # String |
|
|
1239
1115
|
tempo: 'very slow', # String |
|
|
@@ -1248,6 +1124,7 @@ opts = {
|
|
|
1248
1124
|
texture: 'very thin', # String |
|
|
1249
1125
|
groovyness: 'very steady', # String |
|
|
1250
1126
|
space: 'very compact', # String |
|
|
1127
|
+
loudness: 'very low', # String |
|
|
1251
1128
|
production_rating: 'low production quality', # String |
|
|
1252
1129
|
performance_rating: 'low performance quality', # String |
|
|
1253
1130
|
song_rating: 'low song quality', # String |
|
|
@@ -1342,6 +1219,7 @@ end
|
|
|
1342
1219
|
| **texture** | **String** | | [optional] |
|
|
1343
1220
|
| **groovyness** | **String** | | [optional] |
|
|
1344
1221
|
| **space** | **String** | | [optional] |
|
|
1222
|
+
| **loudness** | **String** | | [optional] |
|
|
1345
1223
|
| **production_rating** | **String** | | [optional] |
|
|
1346
1224
|
| **performance_rating** | **String** | | [optional] |
|
|
1347
1225
|
| **song_rating** | **String** | | [optional] |
|
|
@@ -1486,9 +1364,9 @@ opts = {
|
|
|
1486
1364
|
pleasantness: 'very unpleasant', # String |
|
|
1487
1365
|
engagement: 'very unengaging', # String |
|
|
1488
1366
|
vocals: 'instrumental', # String |
|
|
1489
|
-
dominant_instrument: '
|
|
1490
|
-
secondary_instrument: '
|
|
1491
|
-
tertiary_instrument: '
|
|
1367
|
+
dominant_instrument: 'piano', # String |
|
|
1368
|
+
secondary_instrument: 'piano', # String |
|
|
1369
|
+
tertiary_instrument: 'piano', # String |
|
|
1492
1370
|
energy: 'very quiet', # String |
|
|
1493
1371
|
sound_generation: 'acoustic', # String |
|
|
1494
1372
|
tempo: 'very slow', # String |
|
|
@@ -1503,6 +1381,7 @@ opts = {
|
|
|
1503
1381
|
texture: 'very thin', # String |
|
|
1504
1382
|
groovyness: 'very steady', # String |
|
|
1505
1383
|
space: 'very compact', # String |
|
|
1384
|
+
loudness: 'very low', # String |
|
|
1506
1385
|
production_rating: 'low production quality', # String |
|
|
1507
1386
|
performance_rating: 'low performance quality', # String |
|
|
1508
1387
|
song_rating: 'low song quality', # String |
|
|
@@ -1593,6 +1472,7 @@ end
|
|
|
1593
1472
|
| **texture** | **String** | | [optional] |
|
|
1594
1473
|
| **groovyness** | **String** | | [optional] |
|
|
1595
1474
|
| **space** | **String** | | [optional] |
|
|
1475
|
+
| **loudness** | **String** | | [optional] |
|
|
1596
1476
|
| **production_rating** | **String** | | [optional] |
|
|
1597
1477
|
| **performance_rating** | **String** | | [optional] |
|
|
1598
1478
|
| **song_rating** | **String** | | [optional] |
|
data/docs/UserDTO.md
CHANGED
|
@@ -33,6 +33,7 @@
|
|
|
33
33
|
| **reduced_musical_features** | **Boolean** | | |
|
|
34
34
|
| **confirmed** | **Boolean** | | |
|
|
35
35
|
| **language** | **String** | | |
|
|
36
|
+
| **recording_endpoints_allowed** | **Boolean** | | |
|
|
36
37
|
| **admin** | **Boolean** | | [optional] |
|
|
37
38
|
|
|
38
39
|
## Example
|
|
@@ -70,6 +71,7 @@ instance = SongtradrApiClientRuby::UserDTO.new(
|
|
|
70
71
|
reduced_musical_features: null,
|
|
71
72
|
confirmed: null,
|
|
72
73
|
language: null,
|
|
74
|
+
recording_endpoints_allowed: null,
|
|
73
75
|
admin: null
|
|
74
76
|
)
|
|
75
77
|
```
|
|
@@ -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:
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 7.
|
|
9
|
+
OpenAPI Generator version: 7.4.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|