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
@@ -44,157 +44,157 @@ describe 'MailboxesApi' do
44
44
  end
45
45
  end
46
46
 
47
- # unit tests for list_shared_members
48
- # List shared mailbox members
49
- # @param email
47
+ # unit tests for create_mailbox
48
+ # Create a mailbox
49
+ # 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.
50
+ # @param create_mailbox_request
50
51
  # @param [Hash] opts the optional parameters
51
- # @return [ListSharedMembers200Response]
52
- describe 'list_shared_members test' do
52
+ # @return [Mailbox]
53
+ describe 'create_mailbox test' do
53
54
  it 'should work' do
54
55
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
55
56
  end
56
57
  end
57
58
 
58
- # unit tests for remove_shared_member
59
- # Remove a shared mailbox member
59
+ # unit tests for delete_mailbox
60
+ # Soft-delete a mailbox
61
+ # 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.
60
62
  # @param email
61
- # @param member_email
62
63
  # @param [Hash] opts the optional parameters
63
64
  # @return [nil]
64
- describe 'remove_shared_member test' do
65
+ describe 'delete_mailbox test' do
65
66
  it 'should work' do
66
67
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
67
68
  end
68
69
  end
69
70
 
70
- # unit tests for v1_mailboxes_email_delete
71
- # Soft-delete a mailbox
72
- # 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.
71
+ # unit tests for delete_vacation_responder
72
+ # Remove the vacation responder
73
+ # Idempotent — 204 whether or not a row existed.
73
74
  # @param email
74
75
  # @param [Hash] opts the optional parameters
75
76
  # @return [nil]
76
- describe 'v1_mailboxes_email_delete test' do
77
+ describe 'delete_vacation_responder test' do
77
78
  it 'should work' do
78
79
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
79
80
  end
80
81
  end
81
82
 
82
- # unit tests for v1_mailboxes_email_export_download_get
83
+ # unit tests for download_mailbox_export
83
84
  # Download a previously-issued mailbox export
84
85
  # Public endpoint (no Authorization header). Validates the one-shot token from the URL, marks it used, and streams an mbox file. Second GET with the same token returns 404 — tokens are single-use.
85
86
  # @param email
86
87
  # @param token
87
88
  # @param [Hash] opts the optional parameters
88
89
  # @return [File]
89
- describe 'v1_mailboxes_email_export_download_get test' do
90
+ describe 'download_mailbox_export test' do
90
91
  it 'should work' do
91
92
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
92
93
  end
93
94
  end
94
95
 
95
- # unit tests for v1_mailboxes_email_export_post
96
+ # unit tests for export_mailbox
96
97
  # Request a mailbox export
97
98
  # Issues a one-shot \"presigned\" download URL for the mailbox's content in mbox format. The URL works without an Authorization header — the token in the query string is the authz. TTL is 5 minutes; the token is consumed on first GET. **v1 caveat:** the synthesized mbox only contains outbound mail (from `lockally.messages`). v2 swaps in Stalwart's export primitive for full inbox + folder structure + flags. The endpoint contract stays unchanged. **Scope changed:** this used to accept `mailboxes:read`. It takes any mailbox in the tenant and returns that mailbox's mail, so it now requires `tenant:admin`, matching `POST /v1/ediscovery/export`. A key scoped `mailboxes:read` gets 403 and has to be reissued; admin console sessions are unaffected.
98
99
  # @param email
99
100
  # @param [Hash] opts the optional parameters
100
- # @return [V1MailboxesEmailExportPost201Response]
101
- describe 'v1_mailboxes_email_export_post test' do
101
+ # @return [ExportMailbox201Response]
102
+ describe 'export_mailbox test' do
102
103
  it 'should work' do
103
104
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
104
105
  end
105
106
  end
106
107
 
107
- # unit tests for v1_mailboxes_email_get
108
+ # unit tests for get_mailbox
108
109
  # Get a mailbox
109
110
  # @param email
110
111
  # @param [Hash] opts the optional parameters
111
112
  # @return [Mailbox]
112
- describe 'v1_mailboxes_email_get test' do
113
+ describe 'get_mailbox test' do
113
114
  it 'should work' do
114
115
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
115
116
  end
116
117
  end
117
118
 
