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
data/docs/AgentsApi.md
ADDED
|
@@ -0,0 +1,927 @@
|
|
|
1
|
+
# Lockally::AgentsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.lockally.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**v1_api_keys_key_id_mailboxes_get**](AgentsApi.md#v1_api_keys_key_id_mailboxes_get) | **GET** /v1/api-keys/{keyID}/mailboxes | List a key's mailbox grants |
|
|
8
|
+
| [**v1_api_keys_key_id_mailboxes_mailbox_id_delete**](AgentsApi.md#v1_api_keys_key_id_mailboxes_mailbox_id_delete) | **DELETE** /v1/api-keys/{keyID}/mailboxes/{mailboxID} | Revoke a mailbox grant |
|
|
9
|
+
| [**v1_api_keys_key_id_mailboxes_post**](AgentsApi.md#v1_api_keys_key_id_mailboxes_post) | **POST** /v1/api-keys/{keyID}/mailboxes | Grant a mailbox to a key |
|
|
10
|
+
| [**v1_auth_whoami_get**](AgentsApi.md#v1_auth_whoami_get) | **GET** /v1/auth/whoami | Introspect the calling credentials |
|
|
11
|
+
| [**v1_contacts_lookup_get**](AgentsApi.md#v1_contacts_lookup_get) | **GET** /v1/contacts/lookup | Who is this sender? |
|
|
12
|
+
| [**v1_inboxes_get**](AgentsApi.md#v1_inboxes_get) | **GET** /v1/inboxes | List granted inboxes |
|
|
13
|
+
| [**v1_inboxes_mailbox_messages_post**](AgentsApi.md#v1_inboxes_mailbox_messages_post) | **POST** /v1/inboxes/{mailbox}/messages | Start a new conversation (agent stream) |
|
|
14
|
+
| [**v1_inboxes_mailbox_threads_get**](AgentsApi.md#v1_inboxes_mailbox_threads_get) | **GET** /v1/inboxes/{mailbox}/threads | List conversation threads |
|
|
15
|
+
| [**v1_threads_thread_id_get**](AgentsApi.md#v1_threads_thread_id_get) | **GET** /v1/threads/{threadID} | Get a whole conversation |
|
|
16
|
+
| [**v1_threads_thread_id_messages_message_id_attachments_idx_get**](AgentsApi.md#v1_threads_thread_id_messages_message_id_attachments_idx_get) | **GET** /v1/threads/{threadID}/messages/{messageID}/attachments/{idx} | Download an attachment |
|
|
17
|
+
| [**v1_threads_thread_id_messages_message_id_get**](AgentsApi.md#v1_threads_thread_id_messages_message_id_get) | **GET** /v1/threads/{threadID}/messages/{messageID} | Get one message with body |
|
|
18
|
+
| [**v1_threads_thread_id_messages_message_id_read_post**](AgentsApi.md#v1_threads_thread_id_messages_message_id_read_post) | **POST** /v1/threads/{threadID}/messages/{messageID}/read | Mark read/unread |
|
|
19
|
+
| [**v1_threads_thread_id_reply_post**](AgentsApi.md#v1_threads_thread_id_reply_post) | **POST** /v1/threads/{threadID}/reply | Reply in-thread (agent stream) |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## v1_api_keys_key_id_mailboxes_get
|
|
23
|
+
|
|
24
|
+
> Object v1_api_keys_key_id_mailboxes_get(key_id)
|
|
25
|
+
|
|
26
|
+
List a key's mailbox grants
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'time'
|
|
32
|
+
require 'lockally'
|
|
33
|
+
# setup authorization
|
|
34
|
+
Lockally.configure do |config|
|
|
35
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
36
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
api_instance = Lockally::AgentsApi.new
|
|
40
|
+
key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
# List a key's mailbox grants
|
|
44
|
+
result = api_instance.v1_api_keys_key_id_mailboxes_get(key_id)
|
|
45
|
+
p result
|
|
46
|
+
rescue Lockally::ApiError => e
|
|
47
|
+
puts "Error when calling AgentsApi->v1_api_keys_key_id_mailboxes_get: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Using the v1_api_keys_key_id_mailboxes_get_with_http_info variant
|
|
52
|
+
|
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
|
54
|
+
|
|
55
|
+
> <Array(Object, Integer, Hash)> v1_api_keys_key_id_mailboxes_get_with_http_info(key_id)
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
begin
|
|
59
|
+
# List a key's mailbox grants
|
|
60
|
+
data, status_code, headers = api_instance.v1_api_keys_key_id_mailboxes_get_with_http_info(key_id)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => Object
|
|
64
|
+
rescue Lockally::ApiError => e
|
|
65
|
+
puts "Error when calling AgentsApi->v1_api_keys_key_id_mailboxes_get_with_http_info: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **key_id** | **String** | | |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
**Object**
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: Not defined
|
|
86
|
+
- **Accept**: application/json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## v1_api_keys_key_id_mailboxes_mailbox_id_delete
|
|
90
|
+
|
|
91
|
+
> v1_api_keys_key_id_mailboxes_mailbox_id_delete(key_id, mailbox_id)
|
|
92
|
+
|
|
93
|
+
Revoke a mailbox grant
|
|
94
|
+
|
|
95
|
+
### Examples
|
|
96
|
+
|
|
97
|
+
```ruby
|
|
98
|
+
require 'time'
|
|
99
|
+
require 'lockally'
|
|
100
|
+
# setup authorization
|
|
101
|
+
Lockally.configure do |config|
|
|
102
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
103
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
api_instance = Lockally::AgentsApi.new
|
|
107
|
+
key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
108
|
+
mailbox_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
# Revoke a mailbox grant
|
|
112
|
+
api_instance.v1_api_keys_key_id_mailboxes_mailbox_id_delete(key_id, mailbox_id)
|
|
113
|
+
rescue Lockally::ApiError => e
|
|
114
|
+
puts "Error when calling AgentsApi->v1_api_keys_key_id_mailboxes_mailbox_id_delete: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Using the v1_api_keys_key_id_mailboxes_mailbox_id_delete_with_http_info variant
|
|
119
|
+
|
|
120
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
121
|
+
|
|
122
|
+
> <Array(nil, Integer, Hash)> v1_api_keys_key_id_mailboxes_mailbox_id_delete_with_http_info(key_id, mailbox_id)
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
begin
|
|
126
|
+
# Revoke a mailbox grant
|
|
127
|
+
data, status_code, headers = api_instance.v1_api_keys_key_id_mailboxes_mailbox_id_delete_with_http_info(key_id, mailbox_id)
|
|
128
|
+
p status_code # => 2xx
|
|
129
|
+
p headers # => { ... }
|
|
130
|
+
p data # => nil
|
|
131
|
+
rescue Lockally::ApiError => e
|
|
132
|
+
puts "Error when calling AgentsApi->v1_api_keys_key_id_mailboxes_mailbox_id_delete_with_http_info: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
|
140
|
+
| **key_id** | **String** | | |
|
|
141
|
+
| **mailbox_id** | **String** | | |
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
nil (empty response body)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: Not defined
|
|
154
|
+
- **Accept**: Not defined
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
## v1_api_keys_key_id_mailboxes_post
|
|
158
|
+
|
|
159
|
+
> Object v1_api_keys_key_id_mailboxes_post(key_id)
|
|
160
|
+
|
|
161
|
+
Grant a mailbox to a key
|
|
162
|
+
|
|
163
|
+
Body: {\"mailbox\": \"email or id\"}. Refused (422) for mailboxes with agent access disabled or an active E2E encryption key — the server cannot read E2E mailboxes.
|
|
164
|
+
|
|
165
|
+
### Examples
|
|
166
|
+
|
|
167
|
+
```ruby
|
|
168
|
+
require 'time'
|
|
169
|
+
require 'lockally'
|
|
170
|
+
# setup authorization
|
|
171
|
+
Lockally.configure do |config|
|
|
172
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
173
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
api_instance = Lockally::AgentsApi.new
|
|
177
|
+
key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
# Grant a mailbox to a key
|
|
181
|
+
result = api_instance.v1_api_keys_key_id_mailboxes_post(key_id)
|
|
182
|
+
p result
|
|
183
|
+
rescue Lockally::ApiError => e
|
|
184
|
+
puts "Error when calling AgentsApi->v1_api_keys_key_id_mailboxes_post: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
#### Using the v1_api_keys_key_id_mailboxes_post_with_http_info variant
|
|
189
|
+
|
|
190
|
+
This returns an Array which contains the response data, status code and headers.
|
|
191
|
+
|
|
192
|
+
> <Array(Object, Integer, Hash)> v1_api_keys_key_id_mailboxes_post_with_http_info(key_id)
|
|
193
|
+
|
|
194
|
+
```ruby
|
|
195
|
+
begin
|
|
196
|
+
# Grant a mailbox to a key
|
|
197
|
+
data, status_code, headers = api_instance.v1_api_keys_key_id_mailboxes_post_with_http_info(key_id)
|
|
198
|
+
p status_code # => 2xx
|
|
199
|
+
p headers # => { ... }
|
|
200
|
+
p data # => Object
|
|
201
|
+
rescue Lockally::ApiError => e
|
|
202
|
+
puts "Error when calling AgentsApi->v1_api_keys_key_id_mailboxes_post_with_http_info: #{e}"
|
|
203
|
+
end
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Parameters
|
|
207
|
+
|
|
208
|
+
| Name | Type | Description | Notes |
|
|
209
|
+
| ---- | ---- | ----------- | ----- |
|
|
210
|
+
| **key_id** | **String** | | |
|
|
211
|
+
|
|
212
|
+
### Return type
|
|
213
|
+
|
|
214
|
+
**Object**
|
|
215
|
+
|
|
216
|
+
### Authorization
|
|
217
|
+
|
|
218
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
219
|
+
|
|
220
|
+
### HTTP request headers
|
|
221
|
+
|
|
222
|
+
- **Content-Type**: Not defined
|
|
223
|
+
- **Accept**: application/json
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
## v1_auth_whoami_get
|
|
227
|
+
|
|
228
|
+
> Object v1_auth_whoami_get
|
|
229
|
+
|
|
230
|
+
Introspect the calling credentials
|
|
231
|
+
|
|
232
|
+
Returns the tenant, auth kind (api_key/session), key label, and granted scopes. The MCP server uses this to scope-filter tool discovery.
|
|
233
|
+
|
|
234
|
+
### Examples
|
|
235
|
+
|
|
236
|
+
```ruby
|
|
237
|
+
require 'time'
|
|
238
|
+
require 'lockally'
|
|
239
|
+
# setup authorization
|
|
240
|
+
Lockally.configure do |config|
|
|
241
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
242
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
api_instance = Lockally::AgentsApi.new
|
|
246
|
+
|
|
247
|
+
begin
|
|
248
|
+
# Introspect the calling credentials
|
|
249
|
+
result = api_instance.v1_auth_whoami_get
|
|
250
|
+
p result
|
|
251
|
+
rescue Lockally::ApiError => e
|
|
252
|
+
puts "Error when calling AgentsApi->v1_auth_whoami_get: #{e}"
|
|
253
|
+
end
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
#### Using the v1_auth_whoami_get_with_http_info variant
|
|
257
|
+
|
|
258
|
+
This returns an Array which contains the response data, status code and headers.
|
|
259
|
+
|
|
260
|
+
> <Array(Object, Integer, Hash)> v1_auth_whoami_get_with_http_info
|
|
261
|
+
|
|
262
|
+
```ruby
|
|
263
|
+
begin
|
|
264
|
+
# Introspect the calling credentials
|
|
265
|
+
data, status_code, headers = api_instance.v1_auth_whoami_get_with_http_info
|
|
266
|
+
p status_code # => 2xx
|
|
267
|
+
p headers # => { ... }
|
|
268
|
+
p data # => Object
|
|
269
|
+
rescue Lockally::ApiError => e
|
|
270
|
+
puts "Error when calling AgentsApi->v1_auth_whoami_get_with_http_info: #{e}"
|
|
271
|
+
end
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Parameters
|
|
275
|
+
|
|
276
|
+
This endpoint does not need any parameter.
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
**Object**
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: Not defined
|
|
289
|
+
- **Accept**: application/json
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
## v1_contacts_lookup_get
|
|
293
|
+
|
|
294
|
+
> Object v1_contacts_lookup_get(email)
|
|
295
|
+
|
|
296
|
+
Who is this sender?
|
|
297
|
+
|
|
298
|
+
Directory record (name, company, role, notes), whether the address is one of the tenant's own mailboxes, and grant-aware correspondence history (thread count, first/last seen across granted mailboxes only).
|
|
299
|
+
|
|
300
|
+
### Examples
|
|
301
|
+
|
|
302
|
+
```ruby
|
|
303
|
+
require 'time'
|
|
304
|
+
require 'lockally'
|
|
305
|
+
# setup authorization
|
|
306
|
+
Lockally.configure do |config|
|
|
307
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
308
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
309
|
+
end
|
|
310
|
+
|
|
311
|
+
api_instance = Lockally::AgentsApi.new
|
|
312
|
+
email = 'email_example' # String |
|
|
313
|
+
|
|
314
|
+
begin
|
|
315
|
+
# Who is this sender?
|
|
316
|
+
result = api_instance.v1_contacts_lookup_get(email)
|
|
317
|
+
p result
|
|
318
|
+
rescue Lockally::ApiError => e
|
|
319
|
+
puts "Error when calling AgentsApi->v1_contacts_lookup_get: #{e}"
|
|
320
|
+
end
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
#### Using the v1_contacts_lookup_get_with_http_info variant
|
|
324
|
+
|
|
325
|
+
This returns an Array which contains the response data, status code and headers.
|
|
326
|
+
|
|
327
|
+
> <Array(Object, Integer, Hash)> v1_contacts_lookup_get_with_http_info(email)
|
|
328
|
+
|
|
329
|
+
```ruby
|
|
330
|
+
begin
|
|
331
|
+
# Who is this sender?
|
|
332
|
+
data, status_code, headers = api_instance.v1_contacts_lookup_get_with_http_info(email)
|
|
333
|
+
p status_code # => 2xx
|
|
334
|
+
p headers # => { ... }
|
|
335
|
+
p data # => Object
|
|
336
|
+
rescue Lockally::ApiError => e
|
|
337
|
+
puts "Error when calling AgentsApi->v1_contacts_lookup_get_with_http_info: #{e}"
|
|
338
|
+
end
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
| Name | Type | Description | Notes |
|
|
344
|
+
| ---- | ---- | ----------- | ----- |
|
|
345
|
+
| **email** | **String** | | |
|
|
346
|
+
|
|
347
|
+
### Return type
|
|
348
|
+
|
|
349
|
+
**Object**
|
|
350
|
+
|
|
351
|
+
### Authorization
|
|
352
|
+
|
|
353
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
354
|
+
|
|
355
|
+
### HTTP request headers
|
|
356
|
+
|
|
357
|
+
- **Content-Type**: Not defined
|
|
358
|
+
- **Accept**: application/json
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
## v1_inboxes_get
|
|
362
|
+
|
|
363
|
+
> Object v1_inboxes_get
|
|
364
|
+
|
|
365
|
+
List granted inboxes
|
|
366
|
+
|
|
367
|
+
The mailboxes this key is granted, with thread counts and last activity. Admin sessions see every agent-enabled, non-E2E mailbox.
|
|
368
|
+
|
|
369
|
+
### Examples
|
|
370
|
+
|
|
371
|
+
```ruby
|
|
372
|
+
require 'time'
|
|
373
|
+
require 'lockally'
|
|
374
|
+
# setup authorization
|
|
375
|
+
Lockally.configure do |config|
|
|
376
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
377
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
378
|
+
end
|
|
379
|
+
|
|
380
|
+
api_instance = Lockally::AgentsApi.new
|
|
381
|
+
|
|
382
|
+
begin
|
|
383
|
+
# List granted inboxes
|
|
384
|
+
result = api_instance.v1_inboxes_get
|
|
385
|
+
p result
|
|
386
|
+
rescue Lockally::ApiError => e
|
|
387
|
+
puts "Error when calling AgentsApi->v1_inboxes_get: #{e}"
|
|
388
|
+
end
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
#### Using the v1_inboxes_get_with_http_info variant
|
|
392
|
+
|
|
393
|
+
This returns an Array which contains the response data, status code and headers.
|
|
394
|
+
|
|
395
|
+
> <Array(Object, Integer, Hash)> v1_inboxes_get_with_http_info
|
|
396
|
+
|
|
397
|
+
```ruby
|
|
398
|
+
begin
|
|
399
|
+
# List granted inboxes
|
|
400
|
+
data, status_code, headers = api_instance.v1_inboxes_get_with_http_info
|
|
401
|
+
p status_code # => 2xx
|
|
402
|
+
p headers # => { ... }
|
|
403
|
+
p data # => Object
|
|
404
|
+
rescue Lockally::ApiError => e
|
|
405
|
+
puts "Error when calling AgentsApi->v1_inboxes_get_with_http_info: #{e}"
|
|
406
|
+
end
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
### Parameters
|
|
410
|
+
|
|
411
|
+
This endpoint does not need any parameter.
|
|
412
|
+
|
|
413
|
+
### Return type
|
|
414
|
+
|
|
415
|
+
**Object**
|
|
416
|
+
|
|
417
|
+
### Authorization
|
|
418
|
+
|
|
419
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
420
|
+
|
|
421
|
+
### HTTP request headers
|
|
422
|
+
|
|
423
|
+
- **Content-Type**: Not defined
|
|
424
|
+
- **Accept**: application/json
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
## v1_inboxes_mailbox_messages_post
|
|
428
|
+
|
|
429
|
+
> Object v1_inboxes_mailbox_messages_post(mailbox, idempotency_key, v1_inboxes_mailbox_messages_post_request)
|
|
430
|
+
|
|
431
|
+
Start a new conversation (agent stream)
|
|
432
|
+
|
|
433
|
+
Sends a new email from a granted mailbox. Classified stream=agent (isolated reputation, per-key rate caps). The first inbound reply adopts the created thread via the References chain. Idempotency-Key required. Mailboxes with agent_draft_policy=always_approve divert this into a pending draft.
|
|
434
|
+
|
|
435
|
+
### Examples
|
|
436
|
+
|
|
437
|
+
```ruby
|
|
438
|
+
require 'time'
|
|
439
|
+
require 'lockally'
|
|
440
|
+
# setup authorization
|
|
441
|
+
Lockally.configure do |config|
|
|
442
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
443
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
api_instance = Lockally::AgentsApi.new
|
|
447
|
+
mailbox = 'mailbox_example' # String |
|
|
448
|
+
idempotency_key = 'idempotency_key_example' # String |
|
|
449
|
+
v1_inboxes_mailbox_messages_post_request = Lockally::V1InboxesMailboxMessagesPostRequest.new({to: ['to_example'], text: 'text_example'}) # V1InboxesMailboxMessagesPostRequest |
|
|
450
|
+
|
|
451
|
+
begin
|
|
452
|
+
# Start a new conversation (agent stream)
|
|
453
|
+
result = api_instance.v1_inboxes_mailbox_messages_post(mailbox, idempotency_key, v1_inboxes_mailbox_messages_post_request)
|
|
454
|
+
p result
|
|
455
|
+
rescue Lockally::ApiError => e
|
|
456
|
+
puts "Error when calling AgentsApi->v1_inboxes_mailbox_messages_post: #{e}"
|
|
457
|
+
end
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
#### Using the v1_inboxes_mailbox_messages_post_with_http_info variant
|
|
461
|
+
|
|
462
|
+
This returns an Array which contains the response data, status code and headers.
|
|
463
|
+
|
|
464
|
+
> <Array(Object, Integer, Hash)> v1_inboxes_mailbox_messages_post_with_http_info(mailbox, idempotency_key, v1_inboxes_mailbox_messages_post_request)
|
|
465
|
+
|
|
466
|
+
```ruby
|
|
467
|
+
begin
|
|
468
|
+
# Start a new conversation (agent stream)
|
|
469
|
+
data, status_code, headers = api_instance.v1_inboxes_mailbox_messages_post_with_http_info(mailbox, idempotency_key, v1_inboxes_mailbox_messages_post_request)
|
|
470
|
+
p status_code # => 2xx
|
|
471
|
+
p headers # => { ... }
|
|
472
|
+
p data # => Object
|
|
473
|
+
rescue Lockally::ApiError => e
|
|
474
|
+
puts "Error when calling AgentsApi->v1_inboxes_mailbox_messages_post_with_http_info: #{e}"
|
|
475
|
+
end
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
### Parameters
|
|
479
|
+
|
|
480
|
+
| Name | Type | Description | Notes |
|
|
481
|
+
| ---- | ---- | ----------- | ----- |
|
|
482
|
+
| **mailbox** | **String** | | |
|
|
483
|
+
| **idempotency_key** | **String** | | |
|
|
484
|
+
| **v1_inboxes_mailbox_messages_post_request** | [**V1InboxesMailboxMessagesPostRequest**](V1InboxesMailboxMessagesPostRequest.md) | | |
|
|
485
|
+
|
|
486
|
+
### Return type
|
|
487
|
+
|
|
488
|
+
**Object**
|
|
489
|
+
|
|
490
|
+
### Authorization
|
|
491
|
+
|
|
492
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
493
|
+
|
|
494
|
+
### HTTP request headers
|
|
495
|
+
|
|
496
|
+
- **Content-Type**: application/json
|
|
497
|
+
- **Accept**: application/json
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
## v1_inboxes_mailbox_threads_get
|
|
501
|
+
|
|
502
|
+
> Object v1_inboxes_mailbox_threads_get(mailbox, opts)
|
|
503
|
+
|
|
504
|
+
List conversation threads
|
|
505
|
+
|
|
506
|
+
Newest-active first. Cursors: `?before=<RFC3339>` pages backwards; `?since=<RFC3339>` delta-syncs forward (oldest first) so an agent can catch up in order.
|
|
507
|
+
|
|
508
|
+
### Examples
|
|
509
|
+
|
|
510
|
+
```ruby
|
|
511
|
+
require 'time'
|
|
512
|
+
require 'lockally'
|
|
513
|
+
# setup authorization
|
|
514
|
+
Lockally.configure do |config|
|
|
515
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
516
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
api_instance = Lockally::AgentsApi.new
|
|
520
|
+
mailbox = 'mailbox_example' # String | mailbox email or id
|
|
521
|
+
opts = {
|
|
522
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
523
|
+
before: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
524
|
+
limit: 56 # Integer |
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
begin
|
|
528
|
+
# List conversation threads
|
|
529
|
+
result = api_instance.v1_inboxes_mailbox_threads_get(mailbox, opts)
|
|
530
|
+
p result
|
|
531
|
+
rescue Lockally::ApiError => e
|
|
532
|
+
puts "Error when calling AgentsApi->v1_inboxes_mailbox_threads_get: #{e}"
|
|
533
|
+
end
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
#### Using the v1_inboxes_mailbox_threads_get_with_http_info variant
|
|
537
|
+
|
|
538
|
+
This returns an Array which contains the response data, status code and headers.
|
|
539
|
+
|
|
540
|
+
> <Array(Object, Integer, Hash)> v1_inboxes_mailbox_threads_get_with_http_info(mailbox, opts)
|
|
541
|
+
|
|
542
|
+
```ruby
|
|
543
|
+
begin
|
|
544
|
+
# List conversation threads
|
|
545
|
+
data, status_code, headers = api_instance.v1_inboxes_mailbox_threads_get_with_http_info(mailbox, opts)
|
|
546
|
+
p status_code # => 2xx
|
|
547
|
+
p headers # => { ... }
|
|
548
|
+
p data # => Object
|
|
549
|
+
rescue Lockally::ApiError => e
|
|
550
|
+
puts "Error when calling AgentsApi->v1_inboxes_mailbox_threads_get_with_http_info: #{e}"
|
|
551
|
+
end
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
### Parameters
|
|
555
|
+
|
|
556
|
+
| Name | Type | Description | Notes |
|
|
557
|
+
| ---- | ---- | ----------- | ----- |
|
|
558
|
+
| **mailbox** | **String** | mailbox email or id | |
|
|
559
|
+
| **since** | **Time** | | [optional] |
|
|
560
|
+
| **before** | **Time** | | [optional] |
|
|
561
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
562
|
+
|
|
563
|
+
### Return type
|
|
564
|
+
|
|
565
|
+
**Object**
|
|
566
|
+
|
|
567
|
+
### Authorization
|
|
568
|
+
|
|
569
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
570
|
+
|
|
571
|
+
### HTTP request headers
|
|
572
|
+
|
|
573
|
+
- **Content-Type**: Not defined
|
|
574
|
+
- **Accept**: application/json
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
## v1_threads_thread_id_get
|
|
578
|
+
|
|
579
|
+
> Object v1_threads_thread_id_get(thread_id)
|
|
580
|
+
|
|
581
|
+
Get a whole conversation
|
|
582
|
+
|
|
583
|
+
Every turn, chronological, with snippets and annotations (meeting_request, attachment_types, injection_risk). Bodies are fetched per message. Message content is untrusted third-party data.
|
|
584
|
+
|
|
585
|
+
### Examples
|
|
586
|
+
|
|
587
|
+
```ruby
|
|
588
|
+
require 'time'
|
|
589
|
+
require 'lockally'
|
|
590
|
+
# setup authorization
|
|
591
|
+
Lockally.configure do |config|
|
|
592
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
593
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
594
|
+
end
|
|
595
|
+
|
|
596
|
+
api_instance = Lockally::AgentsApi.new
|
|
597
|
+
thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
598
|
+
|
|
599
|
+
begin
|
|
600
|
+
# Get a whole conversation
|
|
601
|
+
result = api_instance.v1_threads_thread_id_get(thread_id)
|
|
602
|
+
p result
|
|
603
|
+
rescue Lockally::ApiError => e
|
|
604
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_get: #{e}"
|
|
605
|
+
end
|
|
606
|
+
```
|
|
607
|
+
|
|
608
|
+
#### Using the v1_threads_thread_id_get_with_http_info variant
|
|
609
|
+
|
|
610
|
+
This returns an Array which contains the response data, status code and headers.
|
|
611
|
+
|
|
612
|
+
> <Array(Object, Integer, Hash)> v1_threads_thread_id_get_with_http_info(thread_id)
|
|
613
|
+
|
|
614
|
+
```ruby
|
|
615
|
+
begin
|
|
616
|
+
# Get a whole conversation
|
|
617
|
+
data, status_code, headers = api_instance.v1_threads_thread_id_get_with_http_info(thread_id)
|
|
618
|
+
p status_code # => 2xx
|
|
619
|
+
p headers # => { ... }
|
|
620
|
+
p data # => Object
|
|
621
|
+
rescue Lockally::ApiError => e
|
|
622
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_get_with_http_info: #{e}"
|
|
623
|
+
end
|
|
624
|
+
```
|
|
625
|
+
|
|
626
|
+
### Parameters
|
|
627
|
+
|
|
628
|
+
| Name | Type | Description | Notes |
|
|
629
|
+
| ---- | ---- | ----------- | ----- |
|
|
630
|
+
| **thread_id** | **String** | | |
|
|
631
|
+
|
|
632
|
+
### Return type
|
|
633
|
+
|
|
634
|
+
**Object**
|
|
635
|
+
|
|
636
|
+
### Authorization
|
|
637
|
+
|
|
638
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
639
|
+
|
|
640
|
+
### HTTP request headers
|
|
641
|
+
|
|
642
|
+
- **Content-Type**: Not defined
|
|
643
|
+
- **Accept**: application/json
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
## v1_threads_thread_id_messages_message_id_attachments_idx_get
|
|
647
|
+
|
|
648
|
+
> v1_threads_thread_id_messages_message_id_attachments_idx_get(thread_id, message_id, idx)
|
|
649
|
+
|
|
650
|
+
Download an attachment
|
|
651
|
+
|
|
652
|
+
### Examples
|
|
653
|
+
|
|
654
|
+
```ruby
|
|
655
|
+
require 'time'
|
|
656
|
+
require 'lockally'
|
|
657
|
+
# setup authorization
|
|
658
|
+
Lockally.configure do |config|
|
|
659
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
660
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
api_instance = Lockally::AgentsApi.new
|
|
664
|
+
thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
665
|
+
message_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
666
|
+
idx = 56 # Integer |
|
|
667
|
+
|
|
668
|
+
begin
|
|
669
|
+
# Download an attachment
|
|
670
|
+
api_instance.v1_threads_thread_id_messages_message_id_attachments_idx_get(thread_id, message_id, idx)
|
|
671
|
+
rescue Lockally::ApiError => e
|
|
672
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_messages_message_id_attachments_idx_get: #{e}"
|
|
673
|
+
end
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
#### Using the v1_threads_thread_id_messages_message_id_attachments_idx_get_with_http_info variant
|
|
677
|
+
|
|
678
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
679
|
+
|
|
680
|
+
> <Array(nil, Integer, Hash)> v1_threads_thread_id_messages_message_id_attachments_idx_get_with_http_info(thread_id, message_id, idx)
|
|
681
|
+
|
|
682
|
+
```ruby
|
|
683
|
+
begin
|
|
684
|
+
# Download an attachment
|
|
685
|
+
data, status_code, headers = api_instance.v1_threads_thread_id_messages_message_id_attachments_idx_get_with_http_info(thread_id, message_id, idx)
|
|
686
|
+
p status_code # => 2xx
|
|
687
|
+
p headers # => { ... }
|
|
688
|
+
p data # => nil
|
|
689
|
+
rescue Lockally::ApiError => e
|
|
690
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_messages_message_id_attachments_idx_get_with_http_info: #{e}"
|
|
691
|
+
end
|
|
692
|
+
```
|
|
693
|
+
|
|
694
|
+
### Parameters
|
|
695
|
+
|
|
696
|
+
| Name | Type | Description | Notes |
|
|
697
|
+
| ---- | ---- | ----------- | ----- |
|
|
698
|
+
| **thread_id** | **String** | | |
|
|
699
|
+
| **message_id** | **String** | | |
|
|
700
|
+
| **idx** | **Integer** | | |
|
|
701
|
+
|
|
702
|
+
### Return type
|
|
703
|
+
|
|
704
|
+
nil (empty response body)
|
|
705
|
+
|
|
706
|
+
### Authorization
|
|
707
|
+
|
|
708
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
709
|
+
|
|
710
|
+
### HTTP request headers
|
|
711
|
+
|
|
712
|
+
- **Content-Type**: Not defined
|
|
713
|
+
- **Accept**: Not defined
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
## v1_threads_thread_id_messages_message_id_get
|
|
717
|
+
|
|
718
|
+
> Object v1_threads_thread_id_messages_message_id_get(thread_id, message_id)
|
|
719
|
+
|
|
720
|
+
Get one message with body
|
|
721
|
+
|
|
722
|
+
Full text/html body fetched on demand from mail storage. Never marks the message read.
|
|
723
|
+
|
|
724
|
+
### Examples
|
|
725
|
+
|
|
726
|
+
```ruby
|
|
727
|
+
require 'time'
|
|
728
|
+
require 'lockally'
|
|
729
|
+
# setup authorization
|
|
730
|
+
Lockally.configure do |config|
|
|
731
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
732
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
733
|
+
end
|
|
734
|
+
|
|
735
|
+
api_instance = Lockally::AgentsApi.new
|
|
736
|
+
thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
737
|
+
message_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
738
|
+
|
|
739
|
+
begin
|
|
740
|
+
# Get one message with body
|
|
741
|
+
result = api_instance.v1_threads_thread_id_messages_message_id_get(thread_id, message_id)
|
|
742
|
+
p result
|
|
743
|
+
rescue Lockally::ApiError => e
|
|
744
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_messages_message_id_get: #{e}"
|
|
745
|
+
end
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
#### Using the v1_threads_thread_id_messages_message_id_get_with_http_info variant
|
|
749
|
+
|
|
750
|
+
This returns an Array which contains the response data, status code and headers.
|
|
751
|
+
|
|
752
|
+
> <Array(Object, Integer, Hash)> v1_threads_thread_id_messages_message_id_get_with_http_info(thread_id, message_id)
|
|
753
|
+
|
|
754
|
+
```ruby
|
|
755
|
+
begin
|
|
756
|
+
# Get one message with body
|
|
757
|
+
data, status_code, headers = api_instance.v1_threads_thread_id_messages_message_id_get_with_http_info(thread_id, message_id)
|
|
758
|
+
p status_code # => 2xx
|
|
759
|
+
p headers # => { ... }
|
|
760
|
+
p data # => Object
|
|
761
|
+
rescue Lockally::ApiError => e
|
|
762
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_messages_message_id_get_with_http_info: #{e}"
|
|
763
|
+
end
|
|
764
|
+
```
|
|
765
|
+
|
|
766
|
+
### Parameters
|
|
767
|
+
|
|
768
|
+
| Name | Type | Description | Notes |
|
|
769
|
+
| ---- | ---- | ----------- | ----- |
|
|
770
|
+
| **thread_id** | **String** | | |
|
|
771
|
+
| **message_id** | **String** | | |
|
|
772
|
+
|
|
773
|
+
### Return type
|
|
774
|
+
|
|
775
|
+
**Object**
|
|
776
|
+
|
|
777
|
+
### Authorization
|
|
778
|
+
|
|
779
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
780
|
+
|
|
781
|
+
### HTTP request headers
|
|
782
|
+
|
|
783
|
+
- **Content-Type**: Not defined
|
|
784
|
+
- **Accept**: application/json
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
## v1_threads_thread_id_messages_message_id_read_post
|
|
788
|
+
|
|
789
|
+
> Object v1_threads_thread_id_messages_message_id_read_post(thread_id, message_id)
|
|
790
|
+
|
|
791
|
+
Mark read/unread
|
|
792
|
+
|
|
793
|
+
The ONLY way agent access changes unread state. Body: {\"read\": true|false} (default true).
|
|
794
|
+
|
|
795
|
+
### Examples
|
|
796
|
+
|
|
797
|
+
```ruby
|
|
798
|
+
require 'time'
|
|
799
|
+
require 'lockally'
|
|
800
|
+
# setup authorization
|
|
801
|
+
Lockally.configure do |config|
|
|
802
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
803
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
804
|
+
end
|
|
805
|
+
|
|
806
|
+
api_instance = Lockally::AgentsApi.new
|
|
807
|
+
thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
808
|
+
message_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
809
|
+
|
|
810
|
+
begin
|
|
811
|
+
# Mark read/unread
|
|
812
|
+
result = api_instance.v1_threads_thread_id_messages_message_id_read_post(thread_id, message_id)
|
|
813
|
+
p result
|
|
814
|
+
rescue Lockally::ApiError => e
|
|
815
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_messages_message_id_read_post: #{e}"
|
|
816
|
+
end
|
|
817
|
+
```
|
|
818
|
+
|
|
819
|
+
#### Using the v1_threads_thread_id_messages_message_id_read_post_with_http_info variant
|
|
820
|
+
|
|
821
|
+
This returns an Array which contains the response data, status code and headers.
|
|
822
|
+
|
|
823
|
+
> <Array(Object, Integer, Hash)> v1_threads_thread_id_messages_message_id_read_post_with_http_info(thread_id, message_id)
|
|
824
|
+
|
|
825
|
+
```ruby
|
|
826
|
+
begin
|
|
827
|
+
# Mark read/unread
|
|
828
|
+
data, status_code, headers = api_instance.v1_threads_thread_id_messages_message_id_read_post_with_http_info(thread_id, message_id)
|
|
829
|
+
p status_code # => 2xx
|
|
830
|
+
p headers # => { ... }
|
|
831
|
+
p data # => Object
|
|
832
|
+
rescue Lockally::ApiError => e
|
|
833
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_messages_message_id_read_post_with_http_info: #{e}"
|
|
834
|
+
end
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
### Parameters
|
|
838
|
+
|
|
839
|
+
| Name | Type | Description | Notes |
|
|
840
|
+
| ---- | ---- | ----------- | ----- |
|
|
841
|
+
| **thread_id** | **String** | | |
|
|
842
|
+
| **message_id** | **String** | | |
|
|
843
|
+
|
|
844
|
+
### Return type
|
|
845
|
+
|
|
846
|
+
**Object**
|
|
847
|
+
|
|
848
|
+
### Authorization
|
|
849
|
+
|
|
850
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
851
|
+
|
|
852
|
+
### HTTP request headers
|
|
853
|
+
|
|
854
|
+
- **Content-Type**: Not defined
|
|
855
|
+
- **Accept**: application/json
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
## v1_threads_thread_id_reply_post
|
|
859
|
+
|
|
860
|
+
> Object v1_threads_thread_id_reply_post(thread_id, idempotency_key)
|
|
861
|
+
|
|
862
|
+
Reply in-thread (agent stream)
|
|
863
|
+
|
|
864
|
+
The server builds In-Reply-To/References and defaults recipients + subject from the conversation — a minimal call is {\"text\": \"...\"}. Guarded by the reply-loop detector (≥5 outbound/10min → 429 + agent.loop_detected). Idempotency-Key required.
|
|
865
|
+
|
|
866
|
+
### Examples
|
|
867
|
+
|
|
868
|
+
```ruby
|
|
869
|
+
require 'time'
|
|
870
|
+
require 'lockally'
|
|
871
|
+
# setup authorization
|
|
872
|
+
Lockally.configure do |config|
|
|
873
|
+
# Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
|
|
874
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
875
|
+
end
|
|
876
|
+
|
|
877
|
+
api_instance = Lockally::AgentsApi.new
|
|
878
|
+
thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
879
|
+
idempotency_key = 'idempotency_key_example' # String |
|
|
880
|
+
|
|
881
|
+
begin
|
|
882
|
+
# Reply in-thread (agent stream)
|
|
883
|
+
result = api_instance.v1_threads_thread_id_reply_post(thread_id, idempotency_key)
|
|
884
|
+
p result
|
|
885
|
+
rescue Lockally::ApiError => e
|
|
886
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_reply_post: #{e}"
|
|
887
|
+
end
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
#### Using the v1_threads_thread_id_reply_post_with_http_info variant
|
|
891
|
+
|
|
892
|
+
This returns an Array which contains the response data, status code and headers.
|
|
893
|
+
|
|
894
|
+
> <Array(Object, Integer, Hash)> v1_threads_thread_id_reply_post_with_http_info(thread_id, idempotency_key)
|
|
895
|
+
|
|
896
|
+
```ruby
|
|
897
|
+
begin
|
|
898
|
+
# Reply in-thread (agent stream)
|
|
899
|
+
data, status_code, headers = api_instance.v1_threads_thread_id_reply_post_with_http_info(thread_id, idempotency_key)
|
|
900
|
+
p status_code # => 2xx
|
|
901
|
+
p headers # => { ... }
|
|
902
|
+
p data # => Object
|
|
903
|
+
rescue Lockally::ApiError => e
|
|
904
|
+
puts "Error when calling AgentsApi->v1_threads_thread_id_reply_post_with_http_info: #{e}"
|
|
905
|
+
end
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
### Parameters
|
|
909
|
+
|
|
910
|
+
| Name | Type | Description | Notes |
|
|
911
|
+
| ---- | ---- | ----------- | ----- |
|
|
912
|
+
| **thread_id** | **String** | | |
|
|
913
|
+
| **idempotency_key** | **String** | | |
|
|
914
|
+
|
|
915
|
+
### Return type
|
|
916
|
+
|
|
917
|
+
**Object**
|
|
918
|
+
|
|
919
|
+
### Authorization
|
|
920
|
+
|
|
921
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
922
|
+
|
|
923
|
+
### HTTP request headers
|
|
924
|
+
|
|
925
|
+
- **Content-Type**: Not defined
|
|
926
|
+
- **Accept**: application/json
|
|
927
|
+
|