songtradr_api_client_ruby 1.13.3 → 1.13.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (279) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +48 -5
  4. data/docs/AdminApiCreateUserDTO.md +76 -0
  5. data/docs/AdminApiUpdateUserDTO.md +76 -0
  6. data/docs/AdminUsersControllerApi.md +355 -0
  7. data/docs/AgeRange.md +20 -0
  8. data/docs/Beard.md +20 -0
  9. data/docs/BoundingBox.md +24 -0
  10. data/docs/ContextValue.md +18 -0
  11. data/docs/CuratePlaylistDTO.md +26 -0
  12. data/docs/CuratePlaylistResponseDTO.md +18 -0
  13. data/docs/DominantColor.md +30 -0
  14. data/docs/Emotion.md +20 -0
  15. data/docs/EyeDirection.md +22 -0
  16. data/docs/EyeOpen.md +20 -0
  17. data/docs/Eyeglasses.md +20 -0
  18. data/docs/FaceDetail.md +50 -0
  19. data/docs/FaceDetection.md +20 -0
  20. data/docs/FaceOccluded.md +20 -0
  21. data/docs/FileSmallDTO.md +5 -5
  22. data/docs/Gender.md +20 -0
  23. data/docs/ImageQuality.md +20 -0
  24. data/docs/ImageRecognitionResponse.md +20 -0
  25. data/docs/Instance.md +22 -0
  26. data/docs/InternalApiApi.md +149 -0
  27. data/docs/Label.md +28 -0
  28. data/docs/LabelAlias.md +18 -0
  29. data/docs/LabelCategory.md +18 -0
  30. data/docs/LabelDetection.md +26 -0
  31. data/docs/Landmark.md +22 -0
  32. data/docs/MouthOpen.md +20 -0
  33. data/docs/MusicalFeaturesDTO.md +38 -38
  34. data/docs/Mustache.md +20 -0
  35. data/docs/Parent.md +18 -0
  36. data/docs/PlaylistApi.md +70 -0
  37. data/docs/PlaylistLargeDTO.md +5 -5
  38. data/docs/Pose.md +22 -0
  39. data/docs/ProductMediumDTO.md +3 -3
  40. data/docs/RecordingGenrePredictionDTO.md +4 -4
  41. data/docs/RecordingLargeDTO.md +5 -5
  42. data/docs/RecordingMediumDTO.md +2 -2
  43. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
  44. data/docs/RecordingSmallDTO.md +3 -3
  45. data/docs/SaveFileDTO.md +42 -0
  46. data/docs/SaveFileRecordingDTO.md +5 -1
  47. data/docs/Smile.md +20 -0
  48. data/docs/Sunglasses.md +20 -0
  49. data/docs/UserApi.md +140 -0
  50. data/docs/VideoRecognitionResponse.md +20 -0
  51. data/lib/songtradr_api_client_ruby/api/admin_users_controller_api.rb +346 -0
  52. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +2 -2
  53. data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +2 -2
  54. data/lib/songtradr_api_client_ruby/api/internal_api_api.rb +169 -0
  55. data/lib/songtradr_api_client_ruby/api/party_api.rb +2 -2
  56. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +79 -2
  57. data/lib/songtradr_api_client_ruby/api/recording_api.rb +2 -2
  58. data/lib/songtradr_api_client_ruby/api/user_api.rb +138 -2
  59. data/lib/songtradr_api_client_ruby/api_client.rb +4 -3
  60. data/lib/songtradr_api_client_ruby/api_error.rb +2 -2
  61. data/lib/songtradr_api_client_ruby/configuration.rb +3 -2
  62. data/lib/songtradr_api_client_ruby/models/admin_api_create_user_dto.rb +489 -0
  63. data/lib/songtradr_api_client_ruby/models/admin_api_update_user_dto.rb +475 -0
  64. data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +2 -2
  65. data/lib/songtradr_api_client_ruby/models/age_range.rb +223 -0
  66. data/lib/songtradr_api_client_ruby/models/api_key_dto.rb +2 -2
  67. data/lib/songtradr_api_client_ruby/models/beard.rb +223 -0
  68. data/lib/songtradr_api_client_ruby/models/bounding_box.rb +241 -0
  69. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
  70. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
  71. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
  72. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
  73. data/lib/songtradr_api_client_ruby/models/context_value.rb +216 -0
  74. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
  75. data/lib/songtradr_api_client_ruby/models/create_api_key_dto.rb +2 -2
  76. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +256 -0
  77. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +216 -0
  78. data/lib/songtradr_api_client_ruby/models/dominant_color.rb +268 -0
  79. data/lib/songtradr_api_client_ruby/models/emotion.rb +223 -0
  80. data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
  81. data/lib/songtradr_api_client_ruby/models/eye_direction.rb +232 -0
  82. data/lib/songtradr_api_client_ruby/models/eye_open.rb +223 -0
  83. data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +223 -0
  84. data/lib/songtradr_api_client_ruby/models/face_detail.rb +362 -0
  85. data/lib/songtradr_api_client_ruby/models/face_detection.rb +223 -0
  86. data/lib/songtradr_api_client_ruby/models/face_occluded.rb +223 -0
  87. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
  88. data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
  89. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
  90. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +2 -2
  91. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +24 -24
  92. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
  93. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
  94. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
  95. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
  96. data/lib/songtradr_api_client_ruby/models/gender.rb +223 -0
  97. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
  98. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
  99. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
  100. data/lib/songtradr_api_client_ruby/models/image_quality.rb +223 -0
  101. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +227 -0
  102. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
  103. data/lib/songtradr_api_client_ruby/models/instance.rb +234 -0
  104. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
  105. data/lib/songtradr_api_client_ruby/models/label.rb +267 -0
  106. data/lib/songtradr_api_client_ruby/models/label_alias.rb +214 -0
  107. data/lib/songtradr_api_client_ruby/models/label_category.rb +214 -0
  108. data/lib/songtradr_api_client_ruby/models/label_detection.rb +250 -0
  109. data/lib/songtradr_api_client_ruby/models/landmark.rb +232 -0
  110. data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
  111. data/lib/songtradr_api_client_ruby/models/mouth_open.rb +223 -0
  112. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +285 -285
  113. data/lib/songtradr_api_client_ruby/models/mustache.rb +223 -0
  114. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +2 -2
  115. data/lib/songtradr_api_client_ruby/models/parent.rb +214 -0
  116. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +2 -2
  117. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
  118. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +24 -24
  119. data/lib/songtradr_api_client_ruby/models/pose.rb +232 -0
  120. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +15 -15
  121. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +2 -2
  122. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
  123. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +23 -23
  124. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +26 -26
  125. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
  126. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +14 -14
  127. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +17 -17
  128. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
  129. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
  130. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +2 -2
  131. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +2 -2
  132. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +17 -17
  133. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
  134. data/lib/songtradr_api_client_ruby/models/save_file_dto.rb +323 -0
  135. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +30 -12
  136. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +2 -2
  137. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +2 -2
  138. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +2 -2
  139. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +2 -2
  140. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +2 -2
  141. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +2 -2
  142. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +2 -2
  143. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
  144. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +2 -2
  145. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +2 -2
  146. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +2 -2
  147. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
  148. data/lib/songtradr_api_client_ruby/models/smile.rb +223 -0
  149. data/lib/songtradr_api_client_ruby/models/sunglasses.rb +223 -0
  150. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
  151. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
  152. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
  153. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
  154. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
  155. data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
  156. data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
  157. data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
  158. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +2 -2
  159. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
  160. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +2 -2
  161. data/lib/songtradr_api_client_ruby/models/user_dto.rb +2 -2
  162. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +227 -0
  163. data/lib/songtradr_api_client_ruby/version.rb +3 -3
  164. data/lib/songtradr_api_client_ruby.rb +37 -2
  165. data/openapi-generator-config.yaml +1 -1
  166. data/songtradr_api_client_ruby.gemspec +2 -2
  167. data/spec/api/admin_users_controller_api_spec.rb +93 -0
  168. data/spec/api/allowed_values_api_spec.rb +2 -2
  169. data/spec/api/api_keys_api_spec.rb +2 -2
  170. data/spec/api/internal_api_api_spec.rb +58 -0
  171. data/spec/api/party_api_spec.rb +2 -2
  172. data/spec/api/playlist_api_spec.rb +14 -2
  173. data/spec/api/recording_api_spec.rb +2 -2
  174. data/spec/api/user_api_spec.rb +26 -2
  175. data/spec/api_client_spec.rb +2 -2
  176. data/spec/configuration_spec.rb +2 -2
  177. data/spec/models/admin_api_create_user_dto_spec.rb +210 -0
  178. data/spec/models/admin_api_update_user_dto_spec.rb +210 -0
  179. data/spec/models/admin_api_user_dto_spec.rb +5 -3
  180. data/spec/models/age_range_spec.rb +42 -0
  181. data/spec/models/api_key_dto_spec.rb +5 -3
  182. data/spec/models/beard_spec.rb +42 -0
  183. data/spec/models/bounding_box_spec.rb +54 -0
  184. data/spec/models/category_medium_dto_spec.rb +5 -3
  185. data/spec/models/category_minimal_dto_spec.rb +5 -3
  186. data/spec/models/config_access_dto_spec.rb +5 -3
  187. data/spec/models/config_identifier_dto_spec.rb +5 -3
  188. data/spec/models/context_value_spec.rb +36 -0
  189. data/spec/models/contributor_type_dto_spec.rb +5 -3
  190. data/spec/models/create_api_key_dto_spec.rb +5 -3
  191. data/spec/models/curate_playlist_dto_spec.rb +60 -0
  192. data/spec/models/curate_playlist_response_dto_spec.rb +36 -0
  193. data/spec/models/dominant_color_spec.rb +72 -0
  194. data/spec/models/emotion_spec.rb +42 -0
  195. data/spec/models/error_response_spec.rb +5 -3
  196. data/spec/models/eye_direction_spec.rb +48 -0
  197. data/spec/models/eye_open_spec.rb +42 -0
  198. data/spec/models/eyeglasses_spec.rb +42 -0
  199. data/spec/models/face_detail_spec.rb +132 -0
  200. data/spec/models/face_detection_spec.rb +42 -0
  201. data/spec/models/face_occluded_spec.rb +42 -0
  202. data/spec/models/field_summary_dto_spec.rb +5 -3
  203. data/spec/models/file_dto_spec.rb +5 -3
  204. data/spec/models/file_list_dto_spec.rb +5 -3
  205. data/spec/models/file_minimal_with_url_dto_spec.rb +5 -3
  206. data/spec/models/file_small_dto_spec.rb +17 -15
  207. data/spec/models/file_upload_dto_spec.rb +5 -3
  208. data/spec/models/file_w_ith_url_dto_spec.rb +5 -3
  209. data/spec/models/files_summary_dto_spec.rb +5 -3
  210. data/spec/models/forgot_password_dto_spec.rb +5 -3
  211. data/spec/models/gender_spec.rb +42 -0
  212. data/spec/models/genre_dto_spec.rb +5 -3
  213. data/spec/models/genre_minimal_dto_spec.rb +5 -3
  214. data/spec/models/genres_summary_dto_spec.rb +5 -3
  215. data/spec/models/image_quality_spec.rb +42 -0
  216. data/spec/models/image_recognition_response_spec.rb +42 -0
  217. data/spec/models/init_put_recording_audio_dto_spec.rb +5 -3
  218. data/spec/models/instance_spec.rb +48 -0
  219. data/spec/models/jwt_token_dto_spec.rb +5 -3
  220. data/spec/models/label_alias_spec.rb +36 -0
  221. data/spec/models/label_category_spec.rb +36 -0
  222. data/spec/models/label_detection_spec.rb +60 -0
  223. data/spec/models/label_spec.rb +66 -0
  224. data/spec/models/landmark_spec.rb +48 -0
  225. data/spec/models/login_dto_spec.rb +5 -3
  226. data/spec/models/mouth_open_spec.rb +42 -0
  227. data/spec/models/musical_features_dto_spec.rb +114 -112
  228. data/spec/models/mustache_spec.rb +42 -0
  229. data/spec/models/p_line_dto_spec.rb +5 -3
  230. data/spec/models/parent_spec.rb +36 -0
  231. data/spec/models/party_large_dto_spec.rb +5 -3
  232. data/spec/models/party_small_dto_spec.rb +5 -3
  233. data/spec/models/playlist_large_dto_spec.rb +14 -12
  234. data/spec/models/pose_spec.rb +48 -0
  235. data/spec/models/product_medium_dto_spec.rb +11 -9
  236. data/spec/models/product_party_dto_spec.rb +5 -3
  237. data/spec/models/recording_for_similarity_search_dto_spec.rb +5 -3
  238. data/spec/models/recording_genre_prediction_dto_spec.rb +7 -5
  239. data/spec/models/recording_large_dto_spec.rb +13 -11
  240. data/spec/models/recording_list_dto_spec.rb +5 -3
  241. data/spec/models/recording_medium_dto_spec.rb +10 -8
  242. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +7 -5
  243. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +5 -3
  244. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +5 -3
  245. data/spec/models/recording_party_dto_spec.rb +5 -3
  246. data/spec/models/recording_playlist_dto_spec.rb +5 -3
  247. data/spec/models/recording_small_dto_spec.rb +8 -6
  248. data/spec/models/recording_tag_small_dto_spec.rb +5 -3
  249. data/spec/models/save_file_dto_spec.rb +108 -0
  250. data/spec/models/save_file_recording_dto_spec.rb +20 -6
  251. data/spec/models/save_playlist_dto_spec.rb +5 -3
  252. data/spec/models/save_recording_genre_dto_spec.rb +5 -3
  253. data/spec/models/save_recording_party_dto_spec.rb +5 -3
  254. data/spec/models/save_recording_playlist_dto_spec.rb +5 -3
  255. data/spec/models/save_recording_tag_dto_spec.rb +5 -3
  256. data/spec/models/save_referrer_dto_spec.rb +5 -3
  257. data/spec/models/save_taggrams_dto_spec.rb +5 -3
  258. data/spec/models/save_user_dto_spec.rb +5 -3
  259. data/spec/models/search_filter_values_dto_spec.rb +5 -3
  260. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +5 -3
  261. data/spec/models/search_recording_granular_dto_spec.rb +5 -3
  262. data/spec/models/sign_up_dto_spec.rb +5 -3
  263. data/spec/models/smile_spec.rb +42 -0
  264. data/spec/models/sunglasses_spec.rb +42 -0
  265. data/spec/models/tag_dto_spec.rb +5 -3
  266. data/spec/models/tag_small_dto_spec.rb +5 -3
  267. data/spec/models/taggram_dto_spec.rb +5 -3
  268. data/spec/models/tags_summary_dto_spec.rb +5 -3
  269. data/spec/models/tagstrength_dto_spec.rb +5 -3
  270. data/spec/models/title_dto_spec.rb +5 -3
  271. data/spec/models/token_request_spec.rb +5 -3
  272. data/spec/models/track_dto_spec.rb +5 -3
  273. data/spec/models/track_to_medium_product_dto_spec.rb +5 -3
  274. data/spec/models/update_password_dto_spec.rb +5 -3
  275. data/spec/models/usage_dto_spec.rb +5 -3
  276. data/spec/models/user_dto_spec.rb +5 -3
  277. data/spec/models/video_recognition_response_spec.rb +42 -0
  278. data/spec/spec_helper.rb +2 -2
  279. metadata +201 -61
