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
|
@@ -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.
|
|
6
|
+
The version of the OpenAPI document: 1.15.0
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -19,145 +19,6 @@ module SongtradrApiClientRuby
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# All playlists.
|
|
23
|
-
# @param [Hash] opts the optional parameters
|
|
24
|
-
# @option opts [Boolean] :include_recordings Whether a playlist shall include recordings or not. (default to false)
|
|
25
|
-
# @option opts [Boolean] :ignore_usages Whether a playlist shall include all songs regardless of their track usages. (default to false)
|
|
26
|
-
# @option opts [String] :usage_filter_mode Whether a playlist recordings shall include all playlist usages or not. (default to 'any')
|
|
27
|
-
# @option opts [String] :songtradr_playlist_guid
|
|
28
|
-
# @return [Array<PlaylistLargeDTO>]
|
|
29
|
-
def all_playlists(opts = {})
|
|
30
|
-
data, _status_code, _headers = all_playlists_with_http_info(opts)
|
|
31
|
-
data
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# All playlists.
|
|
35
|
-
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @option opts [Boolean] :include_recordings Whether a playlist shall include recordings or not. (default to false)
|
|
37
|
-
# @option opts [Boolean] :ignore_usages Whether a playlist shall include all songs regardless of their track usages. (default to false)
|
|
38
|
-
# @option opts [String] :usage_filter_mode Whether a playlist recordings shall include all playlist usages or not. (default to 'any')
|
|
39
|
-
# @option opts [String] :songtradr_playlist_guid
|
|
40
|
-
# @return [Array<(Array<PlaylistLargeDTO>, Integer, Hash)>] Array<PlaylistLargeDTO> data, response status code and response headers
|
|
41
|
-
def all_playlists_with_http_info(opts = {})
|
|
42
|
-
if @api_client.config.debugging
|
|
43
|
-
@api_client.config.logger.debug 'Calling API: PlaylistApi.all_playlists ...'
|
|
44
|
-
end
|
|
45
|
-
allowable_values = ["any", "all"]
|
|
46
|
-
if @api_client.config.client_side_validation && opts[:'usage_filter_mode'] && !allowable_values.include?(opts[:'usage_filter_mode'])
|
|
47
|
-
fail ArgumentError, "invalid value for \"usage_filter_mode\", must be one of #{allowable_values}"
|
|
48
|
-
end
|
|
49
|
-
# resource path
|
|
50
|
-
local_var_path = '/api/v1/playlist'
|
|
51
|
-
|
|
52
|
-
# query parameters
|
|
53
|
-
query_params = opts[:query_params] || {}
|
|
54
|
-
query_params[:'includeRecordings'] = opts[:'include_recordings'] if !opts[:'include_recordings'].nil?
|
|
55
|
-
query_params[:'ignoreUsages'] = opts[:'ignore_usages'] if !opts[:'ignore_usages'].nil?
|
|
56
|
-
query_params[:'usageFilterMode'] = opts[:'usage_filter_mode'] if !opts[:'usage_filter_mode'].nil?
|
|
57
|
-
query_params[:'songtradrPlaylistGuid'] = opts[:'songtradr_playlist_guid'] if !opts[:'songtradr_playlist_guid'].nil?
|
|
58
|
-
|
|
59
|
-
# header parameters
|
|
60
|
-
header_params = opts[:header_params] || {}
|
|
61
|
-
# HTTP header 'Accept' (if needed)
|
|
62
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
63
|
-
|
|
64
|
-
# form parameters
|
|
65
|
-
form_params = opts[:form_params] || {}
|
|
66
|
-
|
|
67
|
-
# http body (model)
|
|
68
|
-
post_body = opts[:debug_body]
|
|
69
|
-
|
|
70
|
-
# return_type
|
|
71
|
-
return_type = opts[:debug_return_type] || 'Array<PlaylistLargeDTO>'
|
|
72
|
-
|
|
73
|
-
# auth_names
|
|
74
|
-
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
75
|
-
|
|
76
|
-
new_options = opts.merge(
|
|
77
|
-
:operation => :"PlaylistApi.all_playlists",
|
|
78
|
-
:header_params => header_params,
|
|
79
|
-
:query_params => query_params,
|
|
80
|
-
:form_params => form_params,
|
|
81
|
-
:body => post_body,
|
|
82
|
-
:auth_names => auth_names,
|
|
83
|
-
:return_type => return_type
|
|
84
|
-
)
|
|
85
|
-
|
|
86
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
87
|
-
if @api_client.config.debugging
|
|
88
|
-
@api_client.config.logger.debug "API called: PlaylistApi#all_playlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
89
|
-
end
|
|
90
|
-
return data, status_code, headers
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
# Create and edit playlist.
|
|
94
|
-
# This endpoint expects always the full amount of information including all recordings.
|
|
95
|
-
# @param save_playlist_dto [SavePlaylistDTO]
|
|
96
|
-
# @param [Hash] opts the optional parameters
|
|
97
|
-
# @return [Object]
|
|
98
|
-
def create_or_update_playlist(save_playlist_dto, opts = {})
|
|
99
|
-
data, _status_code, _headers = create_or_update_playlist_with_http_info(save_playlist_dto, opts)
|
|
100
|
-
data
|
|
101
|
-
end
|
|
102
|
-
|
|
103
|
-
# Create and edit playlist.
|
|
104
|
-
# This endpoint expects always the full amount of information including all recordings.
|
|
105
|
-
# @param save_playlist_dto [SavePlaylistDTO]
|
|
106
|
-
# @param [Hash] opts the optional parameters
|
|
107
|
-
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
108
|
-
def create_or_update_playlist_with_http_info(save_playlist_dto, opts = {})
|
|
109
|
-
if @api_client.config.debugging
|
|
110
|
-
@api_client.config.logger.debug 'Calling API: PlaylistApi.create_or_update_playlist ...'
|
|
111
|
-
end
|
|
112
|
-
# verify the required parameter 'save_playlist_dto' is set
|
|
113
|
-
if @api_client.config.client_side_validation && save_playlist_dto.nil?
|
|
114
|
-
fail ArgumentError, "Missing the required parameter 'save_playlist_dto' when calling PlaylistApi.create_or_update_playlist"
|
|
115
|
-
end
|
|
116
|
-
# resource path
|
|
117
|
-
local_var_path = '/api/v1/playlist'
|
|
118
|
-
|
|
119
|
-
# query parameters
|
|
120
|
-
query_params = opts[:query_params] || {}
|
|
121
|
-
|
|
122
|
-
# header parameters
|
|
123
|
-
header_params = opts[:header_params] || {}
|
|
124
|
-
# HTTP header 'Accept' (if needed)
|
|
125
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
126
|
-
# HTTP header 'Content-Type'
|
|
127
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
128
|
-
if !content_type.nil?
|
|
129
|
-
header_params['Content-Type'] = content_type
|
|
130
|
-
end
|
|
131
|
-
|
|
132
|
-
# form parameters
|
|
133
|
-
form_params = opts[:form_params] || {}
|
|
134
|
-
|
|
135
|
-
# http body (model)
|
|
136
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(save_playlist_dto)
|
|
137
|
-
|
|
138
|
-
# return_type
|
|
139
|
-
return_type = opts[:debug_return_type] || 'Object'
|
|
140
|
-
|
|
141
|
-
# auth_names
|
|
142
|
-
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
143
|
-
|
|
144
|
-
new_options = opts.merge(
|
|
145
|
-
:operation => :"PlaylistApi.create_or_update_playlist",
|
|
146
|
-
:header_params => header_params,
|
|
147
|
-
:query_params => query_params,
|
|
148
|
-
:form_params => form_params,
|
|
149
|
-
:body => post_body,
|
|
150
|
-
:auth_names => auth_names,
|
|
151
|
-
:return_type => return_type
|
|
152
|
-
)
|
|
153
|
-
|
|
154
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
155
|
-
if @api_client.config.debugging
|
|
156
|
-
@api_client.config.logger.debug "API called: PlaylistApi#create_or_update_playlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
157
|
-
end
|
|
158
|
-
return data, status_code, headers
|
|
159
|
-
end
|
|
160
|
-
|
|
161
22
|
# Curate playlist.
|
|
162
23
|
# @param method_name [String] Name of the curation task that should be executed
|
|
163
24
|
# @param curate_playlist_dto [CuratePlaylistDTO]
|
|
@@ -234,66 +95,5 @@ module SongtradrApiClientRuby
|
|
|
234
95
|
end
|
|
235
96
|
return data, status_code, headers
|
|
236
97
|
end
|
|
237
|
-
|
|
238
|
-
# Delete playlist.
|
|
239
|
-
# @param songtradr_playlist_guid [String] ID of the file that should be deleted.
|
|
240
|
-
# @param [Hash] opts the optional parameters
|
|
241
|
-
# @return [Object]
|
|
242
|
-
def delete_playlist(songtradr_playlist_guid, opts = {})
|
|
243
|
-
data, _status_code, _headers = delete_playlist_with_http_info(songtradr_playlist_guid, opts)
|
|
244
|
-
data
|
|
245
|
-
end
|
|
246
|
-
|
|
247
|
-
# Delete playlist.
|
|
248
|
-
# @param songtradr_playlist_guid [String] ID of the file that should be deleted.
|
|
249
|
-
# @param [Hash] opts the optional parameters
|
|
250
|
-
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
251
|
-
def delete_playlist_with_http_info(songtradr_playlist_guid, opts = {})
|
|
252
|
-
if @api_client.config.debugging
|
|
253
|
-
@api_client.config.logger.debug 'Calling API: PlaylistApi.delete_playlist ...'
|
|
254
|
-
end
|
|
255
|
-
# verify the required parameter 'songtradr_playlist_guid' is set
|
|
256
|
-
if @api_client.config.client_side_validation && songtradr_playlist_guid.nil?
|
|
257
|
-
fail ArgumentError, "Missing the required parameter 'songtradr_playlist_guid' when calling PlaylistApi.delete_playlist"
|
|
258
|
-
end
|
|
259
|
-
# resource path
|
|
260
|
-
local_var_path = '/api/v1/playlist/{songtradrPlaylistGuid}'.sub('{' + 'songtradrPlaylistGuid' + '}', CGI.escape(songtradr_playlist_guid.to_s))
|
|
261
|
-
|
|
262
|
-
# query parameters
|
|
263
|
-
query_params = opts[:query_params] || {}
|
|
264
|
-
|
|
265
|
-
# header parameters
|
|
266
|
-
header_params = opts[:header_params] || {}
|
|
267
|
-
# HTTP header 'Accept' (if needed)
|
|
268
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/json'])
|
|
269
|
-
|
|
270
|
-
# form parameters
|
|
271
|
-
form_params = opts[:form_params] || {}
|
|
272
|
-
|
|
273
|
-
# http body (model)
|
|
274
|
-
post_body = opts[:debug_body]
|
|
275
|
-
|
|
276
|
-
# return_type
|
|
277
|
-
return_type = opts[:debug_return_type] || 'Object'
|
|
278
|
-
|
|
279
|
-
# auth_names
|
|
280
|
-
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
281
|
-
|
|
282
|
-
new_options = opts.merge(
|
|
283
|
-
:operation => :"PlaylistApi.delete_playlist",
|
|
284
|
-
:header_params => header_params,
|
|
285
|
-
:query_params => query_params,
|
|
286
|
-
:form_params => form_params,
|
|
287
|
-
:body => post_body,
|
|
288
|
-
:auth_names => auth_names,
|
|
289
|
-
:return_type => return_type
|
|
290
|
-
)
|
|
291
|
-
|
|
292
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
293
|
-
if @api_client.config.debugging
|
|
294
|
-
@api_client.config.logger.debug "API called: PlaylistApi#delete_playlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
295
|
-
end
|
|
296
|
-
return data, status_code, headers
|
|
297
|
-
end
|
|
298
98
|
end
|
|
299
99
|
end
|
|
@@ -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.
|
|
6
|
+
The version of the OpenAPI document: 1.15.0
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -301,67 +301,6 @@ module SongtradrApiClientRuby
|
|
|
301
301
|
return data, status_code, headers
|
|
302
302
|
end
|
|
303
303
|
|
|
304
|
-
# Recordings by IDs with a large response.
|
|
305
|
-
# @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
306
|
-
# @param [Hash] opts the optional parameters
|
|
307
|
-
# @return [Array<RecordingLargeDTO>]
|
|
308
|
-
def recordings_large_by_ids(ids, opts = {})
|
|
309
|
-
data, _status_code, _headers = recordings_large_by_ids_with_http_info(ids, opts)
|
|
310
|
-
data
|
|
311
|
-
end
|
|
312
|
-
|
|
313
|
-
# Recordings by IDs with a large response.
|
|
314
|
-
# @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
315
|
-
# @param [Hash] opts the optional parameters
|
|
316
|
-
# @return [Array<(Array<RecordingLargeDTO>, Integer, Hash)>] Array<RecordingLargeDTO> data, response status code and response headers
|
|
317
|
-
def recordings_large_by_ids_with_http_info(ids, opts = {})
|
|
318
|
-
if @api_client.config.debugging
|
|
319
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.recordings_large_by_ids ...'
|
|
320
|
-
end
|
|
321
|
-
# verify the required parameter 'ids' is set
|
|
322
|
-
if @api_client.config.client_side_validation && ids.nil?
|
|
323
|
-
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_large_by_ids"
|
|
324
|
-
end
|
|
325
|
-
# resource path
|
|
326
|
-
local_var_path = '/api/v1/public/recording/l/{ids}'.sub('{' + 'ids' + '}', CGI.escape(ids.to_s))
|
|
327
|
-
|
|
328
|
-
# query parameters
|
|
329
|
-
query_params = opts[:query_params] || {}
|
|
330
|
-
|
|
331
|
-
# header parameters
|
|
332
|
-
header_params = opts[:header_params] || {}
|
|
333
|
-
# HTTP header 'Accept' (if needed)
|
|
334
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
335
|
-
|
|
336
|
-
# form parameters
|
|
337
|
-
form_params = opts[:form_params] || {}
|
|
338
|
-
|
|
339
|
-
# http body (model)
|
|
340
|
-
post_body = opts[:debug_body]
|
|
341
|
-
|
|
342
|
-
# return_type
|
|
343
|
-
return_type = opts[:debug_return_type] || 'Array<RecordingLargeDTO>'
|
|
344
|
-
|
|
345
|
-
# auth_names
|
|
346
|
-
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
347
|
-
|
|
348
|
-
new_options = opts.merge(
|
|
349
|
-
:operation => :"RecordingApi.recordings_large_by_ids",
|
|
350
|
-
:header_params => header_params,
|
|
351
|
-
:query_params => query_params,
|
|
352
|
-
:form_params => form_params,
|
|
353
|
-
:body => post_body,
|
|
354
|
-
:auth_names => auth_names,
|
|
355
|
-
:return_type => return_type
|
|
356
|
-
)
|
|
357
|
-
|
|
358
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
359
|
-
if @api_client.config.debugging
|
|
360
|
-
@api_client.config.logger.debug "API called: RecordingApi#recordings_large_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
361
|
-
end
|
|
362
|
-
return data, status_code, headers
|
|
363
|
-
end
|
|
364
|
-
|
|
365
304
|
# Recordings by IDs with a medium sized response.
|
|
366
305
|
# @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
367
306
|
# @param [Hash] opts the optional parameters
|
|
@@ -432,67 +371,6 @@ module SongtradrApiClientRuby
|
|
|
432
371
|
return data, status_code, headers
|
|
433
372
|
end
|
|
434
373
|
|
|
435
|
-
# Recordings by IDs with a small response.
|
|
436
|
-
# @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
437
|
-
# @param [Hash] opts the optional parameters
|
|
438
|
-
# @return [Array<RecordingSmallDTO>]
|
|
439
|
-
def recordings_small_by_ids(ids, opts = {})
|
|
440
|
-
data, _status_code, _headers = recordings_small_by_ids_with_http_info(ids, opts)
|
|
441
|
-
data
|
|
442
|
-
end
|
|
443
|
-
|
|
444
|
-
# Recordings by IDs with a small response.
|
|
445
|
-
# @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
446
|
-
# @param [Hash] opts the optional parameters
|
|
447
|
-
# @return [Array<(Array<RecordingSmallDTO>, Integer, Hash)>] Array<RecordingSmallDTO> data, response status code and response headers
|
|
448
|
-
def recordings_small_by_ids_with_http_info(ids, opts = {})
|
|
449
|
-
if @api_client.config.debugging
|
|
450
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.recordings_small_by_ids ...'
|
|
451
|
-
end
|
|
452
|
-
# verify the required parameter 'ids' is set
|
|
453
|
-
if @api_client.config.client_side_validation && ids.nil?
|
|
454
|
-
fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_small_by_ids"
|
|
455
|
-
end
|
|
456
|
-
# resource path
|
|
457
|
-
local_var_path = '/api/v1/public/recording/s/{ids}'.sub('{' + 'ids' + '}', CGI.escape(ids.to_s))
|
|
458
|
-
|
|
459
|
-
# query parameters
|
|
460
|
-
query_params = opts[:query_params] || {}
|
|
461
|
-
|
|
462
|
-
# header parameters
|
|
463
|
-
header_params = opts[:header_params] || {}
|
|
464
|
-
# HTTP header 'Accept' (if needed)
|
|
465
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
466
|
-
|
|
467
|
-
# form parameters
|
|
468
|
-
form_params = opts[:form_params] || {}
|
|
469
|
-
|
|
470
|
-
# http body (model)
|
|
471
|
-
post_body = opts[:debug_body]
|
|
472
|
-
|
|
473
|
-
# return_type
|
|
474
|
-
return_type = opts[:debug_return_type] || 'Array<RecordingSmallDTO>'
|
|
475
|
-
|
|
476
|
-
# auth_names
|
|
477
|
-
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
478
|
-
|
|
479
|
-
new_options = opts.merge(
|
|
480
|
-
:operation => :"RecordingApi.recordings_small_by_ids",
|
|
481
|
-
:header_params => header_params,
|
|
482
|
-
:query_params => query_params,
|
|
483
|
-
:form_params => form_params,
|
|
484
|
-
:body => post_body,
|
|
485
|
-
:auth_names => auth_names,
|
|
486
|
-
:return_type => return_type
|
|
487
|
-
)
|
|
488
|
-
|
|
489
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
490
|
-
if @api_client.config.debugging
|
|
491
|
-
@api_client.config.logger.debug "API called: RecordingApi#recordings_small_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
492
|
-
end
|
|
493
|
-
return data, status_code, headers
|
|
494
|
-
end
|
|
495
|
-
|
|
496
374
|
# Recordings by contributors, moods, musical features and more.
|
|
497
375
|
# @param [Hash] opts the optional parameters
|
|
498
376
|
# @option opts [String] :similar_to_recording Search for songs similar to a recording.
|
|
@@ -845,71 +723,5 @@ module SongtradrApiClientRuby
|
|
|
845
723
|
end
|
|
846
724
|
return data, status_code, headers
|
|
847
725
|
end
|
|
848
|
-
|
|
849
|
-
# Recordings by abstracted wordings and granular search options.
|
|
850
|
-
# @param search_recording_granular_abstraction_dto [Array<SearchRecordingGranularAbstractionDTO>]
|
|
851
|
-
# @param [Hash] opts the optional parameters
|
|
852
|
-
# @return [RecordingListDTO]
|
|
853
|
-
def search_recordings_granular_abstraction(search_recording_granular_abstraction_dto, opts = {})
|
|
854
|
-
data, _status_code, _headers = search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto, opts)
|
|
855
|
-
data
|
|
856
|
-
end
|
|
857
|
-
|
|
858
|
-
# Recordings by abstracted wordings and granular search options.
|
|
859
|
-
# @param search_recording_granular_abstraction_dto [Array<SearchRecordingGranularAbstractionDTO>]
|
|
860
|
-
# @param [Hash] opts the optional parameters
|
|
861
|
-
# @return [Array<(RecordingListDTO, Integer, Hash)>] RecordingListDTO data, response status code and response headers
|
|
862
|
-
def search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto, opts = {})
|
|
863
|
-
if @api_client.config.debugging
|
|
864
|
-
@api_client.config.logger.debug 'Calling API: RecordingApi.search_recordings_granular_abstraction ...'
|
|
865
|
-
end
|
|
866
|
-
# verify the required parameter 'search_recording_granular_abstraction_dto' is set
|
|
867
|
-
if @api_client.config.client_side_validation && search_recording_granular_abstraction_dto.nil?
|
|
868
|
-
fail ArgumentError, "Missing the required parameter 'search_recording_granular_abstraction_dto' when calling RecordingApi.search_recordings_granular_abstraction"
|
|
869
|
-
end
|
|
870
|
-
# resource path
|
|
871
|
-
local_var_path = '/api/v1/public/recording/searchGranularAbstraction'
|
|
872
|
-
|
|
873
|
-
# query parameters
|
|
874
|
-
query_params = opts[:query_params] || {}
|
|
875
|
-
|
|
876
|
-
# header parameters
|
|
877
|
-
header_params = opts[:header_params] || {}
|
|
878
|
-
# HTTP header 'Accept' (if needed)
|
|
879
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
880
|
-
# HTTP header 'Content-Type'
|
|
881
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
882
|
-
if !content_type.nil?
|
|
883
|
-
header_params['Content-Type'] = content_type
|
|
884
|
-
end
|
|
885
|
-
|
|
886
|
-
# form parameters
|
|
887
|
-
form_params = opts[:form_params] || {}
|
|
888
|
-
|
|
889
|
-
# http body (model)
|
|
890
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_recording_granular_abstraction_dto)
|
|
891
|
-
|
|
892
|
-
# return_type
|
|
893
|
-
return_type = opts[:debug_return_type] || 'RecordingListDTO'
|
|
894
|
-
|
|
895
|
-
# auth_names
|
|
896
|
-
auth_names = opts[:debug_auth_names] || ['bearer-jwt']
|
|
897
|
-
|
|
898
|
-
new_options = opts.merge(
|
|
899
|
-
:operation => :"RecordingApi.search_recordings_granular_abstraction",
|
|
900
|
-
:header_params => header_params,
|
|
901
|
-
:query_params => query_params,
|
|
902
|
-
:form_params => form_params,
|
|
903
|
-
:body => post_body,
|
|
904
|
-
:auth_names => auth_names,
|
|
905
|
-
:return_type => return_type
|
|
906
|
-
)
|
|
907
|
-
|
|
908
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
909
|
-
if @api_client.config.debugging
|
|
910
|
-
@api_client.config.logger.debug "API called: RecordingApi#search_recordings_granular_abstraction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
911
|
-
end
|
|
912
|
-
return data, status_code, headers
|
|
913
|
-
end
|
|
914
726
|
end
|
|
915
727
|
end
|