songtradr_api_client_ruby 1.12.21

data/spec/api/user_api_spec.rb

@@ -0,0 +1,507 @@
+=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::UserApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UserApi' do
+  before do
+    # run before each test
+    @api_instance = SongtradrApiClientRuby::UserApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserApi' do
+    it 'should create an instance of UserApi' do
+      expect(@api_instance).to be_instance_of(SongtradrApiClientRuby::UserApi)
+    end
+  end
+
+  # unit tests for create_user_referrer
+  # @param save_referrer_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'create_user_referrer 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_user_file
+  # Delete file.
+  # @param object_key ObjectKey of the file that should be deleted.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_user_file 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 edit_me
+  # Edit details for a logged-in user
+  # @param save_user_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'edit_me 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 forgot_password
+  # Send a password reset email
+  # @param forgot_password_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'forgot_password 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 initiate_user_file_upload
+  # Initialize a file upload. Responds with an URL where the file can be uploaded.
+  # @param name The Name of the file that will be uploaded
+  # @param folder The Name of the folder that the file will be placed in
+  # @param [Hash] opts the optional parameters
+  # @option opts [FileUploadDTO] :file_upload_dto 
+  # @return [InitPutRecordingAudioDTO]
+  describe 'initiate_user_file_upload 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 login
+  # Login to generate a bearer token.
+  # @param login_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [JwtTokenDTO]
+  describe 'login 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 me
+  # Details for a logged-in user
+  # @param [Hash] opts the optional parameters
+  # @return [UserDTO]
+  describe 'me 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_folder_with_taggrams
+  # Timeseries of AI generated moods, musical features and more for recordings in your folder.
+  # @param folder_name Folder name
+  # @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.
+  # @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<RecordingMinimalWithTaggramsDTO>]
+  describe 'recordings_by_folder_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_folder_with_tagstrengths
+  # Strengths as numerical representations for AI generated moods, musical features and more for recordings in your folder.
+  # @param folder_name Folder name
+  # @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 [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<RecordingMinimalWithTagstrengthsDTO>]
+  describe 'recordings_by_folder_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 save_playlist
+  # List, search and create playlist of your own files.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :isrc Search for a ISRC
+  # @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 [Array<String>] :genre_names 
+  # @option opts [Array<String>] :tag_names 
+  # @option opts [Time] :release_date 
+  # @option opts [String] :primary_mood_cluster 
+  # @option opts [String] :secondary_mood_cluster 
+  # @option opts [String] :tertiary_mood_cluster 
+  # @option opts [String] :valence 
+  # @option opts [String] :arousal 
+  # @option opts [String] :pleasantness 
+  # @option opts [String] :engagement 
+  # @option opts [String] :vocals 
+  # @option opts [String] :dominant_instrument 
+  # @option opts [String] :secondary_instrument 
+  # @option opts [String] :tertiary_instrument 
+  # @option opts [String] :energy 
+  # @option opts [String] :sound_generation 
+  # @option opts [String] :tempo 
+  # @option opts [String] :scale 
+  # @option opts [String] :rhythm 
+  # @option opts [String] :primary_sound_character 
+  # @option opts [String] :timbre 
+  # @option opts [String] :roughness 
+  # @option opts [String] :tonality 
+  # @option opts [String] :harmony 
+  # @option opts [String] :texture 
+  # @option opts [String] :groovyness 
+  # @option opts [String] :space 
+  # @option opts [String] :production_rating 
+  # @option opts [String] :performance_rating 
+  # @option opts [String] :song_rating 
+  # @option opts [String] :audience_age 
+  # @option opts [String] :audience_region 
+  # @option opts [String] :audience_gender 
+  # @option opts [String] :origin_decade 
+  # @option opts [String] :curateability 
+  # @option opts [String] :use_case 
+  # @option opts [String] :channel_suitability 
+  # @option opts [String] :similar_to_recording 
+  # @option opts [String] :create_playlist_with_name 
+  # @option opts [String] :songtradr_track_id 
+  # @option opts [String] :usage_name 
+  # @option opts [Integer] :bpm_min Search for a minimal bpm.
+  # @option opts [Integer] :bpm_max Search for a maximal bpm.
+  # @option opts [String] :name Search for a file name.
+  # @option opts [String] :folder Search for a folder.
+  # @option opts [String] :extension Search for a file extension.
+  # @option opts [Time] :upload_end_time 
+  # @option opts [Time] :min_upload_end_time 
+  # @option opts [Time] :max_upload_end_time 
+  # @option opts [String] :fingerprint_status Search for a fingerprint status.
+  # @option opts [String] :inference_status Search for a inference status.
+  # @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 [FileListDTO]
+  describe 'save_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 sign_up
+  # Sign up a new user.
+  # @param save_user_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [SignUpDTO]
+  describe 'sign_up 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 token
+  # Generates a new JWT token for the given refresh token
+  # @param token_request 
+  # @param [Hash] opts the optional parameters
+  # @return [JwtTokenDTO]
+  describe 'token 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 update_password
+  # Update password by using the password reset token
+  # @param update_password_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'update_password 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 update_user_file_recording
+  # Create and edit metadata of your files.
+  # @param object_key ObjectKey of the file that should be edited.
+  # @param save_file_recording_dto 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'update_user_file_recording 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 user_file
+  # Details and a download link for a file.
+  # @param object_key ObjectKey of the file that should be edited.
+  # @param [Hash] opts the optional parameters
+  # @return [FileWIthUrlDTO]
+  describe 'user_file 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 user_files
+  # List and search your own files.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :isrc Search for a ISRC
+  # @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 [Array<String>] :genre_names 
+  # @option opts [Array<String>] :tag_names 
+  # @option opts [Time] :release_date 
+  # @option opts [String] :primary_mood_cluster 
+  # @option opts [String] :secondary_mood_cluster 
+  # @option opts [String] :tertiary_mood_cluster 
+  # @option opts [String] :valence 
+  # @option opts [String] :arousal 
+  # @option opts [String] :pleasantness 
+  # @option opts [String] :engagement 
+  # @option opts [String] :vocals 
+  # @option opts [String] :dominant_instrument 
+  # @option opts [String] :secondary_instrument 
+  # @option opts [String] :tertiary_instrument 
+  # @option opts [String] :energy 
+  # @option opts [String] :sound_generation 
+  # @option opts [String] :tempo 
+  # @option opts [String] :scale 
+  # @option opts [String] :rhythm 
+  # @option opts [String] :primary_sound_character 
+  # @option opts [String] :timbre 
+  # @option opts [String] :roughness 
+  # @option opts [String] :tonality 
+  # @option opts [String] :harmony 
+  # @option opts [String] :texture 
+  # @option opts [String] :groovyness 
+  # @option opts [String] :space 
+  # @option opts [String] :production_rating 
+  # @option opts [String] :performance_rating 
+  # @option opts [String] :song_rating 
+  # @option opts [String] :audience_age 
+  # @option opts [String] :audience_region 
+  # @option opts [String] :audience_gender 
+  # @option opts [String] :origin_decade 
+  # @option opts [String] :curateability 
+  # @option opts [String] :use_case 
+  # @option opts [String] :channel_suitability 
+  # @option opts [String] :similar_to_recording 
+  # @option opts [String] :songtradr_track_id 
+  # @option opts [String] :usage_name 
+  # @option opts [Integer] :bpm_min Search for a minimal bpm.
+  # @option opts [Integer] :bpm_max Search for a maximal bpm.
+  # @option opts [String] :name Search for a file name.
+  # @option opts [String] :folder Search for a folder.
+  # @option opts [String] :extension Search for a file extension.
+  # @option opts [Time] :upload_end_time 
+  # @option opts [Time] :min_upload_end_time 
+  # @option opts [Time] :max_upload_end_time 
+  # @option opts [String] :fingerprint_status Search for a fingerprint status.
+  # @option opts [String] :inference_status Search for a inference status.
+  # @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 [FileListDTO]
+  describe 'user_files 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 user_files_download
+  # Download links for your files
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :isrc 
+  # @option opts [String] :contributor 
+  # @option opts [String] :main_artist 
+  # @option opts [String] :composer 
+  # @option opts [String] :title 
+  # @option opts [String] :language 
+  # @option opts [Array<String>] :genre_names 
+  # @option opts [Array<String>] :tag_names 
+  # @option opts [Time] :release_date 
+  # @option opts [String] :primary_mood_cluster 
+  # @option opts [String] :secondary_mood_cluster 
+  # @option opts [String] :tertiary_mood_cluster 
+  # @option opts [String] :valence 
+  # @option opts [String] :arousal 
+  # @option opts [String] :pleasantness 
+  # @option opts [String] :engagement 
+  # @option opts [String] :vocals 
+  # @option opts [String] :dominant_instrument 
+  # @option opts [String] :secondary_instrument 
+  # @option opts [String] :tertiary_instrument 
+  # @option opts [String] :energy 
+  # @option opts [String] :sound_generation 
+  # @option opts [String] :tempo 
+  # @option opts [String] :scale 
+  # @option opts [String] :rhythm 
+  # @option opts [String] :primary_sound_character 
+  # @option opts [String] :timbre 
+  # @option opts [String] :roughness 
+  # @option opts [String] :tonality 
+  # @option opts [String] :harmony 
+  # @option opts [String] :texture 
+  # @option opts [String] :groovyness 
+  # @option opts [String] :space 
+  # @option opts [String] :production_rating 
+  # @option opts [String] :performance_rating 
+  # @option opts [String] :song_rating 
+  # @option opts [String] :audience_age 
+  # @option opts [String] :audience_region 
+  # @option opts [String] :audience_gender 
+  # @option opts [String] :songtradr_track_id 
+  # @option opts [String] :usage_name 
+  # @option opts [Integer] :bpm_min 
+  # @option opts [Integer] :bpm_max 
+  # @option opts [String] :name 
+  # @option opts [String] :folder 
+  # @option opts [String] :extension 
+  # @option opts [Time] :upload_end_time 
+  # @option opts [Time] :min_upload_end_time 
+  # @option opts [Time] :max_upload_end_time 
+  # @option opts [String] :fingerprint_status 
+  # @option opts [String] :inference_status 
+  # @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<FileMinimalWithUrlDTO>]
+  describe 'user_files_download 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 user_files_status
+  # Status details for files.
+  # @param object_keys Comma-separated  list of objectKeys of the files.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<FileSmallDTO>]
+  describe 'user_files_status 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 user_files_summary
+  # Summary fo your files.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :isrc Search for a ISRC
+  # @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 [Array<String>] :genre_names 
+  # @option opts [Array<String>] :tag_names 
+  # @option opts [Time] :release_date 
+  # @option opts [String] :primary_mood_cluster 
+  # @option opts [String] :secondary_mood_cluster 
+  # @option opts [String] :tertiary_mood_cluster 
+  # @option opts [String] :valence 
+  # @option opts [String] :arousal 
+  # @option opts [String] :pleasantness 
+  # @option opts [String] :engagement 
+  # @option opts [String] :vocals 
+  # @option opts [String] :dominant_instrument 
+  # @option opts [String] :secondary_instrument 
+  # @option opts [String] :tertiary_instrument 
+  # @option opts [String] :energy 
+  # @option opts [String] :sound_generation 
+  # @option opts [String] :tempo 
+  # @option opts [String] :scale 
+  # @option opts [String] :rhythm 
+  # @option opts [String] :primary_sound_character 
+  # @option opts [String] :timbre 
+  # @option opts [String] :roughness 
+  # @option opts [String] :tonality 
+  # @option opts [String] :harmony 
+  # @option opts [String] :texture 
+  # @option opts [String] :groovyness 
+  # @option opts [String] :space 
+  # @option opts [String] :production_rating 
+  # @option opts [String] :performance_rating 
+  # @option opts [String] :song_rating 
+  # @option opts [String] :audience_age 
+  # @option opts [String] :audience_region 
+  # @option opts [String] :audience_gender 
+  # @option opts [String] :origin_decade 
+  # @option opts [String] :curateability 
+  # @option opts [String] :use_case 
+  # @option opts [String] :channel_suitability 
+  # @option opts [String] :similar_to_recording 
+  # @option opts [String] :songtradr_track_id 
+  # @option opts [String] :usage_name 
+  # @option opts [Integer] :bpm_min Search for a minimal bpm.
+  # @option opts [Integer] :bpm_max Search for a maximal bpm.
+  # @option opts [String] :name Search for a file name.
+  # @option opts [String] :folder Search for a folder.
+  # @option opts [String] :extension Search for a file extension.
+  # @option opts [Time] :upload_end_time 
+  # @option opts [Time] :min_upload_end_time 
+  # @option opts [Time] :max_upload_end_time 
+  # @option opts [String] :fingerprint_status Search for a fingerprint status.
+  # @option opts [String] :inference_status Search for a inference status.
+  # @return [FilesSummaryDTO]
+  describe 'user_files_summary 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 user_folders
+  # Your Folders
+  # @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<String>]
+  describe 'user_folders 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 user_referrers
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<String>]
+  describe 'user_referrers test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end