118
- # unit tests for v1_mailboxes_email_patch
119
- # Update a mailbox
120
- # Supply at least one of `password`, `quota_bytes`, `disabled`. Returns the updated mailbox.
119
+ # unit tests for get_vacation_responder
120
+ # Get the vacation responder
121
+ # Returns the stored vacation rule or 404 if none is set.
121
122
  # @param email
122
- # @param v1_mailboxes_email_patch_request
123
123
  # @param [Hash] opts the optional parameters
124
- # @return [Mailbox]
125
- describe 'v1_mailboxes_email_patch test' do
124
+ # @return [VacationResponder]
125
+ describe 'get_vacation_responder test' do
126
126
  it 'should work' do
127
127
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
128
128
  end
129
129
  end
130
130
 
131
- # unit tests for v1_mailboxes_email_vacation_delete
132
- # Remove the vacation responder
133
- # Idempotent — 204 whether or not a row existed.
134
- # @param email
131
+ # unit tests for list_mailboxes
132
+ # List mailboxes
133
+ # Returns mailboxes under the calling tenant — active and soft-deleted. `?limit=N` between 1 and 200 (default 50).
135
134
  # @param [Hash] opts the optional parameters
136
- # @return [nil]
137
- describe 'v1_mailboxes_email_vacation_delete test' do
135
+ # @option opts [Integer] :limit
136
+ # @return [ListMailboxes200Response]
137
+ describe 'list_mailboxes test' do
138
138
  it 'should work' do
139
139
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
140
140
  end
141
141
  end
142
142
 
143
- # unit tests for v1_mailboxes_email_vacation_get
144
- # Get the vacation responder
145
- # Returns the stored vacation rule or 404 if none is set.
143
+ # unit tests for list_shared_members
144
+ # List shared mailbox members
146
145
  # @param email
147
146
  # @param [Hash] opts the optional parameters
148
- # @return [VacationResponder]
149
- describe 'v1_mailboxes_email_vacation_get test' do
147
+ # @return [ListSharedMembers200Response]
148
+ describe 'list_shared_members test' do
150
149
  it 'should work' do
151
150
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
152
151
  end
153
152
  end
154
153
 
155
- # unit tests for v1_mailboxes_email_vacation_put
156
- # Set the vacation responder
157
- # 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.
158
- # @param email
159
- # @param v1_mailboxes_email_vacation_put_request
154
+ # unit tests for list_vacation_responders
155
+ # List all vacation responders
156
+ # Returns every vacation responder for the calling tenant.
160
157
  # @param [Hash] opts the optional parameters
161
- # @return [VacationResponder]
162
- describe 'v1_mailboxes_email_vacation_put test' do
158
+ # @return [ListVacationResponders200Response]
159
+ describe 'list_vacation_responders test' do
163
160
  it 'should work' do
164
161
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
165
162
  end
166
163
  end
167
164
 
168
- # unit tests for v1_mailboxes_get
169
- # List mailboxes
170
- # Returns mailboxes under the calling tenant — active and soft-deleted. `?limit=N` between 1 and 200 (default 50).
165
+ # unit tests for remove_shared_member
166
+ # Remove a shared mailbox member
167
+ # @param email
168
+ # @param member_email
171
169
  # @param [Hash] opts the optional parameters
172
- # @option opts [Integer] :limit
173
- # @return [V1MailboxesGet200Response]
174
- describe 'v1_mailboxes_get test' do
170
+ # @return [nil]
171
+ describe 'remove_shared_member test' do
175
172
  it 'should work' do
176
173
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
177
174
  end
178
175
  end
179
176
 
180
- # unit tests for v1_mailboxes_post
181
- # Create a mailbox
182
- # 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.
183
- # @param v1_mailboxes_post_request
177
+ # unit tests for set_vacation_responder
178
+ # Set the vacation responder
179
+ # 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.
180
+ # @param email
181
+ # @param set_vacation_responder_request
184
182
  # @param [Hash] opts the optional parameters
185
- # @return [Mailbox]
186
- describe 'v1_mailboxes_post test' do
183
+ # @return [VacationResponder]
184
+ describe 'set_vacation_responder test' do
187
185
  it 'should work' do
188
186
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
189
187
  end
190
188
  end
191
189
 
