lockally 0.2.0 → 0.3.0

data/docs/AiApi.md

@@ -4,19 +4,19 @@ 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 |
+| [**classify_thread**](AiApi.md#classify_thread) | **POST** /v1/threads/{threadID}/classify | LLM-classify a thread |
+| [**create_ai_units_checkout**](AiApi.md#create_ai_units_checkout) | **POST** /v1/billing/ai-units/checkout | Buy prepaid AI units |
+| [**get_ai_config**](AiApi.md#get_ai_config) | **GET** /v1/ai-config | Read the tenant's AI configuration |
+| [**update_ai_config**](AiApi.md#update_ai_config) | **PUT** /v1/ai-config | Configure the AI tier |
 
 
-## v1_ai_config_get
+## classify_thread
 
-> Object v1_ai_config_get
+> <ThreadClassification> classify_thread(thread_id, opts)
 
-Read the tenant's AI configuration
+LLM-classify a thread
 
-Mode (off/byok/units), model, masked key hint, AI-unit balance, whether the units tier is available on this deployment.
+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
 
@@ -30,41 +30,48 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AiApi.new
+thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  refresh: true # Boolean | 
+}
 
 begin
-  # Read the tenant's AI configuration
-  result = api_instance.v1_ai_config_get
+  # LLM-classify a thread
+  result = api_instance.classify_thread(thread_id, opts)
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_ai_config_get: #{e}"
+  puts "Error when calling AiApi->classify_thread: #{e}"
 end
 ```
 
-#### Using the v1_ai_config_get_with_http_info variant
+#### Using the classify_thread_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
+> <Array(<ThreadClassification>, Integer, Hash)> classify_thread_with_http_info(thread_id, opts)
 
 ```ruby
 begin
-  # Read the tenant's AI configuration
-  data, status_code, headers = api_instance.v1_ai_config_get_with_http_info
+  # LLM-classify a thread
+  data, status_code, headers = api_instance.classify_thread_with_http_info(thread_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <ThreadClassification>
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_ai_config_get_with_http_info: #{e}"
+  puts "Error when calling AiApi->classify_thread_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **thread_id** | **String** |  |  |
+| **refresh** | **Boolean** |  | [optional] |
 
 ### Return type
 
-**Object**
+[**ThreadClassification**](ThreadClassification.md)
 
 ### Authorization
 
@@ -76,13 +83,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## v1_ai_config_put
+## create_ai_units_checkout
 
-> Object v1_ai_config_put
+> <CreateAiUnitsCheckout200Response> create_ai_units_checkout
 
-Configure the AI tier
+Buy prepaid AI units
 
-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.
+Body: {\"bundle\": \"100|500|2000\"}. One classification = one unit; bundles expire after 6 months. Admin session required. 503 until Paystack billing is configured.
 
 ### Examples
 
@@ -98,29 +105,29 @@ end
 api_instance = Lockally::AiApi.new
 
 begin
-  # Configure the AI tier
-  result = api_instance.v1_ai_config_put
+  # Buy prepaid AI units
+  result = api_instance.create_ai_units_checkout
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_ai_config_put: #{e}"
+  puts "Error when calling AiApi->create_ai_units_checkout: #{e}"
 end
 ```
 
-#### Using the v1_ai_config_put_with_http_info variant
+#### Using the create_ai_units_checkout_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
+> <Array(<CreateAiUnitsCheckout200Response>, Integer, Hash)> create_ai_units_checkout_with_http_info
 
 ```ruby
 begin
-  # Configure the AI tier
-  data, status_code, headers = api_instance.v1_ai_config_put_with_http_info
+  # Buy prepaid AI units
+  data, status_code, headers = api_instance.create_ai_units_checkout_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CreateAiUnitsCheckout200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_ai_config_put_with_http_info: #{e}"
+  puts "Error when calling AiApi->create_ai_units_checkout_with_http_info: #{e}"
 end
 ```
 
@@ -130,7 +137,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-**Object**
+[**CreateAiUnitsCheckout200Response**](CreateAiUnitsCheckout200Response.md)
 
 ### Authorization
 
@@ -142,13 +149,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## v1_billing_ai_units_checkout_post
+## get_ai_config
 
-> Object v1_billing_ai_units_checkout_post
+> <AiConfig> get_ai_config
 
-Buy prepaid AI units
+Read the tenant's AI configuration
 
-Body: {\"bundle\": \"100|500|2000\"}. One classification = one unit; bundles expire after 6 months. Admin session required. 503 until Paystack billing is configured.
+Mode (off/byok/units), model, masked key hint, AI-unit balance, whether the units tier is available on this deployment.
 
 ### Examples
 
@@ -164,29 +171,29 @@ end
 api_instance = Lockally::AiApi.new
 
 begin
-  # Buy prepaid AI units
-  result = api_instance.v1_billing_ai_units_checkout_post
+  # Read the tenant's AI configuration
+  result = api_instance.get_ai_config
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_billing_ai_units_checkout_post: #{e}"
+  puts "Error when calling AiApi->get_ai_config: #{e}"
 end
 ```
 
-#### Using the v1_billing_ai_units_checkout_post_with_http_info variant
+#### Using the get_ai_config_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
+> <Array(<AiConfig>, Integer, Hash)> get_ai_config_with_http_info
 
 ```ruby
 begin
-  # Buy prepaid AI units
-  data, status_code, headers = api_instance.v1_billing_ai_units_checkout_post_with_http_info
+  # Read the tenant's AI configuration
+  data, status_code, headers = api_instance.get_ai_config_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <AiConfig>
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_billing_ai_units_checkout_post_with_http_info: #{e}"
+  puts "Error when calling AiApi->get_ai_config_with_http_info: #{e}"
 end
 ```
 
@@ -196,7 +203,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-**Object**
+[**AiConfig**](AiConfig.md)
 
 ### Authorization
 
@@ -208,13 +215,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## v1_threads_thread_id_classify_post
+## update_ai_config
 
-> Object v1_threads_thread_id_classify_post(thread_id, opts)
+> <AiConfigUpdate> update_ai_config
 
-LLM-classify a thread
+Configure the AI tier
 
-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.
+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
 
@@ -228,48 +235,41 @@ Lockally.configure do |config|
 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)
+  # Configure the AI tier
+  result = api_instance.update_ai_config
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_threads_thread_id_classify_post: #{e}"
+  puts "Error when calling AiApi->update_ai_config: #{e}"
 end
 ```
 
-#### Using the v1_threads_thread_id_classify_post_with_http_info variant
+#### Using the update_ai_config_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)
+> <Array(<AiConfigUpdate>, Integer, Hash)> update_ai_config_with_http_info
 
 ```ruby
 begin
-  # LLM-classify a thread
-  data, status_code, headers = api_instance.v1_threads_thread_id_classify_post_with_http_info(thread_id, opts)
+  # Configure the AI tier
+  data, status_code, headers = api_instance.update_ai_config_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <AiConfigUpdate>
 rescue Lockally::ApiError => e
-  puts "Error when calling AiApi->v1_threads_thread_id_classify_post_with_http_info: #{e}"
+  puts "Error when calling AiApi->update_ai_config_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **thread_id** | **String** |  |  |
-| **refresh** | **Boolean** |  | [optional] |
+This endpoint does not need any parameter.
 
 ### Return type
 
-**Object**
+[**AiConfigUpdate**](AiConfigUpdate.md)
 
 ### Authorization
 

data/docs/AiConfig.md

@@ -0,0 +1,26 @@
+# Lockally::AiConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** |  |  |
+| **model** | **String** |  |  |
+| **byok_key_hint** | **String** |  | [optional] |
+| **units_balance** | **Integer** |  | [optional] |
+| **units_available** | **Boolean** | True when a platform model key is configured. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AiConfig.new(
+  mode: null,
+  model: null,
+  byok_key_hint: null,
+  units_balance: null,
+  units_available: null
+)
+```
+

data/docs/AiConfigUpdate.md

@@ -0,0 +1,20 @@
+# Lockally::AiConfigUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** |  |  |
+| **model** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AiConfigUpdate.new(
+  mode: null,
+  model: null
+)
+```
+

data/docs/AliasesApi.md

@@ -4,18 +4,18 @@ 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 |
+| [**create_alias**](AliasesApi.md#create_alias) | **POST** /v1/aliases | Create an alias |
+| [**delete_alias**](AliasesApi.md#delete_alias) | **DELETE** /v1/aliases/{address} | Delete an alias |
+| [**list_aliases**](AliasesApi.md#list_aliases) | **GET** /v1/aliases | List aliases |
 
 
-## v1_aliases_address_delete
+## create_alias
 
-> v1_aliases_address_delete(address)
+> <ModelAlias> create_alias(create_alias_request)
 
-Delete an alias
+Create an alias
 
-Hard-delete (no soft-delete window — aliases are cheap to recreate).
+Creates an email alias. `alias_address` must be on a verified tenant-owned domain and must not be the address of an existing mailbox (live, suspended or deleted). `alias_target` must be an active mailbox in the same workspace; forwarding to an address Lockally does not host is not supported. The alias delivers as soon as the call returns. 
 
 ### Examples
 
@@ -29,31 +29,32 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AliasesApi.new
-address = 'address_example' # String | 
+create_alias_request = Lockally::CreateAliasRequest.new({alias_address: 'support@acme.com', alias_target: 'alice@acme.com'}) # CreateAliasRequest | 
 
 begin
-  # Delete an alias
-  api_instance.v1_aliases_address_delete(address)
+  # Create an alias
+  result = api_instance.create_alias(create_alias_request)
+  p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AliasesApi->v1_aliases_address_delete: #{e}"
+  puts "Error when calling AliasesApi->create_alias: #{e}"
 end
 ```
 
-#### Using the v1_aliases_address_delete_with_http_info variant
+#### Using the create_alias_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> v1_aliases_address_delete_with_http_info(address)
+> <Array(<ModelAlias>, Integer, Hash)> create_alias_with_http_info(create_alias_request)
 
 ```ruby
 begin
-  # Delete an alias
-  data, status_code, headers = api_instance.v1_aliases_address_delete_with_http_info(address)
+  # Create an alias
+  data, status_code, headers = api_instance.create_alias_with_http_info(create_alias_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <ModelAlias>
 rescue Lockally::ApiError => e
-  puts "Error when calling AliasesApi->v1_aliases_address_delete_with_http_info: #{e}"
+  puts "Error when calling AliasesApi->create_alias_with_http_info: #{e}"
 end
 ```
 
@@ -61,11 +62,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **address** | **String** |  |  |
+| **create_alias_request** | [**CreateAliasRequest**](CreateAliasRequest.md) |  |  |
 
 ### Return type
 
-nil (empty response body)
+[**ModelAlias**](ModelAlias.md)
 
 ### Authorization
 
@@ -73,15 +74,17 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/problem+json
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
 
 
-## v1_aliases_get
+## delete_alias
 
-> <V1AliasesGet200Response> v1_aliases_get
+> delete_alias(address)
 
-List aliases
+Delete an alias
+
+Hard-delete (no soft-delete window — aliases are cheap to recreate).
 
 ### Examples
 
@@ -95,41 +98,43 @@ Lockally.configure do |config|
 end
 
 api_instance = Lockally::AliasesApi.new
+address = 'address_example' # String | 
 
 begin
-  # List aliases
-  result = api_instance.v1_aliases_get
-  p result
+  # Delete an alias
+  api_instance.delete_alias(address)
 rescue Lockally::ApiError => e
-  puts "Error when calling AliasesApi->v1_aliases_get: #{e}"
+  puts "Error when calling AliasesApi->delete_alias: #{e}"
 end
 ```
 
-#### Using the v1_aliases_get_with_http_info variant
+#### Using the delete_alias_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<V1AliasesGet200Response>, Integer, Hash)> v1_aliases_get_with_http_info
+> <Array(nil, Integer, Hash)> delete_alias_with_http_info(address)
 
 ```ruby
 begin
-  # List aliases
-  data, status_code, headers = api_instance.v1_aliases_get_with_http_info
+  # Delete an alias
+  data, status_code, headers = api_instance.delete_alias_with_http_info(address)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1AliasesGet200Response>
+  p data # => nil
 rescue Lockally::ApiError => e
-  puts "Error when calling AliasesApi->v1_aliases_get_with_http_info: #{e}"
+  puts "Error when calling AliasesApi->delete_alias_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** |  |  |
 
 ### Return type
 
-[**V1AliasesGet200Response**](V1AliasesGet200Response.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -138,16 +143,14 @@ This endpoint does not need any parameter.
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/problem+json
-
+- **Accept**: application/problem+json
 
-## v1_aliases_post
 
-> <ModelAlias> v1_aliases_post(v1_aliases_post_request)
+## list_aliases
 
-Create an alias
+> <ListAliases200Response> list_aliases
 
-Creates an email alias. `alias_address` must be on a verified tenant-owned domain and must not be the address of an existing mailbox (live, suspended or deleted). `alias_target` must be an active mailbox in the same workspace; forwarding to an address Lockally does not host is not supported. The alias delivers as soon as the call returns. 
+List aliases
 
 ### Examples
 
@@ -161,44 +164,41 @@ Lockally.configure do |config|
 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)
+  # List aliases
+  result = api_instance.list_aliases
   p result
 rescue Lockally::ApiError => e
-  puts "Error when calling AliasesApi->v1_aliases_post: #{e}"
+  puts "Error when calling AliasesApi->list_aliases: #{e}"
 end
 ```
 
-#### Using the v1_aliases_post_with_http_info variant
+#### Using the list_aliases_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)
+> <Array(<ListAliases200Response>, Integer, Hash)> list_aliases_with_http_info
 
 ```ruby
 begin
-  # Create an alias
-  data, status_code, headers = api_instance.v1_aliases_post_with_http_info(v1_aliases_post_request)
+  # List aliases
+  data, status_code, headers = api_instance.list_aliases_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <ModelAlias>
+  p data # => <ListAliases200Response>
 rescue Lockally::ApiError => e
-  puts "Error when calling AliasesApi->v1_aliases_post_with_http_info: #{e}"
+  puts "Error when calling AliasesApi->list_aliases_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **v1_aliases_post_request** | [**V1AliasesPostRequest**](V1AliasesPostRequest.md) |  |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**ModelAlias**](ModelAlias.md)
+[**ListAliases200Response**](ListAliases200Response.md)
 
 ### Authorization
 
@@ -206,6 +206,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json