songtradr_api_client_ruby 1.12.21

data/spec/api/allowed_values_api_spec.rb

@@ -0,0 +1,68 @@
+=begin
+#Songtradr API
+
+#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging.  You can also use the API to manage your account and musicube cloud data.  **Authentication**  1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up.  2. To authenticate, you need to login via the POST /api/v1/user/login endpoint.  3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token.  **Rate Limiting**  The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more.  **Getting Started with auto-tagging**  1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint.  **Getting Started with search**  You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints.  1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
+
+The version of the OpenAPI document: 1.12.21
+Contact: info@songtradr.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SongtradrApiClientRuby::AllowedValuesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AllowedValuesApi' do
+  before do
+    # run before each test
+    @api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AllowedValuesApi' do
+    it 'should create an instance of AllowedValuesApi' do
+      expect(@api_instance).to be_instance_of(SongtradrApiClientRuby::AllowedValuesApi)
+    end
+  end
+
+  # unit tests for allowed_musical_features
+  # Allowed values for music descriptive parameters to be used in the searchAll endpoint.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :response_size Size the response should have.
+  # @return [SearchFilterValuesDTO]
+  describe 'allowed_musical_features test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for genres
+  # Allowed values for genres.
+  # @param genre_type Type of the response should have.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<GenreDTO>]
+  describe 'genres test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tags
+  # All descriptive tags inside of tag-categories.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :category_name Filters tags for one category only 
+  # @return [Array<CategoryMediumDTO>]
+  describe 'tags test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/party_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Songtradr API
+
+#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging.  You can also use the API to manage your account and musicube cloud data.  **Authentication**  1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up.  2. To authenticate, you need to login via the POST /api/v1/user/login endpoint.  3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token.  **Rate Limiting**  The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more.  **Getting Started with auto-tagging**  1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint.  **Getting Started with search**  You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints.  1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
+
+The version of the OpenAPI document: 1.12.21
+Contact: info@songtradr.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SongtradrApiClientRuby::PartyApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PartyApi' do
+  before do
+    # run before each test
+    @api_instance = SongtradrApiClientRuby::PartyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PartyApi' do
+    it 'should create an instance of PartyApi' do
+      expect(@api_instance).to be_instance_of(SongtradrApiClientRuby::PartyApi)
+    end
+  end
+
+  # unit tests for party
+  # Information on a person, group or company.
+  # @param full_name Full Name of the person, group, company or organisation.
+  # @param [Hash] opts the optional parameters
+  # @return [PartyLargeDTO]
+  describe 'party test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/playlist_api_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#Songtradr API
+
+#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging.  You can also use the API to manage your account and musicube cloud data.  **Authentication**  1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up.  2. To authenticate, you need to login via the POST /api/v1/user/login endpoint.  3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token.  **Rate Limiting**  The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more.  **Getting Started with auto-tagging**  1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint.  **Getting Started with search**  You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints.  1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
+
+The version of the OpenAPI document: 1.12.21
+Contact: info@songtradr.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SongtradrApiClientRuby::PlaylistApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PlaylistApi' do
+  before do
+    # run before each test
+    @api_instance = SongtradrApiClientRuby::PlaylistApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PlaylistApi' do
+    it 'should create an instance of PlaylistApi' do
+      expect(@api_instance).to be_instance_of(SongtradrApiClientRuby::PlaylistApi)
+    end
+  end
+
+  # unit tests for all_playlists
+  # All playlists.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :include_recordings Whether a playlist shall include recordings or not.
+  # @option opts [Boolean] :ignore_usages Whether a playlist shall include all songs regardless of their track usages.
+  # @option opts [String] :usage_filter_mode Whether a playlist recordings shall include all playlist usages or not.
+  # @option opts [String] :songtradr_playlist_guid 
+  # @return [Array<PlaylistLargeDTO>]
+  describe 'all_playlists test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_or_update_playlist
+  # Create and edit playlist.
+  # This endpoint expects always the full amount of information including all recordings.
+  # @param save_playlist_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'create_or_update_playlist test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_playlist
+  # Delete playlist.
+  # @param songtradr_playlist_guid ID of the file that should be deleted.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_playlist test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/recording_api_spec.rb

