songtradr_api_client_ruby 1.13.4 → 1.13.5

data/docs/FaceOccluded.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::FaceOccluded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Boolean** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FaceOccluded.new(
+  value: null,
+  confidence: null
+)
+```
+

data/docs/FileSmallDTO.md

@@ -9,6 +9,9 @@
 | **extension** | **String** | extension of the file |  |
 | **error_message** | **String** |  | [optional] |
 | **folder** | **String** |  |  |
+| **inference_start_time** | **Time** |  | [optional] |
+| **inference_end_time** | **Time** |  | [optional] |
+| **error_time** | **Time** |  | [optional] |
 | **object_key** | **String** |  |  |
 | **upload_start_time** | **Time** |  | [optional] |
 | **upload_end_time** | **Time** |  | [optional] |
@@ -16,9 +19,6 @@
 | **fingerprint_start_time** | **Time** |  | [optional] |
 | **fingerprint_end_time** | **Time** |  | [optional] |
 | **inference_status** | **String** | status of the auto-tagging | [optional] |
-| **inference_start_time** | **Time** |  | [optional] |
-| **inference_end_time** | **Time** |  | [optional] |
-| **error_time** | **Time** |  | [optional] |
 
 ## Example
 
@@ -31,16 +31,16 @@ instance = SongtradrApiClientRuby::FileSmallDTO.new(
   extension: null,
   error_message: null,
   folder: null,
+  inference_start_time: null,
+  inference_end_time: null,
+  error_time: null,
   object_key: null,
   upload_start_time: null,
   upload_end_time: null,
   fingerprint_status: null,
   fingerprint_start_time: null,
   fingerprint_end_time: null,
-  inference_status: null,
-  inference_start_time: null,
-  inference_end_time: null,
-  error_time: null
+  inference_status: null
 )
 ```
 

data/docs/Gender.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::Gender
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Gender.new(
+  value: null,
+  confidence: null
+)
+```
+

data/docs/ImageQuality.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::ImageQuality
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **brightness** | **Float** |  | [optional] |
+| **sharpness** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ImageQuality.new(
+  brightness: null,
+  sharpness: null
+)
+```
+

