lockally 0.1.0 → 0.2.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 +32 -7
- data/docs/AliasesApi.md +1 -1
- data/docs/BatchResult.md +1 -1
- data/docs/Calendar.md +8 -0
- data/docs/CalendarsApi.md +73 -0
- data/docs/DomainsApi.md +279 -0
- data/docs/GetCalendarOverview200Response.md +34 -0
- data/docs/GetCalendarOverview200ResponseActivityInner.md +24 -0
- data/docs/GetUserInsights200Response.md +2 -0
- data/docs/MailboxesApi.md +1 -1
- data/docs/MessageDetail.md +52 -0
- data/docs/ReturnPath.md +28 -0
- data/docs/ReturnPathCheck.md +20 -0
- data/docs/SendApi.md +9 -9
- data/docs/SendMessage.md +4 -0
- data/docs/V1ApiKeysPostRequest.md +3 -1
- data/docs/V1SendPost200Response.md +24 -0
- data/docs/V1SendPostRequest.md +4 -0
- data/lib/lockally/api/add_ons_api.rb +1 -1
- data/lib/lockally/api/admin_api.rb +1 -1
- data/lib/lockally/api/admins_api.rb +1 -1
- data/lib/lockally/api/agents_api.rb +1 -1
- data/lib/lockally/api/ai_api.rb +1 -1
- data/lib/lockally/api/aliases_api.rb +3 -3
- data/lib/lockally/api/api_keys_api.rb +1 -1
- 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 +253 -1
- data/lib/lockally/api/drafts_api.rb +1 -1
- data/lib/lockally/api/encryption_api.rb +1 -1
- data/lib/lockally/api/health_api.rb +1 -1
- data/lib/lockally/api/ip_pools_api.rb +1 -1
- data/lib/lockally/api/mailboxes_api.rb +3 -3
- 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 +9 -9
- data/lib/lockally/api/signup_api.rb +1 -1
- data/lib/lockally/api/suppressions_api.rb +1 -1
- data/lib/lockally/api/templates_api.rb +1 -1
- data/lib/lockally/api/tenant_api.rb +1 -1
- data/lib/lockally/api/test_api.rb +1 -1
- data/lib/lockally/api/users_api.rb +1 -1
- data/lib/lockally/api/webhooks_api.rb +1 -1
- 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/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/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/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/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/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/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/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/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/get_user_insights200_response.rb +12 -2
- data/lib/lockally/models/healthz_get200_response.rb +1 -1
- data/lib/lockally/models/list_add_ons200_response.rb +1 -1
- 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/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/list_users200_response.rb +1 -1
- data/lib/lockally/models/mailbox.rb +1 -1
- 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/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_message.rb +22 -2
- data/lib/lockally/models/shared_member.rb +1 -1
- data/lib/lockally/models/signup_request.rb +1 -1
- 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/unit_bundle.rb +1 -1
- 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/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/user.rb +1 -1
- data/lib/lockally/models/user_event.rb +1 -1
- data/lib/lockally/models/v1_admin_login_post200_response.rb +1 -1
- data/lib/lockally/models/v1_admin_login_post_request.rb +1 -1
- data/lib/lockally/models/v1_admin_me_get200_response.rb +1 -1
- data/lib/lockally/models/v1_admins_get200_response.rb +1 -1
- data/lib/lockally/models/v1_admins_id_patch_request.rb +1 -1
- data/lib/lockally/models/v1_admins_post_request.rb +1 -1
- data/lib/lockally/models/v1_aliases_get200_response.rb +1 -1
- data/lib/lockally/models/v1_aliases_post_request.rb +1 -1
- data/lib/lockally/models/v1_api_keys_get200_response.rb +1 -1
- data/lib/lockally/models/v1_api_keys_post201_response.rb +1 -1
- data/lib/lockally/models/v1_api_keys_post_request.rb +17 -5
- data/lib/lockally/models/v1_domains_get200_response.rb +1 -1
- data/lib/lockally/models/v1_domains_post_request.rb +1 -1
- data/lib/lockally/models/v1_inboxes_mailbox_messages_post_request.rb +1 -1
- data/lib/lockally/models/v1_mailboxes_email_export_post201_response.rb +1 -1
- data/lib/lockally/models/v1_mailboxes_email_patch_request.rb +1 -1
- data/lib/lockally/models/v1_mailboxes_email_vacation_put_request.rb +1 -1
- data/lib/lockally/models/v1_mailboxes_get200_response.rb +1 -1
- data/lib/lockally/models/v1_mailboxes_post_request.rb +1 -1
- data/lib/lockally/models/v1_messages_get200_response.rb +1 -1
- data/lib/lockally/models/v1_send_batch_post200_response.rb +1 -1
- data/lib/lockally/models/v1_send_batch_post_request.rb +1 -1
- data/lib/lockally/models/v1_send_post200_response.rb +218 -0
- data/lib/lockally/models/v1_send_post202_response.rb +1 -1
- data/lib/lockally/models/v1_send_post_request.rb +22 -2
- data/lib/lockally/models/v1_send_post_request_attachments_inner.rb +1 -1
- data/lib/lockally/models/v1_suppressions_get200_response.rb +1 -1
- data/lib/lockally/models/v1_suppressions_post_request.rb +1 -1
- data/lib/lockally/models/v1_templates_get200_response.rb +1 -1
- data/lib/lockally/models/v1_usage_get200_response.rb +1 -1
- data/lib/lockally/models/v1_vacation_get200_response.rb +1 -1
- data/lib/lockally/models/v1_webhooks_get200_response.rb +1 -1
- data/lib/lockally/models/v1_webhooks_id_patch_request.rb +1 -1
- data/lib/lockally/models/v1_webhooks_post_request.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/version.rb +2 -2
- data/lib/lockally.rb +7 -1
- data/lockally.gemspec +2 -2
- data/spec/api/add_ons_api_spec.rb +1 -1
- data/spec/api/admin_api_spec.rb +1 -1
- data/spec/api/admins_api_spec.rb +1 -1
- data/spec/api/agents_api_spec.rb +1 -1
- data/spec/api/ai_api_spec.rb +1 -1
- data/spec/api/aliases_api_spec.rb +2 -2
- data/spec/api/api_keys_api_spec.rb +1 -1
- 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 +49 -1
- data/spec/api/drafts_api_spec.rb +1 -1
- data/spec/api/encryption_api_spec.rb +1 -1
- data/spec/api/health_api_spec.rb +1 -1
- data/spec/api/ip_pools_api_spec.rb +1 -1
- data/spec/api/mailboxes_api_spec.rb +2 -2
- 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 +4 -4
- data/spec/api/signup_api_spec.rb +1 -1
- data/spec/api/suppressions_api_spec.rb +1 -1
- data/spec/api/templates_api_spec.rb +1 -1
- data/spec/api/tenant_api_spec.rb +1 -1
- data/spec/api/test_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- 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/admin_spec.rb +1 -1
- 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_spec.rb +1 -1
- 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/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/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/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/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/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/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/get_user_insights200_response_spec.rb +7 -1
- data/spec/models/healthz_get200_response_spec.rb +1 -1
- data/spec/models/list_add_ons200_response_spec.rb +1 -1
- 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_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/list_users200_response_spec.rb +1 -1
- 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/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_message_spec.rb +13 -1
- data/spec/models/shared_member_spec.rb +1 -1
- data/spec/models/signup_request_spec.rb +1 -1
- 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/unit_bundle_spec.rb +1 -1
- 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/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/user_event_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/v1_admin_login_post200_response_spec.rb +1 -1
- data/spec/models/v1_admin_login_post_request_spec.rb +1 -1
- data/spec/models/v1_admin_me_get200_response_spec.rb +1 -1
- data/spec/models/v1_admins_get200_response_spec.rb +1 -1
- data/spec/models/v1_admins_id_patch_request_spec.rb +1 -1
- data/spec/models/v1_admins_post_request_spec.rb +1 -1
- data/spec/models/v1_aliases_get200_response_spec.rb +1 -1
- data/spec/models/v1_aliases_post_request_spec.rb +1 -1
- data/spec/models/v1_api_keys_get200_response_spec.rb +1 -1
- data/spec/models/v1_api_keys_post201_response_spec.rb +1 -1
- data/spec/models/v1_api_keys_post_request_spec.rb +8 -2
- data/spec/models/v1_domains_get200_response_spec.rb +1 -1
- data/spec/models/v1_domains_post_request_spec.rb +1 -1
- data/spec/models/v1_inboxes_mailbox_messages_post_request_spec.rb +1 -1
- data/spec/models/v1_mailboxes_email_export_post201_response_spec.rb +1 -1
- data/spec/models/v1_mailboxes_email_patch_request_spec.rb +1 -1
- data/spec/models/v1_mailboxes_email_vacation_put_request_spec.rb +1 -1
- data/spec/models/v1_mailboxes_get200_response_spec.rb +1 -1
- data/spec/models/v1_mailboxes_post_request_spec.rb +1 -1
- data/spec/models/v1_messages_get200_response_spec.rb +1 -1
- data/spec/models/v1_send_batch_post200_response_spec.rb +1 -1
- data/spec/models/v1_send_batch_post_request_spec.rb +1 -1
- data/spec/models/v1_send_post200_response_spec.rb +58 -0
- data/spec/models/v1_send_post202_response_spec.rb +1 -1
- data/spec/models/v1_send_post_request_attachments_inner_spec.rb +1 -1
- data/spec/models/v1_send_post_request_spec.rb +13 -1
- data/spec/models/v1_suppressions_get200_response_spec.rb +1 -1
- data/spec/models/v1_suppressions_post_request_spec.rb +1 -1
- data/spec/models/v1_templates_get200_response_spec.rb +1 -1
- data/spec/models/v1_usage_get200_response_spec.rb +1 -1
- data/spec/models/v1_vacation_get200_response_spec.rb +1 -1
- data/spec/models/v1_webhooks_get200_response_spec.rb +1 -1
- data/spec/models/v1_webhooks_id_patch_request_spec.rb +1 -1
- data/spec/models/v1_webhooks_post_request_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/spec_helper.rb +1 -1
- metadata +207 -180
data/lockally.gemspec
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#lockally control plane
|
|
5
5
|
|
|
6
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
6
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
7
7
|
|
|
8
8
|
The version of the OpenAPI document: 0.1.0
|
|
9
9
|
Contact: support@lockally.com
|
|
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
|
|
|
23
23
|
s.email = ["support@lockally.com"]
|
|
24
24
|
s.homepage = "https://lockally.com"
|
|
25
25
|
s.summary = "Ruby client for the Lockally API"
|
|
26
|
-
s.description = "The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
26
|
+
s.description = "The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. "
|
|
27
27
|
s.license = "MIT"
|
|
28
28
|
s.required_ruby_version = ">= 2.7"
|
|
29
29
|
s.metadata = {}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/admin_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/admins_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/agents_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/ai_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -56,7 +56,7 @@ describe 'AliasesApi' do
|
|
|
56
56
|
|
|
57
57
|
# unit tests for v1_aliases_post
|
|
58
58
|
# Create an alias
|
|
59
|
-
# Creates an email alias. `alias_address` must be on a verified tenant-owned domain. `alias_target`
|
|
59
|
+
# Creates an email alias. `alias_address` must be on a verified tenant-owned domain and must not be the address of an existing mailbox (live, suspended or deleted). `alias_target` must be an active mailbox in the same workspace; forwarding to an address Lockally does not host is not supported. The alias delivers as soon as the call returns.
|
|
60
60
|
# @param v1_aliases_post_request
|
|
61
61
|
# @param [Hash] opts the optional parameters
|
|
62
62
|
# @return [ModelAlias]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -69,6 +69,7 @@ describe 'CalendarsApi' do
|
|
|
69
69
|
|
|
70
70
|
# unit tests for create_calendar_integration
|
|
71
71
|
# Create a calendar integration
|
|
72
|
+
# Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn.
|
|
72
73
|
# @param create_calendar_integration_request
|
|
73
74
|
# @param [Hash] opts the optional parameters
|
|
74
75
|
# @return [CalendarIntegration]
|
|
@@ -123,6 +124,17 @@ describe 'CalendarsApi' do
|
|
|
123
124
|
end
|
|
124
125
|
end
|
|
125
126
|
|
|
127
|
+
# unit tests for get_calendar_overview
|
|
128
|
+
# Administrative overview of the organization's calendar system
|
|
129
|
+
# Counts across the whole account, plus the recent calendar entries from the audit trail. Not scoped to the caller's own calendar.
|
|
130
|
+
# @param [Hash] opts the optional parameters
|
|
131
|
+
# @return [GetCalendarOverview200Response]
|
|
132
|
+
describe 'get_calendar_overview test' do
|
|
133
|
+
it 'should work' do
|
|
134
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
|
|
126
138
|
# unit tests for get_calendar_policies
|
|
127
139
|
# Get calendar policies
|
|
128
140
|
# @param [Hash] opts the optional parameters
|
|
@@ -201,6 +213,7 @@ describe 'CalendarsApi' do
|
|
|
201
213
|
|
|
202
214
|
# unit tests for sync_calendar_integration
|
|
203
215
|
# Trigger sync for a calendar integration
|
|
216
|
+
# Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn.
|
|
204
217
|
# @param id
|
|
205
218
|
# @param [Hash] opts the optional parameters
|
|
206
219
|
# @return [CalendarIntegration]
|
|
@@ -237,6 +250,7 @@ describe 'CalendarsApi' do
|
|
|
237
250
|
|
|
238
251
|
# unit tests for update_calendar_integration
|
|
239
252
|
# Update a calendar integration
|
|
253
|
+
# Not implemented. Calendar integrations do not sync with any provider yet, so this always answers 501. Listing and deleting still work, for entries created before the feature was withdrawn.
|
|
240
254
|
# @param id
|
|
241
255
|
# @param update_calendar_integration_request
|
|
242
256
|
# @param [Hash] opts the optional parameters
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -55,6 +55,54 @@ describe 'DomainsApi' do
|
|
|
55
55
|
end
|
|
56
56
|
end
|
|
57
57
|
|
|
58
|
+
# unit tests for v1_domains_domain_return_path_delete
|
|
59
|
+
# Turn off the custom Return-Path
|
|
60
|
+
# API mail uses the sender's own address as the envelope sender again, from the next message.
|
|
61
|
+
# @param domain
|
|
62
|
+
# @param [Hash] opts the optional parameters
|
|
63
|
+
# @return [nil]
|
|
64
|
+
describe 'v1_domains_domain_return_path_delete test' do
|
|
65
|
+
it 'should work' do
|
|
66
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# unit tests for v1_domains_domain_return_path_get
|
|
71
|
+
# Get the custom Return-Path
|
|
72
|
+
# A custom Return-Path moves the envelope sender of mail sent through the API from this domain onto `bounces.<domain>`. Bounce reports then come back to Lockally instead of the sending mailbox, and a bounce that arrives after delivery marks the message bounced, suppresses the address and fires `delivery.bounced`. Mail sent from webmail or mail apps is not affected. DKIM stays signed by the domain itself. `status` is `off`, `pending` (records not confirmed yet) or `active`.
|
|
73
|
+
# @param domain
|
|
74
|
+
# @param [Hash] opts the optional parameters
|
|
75
|
+
# @return [ReturnPath]
|
|
76
|
+
describe 'v1_domains_domain_return_path_get test' do
|
|
77
|
+
it 'should work' do
|
|
78
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# unit tests for v1_domains_domain_return_path_post
|
|
83
|
+
# Turn on the custom Return-Path
|
|
84
|
+
# Moves it to `pending` and returns the two records to publish on `bounces.<domain>`. Nothing changes for mail until they are confirmed with the verify call. The domain must be verified. Available on every plan except Free.
|
|
85
|
+
# @param domain
|
|
86
|
+
# @param [Hash] opts the optional parameters
|
|
87
|
+
# @return [ReturnPath]
|
|
88
|
+
describe 'v1_domains_domain_return_path_post test' do
|
|
89
|
+
it 'should work' do
|
|
90
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# unit tests for v1_domains_domain_return_path_verify_post
|
|
95
|
+
# Check the custom Return-Path records
|
|
96
|
+
# Looks up the MX and SPF records on `bounces.<domain>`. Returns 200 either way: while a record is missing the status stays `pending` and `check` says which one. Once both are found the Return-Path becomes `active` and the send path starts using it.
|
|
97
|
+
# @param domain
|
|
98
|
+
# @param [Hash] opts the optional parameters
|
|
99
|
+
# @return [ReturnPath]
|
|
100
|
+
describe 'v1_domains_domain_return_path_verify_post test' do
|
|
101
|
+
it 'should work' do
|
|
102
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
|
|
58
106
|
# unit tests for v1_domains_domain_verify_post
|
|
59
107
|
# Force-poll DNS verification
|
|
60
108
|
# Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook.
|
data/spec/api/drafts_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/health_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -94,7 +94,7 @@ describe 'MailboxesApi' do
|
|
|
94
94
|
|
|
95
95
|
# unit tests for v1_mailboxes_email_export_post
|
|
96
96
|
# Request a mailbox export
|
|
97
|
-
# 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.
|
|
97
|
+
# 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.
|
|
98
98
|
# @param email
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
100
100
|
# @return [V1MailboxesEmailExportPost201Response]
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/send_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -65,7 +65,7 @@ describe 'SendApi' do
|
|
|
65
65
|
# Get message status
|
|
66
66
|
# @param id
|
|
67
67
|
# @param [Hash] opts the optional parameters
|
|
68
|
-
# @return [
|
|
68
|
+
# @return [MessageDetail]
|
|
69
69
|
describe 'v1_messages_id_get test' do
|
|
70
70
|
it 'should work' do
|
|
71
71
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -101,11 +101,11 @@ describe 'SendApi' do
|
|
|
101
101
|
|
|
102
102
|
# unit tests for v1_send_post
|
|
103
103
|
# Send an email
|
|
104
|
-
# 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 a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported. **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.
|
|
104
|
+
# 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 a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported. **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.
|
|
105
105
|
# @param idempotency_key
|
|
106
106
|
# @param v1_send_post_request
|
|
107
107
|
# @param [Hash] opts the optional parameters
|
|
108
|
-
# @return [
|
|
108
|
+
# @return [V1SendPost200Response]
|
|
109
109
|
describe 'v1_send_post test' do
|
|
110
110
|
it 'should work' do
|
|
111
111
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
data/spec/api/signup_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/tenant_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/test_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
data/spec/api/users_api_spec.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#lockally control plane
|
|
3
3
|
|
|
4
|
-
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret
|
|
4
|
+
#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints). **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`. The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back. **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents. **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.1.0
|
|
7
7
|
Contact: support@lockally.com
|