songtradr_api_client_ruby 1.13.5 → 1.13.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (250) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +12 -36
  4. data/docs/FileSmallDTO.md +5 -5
  5. data/docs/MusicalFeaturesDTO.md +27 -27
  6. data/docs/PlaylistLargeDTO.md +2 -2
  7. data/docs/RecordingGenrePredictionDTO.md +3 -3
  8. data/docs/RecordingLargeDTO.md +2 -2
  9. data/docs/RecordingMediumDTO.md +2 -2
  10. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
  11. data/docs/RecordingSmallDTO.md +3 -3
  12. data/docs/TagDTO.md +3 -3
  13. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
  14. data/lib/songtradr_api_client_ruby/api/party_api.rb +1 -1
  15. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -1
  16. data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -1
  17. data/lib/songtradr_api_client_ruby/api/user_api.rb +1 -1
  18. data/lib/songtradr_api_client_ruby/api_client.rb +1 -1
  19. data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
  20. data/lib/songtradr_api_client_ruby/configuration.rb +1 -1
  21. data/lib/songtradr_api_client_ruby/models/age_range.rb +1 -1
  22. data/lib/songtradr_api_client_ruby/models/beard.rb +1 -1
  23. data/lib/songtradr_api_client_ruby/models/bounding_box.rb +1 -1
  24. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +1 -1
  25. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +1 -1
  26. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +1 -1
  27. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +1 -1
  28. data/lib/songtradr_api_client_ruby/models/context_value.rb +1 -1
  29. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +1 -1
  30. data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +1 -1
  31. data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +1 -1
  32. data/lib/songtradr_api_client_ruby/models/dominant_color.rb +1 -1
  33. data/lib/songtradr_api_client_ruby/models/emotion.rb +1 -1
  34. data/lib/songtradr_api_client_ruby/models/error_response.rb +1 -1
  35. data/lib/songtradr_api_client_ruby/models/eye_direction.rb +1 -1
  36. data/lib/songtradr_api_client_ruby/models/eye_open.rb +1 -1
  37. data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +1 -1
  38. data/lib/songtradr_api_client_ruby/models/face_detail.rb +1 -1
  39. data/lib/songtradr_api_client_ruby/models/face_detection.rb +1 -1
  40. data/lib/songtradr_api_client_ruby/models/face_occluded.rb +1 -1
  41. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +1 -1
  42. data/lib/songtradr_api_client_ruby/models/file_dto.rb +1 -1
  43. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +1 -1
  44. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +1 -1
  45. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +36 -36
  46. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +1 -1
  47. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +1 -1
  48. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +1 -1
  49. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +1 -1
  50. data/lib/songtradr_api_client_ruby/models/gender.rb +1 -1
  51. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +1 -1
  52. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +1 -1
  53. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +1 -1
  54. data/lib/songtradr_api_client_ruby/models/image_quality.rb +1 -1
  55. data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +1 -1
  56. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +1 -1
  57. data/lib/songtradr_api_client_ruby/models/instance.rb +1 -1
  58. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +1 -1
  59. data/lib/songtradr_api_client_ruby/models/label.rb +1 -1
  60. data/lib/songtradr_api_client_ruby/models/label_alias.rb +1 -1
  61. data/lib/songtradr_api_client_ruby/models/label_category.rb +1 -1
  62. data/lib/songtradr_api_client_ruby/models/label_detection.rb +1 -1
  63. data/lib/songtradr_api_client_ruby/models/landmark.rb +1 -1
  64. data/lib/songtradr_api_client_ruby/models/login_dto.rb +1 -1
  65. data/lib/songtradr_api_client_ruby/models/mouth_open.rb +1 -1
  66. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +172 -172
  67. data/lib/songtradr_api_client_ruby/models/mustache.rb +1 -1
  68. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +1 -1
  69. data/lib/songtradr_api_client_ruby/models/parent.rb +1 -1
  70. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +1 -1
  71. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +1 -1
  72. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +11 -11
  73. data/lib/songtradr_api_client_ruby/models/pose.rb +1 -1
  74. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +1 -1
  75. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +1 -1
  76. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +1 -1
  77. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +21 -21
  78. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +13 -13
  79. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +1 -1
  80. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +13 -13
  81. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +16 -16
  82. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +1 -1
  83. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +1 -1
  84. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +1 -1
  85. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +1 -1
  86. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +16 -16
  87. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +1 -1
  88. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +1 -1
  89. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +1 -1
  90. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +1 -1
  91. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +1 -1
  92. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +1 -1
  93. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +1 -1
  94. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +1 -1
  95. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +1 -1
  96. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +1 -1
  97. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +1 -1
  98. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +1 -1
  99. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +1 -1
  100. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +1 -1
  101. data/lib/songtradr_api_client_ruby/models/smile.rb +1 -1
  102. data/lib/songtradr_api_client_ruby/models/sunglasses.rb +1 -1
  103. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +16 -16
  104. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +1 -1
  105. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +1 -1
  106. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +1 -1
  107. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +1 -1
  108. data/lib/songtradr_api_client_ruby/models/title_dto.rb +1 -1
  109. data/lib/songtradr_api_client_ruby/models/token_request.rb +1 -1
  110. data/lib/songtradr_api_client_ruby/models/track_dto.rb +1 -1
  111. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +1 -1
  112. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +1 -1
  113. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +1 -1
  114. data/lib/songtradr_api_client_ruby/models/user_dto.rb +1 -1
  115. data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +1 -1
  116. data/lib/songtradr_api_client_ruby/version.rb +2 -2
  117. data/lib/songtradr_api_client_ruby.rb +1 -10
  118. data/openapi-generator-config.yaml +1 -1
  119. data/songtradr_api_client_ruby.gemspec +1 -1
  120. data/spec/api/allowed_values_api_spec.rb +1 -1
  121. data/spec/api/party_api_spec.rb +1 -1
  122. data/spec/api/playlist_api_spec.rb +1 -1
  123. data/spec/api/recording_api_spec.rb +1 -1
  124. data/spec/api/user_api_spec.rb +1 -1
  125. data/spec/api_client_spec.rb +1 -1
  126. data/spec/configuration_spec.rb +1 -1
  127. data/spec/models/age_range_spec.rb +1 -1
  128. data/spec/models/beard_spec.rb +1 -1
  129. data/spec/models/bounding_box_spec.rb +1 -1
  130. data/spec/models/category_medium_dto_spec.rb +1 -1
  131. data/spec/models/category_minimal_dto_spec.rb +1 -1
  132. data/spec/models/config_access_dto_spec.rb +1 -1
  133. data/spec/models/config_identifier_dto_spec.rb +1 -1
  134. data/spec/models/context_value_spec.rb +1 -1
  135. data/spec/models/contributor_type_dto_spec.rb +1 -1
  136. data/spec/models/curate_playlist_dto_spec.rb +1 -1
  137. data/spec/models/curate_playlist_response_dto_spec.rb +1 -1
  138. data/spec/models/dominant_color_spec.rb +1 -1
  139. data/spec/models/emotion_spec.rb +1 -1
  140. data/spec/models/error_response_spec.rb +1 -1
  141. data/spec/models/eye_direction_spec.rb +1 -1
  142. data/spec/models/eye_open_spec.rb +1 -1
  143. data/spec/models/eyeglasses_spec.rb +1 -1
  144. data/spec/models/face_detail_spec.rb +1 -1
  145. data/spec/models/face_detection_spec.rb +1 -1
  146. data/spec/models/face_occluded_spec.rb +1 -1
  147. data/spec/models/field_summary_dto_spec.rb +1 -1
  148. data/spec/models/file_dto_spec.rb +1 -1
  149. data/spec/models/file_list_dto_spec.rb +1 -1
  150. data/spec/models/file_minimal_with_url_dto_spec.rb +1 -1
  151. data/spec/models/file_small_dto_spec.rb +17 -17
  152. data/spec/models/file_upload_dto_spec.rb +1 -1
  153. data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
  154. data/spec/models/files_summary_dto_spec.rb +1 -1
  155. data/spec/models/forgot_password_dto_spec.rb +1 -1
  156. data/spec/models/gender_spec.rb +1 -1
  157. data/spec/models/genre_dto_spec.rb +1 -1
  158. data/spec/models/genre_minimal_dto_spec.rb +1 -1
  159. data/spec/models/genres_summary_dto_spec.rb +1 -1
  160. data/spec/models/image_quality_spec.rb +1 -1
  161. data/spec/models/image_recognition_response_spec.rb +1 -1
  162. data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
  163. data/spec/models/instance_spec.rb +1 -1
  164. data/spec/models/jwt_token_dto_spec.rb +1 -1
  165. data/spec/models/label_alias_spec.rb +1 -1
  166. data/spec/models/label_category_spec.rb +1 -1
  167. data/spec/models/label_detection_spec.rb +1 -1
  168. data/spec/models/label_spec.rb +1 -1
  169. data/spec/models/landmark_spec.rb +1 -1
  170. data/spec/models/login_dto_spec.rb +1 -1
  171. data/spec/models/mouth_open_spec.rb +1 -1
  172. data/spec/models/musical_features_dto_spec.rb +57 -57
  173. data/spec/models/mustache_spec.rb +1 -1
  174. data/spec/models/p_line_dto_spec.rb +1 -1
  175. data/spec/models/parent_spec.rb +1 -1
  176. data/spec/models/party_large_dto_spec.rb +1 -1
  177. data/spec/models/party_small_dto_spec.rb +1 -1
  178. data/spec/models/playlist_large_dto_spec.rb +7 -7
  179. data/spec/models/pose_spec.rb +1 -1
  180. data/spec/models/product_medium_dto_spec.rb +1 -1
  181. data/spec/models/product_party_dto_spec.rb +1 -1
  182. data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
  183. data/spec/models/recording_genre_prediction_dto_spec.rb +4 -4
  184. data/spec/models/recording_large_dto_spec.rb +7 -7
  185. data/spec/models/recording_list_dto_spec.rb +1 -1
  186. data/spec/models/recording_medium_dto_spec.rb +7 -7
  187. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +3 -3
  188. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
  189. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
  190. data/spec/models/recording_party_dto_spec.rb +1 -1
  191. data/spec/models/recording_playlist_dto_spec.rb +1 -1
  192. data/spec/models/recording_small_dto_spec.rb +4 -4
  193. data/spec/models/recording_tag_small_dto_spec.rb +1 -1
  194. data/spec/models/save_file_recording_dto_spec.rb +1 -1
  195. data/spec/models/save_playlist_dto_spec.rb +1 -1
  196. data/spec/models/save_recording_genre_dto_spec.rb +1 -1
  197. data/spec/models/save_recording_party_dto_spec.rb +1 -1
  198. data/spec/models/save_recording_playlist_dto_spec.rb +1 -1
  199. data/spec/models/save_recording_tag_dto_spec.rb +1 -1
  200. data/spec/models/save_referrer_dto_spec.rb +1 -1
  201. data/spec/models/save_taggrams_dto_spec.rb +1 -1
  202. data/spec/models/save_user_dto_spec.rb +1 -1
  203. data/spec/models/search_filter_values_dto_spec.rb +1 -1
  204. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +1 -1
  205. data/spec/models/search_recording_granular_dto_spec.rb +1 -1
  206. data/spec/models/sign_up_dto_spec.rb +1 -1
  207. data/spec/models/smile_spec.rb +1 -1
  208. data/spec/models/sunglasses_spec.rb +1 -1
  209. data/spec/models/tag_dto_spec.rb +3 -3
  210. data/spec/models/tag_small_dto_spec.rb +1 -1
  211. data/spec/models/taggram_dto_spec.rb +1 -1
  212. data/spec/models/tags_summary_dto_spec.rb +1 -1
  213. data/spec/models/tagstrength_dto_spec.rb +1 -1
  214. data/spec/models/title_dto_spec.rb +1 -1
  215. data/spec/models/token_request_spec.rb +1 -1
  216. data/spec/models/track_dto_spec.rb +1 -1
  217. data/spec/models/track_to_medium_product_dto_spec.rb +1 -1
  218. data/spec/models/update_password_dto_spec.rb +1 -1
  219. data/spec/models/usage_dto_spec.rb +1 -1
  220. data/spec/models/user_dto_spec.rb +1 -1
  221. data/spec/models/video_recognition_response_spec.rb +1 -1
  222. data/spec/spec_helper.rb +1 -1
  223. metadata +1 -37
  224. data/docs/APIKeysApi.md +0 -217
  225. data/docs/AdminApiCreateUserDTO.md +0 -76
  226. data/docs/AdminApiUpdateUserDTO.md +0 -76
  227. data/docs/AdminApiUserDTO.md +0 -70
  228. data/docs/AdminUsersControllerApi.md +0 -355
  229. data/docs/ApiKeyDTO.md +0 -24
  230. data/docs/CreateApiKeyDTO.md +0 -18
  231. data/docs/InternalApiApi.md +0 -149
  232. data/docs/SaveFileDTO.md +0 -42
  233. data/lib/songtradr_api_client_ruby/api/admin_users_controller_api.rb +0 -346
  234. data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +0 -213
  235. data/lib/songtradr_api_client_ruby/api/internal_api_api.rb +0 -169
  236. data/lib/songtradr_api_client_ruby/models/admin_api_create_user_dto.rb +0 -489
  237. data/lib/songtradr_api_client_ruby/models/admin_api_update_user_dto.rb +0 -475
  238. data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +0 -448
  239. data/lib/songtradr_api_client_ruby/models/api_key_dto.rb +0 -262
  240. data/lib/songtradr_api_client_ruby/models/create_api_key_dto.rb +0 -214
  241. data/lib/songtradr_api_client_ruby/models/save_file_dto.rb +0 -323
  242. data/spec/api/admin_users_controller_api_spec.rb +0 -93
  243. data/spec/api/api_keys_api_spec.rb +0 -70
  244. data/spec/api/internal_api_api_spec.rb +0 -58
  245. data/spec/models/admin_api_create_user_dto_spec.rb +0 -210
  246. data/spec/models/admin_api_update_user_dto_spec.rb +0 -210
  247. data/spec/models/admin_api_user_dto_spec.rb +0 -192
  248. data/spec/models/api_key_dto_spec.rb +0 -54
  249. data/spec/models/create_api_key_dto_spec.rb +0 -36
  250. data/spec/models/save_file_dto_spec.rb +0 -108
