musicube_api_client_ruby 1.1.5

data/docs/UserApi.md

@@ -0,0 +1,1936 @@
+# MusicubeApiClientRuby::UserApi
+
+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 |
+| [**initiate_user_file_upload**](UserApi.md#initiate_user_file_upload) | **POST** /api/v1/user/file/{name}/initUpload | Initialize a file upload. Responds with an URL where the file can be uploaded. |
+| [**login**](UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token. |
+| [**me**](UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user |
+| [**recordings_by_folder_with_taggrams**](UserApi.md#recordings_by_folder_with_taggrams) | **GET** /api/v1/user/folder/{folderName}/taggrams | Timeseries of AI generated moods, musical features and more for recordings in your folder. |
+| [**recordings_by_folder_with_tagstrengths**](UserApi.md#recordings_by_folder_with_tagstrengths) | **GET** /api/v1/user/folder/{folderName}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder. |
+| [**save_playlist**](UserApi.md#save_playlist) | **POST** /api/v1/user/savePlaylist | List, search and create playlist of your own files. |
+| [**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 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+save_referrer_dto = MusicubeApiClientRuby::SaveReferrerDTO.new # SaveReferrerDTO | 
+
+begin
+  
+  result = api_instance.create_user_referrer(save_referrer_dto)
+  p result
+rescue MusicubeApiClientRuby::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 MusicubeApiClientRuby::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
+
+> Object delete_user_file(object_key)
+
+Delete file.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be deleted.
+
+begin
+  # Delete file.
+  result = api_instance.delete_user_file(object_key)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->delete_user_file: #{e}"
+end
+```
+
+#### Using the delete_user_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_user_file_with_http_info(object_key)
+
+```ruby
+begin
+  # Delete file.
+  data, status_code, headers = api_instance.delete_user_file_with_http_info(object_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->delete_user_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_key** | **String** | ObjectKey of the file that should be deleted. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/json
+
+
+## edit_me
+
+> Object edit_me(save_user_dto)
+
+Edit details for a logged-in user
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+save_user_dto = MusicubeApiClientRuby::SaveUserDTO.new({email_address: 'email_address_example'}) # SaveUserDTO | 
+
+begin
+  # Edit details for a logged-in user
+  result = api_instance.edit_me(save_user_dto)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->edit_me: #{e}"
+end
+```
+
+#### Using the edit_me_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> edit_me_with_http_info(save_user_dto)
+
+```ruby
+begin
+  # Edit details for a logged-in user
+  data, status_code, headers = api_instance.edit_me_with_http_info(save_user_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->edit_me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_user_dto** | [**SaveUserDTO**](SaveUserDTO.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## forgot_password
+
+> Object forgot_password(forgot_password_dto)
+
+Send a password reset email
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+forgot_password_dto = MusicubeApiClientRuby::ForgotPasswordDTO.new({email_or_username: 'email_or_username_example'}) # ForgotPasswordDTO | 
+
+begin
+  # Send a password reset email
+  result = api_instance.forgot_password(forgot_password_dto)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->forgot_password: #{e}"
+end
+```
+
+#### Using the forgot_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> forgot_password_with_http_info(forgot_password_dto)
+
+```ruby
+begin
+  # Send a password reset email
+  data, status_code, headers = api_instance.forgot_password_with_http_info(forgot_password_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->forgot_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **forgot_password_dto** | [**ForgotPasswordDTO**](ForgotPasswordDTO.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/hal+json, application/json
+
+
+## initiate_user_file_upload
+
+> <InitPutRecordingAudioDTO> initiate_user_file_upload(name, folder, opts)
+
+Initialize a file upload. Responds with an URL where the file can be uploaded.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+name = 'FileName.mp3' # String | The Name of the file that will be uploaded
+folder = 'FolderName' # String | The Name of the folder that the file will be placed in
+opts = {
+  file_upload_dto: MusicubeApiClientRuby::FileUploadDTO.new # FileUploadDTO | 
+}
+
+begin
+  # Initialize a file upload. Responds with an URL where the file can be uploaded.
+  result = api_instance.initiate_user_file_upload(name, folder, opts)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->initiate_user_file_upload: #{e}"
+end
+```
+
+#### Using the initiate_user_file_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InitPutRecordingAudioDTO>, Integer, Hash)> initiate_user_file_upload_with_http_info(name, folder, opts)
+
+```ruby
+begin
+  # Initialize a file upload. Responds with an URL where the file can be uploaded.
+  data, status_code, headers = api_instance.initiate_user_file_upload_with_http_info(name, folder, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InitPutRecordingAudioDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->initiate_user_file_upload_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The Name of the file that will be uploaded |  |
+| **folder** | **String** | The Name of the folder that the file will be placed in |  |
+| **file_upload_dto** | [**FileUploadDTO**](FileUploadDTO.md) |  | [optional] |
+
+### Return type
+
+[**InitPutRecordingAudioDTO**](InitPutRecordingAudioDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## login
+
+> <JwtTokenDTO> login(login_dto)
+
+Login to generate a bearer token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+login_dto = MusicubeApiClientRuby::LoginDTO.new({email: 'email_example', password: 'password_example'}) # LoginDTO | 
+
+begin
+  # Login to generate a bearer token.
+  result = api_instance.login(login_dto)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->login: #{e}"
+end
+```
+
+#### Using the login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JwtTokenDTO>, Integer, Hash)> login_with_http_info(login_dto)
+
+```ruby
+begin
+  # Login to generate a bearer token.
+  data, status_code, headers = api_instance.login_with_http_info(login_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JwtTokenDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **login_dto** | [**LoginDTO**](LoginDTO.md) |  |  |
+
+### Return type
+
+[**JwtTokenDTO**](JwtTokenDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## me
+
+> <UserDTO> me
+
+Details for a logged-in user
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+
+begin
+  # Details for a logged-in user
+  result = api_instance.me
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->me: #{e}"
+end
+```
+
+#### Using the me_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserDTO>, Integer, Hash)> me_with_http_info
+
+```ruby
+begin
+  # Details for a logged-in user
+  data, status_code, headers = api_instance.me_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserDTO**](UserDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## recordings_by_folder_with_taggrams
+
+> <Array<RecordingMinimalWithTaggramsDTO>> recordings_by_folder_with_taggrams(folder_name, opts)
+
+Timeseries of AI generated moods, musical features and more for recordings in your folder.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+folder_name = 'Default' # String | Folder name
+opts = {
+  category_name: 'instrument', # String | Show only taggrams for one category.
+  tag_name: 'energetic', # String | Show only taggrams for one tag.
+  genre_name: 'Ska', # String | Show only taggrams for one genre.
+  from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
+  fill_with_zero: true, # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
+  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
+  # Timeseries of AI generated moods, musical features and more for recordings in your folder.
+  result = api_instance.recordings_by_folder_with_taggrams(folder_name, opts)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->recordings_by_folder_with_taggrams: #{e}"
+end
+```
+
+#### Using the recordings_by_folder_with_taggrams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)> recordings_by_folder_with_taggrams_with_http_info(folder_name, opts)
+
+```ruby
+begin
+  # Timeseries of AI generated moods, musical features and more for recordings in your folder.
+  data, status_code, headers = api_instance.recordings_by_folder_with_taggrams_with_http_info(folder_name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<RecordingMinimalWithTaggramsDTO>>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->recordings_by_folder_with_taggrams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder_name** | **String** | Folder name |  |
+| **category_name** | **String** | Show only taggrams for one category. | [optional] |
+| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
+| **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
+| **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
+| **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [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 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;RecordingMinimalWithTaggramsDTO&gt;**](RecordingMinimalWithTaggramsDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## recordings_by_folder_with_tagstrengths
+
+> <Array<RecordingMinimalWithTagstrengthsDTO>> recordings_by_folder_with_tagstrengths(folder_name, opts)
+
+Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+folder_name = 'Default' # String | Folder name
+opts = {
+  category_name: 'instrument', # String | Show only taggrams for one category.
+  tag_name: 'energetic', # String | Show only taggrams for one tag.
+  genre_name: 'Ska', # String | Show only taggrams for one genre.
+  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
+  # Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
+  result = api_instance.recordings_by_folder_with_tagstrengths(folder_name, opts)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->recordings_by_folder_with_tagstrengths: #{e}"
+end
+```
+
+#### Using the recordings_by_folder_with_tagstrengths_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)> recordings_by_folder_with_tagstrengths_with_http_info(folder_name, opts)
+
+```ruby
+begin
+  # Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
+  data, status_code, headers = api_instance.recordings_by_folder_with_tagstrengths_with_http_info(folder_name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<RecordingMinimalWithTagstrengthsDTO>>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->recordings_by_folder_with_tagstrengths_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **folder_name** | **String** | Folder name |  |
+| **category_name** | **String** | Show only taggrams for one category. | [optional] |
+| **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
+| **genre_name** | **String** | Show only taggrams for one genre. | [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 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;RecordingMinimalWithTagstrengthsDTO&gt;**](RecordingMinimalWithTagstrengthsDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## save_playlist
+
+> <FileListDTO> save_playlist(opts)
+
+List, search and create playlist of your own files.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+opts = {
+  isrc: 'USUM71703692', # String | Search for a ISRC
+  contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
+  main_artist: 'The Beatles', # String | Search for a main artist.
+  composer: 'John Cale', # String | Search for a composer.
+  title: 'Highway To Hell', # String | Search for a title.
+  language: 'en', # String | Search for a language of the lyrics.
+  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 | 
+  origin_decade: 'pre-1950s', # String | 
+  curateability: 'curateable', # String | 
+  use_case: 'background', # String | 
+  channel_suitability: 'Spotify', # String | 
+  similar_to_recording: 'similar_to_recording_example', # String | 
+  create_playlist_with_name: 'PlaylistName', # String | 
+  songtradr_track_id: 'songtradr_track_id_example', # String | 
+  usage_name: 'usage_name_example', # String | 
+  bpm_min: 50, # Integer | Search for a minimal bpm.
+  bpm_max: 210, # Integer | Search for a maximal bpm.
+  name: 'Groove.mp3', # String | Search for a file name.
+  folder: 'defaultFolder', # String | Search for a folder.
+  extension: '.mp3', # String | Search for a file extension.
+  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: 'done', # String | Search for a fingerprint status.
+  inference_status: 'done', # String | Search for a inference status.
+  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, search and create playlist of your own files.
+  result = api_instance.save_playlist(opts)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->save_playlist: #{e}"
+end
+```
+
+#### Using the save_playlist_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileListDTO>, Integer, Hash)> save_playlist_with_http_info(opts)
+
+```ruby
+begin
+  # List, search and create playlist of your own files.
+  data, status_code, headers = api_instance.save_playlist_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileListDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->save_playlist_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **isrc** | **String** | Search for a ISRC | [optional] |
+| **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
+| **main_artist** | **String** | Search for a main artist. | [optional] |
+| **composer** | **String** | Search for a composer. | [optional] |
+| **title** | **String** | Search for a title. | [optional] |
+| **language** | **String** | Search for a language of the lyrics. | [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] |
+| **origin_decade** | **String** |  | [optional] |
+| **curateability** | **String** |  | [optional] |
+| **use_case** | **String** |  | [optional] |
+| **channel_suitability** | **String** |  | [optional] |
+| **similar_to_recording** | **String** |  | [optional] |
+| **create_playlist_with_name** | **String** |  | [optional] |
+| **songtradr_track_id** | **String** |  | [optional] |
+| **usage_name** | **String** |  | [optional] |
+| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
+| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
+| **name** | **String** | Search for a file name. | [optional] |
+| **folder** | **String** | Search for a folder. | [optional] |
+| **extension** | **String** | Search for a file extension. | [optional] |
+| **upload_end_time** | **Time** |  | [optional] |
+| **min_upload_end_time** | **Time** |  | [optional] |
+| **max_upload_end_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
+| **inference_status** | **String** | Search for a inference status. | [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
+
+[**FileListDTO**](FileListDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sign_up
+
+> <SignUpDTO> sign_up(save_user_dto)
+
+Sign up a new user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+save_user_dto = MusicubeApiClientRuby::SaveUserDTO.new({email_address: 'email_address_example'}) # SaveUserDTO | 
+
+begin
+  # Sign up a new user.
+  result = api_instance.sign_up(save_user_dto)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->sign_up: #{e}"
+end
+```
+
+#### Using the sign_up_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignUpDTO>, Integer, Hash)> sign_up_with_http_info(save_user_dto)
+
+```ruby
+begin
+  # Sign up a new user.
+  data, status_code, headers = api_instance.sign_up_with_http_info(save_user_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignUpDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->sign_up_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_user_dto** | [**SaveUserDTO**](SaveUserDTO.md) |  |  |
+
+### Return type
+
+[**SignUpDTO**](SignUpDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## token
+
+> <JwtTokenDTO> token(token_request)
+
+Generates a new JWT token for the given refresh token
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+token_request = MusicubeApiClientRuby::TokenRequest.new({refresh_token: 'refresh_token_example'}) # TokenRequest | 
+
+begin
+  # Generates a new JWT token for the given refresh token
+  result = api_instance.token(token_request)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->token: #{e}"
+end
+```
+
+#### Using the token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JwtTokenDTO>, Integer, Hash)> token_with_http_info(token_request)
+
+```ruby
+begin
+  # Generates a new JWT token for the given refresh token
+  data, status_code, headers = api_instance.token_with_http_info(token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JwtTokenDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token_request** | [**TokenRequest**](TokenRequest.md) |  |  |
+
+### Return type
+
+[**JwtTokenDTO**](JwtTokenDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_password
+
+> Object update_password(update_password_dto)
+
+Update password by using the password reset token
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+update_password_dto = MusicubeApiClientRuby::UpdatePasswordDTO.new({token: 'token_example', password: 'password_example'}) # UpdatePasswordDTO | 
+
+begin
+  # Update password by using the password reset token
+  result = api_instance.update_password(update_password_dto)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->update_password: #{e}"
+end
+```
+
+#### Using the update_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> update_password_with_http_info(update_password_dto)
+
+```ruby
+begin
+  # Update password by using the password reset token
+  data, status_code, headers = api_instance.update_password_with_http_info(update_password_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->update_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_password_dto** | [**UpdatePasswordDTO**](UpdatePasswordDTO.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **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 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be edited.
+save_file_recording_dto = MusicubeApiClientRuby::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 MusicubeApiClientRuby::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 MusicubeApiClientRuby::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)
+
+Details and a download link for a file.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+object_key = '73818371-0963-412e-aa3d-27c2bab952a3' # String | ObjectKey of the file that should be edited.
+
+begin
+  # Details and a download link for a file.
+  result = api_instance.user_file(object_key)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_file: #{e}"
+end
+```
+
+#### Using the user_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileWIthUrlDTO>, Integer, Hash)> user_file_with_http_info(object_key)
+
+```ruby
+begin
+  # Details and a download link for a file.
+  data, status_code, headers = api_instance.user_file_with_http_info(object_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileWIthUrlDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_key** | **String** | ObjectKey of the file that should be edited. |  |
+
+### Return type
+
+[**FileWIthUrlDTO**](FileWIthUrlDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_files
+
+> <FileListDTO> user_files(opts)
+
+List and search your own files.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+opts = {
+  isrc: 'USUM71703692', # String | Search for a ISRC
+  contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
+  main_artist: 'The Beatles', # String | Search for a main artist.
+  composer: 'John Cale', # String | Search for a composer.
+  title: 'Highway To Hell', # String | Search for a title.
+  language: 'en', # String | Search for a language of the lyrics.
+  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 | 
+  origin_decade: 'pre-1950s', # String | 
+  curateability: 'curateable', # String | 
+  use_case: 'background', # String | 
+  channel_suitability: 'Spotify', # String | 
+  similar_to_recording: 'similar_to_recording_example', # String | 
+  songtradr_track_id: 'songtradr_track_id_example', # String | 
+  usage_name: 'usage_name_example', # String | 
+  bpm_min: 50, # Integer | Search for a minimal bpm.
+  bpm_max: 210, # Integer | Search for a maximal bpm.
+  name: 'Groove.mp3', # String | Search for a file name.
+  folder: 'defaultFolder', # String | Search for a folder.
+  extension: '.mp3', # String | Search for a file extension.
+  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: 'done', # String | Search for a fingerprint status.
+  inference_status: 'done', # String | Search for a inference status.
+  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 and search your own files.
+  result = api_instance.user_files(opts)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_files: #{e}"
+end
+```
+
+#### Using the user_files_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileListDTO>, Integer, Hash)> user_files_with_http_info(opts)
+
+```ruby
+begin
+  # List and search your own files.
+  data, status_code, headers = api_instance.user_files_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileListDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_files_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **isrc** | **String** | Search for a ISRC | [optional] |
+| **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
+| **main_artist** | **String** | Search for a main artist. | [optional] |
+| **composer** | **String** | Search for a composer. | [optional] |
+| **title** | **String** | Search for a title. | [optional] |
+| **language** | **String** | Search for a language of the lyrics. | [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] |
+| **origin_decade** | **String** |  | [optional] |
+| **curateability** | **String** |  | [optional] |
+| **use_case** | **String** |  | [optional] |
+| **channel_suitability** | **String** |  | [optional] |
+| **similar_to_recording** | **String** |  | [optional] |
+| **songtradr_track_id** | **String** |  | [optional] |
+| **usage_name** | **String** |  | [optional] |
+| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
+| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
+| **name** | **String** | Search for a file name. | [optional] |
+| **folder** | **String** | Search for a folder. | [optional] |
+| **extension** | **String** | Search for a file extension. | [optional] |
+| **upload_end_time** | **Time** |  | [optional] |
+| **min_upload_end_time** | **Time** |  | [optional] |
+| **max_upload_end_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
+| **inference_status** | **String** | Search for a inference status. | [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
+
+[**FileListDTO**](FileListDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_files_download
+
+> <Array<FileMinimalWithUrlDTO>> user_files_download(opts)
+
+Download links for your files
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::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 MusicubeApiClientRuby::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 MusicubeApiClientRuby::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)
+
+Status details for files.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+object_keys = 'Example-objectKey' # String | Comma-separated  list of objectKeys of the files.
+
+begin
+  # Status details for files.
+  result = api_instance.user_files_status(object_keys)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_files_status: #{e}"
+end
+```
+
+#### Using the user_files_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<FileSmallDTO>>, Integer, Hash)> user_files_status_with_http_info(object_keys)
+
+```ruby
+begin
+  # Status details for files.
+  data, status_code, headers = api_instance.user_files_status_with_http_info(object_keys)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<FileSmallDTO>>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_files_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_keys** | **String** | Comma-separated  list of objectKeys of the files. |  |
+
+### Return type
+
+[**Array&lt;FileSmallDTO&gt;**](FileSmallDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_files_summary
+
+> <FilesSummaryDTO> user_files_summary(opts)
+
+Summary fo your files.
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+opts = {
+  isrc: 'USUM71703692', # String | Search for a ISRC
+  contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
+  main_artist: 'The Beatles', # String | Search for a main artist.
+  composer: 'John Cale', # String | Search for a composer.
+  title: 'Highway To Hell', # String | Search for a title.
+  language: 'en', # String | Search for a language of the lyrics.
+  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 | 
+  origin_decade: 'pre-1950s', # String | 
+  curateability: 'curateable', # String | 
+  use_case: 'background', # String | 
+  channel_suitability: 'Spotify', # String | 
+  similar_to_recording: 'Highway To Hell', # String | 
+  songtradr_track_id: 'songtradr_track_id_example', # String | 
+  usage_name: 'usage_name_example', # String | 
+  bpm_min: 50, # Integer | Search for a minimal bpm.
+  bpm_max: 210, # Integer | Search for a maximal bpm.
+  name: 'Groove.mp3', # String | Search for a file name.
+  folder: 'defaultFolder', # String | Search for a folder.
+  extension: '.mp3', # String | Search for a file extension.
+  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: 'done', # String | Search for a fingerprint status.
+  inference_status: 'done' # String | Search for a inference status.
+}
+
+begin
+  # Summary fo your files.
+  result = api_instance.user_files_summary(opts)
+  p result
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_files_summary: #{e}"
+end
+```
+
+#### Using the user_files_summary_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FilesSummaryDTO>, Integer, Hash)> user_files_summary_with_http_info(opts)
+
+```ruby
+begin
+  # Summary fo your files.
+  data, status_code, headers = api_instance.user_files_summary_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FilesSummaryDTO>
+rescue MusicubeApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->user_files_summary_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **isrc** | **String** | Search for a ISRC | [optional] |
+| **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
+| **main_artist** | **String** | Search for a main artist. | [optional] |
+| **composer** | **String** | Search for a composer. | [optional] |
+| **title** | **String** | Search for a title. | [optional] |
+| **language** | **String** | Search for a language of the lyrics. | [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] |
+| **origin_decade** | **String** |  | [optional] |
+| **curateability** | **String** |  | [optional] |
+| **use_case** | **String** |  | [optional] |
+| **channel_suitability** | **String** |  | [optional] |
+| **similar_to_recording** | **String** |  | [optional] |
+| **songtradr_track_id** | **String** |  | [optional] |
+| **usage_name** | **String** |  | [optional] |
+| **bpm_min** | **Integer** | Search for a minimal bpm. | [optional] |
+| **bpm_max** | **Integer** | Search for a maximal bpm. | [optional] |
+| **name** | **String** | Search for a file name. | [optional] |
+| **folder** | **String** | Search for a folder. | [optional] |
+| **extension** | **String** | Search for a file extension. | [optional] |
+| **upload_end_time** | **Time** |  | [optional] |
+| **min_upload_end_time** | **Time** |  | [optional] |
+| **max_upload_end_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** | Search for a fingerprint status. | [optional] |
+| **inference_status** | **String** | Search for a inference status. | [optional] |
+
+### Return type
+
+[**FilesSummaryDTO**](FilesSummaryDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_folders
+
+> Array&lt;String&gt; user_folders(opts)
+
+Your Folders
+
+### Examples
+
+```ruby
+require 'time'
+require 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::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 MusicubeApiClientRuby::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 MusicubeApiClientRuby::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 'musicube_api_client_ruby'
+# setup authorization
+MusicubeApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MusicubeApiClientRuby::UserApi.new
+username = 'username_example' # String | 
+
+begin
+  
+  result = api_instance.user_referrers(username)
+  p result
+rescue MusicubeApiClientRuby::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 MusicubeApiClientRuby::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
+