Module: Lockally

Defined in:
lib/lockally/version.rb,
lib/lockally.rb,
lib/lockally/api_error.rb,
lib/lockally/api/ai_api.rb,
lib/lockally/api_client.rb,
lib/lockally/models/user.rb,
lib/lockally/api/send_api.rb,
lib/lockally/api/test_api.rb,
lib/lockally/models/admin.rb,
lib/lockally/api/admin_api.rb,
lib/lockally/api/users_api.rb,
lib/lockally/configuration.rb,
lib/lockally/models/add_on.rb,
lib/lockally/models/domain.rb,
lib/lockally/models/tenant.rb,
lib/lockally/api/admins_api.rb,
lib/lockally/api/agents_api.rb,
lib/lockally/api/drafts_api.rb,
lib/lockally/api/health_api.rb,
lib/lockally/api/signup_api.rb,
lib/lockally/api/tenant_api.rb,
lib/lockally/api_model_base.rb,
lib/lockally/models/api_key.rb,
lib/lockally/models/contact.rb,
lib/lockally/models/mailbox.rb,
lib/lockally/models/message.rb,
lib/lockally/models/problem.rb,
lib/lockally/models/webhook.rb,
lib/lockally/api/add_ons_api.rb,
lib/lockally/api/aliases_api.rb,
lib/lockally/api/billing_api.rb,
lib/lockally/api/domains_api.rb,
lib/lockally/models/calendar.rb,
lib/lockally/models/resource.rb,
lib/lockally/models/template.rb,
lib/lockally/api/api_keys_api.rb,
lib/lockally/api/contacts_api.rb,
lib/lockally/api/ip_pools_api.rb,
lib/lockally/api/webhooks_api.rb,
lib/lockally/models/migration.rb,
lib/lockally/api/calendars_api.rb,
lib/lockally/api/dashboard_api.rb,
lib/lockally/api/directory_api.rb,
lib/lockally/api/mailboxes_api.rb,
lib/lockally/api/resources_api.rb,
lib/lockally/api/templates_api.rb,
lib/lockally/models/admin_full.rb,
lib/lockally/models/dns_record.rb,
lib/lockally/models/user_event.rb,
lib/lockally/api/encryption_api.rb,
lib/lockally/api/migrations_api.rb,
lib/lockally/models/audit_event.rb,
lib/lockally/models/model_alias.rb,
lib/lockally/models/suppression.rb,
lib/lockally/models/unit_bundle.rb,
lib/lockally/models/batch_result.rb,
lib/lockally/models/contact_list.rb,
lib/lockally/models/gal_settings.rb,
lib/lockally/models/send_message.rb,
lib/lockally/api/suppressions_api.rb,
lib/lockally/models/message_stats.rb,
lib/lockally/models/shared_member.rb,
lib/lockally/api/contact_lists_api.rb,
lib/lockally/models/billing_status.rb,
lib/lockally/models/calendar_event.rb,
lib/lockally/models/signup_request.rb,
lib/lockally/models/template_input.rb,
lib/lockally/models/calendar_member.rb,
lib/lockally/models/migration_event.rb,
lib/lockally/models/vacation_params.rb,
lib/lockally/models/calendar_policies.rb,
lib/lockally/models/migration_mailbox.rb,
lib/lockally/models/migration_progress.rb,
lib/lockally/models/migration_settings.rb,
lib/lockally/models/plan_catalog_entry.rb,
lib/lockally/models/vacation_responder.rb,
lib/lockally/api/distribution_lists_api.rb,
lib/lockally/models/create_user_request.rb,
lib/lockally/models/message_stats_rates.rb,
lib/lockally/models/update_user_request.rb,
lib/lockally/models/calendar_integration.rb,
lib/lockally/models/dedicated_ip_request.rb,
lib/lockally/models/message_stats_counts.rb,
lib/lockally/models/message_stats_window.rb,
lib/lockally/models/migration_credential.rb,
lib/lockally/models/v1_send_post_request.rb,
lib/lockally/models/directory_permissions.rb,
lib/lockally/models/map_migration_request.rb,
lib/lockally/models/create_contact_request.rb,
lib/lockally/models/list_users200_response.rb,
lib/lockally/models/update_contact_request.rb,
lib/lockally/models/v1_admins_post_request.rb,
lib/lockally/models/create_calendar_request.rb,
lib/lockally/models/create_resource_request.rb,
lib/lockally/models/get_storage200_response.rb,
lib/lockally/models/healthz_get200_response.rb,
lib/lockally/models/update_calendar_request.rb,
lib/lockally/models/update_resource_request.rb,
lib/lockally/models/v1_aliases_post_request.rb,
lib/lockally/models/v1_domains_post_request.rb,
lib/lockally/models/create_migration_request.rb,
lib/lockally/models/distribution_list_detail.rb,
lib/lockally/models/get_security200_response.rb,
lib/lockally/models/list_add_ons200_response.rb,
lib/lockally/models/update_migration_request.rb,
lib/lockally/models/v1_api_keys_post_request.rb,
lib/lockally/models/v1_send_post202_response.rb,
lib/lockally/models/v1_usage_get200_response.rb,
lib/lockally/models/v1_webhooks_post_request.rb,
lib/lockally/models/add_shared_member_request.rb,
lib/lockally/models/distribution_list_summary.rb,
lib/lockally/models/list_contacts200_response.rb,
lib/lockally/models/v1_admins_get200_response.rb,
lib/lockally/models/v1_mailboxes_post_request.rb,
lib/lockally/models/list_calendars200_response.rb,
lib/lockally/models/list_resources200_response.rb,
lib/lockally/models/v1_admins_id_patch_request.rb,
lib/lockally/models/v1_aliases_get200_response.rb,
lib/lockally/models/v1_domains_get200_response.rb,
lib/lockally/models/v1_send_batch_post_request.rb,
lib/lockally/models/activate_add_on200_response.rb,
lib/lockally/models/add_calendar_member_request.rb,
lib/lockally/models/create_contact_list_request.rb,
lib/lockally/models/list_migrations200_response.rb,
lib/lockally/models/start_migration202_response.rb,
lib/lockally/models/update_contact_list_request.rb,
lib/lockally/models/update_gal_settings_request.rb,
lib/lockally/models/v1_admin_login_post_request.rb,
lib/lockally/models/v1_admin_me_get200_response.rb,
lib/lockally/models/v1_api_keys_get200_response.rb,
lib/lockally/models/v1_messages_get200_response.rb,
lib/lockally/models/v1_vacation_get200_response.rb,
lib/lockally/models/v1_webhooks_get200_response.rb,
lib/lockally/models/get_contact_list200_response.rb,
lib/lockally/models/v1_api_keys_post201_response.rb,
lib/lockally/models/v1_mailboxes_get200_response.rb,
lib/lockally/models/v1_suppressions_post_request.rb,
lib/lockally/models/v1_templates_get200_response.rb,
lib/lockally/models/v1_webhooks_id_patch_request.rb,
lib/lockally/models/create_calendar_event_request.rb,
lib/lockally/models/create_encryption_key_request.rb,
lib/lockally/models/create_units_checkout_request.rb,
lib/lockally/models/get_add_on_status200_response.rb,
lib/lockally/models/get_audit_summary200_response.rb,
lib/lockally/models/get_contact_lists200_response.rb,
lib/lockally/models/get_ip_assignment200_response.rb,
lib/lockally/models/get_user_insights200_response.rb,
lib/lockally/models/rotate_encryption_key_request.rb,
lib/lockally/models/update_calendar_event_request.rb,
lib/lockally/models/discover_migration202_response.rb,
lib/lockally/models/get_domains_status200_response.rb,
lib/lockally/models/get_encryption_key200_response.rb,
lib/lockally/models/list_contact_lists200_response.rb,
lib/lockally/models/update_calendar_member_request.rb,
lib/lockally/models/v1_send_batch_post200_response.rb,
lib/lockally/models/add_contact_list_member_request.rb,
lib/lockally/models/create_billing_checkout_request.rb,
lib/lockally/models/get_directory_stats200_response.rb,
lib/lockally/models/list_shared_members200_response.rb,
lib/lockally/models/v1_admin_login_post200_response.rb,
lib/lockally/models/v1_suppressions_get200_response.rb,
lib/lockally/models/create_distribution_list_request.rb,
lib/lockally/models/list_calendar_events200_response.rb,
lib/lockally/models/update_calendar_policies_request.rb,
lib/lockally/models/update_migration_mailbox_request.rb,
lib/lockally/models/v1_mailboxes_email_patch_request.rb,
lib/lockally/models/create_encryption_key201_response.rb,
lib/lockally/models/create_units_checkout200_response.rb,
lib/lockally/models/get_calendar_security200_response.rb,
lib/lockally/models/list_calendar_members200_response.rb,
lib/lockally/models/list_migration_events200_response.rb,
lib/lockally/models/create_encryption_recovery_request.rb,
lib/lockally/models/get_directory_activity200_response.rb,
lib/lockally/models/migration_progress_mailboxes_inner.rb,
lib/lockally/models/create_billing_checkout200_response.rb,
lib/lockally/models/create_calendar_integration_request.rb,
lib/lockally/models/create_dedicated_ip_request_request.rb,
lib/lockally/models/create_migration_credential_request.rb,
lib/lockally/models/list_distribution_lists200_response.rb,
lib/lockally/models/update_calendar_integration_request.rb,
lib/lockally/models/batch_lookup_public_keys200_response.rb,
lib/lockally/models/get_integrations_summary200_response.rb,
lib/lockally/models/get_security200_response_stats_inner.rb,
lib/lockally/models/list_migration_mailboxes200_response.rb,
lib/lockally/models/map_migration_request_mappings_inner.rb,
lib/lockally/models/update_directory_permissions_request.rb,
lib/lockally/models/get_security200_response_alerts_inner.rb,
lib/lockally/models/list_calendar_integrations200_response.rb,
lib/lockally/models/list_dedicated_ip_requests200_response.rb,
lib/lockally/models/list_migration_credentials200_response.rb,
lib/lockally/models/v1_send_post_request_attachments_inner.rb,
lib/lockally/models/v1_mailboxes_email_vacation_put_request.rb,
lib/lockally/models/get_contact_lists200_response_data_inner.rb,
lib/lockally/models/v1_inboxes_mailbox_messages_post_request.rb,
lib/lockally/models/replace_distribution_list_members_request.rb,
lib/lockally/models/get_contact_list200_response_members_inner.rb,
lib/lockally/models/get_storage200_response_top_messages_inner.rb,
lib/lockally/models/v1_mailboxes_email_export_post201_response.rb,
lib/lockally/models/get_storage200_response_top_mailboxes_inner.rb,
lib/lockally/models/get_domains_status200_response_domains_inner.rb,
lib/lockally/models/get_directory_activity200_response_data_inner.rb,
lib/lockally/models/replace_distribution_list_members200_response.rb,
lib/lockally/models/get_calendar_security200_response_alerts_inner.rb,
lib/lockally/models/batch_lookup_public_keys200_response_data_inner.rb,
lib/lockally/models/create_migration_credential_request_credentials.rb,
lib/lockally/models/get_calendar_security200_response_external_sharing.rb,
lib/lockally/models/get_integrations_summary200_response_api_keys_inner.rb,
lib/lockally/models/get_integrations_summary200_response_webhooks_inner.rb,
lib/lockally/models/get_calendar_security200_response_delegated_access_inner.rb,
lib/lockally/models/get_domains_status200_response_domains_inner_checks_inner.rb,
lib/lockally/models/get_calendar_security200_response_public_calendar_list_inner.rb

