qsafe-sdk 1.0.4

data/docs/SignRequest.md

@@ -0,0 +1,26 @@
+# QSafe::SignRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **hash_algorithm** | **String** |  | [optional] |
+| **include_certificate** | **Boolean** |  | [optional] |
+| **ephemeral_storage** | [**SignRequestEphemeralStorage**](SignRequestEphemeralStorage.md) |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::SignRequest.new(
+  message: I hereby approve this financial transaction of $10,000,
+  hash_algorithm: sha256,
+  include_certificate: false,
+  ephemeral_storage: null,
+  metadata: {"document_id":"DOC-2024-001","signer_role":"CFO"}
+)
+```
+

data/docs/SignRequestEphemeralStorage.md

@@ -0,0 +1,20 @@
+# QSafe::SignRequestEphemeralStorage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ttl** | **Integer** |  | [optional] |
+| **max_access_count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::SignRequestEphemeralStorage.new(
+  ttl: 3600,
+  max_access_count: 5
+)
+```
+

data/docs/UpdateApiKeyRequest.md

@@ -0,0 +1,28 @@
+# QSafe::UpdateApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **permissions** | **Array<String>** |  | [optional] |
+| **rate_limit_per_hour** | **Integer** |  | [optional] |
+| **allowed_ips** | **Array<String>** |  | [optional] |
+| **allowed_origins** | **Array<String>** |  | [optional] |
+| **is_active** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::UpdateApiKeyRequest.new(
+  name: Updated Key Name,
+  permissions: ["read","write","crypto_sign"],
+  rate_limit_per_hour: 2000,
+  allowed_ips: ["10.0.0.0/8"],
+  allowed_origins: ["https://newdomain.com"],
+  is_active: true
+)
+```
+

data/docs/UpdateKeypair200Response.md

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

data/docs/UpdateKeypairRequest.md

@@ -0,0 +1,24 @@
+# QSafe::UpdateKeypairRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **purpose** | **String** |  | [optional] |
+| **usage_limit** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::UpdateKeypairRequest.new(
+  metadata: {"updated_by":"admin@company.com"},
+  tags: ["production","finance"],
+  purpose: SIGNATURE,
+  usage_limit: 10000
+)
+```
+

data/docs/User.md

@@ -0,0 +1,32 @@
+# QSafe::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **role** | **String** |  | [optional] |
+| **organization** | **String** |  | [optional] |
+| **is_active** | **Boolean** |  | [optional] |
+| **email_verified** | **Boolean** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::User.new(
+  id: null,
+  email: null,
+  role: USER,
+  organization: null,
+  is_active: true,
+  email_verified: false,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/UtilitiesApi.md

@@ -0,0 +1,81 @@
+# QSafe::UtilitiesApi
+
+All URIs are relative to *https://rushikesh66-pqc-api.hf.space*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_rate_limit_status**](UtilitiesApi.md#get_rate_limit_status) | **GET** /rate-limit/status | Get rate limit status for the current API key |
+
+
+## get_rate_limit_status
+
+> <GetRateLimitStatus200Response> get_rate_limit_status
+
+Get rate limit status for the current API key
+
+API key authentication only — JWT not supported for this endpoint.
+
+### 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'
+end
+
+api_instance = QSafe::UtilitiesApi.new
+
+begin
+  # Get rate limit status for the current API key
+  result = api_instance.get_rate_limit_status
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling UtilitiesApi->get_rate_limit_status: #{e}"
+end
+```
+
+#### Using the get_rate_limit_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRateLimitStatus200Response>, Integer, Hash)> get_rate_limit_status_with_http_info
+
+```ruby
+begin
+  # Get rate limit status for the current API key
+  data, status_code, headers = api_instance.get_rate_limit_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRateLimitStatus200Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling UtilitiesApi->get_rate_limit_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetRateLimitStatus200Response**](GetRateLimitStatus200Response.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/VerifyRequest.md

@@ -0,0 +1,26 @@
+# QSafe::VerifyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **signature** | **String** |  | [optional] |
+| **ephemeral_id** | **String** |  | [optional] |
+| **hash_algorithm** | **String** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::VerifyRequest.new(
+  message: I hereby approve this financial transaction of $10,000,
+  signature: dGVzdCBzaWduYXR1cmU=,
+  ephemeral_id: eph_sig_1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ,
+  hash_algorithm: sha256,
+  metadata: null
+)
+```
+

data/docs/VerifySignature200Response.md

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

data/docs/VerifySignature200ResponseData.md

@@ -0,0 +1,22 @@
+# QSafe::VerifySignature200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operation_id** | **String** |  | [optional] |
+| **verification_result** | [**VerifySignature200ResponseDataVerificationResult**](VerifySignature200ResponseDataVerificationResult.md) |  | [optional] |
+| **signature_info** | [**VerifySignature200ResponseDataSignatureInfo**](VerifySignature200ResponseDataSignatureInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::VerifySignature200ResponseData.new(
+  operation_id: null,
+  verification_result: null,
+  signature_info: null
+)
+```
+

data/docs/VerifySignature200ResponseDataSignatureInfo.md

@@ -0,0 +1,20 @@
+# QSafe::VerifySignature200ResponseDataSignatureInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **algorithm** | **String** |  | [optional] |
+| **keypair_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::VerifySignature200ResponseDataSignatureInfo.new(
+  algorithm: DILITHIUM3,
+  keypair_id: null
+)
+```
+

data/docs/VerifySignature200ResponseDataVerificationResult.md

@@ -0,0 +1,22 @@
+# QSafe::VerifySignature200ResponseDataVerificationResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | true = signature is authentic | [optional] |
+| **hash_algorithm** | **String** |  | [optional] |
+| **verified_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::VerifySignature200ResponseDataVerificationResult.new(
+  valid: true,
+  hash_algorithm: sha256,
+  verified_at: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="qsafe"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="sdk-ruby"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'