songtradr_api_client_ruby 1.12.22 → 1.12.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +4 -4
  3. data/README.md +26 -12
  4. data/docs/APIKeysApi.md +217 -0
  5. data/docs/AdminApiUserDTO.md +70 -0
  6. data/docs/ApiKeyDTO.md +24 -0
  7. data/docs/CreateApiKeyDTO.md +18 -0
  8. data/docs/FileSmallDTO.md +3 -3
  9. data/docs/MusicalFeaturesDTO.md +32 -32
  10. data/docs/PlaylistLargeDTO.md +7 -7
  11. data/docs/ProductMediumDTO.md +7 -7
  12. data/docs/ProductPartyDTO.md +3 -3
  13. data/docs/RecordingGenrePredictionDTO.md +3 -3
  14. data/docs/RecordingLargeDTO.md +8 -8
  15. data/docs/RecordingMediumDTO.md +6 -6
  16. data/docs/RecordingPartyDTO.md +3 -3
  17. data/docs/RecordingPlaylistDTO.md +3 -3
  18. data/docs/UserDTO.md +2 -0
  19. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
  20. data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +213 -0
  21. data/lib/songtradr_api_client_ruby/api/party_api.rb +1 -1
  22. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -1
  23. data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -1
  24. data/lib/songtradr_api_client_ruby/api/user_api.rb +1 -1
  25. data/lib/songtradr_api_client_ruby/api_client.rb +1 -1
  26. data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
  27. data/lib/songtradr_api_client_ruby/configuration.rb +1 -1
  28. data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +453 -0
  29. data/lib/songtradr_api_client_ruby/models/api_key_dto.rb +261 -0
  30. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +1 -1
  31. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +1 -1
  32. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +1 -1
  33. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +1 -1
  34. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +1 -1
  35. data/lib/songtradr_api_client_ruby/models/create_api_key_dto.rb +219 -0
  36. data/lib/songtradr_api_client_ruby/models/error_response.rb +1 -1
  37. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +1 -1
  38. data/lib/songtradr_api_client_ruby/models/file_dto.rb +1 -1
  39. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +1 -1
  40. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +1 -1
  41. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +19 -19
  42. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +1 -1
  43. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +1 -1
  44. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +1 -1
  45. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +1 -1
  46. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +1 -1
  47. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +1 -1
  48. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +1 -1
  49. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +1 -1
  50. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +1 -1
  51. data/lib/songtradr_api_client_ruby/models/login_dto.rb +1 -1
  52. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +300 -300
  53. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +1 -1
  54. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +1 -1
  55. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +1 -1
  56. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +34 -34
  57. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +42 -42
  58. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +14 -14
  59. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +1 -1
  60. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +19 -19
  61. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +40 -40
  62. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +1 -1
  63. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +20 -20
  64. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +1 -1
  65. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +1 -1
  66. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +1 -1
  67. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +14 -14
  68. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +14 -14
  69. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +1 -1
  70. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +1 -1
  71. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +1 -1
  72. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +1 -1
  73. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +1 -1
  74. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +1 -1
  75. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +1 -1
  76. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +1 -1
  77. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +1 -1
  78. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +1 -1
  79. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +1 -1
  80. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +1 -1
  81. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +1 -1
  82. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +1 -1
  83. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +1 -1
  84. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +1 -1
  85. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +1 -1
  86. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +1 -1
  87. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +1 -1
  88. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +1 -1
  89. data/lib/songtradr_api_client_ruby/models/title_dto.rb +1 -1
  90. data/lib/songtradr_api_client_ruby/models/token_request.rb +1 -1
  91. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +1 -1
  92. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +1 -1
  93. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +1 -1
  94. data/lib/songtradr_api_client_ruby/models/user_dto.rb +16 -2
  95. data/lib/songtradr_api_client_ruby/version.rb +2 -2
  96. data/lib/songtradr_api_client_ruby.rb +5 -1
  97. data/openapi-generator-config.yaml +1 -1
  98. data/songtradr_api_client_ruby.gemspec +1 -1
  99. data/spec/api/allowed_values_api_spec.rb +1 -1
  100. data/spec/api/api_keys_api_spec.rb +70 -0
  101. data/spec/api/party_api_spec.rb +1 -1
  102. data/spec/api/playlist_api_spec.rb +1 -1
  103. data/spec/api/recording_api_spec.rb +1 -1
  104. data/spec/api/user_api_spec.rb +1 -1
  105. data/spec/api_client_spec.rb +1 -1
  106. data/spec/configuration_spec.rb +1 -1
  107. data/spec/models/admin_api_user_dto_spec.rb +190 -0
  108. data/spec/models/api_key_dto_spec.rb +52 -0
  109. data/spec/models/category_medium_dto_spec.rb +1 -1
  110. data/spec/models/category_minimal_dto_spec.rb +1 -1
  111. data/spec/models/config_access_dto_spec.rb +1 -1
  112. data/spec/models/config_identifier_dto_spec.rb +1 -1
  113. data/spec/models/contributor_type_dto_spec.rb +1 -1
  114. data/spec/models/create_api_key_dto_spec.rb +34 -0
  115. data/spec/models/error_response_spec.rb +1 -1
  116. data/spec/models/field_summary_dto_spec.rb +1 -1
  117. data/spec/models/file_dto_spec.rb +1 -1
  118. data/spec/models/file_list_dto_spec.rb +1 -1
  119. data/spec/models/file_minimal_with_url_dto_spec.rb +1 -1
  120. data/spec/models/file_small_dto_spec.rb +7 -7
  121. data/spec/models/file_upload_dto_spec.rb +1 -1
  122. data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
  123. data/spec/models/files_summary_dto_spec.rb +1 -1
  124. data/spec/models/forgot_password_dto_spec.rb +1 -1
  125. data/spec/models/genre_dto_spec.rb +1 -1
  126. data/spec/models/genre_minimal_dto_spec.rb +1 -1
  127. data/spec/models/genres_summary_dto_spec.rb +1 -1
  128. data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
  129. data/spec/models/jwt_token_dto_spec.rb +1 -1
  130. data/spec/models/login_dto_spec.rb +1 -1
  131. data/spec/models/musical_features_dto_spec.rb +121 -121
  132. data/spec/models/p_line_dto_spec.rb +1 -1
  133. data/spec/models/party_large_dto_spec.rb +1 -1
  134. data/spec/models/party_small_dto_spec.rb +1 -1
  135. data/spec/models/playlist_large_dto_spec.rb +9 -9
  136. data/spec/models/product_medium_dto_spec.rb +9 -9
  137. data/spec/models/product_party_dto_spec.rb +3 -3
  138. data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
  139. data/spec/models/recording_genre_prediction_dto_spec.rb +4 -4
  140. data/spec/models/recording_large_dto_spec.rb +11 -11
  141. data/spec/models/recording_list_dto_spec.rb +1 -1
  142. data/spec/models/recording_medium_dto_spec.rb +4 -4
  143. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +1 -1
  144. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
  145. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
  146. data/spec/models/recording_party_dto_spec.rb +3 -3
  147. data/spec/models/recording_playlist_dto_spec.rb +4 -4
  148. data/spec/models/recording_small_dto_spec.rb +1 -1
  149. data/spec/models/recording_tag_small_dto_spec.rb +1 -1
  150. data/spec/models/save_file_recording_dto_spec.rb +1 -1
  151. data/spec/models/save_playlist_dto_spec.rb +1 -1
  152. data/spec/models/save_recording_genre_dto_spec.rb +1 -1
  153. data/spec/models/save_recording_party_dto_spec.rb +1 -1
  154. data/spec/models/save_recording_playlist_dto_spec.rb +1 -1
  155. data/spec/models/save_recording_tag_dto_spec.rb +1 -1
  156. data/spec/models/save_referrer_dto_spec.rb +1 -1
  157. data/spec/models/save_taggrams_dto_spec.rb +1 -1
  158. data/spec/models/save_user_dto_spec.rb +1 -1
  159. data/spec/models/search_filter_values_dto_spec.rb +1 -1
  160. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +1 -1
  161. data/spec/models/search_recording_granular_dto_spec.rb +1 -1
  162. data/spec/models/sign_up_dto_spec.rb +1 -1
  163. data/spec/models/tag_dto_spec.rb +1 -1
  164. data/spec/models/tag_small_dto_spec.rb +1 -1
  165. data/spec/models/taggram_dto_spec.rb +1 -1
  166. data/spec/models/tags_summary_dto_spec.rb +1 -1
  167. data/spec/models/tagstrength_dto_spec.rb +1 -1
  168. data/spec/models/title_dto_spec.rb +1 -1
  169. data/spec/models/token_request_spec.rb +1 -1
  170. data/spec/models/track_to_medium_product_dto_spec.rb +1 -1
  171. data/spec/models/update_password_dto_spec.rb +1 -1
  172. data/spec/models/usage_dto_spec.rb +1 -1
  173. data/spec/models/user_dto_spec.rb +7 -1
  174. data/spec/spec_helper.rb +1 -1
  175. metadata +72 -56
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9496e7db7452484fd349e9c0b8801a55995babe6369d12f5f9c0759cb7724ea8
4
- data.tar.gz: c76963a03ad269009cdb5b6a3e43be94427afb208187430030ac9c8106b196de
3
+ metadata.gz: 0b3eef1b585b08a2daa6d292166e9deb6ab0f8c3a7dd09b55fecaf3640d45e69
4
+ data.tar.gz: 3f2e12ab63e11df2c32b1a9e63406b0dca11f71053754ab1fe27aec87437ae8e
5
5
  SHA512:
