lockally 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 890d3a4d26f371a00c74047b610b0a0a2669fe7f0ff304f1e63fda67b4546b96
-  data.tar.gz: 4987c88d94848537d1e171288b7c5b85aa427dbf2ccc3adcf8bc783dcb9e3f93
+  metadata.gz: 635cb8b1168196f95efdcda563396bacfd979103d3ba75aea85b288240070dd6
+  data.tar.gz: a1844f886139279931bc5c0d351f792399d484d5d73d4e0b44414221cf3ffd15
 SHA512:
-  metadata.gz: 66085de010a62bbfdbe8136b6e5116cabb3e44f3c4f1284a7963f2fc17e2312656e6891e83f320b94644bcfab5b4b902eb9e5fe22065a08f11adaf16b893302f
-  data.tar.gz: c4d0a270b79846c420f84e08b6f23a9e180083386b54b3b1f3f100f4a95d27d8b4faead45b123ce7e1cbf53904b3cea4070d21ce0a1e983a39d19afd88f62adb
+  metadata.gz: 817293d3468bdf6c8acf26416d9de3ea668ec453b2dffef9e2eb66779f4b6dd3be04918f6348574dbd34fd6929d44e0868bec319d48564f0a94f8bf2d99a929a
+  data.tar.gz: ff77f10cf4a2bcdbb012b099e15b31c0fdd761cbd87b1f2d026eceebc8b78512888130331688faf457fb211b860e2d42190169b8a5b0aa24dd29e969d640da0c

data/README.md

@@ -1,3 +1,14 @@
+<!-- lockally-brand-header -->
+<p align="center">
+  <a href="https://lockally.com">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/LockallyInc/community/main/brand/lockup-dark.png">
+      <img alt="Lockally" src="https://raw.githubusercontent.com/LockallyInc/community/main/brand/lockup-light.png" width="260">
+    </picture>
+  </a>
+</p>
+<!-- /lockally-brand-header -->
+
 # lockally
 
 Lockally - the Ruby gem for the lockally control plane
@@ -7,9 +18,12 @@ 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`.
+`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.
@@ -21,7 +35,7 @@ Insufficient scope returns `403` with the required scope name in `detail`.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 0.1.0
-- Package version: 0.1.0
+- Package version: 0.2.0
 - Generator version: 7.23.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -38,16 +52,16 @@ gem build lockally.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./lockally-0.1.0.gem
+gem install ./lockally-0.2.0.gem
 ```
 
-(for development, run `gem install --dev ./lockally-0.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./lockally-0.2.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'lockally', '~> 0.1.0'
+    gem 'lockally', '~> 0.2.0'
 
 ### Install from Git
 
