lockally 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (571) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +166 -117
  3. data/docs/AdminApi.md +33 -33
  4. data/docs/{V1AdminLoginPost200Response.md → AdminLogin200Response.md} +2 -2
  5. data/docs/{V1AdminLoginPostRequest.md → AdminLoginRequest.md} +2 -2
  6. data/docs/AdminsApi.md +76 -76
  7. data/docs/AgentSendResult.md +22 -0
  8. data/docs/AgentsApi.md +247 -247
  9. data/docs/AiApi.md +69 -69
  10. data/docs/AiConfig.md +26 -0
  11. data/docs/AiConfigUpdate.md +20 -0
  12. data/docs/AliasesApi.md +59 -59
  13. data/docs/ApiKeysApi.md +59 -59
  14. data/docs/BatchResult.md +1 -1
  15. data/docs/Calendar.md +8 -0
  16. data/docs/CalendarsApi.md +73 -0
  17. data/docs/ContactLookup.md +26 -0
  18. data/docs/ContactLookupContact.md +28 -0
  19. data/docs/ContactLookupHistory.md +22 -0
  20. data/docs/CreateAiUnitsCheckout200Response.md +22 -0
  21. data/docs/{V1AliasesPostRequest.md → CreateAliasRequest.md} +2 -2
  22. data/docs/{V1ApiKeysPost201Response.md → CreateApiKey201Response.md} +2 -2
  23. data/docs/CreateApiKeyRequest.md +22 -0
  24. data/docs/{V1DomainsPostRequest.md → CreateDomainRequest.md} +2 -2
  25. data/docs/{V1MailboxesPostRequest.md → CreateMailboxRequest.md} +2 -2
  26. data/docs/{V1SuppressionsPostRequest.md → CreateSuppressionRequest.md} +2 -2
  27. data/docs/{V1WebhooksPostRequest.md → CreateWebhookRequest.md} +2 -2
  28. data/docs/DomainsApi.md +339 -60
  29. data/docs/Draft.md +44 -0
  30. data/docs/DraftList.md +18 -0
  31. data/docs/DraftResult.md +26 -0
  32. data/docs/DraftsApi.md +115 -115
  33. data/docs/{V1MailboxesEmailExportPost201Response.md → ExportMailbox201Response.md} +2 -2
  34. data/docs/GetCalendarOverview200Response.md +34 -0
  35. data/docs/GetCalendarOverview200ResponseActivityInner.md +24 -0
  36. data/docs/{V1AdminMeGet200Response.md → GetCurrentAdmin200Response.md} +2 -2
  37. data/docs/{V1UsageGet200Response.md → GetUsage200Response.md} +2 -2
  38. data/docs/GetUserInsights200Response.md +2 -0
  39. data/docs/HealthApi.md +11 -11
  40. data/docs/{HealthzGet200Response.md → HealthCheck200Response.md} +2 -2
  41. data/docs/Inbox.md +24 -0
  42. data/docs/InboxList.md +18 -0
  43. data/docs/{V1AdminsPostRequest.md → InviteAdminRequest.md} +2 -2
  44. data/docs/{V1AdminsGet200Response.md → ListAdmins200Response.md} +2 -2
  45. data/docs/{V1AliasesGet200Response.md → ListAliases200Response.md} +2 -2
  46. data/docs/{V1ApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
  47. data/docs/{V1DomainsGet200Response.md → ListDomains200Response.md} +2 -2
  48. data/docs/{V1MailboxesGet200Response.md → ListMailboxes200Response.md} +2 -2
  49. data/docs/{V1MessagesGet200Response.md → ListMessages200Response.md} +2 -2
  50. data/docs/{V1SuppressionsGet200Response.md → ListSuppressions200Response.md} +2 -2
  51. data/docs/{V1TemplatesGet200Response.md → ListTemplates200Response.md} +2 -2
  52. data/docs/{V1VacationGet200Response.md → ListVacationResponders200Response.md} +2 -2
  53. data/docs/{V1WebhooksGet200Response.md → ListWebhooks200Response.md} +2 -2
  54. data/docs/MailboxGrant.md +20 -0
  55. data/docs/MailboxGrantList.md +18 -0
  56. data/docs/MailboxesApi.md +204 -204
  57. data/docs/MarkReadResult.md +18 -0
  58. data/docs/MessageDetail.md +52 -0
  59. data/docs/ReturnPath.md +28 -0
  60. data/docs/ReturnPathCheck.md +20 -0
  61. data/docs/SendApi.md +121 -121
  62. data/docs/SendEmail200Response.md +24 -0
  63. data/docs/{V1SendPost202Response.md → SendEmail202Response.md} +2 -2
  64. data/docs/{V1SendBatchPost200Response.md → SendEmailBatch200Response.md} +2 -2
  65. data/docs/{V1SendBatchPostRequest.md → SendEmailBatchRequest.md} +2 -2
  66. data/docs/{V1SendPostRequest.md → SendEmailRequest.md} +7 -3
  67. data/docs/{V1SendPostRequestAttachmentsInner.md → SendEmailRequestAttachmentsInner.md} +2 -2
  68. data/docs/SendMessage.md +5 -1
  69. data/docs/{V1MailboxesEmailVacationPutRequest.md → SetVacationResponderRequest.md} +2 -2
  70. data/docs/SignupApi.md +4 -4
  71. data/docs/SimulatedInbound.md +22 -0
  72. data/docs/{V1InboxesMailboxMessagesPostRequest.md → StartConversationRequest.md} +2 -2
  73. data/docs/SuppressionsApi.md +75 -75
  74. data/docs/TemplatesApi.md +67 -67
  75. data/docs/TenantApi.md +20 -20
  76. data/docs/TestApi.md +11 -11
  77. data/docs/Thread.md +22 -0
  78. data/docs/ThreadClassification.md +22 -0
  79. data/docs/ThreadList.md +20 -0
  80. data/docs/ThreadMessage.md +40 -0
  81. data/docs/ThreadMessageBody.md +42 -0
  82. data/docs/ThreadMessageBodyAllOfBody.md +22 -0
  83. data/docs/ThreadSummary.md +28 -0
  84. data/docs/{V1AdminsIdPatchRequest.md → UpdateAdminRequest.md} +2 -2
  85. data/docs/{V1MailboxesEmailPatchRequest.md → UpdateMailboxRequest.md} +2 -2
  86. data/docs/{V1WebhooksIdPatchRequest.md → UpdateWebhookRequest.md} +2 -2
  87. data/docs/WebhooksApi.md +63 -63
  88. data/docs/Whoami.md +24 -0
  89. data/lib/lockally/api/add_ons_api.rb +1 -1
  90. data/lib/lockally/api/admin_api.rb +31 -31
  91. data/lib/lockally/api/admins_api.rb +90 -90
  92. data/lib/lockally/api/agents_api.rb +310 -310
  93. data/lib/lockally/api/ai_api.rb +70 -70
  94. data/lib/lockally/api/aliases_api.rb +65 -65
  95. data/lib/lockally/api/api_keys_api.rb +67 -67
  96. data/lib/lockally/api/billing_api.rb +1 -1
  97. data/lib/lockally/api/calendars_api.rb +64 -1
  98. data/lib/lockally/api/contact_lists_api.rb +1 -1
  99. data/lib/lockally/api/contacts_api.rb +1 -1
  100. data/lib/lockally/api/dashboard_api.rb +1 -1
  101. data/lib/lockally/api/directory_api.rb +1 -1
  102. data/lib/lockally/api/distribution_lists_api.rb +1 -1
  103. data/lib/lockally/api/domains_api.rb +314 -62
  104. data/lib/lockally/api/drafts_api.rb +141 -141
  105. data/lib/lockally/api/encryption_api.rb +1 -1
  106. data/lib/lockally/api/health_api.rb +10 -10
  107. data/lib/lockally/api/ip_pools_api.rb +1 -1
  108. data/lib/lockally/api/mailboxes_api.rb +236 -236
  109. data/lib/lockally/api/migrations_api.rb +1 -1
  110. data/lib/lockally/api/resources_api.rb +1 -1
  111. data/lib/lockally/api/send_api.rb +147 -147
  112. data/lib/lockally/api/signup_api.rb +4 -4
  113. data/lib/lockally/api/suppressions_api.rb +88 -88
  114. data/lib/lockally/api/templates_api.rb +70 -70
  115. data/lib/lockally/api/tenant_api.rb +16 -16
  116. data/lib/lockally/api/test_api.rb +10 -10
  117. data/lib/lockally/api/users_api.rb +1 -1
  118. data/lib/lockally/api/webhooks_api.rb +74 -74
  119. data/lib/lockally/api_client.rb +1 -1
  120. data/lib/lockally/api_error.rb +1 -1
  121. data/lib/lockally/api_model_base.rb +1 -1
  122. data/lib/lockally/configuration.rb +1 -1
  123. data/lib/lockally/models/activate_add_on200_response.rb +1 -1
  124. data/lib/lockally/models/add_calendar_member_request.rb +1 -1
  125. data/lib/lockally/models/add_contact_list_member_request.rb +1 -1
  126. data/lib/lockally/models/add_on.rb +1 -1
  127. data/lib/lockally/models/add_shared_member_request.rb +1 -1
  128. data/lib/lockally/models/admin.rb +1 -1
  129. data/lib/lockally/models/admin_full.rb +1 -1
  130. data/lib/lockally/models/{v1_admin_login_post200_response.rb → admin_login200_response.rb} +4 -4
  131. data/lib/lockally/models/{v1_admin_login_post_request.rb → admin_login_request.rb} +4 -4
  132. data/lib/lockally/models/agent_send_result.rb +184 -0
  133. data/lib/lockally/models/ai_config.rb +242 -0
  134. data/lib/lockally/models/ai_config_update.rb +214 -0
  135. data/lib/lockally/models/api_key.rb +1 -1
  136. data/lib/lockally/models/audit_event.rb +1 -1
  137. data/lib/lockally/models/batch_lookup_public_keys200_response.rb +1 -1
  138. data/lib/lockally/models/batch_lookup_public_keys200_response_data_inner.rb +1 -1
  139. data/lib/lockally/models/batch_result.rb +4 -3
  140. data/lib/lockally/models/billing_status.rb +1 -1
  141. data/lib/lockally/models/calendar.rb +68 -4
  142. data/lib/lockally/models/calendar_event.rb +1 -1
  143. data/lib/lockally/models/calendar_integration.rb +1 -1
  144. data/lib/lockally/models/calendar_member.rb +1 -1
  145. data/lib/lockally/models/calendar_policies.rb +1 -1
  146. data/lib/lockally/models/contact.rb +1 -1
  147. data/lib/lockally/models/contact_list.rb +1 -1
  148. data/lib/lockally/models/contact_lookup.rb +235 -0
  149. data/lib/lockally/models/contact_lookup_contact.rb +192 -0
  150. data/lib/lockally/models/contact_lookup_history.rb +166 -0
  151. data/lib/lockally/models/create_ai_units_checkout200_response.rb +199 -0
  152. data/lib/lockally/models/{v1_aliases_post_request.rb → create_alias_request.rb} +4 -4
  153. data/lib/lockally/models/{v1_api_keys_post201_response.rb → create_api_key201_response.rb} +4 -4
  154. data/lib/lockally/models/{v1_api_keys_post_request.rb → create_api_key_request.rb} +20 -8
  155. data/lib/lockally/models/create_billing_checkout200_response.rb +1 -1
  156. data/lib/lockally/models/create_billing_checkout_request.rb +1 -1
  157. data/lib/lockally/models/create_calendar_event_request.rb +1 -1
  158. data/lib/lockally/models/create_calendar_integration_request.rb +1 -1
  159. data/lib/lockally/models/create_calendar_request.rb +1 -1
  160. data/lib/lockally/models/create_contact_list_request.rb +1 -1
  161. data/lib/lockally/models/create_contact_request.rb +1 -1
  162. data/lib/lockally/models/create_dedicated_ip_request_request.rb +1 -1
  163. data/lib/lockally/models/create_distribution_list_request.rb +1 -1
  164. data/lib/lockally/models/{v1_domains_post_request.rb → create_domain_request.rb} +4 -4
  165. data/lib/lockally/models/create_encryption_key201_response.rb +1 -1
  166. data/lib/lockally/models/create_encryption_key_request.rb +1 -1
  167. data/lib/lockally/models/create_encryption_recovery_request.rb +1 -1
  168. data/lib/lockally/models/{v1_mailboxes_post_request.rb → create_mailbox_request.rb} +4 -4
  169. data/lib/lockally/models/create_migration_credential_request.rb +1 -1
  170. data/lib/lockally/models/create_migration_credential_request_credentials.rb +1 -1
  171. data/lib/lockally/models/create_migration_request.rb +1 -1
  172. data/lib/lockally/models/create_resource_request.rb +1 -1
  173. data/lib/lockally/models/{v1_suppressions_post_request.rb → create_suppression_request.rb} +4 -4
  174. data/lib/lockally/models/create_units_checkout200_response.rb +1 -1
  175. data/lib/lockally/models/create_units_checkout_request.rb +1 -1
  176. data/lib/lockally/models/create_user_request.rb +1 -1
  177. data/lib/lockally/models/{v1_webhooks_post_request.rb → create_webhook_request.rb} +4 -4
  178. data/lib/lockally/models/dedicated_ip_request.rb +1 -1
  179. data/lib/lockally/models/directory_permissions.rb +1 -1
  180. data/lib/lockally/models/discover_migration202_response.rb +1 -1
  181. data/lib/lockally/models/distribution_list_detail.rb +1 -1
  182. data/lib/lockally/models/distribution_list_summary.rb +1 -1
  183. data/lib/lockally/models/dns_record.rb +1 -1
  184. data/lib/lockally/models/domain.rb +1 -1
  185. data/lib/lockally/models/draft.rb +413 -0
  186. data/lib/lockally/models/draft_list.rb +166 -0
  187. data/lib/lockally/models/draft_result.rb +260 -0
  188. data/lib/lockally/models/{v1_mailboxes_email_export_post201_response.rb → export_mailbox201_response.rb} +4 -4
  189. data/lib/lockally/models/gal_settings.rb +1 -1
  190. data/lib/lockally/models/get_add_on_status200_response.rb +1 -1
  191. data/lib/lockally/models/get_audit_summary200_response.rb +1 -1
  192. data/lib/lockally/models/get_calendar_overview200_response.rb +228 -0
  193. data/lib/lockally/models/get_calendar_overview200_response_activity_inner.rb +174 -0
  194. data/lib/lockally/models/get_calendar_security200_response.rb +1 -1
  195. data/lib/lockally/models/get_calendar_security200_response_alerts_inner.rb +1 -1
  196. data/lib/lockally/models/get_calendar_security200_response_delegated_access_inner.rb +1 -1
  197. data/lib/lockally/models/get_calendar_security200_response_external_sharing.rb +1 -1
  198. data/lib/lockally/models/get_calendar_security200_response_public_calendar_list_inner.rb +1 -1
  199. data/lib/lockally/models/get_contact_list200_response.rb +1 -1
  200. data/lib/lockally/models/get_contact_list200_response_members_inner.rb +1 -1
  201. data/lib/lockally/models/get_contact_lists200_response.rb +1 -1
  202. data/lib/lockally/models/get_contact_lists200_response_data_inner.rb +1 -1
  203. data/lib/lockally/models/{v1_admin_me_get200_response.rb → get_current_admin200_response.rb} +4 -4
  204. data/lib/lockally/models/get_directory_activity200_response.rb +1 -1
  205. data/lib/lockally/models/get_directory_activity200_response_data_inner.rb +1 -1
  206. data/lib/lockally/models/get_directory_stats200_response.rb +1 -1
  207. data/lib/lockally/models/get_domains_status200_response.rb +1 -1
  208. data/lib/lockally/models/get_domains_status200_response_domains_inner.rb +1 -1
  209. data/lib/lockally/models/get_domains_status200_response_domains_inner_checks_inner.rb +1 -1
  210. data/lib/lockally/models/get_encryption_key200_response.rb +1 -1
  211. data/lib/lockally/models/get_integrations_summary200_response.rb +1 -1
  212. data/lib/lockally/models/get_integrations_summary200_response_api_keys_inner.rb +1 -1
  213. data/lib/lockally/models/get_integrations_summary200_response_webhooks_inner.rb +1 -1
  214. data/lib/lockally/models/get_ip_assignment200_response.rb +1 -1
  215. data/lib/lockally/models/get_security200_response.rb +1 -1
  216. data/lib/lockally/models/get_security200_response_alerts_inner.rb +1 -1
  217. data/lib/lockally/models/get_security200_response_stats_inner.rb +1 -1
  218. data/lib/lockally/models/get_storage200_response.rb +1 -1
  219. data/lib/lockally/models/get_storage200_response_top_mailboxes_inner.rb +1 -1
  220. data/lib/lockally/models/get_storage200_response_top_messages_inner.rb +1 -1
  221. data/lib/lockally/models/{v1_usage_get200_response.rb → get_usage200_response.rb} +4 -4
  222. data/lib/lockally/models/get_user_insights200_response.rb +12 -2
  223. data/lib/lockally/models/{healthz_get200_response.rb → health_check200_response.rb} +4 -4
  224. data/lib/lockally/models/inbox.rb +225 -0
  225. data/lib/lockally/models/inbox_list.rb +166 -0
  226. data/lib/lockally/models/{v1_admins_post_request.rb → invite_admin_request.rb} +4 -4
  227. data/lib/lockally/models/list_add_ons200_response.rb +1 -1
  228. data/lib/lockally/models/{v1_api_keys_get200_response.rb → list_admins200_response.rb} +5 -5
  229. data/lib/lockally/models/list_aliases200_response.rb +166 -0
  230. data/lib/lockally/models/{v1_admins_get200_response.rb → list_api_keys200_response.rb} +5 -5
  231. data/lib/lockally/models/list_calendar_events200_response.rb +1 -1
  232. data/lib/lockally/models/list_calendar_integrations200_response.rb +1 -1
  233. data/lib/lockally/models/list_calendar_members200_response.rb +1 -1
  234. data/lib/lockally/models/list_calendars200_response.rb +1 -1
  235. data/lib/lockally/models/list_contact_lists200_response.rb +1 -1
  236. data/lib/lockally/models/list_contacts200_response.rb +1 -1
  237. data/lib/lockally/models/list_dedicated_ip_requests200_response.rb +1 -1
  238. data/lib/lockally/models/list_distribution_lists200_response.rb +1 -1
  239. data/lib/lockally/models/{v1_domains_get200_response.rb → list_domains200_response.rb} +4 -4
  240. data/lib/lockally/models/{v1_mailboxes_get200_response.rb → list_mailboxes200_response.rb} +4 -4
  241. data/lib/lockally/models/{v1_messages_get200_response.rb → list_messages200_response.rb} +4 -4
  242. data/lib/lockally/models/list_migration_credentials200_response.rb +1 -1
  243. data/lib/lockally/models/list_migration_events200_response.rb +1 -1
  244. data/lib/lockally/models/list_migration_mailboxes200_response.rb +1 -1
  245. data/lib/lockally/models/list_migrations200_response.rb +1 -1
  246. data/lib/lockally/models/list_resources200_response.rb +1 -1
  247. data/lib/lockally/models/list_shared_members200_response.rb +1 -1
  248. data/lib/lockally/models/{v1_suppressions_get200_response.rb → list_suppressions200_response.rb} +4 -4
  249. data/lib/lockally/models/{v1_send_batch_post200_response.rb → list_templates200_response.rb} +5 -5
  250. data/lib/lockally/models/list_users200_response.rb +1 -1
  251. data/lib/lockally/models/{v1_vacation_get200_response.rb → list_vacation_responders200_response.rb} +4 -4
  252. data/lib/lockally/models/{v1_aliases_get200_response.rb → list_webhooks200_response.rb} +5 -5
  253. data/lib/lockally/models/mailbox.rb +1 -1
  254. data/lib/lockally/models/mailbox_grant.rb +156 -0
  255. data/lib/lockally/models/mailbox_grant_list.rb +166 -0
  256. data/lib/lockally/models/map_migration_request.rb +1 -1
  257. data/lib/lockally/models/map_migration_request_mappings_inner.rb +1 -1
  258. data/lib/lockally/models/mark_read_result.rb +147 -0
  259. data/lib/lockally/models/message.rb +1 -1
  260. data/lib/lockally/models/message_detail.rb +479 -0
  261. data/lib/lockally/models/message_stats.rb +1 -1
  262. data/lib/lockally/models/message_stats_counts.rb +1 -1
  263. data/lib/lockally/models/message_stats_rates.rb +1 -1
  264. data/lib/lockally/models/message_stats_window.rb +1 -1
  265. data/lib/lockally/models/migration.rb +1 -1
  266. data/lib/lockally/models/migration_credential.rb +1 -1
  267. data/lib/lockally/models/migration_event.rb +1 -1
  268. data/lib/lockally/models/migration_mailbox.rb +1 -1
  269. data/lib/lockally/models/migration_progress.rb +1 -1
  270. data/lib/lockally/models/migration_progress_mailboxes_inner.rb +1 -1
  271. data/lib/lockally/models/migration_settings.rb +1 -1
  272. data/lib/lockally/models/model_alias.rb +1 -1
  273. data/lib/lockally/models/plan_catalog_entry.rb +1 -1
  274. data/lib/lockally/models/problem.rb +1 -1
  275. data/lib/lockally/models/replace_distribution_list_members200_response.rb +1 -1
  276. data/lib/lockally/models/replace_distribution_list_members_request.rb +1 -1
  277. data/lib/lockally/models/resource.rb +1 -1
  278. data/lib/lockally/models/return_path.rb +269 -0
  279. data/lib/lockally/models/return_path_check.rb +157 -0
  280. data/lib/lockally/models/rotate_encryption_key_request.rb +1 -1
  281. data/lib/lockally/models/send_email200_response.rb +218 -0
  282. data/lib/lockally/models/{v1_send_post202_response.rb → send_email202_response.rb} +4 -4
  283. data/lib/lockally/models/{v1_templates_get200_response.rb → send_email_batch200_response.rb} +5 -5
  284. data/lib/lockally/models/{v1_send_batch_post_request.rb → send_email_batch_request.rb} +4 -4
  285. data/lib/lockally/models/{v1_send_post_request.rb → send_email_request.rb} +26 -6
  286. data/lib/lockally/models/{v1_send_post_request_attachments_inner.rb → send_email_request_attachments_inner.rb} +4 -4
  287. data/lib/lockally/models/send_message.rb +23 -3
  288. data/lib/lockally/models/{v1_mailboxes_email_vacation_put_request.rb → set_vacation_responder_request.rb} +4 -4
  289. data/lib/lockally/models/shared_member.rb +1 -1
  290. data/lib/lockally/models/signup_request.rb +1 -1
  291. data/lib/lockally/models/simulated_inbound.rb +167 -0
  292. data/lib/lockally/models/{v1_inboxes_mailbox_messages_post_request.rb → start_conversation_request.rb} +4 -4
  293. data/lib/lockally/models/start_migration202_response.rb +1 -1
  294. data/lib/lockally/models/suppression.rb +1 -1
  295. data/lib/lockally/models/template.rb +1 -1
  296. data/lib/lockally/models/template_input.rb +1 -1
  297. data/lib/lockally/models/tenant.rb +1 -1
  298. data/lib/lockally/models/thread.rb +219 -0
  299. data/lib/lockally/models/thread_classification.rb +186 -0
  300. data/lib/lockally/models/thread_list.rb +192 -0
  301. data/lib/lockally/models/thread_message.rb +397 -0
  302. data/lib/lockally/models/thread_message_body.rb +413 -0
  303. data/lib/lockally/models/thread_message_body_all_of_body.rb +165 -0
  304. data/lib/lockally/models/thread_summary.rb +280 -0
  305. data/lib/lockally/models/unit_bundle.rb +1 -1
  306. data/lib/lockally/models/{v1_admins_id_patch_request.rb → update_admin_request.rb} +4 -4
  307. data/lib/lockally/models/update_calendar_event_request.rb +1 -1
  308. data/lib/lockally/models/update_calendar_integration_request.rb +1 -1
  309. data/lib/lockally/models/update_calendar_member_request.rb +1 -1
  310. data/lib/lockally/models/update_calendar_policies_request.rb +1 -1
  311. data/lib/lockally/models/update_calendar_request.rb +1 -1
  312. data/lib/lockally/models/update_contact_list_request.rb +1 -1
  313. data/lib/lockally/models/update_contact_request.rb +1 -1
  314. data/lib/lockally/models/update_directory_permissions_request.rb +1 -1
  315. data/lib/lockally/models/update_gal_settings_request.rb +1 -1
  316. data/lib/lockally/models/{v1_mailboxes_email_patch_request.rb → update_mailbox_request.rb} +4 -4
  317. data/lib/lockally/models/update_migration_mailbox_request.rb +1 -1
  318. data/lib/lockally/models/update_migration_request.rb +1 -1
  319. data/lib/lockally/models/update_resource_request.rb +1 -1
  320. data/lib/lockally/models/update_user_request.rb +1 -1
  321. data/lib/lockally/models/{v1_webhooks_id_patch_request.rb → update_webhook_request.rb} +4 -4
  322. data/lib/lockally/models/user.rb +1 -1
  323. data/lib/lockally/models/user_event.rb +1 -1
  324. data/lib/lockally/models/vacation_params.rb +1 -1
  325. data/lib/lockally/models/vacation_responder.rb +1 -1
  326. data/lib/lockally/models/webhook.rb +1 -1
  327. data/lib/lockally/models/whoami.rb +177 -0
  328. data/lib/lockally/version.rb +2 -2
  329. data/lib/lockally.rb +65 -35
  330. data/lockally.gemspec +2 -2
  331. data/spec/api/add_ons_api_spec.rb +1 -1
  332. data/spec/api/admin_api_spec.rb +10 -10
  333. data/spec/api/admins_api_spec.rb +23 -23
  334. data/spec/api/agents_api_spec.rb +79 -79
  335. data/spec/api/ai_api_spec.rb +23 -23
  336. data/spec/api/aliases_api_spec.rb +17 -17
  337. data/spec/api/api_keys_api_spec.rb +18 -18
  338. data/spec/api/billing_api_spec.rb +1 -1
  339. data/spec/api/calendars_api_spec.rb +15 -1
  340. data/spec/api/contact_lists_api_spec.rb +1 -1
  341. data/spec/api/contacts_api_spec.rb +1 -1
  342. data/spec/api/dashboard_api_spec.rb +1 -1
  343. data/spec/api/directory_api_spec.rb +1 -1
  344. data/spec/api/distribution_lists_api_spec.rb +1 -1
  345. data/spec/api/domains_api_spec.rb +66 -18
  346. data/spec/api/drafts_api_spec.rb +39 -39
  347. data/spec/api/encryption_api_spec.rb +1 -1
  348. data/spec/api/health_api_spec.rb +4 -4
  349. data/spec/api/ip_pools_api_spec.rb +1 -1
  350. data/spec/api/mailboxes_api_spec.rb +63 -63
  351. data/spec/api/migrations_api_spec.rb +1 -1
  352. data/spec/api/resources_api_spec.rb +1 -1
  353. data/spec/api/send_api_spec.rb +37 -37
  354. data/spec/api/signup_api_spec.rb +2 -2
  355. data/spec/api/suppressions_api_spec.rb +19 -19
  356. data/spec/api/templates_api_spec.rb +18 -18
  357. data/spec/api/tenant_api_spec.rb +6 -6
  358. data/spec/api/test_api_spec.rb +4 -4
  359. data/spec/api/users_api_spec.rb +1 -1
  360. data/spec/api/webhooks_api_spec.rb +20 -20
  361. data/spec/models/activate_add_on200_response_spec.rb +1 -1
  362. data/spec/models/add_calendar_member_request_spec.rb +1 -1
  363. data/spec/models/add_contact_list_member_request_spec.rb +1 -1
  364. data/spec/models/add_on_spec.rb +1 -1
  365. data/spec/models/add_shared_member_request_spec.rb +1 -1
  366. data/spec/models/admin_full_spec.rb +1 -1
  367. data/spec/models/{v1_admin_login_post200_response_spec.rb → admin_login200_response_spec.rb} +7 -7
  368. data/spec/models/{v1_admin_login_post_request_spec.rb → admin_login_request_spec.rb} +7 -7
  369. data/spec/models/admin_spec.rb +1 -1
  370. data/spec/models/agent_send_result_spec.rb +48 -0
  371. data/spec/models/ai_config_spec.rb +64 -0
  372. data/spec/models/{v1_api_keys_post_request_spec.rb → ai_config_update_spec.rb} +13 -13
  373. data/spec/models/api_key_spec.rb +1 -1
  374. data/spec/models/audit_event_spec.rb +1 -1
  375. data/spec/models/batch_lookup_public_keys200_response_data_inner_spec.rb +1 -1
  376. data/spec/models/batch_lookup_public_keys200_response_spec.rb +1 -1
  377. data/spec/models/batch_result_spec.rb +2 -2
  378. data/spec/models/billing_status_spec.rb +1 -1
  379. data/spec/models/calendar_event_spec.rb +1 -1
  380. data/spec/models/calendar_integration_spec.rb +1 -1
  381. data/spec/models/calendar_member_spec.rb +1 -1
  382. data/spec/models/calendar_policies_spec.rb +1 -1
  383. data/spec/models/calendar_spec.rb +34 -2
  384. data/spec/models/contact_list_spec.rb +1 -1
  385. data/spec/models/contact_lookup_contact_spec.rb +66 -0
  386. data/spec/models/contact_lookup_history_spec.rb +48 -0
  387. data/spec/models/contact_lookup_spec.rb +60 -0
  388. data/spec/models/contact_spec.rb +1 -1
  389. data/spec/models/create_ai_units_checkout200_response_spec.rb +48 -0
  390. data/spec/models/{v1_aliases_post_request_spec.rb → create_alias_request_spec.rb} +7 -7
  391. data/spec/models/{v1_api_keys_post201_response_spec.rb → create_api_key201_response_spec.rb} +7 -7
  392. data/spec/models/create_api_key_request_spec.rb +52 -0
  393. data/spec/models/create_billing_checkout200_response_spec.rb +1 -1
  394. data/spec/models/create_billing_checkout_request_spec.rb +1 -1
  395. data/spec/models/create_calendar_event_request_spec.rb +1 -1
  396. data/spec/models/create_calendar_integration_request_spec.rb +1 -1
  397. data/spec/models/create_calendar_request_spec.rb +1 -1
  398. data/spec/models/create_contact_list_request_spec.rb +1 -1
  399. data/spec/models/create_contact_request_spec.rb +1 -1
  400. data/spec/models/create_dedicated_ip_request_request_spec.rb +1 -1
  401. data/spec/models/create_distribution_list_request_spec.rb +1 -1
  402. data/spec/models/{v1_domains_post_request_spec.rb → create_domain_request_spec.rb} +7 -7
  403. data/spec/models/create_encryption_key201_response_spec.rb +1 -1
  404. data/spec/models/create_encryption_key_request_spec.rb +1 -1
  405. data/spec/models/create_encryption_recovery_request_spec.rb +1 -1
  406. data/spec/models/{v1_mailboxes_post_request_spec.rb → create_mailbox_request_spec.rb} +7 -7
  407. data/spec/models/create_migration_credential_request_credentials_spec.rb +1 -1
  408. data/spec/models/create_migration_credential_request_spec.rb +1 -1
  409. data/spec/models/create_migration_request_spec.rb +1 -1
  410. data/spec/models/create_resource_request_spec.rb +1 -1
  411. data/spec/models/{v1_suppressions_post_request_spec.rb → create_suppression_request_spec.rb} +7 -7
  412. data/spec/models/create_units_checkout200_response_spec.rb +1 -1
  413. data/spec/models/create_units_checkout_request_spec.rb +1 -1
  414. data/spec/models/create_user_request_spec.rb +1 -1
  415. data/spec/models/{v1_webhooks_post_request_spec.rb → create_webhook_request_spec.rb} +7 -7
  416. data/spec/models/dedicated_ip_request_spec.rb +1 -1
  417. data/spec/models/directory_permissions_spec.rb +1 -1
  418. data/spec/models/discover_migration202_response_spec.rb +1 -1
  419. data/spec/models/distribution_list_detail_spec.rb +1 -1
  420. data/spec/models/distribution_list_summary_spec.rb +1 -1
  421. data/spec/models/dns_record_spec.rb +1 -1
  422. data/spec/models/domain_spec.rb +1 -1
  423. data/spec/models/{v1_aliases_get200_response_spec.rb → draft_list_spec.rb} +8 -8
  424. data/spec/models/draft_result_spec.rb +64 -0
  425. data/spec/models/draft_spec.rb +118 -0
  426. data/spec/models/{v1_mailboxes_email_export_post201_response_spec.rb → export_mailbox201_response_spec.rb} +7 -7
  427. data/spec/models/gal_settings_spec.rb +1 -1
  428. data/spec/models/get_add_on_status200_response_spec.rb +1 -1
  429. data/spec/models/get_audit_summary200_response_spec.rb +1 -1
  430. data/spec/models/get_calendar_overview200_response_activity_inner_spec.rb +54 -0
  431. data/spec/models/get_calendar_overview200_response_spec.rb +84 -0
  432. data/spec/models/get_calendar_security200_response_alerts_inner_spec.rb +1 -1
  433. data/spec/models/get_calendar_security200_response_delegated_access_inner_spec.rb +1 -1
  434. data/spec/models/get_calendar_security200_response_external_sharing_spec.rb +1 -1
  435. data/spec/models/get_calendar_security200_response_public_calendar_list_inner_spec.rb +1 -1
  436. data/spec/models/get_calendar_security200_response_spec.rb +1 -1
  437. data/spec/models/get_contact_list200_response_members_inner_spec.rb +1 -1
  438. data/spec/models/get_contact_list200_response_spec.rb +1 -1
  439. data/spec/models/get_contact_lists200_response_data_inner_spec.rb +1 -1
  440. data/spec/models/get_contact_lists200_response_spec.rb +1 -1
  441. data/spec/models/{v1_admin_me_get200_response_spec.rb → get_current_admin200_response_spec.rb} +7 -7
  442. data/spec/models/get_directory_activity200_response_data_inner_spec.rb +1 -1
  443. data/spec/models/get_directory_activity200_response_spec.rb +1 -1
  444. data/spec/models/get_directory_stats200_response_spec.rb +1 -1
  445. data/spec/models/get_domains_status200_response_domains_inner_checks_inner_spec.rb +1 -1
  446. data/spec/models/get_domains_status200_response_domains_inner_spec.rb +1 -1
  447. data/spec/models/get_domains_status200_response_spec.rb +1 -1
  448. data/spec/models/get_encryption_key200_response_spec.rb +1 -1
  449. data/spec/models/get_integrations_summary200_response_api_keys_inner_spec.rb +1 -1
  450. data/spec/models/get_integrations_summary200_response_spec.rb +1 -1
  451. data/spec/models/get_integrations_summary200_response_webhooks_inner_spec.rb +1 -1
  452. data/spec/models/get_ip_assignment200_response_spec.rb +1 -1
  453. data/spec/models/get_security200_response_alerts_inner_spec.rb +1 -1
  454. data/spec/models/get_security200_response_spec.rb +1 -1
  455. data/spec/models/get_security200_response_stats_inner_spec.rb +1 -1
  456. data/spec/models/get_storage200_response_spec.rb +1 -1
  457. data/spec/models/get_storage200_response_top_mailboxes_inner_spec.rb +1 -1
  458. data/spec/models/get_storage200_response_top_messages_inner_spec.rb +1 -1
  459. data/spec/models/{v1_usage_get200_response_spec.rb → get_usage200_response_spec.rb} +7 -7
  460. data/spec/models/get_user_insights200_response_spec.rb +7 -1
  461. data/spec/models/{healthz_get200_response_spec.rb → health_check200_response_spec.rb} +7 -7
  462. data/spec/models/inbox_list_spec.rb +36 -0
  463. data/spec/models/inbox_spec.rb +54 -0
  464. data/spec/models/{v1_admins_post_request_spec.rb → invite_admin_request_spec.rb} +7 -7
  465. data/spec/models/list_add_ons200_response_spec.rb +1 -1
  466. data/spec/models/list_admins200_response_spec.rb +36 -0
  467. data/spec/models/{v1_admins_get200_response_spec.rb → list_aliases200_response_spec.rb} +7 -7
  468. data/spec/models/{v1_api_keys_get200_response_spec.rb → list_api_keys200_response_spec.rb} +7 -7
  469. data/spec/models/list_calendar_events200_response_spec.rb +1 -1
  470. data/spec/models/list_calendar_integrations200_response_spec.rb +1 -1
  471. data/spec/models/list_calendar_members200_response_spec.rb +1 -1
  472. data/spec/models/list_calendars200_response_spec.rb +1 -1
  473. data/spec/models/list_contact_lists200_response_spec.rb +1 -1
  474. data/spec/models/list_contacts200_response_spec.rb +1 -1
  475. data/spec/models/list_dedicated_ip_requests200_response_spec.rb +1 -1
  476. data/spec/models/list_distribution_lists200_response_spec.rb +1 -1
  477. data/spec/models/list_domains200_response_spec.rb +36 -0
  478. data/spec/models/{v1_mailboxes_get200_response_spec.rb → list_mailboxes200_response_spec.rb} +7 -7
  479. data/spec/models/{v1_suppressions_get200_response_spec.rb → list_messages200_response_spec.rb} +7 -7
  480. data/spec/models/list_migration_credentials200_response_spec.rb +1 -1
  481. data/spec/models/list_migration_events200_response_spec.rb +1 -1
  482. data/spec/models/list_migration_mailboxes200_response_spec.rb +1 -1
  483. data/spec/models/list_migrations200_response_spec.rb +1 -1
  484. data/spec/models/list_resources200_response_spec.rb +1 -1
  485. data/spec/models/list_shared_members200_response_spec.rb +1 -1
  486. data/spec/models/{v1_messages_get200_response_spec.rb → list_suppressions200_response_spec.rb} +7 -7
  487. data/spec/models/{v1_vacation_get200_response_spec.rb → list_templates200_response_spec.rb} +7 -7
  488. data/spec/models/list_users200_response_spec.rb +1 -1
  489. data/spec/models/list_vacation_responders200_response_spec.rb +36 -0
  490. data/spec/models/{v1_domains_get200_response_spec.rb → list_webhooks200_response_spec.rb} +7 -7
  491. data/spec/models/mailbox_grant_list_spec.rb +36 -0
  492. data/spec/models/mailbox_grant_spec.rb +42 -0
  493. data/spec/models/mailbox_spec.rb +1 -1
  494. data/spec/models/map_migration_request_mappings_inner_spec.rb +1 -1
  495. data/spec/models/map_migration_request_spec.rb +1 -1
  496. data/spec/models/mark_read_result_spec.rb +36 -0
  497. data/spec/models/message_detail_spec.rb +142 -0
  498. data/spec/models/message_spec.rb +1 -1
  499. data/spec/models/message_stats_counts_spec.rb +1 -1
  500. data/spec/models/message_stats_rates_spec.rb +1 -1
  501. data/spec/models/message_stats_spec.rb +1 -1
  502. data/spec/models/message_stats_window_spec.rb +1 -1
  503. data/spec/models/migration_credential_spec.rb +1 -1
  504. data/spec/models/migration_event_spec.rb +1 -1
  505. data/spec/models/migration_mailbox_spec.rb +1 -1
  506. data/spec/models/migration_progress_mailboxes_inner_spec.rb +1 -1
  507. data/spec/models/migration_progress_spec.rb +1 -1
  508. data/spec/models/migration_settings_spec.rb +1 -1
  509. data/spec/models/migration_spec.rb +1 -1
  510. data/spec/models/model_alias_spec.rb +1 -1
  511. data/spec/models/plan_catalog_entry_spec.rb +1 -1
  512. data/spec/models/problem_spec.rb +1 -1
  513. data/spec/models/replace_distribution_list_members200_response_spec.rb +1 -1
  514. data/spec/models/replace_distribution_list_members_request_spec.rb +1 -1
  515. data/spec/models/resource_spec.rb +1 -1
  516. data/spec/models/return_path_check_spec.rb +42 -0
  517. data/spec/models/return_path_spec.rb +70 -0
  518. data/spec/models/rotate_encryption_key_request_spec.rb +1 -1
  519. data/spec/models/send_email200_response_spec.rb +58 -0
  520. data/spec/models/{v1_send_post202_response_spec.rb → send_email202_response_spec.rb} +7 -7
  521. data/spec/models/{v1_templates_get200_response_spec.rb → send_email_batch200_response_spec.rb} +7 -7
  522. data/spec/models/{v1_send_batch_post_request_spec.rb → send_email_batch_request_spec.rb} +7 -7
  523. data/spec/models/{v1_send_post_request_attachments_inner_spec.rb → send_email_request_attachments_inner_spec.rb} +7 -7
  524. data/spec/models/{v1_send_post_request_spec.rb → send_email_request_spec.rb} +19 -7
  525. data/spec/models/send_message_spec.rb +13 -1
  526. data/spec/models/{v1_mailboxes_email_vacation_put_request_spec.rb → set_vacation_responder_request_spec.rb} +7 -7
  527. data/spec/models/shared_member_spec.rb +1 -1
  528. data/spec/models/signup_request_spec.rb +1 -1
  529. data/spec/models/simulated_inbound_spec.rb +48 -0
  530. data/spec/models/{v1_inboxes_mailbox_messages_post_request_spec.rb → start_conversation_request_spec.rb} +7 -7
  531. data/spec/models/start_migration202_response_spec.rb +1 -1
  532. data/spec/models/suppression_spec.rb +1 -1
  533. data/spec/models/template_input_spec.rb +1 -1
  534. data/spec/models/template_spec.rb +1 -1
  535. data/spec/models/tenant_spec.rb +1 -1
  536. data/spec/models/thread_classification_spec.rb +48 -0
  537. data/spec/models/thread_list_spec.rb +42 -0
  538. data/spec/models/thread_message_body_all_of_body_spec.rb +48 -0
  539. data/spec/models/thread_message_body_spec.rb +112 -0
  540. data/spec/models/thread_message_spec.rb +106 -0
  541. data/spec/models/thread_spec.rb +48 -0
  542. data/spec/models/thread_summary_spec.rb +70 -0
  543. data/spec/models/unit_bundle_spec.rb +1 -1
  544. data/spec/models/{v1_admins_id_patch_request_spec.rb → update_admin_request_spec.rb} +7 -7
  545. data/spec/models/update_calendar_event_request_spec.rb +1 -1
  546. data/spec/models/update_calendar_integration_request_spec.rb +1 -1
  547. data/spec/models/update_calendar_member_request_spec.rb +1 -1
  548. data/spec/models/update_calendar_policies_request_spec.rb +1 -1
  549. data/spec/models/update_calendar_request_spec.rb +1 -1
  550. data/spec/models/update_contact_list_request_spec.rb +1 -1
  551. data/spec/models/update_contact_request_spec.rb +1 -1
  552. data/spec/models/update_directory_permissions_request_spec.rb +1 -1
  553. data/spec/models/update_gal_settings_request_spec.rb +1 -1
  554. data/spec/models/{v1_mailboxes_email_patch_request_spec.rb → update_mailbox_request_spec.rb} +7 -7
  555. data/spec/models/update_migration_mailbox_request_spec.rb +1 -1
  556. data/spec/models/update_migration_request_spec.rb +1 -1
  557. data/spec/models/update_resource_request_spec.rb +1 -1
  558. data/spec/models/update_user_request_spec.rb +1 -1
  559. data/spec/models/{v1_webhooks_id_patch_request_spec.rb → update_webhook_request_spec.rb} +7 -7
  560. data/spec/models/user_event_spec.rb +1 -1
  561. data/spec/models/user_spec.rb +1 -1
  562. data/spec/models/vacation_params_spec.rb +1 -1
  563. data/spec/models/vacation_responder_spec.rb +1 -1
  564. data/spec/models/webhook_spec.rb +1 -1
  565. data/spec/models/whoami_spec.rb +54 -0
  566. data/spec/spec_helper.rb +1 -1
  567. metadata +408 -285
  568. data/docs/V1ApiKeysPostRequest.md +0 -20
  569. data/lib/lockally/models/v1_webhooks_get200_response.rb +0 -166
  570. data/spec/models/v1_send_batch_post200_response_spec.rb +0 -36
  571. data/spec/models/v1_webhooks_get200_response_spec.rb +0 -36
@@ -0,0 +1,18 @@
1
+ # Lockally::MarkReadResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **read** | **Boolean** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'lockally'
13
+
14
+ instance = Lockally::MarkReadResult.new(
15
+ read: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,52 @@
1
+ # Lockally::MessageDetail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **tenant_id** | **String** | | |
9
+ | **message_id** | **String** | RFC 5322 Message-ID header, including angle brackets. | |
10
+ | **sender** | **String** | | |
11
+ | **recipients** | **Array<String>** | | |
12
+ | **subject** | **String** | | [optional] |
13
+ | **status** | **String** | | |
14
+ | **queued_at** | **Time** | | |
15
+ | **updated_at** | **Time** | | |
16
+ | **bounce_reason** | **String** | | [optional] |
17
+ | **size_bytes** | **Integer** | | [optional] |
18
+ | **from** | **String** | | [optional] |
19
+ | **to** | **Array<String>** | | [optional] |
20
+ | **cc** | **Array<String>** | | [optional] |
21
+ | **bcc** | **Array<String>** | | [optional] |
22
+ | **text** | **String** | | [optional] |
23
+ | **html** | **String** | | [optional] |
24
+ | **headers** | **Hash<String, String>** | | [optional] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'lockally'
30
+
31
+ instance = Lockally::MessageDetail.new(
32
+ id: null,
33
+ tenant_id: null,
34
+ message_id: null,
35
+ sender: null,
36
+ recipients: null,
37
+ subject: null,
38
+ status: null,
39
+ queued_at: null,
40
+ updated_at: null,
41
+ bounce_reason: null,
42
+ size_bytes: null,
43
+ from: null,
44
+ to: null,
45
+ cc: null,
46
+ bcc: null,
47
+ text: null,
48
+ html: null,
49
+ headers: null
50
+ )
51
+ ```
52
+
@@ -0,0 +1,28 @@
1
+ # Lockally::ReturnPath
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **host** | **String** | | |
9
+ | **records** | [**Array<DNSRecord>**](DNSRecord.md) | | |
10
+ | **check** | [**ReturnPathCheck**](ReturnPathCheck.md) | | [optional] |
11
+ | **requested_at** | **Time** | | [optional] |
12
+ | **verified_at** | **Time** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'lockally'
18
+
19
+ instance = Lockally::ReturnPath.new(
20
+ status: null,
21
+ host: bounces.acme.com,
22
+ records: null,
23
+ check: null,
24
+ requested_at: null,
25
+ verified_at: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # Lockally::ReturnPathCheck
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mx** | **Boolean** | | [optional] |
8
+ | **spf** | **Boolean** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'lockally'
14
+
15
+ instance = Lockally::ReturnPathCheck.new(
16
+ mx: null,
17
+ spf: null
18
+ )
19
+ ```
20
+
data/docs/SendApi.md CHANGED
@@ -4,21 +4,21 @@ All URIs are relative to *https://api.lockally.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**v1_messages_get**](SendApi.md#v1_messages_get) | **GET** /v1/messages | List outbound messages |
8
- | [**v1_messages_id_delete**](SendApi.md#v1_messages_id_delete) | **DELETE** /v1/messages/{id} | Cancel a scheduled send |
9
- | [**v1_messages_id_get**](SendApi.md#v1_messages_id_get) | **GET** /v1/messages/{id} | Get message status |
10
- | [**v1_messages_stats_get**](SendApi.md#v1_messages_stats_get) | **GET** /v1/messages/stats | Aggregate delivery stats |
11
- | [**v1_send_batch_post**](SendApi.md#v1_send_batch_post) | **POST** /v1/send/batch | Send a batch of emails |
12
- | [**v1_send_post**](SendApi.md#v1_send_post) | **POST** /v1/send | Send an email |
7
+ | [**cancel_message**](SendApi.md#cancel_message) | **DELETE** /v1/messages/{id} | Cancel a scheduled send |
8
+ | [**get_message**](SendApi.md#get_message) | **GET** /v1/messages/{id} | Get message status |
9
+ | [**get_message_stats**](SendApi.md#get_message_stats) | **GET** /v1/messages/stats | Aggregate delivery stats |
10
+ | [**list_messages**](SendApi.md#list_messages) | **GET** /v1/messages | List outbound messages |
11
+ | [**send_email**](SendApi.md#send_email) | **POST** /v1/send | Send an email |
12
+ | [**send_email_batch**](SendApi.md#send_email_batch) | **POST** /v1/send/batch | Send a batch of emails |
13
13
 
14
14
 
15
- ## v1_messages_get
15
+ ## cancel_message
16
16
 
17
- > <V1MessagesGet200Response> v1_messages_get(opts)
17
+ > cancel_message(id)
18
18
 
19
- List outbound messages
19
+ Cancel a scheduled send
20
20
 
21
- 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.
21
+ Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
22
22
 
23
23
  ### Examples
24
24
 
@@ -32,39 +32,31 @@ Lockally.configure do |config|
32
32
  end
33
33
 
34
34
  api_instance = Lockally::SendApi.new
35
- opts = {
36
- status: 'queued', # String |
37
- sender: 'sender_example', # String | Exact match against the `from` mailbox.
38
- q: 'q_example', # String | Free-text search across subject + sender.
39
- since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only messages queued at or after this RFC 3339 instant.
40
- cursor: 'cursor_example', # String | queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
41
- limit: 56 # Integer |
42
- }
35
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
43
36
 
44
37
  begin
45
- # List outbound messages
46
- result = api_instance.v1_messages_get(opts)
47
- p result
38
+ # Cancel a scheduled send
39
+ api_instance.cancel_message(id)
48
40
  rescue Lockally::ApiError => e
49
- puts "Error when calling SendApi->v1_messages_get: #{e}"
41
+ puts "Error when calling SendApi->cancel_message: #{e}"
50
42
  end
51
43
  ```
52
44
 
53
- #### Using the v1_messages_get_with_http_info variant
45
+ #### Using the cancel_message_with_http_info variant
54
46
 
55
- This returns an Array which contains the response data, status code and headers.
47
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
56
48
 
57
- > <Array(<V1MessagesGet200Response>, Integer, Hash)> v1_messages_get_with_http_info(opts)
49
+ > <Array(nil, Integer, Hash)> cancel_message_with_http_info(id)
58
50
 
59
51
  ```ruby
60
52
  begin
61
- # List outbound messages
62
- data, status_code, headers = api_instance.v1_messages_get_with_http_info(opts)
53
+ # Cancel a scheduled send
54
+ data, status_code, headers = api_instance.cancel_message_with_http_info(id)
63
55
  p status_code # => 2xx
64
56
  p headers # => { ... }
65
- p data # => <V1MessagesGet200Response>
57
+ p data # => nil
66
58
  rescue Lockally::ApiError => e
67
- puts "Error when calling SendApi->v1_messages_get_with_http_info: #{e}"
59
+ puts "Error when calling SendApi->cancel_message_with_http_info: #{e}"
68
60
  end
69
61
  ```
70
62
 
@@ -72,16 +64,11 @@ end
72
64
 
73
65
  | Name | Type | Description | Notes |
74
66
  | ---- | ---- | ----------- | ----- |
75
- | **status** | **String** | | [optional] |
76
- | **sender** | **String** | Exact match against the &#x60;from&#x60; mailbox. | [optional] |
77
- | **q** | **String** | Free-text search across subject + sender. | [optional] |
78
- | **since** | **Time** | Only messages queued at or after this RFC 3339 instant. | [optional] |
79
- | **cursor** | **String** | queued_at of the prior page boundary. Pass back the &#x60;next_cursor&#x60; returned by the previous call. | [optional] |
80
- | **limit** | **Integer** | | [optional][default to 50] |
67
+ | **id** | **String** | | |
81
68
 
82
69
  ### Return type
83
70
 
84
- [**V1MessagesGet200Response**](V1MessagesGet200Response.md)
71
+ nil (empty response body)
85
72
 
86
73
  ### Authorization
87
74
 
@@ -90,16 +77,14 @@ end
90
77
  ### HTTP request headers
91
78
 
92
79
  - **Content-Type**: Not defined
93
- - **Accept**: application/json, application/problem+json
94
-
80
+ - **Accept**: application/problem+json
95
81
 
96
- ## v1_messages_id_delete
97
82
 
98
- > v1_messages_id_delete(id)
83
+ ## get_message
99
84
 
100
- Cancel a scheduled send
85
+ > <MessageDetail> get_message(id)
101
86
 
102
- Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
87
+ Get message status
103
88
 
104
89
  ### Examples
105
90
 
@@ -116,28 +101,29 @@ api_instance = Lockally::SendApi.new
116
101
  id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
117
102
 
118
103
  begin
119
- # Cancel a scheduled send
120
- api_instance.v1_messages_id_delete(id)
104
+ # Get message status
105
+ result = api_instance.get_message(id)
106
+ p result
121
107
  rescue Lockally::ApiError => e
122
- puts "Error when calling SendApi->v1_messages_id_delete: #{e}"
108
+ puts "Error when calling SendApi->get_message: #{e}"
123
109
  end
124
110
  ```
125
111
 
126
- #### Using the v1_messages_id_delete_with_http_info variant
112
+ #### Using the get_message_with_http_info variant
127
113
 
128
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
114
+ This returns an Array which contains the response data, status code and headers.
129
115
 
130
- > <Array(nil, Integer, Hash)> v1_messages_id_delete_with_http_info(id)
116
+ > <Array(<MessageDetail>, Integer, Hash)> get_message_with_http_info(id)
131
117
 
132
118
  ```ruby
133
119
  begin
134
- # Cancel a scheduled send
135
- data, status_code, headers = api_instance.v1_messages_id_delete_with_http_info(id)
120
+ # Get message status
121
+ data, status_code, headers = api_instance.get_message_with_http_info(id)
136
122
  p status_code # => 2xx
137
123
  p headers # => { ... }
138
- p data # => nil
124
+ p data # => <MessageDetail>
139
125
  rescue Lockally::ApiError => e
140
- puts "Error when calling SendApi->v1_messages_id_delete_with_http_info: #{e}"
126
+ puts "Error when calling SendApi->get_message_with_http_info: #{e}"
141
127
  end
142
128
  ```
143
129
 
@@ -149,7 +135,7 @@ end
149
135
 
150
136
  ### Return type
151
137
 
152
- nil (empty response body)
138
+ [**MessageDetail**](MessageDetail.md)
153
139
 
154
140
  ### Authorization
155
141
 
@@ -158,14 +144,16 @@ nil (empty response body)
158
144
  ### HTTP request headers
159
145
 
160
146
  - **Content-Type**: Not defined
161
- - **Accept**: application/problem+json
147
+ - **Accept**: application/json, application/problem+json
162
148
 
163
149
 
164
- ## v1_messages_id_get
150
+ ## get_message_stats
165
151
 
166
- > <Message> v1_messages_id_get(id)
152
+ > <MessageStats> get_message_stats(opts)
167
153
 
168
- Get message status
154
+ Aggregate delivery stats
155
+
156
+ Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking.
169
157
 
170
158
  ### Examples
171
159
 
@@ -179,32 +167,36 @@ Lockally.configure do |config|
179
167
  end
180
168
 
181
169
  api_instance = Lockally::SendApi.new
182
- id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
170
+ opts = {
171
+ from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window start (default 7 days ago).
172
+ to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window end (default now).
173
+ domain: 'domain_example' # String | Filter by sender domain.
174
+ }
183
175
 
184
176
  begin
185
- # Get message status
186
- result = api_instance.v1_messages_id_get(id)
177
+ # Aggregate delivery stats
178
+ result = api_instance.get_message_stats(opts)
187
179
  p result
188
180
  rescue Lockally::ApiError => e
189
- puts "Error when calling SendApi->v1_messages_id_get: #{e}"
181
+ puts "Error when calling SendApi->get_message_stats: #{e}"
190
182
  end
191
183
  ```
192
184
 
193
- #### Using the v1_messages_id_get_with_http_info variant
185
+ #### Using the get_message_stats_with_http_info variant
194
186
 
195
187
  This returns an Array which contains the response data, status code and headers.
196
188
 
197
- > <Array(<Message>, Integer, Hash)> v1_messages_id_get_with_http_info(id)
189
+ > <Array(<MessageStats>, Integer, Hash)> get_message_stats_with_http_info(opts)
198
190
 
199
191
  ```ruby
200
192
  begin
201
- # Get message status
202
- data, status_code, headers = api_instance.v1_messages_id_get_with_http_info(id)
193
+ # Aggregate delivery stats
194
+ data, status_code, headers = api_instance.get_message_stats_with_http_info(opts)
203
195
  p status_code # => 2xx
204
196
  p headers # => { ... }
205
- p data # => <Message>
197
+ p data # => <MessageStats>
206
198
  rescue Lockally::ApiError => e
207
- puts "Error when calling SendApi->v1_messages_id_get_with_http_info: #{e}"
199
+ puts "Error when calling SendApi->get_message_stats_with_http_info: #{e}"
208
200
  end
209
201
  ```
210
202
 
@@ -212,11 +204,13 @@ end
212
204
 
213
205
  | Name | Type | Description | Notes |
214
206
  | ---- | ---- | ----------- | ----- |
215
- | **id** | **String** | | |
207
+ | **from** | **Time** | Window start (default 7 days ago). | [optional] |
208
+ | **to** | **Time** | Window end (default now). | [optional] |
209
+ | **domain** | **String** | Filter by sender domain. | [optional] |
216
210
 
217
211
  ### Return type
218
212
 
219
- [**Message**](Message.md)
213
+ [**MessageStats**](MessageStats.md)
220
214
 
221
215
  ### Authorization
222
216
 
@@ -228,13 +222,13 @@ end
228
222
  - **Accept**: application/json, application/problem+json
229
223
 
230
224
 
231
- ## v1_messages_stats_get
225
+ ## list_messages
232
226
 
233
- > <MessageStats> v1_messages_stats_get(opts)
227
+ > <ListMessages200Response> list_messages(opts)
234
228
 
235
- Aggregate delivery stats
229
+ List outbound messages
236
230
 
237
- 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
+ Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box.
238
232
 
239
233
  ### Examples
240
234
 
@@ -249,35 +243,38 @@ end
249
243
 
250
244
  api_instance = Lockally::SendApi.new
251
245
  opts = {
252
- from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window start (default 7 days ago).
253
- to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Window end (default now).
254
- domain: 'domain_example' # String | Filter by sender domain.
246
+ status: 'queued', # String |
247
+ sender: 'sender_example', # String | Exact match against the `from` mailbox.
248
+ q: 'q_example', # String | Free-text search across subject + sender.
249
+ since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only messages queued at or after this RFC 3339 instant.
250
+ cursor: 'cursor_example', # String | queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
251
+ limit: 56 # Integer |
255
252
  }
256
253
 
257
254
  begin
258
- # Aggregate delivery stats
259
- result = api_instance.v1_messages_stats_get(opts)
255
+ # List outbound messages
256
+ result = api_instance.list_messages(opts)
260
257
  p result
261
258
  rescue Lockally::ApiError => e
262
- puts "Error when calling SendApi->v1_messages_stats_get: #{e}"
259
+ puts "Error when calling SendApi->list_messages: #{e}"
263
260
  end
264
261
  ```
265
262
 
266
- #### Using the v1_messages_stats_get_with_http_info variant
263
+ #### Using the list_messages_with_http_info variant
267
264
 
268
265
  This returns an Array which contains the response data, status code and headers.
269
266
 
270
- > <Array(<MessageStats>, Integer, Hash)> v1_messages_stats_get_with_http_info(opts)
267
+ > <Array(<ListMessages200Response>, Integer, Hash)> list_messages_with_http_info(opts)
271
268
 
272
269
  ```ruby
273
270
  begin
274
- # Aggregate delivery stats
275
- data, status_code, headers = api_instance.v1_messages_stats_get_with_http_info(opts)
271
+ # List outbound messages
272
+ data, status_code, headers = api_instance.list_messages_with_http_info(opts)
276
273
  p status_code # => 2xx
277
274
  p headers # => { ... }
278
- p data # => <MessageStats>
275
+ p data # => <ListMessages200Response>
279
276
  rescue Lockally::ApiError => e
280
- puts "Error when calling SendApi->v1_messages_stats_get_with_http_info: #{e}"
277
+ puts "Error when calling SendApi->list_messages_with_http_info: #{e}"
281
278
  end
282
279
  ```
283
280
 
@@ -285,13 +282,16 @@ end
285
282
 
286
283
  | Name | Type | Description | Notes |
287
284
  | ---- | ---- | ----------- | ----- |
288
- | **from** | **Time** | Window start (default 7 days ago). | [optional] |
289
- | **to** | **Time** | Window end (default now). | [optional] |
290
- | **domain** | **String** | Filter by sender domain. | [optional] |
285
+ | **status** | **String** | | [optional] |
286
+ | **sender** | **String** | Exact match against the &#x60;from&#x60; mailbox. | [optional] |
287
+ | **q** | **String** | Free-text search across subject + sender. | [optional] |
288
+ | **since** | **Time** | Only messages queued at or after this RFC 3339 instant. | [optional] |
289
+ | **cursor** | **String** | queued_at of the prior page boundary. Pass back the &#x60;next_cursor&#x60; returned by the previous call. | [optional] |
290
+ | **limit** | **Integer** | | [optional][default to 50] |
291
291
 
292
292
  ### Return type
293
293
 
294
- [**MessageStats**](MessageStats.md)
294
+ [**ListMessages200Response**](ListMessages200Response.md)
295
295
 
296
296
  ### Authorization
297
297
 
@@ -303,13 +303,13 @@ end
303
303
  - **Accept**: application/json, application/problem+json
304
304
 
305
305
 
306
- ## v1_send_batch_post
306
+ ## send_email
307
307
 
308
- > <V1SendBatchPost200Response> v1_send_batch_post(idempotency_key, v1_send_batch_post_request)
308
+ > <SendEmail200Response> send_email(idempotency_key, send_email_request)
309
309
 
310
- Send a batch of emails
310
+ Send an email
311
311
 
312
- 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>`.
312
+ Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`. **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message. **Sender authorisation.** `from` must be an address the calling tenant owns on a verified domain. A mailbox always qualifies. On business and combined accounts an **alias** qualifies too, so a send-only address such as `no-reply@` need not be a billed seat. An alias on an unverified domain, or one belonging to another account, is refused with `403`. A catch-all creates no aliases and so grants no sending rights. **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped. **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. **Not every success is a 202.** Check the status code, not just the body. A `200` means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the `200` response below. **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry `X-Warmup-Day`, `X-Warmup-Daily-Cap` and `X-Warmup-Used-Today`. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429.
313
313
 
314
314
  ### Examples
315
315
 
@@ -324,32 +324,32 @@ end
324
324
 
325
325
  api_instance = Lockally::SendApi.new
326
326
  idempotency_key = 'idempotency_key_example' # String |
327
- v1_send_batch_post_request = Lockally::V1SendBatchPostRequest.new({messages: [Lockally::SendMessage.new({from: 'from_example', to: ['to_example']})]}) # V1SendBatchPostRequest |
327
+ send_email_request = Lockally::SendEmailRequest.new({from: 'from_example', to: ['to_example']}) # SendEmailRequest |
328
328
 
329
329
  begin
330
- # Send a batch of emails
331
- result = api_instance.v1_send_batch_post(idempotency_key, v1_send_batch_post_request)
330
+ # Send an email
331
+ result = api_instance.send_email(idempotency_key, send_email_request)
332
332
  p result
333
333
  rescue Lockally::ApiError => e
334
- puts "Error when calling SendApi->v1_send_batch_post: #{e}"
334
+ puts "Error when calling SendApi->send_email: #{e}"
335
335
  end
336
336
  ```
337
337
 
338
- #### Using the v1_send_batch_post_with_http_info variant
338
+ #### Using the send_email_with_http_info variant
339
339
 
340
340
  This returns an Array which contains the response data, status code and headers.
341
341
 
342
- > <Array(<V1SendBatchPost200Response>, Integer, Hash)> v1_send_batch_post_with_http_info(idempotency_key, v1_send_batch_post_request)
342
+ > <Array(<SendEmail200Response>, Integer, Hash)> send_email_with_http_info(idempotency_key, send_email_request)
343
343
 
344
344
  ```ruby
345
345
  begin
346
- # Send a batch of emails
347
- data, status_code, headers = api_instance.v1_send_batch_post_with_http_info(idempotency_key, v1_send_batch_post_request)
346
+ # Send an email
347
+ data, status_code, headers = api_instance.send_email_with_http_info(idempotency_key, send_email_request)
348
348
  p status_code # => 2xx
349
349
  p headers # => { ... }
350
- p data # => <V1SendBatchPost200Response>
350
+ p data # => <SendEmail200Response>
351
351
  rescue Lockally::ApiError => e
352
- puts "Error when calling SendApi->v1_send_batch_post_with_http_info: #{e}"
352
+ puts "Error when calling SendApi->send_email_with_http_info: #{e}"
353
353
  end
354
354
  ```
355
355
 
@@ -358,11 +358,11 @@ end
358
358
  | Name | Type | Description | Notes |
359
359
  | ---- | ---- | ----------- | ----- |
360
360
  | **idempotency_key** | **String** | | |
361
- | **v1_send_batch_post_request** | [**V1SendBatchPostRequest**](V1SendBatchPostRequest.md) | | |
361
+ | **send_email_request** | [**SendEmailRequest**](SendEmailRequest.md) | | |
362
362
 
363
363
  ### Return type
364
364
 
365
- [**V1SendBatchPost200Response**](V1SendBatchPost200Response.md)
365
+ [**SendEmail200Response**](SendEmail200Response.md)
366
366
 
367
367
  ### Authorization
368
368
 
@@ -374,13 +374,13 @@ end
374
374
  - **Accept**: application/json, application/problem+json
375
375
 
376
376
 
377
- ## v1_send_post
377
+ ## send_email_batch
378
378
 
379
- > <V1SendPost202Response> v1_send_post(idempotency_key, v1_send_post_request)
379
+ > <SendEmailBatch200Response> send_email_batch(idempotency_key, send_email_batch_request)
380
380
 
381
- Send an email
381
+ Send a batch of emails
382
382
 
383
- 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.
383
+ Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`.
384
384
 
385
385
  ### Examples
386
386
 
@@ -395,32 +395,32 @@ end
395
395
 
396
396
  api_instance = Lockally::SendApi.new
397
397
  idempotency_key = 'idempotency_key_example' # String |
398
- v1_send_post_request = Lockally::V1SendPostRequest.new({from: 'from_example', to: ['to_example']}) # V1SendPostRequest |
398
+ send_email_batch_request = Lockally::SendEmailBatchRequest.new({messages: [Lockally::SendMessage.new({from: 'from_example', to: ['to_example']})]}) # SendEmailBatchRequest |
399
399
 
400
400
  begin
401
- # Send an email
402
- result = api_instance.v1_send_post(idempotency_key, v1_send_post_request)
401
+ # Send a batch of emails
402
+ result = api_instance.send_email_batch(idempotency_key, send_email_batch_request)
403
403
  p result
404
404
  rescue Lockally::ApiError => e
405
- puts "Error when calling SendApi->v1_send_post: #{e}"
405
+ puts "Error when calling SendApi->send_email_batch: #{e}"
406
406
  end
407
407
  ```
408
408
 
409
- #### Using the v1_send_post_with_http_info variant
409
+ #### Using the send_email_batch_with_http_info variant
410
410
 
411
411
  This returns an Array which contains the response data, status code and headers.
412
412
 
413
- > <Array(<V1SendPost202Response>, Integer, Hash)> v1_send_post_with_http_info(idempotency_key, v1_send_post_request)
413
+ > <Array(<SendEmailBatch200Response>, Integer, Hash)> send_email_batch_with_http_info(idempotency_key, send_email_batch_request)
414
414
 
415
415
  ```ruby
416
416
  begin
417
- # Send an email
418
- data, status_code, headers = api_instance.v1_send_post_with_http_info(idempotency_key, v1_send_post_request)
417
+ # Send a batch of emails
418
+ data, status_code, headers = api_instance.send_email_batch_with_http_info(idempotency_key, send_email_batch_request)
419
419
  p status_code # => 2xx
420
420
  p headers # => { ... }
421
- p data # => <V1SendPost202Response>
421
+ p data # => <SendEmailBatch200Response>
422
422
  rescue Lockally::ApiError => e
423
- puts "Error when calling SendApi->v1_send_post_with_http_info: #{e}"
423
+ puts "Error when calling SendApi->send_email_batch_with_http_info: #{e}"
424
424
  end
425
425
  ```
426
426
 
@@ -429,11 +429,11 @@ end
429
429
  | Name | Type | Description | Notes |
430
430
  | ---- | ---- | ----------- | ----- |
431
431
  | **idempotency_key** | **String** | | |
432
- | **v1_send_post_request** | [**V1SendPostRequest**](V1SendPostRequest.md) | | |
432
+ | **send_email_batch_request** | [**SendEmailBatchRequest**](SendEmailBatchRequest.md) | | |
433
433
 
434
434
  ### Return type
435
435
 
436
- [**V1SendPost202Response**](V1SendPost202Response.md)
436
+ [**SendEmailBatch200Response**](SendEmailBatch200Response.md)
437
437
 
438
438
  ### Authorization
439
439
 
@@ -0,0 +1,24 @@
1
+ # Lockally::SendEmail200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Present on a test-mode send; absent when suppressed. | [optional] |
8
+ | **message_id** | **String** | RFC 5322 Message-ID. On a test send the domain is test.lockally.com. Absent when suppressed. | [optional] |
9
+ | **status** | **String** | | |
10
+ | **warning** | **String** | On a suppressed send, explains that nothing was sent. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'lockally'
16
+
17
+ instance = Lockally::SendEmail200Response.new(
18
+ id: null,
19
+ message_id: null,
20
+ status: null,
21
+ warning: null
22
+ )
23
+ ```
24
+
@@ -1,4 +1,4 @@
1
- # Lockally::V1SendPost202Response
1
+ # Lockally::SendEmail202Response
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,7 @@
14
14
  ```ruby
15
15
  require 'lockally'
16
16
 
17
- instance = Lockally::V1SendPost202Response.new(
17
+ instance = Lockally::SendEmail202Response.new(
18
18
  id: null,
19
19
  message_id: null,
20
20
  status: null,