lockally 0.2.0 → 0.3.1

data/spec/api/ai_api_spec.rb

@@ -32,47 +32,47 @@ describe 'AiApi' do
     end
   end
 
-  # unit tests for 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.
+  # unit tests for classify_thread
+  # 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.
+  # @param thread_id 
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_ai_config_get test' do
+  # @option opts [Boolean] :refresh 
+  # @return [ThreadClassification]
+  describe 'classify_thread test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for 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.
+  # unit tests for create_ai_units_checkout
+  # 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.
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_ai_config_put test' do
+  # @return [CreateAiUnitsCheckout200Response]
+  describe 'create_ai_units_checkout test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for 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.
+  # unit tests for get_ai_config
+  # 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.
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_billing_ai_units_checkout_post test' do
+  # @return [AiConfig]
+  describe 'get_ai_config test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_threads_thread_id_classify_post
-  # 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.
-  # @param thread_id 
+  # unit tests for update_ai_config
+  # 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.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :refresh 
-  # @return [Object]
-  describe 'v1_threads_thread_id_classify_post test' do
+  # @return [AiConfigUpdate]
+  describe 'update_ai_config test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/aliases_api_spec.rb

@@ -32,35 +32,35 @@ describe 'AliasesApi' do
     end
   end
 
-  # unit tests for v1_aliases_address_delete
-  # Delete an alias
-  # Hard-delete (no soft-delete window — aliases are cheap to recreate).
-  # @param address 
+  # unit tests for create_alias
+  # Create an alias
+  # 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. 
+  # @param create_alias_request 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_aliases_address_delete test' do
+  # @return [ModelAlias]
+  describe 'create_alias test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_aliases_get
-  # List aliases
+  # unit tests for delete_alias
+  # Delete an alias
+  # Hard-delete (no soft-delete window — aliases are cheap to recreate).
+  # @param address 
   # @param [Hash] opts the optional parameters
-  # @return [V1AliasesGet200Response]
-  describe 'v1_aliases_get test' do
+  # @return [nil]
+  describe 'delete_alias test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_aliases_post
-  # Create an alias
-  # 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. 
-  # @param v1_aliases_post_request 
+  # unit tests for list_aliases
+  # List aliases
   # @param [Hash] opts the optional parameters
-  # @return [ModelAlias]
-  describe 'v1_aliases_post test' do
+  # @return [ListAliases200Response]
+  describe 'list_aliases test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/api_keys_api_spec.rb

@@ -32,36 +32,36 @@ describe 'ApiKeysApi' do
     end
   end
 
-  # unit tests for 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. 
+  # unit tests for create_api_key
+  # 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. 
+  # @param create_api_key_request 
   # @param [Hash] opts the optional parameters
-  # @return [V1ApiKeysGet200Response]
-  describe 'v1_api_keys_get test' do
+  # @return [CreateApiKey201Response]
+  describe 'create_api_key test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_api_keys_id_delete
-  # 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. 
-  # @param id 
+  # unit tests for list_api_keys
+  # List API keys
+  # Returns all API keys (active and revoked) belonging to the calling tenant. The `secret` is **never** returned — only prefix + metadata. 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_api_keys_id_delete test' do
+  # @return [ListApiKeys200Response]
+  describe 'list_api_keys test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_api_keys_post
-  # 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. 
-  # @param v1_api_keys_post_request 
+  # unit tests for revoke_api_key
+  # 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. 
+  # @param id 
   # @param [Hash] opts the optional parameters
-  # @return [V1ApiKeysPost201Response]
-  describe 'v1_api_keys_post test' do
+  # @return [nil]
+  describe 'revoke_api_key test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/domains_api_spec.rb

@@ -32,107 +32,107 @@ describe 'DomainsApi' do
     end
   end
 
-  # unit tests for v1_domains_domain_delete
-  # Delete a domain
-  # Removes the domain registration. Refuses with 409 if any mailbox is still attached — delete the mailboxes first. 
-  # @param domain 
+  # unit tests for create_domain
+  # Register a domain
+  # Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed).  **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create.  Returns 409 if the domain is already claimed by a different tenant. 
+  # @param create_domain_request 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_domains_domain_delete test' do
+  # @return [Domain]
+  describe 'create_domain test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_domain_get
-  # Get a domain
+  # unit tests for delete_domain
+  # Delete a domain
+  # Removes the domain registration. Refuses with 409 if any mailbox is still attached — delete the mailboxes first. 
   # @param domain 
   # @param [Hash] opts the optional parameters
