songtradr_api_client_ruby 1.13.6 → 1.15.0

data/docs/UserApi.md

@@ -4,7 +4,6 @@ All URIs are relative to *https://api.songtradr.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_user_referrer**](UserApi.md#create_user_referrer) | **POST** /api/v1/user/referrers/new |  |
 | [**delete_user_file**](UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file. |
 | [**edit_me**](UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user |
 | [**forgot_password**](UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email |
@@ -19,81 +18,10 @@ All URIs are relative to *https://api.songtradr.com*
 | [**sign_up**](UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user. |
 | [**token**](UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token |
 | [**update_password**](UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token |
-| [**update_user_file_recording**](UserApi.md#update_user_file_recording) | **POST** /api/v1/user/file/{objectKey} | Create and edit metadata of your files. |
 | [**user_file**](UserApi.md#user_file) | **GET** /api/v1/user/file/{objectKey} | Details and a download link for a file. |
 | [**user_files**](UserApi.md#user_files) | **GET** /api/v1/user/files | List and search your own files. |
-| [**user_files_download**](UserApi.md#user_files_download) | **GET** /api/v1/user/filesDownload | Download links for your files |
 | [**user_files_status**](UserApi.md#user_files_status) | **GET** /api/v1/user/filesStatus | Status details for files. |
 | [**user_files_summary**](UserApi.md#user_files_summary) | **GET** /api/v1/user/filesSummary | Summary fo your files. |
-| [**user_folders**](UserApi.md#user_folders) | **GET** /api/v1/user/folders | Your Folders |
-| [**user_referrers**](UserApi.md#user_referrers) | **GET** /api/v1/user/referrers/{username} |  |
-
-
-## create_user_referrer
-
-> Object create_user_referrer(save_referrer_dto)
-
-
-
-### 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::UserApi.new
-save_referrer_dto = SongtradrApiClientRuby::SaveReferrerDTO.new # SaveReferrerDTO | 
-
-begin
-  
-  result = api_instance.create_user_referrer(save_referrer_dto)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->create_user_referrer: #{e}"
-end
-```
-
-#### Using the create_user_referrer_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> create_user_referrer_with_http_info(save_referrer_dto)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.create_user_referrer_with_http_info(save_referrer_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->create_user_referrer_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **save_referrer_dto** | [**SaveReferrerDTO**](SaveReferrerDTO.md) |  |  |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
 
 
 ## delete_user_file
@@ -1195,75 +1123,6 @@ end
 - **Accept**: application/hal+json, application/json
 
 
-## update_user_file_recording
-
-> Object update_user_file_recording(object_key, save_file_recording_dto)
-
-Create and edit metadata of your files.
-
-### 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::UserApi.new
-object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be edited.
-save_file_recording_dto = SongtradrApiClientRuby::SaveFileRecordingDTO.new({isrc: 'isrc_example', created_by_version: 'created_by_version_example'}) # SaveFileRecordingDTO | 
-
-begin
-  # Create and edit metadata of your files.
-  result = api_instance.update_user_file_recording(object_key, save_file_recording_dto)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->update_user_file_recording: #{e}"
-end
-```
-
-#### Using the update_user_file_recording_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> update_user_file_recording_with_http_info(object_key, save_file_recording_dto)
-
-```ruby
-begin
-  # Create and edit metadata of your files.
-  data, status_code, headers = api_instance.update_user_file_recording_with_http_info(object_key, save_file_recording_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->update_user_file_recording_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **object_key** | **String** | ObjectKey of the file that should be edited. |  |
-| **save_file_recording_dto** | [**SaveFileRecordingDTO**](SaveFileRecordingDTO.md) |  |  |
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
 ## user_file
 
 > <FileWIthUrlDTO> user_file(object_key)
@@ -1518,181 +1377,6 @@ end
 - **Accept**: application/json
 
 
-## user_files_download
-
-> <Array<FileMinimalWithUrlDTO>> user_files_download(opts)
-
-Download links for your files
-
-### 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::UserApi.new
-opts = {
-  isrc: 'isrc_example', # String | 
-  contributor: 'contributor_example', # String | 
-  main_artist: 'main_artist_example', # String | 
-  composer: 'composer_example', # String | 
-  title: 'title_example', # String | 
-  language: 'language_example', # String | 
-  genre_names: ['inner_example'], # Array<String> | 
-  tag_names: ['inner_example'], # Array<String> | 
-  release_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
-  primary_mood_cluster: 'aggressive', # String | 
-  secondary_mood_cluster: 'aggressive', # String | 
-  tertiary_mood_cluster: 'aggressive', # String | 
-  valence: 'very sad', # String | 
-  arousal: 'very calm', # String | 
-  pleasantness: 'very unpleasant', # String | 
-  engagement: 'very unengaging', # String | 
-  vocals: 'instrumental', # String | 
-  dominant_instrument: 'electric guitar', # String | 
-  secondary_instrument: 'electric guitar', # String | 
-  tertiary_instrument: 'electric guitar', # String | 
-  energy: 'very quiet', # String | 
-  sound_generation: 'acoustic', # String | 
-  tempo: 'very slow', # String | 
-  scale: 'major key', # String | 
-  rhythm: 'common time', # String | 
-  primary_sound_character: 'aggressive', # String | 
-  timbre: 'very warm', # String | 
-  roughness: 'very clear', # String | 
-  tonality: 'monotonous', # String | 
-  harmony: 'very dissonant', # String | 
-  texture: 'very thin', # String | 
-  groovyness: 'very steady', # String | 
-  space: 'very compact', # String | 
-  production_rating: 'low production quality', # String | 
-  performance_rating: 'low performance quality', # String | 
-  song_rating: 'low song quality', # String | 
-  audience_age: 'Generation Z', # String | 
-  audience_region: 'Australia and New Zealand', # String | 
-  audience_gender: 'male', # String | 
-  songtradr_track_id: 'songtradr_track_id_example', # String | 
-  usage_name: 'usage_name_example', # String | 
-  bpm_min: 56, # Integer | 
-  bpm_max: 56, # Integer | 
-  name: 'name_example', # String | 
-  folder: 'folder_example', # String | 
-  extension: 'extension_example', # String | 
-  upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
-  min_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
-  max_upload_end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
-  fingerprint_status: 'fingerprint_status_example', # String | 
-  inference_status: 'inference_status_example', # String | 
-  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
-  # Download links for your files
-  result = api_instance.user_files_download(opts)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->user_files_download: #{e}"
-end
-```
-
-#### Using the user_files_download_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<FileMinimalWithUrlDTO>>, Integer, Hash)> user_files_download_with_http_info(opts)
-
-```ruby
-begin
-  # Download links for your files
-  data, status_code, headers = api_instance.user_files_download_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<FileMinimalWithUrlDTO>>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->user_files_download_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **isrc** | **String** |  | [optional] |
-| **contributor** | **String** |  | [optional] |
-| **main_artist** | **String** |  | [optional] |
-| **composer** | **String** |  | [optional] |
-| **title** | **String** |  | [optional] |
-| **language** | **String** |  | [optional] |
-| **genre_names** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
-| **tag_names** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
-| **release_date** | **Time** |  | [optional] |
-| **primary_mood_cluster** | **String** |  | [optional] |
-| **secondary_mood_cluster** | **String** |  | [optional] |
-| **tertiary_mood_cluster** | **String** |  | [optional] |
-| **valence** | **String** |  | [optional] |
-| **arousal** | **String** |  | [optional] |
-| **pleasantness** | **String** |  | [optional] |
-| **engagement** | **String** |  | [optional] |
-| **vocals** | **String** |  | [optional] |
-| **dominant_instrument** | **String** |  | [optional] |
-| **secondary_instrument** | **String** |  | [optional] |
-| **tertiary_instrument** | **String** |  | [optional] |
-| **energy** | **String** |  | [optional] |
-| **sound_generation** | **String** |  | [optional] |
-| **tempo** | **String** |  | [optional] |
-| **scale** | **String** |  | [optional] |
-| **rhythm** | **String** |  | [optional] |
-| **primary_sound_character** | **String** |  | [optional] |
-| **timbre** | **String** |  | [optional] |
-| **roughness** | **String** |  | [optional] |
-| **tonality** | **String** |  | [optional] |
-| **harmony** | **String** |  | [optional] |
-| **texture** | **String** |  | [optional] |
-| **groovyness** | **String** |  | [optional] |
-| **space** | **String** |  | [optional] |
-| **production_rating** | **String** |  | [optional] |
-| **performance_rating** | **String** |  | [optional] |
-| **song_rating** | **String** |  | [optional] |
-| **audience_age** | **String** |  | [optional] |
-| **audience_region** | **String** |  | [optional] |
-| **audience_gender** | **String** |  | [optional] |
-| **songtradr_track_id** | **String** |  | [optional] |
-| **usage_name** | **String** |  | [optional] |
-| **bpm_min** | **Integer** |  | [optional] |
-| **bpm_max** | **Integer** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **folder** | **String** |  | [optional] |
-| **extension** | **String** |  | [optional] |
-| **upload_end_time** | **Time** |  | [optional] |
-| **min_upload_end_time** | **Time** |  | [optional] |
-| **max_upload_end_time** | **Time** |  | [optional] |
-| **fingerprint_status** | **String** |  | [optional] |
-| **inference_status** | **String** |  | [optional] |
-| **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 100] |
-| **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;FileMinimalWithUrlDTO&gt;**](FileMinimalWithUrlDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## user_files_status
 
 > <Array<FileSmallDTO>> user_files_status(object_keys)
@@ -1938,143 +1622,3 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## user_folders
-
-> Array&lt;String&gt; user_folders(opts)
-
-Your Folders
-
-### 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::UserApi.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
-  # Your Folders
-  result = api_instance.user_folders(opts)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->user_folders: #{e}"
-end
-```
-
-#### Using the user_folders_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;String&gt;, Integer, Hash)> user_folders_with_http_info(opts)
-
-```ruby
-begin
-  # Your Folders
-  data, status_code, headers = api_instance.user_folders_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;String&gt;
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->user_folders_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;String&gt;**
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## user_referrers
-
-> Array&lt;String&gt; user_referrers(username)
-
-
-
-### 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::UserApi.new
-username = 'username_example' # String | 
-
-begin
-  
-  result = api_instance.user_referrers(username)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->user_referrers: #{e}"
-end
-```
-
-#### Using the user_referrers_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Array&lt;String&gt;, Integer, Hash)> user_referrers_with_http_info(username)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.user_referrers_with_http_info(username)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array&lt;String&gt;
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling UserApi->user_referrers_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **username** | **String** |  |  |
-
-### Return type
-
-**Array&lt;String&gt;**
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/lib/songtradr_api_client_ruby/api/allowed_values_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