songtradr_api_client_ruby 1.12.21

data/docs/FieldSummaryDTO.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::FieldSummaryDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_value** | **String** |  |  |
+| **total** | **Integer** |  |  |
+| **field_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FieldSummaryDTO.new(
+  field_value: null,
+  total: null,
+  field_name: null
+)
+```
+

data/docs/FileDTO.md

@@ -0,0 +1,50 @@
+# SongtradrApiClientRuby::FileDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **name** | **String** |  |  |
+| **object_key** | **String** |  |  |
+| **folder** | **String** |  |  |
+| **extension** | **String** | extension of the file |  |
+| **url** | **String** |  | [optional] |
+| **upload_start_time** | **Time** |  | [optional] |
+| **upload_end_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
+| **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] |
+| **recording** | [**RecordingMediumDTO**](RecordingMediumDTO.md) |  | [optional] |
+| **error_time** | **Time** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FileDTO.new(
+  id: null,
+  name: null,
+  object_key: null,
+  folder: null,
+  extension: null,
+  url: 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,
+  recording: null,
+  error_time: null,
+  error_message: null
+)
+```
+

data/docs/FileListDTO.md

@@ -0,0 +1,24 @@
+# SongtradrApiClientRuby::FileListDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **files** | [**Array<FileDTO>**](FileDTO.md) |  |  |
+| **has_next_page** | **Boolean** |  |  |
+| **current_page_number** | **Integer** |  |  |
+| **total_results** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FileListDTO.new(
+  files: null,
+  has_next_page: null,
+  current_page_number: null,
+  total_results: null
+)
+```
+

data/docs/FileMinimalWithUrlDTO.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::FileMinimalWithUrlDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_name** | **String** |  |  |
+| **url** | **String** |  |  |
+| **isrc** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FileMinimalWithUrlDTO.new(
+  file_name: null,
+  url: null,
+  isrc: null
+)
+```
+

data/docs/FileSmallDTO.md

@@ -0,0 +1,46 @@
+# SongtradrApiClientRuby::FileSmallDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **id** | **Integer** |  |  |
+| **extension** | **String** | extension of the file |  |
+| **error_message** | **String** |  | [optional] |
+| **object_key** | **String** |  |  |
+| **upload_start_time** | **Time** |  | [optional] |
+| **upload_end_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
+| **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] |
+| **folder** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FileSmallDTO.new(
+  name: null,
+  id: null,
+  extension: null,
+  error_message: 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,
+  folder: null
+)
+```
+

data/docs/FileUploadDTO.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::FileUploadDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifiers** | [**Array<ConfigIdentifierDTO>**](ConfigIdentifierDTO.md) |  | [optional] |
+| **flags** | **Array<String>** |  | [optional] |
+| **access** | [**Array<ConfigAccessDTO>**](ConfigAccessDTO.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FileUploadDTO.new(
+  identifiers: null,
+  flags: null,
+  access: null
+)
+```
+

data/docs/FileWIthUrlDTO.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::FileWIthUrlDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | [**FileDTO**](FileDTO.md) |  |  |
+| **url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FileWIthUrlDTO.new(
+  file: null,
+  url: null
+)
+```
+

data/docs/FilesSummaryDTO.md

@@ -0,0 +1,30 @@
+# SongtradrApiClientRuby::FilesSummaryDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_details_summary** | [**Array<FieldSummaryDTO>**](FieldSummaryDTO.md) |  | [optional] |
+| **genre_summary** | [**Array<GenresSummaryDTO>**](GenresSummaryDTO.md) |  | [optional] |
+| **tag_summary** | [**Array<TagsSummaryDTO>**](TagsSummaryDTO.md) |  | [optional] |
+| **musical_features_summary** | [**Array<FieldSummaryDTO>**](FieldSummaryDTO.md) |  | [optional] |
+| **total_files** | **Integer** |  |  |
+| **bpm_min** | **Float** |  | [optional] |
+| **bpm_max** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FilesSummaryDTO.new(
+  file_details_summary: null,
+  genre_summary: null,
+  tag_summary: null,
+  musical_features_summary: null,
+  total_files: null,
+  bpm_min: null,
+  bpm_max: null
+)
+```
+

data/docs/ForgotPasswordDTO.md

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

data/docs/GenreDTO.md

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

data/docs/GenreMinimalDTO.md

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

data/docs/GenresSummaryDTO.md

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

data/docs/InitPutRecordingAudioDTO.md

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

data/docs/JwtTokenDTO.md