@@ -0,0 +1,355 @@
1
+ # SongtradrApiClientRuby::AdminUsersControllerApi
2
+
3
+ All URIs are relative to *https://api.songtradr.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_user**](AdminUsersControllerApi.md#create_user) | **POST** /api/v1/admin/users | create a user |
8
+ | [**delete_user**](AdminUsersControllerApi.md#delete_user) | **DELETE** /api/v1/admin/users/{id} | delete a user |
9
+ | [**get_user**](AdminUsersControllerApi.md#get_user) | **GET** /api/v1/admin/users/{id} | show details of a user |
10
+ | [**get_users**](AdminUsersControllerApi.md#get_users) | **GET** /api/v1/admin/users | List users |
11
+ | [**update_user**](AdminUsersControllerApi.md#update_user) | **PUT** /api/v1/admin/users/{id} | update a user |
12
+
13
+
14
+ ## create_user
15
+
16
+ > <AdminApiUserDTO> create_user(admin_api_create_user_dto)
17
+
18
+ create a user
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'songtradr_api_client_ruby'
25
+ # setup authorization
26
+ SongtradrApiClientRuby.configure do |config|
27
+ # Configure Bearer authorization (JWT): bearer-jwt
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+ end
30
+
31
+ api_instance = SongtradrApiClientRuby::AdminUsersControllerApi.new
32
+ admin_api_create_user_dto = SongtradrApiClientRuby::AdminApiCreateUserDTO.new({email: 'email_example', full_name: 'full_name_example'}) # AdminApiCreateUserDTO |
33
+
34
+ begin
35
+ # create a user
36
+ result = api_instance.create_user(admin_api_create_user_dto)
37
+ p result
38
+ rescue SongtradrApiClientRuby::ApiError => e
39
+ puts "Error when calling AdminUsersControllerApi->create_user: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the create_user_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<AdminApiUserDTO>, Integer, Hash)> create_user_with_http_info(admin_api_create_user_dto)
48
+
49
+ ```ruby
50
+ begin
51
+ # create a user
52
+ data, status_code, headers = api_instance.create_user_with_http_info(admin_api_create_user_dto)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <AdminApiUserDTO>
56
+ rescue SongtradrApiClientRuby::ApiError => e
57
+ puts "Error when calling AdminUsersControllerApi->create_user_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **admin_api_create_user_dto** | [**AdminApiCreateUserDTO**](AdminApiCreateUserDTO.md) | | |
66
+
67
+ ### Return type
68
+
69
+ [**AdminApiUserDTO**](AdminApiUserDTO.md)
70
+
71
+ ### Authorization
72
+
73
+ [bearer-jwt](../README.md#bearer-jwt)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: application/json
78
+ - **Accept**: application/json
79
+
80
+
81
+ ## delete_user
82
+
83
+ > Object delete_user(id)
84
+
85
+ delete a user
86
+
87
+ ### Examples
88
+
89
+ ```ruby
90
+ require 'time'
91
+ require 'songtradr_api_client_ruby'
92
+ # setup authorization
93
+ SongtradrApiClientRuby.configure do |config|
94
+ # Configure Bearer authorization (JWT): bearer-jwt
95
+ config.access_token = 'YOUR_BEARER_TOKEN'
96
+ end
97
+
98
+ api_instance = SongtradrApiClientRuby::AdminUsersControllerApi.new
99
+ id = 56 # Integer |
100
+
101
+ begin
102
+ # delete a user
103
+ result = api_instance.delete_user(id)
104
+ p result
105
+ rescue SongtradrApiClientRuby::ApiError => e
106
+ puts "Error when calling AdminUsersControllerApi->delete_user: #{e}"
107
+ end
108
+ ```
109
+
110
+ #### Using the delete_user_with_http_info variant
111
+
112
+ This returns an Array which contains the response data, status code and headers.
113
+
114
+ > <Array(Object, Integer, Hash)> delete_user_with_http_info(id)
115
+
116
+ ```ruby
117
+ begin
118
+ # delete a user
119
+ data, status_code, headers = api_instance.delete_user_with_http_info(id)
120
+ p status_code # => 2xx
121
+ p headers # => { ... }
122
+ p data # => Object
123
+ rescue SongtradrApiClientRuby::ApiError => e
124
+ puts "Error when calling AdminUsersControllerApi->delete_user_with_http_info: #{e}"
125
+ end
126
+ ```
127
+
128
+ ### Parameters
129
+
130
+ | Name | Type | Description | Notes |
131
+ | ---- | ---- | ----------- | ----- |
132
+ | **id** | **Integer** | | |
133
+
134
+ ### Return type
135
+
136
+ **Object**
137
+
138
+ ### Authorization
139
+
140
+ [bearer-jwt](../README.md#bearer-jwt)
141
+
142
+ ### HTTP request headers
143
+
144
+ - **Content-Type**: Not defined
145
+ - **Accept**: application/json
146
+
147
+
148
+ ## get_user
149
+
150
+ > <AdminApiUserDTO> get_user(id)
151
+
152
+ show details of a user
153
+
154
+ ### Examples
155
+
156
+ ```ruby
157
+ require 'time'
158
+ require 'songtradr_api_client_ruby'
159
+ # setup authorization
160
+ SongtradrApiClientRuby.configure do |config|
161
+ # Configure Bearer authorization (JWT): bearer-jwt
162
+ config.access_token = 'YOUR_BEARER_TOKEN'
163
+ end
164
+
165
+ api_instance = SongtradrApiClientRuby::AdminUsersControllerApi.new
166
+ id = 56 # Integer |
167
+
168
+ begin
169
+ # show details of a user
170
+ result = api_instance.get_user(id)
171
+ p result
172
+ rescue SongtradrApiClientRuby::ApiError => e
173
+ puts "Error when calling AdminUsersControllerApi->get_user: #{e}"
174
+ end
175
+ ```
176
+
177
+ #### Using the get_user_with_http_info variant
178
+
179
+ This returns an Array which contains the response data, status code and headers.
180
+
181
+ > <Array(<AdminApiUserDTO>, Integer, Hash)> get_user_with_http_info(id)
182
+
183
+ ```ruby
184
+ begin
185
+ # show details of a user
186
+ data, status_code, headers = api_instance.get_user_with_http_info(id)
187
+ p status_code # => 2xx
188
+ p headers # => { ... }
189
+ p data # => <AdminApiUserDTO>
190
+ rescue SongtradrApiClientRuby::ApiError => e
191
+ puts "Error when calling AdminUsersControllerApi->get_user_with_http_info: #{e}"
192
+ end
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+ | Name | Type | Description | Notes |
198
+ | ---- | ---- | ----------- | ----- |
199
+ | **id** | **Integer** | | |
200
+
201
+ ### Return type
202
+
203
+ [**AdminApiUserDTO**](AdminApiUserDTO.md)
204
+
205
+ ### Authorization
206
+
207
+ [bearer-jwt](../README.md#bearer-jwt)
208
+
209
+ ### HTTP request headers
210
+
211
+ - **Content-Type**: Not defined
212
+ - **Accept**: application/json
213
+
214
+
215
+ ## get_users
216
+
217
+ > <AdminApiUserDTO> get_users(opts)
218
+
219
+ List users
220
+
221
+ ### Examples
222
+
223
+ ```ruby
224
+ require 'time'
225
+ require 'songtradr_api_client_ruby'
226
+ # setup authorization
227
+ SongtradrApiClientRuby.configure do |config|
228
+ # Configure Bearer authorization (JWT): bearer-jwt
229
+ config.access_token = 'YOUR_BEARER_TOKEN'
230
+ end
231
+
232
+ api_instance = SongtradrApiClientRuby::AdminUsersControllerApi.new
233
+ opts = {
234
+ page: 56, # Integer | Zero-based page index (0..N)
235
+ size: 56, # Integer | The size of the page to be returned
236
+ sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
237
+ }
238
+
239
+ begin
240
+ # List users
241
+ result = api_instance.get_users(opts)
242
+ p result
243
+ rescue SongtradrApiClientRuby::ApiError => e
244
+ puts "Error when calling AdminUsersControllerApi->get_users: #{e}"
245
+ end
246
+ ```
247
+
248
+ #### Using the get_users_with_http_info variant
249
+
250
+ This returns an Array which contains the response data, status code and headers.
251
+
252
+ > <Array(<AdminApiUserDTO>, Integer, Hash)> get_users_with_http_info(opts)
253
+
254
+ ```ruby
255
+ begin
256
+ # List users
257
+ data, status_code, headers = api_instance.get_users_with_http_info(opts)
258
+ p status_code # => 2xx
259
+ p headers # => { ... }
260
+ p data # => <AdminApiUserDTO>
261
+ rescue SongtradrApiClientRuby::ApiError => e
262
+ puts "Error when calling AdminUsersControllerApi->get_users_with_http_info: #{e}"
263
+ end
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+ | Name | Type | Description | Notes |
269
+ | ---- | ---- | ----------- | ----- |
270
+ | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
271
+ | **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
272
+ | **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] |
273
+
274
+ ### Return type
275
+
276
+ [**AdminApiUserDTO**](AdminApiUserDTO.md)
277
+
278
+ ### Authorization
279
+
280
+ [bearer-jwt](../README.md#bearer-jwt)
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: Not defined
285
+ - **Accept**: application/json
286
+
287
+
288
+ ## update_user
289
+
290
+ > <AdminApiUserDTO> update_user(id, admin_api_update_user_dto)
291
+
292
+ update a user
293
+
294
+ ### Examples
295
+
296
+ ```ruby
297
+ require 'time'
298
+ require 'songtradr_api_client_ruby'
299
+ # setup authorization
300
+ SongtradrApiClientRuby.configure do |config|
301
+ # Configure Bearer authorization (JWT): bearer-jwt
302
+ config.access_token = 'YOUR_BEARER_TOKEN'
303
+ end
304
+
305
+ api_instance = SongtradrApiClientRuby::AdminUsersControllerApi.new
306
+ id = 56 # Integer |
307
+ admin_api_update_user_dto = SongtradrApiClientRuby::AdminApiUpdateUserDTO.new # AdminApiUpdateUserDTO |
308
+
309
+ begin
310
+ # update a user
311
+ result = api_instance.update_user(id, admin_api_update_user_dto)
312
+ p result
313
+ rescue SongtradrApiClientRuby::ApiError => e
314
+ puts "Error when calling AdminUsersControllerApi->update_user: #{e}"
315
+ end
316
+ ```
317
+
318
+ #### Using the update_user_with_http_info variant
319
+
320
+ This returns an Array which contains the response data, status code and headers.
321
+
322
+ > <Array(<AdminApiUserDTO>, Integer, Hash)> update_user_with_http_info(id, admin_api_update_user_dto)
323
+
324
+ ```ruby
325
+ begin
326
+ # update a user
327
+ data, status_code, headers = api_instance.update_user_with_http_info(id, admin_api_update_user_dto)
328
+ p status_code # => 2xx
329
+ p headers # => { ... }
330
+ p data # => <AdminApiUserDTO>
331
+ rescue SongtradrApiClientRuby::ApiError => e
332
+ puts "Error when calling AdminUsersControllerApi->update_user_with_http_info: #{e}"
333
+ end
334
+ ```
335
+
336
+ ### Parameters
337
+
338
+ | Name | Type | Description | Notes |
339
+ | ---- | ---- | ----------- | ----- |
340
+ | **id** | **Integer** | | |
341
+ | **admin_api_update_user_dto** | [**AdminApiUpdateUserDTO**](AdminApiUpdateUserDTO.md) | | |
342
+
343
+ ### Return type
344
+
345
+ [**AdminApiUserDTO**](AdminApiUserDTO.md)
346
+
347
+ ### Authorization
348
+
349
+ [bearer-jwt](../README.md#bearer-jwt)
350
+
351
+ ### HTTP request headers
352
+
353
+ - **Content-Type**: application/json
354
+ - **Accept**: application/json
355
+
data/docs/AgeRange.md ADDED
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::AgeRange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **low** | **Integer** | | [optional] |
8
+ | **high** | **Integer** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::AgeRange.new(
16
+ low: null,
17
+ high: null
18
+ )
19
+ ```
20
+
data/docs/Beard.md ADDED
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::Beard
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Boolean** | | [optional] |
8
+ | **confidence** | **Float** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::Beard.new(
16
+ value: null,
17
+ confidence: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # SongtradrApiClientRuby::BoundingBox
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **width** | **Float** | | [optional] |
8
+ | **height** | **Float** | | [optional] |
9
+ | **left** | **Float** | | [optional] |
10
+ | **top** | **Float** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'songtradr_api_client_ruby'
16
+
17
+ instance = SongtradrApiClientRuby::BoundingBox.new(
18
+ width: null,
19
+ height: null,
20
+ left: null,
21
+ top: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # SongtradrApiClientRuby::ContextValue
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trackids** | **Array&lt;Integer&gt;** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'songtradr_api_client_ruby'
13
+
14
+ instance = SongtradrApiClientRuby::ContextValue.new(
15
+ trackids: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # SongtradrApiClientRuby::CuratePlaylistDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_data** | **Array&lt;String&gt;** | | [optional] |
8
+ | **usage_filter** | **String** | | [optional] |
9
+ | **numerical_filter** | **Hash&lt;String, String&gt;** | | [optional] |
10
+ | **category_filter** | **Hash&lt;String, String&gt;** | | [optional] |
11
+ | **first_id** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'songtradr_api_client_ruby'
17
+
18
+ instance = SongtradrApiClientRuby::CuratePlaylistDTO.new(
19
+ request_data: null,
20
+ usage_filter: null,
21
+ numerical_filter: null,
22
+ category_filter: null,
23
+ first_id: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # SongtradrApiClientRuby::CuratePlaylistResponseDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **songtradr_track_ids** | **Array&lt;String&gt;** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'songtradr_api_client_ruby'
13
+
14
+ instance = SongtradrApiClientRuby::CuratePlaylistResponseDTO.new(
15
+ songtradr_track_ids: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,30 @@
1
+ # SongtradrApiClientRuby::DominantColor
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **red** | **Integer** | | [optional] |
8
+ | **blue** | **Integer** | | [optional] |
9
+ | **green** | **Integer** | | [optional] |
10
+ | **hex_code** | **String** | | [optional] |
11
+ | **simplified_color** | **String** | | [optional] |
12
+ | **pixel_percent** | **Float** | | [optional] |
13
+ | **csscolor** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'songtradr_api_client_ruby'
19
+
20
+ instance = SongtradrApiClientRuby::DominantColor.new(
21
+ red: null,
22
+ blue: null,
23
+ green: null,
24
+ hex_code: null,
25
+ simplified_color: null,
26
+ pixel_percent: null,
27
+ csscolor: null
28
+ )
29
+ ```
30
+
data/docs/Emotion.md ADDED
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::Emotion
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional] |
8
+ | **confidence** | **Float** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::Emotion.new(
16
+ type: null,
17
+ confidence: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # SongtradrApiClientRuby::EyeDirection
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **yaw** | **Float** | | [optional] |
8
+ | **pitch** | **Float** | | [optional] |
9
+ | **confidence** | **Float** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'songtradr_api_client_ruby'
15
+
16
+ instance = SongtradrApiClientRuby::EyeDirection.new(
17
+ yaw: null,
18
+ pitch: null,
19
+ confidence: null
20
+ )
21
+ ```
22
+
data/docs/EyeOpen.md ADDED
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::EyeOpen
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Boolean** | | [optional] |
8
+ | **confidence** | **Float** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::EyeOpen.new(
16
+ value: null,
17
+ confidence: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::Eyeglasses
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Boolean** | | [optional] |
8
+ | **confidence** | **Float** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::Eyeglasses.new(
16
+ value: null,
17
+ confidence: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,50 @@
1
+ # SongtradrApiClientRuby::FaceDetail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **bounding_box** | [**BoundingBox**](BoundingBox.md) | | [optional] |
8
+ | **age_range** | [**AgeRange**](AgeRange.md) | | [optional] |
9
+ | **smile** | [**Smile**](Smile.md) | | [optional] |
10
+ | **eyeglasses** | [**Eyeglasses**](Eyeglasses.md) | | [optional] |
11
+ | **sunglasses** | [**Sunglasses**](Sunglasses.md) | | [optional] |
12
+ | **gender** | [**Gender**](Gender.md) | | [optional] |
13
+ | **beard** | [**Beard**](Beard.md) | | [optional] |
14
+ | **mustache** | [**Mustache**](Mustache.md) | | [optional] |
15
+ | **eyes_open** | [**EyeOpen**](EyeOpen.md) | | [optional] |
16
+ | **mouth_open** | [**MouthOpen**](MouthOpen.md) | | [optional] |
17
+ | **emotions** | [**Array&lt;Emotion&gt;**](Emotion.md) | | [optional] |
18
+ | **landmarks** | [**Array&lt;Landmark&gt;**](Landmark.md) | | [optional] |
19
+ | **pose** | [**Pose**](Pose.md) | | [optional] |
20
+ | **quality** | [**ImageQuality**](ImageQuality.md) | | [optional] |
21
+ | **confidence** | **Float** | | [optional] |
22
+ | **face_occluded** | [**FaceOccluded**](FaceOccluded.md) | | [optional] |
23
+ | **eye_direction** | [**EyeDirection**](EyeDirection.md) | | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'songtradr_api_client_ruby'
29
+
30
+ instance = SongtradrApiClientRuby::FaceDetail.new(
31
+ bounding_box: null,
32
+ age_range: null,
33
+ smile: null,
34
+ eyeglasses: null,
35
+ sunglasses: null,
36
+ gender: null,
37
+ beard: null,
38
+ mustache: null,
39
+ eyes_open: null,
40
+ mouth_open: null,
41
+ emotions: null,
42
+ landmarks: null,
43
+ pose: null,
44
+ quality: null,
45
+ confidence: null,
46
+ face_occluded: null,
47
+ eye_direction: null
48
+ )
49
+ ```
50
+
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::FaceDetection
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **timestamp** | **Integer** | | [optional] |
8
+ | **face** | [**FaceDetail**](FaceDetail.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::FaceDetection.new(
16
+ timestamp: null,
17
+ face: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # SongtradrApiClientRuby::FaceOccluded
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Boolean** | | [optional] |
8
+ | **confidence** | **Float** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'songtradr_api_client_ruby'
14
+
15
+ instance = SongtradrApiClientRuby::FaceOccluded.new(
16
+ value: null,
17
+ confidence: null
18
+ )
19
+ ```
20
+