lockally 0.2.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 (238) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +143 -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/ApiKeysApi.md +59 -59
  14. data/docs/ContactLookup.md +26 -0
  15. data/docs/ContactLookupContact.md +28 -0
  16. data/docs/ContactLookupHistory.md +22 -0
  17. data/docs/CreateAiUnitsCheckout200Response.md +22 -0
  18. data/docs/{V1AliasesPostRequest.md → CreateAliasRequest.md} +2 -2
  19. data/docs/{V1ApiKeysPost201Response.md → CreateApiKey201Response.md} +2 -2
  20. data/docs/{V1ApiKeysPostRequest.md → CreateApiKeyRequest.md} +2 -2
  21. data/docs/{V1DomainsPostRequest.md → CreateDomainRequest.md} +2 -2
  22. data/docs/{V1MailboxesPostRequest.md → CreateMailboxRequest.md} +2 -2
  23. data/docs/{V1SuppressionsPostRequest.md → CreateSuppressionRequest.md} +2 -2
  24. data/docs/{V1WebhooksPostRequest.md → CreateWebhookRequest.md} +2 -2
  25. data/docs/DomainsApi.md +141 -141
  26. data/docs/Draft.md +44 -0
  27. data/docs/DraftList.md +18 -0
  28. data/docs/DraftResult.md +26 -0
  29. data/docs/DraftsApi.md +115 -115
  30. data/docs/{V1MailboxesEmailExportPost201Response.md → ExportMailbox201Response.md} +2 -2
  31. data/docs/{V1AdminMeGet200Response.md → GetCurrentAdmin200Response.md} +2 -2
  32. data/docs/{V1UsageGet200Response.md → GetUsage200Response.md} +2 -2
  33. data/docs/HealthApi.md +11 -11
  34. data/docs/{HealthzGet200Response.md → HealthCheck200Response.md} +2 -2
  35. data/docs/Inbox.md +24 -0
  36. data/docs/InboxList.md +18 -0
  37. data/docs/{V1AdminsPostRequest.md → InviteAdminRequest.md} +2 -2
  38. data/docs/{V1AdminsGet200Response.md → ListAdmins200Response.md} +2 -2
  39. data/docs/{V1AliasesGet200Response.md → ListAliases200Response.md} +2 -2
  40. data/docs/{V1ApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
  41. data/docs/{V1DomainsGet200Response.md → ListDomains200Response.md} +2 -2
  42. data/docs/{V1MailboxesGet200Response.md → ListMailboxes200Response.md} +2 -2
  43. data/docs/{V1MessagesGet200Response.md → ListMessages200Response.md} +2 -2
  44. data/docs/{V1SuppressionsGet200Response.md → ListSuppressions200Response.md} +2 -2
  45. data/docs/{V1TemplatesGet200Response.md → ListTemplates200Response.md} +2 -2
  46. data/docs/{V1VacationGet200Response.md → ListVacationResponders200Response.md} +2 -2
  47. data/docs/{V1WebhooksGet200Response.md → ListWebhooks200Response.md} +2 -2
  48. data/docs/MailboxGrant.md +20 -0
  49. data/docs/MailboxGrantList.md +18 -0
  50. data/docs/MailboxesApi.md +203 -203
  51. data/docs/MarkReadResult.md +18 -0
  52. data/docs/SendApi.md +121 -121
  53. data/docs/{V1SendPost200Response.md → SendEmail200Response.md} +2 -2
  54. data/docs/{V1SendPost202Response.md → SendEmail202Response.md} +2 -2
  55. data/docs/{V1SendBatchPost200Response.md → SendEmailBatch200Response.md} +2 -2
  56. data/docs/{V1SendBatchPostRequest.md → SendEmailBatchRequest.md} +2 -2
  57. data/docs/{V1SendPostRequest.md → SendEmailRequest.md} +3 -3
  58. data/docs/{V1SendPostRequestAttachmentsInner.md → SendEmailRequestAttachmentsInner.md} +2 -2
  59. data/docs/SendMessage.md +1 -1
  60. data/docs/{V1MailboxesEmailVacationPutRequest.md → SetVacationResponderRequest.md} +2 -2
  61. data/docs/SignupApi.md +4 -4
  62. data/docs/SimulatedInbound.md +22 -0
  63. data/docs/{V1InboxesMailboxMessagesPostRequest.md → StartConversationRequest.md} +2 -2
  64. data/docs/SuppressionsApi.md +75 -75
  65. data/docs/TemplatesApi.md +67 -67
  66. data/docs/TenantApi.md +20 -20
  67. data/docs/TestApi.md +11 -11
  68. data/docs/Thread.md +22 -0
  69. data/docs/ThreadClassification.md +22 -0
  70. data/docs/ThreadList.md +20 -0
  71. data/docs/ThreadMessage.md +40 -0
  72. data/docs/ThreadMessageBody.md +42 -0
  73. data/docs/ThreadMessageBodyAllOfBody.md +22 -0
  74. data/docs/ThreadSummary.md +28 -0
  75. data/docs/{V1AdminsIdPatchRequest.md → UpdateAdminRequest.md} +2 -2
  76. data/docs/{V1MailboxesEmailPatchRequest.md → UpdateMailboxRequest.md} +2 -2
  77. data/docs/{V1WebhooksIdPatchRequest.md → UpdateWebhookRequest.md} +2 -2
  78. data/docs/WebhooksApi.md +63 -63
  79. data/docs/Whoami.md +24 -0
  80. data/lib/lockally/api/admin_api.rb +30 -30
  81. data/lib/lockally/api/admins_api.rb +89 -89
  82. data/lib/lockally/api/agents_api.rb +309 -309
  83. data/lib/lockally/api/ai_api.rb +69 -69
  84. data/lib/lockally/api/aliases_api.rb +64 -64
  85. data/lib/lockally/api/api_keys_api.rb +66 -66
  86. data/lib/lockally/api/domains_api.rb +147 -147
  87. data/lib/lockally/api/drafts_api.rb +140 -140
  88. data/lib/lockally/api/health_api.rb +9 -9
  89. data/lib/lockally/api/mailboxes_api.rb +233 -233
  90. data/lib/lockally/api/send_api.rb +146 -146
  91. data/lib/lockally/api/signup_api.rb +3 -3
  92. data/lib/lockally/api/suppressions_api.rb +87 -87
  93. data/lib/lockally/api/templates_api.rb +69 -69
  94. data/lib/lockally/api/tenant_api.rb +15 -15
  95. data/lib/lockally/api/test_api.rb +9 -9
  96. data/lib/lockally/api/webhooks_api.rb +73 -73
  97. data/lib/lockally/models/{v1_admin_login_post200_response.rb → admin_login200_response.rb} +3 -3
  98. data/lib/lockally/models/{v1_admin_login_post_request.rb → admin_login_request.rb} +3 -3
  99. data/lib/lockally/models/agent_send_result.rb +184 -0
  100. data/lib/lockally/models/ai_config.rb +242 -0
  101. data/lib/lockally/models/ai_config_update.rb +214 -0
  102. data/lib/lockally/models/contact_lookup.rb +235 -0
  103. data/lib/lockally/models/contact_lookup_contact.rb +192 -0
  104. data/lib/lockally/models/contact_lookup_history.rb +166 -0
  105. data/lib/lockally/models/create_ai_units_checkout200_response.rb +199 -0
  106. data/lib/lockally/models/{v1_aliases_post_request.rb → create_alias_request.rb} +3 -3
  107. data/lib/lockally/models/{v1_api_keys_post201_response.rb → create_api_key201_response.rb} +3 -3
  108. data/lib/lockally/models/{v1_api_keys_post_request.rb → create_api_key_request.rb} +3 -3
  109. data/lib/lockally/models/{v1_domains_post_request.rb → create_domain_request.rb} +3 -3
  110. data/lib/lockally/models/{v1_mailboxes_post_request.rb → create_mailbox_request.rb} +3 -3
  111. data/lib/lockally/models/{v1_suppressions_post_request.rb → create_suppression_request.rb} +3 -3
  112. data/lib/lockally/models/{v1_webhooks_post_request.rb → create_webhook_request.rb} +3 -3
  113. data/lib/lockally/models/draft.rb +413 -0
  114. data/lib/lockally/models/draft_list.rb +166 -0
  115. data/lib/lockally/models/draft_result.rb +260 -0
  116. data/lib/lockally/models/{v1_mailboxes_email_export_post201_response.rb → export_mailbox201_response.rb} +3 -3
  117. data/lib/lockally/models/{v1_admin_me_get200_response.rb → get_current_admin200_response.rb} +3 -3
  118. data/lib/lockally/models/{v1_usage_get200_response.rb → get_usage200_response.rb} +3 -3
  119. data/lib/lockally/models/{healthz_get200_response.rb → health_check200_response.rb} +3 -3
  120. data/lib/lockally/models/inbox.rb +225 -0
  121. data/lib/lockally/models/inbox_list.rb +166 -0
  122. data/lib/lockally/models/{v1_admins_post_request.rb → invite_admin_request.rb} +3 -3
  123. data/lib/lockally/models/list_admins200_response.rb +166 -0
  124. data/lib/lockally/models/{v1_aliases_get200_response.rb → list_aliases200_response.rb} +3 -3
  125. data/lib/lockally/models/{v1_admins_get200_response.rb → list_api_keys200_response.rb} +4 -4
  126. data/lib/lockally/models/{v1_domains_get200_response.rb → list_domains200_response.rb} +3 -3
  127. data/lib/lockally/models/{v1_mailboxes_get200_response.rb → list_mailboxes200_response.rb} +3 -3
  128. data/lib/lockally/models/{v1_messages_get200_response.rb → list_messages200_response.rb} +3 -3
  129. data/lib/lockally/models/{v1_suppressions_get200_response.rb → list_suppressions200_response.rb} +3 -3
  130. data/lib/lockally/models/{v1_send_batch_post200_response.rb → list_templates200_response.rb} +4 -4
  131. data/lib/lockally/models/{v1_vacation_get200_response.rb → list_vacation_responders200_response.rb} +3 -3
  132. data/lib/lockally/models/{v1_api_keys_get200_response.rb → list_webhooks200_response.rb} +4 -4
  133. data/lib/lockally/models/mailbox_grant.rb +156 -0
  134. data/lib/lockally/models/mailbox_grant_list.rb +166 -0
  135. data/lib/lockally/models/mark_read_result.rb +147 -0
  136. data/lib/lockally/models/{v1_send_post200_response.rb → send_email200_response.rb} +3 -3
  137. data/lib/lockally/models/{v1_send_post202_response.rb → send_email202_response.rb} +3 -3
  138. data/lib/lockally/models/{v1_templates_get200_response.rb → send_email_batch200_response.rb} +4 -4
  139. data/lib/lockally/models/{v1_send_batch_post_request.rb → send_email_batch_request.rb} +3 -3
  140. data/lib/lockally/models/{v1_send_post_request.rb → send_email_request.rb} +4 -4
  141. data/lib/lockally/models/{v1_send_post_request_attachments_inner.rb → send_email_request_attachments_inner.rb} +3 -3
  142. data/lib/lockally/models/send_message.rb +1 -1
  143. data/lib/lockally/models/{v1_mailboxes_email_vacation_put_request.rb → set_vacation_responder_request.rb} +3 -3
  144. data/lib/lockally/models/simulated_inbound.rb +167 -0
  145. data/lib/lockally/models/{v1_inboxes_mailbox_messages_post_request.rb → start_conversation_request.rb} +3 -3
  146. data/lib/lockally/models/thread.rb +219 -0
  147. data/lib/lockally/models/thread_classification.rb +186 -0
  148. data/lib/lockally/models/thread_list.rb +192 -0
  149. data/lib/lockally/models/thread_message.rb +397 -0
  150. data/lib/lockally/models/thread_message_body.rb +413 -0
  151. data/lib/lockally/models/thread_message_body_all_of_body.rb +165 -0
  152. data/lib/lockally/models/thread_summary.rb +280 -0
  153. data/lib/lockally/models/{v1_admins_id_patch_request.rb → update_admin_request.rb} +3 -3
  154. data/lib/lockally/models/{v1_mailboxes_email_patch_request.rb → update_mailbox_request.rb} +3 -3
  155. data/lib/lockally/models/{v1_webhooks_id_patch_request.rb → update_webhook_request.rb} +3 -3
  156. data/lib/lockally/models/whoami.rb +177 -0
  157. data/lib/lockally/version.rb +1 -1
  158. data/lib/lockally.rb +59 -35
  159. data/spec/api/admin_api_spec.rb +9 -9
  160. data/spec/api/admins_api_spec.rb +22 -22
  161. data/spec/api/agents_api_spec.rb +78 -78
  162. data/spec/api/ai_api_spec.rb +22 -22
  163. data/spec/api/aliases_api_spec.rb +16 -16
  164. data/spec/api/api_keys_api_spec.rb +17 -17
  165. data/spec/api/domains_api_spec.rb +42 -42
  166. data/spec/api/drafts_api_spec.rb +38 -38
  167. data/spec/api/health_api_spec.rb +3 -3
  168. data/spec/api/mailboxes_api_spec.rb +61 -61
  169. data/spec/api/send_api_spec.rb +35 -35
  170. data/spec/api/signup_api_spec.rb +1 -1
  171. data/spec/api/suppressions_api_spec.rb +18 -18
  172. data/spec/api/templates_api_spec.rb +17 -17
  173. data/spec/api/tenant_api_spec.rb +5 -5
  174. data/spec/api/test_api_spec.rb +3 -3
  175. data/spec/api/webhooks_api_spec.rb +19 -19
  176. data/spec/models/{v1_admin_login_post200_response_spec.rb → admin_login200_response_spec.rb} +6 -6
  177. data/spec/models/{v1_admin_login_post_request_spec.rb → admin_login_request_spec.rb} +6 -6
  178. data/spec/models/agent_send_result_spec.rb +48 -0
  179. data/spec/models/ai_config_spec.rb +64 -0
  180. data/spec/models/ai_config_update_spec.rb +46 -0
  181. data/spec/models/contact_lookup_contact_spec.rb +66 -0
  182. data/spec/models/contact_lookup_history_spec.rb +48 -0
  183. data/spec/models/contact_lookup_spec.rb +60 -0
  184. data/spec/models/create_ai_units_checkout200_response_spec.rb +48 -0
  185. data/spec/models/{v1_aliases_post_request_spec.rb → create_alias_request_spec.rb} +6 -6
  186. data/spec/models/{v1_api_keys_post201_response_spec.rb → create_api_key201_response_spec.rb} +6 -6
  187. data/spec/models/{v1_api_keys_post_request_spec.rb → create_api_key_request_spec.rb} +6 -6
  188. data/spec/models/{v1_domains_post_request_spec.rb → create_domain_request_spec.rb} +6 -6
  189. data/spec/models/{v1_mailboxes_post_request_spec.rb → create_mailbox_request_spec.rb} +6 -6
  190. data/spec/models/{v1_suppressions_post_request_spec.rb → create_suppression_request_spec.rb} +6 -6
  191. data/spec/models/{v1_webhooks_post_request_spec.rb → create_webhook_request_spec.rb} +6 -6
  192. data/spec/models/draft_list_spec.rb +36 -0
  193. data/spec/models/draft_result_spec.rb +64 -0
  194. data/spec/models/draft_spec.rb +118 -0
  195. data/spec/models/{v1_mailboxes_email_export_post201_response_spec.rb → export_mailbox201_response_spec.rb} +6 -6
  196. data/spec/models/{v1_admin_me_get200_response_spec.rb → get_current_admin200_response_spec.rb} +6 -6
  197. data/spec/models/{v1_usage_get200_response_spec.rb → get_usage200_response_spec.rb} +6 -6
  198. data/spec/models/{healthz_get200_response_spec.rb → health_check200_response_spec.rb} +6 -6
  199. data/spec/models/inbox_list_spec.rb +36 -0
  200. data/spec/models/inbox_spec.rb +54 -0
  201. data/spec/models/{v1_admins_post_request_spec.rb → invite_admin_request_spec.rb} +6 -6
  202. data/spec/models/{v1_aliases_get200_response_spec.rb → list_admins200_response_spec.rb} +6 -6
  203. data/spec/models/{v1_admins_get200_response_spec.rb → list_aliases200_response_spec.rb} +6 -6
  204. data/spec/models/{v1_api_keys_get200_response_spec.rb → list_api_keys200_response_spec.rb} +6 -6
  205. data/spec/models/list_domains200_response_spec.rb +36 -0
  206. data/spec/models/{v1_mailboxes_get200_response_spec.rb → list_mailboxes200_response_spec.rb} +6 -6
  207. data/spec/models/{v1_messages_get200_response_spec.rb → list_messages200_response_spec.rb} +6 -6
  208. data/spec/models/{v1_suppressions_get200_response_spec.rb → list_suppressions200_response_spec.rb} +6 -6
  209. data/spec/models/{v1_vacation_get200_response_spec.rb → list_templates200_response_spec.rb} +6 -6
  210. data/spec/models/list_vacation_responders200_response_spec.rb +36 -0
  211. data/spec/models/{v1_domains_get200_response_spec.rb → list_webhooks200_response_spec.rb} +6 -6
  212. data/spec/models/mailbox_grant_list_spec.rb +36 -0
  213. data/spec/models/mailbox_grant_spec.rb +42 -0
  214. data/spec/models/mark_read_result_spec.rb +36 -0
  215. data/spec/models/{v1_send_post200_response_spec.rb → send_email200_response_spec.rb} +6 -6
  216. data/spec/models/{v1_send_post202_response_spec.rb → send_email202_response_spec.rb} +6 -6
  217. data/spec/models/{v1_templates_get200_response_spec.rb → send_email_batch200_response_spec.rb} +6 -6
  218. data/spec/models/{v1_send_batch_post_request_spec.rb → send_email_batch_request_spec.rb} +6 -6
  219. data/spec/models/{v1_send_post_request_attachments_inner_spec.rb → send_email_request_attachments_inner_spec.rb} +6 -6
  220. data/spec/models/{v1_send_post_request_spec.rb → send_email_request_spec.rb} +6 -6
  221. data/spec/models/{v1_mailboxes_email_vacation_put_request_spec.rb → set_vacation_responder_request_spec.rb} +6 -6
  222. data/spec/models/simulated_inbound_spec.rb +48 -0
  223. data/spec/models/{v1_inboxes_mailbox_messages_post_request_spec.rb → start_conversation_request_spec.rb} +6 -6
  224. data/spec/models/thread_classification_spec.rb +48 -0
  225. data/spec/models/thread_list_spec.rb +42 -0
  226. data/spec/models/thread_message_body_all_of_body_spec.rb +48 -0
  227. data/spec/models/thread_message_body_spec.rb +112 -0
  228. data/spec/models/thread_message_spec.rb +106 -0
  229. data/spec/models/thread_spec.rb +48 -0
  230. data/spec/models/thread_summary_spec.rb +70 -0
  231. data/spec/models/{v1_admins_id_patch_request_spec.rb → update_admin_request_spec.rb} +6 -6
  232. data/spec/models/{v1_mailboxes_email_patch_request_spec.rb → update_mailbox_request_spec.rb} +6 -6
  233. data/spec/models/{v1_webhooks_id_patch_request_spec.rb → update_webhook_request_spec.rb} +6 -6
  234. data/spec/models/whoami_spec.rb +54 -0
  235. metadata +238 -142
  236. data/lib/lockally/models/v1_webhooks_get200_response.rb +0 -166
  237. data/spec/models/v1_send_batch_post200_response_spec.rb +0 -36
  238. data/spec/models/v1_webhooks_get200_response_spec.rb +0 -36
data/docs/MailboxesApi.md CHANGED
@@ -5,19 +5,19 @@ All URIs are relative to *https://api.lockally.com*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**add_shared_member**](MailboxesApi.md#add_shared_member) | **POST** /v1/mailboxes/{email}/members | Add a shared mailbox member |
8
+ | [**create_mailbox**](MailboxesApi.md#create_mailbox) | **POST** /v1/mailboxes | Create a mailbox |
9
+ | [**delete_mailbox**](MailboxesApi.md#delete_mailbox) | **DELETE** /v1/mailboxes/{email} | Soft-delete a mailbox |
10
+ | [**delete_vacation_responder**](MailboxesApi.md#delete_vacation_responder) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder |
11
+ | [**download_mailbox_export**](MailboxesApi.md#download_mailbox_export) | **GET** /v1/mailboxes/{email}/export/download | Download a previously-issued mailbox export |
12
+ | [**export_mailbox**](MailboxesApi.md#export_mailbox) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export |
13
+ | [**get_mailbox**](MailboxesApi.md#get_mailbox) | **GET** /v1/mailboxes/{email} | Get a mailbox |
14
+ | [**get_vacation_responder**](MailboxesApi.md#get_vacation_responder) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder |
15
+ | [**list_mailboxes**](MailboxesApi.md#list_mailboxes) | **GET** /v1/mailboxes | List mailboxes |
8
16
  | [**list_shared_members**](MailboxesApi.md#list_shared_members) | **GET** /v1/mailboxes/{email}/members | List shared mailbox members |
17
+ | [**list_vacation_responders**](MailboxesApi.md#list_vacation_responders) | **GET** /v1/vacation | List all vacation responders |
9
18
  | [**remove_shared_member**](MailboxesApi.md#remove_shared_member) | **DELETE** /v1/mailboxes/{email}/members/{memberEmail} | Remove a shared mailbox member |
10
- | [**v1_mailboxes_email_delete**](MailboxesApi.md#v1_mailboxes_email_delete) | **DELETE** /v1/mailboxes/{email} | Soft-delete a mailbox |
11
- | [**v1_mailboxes_email_export_download_get**](MailboxesApi.md#v1_mailboxes_email_export_download_get) | **GET** /v1/mailboxes/{email}/export/download | Download a previously-issued mailbox export |
12
- | [**v1_mailboxes_email_export_post**](MailboxesApi.md#v1_mailboxes_email_export_post) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export |
13
- | [**v1_mailboxes_email_get**](MailboxesApi.md#v1_mailboxes_email_get) | **GET** /v1/mailboxes/{email} | Get a mailbox |
14
- | [**v1_mailboxes_email_patch**](MailboxesApi.md#v1_mailboxes_email_patch) | **PATCH** /v1/mailboxes/{email} | Update a mailbox |
15
- | [**v1_mailboxes_email_vacation_delete**](MailboxesApi.md#v1_mailboxes_email_vacation_delete) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder |
16
- | [**v1_mailboxes_email_vacation_get**](MailboxesApi.md#v1_mailboxes_email_vacation_get) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder |
17
- | [**v1_mailboxes_email_vacation_put**](MailboxesApi.md#v1_mailboxes_email_vacation_put) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder |
18
- | [**v1_mailboxes_get**](MailboxesApi.md#v1_mailboxes_get) | **GET** /v1/mailboxes | List mailboxes |
19
- | [**v1_mailboxes_post**](MailboxesApi.md#v1_mailboxes_post) | **POST** /v1/mailboxes | Create a mailbox |
20
- | [**v1_vacation_get**](MailboxesApi.md#v1_vacation_get) | **GET** /v1/vacation | List all vacation responders |
19
+ | [**set_vacation_responder**](MailboxesApi.md#set_vacation_responder) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder |
20
+ | [**update_mailbox**](MailboxesApi.md#update_mailbox) | **PATCH** /v1/mailboxes/{email} | Update a mailbox |
21
21
 
22
22
 
23
23
  ## add_shared_member
@@ -89,11 +89,13 @@ end
89
89
  - **Accept**: application/json, application/problem+json
90
90
 
91
91
 
92
- ## list_shared_members
92
+ ## create_mailbox
93
93
 
94
- > <ListSharedMembers200Response> list_shared_members(email)
94
+ > <Mailbox> create_mailbox(create_mailbox_request)
95
95
 
96
- List shared mailbox members
96
+ Create a mailbox
97
+
98
+ Creates a mailbox on a tenant-verified domain. If `password` is omitted, lockally generates a 16-char password and returns it in the response — shown once. **Gate.** The mailbox's domain must already be registered AND verified for this tenant (via `/v1/domains` + `/v1/domains/{domain}/verify`). **Idempotent.** Re-posting the same email returns the existing mailbox UNTOUCHED — password is NOT regenerated. To change a password, use PATCH instead.
97
99
 
98
100
  ### Examples
99
101
 
@@ -107,32 +109,32 @@ Lockally.configure do |config|
107
109
  end
108
110
 
109
111
  api_instance = Lockally::MailboxesApi.new
110
- email = 'email_example' # String |
112
+ create_mailbox_request = Lockally::CreateMailboxRequest.new({email: 'alice@acme.com'}) # CreateMailboxRequest |
111
113
 
112
114
  begin
113
- # List shared mailbox members
114
- result = api_instance.list_shared_members(email)
115
+ # Create a mailbox
116
+ result = api_instance.create_mailbox(create_mailbox_request)
115
117
  p result
116
118
  rescue Lockally::ApiError => e
117
- puts "Error when calling MailboxesApi->list_shared_members: #{e}"
119
+ puts "Error when calling MailboxesApi->create_mailbox: #{e}"
118
120
  end
119
121
  ```
120
122
 
121
- #### Using the list_shared_members_with_http_info variant
123
+ #### Using the create_mailbox_with_http_info variant
122
124
 
123
125
  This returns an Array which contains the response data, status code and headers.
124
126
 
125
- > <Array(<ListSharedMembers200Response>, Integer, Hash)> list_shared_members_with_http_info(email)
127
+ > <Array(<Mailbox>, Integer, Hash)> create_mailbox_with_http_info(create_mailbox_request)
126
128
 
127
129
  ```ruby
128
130
  begin
129
- # List shared mailbox members
130
- data, status_code, headers = api_instance.list_shared_members_with_http_info(email)
131
+ # Create a mailbox
132
+ data, status_code, headers = api_instance.create_mailbox_with_http_info(create_mailbox_request)
131
133
  p status_code # => 2xx
132
134
  p headers # => { ... }
133
- p data # => <ListSharedMembers200Response>
135
+ p data # => <Mailbox>
134
136
  rescue Lockally::ApiError => e
135
- puts "Error when calling MailboxesApi->list_shared_members_with_http_info: #{e}"
137
+ puts "Error when calling MailboxesApi->create_mailbox_with_http_info: #{e}"
136
138
  end
137
139
  ```
138
140
 
@@ -140,11 +142,11 @@ end
140
142
 
141
143
  | Name | Type | Description | Notes |
142
144
  | ---- | ---- | ----------- | ----- |
143
- | **email** | **String** | | |
145
+ | **create_mailbox_request** | [**CreateMailboxRequest**](CreateMailboxRequest.md) | | |
144
146
 
145
147
  ### Return type
146
148
 
147
- [**ListSharedMembers200Response**](ListSharedMembers200Response.md)
149
+ [**Mailbox**](Mailbox.md)
148
150
 
149
151
  ### Authorization
150
152
 
@@ -152,15 +154,17 @@ end
152
154
 
153
155
  ### HTTP request headers
154
156
 
155
- - **Content-Type**: Not defined
157
+ - **Content-Type**: application/json
156
158
  - **Accept**: application/json, application/problem+json
157
159
 
158
160
 
159
- ## remove_shared_member
161
+ ## delete_mailbox
160
162
 
161
- > remove_shared_member(email, member_email)
163
+ > delete_mailbox(email)
162
164
 
163
- Remove a shared mailbox member
165
+ Soft-delete a mailbox
166
+
167
+ Sets `soft_deleted_at = now()` and `hard_delete_after = now() + 90d` per design D25. A background sweep (planned) will hard-delete after the window. The mailbox is also disabled immediately.
164
168
 
165
169
  ### Examples
166
170
 
@@ -175,31 +179,30 @@ end
175
179
 
176
180
  api_instance = Lockally::MailboxesApi.new
177
181
  email = 'email_example' # String |
178
- member_email = 'member_email_example' # String |
179
182
 
180
183
  begin
181
- # Remove a shared mailbox member
182
- api_instance.remove_shared_member(email, member_email)
184
+ # Soft-delete a mailbox
185
+ api_instance.delete_mailbox(email)
183
186
  rescue Lockally::ApiError => e
184
- puts "Error when calling MailboxesApi->remove_shared_member: #{e}"
187
+ puts "Error when calling MailboxesApi->delete_mailbox: #{e}"
185
188
  end
186
189
  ```
187
190
 
188
- #### Using the remove_shared_member_with_http_info variant
191
+ #### Using the delete_mailbox_with_http_info variant
189
192
 
190
193
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
191
194
 
192
- > <Array(nil, Integer, Hash)> remove_shared_member_with_http_info(email, member_email)
195
+ > <Array(nil, Integer, Hash)> delete_mailbox_with_http_info(email)
193
196
 
194
197
  ```ruby
195
198
  begin
196
- # Remove a shared mailbox member
197
- data, status_code, headers = api_instance.remove_shared_member_with_http_info(email, member_email)
199
+ # Soft-delete a mailbox
200
+ data, status_code, headers = api_instance.delete_mailbox_with_http_info(email)
198
201
  p status_code # => 2xx
199
202
  p headers # => { ... }
200
203
  p data # => nil
201
204
  rescue Lockally::ApiError => e
202
- puts "Error when calling MailboxesApi->remove_shared_member_with_http_info: #{e}"
205
+ puts "Error when calling MailboxesApi->delete_mailbox_with_http_info: #{e}"
203
206
  end
204
207
  ```
205
208
 
@@ -208,7 +211,6 @@ end
208
211
  | Name | Type | Description | Notes |
209
212
  | ---- | ---- | ----------- | ----- |
210
213
  | **email** | **String** | | |
211
- | **member_email** | **String** | | |
212
214
 
213
215
  ### Return type
214
216
 
@@ -224,13 +226,13 @@ nil (empty response body)
224
226
  - **Accept**: application/problem+json
225
227
 
226
228
 
227
- ## v1_mailboxes_email_delete
229
+ ## delete_vacation_responder
228
230
 
229
- > v1_mailboxes_email_delete(email)
231
+ > delete_vacation_responder(email)
230
232
 
231
- Soft-delete a mailbox
233
+ Remove the vacation responder
232
234
 
233
- Sets `soft_deleted_at = now()` and `hard_delete_after = now() + 90d` per design D25. A background sweep (planned) will hard-delete after the window. The mailbox is also disabled immediately.
235
+ Idempotent — 204 whether or not a row existed.
234
236
 
235
237
  ### Examples
236
238
 
@@ -247,28 +249,28 @@ api_instance = Lockally::MailboxesApi.new
247
249
  email = 'email_example' # String |
248
250
 
249
251
  begin
250
- # Soft-delete a mailbox
251
- api_instance.v1_mailboxes_email_delete(email)
252
+ # Remove the vacation responder
253
+ api_instance.delete_vacation_responder(email)
252
254
  rescue Lockally::ApiError => e
253
- puts "Error when calling MailboxesApi->v1_mailboxes_email_delete: #{e}"
255
+ puts "Error when calling MailboxesApi->delete_vacation_responder: #{e}"
254
256
  end
255
257
  ```
256
258
 
257
- #### Using the v1_mailboxes_email_delete_with_http_info variant
259
+ #### Using the delete_vacation_responder_with_http_info variant
258
260
 
259
261
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
260
262
 
261
- > <Array(nil, Integer, Hash)> v1_mailboxes_email_delete_with_http_info(email)
263
+ > <Array(nil, Integer, Hash)> delete_vacation_responder_with_http_info(email)
262
264
 
263
265
  ```ruby
264
266
  begin
265
- # Soft-delete a mailbox
266
- data, status_code, headers = api_instance.v1_mailboxes_email_delete_with_http_info(email)
267
+ # Remove the vacation responder
268
+ data, status_code, headers = api_instance.delete_vacation_responder_with_http_info(email)
267
269
  p status_code # => 2xx
268
270
  p headers # => { ... }
269
271
  p data # => nil
270
272
  rescue Lockally::ApiError => e
271
- puts "Error when calling MailboxesApi->v1_mailboxes_email_delete_with_http_info: #{e}"
273
+ puts "Error when calling MailboxesApi->delete_vacation_responder_with_http_info: #{e}"
272
274
  end
273
275
  ```
274
276
 
@@ -292,9 +294,9 @@ nil (empty response body)
292
294
  - **Accept**: application/problem+json
293
295
 
294
296
 
295
- ## v1_mailboxes_email_export_download_get
297
+ ## download_mailbox_export
296
298
 
297
- > File v1_mailboxes_email_export_download_get(email, token)
299
+ > File download_mailbox_export(email, token)
298
300
 
299
301
  Download a previously-issued mailbox export
300
302
 
@@ -312,28 +314,28 @@ token = 'token_example' # String |
312
314
 
313
315
  begin
314
316
  # Download a previously-issued mailbox export
315
- result = api_instance.v1_mailboxes_email_export_download_get(email, token)
317
+ result = api_instance.download_mailbox_export(email, token)
316
318
  p result
317
319
  rescue Lockally::ApiError => e
318
- puts "Error when calling MailboxesApi->v1_mailboxes_email_export_download_get: #{e}"
320
+ puts "Error when calling MailboxesApi->download_mailbox_export: #{e}"
319
321
  end
320
322
  ```
321
323
 
322
- #### Using the v1_mailboxes_email_export_download_get_with_http_info variant
324
+ #### Using the download_mailbox_export_with_http_info variant
323
325
 
324
326
  This returns an Array which contains the response data, status code and headers.
325
327
 
326
- > <Array(File, Integer, Hash)> v1_mailboxes_email_export_download_get_with_http_info(email, token)
328
+ > <Array(File, Integer, Hash)> download_mailbox_export_with_http_info(email, token)
327
329
 
328
330
  ```ruby
329
331
  begin
330
332
  # Download a previously-issued mailbox export
331
- data, status_code, headers = api_instance.v1_mailboxes_email_export_download_get_with_http_info(email, token)
333
+ data, status_code, headers = api_instance.download_mailbox_export_with_http_info(email, token)
332
334
  p status_code # => 2xx
333
335
  p headers # => { ... }
334
336
  p data # => File
335
337
  rescue Lockally::ApiError => e
336
- puts "Error when calling MailboxesApi->v1_mailboxes_email_export_download_get_with_http_info: #{e}"
338
+ puts "Error when calling MailboxesApi->download_mailbox_export_with_http_info: #{e}"
337
339
  end
338
340
  ```
339
341
 
@@ -358,9 +360,9 @@ No authorization required
358
360
  - **Accept**: application/mbox, application/problem+json
359
361
 
360
362
 
361
- ## v1_mailboxes_email_export_post
363
+ ## export_mailbox
362
364
 
363
- > <V1MailboxesEmailExportPost201Response> v1_mailboxes_email_export_post(email)
365
+ > <ExportMailbox201Response> export_mailbox(email)
364
366
 
365
367
  Request a mailbox export
366
368
 
@@ -382,28 +384,28 @@ email = 'email_example' # String |
382
384
 
383
385
  begin
384
386
  # Request a mailbox export
385
- result = api_instance.v1_mailboxes_email_export_post(email)
387
+ result = api_instance.export_mailbox(email)
386
388
  p result
387
389
  rescue Lockally::ApiError => e
388
- puts "Error when calling MailboxesApi->v1_mailboxes_email_export_post: #{e}"
390
+ puts "Error when calling MailboxesApi->export_mailbox: #{e}"
389
391
  end
390
392
  ```
391
393
 
392
- #### Using the v1_mailboxes_email_export_post_with_http_info variant
394
+ #### Using the export_mailbox_with_http_info variant
393
395
 
394
396
  This returns an Array which contains the response data, status code and headers.
395
397
 
396
- > <Array(<V1MailboxesEmailExportPost201Response>, Integer, Hash)> v1_mailboxes_email_export_post_with_http_info(email)
398
+ > <Array(<ExportMailbox201Response>, Integer, Hash)> export_mailbox_with_http_info(email)
397
399
 
398
400
  ```ruby
399
401
  begin
400
402
  # Request a mailbox export
401
- data, status_code, headers = api_instance.v1_mailboxes_email_export_post_with_http_info(email)
403
+ data, status_code, headers = api_instance.export_mailbox_with_http_info(email)
402
404
  p status_code # => 2xx
403
405
  p headers # => { ... }
404
- p data # => <V1MailboxesEmailExportPost201Response>
406
+ p data # => <ExportMailbox201Response>
405
407
  rescue Lockally::ApiError => e
406
- puts "Error when calling MailboxesApi->v1_mailboxes_email_export_post_with_http_info: #{e}"
408
+ puts "Error when calling MailboxesApi->export_mailbox_with_http_info: #{e}"
407
409
  end
408
410
  ```
409
411
 
@@ -415,7 +417,7 @@ end
415
417
 
416
418
  ### Return type
417
419
 
418
- [**V1MailboxesEmailExportPost201Response**](V1MailboxesEmailExportPost201Response.md)
420
+ [**ExportMailbox201Response**](ExportMailbox201Response.md)
419
421
 
420
422
  ### Authorization
421
423
 
@@ -427,9 +429,9 @@ end
427
429
  - **Accept**: application/json, application/problem+json
428
430
 
429
431
 
430
- ## v1_mailboxes_email_get
432
+ ## get_mailbox
431
433
 
432
- > <Mailbox> v1_mailboxes_email_get(email)
434
+ > <Mailbox> get_mailbox(email)
433
435
 
434
436
  Get a mailbox
435
437
 
@@ -449,28 +451,28 @@ email = 'email_example' # String |
449
451
 
450
452
  begin
451
453
  # Get a mailbox
452
- result = api_instance.v1_mailboxes_email_get(email)
454
+ result = api_instance.get_mailbox(email)
453
455
  p result
454
456
  rescue Lockally::ApiError => e
455
- puts "Error when calling MailboxesApi->v1_mailboxes_email_get: #{e}"
457
+ puts "Error when calling MailboxesApi->get_mailbox: #{e}"
456
458
  end
457
459
  ```
458
460
 
459
- #### Using the v1_mailboxes_email_get_with_http_info variant
461
+ #### Using the get_mailbox_with_http_info variant
460
462
 
461
463
  This returns an Array which contains the response data, status code and headers.
462
464
 
463
- > <Array(<Mailbox>, Integer, Hash)> v1_mailboxes_email_get_with_http_info(email)
465
+ > <Array(<Mailbox>, Integer, Hash)> get_mailbox_with_http_info(email)
464
466
 
465
467
  ```ruby
466
468
  begin
467
469
  # Get a mailbox
468
- data, status_code, headers = api_instance.v1_mailboxes_email_get_with_http_info(email)
470
+ data, status_code, headers = api_instance.get_mailbox_with_http_info(email)
469
471
  p status_code # => 2xx
470
472
  p headers # => { ... }
471
473
  p data # => <Mailbox>
472
474
  rescue Lockally::ApiError => e
473
- puts "Error when calling MailboxesApi->v1_mailboxes_email_get_with_http_info: #{e}"
475
+ puts "Error when calling MailboxesApi->get_mailbox_with_http_info: #{e}"
474
476
  end
475
477
  ```
476
478
 
@@ -494,13 +496,13 @@ end
494
496
  - **Accept**: application/json, application/problem+json
495
497
 
496
498
 
497
- ## v1_mailboxes_email_patch
499
+ ## get_vacation_responder
498
500
 
499
- > <Mailbox> v1_mailboxes_email_patch(email, v1_mailboxes_email_patch_request)
501
+ > <VacationResponder> get_vacation_responder(email)
500
502
 
501
- Update a mailbox
503
+ Get the vacation responder
502
504
 
503
- Supply at least one of `password`, `quota_bytes`, `disabled`. Returns the updated mailbox.
505
+ Returns the stored vacation rule or 404 if none is set.
504
506
 
505
507
  ### Examples
506
508
 
@@ -515,32 +517,31 @@ end
515
517
 
516
518
  api_instance = Lockally::MailboxesApi.new
517
519
  email = 'email_example' # String |
518
- v1_mailboxes_email_patch_request = Lockally::V1MailboxesEmailPatchRequest.new # V1MailboxesEmailPatchRequest |
519
520
 
520
521
  begin
521
- # Update a mailbox
522
- result = api_instance.v1_mailboxes_email_patch(email, v1_mailboxes_email_patch_request)
522
+ # Get the vacation responder
523
+ result = api_instance.get_vacation_responder(email)
523
524
  p result
524
525
  rescue Lockally::ApiError => e
525
- puts "Error when calling MailboxesApi->v1_mailboxes_email_patch: #{e}"
526
+ puts "Error when calling MailboxesApi->get_vacation_responder: #{e}"
526
527
  end
527
528
  ```
528
529
 
529
- #### Using the v1_mailboxes_email_patch_with_http_info variant
530
+ #### Using the get_vacation_responder_with_http_info variant
530
531
 
531
532
  This returns an Array which contains the response data, status code and headers.
532
533
 
533
- > <Array(<Mailbox>, Integer, Hash)> v1_mailboxes_email_patch_with_http_info(email, v1_mailboxes_email_patch_request)
534
+ > <Array(<VacationResponder>, Integer, Hash)> get_vacation_responder_with_http_info(email)
534
535
 
535
536
  ```ruby
536
537
  begin
537
- # Update a mailbox
538
- data, status_code, headers = api_instance.v1_mailboxes_email_patch_with_http_info(email, v1_mailboxes_email_patch_request)
538
+ # Get the vacation responder
539
+ data, status_code, headers = api_instance.get_vacation_responder_with_http_info(email)
539
540
  p status_code # => 2xx
540
541
  p headers # => { ... }
541
- p data # => <Mailbox>
542
+ p data # => <VacationResponder>
542
543
  rescue Lockally::ApiError => e
543
- puts "Error when calling MailboxesApi->v1_mailboxes_email_patch_with_http_info: #{e}"
544
+ puts "Error when calling MailboxesApi->get_vacation_responder_with_http_info: #{e}"
544
545
  end
545
546
  ```
546
547
 
@@ -549,11 +550,10 @@ end
549
550
  | Name | Type | Description | Notes |
550
551
  | ---- | ---- | ----------- | ----- |
551
552
  | **email** | **String** | | |
552
- | **v1_mailboxes_email_patch_request** | [**V1MailboxesEmailPatchRequest**](V1MailboxesEmailPatchRequest.md) | | |
553
553
 
554
554
  ### Return type
555
555
 
556
- [**Mailbox**](Mailbox.md)
556
+ [**VacationResponder**](VacationResponder.md)
557
557
 
558
558
  ### Authorization
559
559
 
@@ -561,17 +561,17 @@ end
561
561
 
562
562
  ### HTTP request headers
563
563
 
564
- - **Content-Type**: application/json
564
+ - **Content-Type**: Not defined
565
565
  - **Accept**: application/json, application/problem+json
566
566
 
567
567
 
568
- ## v1_mailboxes_email_vacation_delete
568
+ ## list_mailboxes
569
569
 
570
- > v1_mailboxes_email_vacation_delete(email)
570
+ > <ListMailboxes200Response> list_mailboxes(opts)
571
571
 
572
- Remove the vacation responder
572
+ List mailboxes
573
573
 
574
- Idempotent — 204 whether or not a row existed.
574
+ Returns mailboxes under the calling tenant — active and soft-deleted. `?limit=N` between 1 and 200 (default 50).
575
575
 
576
576
  ### Examples
577
577
 
@@ -585,31 +585,34 @@ Lockally.configure do |config|
585
585
  end
586
586
 
587
587
  api_instance = Lockally::MailboxesApi.new
588
- email = 'email_example' # String |
588
+ opts = {
589
+ limit: 56 # Integer |
590
+ }
589
591
 
590
592
  begin
591
- # Remove the vacation responder
592
- api_instance.v1_mailboxes_email_vacation_delete(email)
593
+ # List mailboxes
594
+ result = api_instance.list_mailboxes(opts)
595
+ p result
593
596
  rescue Lockally::ApiError => e
594
- puts "Error when calling MailboxesApi->v1_mailboxes_email_vacation_delete: #{e}"
597
+ puts "Error when calling MailboxesApi->list_mailboxes: #{e}"
595
598
  end
596
599
  ```
597
600
 
598
- #### Using the v1_mailboxes_email_vacation_delete_with_http_info variant
601
+ #### Using the list_mailboxes_with_http_info variant
599
602
 
600
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
603
+ This returns an Array which contains the response data, status code and headers.
601
604
 
602
- > <Array(nil, Integer, Hash)> v1_mailboxes_email_vacation_delete_with_http_info(email)
605
+ > <Array(<ListMailboxes200Response>, Integer, Hash)> list_mailboxes_with_http_info(opts)
603
606
 
604
607
  ```ruby
605
608
  begin
606
- # Remove the vacation responder
607
- data, status_code, headers = api_instance.v1_mailboxes_email_vacation_delete_with_http_info(email)
609
+ # List mailboxes
610
+ data, status_code, headers = api_instance.list_mailboxes_with_http_info(opts)
608
611
  p status_code # => 2xx
609
612
  p headers # => { ... }
610
- p data # => nil
613
+ p data # => <ListMailboxes200Response>
611
614
  rescue Lockally::ApiError => e
612
- puts "Error when calling MailboxesApi->v1_mailboxes_email_vacation_delete_with_http_info: #{e}"
615
+ puts "Error when calling MailboxesApi->list_mailboxes_with_http_info: #{e}"
613
616
  end
614
617
  ```
615
618
 
@@ -617,11 +620,11 @@ end
617
620
 
618
621
  | Name | Type | Description | Notes |
619
622
  | ---- | ---- | ----------- | ----- |
620
- | **email** | **String** | | |
623
+ | **limit** | **Integer** | | [optional][default to 50] |
621
624
 
622
625
  ### Return type
623
626
 
624
- nil (empty response body)
627
+ [**ListMailboxes200Response**](ListMailboxes200Response.md)
625
628
 
626
629
  ### Authorization
627
630
 
@@ -630,16 +633,14 @@ nil (empty response body)
630
633
  ### HTTP request headers
631
634
 
632
635
  - **Content-Type**: Not defined
633
- - **Accept**: application/problem+json
634
-
636
+ - **Accept**: application/json, application/problem+json
635
637
 
636
- ## v1_mailboxes_email_vacation_get
637
638
 
638
- > <VacationResponder> v1_mailboxes_email_vacation_get(email)
639
+ ## list_shared_members
639
640
 
640
- Get the vacation responder
641
+ > <ListSharedMembers200Response> list_shared_members(email)
641
642
 
642
- Returns the stored vacation rule or 404 if none is set.
643
+ List shared mailbox members
643
644
 
644
645
  ### Examples
645
646
 
@@ -656,29 +657,29 @@ api_instance = Lockally::MailboxesApi.new
656
657
  email = 'email_example' # String |
657
658
 
658
659
  begin
659
- # Get the vacation responder
660
- result = api_instance.v1_mailboxes_email_vacation_get(email)
660
+ # List shared mailbox members
661
+ result = api_instance.list_shared_members(email)
661
662
  p result
662
663
  rescue Lockally::ApiError => e
663
- puts "Error when calling MailboxesApi->v1_mailboxes_email_vacation_get: #{e}"
664
+ puts "Error when calling MailboxesApi->list_shared_members: #{e}"
664
665
  end
665
666
  ```
666
667
 
667
- #### Using the v1_mailboxes_email_vacation_get_with_http_info variant
668
+ #### Using the list_shared_members_with_http_info variant
668
669
 
669
670
  This returns an Array which contains the response data, status code and headers.
670
671
 
671
- > <Array(<VacationResponder>, Integer, Hash)> v1_mailboxes_email_vacation_get_with_http_info(email)
672
+ > <Array(<ListSharedMembers200Response>, Integer, Hash)> list_shared_members_with_http_info(email)
672
673
 
673
674
  ```ruby
674
675
  begin
675
- # Get the vacation responder
676
- data, status_code, headers = api_instance.v1_mailboxes_email_vacation_get_with_http_info(email)
676
+ # List shared mailbox members
677
+ data, status_code, headers = api_instance.list_shared_members_with_http_info(email)
677
678
  p status_code # => 2xx
678
679
  p headers # => { ... }
679
- p data # => <VacationResponder>
680
+ p data # => <ListSharedMembers200Response>
680
681
  rescue Lockally::ApiError => e
681
- puts "Error when calling MailboxesApi->v1_mailboxes_email_vacation_get_with_http_info: #{e}"
682
+ puts "Error when calling MailboxesApi->list_shared_members_with_http_info: #{e}"
682
683
  end
683
684
  ```
684
685
 
@@ -690,7 +691,7 @@ end
690
691
 
691
692
  ### Return type
692
693
 
693
- [**VacationResponder**](VacationResponder.md)
694
+ [**ListSharedMembers200Response**](ListSharedMembers200Response.md)
694
695
 
695
696
  ### Authorization
696
697
 
@@ -702,13 +703,13 @@ end
702
703
  - **Accept**: application/json, application/problem+json
703
704
 
704
705
 
705
- ## v1_mailboxes_email_vacation_put
706
+ ## list_vacation_responders
706
707
 
707
- > <VacationResponder> v1_mailboxes_email_vacation_put(email, v1_mailboxes_email_vacation_put_request)
708
+ > <ListVacationResponders200Response> list_vacation_responders
708
709
 
709
- Set the vacation responder
710
+ List all vacation responders
710
711
 
711
- Upsert — same endpoint creates or replaces the rule. Clears `synced_at`; the rule is staged on lockally until a sync worker pushes it to the mail server.
712
+ Returns every vacation responder for the calling tenant.
712
713
 
713
714
  ### Examples
714
715
 
@@ -722,46 +723,41 @@ Lockally.configure do |config|
722
723
  end
723
724
 
724
725
  api_instance = Lockally::MailboxesApi.new
725
- email = 'email_example' # String |
726
- v1_mailboxes_email_vacation_put_request = Lockally::V1MailboxesEmailVacationPutRequest.new({params: Lockally::VacationParams.new({subject: 'Out of office until June 5', body: 'Hi! I'm away until June 5. For urgent matters please contact ...'})}) # V1MailboxesEmailVacationPutRequest |
727
726
 
728
727
  begin
729
- # Set the vacation responder
730
- result = api_instance.v1_mailboxes_email_vacation_put(email, v1_mailboxes_email_vacation_put_request)
728
+ # List all vacation responders
729
+ result = api_instance.list_vacation_responders
731
730
  p result
732
731
  rescue Lockally::ApiError => e
733
- puts "Error when calling MailboxesApi->v1_mailboxes_email_vacation_put: #{e}"
732
+ puts "Error when calling MailboxesApi->list_vacation_responders: #{e}"
734
733
  end
735
734
  ```
736
735
 
737
- #### Using the v1_mailboxes_email_vacation_put_with_http_info variant
736
+ #### Using the list_vacation_responders_with_http_info variant
738
737
 
739
738
  This returns an Array which contains the response data, status code and headers.
740
739
 
741
- > <Array(<VacationResponder>, Integer, Hash)> v1_mailboxes_email_vacation_put_with_http_info(email, v1_mailboxes_email_vacation_put_request)
740
+ > <Array(<ListVacationResponders200Response>, Integer, Hash)> list_vacation_responders_with_http_info
742
741
 
743
742
  ```ruby
744
743
  begin
745
- # Set the vacation responder
746
- data, status_code, headers = api_instance.v1_mailboxes_email_vacation_put_with_http_info(email, v1_mailboxes_email_vacation_put_request)
744
+ # List all vacation responders
745
+ data, status_code, headers = api_instance.list_vacation_responders_with_http_info
747
746
  p status_code # => 2xx
748
747
  p headers # => { ... }
749
- p data # => <VacationResponder>
748
+ p data # => <ListVacationResponders200Response>
750
749
  rescue Lockally::ApiError => e
751
- puts "Error when calling MailboxesApi->v1_mailboxes_email_vacation_put_with_http_info: #{e}"
750
+ puts "Error when calling MailboxesApi->list_vacation_responders_with_http_info: #{e}"
752
751
  end
753
752
  ```
754
753
 
755
754
  ### Parameters
756
755
 
757
- | Name | Type | Description | Notes |
758
- | ---- | ---- | ----------- | ----- |
759
- | **email** | **String** | | |
760
- | **v1_mailboxes_email_vacation_put_request** | [**V1MailboxesEmailVacationPutRequest**](V1MailboxesEmailVacationPutRequest.md) | | |
756
+ This endpoint does not need any parameter.
761
757
 
762
758
  ### Return type
763
759
 
764
- [**VacationResponder**](VacationResponder.md)
760
+ [**ListVacationResponders200Response**](ListVacationResponders200Response.md)
765
761
 
766
762
  ### Authorization
767
763
 
@@ -769,17 +765,15 @@ end
769
765
 
770
766
  ### HTTP request headers
771
767
 
772
- - **Content-Type**: application/json
768
+ - **Content-Type**: Not defined
773
769
  - **Accept**: application/json, application/problem+json
774
770
 
775
771
 
776
- ## v1_mailboxes_get
777
-
778
- > <V1MailboxesGet200Response> v1_mailboxes_get(opts)
772
+ ## remove_shared_member
779
773
 
780
- List mailboxes
774
+ > remove_shared_member(email, member_email)
781
775
 
782
- Returns mailboxes under the calling tenant — active and soft-deleted. `?limit=N` between 1 and 200 (default 50).
776
+ Remove a shared mailbox member
783
777
 
784
778
  ### Examples
785
779
 
@@ -793,34 +787,32 @@ Lockally.configure do |config|
793
787
  end
794
788
 
795
789
  api_instance = Lockally::MailboxesApi.new
796
- opts = {
797
- limit: 56 # Integer |
798
- }
790
+ email = 'email_example' # String |
791
+ member_email = 'member_email_example' # String |
799
792
 
800
793
  begin
801
- # List mailboxes
802
- result = api_instance.v1_mailboxes_get(opts)
803
- p result
794
+ # Remove a shared mailbox member
795
+ api_instance.remove_shared_member(email, member_email)
804
796
  rescue Lockally::ApiError => e
805
- puts "Error when calling MailboxesApi->v1_mailboxes_get: #{e}"
797
+ puts "Error when calling MailboxesApi->remove_shared_member: #{e}"
806
798
  end
807
799
  ```
808
800
 
809
- #### Using the v1_mailboxes_get_with_http_info variant
801
+ #### Using the remove_shared_member_with_http_info variant
810
802
 
811
- This returns an Array which contains the response data, status code and headers.
803
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
812
804
 
813
- > <Array(<V1MailboxesGet200Response>, Integer, Hash)> v1_mailboxes_get_with_http_info(opts)
805
+ > <Array(nil, Integer, Hash)> remove_shared_member_with_http_info(email, member_email)
814
806
 
815
807
  ```ruby
816
808
  begin
817
- # List mailboxes
818
- data, status_code, headers = api_instance.v1_mailboxes_get_with_http_info(opts)
809
+ # Remove a shared mailbox member
810
+ data, status_code, headers = api_instance.remove_shared_member_with_http_info(email, member_email)
819
811
  p status_code # => 2xx
820
812
  p headers # => { ... }
821
- p data # => <V1MailboxesGet200Response>
813
+ p data # => nil
822
814
  rescue Lockally::ApiError => e
823
- puts "Error when calling MailboxesApi->v1_mailboxes_get_with_http_info: #{e}"
815
+ puts "Error when calling MailboxesApi->remove_shared_member_with_http_info: #{e}"
824
816
  end
825
817
  ```
826
818
 
@@ -828,11 +820,12 @@ end
828
820
 
829
821
  | Name | Type | Description | Notes |
830
822
  | ---- | ---- | ----------- | ----- |
831
- | **limit** | **Integer** | | [optional][default to 50] |
823
+ | **email** | **String** | | |
824
+ | **member_email** | **String** | | |
832
825
 
833
826
  ### Return type
834
827
 
835
- [**V1MailboxesGet200Response**](V1MailboxesGet200Response.md)
828
+ nil (empty response body)
836
829
 
837
830
  ### Authorization
838
831
 
@@ -841,16 +834,16 @@ end
841
834
  ### HTTP request headers
842
835
 
843
836
  - **Content-Type**: Not defined
844
- - **Accept**: application/json, application/problem+json
837
+ - **Accept**: application/problem+json
845
838
 
846
839
 
847
- ## v1_mailboxes_post
840
+ ## set_vacation_responder
848
841
 
849
- > <Mailbox> v1_mailboxes_post(v1_mailboxes_post_request)
842
+ > <VacationResponder> set_vacation_responder(email, set_vacation_responder_request)
850
843
 
851
- Create a mailbox
844
+ Set the vacation responder
852
845
 
853
- Creates a mailbox on a tenant-verified domain. If `password` is omitted, lockally generates a 16-char password and returns it in the response — shown once. **Gate.** The mailbox's domain must already be registered AND verified for this tenant (via `/v1/domains` + `/v1/domains/{domain}/verify`). **Idempotent.** Re-posting the same email returns the existing mailbox UNTOUCHED — password is NOT regenerated. To change a password, use PATCH instead.
846
+ Upsert — same endpoint creates or replaces the rule. Clears `synced_at`; the rule is staged on lockally until a sync worker pushes it to the mail server.
854
847
 
855
848
  ### Examples
856
849
 
@@ -864,32 +857,33 @@ Lockally.configure do |config|
864
857
  end
865
858
 
866
859
  api_instance = Lockally::MailboxesApi.new
867
- v1_mailboxes_post_request = Lockally::V1MailboxesPostRequest.new({email: 'alice@acme.com'}) # V1MailboxesPostRequest |
860
+ email = 'email_example' # String |
861
+ set_vacation_responder_request = Lockally::SetVacationResponderRequest.new({params: Lockally::VacationParams.new({subject: 'Out of office until June 5', body: 'Hi! I'm away until June 5. For urgent matters please contact ...'})}) # SetVacationResponderRequest |
868
862
 
869
863
  begin
870
- # Create a mailbox
871
- result = api_instance.v1_mailboxes_post(v1_mailboxes_post_request)
864
+ # Set the vacation responder
865
+ result = api_instance.set_vacation_responder(email, set_vacation_responder_request)
872
866
  p result
873
867
  rescue Lockally::ApiError => e
874
- puts "Error when calling MailboxesApi->v1_mailboxes_post: #{e}"
868
+ puts "Error when calling MailboxesApi->set_vacation_responder: #{e}"
875
869
  end
876
870
  ```
877
871
 
878
- #### Using the v1_mailboxes_post_with_http_info variant
872
+ #### Using the set_vacation_responder_with_http_info variant
879
873
 
880
874
  This returns an Array which contains the response data, status code and headers.
881
875
 
882
- > <Array(<Mailbox>, Integer, Hash)> v1_mailboxes_post_with_http_info(v1_mailboxes_post_request)
876
+ > <Array(<VacationResponder>, Integer, Hash)> set_vacation_responder_with_http_info(email, set_vacation_responder_request)
883
877
 
884
878
  ```ruby
885
879
  begin
886
- # Create a mailbox
887
- data, status_code, headers = api_instance.v1_mailboxes_post_with_http_info(v1_mailboxes_post_request)
880
+ # Set the vacation responder
881
+ data, status_code, headers = api_instance.set_vacation_responder_with_http_info(email, set_vacation_responder_request)
888
882
  p status_code # => 2xx
889
883
  p headers # => { ... }
890
- p data # => <Mailbox>
884
+ p data # => <VacationResponder>
891
885
  rescue Lockally::ApiError => e
892
- puts "Error when calling MailboxesApi->v1_mailboxes_post_with_http_info: #{e}"
886
+ puts "Error when calling MailboxesApi->set_vacation_responder_with_http_info: #{e}"
893
887
  end
894
888
  ```
895
889
 
@@ -897,11 +891,12 @@ end
897
891
 
898
892
  | Name | Type | Description | Notes |
899
893
  | ---- | ---- | ----------- | ----- |
900
- | **v1_mailboxes_post_request** | [**V1MailboxesPostRequest**](V1MailboxesPostRequest.md) | | |
894
+ | **email** | **String** | | |
895
+ | **set_vacation_responder_request** | [**SetVacationResponderRequest**](SetVacationResponderRequest.md) | | |
901
896
 
902
897
  ### Return type
903
898
 
904
- [**Mailbox**](Mailbox.md)
899
+ [**VacationResponder**](VacationResponder.md)
905
900
 
906
901
  ### Authorization
907
902
 
@@ -913,13 +908,13 @@ end
913
908
  - **Accept**: application/json, application/problem+json
914
909
 
915
910
 
916
- ## v1_vacation_get
911
+ ## update_mailbox
917
912
 
918
- > <V1VacationGet200Response> v1_vacation_get
913
+ > <Mailbox> update_mailbox(email, update_mailbox_request)
919
914
 
920
- List all vacation responders
915
+ Update a mailbox
921
916
 
922
- Returns every vacation responder for the calling tenant.
917
+ Supply at least one of `password`, `quota_bytes`, `disabled`. Returns the updated mailbox.
923
918
 
924
919
  ### Examples
925
920
 
@@ -933,41 +928,46 @@ Lockally.configure do |config|
933
928
  end
934
929
 
935
930
  api_instance = Lockally::MailboxesApi.new
931
+ email = 'email_example' # String |
932
+ update_mailbox_request = Lockally::UpdateMailboxRequest.new # UpdateMailboxRequest |
936
933
 
937
934
  begin
938
- # List all vacation responders
939
- result = api_instance.v1_vacation_get
935
+ # Update a mailbox
936
+ result = api_instance.update_mailbox(email, update_mailbox_request)
940
937
  p result
941
938
  rescue Lockally::ApiError => e
942
- puts "Error when calling MailboxesApi->v1_vacation_get: #{e}"
939
+ puts "Error when calling MailboxesApi->update_mailbox: #{e}"
943
940
  end
944
941
  ```
945
942
 
946
- #### Using the v1_vacation_get_with_http_info variant
943
+ #### Using the update_mailbox_with_http_info variant
947
944
 
948
945
  This returns an Array which contains the response data, status code and headers.
949
946
 
950
- > <Array(<V1VacationGet200Response>, Integer, Hash)> v1_vacation_get_with_http_info
947
+ > <Array(<Mailbox>, Integer, Hash)> update_mailbox_with_http_info(email, update_mailbox_request)
951
948
 
952
949
  ```ruby
953
950
  begin
954
- # List all vacation responders
955
- data, status_code, headers = api_instance.v1_vacation_get_with_http_info
951
+ # Update a mailbox
952
+ data, status_code, headers = api_instance.update_mailbox_with_http_info(email, update_mailbox_request)
956
953
  p status_code # => 2xx
957
954
  p headers # => { ... }
958
- p data # => <V1VacationGet200Response>
955
+ p data # => <Mailbox>
959
956
  rescue Lockally::ApiError => e
960
- puts "Error when calling MailboxesApi->v1_vacation_get_with_http_info: #{e}"
957
+ puts "Error when calling MailboxesApi->update_mailbox_with_http_info: #{e}"
961
958
  end
962
959
  ```
963
960
 
964
961
  ### Parameters
965
962
 
966
- This endpoint does not need any parameter.
963
+ | Name | Type | Description | Notes |
964
+ | ---- | ---- | ----------- | ----- |
965
+ | **email** | **String** | | |
966
+ | **update_mailbox_request** | [**UpdateMailboxRequest**](UpdateMailboxRequest.md) | | |
967
967
 
968
968
  ### Return type
969
969
 
970
- [**V1VacationGet200Response**](V1VacationGet200Response.md)
970
+ [**Mailbox**](Mailbox.md)
971
971
 
972
972
  ### Authorization
973
973
 
@@ -975,6 +975,6 @@ This endpoint does not need any parameter.
975
975
 
976
976
  ### HTTP request headers
977
977
 
978
- - **Content-Type**: Not defined
978
+ - **Content-Type**: application/json
979
979
  - **Accept**: application/json, application/problem+json
980
980