lockally 0.1.0 → 0.2.0

data/docs/MessageDetail.md

@@ -0,0 +1,52 @@
+# Lockally::MessageDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **message_id** | **String** | RFC 5322 Message-ID header, including angle brackets. |  |
+| **sender** | **String** |  |  |
+| **recipients** | **Array<String>** |  |  |
+| **subject** | **String** |  | [optional] |
+| **status** | **String** |  |  |
+| **queued_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **bounce_reason** | **String** |  | [optional] |
+| **size_bytes** | **Integer** |  | [optional] |
+| **from** | **String** |  | [optional] |
+| **to** | **Array<String>** |  | [optional] |
+| **cc** | **Array<String>** |  | [optional] |
+| **bcc** | **Array<String>** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **html** | **String** |  | [optional] |
+| **headers** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::MessageDetail.new(
+  id: null,
+  tenant_id: null,
+  message_id: null,
+  sender: null,
+  recipients: null,
+  subject: null,
+  status: null,
+  queued_at: null,
+  updated_at: null,
+  bounce_reason: null,
+  size_bytes: null,
+  from: null,
+  to: null,
+  cc: null,
+  bcc: null,
+  text: null,
+  html: null,
+  headers: null
+)
+```
+

data/docs/ReturnPath.md

@@ -0,0 +1,28 @@
+# Lockally::ReturnPath
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **host** | **String** |  |  |
+| **records** | [**Array<DNSRecord>**](DNSRecord.md) |  |  |
+| **check** | [**ReturnPathCheck**](ReturnPathCheck.md) |  | [optional] |
+| **requested_at** | **Time** |  | [optional] |
+| **verified_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ReturnPath.new(
+  status: null,
+  host: bounces.acme.com,
+  records: null,
+  check: null,
+  requested_at: null,
+  verified_at: null
+)
+```
+

data/docs/ReturnPathCheck.md

@@ -0,0 +1,20 @@
+# Lockally::ReturnPathCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mx** | **Boolean** |  | [optional] |
+| **spf** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ReturnPathCheck.new(
+  mx: null,
+  spf: null
+)
+```
+

data/docs/SendApi.md

@@ -163,7 +163,7 @@ nil (empty response body)
 
 ## v1_messages_id_get
 
-> <Message> v1_messages_id_get(id)
+> <MessageDetail> v1_messages_id_get(id)
 
 Get message status
 
@@ -194,7 +194,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Message>, Integer, Hash)> v1_messages_id_get_with_http_info(id)
+> <Array(<MessageDetail>, Integer, Hash)> v1_messages_id_get_with_http_info(id)
 
 ```ruby
 begin
@@ -202,7 +202,7 @@ begin
   data, status_code, headers = api_instance.v1_messages_id_get_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Message>
+  p data # => <MessageDetail>
 rescue Lockally::ApiError => e
   puts "Error when calling SendApi->v1_messages_id_get_with_http_info: #{e}"
 end
@@ -216,7 +216,7 @@ end
 
 ### Return type
 
-[**Message**](Message.md)
+[**MessageDetail**](MessageDetail.md)
 
 ### Authorization
 
@@ -376,11 +376,11 @@ end
 
 ## v1_send_post
 
-> <V1SendPost202Response> v1_send_post(idempotency_key, v1_send_post_request)
+> <V1SendPost200Response> v1_send_post(idempotency_key, v1_send_post_request)
 
 Send an email
 
-Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`.  **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message.  **Sender authorisation.** `from` must be a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported.  **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped.  **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. 
+Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`.  **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message.  **Sender authorisation.** `from` must be a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported.  **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped.  **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send.  **Not every success is a 202.** Check the status code, not just the body. A `200` means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the `200` response below.  **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry `X-Warmup-Day`, `X-Warmup-Daily-Cap` and `X-Warmup-Used-Today`. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429. 
 
 ### Examples
 