192
- # unit tests for v1_vacation_get
193
- # List all vacation responders
194
- # Returns every vacation responder for the calling tenant.
190
+ # unit tests for update_mailbox
191
+ # Update a mailbox
192
+ # Supply at least one of `password`, `quota_bytes`, `disabled`. Returns the updated mailbox.
193
+ # @param email
194
+ # @param update_mailbox_request
195
195
  # @param [Hash] opts the optional parameters
196
- # @return [V1VacationGet200Response]
197
- describe 'v1_vacation_get test' do
196
+ # @return [Mailbox]
197
+ describe 'update_mailbox test' do
198
198
  it 'should work' do
199
199
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
200
200
  end
@@ -32,47 +32,30 @@ describe 'SendApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for v1_messages_get
36
- # List outbound messages
37
- # Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box.
38
- # @param [Hash] opts the optional parameters
39
- # @option opts [String] :status
40
- # @option opts [String] :sender Exact match against the `from` mailbox.
41
- # @option opts [String] :q Free-text search across subject + sender.
42
- # @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
43
- # @option opts [String] :cursor queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
44
- # @option opts [Integer] :limit
45
- # @return [V1MessagesGet200Response]
46
- describe 'v1_messages_get test' do
47
- it 'should work' do
48
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
- end
50
- end
51
-
52
- # unit tests for v1_messages_id_delete
35
+ # unit tests for cancel_message
53
36
  # Cancel a scheduled send
54
37
  # Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
55
38
  # @param id
56
39
  # @param [Hash] opts the optional parameters
57
40
  # @return [nil]
58
- describe 'v1_messages_id_delete test' do
41
+ describe 'cancel_message test' do
59
42
  it 'should work' do
60
43
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
61
44
  end
62
45
  end
63
46
 
64
- # unit tests for v1_messages_id_get
47
+ # unit tests for get_message
65
48
  # Get message status
66
49
  # @param id
67
50
  # @param [Hash] opts the optional parameters
68
51
  # @return [MessageDetail]
69
- describe 'v1_messages_id_get test' do
52
+ describe 'get_message test' do
70
53
  it 'should work' do
71
54
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
72
55
  end
73
56
  end
74
57
 
75
- # unit tests for v1_messages_stats_get
58
+ # unit tests for get_message_stats
76
59
  # Aggregate delivery stats
77
60
  # Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking.
78
61
  # @param [Hash] opts the optional parameters
@@ -80,33 +63,50 @@ describe 'SendApi' do
80
63
  # @option opts [Time] :to Window end (default now).
81
64
  # @option opts [String] :domain Filter by sender domain.
82
65
  # @return [MessageStats]
83
- describe 'v1_messages_stats_get test' do
66
+ describe 'get_message_stats test' do
84
67
  it 'should work' do
85
68
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
86
69
  end
87
70
  end
88
71
 
89
- # unit tests for v1_send_batch_post
90
- # Send a batch of emails
91
- # Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`.
92
- # @param idempotency_key
93
- # @param v1_send_batch_post_request
72
+ # unit tests for list_messages
73
+ # List outbound messages
74
+ # Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box.
94
75
  # @param [Hash] opts the optional parameters
95
- # @return [V1SendBatchPost200Response]
96
- describe 'v1_send_batch_post test' do
76
+ # @option opts [String] :status
77
+ # @option opts [String] :sender Exact match against the `from` mailbox.
78
+ # @option opts [String] :q Free-text search across subject + sender.
79
+ # @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
80
+ # @option opts [String] :cursor queued_at of the prior page boundary. Pass back the `next_cursor` returned by the previous call.
81
+ # @option opts [Integer] :limit
82
+ # @return [ListMessages200Response]
83
+ describe 'list_messages test' do
97
84
  it 'should work' do
98
85
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
99
86
  end
100
87
  end
101
88
 
102
- # unit tests for v1_send_post
89
+ # unit tests for send_email
103
90
  # Send an email
