songtradr_api_client_ruby 1.13.6 → 1.15.0

data/docs/RecordingApi.md

@@ -8,12 +8,9 @@ All URIs are relative to *https://api.songtradr.com*
 | [**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. |
 | [**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. |
 | [**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. |
-| [**recordings_large_by_ids**](RecordingApi.md#recordings_large_by_ids) | **GET** /api/v1/public/recording/l/{ids} | Recordings by IDs with a large response. |
 | [**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. |
-| [**recordings_small_by_ids**](RecordingApi.md#recordings_small_by_ids) | **GET** /api/v1/public/recording/s/{ids} | Recordings by IDs with a small response. |
 | [**search_recordings**](RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more. |
 | [**search_recordings_granular**](RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options. |
-| [**search_recordings_granular_abstraction**](RecordingApi.md#search_recordings_granular_abstraction) | **POST** /api/v1/public/recording/searchGranularAbstraction | Recordings by abstracted wordings and granular search options. |
 
 
 ## recordings_by_ids_with_musical_features
@@ -85,7 +82,7 @@ end
 
 ## recordings_by_ids_with_similarities
 
-> <Array<RecordingForSimilaritySearchDTO>> recordings_by_ids_with_similarities(ids)
+> <Array<RecordingForSimilaritySearchDTO>> recordings_by_ids_with_similarities(ids, opts)
 
 Similar recordings for a list of recordings.
 
@@ -102,10 +99,14 @@ end
 
 api_instance = SongtradrApiClientRuby::RecordingApi.new
 ids = 'USUM71703692' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
+opts = {
+  identical_only: true, # Boolean | Whether a result list shall include only identical recordings.
+  usage: 'usage_example' # String | Filter by recording usage.
+}
 
 begin
   # Similar recordings for a list of recordings.
-  result = api_instance.recordings_by_ids_with_similarities(ids)
+  result = api_instance.recordings_by_ids_with_similarities(ids, opts)
   p result
 rescue SongtradrApiClientRuby::ApiError => e
   puts "Error when calling RecordingApi->recordings_by_ids_with_similarities: #{e}"
@@ -116,12 +117,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<RecordingForSimilaritySearchDTO>>, Integer, Hash)> recordings_by_ids_with_similarities_with_http_info(ids)
+> <Array(<Array<RecordingForSimilaritySearchDTO>>, Integer, Hash)> recordings_by_ids_with_similarities_with_http_info(ids, opts)
 
 ```ruby
 begin
   # Similar recordings for a list of recordings.
-  data, status_code, headers = api_instance.recordings_by_ids_with_similarities_with_http_info(ids)
+  data, status_code, headers = api_instance.recordings_by_ids_with_similarities_with_http_info(ids, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<RecordingForSimilaritySearchDTO>>
@@ -135,6 +136,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs |  |
+| **identical_only** | **Boolean** | Whether a result list shall include only identical recordings. | [optional][default to false] |
+| **usage** | **String** | Filter by recording usage. | [optional] |
 
 ### Return type
 
@@ -304,73 +307,6 @@ end
 - **Accept**: application/json
 
 
-## recordings_large_by_ids
-
-> <Array<RecordingLargeDTO>> recordings_large_by_ids(ids)
-
-Recordings by IDs with a large response.
-
-### 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::RecordingApi.new
-ids = 'GBAYE1101181' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
-
-begin
-  # Recordings by IDs with a large response.
-  result = api_instance.recordings_large_by_ids(ids)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling RecordingApi->recordings_large_by_ids: #{e}"
-end
-```
-
-#### Using the recordings_large_by_ids_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<RecordingLargeDTO>>, Integer, Hash)> recordings_large_by_ids_with_http_info(ids)
-
-```ruby
-begin
-  # Recordings by IDs with a large response.
-  data, status_code, headers = api_instance.recordings_large_by_ids_with_http_info(ids)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<RecordingLargeDTO>>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling RecordingApi->recordings_large_by_ids_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs |  |
-
-### Return type
-
-[**Array&lt;RecordingLargeDTO&gt;**](RecordingLargeDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## recordings_medium_by_ids
 
 > <Array<RecordingMediumDTO>> recordings_medium_by_ids(ids, opts)
@@ -446,73 +382,6 @@ end
 - **Accept**: application/json
 
 
-## recordings_small_by_ids
-
-> <Array<RecordingSmallDTO>> recordings_small_by_ids(ids)
-
-Recordings by IDs with a small response.
-
-### 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::RecordingApi.new
-ids = 'GBAYE0200774' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
-
-begin
-  # Recordings by IDs with a small response.
-  result = api_instance.recordings_small_by_ids(ids)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling RecordingApi->recordings_small_by_ids: #{e}"
-end
-```
-
-#### Using the recordings_small_by_ids_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<RecordingSmallDTO>>, Integer, Hash)> recordings_small_by_ids_with_http_info(ids)
-
-```ruby
-begin
-  # Recordings by IDs with a small response.
-  data, status_code, headers = api_instance.recordings_small_by_ids_with_http_info(ids)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<RecordingSmallDTO>>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling RecordingApi->recordings_small_by_ids_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs |  |
-
-### Return type
-
-[**Array&lt;RecordingSmallDTO&gt;**](RecordingSmallDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## search_recordings
 
 > <RecordingListDTO> search_recordings(opts)
@@ -726,70 +595,3 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 
-
-## search_recordings_granular_abstraction
-
-> <RecordingListDTO> search_recordings_granular_abstraction(search_recording_granular_abstraction_dto)
-
-Recordings by abstracted wordings and granular search options.
-
-### 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::RecordingApi.new
-search_recording_granular_abstraction_dto = [SongtradrApiClientRuby::SearchRecordingGranularAbstractionDTO.new({abstraction_name: 'brandarchetypeInnocent'})] # Array<SearchRecordingGranularAbstractionDTO> | 
-
-begin
-  # Recordings by abstracted wordings and granular search options.
-  result = api_instance.search_recordings_granular_abstraction(search_recording_granular_abstraction_dto)
-  p result
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling RecordingApi->search_recordings_granular_abstraction: #{e}"
-end
-```
-
-#### Using the search_recordings_granular_abstraction_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto)
-
-```ruby
-begin
-  # Recordings by abstracted wordings and granular search options.
-  data, status_code, headers = api_instance.search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <RecordingListDTO>
-rescue SongtradrApiClientRuby::ApiError => e
-  puts "Error when calling RecordingApi->search_recordings_granular_abstraction_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **search_recording_granular_abstraction_dto** | [**Array&lt;SearchRecordingGranularAbstractionDTO&gt;**](SearchRecordingGranularAbstractionDTO.md) |  |  |
-
-### Return type
-
-[**RecordingListDTO**](RecordingListDTO.md)
-
-### Authorization
-
-[bearer-jwt](../README.md#bearer-jwt)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/RecordingMediumDTO.md

@@ -12,8 +12,8 @@
 | **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
 | **tracks** | [**Array<TrackDTO>**](TrackDTO.md) |  | [optional] |
 | **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) |  | [optional] |
-| **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) |  | [optional] |
 | **spotify_id** | **String** |  | [optional] |
+| **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) |  | [optional] |
 | **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) |  | [optional] |
 
 ## Example
@@ -30,8 +30,8 @@ instance = SongtradrApiClientRuby::RecordingMediumDTO.new(
   titles: null,
   tracks: null,
   musical_features: null,
-  tags: null,
   spotify_id: null,
+  tags: null,
   genre_predictions: null
 )
 ```

data/docs/RecordingSmallDTO.md

@@ -8,6 +8,7 @@
 | **isrc** | **String** |  |  |
 | **parties** | [**Array<RecordingPartyDTO>**](RecordingPartyDTO.md) |  | [optional] |
 | **titles** | [**Array<TitleDTO>**](TitleDTO.md) |  | [optional] |
+| **tracks** | [**Array<TrackDTO>**](TrackDTO.md) |  | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = SongtradrApiClientRuby::RecordingSmallDTO.new(
   duration: null,
   isrc: null,
   parties: null,
-  titles: null
+  titles: null,
+  tracks: null
 )
 ```
 

data/docs/TagDTO.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** |  |  |
-| **categories** | [**Array<CategoryMinimalDTO>**](CategoryMinimalDTO.md) |  | [optional] |
 | **name** | **String** |  |  |
+| **categories** | [**Array<CategoryMinimalDTO>**](CategoryMinimalDTO.md) |  | [optional] |
 
 ## Example
 
@@ -15,8 +15,8 @@ require 'songtradr_api_client_ruby'
 
 instance = SongtradrApiClientRuby::TagDTO.new(
   id: null,
-  categories: null,
-  name: null
+  name: null,
+  categories: null
 )
 ```