lockally 0.1.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +166 -117
- data/docs/AdminApi.md +33 -33
- data/docs/{V1AdminLoginPost200Response.md → AdminLogin200Response.md} +2 -2
- data/docs/{V1AdminLoginPostRequest.md → AdminLoginRequest.md} +2 -2
- data/docs/AdminsApi.md +76 -76
- data/docs/AgentSendResult.md +22 -0
- data/docs/AgentsApi.md +247 -247
- data/docs/AiApi.md +69 -69
- data/docs/AiConfig.md +26 -0
- data/docs/AiConfigUpdate.md +20 -0
- data/docs/AliasesApi.md +59 -59
- data/docs/ApiKeysApi.md +59 -59
- data/docs/BatchResult.md +1 -1
- data/docs/Calendar.md +8 -0
- data/docs/CalendarsApi.md +73 -0
- data/docs/ContactLookup.md +26 -0
- data/docs/ContactLookupContact.md +28 -0
- data/docs/ContactLookupHistory.md +22 -0
- data/docs/CreateAiUnitsCheckout200Response.md +22 -0
- data/docs/{V1AliasesPostRequest.md → CreateAliasRequest.md} +2 -2
- data/docs/{V1ApiKeysPost201Response.md → CreateApiKey201Response.md} +2 -2
- data/docs/CreateApiKeyRequest.md +22 -0
- data/docs/{V1DomainsPostRequest.md → CreateDomainRequest.md} +2 -2
- data/docs/{V1MailboxesPostRequest.md → CreateMailboxRequest.md} +2 -2
- data/docs/{V1SuppressionsPostRequest.md → CreateSuppressionRequest.md} +2 -2
- data/docs/{V1WebhooksPostRequest.md → CreateWebhookRequest.md} +2 -2
- data/docs/DomainsApi.md +339 -60
- data/docs/Draft.md +44 -0
- data/docs/DraftList.md +18 -0
- data/docs/DraftResult.md +26 -0
- data/docs/DraftsApi.md +115 -115
- data/docs/{V1MailboxesEmailExportPost201Response.md → ExportMailbox201Response.md} +2 -2
- data/docs/GetCalendarOverview200Response.md +34 -0
- data/docs/GetCalendarOverview200ResponseActivityInner.md +24 -0
- data/docs/{V1AdminMeGet200Response.md → GetCurrentAdmin200Response.md} +2 -2
- data/docs/{V1UsageGet200Response.md → GetUsage200Response.md} +2 -2
- data/docs/GetUserInsights200Response.md +2 -0
- data/docs/HealthApi.md +11 -11
- data/docs/{HealthzGet200Response.md → HealthCheck200Response.md} +2 -2
- data/docs/Inbox.md +24 -0
- data/docs/InboxList.md +18 -0
- data/docs/{V1AdminsPostRequest.md → InviteAdminRequest.md} +2 -2
- data/docs/{V1AdminsGet200Response.md → ListAdmins200Response.md} +2 -2
- data/docs/{V1AliasesGet200Response.md → ListAliases200Response.md} +2 -2
- data/docs/{V1ApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
- data/docs/{V1DomainsGet200Response.md → ListDomains200Response.md} +2 -2
- data/docs/{V1MailboxesGet200Response.md → ListMailboxes200Response.md} +2 -2
- data/docs/{V1MessagesGet200Response.md → ListMessages200Response.md} +2 -2
- data/docs/{V1SuppressionsGet200Response.md → ListSuppressions200Response.md} +2 -2
- data/docs/{V1TemplatesGet200Response.md → ListTemplates200Response.md} +2 -2
- data/docs/{V1VacationGet200Response.md → ListVacationResponders200Response.md} +2 -2
- data/docs/{V1WebhooksGet200Response.md → ListWebhooks200Response.md} +2 -2
- data/docs/MailboxGrant.md +20 -0
- data/docs/MailboxGrantList.md +18 -0
- data/docs/MailboxesApi.md +204 -204
- data/docs/MarkReadResult.md +18 -0
- data/docs/MessageDetail.md +52 -0
- data/docs/ReturnPath.md +28 -0
- data/docs/ReturnPathCheck.md +20 -0
- data/docs/SendApi.md +121 -121
- data/docs/SendEmail200Response.md +24 -0
- data/docs/{V1SendPost202Response.md → SendEmail202Response.md} +2 -2
- data/docs/{V1SendBatchPost200Response.md → SendEmailBatch200Response.md} +2 -2
- data/docs/{V1SendBatchPostRequest.md → SendEmailBatchRequest.md} +2 -2
- data/docs/{V1SendPostRequest.md → SendEmailRequest.md} +7 -3
- data/docs/{V1SendPostRequestAttachmentsInner.md → SendEmailRequestAttachmentsInner.md} +2 -2
- data/docs/SendMessage.md +5 -1
- data/docs/{V1MailboxesEmailVacationPutRequest.md → SetVacationResponderRequest.md} +2 -2
- data/docs/SignupApi.md +4 -4
- data/docs/SimulatedInbound.md +22 -0
- data/docs/{V1InboxesMailboxMessagesPostRequest.md → StartConversationRequest.md} +2 -2
- data/docs/SuppressionsApi.md +75 -75
- data/docs/TemplatesApi.md +67 -67
- data/docs/TenantApi.md +20 -20
- data/docs/TestApi.md +11 -11
- data/docs/Thread.md +22 -0
- data/docs/ThreadClassification.md +22 -0
- data/docs/ThreadList.md +20 -0
- data/docs/ThreadMessage.md +40 -0
- data/docs/ThreadMessageBody.md +42 -0
- data/docs/ThreadMessageBodyAllOfBody.md +22 -0
- data/docs/ThreadSummary.md +28 -0
- data/docs/{V1AdminsIdPatchRequest.md → UpdateAdminRequest.md} +2 -2
- data/docs/{V1MailboxesEmailPatchRequest.md → UpdateMailboxRequest.md} +2 -2
- data/docs/{V1WebhooksIdPatchRequest.md → UpdateWebhookRequest.md} +2 -2
- data/docs/WebhooksApi.md +63 -63
- data/docs/Whoami.md +24 -0
- data/lib/lockally/api/add_ons_api.rb +1 -1
- data/lib/lockally/api/admin_api.rb +31 -31
- data/lib/lockally/api/admins_api.rb +90 -90
- data/lib/lockally/api/agents_api.rb +310 -310
- data/lib/lockally/api/ai_api.rb +70 -70
- data/lib/lockally/api/aliases_api.rb +65 -65
- data/lib/lockally/api/api_keys_api.rb +67 -67
- data/lib/lockally/api/billing_api.rb +1 -1
- data/lib/lockally/api/calendars_api.rb +64 -1
- data/lib/lockally/api/contact_lists_api.rb +1 -1
- data/lib/lockally/api/contacts_api.rb +1 -1
- data/lib/lockally/api/dashboard_api.rb +1 -1
- data/lib/lockally/api/directory_api.rb +1 -1
- data/lib/lockally/api/distribution_lists_api.rb +1 -1
- data/lib/lockally/api/domains_api.rb +314 -62
- data/lib/lockally/api/drafts_api.rb +141 -141
- data/lib/lockally/api/encryption_api.rb +1 -1
- data/lib/lockally/api/health_api.rb +10 -10
- data/lib/lockally/api/ip_pools_api.rb +1 -1
- data/lib/lockally/api/mailboxes_api.rb +236 -236
- data/lib/lockally/api/migrations_api.rb +1 -1
- data/lib/lockally/api/resources_api.rb +1 -1
- data/lib/lockally/api/send_api.rb +147 -147
- data/lib/lockally/api/signup_api.rb +4 -4
- data/lib/lockally/api/suppressions_api.rb +88 -88
- data/lib/lockally/api/templates_api.rb +70 -70
- data/lib/lockally/api/tenant_api.rb +16 -16
- data/lib/lockally/api/test_api.rb +10 -10
- data/lib/lockally/api/users_api.rb +1 -1
- data/lib/lockally/api/webhooks_api.rb +74 -74
- data/lib/lockally/api_client.rb +1 -1
- data/lib/lockally/api_error.rb +1 -1
- data/lib/lockally/api_model_base.rb +1 -1
- data/lib/lockally/configuration.rb +1 -1
- data/lib/lockally/models/activate_add_on200_response.rb +1 -1
- data/lib/lockally/models/add_calendar_member_request.rb +1 -1
- data/lib/lockally/models/add_contact_list_member_request.rb +1 -1
- data/lib/lockally/models/add_on.rb +1 -1
- data/lib/lockally/models/add_shared_member_request.rb +1 -1
- data/lib/lockally/models/admin.rb +1 -1
- data/lib/lockally/models/admin_full.rb +1 -1
- data/lib/lockally/models/{v1_admin_login_post200_response.rb → admin_login200_response.rb} +4 -4
- data/lib/lockally/models/{v1_admin_login_post_request.rb → admin_login_request.rb} +4 -4
- data/lib/lockally/models/agent_send_result.rb +184 -0
- data/lib/lockally/models/ai_config.rb +242 -0
- data/lib/lockally/models/ai_config_update.rb +214 -0
- data/lib/lockally/models/api_key.rb +1 -1
- data/lib/lockally/models/audit_event.rb +1 -1
- data/lib/lockally/models/batch_lookup_public_keys200_response.rb +1 -1
- data/lib/lockally/models/batch_lookup_public_keys200_response_data_inner.rb +1 -1
- data/lib/lockally/models/batch_result.rb +4 -3
- data/lib/lockally/models/billing_status.rb +1 -1
- data/lib/lockally/models/calendar.rb +68 -4
- data/lib/lockally/models/calendar_event.rb +1 -1
- data/lib/lockally/models/calendar_integration.rb +1 -1
- data/lib/lockally/models/calendar_member.rb +1 -1
- data/lib/lockally/models/calendar_policies.rb +1 -1
- data/lib/lockally/models/contact.rb +1 -1
- data/lib/lockally/models/contact_list.rb +1 -1
- data/lib/lockally/models/contact_lookup.rb +235 -0
- data/lib/lockally/models/contact_lookup_contact.rb +192 -0
- data/lib/lockally/models/contact_lookup_history.rb +166 -0
- data/lib/lockally/models/create_ai_units_checkout200_response.rb +199 -0
- data/lib/lockally/models/{v1_aliases_post_request.rb → create_alias_request.rb} +4 -4
- data/lib/lockally/models/{v1_api_keys_post201_response.rb → create_api_key201_response.rb} +4 -4
- data/lib/lockally/models/{v1_api_keys_post_request.rb → create_api_key_request.rb} +20 -8
- data/lib/lockally/models/create_billing_checkout200_response.rb +1 -1
- data/lib/lockally/models/create_billing_checkout_request.rb +1 -1
- data/lib/lockally/models/create_calendar_event_request.rb +1 -1
- data/lib/lockally/models/create_calendar_integration_request.rb +1 -1
- data/lib/lockally/models/create_calendar_request.rb +1 -1
- data/lib/lockally/models/create_contact_list_request.rb +1 -1
- data/lib/lockally/models/create_contact_request.rb +1 -1
- data/lib/lockally/models/create_dedicated_ip_request_request.rb +1 -1
- data/lib/lockally/models/create_distribution_list_request.rb +1 -1
- data/lib/lockally/models/{v1_domains_post_request.rb → create_domain_request.rb} +4 -4
- data/lib/lockally/models/create_encryption_key201_response.rb +1 -1
- data/lib/lockally/models/create_encryption_key_request.rb +1 -1
- data/lib/lockally/models/create_encryption_recovery_request.rb +1 -1
- data/lib/lockally/models/{v1_mailboxes_post_request.rb → create_mailbox_request.rb} +4 -4
- data/lib/lockally/models/create_migration_credential_request.rb +1 -1
- data/lib/lockally/models/create_migration_credential_request_credentials.rb +1 -1
- data/lib/lockally/models/create_migration_request.rb +1 -1
- data/lib/lockally/models/create_resource_request.rb +1 -1
- data/lib/lockally/models/{v1_suppressions_post_request.rb → create_suppression_request.rb} +4 -4
- data/lib/lockally/models/create_units_checkout200_response.rb +1 -1
- data/lib/lockally/models/create_units_checkout_request.rb +1 -1
- data/lib/lockally/models/create_user_request.rb +1 -1
- data/lib/lockally/models/{v1_webhooks_post_request.rb → create_webhook_request.rb} +4 -4
- data/lib/lockally/models/dedicated_ip_request.rb +1 -1
- data/lib/lockally/models/directory_permissions.rb +1 -1
- data/lib/lockally/models/discover_migration202_response.rb +1 -1
- data/lib/lockally/models/distribution_list_detail.rb +1 -1
- data/lib/lockally/models/distribution_list_summary.rb +1 -1
- data/lib/lockally/models/dns_record.rb +1 -1
- data/lib/lockally/models/domain.rb +1 -1
- data/lib/lockally/models/draft.rb +413 -0
- data/lib/lockally/models/draft_list.rb +166 -0
- data/lib/lockally/models/draft_result.rb +260 -0
- data/lib/lockally/models/{v1_mailboxes_email_export_post201_response.rb → export_mailbox201_response.rb} +4 -4
- data/lib/lockally/models/gal_settings.rb +1 -1
- data/lib/lockally/models/get_add_on_status200_response.rb +1 -1
- data/lib/lockally/models/get_audit_summary200_response.rb +1 -1
- data/lib/lockally/models/get_calendar_overview200_response.rb +228 -0
- data/lib/lockally/models/get_calendar_overview200_response_activity_inner.rb +174 -0
- data/lib/lockally/models/get_calendar_security200_response.rb +1 -1
- data/lib/lockally/models/get_calendar_security200_response_alerts_inner.rb +1 -1
- data/lib/lockally/models/get_calendar_security200_response_delegated_access_inner.rb +1 -1
- data/lib/lockally/models/get_calendar_security200_response_external_sharing.rb +1 -1
- data/lib/lockally/models/get_calendar_security200_response_public_calendar_list_inner.rb +1 -1
- data/lib/lockally/models/get_contact_list200_response.rb +1 -1
- data/lib/lockally/models/get_contact_list200_response_members_inner.rb +1 -1
- data/lib/lockally/models/get_contact_lists200_response.rb +1 -1
- data/lib/lockally/models/get_contact_lists200_response_data_inner.rb +1 -1
- data/lib/lockally/models/{v1_admin_me_get200_response.rb → get_current_admin200_response.rb} +4 -4
- data/lib/lockally/models/get_directory_activity200_response.rb +1 -1
- data/lib/lockally/models/get_directory_activity200_response_data_inner.rb +1 -1
- data/lib/lockally/models/get_directory_stats200_response.rb +1 -1
- data/lib/lockally/models/get_domains_status200_response.rb +1 -1
- data/lib/lockally/models/get_domains_status200_response_domains_inner.rb +1 -1
- data/lib/lockally/models/get_domains_status200_response_domains_inner_checks_inner.rb +1 -1
- data/lib/lockally/models/get_encryption_key200_response.rb +1 -1
- data/lib/lockally/models/get_integrations_summary200_response.rb +1 -1
- data/lib/lockally/models/get_integrations_summary200_response_api_keys_inner.rb +1 -1
- data/lib/lockally/models/get_integrations_summary200_response_webhooks_inner.rb +1 -1
- data/lib/lockally/models/get_ip_assignment200_response.rb +1 -1
- data/lib/lockally/models/get_security200_response.rb +1 -1
- data/lib/lockally/models/get_security200_response_alerts_inner.rb +1 -1
- data/lib/lockally/models/get_security200_response_stats_inner.rb +1 -1
- data/lib/lockally/models/get_storage200_response.rb +1 -1
- data/lib/lockally/models/get_storage200_response_top_mailboxes_inner.rb +1 -1
- data/lib/lockally/models/get_storage200_response_top_messages_inner.rb +1 -1
- data/lib/lockally/models/{v1_usage_get200_response.rb → get_usage200_response.rb} +4 -4
- data/lib/lockally/models/get_user_insights200_response.rb +12 -2
- data/lib/lockally/models/{healthz_get200_response.rb → health_check200_response.rb} +4 -4
- data/lib/lockally/models/inbox.rb +225 -0
- data/lib/lockally/models/inbox_list.rb +166 -0
- data/lib/lockally/models/{v1_admins_post_request.rb → invite_admin_request.rb} +4 -4
- data/lib/lockally/models/list_add_ons200_response.rb +1 -1
- data/lib/lockally/models/{v1_api_keys_get200_response.rb → list_admins200_response.rb} +5 -5
- data/lib/lockally/models/list_aliases200_response.rb +166 -0
- data/lib/lockally/models/{v1_admins_get200_response.rb → list_api_keys200_response.rb} +5 -5
- data/lib/lockally/models/list_calendar_events200_response.rb +1 -1
- data/lib/lockally/models/list_calendar_integrations200_response.rb +1 -1
- data/lib/lockally/models/list_calendar_members200_response.rb +1 -1
- data/lib/lockally/models/list_calendars200_response.rb +1 -1
- data/lib/lockally/models/list_contact_lists200_response.rb +1 -1
- data/lib/lockally/models/list_contacts200_response.rb +1 -1
- data/lib/lockally/models/list_dedicated_ip_requests200_response.rb +1 -1
- data/lib/lockally/models/list_distribution_lists200_response.rb +1 -1
- data/lib/lockally/models/{v1_domains_get200_response.rb → list_domains200_response.rb} +4 -4
- data/lib/lockally/models/{v1_mailboxes_get200_response.rb → list_mailboxes200_response.rb} +4 -4
- data/lib/lockally/models/{v1_messages_get200_response.rb → list_messages200_response.rb} +4 -4
- data/lib/lockally/models/list_migration_credentials200_response.rb +1 -1
- data/lib/lockally/models/list_migration_events200_response.rb +1 -1
- data/lib/lockally/models/list_migration_mailboxes200_response.rb +1 -1
- data/lib/lockally/models/list_migrations200_response.rb +1 -1
- data/lib/lockally/models/list_resources200_response.rb +1 -1
- data/lib/lockally/models/list_shared_members200_response.rb +1 -1
- data/lib/lockally/models/{v1_suppressions_get200_response.rb → list_suppressions200_response.rb} +4 -4
- data/lib/lockally/models/{v1_send_batch_post200_response.rb → list_templates200_response.rb} +5 -5
- data/lib/lockally/models/list_users200_response.rb +1 -1
- data/lib/lockally/models/{v1_vacation_get200_response.rb → list_vacation_responders200_response.rb} +4 -4
- data/lib/lockally/models/{v1_aliases_get200_response.rb → list_webhooks200_response.rb} +5 -5
- data/lib/lockally/models/mailbox.rb +1 -1
- data/lib/lockally/models/mailbox_grant.rb +156 -0
- data/lib/lockally/models/mailbox_grant_list.rb +166 -0
- data/lib/lockally/models/map_migration_request.rb +1 -1
- data/lib/lockally/models/map_migration_request_mappings_inner.rb +1 -1
- data/lib/lockally/models/mark_read_result.rb +147 -0
- data/lib/lockally/models/message.rb +1 -1
- data/lib/lockally/models/message_detail.rb +479 -0
- data/lib/lockally/models/message_stats.rb +1 -1
- data/lib/lockally/models/message_stats_counts.rb +1 -1
- data/lib/lockally/models/message_stats_rates.rb +1 -1
- data/lib/lockally/models/message_stats_window.rb +1 -1
- data/lib/lockally/models/migration.rb +1 -1
- data/lib/lockally/models/migration_credential.rb +1 -1
- data/lib/lockally/models/migration_event.rb +1 -1
- data/lib/lockally/models/migration_mailbox.rb +1 -1
- data/lib/lockally/models/migration_progress.rb +1 -1
- data/lib/lockally/models/migration_progress_mailboxes_inner.rb +1 -1
- data/lib/lockally/models/migration_settings.rb +1 -1
- data/lib/lockally/models/model_alias.rb +1 -1
- data/lib/lockally/models/plan_catalog_entry.rb +1 -1
- data/lib/lockally/models/problem.rb +1 -1
- data/lib/lockally/models/replace_distribution_list_members200_response.rb +1 -1
- data/lib/lockally/models/replace_distribution_list_members_request.rb +1 -1
- data/lib/lockally/models/resource.rb +1 -1
- data/lib/lockally/models/return_path.rb +269 -0
- data/lib/lockally/models/return_path_check.rb +157 -0
- data/lib/lockally/models/rotate_encryption_key_request.rb +1 -1
- data/lib/lockally/models/send_email200_response.rb +218 -0
- data/lib/lockally/models/{v1_send_post202_response.rb → send_email202_response.rb} +4 -4
- data/lib/lockally/models/{v1_templates_get200_response.rb → send_email_batch200_response.rb} +5 -5
- data/lib/lockally/models/{v1_send_batch_post_request.rb → send_email_batch_request.rb} +4 -4
- data/lib/lockally/models/{v1_send_post_request.rb → send_email_request.rb} +26 -6
- data/lib/lockally/models/{v1_send_post_request_attachments_inner.rb → send_email_request_attachments_inner.rb} +4 -4
- data/lib/lockally/models/send_message.rb +23 -3
- data/lib/lockally/models/{v1_mailboxes_email_vacation_put_request.rb → set_vacation_responder_request.rb} +4 -4
- data/lib/lockally/models/shared_member.rb +1 -1
- data/lib/lockally/models/signup_request.rb +1 -1
- data/lib/lockally/models/simulated_inbound.rb +167 -0
- data/lib/lockally/models/{v1_inboxes_mailbox_messages_post_request.rb → start_conversation_request.rb} +4 -4
- data/lib/lockally/models/start_migration202_response.rb +1 -1
- data/lib/lockally/models/suppression.rb +1 -1
- data/lib/lockally/models/template.rb +1 -1
- data/lib/lockally/models/template_input.rb +1 -1
- data/lib/lockally/models/tenant.rb +1 -1
- data/lib/lockally/models/thread.rb +219 -0
- data/lib/lockally/models/thread_classification.rb +186 -0
- data/lib/lockally/models/thread_list.rb +192 -0
- data/lib/lockally/models/thread_message.rb +397 -0
- data/lib/lockally/models/thread_message_body.rb +413 -0
- data/lib/lockally/models/thread_message_body_all_of_body.rb +165 -0
- data/lib/lockally/models/thread_summary.rb +280 -0
- data/lib/lockally/models/unit_bundle.rb +1 -1
- data/lib/lockally/models/{v1_admins_id_patch_request.rb → update_admin_request.rb} +4 -4
- data/lib/lockally/models/update_calendar_event_request.rb +1 -1
- data/lib/lockally/models/update_calendar_integration_request.rb +1 -1
- data/lib/lockally/models/update_calendar_member_request.rb +1 -1
- data/lib/lockally/models/update_calendar_policies_request.rb +1 -1
- data/lib/lockally/models/update_calendar_request.rb +1 -1
- data/lib/lockally/models/update_contact_list_request.rb +1 -1
- data/lib/lockally/models/update_contact_request.rb +1 -1
- data/lib/lockally/models/update_directory_permissions_request.rb +1 -1
- data/lib/lockally/models/update_gal_settings_request.rb +1 -1
- data/lib/lockally/models/{v1_mailboxes_email_patch_request.rb → update_mailbox_request.rb} +4 -4
- data/lib/lockally/models/update_migration_mailbox_request.rb +1 -1
- data/lib/lockally/models/update_migration_request.rb +1 -1
- data/lib/lockally/models/update_resource_request.rb +1 -1
- data/lib/lockally/models/update_user_request.rb +1 -1
- data/lib/lockally/models/{v1_webhooks_id_patch_request.rb → update_webhook_request.rb} +4 -4
- data/lib/lockally/models/user.rb +1 -1
- data/lib/lockally/models/user_event.rb +1 -1
- data/lib/lockally/models/vacation_params.rb +1 -1
- data/lib/lockally/models/vacation_responder.rb +1 -1
- data/lib/lockally/models/webhook.rb +1 -1
- data/lib/lockally/models/whoami.rb +177 -0
- data/lib/lockally/version.rb +2 -2
- data/lib/lockally.rb +65 -35
- data/lockally.gemspec +2 -2
- data/spec/api/add_ons_api_spec.rb +1 -1
- data/spec/api/admin_api_spec.rb +10 -10
- data/spec/api/admins_api_spec.rb +23 -23
- data/spec/api/agents_api_spec.rb +79 -79
- data/spec/api/ai_api_spec.rb +23 -23
- data/spec/api/aliases_api_spec.rb +17 -17
- data/spec/api/api_keys_api_spec.rb +18 -18
- data/spec/api/billing_api_spec.rb +1 -1
- data/spec/api/calendars_api_spec.rb +15 -1
- data/spec/api/contact_lists_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +1 -1
- data/spec/api/dashboard_api_spec.rb +1 -1
- data/spec/api/directory_api_spec.rb +1 -1
- data/spec/api/distribution_lists_api_spec.rb +1 -1
- data/spec/api/domains_api_spec.rb +66 -18
- data/spec/api/drafts_api_spec.rb +39 -39
- data/spec/api/encryption_api_spec.rb +1 -1
- data/spec/api/health_api_spec.rb +4 -4
- data/spec/api/ip_pools_api_spec.rb +1 -1
- data/spec/api/mailboxes_api_spec.rb +63 -63
- data/spec/api/migrations_api_spec.rb +1 -1
- data/spec/api/resources_api_spec.rb +1 -1
- data/spec/api/send_api_spec.rb +37 -37
- data/spec/api/signup_api_spec.rb +2 -2
- data/spec/api/suppressions_api_spec.rb +19 -19
- data/spec/api/templates_api_spec.rb +18 -18
- data/spec/api/tenant_api_spec.rb +6 -6
- data/spec/api/test_api_spec.rb +4 -4
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +20 -20
- data/spec/models/activate_add_on200_response_spec.rb +1 -1
- data/spec/models/add_calendar_member_request_spec.rb +1 -1
- data/spec/models/add_contact_list_member_request_spec.rb +1 -1
- data/spec/models/add_on_spec.rb +1 -1
- data/spec/models/add_shared_member_request_spec.rb +1 -1
- data/spec/models/admin_full_spec.rb +1 -1
- data/spec/models/{v1_admin_login_post200_response_spec.rb → admin_login200_response_spec.rb} +7 -7
- data/spec/models/{v1_admin_login_post_request_spec.rb → admin_login_request_spec.rb} +7 -7
- data/spec/models/admin_spec.rb +1 -1
- data/spec/models/agent_send_result_spec.rb +48 -0
- data/spec/models/ai_config_spec.rb +64 -0
- data/spec/models/{v1_api_keys_post_request_spec.rb → ai_config_update_spec.rb} +13 -13
- data/spec/models/api_key_spec.rb +1 -1
- data/spec/models/audit_event_spec.rb +1 -1
- data/spec/models/batch_lookup_public_keys200_response_data_inner_spec.rb +1 -1
- data/spec/models/batch_lookup_public_keys200_response_spec.rb +1 -1
- data/spec/models/batch_result_spec.rb +2 -2
- data/spec/models/billing_status_spec.rb +1 -1
- data/spec/models/calendar_event_spec.rb +1 -1
- data/spec/models/calendar_integration_spec.rb +1 -1
- data/spec/models/calendar_member_spec.rb +1 -1
- data/spec/models/calendar_policies_spec.rb +1 -1
- data/spec/models/calendar_spec.rb +34 -2
- data/spec/models/contact_list_spec.rb +1 -1
- data/spec/models/contact_lookup_contact_spec.rb +66 -0
- data/spec/models/contact_lookup_history_spec.rb +48 -0
- data/spec/models/contact_lookup_spec.rb +60 -0
- data/spec/models/contact_spec.rb +1 -1
- data/spec/models/create_ai_units_checkout200_response_spec.rb +48 -0
- data/spec/models/{v1_aliases_post_request_spec.rb → create_alias_request_spec.rb} +7 -7
- data/spec/models/{v1_api_keys_post201_response_spec.rb → create_api_key201_response_spec.rb} +7 -7
- data/spec/models/create_api_key_request_spec.rb +52 -0
- data/spec/models/create_billing_checkout200_response_spec.rb +1 -1
- data/spec/models/create_billing_checkout_request_spec.rb +1 -1
- data/spec/models/create_calendar_event_request_spec.rb +1 -1
- data/spec/models/create_calendar_integration_request_spec.rb +1 -1
- data/spec/models/create_calendar_request_spec.rb +1 -1
- data/spec/models/create_contact_list_request_spec.rb +1 -1
- data/spec/models/create_contact_request_spec.rb +1 -1
- data/spec/models/create_dedicated_ip_request_request_spec.rb +1 -1
- data/spec/models/create_distribution_list_request_spec.rb +1 -1
- data/spec/models/{v1_domains_post_request_spec.rb → create_domain_request_spec.rb} +7 -7
- data/spec/models/create_encryption_key201_response_spec.rb +1 -1
- data/spec/models/create_encryption_key_request_spec.rb +1 -1
- data/spec/models/create_encryption_recovery_request_spec.rb +1 -1
- data/spec/models/{v1_mailboxes_post_request_spec.rb → create_mailbox_request_spec.rb} +7 -7
- data/spec/models/create_migration_credential_request_credentials_spec.rb +1 -1
- data/spec/models/create_migration_credential_request_spec.rb +1 -1
- data/spec/models/create_migration_request_spec.rb +1 -1
- data/spec/models/create_resource_request_spec.rb +1 -1
- data/spec/models/{v1_suppressions_post_request_spec.rb → create_suppression_request_spec.rb} +7 -7
- data/spec/models/create_units_checkout200_response_spec.rb +1 -1
- data/spec/models/create_units_checkout_request_spec.rb +1 -1
- data/spec/models/create_user_request_spec.rb +1 -1
- data/spec/models/{v1_webhooks_post_request_spec.rb → create_webhook_request_spec.rb} +7 -7
- data/spec/models/dedicated_ip_request_spec.rb +1 -1
- data/spec/models/directory_permissions_spec.rb +1 -1
- data/spec/models/discover_migration202_response_spec.rb +1 -1
- data/spec/models/distribution_list_detail_spec.rb +1 -1
- data/spec/models/distribution_list_summary_spec.rb +1 -1
- data/spec/models/dns_record_spec.rb +1 -1
- data/spec/models/domain_spec.rb +1 -1
- data/spec/models/{v1_aliases_get200_response_spec.rb → draft_list_spec.rb} +8 -8
- data/spec/models/draft_result_spec.rb +64 -0
- data/spec/models/draft_spec.rb +118 -0
- data/spec/models/{v1_mailboxes_email_export_post201_response_spec.rb → export_mailbox201_response_spec.rb} +7 -7
- data/spec/models/gal_settings_spec.rb +1 -1
- data/spec/models/get_add_on_status200_response_spec.rb +1 -1
- data/spec/models/get_audit_summary200_response_spec.rb +1 -1
- data/spec/models/get_calendar_overview200_response_activity_inner_spec.rb +54 -0
- data/spec/models/get_calendar_overview200_response_spec.rb +84 -0
- data/spec/models/get_calendar_security200_response_alerts_inner_spec.rb +1 -1
- data/spec/models/get_calendar_security200_response_delegated_access_inner_spec.rb +1 -1
- data/spec/models/get_calendar_security200_response_external_sharing_spec.rb +1 -1
- data/spec/models/get_calendar_security200_response_public_calendar_list_inner_spec.rb +1 -1
- data/spec/models/get_calendar_security200_response_spec.rb +1 -1
- data/spec/models/get_contact_list200_response_members_inner_spec.rb +1 -1
- data/spec/models/get_contact_list200_response_spec.rb +1 -1
- data/spec/models/get_contact_lists200_response_data_inner_spec.rb +1 -1
- data/spec/models/get_contact_lists200_response_spec.rb +1 -1
- data/spec/models/{v1_admin_me_get200_response_spec.rb → get_current_admin200_response_spec.rb} +7 -7
- data/spec/models/get_directory_activity200_response_data_inner_spec.rb +1 -1
- data/spec/models/get_directory_activity200_response_spec.rb +1 -1
- data/spec/models/get_directory_stats200_response_spec.rb +1 -1
- data/spec/models/get_domains_status200_response_domains_inner_checks_inner_spec.rb +1 -1
- data/spec/models/get_domains_status200_response_domains_inner_spec.rb +1 -1
- data/spec/models/get_domains_status200_response_spec.rb +1 -1
- data/spec/models/get_encryption_key200_response_spec.rb +1 -1
- data/spec/models/get_integrations_summary200_response_api_keys_inner_spec.rb +1 -1
- data/spec/models/get_integrations_summary200_response_spec.rb +1 -1
- data/spec/models/get_integrations_summary200_response_webhooks_inner_spec.rb +1 -1
- data/spec/models/get_ip_assignment200_response_spec.rb +1 -1
- data/spec/models/get_security200_response_alerts_inner_spec.rb +1 -1
- data/spec/models/get_security200_response_spec.rb +1 -1
- data/spec/models/get_security200_response_stats_inner_spec.rb +1 -1
- data/spec/models/get_storage200_response_spec.rb +1 -1
- data/spec/models/get_storage200_response_top_mailboxes_inner_spec.rb +1 -1
- data/spec/models/get_storage200_response_top_messages_inner_spec.rb +1 -1
- data/spec/models/{v1_usage_get200_response_spec.rb → get_usage200_response_spec.rb} +7 -7
- data/spec/models/get_user_insights200_response_spec.rb +7 -1
- data/spec/models/{healthz_get200_response_spec.rb → health_check200_response_spec.rb} +7 -7
- data/spec/models/inbox_list_spec.rb +36 -0
- data/spec/models/inbox_spec.rb +54 -0
- data/spec/models/{v1_admins_post_request_spec.rb → invite_admin_request_spec.rb} +7 -7
- data/spec/models/list_add_ons200_response_spec.rb +1 -1
- data/spec/models/list_admins200_response_spec.rb +36 -0
- data/spec/models/{v1_admins_get200_response_spec.rb → list_aliases200_response_spec.rb} +7 -7
- data/spec/models/{v1_api_keys_get200_response_spec.rb → list_api_keys200_response_spec.rb} +7 -7
- data/spec/models/list_calendar_events200_response_spec.rb +1 -1
- data/spec/models/list_calendar_integrations200_response_spec.rb +1 -1
- data/spec/models/list_calendar_members200_response_spec.rb +1 -1
- data/spec/models/list_calendars200_response_spec.rb +1 -1
- data/spec/models/list_contact_lists200_response_spec.rb +1 -1
- data/spec/models/list_contacts200_response_spec.rb +1 -1
- data/spec/models/list_dedicated_ip_requests200_response_spec.rb +1 -1
- data/spec/models/list_distribution_lists200_response_spec.rb +1 -1
- data/spec/models/list_domains200_response_spec.rb +36 -0
- data/spec/models/{v1_mailboxes_get200_response_spec.rb → list_mailboxes200_response_spec.rb} +7 -7
- data/spec/models/{v1_suppressions_get200_response_spec.rb → list_messages200_response_spec.rb} +7 -7
- data/spec/models/list_migration_credentials200_response_spec.rb +1 -1
- data/spec/models/list_migration_events200_response_spec.rb +1 -1
- data/spec/models/list_migration_mailboxes200_response_spec.rb +1 -1
- data/spec/models/list_migrations200_response_spec.rb +1 -1
- data/spec/models/list_resources200_response_spec.rb +1 -1
- data/spec/models/list_shared_members200_response_spec.rb +1 -1
- data/spec/models/{v1_messages_get200_response_spec.rb → list_suppressions200_response_spec.rb} +7 -7
- data/spec/models/{v1_vacation_get200_response_spec.rb → list_templates200_response_spec.rb} +7 -7
- data/spec/models/list_users200_response_spec.rb +1 -1
- data/spec/models/list_vacation_responders200_response_spec.rb +36 -0
- data/spec/models/{v1_domains_get200_response_spec.rb → list_webhooks200_response_spec.rb} +7 -7
- data/spec/models/mailbox_grant_list_spec.rb +36 -0
- data/spec/models/mailbox_grant_spec.rb +42 -0
- data/spec/models/mailbox_spec.rb +1 -1
- data/spec/models/map_migration_request_mappings_inner_spec.rb +1 -1
- data/spec/models/map_migration_request_spec.rb +1 -1
- data/spec/models/mark_read_result_spec.rb +36 -0
- data/spec/models/message_detail_spec.rb +142 -0
- data/spec/models/message_spec.rb +1 -1
- data/spec/models/message_stats_counts_spec.rb +1 -1
- data/spec/models/message_stats_rates_spec.rb +1 -1
- data/spec/models/message_stats_spec.rb +1 -1
- data/spec/models/message_stats_window_spec.rb +1 -1
- data/spec/models/migration_credential_spec.rb +1 -1
- data/spec/models/migration_event_spec.rb +1 -1
- data/spec/models/migration_mailbox_spec.rb +1 -1
- data/spec/models/migration_progress_mailboxes_inner_spec.rb +1 -1
- data/spec/models/migration_progress_spec.rb +1 -1
- data/spec/models/migration_settings_spec.rb +1 -1
- data/spec/models/migration_spec.rb +1 -1
- data/spec/models/model_alias_spec.rb +1 -1
- data/spec/models/plan_catalog_entry_spec.rb +1 -1
- data/spec/models/problem_spec.rb +1 -1
- data/spec/models/replace_distribution_list_members200_response_spec.rb +1 -1
- data/spec/models/replace_distribution_list_members_request_spec.rb +1 -1
- data/spec/models/resource_spec.rb +1 -1
- data/spec/models/return_path_check_spec.rb +42 -0
- data/spec/models/return_path_spec.rb +70 -0
- data/spec/models/rotate_encryption_key_request_spec.rb +1 -1
- data/spec/models/send_email200_response_spec.rb +58 -0
- data/spec/models/{v1_send_post202_response_spec.rb → send_email202_response_spec.rb} +7 -7
- data/spec/models/{v1_templates_get200_response_spec.rb → send_email_batch200_response_spec.rb} +7 -7
- data/spec/models/{v1_send_batch_post_request_spec.rb → send_email_batch_request_spec.rb} +7 -7
- data/spec/models/{v1_send_post_request_attachments_inner_spec.rb → send_email_request_attachments_inner_spec.rb} +7 -7
- data/spec/models/{v1_send_post_request_spec.rb → send_email_request_spec.rb} +19 -7
- data/spec/models/send_message_spec.rb +13 -1
- data/spec/models/{v1_mailboxes_email_vacation_put_request_spec.rb → set_vacation_responder_request_spec.rb} +7 -7
- data/spec/models/shared_member_spec.rb +1 -1
- data/spec/models/signup_request_spec.rb +1 -1
- data/spec/models/simulated_inbound_spec.rb +48 -0
- data/spec/models/{v1_inboxes_mailbox_messages_post_request_spec.rb → start_conversation_request_spec.rb} +7 -7
- data/spec/models/start_migration202_response_spec.rb +1 -1
- data/spec/models/suppression_spec.rb +1 -1
- data/spec/models/template_input_spec.rb +1 -1
- data/spec/models/template_spec.rb +1 -1
- data/spec/models/tenant_spec.rb +1 -1
- data/spec/models/thread_classification_spec.rb +48 -0
- data/spec/models/thread_list_spec.rb +42 -0
- data/spec/models/thread_message_body_all_of_body_spec.rb +48 -0
- data/spec/models/thread_message_body_spec.rb +112 -0
- data/spec/models/thread_message_spec.rb +106 -0
- data/spec/models/thread_spec.rb +48 -0
- data/spec/models/thread_summary_spec.rb +70 -0
- data/spec/models/unit_bundle_spec.rb +1 -1
- data/spec/models/{v1_admins_id_patch_request_spec.rb → update_admin_request_spec.rb} +7 -7
- data/spec/models/update_calendar_event_request_spec.rb +1 -1
- data/spec/models/update_calendar_integration_request_spec.rb +1 -1
- data/spec/models/update_calendar_member_request_spec.rb +1 -1
- data/spec/models/update_calendar_policies_request_spec.rb +1 -1
- data/spec/models/update_calendar_request_spec.rb +1 -1
- data/spec/models/update_contact_list_request_spec.rb +1 -1
- data/spec/models/update_contact_request_spec.rb +1 -1
- data/spec/models/update_directory_permissions_request_spec.rb +1 -1
- data/spec/models/update_gal_settings_request_spec.rb +1 -1
- data/spec/models/{v1_mailboxes_email_patch_request_spec.rb → update_mailbox_request_spec.rb} +7 -7
- data/spec/models/update_migration_mailbox_request_spec.rb +1 -1
- data/spec/models/update_migration_request_spec.rb +1 -1
- data/spec/models/update_resource_request_spec.rb +1 -1
- data/spec/models/update_user_request_spec.rb +1 -1
- data/spec/models/{v1_webhooks_id_patch_request_spec.rb → update_webhook_request_spec.rb} +7 -7
- data/spec/models/user_event_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/vacation_params_spec.rb +1 -1
- data/spec/models/vacation_responder_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/whoami_spec.rb +54 -0
- data/spec/spec_helper.rb +1 -1
- metadata +408 -285
- data/docs/V1ApiKeysPostRequest.md +0 -20
- data/lib/lockally/models/v1_webhooks_get200_response.rb +0 -166
- data/spec/models/v1_send_batch_post200_response_spec.rb +0 -36
- data/spec/models/v1_webhooks_get200_response_spec.rb +0 -36
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#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
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -19,20 +19,26 @@ module Lockally
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
#
|
|
22
|
+
# Create a template
|
|
23
|
+
# @param template_input [TemplateInput]
|
|
23
24
|
# @param [Hash] opts the optional parameters
|
|
24
|
-
# @return [
|
|
25
|
-
def
|
|
26
|
-
data, _status_code, _headers =
|
|
25
|
+
# @return [Template]
|
|
26
|
+
def create_template(template_input, opts = {})
|
|
27
|
+
data, _status_code, _headers = create_template_with_http_info(template_input, opts)
|
|
27
28
|
data
|
|
28
29
|
end
|
|
29
30
|
|
|
30
|
-
#
|
|
31
|
+
# Create a template
|
|
32
|
+
# @param template_input [TemplateInput]
|
|
31
33
|
# @param [Hash] opts the optional parameters
|
|
32
|
-
# @return [Array<(
|
|
33
|
-
def
|
|
34
|
+
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
35
|
+
def create_template_with_http_info(template_input, opts = {})
|
|
34
36
|
if @api_client.config.debugging
|
|
35
|
-
@api_client.config.logger.debug 'Calling API: TemplatesApi.
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: TemplatesApi.create_template ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'template_input' is set
|
|
40
|
+
if @api_client.config.client_side_validation && template_input.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'template_input' when calling TemplatesApi.create_template"
|
|
36
42
|
end
|
|
37
43
|
# resource path
|
|
38
44
|
local_var_path = '/v1/templates'
|
|
@@ -44,21 +50,26 @@ module Lockally
|
|
|
44
50
|
header_params = opts[:header_params] || {}
|
|
45
51
|
# HTTP header 'Accept' (if needed)
|
|
46
52
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
53
|
+
# HTTP header 'Content-Type'
|
|
54
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
55
|
+
if !content_type.nil?
|
|
56
|
+
header_params['Content-Type'] = content_type
|
|
57
|
+
end
|
|
47
58
|
|
|
48
59
|
# form parameters
|
|
49
60
|
form_params = opts[:form_params] || {}
|
|
50
61
|
|
|
51
62
|
# http body (model)
|
|
52
|
-
post_body = opts[:debug_body]
|
|
63
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(template_input)
|
|
53
64
|
|
|
54
65
|
# return_type
|
|
55
|
-
return_type = opts[:debug_return_type] || '
|
|
66
|
+
return_type = opts[:debug_return_type] || 'Template'
|
|
56
67
|
|
|
57
68
|
# auth_names
|
|
58
69
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
59
70
|
|
|
60
71
|
new_options = opts.merge(
|
|
61
|
-
:operation => :"TemplatesApi.
|
|
72
|
+
:operation => :"TemplatesApi.create_template",
|
|
62
73
|
:header_params => header_params,
|
|
63
74
|
:query_params => query_params,
|
|
64
75
|
:form_params => form_params,
|
|
@@ -67,9 +78,9 @@ module Lockally
|
|
|
67
78
|
:return_type => return_type
|
|
68
79
|
)
|
|
69
80
|
|
|
70
|
-
data, status_code, headers = @api_client.call_api(:
|
|
81
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
71
82
|
if @api_client.config.debugging
|
|
72
|
-
@api_client.config.logger.debug "API called: TemplatesApi#
|
|
83
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
73
84
|
end
|
|
74
85
|
return data, status_code, headers
|
|
75
86
|
end
|
|
@@ -78,8 +89,8 @@ module Lockally
|
|
|
78
89
|
# @param id [String]
|
|
79
90
|
# @param [Hash] opts the optional parameters
|
|
80
91
|
# @return [nil]
|
|
81
|
-
def
|
|
82
|
-
|
|
92
|
+
def delete_template(id, opts = {})
|
|
93
|
+
delete_template_with_http_info(id, opts)
|
|
83
94
|
nil
|
|
84
95
|
end
|
|
85
96
|
|
|
@@ -87,13 +98,13 @@ module Lockally
|
|
|
87
98
|
# @param id [String]
|
|
88
99
|
# @param [Hash] opts the optional parameters
|
|
89
100
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
90
|
-
def
|
|
101
|
+
def delete_template_with_http_info(id, opts = {})
|
|
91
102
|
if @api_client.config.debugging
|
|
92
|
-
@api_client.config.logger.debug 'Calling API: TemplatesApi.
|
|
103
|
+
@api_client.config.logger.debug 'Calling API: TemplatesApi.delete_template ...'
|
|
93
104
|
end
|
|
94
105
|
# verify the required parameter 'id' is set
|
|
95
106
|
if @api_client.config.client_side_validation && id.nil?
|
|
96
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TemplatesApi.
|
|
107
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TemplatesApi.delete_template"
|
|
97
108
|
end
|
|
98
109
|
# resource path
|
|
99
110
|
local_var_path = '/v1/templates/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
@@ -119,7 +130,7 @@ module Lockally
|
|
|
119
130
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
120
131
|
|
|
121
132
|
new_options = opts.merge(
|
|
122
|
-
:operation => :"TemplatesApi.
|
|
133
|
+
:operation => :"TemplatesApi.delete_template",
|
|
123
134
|
:header_params => header_params,
|
|
124
135
|
:query_params => query_params,
|
|
125
136
|
:form_params => form_params,
|
|
@@ -130,7 +141,7 @@ module Lockally
|
|
|
130
141
|
|
|
131
142
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
132
143
|
if @api_client.config.debugging
|
|
133
|
-
@api_client.config.logger.debug "API called: TemplatesApi#
|
|
144
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
134
145
|
end
|
|
135
146
|
return data, status_code, headers
|
|
136
147
|
end
|
|
@@ -139,8 +150,8 @@ module Lockally
|
|
|
139
150
|
# @param id [String]
|
|
140
151
|
# @param [Hash] opts the optional parameters
|
|
141
152
|
# @return [Template]
|
|
142
|
-
def
|
|
143
|
-
data, _status_code, _headers =
|
|
153
|
+
def get_template(id, opts = {})
|
|
154
|
+
data, _status_code, _headers = get_template_with_http_info(id, opts)
|
|
144
155
|
data
|
|
145
156
|
end
|
|
146
157
|
|
|
@@ -148,13 +159,13 @@ module Lockally
|
|
|
148
159
|
# @param id [String]
|
|
149
160
|
# @param [Hash] opts the optional parameters
|
|
150
161
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
151
|
-
def
|
|
162
|
+
def get_template_with_http_info(id, opts = {})
|
|
152
163
|
if @api_client.config.debugging
|
|
153
|
-
@api_client.config.logger.debug 'Calling API: TemplatesApi.
|
|
164
|
+
@api_client.config.logger.debug 'Calling API: TemplatesApi.get_template ...'
|
|
154
165
|
end
|
|
155
166
|
# verify the required parameter 'id' is set
|
|
156
167
|
if @api_client.config.client_side_validation && id.nil?
|
|
157
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TemplatesApi.
|
|
168
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TemplatesApi.get_template"
|
|
158
169
|
end
|
|
159
170
|
# resource path
|
|
160
171
|
local_var_path = '/v1/templates/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
@@ -180,7 +191,7 @@ module Lockally
|
|
|
180
191
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
181
192
|
|
|
182
193
|
new_options = opts.merge(
|
|
183
|
-
:operation => :"TemplatesApi.
|
|
194
|
+
:operation => :"TemplatesApi.get_template",
|
|
184
195
|
:header_params => header_params,
|
|
185
196
|
:query_params => query_params,
|
|
186
197
|
:form_params => form_params,
|
|
@@ -191,40 +202,28 @@ module Lockally
|
|
|
191
202
|
|
|
192
203
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
193
204
|
if @api_client.config.debugging
|
|
194
|
-
@api_client.config.logger.debug "API called: TemplatesApi#
|
|
205
|
+
@api_client.config.logger.debug "API called: TemplatesApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
195
206
|
end
|
|
196
207
|
return data, status_code, headers
|
|
197
208
|
end
|
|
198
209
|
|
|
199
|
-
#
|
|
200
|
-
# @param id [String]
|
|
201
|
-
# @param template_input [TemplateInput]
|
|
210
|
+
# List templates
|
|
202
211
|
# @param [Hash] opts the optional parameters
|
|
203
|
-
# @return [
|
|
204
|
-
def
|
|
205
|
-
data, _status_code, _headers =
|
|
212
|
+
# @return [ListTemplates200Response]
|
|
213
|
+
def list_templates(opts = {})
|
|
214
|
+
data, _status_code, _headers = list_templates_with_http_info(opts)
|
|
206
215
|
data
|
|
207
216
|
end
|
|
208
217
|
|
|
209
|
-
#
|
|
210
|
-
# @param id [String]
|
|
211
|
-
# @param template_input [TemplateInput]
|
|
218
|
+
# List templates
|
|
212
219
|
# @param [Hash] opts the optional parameters
|
|
213
|
-
# @return [Array<(
|
|
214
|
-
def
|
|
220
|
+
# @return [Array<(ListTemplates200Response, Integer, Hash)>] ListTemplates200Response data, response status code and response headers
|
|
221
|
+
def list_templates_with_http_info(opts = {})
|
|
215
222
|
if @api_client.config.debugging
|
|
216
|
-
@api_client.config.logger.debug 'Calling API: TemplatesApi.
|
|
217
|
-
end
|
|
218
|
-
# verify the required parameter 'id' is set
|
|
219
|
-
if @api_client.config.client_side_validation && id.nil?
|
|
220
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling TemplatesApi.v1_templates_id_put"
|
|
221
|
-
end
|
|
222
|
-
# verify the required parameter 'template_input' is set
|
|
223
|
-
if @api_client.config.client_side_validation && template_input.nil?
|
|
224
|
-
fail ArgumentError, "Missing the required parameter 'template_input' when calling TemplatesApi.v1_templates_id_put"
|
|
223
|
+
@api_client.config.logger.debug 'Calling API: TemplatesApi.list_templates ...'
|
|
225
224
|
end
|
|
226
225
|
# resource path
|
|
227
|
-
local_var_path = '/v1/templates
|
|
226
|
+
local_var_path = '/v1/templates'
|
|
228
227
|
|
|
229
228
|
# query parameters
|
|
230
229
|
query_params = opts[:query_params] || {}
|
|
@@ -233,26 +232,21 @@ module Lockally
|
|
|
233
232
|
header_params = opts[:header_params] || {}
|
|
234
233
|
# HTTP header 'Accept' (if needed)
|
|
235
234
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
236
|
-
# HTTP header 'Content-Type'
|
|
237
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
238
|
-
if !content_type.nil?
|
|
239
|
-
header_params['Content-Type'] = content_type
|
|
240
|
-
end
|
|
241
235
|
|
|
242
236
|
# form parameters
|
|
243
237
|
form_params = opts[:form_params] || {}
|
|
244
238
|
|
|
245
239
|
# http body (model)
|
|
246
|
-
post_body = opts[:debug_body]
|
|
240
|
+
post_body = opts[:debug_body]
|
|
247
241
|
|
|
248
242
|
# return_type
|
|
249
|
-
return_type = opts[:debug_return_type] || '
|
|
243
|
+
return_type = opts[:debug_return_type] || 'ListTemplates200Response'
|
|
250
244
|
|
|
251
245
|
# auth_names
|
|
252
246
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
253
247
|
|
|
254
248
|
new_options = opts.merge(
|
|
255
|
-
:operation => :"TemplatesApi.
|
|
249
|
+
:operation => :"TemplatesApi.list_templates",
|
|
256
250
|
:header_params => header_params,
|
|
257
251
|
:query_params => query_params,
|
|
258
252
|
:form_params => form_params,
|
|
@@ -261,36 +255,42 @@ module Lockally
|
|
|
261
255
|
:return_type => return_type
|
|
262
256
|
)
|
|
263
257
|
|
|
264
|
-
data, status_code, headers = @api_client.call_api(:
|
|
258
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
265
259
|
if @api_client.config.debugging
|
|
266
|
-
@api_client.config.logger.debug "API called: TemplatesApi#
|
|
260
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
267
261
|
end
|
|
268
262
|
return data, status_code, headers
|
|
269
263
|
end
|
|
270
264
|
|
|
271
|
-
#
|
|
265
|
+
# Update a template
|
|
266
|
+
# @param id [String]
|
|
272
267
|
# @param template_input [TemplateInput]
|
|
273
268
|
# @param [Hash] opts the optional parameters
|
|
274
269
|
# @return [Template]
|
|
275
|
-
def
|
|
276
|
-
data, _status_code, _headers =
|
|
270
|
+
def update_template(id, template_input, opts = {})
|
|
271
|
+
data, _status_code, _headers = update_template_with_http_info(id, template_input, opts)
|
|
277
272
|
data
|
|
278
273
|
end
|
|
279
274
|
|
|
280
|
-
#
|
|
275
|
+
# Update a template
|
|
276
|
+
# @param id [String]
|
|
281
277
|
# @param template_input [TemplateInput]
|
|
282
278
|
# @param [Hash] opts the optional parameters
|
|
283
279
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
284
|
-
def
|
|
280
|
+
def update_template_with_http_info(id, template_input, opts = {})
|
|
285
281
|
if @api_client.config.debugging
|
|
286
|
-
@api_client.config.logger.debug 'Calling API: TemplatesApi.
|
|
282
|
+
@api_client.config.logger.debug 'Calling API: TemplatesApi.update_template ...'
|
|
283
|
+
end
|
|
284
|
+
# verify the required parameter 'id' is set
|
|
285
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
286
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling TemplatesApi.update_template"
|
|
287
287
|
end
|
|
288
288
|
# verify the required parameter 'template_input' is set
|
|
289
289
|
if @api_client.config.client_side_validation && template_input.nil?
|
|
290
|
-
fail ArgumentError, "Missing the required parameter 'template_input' when calling TemplatesApi.
|
|
290
|
+
fail ArgumentError, "Missing the required parameter 'template_input' when calling TemplatesApi.update_template"
|
|
291
291
|
end
|
|
292
292
|
# resource path
|
|
293
|
-
local_var_path = '/v1/templates'
|
|
293
|
+
local_var_path = '/v1/templates/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
294
294
|
|
|
295
295
|
# query parameters
|
|
296
296
|
query_params = opts[:query_params] || {}
|
|
@@ -318,7 +318,7 @@ module Lockally
|
|
|
318
318
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
319
319
|
|
|
320
320
|
new_options = opts.merge(
|
|
321
|
-
:operation => :"TemplatesApi.
|
|
321
|
+
:operation => :"TemplatesApi.update_template",
|
|
322
322
|
:header_params => header_params,
|
|
323
323
|
:query_params => query_params,
|
|
324
324
|
:form_params => form_params,
|
|
@@ -327,9 +327,9 @@ module Lockally
|
|
|
327
327
|
:return_type => return_type
|
|
328
328
|
)
|
|
329
329
|
|
|
330
|
-
data, status_code, headers = @api_client.call_api(:
|
|
330
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
331
331
|
if @api_client.config.debugging
|
|
332
|
-
@api_client.config.logger.debug "API called: TemplatesApi#
|
|
332
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
333
333
|
end
|
|
334
334
|
return data, status_code, headers
|
|
335
335
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#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
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -23,8 +23,8 @@ module Lockally
|
|
|
23
23
|
# Returns the tenant the presented API key belongs to.
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @return [Tenant]
|
|
26
|
-
def
|
|
27
|
-
data, _status_code, _headers =
|
|
26
|
+
def get_tenant(opts = {})
|
|
27
|
+
data, _status_code, _headers = get_tenant_with_http_info(opts)
|
|
28
28
|
data
|
|
29
29
|
end
|
|
30
30
|
|
|
@@ -32,9 +32,9 @@ module Lockally
|
|
|
32
32
|
# Returns the tenant the presented API key belongs to.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
34
|
# @return [Array<(Tenant, Integer, Hash)>] Tenant data, response status code and response headers
|
|
35
|
-
def
|
|
35
|
+
def get_tenant_with_http_info(opts = {})
|
|
36
36
|
if @api_client.config.debugging
|
|
37
|
-
@api_client.config.logger.debug 'Calling API: TenantApi.
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: TenantApi.get_tenant ...'
|
|
38
38
|
end
|
|
39
39
|
# resource path
|
|
40
40
|
local_var_path = '/v1/tenant'
|
|
@@ -60,7 +60,7 @@ module Lockally
|
|
|
60
60
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
61
61
|
|
|
62
62
|
new_options = opts.merge(
|
|
63
|
-
:operation => :"TenantApi.
|
|
63
|
+
:operation => :"TenantApi.get_tenant",
|
|
64
64
|
:header_params => header_params,
|
|
65
65
|
:query_params => query_params,
|
|
66
66
|
:form_params => form_params,
|
|
@@ -71,7 +71,7 @@ module Lockally
|
|
|
71
71
|
|
|
72
72
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
73
73
|
if @api_client.config.debugging
|
|
74
|
-
@api_client.config.logger.debug "API called: TenantApi#
|
|
74
|
+
@api_client.config.logger.debug "API called: TenantApi#get_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
75
|
end
|
|
76
76
|
return data, status_code, headers
|
|
77
77
|
end
|
|
@@ -79,19 +79,19 @@ module Lockally
|
|
|
79
79
|
# Usage snapshot
|
|
80
80
|
# Returns the tenant's current usage + cap consumption. Designed for poll-based alerting on the integrator side (e.g. \"warn when daily quota is 80% used\"). Refreshed live from Postgres — there is no cache, so callers should poll at most once per minute.
|
|
81
81
|
# @param [Hash] opts the optional parameters
|
|
82
|
-
# @return [
|
|
83
|
-
def
|
|
84
|
-
data, _status_code, _headers =
|
|
82
|
+
# @return [GetUsage200Response]
|
|
83
|
+
def get_usage(opts = {})
|
|
84
|
+
data, _status_code, _headers = get_usage_with_http_info(opts)
|
|
85
85
|
data
|
|
86
86
|
end
|
|
87
87
|
|
|
88
88
|
# Usage snapshot
|
|
89
89
|
# Returns the tenant's current usage + cap consumption. Designed for poll-based alerting on the integrator side (e.g. \"warn when daily quota is 80% used\"). Refreshed live from Postgres — there is no cache, so callers should poll at most once per minute.
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
|
-
# @return [Array<(
|
|
92
|
-
def
|
|
91
|
+
# @return [Array<(GetUsage200Response, Integer, Hash)>] GetUsage200Response data, response status code and response headers
|
|
92
|
+
def get_usage_with_http_info(opts = {})
|
|
93
93
|
if @api_client.config.debugging
|
|
94
|
-
@api_client.config.logger.debug 'Calling API: TenantApi.
|
|
94
|
+
@api_client.config.logger.debug 'Calling API: TenantApi.get_usage ...'
|
|
95
95
|
end
|
|
96
96
|
# resource path
|
|
97
97
|
local_var_path = '/v1/usage'
|
|
@@ -111,13 +111,13 @@ module Lockally
|
|
|
111
111
|
post_body = opts[:debug_body]
|
|
112
112
|
|
|
113
113
|
# return_type
|
|
114
|
-
return_type = opts[:debug_return_type] || '
|
|
114
|
+
return_type = opts[:debug_return_type] || 'GetUsage200Response'
|
|
115
115
|
|
|
116
116
|
# auth_names
|
|
117
117
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
118
118
|
|
|
119
119
|
new_options = opts.merge(
|
|
120
|
-
:operation => :"TenantApi.
|
|
120
|
+
:operation => :"TenantApi.get_usage",
|
|
121
121
|
:header_params => header_params,
|
|
122
122
|
:query_params => query_params,
|
|
123
123
|
:form_params => form_params,
|
|
@@ -128,7 +128,7 @@ module Lockally
|
|
|
128
128
|
|
|
129
129
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
130
130
|
if @api_client.config.debugging
|
|
131
|
-
@api_client.config.logger.debug "API called: TenantApi#
|
|
131
|
+
@api_client.config.logger.debug "API called: TenantApi#get_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
132
132
|
end
|
|
133
133
|
return data, status_code, headers
|
|
134
134
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#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
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -22,19 +22,19 @@ module Lockally
|
|
|
22
22
|
# Simulate an inbound email (test keys only)
|
|
23
23
|
# Runs a synthetic message through the REAL indexing pipeline — thread adoption, deterministic extraction (incl. injection_risk), and the message.received webhook — so the whole agent loop is testable without a real domain or MTA. Requires an lk_test_* key (create with {\"test\": true} on POST /v1/api-keys). Body: {mailbox, from, subject, text, in_reply_to?, references?}.
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @return [
|
|
26
|
-
def
|
|
27
|
-
data, _status_code, _headers =
|
|
25
|
+
# @return [SimulatedInbound]
|
|
26
|
+
def simulate_inbound_email(opts = {})
|
|
27
|
+
data, _status_code, _headers = simulate_inbound_email_with_http_info(opts)
|
|
28
28
|
data
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
# Simulate an inbound email (test keys only)
|
|
32
32
|
# Runs a synthetic message through the REAL indexing pipeline — thread adoption, deterministic extraction (incl. injection_risk), and the message.received webhook — so the whole agent loop is testable without a real domain or MTA. Requires an lk_test_* key (create with {\"test\": true} on POST /v1/api-keys). Body: {mailbox, from, subject, text, in_reply_to?, references?}.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
|
-
# @return [Array<(
|
|
35
|
-
def
|
|
34
|
+
# @return [Array<(SimulatedInbound, Integer, Hash)>] SimulatedInbound data, response status code and response headers
|
|
35
|
+
def simulate_inbound_email_with_http_info(opts = {})
|
|
36
36
|
if @api_client.config.debugging
|
|
37
|
-
@api_client.config.logger.debug 'Calling API: TestApi.
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: TestApi.simulate_inbound_email ...'
|
|
38
38
|
end
|
|
39
39
|
# resource path
|
|
40
40
|
local_var_path = '/v1/test/inbound'
|
|
@@ -54,13 +54,13 @@ module Lockally
|
|
|
54
54
|
post_body = opts[:debug_body]
|
|
55
55
|
|
|
56
56
|
# return_type
|
|
57
|
-
return_type = opts[:debug_return_type] || '
|
|
57
|
+
return_type = opts[:debug_return_type] || 'SimulatedInbound'
|
|
58
58
|
|
|
59
59
|
# auth_names
|
|
60
60
|
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
61
61
|
|
|
62
62
|
new_options = opts.merge(
|
|
63
|
-
:operation => :"TestApi.
|
|
63
|
+
:operation => :"TestApi.simulate_inbound_email",
|
|
64
64
|
:header_params => header_params,
|
|
65
65
|
:query_params => query_params,
|
|
66
66
|
:form_params => form_params,
|
|
@@ -71,7 +71,7 @@ module Lockally
|
|
|
71
71
|
|
|
72
72
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
73
73
|
if @api_client.config.debugging
|
|
74
|
-
@api_client.config.logger.debug "API called: TestApi#
|
|
74
|
+
@api_client.config.logger.debug "API called: TestApi#simulate_inbound_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
75
|
end
|
|
76
76
|
return data, status_code, headers
|
|
77
77
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#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
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|