-  # @return [Domain]
-  describe 'v1_domains_domain_get test' do
+  # @return [nil]
+  describe 'delete_domain test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_domain_return_path_delete
+  # unit tests for disable_return_path
   # Turn off the custom Return-Path
   # API mail uses the sender's own address as the envelope sender again, from the next message. 
   # @param domain 
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'v1_domains_domain_return_path_delete test' do
+  describe 'disable_return_path test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_domain_return_path_get
-  # Get the custom Return-Path
-  # A custom Return-Path moves the envelope sender of mail sent through the API from this domain onto `bounces.<domain>`. Bounce reports then come back to Lockally instead of the sending mailbox, and a bounce that arrives after delivery marks the message bounced, suppresses the address and fires `delivery.bounced`. Mail sent from webmail or mail apps is not affected. DKIM stays signed by the domain itself. `status` is `off`, `pending` (records not confirmed yet) or `active`. 
+  # unit tests for enable_return_path
+  # Turn on the custom Return-Path
+  # Moves it to `pending` and returns the two records to publish on `bounces.<domain>`. Nothing changes for mail until they are confirmed with the verify call. The domain must be verified. Available on every plan except Free. 
   # @param domain 
   # @param [Hash] opts the optional parameters
   # @return [ReturnPath]
-  describe 'v1_domains_domain_return_path_get test' do
+  describe 'enable_return_path test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_domain_return_path_post
-  # Turn on the custom Return-Path
-  # Moves it to `pending` and returns the two records to publish on `bounces.<domain>`. Nothing changes for mail until they are confirmed with the verify call. The domain must be verified. Available on every plan except Free. 
+  # unit tests for get_domain
+  # Get a domain
   # @param domain 
   # @param [Hash] opts the optional parameters
-  # @return [ReturnPath]
-  describe 'v1_domains_domain_return_path_post test' do
+  # @return [Domain]
+  describe 'get_domain test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_domain_return_path_verify_post
-  # Check the custom Return-Path records
-  # Looks up the MX and SPF records on `bounces.<domain>`. Returns 200 either way: while a record is missing the status stays `pending` and `check` says which one. Once both are found the Return-Path becomes `active` and the send path starts using it. 
+  # unit tests for get_return_path
+  # Get the custom Return-Path
+  # A custom Return-Path moves the envelope sender of mail sent through the API from this domain onto `bounces.<domain>`. Bounce reports then come back to Lockally instead of the sending mailbox, and a bounce that arrives after delivery marks the message bounced, suppresses the address and fires `delivery.bounced`. Mail sent from webmail or mail apps is not affected. DKIM stays signed by the domain itself. `status` is `off`, `pending` (records not confirmed yet) or `active`. 
   # @param domain 
   # @param [Hash] opts the optional parameters
   # @return [ReturnPath]
-  describe 'v1_domains_domain_return_path_verify_post test' do
+  describe 'get_return_path test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_domain_verify_post
-  # Force-poll DNS verification
-  # Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook. 
-  # @param domain 
+  # unit tests for list_domains
+  # List domains
+  # Returns every domain registered under the calling tenant.
   # @param [Hash] opts the optional parameters
-  # @return [Domain]
-  describe 'v1_domains_domain_verify_post test' do
+  # @return [ListDomains200Response]
+  describe 'list_domains test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_get
-  # List domains
-  # Returns every domain registered under the calling tenant.
+  # unit tests for verify_domain
+  # Force-poll DNS verification
+  # Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook. 
+  # @param domain 
   # @param [Hash] opts the optional parameters
-  # @return [V1DomainsGet200Response]
-  describe 'v1_domains_get test' do
+  # @return [Domain]
+  describe 'verify_domain test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_domains_post
-  # Register a domain
-  # Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed).  **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create.  Returns 409 if the domain is already claimed by a different tenant. 
-  # @param v1_domains_post_request 
+  # unit tests for verify_return_path
+  # Check the custom Return-Path records
+  # Looks up the MX and SPF records on `bounces.<domain>`. Returns 200 either way: while a record is missing the status stays `pending` and `check` says which one. Once both are found the Return-Path becomes `active` and the send path starts using it. 
+  # @param domain 
   # @param [Hash] opts the optional parameters