104
- # Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`. **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message. **Sender authorisation.** `from` must be a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported. **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped. **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. **Not every success is a 202.** Check the status code, not just the body. A `200` means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the `200` response below. **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry `X-Warmup-Day`, `X-Warmup-Daily-Cap` and `X-Warmup-Used-Today`. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429.
91
+ # Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`. **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message. **Sender authorisation.** `from` must be an address the calling tenant owns on a verified domain. A mailbox always qualifies. On business and combined accounts an **alias** qualifies too, so a send-only address such as `no-reply@` need not be a billed seat. An alias on an unverified domain, or one belonging to another account, is refused with `403`. A catch-all creates no aliases and so grants no sending rights. **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped. **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. **Not every success is a 202.** Check the status code, not just the body. A `200` means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the `200` response below. **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry `X-Warmup-Day`, `X-Warmup-Daily-Cap` and `X-Warmup-Used-Today`. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429.
92
+ # @param idempotency_key
93
+ # @param send_email_request
94
+ # @param [Hash] opts the optional parameters
95
+ # @return [SendEmail200Response]
96
+ describe 'send_email test' do
97
+ it 'should work' do
98
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
99
+ end
100
+ end
101
+
102
+ # unit tests for send_email_batch
103
+ # Send a batch of emails
104
+ # Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`.
105
105
  # @param idempotency_key
106
- # @param v1_send_post_request
106
+ # @param send_email_batch_request
107
107
  # @param [Hash] opts the optional parameters
108
- # @return [V1SendPost200Response]
109
- describe 'v1_send_post test' do
108
+ # @return [SendEmailBatch200Response]
109
+ describe 'send_email_batch test' do
110
110
  it 'should work' do
111
111
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
112
112
  end
@@ -36,7 +36,7 @@ describe 'SignupApi' do
36
36
  # Sign up a new tenant
37
37
  # @param signup_request
38
38
  # @param [Hash] opts the optional parameters
39
- # @return [V1AdminLoginPost200Response]
39
+ # @return [AdminLogin200Response]
40
40
  describe 'signup test' do
41
41
  it 'should work' do
42
42
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -32,47 +32,47 @@ describe 'SuppressionsApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for v1_suppressions_email_delete
35
+ # unit tests for create_suppression
36
+ # Add a suppression
37
+ # @param create_suppression_request
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [Suppression]
40
+ describe 'create_suppression test' do
41
+ it 'should work' do
42
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
+ end
44
+ end
45
+
46
+ # unit tests for delete_suppression
36
47
  # Remove a suppression
37
48
  # @param email
38
49
  # @param [Hash] opts the optional parameters
39
50
  # @return [nil]
40
- describe 'v1_suppressions_email_delete test' do
51
+ describe 'delete_suppression test' do
41
52
  it 'should work' do
42
53
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
54
  end
44
55
  end
45
56
 
46
- # unit tests for v1_suppressions_email_get
57
+ # unit tests for get_suppression
47
58
  # Check whether an address is suppressed
48
59
  # @param email
49
60
  # @param [Hash] opts the optional parameters
50
61
  # @return [Suppression]
51
- describe 'v1_suppressions_email_get test' do
62
+ describe 'get_suppression test' do
52
63
  it 'should work' do
53
64
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
54
65
  end
55
66
  end
56
67
 
57
- # unit tests for v1_suppressions_get
68
+ # unit tests for list_suppressions
58
69
  # List suppressed recipients
59
70
  # @param [Hash] opts the optional parameters
60
71
  # @option opts [String] :reason
61
72
  # @option opts [String] :cursor
62
73
  # @option opts [Integer] :limit
63
- # @return [V1SuppressionsGet200Response]
64
- describe 'v1_suppressions_get test' do
65
- it 'should work' do
66
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
67
- end
68
- end
69
-
70
- # unit tests for v1_suppressions_post
71
- # Add a suppression
72
- # @param v1_suppressions_post_request
73
- # @param [Hash] opts the optional parameters
74
- # @return [Suppression]
75
- describe 'v1_suppressions_post test' do
74
+ # @return [ListSuppressions200Response]
75
+ describe 'list_suppressions test' do
76
76
  it 'should work' do
77
77
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
78
78
  end
@@ -32,56 +32,56 @@ describe 'TemplatesApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for v1_templates_get
36
- # List templates
35
+ # unit tests for create_template
36
+ # Create a template
37
+ # @param template_input
37
38
  # @param [Hash] opts the optional parameters
38
- # @return [V1TemplatesGet200Response]
39
- describe 'v1_templates_get test' do
39
+ # @return [Template]
40
+ describe 'create_template test' do
40
41
  it 'should work' do
41
42
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
42
43
  end