Overview

#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 application/problem+json documents. Scopes. Each endpoint requires a specific scope on the presented key. Insufficient scope returns 403 with the required scope name in detail.

The version of the OpenAPI document: 0.1.0 Contact: support@lockally.com Generated by: https://openapi-generator.tech Generator version: 7.23.0

Defined Under Namespace

Classes: APIKey, ActivateAddOn200Response, AddCalendarMemberRequest, AddContactListMemberRequest, AddOn, AddOnsApi, AddSharedMemberRequest, Admin, AdminApi, AdminFull, AdminsApi, AgentsApi, AiApi, AliasesApi, ApiClient, ApiError, ApiKeysApi, ApiModelBase, AuditEvent, BatchLookupPublicKeys200Response, BatchLookupPublicKeys200ResponseDataInner, BatchResult, BillingApi, BillingStatus, Calendar, CalendarEvent, CalendarIntegration, CalendarMember, CalendarPolicies, CalendarsApi, Configuration, Contact, ContactList, ContactListsApi, ContactsApi, CreateBillingCheckout200Response, CreateBillingCheckoutRequest, CreateCalendarEventRequest, CreateCalendarIntegrationRequest, CreateCalendarRequest, CreateContactListRequest, CreateContactRequest, CreateDedicatedIPRequestRequest, CreateDistributionListRequest, CreateEncryptionKey201Response, CreateEncryptionKeyRequest, CreateEncryptionRecoveryRequest, CreateMigrationCredentialRequest, CreateMigrationCredentialRequestCredentials, CreateMigrationRequest, CreateResourceRequest, CreateUnitsCheckout200Response, CreateUnitsCheckoutRequest, CreateUserRequest, DNSRecord, DashboardApi, DedicatedIPRequest, DirectoryApi, DirectoryPermissions, DiscoverMigration202Response, DistributionListDetail, DistributionListSummary, DistributionListsApi, Domain, DomainsApi, DraftsApi, EncryptionApi, GALSettings, GetAddOnStatus200Response, GetAuditSummary200Response, GetCalendarSecurity200Response, GetCalendarSecurity200ResponseAlertsInner, GetCalendarSecurity200ResponseDelegatedAccessInner, GetCalendarSecurity200ResponseExternalSharing, GetCalendarSecurity200ResponsePublicCalendarListInner, GetContactList200Response, GetContactList200ResponseMembersInner, GetContactLists200Response, GetContactLists200ResponseDataInner, GetDirectoryActivity200Response, GetDirectoryActivity200ResponseDataInner, GetDirectoryStats200Response, GetDomainsStatus200Response, GetDomainsStatus200ResponseDomainsInner, GetDomainsStatus200ResponseDomainsInnerChecksInner, GetEncryptionKey200Response, GetIPAssignment200Response, GetIntegrationsSummary200Response, GetIntegrationsSummary200ResponseApiKeysInner, GetIntegrationsSummary200ResponseWebhooksInner, GetSecurity200Response, GetSecurity200ResponseAlertsInner, GetSecurity200ResponseStatsInner, GetStorage200Response, GetStorage200ResponseTopMailboxesInner, GetStorage200ResponseTopMessagesInner, GetUserInsights200Response, HealthApi, HealthzGet200Response, IpPoolsApi, ListAddOns200Response, ListCalendarEvents200Response, ListCalendarIntegrations200Response, ListCalendarMembers200Response, ListCalendars200Response, ListContactLists200Response, ListContacts200Response, ListDedicatedIPRequests200Response, ListDistributionLists200Response, ListMigrationCredentials200Response, ListMigrationEvents200Response, ListMigrationMailboxes200Response, ListMigrations200Response, ListResources200Response, ListSharedMembers200Response, ListUsers200Response, Mailbox, MailboxesApi, MapMigrationRequest, MapMigrationRequestMappingsInner, Message, MessageStats, MessageStatsCounts, MessageStatsRates, MessageStatsWindow, Migration, MigrationCredential, MigrationEvent, MigrationMailbox, MigrationProgress, MigrationProgressMailboxesInner, MigrationSettings, MigrationsApi, ModelAlias, PlanCatalogEntry, Problem, ReplaceDistributionListMembers200Response, ReplaceDistributionListMembersRequest, Resource, ResourcesApi, RotateEncryptionKeyRequest, SendApi, SendMessage, SharedMember, SignupApi, SignupRequest, StartMigration202Response, Suppression, SuppressionsApi, Template, TemplateInput, TemplatesApi, Tenant, TenantApi, TestApi, UnitBundle, UpdateCalendarEventRequest, UpdateCalendarIntegrationRequest, UpdateCalendarMemberRequest, UpdateCalendarPoliciesRequest, UpdateCalendarRequest, UpdateContactListRequest, UpdateContactRequest, UpdateDirectoryPermissionsRequest, UpdateGALSettingsRequest, UpdateMigrationMailboxRequest, UpdateMigrationRequest, UpdateResourceRequest, UpdateUserRequest, User, UserEvent, UsersApi, V1AdminLoginPost200Response, V1AdminLoginPostRequest, V1AdminMeGet200Response, V1AdminsGet200Response, V1AdminsIdPatchRequest, V1AdminsPostRequest, V1AliasesGet200Response, V1AliasesPostRequest, V1ApiKeysGet200Response, V1ApiKeysPost201Response, V1ApiKeysPostRequest, V1DomainsGet200Response, V1DomainsPostRequest, V1InboxesMailboxMessagesPostRequest, V1MailboxesEmailExportPost201Response, V1MailboxesEmailPatchRequest, V1MailboxesEmailVacationPutRequest, V1MailboxesGet200Response, V1MailboxesPostRequest, V1MessagesGet200Response, V1SendBatchPost200Response, V1SendBatchPostRequest, V1SendPost202Response, V1SendPostRequest, V1SendPostRequestAttachmentsInner, V1SuppressionsGet200Response, V1SuppressionsPostRequest, V1TemplatesGet200Response, V1UsageGet200Response, V1VacationGet200Response, V1WebhooksGet200Response, V1WebhooksIdPatchRequest, V1WebhooksPostRequest, VacationParams, VacationResponder, Webhook, WebhooksApi

Constant Summary collapse

VERSION = 
'0.1.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block. Lockally.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



237
238
239
240
241
242
243
 
# File 'lib/lockally.rb', line 237

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end