songtradr_api_client_ruby 1.12.21

data/docs/PartyLargeDTO.md

@@ -0,0 +1,32 @@
+# SongtradrApiClientRuby::PartyLargeDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** |  |  |
+| **birth_date** | **String** |  | [optional] |
+| **death_date** | **String** |  | [optional] |
+| **birth_year** | **String** |  | [optional] |
+| **death_year** | **String** |  | [optional] |
+| **birth_place** | **String** |  | [optional] |
+| **musicbrainz_type** | **String** |  | [optional] |
+| **area** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::PartyLargeDTO.new(
+  full_name: null,
+  birth_date: null,
+  death_date: null,
+  birth_year: null,
+  death_year: null,
+  birth_place: null,
+  musicbrainz_type: null,
+  area: null
+)
+```
+

data/docs/PartySmallDTO.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::PartySmallDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **full_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::PartySmallDTO.new(
+  id: null,
+  full_name: null
+)
+```
+

data/docs/PlaylistApi.md

@@ -0,0 +1,221 @@
+# SongtradrApiClientRuby::PlaylistApi
+
+All URIs are relative to *https://api.songtradr.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**all_playlists**](PlaylistApi.md#all_playlists) | **GET** /api/v1/playlist | All playlists. |
+| [**create_or_update_playlist**](PlaylistApi.md#create_or_update_playlist) | **POST** /api/v1/playlist | Create and edit playlist. |
+| [**delete_playlist**](PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist. |
+
+
+## all_playlists
+
+> <Array<PlaylistLargeDTO>> all_playlists(opts)
+
+All playlists.
+
+### Examples
+
+```ruby
+require 'time'
+require 'songtradr_api_client_ruby'
+# setup authorization
+SongtradrApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SongtradrApiClientRuby::PlaylistApi.new
+opts = {
+  include_recordings: true, # Boolean | Whether a playlist shall include recordings or not.
+  ignore_usages: true, # Boolean | Whether a playlist shall include all songs regardless of their track usages.
+  usage_filter_mode: 'any', # String | Whether a playlist recordings shall include all playlist usages or not.
+  songtradr_playlist_guid: 'songtradr_playlist_guid_example' # String | 
+}
+
+begin
+  # All playlists.
+  result = api_instance.all_playlists(opts)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->all_playlists: #{e}"
+end
+```
+
+#### Using the all_playlists_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<PlaylistLargeDTO>>, Integer, Hash)> all_playlists_with_http_info(opts)
+
+```ruby
+begin
+  # All playlists.
+  data, status_code, headers = api_instance.all_playlists_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<PlaylistLargeDTO>>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->all_playlists_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_recordings** | **Boolean** | Whether a playlist shall include recordings or not. | [optional][default to false] |
+| **ignore_usages** | **Boolean** | Whether a playlist shall include all songs regardless of their track usages. | [optional][default to false] |
+| **usage_filter_mode** | **String** | Whether a playlist recordings shall include all playlist usages or not. | [optional][default to &#39;any&#39;] |
+| **songtradr_playlist_guid** | **String** |  | [optional] |
+
+### Return type
+
+[**Array&lt;PlaylistLargeDTO&gt;**](PlaylistLargeDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_or_update_playlist
+
+> Object create_or_update_playlist(save_playlist_dto)
+
+Create and edit playlist.
+
+This endpoint expects always the full amount of information including all recordings.
+
+### Examples
+
+```ruby
+require 'time'
+require 'songtradr_api_client_ruby'
+# setup authorization
+SongtradrApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SongtradrApiClientRuby::PlaylistApi.new
+save_playlist_dto = SongtradrApiClientRuby::SavePlaylistDTO.new({songtradr_playlist_guid: 'songtradr_playlist_guid_example', name: 'name_example', state: 'active', usages: ['usages_example']}) # SavePlaylistDTO | 
+
+begin
+  # Create and edit playlist.
+  result = api_instance.create_or_update_playlist(save_playlist_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->create_or_update_playlist: #{e}"
+end
+```
+
+#### Using the create_or_update_playlist_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> create_or_update_playlist_with_http_info(save_playlist_dto)
+
+```ruby
+begin
+  # Create and edit playlist.
+  data, status_code, headers = api_instance.create_or_update_playlist_with_http_info(save_playlist_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->create_or_update_playlist_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_playlist_dto** | [**SavePlaylistDTO**](SavePlaylistDTO.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_playlist
+
+> Object delete_playlist(songtradr_playlist_guid)
+
+Delete playlist.
+
+### Examples
+
+```ruby
+require 'time'
+require 'songtradr_api_client_ruby'
+# setup authorization
+SongtradrApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SongtradrApiClientRuby::PlaylistApi.new
+songtradr_playlist_guid = '1234' # String | ID of the file that should be deleted.
+
+begin
+  # Delete playlist.
+  result = api_instance.delete_playlist(songtradr_playlist_guid)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->delete_playlist: #{e}"
+end
+```
+
+#### Using the delete_playlist_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_playlist_with_http_info(songtradr_playlist_guid)
+
+```ruby
+begin
+  # Delete playlist.
+  data, status_code, headers = api_instance.delete_playlist_with_http_info(songtradr_playlist_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->delete_playlist_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **songtradr_playlist_guid** | **String** | ID of the file that should be deleted. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/json
+

data/docs/PlaylistLargeDTO.md

@@ -0,0 +1,38 @@
+# SongtradrApiClientRuby::PlaylistLargeDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **state** | **String** |  | [optional] |
+| **created** | **Time** |  | [optional] |
+| **updated** | **Time** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **songtradr_playlist_guid** | **String** |  | [optional] |
+| **asset_url** | **String** |  | [optional] |
+| **pretzel_tier** | **String** |  | [optional] |
+| **usage** | **String** |  | [optional] |
+| **tracks** | [**Array<RecordingPlaylistDTO>**](RecordingPlaylistDTO.md) |  | [optional] |
+| **usages** | [**Array<UsageDTO>**](UsageDTO.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::PlaylistLargeDTO.new(
+  name: null,
+  state: null,
+  created: null,
+  updated: null,
+  description: null,
+  songtradr_playlist_guid: null,
+  asset_url: null,
+  pretzel_tier: null,
+  usage: null,
+  tracks: null,
+  usages: null
+)
+```
+

data/docs/ProductMediumDTO.md

@@ -0,0 +1,34 @@
+# SongtradrApiClientRuby::ProductMediumDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **duration** | **Time** |  | [optional] |
+| **pline** | [**PLineDTO**](PLineDTO.md) |  | [optional] |
+| **parties** | [**Array<ProductPartyDTO>**](ProductPartyDTO.md) |  | [optional] |
+| **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
+| **genres** | [**Array<GenreMinimalDTO>**](GenreMinimalDTO.md) |  | [optional] |
+| **gtin** | **String** |  | [optional] |
+| **grid** | **String** |  | [optional] |
+| **release_date** | **Time** |  | [optional] |
+| **takedown_date** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ProductMediumDTO.new(
+  duration: null,
+  pline: null,
+  parties: null,
+  titles: null,
+  genres: null,
+  gtin: null,
+  grid: null,
+  release_date: null,
+  takedown_date: null
+)
+```
+

data/docs/ProductPartyDTO.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::ProductPartyDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contributor_types** | [**Array<ContributorTypeDTO>**](ContributorTypeDTO.md) |  | [optional] |
+| **party** | [**PartySmallDTO**](PartySmallDTO.md) |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ProductPartyDTO.new(
+  contributor_types: null,
+  party: null
+)
+```
+