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
data/docs/MailboxesApi.md
CHANGED
|
@@ -5,19 +5,19 @@ All URIs are relative to *https://api.lockally.com*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**add_shared_member**](MailboxesApi.md#add_shared_member) | **POST** /v1/mailboxes/{email}/members | Add a shared mailbox member |
|
|
8
|
+
| [**create_mailbox**](MailboxesApi.md#create_mailbox) | **POST** /v1/mailboxes | Create a mailbox |
|
|
9
|
+
| [**delete_mailbox**](MailboxesApi.md#delete_mailbox) | **DELETE** /v1/mailboxes/{email} | Soft-delete a mailbox |
|
|
10
|
+
| [**delete_vacation_responder**](MailboxesApi.md#delete_vacation_responder) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder |
|
|
11
|
+
| [**download_mailbox_export**](MailboxesApi.md#download_mailbox_export) | **GET** /v1/mailboxes/{email}/export/download | Download a previously-issued mailbox export |
|
|
12
|
+
| [**export_mailbox**](MailboxesApi.md#export_mailbox) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export |
|
|
13
|
+
| [**get_mailbox**](MailboxesApi.md#get_mailbox) | **GET** /v1/mailboxes/{email} | Get a mailbox |
|
|
14
|
+
| [**get_vacation_responder**](MailboxesApi.md#get_vacation_responder) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder |
|
|
15
|
+
| [**list_mailboxes**](MailboxesApi.md#list_mailboxes) | **GET** /v1/mailboxes | List mailboxes |
|
|
8
16
|
| [**list_shared_members**](MailboxesApi.md#list_shared_members) | **GET** /v1/mailboxes/{email}/members | List shared mailbox members |
|
|
17
|
+
| [**list_vacation_responders**](MailboxesApi.md#list_vacation_responders) | **GET** /v1/vacation | List all vacation responders |
|
|
9
18
|
| [**remove_shared_member**](MailboxesApi.md#remove_shared_member) | **DELETE** /v1/mailboxes/{email}/members/{memberEmail} | Remove a shared mailbox member |
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**v1_mailboxes_email_export_post**](MailboxesApi.md#v1_mailboxes_email_export_post) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export |
|
|
13
|
-
| [**v1_mailboxes_email_get**](MailboxesApi.md#v1_mailboxes_email_get) | **GET** /v1/mailboxes/{email} | Get a mailbox |
|
|
14
|
-
| [**v1_mailboxes_email_patch**](MailboxesApi.md#v1_mailboxes_email_patch) | **PATCH** /v1/mailboxes/{email} | Update a mailbox |
|
|
15
|
-
| [**v1_mailboxes_email_vacation_delete**](MailboxesApi.md#v1_mailboxes_email_vacation_delete) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder |
|
|
16
|
-
| [**v1_mailboxes_email_vacation_get**](MailboxesApi.md#v1_mailboxes_email_vacation_get) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder |
|
|
17
|
-
| [**v1_mailboxes_email_vacation_put**](MailboxesApi.md#v1_mailboxes_email_vacation_put) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder |
|
|
18
|
-
| [**v1_mailboxes_get**](MailboxesApi.md#v1_mailboxes_get) | **GET** /v1/mailboxes | List mailboxes |
|
|
19
|
-
| [**v1_mailboxes_post**](MailboxesApi.md#v1_mailboxes_post) | **POST** /v1/mailboxes | Create a mailbox |
|
|
20
|
-
| [**v1_vacation_get**](MailboxesApi.md#v1_vacation_get) | **GET** /v1/vacation | List all vacation responders |
|
|
19
|
+
| [**set_vacation_responder**](MailboxesApi.md#set_vacation_responder) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder |
|
|
20
|
+
| [**update_mailbox**](MailboxesApi.md#update_mailbox) | **PATCH** /v1/mailboxes/{email} | Update a mailbox |
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
## add_shared_member
|
|
@@ -89,11 +89,13 @@ end
|
|
|
89
89
|
- **Accept**: application/json, application/problem+json
|
|
90
90
|
|
|
91
91
|
|
|
92
|
-
##
|
|
92
|
+
## create_mailbox
|
|
93
93
|
|
|
94
|
-
> <
|
|
94
|
+
> <Mailbox> create_mailbox(create_mailbox_request)
|
|
95
95
|
|
|
96
|
-
|
|
96
|
+
Create a mailbox
|
|
97
|
+
|
|
98
|
+
Creates a mailbox on a tenant-verified domain. If `password` is omitted, lockally generates a 16-char password and returns it in the response — shown once. **Gate.** The mailbox's domain must already be registered AND verified for this tenant (via `/v1/domains` + `/v1/domains/{domain}/verify`). **Idempotent.** Re-posting the same email returns the existing mailbox UNTOUCHED — password is NOT regenerated. To change a password, use PATCH instead.
|
|
97
99
|
|
|
98
100
|
### Examples
|
|
99
101
|
|
|
@@ -107,32 +109,32 @@ Lockally.configure do |config|
|
|
|
107
109
|
end
|
|
108
110
|
|
|
109
111
|
api_instance = Lockally::MailboxesApi.new
|
|
110
|
-
|
|
112
|
+
create_mailbox_request = Lockally::CreateMailboxRequest.new({email: 'alice@acme.com'}) # CreateMailboxRequest |
|
|
111
113
|
|
|
112
114
|
begin
|
|
113
|
-
#
|
|
114
|
-
result = api_instance.
|
|
115
|
+
# Create a mailbox
|
|
116
|
+
result = api_instance.create_mailbox(create_mailbox_request)
|
|
115
117
|
p result
|
|
116
118
|
rescue Lockally::ApiError => e
|
|
117
|
-
puts "Error when calling MailboxesApi->
|
|
119
|
+
puts "Error when calling MailboxesApi->create_mailbox: #{e}"
|
|
118
120
|
end
|
|
119
121
|
```
|
|
120
122
|
|
|
121
|
-
#### Using the
|
|
123
|
+
#### Using the create_mailbox_with_http_info variant
|
|
122
124
|
|
|
123
125
|
This returns an Array which contains the response data, status code and headers.
|
|
124
126
|
|
|
125
|
-
> <Array(<
|
|
127
|
+
> <Array(<Mailbox>, Integer, Hash)> create_mailbox_with_http_info(create_mailbox_request)
|
|
126
128
|
|
|
127
129
|
```ruby
|
|
128
130
|
begin
|
|
129
|
-
#
|
|
130
|
-
data, status_code, headers = api_instance.
|
|
131
|
+
# Create a mailbox
|
|
132
|
+
data, status_code, headers = api_instance.create_mailbox_with_http_info(create_mailbox_request)
|
|
131
133
|
p status_code # => 2xx
|
|
132
134
|
p headers # => { ... }
|
|
133
|
-
p data # => <
|
|
135
|
+
p data # => <Mailbox>
|
|
134
136
|
rescue Lockally::ApiError => e
|
|
135
|
-
puts "Error when calling MailboxesApi->
|
|
137
|
+
puts "Error when calling MailboxesApi->create_mailbox_with_http_info: #{e}"
|
|
136
138
|
end
|
|
137
139
|
```
|
|
138
140
|
|
|
@@ -140,11 +142,11 @@ end
|
|
|
140
142
|
|
|
141
143
|
| Name | Type | Description | Notes |
|
|
142
144
|
| ---- | ---- | ----------- | ----- |
|
|
143
|
-
| **
|
|
145
|
+
| **create_mailbox_request** | [**CreateMailboxRequest**](CreateMailboxRequest.md) | | |
|
|
144
146
|
|
|
145
147
|
### Return type
|
|
146
148
|
|
|
147
|
-
[**
|
|
149
|
+
[**Mailbox**](Mailbox.md)
|
|
148
150
|
|
|
149
151
|
### Authorization
|
|
150
152
|
|
|
@@ -152,15 +154,17 @@ end
|
|
|
152
154
|
|
|
153
155
|
### HTTP request headers
|
|
154
156
|
|
|
155
|
-
- **Content-Type**:
|
|
157
|
+
- **Content-Type**: application/json
|
|
156
158
|
- **Accept**: application/json, application/problem+json
|
|
157
159
|
|
|
158
160
|
|
|
159
|
-
##
|
|
161
|
+
## delete_mailbox
|
|
160
162
|
|
|
161
|
-
>
|
|
163
|
+
> delete_mailbox(email)
|
|
162
164
|
|
|
163
|
-
|
|
165
|
+
Soft-delete a mailbox
|
|
166
|
+
|
|
167
|
+
Sets `soft_deleted_at = now()` and `hard_delete_after = now() + 90d` per design D25. A background sweep (planned) will hard-delete after the window. The mailbox is also disabled immediately.
|
|
164
168
|
|
|
165
169
|
### Examples
|
|
166
170
|
|
|
@@ -175,31 +179,30 @@ end
|
|
|
175
179
|
|
|
176
180
|
api_instance = Lockally::MailboxesApi.new
|
|
177
181
|
email = 'email_example' # String |
|
|
178
|
-
member_email = 'member_email_example' # String |
|
|
179
182
|
|
|
180
183
|
begin
|
|
181
|
-
#
|
|
182
|
-
api_instance.
|
|
184
|
+
# Soft-delete a mailbox
|
|
185
|
+
api_instance.delete_mailbox(email)
|
|
183
186
|
rescue Lockally::ApiError => e
|
|
184
|
-
puts "Error when calling MailboxesApi->
|
|
187
|
+
puts "Error when calling MailboxesApi->delete_mailbox: #{e}"
|
|
185
188
|
end
|
|
186
189
|
```
|
|
187
190
|
|
|
188
|
-
#### Using the
|
|
191
|
+
#### Using the delete_mailbox_with_http_info variant
|
|
189
192
|
|
|
190
193
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
191
194
|
|
|
192
|
-
> <Array(nil, Integer, Hash)>
|
|
195
|
+
> <Array(nil, Integer, Hash)> delete_mailbox_with_http_info(email)
|
|
193
196
|
|
|
194
197
|
```ruby
|
|
195
198
|
begin
|
|
196
|
-
#
|
|
197
|
-
data, status_code, headers = api_instance.
|
|
199
|
+
# Soft-delete a mailbox
|
|
200
|
+
data, status_code, headers = api_instance.delete_mailbox_with_http_info(email)
|
|
198
201
|
p status_code # => 2xx
|
|
199
202
|
p headers # => { ... }
|
|
200
203
|
p data # => nil
|
|
201
204
|
rescue Lockally::ApiError => e
|
|
202
|
-
puts "Error when calling MailboxesApi->
|
|
205
|
+
puts "Error when calling MailboxesApi->delete_mailbox_with_http_info: #{e}"
|
|
203
206
|
end
|
|
204
207
|
```
|
|
205
208
|
|
|
@@ -208,7 +211,6 @@ end
|
|
|
208
211
|
| Name | Type | Description | Notes |
|
|
209
212
|
| ---- | ---- | ----------- | ----- |
|
|
210
213
|
| **email** | **String** | | |
|
|
211
|
-
| **member_email** | **String** | | |
|
|
212
214
|
|
|
213
215
|
### Return type
|
|
214
216
|
|
|
@@ -224,13 +226,13 @@ nil (empty response body)
|
|
|
224
226
|
- **Accept**: application/problem+json
|
|
225
227
|
|
|
226
228
|
|
|
227
|
-
##
|
|
229
|
+
## delete_vacation_responder
|
|
228
230
|
|
|
229
|
-
>
|
|
231
|
+
> delete_vacation_responder(email)
|
|
230
232
|
|
|
231
|
-
|
|
233
|
+
Remove the vacation responder
|
|
232
234
|
|
|
233
|
-
|
|
235
|
+
Idempotent — 204 whether or not a row existed.
|
|
234
236
|
|
|
235
237
|
### Examples
|
|
236
238
|
|
|
@@ -247,28 +249,28 @@ api_instance = Lockally::MailboxesApi.new
|
|
|
247
249
|
email = 'email_example' # String |
|
|
248
250
|
|
|
249
251
|
begin
|
|
250
|
-
#
|
|
251
|
-
api_instance.
|
|
252
|
+
# Remove the vacation responder
|
|
253
|
+
api_instance.delete_vacation_responder(email)
|
|
252
254
|
rescue Lockally::ApiError => e
|
|
253
|
-
puts "Error when calling MailboxesApi->
|
|
255
|
+
puts "Error when calling MailboxesApi->delete_vacation_responder: #{e}"
|
|
254
256
|
end
|
|
255
257
|
```
|
|
256
258
|
|
|
257
|
-
#### Using the
|
|
259
|
+
#### Using the delete_vacation_responder_with_http_info variant
|
|
258
260
|
|
|
259
261
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
260
262
|
|
|
261
|
-
> <Array(nil, Integer, Hash)>
|
|
263
|
+
> <Array(nil, Integer, Hash)> delete_vacation_responder_with_http_info(email)
|
|
262
264
|
|
|
263
265
|
```ruby
|
|
264
266
|
begin
|
|
265
|
-
#
|
|
266
|
-
data, status_code, headers = api_instance.
|
|
267
|
+
# Remove the vacation responder
|
|
268
|
+
data, status_code, headers = api_instance.delete_vacation_responder_with_http_info(email)
|
|
267
269
|
p status_code # => 2xx
|
|
268
270
|
p headers # => { ... }
|
|
269
271
|
p data # => nil
|
|
270
272
|
rescue Lockally::ApiError => e
|
|
271
|
-
puts "Error when calling MailboxesApi->
|
|
273
|
+
puts "Error when calling MailboxesApi->delete_vacation_responder_with_http_info: #{e}"
|
|
272
274
|
end
|
|
273
275
|
```
|
|
274
276
|
|
|
@@ -292,9 +294,9 @@ nil (empty response body)
|
|
|
292
294
|
- **Accept**: application/problem+json
|
|
293
295
|
|
|
294
296
|
|
|
295
|
-
##
|
|
297
|
+
## download_mailbox_export
|
|
296
298
|
|
|
297
|
-
> File
|
|
299
|
+
> File download_mailbox_export(email, token)
|
|
298
300
|
|
|
299
301
|
Download a previously-issued mailbox export
|
|
300
302
|
|
|
@@ -312,28 +314,28 @@ token = 'token_example' # String |
|
|
|
312
314
|
|
|
313
315
|
begin
|
|
314
316
|
# Download a previously-issued mailbox export
|
|
315
|
-
result = api_instance.
|
|
317
|
+
result = api_instance.download_mailbox_export(email, token)
|
|
316
318
|
p result
|
|
317
319
|
rescue Lockally::ApiError => e
|
|
318
|
-
puts "Error when calling MailboxesApi->
|
|
320
|
+
puts "Error when calling MailboxesApi->download_mailbox_export: #{e}"
|
|
319
321
|
end
|
|
320
322
|
```
|
|
321
323
|
|
|
322
|
-
#### Using the
|
|
324
|
+
#### Using the download_mailbox_export_with_http_info variant
|
|
323
325
|
|
|
324
326
|
This returns an Array which contains the response data, status code and headers.
|
|
325
327
|
|
|
326
|
-
> <Array(File, Integer, Hash)>
|
|
328
|
+
> <Array(File, Integer, Hash)> download_mailbox_export_with_http_info(email, token)
|
|
327
329
|
|
|
328
330
|
```ruby
|
|
329
331
|
begin
|
|
330
332
|
# Download a previously-issued mailbox export
|
|
331
|
-
data, status_code, headers = api_instance.
|
|
333
|
+
data, status_code, headers = api_instance.download_mailbox_export_with_http_info(email, token)
|
|
332
334
|
p status_code # => 2xx
|
|
333
335
|
p headers # => { ... }
|
|
334
336
|
p data # => File
|
|
335
337
|
rescue Lockally::ApiError => e
|
|
336
|
-
puts "Error when calling MailboxesApi->
|
|
338
|
+
puts "Error when calling MailboxesApi->download_mailbox_export_with_http_info: #{e}"
|
|
337
339
|
end
|
|
338
340
|
```
|
|
339
341
|
|
|
@@ -358,13 +360,13 @@ No authorization required
|
|
|
358
360
|
- **Accept**: application/mbox, application/problem+json
|
|
359
361
|
|
|
360
362
|
|
|
361
|
-
##
|
|
363
|
+
## export_mailbox
|
|
362
364
|
|
|
363
|
-
> <
|
|
365
|
+
> <ExportMailbox201Response> export_mailbox(email)
|
|
364
366
|
|
|
365
367
|
Request a mailbox export
|
|
366
368
|
|
|
367
|
-
Issues a one-shot \"presigned\" download URL for the mailbox's content in mbox format. The URL works without an Authorization header — the token in the query string is the authz. TTL is 5 minutes; the token is consumed on first GET. **v1 caveat:** the synthesized mbox only contains outbound mail (from `lockally.messages`). v2 swaps in Stalwart's export primitive for full inbox + folder structure + flags. The endpoint contract stays unchanged.
|
|
369
|
+
Issues a one-shot \"presigned\" download URL for the mailbox's content in mbox format. The URL works without an Authorization header — the token in the query string is the authz. TTL is 5 minutes; the token is consumed on first GET. **v1 caveat:** the synthesized mbox only contains outbound mail (from `lockally.messages`). v2 swaps in Stalwart's export primitive for full inbox + folder structure + flags. The endpoint contract stays unchanged. **Scope changed:** this used to accept `mailboxes:read`. It takes any mailbox in the tenant and returns that mailbox's mail, so it now requires `tenant:admin`, matching `POST /v1/ediscovery/export`. A key scoped `mailboxes:read` gets 403 and has to be reissued; admin console sessions are unaffected.
|
|
368
370
|
|
|
369
371
|
### Examples
|
|
370
372
|
|
|
@@ -382,28 +384,28 @@ email = 'email_example' # String |
|
|
|
382
384
|
|
|
383
385
|
begin
|
|
384
386
|
# Request a mailbox export
|
|
385
|
-
result = api_instance.
|
|
387
|
+
result = api_instance.export_mailbox(email)
|
|
386
388
|
p result
|
|
387
389
|
rescue Lockally::ApiError => e
|
|
388
|
-
puts "Error when calling MailboxesApi->
|
|
390
|
+
puts "Error when calling MailboxesApi->export_mailbox: #{e}"
|
|
389
391
|
end
|
|
390
392
|
```
|
|
391
393
|
|
|
392
|
-
#### Using the
|
|
394
|
+
#### Using the export_mailbox_with_http_info variant
|
|
393
395
|
|
|
394
396
|
This returns an Array which contains the response data, status code and headers.
|
|
395
397
|
|
|
396
|
-
> <Array(<
|
|
398
|
+
> <Array(<ExportMailbox201Response>, Integer, Hash)> export_mailbox_with_http_info(email)
|
|
397
399
|
|
|
398
400
|
```ruby
|
|
399
401
|
begin
|
|
400
402
|
# Request a mailbox export
|
|
401
|
-
data, status_code, headers = api_instance.
|
|
403
|
+
data, status_code, headers = api_instance.export_mailbox_with_http_info(email)
|
|
402
404
|
p status_code # => 2xx
|
|
403
405
|
p headers # => { ... }
|
|
404
|
-
p data # => <
|
|
406
|
+
p data # => <ExportMailbox201Response>
|
|
405
407
|
rescue Lockally::ApiError => e
|
|
406
|
-
puts "Error when calling MailboxesApi->
|
|
408
|
+
puts "Error when calling MailboxesApi->export_mailbox_with_http_info: #{e}"
|
|
407
409
|
end
|
|
408
410
|
```
|
|
409
411
|
|
|
@@ -415,7 +417,7 @@ end
|
|
|
415
417
|
|
|
416
418
|
### Return type
|
|
417
419
|
|
|
418
|
-
[**
|
|
420
|
+
[**ExportMailbox201Response**](ExportMailbox201Response.md)
|
|
419
421
|
|
|
420
422
|
### Authorization
|
|
421
423
|
|
|
@@ -427,9 +429,9 @@ end
|
|
|
427
429
|
- **Accept**: application/json, application/problem+json
|
|
428
430
|
|
|
429
431
|
|
|
430
|
-
##
|
|
432
|
+
## get_mailbox
|
|
431
433
|
|
|
432
|
-
> <Mailbox>
|
|
434
|
+
> <Mailbox> get_mailbox(email)
|
|
433
435
|
|
|
434
436
|
Get a mailbox
|
|
435
437
|
|
|
@@ -449,28 +451,28 @@ email = 'email_example' # String |
|
|
|
449
451
|
|
|
450
452
|
begin
|
|
451
453
|
# Get a mailbox
|
|
452
|
-
result = api_instance.
|
|
454
|
+
result = api_instance.get_mailbox(email)
|
|
453
455
|
p result
|
|
454
456
|
rescue Lockally::ApiError => e
|
|
455
|
-
puts "Error when calling MailboxesApi->
|
|
457
|
+
puts "Error when calling MailboxesApi->get_mailbox: #{e}"
|
|
456
458
|
end
|
|
457
459
|
```
|
|
458
460
|
|
|
459
|
-
#### Using the
|
|
461
|
+
#### Using the get_mailbox_with_http_info variant
|
|
460
462
|
|
|
461
463
|
This returns an Array which contains the response data, status code and headers.
|
|
462
464
|
|
|
463
|
-
> <Array(<Mailbox>, Integer, Hash)>
|
|
465
|
+
> <Array(<Mailbox>, Integer, Hash)> get_mailbox_with_http_info(email)
|
|
464
466
|
|
|
465
467
|
```ruby
|
|
466
468
|
begin
|
|
467
469
|
# Get a mailbox
|
|
468
|
-
data, status_code, headers = api_instance.
|
|
470
|
+
data, status_code, headers = api_instance.get_mailbox_with_http_info(email)
|
|
469
471
|
p status_code # => 2xx
|
|
470
472
|
p headers # => { ... }
|
|
471
473
|
p data # => <Mailbox>
|
|
472
474
|
rescue Lockally::ApiError => e
|
|
473
|
-
puts "Error when calling MailboxesApi->
|
|
475
|
+
puts "Error when calling MailboxesApi->get_mailbox_with_http_info: #{e}"
|
|
474
476
|
end
|
|
475
477
|
```
|
|
476
478
|
|
|
@@ -494,13 +496,13 @@ end
|
|
|
494
496
|
- **Accept**: application/json, application/problem+json
|
|
495
497
|
|
|
496
498
|
|
|
497
|
-
##
|
|
499
|
+
## get_vacation_responder
|
|
498
500
|
|
|
499
|
-
> <
|
|
501
|
+
> <VacationResponder> get_vacation_responder(email)
|
|
500
502
|
|
|
501
|
-
|
|
503
|
+
Get the vacation responder
|
|
502
504
|
|
|
503
|
-
|
|
505
|
+
Returns the stored vacation rule or 404 if none is set.
|
|
504
506
|
|
|
505
507
|
### Examples
|
|
506
508
|
|
|
@@ -515,32 +517,31 @@ end
|
|
|
515
517
|
|
|
516
518
|
api_instance = Lockally::MailboxesApi.new
|
|
517
519
|
email = 'email_example' # String |
|
|
518
|
-
v1_mailboxes_email_patch_request = Lockally::V1MailboxesEmailPatchRequest.new # V1MailboxesEmailPatchRequest |
|
|
519
520
|
|
|
520
521
|
begin
|
|
521
|
-
#
|
|
522
|
-
result = api_instance.
|
|
522
|
+
# Get the vacation responder
|
|
523
|
+
result = api_instance.get_vacation_responder(email)
|
|
523
524
|
p result
|
|
524
525
|
rescue Lockally::ApiError => e
|
|
525
|
-
puts "Error when calling MailboxesApi->
|
|
526
|
+
puts "Error when calling MailboxesApi->get_vacation_responder: #{e}"
|
|
526
527
|
end
|
|
527
528
|
```
|
|
528
529
|
|
|
529
|
-
#### Using the
|
|
530
|
+
#### Using the get_vacation_responder_with_http_info variant
|
|
530
531
|
|
|
531
532
|
This returns an Array which contains the response data, status code and headers.
|
|
532
533
|
|
|
533
|
-
> <Array(<
|
|
534
|
+
> <Array(<VacationResponder>, Integer, Hash)> get_vacation_responder_with_http_info(email)
|
|
534
535
|
|
|
535
536
|
```ruby
|
|
536
537
|
begin
|
|
537
|
-
#
|
|
538
|
-
data, status_code, headers = api_instance.
|
|
538
|
+
# Get the vacation responder
|
|
539
|
+
data, status_code, headers = api_instance.get_vacation_responder_with_http_info(email)
|
|
539
540
|
p status_code # => 2xx
|
|
540
541
|
p headers # => { ... }
|
|
541
|
-
p data # => <
|
|
542
|
+
p data # => <VacationResponder>
|
|
542
543
|
rescue Lockally::ApiError => e
|
|
543
|
-
puts "Error when calling MailboxesApi->
|
|
544
|
+
puts "Error when calling MailboxesApi->get_vacation_responder_with_http_info: #{e}"
|
|
544
545
|
end
|
|
545
546
|
```
|
|
546
547
|
|
|
@@ -549,11 +550,10 @@ end
|
|
|
549
550
|
| Name | Type | Description | Notes |
|
|
550
551
|
| ---- | ---- | ----------- | ----- |
|
|
551
552
|
| **email** | **String** | | |
|
|
552
|
-
| **v1_mailboxes_email_patch_request** | [**V1MailboxesEmailPatchRequest**](V1MailboxesEmailPatchRequest.md) | | |
|
|
553
553
|
|
|
554
554
|
### Return type
|
|
555
555
|
|
|
556
|
-
[**
|
|
556
|
+
[**VacationResponder**](VacationResponder.md)
|
|
557
557
|
|
|
558
558
|
### Authorization
|
|
559
559
|
|
|
@@ -561,17 +561,17 @@ end
|
|
|
561
561
|
|
|
562
562
|
### HTTP request headers
|
|
563
563
|
|
|
564
|
-
- **Content-Type**:
|
|
564
|
+
- **Content-Type**: Not defined
|
|
565
565
|
- **Accept**: application/json, application/problem+json
|
|
566
566
|
|
|
567
567
|
|
|
568
|
-
##
|
|
568
|
+
## list_mailboxes
|
|
569
569
|
|
|
570
|
-
>
|
|
570
|
+
> <ListMailboxes200Response> list_mailboxes(opts)
|
|
571
571
|
|
|
572
|
-
|
|
572
|
+
List mailboxes
|
|
573
573
|
|
|
574
|
-
|
|
574
|
+
Returns mailboxes under the calling tenant — active and soft-deleted. `?limit=N` between 1 and 200 (default 50).
|
|
575
575
|
|
|
576
576
|
### Examples
|
|
577
577
|
|
|
@@ -585,31 +585,34 @@ Lockally.configure do |config|
|
|
|
585
585
|
end
|
|
586
586
|
|
|
587
587
|
api_instance = Lockally::MailboxesApi.new
|
|
588
|
-
|
|
588
|
+
opts = {
|
|
589
|
+
limit: 56 # Integer |
|
|
590
|
+
}
|
|
589
591
|
|
|
590
592
|
begin
|
|
591
|
-
#
|
|
592
|
-
api_instance.
|
|
593
|
+
# List mailboxes
|
|
594
|
+
result = api_instance.list_mailboxes(opts)
|
|
595
|
+
p result
|
|
593
596
|
rescue Lockally::ApiError => e
|
|
594
|
-
puts "Error when calling MailboxesApi->
|
|
597
|
+
puts "Error when calling MailboxesApi->list_mailboxes: #{e}"
|
|
595
598
|
end
|
|
596
599
|
```
|
|
597
600
|
|
|
598
|
-
#### Using the
|
|
601
|
+
#### Using the list_mailboxes_with_http_info variant
|
|
599
602
|
|
|
600
|
-
This returns an Array which contains the response data
|
|
603
|
+
This returns an Array which contains the response data, status code and headers.
|
|
601
604
|
|
|
602
|
-
> <Array(
|
|
605
|
+
> <Array(<ListMailboxes200Response>, Integer, Hash)> list_mailboxes_with_http_info(opts)
|
|
603
606
|
|
|
604
607
|
```ruby
|
|
605
608
|
begin
|
|
606
|
-
#
|
|
607
|
-
data, status_code, headers = api_instance.
|
|
609
|
+
# List mailboxes
|
|
610
|
+
data, status_code, headers = api_instance.list_mailboxes_with_http_info(opts)
|
|
608
611
|
p status_code # => 2xx
|
|
609
612
|
p headers # => { ... }
|
|
610
|
-
p data # =>
|
|
613
|
+
p data # => <ListMailboxes200Response>
|
|
611
614
|
rescue Lockally::ApiError => e
|
|
612
|
-
puts "Error when calling MailboxesApi->
|
|
615
|
+
puts "Error when calling MailboxesApi->list_mailboxes_with_http_info: #{e}"
|
|
613
616
|
end
|
|
614
617
|
```
|
|
615
618
|
|
|
@@ -617,11 +620,11 @@ end
|
|
|
617
620
|
|
|
618
621
|
| Name | Type | Description | Notes |
|
|
619
622
|
| ---- | ---- | ----------- | ----- |
|
|
620
|
-
| **
|
|
623
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
621
624
|
|
|
622
625
|
### Return type
|
|
623
626
|
|
|
624
|
-
|
|
627
|
+
[**ListMailboxes200Response**](ListMailboxes200Response.md)
|
|
625
628
|
|
|
626
629
|
### Authorization
|
|
627
630
|
|
|
@@ -630,16 +633,14 @@ nil (empty response body)
|
|
|
630
633
|
### HTTP request headers
|
|
631
634
|
|
|
632
635
|
- **Content-Type**: Not defined
|
|
633
|
-
- **Accept**: application/problem+json
|
|
634
|
-
|
|
636
|
+
- **Accept**: application/json, application/problem+json
|
|
635
637
|
|
|
636
|
-
## v1_mailboxes_email_vacation_get
|
|
637
638
|
|
|
638
|
-
|
|
639
|
+
## list_shared_members
|
|
639
640
|
|
|
640
|
-
|
|
641
|
+
> <ListSharedMembers200Response> list_shared_members(email)
|
|
641
642
|
|
|
642
|
-
|
|
643
|
+
List shared mailbox members
|
|
643
644
|
|
|
644
645
|
### Examples
|
|
645
646
|
|
|
@@ -656,29 +657,29 @@ api_instance = Lockally::MailboxesApi.new
|
|
|
656
657
|
email = 'email_example' # String |
|
|
657
658
|
|
|
658
659
|
begin
|
|
659
|
-
#
|
|
660
|
-
result = api_instance.
|
|
660
|
+
# List shared mailbox members
|
|
661
|
+
result = api_instance.list_shared_members(email)
|
|
661
662
|
p result
|
|
662
663
|
rescue Lockally::ApiError => e
|
|
663
|
-
puts "Error when calling MailboxesApi->
|
|
664
|
+
puts "Error when calling MailboxesApi->list_shared_members: #{e}"
|
|
664
665
|
end
|
|
665
666
|
```
|
|
666
667
|
|
|
667
|
-
#### Using the
|
|
668
|
+
#### Using the list_shared_members_with_http_info variant
|
|
668
669
|
|
|
669
670
|
This returns an Array which contains the response data, status code and headers.
|
|
670
671
|
|
|
671
|
-
> <Array(<
|
|
672
|
+
> <Array(<ListSharedMembers200Response>, Integer, Hash)> list_shared_members_with_http_info(email)
|
|
672
673
|
|
|
673
674
|
```ruby
|
|
674
675
|
begin
|
|
675
|
-
#
|
|
676
|
-
data, status_code, headers = api_instance.
|
|
676
|
+
# List shared mailbox members
|
|
677
|
+
data, status_code, headers = api_instance.list_shared_members_with_http_info(email)
|
|
677
678
|
p status_code # => 2xx
|
|
678
679
|
p headers # => { ... }
|
|
679
|
-
p data # => <
|
|
680
|
+
p data # => <ListSharedMembers200Response>
|
|
680
681
|
rescue Lockally::ApiError => e
|
|
681
|
-
puts "Error when calling MailboxesApi->
|
|
682
|
+
puts "Error when calling MailboxesApi->list_shared_members_with_http_info: #{e}"
|
|
682
683
|
end
|
|
683
684
|
```
|
|
684
685
|
|
|
@@ -690,7 +691,7 @@ end
|
|
|
690
691
|
|
|
691
692
|
### Return type
|
|
692
693
|
|
|
693
|
-
[**
|
|
694
|
+
[**ListSharedMembers200Response**](ListSharedMembers200Response.md)
|
|
694
695
|
|
|
695
696
|
### Authorization
|
|
696
697
|
|
|
@@ -702,13 +703,13 @@ end
|
|
|
702
703
|
- **Accept**: application/json, application/problem+json
|
|
703
704
|
|
|
704
705
|
|
|
705
|
-
##
|
|
706
|
+
## list_vacation_responders
|
|
706
707
|
|
|
707
|
-
> <
|
|
708
|
+
> <ListVacationResponders200Response> list_vacation_responders
|
|
708
709
|
|
|
709
|
-
|
|
710
|
+
List all vacation responders
|
|
710
711
|
|
|
711
|
-
|
|
712
|
+
Returns every vacation responder for the calling tenant.
|
|
712
713
|
|
|
713
714
|
### Examples
|
|
714
715
|
|
|
@@ -722,46 +723,41 @@ Lockally.configure do |config|
|
|
|
722
723
|
end
|
|
723
724
|
|
|
724
725
|
api_instance = Lockally::MailboxesApi.new
|
|
725
|
-
email = 'email_example' # String |
|
|
726
|
-
v1_mailboxes_email_vacation_put_request = Lockally::V1MailboxesEmailVacationPutRequest.new({params: Lockally::VacationParams.new({subject: 'Out of office until June 5', body: 'Hi! I'm away until June 5. For urgent matters please contact ...'})}) # V1MailboxesEmailVacationPutRequest |
|
|
727
726
|
|
|
728
727
|
begin
|
|
729
|
-
#
|
|
730
|
-
result = api_instance.
|
|
728
|
+
# List all vacation responders
|
|
729
|
+
result = api_instance.list_vacation_responders
|
|
731
730
|
p result
|
|
732
731
|
rescue Lockally::ApiError => e
|
|
733
|
-
puts "Error when calling MailboxesApi->
|
|
732
|
+
puts "Error when calling MailboxesApi->list_vacation_responders: #{e}"
|
|
734
733
|
end
|
|
735
734
|
```
|
|
736
735
|
|
|
737
|
-
#### Using the
|
|
736
|
+
#### Using the list_vacation_responders_with_http_info variant
|
|
738
737
|
|
|
739
738
|
This returns an Array which contains the response data, status code and headers.
|
|
740
739
|
|
|
741
|
-
> <Array(<
|
|
740
|
+
> <Array(<ListVacationResponders200Response>, Integer, Hash)> list_vacation_responders_with_http_info
|
|
742
741
|
|
|
743
742
|
```ruby
|
|
744
743
|
begin
|
|
745
|
-
#
|
|
746
|
-
data, status_code, headers = api_instance.
|
|
744
|
+
# List all vacation responders
|
|
745
|
+
data, status_code, headers = api_instance.list_vacation_responders_with_http_info
|
|
747
746
|
p status_code # => 2xx
|
|
748
747
|
p headers # => { ... }
|
|
749
|
-
p data # => <
|
|
748
|
+
p data # => <ListVacationResponders200Response>
|
|
750
749
|
rescue Lockally::ApiError => e
|
|
751
|
-
puts "Error when calling MailboxesApi->
|
|
750
|
+
puts "Error when calling MailboxesApi->list_vacation_responders_with_http_info: #{e}"
|
|
752
751
|
end
|
|
753
752
|
```
|
|
754
753
|
|
|
755
754
|
### Parameters
|
|
756
755
|
|
|
757
|
-
|
|
758
|
-
| ---- | ---- | ----------- | ----- |
|
|
759
|
-
| **email** | **String** | | |
|
|
760
|
-
| **v1_mailboxes_email_vacation_put_request** | [**V1MailboxesEmailVacationPutRequest**](V1MailboxesEmailVacationPutRequest.md) | | |
|
|
756
|
+
This endpoint does not need any parameter.
|
|
761
757
|
|
|
762
758
|
### Return type
|
|
763
759
|
|
|
764
|
-
[**
|
|
760
|
+
[**ListVacationResponders200Response**](ListVacationResponders200Response.md)
|
|
765
761
|
|
|
766
762
|
### Authorization
|
|
767
763
|
|
|
@@ -769,17 +765,15 @@ end
|
|
|
769
765
|
|
|
770
766
|
### HTTP request headers
|
|
771
767
|
|
|
772
|
-
- **Content-Type**:
|
|
768
|
+
- **Content-Type**: Not defined
|
|
773
769
|
- **Accept**: application/json, application/problem+json
|
|
774
770
|
|
|
775
771
|
|
|
776
|
-
##
|
|
777
|
-
|
|
778
|
-
> <V1MailboxesGet200Response> v1_mailboxes_get(opts)
|
|
772
|
+
## remove_shared_member
|
|
779
773
|
|
|
780
|
-
|
|
774
|
+
> remove_shared_member(email, member_email)
|
|
781
775
|
|
|
782
|
-
|
|
776
|
+
Remove a shared mailbox member
|
|
783
777
|
|
|
784
778
|
### Examples
|
|
785
779
|
|
|
@@ -793,34 +787,32 @@ Lockally.configure do |config|
|
|
|
793
787
|
end
|
|
794
788
|
|
|
795
789
|
api_instance = Lockally::MailboxesApi.new
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
}
|
|
790
|
+
email = 'email_example' # String |
|
|
791
|
+
member_email = 'member_email_example' # String |
|
|
799
792
|
|
|
800
793
|
begin
|
|
801
|
-
#
|
|
802
|
-
|
|
803
|
-
p result
|
|
794
|
+
# Remove a shared mailbox member
|
|
795
|
+
api_instance.remove_shared_member(email, member_email)
|
|
804
796
|
rescue Lockally::ApiError => e
|
|
805
|
-
puts "Error when calling MailboxesApi->
|
|
797
|
+
puts "Error when calling MailboxesApi->remove_shared_member: #{e}"
|
|
806
798
|
end
|
|
807
799
|
```
|
|
808
800
|
|
|
809
|
-
#### Using the
|
|
801
|
+
#### Using the remove_shared_member_with_http_info variant
|
|
810
802
|
|
|
811
|
-
This returns an Array which contains the response data, status code and headers.
|
|
803
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
812
804
|
|
|
813
|
-
> <Array(
|
|
805
|
+
> <Array(nil, Integer, Hash)> remove_shared_member_with_http_info(email, member_email)
|
|
814
806
|
|
|
815
807
|
```ruby
|
|
816
808
|
begin
|
|
817
|
-
#
|
|
818
|
-
data, status_code, headers = api_instance.
|
|
809
|
+
# Remove a shared mailbox member
|
|
810
|
+
data, status_code, headers = api_instance.remove_shared_member_with_http_info(email, member_email)
|
|
819
811
|
p status_code # => 2xx
|
|
820
812
|
p headers # => { ... }
|
|
821
|
-
p data # =>
|
|
813
|
+
p data # => nil
|
|
822
814
|
rescue Lockally::ApiError => e
|
|
823
|
-
puts "Error when calling MailboxesApi->
|
|
815
|
+
puts "Error when calling MailboxesApi->remove_shared_member_with_http_info: #{e}"
|
|
824
816
|
end
|
|
825
817
|
```
|
|
826
818
|
|
|
@@ -828,11 +820,12 @@ end
|
|
|
828
820
|
|
|
829
821
|
| Name | Type | Description | Notes |
|
|
830
822
|
| ---- | ---- | ----------- | ----- |
|
|
831
|
-
| **
|
|
823
|
+
| **email** | **String** | | |
|
|
824
|
+
| **member_email** | **String** | | |
|
|
832
825
|
|
|
833
826
|
### Return type
|
|
834
827
|
|
|
835
|
-
|
|
828
|
+
nil (empty response body)
|
|
836
829
|
|
|
837
830
|
### Authorization
|
|
838
831
|
|
|
@@ -841,16 +834,16 @@ end
|
|
|
841
834
|
### HTTP request headers
|
|
842
835
|
|
|
843
836
|
- **Content-Type**: Not defined
|
|
844
|
-
- **Accept**: application/
|
|
837
|
+
- **Accept**: application/problem+json
|
|
845
838
|
|
|
846
839
|
|
|
847
|
-
##
|
|
840
|
+
## set_vacation_responder
|
|
848
841
|
|
|
849
|
-
> <
|
|
842
|
+
> <VacationResponder> set_vacation_responder(email, set_vacation_responder_request)
|
|
850
843
|
|
|
851
|
-
|
|
844
|
+
Set the vacation responder
|
|
852
845
|
|
|
853
|
-
|
|
846
|
+
Upsert — same endpoint creates or replaces the rule. Clears `synced_at`; the rule is staged on lockally until a sync worker pushes it to the mail server.
|
|
854
847
|
|
|
855
848
|
### Examples
|
|
856
849
|
|
|
@@ -864,32 +857,33 @@ Lockally.configure do |config|
|
|
|
864
857
|
end
|
|
865
858
|
|
|
866
859
|
api_instance = Lockally::MailboxesApi.new
|
|
867
|
-
|
|
860
|
+
email = 'email_example' # String |
|
|
861
|
+
set_vacation_responder_request = Lockally::SetVacationResponderRequest.new({params: Lockally::VacationParams.new({subject: 'Out of office until June 5', body: 'Hi! I'm away until June 5. For urgent matters please contact ...'})}) # SetVacationResponderRequest |
|
|
868
862
|
|
|
869
863
|
begin
|
|
870
|
-
#
|
|
871
|
-
result = api_instance.
|
|
864
|
+
# Set the vacation responder
|
|
865
|
+
result = api_instance.set_vacation_responder(email, set_vacation_responder_request)
|
|
872
866
|
p result
|
|
873
867
|
rescue Lockally::ApiError => e
|
|
874
|
-
puts "Error when calling MailboxesApi->
|
|
868
|
+
puts "Error when calling MailboxesApi->set_vacation_responder: #{e}"
|
|
875
869
|
end
|
|
876
870
|
```
|
|
877
871
|
|
|
878
|
-
#### Using the
|
|
872
|
+
#### Using the set_vacation_responder_with_http_info variant
|
|
879
873
|
|
|
880
874
|
This returns an Array which contains the response data, status code and headers.
|
|
881
875
|
|
|
882
|
-
> <Array(<
|
|
876
|
+
> <Array(<VacationResponder>, Integer, Hash)> set_vacation_responder_with_http_info(email, set_vacation_responder_request)
|
|
883
877
|
|
|
884
878
|
```ruby
|
|
885
879
|
begin
|
|
886
|
-
#
|
|
887
|
-
data, status_code, headers = api_instance.
|
|
880
|
+
# Set the vacation responder
|
|
881
|
+
data, status_code, headers = api_instance.set_vacation_responder_with_http_info(email, set_vacation_responder_request)
|
|
888
882
|
p status_code # => 2xx
|
|
889
883
|
p headers # => { ... }
|
|
890
|
-
p data # => <
|
|
884
|
+
p data # => <VacationResponder>
|
|
891
885
|
rescue Lockally::ApiError => e
|
|
892
|
-
puts "Error when calling MailboxesApi->
|
|
886
|
+
puts "Error when calling MailboxesApi->set_vacation_responder_with_http_info: #{e}"
|
|
893
887
|
end
|
|
894
888
|
```
|
|
895
889
|
|
|
@@ -897,11 +891,12 @@ end
|
|
|
897
891
|
|
|
898
892
|
| Name | Type | Description | Notes |
|
|
899
893
|
| ---- | ---- | ----------- | ----- |
|
|
900
|
-
| **
|
|
894
|
+
| **email** | **String** | | |
|
|
895
|
+
| **set_vacation_responder_request** | [**SetVacationResponderRequest**](SetVacationResponderRequest.md) | | |
|
|
901
896
|
|
|
902
897
|
### Return type
|
|
903
898
|
|
|
904
|
-
[**
|
|
899
|
+
[**VacationResponder**](VacationResponder.md)
|
|
905
900
|
|
|
906
901
|
### Authorization
|
|
907
902
|
|
|
@@ -913,13 +908,13 @@ end
|
|
|
913
908
|
- **Accept**: application/json, application/problem+json
|
|
914
909
|
|
|
915
910
|
|
|
916
|
-
##
|
|
911
|
+
## update_mailbox
|
|
917
912
|
|
|
918
|
-
> <
|
|
913
|
+
> <Mailbox> update_mailbox(email, update_mailbox_request)
|
|
919
914
|
|
|
920
|
-
|
|
915
|
+
Update a mailbox
|
|
921
916
|
|
|
922
|
-
|
|
917
|
+
Supply at least one of `password`, `quota_bytes`, `disabled`. Returns the updated mailbox.
|
|
923
918
|
|
|
924
919
|
### Examples
|
|
925
920
|
|
|
@@ -933,41 +928,46 @@ Lockally.configure do |config|
|
|
|
933
928
|
end
|
|
934
929
|
|
|
935
930
|
api_instance = Lockally::MailboxesApi.new
|
|
931
|
+
email = 'email_example' # String |
|
|
932
|
+
update_mailbox_request = Lockally::UpdateMailboxRequest.new # UpdateMailboxRequest |
|
|
936
933
|
|
|
937
934
|
begin
|
|
938
|
-
#
|
|
939
|
-
result = api_instance.
|
|
935
|
+
# Update a mailbox
|
|
936
|
+
result = api_instance.update_mailbox(email, update_mailbox_request)
|
|
940
937
|
p result
|
|
941
938
|
rescue Lockally::ApiError => e
|
|
942
|
-
puts "Error when calling MailboxesApi->
|
|
939
|
+
puts "Error when calling MailboxesApi->update_mailbox: #{e}"
|
|
943
940
|
end
|
|
944
941
|
```
|
|
945
942
|
|
|
946
|
-
#### Using the
|
|
943
|
+
#### Using the update_mailbox_with_http_info variant
|
|
947
944
|
|
|
948
945
|
This returns an Array which contains the response data, status code and headers.
|
|
949
946
|
|
|
950
|
-
> <Array(<
|
|
947
|
+
> <Array(<Mailbox>, Integer, Hash)> update_mailbox_with_http_info(email, update_mailbox_request)
|
|
951
948
|
|
|
952
949
|
```ruby
|
|
953
950
|
begin
|
|
954
|
-
#
|
|
955
|
-
data, status_code, headers = api_instance.
|
|
951
|
+
# Update a mailbox
|
|
952
|
+
data, status_code, headers = api_instance.update_mailbox_with_http_info(email, update_mailbox_request)
|
|
956
953
|
p status_code # => 2xx
|
|
957
954
|
p headers # => { ... }
|
|
958
|
-
p data # => <
|
|
955
|
+
p data # => <Mailbox>
|
|
959
956
|
rescue Lockally::ApiError => e
|
|
960
|
-
puts "Error when calling MailboxesApi->
|
|
957
|
+
puts "Error when calling MailboxesApi->update_mailbox_with_http_info: #{e}"
|
|
961
958
|
end
|
|
962
959
|
```
|
|
963
960
|
|
|
964
961
|
### Parameters
|
|
965
962
|
|
|
966
|
-
|
|
963
|
+
| Name | Type | Description | Notes |
|
|
964
|
+
| ---- | ---- | ----------- | ----- |
|
|
965
|
+
| **email** | **String** | | |
|
|
966
|
+
| **update_mailbox_request** | [**UpdateMailboxRequest**](UpdateMailboxRequest.md) | | |
|
|
967
967
|
|
|
968
968
|
### Return type
|
|
969
969
|
|
|
970
|
-
[**
|
|
970
|
+
[**Mailbox**](Mailbox.md)
|
|
971
971
|
|
|
972
972
|
### Authorization
|
|
973
973
|
|
|
@@ -975,6 +975,6 @@ This endpoint does not need any parameter.
|
|
|
975
975
|
|
|
976
976
|
### HTTP request headers
|
|
977
977
|
|
|
978
|
-
- **Content-Type**:
|
|
978
|
+
- **Content-Type**: application/json
|
|
979
979
|
- **Accept**: application/json, application/problem+json
|
|
980
980
|
|