songtradr_api_client_ruby 1.12.21

Sign up to get free protection for your applications and to get access to all the features.
Files changed (225) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +76 -0
  4. data/README.md +223 -0
  5. data/Rakefile +10 -0
  6. data/docs/AllowedValuesApi.md +200 -0
  7. data/docs/CategoryMediumDTO.md +22 -0
  8. data/docs/CategoryMinimalDTO.md +18 -0
  9. data/docs/ConfigAccessDTO.md +20 -0
  10. data/docs/ConfigIdentifierDTO.md +20 -0
  11. data/docs/ContributorTypeDTO.md +18 -0
  12. data/docs/ErrorResponse.md +26 -0
  13. data/docs/FieldSummaryDTO.md +22 -0
  14. data/docs/FileDTO.md +50 -0
  15. data/docs/FileListDTO.md +24 -0
  16. data/docs/FileMinimalWithUrlDTO.md +22 -0
  17. data/docs/FileSmallDTO.md +46 -0
  18. data/docs/FileUploadDTO.md +22 -0
  19. data/docs/FileWIthUrlDTO.md +20 -0
  20. data/docs/FilesSummaryDTO.md +30 -0
  21. data/docs/ForgotPasswordDTO.md +20 -0
  22. data/docs/GenreDTO.md +20 -0
  23. data/docs/GenreMinimalDTO.md +18 -0
  24. data/docs/GenresSummaryDTO.md +22 -0
  25. data/docs/InitPutRecordingAudioDTO.md +22 -0
  26. data/docs/JwtTokenDTO.md +22 -0
  27. data/docs/LoginDTO.md +24 -0
  28. data/docs/MusicalFeaturesDTO.md +186 -0
  29. data/docs/PLineDTO.md +20 -0
  30. data/docs/PartyApi.md +75 -0
  31. data/docs/PartyLargeDTO.md +32 -0
  32. data/docs/PartySmallDTO.md +20 -0
  33. data/docs/PlaylistApi.md +221 -0
  34. data/docs/PlaylistLargeDTO.md +38 -0
  35. data/docs/ProductMediumDTO.md +34 -0
  36. data/docs/ProductPartyDTO.md +20 -0
  37. data/docs/RecordingApi.md +789 -0
  38. data/docs/RecordingForSimilaritySearchDTO.md +20 -0
  39. data/docs/RecordingGenrePredictionDTO.md +22 -0
  40. data/docs/RecordingLargeDTO.md +40 -0
  41. data/docs/RecordingListDTO.md +24 -0
  42. data/docs/RecordingMediumDTO.md +36 -0
  43. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +20 -0
  44. data/docs/RecordingMinimalWithTaggramsDTO.md +22 -0
  45. data/docs/RecordingMinimalWithTagstrengthsDTO.md +20 -0
  46. data/docs/RecordingPartyDTO.md +20 -0
  47. data/docs/RecordingPlaylistDTO.md +24 -0
  48. data/docs/RecordingSmallDTO.md +24 -0
  49. data/docs/RecordingTagSmallDTO.md +18 -0
  50. data/docs/SaveFileRecordingDTO.md +236 -0
  51. data/docs/SavePlaylistDTO.md +34 -0
  52. data/docs/SaveRecordingGenreDTO.md +22 -0
  53. data/docs/SaveRecordingPartyDTO.md +20 -0
  54. data/docs/SaveRecordingPlaylistDTO.md +22 -0
  55. data/docs/SaveRecordingTagDTO.md +20 -0
  56. data/docs/SaveReferrerDTO.md +20 -0
  57. data/docs/SaveTaggramsDTO.md +82 -0
  58. data/docs/SaveUserDTO.md +28 -0
  59. data/docs/SearchFilterValuesDTO.md +98 -0
  60. data/docs/SearchRecordingGranularAbstractionDTO.md +20 -0
  61. data/docs/SearchRecordingGranularDTO.md +20 -0
  62. data/docs/SignUpDTO.md +24 -0
  63. data/docs/TagDTO.md +22 -0
  64. data/docs/TagSmallDTO.md +20 -0
  65. data/docs/TaggramDTO.md +26 -0
  66. data/docs/TagsSummaryDTO.md +22 -0
  67. data/docs/TagstrengthDTO.md +26 -0
  68. data/docs/TitleDTO.md +18 -0
  69. data/docs/TokenRequest.md +18 -0
  70. data/docs/TrackToMediumProductDTO.md +22 -0
  71. data/docs/UpdatePasswordDTO.md +20 -0
  72. data/docs/UsageDTO.md +18 -0
  73. data/docs/UserApi.md +1936 -0
  74. data/docs/UserDTO.md +56 -0
  75. data/getspec.rb +10 -0
  76. data/git_push.sh +57 -0
  77. data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +213 -0
  78. data/lib/songtradr_api_client_ruby/api/party_api.rb +84 -0
  79. data/lib/songtradr_api_client_ruby/api/playlist_api.rb +222 -0
  80. data/lib/songtradr_api_client_ruby/api/recording_api.rb +900 -0
  81. data/lib/songtradr_api_client_ruby/api/user_api.rb +2642 -0
  82. data/lib/songtradr_api_client_ruby/api_client.rb +428 -0
  83. data/lib/songtradr_api_client_ruby/api_error.rb +58 -0
  84. data/lib/songtradr_api_client_ruby/configuration.rb +380 -0
  85. data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +250 -0
  86. data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +225 -0
  87. data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +287 -0
  88. data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +239 -0
  89. data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +225 -0
  90. data/lib/songtradr_api_client_ruby/models/error_response.rb +276 -0
  91. data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +253 -0
  92. data/lib/songtradr_api_client_ruby/models/file_dto.rb +450 -0
  93. data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +269 -0
  94. data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +253 -0
  95. data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +432 -0
  96. data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +244 -0
  97. data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +239 -0
  98. data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +287 -0
  99. data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +267 -0
  100. data/lib/songtradr_api_client_ruby/models/genre_dto.rb +239 -0
  101. data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +225 -0
  102. data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +248 -0
  103. data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +238 -0
  104. data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +248 -0
  105. data/lib/songtradr_api_client_ruby/models/login_dto.rb +257 -0
  106. data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +1532 -0
  107. data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +234 -0
  108. data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +288 -0
  109. data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +239 -0
  110. data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +353 -0
  111. data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +316 -0
  112. data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +236 -0
  113. data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +239 -0
  114. data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +253 -0
  115. data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +366 -0
  116. data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +269 -0
  117. data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +340 -0
  118. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +236 -0
  119. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +248 -0
  120. data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +236 -0
  121. data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +236 -0
  122. data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +247 -0
  123. data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +268 -0
  124. data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +225 -0
  125. data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +1847 -0
  126. data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +350 -0
  127. data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +243 -0
  128. data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +273 -0
  129. data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +248 -0
  130. data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +234 -0
  131. data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +229 -0
  132. data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +574 -0
  133. data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +317 -0
  134. data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +867 -0
  135. data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +270 -0
  136. data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +235 -0
  137. data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +262 -0
  138. data/lib/songtradr_api_client_ruby/models/tag_dto.rb +250 -0
  139. data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +239 -0
  140. data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +271 -0
  141. data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +250 -0
  142. data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +269 -0
  143. data/lib/songtradr_api_client_ruby/models/title_dto.rb +225 -0
  144. data/lib/songtradr_api_client_ruby/models/token_request.rb +224 -0
  145. data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +248 -0
  146. data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +238 -0
  147. data/lib/songtradr_api_client_ruby/models/usage_dto.rb +220 -0
  148. data/lib/songtradr_api_client_ruby/models/user_dto.rb +481 -0
  149. data/lib/songtradr_api_client_ruby/version.rb +15 -0
  150. data/lib/songtradr_api_client_ruby.rb +108 -0
  151. data/openapi-generator-config.yaml +10 -0
  152. data/songtradr_api_client_ruby.gemspec +39 -0
  153. data/spec/api/allowed_values_api_spec.rb +68 -0
  154. data/spec/api/party_api_spec.rb +46 -0
  155. data/spec/api/playlist_api_spec.rb +72 -0
  156. data/spec/api/recording_api_spec.rb +192 -0
  157. data/spec/api/user_api_spec.rb +507 -0
  158. data/spec/api_client_spec.rb +223 -0
  159. data/spec/configuration_spec.rb +82 -0
  160. data/spec/models/category_medium_dto_spec.rb +46 -0
  161. data/spec/models/category_minimal_dto_spec.rb +34 -0
  162. data/spec/models/config_access_dto_spec.rb +48 -0
  163. data/spec/models/config_identifier_dto_spec.rb +40 -0
  164. data/spec/models/contributor_type_dto_spec.rb +34 -0
  165. data/spec/models/error_response_spec.rb +58 -0
  166. data/spec/models/field_summary_dto_spec.rb +46 -0
  167. data/spec/models/file_dto_spec.rb +142 -0
  168. data/spec/models/file_list_dto_spec.rb +52 -0
  169. data/spec/models/file_minimal_with_url_dto_spec.rb +46 -0
  170. data/spec/models/file_small_dto_spec.rb +130 -0
  171. data/spec/models/file_upload_dto_spec.rb +46 -0
  172. data/spec/models/file_w_ith_url_dto_spec.rb +40 -0
  173. data/spec/models/files_summary_dto_spec.rb +70 -0
  174. data/spec/models/forgot_password_dto_spec.rb +44 -0
  175. data/spec/models/genre_dto_spec.rb +40 -0
  176. data/spec/models/genre_minimal_dto_spec.rb +34 -0
  177. data/spec/models/genres_summary_dto_spec.rb +46 -0
  178. data/spec/models/init_put_recording_audio_dto_spec.rb +46 -0
  179. data/spec/models/jwt_token_dto_spec.rb +46 -0
  180. data/spec/models/login_dto_spec.rb +52 -0
  181. data/spec/models/musical_features_dto_spec.rb +706 -0
  182. data/spec/models/p_line_dto_spec.rb +40 -0
  183. data/spec/models/party_large_dto_spec.rb +76 -0
  184. data/spec/models/party_small_dto_spec.rb +40 -0
  185. data/spec/models/playlist_large_dto_spec.rb +98 -0
  186. data/spec/models/product_medium_dto_spec.rb +82 -0
  187. data/spec/models/product_party_dto_spec.rb +40 -0
  188. data/spec/models/recording_for_similarity_search_dto_spec.rb +40 -0
  189. data/spec/models/recording_genre_prediction_dto_spec.rb +46 -0
  190. data/spec/models/recording_large_dto_spec.rb +100 -0
  191. data/spec/models/recording_list_dto_spec.rb +52 -0
  192. data/spec/models/recording_medium_dto_spec.rb +88 -0
  193. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +40 -0
  194. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +46 -0
  195. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +40 -0
  196. data/spec/models/recording_party_dto_spec.rb +40 -0
  197. data/spec/models/recording_playlist_dto_spec.rb +52 -0
  198. data/spec/models/recording_small_dto_spec.rb +52 -0
  199. data/spec/models/recording_tag_small_dto_spec.rb +34 -0
  200. data/spec/models/save_file_recording_dto_spec.rb +880 -0
  201. data/spec/models/save_playlist_dto_spec.rb +86 -0
  202. data/spec/models/save_recording_genre_dto_spec.rb +46 -0
  203. data/spec/models/save_recording_party_dto_spec.rb +44 -0
  204. data/spec/models/save_recording_playlist_dto_spec.rb +46 -0
  205. data/spec/models/save_recording_tag_dto_spec.rb +40 -0
  206. data/spec/models/save_referrer_dto_spec.rb +40 -0
  207. data/spec/models/save_taggrams_dto_spec.rb +226 -0
  208. data/spec/models/save_user_dto_spec.rb +72 -0
  209. data/spec/models/search_filter_values_dto_spec.rb +274 -0
  210. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +44 -0
  211. data/spec/models/search_recording_granular_dto_spec.rb +40 -0
  212. data/spec/models/sign_up_dto_spec.rb +52 -0
  213. data/spec/models/tag_dto_spec.rb +46 -0
  214. data/spec/models/tag_small_dto_spec.rb +40 -0
  215. data/spec/models/taggram_dto_spec.rb +58 -0
  216. data/spec/models/tags_summary_dto_spec.rb +46 -0
  217. data/spec/models/tagstrength_dto_spec.rb +58 -0
  218. data/spec/models/title_dto_spec.rb +34 -0
  219. data/spec/models/token_request_spec.rb +34 -0
  220. data/spec/models/track_to_medium_product_dto_spec.rb +46 -0
  221. data/spec/models/update_password_dto_spec.rb +40 -0
  222. data/spec/models/usage_dto_spec.rb +34 -0
  223. data/spec/models/user_dto_spec.rb +148 -0
  224. data/spec/spec_helper.rb +111 -0
  225. metadata +412 -0
