songtradr_api_client_ruby 1.17.0 → 2.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: songtradr_api_client_ruby
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 2.0.0
 platform: ruby
 authors:
 - songtradr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,8 +95,6 @@ files:
 - docs/ConfigAccessDTO.md
 - docs/ConfigIdentifierDTO.md
 - docs/ContributorTypeDTO.md
-- docs/CuratePlaylistDTO.md
-- docs/CuratePlaylistResponseDTO.md
 - docs/ErrorResponse.md
 - docs/FieldSummaryDTO.md
 - docs/FileDTO.md
@@ -101,7 +113,6 @@ files:
 - docs/LoginDTO.md
 - docs/MusicalFeaturesDTO.md
 - docs/PartySmallDTO.md
-- docs/PlaylistApi.md
 - docs/RecordingApi.md
 - docs/RecordingForSimilaritySearchDTO.md
 - docs/RecordingGenrePredictionDTO.md
@@ -115,7 +126,6 @@ files:
 - docs/RecordingTagSmallDTO.md
 - docs/SaveUserDTO.md
 - docs/SearchFilterValuesDTO.md
-- docs/SearchRecordingGranularDTO.md
 - docs/SignUpDTO.md
 - docs/TagDTO.md
 - docs/TagSmallDTO.md
@@ -133,7 +143,6 @@ files:
 - git_push.sh
 - lib/songtradr_api_client_ruby.rb
 - lib/songtradr_api_client_ruby/api/allowed_values_api.rb
-- lib/songtradr_api_client_ruby/api/playlist_api.rb
 - lib/songtradr_api_client_ruby/api/recording_api.rb
 - lib/songtradr_api_client_ruby/api/user_api.rb
 - lib/songtradr_api_client_ruby/api_client.rb
@@ -144,8 +153,6 @@ files:
 - lib/songtradr_api_client_ruby/models/config_access_dto.rb
 - lib/songtradr_api_client_ruby/models/config_identifier_dto.rb
 - lib/songtradr_api_client_ruby/models/contributor_type_dto.rb
-- lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb
-- lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb
 - lib/songtradr_api_client_ruby/models/error_response.rb
 - lib/songtradr_api_client_ruby/models/field_summary_dto.rb
 - lib/songtradr_api_client_ruby/models/file_dto.rb
@@ -176,7 +183,6 @@ files:
 - lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb
 - lib/songtradr_api_client_ruby/models/save_user_dto.rb
 - lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb
-- lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb
 - lib/songtradr_api_client_ruby/models/sign_up_dto.rb
 - lib/songtradr_api_client_ruby/models/tag_dto.rb
 - lib/songtradr_api_client_ruby/models/tag_small_dto.rb
@@ -193,7 +199,6 @@ files:
 - openapi-generator-config.yaml
 - songtradr_api_client_ruby.gemspec
 - spec/api/allowed_values_api_spec.rb
-- spec/api/playlist_api_spec.rb
 - spec/api/recording_api_spec.rb
 - spec/api/user_api_spec.rb
 - spec/models/category_medium_dto_spec.rb
@@ -201,8 +206,6 @@ files:
 - spec/models/config_access_dto_spec.rb
 - spec/models/config_identifier_dto_spec.rb
 - spec/models/contributor_type_dto_spec.rb
-- spec/models/curate_playlist_dto_spec.rb
-- spec/models/curate_playlist_response_dto_spec.rb
 - spec/models/error_response_spec.rb
 - spec/models/field_summary_dto_spec.rb
 - spec/models/file_dto_spec.rb
@@ -233,7 +236,6 @@ files:
 - spec/models/recording_tag_small_dto_spec.rb
 - spec/models/save_user_dto_spec.rb
 - spec/models/search_filter_values_dto_spec.rb
-- spec/models/search_recording_granular_dto_spec.rb
 - spec/models/sign_up_dto_spec.rb
 - spec/models/tag_dto_spec.rb
 - spec/models/tag_small_dto_spec.rb
@@ -271,58 +273,54 @@ signing_key:
 specification_version: 4
 summary: Client for Songtradr API, generated with openapi-generator
 test_files:
-- spec/api/allowed_values_api_spec.rb
-- spec/api/user_api_spec.rb
-- spec/api/playlist_api_spec.rb
 - spec/api/recording_api_spec.rb
-- spec/models/recording_genre_prediction_dto_spec.rb
-- spec/models/update_password_dto_spec.rb
-- spec/models/recording_minimal_with_musical_features_dto_spec.rb
-- spec/models/user_dto_spec.rb
-- spec/models/recording_minimal_with_taggrams_dto_spec.rb
+- spec/api/user_api_spec.rb
+- spec/api/allowed_values_api_spec.rb
+- spec/models/genre_dto_spec.rb
+- spec/models/file_dto_spec.rb
+- spec/models/file_upload_dto_spec.rb
+- spec/models/forgot_password_dto_spec.rb
+- spec/models/search_filter_values_dto_spec.rb
 - spec/models/save_user_dto_spec.rb
