lockally 0.1.0

data/docs/AiApi.md

@@ -0,0 +1,282 @@
+# Lockally::AiApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_ai_config_get**](AiApi.md#v1_ai_config_get) | **GET** /v1/ai-config | Read the tenant's AI configuration |
+| [**v1_ai_config_put**](AiApi.md#v1_ai_config_put) | **PUT** /v1/ai-config | Configure the AI tier |
+| [**v1_billing_ai_units_checkout_post**](AiApi.md#v1_billing_ai_units_checkout_post) | **POST** /v1/billing/ai-units/checkout | Buy prepaid AI units |
+| [**v1_threads_thread_id_classify_post**](AiApi.md#v1_threads_thread_id_classify_post) | **POST** /v1/threads/{threadID}/classify | LLM-classify a thread |
+
+
+## v1_ai_config_get
+
+> Object v1_ai_config_get
+
+Read the tenant's AI configuration
+
+Mode (off/byok/units), model, masked key hint, AI-unit balance, whether the units tier is available on this deployment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AiApi.new
+
+begin
+  # Read the tenant's AI configuration
+  result = api_instance.v1_ai_config_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_ai_config_get: #{e}"
+end
+```
+
+#### Using the v1_ai_config_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_ai_config_get_with_http_info
+
+```ruby
+begin
+  # Read the tenant's AI configuration
+  data, status_code, headers = api_instance.v1_ai_config_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_ai_config_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_ai_config_put
+
+> Object v1_ai_config_put
+
+Configure the AI tier
+
+Body: {\"mode\": \"off|byok|units\", \"model\": \"...\", \"anthropic_key\": \"sk-ant-...\"}. BYOK keys are stored AES-256-GCM encrypted; the cleartext is never returned. Omit anthropic_key to keep the stored one.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AiApi.new
+
+begin
+  # Configure the AI tier
+  result = api_instance.v1_ai_config_put
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_ai_config_put: #{e}"
+end
+```
+
+#### Using the v1_ai_config_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_ai_config_put_with_http_info
+
+```ruby
+begin
+  # Configure the AI tier
+  data, status_code, headers = api_instance.v1_ai_config_put_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_ai_config_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_billing_ai_units_checkout_post
+
+> Object v1_billing_ai_units_checkout_post
+
+Buy prepaid AI units
+
+Body: {\"bundle\": \"100|500|2000\"}. One classification = one unit; bundles expire after 6 months. Admin session required. 503 until Paystack billing is configured.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AiApi.new
+
+begin
+  # Buy prepaid AI units
+  result = api_instance.v1_billing_ai_units_checkout_post
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_billing_ai_units_checkout_post: #{e}"
+end
+```
+
+#### Using the v1_billing_ai_units_checkout_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_billing_ai_units_checkout_post_with_http_info
+
+```ruby
+begin
+  # Buy prepaid AI units
+  data, status_code, headers = api_instance.v1_billing_ai_units_checkout_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_billing_ai_units_checkout_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_threads_thread_id_classify_post
+
+> Object v1_threads_thread_id_classify_post(thread_id, opts)
+
+LLM-classify a thread
+
+Returns {intent, urgency, summary, suggested_action} via the tenant's AI tier (BYOK or prepaid units — see /v1/ai-config). Cached per thread state: unchanged threads return the cache free; ?refresh=true forces a re-run. A failed model call charges nothing. 402 when the AI tier is off.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AiApi.new
+thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  refresh: true # Boolean | 
+}
+
+begin
+  # LLM-classify a thread
+  result = api_instance.v1_threads_thread_id_classify_post(thread_id, opts)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_threads_thread_id_classify_post: #{e}"
+end
+```
+
+#### Using the v1_threads_thread_id_classify_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_threads_thread_id_classify_post_with_http_info(thread_id, opts)
+
+```ruby
+begin
+  # LLM-classify a thread
+  data, status_code, headers = api_instance.v1_threads_thread_id_classify_post_with_http_info(thread_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lockally::ApiError => e
+  puts "Error when calling AiApi->v1_threads_thread_id_classify_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread_id** | **String** |  |  |
+| **refresh** | **Boolean** |  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AliasesApi.md

@@ -0,0 +1,211 @@
+# Lockally::AliasesApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_aliases_address_delete**](AliasesApi.md#v1_aliases_address_delete) | **DELETE** /v1/aliases/{address} | Delete an alias |
+| [**v1_aliases_get**](AliasesApi.md#v1_aliases_get) | **GET** /v1/aliases | List aliases |
+| [**v1_aliases_post**](AliasesApi.md#v1_aliases_post) | **POST** /v1/aliases | Create an alias |
+
+
+## v1_aliases_address_delete
+
+> v1_aliases_address_delete(address)
+
+Delete an alias
+
+Hard-delete (no soft-delete window — aliases are cheap to recreate).
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AliasesApi.new
+address = 'address_example' # String | 
+
+begin
+  # Delete an alias
+  api_instance.v1_aliases_address_delete(address)
+rescue Lockally::ApiError => e
+  puts "Error when calling AliasesApi->v1_aliases_address_delete: #{e}"
+end
+```
+
+#### Using the v1_aliases_address_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v1_aliases_address_delete_with_http_info(address)
+
+```ruby
+begin
+  # Delete an alias
+  data, status_code, headers = api_instance.v1_aliases_address_delete_with_http_info(address)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling AliasesApi->v1_aliases_address_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_aliases_get
+
+> <V1AliasesGet200Response> v1_aliases_get
+
+List aliases
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AliasesApi.new
+
+begin
+  # List aliases
+  result = api_instance.v1_aliases_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AliasesApi->v1_aliases_get: #{e}"
+end
+```
+
+#### Using the v1_aliases_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1AliasesGet200Response>, Integer, Hash)> v1_aliases_get_with_http_info
+
+```ruby
+begin
+  # List aliases
+  data, status_code, headers = api_instance.v1_aliases_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1AliasesGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling AliasesApi->v1_aliases_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1AliasesGet200Response**](V1AliasesGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_aliases_post
+
+> <ModelAlias> v1_aliases_post(v1_aliases_post_request)
+
+Create an alias
+
+Creates an email alias. `alias_address` must be on a verified tenant-owned domain. `alias_target` can be any email — intra-tenant or external (forwarding to a Gmail account is a legitimate use). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::AliasesApi.new
+v1_aliases_post_request = Lockally::V1AliasesPostRequest.new({alias_address: 'support@acme.com', alias_target: 'alice@acme.com'}) # V1AliasesPostRequest | 
+
+begin
+  # Create an alias
+  result = api_instance.v1_aliases_post(v1_aliases_post_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling AliasesApi->v1_aliases_post: #{e}"
+end
+```
+
+#### Using the v1_aliases_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ModelAlias>, Integer, Hash)> v1_aliases_post_with_http_info(v1_aliases_post_request)
+
+```ruby
+begin
+  # Create an alias
+  data, status_code, headers = api_instance.v1_aliases_post_with_http_info(v1_aliases_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ModelAlias>
+rescue Lockally::ApiError => e
+  puts "Error when calling AliasesApi->v1_aliases_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v1_aliases_post_request** | [**V1AliasesPostRequest**](V1AliasesPostRequest.md) |  |  |
+
+### Return type
+
+[**ModelAlias**](ModelAlias.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/docs/ApiKeysApi.md

@@ -0,0 +1,213 @@
+# Lockally::ApiKeysApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_api_keys_get**](ApiKeysApi.md#v1_api_keys_get) | **GET** /v1/api-keys | List API keys |
+| [**v1_api_keys_id_delete**](ApiKeysApi.md#v1_api_keys_id_delete) | **DELETE** /v1/api-keys/{id} | Revoke an API key |
+| [**v1_api_keys_post**](ApiKeysApi.md#v1_api_keys_post) | **POST** /v1/api-keys | Create an API key |
+
+
+## v1_api_keys_get
+
+> <V1ApiKeysGet200Response> v1_api_keys_get
+
+List API keys
+
+Returns all API keys (active and revoked) belonging to the calling tenant. The `secret` is **never** returned — only prefix + metadata. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::ApiKeysApi.new
+
+begin
+  # List API keys
+  result = api_instance.v1_api_keys_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling ApiKeysApi->v1_api_keys_get: #{e}"
+end
+```
+
+#### Using the v1_api_keys_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1ApiKeysGet200Response>, Integer, Hash)> v1_api_keys_get_with_http_info
+
+```ruby
+begin
+  # List API keys
+  data, status_code, headers = api_instance.v1_api_keys_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1ApiKeysGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling ApiKeysApi->v1_api_keys_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1ApiKeysGet200Response**](V1ApiKeysGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_api_keys_id_delete
+
+> v1_api_keys_id_delete(id)
+
+Revoke an API key
+
+Soft-deletes (sets `revoked_at`) on the named key. The row stays for audit purposes; the key no longer authenticates.  You **cannot revoke the key currently being used** to make this call — that would lock you out. Use a different `tenant:admin` key. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::ApiKeysApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Revoke an API key
+  api_instance.v1_api_keys_id_delete(id)
+rescue Lockally::ApiError => e
+  puts "Error when calling ApiKeysApi->v1_api_keys_id_delete: #{e}"
+end
+```
+
+#### Using the v1_api_keys_id_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v1_api_keys_id_delete_with_http_info(id)
+
+```ruby
+begin
+  # Revoke an API key
+  data, status_code, headers = api_instance.v1_api_keys_id_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling ApiKeysApi->v1_api_keys_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_api_keys_post
+
+> <V1ApiKeysPost201Response> v1_api_keys_post(v1_api_keys_post_request)
+
+Create an API key
+
+Provisions a fresh API key for the calling tenant.  **The full `secret` is included in this response ONLY** — store it immediately. The cleartext secret is not recoverable from the argon2id hash kept server-side; rotate by creating a new key and revoking the old one. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::ApiKeysApi.new
+v1_api_keys_post_request = Lockally::V1ApiKeysPostRequest.new({label: 'ci-pipeline', scopes: ['tenant:read']}) # V1ApiKeysPostRequest | 
+
+begin
+  # Create an API key
+  result = api_instance.v1_api_keys_post(v1_api_keys_post_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling ApiKeysApi->v1_api_keys_post: #{e}"
+end
+```
+
+#### Using the v1_api_keys_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1ApiKeysPost201Response>, Integer, Hash)> v1_api_keys_post_with_http_info(v1_api_keys_post_request)
+
+```ruby
+begin
+  # Create an API key
+  data, status_code, headers = api_instance.v1_api_keys_post_with_http_info(v1_api_keys_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1ApiKeysPost201Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling ApiKeysApi->v1_api_keys_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v1_api_keys_post_request** | [**V1ApiKeysPostRequest**](V1ApiKeysPostRequest.md) |  |  |
+
+### Return type
+
+[**V1ApiKeysPost201Response**](V1ApiKeysPost201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+