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
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Lockally::MarkReadResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **read** | **Boolean** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'lockally'
|
|
13
|
+
|
|
14
|
+
instance = Lockally::MarkReadResult.new(
|
|
15
|
+
read: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Lockally::MessageDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **tenant_id** | **String** | | |
|
|
9
|
+
| **message_id** | **String** | RFC 5322 Message-ID header, including angle brackets. | |
|
|
10
|
+
| **sender** | **String** | | |
|
|
11
|
+
| **recipients** | **Array<String>** | | |
|
|
12
|
+
| **subject** | **String** | | [optional] |
|
|
13
|
+
| **status** | **String** | | |
|
|
14
|
+
| **queued_at** | **Time** | | |
|
|
15
|
+
| **updated_at** | **Time** | | |
|
|
16
|
+
| **bounce_reason** | **String** | | [optional] |
|
|
17
|
+
| **size_bytes** | **Integer** | | [optional] |
|
|
18
|
+
| **from** | **String** | | [optional] |
|
|
19
|
+
| **to** | **Array<String>** | | [optional] |
|
|
20
|
+
| **cc** | **Array<String>** | | [optional] |
|
|
21
|
+
| **bcc** | **Array<String>** | | [optional] |
|
|
22
|
+
| **text** | **String** | | [optional] |
|
|
23
|
+
| **html** | **String** | | [optional] |
|
|
24
|
+
| **headers** | **Hash<String, String>** | | [optional] |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'lockally'
|
|
30
|
+
|
|
31
|
+
instance = Lockally::MessageDetail.new(
|
|
32
|
+
id: null,
|
|
33
|
+
tenant_id: null,
|
|
34
|
+
message_id: null,
|
|
35
|
+
sender: null,
|
|
36
|
+
recipients: null,
|
|
37
|
+
subject: null,
|
|
38
|
+
status: null,
|
|
39
|
+
queued_at: null,
|
|
40
|
+
updated_at: null,
|
|
41
|
+
bounce_reason: null,
|
|
42
|
+
size_bytes: null,
|
|
43
|
+
from: null,
|
|
44
|
+
to: null,
|
|
45
|
+
cc: null,
|
|
46
|
+
bcc: null,
|
|
47
|
+
text: null,
|
|
48
|
+
html: null,
|
|
49
|
+
headers: null
|
|
50
|
+
)
|
|
51
|
+
```
|
|
52
|
+
|
data/docs/ReturnPath.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Lockally::ReturnPath
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | |
|
|
8
|
+
| **host** | **String** | | |
|
|
9
|
+
| **records** | [**Array<DNSRecord>**](DNSRecord.md) | | |
|
|
10
|
+
| **check** | [**ReturnPathCheck**](ReturnPathCheck.md) | | [optional] |
|
|
11
|
+
| **requested_at** | **Time** | | [optional] |
|
|
12
|
+
| **verified_at** | **Time** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'lockally'
|
|
18
|
+
|
|
19
|
+
instance = Lockally::ReturnPath.new(
|
|
20
|
+
status: null,
|
|
21
|
+
host: bounces.acme.com,
|
|
22
|
+
records: null,
|
|
23
|
+
check: null,
|
|
24
|
+
requested_at: null,
|
|
25
|
+
verified_at: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Lockally::ReturnPathCheck
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mx** | **Boolean** | | [optional] |
|
|
8
|
+
| **spf** | **Boolean** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'lockally'
|
|
14
|
+
|
|
15
|
+
instance = Lockally::ReturnPathCheck.new(
|
|
16
|
+
mx: null,
|
|
17
|
+
spf: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/SendApi.md
CHANGED
|
@@ -4,21 +4,21 @@ All URIs are relative to *https://api.lockally.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
7
|
+
| [**cancel_message**](SendApi.md#cancel_message) | **DELETE** /v1/messages/{id} | Cancel a scheduled send |
|
|
8
|
+
| [**get_message**](SendApi.md#get_message) | **GET** /v1/messages/{id} | Get message status |
|
|
9
|
+
| [**get_message_stats**](SendApi.md#get_message_stats) | **GET** /v1/messages/stats | Aggregate delivery stats |
|
|
10
|
+
| [**list_messages**](SendApi.md#list_messages) | **GET** /v1/messages | List outbound messages |
|
|
11
|
+
| [**send_email**](SendApi.md#send_email) | **POST** /v1/send | Send an email |
|
|
12
|
+
| [**send_email_batch**](SendApi.md#send_email_batch) | **POST** /v1/send/batch | Send a batch of emails |
|
|
13
13
|
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## cancel_message
|
|
16
16
|
|
|
17
|
-
>
|
|
17
|
+
> cancel_message(id)
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Cancel a scheduled send
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
|
|
22
22
|
|
|
23
23
|
### Examples
|
|
24
24
|
|
|
@@ -32,39 +32,31 @@ Lockally.configure do |config|
|
|
|
32
32
|
end
|
|
33
33
|
|
|
34
34
|
api_instance = Lockally::SendApi.new
|
|
35
|
-
|
|
36
|
-
status: 'queued', # String |
|
|
37
|
-
sender: 'sender_example', # String | Exact match against the `from` mailbox.
|
|
38
|
-
q: 'q_example', # String | Free-text search across subject + sender.
|
|
39
|
-
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only messages queued at or after this RFC 3339 instant.
|
|
40
|
-
cursor: 'cursor_example', # String | queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
|
|
41
|
-
limit: 56 # Integer |
|
|
42
|
-
}
|
|
35
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
43
36
|
|
|
44
37
|
begin
|
|
45
|
-
#
|
|
46
|
-
|
|
47
|
-
p result
|
|
38
|
+
# Cancel a scheduled send
|
|
39
|
+
api_instance.cancel_message(id)
|
|
48
40
|
rescue Lockally::ApiError => e
|
|
49
|
-
puts "Error when calling SendApi->
|
|
41
|
+
puts "Error when calling SendApi->cancel_message: #{e}"
|
|
50
42
|
end
|
|
51
43
|
```
|
|
52
44
|
|
|
53
|
-
#### Using the
|
|
45
|
+
#### Using the cancel_message_with_http_info variant
|
|
54
46
|
|
|
55
|
-
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
56
48
|
|
|
57
|
-
> <Array(
|
|
49
|
+
> <Array(nil, Integer, Hash)> cancel_message_with_http_info(id)
|
|
58
50
|
|
|
59
51
|
```ruby
|
|
60
52
|
begin
|
|
61
|
-
#
|
|
62
|
-
data, status_code, headers = api_instance.
|
|
53
|
+
# Cancel a scheduled send
|
|
54
|
+
data, status_code, headers = api_instance.cancel_message_with_http_info(id)
|
|
63
55
|
p status_code # => 2xx
|
|
64
56
|
p headers # => { ... }
|
|
65
|
-
p data # =>
|
|
57
|
+
p data # => nil
|
|
66
58
|
rescue Lockally::ApiError => e
|
|
67
|
-
puts "Error when calling SendApi->
|
|
59
|
+
puts "Error when calling SendApi->cancel_message_with_http_info: #{e}"
|
|
68
60
|
end
|
|
69
61
|
```
|
|
70
62
|
|
|
@@ -72,16 +64,11 @@ end
|
|
|
72
64
|
|
|
73
65
|
| Name | Type | Description | Notes |
|
|
74
66
|
| ---- | ---- | ----------- | ----- |
|
|
75
|
-
| **
|
|
76
|
-
| **sender** | **String** | Exact match against the `from` mailbox. | [optional] |
|
|
77
|
-
| **q** | **String** | Free-text search across subject + sender. | [optional] |
|
|
78
|
-
| **since** | **Time** | Only messages queued at or after this RFC 3339 instant. | [optional] |
|
|
79
|
-
| **cursor** | **String** | queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call. | [optional] |
|
|
80
|
-
| **limit** | **Integer** | | [optional][default to 50] |
|
|
67
|
+
| **id** | **String** | | |
|
|
81
68
|
|
|
82
69
|
### Return type
|
|
83
70
|
|
|
84
|
-
|
|
71
|
+
nil (empty response body)
|
|
85
72
|
|
|
86
73
|
### Authorization
|
|
87
74
|
|
|
@@ -90,16 +77,14 @@ end
|
|
|
90
77
|
### HTTP request headers
|
|
91
78
|
|
|
92
79
|
- **Content-Type**: Not defined
|
|
93
|
-
- **Accept**: application/
|
|
94
|
-
|
|
80
|
+
- **Accept**: application/problem+json
|
|
95
81
|
|
|
96
|
-
## v1_messages_id_delete
|
|
97
82
|
|
|
98
|
-
|
|
83
|
+
## get_message
|
|
99
84
|
|
|
100
|
-
|
|
85
|
+
> <MessageDetail> get_message(id)
|
|
101
86
|
|
|
102
|
-
|
|
87
|
+
Get message status
|
|
103
88
|
|
|
104
89
|
### Examples
|
|
105
90
|
|
|
@@ -116,28 +101,29 @@ api_instance = Lockally::SendApi.new
|
|
|
116
101
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
117
102
|
|
|
118
103
|
begin
|
|
119
|
-
#
|
|
120
|
-
api_instance.
|
|
104
|
+
# Get message status
|
|
105
|
+
result = api_instance.get_message(id)
|
|
106
|
+
p result
|
|
121
107
|
rescue Lockally::ApiError => e
|
|
122
|
-
puts "Error when calling SendApi->
|
|
108
|
+
puts "Error when calling SendApi->get_message: #{e}"
|
|
123
109
|
end
|
|
124
110
|
```
|
|
125
111
|
|
|
126
|
-
#### Using the
|
|
112
|
+
#### Using the get_message_with_http_info variant
|
|
127
113
|
|
|
128
|
-
This returns an Array which contains the response data
|
|
114
|
+
This returns an Array which contains the response data, status code and headers.
|
|
129
115
|
|
|
130
|
-
> <Array(
|
|
116
|
+
> <Array(<MessageDetail>, Integer, Hash)> get_message_with_http_info(id)
|
|
131
117
|
|
|
132
118
|
```ruby
|
|
133
119
|
begin
|
|
134
|
-
#
|
|
135
|
-
data, status_code, headers = api_instance.
|
|
120
|
+
# Get message status
|
|
121
|
+
data, status_code, headers = api_instance.get_message_with_http_info(id)
|
|
136
122
|
p status_code # => 2xx
|
|
137
123
|
p headers # => { ... }
|
|
138
|
-
p data # =>
|
|
124
|
+
p data # => <MessageDetail>
|
|
139
125
|
rescue Lockally::ApiError => e
|
|
140
|
-
puts "Error when calling SendApi->
|
|
126
|
+
puts "Error when calling SendApi->get_message_with_http_info: #{e}"
|
|
141
127
|
end
|
|
142
128
|
```
|
|
143
129
|
|
|
@@ -149,7 +135,7 @@ end
|
|
|
149
135
|
|
|
150
136
|
### Return type
|
|
151
137
|
|
|
152
|
-
|
|
138
|
+
[**MessageDetail**](MessageDetail.md)
|
|
153
139
|
|
|
154
140
|
### Authorization
|
|
155
141
|
|
|
@@ -158,14 +144,16 @@ nil (empty response body)
|
|
|
158
144
|
### HTTP request headers
|
|
159
145
|
|
|
160
146
|
- **Content-Type**: Not defined
|
|
161
|
-
- **Accept**: application/problem+json
|
|
147
|
+
- **Accept**: application/json, application/problem+json
|
|
162
148
|
|
|
163
149
|
|
|
164
|
-
##
|
|
150
|
+
## get_message_stats
|
|
165
151
|
|
|
166
|
-
> <
|
|
152
|
+
> <MessageStats> get_message_stats(opts)
|
|
167
153
|
|
|
168
|
-
|
|
154
|
+
Aggregate delivery stats
|
|
155
|
+
|
|
156
|
+
Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking.
|
|
169
157
|
|
|
170
158
|
### Examples
|
|
171
159
|
|
|
@@ -179,32 +167,36 @@ Lockally.configure do |config|
|
|
|
179
167
|
end
|
|
180
168
|
|
|
181
169
|
api_instance = Lockally::SendApi.new
|
|
182
|
-
|
|
170
|
+
opts = {
|
|
171
|
+
from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window start (default 7 days ago).
|
|
172
|
+
to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window end (default now).
|
|
173
|
+
domain: 'domain_example' # String | Filter by sender domain.
|
|
174
|
+
}
|
|
183
175
|
|
|
184
176
|
begin
|
|
185
|
-
#
|
|
186
|
-
result = api_instance.
|
|
177
|
+
# Aggregate delivery stats
|
|
178
|
+
result = api_instance.get_message_stats(opts)
|
|
187
179
|
p result
|
|
188
180
|
rescue Lockally::ApiError => e
|
|
189
|
-
puts "Error when calling SendApi->
|
|
181
|
+
puts "Error when calling SendApi->get_message_stats: #{e}"
|
|
190
182
|
end
|
|
191
183
|
```
|
|
192
184
|
|
|
193
|
-
#### Using the
|
|
185
|
+
#### Using the get_message_stats_with_http_info variant
|
|
194
186
|
|
|
195
187
|
This returns an Array which contains the response data, status code and headers.
|
|
196
188
|
|
|
197
|
-
> <Array(<
|
|
189
|
+
> <Array(<MessageStats>, Integer, Hash)> get_message_stats_with_http_info(opts)
|
|
198
190
|
|
|
199
191
|
```ruby
|
|
200
192
|
begin
|
|
201
|
-
#
|
|
202
|
-
data, status_code, headers = api_instance.
|
|
193
|
+
# Aggregate delivery stats
|
|
194
|
+
data, status_code, headers = api_instance.get_message_stats_with_http_info(opts)
|
|
203
195
|
p status_code # => 2xx
|
|
204
196
|
p headers # => { ... }
|
|
205
|
-
p data # => <
|
|
197
|
+
p data # => <MessageStats>
|
|
206
198
|
rescue Lockally::ApiError => e
|
|
207
|
-
puts "Error when calling SendApi->
|
|
199
|
+
puts "Error when calling SendApi->get_message_stats_with_http_info: #{e}"
|
|
208
200
|
end
|
|
209
201
|
```
|
|
210
202
|
|
|
@@ -212,11 +204,13 @@ end
|
|
|
212
204
|
|
|
213
205
|
| Name | Type | Description | Notes |
|
|
214
206
|
| ---- | ---- | ----------- | ----- |
|
|
215
|
-
| **
|
|
207
|
+
| **from** | **Time** | Window start (default 7 days ago). | [optional] |
|
|
208
|
+
| **to** | **Time** | Window end (default now). | [optional] |
|
|
209
|
+
| **domain** | **String** | Filter by sender domain. | [optional] |
|
|
216
210
|
|
|
217
211
|
### Return type
|
|
218
212
|
|
|
219
|
-
[**
|
|
213
|
+
[**MessageStats**](MessageStats.md)
|
|
220
214
|
|
|
221
215
|
### Authorization
|
|
222
216
|
|
|
@@ -228,13 +222,13 @@ end
|
|
|
228
222
|
- **Accept**: application/json, application/problem+json
|
|
229
223
|
|
|
230
224
|
|
|
231
|
-
##
|
|
225
|
+
## list_messages
|
|
232
226
|
|
|
233
|
-
> <
|
|
227
|
+
> <ListMessages200Response> list_messages(opts)
|
|
234
228
|
|
|
235
|
-
|
|
229
|
+
List outbound messages
|
|
236
230
|
|
|
237
|
-
|
|
231
|
+
Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box.
|
|
238
232
|
|
|
239
233
|
### Examples
|
|
240
234
|
|
|
@@ -249,35 +243,38 @@ end
|
|
|
249
243
|
|
|
250
244
|
api_instance = Lockally::SendApi.new
|
|
251
245
|
opts = {
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
246
|
+
status: 'queued', # String |
|
|
247
|
+
sender: 'sender_example', # String | Exact match against the `from` mailbox.
|
|
248
|
+
q: 'q_example', # String | Free-text search across subject + sender.
|
|
249
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only messages queued at or after this RFC 3339 instant.
|
|
250
|
+
cursor: 'cursor_example', # String | queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
|
|
251
|
+
limit: 56 # Integer |
|
|
255
252
|
}
|
|
256
253
|
|
|
257
254
|
begin
|
|
258
|
-
#
|
|
259
|
-
result = api_instance.
|
|
255
|
+
# List outbound messages
|
|
256
|
+
result = api_instance.list_messages(opts)
|
|
260
257
|
p result
|
|
261
258
|
rescue Lockally::ApiError => e
|
|
262
|
-
puts "Error when calling SendApi->
|
|
259
|
+
puts "Error when calling SendApi->list_messages: #{e}"
|
|
263
260
|
end
|
|
264
261
|
```
|
|
265
262
|
|
|
266
|
-
#### Using the
|
|
263
|
+
#### Using the list_messages_with_http_info variant
|
|
267
264
|
|
|
268
265
|
This returns an Array which contains the response data, status code and headers.
|
|
269
266
|
|
|
270
|
-
> <Array(<
|
|
267
|
+
> <Array(<ListMessages200Response>, Integer, Hash)> list_messages_with_http_info(opts)
|
|
271
268
|
|
|
272
269
|
```ruby
|
|
273
270
|
begin
|
|
274
|
-
#
|
|
275
|
-
data, status_code, headers = api_instance.
|
|
271
|
+
# List outbound messages
|
|
272
|
+
data, status_code, headers = api_instance.list_messages_with_http_info(opts)
|
|
276
273
|
p status_code # => 2xx
|
|
277
274
|
p headers # => { ... }
|
|
278
|
-
p data # => <
|
|
275
|
+
p data # => <ListMessages200Response>
|
|
279
276
|
rescue Lockally::ApiError => e
|
|
280
|
-
puts "Error when calling SendApi->
|
|
277
|
+
puts "Error when calling SendApi->list_messages_with_http_info: #{e}"
|
|
281
278
|
end
|
|
282
279
|
```
|
|
283
280
|
|
|
@@ -285,13 +282,16 @@ end
|
|
|
285
282
|
|
|
286
283
|
| Name | Type | Description | Notes |
|
|
287
284
|
| ---- | ---- | ----------- | ----- |
|
|
288
|
-
| **
|
|
289
|
-
| **
|
|
290
|
-
| **
|
|
285
|
+
| **status** | **String** | | [optional] |
|
|
286
|
+
| **sender** | **String** | Exact match against the `from` mailbox. | [optional] |
|
|
287
|
+
| **q** | **String** | Free-text search across subject + sender. | [optional] |
|
|
288
|
+
| **since** | **Time** | Only messages queued at or after this RFC 3339 instant. | [optional] |
|
|
289
|
+
| **cursor** | **String** | queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call. | [optional] |
|
|
290
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
291
291
|
|
|
292
292
|
### Return type
|
|
293
293
|
|
|
294
|
-
[**
|
|
294
|
+
[**ListMessages200Response**](ListMessages200Response.md)
|
|
295
295
|
|
|
296
296
|
### Authorization
|
|
297
297
|
|
|
@@ -303,13 +303,13 @@ end
|
|
|
303
303
|
- **Accept**: application/json, application/problem+json
|
|
304
304
|
|
|
305
305
|
|
|
306
|
-
##
|
|
306
|
+
## send_email
|
|
307
307
|
|
|
308
|
-
> <
|
|
308
|
+
> <SendEmail200Response> send_email(idempotency_key, send_email_request)
|
|
309
309
|
|
|
310
|
-
Send
|
|
310
|
+
Send an email
|
|
311
311
|
|
|
312
|
-
|
|
312
|
+
Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`. **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message. **Sender authorisation.** `from` must be an address the calling tenant owns on a verified domain. A mailbox always qualifies. On business and combined accounts an **alias** qualifies too, so a send-only address such as `no-reply@` need not be a billed seat. An alias on an unverified domain, or one belonging to another account, is refused with `403`. A catch-all creates no aliases and so grants no sending rights. **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped. **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. **Not every success is a 202.** Check the status code, not just the body. A `200` means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the `200` response below. **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry `X-Warmup-Day`, `X-Warmup-Daily-Cap` and `X-Warmup-Used-Today`. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429.
|
|
313
313
|
|
|
314
314
|
### Examples
|
|
315
315
|
|
|
@@ -324,32 +324,32 @@ end
|
|
|
324
324
|
|
|
325
325
|
api_instance = Lockally::SendApi.new
|
|
326
326
|
idempotency_key = 'idempotency_key_example' # String |
|
|
327
|
-
|
|
327
|
+
send_email_request = Lockally::SendEmailRequest.new({from: 'from_example', to: ['to_example']}) # SendEmailRequest |
|
|
328
328
|
|
|
329
329
|
begin
|
|
330
|
-
# Send
|
|
331
|
-
result = api_instance.
|
|
330
|
+
# Send an email
|
|
331
|
+
result = api_instance.send_email(idempotency_key, send_email_request)
|
|
332
332
|
p result
|
|
333
333
|
rescue Lockally::ApiError => e
|
|
334
|
-
puts "Error when calling SendApi->
|
|
334
|
+
puts "Error when calling SendApi->send_email: #{e}"
|
|
335
335
|
end
|
|
336
336
|
```
|
|
337
337
|
|
|
338
|
-
#### Using the
|
|
338
|
+
#### Using the send_email_with_http_info variant
|
|
339
339
|
|
|
340
340
|
This returns an Array which contains the response data, status code and headers.
|
|
341
341
|
|
|
342
|
-
> <Array(<
|
|
342
|
+
> <Array(<SendEmail200Response>, Integer, Hash)> send_email_with_http_info(idempotency_key, send_email_request)
|
|
343
343
|
|
|
344
344
|
```ruby
|
|
345
345
|
begin
|
|
346
|
-
# Send
|
|
347
|
-
data, status_code, headers = api_instance.
|
|
346
|
+
# Send an email
|
|
347
|
+
data, status_code, headers = api_instance.send_email_with_http_info(idempotency_key, send_email_request)
|
|
348
348
|
p status_code # => 2xx
|
|
349
349
|
p headers # => { ... }
|
|
350
|
-
p data # => <
|
|
350
|
+
p data # => <SendEmail200Response>
|
|
351
351
|
rescue Lockally::ApiError => e
|
|
352
|
-
puts "Error when calling SendApi->
|
|
352
|
+
puts "Error when calling SendApi->send_email_with_http_info: #{e}"
|
|
353
353
|
end
|
|
354
354
|
```
|
|
355
355
|
|
|
@@ -358,11 +358,11 @@ end
|
|
|
358
358
|
| Name | Type | Description | Notes |
|
|
359
359
|
| ---- | ---- | ----------- | ----- |
|
|
360
360
|
| **idempotency_key** | **String** | | |
|
|
361
|
-
| **
|
|
361
|
+
| **send_email_request** | [**SendEmailRequest**](SendEmailRequest.md) | | |
|
|
362
362
|
|
|
363
363
|
### Return type
|
|
364
364
|
|
|
365
|
-
[**
|
|
365
|
+
[**SendEmail200Response**](SendEmail200Response.md)
|
|
366
366
|
|
|
367
367
|
### Authorization
|
|
368
368
|
|
|
@@ -374,13 +374,13 @@ end
|
|
|
374
374
|
- **Accept**: application/json, application/problem+json
|
|
375
375
|
|
|
376
376
|
|
|
377
|
-
##
|
|
377
|
+
## send_email_batch
|
|
378
378
|
|
|
379
|
-
> <
|
|
379
|
+
> <SendEmailBatch200Response> send_email_batch(idempotency_key, send_email_batch_request)
|
|
380
380
|
|
|
381
|
-
Send
|
|
381
|
+
Send a batch of emails
|
|
382
382
|
|
|
383
|
-
|
|
383
|
+
Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`.
|
|
384
384
|
|
|
385
385
|
### Examples
|
|
386
386
|
|
|
@@ -395,32 +395,32 @@ end
|
|
|
395
395
|
|
|
396
396
|
api_instance = Lockally::SendApi.new
|
|
397
397
|
idempotency_key = 'idempotency_key_example' # String |
|
|
398
|
-
|
|
398
|
+
send_email_batch_request = Lockally::SendEmailBatchRequest.new({messages: [Lockally::SendMessage.new({from: 'from_example', to: ['to_example']})]}) # SendEmailBatchRequest |
|
|
399
399
|
|
|
400
400
|
begin
|
|
401
|
-
# Send
|
|
402
|
-
result = api_instance.
|
|
401
|
+
# Send a batch of emails
|
|
402
|
+
result = api_instance.send_email_batch(idempotency_key, send_email_batch_request)
|
|
403
403
|
p result
|
|
404
404
|
rescue Lockally::ApiError => e
|
|
405
|
-
puts "Error when calling SendApi->
|
|
405
|
+
puts "Error when calling SendApi->send_email_batch: #{e}"
|
|
406
406
|
end
|
|
407
407
|
```
|
|
408
408
|
|
|
409
|
-
#### Using the
|
|
409
|
+
#### Using the send_email_batch_with_http_info variant
|
|
410
410
|
|
|
411
411
|
This returns an Array which contains the response data, status code and headers.
|
|
412
412
|
|
|
413
|
-
> <Array(<
|
|
413
|
+
> <Array(<SendEmailBatch200Response>, Integer, Hash)> send_email_batch_with_http_info(idempotency_key, send_email_batch_request)
|
|
414
414
|
|
|
415
415
|
```ruby
|
|
416
416
|
begin
|
|
417
|
-
# Send
|
|
418
|
-
data, status_code, headers = api_instance.
|
|
417
|
+
# Send a batch of emails
|
|
418
|
+
data, status_code, headers = api_instance.send_email_batch_with_http_info(idempotency_key, send_email_batch_request)
|
|
419
419
|
p status_code # => 2xx
|
|
420
420
|
p headers # => { ... }
|
|
421
|
-
p data # => <
|
|
421
|
+
p data # => <SendEmailBatch200Response>
|
|
422
422
|
rescue Lockally::ApiError => e
|
|
423
|
-
puts "Error when calling SendApi->
|
|
423
|
+
puts "Error when calling SendApi->send_email_batch_with_http_info: #{e}"
|
|
424
424
|
end
|
|
425
425
|
```
|
|
426
426
|
|
|
@@ -429,11 +429,11 @@ end
|
|
|
429
429
|
| Name | Type | Description | Notes |
|
|
430
430
|
| ---- | ---- | ----------- | ----- |
|
|
431
431
|
| **idempotency_key** | **String** | | |
|
|
432
|
-
| **
|
|
432
|
+
| **send_email_batch_request** | [**SendEmailBatchRequest**](SendEmailBatchRequest.md) | | |
|
|
433
433
|
|
|
434
434
|
### Return type
|
|
435
435
|
|
|
436
|
-
[**
|
|
436
|
+
[**SendEmailBatch200Response**](SendEmailBatch200Response.md)
|
|
437
437
|
|
|
438
438
|
### Authorization
|
|
439
439
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Lockally::SendEmail200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Present on a test-mode send; absent when suppressed. | [optional] |
|
|
8
|
+
| **message_id** | **String** | RFC 5322 Message-ID. On a test send the domain is test.lockally.com. Absent when suppressed. | [optional] |
|
|
9
|
+
| **status** | **String** | | |
|
|
10
|
+
| **warning** | **String** | On a suppressed send, explains that nothing was sent. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'lockally'
|
|
16
|
+
|
|
17
|
+
instance = Lockally::SendEmail200Response.new(
|
|
18
|
+
id: null,
|
|
19
|
+
message_id: null,
|
|
20
|
+
status: null,
|
|
21
|
+
warning: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Lockally::
|
|
1
|
+
# Lockally::SendEmail202Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'lockally'
|
|
16
16
|
|
|
17
|
-
instance = Lockally::
|
|
17
|
+
instance = Lockally::SendEmail202Response.new(
|
|
18
18
|
id: null,
|
|
19
19
|
message_id: null,
|
|
20
20
|
status: null,
|