-- spec/models/genre_minimal_dto_spec.rb
-- spec/models/search_recording_granular_dto_spec.rb
-- spec/models/file_small_dto_spec.rb
-- spec/models/jwt_token_dto_spec.rb
-- spec/models/recording_party_dto_spec.rb
-- spec/models/recording_medium_dto_spec.rb
-- spec/models/video_recognition_response_spec.rb
-- spec/models/curate_playlist_response_dto_spec.rb
+- spec/models/image_recognition_response_spec.rb
+- spec/models/field_summary_dto_spec.rb
+- spec/models/recording_minimal_with_musical_features_dto_spec.rb
+- spec/models/token_request_spec.rb
+- spec/models/recording_for_similarity_search_dto_spec.rb
+- spec/models/recording_list_dto_spec.rb
 - spec/models/musical_features_dto_spec.rb
-- spec/models/recording_small_dto_spec.rb
-- spec/models/category_medium_dto_spec.rb
+- spec/models/config_access_dto_spec.rb
 - spec/models/file_list_dto_spec.rb
-- spec/models/file_dto_spec.rb
-- spec/models/files_summary_dto_spec.rb
-- spec/models/config_identifier_dto_spec.rb
+- spec/models/tag_dto_spec.rb
 - spec/models/error_response_spec.rb
-- spec/models/genres_summary_dto_spec.rb
+- spec/models/files_summary_dto_spec.rb
 - spec/models/tags_summary_dto_spec.rb
+- spec/models/genre_minimal_dto_spec.rb
+- spec/models/category_medium_dto_spec.rb
+- spec/models/contributor_type_dto_spec.rb
+- spec/models/party_small_dto_spec.rb
+- spec/models/category_minimal_dto_spec.rb
+- spec/models/file_small_dto_spec.rb
+- spec/models/genres_summary_dto_spec.rb
+- spec/models/sign_up_dto_spec.rb
 - spec/models/taggram_dto_spec.rb
+- spec/models/recording_genre_prediction_dto_spec.rb
+- spec/models/tag_small_dto_spec.rb
+- spec/models/recording_tag_small_dto_spec.rb
+- spec/models/recording_minimal_with_tagstrengths_dto_spec.rb
+- spec/models/recording_small_dto_spec.rb
+- spec/models/track_dto_spec.rb
+- spec/models/recording_medium_dto_spec.rb
+- spec/models/login_dto_spec.rb
+- spec/models/update_password_dto_spec.rb
 - spec/models/init_put_recording_audio_dto_spec.rb
-- spec/models/token_request_spec.rb
-- spec/models/image_recognition_response_spec.rb
+- spec/models/user_dto_spec.rb
 - spec/models/tagstrength_dto_spec.rb
-- spec/models/sign_up_dto_spec.rb
-- spec/models/config_access_dto_spec.rb
-- spec/models/party_small_dto_spec.rb
-- spec/models/login_dto_spec.rb
-- spec/models/contributor_type_dto_spec.rb
-- spec/models/curate_playlist_dto_spec.rb
-- spec/models/recording_for_similarity_search_dto_spec.rb
-- spec/models/file_upload_dto_spec.rb
-- spec/models/recording_list_dto_spec.rb
-- spec/models/tag_dto_spec.rb
-- spec/models/recording_minimal_with_tagstrengths_dto_spec.rb
 - spec/models/file_w_ith_url_dto_spec.rb
-- spec/models/forgot_password_dto_spec.rb
-- spec/models/genre_dto_spec.rb
-- spec/models/recording_tag_small_dto_spec.rb
 - spec/models/title_dto_spec.rb
-- spec/models/field_summary_dto_spec.rb
-- spec/models/tag_small_dto_spec.rb
-- spec/models/category_minimal_dto_spec.rb
-- spec/models/search_filter_values_dto_spec.rb
-- spec/models/track_dto_spec.rb
+- spec/models/recording_party_dto_spec.rb
+- spec/models/jwt_token_dto_spec.rb
+- spec/models/config_identifier_dto_spec.rb
+- spec/models/video_recognition_response_spec.rb
+- spec/models/recording_minimal_with_taggrams_dto_spec.rb
 - spec/spec_helper.rb

data/docs/CuratePlaylistDTO.md

