songtradr_api_client_ruby 1.12.22 → 1.12.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9496e7db7452484fd349e9c0b8801a55995babe6369d12f5f9c0759cb7724ea8
-  data.tar.gz: c76963a03ad269009cdb5b6a3e43be94427afb208187430030ac9c8106b196de
+  metadata.gz: f66f5d36b93dd1a67f830deb98b9f9db2b28486bd1e53650c09beffdb6467005
+  data.tar.gz: 5130fd5e458a1606b6e23a5ba75ff0b5ec136cbc08170e1a6fbe547d2b573667
 SHA512:
-  metadata.gz: c6f8b98686bf5eaa89ba0dec350271d2384c3f88af348283a09df72976c4f698e5570d72fc31c00a05eed54188be3d795028a1d290e44682137f08a7550dca71
-  data.tar.gz: bbae3628a9c165262cdcd31e90b53ddc37484da4cab4d9038151468ec5081154d4f17189964d7a4e259f85fb91f169aa0ed307f7a70a870b76c64820bf791a39
+  metadata.gz: 73653116ee27dc261a3a549e859d1c3a32ecb6383e180cba33d07e9c872727997fdf7fd962c4db0c5288f390137c7a7fc4cfa236307dff5645a67fbf47a88fdc
+  data.tar.gz: 7e5b40ba2cbf318cb0ba53367f5ee91954743793e5397fbf8a368de5df2815721c96a6b2a13a1fb069401082126d926a469098acbc4b32f1442f0b6e996100c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    songtradr_api_client_ruby (1.12.22)
+    songtradr_api_client_ruby (1.12.24)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
 
@@ -12,7 +12,7 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    faraday (2.7.6)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
@@ -45,10 +45,10 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)

data/README.md

@@ -33,8 +33,8 @@ You can either search the released music via the /public/recording endpoints or
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.12.22
-- Package version: 1.12.22
+- API version: 1.12.24
+- Package version: 1.12.24
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://songtradr.com](https://songtradr.com)
 
@@ -51,16 +51,16 @@ gem build songtradr_api_client_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./songtradr_api_client_ruby-1.12.22.gem
+gem install ./songtradr_api_client_ruby-1.12.24.gem
 ```
 
-(for development, run `gem install --dev ./songtradr_api_client_ruby-1.12.22.gem` to install the development dependencies)
+(for development, run `gem install --dev ./songtradr_api_client_ruby-1.12.24.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'songtradr_api_client_ruby', '~> 1.12.22'
+    gem 'songtradr_api_client_ruby', '~> 1.12.24'
 
 ### Install from Git
 
