lockally 0.2.0 → 0.3.1

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 (253) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +148 -119
  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/Annotations.md +22 -0
  14. data/docs/ApiKeysApi.md +59 -59
  15. data/docs/Attachment.md +26 -0
  16. data/docs/Classification.md +24 -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/{V1ApiKeysPostRequest.md → CreateApiKeyRequest.md} +2 -2
  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 +141 -141
  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/{V1AdminMeGet200Response.md → GetCurrentAdmin200Response.md} +2 -2
  35. data/docs/{V1UsageGet200Response.md → GetUsage200Response.md} +2 -2
  36. data/docs/HealthApi.md +11 -11
  37. data/docs/{HealthzGet200Response.md → HealthCheck200Response.md} +2 -2
  38. data/docs/Inbox.md +24 -0
  39. data/docs/InboxList.md +18 -0
  40. data/docs/InjectionRisk.md +20 -0
  41. data/docs/{V1AdminsPostRequest.md → InviteAdminRequest.md} +2 -2
  42. data/docs/{V1AdminsGet200Response.md → ListAdmins200Response.md} +2 -2
  43. data/docs/{V1AliasesGet200Response.md → ListAliases200Response.md} +2 -2
  44. data/docs/{V1ApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
  45. data/docs/{V1DomainsGet200Response.md → ListDomains200Response.md} +2 -2
  46. data/docs/{V1MailboxesGet200Response.md → ListMailboxes200Response.md} +2 -2
  47. data/docs/{V1MessagesGet200Response.md → ListMessages200Response.md} +2 -2
  48. data/docs/{V1SuppressionsGet200Response.md → ListSuppressions200Response.md} +2 -2
  49. data/docs/{V1TemplatesGet200Response.md → ListTemplates200Response.md} +2 -2
  50. data/docs/{V1VacationGet200Response.md → ListVacationResponders200Response.md} +2 -2
  51. data/docs/{V1WebhooksGet200Response.md → ListWebhooks200Response.md} +2 -2
  52. data/docs/MailboxGrant.md +20 -0
  53. data/docs/MailboxGrantList.md +18 -0
  54. data/docs/MailboxesApi.md +203 -203
  55. data/docs/MarkReadResult.md +18 -0
  56. data/docs/PolicyFlags.md +28 -0
  57. data/docs/SendApi.md +121 -121
  58. data/docs/{V1SendPost200Response.md → SendEmail200Response.md} +2 -2
  59. data/docs/{V1SendPost202Response.md → SendEmail202Response.md} +2 -2
  60. data/docs/{V1SendBatchPost200Response.md → SendEmailBatch200Response.md} +2 -2
  61. data/docs/{V1SendBatchPostRequest.md → SendEmailBatchRequest.md} +2 -2
  62. data/docs/{V1SendPostRequest.md → SendEmailRequest.md} +3 -3
  63. data/docs/{V1SendPostRequestAttachmentsInner.md → SendEmailRequestAttachmentsInner.md} +2 -2
  64. data/docs/SendMessage.md +1 -1
  65. data/docs/{V1MailboxesEmailVacationPutRequest.md → SetVacationResponderRequest.md} +2 -2
  66. data/docs/SignupApi.md +4 -4
  67. data/docs/SimulatedInbound.md +22 -0
  68. data/docs/{V1InboxesMailboxMessagesPostRequest.md → StartConversationRequest.md} +2 -2
  69. data/docs/SuppressionsApi.md +75 -75
  70. data/docs/TemplatesApi.md +67 -67
  71. data/docs/TenantApi.md +20 -20
  72. data/docs/TestApi.md +11 -11
  73. data/docs/Thread.md +22 -0
  74. data/docs/ThreadClassification.md +22 -0
  75. data/docs/ThreadList.md +20 -0
  76. data/docs/ThreadMessage.md +40 -0
  77. data/docs/ThreadMessageBody.md +42 -0
  78. data/docs/ThreadMessageBodyAllOfBody.md +22 -0
  79. data/docs/ThreadSummary.md +28 -0
  80. data/docs/{V1AdminsIdPatchRequest.md → UpdateAdminRequest.md} +2 -2
  81. data/docs/{V1MailboxesEmailPatchRequest.md → UpdateMailboxRequest.md} +2 -2
  82. data/docs/{V1WebhooksIdPatchRequest.md → UpdateWebhookRequest.md} +2 -2
  83. data/docs/WebhooksApi.md +63 -63
  84. data/docs/Whoami.md +24 -0
  85. data/lib/lockally/api/admin_api.rb +30 -30
  86. data/lib/lockally/api/admins_api.rb +89 -89
  87. data/lib/lockally/api/agents_api.rb +309 -309
  88. data/lib/lockally/api/ai_api.rb +69 -69
  89. data/lib/lockally/api/aliases_api.rb +64 -64
  90. data/lib/lockally/api/api_keys_api.rb +66 -66
  91. data/lib/lockally/api/domains_api.rb +147 -147
  92. data/lib/lockally/api/drafts_api.rb +140 -140
  93. data/lib/lockally/api/health_api.rb +9 -9
  94. data/lib/lockally/api/mailboxes_api.rb +233 -233
  95. data/lib/lockally/api/send_api.rb +146 -146
  96. data/lib/lockally/api/signup_api.rb +3 -3
  97. data/lib/lockally/api/suppressions_api.rb +87 -87
  98. data/lib/lockally/api/templates_api.rb +69 -69
  99. data/lib/lockally/api/tenant_api.rb +15 -15
  100. data/lib/lockally/api/test_api.rb +9 -9
  101. data/lib/lockally/api/webhooks_api.rb +73 -73
  102. data/lib/lockally/models/{v1_admin_login_post200_response.rb → admin_login200_response.rb} +3 -3
  103. data/lib/lockally/models/{v1_admin_login_post_request.rb → admin_login_request.rb} +3 -3
  104. data/lib/lockally/models/agent_send_result.rb +184 -0
  105. data/lib/lockally/models/ai_config.rb +242 -0
  106. data/lib/lockally/models/ai_config_update.rb +214 -0
  107. data/lib/lockally/models/annotations.rb +168 -0
  108. data/lib/lockally/models/attachment.rb +185 -0
  109. data/lib/lockally/models/classification.rb +211 -0
  110. data/lib/lockally/models/contact_lookup.rb +235 -0
  111. data/lib/lockally/models/contact_lookup_contact.rb +192 -0
  112. data/lib/lockally/models/contact_lookup_history.rb +166 -0
  113. data/lib/lockally/models/create_ai_units_checkout200_response.rb +199 -0
  114. data/lib/lockally/models/{v1_aliases_post_request.rb → create_alias_request.rb} +3 -3
  115. data/lib/lockally/models/{v1_api_keys_post201_response.rb → create_api_key201_response.rb} +3 -3
  116. data/lib/lockally/models/{v1_api_keys_post_request.rb → create_api_key_request.rb} +3 -3
  117. data/lib/lockally/models/{v1_domains_post_request.rb → create_domain_request.rb} +3 -3
  118. data/lib/lockally/models/{v1_mailboxes_post_request.rb → create_mailbox_request.rb} +3 -3
  119. data/lib/lockally/models/{v1_suppressions_post_request.rb → create_suppression_request.rb} +3 -3
  120. data/lib/lockally/models/{v1_webhooks_post_request.rb → create_webhook_request.rb} +3 -3
  121. data/lib/lockally/models/draft.rb +411 -0
  122. data/lib/lockally/models/draft_list.rb +166 -0
  123. data/lib/lockally/models/draft_result.rb +258 -0
  124. data/lib/lockally/models/{v1_mailboxes_email_export_post201_response.rb → export_mailbox201_response.rb} +3 -3
  125. data/lib/lockally/models/{v1_admin_me_get200_response.rb → get_current_admin200_response.rb} +3 -3
  126. data/lib/lockally/models/{v1_usage_get200_response.rb → get_usage200_response.rb} +3 -3
  127. data/lib/lockally/models/{healthz_get200_response.rb → health_check200_response.rb} +3 -3
  128. data/lib/lockally/models/inbox.rb +225 -0
  129. data/lib/lockally/models/inbox_list.rb +166 -0
  130. data/lib/lockally/models/injection_risk.rb +159 -0
  131. data/lib/lockally/models/{v1_admins_post_request.rb → invite_admin_request.rb} +3 -3
  132. data/lib/lockally/models/list_admins200_response.rb +166 -0
  133. data/lib/lockally/models/{v1_aliases_get200_response.rb → list_aliases200_response.rb} +3 -3
  134. data/lib/lockally/models/{v1_admins_get200_response.rb → list_api_keys200_response.rb} +4 -4
  135. data/lib/lockally/models/{v1_domains_get200_response.rb → list_domains200_response.rb} +3 -3
  136. data/lib/lockally/models/{v1_mailboxes_get200_response.rb → list_mailboxes200_response.rb} +3 -3
  137. data/lib/lockally/models/{v1_messages_get200_response.rb → list_messages200_response.rb} +3 -3
  138. data/lib/lockally/models/{v1_suppressions_get200_response.rb → list_suppressions200_response.rb} +3 -3
  139. data/lib/lockally/models/{v1_send_batch_post200_response.rb → list_templates200_response.rb} +4 -4
  140. data/lib/lockally/models/{v1_vacation_get200_response.rb → list_vacation_responders200_response.rb} +3 -3
  141. data/lib/lockally/models/{v1_api_keys_get200_response.rb → list_webhooks200_response.rb} +4 -4
  142. data/lib/lockally/models/mailbox_grant.rb +156 -0
  143. data/lib/lockally/models/mailbox_grant_list.rb +166 -0
  144. data/lib/lockally/models/mark_read_result.rb +147 -0
  145. data/lib/lockally/models/policy_flags.rb +197 -0
  146. data/lib/lockally/models/{v1_send_post200_response.rb → send_email200_response.rb} +3 -3
  147. data/lib/lockally/models/{v1_send_post202_response.rb → send_email202_response.rb} +3 -3
  148. data/lib/lockally/models/{v1_templates_get200_response.rb → send_email_batch200_response.rb} +4 -4
  149. data/lib/lockally/models/{v1_send_batch_post_request.rb → send_email_batch_request.rb} +3 -3
  150. data/lib/lockally/models/{v1_send_post_request.rb → send_email_request.rb} +4 -4
  151. data/lib/lockally/models/{v1_send_post_request_attachments_inner.rb → send_email_request_attachments_inner.rb} +3 -3
  152. data/lib/lockally/models/send_message.rb +1 -1
  153. data/lib/lockally/models/{v1_mailboxes_email_vacation_put_request.rb → set_vacation_responder_request.rb} +3 -3
  154. data/lib/lockally/models/simulated_inbound.rb +165 -0
  155. data/lib/lockally/models/{v1_inboxes_mailbox_messages_post_request.rb → start_conversation_request.rb} +3 -3
  156. data/lib/lockally/models/thread.rb +219 -0
  157. data/lib/lockally/models/thread_classification.rb +183 -0
  158. data/lib/lockally/models/thread_list.rb +192 -0
  159. data/lib/lockally/models/thread_message.rb +394 -0
  160. data/lib/lockally/models/thread_message_body.rb +410 -0
  161. data/lib/lockally/models/thread_message_body_all_of_body.rb +165 -0
  162. data/lib/lockally/models/thread_summary.rb +280 -0
  163. data/lib/lockally/models/{v1_admins_id_patch_request.rb → update_admin_request.rb} +3 -3
  164. data/lib/lockally/models/{v1_mailboxes_email_patch_request.rb → update_mailbox_request.rb} +3 -3
  165. data/lib/lockally/models/{v1_webhooks_id_patch_request.rb → update_webhook_request.rb} +3 -3
  166. data/lib/lockally/models/whoami.rb +177 -0
  167. data/lib/lockally/version.rb +1 -1
  168. data/lib/lockally.rb +64 -35
  169. data/spec/api/admin_api_spec.rb +9 -9
  170. data/spec/api/admins_api_spec.rb +22 -22
  171. data/spec/api/agents_api_spec.rb +78 -78
  172. data/spec/api/ai_api_spec.rb +22 -22
  173. data/spec/api/aliases_api_spec.rb +16 -16
  174. data/spec/api/api_keys_api_spec.rb +17 -17
  175. data/spec/api/domains_api_spec.rb +42 -42
  176. data/spec/api/drafts_api_spec.rb +38 -38
  177. data/spec/api/health_api_spec.rb +3 -3
  178. data/spec/api/mailboxes_api_spec.rb +61 -61
  179. data/spec/api/send_api_spec.rb +35 -35
  180. data/spec/api/signup_api_spec.rb +1 -1
  181. data/spec/api/suppressions_api_spec.rb +18 -18
  182. data/spec/api/templates_api_spec.rb +17 -17
  183. data/spec/api/tenant_api_spec.rb +5 -5
  184. data/spec/api/test_api_spec.rb +3 -3
  185. data/spec/api/webhooks_api_spec.rb +19 -19
  186. data/spec/models/{v1_admin_login_post200_response_spec.rb → admin_login200_response_spec.rb} +6 -6
  187. data/spec/models/{v1_admin_login_post_request_spec.rb → admin_login_request_spec.rb} +6 -6
  188. data/spec/models/agent_send_result_spec.rb +48 -0
  189. data/spec/models/ai_config_spec.rb +64 -0
  190. data/spec/models/ai_config_update_spec.rb +46 -0
  191. data/spec/models/annotations_spec.rb +48 -0
  192. data/spec/models/attachment_spec.rb +60 -0
  193. data/spec/models/classification_spec.rb +58 -0
  194. data/spec/models/contact_lookup_contact_spec.rb +66 -0
  195. data/spec/models/contact_lookup_history_spec.rb +48 -0
  196. data/spec/models/contact_lookup_spec.rb +60 -0
  197. data/spec/models/create_ai_units_checkout200_response_spec.rb +48 -0
  198. data/spec/models/{v1_aliases_post_request_spec.rb → create_alias_request_spec.rb} +6 -6
  199. data/spec/models/{v1_api_keys_post201_response_spec.rb → create_api_key201_response_spec.rb} +6 -6
  200. data/spec/models/{v1_api_keys_post_request_spec.rb → create_api_key_request_spec.rb} +6 -6
  201. data/spec/models/{v1_domains_post_request_spec.rb → create_domain_request_spec.rb} +6 -6
  202. data/spec/models/{v1_mailboxes_post_request_spec.rb → create_mailbox_request_spec.rb} +6 -6
  203. data/spec/models/{v1_suppressions_post_request_spec.rb → create_suppression_request_spec.rb} +6 -6
  204. data/spec/models/{v1_webhooks_post_request_spec.rb → create_webhook_request_spec.rb} +6 -6
  205. data/spec/models/draft_list_spec.rb +36 -0
  206. data/spec/models/draft_result_spec.rb +64 -0
  207. data/spec/models/draft_spec.rb +118 -0
  208. data/spec/models/{v1_mailboxes_email_export_post201_response_spec.rb → export_mailbox201_response_spec.rb} +6 -6
  209. data/spec/models/{v1_admin_me_get200_response_spec.rb → get_current_admin200_response_spec.rb} +6 -6
  210. data/spec/models/{v1_usage_get200_response_spec.rb → get_usage200_response_spec.rb} +6 -6
  211. data/spec/models/{healthz_get200_response_spec.rb → health_check200_response_spec.rb} +6 -6
  212. data/spec/models/inbox_list_spec.rb +36 -0
  213. data/spec/models/inbox_spec.rb +54 -0
  214. data/spec/models/injection_risk_spec.rb +42 -0
  215. data/spec/models/{v1_admins_post_request_spec.rb → invite_admin_request_spec.rb} +6 -6
  216. data/spec/models/{v1_aliases_get200_response_spec.rb → list_admins200_response_spec.rb} +6 -6
  217. data/spec/models/{v1_admins_get200_response_spec.rb → list_aliases200_response_spec.rb} +6 -6
  218. data/spec/models/{v1_api_keys_get200_response_spec.rb → list_api_keys200_response_spec.rb} +6 -6
  219. data/spec/models/list_domains200_response_spec.rb +36 -0
  220. data/spec/models/{v1_mailboxes_get200_response_spec.rb → list_mailboxes200_response_spec.rb} +6 -6
  221. data/spec/models/{v1_messages_get200_response_spec.rb → list_messages200_response_spec.rb} +6 -6
  222. data/spec/models/{v1_suppressions_get200_response_spec.rb → list_suppressions200_response_spec.rb} +6 -6
  223. data/spec/models/{v1_vacation_get200_response_spec.rb → list_templates200_response_spec.rb} +6 -6
  224. data/spec/models/list_vacation_responders200_response_spec.rb +36 -0
  225. data/spec/models/{v1_domains_get200_response_spec.rb → list_webhooks200_response_spec.rb} +6 -6
  226. data/spec/models/mailbox_grant_list_spec.rb +36 -0
  227. data/spec/models/mailbox_grant_spec.rb +42 -0
  228. data/spec/models/mark_read_result_spec.rb +36 -0
  229. data/spec/models/policy_flags_spec.rb +66 -0
  230. data/spec/models/{v1_send_post200_response_spec.rb → send_email200_response_spec.rb} +6 -6
  231. data/spec/models/{v1_send_post202_response_spec.rb → send_email202_response_spec.rb} +6 -6
  232. data/spec/models/{v1_templates_get200_response_spec.rb → send_email_batch200_response_spec.rb} +6 -6
  233. data/spec/models/{v1_send_batch_post_request_spec.rb → send_email_batch_request_spec.rb} +6 -6
  234. data/spec/models/{v1_send_post_request_attachments_inner_spec.rb → send_email_request_attachments_inner_spec.rb} +6 -6
  235. data/spec/models/{v1_send_post_request_spec.rb → send_email_request_spec.rb} +6 -6
  236. data/spec/models/{v1_mailboxes_email_vacation_put_request_spec.rb → set_vacation_responder_request_spec.rb} +6 -6
  237. data/spec/models/simulated_inbound_spec.rb +48 -0
  238. data/spec/models/{v1_inboxes_mailbox_messages_post_request_spec.rb → start_conversation_request_spec.rb} +6 -6
  239. data/spec/models/thread_classification_spec.rb +48 -0
  240. data/spec/models/thread_list_spec.rb +42 -0
  241. data/spec/models/thread_message_body_all_of_body_spec.rb +48 -0
  242. data/spec/models/thread_message_body_spec.rb +112 -0
  243. data/spec/models/thread_message_spec.rb +106 -0
  244. data/spec/models/thread_spec.rb +48 -0
  245. data/spec/models/thread_summary_spec.rb +70 -0
  246. data/spec/models/{v1_admins_id_patch_request_spec.rb → update_admin_request_spec.rb} +6 -6
  247. data/spec/models/{v1_mailboxes_email_patch_request_spec.rb → update_mailbox_request_spec.rb} +6 -6
  248. data/spec/models/{v1_webhooks_id_patch_request_spec.rb → update_webhook_request_spec.rb} +6 -6
  249. data/spec/models/whoami_spec.rb +54 -0
  250. metadata +258 -142
  251. data/lib/lockally/models/v1_webhooks_get200_response.rb +0 -166
  252. data/spec/models/v1_send_batch_post200_response_spec.rb +0 -36
  253. data/spec/models/v1_webhooks_get200_response_spec.rb +0 -36
data/docs/DomainsApi.md CHANGED
@@ -4,24 +4,24 @@ All URIs are relative to *https://api.lockally.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**v1_domains_domain_delete**](DomainsApi.md#v1_domains_domain_delete) | **DELETE** /v1/domains/{domain} | Delete a domain |
8
- | [**v1_domains_domain_get**](DomainsApi.md#v1_domains_domain_get) | **GET** /v1/domains/{domain} | Get a domain |
9
- | [**v1_domains_domain_return_path_delete**](DomainsApi.md#v1_domains_domain_return_path_delete) | **DELETE** /v1/domains/{domain}/return-path | Turn off the custom Return-Path |
10
- | [**v1_domains_domain_return_path_get**](DomainsApi.md#v1_domains_domain_return_path_get) | **GET** /v1/domains/{domain}/return-path | Get the custom Return-Path |
11
- | [**v1_domains_domain_return_path_post**](DomainsApi.md#v1_domains_domain_return_path_post) | **POST** /v1/domains/{domain}/return-path | Turn on the custom Return-Path |
12
- | [**v1_domains_domain_return_path_verify_post**](DomainsApi.md#v1_domains_domain_return_path_verify_post) | **POST** /v1/domains/{domain}/return-path/verify | Check the custom Return-Path records |
13
- | [**v1_domains_domain_verify_post**](DomainsApi.md#v1_domains_domain_verify_post) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification |
14
- | [**v1_domains_get**](DomainsApi.md#v1_domains_get) | **GET** /v1/domains | List domains |
15
- | [**v1_domains_post**](DomainsApi.md#v1_domains_post) | **POST** /v1/domains | Register a domain |
7
+ | [**create_domain**](DomainsApi.md#create_domain) | **POST** /v1/domains | Register a domain |
8
+ | [**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /v1/domains/{domain} | Delete a domain |
9
+ | [**disable_return_path**](DomainsApi.md#disable_return_path) | **DELETE** /v1/domains/{domain}/return-path | Turn off the custom Return-Path |
10
+ | [**enable_return_path**](DomainsApi.md#enable_return_path) | **POST** /v1/domains/{domain}/return-path | Turn on the custom Return-Path |
11
+ | [**get_domain**](DomainsApi.md#get_domain) | **GET** /v1/domains/{domain} | Get a domain |
12
+ | [**get_return_path**](DomainsApi.md#get_return_path) | **GET** /v1/domains/{domain}/return-path | Get the custom Return-Path |
13
+ | [**list_domains**](DomainsApi.md#list_domains) | **GET** /v1/domains | List domains |
14
+ | [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification |
15
+ | [**verify_return_path**](DomainsApi.md#verify_return_path) | **POST** /v1/domains/{domain}/return-path/verify | Check the custom Return-Path records |
16
16
 
17
17
 
18
- ## v1_domains_domain_delete
18
+ ## create_domain
19
19
 
20
- > v1_domains_domain_delete(domain)
20
+ > <Domain> create_domain(create_domain_request)
21
21
 
22
- Delete a domain
22
+ Register a domain
23
23
 
24
- Removes the domain registration. Refuses with 409 if any mailbox is still attached — delete the mailboxes first.
24
+ Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed). **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create. Returns 409 if the domain is already claimed by a different tenant.
25
25
 
26
26
  ### Examples
27
27
 
@@ -35,31 +35,32 @@ Lockally.configure do |config|
35
35
  end
36
36
 
37
37
  api_instance = Lockally::DomainsApi.new
38
- domain = 'domain_example' # String |
38
+ create_domain_request = Lockally::CreateDomainRequest.new({domain: 'acme.com'}) # CreateDomainRequest |
39
39
 
40
40
  begin
41
- # Delete a domain
42
- api_instance.v1_domains_domain_delete(domain)
41
+ # Register a domain
42
+ result = api_instance.create_domain(create_domain_request)
43
+ p result
43
44
  rescue Lockally::ApiError => e
44
- puts "Error when calling DomainsApi->v1_domains_domain_delete: #{e}"
45
+ puts "Error when calling DomainsApi->create_domain: #{e}"
45
46
  end
46
47
  ```
47
48
 
48
- #### Using the v1_domains_domain_delete_with_http_info variant
49
+ #### Using the create_domain_with_http_info variant
49
50
 
50
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
51
+ This returns an Array which contains the response data, status code and headers.
51
52
 
52
- > <Array(nil, Integer, Hash)> v1_domains_domain_delete_with_http_info(domain)
53
+ > <Array(<Domain>, Integer, Hash)> create_domain_with_http_info(create_domain_request)
53
54
 
54
55
  ```ruby
55
56
  begin
56
- # Delete a domain
57
- data, status_code, headers = api_instance.v1_domains_domain_delete_with_http_info(domain)
57
+ # Register a domain
58
+ data, status_code, headers = api_instance.create_domain_with_http_info(create_domain_request)
58
59
  p status_code # => 2xx
59
60
  p headers # => { ... }
60
- p data # => nil
61
+ p data # => <Domain>
61
62
  rescue Lockally::ApiError => e
62
- puts "Error when calling DomainsApi->v1_domains_domain_delete_with_http_info: #{e}"
63
+ puts "Error when calling DomainsApi->create_domain_with_http_info: #{e}"
63
64
  end
64
65
  ```
65
66
 
@@ -67,11 +68,11 @@ end
67
68
 
68
69
  | Name | Type | Description | Notes |
69
70
  | ---- | ---- | ----------- | ----- |
70
- | **domain** | **String** | | |
71
+ | **create_domain_request** | [**CreateDomainRequest**](CreateDomainRequest.md) | | |
71
72
 
72
73
  ### Return type
73
74
 
74
- nil (empty response body)
75
+ [**Domain**](Domain.md)
75
76
 
76
77
  ### Authorization
77
78
 
@@ -79,15 +80,17 @@ nil (empty response body)
79
80
 
80
81
  ### HTTP request headers
81
82
 
82
- - **Content-Type**: Not defined
83
- - **Accept**: application/problem+json
83
+ - **Content-Type**: application/json
84
+ - **Accept**: application/json, application/problem+json
84
85
 
85
86
 
86
- ## v1_domains_domain_get
87
+ ## delete_domain
87
88
 
88
- > <Domain> v1_domains_domain_get(domain)
89
+ > delete_domain(domain)
89
90
 
90
- Get a domain
91
+ Delete a domain
92
+
93
+ Removes the domain registration. Refuses with 409 if any mailbox is still attached — delete the mailboxes first.
91
94
 
92
95
  ### Examples
93
96
 
@@ -104,29 +107,28 @@ api_instance = Lockally::DomainsApi.new
104
107
  domain = 'domain_example' # String |
105
108
 
106
109
  begin
107
- # Get a domain
108
- result = api_instance.v1_domains_domain_get(domain)
109
- p result
110
+ # Delete a domain
111
+ api_instance.delete_domain(domain)
110
112
  rescue Lockally::ApiError => e
111
- puts "Error when calling DomainsApi->v1_domains_domain_get: #{e}"
113
+ puts "Error when calling DomainsApi->delete_domain: #{e}"
112
114
  end
113
115
  ```
114
116
 
115
- #### Using the v1_domains_domain_get_with_http_info variant
117
+ #### Using the delete_domain_with_http_info variant
116
118
 
117
- This returns an Array which contains the response data, status code and headers.
119
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
118
120
 
119
- > <Array(<Domain>, Integer, Hash)> v1_domains_domain_get_with_http_info(domain)
121
+ > <Array(nil, Integer, Hash)> delete_domain_with_http_info(domain)
120
122
 
121
123
  ```ruby
122
124
  begin
123
- # Get a domain
124
- data, status_code, headers = api_instance.v1_domains_domain_get_with_http_info(domain)
125
+ # Delete a domain
126
+ data, status_code, headers = api_instance.delete_domain_with_http_info(domain)
125
127
  p status_code # => 2xx
126
128
  p headers # => { ... }
127
- p data # => <Domain>
129
+ p data # => nil
128
130
  rescue Lockally::ApiError => e
129
- puts "Error when calling DomainsApi->v1_domains_domain_get_with_http_info: #{e}"
131
+ puts "Error when calling DomainsApi->delete_domain_with_http_info: #{e}"
130
132
  end
131
133
  ```
132
134
 
@@ -138,7 +140,7 @@ end
138
140
 
139
141
  ### Return type
140
142
 
141
- [**Domain**](Domain.md)
143
+ nil (empty response body)
142
144
 
143
145
  ### Authorization
144
146
 
@@ -147,12 +149,12 @@ end
147
149
  ### HTTP request headers
148
150
 
149
151
  - **Content-Type**: Not defined
150
- - **Accept**: application/json, application/problem+json
152
+ - **Accept**: application/problem+json
151
153
 
152
154
 
153
- ## v1_domains_domain_return_path_delete
155
+ ## disable_return_path
154
156
 
155
- > v1_domains_domain_return_path_delete(domain)
157
+ > disable_return_path(domain)
156
158
 
157
159
  Turn off the custom Return-Path
158
160
 
@@ -174,27 +176,27 @@ domain = 'domain_example' # String |
174
176
 
175
177
  begin
176
178
  # Turn off the custom Return-Path
177
- api_instance.v1_domains_domain_return_path_delete(domain)
179
+ api_instance.disable_return_path(domain)
178
180
  rescue Lockally::ApiError => e
179
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_delete: #{e}"
181
+ puts "Error when calling DomainsApi->disable_return_path: #{e}"
180
182
  end
181
183
  ```
182
184
 
183
- #### Using the v1_domains_domain_return_path_delete_with_http_info variant
185
+ #### Using the disable_return_path_with_http_info variant
184
186
 
185
187
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
186
188
 
187
- > <Array(nil, Integer, Hash)> v1_domains_domain_return_path_delete_with_http_info(domain)
189
+ > <Array(nil, Integer, Hash)> disable_return_path_with_http_info(domain)
188
190
 
189
191
  ```ruby
190
192
  begin
191
193
  # Turn off the custom Return-Path
192
- data, status_code, headers = api_instance.v1_domains_domain_return_path_delete_with_http_info(domain)
194
+ data, status_code, headers = api_instance.disable_return_path_with_http_info(domain)
193
195
  p status_code # => 2xx
194
196
  p headers # => { ... }
195
197
  p data # => nil
196
198
  rescue Lockally::ApiError => e
197
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_delete_with_http_info: #{e}"
199
+ puts "Error when calling DomainsApi->disable_return_path_with_http_info: #{e}"
198
200
  end
199
201
  ```
200
202
 
@@ -218,13 +220,13 @@ nil (empty response body)
218
220
  - **Accept**: application/problem+json
219
221
 
220
222
 
221
- ## v1_domains_domain_return_path_get
223
+ ## enable_return_path
222
224
 
223
- > <ReturnPath> v1_domains_domain_return_path_get(domain)
225
+ > <ReturnPath> enable_return_path(domain)
224
226
 
225
- Get the custom Return-Path
227
+ Turn on the custom Return-Path
226
228
 
227
- A custom Return-Path moves the envelope sender of mail sent through the API from this domain onto `bounces.<domain>`. Bounce reports then come back to Lockally instead of the sending mailbox, and a bounce that arrives after delivery marks the message bounced, suppresses the address and fires `delivery.bounced`. Mail sent from webmail or mail apps is not affected. DKIM stays signed by the domain itself. `status` is `off`, `pending` (records not confirmed yet) or `active`.
229
+ Moves it to `pending` and returns the two records to publish on `bounces.<domain>`. Nothing changes for mail until they are confirmed with the verify call. The domain must be verified. Available on every plan except Free.
228
230
 
229
231
  ### Examples
230
232
 
@@ -241,29 +243,29 @@ api_instance = Lockally::DomainsApi.new
241
243
  domain = 'domain_example' # String |
242
244
 
243
245
  begin
244
- # Get the custom Return-Path
245
- result = api_instance.v1_domains_domain_return_path_get(domain)
246
+ # Turn on the custom Return-Path
247
+ result = api_instance.enable_return_path(domain)
246
248
  p result
247
249
  rescue Lockally::ApiError => e
248
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_get: #{e}"
250
+ puts "Error when calling DomainsApi->enable_return_path: #{e}"
249
251
  end
250
252
  ```
251
253
 
252
- #### Using the v1_domains_domain_return_path_get_with_http_info variant
254
+ #### Using the enable_return_path_with_http_info variant
253
255
 
254
256
  This returns an Array which contains the response data, status code and headers.
255
257
 
256
- > <Array(<ReturnPath>, Integer, Hash)> v1_domains_domain_return_path_get_with_http_info(domain)
258
+ > <Array(<ReturnPath>, Integer, Hash)> enable_return_path_with_http_info(domain)
257
259
 
258
260
  ```ruby
259
261
  begin
260
- # Get the custom Return-Path
261
- data, status_code, headers = api_instance.v1_domains_domain_return_path_get_with_http_info(domain)
262
+ # Turn on the custom Return-Path
263
+ data, status_code, headers = api_instance.enable_return_path_with_http_info(domain)
262
264
  p status_code # => 2xx
263
265
  p headers # => { ... }
264
266
  p data # => <ReturnPath>
265
267
  rescue Lockally::ApiError => e
266
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_get_with_http_info: #{e}"
268
+ puts "Error when calling DomainsApi->enable_return_path_with_http_info: #{e}"
267
269
  end
268
270
  ```
269
271
 
@@ -287,13 +289,11 @@ end
287
289
  - **Accept**: application/json, application/problem+json
288
290
 
289
291
 
290
- ## v1_domains_domain_return_path_post
292
+ ## get_domain
291
293
 
292
- > <ReturnPath> v1_domains_domain_return_path_post(domain)
294
+ > <Domain> get_domain(domain)
293
295
 
294
- Turn on the custom Return-Path
295
-
296
- Moves it to `pending` and returns the two records to publish on `bounces.<domain>`. Nothing changes for mail until they are confirmed with the verify call. The domain must be verified. Available on every plan except Free.
296
+ Get a domain
297
297
 
298
298
  ### Examples
299
299
 
@@ -310,29 +310,29 @@ api_instance = Lockally::DomainsApi.new
310
310
  domain = 'domain_example' # String |
311
311
 
312
312
  begin
313
- # Turn on the custom Return-Path
314
- result = api_instance.v1_domains_domain_return_path_post(domain)
313
+ # Get a domain
314
+ result = api_instance.get_domain(domain)
315
315
  p result
316
316
  rescue Lockally::ApiError => e
317
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_post: #{e}"
317
+ puts "Error when calling DomainsApi->get_domain: #{e}"
318
318
  end
319
319
  ```
320
320
 
321
- #### Using the v1_domains_domain_return_path_post_with_http_info variant
321
+ #### Using the get_domain_with_http_info variant
322
322
 
323
323
  This returns an Array which contains the response data, status code and headers.
324
324
 
325
- > <Array(<ReturnPath>, Integer, Hash)> v1_domains_domain_return_path_post_with_http_info(domain)
325
+ > <Array(<Domain>, Integer, Hash)> get_domain_with_http_info(domain)
326
326
 
327
327
  ```ruby
328
328
  begin
329
- # Turn on the custom Return-Path
330
- data, status_code, headers = api_instance.v1_domains_domain_return_path_post_with_http_info(domain)
329
+ # Get a domain
330
+ data, status_code, headers = api_instance.get_domain_with_http_info(domain)
331
331
  p status_code # => 2xx
332
332
  p headers # => { ... }
333
- p data # => <ReturnPath>
333
+ p data # => <Domain>
334
334
  rescue Lockally::ApiError => e
335
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_post_with_http_info: #{e}"
335
+ puts "Error when calling DomainsApi->get_domain_with_http_info: #{e}"
336
336
  end
337
337
  ```
338
338
 
@@ -344,7 +344,7 @@ end
344
344
 
345
345
  ### Return type
346
346
 
347
- [**ReturnPath**](ReturnPath.md)
347
+ [**Domain**](Domain.md)
348
348
 
349
349
  ### Authorization
350
350
 
@@ -356,13 +356,13 @@ end
356
356
  - **Accept**: application/json, application/problem+json
357
357
 
358
358
 
359
- ## v1_domains_domain_return_path_verify_post
359
+ ## get_return_path
360
360
 
361
- > <ReturnPath> v1_domains_domain_return_path_verify_post(domain)
361
+ > <ReturnPath> get_return_path(domain)
362
362
 
363
- Check the custom Return-Path records
363
+ Get the custom Return-Path
364
364
 
365
- Looks up the MX and SPF records on `bounces.<domain>`. Returns 200 either way: while a record is missing the status stays `pending` and `check` says which one. Once both are found the Return-Path becomes `active` and the send path starts using it.
365
+ A custom Return-Path moves the envelope sender of mail sent through the API from this domain onto `bounces.<domain>`. Bounce reports then come back to Lockally instead of the sending mailbox, and a bounce that arrives after delivery marks the message bounced, suppresses the address and fires `delivery.bounced`. Mail sent from webmail or mail apps is not affected. DKIM stays signed by the domain itself. `status` is `off`, `pending` (records not confirmed yet) or `active`.
366
366
 
367
367
  ### Examples
368
368
 
@@ -379,29 +379,29 @@ api_instance = Lockally::DomainsApi.new
379
379
  domain = 'domain_example' # String |
380
380
 
381
381
  begin
382
- # Check the custom Return-Path records
383
- result = api_instance.v1_domains_domain_return_path_verify_post(domain)
382
+ # Get the custom Return-Path
383
+ result = api_instance.get_return_path(domain)
384
384
  p result
385
385
  rescue Lockally::ApiError => e
386
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_verify_post: #{e}"
386
+ puts "Error when calling DomainsApi->get_return_path: #{e}"
387
387
  end
388
388
  ```
389
389
 
390
- #### Using the v1_domains_domain_return_path_verify_post_with_http_info variant
390
+ #### Using the get_return_path_with_http_info variant
391
391
 
392
392
  This returns an Array which contains the response data, status code and headers.
393
393
 
394
- > <Array(<ReturnPath>, Integer, Hash)> v1_domains_domain_return_path_verify_post_with_http_info(domain)
394
+ > <Array(<ReturnPath>, Integer, Hash)> get_return_path_with_http_info(domain)
395
395
 
396
396
  ```ruby
397
397
  begin
398
- # Check the custom Return-Path records
399
- data, status_code, headers = api_instance.v1_domains_domain_return_path_verify_post_with_http_info(domain)
398
+ # Get the custom Return-Path
399
+ data, status_code, headers = api_instance.get_return_path_with_http_info(domain)
400
400
  p status_code # => 2xx
401
401
  p headers # => { ... }
402
402
  p data # => <ReturnPath>
403
403
  rescue Lockally::ApiError => e
404
- puts "Error when calling DomainsApi->v1_domains_domain_return_path_verify_post_with_http_info: #{e}"
404
+ puts "Error when calling DomainsApi->get_return_path_with_http_info: #{e}"
405
405
  end
406
406
  ```
407
407
 
@@ -425,13 +425,13 @@ end
425
425
  - **Accept**: application/json, application/problem+json
426
426
 
427
427
 
428
- ## v1_domains_domain_verify_post
428
+ ## list_domains
429
429
 
430
- > <Domain> v1_domains_domain_verify_post(domain)
430
+ > <ListDomains200Response> list_domains
431
431
 
432
- Force-poll DNS verification
432
+ List domains
433
433
 
434
- Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook.
434
+ Returns every domain registered under the calling tenant.
435
435
 
436
436
  ### Examples
437
437
 
@@ -445,44 +445,41 @@ Lockally.configure do |config|
445
445
  end
446
446
 
447
447
  api_instance = Lockally::DomainsApi.new
448
- domain = 'domain_example' # String |
449
448
 
450
449
  begin
451
- # Force-poll DNS verification
452
- result = api_instance.v1_domains_domain_verify_post(domain)
450
+ # List domains
451
+ result = api_instance.list_domains
453
452
  p result
454
453
  rescue Lockally::ApiError => e
455
- puts "Error when calling DomainsApi->v1_domains_domain_verify_post: #{e}"
454
+ puts "Error when calling DomainsApi->list_domains: #{e}"
456
455
  end
457
456
  ```
458
457
 
459
- #### Using the v1_domains_domain_verify_post_with_http_info variant
458
+ #### Using the list_domains_with_http_info variant
460
459
 
461
460
  This returns an Array which contains the response data, status code and headers.
462
461
 
463
- > <Array(<Domain>, Integer, Hash)> v1_domains_domain_verify_post_with_http_info(domain)
462
+ > <Array(<ListDomains200Response>, Integer, Hash)> list_domains_with_http_info
464
463
 
465
464
  ```ruby
466
465
  begin
467
- # Force-poll DNS verification
468
- data, status_code, headers = api_instance.v1_domains_domain_verify_post_with_http_info(domain)
466
+ # List domains
467
+ data, status_code, headers = api_instance.list_domains_with_http_info
469
468
  p status_code # => 2xx
470
469
  p headers # => { ... }
471
- p data # => <Domain>
470
+ p data # => <ListDomains200Response>
472
471
  rescue Lockally::ApiError => e
473
- puts "Error when calling DomainsApi->v1_domains_domain_verify_post_with_http_info: #{e}"
472
+ puts "Error when calling DomainsApi->list_domains_with_http_info: #{e}"
474
473
  end
475
474
  ```
476
475
 
477
476
  ### Parameters
478
477
 
479
- | Name | Type | Description | Notes |
480
- | ---- | ---- | ----------- | ----- |
481
- | **domain** | **String** | | |
478
+ This endpoint does not need any parameter.
482
479
 
483
480
  ### Return type
484
481
 
485
- [**Domain**](Domain.md)
482
+ [**ListDomains200Response**](ListDomains200Response.md)
486
483
 
487
484
  ### Authorization
488
485
 
@@ -494,13 +491,13 @@ end
494
491
  - **Accept**: application/json, application/problem+json
495
492
 
496
493
 
497
- ## v1_domains_get
494
+ ## verify_domain
498
495
 
499
- > <V1DomainsGet200Response> v1_domains_get
496
+ > <Domain> verify_domain(domain)
500
497
 
501
- List domains
498
+ Force-poll DNS verification
502
499
 
503
- Returns every domain registered under the calling tenant.
500
+ Synchronously checks the `_lockally-verify.<domain>` TXT record against the stored verification token. Returns 200 either way: the returned `verified` boolean tells you whether DNS now confirms. Caller polls until `verified: true`. In v2 a background worker auto-polls and fires a `domain.verified` webhook.
504
501
 
505
502
  ### Examples
506
503
 
@@ -514,41 +511,44 @@ Lockally.configure do |config|
514
511
  end
515
512
 
516
513
  api_instance = Lockally::DomainsApi.new
514
+ domain = 'domain_example' # String |
517
515
 
518
516
  begin
519
- # List domains
520
- result = api_instance.v1_domains_get
517
+ # Force-poll DNS verification
518
+ result = api_instance.verify_domain(domain)
521
519
  p result
522
520
  rescue Lockally::ApiError => e
523
- puts "Error when calling DomainsApi->v1_domains_get: #{e}"
521
+ puts "Error when calling DomainsApi->verify_domain: #{e}"
524
522
  end
525
523
  ```
526
524
 
527
- #### Using the v1_domains_get_with_http_info variant
525
+ #### Using the verify_domain_with_http_info variant
528
526
 
529
527
  This returns an Array which contains the response data, status code and headers.
530
528
 
531
- > <Array(<V1DomainsGet200Response>, Integer, Hash)> v1_domains_get_with_http_info
529
+ > <Array(<Domain>, Integer, Hash)> verify_domain_with_http_info(domain)
532
530
 
533
531
  ```ruby
534
532
  begin
535
- # List domains
536
- data, status_code, headers = api_instance.v1_domains_get_with_http_info
533
+ # Force-poll DNS verification
534
+ data, status_code, headers = api_instance.verify_domain_with_http_info(domain)
537
535
  p status_code # => 2xx
538
536
  p headers # => { ... }
539
- p data # => <V1DomainsGet200Response>
537
+ p data # => <Domain>
540
538
  rescue Lockally::ApiError => e
541
- puts "Error when calling DomainsApi->v1_domains_get_with_http_info: #{e}"
539
+ puts "Error when calling DomainsApi->verify_domain_with_http_info: #{e}"
542
540
  end
543
541
  ```
544
542
 
545
543
  ### Parameters
546
544
 
547
- This endpoint does not need any parameter.
545
+ | Name | Type | Description | Notes |
546
+ | ---- | ---- | ----------- | ----- |
547
+ | **domain** | **String** | | |
548
548
 
549
549
  ### Return type
550
550
 
551
- [**V1DomainsGet200Response**](V1DomainsGet200Response.md)
551
+ [**Domain**](Domain.md)
552
552
 
553
553
  ### Authorization
554
554
 
@@ -560,13 +560,13 @@ This endpoint does not need any parameter.
560
560
  - **Accept**: application/json, application/problem+json
561
561
 
562
562
 
563
- ## v1_domains_post
563
+ ## verify_return_path
564
564
 
565
- > <Domain> v1_domains_post(v1_domains_post_request)
565
+ > <ReturnPath> verify_return_path(domain)
566
566
 
567
- Register a domain
567
+ Check the custom Return-Path records
568
568
 
569
- Registers a new domain for the calling tenant. Generates a DKIM keypair and verification token. Returns DNS instructions the tenant must publish under their own DNS (verification TXT, SPF include, DKIM TXT, MX records to `mx1`/`mx2.lockally.com`, DMARC seed). **Idempotent** — re-posting the same domain returns the existing record with the same DKIM keys and token (regenerating would break the tenant's published DNS). Returns 200 on idempotent hit, 201 on first create. Returns 409 if the domain is already claimed by a different tenant.
569
+ Looks up the MX and SPF records on `bounces.<domain>`. Returns 200 either way: while a record is missing the status stays `pending` and `check` says which one. Once both are found the Return-Path becomes `active` and the send path starts using it.
570
570
 
571
571
  ### Examples
572
572
 
@@ -580,32 +580,32 @@ Lockally.configure do |config|
580
580
  end
581
581
 
582
582
  api_instance = Lockally::DomainsApi.new
583
- v1_domains_post_request = Lockally::V1DomainsPostRequest.new({domain: 'acme.com'}) # V1DomainsPostRequest |
583
+ domain = 'domain_example' # String |
584
584
 
585
585
  begin
586
- # Register a domain
587
- result = api_instance.v1_domains_post(v1_domains_post_request)
586
+ # Check the custom Return-Path records
587
+ result = api_instance.verify_return_path(domain)
588
588
  p result
589
589
  rescue Lockally::ApiError => e
590
- puts "Error when calling DomainsApi->v1_domains_post: #{e}"
590
+ puts "Error when calling DomainsApi->verify_return_path: #{e}"
591
591
  end
592
592
  ```
593
593
 
594
- #### Using the v1_domains_post_with_http_info variant
594
+ #### Using the verify_return_path_with_http_info variant
595
595
 
596
596
  This returns an Array which contains the response data, status code and headers.
597
597
 
598
- > <Array(<Domain>, Integer, Hash)> v1_domains_post_with_http_info(v1_domains_post_request)
598
+ > <Array(<ReturnPath>, Integer, Hash)> verify_return_path_with_http_info(domain)
599
599
 
600
600
  ```ruby
601
601
  begin
602
- # Register a domain
603
- data, status_code, headers = api_instance.v1_domains_post_with_http_info(v1_domains_post_request)
602
+ # Check the custom Return-Path records
603
+ data, status_code, headers = api_instance.verify_return_path_with_http_info(domain)
604
604
  p status_code # => 2xx
605
605
  p headers # => { ... }
606
- p data # => <Domain>
606
+ p data # => <ReturnPath>
607
607
  rescue Lockally::ApiError => e
608
- puts "Error when calling DomainsApi->v1_domains_post_with_http_info: #{e}"
608
+ puts "Error when calling DomainsApi->verify_return_path_with_http_info: #{e}"
609
609
  end
610
610
  ```
611
611
 
@@ -613,11 +613,11 @@ end
613
613
 
614
614
  | Name | Type | Description | Notes |
615
615
  | ---- | ---- | ----------- | ----- |
616
- | **v1_domains_post_request** | [**V1DomainsPostRequest**](V1DomainsPostRequest.md) | | |
616
+ | **domain** | **String** | | |
617
617
 
618
618
  ### Return type
619
619
 
620
- [**Domain**](Domain.md)
620
+ [**ReturnPath**](ReturnPath.md)
621
621
 
622
622
  ### Authorization
623
623
 
@@ -625,6 +625,6 @@ end
625
625
 
626
626
  ### HTTP request headers
627
627
 
628
- - **Content-Type**: application/json
628
+ - **Content-Type**: Not defined
629
629
  - **Accept**: application/json, application/problem+json
630
630
 
data/docs/Draft.md ADDED
@@ -0,0 +1,44 @@
1
+ # Lockally::Draft
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **mailbox_id** | **String** | | |
9
+ | **mailbox** | **String** | | [optional] |
10
+ | **thread_id** | **String** | | [optional] |
11
+ | **to** | **Array&lt;String&gt;** | | |
12
+ | **cc** | **Array&lt;String&gt;** | | [optional] |
13
+ | **subject** | **String** | | [optional] |
14
+ | **body_text** | **String** | | [optional] |
15
+ | **status** | **String** | | |
16
+ | **policy_flags** | [**PolicyFlags**](PolicyFlags.md) | | |
17
+ | **reviewed_at** | **Time** | | [optional] |
18
+ | **sent_message_id** | **String** | | [optional] |
19
+ | **created_at** | **Time** | | |
20
+ | **updated_at** | **Time** | | |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'lockally'
26
+
27
+ instance = Lockally::Draft.new(
28
+ id: null,
29
+ mailbox_id: null,
30
+ mailbox: null,
31
+ thread_id: null,
32
+ to: null,
33
+ cc: null,
34
+ subject: null,
35
+ body_text: null,
36
+ status: null,
37
+ policy_flags: null,
38
+ reviewed_at: null,
39
+ sent_message_id: null,
40
+ created_at: null,
41
+ updated_at: null
42
+ )
43
+ ```
44
+