@@ -0,0 +1,22 @@
+# SongtradrApiClientRuby::JwtTokenDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jwt_token** | **String** |  |  |
+| **expiration_date** | **Time** |  |  |
+| **refresh_token** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::JwtTokenDTO.new(
+  jwt_token: null,
+  expiration_date: null,
+  refresh_token: null
+)
+```
+

data/docs/LoginDTO.md

@@ -0,0 +1,24 @@
+# SongtradrApiClientRuby::LoginDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::LoginDTO.new(
+  username: null,
+  version: null,
+  email: null,
+  password: null
+)
+```
+

data/docs/MusicalFeaturesDTO.md

@@ -0,0 +1,186 @@
+# SongtradrApiClientRuby::MusicalFeaturesDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **space** | **String** | Search for space | [optional] |
+| **curateability** | **String** | Search for curatebility | [optional] |
+| **use_case** | **String** | Search for use case | [optional] |
+| **channel_suitability** | **String** | Search for social media suitability | [optional] |
+| **arousal** | **String** | Search for an arousal | [optional] |
+| **dominant_instrument** | **String** | Search for a dominant instrument | [optional] |
+| **language_of_performance** | **String** |  | [optional] |
+| **energy** | **String** | Search for energy | [optional] |
+| **engagement** | **String** | Search for an engagement | [optional] |
+| **groovyness** | **String** | Search for groovyness | [optional] |
+| **harmony** | **String** | Search for a degree of harmoniousness | [optional] |
+| **pleasantness** | **String** | Search for pleasantness | [optional] |
+| **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] |
+| **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] |
+| **primary_mood_cluster_affinity** | **Float** |  | [optional] |
+| **secondary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
+| **secondary_mood_cluster_affinity** | **Float** |  | [optional] |
+| **tertiary_mood_cluster** | **String** | Search for a language of the lyrics | [optional] |
+| **tertiary_mood_cluster_affinity** | **Float** |  | [optional] |
+| **vocals_affinity** | **Float** |  | [optional] |
+| **bpm** | **Float** |  | [optional] |
+| **production_rating** | **String** |  | [optional] |
+| **production_rating_affinity** | **Float** |  | [optional] |
+| **performance_rating** | **String** |  | [optional] |
+| **performance_rating_affinity** | **Float** |  | [optional] |
+| **song_rating** | **String** |  | [optional] |
+| **song_rating_affinity** | **Float** |  | [optional] |
+| **audience_age** | **String** |  | [optional] |
+| **audience_age_affinity** | **Float** |  | [optional] |
+| **secondary_audience_age** | **String** |  | [optional] |
+| **secondary_audience_age_affinity** | **Float** |  | [optional] |
+| **tertiary_audience_age** | **String** |  | [optional] |
+| **tertiary_audience_age_affinity** | **Float** |  | [optional] |
+| **audience_gender** | **String** |  | [optional] |
+| **audience_gender_affinity** | **Float** |  | [optional] |
+| **dominant_instrument_affinity** | **Float** |  | [optional] |
+| **secondary_instrument** | **String** | Search for a dominant instrument | [optional] |
+| **secondary_instrument_affinity** | **Float** |  | [optional] |
+| **tertiary_instrument** | **String** | Search for a dominant instrument | [optional] |
+| **tertiary_instrument_affinity** | **Float** |  | [optional] |
+| **sound_generation_affinity** | **Float** |  | [optional] |
+| **rhythm_affinity** | **Float** |  | [optional] |
+| **primary_sound_character_affinity** | **Float** |  | [optional] |
+| **tonality_affinity** | **Float** |  | [optional] |
+| **audience_region_affinity** | **Float** |  | [optional] |
+| **secondary_audience_region** | **String** |  | [optional] |
+| **secondary_audience_region_affinity** | **Float** |  | [optional] |
+| **tertiary_audience_region** | **String** |  | [optional] |
+| **tertiary_audience_region_affinity** | **Float** |  | [optional] |
+| **origin_region** | **String** |  | [optional] |
+| **origin_region_affinity** | **Float** |  | [optional] |
+| **origin_decade_affinity** | **Float** |  | [optional] |
+| **language_of_performance_affinity** | **Float** |  | [optional] |
+| **curateability_affinity** | **Float** |  | [optional] |
+| **use_case_affinity** | **Float** |  | [optional] |
+| **industry_suitability** | **String** | Search for Industry suitability | [optional] |
+| **industry_suitability_affinity** | **Float** |  | [optional] |
+| **audience_region** | **String** |  | [optional] |
+| **valence_affinity** | **Float** |  | [optional] |
+| **arousal_affinity** | **Float** |  | [optional] |
+| **pleasantness_affinity** | **Float** |  | [optional] |
+| **engagement_affinity** | **Float** |  | [optional] |
+| **energy_affinity** | **Float** |  | [optional] |
+| **tempo_affinity** | **Float** |  | [optional] |
+| **scale_affinity** | **Float** |  | [optional] |
+| **timbre_affinity** | **Float** |  | [optional] |
+| **roughness_affinity** | **Float** |  | [optional] |
+| **harmony_affinity** | **Float** |  | [optional] |
+| **texture_affinity** | **Float** |  | [optional] |
+| **groovyness_affinity** | **Float** |  | [optional] |
+| **space_affinity** | **Float** |  | [optional] |
+| **key_affinity** | **Float** |  | [optional] |
+| **channel_suitability_affinity** | **Float** |  | [optional] |
+| **key** | **String** | Search for a harmonic key | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::MusicalFeaturesDTO.new(
+  space: null,
+  curateability: null,
+  use_case: null,
+  channel_suitability: null,
+  arousal: null,
+  dominant_instrument: null,
+  language_of_performance: null,
+  energy: null,
+  engagement: null,
+  groovyness: null,
+  harmony: null,
+  pleasantness: null,
+  primary_mood_cluster: null,
+  primary_sound_character: null,
+  rhythm: null,
+  roughness: null,
+  scale: null,
+  sound_generation: null,
+  tempo: null,
+  texture: null,
+  timbre: null,
+  tonality: null,
+  valence: null,
+  vocals: null,
+  origin_decade: null,
+  primary_mood_cluster_affinity: null,
+  secondary_mood_cluster: null,
+  secondary_mood_cluster_affinity: null,
+  tertiary_mood_cluster: null,
+  tertiary_mood_cluster_affinity: null,
+  vocals_affinity: null,
+  bpm: null,
+  production_rating: null,
+  production_rating_affinity: null,
+  performance_rating: null,
+  performance_rating_affinity: null,
+  song_rating: null,
+  song_rating_affinity: null,
+  audience_age: null,
+  audience_age_affinity: null,
+  secondary_audience_age: null,
+  secondary_audience_age_affinity: null,
+  tertiary_audience_age: null,
+  tertiary_audience_age_affinity: null,
+  audience_gender: null,
+  audience_gender_affinity: null,
+  dominant_instrument_affinity: null,
+  secondary_instrument: null,
+  secondary_instrument_affinity: null,
+  tertiary_instrument: null,
+  tertiary_instrument_affinity: null,
+  sound_generation_affinity: null,
+  rhythm_affinity: null,
+  primary_sound_character_affinity: null,
+  tonality_affinity: null,
+  audience_region_affinity: null,
+  secondary_audience_region: null,
+  secondary_audience_region_affinity: null,
+  tertiary_audience_region: null,
+  tertiary_audience_region_affinity: null,
+  origin_region: null,
+  origin_region_affinity: null,
+  origin_decade_affinity: null,
+  language_of_performance_affinity: null,
+  curateability_affinity: null,
+  use_case_affinity: null,
+  industry_suitability: null,
+  industry_suitability_affinity: null,
+  audience_region: null,
+  valence_affinity: null,
+  arousal_affinity: null,
+  pleasantness_affinity: null,
+  engagement_affinity: null,
+  energy_affinity: null,
+  tempo_affinity: null,
+  scale_affinity: null,
+  timbre_affinity: null,
+  roughness_affinity: null,
+  harmony_affinity: null,
+  texture_affinity: null,
+  groovyness_affinity: null,
+  space_affinity: null,
+  key_affinity: null,
+  channel_suitability_affinity: null,
+  key: null
+)
+```
+

data/docs/PLineDTO.md

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

data/docs/PartyApi.md

@@ -0,0 +1,75 @@
+# SongtradrApiClientRuby::PartyApi
+
+All URIs are relative to *https://api.songtradr.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**party**](PartyApi.md#party) | **GET** /api/v1/party | Information on a person, group or company. |
+
+
+## party
+
+> <PartyLargeDTO> party(full_name)
+
+Information on a person, group or company.
+
+### 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::PartyApi.new
+full_name = 'The Beatles' # String | Full Name of the person, group, company or organisation.
+
+begin
+  # Information on a person, group or company.
+  result = api_instance.party(full_name)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PartyApi->party: #{e}"
+end
+```
+
+#### Using the party_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PartyLargeDTO>, Integer, Hash)> party_with_http_info(full_name)
+
+```ruby
+begin
+  # Information on a person, group or company.
+  data, status_code, headers = api_instance.party_with_http_info(full_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PartyLargeDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling PartyApi->party_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full Name of the person, group, company or organisation. |  |
+
+### Return type
+
+[**PartyLargeDTO**](PartyLargeDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+