musicube_api_client_ruby 1.1.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (227) hide show
  1. checksums.yaml +7 -0
  2. data/CODE_OF_CONDUCT.md +84 -0
  3. data/Gemfile +9 -0
  4. data/README.md +223 -0
  5. data/Rakefile +10 -0
  6. data/bin/console +15 -0
  7. data/bin/setup +8 -0
  8. data/docs/AllowedValuesApi.md +200 -0
  9. data/docs/CategoryMediumDTO.md +22 -0
  10. data/docs/CategoryMinimalDTO.md +18 -0
  11. data/docs/ConfigAccessDTO.md +20 -0
  12. data/docs/ConfigIdentifierDTO.md +20 -0
  13. data/docs/ContributorTypeDTO.md +18 -0
  14. data/docs/ErrorResponse.md +26 -0
  15. data/docs/FieldSummaryDTO.md +22 -0
  16. data/docs/FileDTO.md +50 -0
  17. data/docs/FileListDTO.md +24 -0
  18. data/docs/FileMinimalWithUrlDTO.md +22 -0
  19. data/docs/FileSmallDTO.md +46 -0
  20. data/docs/FileUploadDTO.md +22 -0
  21. data/docs/FileWIthUrlDTO.md +20 -0
  22. data/docs/FilesSummaryDTO.md +30 -0
  23. data/docs/ForgotPasswordDTO.md +20 -0
  24. data/docs/GenreDTO.md +20 -0
  25. data/docs/GenreMinimalDTO.md +18 -0
  26. data/docs/GenresSummaryDTO.md +22 -0
  27. data/docs/InitPutRecordingAudioDTO.md +22 -0
  28. data/docs/JwtTokenDTO.md +22 -0
  29. data/docs/LoginDTO.md +24 -0
  30. data/docs/MusicalFeaturesDTO.md +186 -0
  31. data/docs/PLineDTO.md +20 -0
  32. data/docs/PartyApi.md +75 -0
  33. data/docs/PartyLargeDTO.md +32 -0
  34. data/docs/PartySmallDTO.md +20 -0
  35. data/docs/PlaylistApi.md +221 -0
  36. data/docs/PlaylistLargeDTO.md +38 -0
  37. data/docs/ProductMediumDTO.md +34 -0
  38. data/docs/ProductPartyDTO.md +20 -0
  39. data/docs/RecordingApi.md +789 -0
  40. data/docs/RecordingForSimilaritySearchDTO.md +20 -0
  41. data/docs/RecordingGenrePredictionDTO.md +22 -0
  42. data/docs/RecordingLargeDTO.md +40 -0
  43. data/docs/RecordingListDTO.md +24 -0
  44. data/docs/RecordingMediumDTO.md +36 -0
  45. data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +20 -0
  46. data/docs/RecordingMinimalWithTaggramsDTO.md +22 -0
  47. data/docs/RecordingMinimalWithTagstrengthsDTO.md +20 -0
  48. data/docs/RecordingPartyDTO.md +20 -0
  49. data/docs/RecordingPlaylistDTO.md +24 -0
  50. data/docs/RecordingSmallDTO.md +24 -0
  51. data/docs/RecordingTagSmallDTO.md +18 -0
  52. data/docs/SaveFileRecordingDTO.md +236 -0
  53. data/docs/SavePlaylistDTO.md +34 -0
  54. data/docs/SaveRecordingGenreDTO.md +22 -0
  55. data/docs/SaveRecordingPartyDTO.md +20 -0
  56. data/docs/SaveRecordingPlaylistDTO.md +22 -0
  57. data/docs/SaveRecordingTagDTO.md +20 -0
  58. data/docs/SaveReferrerDTO.md +20 -0
  59. data/docs/SaveTaggramsDTO.md +82 -0
  60. data/docs/SaveUserDTO.md +28 -0
  61. data/docs/SearchFilterValuesDTO.md +98 -0
  62. data/docs/SearchRecordingGranularAbstractionDTO.md +20 -0
  63. data/docs/SearchRecordingGranularDTO.md +22 -0
  64. data/docs/SignUpDTO.md +24 -0
  65. data/docs/TagDTO.md +22 -0
  66. data/docs/TagSmallDTO.md +20 -0
  67. data/docs/TaggramDTO.md +26 -0
  68. data/docs/TagsSummaryDTO.md +22 -0
  69. data/docs/TagstrengthDTO.md +26 -0
  70. data/docs/TitleDTO.md +18 -0
  71. data/docs/TokenRequest.md +18 -0
  72. data/docs/TrackToMediumProductDTO.md +22 -0
  73. data/docs/UpdatePasswordDTO.md +20 -0
  74. data/docs/UsageDTO.md +18 -0
  75. data/docs/UserApi.md +1936 -0
  76. data/docs/UserDTO.md +56 -0
  77. data/git_push.sh +57 -0
  78. data/lib/musicube_api_client_ruby/api/allowed_values_api.rb +213 -0
  79. data/lib/musicube_api_client_ruby/api/party_api.rb +84 -0
  80. data/lib/musicube_api_client_ruby/api/playlist_api.rb +222 -0
  81. data/lib/musicube_api_client_ruby/api/recording_api.rb +900 -0
  82. data/lib/musicube_api_client_ruby/api/user_api.rb +2642 -0
  83. data/lib/musicube_api_client_ruby/api_client.rb +428 -0
  84. data/lib/musicube_api_client_ruby/api_error.rb +58 -0
  85. data/lib/musicube_api_client_ruby/configuration.rb +380 -0
  86. data/lib/musicube_api_client_ruby/models/category_medium_dto.rb +250 -0
  87. data/lib/musicube_api_client_ruby/models/category_minimal_dto.rb +225 -0
  88. data/lib/musicube_api_client_ruby/models/config_access_dto.rb +287 -0
  89. data/lib/musicube_api_client_ruby/models/config_identifier_dto.rb +239 -0
  90. data/lib/musicube_api_client_ruby/models/contributor_type_dto.rb +225 -0
  91. data/lib/musicube_api_client_ruby/models/error_response.rb +276 -0
  92. data/lib/musicube_api_client_ruby/models/field_summary_dto.rb +253 -0
  93. data/lib/musicube_api_client_ruby/models/file_dto.rb +450 -0
  94. data/lib/musicube_api_client_ruby/models/file_list_dto.rb +269 -0
  95. data/lib/musicube_api_client_ruby/models/file_minimal_with_url_dto.rb +253 -0
  96. data/lib/musicube_api_client_ruby/models/file_small_dto.rb +432 -0
  97. data/lib/musicube_api_client_ruby/models/file_upload_dto.rb +244 -0
  98. data/lib/musicube_api_client_ruby/models/file_w_ith_url_dto.rb +239 -0
  99. data/lib/musicube_api_client_ruby/models/files_summary_dto.rb +287 -0
  100. data/lib/musicube_api_client_ruby/models/forgot_password_dto.rb +267 -0
  101. data/lib/musicube_api_client_ruby/models/genre_dto.rb +239 -0
  102. data/lib/musicube_api_client_ruby/models/genre_minimal_dto.rb +225 -0
  103. data/lib/musicube_api_client_ruby/models/genres_summary_dto.rb +248 -0
  104. data/lib/musicube_api_client_ruby/models/init_put_recording_audio_dto.rb +238 -0
  105. data/lib/musicube_api_client_ruby/models/jwt_token_dto.rb +248 -0
  106. data/lib/musicube_api_client_ruby/models/login_dto.rb +257 -0
  107. data/lib/musicube_api_client_ruby/models/musical_features_dto.rb +1532 -0
  108. data/lib/musicube_api_client_ruby/models/p_line_dto.rb +234 -0
  109. data/lib/musicube_api_client_ruby/models/party_large_dto.rb +288 -0
  110. data/lib/musicube_api_client_ruby/models/party_small_dto.rb +239 -0
  111. data/lib/musicube_api_client_ruby/models/playlist_large_dto.rb +353 -0
  112. data/lib/musicube_api_client_ruby/models/product_medium_dto.rb +316 -0
  113. data/lib/musicube_api_client_ruby/models/product_party_dto.rb +236 -0
  114. data/lib/musicube_api_client_ruby/models/recording_for_similarity_search_dto.rb +239 -0
  115. data/lib/musicube_api_client_ruby/models/recording_genre_prediction_dto.rb +253 -0
  116. data/lib/musicube_api_client_ruby/models/recording_large_dto.rb +366 -0
  117. data/lib/musicube_api_client_ruby/models/recording_list_dto.rb +269 -0
  118. data/lib/musicube_api_client_ruby/models/recording_medium_dto.rb +340 -0
  119. data/lib/musicube_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +236 -0
  120. data/lib/musicube_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +248 -0
  121. data/lib/musicube_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +236 -0
  122. data/lib/musicube_api_client_ruby/models/recording_party_dto.rb +236 -0
  123. data/lib/musicube_api_client_ruby/models/recording_playlist_dto.rb +247 -0
  124. data/lib/musicube_api_client_ruby/models/recording_small_dto.rb +268 -0
  125. data/lib/musicube_api_client_ruby/models/recording_tag_small_dto.rb +225 -0
  126. data/lib/musicube_api_client_ruby/models/save_file_recording_dto.rb +1847 -0
  127. data/lib/musicube_api_client_ruby/models/save_playlist_dto.rb +350 -0
  128. data/lib/musicube_api_client_ruby/models/save_recording_genre_dto.rb +243 -0
  129. data/lib/musicube_api_client_ruby/models/save_recording_party_dto.rb +273 -0
  130. data/lib/musicube_api_client_ruby/models/save_recording_playlist_dto.rb +248 -0
  131. data/lib/musicube_api_client_ruby/models/save_recording_tag_dto.rb +234 -0
  132. data/lib/musicube_api_client_ruby/models/save_referrer_dto.rb +229 -0
  133. data/lib/musicube_api_client_ruby/models/save_taggrams_dto.rb +574 -0
  134. data/lib/musicube_api_client_ruby/models/save_user_dto.rb +317 -0
  135. data/lib/musicube_api_client_ruby/models/search_filter_values_dto.rb +867 -0
  136. data/lib/musicube_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +270 -0
  137. data/lib/musicube_api_client_ruby/models/search_recording_granular_dto.rb +245 -0
  138. data/lib/musicube_api_client_ruby/models/sign_up_dto.rb +262 -0
  139. data/lib/musicube_api_client_ruby/models/tag_dto.rb +250 -0
  140. data/lib/musicube_api_client_ruby/models/tag_small_dto.rb +239 -0
  141. data/lib/musicube_api_client_ruby/models/taggram_dto.rb +271 -0
  142. data/lib/musicube_api_client_ruby/models/tags_summary_dto.rb +250 -0
  143. data/lib/musicube_api_client_ruby/models/tagstrength_dto.rb +269 -0
  144. data/lib/musicube_api_client_ruby/models/title_dto.rb +225 -0
  145. data/lib/musicube_api_client_ruby/models/token_request.rb +224 -0
  146. data/lib/musicube_api_client_ruby/models/track_to_medium_product_dto.rb +248 -0
  147. data/lib/musicube_api_client_ruby/models/update_password_dto.rb +238 -0
  148. data/lib/musicube_api_client_ruby/models/usage_dto.rb +220 -0
  149. data/lib/musicube_api_client_ruby/models/user_dto.rb +481 -0
  150. data/lib/musicube_api_client_ruby/version.rb +15 -0
  151. data/lib/musicube_api_client_ruby.rb +108 -0
  152. data/musicube_api_client_ruby.gemspec +39 -0
  153. data/openapi-generator-config.yaml +9 -0
  154. data/spec/api/allowed_values_api_spec.rb +68 -0
  155. data/spec/api/party_api_spec.rb +46 -0
  156. data/spec/api/playlist_api_spec.rb +72 -0
  157. data/spec/api/recording_api_spec.rb +192 -0
  158. data/spec/api/user_api_spec.rb +507 -0
  159. data/spec/api_client_spec.rb +223 -0
  160. data/spec/configuration_spec.rb +82 -0
  161. data/spec/models/category_medium_dto_spec.rb +46 -0
  162. data/spec/models/category_minimal_dto_spec.rb +34 -0
  163. data/spec/models/config_access_dto_spec.rb +48 -0
  164. data/spec/models/config_identifier_dto_spec.rb +40 -0
  165. data/spec/models/contributor_type_dto_spec.rb +34 -0
  166. data/spec/models/error_response_spec.rb +58 -0
  167. data/spec/models/field_summary_dto_spec.rb +46 -0
  168. data/spec/models/file_dto_spec.rb +142 -0
  169. data/spec/models/file_list_dto_spec.rb +52 -0
  170. data/spec/models/file_minimal_with_url_dto_spec.rb +46 -0
  171. data/spec/models/file_small_dto_spec.rb +130 -0
  172. data/spec/models/file_upload_dto_spec.rb +46 -0
  173. data/spec/models/file_w_ith_url_dto_spec.rb +40 -0
  174. data/spec/models/files_summary_dto_spec.rb +70 -0
  175. data/spec/models/forgot_password_dto_spec.rb +44 -0
  176. data/spec/models/genre_dto_spec.rb +40 -0
  177. data/spec/models/genre_minimal_dto_spec.rb +34 -0
  178. data/spec/models/genres_summary_dto_spec.rb +46 -0
  179. data/spec/models/init_put_recording_audio_dto_spec.rb +46 -0
  180. data/spec/models/jwt_token_dto_spec.rb +46 -0
  181. data/spec/models/login_dto_spec.rb +52 -0
  182. data/spec/models/musical_features_dto_spec.rb +706 -0
  183. data/spec/models/p_line_dto_spec.rb +40 -0
  184. data/spec/models/party_large_dto_spec.rb +76 -0
  185. data/spec/models/party_small_dto_spec.rb +40 -0
  186. data/spec/models/playlist_large_dto_spec.rb +98 -0
  187. data/spec/models/product_medium_dto_spec.rb +82 -0
  188. data/spec/models/product_party_dto_spec.rb +40 -0
  189. data/spec/models/recording_for_similarity_search_dto_spec.rb +40 -0
  190. data/spec/models/recording_genre_prediction_dto_spec.rb +46 -0
  191. data/spec/models/recording_large_dto_spec.rb +100 -0
  192. data/spec/models/recording_list_dto_spec.rb +52 -0
  193. data/spec/models/recording_medium_dto_spec.rb +88 -0
  194. data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +40 -0
  195. data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +46 -0
  196. data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +40 -0
  197. data/spec/models/recording_party_dto_spec.rb +40 -0
  198. data/spec/models/recording_playlist_dto_spec.rb +52 -0
  199. data/spec/models/recording_small_dto_spec.rb +52 -0
  200. data/spec/models/recording_tag_small_dto_spec.rb +34 -0
  201. data/spec/models/save_file_recording_dto_spec.rb +880 -0
  202. data/spec/models/save_playlist_dto_spec.rb +86 -0
  203. data/spec/models/save_recording_genre_dto_spec.rb +46 -0
  204. data/spec/models/save_recording_party_dto_spec.rb +44 -0
  205. data/spec/models/save_recording_playlist_dto_spec.rb +46 -0
  206. data/spec/models/save_recording_tag_dto_spec.rb +40 -0
  207. data/spec/models/save_referrer_dto_spec.rb +40 -0
  208. data/spec/models/save_taggrams_dto_spec.rb +226 -0
  209. data/spec/models/save_user_dto_spec.rb +72 -0
  210. data/spec/models/search_filter_values_dto_spec.rb +274 -0
  211. data/spec/models/search_recording_granular_abstraction_dto_spec.rb +44 -0
  212. data/spec/models/search_recording_granular_dto_spec.rb +46 -0
  213. data/spec/models/sign_up_dto_spec.rb +52 -0
  214. data/spec/models/tag_dto_spec.rb +46 -0
  215. data/spec/models/tag_small_dto_spec.rb +40 -0
  216. data/spec/models/taggram_dto_spec.rb +58 -0
  217. data/spec/models/tags_summary_dto_spec.rb +46 -0
  218. data/spec/models/tagstrength_dto_spec.rb +58 -0
  219. data/spec/models/title_dto_spec.rb +34 -0
  220. data/spec/models/token_request_spec.rb +34 -0
  221. data/spec/models/track_to_medium_product_dto_spec.rb +46 -0
  222. data/spec/models/update_password_dto_spec.rb +40 -0
  223. data/spec/models/usage_dto_spec.rb +34 -0
  224. data/spec/models/user_dto_spec.rb +148 -0
  225. data/spec/musicube_api_client_ruby_spec.rb +11 -0
  226. data/spec/spec_helper.rb +111 -0
  227. metadata +415 -0
