songtradr_api_client_ruby 1.17.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (131) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +24 -22
  3. data/README.md +7 -11
  4. data/docs/FileSmallDTO.md +2 -2
  5. data/docs/MusicalFeaturesDTO.md +113 -109
  6. data/docs/RecordingApi.md +71 -69
  7. data/docs/RecordingMediumDTO.md +2 -2
  8. data/docs/SearchFilterValuesDTO.md +2 -0
  9. data/docs/UserApi.md +67 -187
  10. data/docs/UserDTO.md +2 -0
  11. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
  12. data/lib/songtradr_api_client_ruby/api/recording_api.rb +74 -71
  13. data/lib/songtradr_api_client_ruby/api/user_api.rb +86 -403
  14. data/lib/songtradr_api_client_ruby/api_client.rb +5 -4
  15. data/lib/songtradr_api_client_ruby/api_error.rb +2 -2
  16. data/lib/songtradr_api_client_ruby/configuration.rb +2 -2
  17. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
  18. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
  19. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
  20. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
  21. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
  22. data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
  23. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
  24. data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
  25. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
  26. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +14 -14
  27. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
  28. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
  29. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
  30. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
  31. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
  32. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
  33. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
  34. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +2 -2
  35. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
  36. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
  37. data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
  38. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +662 -631
  39. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
  40. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
  41. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +2 -2
  42. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
  43. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +24 -24
  44. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +2 -2
  45. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
  46. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
  47. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +2 -2
  48. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +2 -2
  49. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
  50. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
  51. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +21 -3
  52. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
  53. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
  54. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
  55. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
  56. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
  57. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
  58. data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
  59. data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
  60. data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
  61. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
  62. data/lib/songtradr_api_client_ruby/models/user_dto.rb +19 -3
  63. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +2 -2
  64. data/lib/songtradr_api_client_ruby/version.rb +3 -3
  65. data/lib/songtradr_api_client_ruby.rb +2 -6
  66. data/openapi-generator-config.yaml +1 -1
  67. data/songtradr_api_client_ruby.gemspec +3 -2
  68. data/spec/api/allowed_values_api_spec.rb +2 -2
  69. data/spec/api/recording_api_spec.rb +14 -13
  70. data/spec/api/user_api_spec.rb +15 -74
  71. data/spec/models/category_medium_dto_spec.rb +2 -2
  72. data/spec/models/category_minimal_dto_spec.rb +2 -2
  73. data/spec/models/config_access_dto_spec.rb +2 -2
  74. data/spec/models/config_identifier_dto_spec.rb +2 -2
  75. data/spec/models/contributor_type_dto_spec.rb +2 -2
  76. data/spec/models/error_response_spec.rb +2 -2
  77. data/spec/models/field_summary_dto_spec.rb +2 -2
  78. data/spec/models/file_dto_spec.rb +2 -2
  79. data/spec/models/file_list_dto_spec.rb +2 -2
  80. data/spec/models/file_small_dto_spec.rb +10 -10
  81. data/spec/models/file_upload_dto_spec.rb +2 -2
  82. data/spec/models/file_w_ith_url_dto_spec.rb +2 -2
  83. data/spec/models/files_summary_dto_spec.rb +2 -2
  84. data/spec/models/forgot_password_dto_spec.rb +2 -2
  85. data/spec/models/genre_dto_spec.rb +2 -2
  86. data/spec/models/genre_minimal_dto_spec.rb +2 -2
  87. data/spec/models/genres_summary_dto_spec.rb +2 -2
  88. data/spec/models/image_recognition_response_spec.rb +2 -2
  89. data/spec/models/init_put_recording_audio_dto_spec.rb +2 -2
  90. data/spec/models/jwt_token_dto_spec.rb +2 -2
  91. data/spec/models/login_dto_spec.rb +2 -2
  92. data/spec/models/musical_features_dto_spec.rb +230 -214
  93. data/spec/models/party_small_dto_spec.rb +2 -2
  94. data/spec/models/recording_for_similarity_search_dto_spec.rb +2 -2
  95. data/spec/models/recording_genre_prediction_dto_spec.rb +2 -2
  96. data/spec/models/recording_list_dto_spec.rb +2 -2
  97. data/spec/models/recording_medium_dto_spec.rb +8 -8
  98. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +2 -2
  99. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +2 -2
  100. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +2 -2
  101. data/spec/models/recording_party_dto_spec.rb +2 -2
  102. data/spec/models/recording_small_dto_spec.rb +2 -2
  103. data/spec/models/recording_tag_small_dto_spec.rb +2 -2
  104. data/spec/models/save_user_dto_spec.rb +2 -2
  105. data/spec/models/search_filter_values_dto_spec.rb +8 -2
  106. data/spec/models/sign_up_dto_spec.rb +2 -2
  107. data/spec/models/tag_dto_spec.rb +2 -2
  108. data/spec/models/tag_small_dto_spec.rb +2 -2
  109. data/spec/models/taggram_dto_spec.rb +2 -2
  110. data/spec/models/tags_summary_dto_spec.rb +2 -2
  111. data/spec/models/tagstrength_dto_spec.rb +2 -2
  112. data/spec/models/title_dto_spec.rb +2 -2
  113. data/spec/models/token_request_spec.rb +2 -2
  114. data/spec/models/track_dto_spec.rb +2 -2
  115. data/spec/models/update_password_dto_spec.rb +2 -2
  116. data/spec/models/user_dto_spec.rb +8 -2
  117. data/spec/models/video_recognition_response_spec.rb +2 -2
  118. data/spec/spec_helper.rb +2 -2
  119. metadata +55 -57
  120. data/docs/CuratePlaylistDTO.md +0 -26
  121. data/docs/CuratePlaylistResponseDTO.md +0 -18
  122. data/docs/PlaylistApi.md +0 -77
  123. data/docs/SearchRecordingGranularDTO.md +0 -20
  124. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +0 -99
  125. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +0 -256
  126. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +0 -216
  127. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +0 -232
  128. data/spec/api/playlist_api_spec.rb +0 -47
  129. data/spec/models/curate_playlist_dto_spec.rb +0 -60
  130. data/spec/models/curate_playlist_response_dto_spec.rb +0 -36
  131. data/spec/models/search_recording_granular_dto_spec.rb +0 -42