43
44
  end
44
45
 
45
- # unit tests for v1_templates_id_delete
46
+ # unit tests for delete_template
46
47
  # Delete a template
47
48
  # @param id
48
49
  # @param [Hash] opts the optional parameters
49
50
  # @return [nil]
50
- describe 'v1_templates_id_delete test' do
51
+ describe 'delete_template test' do
51
52
  it 'should work' do
52
53
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
53
54
  end
54
55
  end
55
56
 
56
- # unit tests for v1_templates_id_get
57
+ # unit tests for get_template
57
58
  # Get a template
58
59
  # @param id
59
60
  # @param [Hash] opts the optional parameters
60
61
  # @return [Template]
61
- describe 'v1_templates_id_get test' do
62
+ describe 'get_template test' do
62
63
  it 'should work' do
63
64
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
64
65
  end
65
66
  end
66
67
 
67
- # unit tests for v1_templates_id_put
68
- # Update a template
69
- # @param id
70
- # @param template_input
68
+ # unit tests for list_templates
69
+ # List templates
71
70
  # @param [Hash] opts the optional parameters
72
- # @return [Template]
73
- describe 'v1_templates_id_put test' do
71
+ # @return [ListTemplates200Response]
72
+ describe 'list_templates test' do
74
73
  it 'should work' do
75
74
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
76
75
  end
77
76
  end
78
77
 
79
- # unit tests for v1_templates_post
80
- # Create a template
78
+ # unit tests for update_template
79
+ # Update a template
80
+ # @param id
81
81
  # @param template_input
82
82
  # @param [Hash] opts the optional parameters
83
83
  # @return [Template]
84
- describe 'v1_templates_post test' do
84
+ describe 'update_template test' do
85
85
  it 'should work' do
86
86
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
87
  end
@@ -32,23 +32,23 @@ describe 'TenantApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for v1_tenant_get
35
+ # unit tests for get_tenant
36
36
  # Get the calling tenant
37
37
  # Returns the tenant the presented API key belongs to.
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @return [Tenant]
40
- describe 'v1_tenant_get test' do
40
+ describe 'get_tenant test' do
41
41
  it 'should work' do
42
42
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
43
  end
44
44
  end
45
45
 
46
- # unit tests for v1_usage_get
46
+ # unit tests for get_usage
47
47
  # Usage snapshot
48
48
  # Returns the tenant's current usage + cap consumption. Designed for poll-based alerting on the integrator side (e.g. \"warn when daily quota is 80% used\"). Refreshed live from Postgres — there is no cache, so callers should poll at most once per minute.
49
49
  # @param [Hash] opts the optional parameters
50
- # @return [V1UsageGet200Response]
51
- describe 'v1_usage_get test' do
50
+ # @return [GetUsage200Response]
51
+ describe 'get_usage test' do
52
52
  it 'should work' do
53
53
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
54
54
  end
@@ -32,12 +32,12 @@ describe 'TestApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for v1_test_inbound_post
35
+ # unit tests for simulate_inbound_email
36
36
  # Simulate an inbound email (test keys only)
37
37
  # Runs a synthetic message through the REAL indexing pipeline — thread adoption, deterministic extraction (incl. injection_risk), and the message.received webhook — so the whole agent loop is testable without a real domain or MTA. Requires an lk_test_* key (create with {\"test\": true} on POST /v1/api-keys). Body: {mailbox, from, subject, text, in_reply_to?, references?}.
38
38
  # @param [Hash] opts the optional parameters
39
- # @return [Object]
40
- describe 'v1_test_inbound_post test' do
39
+ # @return [SimulatedInbound]
40
+ describe 'simulate_inbound_email test' do
41
41
  it 'should work' do
42
42
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
43
  end
@@ -32,49 +32,49 @@ describe 'WebhooksApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for v1_webhooks_get
36
- # List webhooks
37
- # Returns the calling tenant's webhook subscriptions. Never returns the signing secret — only metadata.
35
+ # unit tests for create_webhook
36
+ # Create a webhook
37
+ # Subscribes a URL to one or more event types. Returns the `signing_secret` ONCE in the response — store it immediately. The dispatcher signs every outbound POST per design L3: X-Lockally-Signature: t=<unix>,v1=<hex(hmac_sha256(secret, t + \".\" + body))> Verify on your end using HMAC-SHA256 with a 5-minute timestamp window (replay protection). A reference verifier ships in [internal/webhook](https://github.com/ucheigwedinma/lockally/blob/main/internal/webhook/sign.go). Event names: see the [event catalogue](https://github.com/ucheigwedinma/lockally/blob/main/docs/v1-design.md#64-webhook-event-catalogue-v1).
38
+ # @param create_webhook_request
38
39
  # @param [Hash] opts the optional parameters
