songtradr_api_client_ruby 1.16.0 → 1.18.0

data/docs/Gender.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::Gender
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **String** |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Gender.new(
-  value: null,
-  confidence: null
-)
-```
-

data/docs/ImageQuality.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::ImageQuality
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **brightness** | **Float** |  | [optional] |
-| **sharpness** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::ImageQuality.new(
-  brightness: null,
-  sharpness: null
-)
-```
-

data/docs/Instance.md

@@ -1,22 +0,0 @@
-# SongtradrApiClientRuby::Instance
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **bounding_box** | [**BoundingBox**](BoundingBox.md) |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-| **dominant_colors** | [**Array<DominantColor>**](DominantColor.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Instance.new(
-  bounding_box: null,
-  confidence: null,
-  dominant_colors: null
-)
-```
-

data/docs/Label.md

@@ -1,28 +0,0 @@
-# SongtradrApiClientRuby::Label
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-| **instances** | [**Array<Instance>**](Instance.md) |  | [optional] |
-| **parents** | [**Array<Parent>**](Parent.md) |  | [optional] |
-| **aliases** | [**Array<LabelAlias>**](LabelAlias.md) |  | [optional] |
-| **categories** | [**Array<LabelCategory>**](LabelCategory.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Label.new(
-  name: null,
-  confidence: null,
-  instances: null,
-  parents: null,
-  aliases: null,
-  categories: null
-)
-```
-

data/docs/LabelAlias.md

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

data/docs/LabelCategory.md

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

data/docs/LabelDetection.md

@@ -1,26 +0,0 @@
-# SongtradrApiClientRuby::LabelDetection
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **timestamp** | **Integer** |  | [optional] |
-| **label** | [**Label**](Label.md) |  | [optional] |
-| **start_timestamp_millis** | **Integer** |  | [optional] |
-| **end_timestamp_millis** | **Integer** |  | [optional] |
-| **duration_millis** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::LabelDetection.new(
-  timestamp: null,
-  label: null,
-  start_timestamp_millis: null,
-  end_timestamp_millis: null,
-  duration_millis: null
-)
-```
-

data/docs/Landmark.md

@@ -1,22 +0,0 @@
-# SongtradrApiClientRuby::Landmark
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** |  | [optional] |
-| **x** | **Float** |  | [optional] |
-| **y** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Landmark.new(
-  type: null,
-  x: null,
-  y: null
-)
-```
-

data/docs/MouthOpen.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::MouthOpen
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **Boolean** |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::MouthOpen.new(
-  value: null,
-  confidence: null
-)
-```
-

data/docs/Mustache.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::Mustache
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **Boolean** |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Mustache.new(
-  value: null,
-  confidence: null
-)
-```
-

data/docs/Parent.md

@@ -1,18 +0,0 @@
-# SongtradrApiClientRuby::Parent
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Parent.new(
-  name: 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/Pose.md

@@ -1,22 +0,0 @@
-# SongtradrApiClientRuby::Pose
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **roll** | **Float** |  | [optional] |
-| **yaw** | **Float** |  | [optional] |
-| **pitch** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Pose.new(
-  roll: null,
-  yaw: null,
-  pitch: null
-)
-```
-

data/docs/Smile.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::Smile
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **Boolean** |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Smile.new(
-  value: null,
-  confidence: null
-)
-```
-

data/docs/Sunglasses.md

@@ -1,20 +0,0 @@
-# SongtradrApiClientRuby::Sunglasses
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **value** | **Boolean** |  | [optional] |
-| **confidence** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::Sunglasses.new(
-  value: null,
-  confidence: 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.16.0
-Contact: info@songtradr.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.2.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