@@ -84,17 +84,25 @@ Please follow the [installation](#installation) procedure and then run the follo
 # Load the gem
 require 'songtradr_api_client_ruby'
 
-api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
-opts = {
-  response_size: 's' # String | Size the response should have.
-}
+# Setup authorization
+SongtradrApiClientRuby.configure do |config|
+  # Configure Bearer authorization (JWT): bearer-jwt
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = SongtradrApiClientRuby::APIKeysApi.new
+create_api_key_dto = SongtradrApiClientRuby::CreateApiKeyDTO.new # CreateApiKeyDTO | 
 
 begin
-  #Allowed values for music descriptive parameters to be used in the searchAll endpoint.
-  result = api_instance.allowed_musical_features(opts)
+  #create an API key
+  result = api_instance.create_api_key(create_api_key_dto)
   p result
 rescue SongtradrApiClientRuby::ApiError => e
-  puts "Exception when calling AllowedValuesApi->allowed_musical_features: #{e}"
+  puts "Exception when calling APIKeysApi->create_api_key: #{e}"
 end
 
 ```
@@ -105,6 +113,9 @@ All URIs are relative to *https://api.songtradr.com*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*SongtradrApiClientRuby::APIKeysApi* | [**create_api_key**](docs/APIKeysApi.md#create_api_key) | **POST** /api/v1/user/apiKeys | create an API key
+*SongtradrApiClientRuby::APIKeysApi* | [**delete_api_key**](docs/APIKeysApi.md#delete_api_key) | **DELETE** /api/v1/user/apiKeys/{id} | delete an API key
+*SongtradrApiClientRuby::APIKeysApi* | [**get_api_keys**](docs/APIKeysApi.md#get_api_keys) | **GET** /api/v1/user/apiKeys | list API keys
 *SongtradrApiClientRuby::AllowedValuesApi* | [**allowed_musical_features**](docs/AllowedValuesApi.md#allowed_musical_features) | **GET** /api/v1/allowedValues/musicalFeatures | Allowed values for music descriptive parameters to be used in the searchAll endpoint.
 *SongtradrApiClientRuby::AllowedValuesApi* | [**genres**](docs/AllowedValuesApi.md#genres) | **GET** /api/v1/allowedValues/genre | Allowed values for genres.
 *SongtradrApiClientRuby::AllowedValuesApi* | [**tags**](docs/AllowedValuesApi.md#tags) | **GET** /api/v1/allowedValues/tag | All descriptive tags inside of tag-categories.
@@ -147,11 +158,14 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [SongtradrApiClientRuby::AdminApiUserDTO](docs/AdminApiUserDTO.md)
+ - [SongtradrApiClientRuby::ApiKeyDTO](docs/ApiKeyDTO.md)
  - [SongtradrApiClientRuby::CategoryMediumDTO](docs/CategoryMediumDTO.md)
  - [SongtradrApiClientRuby::CategoryMinimalDTO](docs/CategoryMinimalDTO.md)
  - [SongtradrApiClientRuby::ConfigAccessDTO](docs/ConfigAccessDTO.md)
  - [SongtradrApiClientRuby::ConfigIdentifierDTO](docs/ConfigIdentifierDTO.md)
  - [SongtradrApiClientRuby::ContributorTypeDTO](docs/ContributorTypeDTO.md)
+ - [SongtradrApiClientRuby::CreateApiKeyDTO](docs/CreateApiKeyDTO.md)
  - [SongtradrApiClientRuby::ErrorResponse](docs/ErrorResponse.md)
  - [SongtradrApiClientRuby::FieldSummaryDTO](docs/FieldSummaryDTO.md)
  - [SongtradrApiClientRuby::FileDTO](docs/FileDTO.md)

data/docs/APIKeysApi.md

@@ -0,0 +1,217 @@
+# SongtradrApiClientRuby::APIKeysApi
+
+All URIs are relative to *https://api.songtradr.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api/v1/user/apiKeys | create an API key |
+| [**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api/v1/user/apiKeys/{id} | delete an API key |
+| [**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api/v1/user/apiKeys | list API keys |
+
+
+## create_api_key
+
+> <AdminApiUserDTO> create_api_key(create_api_key_dto)
+
+create an API key
+
+### 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::APIKeysApi.new
+create_api_key_dto = SongtradrApiClientRuby::CreateApiKeyDTO.new # CreateApiKeyDTO | 
+
+begin
+  # create an API key
+  result = api_instance.create_api_key(create_api_key_dto)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling APIKeysApi->create_api_key: #{e}"
+end
+```
+
+#### Using the create_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AdminApiUserDTO>, Integer, Hash)> create_api_key_with_http_info(create_api_key_dto)
+
+```ruby
+begin
+  # create an API key
+  data, status_code, headers = api_instance.create_api_key_with_http_info(create_api_key_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AdminApiUserDTO>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling APIKeysApi->create_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_api_key_dto** | [**CreateApiKeyDTO**](CreateApiKeyDTO.md) |  |  |
+
+### Return type
+
+[**AdminApiUserDTO**](AdminApiUserDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_api_key
+
+> Object delete_api_key(id)
+
+delete an API key
+
+### 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::APIKeysApi.new
+id = 'id_example' # String | 
+
+begin
+  # delete an API key
+  result = api_instance.delete_api_key(id)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling APIKeysApi->delete_api_key: #{e}"
+end
+```
+
+#### Using the delete_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_api_key_with_http_info(id)
+
+```ruby
+begin
+  # delete an API key
+  data, status_code, headers = api_instance.delete_api_key_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling APIKeysApi->delete_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_api_keys
+
+> <Array<ApiKeyDTO>> get_api_keys(opts)
+
+list API keys
+
+### 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::APIKeysApi.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 API keys
+  result = api_instance.get_api_keys(opts)
+  p result
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling APIKeysApi->get_api_keys: #{e}"
+end
+```
+
+#### Using the get_api_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> get_api_keys_with_http_info(opts)
+
+```ruby
+begin
+  # list API keys
+  data, status_code, headers = api_instance.get_api_keys_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ApiKeyDTO>>
+rescue SongtradrApiClientRuby::ApiError => e
+  puts "Error when calling APIKeysApi->get_api_keys_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
+
+[**Array&lt;ApiKeyDTO&gt;**](ApiKeyDTO.md)
+
+### Authorization
+
+[bearer-jwt](../README.md#bearer-jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AdminApiUserDTO.md

@@ -0,0 +1,70 @@
+# SongtradrApiClientRuby::AdminApiUserDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **username** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **full_name** | **String** |  | [optional] |
+| **language** | **String** |  | [optional] |
+| **is_admin** | **Boolean** |  | [optional] |
+| **widgets_allowed** | **Boolean** |  | [optional] |
+| **full_search_allowed** | **Boolean** |  | [optional] |
+| **voice_search_allowed** | **Boolean** |  | [optional] |
+| **recording_detail_allowed** | **Boolean** |  | [optional] |
+| **artist_detail_allowed** | **Boolean** |  | [optional] |
+| **playlist_prediction_allowed** | **Boolean** |  | [optional] |
+| **signup_allowed** | **Boolean** |  | [optional] |
+| **upload_allowed** | **Boolean** |  | [optional] |
+| **fingerprint_allowed** | **Boolean** |  | [optional] |
+| **audiotagging_allowed** | **Boolean** |  | [optional] |
+| **b2b_allowed** | **Boolean** |  | [optional] |
+| **editor_allowed** | **Boolean** |  | [optional] |
+| **reduced_musical_features** | **Boolean** |  | [optional] |
+| **confirmed** | **Boolean** |  | [optional] |
+| **gdpr_confirmation_timestamp** | **Time** |  | [optional] |
+| **last_login** | **Time** |  | [optional] |
+| **total_logins** | **Integer** |  | [optional] |
+| **total_searches** | **Integer** |  | [optional] |
+| **total_uploads** | **Integer** |  | [optional] |
+| **total_downloads** | **Integer** |  | [optional] |
+| **total_updates** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'songtradr_api_client_ruby'
+
+instance = SongtradrApiClientRuby::AdminApiUserDTO.new(
+  id: null,
+  username: null,
+  email: null,
+  full_name: null,
+  language: null,
+  is_admin: null,
+  widgets_allowed: null,
+  full_search_allowed: null,
+  voice_search_allowed: null,
+  recording_detail_allowed: null,
+  artist_detail_allowed: null,
+  playlist_prediction_allowed: null,
+  signup_allowed: null,
+  upload_allowed: null,
+  fingerprint_allowed: null,
+  audiotagging_allowed: null,
+  b2b_allowed: null,
+  editor_allowed: null,
+  reduced_musical_features: null,
+  confirmed: null,
+  gdpr_confirmation_timestamp: null,
+  last_login: null,
+  total_logins: null,
+  total_searches: null,
+  total_uploads: null,
+  total_downloads: null,
+  total_updates: null
+)
+```
+

data/docs/AllowedValuesApi.md

@@ -86,7 +86,7 @@ require 'time'
 require 'songtradr_api_client_ruby'
 
 api_instance = SongtradrApiClientRuby::AllowedValuesApi.new
-genre_type = 'level1Genre' # String | Type of the response should have.
+genre_type = 'musicubeLevel1Genre' # String | Type of the response should have.  Deprecated: level1Genre, level2Genre - use musicubeLevel1Genre, musicubeLevel2Genre instead.
 
 begin
   # Allowed values for genres.
@@ -119,7 +119,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **genre_type** | **String** | Type of the response should have. |  |
+| **genre_type** | **String** | Type of the response should have.  Deprecated: level1Genre, level2Genre - use musicubeLevel1Genre, musicubeLevel2Genre instead. |  |
 
 ### Return type
 

data/docs/ApiKeyDTO.md

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

data/docs/CreateApiKeyDTO.md

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

@@ -8,17 +8,17 @@
 | **id** | **Integer** |  |  |
 | **extension** | **String** | extension of the file |  |
 | **error_message** | **String** |  | [optional] |
-| **folder** | **String** |  |  |
-| **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] |
+| **error_time** | **Time** |  | [optional] |
 | **fingerprint_end_time** | **Time** |  | [optional] |
