lockally 0.1.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 +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +481 -0
- data/Rakefile +10 -0
- data/docs/APIKey.md +32 -0
- data/docs/ActivateAddOn200Response.md +24 -0
- data/docs/AddCalendarMemberRequest.md +20 -0
- data/docs/AddContactListMemberRequest.md +18 -0
- data/docs/AddOn.md +28 -0
- data/docs/AddOnsApi.md +275 -0
- data/docs/AddSharedMemberRequest.md +20 -0
- data/docs/Admin.md +30 -0
- data/docs/AdminApi.md +205 -0
- data/docs/AdminFull.md +36 -0
- data/docs/AdminsApi.md +283 -0
- data/docs/AgentsApi.md +927 -0
- data/docs/AiApi.md +282 -0
- data/docs/AliasesApi.md +211 -0
- data/docs/ApiKeysApi.md +213 -0
- data/docs/AuditEvent.md +26 -0
- data/docs/BatchLookupPublicKeys200Response.md +18 -0
- data/docs/BatchLookupPublicKeys200ResponseDataInner.md +22 -0
- data/docs/BatchResult.md +26 -0
- data/docs/BillingApi.md +208 -0
- data/docs/BillingStatus.md +46 -0
- data/docs/Calendar.md +38 -0
- data/docs/CalendarEvent.md +40 -0
- data/docs/CalendarIntegration.md +34 -0
- data/docs/CalendarMember.md +28 -0
- data/docs/CalendarPolicies.md +40 -0
- data/docs/CalendarsApi.md +1445 -0
- data/docs/Contact.md +44 -0
- data/docs/ContactList.md +32 -0
- data/docs/ContactListsApi.md +483 -0
- data/docs/ContactsApi.md +426 -0
- data/docs/CreateBillingCheckout200Response.md +20 -0
- data/docs/CreateBillingCheckoutRequest.md +18 -0
- data/docs/CreateCalendarEventRequest.md +28 -0
- data/docs/CreateCalendarIntegrationRequest.md +20 -0
- data/docs/CreateCalendarRequest.md +26 -0
- data/docs/CreateContactListRequest.md +22 -0
- data/docs/CreateContactRequest.md +32 -0
- data/docs/CreateDedicatedIPRequestRequest.md +18 -0
- data/docs/CreateDistributionListRequest.md +22 -0
- data/docs/CreateEncryptionKey201Response.md +22 -0
- data/docs/CreateEncryptionKeyRequest.md +24 -0
- data/docs/CreateEncryptionRecoveryRequest.md +20 -0
- data/docs/CreateMigrationCredentialRequest.md +22 -0
- data/docs/CreateMigrationCredentialRequestCredentials.md +26 -0
- data/docs/CreateMigrationRequest.md +24 -0
- data/docs/CreateResourceRequest.md +22 -0
- data/docs/CreateUnitsCheckout200Response.md +22 -0
- data/docs/CreateUnitsCheckoutRequest.md +18 -0
- data/docs/CreateUserRequest.md +26 -0
- data/docs/DNSRecord.md +28 -0
- data/docs/DashboardApi.md +462 -0
- data/docs/DedicatedIPRequest.md +30 -0
- data/docs/DirectoryApi.md +533 -0
- data/docs/DirectoryPermissions.md +30 -0
- data/docs/DiscoverMigration202Response.md +18 -0
- data/docs/DistributionListDetail.md +30 -0
- data/docs/DistributionListSummary.md +28 -0
- data/docs/DistributionListsApi.md +345 -0
- data/docs/Domain.md +36 -0
- data/docs/DomainsApi.md +351 -0
- data/docs/DraftsApi.md +503 -0
- data/docs/EncryptionApi.md +345 -0
- data/docs/GALSettings.md +36 -0
- data/docs/GetAddOnStatus200Response.md +22 -0
- data/docs/GetAuditSummary200Response.md +26 -0
- data/docs/GetCalendarSecurity200Response.md +32 -0
- data/docs/GetCalendarSecurity200ResponseAlertsInner.md +20 -0
- data/docs/GetCalendarSecurity200ResponseDelegatedAccessInner.md +26 -0
- data/docs/GetCalendarSecurity200ResponseExternalSharing.md +22 -0
- data/docs/GetCalendarSecurity200ResponsePublicCalendarListInner.md +26 -0
- data/docs/GetContactList200Response.md +20 -0
- data/docs/GetContactList200ResponseMembersInner.md +22 -0
- data/docs/GetContactLists200Response.md +18 -0
- data/docs/GetContactLists200ResponseDataInner.md +22 -0
- data/docs/GetDirectoryActivity200Response.md +18 -0
- data/docs/GetDirectoryActivity200ResponseDataInner.md +24 -0
- data/docs/GetDirectoryStats200Response.md +28 -0
- data/docs/GetDomainsStatus200Response.md +20 -0
- data/docs/GetDomainsStatus200ResponseDomainsInner.md +22 -0
- data/docs/GetDomainsStatus200ResponseDomainsInnerChecksInner.md +22 -0
- data/docs/GetEncryptionKey200Response.md +28 -0
- data/docs/GetIPAssignment200Response.md +26 -0
- data/docs/GetIntegrationsSummary200Response.md +30 -0
- data/docs/GetIntegrationsSummary200ResponseApiKeysInner.md +22 -0
- data/docs/GetIntegrationsSummary200ResponseWebhooksInner.md +24 -0
- data/docs/GetSecurity200Response.md +22 -0
- data/docs/GetSecurity200ResponseAlertsInner.md +22 -0
- data/docs/GetSecurity200ResponseStatsInner.md +22 -0
- data/docs/GetStorage200Response.md +28 -0
- data/docs/GetStorage200ResponseTopMailboxesInner.md +20 -0
- data/docs/GetStorage200ResponseTopMessagesInner.md +26 -0
- data/docs/GetUserInsights200Response.md +28 -0
- data/docs/HealthApi.md +69 -0
- data/docs/HealthzGet200Response.md +20 -0
- data/docs/IpPoolsApi.md +205 -0
- data/docs/ListAddOns200Response.md +18 -0
- data/docs/ListCalendarEvents200Response.md +18 -0
- data/docs/ListCalendarIntegrations200Response.md +18 -0
- data/docs/ListCalendarMembers200Response.md +18 -0
- data/docs/ListCalendars200Response.md +18 -0
- data/docs/ListContactLists200Response.md +18 -0
- data/docs/ListContacts200Response.md +18 -0
- data/docs/ListDedicatedIPRequests200Response.md +18 -0
- data/docs/ListDistributionLists200Response.md +18 -0
- data/docs/ListMigrationCredentials200Response.md +18 -0
- data/docs/ListMigrationEvents200Response.md +18 -0
- data/docs/ListMigrationMailboxes200Response.md +18 -0
- data/docs/ListMigrations200Response.md +18 -0
- data/docs/ListResources200Response.md +18 -0
- data/docs/ListSharedMembers200Response.md +18 -0
- data/docs/ListUsers200Response.md +20 -0
- data/docs/Mailbox.md +38 -0
- data/docs/MailboxesApi.md +980 -0
- data/docs/MapMigrationRequest.md +18 -0
- data/docs/MapMigrationRequestMappingsInner.md +20 -0
- data/docs/Message.md +38 -0
- data/docs/MessageStats.md +26 -0
- data/docs/MessageStatsCounts.md +24 -0
- data/docs/MessageStatsRates.md +24 -0
- data/docs/MessageStatsWindow.md +20 -0
- data/docs/Migration.md +44 -0
- data/docs/MigrationCredential.md +30 -0
- data/docs/MigrationEvent.md +36 -0
- data/docs/MigrationMailbox.md +54 -0
- data/docs/MigrationProgress.md +36 -0
- data/docs/MigrationProgressMailboxesInner.md +30 -0
- data/docs/MigrationSettings.md +26 -0
- data/docs/MigrationsApi.md +1434 -0
- data/docs/ModelAlias.md +26 -0
- data/docs/PlanCatalogEntry.md +36 -0
- data/docs/Problem.md +26 -0
- data/docs/ReplaceDistributionListMembers200Response.md +26 -0
- data/docs/ReplaceDistributionListMembersRequest.md +18 -0
- data/docs/Resource.md +32 -0
- data/docs/ResourcesApi.md +345 -0
- data/docs/RotateEncryptionKeyRequest.md +22 -0
- data/docs/SendApi.md +446 -0
- data/docs/SendMessage.md +42 -0
- data/docs/SharedMember.md +28 -0
- data/docs/SignupApi.md +70 -0
- data/docs/SignupRequest.md +26 -0
- data/docs/StartMigration202Response.md +20 -0
- data/docs/Suppression.md +24 -0
- data/docs/SuppressionsApi.md +284 -0
- data/docs/Template.md +30 -0
- data/docs/TemplateInput.md +24 -0
- data/docs/TemplatesApi.md +345 -0
- data/docs/Tenant.md +40 -0
- data/docs/TenantApi.md +141 -0
- data/docs/TestApi.md +74 -0
- data/docs/UnitBundle.md +26 -0
- data/docs/UpdateCalendarEventRequest.md +28 -0
- data/docs/UpdateCalendarIntegrationRequest.md +22 -0
- data/docs/UpdateCalendarMemberRequest.md +18 -0
- data/docs/UpdateCalendarPoliciesRequest.md +34 -0
- data/docs/UpdateCalendarRequest.md +26 -0
- data/docs/UpdateContactListRequest.md +22 -0
- data/docs/UpdateContactRequest.md +34 -0
- data/docs/UpdateDirectoryPermissionsRequest.md +24 -0
- data/docs/UpdateGALSettingsRequest.md +26 -0
- data/docs/UpdateMigrationMailboxRequest.md +20 -0
- data/docs/UpdateMigrationRequest.md +20 -0
- data/docs/UpdateResourceRequest.md +24 -0
- data/docs/UpdateUserRequest.md +26 -0
- data/docs/User.md +38 -0
- data/docs/UserEvent.md +22 -0
- data/docs/UsersApi.md +352 -0
- data/docs/V1AdminLoginPost200Response.md +24 -0
- data/docs/V1AdminLoginPostRequest.md +20 -0
- data/docs/V1AdminMeGet200Response.md +20 -0
- data/docs/V1AdminsGet200Response.md +18 -0
- data/docs/V1AdminsIdPatchRequest.md +24 -0
- data/docs/V1AdminsPostRequest.md +24 -0
- data/docs/V1AliasesGet200Response.md +18 -0
- data/docs/V1AliasesPostRequest.md +20 -0
- data/docs/V1ApiKeysGet200Response.md +18 -0
- data/docs/V1ApiKeysPost201Response.md +34 -0
- data/docs/V1ApiKeysPostRequest.md +20 -0
- data/docs/V1DomainsGet200Response.md +18 -0
- data/docs/V1DomainsPostRequest.md +18 -0
- data/docs/V1InboxesMailboxMessagesPostRequest.md +26 -0
- data/docs/V1MailboxesEmailExportPost201Response.md +22 -0
- data/docs/V1MailboxesEmailPatchRequest.md +22 -0
- data/docs/V1MailboxesEmailVacationPutRequest.md +20 -0
- data/docs/V1MailboxesGet200Response.md +20 -0
- data/docs/V1MailboxesPostRequest.md +22 -0
- data/docs/V1MessagesGet200Response.md +20 -0
- data/docs/V1SendBatchPost200Response.md +18 -0
- data/docs/V1SendBatchPostRequest.md +18 -0
- data/docs/V1SendPost202Response.md +24 -0
- data/docs/V1SendPostRequest.md +42 -0
- data/docs/V1SendPostRequestAttachmentsInner.md +22 -0
- data/docs/V1SuppressionsGet200Response.md +20 -0
- data/docs/V1SuppressionsPostRequest.md +20 -0
- data/docs/V1TemplatesGet200Response.md +18 -0
- data/docs/V1UsageGet200Response.md +42 -0
- data/docs/V1VacationGet200Response.md +18 -0
- data/docs/V1WebhooksGet200Response.md +18 -0
- data/docs/V1WebhooksIdPatchRequest.md +22 -0
- data/docs/V1WebhooksPostRequest.md +20 -0
- data/docs/VacationParams.md +24 -0
- data/docs/VacationResponder.md +30 -0
- data/docs/Webhook.md +38 -0
- data/docs/WebhooksApi.md +285 -0
- data/git_push.sh +57 -0
- data/lib/lockally/api/add_ons_api.rb +260 -0
- data/lib/lockally/api/admin_api.rb +204 -0
- data/lib/lockally/api/admins_api.rb +282 -0
- data/lib/lockally/api/agents_api.rb +900 -0
- data/lib/lockally/api/ai_api.rb +259 -0
- data/lib/lockally/api/aliases_api.rb +208 -0
- data/lib/lockally/api/api_keys_api.rb +210 -0
- data/lib/lockally/api/billing_api.rb +209 -0
- data/lib/lockally/api/calendars_api.rb +1390 -0
- data/lib/lockally/api/contact_lists_api.rb +476 -0
- data/lib/lockally/api/contacts_api.rb +413 -0
- data/lib/lockally/api/dashboard_api.rb +407 -0
- data/lib/lockally/api/directory_api.rb +484 -0
- data/lib/lockally/api/distribution_lists_api.rb +337 -0
- data/lib/lockally/api/domains_api.rb +334 -0
- data/lib/lockally/api/drafts_api.rb +487 -0
- data/lib/lockally/api/encryption_api.rb +343 -0
- data/lib/lockally/api/health_api.rb +79 -0
- data/lib/lockally/api/ip_pools_api.rb +198 -0
- data/lib/lockally/api/mailboxes_api.rb +946 -0
- data/lib/lockally/api/migrations_api.rb +1340 -0
- data/lib/lockally/api/resources_api.rb +337 -0
- data/lib/lockally/api/send_api.rb +453 -0
- data/lib/lockally/api/signup_api.rb +88 -0
- data/lib/lockally/api/suppressions_api.rb +282 -0
- data/lib/lockally/api/templates_api.rb +337 -0
- data/lib/lockally/api/tenant_api.rb +136 -0
- data/lib/lockally/api/test_api.rb +79 -0
- data/lib/lockally/api/users_api.rb +350 -0
- data/lib/lockally/api/webhooks_api.rb +284 -0
- data/lib/lockally/api_client.rb +441 -0
- data/lib/lockally/api_error.rb +58 -0
- data/lib/lockally/api_model_base.rb +88 -0
- data/lib/lockally/configuration.rb +404 -0
- data/lib/lockally/models/activate_add_on200_response.rb +242 -0
- data/lib/lockally/models/add_calendar_member_request.rb +209 -0
- data/lib/lockally/models/add_contact_list_member_request.rb +164 -0
- data/lib/lockally/models/add_on.rb +294 -0
- data/lib/lockally/models/add_shared_member_request.rb +209 -0
- data/lib/lockally/models/admin.rb +310 -0
- data/lib/lockally/models/admin_full.rb +362 -0
- data/lib/lockally/models/api_key.rb +315 -0
- data/lib/lockally/models/audit_event.rb +183 -0
- data/lib/lockally/models/batch_lookup_public_keys200_response.rb +149 -0
- data/lib/lockally/models/batch_lookup_public_keys200_response_data_inner.rb +165 -0
- data/lib/lockally/models/batch_result.rb +218 -0
- data/lib/lockally/models/billing_status.rb +507 -0
- data/lib/lockally/models/calendar.rb +363 -0
- data/lib/lockally/models/calendar_event.rb +416 -0
- data/lib/lockally/models/calendar_integration.rb +347 -0
- data/lib/lockally/models/calendar_member.rb +318 -0
- data/lib/lockally/models/calendar_policies.rb +297 -0
- data/lib/lockally/models/contact.rb +424 -0
- data/lib/lockally/models/contact_list.rb +353 -0
- data/lib/lockally/models/create_billing_checkout200_response.rb +190 -0
- data/lib/lockally/models/create_billing_checkout_request.rb +188 -0
- data/lib/lockally/models/create_calendar_event_request.rb +245 -0
- data/lib/lockally/models/create_calendar_integration_request.rb +197 -0
- data/lib/lockally/models/create_calendar_request.rb +236 -0
- data/lib/lockally/models/create_contact_list_request.rb +218 -0
- data/lib/lockally/models/create_contact_request.rb +280 -0
- data/lib/lockally/models/create_dedicated_ip_request_request.rb +164 -0
- data/lib/lockally/models/create_distribution_list_request.rb +184 -0
- data/lib/lockally/models/create_encryption_key201_response.rb +165 -0
- data/lib/lockally/models/create_encryption_key_request.rb +225 -0
- data/lib/lockally/models/create_encryption_recovery_request.rb +190 -0
- data/lib/lockally/models/create_migration_credential_request.rb +223 -0
- data/lib/lockally/models/create_migration_credential_request_credentials.rb +217 -0
- data/lib/lockally/models/create_migration_request.rb +225 -0
- data/lib/lockally/models/create_resource_request.rb +237 -0
- data/lib/lockally/models/create_units_checkout200_response.rb +216 -0
- data/lib/lockally/models/create_units_checkout_request.rb +188 -0
- data/lib/lockally/models/create_user_request.rb +234 -0
- data/lib/lockally/models/dedicated_ip_request.rb +293 -0
- data/lib/lockally/models/directory_permissions.rb +316 -0
- data/lib/lockally/models/discover_migration202_response.rb +164 -0
- data/lib/lockally/models/distribution_list_detail.rb +305 -0
- data/lib/lockally/models/distribution_list_summary.rb +277 -0
- data/lib/lockally/models/dns_record.rb +304 -0
- data/lib/lockally/models/domain.rb +367 -0
- data/lib/lockally/models/gal_settings.rb +354 -0
- data/lib/lockally/models/get_add_on_status200_response.rb +216 -0
- data/lib/lockally/models/get_audit_summary200_response.rb +189 -0
- data/lib/lockally/models/get_calendar_security200_response.rb +216 -0
- data/lib/lockally/models/get_calendar_security200_response_alerts_inner.rb +190 -0
- data/lib/lockally/models/get_calendar_security200_response_delegated_access_inner.rb +183 -0
- data/lib/lockally/models/get_calendar_security200_response_external_sharing.rb +165 -0
- data/lib/lockally/models/get_calendar_security200_response_public_calendar_list_inner.rb +183 -0
- data/lib/lockally/models/get_contact_list200_response.rb +158 -0
- data/lib/lockally/models/get_contact_list200_response_members_inner.rb +165 -0
- data/lib/lockally/models/get_contact_lists200_response.rb +149 -0
- data/lib/lockally/models/get_contact_lists200_response_data_inner.rb +165 -0
- data/lib/lockally/models/get_directory_activity200_response.rb +149 -0
- data/lib/lockally/models/get_directory_activity200_response_data_inner.rb +174 -0
- data/lib/lockally/models/get_directory_stats200_response.rb +192 -0
- data/lib/lockally/models/get_domains_status200_response.rb +158 -0
- data/lib/lockally/models/get_domains_status200_response_domains_inner.rb +167 -0
- data/lib/lockally/models/get_domains_status200_response_domains_inner_checks_inner.rb +199 -0
- data/lib/lockally/models/get_encryption_key200_response.rb +192 -0
- data/lib/lockally/models/get_integrations_summary200_response.rb +205 -0
- data/lib/lockally/models/get_integrations_summary200_response_api_keys_inner.rb +165 -0
- data/lib/lockally/models/get_integrations_summary200_response_webhooks_inner.rb +174 -0
- data/lib/lockally/models/get_ip_assignment200_response.rb +183 -0
- data/lib/lockally/models/get_security200_response.rb +203 -0
- data/lib/lockally/models/get_security200_response_alerts_inner.rb +199 -0
- data/lib/lockally/models/get_security200_response_stats_inner.rb +165 -0
- data/lib/lockally/models/get_storage200_response.rb +196 -0
- data/lib/lockally/models/get_storage200_response_top_mailboxes_inner.rb +156 -0
- data/lib/lockally/models/get_storage200_response_top_messages_inner.rb +185 -0
- data/lib/lockally/models/get_user_insights200_response.rb +198 -0
- data/lib/lockally/models/healthz_get200_response.rb +214 -0
- data/lib/lockally/models/list_add_ons200_response.rb +166 -0
- data/lib/lockally/models/list_calendar_events200_response.rb +149 -0
- data/lib/lockally/models/list_calendar_integrations200_response.rb +149 -0
- data/lib/lockally/models/list_calendar_members200_response.rb +149 -0
- data/lib/lockally/models/list_calendars200_response.rb +149 -0
- data/lib/lockally/models/list_contact_lists200_response.rb +149 -0
- data/lib/lockally/models/list_contacts200_response.rb +149 -0
- data/lib/lockally/models/list_dedicated_ip_requests200_response.rb +166 -0
- data/lib/lockally/models/list_distribution_lists200_response.rb +166 -0
- data/lib/lockally/models/list_migration_credentials200_response.rb +166 -0
- data/lib/lockally/models/list_migration_events200_response.rb +166 -0
- data/lib/lockally/models/list_migration_mailboxes200_response.rb +166 -0
- data/lib/lockally/models/list_migrations200_response.rb +166 -0
- data/lib/lockally/models/list_resources200_response.rb +149 -0
- data/lib/lockally/models/list_shared_members200_response.rb +166 -0
- data/lib/lockally/models/list_users200_response.rb +192 -0
- data/lib/lockally/models/mailbox.rb +357 -0
- data/lib/lockally/models/map_migration_request.rb +166 -0
- data/lib/lockally/models/map_migration_request_mappings_inner.rb +190 -0
- data/lib/lockally/models/message.rb +400 -0
- data/lib/lockally/models/message_stats.rb +183 -0
- data/lib/lockally/models/message_stats_counts.rb +174 -0
- data/lib/lockally/models/message_stats_rates.rb +174 -0
- data/lib/lockally/models/message_stats_window.rb +156 -0
- data/lib/lockally/models/migration.rb +441 -0
- data/lib/lockally/models/migration_credential.rb +310 -0
- data/lib/lockally/models/migration_event.rb +330 -0
- data/lib/lockally/models/migration_mailbox.rb +462 -0
- data/lib/lockally/models/migration_progress.rb +400 -0
- data/lib/lockally/models/migration_progress_mailboxes_inner.rb +286 -0
- data/lib/lockally/models/migration_settings.rb +185 -0
- data/lib/lockally/models/model_alias.rb +268 -0
- data/lib/lockally/models/plan_catalog_entry.rb +398 -0
- data/lib/lockally/models/problem.rb +235 -0
- data/lib/lockally/models/replace_distribution_list_members200_response.rb +270 -0
- data/lib/lockally/models/replace_distribution_list_members_request.rb +166 -0
- data/lib/lockally/models/resource.rb +353 -0
- data/lib/lockally/models/rotate_encryption_key_request.rb +199 -0
- data/lib/lockally/models/send_message.rb +310 -0
- data/lib/lockally/models/shared_member.rb +318 -0
- data/lib/lockally/models/signup_request.rb +279 -0
- data/lib/lockally/models/start_migration202_response.rb +190 -0
- data/lib/lockally/models/suppression.rb +208 -0
- data/lib/lockally/models/template.rb +201 -0
- data/lib/lockally/models/template_input.rb +195 -0
- data/lib/lockally/models/tenant.rb +424 -0
- data/lib/lockally/models/unit_bundle.rb +268 -0
- data/lib/lockally/models/update_calendar_event_request.rb +192 -0
- data/lib/lockally/models/update_calendar_integration_request.rb +199 -0
- data/lib/lockally/models/update_calendar_member_request.rb +188 -0
- data/lib/lockally/models/update_calendar_policies_request.rb +337 -0
- data/lib/lockally/models/update_calendar_request.rb +217 -0
- data/lib/lockally/models/update_contact_list_request.rb +199 -0
- data/lib/lockally/models/update_contact_request.rb +265 -0
- data/lib/lockally/models/update_directory_permissions_request.rb +244 -0
- data/lib/lockally/models/update_gal_settings_request.rb +217 -0
- data/lib/lockally/models/update_migration_mailbox_request.rb +157 -0
- data/lib/lockally/models/update_migration_request.rb +156 -0
- data/lib/lockally/models/update_resource_request.rb +220 -0
- data/lib/lockally/models/update_user_request.rb +217 -0
- data/lib/lockally/models/user.rb +397 -0
- data/lib/lockally/models/user_event.rb +165 -0
- data/lib/lockally/models/v1_admin_login_post200_response.rb +242 -0
- data/lib/lockally/models/v1_admin_login_post_request.rb +199 -0
- data/lib/lockally/models/v1_admin_me_get200_response.rb +190 -0
- data/lib/lockally/models/v1_admins_get200_response.rb +166 -0
- data/lib/lockally/models/v1_admins_id_patch_request.rb +227 -0
- data/lib/lockally/models/v1_admins_post_request.rb +246 -0
- data/lib/lockally/models/v1_aliases_get200_response.rb +166 -0
- data/lib/lockally/models/v1_aliases_post_request.rb +190 -0
- data/lib/lockally/models/v1_api_keys_get200_response.rb +166 -0
- data/lib/lockally/models/v1_api_keys_post201_response.rb +349 -0
- data/lib/lockally/models/v1_api_keys_post_request.rb +211 -0
- data/lib/lockally/models/v1_domains_get200_response.rb +166 -0
- data/lib/lockally/models/v1_domains_post_request.rb +164 -0
- data/lib/lockally/models/v1_inboxes_mailbox_messages_post_request.rb +221 -0
- data/lib/lockally/models/v1_mailboxes_email_export_post201_response.rb +241 -0
- data/lib/lockally/models/v1_mailboxes_email_patch_request.rb +203 -0
- data/lib/lockally/models/v1_mailboxes_email_vacation_put_request.rb +175 -0
- data/lib/lockally/models/v1_mailboxes_get200_response.rb +192 -0
- data/lib/lockally/models/v1_mailboxes_post_request.rb +205 -0
- data/lib/lockally/models/v1_messages_get200_response.rb +176 -0
- data/lib/lockally/models/v1_send_batch_post200_response.rb +149 -0
- data/lib/lockally/models/v1_send_batch_post_request.rb +184 -0
- data/lib/lockally/models/v1_send_post202_response.rb +252 -0
- data/lib/lockally/models/v1_send_post_request.rb +316 -0
- data/lib/lockally/models/v1_send_post_request_attachments_inner.rb +217 -0
- data/lib/lockally/models/v1_suppressions_get200_response.rb +158 -0
- data/lib/lockally/models/v1_suppressions_post_request.rb +209 -0
- data/lib/lockally/models/v1_templates_get200_response.rb +149 -0
- data/lib/lockally/models/v1_usage_get200_response.rb +300 -0
- data/lib/lockally/models/v1_vacation_get200_response.rb +166 -0
- data/lib/lockally/models/v1_webhooks_get200_response.rb +166 -0
- data/lib/lockally/models/v1_webhooks_id_patch_request.rb +167 -0
- data/lib/lockally/models/v1_webhooks_post_request.rb +202 -0
- data/lib/lockally/models/vacation_params.rb +208 -0
- data/lib/lockally/models/vacation_responder.rb +305 -0
- data/lib/lockally/models/webhook.rb +359 -0
- data/lib/lockally/version.rb +15 -0
- data/lib/lockally.rb +245 -0
- data/lockally.gemspec +41 -0
- data/spec/api/add_ons_api_spec.rb +78 -0
- data/spec/api/admin_api_spec.rb +69 -0
- data/spec/api/admins_api_spec.rb +82 -0
- data/spec/api/agents_api_spec.rb +197 -0
- data/spec/api/ai_api_spec.rb +81 -0
- data/spec/api/aliases_api_spec.rb +69 -0
- data/spec/api/api_keys_api_spec.rb +70 -0
- data/spec/api/billing_api_spec.rb +67 -0
- data/spec/api/calendars_api_spec.rb +274 -0
- data/spec/api/contact_lists_api_spec.rb +114 -0
- data/spec/api/contacts_api_spec.rb +106 -0
- data/spec/api/dashboard_api_spec.rb +105 -0
- data/spec/api/directory_api_spec.rb +117 -0
- data/spec/api/distribution_lists_api_spec.rb +90 -0
- data/spec/api/domains_api_spec.rb +93 -0
- data/spec/api/drafts_api_spec.rb +121 -0
- data/spec/api/encryption_api_spec.rb +90 -0
- data/spec/api/health_api_spec.rb +46 -0
- data/spec/api/ip_pools_api_spec.rb +66 -0
- data/spec/api/mailboxes_api_spec.rb +203 -0
- data/spec/api/migrations_api_spec.rb +268 -0
- data/spec/api/resources_api_spec.rb +90 -0
- data/spec/api/send_api_spec.rb +115 -0
- data/spec/api/signup_api_spec.rb +46 -0
- data/spec/api/suppressions_api_spec.rb +81 -0
- data/spec/api/templates_api_spec.rb +90 -0
- data/spec/api/tenant_api_spec.rb +57 -0
- data/spec/api/test_api_spec.rb +46 -0
- data/spec/api/users_api_spec.rb +92 -0
- data/spec/api/webhooks_api_spec.rb +83 -0
- data/spec/models/activate_add_on200_response_spec.rb +54 -0
- data/spec/models/add_calendar_member_request_spec.rb +46 -0
- data/spec/models/add_contact_list_member_request_spec.rb +36 -0
- data/spec/models/add_on_spec.rb +66 -0
- data/spec/models/add_shared_member_request_spec.rb +46 -0
- data/spec/models/admin_full_spec.rb +94 -0
- data/spec/models/admin_spec.rb +76 -0
- data/spec/models/api_key_spec.rb +78 -0
- data/spec/models/audit_event_spec.rb +60 -0
- data/spec/models/batch_lookup_public_keys200_response_data_inner_spec.rb +48 -0
- data/spec/models/batch_lookup_public_keys200_response_spec.rb +36 -0
- data/spec/models/batch_result_spec.rb +64 -0
- data/spec/models/billing_status_spec.rb +128 -0
- data/spec/models/calendar_event_spec.rb +102 -0
- data/spec/models/calendar_integration_spec.rb +92 -0
- data/spec/models/calendar_member_spec.rb +70 -0
- data/spec/models/calendar_policies_spec.rb +106 -0
- data/spec/models/calendar_spec.rb +100 -0
- data/spec/models/contact_list_spec.rb +82 -0
- data/spec/models/contact_spec.rb +118 -0
- data/spec/models/create_billing_checkout200_response_spec.rb +42 -0
- data/spec/models/create_billing_checkout_request_spec.rb +40 -0
- data/spec/models/create_calendar_event_request_spec.rb +66 -0
- data/spec/models/create_calendar_integration_request_spec.rb +46 -0
- data/spec/models/create_calendar_request_spec.rb +64 -0
- data/spec/models/create_contact_list_request_spec.rb +52 -0
- data/spec/models/create_contact_request_spec.rb +82 -0
- data/spec/models/create_dedicated_ip_request_request_spec.rb +36 -0
- data/spec/models/create_distribution_list_request_spec.rb +48 -0
- data/spec/models/create_encryption_key201_response_spec.rb +48 -0
- data/spec/models/create_encryption_key_request_spec.rb +54 -0
- data/spec/models/create_encryption_recovery_request_spec.rb +42 -0
- data/spec/models/create_migration_credential_request_credentials_spec.rb +60 -0
- data/spec/models/create_migration_credential_request_spec.rb +52 -0
- data/spec/models/create_migration_request_spec.rb +54 -0
- data/spec/models/create_resource_request_spec.rb +52 -0
- data/spec/models/create_units_checkout200_response_spec.rb +48 -0
- data/spec/models/create_units_checkout_request_spec.rb +40 -0
- data/spec/models/create_user_request_spec.rb +60 -0
- data/spec/models/dedicated_ip_request_spec.rb +76 -0
- data/spec/models/directory_permissions_spec.rb +88 -0
- data/spec/models/discover_migration202_response_spec.rb +36 -0
- data/spec/models/distribution_list_detail_spec.rb +72 -0
- data/spec/models/distribution_list_summary_spec.rb +66 -0
- data/spec/models/dns_record_spec.rb +74 -0
- data/spec/models/domain_spec.rb +90 -0
- data/spec/models/gal_settings_spec.rb +94 -0
- data/spec/models/get_add_on_status200_response_spec.rb +48 -0
- data/spec/models/get_audit_summary200_response_spec.rb +60 -0
- data/spec/models/get_calendar_security200_response_alerts_inner_spec.rb +46 -0
- data/spec/models/get_calendar_security200_response_delegated_access_inner_spec.rb +60 -0
- data/spec/models/get_calendar_security200_response_external_sharing_spec.rb +48 -0
- data/spec/models/get_calendar_security200_response_public_calendar_list_inner_spec.rb +60 -0
- data/spec/models/get_calendar_security200_response_spec.rb +78 -0
- data/spec/models/get_contact_list200_response_members_inner_spec.rb +48 -0
- data/spec/models/get_contact_list200_response_spec.rb +42 -0
- data/spec/models/get_contact_lists200_response_data_inner_spec.rb +48 -0
- data/spec/models/get_contact_lists200_response_spec.rb +36 -0
- data/spec/models/get_directory_activity200_response_data_inner_spec.rb +54 -0
- data/spec/models/get_directory_activity200_response_spec.rb +36 -0
- data/spec/models/get_directory_stats200_response_spec.rb +66 -0
- data/spec/models/get_domains_status200_response_domains_inner_checks_inner_spec.rb +52 -0
- data/spec/models/get_domains_status200_response_domains_inner_spec.rb +48 -0
- data/spec/models/get_domains_status200_response_spec.rb +42 -0
- data/spec/models/get_encryption_key200_response_spec.rb +66 -0
- data/spec/models/get_integrations_summary200_response_api_keys_inner_spec.rb +48 -0
- data/spec/models/get_integrations_summary200_response_spec.rb +72 -0
- data/spec/models/get_integrations_summary200_response_webhooks_inner_spec.rb +54 -0
- data/spec/models/get_ip_assignment200_response_spec.rb +60 -0
- data/spec/models/get_security200_response_alerts_inner_spec.rb +52 -0
- data/spec/models/get_security200_response_spec.rb +52 -0
- data/spec/models/get_security200_response_stats_inner_spec.rb +48 -0
- data/spec/models/get_storage200_response_spec.rb +66 -0
- data/spec/models/get_storage200_response_top_mailboxes_inner_spec.rb +42 -0
- data/spec/models/get_storage200_response_top_messages_inner_spec.rb +60 -0
- data/spec/models/get_user_insights200_response_spec.rb +66 -0
- data/spec/models/healthz_get200_response_spec.rb +46 -0
- data/spec/models/list_add_ons200_response_spec.rb +36 -0
- data/spec/models/list_calendar_events200_response_spec.rb +36 -0
- data/spec/models/list_calendar_integrations200_response_spec.rb +36 -0
- data/spec/models/list_calendar_members200_response_spec.rb +36 -0
- data/spec/models/list_calendars200_response_spec.rb +36 -0
- data/spec/models/list_contact_lists200_response_spec.rb +36 -0
- data/spec/models/list_contacts200_response_spec.rb +36 -0
- data/spec/models/list_dedicated_ip_requests200_response_spec.rb +36 -0
- data/spec/models/list_distribution_lists200_response_spec.rb +36 -0
- data/spec/models/list_migration_credentials200_response_spec.rb +36 -0
- data/spec/models/list_migration_events200_response_spec.rb +36 -0
- data/spec/models/list_migration_mailboxes200_response_spec.rb +36 -0
- data/spec/models/list_migrations200_response_spec.rb +36 -0
- data/spec/models/list_resources200_response_spec.rb +36 -0
- data/spec/models/list_shared_members200_response_spec.rb +36 -0
- data/spec/models/list_users200_response_spec.rb +42 -0
- data/spec/models/mailbox_spec.rb +96 -0
- data/spec/models/map_migration_request_mappings_inner_spec.rb +42 -0
- data/spec/models/map_migration_request_spec.rb +36 -0
- data/spec/models/message_spec.rb +100 -0
- data/spec/models/message_stats_counts_spec.rb +54 -0
- data/spec/models/message_stats_rates_spec.rb +54 -0
- data/spec/models/message_stats_spec.rb +60 -0
- data/spec/models/message_stats_window_spec.rb +42 -0
- data/spec/models/migration_credential_spec.rb +76 -0
- data/spec/models/migration_event_spec.rb +90 -0
- data/spec/models/migration_mailbox_spec.rb +144 -0
- data/spec/models/migration_progress_mailboxes_inner_spec.rb +72 -0
- data/spec/models/migration_progress_spec.rb +90 -0
- data/spec/models/migration_settings_spec.rb +60 -0
- data/spec/models/migration_spec.rb +118 -0
- data/spec/models/model_alias_spec.rb +60 -0
- data/spec/models/plan_catalog_entry_spec.rb +90 -0
- data/spec/models/problem_spec.rb +60 -0
- data/spec/models/replace_distribution_list_members200_response_spec.rb +60 -0
- data/spec/models/replace_distribution_list_members_request_spec.rb +36 -0
- data/spec/models/resource_spec.rb +82 -0
- data/spec/models/rotate_encryption_key_request_spec.rb +48 -0
- data/spec/models/send_message_spec.rb +108 -0
- data/spec/models/shared_member_spec.rb +70 -0
- data/spec/models/signup_request_spec.rb +64 -0
- data/spec/models/start_migration202_response_spec.rb +42 -0
- data/spec/models/suppression_spec.rb +58 -0
- data/spec/models/template_input_spec.rb +54 -0
- data/spec/models/template_spec.rb +72 -0
- data/spec/models/tenant_spec.rb +106 -0
- data/spec/models/unit_bundle_spec.rb +60 -0
- data/spec/models/update_calendar_event_request_spec.rb +66 -0
- data/spec/models/update_calendar_integration_request_spec.rb +52 -0
- data/spec/models/update_calendar_member_request_spec.rb +40 -0
- data/spec/models/update_calendar_policies_request_spec.rb +88 -0
- data/spec/models/update_calendar_request_spec.rb +64 -0
- data/spec/models/update_contact_list_request_spec.rb +52 -0
- data/spec/models/update_contact_request_spec.rb +92 -0
- data/spec/models/update_directory_permissions_request_spec.rb +70 -0
- data/spec/models/update_gal_settings_request_spec.rb +64 -0
- data/spec/models/update_migration_mailbox_request_spec.rb +42 -0
- data/spec/models/update_migration_request_spec.rb +42 -0
- data/spec/models/update_resource_request_spec.rb +62 -0
- data/spec/models/update_user_request_spec.rb +64 -0
- data/spec/models/user_event_spec.rb +48 -0
- data/spec/models/user_spec.rb +100 -0
- data/spec/models/v1_admin_login_post200_response_spec.rb +54 -0
- data/spec/models/v1_admin_login_post_request_spec.rb +42 -0
- data/spec/models/v1_admin_me_get200_response_spec.rb +42 -0
- data/spec/models/v1_admins_get200_response_spec.rb +36 -0
- data/spec/models/v1_admins_id_patch_request_spec.rb +58 -0
- data/spec/models/v1_admins_post_request_spec.rb +58 -0
- data/spec/models/v1_aliases_get200_response_spec.rb +36 -0
- data/spec/models/v1_aliases_post_request_spec.rb +42 -0
- data/spec/models/v1_api_keys_get200_response_spec.rb +36 -0
- data/spec/models/v1_api_keys_post201_response_spec.rb +84 -0
- data/spec/models/v1_api_keys_post_request_spec.rb +46 -0
- data/spec/models/v1_domains_get200_response_spec.rb +36 -0
- data/spec/models/v1_domains_post_request_spec.rb +36 -0
- data/spec/models/v1_inboxes_mailbox_messages_post_request_spec.rb +60 -0
- data/spec/models/v1_mailboxes_email_export_post201_response_spec.rb +52 -0
- data/spec/models/v1_mailboxes_email_patch_request_spec.rb +48 -0
- data/spec/models/v1_mailboxes_email_vacation_put_request_spec.rb +42 -0
- data/spec/models/v1_mailboxes_get200_response_spec.rb +42 -0
- data/spec/models/v1_mailboxes_post_request_spec.rb +48 -0
- data/spec/models/v1_messages_get200_response_spec.rb +42 -0
- data/spec/models/v1_send_batch_post200_response_spec.rb +36 -0
- data/spec/models/v1_send_batch_post_request_spec.rb +36 -0
- data/spec/models/v1_send_post202_response_spec.rb +58 -0
- data/spec/models/v1_send_post_request_attachments_inner_spec.rb +48 -0
- data/spec/models/v1_send_post_request_spec.rb +108 -0
- data/spec/models/v1_suppressions_get200_response_spec.rb +42 -0
- data/spec/models/v1_suppressions_post_request_spec.rb +46 -0
- data/spec/models/v1_templates_get200_response_spec.rb +36 -0
- data/spec/models/v1_usage_get200_response_spec.rb +108 -0
- data/spec/models/v1_vacation_get200_response_spec.rb +36 -0
- data/spec/models/v1_webhooks_get200_response_spec.rb +36 -0
- data/spec/models/v1_webhooks_id_patch_request_spec.rb +48 -0
- data/spec/models/v1_webhooks_post_request_spec.rb +42 -0
- data/spec/models/vacation_params_spec.rb +54 -0
- data/spec/models/vacation_responder_spec.rb +72 -0
- data/spec/models/webhook_spec.rb +96 -0
- data/spec/spec_helper.rb +111 -0
- metadata +952 -0
|
@@ -0,0 +1,337 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#lockally control plane
|
|
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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`. **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
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.1.0
|
|
7
|
+
Contact: support@lockally.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Lockally
|
|
16
|
+
class DistributionListsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Create a distribution list
|
|
23
|
+
# @param create_distribution_list_request [CreateDistributionListRequest]
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [DistributionListDetail]
|
|
26
|
+
def create_distribution_list(create_distribution_list_request, opts = {})
|
|
27
|
+
data, _status_code, _headers = create_distribution_list_with_http_info(create_distribution_list_request, opts)
|
|
28
|
+
data
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Create a distribution list
|
|
32
|
+
# @param create_distribution_list_request [CreateDistributionListRequest]
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(DistributionListDetail, Integer, Hash)>] DistributionListDetail data, response status code and response headers
|
|
35
|
+
def create_distribution_list_with_http_info(create_distribution_list_request, opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: DistributionListsApi.create_distribution_list ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'create_distribution_list_request' is set
|
|
40
|
+
if @api_client.config.client_side_validation && create_distribution_list_request.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'create_distribution_list_request' when calling DistributionListsApi.create_distribution_list"
|
|
42
|
+
end
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = '/v1/distribution-lists'
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = opts[:query_params] || {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = opts[:header_params] || {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
53
|
+
# HTTP header 'Content-Type'
|
|
54
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
55
|
+
if !content_type.nil?
|
|
56
|
+
header_params['Content-Type'] = content_type
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# form parameters
|
|
60
|
+
form_params = opts[:form_params] || {}
|
|
61
|
+
|
|
62
|
+
# http body (model)
|
|
63
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_distribution_list_request)
|
|
64
|
+
|
|
65
|
+
# return_type
|
|
66
|
+
return_type = opts[:debug_return_type] || 'DistributionListDetail'
|
|
67
|
+
|
|
68
|
+
# auth_names
|
|
69
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
70
|
+
|
|
71
|
+
new_options = opts.merge(
|
|
72
|
+
:operation => :"DistributionListsApi.create_distribution_list",
|
|
73
|
+
:header_params => header_params,
|
|
74
|
+
:query_params => query_params,
|
|
75
|
+
:form_params => form_params,
|
|
76
|
+
:body => post_body,
|
|
77
|
+
:auth_names => auth_names,
|
|
78
|
+
:return_type => return_type
|
|
79
|
+
)
|
|
80
|
+
|
|
81
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
82
|
+
if @api_client.config.debugging
|
|
83
|
+
@api_client.config.logger.debug "API called: DistributionListsApi#create_distribution_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
84
|
+
end
|
|
85
|
+
return data, status_code, headers
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Delete a distribution list
|
|
89
|
+
# @param address [String] Distribution list email address
|
|
90
|
+
# @param [Hash] opts the optional parameters
|
|
91
|
+
# @return [nil]
|
|
92
|
+
def delete_distribution_list(address, opts = {})
|
|
93
|
+
delete_distribution_list_with_http_info(address, opts)
|
|
94
|
+
nil
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# Delete a distribution list
|
|
98
|
+
# @param address [String] Distribution list email address
|
|
99
|
+
# @param [Hash] opts the optional parameters
|
|
100
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
101
|
+
def delete_distribution_list_with_http_info(address, opts = {})
|
|
102
|
+
if @api_client.config.debugging
|
|
103
|
+
@api_client.config.logger.debug 'Calling API: DistributionListsApi.delete_distribution_list ...'
|
|
104
|
+
end
|
|
105
|
+
# verify the required parameter 'address' is set
|
|
106
|
+
if @api_client.config.client_side_validation && address.nil?
|
|
107
|
+
fail ArgumentError, "Missing the required parameter 'address' when calling DistributionListsApi.delete_distribution_list"
|
|
108
|
+
end
|
|
109
|
+
# resource path
|
|
110
|
+
local_var_path = '/v1/distribution-lists/{address}'.sub('{address}', CGI.escape(address.to_s))
|
|
111
|
+
|
|
112
|
+
# query parameters
|
|
113
|
+
query_params = opts[:query_params] || {}
|
|
114
|
+
|
|
115
|
+
# header parameters
|
|
116
|
+
header_params = opts[:header_params] || {}
|
|
117
|
+
# HTTP header 'Accept' (if needed)
|
|
118
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
|
|
119
|
+
|
|
120
|
+
# form parameters
|
|
121
|
+
form_params = opts[:form_params] || {}
|
|
122
|
+
|
|
123
|
+
# http body (model)
|
|
124
|
+
post_body = opts[:debug_body]
|
|
125
|
+
|
|
126
|
+
# return_type
|
|
127
|
+
return_type = opts[:debug_return_type]
|
|
128
|
+
|
|
129
|
+
# auth_names
|
|
130
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
131
|
+
|
|
132
|
+
new_options = opts.merge(
|
|
133
|
+
:operation => :"DistributionListsApi.delete_distribution_list",
|
|
134
|
+
:header_params => header_params,
|
|
135
|
+
:query_params => query_params,
|
|
136
|
+
:form_params => form_params,
|
|
137
|
+
:body => post_body,
|
|
138
|
+
:auth_names => auth_names,
|
|
139
|
+
:return_type => return_type
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
143
|
+
if @api_client.config.debugging
|
|
144
|
+
@api_client.config.logger.debug "API called: DistributionListsApi#delete_distribution_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
145
|
+
end
|
|
146
|
+
return data, status_code, headers
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Get a distribution list
|
|
150
|
+
# @param address [String] Distribution list email address
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @return [DistributionListDetail]
|
|
153
|
+
def get_distribution_list(address, opts = {})
|
|
154
|
+
data, _status_code, _headers = get_distribution_list_with_http_info(address, opts)
|
|
155
|
+
data
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Get a distribution list
|
|
159
|
+
# @param address [String] Distribution list email address
|
|
160
|
+
# @param [Hash] opts the optional parameters
|
|
161
|
+
# @return [Array<(DistributionListDetail, Integer, Hash)>] DistributionListDetail data, response status code and response headers
|
|
162
|
+
def get_distribution_list_with_http_info(address, opts = {})
|
|
163
|
+
if @api_client.config.debugging
|
|
164
|
+
@api_client.config.logger.debug 'Calling API: DistributionListsApi.get_distribution_list ...'
|
|
165
|
+
end
|
|
166
|
+
# verify the required parameter 'address' is set
|
|
167
|
+
if @api_client.config.client_side_validation && address.nil?
|
|
168
|
+
fail ArgumentError, "Missing the required parameter 'address' when calling DistributionListsApi.get_distribution_list"
|
|
169
|
+
end
|
|
170
|
+
# resource path
|
|
171
|
+
local_var_path = '/v1/distribution-lists/{address}'.sub('{address}', CGI.escape(address.to_s))
|
|
172
|
+
|
|
173
|
+
# query parameters
|
|
174
|
+
query_params = opts[:query_params] || {}
|
|
175
|
+
|
|
176
|
+
# header parameters
|
|
177
|
+
header_params = opts[:header_params] || {}
|
|
178
|
+
# HTTP header 'Accept' (if needed)
|
|
179
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
180
|
+
|
|
181
|
+
# form parameters
|
|
182
|
+
form_params = opts[:form_params] || {}
|
|
183
|
+
|
|
184
|
+
# http body (model)
|
|
185
|
+
post_body = opts[:debug_body]
|
|
186
|
+
|
|
187
|
+
# return_type
|
|
188
|
+
return_type = opts[:debug_return_type] || 'DistributionListDetail'
|
|
189
|
+
|
|
190
|
+
# auth_names
|
|
191
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
192
|
+
|
|
193
|
+
new_options = opts.merge(
|
|
194
|
+
:operation => :"DistributionListsApi.get_distribution_list",
|
|
195
|
+
:header_params => header_params,
|
|
196
|
+
:query_params => query_params,
|
|
197
|
+
:form_params => form_params,
|
|
198
|
+
:body => post_body,
|
|
199
|
+
:auth_names => auth_names,
|
|
200
|
+
:return_type => return_type
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
204
|
+
if @api_client.config.debugging
|
|
205
|
+
@api_client.config.logger.debug "API called: DistributionListsApi#get_distribution_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
206
|
+
end
|
|
207
|
+
return data, status_code, headers
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# List distribution lists
|
|
211
|
+
# @param [Hash] opts the optional parameters
|
|
212
|
+
# @return [ListDistributionLists200Response]
|
|
213
|
+
def list_distribution_lists(opts = {})
|
|
214
|
+
data, _status_code, _headers = list_distribution_lists_with_http_info(opts)
|
|
215
|
+
data
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# List distribution lists
|
|
219
|
+
# @param [Hash] opts the optional parameters
|
|
220
|
+
# @return [Array<(ListDistributionLists200Response, Integer, Hash)>] ListDistributionLists200Response data, response status code and response headers
|
|
221
|
+
def list_distribution_lists_with_http_info(opts = {})
|
|
222
|
+
if @api_client.config.debugging
|
|
223
|
+
@api_client.config.logger.debug 'Calling API: DistributionListsApi.list_distribution_lists ...'
|
|
224
|
+
end
|
|
225
|
+
# resource path
|
|
226
|
+
local_var_path = '/v1/distribution-lists'
|
|
227
|
+
|
|
228
|
+
# query parameters
|
|
229
|
+
query_params = opts[:query_params] || {}
|
|
230
|
+
|
|
231
|
+
# header parameters
|
|
232
|
+
header_params = opts[:header_params] || {}
|
|
233
|
+
# HTTP header 'Accept' (if needed)
|
|
234
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
235
|
+
|
|
236
|
+
# form parameters
|
|
237
|
+
form_params = opts[:form_params] || {}
|
|
238
|
+
|
|
239
|
+
# http body (model)
|
|
240
|
+
post_body = opts[:debug_body]
|
|
241
|
+
|
|
242
|
+
# return_type
|
|
243
|
+
return_type = opts[:debug_return_type] || 'ListDistributionLists200Response'
|
|
244
|
+
|
|
245
|
+
# auth_names
|
|
246
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
247
|
+
|
|
248
|
+
new_options = opts.merge(
|
|
249
|
+
:operation => :"DistributionListsApi.list_distribution_lists",
|
|
250
|
+
:header_params => header_params,
|
|
251
|
+
:query_params => query_params,
|
|
252
|
+
:form_params => form_params,
|
|
253
|
+
:body => post_body,
|
|
254
|
+
:auth_names => auth_names,
|
|
255
|
+
:return_type => return_type
|
|
256
|
+
)
|
|
257
|
+
|
|
258
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
259
|
+
if @api_client.config.debugging
|
|
260
|
+
@api_client.config.logger.debug "API called: DistributionListsApi#list_distribution_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
261
|
+
end
|
|
262
|
+
return data, status_code, headers
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# Replace distribution list members
|
|
266
|
+
# @param address [String] Distribution list email address
|
|
267
|
+
# @param replace_distribution_list_members_request [ReplaceDistributionListMembersRequest]
|
|
268
|
+
# @param [Hash] opts the optional parameters
|
|
269
|
+
# @return [ReplaceDistributionListMembers200Response]
|
|
270
|
+
def replace_distribution_list_members(address, replace_distribution_list_members_request, opts = {})
|
|
271
|
+
data, _status_code, _headers = replace_distribution_list_members_with_http_info(address, replace_distribution_list_members_request, opts)
|
|
272
|
+
data
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# Replace distribution list members
|
|
276
|
+
# @param address [String] Distribution list email address
|
|
277
|
+
# @param replace_distribution_list_members_request [ReplaceDistributionListMembersRequest]
|
|
278
|
+
# @param [Hash] opts the optional parameters
|
|
279
|
+
# @return [Array<(ReplaceDistributionListMembers200Response, Integer, Hash)>] ReplaceDistributionListMembers200Response data, response status code and response headers
|
|
280
|
+
def replace_distribution_list_members_with_http_info(address, replace_distribution_list_members_request, opts = {})
|
|
281
|
+
if @api_client.config.debugging
|
|
282
|
+
@api_client.config.logger.debug 'Calling API: DistributionListsApi.replace_distribution_list_members ...'
|
|
283
|
+
end
|
|
284
|
+
# verify the required parameter 'address' is set
|
|
285
|
+
if @api_client.config.client_side_validation && address.nil?
|
|
286
|
+
fail ArgumentError, "Missing the required parameter 'address' when calling DistributionListsApi.replace_distribution_list_members"
|
|
287
|
+
end
|
|
288
|
+
# verify the required parameter 'replace_distribution_list_members_request' is set
|
|
289
|
+
if @api_client.config.client_side_validation && replace_distribution_list_members_request.nil?
|
|
290
|
+
fail ArgumentError, "Missing the required parameter 'replace_distribution_list_members_request' when calling DistributionListsApi.replace_distribution_list_members"
|
|
291
|
+
end
|
|
292
|
+
# resource path
|
|
293
|
+
local_var_path = '/v1/distribution-lists/{address}/members'.sub('{address}', CGI.escape(address.to_s))
|
|
294
|
+
|
|
295
|
+
# query parameters
|
|
296
|
+
query_params = opts[:query_params] || {}
|
|
297
|
+
|
|
298
|
+
# header parameters
|
|
299
|
+
header_params = opts[:header_params] || {}
|
|
300
|
+
# HTTP header 'Accept' (if needed)
|
|
301
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
302
|
+
# HTTP header 'Content-Type'
|
|
303
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
304
|
+
if !content_type.nil?
|
|
305
|
+
header_params['Content-Type'] = content_type
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# form parameters
|
|
309
|
+
form_params = opts[:form_params] || {}
|
|
310
|
+
|
|
311
|
+
# http body (model)
|
|
312
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(replace_distribution_list_members_request)
|
|
313
|
+
|
|
314
|
+
# return_type
|
|
315
|
+
return_type = opts[:debug_return_type] || 'ReplaceDistributionListMembers200Response'
|
|
316
|
+
|
|
317
|
+
# auth_names
|
|
318
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
319
|
+
|
|
320
|
+
new_options = opts.merge(
|
|
321
|
+
:operation => :"DistributionListsApi.replace_distribution_list_members",
|
|
322
|
+
:header_params => header_params,
|
|
323
|
+
:query_params => query_params,
|
|
324
|
+
:form_params => form_params,
|
|
325
|
+
:body => post_body,
|
|
326
|
+
:auth_names => auth_names,
|
|
327
|
+
:return_type => return_type
|
|
328
|
+
)
|
|
329
|
+
|
|
330
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
331
|
+
if @api_client.config.debugging
|
|
332
|
+
@api_client.config.logger.debug "API called: DistributionListsApi#replace_distribution_list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
333
|
+
end
|
|
334
|
+
return data, status_code, headers
|
|
335
|
+
end
|
|
336
|
+
end
|
|
337
|
+
end
|
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#lockally control plane
|
|
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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`. **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
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.1.0
|
|
7
|
+
Contact: support@lockally.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Lockally
|
|
16
|
+
class DomainsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Delete a domain
|
|
23
|
+
# Removes the domain registration. Refuses with 409 if any mailbox is still attached — delete the mailboxes first.
|
|
24
|
+
# @param domain [String]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [nil]
|
|
27
|
+
def v1_domains_domain_delete(domain, opts = {})
|
|
28
|
+
v1_domains_domain_delete_with_http_info(domain, opts)
|
|
29
|
+
nil
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Delete a domain
|
|
33
|
+
# Removes the domain registration. Refuses with 409 if any mailbox is still attached — delete the mailboxes first.
|
|
34
|
+
# @param domain [String]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
37
|
+
def v1_domains_domain_delete_with_http_info(domain, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.v1_domains_domain_delete ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'domain' is set
|
|
42
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.v1_domains_domain_delete"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/v1/domains/{domain}'.sub('{domain}', CGI.escape(domain.to_s))
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = opts[:header_params] || {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = opts[:form_params] || {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = opts[:debug_body]
|
|
61
|
+
|
|
62
|
+
# return_type
|
|
63
|
+
return_type = opts[:debug_return_type]
|
|
64
|
+
|
|
65
|
+
# auth_names
|
|
66
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
67
|
+
|
|
68
|
+
new_options = opts.merge(
|
|
69
|
+
:operation => :"DomainsApi.v1_domains_domain_delete",
|
|
70
|
+
:header_params => header_params,
|
|
71
|
+
:query_params => query_params,
|
|
72
|
+
:form_params => form_params,
|
|
73
|
+
:body => post_body,
|
|
74
|
+
:auth_names => auth_names,
|
|
75
|
+
:return_type => return_type
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: DomainsApi#v1_domains_domain_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Get a domain
|
|
86
|
+
# @param domain [String]
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [Domain]
|
|
89
|
+
def v1_domains_domain_get(domain, opts = {})
|
|
90
|
+
data, _status_code, _headers = v1_domains_domain_get_with_http_info(domain, opts)
|
|
91
|
+
data
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Get a domain
|
|
95
|
+
# @param domain [String]
|
|
96
|
+
# @param [Hash] opts the optional parameters
|
|
97
|
+
# @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers
|
|
98
|
+
def v1_domains_domain_get_with_http_info(domain, opts = {})
|
|
99
|
+
if @api_client.config.debugging
|
|
100
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.v1_domains_domain_get ...'
|
|
101
|
+
end
|
|
102
|
+
# verify the required parameter 'domain' is set
|
|
103
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
104
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.v1_domains_domain_get"
|
|
105
|
+
end
|
|
106
|
+
# resource path
|
|
107
|
+
local_var_path = '/v1/domains/{domain}'.sub('{domain}', CGI.escape(domain.to_s))
|
|
108
|
+
|
|
109
|
+
# query parameters
|
|
110
|
+
query_params = opts[:query_params] || {}
|
|
111
|
+
|
|
112
|
+
# header parameters
|
|
113
|
+
header_params = opts[:header_params] || {}
|
|
114
|
+
# HTTP header 'Accept' (if needed)
|
|
115
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
116
|
+
|
|
117
|
+
# form parameters
|
|
118
|
+
form_params = opts[:form_params] || {}
|
|
119
|
+
|
|
120
|
+
# http body (model)
|
|
121
|
+
post_body = opts[:debug_body]
|
|
122
|
+
|
|
123
|
+
# return_type
|
|
124
|
+
return_type = opts[:debug_return_type] || 'Domain'
|
|
125
|
+
|
|
126
|
+
# auth_names
|
|
127
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
128
|
+
|
|
129
|
+
new_options = opts.merge(
|
|
130
|
+
:operation => :"DomainsApi.v1_domains_domain_get",
|
|
131
|
+
:header_params => header_params,
|
|
132
|
+
:query_params => query_params,
|
|
133
|
+
:form_params => form_params,
|
|
134
|
+
:body => post_body,
|
|
135
|
+
:auth_names => auth_names,
|
|
136
|
+
:return_type => return_type
|
|
137
|
+
)
|
|
138
|
+
|
|
139
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
140
|
+
if @api_client.config.debugging
|
|
141
|
+
@api_client.config.logger.debug "API called: DomainsApi#v1_domains_domain_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
142
|
+
end
|
|
143
|
+
return data, status_code, headers
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Force-poll DNS verification
|
|
147
|
+
# 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.
|
|
148
|
+
# @param domain [String]
|
|
149
|
+
# @param [Hash] opts the optional parameters
|
|
150
|
+
# @return [Domain]
|
|
151
|
+
def v1_domains_domain_verify_post(domain, opts = {})
|
|
152
|
+
data, _status_code, _headers = v1_domains_domain_verify_post_with_http_info(domain, opts)
|
|
153
|
+
data
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# Force-poll DNS verification
|
|
157
|
+
# 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.
|
|
158
|
+
# @param domain [String]
|
|
159
|
+
# @param [Hash] opts the optional parameters
|
|
160
|
+
# @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers
|
|
161
|
+
def v1_domains_domain_verify_post_with_http_info(domain, opts = {})
|
|
162
|
+
if @api_client.config.debugging
|
|
163
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.v1_domains_domain_verify_post ...'
|
|
164
|
+
end
|
|
165
|
+
# verify the required parameter 'domain' is set
|
|
166
|
+
if @api_client.config.client_side_validation && domain.nil?
|
|
167
|
+
fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.v1_domains_domain_verify_post"
|
|
168
|
+
end
|
|
169
|
+
# resource path
|
|
170
|
+
local_var_path = '/v1/domains/{domain}/verify'.sub('{domain}', CGI.escape(domain.to_s))
|
|
171
|
+
|
|
172
|
+
# query parameters
|
|
173
|
+
query_params = opts[:query_params] || {}
|
|
174
|
+
|
|
175
|
+
# header parameters
|
|
176
|
+
header_params = opts[:header_params] || {}
|
|
177
|
+
# HTTP header 'Accept' (if needed)
|
|
178
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
179
|
+
|
|
180
|
+
# form parameters
|
|
181
|
+
form_params = opts[:form_params] || {}
|
|
182
|
+
|
|
183
|
+
# http body (model)
|
|
184
|
+
post_body = opts[:debug_body]
|
|
185
|
+
|
|
186
|
+
# return_type
|
|
187
|
+
return_type = opts[:debug_return_type] || 'Domain'
|
|
188
|
+
|
|
189
|
+
# auth_names
|
|
190
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
191
|
+
|
|
192
|
+
new_options = opts.merge(
|
|
193
|
+
:operation => :"DomainsApi.v1_domains_domain_verify_post",
|
|
194
|
+
:header_params => header_params,
|
|
195
|
+
:query_params => query_params,
|
|
196
|
+
:form_params => form_params,
|
|
197
|
+
:body => post_body,
|
|
198
|
+
:auth_names => auth_names,
|
|
199
|
+
:return_type => return_type
|
|
200
|
+
)
|
|
201
|
+
|
|
202
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
203
|
+
if @api_client.config.debugging
|
|
204
|
+
@api_client.config.logger.debug "API called: DomainsApi#v1_domains_domain_verify_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
205
|
+
end
|
|
206
|
+
return data, status_code, headers
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# List domains
|
|
210
|
+
# Returns every domain registered under the calling tenant.
|
|
211
|
+
# @param [Hash] opts the optional parameters
|
|
212
|
+
# @return [V1DomainsGet200Response]
|
|
213
|
+
def v1_domains_get(opts = {})
|
|
214
|
+
data, _status_code, _headers = v1_domains_get_with_http_info(opts)
|
|
215
|
+
data
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# List domains
|
|
219
|
+
# Returns every domain registered under the calling tenant.
|
|
220
|
+
# @param [Hash] opts the optional parameters
|
|
221
|
+
# @return [Array<(V1DomainsGet200Response, Integer, Hash)>] V1DomainsGet200Response data, response status code and response headers
|
|
222
|
+
def v1_domains_get_with_http_info(opts = {})
|
|
223
|
+
if @api_client.config.debugging
|
|
224
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.v1_domains_get ...'
|
|
225
|
+
end
|
|
226
|
+
# resource path
|
|
227
|
+
local_var_path = '/v1/domains'
|
|
228
|
+
|
|
229
|
+
# query parameters
|
|
230
|
+
query_params = opts[:query_params] || {}
|
|
231
|
+
|
|
232
|
+
# header parameters
|
|
233
|
+
header_params = opts[:header_params] || {}
|
|
234
|
+
# HTTP header 'Accept' (if needed)
|
|
235
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
236
|
+
|
|
237
|
+
# form parameters
|
|
238
|
+
form_params = opts[:form_params] || {}
|
|
239
|
+
|
|
240
|
+
# http body (model)
|
|
241
|
+
post_body = opts[:debug_body]
|
|
242
|
+
|
|
243
|
+
# return_type
|
|
244
|
+
return_type = opts[:debug_return_type] || 'V1DomainsGet200Response'
|
|
245
|
+
|
|
246
|
+
# auth_names
|
|
247
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
248
|
+
|
|
249
|
+
new_options = opts.merge(
|
|
250
|
+
:operation => :"DomainsApi.v1_domains_get",
|
|
251
|
+
:header_params => header_params,
|
|
252
|
+
:query_params => query_params,
|
|
253
|
+
:form_params => form_params,
|
|
254
|
+
:body => post_body,
|
|
255
|
+
:auth_names => auth_names,
|
|
256
|
+
:return_type => return_type
|
|
257
|
+
)
|
|
258
|
+
|
|
259
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
260
|
+
if @api_client.config.debugging
|
|
261
|
+
@api_client.config.logger.debug "API called: DomainsApi#v1_domains_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
262
|
+
end
|
|
263
|
+
return data, status_code, headers
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
# Register a domain
|
|
267
|
+
# Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed). **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create. Returns 409 if the domain is already claimed by a different tenant.
|
|
268
|
+
# @param v1_domains_post_request [V1DomainsPostRequest]
|
|
269
|
+
# @param [Hash] opts the optional parameters
|
|
270
|
+
# @return [Domain]
|
|
271
|
+
def v1_domains_post(v1_domains_post_request, opts = {})
|
|
272
|
+
data, _status_code, _headers = v1_domains_post_with_http_info(v1_domains_post_request, opts)
|
|
273
|
+
data
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
# Register a domain
|
|
277
|
+
# Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed). **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create. Returns 409 if the domain is already claimed by a different tenant.
|
|
278
|
+
# @param v1_domains_post_request [V1DomainsPostRequest]
|
|
279
|
+
# @param [Hash] opts the optional parameters
|
|
280
|
+
# @return [Array<(Domain, Integer, Hash)>] Domain data, response status code and response headers
|
|
281
|
+
def v1_domains_post_with_http_info(v1_domains_post_request, opts = {})
|
|
282
|
+
if @api_client.config.debugging
|
|
283
|
+
@api_client.config.logger.debug 'Calling API: DomainsApi.v1_domains_post ...'
|
|
284
|
+
end
|
|
285
|
+
# verify the required parameter 'v1_domains_post_request' is set
|
|
286
|
+
if @api_client.config.client_side_validation && v1_domains_post_request.nil?
|
|
287
|
+
fail ArgumentError, "Missing the required parameter 'v1_domains_post_request' when calling DomainsApi.v1_domains_post"
|
|
288
|
+
end
|
|
289
|
+
# resource path
|
|
290
|
+
local_var_path = '/v1/domains'
|
|
291
|
+
|
|
292
|
+
# query parameters
|
|
293
|
+
query_params = opts[:query_params] || {}
|
|
294
|
+
|
|
295
|
+
# header parameters
|
|
296
|
+
header_params = opts[:header_params] || {}
|
|
297
|
+
# HTTP header 'Accept' (if needed)
|
|
298
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
299
|
+
# HTTP header 'Content-Type'
|
|
300
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
301
|
+
if !content_type.nil?
|
|
302
|
+
header_params['Content-Type'] = content_type
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
# form parameters
|
|
306
|
+
form_params = opts[:form_params] || {}
|
|
307
|
+
|
|
308
|
+
# http body (model)
|
|
309
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_domains_post_request)
|
|
310
|
+
|
|
311
|
+
# return_type
|
|
312
|
+
return_type = opts[:debug_return_type] || 'Domain'
|
|
313
|
+
|
|
314
|
+
# auth_names
|
|
315
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
316
|
+
|
|
317
|
+
new_options = opts.merge(
|
|
318
|
+
:operation => :"DomainsApi.v1_domains_post",
|
|
319
|
+
:header_params => header_params,
|
|
320
|
+
:query_params => query_params,
|
|
321
|
+
:form_params => form_params,
|
|
322
|
+
:body => post_body,
|
|
323
|
+
:auth_names => auth_names,
|
|
324
|
+
:return_type => return_type
|
|
325
|
+
)
|
|
326
|
+
|
|
327
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
328
|
+
if @api_client.config.debugging
|
|
329
|
+
@api_client.config.logger.debug "API called: DomainsApi#v1_domains_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
330
|
+
end
|
|
331
|
+
return data, status_code, headers
|
|
332
|
+
end
|
|
333
|
+
end
|
|
334
|
+
end
|