@@ -410,7 +410,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<V1SendPost202Response>, Integer, Hash)> v1_send_post_with_http_info(idempotency_key, v1_send_post_request)
+> <Array(<V1SendPost200Response>, Integer, Hash)> v1_send_post_with_http_info(idempotency_key, v1_send_post_request)
 
 ```ruby
 begin
@@ -418,7 +418,7 @@ begin
   data, status_code, headers = api_instance.v1_send_post_with_http_info(idempotency_key, v1_send_post_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1SendPost202Response>
+  p data # => <V1SendPost200Response>
 rescue Lockally::ApiError => e
   puts "Error when calling SendApi->v1_send_post_with_http_info: #{e}"
 end
@@ -433,7 +433,7 @@ end
 
 ### Return type
 
-[**V1SendPost202Response**](V1SendPost202Response.md)
+[**V1SendPost200Response**](V1SendPost200Response.md)
 
 ### Authorization
 

data/docs/SendMessage.md

@@ -12,6 +12,8 @@
 | **text** | **String** |  | [optional] |
 | **html** | **String** |  | [optional] |
 | **headers** | **Hash<String, String>** |  | [optional] |
+| **reply_to** | **String** | Where replies go. Required when `from` has no mailbox behind it. The named form `Acme Support <a@b.com>` is also accepted. | [optional] |
+| **reply_to_name** | **String** | Display name shown on `Reply-To`. Ignored without `reply_to`. | [optional] |
 | **unsubscribe** | **Boolean** |  | [optional] |
 | **template_id** | **String** |  | [optional] |
 | **variables** | **Hash<String, String>** |  | [optional] |
@@ -32,6 +34,8 @@ instance = Lockally::SendMessage.new(
   text: null,
   html: null,
   headers: null,
+  reply_to: null,
+  reply_to_name: null,
   unsubscribe: null,
   template_id: null,
   variables: null,

data/docs/V1ApiKeysPostRequest.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **label** | **String** | Free-text identifier shown in the dashboard. |  |
 | **scopes** | **Array<String>** | Allowed scopes on this key. |  |
+| **test** | **Boolean** | Issue a test key (`lk_test_` prefix). A test key accepts sends, records them and fires a simulated delivery webhook without sending mail, and counts against no limit or allowance.  | [optional][default to false] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'lockally'
 
 instance = Lockally::V1ApiKeysPostRequest.new(
   label: ci-pipeline,
-  scopes: null
+  scopes: null,
+  test: null
 )
 ```
 

data/docs/V1SendPost200Response.md