@@ -1,47 +0,0 @@
1
- =begin
2
- #Songtradr API
3
-
4
- #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.
5
-
6
- The version of the OpenAPI document: 1.17.0
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for SongtradrApiClientRuby::PlaylistApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'PlaylistApi' do
20
- before do
21
- # run before each test
22
- @api_instance = SongtradrApiClientRuby::PlaylistApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of PlaylistApi' do
30
- it 'should create an instance of PlaylistApi' do
31
- expect(@api_instance).to be_instance_of(SongtradrApiClientRuby::PlaylistApi)
32
- end
33
- end
34
-
35
- # unit tests for curate_playlist
36
- # Curate playlist.
37
- # @param method_name Name of the curation task that should be executed
38
- # @param curate_playlist_dto
39
- # @param [Hash] opts the optional parameters
40
- # @return [CuratePlaylistResponseDTO]
41
- describe 'curate_playlist test' do
42
- it 'should work' do
43
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
44
- end
45
- end
46
-
47
- end
@@ -1,60 +0,0 @@
1
- =begin
2
- #Songtradr API
3
-
4
- #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.
5
-
6
- The version of the OpenAPI document: 1.17.0
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for SongtradrApiClientRuby::CuratePlaylistDTO
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe SongtradrApiClientRuby::CuratePlaylistDTO do
21
- let(:instance) { SongtradrApiClientRuby::CuratePlaylistDTO.new }
22
-
23
- describe 'test an instance of CuratePlaylistDTO' do
24
- it 'should create an instance of CuratePlaylistDTO' do
25
- # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(SongtradrApiClientRuby::CuratePlaylistDTO)
27
- end
28
- end
29
-
30
- describe 'test attribute "request_data"' do
31
- it 'should work' do
32
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
- end
34
- end
35
-
36
- describe 'test attribute "usage_filter"' do
37
- it 'should work' do
38
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
- end
40
- end
41
-
42
- describe 'test attribute "numerical_filter"' do
43
- it 'should work' do
44
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
- end
46
- end
47
-
48
- describe 'test attribute "category_filter"' do
49
- it 'should work' do
50
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
- end
52
- end
53
-
54
- describe 'test attribute "first_id"' do
55
- it 'should work' do
56
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
- end
58
- end
59
-
60
- end
@@ -1,36 +0,0 @@
1
- =begin
2
- #Songtradr API
3
-
4
- #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.
5
-
6
- The version of the OpenAPI document: 1.17.0
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for SongtradrApiClientRuby::CuratePlaylistResponseDTO
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe SongtradrApiClientRuby::CuratePlaylistResponseDTO do
21
- let(:instance) { SongtradrApiClientRuby::CuratePlaylistResponseDTO.new }
22
-
23
- describe 'test an instance of CuratePlaylistResponseDTO' do
24
- it 'should create an instance of CuratePlaylistResponseDTO' do
25
- # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(SongtradrApiClientRuby::CuratePlaylistResponseDTO)
27
- end
28
- end
29
-
30
- describe 'test attribute "songtradr_track_ids"' do
31
- it 'should work' do
32
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
- end
34
- end
35
-
36
- end
@@ -1,42 +0,0 @@
1
- =begin
2
- #Songtradr API
3
-
4
- #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.
5
-
6
- The version of the OpenAPI document: 1.17.0
7
- Contact: info@songtradr.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.3.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for SongtradrApiClientRuby::SearchRecordingGranularDTO
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe SongtradrApiClientRuby::SearchRecordingGranularDTO do
21
- let(:instance) { SongtradrApiClientRuby::SearchRecordingGranularDTO.new }
22
-
23
- describe 'test an instance of SearchRecordingGranularDTO' do
24
- it 'should create an instance of SearchRecordingGranularDTO' do
25
- # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(SongtradrApiClientRuby::SearchRecordingGranularDTO)
27
- end
28
- end
29
-
30
- describe 'test attribute "strength"' do
31
- it 'should work' do
32
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
- end
34
- end
35
-
36
- describe 'test attribute "tag_name"' do
37
- it 'should work' do
38
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
- end
40
- end
41
-
42
- end