songtradr_api_client_ruby 1.13.4 → 1.13.5

data/docs/Pose.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::Pose
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **roll** | **Float** |  | [optional] |
+| **yaw** | **Float** |  | [optional] |
+| **pitch** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::Pose.new(
+  roll: null,
+  yaw: null,
+  pitch: null
+)
+```
+

data/docs/ProductMediumDTO.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **duration** | **Time** |  | [optional] |
-| **pline** | [**PLineDTO**](PLineDTO.md) |  | [optional] |
 | **genres** | [**Array<GenreMinimalDTO>**](GenreMinimalDTO.md) |  | [optional] |
 | **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
+| **pline** | [**PLineDTO**](PLineDTO.md) |  | [optional] |
 | **gtin** | **String** |  | [optional] |
 | **grid** | **String** |  | [optional] |
 | **release_date** | **Time** |  | [optional] |
@@ -21,9 +21,9 @@ require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::ProductMediumDTO.new(
   duration: null,
-  pline: null,
   genres: null,
   titles: null,
+  pline: null,
   gtin: null,
   grid: null,
   release_date: null,

data/docs/ProductPartyDTO.md

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

data/docs/RecordingLargeDTO.md

@@ -5,17 +5,17 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **duration** | **Integer** |  | [optional] |
-| **isrc** | **String** |  |  |
-| **spotify_id** | **String** |  | [optional] |
-| **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) |  | [optional] |
-| **pline** | [**PLineDTO**](PLineDTO.md) |  | [optional] |
+| **parties** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) |  | [optional] |
 | **genres** | [**Array<GenreDTO>**](GenreDTO.md) |  | [optional] |
 | **language_of_performance** | **String** |  | [optional] |
 | **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
 | **tracks** | [**Array<TrackToMediumProductDTO>**](TrackToMediumProductDTO.md) |  | [optional] |
 | **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) |  | [optional] |
-| **parties** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) |  | [optional] |
+| **isrc** | **String** |  |  |
 | **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) |  | [optional] |
+| **spotify_id** | **String** |  | [optional] |
+| **pline** | [**PLineDTO**](PLineDTO.md) |  | [optional] |
+| **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) |  | [optional] |
 
 ## Example
 
@@ -24,17 +24,17 @@ require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::RecordingLargeDTO.new(
   duration: null,
-  isrc: null,
-  spotify_id: null,
-  genre_predictions: null,
-  pline: null,
+  parties: null,
   genres: null,
   language_of_performance: null,
   titles: null,
   tracks: null,
   musical_features: null,
-  parties: null,
-  tags: null
+  isrc: null,
+  tags: null,
+  spotify_id: null,
+  pline: null,
+  genre_predictions: null
 )
 ```
 

data/docs/RecordingMediumDTO.md

@@ -4,17 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **isrc** | **String** |  |  |
-| **spotify_id** | **String** |  | [optional] |
-| **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) |  | [optional] |
+| **recording_party_entities** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) |  | [optional] |
 | **genres** | [**Array<GenreDTO>**](GenreDTO.md) |  | [optional] |
 | **language_of_performance** | **String** |  | [optional] |
 | **release_date** | **Time** |  | [optional] |
 | **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
 | **tracks** | [**Array<TrackDTO>**](TrackDTO.md) |  | [optional] |
 | **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) |  | [optional] |
-| **recording_party_entities** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) |  | [optional] |
+| **isrc** | **String** |  |  |
 | **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) |  | [optional] |
+| **spotify_id** | **String** |  | [optional] |
+| **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) |  | [optional] |
 
 ## Example
 
@@ -22,17 +22,17 @@
 require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::RecordingMediumDTO.new(
-  isrc: null,
-  spotify_id: null,
-  genre_predictions: null,
+  recording_party_entities: null,
   genres: null,
   language_of_performance: null,
   release_date: null,
   titles: null,
   tracks: null,
   musical_features: null,
-  recording_party_entities: null,
-  tags: null
+  isrc: null,
+  tags: null,
+  spotify_id: null,
+  genre_predictions: null
 )
 ```
 

data/docs/RecordingMinimalWithMusicalFeaturesDTO.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **isrc** | **String** |  |  |
 | **musical_features** | [**Array<MusicalFeaturesDTO>**](MusicalFeaturesDTO.md) |  | [optional] |
+| **isrc** | **String** |  |  |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::RecordingMinimalWithMusicalFeaturesDTO.new(
-  isrc: null,
-  musical_features: null
+  musical_features: null,
+  isrc: null
 )
 ```
 

data/docs/RecordingPartyDTO.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **contributor_types** | [**Array<ContributorTypeDTO>**](ContributorTypeDTO.md) |  | [optional] |
 | **party** | [**PartySmallDTO**](PartySmallDTO.md) |  |  |
+| **contributor_types** | [**Array<ContributorTypeDTO>**](ContributorTypeDTO.md) |  | [optional] |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::RecordingPartyDTO.new(
-  contributor_types: null,
-  party: null
+  party: null,
+  contributor_types: null
 )
 ```
 

data/docs/RecordingSmallDTO.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **duration** | **Integer** |  | [optional] |
-| **isrc** | **String** |  |  |
-| **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
 | **parties** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) |  | [optional] |
+| **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
+| **isrc** | **String** |  |  |
 
 ## Example
 
@@ -16,9 +16,9 @@ require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::RecordingSmallDTO.new(
   duration: null,
-  isrc: null,
+  parties: null,
   titles: null,
-  parties: null
+  isrc: null
 )
 ```
 

data/docs/SaveFileDTO.md