@@ -0,0 +1,24 @@
+# Lockally::V1SendPost200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Present on a test-mode send; absent when suppressed. | [optional] |
+| **message_id** | **String** | RFC 5322 Message-ID. On a test send the domain is test.lockally.com. Absent when suppressed. | [optional] |
+| **status** | **String** |  |  |
+| **warning** | **String** | On a suppressed send, explains that nothing was sent. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::V1SendPost200Response.new(
+  id: null,
+  message_id: null,
+  status: null,
+  warning: null
+)
+```
+

data/docs/V1SendPostRequest.md

@@ -12,6 +12,8 @@
 | **text** | **String** | Plain-text body. Required if `html` is absent. | [optional] |
 | **html** | **String** | HTML body. Required if `text` is absent. | [optional] |
 | **headers** | **Hash<String, String>** |  | [optional] |
+| **reply_to** | **String** | Where replies go. REQUIRED when `from` has no mailbox behind it, since a reply there would be delivered nowhere. A `Reply-To` entry in `headers` satisfies the same rule. The named form `Acme Support <a@b.com>` is also accepted. | [optional] |
+| **reply_to_name** | **String** | Display name shown on `Reply-To`, e.g. `Acme Support`. Ignored without `reply_to`. Encoded and quoted for you, so accents, commas and quotes are all safe. | [optional] |
 | **unsubscribe** | **Boolean** | Mark as opt-in/broadcast: skips suppressed recipients and adds a managed one-click List-Unsubscribe header. | [optional] |
 | **template_id** | **String** | Render subject/text/html from a stored template (GET /v1/templates). Mutually exclusive with inline subject/text/html. | [optional] |
 | **variables** | **Hash<String, String>** | Values substituted into the template's {{variable}} placeholders. | [optional] |
@@ -32,6 +34,8 @@ instance = Lockally::V1SendPostRequest.new(
   text: null,
   html: null,
   headers: null,
+  reply_to: null,
+  reply_to_name: null,
   unsubscribe: null,
   template_id: null,
   variables: null,

data/lib/lockally/api/add_ons_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/admin_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/admins_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/agents_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/ai_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/aliases_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com
@@ -138,7 +138,7 @@ module Lockally
     end
 
     # 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). 
+    # 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 [V1AliasesPostRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ModelAlias]
@@ -148,7 +148,7 @@ module Lockally
     end
 
     # Create an alias
-    # Creates an email alias. &#x60;alias_address&#x60; must be on a verified tenant-owned domain. &#x60;alias_target&#x60; can be any email — intra-tenant or external (forwarding to a Gmail account is a legitimate use). 
+    # Creates an email alias. &#x60;alias_address&#x60; must be on a verified tenant-owned domain and must not be the address of an existing mailbox (live, suspended or deleted). &#x60;alias_target&#x60; 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 [V1AliasesPostRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ModelAlias, Integer, Hash)>] ModelAlias data, response status code and response headers

data/lib/lockally/api/api_keys_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/billing_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/calendars_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com
@@ -230,6 +230,7 @@ module Lockally
     end
 
     # Create a calendar integration
+    # Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
     # @param create_calendar_integration_request [CreateCalendarIntegrationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CalendarIntegration]
@@ -239,6 +240,7 @@ module Lockally
     end
 
     # Create a calendar integration
+    # Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
     # @param create_calendar_integration_request [CreateCalendarIntegrationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CalendarIntegration, Integer, Hash)>] CalendarIntegration data, response status code and response headers
@@ -545,6 +547,63 @@ module Lockally
       return data, status_code, headers
     end
 
+    # Administrative overview of the organization's calendar system
+    # Counts across the whole account, plus the recent calendar entries from the audit trail. Not scoped to the caller's own calendar. 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCalendarOverview200Response]
+    def get_calendar_overview(opts = {})
+      data, _status_code, _headers = get_calendar_overview_with_http_info(opts)
+      data
+    end
+
+    # Administrative overview of the organization&#39;s calendar system
+    # Counts across the whole account, plus the recent calendar entries from the audit trail. Not scoped to the caller&#39;s own calendar. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCalendarOverview200Response, Integer, Hash)>] GetCalendarOverview200Response data, response status code and response headers
+    def get_calendar_overview_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CalendarsApi.get_calendar_overview ...'
+      end
+      # resource path
+      local_var_path = '/v1/calendar-overview'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetCalendarOverview200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CalendarsApi.get_calendar_overview",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CalendarsApi#get_calendar_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get calendar policies
     # @param [Hash] opts the optional parameters
     # @return [CalendarPolicies]
@@ -961,6 +1020,7 @@ module Lockally
     end
 
     # Trigger sync for a calendar integration
+    # Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [CalendarIntegration]
@@ -970,6 +1030,7 @@ module Lockally
     end
 
     # Trigger sync for a calendar integration
+    # Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CalendarIntegration, Integer, Hash)>] CalendarIntegration data, response status code and response headers
@@ -1172,6 +1233,7 @@ module Lockally
     end
 
     # Update a calendar integration
+    # Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
     # @param id [String] 
     # @param update_calendar_integration_request [UpdateCalendarIntegrationRequest] 
     # @param [Hash] opts the optional parameters
@@ -1182,6 +1244,7 @@ module Lockally
     end
 
     # Update a calendar integration
+    # Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn. 
     # @param id [String] 
     # @param update_calendar_integration_request [UpdateCalendarIntegrationRequest] 
     # @param [Hash] opts the optional parameters

data/lib/lockally/api/contact_lists_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/contacts_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/dashboard_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/directory_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com

data/lib/lockally/api/distribution_lists_api.rb

@@ -1,7 +1,7 @@
 =begin
 #lockally control plane
 
-#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
 
 The version of the OpenAPI document: 0.1.0
 Contact: support@lockally.com