@@ -145,6 +159,7 @@ Class | Method | HTTP request | Description
 *Lockally::CalendarsApi* | [**delete_calendar_event**](docs/CalendarsApi.md#delete_calendar_event) | **DELETE** /v1/calendars/{id}/events/{eventId} | Delete a calendar event
 *Lockally::CalendarsApi* | [**delete_calendar_integration**](docs/CalendarsApi.md#delete_calendar_integration) | **DELETE** /v1/calendar-integrations/{id} | Delete a calendar integration
 *Lockally::CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /v1/calendars/{id} | Get a calendar
+*Lockally::CalendarsApi* | [**get_calendar_overview**](docs/CalendarsApi.md#get_calendar_overview) | **GET** /v1/calendar-overview | Administrative overview of the organization's calendar system
 *Lockally::CalendarsApi* | [**get_calendar_policies**](docs/CalendarsApi.md#get_calendar_policies) | **GET** /v1/calendar-policies | Get calendar policies
 *Lockally::CalendarsApi* | [**get_calendar_security**](docs/CalendarsApi.md#get_calendar_security) | **GET** /v1/calendar-security | Get calendar security overview
 *Lockally::CalendarsApi* | [**list_calendar_events**](docs/CalendarsApi.md#list_calendar_events) | **GET** /v1/calendars/{id}/events | List events in a calendar
@@ -193,6 +208,10 @@ Class | Method | HTTP request | Description
 *Lockally::DistributionListsApi* | [**replace_distribution_list_members**](docs/DistributionListsApi.md#replace_distribution_list_members) | **PUT** /v1/distribution-lists/{address}/members | Replace distribution list members
 *Lockally::DomainsApi* | [**v1_domains_domain_delete**](docs/DomainsApi.md#v1_domains_domain_delete) | **DELETE** /v1/domains/{domain} | Delete a domain
 *Lockally::DomainsApi* | [**v1_domains_domain_get**](docs/DomainsApi.md#v1_domains_domain_get) | **GET** /v1/domains/{domain} | Get a domain
+*Lockally::DomainsApi* | [**v1_domains_domain_return_path_delete**](docs/DomainsApi.md#v1_domains_domain_return_path_delete) | **DELETE** /v1/domains/{domain}/return-path | Turn off the custom Return-Path
+*Lockally::DomainsApi* | [**v1_domains_domain_return_path_get**](docs/DomainsApi.md#v1_domains_domain_return_path_get) | **GET** /v1/domains/{domain}/return-path | Get the custom Return-Path
+*Lockally::DomainsApi* | [**v1_domains_domain_return_path_post**](docs/DomainsApi.md#v1_domains_domain_return_path_post) | **POST** /v1/domains/{domain}/return-path | Turn on the custom Return-Path
+*Lockally::DomainsApi* | [**v1_domains_domain_return_path_verify_post**](docs/DomainsApi.md#v1_domains_domain_return_path_verify_post) | **POST** /v1/domains/{domain}/return-path/verify | Check the custom Return-Path records
 *Lockally::DomainsApi* | [**v1_domains_domain_verify_post**](docs/DomainsApi.md#v1_domains_domain_verify_post) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification
 *Lockally::DomainsApi* | [**v1_domains_get**](docs/DomainsApi.md#v1_domains_get) | **GET** /v1/domains | List domains
 *Lockally::DomainsApi* | [**v1_domains_post**](docs/DomainsApi.md#v1_domains_post) | **POST** /v1/domains | Register a domain
@@ -333,6 +352,8 @@ Class | Method | HTTP request | Description
  - [Lockally::GALSettings](docs/GALSettings.md)
  - [Lockally::GetAddOnStatus200Response](docs/GetAddOnStatus200Response.md)
  - [Lockally::GetAuditSummary200Response](docs/GetAuditSummary200Response.md)
+ - [Lockally::GetCalendarOverview200Response](docs/GetCalendarOverview200Response.md)
+ - [Lockally::GetCalendarOverview200ResponseActivityInner](docs/GetCalendarOverview200ResponseActivityInner.md)
  - [Lockally::GetCalendarSecurity200Response](docs/GetCalendarSecurity200Response.md)
  - [Lockally::GetCalendarSecurity200ResponseAlertsInner](docs/GetCalendarSecurity200ResponseAlertsInner.md)
  - [Lockally::GetCalendarSecurity200ResponseDelegatedAccessInner](docs/GetCalendarSecurity200ResponseDelegatedAccessInner.md)
@@ -381,6 +402,7 @@ Class | Method | HTTP request | Description
  - [Lockally::MapMigrationRequest](docs/MapMigrationRequest.md)
  - [Lockally::MapMigrationRequestMappingsInner](docs/MapMigrationRequestMappingsInner.md)
  - [Lockally::Message](docs/Message.md)
+ - [Lockally::MessageDetail](docs/MessageDetail.md)
  - [Lockally::MessageStats](docs/MessageStats.md)
  - [Lockally::MessageStatsCounts](docs/MessageStatsCounts.md)
  - [Lockally::MessageStatsRates](docs/MessageStatsRates.md)
@@ -398,6 +420,8 @@ Class | Method | HTTP request | Description
  - [Lockally::ReplaceDistributionListMembers200Response](docs/ReplaceDistributionListMembers200Response.md)
  - [Lockally::ReplaceDistributionListMembersRequest](docs/ReplaceDistributionListMembersRequest.md)
  - [Lockally::Resource](docs/Resource.md)
+ - [Lockally::ReturnPath](docs/ReturnPath.md)
+ - [Lockally::ReturnPathCheck](docs/ReturnPathCheck.md)
  - [Lockally::RotateEncryptionKeyRequest](docs/RotateEncryptionKeyRequest.md)
  - [Lockally::SendMessage](docs/SendMessage.md)
  - [Lockally::SharedMember](docs/SharedMember.md)
@@ -445,6 +469,7 @@ Class | Method | HTTP request | Description
  - [Lockally::V1MessagesGet200Response](docs/V1MessagesGet200Response.md)
  - [Lockally::V1SendBatchPost200Response](docs/V1SendBatchPost200Response.md)
  - [Lockally::V1SendBatchPostRequest](docs/V1SendBatchPostRequest.md)
+ - [Lockally::V1SendPost200Response](docs/V1SendPost200Response.md)
  - [Lockally::V1SendPost202Response](docs/V1SendPost202Response.md)
  - [Lockally::V1SendPostRequest](docs/V1SendPostRequest.md)
  - [Lockally::V1SendPostRequestAttachmentsInner](docs/V1SendPostRequestAttachmentsInner.md)

data/docs/AliasesApi.md

@@ -147,7 +147,7 @@ This endpoint does not need any parameter.
 
 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. 
 
 ### Examples
 

data/docs/BatchResult.md

@@ -7,7 +7,7 @@
 | **index** | **Integer** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **message_id** | **String** |  | [optional] |
-| **status** | **String** |  | [optional] |
+| **status** | **String** | \"suppressed\" means every recipient of that slot was on your suppression list, and it carries no id or message_id. \"delivered\" only appears on a test key: the send was simulated, not transmitted. | [optional] |
 | **error** | **String** | Present when this message failed; the others are then absent. | [optional] |
 
 ## Example

data/docs/Calendar.md

@@ -10,7 +10,11 @@
 | **color** | **String** |  | [optional] |
 | **owner_email** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
+| **calendar_type** | **String** | What the calendar is for. Separate from visibility, which is who may see it: a team calendar can be open to everyone and a department one restricted to named people. \"personal\" is a person's own and is not listed in the console's management table.  | [optional] |
+| **owner_unit** | **String** | The owning department or office. Empty on a personal calendar, which is owned by owner_email. | [optional] |
 | **visibility** | **String** |  |  |
+| **access_department** | **String** | Which department may see it, when visibility is \"department\". Matched against the department recorded on a user, so access follows a person between departments with no membership list to maintain.  | [optional] |
+| **status** | **String** | Archived keeps the calendar, its events and its feed, and stops it taking new events. | [optional] |
 | **feed_url** | **String** |  | [optional] |
 | **event_count** | **Integer** |  | [optional] |
 | **created_at** | **Time** |  |  |
@@ -28,7 +32,11 @@ instance = Lockally::Calendar.new(
   color: null,
   owner_email: null,
   description: null,
+  calendar_type: null,
+  owner_unit: null,
   visibility: null,
+  access_department: null,
+  status: null,
   feed_url: null,
   event_count: null,
   created_at: null,

data/docs/CalendarsApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://api.lockally.com*
 | [**delete_calendar_event**](CalendarsApi.md#delete_calendar_event) | **DELETE** /v1/calendars/{id}/events/{eventId} | Delete a calendar event |
 | [**delete_calendar_integration**](CalendarsApi.md#delete_calendar_integration) | **DELETE** /v1/calendar-integrations/{id} | Delete a calendar integration |
 | [**get_calendar**](CalendarsApi.md#get_calendar) | **GET** /v1/calendars/{id} | Get a calendar |
+| [**get_calendar_overview**](CalendarsApi.md#get_calendar_overview) | **GET** /v1/calendar-overview | Administrative overview of the organization's calendar system |
 | [**get_calendar_policies**](CalendarsApi.md#get_calendar_policies) | **GET** /v1/calendar-policies | Get calendar policies |
 | [**get_calendar_security**](CalendarsApi.md#get_calendar_security) | **GET** /v1/calendar-security | Get calendar security overview |
 | [**list_calendar_events**](CalendarsApi.md#list_calendar_events) | **GET** /v1/calendars/{id}/events | List events in a calendar |
@@ -238,6 +239,8 @@ 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. 
+
 ### Examples
 
 ```ruby
@@ -566,6 +569,72 @@ end
 - **Accept**: application/json, application/problem+json
 
 
+## get_calendar_overview
+
+> <GetCalendarOverview200Response> get_calendar_overview
+
+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. 
+
+### 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::CalendarsApi.new
+
+begin
+  # Administrative overview of the organization's calendar system
+  result = api_instance.get_calendar_overview
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling CalendarsApi->get_calendar_overview: #{e}"
+end
+```
+
+#### Using the get_calendar_overview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCalendarOverview200Response>, Integer, Hash)> get_calendar_overview_with_http_info
+
+```ruby
+begin
+  # Administrative overview of the organization's calendar system
+  data, status_code, headers = api_instance.get_calendar_overview_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCalendarOverview200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling CalendarsApi->get_calendar_overview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetCalendarOverview200Response**](GetCalendarOverview200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
 ## get_calendar_policies
 
 > <CalendarPolicies> get_calendar_policies
@@ -1036,6 +1105,8 @@ nil (empty response body)
 
 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. 
+
 ### Examples
 
 ```ruby
@@ -1243,6 +1314,8 @@ 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. 
+
 ### Examples
 
 ```ruby

data/docs/DomainsApi.md

@@ -6,6 +6,10 @@ All URIs are relative to *https://api.lockally.com*
 | ------ | ------------ | ----------- |
 | [**v1_domains_domain_delete**](DomainsApi.md#v1_domains_domain_delete) | **DELETE** /v1/domains/{domain} | Delete a domain |
 | [**v1_domains_domain_get**](DomainsApi.md#v1_domains_domain_get) | **GET** /v1/domains/{domain} | Get a domain |
+| [**v1_domains_domain_return_path_delete**](DomainsApi.md#v1_domains_domain_return_path_delete) | **DELETE** /v1/domains/{domain}/return-path | Turn off the custom Return-Path |
+| [**v1_domains_domain_return_path_get**](DomainsApi.md#v1_domains_domain_return_path_get) | **GET** /v1/domains/{domain}/return-path | Get the custom Return-Path |
+| [**v1_domains_domain_return_path_post**](DomainsApi.md#v1_domains_domain_return_path_post) | **POST** /v1/domains/{domain}/return-path | Turn on the custom Return-Path |
+| [**v1_domains_domain_return_path_verify_post**](DomainsApi.md#v1_domains_domain_return_path_verify_post) | **POST** /v1/domains/{domain}/return-path/verify | Check the custom Return-Path records |
 | [**v1_domains_domain_verify_post**](DomainsApi.md#v1_domains_domain_verify_post) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification |
 | [**v1_domains_get**](DomainsApi.md#v1_domains_get) | **GET** /v1/domains | List domains |
 | [**v1_domains_post**](DomainsApi.md#v1_domains_post) | **POST** /v1/domains | Register a domain |
@@ -146,6 +150,281 @@ end
 - **Accept**: application/json, application/problem+json
 
 
+## v1_domains_domain_return_path_delete
+
+> v1_domains_domain_return_path_delete(domain)
+
+Turn off the custom Return-Path
+
+API mail uses the sender's own address as the envelope sender again, from the next message. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Turn off the custom Return-Path
+  api_instance.v1_domains_domain_return_path_delete(domain)
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_delete: #{e}"
+end
+```
+
+#### Using the v1_domains_domain_return_path_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_domains_domain_return_path_delete_with_http_info(domain)
+
+```ruby
+begin
+  # Turn off the custom Return-Path
+  data, status_code, headers = api_instance.v1_domains_domain_return_path_delete_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_domains_domain_return_path_get
+
+> <ReturnPath> v1_domains_domain_return_path_get(domain)
+
+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`. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Get the custom Return-Path
+  result = api_instance.v1_domains_domain_return_path_get(domain)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_get: #{e}"
+end
+```
+
+#### Using the v1_domains_domain_return_path_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReturnPath>, Integer, Hash)> v1_domains_domain_return_path_get_with_http_info(domain)
+
+```ruby
+begin
+  # Get the custom Return-Path
+  data, status_code, headers = api_instance.v1_domains_domain_return_path_get_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReturnPath>
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+[**ReturnPath**](ReturnPath.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_domains_domain_return_path_post
+
+> <ReturnPath> v1_domains_domain_return_path_post(domain)
+
+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. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Turn on the custom Return-Path
+  result = api_instance.v1_domains_domain_return_path_post(domain)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_post: #{e}"
+end
+```
+
+#### Using the v1_domains_domain_return_path_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReturnPath>, Integer, Hash)> v1_domains_domain_return_path_post_with_http_info(domain)
+
+```ruby
+begin
+  # Turn on the custom Return-Path
+  data, status_code, headers = api_instance.v1_domains_domain_return_path_post_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReturnPath>
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+[**ReturnPath**](ReturnPath.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_domains_domain_return_path_verify_post
+
+> <ReturnPath> v1_domains_domain_return_path_verify_post(domain)
+
+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. 
+
+### 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::DomainsApi.new
+domain = 'domain_example' # String | 
+
+begin
+  # Check the custom Return-Path records
+  result = api_instance.v1_domains_domain_return_path_verify_post(domain)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_verify_post: #{e}"
+end
+```
+
+#### Using the v1_domains_domain_return_path_verify_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReturnPath>, Integer, Hash)> v1_domains_domain_return_path_verify_post_with_http_info(domain)
+
+```ruby
+begin
+  # Check the custom Return-Path records
+  data, status_code, headers = api_instance.v1_domains_domain_return_path_verify_post_with_http_info(domain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReturnPath>
+rescue Lockally::ApiError => e
+  puts "Error when calling DomainsApi->v1_domains_domain_return_path_verify_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+
+### Return type
+
+[**ReturnPath**](ReturnPath.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
 ## v1_domains_domain_verify_post
 
 > <Domain> v1_domains_domain_verify_post(domain)

data/docs/GetCalendarOverview200Response.md

@@ -0,0 +1,34 @@
+# Lockally::GetCalendarOverview200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_calendars** | **Integer** |  | [optional] |
+| **active_calendars** | **Integer** | Calendars with an event created, edited or held in the last 30 days. | [optional] |
+| **shared_calendars** | **Integer** | Calendars visible to the whole organization. | [optional] |
+| **events_this_month** | **Integer** | Events on every calendar, in the account's own timezone. | [optional] |
+| **upcoming_org_events** | **Integer** | Future events on organization-visible calendars. | [optional] |
+| **bookable_resources** | **Integer** | Resources that are not disabled. | [optional] |
+| **access_granted** | **Integer** | People who own a calendar or are named on one. | [optional] |
+| **access_org_wide** | **Integer** | Everyone who can see an organization calendar; 0 when none exists. | [optional] |
+| **activity** | [**Array<GetCalendarOverview200ResponseActivityInner>**](GetCalendarOverview200ResponseActivityInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::GetCalendarOverview200Response.new(
+  total_calendars: null,
+  active_calendars: null,
+  shared_calendars: null,
+  events_this_month: null,
+  upcoming_org_events: null,
+  bookable_resources: null,
+  access_granted: null,
+  access_org_wide: null,
+  activity: null
+)
+```
+

data/docs/GetCalendarOverview200ResponseActivityInner.md

@@ -0,0 +1,24 @@
+# Lockally::GetCalendarOverview200ResponseActivityInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  | [optional] |
+| **target** | **String** |  | [optional] |
+| **actor** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::GetCalendarOverview200ResponseActivityInner.new(
+  action: null,
+  target: null,
+  actor: null,
+  created_at: null
+)
+```
+

data/docs/GetUserInsights200Response.md

@@ -9,6 +9,7 @@
 | **inactive_30d** | [**Array<UserEvent>**](UserEvent.md) |  | [optional] |
 | **seats_used** | **Integer** |  | [optional] |
 | **seats_alloc** | **Integer** |  | [optional] |
+| **seats_capped** | **Boolean** | True only on tiers with a hard seat cap (Free, Founder). On unlimited/per-seat tiers seats_alloc merely tracks the live mailbox count, so seats_used == seats_alloc is normal and must not be read as 'at capacity'. | [optional] |
 | **generated_at** | **Time** |  | [optional] |
 
 ## Example
@@ -22,6 +23,7 @@ instance = Lockally::GetUserInsights200Response.new(
   inactive_30d: null,
   seats_used: null,
   seats_alloc: null,
+  seats_capped: null,
   generated_at: null
 )
 ```

data/docs/MailboxesApi.md

@@ -364,7 +364,7 @@ No authorization required
 
 Request a mailbox export
 
-Issues a one-shot \"presigned\" download URL for the mailbox's content in mbox format. The URL works without an Authorization header — the token in the query string is the authz. TTL is 5 minutes; the token is consumed on first GET.  **v1 caveat:** the synthesized mbox only contains outbound mail (from `lockally.messages`). v2 swaps in Stalwart's export primitive for full inbox + folder structure + flags. The endpoint contract stays unchanged. 
+Issues a one-shot \"presigned\" download URL for the mailbox's content in mbox format. The URL works without an Authorization header — the token in the query string is the authz. TTL is 5 minutes; the token is consumed on first GET.  **v1 caveat:** the synthesized mbox only contains outbound mail (from `lockally.messages`). v2 swaps in Stalwart's export primitive for full inbox + folder structure + flags. The endpoint contract stays unchanged.  **Scope changed:** this used to accept `mailboxes:read`. It takes any mailbox in the tenant and returns that mailbox's mail, so it now requires `tenant:admin`, matching `POST /v1/ediscovery/export`. A key scoped `mailboxes:read` gets 403 and has to be reissued; admin console sessions are unaffected. 
 
 ### Examples