songtradr_api_client_ruby 1.13.5 → 1.13.6

data/docs/AdminUsersControllerApi.md

@@ -1,355 +0,0 @@
-# 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/ApiKeyDTO.md

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

data/docs/CreateApiKeyDTO.md

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

data/docs/InternalApiApi.md

@@ -1,149 +0,0 @@
-# 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/SaveFileDTO.md

@@ -1,42 +0,0 @@
-# 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
-)
-```
-