Metadata-Version: 2.4
Name: lockally
Version: 0.1.0
Summary: lockally control plane
Home-page: 
Author: lockally support
Author-email: lockally support <support@lockally.com>
License: AGPL-3.0-only OR LicenseRef-LOC-Commercial
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,lockally control plane
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: license-file

# lockally
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 Python package 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.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import lockally
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import lockally
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import lockally
from lockally.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.lockally.com
# See configuration.py for a list of all supported configuration parameters.
configuration = lockally.Configuration(
    host = "https://api.lockally.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
configuration = lockally.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with lockally.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lockally.AddOnsApi(api_client)
    name = 'name_example' # str | Add-on key

    try:
        # Activate an add-on
        api_response = api_instance.activate_add_on(name)
        print("The response of AddOnsApi->activate_add_on:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddOnsApi->activate_add_on: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.lockally.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AddOnsApi* | [**activate_add_on**](docs/AddOnsApi.md#activate_add_on) | **POST** /v1/add-ons/{name}/activate | Activate an add-on
*AddOnsApi* | [**cancel_add_on**](docs/AddOnsApi.md#cancel_add_on) | **POST** /v1/add-ons/{name}/cancel | Cancel an add-on
*AddOnsApi* | [**get_add_on_status**](docs/AddOnsApi.md#get_add_on_status) | **GET** /v1/add-ons/{name} | Get add-on status
*AddOnsApi* | [**list_add_ons**](docs/AddOnsApi.md#list_add_ons) | **GET** /v1/add-ons | List add-ons
*AdminApi* | [**v1_admin_login_post**](docs/AdminApi.md#v1_admin_login_post) | **POST** /v1/admin/login | Tenant-admin email+password login
*AdminApi* | [**v1_admin_logout_post**](docs/AdminApi.md#v1_admin_logout_post) | **POST** /v1/admin/logout | Invalidate the current admin session
*AdminApi* | [**v1_admin_me_get**](docs/AdminApi.md#v1_admin_me_get) | **GET** /v1/admin/me | Get the current admin + tenant
*AdminsApi* | [**v1_admins_get**](docs/AdminsApi.md#v1_admins_get) | **GET** /v1/admins | List tenant admins
*AdminsApi* | [**v1_admins_id_delete**](docs/AdminsApi.md#v1_admins_id_delete) | **DELETE** /v1/admins/{id} | Delete an admin
*AdminsApi* | [**v1_admins_id_patch**](docs/AdminsApi.md#v1_admins_id_patch) | **PATCH** /v1/admins/{id} | Update an admin
*AdminsApi* | [**v1_admins_post**](docs/AdminsApi.md#v1_admins_post) | **POST** /v1/admins | Invite a new admin
*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&#39;s mailbox grants
*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
*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
*AgentsApi* | [**v1_auth_whoami_get**](docs/AgentsApi.md#v1_auth_whoami_get) | **GET** /v1/auth/whoami | Introspect the calling credentials
*AgentsApi* | [**v1_contacts_lookup_get**](docs/AgentsApi.md#v1_contacts_lookup_get) | **GET** /v1/contacts/lookup | Who is this sender?
*AgentsApi* | [**v1_inboxes_get**](docs/AgentsApi.md#v1_inboxes_get) | **GET** /v1/inboxes | List granted inboxes
*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)
*AgentsApi* | [**v1_inboxes_mailbox_threads_get**](docs/AgentsApi.md#v1_inboxes_mailbox_threads_get) | **GET** /v1/inboxes/{mailbox}/threads | List conversation threads
*AgentsApi* | [**v1_threads_thread_id_get**](docs/AgentsApi.md#v1_threads_thread_id_get) | **GET** /v1/threads/{threadID} | Get a whole conversation
*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
*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
*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
*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)
*AiApi* | [**v1_ai_config_get**](docs/AiApi.md#v1_ai_config_get) | **GET** /v1/ai-config | Read the tenant&#39;s AI configuration
*AiApi* | [**v1_ai_config_put**](docs/AiApi.md#v1_ai_config_put) | **PUT** /v1/ai-config | Configure the AI tier
*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
*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
*AliasesApi* | [**v1_aliases_address_delete**](docs/AliasesApi.md#v1_aliases_address_delete) | **DELETE** /v1/aliases/{address} | Delete an alias
*AliasesApi* | [**v1_aliases_get**](docs/AliasesApi.md#v1_aliases_get) | **GET** /v1/aliases | List aliases
*AliasesApi* | [**v1_aliases_post**](docs/AliasesApi.md#v1_aliases_post) | **POST** /v1/aliases | Create an alias
*ApiKeysApi* | [**v1_api_keys_get**](docs/ApiKeysApi.md#v1_api_keys_get) | **GET** /v1/api-keys | List API keys
*ApiKeysApi* | [**v1_api_keys_id_delete**](docs/ApiKeysApi.md#v1_api_keys_id_delete) | **DELETE** /v1/api-keys/{id} | Revoke an API key
*ApiKeysApi* | [**v1_api_keys_post**](docs/ApiKeysApi.md#v1_api_keys_post) | **POST** /v1/api-keys | Create an API key
*BillingApi* | [**create_billing_checkout**](docs/BillingApi.md#create_billing_checkout) | **POST** /v1/billing/checkout | Create a plan checkout session
*BillingApi* | [**create_units_checkout**](docs/BillingApi.md#create_units_checkout) | **POST** /v1/billing/units/checkout | Create a send-units checkout session
*BillingApi* | [**get_billing**](docs/BillingApi.md#get_billing) | **GET** /v1/billing | Get billing status
*CalendarsApi* | [**add_calendar_member**](docs/CalendarsApi.md#add_calendar_member) | **POST** /v1/calendars/{id}/members | Add a member to a calendar
*CalendarsApi* | [**create_calendar**](docs/CalendarsApi.md#create_calendar) | **POST** /v1/calendars | Create a calendar
*CalendarsApi* | [**create_calendar_event**](docs/CalendarsApi.md#create_calendar_event) | **POST** /v1/calendars/{id}/events | Create an event in a calendar
*CalendarsApi* | [**create_calendar_integration**](docs/CalendarsApi.md#create_calendar_integration) | **POST** /v1/calendar-integrations | Create a calendar integration
*CalendarsApi* | [**delete_calendar**](docs/CalendarsApi.md#delete_calendar) | **DELETE** /v1/calendars/{id} | Delete a calendar
*CalendarsApi* | [**delete_calendar_event**](docs/CalendarsApi.md#delete_calendar_event) | **DELETE** /v1/calendars/{id}/events/{eventId} | Delete a calendar event
*CalendarsApi* | [**delete_calendar_integration**](docs/CalendarsApi.md#delete_calendar_integration) | **DELETE** /v1/calendar-integrations/{id} | Delete a calendar integration
*CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /v1/calendars/{id} | Get a calendar
*CalendarsApi* | [**get_calendar_policies**](docs/CalendarsApi.md#get_calendar_policies) | **GET** /v1/calendar-policies | Get calendar policies
*CalendarsApi* | [**get_calendar_security**](docs/CalendarsApi.md#get_calendar_security) | **GET** /v1/calendar-security | Get calendar security overview
*CalendarsApi* | [**list_calendar_events**](docs/CalendarsApi.md#list_calendar_events) | **GET** /v1/calendars/{id}/events | List events in a calendar
*CalendarsApi* | [**list_calendar_integrations**](docs/CalendarsApi.md#list_calendar_integrations) | **GET** /v1/calendar-integrations | List calendar integrations
*CalendarsApi* | [**list_calendar_members**](docs/CalendarsApi.md#list_calendar_members) | **GET** /v1/calendars/{id}/members | List calendar members
*CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /v1/calendars | List calendars
*CalendarsApi* | [**remove_calendar_member**](docs/CalendarsApi.md#remove_calendar_member) | **DELETE** /v1/calendars/{id}/members/{memberId} | Remove a member from a calendar
*CalendarsApi* | [**sync_calendar_integration**](docs/CalendarsApi.md#sync_calendar_integration) | **POST** /v1/calendar-integrations/{id}/sync | Trigger sync for a calendar integration
*CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **PATCH** /v1/calendars/{id} | Update a calendar
*CalendarsApi* | [**update_calendar_event**](docs/CalendarsApi.md#update_calendar_event) | **PATCH** /v1/calendars/{id}/events/{eventId} | Update a calendar event
*CalendarsApi* | [**update_calendar_integration**](docs/CalendarsApi.md#update_calendar_integration) | **PATCH** /v1/calendar-integrations/{id} | Update a calendar integration
*CalendarsApi* | [**update_calendar_member**](docs/CalendarsApi.md#update_calendar_member) | **PATCH** /v1/calendars/{id}/members/{memberId} | Update a calendar member&#39;s role
*CalendarsApi* | [**update_calendar_policies**](docs/CalendarsApi.md#update_calendar_policies) | **PATCH** /v1/calendar-policies | Update calendar policies
*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
*ContactListsApi* | [**create_contact_list**](docs/ContactListsApi.md#create_contact_list) | **POST** /v1/contact-lists | Create a contact list
*ContactListsApi* | [**delete_contact_list**](docs/ContactListsApi.md#delete_contact_list) | **DELETE** /v1/contact-lists/{id} | Delete a contact list
*ContactListsApi* | [**get_contact_list**](docs/ContactListsApi.md#get_contact_list) | **GET** /v1/contact-lists/{id} | Get a contact list with members
*ContactListsApi* | [**list_contact_lists**](docs/ContactListsApi.md#list_contact_lists) | **GET** /v1/contact-lists | List contact lists
*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
*ContactListsApi* | [**update_contact_list**](docs/ContactListsApi.md#update_contact_list) | **PATCH** /v1/contact-lists/{id} | Update a contact list
*ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /v1/contacts | Create a contact
*ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /v1/contacts/{id} | Delete a contact
*ContactsApi* | [**get_contact**](docs/ContactsApi.md#get_contact) | **GET** /v1/contacts/{id} | Get a contact
*ContactsApi* | [**get_contact_lists**](docs/ContactsApi.md#get_contact_lists) | **GET** /v1/contacts/{id}/lists | Get lists a contact belongs to
*ContactsApi* | [**list_contacts**](docs/ContactsApi.md#list_contacts) | **GET** /v1/contacts | List contacts
*ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PATCH** /v1/contacts/{id} | Update a contact
*DashboardApi* | [**get_audit_summary**](docs/DashboardApi.md#get_audit_summary) | **GET** /v1/audit-summary | Audit summary for the dashboard
*DashboardApi* | [**get_domains_status**](docs/DashboardApi.md#get_domains_status) | **GET** /v1/domains/status | Domain health status for the dashboard
*DashboardApi* | [**get_integrations_summary**](docs/DashboardApi.md#get_integrations_summary) | **GET** /v1/integrations-summary | Integrations summary for the dashboard
*DashboardApi* | [**get_security**](docs/DashboardApi.md#get_security) | **GET** /v1/security | Security overview for the dashboard
*DashboardApi* | [**get_storage**](docs/DashboardApi.md#get_storage) | **GET** /v1/storage | Storage usage for the dashboard
*DashboardApi* | [**get_tenant_health**](docs/DashboardApi.md#get_tenant_health) | **GET** /v1/health | Full tenant health report
*DashboardApi* | [**get_user_insights**](docs/DashboardApi.md#get_user_insights) | **GET** /v1/user-insights | User insights for the dashboard
*DirectoryApi* | [**get_directory_activity**](docs/DirectoryApi.md#get_directory_activity) | **GET** /v1/directory-activity | Get recent directory activity
*DirectoryApi* | [**get_directory_permissions**](docs/DirectoryApi.md#get_directory_permissions) | **GET** /v1/directory-permissions | Get directory permission settings
*DirectoryApi* | [**get_directory_stats**](docs/DirectoryApi.md#get_directory_stats) | **GET** /v1/directory-stats | Get directory statistics
*DirectoryApi* | [**get_gal_settings**](docs/DirectoryApi.md#get_gal_settings) | **GET** /v1/gal-settings | Get Global Address List settings
*DirectoryApi* | [**rebuild_gal_index**](docs/DirectoryApi.md#rebuild_gal_index) | **POST** /v1/gal-settings/rebuild-index | Rebuild the GAL search index
*DirectoryApi* | [**sync_gal**](docs/DirectoryApi.md#sync_gal) | **POST** /v1/gal-settings/sync | Sync GAL with external directory sources
*DirectoryApi* | [**update_directory_permissions**](docs/DirectoryApi.md#update_directory_permissions) | **PATCH** /v1/directory-permissions | Update directory permission settings
*DirectoryApi* | [**update_gal_settings**](docs/DirectoryApi.md#update_gal_settings) | **PATCH** /v1/gal-settings | Update GAL settings
*DistributionListsApi* | [**create_distribution_list**](docs/DistributionListsApi.md#create_distribution_list) | **POST** /v1/distribution-lists | Create a distribution list
*DistributionListsApi* | [**delete_distribution_list**](docs/DistributionListsApi.md#delete_distribution_list) | **DELETE** /v1/distribution-lists/{address} | Delete a distribution list
*DistributionListsApi* | [**get_distribution_list**](docs/DistributionListsApi.md#get_distribution_list) | **GET** /v1/distribution-lists/{address} | Get a distribution list
*DistributionListsApi* | [**list_distribution_lists**](docs/DistributionListsApi.md#list_distribution_lists) | **GET** /v1/distribution-lists | List distribution lists
*DistributionListsApi* | [**replace_distribution_list_members**](docs/DistributionListsApi.md#replace_distribution_list_members) | **PUT** /v1/distribution-lists/{address}/members | Replace distribution list members
*DomainsApi* | [**v1_domains_domain_delete**](docs/DomainsApi.md#v1_domains_domain_delete) | **DELETE** /v1/domains/{domain} | Delete a domain
*DomainsApi* | [**v1_domains_domain_get**](docs/DomainsApi.md#v1_domains_domain_get) | **GET** /v1/domains/{domain} | Get a domain
*DomainsApi* | [**v1_domains_domain_verify_post**](docs/DomainsApi.md#v1_domains_domain_verify_post) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification
*DomainsApi* | [**v1_domains_get**](docs/DomainsApi.md#v1_domains_get) | **GET** /v1/domains | List domains
*DomainsApi* | [**v1_domains_post**](docs/DomainsApi.md#v1_domains_post) | **POST** /v1/domains | Register a domain
*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)
*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
*DraftsApi* | [**v1_drafts_draft_id_get**](docs/DraftsApi.md#v1_drafts_draft_id_get) | **GET** /v1/drafts/{draftID} | Get a draft
*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)
*DraftsApi* | [**v1_drafts_get**](docs/DraftsApi.md#v1_drafts_get) | **GET** /v1/drafts | List drafts
*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
*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
*EncryptionApi* | [**batch_lookup_public_keys**](docs/EncryptionApi.md#batch_lookup_public_keys) | **GET** /v1/encryption/keys/lookup | Batch-lookup public keys by email
*EncryptionApi* | [**create_encryption_key**](docs/EncryptionApi.md#create_encryption_key) | **POST** /v1/encryption/keys | Upload an encryption key pair
*EncryptionApi* | [**create_encryption_recovery**](docs/EncryptionApi.md#create_encryption_recovery) | **POST** /v1/encryption/recovery | Store an encryption recovery blob
*EncryptionApi* | [**get_encryption_key**](docs/EncryptionApi.md#get_encryption_key) | **GET** /v1/encryption/keys/{email} | Get encryption key for a mailbox
*EncryptionApi* | [**rotate_encryption_key**](docs/EncryptionApi.md#rotate_encryption_key) | **POST** /v1/encryption/keys/rotate | Rotate an encryption key
*HealthApi* | [**healthz_get**](docs/HealthApi.md#healthz_get) | **GET** /healthz | Liveness check
*IpPoolsApi* | [**create_dedicated_ip_request**](docs/IpPoolsApi.md#create_dedicated_ip_request) | **POST** /v1/dedicated-ip-requests | Request a dedicated IP
*IpPoolsApi* | [**get_ip_assignment**](docs/IpPoolsApi.md#get_ip_assignment) | **GET** /v1/ip-assignment | Get current IP assignment
*IpPoolsApi* | [**list_dedicated_ip_requests**](docs/IpPoolsApi.md#list_dedicated_ip_requests) | **GET** /v1/dedicated-ip-requests | List dedicated IP requests
*MailboxesApi* | [**add_shared_member**](docs/MailboxesApi.md#add_shared_member) | **POST** /v1/mailboxes/{email}/members | Add a shared mailbox member
*MailboxesApi* | [**list_shared_members**](docs/MailboxesApi.md#list_shared_members) | **GET** /v1/mailboxes/{email}/members | List shared mailbox members
*MailboxesApi* | [**remove_shared_member**](docs/MailboxesApi.md#remove_shared_member) | **DELETE** /v1/mailboxes/{email}/members/{memberEmail} | Remove a shared mailbox member
*MailboxesApi* | [**v1_mailboxes_email_delete**](docs/MailboxesApi.md#v1_mailboxes_email_delete) | **DELETE** /v1/mailboxes/{email} | Soft-delete a mailbox
*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
*MailboxesApi* | [**v1_mailboxes_email_export_post**](docs/MailboxesApi.md#v1_mailboxes_email_export_post) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export
*MailboxesApi* | [**v1_mailboxes_email_get**](docs/MailboxesApi.md#v1_mailboxes_email_get) | **GET** /v1/mailboxes/{email} | Get a mailbox
*MailboxesApi* | [**v1_mailboxes_email_patch**](docs/MailboxesApi.md#v1_mailboxes_email_patch) | **PATCH** /v1/mailboxes/{email} | Update a mailbox
*MailboxesApi* | [**v1_mailboxes_email_vacation_delete**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_delete) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder
*MailboxesApi* | [**v1_mailboxes_email_vacation_get**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_get) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder
*MailboxesApi* | [**v1_mailboxes_email_vacation_put**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_put) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder
*MailboxesApi* | [**v1_mailboxes_get**](docs/MailboxesApi.md#v1_mailboxes_get) | **GET** /v1/mailboxes | List mailboxes
*MailboxesApi* | [**v1_mailboxes_post**](docs/MailboxesApi.md#v1_mailboxes_post) | **POST** /v1/mailboxes | Create a mailbox
*MailboxesApi* | [**v1_vacation_get**](docs/MailboxesApi.md#v1_vacation_get) | **GET** /v1/vacation | List all vacation responders
*MigrationsApi* | [**cancel_migration**](docs/MigrationsApi.md#cancel_migration) | **POST** /v1/migrations/{id}/cancel | Cancel a running migration
*MigrationsApi* | [**check_migration_dns**](docs/MigrationsApi.md#check_migration_dns) | **GET** /v1/migrations/{id}/dns-check | Check DNS readiness for cutover
*MigrationsApi* | [**create_migration**](docs/MigrationsApi.md#create_migration) | **POST** /v1/migrations | Create a migration
*MigrationsApi* | [**create_migration_credential**](docs/MigrationsApi.md#create_migration_credential) | **POST** /v1/migrations/credentials | Store a migration credential
*MigrationsApi* | [**delete_migration**](docs/MigrationsApi.md#delete_migration) | **DELETE** /v1/migrations/{id} | Delete a migration
*MigrationsApi* | [**delete_migration_credential**](docs/MigrationsApi.md#delete_migration_credential) | **DELETE** /v1/migrations/credentials/{id} | Delete a migration credential
*MigrationsApi* | [**delta_sync_migration**](docs/MigrationsApi.md#delta_sync_migration) | **POST** /v1/migrations/{id}/delta-sync | Run a delta sync
*MigrationsApi* | [**discover_migration**](docs/MigrationsApi.md#discover_migration) | **POST** /v1/migrations/{id}/discover | Discover source mailboxes
*MigrationsApi* | [**final_sync_migration**](docs/MigrationsApi.md#final_sync_migration) | **POST** /v1/migrations/{id}/final-sync | Run the final sync before cutover
*MigrationsApi* | [**get_migration**](docs/MigrationsApi.md#get_migration) | **GET** /v1/migrations/{id} | Get a migration
*MigrationsApi* | [**get_migration_progress**](docs/MigrationsApi.md#get_migration_progress) | **GET** /v1/migrations/{id}/progress | Get migration progress
*MigrationsApi* | [**list_migration_credentials**](docs/MigrationsApi.md#list_migration_credentials) | **GET** /v1/migrations/credentials | List migration credentials
*MigrationsApi* | [**list_migration_events**](docs/MigrationsApi.md#list_migration_events) | **GET** /v1/migrations/{id}/events | List migration events
*MigrationsApi* | [**list_migration_mailboxes**](docs/MigrationsApi.md#list_migration_mailboxes) | **GET** /v1/migrations/{id}/mailboxes | List migration mailboxes
*MigrationsApi* | [**list_migrations**](docs/MigrationsApi.md#list_migrations) | **GET** /v1/migrations | List migrations
*MigrationsApi* | [**map_migration**](docs/MigrationsApi.md#map_migration) | **POST** /v1/migrations/{id}/map | Map source to destination mailboxes
*MigrationsApi* | [**retry_migration**](docs/MigrationsApi.md#retry_migration) | **POST** /v1/migrations/{id}/retry | Retry a failed or cancelled migration
*MigrationsApi* | [**start_migration**](docs/MigrationsApi.md#start_migration) | **POST** /v1/migrations/{id}/start | Start the migration
*MigrationsApi* | [**update_migration**](docs/MigrationsApi.md#update_migration) | **PATCH** /v1/migrations/{id} | Update a migration
*MigrationsApi* | [**update_migration_mailbox**](docs/MigrationsApi.md#update_migration_mailbox) | **PATCH** /v1/migrations/{id}/mailboxes/{mbxId} | Update a migration mailbox
*MigrationsApi* | [**validate_migration**](docs/MigrationsApi.md#validate_migration) | **POST** /v1/migrations/{id}/validate | Validate migrated data
*ResourcesApi* | [**create_resource**](docs/ResourcesApi.md#create_resource) | **POST** /v1/resources | Create a resource
*ResourcesApi* | [**delete_resource**](docs/ResourcesApi.md#delete_resource) | **DELETE** /v1/resources/{id} | Delete a resource
*ResourcesApi* | [**get_resource**](docs/ResourcesApi.md#get_resource) | **GET** /v1/resources/{id} | Get a resource
*ResourcesApi* | [**list_resources**](docs/ResourcesApi.md#list_resources) | **GET** /v1/resources | List resources
*ResourcesApi* | [**update_resource**](docs/ResourcesApi.md#update_resource) | **PATCH** /v1/resources/{id} | Update a resource
*SendApi* | [**v1_messages_get**](docs/SendApi.md#v1_messages_get) | **GET** /v1/messages | List outbound messages
*SendApi* | [**v1_messages_id_delete**](docs/SendApi.md#v1_messages_id_delete) | **DELETE** /v1/messages/{id} | Cancel a scheduled send
*SendApi* | [**v1_messages_id_get**](docs/SendApi.md#v1_messages_id_get) | **GET** /v1/messages/{id} | Get message status
*SendApi* | [**v1_messages_stats_get**](docs/SendApi.md#v1_messages_stats_get) | **GET** /v1/messages/stats | Aggregate delivery stats
*SendApi* | [**v1_send_batch_post**](docs/SendApi.md#v1_send_batch_post) | **POST** /v1/send/batch | Send a batch of emails
*SendApi* | [**v1_send_post**](docs/SendApi.md#v1_send_post) | **POST** /v1/send | Send an email
*SignupApi* | [**signup**](docs/SignupApi.md#signup) | **POST** /v1/signup | Sign up a new tenant
*SuppressionsApi* | [**v1_suppressions_email_delete**](docs/SuppressionsApi.md#v1_suppressions_email_delete) | **DELETE** /v1/suppressions/{email} | Remove a suppression
*SuppressionsApi* | [**v1_suppressions_email_get**](docs/SuppressionsApi.md#v1_suppressions_email_get) | **GET** /v1/suppressions/{email} | Check whether an address is suppressed
*SuppressionsApi* | [**v1_suppressions_get**](docs/SuppressionsApi.md#v1_suppressions_get) | **GET** /v1/suppressions | List suppressed recipients
*SuppressionsApi* | [**v1_suppressions_post**](docs/SuppressionsApi.md#v1_suppressions_post) | **POST** /v1/suppressions | Add a suppression
*TemplatesApi* | [**v1_templates_get**](docs/TemplatesApi.md#v1_templates_get) | **GET** /v1/templates | List templates
*TemplatesApi* | [**v1_templates_id_delete**](docs/TemplatesApi.md#v1_templates_id_delete) | **DELETE** /v1/templates/{id} | Delete a template
*TemplatesApi* | [**v1_templates_id_get**](docs/TemplatesApi.md#v1_templates_id_get) | **GET** /v1/templates/{id} | Get a template
*TemplatesApi* | [**v1_templates_id_put**](docs/TemplatesApi.md#v1_templates_id_put) | **PUT** /v1/templates/{id} | Update a template
*TemplatesApi* | [**v1_templates_post**](docs/TemplatesApi.md#v1_templates_post) | **POST** /v1/templates | Create a template
*TenantApi* | [**v1_tenant_get**](docs/TenantApi.md#v1_tenant_get) | **GET** /v1/tenant | Get the calling tenant
*TenantApi* | [**v1_usage_get**](docs/TenantApi.md#v1_usage_get) | **GET** /v1/usage | Usage snapshot
*TestApi* | [**v1_test_inbound_post**](docs/TestApi.md#v1_test_inbound_post) | **POST** /v1/test/inbound | Simulate an inbound email (test keys only)
*UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /v1/users | Create a user
*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /v1/users/{id} | Delete a user
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /v1/users/{id} | Get a user
*UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /v1/users | List users
*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /v1/users/{id} | Update a user
*WebhooksApi* | [**v1_webhooks_get**](docs/WebhooksApi.md#v1_webhooks_get) | **GET** /v1/webhooks | List webhooks
*WebhooksApi* | [**v1_webhooks_id_delete**](docs/WebhooksApi.md#v1_webhooks_id_delete) | **DELETE** /v1/webhooks/{id} | Delete a webhook
*WebhooksApi* | [**v1_webhooks_id_patch**](docs/WebhooksApi.md#v1_webhooks_id_patch) | **PATCH** /v1/webhooks/{id} | Update a webhook
*WebhooksApi* | [**v1_webhooks_post**](docs/WebhooksApi.md#v1_webhooks_post) | **POST** /v1/webhooks | Create a webhook


## Documentation For Models

 - [APIKey](docs/APIKey.md)
 - [ActivateAddOn200Response](docs/ActivateAddOn200Response.md)
 - [AddCalendarMemberRequest](docs/AddCalendarMemberRequest.md)
 - [AddContactListMemberRequest](docs/AddContactListMemberRequest.md)
 - [AddOn](docs/AddOn.md)
 - [AddSharedMemberRequest](docs/AddSharedMemberRequest.md)
 - [Admin](docs/Admin.md)
 - [AdminFull](docs/AdminFull.md)
 - [Alias](docs/Alias.md)
 - [AuditEvent](docs/AuditEvent.md)
 - [BatchLookupPublicKeys200Response](docs/BatchLookupPublicKeys200Response.md)
 - [BatchLookupPublicKeys200ResponseDataInner](docs/BatchLookupPublicKeys200ResponseDataInner.md)
 - [BatchResult](docs/BatchResult.md)
 - [BillingStatus](docs/BillingStatus.md)
 - [Calendar](docs/Calendar.md)
 - [CalendarEvent](docs/CalendarEvent.md)
 - [CalendarIntegration](docs/CalendarIntegration.md)
 - [CalendarMember](docs/CalendarMember.md)
 - [CalendarPolicies](docs/CalendarPolicies.md)
 - [Contact](docs/Contact.md)
 - [ContactList](docs/ContactList.md)
 - [CreateBillingCheckout200Response](docs/CreateBillingCheckout200Response.md)
 - [CreateBillingCheckoutRequest](docs/CreateBillingCheckoutRequest.md)
 - [CreateCalendarEventRequest](docs/CreateCalendarEventRequest.md)
 - [CreateCalendarIntegrationRequest](docs/CreateCalendarIntegrationRequest.md)
 - [CreateCalendarRequest](docs/CreateCalendarRequest.md)
 - [CreateContactListRequest](docs/CreateContactListRequest.md)
 - [CreateContactRequest](docs/CreateContactRequest.md)
 - [CreateDedicatedIPRequestRequest](docs/CreateDedicatedIPRequestRequest.md)
 - [CreateDistributionListRequest](docs/CreateDistributionListRequest.md)
 - [CreateEncryptionKey201Response](docs/CreateEncryptionKey201Response.md)
 - [CreateEncryptionKeyRequest](docs/CreateEncryptionKeyRequest.md)
 - [CreateEncryptionRecoveryRequest](docs/CreateEncryptionRecoveryRequest.md)
 - [CreateMigrationCredentialRequest](docs/CreateMigrationCredentialRequest.md)
 - [CreateMigrationCredentialRequestCredentials](docs/CreateMigrationCredentialRequestCredentials.md)
 - [CreateMigrationRequest](docs/CreateMigrationRequest.md)
 - [CreateResourceRequest](docs/CreateResourceRequest.md)
 - [CreateUnitsCheckout200Response](docs/CreateUnitsCheckout200Response.md)
 - [CreateUnitsCheckoutRequest](docs/CreateUnitsCheckoutRequest.md)
 - [CreateUserRequest](docs/CreateUserRequest.md)
 - [DNSRecord](docs/DNSRecord.md)
 - [DedicatedIPRequest](docs/DedicatedIPRequest.md)
 - [DirectoryPermissions](docs/DirectoryPermissions.md)
 - [DiscoverMigration202Response](docs/DiscoverMigration202Response.md)
 - [DistributionListDetail](docs/DistributionListDetail.md)
 - [DistributionListSummary](docs/DistributionListSummary.md)
 - [Domain](docs/Domain.md)
 - [GALSettings](docs/GALSettings.md)
 - [GetAddOnStatus200Response](docs/GetAddOnStatus200Response.md)
 - [GetAuditSummary200Response](docs/GetAuditSummary200Response.md)
 - [GetCalendarSecurity200Response](docs/GetCalendarSecurity200Response.md)
 - [GetCalendarSecurity200ResponseAlertsInner](docs/GetCalendarSecurity200ResponseAlertsInner.md)
 - [GetCalendarSecurity200ResponseDelegatedAccessInner](docs/GetCalendarSecurity200ResponseDelegatedAccessInner.md)
 - [GetCalendarSecurity200ResponseExternalSharing](docs/GetCalendarSecurity200ResponseExternalSharing.md)
 - [GetCalendarSecurity200ResponsePublicCalendarListInner](docs/GetCalendarSecurity200ResponsePublicCalendarListInner.md)
 - [GetContactList200Response](docs/GetContactList200Response.md)
 - [GetContactList200ResponseMembersInner](docs/GetContactList200ResponseMembersInner.md)
 - [GetContactLists200Response](docs/GetContactLists200Response.md)
 - [GetContactLists200ResponseDataInner](docs/GetContactLists200ResponseDataInner.md)
 - [GetDirectoryActivity200Response](docs/GetDirectoryActivity200Response.md)
 - [GetDirectoryActivity200ResponseDataInner](docs/GetDirectoryActivity200ResponseDataInner.md)
 - [GetDirectoryStats200Response](docs/GetDirectoryStats200Response.md)
 - [GetDomainsStatus200Response](docs/GetDomainsStatus200Response.md)
 - [GetDomainsStatus200ResponseDomainsInner](docs/GetDomainsStatus200ResponseDomainsInner.md)
 - [GetDomainsStatus200ResponseDomainsInnerChecksInner](docs/GetDomainsStatus200ResponseDomainsInnerChecksInner.md)
 - [GetEncryptionKey200Response](docs/GetEncryptionKey200Response.md)
 - [GetIPAssignment200Response](docs/GetIPAssignment200Response.md)
 - [GetIntegrationsSummary200Response](docs/GetIntegrationsSummary200Response.md)
 - [GetIntegrationsSummary200ResponseApiKeysInner](docs/GetIntegrationsSummary200ResponseApiKeysInner.md)
 - [GetIntegrationsSummary200ResponseWebhooksInner](docs/GetIntegrationsSummary200ResponseWebhooksInner.md)
 - [GetSecurity200Response](docs/GetSecurity200Response.md)
 - [GetSecurity200ResponseAlertsInner](docs/GetSecurity200ResponseAlertsInner.md)
 - [GetSecurity200ResponseStatsInner](docs/GetSecurity200ResponseStatsInner.md)
 - [GetStorage200Response](docs/GetStorage200Response.md)
 - [GetStorage200ResponseTopMailboxesInner](docs/GetStorage200ResponseTopMailboxesInner.md)
 - [GetStorage200ResponseTopMessagesInner](docs/GetStorage200ResponseTopMessagesInner.md)
 - [GetUserInsights200Response](docs/GetUserInsights200Response.md)
 - [HealthzGet200Response](docs/HealthzGet200Response.md)
 - [ListAddOns200Response](docs/ListAddOns200Response.md)
 - [ListCalendarEvents200Response](docs/ListCalendarEvents200Response.md)
 - [ListCalendarIntegrations200Response](docs/ListCalendarIntegrations200Response.md)
 - [ListCalendarMembers200Response](docs/ListCalendarMembers200Response.md)
 - [ListCalendars200Response](docs/ListCalendars200Response.md)
 - [ListContactLists200Response](docs/ListContactLists200Response.md)
 - [ListContacts200Response](docs/ListContacts200Response.md)
 - [ListDedicatedIPRequests200Response](docs/ListDedicatedIPRequests200Response.md)
 - [ListDistributionLists200Response](docs/ListDistributionLists200Response.md)
 - [ListMigrationCredentials200Response](docs/ListMigrationCredentials200Response.md)
 - [ListMigrationEvents200Response](docs/ListMigrationEvents200Response.md)
 - [ListMigrationMailboxes200Response](docs/ListMigrationMailboxes200Response.md)
 - [ListMigrations200Response](docs/ListMigrations200Response.md)
 - [ListResources200Response](docs/ListResources200Response.md)
 - [ListSharedMembers200Response](docs/ListSharedMembers200Response.md)
 - [ListUsers200Response](docs/ListUsers200Response.md)
 - [Mailbox](docs/Mailbox.md)
 - [MapMigrationRequest](docs/MapMigrationRequest.md)
 - [MapMigrationRequestMappingsInner](docs/MapMigrationRequestMappingsInner.md)
 - [Message](docs/Message.md)
 - [MessageStats](docs/MessageStats.md)
 - [MessageStatsCounts](docs/MessageStatsCounts.md)
 - [MessageStatsRates](docs/MessageStatsRates.md)
 - [MessageStatsWindow](docs/MessageStatsWindow.md)
 - [Migration](docs/Migration.md)
 - [MigrationCredential](docs/MigrationCredential.md)
 - [MigrationEvent](docs/MigrationEvent.md)
 - [MigrationMailbox](docs/MigrationMailbox.md)
 - [MigrationProgress](docs/MigrationProgress.md)
 - [MigrationProgressMailboxesInner](docs/MigrationProgressMailboxesInner.md)
 - [MigrationSettings](docs/MigrationSettings.md)
 - [PlanCatalogEntry](docs/PlanCatalogEntry.md)
 - [Problem](docs/Problem.md)
 - [ReplaceDistributionListMembers200Response](docs/ReplaceDistributionListMembers200Response.md)
 - [ReplaceDistributionListMembersRequest](docs/ReplaceDistributionListMembersRequest.md)
 - [Resource](docs/Resource.md)
 - [RotateEncryptionKeyRequest](docs/RotateEncryptionKeyRequest.md)
 - [SendMessage](docs/SendMessage.md)
 - [SharedMember](docs/SharedMember.md)
 - [SignupRequest](docs/SignupRequest.md)
 - [StartMigration202Response](docs/StartMigration202Response.md)
 - [Suppression](docs/Suppression.md)
 - [Template](docs/Template.md)
 - [TemplateInput](docs/TemplateInput.md)
 - [Tenant](docs/Tenant.md)
 - [UnitBundle](docs/UnitBundle.md)
 - [UpdateCalendarEventRequest](docs/UpdateCalendarEventRequest.md)
 - [UpdateCalendarIntegrationRequest](docs/UpdateCalendarIntegrationRequest.md)
 - [UpdateCalendarMemberRequest](docs/UpdateCalendarMemberRequest.md)
 - [UpdateCalendarPoliciesRequest](docs/UpdateCalendarPoliciesRequest.md)
 - [UpdateCalendarRequest](docs/UpdateCalendarRequest.md)
 - [UpdateContactListRequest](docs/UpdateContactListRequest.md)
 - [UpdateContactRequest](docs/UpdateContactRequest.md)
 - [UpdateDirectoryPermissionsRequest](docs/UpdateDirectoryPermissionsRequest.md)
 - [UpdateGALSettingsRequest](docs/UpdateGALSettingsRequest.md)
 - [UpdateMigrationMailboxRequest](docs/UpdateMigrationMailboxRequest.md)
 - [UpdateMigrationRequest](docs/UpdateMigrationRequest.md)
 - [UpdateResourceRequest](docs/UpdateResourceRequest.md)
 - [UpdateUserRequest](docs/UpdateUserRequest.md)
 - [User](docs/User.md)
 - [UserEvent](docs/UserEvent.md)
 - [V1AdminLoginPost200Response](docs/V1AdminLoginPost200Response.md)
 - [V1AdminLoginPostRequest](docs/V1AdminLoginPostRequest.md)
 - [V1AdminMeGet200Response](docs/V1AdminMeGet200Response.md)
 - [V1AdminsGet200Response](docs/V1AdminsGet200Response.md)
 - [V1AdminsIdPatchRequest](docs/V1AdminsIdPatchRequest.md)
 - [V1AdminsPostRequest](docs/V1AdminsPostRequest.md)
 - [V1AliasesGet200Response](docs/V1AliasesGet200Response.md)
 - [V1AliasesPostRequest](docs/V1AliasesPostRequest.md)
 - [V1ApiKeysGet200Response](docs/V1ApiKeysGet200Response.md)
 - [V1ApiKeysPost201Response](docs/V1ApiKeysPost201Response.md)
 - [V1ApiKeysPostRequest](docs/V1ApiKeysPostRequest.md)
 - [V1DomainsGet200Response](docs/V1DomainsGet200Response.md)
 - [V1DomainsPostRequest](docs/V1DomainsPostRequest.md)
 - [V1InboxesMailboxMessagesPostRequest](docs/V1InboxesMailboxMessagesPostRequest.md)
 - [V1MailboxesEmailExportPost201Response](docs/V1MailboxesEmailExportPost201Response.md)
 - [V1MailboxesEmailPatchRequest](docs/V1MailboxesEmailPatchRequest.md)
 - [V1MailboxesEmailVacationPutRequest](docs/V1MailboxesEmailVacationPutRequest.md)
 - [V1MailboxesGet200Response](docs/V1MailboxesGet200Response.md)
 - [V1MailboxesPostRequest](docs/V1MailboxesPostRequest.md)
 - [V1MessagesGet200Response](docs/V1MessagesGet200Response.md)
 - [V1SendBatchPost200Response](docs/V1SendBatchPost200Response.md)
 - [V1SendBatchPostRequest](docs/V1SendBatchPostRequest.md)
 - [V1SendPost202Response](docs/V1SendPost202Response.md)
 - [V1SendPostRequest](docs/V1SendPostRequest.md)
 - [V1SendPostRequestAttachmentsInner](docs/V1SendPostRequestAttachmentsInner.md)
 - [V1SuppressionsGet200Response](docs/V1SuppressionsGet200Response.md)
 - [V1SuppressionsPostRequest](docs/V1SuppressionsPostRequest.md)
 - [V1TemplatesGet200Response](docs/V1TemplatesGet200Response.md)
 - [V1UsageGet200Response](docs/V1UsageGet200Response.md)
 - [V1VacationGet200Response](docs/V1VacationGet200Response.md)
 - [V1WebhooksGet200Response](docs/V1WebhooksGet200Response.md)
 - [V1WebhooksIdPatchRequest](docs/V1WebhooksIdPatchRequest.md)
 - [V1WebhooksPostRequest](docs/V1WebhooksPostRequest.md)
 - [VacationParams](docs/VacationParams.md)
 - [VacationResponder](docs/VacationResponder.md)
 - [Webhook](docs/Webhook.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (lk_live_<prefix>_<secret>)

<a id="oauth2"></a>
### 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


## Author

support@lockally.com