@@ -1,26 +0,0 @@
-# SongtradrApiClientRuby::CuratePlaylistDTO
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **request_data** | **Array<String>** |  | [optional] |
-| **usage_filter** | **String** |  | [optional] |
-| **numerical_filter** | **Hash<String, String>** |  | [optional] |
-| **category_filter** | **Hash<String, String>** |  | [optional] |
-| **first_id** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::CuratePlaylistDTO.new(
-  request_data: null,
-  usage_filter: null,
-  numerical_filter: null,
-  category_filter: null,
-  first_id: null
-)
-```
-

data/docs/CuratePlaylistResponseDTO.md

@@ -1,18 +0,0 @@
-# SongtradrApiClientRuby::CuratePlaylistResponseDTO
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **songtradr_track_ids** | **Array<String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::CuratePlaylistResponseDTO.new(
-  songtradr_track_ids: null
-)
-```
-

data/docs/PlaylistApi.md

@@ -1,77 +0,0 @@
-# SongtradrApiClientRuby::PlaylistApi
-
-All URIs are relative to *https://api.songtradr.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**curate_playlist**](PlaylistApi.md#curate_playlist) | **POST** /api/v1/playlist/{methodName} | Curate playlist. |
-
-
-## curate_playlist
-
-> <CuratePlaylistResponseDTO> curate_playlist(method_name, curate_playlist_dto)
-
-Curate playlist.
-
-### Examples
-
-```ruby
-require 'time'
-require 'songtradr_api_client_ruby'
-# setup authorization
-SongtradrApiClientRuby.configure do |config|
-  # Configure Bearer authorization (JWT): bearer-jwt
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = SongtradrApiClientRuby::PlaylistApi.new
-method_name = 'recommend' # String | Name of the curation task that should be executed
-curate_playlist_dto = SongtradrApiClientRuby::CuratePlaylistDTO.new # CuratePlaylistDTO | 
-
-begin
-  # Curate playlist.
-  result = api_instance.curate_playlist(method_name, curate_playlist_dto)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling PlaylistApi->curate_playlist: #{e}"
-end
-```
-
-#### Using the curate_playlist_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<CuratePlaylistResponseDTO>, Integer, Hash)> curate_playlist_with_http_info(method_name, curate_playlist_dto)
-
-```ruby
-begin
-  # Curate playlist.
-  data, status_code, headers = api_instance.curate_playlist_with_http_info(method_name, curate_playlist_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <CuratePlaylistResponseDTO>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling PlaylistApi->curate_playlist_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **method_name** | **String** | Name of the curation task that should be executed |  |
-| **curate_playlist_dto** | [**CuratePlaylistDTO**](CuratePlaylistDTO.md) |  |  |
-
-### Return type
-
-[**CuratePlaylistResponseDTO**](CuratePlaylistResponseDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/SearchRecordingGranularDTO.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::SearchRecordingGranularDTO
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **strength** | **Float** | Strength of presence of the corresponding category, tag or genre. | [optional] |
-| **tag_name** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::SearchRecordingGranularDTO.new(
-  strength: null,
-  tag_name: null
-)
-```
-

data/lib/songtradr_api_client_ruby/api/playlist_api.rb

@@ -1,99 +0,0 @@
-=begin
-#Songtradr API
-
-#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.17.0
-Contact: info@songtradr.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0-SNAPSHOT
-
-=end
-
-require 'cgi'
-
-module SongtradrApiClientRuby
-  class PlaylistApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Curate playlist.
-    # @param method_name [String] Name of the curation task that should be executed
-    # @param curate_playlist_dto [CuratePlaylistDTO] 
-    # @param [Hash] opts the optional parameters
-    # @return [CuratePlaylistResponseDTO]
-    def curate_playlist(method_name, curate_playlist_dto, opts = {})
-      data, _status_code, _headers = curate_playlist_with_http_info(method_name, curate_playlist_dto, opts)
-      data
-    end
-
-    # Curate playlist.
-    # @param method_name [String] Name of the curation task that should be executed
-    # @param curate_playlist_dto [CuratePlaylistDTO] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(CuratePlaylistResponseDTO, Integer, Hash)>] CuratePlaylistResponseDTO data, response status code and response headers
-    def curate_playlist_with_http_info(method_name, curate_playlist_dto, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PlaylistApi.curate_playlist ...'
-      end
-      # verify the required parameter 'method_name' is set
-      if @api_client.config.client_side_validation && method_name.nil?
-        fail ArgumentError, "Missing the required parameter 'method_name' when calling PlaylistApi.curate_playlist"
-      end
-      # verify enum value
-      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
-      # verify the required parameter 'curate_playlist_dto' is set
-      if @api_client.config.client_side_validation && curate_playlist_dto.nil?
-        fail ArgumentError, "Missing the required parameter 'curate_playlist_dto' when calling PlaylistApi.curate_playlist"
-      end
-      # resource path
-      local_var_path = '/api/v1/playlist/{methodName}'.sub('{' + 'methodName' + '}', CGI.escape(method_name.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'])
-      # 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(curate_playlist_dto)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'CuratePlaylistResponseDTO'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"PlaylistApi.curate_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#curate_playlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end