qsafe-sdk 1.0.4

data/docs/KeypairsApi.md

@@ -0,0 +1,341 @@
+# QSafe::KeypairsApi
+
+All URIs are relative to *https://rushikesh66-pqc-api.hf.space*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_keypair**](KeypairsApi.md#generate_keypair) | **POST** /generate-keypair | Generate a new keypair |
+| [**list_keypairs**](KeypairsApi.md#list_keypairs) | **GET** /keypairs | List keypairs |
+| [**revoke_keypair**](KeypairsApi.md#revoke_keypair) | **PATCH** /keypairs/{keypairId}/revoke | Revoke a keypair |
+| [**update_keypair**](KeypairsApi.md#update_keypair) | **PATCH** /keypairs/{keypairId} | Update keypair metadata / tags |
+
+
+## generate_keypair
+
+> <GenerateKeypair201Response> generate_keypair(generate_keypair_request)
+
+Generate a new keypair
+
+Supports dual authentication (JWT or API key). Use `KYBER*` algorithms for encryption (KEM), `DILITHIUM*` for signing. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+# setup authorization
+QSafe.configure do |config|
+  # Configure API key authorization: ApiKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure API key authorization: ApiKeyQuery
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = QSafe::KeypairsApi.new
+generate_keypair_request = QSafe::GenerateKeypairRequest.new({algorithm: 'KYBER512'}) # GenerateKeypairRequest | 
+
+begin
+  # Generate a new keypair
+  result = api_instance.generate_keypair(generate_keypair_request)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->generate_keypair: #{e}"
+end
+```
+
+#### Using the generate_keypair_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateKeypair201Response>, Integer, Hash)> generate_keypair_with_http_info(generate_keypair_request)
+
+```ruby
+begin
+  # Generate a new keypair
+  data, status_code, headers = api_instance.generate_keypair_with_http_info(generate_keypair_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateKeypair201Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->generate_keypair_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **generate_keypair_request** | [**GenerateKeypairRequest**](GenerateKeypairRequest.md) |  |  |
+
+### Return type
+
+[**GenerateKeypair201Response**](GenerateKeypair201Response.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_keypairs
+
+> <ListKeypairs200Response> list_keypairs(opts)
+
+List keypairs
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+# setup authorization
+QSafe.configure do |config|
+  # Configure API key authorization: ApiKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure API key authorization: ApiKeyQuery
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = QSafe::KeypairsApi.new
+opts = {
+  page: 1, # Integer | 
+  limit: 20, # Integer | 
+  algorithm: 'KYBER512', # String | 
+  status: 'ACTIVE', # String | 
+  key_type: 'KEM', # String | 
+  created_after: Time.parse('2025-01-01T00:00:00Z'), # Time | 
+  created_before: Time.parse('2025-12-31T23:59:59Z'), # Time | 
+  search: 'finance' # String | Search in keypair metadata (alphanumeric, spaces, hyphens, underscores)
+}
+
+begin
+  # List keypairs
+  result = api_instance.list_keypairs(opts)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->list_keypairs: #{e}"
+end
+```
+
+#### Using the list_keypairs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListKeypairs200Response>, Integer, Hash)> list_keypairs_with_http_info(opts)
+
+```ruby
+begin
+  # List keypairs
+  data, status_code, headers = api_instance.list_keypairs_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListKeypairs200Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->list_keypairs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **limit** | **Integer** |  | [optional][default to 10] |
+| **algorithm** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **key_type** | **String** |  | [optional] |
+| **created_after** | **Time** |  | [optional] |
+| **created_before** | **Time** |  | [optional] |
+| **search** | **String** | Search in keypair metadata (alphanumeric, spaces, hyphens, underscores) | [optional] |
+
+### Return type
+
+[**ListKeypairs200Response**](ListKeypairs200Response.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## revoke_keypair
+
+> <RevokeKeypair200Response> revoke_keypair(keypair_id, revoke_keypair_request)
+
+Revoke a keypair
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+# setup authorization
+QSafe.configure do |config|
+  # Configure API key authorization: ApiKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure API key authorization: ApiKeyQuery
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = QSafe::KeypairsApi.new
+keypair_id = '123e4567-e89b-12d3-a456-426614174000' # String | UUID v4 keypair identifier
+revoke_keypair_request = QSafe::RevokeKeypairRequest.new({reason: 'COMPROMISE_SUSPECTED'}) # RevokeKeypairRequest | 
+
+begin
+  # Revoke a keypair
+  result = api_instance.revoke_keypair(keypair_id, revoke_keypair_request)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->revoke_keypair: #{e}"
+end
+```
+
+#### Using the revoke_keypair_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RevokeKeypair200Response>, Integer, Hash)> revoke_keypair_with_http_info(keypair_id, revoke_keypair_request)
+
+```ruby
+begin
+  # Revoke a keypair
+  data, status_code, headers = api_instance.revoke_keypair_with_http_info(keypair_id, revoke_keypair_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RevokeKeypair200Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->revoke_keypair_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keypair_id** | **String** | UUID v4 keypair identifier |  |
+| **revoke_keypair_request** | [**RevokeKeypairRequest**](RevokeKeypairRequest.md) |  |  |
+
+### Return type
+
+[**RevokeKeypair200Response**](RevokeKeypair200Response.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_keypair
+
+> <UpdateKeypair200Response> update_keypair(keypair_id, update_keypair_request)
+
+Update keypair metadata / tags
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+# setup authorization
+QSafe.configure do |config|
+  # Configure API key authorization: ApiKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure API key authorization: ApiKeyQuery
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = QSafe::KeypairsApi.new
+keypair_id = '123e4567-e89b-12d3-a456-426614174000' # String | UUID v4 keypair identifier
+update_keypair_request = QSafe::UpdateKeypairRequest.new # UpdateKeypairRequest | 
+
+begin
+  # Update keypair metadata / tags
+  result = api_instance.update_keypair(keypair_id, update_keypair_request)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->update_keypair: #{e}"
+end
+```
+
+#### Using the update_keypair_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateKeypair200Response>, Integer, Hash)> update_keypair_with_http_info(keypair_id, update_keypair_request)
+
+```ruby
+begin
+  # Update keypair metadata / tags
+  data, status_code, headers = api_instance.update_keypair_with_http_info(keypair_id, update_keypair_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateKeypair200Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling KeypairsApi->update_keypair_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keypair_id** | **String** | UUID v4 keypair identifier |  |
+| **update_keypair_request** | [**UpdateKeypairRequest**](UpdateKeypairRequest.md) |  |  |
+
+### Return type
+
+[**UpdateKeypair200Response**](UpdateKeypair200Response.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ListApiKeys200Response.md

@@ -0,0 +1,20 @@
+# QSafe::ListApiKeys200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **data** | [**ListApiKeys200ResponseData**](ListApiKeys200ResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ListApiKeys200Response.new(
+  success: true,
+  data: null
+)
+```
+

data/docs/ListApiKeys200ResponseData.md

@@ -0,0 +1,22 @@
+# QSafe::ListApiKeys200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_keys** | [**Array<ApiKey>**](ApiKey.md) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **pagination** | [**ListApiKeys200ResponseDataPagination**](ListApiKeys200ResponseDataPagination.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ListApiKeys200ResponseData.new(
+  api_keys: null,
+  total: 5,
+  pagination: null
+)
+```
+

data/docs/ListApiKeys200ResponseDataPagination.md

@@ -0,0 +1,22 @@
+# QSafe::ListApiKeys200ResponseDataPagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **total_pages** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ListApiKeys200ResponseDataPagination.new(
+  page: 1,
+  limit: 10,
+  total_pages: 1
+)
+```
+

data/docs/ListKeypairs200Response.md

@@ -0,0 +1,20 @@
+# QSafe::ListKeypairs200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **data** | [**ListKeypairs200ResponseData**](ListKeypairs200ResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ListKeypairs200Response.new(
+  success: true,
+  data: null
+)
+```
+

data/docs/ListKeypairs200ResponseData.md

@@ -0,0 +1,22 @@
+# QSafe::ListKeypairs200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keypairs** | [**Array<Keypair>**](Keypair.md) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **pagination** | [**ListKeypairs200ResponseDataPagination**](ListKeypairs200ResponseDataPagination.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ListKeypairs200ResponseData.new(
+  keypairs: null,
+  total: 12,
+  pagination: null
+)
+```
+

data/docs/ListKeypairs200ResponseDataPagination.md

@@ -0,0 +1,22 @@
+# QSafe::ListKeypairs200ResponseDataPagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **total_pages** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ListKeypairs200ResponseDataPagination.new(
+  page: 1,
+  limit: 20,
+  total_pages: 1
+)
+```
+

data/docs/LoginRequest.md

@@ -0,0 +1,20 @@
+# QSafe::LoginRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::LoginRequest.new(
+  email: john.doe@company.com,
+  password: SecureP@ssw0rd123
+)
+```
+

data/docs/RegisterRequest.md

@@ -0,0 +1,24 @@
+# QSafe::RegisterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** | Min 8 chars; mixed case, digits, and symbols recommended |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::RegisterRequest.new(
+  email: john.doe@company.com,
+  password: SecureP@ssw0rd123,
+  first_name: John,
+  last_name: Doe
+)
+```
+

data/docs/RevokeKeypair200Response.md

@@ -0,0 +1,22 @@
+# QSafe::RevokeKeypair200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **data** | [**Keypair**](Keypair.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::RevokeKeypair200Response.new(
+  success: true,
+  message: Keypair revoked successfully,
+  data: null
+)
+```
+

data/docs/RevokeKeypairRequest.md

@@ -0,0 +1,22 @@
+# QSafe::RevokeKeypairRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **notify_users** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::RevokeKeypairRequest.new(
+  reason: KEY_ROTATION,
+  description: Quarterly security rotation per company policy,
+  notify_users: true
+)
+```
+

data/docs/RotateApiKey200Response.md

@@ -0,0 +1,20 @@
+# QSafe::RotateApiKey200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **data** | [**RotateApiKey200ResponseData**](RotateApiKey200ResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::RotateApiKey200Response.new(
+  success: true,
+  data: null
+)
+```
+

data/docs/RotateApiKey200ResponseData.md

@@ -0,0 +1,20 @@
+# QSafe::RotateApiKey200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | New raw API key value — store it now | [optional] |
+| **key_info** | [**ApiKey**](ApiKey.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::RotateApiKey200ResponseData.new(
+  api_key: pqc_newkeyvalue123456789,
+  key_info: null
+)
+```
+

data/docs/SignData200Response.md

@@ -0,0 +1,20 @@
+# QSafe::SignData200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **data** | [**SignData200ResponseData**](SignData200ResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::SignData200Response.new(
+  success: true,
+  data: null
+)
+```
+

data/docs/SignData200ResponseData.md

@@ -0,0 +1,30 @@
+# QSafe::SignData200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operation_id** | **String** |  | [optional] |
+| **signature** | **String** |  | [optional] |
+| **algorithm** | **String** |  | [optional] |
+| **keypair_id** | **String** |  | [optional] |
+| **hash_algorithm** | **String** |  | [optional] |
+| **message_hash** | **String** | Hash of the signed message | [optional] |
+| **ephemeral_storage** | [**SignData200ResponseDataEphemeralStorage**](SignData200ResponseDataEphemeralStorage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::SignData200ResponseData.new(
+  operation_id: null,
+  signature: null,
+  algorithm: DILITHIUM3,
+  keypair_id: null,
+  hash_algorithm: sha256,
+  message_hash: null,
+  ephemeral_storage: null
+)
+```
+

data/docs/SignData200ResponseDataEphemeralStorage.md

@@ -0,0 +1,22 @@
+# QSafe::SignData200ResponseDataEphemeralStorage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ephemeral_id** | **String** | Use in verify request instead of raw signature | [optional] |
+| **expires_in** | **Integer** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::SignData200ResponseDataEphemeralStorage.new(
+  ephemeral_id: null,
+  expires_in: null,
+  expires_at: null
+)
+```
+