qsafe-sdk 1.0.4

data/docs/AuthenticationApi.md

@@ -0,0 +1,276 @@
+# QSafe::AuthenticationApi
+
+All URIs are relative to *https://rushikesh66-pqc-api.hf.space*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**change_password**](AuthenticationApi.md#change_password) | **POST** /auth/change-password | Change password (JWT only) |
+| [**get_auth_info**](AuthenticationApi.md#get_auth_info) | **GET** /auth/info | Get current auth context (JWT or API key) |
+| [**login_user**](AuthenticationApi.md#login_user) | **POST** /auth/login | Login and get JWT token |
+| [**register_user**](AuthenticationApi.md#register_user) | **POST** /auth/register | Register a new user |
+
+
+## change_password
+
+> <ChangePassword200Response> change_password(change_password_request)
+
+Change password (JWT only)
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+# setup authorization
+QSafe.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = QSafe::AuthenticationApi.new
+change_password_request = QSafe::ChangePasswordRequest.new({current_password: 'OldP@ssw0rd123', new_password: 'NewSecureP@ssw0rd456'}) # ChangePasswordRequest | 
+
+begin
+  # Change password (JWT only)
+  result = api_instance.change_password(change_password_request)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->change_password: #{e}"
+end
+```
+
+#### Using the change_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChangePassword200Response>, Integer, Hash)> change_password_with_http_info(change_password_request)
+
+```ruby
+begin
+  # Change password (JWT only)
+  data, status_code, headers = api_instance.change_password_with_http_info(change_password_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChangePassword200Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->change_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **change_password_request** | [**ChangePasswordRequest**](ChangePasswordRequest.md) |  |  |
+
+### Return type
+
+[**ChangePassword200Response**](ChangePassword200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_auth_info
+
+> <GetAuthInfo200Response> get_auth_info
+
+Get current auth context (JWT or API key)
+
+### 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::AuthenticationApi.new
+
+begin
+  # Get current auth context (JWT or API key)
+  result = api_instance.get_auth_info
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->get_auth_info: #{e}"
+end
+```
+
+#### Using the get_auth_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAuthInfo200Response>, Integer, Hash)> get_auth_info_with_http_info
+
+```ruby
+begin
+  # Get current auth context (JWT or API key)
+  data, status_code, headers = api_instance.get_auth_info_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAuthInfo200Response>
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->get_auth_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetAuthInfo200Response**](GetAuthInfo200Response.md)
+
+### Authorization
+
+[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## login_user
+
+> <AuthResponse> login_user(login_request)
+
+Login and get JWT token
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+
+api_instance = QSafe::AuthenticationApi.new
+login_request = QSafe::LoginRequest.new({email: 'john.doe@company.com', password: 'SecureP@ssw0rd123'}) # LoginRequest | 
+
+begin
+  # Login and get JWT token
+  result = api_instance.login_user(login_request)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->login_user: #{e}"
+end
+```
+
+#### Using the login_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> login_user_with_http_info(login_request)
+
+```ruby
+begin
+  # Login and get JWT token
+  data, status_code, headers = api_instance.login_user_with_http_info(login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->login_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **login_request** | [**LoginRequest**](LoginRequest.md) |  |  |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## register_user
+
+> <AuthResponse> register_user(register_request)
+
+Register a new user
+
+### Examples
+
+```ruby
+require 'time'
+require 'qsafe-sdk'
+
+api_instance = QSafe::AuthenticationApi.new
+register_request = QSafe::RegisterRequest.new({email: 'john.doe@company.com', password: 'SecureP@ssw0rd123', first_name: 'John', last_name: 'Doe'}) # RegisterRequest | 
+
+begin
+  # Register a new user
+  result = api_instance.register_user(register_request)
+  p result
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->register_user: #{e}"
+end
+```
+
+#### Using the register_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResponse>, Integer, Hash)> register_user_with_http_info(register_request)
+
+```ruby
+begin
+  # Register a new user
+  data, status_code, headers = api_instance.register_user_with_http_info(register_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResponse>
+rescue QSafe::ApiError => e
+  puts "Error when calling AuthenticationApi->register_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **register_request** | [**RegisterRequest**](RegisterRequest.md) |  |  |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ChangePassword200Response.md

@@ -0,0 +1,20 @@
+# QSafe::ChangePassword200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ChangePassword200Response.new(
+  success: true,
+  message: Password changed successfully
+)
+```
+

data/docs/ChangePasswordRequest.md

@@ -0,0 +1,20 @@
+# QSafe::ChangePasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_password** | **String** |  |  |
+| **new_password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::ChangePasswordRequest.new(
+  current_password: OldP@ssw0rd123,
+  new_password: NewSecureP@ssw0rd456
+)
+```
+

data/docs/CreateApiKey201Response.md

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

data/docs/CreateApiKey201ResponseData.md

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

data/docs/CreateApiKeyRequest.md

@@ -0,0 +1,28 @@
+# QSafe::CreateApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **permissions** | **Array<String>** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+| **rate_limit_per_hour** | **Integer** |  | [optional] |
+| **allowed_ips** | **Array<String>** |  | [optional] |
+| **allowed_origins** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'qsafe-sdk'
+
+instance = QSafe::CreateApiKeyRequest.new(
+  name: Production API Key,
+  permissions: ["read","crypto_encrypt","crypto_decrypt"],
+  expires_at: 2027-12-31T23:59:59Z,
+  rate_limit_per_hour: 1000,
+  allowed_ips: ["192.168.1.0/24"],
+  allowed_origins: ["https://app.example.com"]
+)
+```
+