@@ -0,0 +1,789 @@
1
+ # SongtradrApiClientRuby::RecordingApi
2
+
3
+ All URIs are relative to *https://api.songtradr.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**recordings_by_ids_with_musical_features**](RecordingApi.md#recordings_by_ids_with_musical_features) | **GET** /api/v1/public/recording/{ids}/musicalFeatures | AI generated moods, musical features and more for recordings. |
8
+ | [**recordings_by_ids_with_similarities**](RecordingApi.md#recordings_by_ids_with_similarities) | **GET** /api/v1/public/recording/{ids}/similarities | Similar recordings for a list of recordings. |
9
+ | [**recordings_by_ids_with_taggrams**](RecordingApi.md#recordings_by_ids_with_taggrams) | **GET** /api/v1/public/recording/{ids}/taggrams | Timeseries of AI generated moods, musical features and more for a list of recordings. |
10
+ | [**recordings_by_ids_with_tagstrengths**](RecordingApi.md#recordings_by_ids_with_tagstrengths) | **GET** /api/v1/public/recording/{ids}/tagstrengths | Strengths as numerical representations for AI generated moods, musical features and more for recordings. |
11
+ | [**recordings_large_by_ids**](RecordingApi.md#recordings_large_by_ids) | **GET** /api/v1/public/recording/l/{ids} | Recordings by IDs with a large response. |
12
+ | [**recordings_medium_by_ids**](RecordingApi.md#recordings_medium_by_ids) | **GET** /api/v1/public/recording/m/{ids} | Recordings by IDs with a medium sized response. |
13
+ | [**recordings_small_by_ids**](RecordingApi.md#recordings_small_by_ids) | **GET** /api/v1/public/recording/s/{ids} | Recordings by IDs with a small response. |
14
+ | [**search_recordings**](RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more. |
15
+ | [**search_recordings_granular**](RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options. |
16
+ | [**search_recordings_granular_abstraction**](RecordingApi.md#search_recordings_granular_abstraction) | **POST** /api/v1/public/recording/searchGranularAbstraction | Recordings by abstracted wordings and granular search options. |
17
+
18
+
19
+ ## recordings_by_ids_with_musical_features
20
+
21
+ > <Array<RecordingMinimalWithMusicalFeaturesDTO>> recordings_by_ids_with_musical_features(ids)
22
+
23
+ AI generated moods, musical features and more for recordings.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'songtradr_api_client_ruby'
30
+ # setup authorization
31
+ SongtradrApiClientRuby.configure do |config|
32
+ # Configure Bearer authorization (JWT): bearer-jwt
33
+ config.access_token = 'YOUR_BEARER_TOKEN'
34
+ end
35
+
36
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
37
+ ids = 'ZAA010800469' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
38
+
39
+ begin
40
+ # AI generated moods, musical features and more for recordings.
41
+ result = api_instance.recordings_by_ids_with_musical_features(ids)
42
+ p result
43
+ rescue SongtradrApiClientRuby::ApiError => e
44
+ puts "Error when calling RecordingApi->recordings_by_ids_with_musical_features: #{e}"
45
+ end
46
+ ```
47
+
48
+ #### Using the recordings_by_ids_with_musical_features_with_http_info variant
49
+
50
+ This returns an Array which contains the response data, status code and headers.
51
+
52
+ > <Array(<Array<RecordingMinimalWithMusicalFeaturesDTO>>, Integer, Hash)> recordings_by_ids_with_musical_features_with_http_info(ids)
53
+
54
+ ```ruby
55
+ begin
56
+ # AI generated moods, musical features and more for recordings.
57
+ data, status_code, headers = api_instance.recordings_by_ids_with_musical_features_with_http_info(ids)
58
+ p status_code # => 2xx
59
+ p headers # => { ... }
60
+ p data # => <Array<RecordingMinimalWithMusicalFeaturesDTO>>
61
+ rescue SongtradrApiClientRuby::ApiError => e
62
+ puts "Error when calling RecordingApi->recordings_by_ids_with_musical_features_with_http_info: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ | Name | Type | Description | Notes |
69
+ | ---- | ---- | ----------- | ----- |
70
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
71
+
72
+ ### Return type
73
+
74
+ [**Array&lt;RecordingMinimalWithMusicalFeaturesDTO&gt;**](RecordingMinimalWithMusicalFeaturesDTO.md)
75
+
76
+ ### Authorization
77
+
78
+ [bearer-jwt](../README.md#bearer-jwt)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: application/json
84
+
85
+
86
+ ## recordings_by_ids_with_similarities
87
+
88
+ > <Array<RecordingForSimilaritySearchDTO>> recordings_by_ids_with_similarities(ids)
89
+
90
+ Similar recordings for a list of recordings.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'songtradr_api_client_ruby'
97
+ # setup authorization
98
+ SongtradrApiClientRuby.configure do |config|
99
+ # Configure Bearer authorization (JWT): bearer-jwt
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+ end
102
+
103
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
104
+ ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
105
+
106
+ begin
107
+ # Similar recordings for a list of recordings.
108
+ result = api_instance.recordings_by_ids_with_similarities(ids)
109
+ p result
110
+ rescue SongtradrApiClientRuby::ApiError => e
111
+ puts "Error when calling RecordingApi->recordings_by_ids_with_similarities: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the recordings_by_ids_with_similarities_with_http_info variant
116
+
117
+ This returns an Array which contains the response data, status code and headers.
118
+
119
+ > <Array(<Array<RecordingForSimilaritySearchDTO>>, Integer, Hash)> recordings_by_ids_with_similarities_with_http_info(ids)
120
+
121
+ ```ruby
122
+ begin
123
+ # Similar recordings for a list of recordings.
124
+ data, status_code, headers = api_instance.recordings_by_ids_with_similarities_with_http_info(ids)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => <Array<RecordingForSimilaritySearchDTO>>
128
+ rescue SongtradrApiClientRuby::ApiError => e
129
+ puts "Error when calling RecordingApi->recordings_by_ids_with_similarities_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
138
+
139
+ ### Return type
140
+
141
+ [**Array&lt;RecordingForSimilaritySearchDTO&gt;**](RecordingForSimilaritySearchDTO.md)
142
+
143
+ ### Authorization
144
+
145
+ [bearer-jwt](../README.md#bearer-jwt)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: Not defined
150
+ - **Accept**: application/json
151
+
152
+
153
+ ## recordings_by_ids_with_taggrams
154
+
155
+ > <Array<RecordingMinimalWithTaggramsDTO>> recordings_by_ids_with_taggrams(ids, opts)
156
+
157
+ Timeseries of AI generated moods, musical features and more for a list of recordings.
158
+
159
+ ### Examples
160
+
161
+ ```ruby
162
+ require 'time'
163
+ require 'songtradr_api_client_ruby'
164
+ # setup authorization
165
+ SongtradrApiClientRuby.configure do |config|
166
+ # Configure Bearer authorization (JWT): bearer-jwt
167
+ config.access_token = 'YOUR_BEARER_TOKEN'
168
+ end
169
+
170
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
171
+ ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
172
+ opts = {
173
+ category_name: 'instrument', # String | Show only taggrams for one category.
174
+ tag_name: 'energetic', # String | Show only taggrams for one tag.
175
+ genre_name: 'Ska', # String | Show only taggrams for one genre.
176
+ from_timestamp: 16.0, # Float | Show only taggrams data starting from from this timestamp in seconds.
177
+ fill_with_zero: true # Boolean | If set to true, empty timeseries are filled with timeseries of 0.0 values.
178
+ }
179
+
180
+ begin
181
+ # Timeseries of AI generated moods, musical features and more for a list of recordings.
182
+ result = api_instance.recordings_by_ids_with_taggrams(ids, opts)
183
+ p result
184
+ rescue SongtradrApiClientRuby::ApiError => e
185
+ puts "Error when calling RecordingApi->recordings_by_ids_with_taggrams: #{e}"
186
+ end
187
+ ```
188
+
189
+ #### Using the recordings_by_ids_with_taggrams_with_http_info variant
190
+
191
+ This returns an Array which contains the response data, status code and headers.
192
+
193
+ > <Array(<Array<RecordingMinimalWithTaggramsDTO>>, Integer, Hash)> recordings_by_ids_with_taggrams_with_http_info(ids, opts)
194
+
195
+ ```ruby
196
+ begin
197
+ # Timeseries of AI generated moods, musical features and more for a list of recordings.
198
+ data, status_code, headers = api_instance.recordings_by_ids_with_taggrams_with_http_info(ids, opts)
199
+ p status_code # => 2xx
200
+ p headers # => { ... }
201
+ p data # => <Array<RecordingMinimalWithTaggramsDTO>>
202
+ rescue SongtradrApiClientRuby::ApiError => e
203
+ puts "Error when calling RecordingApi->recordings_by_ids_with_taggrams_with_http_info: #{e}"
204
+ end
205
+ ```
206
+
207
+ ### Parameters
208
+
209
+ | Name | Type | Description | Notes |
210
+ | ---- | ---- | ----------- | ----- |
211
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
212
+ | **category_name** | **String** | Show only taggrams for one category. | [optional] |
213
+ | **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
214
+ | **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
215
+ | **from_timestamp** | **Float** | Show only taggrams data starting from from this timestamp in seconds. | [optional] |
216
+ | **fill_with_zero** | **Boolean** | If set to true, empty timeseries are filled with timeseries of 0.0 values. | [optional] |
217
+
218
+ ### Return type
219
+
220
+ [**Array&lt;RecordingMinimalWithTaggramsDTO&gt;**](RecordingMinimalWithTaggramsDTO.md)
221
+
222
+ ### Authorization
223
+
224
+ [bearer-jwt](../README.md#bearer-jwt)
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: Not defined
229
+ - **Accept**: application/json
230
+
231
+
232
+ ## recordings_by_ids_with_tagstrengths
233
+
234
+ > <Array<RecordingMinimalWithTagstrengthsDTO>> recordings_by_ids_with_tagstrengths(ids, opts)
235
+
236
+ Strengths as numerical representations for AI generated moods, musical features and more for recordings.
237
+
238
+ ### Examples
239
+
240
+ ```ruby
241
+ require 'time'
242
+ require 'songtradr_api_client_ruby'
243
+ # setup authorization
244
+ SongtradrApiClientRuby.configure do |config|
245
+ # Configure Bearer authorization (JWT): bearer-jwt
246
+ config.access_token = 'YOUR_BEARER_TOKEN'
247
+ end
248
+
249
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
250
+ ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
251
+ opts = {
252
+ category_name: 'instrument', # String | Show only taggrams for one category.
253
+ tag_name: 'energetic', # String | Show only taggrams for one tag.
254
+ genre_name: 'Ska' # String | Show only taggrams for one genre.
255
+ }
256
+
257
+ begin
258
+ # Strengths as numerical representations for AI generated moods, musical features and more for recordings.
259
+ result = api_instance.recordings_by_ids_with_tagstrengths(ids, opts)
260
+ p result
261
+ rescue SongtradrApiClientRuby::ApiError => e
262
+ puts "Error when calling RecordingApi->recordings_by_ids_with_tagstrengths: #{e}"
263
+ end
264
+ ```
265
+
266
+ #### Using the recordings_by_ids_with_tagstrengths_with_http_info variant
267
+
268
+ This returns an Array which contains the response data, status code and headers.
269
+
270
+ > <Array(<Array<RecordingMinimalWithTagstrengthsDTO>>, Integer, Hash)> recordings_by_ids_with_tagstrengths_with_http_info(ids, opts)
271
+
272
+ ```ruby
273
+ begin
274
+ # Strengths as numerical representations for AI generated moods, musical features and more for recordings.
275
+ data, status_code, headers = api_instance.recordings_by_ids_with_tagstrengths_with_http_info(ids, opts)
276
+ p status_code # => 2xx
277
+ p headers # => { ... }
278
+ p data # => <Array<RecordingMinimalWithTagstrengthsDTO>>
279
+ rescue SongtradrApiClientRuby::ApiError => e
280
+ puts "Error when calling RecordingApi->recordings_by_ids_with_tagstrengths_with_http_info: #{e}"
281
+ end
282
+ ```
283
+
284
+ ### Parameters
285
+
286
+ | Name | Type | Description | Notes |
287
+ | ---- | ---- | ----------- | ----- |
288
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
289
+ | **category_name** | **String** | Show only taggrams for one category. | [optional] |
290
+ | **tag_name** | **String** | Show only taggrams for one tag. | [optional] |
291
+ | **genre_name** | **String** | Show only taggrams for one genre. | [optional] |
292
+
293
+ ### Return type
294
+
295
+ [**Array&lt;RecordingMinimalWithTagstrengthsDTO&gt;**](RecordingMinimalWithTagstrengthsDTO.md)
296
+
297
+ ### Authorization
298
+
299
+ [bearer-jwt](../README.md#bearer-jwt)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: Not defined
304
+ - **Accept**: application/json
305
+
306
+
307
+ ## recordings_large_by_ids
308
+
309
+ > <Array<RecordingLargeDTO>> recordings_large_by_ids(ids)
310
+
311
+ Recordings by IDs with a large response.
312
+
313
+ ### Examples
314
+
315
+ ```ruby
316
+ require 'time'
317
+ require 'songtradr_api_client_ruby'
318
+ # setup authorization
319
+ SongtradrApiClientRuby.configure do |config|
320
+ # Configure Bearer authorization (JWT): bearer-jwt
321
+ config.access_token = 'YOUR_BEARER_TOKEN'
322
+ end
323
+
324
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
325
+ ids = 'GBAYE1101181' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
326
+
327
+ begin
328
+ # Recordings by IDs with a large response.
329
+ result = api_instance.recordings_large_by_ids(ids)
330
+ p result
331
+ rescue SongtradrApiClientRuby::ApiError => e
332
+ puts "Error when calling RecordingApi->recordings_large_by_ids: #{e}"
333
+ end
334
+ ```
335
+
336
+ #### Using the recordings_large_by_ids_with_http_info variant
337
+
338
+ This returns an Array which contains the response data, status code and headers.
339
+
340
+ > <Array(<Array<RecordingLargeDTO>>, Integer, Hash)> recordings_large_by_ids_with_http_info(ids)
341
+
342
+ ```ruby
343
+ begin
344
+ # Recordings by IDs with a large response.
345
+ data, status_code, headers = api_instance.recordings_large_by_ids_with_http_info(ids)
346
+ p status_code # => 2xx
347
+ p headers # => { ... }
348
+ p data # => <Array<RecordingLargeDTO>>
349
+ rescue SongtradrApiClientRuby::ApiError => e
350
+ puts "Error when calling RecordingApi->recordings_large_by_ids_with_http_info: #{e}"
351
+ end
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ | Name | Type | Description | Notes |
357
+ | ---- | ---- | ----------- | ----- |
358
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
359
+
360
+ ### Return type
361
+
362
+ [**Array&lt;RecordingLargeDTO&gt;**](RecordingLargeDTO.md)
363
+
364
+ ### Authorization
365
+
366
+ [bearer-jwt](../README.md#bearer-jwt)
367
+
368
+ ### HTTP request headers
369
+
370
+ - **Content-Type**: Not defined
371
+ - **Accept**: application/json
372
+
373
+
374
+ ## recordings_medium_by_ids
375
+
376
+ > <Array<RecordingMediumDTO>> recordings_medium_by_ids(ids, opts)
377
+
378
+ Recordings by IDs with a medium sized response.
379
+
380
+ ### Examples
381
+
382
+ ```ruby
383
+ require 'time'
384
+ require 'songtradr_api_client_ruby'
385
+ # setup authorization
386
+ SongtradrApiClientRuby.configure do |config|
387
+ # Configure Bearer authorization (JWT): bearer-jwt
388
+ config.access_token = 'YOUR_BEARER_TOKEN'
389
+ end
390
+
391
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
392
+ ids = 'GBAHT0108619' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
393
+ opts = {
394
+ page: 56, # Integer | Zero-based page index (0..N)
395
+ size: 56, # Integer | The size of the page to be returned
396
+ sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
397
+ }
398
+
399
+ begin
400
+ # Recordings by IDs with a medium sized response.
401
+ result = api_instance.recordings_medium_by_ids(ids, opts)
402
+ p result
403
+ rescue SongtradrApiClientRuby::ApiError => e
404
+ puts "Error when calling RecordingApi->recordings_medium_by_ids: #{e}"
405
+ end
406
+ ```
407
+
408
+ #### Using the recordings_medium_by_ids_with_http_info variant
409
+
410
+ This returns an Array which contains the response data, status code and headers.
411
+
412
+ > <Array(<Array<RecordingMediumDTO>>, Integer, Hash)> recordings_medium_by_ids_with_http_info(ids, opts)
413
+
414
+ ```ruby
415
+ begin
416
+ # Recordings by IDs with a medium sized response.
417
+ data, status_code, headers = api_instance.recordings_medium_by_ids_with_http_info(ids, opts)
418
+ p status_code # => 2xx
419
+ p headers # => { ... }
420
+ p data # => <Array<RecordingMediumDTO>>
421
+ rescue SongtradrApiClientRuby::ApiError => e
422
+ puts "Error when calling RecordingApi->recordings_medium_by_ids_with_http_info: #{e}"
423
+ end
424
+ ```
425
+
426
+ ### Parameters
427
+
428
+ | Name | Type | Description | Notes |
429
+ | ---- | ---- | ----------- | ----- |
430
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
431
+ | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
432
+ | **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
433
+ | **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] |
434
+
435
+ ### Return type
436
+
437
+ [**Array&lt;RecordingMediumDTO&gt;**](RecordingMediumDTO.md)
438
+
439
+ ### Authorization
440
+
441
+ [bearer-jwt](../README.md#bearer-jwt)
442
+
443
+ ### HTTP request headers
444
+
445
+ - **Content-Type**: Not defined
446
+ - **Accept**: application/json
447
+
448
+
449
+ ## recordings_small_by_ids
450
+
451
+ > <Array<RecordingSmallDTO>> recordings_small_by_ids(ids)
452
+
453
+ Recordings by IDs with a small response.
454
+
455
+ ### Examples
456
+
457
+ ```ruby
458
+ require 'time'
459
+ require 'songtradr_api_client_ruby'
460
+ # setup authorization
461
+ SongtradrApiClientRuby.configure do |config|
462
+ # Configure Bearer authorization (JWT): bearer-jwt
463
+ config.access_token = 'YOUR_BEARER_TOKEN'
464
+ end
465
+
466
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
467
+ ids = 'GBAYE0200774' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
468
+
469
+ begin
470
+ # Recordings by IDs with a small response.
471
+ result = api_instance.recordings_small_by_ids(ids)
472
+ p result
473
+ rescue SongtradrApiClientRuby::ApiError => e
474
+ puts "Error when calling RecordingApi->recordings_small_by_ids: #{e}"
475
+ end
476
+ ```
477
+
478
+ #### Using the recordings_small_by_ids_with_http_info variant
479
+
480
+ This returns an Array which contains the response data, status code and headers.
481
+
482
+ > <Array(<Array<RecordingSmallDTO>>, Integer, Hash)> recordings_small_by_ids_with_http_info(ids)
483
+
484
+ ```ruby
485
+ begin
486
+ # Recordings by IDs with a small response.
487
+ data, status_code, headers = api_instance.recordings_small_by_ids_with_http_info(ids)
488
+ p status_code # => 2xx
489
+ p headers # => { ... }
490
+ p data # => <Array<RecordingSmallDTO>>
491
+ rescue SongtradrApiClientRuby::ApiError => e
492
+ puts "Error when calling RecordingApi->recordings_small_by_ids_with_http_info: #{e}"
493
+ end
494
+ ```
495
+
496
+ ### Parameters
497
+
498
+ | Name | Type | Description | Notes |
499
+ | ---- | ---- | ----------- | ----- |
500
+ | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
501
+
502
+ ### Return type
503
+
504
+ [**Array&lt;RecordingSmallDTO&gt;**](RecordingSmallDTO.md)
505
+
506
+ ### Authorization
507
+
508
+ [bearer-jwt](../README.md#bearer-jwt)
509
+
510
+ ### HTTP request headers
511
+
512
+ - **Content-Type**: Not defined
513
+ - **Accept**: application/json
514
+
515
+
516
+ ## search_recordings
517
+
518
+ > <RecordingListDTO> search_recordings(opts)
519
+
520
+ Recordings by contributors, moods, musical features and more.
521
+
522
+ ### Examples
523
+
524
+ ```ruby
525
+ require 'time'
526
+ require 'songtradr_api_client_ruby'
527
+ # setup authorization
528
+ SongtradrApiClientRuby.configure do |config|
529
+ # Configure Bearer authorization (JWT): bearer-jwt
530
+ config.access_token = 'YOUR_BEARER_TOKEN'
531
+ end
532
+
533
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
534
+ opts = {
535
+ similar_to_recording: 'GBUM71110209', # String | Search for songs similar to a recording.
536
+ contributor: 'Rick Rubin', # String | Search for a name that was involved as any contributor.
537
+ main_artist: 'The Beatles', # String | Search for a main artist.
538
+ composer: 'John Cale', # String | Search for a composer.
539
+ title: 'Highway To Hell', # String | Search for a title.
540
+ language: 'en', # String | Search for a language of the lyrics.
541
+ genre: 'Rock', # String | Search for a genre.
542
+ primary_mood_cluster: 'aggressive', # String | Search for a mood.
543
+ valence: 'very sad', # String | Search for valence.
544
+ arousal: 'very calm', # String | Search for arousal.
545
+ pleasantness: 'very unpleasant', # String | Search for pleasantness.
546
+ engagement: 'very unengaging', # String | Search for an engagement.
547
+ vocals: 'instrumental', # String | Search for a vocals gender or instrumental songs.
548
+ dominant_instrument: 'electric guitar', # String | Search for a dominant instrument.
549
+ energy: 'very quiet', # String | Search for energy.
550
+ sound_generation: 'acoustic', # String | Search for type of sound generation.
551
+ tempo: 'very slow', # String | Search for tempo.
552
+ scale: 'major key', # String | Search for tonal scale.
553
+ key: 'C', # String | Search for harmonic key.
554
+ rhythm: 'common time', # String | Search for rhythm.
555
+ primary_sound_character: 'brassy', # String | Search for a sound character.
556
+ timbre: 'very warm', # String | Search for timbre.
557
+ roughness: 'very clear', # String | Search for roughness.
558
+ tonality: 'monotonous', # String | Search for tonality.
559
+ harmony: 'very dissonant', # String | Search for a degree of harmoniousness.
560
+ texture: 'very thin', # String | Search for texture.
561
+ groovyness: 'very steady', # String | Search for groovyness.
562
+ space: 'very compact', # String | Search for space.
563
+ origin_decade: 'pre-1950s', # String | Search for origin decade.
564
+ curateability: 'curateable', # String | Search for curateability.
565
+ use_case: 'background', # String | Search for use case.
566
+ channel_suitability: 'Spotify', # String | Search for channel suitability.
567
+ songtradr_track_id: 'songtradr_track_id_example', # String | Search for Songtradr track id.
568
+ shuffled: 'true', # String | Sort the results randomly.
569
+ sort: 'popularityDesc', # String | Sort the results.
570
+ page: 56, # Integer | Zero-based page index (0..N)
571
+ size: 56 # Integer | The size of the page to be returned
572
+ }
573
+
574
+ begin
575
+ # Recordings by contributors, moods, musical features and more.
576
+ result = api_instance.search_recordings(opts)
577
+ p result
578
+ rescue SongtradrApiClientRuby::ApiError => e
579
+ puts "Error when calling RecordingApi->search_recordings: #{e}"
580
+ end
581
+ ```
582
+
583
+ #### Using the search_recordings_with_http_info variant
584
+
585
+ This returns an Array which contains the response data, status code and headers.
586
+
587
+ > <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_with_http_info(opts)
588
+
589
+ ```ruby
590
+ begin
591
+ # Recordings by contributors, moods, musical features and more.
592
+ data, status_code, headers = api_instance.search_recordings_with_http_info(opts)
593
+ p status_code # => 2xx
594
+ p headers # => { ... }
595
+ p data # => <RecordingListDTO>
596
+ rescue SongtradrApiClientRuby::ApiError => e
597
+ puts "Error when calling RecordingApi->search_recordings_with_http_info: #{e}"
598
+ end
599
+ ```
600
+
601
+ ### Parameters
602
+
603
+ | Name | Type | Description | Notes |
604
+ | ---- | ---- | ----------- | ----- |
605
+ | **similar_to_recording** | **String** | Search for songs similar to a recording. | [optional] |
606
+ | **contributor** | **String** | Search for a name that was involved as any contributor. | [optional] |
607
+ | **main_artist** | **String** | Search for a main artist. | [optional] |
608
+ | **composer** | **String** | Search for a composer. | [optional] |
609
+ | **title** | **String** | Search for a title. | [optional] |
610
+ | **language** | **String** | Search for a language of the lyrics. | [optional] |
611
+ | **genre** | **String** | Search for a genre. | [optional] |
612
+ | **primary_mood_cluster** | **String** | Search for a mood. | [optional] |
613
+ | **valence** | **String** | Search for valence. | [optional] |
614
+ | **arousal** | **String** | Search for arousal. | [optional] |
615
+ | **pleasantness** | **String** | Search for pleasantness. | [optional] |
616
+ | **engagement** | **String** | Search for an engagement. | [optional] |
617
+ | **vocals** | **String** | Search for a vocals gender or instrumental songs. | [optional] |
618
+ | **dominant_instrument** | **String** | Search for a dominant instrument. | [optional] |
619
+ | **energy** | **String** | Search for energy. | [optional] |
620
+ | **sound_generation** | **String** | Search for type of sound generation. | [optional] |
621
+ | **tempo** | **String** | Search for tempo. | [optional] |
622
+ | **scale** | **String** | Search for tonal scale. | [optional] |
623
+ | **key** | **String** | Search for harmonic key. | [optional] |
624
+ | **rhythm** | **String** | Search for rhythm. | [optional] |
625
+ | **primary_sound_character** | **String** | Search for a sound character. | [optional] |
626
+ | **timbre** | **String** | Search for timbre. | [optional] |
627
+ | **roughness** | **String** | Search for roughness. | [optional] |
628
+ | **tonality** | **String** | Search for tonality. | [optional] |
629
+ | **harmony** | **String** | Search for a degree of harmoniousness. | [optional] |
630
+ | **texture** | **String** | Search for texture. | [optional] |
631
+ | **groovyness** | **String** | Search for groovyness. | [optional] |
632
+ | **space** | **String** | Search for space. | [optional] |
633
+ | **origin_decade** | **String** | Search for origin decade. | [optional] |
634
+ | **curateability** | **String** | Search for curateability. | [optional] |
635
+ | **use_case** | **String** | Search for use case. | [optional] |
636
+ | **channel_suitability** | **String** | Search for channel suitability. | [optional] |
637
+ | **songtradr_track_id** | **String** | Search for Songtradr track id. | [optional] |
638
+ | **shuffled** | **String** | Sort the results randomly. | [optional][default to &#39;false&#39;] |
639
+ | **sort** | **String** | Sort the results. | [optional][default to &#39;popularityDesc&#39;] |
640
+ | **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
641
+ | **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
642
+
643
+ ### Return type
644
+
645
+ [**RecordingListDTO**](RecordingListDTO.md)
646
+
647
+ ### Authorization
648
+
649
+ [bearer-jwt](../README.md#bearer-jwt)
650
+
651
+ ### HTTP request headers
652
+
653
+ - **Content-Type**: Not defined
654
+ - **Accept**: application/json
655
+
656
+
657
+ ## search_recordings_granular
658
+
659
+ > <RecordingListDTO> search_recordings_granular(search_recording_granular_dto)
660
+
661
+ Recordings by granular search options.
662
+
663
+ ### Examples
664
+
665
+ ```ruby
666
+ require 'time'
667
+ require 'songtradr_api_client_ruby'
668
+ # setup authorization
669
+ SongtradrApiClientRuby.configure do |config|
670
+ # Configure Bearer authorization (JWT): bearer-jwt
671
+ config.access_token = 'YOUR_BEARER_TOKEN'
672
+ end
673
+
674
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
675
+ search_recording_granular_dto = [SongtradrApiClientRuby::SearchRecordingGranularDTO.new({tag_name: 'tag_name_example'})] # Array<SearchRecordingGranularDTO> |
676
+
677
+ begin
678
+ # Recordings by granular search options.
679
+ result = api_instance.search_recordings_granular(search_recording_granular_dto)
680
+ p result
681
+ rescue SongtradrApiClientRuby::ApiError => e
682
+ puts "Error when calling RecordingApi->search_recordings_granular: #{e}"
683
+ end
684
+ ```
685
+
686
+ #### Using the search_recordings_granular_with_http_info variant
687
+
688
+ This returns an Array which contains the response data, status code and headers.
689
+
690
+ > <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_granular_with_http_info(search_recording_granular_dto)
691
+
692
+ ```ruby
693
+ begin
694
+ # Recordings by granular search options.
695
+ data, status_code, headers = api_instance.search_recordings_granular_with_http_info(search_recording_granular_dto)
696
+ p status_code # => 2xx
697
+ p headers # => { ... }
698
+ p data # => <RecordingListDTO>
699
+ rescue SongtradrApiClientRuby::ApiError => e
700
+ puts "Error when calling RecordingApi->search_recordings_granular_with_http_info: #{e}"
701
+ end
702
+ ```
703
+
704
+ ### Parameters
705
+
706
+ | Name | Type | Description | Notes |
707
+ | ---- | ---- | ----------- | ----- |
708
+ | **search_recording_granular_dto** | [**Array&lt;SearchRecordingGranularDTO&gt;**](SearchRecordingGranularDTO.md) | | |
709
+
710
+ ### Return type
711
+
712
+ [**RecordingListDTO**](RecordingListDTO.md)
713
+
714
+ ### Authorization
715
+
716
+ [bearer-jwt](../README.md#bearer-jwt)
717
+
718
+ ### HTTP request headers
719
+
720
+ - **Content-Type**: application/json
721
+ - **Accept**: application/json
722
+
723
+
724
+ ## search_recordings_granular_abstraction
725
+
726
+ > <RecordingListDTO> search_recordings_granular_abstraction(search_recording_granular_abstraction_dto)
727
+
728
+ Recordings by abstracted wordings and granular search options.
729
+
730
+ ### Examples
731
+
732
+ ```ruby
733
+ require 'time'
734
+ require 'songtradr_api_client_ruby'
735
+ # setup authorization
736
+ SongtradrApiClientRuby.configure do |config|
737
+ # Configure Bearer authorization (JWT): bearer-jwt
738
+ config.access_token = 'YOUR_BEARER_TOKEN'
739
+ end
740
+
741
+ api_instance = SongtradrApiClientRuby::RecordingApi.new
742
+ search_recording_granular_abstraction_dto = [SongtradrApiClientRuby::SearchRecordingGranularAbstractionDTO.new({abstraction_name: 'brandarchetypeInnocent'})] # Array<SearchRecordingGranularAbstractionDTO> |
743
+
744
+ begin
745
+ # Recordings by abstracted wordings and granular search options.
746
+ result = api_instance.search_recordings_granular_abstraction(search_recording_granular_abstraction_dto)
747
+ p result
748
+ rescue SongtradrApiClientRuby::ApiError => e
749
+ puts "Error when calling RecordingApi->search_recordings_granular_abstraction: #{e}"
750
+ end
751
+ ```
752
+
753
+ #### Using the search_recordings_granular_abstraction_with_http_info variant
754
+
755
+ This returns an Array which contains the response data, status code and headers.
756
+
757
+ > <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto)
758
+
759
+ ```ruby
760
+ begin
761
+ # Recordings by abstracted wordings and granular search options.
762
+ data, status_code, headers = api_instance.search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto)
763
+ p status_code # => 2xx
764
+ p headers # => { ... }
765
+ p data # => <RecordingListDTO>
766
+ rescue SongtradrApiClientRuby::ApiError => e
767
+ puts "Error when calling RecordingApi->search_recordings_granular_abstraction_with_http_info: #{e}"
768
+ end
769
+ ```
770
+
771
+ ### Parameters
772
+
773
+ | Name | Type | Description | Notes |
774
+ | ---- | ---- | ----------- | ----- |
775
+ | **search_recording_granular_abstraction_dto** | [**Array&lt;SearchRecordingGranularAbstractionDTO&gt;**](SearchRecordingGranularAbstractionDTO.md) | | |
776
+
777
+ ### Return type
778
+
779
+ [**RecordingListDTO**](RecordingListDTO.md)
780
+
781
+ ### Authorization
782
+
783
+ [bearer-jwt](../README.md#bearer-jwt)
784
+
785
+ ### HTTP request headers
786
+
787
+ - **Content-Type**: application/json
788
+ - **Accept**: application/json
789
+