@@ -0,0 +1,192 @@
+=begin
+#Songtradr API
+
+#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging.  You can also use the API to manage your account and musicube cloud data.  **Authentication**  1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up.  2. To authenticate, you need to login via the POST /api/v1/user/login endpoint.  3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token.  **Rate Limiting**  The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more.  **Getting Started with auto-tagging**  1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint.  **Getting Started with search**  You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints.  1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
+
+The version of the OpenAPI document: 1.12.21
+Contact: info@songtradr.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SongtradrApiClientRuby::RecordingApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RecordingApi' do
+  before do
+    # run before each test
+    @api_instance = SongtradrApiClientRuby::RecordingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecordingApi' do
+    it 'should create an instance of RecordingApi' do
+      expect(@api_instance).to be_instance_of(SongtradrApiClientRuby::RecordingApi)
+    end
+  end
+
+  # unit tests for recordings_by_ids_with_musical_features
+  # AI generated moods, musical features and more for recordings.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @return [Array<RecordingMinimalWithMusicalFeaturesDTO>]
+  describe 'recordings_by_ids_with_musical_features test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for recordings_by_ids_with_similarities
+  # Similar recordings for a list of recordings.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @return [Array<RecordingForSimilaritySearchDTO>]
+  describe 'recordings_by_ids_with_similarities test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for recordings_by_ids_with_taggrams
+  # Timeseries of AI generated moods, musical features and more for a list of recordings.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :category_name Show only taggrams for one category.
+  # @option opts [String] :tag_name Show only taggrams for one tag.
+  # @option opts [String] :genre_name Show only taggrams for one genre.
+  # @option opts [Float] :from_timestamp Show only taggrams data starting from from this timestamp in seconds.
+  # @option opts [Boolean] :fill_with_zero If set to true, empty timeseries are filled with timeseries of 0.0 values.
+  # @return [Array<RecordingMinimalWithTaggramsDTO>]
+  describe 'recordings_by_ids_with_taggrams test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for recordings_by_ids_with_tagstrengths
+  # Strengths as numerical representations for AI generated moods, musical features and more for recordings.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :category_name Show only taggrams for one category.
+  # @option opts [String] :tag_name Show only taggrams for one tag.
+  # @option opts [String] :genre_name Show only taggrams for one genre.
+  # @return [Array<RecordingMinimalWithTagstrengthsDTO>]
+  describe 'recordings_by_ids_with_tagstrengths test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for recordings_large_by_ids
+  # Recordings by IDs with a large response.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @return [Array<RecordingLargeDTO>]
+  describe 'recordings_large_by_ids test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for recordings_medium_by_ids
+  # Recordings by IDs with a medium sized response.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Zero-based page index (0..N)
+  # @option opts [Integer] :size The size of the page to be returned
+  # @option opts [Array<String>] :sort Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+  # @return [Array<RecordingMediumDTO>]
+  describe 'recordings_medium_by_ids test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for recordings_small_by_ids
+  # Recordings by IDs with a small response.
+  # @param ids Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+  # @param [Hash] opts the optional parameters
+  # @return [Array<RecordingSmallDTO>]
+  describe 'recordings_small_by_ids test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for search_recordings
+  # Recordings by contributors, moods, musical features and more.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :similar_to_recording Search for songs similar to a recording.
+  # @option opts [String] :contributor Search for a name that was involved as any contributor.
+  # @option opts [String] :main_artist Search for a main artist.
+  # @option opts [String] :composer Search for a composer.
+  # @option opts [String] :title Search for a title.
+  # @option opts [String] :language Search for a language of the lyrics.
+  # @option opts [String] :genre Search for a genre.
+  # @option opts [String] :primary_mood_cluster Search for a mood.
+  # @option opts [String] :valence Search for valence.
+  # @option opts [String] :arousal Search for arousal.
+  # @option opts [String] :pleasantness Search for pleasantness.
+  # @option opts [String] :engagement Search for an engagement.
+  # @option opts [String] :vocals Search for a vocals gender or instrumental songs.
+  # @option opts [String] :dominant_instrument Search for a dominant instrument.
+  # @option opts [String] :energy Search for energy.
+  # @option opts [String] :sound_generation Search for type of sound generation.
+  # @option opts [String] :tempo Search for tempo.
+  # @option opts [String] :scale Search for tonal scale.
+  # @option opts [String] :key Search for harmonic key.
+  # @option opts [String] :rhythm Search for rhythm.
+  # @option opts [String] :primary_sound_character Search for a sound character.
+  # @option opts [String] :timbre Search for timbre.
+  # @option opts [String] :roughness Search for roughness.
+  # @option opts [String] :tonality Search for tonality.
+  # @option opts [String] :harmony Search for a degree of harmoniousness.
+  # @option opts [String] :texture Search for texture.
+  # @option opts [String] :groovyness Search for groovyness.
+  # @option opts [String] :space Search for space.
+  # @option opts [String] :origin_decade Search for origin decade.
+  # @option opts [String] :curateability Search for curateability.
+  # @option opts [String] :use_case Search for use case.
+  # @option opts [String] :channel_suitability Search for channel suitability.
+  # @option opts [String] :songtradr_track_id Search for Songtradr track id.
+  # @option opts [String] :shuffled Sort the results randomly.
+  # @option opts [String] :sort Sort the results.
+  # @option opts [Integer] :page Zero-based page index (0..N)
+  # @option opts [Integer] :size The size of the page to be returned
+  # @return [RecordingListDTO]
+  describe 'search_recordings test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for search_recordings_granular
+  # Recordings by granular search options.
+  # @param search_recording_granular_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [RecordingListDTO]
+  describe 'search_recordings_granular test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for search_recordings_granular_abstraction
+  # Recordings by abstracted wordings and granular search options.
+  # @param search_recording_granular_abstraction_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [RecordingListDTO]
+  describe 'search_recordings_granular_abstraction test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end