@@ -0,0 +1,42 @@
+# SongtradrApiClientRuby::SaveFileDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **folder** | **String** |  | [optional] |
+| **extension** | **String** |  | [optional] |
+| **object_key** | **String** |  | [optional] |
+| **customer** | **String** |  | [optional] |
+| **upload_start_time** | **Time** |  | [optional] |
+| **upload_end_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** |  | [optional] |
+| **fingerprint_start_time** | **Time** |  | [optional] |
+| **fingerprint_end_time** | **Time** |  | [optional] |
+| **inference_status** | **String** |  | [optional] |
+| **inference_start_time** | **Time** |  | [optional] |
+| **inference_end_time** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::SaveFileDTO.new(
+  name: null,
+  folder: null,
+  extension: null,
+  object_key: null,
+  customer: 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
+)
+```
+

data/docs/SaveFileRecordingDTO.md

@@ -114,6 +114,8 @@
 | **proprietary_id_gema** | **String** |  | [optional] |
 | **title** | **String** |  | [optional] |
 | **version_title** | **String** |  | [optional] |
+| **context_kind** | **String** |  | [optional] |
+| **context_value** | [**ContextValue**](ContextValue.md) |  | [optional] |
 
 ## Example
 
@@ -230,7 +232,9 @@ instance = SongtradrApiClientRuby::SaveFileRecordingDTO.new(
   iswc: null,
   proprietary_id_gema: null,
   title: null,
-  version_title: null
+  version_title: null,
+  context_kind: null,
+  context_value: null
 )
 ```
 

data/docs/Smile.md

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

data/docs/Sunglasses.md

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

data/docs/UserApi.md

@@ -8,7 +8,9 @@ All URIs are relative to *https://api.songtradr.com*
 | [**delete_user_file**](UserApi.md#delete_user_file) | **DELETE** /api/v1/user/file/{objectKey} | Delete file. |
 | [**edit_me**](UserApi.md#edit_me) | **POST** /api/v1/user/me | Edit details for a logged-in user |
 | [**forgot_password**](UserApi.md#forgot_password) | **POST** /api/v1/user/forgot-password | Send a password reset email |
+| [**init_video_upload**](UserApi.md#init_video_upload) | **POST** /api/v1/user/file/{name}/initVideoUpload | Recognise and upload video. Responds with an object with recognition result. |
 | [**initiate_user_file_upload**](UserApi.md#initiate_user_file_upload) | **POST** /api/v1/user/file/{name}/initUpload | Initialize a file upload. Responds with an URL where the file can be uploaded. |
+| [**initiate_user_image_upload**](UserApi.md#initiate_user_image_upload) | **POST** /api/v1/user/file/{name}/initImageUpload | Recognise and upload image. Responds with an object with recognition result. |
 | [**login**](UserApi.md#login) | **POST** /api/v1/user/login | Login to generate a bearer token. |
 | [**me**](UserApi.md#me) | **GET** /api/v1/user/me | Details for a logged-in user |
 | [**recordings_by_folder_with_taggrams**](UserApi.md#recordings_by_folder_with_taggrams) | **GET** /api/v1/user/folder/{folderName}/taggrams | Timeseries of AI generated moods, musical features and more for recordings in your folder. |
@@ -295,6 +297,75 @@ end
 - **Accept**: application/hal+json, application/json
 
 
+## init_video_upload
+
+> <VideoRecognitionResponse> init_video_upload(name, url)
+
+Recognise and upload video. Responds with an object with recognition result.
+
+### 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::UserApi.new
+name = 'FileName.mp4' # String | The Name of the image that will be uploaded
+url = 'url_example' # String | 
+
+begin
+  # Recognise and upload video. Responds with an object with recognition result.
+  result = api_instance.init_video_upload(name, url)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->init_video_upload: #{e}"
+end
+```
+
+#### Using the init_video_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VideoRecognitionResponse>, Integer, Hash)> init_video_upload_with_http_info(name, url)
+
+```ruby
+begin
+  # Recognise and upload video. Responds with an object with recognition result.
+  data, status_code, headers = api_instance.init_video_upload_with_http_info(name, url)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VideoRecognitionResponse>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->init_video_upload_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The Name of the image that will be uploaded |  |
+| **url** | **String** |  |  |
+
+### Return type
+
+[**VideoRecognitionResponse**](VideoRecognitionResponse.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## initiate_user_file_upload
 
 > <InitPutRecordingAudioDTO> initiate_user_file_upload(name, folder, opts)
@@ -368,6 +439,75 @@ end
 - **Accept**: application/json
 
 
+## initiate_user_image_upload
+
+> <ImageRecognitionResponse> initiate_user_image_upload(name, url)
+
+Recognise and upload image. Responds with an object with recognition result.
+
+### 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::UserApi.new
+name = 'FileName.mp3' # String | The Name of the image that will be uploaded
+url = 'url_example' # String | 
+
+begin
+  # Recognise and upload image. Responds with an object with recognition result.
+  result = api_instance.initiate_user_image_upload(name, url)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->initiate_user_image_upload: #{e}"
+end
+```
+
+#### Using the initiate_user_image_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImageRecognitionResponse>, Integer, Hash)> initiate_user_image_upload_with_http_info(name, url)
+
+```ruby
+begin
+  # Recognise and upload image. Responds with an object with recognition result.
+  data, status_code, headers = api_instance.initiate_user_image_upload_with_http_info(name, url)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImageRecognitionResponse>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling UserApi->initiate_user_image_upload_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The Name of the image that will be uploaded |  |
+| **url** | **String** |  |  |
+
+### Return type
+
+[**ImageRecognitionResponse**](ImageRecognitionResponse.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## login
 
 > <JwtTokenDTO> login(login_dto)

data/docs/VideoRecognitionResponse.md

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