songtradr_api_client_ruby 1.13.6 → 1.15.0

data/lib/songtradr_api_client_ruby/api/playlist_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-The version of the OpenAPI document: 1.13.6
+The version of the OpenAPI document: 1.15.0
 Contact: info@songtradr.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.1.0-SNAPSHOT
@@ -19,145 +19,6 @@ module SongtradrApiClientRuby
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # All playlists.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :include_recordings Whether a playlist shall include recordings or not. (default to false)
-    # @option opts [Boolean] :ignore_usages Whether a playlist shall include all songs regardless of their track usages. (default to false)
-    # @option opts [String] :usage_filter_mode Whether a playlist recordings shall include all playlist usages or not. (default to 'any')
-    # @option opts [String] :songtradr_playlist_guid 
-    # @return [Array<PlaylistLargeDTO>]
-    def all_playlists(opts = {})
-      data, _status_code, _headers = all_playlists_with_http_info(opts)
-      data
-    end
-
-    # All playlists.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :include_recordings Whether a playlist shall include recordings or not. (default to false)
-    # @option opts [Boolean] :ignore_usages Whether a playlist shall include all songs regardless of their track usages. (default to false)
-    # @option opts [String] :usage_filter_mode Whether a playlist recordings shall include all playlist usages or not. (default to 'any')
-    # @option opts [String] :songtradr_playlist_guid 
-    # @return [Array<(Array<PlaylistLargeDTO>, Integer, Hash)>] Array<PlaylistLargeDTO> data, response status code and response headers
-    def all_playlists_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PlaylistApi.all_playlists ...'
-      end
-      allowable_values = ["any", "all"]
-      if @api_client.config.client_side_validation && opts[:'usage_filter_mode'] && !allowable_values.include?(opts[:'usage_filter_mode'])
-        fail ArgumentError, "invalid value for \"usage_filter_mode\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/api/v1/playlist'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'includeRecordings'] = opts[:'include_recordings'] if !opts[:'include_recordings'].nil?
-      query_params[:'ignoreUsages'] = opts[:'ignore_usages'] if !opts[:'ignore_usages'].nil?
-      query_params[:'usageFilterMode'] = opts[:'usage_filter_mode'] if !opts[:'usage_filter_mode'].nil?
-      query_params[:'songtradrPlaylistGuid'] = opts[:'songtradr_playlist_guid'] if !opts[:'songtradr_playlist_guid'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Array<PlaylistLargeDTO>'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"PlaylistApi.all_playlists",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PlaylistApi#all_playlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Create and edit playlist.
-    # This endpoint expects always the full amount of information including all recordings.
-    # @param save_playlist_dto [SavePlaylistDTO] 
-    # @param [Hash] opts the optional parameters
-    # @return [Object]
-    def create_or_update_playlist(save_playlist_dto, opts = {})
-      data, _status_code, _headers = create_or_update_playlist_with_http_info(save_playlist_dto, opts)
-      data
-    end
-
-    # Create and edit playlist.
-    # This endpoint expects always the full amount of information including all recordings.
-    # @param save_playlist_dto [SavePlaylistDTO] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
-    def create_or_update_playlist_with_http_info(save_playlist_dto, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PlaylistApi.create_or_update_playlist ...'
-      end
-      # verify the required parameter 'save_playlist_dto' is set
-      if @api_client.config.client_side_validation && save_playlist_dto.nil?
-        fail ArgumentError, "Missing the required parameter 'save_playlist_dto' when calling PlaylistApi.create_or_update_playlist"
-      end
-      # resource path
-      local_var_path = '/api/v1/playlist'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(save_playlist_dto)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Object'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"PlaylistApi.create_or_update_playlist",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PlaylistApi#create_or_update_playlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Curate playlist.
     # @param method_name [String] Name of the curation task that should be executed
     # @param curate_playlist_dto [CuratePlaylistDTO] 
@@ -182,7 +43,7 @@ module SongtradrApiClientRuby
         fail ArgumentError, "Missing the required parameter 'method_name' when calling PlaylistApi.curate_playlist"
       end
       # verify enum value
-      allowable_values = ["RECOMMEND", "REPLACE_SIMILAR", "REPLACE_DIFFERENT", "ORDER"]
+      allowable_values = ["recommend", "replaceSimilar", "replaceDifferent", "order"]
       if @api_client.config.client_side_validation && !allowable_values.include?(method_name)
         fail ArgumentError, "invalid value for \"method_name\", must be one of #{allowable_values}"
       end
@@ -234,66 +95,5 @@ module SongtradrApiClientRuby
       end
       return data, status_code, headers
     end
-
-    # Delete playlist.
-    # @param songtradr_playlist_guid [String] ID of the file that should be deleted.
-    # @param [Hash] opts the optional parameters
-    # @return [Object]
-    def delete_playlist(songtradr_playlist_guid, opts = {})
-      data, _status_code, _headers = delete_playlist_with_http_info(songtradr_playlist_guid, opts)
-      data
-    end
-
-    # Delete playlist.
-    # @param songtradr_playlist_guid [String] ID of the file that should be deleted.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
-    def delete_playlist_with_http_info(songtradr_playlist_guid, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PlaylistApi.delete_playlist ...'
-      end
-      # verify the required parameter 'songtradr_playlist_guid' is set
-      if @api_client.config.client_side_validation && songtradr_playlist_guid.nil?
-        fail ArgumentError, "Missing the required parameter 'songtradr_playlist_guid' when calling PlaylistApi.delete_playlist"
-      end
-      # resource path
-      local_var_path = '/api/v1/playlist/{songtradrPlaylistGuid}'.sub('{' + 'songtradrPlaylistGuid' + '}', CGI.escape(songtradr_playlist_guid.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Object'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"PlaylistApi.delete_playlist",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PlaylistApi#delete_playlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/songtradr_api_client_ruby/api/recording_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-The version of the OpenAPI document: 1.13.6
+The version of the OpenAPI document: 1.15.0
 Contact: info@songtradr.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 7.1.0-SNAPSHOT
@@ -83,6 +83,8 @@ module SongtradrApiClientRuby
     # Similar recordings for a list of recordings.
     # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :identical_only Whether a result list shall include only identical recordings. (default to false)
+    # @option opts [String] :usage Filter by recording usage.
     # @return [Array<RecordingForSimilaritySearchDTO>]
     def recordings_by_ids_with_similarities(ids, opts = {})
       data, _status_code, _headers = recordings_by_ids_with_similarities_with_http_info(ids, opts)
@@ -92,6 +94,8 @@ module SongtradrApiClientRuby
     # Similar recordings for a list of recordings.
     # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :identical_only Whether a result list shall include only identical recordings. (default to false)
+    # @option opts [String] :usage Filter by recording usage.
     # @return [Array<(Array<RecordingForSimilaritySearchDTO>, Integer, Hash)>] Array<RecordingForSimilaritySearchDTO> data, response status code and response headers
     def recordings_by_ids_with_similarities_with_http_info(ids, opts = {})
       if @api_client.config.debugging
@@ -106,6 +110,8 @@ module SongtradrApiClientRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'identicalOnly'] = opts[:'identical_only'] if !opts[:'identical_only'].nil?
+      query_params[:'usage'] = opts[:'usage'] if !opts[:'usage'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -295,67 +301,6 @@ module SongtradrApiClientRuby
       return data, status_code, headers
     end
 
-    # Recordings by IDs with a large response.
-    # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
-    # @param [Hash] opts the optional parameters
-    # @return [Array<RecordingLargeDTO>]
-    def recordings_large_by_ids(ids, opts = {})
-      data, _status_code, _headers = recordings_large_by_ids_with_http_info(ids, opts)
-      data
-    end
-
-    # Recordings by IDs with a large response.
-    # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<RecordingLargeDTO>, Integer, Hash)>] Array<RecordingLargeDTO> data, response status code and response headers
-    def recordings_large_by_ids_with_http_info(ids, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RecordingApi.recordings_large_by_ids ...'
-      end
-      # verify the required parameter 'ids' is set
-      if @api_client.config.client_side_validation && ids.nil?
-        fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_large_by_ids"
-      end
-      # resource path
-      local_var_path = '/api/v1/public/recording/l/{ids}'.sub('{' + 'ids' + '}', CGI.escape(ids.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Array<RecordingLargeDTO>'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"RecordingApi.recordings_large_by_ids",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RecordingApi#recordings_large_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Recordings by IDs with a medium sized response.
     # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
     # @param [Hash] opts the optional parameters
@@ -426,67 +371,6 @@ module SongtradrApiClientRuby
       return data, status_code, headers
     end
 
-    # Recordings by IDs with a small response.
-    # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
-    # @param [Hash] opts the optional parameters
-    # @return [Array<RecordingSmallDTO>]
-    def recordings_small_by_ids(ids, opts = {})
-      data, _status_code, _headers = recordings_small_by_ids_with_http_info(ids, opts)
-      data
-    end
-
-    # Recordings by IDs with a small response.
-    # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<RecordingSmallDTO>, Integer, Hash)>] Array<RecordingSmallDTO> data, response status code and response headers
-    def recordings_small_by_ids_with_http_info(ids, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RecordingApi.recordings_small_by_ids ...'
-      end
-      # verify the required parameter 'ids' is set
-      if @api_client.config.client_side_validation && ids.nil?
-        fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_small_by_ids"
-      end
-      # resource path
-      local_var_path = '/api/v1/public/recording/s/{ids}'.sub('{' + 'ids' + '}', CGI.escape(ids.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Array<RecordingSmallDTO>'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"RecordingApi.recordings_small_by_ids",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RecordingApi#recordings_small_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Recordings by contributors, moods, musical features and more.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :similar_to_recording Search for songs similar to a recording.
@@ -839,71 +723,5 @@ module SongtradrApiClientRuby
       end
       return data, status_code, headers
     end
-
-    # Recordings by abstracted wordings and granular search options.
-    # @param search_recording_granular_abstraction_dto [Array<SearchRecordingGranularAbstractionDTO>] 
-    # @param [Hash] opts the optional parameters
-    # @return [RecordingListDTO]
-    def search_recordings_granular_abstraction(search_recording_granular_abstraction_dto, opts = {})
-      data, _status_code, _headers = search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto, opts)
-      data
-    end
-
-    # Recordings by abstracted wordings and granular search options.
-    # @param search_recording_granular_abstraction_dto [Array<SearchRecordingGranularAbstractionDTO>] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(RecordingListDTO, Integer, Hash)>] RecordingListDTO data, response status code and response headers
-    def search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RecordingApi.search_recordings_granular_abstraction ...'
-      end
-      # verify the required parameter 'search_recording_granular_abstraction_dto' is set
-      if @api_client.config.client_side_validation && search_recording_granular_abstraction_dto.nil?
-        fail ArgumentError, "Missing the required parameter 'search_recording_granular_abstraction_dto' when calling RecordingApi.search_recordings_granular_abstraction"
-      end
-      # resource path
-      local_var_path = '/api/v1/public/recording/searchGranularAbstraction'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_recording_granular_abstraction_dto)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'RecordingListDTO'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"RecordingApi.search_recordings_granular_abstraction",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RecordingApi#search_recordings_granular_abstraction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end