songtradr_api_client_ruby 1.12.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f96becb3654d7fd4369df782e82b79683a9bb05ceacc787c4bf20cde2c59a26
+  data.tar.gz: 29ef1f0814d6b2af7ba7ffae5d871c351c6097d87987f63bfb0c2dc871aa095e
+SHA512:
+  metadata.gz: 90e1caa4b96e3700510c22aa383dd2a521110a9709819f63f5959c54bfa28190cef2583a51e60ab9375b6595acd7fe56e7581ef83de68a30e674846be0137f8c
+  data.tar.gz: 51e72fd324c1a0760f6dbf5c0fedfce46810b9a34649ce58b803836b9046462aec28c6706b030da853b6576aed633e9bb8b8355cc62eb650416ea3069b5d3e4e

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    songtradr_api_client_ruby (1.12.21)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-multipart
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.7.6)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    jaro_winkler (1.5.6)
+    method_source (1.0.0)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.0)
+      stringio
+    racc (1.7.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.0.7)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  songtradr_api_client_ruby!
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -0,0 +1,223 @@
+# songtradr_api_client_ruby
+
+SongtradrApiClientRuby - the Ruby gem for the 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.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.12.21
+- Package version: 1.12.21
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://songtradr.com](https://songtradr.com)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build songtradr_api_client_ruby.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./songtradr_api_client_ruby-1.12.21.gem
+```
+
+(for development, run `gem install --dev ./songtradr_api_client_ruby-1.12.21.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'songtradr_api_client_ruby', '~> 1.12.21'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'songtradr_api_client_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'songtradr_api_client_ruby'
+
+api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
+opts = {
+  response_size: 's' # String | Size the response should have.
+}
+
+begin
+  #Allowed values for music descriptive parameters to be used in the searchAll endpoint.
+  result = api_instance.allowed_musical_features(opts)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Exception when calling AllowedValuesApi->allowed_musical_features: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.songtradr.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SongtradrApiClientRuby::AllowedValuesApi* | [**allowed_musical_features**](docs/AllowedValuesApi.md#allowed_musical_features) | **GET** /api/v1/allowedValues/musicalFeatures | Allowed values for music descriptive parameters to be used in the searchAll endpoint.
+*SongtradrApiClientRuby::AllowedValuesApi* | [**genres**](docs/AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres.
+*SongtradrApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
+*SongtradrApiClientRuby::PartyApi* | [**party**](docs/PartyApi.md#party) | **GET** /api/v1/party | Information on a person, group or company.
+*SongtradrApiClientRuby::PlaylistApi* | [**all_playlists**](docs/PlaylistApi.md#all_playlists) | **GET** /api/v1/playlist | All playlists.
+*SongtradrApiClientRuby::PlaylistApi* | [**create_or_update_playlist**](docs/PlaylistApi.md#create_or_update_playlist) | **POST** /api/v1/playlist | Create and edit playlist.
+*SongtradrApiClientRuby::PlaylistApi* | [**delete_playlist**](docs/PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_musical_features**](docs/RecordingApi.md#recordings_by_ids_with_musical_features) | **GET** /api/v1/public/recording/{ids}/musicalFeatures | AI generated moods, musical features and more for recordings.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_similarities**](docs/RecordingApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_taggrams**](docs/RecordingApi.md#recordings_by_ids_with_taggrams) | **GET** /api/v1/public/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_by_ids_with_tagstrengths**](docs/RecordingApi.md#recordings_by_ids_with_tagstrengths) | **GET** /api/v1/public/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_large_by_ids**](docs/RecordingApi.md#recordings_large_by_ids) | **GET** /api/v1/public/recording/l/{ids} | Recordings by IDs with a large response.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_medium_by_ids**](docs/RecordingApi.md#recordings_medium_by_ids) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response.
+*SongtradrApiClientRuby::RecordingApi* | [**recordings_small_by_ids**](docs/RecordingApi.md#recordings_small_by_ids) | **GET** /api/v1/public/recording/s/{ids} | Recordings by IDs with a small response.
+*SongtradrApiClientRuby::RecordingApi* | [**search_recordings**](docs/RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more.
+*SongtradrApiClientRuby::RecordingApi* | [**search_recordings_granular**](docs/RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options.
+*SongtradrApiClientRuby::RecordingApi* | [**search_recordings_granular_abstraction**](docs/RecordingApi.md#search_recordings_granular_abstraction) | **POST** /api/v1/public/recording/searchGranularAbstraction | Recordings by abstracted wordings and granular search options.
+*SongtradrApiClientRuby::UserApi* | [**create_user_referrer**](docs/UserApi.md#create_user_referrer) | **POST** /api/v1/user/referrers/new | 
+*SongtradrApiClientRuby::UserApi* | [**delete_user_file**](docs/UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file.
+*SongtradrApiClientRuby::UserApi* | [**edit_me**](docs/UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user
+*SongtradrApiClientRuby::UserApi* | [**forgot_password**](docs/UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email
+*SongtradrApiClientRuby::UserApi* | [**initiate_user_file_upload**](docs/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.
+*SongtradrApiClientRuby::UserApi* | [**login**](docs/UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token.
+*SongtradrApiClientRuby::UserApi* | [**me**](docs/UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user
+*SongtradrApiClientRuby::UserApi* | [**recordings_by_folder_with_taggrams**](docs/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.
+*SongtradrApiClientRuby::UserApi* | [**recordings_by_folder_with_tagstrengths**](docs/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.
+*SongtradrApiClientRuby::UserApi* | [**save_playlist**](docs/UserApi.md#save_playlist) | **POST** /api/v1/user/savePlaylist | List, search and create playlist of your own files.
+*SongtradrApiClientRuby::UserApi* | [**sign_up**](docs/UserApi.md#sign_up) | **POST** /api/v1/user/sign-up | Sign up a new user.
+*SongtradrApiClientRuby::UserApi* | [**token**](docs/UserApi.md#token) | **POST** /api/v1/user/token | Generates a new JWT token for the given refresh token
+*SongtradrApiClientRuby::UserApi* | [**update_password**](docs/UserApi.md#update_password) | **POST** /api/v1/user/update-password | Update password by using the password reset token
+*SongtradrApiClientRuby::UserApi* | [**update_user_file_recording**](docs/UserApi.md#update_user_file_recording) | **POST** /api/v1/user/file/{objectKey} | Create and edit metadata of your files.
+*SongtradrApiClientRuby::UserApi* | [**user_file**](docs/UserApi.md#user_file) | **GET** /api/v1/user/file/{objectKey} | Details and a download link for a file.
+*SongtradrApiClientRuby::UserApi* | [**user_files**](docs/UserApi.md#user_files) | **GET** /api/v1/user/files | List and search your own files.
+*SongtradrApiClientRuby::UserApi* | [**user_files_download**](docs/UserApi.md#user_files_download) | **GET** /api/v1/user/filesDownload | Download links for your files
+*SongtradrApiClientRuby::UserApi* | [**user_files_status**](docs/UserApi.md#user_files_status) | **GET** /api/v1/user/filesStatus | Status details for files.
+*SongtradrApiClientRuby::UserApi* | [**user_files_summary**](docs/UserApi.md#user_files_summary) | **GET** /api/v1/user/filesSummary | Summary fo your files.
+*SongtradrApiClientRuby::UserApi* | [**user_folders**](docs/UserApi.md#user_folders) | **GET** /api/v1/user/folders | Your Folders
+*SongtradrApiClientRuby::UserApi* | [**user_referrers**](docs/UserApi.md#user_referrers) | **GET** /api/v1/user/referrers/{username} | 
+
+
+## Documentation for Models
+
+ - [SongtradrApiClientRuby::CategoryMediumDTO](docs/CategoryMediumDTO.md)
+ - [SongtradrApiClientRuby::CategoryMinimalDTO](docs/CategoryMinimalDTO.md)
+ - [SongtradrApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
+ - [SongtradrApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
+ - [SongtradrApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
+ - [SongtradrApiClientRuby::ErrorResponse](docs/ErrorResponse.md)
+ - [SongtradrApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
+ - [SongtradrApiClientRuby::FileDTO](docs/FileDTO.md)
+ - [SongtradrApiClientRuby::FileListDTO](docs/FileListDTO.md)
+ - [SongtradrApiClientRuby::FileMinimalWithUrlDTO](docs/FileMinimalWithUrlDTO.md)
+ - [SongtradrApiClientRuby::FileSmallDTO](docs/FileSmallDTO.md)
+ - [SongtradrApiClientRuby::FileUploadDTO](docs/FileUploadDTO.md)
+ - [SongtradrApiClientRuby::FileWIthUrlDTO](docs/FileWIthUrlDTO.md)
+ - [SongtradrApiClientRuby::FilesSummaryDTO](docs/FilesSummaryDTO.md)
+ - [SongtradrApiClientRuby::ForgotPasswordDTO](docs/ForgotPasswordDTO.md)
+ - [SongtradrApiClientRuby::GenreDTO](docs/GenreDTO.md)
+ - [SongtradrApiClientRuby::GenreMinimalDTO](docs/GenreMinimalDTO.md)
+ - [SongtradrApiClientRuby::GenresSummaryDTO](docs/GenresSummaryDTO.md)
+ - [SongtradrApiClientRuby::InitPutRecordingAudioDTO](docs/InitPutRecordingAudioDTO.md)
+ - [SongtradrApiClientRuby::JwtTokenDTO](docs/JwtTokenDTO.md)
+ - [SongtradrApiClientRuby::LoginDTO](docs/LoginDTO.md)
+ - [SongtradrApiClientRuby::MusicalFeaturesDTO](docs/MusicalFeaturesDTO.md)
+ - [SongtradrApiClientRuby::PLineDTO](docs/PLineDTO.md)
+ - [SongtradrApiClientRuby::PartyLargeDTO](docs/PartyLargeDTO.md)
+ - [SongtradrApiClientRuby::PartySmallDTO](docs/PartySmallDTO.md)
+ - [SongtradrApiClientRuby::PlaylistLargeDTO](docs/PlaylistLargeDTO.md)
+ - [SongtradrApiClientRuby::ProductMediumDTO](docs/ProductMediumDTO.md)
+ - [SongtradrApiClientRuby::ProductPartyDTO](docs/ProductPartyDTO.md)
+ - [SongtradrApiClientRuby::RecordingForSimilaritySearchDTO](docs/RecordingForSimilaritySearchDTO.md)
+ - [SongtradrApiClientRuby::RecordingGenrePredictionDTO](docs/RecordingGenrePredictionDTO.md)
+ - [SongtradrApiClientRuby::RecordingLargeDTO](docs/RecordingLargeDTO.md)
+ - [SongtradrApiClientRuby::RecordingListDTO](docs/RecordingListDTO.md)
+ - [SongtradrApiClientRuby::RecordingMediumDTO](docs/RecordingMediumDTO.md)
+ - [SongtradrApiClientRuby::RecordingMinimalWithMusicalFeaturesDTO](docs/RecordingMinimalWithMusicalFeaturesDTO.md)
+ - [SongtradrApiClientRuby::RecordingMinimalWithTaggramsDTO](docs/RecordingMinimalWithTaggramsDTO.md)
+ - [SongtradrApiClientRuby::RecordingMinimalWithTagstrengthsDTO](docs/RecordingMinimalWithTagstrengthsDTO.md)
+ - [SongtradrApiClientRuby::RecordingPartyDTO](docs/RecordingPartyDTO.md)
+ - [SongtradrApiClientRuby::RecordingPlaylistDTO](docs/RecordingPlaylistDTO.md)
+ - [SongtradrApiClientRuby::RecordingSmallDTO](docs/RecordingSmallDTO.md)
+ - [SongtradrApiClientRuby::RecordingTagSmallDTO](docs/RecordingTagSmallDTO.md)
+ - [SongtradrApiClientRuby::SaveFileRecordingDTO](docs/SaveFileRecordingDTO.md)
+ - [SongtradrApiClientRuby::SavePlaylistDTO](docs/SavePlaylistDTO.md)
+ - [SongtradrApiClientRuby::SaveRecordingGenreDTO](docs/SaveRecordingGenreDTO.md)
+ - [SongtradrApiClientRuby::SaveRecordingPartyDTO](docs/SaveRecordingPartyDTO.md)
+ - [SongtradrApiClientRuby::SaveRecordingPlaylistDTO](docs/SaveRecordingPlaylistDTO.md)
+ - [SongtradrApiClientRuby::SaveRecordingTagDTO](docs/SaveRecordingTagDTO.md)
+ - [SongtradrApiClientRuby::SaveReferrerDTO](docs/SaveReferrerDTO.md)
+ - [SongtradrApiClientRuby::SaveTaggramsDTO](docs/SaveTaggramsDTO.md)
+ - [SongtradrApiClientRuby::SaveUserDTO](docs/SaveUserDTO.md)
+ - [SongtradrApiClientRuby::SearchFilterValuesDTO](docs/SearchFilterValuesDTO.md)
+ - [SongtradrApiClientRuby::SearchRecordingGranularAbstractionDTO](docs/SearchRecordingGranularAbstractionDTO.md)
+ - [SongtradrApiClientRuby::SearchRecordingGranularDTO](docs/SearchRecordingGranularDTO.md)
+ - [SongtradrApiClientRuby::SignUpDTO](docs/SignUpDTO.md)
+ - [SongtradrApiClientRuby::TagDTO](docs/TagDTO.md)
+ - [SongtradrApiClientRuby::TagSmallDTO](docs/TagSmallDTO.md)
+ - [SongtradrApiClientRuby::TaggramDTO](docs/TaggramDTO.md)
+ - [SongtradrApiClientRuby::TagsSummaryDTO](docs/TagsSummaryDTO.md)
+ - [SongtradrApiClientRuby::TagstrengthDTO](docs/TagstrengthDTO.md)
+ - [SongtradrApiClientRuby::TitleDTO](docs/TitleDTO.md)
+ - [SongtradrApiClientRuby::TokenRequest](docs/TokenRequest.md)
+ - [SongtradrApiClientRuby::TrackToMediumProductDTO](docs/TrackToMediumProductDTO.md)
+ - [SongtradrApiClientRuby::UpdatePasswordDTO](docs/UpdatePasswordDTO.md)
+ - [SongtradrApiClientRuby::UsageDTO](docs/UsageDTO.md)
+ - [SongtradrApiClientRuby::UserDTO](docs/UserDTO.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearer-jwt
+
+- **Type**: Bearer authentication (JWT)
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AllowedValuesApi.md

@@ -0,0 +1,200 @@
+# SongtradrApiClientRuby::AllowedValuesApi
+
+All URIs are relative to *https://api.songtradr.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**allowed_musical_features**](AllowedValuesApi.md#allowed_musical_features) | **GET** /api/v1/allowedValues/musicalFeatures | Allowed values for music descriptive parameters to be used in the searchAll endpoint. |
+| [**genres**](AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres. |
+| [**tags**](AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories. |
+
+
+## allowed_musical_features
+
+> <SearchFilterValuesDTO> allowed_musical_features(opts)
+
+Allowed values for music descriptive parameters to be used in the searchAll endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'songtradr_api_client_ruby'
+
+api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
+opts = {
+  response_size: 's' # String | Size the response should have.
+}
+
+begin
+  # Allowed values for music descriptive parameters to be used in the searchAll endpoint.
+  result = api_instance.allowed_musical_features(opts)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AllowedValuesApi->allowed_musical_features: #{e}"
+end
+```
+
+#### Using the allowed_musical_features_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchFilterValuesDTO>, Integer, Hash)> allowed_musical_features_with_http_info(opts)
+
+```ruby
+begin
+  # Allowed values for music descriptive parameters to be used in the searchAll endpoint.
+  data, status_code, headers = api_instance.allowed_musical_features_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchFilterValuesDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AllowedValuesApi->allowed_musical_features_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response_size** | **String** | Size the response should have. | [optional][default to &#39;s&#39;] |
+
+### Return type
+
+[**SearchFilterValuesDTO**](SearchFilterValuesDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## genres
+
+> <Array<GenreDTO>> genres(genre_type)
+
+Allowed values for genres.
+
+### Examples
+
+```ruby
+require 'time'
+require 'songtradr_api_client_ruby'
+
+api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
+genre_type = 'level1Genre' # String | Type of the response should have.
+
+begin
+  # Allowed values for genres.
+  result = api_instance.genres(genre_type)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AllowedValuesApi->genres: #{e}"
+end
+```
+
+#### Using the genres_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GenreDTO>>, Integer, Hash)> genres_with_http_info(genre_type)
+
+```ruby
+begin
+  # Allowed values for genres.
+  data, status_code, headers = api_instance.genres_with_http_info(genre_type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GenreDTO>>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AllowedValuesApi->genres_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **genre_type** | **String** | Type of the response should have. |  |
+
+### Return type
+
+[**Array&lt;GenreDTO&gt;**](GenreDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tags
+
+> <Array<CategoryMediumDTO>> tags(opts)
+
+All descriptive tags inside of tag-categories.
+
+### Examples
+
+```ruby
+require 'time'
+require 'songtradr_api_client_ruby'
+
+api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
+opts = {
+  category_name: 'mood' # String | Filters tags for one category only 
+}
+
+begin
+  # All descriptive tags inside of tag-categories.
+  result = api_instance.tags(opts)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AllowedValuesApi->tags: #{e}"
+end
+```
+
+#### Using the tags_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CategoryMediumDTO>>, Integer, Hash)> tags_with_http_info(opts)
+
+```ruby
+begin
+  # All descriptive tags inside of tag-categories.
+  data, status_code, headers = api_instance.tags_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CategoryMediumDTO>>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AllowedValuesApi->tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_name** | **String** | Filters tags for one category only  | [optional] |
+
+### Return type
+
+[**Array&lt;CategoryMediumDTO&gt;**](CategoryMediumDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CategoryMediumDTO.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::CategoryMediumDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **tags** | [**Array<TagSmallDTO>**](TagSmallDTO.md) |  | [optional] |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::CategoryMediumDTO.new(
+  id: null,
+  tags: null,
+  name: null
+)
+```
+

data/docs/CategoryMinimalDTO.md

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

data/docs/ConfigAccessDTO.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::ConfigAccessDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accessor_id** | **String** | ID of the accessing entity |  |
+| **rights** | **String** | access rights to a resource |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ConfigAccessDTO.new(
+  accessor_id: null,
+  rights: null
+)
+```
+

data/docs/ConfigIdentifierDTO.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::ConfigIdentifierDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier_type** | **String** |  |  |
+| **identifier_value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ConfigIdentifierDTO.new(
+  identifier_type: null,
+  identifier_value: null
+)
+```
+

data/docs/ContributorTypeDTO.md

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

data/docs/ErrorResponse.md

@@ -0,0 +1,26 @@
+# SongtradrApiClientRuby::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Time** | timestamp |  |
+| **status** | **Integer** | HTTP Status code |  |
+| **error** | **String** | HTTP status message |  |
+| **message** | **String** | detailed error message | [optional] |
+| **path** | **String** | path of the called API endpoint | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ErrorResponse.new(
+  timestamp: null,
+  status: null,
+  error: null,
+  message: null,
+  path: null
+)
+```
+