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,453 @@
|
|
|
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 SendApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# List outbound messages
|
|
23
|
+
# Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [String] :status
|
|
26
|
+
# @option opts [String] :sender Exact match against the `from` mailbox.
|
|
27
|
+
# @option opts [String] :q Free-text search across subject + sender.
|
|
28
|
+
# @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
|
|
29
|
+
# @option opts [String] :cursor queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
|
|
30
|
+
# @option opts [Integer] :limit (default to 50)
|
|
31
|
+
# @return [V1MessagesGet200Response]
|
|
32
|
+
def v1_messages_get(opts = {})
|
|
33
|
+
data, _status_code, _headers = v1_messages_get_with_http_info(opts)
|
|
34
|
+
data
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# List outbound messages
|
|
38
|
+
# Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box.
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @option opts [String] :status
|
|
41
|
+
# @option opts [String] :sender Exact match against the `from` mailbox.
|
|
42
|
+
# @option opts [String] :q Free-text search across subject + sender.
|
|
43
|
+
# @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
|
|
44
|
+
# @option opts [String] :cursor queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
|
|
45
|
+
# @option opts [Integer] :limit (default to 50)
|
|
46
|
+
# @return [Array<(V1MessagesGet200Response, Integer, Hash)>] V1MessagesGet200Response data, response status code and response headers
|
|
47
|
+
def v1_messages_get_with_http_info(opts = {})
|
|
48
|
+
if @api_client.config.debugging
|
|
49
|
+
@api_client.config.logger.debug 'Calling API: SendApi.v1_messages_get ...'
|
|
50
|
+
end
|
|
51
|
+
allowable_values = ["queued", "sending", "delivered", "bounced", "deferred", "complaint"]
|
|
52
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
53
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
54
|
+
end
|
|
55
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
|
|
56
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendApi.v1_messages_get, must be smaller than or equal to 200.'
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# resource path
|
|
60
|
+
local_var_path = '/v1/messages'
|
|
61
|
+
|
|
62
|
+
# query parameters
|
|
63
|
+
query_params = opts[:query_params] || {}
|
|
64
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
65
|
+
query_params[:'sender'] = opts[:'sender'] if !opts[:'sender'].nil?
|
|
66
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
67
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
68
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
69
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
70
|
+
|
|
71
|
+
# header parameters
|
|
72
|
+
header_params = opts[:header_params] || {}
|
|
73
|
+
# HTTP header 'Accept' (if needed)
|
|
74
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
75
|
+
|
|
76
|
+
# form parameters
|
|
77
|
+
form_params = opts[:form_params] || {}
|
|
78
|
+
|
|
79
|
+
# http body (model)
|
|
80
|
+
post_body = opts[:debug_body]
|
|
81
|
+
|
|
82
|
+
# return_type
|
|
83
|
+
return_type = opts[:debug_return_type] || 'V1MessagesGet200Response'
|
|
84
|
+
|
|
85
|
+
# auth_names
|
|
86
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
87
|
+
|
|
88
|
+
new_options = opts.merge(
|
|
89
|
+
:operation => :"SendApi.v1_messages_get",
|
|
90
|
+
:header_params => header_params,
|
|
91
|
+
:query_params => query_params,
|
|
92
|
+
:form_params => form_params,
|
|
93
|
+
:body => post_body,
|
|
94
|
+
:auth_names => auth_names,
|
|
95
|
+
:return_type => return_type
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
99
|
+
if @api_client.config.debugging
|
|
100
|
+
@api_client.config.logger.debug "API called: SendApi#v1_messages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
101
|
+
end
|
|
102
|
+
return data, status_code, headers
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Cancel a scheduled send
|
|
106
|
+
# Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
|
|
107
|
+
# @param id [String]
|
|
108
|
+
# @param [Hash] opts the optional parameters
|
|
109
|
+
# @return [nil]
|
|
110
|
+
def v1_messages_id_delete(id, opts = {})
|
|
111
|
+
v1_messages_id_delete_with_http_info(id, opts)
|
|
112
|
+
nil
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# Cancel a scheduled send
|
|
116
|
+
# Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
|
|
117
|
+
# @param id [String]
|
|
118
|
+
# @param [Hash] opts the optional parameters
|
|
119
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
120
|
+
def v1_messages_id_delete_with_http_info(id, opts = {})
|
|
121
|
+
if @api_client.config.debugging
|
|
122
|
+
@api_client.config.logger.debug 'Calling API: SendApi.v1_messages_id_delete ...'
|
|
123
|
+
end
|
|
124
|
+
# verify the required parameter 'id' is set
|
|
125
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
126
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling SendApi.v1_messages_id_delete"
|
|
127
|
+
end
|
|
128
|
+
# resource path
|
|
129
|
+
local_var_path = '/v1/messages/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
130
|
+
|
|
131
|
+
# query parameters
|
|
132
|
+
query_params = opts[:query_params] || {}
|
|
133
|
+
|
|
134
|
+
# header parameters
|
|
135
|
+
header_params = opts[:header_params] || {}
|
|
136
|
+
# HTTP header 'Accept' (if needed)
|
|
137
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
|
|
138
|
+
|
|
139
|
+
# form parameters
|
|
140
|
+
form_params = opts[:form_params] || {}
|
|
141
|
+
|
|
142
|
+
# http body (model)
|
|
143
|
+
post_body = opts[:debug_body]
|
|
144
|
+
|
|
145
|
+
# return_type
|
|
146
|
+
return_type = opts[:debug_return_type]
|
|
147
|
+
|
|
148
|
+
# auth_names
|
|
149
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
150
|
+
|
|
151
|
+
new_options = opts.merge(
|
|
152
|
+
:operation => :"SendApi.v1_messages_id_delete",
|
|
153
|
+
:header_params => header_params,
|
|
154
|
+
:query_params => query_params,
|
|
155
|
+
:form_params => form_params,
|
|
156
|
+
:body => post_body,
|
|
157
|
+
:auth_names => auth_names,
|
|
158
|
+
:return_type => return_type
|
|
159
|
+
)
|
|
160
|
+
|
|
161
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
162
|
+
if @api_client.config.debugging
|
|
163
|
+
@api_client.config.logger.debug "API called: SendApi#v1_messages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
164
|
+
end
|
|
165
|
+
return data, status_code, headers
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Get message status
|
|
169
|
+
# @param id [String]
|
|
170
|
+
# @param [Hash] opts the optional parameters
|
|
171
|
+
# @return [Message]
|
|
172
|
+
def v1_messages_id_get(id, opts = {})
|
|
173
|
+
data, _status_code, _headers = v1_messages_id_get_with_http_info(id, opts)
|
|
174
|
+
data
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Get message status
|
|
178
|
+
# @param id [String]
|
|
179
|
+
# @param [Hash] opts the optional parameters
|
|
180
|
+
# @return [Array<(Message, Integer, Hash)>] Message data, response status code and response headers
|
|
181
|
+
def v1_messages_id_get_with_http_info(id, opts = {})
|
|
182
|
+
if @api_client.config.debugging
|
|
183
|
+
@api_client.config.logger.debug 'Calling API: SendApi.v1_messages_id_get ...'
|
|
184
|
+
end
|
|
185
|
+
# verify the required parameter 'id' is set
|
|
186
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
187
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling SendApi.v1_messages_id_get"
|
|
188
|
+
end
|
|
189
|
+
# resource path
|
|
190
|
+
local_var_path = '/v1/messages/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
191
|
+
|
|
192
|
+
# query parameters
|
|
193
|
+
query_params = opts[:query_params] || {}
|
|
194
|
+
|
|
195
|
+
# header parameters
|
|
196
|
+
header_params = opts[:header_params] || {}
|
|
197
|
+
# HTTP header 'Accept' (if needed)
|
|
198
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
199
|
+
|
|
200
|
+
# form parameters
|
|
201
|
+
form_params = opts[:form_params] || {}
|
|
202
|
+
|
|
203
|
+
# http body (model)
|
|
204
|
+
post_body = opts[:debug_body]
|
|
205
|
+
|
|
206
|
+
# return_type
|
|
207
|
+
return_type = opts[:debug_return_type] || 'Message'
|
|
208
|
+
|
|
209
|
+
# auth_names
|
|
210
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
211
|
+
|
|
212
|
+
new_options = opts.merge(
|
|
213
|
+
:operation => :"SendApi.v1_messages_id_get",
|
|
214
|
+
:header_params => header_params,
|
|
215
|
+
:query_params => query_params,
|
|
216
|
+
:form_params => form_params,
|
|
217
|
+
:body => post_body,
|
|
218
|
+
:auth_names => auth_names,
|
|
219
|
+
:return_type => return_type
|
|
220
|
+
)
|
|
221
|
+
|
|
222
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
223
|
+
if @api_client.config.debugging
|
|
224
|
+
@api_client.config.logger.debug "API called: SendApi#v1_messages_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
225
|
+
end
|
|
226
|
+
return data, status_code, headers
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
# Aggregate delivery stats
|
|
230
|
+
# Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking.
|
|
231
|
+
# @param [Hash] opts the optional parameters
|
|
232
|
+
# @option opts [Time] :from Window start (default 7 days ago).
|
|
233
|
+
# @option opts [Time] :to Window end (default now).
|
|
234
|
+
# @option opts [String] :domain Filter by sender domain.
|
|
235
|
+
# @return [MessageStats]
|
|
236
|
+
def v1_messages_stats_get(opts = {})
|
|
237
|
+
data, _status_code, _headers = v1_messages_stats_get_with_http_info(opts)
|
|
238
|
+
data
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Aggregate delivery stats
|
|
242
|
+
# Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking.
|
|
243
|
+
# @param [Hash] opts the optional parameters
|
|
244
|
+
# @option opts [Time] :from Window start (default 7 days ago).
|
|
245
|
+
# @option opts [Time] :to Window end (default now).
|
|
246
|
+
# @option opts [String] :domain Filter by sender domain.
|
|
247
|
+
# @return [Array<(MessageStats, Integer, Hash)>] MessageStats data, response status code and response headers
|
|
248
|
+
def v1_messages_stats_get_with_http_info(opts = {})
|
|
249
|
+
if @api_client.config.debugging
|
|
250
|
+
@api_client.config.logger.debug 'Calling API: SendApi.v1_messages_stats_get ...'
|
|
251
|
+
end
|
|
252
|
+
# resource path
|
|
253
|
+
local_var_path = '/v1/messages/stats'
|
|
254
|
+
|
|
255
|
+
# query parameters
|
|
256
|
+
query_params = opts[:query_params] || {}
|
|
257
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
258
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
259
|
+
query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil?
|
|
260
|
+
|
|
261
|
+
# header parameters
|
|
262
|
+
header_params = opts[:header_params] || {}
|
|
263
|
+
# HTTP header 'Accept' (if needed)
|
|
264
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
265
|
+
|
|
266
|
+
# form parameters
|
|
267
|
+
form_params = opts[:form_params] || {}
|
|
268
|
+
|
|
269
|
+
# http body (model)
|
|
270
|
+
post_body = opts[:debug_body]
|
|
271
|
+
|
|
272
|
+
# return_type
|
|
273
|
+
return_type = opts[:debug_return_type] || 'MessageStats'
|
|
274
|
+
|
|
275
|
+
# auth_names
|
|
276
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
277
|
+
|
|
278
|
+
new_options = opts.merge(
|
|
279
|
+
:operation => :"SendApi.v1_messages_stats_get",
|
|
280
|
+
:header_params => header_params,
|
|
281
|
+
:query_params => query_params,
|
|
282
|
+
:form_params => form_params,
|
|
283
|
+
:body => post_body,
|
|
284
|
+
:auth_names => auth_names,
|
|
285
|
+
:return_type => return_type
|
|
286
|
+
)
|
|
287
|
+
|
|
288
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
289
|
+
if @api_client.config.debugging
|
|
290
|
+
@api_client.config.logger.debug "API called: SendApi#v1_messages_stats_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
291
|
+
end
|
|
292
|
+
return data, status_code, headers
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
# Send a batch of emails
|
|
296
|
+
# Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`.
|
|
297
|
+
# @param idempotency_key [String]
|
|
298
|
+
# @param v1_send_batch_post_request [V1SendBatchPostRequest]
|
|
299
|
+
# @param [Hash] opts the optional parameters
|
|
300
|
+
# @return [V1SendBatchPost200Response]
|
|
301
|
+
def v1_send_batch_post(idempotency_key, v1_send_batch_post_request, opts = {})
|
|
302
|
+
data, _status_code, _headers = v1_send_batch_post_with_http_info(idempotency_key, v1_send_batch_post_request, opts)
|
|
303
|
+
data
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# Send a batch of emails
|
|
307
|
+
# Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`.
|
|
308
|
+
# @param idempotency_key [String]
|
|
309
|
+
# @param v1_send_batch_post_request [V1SendBatchPostRequest]
|
|
310
|
+
# @param [Hash] opts the optional parameters
|
|
311
|
+
# @return [Array<(V1SendBatchPost200Response, Integer, Hash)>] V1SendBatchPost200Response data, response status code and response headers
|
|
312
|
+
def v1_send_batch_post_with_http_info(idempotency_key, v1_send_batch_post_request, opts = {})
|
|
313
|
+
if @api_client.config.debugging
|
|
314
|
+
@api_client.config.logger.debug 'Calling API: SendApi.v1_send_batch_post ...'
|
|
315
|
+
end
|
|
316
|
+
# verify the required parameter 'idempotency_key' is set
|
|
317
|
+
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
318
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling SendApi.v1_send_batch_post"
|
|
319
|
+
end
|
|
320
|
+
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 200
|
|
321
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling SendApi.v1_send_batch_post, the character length must be smaller than or equal to 200.'
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
# verify the required parameter 'v1_send_batch_post_request' is set
|
|
325
|
+
if @api_client.config.client_side_validation && v1_send_batch_post_request.nil?
|
|
326
|
+
fail ArgumentError, "Missing the required parameter 'v1_send_batch_post_request' when calling SendApi.v1_send_batch_post"
|
|
327
|
+
end
|
|
328
|
+
# resource path
|
|
329
|
+
local_var_path = '/v1/send/batch'
|
|
330
|
+
|
|
331
|
+
# query parameters
|
|
332
|
+
query_params = opts[:query_params] || {}
|
|
333
|
+
|
|
334
|
+
# header parameters
|
|
335
|
+
header_params = opts[:header_params] || {}
|
|
336
|
+
# HTTP header 'Accept' (if needed)
|
|
337
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
338
|
+
# HTTP header 'Content-Type'
|
|
339
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
340
|
+
if !content_type.nil?
|
|
341
|
+
header_params['Content-Type'] = content_type
|
|
342
|
+
end
|
|
343
|
+
header_params[:'Idempotency-Key'] = idempotency_key
|
|
344
|
+
|
|
345
|
+
# form parameters
|
|
346
|
+
form_params = opts[:form_params] || {}
|
|
347
|
+
|
|
348
|
+
# http body (model)
|
|
349
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_send_batch_post_request)
|
|
350
|
+
|
|
351
|
+
# return_type
|
|
352
|
+
return_type = opts[:debug_return_type] || 'V1SendBatchPost200Response'
|
|
353
|
+
|
|
354
|
+
# auth_names
|
|
355
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
356
|
+
|
|
357
|
+
new_options = opts.merge(
|
|
358
|
+
:operation => :"SendApi.v1_send_batch_post",
|
|
359
|
+
:header_params => header_params,
|
|
360
|
+
:query_params => query_params,
|
|
361
|
+
:form_params => form_params,
|
|
362
|
+
:body => post_body,
|
|
363
|
+
:auth_names => auth_names,
|
|
364
|
+
:return_type => return_type
|
|
365
|
+
)
|
|
366
|
+
|
|
367
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
368
|
+
if @api_client.config.debugging
|
|
369
|
+
@api_client.config.logger.debug "API called: SendApi#v1_send_batch_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
370
|
+
end
|
|
371
|
+
return data, status_code, headers
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
# Send an email
|
|
375
|
+
# 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.
|
|
376
|
+
# @param idempotency_key [String]
|
|
377
|
+
# @param v1_send_post_request [V1SendPostRequest]
|
|
378
|
+
# @param [Hash] opts the optional parameters
|
|
379
|
+
# @return [V1SendPost202Response]
|
|
380
|
+
def v1_send_post(idempotency_key, v1_send_post_request, opts = {})
|
|
381
|
+
data, _status_code, _headers = v1_send_post_with_http_info(idempotency_key, v1_send_post_request, opts)
|
|
382
|
+
data
|
|
383
|
+
end
|
|
384
|
+
|
|
385
|
+
# Send an email
|
|
386
|
+
# 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.
|
|
387
|
+
# @param idempotency_key [String]
|
|
388
|
+
# @param v1_send_post_request [V1SendPostRequest]
|
|
389
|
+
# @param [Hash] opts the optional parameters
|
|
390
|
+
# @return [Array<(V1SendPost202Response, Integer, Hash)>] V1SendPost202Response data, response status code and response headers
|
|
391
|
+
def v1_send_post_with_http_info(idempotency_key, v1_send_post_request, opts = {})
|
|
392
|
+
if @api_client.config.debugging
|
|
393
|
+
@api_client.config.logger.debug 'Calling API: SendApi.v1_send_post ...'
|
|
394
|
+
end
|
|
395
|
+
# verify the required parameter 'idempotency_key' is set
|
|
396
|
+
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
397
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling SendApi.v1_send_post"
|
|
398
|
+
end
|
|
399
|
+
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
|
|
400
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling SendApi.v1_send_post, the character length must be smaller than or equal to 255.'
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
# verify the required parameter 'v1_send_post_request' is set
|
|
404
|
+
if @api_client.config.client_side_validation && v1_send_post_request.nil?
|
|
405
|
+
fail ArgumentError, "Missing the required parameter 'v1_send_post_request' when calling SendApi.v1_send_post"
|
|
406
|
+
end
|
|
407
|
+
# resource path
|
|
408
|
+
local_var_path = '/v1/send'
|
|
409
|
+
|
|
410
|
+
# query parameters
|
|
411
|
+
query_params = opts[:query_params] || {}
|
|
412
|
+
|
|
413
|
+
# header parameters
|
|
414
|
+
header_params = opts[:header_params] || {}
|
|
415
|
+
# HTTP header 'Accept' (if needed)
|
|
416
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
|
|
417
|
+
# HTTP header 'Content-Type'
|
|
418
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
419
|
+
if !content_type.nil?
|
|
420
|
+
header_params['Content-Type'] = content_type
|
|
421
|
+
end
|
|
422
|
+
header_params[:'Idempotency-Key'] = idempotency_key
|
|
423
|
+
|
|
424
|
+
# form parameters
|
|
425
|
+
form_params = opts[:form_params] || {}
|
|
426
|
+
|
|
427
|
+
# http body (model)
|
|
428
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_send_post_request)
|
|
429
|
+
|
|
430
|
+
# return_type
|
|
431
|
+
return_type = opts[:debug_return_type] || 'V1SendPost202Response'
|
|
432
|
+
|
|
433
|
+
# auth_names
|
|
434
|
+
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
435
|
+
|
|
436
|
+
new_options = opts.merge(
|
|
437
|
+
:operation => :"SendApi.v1_send_post",
|
|
438
|
+
:header_params => header_params,
|
|
439
|
+
:query_params => query_params,
|
|
440
|
+
:form_params => form_params,
|
|
441
|
+
:body => post_body,
|
|
442
|
+
:auth_names => auth_names,
|
|
443
|
+
:return_type => return_type
|
|
444
|
+
)
|
|
445
|
+
|
|
446
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
447
|
+
if @api_client.config.debugging
|
|
448
|
+
@api_client.config.logger.debug "API called: SendApi#v1_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
449
|
+
end
|
|
450
|
+
return data, status_code, headers
|
|
451
|
+
end
|
|
452
|
+
end
|
|
453
|
+
end
|
|
@@ -0,0 +1,88 @@
|
|
|
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 SignupApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Sign up a new tenant
|
|
23
|
+
# @param signup_request [SignupRequest]
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [V1AdminLoginPost200Response]
|
|
26
|
+
def signup(signup_request, opts = {})
|
|
27
|
+
data, _status_code, _headers = signup_with_http_info(signup_request, opts)
|
|
28
|
+
data
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Sign up a new tenant
|
|
32
|
+
# @param signup_request [SignupRequest]
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(V1AdminLoginPost200Response, Integer, Hash)>] V1AdminLoginPost200Response data, response status code and response headers
|
|
35
|
+
def signup_with_http_info(signup_request, opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: SignupApi.signup ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'signup_request' is set
|
|
40
|
+
if @api_client.config.client_side_validation && signup_request.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'signup_request' when calling SignupApi.signup"
|
|
42
|
+
end
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = '/v1/signup'
|
|
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(signup_request)
|
|
64
|
+
|
|
65
|
+
# return_type
|
|
66
|
+
return_type = opts[:debug_return_type] || 'V1AdminLoginPost200Response'
|
|
67
|
+
|
|
68
|
+
# auth_names
|
|
69
|
+
auth_names = opts[:debug_auth_names] || []
|
|
70
|
+
|
|
71
|
+
new_options = opts.merge(
|
|
72
|
+
:operation => :"SignupApi.signup",
|
|
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: SignupApi#signup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
84
|
+
end
|
|
85
|
+
return data, status_code, headers
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|