songtradr_api_client_ruby 1.13.4 → 1.13.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +45 -26
- data/docs/AgeRange.md +20 -0
- data/docs/Beard.md +20 -0
- data/docs/BoundingBox.md +24 -0
- data/docs/ContextValue.md +18 -0
- data/docs/CuratePlaylistDTO.md +26 -0
- data/docs/CuratePlaylistResponseDTO.md +18 -0
- data/docs/DominantColor.md +30 -0
- data/docs/Emotion.md +20 -0
- data/docs/EyeDirection.md +22 -0
- data/docs/EyeOpen.md +20 -0
- data/docs/Eyeglasses.md +20 -0
- data/docs/FaceDetail.md +50 -0
- data/docs/FaceDetection.md +20 -0
- data/docs/FaceOccluded.md +20 -0
- data/docs/FileSmallDTO.md +11 -11
- data/docs/Gender.md +20 -0
- data/docs/ImageQuality.md +20 -0
- data/docs/ImageRecognitionResponse.md +20 -0
- data/docs/Instance.md +22 -0
- data/docs/Label.md +28 -0
- data/docs/{CreateApiKeyDTO.md → LabelAlias.md} +2 -2
- data/docs/LabelCategory.md +18 -0
- data/docs/LabelDetection.md +26 -0
- data/docs/Landmark.md +22 -0
- data/docs/MouthOpen.md +20 -0
- data/docs/MusicalFeaturesDTO.md +45 -45
- data/docs/Mustache.md +20 -0
- data/docs/Parent.md +18 -0
- data/docs/PlaylistApi.md +70 -0
- data/docs/PlaylistLargeDTO.md +5 -5
- data/docs/Pose.md +22 -0
- data/docs/ProductMediumDTO.md +2 -2
- data/docs/ProductPartyDTO.md +3 -3
- data/docs/RecordingGenrePredictionDTO.md +3 -3
- data/docs/RecordingLargeDTO.md +9 -9
- data/docs/RecordingMediumDTO.md +7 -7
- data/docs/RecordingPartyDTO.md +3 -3
- data/docs/RecordingSmallDTO.md +3 -3
- data/docs/SaveFileRecordingDTO.md +5 -1
- data/docs/Smile.md +20 -0
- data/docs/Sunglasses.md +20 -0
- data/docs/TagDTO.md +3 -3
- data/docs/UserApi.md +140 -0
- data/docs/VideoRecognitionResponse.md +20 -0
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/party_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/playlist_api.rb +78 -1
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/user_api.rb +137 -1
- data/lib/songtradr_api_client_ruby/api_client.rb +3 -2
- data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
- data/lib/songtradr_api_client_ruby/configuration.rb +2 -1
- data/lib/songtradr_api_client_ruby/models/age_range.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/beard.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/bounding_box.rb +241 -0
- data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/context_value.rb +216 -0
- data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +256 -0
- data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +216 -0
- data/lib/songtradr_api_client_ruby/models/dominant_color.rb +268 -0
- data/lib/songtradr_api_client_ruby/models/emotion.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/error_response.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/eye_direction.rb +232 -0
- data/lib/songtradr_api_client_ruby/models/eye_open.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/face_detail.rb +362 -0
- data/lib/songtradr_api_client_ruby/models/face_detection.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/face_occluded.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +63 -63
- data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/gender.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/genre_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/image_quality.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +227 -0
- data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/instance.rb +234 -0
- data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/label.rb +267 -0
- data/lib/songtradr_api_client_ruby/models/{create_api_key_dto.rb → label_alias.rb} +4 -4
- data/lib/songtradr_api_client_ruby/models/label_category.rb +214 -0
- data/lib/songtradr_api_client_ruby/models/label_detection.rb +250 -0
- data/lib/songtradr_api_client_ruby/models/landmark.rb +232 -0
- data/lib/songtradr_api_client_ruby/models/login_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/{api_key_dto.rb → mouth_open.rb} +17 -56
- data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +353 -353
- data/lib/songtradr_api_client_ruby/models/mustache.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/parent.rb +214 -0
- data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +22 -22
- data/lib/songtradr_api_client_ruby/models/pose.rb +232 -0
- data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +11 -11
- data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +16 -16
- data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +21 -21
- data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +51 -51
- data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +42 -42
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +16 -16
- data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +26 -26
- data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +23 -5
- data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/smile.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/sunglasses.rb +223 -0
- data/lib/songtradr_api_client_ruby/models/tag_dto.rb +16 -16
- data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/title_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/token_request.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/track_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/usage_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/user_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +227 -0
- data/lib/songtradr_api_client_ruby/version.rb +2 -2
- data/lib/songtradr_api_client_ruby.rb +31 -5
- data/openapi-generator-config.yaml +1 -1
- data/songtradr_api_client_ruby.gemspec +1 -1
- data/spec/api/allowed_values_api_spec.rb +1 -1
- data/spec/api/party_api_spec.rb +1 -1
- data/spec/api/playlist_api_spec.rb +13 -1
- data/spec/api/recording_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +25 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/age_range_spec.rb +42 -0
- data/spec/models/beard_spec.rb +42 -0
- data/spec/models/{api_key_dto_spec.rb → bounding_box_spec.rb} +13 -11
- data/spec/models/category_medium_dto_spec.rb +4 -2
- data/spec/models/category_minimal_dto_spec.rb +4 -2
- data/spec/models/config_access_dto_spec.rb +4 -2
- data/spec/models/config_identifier_dto_spec.rb +4 -2
- data/spec/models/context_value_spec.rb +36 -0
- data/spec/models/contributor_type_dto_spec.rb +4 -2
- data/spec/{api/api_keys_api_spec.rb → models/curate_playlist_dto_spec.rb} +21 -31
- data/spec/models/curate_playlist_response_dto_spec.rb +36 -0
- data/spec/models/dominant_color_spec.rb +72 -0
- data/spec/models/emotion_spec.rb +42 -0
- data/spec/models/error_response_spec.rb +4 -2
- data/spec/models/eye_direction_spec.rb +48 -0
- data/spec/models/eye_open_spec.rb +42 -0
- data/spec/models/eyeglasses_spec.rb +42 -0
- data/spec/models/{admin_api_user_dto_spec.rb → face_detail_spec.rb} +25 -83
- data/spec/models/face_detection_spec.rb +42 -0
- data/spec/models/face_occluded_spec.rb +42 -0
- data/spec/models/field_summary_dto_spec.rb +4 -2
- data/spec/models/file_dto_spec.rb +4 -2
- data/spec/models/file_list_dto_spec.rb +4 -2
- data/spec/models/file_minimal_with_url_dto_spec.rb +4 -2
- data/spec/models/file_small_dto_spec.rb +22 -20
- data/spec/models/file_upload_dto_spec.rb +4 -2
- data/spec/models/file_w_ith_url_dto_spec.rb +4 -2
- data/spec/models/files_summary_dto_spec.rb +4 -2
- data/spec/models/forgot_password_dto_spec.rb +4 -2
- data/spec/models/gender_spec.rb +42 -0
- data/spec/models/genre_dto_spec.rb +4 -2
- data/spec/models/genre_minimal_dto_spec.rb +4 -2
- data/spec/models/genres_summary_dto_spec.rb +4 -2
- data/spec/models/image_quality_spec.rb +42 -0
- data/spec/models/image_recognition_response_spec.rb +42 -0
- data/spec/models/init_put_recording_audio_dto_spec.rb +4 -2
- data/spec/models/instance_spec.rb +48 -0
- data/spec/models/jwt_token_dto_spec.rb +4 -2
- data/spec/models/label_alias_spec.rb +36 -0
- data/spec/models/label_category_spec.rb +36 -0
- data/spec/models/label_detection_spec.rb +60 -0
- data/spec/models/label_spec.rb +66 -0
- data/spec/models/landmark_spec.rb +48 -0
- data/spec/models/login_dto_spec.rb +4 -2
- data/spec/models/mouth_open_spec.rb +42 -0
- data/spec/models/musical_features_dto_spec.rb +145 -143
- data/spec/models/mustache_spec.rb +42 -0
- data/spec/models/p_line_dto_spec.rb +4 -2
- data/spec/models/{create_api_key_dto_spec.rb → parent_spec.rb} +9 -7
- data/spec/models/party_large_dto_spec.rb +4 -2
- data/spec/models/party_small_dto_spec.rb +4 -2
- data/spec/models/playlist_large_dto_spec.rb +8 -6
- data/spec/models/pose_spec.rb +48 -0
- data/spec/models/product_medium_dto_spec.rb +7 -5
- data/spec/models/product_party_dto_spec.rb +6 -4
- data/spec/models/recording_for_similarity_search_dto_spec.rb +4 -2
- data/spec/models/recording_genre_prediction_dto_spec.rb +7 -5
- data/spec/models/recording_large_dto_spec.rb +14 -12
- data/spec/models/recording_list_dto_spec.rb +4 -2
- data/spec/models/recording_medium_dto_spec.rb +13 -11
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +4 -2
- data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +4 -2
- data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +4 -2
- data/spec/models/recording_party_dto_spec.rb +6 -4
- data/spec/models/recording_playlist_dto_spec.rb +4 -2
- data/spec/models/recording_small_dto_spec.rb +6 -4
- data/spec/models/recording_tag_small_dto_spec.rb +4 -2
- data/spec/models/save_file_recording_dto_spec.rb +16 -2
- data/spec/models/save_playlist_dto_spec.rb +4 -2
- data/spec/models/save_recording_genre_dto_spec.rb +4 -2
- data/spec/models/save_recording_party_dto_spec.rb +4 -2
- data/spec/models/save_recording_playlist_dto_spec.rb +4 -2
- data/spec/models/save_recording_tag_dto_spec.rb +4 -2
- data/spec/models/save_referrer_dto_spec.rb +4 -2
- data/spec/models/save_taggrams_dto_spec.rb +4 -2
- data/spec/models/save_user_dto_spec.rb +4 -2
- data/spec/models/search_filter_values_dto_spec.rb +4 -2
- data/spec/models/search_recording_granular_abstraction_dto_spec.rb +4 -2
- data/spec/models/search_recording_granular_dto_spec.rb +4 -2
- data/spec/models/sign_up_dto_spec.rb +4 -2
- data/spec/models/smile_spec.rb +42 -0
- data/spec/models/sunglasses_spec.rb +42 -0
- data/spec/models/tag_dto_spec.rb +6 -4
- data/spec/models/tag_small_dto_spec.rb +4 -2
- data/spec/models/taggram_dto_spec.rb +4 -2
- data/spec/models/tags_summary_dto_spec.rb +4 -2
- data/spec/models/tagstrength_dto_spec.rb +4 -2
- data/spec/models/title_dto_spec.rb +4 -2
- data/spec/models/token_request_spec.rb +4 -2
- data/spec/models/track_dto_spec.rb +4 -2
- data/spec/models/track_to_medium_product_dto_spec.rb +4 -2
- data/spec/models/update_password_dto_spec.rb +4 -2
- data/spec/models/usage_dto_spec.rb +4 -2
- data/spec/models/user_dto_spec.rb +4 -2
- data/spec/models/video_recognition_response_spec.rb +42 -0
- data/spec/spec_helper.rb +1 -1
- metadata +177 -73
- data/docs/APIKeysApi.md +0 -217
- data/docs/AdminApiUserDTO.md +0 -70
- data/docs/ApiKeyDTO.md +0 -24
- data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +0 -213
- data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +0 -448
|
@@ -114,6 +114,8 @@
|
|
|
114
114
|
| **proprietary_id_gema** | **String** | | [optional] |
|
|
115
115
|
| **title** | **String** | | [optional] |
|
|
116
116
|
| **version_title** | **String** | | [optional] |
|
|
117
|
+
| **context_kind** | **String** | | [optional] |
|
|
118
|
+
| **context_value** | [**ContextValue**](ContextValue.md) | | [optional] |
|
|
117
119
|
|
|
118
120
|
## Example
|
|
119
121
|
|
|
@@ -230,7 +232,9 @@ instance = SongtradrApiClientRuby::SaveFileRecordingDTO.new(
|
|
|
230
232
|
iswc: null,
|
|
231
233
|
proprietary_id_gema: null,
|
|
232
234
|
title: null,
|
|
233
|
-
version_title: null
|
|
235
|
+
version_title: null,
|
|
236
|
+
context_kind: null,
|
|
237
|
+
context_value: null
|
|
234
238
|
)
|
|
235
239
|
```
|
|
236
240
|
|
data/docs/Smile.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SongtradrApiClientRuby::Smile
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **value** | **Boolean** | | [optional] |
|
|
8
|
+
| **confidence** | **Float** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'songtradr_api_client_ruby'
|
|
14
|
+
|
|
15
|
+
instance = SongtradrApiClientRuby::Smile.new(
|
|
16
|
+
value: null,
|
|
17
|
+
confidence: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Sunglasses.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SongtradrApiClientRuby::Sunglasses
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **value** | **Boolean** | | [optional] |
|
|
8
|
+
| **confidence** | **Float** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'songtradr_api_client_ruby'
|
|
14
|
+
|
|
15
|
+
instance = SongtradrApiClientRuby::Sunglasses.new(
|
|
16
|
+
value: null,
|
|
17
|
+
confidence: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/TagDTO.md
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **Integer** | | |
|
|
8
|
-
| **name** | **String** | | |
|
|
9
8
|
| **categories** | [**Array<CategoryMinimalDTO>**](CategoryMinimalDTO.md) | | [optional] |
|
|
9
|
+
| **name** | **String** | | |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -15,8 +15,8 @@ require 'songtradr_api_client_ruby'
|
|
|
15
15
|
|
|
16
16
|
instance = SongtradrApiClientRuby::TagDTO.new(
|
|
17
17
|
id: null,
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
categories: null,
|
|
19
|
+
name: null
|
|
20
20
|
)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/UserApi.md
CHANGED
|
@@ -8,7 +8,9 @@ All URIs are relative to *https://api.songtradr.com*
|
|
|
8
8
|
| [**delete_user_file**](UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file. |
|
|
9
9
|
| [**edit_me**](UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user |
|
|
10
10
|
| [**forgot_password**](UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email |
|
|
11
|
+
| [**init_video_upload**](UserApi.md#init_video_upload) | **POST** /api/v1/user/file/{name}/initVideoUpload | Recognise and upload video. Responds with an object with recognition result. |
|
|
11
12
|
| [**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. |
|
|
13
|
+
| [**initiate_user_image_upload**](UserApi.md#initiate_user_image_upload) | **POST** /api/v1/user/file/{name}/initImageUpload | Recognise and upload image. Responds with an object with recognition result. |
|
|
12
14
|
| [**login**](UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token. |
|
|
13
15
|
| [**me**](UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user |
|
|
14
16
|
| [**recordings_by_folder_with_taggrams**](UserApi.md#recordings_by_folder_with_taggrams) | **GET** /api/v1/user/folder/{folderName}/taggrams | Timeseries of AI generated moods, musical features and more for recordings in your folder. |
|
|
@@ -295,6 +297,75 @@ end
|
|
|
295
297
|
- **Accept**: application/hal+json, application/json
|
|
296
298
|
|
|
297
299
|
|
|
300
|
+
## init_video_upload
|
|
301
|
+
|
|
302
|
+
> <VideoRecognitionResponse> init_video_upload(name, url)
|
|
303
|
+
|
|
304
|
+
Recognise and upload video. Responds with an object with recognition result.
|
|
305
|
+
|
|
306
|
+
### Examples
|
|
307
|
+
|
|
308
|
+
```ruby
|
|
309
|
+
require 'time'
|
|
310
|
+
require 'songtradr_api_client_ruby'
|
|
311
|
+
# setup authorization
|
|
312
|
+
SongtradrApiClientRuby.configure do |config|
|
|
313
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
314
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
318
|
+
name = 'FileName.mp4' # String | The Name of the image that will be uploaded
|
|
319
|
+
url = 'url_example' # String |
|
|
320
|
+
|
|
321
|
+
begin
|
|
322
|
+
# Recognise and upload video. Responds with an object with recognition result.
|
|
323
|
+
result = api_instance.init_video_upload(name, url)
|
|
324
|
+
p result
|
|
325
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
326
|
+
puts "Error when calling UserApi->init_video_upload: #{e}"
|
|
327
|
+
end
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
#### Using the init_video_upload_with_http_info variant
|
|
331
|
+
|
|
332
|
+
This returns an Array which contains the response data, status code and headers.
|
|
333
|
+
|
|
334
|
+
> <Array(<VideoRecognitionResponse>, Integer, Hash)> init_video_upload_with_http_info(name, url)
|
|
335
|
+
|
|
336
|
+
```ruby
|
|
337
|
+
begin
|
|
338
|
+
# Recognise and upload video. Responds with an object with recognition result.
|
|
339
|
+
data, status_code, headers = api_instance.init_video_upload_with_http_info(name, url)
|
|
340
|
+
p status_code # => 2xx
|
|
341
|
+
p headers # => { ... }
|
|
342
|
+
p data # => <VideoRecognitionResponse>
|
|
343
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
344
|
+
puts "Error when calling UserApi->init_video_upload_with_http_info: #{e}"
|
|
345
|
+
end
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### Parameters
|
|
349
|
+
|
|
350
|
+
| Name | Type | Description | Notes |
|
|
351
|
+
| ---- | ---- | ----------- | ----- |
|
|
352
|
+
| **name** | **String** | The Name of the image that will be uploaded | |
|
|
353
|
+
| **url** | **String** | | |
|
|
354
|
+
|
|
355
|
+
### Return type
|
|
356
|
+
|
|
357
|
+
[**VideoRecognitionResponse**](VideoRecognitionResponse.md)
|
|
358
|
+
|
|
359
|
+
### Authorization
|
|
360
|
+
|
|
361
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
362
|
+
|
|
363
|
+
### HTTP request headers
|
|
364
|
+
|
|
365
|
+
- **Content-Type**: Not defined
|
|
366
|
+
- **Accept**: application/json
|
|
367
|
+
|
|
368
|
+
|
|
298
369
|
## initiate_user_file_upload
|
|
299
370
|
|
|
300
371
|
> <InitPutRecordingAudioDTO> initiate_user_file_upload(name, folder, opts)
|
|
@@ -368,6 +439,75 @@ end
|
|
|
368
439
|
- **Accept**: application/json
|
|
369
440
|
|
|
370
441
|
|
|
442
|
+
## initiate_user_image_upload
|
|
443
|
+
|
|
444
|
+
> <ImageRecognitionResponse> initiate_user_image_upload(name, url)
|
|
445
|
+
|
|
446
|
+
Recognise and upload image. Responds with an object with recognition result.
|
|
447
|
+
|
|
448
|
+
### Examples
|
|
449
|
+
|
|
450
|
+
```ruby
|
|
451
|
+
require 'time'
|
|
452
|
+
require 'songtradr_api_client_ruby'
|
|
453
|
+
# setup authorization
|
|
454
|
+
SongtradrApiClientRuby.configure do |config|
|
|
455
|
+
# Configure Bearer authorization (JWT): bearer-jwt
|
|
456
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
457
|
+
end
|
|
458
|
+
|
|
459
|
+
api_instance = SongtradrApiClientRuby::UserApi.new
|
|
460
|
+
name = 'FileName.mp3' # String | The Name of the image that will be uploaded
|
|
461
|
+
url = 'url_example' # String |
|
|
462
|
+
|
|
463
|
+
begin
|
|
464
|
+
# Recognise and upload image. Responds with an object with recognition result.
|
|
465
|
+
result = api_instance.initiate_user_image_upload(name, url)
|
|
466
|
+
p result
|
|
467
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
468
|
+
puts "Error when calling UserApi->initiate_user_image_upload: #{e}"
|
|
469
|
+
end
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
#### Using the initiate_user_image_upload_with_http_info variant
|
|
473
|
+
|
|
474
|
+
This returns an Array which contains the response data, status code and headers.
|
|
475
|
+
|
|
476
|
+
> <Array(<ImageRecognitionResponse>, Integer, Hash)> initiate_user_image_upload_with_http_info(name, url)
|
|
477
|
+
|
|
478
|
+
```ruby
|
|
479
|
+
begin
|
|
480
|
+
# Recognise and upload image. Responds with an object with recognition result.
|
|
481
|
+
data, status_code, headers = api_instance.initiate_user_image_upload_with_http_info(name, url)
|
|
482
|
+
p status_code # => 2xx
|
|
483
|
+
p headers # => { ... }
|
|
484
|
+
p data # => <ImageRecognitionResponse>
|
|
485
|
+
rescue SongtradrApiClientRuby::ApiError => e
|
|
486
|
+
puts "Error when calling UserApi->initiate_user_image_upload_with_http_info: #{e}"
|
|
487
|
+
end
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
### Parameters
|
|
491
|
+
|
|
492
|
+
| Name | Type | Description | Notes |
|
|
493
|
+
| ---- | ---- | ----------- | ----- |
|
|
494
|
+
| **name** | **String** | The Name of the image that will be uploaded | |
|
|
495
|
+
| **url** | **String** | | |
|
|
496
|
+
|
|
497
|
+
### Return type
|
|
498
|
+
|
|
499
|
+
[**ImageRecognitionResponse**](ImageRecognitionResponse.md)
|
|
500
|
+
|
|
501
|
+
### Authorization
|
|
502
|
+
|
|
503
|
+
[bearer-jwt](../README.md#bearer-jwt)
|
|
504
|
+
|
|
505
|
+
### HTTP request headers
|
|
506
|
+
|
|
507
|
+
- **Content-Type**: Not defined
|
|
508
|
+
- **Accept**: application/json
|
|
509
|
+
|
|
510
|
+
|
|
371
511
|
## login
|
|
372
512
|
|
|
373
513
|
> <JwtTokenDTO> login(login_dto)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SongtradrApiClientRuby::VideoRecognitionResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **labels** | [**Array<LabelDetection>**](LabelDetection.md) | | [optional] |
|
|
8
|
+
| **faces** | [**Array<FaceDetection>**](FaceDetection.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'songtradr_api_client_ruby'
|
|
14
|
+
|
|
15
|
+
instance = SongtradrApiClientRuby::VideoRecognitionResponse.new(
|
|
16
|
+
labels: null,
|
|
17
|
+
faces: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -158,6 +158,83 @@ module SongtradrApiClientRuby
|
|
|
158
158
|
return data, status_code, headers
|
|
159
159
|
end
|
|
160
160
|
|
|
161
|
+
# Curate playlist.
|
|
162
|
+
# @param method_name [String] Name of the curation task that should be executed
|
|
163
|
+
# @param curate_playlist_dto [CuratePlaylistDTO]
|
|
164
|
+
# @param [Hash] opts the optional parameters
|
|
165
|
+
# @return [CuratePlaylistResponseDTO]
|
|
166
|
+
def curate_playlist(method_name, curate_playlist_dto, opts = {})
|
|
167
|
+
data, _status_code, _headers = curate_playlist_with_http_info(method_name, curate_playlist_dto, opts)
|
|
168
|
+
data
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Curate playlist.
|
|
172
|
+
# @param method_name [String] Name of the curation task that should be executed
|
|
173
|
+
# @param curate_playlist_dto [CuratePlaylistDTO]
|
|
174
|
+
# @param [Hash] opts the optional parameters
|
|
175
|
+
# @return [Array<(CuratePlaylistResponseDTO, Integer, Hash)>] CuratePlaylistResponseDTO data, response status code and response headers
|
|
176
|
+
def curate_playlist_with_http_info(method_name, curate_playlist_dto, opts = {})
|
|
177
|
+
if @api_client.config.debugging
|
|
178
|
+
@api_client.config.logger.debug 'Calling API: PlaylistApi.curate_playlist ...'
|
|
179
|
+
end
|
|
180
|
+
# verify the required parameter 'method_name' is set
|
|
181
|
+
if @api_client.config.client_side_validation && method_name.nil?
|
|
182
|
+
fail ArgumentError, "Missing the required parameter 'method_name' when calling PlaylistApi.curate_playlist"
|
|
183
|
+
end
|
|
184
|
+
# verify enum value
|
|
185
|
+
allowable_values = ["RECOMMEND", "REPLACE_SIMILAR", "REPLACE_DIFFERENT", "ORDER"]
|
|
186
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(method_name)
|
|
187
|
+
fail ArgumentError, "invalid value for \"method_name\", must be one of #{allowable_values}"
|
|
188
|
+
end
|
|
189
|
+
# verify the required parameter 'curate_playlist_dto' is set
|
|
190
|
+
if @api_client.config.client_side_validation && curate_playlist_dto.nil?
|
|
191
|
+
fail ArgumentError, "Missing the required parameter 'curate_playlist_dto' when calling PlaylistApi.curate_playlist"
|
|
192
|
+
end
|
|
193
|
+
# resource path
|
|
194
|
+
local_var_path = '/api/v1/playlist/{methodName}'.sub('{' + 'methodName' + '}', CGI.escape(method_name.to_s))
|
|
195
|
+
|
|
196
|
+
# query parameters
|
|
197
|
+
query_params = opts[:query_params] || {}
|
|
198
|
+
|
|
199
|
+
# header parameters
|
|
200
|
+
header_params = opts[:header_params] || {}
|
|
201
|
+
# HTTP header 'Accept' (if needed)
|
|
202
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
203
|
+
# HTTP header 'Content-Type'
|
|
204
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
205
|
+
if !content_type.nil?
|
|
206
|
+
header_params['Content-Type'] = content_type
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# form parameters
|
|
210
|
+
form_params = opts[:form_params] || {}
|
|
211
|
+
|
|
212
|
+
# http body (model)
|
|
213
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(curate_playlist_dto)
|
|
214
|
+
|
|
215
|
+
# return_type
|
|
216
|
+
return_type = opts[:debug_return_type] || 'CuratePlaylistResponseDTO'
|
|
217
|
+
|
|
218
|
+
# auth_names
|
|
219
|
+
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
220
|
+
|
|
221
|
+
new_options = opts.merge(
|
|
222
|
+
:operation => :"PlaylistApi.curate_playlist",
|
|
223
|
+
:header_params => header_params,
|
|
224
|
+
:query_params => query_params,
|
|
225
|
+
:form_params => form_params,
|
|
226
|
+
:body => post_body,
|
|
227
|
+
:auth_names => auth_names,
|
|
228
|
+
:return_type => return_type
|
|
229
|
+
)
|
|
230
|
+
|
|
231
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
232
|
+
if @api_client.config.debugging
|
|
233
|
+
@api_client.config.logger.debug "API called: PlaylistApi#curate_playlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
234
|
+
end
|
|
235
|
+
return data, status_code, headers
|
|
236
|
+
end
|
|
237
|
+
|
|
161
238
|
# Delete playlist.
|
|
162
239
|
# @param songtradr_playlist_guid [String] ID of the file that should be deleted.
|
|
163
240
|
# @param [Hash] opts the optional parameters
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -276,6 +276,74 @@ module SongtradrApiClientRuby
|
|
|
276
276
|
return data, status_code, headers
|
|
277
277
|
end
|
|
278
278
|
|
|
279
|
+
# Recognise and upload video. Responds with an object with recognition result.
|
|
280
|
+
# @param name [String] The Name of the image that will be uploaded
|
|
281
|
+
# @param url [String]
|
|
282
|
+
# @param [Hash] opts the optional parameters
|
|
283
|
+
# @return [VideoRecognitionResponse]
|
|
284
|
+
def init_video_upload(name, url, opts = {})
|
|
285
|
+
data, _status_code, _headers = init_video_upload_with_http_info(name, url, opts)
|
|
286
|
+
data
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Recognise and upload video. Responds with an object with recognition result.
|
|
290
|
+
# @param name [String] The Name of the image that will be uploaded
|
|
291
|
+
# @param url [String]
|
|
292
|
+
# @param [Hash] opts the optional parameters
|
|
293
|
+
# @return [Array<(VideoRecognitionResponse, Integer, Hash)>] VideoRecognitionResponse data, response status code and response headers
|
|
294
|
+
def init_video_upload_with_http_info(name, url, opts = {})
|
|
295
|
+
if @api_client.config.debugging
|
|
296
|
+
@api_client.config.logger.debug 'Calling API: UserApi.init_video_upload ...'
|
|
297
|
+
end
|
|
298
|
+
# verify the required parameter 'name' is set
|
|
299
|
+
if @api_client.config.client_side_validation && name.nil?
|
|
300
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling UserApi.init_video_upload"
|
|
301
|
+
end
|
|
302
|
+
# verify the required parameter 'url' is set
|
|
303
|
+
if @api_client.config.client_side_validation && url.nil?
|
|
304
|
+
fail ArgumentError, "Missing the required parameter 'url' when calling UserApi.init_video_upload"
|
|
305
|
+
end
|
|
306
|
+
# resource path
|
|
307
|
+
local_var_path = '/api/v1/user/file/{name}/initVideoUpload'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
|
|
308
|
+
|
|
309
|
+
# query parameters
|
|
310
|
+
query_params = opts[:query_params] || {}
|
|
311
|
+
query_params[:'url'] = url
|
|
312
|
+
|
|
313
|
+
# header parameters
|
|
314
|
+
header_params = opts[:header_params] || {}
|
|
315
|
+
# HTTP header 'Accept' (if needed)
|
|
316
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
317
|
+
|
|
318
|
+
# form parameters
|
|
319
|
+
form_params = opts[:form_params] || {}
|
|
320
|
+
|
|
321
|
+
# http body (model)
|
|
322
|
+
post_body = opts[:debug_body]
|
|
323
|
+
|
|
324
|
+
# return_type
|
|
325
|
+
return_type = opts[:debug_return_type] || 'VideoRecognitionResponse'
|
|
326
|
+
|
|
327
|
+
# auth_names
|
|
328
|
+
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
329
|
+
|
|
330
|
+
new_options = opts.merge(
|
|
331
|
+
:operation => :"UserApi.init_video_upload",
|
|
332
|
+
:header_params => header_params,
|
|
333
|
+
:query_params => query_params,
|
|
334
|
+
:form_params => form_params,
|
|
335
|
+
:body => post_body,
|
|
336
|
+
:auth_names => auth_names,
|
|
337
|
+
:return_type => return_type
|
|
338
|
+
)
|
|
339
|
+
|
|
340
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
341
|
+
if @api_client.config.debugging
|
|
342
|
+
@api_client.config.logger.debug "API called: UserApi#init_video_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
343
|
+
end
|
|
344
|
+
return data, status_code, headers
|
|
345
|
+
end
|
|
346
|
+
|
|
279
347
|
# Initialize a file upload. Responds with an URL where the file can be uploaded.
|
|
280
348
|
# @param name [String] The Name of the file that will be uploaded
|
|
281
349
|
# @param folder [String] The Name of the folder that the file will be placed in
|
|
@@ -351,6 +419,74 @@ module SongtradrApiClientRuby
|
|
|
351
419
|
return data, status_code, headers
|
|
352
420
|
end
|
|
353
421
|
|
|
422
|
+
# Recognise and upload image. Responds with an object with recognition result.
|
|
423
|
+
# @param name [String] The Name of the image that will be uploaded
|
|
424
|
+
# @param url [String]
|
|
425
|
+
# @param [Hash] opts the optional parameters
|
|
426
|
+
# @return [ImageRecognitionResponse]
|
|
427
|
+
def initiate_user_image_upload(name, url, opts = {})
|
|
428
|
+
data, _status_code, _headers = initiate_user_image_upload_with_http_info(name, url, opts)
|
|
429
|
+
data
|
|
430
|
+
end
|
|
431
|
+
|
|
432
|
+
# Recognise and upload image. Responds with an object with recognition result.
|
|
433
|
+
# @param name [String] The Name of the image that will be uploaded
|
|
434
|
+
# @param url [String]
|
|
435
|
+
# @param [Hash] opts the optional parameters
|
|
436
|
+
# @return [Array<(ImageRecognitionResponse, Integer, Hash)>] ImageRecognitionResponse data, response status code and response headers
|
|
437
|
+
def initiate_user_image_upload_with_http_info(name, url, opts = {})
|
|
438
|
+
if @api_client.config.debugging
|
|
439
|
+
@api_client.config.logger.debug 'Calling API: UserApi.initiate_user_image_upload ...'
|
|
440
|
+
end
|
|
441
|
+
# verify the required parameter 'name' is set
|
|
442
|
+
if @api_client.config.client_side_validation && name.nil?
|
|
443
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling UserApi.initiate_user_image_upload"
|
|
444
|
+
end
|
|
445
|
+
# verify the required parameter 'url' is set
|
|
446
|
+
if @api_client.config.client_side_validation && url.nil?
|
|
447
|
+
fail ArgumentError, "Missing the required parameter 'url' when calling UserApi.initiate_user_image_upload"
|
|
448
|
+
end
|
|
449
|
+
# resource path
|
|
450
|
+
local_var_path = '/api/v1/user/file/{name}/initImageUpload'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
|
|
451
|
+
|
|
452
|
+
# query parameters
|
|
453
|
+
query_params = opts[:query_params] || {}
|
|
454
|
+
query_params[:'url'] = url
|
|
455
|
+
|
|
456
|
+
# header parameters
|
|
457
|
+
header_params = opts[:header_params] || {}
|
|
458
|
+
# HTTP header 'Accept' (if needed)
|
|
459
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
460
|
+
|
|
461
|
+
# form parameters
|
|
462
|
+
form_params = opts[:form_params] || {}
|
|
463
|
+
|
|
464
|
+
# http body (model)
|
|
465
|
+
post_body = opts[:debug_body]
|
|
466
|
+
|
|
467
|
+
# return_type
|
|
468
|
+
return_type = opts[:debug_return_type] || 'ImageRecognitionResponse'
|
|
469
|
+
|
|
470
|
+
# auth_names
|
|
471
|
+
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
472
|
+
|
|
473
|
+
new_options = opts.merge(
|
|
474
|
+
:operation => :"UserApi.initiate_user_image_upload",
|
|
475
|
+
:header_params => header_params,
|
|
476
|
+
:query_params => query_params,
|
|
477
|
+
:form_params => form_params,
|
|
478
|
+
:body => post_body,
|
|
479
|
+
:auth_names => auth_names,
|
|
480
|
+
:return_type => return_type
|
|
481
|
+
)
|
|
482
|
+
|
|
483
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
484
|
+
if @api_client.config.debugging
|
|
485
|
+
@api_client.config.logger.debug "API called: UserApi#initiate_user_image_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
486
|
+
end
|
|
487
|
+
return data, status_code, headers
|
|
488
|
+
end
|
|
489
|
+
|
|
354
490
|
# Login to generate a bearer token.
|
|
355
491
|
# @param login_dto [LoginDTO]
|
|
356
492
|
# @param [Hash] opts the optional parameters
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -18,6 +18,7 @@ require 'time'
|
|
|
18
18
|
require 'faraday'
|
|
19
19
|
require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
|
|
20
20
|
|
|
21
|
+
|
|
21
22
|
module SongtradrApiClientRuby
|
|
22
23
|
class ApiClient
|
|
23
24
|
# The Configuration object holding settings to be used in the API client.
|
|
@@ -258,7 +259,7 @@ module SongtradrApiClientRuby
|
|
|
258
259
|
return nil if body.nil? || body.empty?
|
|
259
260
|
|
|
260
261
|
# return response body directly for String return type
|
|
261
|
-
return body if return_type == 'String'
|
|
262
|
+
return body.to_s if return_type == 'String'
|
|
262
263
|
|
|
263
264
|
# ensuring a default content type
|
|
264
265
|
content_type = response.headers['Content-Type'] || 'application/json'
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -378,5 +378,6 @@ module SongtradrApiClientRuby
|
|
|
378
378
|
end
|
|
379
379
|
end
|
|
380
380
|
end
|
|
381
|
+
|
|
381
382
|
end
|
|
382
383
|
end
|