songtradr_api_client_ruby 1.13.5 → 1.13.6
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 +12 -36
- data/docs/FileSmallDTO.md +5 -5
- data/docs/MusicalFeaturesDTO.md +27 -27
- data/docs/PlaylistLargeDTO.md +2 -2
- data/docs/RecordingGenrePredictionDTO.md +3 -3
- data/docs/RecordingLargeDTO.md +2 -2
- data/docs/RecordingMediumDTO.md +2 -2
- data/docs/RecordingMinimalWithMusicalFeaturesDTO.md +3 -3
- data/docs/RecordingSmallDTO.md +3 -3
- data/docs/TagDTO.md +3 -3
- data/lib/songtradr_api_client_ruby/api/allowed_values_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/party_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/playlist_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/recording_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api/user_api.rb +1 -1
- data/lib/songtradr_api_client_ruby/api_client.rb +1 -1
- 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 +1 -1
- data/lib/songtradr_api_client_ruby/models/beard.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/bounding_box.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/category_medium_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/category_minimal_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/config_access_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/config_identifier_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/context_value.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/contributor_type_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/dominant_color.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/emotion.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/error_response.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/eye_direction.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/eye_open.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/eyeglasses.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/face_detail.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/face_detection.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/face_occluded.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/field_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_list_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_minimal_with_url_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_small_dto.rb +36 -36
- data/lib/songtradr_api_client_ruby/models/file_upload_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/file_w_ith_url_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/files_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/forgot_password_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/gender.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/genre_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/genre_minimal_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/genres_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/image_quality.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/image_recognition_response.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/init_put_recording_audio_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/instance.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/jwt_token_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/label.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/label_alias.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/label_category.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/label_detection.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/landmark.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/login_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/mouth_open.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/musical_features_dto.rb +172 -172
- data/lib/songtradr_api_client_ruby/models/mustache.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/p_line_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/parent.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/party_large_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/party_small_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/playlist_large_dto.rb +11 -11
- data/lib/songtradr_api_client_ruby/models/pose.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/product_medium_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/product_party_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_for_similarity_search_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_genre_prediction_dto.rb +21 -21
- data/lib/songtradr_api_client_ruby/models/recording_large_dto.rb +13 -13
- data/lib/songtradr_api_client_ruby/models/recording_list_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_medium_dto.rb +13 -13
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_musical_features_dto.rb +16 -16
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_taggrams_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_minimal_with_tagstrengths_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_party_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/recording_small_dto.rb +16 -16
- data/lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_party_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_playlist_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_recording_tag_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_referrer_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_taggrams_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/save_user_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/search_filter_values_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_abstraction_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/search_recording_granular_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/sign_up_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/smile.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/sunglasses.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/tag_dto.rb +16 -16
- data/lib/songtradr_api_client_ruby/models/tag_small_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/taggram_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/tags_summary_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/tagstrength_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/title_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/token_request.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/track_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/track_to_medium_product_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/update_password_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/usage_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/user_dto.rb +1 -1
- data/lib/songtradr_api_client_ruby/models/video_recognition_response.rb +1 -1
- data/lib/songtradr_api_client_ruby/version.rb +2 -2
- data/lib/songtradr_api_client_ruby.rb +1 -10
- data/openapi-generator-config.yaml +1 -1
- data/songtradr_api_client_ruby.gemspec +1 -1
- data/spec/api/allowed_values_api_spec.rb +1 -1
- data/spec/api/party_api_spec.rb +1 -1
- data/spec/api/playlist_api_spec.rb +1 -1
- data/spec/api/recording_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +1 -1
- 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/context_value_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_minimal_with_url_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 +57 -57
- data/spec/models/mustache_spec.rb +1 -1
- data/spec/models/p_line_dto_spec.rb +1 -1
- data/spec/models/parent_spec.rb +1 -1
- data/spec/models/party_large_dto_spec.rb +1 -1
- data/spec/models/party_small_dto_spec.rb +1 -1
- data/spec/models/playlist_large_dto_spec.rb +7 -7
- data/spec/models/pose_spec.rb +1 -1
- data/spec/models/product_medium_dto_spec.rb +1 -1
- data/spec/models/product_party_dto_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 +4 -4
- data/spec/models/recording_large_dto_spec.rb +7 -7
- data/spec/models/recording_list_dto_spec.rb +1 -1
- data/spec/models/recording_medium_dto_spec.rb +7 -7
- data/spec/models/recording_minimal_with_musical_features_dto_spec.rb +3 -3
- 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_playlist_dto_spec.rb +1 -1
- data/spec/models/recording_small_dto_spec.rb +4 -4
- data/spec/models/recording_tag_small_dto_spec.rb +1 -1
- data/spec/models/save_file_recording_dto_spec.rb +1 -1
- data/spec/models/save_playlist_dto_spec.rb +1 -1
- data/spec/models/save_recording_genre_dto_spec.rb +1 -1
- data/spec/models/save_recording_party_dto_spec.rb +1 -1
- data/spec/models/save_recording_playlist_dto_spec.rb +1 -1
- data/spec/models/save_recording_tag_dto_spec.rb +1 -1
- data/spec/models/save_referrer_dto_spec.rb +1 -1
- data/spec/models/save_taggrams_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_abstraction_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 +3 -3
- 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/track_to_medium_product_dto_spec.rb +1 -1
- data/spec/models/update_password_dto_spec.rb +1 -1
- data/spec/models/usage_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 +1 -37
- data/docs/APIKeysApi.md +0 -217
- data/docs/AdminApiCreateUserDTO.md +0 -76
- data/docs/AdminApiUpdateUserDTO.md +0 -76
- data/docs/AdminApiUserDTO.md +0 -70
- data/docs/AdminUsersControllerApi.md +0 -355
- data/docs/ApiKeyDTO.md +0 -24
- data/docs/CreateApiKeyDTO.md +0 -18
- data/docs/InternalApiApi.md +0 -149
- data/docs/SaveFileDTO.md +0 -42
- data/lib/songtradr_api_client_ruby/api/admin_users_controller_api.rb +0 -346
- data/lib/songtradr_api_client_ruby/api/api_keys_api.rb +0 -213
- data/lib/songtradr_api_client_ruby/api/internal_api_api.rb +0 -169
- data/lib/songtradr_api_client_ruby/models/admin_api_create_user_dto.rb +0 -489
- data/lib/songtradr_api_client_ruby/models/admin_api_update_user_dto.rb +0 -475
- data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb +0 -448
- data/lib/songtradr_api_client_ruby/models/api_key_dto.rb +0 -262
- data/lib/songtradr_api_client_ruby/models/create_api_key_dto.rb +0 -214
- data/lib/songtradr_api_client_ruby/models/save_file_dto.rb +0 -323
- data/spec/api/admin_users_controller_api_spec.rb +0 -93
- data/spec/api/api_keys_api_spec.rb +0 -70
- data/spec/api/internal_api_api_spec.rb +0 -58
- data/spec/models/admin_api_create_user_dto_spec.rb +0 -210
- data/spec/models/admin_api_update_user_dto_spec.rb +0 -210
- data/spec/models/admin_api_user_dto_spec.rb +0 -192
- data/spec/models/api_key_dto_spec.rb +0 -54
- data/spec/models/create_api_key_dto_spec.rb +0 -36
- data/spec/models/save_file_dto_spec.rb +0 -108
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
data/spec/spec_helper.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging. You can also use the API to manage your account and musicube cloud data. **Authentication** 1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up. 2. To authenticate, you need to login via the POST /api/v1/user/login endpoint. 3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token. **Rate Limiting** The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more. **Getting Started with auto-tagging** 1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint. **Getting Started with search** You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints. 1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.13.
|
|
6
|
+
The version of the OpenAPI document: 1.13.6
|
|
7
7
|
Contact: info@songtradr.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: songtradr_api_client_ruby
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.13.
|
|
4
|
+
version: 1.13.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- songtradr
|
|
@@ -75,14 +75,8 @@ files:
|
|
|
75
75
|
- Gemfile.lock
|
|
76
76
|
- README.md
|
|
77
77
|
- Rakefile
|
|
78
|
-
- docs/APIKeysApi.md
|
|
79
|
-
- docs/AdminApiCreateUserDTO.md
|
|
80
|
-
- docs/AdminApiUpdateUserDTO.md
|
|
81
|
-
- docs/AdminApiUserDTO.md
|
|
82
|
-
- docs/AdminUsersControllerApi.md
|
|
83
78
|
- docs/AgeRange.md
|
|
84
79
|
- docs/AllowedValuesApi.md
|
|
85
|
-
- docs/ApiKeyDTO.md
|
|
86
80
|
- docs/Beard.md
|
|
87
81
|
- docs/BoundingBox.md
|
|
88
82
|
- docs/CategoryMediumDTO.md
|
|
@@ -91,7 +85,6 @@ files:
|
|
|
91
85
|
- docs/ConfigIdentifierDTO.md
|
|
92
86
|
- docs/ContextValue.md
|
|
93
87
|
- docs/ContributorTypeDTO.md
|
|
94
|
-
- docs/CreateApiKeyDTO.md
|
|
95
88
|
- docs/CuratePlaylistDTO.md
|
|
96
89
|
- docs/CuratePlaylistResponseDTO.md
|
|
97
90
|
- docs/DominantColor.md
|
|
@@ -120,7 +113,6 @@ files:
|
|
|
120
113
|
- docs/ImageRecognitionResponse.md
|
|
121
114
|
- docs/InitPutRecordingAudioDTO.md
|
|
122
115
|
- docs/Instance.md
|
|
123
|
-
- docs/InternalApiApi.md
|
|
124
116
|
- docs/JwtTokenDTO.md
|
|
125
117
|
- docs/Label.md
|
|
126
118
|
- docs/LabelAlias.md
|
|
@@ -154,7 +146,6 @@ files:
|
|
|
154
146
|
- docs/RecordingPlaylistDTO.md
|
|
155
147
|
- docs/RecordingSmallDTO.md
|
|
156
148
|
- docs/RecordingTagSmallDTO.md
|
|
157
|
-
- docs/SaveFileDTO.md
|
|
158
149
|
- docs/SaveFileRecordingDTO.md
|
|
159
150
|
- docs/SavePlaylistDTO.md
|
|
160
151
|
- docs/SaveRecordingGenreDTO.md
|
|
@@ -187,10 +178,7 @@ files:
|
|
|
187
178
|
- getspec.rb
|
|
188
179
|
- git_push.sh
|
|
189
180
|
- lib/songtradr_api_client_ruby.rb
|
|
190
|
-
- lib/songtradr_api_client_ruby/api/admin_users_controller_api.rb
|
|
191
181
|
- lib/songtradr_api_client_ruby/api/allowed_values_api.rb
|
|
192
|
-
- lib/songtradr_api_client_ruby/api/api_keys_api.rb
|
|
193
|
-
- lib/songtradr_api_client_ruby/api/internal_api_api.rb
|
|
194
182
|
- lib/songtradr_api_client_ruby/api/party_api.rb
|
|
195
183
|
- lib/songtradr_api_client_ruby/api/playlist_api.rb
|
|
196
184
|
- lib/songtradr_api_client_ruby/api/recording_api.rb
|
|
@@ -198,11 +186,7 @@ files:
|
|
|
198
186
|
- lib/songtradr_api_client_ruby/api_client.rb
|
|
199
187
|
- lib/songtradr_api_client_ruby/api_error.rb
|
|
200
188
|
- lib/songtradr_api_client_ruby/configuration.rb
|
|
201
|
-
- lib/songtradr_api_client_ruby/models/admin_api_create_user_dto.rb
|
|
202
|
-
- lib/songtradr_api_client_ruby/models/admin_api_update_user_dto.rb
|
|
203
|
-
- lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb
|
|
204
189
|
- lib/songtradr_api_client_ruby/models/age_range.rb
|
|
205
|
-
- lib/songtradr_api_client_ruby/models/api_key_dto.rb
|
|
206
190
|
- lib/songtradr_api_client_ruby/models/beard.rb
|
|
207
191
|
- lib/songtradr_api_client_ruby/models/bounding_box.rb
|
|
208
192
|
- lib/songtradr_api_client_ruby/models/category_medium_dto.rb
|
|
@@ -211,7 +195,6 @@ files:
|
|
|
211
195
|
- lib/songtradr_api_client_ruby/models/config_identifier_dto.rb
|
|
212
196
|
- lib/songtradr_api_client_ruby/models/context_value.rb
|
|
213
197
|
- lib/songtradr_api_client_ruby/models/contributor_type_dto.rb
|
|
214
|
-
- lib/songtradr_api_client_ruby/models/create_api_key_dto.rb
|
|
215
198
|
- lib/songtradr_api_client_ruby/models/curate_playlist_dto.rb
|
|
216
199
|
- lib/songtradr_api_client_ruby/models/curate_playlist_response_dto.rb
|
|
217
200
|
- lib/songtradr_api_client_ruby/models/dominant_color.rb
|
|
@@ -270,7 +253,6 @@ files:
|
|
|
270
253
|
- lib/songtradr_api_client_ruby/models/recording_playlist_dto.rb
|
|
271
254
|
- lib/songtradr_api_client_ruby/models/recording_small_dto.rb
|
|
272
255
|
- lib/songtradr_api_client_ruby/models/recording_tag_small_dto.rb
|
|
273
|
-
- lib/songtradr_api_client_ruby/models/save_file_dto.rb
|
|
274
256
|
- lib/songtradr_api_client_ruby/models/save_file_recording_dto.rb
|
|
275
257
|
- lib/songtradr_api_client_ruby/models/save_playlist_dto.rb
|
|
276
258
|
- lib/songtradr_api_client_ruby/models/save_recording_genre_dto.rb
|
|
@@ -302,21 +284,14 @@ files:
|
|
|
302
284
|
- lib/songtradr_api_client_ruby/version.rb
|
|
303
285
|
- openapi-generator-config.yaml
|
|
304
286
|
- songtradr_api_client_ruby.gemspec
|
|
305
|
-
- spec/api/admin_users_controller_api_spec.rb
|
|
306
287
|
- spec/api/allowed_values_api_spec.rb
|
|
307
|
-
- spec/api/api_keys_api_spec.rb
|
|
308
|
-
- spec/api/internal_api_api_spec.rb
|
|
309
288
|
- spec/api/party_api_spec.rb
|
|
310
289
|
- spec/api/playlist_api_spec.rb
|
|
311
290
|
- spec/api/recording_api_spec.rb
|
|
312
291
|
- spec/api/user_api_spec.rb
|
|
313
292
|
- spec/api_client_spec.rb
|
|
314
293
|
- spec/configuration_spec.rb
|
|
315
|
-
- spec/models/admin_api_create_user_dto_spec.rb
|
|
316
|
-
- spec/models/admin_api_update_user_dto_spec.rb
|
|
317
|
-
- spec/models/admin_api_user_dto_spec.rb
|
|
318
294
|
- spec/models/age_range_spec.rb
|
|
319
|
-
- spec/models/api_key_dto_spec.rb
|
|
320
295
|
- spec/models/beard_spec.rb
|
|
321
296
|
- spec/models/bounding_box_spec.rb
|
|
322
297
|
- spec/models/category_medium_dto_spec.rb
|
|
@@ -325,7 +300,6 @@ files:
|
|
|
325
300
|
- spec/models/config_identifier_dto_spec.rb
|
|
326
301
|
- spec/models/context_value_spec.rb
|
|
327
302
|
- spec/models/contributor_type_dto_spec.rb
|
|
328
|
-
- spec/models/create_api_key_dto_spec.rb
|
|
329
303
|
- spec/models/curate_playlist_dto_spec.rb
|
|
330
304
|
- spec/models/curate_playlist_response_dto_spec.rb
|
|
331
305
|
- spec/models/dominant_color_spec.rb
|
|
@@ -384,7 +358,6 @@ files:
|
|
|
384
358
|
- spec/models/recording_playlist_dto_spec.rb
|
|
385
359
|
- spec/models/recording_small_dto_spec.rb
|
|
386
360
|
- spec/models/recording_tag_small_dto_spec.rb
|
|
387
|
-
- spec/models/save_file_dto_spec.rb
|
|
388
361
|
- spec/models/save_file_recording_dto_spec.rb
|
|
389
362
|
- spec/models/save_playlist_dto_spec.rb
|
|
390
363
|
- spec/models/save_recording_genre_dto_spec.rb
|
|
@@ -438,13 +411,10 @@ signing_key:
|
|
|
438
411
|
specification_version: 4
|
|
439
412
|
summary: Client for Songtradr API, generated with openapi-generator
|
|
440
413
|
test_files:
|
|
441
|
-
- spec/api/admin_users_controller_api_spec.rb
|
|
442
|
-
- spec/api/internal_api_api_spec.rb
|
|
443
414
|
- spec/api/user_api_spec.rb
|
|
444
415
|
- spec/api/party_api_spec.rb
|
|
445
416
|
- spec/api/allowed_values_api_spec.rb
|
|
446
417
|
- spec/api/recording_api_spec.rb
|
|
447
|
-
- spec/api/api_keys_api_spec.rb
|
|
448
418
|
- spec/api/playlist_api_spec.rb
|
|
449
419
|
- spec/api_client_spec.rb
|
|
450
420
|
- spec/configuration_spec.rb
|
|
@@ -456,14 +426,12 @@ test_files:
|
|
|
456
426
|
- spec/models/party_large_dto_spec.rb
|
|
457
427
|
- spec/models/forgot_password_dto_spec.rb
|
|
458
428
|
- spec/models/face_occluded_spec.rb
|
|
459
|
-
- spec/models/api_key_dto_spec.rb
|
|
460
429
|
- spec/models/curate_playlist_response_dto_spec.rb
|
|
461
430
|
- spec/models/context_value_spec.rb
|
|
462
431
|
- spec/models/label_alias_spec.rb
|
|
463
432
|
- spec/models/mouth_open_spec.rb
|
|
464
433
|
- spec/models/recording_minimal_with_tagstrengths_dto_spec.rb
|
|
465
434
|
- spec/models/recording_for_similarity_search_dto_spec.rb
|
|
466
|
-
- spec/models/admin_api_update_user_dto_spec.rb
|
|
467
435
|
- spec/models/recording_playlist_dto_spec.rb
|
|
468
436
|
- spec/models/contributor_type_dto_spec.rb
|
|
469
437
|
- spec/models/eye_open_spec.rb
|
|
@@ -488,9 +456,7 @@ test_files:
|
|
|
488
456
|
- spec/models/track_dto_spec.rb
|
|
489
457
|
- spec/models/save_recording_playlist_dto_spec.rb
|
|
490
458
|
- spec/models/product_medium_dto_spec.rb
|
|
491
|
-
- spec/models/admin_api_create_user_dto_spec.rb
|
|
492
459
|
- spec/models/taggram_dto_spec.rb
|
|
493
|
-
- spec/models/admin_api_user_dto_spec.rb
|
|
494
460
|
- spec/models/field_summary_dto_spec.rb
|
|
495
461
|
- spec/models/recording_tag_small_dto_spec.rb
|
|
496
462
|
- spec/models/face_detail_spec.rb
|
|
@@ -517,13 +483,11 @@ test_files:
|
|
|
517
483
|
- spec/models/gender_spec.rb
|
|
518
484
|
- spec/models/genres_summary_dto_spec.rb
|
|
519
485
|
- spec/models/search_recording_granular_dto_spec.rb
|
|
520
|
-
- spec/models/save_file_dto_spec.rb
|
|
521
486
|
- spec/models/tags_summary_dto_spec.rb
|
|
522
487
|
- spec/models/recording_genre_prediction_dto_spec.rb
|
|
523
488
|
- spec/models/parent_spec.rb
|
|
524
489
|
- spec/models/title_dto_spec.rb
|
|
525
490
|
- spec/models/config_access_dto_spec.rb
|
|
526
|
-
- spec/models/create_api_key_dto_spec.rb
|
|
527
491
|
- spec/models/recording_minimal_with_taggrams_dto_spec.rb
|
|
528
492
|
- spec/models/recording_small_dto_spec.rb
|
|
529
493
|
- spec/models/save_referrer_dto_spec.rb
|
data/docs/APIKeysApi.md
DELETED
|
@@ -1,217 +0,0 @@
|
|
|
1
|
-
# SongtradrApiClientRuby::APIKeysApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.songtradr.com*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api/v1/user/apiKeys | create an API key |
|
|
8
|
-
| [**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api/v1/user/apiKeys/{id} | delete an API key |
|
|
9
|
-
| [**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api/v1/user/apiKeys | list API keys |
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
## create_api_key
|
|
13
|
-
|
|
14
|
-
> <AdminApiUserDTO> create_api_key(create_api_key_dto)
|
|
15
|
-
|
|
16
|
-
create an API key
|
|
17
|
-
|
|
18
|
-
### Examples
|
|
19
|
-
|
|
20
|
-
```ruby
|
|
21
|
-
require 'time'
|
|
22
|
-
require 'songtradr_api_client_ruby'
|
|
23
|
-
# setup authorization
|
|
24
|
-
SongtradrApiClientRuby.configure do |config|
|
|
25
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
26
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
27
|
-
end
|
|
28
|
-
|
|
29
|
-
api_instance = SongtradrApiClientRuby::APIKeysApi.new
|
|
30
|
-
create_api_key_dto = SongtradrApiClientRuby::CreateApiKeyDTO.new # CreateApiKeyDTO |
|
|
31
|
-
|
|
32
|
-
begin
|
|
33
|
-
# create an API key
|
|
34
|
-
result = api_instance.create_api_key(create_api_key_dto)
|
|
35
|
-
p result
|
|
36
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
37
|
-
puts "Error when calling APIKeysApi->create_api_key: #{e}"
|
|
38
|
-
end
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
#### Using the create_api_key_with_http_info variant
|
|
42
|
-
|
|
43
|
-
This returns an Array which contains the response data, status code and headers.
|
|
44
|
-
|
|
45
|
-
> <Array(<AdminApiUserDTO>, Integer, Hash)> create_api_key_with_http_info(create_api_key_dto)
|
|
46
|
-
|
|
47
|
-
```ruby
|
|
48
|
-
begin
|
|
49
|
-
# create an API key
|
|
50
|
-
data, status_code, headers = api_instance.create_api_key_with_http_info(create_api_key_dto)
|
|
51
|
-
p status_code # => 2xx
|
|
52
|
-
p headers # => { ... }
|
|
53
|
-
p data # => <AdminApiUserDTO>
|
|
54
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
55
|
-
puts "Error when calling APIKeysApi->create_api_key_with_http_info: #{e}"
|
|
56
|
-
end
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Parameters
|
|
60
|
-
|
|
61
|
-
| Name | Type | Description | Notes |
|
|
62
|
-
| ---- | ---- | ----------- | ----- |
|
|
63
|
-
| **create_api_key_dto** | [**CreateApiKeyDTO**](CreateApiKeyDTO.md) | | |
|
|
64
|
-
|
|
65
|
-
### Return type
|
|
66
|
-
|
|
67
|
-
[**AdminApiUserDTO**](AdminApiUserDTO.md)
|
|
68
|
-
|
|
69
|
-
### Authorization
|
|
70
|
-
|
|
71
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
72
|
-
|
|
73
|
-
### HTTP request headers
|
|
74
|
-
|
|
75
|
-
- **Content-Type**: application/json
|
|
76
|
-
- **Accept**: application/json
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
## delete_api_key
|
|
80
|
-
|
|
81
|
-
> Object delete_api_key(id)
|
|
82
|
-
|
|
83
|
-
delete an API key
|
|
84
|
-
|
|
85
|
-
### Examples
|
|
86
|
-
|
|
87
|
-
```ruby
|
|
88
|
-
require 'time'
|
|
89
|
-
require 'songtradr_api_client_ruby'
|
|
90
|
-
# setup authorization
|
|
91
|
-
SongtradrApiClientRuby.configure do |config|
|
|
92
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
93
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
94
|
-
end
|
|
95
|
-
|
|
96
|
-
api_instance = SongtradrApiClientRuby::APIKeysApi.new
|
|
97
|
-
id = 'id_example' # String |
|
|
98
|
-
|
|
99
|
-
begin
|
|
100
|
-
# delete an API key
|
|
101
|
-
result = api_instance.delete_api_key(id)
|
|
102
|
-
p result
|
|
103
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
104
|
-
puts "Error when calling APIKeysApi->delete_api_key: #{e}"
|
|
105
|
-
end
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
#### Using the delete_api_key_with_http_info variant
|
|
109
|
-
|
|
110
|
-
This returns an Array which contains the response data, status code and headers.
|
|
111
|
-
|
|
112
|
-
> <Array(Object, Integer, Hash)> delete_api_key_with_http_info(id)
|
|
113
|
-
|
|
114
|
-
```ruby
|
|
115
|
-
begin
|
|
116
|
-
# delete an API key
|
|
117
|
-
data, status_code, headers = api_instance.delete_api_key_with_http_info(id)
|
|
118
|
-
p status_code # => 2xx
|
|
119
|
-
p headers # => { ... }
|
|
120
|
-
p data # => Object
|
|
121
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
122
|
-
puts "Error when calling APIKeysApi->delete_api_key_with_http_info: #{e}"
|
|
123
|
-
end
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Parameters
|
|
127
|
-
|
|
128
|
-
| Name | Type | Description | Notes |
|
|
129
|
-
| ---- | ---- | ----------- | ----- |
|
|
130
|
-
| **id** | **String** | | |
|
|
131
|
-
|
|
132
|
-
### Return type
|
|
133
|
-
|
|
134
|
-
**Object**
|
|
135
|
-
|
|
136
|
-
### Authorization
|
|
137
|
-
|
|
138
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
139
|
-
|
|
140
|
-
### HTTP request headers
|
|
141
|
-
|
|
142
|
-
- **Content-Type**: Not defined
|
|
143
|
-
- **Accept**: application/json
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
## get_api_keys
|
|
147
|
-
|
|
148
|
-
> <Array<ApiKeyDTO>> get_api_keys(opts)
|
|
149
|
-
|
|
150
|
-
list API keys
|
|
151
|
-
|
|
152
|
-
### Examples
|
|
153
|
-
|
|
154
|
-
```ruby
|
|
155
|
-
require 'time'
|
|
156
|
-
require 'songtradr_api_client_ruby'
|
|
157
|
-
# setup authorization
|
|
158
|
-
SongtradrApiClientRuby.configure do |config|
|
|
159
|
-
# Configure Bearer authorization (JWT): bearer-jwt
|
|
160
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
161
|
-
end
|
|
162
|
-
|
|
163
|
-
api_instance = SongtradrApiClientRuby::APIKeysApi.new
|
|
164
|
-
opts = {
|
|
165
|
-
page: 56, # Integer | Zero-based page index (0..N)
|
|
166
|
-
size: 56, # Integer | The size of the page to be returned
|
|
167
|
-
sort: ['inner_example'] # Array<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
begin
|
|
171
|
-
# list API keys
|
|
172
|
-
result = api_instance.get_api_keys(opts)
|
|
173
|
-
p result
|
|
174
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
175
|
-
puts "Error when calling APIKeysApi->get_api_keys: #{e}"
|
|
176
|
-
end
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
#### Using the get_api_keys_with_http_info variant
|
|
180
|
-
|
|
181
|
-
This returns an Array which contains the response data, status code and headers.
|
|
182
|
-
|
|
183
|
-
> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> get_api_keys_with_http_info(opts)
|
|
184
|
-
|
|
185
|
-
```ruby
|
|
186
|
-
begin
|
|
187
|
-
# list API keys
|
|
188
|
-
data, status_code, headers = api_instance.get_api_keys_with_http_info(opts)
|
|
189
|
-
p status_code # => 2xx
|
|
190
|
-
p headers # => { ... }
|
|
191
|
-
p data # => <Array<ApiKeyDTO>>
|
|
192
|
-
rescue SongtradrApiClientRuby::ApiError => e
|
|
193
|
-
puts "Error when calling APIKeysApi->get_api_keys_with_http_info: #{e}"
|
|
194
|
-
end
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
### Parameters
|
|
198
|
-
|
|
199
|
-
| Name | Type | Description | Notes |
|
|
200
|
-
| ---- | ---- | ----------- | ----- |
|
|
201
|
-
| **page** | **Integer** | Zero-based page index (0..N) | [optional][default to 0] |
|
|
202
|
-
| **size** | **Integer** | The size of the page to be returned | [optional][default to 20] |
|
|
203
|
-
| **sort** | [**Array<String>**](String.md) | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] |
|
|
204
|
-
|
|
205
|
-
### Return type
|
|
206
|
-
|
|
207
|
-
[**Array<ApiKeyDTO>**](ApiKeyDTO.md)
|
|
208
|
-
|
|
209
|
-
### Authorization
|
|
210
|
-
|
|
211
|
-
[bearer-jwt](../README.md#bearer-jwt)
|
|
212
|
-
|
|
213
|
-
### HTTP request headers
|
|
214
|
-
|
|
215
|
-
- **Content-Type**: Not defined
|
|
216
|
-
- **Accept**: application/json
|
|
217
|
-
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
# SongtradrApiClientRuby::AdminApiCreateUserDTO
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **password** | **String** | | [optional] |
|
|
8
|
-
| **email** | **String** | | |
|
|
9
|
-
| **full_name** | **String** | | |
|
|
10
|
-
| **language** | **String** | | [optional] |
|
|
11
|
-
| **is_admin** | **Boolean** | | [optional] |
|
|
12
|
-
| **widgets_allowed** | **Boolean** | | [optional] |
|
|
13
|
-
| **full_search_allowed** | **Boolean** | | [optional] |
|
|
14
|
-
| **voice_search_allowed** | **Boolean** | | [optional] |
|
|
15
|
-
| **recording_detail_allowed** | **Boolean** | | [optional] |
|
|
16
|
-
| **artist_detail_allowed** | **Boolean** | | [optional] |
|
|
17
|
-
| **playlist_prediction_allowed** | **Boolean** | | [optional] |
|
|
18
|
-
| **signup_allowed** | **Boolean** | | [optional] |
|
|
19
|
-
| **upload_allowed** | **Boolean** | | [optional] |
|
|
20
|
-
| **fingerprint_allowed** | **Boolean** | | [optional] |
|
|
21
|
-
| **audiotagging_allowed** | **Boolean** | | [optional] |
|
|
22
|
-
| **insights_allowed** | **Boolean** | | [optional] |
|
|
23
|
-
| **genres_allowed** | **Boolean** | | [optional] |
|
|
24
|
-
| **moods_allowed** | **Boolean** | | [optional] |
|
|
25
|
-
| **instrumentation_allowed** | **Boolean** | | [optional] |
|
|
26
|
-
| **sound_features_allowed** | **Boolean** | | [optional] |
|
|
27
|
-
| **tonal_features_allowed** | **Boolean** | | [optional] |
|
|
28
|
-
| **rhythm_features_allowed** | **Boolean** | | [optional] |
|
|
29
|
-
| **audience_allowed** | **Boolean** | | [optional] |
|
|
30
|
-
| **origin_allowed** | **Boolean** | | [optional] |
|
|
31
|
-
| **quality_allowed** | **Boolean** | | [optional] |
|
|
32
|
-
| **b2b_allowed** | **Boolean** | | [optional] |
|
|
33
|
-
| **editor_allowed** | **Boolean** | | [optional] |
|
|
34
|
-
| **reduced_musical_features** | **Boolean** | | [optional] |
|
|
35
|
-
| **trusted_to_set_ids** | **Boolean** | | [optional] |
|
|
36
|
-
| **confirmed** | **Boolean** | | [optional] |
|
|
37
|
-
|
|
38
|
-
## Example
|
|
39
|
-
|
|
40
|
-
```ruby
|
|
41
|
-
require 'songtradr_api_client_ruby'
|
|
42
|
-
|
|
43
|
-
instance = SongtradrApiClientRuby::AdminApiCreateUserDTO.new(
|
|
44
|
-
password: null,
|
|
45
|
-
email: null,
|
|
46
|
-
full_name: null,
|
|
47
|
-
language: null,
|
|
48
|
-
is_admin: null,
|
|
49
|
-
widgets_allowed: null,
|
|
50
|
-
full_search_allowed: null,
|
|
51
|
-
voice_search_allowed: null,
|
|
52
|
-
recording_detail_allowed: null,
|
|
53
|
-
artist_detail_allowed: null,
|
|
54
|
-
playlist_prediction_allowed: null,
|
|
55
|
-
signup_allowed: null,
|
|
56
|
-
upload_allowed: null,
|
|
57
|
-
fingerprint_allowed: null,
|
|
58
|
-
audiotagging_allowed: null,
|
|
59
|
-
insights_allowed: null,
|
|
60
|
-
genres_allowed: null,
|
|
61
|
-
moods_allowed: null,
|
|
62
|
-
instrumentation_allowed: null,
|
|
63
|
-
sound_features_allowed: null,
|
|
64
|
-
tonal_features_allowed: null,
|
|
65
|
-
rhythm_features_allowed: null,
|
|
66
|
-
audience_allowed: null,
|
|
67
|
-
origin_allowed: null,
|
|
68
|
-
quality_allowed: null,
|
|
69
|
-
b2b_allowed: null,
|
|
70
|
-
editor_allowed: null,
|
|
71
|
-
reduced_musical_features: null,
|
|
72
|
-
trusted_to_set_ids: null,
|
|
73
|
-
confirmed: null
|
|
74
|
-
)
|
|
75
|
-
```
|
|
76
|
-
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
# SongtradrApiClientRuby::AdminApiUpdateUserDTO
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **username** | **String** | | [optional] |
|
|
8
|
-
| **email** | **String** | | [optional] |
|
|
9
|
-
| **password** | **String** | | [optional] |
|
|
10
|
-
| **full_name** | **String** | | [optional] |
|
|
11
|
-
| **language** | **String** | | [optional] |
|
|
12
|
-
| **is_admin** | **Boolean** | | [optional] |
|
|
13
|
-
| **widgets_allowed** | **Boolean** | | [optional] |
|
|
14
|
-
| **full_search_allowed** | **Boolean** | | [optional] |
|
|
15
|
-
| **voice_search_allowed** | **Boolean** | | [optional] |
|
|
16
|
-
| **recording_detail_allowed** | **Boolean** | | [optional] |
|
|
17
|
-
| **artist_detail_allowed** | **Boolean** | | [optional] |
|
|
18
|
-
| **playlist_prediction_allowed** | **Boolean** | | [optional] |
|
|
19
|
-
| **signup_allowed** | **Boolean** | | [optional] |
|
|
20
|
-
| **upload_allowed** | **Boolean** | | [optional] |
|
|
21
|
-
| **fingerprint_allowed** | **Boolean** | | [optional] |
|
|
22
|
-
| **audiotagging_allowed** | **Boolean** | | [optional] |
|
|
23
|
-
| **insights_allowed** | **Boolean** | | [optional] |
|
|
24
|
-
| **genres_allowed** | **Boolean** | | [optional] |
|
|
25
|
-
| **moods_allowed** | **Boolean** | | [optional] |
|
|
26
|
-
| **instrumentation_allowed** | **Boolean** | | [optional] |
|
|
27
|
-
| **sound_features_allowed** | **Boolean** | | [optional] |
|
|
28
|
-
| **tonal_features_allowed** | **Boolean** | | [optional] |
|
|
29
|
-
| **rhythm_features_allowed** | **Boolean** | | [optional] |
|
|
30
|
-
| **audience_allowed** | **Boolean** | | [optional] |
|
|
31
|
-
| **origin_allowed** | **Boolean** | | [optional] |
|
|
32
|
-
| **quality_allowed** | **Boolean** | | [optional] |
|
|
33
|
-
| **b2b_allowed** | **Boolean** | | [optional] |
|
|
34
|
-
| **editor_allowed** | **Boolean** | | [optional] |
|
|
35
|
-
| **reduced_musical_features** | **Boolean** | | [optional] |
|
|
36
|
-
| **confirmed** | **Boolean** | | [optional] |
|
|
37
|
-
|
|
38
|
-
## Example
|
|
39
|
-
|
|
40
|
-
```ruby
|
|
41
|
-
require 'songtradr_api_client_ruby'
|
|
42
|
-
|
|
43
|
-
instance = SongtradrApiClientRuby::AdminApiUpdateUserDTO.new(
|
|
44
|
-
username: null,
|
|
45
|
-
email: null,
|
|
46
|
-
password: null,
|
|
47
|
-
full_name: null,
|
|
48
|
-
language: null,
|
|
49
|
-
is_admin: null,
|
|
50
|
-
widgets_allowed: null,
|
|
51
|
-
full_search_allowed: null,
|
|
52
|
-
voice_search_allowed: null,
|
|
53
|
-
recording_detail_allowed: null,
|
|
54
|
-
artist_detail_allowed: null,
|
|
55
|
-
playlist_prediction_allowed: null,
|
|
56
|
-
signup_allowed: null,
|
|
57
|
-
upload_allowed: null,
|
|
58
|
-
fingerprint_allowed: null,
|
|
59
|
-
audiotagging_allowed: null,
|
|
60
|
-
insights_allowed: null,
|
|
61
|
-
genres_allowed: null,
|
|
62
|
-
moods_allowed: null,
|
|
63
|
-
instrumentation_allowed: null,
|
|
64
|
-
sound_features_allowed: null,
|
|
65
|
-
tonal_features_allowed: null,
|
|
66
|
-
rhythm_features_allowed: null,
|
|
67
|
-
audience_allowed: null,
|
|
68
|
-
origin_allowed: null,
|
|
69
|
-
quality_allowed: null,
|
|
70
|
-
b2b_allowed: null,
|
|
71
|
-
editor_allowed: null,
|
|
72
|
-
reduced_musical_features: null,
|
|
73
|
-
confirmed: null
|
|
74
|
-
)
|
|
75
|
-
```
|
|
76
|
-
|
data/docs/AdminApiUserDTO.md
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
# SongtradrApiClientRuby::AdminApiUserDTO
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | | [optional] |
|
|
8
|
-
| **username** | **String** | | [optional] |
|
|
9
|
-
| **email** | **String** | | [optional] |
|
|
10
|
-
| **full_name** | **String** | | [optional] |
|
|
11
|
-
| **language** | **String** | | [optional] |
|
|
12
|
-
| **is_admin** | **Boolean** | | [optional] |
|
|
13
|
-
| **widgets_allowed** | **Boolean** | | [optional] |
|
|
14
|
-
| **full_search_allowed** | **Boolean** | | [optional] |
|
|
15
|
-
| **voice_search_allowed** | **Boolean** | | [optional] |
|
|
16
|
-
| **recording_detail_allowed** | **Boolean** | | [optional] |
|
|
17
|
-
| **artist_detail_allowed** | **Boolean** | | [optional] |
|
|
18
|
-
| **playlist_prediction_allowed** | **Boolean** | | [optional] |
|
|
19
|
-
| **signup_allowed** | **Boolean** | | [optional] |
|
|
20
|
-
| **upload_allowed** | **Boolean** | | [optional] |
|
|
21
|
-
| **fingerprint_allowed** | **Boolean** | | [optional] |
|
|
22
|
-
| **audiotagging_allowed** | **Boolean** | | [optional] |
|
|
23
|
-
| **b2b_allowed** | **Boolean** | | [optional] |
|
|
24
|
-
| **editor_allowed** | **Boolean** | | [optional] |
|
|
25
|
-
| **reduced_musical_features** | **Boolean** | | [optional] |
|
|
26
|
-
| **confirmed** | **Boolean** | | [optional] |
|
|
27
|
-
| **gdpr_confirmation_timestamp** | **Time** | | [optional] |
|
|
28
|
-
| **last_login** | **Time** | | [optional] |
|
|
29
|
-
| **total_logins** | **Integer** | | [optional] |
|
|
30
|
-
| **total_searches** | **Integer** | | [optional] |
|
|
31
|
-
| **total_uploads** | **Integer** | | [optional] |
|
|
32
|
-
| **total_downloads** | **Integer** | | [optional] |
|
|
33
|
-
| **total_updates** | **Integer** | | [optional] |
|
|
34
|
-
|
|
35
|
-
## Example
|
|
36
|
-
|
|
37
|
-
```ruby
|
|
38
|
-
require 'songtradr_api_client_ruby'
|
|
39
|
-
|
|
40
|
-
instance = SongtradrApiClientRuby::AdminApiUserDTO.new(
|
|
41
|
-
id: null,
|
|
42
|
-
username: null,
|
|
43
|
-
email: null,
|
|
44
|
-
full_name: null,
|
|
45
|
-
language: null,
|
|
46
|
-
is_admin: null,
|
|
47
|
-
widgets_allowed: null,
|
|
48
|
-
full_search_allowed: null,
|
|
49
|
-
voice_search_allowed: null,
|
|
50
|
-
recording_detail_allowed: null,
|
|
51
|
-
artist_detail_allowed: null,
|
|
52
|
-
playlist_prediction_allowed: null,
|
|
53
|
-
signup_allowed: null,
|
|
54
|
-
upload_allowed: null,
|
|
55
|
-
fingerprint_allowed: null,
|
|
56
|
-
audiotagging_allowed: null,
|
|
57
|
-
b2b_allowed: null,
|
|
58
|
-
editor_allowed: null,
|
|
59
|
-
reduced_musical_features: null,
|
|
60
|
-
confirmed: null,
|
|
61
|
-
gdpr_confirmation_timestamp: null,
|
|
62
|
-
last_login: null,
|
|
63
|
-
total_logins: null,
|
|
64
|
-
total_searches: null,
|
|
65
|
-
total_uploads: null,
|
|
66
|
-
total_downloads: null,
|
|
67
|
-
total_updates: null
|
|
68
|
-
)
|
|
69
|
-
```
|
|
70
|
-
|