6
- metadata.gz: c6f8b98686bf5eaa89ba0dec350271d2384c3f88af348283a09df72976c4f698e5570d72fc31c00a05eed54188be3d795028a1d290e44682137f08a7550dca71
7
- data.tar.gz: bbae3628a9c165262cdcd31e90b53ddc37484da4cab4d9038151468ec5081154d4f17189964d7a4e259f85fb91f169aa0ed307f7a70a870b76c64820bf791a39
6
+ metadata.gz: d4b89dde32fa3f3de84583a478f435b019b24a0ca4c5b4a34ae1301f5fd3c7537743bfc30a4c1970950d1a8d4abf865235c4b2718693d21baec3871b8fd69a9a
7
+ data.tar.gz: d8c3f4a2ff20a29091e7afdbf1fd5dca796461f38ecd31795d5ee0006047f39b4fe1399aebff75166783fa558074e2972949176e131c543b02e70657e6f291d0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- songtradr_api_client_ruby (1.12.22)
4
+ songtradr_api_client_ruby (1.12.23)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
7
 
@@ -12,7 +12,7 @@ GEM
12
12
  byebug (11.1.3)
13
13
  coderay (1.1.3)
14
14
  diff-lcs (1.5.0)
15
- faraday (2.7.6)
15
+ faraday (2.7.10)
16
16
  faraday-net_http (>= 2.0, < 3.1)