@@ -1,355 +0,0 @@
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/ApiKeyDTO.md DELETED
@@ -1,24 +0,0 @@
1
- # SongtradrApiClientRuby::ApiKeyDTO
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | |
8
- | **id** | **String** | | |
9
- | **created_at** | **Time** | | |
10
- | **last_used_at** | **Time** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'songtradr_api_client_ruby'
16
-
17
- instance = SongtradrApiClientRuby::ApiKeyDTO.new(
18
- name: null,
19
- id: null,
20
- created_at: null,
21
- last_used_at: null
22
- )
23
- ```
24
-
@@ -1,18 +0,0 @@
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
-
@@ -1,149 +0,0 @@
1
- # SongtradrApiClientRuby::InternalApiApi
2
-
3
- All URIs are relative to *https://api.songtradr.com*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**internal_create_inference**](InternalApiApi.md#internal_create_inference) | **POST** /api/v1/internal/inference | |
8
- | [**internal_update_file**](InternalApiApi.md#internal_update_file) | **PATCH** /api/v1/internal/file/{customerName}/{objectKey} | |
9
-
10
-
11
- ## internal_create_inference
12
-
13
- > Object internal_create_inference(authorization, save_file_recording_dto)
14
-
15
-
16
-
17
- ### Examples
18
-
19
- ```ruby
20
- require 'time'
21
- require 'songtradr_api_client_ruby'
22
- # setup authorization
23
- SongtradrApiClientRuby.configure do |config|
24
- # Configure Bearer authorization (JWT): bearer-jwt
25
- config.access_token = 'YOUR_BEARER_TOKEN'
26
- end
27
-
28
- api_instance = SongtradrApiClientRuby::InternalApiApi.new
29
- authorization = 'authorization_example' # String |
30
- save_file_recording_dto = [SongtradrApiClientRuby::SaveFileRecordingDTO.new({isrc: 'isrc_example', created_by_version: 'created_by_version_example'})] # Array<SaveFileRecordingDTO> |
31
-
32
- begin
33
-
34
- result = api_instance.internal_create_inference(authorization, save_file_recording_dto)
35
- p result
36
- rescue SongtradrApiClientRuby::ApiError => e
37
- puts "Error when calling InternalApiApi->internal_create_inference: #{e}"
38
- end
39
- ```
40
-
41
- #### Using the internal_create_inference_with_http_info variant
42
-
43
- This returns an Array which contains the response data, status code and headers.
44
-
45
- > <Array(Object, Integer, Hash)> internal_create_inference_with_http_info(authorization, save_file_recording_dto)
46
-
47
- ```ruby
48
- begin
49
-
50
- data, status_code, headers = api_instance.internal_create_inference_with_http_info(authorization, save_file_recording_dto)
51
- p status_code # => 2xx
52
- p headers # => { ... }
53
- p data # => Object
54
- rescue SongtradrApiClientRuby::ApiError => e
55
- puts "Error when calling InternalApiApi->internal_create_inference_with_http_info: #{e}"
56
- end
57
- ```
58
-
59
- ### Parameters
60
-
61
- | Name | Type | Description | Notes |
62
- | ---- | ---- | ----------- | ----- |
63
- | **authorization** | **String** | | |
64
- | **save_file_recording_dto** | [**Array&lt;SaveFileRecordingDTO&gt;**](SaveFileRecordingDTO.md) | | |
65
-
66
- ### Return type
67
-
68
- **Object**
69
-
70
- ### Authorization
71
-
72
- [bearer-jwt](../README.md#bearer-jwt)
73
-
74
- ### HTTP request headers
75
-
76
- - **Content-Type**: application/json
77
- - **Accept**: application/json
78
-
79
-
80
- ## internal_update_file
81
-
82
- > Object internal_update_file(customer_name, object_key, save_file_dto)
83
-
84
-
85
-
86
- ### Examples
87
-
88
- ```ruby
89
- require 'time'
90
- require 'songtradr_api_client_ruby'
91
- # setup authorization
92
- SongtradrApiClientRuby.configure do |config|
93
- # Configure Bearer authorization (JWT): bearer-jwt
94
- config.access_token = 'YOUR_BEARER_TOKEN'
95
- end
96
-
97
- api_instance = SongtradrApiClientRuby::InternalApiApi.new
98
- customer_name = 'customer_name_example' # String |
99
- object_key = 'object_key_example' # String |
100
- save_file_dto = SongtradrApiClientRuby::SaveFileDTO.new # SaveFileDTO |
101
-
102
- begin
103
-
104
- result = api_instance.internal_update_file(customer_name, object_key, save_file_dto)
105
- p result
106
- rescue SongtradrApiClientRuby::ApiError => e
107
- puts "Error when calling InternalApiApi->internal_update_file: #{e}"
108
- end
109
- ```
110
-
111
- #### Using the internal_update_file_with_http_info variant
112
-
113
- This returns an Array which contains the response data, status code and headers.
114
-
115
- > <Array(Object, Integer, Hash)> internal_update_file_with_http_info(customer_name, object_key, save_file_dto)
116
-
117
- ```ruby
118
- begin
119
-
120
- data, status_code, headers = api_instance.internal_update_file_with_http_info(customer_name, object_key, save_file_dto)
121
- p status_code # => 2xx
122
- p headers # => { ... }
123
- p data # => Object
124
- rescue SongtradrApiClientRuby::ApiError => e
125
- puts "Error when calling InternalApiApi->internal_update_file_with_http_info: #{e}"
126
- end
127
- ```
128
-
129
- ### Parameters
130
-
131
- | Name | Type | Description | Notes |
132
- | ---- | ---- | ----------- | ----- |
133
- | **customer_name** | **String** | | |
134
- | **object_key** | **String** | | |
135
- | **save_file_dto** | [**SaveFileDTO**](SaveFileDTO.md) | | |
136
-
137
- ### Return type
138
-
139
- **Object**
140
-
141
- ### Authorization
142
-
143
- [bearer-jwt](../README.md#bearer-jwt)
144
-
145
- ### HTTP request headers
146
-
147
- - **Content-Type**: application/json
148
- - **Accept**: application/json
149
-
data/docs/SaveFileDTO.md DELETED
@@ -1,42 +0,0 @@
1
- # SongtradrApiClientRuby::SaveFileDTO
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **folder** | **String** | | [optional] |
9
- | **extension** | **String** | | [optional] |
10
- | **object_key** | **String** | | [optional] |
11
- | **customer** | **String** | | [optional] |
12
- | **upload_start_time** | **Time** | | [optional] |
13
- | **upload_end_time** | **Time** | | [optional] |
14
- | **fingerprint_status** | **String** | | [optional] |
15
- | **fingerprint_start_time** | **Time** | | [optional] |
16
- | **fingerprint_end_time** | **Time** | | [optional] |
17
- | **inference_status** | **String** | | [optional] |
18
- | **inference_start_time** | **Time** | | [optional] |
19
- | **inference_end_time** | **Time** | | [optional] |
20
-
21
- ## Example
22
-
23
- ```ruby
24
- require 'songtradr_api_client_ruby'
25
-
26
- instance = SongtradrApiClientRuby::SaveFileDTO.new(
27
- name: null,
28
- folder: null,
29
- extension: null,
30
- object_key: null,
31
- customer: null,
32
- upload_start_time: null,
33
- upload_end_time: null,
34
- fingerprint_status: null,
35
- fingerprint_start_time: null,
36
- fingerprint_end_time: null,
37
- inference_status: null,
38
- inference_start_time: null,
39
- inference_end_time: null
40
- )
41
- ```
42
-