songtradr_api_client_ruby 1.12.21
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 +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +76 -0
- data/README.md +223 -0
- data/Rakefile +10 -0
- data/docs/AllowedValuesApi.md +200 -0
- data/docs/CategoryMediumDTO.md +22 -0
- data/docs/CategoryMinimalDTO.md +18 -0
- data/docs/ConfigAccessDTO.md +20 -0
- data/docs/ConfigIdentifierDTO.md +20 -0
- data/docs/ContributorTypeDTO.md +18 -0
- data/docs/ErrorResponse.md +26 -0
- data/docs/FieldSummaryDTO.md +22 -0
- data/docs/FileDTO.md +50 -0
- data/docs/FileListDTO.md +24 -0
- data/docs/FileMinimalWithUrlDTO.md +22 -0
- data/docs/FileSmallDTO.md +46 -0
- data/docs/FileUploadDTO.md +22 -0
- data/docs/FileWIthUrlDTO.md +20 -0
- data/docs/FilesSummaryDTO.md +30 -0
- data/docs/ForgotPasswordDTO.md +20 -0
- data/docs/GenreDTO.md +20 -0
- data/docs/GenreMinimalDTO.md +18 -0
- data/docs/GenresSummaryDTO.md +22 -0
- data/docs/InitPutRecordingAudioDTO.md +22 -0
- data/docs/JwtTokenDTO.md +22 -0
- data/docs/LoginDTO.md +24 -0
- data/docs/MusicalFeaturesDTO.md +186 -0
- data/docs/PLineDTO.md +20 -0
- data/docs/PartyApi.md +75 -0
- data/docs/PartyLargeDTO.md +32 -0
- data/docs/PartySmallDTO.md +20 -0
- data/docs/PlaylistApi.md +221 -0
- data/docs/PlaylistLargeDTO.md +38 -0
- data/docs/ProductMediumDTO.md +34 -0
- data/docs/ProductPartyDTO.md +20 -0
- data/docs/RecordingApi.md +789 -0
- data/docs/RecordingForSimilaritySearchDTO.md +20 -0
- data/docs/RecordingGenrePredictionDTO.md +22 -0
- data/docs/RecordingLargeDTO.md +40 -0
- data/docs/RecordingListDTO.md +24 -0
- data/docs/RecordingMediumDTO.md +36 -0
- data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +20 -0
- data/docs/RecordingMinimalWithTaggramsDTO.md +22 -0
- data/docs/RecordingMinimalWithTagstrengthsDTO.md +20 -0
- data/docs/RecordingPartyDTO.md +20 -0
- data/docs/RecordingPlaylistDTO.md +24 -0
- data/docs/RecordingSmallDTO.md +24 -0
- data/docs/RecordingTagSmallDTO.md +18 -0
- data/docs/SaveFileRecordingDTO.md +236 -0
- data/docs/SavePlaylistDTO.md +34 -0
- data/docs/SaveRecordingGenreDTO.md +22 -0
- data/docs/SaveRecordingPartyDTO.md +20 -0
- data/docs/SaveRecordingPlaylistDTO.md +22 -0
- data/docs/SaveRecordingTagDTO.md +20 -0
- data/docs/SaveReferrerDTO.md +20 -0
- data/docs/SaveTaggramsDTO.md +82 -0
- data/docs/SaveUserDTO.md +28 -0
- data/docs/SearchFilterValuesDTO.md +98 -0
- data/docs/SearchRecordingGranularAbstractionDTO.md +20 -0
- data/docs/SearchRecordingGranularDTO.md +20 -0
- data/docs/SignUpDTO.md +24 -0
- data/docs/TagDTO.md +22 -0
- data/docs/TagSmallDTO.md +20 -0
- data/docs/TaggramDTO.md +26 -0
- data/docs/TagsSummaryDTO.md +22 -0
- data/docs/TagstrengthDTO.md +26 -0
- data/docs/TitleDTO.md +18 -0
- data/docs/TokenRequest.md +18 -0
- data/docs/TrackToMediumProductDTO.md +22 -0
- data/docs/UpdatePasswordDTO.md +20 -0
- data/docs/UsageDTO.md +18 -0
- data/docs/UserApi.md +1936 -0
- data/docs/UserDTO.md +56 -0
- data/getspec.rb +10 -0
- data/git_push.sh +57 -0
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +213 -0
- data/lib/songtradr_api_client_ruby/api/party_api.rb +84 -0
- data/lib/songtradr_api_client_ruby/api/playlist_api.rb +222 -0
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +900 -0
- data/lib/songtradr_api_client_ruby/api/user_api.rb +2642 -0
- data/lib/songtradr_api_client_ruby/api_client.rb +428 -0
- data/lib/songtradr_api_client_ruby/api_error.rb +58 -0
- data/lib/songtradr_api_client_ruby/configuration.rb +380 -0
- data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +250 -0
- data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +225 -0
- data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +287 -0
- data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +239 -0
- data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +225 -0
- data/lib/songtradr_api_client_ruby/models/error_response.rb +276 -0
- data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +253 -0
- data/lib/songtradr_api_client_ruby/models/file_dto.rb +450 -0
- data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +269 -0
- data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +253 -0
- data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +432 -0
- data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +244 -0
- data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +239 -0
- data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +287 -0
- data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +267 -0
- data/lib/songtradr_api_client_ruby/models/genre_dto.rb +239 -0
- data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +225 -0
- data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +248 -0
- data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +238 -0
- data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +248 -0
- data/lib/songtradr_api_client_ruby/models/login_dto.rb +257 -0
- data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +1532 -0
- data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +234 -0
- data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +288 -0
- data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +239 -0
- data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +353 -0
- data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +316 -0
- data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +236 -0
- data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +239 -0
- data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +253 -0
- data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +366 -0
- data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +269 -0
- data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +340 -0
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +236 -0
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +248 -0
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +236 -0
- data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +236 -0
- data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +247 -0
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +268 -0
- data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +225 -0
- data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +1847 -0
- data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +350 -0
- data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +243 -0
- data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +273 -0
- data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +248 -0
- data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +234 -0
- data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +229 -0
- data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +574 -0
- data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +317 -0
- data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +867 -0
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +270 -0
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +235 -0
- data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +262 -0
- data/lib/songtradr_api_client_ruby/models/tag_dto.rb +250 -0
- data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +239 -0
- data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +271 -0
- data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +250 -0
- data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +269 -0
- data/lib/songtradr_api_client_ruby/models/title_dto.rb +225 -0
- data/lib/songtradr_api_client_ruby/models/token_request.rb +224 -0
- data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +248 -0
- data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +238 -0
- data/lib/songtradr_api_client_ruby/models/usage_dto.rb +220 -0
- data/lib/songtradr_api_client_ruby/models/user_dto.rb +481 -0
- data/lib/songtradr_api_client_ruby/version.rb +15 -0
- data/lib/songtradr_api_client_ruby.rb +108 -0
- data/openapi-generator-config.yaml +10 -0
- data/songtradr_api_client_ruby.gemspec +39 -0
- data/spec/api/allowed_values_api_spec.rb +68 -0
- data/spec/api/party_api_spec.rb +46 -0
- data/spec/api/playlist_api_spec.rb +72 -0
- data/spec/api/recording_api_spec.rb +192 -0
- data/spec/api/user_api_spec.rb +507 -0
- data/spec/api_client_spec.rb +223 -0
- data/spec/configuration_spec.rb +82 -0
- data/spec/models/category_medium_dto_spec.rb +46 -0
- data/spec/models/category_minimal_dto_spec.rb +34 -0
- data/spec/models/config_access_dto_spec.rb +48 -0
- data/spec/models/config_identifier_dto_spec.rb +40 -0
- data/spec/models/contributor_type_dto_spec.rb +34 -0
- data/spec/models/error_response_spec.rb +58 -0
- data/spec/models/field_summary_dto_spec.rb +46 -0
- data/spec/models/file_dto_spec.rb +142 -0
- data/spec/models/file_list_dto_spec.rb +52 -0
- data/spec/models/file_minimal_with_url_dto_spec.rb +46 -0
- data/spec/models/file_small_dto_spec.rb +130 -0
- data/spec/models/file_upload_dto_spec.rb +46 -0
- data/spec/models/file_w_ith_url_dto_spec.rb +40 -0
- data/spec/models/files_summary_dto_spec.rb +70 -0
- data/spec/models/forgot_password_dto_spec.rb +44 -0
- data/spec/models/genre_dto_spec.rb +40 -0
- data/spec/models/genre_minimal_dto_spec.rb +34 -0
- data/spec/models/genres_summary_dto_spec.rb +46 -0
- data/spec/models/init_put_recording_audio_dto_spec.rb +46 -0
- data/spec/models/jwt_token_dto_spec.rb +46 -0
- data/spec/models/login_dto_spec.rb +52 -0
- data/spec/models/musical_features_dto_spec.rb +706 -0
- data/spec/models/p_line_dto_spec.rb +40 -0
- data/spec/models/party_large_dto_spec.rb +76 -0
- data/spec/models/party_small_dto_spec.rb +40 -0
- data/spec/models/playlist_large_dto_spec.rb +98 -0
- data/spec/models/product_medium_dto_spec.rb +82 -0
- data/spec/models/product_party_dto_spec.rb +40 -0
- data/spec/models/recording_for_similarity_search_dto_spec.rb +40 -0
- data/spec/models/recording_genre_prediction_dto_spec.rb +46 -0
- data/spec/models/recording_large_dto_spec.rb +100 -0
- data/spec/models/recording_list_dto_spec.rb +52 -0
- data/spec/models/recording_medium_dto_spec.rb +88 -0
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +40 -0
- data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +46 -0
- data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +40 -0
- data/spec/models/recording_party_dto_spec.rb +40 -0
- data/spec/models/recording_playlist_dto_spec.rb +52 -0
- data/spec/models/recording_small_dto_spec.rb +52 -0
- data/spec/models/recording_tag_small_dto_spec.rb +34 -0
- data/spec/models/save_file_recording_dto_spec.rb +880 -0
- data/spec/models/save_playlist_dto_spec.rb +86 -0
- data/spec/models/save_recording_genre_dto_spec.rb +46 -0
- data/spec/models/save_recording_party_dto_spec.rb +44 -0
- data/spec/models/save_recording_playlist_dto_spec.rb +46 -0
- data/spec/models/save_recording_tag_dto_spec.rb +40 -0
- data/spec/models/save_referrer_dto_spec.rb +40 -0
- data/spec/models/save_taggrams_dto_spec.rb +226 -0
- data/spec/models/save_user_dto_spec.rb +72 -0
- data/spec/models/search_filter_values_dto_spec.rb +274 -0
- data/spec/models/search_recording_granular_abstraction_dto_spec.rb +44 -0
- data/spec/models/search_recording_granular_dto_spec.rb +40 -0
- data/spec/models/sign_up_dto_spec.rb +52 -0
- data/spec/models/tag_dto_spec.rb +46 -0
- data/spec/models/tag_small_dto_spec.rb +40 -0
- data/spec/models/taggram_dto_spec.rb +58 -0
- data/spec/models/tags_summary_dto_spec.rb +46 -0
- data/spec/models/tagstrength_dto_spec.rb +58 -0
- data/spec/models/title_dto_spec.rb +34 -0
- data/spec/models/token_request_spec.rb +34 -0
- data/spec/models/track_to_medium_product_dto_spec.rb +46 -0
- data/spec/models/update_password_dto_spec.rb +40 -0
- data/spec/models/usage_dto_spec.rb +34 -0
- data/spec/models/user_dto_spec.rb +148 -0
- data/spec/spec_helper.rb +111 -0
- metadata +412 -0
data/docs/UserApi.md
ADDED
|
@@ -0,0 +1,1936 @@
|
|
|
1
|
+
# SongtradrApiClientRuby::UserApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.songtradr.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_user_referrer**](UserApi.md#create_user_referrer) | **POST** /api/v1/user/referrers/new | |
|
|
8
|
+
| [**delete_user_file**](UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file. |
|
|
9
|
+
| [**edit_me**](UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user |
|
|
10
|
+
| [**forgot_password**](UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email |
|
|
11
|
+
| [**initiate_user_file_upload**](UserApi.md#initiate_user_file_upload) | **POST** /api/v1/user/file/{name}/initUpload | Initialize a file upload. Responds with an URL where the file can be uploaded. |
|
|
12
|
+
| [**login**](UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token. |
|
|
13
|
+
| [**me**](UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user |
|
|
14
|
+
| [**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. |
|
|
15
|
+
| [**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. |
|
|
16
|
+
| [**save_playlist**](UserApi.md#save_playlist) | **POST** /api/v1/user/savePlaylist | List, search and create playlist of your own files. |
|
|
17
|
+
| [**sign_up**](UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user. |
|
|
18
|
+
| [**token**](UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token |
|
|
19
|
+
| [**update_password**](UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token |
|
|
20
|
+
| [**update_user_file_recording**](UserApi.md#update_user_file_recording) | **POST** /api/v1/user/file/{objectKey} | Create and edit metadata of your files. |
|
|
21
|
+
| [**user_file**](UserApi.md#user_file) | **GET** /api/v1/user/file/{objectKey} | Details and a download link for a file. |
|
|
22
|
+
| [**user_files**](UserApi.md#user_files) | **GET** /api/v1/user/files | List and search your own files. |
|
|
23
|
+
| [**user_files_download**](UserApi.md#user_files_download) | **GET** /api/v1/user/filesDownload | Download links for your files |
|
|
24
|
+
| [**user_files_status**](UserApi.md#user_files_status) | **GET** /api/v1/user/filesStatus | Status details for files. |
|
|
25
|
+
| [**user_files_summary**](UserApi.md#user_files_summary) | **GET** /api/v1/user/filesSummary | Summary fo your files. |
|
|
26
|
+
| [**user_folders**](UserApi.md#user_folders) | **GET** /api/v1/user/folders | Your Folders |
|
|
27
|
+
| [**user_referrers**](UserApi.md#user_referrers) | **GET** /api/v1/user/referrers/{username} | |
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
## create_user_referrer
|
|
31
|
+
|
|
32
|
+
> Object create_user_referrer(save_referrer_dto)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### Examples
|
|
37
|
+
|
|
38
|
+
```ruby
|
|
39
|
+
require 'time'
|
|
40
|
+
require 'songtradr_api_client_ruby'
|
|
41
|
+
# setup authorization
|
|
42
|
+
SongtradrApiClientRuby.configure do |config|
|
|
43
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
44
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
48
|
+
save_referrer_dto = SongtradrApiClientRuby::SaveReferrerDTO.new # SaveReferrerDTO |
|
|
49
|
+
|
|
50
|
+
begin
|
|
51
|
+
|
|
52
|
+
result = api_instance.create_user_referrer(save_referrer_dto)
|
|
53
|
+
p result
|
|
54
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
55
|
+
puts "Error when calling UserApi->create_user_referrer: #{e}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### Using the create_user_referrer_with_http_info variant
|
|
60
|
+
|
|
61
|
+
This returns an Array which contains the response data, status code and headers.
|
|
62
|
+
|
|
63
|
+
> <Array(Object, Integer, Hash)> create_user_referrer_with_http_info(save_referrer_dto)
|
|
64
|
+
|
|
65
|
+
```ruby
|
|
66
|
+
begin
|
|
67
|
+
|
|
68
|
+
data, status_code, headers = api_instance.create_user_referrer_with_http_info(save_referrer_dto)
|
|
69
|
+
p status_code # => 2xx
|
|
70
|
+
p headers # => { ... }
|
|
71
|
+
p data # => Object
|
|
72
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
73
|
+
puts "Error when calling UserApi->create_user_referrer_with_http_info: #{e}"
|
|
74
|
+
end
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Parameters
|
|
78
|
+
|
|
79
|
+
| Name | Type | Description | Notes |
|
|
80
|
+
| ---- | ---- | ----------- | ----- |
|
|
81
|
+
| **save_referrer_dto** | [**SaveReferrerDTO**](SaveReferrerDTO.md) | | |
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
**Object**
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: application/json
|
|
94
|
+
- **Accept**: application/json
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
## delete_user_file
|
|
98
|
+
|
|
99
|
+
> Object delete_user_file(object_key)
|
|
100
|
+
|
|
101
|
+
Delete file.
|
|
102
|
+
|
|
103
|
+
### Examples
|
|
104
|
+
|
|
105
|
+
```ruby
|
|
106
|
+
require 'time'
|
|
107
|
+
require 'songtradr_api_client_ruby'
|
|
108
|
+
# setup authorization
|
|
109
|
+
SongtradrApiClientRuby.configure do |config|
|
|
110
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
111
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
115
|
+
object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be deleted.
|
|
116
|
+
|
|
117
|
+
begin
|
|
118
|
+
# Delete file.
|
|
119
|
+
result = api_instance.delete_user_file(object_key)
|
|
120
|
+
p result
|
|
121
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
122
|
+
puts "Error when calling UserApi->delete_user_file: #{e}"
|
|
123
|
+
end
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
#### Using the delete_user_file_with_http_info variant
|
|
127
|
+
|
|
128
|
+
This returns an Array which contains the response data, status code and headers.
|
|
129
|
+
|
|
130
|
+
> <Array(Object, Integer, Hash)> delete_user_file_with_http_info(object_key)
|
|
131
|
+
|
|
132
|
+
```ruby
|
|
133
|
+
begin
|
|
134
|
+
# Delete file.
|
|
135
|
+
data, status_code, headers = api_instance.delete_user_file_with_http_info(object_key)
|
|
136
|
+
p status_code # => 2xx
|
|
137
|
+
p headers # => { ... }
|
|
138
|
+
p data # => Object
|
|
139
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
140
|
+
puts "Error when calling UserApi->delete_user_file_with_http_info: #{e}"
|
|
141
|
+
end
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
| Name | Type | Description | Notes |
|
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
|
148
|
+
| **object_key** | **String** | ObjectKey of the file that should be deleted. | |
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
**Object**
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: Not defined
|
|
161
|
+
- **Accept**: application/hal+json, application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
## edit_me
|
|
165
|
+
|
|
166
|
+
> Object edit_me(save_user_dto)
|
|
167
|
+
|
|
168
|
+
Edit details for a logged-in user
|
|
169
|
+
|
|
170
|
+
### Examples
|
|
171
|
+
|
|
172
|
+
```ruby
|
|
173
|
+
require 'time'
|
|
174
|
+
require 'songtradr_api_client_ruby'
|
|
175
|
+
# setup authorization
|
|
176
|
+
SongtradrApiClientRuby.configure do |config|
|
|
177
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
178
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
182
|
+
save_user_dto = SongtradrApiClientRuby::SaveUserDTO.new({email_address: 'email_address_example'}) # SaveUserDTO |
|
|
183
|
+
|
|
184
|
+
begin
|
|
185
|
+
# Edit details for a logged-in user
|
|
186
|
+
result = api_instance.edit_me(save_user_dto)
|
|
187
|
+
p result
|
|
188
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
189
|
+
puts "Error when calling UserApi->edit_me: #{e}"
|
|
190
|
+
end
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
#### Using the edit_me_with_http_info variant
|
|
194
|
+
|
|
195
|
+
This returns an Array which contains the response data, status code and headers.
|
|
196
|
+
|
|
197
|
+
> <Array(Object, Integer, Hash)> edit_me_with_http_info(save_user_dto)
|
|
198
|
+
|
|
199
|
+
```ruby
|
|
200
|
+
begin
|
|
201
|
+
# Edit details for a logged-in user
|
|
202
|
+
data, status_code, headers = api_instance.edit_me_with_http_info(save_user_dto)
|
|
203
|
+
p status_code # => 2xx
|
|
204
|
+
p headers # => { ... }
|
|
205
|
+
p data # => Object
|
|
206
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
207
|
+
puts "Error when calling UserApi->edit_me_with_http_info: #{e}"
|
|
208
|
+
end
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Parameters
|
|
212
|
+
|
|
213
|
+
| Name | Type | Description | Notes |
|
|
214
|
+
| ---- | ---- | ----------- | ----- |
|
|
215
|
+
| **save_user_dto** | [**SaveUserDTO**](SaveUserDTO.md) | | |
|
|
216
|
+
|
|
217
|
+
### Return type
|
|
218
|
+
|
|
219
|
+
**Object**
|
|
220
|
+
|
|
221
|
+
### Authorization
|
|
222
|
+
|
|
223
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
224
|
+
|
|
225
|
+
### HTTP request headers
|
|
226
|
+
|
|
227
|
+
- **Content-Type**: application/json
|
|
228
|
+
- **Accept**: application/json
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
## forgot_password
|
|
232
|
+
|
|
233
|
+
> Object forgot_password(forgot_password_dto)
|
|
234
|
+
|
|
235
|
+
Send a password reset email
|
|
236
|
+
|
|
237
|
+
### Examples
|
|
238
|
+
|
|
239
|
+
```ruby
|
|
240
|
+
require 'time'
|
|
241
|
+
require 'songtradr_api_client_ruby'
|
|
242
|
+
# setup authorization
|
|
243
|
+
SongtradrApiClientRuby.configure do |config|
|
|
244
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
245
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
249
|
+
forgot_password_dto = SongtradrApiClientRuby::ForgotPasswordDTO.new({email_or_username: 'email_or_username_example'}) # ForgotPasswordDTO |
|
|
250
|
+
|
|
251
|
+
begin
|
|
252
|
+
# Send a password reset email
|
|
253
|
+
result = api_instance.forgot_password(forgot_password_dto)
|
|
254
|
+
p result
|
|
255
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
256
|
+
puts "Error when calling UserApi->forgot_password: #{e}"
|
|
257
|
+
end
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
#### Using the forgot_password_with_http_info variant
|
|
261
|
+
|
|
262
|
+
This returns an Array which contains the response data, status code and headers.
|
|
263
|
+
|
|
264
|
+
> <Array(Object, Integer, Hash)> forgot_password_with_http_info(forgot_password_dto)
|
|
265
|
+
|
|
266
|
+
```ruby
|
|
267
|
+
begin
|
|
268
|
+
# Send a password reset email
|
|
269
|
+
data, status_code, headers = api_instance.forgot_password_with_http_info(forgot_password_dto)
|
|
270
|
+
p status_code # => 2xx
|
|
271
|
+
p headers # => { ... }
|
|
272
|
+
p data # => Object
|
|
273
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
274
|
+
puts "Error when calling UserApi->forgot_password_with_http_info: #{e}"
|
|
275
|
+
end
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
### Parameters
|
|
279
|
+
|
|
280
|
+
| Name | Type | Description | Notes |
|
|
281
|
+
| ---- | ---- | ----------- | ----- |
|
|
282
|
+
| **forgot_password_dto** | [**ForgotPasswordDTO**](ForgotPasswordDTO.md) | | |
|
|
283
|
+
|
|
284
|
+
### Return type
|
|
285
|
+
|
|
286
|
+
**Object**
|
|
287
|
+
|
|
288
|
+
### Authorization
|
|
289
|
+
|
|
290
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
291
|
+
|
|
292
|
+
### HTTP request headers
|
|
293
|
+
|
|
294
|
+
- **Content-Type**: application/json
|
|
295
|
+
- **Accept**: application/hal+json, application/json
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
## initiate_user_file_upload
|
|
299
|
+
|
|
300
|
+
> <InitPutRecordingAudioDTO> initiate_user_file_upload(name, folder, opts)
|
|
301
|
+
|
|
302
|
+
Initialize a file upload. Responds with an URL where the file can be uploaded.
|
|
303
|
+
|
|
304
|
+
### Examples
|
|
305
|
+
|
|
306
|
+
```ruby
|
|
307
|
+
require 'time'
|
|
308
|
+
require 'songtradr_api_client_ruby'
|
|
309
|
+
# setup authorization
|
|
310
|
+
SongtradrApiClientRuby.configure do |config|
|
|
311
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
312
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
313
|
+
end
|
|
314
|
+
|
|
315
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
316
|
+
name = 'FileName.mp3' # String | The Name of the file that will be uploaded
|
|
317
|
+
folder = 'FolderName' # String | The Name of the folder that the file will be placed in
|
|
318
|
+
opts = {
|
|
319
|
+
file_upload_dto: SongtradrApiClientRuby::FileUploadDTO.new # FileUploadDTO |
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
begin
|
|
323
|
+
# Initialize a file upload. Responds with an URL where the file can be uploaded.
|
|
324
|
+
result = api_instance.initiate_user_file_upload(name, folder, opts)
|
|
325
|
+
p result
|
|
326
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
327
|
+
puts "Error when calling UserApi->initiate_user_file_upload: #{e}"
|
|
328
|
+
end
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
#### Using the initiate_user_file_upload_with_http_info variant
|
|
332
|
+
|
|
333
|
+
This returns an Array which contains the response data, status code and headers.
|
|
334
|
+
|
|
335
|
+
> <Array(<InitPutRecordingAudioDTO>, Integer, Hash)> initiate_user_file_upload_with_http_info(name, folder, opts)
|
|
336
|
+
|
|
337
|
+
```ruby
|
|
338
|
+
begin
|
|
339
|
+
# Initialize a file upload. Responds with an URL where the file can be uploaded.
|
|
340
|
+
data, status_code, headers = api_instance.initiate_user_file_upload_with_http_info(name, folder, opts)
|
|
341
|
+
p status_code # => 2xx
|
|
342
|
+
p headers # => { ... }
|
|
343
|
+
p data # => <InitPutRecordingAudioDTO>
|
|
344
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
345
|
+
puts "Error when calling UserApi->initiate_user_file_upload_with_http_info: #{e}"
|
|
346
|
+
end
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### Parameters
|
|
350
|
+
|
|
351
|
+
| Name | Type | Description | Notes |
|
|
352
|
+
| ---- | ---- | ----------- | ----- |
|
|
353
|
+
| **name** | **String** | The Name of the file that will be uploaded | |
|
|
354
|
+
| **folder** | **String** | The Name of the folder that the file will be placed in | |
|
|
355
|
+
| **file_upload_dto** | [**FileUploadDTO**](FileUploadDTO.md) | | [optional] |
|
|
356
|
+
|
|
357
|
+
### Return type
|
|
358
|
+
|
|
359
|
+
[**InitPutRecordingAudioDTO**](InitPutRecordingAudioDTO.md)
|
|
360
|
+
|
|
361
|
+
### Authorization
|
|
362
|
+
|
|
363
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
364
|
+
|
|
365
|
+
### HTTP request headers
|
|
366
|
+
|
|
367
|
+
- **Content-Type**: application/json
|
|
368
|
+
- **Accept**: application/json
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
## login
|
|
372
|
+
|
|
373
|
+
> <JwtTokenDTO> login(login_dto)
|
|
374
|
+
|
|
375
|
+
Login to generate a bearer token.
|
|
376
|
+
|
|
377
|
+
### Examples
|
|
378
|
+
|
|
379
|
+
```ruby
|
|
380
|
+
require 'time'
|
|
381
|
+
require 'songtradr_api_client_ruby'
|
|
382
|
+
# setup authorization
|
|
383
|
+
SongtradrApiClientRuby.configure do |config|
|
|
384
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
385
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
386
|
+
end
|
|
387
|
+
|
|
388
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
389
|
+
login_dto = SongtradrApiClientRuby::LoginDTO.new({email: 'email_example', password: 'password_example'}) # LoginDTO |
|
|
390
|
+
|
|
391
|
+
begin
|
|
392
|
+
# Login to generate a bearer token.
|
|
393
|
+
result = api_instance.login(login_dto)
|
|
394
|
+
p result
|
|
395
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
396
|
+
puts "Error when calling UserApi->login: #{e}"
|
|
397
|
+
end
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
#### Using the login_with_http_info variant
|
|
401
|
+
|
|
402
|
+
This returns an Array which contains the response data, status code and headers.
|
|
403
|
+
|
|
404
|
+
> <Array(<JwtTokenDTO>, Integer, Hash)> login_with_http_info(login_dto)
|
|
405
|
+
|
|
406
|
+
```ruby
|
|
407
|
+
begin
|
|
408
|
+
# Login to generate a bearer token.
|
|
409
|
+
data, status_code, headers = api_instance.login_with_http_info(login_dto)
|
|
410
|
+
p status_code # => 2xx
|
|
411
|
+
p headers # => { ... }
|
|
412
|
+
p data # => <JwtTokenDTO>
|
|
413
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
414
|
+
puts "Error when calling UserApi->login_with_http_info: #{e}"
|
|
415
|
+
end
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
### Parameters
|
|
419
|
+
|
|
420
|
+
| Name | Type | Description | Notes |
|
|
421
|
+
| ---- | ---- | ----------- | ----- |
|
|
422
|
+
| **login_dto** | [**LoginDTO**](LoginDTO.md) | | |
|
|
423
|
+
|
|
424
|
+
### Return type
|
|
425
|
+
|
|
426
|
+
[**JwtTokenDTO**](JwtTokenDTO.md)
|
|
427
|
+
|
|
428
|
+
### Authorization
|
|
429
|
+
|
|
430
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
431
|
+
|
|
432
|
+
### HTTP request headers
|
|
433
|
+
|
|
434
|
+
- **Content-Type**: application/json
|
|
435
|
+
- **Accept**: application/json
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
## me
|
|
439
|
+
|
|
440
|
+
> <UserDTO> me
|
|
441
|
+
|
|
442
|
+
Details for a logged-in user
|
|
443
|
+
|
|
444
|
+
### Examples
|
|
445
|
+
|
|
446
|
+
```ruby
|
|
447
|
+
require 'time'
|
|
448
|
+
require 'songtradr_api_client_ruby'
|
|
449
|
+
# setup authorization
|
|
450
|
+
SongtradrApiClientRuby.configure do |config|
|
|
451
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
452
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
453
|
+
end
|
|
454
|
+
|
|
455
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
456
|
+
|
|
457
|
+
begin
|
|
458
|
+
# Details for a logged-in user
|
|
459
|
+
result = api_instance.me
|
|
460
|
+
p result
|
|
461
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
462
|
+
puts "Error when calling UserApi->me: #{e}"
|
|
463
|
+
end
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
#### Using the me_with_http_info variant
|
|
467
|
+
|
|
468
|
+
This returns an Array which contains the response data, status code and headers.
|
|
469
|
+
|
|
470
|
+
> <Array(<UserDTO>, Integer, Hash)> me_with_http_info
|
|
471
|
+
|
|
472
|
+
```ruby
|
|
473
|
+
begin
|
|
474
|
+
# Details for a logged-in user
|
|
475
|
+
data, status_code, headers = api_instance.me_with_http_info
|
|
476
|
+
p status_code # => 2xx
|
|
477
|
+
p headers # => { ... }
|
|
478
|
+
p data # => <UserDTO>
|
|
479
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
480
|
+
puts "Error when calling UserApi->me_with_http_info: #{e}"
|
|
481
|
+
end
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Parameters
|
|
485
|
+
|
|
486
|
+
This endpoint does not need any parameter.
|
|
487
|
+
|
|
488
|
+
### Return type
|
|
489
|
+
|
|
490
|
+
[**UserDTO**](UserDTO.md)
|
|
491
|
+
|
|
492
|
+
### Authorization
|
|
493
|
+
|
|
494
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
495
|
+
|
|
496
|
+
### HTTP request headers
|
|
497
|
+
|
|
498
|
+
- **Content-Type**: Not defined
|
|
499
|
+
- **Accept**: application/json
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
## recordings_by_folder_with_taggrams
|
|
503
|
+
|
|
504
|
+
> <Array<RecordingMinimalWithTaggramsDTO>> recordings_by_folder_with_taggrams(folder_name, opts)
|
|
505
|
+
|
|
506
|
+
Timeseries of AI generated moods, musical features and more for recordings in your folder.
|
|
507
|
+
|
|
508
|
+
### Examples
|
|
509
|
+
|
|
510
|
+
```ruby
|
|
511
|
+
require 'time'
|
|
512
|
+
require 'songtradr_api_client_ruby'
|
|
513
|
+
# setup authorization
|
|
514
|
+
SongtradrApiClientRuby.configure do |config|
|
|
515
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
516
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
520
|
+
folder_name = 'Default' # String | Folder name
|
|
521
|
+
opts = {
|
|
522
|
+
category_name: 'instrument', # String | Show only taggrams for one category.
|
|
523
|
+
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
|
524
|
+
genre_name: 'Ska', # String | Show only taggrams for one genre.
|
|
525
|
+
from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
|
|
526
|
+
fill_with_zero: true, # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
|
|
527
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
|
528
|
+
size: 56, # Integer | The size of the page to be returned
|
|
529
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
begin
|
|
533
|
+
# Timeseries of AI generated moods, musical features and more for recordings in your folder.
|
|
534
|
+
result = api_instance.recordings_by_folder_with_taggrams(folder_name, opts)
|
|
535
|
+
p result
|
|
536
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
537
|
+
puts "Error when calling UserApi->recordings_by_folder_with_taggrams: #{e}"
|
|
538
|
+
end
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
#### Using the recordings_by_folder_with_taggrams_with_http_info variant
|
|
542
|
+
|
|
543
|
+
This returns an Array which contains the response data, status code and headers.
|
|
544
|
+
|
|
545
|
+
> <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)> recordings_by_folder_with_taggrams_with_http_info(folder_name, opts)
|
|
546
|
+
|
|
547
|
+
```ruby
|
|
548
|
+
begin
|
|
549
|
+
# Timeseries of AI generated moods, musical features and more for recordings in your folder.
|
|
550
|
+
data, status_code, headers = api_instance.recordings_by_folder_with_taggrams_with_http_info(folder_name, opts)
|
|
551
|
+
p status_code # => 2xx
|
|
552
|
+
p headers # => { ... }
|
|
553
|
+
p data # => <Array<RecordingMinimalWithTaggramsDTO>>
|
|
554
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
555
|
+
puts "Error when calling UserApi->recordings_by_folder_with_taggrams_with_http_info: #{e}"
|
|
556
|
+
end
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
### Parameters
|
|
560
|
+
|
|
561
|
+
| Name | Type | Description | Notes |
|
|
562
|
+
| ---- | ---- | ----------- | ----- |
|
|
563
|
+
| **folder_name** | **String** | Folder name | |
|
|
564
|
+
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
|
565
|
+
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
|
566
|
+
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
|
567
|
+
| **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
|
|
568
|
+
| **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [optional] |
|
|
569
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
570
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
571
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
572
|
+
|
|
573
|
+
### Return type
|
|
574
|
+
|
|
575
|
+
[**Array<RecordingMinimalWithTaggramsDTO>**](RecordingMinimalWithTaggramsDTO.md)
|
|
576
|
+
|
|
577
|
+
### Authorization
|
|
578
|
+
|
|
579
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
580
|
+
|
|
581
|
+
### HTTP request headers
|
|
582
|
+
|
|
583
|
+
- **Content-Type**: Not defined
|
|
584
|
+
- **Accept**: application/json
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
## recordings_by_folder_with_tagstrengths
|
|
588
|
+
|
|
589
|
+
> <Array<RecordingMinimalWithTagstrengthsDTO>> recordings_by_folder_with_tagstrengths(folder_name, opts)
|
|
590
|
+
|
|
591
|
+
Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
|
|
592
|
+
|
|
593
|
+
### Examples
|
|
594
|
+
|
|
595
|
+
```ruby
|
|
596
|
+
require 'time'
|
|
597
|
+
require 'songtradr_api_client_ruby'
|
|
598
|
+
# setup authorization
|
|
599
|
+
SongtradrApiClientRuby.configure do |config|
|
|
600
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
601
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
602
|
+
end
|
|
603
|
+
|
|
604
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
605
|
+
folder_name = 'Default' # String | Folder name
|
|
606
|
+
opts = {
|
|
607
|
+
category_name: 'instrument', # String | Show only taggrams for one category.
|
|
608
|
+
tag_name: 'energetic', # String | Show only taggrams for one tag.
|
|
609
|
+
genre_name: 'Ska', # String | Show only taggrams for one genre.
|
|
610
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
|
611
|
+
size: 56, # Integer | The size of the page to be returned
|
|
612
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
begin
|
|
616
|
+
# Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
|
|
617
|
+
result = api_instance.recordings_by_folder_with_tagstrengths(folder_name, opts)
|
|
618
|
+
p result
|
|
619
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
620
|
+
puts "Error when calling UserApi->recordings_by_folder_with_tagstrengths: #{e}"
|
|
621
|
+
end
|
|
622
|
+
```
|
|
623
|
+
|
|
624
|
+
#### Using the recordings_by_folder_with_tagstrengths_with_http_info variant
|
|
625
|
+
|
|
626
|
+
This returns an Array which contains the response data, status code and headers.
|
|
627
|
+
|
|
628
|
+
> <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)> recordings_by_folder_with_tagstrengths_with_http_info(folder_name, opts)
|
|
629
|
+
|
|
630
|
+
```ruby
|
|
631
|
+
begin
|
|
632
|
+
# Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
|
|
633
|
+
data, status_code, headers = api_instance.recordings_by_folder_with_tagstrengths_with_http_info(folder_name, opts)
|
|
634
|
+
p status_code # => 2xx
|
|
635
|
+
p headers # => { ... }
|
|
636
|
+
p data # => <Array<RecordingMinimalWithTagstrengthsDTO>>
|
|
637
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
638
|
+
puts "Error when calling UserApi->recordings_by_folder_with_tagstrengths_with_http_info: #{e}"
|
|
639
|
+
end
|
|
640
|
+
```
|
|
641
|
+
|
|
642
|
+
### Parameters
|
|
643
|
+
|
|
644
|
+
| Name | Type | Description | Notes |
|
|
645
|
+
| ---- | ---- | ----------- | ----- |
|
|
646
|
+
| **folder_name** | **String** | Folder name | |
|
|
647
|
+
| **category_name** | **String** | Show only taggrams for one category. | [optional] |
|
|
648
|
+
| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
|
|
649
|
+
| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
|
|
650
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
651
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
652
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
653
|
+
|
|
654
|
+
### Return type
|
|
655
|
+
|
|
656
|
+
[**Array<RecordingMinimalWithTagstrengthsDTO>**](RecordingMinimalWithTagstrengthsDTO.md)
|
|
657
|
+
|
|
658
|
+
### Authorization
|
|
659
|
+
|
|
660
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
661
|
+
|
|
662
|
+
### HTTP request headers
|
|
663
|
+
|
|
664
|
+
- **Content-Type**: Not defined
|
|
665
|
+
- **Accept**: application/json
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
## save_playlist
|
|
669
|
+
|
|
670
|
+
> <FileListDTO> save_playlist(opts)
|
|
671
|
+
|
|
672
|
+
List, search and create playlist of your own files.
|
|
673
|
+
|
|
674
|
+
### Examples
|
|
675
|
+
|
|
676
|
+
```ruby
|
|
677
|
+
require 'time'
|
|
678
|
+
require 'songtradr_api_client_ruby'
|
|
679
|
+
# setup authorization
|
|
680
|
+
SongtradrApiClientRuby.configure do |config|
|
|
681
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
682
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
683
|
+
end
|
|
684
|
+
|
|
685
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
686
|
+
opts = {
|
|
687
|
+
isrc: 'USUM71703692', # String | Search for a ISRC
|
|
688
|
+
contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
|
|
689
|
+
main_artist: 'The Beatles', # String | Search for a main artist.
|
|
690
|
+
composer: 'John Cale', # String | Search for a composer.
|
|
691
|
+
title: 'Highway To Hell', # String | Search for a title.
|
|
692
|
+
language: 'en', # String | Search for a language of the lyrics.
|
|
693
|
+
genre_names: ['inner_example'], # Array<String> |
|
|
694
|
+
tag_names: ['inner_example'], # Array<String> |
|
|
695
|
+
release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
696
|
+
primary_mood_cluster: 'aggressive', # String |
|
|
697
|
+
secondary_mood_cluster: 'aggressive', # String |
|
|
698
|
+
tertiary_mood_cluster: 'aggressive', # String |
|
|
699
|
+
valence: 'very sad', # String |
|
|
700
|
+
arousal: 'very calm', # String |
|
|
701
|
+
pleasantness: 'very unpleasant', # String |
|
|
702
|
+
engagement: 'very unengaging', # String |
|
|
703
|
+
vocals: 'instrumental', # String |
|
|
704
|
+
dominant_instrument: 'electric guitar', # String |
|
|
705
|
+
secondary_instrument: 'electric guitar', # String |
|
|
706
|
+
tertiary_instrument: 'electric guitar', # String |
|
|
707
|
+
energy: 'very quiet', # String |
|
|
708
|
+
sound_generation: 'acoustic', # String |
|
|
709
|
+
tempo: 'very slow', # String |
|
|
710
|
+
scale: 'major key', # String |
|
|
711
|
+
rhythm: 'common time', # String |
|
|
712
|
+
primary_sound_character: 'aggressive', # String |
|
|
713
|
+
timbre: 'very warm', # String |
|
|
714
|
+
roughness: 'very clear', # String |
|
|
715
|
+
tonality: 'monotonous', # String |
|
|
716
|
+
harmony: 'very dissonant', # String |
|
|
717
|
+
texture: 'very thin', # String |
|
|
718
|
+
groovyness: 'very steady', # String |
|
|
719
|
+
space: 'very compact', # String |
|
|
720
|
+
production_rating: 'low production quality', # String |
|
|
721
|
+
performance_rating: 'low performance quality', # String |
|
|
722
|
+
song_rating: 'low song quality', # String |
|
|
723
|
+
audience_age: 'Generation Z', # String |
|
|
724
|
+
audience_region: 'Australia and New Zealand', # String |
|
|
725
|
+
audience_gender: 'male', # String |
|
|
726
|
+
origin_decade: 'pre-1950s', # String |
|
|
727
|
+
curateability: 'curateable', # String |
|
|
728
|
+
use_case: 'background', # String |
|
|
729
|
+
channel_suitability: 'Spotify', # String |
|
|
730
|
+
similar_to_recording: 'similar_to_recording_example', # String |
|
|
731
|
+
create_playlist_with_name: 'PlaylistName', # String |
|
|
732
|
+
songtradr_track_id: 'songtradr_track_id_example', # String |
|
|
733
|
+
usage_name: 'usage_name_example', # String |
|
|
734
|
+
bpm_min: 50, # Integer | Search for a minimal bpm.
|
|
735
|
+
bpm_max: 210, # Integer | Search for a maximal bpm.
|
|
736
|
+
name: 'Groove.mp3', # String | Search for a file name.
|
|
737
|
+
folder: 'defaultFolder', # String | Search for a folder.
|
|
738
|
+
extension: '.mp3', # String | Search for a file extension.
|
|
739
|
+
upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
740
|
+
min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
741
|
+
max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
742
|
+
fingerprint_status: 'done', # String | Search for a fingerprint status.
|
|
743
|
+
inference_status: 'done', # String | Search for a inference status.
|
|
744
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
|
745
|
+
size: 56, # Integer | The size of the page to be returned
|
|
746
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
begin
|
|
750
|
+
# List, search and create playlist of your own files.
|
|
751
|
+
result = api_instance.save_playlist(opts)
|
|
752
|
+
p result
|
|
753
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
754
|
+
puts "Error when calling UserApi->save_playlist: #{e}"
|
|
755
|
+
end
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
#### Using the save_playlist_with_http_info variant
|
|
759
|
+
|
|
760
|
+
This returns an Array which contains the response data, status code and headers.
|
|
761
|
+
|
|
762
|
+
> <Array(<FileListDTO>, Integer, Hash)> save_playlist_with_http_info(opts)
|
|
763
|
+
|
|
764
|
+
```ruby
|
|
765
|
+
begin
|
|
766
|
+
# List, search and create playlist of your own files.
|
|
767
|
+
data, status_code, headers = api_instance.save_playlist_with_http_info(opts)
|
|
768
|
+
p status_code # => 2xx
|
|
769
|
+
p headers # => { ... }
|
|
770
|
+
p data # => <FileListDTO>
|
|
771
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
772
|
+
puts "Error when calling UserApi->save_playlist_with_http_info: #{e}"
|
|
773
|
+
end
|
|
774
|
+
```
|
|
775
|
+
|
|
776
|
+
### Parameters
|
|
777
|
+
|
|
778
|
+
| Name | Type | Description | Notes |
|
|
779
|
+
| ---- | ---- | ----------- | ----- |
|
|
780
|
+
| **isrc** | **String** | Search for a ISRC | [optional] |
|
|
781
|
+
| **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
|
|
782
|
+
| **main_artist** | **String** | Search for a main artist. | [optional] |
|
|
783
|
+
| **composer** | **String** | Search for a composer. | [optional] |
|
|
784
|
+
| **title** | **String** | Search for a title. | [optional] |
|
|
785
|
+
| **language** | **String** | Search for a language of the lyrics. | [optional] |
|
|
786
|
+
| **genre_names** | [**Array<String>**](String.md) | | [optional] |
|
|
787
|
+
| **tag_names** | [**Array<String>**](String.md) | | [optional] |
|
|
788
|
+
| **release_date** | **Time** | | [optional] |
|
|
789
|
+
| **primary_mood_cluster** | **String** | | [optional] |
|
|
790
|
+
| **secondary_mood_cluster** | **String** | | [optional] |
|
|
791
|
+
| **tertiary_mood_cluster** | **String** | | [optional] |
|
|
792
|
+
| **valence** | **String** | | [optional] |
|
|
793
|
+
| **arousal** | **String** | | [optional] |
|
|
794
|
+
| **pleasantness** | **String** | | [optional] |
|
|
795
|
+
| **engagement** | **String** | | [optional] |
|
|
796
|
+
| **vocals** | **String** | | [optional] |
|
|
797
|
+
| **dominant_instrument** | **String** | | [optional] |
|
|
798
|
+
| **secondary_instrument** | **String** | | [optional] |
|
|
799
|
+
| **tertiary_instrument** | **String** | | [optional] |
|
|
800
|
+
| **energy** | **String** | | [optional] |
|
|
801
|
+
| **sound_generation** | **String** | | [optional] |
|
|
802
|
+
| **tempo** | **String** | | [optional] |
|
|
803
|
+
| **scale** | **String** | | [optional] |
|
|
804
|
+
| **rhythm** | **String** | | [optional] |
|
|
805
|
+
| **primary_sound_character** | **String** | | [optional] |
|
|
806
|
+
| **timbre** | **String** | | [optional] |
|
|
807
|
+
| **roughness** | **String** | | [optional] |
|
|
808
|
+
| **tonality** | **String** | | [optional] |
|
|
809
|
+
| **harmony** | **String** | | [optional] |
|
|
810
|
+
| **texture** | **String** | | [optional] |
|
|
811
|
+
| **groovyness** | **String** | | [optional] |
|
|
812
|
+
| **space** | **String** | | [optional] |
|
|
813
|
+
| **production_rating** | **String** | | [optional] |
|
|
814
|
+
| **performance_rating** | **String** | | [optional] |
|
|
815
|
+
| **song_rating** | **String** | | [optional] |
|
|
816
|
+
| **audience_age** | **String** | | [optional] |
|
|
817
|
+
| **audience_region** | **String** | | [optional] |
|
|
818
|
+
| **audience_gender** | **String** | | [optional] |
|
|
819
|
+
| **origin_decade** | **String** | | [optional] |
|
|
820
|
+
| **curateability** | **String** | | [optional] |
|
|
821
|
+
| **use_case** | **String** | | [optional] |
|
|
822
|
+
| **channel_suitability** | **String** | | [optional] |
|
|
823
|
+
| **similar_to_recording** | **String** | | [optional] |
|
|
824
|
+
| **create_playlist_with_name** | **String** | | [optional] |
|
|
825
|
+
| **songtradr_track_id** | **String** | | [optional] |
|
|
826
|
+
| **usage_name** | **String** | | [optional] |
|
|
827
|
+
| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
|
|
828
|
+
| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
|
|
829
|
+
| **name** | **String** | Search for a file name. | [optional] |
|
|
830
|
+
| **folder** | **String** | Search for a folder. | [optional] |
|
|
831
|
+
| **extension** | **String** | Search for a file extension. | [optional] |
|
|
832
|
+
| **upload_end_time** | **Time** | | [optional] |
|
|
833
|
+
| **min_upload_end_time** | **Time** | | [optional] |
|
|
834
|
+
| **max_upload_end_time** | **Time** | | [optional] |
|
|
835
|
+
| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
|
|
836
|
+
| **inference_status** | **String** | Search for a inference status. | [optional] |
|
|
837
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
838
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 100] |
|
|
839
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
840
|
+
|
|
841
|
+
### Return type
|
|
842
|
+
|
|
843
|
+
[**FileListDTO**](FileListDTO.md)
|
|
844
|
+
|
|
845
|
+
### Authorization
|
|
846
|
+
|
|
847
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
848
|
+
|
|
849
|
+
### HTTP request headers
|
|
850
|
+
|
|
851
|
+
- **Content-Type**: Not defined
|
|
852
|
+
- **Accept**: application/json
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
## sign_up
|
|
856
|
+
|
|
857
|
+
> <SignUpDTO> sign_up(save_user_dto)
|
|
858
|
+
|
|
859
|
+
Sign up a new user.
|
|
860
|
+
|
|
861
|
+
### Examples
|
|
862
|
+
|
|
863
|
+
```ruby
|
|
864
|
+
require 'time'
|
|
865
|
+
require 'songtradr_api_client_ruby'
|
|
866
|
+
# setup authorization
|
|
867
|
+
SongtradrApiClientRuby.configure do |config|
|
|
868
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
869
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
870
|
+
end
|
|
871
|
+
|
|
872
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
873
|
+
save_user_dto = SongtradrApiClientRuby::SaveUserDTO.new({email_address: 'email_address_example'}) # SaveUserDTO |
|
|
874
|
+
|
|
875
|
+
begin
|
|
876
|
+
# Sign up a new user.
|
|
877
|
+
result = api_instance.sign_up(save_user_dto)
|
|
878
|
+
p result
|
|
879
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
880
|
+
puts "Error when calling UserApi->sign_up: #{e}"
|
|
881
|
+
end
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
#### Using the sign_up_with_http_info variant
|
|
885
|
+
|
|
886
|
+
This returns an Array which contains the response data, status code and headers.
|
|
887
|
+
|
|
888
|
+
> <Array(<SignUpDTO>, Integer, Hash)> sign_up_with_http_info(save_user_dto)
|
|
889
|
+
|
|
890
|
+
```ruby
|
|
891
|
+
begin
|
|
892
|
+
# Sign up a new user.
|
|
893
|
+
data, status_code, headers = api_instance.sign_up_with_http_info(save_user_dto)
|
|
894
|
+
p status_code # => 2xx
|
|
895
|
+
p headers # => { ... }
|
|
896
|
+
p data # => <SignUpDTO>
|
|
897
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
898
|
+
puts "Error when calling UserApi->sign_up_with_http_info: #{e}"
|
|
899
|
+
end
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
### Parameters
|
|
903
|
+
|
|
904
|
+
| Name | Type | Description | Notes |
|
|
905
|
+
| ---- | ---- | ----------- | ----- |
|
|
906
|
+
| **save_user_dto** | [**SaveUserDTO**](SaveUserDTO.md) | | |
|
|
907
|
+
|
|
908
|
+
### Return type
|
|
909
|
+
|
|
910
|
+
[**SignUpDTO**](SignUpDTO.md)
|
|
911
|
+
|
|
912
|
+
### Authorization
|
|
913
|
+
|
|
914
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
915
|
+
|
|
916
|
+
### HTTP request headers
|
|
917
|
+
|
|
918
|
+
- **Content-Type**: application/json
|
|
919
|
+
- **Accept**: application/json
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
## token
|
|
923
|
+
|
|
924
|
+
> <JwtTokenDTO> token(token_request)
|
|
925
|
+
|
|
926
|
+
Generates a new JWT token for the given refresh token
|
|
927
|
+
|
|
928
|
+
### Examples
|
|
929
|
+
|
|
930
|
+
```ruby
|
|
931
|
+
require 'time'
|
|
932
|
+
require 'songtradr_api_client_ruby'
|
|
933
|
+
# setup authorization
|
|
934
|
+
SongtradrApiClientRuby.configure do |config|
|
|
935
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
936
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
937
|
+
end
|
|
938
|
+
|
|
939
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
940
|
+
token_request = SongtradrApiClientRuby::TokenRequest.new({refresh_token: 'refresh_token_example'}) # TokenRequest |
|
|
941
|
+
|
|
942
|
+
begin
|
|
943
|
+
# Generates a new JWT token for the given refresh token
|
|
944
|
+
result = api_instance.token(token_request)
|
|
945
|
+
p result
|
|
946
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
947
|
+
puts "Error when calling UserApi->token: #{e}"
|
|
948
|
+
end
|
|
949
|
+
```
|
|
950
|
+
|
|
951
|
+
#### Using the token_with_http_info variant
|
|
952
|
+
|
|
953
|
+
This returns an Array which contains the response data, status code and headers.
|
|
954
|
+
|
|
955
|
+
> <Array(<JwtTokenDTO>, Integer, Hash)> token_with_http_info(token_request)
|
|
956
|
+
|
|
957
|
+
```ruby
|
|
958
|
+
begin
|
|
959
|
+
# Generates a new JWT token for the given refresh token
|
|
960
|
+
data, status_code, headers = api_instance.token_with_http_info(token_request)
|
|
961
|
+
p status_code # => 2xx
|
|
962
|
+
p headers # => { ... }
|
|
963
|
+
p data # => <JwtTokenDTO>
|
|
964
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
965
|
+
puts "Error when calling UserApi->token_with_http_info: #{e}"
|
|
966
|
+
end
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
### Parameters
|
|
970
|
+
|
|
971
|
+
| Name | Type | Description | Notes |
|
|
972
|
+
| ---- | ---- | ----------- | ----- |
|
|
973
|
+
| **token_request** | [**TokenRequest**](TokenRequest.md) | | |
|
|
974
|
+
|
|
975
|
+
### Return type
|
|
976
|
+
|
|
977
|
+
[**JwtTokenDTO**](JwtTokenDTO.md)
|
|
978
|
+
|
|
979
|
+
### Authorization
|
|
980
|
+
|
|
981
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
982
|
+
|
|
983
|
+
### HTTP request headers
|
|
984
|
+
|
|
985
|
+
- **Content-Type**: application/json
|
|
986
|
+
- **Accept**: application/json
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
## update_password
|
|
990
|
+
|
|
991
|
+
> Object update_password(update_password_dto)
|
|
992
|
+
|
|
993
|
+
Update password by using the password reset token
|
|
994
|
+
|
|
995
|
+
### Examples
|
|
996
|
+
|
|
997
|
+
```ruby
|
|
998
|
+
require 'time'
|
|
999
|
+
require 'songtradr_api_client_ruby'
|
|
1000
|
+
# setup authorization
|
|
1001
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1002
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1003
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1004
|
+
end
|
|
1005
|
+
|
|
1006
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1007
|
+
update_password_dto = SongtradrApiClientRuby::UpdatePasswordDTO.new({token: 'token_example', password: 'password_example'}) # UpdatePasswordDTO |
|
|
1008
|
+
|
|
1009
|
+
begin
|
|
1010
|
+
# Update password by using the password reset token
|
|
1011
|
+
result = api_instance.update_password(update_password_dto)
|
|
1012
|
+
p result
|
|
1013
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1014
|
+
puts "Error when calling UserApi->update_password: #{e}"
|
|
1015
|
+
end
|
|
1016
|
+
```
|
|
1017
|
+
|
|
1018
|
+
#### Using the update_password_with_http_info variant
|
|
1019
|
+
|
|
1020
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1021
|
+
|
|
1022
|
+
> <Array(Object, Integer, Hash)> update_password_with_http_info(update_password_dto)
|
|
1023
|
+
|
|
1024
|
+
```ruby
|
|
1025
|
+
begin
|
|
1026
|
+
# Update password by using the password reset token
|
|
1027
|
+
data, status_code, headers = api_instance.update_password_with_http_info(update_password_dto)
|
|
1028
|
+
p status_code # => 2xx
|
|
1029
|
+
p headers # => { ... }
|
|
1030
|
+
p data # => Object
|
|
1031
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1032
|
+
puts "Error when calling UserApi->update_password_with_http_info: #{e}"
|
|
1033
|
+
end
|
|
1034
|
+
```
|
|
1035
|
+
|
|
1036
|
+
### Parameters
|
|
1037
|
+
|
|
1038
|
+
| Name | Type | Description | Notes |
|
|
1039
|
+
| ---- | ---- | ----------- | ----- |
|
|
1040
|
+
| **update_password_dto** | [**UpdatePasswordDTO**](UpdatePasswordDTO.md) | | |
|
|
1041
|
+
|
|
1042
|
+
### Return type
|
|
1043
|
+
|
|
1044
|
+
**Object**
|
|
1045
|
+
|
|
1046
|
+
### Authorization
|
|
1047
|
+
|
|
1048
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1049
|
+
|
|
1050
|
+
### HTTP request headers
|
|
1051
|
+
|
|
1052
|
+
- **Content-Type**: application/json
|
|
1053
|
+
- **Accept**: application/hal+json, application/json
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
## update_user_file_recording
|
|
1057
|
+
|
|
1058
|
+
> Object update_user_file_recording(object_key, save_file_recording_dto)
|
|
1059
|
+
|
|
1060
|
+
Create and edit metadata of your files.
|
|
1061
|
+
|
|
1062
|
+
### Examples
|
|
1063
|
+
|
|
1064
|
+
```ruby
|
|
1065
|
+
require 'time'
|
|
1066
|
+
require 'songtradr_api_client_ruby'
|
|
1067
|
+
# setup authorization
|
|
1068
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1069
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1070
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1071
|
+
end
|
|
1072
|
+
|
|
1073
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1074
|
+
object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be edited.
|
|
1075
|
+
save_file_recording_dto = SongtradrApiClientRuby::SaveFileRecordingDTO.new({isrc: 'isrc_example', created_by_version: 'created_by_version_example'}) # SaveFileRecordingDTO |
|
|
1076
|
+
|
|
1077
|
+
begin
|
|
1078
|
+
# Create and edit metadata of your files.
|
|
1079
|
+
result = api_instance.update_user_file_recording(object_key, save_file_recording_dto)
|
|
1080
|
+
p result
|
|
1081
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1082
|
+
puts "Error when calling UserApi->update_user_file_recording: #{e}"
|
|
1083
|
+
end
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
#### Using the update_user_file_recording_with_http_info variant
|
|
1087
|
+
|
|
1088
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1089
|
+
|
|
1090
|
+
> <Array(Object, Integer, Hash)> update_user_file_recording_with_http_info(object_key, save_file_recording_dto)
|
|
1091
|
+
|
|
1092
|
+
```ruby
|
|
1093
|
+
begin
|
|
1094
|
+
# Create and edit metadata of your files.
|
|
1095
|
+
data, status_code, headers = api_instance.update_user_file_recording_with_http_info(object_key, save_file_recording_dto)
|
|
1096
|
+
p status_code # => 2xx
|
|
1097
|
+
p headers # => { ... }
|
|
1098
|
+
p data # => Object
|
|
1099
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1100
|
+
puts "Error when calling UserApi->update_user_file_recording_with_http_info: #{e}"
|
|
1101
|
+
end
|
|
1102
|
+
```
|
|
1103
|
+
|
|
1104
|
+
### Parameters
|
|
1105
|
+
|
|
1106
|
+
| Name | Type | Description | Notes |
|
|
1107
|
+
| ---- | ---- | ----------- | ----- |
|
|
1108
|
+
| **object_key** | **String** | ObjectKey of the file that should be edited. | |
|
|
1109
|
+
| **save_file_recording_dto** | [**SaveFileRecordingDTO**](SaveFileRecordingDTO.md) | | |
|
|
1110
|
+
|
|
1111
|
+
### Return type
|
|
1112
|
+
|
|
1113
|
+
**Object**
|
|
1114
|
+
|
|
1115
|
+
### Authorization
|
|
1116
|
+
|
|
1117
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1118
|
+
|
|
1119
|
+
### HTTP request headers
|
|
1120
|
+
|
|
1121
|
+
- **Content-Type**: application/json
|
|
1122
|
+
- **Accept**: application/json
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
## user_file
|
|
1126
|
+
|
|
1127
|
+
> <FileWIthUrlDTO> user_file(object_key)
|
|
1128
|
+
|
|
1129
|
+
Details and a download link for a file.
|
|
1130
|
+
|
|
1131
|
+
### Examples
|
|
1132
|
+
|
|
1133
|
+
```ruby
|
|
1134
|
+
require 'time'
|
|
1135
|
+
require 'songtradr_api_client_ruby'
|
|
1136
|
+
# setup authorization
|
|
1137
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1138
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1139
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1140
|
+
end
|
|
1141
|
+
|
|
1142
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1143
|
+
object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be edited.
|
|
1144
|
+
|
|
1145
|
+
begin
|
|
1146
|
+
# Details and a download link for a file.
|
|
1147
|
+
result = api_instance.user_file(object_key)
|
|
1148
|
+
p result
|
|
1149
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1150
|
+
puts "Error when calling UserApi->user_file: #{e}"
|
|
1151
|
+
end
|
|
1152
|
+
```
|
|
1153
|
+
|
|
1154
|
+
#### Using the user_file_with_http_info variant
|
|
1155
|
+
|
|
1156
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1157
|
+
|
|
1158
|
+
> <Array(<FileWIthUrlDTO>, Integer, Hash)> user_file_with_http_info(object_key)
|
|
1159
|
+
|
|
1160
|
+
```ruby
|
|
1161
|
+
begin
|
|
1162
|
+
# Details and a download link for a file.
|
|
1163
|
+
data, status_code, headers = api_instance.user_file_with_http_info(object_key)
|
|
1164
|
+
p status_code # => 2xx
|
|
1165
|
+
p headers # => { ... }
|
|
1166
|
+
p data # => <FileWIthUrlDTO>
|
|
1167
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1168
|
+
puts "Error when calling UserApi->user_file_with_http_info: #{e}"
|
|
1169
|
+
end
|
|
1170
|
+
```
|
|
1171
|
+
|
|
1172
|
+
### Parameters
|
|
1173
|
+
|
|
1174
|
+
| Name | Type | Description | Notes |
|
|
1175
|
+
| ---- | ---- | ----------- | ----- |
|
|
1176
|
+
| **object_key** | **String** | ObjectKey of the file that should be edited. | |
|
|
1177
|
+
|
|
1178
|
+
### Return type
|
|
1179
|
+
|
|
1180
|
+
[**FileWIthUrlDTO**](FileWIthUrlDTO.md)
|
|
1181
|
+
|
|
1182
|
+
### Authorization
|
|
1183
|
+
|
|
1184
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1185
|
+
|
|
1186
|
+
### HTTP request headers
|
|
1187
|
+
|
|
1188
|
+
- **Content-Type**: Not defined
|
|
1189
|
+
- **Accept**: application/json
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
## user_files
|
|
1193
|
+
|
|
1194
|
+
> <FileListDTO> user_files(opts)
|
|
1195
|
+
|
|
1196
|
+
List and search your own files.
|
|
1197
|
+
|
|
1198
|
+
### Examples
|
|
1199
|
+
|
|
1200
|
+
```ruby
|
|
1201
|
+
require 'time'
|
|
1202
|
+
require 'songtradr_api_client_ruby'
|
|
1203
|
+
# setup authorization
|
|
1204
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1205
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1206
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1207
|
+
end
|
|
1208
|
+
|
|
1209
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1210
|
+
opts = {
|
|
1211
|
+
isrc: 'USUM71703692', # String | Search for a ISRC
|
|
1212
|
+
contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
|
|
1213
|
+
main_artist: 'The Beatles', # String | Search for a main artist.
|
|
1214
|
+
composer: 'John Cale', # String | Search for a composer.
|
|
1215
|
+
title: 'Highway To Hell', # String | Search for a title.
|
|
1216
|
+
language: 'en', # String | Search for a language of the lyrics.
|
|
1217
|
+
genre_names: ['inner_example'], # Array<String> |
|
|
1218
|
+
tag_names: ['inner_example'], # Array<String> |
|
|
1219
|
+
release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1220
|
+
primary_mood_cluster: 'aggressive', # String |
|
|
1221
|
+
secondary_mood_cluster: 'aggressive', # String |
|
|
1222
|
+
tertiary_mood_cluster: 'aggressive', # String |
|
|
1223
|
+
valence: 'very sad', # String |
|
|
1224
|
+
arousal: 'very calm', # String |
|
|
1225
|
+
pleasantness: 'very unpleasant', # String |
|
|
1226
|
+
engagement: 'very unengaging', # String |
|
|
1227
|
+
vocals: 'instrumental', # String |
|
|
1228
|
+
dominant_instrument: 'electric guitar', # String |
|
|
1229
|
+
secondary_instrument: 'electric guitar', # String |
|
|
1230
|
+
tertiary_instrument: 'electric guitar', # String |
|
|
1231
|
+
energy: 'very quiet', # String |
|
|
1232
|
+
sound_generation: 'acoustic', # String |
|
|
1233
|
+
tempo: 'very slow', # String |
|
|
1234
|
+
scale: 'major key', # String |
|
|
1235
|
+
rhythm: 'common time', # String |
|
|
1236
|
+
primary_sound_character: 'aggressive', # String |
|
|
1237
|
+
timbre: 'very warm', # String |
|
|
1238
|
+
roughness: 'very clear', # String |
|
|
1239
|
+
tonality: 'monotonous', # String |
|
|
1240
|
+
harmony: 'very dissonant', # String |
|
|
1241
|
+
texture: 'very thin', # String |
|
|
1242
|
+
groovyness: 'very steady', # String |
|
|
1243
|
+
space: 'very compact', # String |
|
|
1244
|
+
production_rating: 'low production quality', # String |
|
|
1245
|
+
performance_rating: 'low performance quality', # String |
|
|
1246
|
+
song_rating: 'low song quality', # String |
|
|
1247
|
+
audience_age: 'Generation Z', # String |
|
|
1248
|
+
audience_region: 'Australia and New Zealand', # String |
|
|
1249
|
+
audience_gender: 'male', # String |
|
|
1250
|
+
origin_decade: 'pre-1950s', # String |
|
|
1251
|
+
curateability: 'curateable', # String |
|
|
1252
|
+
use_case: 'background', # String |
|
|
1253
|
+
channel_suitability: 'Spotify', # String |
|
|
1254
|
+
similar_to_recording: 'similar_to_recording_example', # String |
|
|
1255
|
+
songtradr_track_id: 'songtradr_track_id_example', # String |
|
|
1256
|
+
usage_name: 'usage_name_example', # String |
|
|
1257
|
+
bpm_min: 50, # Integer | Search for a minimal bpm.
|
|
1258
|
+
bpm_max: 210, # Integer | Search for a maximal bpm.
|
|
1259
|
+
name: 'Groove.mp3', # String | Search for a file name.
|
|
1260
|
+
folder: 'defaultFolder', # String | Search for a folder.
|
|
1261
|
+
extension: '.mp3', # String | Search for a file extension.
|
|
1262
|
+
upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1263
|
+
min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1264
|
+
max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1265
|
+
fingerprint_status: 'done', # String | Search for a fingerprint status.
|
|
1266
|
+
inference_status: 'done', # String | Search for a inference status.
|
|
1267
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
|
1268
|
+
size: 56, # Integer | The size of the page to be returned
|
|
1269
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
1270
|
+
}
|
|
1271
|
+
|
|
1272
|
+
begin
|
|
1273
|
+
# List and search your own files.
|
|
1274
|
+
result = api_instance.user_files(opts)
|
|
1275
|
+
p result
|
|
1276
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1277
|
+
puts "Error when calling UserApi->user_files: #{e}"
|
|
1278
|
+
end
|
|
1279
|
+
```
|
|
1280
|
+
|
|
1281
|
+
#### Using the user_files_with_http_info variant
|
|
1282
|
+
|
|
1283
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1284
|
+
|
|
1285
|
+
> <Array(<FileListDTO>, Integer, Hash)> user_files_with_http_info(opts)
|
|
1286
|
+
|
|
1287
|
+
```ruby
|
|
1288
|
+
begin
|
|
1289
|
+
# List and search your own files.
|
|
1290
|
+
data, status_code, headers = api_instance.user_files_with_http_info(opts)
|
|
1291
|
+
p status_code # => 2xx
|
|
1292
|
+
p headers # => { ... }
|
|
1293
|
+
p data # => <FileListDTO>
|
|
1294
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1295
|
+
puts "Error when calling UserApi->user_files_with_http_info: #{e}"
|
|
1296
|
+
end
|
|
1297
|
+
```
|
|
1298
|
+
|
|
1299
|
+
### Parameters
|
|
1300
|
+
|
|
1301
|
+
| Name | Type | Description | Notes |
|
|
1302
|
+
| ---- | ---- | ----------- | ----- |
|
|
1303
|
+
| **isrc** | **String** | Search for a ISRC | [optional] |
|
|
1304
|
+
| **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
|
|
1305
|
+
| **main_artist** | **String** | Search for a main artist. | [optional] |
|
|
1306
|
+
| **composer** | **String** | Search for a composer. | [optional] |
|
|
1307
|
+
| **title** | **String** | Search for a title. | [optional] |
|
|
1308
|
+
| **language** | **String** | Search for a language of the lyrics. | [optional] |
|
|
1309
|
+
| **genre_names** | [**Array<String>**](String.md) | | [optional] |
|
|
1310
|
+
| **tag_names** | [**Array<String>**](String.md) | | [optional] |
|
|
1311
|
+
| **release_date** | **Time** | | [optional] |
|
|
1312
|
+
| **primary_mood_cluster** | **String** | | [optional] |
|
|
1313
|
+
| **secondary_mood_cluster** | **String** | | [optional] |
|
|
1314
|
+
| **tertiary_mood_cluster** | **String** | | [optional] |
|
|
1315
|
+
| **valence** | **String** | | [optional] |
|
|
1316
|
+
| **arousal** | **String** | | [optional] |
|
|
1317
|
+
| **pleasantness** | **String** | | [optional] |
|
|
1318
|
+
| **engagement** | **String** | | [optional] |
|
|
1319
|
+
| **vocals** | **String** | | [optional] |
|
|
1320
|
+
| **dominant_instrument** | **String** | | [optional] |
|
|
1321
|
+
| **secondary_instrument** | **String** | | [optional] |
|
|
1322
|
+
| **tertiary_instrument** | **String** | | [optional] |
|
|
1323
|
+
| **energy** | **String** | | [optional] |
|
|
1324
|
+
| **sound_generation** | **String** | | [optional] |
|
|
1325
|
+
| **tempo** | **String** | | [optional] |
|
|
1326
|
+
| **scale** | **String** | | [optional] |
|
|
1327
|
+
| **rhythm** | **String** | | [optional] |
|
|
1328
|
+
| **primary_sound_character** | **String** | | [optional] |
|
|
1329
|
+
| **timbre** | **String** | | [optional] |
|
|
1330
|
+
| **roughness** | **String** | | [optional] |
|
|
1331
|
+
| **tonality** | **String** | | [optional] |
|
|
1332
|
+
| **harmony** | **String** | | [optional] |
|
|
1333
|
+
| **texture** | **String** | | [optional] |
|
|
1334
|
+
| **groovyness** | **String** | | [optional] |
|
|
1335
|
+
| **space** | **String** | | [optional] |
|
|
1336
|
+
| **production_rating** | **String** | | [optional] |
|
|
1337
|
+
| **performance_rating** | **String** | | [optional] |
|
|
1338
|
+
| **song_rating** | **String** | | [optional] |
|
|
1339
|
+
| **audience_age** | **String** | | [optional] |
|
|
1340
|
+
| **audience_region** | **String** | | [optional] |
|
|
1341
|
+
| **audience_gender** | **String** | | [optional] |
|
|
1342
|
+
| **origin_decade** | **String** | | [optional] |
|
|
1343
|
+
| **curateability** | **String** | | [optional] |
|
|
1344
|
+
| **use_case** | **String** | | [optional] |
|
|
1345
|
+
| **channel_suitability** | **String** | | [optional] |
|
|
1346
|
+
| **similar_to_recording** | **String** | | [optional] |
|
|
1347
|
+
| **songtradr_track_id** | **String** | | [optional] |
|
|
1348
|
+
| **usage_name** | **String** | | [optional] |
|
|
1349
|
+
| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
|
|
1350
|
+
| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
|
|
1351
|
+
| **name** | **String** | Search for a file name. | [optional] |
|
|
1352
|
+
| **folder** | **String** | Search for a folder. | [optional] |
|
|
1353
|
+
| **extension** | **String** | Search for a file extension. | [optional] |
|
|
1354
|
+
| **upload_end_time** | **Time** | | [optional] |
|
|
1355
|
+
| **min_upload_end_time** | **Time** | | [optional] |
|
|
1356
|
+
| **max_upload_end_time** | **Time** | | [optional] |
|
|
1357
|
+
| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
|
|
1358
|
+
| **inference_status** | **String** | Search for a inference status. | [optional] |
|
|
1359
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
1360
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 100] |
|
|
1361
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
1362
|
+
|
|
1363
|
+
### Return type
|
|
1364
|
+
|
|
1365
|
+
[**FileListDTO**](FileListDTO.md)
|
|
1366
|
+
|
|
1367
|
+
### Authorization
|
|
1368
|
+
|
|
1369
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1370
|
+
|
|
1371
|
+
### HTTP request headers
|
|
1372
|
+
|
|
1373
|
+
- **Content-Type**: Not defined
|
|
1374
|
+
- **Accept**: application/json
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
## user_files_download
|
|
1378
|
+
|
|
1379
|
+
> <Array<FileMinimalWithUrlDTO>> user_files_download(opts)
|
|
1380
|
+
|
|
1381
|
+
Download links for your files
|
|
1382
|
+
|
|
1383
|
+
### Examples
|
|
1384
|
+
|
|
1385
|
+
```ruby
|
|
1386
|
+
require 'time'
|
|
1387
|
+
require 'songtradr_api_client_ruby'
|
|
1388
|
+
# setup authorization
|
|
1389
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1390
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1391
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1392
|
+
end
|
|
1393
|
+
|
|
1394
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1395
|
+
opts = {
|
|
1396
|
+
isrc: 'isrc_example', # String |
|
|
1397
|
+
contributor: 'contributor_example', # String |
|
|
1398
|
+
main_artist: 'main_artist_example', # String |
|
|
1399
|
+
composer: 'composer_example', # String |
|
|
1400
|
+
title: 'title_example', # String |
|
|
1401
|
+
language: 'language_example', # String |
|
|
1402
|
+
genre_names: ['inner_example'], # Array<String> |
|
|
1403
|
+
tag_names: ['inner_example'], # Array<String> |
|
|
1404
|
+
release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1405
|
+
primary_mood_cluster: 'aggressive', # String |
|
|
1406
|
+
secondary_mood_cluster: 'aggressive', # String |
|
|
1407
|
+
tertiary_mood_cluster: 'aggressive', # String |
|
|
1408
|
+
valence: 'very sad', # String |
|
|
1409
|
+
arousal: 'very calm', # String |
|
|
1410
|
+
pleasantness: 'very unpleasant', # String |
|
|
1411
|
+
engagement: 'very unengaging', # String |
|
|
1412
|
+
vocals: 'instrumental', # String |
|
|
1413
|
+
dominant_instrument: 'electric guitar', # String |
|
|
1414
|
+
secondary_instrument: 'electric guitar', # String |
|
|
1415
|
+
tertiary_instrument: 'electric guitar', # String |
|
|
1416
|
+
energy: 'very quiet', # String |
|
|
1417
|
+
sound_generation: 'acoustic', # String |
|
|
1418
|
+
tempo: 'very slow', # String |
|
|
1419
|
+
scale: 'major key', # String |
|
|
1420
|
+
rhythm: 'common time', # String |
|
|
1421
|
+
primary_sound_character: 'aggressive', # String |
|
|
1422
|
+
timbre: 'very warm', # String |
|
|
1423
|
+
roughness: 'very clear', # String |
|
|
1424
|
+
tonality: 'monotonous', # String |
|
|
1425
|
+
harmony: 'very dissonant', # String |
|
|
1426
|
+
texture: 'very thin', # String |
|
|
1427
|
+
groovyness: 'very steady', # String |
|
|
1428
|
+
space: 'very compact', # String |
|
|
1429
|
+
production_rating: 'low production quality', # String |
|
|
1430
|
+
performance_rating: 'low performance quality', # String |
|
|
1431
|
+
song_rating: 'low song quality', # String |
|
|
1432
|
+
audience_age: 'Generation Z', # String |
|
|
1433
|
+
audience_region: 'Australia and New Zealand', # String |
|
|
1434
|
+
audience_gender: 'male', # String |
|
|
1435
|
+
songtradr_track_id: 'songtradr_track_id_example', # String |
|
|
1436
|
+
usage_name: 'usage_name_example', # String |
|
|
1437
|
+
bpm_min: 56, # Integer |
|
|
1438
|
+
bpm_max: 56, # Integer |
|
|
1439
|
+
name: 'name_example', # String |
|
|
1440
|
+
folder: 'folder_example', # String |
|
|
1441
|
+
extension: 'extension_example', # String |
|
|
1442
|
+
upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1443
|
+
min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1444
|
+
max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1445
|
+
fingerprint_status: 'fingerprint_status_example', # String |
|
|
1446
|
+
inference_status: 'inference_status_example', # String |
|
|
1447
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
|
1448
|
+
size: 56, # Integer | The size of the page to be returned
|
|
1449
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1452
|
+
begin
|
|
1453
|
+
# Download links for your files
|
|
1454
|
+
result = api_instance.user_files_download(opts)
|
|
1455
|
+
p result
|
|
1456
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1457
|
+
puts "Error when calling UserApi->user_files_download: #{e}"
|
|
1458
|
+
end
|
|
1459
|
+
```
|
|
1460
|
+
|
|
1461
|
+
#### Using the user_files_download_with_http_info variant
|
|
1462
|
+
|
|
1463
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1464
|
+
|
|
1465
|
+
> <Array(<Array<FileMinimalWithUrlDTO>>, Integer, Hash)> user_files_download_with_http_info(opts)
|
|
1466
|
+
|
|
1467
|
+
```ruby
|
|
1468
|
+
begin
|
|
1469
|
+
# Download links for your files
|
|
1470
|
+
data, status_code, headers = api_instance.user_files_download_with_http_info(opts)
|
|
1471
|
+
p status_code # => 2xx
|
|
1472
|
+
p headers # => { ... }
|
|
1473
|
+
p data # => <Array<FileMinimalWithUrlDTO>>
|
|
1474
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1475
|
+
puts "Error when calling UserApi->user_files_download_with_http_info: #{e}"
|
|
1476
|
+
end
|
|
1477
|
+
```
|
|
1478
|
+
|
|
1479
|
+
### Parameters
|
|
1480
|
+
|
|
1481
|
+
| Name | Type | Description | Notes |
|
|
1482
|
+
| ---- | ---- | ----------- | ----- |
|
|
1483
|
+
| **isrc** | **String** | | [optional] |
|
|
1484
|
+
| **contributor** | **String** | | [optional] |
|
|
1485
|
+
| **main_artist** | **String** | | [optional] |
|
|
1486
|
+
| **composer** | **String** | | [optional] |
|
|
1487
|
+
| **title** | **String** | | [optional] |
|
|
1488
|
+
| **language** | **String** | | [optional] |
|
|
1489
|
+
| **genre_names** | [**Array<String>**](String.md) | | [optional] |
|
|
1490
|
+
| **tag_names** | [**Array<String>**](String.md) | | [optional] |
|
|
1491
|
+
| **release_date** | **Time** | | [optional] |
|
|
1492
|
+
| **primary_mood_cluster** | **String** | | [optional] |
|
|
1493
|
+
| **secondary_mood_cluster** | **String** | | [optional] |
|
|
1494
|
+
| **tertiary_mood_cluster** | **String** | | [optional] |
|
|
1495
|
+
| **valence** | **String** | | [optional] |
|
|
1496
|
+
| **arousal** | **String** | | [optional] |
|
|
1497
|
+
| **pleasantness** | **String** | | [optional] |
|
|
1498
|
+
| **engagement** | **String** | | [optional] |
|
|
1499
|
+
| **vocals** | **String** | | [optional] |
|
|
1500
|
+
| **dominant_instrument** | **String** | | [optional] |
|
|
1501
|
+
| **secondary_instrument** | **String** | | [optional] |
|
|
1502
|
+
| **tertiary_instrument** | **String** | | [optional] |
|
|
1503
|
+
| **energy** | **String** | | [optional] |
|
|
1504
|
+
| **sound_generation** | **String** | | [optional] |
|
|
1505
|
+
| **tempo** | **String** | | [optional] |
|
|
1506
|
+
| **scale** | **String** | | [optional] |
|
|
1507
|
+
| **rhythm** | **String** | | [optional] |
|
|
1508
|
+
| **primary_sound_character** | **String** | | [optional] |
|
|
1509
|
+
| **timbre** | **String** | | [optional] |
|
|
1510
|
+
| **roughness** | **String** | | [optional] |
|
|
1511
|
+
| **tonality** | **String** | | [optional] |
|
|
1512
|
+
| **harmony** | **String** | | [optional] |
|
|
1513
|
+
| **texture** | **String** | | [optional] |
|
|
1514
|
+
| **groovyness** | **String** | | [optional] |
|
|
1515
|
+
| **space** | **String** | | [optional] |
|
|
1516
|
+
| **production_rating** | **String** | | [optional] |
|
|
1517
|
+
| **performance_rating** | **String** | | [optional] |
|
|
1518
|
+
| **song_rating** | **String** | | [optional] |
|
|
1519
|
+
| **audience_age** | **String** | | [optional] |
|
|
1520
|
+
| **audience_region** | **String** | | [optional] |
|
|
1521
|
+
| **audience_gender** | **String** | | [optional] |
|
|
1522
|
+
| **songtradr_track_id** | **String** | | [optional] |
|
|
1523
|
+
| **usage_name** | **String** | | [optional] |
|
|
1524
|
+
| **bpm_min** | **Integer** | | [optional] |
|
|
1525
|
+
| **bpm_max** | **Integer** | | [optional] |
|
|
1526
|
+
| **name** | **String** | | [optional] |
|
|
1527
|
+
| **folder** | **String** | | [optional] |
|
|
1528
|
+
| **extension** | **String** | | [optional] |
|
|
1529
|
+
| **upload_end_time** | **Time** | | [optional] |
|
|
1530
|
+
| **min_upload_end_time** | **Time** | | [optional] |
|
|
1531
|
+
| **max_upload_end_time** | **Time** | | [optional] |
|
|
1532
|
+
| **fingerprint_status** | **String** | | [optional] |
|
|
1533
|
+
| **inference_status** | **String** | | [optional] |
|
|
1534
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
1535
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 100] |
|
|
1536
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
1537
|
+
|
|
1538
|
+
### Return type
|
|
1539
|
+
|
|
1540
|
+
[**Array<FileMinimalWithUrlDTO>**](FileMinimalWithUrlDTO.md)
|
|
1541
|
+
|
|
1542
|
+
### Authorization
|
|
1543
|
+
|
|
1544
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1545
|
+
|
|
1546
|
+
### HTTP request headers
|
|
1547
|
+
|
|
1548
|
+
- **Content-Type**: Not defined
|
|
1549
|
+
- **Accept**: application/json
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
## user_files_status
|
|
1553
|
+
|
|
1554
|
+
> <Array<FileSmallDTO>> user_files_status(object_keys)
|
|
1555
|
+
|
|
1556
|
+
Status details for files.
|
|
1557
|
+
|
|
1558
|
+
### Examples
|
|
1559
|
+
|
|
1560
|
+
```ruby
|
|
1561
|
+
require 'time'
|
|
1562
|
+
require 'songtradr_api_client_ruby'
|
|
1563
|
+
# setup authorization
|
|
1564
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1565
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1566
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1567
|
+
end
|
|
1568
|
+
|
|
1569
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1570
|
+
object_keys = 'Example-objectKey' # String | Comma-separated list of objectKeys of the files.
|
|
1571
|
+
|
|
1572
|
+
begin
|
|
1573
|
+
# Status details for files.
|
|
1574
|
+
result = api_instance.user_files_status(object_keys)
|
|
1575
|
+
p result
|
|
1576
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1577
|
+
puts "Error when calling UserApi->user_files_status: #{e}"
|
|
1578
|
+
end
|
|
1579
|
+
```
|
|
1580
|
+
|
|
1581
|
+
#### Using the user_files_status_with_http_info variant
|
|
1582
|
+
|
|
1583
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1584
|
+
|
|
1585
|
+
> <Array(<Array<FileSmallDTO>>, Integer, Hash)> user_files_status_with_http_info(object_keys)
|
|
1586
|
+
|
|
1587
|
+
```ruby
|
|
1588
|
+
begin
|
|
1589
|
+
# Status details for files.
|
|
1590
|
+
data, status_code, headers = api_instance.user_files_status_with_http_info(object_keys)
|
|
1591
|
+
p status_code # => 2xx
|
|
1592
|
+
p headers # => { ... }
|
|
1593
|
+
p data # => <Array<FileSmallDTO>>
|
|
1594
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1595
|
+
puts "Error when calling UserApi->user_files_status_with_http_info: #{e}"
|
|
1596
|
+
end
|
|
1597
|
+
```
|
|
1598
|
+
|
|
1599
|
+
### Parameters
|
|
1600
|
+
|
|
1601
|
+
| Name | Type | Description | Notes |
|
|
1602
|
+
| ---- | ---- | ----------- | ----- |
|
|
1603
|
+
| **object_keys** | **String** | Comma-separated list of objectKeys of the files. | |
|
|
1604
|
+
|
|
1605
|
+
### Return type
|
|
1606
|
+
|
|
1607
|
+
[**Array<FileSmallDTO>**](FileSmallDTO.md)
|
|
1608
|
+
|
|
1609
|
+
### Authorization
|
|
1610
|
+
|
|
1611
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1612
|
+
|
|
1613
|
+
### HTTP request headers
|
|
1614
|
+
|
|
1615
|
+
- **Content-Type**: Not defined
|
|
1616
|
+
- **Accept**: application/json
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
## user_files_summary
|
|
1620
|
+
|
|
1621
|
+
> <FilesSummaryDTO> user_files_summary(opts)
|
|
1622
|
+
|
|
1623
|
+
Summary fo your files.
|
|
1624
|
+
|
|
1625
|
+
### Examples
|
|
1626
|
+
|
|
1627
|
+
```ruby
|
|
1628
|
+
require 'time'
|
|
1629
|
+
require 'songtradr_api_client_ruby'
|
|
1630
|
+
# setup authorization
|
|
1631
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1632
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1633
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1634
|
+
end
|
|
1635
|
+
|
|
1636
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1637
|
+
opts = {
|
|
1638
|
+
isrc: 'USUM71703692', # String | Search for a ISRC
|
|
1639
|
+
contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
|
|
1640
|
+
main_artist: 'The Beatles', # String | Search for a main artist.
|
|
1641
|
+
composer: 'John Cale', # String | Search for a composer.
|
|
1642
|
+
title: 'Highway To Hell', # String | Search for a title.
|
|
1643
|
+
language: 'en', # String | Search for a language of the lyrics.
|
|
1644
|
+
genre_names: ['inner_example'], # Array<String> |
|
|
1645
|
+
tag_names: ['inner_example'], # Array<String> |
|
|
1646
|
+
release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1647
|
+
primary_mood_cluster: 'aggressive', # String |
|
|
1648
|
+
secondary_mood_cluster: 'aggressive', # String |
|
|
1649
|
+
tertiary_mood_cluster: 'aggressive', # String |
|
|
1650
|
+
valence: 'very sad', # String |
|
|
1651
|
+
arousal: 'very calm', # String |
|
|
1652
|
+
pleasantness: 'very unpleasant', # String |
|
|
1653
|
+
engagement: 'very unengaging', # String |
|
|
1654
|
+
vocals: 'instrumental', # String |
|
|
1655
|
+
dominant_instrument: 'electric guitar', # String |
|
|
1656
|
+
secondary_instrument: 'electric guitar', # String |
|
|
1657
|
+
tertiary_instrument: 'electric guitar', # String |
|
|
1658
|
+
energy: 'very quiet', # String |
|
|
1659
|
+
sound_generation: 'acoustic', # String |
|
|
1660
|
+
tempo: 'very slow', # String |
|
|
1661
|
+
scale: 'major key', # String |
|
|
1662
|
+
rhythm: 'common time', # String |
|
|
1663
|
+
primary_sound_character: 'aggressive', # String |
|
|
1664
|
+
timbre: 'very warm', # String |
|
|
1665
|
+
roughness: 'very clear', # String |
|
|
1666
|
+
tonality: 'monotonous', # String |
|
|
1667
|
+
harmony: 'very dissonant', # String |
|
|
1668
|
+
texture: 'very thin', # String |
|
|
1669
|
+
groovyness: 'very steady', # String |
|
|
1670
|
+
space: 'very compact', # String |
|
|
1671
|
+
production_rating: 'low production quality', # String |
|
|
1672
|
+
performance_rating: 'low performance quality', # String |
|
|
1673
|
+
song_rating: 'low song quality', # String |
|
|
1674
|
+
audience_age: 'Generation Z', # String |
|
|
1675
|
+
audience_region: 'Australia and New Zealand', # String |
|
|
1676
|
+
audience_gender: 'male', # String |
|
|
1677
|
+
origin_decade: 'pre-1950s', # String |
|
|
1678
|
+
curateability: 'curateable', # String |
|
|
1679
|
+
use_case: 'background', # String |
|
|
1680
|
+
channel_suitability: 'Spotify', # String |
|
|
1681
|
+
similar_to_recording: 'Highway To Hell', # String |
|
|
1682
|
+
songtradr_track_id: 'songtradr_track_id_example', # String |
|
|
1683
|
+
usage_name: 'usage_name_example', # String |
|
|
1684
|
+
bpm_min: 50, # Integer | Search for a minimal bpm.
|
|
1685
|
+
bpm_max: 210, # Integer | Search for a maximal bpm.
|
|
1686
|
+
name: 'Groove.mp3', # String | Search for a file name.
|
|
1687
|
+
folder: 'defaultFolder', # String | Search for a folder.
|
|
1688
|
+
extension: '.mp3', # String | Search for a file extension.
|
|
1689
|
+
upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1690
|
+
min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1691
|
+
max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
1692
|
+
fingerprint_status: 'done', # String | Search for a fingerprint status.
|
|
1693
|
+
inference_status: 'done' # String | Search for a inference status.
|
|
1694
|
+
}
|
|
1695
|
+
|
|
1696
|
+
begin
|
|
1697
|
+
# Summary fo your files.
|
|
1698
|
+
result = api_instance.user_files_summary(opts)
|
|
1699
|
+
p result
|
|
1700
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1701
|
+
puts "Error when calling UserApi->user_files_summary: #{e}"
|
|
1702
|
+
end
|
|
1703
|
+
```
|
|
1704
|
+
|
|
1705
|
+
#### Using the user_files_summary_with_http_info variant
|
|
1706
|
+
|
|
1707
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1708
|
+
|
|
1709
|
+
> <Array(<FilesSummaryDTO>, Integer, Hash)> user_files_summary_with_http_info(opts)
|
|
1710
|
+
|
|
1711
|
+
```ruby
|
|
1712
|
+
begin
|
|
1713
|
+
# Summary fo your files.
|
|
1714
|
+
data, status_code, headers = api_instance.user_files_summary_with_http_info(opts)
|
|
1715
|
+
p status_code # => 2xx
|
|
1716
|
+
p headers # => { ... }
|
|
1717
|
+
p data # => <FilesSummaryDTO>
|
|
1718
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1719
|
+
puts "Error when calling UserApi->user_files_summary_with_http_info: #{e}"
|
|
1720
|
+
end
|
|
1721
|
+
```
|
|
1722
|
+
|
|
1723
|
+
### Parameters
|
|
1724
|
+
|
|
1725
|
+
| Name | Type | Description | Notes |
|
|
1726
|
+
| ---- | ---- | ----------- | ----- |
|
|
1727
|
+
| **isrc** | **String** | Search for a ISRC | [optional] |
|
|
1728
|
+
| **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
|
|
1729
|
+
| **main_artist** | **String** | Search for a main artist. | [optional] |
|
|
1730
|
+
| **composer** | **String** | Search for a composer. | [optional] |
|
|
1731
|
+
| **title** | **String** | Search for a title. | [optional] |
|
|
1732
|
+
| **language** | **String** | Search for a language of the lyrics. | [optional] |
|
|
1733
|
+
| **genre_names** | [**Array<String>**](String.md) | | [optional] |
|
|
1734
|
+
| **tag_names** | [**Array<String>**](String.md) | | [optional] |
|
|
1735
|
+
| **release_date** | **Time** | | [optional] |
|
|
1736
|
+
| **primary_mood_cluster** | **String** | | [optional] |
|
|
1737
|
+
| **secondary_mood_cluster** | **String** | | [optional] |
|
|
1738
|
+
| **tertiary_mood_cluster** | **String** | | [optional] |
|
|
1739
|
+
| **valence** | **String** | | [optional] |
|
|
1740
|
+
| **arousal** | **String** | | [optional] |
|
|
1741
|
+
| **pleasantness** | **String** | | [optional] |
|
|
1742
|
+
| **engagement** | **String** | | [optional] |
|
|
1743
|
+
| **vocals** | **String** | | [optional] |
|
|
1744
|
+
| **dominant_instrument** | **String** | | [optional] |
|
|
1745
|
+
| **secondary_instrument** | **String** | | [optional] |
|
|
1746
|
+
| **tertiary_instrument** | **String** | | [optional] |
|
|
1747
|
+
| **energy** | **String** | | [optional] |
|
|
1748
|
+
| **sound_generation** | **String** | | [optional] |
|
|
1749
|
+
| **tempo** | **String** | | [optional] |
|
|
1750
|
+
| **scale** | **String** | | [optional] |
|
|
1751
|
+
| **rhythm** | **String** | | [optional] |
|
|
1752
|
+
| **primary_sound_character** | **String** | | [optional] |
|
|
1753
|
+
| **timbre** | **String** | | [optional] |
|
|
1754
|
+
| **roughness** | **String** | | [optional] |
|
|
1755
|
+
| **tonality** | **String** | | [optional] |
|
|
1756
|
+
| **harmony** | **String** | | [optional] |
|
|
1757
|
+
| **texture** | **String** | | [optional] |
|
|
1758
|
+
| **groovyness** | **String** | | [optional] |
|
|
1759
|
+
| **space** | **String** | | [optional] |
|
|
1760
|
+
| **production_rating** | **String** | | [optional] |
|
|
1761
|
+
| **performance_rating** | **String** | | [optional] |
|
|
1762
|
+
| **song_rating** | **String** | | [optional] |
|
|
1763
|
+
| **audience_age** | **String** | | [optional] |
|
|
1764
|
+
| **audience_region** | **String** | | [optional] |
|
|
1765
|
+
| **audience_gender** | **String** | | [optional] |
|
|
1766
|
+
| **origin_decade** | **String** | | [optional] |
|
|
1767
|
+
| **curateability** | **String** | | [optional] |
|
|
1768
|
+
| **use_case** | **String** | | [optional] |
|
|
1769
|
+
| **channel_suitability** | **String** | | [optional] |
|
|
1770
|
+
| **similar_to_recording** | **String** | | [optional] |
|
|
1771
|
+
| **songtradr_track_id** | **String** | | [optional] |
|
|
1772
|
+
| **usage_name** | **String** | | [optional] |
|
|
1773
|
+
| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
|
|
1774
|
+
| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
|
|
1775
|
+
| **name** | **String** | Search for a file name. | [optional] |
|
|
1776
|
+
| **folder** | **String** | Search for a folder. | [optional] |
|
|
1777
|
+
| **extension** | **String** | Search for a file extension. | [optional] |
|
|
1778
|
+
| **upload_end_time** | **Time** | | [optional] |
|
|
1779
|
+
| **min_upload_end_time** | **Time** | | [optional] |
|
|
1780
|
+
| **max_upload_end_time** | **Time** | | [optional] |
|
|
1781
|
+
| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
|
|
1782
|
+
| **inference_status** | **String** | Search for a inference status. | [optional] |
|
|
1783
|
+
|
|
1784
|
+
### Return type
|
|
1785
|
+
|
|
1786
|
+
[**FilesSummaryDTO**](FilesSummaryDTO.md)
|
|
1787
|
+
|
|
1788
|
+
### Authorization
|
|
1789
|
+
|
|
1790
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1791
|
+
|
|
1792
|
+
### HTTP request headers
|
|
1793
|
+
|
|
1794
|
+
- **Content-Type**: Not defined
|
|
1795
|
+
- **Accept**: application/json
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
## user_folders
|
|
1799
|
+
|
|
1800
|
+
> Array<String> user_folders(opts)
|
|
1801
|
+
|
|
1802
|
+
Your Folders
|
|
1803
|
+
|
|
1804
|
+
### Examples
|
|
1805
|
+
|
|
1806
|
+
```ruby
|
|
1807
|
+
require 'time'
|
|
1808
|
+
require 'songtradr_api_client_ruby'
|
|
1809
|
+
# setup authorization
|
|
1810
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1811
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1812
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1813
|
+
end
|
|
1814
|
+
|
|
1815
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1816
|
+
opts = {
|
|
1817
|
+
page: 56, # Integer | Zero-based page index (0..N)
|
|
1818
|
+
size: 56, # Integer | The size of the page to be returned
|
|
1819
|
+
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
1820
|
+
}
|
|
1821
|
+
|
|
1822
|
+
begin
|
|
1823
|
+
# Your Folders
|
|
1824
|
+
result = api_instance.user_folders(opts)
|
|
1825
|
+
p result
|
|
1826
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1827
|
+
puts "Error when calling UserApi->user_folders: #{e}"
|
|
1828
|
+
end
|
|
1829
|
+
```
|
|
1830
|
+
|
|
1831
|
+
#### Using the user_folders_with_http_info variant
|
|
1832
|
+
|
|
1833
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1834
|
+
|
|
1835
|
+
> <Array(Array<String>, Integer, Hash)> user_folders_with_http_info(opts)
|
|
1836
|
+
|
|
1837
|
+
```ruby
|
|
1838
|
+
begin
|
|
1839
|
+
# Your Folders
|
|
1840
|
+
data, status_code, headers = api_instance.user_folders_with_http_info(opts)
|
|
1841
|
+
p status_code # => 2xx
|
|
1842
|
+
p headers # => { ... }
|
|
1843
|
+
p data # => Array<String>
|
|
1844
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1845
|
+
puts "Error when calling UserApi->user_folders_with_http_info: #{e}"
|
|
1846
|
+
end
|
|
1847
|
+
```
|
|
1848
|
+
|
|
1849
|
+
### Parameters
|
|
1850
|
+
|
|
1851
|
+
| Name | Type | Description | Notes |
|
|
1852
|
+
| ---- | ---- | ----------- | ----- |
|
|
1853
|
+
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
1854
|
+
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
1855
|
+
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
1856
|
+
|
|
1857
|
+
### Return type
|
|
1858
|
+
|
|
1859
|
+
**Array<String>**
|
|
1860
|
+
|
|
1861
|
+
### Authorization
|
|
1862
|
+
|
|
1863
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1864
|
+
|
|
1865
|
+
### HTTP request headers
|
|
1866
|
+
|
|
1867
|
+
- **Content-Type**: Not defined
|
|
1868
|
+
- **Accept**: application/json
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
## user_referrers
|
|
1872
|
+
|
|
1873
|
+
> Array<String> user_referrers(username)
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
### Examples
|
|
1878
|
+
|
|
1879
|
+
```ruby
|
|
1880
|
+
require 'time'
|
|
1881
|
+
require 'songtradr_api_client_ruby'
|
|
1882
|
+
# setup authorization
|
|
1883
|
+
SongtradrApiClientRuby.configure do |config|
|
|
1884
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
1885
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1886
|
+
end
|
|
1887
|
+
|
|
1888
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
1889
|
+
username = 'username_example' # String |
|
|
1890
|
+
|
|
1891
|
+
begin
|
|
1892
|
+
|
|
1893
|
+
result = api_instance.user_referrers(username)
|
|
1894
|
+
p result
|
|
1895
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1896
|
+
puts "Error when calling UserApi->user_referrers: #{e}"
|
|
1897
|
+
end
|
|
1898
|
+
```
|
|
1899
|
+
|
|
1900
|
+
#### Using the user_referrers_with_http_info variant
|
|
1901
|
+
|
|
1902
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1903
|
+
|
|
1904
|
+
> <Array(Array<String>, Integer, Hash)> user_referrers_with_http_info(username)
|
|
1905
|
+
|
|
1906
|
+
```ruby
|
|
1907
|
+
begin
|
|
1908
|
+
|
|
1909
|
+
data, status_code, headers = api_instance.user_referrers_with_http_info(username)
|
|
1910
|
+
p status_code # => 2xx
|
|
1911
|
+
p headers # => { ... }
|
|
1912
|
+
p data # => Array<String>
|
|
1913
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
1914
|
+
puts "Error when calling UserApi->user_referrers_with_http_info: #{e}"
|
|
1915
|
+
end
|
|
1916
|
+
```
|
|
1917
|
+
|
|
1918
|
+
### Parameters
|
|
1919
|
+
|
|
1920
|
+
| Name | Type | Description | Notes |
|
|
1921
|
+
| ---- | ---- | ----------- | ----- |
|
|
1922
|
+
| **username** | **String** | | |
|
|
1923
|
+
|
|
1924
|
+
### Return type
|
|
1925
|
+
|
|
1926
|
+
**Array<String>**
|
|
1927
|
+
|
|
1928
|
+
### Authorization
|
|
1929
|
+
|
|
1930
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
1931
|
+
|
|
1932
|
+
### HTTP request headers
|
|
1933
|
+
|
|
1934
|
+
- **Content-Type**: Not defined
|
|
1935
|
+
- **Accept**: application/json
|
|
1936
|
+
|