songtradr_api_client_ruby 1.13.4 → 1.13.6

data/docs/APIKeysApi.md

@@ -1,217 +0,0 @@
-# SongtradrApiClientRuby::APIKeysApi
-
-All URIs are relative to *https://api.songtradr.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api/v1/user/apiKeys | create an API key |
-| [**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api/v1/user/apiKeys/{id} | delete an API key |
-| [**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api/v1/user/apiKeys | list API keys |
-
-
-## create_api_key
-
-> <AdminApiUserDTO> create_api_key(create_api_key_dto)
-
-create an API key
-
-### 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::APIKeysApi.new
-create_api_key_dto = SongtradrApiClientRuby::CreateApiKeyDTO.new # CreateApiKeyDTO | 
-
-begin
-  # create an API key
-  result = api_instance.create_api_key(create_api_key_dto)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling APIKeysApi->create_api_key: #{e}"
-end
-```
-
-#### Using the create_api_key_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AdminApiUserDTO>, Integer, Hash)> create_api_key_with_http_info(create_api_key_dto)
-
-```ruby
-begin
-  # create an API key
-  data, status_code, headers = api_instance.create_api_key_with_http_info(create_api_key_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AdminApiUserDTO>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling APIKeysApi->create_api_key_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **create_api_key_dto** | [**CreateApiKeyDTO**](CreateApiKeyDTO.md) |  |  |
-
-### Return type
-
-[**AdminApiUserDTO**](AdminApiUserDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_api_key
-
-> Object delete_api_key(id)
-
-delete an API key
-
-### 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::APIKeysApi.new
-id = 'id_example' # String | 
-
-begin
-  # delete an API key
-  result = api_instance.delete_api_key(id)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling APIKeysApi->delete_api_key: #{e}"
-end
-```
-
-#### Using the delete_api_key_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> delete_api_key_with_http_info(id)
-
-```ruby
-begin
-  # delete an API key
-  data, status_code, headers = api_instance.delete_api_key_with_http_info(id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling APIKeysApi->delete_api_key_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_api_keys
-
-> <Array<ApiKeyDTO>> get_api_keys(opts)
-
-list API keys
-
-### 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::APIKeysApi.new
-opts = {
-  page: 56, # Integer | Zero-based page index (0..N)
-  size: 56, # Integer | The size of the page to be returned
-  sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
-}
-
-begin
-  # list API keys
-  result = api_instance.get_api_keys(opts)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling APIKeysApi->get_api_keys: #{e}"
-end
-```
-
-#### Using the get_api_keys_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> get_api_keys_with_http_info(opts)
-
-```ruby
-begin
-  # list API keys
-  data, status_code, headers = api_instance.get_api_keys_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<ApiKeyDTO>>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling APIKeysApi->get_api_keys_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
-| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
-| **sort** | [**Array&lt;String&gt;**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
-
-### Return type
-
-[**Array&lt;ApiKeyDTO&gt;**](ApiKeyDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/AdminApiUserDTO.md

@@ -1,70 +0,0 @@
-# SongtradrApiClientRuby::AdminApiUserDTO
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **username** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **full_name** | **String** |  | [optional] |
-| **language** | **String** |  | [optional] |
-| **is_admin** | **Boolean** |  | [optional] |
-| **widgets_allowed** | **Boolean** |  | [optional] |
-| **full_search_allowed** | **Boolean** |  | [optional] |
-| **voice_search_allowed** | **Boolean** |  | [optional] |
-| **recording_detail_allowed** | **Boolean** |  | [optional] |
-| **artist_detail_allowed** | **Boolean** |  | [optional] |
-| **playlist_prediction_allowed** | **Boolean** |  | [optional] |
-| **signup_allowed** | **Boolean** |  | [optional] |
-| **upload_allowed** | **Boolean** |  | [optional] |
-| **fingerprint_allowed** | **Boolean** |  | [optional] |
-| **audiotagging_allowed** | **Boolean** |  | [optional] |
-| **b2b_allowed** | **Boolean** |  | [optional] |
-| **editor_allowed** | **Boolean** |  | [optional] |
-| **reduced_musical_features** | **Boolean** |  | [optional] |
-| **confirmed** | **Boolean** |  | [optional] |
-| **gdpr_confirmation_timestamp** | **Time** |  | [optional] |
-| **last_login** | **Time** |  | [optional] |
-| **total_logins** | **Integer** |  | [optional] |
-| **total_searches** | **Integer** |  | [optional] |
-| **total_uploads** | **Integer** |  | [optional] |
-| **total_downloads** | **Integer** |  | [optional] |
-| **total_updates** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'songtradr_api_client_ruby'
-
-instance = SongtradrApiClientRuby::AdminApiUserDTO.new(
-  id: null,
-  username: null,
-  email: null,
-  full_name: null,
-  language: null,
-  is_admin: null,
-  widgets_allowed: null,
-  full_search_allowed: null,
-  voice_search_allowed: null,
-  recording_detail_allowed: null,
-  artist_detail_allowed: null,
-  playlist_prediction_allowed: null,
-  signup_allowed: null,
-  upload_allowed: null,
-  fingerprint_allowed: null,
-  audiotagging_allowed: null,
-  b2b_allowed: null,
-  editor_allowed: null,
-  reduced_musical_features: null,
-  confirmed: null,
-  gdpr_confirmation_timestamp: null,
-  last_login: null,
-  total_logins: null,
-  total_searches: null,
-  total_uploads: null,
-  total_downloads: null,
-  total_updates: null
-)
-```
-

data/docs/ApiKeyDTO.md

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

data/lib/songtradr_api_client_ruby/api/api_keys_api.rb

@@ -1,213 +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.13.4
-Contact: info@songtradr.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.1.0-SNAPSHOT
-
-=end
-
-require 'cgi'
-
-module SongtradrApiClientRuby
-  class APIKeysApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # create an API key
-    # @param create_api_key_dto [CreateApiKeyDTO] 
-    # @param [Hash] opts the optional parameters
-    # @return [AdminApiUserDTO]
-    def create_api_key(create_api_key_dto, opts = {})
-      data, _status_code, _headers = create_api_key_with_http_info(create_api_key_dto, opts)
-      data
-    end
-
-    # create an API key
-    # @param create_api_key_dto [CreateApiKeyDTO] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(AdminApiUserDTO, Integer, Hash)>] AdminApiUserDTO data, response status code and response headers
-    def create_api_key_with_http_info(create_api_key_dto, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: APIKeysApi.create_api_key ...'
-      end
-      # verify the required parameter 'create_api_key_dto' is set
-      if @api_client.config.client_side_validation && create_api_key_dto.nil?
-        fail ArgumentError, "Missing the required parameter 'create_api_key_dto' when calling APIKeysApi.create_api_key"
-      end
-      # resource path
-      local_var_path = '/api/v1/user/apiKeys'
-
-      # 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(create_api_key_dto)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'AdminApiUserDTO'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"APIKeysApi.create_api_key",
-        :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: APIKeysApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # delete an API key
-    # @param id [String] 
-    # @param [Hash] opts the optional parameters
-    # @return [Object]
-    def delete_api_key(id, opts = {})
-      data, _status_code, _headers = delete_api_key_with_http_info(id, opts)
-      data
-    end
-
-    # delete an API key
-    # @param id [String] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
-    def delete_api_key_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: APIKeysApi.delete_api_key ...'
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysApi.delete_api_key"
-      end
-      # resource path
-      local_var_path = '/api/v1/user/apiKeys/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Object'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"APIKeysApi.delete_api_key",
-        :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: APIKeysApi#delete_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # list API keys
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Zero-based page index (0..N) (default to 0)
-    # @option opts [Integer] :size The size of the page to be returned (default to 20)
-    # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
-    # @return [Array<ApiKeyDTO>]
-    def get_api_keys(opts = {})
-      data, _status_code, _headers = get_api_keys_with_http_info(opts)
-      data
-    end
-
-    # list API keys
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Zero-based page index (0..N) (default to 0)
-    # @option opts [Integer] :size The size of the page to be returned (default to 20)
-    # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
-    # @return [Array<(Array<ApiKeyDTO>, Integer, Hash)>] Array<ApiKeyDTO> data, response status code and response headers
-    def get_api_keys_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_keys ...'
-      end
-      # resource path
-      local_var_path = '/api/v1/user/apiKeys'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
-      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
-      query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].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<ApiKeyDTO>'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearer-jwt']
-
-      new_options = opts.merge(
-        :operation => :"APIKeysApi.get_api_keys",
-        :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: APIKeysApi#get_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end