lockally 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 890d3a4d26f371a00c74047b610b0a0a2669fe7f0ff304f1e63fda67b4546b96
+  data.tar.gz: 4987c88d94848537d1e171288b7c5b85aa427dbf2ccc3adcf8bc783dcb9e3f93
+SHA512:
+  metadata.gz: 66085de010a62bbfdbe8136b6e5116cabb3e44f3c4f1284a7963f2fc17e2312656e6891e83f320b94644bcfab5b4b902eb9e5fe22065a08f11adaf16b893302f
+  data.tar.gz: c4d0a270b79846c420f84e08b6f23a9e180083386b54b3b1f3f100f4a95d27d8b4faead45b123ce7e1cbf53904b3cea4070d21ce0a1e983a39d19afd88f62adb

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lockally
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,481 @@
+# lockally
+
+Lockally - the Ruby gem for the 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`.
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1.0
+- Package version: 0.1.0
+- Generator version: 7.23.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build lockally.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./lockally-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./lockally-0.1.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'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'lockally', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'lockally'
+
+# Setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = Lockally::AddOnsApi.new
+name = 'name_example' # String | Add-on key
+
+begin
+  #Activate an add-on
+  result = api_instance.activate_add_on(name)
+  p result
+rescue Lockally::ApiError => e
+  puts "Exception when calling AddOnsApi->activate_add_on: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.lockally.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Lockally::AddOnsApi* | [**activate_add_on**](docs/AddOnsApi.md#activate_add_on) | **POST** /v1/add-ons/{name}/activate | Activate an add-on
+*Lockally::AddOnsApi* | [**cancel_add_on**](docs/AddOnsApi.md#cancel_add_on) | **POST** /v1/add-ons/{name}/cancel | Cancel an add-on
+*Lockally::AddOnsApi* | [**get_add_on_status**](docs/AddOnsApi.md#get_add_on_status) | **GET** /v1/add-ons/{name} | Get add-on status
+*Lockally::AddOnsApi* | [**list_add_ons**](docs/AddOnsApi.md#list_add_ons) | **GET** /v1/add-ons | List add-ons
+*Lockally::AdminApi* | [**v1_admin_login_post**](docs/AdminApi.md#v1_admin_login_post) | **POST** /v1/admin/login | Tenant-admin email+password login
+*Lockally::AdminApi* | [**v1_admin_logout_post**](docs/AdminApi.md#v1_admin_logout_post) | **POST** /v1/admin/logout | Invalidate the current admin session
+*Lockally::AdminApi* | [**v1_admin_me_get**](docs/AdminApi.md#v1_admin_me_get) | **GET** /v1/admin/me | Get the current admin + tenant
+*Lockally::AdminsApi* | [**v1_admins_get**](docs/AdminsApi.md#v1_admins_get) | **GET** /v1/admins | List tenant admins
+*Lockally::AdminsApi* | [**v1_admins_id_delete**](docs/AdminsApi.md#v1_admins_id_delete) | **DELETE** /v1/admins/{id} | Delete an admin
+*Lockally::AdminsApi* | [**v1_admins_id_patch**](docs/AdminsApi.md#v1_admins_id_patch) | **PATCH** /v1/admins/{id} | Update an admin
+*Lockally::AdminsApi* | [**v1_admins_post**](docs/AdminsApi.md#v1_admins_post) | **POST** /v1/admins | Invite a new admin
+*Lockally::AgentsApi* | [**v1_api_keys_key_id_mailboxes_get**](docs/AgentsApi.md#v1_api_keys_key_id_mailboxes_get) | **GET** /v1/api-keys/{keyID}/mailboxes | List a key's mailbox grants
+*Lockally::AgentsApi* | [**v1_api_keys_key_id_mailboxes_mailbox_id_delete**](docs/AgentsApi.md#v1_api_keys_key_id_mailboxes_mailbox_id_delete) | **DELETE** /v1/api-keys/{keyID}/mailboxes/{mailboxID} | Revoke a mailbox grant
+*Lockally::AgentsApi* | [**v1_api_keys_key_id_mailboxes_post**](docs/AgentsApi.md#v1_api_keys_key_id_mailboxes_post) | **POST** /v1/api-keys/{keyID}/mailboxes | Grant a mailbox to a key
+*Lockally::AgentsApi* | [**v1_auth_whoami_get**](docs/AgentsApi.md#v1_auth_whoami_get) | **GET** /v1/auth/whoami | Introspect the calling credentials
+*Lockally::AgentsApi* | [**v1_contacts_lookup_get**](docs/AgentsApi.md#v1_contacts_lookup_get) | **GET** /v1/contacts/lookup | Who is this sender?
+*Lockally::AgentsApi* | [**v1_inboxes_get**](docs/AgentsApi.md#v1_inboxes_get) | **GET** /v1/inboxes | List granted inboxes
+*Lockally::AgentsApi* | [**v1_inboxes_mailbox_messages_post**](docs/AgentsApi.md#v1_inboxes_mailbox_messages_post) | **POST** /v1/inboxes/{mailbox}/messages | Start a new conversation (agent stream)
+*Lockally::AgentsApi* | [**v1_inboxes_mailbox_threads_get**](docs/AgentsApi.md#v1_inboxes_mailbox_threads_get) | **GET** /v1/inboxes/{mailbox}/threads | List conversation threads
+*Lockally::AgentsApi* | [**v1_threads_thread_id_get**](docs/AgentsApi.md#v1_threads_thread_id_get) | **GET** /v1/threads/{threadID} | Get a whole conversation
+*Lockally::AgentsApi* | [**v1_threads_thread_id_messages_message_id_attachments_idx_get**](docs/AgentsApi.md#v1_threads_thread_id_messages_message_id_attachments_idx_get) | **GET** /v1/threads/{threadID}/messages/{messageID}/attachments/{idx} | Download an attachment
+*Lockally::AgentsApi* | [**v1_threads_thread_id_messages_message_id_get**](docs/AgentsApi.md#v1_threads_thread_id_messages_message_id_get) | **GET** /v1/threads/{threadID}/messages/{messageID} | Get one message with body
+*Lockally::AgentsApi* | [**v1_threads_thread_id_messages_message_id_read_post**](docs/AgentsApi.md#v1_threads_thread_id_messages_message_id_read_post) | **POST** /v1/threads/{threadID}/messages/{messageID}/read | Mark read/unread
+*Lockally::AgentsApi* | [**v1_threads_thread_id_reply_post**](docs/AgentsApi.md#v1_threads_thread_id_reply_post) | **POST** /v1/threads/{threadID}/reply | Reply in-thread (agent stream)
+*Lockally::AiApi* | [**v1_ai_config_get**](docs/AiApi.md#v1_ai_config_get) | **GET** /v1/ai-config | Read the tenant's AI configuration
+*Lockally::AiApi* | [**v1_ai_config_put**](docs/AiApi.md#v1_ai_config_put) | **PUT** /v1/ai-config | Configure the AI tier
+*Lockally::AiApi* | [**v1_billing_ai_units_checkout_post**](docs/AiApi.md#v1_billing_ai_units_checkout_post) | **POST** /v1/billing/ai-units/checkout | Buy prepaid AI units
+*Lockally::AiApi* | [**v1_threads_thread_id_classify_post**](docs/AiApi.md#v1_threads_thread_id_classify_post) | **POST** /v1/threads/{threadID}/classify | LLM-classify a thread
+*Lockally::AliasesApi* | [**v1_aliases_address_delete**](docs/AliasesApi.md#v1_aliases_address_delete) | **DELETE** /v1/aliases/{address} | Delete an alias
+*Lockally::AliasesApi* | [**v1_aliases_get**](docs/AliasesApi.md#v1_aliases_get) | **GET** /v1/aliases | List aliases
+*Lockally::AliasesApi* | [**v1_aliases_post**](docs/AliasesApi.md#v1_aliases_post) | **POST** /v1/aliases | Create an alias
+*Lockally::ApiKeysApi* | [**v1_api_keys_get**](docs/ApiKeysApi.md#v1_api_keys_get) | **GET** /v1/api-keys | List API keys
+*Lockally::ApiKeysApi* | [**v1_api_keys_id_delete**](docs/ApiKeysApi.md#v1_api_keys_id_delete) | **DELETE** /v1/api-keys/{id} | Revoke an API key
+*Lockally::ApiKeysApi* | [**v1_api_keys_post**](docs/ApiKeysApi.md#v1_api_keys_post) | **POST** /v1/api-keys | Create an API key
+*Lockally::BillingApi* | [**create_billing_checkout**](docs/BillingApi.md#create_billing_checkout) | **POST** /v1/billing/checkout | Create a plan checkout session
+*Lockally::BillingApi* | [**create_units_checkout**](docs/BillingApi.md#create_units_checkout) | **POST** /v1/billing/units/checkout | Create a send-units checkout session
+*Lockally::BillingApi* | [**get_billing**](docs/BillingApi.md#get_billing) | **GET** /v1/billing | Get billing status
+*Lockally::CalendarsApi* | [**add_calendar_member**](docs/CalendarsApi.md#add_calendar_member) | **POST** /v1/calendars/{id}/members | Add a member to a calendar
+*Lockally::CalendarsApi* | [**create_calendar**](docs/CalendarsApi.md#create_calendar) | **POST** /v1/calendars | Create a calendar
+*Lockally::CalendarsApi* | [**create_calendar_event**](docs/CalendarsApi.md#create_calendar_event) | **POST** /v1/calendars/{id}/events | Create an event in a calendar
+*Lockally::CalendarsApi* | [**create_calendar_integration**](docs/CalendarsApi.md#create_calendar_integration) | **POST** /v1/calendar-integrations | Create a calendar integration
+*Lockally::CalendarsApi* | [**delete_calendar**](docs/CalendarsApi.md#delete_calendar) | **DELETE** /v1/calendars/{id} | Delete a calendar
+*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_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
+*Lockally::CalendarsApi* | [**list_calendar_integrations**](docs/CalendarsApi.md#list_calendar_integrations) | **GET** /v1/calendar-integrations | List calendar integrations
+*Lockally::CalendarsApi* | [**list_calendar_members**](docs/CalendarsApi.md#list_calendar_members) | **GET** /v1/calendars/{id}/members | List calendar members
+*Lockally::CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /v1/calendars | List calendars
+*Lockally::CalendarsApi* | [**remove_calendar_member**](docs/CalendarsApi.md#remove_calendar_member) | **DELETE** /v1/calendars/{id}/members/{memberId} | Remove a member from a calendar
+*Lockally::CalendarsApi* | [**sync_calendar_integration**](docs/CalendarsApi.md#sync_calendar_integration) | **POST** /v1/calendar-integrations/{id}/sync | Trigger sync for a calendar integration
+*Lockally::CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **PATCH** /v1/calendars/{id} | Update a calendar
+*Lockally::CalendarsApi* | [**update_calendar_event**](docs/CalendarsApi.md#update_calendar_event) | **PATCH** /v1/calendars/{id}/events/{eventId} | Update a calendar event
+*Lockally::CalendarsApi* | [**update_calendar_integration**](docs/CalendarsApi.md#update_calendar_integration) | **PATCH** /v1/calendar-integrations/{id} | Update a calendar integration
+*Lockally::CalendarsApi* | [**update_calendar_member**](docs/CalendarsApi.md#update_calendar_member) | **PATCH** /v1/calendars/{id}/members/{memberId} | Update a calendar member's role
+*Lockally::CalendarsApi* | [**update_calendar_policies**](docs/CalendarsApi.md#update_calendar_policies) | **PATCH** /v1/calendar-policies | Update calendar policies
+*Lockally::ContactListsApi* | [**add_contact_list_member**](docs/ContactListsApi.md#add_contact_list_member) | **POST** /v1/contact-lists/{id}/members | Add a member to a contact list
+*Lockally::ContactListsApi* | [**create_contact_list**](docs/ContactListsApi.md#create_contact_list) | **POST** /v1/contact-lists | Create a contact list
+*Lockally::ContactListsApi* | [**delete_contact_list**](docs/ContactListsApi.md#delete_contact_list) | **DELETE** /v1/contact-lists/{id} | Delete a contact list
+*Lockally::ContactListsApi* | [**get_contact_list**](docs/ContactListsApi.md#get_contact_list) | **GET** /v1/contact-lists/{id} | Get a contact list with members
+*Lockally::ContactListsApi* | [**list_contact_lists**](docs/ContactListsApi.md#list_contact_lists) | **GET** /v1/contact-lists | List contact lists
+*Lockally::ContactListsApi* | [**remove_contact_list_member**](docs/ContactListsApi.md#remove_contact_list_member) | **DELETE** /v1/contact-lists/{id}/members/{contactId} | Remove a member from a contact list
+*Lockally::ContactListsApi* | [**update_contact_list**](docs/ContactListsApi.md#update_contact_list) | **PATCH** /v1/contact-lists/{id} | Update a contact list
+*Lockally::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /v1/contacts | Create a contact
+*Lockally::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /v1/contacts/{id} | Delete a contact
+*Lockally::ContactsApi* | [**get_contact**](docs/ContactsApi.md#get_contact) | **GET** /v1/contacts/{id} | Get a contact
+*Lockally::ContactsApi* | [**get_contact_lists**](docs/ContactsApi.md#get_contact_lists) | **GET** /v1/contacts/{id}/lists | Get lists a contact belongs to
+*Lockally::ContactsApi* | [**list_contacts**](docs/ContactsApi.md#list_contacts) | **GET** /v1/contacts | List contacts
+*Lockally::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PATCH** /v1/contacts/{id} | Update a contact
+*Lockally::DashboardApi* | [**get_audit_summary**](docs/DashboardApi.md#get_audit_summary) | **GET** /v1/audit-summary | Audit summary for the dashboard
+*Lockally::DashboardApi* | [**get_domains_status**](docs/DashboardApi.md#get_domains_status) | **GET** /v1/domains/status | Domain health status for the dashboard
+*Lockally::DashboardApi* | [**get_integrations_summary**](docs/DashboardApi.md#get_integrations_summary) | **GET** /v1/integrations-summary | Integrations summary for the dashboard
+*Lockally::DashboardApi* | [**get_security**](docs/DashboardApi.md#get_security) | **GET** /v1/security | Security overview for the dashboard
+*Lockally::DashboardApi* | [**get_storage**](docs/DashboardApi.md#get_storage) | **GET** /v1/storage | Storage usage for the dashboard
+*Lockally::DashboardApi* | [**get_tenant_health**](docs/DashboardApi.md#get_tenant_health) | **GET** /v1/health | Full tenant health report
+*Lockally::DashboardApi* | [**get_user_insights**](docs/DashboardApi.md#get_user_insights) | **GET** /v1/user-insights | User insights for the dashboard
+*Lockally::DirectoryApi* | [**get_directory_activity**](docs/DirectoryApi.md#get_directory_activity) | **GET** /v1/directory-activity | Get recent directory activity
+*Lockally::DirectoryApi* | [**get_directory_permissions**](docs/DirectoryApi.md#get_directory_permissions) | **GET** /v1/directory-permissions | Get directory permission settings
+*Lockally::DirectoryApi* | [**get_directory_stats**](docs/DirectoryApi.md#get_directory_stats) | **GET** /v1/directory-stats | Get directory statistics
+*Lockally::DirectoryApi* | [**get_gal_settings**](docs/DirectoryApi.md#get_gal_settings) | **GET** /v1/gal-settings | Get Global Address List settings
+*Lockally::DirectoryApi* | [**rebuild_gal_index**](docs/DirectoryApi.md#rebuild_gal_index) | **POST** /v1/gal-settings/rebuild-index | Rebuild the GAL search index
+*Lockally::DirectoryApi* | [**sync_gal**](docs/DirectoryApi.md#sync_gal) | **POST** /v1/gal-settings/sync | Sync GAL with external directory sources
+*Lockally::DirectoryApi* | [**update_directory_permissions**](docs/DirectoryApi.md#update_directory_permissions) | **PATCH** /v1/directory-permissions | Update directory permission settings
+*Lockally::DirectoryApi* | [**update_gal_settings**](docs/DirectoryApi.md#update_gal_settings) | **PATCH** /v1/gal-settings | Update GAL settings
+*Lockally::DistributionListsApi* | [**create_distribution_list**](docs/DistributionListsApi.md#create_distribution_list) | **POST** /v1/distribution-lists | Create a distribution list
+*Lockally::DistributionListsApi* | [**delete_distribution_list**](docs/DistributionListsApi.md#delete_distribution_list) | **DELETE** /v1/distribution-lists/{address} | Delete a distribution list
+*Lockally::DistributionListsApi* | [**get_distribution_list**](docs/DistributionListsApi.md#get_distribution_list) | **GET** /v1/distribution-lists/{address} | Get a distribution list
+*Lockally::DistributionListsApi* | [**list_distribution_lists**](docs/DistributionListsApi.md#list_distribution_lists) | **GET** /v1/distribution-lists | List distribution lists
+*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_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
+*Lockally::DraftsApi* | [**v1_drafts_draft_id_approve_post**](docs/DraftsApi.md#v1_drafts_draft_id_approve_post) | **POST** /v1/drafts/{draftID}/approve | Approve a pending draft (human)
+*Lockally::DraftsApi* | [**v1_drafts_draft_id_cancel_post**](docs/DraftsApi.md#v1_drafts_draft_id_cancel_post) | **POST** /v1/drafts/{draftID}/cancel | Withdraw a pending draft
+*Lockally::DraftsApi* | [**v1_drafts_draft_id_get**](docs/DraftsApi.md#v1_drafts_draft_id_get) | **GET** /v1/drafts/{draftID} | Get a draft
+*Lockally::DraftsApi* | [**v1_drafts_draft_id_reject_post**](docs/DraftsApi.md#v1_drafts_draft_id_reject_post) | **POST** /v1/drafts/{draftID}/reject | Reject a pending draft (human)
+*Lockally::DraftsApi* | [**v1_drafts_get**](docs/DraftsApi.md#v1_drafts_get) | **GET** /v1/drafts | List drafts
+*Lockally::DraftsApi* | [**v1_inboxes_mailbox_drafts_post**](docs/DraftsApi.md#v1_inboxes_mailbox_drafts_post) | **POST** /v1/inboxes/{mailbox}/drafts | Propose a new conversation as a draft
+*Lockally::DraftsApi* | [**v1_threads_thread_id_drafts_post**](docs/DraftsApi.md#v1_threads_thread_id_drafts_post) | **POST** /v1/threads/{threadID}/drafts | Propose a reply as a draft
+*Lockally::EncryptionApi* | [**batch_lookup_public_keys**](docs/EncryptionApi.md#batch_lookup_public_keys) | **GET** /v1/encryption/keys/lookup | Batch-lookup public keys by email
+*Lockally::EncryptionApi* | [**create_encryption_key**](docs/EncryptionApi.md#create_encryption_key) | **POST** /v1/encryption/keys | Upload an encryption key pair
+*Lockally::EncryptionApi* | [**create_encryption_recovery**](docs/EncryptionApi.md#create_encryption_recovery) | **POST** /v1/encryption/recovery | Store an encryption recovery blob
+*Lockally::EncryptionApi* | [**get_encryption_key**](docs/EncryptionApi.md#get_encryption_key) | **GET** /v1/encryption/keys/{email} | Get encryption key for a mailbox
+*Lockally::EncryptionApi* | [**rotate_encryption_key**](docs/EncryptionApi.md#rotate_encryption_key) | **POST** /v1/encryption/keys/rotate | Rotate an encryption key
+*Lockally::HealthApi* | [**healthz_get**](docs/HealthApi.md#healthz_get) | **GET** /healthz | Liveness check
+*Lockally::IpPoolsApi* | [**create_dedicated_ip_request**](docs/IpPoolsApi.md#create_dedicated_ip_request) | **POST** /v1/dedicated-ip-requests | Request a dedicated IP
+*Lockally::IpPoolsApi* | [**get_ip_assignment**](docs/IpPoolsApi.md#get_ip_assignment) | **GET** /v1/ip-assignment | Get current IP assignment
+*Lockally::IpPoolsApi* | [**list_dedicated_ip_requests**](docs/IpPoolsApi.md#list_dedicated_ip_requests) | **GET** /v1/dedicated-ip-requests | List dedicated IP requests
+*Lockally::MailboxesApi* | [**add_shared_member**](docs/MailboxesApi.md#add_shared_member) | **POST** /v1/mailboxes/{email}/members | Add a shared mailbox member
+*Lockally::MailboxesApi* | [**list_shared_members**](docs/MailboxesApi.md#list_shared_members) | **GET** /v1/mailboxes/{email}/members | List shared mailbox members
+*Lockally::MailboxesApi* | [**remove_shared_member**](docs/MailboxesApi.md#remove_shared_member) | **DELETE** /v1/mailboxes/{email}/members/{memberEmail} | Remove a shared mailbox member
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_delete**](docs/MailboxesApi.md#v1_mailboxes_email_delete) | **DELETE** /v1/mailboxes/{email} | Soft-delete a mailbox
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_export_download_get**](docs/MailboxesApi.md#v1_mailboxes_email_export_download_get) | **GET** /v1/mailboxes/{email}/export/download | Download a previously-issued mailbox export
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_export_post**](docs/MailboxesApi.md#v1_mailboxes_email_export_post) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_get**](docs/MailboxesApi.md#v1_mailboxes_email_get) | **GET** /v1/mailboxes/{email} | Get a mailbox
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_patch**](docs/MailboxesApi.md#v1_mailboxes_email_patch) | **PATCH** /v1/mailboxes/{email} | Update a mailbox
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_vacation_delete**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_delete) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_vacation_get**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_get) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder
+*Lockally::MailboxesApi* | [**v1_mailboxes_email_vacation_put**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_put) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder
+*Lockally::MailboxesApi* | [**v1_mailboxes_get**](docs/MailboxesApi.md#v1_mailboxes_get) | **GET** /v1/mailboxes | List mailboxes
+*Lockally::MailboxesApi* | [**v1_mailboxes_post**](docs/MailboxesApi.md#v1_mailboxes_post) | **POST** /v1/mailboxes | Create a mailbox
+*Lockally::MailboxesApi* | [**v1_vacation_get**](docs/MailboxesApi.md#v1_vacation_get) | **GET** /v1/vacation | List all vacation responders
+*Lockally::MigrationsApi* | [**cancel_migration**](docs/MigrationsApi.md#cancel_migration) | **POST** /v1/migrations/{id}/cancel | Cancel a running migration
+*Lockally::MigrationsApi* | [**check_migration_dns**](docs/MigrationsApi.md#check_migration_dns) | **GET** /v1/migrations/{id}/dns-check | Check DNS readiness for cutover
+*Lockally::MigrationsApi* | [**create_migration**](docs/MigrationsApi.md#create_migration) | **POST** /v1/migrations | Create a migration
+*Lockally::MigrationsApi* | [**create_migration_credential**](docs/MigrationsApi.md#create_migration_credential) | **POST** /v1/migrations/credentials | Store a migration credential
+*Lockally::MigrationsApi* | [**delete_migration**](docs/MigrationsApi.md#delete_migration) | **DELETE** /v1/migrations/{id} | Delete a migration
+*Lockally::MigrationsApi* | [**delete_migration_credential**](docs/MigrationsApi.md#delete_migration_credential) | **DELETE** /v1/migrations/credentials/{id} | Delete a migration credential
+*Lockally::MigrationsApi* | [**delta_sync_migration**](docs/MigrationsApi.md#delta_sync_migration) | **POST** /v1/migrations/{id}/delta-sync | Run a delta sync
+*Lockally::MigrationsApi* | [**discover_migration**](docs/MigrationsApi.md#discover_migration) | **POST** /v1/migrations/{id}/discover | Discover source mailboxes
+*Lockally::MigrationsApi* | [**final_sync_migration**](docs/MigrationsApi.md#final_sync_migration) | **POST** /v1/migrations/{id}/final-sync | Run the final sync before cutover
+*Lockally::MigrationsApi* | [**get_migration**](docs/MigrationsApi.md#get_migration) | **GET** /v1/migrations/{id} | Get a migration
+*Lockally::MigrationsApi* | [**get_migration_progress**](docs/MigrationsApi.md#get_migration_progress) | **GET** /v1/migrations/{id}/progress | Get migration progress
+*Lockally::MigrationsApi* | [**list_migration_credentials**](docs/MigrationsApi.md#list_migration_credentials) | **GET** /v1/migrations/credentials | List migration credentials
+*Lockally::MigrationsApi* | [**list_migration_events**](docs/MigrationsApi.md#list_migration_events) | **GET** /v1/migrations/{id}/events | List migration events
+*Lockally::MigrationsApi* | [**list_migration_mailboxes**](docs/MigrationsApi.md#list_migration_mailboxes) | **GET** /v1/migrations/{id}/mailboxes | List migration mailboxes
+*Lockally::MigrationsApi* | [**list_migrations**](docs/MigrationsApi.md#list_migrations) | **GET** /v1/migrations | List migrations
+*Lockally::MigrationsApi* | [**map_migration**](docs/MigrationsApi.md#map_migration) | **POST** /v1/migrations/{id}/map | Map source to destination mailboxes
+*Lockally::MigrationsApi* | [**retry_migration**](docs/MigrationsApi.md#retry_migration) | **POST** /v1/migrations/{id}/retry | Retry a failed or cancelled migration
+*Lockally::MigrationsApi* | [**start_migration**](docs/MigrationsApi.md#start_migration) | **POST** /v1/migrations/{id}/start | Start the migration
+*Lockally::MigrationsApi* | [**update_migration**](docs/MigrationsApi.md#update_migration) | **PATCH** /v1/migrations/{id} | Update a migration
+*Lockally::MigrationsApi* | [**update_migration_mailbox**](docs/MigrationsApi.md#update_migration_mailbox) | **PATCH** /v1/migrations/{id}/mailboxes/{mbxId} | Update a migration mailbox
+*Lockally::MigrationsApi* | [**validate_migration**](docs/MigrationsApi.md#validate_migration) | **POST** /v1/migrations/{id}/validate | Validate migrated data
+*Lockally::ResourcesApi* | [**create_resource**](docs/ResourcesApi.md#create_resource) | **POST** /v1/resources | Create a resource
+*Lockally::ResourcesApi* | [**delete_resource**](docs/ResourcesApi.md#delete_resource) | **DELETE** /v1/resources/{id} | Delete a resource
+*Lockally::ResourcesApi* | [**get_resource**](docs/ResourcesApi.md#get_resource) | **GET** /v1/resources/{id} | Get a resource
+*Lockally::ResourcesApi* | [**list_resources**](docs/ResourcesApi.md#list_resources) | **GET** /v1/resources | List resources
+*Lockally::ResourcesApi* | [**update_resource**](docs/ResourcesApi.md#update_resource) | **PATCH** /v1/resources/{id} | Update a resource
+*Lockally::SendApi* | [**v1_messages_get**](docs/SendApi.md#v1_messages_get) | **GET** /v1/messages | List outbound messages
+*Lockally::SendApi* | [**v1_messages_id_delete**](docs/SendApi.md#v1_messages_id_delete) | **DELETE** /v1/messages/{id} | Cancel a scheduled send
+*Lockally::SendApi* | [**v1_messages_id_get**](docs/SendApi.md#v1_messages_id_get) | **GET** /v1/messages/{id} | Get message status
+*Lockally::SendApi* | [**v1_messages_stats_get**](docs/SendApi.md#v1_messages_stats_get) | **GET** /v1/messages/stats | Aggregate delivery stats
+*Lockally::SendApi* | [**v1_send_batch_post**](docs/SendApi.md#v1_send_batch_post) | **POST** /v1/send/batch | Send a batch of emails
+*Lockally::SendApi* | [**v1_send_post**](docs/SendApi.md#v1_send_post) | **POST** /v1/send | Send an email
+*Lockally::SignupApi* | [**signup**](docs/SignupApi.md#signup) | **POST** /v1/signup | Sign up a new tenant
+*Lockally::SuppressionsApi* | [**v1_suppressions_email_delete**](docs/SuppressionsApi.md#v1_suppressions_email_delete) | **DELETE** /v1/suppressions/{email} | Remove a suppression
+*Lockally::SuppressionsApi* | [**v1_suppressions_email_get**](docs/SuppressionsApi.md#v1_suppressions_email_get) | **GET** /v1/suppressions/{email} | Check whether an address is suppressed
+*Lockally::SuppressionsApi* | [**v1_suppressions_get**](docs/SuppressionsApi.md#v1_suppressions_get) | **GET** /v1/suppressions | List suppressed recipients
+*Lockally::SuppressionsApi* | [**v1_suppressions_post**](docs/SuppressionsApi.md#v1_suppressions_post) | **POST** /v1/suppressions | Add a suppression
+*Lockally::TemplatesApi* | [**v1_templates_get**](docs/TemplatesApi.md#v1_templates_get) | **GET** /v1/templates | List templates
+*Lockally::TemplatesApi* | [**v1_templates_id_delete**](docs/TemplatesApi.md#v1_templates_id_delete) | **DELETE** /v1/templates/{id} | Delete a template
+*Lockally::TemplatesApi* | [**v1_templates_id_get**](docs/TemplatesApi.md#v1_templates_id_get) | **GET** /v1/templates/{id} | Get a template
+*Lockally::TemplatesApi* | [**v1_templates_id_put**](docs/TemplatesApi.md#v1_templates_id_put) | **PUT** /v1/templates/{id} | Update a template
+*Lockally::TemplatesApi* | [**v1_templates_post**](docs/TemplatesApi.md#v1_templates_post) | **POST** /v1/templates | Create a template
+*Lockally::TenantApi* | [**v1_tenant_get**](docs/TenantApi.md#v1_tenant_get) | **GET** /v1/tenant | Get the calling tenant
+*Lockally::TenantApi* | [**v1_usage_get**](docs/TenantApi.md#v1_usage_get) | **GET** /v1/usage | Usage snapshot
+*Lockally::TestApi* | [**v1_test_inbound_post**](docs/TestApi.md#v1_test_inbound_post) | **POST** /v1/test/inbound | Simulate an inbound email (test keys only)
+*Lockally::UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /v1/users | Create a user
+*Lockally::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /v1/users/{id} | Delete a user
+*Lockally::UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /v1/users/{id} | Get a user
+*Lockally::UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /v1/users | List users
+*Lockally::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /v1/users/{id} | Update a user
+*Lockally::WebhooksApi* | [**v1_webhooks_get**](docs/WebhooksApi.md#v1_webhooks_get) | **GET** /v1/webhooks | List webhooks
+*Lockally::WebhooksApi* | [**v1_webhooks_id_delete**](docs/WebhooksApi.md#v1_webhooks_id_delete) | **DELETE** /v1/webhooks/{id} | Delete a webhook
+*Lockally::WebhooksApi* | [**v1_webhooks_id_patch**](docs/WebhooksApi.md#v1_webhooks_id_patch) | **PATCH** /v1/webhooks/{id} | Update a webhook
+*Lockally::WebhooksApi* | [**v1_webhooks_post**](docs/WebhooksApi.md#v1_webhooks_post) | **POST** /v1/webhooks | Create a webhook
+
+
+## Documentation for Models
+
+ - [Lockally::APIKey](docs/APIKey.md)
+ - [Lockally::ActivateAddOn200Response](docs/ActivateAddOn200Response.md)
+ - [Lockally::AddCalendarMemberRequest](docs/AddCalendarMemberRequest.md)
+ - [Lockally::AddContactListMemberRequest](docs/AddContactListMemberRequest.md)
+ - [Lockally::AddOn](docs/AddOn.md)
+ - [Lockally::AddSharedMemberRequest](docs/AddSharedMemberRequest.md)
+ - [Lockally::Admin](docs/Admin.md)
+ - [Lockally::AdminFull](docs/AdminFull.md)
+ - [Lockally::AuditEvent](docs/AuditEvent.md)
+ - [Lockally::BatchLookupPublicKeys200Response](docs/BatchLookupPublicKeys200Response.md)
+ - [Lockally::BatchLookupPublicKeys200ResponseDataInner](docs/BatchLookupPublicKeys200ResponseDataInner.md)
+ - [Lockally::BatchResult](docs/BatchResult.md)
+ - [Lockally::BillingStatus](docs/BillingStatus.md)
+ - [Lockally::Calendar](docs/Calendar.md)
+ - [Lockally::CalendarEvent](docs/CalendarEvent.md)
+ - [Lockally::CalendarIntegration](docs/CalendarIntegration.md)
+ - [Lockally::CalendarMember](docs/CalendarMember.md)
+ - [Lockally::CalendarPolicies](docs/CalendarPolicies.md)
+ - [Lockally::Contact](docs/Contact.md)
+ - [Lockally::ContactList](docs/ContactList.md)
+ - [Lockally::CreateBillingCheckout200Response](docs/CreateBillingCheckout200Response.md)
+ - [Lockally::CreateBillingCheckoutRequest](docs/CreateBillingCheckoutRequest.md)
+ - [Lockally::CreateCalendarEventRequest](docs/CreateCalendarEventRequest.md)
+ - [Lockally::CreateCalendarIntegrationRequest](docs/CreateCalendarIntegrationRequest.md)
+ - [Lockally::CreateCalendarRequest](docs/CreateCalendarRequest.md)
+ - [Lockally::CreateContactListRequest](docs/CreateContactListRequest.md)
+ - [Lockally::CreateContactRequest](docs/CreateContactRequest.md)
+ - [Lockally::CreateDedicatedIPRequestRequest](docs/CreateDedicatedIPRequestRequest.md)
+ - [Lockally::CreateDistributionListRequest](docs/CreateDistributionListRequest.md)
+ - [Lockally::CreateEncryptionKey201Response](docs/CreateEncryptionKey201Response.md)
+ - [Lockally::CreateEncryptionKeyRequest](docs/CreateEncryptionKeyRequest.md)
+ - [Lockally::CreateEncryptionRecoveryRequest](docs/CreateEncryptionRecoveryRequest.md)
+ - [Lockally::CreateMigrationCredentialRequest](docs/CreateMigrationCredentialRequest.md)
+ - [Lockally::CreateMigrationCredentialRequestCredentials](docs/CreateMigrationCredentialRequestCredentials.md)
+ - [Lockally::CreateMigrationRequest](docs/CreateMigrationRequest.md)
+ - [Lockally::CreateResourceRequest](docs/CreateResourceRequest.md)
+ - [Lockally::CreateUnitsCheckout200Response](docs/CreateUnitsCheckout200Response.md)
+ - [Lockally::CreateUnitsCheckoutRequest](docs/CreateUnitsCheckoutRequest.md)
+ - [Lockally::CreateUserRequest](docs/CreateUserRequest.md)
+ - [Lockally::DNSRecord](docs/DNSRecord.md)
+ - [Lockally::DedicatedIPRequest](docs/DedicatedIPRequest.md)
+ - [Lockally::DirectoryPermissions](docs/DirectoryPermissions.md)
+ - [Lockally::DiscoverMigration202Response](docs/DiscoverMigration202Response.md)
+ - [Lockally::DistributionListDetail](docs/DistributionListDetail.md)
+ - [Lockally::DistributionListSummary](docs/DistributionListSummary.md)
+ - [Lockally::Domain](docs/Domain.md)
+ - [Lockally::GALSettings](docs/GALSettings.md)
+ - [Lockally::GetAddOnStatus200Response](docs/GetAddOnStatus200Response.md)
+ - [Lockally::GetAuditSummary200Response](docs/GetAuditSummary200Response.md)
+ - [Lockally::GetCalendarSecurity200Response](docs/GetCalendarSecurity200Response.md)
+ - [Lockally::GetCalendarSecurity200ResponseAlertsInner](docs/GetCalendarSecurity200ResponseAlertsInner.md)
+ - [Lockally::GetCalendarSecurity200ResponseDelegatedAccessInner](docs/GetCalendarSecurity200ResponseDelegatedAccessInner.md)
+ - [Lockally::GetCalendarSecurity200ResponseExternalSharing](docs/GetCalendarSecurity200ResponseExternalSharing.md)
+ - [Lockally::GetCalendarSecurity200ResponsePublicCalendarListInner](docs/GetCalendarSecurity200ResponsePublicCalendarListInner.md)
+ - [Lockally::GetContactList200Response](docs/GetContactList200Response.md)
+ - [Lockally::GetContactList200ResponseMembersInner](docs/GetContactList200ResponseMembersInner.md)
+ - [Lockally::GetContactLists200Response](docs/GetContactLists200Response.md)
+ - [Lockally::GetContactLists200ResponseDataInner](docs/GetContactLists200ResponseDataInner.md)
+ - [Lockally::GetDirectoryActivity200Response](docs/GetDirectoryActivity200Response.md)
+ - [Lockally::GetDirectoryActivity200ResponseDataInner](docs/GetDirectoryActivity200ResponseDataInner.md)
+ - [Lockally::GetDirectoryStats200Response](docs/GetDirectoryStats200Response.md)
+ - [Lockally::GetDomainsStatus200Response](docs/GetDomainsStatus200Response.md)
+ - [Lockally::GetDomainsStatus200ResponseDomainsInner](docs/GetDomainsStatus200ResponseDomainsInner.md)
+ - [Lockally::GetDomainsStatus200ResponseDomainsInnerChecksInner](docs/GetDomainsStatus200ResponseDomainsInnerChecksInner.md)
+ - [Lockally::GetEncryptionKey200Response](docs/GetEncryptionKey200Response.md)
+ - [Lockally::GetIPAssignment200Response](docs/GetIPAssignment200Response.md)
+ - [Lockally::GetIntegrationsSummary200Response](docs/GetIntegrationsSummary200Response.md)
+ - [Lockally::GetIntegrationsSummary200ResponseApiKeysInner](docs/GetIntegrationsSummary200ResponseApiKeysInner.md)
+ - [Lockally::GetIntegrationsSummary200ResponseWebhooksInner](docs/GetIntegrationsSummary200ResponseWebhooksInner.md)
+ - [Lockally::GetSecurity200Response](docs/GetSecurity200Response.md)
+ - [Lockally::GetSecurity200ResponseAlertsInner](docs/GetSecurity200ResponseAlertsInner.md)
+ - [Lockally::GetSecurity200ResponseStatsInner](docs/GetSecurity200ResponseStatsInner.md)
+ - [Lockally::GetStorage200Response](docs/GetStorage200Response.md)
+ - [Lockally::GetStorage200ResponseTopMailboxesInner](docs/GetStorage200ResponseTopMailboxesInner.md)
+ - [Lockally::GetStorage200ResponseTopMessagesInner](docs/GetStorage200ResponseTopMessagesInner.md)
+ - [Lockally::GetUserInsights200Response](docs/GetUserInsights200Response.md)
+ - [Lockally::HealthzGet200Response](docs/HealthzGet200Response.md)
+ - [Lockally::ListAddOns200Response](docs/ListAddOns200Response.md)
+ - [Lockally::ListCalendarEvents200Response](docs/ListCalendarEvents200Response.md)
+ - [Lockally::ListCalendarIntegrations200Response](docs/ListCalendarIntegrations200Response.md)
+ - [Lockally::ListCalendarMembers200Response](docs/ListCalendarMembers200Response.md)
+ - [Lockally::ListCalendars200Response](docs/ListCalendars200Response.md)
+ - [Lockally::ListContactLists200Response](docs/ListContactLists200Response.md)
+ - [Lockally::ListContacts200Response](docs/ListContacts200Response.md)
+ - [Lockally::ListDedicatedIPRequests200Response](docs/ListDedicatedIPRequests200Response.md)
+ - [Lockally::ListDistributionLists200Response](docs/ListDistributionLists200Response.md)
+ - [Lockally::ListMigrationCredentials200Response](docs/ListMigrationCredentials200Response.md)
+ - [Lockally::ListMigrationEvents200Response](docs/ListMigrationEvents200Response.md)
+ - [Lockally::ListMigrationMailboxes200Response](docs/ListMigrationMailboxes200Response.md)
+ - [Lockally::ListMigrations200Response](docs/ListMigrations200Response.md)
+ - [Lockally::ListResources200Response](docs/ListResources200Response.md)
+ - [Lockally::ListSharedMembers200Response](docs/ListSharedMembers200Response.md)
+ - [Lockally::ListUsers200Response](docs/ListUsers200Response.md)
+ - [Lockally::Mailbox](docs/Mailbox.md)
+ - [Lockally::MapMigrationRequest](docs/MapMigrationRequest.md)
+ - [Lockally::MapMigrationRequestMappingsInner](docs/MapMigrationRequestMappingsInner.md)
+ - [Lockally::Message](docs/Message.md)
+ - [Lockally::MessageStats](docs/MessageStats.md)
+ - [Lockally::MessageStatsCounts](docs/MessageStatsCounts.md)
+ - [Lockally::MessageStatsRates](docs/MessageStatsRates.md)
+ - [Lockally::MessageStatsWindow](docs/MessageStatsWindow.md)
+ - [Lockally::Migration](docs/Migration.md)
+ - [Lockally::MigrationCredential](docs/MigrationCredential.md)
+ - [Lockally::MigrationEvent](docs/MigrationEvent.md)
+ - [Lockally::MigrationMailbox](docs/MigrationMailbox.md)
+ - [Lockally::MigrationProgress](docs/MigrationProgress.md)
+ - [Lockally::MigrationProgressMailboxesInner](docs/MigrationProgressMailboxesInner.md)
+ - [Lockally::MigrationSettings](docs/MigrationSettings.md)
+ - [Lockally::ModelAlias](docs/ModelAlias.md)
+ - [Lockally::PlanCatalogEntry](docs/PlanCatalogEntry.md)
+ - [Lockally::Problem](docs/Problem.md)
+ - [Lockally::ReplaceDistributionListMembers200Response](docs/ReplaceDistributionListMembers200Response.md)
+ - [Lockally::ReplaceDistributionListMembersRequest](docs/ReplaceDistributionListMembersRequest.md)
+ - [Lockally::Resource](docs/Resource.md)
+ - [Lockally::RotateEncryptionKeyRequest](docs/RotateEncryptionKeyRequest.md)
+ - [Lockally::SendMessage](docs/SendMessage.md)
+ - [Lockally::SharedMember](docs/SharedMember.md)
+ - [Lockally::SignupRequest](docs/SignupRequest.md)
+ - [Lockally::StartMigration202Response](docs/StartMigration202Response.md)
+ - [Lockally::Suppression](docs/Suppression.md)
+ - [Lockally::Template](docs/Template.md)
+ - [Lockally::TemplateInput](docs/TemplateInput.md)
+ - [Lockally::Tenant](docs/Tenant.md)
+ - [Lockally::UnitBundle](docs/UnitBundle.md)
+ - [Lockally::UpdateCalendarEventRequest](docs/UpdateCalendarEventRequest.md)
+ - [Lockally::UpdateCalendarIntegrationRequest](docs/UpdateCalendarIntegrationRequest.md)
+ - [Lockally::UpdateCalendarMemberRequest](docs/UpdateCalendarMemberRequest.md)
+ - [Lockally::UpdateCalendarPoliciesRequest](docs/UpdateCalendarPoliciesRequest.md)
+ - [Lockally::UpdateCalendarRequest](docs/UpdateCalendarRequest.md)
+ - [Lockally::UpdateContactListRequest](docs/UpdateContactListRequest.md)
+ - [Lockally::UpdateContactRequest](docs/UpdateContactRequest.md)
+ - [Lockally::UpdateDirectoryPermissionsRequest](docs/UpdateDirectoryPermissionsRequest.md)
+ - [Lockally::UpdateGALSettingsRequest](docs/UpdateGALSettingsRequest.md)
+ - [Lockally::UpdateMigrationMailboxRequest](docs/UpdateMigrationMailboxRequest.md)
+ - [Lockally::UpdateMigrationRequest](docs/UpdateMigrationRequest.md)
+ - [Lockally::UpdateResourceRequest](docs/UpdateResourceRequest.md)
+ - [Lockally::UpdateUserRequest](docs/UpdateUserRequest.md)
+ - [Lockally::User](docs/User.md)
+ - [Lockally::UserEvent](docs/UserEvent.md)
+ - [Lockally::V1AdminLoginPost200Response](docs/V1AdminLoginPost200Response.md)
+ - [Lockally::V1AdminLoginPostRequest](docs/V1AdminLoginPostRequest.md)
+ - [Lockally::V1AdminMeGet200Response](docs/V1AdminMeGet200Response.md)
+ - [Lockally::V1AdminsGet200Response](docs/V1AdminsGet200Response.md)
+ - [Lockally::V1AdminsIdPatchRequest](docs/V1AdminsIdPatchRequest.md)
+ - [Lockally::V1AdminsPostRequest](docs/V1AdminsPostRequest.md)
+ - [Lockally::V1AliasesGet200Response](docs/V1AliasesGet200Response.md)
+ - [Lockally::V1AliasesPostRequest](docs/V1AliasesPostRequest.md)
+ - [Lockally::V1ApiKeysGet200Response](docs/V1ApiKeysGet200Response.md)
+ - [Lockally::V1ApiKeysPost201Response](docs/V1ApiKeysPost201Response.md)
+ - [Lockally::V1ApiKeysPostRequest](docs/V1ApiKeysPostRequest.md)
+ - [Lockally::V1DomainsGet200Response](docs/V1DomainsGet200Response.md)
+ - [Lockally::V1DomainsPostRequest](docs/V1DomainsPostRequest.md)
+ - [Lockally::V1InboxesMailboxMessagesPostRequest](docs/V1InboxesMailboxMessagesPostRequest.md)
+ - [Lockally::V1MailboxesEmailExportPost201Response](docs/V1MailboxesEmailExportPost201Response.md)
+ - [Lockally::V1MailboxesEmailPatchRequest](docs/V1MailboxesEmailPatchRequest.md)
+ - [Lockally::V1MailboxesEmailVacationPutRequest](docs/V1MailboxesEmailVacationPutRequest.md)
+ - [Lockally::V1MailboxesGet200Response](docs/V1MailboxesGet200Response.md)
+ - [Lockally::V1MailboxesPostRequest](docs/V1MailboxesPostRequest.md)
+ - [Lockally::V1MessagesGet200Response](docs/V1MessagesGet200Response.md)
+ - [Lockally::V1SendBatchPost200Response](docs/V1SendBatchPost200Response.md)
+ - [Lockally::V1SendBatchPostRequest](docs/V1SendBatchPostRequest.md)
+ - [Lockally::V1SendPost202Response](docs/V1SendPost202Response.md)
+ - [Lockally::V1SendPostRequest](docs/V1SendPostRequest.md)
+ - [Lockally::V1SendPostRequestAttachmentsInner](docs/V1SendPostRequestAttachmentsInner.md)
+ - [Lockally::V1SuppressionsGet200Response](docs/V1SuppressionsGet200Response.md)
+ - [Lockally::V1SuppressionsPostRequest](docs/V1SuppressionsPostRequest.md)
+ - [Lockally::V1TemplatesGet200Response](docs/V1TemplatesGet200Response.md)
+ - [Lockally::V1UsageGet200Response](docs/V1UsageGet200Response.md)
+ - [Lockally::V1VacationGet200Response](docs/V1VacationGet200Response.md)
+ - [Lockally::V1WebhooksGet200Response](docs/V1WebhooksGet200Response.md)
+ - [Lockally::V1WebhooksIdPatchRequest](docs/V1WebhooksIdPatchRequest.md)
+ - [Lockally::V1WebhooksPostRequest](docs/V1WebhooksPostRequest.md)
+ - [Lockally::VacationParams](docs/VacationParams.md)
+ - [Lockally::VacationResponder](docs/VacationResponder.md)
+ - [Lockally::Webhook](docs/Webhook.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearerAuth
+
+- **Type**: Bearer authentication (lk_live_<prefix>_<secret>)
+
+### oauth2
+
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://api.lockally.com/oauth/authorize
+- **Scopes**: 
+  - inboxes:read: Read agent-accessible mailboxes and threads
+  - inboxes:write: Send and act on agent-accessible mailboxes
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/APIKey.md

@@ -0,0 +1,32 @@
+# Lockally::APIKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **prefix** | **String** | 8-char public prefix; safe to store and display. |  |
+| **scopes** | **Array<String>** |  |  |
+| **label** | **String** |  |  |
+| **last_used_at** | **Time** |  | [optional] |
+| **revoked_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::APIKey.new(
+  id: null,
+  tenant_id: null,
+  prefix: fbl73bhj,
+  scopes: null,
+  label: ci-pipeline,
+  last_used_at: null,
+  revoked_at: null,
+  created_at: null
+)
+```
+

data/docs/ActivateAddOn200Response.md

@@ -0,0 +1,24 @@
+# Lockally::ActivateAddOn200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **add_on** | **String** |  |  |
+| **status** | **String** |  |  |
+| **message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ActivateAddOn200Response.new(
+  id: null,
+  add_on: null,
+  status: null,
+  message: null
+)
+```
+

data/docs/AddCalendarMemberRequest.md

@@ -0,0 +1,20 @@
+# Lockally::AddCalendarMemberRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_email** | **String** |  |  |
+| **role** | **String** |  | [optional][default to 'viewer'] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::AddCalendarMemberRequest.new(
+  user_email: null,
+  role: null
+)
+```
+