songtradr_api_client_ruby 1.13.3 → 1.13.5

data/docs/AdminUsersControllerApi.md

@@ -0,0 +1,355 @@
+# SongtradrApiClientRuby::AdminUsersControllerApi
+
+All URIs are relative to *https://api.songtradr.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_user**](AdminUsersControllerApi.md#create_user) | **POST** /api/v1/admin/users | create a user |
+| [**delete_user**](AdminUsersControllerApi.md#delete_user) | **DELETE** /api/v1/admin/users/{id} | delete a user |
+| [**get_user**](AdminUsersControllerApi.md#get_user) | **GET** /api/v1/admin/users/{id} | show details of a user |
+| [**get_users**](AdminUsersControllerApi.md#get_users) | **GET** /api/v1/admin/users | List users |
+| [**update_user**](AdminUsersControllerApi.md#update_user) | **PUT** /api/v1/admin/users/{id} | update a user |
+
+
+## create_user
+
+> <AdminApiUserDTO> create_user(admin_api_create_user_dto)
+
+create a user
+
+### 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::AdminUsersControllerApi.new
+admin_api_create_user_dto = SongtradrApiClientRuby::AdminApiCreateUserDTO.new({email: 'email_example', full_name: 'full_name_example'}) # AdminApiCreateUserDTO | 
+
+begin
+  # create a user
+  result = api_instance.create_user(admin_api_create_user_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->create_user: #{e}"
+end
+```
+
+#### Using the create_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiUserDTO>, Integer, Hash)> create_user_with_http_info(admin_api_create_user_dto)
+
+```ruby
+begin
+  # create a user
+  data, status_code, headers = api_instance.create_user_with_http_info(admin_api_create_user_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiUserDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->create_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin_api_create_user_dto** | [**AdminApiCreateUserDTO**](AdminApiCreateUserDTO.md) |  |  |
+
+### Return type
+
+[**AdminApiUserDTO**](AdminApiUserDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_user
+
+> Object delete_user(id)
+
+delete a user
+
+### 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::AdminUsersControllerApi.new
+id = 56 # Integer | 
+
+begin
+  # delete a user
+  result = api_instance.delete_user(id)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->delete_user: #{e}"
+end
+```
+
+#### Using the delete_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_user_with_http_info(id)
+
+```ruby
+begin
+  # delete a user
+  data, status_code, headers = api_instance.delete_user_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->delete_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user
+
+> <AdminApiUserDTO> get_user(id)
+
+show details of a user
+
+### 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::AdminUsersControllerApi.new
+id = 56 # Integer | 
+
+begin
+  # show details of a user
+  result = api_instance.get_user(id)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->get_user: #{e}"
+end
+```
+
+#### Using the get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiUserDTO>, Integer, Hash)> get_user_with_http_info(id)
+
+```ruby
+begin
+  # show details of a user
+  data, status_code, headers = api_instance.get_user_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiUserDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**AdminApiUserDTO**](AdminApiUserDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_users
+
+> <AdminApiUserDTO> get_users(opts)
+
+List users
+
+### 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::AdminUsersControllerApi.new
+opts = {
+  page: 56, # Integer | Zero-based page index (0..N)
+  size: 56, # Integer | The size of the page to be returned
+  sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
+}
+
+begin
+  # List users
+  result = api_instance.get_users(opts)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->get_users: #{e}"
+end
+```
+
+#### Using the get_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiUserDTO>, Integer, Hash)> get_users_with_http_info(opts)
+
+```ruby
+begin
+  # List users
+  data, status_code, headers = api_instance.get_users_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiUserDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->get_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
+| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
+| **sort** | [**Array&lt;String&gt;**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
+
+### Return type
+
+[**AdminApiUserDTO**](AdminApiUserDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_user
+
+> <AdminApiUserDTO> update_user(id, admin_api_update_user_dto)
+
+update a user
+
+### 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::AdminUsersControllerApi.new
+id = 56 # Integer | 
+admin_api_update_user_dto = SongtradrApiClientRuby::AdminApiUpdateUserDTO.new # AdminApiUpdateUserDTO | 
+
+begin
+  # update a user
+  result = api_instance.update_user(id, admin_api_update_user_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->update_user: #{e}"
+end
+```
+
+#### Using the update_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiUserDTO>, Integer, Hash)> update_user_with_http_info(id, admin_api_update_user_dto)
+
+```ruby
+begin
+  # update a user
+  data, status_code, headers = api_instance.update_user_with_http_info(id, admin_api_update_user_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiUserDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling AdminUsersControllerApi->update_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **admin_api_update_user_dto** | [**AdminApiUpdateUserDTO**](AdminApiUpdateUserDTO.md) |  |  |
+
+### Return type
+
+[**AdminApiUserDTO**](AdminApiUserDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AgeRange.md

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

data/docs/Beard.md

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

data/docs/BoundingBox.md

@@ -0,0 +1,24 @@
+# SongtradrApiClientRuby::BoundingBox
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **width** | **Float** |  | [optional] |
+| **height** | **Float** |  | [optional] |
+| **left** | **Float** |  | [optional] |
+| **top** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::BoundingBox.new(
+  width: null,
+  height: null,
+  left: null,
+  top: null
+)
+```
+

data/docs/ContextValue.md

@@ -0,0 +1,18 @@
+# SongtradrApiClientRuby::ContextValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trackids** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::ContextValue.new(
+  trackids: null
+)
+```
+

data/docs/CuratePlaylistDTO.md

@@ -0,0 +1,26 @@
+# SongtradrApiClientRuby::CuratePlaylistDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_data** | **Array<String>** |  | [optional] |
+| **usage_filter** | **String** |  | [optional] |
+| **numerical_filter** | **Hash<String, String>** |  | [optional] |
+| **category_filter** | **Hash<String, String>** |  | [optional] |
+| **first_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::CuratePlaylistDTO.new(
+  request_data: null,
+  usage_filter: null,
+  numerical_filter: null,
+  category_filter: null,
+  first_id: null
+)
+```
+

data/docs/CuratePlaylistResponseDTO.md

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

data/docs/DominantColor.md

@@ -0,0 +1,30 @@
+# SongtradrApiClientRuby::DominantColor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **red** | **Integer** |  | [optional] |
+| **blue** | **Integer** |  | [optional] |
+| **green** | **Integer** |  | [optional] |
+| **hex_code** | **String** |  | [optional] |
+| **simplified_color** | **String** |  | [optional] |
+| **pixel_percent** | **Float** |  | [optional] |
+| **csscolor** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::DominantColor.new(
+  red: null,
+  blue: null,
+  green: null,
+  hex_code: null,
+  simplified_color: null,
+  pixel_percent: null,
+  csscolor: null
+)
+```
+

data/docs/Emotion.md

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

data/docs/EyeDirection.md

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

data/docs/EyeOpen.md

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

data/docs/Eyeglasses.md

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

data/docs/FaceDetail.md

@@ -0,0 +1,50 @@
+# SongtradrApiClientRuby::FaceDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bounding_box** | [**BoundingBox**](BoundingBox.md) |  | [optional] |
+| **age_range** | [**AgeRange**](AgeRange.md) |  | [optional] |
+| **smile** | [**Smile**](Smile.md) |  | [optional] |
+| **eyeglasses** | [**Eyeglasses**](Eyeglasses.md) |  | [optional] |
+| **sunglasses** | [**Sunglasses**](Sunglasses.md) |  | [optional] |
+| **gender** | [**Gender**](Gender.md) |  | [optional] |
+| **beard** | [**Beard**](Beard.md) |  | [optional] |
+| **mustache** | [**Mustache**](Mustache.md) |  | [optional] |
+| **eyes_open** | [**EyeOpen**](EyeOpen.md) |  | [optional] |
+| **mouth_open** | [**MouthOpen**](MouthOpen.md) |  | [optional] |
+| **emotions** | [**Array<Emotion>**](Emotion.md) |  | [optional] |
+| **landmarks** | [**Array<Landmark>**](Landmark.md) |  | [optional] |
+| **pose** | [**Pose**](Pose.md) |  | [optional] |
+| **quality** | [**ImageQuality**](ImageQuality.md) |  | [optional] |
+| **confidence** | **Float** |  | [optional] |
+| **face_occluded** | [**FaceOccluded**](FaceOccluded.md) |  | [optional] |
+| **eye_direction** | [**EyeDirection**](EyeDirection.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FaceDetail.new(
+  bounding_box: null,
+  age_range: null,
+  smile: null,
+  eyeglasses: null,
+  sunglasses: null,
+  gender: null,
+  beard: null,
+  mustache: null,
+  eyes_open: null,
+  mouth_open: null,
+  emotions: null,
+  landmarks: null,
+  pose: null,
+  quality: null,
+  confidence: null,
+  face_occluded: null,
+  eye_direction: null
+)
+```
+

data/docs/FaceDetection.md

@@ -0,0 +1,20 @@
+# SongtradrApiClientRuby::FaceDetection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** |  | [optional] |
+| **face** | [**FaceDetail**](FaceDetail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::FaceDetection.new(
+  timestamp: null,
+  face: null
+)
+```
+

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
+)
+```
+