39
- # @return [V1WebhooksGet200Response]
40
- describe 'v1_webhooks_get test' do
40
+ # @return [Webhook]
41
+ describe 'create_webhook test' do
41
42
  it 'should work' do
42
43
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
44
  end
44
45
  end
45
46
 
46
- # unit tests for v1_webhooks_id_delete
47
+ # unit tests for delete_webhook
47
48
  # Delete a webhook
48
49
  # Hard-delete; cascades to `webhook_deliveries` history.
49
50
  # @param id
50
51
  # @param [Hash] opts the optional parameters
51
52
  # @return [nil]
52
- describe 'v1_webhooks_id_delete test' do
53
+ describe 'delete_webhook test' do
53
54
  it 'should work' do
54
55
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
55
56
  end
56
57
  end
57
58
 
58
- # unit tests for v1_webhooks_id_patch
59
- # Update a webhook
60
- # Supply at least one of `url`, `events`, `paused`. Setting `paused` to `false` ALSO resets `consecutive_failures` to 0 — re-arms the 50-failure auto-pause counter.
61
- # @param id
62
- # @param v1_webhooks_id_patch_request
59
+ # unit tests for list_webhooks
60
+ # List webhooks
61
+ # Returns the calling tenant's webhook subscriptions. Never returns the signing secret — only metadata.
63
62
  # @param [Hash] opts the optional parameters
64
- # @return [Webhook]
65
- describe 'v1_webhooks_id_patch test' do
63
+ # @return [ListWebhooks200Response]
64
+ describe 'list_webhooks test' do
66
65
  it 'should work' do
67
66
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
68
67
  end
69
68
  end
70
69
 
71
- # unit tests for v1_webhooks_post
72
- # Create a webhook
73
- # Subscribes a URL to one or more event types. Returns the `signing_secret` ONCE in the response — store it immediately. The dispatcher signs every outbound POST per design L3: X-Lockally-Signature: t=<unix>,v1=<hex(hmac_sha256(secret, t + \".\" + body))> Verify on your end using HMAC-SHA256 with a 5-minute timestamp window (replay protection). A reference verifier ships in [internal/webhook](https://github.com/ucheigwedinma/lockally/blob/main/internal/webhook/sign.go). Event names: see the [event catalogue](https://github.com/ucheigwedinma/lockally/blob/main/docs/v1-design.md#64-webhook-event-catalogue-v1).
74
- # @param v1_webhooks_post_request
70
+ # unit tests for update_webhook
71
+ # Update a webhook
72
+ # Supply at least one of `url`, `events`, `paused`. Setting `paused` to `false` ALSO resets `consecutive_failures` to 0 — re-arms the 50-failure auto-pause counter.
73
+ # @param id
74
+ # @param update_webhook_request
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @return [Webhook]
77
- describe 'v1_webhooks_post test' do
77
+ describe 'update_webhook test' do
78
78
  it 'should work' do
79
79
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
80
80
  end
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for Lockally::V1AdminLoginPost200Response
17
+ # Unit tests for Lockally::AdminLogin200Response
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe Lockally::V1AdminLoginPost200Response do
21
- #let(:instance) { Lockally::V1AdminLoginPost200Response.new }
20
+ describe Lockally::AdminLogin200Response do
21
+ #let(:instance) { Lockally::AdminLogin200Response.new }
22
22
 
23
- describe 'test an instance of V1AdminLoginPost200Response' do
24
- it 'should create an instance of V1AdminLoginPost200Response' do
23
+ describe 'test an instance of AdminLogin200Response' do
24
+ it 'should create an instance of AdminLogin200Response' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(Lockally::V1AdminLoginPost200Response)
26
+ #expect(instance).to be_instance_of(Lockally::AdminLogin200Response)
27
27
  end
28
28
  end
29
29