data/docs/ImageRecognitionResponse.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::ImageRecognitionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **labels** | [**Array<Label>**](Label.md) |  | [optional] |
+| **faces** | [**Array<FaceDetail>**](FaceDetail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ImageRecognitionResponse.new(
+  labels: null,
+  faces: null
+)
+```
+

data/docs/Instance.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::Instance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bounding_box** | [**BoundingBox**](BoundingBox.md) |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+| **dominant_colors** | [**Array<DominantColor>**](DominantColor.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Instance.new(
+  bounding_box: null,
+  confidence: null,
+  dominant_colors: null
+)
+```
+

data/docs/InternalApiApi.md

@@ -0,0 +1,149 @@
+# SongtradrApiClientRuby::InternalApiApi
+
+All URIs are relative to *https://api.songtradr.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**internal_create_inference**](InternalApiApi.md#internal_create_inference) | **POST** /api/v1/internal/inference |  |
+| [**internal_update_file**](InternalApiApi.md#internal_update_file) | **PATCH** /api/v1/internal/file/{customerName}/{objectKey} |  |
+
+
+## internal_create_inference
+
+> Object internal_create_inference(authorization, save_file_recording_dto)
+
+
+
+### 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::InternalApiApi.new
+authorization = 'authorization_example' # String | 
+save_file_recording_dto = [SongtradrApiClientRuby::SaveFileRecordingDTO.new({isrc: 'isrc_example', created_by_version: 'created_by_version_example'})] # Array<SaveFileRecordingDTO> | 
+
+begin
+  
+  result = api_instance.internal_create_inference(authorization, save_file_recording_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling InternalApiApi->internal_create_inference: #{e}"
+end
+```
+
+#### Using the internal_create_inference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> internal_create_inference_with_http_info(authorization, save_file_recording_dto)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.internal_create_inference_with_http_info(authorization, save_file_recording_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling InternalApiApi->internal_create_inference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization** | **String** |  |  |
+| **save_file_recording_dto** | [**Array&lt;SaveFileRecordingDTO&gt;**](SaveFileRecordingDTO.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## internal_update_file
+
+> Object internal_update_file(customer_name, object_key, save_file_dto)
+
+
+
+### 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::InternalApiApi.new
+customer_name = 'customer_name_example' # String | 
+object_key = 'object_key_example' # String | 
+save_file_dto = SongtradrApiClientRuby::SaveFileDTO.new # SaveFileDTO | 
+
+begin
+  
+  result = api_instance.internal_update_file(customer_name, object_key, save_file_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling InternalApiApi->internal_update_file: #{e}"
+end
+```
+
+#### Using the internal_update_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> internal_update_file_with_http_info(customer_name, object_key, save_file_dto)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.internal_update_file_with_http_info(customer_name, object_key, save_file_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling InternalApiApi->internal_update_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_name** | **String** |  |  |
+| **object_key** | **String** |  |  |
+| **save_file_dto** | [**SaveFileDTO**](SaveFileDTO.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Label.md

@@ -0,0 +1,28 @@
+# SongtradrApiClientRuby::Label
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+| **instances** | [**Array<Instance>**](Instance.md) |  | [optional] |
+| **parents** | [**Array<Parent>**](Parent.md) |  | [optional] |
+| **aliases** | [**Array<LabelAlias>**](LabelAlias.md) |  | [optional] |
+| **categories** | [**Array<LabelCategory>**](LabelCategory.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Label.new(
+  name: null,
+  confidence: null,
+  instances: null,
+  parents: null,
+  aliases: null,
+  categories: null
+)
+```
+

data/docs/LabelAlias.md

@@ -0,0 +1,18 @@
+# SongtradrApiClientRuby::LabelAlias
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::LabelAlias.new(
+  name: null
+)
+```
+

data/docs/LabelCategory.md

@@ -0,0 +1,18 @@
+# SongtradrApiClientRuby::LabelCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::LabelCategory.new(
+  name: null
+)
+```
+

data/docs/LabelDetection.md

@@ -0,0 +1,26 @@
+# SongtradrApiClientRuby::LabelDetection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** |  | [optional] |
+| **label** | [**Label**](Label.md) |  | [optional] |
+| **start_timestamp_millis** | **Integer** |  | [optional] |
+| **end_timestamp_millis** | **Integer** |  | [optional] |
+| **duration_millis** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::LabelDetection.new(
+  timestamp: null,
+  label: null,
+  start_timestamp_millis: null,
+  end_timestamp_millis: null,
+  duration_millis: null
+)
+```
+

data/docs/Landmark.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::Landmark
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **x** | **Float** |  | [optional] |
+| **y** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Landmark.new(
+  type: null,
+  x: null,
+  y: null
+)
+```
+

data/docs/MouthOpen.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::MouthOpen
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Boolean** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::MouthOpen.new(
+  value: null,
+  confidence: null
+)
+```
+

data/docs/MusicalFeaturesDTO.md

@@ -5,19 +5,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **space** | **String** | Search for space | [optional] |
-| **roughness** | **String** | Search for roughness | [optional] |
-| **scale** | **String** | Search for a tonal scale | [optional] |
-| **sound_generation** | **String** | Search for type of sound generation | [optional] |
-| **tempo** | **String** | Search for tempo | [optional] |
-| **texture** | **String** | Search for texture | [optional] |
-| **timbre** | **String** | Search for timbre | [optional] |
-| **tonality** | **String** | Search for tonality | [optional] |
-| **valence** | **String** | Search for a valence | [optional] |
-| **vocals** | **String** | Search for a vocal gender or instrumental songs | [optional] |
-| **origin_decade** | **String** | Search for origin decade | [optional] |
-| **curateability** | **String** | Search for curatebility | [optional] |
-| **use_case** | **String** | Search for use case | [optional] |
-| **channel_suitability** | **String** | Search for social media suitability | [optional] |
 | **language_of_performance** | **String** |  | [optional] |
 | **arousal** | **String** | Search for an arousal | [optional] |
 | **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
@@ -29,6 +16,10 @@
 | **primary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
 | **primary_sound_character** | **String** | Search for a sound character | [optional] |
 | **rhythm** | **String** | Search for rhythm | [optional] |
+| **roughness** | **String** | Search for roughness | [optional] |
+| **scale** | **String** | Search for a tonal scale | [optional] |
+| **sound_generation** | **String** | Search for type of sound generation | [optional] |
+| **tempo** | **String** | Search for tempo | [optional] |
 | **primary_mood_cluster_affinity** | **Float** |  | [optional] |
 | **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
 | **secondary_mood_cluster_affinity** | **Float** |  | [optional] |
@@ -73,6 +64,15 @@
 | **industry_suitability** | **String** | Search for Industry suitability | [optional] |
 | **industry_suitability_affinity** | **Float** |  | [optional] |
 | **audience_region** | **String** |  | [optional] |
+| **texture** | **String** | Search for texture | [optional] |
+| **timbre** | **String** | Search for timbre | [optional] |
+| **tonality** | **String** | Search for tonality | [optional] |
+| **valence** | **String** | Search for a valence | [optional] |
+| **vocals** | **String** | Search for a vocal gender or instrumental songs | [optional] |
+| **origin_decade** | **String** | Search for origin decade | [optional] |
+| **curateability** | **String** | Search for curatebility | [optional] |
+| **use_case** | **String** | Search for use case | [optional] |
+| **channel_suitability** | **String** | Search for social media suitability | [optional] |
 | **valence_affinity** | **Float** |  | [optional] |
 | **arousal_affinity** | **Float** |  | [optional] |
 | **pleasantness_affinity** | **Float** |  | [optional] |
@@ -97,19 +97,6 @@ require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
   space: null,
-  roughness: null,
-  scale: null,
-  sound_generation: null,
-  tempo: null,
-  texture: null,
-  timbre: null,
-  tonality: null,
-  valence: null,
-  vocals: null,
-  origin_decade: null,
-  curateability: null,
-  use_case: null,
-  channel_suitability: null,
   language_of_performance: null,
   arousal: null,
   dominant_instrument: null,
@@ -121,6 +108,10 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
   primary_mood_cluster: null,
   primary_sound_character: null,
   rhythm: null,
+  roughness: null,
+  scale: null,
+  sound_generation: null,
+  tempo: null,
   primary_mood_cluster_affinity: null,
   secondary_mood_cluster: null,
   secondary_mood_cluster_affinity: null,
@@ -165,6 +156,15 @@ instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
   industry_suitability: null,
   industry_suitability_affinity: null,
   audience_region: null,
+  texture: null,
+  timbre: null,
+  tonality: null,
+  valence: null,
+  vocals: null,
+  origin_decade: null,
+  curateability: null,
+  use_case: null,
+  channel_suitability: null,
   valence_affinity: null,
   arousal_affinity: null,
   pleasantness_affinity: null,

data/docs/Mustache.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::Mustache
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Boolean** |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Mustache.new(
+  value: null,
+  confidence: null
+)
+```
+

data/docs/Parent.md

@@ -0,0 +1,18 @@
+# SongtradrApiClientRuby::Parent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Parent.new(
+  name: null
+)
+```
+

data/docs/PlaylistApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.songtradr.com*
 | ------ | ------------ | ----------- |
 | [**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. |
+| [**curate_playlist**](PlaylistApi.md#curate_playlist) | **POST** /api/v1/playlist/{methodName} | Curate playlist. |
 | [**delete_playlist**](PlaylistApi.md#delete_playlist) | **DELETE** /api/v1/playlist/{songtradrPlaylistGuid} | Delete playlist. |
 
 
@@ -153,6 +154,75 @@ end
 - **Accept**: application/json
 
 
+## curate_playlist
+
+> <CuratePlaylistResponseDTO> curate_playlist(method_name, curate_playlist_dto)
+
+Curate 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
+method_name = 'RECOMMEND' # String | Name of the curation task that should be executed
+curate_playlist_dto = SongtradrApiClientRuby::CuratePlaylistDTO.new # CuratePlaylistDTO | 
+
+begin
+  # Curate playlist.
+  result = api_instance.curate_playlist(method_name, curate_playlist_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->curate_playlist: #{e}"
+end
+```
+
+#### Using the curate_playlist_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CuratePlaylistResponseDTO>, Integer, Hash)> curate_playlist_with_http_info(method_name, curate_playlist_dto)
+
+```ruby
+begin
+  # Curate playlist.
+  data, status_code, headers = api_instance.curate_playlist_with_http_info(method_name, curate_playlist_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CuratePlaylistResponseDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PlaylistApi->curate_playlist_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method_name** | **String** | Name of the curation task that should be executed |  |
+| **curate_playlist_dto** | [**CuratePlaylistDTO**](CuratePlaylistDTO.md) |  |  |
+
+### Return type
+
+[**CuratePlaylistResponseDTO**](CuratePlaylistResponseDTO.md)
+
+### 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)

data/docs/PlaylistLargeDTO.md

@@ -8,13 +8,13 @@
 | **state** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **songtradr_playlist_guid** | **String** |  | [optional] |
+| **usages** | [**Array<UsageDTO>**](UsageDTO.md) |  | [optional] |
 | **asset_url** | **String** |  | [optional] |
 | **pretzel_tier** | **String** |  | [optional] |
 | **usage** | **String** |  | [optional] |
 | **tracks** | [**Array<RecordingPlaylistDTO>**](RecordingPlaylistDTO.md) |  | [optional] |
 | **created** | **Time** |  | [optional] |
 | **updated** | **Time** |  | [optional] |
-| **usages** | [**Array<UsageDTO>**](UsageDTO.md) |  | [optional] |
 
 ## Example
 
@@ -26,13 +26,13 @@ instance = SongtradrApiClientRuby::PlaylistLargeDTO.new(
   state: null,
   description: null,
   songtradr_playlist_guid: null,
+  usages: null,
   asset_url: null,
   pretzel_tier: null,
   usage: null,
   tracks: null,
   created: null,
-  updated: null,
-  usages: null
+  updated: null
 )
 ```