-  # @return [Domain]
-  describe 'v1_domains_post test' do
+  # @return [ReturnPath]
+  describe 'verify_return_path test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/drafts_api_spec.rb

@@ -32,87 +32,87 @@ describe 'DraftsApi' do
     end
   end
 
-  # unit tests for v1_drafts_draft_id_approve_post
+  # unit tests for approve_draft
   # Approve a pending draft (human)
   # Sends the draft exactly as reviewed, through the agent stream (loop detector included). Fires draft.approved.
   # @param draft_id 
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_drafts_draft_id_approve_post test' do
+  # @return [DraftResult]
+  describe 'approve_draft test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_drafts_draft_id_cancel_post
+  # unit tests for cancel_draft
   # Withdraw a pending draft
   # Only the API key that created the draft may cancel it.
   # @param draft_id 
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_drafts_draft_id_cancel_post test' do
+  # @return [Draft]
+  describe 'cancel_draft test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_drafts_draft_id_get
-  # Get a draft
-  # @param draft_id 
+  # unit tests for create_conversation_draft
+  # Propose a new conversation as a draft
+  # New-conversation drafts ALWAYS require human approval (policy flag new_thread). Idempotency-Key required.
+  # @param mailbox 
+  # @param idempotency_key 
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_drafts_draft_id_get test' do
+  # @return [DraftResult]
+  describe 'create_conversation_draft test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_drafts_draft_id_reject_post
-  # Reject a pending draft (human)
-  # Body: {\"reason\": \"...\"} (optional). Fires draft.rejected.
-  # @param draft_id 
+  # unit tests for create_reply_draft
+  # Propose a reply as a draft
+  # The safe default over /reply: the deterministic policy engine auto-sends clean in-thread replies and holds anything risky (PII, new recipients, injection-flagged threads, always-approve mailboxes) for human approval. Fires draft.pending_approval when held. Idempotency-Key required.
+  # @param thread_id 
+  # @param idempotency_key 
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_drafts_draft_id_reject_post test' do
+  # @return [DraftResult]
+  describe 'create_reply_draft test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_drafts_get
-  # List drafts
-  # Filter with ?status=pending_approval|sent|rejected|cancelled. Keys see drafts of granted mailboxes; admin sessions see all.
+  # unit tests for get_draft
+  # Get a draft
+  # @param draft_id 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :status 
-  # @option opts [Integer] :limit 
-  # @return [Object]
-  describe 'v1_drafts_get test' do
+  # @return [Draft]
+  describe 'get_draft test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_inboxes_mailbox_drafts_post
-  # Propose a new conversation as a draft
-  # New-conversation drafts ALWAYS require human approval (policy flag new_thread). Idempotency-Key required.
-  # @param mailbox 
-  # @param idempotency_key 
+  # unit tests for list_drafts
+  # List drafts
+  # Filter with ?status=pending_approval|sent|rejected|cancelled. Keys see drafts of granted mailboxes; admin sessions see all.
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_inboxes_mailbox_drafts_post test' do
+  # @option opts [String] :status 
+  # @option opts [Integer] :limit 
+  # @return [DraftList]
+  describe 'list_drafts test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_threads_thread_id_drafts_post
-  # Propose a reply as a draft
-  # The safe default over /reply: the deterministic policy engine auto-sends clean in-thread replies and holds anything risky (PII, new recipients, injection-flagged threads, always-approve mailboxes) for human approval. Fires draft.pending_approval when held. Idempotency-Key required.
-  # @param thread_id 
-  # @param idempotency_key 
+  # unit tests for reject_draft
+  # Reject a pending draft (human)
+  # Body: {\"reason\": \"...\"} (optional). Fires draft.rejected.
+  # @param draft_id 
   # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'v1_threads_thread_id_drafts_post test' do
+  # @return [Draft]
+  describe 'reject_draft test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/health_api_spec.rb

@@ -32,12 +32,12 @@ describe 'HealthApi' do
     end
   end
 
-  # unit tests for healthz_get
+  # unit tests for health_check
   # Liveness check
   # Returns 200 if the process is up and the database pings cleanly. No authentication required.
   # @param [Hash] opts the optional parameters
-  # @return [HealthzGet200Response]
-  describe 'healthz_get test' do
+  # @return [HealthCheck200Response]
+  describe 'health_check test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end