data/docs/PartyApi.md ADDED
@@ -0,0 +1,75 @@
1
+ # MusicubeApiClientRuby::PartyApi
2
+
3
+ All URIs are relative to *https://api.songtradr.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**party**](PartyApi.md#party) | **GET** /api/v1/party | Information on a person, group or company. |
8
+
9
+
10
+ ## party
11
+
12
+ > <PartyLargeDTO> party(full_name)
13
+
14
+ Information on a person, group or company.
15
+
16
+ ### Examples
17
+
18
+ ```ruby
19
+ require 'time'
20
+ require 'musicube_api_client_ruby'
21
+ # setup authorization
22
+ MusicubeApiClientRuby.configure do |config|
23
+ # Configure Bearer authorization (JWT): bearer-jwt
24
+ config.access_token = 'YOUR_BEARER_TOKEN'
25
+ end
26
+
27
+ api_instance = MusicubeApiClientRuby::PartyApi.new
28
+ full_name = 'The Beatles' # String | Full Name of the person, group, company or organisation.
29
+
30
+ begin
31
+ # Information on a person, group or company.
32
+ result = api_instance.party(full_name)
33
+ p result
34
+ rescue MusicubeApiClientRuby::ApiError => e
35
+ puts "Error when calling PartyApi->party: #{e}"
36
+ end
37
+ ```
38
+
39
+ #### Using the party_with_http_info variant
40
+
41
+ This returns an Array which contains the response data, status code and headers.
42
+
43
+ > <Array(<PartyLargeDTO>, Integer, Hash)> party_with_http_info(full_name)
44
+
45
+ ```ruby
46
+ begin
47
+ # Information on a person, group or company.
48
+ data, status_code, headers = api_instance.party_with_http_info(full_name)
49
+ p status_code # => 2xx
50
+ p headers # => { ... }
51
+ p data # => <PartyLargeDTO>
52
+ rescue MusicubeApiClientRuby::ApiError => e
53
+ puts "Error when calling PartyApi->party_with_http_info: #{e}"
54
+ end
55
+ ```
56
+
57
+ ### Parameters
58
+
59
+ | Name | Type | Description | Notes |
60
+ | ---- | ---- | ----------- | ----- |
61
+ | **full_name** | **String** | Full Name of the person, group, company or organisation. | |
62
+
63
+ ### Return type
64
+
65
+ [**PartyLargeDTO**](PartyLargeDTO.md)
66
+
67
+ ### Authorization
68
+
69
+ [bearer-jwt](../README.md#bearer-jwt)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: Not defined
74
+ - **Accept**: application/json
75
+
@@ -0,0 +1,32 @@
1
+ # MusicubeApiClientRuby::PartyLargeDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | **String** | | |
8
+ | **birth_date** | **String** | | [optional] |
9
+ | **death_date** | **String** | | [optional] |
10
+ | **birth_year** | **String** | | [optional] |
11
+ | **death_year** | **String** | | [optional] |
12
+ | **birth_place** | **String** | | [optional] |
13
+ | **musicbrainz_type** | **String** | | [optional] |
14
+ | **area** | **String** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'musicube_api_client_ruby'
20
+
21
+ instance = MusicubeApiClientRuby::PartyLargeDTO.new(
22
+ full_name: null,
23
+ birth_date: null,
24
+ death_date: null,
25
+ birth_year: null,
26
+ death_year: null,
27
+ birth_place: null,
28
+ musicbrainz_type: null,
29
+ area: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,20 @@
1
+ # MusicubeApiClientRuby::PartySmallDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **full_name** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'musicube_api_client_ruby'
14
+
15
+ instance = MusicubeApiClientRuby::PartySmallDTO.new(
16
+ id: null,
17
+ full_name: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,221 @@
1
+ # MusicubeApiClientRuby::PlaylistApi
2
+
3
+ All URIs are relative to *https://api.songtradr.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**all_playlists**](PlaylistApi.md#all_playlists) | **GET** /api/v1/playlist | All playlists. |
8
+ | [**create_or_update_playlist**](PlaylistApi.md#create_or_update_playlist) | **POST** /api/v1/playlist | Create and edit playlist. |
9
+ | [**delete_playlist**](PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist. |
10
+
11
+
12
+ ## all_playlists
13
+
14
+ > <Array<PlaylistLargeDTO>> all_playlists(opts)
15
+
16
+ All playlists.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'musicube_api_client_ruby'
23
+ # setup authorization
24
+ MusicubeApiClientRuby.configure do |config|
25
+ # Configure Bearer authorization (JWT): bearer-jwt
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
27
+ end
28
+
29
+ api_instance = MusicubeApiClientRuby::PlaylistApi.new
30
+ opts = {
31
+ include_recordings: true, # Boolean | Whether a playlist shall include recordings or not.
32
+ ignore_usages: true, # Boolean | Whether a playlist shall include all songs regardless of their track usages.
33
+ usage_filter_mode: 'any', # String | Whether a playlist recordings shall include all playlist usages or not.
34
+ songtradr_playlist_guid: 'songtradr_playlist_guid_example' # String |
35
+ }
36
+
37
+ begin
38
+ # All playlists.
39
+ result = api_instance.all_playlists(opts)
40
+ p result
41
+ rescue MusicubeApiClientRuby::ApiError => e
42
+ puts "Error when calling PlaylistApi->all_playlists: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the all_playlists_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<Array<PlaylistLargeDTO>>, Integer, Hash)> all_playlists_with_http_info(opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # All playlists.
55
+ data, status_code, headers = api_instance.all_playlists_with_http_info(opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <Array<PlaylistLargeDTO>>
59
+ rescue MusicubeApiClientRuby::ApiError => e
60
+ puts "Error when calling PlaylistApi->all_playlists_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **include_recordings** | **Boolean** | Whether a playlist shall include recordings or not. | [optional][default to false] |
69
+ | **ignore_usages** | **Boolean** | Whether a playlist shall include all songs regardless of their track usages. | [optional][default to false] |
70
+ | **usage_filter_mode** | **String** | Whether a playlist recordings shall include all playlist usages or not. | [optional][default to &#39;any&#39;] |
71
+ | **songtradr_playlist_guid** | **String** | | [optional] |
72
+
73
+ ### Return type
74
+
75
+ [**Array&lt;PlaylistLargeDTO&gt;**](PlaylistLargeDTO.md)
76
+
77
+ ### Authorization
78
+
79
+ [bearer-jwt](../README.md#bearer-jwt)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
87
+ ## create_or_update_playlist
88
+
89
+ > Object create_or_update_playlist(save_playlist_dto)
90
+
91
+ Create and edit playlist.
92
+
93
+ This endpoint expects always the full amount of information including all recordings.
94
+
95
+ ### Examples
96
+
97
+ ```ruby
98
+ require 'time'
99
+ require 'musicube_api_client_ruby'
100
+ # setup authorization
101
+ MusicubeApiClientRuby.configure do |config|
102
+ # Configure Bearer authorization (JWT): bearer-jwt
103
+ config.access_token = 'YOUR_BEARER_TOKEN'
104
+ end
105
+
106
+ api_instance = MusicubeApiClientRuby::PlaylistApi.new
107
+ save_playlist_dto = MusicubeApiClientRuby::SavePlaylistDTO.new({songtradr_playlist_guid: 'songtradr_playlist_guid_example', name: 'name_example', state: 'active', usages: ['usages_example']}) # SavePlaylistDTO |
108
+
109
+ begin
110
+ # Create and edit playlist.
111
+ result = api_instance.create_or_update_playlist(save_playlist_dto)
112
+ p result
113
+ rescue MusicubeApiClientRuby::ApiError => e
114
+ puts "Error when calling PlaylistApi->create_or_update_playlist: #{e}"
115
+ end
116
+ ```
117
+
118
+ #### Using the create_or_update_playlist_with_http_info variant
119
+
120
+ This returns an Array which contains the response data, status code and headers.
121
+
122
+ > <Array(Object, Integer, Hash)> create_or_update_playlist_with_http_info(save_playlist_dto)
123
+
124
+ ```ruby
125
+ begin
126
+ # Create and edit playlist.
127
+ data, status_code, headers = api_instance.create_or_update_playlist_with_http_info(save_playlist_dto)
128
+ p status_code # => 2xx
129
+ p headers # => { ... }
130
+ p data # => Object
131
+ rescue MusicubeApiClientRuby::ApiError => e
132
+ puts "Error when calling PlaylistApi->create_or_update_playlist_with_http_info: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ | Name | Type | Description | Notes |
139
+ | ---- | ---- | ----------- | ----- |
140
+ | **save_playlist_dto** | [**SavePlaylistDTO**](SavePlaylistDTO.md) | | |
141
+
142
+ ### Return type
143
+
144
+ **Object**
145
+
146
+ ### Authorization
147
+
148
+ [bearer-jwt](../README.md#bearer-jwt)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## delete_playlist
157
+
158
+ > Object delete_playlist(songtradr_playlist_guid)
159
+
160
+ Delete playlist.
161
+
162
+ ### Examples
163
+
164
+ ```ruby
165
+ require 'time'
166
+ require 'musicube_api_client_ruby'
167
+ # setup authorization
168
+ MusicubeApiClientRuby.configure do |config|
169
+ # Configure Bearer authorization (JWT): bearer-jwt
170
+ config.access_token = 'YOUR_BEARER_TOKEN'
171
+ end
172
+
173
+ api_instance = MusicubeApiClientRuby::PlaylistApi.new
174
+ songtradr_playlist_guid = '1234' # String | ID of the file that should be deleted.
175
+
176
+ begin
177
+ # Delete playlist.
178
+ result = api_instance.delete_playlist(songtradr_playlist_guid)
179
+ p result
180
+ rescue MusicubeApiClientRuby::ApiError => e
181
+ puts "Error when calling PlaylistApi->delete_playlist: #{e}"
182
+ end
183
+ ```
184
+
185
+ #### Using the delete_playlist_with_http_info variant
186
+
187
+ This returns an Array which contains the response data, status code and headers.
188
+
189
+ > <Array(Object, Integer, Hash)> delete_playlist_with_http_info(songtradr_playlist_guid)
190
+
191
+ ```ruby
192
+ begin
193
+ # Delete playlist.
194
+ data, status_code, headers = api_instance.delete_playlist_with_http_info(songtradr_playlist_guid)
195
+ p status_code # => 2xx
196
+ p headers # => { ... }
197
+ p data # => Object
198
+ rescue MusicubeApiClientRuby::ApiError => e
199
+ puts "Error when calling PlaylistApi->delete_playlist_with_http_info: #{e}"
200
+ end
201
+ ```
202
+
203
+ ### Parameters
204
+
205
+ | Name | Type | Description | Notes |
206
+ | ---- | ---- | ----------- | ----- |
207
+ | **songtradr_playlist_guid** | **String** | ID of the file that should be deleted. | |
208
+
209
+ ### Return type
210
+
211
+ **Object**
212
+
213
+ ### Authorization
214
+
215
+ [bearer-jwt](../README.md#bearer-jwt)
216
+
217
+ ### HTTP request headers
218
+
219
+ - **Content-Type**: Not defined
220
+ - **Accept**: application/hal+json, application/json
221
+
@@ -0,0 +1,38 @@
1
+ # MusicubeApiClientRuby::PlaylistLargeDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **state** | **String** | | [optional] |
9
+ | **description** | **String** | | [optional] |
10
+ | **usages** | [**Array&lt;UsageDTO&gt;**](UsageDTO.md) | | [optional] |
11
+ | **created** | **Time** | | [optional] |
12
+ | **updated** | **Time** | | [optional] |
13
+ | **asset_url** | **String** | | [optional] |
14
+ | **pretzel_tier** | **String** | | [optional] |
15
+ | **usage** | **String** | | [optional] |
16
+ | **songtradr_playlist_guid** | **String** | | [optional] |
17
+ | **tracks** | [**Array&lt;RecordingPlaylistDTO&gt;**](RecordingPlaylistDTO.md) | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'musicube_api_client_ruby'
23
+
24
+ instance = MusicubeApiClientRuby::PlaylistLargeDTO.new(
25
+ name: null,
26
+ state: null,
27
+ description: null,
28
+ usages: null,
29
+ created: null,
30
+ updated: null,
31
+ asset_url: null,
32
+ pretzel_tier: null,
33
+ usage: null,
34
+ songtradr_playlist_guid: null,
35
+ tracks: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,34 @@
1
+ # MusicubeApiClientRuby::ProductMediumDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **duration** | **Time** | | [optional] |
8
+ | **gtin** | **String** | | [optional] |
9
+ | **grid** | **String** | | [optional] |
10
+ | **release_date** | **Time** | | [optional] |
11
+ | **takedown_date** | **Time** | | [optional] |
12
+ | **pline** | [**PLineDTO**](PLineDTO.md) | | [optional] |
13
+ | **genres** | [**Array&lt;GenreMinimalDTO&gt;**](GenreMinimalDTO.md) | | [optional] |
14
+ | **titles** | [**Array&lt;TitleDTO&gt;**](TitleDTO.md) | | [optional] |
15
+ | **parties** | [**Array&lt;ProductPartyDTO&gt;**](ProductPartyDTO.md) | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'musicube_api_client_ruby'
21
+
22
+ instance = MusicubeApiClientRuby::ProductMediumDTO.new(
23
+ duration: null,
24
+ gtin: null,
25
+ grid: null,
26
+ release_date: null,
27
+ takedown_date: null,
28
+ pline: null,
29
+ genres: null,
30
+ titles: null,
31
+ parties: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,20 @@
1
+ # MusicubeApiClientRuby::ProductPartyDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **party** | [**PartySmallDTO**](PartySmallDTO.md) | | |
8
+ | **contributor_types** | [**Array&lt;ContributorTypeDTO&gt;**](ContributorTypeDTO.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'musicube_api_client_ruby'
14
+
15
+ instance = MusicubeApiClientRuby::ProductPartyDTO.new(
16
+ party: null,
17
+ contributor_types: null
18
+ )
19
+ ```
20
+