17
17
  ruby2_keywords (>= 0.0.4)
18
18
  faraday-multipart (1.0.4)
@@ -45,10 +45,10 @@ GEM
45
45
  rspec-expectations (3.12.3)
46
46
  diff-lcs (>= 1.2.0, < 2.0)
47
47
  rspec-support (~> 3.12.0)
48
- rspec-mocks (3.12.5)
48
+ rspec-mocks (3.12.6)
49
49
  diff-lcs (>= 1.2.0, < 2.0)
50
50
  rspec-support (~> 3.12.0)
51
- rspec-support (3.12.0)
51
+ rspec-support (3.12.1)
52
52
  rubocop (0.66.0)
53
53
  jaro_winkler (~> 1.5.1)
54
54
  parallel (~> 1.10)
data/README.md CHANGED
@@ -33,8 +33,8 @@ You can either search the released music via the /public/recording endpoints or
33
33
 
34
34
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
35
35
 
36
- - API version: 1.12.22
37
- - Package version: 1.12.22
36
+ - API version: 1.12.23
37
+ - Package version: 1.12.23
38
38
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
39
39
  For more information, please visit [https://songtradr.com](https://songtradr.com)
40
40
 
@@ -51,16 +51,16 @@ gem build songtradr_api_client_ruby.gemspec
51
51
  Then either install the gem locally:
52
52
 
53
53
  ```shell
54
- gem install ./songtradr_api_client_ruby-1.12.22.gem
54
+ gem install ./songtradr_api_client_ruby-1.12.23.gem
55
55
  ```
56
56
 
57
- (for development, run `gem install --dev ./songtradr_api_client_ruby-1.12.22.gem` to install the development dependencies)
57
+ (for development, run `gem install --dev ./songtradr_api_client_ruby-1.12.23.gem` to install the development dependencies)
58
58
 
59
59
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
60
60
 
61
61
  Finally add this to the Gemfile:
62
62
 
63
- gem 'songtradr_api_client_ruby', '~> 1.12.22'
63
+ gem 'songtradr_api_client_ruby', '~> 1.12.23'
64
64
 
65
65
  ### Install from Git
66
66
 
@@ -84,17 +84,25 @@ Please follow the [installation](#installation) procedure and then run the follo
84
84
  # Load the gem
85
85
  require 'songtradr_api_client_ruby'
86
86
 
87
- api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
88
- opts = {
89
- response_size: 's' # String | Size the response should have.
90
- }
87
+ # Setup authorization
88
+ SongtradrApiClientRuby.configure do |config|
89
+ # Configure Bearer authorization (JWT): bearer-jwt
90
+ config.access_token = 'YOUR_BEARER_TOKEN'
91
+ # Configure a proc to get access tokens in lieu of the static access_token configuration
92
+ config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
93
+ # Configure faraday connection
94
+ config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
95
+ end
96
+
97
+ api_instance = SongtradrApiClientRuby::APIKeysApi.new
98
+ create_api_key_dto = SongtradrApiClientRuby::CreateApiKeyDTO.new # CreateApiKeyDTO |
91
99
 
92
100
  begin
93
- #Allowed values for music descriptive parameters to be used in the searchAll endpoint.
94
- result = api_instance.allowed_musical_features(opts)
101
+ #create an API key
102
+ result = api_instance.create_api_key(create_api_key_dto)
95
103
  p result
96
104
  rescue SongtradrApiClientRuby::ApiError => e
97
- puts "Exception when calling AllowedValuesApi->allowed_musical_features: #{e}"
105
+ puts "Exception when calling APIKeysApi->create_api_key: #{e}"
98
106
  end
99
107
 
100
108
  ```
@@ -105,6 +113,9 @@ All URIs are relative to *https://api.songtradr.com*
105
113
 
106
114
  Class | Method | HTTP request | Description
107
115
  ------------ | ------------- | ------------- | -------------
116
+ *SongtradrApiClientRuby::APIKeysApi* | [**create_api_key**](docs/APIKeysApi.md#create_api_key) | **POST** /api/v1/user/apiKeys | create an API key
117
+ *SongtradrApiClientRuby::APIKeysApi* | [**delete_api_key**](docs/APIKeysApi.md#delete_api_key) | **DELETE** /api/v1/user/apiKeys/{id} | delete an API key
118
+ *SongtradrApiClientRuby::APIKeysApi* | [**get_api_keys**](docs/APIKeysApi.md#get_api_keys) | **GET** /api/v1/user/apiKeys | list API keys
108
119
  *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.
109
120
  *SongtradrApiClientRuby::AllowedValuesApi* | [**genres**](docs/AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres.
110
121
  *SongtradrApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
@@ -147,11 +158,14 @@ Class | Method | HTTP request | Description
147
158
 
148
159
  ## Documentation for Models
149
160
 
161
+ - [SongtradrApiClientRuby::AdminApiUserDTO](docs/AdminApiUserDTO.md)
162
+ - [SongtradrApiClientRuby::ApiKeyDTO](docs/ApiKeyDTO.md)
150
163
  - [SongtradrApiClientRuby::CategoryMediumDTO](docs/CategoryMediumDTO.md)
151
164
  - [SongtradrApiClientRuby::CategoryMinimalDTO](docs/CategoryMinimalDTO.md)
152
165
  - [SongtradrApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
153
166
  - [SongtradrApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
154
167
  - [SongtradrApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
168
+ - [SongtradrApiClientRuby::CreateApiKeyDTO](docs/CreateApiKeyDTO.md)
155
169
  - [SongtradrApiClientRuby::ErrorResponse](docs/ErrorResponse.md)
156
170
  - [SongtradrApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
157
171
  - [SongtradrApiClientRuby::FileDTO](docs/FileDTO.md)
@@ -0,0 +1,217 @@
1
+ # SongtradrApiClientRuby::APIKeysApi
2
+
3
+ All URIs are relative to *https://api.songtradr.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api/v1/user/apiKeys | create an API key |
8
+ | [**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api/v1/user/apiKeys/{id} | delete an API key |
9
+ | [**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api/v1/user/apiKeys | list API keys |
10
+
11
+
12
+ ## create_api_key
13
+
14
+ > <AdminApiUserDTO> create_api_key(create_api_key_dto)
15
+
16
+ create an API key
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'songtradr_api_client_ruby'
23
+ # setup authorization
24
+ SongtradrApiClientRuby.configure do |config|
25
+ # Configure Bearer authorization (JWT): bearer-jwt
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
27
+ end
28
+
29
+ api_instance = SongtradrApiClientRuby::APIKeysApi.new
30
+ create_api_key_dto = SongtradrApiClientRuby::CreateApiKeyDTO.new # CreateApiKeyDTO |
31
+
32
+ begin
33
+ # create an API key
34
+ result = api_instance.create_api_key(create_api_key_dto)
35
+ p result
36
+ rescue SongtradrApiClientRuby::ApiError => e
37
+ puts "Error when calling APIKeysApi->create_api_key: #{e}"
38
+ end
39
+ ```
40
+
41
+ #### Using the create_api_key_with_http_info variant
42
+
43
+ This returns an Array which contains the response data, status code and headers.
44
+
45
+ > <Array(<AdminApiUserDTO>, Integer, Hash)> create_api_key_with_http_info(create_api_key_dto)
46
+
47
+ ```ruby
48
+ begin
49
+ # create an API key
50
+ data, status_code, headers = api_instance.create_api_key_with_http_info(create_api_key_dto)
51
+ p status_code # => 2xx
52
+ p headers # => { ... }
53
+ p data # => <AdminApiUserDTO>
54
+ rescue SongtradrApiClientRuby::ApiError => e
55
+ puts "Error when calling APIKeysApi->create_api_key_with_http_info: #{e}"
56
+ end
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ | Name | Type | Description | Notes |
62
+ | ---- | ---- | ----------- | ----- |
63
+ | **create_api_key_dto** | [**CreateApiKeyDTO**](CreateApiKeyDTO.md) | | |
64
+
65
+ ### Return type
66
+
67
+ [**AdminApiUserDTO**](AdminApiUserDTO.md)
68
+
69
+ ### Authorization
70
+
71
+ [bearer-jwt](../README.md#bearer-jwt)
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: application/json
76
+ - **Accept**: application/json
77
+
78
+
79
+ ## delete_api_key
80
+
81
+ > Object delete_api_key(id)
82
+
83
+ delete an API key
84
+
85
+ ### Examples
86
+
87
+ ```ruby
88
+ require 'time'
89
+ require 'songtradr_api_client_ruby'
90
+ # setup authorization
91
+ SongtradrApiClientRuby.configure do |config|
92
+ # Configure Bearer authorization (JWT): bearer-jwt
93
+ config.access_token = 'YOUR_BEARER_TOKEN'
94
+ end
95
+
96
+ api_instance = SongtradrApiClientRuby::APIKeysApi.new
97
+ id = 'id_example' # String |
98
+
99
+ begin
100
+ # delete an API key
101
+ result = api_instance.delete_api_key(id)
102
+ p result
103
+ rescue SongtradrApiClientRuby::ApiError => e
104
+ puts "Error when calling APIKeysApi->delete_api_key: #{e}"
105
+ end
106
+ ```
107
+
108
+ #### Using the delete_api_key_with_http_info variant
109
+
110
+ This returns an Array which contains the response data, status code and headers.
111
+
112
+ > <Array(Object, Integer, Hash)> delete_api_key_with_http_info(id)
113
+
114
+ ```ruby
115
+ begin
116
+ # delete an API key
117
+ data, status_code, headers = api_instance.delete_api_key_with_http_info(id)
118
+ p status_code # => 2xx
119
+ p headers # => { ... }
120
+ p data # => Object
121
+ rescue SongtradrApiClientRuby::ApiError => e
122
+ puts "Error when calling APIKeysApi->delete_api_key_with_http_info: #{e}"
123
+ end
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ | Name | Type | Description | Notes |
129
+ | ---- | ---- | ----------- | ----- |
130
+ | **id** | **String** | | |
131
+
132
+ ### Return type
133
+
134
+ **Object**
135
+
136
+ ### Authorization
137
+
138
+ [bearer-jwt](../README.md#bearer-jwt)
139
+
140
+ ### HTTP request headers
141
+
142
+ - **Content-Type**: Not defined
143
+ - **Accept**: application/json
144
+
145
+
146
+ ## get_api_keys
147
+
148
+ > <Array<ApiKeyDTO>> get_api_keys(opts)
149
+
150
+ list API keys
151
+
152
+ ### Examples
153
+
154
+ ```ruby
155
+ require 'time'
156
+ require 'songtradr_api_client_ruby'
157
+ # setup authorization
158
+ SongtradrApiClientRuby.configure do |config|
159
+ # Configure Bearer authorization (JWT): bearer-jwt
160
+ config.access_token = 'YOUR_BEARER_TOKEN'
161
+ end
162
+
163
+ api_instance = SongtradrApiClientRuby::APIKeysApi.new
164
+ opts = {
165
+ page: 56, # Integer | Zero-based page index (0..N)
166
+ size: 56, # Integer | The size of the page to be returned
167
+ sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
168
+ }
169
+
170
+ begin
171
+ # list API keys
172
+ result = api_instance.get_api_keys(opts)
173
+ p result
174
+ rescue SongtradrApiClientRuby::ApiError => e
175
+ puts "Error when calling APIKeysApi->get_api_keys: #{e}"
176
+ end
177
+ ```
178
+
179
+ #### Using the get_api_keys_with_http_info variant
180
+
181
+ This returns an Array which contains the response data, status code and headers.
182
+
183
+ > <Array(<Array<ApiKeyDTO>>, Integer, Hash)> get_api_keys_with_http_info(opts)
184
+
185
+ ```ruby
186
+ begin
187
+ # list API keys
188
+ data, status_code, headers = api_instance.get_api_keys_with_http_info(opts)
189
+ p status_code # => 2xx
190
+ p headers # => { ... }
191
+ p data # => <Array<ApiKeyDTO>>
192
+ rescue SongtradrApiClientRuby::ApiError => e
193
+ puts "Error when calling APIKeysApi->get_api_keys_with_http_info: #{e}"
194
+ end
195
+ ```
196
+
197
+ ### Parameters
198
+
199
+ | Name | Type | Description | Notes |
200
+ | ---- | ---- | ----------- | ----- |
201
+ | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
202
+ | **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
203
+ | **sort** | [**Array&lt;String&gt;**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
204
+
205
+ ### Return type
206
+
207
+ [**Array&lt;ApiKeyDTO&gt;**](ApiKeyDTO.md)
208
+
209
+ ### Authorization
210
+
211
+ [bearer-jwt](../README.md#bearer-jwt)
212
+
213
+ ### HTTP request headers
214
+
215
+ - **Content-Type**: Not defined
216
+ - **Accept**: application/json
217
+
@@ -0,0 +1,70 @@
1
+ # SongtradrApiClientRuby::AdminApiUserDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | | [optional] |
8
+ | **username** | **String** | | [optional] |
9
+ | **email** | **String** | | [optional] |
10
+ | **full_name** | **String** | | [optional] |
11
+ | **language** | **String** | | [optional] |
12
+ | **is_admin** | **Boolean** | | [optional] |
13
+ | **widgets_allowed** | **Boolean** | | [optional] |
14
+ | **full_search_allowed** | **Boolean** | | [optional] |
15
+ | **voice_search_allowed** | **Boolean** | | [optional] |
16
+ | **recording_detail_allowed** | **Boolean** | | [optional] |
17
+ | **artist_detail_allowed** | **Boolean** | | [optional] |
18
+ | **playlist_prediction_allowed** | **Boolean** | | [optional] |
19
+ | **signup_allowed** | **Boolean** | | [optional] |
20
+ | **upload_allowed** | **Boolean** | | [optional] |
21
+ | **fingerprint_allowed** | **Boolean** | | [optional] |
22
+ | **audiotagging_allowed** | **Boolean** | | [optional] |
23
+ | **b2b_allowed** | **Boolean** | | [optional] |
24
+ | **editor_allowed** | **Boolean** | | [optional] |
25
+ | **reduced_musical_features** | **Boolean** | | [optional] |
26
+ | **confirmed** | **Boolean** | | [optional] |
27
+ | **gdpr_confirmation_timestamp** | **Time** | | [optional] |
28
+ | **last_login** | **Time** | | [optional] |
29
+ | **total_logins** | **Integer** | | [optional] |
30
+ | **total_searches** | **Integer** | | [optional] |
31
+ | **total_uploads** | **Integer** | | [optional] |
32
+ | **total_downloads** | **Integer** | | [optional] |
33
+ | **total_updates** | **Integer** | | [optional] |
34
+
35
+ ## Example
36
+
37
+ ```ruby
38
+ require 'songtradr_api_client_ruby'
39
+
40
+ instance = SongtradrApiClientRuby::AdminApiUserDTO.new(
41
+ id: null,
42
+ username: null,
43
+ email: null,
44
+ full_name: null,
45
+ language: null,
46
+ is_admin: null,
47
+ widgets_allowed: null,
48
+ full_search_allowed: null,
49
+ voice_search_allowed: null,
50
+ recording_detail_allowed: null,
51
+ artist_detail_allowed: null,
52
+ playlist_prediction_allowed: null,
53
+ signup_allowed: null,
54
+ upload_allowed: null,
55
+ fingerprint_allowed: null,
56
+ audiotagging_allowed: null,
57
+ b2b_allowed: null,
58
+ editor_allowed: null,
59
+ reduced_musical_features: null,
60
+ confirmed: null,
61
+ gdpr_confirmation_timestamp: null,
62
+ last_login: null,
63
+ total_logins: null,
64
+ total_searches: null,
65
+ total_uploads: null,
66
+ total_downloads: null,
67
+ total_updates: null
68
+ )
69
+ ```
70
+
data/docs/ApiKeyDTO.md ADDED
@@ -0,0 +1,24 @@
1
+ # SongtradrApiClientRuby::ApiKeyDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **created_at** | **Time** | | |
9
+ | **last_used_at** | **Time** | | [optional] |
10
+ | **id** | **String** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'songtradr_api_client_ruby'
16
+
17
+ instance = SongtradrApiClientRuby::ApiKeyDTO.new(
18
+ name: null,
19
+ created_at: null,
20
+ last_used_at: null,
21
+ id: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # SongtradrApiClientRuby::CreateApiKeyDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'songtradr_api_client_ruby'
13
+
14
+ instance = SongtradrApiClientRuby::CreateApiKeyDTO.new(
15
+ name: null
16
+ )
17
+ ```
18
+
data/docs/FileSmallDTO.md CHANGED
@@ -8,7 +8,6 @@
8
8
  | **id** | **Integer** | | |
9
9
  | **extension** | **String** | extension of the file | |
10
10
  | **error_message** | **String** | | [optional] |
11
- | **folder** | **String** | | |
12
11
  | **object_key** | **String** | | |
13
12
  | **upload_start_time** | **Time** | | [optional] |
14
13
  | **upload_end_time** | **Time** | | [optional] |
@@ -19,6 +18,7 @@
19
18
  | **inference_start_time** | **Time** | | [optional] |
20
19
  | **inference_end_time** | **Time** | | [optional] |
21
20
  | **error_time** | **Time** | | [optional] |
21
+ | **folder** | **String** | | |
22
22
 
23
23
  ## Example
24
24
 
@@ -30,7 +30,6 @@ instance = SongtradrApiClientRuby::FileSmallDTO.new(
30
30
  id: null,
31
31
  extension: null,
32
32
  error_message: null,
33
- folder: null,
34
33
  object_key: null,
35
34
  upload_start_time: null,
36
35
  upload_end_time: null,
@@ -40,7 +39,8 @@ instance = SongtradrApiClientRuby::FileSmallDTO.new(
40
39
  inference_status: null,
41
40
  inference_start_time: null,
42
41
  inference_end_time: null,
43
- error_time: null
42
+ error_time: null,
43
+ folder: null
44
44
  )
45
45
  ```
46
46
 
@@ -5,15 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **space** | **String** | Search for space | [optional] |
8
- | **arousal** | **String** | Search for an arousal | [optional] |
9
- | **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
10
- | **energy** | **String** | Search for energy | [optional] |
11
- | **engagement** | **String** | Search for an engagement | [optional] |
12
- | **groovyness** | **String** | Search for groovyness | [optional] |
13
- | **harmony** | **String** | Search for a degree of harmoniousness | [optional] |
14
- | **pleasantness** | **String** | Search for pleasantness | [optional] |
15
- | **primary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
16
- | **primary_sound_character** | **String** | Search for a sound character | [optional] |
8
+ | **language_of_performance** | **String** | | [optional] |
17
9
  | **rhythm** | **String** | Search for rhythm | [optional] |
18
10
  | **roughness** | **String** | Search for roughness | [optional] |
19
11
  | **scale** | **String** | Search for a tonal scale | [optional] |
@@ -25,7 +17,12 @@
25
17
  | **valence** | **String** | Search for a valence | [optional] |
26
18
  | **vocals** | **String** | Search for a vocal gender or instrumental songs | [optional] |
27
19
  | **origin_decade** | **String** | Search for origin decade | [optional] |
28
- | **language_of_performance** | **String** | | [optional] |
20
+ | **curateability** | **String** | Search for curatebility | [optional] |
21
+ | **use_case** | **String** | Search for use case | [optional] |
22
+ | **channel_suitability** | **String** | Search for social media suitability | [optional] |
23
+ | **tertiary_instrument_affinity** | **Float** | | [optional] |
24
+ | **sound_generation_affinity** | **Float** | | [optional] |
25
+ | **rhythm_affinity** | **Float** | | [optional] |
29
26
  | **primary_sound_character_affinity** | **Float** | | [optional] |
30
27
  | **tonality_affinity** | **Float** | | [optional] |
31
28
  | **bpm** | **Float** | | [optional] |
@@ -54,12 +51,18 @@
54
51
  | **language_of_performance_affinity** | **Float** | | [optional] |
55
52
  | **curateability_affinity** | **Float** | | [optional] |
56
53
  | **use_case_affinity** | **Float** | | [optional] |
54
+ | **arousal** | **String** | Search for an arousal | [optional] |
55
+ | **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
56
+ | **energy** | **String** | Search for energy | [optional] |
57
+ | **engagement** | **String** | Search for an engagement | [optional] |
58
+ | **groovyness** | **String** | Search for groovyness | [optional] |
59
+ | **harmony** | **String** | Search for a degree of harmoniousness | [optional] |
60
+ | **pleasantness** | **String** | Search for pleasantness | [optional] |
61
+ | **primary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
62
+ | **primary_sound_character** | **String** | Search for a sound character | [optional] |
57
63
  | **industry_suitability** | **String** | Search for Industry suitability | [optional] |
58
64
  | **industry_suitability_affinity** | **Float** | | [optional] |
59
65
  | **audience_region** | **String** | | [optional] |
60
- | **curateability** | **String** | Search for curatebility | [optional] |
61
- | **use_case** | **String** | Search for use case | [optional] |
62
- | **channel_suitability** | **String** | Search for social media suitability | [optional] |
63
66
  | **primary_mood_cluster_affinity** | **Float** | | [optional] |
64
67
  | **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
65
68
  | **secondary_mood_cluster_affinity** | **Float** | | [optional] |
@@ -70,9 +73,6 @@
70
73
  | **secondary_instrument** | **String** | Search for a dominant instrument | [optional] |
71
74
  | **secondary_instrument_affinity** | **Float** | | [optional] |
72
75
  | **tertiary_instrument** | **String** | Search for a dominant instrument | [optional] |
73
- | **tertiary_instrument_affinity** | **Float** | | [optional] |
74
- | **sound_generation_affinity** | **Float** | | [optional] |
75
- | **rhythm_affinity** | **Float** | | [optional] |
76
76
  | **valence_affinity** | **Float** | | [optional] |
77
77
  | **arousal_affinity** | **Float** | | [optional] |
78
78
  | **pleasantness_affinity** | **Float** | | [optional] |
@@ -97,15 +97,7 @@ require 'songtradr_api_client_ruby'
97
97
 
98
98
  instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
99
99
  space: null,
100
- arousal: null,
101
- dominant_instrument: null,
102
- energy: null,
103
- engagement: null,
104
- groovyness: null,
105
- harmony: null,
106
- pleasantness: null,
107
- primary_mood_cluster: null,
108
- primary_sound_character: null,
100
+ language_of_performance: null,
109
101
  rhythm: null,
110
102
  roughness: null,
111
103
  scale: null,
@@ -117,7 +109,12 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
117
109
  valence: null,
118
110
  vocals: null,
119
111
  origin_decade: null,
120
- language_of_performance: null,
112
+ curateability: null,
113
+ use_case: null,
114
+ channel_suitability: null,
115
+ tertiary_instrument_affinity: null,
116
+ sound_generation_affinity: null,
117
+ rhythm_affinity: null,
121
118
  primary_sound_character_affinity: null,
122
119
  tonality_affinity: null,
123
120
  bpm: null,
@@ -146,12 +143,18 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
146
143
  language_of_performance_affinity: null,
147
144
  curateability_affinity: null,
148
145
  use_case_affinity: null,
146
+ arousal: null,
147
+ dominant_instrument: null,
148
+ energy: null,
149
+ engagement: null,
150
+ groovyness: null,
151
+ harmony: null,
152
+ pleasantness: null,
153
+ primary_mood_cluster: null,
154
+ primary_sound_character: null,
149
155
  industry_suitability: null,
150
156
  industry_suitability_affinity: null,
151
157
  audience_region: null,
152
- curateability: null,
153
- use_case: null,
154
- channel_suitability: null,
155
158
  primary_mood_cluster_affinity: null,
156
159
  secondary_mood_cluster: null,
157
160
  secondary_mood_cluster_affinity: null,
@@ -162,9 +165,6 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
162
165
  secondary_instrument: null,
163
166
  secondary_instrument_affinity: null,
164
167
  tertiary_instrument: null,
165
- tertiary_instrument_affinity: null,
166
- sound_generation_affinity: null,
167
- rhythm_affinity: null,
168
168
  valence_affinity: null,
169
169
  arousal_affinity: null,
170
170
  pleasantness_affinity: null,
@@ -6,15 +6,15 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | | |
8
8
  | **state** | **String** | | [optional] |
9
- | **description** | **String** | | [optional] |
10
- | **usages** | [**Array&lt;UsageDTO&gt;**](UsageDTO.md) | | [optional] |
11
9
  | **created** | **Time** | | [optional] |
12
10
  | **updated** | **Time** | | [optional] |
11
+ | **description** | **String** | | [optional] |
12
+ | **usages** | [**Array&lt;UsageDTO&gt;**](UsageDTO.md) | | [optional] |
13
13
  | **songtradr_playlist_guid** | **String** | | [optional] |
14
- | **tracks** | [**Array&lt;RecordingPlaylistDTO&gt;**](RecordingPlaylistDTO.md) | | [optional] |
15
14
  | **asset_url** | **String** | | [optional] |
16
15
  | **pretzel_tier** | **String** | | [optional] |
17
16
  | **usage** | **String** | | [optional] |
17
+ | **tracks** | [**Array&lt;RecordingPlaylistDTO&gt;**](RecordingPlaylistDTO.md) | | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -24,15 +24,15 @@ require 'songtradr_api_client_ruby'
24
24
  instance = SongtradrApiClientRuby::PlaylistLargeDTO.new(
25
25
  name: null,
26
26
  state: null,
27
- description: null,
28
- usages: null,
29
27
  created: null,
30
28
  updated: null,
29
+ description: null,
30
+ usages: null,
31
31
  songtradr_playlist_guid: null,
32
- tracks: null,
33
32
  asset_url: null,
34
33
  pretzel_tier: null,
35
- usage: null
34
+ usage: null,
35
+ tracks: null
36
36
  )
37
37
  ```
38
38