songtradr_api_client_ruby 1.17.0 → 2.0.0

data/lib/songtradr_api_client_ruby/api/recording_api.rb

@@ -3,10 +3,10 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 Contact: info@songtradr.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0-SNAPSHOT
+OpenAPI Generator version: 7.4.0-SNAPSHOT
 
 =end
 
@@ -19,6 +19,68 @@ module SongtradrApiClientRuby
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Recordings for query.
+    # @param query [String] Query.
+    # @param [Hash] opts the optional parameters
+    # @return [RecordingListDTO]
+    def prompt_search_recordings(query, opts = {})
+      data, _status_code, _headers = prompt_search_recordings_with_http_info(query, opts)
+      data
+    end
+
+    # Recordings for query.
+    # @param query [String] Query.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RecordingListDTO, Integer, Hash)>] RecordingListDTO data, response status code and response headers
+    def prompt_search_recordings_with_http_info(query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecordingApi.prompt_search_recordings ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling RecordingApi.prompt_search_recordings"
+      end
+      # resource path
+      local_var_path = '/api/v1/public/recording/promptSearch'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'query'] = query
+
+      # 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] || 'RecordingListDTO'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
+
+      new_options = opts.merge(
+        :operation => :"RecordingApi.prompt_search_recordings",
+        :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#prompt_search_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # AI generated moods, musical features and more for recordings.
     # @param ids [String] Comma seperated list of IDs. Can be ISRCs or proprietary IDs
     # @param [Hash] opts the optional parameters
@@ -180,7 +242,7 @@ module SongtradrApiClientRuby
       if @api_client.config.client_side_validation && ids.nil?
         fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_by_ids_with_taggrams"
       end
-      allowable_values = ["instrument", "vocals", "energy", "soundGeneration", "rhythm", "songRating", "performanceRating", "productionRating", "moodCluster", "tonality", "arousal", "valence", "pleasantness", "engagement", "timbre", "roughness", "harmony", "texture", "groovyness", "space", "audienceAge", "audienceRegion", "audienceGender", "originRegion", "originDecade", "languageOfPerformance", "level1Genre", "level2Genre"]
+      allowable_values = ["instrument", "vocals", "energy", "soundGeneration", "rhythm", "songRating", "performanceRating", "productionRating", "moodCluster", "tonality", "arousal", "valence", "pleasantness", "engagement", "timbre", "roughness", "harmony", "texture", "groovyness", "space", "audienceAge", "audienceRegion", "audienceGender", "originRegion", "originDecade", "languageOfPerformance", "level1Genre", "level2Genre", "curateability", "useCase", "channelSuitability", "industrySuitability", "loudness"]
       if @api_client.config.client_side_validation && opts[:'category_name'] && !allowable_values.include?(opts[:'category_name'])
         fail ArgumentError, "invalid value for \"category_name\", must be one of #{allowable_values}"
       end
@@ -257,7 +319,7 @@ module SongtradrApiClientRuby
       if @api_client.config.client_side_validation && ids.nil?
         fail ArgumentError, "Missing the required parameter 'ids' when calling RecordingApi.recordings_by_ids_with_tagstrengths"
       end
-      allowable_values = ["instrument", "vocals", "energy", "soundGeneration", "rhythm", "songRating", "performanceRating", "productionRating", "moodCluster", "tonality", "arousal", "valence", "pleasantness", "engagement", "timbre", "roughness", "harmony", "texture", "groovyness", "space", "audienceAge", "audienceRegion", "audienceGender", "originRegion", "originDecade", "languageOfPerformance", "level1Genre", "level2Genre"]
+      allowable_values = ["instrument", "vocals", "energy", "soundGeneration", "rhythm", "songRating", "performanceRating", "productionRating", "moodCluster", "tonality", "arousal", "valence", "pleasantness", "engagement", "timbre", "roughness", "harmony", "texture", "groovyness", "space", "audienceAge", "audienceRegion", "audienceGender", "originRegion", "originDecade", "languageOfPerformance", "level1Genre", "level2Genre", "curateability", "useCase", "channelSuitability", "industrySuitability", "loudness"]
       if @api_client.config.client_side_validation && opts[:'category_name'] && !allowable_values.include?(opts[:'category_name'])
         fail ArgumentError, "invalid value for \"category_name\", must be one of #{allowable_values}"
       end
@@ -405,6 +467,7 @@ module SongtradrApiClientRuby
     # @option opts [String] :texture Search for texture.
     # @option opts [String] :groovyness Search for groovyness.
     # @option opts [String] :space Search for space.
+    # @option opts [String] :loudness Search for loudness.
     # @option opts [String] :origin_decade Search for origin decade.
     # @option opts [String] :curateability Search for curateability.
     # @option opts [String] :use_case Search for use case.
@@ -453,6 +516,7 @@ module SongtradrApiClientRuby
     # @option opts [String] :texture Search for texture.
     # @option opts [String] :groovyness Search for groovyness.
     # @option opts [String] :space Search for space.
+    # @option opts [String] :loudness Search for loudness.
     # @option opts [String] :origin_decade Search for origin decade.
     # @option opts [String] :curateability Search for curateability.
     # @option opts [String] :use_case Search for use case.
@@ -497,7 +561,7 @@ module SongtradrApiClientRuby
       if @api_client.config.client_side_validation && opts[:'vocals'] && !allowable_values.include?(opts[:'vocals'])
         fail ArgumentError, "invalid value for \"vocals\", must be one of #{allowable_values}"
       end
-      allowable_values = ["electric guitar", "piano", "electronics", "guitar", "strings", "synthesizer", "wind", "saxophone", "flute", "trumpet", "drum kit", "keys", "accordion", "violin", "harpsichord", "choir", "cello", "electric bass", "organ", "brass", "percussion", "vocals", "double bass", "harp"]
+      allowable_values = ["piano", "electronics", "guitar", "strings", "synthesizer", "wind", "drum kit", "keys", "harpsichord", "choir", "electric bass", "organ", "brass", "percussion", "vocals", "double bass", "harp"]
       if @api_client.config.client_side_validation && opts[:'dominant_instrument'] && !allowable_values.include?(opts[:'dominant_instrument'])
         fail ArgumentError, "invalid value for \"dominant_instrument\", must be one of #{allowable_values}"
       end
@@ -557,6 +621,10 @@ module SongtradrApiClientRuby
       if @api_client.config.client_side_validation && opts[:'space'] && !allowable_values.include?(opts[:'space'])
         fail ArgumentError, "invalid value for \"space\", must be one of #{allowable_values}"
       end
+      allowable_values = ["very low", "low", "moderate", "high", "very high"]
+      if @api_client.config.client_side_validation && opts[:'loudness'] && !allowable_values.include?(opts[:'loudness'])
+        fail ArgumentError, "invalid value for \"loudness\", must be one of #{allowable_values}"
+      end
       allowable_values = ["pre-1950s", "1950s", "1960s", "1970s", "1980s", "1990s", "2000s", "2010s", "2020s"]
       if @api_client.config.client_side_validation && opts[:'origin_decade'] && !allowable_values.include?(opts[:'origin_decade'])
         fail ArgumentError, "invalid value for \"origin_decade\", must be one of #{allowable_values}"
@@ -615,6 +683,7 @@ module SongtradrApiClientRuby
       query_params[:'texture'] = opts[:'texture'] if !opts[:'texture'].nil?
       query_params[:'groovyness'] = opts[:'groovyness'] if !opts[:'groovyness'].nil?
       query_params[:'space'] = opts[:'space'] if !opts[:'space'].nil?
+      query_params[:'loudness'] = opts[:'loudness'] if !opts[:'loudness'].nil?
       query_params[:'originDecade'] = opts[:'origin_decade'] if !opts[:'origin_decade'].nil?
       query_params[:'curateability'] = opts[:'curateability'] if !opts[:'curateability'].nil?
       query_params[:'useCase'] = opts[:'use_case'] if !opts[:'use_case'].nil?
@@ -660,71 +729,5 @@ module SongtradrApiClientRuby
       end
       return data, status_code, headers
     end
-
-    # Recordings by granular search options.
-    # @param search_recording_granular_dto [Array<SearchRecordingGranularDTO>] 
-    # @param [Hash] opts the optional parameters
-    # @return [RecordingListDTO]
-    def search_recordings_granular(search_recording_granular_dto, opts = {})
-      data, _status_code, _headers = search_recordings_granular_with_http_info(search_recording_granular_dto, opts)
-      data
-    end
-
-    # Recordings by granular search options.
-    # @param search_recording_granular_dto [Array<SearchRecordingGranularDTO>] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(RecordingListDTO, Integer, Hash)>] RecordingListDTO data, response status code and response headers
-    def search_recordings_granular_with_http_info(search_recording_granular_dto, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: RecordingApi.search_recordings_granular ...'
-      end
-      # verify the required parameter 'search_recording_granular_dto' is set
-      if @api_client.config.client_side_validation && search_recording_granular_dto.nil?
-        fail ArgumentError, "Missing the required parameter 'search_recording_granular_dto' when calling RecordingApi.search_recordings_granular"
-      end
-      # resource path
-      local_var_path = '/api/v1/public/recording/searchGranular'
-
-      # 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_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",
-        :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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end