-| **inference_status** | **String** | status of the auto-tagging | [optional] |
 | **inference_start_time** | **Time** |  | [optional] |
+| **fingerprint_start_time** | **Time** |  | [optional] |
+| **fingerprint_status** | **String** | status of the audio recognition | [optional] |
+| **inference_status** | **String** | status of the auto-tagging | [optional] |
 | **inference_end_time** | **Time** |  | [optional] |
-| **error_time** | **Time** |  | [optional] |
+| **folder** | **String** |  |  |
+| **upload_end_time** | **Time** |  | [optional] |
+| **upload_start_time** | **Time** |  | [optional] |
+| **object_key** | **String** |  |  |
 
 ## Example
 
@@ -30,17 +30,17 @@ instance = SongtradrApiClientRuby::FileSmallDTO.new(
   id: null,
   extension: null,
   error_message: null,
-  folder: null,
-  object_key: null,
-  upload_start_time: null,
-  upload_end_time: null,
-  fingerprint_status: null,
-  fingerprint_start_time: null,
+  error_time: null,
   fingerprint_end_time: null,
-  inference_status: null,
   inference_start_time: null,
+  fingerprint_start_time: null,
+  fingerprint_status: null,
+  inference_status: null,
   inference_end_time: null,
-  error_time: null
+  folder: null,
+  upload_end_time: null,
+  upload_start_time: null,
+  object_key: null
 )
 ```