songtradr_api_client_ruby 1.13.7 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +5 -37
- data/docs/FileSmallDTO.md +7 -7
- data/docs/MusicalFeaturesDTO.md +2 -2
- data/docs/PlaylistApi.md +0 -214
- data/docs/RecordingApi.md +0 -204
- data/docs/RecordingMediumDTO.md +2 -2
- data/docs/UserApi.md +0 -456
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -201
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -189
- data/lib/songtradr_api_client_ruby/api/user_api.rb +134 -746
- data/lib/songtradr_api_client_ruby/api_client.rb +37 -35
- data/lib/songtradr_api_client_ruby/api_error.rb +1 -1
- data/lib/songtradr_api_client_ruby/configuration.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/age_range.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/beard.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/bounding_box.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/dominant_color.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/emotion.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/error_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/eye_direction.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/eye_open.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/face_detail.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/face_detection.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/face_occluded.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +36 -36
- data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/gender.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genre_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/image_quality.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/instance.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label_alias.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label_category.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/label_detection.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/landmark.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/login_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/mouth_open.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +24 -24
- data/lib/songtradr_api_client_ruby/models/mustache.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/parent.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/pose.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +12 -12
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/smile.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/sunglasses.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tag_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/title_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/token_request.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/track_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/user_dto.rb +2 -2
- data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +2 -2
- data/lib/songtradr_api_client_ruby/version.rb +2 -2
- data/lib/songtradr_api_client_ruby.rb +1 -22
- data/openapi-generator-config.yaml +1 -1
- data/songtradr_api_client_ruby.gemspec +2 -1
- data/spec/api/allowed_values_api_spec.rb +1 -1
- data/spec/api/playlist_api_spec.rb +1 -38
- data/spec/api/recording_api_spec.rb +1 -34
- data/spec/api/user_api_spec.rb +1 -110
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/age_range_spec.rb +1 -1
- data/spec/models/beard_spec.rb +1 -1
- data/spec/models/bounding_box_spec.rb +1 -1
- data/spec/models/category_medium_dto_spec.rb +1 -1
- data/spec/models/category_minimal_dto_spec.rb +1 -1
- data/spec/models/config_access_dto_spec.rb +1 -1
- data/spec/models/config_identifier_dto_spec.rb +1 -1
- data/spec/models/contributor_type_dto_spec.rb +1 -1
- data/spec/models/curate_playlist_dto_spec.rb +1 -1
- data/spec/models/curate_playlist_response_dto_spec.rb +1 -1
- data/spec/models/dominant_color_spec.rb +1 -1
- data/spec/models/emotion_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/eye_direction_spec.rb +1 -1
- data/spec/models/eye_open_spec.rb +1 -1
- data/spec/models/eyeglasses_spec.rb +1 -1
- data/spec/models/face_detail_spec.rb +1 -1
- data/spec/models/face_detection_spec.rb +1 -1
- data/spec/models/face_occluded_spec.rb +1 -1
- data/spec/models/field_summary_dto_spec.rb +1 -1
- data/spec/models/file_dto_spec.rb +1 -1
- data/spec/models/file_list_dto_spec.rb +1 -1
- data/spec/models/file_small_dto_spec.rb +17 -17
- data/spec/models/file_upload_dto_spec.rb +1 -1
- data/spec/models/file_w_ith_url_dto_spec.rb +1 -1
- data/spec/models/files_summary_dto_spec.rb +1 -1
- data/spec/models/forgot_password_dto_spec.rb +1 -1
- data/spec/models/gender_spec.rb +1 -1
- data/spec/models/genre_dto_spec.rb +1 -1
- data/spec/models/genre_minimal_dto_spec.rb +1 -1
- data/spec/models/genres_summary_dto_spec.rb +1 -1
- data/spec/models/image_quality_spec.rb +1 -1
- data/spec/models/image_recognition_response_spec.rb +1 -1
- data/spec/models/init_put_recording_audio_dto_spec.rb +1 -1
- data/spec/models/instance_spec.rb +1 -1
- data/spec/models/jwt_token_dto_spec.rb +1 -1
- data/spec/models/label_alias_spec.rb +1 -1
- data/spec/models/label_category_spec.rb +1 -1
- data/spec/models/label_detection_spec.rb +1 -1
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/landmark_spec.rb +1 -1
- data/spec/models/login_dto_spec.rb +1 -1
- data/spec/models/mouth_open_spec.rb +1 -1
- data/spec/models/musical_features_dto_spec.rb +11 -11
- data/spec/models/mustache_spec.rb +1 -1
- data/spec/models/parent_spec.rb +1 -1
- data/spec/models/party_small_dto_spec.rb +1 -1
- data/spec/models/pose_spec.rb +1 -1
- data/spec/models/recording_for_similarity_search_dto_spec.rb +1 -1
- data/spec/models/recording_genre_prediction_dto_spec.rb +1 -1
- data/spec/models/recording_list_dto_spec.rb +1 -1
- data/spec/models/recording_medium_dto_spec.rb +3 -3
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +1 -1
- data/spec/models/recording_minimal_with_taggrams_dto_spec.rb +1 -1
- data/spec/models/recording_minimal_with_tagstrengths_dto_spec.rb +1 -1
- data/spec/models/recording_party_dto_spec.rb +1 -1
- data/spec/models/recording_small_dto_spec.rb +1 -1
- data/spec/models/recording_tag_small_dto_spec.rb +1 -1
- data/spec/models/save_user_dto_spec.rb +1 -1
- data/spec/models/search_filter_values_dto_spec.rb +1 -1
- data/spec/models/search_recording_granular_dto_spec.rb +1 -1
- data/spec/models/sign_up_dto_spec.rb +1 -1
- data/spec/models/smile_spec.rb +1 -1
- data/spec/models/sunglasses_spec.rb +1 -1
- data/spec/models/tag_dto_spec.rb +1 -1
- data/spec/models/tag_small_dto_spec.rb +1 -1
- data/spec/models/taggram_dto_spec.rb +1 -1
- data/spec/models/tags_summary_dto_spec.rb +1 -1
- data/spec/models/tagstrength_dto_spec.rb +1 -1
- data/spec/models/title_dto_spec.rb +1 -1
- data/spec/models/token_request_spec.rb +1 -1
- data/spec/models/track_dto_spec.rb +1 -1
- data/spec/models/update_password_dto_spec.rb +1 -1
- data/spec/models/user_dto_spec.rb +1 -1
- data/spec/models/video_recognition_response_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +63 -147
- data/docs/ContextValue.md +0 -18
- data/docs/FileMinimalWithUrlDTO.md +0 -22
- data/docs/PLineDTO.md +0 -20
- data/docs/PartyApi.md +0 -75
- data/docs/PartyLargeDTO.md +0 -32
- data/docs/PlaylistLargeDTO.md +0 -38
- data/docs/ProductMediumDTO.md +0 -34
- data/docs/ProductPartyDTO.md +0 -20
- data/docs/RecordingLargeDTO.md +0 -40
- data/docs/RecordingPlaylistDTO.md +0 -24
- data/docs/SaveFileRecordingDTO.md +0 -240
- data/docs/SavePlaylistDTO.md +0 -34
- data/docs/SaveRecordingGenreDTO.md +0 -22
- data/docs/SaveRecordingPartyDTO.md +0 -20
- data/docs/SaveRecordingPlaylistDTO.md +0 -22
- data/docs/SaveRecordingTagDTO.md +0 -20
- data/docs/SaveReferrerDTO.md +0 -20
- data/docs/SaveTaggramsDTO.md +0 -82
- data/docs/SearchRecordingGranularAbstractionDTO.md +0 -20
- data/docs/TrackToMediumProductDTO.md +0 -22
- data/docs/UsageDTO.md +0 -18
- data/lib/songtradr_api_client_ruby/api/party_api.rb +0 -84
- data/lib/songtradr_api_client_ruby/models/context_value.rb +0 -216
- data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +0 -254
- data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +0 -231
- data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +0 -285
- data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +0 -350
- data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +0 -323
- data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +0 -233
- data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +0 -383
- data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +0 -242
- data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +0 -1864
- data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +0 -353
- data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +0 -240
- data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +0 -272
- data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +0 -247
- data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +0 -231
- data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +0 -224
- data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +0 -569
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +0 -267
- data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +0 -247
- data/lib/songtradr_api_client_ruby/models/usage_dto.rb +0 -215
- data/spec/api/party_api_spec.rb +0 -46
- data/spec/models/context_value_spec.rb +0 -36
- data/spec/models/file_minimal_with_url_dto_spec.rb +0 -48
- data/spec/models/p_line_dto_spec.rb +0 -42
- data/spec/models/party_large_dto_spec.rb +0 -78
- data/spec/models/playlist_large_dto_spec.rb +0 -100
- data/spec/models/product_medium_dto_spec.rb +0 -84
- data/spec/models/product_party_dto_spec.rb +0 -42
- data/spec/models/recording_large_dto_spec.rb +0 -102
- data/spec/models/recording_playlist_dto_spec.rb +0 -54
- data/spec/models/save_file_recording_dto_spec.rb +0 -894
- data/spec/models/save_playlist_dto_spec.rb +0 -88
- data/spec/models/save_recording_genre_dto_spec.rb +0 -48
- data/spec/models/save_recording_party_dto_spec.rb +0 -46
- data/spec/models/save_recording_playlist_dto_spec.rb +0 -48
- data/spec/models/save_recording_tag_dto_spec.rb +0 -42
- data/spec/models/save_referrer_dto_spec.rb +0 -42
- data/spec/models/save_taggrams_dto_spec.rb +0 -228
- data/spec/models/search_recording_granular_abstraction_dto_spec.rb +0 -46
- data/spec/models/track_to_medium_product_dto_spec.rb +0 -48
- data/spec/models/usage_dto_spec.rb +0 -36
data/docs/RecordingApi.md
CHANGED
|
@@ -8,12 +8,9 @@ All URIs are relative to *https://api.songtradr.com*
|
|
|
8
8
|
| [**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. |
|
|
9
9
|
| [**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. |
|
|
10
10
|
| [**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. |
|
|
11
|
-
| [**recordings_large_by_ids**](RecordingApi.md#recordings_large_by_ids) | **GET** /api/v1/public/recording/l/{ids} | Recordings by IDs with a large response. |
|
|
12
11
|
| [**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. |
|
|
13
|
-
| [**recordings_small_by_ids**](RecordingApi.md#recordings_small_by_ids) | **GET** /api/v1/public/recording/s/{ids} | Recordings by IDs with a small response. |
|
|
14
12
|
| [**search_recordings**](RecordingApi.md#search_recordings) | **GET** /api/v1/public/recording/search | Recordings by contributors, moods, musical features and more. |
|
|
15
13
|
| [**search_recordings_granular**](RecordingApi.md#search_recordings_granular) | **POST** /api/v1/public/recording/searchGranular | Recordings by granular search options. |
|
|
16
|
-
| [**search_recordings_granular_abstraction**](RecordingApi.md#search_recordings_granular_abstraction) | **POST** /api/v1/public/recording/searchGranularAbstraction | Recordings by abstracted wordings and granular search options. |
|
|
17
14
|
|
|
18
15
|
|
|
19
16
|
## recordings_by_ids_with_musical_features
|
|
@@ -310,73 +307,6 @@ end
|
|
|
310
307
|
- **Accept**: application/json
|
|
311
308
|
|
|
312
309
|
|
|
313
|
-
## recordings_large_by_ids
|
|
314
|
-
|
|
315
|
-
> <Array<RecordingLargeDTO>> recordings_large_by_ids(ids)
|
|
316
|
-
|
|
317
|
-
Recordings by IDs with a large response.
|
|
318
|
-
|
|
319
|
-
### Examples
|
|
320
|
-
|
|
321
|
-
```ruby
|
|
322
|
-
require 'time'
|
|
323
|
-
require 'songtradr_api_client_ruby'
|
|
324
|
-
# setup authorization
|
|
325
|
-
SongtradrApiClientRuby.configure do |config|
|
|
326
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
327
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
328
|
-
end
|
|
329
|
-
|
|
330
|
-
api_instance = SongtradrApiClientRuby::RecordingApi.new
|
|
331
|
-
ids = 'GBAYE1101181' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
332
|
-
|
|
333
|
-
begin
|
|
334
|
-
# Recordings by IDs with a large response.
|
|
335
|
-
result = api_instance.recordings_large_by_ids(ids)
|
|
336
|
-
p result
|
|
337
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
338
|
-
puts "Error when calling RecordingApi->recordings_large_by_ids: #{e}"
|
|
339
|
-
end
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
#### Using the recordings_large_by_ids_with_http_info variant
|
|
343
|
-
|
|
344
|
-
This returns an Array which contains the response data, status code and headers.
|
|
345
|
-
|
|
346
|
-
> <Array(<Array<RecordingLargeDTO>>, Integer, Hash)> recordings_large_by_ids_with_http_info(ids)
|
|
347
|
-
|
|
348
|
-
```ruby
|
|
349
|
-
begin
|
|
350
|
-
# Recordings by IDs with a large response.
|
|
351
|
-
data, status_code, headers = api_instance.recordings_large_by_ids_with_http_info(ids)
|
|
352
|
-
p status_code # => 2xx
|
|
353
|
-
p headers # => { ... }
|
|
354
|
-
p data # => <Array<RecordingLargeDTO>>
|
|
355
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
356
|
-
puts "Error when calling RecordingApi->recordings_large_by_ids_with_http_info: #{e}"
|
|
357
|
-
end
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
### Parameters
|
|
361
|
-
|
|
362
|
-
| Name | Type | Description | Notes |
|
|
363
|
-
| ---- | ---- | ----------- | ----- |
|
|
364
|
-
| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
|
|
365
|
-
|
|
366
|
-
### Return type
|
|
367
|
-
|
|
368
|
-
[**Array<RecordingLargeDTO>**](RecordingLargeDTO.md)
|
|
369
|
-
|
|
370
|
-
### Authorization
|
|
371
|
-
|
|
372
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
373
|
-
|
|
374
|
-
### HTTP request headers
|
|
375
|
-
|
|
376
|
-
- **Content-Type**: Not defined
|
|
377
|
-
- **Accept**: application/json
|
|
378
|
-
|
|
379
|
-
|
|
380
310
|
## recordings_medium_by_ids
|
|
381
311
|
|
|
382
312
|
> <Array<RecordingMediumDTO>> recordings_medium_by_ids(ids, opts)
|
|
@@ -452,73 +382,6 @@ end
|
|
|
452
382
|
- **Accept**: application/json
|
|
453
383
|
|
|
454
384
|
|
|
455
|
-
## recordings_small_by_ids
|
|
456
|
-
|
|
457
|
-
> <Array<RecordingSmallDTO>> recordings_small_by_ids(ids)
|
|
458
|
-
|
|
459
|
-
Recordings by IDs with a small response.
|
|
460
|
-
|
|
461
|
-
### Examples
|
|
462
|
-
|
|
463
|
-
```ruby
|
|
464
|
-
require 'time'
|
|
465
|
-
require 'songtradr_api_client_ruby'
|
|
466
|
-
# setup authorization
|
|
467
|
-
SongtradrApiClientRuby.configure do |config|
|
|
468
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
469
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
470
|
-
end
|
|
471
|
-
|
|
472
|
-
api_instance = SongtradrApiClientRuby::RecordingApi.new
|
|
473
|
-
ids = 'GBAYE0200774' # String | Comma seperated list of IDs. Can be ISRCs or proprietary IDs
|
|
474
|
-
|
|
475
|
-
begin
|
|
476
|
-
# Recordings by IDs with a small response.
|
|
477
|
-
result = api_instance.recordings_small_by_ids(ids)
|
|
478
|
-
p result
|
|
479
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
480
|
-
puts "Error when calling RecordingApi->recordings_small_by_ids: #{e}"
|
|
481
|
-
end
|
|
482
|
-
```
|
|
483
|
-
|
|
484
|
-
#### Using the recordings_small_by_ids_with_http_info variant
|
|
485
|
-
|
|
486
|
-
This returns an Array which contains the response data, status code and headers.
|
|
487
|
-
|
|
488
|
-
> <Array(<Array<RecordingSmallDTO>>, Integer, Hash)> recordings_small_by_ids_with_http_info(ids)
|
|
489
|
-
|
|
490
|
-
```ruby
|
|
491
|
-
begin
|
|
492
|
-
# Recordings by IDs with a small response.
|
|
493
|
-
data, status_code, headers = api_instance.recordings_small_by_ids_with_http_info(ids)
|
|
494
|
-
p status_code # => 2xx
|
|
495
|
-
p headers # => { ... }
|
|
496
|
-
p data # => <Array<RecordingSmallDTO>>
|
|
497
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
498
|
-
puts "Error when calling RecordingApi->recordings_small_by_ids_with_http_info: #{e}"
|
|
499
|
-
end
|
|
500
|
-
```
|
|
501
|
-
|
|
502
|
-
### Parameters
|
|
503
|
-
|
|
504
|
-
| Name | Type | Description | Notes |
|
|
505
|
-
| ---- | ---- | ----------- | ----- |
|
|
506
|
-
| **ids** | **String** | Comma seperated list of IDs. Can be ISRCs or proprietary IDs | |
|
|
507
|
-
|
|
508
|
-
### Return type
|
|
509
|
-
|
|
510
|
-
[**Array<RecordingSmallDTO>**](RecordingSmallDTO.md)
|
|
511
|
-
|
|
512
|
-
### Authorization
|
|
513
|
-
|
|
514
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
515
|
-
|
|
516
|
-
### HTTP request headers
|
|
517
|
-
|
|
518
|
-
- **Content-Type**: Not defined
|
|
519
|
-
- **Accept**: application/json
|
|
520
|
-
|
|
521
|
-
|
|
522
385
|
## search_recordings
|
|
523
386
|
|
|
524
387
|
> <RecordingListDTO> search_recordings(opts)
|
|
@@ -732,70 +595,3 @@ end
|
|
|
732
595
|
- **Content-Type**: application/json
|
|
733
596
|
- **Accept**: application/json
|
|
734
597
|
|
|
735
|
-
|
|
736
|
-
## search_recordings_granular_abstraction
|
|
737
|
-
|
|
738
|
-
> <RecordingListDTO> search_recordings_granular_abstraction(search_recording_granular_abstraction_dto)
|
|
739
|
-
|
|
740
|
-
Recordings by abstracted wordings and granular search options.
|
|
741
|
-
|
|
742
|
-
### Examples
|
|
743
|
-
|
|
744
|
-
```ruby
|
|
745
|
-
require 'time'
|
|
746
|
-
require 'songtradr_api_client_ruby'
|
|
747
|
-
# setup authorization
|
|
748
|
-
SongtradrApiClientRuby.configure do |config|
|
|
749
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
750
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
751
|
-
end
|
|
752
|
-
|
|
753
|
-
api_instance = SongtradrApiClientRuby::RecordingApi.new
|
|
754
|
-
search_recording_granular_abstraction_dto = [SongtradrApiClientRuby::SearchRecordingGranularAbstractionDTO.new({abstraction_name: 'brandarchetypeInnocent'})] # Array<SearchRecordingGranularAbstractionDTO> |
|
|
755
|
-
|
|
756
|
-
begin
|
|
757
|
-
# Recordings by abstracted wordings and granular search options.
|
|
758
|
-
result = api_instance.search_recordings_granular_abstraction(search_recording_granular_abstraction_dto)
|
|
759
|
-
p result
|
|
760
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
761
|
-
puts "Error when calling RecordingApi->search_recordings_granular_abstraction: #{e}"
|
|
762
|
-
end
|
|
763
|
-
```
|
|
764
|
-
|
|
765
|
-
#### Using the search_recordings_granular_abstraction_with_http_info variant
|
|
766
|
-
|
|
767
|
-
This returns an Array which contains the response data, status code and headers.
|
|
768
|
-
|
|
769
|
-
> <Array(<RecordingListDTO>, Integer, Hash)> search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto)
|
|
770
|
-
|
|
771
|
-
```ruby
|
|
772
|
-
begin
|
|
773
|
-
# Recordings by abstracted wordings and granular search options.
|
|
774
|
-
data, status_code, headers = api_instance.search_recordings_granular_abstraction_with_http_info(search_recording_granular_abstraction_dto)
|
|
775
|
-
p status_code # => 2xx
|
|
776
|
-
p headers # => { ... }
|
|
777
|
-
p data # => <RecordingListDTO>
|
|
778
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
779
|
-
puts "Error when calling RecordingApi->search_recordings_granular_abstraction_with_http_info: #{e}"
|
|
780
|
-
end
|
|
781
|
-
```
|
|
782
|
-
|
|
783
|
-
### Parameters
|
|
784
|
-
|
|
785
|
-
| Name | Type | Description | Notes |
|
|
786
|
-
| ---- | ---- | ----------- | ----- |
|
|
787
|
-
| **search_recording_granular_abstraction_dto** | [**Array<SearchRecordingGranularAbstractionDTO>**](SearchRecordingGranularAbstractionDTO.md) | | |
|
|
788
|
-
|
|
789
|
-
### Return type
|
|
790
|
-
|
|
791
|
-
[**RecordingListDTO**](RecordingListDTO.md)
|
|
792
|
-
|
|
793
|
-
### Authorization
|
|
794
|
-
|
|
795
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
796
|
-
|
|
797
|
-
### HTTP request headers
|
|
798
|
-
|
|
799
|
-
- **Content-Type**: application/json
|
|
800
|
-
- **Accept**: application/json
|
|
801
|
-
|
data/docs/RecordingMediumDTO.md
CHANGED
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
| **titles** | [**Array<TitleDTO>**](TitleDTO.md) | | [optional] |
|
|
13
13
|
| **tracks** | [**Array<TrackDTO>**](TrackDTO.md) | | [optional] |
|
|
14
14
|
| **musical_features** | [**MusicalFeaturesDTO**](MusicalFeaturesDTO.md) | | [optional] |
|
|
15
|
-
| **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) | | [optional] |
|
|
16
15
|
| **spotify_id** | **String** | | [optional] |
|
|
16
|
+
| **tags** | [**Array<RecordingTagSmallDTO>**](RecordingTagSmallDTO.md) | | [optional] |
|
|
17
17
|
| **genre_predictions** | [**Array<RecordingGenrePredictionDTO>**](RecordingGenrePredictionDTO.md) | | [optional] |
|
|
18
18
|
|
|
19
19
|
## Example
|
|
@@ -30,8 +30,8 @@ instance = SongtradrApiClientRuby::RecordingMediumDTO.new(
|
|
|
30
30
|
titles: null,
|
|
31
31
|
tracks: null,
|
|
32
32
|
musical_features: null,
|
|
33
|
-
tags: null,
|
|
34
33
|
spotify_id: null,
|
|
34
|
+
tags: null,
|
|
35
35
|
genre_predictions: null
|
|
36
36
|
)
|
|
37
37
|
```
|