qsafe-sdk 1.0.4
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 +7 -0
- data/Gemfile +9 -0
- data/README.md +134 -0
- data/Rakefile +10 -0
- data/docs/APIKeysApi.md +427 -0
- data/docs/ApiKey.md +40 -0
- data/docs/AuthResponse.md +20 -0
- data/docs/AuthResponseData.md +26 -0
- data/docs/AuthenticationApi.md +276 -0
- data/docs/ChangePassword200Response.md +20 -0
- data/docs/ChangePasswordRequest.md +20 -0
- data/docs/CreateApiKey201Response.md +20 -0
- data/docs/CreateApiKey201ResponseData.md +20 -0
- data/docs/CreateApiKeyRequest.md +28 -0
- data/docs/CryptographicOperationsApi.md +331 -0
- data/docs/DebugApi.md +84 -0
- data/docs/DebugRedisTest200Response.md +30 -0
- data/docs/DebugRedisTest200ResponseRateLimitTest.md +22 -0
- data/docs/DebugRedisTest200ResponseServicesStatus.md +24 -0
- data/docs/DebugRedisTest500Response.md +20 -0
- data/docs/DecryptData200Response.md +20 -0
- data/docs/DecryptData200ResponseData.md +24 -0
- data/docs/DecryptRequest.md +28 -0
- data/docs/DecryptRequestEphemeralCrypto.md +24 -0
- data/docs/EncryptData200Response.md +20 -0
- data/docs/EncryptData200ResponseData.md +28 -0
- data/docs/EncryptData200ResponseDataEphemeralStorage.md +22 -0
- data/docs/EncryptRequest.md +26 -0
- data/docs/EncryptRequestEphemeralStorage.md +22 -0
- data/docs/Error.md +28 -0
- data/docs/GenerateKeypair201Response.md +20 -0
- data/docs/GenerateKeypairRequest.md +24 -0
- data/docs/GenerateKeypairRequestKeyPolicy.md +20 -0
- data/docs/GetApiKey200Response.md +20 -0
- data/docs/GetApiKeyUsage200Response.md +20 -0
- data/docs/GetApiKeyUsage200ResponseData.md +22 -0
- data/docs/GetApiKeyUsage200ResponseDataDailyUsageInner.md +20 -0
- data/docs/GetAuthInfo200Response.md +20 -0
- data/docs/GetAuthInfo200ResponseData.md +26 -0
- data/docs/GetHealth200Response.md +22 -0
- data/docs/GetHealth200ResponseServices.md +22 -0
- data/docs/GetHealth200ResponseServicesApi.md +22 -0
- data/docs/GetHealth200ResponseServicesEphemeralStorage.md +18 -0
- data/docs/GetHealth200ResponseServicesRedis.md +20 -0
- data/docs/GetRateLimitStatus200Response.md +20 -0
- data/docs/GetRateLimitStatus200ResponseData.md +22 -0
- data/docs/GetRateLimitStatus200ResponseDataCurrentUsage.md +22 -0
- data/docs/GetRateLimitStatus200ResponseDataLimits.md +22 -0
- data/docs/GetRateLimitStatus200ResponseDataResetTimes.md +22 -0
- data/docs/HealthApi.md +69 -0
- data/docs/Keypair.md +40 -0
- data/docs/KeypairsApi.md +341 -0
- data/docs/ListApiKeys200Response.md +20 -0
- data/docs/ListApiKeys200ResponseData.md +22 -0
- data/docs/ListApiKeys200ResponseDataPagination.md +22 -0
- data/docs/ListKeypairs200Response.md +20 -0
- data/docs/ListKeypairs200ResponseData.md +22 -0
- data/docs/ListKeypairs200ResponseDataPagination.md +22 -0
- data/docs/LoginRequest.md +20 -0
- data/docs/RegisterRequest.md +24 -0
- data/docs/RevokeKeypair200Response.md +22 -0
- data/docs/RevokeKeypairRequest.md +22 -0
- data/docs/RotateApiKey200Response.md +20 -0
- data/docs/RotateApiKey200ResponseData.md +20 -0
- data/docs/SignData200Response.md +20 -0
- data/docs/SignData200ResponseData.md +30 -0
- data/docs/SignData200ResponseDataEphemeralStorage.md +22 -0
- data/docs/SignRequest.md +26 -0
- data/docs/SignRequestEphemeralStorage.md +20 -0
- data/docs/UpdateApiKeyRequest.md +28 -0
- data/docs/UpdateKeypair200Response.md +20 -0
- data/docs/UpdateKeypairRequest.md +24 -0
- data/docs/User.md +32 -0
- data/docs/UtilitiesApi.md +81 -0
- data/docs/VerifyRequest.md +26 -0
- data/docs/VerifySignature200Response.md +20 -0
- data/docs/VerifySignature200ResponseData.md +22 -0
- data/docs/VerifySignature200ResponseDataSignatureInfo.md +20 -0
- data/docs/VerifySignature200ResponseDataVerificationResult.md +22 -0
- data/git_push.sh +57 -0
- data/lib/qsafe/api/api_keys_api.rb +430 -0
- data/lib/qsafe/api/authentication_api.rb +275 -0
- data/lib/qsafe/api/cryptographic_operations_api.rb +314 -0
- data/lib/qsafe/api/debug_api.rb +79 -0
- data/lib/qsafe/api/health_api.rb +79 -0
- data/lib/qsafe/api/keypairs_api.rb +345 -0
- data/lib/qsafe/api/utilities_api.rb +79 -0
- data/lib/qsafe/api_client.rb +394 -0
- data/lib/qsafe/api_error.rb +58 -0
- data/lib/qsafe/configuration.rb +327 -0
- data/lib/qsafe/models/api_key.rb +325 -0
- data/lib/qsafe/models/auth_response.rb +223 -0
- data/lib/qsafe/models/auth_response_data.rb +242 -0
- data/lib/qsafe/models/change_password200_response.rb +223 -0
- data/lib/qsafe/models/change_password_request.rb +256 -0
- data/lib/qsafe/models/create_api_key201_response.rb +233 -0
- data/lib/qsafe/models/create_api_key_request.rb +350 -0
- data/lib/qsafe/models/debug_redis_test200_response.rb +304 -0
- data/lib/qsafe/models/debug_redis_test200_response_rate_limit_test.rb +232 -0
- data/lib/qsafe/models/debug_redis_test200_response_services_status.rb +241 -0
- data/lib/qsafe/models/debug_redis_test500_response.rb +223 -0
- data/lib/qsafe/models/decrypt_data200_response.rb +223 -0
- data/lib/qsafe/models/decrypt_data200_response_data.rb +242 -0
- data/lib/qsafe/models/decrypt_request.rb +301 -0
- data/lib/qsafe/models/decrypt_request_ephemeral_crypto.rb +276 -0
- data/lib/qsafe/models/encrypt_data200_response.rb +223 -0
- data/lib/qsafe/models/encrypt_data200_response_data.rb +263 -0
- data/lib/qsafe/models/encrypt_request.rb +322 -0
- data/lib/qsafe/models/encrypt_request_ephemeral_storage.rb +289 -0
- data/lib/qsafe/models/error.rb +275 -0
- data/lib/qsafe/models/generate_keypair201_response.rb +233 -0
- data/lib/qsafe/models/generate_keypair_request.rb +297 -0
- data/lib/qsafe/models/generate_keypair_request_key_policy.rb +266 -0
- data/lib/qsafe/models/get_api_key200_response.rb +223 -0
- data/lib/qsafe/models/get_api_key_usage200_response.rb +223 -0
- data/lib/qsafe/models/get_api_key_usage200_response_data.rb +236 -0
- data/lib/qsafe/models/get_api_key_usage200_response_data_daily_usage_inner.rb +223 -0
- data/lib/qsafe/models/get_auth_info200_response.rb +223 -0
- data/lib/qsafe/models/get_auth_info200_response_data.rb +284 -0
- data/lib/qsafe/models/get_health200_response.rb +232 -0
- data/lib/qsafe/models/get_health200_response_services.rb +232 -0
- data/lib/qsafe/models/get_health200_response_services_api.rb +232 -0
- data/lib/qsafe/models/get_health200_response_services_ephemeral_storage.rb +214 -0
- data/lib/qsafe/models/get_health200_response_services_redis.rb +223 -0
- data/lib/qsafe/models/get_rate_limit_status200_response.rb +223 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data.rb +232 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data_current_usage.rb +232 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data_limits.rb +232 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data_reset_times.rb +232 -0
- data/lib/qsafe/models/keypair.rb +379 -0
- data/lib/qsafe/models/list_api_keys200_response.rb +223 -0
- data/lib/qsafe/models/list_api_keys200_response_data.rb +234 -0
- data/lib/qsafe/models/list_api_keys200_response_data_pagination.rb +232 -0
- data/lib/qsafe/models/list_keypairs200_response.rb +223 -0
- data/lib/qsafe/models/list_keypairs200_response_data.rb +234 -0
- data/lib/qsafe/models/list_keypairs200_response_data_pagination.rb +232 -0
- data/lib/qsafe/models/login_request.rb +237 -0
- data/lib/qsafe/models/register_request.rb +345 -0
- data/lib/qsafe/models/revoke_keypair200_response.rb +232 -0
- data/lib/qsafe/models/revoke_keypair_request.rb +301 -0
- data/lib/qsafe/models/rotate_api_key200_response.rb +232 -0
- data/lib/qsafe/models/sign_data200_response.rb +223 -0
- data/lib/qsafe/models/sign_data200_response_data.rb +262 -0
- data/lib/qsafe/models/sign_request.rb +321 -0
- data/lib/qsafe/models/sign_request_ephemeral_storage.rb +279 -0
- data/lib/qsafe/models/update_api_key_request.rb +343 -0
- data/lib/qsafe/models/update_keypair200_response.rb +223 -0
- data/lib/qsafe/models/update_keypair_request.rb +317 -0
- data/lib/qsafe/models/user.rb +293 -0
- data/lib/qsafe/models/verify_request.rb +389 -0
- data/lib/qsafe/models/verify_signature200_response.rb +223 -0
- data/lib/qsafe/models/verify_signature200_response_data.rb +251 -0
- data/lib/qsafe/version.rb +15 -0
- data/lib/qsafe-sdk/api/api_keys_api.rb +430 -0
- data/lib/qsafe-sdk/api/authentication_api.rb +275 -0
- data/lib/qsafe-sdk/api/cryptographic_operations_api.rb +314 -0
- data/lib/qsafe-sdk/api/debug_api.rb +79 -0
- data/lib/qsafe-sdk/api/health_api.rb +79 -0
- data/lib/qsafe-sdk/api/keypairs_api.rb +345 -0
- data/lib/qsafe-sdk/api/utilities_api.rb +79 -0
- data/lib/qsafe-sdk/api_client.rb +394 -0
- data/lib/qsafe-sdk/api_error.rb +58 -0
- data/lib/qsafe-sdk/configuration.rb +327 -0
- data/lib/qsafe-sdk/models/api_key.rb +345 -0
- data/lib/qsafe-sdk/models/auth_response.rb +223 -0
- data/lib/qsafe-sdk/models/auth_response_data.rb +252 -0
- data/lib/qsafe-sdk/models/change_password200_response.rb +223 -0
- data/lib/qsafe-sdk/models/change_password_request.rb +256 -0
- data/lib/qsafe-sdk/models/create_api_key201_response.rb +223 -0
- data/lib/qsafe-sdk/models/create_api_key201_response_data.rb +224 -0
- data/lib/qsafe-sdk/models/create_api_key_request.rb +350 -0
- data/lib/qsafe-sdk/models/debug_redis_test200_response.rb +304 -0
- data/lib/qsafe-sdk/models/debug_redis_test200_response_rate_limit_test.rb +232 -0
- data/lib/qsafe-sdk/models/debug_redis_test200_response_services_status.rb +241 -0
- data/lib/qsafe-sdk/models/debug_redis_test500_response.rb +223 -0
- data/lib/qsafe-sdk/models/decrypt_data200_response.rb +223 -0
- data/lib/qsafe-sdk/models/decrypt_data200_response_data.rb +242 -0
- data/lib/qsafe-sdk/models/decrypt_request.rb +301 -0
- data/lib/qsafe-sdk/models/decrypt_request_ephemeral_crypto.rb +276 -0
- data/lib/qsafe-sdk/models/encrypt_data200_response.rb +223 -0
- data/lib/qsafe-sdk/models/encrypt_data200_response_data.rb +262 -0
- data/lib/qsafe-sdk/models/encrypt_data200_response_data_ephemeral_storage.rb +235 -0
- data/lib/qsafe-sdk/models/encrypt_request.rb +322 -0
- data/lib/qsafe-sdk/models/encrypt_request_ephemeral_storage.rb +289 -0
- data/lib/qsafe-sdk/models/error.rb +275 -0
- data/lib/qsafe-sdk/models/generate_keypair201_response.rb +223 -0
- data/lib/qsafe-sdk/models/generate_keypair_request.rb +297 -0
- data/lib/qsafe-sdk/models/generate_keypair_request_key_policy.rb +266 -0
- data/lib/qsafe-sdk/models/get_api_key200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_api_key_usage200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_api_key_usage200_response_data.rb +236 -0
- data/lib/qsafe-sdk/models/get_api_key_usage200_response_data_daily_usage_inner.rb +223 -0
- data/lib/qsafe-sdk/models/get_auth_info200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_auth_info200_response_data.rb +284 -0
- data/lib/qsafe-sdk/models/get_health200_response.rb +232 -0
- data/lib/qsafe-sdk/models/get_health200_response_services.rb +232 -0
- data/lib/qsafe-sdk/models/get_health200_response_services_api.rb +232 -0
- data/lib/qsafe-sdk/models/get_health200_response_services_ephemeral_storage.rb +214 -0
- data/lib/qsafe-sdk/models/get_health200_response_services_redis.rb +223 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data.rb +232 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data_current_usage.rb +232 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data_limits.rb +232 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data_reset_times.rb +232 -0
- data/lib/qsafe-sdk/models/keypair.rb +379 -0
- data/lib/qsafe-sdk/models/list_api_keys200_response.rb +223 -0
- data/lib/qsafe-sdk/models/list_api_keys200_response_data.rb +234 -0
- data/lib/qsafe-sdk/models/list_api_keys200_response_data_pagination.rb +232 -0
- data/lib/qsafe-sdk/models/list_keypairs200_response.rb +223 -0
- data/lib/qsafe-sdk/models/list_keypairs200_response_data.rb +234 -0
- data/lib/qsafe-sdk/models/list_keypairs200_response_data_pagination.rb +232 -0
- data/lib/qsafe-sdk/models/login_request.rb +237 -0
- data/lib/qsafe-sdk/models/register_request.rb +345 -0
- data/lib/qsafe-sdk/models/revoke_keypair200_response.rb +232 -0
- data/lib/qsafe-sdk/models/revoke_keypair_request.rb +301 -0
- data/lib/qsafe-sdk/models/rotate_api_key200_response.rb +223 -0
- data/lib/qsafe-sdk/models/rotate_api_key200_response_data.rb +224 -0
- data/lib/qsafe-sdk/models/sign_data200_response.rb +223 -0
- data/lib/qsafe-sdk/models/sign_data200_response_data.rb +270 -0
- data/lib/qsafe-sdk/models/sign_data200_response_data_ephemeral_storage.rb +234 -0
- data/lib/qsafe-sdk/models/sign_request.rb +321 -0
- data/lib/qsafe-sdk/models/sign_request_ephemeral_storage.rb +279 -0
- data/lib/qsafe-sdk/models/update_api_key_request.rb +343 -0
- data/lib/qsafe-sdk/models/update_keypair200_response.rb +223 -0
- data/lib/qsafe-sdk/models/update_keypair_request.rb +317 -0
- data/lib/qsafe-sdk/models/user.rb +312 -0
- data/lib/qsafe-sdk/models/verify_request.rb +389 -0
- data/lib/qsafe-sdk/models/verify_signature200_response.rb +223 -0
- data/lib/qsafe-sdk/models/verify_signature200_response_data.rb +232 -0
- data/lib/qsafe-sdk/models/verify_signature200_response_data_signature_info.rb +223 -0
- data/lib/qsafe-sdk/models/verify_signature200_response_data_verification_result.rb +233 -0
- data/lib/qsafe-sdk/version.rb +15 -0
- data/lib/qsafe-sdk.rb +114 -0
- data/lib/qsafe.rb +108 -0
- data/qsafe-sdk.gemspec +39 -0
- data/qsafe.gemspec +39 -0
- data/spec/api/api_keys_api_spec.rb +105 -0
- data/spec/api/authentication_api_spec.rb +78 -0
- data/spec/api/cryptographic_operations_api_spec.rb +85 -0
- data/spec/api/debug_api_spec.rb +46 -0
- data/spec/api/health_api_spec.rb +46 -0
- data/spec/api/keypairs_api_spec.rb +89 -0
- data/spec/api/utilities_api_spec.rb +46 -0
- data/spec/models/api_key_spec.rb +94 -0
- data/spec/models/auth_response_data_spec.rb +54 -0
- data/spec/models/auth_response_spec.rb +42 -0
- data/spec/models/change_password200_response_spec.rb +42 -0
- data/spec/models/change_password_request_spec.rb +42 -0
- data/spec/models/create_api_key201_response_data_spec.rb +42 -0
- data/spec/models/create_api_key201_response_spec.rb +48 -0
- data/spec/models/create_api_key_request_spec.rb +70 -0
- data/spec/models/debug_redis_test200_response_rate_limit_test_spec.rb +48 -0
- data/spec/models/debug_redis_test200_response_services_status_spec.rb +54 -0
- data/spec/models/debug_redis_test200_response_spec.rb +76 -0
- data/spec/models/debug_redis_test500_response_spec.rb +42 -0
- data/spec/models/decrypt_data200_response_data_spec.rb +54 -0
- data/spec/models/decrypt_data200_response_spec.rb +42 -0
- data/spec/models/decrypt_request_ephemeral_crypto_spec.rb +54 -0
- data/spec/models/decrypt_request_spec.rb +66 -0
- data/spec/models/encrypt_data200_response_data_ephemeral_storage_spec.rb +48 -0
- data/spec/models/encrypt_data200_response_data_spec.rb +66 -0
- data/spec/models/encrypt_data200_response_spec.rb +42 -0
- data/spec/models/encrypt_request_ephemeral_storage_spec.rb +48 -0
- data/spec/models/encrypt_request_spec.rb +64 -0
- data/spec/models/error_spec.rb +66 -0
- data/spec/models/generate_keypair201_response_spec.rb +48 -0
- data/spec/models/generate_keypair_request_key_policy_spec.rb +46 -0
- data/spec/models/generate_keypair_request_spec.rb +62 -0
- data/spec/models/get_api_key200_response_spec.rb +42 -0
- data/spec/models/get_api_key_usage200_response_data_daily_usage_inner_spec.rb +42 -0
- data/spec/models/get_api_key_usage200_response_data_spec.rb +48 -0
- data/spec/models/get_api_key_usage200_response_spec.rb +42 -0
- data/spec/models/get_auth_info200_response_data_spec.rb +64 -0
- data/spec/models/get_auth_info200_response_spec.rb +42 -0
- data/spec/models/get_health200_response_services_api_spec.rb +48 -0
- data/spec/models/get_health200_response_services_ephemeral_storage_spec.rb +36 -0
- data/spec/models/get_health200_response_services_redis_spec.rb +42 -0
- data/spec/models/get_health200_response_services_spec.rb +48 -0
- data/spec/models/get_health200_response_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_current_usage_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_limits_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_reset_times_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_spec.rb +42 -0
- data/spec/models/keypair_spec.rb +114 -0
- data/spec/models/list_api_keys200_response_data_pagination_spec.rb +48 -0
- data/spec/models/list_api_keys200_response_data_spec.rb +48 -0
- data/spec/models/list_api_keys200_response_spec.rb +42 -0
- data/spec/models/list_keypairs200_response_data_pagination_spec.rb +48 -0
- data/spec/models/list_keypairs200_response_data_spec.rb +48 -0
- data/spec/models/list_keypairs200_response_spec.rb +42 -0
- data/spec/models/login_request_spec.rb +42 -0
- data/spec/models/register_request_spec.rb +54 -0
- data/spec/models/revoke_keypair200_response_spec.rb +48 -0
- data/spec/models/revoke_keypair_request_spec.rb +52 -0
- data/spec/models/rotate_api_key200_response_data_spec.rb +42 -0
- data/spec/models/rotate_api_key200_response_spec.rb +48 -0
- data/spec/models/sign_data200_response_data_ephemeral_storage_spec.rb +48 -0
- data/spec/models/sign_data200_response_data_spec.rb +66 -0
- data/spec/models/sign_data200_response_spec.rb +42 -0
- data/spec/models/sign_request_ephemeral_storage_spec.rb +42 -0
- data/spec/models/sign_request_spec.rb +64 -0
- data/spec/models/update_api_key_request_spec.rb +70 -0
- data/spec/models/update_keypair200_response_spec.rb +42 -0
- data/spec/models/update_keypair_request_spec.rb +58 -0
- data/spec/models/user_spec.rb +70 -0
- data/spec/models/verify_request_spec.rb +64 -0
- data/spec/models/verify_signature200_response_data_signature_info_spec.rb +42 -0
- data/spec/models/verify_signature200_response_data_spec.rb +60 -0
- data/spec/models/verify_signature200_response_data_verification_result_spec.rb +48 -0
- data/spec/models/verify_signature200_response_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +477 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# QSafe::EncryptRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plaintext** | **String** | | |
|
|
8
|
+
| **ephemeral_storage** | [**EncryptRequestEphemeralStorage**](EncryptRequestEphemeralStorage.md) | | [optional] |
|
|
9
|
+
| **compression** | **Boolean** | Compress before encrypting | [optional] |
|
|
10
|
+
| **priority** | **String** | | [optional] |
|
|
11
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'qsafe-sdk'
|
|
17
|
+
|
|
18
|
+
instance = QSafe::EncryptRequest.new(
|
|
19
|
+
plaintext: Hello, this is sensitive data to encrypt,
|
|
20
|
+
ephemeral_storage: null,
|
|
21
|
+
compression: false,
|
|
22
|
+
priority: NORMAL,
|
|
23
|
+
metadata: {"document_type":"financial_report","classification":"confidential"}
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::EncryptRequestEphemeralStorage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ttl** | **Integer** | Seconds to keep in ephemeral storage (60–3600) | [optional] |
|
|
8
|
+
| **max_access_count** | **Integer** | | [optional] |
|
|
9
|
+
| **auto_delete** | **Boolean** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::EncryptRequestEphemeralStorage.new(
|
|
17
|
+
ttl: 1800,
|
|
18
|
+
max_access_count: 3,
|
|
19
|
+
auto_delete: true
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/Error.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# QSafe::Error
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
|
+
| **error** | **String** | | |
|
|
9
|
+
| **code** | **String** | | [optional] |
|
|
10
|
+
| **message** | **String** | | [optional] |
|
|
11
|
+
| **request_id** | **String** | | [optional] |
|
|
12
|
+
| **details** | **Hash<String, Object>** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'qsafe-sdk'
|
|
18
|
+
|
|
19
|
+
instance = QSafe::Error.new(
|
|
20
|
+
success: false,
|
|
21
|
+
error: null,
|
|
22
|
+
code: null,
|
|
23
|
+
message: null,
|
|
24
|
+
request_id: null,
|
|
25
|
+
details: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GenerateKeypair201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**Keypair**](Keypair.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GenerateKeypair201Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# QSafe::GenerateKeypairRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **algorithm** | **String** | KYBER* = KEM (encryption); DILITHIUM* = signatures | |
|
|
8
|
+
| **purpose** | **String** | | [optional] |
|
|
9
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
10
|
+
| **key_policy** | [**GenerateKeypairRequestKeyPolicy**](GenerateKeypairRequestKeyPolicy.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'qsafe-sdk'
|
|
16
|
+
|
|
17
|
+
instance = QSafe::GenerateKeypairRequest.new(
|
|
18
|
+
algorithm: KYBER768,
|
|
19
|
+
purpose: KEM,
|
|
20
|
+
metadata: {"department":"finance","project":"secure-documents"},
|
|
21
|
+
key_policy: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GenerateKeypairRequestKeyPolicy
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **expiration_days** | **Integer** | | [optional] |
|
|
8
|
+
| **allowed_operations** | **Array<String>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GenerateKeypairRequestKeyPolicy.new(
|
|
16
|
+
expiration_days: 365,
|
|
17
|
+
allowed_operations: ["encrypt","decrypt"]
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GetApiKey200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**ApiKey**](ApiKey.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GetApiKey200Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GetApiKeyUsage200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**GetApiKeyUsage200ResponseData**](GetApiKeyUsage200ResponseData.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GetApiKeyUsage200Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetApiKeyUsage200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total_requests** | **Integer** | | [optional] |
|
|
8
|
+
| **requests_by_operation** | **Hash<String, Integer>** | | [optional] |
|
|
9
|
+
| **daily_usage** | [**Array<GetApiKeyUsage200ResponseDataDailyUsageInner>**](GetApiKeyUsage200ResponseDataDailyUsageInner.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetApiKeyUsage200ResponseData.new(
|
|
17
|
+
total_requests: 1500,
|
|
18
|
+
requests_by_operation: {"encrypt":500,"decrypt":400,"sign":350,"verify":250},
|
|
19
|
+
daily_usage: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GetApiKeyUsage200ResponseDataDailyUsageInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date** | **Date** | | [optional] |
|
|
8
|
+
| **requests** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GetApiKeyUsage200ResponseDataDailyUsageInner.new(
|
|
16
|
+
date: null,
|
|
17
|
+
requests: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GetAuthInfo200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**GetAuthInfo200ResponseData**](GetAuthInfo200ResponseData.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GetAuthInfo200Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# QSafe::GetAuthInfo200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **authenticated** | **Boolean** | | [optional] |
|
|
8
|
+
| **auth_type** | **String** | | [optional] |
|
|
9
|
+
| **timestamp** | **Time** | | [optional] |
|
|
10
|
+
| **user** | [**User**](User.md) | | [optional] |
|
|
11
|
+
| **api_key** | [**ApiKey**](ApiKey.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'qsafe-sdk'
|
|
17
|
+
|
|
18
|
+
instance = QSafe::GetAuthInfo200ResponseData.new(
|
|
19
|
+
authenticated: true,
|
|
20
|
+
auth_type: jwt,
|
|
21
|
+
timestamp: null,
|
|
22
|
+
user: null,
|
|
23
|
+
api_key: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetHealth200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **timestamp** | **Time** | | [optional] |
|
|
9
|
+
| **services** | [**GetHealth200ResponseServices**](GetHealth200ResponseServices.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetHealth200Response.new(
|
|
17
|
+
success: true,
|
|
18
|
+
timestamp: null,
|
|
19
|
+
services: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetHealth200ResponseServices
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **redis** | [**GetHealth200ResponseServicesRedis**](GetHealth200ResponseServicesRedis.md) | | [optional] |
|
|
8
|
+
| **ephemeral_storage** | [**GetHealth200ResponseServicesEphemeralStorage**](GetHealth200ResponseServicesEphemeralStorage.md) | | [optional] |
|
|
9
|
+
| **api** | [**GetHealth200ResponseServicesApi**](GetHealth200ResponseServicesApi.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetHealth200ResponseServices.new(
|
|
17
|
+
redis: null,
|
|
18
|
+
ephemeral_storage: null,
|
|
19
|
+
api: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetHealth200ResponseServicesApi
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **healthy** | **Boolean** | | [optional] |
|
|
8
|
+
| **uptime** | **Float** | | [optional] |
|
|
9
|
+
| **version** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetHealth200ResponseServicesApi.new(
|
|
17
|
+
healthy: null,
|
|
18
|
+
uptime: null,
|
|
19
|
+
version: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# QSafe::GetHealth200ResponseServicesEphemeralStorage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **healthy** | **Boolean** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'qsafe-sdk'
|
|
13
|
+
|
|
14
|
+
instance = QSafe::GetHealth200ResponseServicesEphemeralStorage.new(
|
|
15
|
+
healthy: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GetHealth200ResponseServicesRedis
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **connected** | **Boolean** | | [optional] |
|
|
8
|
+
| **ping** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GetHealth200ResponseServicesRedis.new(
|
|
16
|
+
connected: null,
|
|
17
|
+
ping: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::GetRateLimitStatus200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**GetRateLimitStatus200ResponseData**](GetRateLimitStatus200ResponseData.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::GetRateLimitStatus200Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetRateLimitStatus200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **limits** | [**GetRateLimitStatus200ResponseDataLimits**](GetRateLimitStatus200ResponseDataLimits.md) | | [optional] |
|
|
8
|
+
| **current_usage** | [**GetRateLimitStatus200ResponseDataCurrentUsage**](GetRateLimitStatus200ResponseDataCurrentUsage.md) | | [optional] |
|
|
9
|
+
| **reset_times** | [**GetRateLimitStatus200ResponseDataResetTimes**](GetRateLimitStatus200ResponseDataResetTimes.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetRateLimitStatus200ResponseData.new(
|
|
17
|
+
limits: null,
|
|
18
|
+
current_usage: null,
|
|
19
|
+
reset_times: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetRateLimitStatus200ResponseDataCurrentUsage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requests_this_minute** | **Integer** | | [optional] |
|
|
8
|
+
| **requests_this_hour** | **Integer** | | [optional] |
|
|
9
|
+
| **requests_this_day** | **Integer** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetRateLimitStatus200ResponseDataCurrentUsage.new(
|
|
17
|
+
requests_this_minute: 15,
|
|
18
|
+
requests_this_hour: 245,
|
|
19
|
+
requests_this_day: 1840
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetRateLimitStatus200ResponseDataLimits
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requests_per_minute** | **Integer** | | [optional] |
|
|
8
|
+
| **requests_per_hour** | **Integer** | | [optional] |
|
|
9
|
+
| **requests_per_day** | **Integer** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetRateLimitStatus200ResponseDataLimits.new(
|
|
17
|
+
requests_per_minute: 100,
|
|
18
|
+
requests_per_hour: 1000,
|
|
19
|
+
requests_per_day: 10000
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::GetRateLimitStatus200ResponseDataResetTimes
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **minute_reset** | **Time** | | [optional] |
|
|
8
|
+
| **hour_reset** | **Time** | | [optional] |
|
|
9
|
+
| **day_reset** | **Time** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::GetRateLimitStatus200ResponseDataResetTimes.new(
|
|
17
|
+
minute_reset: null,
|
|
18
|
+
hour_reset: null,
|
|
19
|
+
day_reset: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/HealthApi.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# QSafe::HealthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://rushikesh66-pqc-api.hf.space*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_health**](HealthApi.md#get_health) | **GET** /health | Health check |
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## get_health
|
|
11
|
+
|
|
12
|
+
> <GetHealth200Response> get_health
|
|
13
|
+
|
|
14
|
+
Health check
|
|
15
|
+
|
|
16
|
+
Returns status of all internal services (Redis, ephemeral storage, API).
|
|
17
|
+
|
|
18
|
+
### Examples
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'time'
|
|
22
|
+
require 'qsafe-sdk'
|
|
23
|
+
|
|
24
|
+
api_instance = QSafe::HealthApi.new
|
|
25
|
+
|
|
26
|
+
begin
|
|
27
|
+
# Health check
|
|
28
|
+
result = api_instance.get_health
|
|
29
|
+
p result
|
|
30
|
+
rescue QSafe::ApiError => e
|
|
31
|
+
puts "Error when calling HealthApi->get_health: #{e}"
|
|
32
|
+
end
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
#### Using the get_health_with_http_info variant
|
|
36
|
+
|
|
37
|
+
This returns an Array which contains the response data, status code and headers.
|
|
38
|
+
|
|
39
|
+
> <Array(<GetHealth200Response>, Integer, Hash)> get_health_with_http_info
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
begin
|
|
43
|
+
# Health check
|
|
44
|
+
data, status_code, headers = api_instance.get_health_with_http_info
|
|
45
|
+
p status_code # => 2xx
|
|
46
|
+
p headers # => { ... }
|
|
47
|
+
p data # => <GetHealth200Response>
|
|
48
|
+
rescue QSafe::ApiError => e
|
|
49
|
+
puts "Error when calling HealthApi->get_health_with_http_info: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
This endpoint does not need any parameter.
|
|
56
|
+
|
|
57
|
+
### Return type
|
|
58
|
+
|
|
59
|
+
[**GetHealth200Response**](GetHealth200Response.md)
|
|
60
|
+
|
|
61
|
+
### Authorization
|
|
62
|
+
|
|
63
|
+
No authorization required
|
|
64
|
+
|
|
65
|
+
### HTTP request headers
|
|
66
|
+
|
|
67
|
+
- **Content-Type**: Not defined
|
|
68
|
+
- **Accept**: application/json
|
|
69
|
+
|
data/docs/Keypair.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# QSafe::Keypair
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **algorithm** | **String** | | [optional] |
|
|
9
|
+
| **status** | **String** | | [optional] |
|
|
10
|
+
| **purpose** | **String** | | [optional] |
|
|
11
|
+
| **public_key** | **String** | Base64-encoded public key | [optional] |
|
|
12
|
+
| **created_at** | **Time** | | [optional] |
|
|
13
|
+
| **expires_at** | **Time** | | [optional] |
|
|
14
|
+
| **revoked_at** | **Time** | | [optional] |
|
|
15
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
16
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
17
|
+
| **usage_count** | **Integer** | | [optional] |
|
|
18
|
+
| **usage_limit** | **Integer** | | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'qsafe-sdk'
|
|
24
|
+
|
|
25
|
+
instance = QSafe::Keypair.new(
|
|
26
|
+
id: 123e4567-e89b-12d3-a456-426614174000,
|
|
27
|
+
algorithm: KYBER768,
|
|
28
|
+
status: ACTIVE,
|
|
29
|
+
purpose: KEM,
|
|
30
|
+
public_key: null,
|
|
31
|
+
created_at: null,
|
|
32
|
+
expires_at: null,
|
|
33
|
+
revoked_at: null,
|
|
34
|
+
metadata: null,
|
|
35
|
+
tags: ["production","finance"],
|
|
36
|
+
usage_count: 42,
|
|
37
|
+
usage_limit: 10000
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|