songtradr_api_client_ruby 1.13.7 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +5 -37
- data/docs/FileSmallDTO.md +7 -7
- data/docs/MusicalFeaturesDTO.md +2 -2
- data/docs/PlaylistApi.md +0 -214
- data/docs/RecordingApi.md +0 -204
- data/docs/RecordingMediumDTO.md +2 -2
- data/docs/UserApi.md +0 -456
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -201
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -189
- data/lib/songtradr_api_client_ruby/api/user_api.rb +134 -746
- data/lib/songtradr_api_client_ruby/api_client.rb +37 -35
- data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
- data/lib/songtradr_api_client_ruby/configuration.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/age_range.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/beard.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/bounding_box.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/dominant_color.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/emotion.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/eye_direction.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/eye_open.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/face_detail.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/face_detection.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/face_occluded.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +36 -36
- data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/gender.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/image_quality.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/instance.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label_alias.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label_category.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label_detection.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/landmark.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/mouth_open.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +24 -24
- data/lib/songtradr_api_client_ruby/models/mustache.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/parent.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/pose.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +12 -12
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/smile.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/sunglasses.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/user_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/version.rb +2 -2
- data/lib/songtradr_api_client_ruby.rb +1 -22
- data/openapi-generator-config.yaml +1 -1
- data/songtradr_api_client_ruby.gemspec +2 -1
- data/spec/api/allowed_values_api_spec.rb +1 -1
- data/spec/api/playlist_api_spec.rb +1 -38
- data/spec/api/recording_api_spec.rb +1 -34
- data/spec/api/user_api_spec.rb +1 -110
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/age_range_spec.rb +1 -1
- data/spec/models/beard_spec.rb +1 -1
- data/spec/models/bounding_box_spec.rb +1 -1
- data/spec/models/category_medium_dto_spec.rb +1 -1
- data/spec/models/category_minimal_dto_spec.rb +1 -1
- data/spec/models/config_access_dto_spec.rb +1 -1
- data/spec/models/config_identifier_dto_spec.rb +1 -1
- data/spec/models/contributor_type_dto_spec.rb +1 -1
- data/spec/models/curate_playlist_dto_spec.rb +1 -1
- data/spec/models/curate_playlist_response_dto_spec.rb +1 -1
- data/spec/models/dominant_color_spec.rb +1 -1
- data/spec/models/emotion_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/eye_direction_spec.rb +1 -1
- data/spec/models/eye_open_spec.rb +1 -1
- data/spec/models/eyeglasses_spec.rb +1 -1
- data/spec/models/face_detail_spec.rb +1 -1
- data/spec/models/face_detection_spec.rb +1 -1
- data/spec/models/face_occluded_spec.rb +1 -1
- data/spec/models/field_summary_dto_spec.rb +1 -1
- data/spec/models/file_dto_spec.rb +1 -1
- data/spec/models/file_list_dto_spec.rb +1 -1
- data/spec/models/file_small_dto_spec.rb +17 -17
- data/spec/models/file_upload_dto_spec.rb +1 -1
- data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
- data/spec/models/files_summary_dto_spec.rb +1 -1
- data/spec/models/forgot_password_dto_spec.rb +1 -1
- data/spec/models/gender_spec.rb +1 -1
- data/spec/models/genre_dto_spec.rb +1 -1
- data/spec/models/genre_minimal_dto_spec.rb +1 -1
- data/spec/models/genres_summary_dto_spec.rb +1 -1
- data/spec/models/image_quality_spec.rb +1 -1
- data/spec/models/image_recognition_response_spec.rb +1 -1
- data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
- data/spec/models/instance_spec.rb +1 -1
- data/spec/models/jwt_token_dto_spec.rb +1 -1
- data/spec/models/label_alias_spec.rb +1 -1
- data/spec/models/label_category_spec.rb +1 -1
- data/spec/models/label_detection_spec.rb +1 -1
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/landmark_spec.rb +1 -1
- data/spec/models/login_dto_spec.rb +1 -1
- data/spec/models/mouth_open_spec.rb +1 -1
- data/spec/models/musical_features_dto_spec.rb +11 -11
- data/spec/models/mustache_spec.rb +1 -1
- data/spec/models/parent_spec.rb +1 -1
- data/spec/models/party_small_dto_spec.rb +1 -1
- data/spec/models/pose_spec.rb +1 -1
- data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
- data/spec/models/recording_genre_prediction_dto_spec.rb +1 -1
- data/spec/models/recording_list_dto_spec.rb +1 -1
- data/spec/models/recording_medium_dto_spec.rb +3 -3
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +1 -1
- data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
- data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
- data/spec/models/recording_party_dto_spec.rb +1 -1
- data/spec/models/recording_small_dto_spec.rb +1 -1
- data/spec/models/recording_tag_small_dto_spec.rb +1 -1
- data/spec/models/save_user_dto_spec.rb +1 -1
- data/spec/models/search_filter_values_dto_spec.rb +1 -1
- data/spec/models/search_recording_granular_dto_spec.rb +1 -1
- data/spec/models/sign_up_dto_spec.rb +1 -1
- data/spec/models/smile_spec.rb +1 -1
- data/spec/models/sunglasses_spec.rb +1 -1
- data/spec/models/tag_dto_spec.rb +1 -1
- data/spec/models/tag_small_dto_spec.rb +1 -1
- data/spec/models/taggram_dto_spec.rb +1 -1
- data/spec/models/tags_summary_dto_spec.rb +1 -1
- data/spec/models/tagstrength_dto_spec.rb +1 -1
- data/spec/models/title_dto_spec.rb +1 -1
- data/spec/models/token_request_spec.rb +1 -1
- data/spec/models/track_dto_spec.rb +1 -1
- data/spec/models/update_password_dto_spec.rb +1 -1
- data/spec/models/user_dto_spec.rb +1 -1
- data/spec/models/video_recognition_response_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +63 -147
- data/docs/ContextValue.md +0 -18
- data/docs/FileMinimalWithUrlDTO.md +0 -22
- data/docs/PLineDTO.md +0 -20
- data/docs/PartyApi.md +0 -75
- data/docs/PartyLargeDTO.md +0 -32
- data/docs/PlaylistLargeDTO.md +0 -38
- data/docs/ProductMediumDTO.md +0 -34
- data/docs/ProductPartyDTO.md +0 -20
- data/docs/RecordingLargeDTO.md +0 -40
- data/docs/RecordingPlaylistDTO.md +0 -24
- data/docs/SaveFileRecordingDTO.md +0 -240
- data/docs/SavePlaylistDTO.md +0 -34
- data/docs/SaveRecordingGenreDTO.md +0 -22
- data/docs/SaveRecordingPartyDTO.md +0 -20
- data/docs/SaveRecordingPlaylistDTO.md +0 -22
- data/docs/SaveRecordingTagDTO.md +0 -20
- data/docs/SaveReferrerDTO.md +0 -20
- data/docs/SaveTaggramsDTO.md +0 -82
- data/docs/SearchRecordingGranularAbstractionDTO.md +0 -20
- data/docs/TrackToMediumProductDTO.md +0 -22
- data/docs/UsageDTO.md +0 -18
- data/lib/songtradr_api_client_ruby/api/party_api.rb +0 -84
- data/lib/songtradr_api_client_ruby/models/context_value.rb +0 -216
- data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +0 -254
- data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +0 -231
- data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +0 -285
- data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +0 -350
- data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +0 -323
- data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +0 -233
- data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +0 -383
- data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +0 -242
- data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +0 -1864
- data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +0 -353
- data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +0 -240
- data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +0 -272
- data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +0 -247
- data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +0 -231
- data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +0 -224
- data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +0 -569
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +0 -267
- data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +0 -247
- data/lib/songtradr_api_client_ruby/models/usage_dto.rb +0 -215
- data/spec/api/party_api_spec.rb +0 -46
- data/spec/models/context_value_spec.rb +0 -36
- data/spec/models/file_minimal_with_url_dto_spec.rb +0 -48
- data/spec/models/p_line_dto_spec.rb +0 -42
- data/spec/models/party_large_dto_spec.rb +0 -78
- data/spec/models/playlist_large_dto_spec.rb +0 -100
- data/spec/models/product_medium_dto_spec.rb +0 -84
- data/spec/models/product_party_dto_spec.rb +0 -42
- data/spec/models/recording_large_dto_spec.rb +0 -102
- data/spec/models/recording_playlist_dto_spec.rb +0 -54
- data/spec/models/save_file_recording_dto_spec.rb +0 -894
- data/spec/models/save_playlist_dto_spec.rb +0 -88
- data/spec/models/save_recording_genre_dto_spec.rb +0 -48
- data/spec/models/save_recording_party_dto_spec.rb +0 -46
- data/spec/models/save_recording_playlist_dto_spec.rb +0 -48
- data/spec/models/save_recording_tag_dto_spec.rb +0 -42
- data/spec/models/save_referrer_dto_spec.rb +0 -42
- data/spec/models/save_taggrams_dto_spec.rb +0 -228
- data/spec/models/search_recording_granular_abstraction_dto_spec.rb +0 -46
- data/spec/models/track_to_medium_product_dto_spec.rb +0 -48
- data/spec/models/usage_dto_spec.rb +0 -36
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 65ed599ec7e016af261c1639c18a9d6e95863a97b9c571407342d5ced9c1e311
|
|
4
|
+
data.tar.gz: 6f0c416628693187a2f5e0fa97d24c47c997cf6bf6b4588703ea1f4cf2bca05d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 48e5486454832027ef5d666025e23c320bc08ef133a38907028d10aa42750489af0d753994e04dd03aeaea7d27d301b09f671620751cb9ff7e17d30be5ecb237
|
|
7
|
+
data.tar.gz: '08bc5004c59e2a4e743799aee69f019a9c46e3e420b2036d6c244b0512c0b39fef063eabefd84a5f49e7c86079dc21ac350218ef4045bbefb07e44a18ff2461a'
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -33,8 +33,8 @@ You can either search the released music via the /public/recording endpoints or
|
|
|
33
33
|
|
|
34
34
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
35
35
|
|
|
36
|
-
- API version: 1.
|
|
37
|
-
- Package version: 1.
|
|
36
|
+
- API version: 1.15.0
|
|
37
|
+
- Package version: 1.15.0
|
|
38
38
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
39
39
|
For more information, please visit [https://songtradr.com](https://songtradr.com)
|
|
40
40
|
|
|
@@ -51,16 +51,16 @@ gem build songtradr_api_client_ruby.gemspec
|
|
|
51
51
|
Then either install the gem locally:
|
|
52
52
|
|
|
53
53
|
```shell
|
|
54
|
-
gem install ./songtradr_api_client_ruby-1.
|
|
54
|
+
gem install ./songtradr_api_client_ruby-1.15.0.gem
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
(for development, run `gem install --dev ./songtradr_api_client_ruby-1.
|
|
57
|
+
(for development, run `gem install --dev ./songtradr_api_client_ruby-1.15.0.gem` to install the development dependencies)
|
|
58
58
|
|
|
59
59
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
60
60
|
|
|
61
61
|
Finally add this to the Gemfile:
|
|
62
62
|
|
|
63
|
-
gem 'songtradr_api_client_ruby', '~> 1.
|
|
63
|
+
gem 'songtradr_api_client_ruby', '~> 1.15.0'
|
|
64
64
|
|
|
65
65
|
### Install from Git
|
|
66
66
|
|
|
@@ -108,22 +108,14 @@ Class | Method | HTTP request | Description
|
|
|
108
108
|
*SongtradrApiClientRuby::AllowedValuesApi* | [**allowed_musical_features**](docs/AllowedValuesApi.md#allowed_musical_features) | **GET** /api/v1/allowedValues/musicalFeatures | Allowed values for music descriptive parameters to be used in the searchAll endpoint.
|
|
109
109
|
*SongtradrApiClientRuby::AllowedValuesApi* | [**genres**](docs/AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres.
|
|
110
110
|
*SongtradrApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
|
|
111
|
-
*SongtradrApiClientRuby::PartyApi* | [**party**](docs/PartyApi.md#party) | **GET** /api/v1/party | Information on a person, group or company.
|
|
112
|
-
*SongtradrApiClientRuby::PlaylistApi* | [**all_playlists**](docs/PlaylistApi.md#all_playlists) | **GET** /api/v1/playlist | All playlists.
|
|
113
|
-
*SongtradrApiClientRuby::PlaylistApi* | [**create_or_update_playlist**](docs/PlaylistApi.md#create_or_update_playlist) | **POST** /api/v1/playlist | Create and edit playlist.
|
|
114
111
|
*SongtradrApiClientRuby::PlaylistApi* | [**curate_playlist**](docs/PlaylistApi.md#curate_playlist) | **POST** /api/v1/playlist/{methodName} | Curate playlist.
|
|
115
|
-
*SongtradrApiClientRuby::PlaylistApi* | [**delete_playlist**](docs/PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist.
|
|
116
112
|
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_musical_features**](docs/RecordingApi.md#recordings_by_ids_with_musical_features) | **GET** /api/v1/public/recording/{ids}/musicalFeatures | AI generated moods, musical features and more for recordings.
|
|
117
113
|
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_similarities**](docs/RecordingApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings.
|
|
118
114
|
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_taggrams**](docs/RecordingApi.md#recordings_by_ids_with_taggrams) | **GET** /api/v1/public/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings.
|
|
119
115
|
*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_tagstrengths**](docs/RecordingApi.md#recordings_by_ids_with_tagstrengths) | **GET** /api/v1/public/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings.
|
|
120
|
-
*SongtradrApiClientRuby::RecordingApi* | [**recordings_large_by_ids**](docs/RecordingApi.md#recordings_large_by_ids) | **GET** /api/v1/public/recording/l/{ids} | Recordings by IDs with a large response.
|
|
121
116
|
*SongtradrApiClientRuby::RecordingApi* | [**recordings_medium_by_ids**](docs/RecordingApi.md#recordings_medium_by_ids) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response.
|
|
122
|
-
*SongtradrApiClientRuby::RecordingApi* | [**recordings_small_by_ids**](docs/RecordingApi.md#recordings_small_by_ids) | **GET** /api/v1/public/recording/s/{ids} | Recordings by IDs with a small response.
|
|
123
117
|
*SongtradrApiClientRuby::RecordingApi* | [**search_recordings**](docs/RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more.
|
|
124
118
|
*SongtradrApiClientRuby::RecordingApi* | [**search_recordings_granular**](docs/RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options.
|
|
125
|
-
*SongtradrApiClientRuby::RecordingApi* | [**search_recordings_granular_abstraction**](docs/RecordingApi.md#search_recordings_granular_abstraction) | **POST** /api/v1/public/recording/searchGranularAbstraction | Recordings by abstracted wordings and granular search options.
|
|
126
|
-
*SongtradrApiClientRuby::UserApi* | [**create_user_referrer**](docs/UserApi.md#create_user_referrer) | **POST** /api/v1/user/referrers/new |
|
|
127
119
|
*SongtradrApiClientRuby::UserApi* | [**delete_user_file**](docs/UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file.
|
|
128
120
|
*SongtradrApiClientRuby::UserApi* | [**edit_me**](docs/UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user
|
|
129
121
|
*SongtradrApiClientRuby::UserApi* | [**forgot_password**](docs/UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email
|
|
@@ -138,14 +130,10 @@ Class | Method | HTTP request | Description
|
|
|
138
130
|
*SongtradrApiClientRuby::UserApi* | [**sign_up**](docs/UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user.
|
|
139
131
|
*SongtradrApiClientRuby::UserApi* | [**token**](docs/UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token
|
|
140
132
|
*SongtradrApiClientRuby::UserApi* | [**update_password**](docs/UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token
|
|
141
|
-
*SongtradrApiClientRuby::UserApi* | [**update_user_file_recording**](docs/UserApi.md#update_user_file_recording) | **POST** /api/v1/user/file/{objectKey} | Create and edit metadata of your files.
|
|
142
133
|
*SongtradrApiClientRuby::UserApi* | [**user_file**](docs/UserApi.md#user_file) | **GET** /api/v1/user/file/{objectKey} | Details and a download link for a file.
|
|
143
134
|
*SongtradrApiClientRuby::UserApi* | [**user_files**](docs/UserApi.md#user_files) | **GET** /api/v1/user/files | List and search your own files.
|
|
144
|
-
*SongtradrApiClientRuby::UserApi* | [**user_files_download**](docs/UserApi.md#user_files_download) | **GET** /api/v1/user/filesDownload | Download links for your files
|
|
145
135
|
*SongtradrApiClientRuby::UserApi* | [**user_files_status**](docs/UserApi.md#user_files_status) | **GET** /api/v1/user/filesStatus | Status details for files.
|
|
146
136
|
*SongtradrApiClientRuby::UserApi* | [**user_files_summary**](docs/UserApi.md#user_files_summary) | **GET** /api/v1/user/filesSummary | Summary fo your files.
|
|
147
|
-
*SongtradrApiClientRuby::UserApi* | [**user_folders**](docs/UserApi.md#user_folders) | **GET** /api/v1/user/folders | Your Folders
|
|
148
|
-
*SongtradrApiClientRuby::UserApi* | [**user_referrers**](docs/UserApi.md#user_referrers) | **GET** /api/v1/user/referrers/{username} |
|
|
149
137
|
|
|
150
138
|
|
|
151
139
|
## Documentation for Models
|
|
@@ -157,7 +145,6 @@ Class | Method | HTTP request | Description
|
|
|
157
145
|
- [SongtradrApiClientRuby::CategoryMinimalDTO](docs/CategoryMinimalDTO.md)
|
|
158
146
|
- [SongtradrApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
|
|
159
147
|
- [SongtradrApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
|
|
160
|
-
- [SongtradrApiClientRuby::ContextValue](docs/ContextValue.md)
|
|
161
148
|
- [SongtradrApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
|
|
162
149
|
- [SongtradrApiClientRuby::CuratePlaylistDTO](docs/CuratePlaylistDTO.md)
|
|
163
150
|
- [SongtradrApiClientRuby::CuratePlaylistResponseDTO](docs/CuratePlaylistResponseDTO.md)
|
|
@@ -173,7 +160,6 @@ Class | Method | HTTP request | Description
|
|
|
173
160
|
- [SongtradrApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
|
|
174
161
|
- [SongtradrApiClientRuby::FileDTO](docs/FileDTO.md)
|
|
175
162
|
- [SongtradrApiClientRuby::FileListDTO](docs/FileListDTO.md)
|
|
176
|
-
- [SongtradrApiClientRuby::FileMinimalWithUrlDTO](docs/FileMinimalWithUrlDTO.md)
|
|
177
163
|
- [SongtradrApiClientRuby::FileSmallDTO](docs/FileSmallDTO.md)
|
|
178
164
|
- [SongtradrApiClientRuby::FileUploadDTO](docs/FileUploadDTO.md)
|
|
179
165
|
- [SongtradrApiClientRuby::FileWIthUrlDTO](docs/FileWIthUrlDTO.md)
|
|
@@ -197,37 +183,21 @@ Class | Method | HTTP request | Description
|
|
|
197
183
|
- [SongtradrApiClientRuby::MouthOpen](docs/MouthOpen.md)
|
|
198
184
|
- [SongtradrApiClientRuby::MusicalFeaturesDTO](docs/MusicalFeaturesDTO.md)
|
|
199
185
|
- [SongtradrApiClientRuby::Mustache](docs/Mustache.md)
|
|
200
|
-
- [SongtradrApiClientRuby::PLineDTO](docs/PLineDTO.md)
|
|
201
186
|
- [SongtradrApiClientRuby::Parent](docs/Parent.md)
|
|
202
|
-
- [SongtradrApiClientRuby::PartyLargeDTO](docs/PartyLargeDTO.md)
|
|
203
187
|
- [SongtradrApiClientRuby::PartySmallDTO](docs/PartySmallDTO.md)
|
|
204
|
-
- [SongtradrApiClientRuby::PlaylistLargeDTO](docs/PlaylistLargeDTO.md)
|
|
205
188
|
- [SongtradrApiClientRuby::Pose](docs/Pose.md)
|
|
206
|
-
- [SongtradrApiClientRuby::ProductMediumDTO](docs/ProductMediumDTO.md)
|
|
207
|
-
- [SongtradrApiClientRuby::ProductPartyDTO](docs/ProductPartyDTO.md)
|
|
208
189
|
- [SongtradrApiClientRuby::RecordingForSimilaritySearchDTO](docs/RecordingForSimilaritySearchDTO.md)
|
|
209
190
|
- [SongtradrApiClientRuby::RecordingGenrePredictionDTO](docs/RecordingGenrePredictionDTO.md)
|
|
210
|
-
- [SongtradrApiClientRuby::RecordingLargeDTO](docs/RecordingLargeDTO.md)
|
|
211
191
|
- [SongtradrApiClientRuby::RecordingListDTO](docs/RecordingListDTO.md)
|
|
212
192
|
- [SongtradrApiClientRuby::RecordingMediumDTO](docs/RecordingMediumDTO.md)
|
|
213
193
|
- [SongtradrApiClientRuby::RecordingMinimalWithMusicalFeaturesDTO](docs/RecordingMinimalWithMusicalFeaturesDTO.md)
|
|
214
194
|
- [SongtradrApiClientRuby::RecordingMinimalWithTaggramsDTO](docs/RecordingMinimalWithTaggramsDTO.md)
|
|
215
195
|
- [SongtradrApiClientRuby::RecordingMinimalWithTagstrengthsDTO](docs/RecordingMinimalWithTagstrengthsDTO.md)
|
|
216
196
|
- [SongtradrApiClientRuby::RecordingPartyDTO](docs/RecordingPartyDTO.md)
|
|
217
|
-
- [SongtradrApiClientRuby::RecordingPlaylistDTO](docs/RecordingPlaylistDTO.md)
|
|
218
197
|
- [SongtradrApiClientRuby::RecordingSmallDTO](docs/RecordingSmallDTO.md)
|
|
219
198
|
- [SongtradrApiClientRuby::RecordingTagSmallDTO](docs/RecordingTagSmallDTO.md)
|
|
220
|
-
- [SongtradrApiClientRuby::SaveFileRecordingDTO](docs/SaveFileRecordingDTO.md)
|
|
221
|
-
- [SongtradrApiClientRuby::SavePlaylistDTO](docs/SavePlaylistDTO.md)
|
|
222
|
-
- [SongtradrApiClientRuby::SaveRecordingGenreDTO](docs/SaveRecordingGenreDTO.md)
|
|
223
|
-
- [SongtradrApiClientRuby::SaveRecordingPartyDTO](docs/SaveRecordingPartyDTO.md)
|
|
224
|
-
- [SongtradrApiClientRuby::SaveRecordingPlaylistDTO](docs/SaveRecordingPlaylistDTO.md)
|
|
225
|
-
- [SongtradrApiClientRuby::SaveRecordingTagDTO](docs/SaveRecordingTagDTO.md)
|
|
226
|
-
- [SongtradrApiClientRuby::SaveReferrerDTO](docs/SaveReferrerDTO.md)
|
|
227
|
-
- [SongtradrApiClientRuby::SaveTaggramsDTO](docs/SaveTaggramsDTO.md)
|
|
228
199
|
- [SongtradrApiClientRuby::SaveUserDTO](docs/SaveUserDTO.md)
|
|
229
200
|
- [SongtradrApiClientRuby::SearchFilterValuesDTO](docs/SearchFilterValuesDTO.md)
|
|
230
|
-
- [SongtradrApiClientRuby::SearchRecordingGranularAbstractionDTO](docs/SearchRecordingGranularAbstractionDTO.md)
|
|
231
201
|
- [SongtradrApiClientRuby::SearchRecordingGranularDTO](docs/SearchRecordingGranularDTO.md)
|
|
232
202
|
- [SongtradrApiClientRuby::SignUpDTO](docs/SignUpDTO.md)
|
|
233
203
|
- [SongtradrApiClientRuby::Smile](docs/Smile.md)
|
|
@@ -240,9 +210,7 @@ Class | Method | HTTP request | Description
|
|
|
240
210
|
- [SongtradrApiClientRuby::TitleDTO](docs/TitleDTO.md)
|
|
241
211
|
- [SongtradrApiClientRuby::TokenRequest](docs/TokenRequest.md)
|
|
242
212
|
- [SongtradrApiClientRuby::TrackDTO](docs/TrackDTO.md)
|
|
243
|
-
- [SongtradrApiClientRuby::TrackToMediumProductDTO](docs/TrackToMediumProductDTO.md)
|
|
244
213
|
- [SongtradrApiClientRuby::UpdatePasswordDTO](docs/UpdatePasswordDTO.md)
|
|
245
|
-
- [SongtradrApiClientRuby::UsageDTO](docs/UsageDTO.md)
|
|
246
214
|
- [SongtradrApiClientRuby::UserDTO](docs/UserDTO.md)
|
|
247
215
|
- [SongtradrApiClientRuby::VideoRecognitionResponse](docs/VideoRecognitionResponse.md)
|
|
248
216
|
|
data/docs/FileSmallDTO.md
CHANGED
|
@@ -9,9 +9,6 @@
|
|
|
9
9
|
| **extension** | **String** | extension of the file | |
|
|
10
10
|
| **error_message** | **String** | | [optional] |
|
|
11
11
|
| **folder** | **String** | | |
|
|
12
|
-
| **upload_start_time** | **Time** | | [optional] |
|
|
13
|
-
| **upload_end_time** | **Time** | | [optional] |
|
|
14
|
-
| **object_key** | **String** | | |
|
|
15
12
|
| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
|
|
16
13
|
| **fingerprint_start_time** | **Time** | | [optional] |
|
|
17
14
|
| **fingerprint_end_time** | **Time** | | [optional] |
|
|
@@ -19,6 +16,9 @@
|
|
|
19
16
|
| **inference_start_time** | **Time** | | [optional] |
|
|
20
17
|
| **inference_end_time** | **Time** | | [optional] |
|
|
21
18
|
| **error_time** | **Time** | | [optional] |
|
|
19
|
+
| **object_key** | **String** | | |
|
|
20
|
+
| **upload_start_time** | **Time** | | [optional] |
|
|
21
|
+
| **upload_end_time** | **Time** | | [optional] |
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -31,16 +31,16 @@ instance = SongtradrApiClientRuby::FileSmallDTO.new(
|
|
|
31
31
|
extension: null,
|
|
32
32
|
error_message: null,
|
|
33
33
|
folder: null,
|
|
34
|
-
upload_start_time: null,
|
|
35
|
-
upload_end_time: null,
|
|
36
|
-
object_key: null,
|
|
37
34
|
fingerprint_status: null,
|
|
38
35
|
fingerprint_start_time: null,
|
|
39
36
|
fingerprint_end_time: null,
|
|
40
37
|
inference_status: null,
|
|
41
38
|
inference_start_time: null,
|
|
42
39
|
inference_end_time: null,
|
|
43
|
-
error_time: null
|
|
40
|
+
error_time: null,
|
|
41
|
+
object_key: null,
|
|
42
|
+
upload_start_time: null,
|
|
43
|
+
upload_end_time: null
|
|
44
44
|
)
|
|
45
45
|
```
|
|
46
46
|
|
data/docs/MusicalFeaturesDTO.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **space** | **String** | Search for space | [optional] |
|
|
8
8
|
| **arousal** | **String** | Search for an arousal | [optional] |
|
|
9
|
+
| **language_of_performance** | **String** | | [optional] |
|
|
9
10
|
| **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
|
|
10
11
|
| **energy** | **String** | Search for energy | [optional] |
|
|
11
12
|
| **engagement** | **String** | Search for an engagement | [optional] |
|
|
@@ -28,7 +29,6 @@
|
|
|
28
29
|
| **curateability** | **String** | Search for curatebility | [optional] |
|
|
29
30
|
| **use_case** | **String** | Search for use case | [optional] |
|
|
30
31
|
| **channel_suitability** | **String** | Search for social media suitability | [optional] |
|
|
31
|
-
| **language_of_performance** | **String** | | [optional] |
|
|
32
32
|
| **primary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
33
33
|
| **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
|
|
34
34
|
| **secondary_mood_cluster_affinity** | **Float** | | [optional] |
|
|
@@ -98,6 +98,7 @@ require 'songtradr_api_client_ruby'
|
|
|
98
98
|
instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
99
99
|
space: null,
|
|
100
100
|
arousal: null,
|
|
101
|
+
language_of_performance: null,
|
|
101
102
|
dominant_instrument: null,
|
|
102
103
|
energy: null,
|
|
103
104
|
engagement: null,
|
|
@@ -120,7 +121,6 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
|
|
|
120
121
|
curateability: null,
|
|
121
122
|
use_case: null,
|
|
122
123
|
channel_suitability: null,
|
|
123
|
-
language_of_performance: null,
|
|
124
124
|
primary_mood_cluster_affinity: null,
|
|
125
125
|
secondary_mood_cluster: null,
|
|
126
126
|
secondary_mood_cluster_affinity: null,
|
data/docs/PlaylistApi.md
CHANGED
|
@@ -4,154 +4,7 @@ All URIs are relative to *https://api.songtradr.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**all_playlists**](PlaylistApi.md#all_playlists) | **GET** /api/v1/playlist | All playlists. |
|
|
8
|
-
| [**create_or_update_playlist**](PlaylistApi.md#create_or_update_playlist) | **POST** /api/v1/playlist | Create and edit playlist. |
|
|
9
7
|
| [**curate_playlist**](PlaylistApi.md#curate_playlist) | **POST** /api/v1/playlist/{methodName} | Curate playlist. |
|
|
10
|
-
| [**delete_playlist**](PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist. |
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## all_playlists
|
|
14
|
-
|
|
15
|
-
> <Array<PlaylistLargeDTO>> all_playlists(opts)
|
|
16
|
-
|
|
17
|
-
All playlists.
|
|
18
|
-
|
|
19
|
-
### Examples
|
|
20
|
-
|
|
21
|
-
```ruby
|
|
22
|
-
require 'time'
|
|
23
|
-
require 'songtradr_api_client_ruby'
|
|
24
|
-
# setup authorization
|
|
25
|
-
SongtradrApiClientRuby.configure do |config|
|
|
26
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
27
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
api_instance = SongtradrApiClientRuby::PlaylistApi.new
|
|
31
|
-
opts = {
|
|
32
|
-
include_recordings: true, # Boolean | Whether a playlist shall include recordings or not.
|
|
33
|
-
ignore_usages: true, # Boolean | Whether a playlist shall include all songs regardless of their track usages.
|
|
34
|
-
usage_filter_mode: 'any', # String | Whether a playlist recordings shall include all playlist usages or not.
|
|
35
|
-
songtradr_playlist_guid: 'songtradr_playlist_guid_example' # String |
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
begin
|
|
39
|
-
# All playlists.
|
|
40
|
-
result = api_instance.all_playlists(opts)
|
|
41
|
-
p result
|
|
42
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
43
|
-
puts "Error when calling PlaylistApi->all_playlists: #{e}"
|
|
44
|
-
end
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
#### Using the all_playlists_with_http_info variant
|
|
48
|
-
|
|
49
|
-
This returns an Array which contains the response data, status code and headers.
|
|
50
|
-
|
|
51
|
-
> <Array(<Array<PlaylistLargeDTO>>, Integer, Hash)> all_playlists_with_http_info(opts)
|
|
52
|
-
|
|
53
|
-
```ruby
|
|
54
|
-
begin
|
|
55
|
-
# All playlists.
|
|
56
|
-
data, status_code, headers = api_instance.all_playlists_with_http_info(opts)
|
|
57
|
-
p status_code # => 2xx
|
|
58
|
-
p headers # => { ... }
|
|
59
|
-
p data # => <Array<PlaylistLargeDTO>>
|
|
60
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
61
|
-
puts "Error when calling PlaylistApi->all_playlists_with_http_info: #{e}"
|
|
62
|
-
end
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Parameters
|
|
66
|
-
|
|
67
|
-
| Name | Type | Description | Notes |
|
|
68
|
-
| ---- | ---- | ----------- | ----- |
|
|
69
|
-
| **include_recordings** | **Boolean** | Whether a playlist shall include recordings or not. | [optional][default to false] |
|
|
70
|
-
| **ignore_usages** | **Boolean** | Whether a playlist shall include all songs regardless of their track usages. | [optional][default to false] |
|
|
71
|
-
| **usage_filter_mode** | **String** | Whether a playlist recordings shall include all playlist usages or not. | [optional][default to 'any'] |
|
|
72
|
-
| **songtradr_playlist_guid** | **String** | | [optional] |
|
|
73
|
-
|
|
74
|
-
### Return type
|
|
75
|
-
|
|
76
|
-
[**Array<PlaylistLargeDTO>**](PlaylistLargeDTO.md)
|
|
77
|
-
|
|
78
|
-
### Authorization
|
|
79
|
-
|
|
80
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
81
|
-
|
|
82
|
-
### HTTP request headers
|
|
83
|
-
|
|
84
|
-
- **Content-Type**: Not defined
|
|
85
|
-
- **Accept**: application/json
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
## create_or_update_playlist
|
|
89
|
-
|
|
90
|
-
> Object create_or_update_playlist(save_playlist_dto)
|
|
91
|
-
|
|
92
|
-
Create and edit playlist.
|
|
93
|
-
|
|
94
|
-
This endpoint expects always the full amount of information including all recordings.
|
|
95
|
-
|
|
96
|
-
### Examples
|
|
97
|
-
|
|
98
|
-
```ruby
|
|
99
|
-
require 'time'
|
|
100
|
-
require 'songtradr_api_client_ruby'
|
|
101
|
-
# setup authorization
|
|
102
|
-
SongtradrApiClientRuby.configure do |config|
|
|
103
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
104
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
105
|
-
end
|
|
106
|
-
|
|
107
|
-
api_instance = SongtradrApiClientRuby::PlaylistApi.new
|
|
108
|
-
save_playlist_dto = SongtradrApiClientRuby::SavePlaylistDTO.new({songtradr_playlist_guid: 'songtradr_playlist_guid_example', name: 'name_example', state: 'active', usages: ['usages_example']}) # SavePlaylistDTO |
|
|
109
|
-
|
|
110
|
-
begin
|
|
111
|
-
# Create and edit playlist.
|
|
112
|
-
result = api_instance.create_or_update_playlist(save_playlist_dto)
|
|
113
|
-
p result
|
|
114
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
115
|
-
puts "Error when calling PlaylistApi->create_or_update_playlist: #{e}"
|
|
116
|
-
end
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
#### Using the create_or_update_playlist_with_http_info variant
|
|
120
|
-
|
|
121
|
-
This returns an Array which contains the response data, status code and headers.
|
|
122
|
-
|
|
123
|
-
> <Array(Object, Integer, Hash)> create_or_update_playlist_with_http_info(save_playlist_dto)
|
|
124
|
-
|
|
125
|
-
```ruby
|
|
126
|
-
begin
|
|
127
|
-
# Create and edit playlist.
|
|
128
|
-
data, status_code, headers = api_instance.create_or_update_playlist_with_http_info(save_playlist_dto)
|
|
129
|
-
p status_code # => 2xx
|
|
130
|
-
p headers # => { ... }
|
|
131
|
-
p data # => Object
|
|
132
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
133
|
-
puts "Error when calling PlaylistApi->create_or_update_playlist_with_http_info: #{e}"
|
|
134
|
-
end
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
### Parameters
|
|
138
|
-
|
|
139
|
-
| Name | Type | Description | Notes |
|
|
140
|
-
| ---- | ---- | ----------- | ----- |
|
|
141
|
-
| **save_playlist_dto** | [**SavePlaylistDTO**](SavePlaylistDTO.md) | | |
|
|
142
|
-
|
|
143
|
-
### Return type
|
|
144
|
-
|
|
145
|
-
**Object**
|
|
146
|
-
|
|
147
|
-
### Authorization
|
|
148
|
-
|
|
149
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
150
|
-
|
|
151
|
-
### HTTP request headers
|
|
152
|
-
|
|
153
|
-
- **Content-Type**: application/json
|
|
154
|
-
- **Accept**: application/json
|
|
155
8
|
|
|
156
9
|
|
|
157
10
|
## curate_playlist
|
|
@@ -222,70 +75,3 @@ end
|
|
|
222
75
|
- **Content-Type**: application/json
|
|
223
76
|
- **Accept**: application/json
|
|
224
77
|
|
|
225
|
-
|
|
226
|
-
## delete_playlist
|
|
227
|
-
|
|
228
|
-
> Object delete_playlist(songtradr_playlist_guid)
|
|
229
|
-
|
|
230
|
-
Delete playlist.
|
|
231
|
-
|
|
232
|
-
### Examples
|
|
233
|
-
|
|
234
|
-
```ruby
|
|
235
|
-
require 'time'
|
|
236
|
-
require 'songtradr_api_client_ruby'
|
|
237
|
-
# setup authorization
|
|
238
|
-
SongtradrApiClientRuby.configure do |config|
|
|
239
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
240
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
241
|
-
end
|
|
242
|
-
|
|
243
|
-
api_instance = SongtradrApiClientRuby::PlaylistApi.new
|
|
244
|
-
songtradr_playlist_guid = '1234' # String | ID of the file that should be deleted.
|
|
245
|
-
|
|
246
|
-
begin
|
|
247
|
-
# Delete playlist.
|
|
248
|
-
result = api_instance.delete_playlist(songtradr_playlist_guid)
|
|
249
|
-
p result
|
|
250
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
251
|
-
puts "Error when calling PlaylistApi->delete_playlist: #{e}"
|
|
252
|
-
end
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
#### Using the delete_playlist_with_http_info variant
|
|
256
|
-
|
|
257
|
-
This returns an Array which contains the response data, status code and headers.
|
|
258
|
-
|
|
259
|
-
> <Array(Object, Integer, Hash)> delete_playlist_with_http_info(songtradr_playlist_guid)
|
|
260
|
-
|
|
261
|
-
```ruby
|
|
262
|
-
begin
|
|
263
|
-
# Delete playlist.
|
|
264
|
-
data, status_code, headers = api_instance.delete_playlist_with_http_info(songtradr_playlist_guid)
|
|
265
|
-
p status_code # => 2xx
|
|
266
|
-
p headers # => { ... }
|
|
267
|
-
p data # => Object
|
|
268
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
269
|
-
puts "Error when calling PlaylistApi->delete_playlist_with_http_info: #{e}"
|
|
270
|
-
end
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
### Parameters
|
|
274
|
-
|
|
275
|
-
| Name | Type | Description | Notes |
|
|
276
|
-
| ---- | ---- | ----------- | ----- |
|
|
277
|
-
| **songtradr_playlist_guid** | **String** | ID of the file that should be deleted. | |
|
|
278
|
-
|
|
279
|
-
### Return type
|
|
280
|
-
|
|
281
|
-
**Object**
|
|
282
|
-
|
|
283
|
-
### Authorization
|
|
284
|
-
|
|
285
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
286
|
-
|
|
287
|
-
### HTTP request headers
|
|
288
|
-
|
|
289
|
-
- **Content-Type**: Not defined
|
|
290
|
-
- **Accept**: application/hal+json, application/json
|
|
291
|
-
|