lockally 0.1.0__tar.gz

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 (430) hide show
  1. lockally-0.1.0/LICENSE +21 -0
  2. lockally-0.1.0/PKG-INFO +517 -0
  3. lockally-0.1.0/README.md +497 -0
  4. lockally-0.1.0/lockally/__init__.py +457 -0
  5. lockally-0.1.0/lockally/api/__init__.py +34 -0
  6. lockally-0.1.0/lockally/api/add_ons_api.py +1093 -0
  7. lockally-0.1.0/lockally/api/admin_api.py +826 -0
  8. lockally-0.1.0/lockally/api/admins_api.py +1155 -0
  9. lockally-0.1.0/lockally/api/agents_api.py +3588 -0
  10. lockally-0.1.0/lockally/api/ai_api.py +1057 -0
  11. lockally-0.1.0/lockally/api/aliases_api.py +846 -0
  12. lockally-0.1.0/lockally/api/api_keys_api.py +849 -0
  13. lockally-0.1.0/lockally/api/billing_api.py +858 -0
  14. lockally-0.1.0/lockally/api/calendars_api.py +5946 -0
  15. lockally-0.1.0/lockally/api/contact_lists_api.py +1987 -0
  16. lockally-0.1.0/lockally/api/contacts_api.py +1762 -0
  17. lockally-0.1.0/lockally/api/dashboard_api.py +1792 -0
  18. lockally-0.1.0/lockally/api/directory_api.py +2103 -0
  19. lockally-0.1.0/lockally/api/distribution_lists_api.py +1410 -0
  20. lockally-0.1.0/lockally/api/domains_api.py +1397 -0
  21. lockally-0.1.0/lockally/api/drafts_api.py +1912 -0
  22. lockally-0.1.0/lockally/api/encryption_api.py +1422 -0
  23. lockally-0.1.0/lockally/api/health_api.py +285 -0
  24. lockally-0.1.0/lockally/api/ip_pools_api.py +823 -0
  25. lockally-0.1.0/lockally/api/mailboxes_api.py +3952 -0
  26. lockally-0.1.0/lockally/api/migrations_api.py +5861 -0
  27. lockally-0.1.0/lockally/api/resources_api.py +1405 -0
  28. lockally-0.1.0/lockally/api/send_api.py +1869 -0
  29. lockally-0.1.0/lockally/api/signup_api.py +314 -0
  30. lockally-0.1.0/lockally/api/suppressions_api.py +1137 -0
  31. lockally-0.1.0/lockally/api/templates_api.py +1386 -0
  32. lockally-0.1.0/lockally/api/tenant_api.py +543 -0
  33. lockally-0.1.0/lockally/api/test_api.py +285 -0
  34. lockally-0.1.0/lockally/api/users_api.py +1431 -0
  35. lockally-0.1.0/lockally/api/webhooks_api.py +1149 -0
  36. lockally-0.1.0/lockally/api_client.py +805 -0
  37. lockally-0.1.0/lockally/api_response.py +21 -0
  38. lockally-0.1.0/lockally/configuration.py +619 -0
  39. lockally-0.1.0/lockally/exceptions.py +219 -0
  40. lockally-0.1.0/lockally/models/__init__.py +192 -0
  41. lockally-0.1.0/lockally/models/activate_add_on200_response.py +96 -0
  42. lockally-0.1.0/lockally/models/add_calendar_member_request.py +101 -0
  43. lockally-0.1.0/lockally/models/add_contact_list_member_request.py +90 -0
  44. lockally-0.1.0/lockally/models/add_on.py +99 -0
  45. lockally-0.1.0/lockally/models/add_shared_member_request.py +101 -0
  46. lockally-0.1.0/lockally/models/admin.py +110 -0
  47. lockally-0.1.0/lockally/models/admin_full.py +116 -0
  48. lockally-0.1.0/lockally/models/alias.py +99 -0
  49. lockally-0.1.0/lockally/models/api_key.py +105 -0
  50. lockally-0.1.0/lockally/models/audit_event.py +98 -0
  51. lockally-0.1.0/lockally/models/batch_lookup_public_keys200_response.py +97 -0
  52. lockally-0.1.0/lockally/models/batch_lookup_public_keys200_response_data_inner.py +94 -0
  53. lockally-0.1.0/lockally/models/batch_result.py +108 -0
  54. lockally-0.1.0/lockally/models/billing_status.py +148 -0
  55. lockally-0.1.0/lockally/models/calendar.py +118 -0
  56. lockally-0.1.0/lockally/models/calendar_event.py +113 -0
  57. lockally-0.1.0/lockally/models/calendar_integration.py +121 -0
  58. lockally-0.1.0/lockally/models/calendar_member.py +108 -0
  59. lockally-0.1.0/lockally/models/calendar_policies.py +123 -0
  60. lockally-0.1.0/lockally/models/contact.py +124 -0
  61. lockally-0.1.0/lockally/models/contact_list.py +112 -0
  62. lockally-0.1.0/lockally/models/create_billing_checkout200_response.py +91 -0
  63. lockally-0.1.0/lockally/models/create_billing_checkout_request.py +96 -0
  64. lockally-0.1.0/lockally/models/create_calendar_event_request.py +100 -0
  65. lockally-0.1.0/lockally/models/create_calendar_integration_request.py +98 -0
  66. lockally-0.1.0/lockally/models/create_calendar_request.py +107 -0
  67. lockally-0.1.0/lockally/models/create_contact_list_request.py +103 -0
  68. lockally-0.1.0/lockally/models/create_contact_request.py +113 -0
  69. lockally-0.1.0/lockally/models/create_dedicated_ip_request_request.py +89 -0
  70. lockally-0.1.0/lockally/models/create_distribution_list_request.py +93 -0
  71. lockally-0.1.0/lockally/models/create_encryption_key201_response.py +95 -0
  72. lockally-0.1.0/lockally/models/create_encryption_key_request.py +95 -0
  73. lockally-0.1.0/lockally/models/create_encryption_recovery_request.py +91 -0
  74. lockally-0.1.0/lockally/models/create_migration_credential_request.py +104 -0
  75. lockally-0.1.0/lockally/models/create_migration_credential_request_credentials.py +97 -0
  76. lockally-0.1.0/lockally/models/create_migration_request.py +100 -0
  77. lockally-0.1.0/lockally/models/create_resource_request.py +104 -0
  78. lockally-0.1.0/lockally/models/create_units_checkout200_response.py +93 -0
  79. lockally-0.1.0/lockally/models/create_units_checkout_request.py +96 -0
  80. lockally-0.1.0/lockally/models/create_user_request.py +97 -0
  81. lockally-0.1.0/lockally/models/dedicated_ip_request.py +110 -0
  82. lockally-0.1.0/lockally/models/directory_permissions.py +131 -0
  83. lockally-0.1.0/lockally/models/discover_migration202_response.py +89 -0
  84. lockally-0.1.0/lockally/models/distribution_list_detail.py +103 -0
  85. lockally-0.1.0/lockally/models/distribution_list_summary.py +101 -0
  86. lockally-0.1.0/lockally/models/dns_record.py +113 -0
  87. lockally-0.1.0/lockally/models/domain.py +117 -0
  88. lockally-0.1.0/lockally/models/gal_settings.py +116 -0
  89. lockally-0.1.0/lockally/models/get_add_on_status200_response.py +93 -0
  90. lockally-0.1.0/lockally/models/get_audit_summary200_response.py +120 -0
  91. lockally-0.1.0/lockally/models/get_calendar_security200_response.py +131 -0
  92. lockally-0.1.0/lockally/models/get_calendar_security200_response_alerts_inner.py +101 -0
  93. lockally-0.1.0/lockally/models/get_calendar_security200_response_delegated_access_inner.py +99 -0
  94. lockally-0.1.0/lockally/models/get_calendar_security200_response_external_sharing.py +93 -0
  95. lockally-0.1.0/lockally/models/get_calendar_security200_response_public_calendar_list_inner.py +98 -0
  96. lockally-0.1.0/lockally/models/get_contact_list200_response.py +103 -0
  97. lockally-0.1.0/lockally/models/get_contact_list200_response_members_inner.py +94 -0
  98. lockally-0.1.0/lockally/models/get_contact_lists200_response.py +97 -0
  99. lockally-0.1.0/lockally/models/get_contact_lists200_response_data_inner.py +94 -0
  100. lockally-0.1.0/lockally/models/get_directory_activity200_response.py +97 -0
  101. lockally-0.1.0/lockally/models/get_directory_activity200_response_data_inner.py +96 -0
  102. lockally-0.1.0/lockally/models/get_directory_stats200_response.py +99 -0
  103. lockally-0.1.0/lockally/models/get_domains_status200_response.py +100 -0
  104. lockally-0.1.0/lockally/models/get_domains_status200_response_domains_inner.py +101 -0
  105. lockally-0.1.0/lockally/models/get_domains_status200_response_domains_inner_checks_inner.py +103 -0
  106. lockally-0.1.0/lockally/models/get_encryption_key200_response.py +100 -0
  107. lockally-0.1.0/lockally/models/get_integrations_summary200_response.py +118 -0
  108. lockally-0.1.0/lockally/models/get_integrations_summary200_response_api_keys_inner.py +94 -0
  109. lockally-0.1.0/lockally/models/get_integrations_summary200_response_webhooks_inner.py +96 -0
  110. lockally-0.1.0/lockally/models/get_ip_assignment200_response.py +98 -0
  111. lockally-0.1.0/lockally/models/get_security200_response.py +119 -0
  112. lockally-0.1.0/lockally/models/get_security200_response_alerts_inner.py +104 -0
  113. lockally-0.1.0/lockally/models/get_security200_response_stats_inner.py +93 -0
  114. lockally-0.1.0/lockally/models/get_storage200_response.py +116 -0
  115. lockally-0.1.0/lockally/models/get_storage200_response_top_mailboxes_inner.py +91 -0
  116. lockally-0.1.0/lockally/models/get_storage200_response_top_messages_inner.py +98 -0
  117. lockally-0.1.0/lockally/models/get_user_insights200_response.py +122 -0
  118. lockally-0.1.0/lockally/models/healthz_get200_response.py +99 -0
  119. lockally-0.1.0/lockally/models/list_add_ons200_response.py +97 -0
  120. lockally-0.1.0/lockally/models/list_calendar_events200_response.py +97 -0
  121. lockally-0.1.0/lockally/models/list_calendar_integrations200_response.py +97 -0
  122. lockally-0.1.0/lockally/models/list_calendar_members200_response.py +97 -0
  123. lockally-0.1.0/lockally/models/list_calendars200_response.py +97 -0
  124. lockally-0.1.0/lockally/models/list_contact_lists200_response.py +97 -0
  125. lockally-0.1.0/lockally/models/list_contacts200_response.py +97 -0
  126. lockally-0.1.0/lockally/models/list_dedicated_ip_requests200_response.py +97 -0
  127. lockally-0.1.0/lockally/models/list_distribution_lists200_response.py +97 -0
  128. lockally-0.1.0/lockally/models/list_migration_credentials200_response.py +97 -0
  129. lockally-0.1.0/lockally/models/list_migration_events200_response.py +97 -0
  130. lockally-0.1.0/lockally/models/list_migration_mailboxes200_response.py +97 -0
  131. lockally-0.1.0/lockally/models/list_migrations200_response.py +97 -0
  132. lockally-0.1.0/lockally/models/list_resources200_response.py +97 -0
  133. lockally-0.1.0/lockally/models/list_shared_members200_response.py +97 -0
  134. lockally-0.1.0/lockally/models/list_users200_response.py +99 -0
  135. lockally-0.1.0/lockally/models/mailbox.py +111 -0
  136. lockally-0.1.0/lockally/models/map_migration_request.py +97 -0
  137. lockally-0.1.0/lockally/models/map_migration_request_mappings_inner.py +91 -0
  138. lockally-0.1.0/lockally/models/message.py +118 -0
  139. lockally-0.1.0/lockally/models/message_stats.py +109 -0
  140. lockally-0.1.0/lockally/models/message_stats_counts.py +95 -0
  141. lockally-0.1.0/lockally/models/message_stats_rates.py +95 -0
  142. lockally-0.1.0/lockally/models/message_stats_window.py +92 -0
  143. lockally-0.1.0/lockally/models/migration.py +128 -0
  144. lockally-0.1.0/lockally/models/migration_credential.py +110 -0
  145. lockally-0.1.0/lockally/models/migration_event.py +109 -0
  146. lockally-0.1.0/lockally/models/migration_mailbox.py +127 -0
  147. lockally-0.1.0/lockally/models/migration_progress.py +116 -0
  148. lockally-0.1.0/lockally/models/migration_progress_mailboxes_inner.py +101 -0
  149. lockally-0.1.0/lockally/models/migration_settings.py +97 -0
  150. lockally-0.1.0/lockally/models/plan_catalog_entry.py +107 -0
  151. lockally-0.1.0/lockally/models/problem.py +97 -0
  152. lockally-0.1.0/lockally/models/replace_distribution_list_members200_response.py +98 -0
  153. lockally-0.1.0/lockally/models/replace_distribution_list_members_request.py +89 -0
  154. lockally-0.1.0/lockally/models/resource.py +112 -0
  155. lockally-0.1.0/lockally/models/rotate_encryption_key_request.py +93 -0
  156. lockally-0.1.0/lockally/models/send_message.py +124 -0
  157. lockally-0.1.0/lockally/models/shared_member.py +108 -0
  158. lockally-0.1.0/lockally/models/signup_request.py +108 -0
  159. lockally-0.1.0/lockally/models/start_migration202_response.py +91 -0
  160. lockally-0.1.0/lockally/models/suppression.py +106 -0
  161. lockally-0.1.0/lockally/models/template.py +103 -0
  162. lockally-0.1.0/lockally/models/template_input.py +95 -0
  163. lockally-0.1.0/lockally/models/tenant.py +120 -0
  164. lockally-0.1.0/lockally/models/unit_bundle.py +97 -0
  165. lockally-0.1.0/lockally/models/update_calendar_event_request.py +100 -0
  166. lockally-0.1.0/lockally/models/update_calendar_integration_request.py +103 -0
  167. lockally-0.1.0/lockally/models/update_calendar_member_request.py +96 -0
  168. lockally-0.1.0/lockally/models/update_calendar_policies_request.py +116 -0
  169. lockally-0.1.0/lockally/models/update_calendar_request.py +107 -0
  170. lockally-0.1.0/lockally/models/update_contact_list_request.py +103 -0
  171. lockally-0.1.0/lockally/models/update_contact_request.py +125 -0
  172. lockally-0.1.0/lockally/models/update_directory_permissions_request.py +135 -0
  173. lockally-0.1.0/lockally/models/update_gal_settings_request.py +107 -0
  174. lockally-0.1.0/lockally/models/update_migration_mailbox_request.py +91 -0
  175. lockally-0.1.0/lockally/models/update_migration_request.py +95 -0
  176. lockally-0.1.0/lockally/models/update_resource_request.py +115 -0
  177. lockally-0.1.0/lockally/models/update_user_request.py +107 -0
  178. lockally-0.1.0/lockally/models/user.py +118 -0
  179. lockally-0.1.0/lockally/models/user_event.py +94 -0
  180. lockally-0.1.0/lockally/models/v1_admin_login_post200_response.py +104 -0
  181. lockally-0.1.0/lockally/models/v1_admin_login_post_request.py +92 -0
  182. lockally-0.1.0/lockally/models/v1_admin_me_get200_response.py +99 -0
  183. lockally-0.1.0/lockally/models/v1_admins_get200_response.py +97 -0
  184. lockally-0.1.0/lockally/models/v1_admins_id_patch_request.py +106 -0
  185. lockally-0.1.0/lockally/models/v1_admins_post_request.py +106 -0
  186. lockally-0.1.0/lockally/models/v1_aliases_get200_response.py +97 -0
  187. lockally-0.1.0/lockally/models/v1_aliases_post_request.py +91 -0
  188. lockally-0.1.0/lockally/models/v1_api_keys_get200_response.py +97 -0
  189. lockally-0.1.0/lockally/models/v1_api_keys_post201_response.py +107 -0
  190. lockally-0.1.0/lockally/models/v1_api_keys_post_request.py +100 -0
  191. lockally-0.1.0/lockally/models/v1_domains_get200_response.py +97 -0
  192. lockally-0.1.0/lockally/models/v1_domains_post_request.py +89 -0
  193. lockally-0.1.0/lockally/models/v1_inboxes_mailbox_messages_post_request.py +97 -0
  194. lockally-0.1.0/lockally/models/v1_mailboxes_email_export_post201_response.py +101 -0
  195. lockally-0.1.0/lockally/models/v1_mailboxes_email_patch_request.py +94 -0
  196. lockally-0.1.0/lockally/models/v1_mailboxes_email_vacation_put_request.py +95 -0
  197. lockally-0.1.0/lockally/models/v1_mailboxes_get200_response.py +99 -0
  198. lockally-0.1.0/lockally/models/v1_mailboxes_post_request.py +94 -0
  199. lockally-0.1.0/lockally/models/v1_messages_get200_response.py +99 -0
  200. lockally-0.1.0/lockally/models/v1_send_batch_post200_response.py +97 -0
  201. lockally-0.1.0/lockally/models/v1_send_batch_post_request.py +98 -0
  202. lockally-0.1.0/lockally/models/v1_send_post202_response.py +103 -0
  203. lockally-0.1.0/lockally/models/v1_send_post_request.py +124 -0
  204. lockally-0.1.0/lockally/models/v1_send_post_request_attachments_inner.py +93 -0
  205. lockally-0.1.0/lockally/models/v1_suppressions_get200_response.py +99 -0
  206. lockally-0.1.0/lockally/models/v1_suppressions_post_request.py +101 -0
  207. lockally-0.1.0/lockally/models/v1_templates_get200_response.py +97 -0
  208. lockally-0.1.0/lockally/models/v1_usage_get200_response.py +114 -0
  209. lockally-0.1.0/lockally/models/v1_vacation_get200_response.py +97 -0
  210. lockally-0.1.0/lockally/models/v1_webhooks_get200_response.py +97 -0
  211. lockally-0.1.0/lockally/models/v1_webhooks_id_patch_request.py +93 -0
  212. lockally-0.1.0/lockally/models/v1_webhooks_post_request.py +92 -0
  213. lockally-0.1.0/lockally/models/vacation_params.py +96 -0
  214. lockally-0.1.0/lockally/models/vacation_responder.py +106 -0
  215. lockally-0.1.0/lockally/models/webhook.py +111 -0
  216. lockally-0.1.0/lockally/py.typed +0 -0
  217. lockally-0.1.0/lockally/rest.py +264 -0
  218. lockally-0.1.0/lockally.egg-info/PKG-INFO +517 -0
  219. lockally-0.1.0/lockally.egg-info/SOURCES.txt +429 -0
  220. lockally-0.1.0/lockally.egg-info/dependency_links.txt +1 -0
  221. lockally-0.1.0/lockally.egg-info/requires.txt +4 -0
  222. lockally-0.1.0/lockally.egg-info/top_level.txt +1 -0
  223. lockally-0.1.0/pyproject.toml +95 -0
  224. lockally-0.1.0/setup.cfg +7 -0
  225. lockally-0.1.0/setup.py +49 -0
  226. lockally-0.1.0/test/test_activate_add_on200_response.py +59 -0
  227. lockally-0.1.0/test/test_add_calendar_member_request.py +54 -0
  228. lockally-0.1.0/test/test_add_contact_list_member_request.py +53 -0
  229. lockally-0.1.0/test/test_add_on.py +63 -0
  230. lockally-0.1.0/test/test_add_ons_api.py +60 -0
  231. lockally-0.1.0/test/test_add_shared_member_request.py +54 -0
  232. lockally-0.1.0/test/test_admin.py +63 -0
  233. lockally-0.1.0/test/test_admin_api.py +53 -0
  234. lockally-0.1.0/test/test_admin_full.py +67 -0
  235. lockally-0.1.0/test/test_admins_api.py +60 -0
  236. lockally-0.1.0/test/test_agents_api.py +123 -0
  237. lockally-0.1.0/test/test_ai_api.py +60 -0
  238. lockally-0.1.0/test/test_alias.py +61 -0
  239. lockally-0.1.0/test/test_aliases_api.py +53 -0
  240. lockally-0.1.0/test/test_api_key.py +69 -0
  241. lockally-0.1.0/test/test_api_keys_api.py +53 -0
  242. lockally-0.1.0/test/test_audit_event.py +56 -0
  243. lockally-0.1.0/test/test_batch_lookup_public_keys200_response.py +57 -0
  244. lockally-0.1.0/test/test_batch_lookup_public_keys200_response_data_inner.py +54 -0
  245. lockally-0.1.0/test/test_batch_result.py +56 -0
  246. lockally-0.1.0/test/test_billing_api.py +53 -0
  247. lockally-0.1.0/test/test_billing_status.py +116 -0
  248. lockally-0.1.0/test/test_calendar.py +68 -0
  249. lockally-0.1.0/test/test_calendar_event.py +73 -0
  250. lockally-0.1.0/test/test_calendar_integration.py +66 -0
  251. lockally-0.1.0/test/test_calendar_member.py +63 -0
  252. lockally-0.1.0/test/test_calendar_policies.py +64 -0
  253. lockally-0.1.0/test/test_calendars_api.py +179 -0
  254. lockally-0.1.0/test/test_contact.py +73 -0
  255. lockally-0.1.0/test/test_contact_list.py +66 -0
  256. lockally-0.1.0/test/test_contact_lists_api.py +81 -0
  257. lockally-0.1.0/test/test_contacts_api.py +74 -0
  258. lockally-0.1.0/test/test_create_billing_checkout200_response.py +55 -0
  259. lockally-0.1.0/test/test_create_billing_checkout_request.py +53 -0
  260. lockally-0.1.0/test/test_create_calendar_event_request.py +60 -0
  261. lockally-0.1.0/test/test_create_calendar_integration_request.py +54 -0
  262. lockally-0.1.0/test/test_create_calendar_request.py +57 -0
  263. lockally-0.1.0/test/test_create_contact_list_request.py +55 -0
  264. lockally-0.1.0/test/test_create_contact_request.py +61 -0
  265. lockally-0.1.0/test/test_create_dedicated_ip_request_request.py +53 -0
  266. lockally-0.1.0/test/test_create_distribution_list_request.py +57 -0
  267. lockally-0.1.0/test/test_create_encryption_key201_response.py +54 -0
  268. lockally-0.1.0/test/test_create_encryption_key_request.py +58 -0
  269. lockally-0.1.0/test/test_create_encryption_recovery_request.py +55 -0
  270. lockally-0.1.0/test/test_create_migration_credential_request.py +66 -0
  271. lockally-0.1.0/test/test_create_migration_credential_request_credentials.py +58 -0
  272. lockally-0.1.0/test/test_create_migration_request.py +65 -0
  273. lockally-0.1.0/test/test_create_resource_request.py +55 -0
  274. lockally-0.1.0/test/test_create_units_checkout200_response.py +57 -0
  275. lockally-0.1.0/test/test_create_units_checkout_request.py +53 -0
  276. lockally-0.1.0/test/test_create_user_request.py +59 -0
  277. lockally-0.1.0/test/test_dashboard_api.py +81 -0
  278. lockally-0.1.0/test/test_dedicated_ip_request.py +62 -0
  279. lockally-0.1.0/test/test_directory_api.py +88 -0
  280. lockally-0.1.0/test/test_directory_permissions.py +63 -0
  281. lockally-0.1.0/test/test_discover_migration202_response.py +53 -0
  282. lockally-0.1.0/test/test_distribution_list_detail.py +68 -0
  283. lockally-0.1.0/test/test_distribution_list_summary.py +62 -0
  284. lockally-0.1.0/test/test_distribution_lists_api.py +67 -0
  285. lockally-0.1.0/test/test_dns_record.py +62 -0
  286. lockally-0.1.0/test/test_domain.py +77 -0
  287. lockally-0.1.0/test/test_domains_api.py +67 -0
  288. lockally-0.1.0/test/test_drafts_api.py +81 -0
  289. lockally-0.1.0/test/test_encryption_api.py +67 -0
  290. lockally-0.1.0/test/test_gal_settings.py +67 -0
  291. lockally-0.1.0/test/test_get_add_on_status200_response.py +57 -0
  292. lockally-0.1.0/test/test_get_audit_summary200_response.py +77 -0
  293. lockally-0.1.0/test/test_get_calendar_security200_response.py +80 -0
  294. lockally-0.1.0/test/test_get_calendar_security200_response_alerts_inner.py +53 -0
  295. lockally-0.1.0/test/test_get_calendar_security200_response_delegated_access_inner.py +56 -0
  296. lockally-0.1.0/test/test_get_calendar_security200_response_external_sharing.py +54 -0
  297. lockally-0.1.0/test/test_get_calendar_security200_response_public_calendar_list_inner.py +56 -0
  298. lockally-0.1.0/test/test_get_contact_list200_response.py +66 -0
  299. lockally-0.1.0/test/test_get_contact_list200_response_members_inner.py +54 -0
  300. lockally-0.1.0/test/test_get_contact_lists200_response.py +57 -0
  301. lockally-0.1.0/test/test_get_contact_lists200_response_data_inner.py +54 -0
  302. lockally-0.1.0/test/test_get_directory_activity200_response.py +58 -0
  303. lockally-0.1.0/test/test_get_directory_activity200_response_data_inner.py +55 -0
  304. lockally-0.1.0/test/test_get_directory_stats200_response.py +57 -0
  305. lockally-0.1.0/test/test_get_domains_status200_response.py +63 -0
  306. lockally-0.1.0/test/test_get_domains_status200_response_domains_inner.py +59 -0
  307. lockally-0.1.0/test/test_get_domains_status200_response_domains_inner_checks_inner.py +54 -0
  308. lockally-0.1.0/test/test_get_encryption_key200_response.py +57 -0
  309. lockally-0.1.0/test/test_get_integrations_summary200_response.py +69 -0
  310. lockally-0.1.0/test/test_get_integrations_summary200_response_api_keys_inner.py +54 -0
  311. lockally-0.1.0/test/test_get_integrations_summary200_response_webhooks_inner.py +55 -0
  312. lockally-0.1.0/test/test_get_ip_assignment200_response.py +56 -0
  313. lockally-0.1.0/test/test_get_security200_response.py +64 -0
  314. lockally-0.1.0/test/test_get_security200_response_alerts_inner.py +54 -0
  315. lockally-0.1.0/test/test_get_security200_response_stats_inner.py +54 -0
  316. lockally-0.1.0/test/test_get_storage200_response.py +70 -0
  317. lockally-0.1.0/test/test_get_storage200_response_top_mailboxes_inner.py +53 -0
  318. lockally-0.1.0/test/test_get_storage200_response_top_messages_inner.py +58 -0
  319. lockally-0.1.0/test/test_get_user_insights200_response.py +72 -0
  320. lockally-0.1.0/test/test_health_api.py +39 -0
  321. lockally-0.1.0/test/test_healthz_get200_response.py +55 -0
  322. lockally-0.1.0/test/test_ip_pools_api.py +53 -0
  323. lockally-0.1.0/test/test_list_add_ons200_response.py +69 -0
  324. lockally-0.1.0/test/test_list_calendar_events200_response.py +66 -0
  325. lockally-0.1.0/test/test_list_calendar_integrations200_response.py +63 -0
  326. lockally-0.1.0/test/test_list_calendar_members200_response.py +60 -0
  327. lockally-0.1.0/test/test_list_calendars200_response.py +65 -0
  328. lockally-0.1.0/test/test_list_contact_lists200_response.py +62 -0
  329. lockally-0.1.0/test/test_list_contacts200_response.py +68 -0
  330. lockally-0.1.0/test/test_list_dedicated_ip_requests200_response.py +71 -0
  331. lockally-0.1.0/test/test_list_distribution_lists200_response.py +69 -0
  332. lockally-0.1.0/test/test_list_migration_credentials200_response.py +71 -0
  333. lockally-0.1.0/test/test_list_migration_events200_response.py +77 -0
  334. lockally-0.1.0/test/test_list_migration_mailboxes200_response.py +95 -0
  335. lockally-0.1.0/test/test_list_migrations200_response.py +99 -0
  336. lockally-0.1.0/test/test_list_resources200_response.py +62 -0
  337. lockally-0.1.0/test/test_list_shared_members200_response.py +69 -0
  338. lockally-0.1.0/test/test_list_users200_response.py +81 -0
  339. lockally-0.1.0/test/test_mailbox.py +69 -0
  340. lockally-0.1.0/test/test_mailboxes_api.py +130 -0
  341. lockally-0.1.0/test/test_map_migration_request.py +61 -0
  342. lockally-0.1.0/test/test_map_migration_request_mappings_inner.py +55 -0
  343. lockally-0.1.0/test/test_message.py +74 -0
  344. lockally-0.1.0/test/test_message_stats.py +66 -0
  345. lockally-0.1.0/test/test_message_stats_counts.py +55 -0
  346. lockally-0.1.0/test/test_message_stats_rates.py +55 -0
  347. lockally-0.1.0/test/test_message_stats_window.py +53 -0
  348. lockally-0.1.0/test/test_migration.py +81 -0
  349. lockally-0.1.0/test/test_migration_credential.py +63 -0
  350. lockally-0.1.0/test/test_migration_event.py +67 -0
  351. lockally-0.1.0/test/test_migration_mailbox.py +79 -0
  352. lockally-0.1.0/test/test_migration_progress.py +89 -0
  353. lockally-0.1.0/test/test_migration_progress_mailboxes_inner.py +63 -0
  354. lockally-0.1.0/test/test_migration_settings.py +58 -0
  355. lockally-0.1.0/test/test_migrations_api.py +179 -0
  356. lockally-0.1.0/test/test_plan_catalog_entry.py +71 -0
  357. lockally-0.1.0/test/test_problem.py +59 -0
  358. lockally-0.1.0/test/test_replace_distribution_list_members200_response.py +65 -0
  359. lockally-0.1.0/test/test_replace_distribution_list_members_request.py +57 -0
  360. lockally-0.1.0/test/test_resource.py +66 -0
  361. lockally-0.1.0/test/test_resources_api.py +67 -0
  362. lockally-0.1.0/test/test_rotate_encryption_key_request.py +56 -0
  363. lockally-0.1.0/test/test_send_api.py +74 -0
  364. lockally-0.1.0/test/test_send_message.py +83 -0
  365. lockally-0.1.0/test/test_shared_member.py +63 -0
  366. lockally-0.1.0/test/test_signup_api.py +39 -0
  367. lockally-0.1.0/test/test_signup_request.py +59 -0
  368. lockally-0.1.0/test/test_start_migration202_response.py +55 -0
  369. lockally-0.1.0/test/test_suppression.py +55 -0
  370. lockally-0.1.0/test/test_suppressions_api.py +60 -0
  371. lockally-0.1.0/test/test_template.py +58 -0
  372. lockally-0.1.0/test/test_template_input.py +56 -0
  373. lockally-0.1.0/test/test_templates_api.py +67 -0
  374. lockally-0.1.0/test/test_tenant.py +72 -0
  375. lockally-0.1.0/test/test_tenant_api.py +46 -0
  376. lockally-0.1.0/test/test_test_api.py +39 -0
  377. lockally-0.1.0/test/test_unit_bundle.py +61 -0
  378. lockally-0.1.0/test/test_update_calendar_event_request.py +57 -0
  379. lockally-0.1.0/test/test_update_calendar_integration_request.py +54 -0
  380. lockally-0.1.0/test/test_update_calendar_member_request.py +53 -0
  381. lockally-0.1.0/test/test_update_calendar_policies_request.py +60 -0
  382. lockally-0.1.0/test/test_update_calendar_request.py +56 -0
  383. lockally-0.1.0/test/test_update_contact_list_request.py +54 -0
  384. lockally-0.1.0/test/test_update_contact_request.py +60 -0
  385. lockally-0.1.0/test/test_update_directory_permissions_request.py +55 -0
  386. lockally-0.1.0/test/test_update_gal_settings_request.py +56 -0
  387. lockally-0.1.0/test/test_update_migration_mailbox_request.py +53 -0
  388. lockally-0.1.0/test/test_update_migration_request.py +60 -0
  389. lockally-0.1.0/test/test_update_resource_request.py +55 -0
  390. lockally-0.1.0/test/test_update_user_request.py +56 -0
  391. lockally-0.1.0/test/test_user.py +70 -0
  392. lockally-0.1.0/test/test_user_event.py +54 -0
  393. lockally-0.1.0/test/test_users_api.py +67 -0
  394. lockally-0.1.0/test/test_v1_admin_login_post200_response.py +97 -0
  395. lockally-0.1.0/test/test_v1_admin_login_post_request.py +55 -0
  396. lockally-0.1.0/test/test_v1_admin_me_get200_response.py +93 -0
  397. lockally-0.1.0/test/test_v1_admins_get200_response.py +57 -0
  398. lockally-0.1.0/test/test_v1_admins_id_patch_request.py +55 -0
  399. lockally-0.1.0/test/test_v1_admins_post_request.py +56 -0
  400. lockally-0.1.0/test/test_v1_aliases_get200_response.py +67 -0
  401. lockally-0.1.0/test/test_v1_aliases_post_request.py +55 -0
  402. lockally-0.1.0/test/test_v1_api_keys_get200_response.py +77 -0
  403. lockally-0.1.0/test/test_v1_api_keys_post201_response.py +71 -0
  404. lockally-0.1.0/test/test_v1_api_keys_post_request.py +59 -0
  405. lockally-0.1.0/test/test_v1_domains_get200_response.py +93 -0
  406. lockally-0.1.0/test/test_v1_domains_post_request.py +53 -0
  407. lockally-0.1.0/test/test_v1_inboxes_mailbox_messages_post_request.py +64 -0
  408. lockally-0.1.0/test/test_v1_mailboxes_email_export_post201_response.py +57 -0
  409. lockally-0.1.0/test/test_v1_mailboxes_email_patch_request.py +54 -0
  410. lockally-0.1.0/test/test_v1_mailboxes_email_vacation_put_request.py +62 -0
  411. lockally-0.1.0/test/test_v1_mailboxes_get200_response.py +81 -0
  412. lockally-0.1.0/test/test_v1_mailboxes_post_request.py +55 -0
  413. lockally-0.1.0/test/test_v1_messages_get200_response.py +84 -0
  414. lockally-0.1.0/test/test_v1_send_batch_post200_response.py +59 -0
  415. lockally-0.1.0/test/test_v1_send_batch_post_request.py +113 -0
  416. lockally-0.1.0/test/test_v1_send_post202_response.py +58 -0
  417. lockally-0.1.0/test/test_v1_send_post_request.py +83 -0
  418. lockally-0.1.0/test/test_v1_send_post_request_attachments_inner.py +57 -0
  419. lockally-0.1.0/test/test_v1_suppressions_get200_response.py +59 -0
  420. lockally-0.1.0/test/test_v1_suppressions_post_request.py +54 -0
  421. lockally-0.1.0/test/test_v1_templates_get200_response.py +61 -0
  422. lockally-0.1.0/test/test_v1_usage_get200_response.py +66 -0
  423. lockally-0.1.0/test/test_v1_vacation_get200_response.py +79 -0
  424. lockally-0.1.0/test/test_v1_webhooks_get200_response.py +83 -0
  425. lockally-0.1.0/test/test_v1_webhooks_id_patch_request.py +56 -0
  426. lockally-0.1.0/test/test_v1_webhooks_post_request.py +59 -0
  427. lockally-0.1.0/test/test_vacation_params.py +57 -0
  428. lockally-0.1.0/test/test_vacation_responder.py +72 -0
  429. lockally-0.1.0/test/test_webhook.py +73 -0
  430. lockally-0.1.0/test/test_webhooks_api.py +60 -0
lockally-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Lockally
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,517 @@
1
+ Metadata-Version: 2.4
2
+ Name: lockally
3
+ Version: 0.1.0
4
+ Summary: lockally control plane
5
+ Home-page:
6
+ Author: lockally support
7
+ Author-email: lockally support <support@lockally.com>
8
+ License: AGPL-3.0-only OR LicenseRef-LOC-Commercial
9
+ Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
10
+ Keywords: OpenAPI,OpenAPI-Generator,lockally control plane
11
+ Requires-Python: >=3.9
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: urllib3<3.0.0,>=2.1.0
15
+ Requires-Dist: python-dateutil>=2.8.2
16
+ Requires-Dist: pydantic>=2.11
17
+ Requires-Dist: typing-extensions>=4.7.1
18
+ Dynamic: author
19
+ Dynamic: license-file
20
+
21
+ # lockally
22
+ The lockally control plane lets integrators and direct customers manage
23
+ everything except actual mail data flow (which uses standard JMAP / IMAP /
24
+ SMTP-submission against the data plane endpoints).
25
+
26
+ **Authentication.** All `/v1/*` endpoints require a Bearer API key in the
27
+ `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`.
28
+ Generate the first key for a tenant via `cmd/seed`; subsequent keys via
29
+ `POST /v1/api-keys`.
30
+
31
+ **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)
32
+ `application/problem+json` documents.
33
+
34
+ **Scopes.** Each endpoint requires a specific scope on the presented key.
35
+ Insufficient scope returns `403` with the required scope name in `detail`.
36
+
37
+
38
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
39
+
40
+ - API version: 0.1.0
41
+ - Package version: 0.1.0
42
+ - Generator version: 7.23.0
43
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
44
+
45
+ ## Requirements.
46
+
47
+ Python 3.10+
48
+
49
+ ## Installation & Usage
50
+ ### pip install
51
+
52
+ If the python package is hosted on a repository, you can install directly using:
53
+
54
+ ```sh
55
+ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
56
+ ```
57
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
58
+
59
+ Then import the package:
60
+ ```python
61
+ import lockally
62
+ ```
63
+
64
+ ### Setuptools
65
+
66
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
67
+
68
+ ```sh
69
+ python setup.py install --user
70
+ ```
71
+ (or `sudo python setup.py install` to install the package for all users)
72
+
73
+ Then import the package:
74
+ ```python
75
+ import lockally
76
+ ```
77
+
78
+ ### Tests
79
+
80
+ Execute `pytest` to run the tests.
81
+
82
+ ## Getting Started
83
+
84
+ Please follow the [installation procedure](#installation--usage) and then run the following:
85
+
86
+ ```python
87
+
88
+ import lockally
89
+ from lockally.rest import ApiException
90
+ from pprint import pprint
91
+
92
+ # Defining the host is optional and defaults to https://api.lockally.com
93
+ # See configuration.py for a list of all supported configuration parameters.
94
+ configuration = lockally.Configuration(
95
+ host = "https://api.lockally.com"
96
+ )
97
+
98
+ # The client must configure the authentication and authorization parameters
99
+ # in accordance with the API server security policy.
100
+ # Examples for each auth method are provided below, use the example that
101
+ # satisfies your auth use case.
102
+
103
+ # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
104
+ configuration = lockally.Configuration(
105
+ access_token = os.environ["BEARER_TOKEN"]
106
+ )
107
+
108
+
109
+ # Enter a context with an instance of the API client
110
+ with lockally.ApiClient(configuration) as api_client:
111
+ # Create an instance of the API class
112
+ api_instance = lockally.AddOnsApi(api_client)
113
+ name = 'name_example' # str | Add-on key
114
+
115
+ try:
116
+ # Activate an add-on
117
+ api_response = api_instance.activate_add_on(name)
118
+ print("The response of AddOnsApi->activate_add_on:\n")
119
+ pprint(api_response)
120
+ except ApiException as e:
121
+ print("Exception when calling AddOnsApi->activate_add_on: %s\n" % e)
122
+
123
+ ```
124
+
125
+ ## Documentation for API Endpoints
126
+
127
+ All URIs are relative to *https://api.lockally.com*
128
+
129
+ Class | Method | HTTP request | Description
130
+ ------------ | ------------- | ------------- | -------------
131
+ *AddOnsApi* | [**activate_add_on**](docs/AddOnsApi.md#activate_add_on) | **POST** /v1/add-ons/{name}/activate | Activate an add-on
132
+ *AddOnsApi* | [**cancel_add_on**](docs/AddOnsApi.md#cancel_add_on) | **POST** /v1/add-ons/{name}/cancel | Cancel an add-on
133
+ *AddOnsApi* | [**get_add_on_status**](docs/AddOnsApi.md#get_add_on_status) | **GET** /v1/add-ons/{name} | Get add-on status
134
+ *AddOnsApi* | [**list_add_ons**](docs/AddOnsApi.md#list_add_ons) | **GET** /v1/add-ons | List add-ons
135
+ *AdminApi* | [**v1_admin_login_post**](docs/AdminApi.md#v1_admin_login_post) | **POST** /v1/admin/login | Tenant-admin email+password login
136
+ *AdminApi* | [**v1_admin_logout_post**](docs/AdminApi.md#v1_admin_logout_post) | **POST** /v1/admin/logout | Invalidate the current admin session
137
+ *AdminApi* | [**v1_admin_me_get**](docs/AdminApi.md#v1_admin_me_get) | **GET** /v1/admin/me | Get the current admin + tenant
138
+ *AdminsApi* | [**v1_admins_get**](docs/AdminsApi.md#v1_admins_get) | **GET** /v1/admins | List tenant admins
139
+ *AdminsApi* | [**v1_admins_id_delete**](docs/AdminsApi.md#v1_admins_id_delete) | **DELETE** /v1/admins/{id} | Delete an admin
140
+ *AdminsApi* | [**v1_admins_id_patch**](docs/AdminsApi.md#v1_admins_id_patch) | **PATCH** /v1/admins/{id} | Update an admin
141
+ *AdminsApi* | [**v1_admins_post**](docs/AdminsApi.md#v1_admins_post) | **POST** /v1/admins | Invite a new admin
142
+ *AgentsApi* | [**v1_api_keys_key_id_mailboxes_get**](docs/AgentsApi.md#v1_api_keys_key_id_mailboxes_get) | **GET** /v1/api-keys/{keyID}/mailboxes | List a key&#39;s mailbox grants
143
+ *AgentsApi* | [**v1_api_keys_key_id_mailboxes_mailbox_id_delete**](docs/AgentsApi.md#v1_api_keys_key_id_mailboxes_mailbox_id_delete) | **DELETE** /v1/api-keys/{keyID}/mailboxes/{mailboxID} | Revoke a mailbox grant
144
+ *AgentsApi* | [**v1_api_keys_key_id_mailboxes_post**](docs/AgentsApi.md#v1_api_keys_key_id_mailboxes_post) | **POST** /v1/api-keys/{keyID}/mailboxes | Grant a mailbox to a key
145
+ *AgentsApi* | [**v1_auth_whoami_get**](docs/AgentsApi.md#v1_auth_whoami_get) | **GET** /v1/auth/whoami | Introspect the calling credentials
146
+ *AgentsApi* | [**v1_contacts_lookup_get**](docs/AgentsApi.md#v1_contacts_lookup_get) | **GET** /v1/contacts/lookup | Who is this sender?
147
+ *AgentsApi* | [**v1_inboxes_get**](docs/AgentsApi.md#v1_inboxes_get) | **GET** /v1/inboxes | List granted inboxes
148
+ *AgentsApi* | [**v1_inboxes_mailbox_messages_post**](docs/AgentsApi.md#v1_inboxes_mailbox_messages_post) | **POST** /v1/inboxes/{mailbox}/messages | Start a new conversation (agent stream)
149
+ *AgentsApi* | [**v1_inboxes_mailbox_threads_get**](docs/AgentsApi.md#v1_inboxes_mailbox_threads_get) | **GET** /v1/inboxes/{mailbox}/threads | List conversation threads
150
+ *AgentsApi* | [**v1_threads_thread_id_get**](docs/AgentsApi.md#v1_threads_thread_id_get) | **GET** /v1/threads/{threadID} | Get a whole conversation
151
+ *AgentsApi* | [**v1_threads_thread_id_messages_message_id_attachments_idx_get**](docs/AgentsApi.md#v1_threads_thread_id_messages_message_id_attachments_idx_get) | **GET** /v1/threads/{threadID}/messages/{messageID}/attachments/{idx} | Download an attachment
152
+ *AgentsApi* | [**v1_threads_thread_id_messages_message_id_get**](docs/AgentsApi.md#v1_threads_thread_id_messages_message_id_get) | **GET** /v1/threads/{threadID}/messages/{messageID} | Get one message with body
153
+ *AgentsApi* | [**v1_threads_thread_id_messages_message_id_read_post**](docs/AgentsApi.md#v1_threads_thread_id_messages_message_id_read_post) | **POST** /v1/threads/{threadID}/messages/{messageID}/read | Mark read/unread
154
+ *AgentsApi* | [**v1_threads_thread_id_reply_post**](docs/AgentsApi.md#v1_threads_thread_id_reply_post) | **POST** /v1/threads/{threadID}/reply | Reply in-thread (agent stream)
155
+ *AiApi* | [**v1_ai_config_get**](docs/AiApi.md#v1_ai_config_get) | **GET** /v1/ai-config | Read the tenant&#39;s AI configuration
156
+ *AiApi* | [**v1_ai_config_put**](docs/AiApi.md#v1_ai_config_put) | **PUT** /v1/ai-config | Configure the AI tier
157
+ *AiApi* | [**v1_billing_ai_units_checkout_post**](docs/AiApi.md#v1_billing_ai_units_checkout_post) | **POST** /v1/billing/ai-units/checkout | Buy prepaid AI units
158
+ *AiApi* | [**v1_threads_thread_id_classify_post**](docs/AiApi.md#v1_threads_thread_id_classify_post) | **POST** /v1/threads/{threadID}/classify | LLM-classify a thread
159
+ *AliasesApi* | [**v1_aliases_address_delete**](docs/AliasesApi.md#v1_aliases_address_delete) | **DELETE** /v1/aliases/{address} | Delete an alias
160
+ *AliasesApi* | [**v1_aliases_get**](docs/AliasesApi.md#v1_aliases_get) | **GET** /v1/aliases | List aliases
161
+ *AliasesApi* | [**v1_aliases_post**](docs/AliasesApi.md#v1_aliases_post) | **POST** /v1/aliases | Create an alias
162
+ *ApiKeysApi* | [**v1_api_keys_get**](docs/ApiKeysApi.md#v1_api_keys_get) | **GET** /v1/api-keys | List API keys
163
+ *ApiKeysApi* | [**v1_api_keys_id_delete**](docs/ApiKeysApi.md#v1_api_keys_id_delete) | **DELETE** /v1/api-keys/{id} | Revoke an API key
164
+ *ApiKeysApi* | [**v1_api_keys_post**](docs/ApiKeysApi.md#v1_api_keys_post) | **POST** /v1/api-keys | Create an API key
165
+ *BillingApi* | [**create_billing_checkout**](docs/BillingApi.md#create_billing_checkout) | **POST** /v1/billing/checkout | Create a plan checkout session
166
+ *BillingApi* | [**create_units_checkout**](docs/BillingApi.md#create_units_checkout) | **POST** /v1/billing/units/checkout | Create a send-units checkout session
167
+ *BillingApi* | [**get_billing**](docs/BillingApi.md#get_billing) | **GET** /v1/billing | Get billing status
168
+ *CalendarsApi* | [**add_calendar_member**](docs/CalendarsApi.md#add_calendar_member) | **POST** /v1/calendars/{id}/members | Add a member to a calendar
169
+ *CalendarsApi* | [**create_calendar**](docs/CalendarsApi.md#create_calendar) | **POST** /v1/calendars | Create a calendar
170
+ *CalendarsApi* | [**create_calendar_event**](docs/CalendarsApi.md#create_calendar_event) | **POST** /v1/calendars/{id}/events | Create an event in a calendar
171
+ *CalendarsApi* | [**create_calendar_integration**](docs/CalendarsApi.md#create_calendar_integration) | **POST** /v1/calendar-integrations | Create a calendar integration
172
+ *CalendarsApi* | [**delete_calendar**](docs/CalendarsApi.md#delete_calendar) | **DELETE** /v1/calendars/{id} | Delete a calendar
173
+ *CalendarsApi* | [**delete_calendar_event**](docs/CalendarsApi.md#delete_calendar_event) | **DELETE** /v1/calendars/{id}/events/{eventId} | Delete a calendar event
174
+ *CalendarsApi* | [**delete_calendar_integration**](docs/CalendarsApi.md#delete_calendar_integration) | **DELETE** /v1/calendar-integrations/{id} | Delete a calendar integration
175
+ *CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /v1/calendars/{id} | Get a calendar
176
+ *CalendarsApi* | [**get_calendar_policies**](docs/CalendarsApi.md#get_calendar_policies) | **GET** /v1/calendar-policies | Get calendar policies
177
+ *CalendarsApi* | [**get_calendar_security**](docs/CalendarsApi.md#get_calendar_security) | **GET** /v1/calendar-security | Get calendar security overview
178
+ *CalendarsApi* | [**list_calendar_events**](docs/CalendarsApi.md#list_calendar_events) | **GET** /v1/calendars/{id}/events | List events in a calendar
179
+ *CalendarsApi* | [**list_calendar_integrations**](docs/CalendarsApi.md#list_calendar_integrations) | **GET** /v1/calendar-integrations | List calendar integrations
180
+ *CalendarsApi* | [**list_calendar_members**](docs/CalendarsApi.md#list_calendar_members) | **GET** /v1/calendars/{id}/members | List calendar members
181
+ *CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /v1/calendars | List calendars
182
+ *CalendarsApi* | [**remove_calendar_member**](docs/CalendarsApi.md#remove_calendar_member) | **DELETE** /v1/calendars/{id}/members/{memberId} | Remove a member from a calendar
183
+ *CalendarsApi* | [**sync_calendar_integration**](docs/CalendarsApi.md#sync_calendar_integration) | **POST** /v1/calendar-integrations/{id}/sync | Trigger sync for a calendar integration
184
+ *CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **PATCH** /v1/calendars/{id} | Update a calendar
185
+ *CalendarsApi* | [**update_calendar_event**](docs/CalendarsApi.md#update_calendar_event) | **PATCH** /v1/calendars/{id}/events/{eventId} | Update a calendar event
186
+ *CalendarsApi* | [**update_calendar_integration**](docs/CalendarsApi.md#update_calendar_integration) | **PATCH** /v1/calendar-integrations/{id} | Update a calendar integration
187
+ *CalendarsApi* | [**update_calendar_member**](docs/CalendarsApi.md#update_calendar_member) | **PATCH** /v1/calendars/{id}/members/{memberId} | Update a calendar member&#39;s role
188
+ *CalendarsApi* | [**update_calendar_policies**](docs/CalendarsApi.md#update_calendar_policies) | **PATCH** /v1/calendar-policies | Update calendar policies
189
+ *ContactListsApi* | [**add_contact_list_member**](docs/ContactListsApi.md#add_contact_list_member) | **POST** /v1/contact-lists/{id}/members | Add a member to a contact list
190
+ *ContactListsApi* | [**create_contact_list**](docs/ContactListsApi.md#create_contact_list) | **POST** /v1/contact-lists | Create a contact list
191
+ *ContactListsApi* | [**delete_contact_list**](docs/ContactListsApi.md#delete_contact_list) | **DELETE** /v1/contact-lists/{id} | Delete a contact list
192
+ *ContactListsApi* | [**get_contact_list**](docs/ContactListsApi.md#get_contact_list) | **GET** /v1/contact-lists/{id} | Get a contact list with members
193
+ *ContactListsApi* | [**list_contact_lists**](docs/ContactListsApi.md#list_contact_lists) | **GET** /v1/contact-lists | List contact lists
194
+ *ContactListsApi* | [**remove_contact_list_member**](docs/ContactListsApi.md#remove_contact_list_member) | **DELETE** /v1/contact-lists/{id}/members/{contactId} | Remove a member from a contact list
195
+ *ContactListsApi* | [**update_contact_list**](docs/ContactListsApi.md#update_contact_list) | **PATCH** /v1/contact-lists/{id} | Update a contact list
196
+ *ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /v1/contacts | Create a contact
197
+ *ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /v1/contacts/{id} | Delete a contact
198
+ *ContactsApi* | [**get_contact**](docs/ContactsApi.md#get_contact) | **GET** /v1/contacts/{id} | Get a contact
199
+ *ContactsApi* | [**get_contact_lists**](docs/ContactsApi.md#get_contact_lists) | **GET** /v1/contacts/{id}/lists | Get lists a contact belongs to
200
+ *ContactsApi* | [**list_contacts**](docs/ContactsApi.md#list_contacts) | **GET** /v1/contacts | List contacts
201
+ *ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PATCH** /v1/contacts/{id} | Update a contact
202
+ *DashboardApi* | [**get_audit_summary**](docs/DashboardApi.md#get_audit_summary) | **GET** /v1/audit-summary | Audit summary for the dashboard
203
+ *DashboardApi* | [**get_domains_status**](docs/DashboardApi.md#get_domains_status) | **GET** /v1/domains/status | Domain health status for the dashboard
204
+ *DashboardApi* | [**get_integrations_summary**](docs/DashboardApi.md#get_integrations_summary) | **GET** /v1/integrations-summary | Integrations summary for the dashboard
205
+ *DashboardApi* | [**get_security**](docs/DashboardApi.md#get_security) | **GET** /v1/security | Security overview for the dashboard
206
+ *DashboardApi* | [**get_storage**](docs/DashboardApi.md#get_storage) | **GET** /v1/storage | Storage usage for the dashboard
207
+ *DashboardApi* | [**get_tenant_health**](docs/DashboardApi.md#get_tenant_health) | **GET** /v1/health | Full tenant health report
208
+ *DashboardApi* | [**get_user_insights**](docs/DashboardApi.md#get_user_insights) | **GET** /v1/user-insights | User insights for the dashboard
209
+ *DirectoryApi* | [**get_directory_activity**](docs/DirectoryApi.md#get_directory_activity) | **GET** /v1/directory-activity | Get recent directory activity
210
+ *DirectoryApi* | [**get_directory_permissions**](docs/DirectoryApi.md#get_directory_permissions) | **GET** /v1/directory-permissions | Get directory permission settings
211
+ *DirectoryApi* | [**get_directory_stats**](docs/DirectoryApi.md#get_directory_stats) | **GET** /v1/directory-stats | Get directory statistics
212
+ *DirectoryApi* | [**get_gal_settings**](docs/DirectoryApi.md#get_gal_settings) | **GET** /v1/gal-settings | Get Global Address List settings
213
+ *DirectoryApi* | [**rebuild_gal_index**](docs/DirectoryApi.md#rebuild_gal_index) | **POST** /v1/gal-settings/rebuild-index | Rebuild the GAL search index
214
+ *DirectoryApi* | [**sync_gal**](docs/DirectoryApi.md#sync_gal) | **POST** /v1/gal-settings/sync | Sync GAL with external directory sources
215
+ *DirectoryApi* | [**update_directory_permissions**](docs/DirectoryApi.md#update_directory_permissions) | **PATCH** /v1/directory-permissions | Update directory permission settings
216
+ *DirectoryApi* | [**update_gal_settings**](docs/DirectoryApi.md#update_gal_settings) | **PATCH** /v1/gal-settings | Update GAL settings
217
+ *DistributionListsApi* | [**create_distribution_list**](docs/DistributionListsApi.md#create_distribution_list) | **POST** /v1/distribution-lists | Create a distribution list
218
+ *DistributionListsApi* | [**delete_distribution_list**](docs/DistributionListsApi.md#delete_distribution_list) | **DELETE** /v1/distribution-lists/{address} | Delete a distribution list
219
+ *DistributionListsApi* | [**get_distribution_list**](docs/DistributionListsApi.md#get_distribution_list) | **GET** /v1/distribution-lists/{address} | Get a distribution list
220
+ *DistributionListsApi* | [**list_distribution_lists**](docs/DistributionListsApi.md#list_distribution_lists) | **GET** /v1/distribution-lists | List distribution lists
221
+ *DistributionListsApi* | [**replace_distribution_list_members**](docs/DistributionListsApi.md#replace_distribution_list_members) | **PUT** /v1/distribution-lists/{address}/members | Replace distribution list members
222
+ *DomainsApi* | [**v1_domains_domain_delete**](docs/DomainsApi.md#v1_domains_domain_delete) | **DELETE** /v1/domains/{domain} | Delete a domain
223
+ *DomainsApi* | [**v1_domains_domain_get**](docs/DomainsApi.md#v1_domains_domain_get) | **GET** /v1/domains/{domain} | Get a domain
224
+ *DomainsApi* | [**v1_domains_domain_verify_post**](docs/DomainsApi.md#v1_domains_domain_verify_post) | **POST** /v1/domains/{domain}/verify | Force-poll DNS verification
225
+ *DomainsApi* | [**v1_domains_get**](docs/DomainsApi.md#v1_domains_get) | **GET** /v1/domains | List domains
226
+ *DomainsApi* | [**v1_domains_post**](docs/DomainsApi.md#v1_domains_post) | **POST** /v1/domains | Register a domain
227
+ *DraftsApi* | [**v1_drafts_draft_id_approve_post**](docs/DraftsApi.md#v1_drafts_draft_id_approve_post) | **POST** /v1/drafts/{draftID}/approve | Approve a pending draft (human)
228
+ *DraftsApi* | [**v1_drafts_draft_id_cancel_post**](docs/DraftsApi.md#v1_drafts_draft_id_cancel_post) | **POST** /v1/drafts/{draftID}/cancel | Withdraw a pending draft
229
+ *DraftsApi* | [**v1_drafts_draft_id_get**](docs/DraftsApi.md#v1_drafts_draft_id_get) | **GET** /v1/drafts/{draftID} | Get a draft
230
+ *DraftsApi* | [**v1_drafts_draft_id_reject_post**](docs/DraftsApi.md#v1_drafts_draft_id_reject_post) | **POST** /v1/drafts/{draftID}/reject | Reject a pending draft (human)
231
+ *DraftsApi* | [**v1_drafts_get**](docs/DraftsApi.md#v1_drafts_get) | **GET** /v1/drafts | List drafts
232
+ *DraftsApi* | [**v1_inboxes_mailbox_drafts_post**](docs/DraftsApi.md#v1_inboxes_mailbox_drafts_post) | **POST** /v1/inboxes/{mailbox}/drafts | Propose a new conversation as a draft
233
+ *DraftsApi* | [**v1_threads_thread_id_drafts_post**](docs/DraftsApi.md#v1_threads_thread_id_drafts_post) | **POST** /v1/threads/{threadID}/drafts | Propose a reply as a draft
234
+ *EncryptionApi* | [**batch_lookup_public_keys**](docs/EncryptionApi.md#batch_lookup_public_keys) | **GET** /v1/encryption/keys/lookup | Batch-lookup public keys by email
235
+ *EncryptionApi* | [**create_encryption_key**](docs/EncryptionApi.md#create_encryption_key) | **POST** /v1/encryption/keys | Upload an encryption key pair
236
+ *EncryptionApi* | [**create_encryption_recovery**](docs/EncryptionApi.md#create_encryption_recovery) | **POST** /v1/encryption/recovery | Store an encryption recovery blob
237
+ *EncryptionApi* | [**get_encryption_key**](docs/EncryptionApi.md#get_encryption_key) | **GET** /v1/encryption/keys/{email} | Get encryption key for a mailbox
238
+ *EncryptionApi* | [**rotate_encryption_key**](docs/EncryptionApi.md#rotate_encryption_key) | **POST** /v1/encryption/keys/rotate | Rotate an encryption key
239
+ *HealthApi* | [**healthz_get**](docs/HealthApi.md#healthz_get) | **GET** /healthz | Liveness check
240
+ *IpPoolsApi* | [**create_dedicated_ip_request**](docs/IpPoolsApi.md#create_dedicated_ip_request) | **POST** /v1/dedicated-ip-requests | Request a dedicated IP
241
+ *IpPoolsApi* | [**get_ip_assignment**](docs/IpPoolsApi.md#get_ip_assignment) | **GET** /v1/ip-assignment | Get current IP assignment
242
+ *IpPoolsApi* | [**list_dedicated_ip_requests**](docs/IpPoolsApi.md#list_dedicated_ip_requests) | **GET** /v1/dedicated-ip-requests | List dedicated IP requests
243
+ *MailboxesApi* | [**add_shared_member**](docs/MailboxesApi.md#add_shared_member) | **POST** /v1/mailboxes/{email}/members | Add a shared mailbox member
244
+ *MailboxesApi* | [**list_shared_members**](docs/MailboxesApi.md#list_shared_members) | **GET** /v1/mailboxes/{email}/members | List shared mailbox members
245
+ *MailboxesApi* | [**remove_shared_member**](docs/MailboxesApi.md#remove_shared_member) | **DELETE** /v1/mailboxes/{email}/members/{memberEmail} | Remove a shared mailbox member
246
+ *MailboxesApi* | [**v1_mailboxes_email_delete**](docs/MailboxesApi.md#v1_mailboxes_email_delete) | **DELETE** /v1/mailboxes/{email} | Soft-delete a mailbox
247
+ *MailboxesApi* | [**v1_mailboxes_email_export_download_get**](docs/MailboxesApi.md#v1_mailboxes_email_export_download_get) | **GET** /v1/mailboxes/{email}/export/download | Download a previously-issued mailbox export
248
+ *MailboxesApi* | [**v1_mailboxes_email_export_post**](docs/MailboxesApi.md#v1_mailboxes_email_export_post) | **POST** /v1/mailboxes/{email}/export | Request a mailbox export
249
+ *MailboxesApi* | [**v1_mailboxes_email_get**](docs/MailboxesApi.md#v1_mailboxes_email_get) | **GET** /v1/mailboxes/{email} | Get a mailbox
250
+ *MailboxesApi* | [**v1_mailboxes_email_patch**](docs/MailboxesApi.md#v1_mailboxes_email_patch) | **PATCH** /v1/mailboxes/{email} | Update a mailbox
251
+ *MailboxesApi* | [**v1_mailboxes_email_vacation_delete**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_delete) | **DELETE** /v1/mailboxes/{email}/vacation | Remove the vacation responder
252
+ *MailboxesApi* | [**v1_mailboxes_email_vacation_get**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_get) | **GET** /v1/mailboxes/{email}/vacation | Get the vacation responder
253
+ *MailboxesApi* | [**v1_mailboxes_email_vacation_put**](docs/MailboxesApi.md#v1_mailboxes_email_vacation_put) | **PUT** /v1/mailboxes/{email}/vacation | Set the vacation responder
254
+ *MailboxesApi* | [**v1_mailboxes_get**](docs/MailboxesApi.md#v1_mailboxes_get) | **GET** /v1/mailboxes | List mailboxes
255
+ *MailboxesApi* | [**v1_mailboxes_post**](docs/MailboxesApi.md#v1_mailboxes_post) | **POST** /v1/mailboxes | Create a mailbox
256
+ *MailboxesApi* | [**v1_vacation_get**](docs/MailboxesApi.md#v1_vacation_get) | **GET** /v1/vacation | List all vacation responders
257
+ *MigrationsApi* | [**cancel_migration**](docs/MigrationsApi.md#cancel_migration) | **POST** /v1/migrations/{id}/cancel | Cancel a running migration
258
+ *MigrationsApi* | [**check_migration_dns**](docs/MigrationsApi.md#check_migration_dns) | **GET** /v1/migrations/{id}/dns-check | Check DNS readiness for cutover
259
+ *MigrationsApi* | [**create_migration**](docs/MigrationsApi.md#create_migration) | **POST** /v1/migrations | Create a migration
260
+ *MigrationsApi* | [**create_migration_credential**](docs/MigrationsApi.md#create_migration_credential) | **POST** /v1/migrations/credentials | Store a migration credential
261
+ *MigrationsApi* | [**delete_migration**](docs/MigrationsApi.md#delete_migration) | **DELETE** /v1/migrations/{id} | Delete a migration
262
+ *MigrationsApi* | [**delete_migration_credential**](docs/MigrationsApi.md#delete_migration_credential) | **DELETE** /v1/migrations/credentials/{id} | Delete a migration credential
263
+ *MigrationsApi* | [**delta_sync_migration**](docs/MigrationsApi.md#delta_sync_migration) | **POST** /v1/migrations/{id}/delta-sync | Run a delta sync
264
+ *MigrationsApi* | [**discover_migration**](docs/MigrationsApi.md#discover_migration) | **POST** /v1/migrations/{id}/discover | Discover source mailboxes
265
+ *MigrationsApi* | [**final_sync_migration**](docs/MigrationsApi.md#final_sync_migration) | **POST** /v1/migrations/{id}/final-sync | Run the final sync before cutover
266
+ *MigrationsApi* | [**get_migration**](docs/MigrationsApi.md#get_migration) | **GET** /v1/migrations/{id} | Get a migration
267
+ *MigrationsApi* | [**get_migration_progress**](docs/MigrationsApi.md#get_migration_progress) | **GET** /v1/migrations/{id}/progress | Get migration progress
268
+ *MigrationsApi* | [**list_migration_credentials**](docs/MigrationsApi.md#list_migration_credentials) | **GET** /v1/migrations/credentials | List migration credentials
269
+ *MigrationsApi* | [**list_migration_events**](docs/MigrationsApi.md#list_migration_events) | **GET** /v1/migrations/{id}/events | List migration events
270
+ *MigrationsApi* | [**list_migration_mailboxes**](docs/MigrationsApi.md#list_migration_mailboxes) | **GET** /v1/migrations/{id}/mailboxes | List migration mailboxes
271
+ *MigrationsApi* | [**list_migrations**](docs/MigrationsApi.md#list_migrations) | **GET** /v1/migrations | List migrations
272
+ *MigrationsApi* | [**map_migration**](docs/MigrationsApi.md#map_migration) | **POST** /v1/migrations/{id}/map | Map source to destination mailboxes
273
+ *MigrationsApi* | [**retry_migration**](docs/MigrationsApi.md#retry_migration) | **POST** /v1/migrations/{id}/retry | Retry a failed or cancelled migration
274
+ *MigrationsApi* | [**start_migration**](docs/MigrationsApi.md#start_migration) | **POST** /v1/migrations/{id}/start | Start the migration
275
+ *MigrationsApi* | [**update_migration**](docs/MigrationsApi.md#update_migration) | **PATCH** /v1/migrations/{id} | Update a migration
276
+ *MigrationsApi* | [**update_migration_mailbox**](docs/MigrationsApi.md#update_migration_mailbox) | **PATCH** /v1/migrations/{id}/mailboxes/{mbxId} | Update a migration mailbox
277
+ *MigrationsApi* | [**validate_migration**](docs/MigrationsApi.md#validate_migration) | **POST** /v1/migrations/{id}/validate | Validate migrated data
278
+ *ResourcesApi* | [**create_resource**](docs/ResourcesApi.md#create_resource) | **POST** /v1/resources | Create a resource
279
+ *ResourcesApi* | [**delete_resource**](docs/ResourcesApi.md#delete_resource) | **DELETE** /v1/resources/{id} | Delete a resource
280
+ *ResourcesApi* | [**get_resource**](docs/ResourcesApi.md#get_resource) | **GET** /v1/resources/{id} | Get a resource
281
+ *ResourcesApi* | [**list_resources**](docs/ResourcesApi.md#list_resources) | **GET** /v1/resources | List resources
282
+ *ResourcesApi* | [**update_resource**](docs/ResourcesApi.md#update_resource) | **PATCH** /v1/resources/{id} | Update a resource
283
+ *SendApi* | [**v1_messages_get**](docs/SendApi.md#v1_messages_get) | **GET** /v1/messages | List outbound messages
284
+ *SendApi* | [**v1_messages_id_delete**](docs/SendApi.md#v1_messages_id_delete) | **DELETE** /v1/messages/{id} | Cancel a scheduled send
285
+ *SendApi* | [**v1_messages_id_get**](docs/SendApi.md#v1_messages_id_get) | **GET** /v1/messages/{id} | Get message status
286
+ *SendApi* | [**v1_messages_stats_get**](docs/SendApi.md#v1_messages_stats_get) | **GET** /v1/messages/stats | Aggregate delivery stats
287
+ *SendApi* | [**v1_send_batch_post**](docs/SendApi.md#v1_send_batch_post) | **POST** /v1/send/batch | Send a batch of emails
288
+ *SendApi* | [**v1_send_post**](docs/SendApi.md#v1_send_post) | **POST** /v1/send | Send an email
289
+ *SignupApi* | [**signup**](docs/SignupApi.md#signup) | **POST** /v1/signup | Sign up a new tenant
290
+ *SuppressionsApi* | [**v1_suppressions_email_delete**](docs/SuppressionsApi.md#v1_suppressions_email_delete) | **DELETE** /v1/suppressions/{email} | Remove a suppression
291
+ *SuppressionsApi* | [**v1_suppressions_email_get**](docs/SuppressionsApi.md#v1_suppressions_email_get) | **GET** /v1/suppressions/{email} | Check whether an address is suppressed
292
+ *SuppressionsApi* | [**v1_suppressions_get**](docs/SuppressionsApi.md#v1_suppressions_get) | **GET** /v1/suppressions | List suppressed recipients
293
+ *SuppressionsApi* | [**v1_suppressions_post**](docs/SuppressionsApi.md#v1_suppressions_post) | **POST** /v1/suppressions | Add a suppression
294
+ *TemplatesApi* | [**v1_templates_get**](docs/TemplatesApi.md#v1_templates_get) | **GET** /v1/templates | List templates
295
+ *TemplatesApi* | [**v1_templates_id_delete**](docs/TemplatesApi.md#v1_templates_id_delete) | **DELETE** /v1/templates/{id} | Delete a template
296
+ *TemplatesApi* | [**v1_templates_id_get**](docs/TemplatesApi.md#v1_templates_id_get) | **GET** /v1/templates/{id} | Get a template
297
+ *TemplatesApi* | [**v1_templates_id_put**](docs/TemplatesApi.md#v1_templates_id_put) | **PUT** /v1/templates/{id} | Update a template
298
+ *TemplatesApi* | [**v1_templates_post**](docs/TemplatesApi.md#v1_templates_post) | **POST** /v1/templates | Create a template
299
+ *TenantApi* | [**v1_tenant_get**](docs/TenantApi.md#v1_tenant_get) | **GET** /v1/tenant | Get the calling tenant
300
+ *TenantApi* | [**v1_usage_get**](docs/TenantApi.md#v1_usage_get) | **GET** /v1/usage | Usage snapshot
301
+ *TestApi* | [**v1_test_inbound_post**](docs/TestApi.md#v1_test_inbound_post) | **POST** /v1/test/inbound | Simulate an inbound email (test keys only)
302
+ *UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /v1/users | Create a user
303
+ *UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /v1/users/{id} | Delete a user
304
+ *UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /v1/users/{id} | Get a user
305
+ *UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /v1/users | List users
306
+ *UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /v1/users/{id} | Update a user
307
+ *WebhooksApi* | [**v1_webhooks_get**](docs/WebhooksApi.md#v1_webhooks_get) | **GET** /v1/webhooks | List webhooks
308
+ *WebhooksApi* | [**v1_webhooks_id_delete**](docs/WebhooksApi.md#v1_webhooks_id_delete) | **DELETE** /v1/webhooks/{id} | Delete a webhook
309
+ *WebhooksApi* | [**v1_webhooks_id_patch**](docs/WebhooksApi.md#v1_webhooks_id_patch) | **PATCH** /v1/webhooks/{id} | Update a webhook
310
+ *WebhooksApi* | [**v1_webhooks_post**](docs/WebhooksApi.md#v1_webhooks_post) | **POST** /v1/webhooks | Create a webhook
311
+
312
+
313
+ ## Documentation For Models
314
+
315
+ - [APIKey](docs/APIKey.md)
316
+ - [ActivateAddOn200Response](docs/ActivateAddOn200Response.md)
317
+ - [AddCalendarMemberRequest](docs/AddCalendarMemberRequest.md)
318
+ - [AddContactListMemberRequest](docs/AddContactListMemberRequest.md)
319
+ - [AddOn](docs/AddOn.md)
320
+ - [AddSharedMemberRequest](docs/AddSharedMemberRequest.md)
321
+ - [Admin](docs/Admin.md)
322
+ - [AdminFull](docs/AdminFull.md)
323
+ - [Alias](docs/Alias.md)
324
+ - [AuditEvent](docs/AuditEvent.md)
325
+ - [BatchLookupPublicKeys200Response](docs/BatchLookupPublicKeys200Response.md)
326
+ - [BatchLookupPublicKeys200ResponseDataInner](docs/BatchLookupPublicKeys200ResponseDataInner.md)
327
+ - [BatchResult](docs/BatchResult.md)
328
+ - [BillingStatus](docs/BillingStatus.md)
329
+ - [Calendar](docs/Calendar.md)
330
+ - [CalendarEvent](docs/CalendarEvent.md)
331
+ - [CalendarIntegration](docs/CalendarIntegration.md)
332
+ - [CalendarMember](docs/CalendarMember.md)
333
+ - [CalendarPolicies](docs/CalendarPolicies.md)
334
+ - [Contact](docs/Contact.md)
335
+ - [ContactList](docs/ContactList.md)
336
+ - [CreateBillingCheckout200Response](docs/CreateBillingCheckout200Response.md)
337
+ - [CreateBillingCheckoutRequest](docs/CreateBillingCheckoutRequest.md)
338
+ - [CreateCalendarEventRequest](docs/CreateCalendarEventRequest.md)
339
+ - [CreateCalendarIntegrationRequest](docs/CreateCalendarIntegrationRequest.md)
340
+ - [CreateCalendarRequest](docs/CreateCalendarRequest.md)
341
+ - [CreateContactListRequest](docs/CreateContactListRequest.md)
342
+ - [CreateContactRequest](docs/CreateContactRequest.md)
343
+ - [CreateDedicatedIPRequestRequest](docs/CreateDedicatedIPRequestRequest.md)
344
+ - [CreateDistributionListRequest](docs/CreateDistributionListRequest.md)
345
+ - [CreateEncryptionKey201Response](docs/CreateEncryptionKey201Response.md)
346
+ - [CreateEncryptionKeyRequest](docs/CreateEncryptionKeyRequest.md)
347
+ - [CreateEncryptionRecoveryRequest](docs/CreateEncryptionRecoveryRequest.md)
348
+ - [CreateMigrationCredentialRequest](docs/CreateMigrationCredentialRequest.md)
349
+ - [CreateMigrationCredentialRequestCredentials](docs/CreateMigrationCredentialRequestCredentials.md)
350
+ - [CreateMigrationRequest](docs/CreateMigrationRequest.md)
351
+ - [CreateResourceRequest](docs/CreateResourceRequest.md)
352
+ - [CreateUnitsCheckout200Response](docs/CreateUnitsCheckout200Response.md)
353
+ - [CreateUnitsCheckoutRequest](docs/CreateUnitsCheckoutRequest.md)
354
+ - [CreateUserRequest](docs/CreateUserRequest.md)
355
+ - [DNSRecord](docs/DNSRecord.md)
356
+ - [DedicatedIPRequest](docs/DedicatedIPRequest.md)
357
+ - [DirectoryPermissions](docs/DirectoryPermissions.md)
358
+ - [DiscoverMigration202Response](docs/DiscoverMigration202Response.md)
359
+ - [DistributionListDetail](docs/DistributionListDetail.md)
360
+ - [DistributionListSummary](docs/DistributionListSummary.md)
361
+ - [Domain](docs/Domain.md)
362
+ - [GALSettings](docs/GALSettings.md)
363
+ - [GetAddOnStatus200Response](docs/GetAddOnStatus200Response.md)
364
+ - [GetAuditSummary200Response](docs/GetAuditSummary200Response.md)
365
+ - [GetCalendarSecurity200Response](docs/GetCalendarSecurity200Response.md)
366
+ - [GetCalendarSecurity200ResponseAlertsInner](docs/GetCalendarSecurity200ResponseAlertsInner.md)
367
+ - [GetCalendarSecurity200ResponseDelegatedAccessInner](docs/GetCalendarSecurity200ResponseDelegatedAccessInner.md)
368
+ - [GetCalendarSecurity200ResponseExternalSharing](docs/GetCalendarSecurity200ResponseExternalSharing.md)
369
+ - [GetCalendarSecurity200ResponsePublicCalendarListInner](docs/GetCalendarSecurity200ResponsePublicCalendarListInner.md)
370
+ - [GetContactList200Response](docs/GetContactList200Response.md)
371
+ - [GetContactList200ResponseMembersInner](docs/GetContactList200ResponseMembersInner.md)
372
+ - [GetContactLists200Response](docs/GetContactLists200Response.md)
373
+ - [GetContactLists200ResponseDataInner](docs/GetContactLists200ResponseDataInner.md)
374
+ - [GetDirectoryActivity200Response](docs/GetDirectoryActivity200Response.md)
375
+ - [GetDirectoryActivity200ResponseDataInner](docs/GetDirectoryActivity200ResponseDataInner.md)
376
+ - [GetDirectoryStats200Response](docs/GetDirectoryStats200Response.md)
377
+ - [GetDomainsStatus200Response](docs/GetDomainsStatus200Response.md)
378
+ - [GetDomainsStatus200ResponseDomainsInner](docs/GetDomainsStatus200ResponseDomainsInner.md)
379
+ - [GetDomainsStatus200ResponseDomainsInnerChecksInner](docs/GetDomainsStatus200ResponseDomainsInnerChecksInner.md)
380
+ - [GetEncryptionKey200Response](docs/GetEncryptionKey200Response.md)
381
+ - [GetIPAssignment200Response](docs/GetIPAssignment200Response.md)
382
+ - [GetIntegrationsSummary200Response](docs/GetIntegrationsSummary200Response.md)
383
+ - [GetIntegrationsSummary200ResponseApiKeysInner](docs/GetIntegrationsSummary200ResponseApiKeysInner.md)
384
+ - [GetIntegrationsSummary200ResponseWebhooksInner](docs/GetIntegrationsSummary200ResponseWebhooksInner.md)
385
+ - [GetSecurity200Response](docs/GetSecurity200Response.md)
386
+ - [GetSecurity200ResponseAlertsInner](docs/GetSecurity200ResponseAlertsInner.md)
387
+ - [GetSecurity200ResponseStatsInner](docs/GetSecurity200ResponseStatsInner.md)
388
+ - [GetStorage200Response](docs/GetStorage200Response.md)
389
+ - [GetStorage200ResponseTopMailboxesInner](docs/GetStorage200ResponseTopMailboxesInner.md)
390
+ - [GetStorage200ResponseTopMessagesInner](docs/GetStorage200ResponseTopMessagesInner.md)
391
+ - [GetUserInsights200Response](docs/GetUserInsights200Response.md)
392
+ - [HealthzGet200Response](docs/HealthzGet200Response.md)
393
+ - [ListAddOns200Response](docs/ListAddOns200Response.md)
394
+ - [ListCalendarEvents200Response](docs/ListCalendarEvents200Response.md)
395
+ - [ListCalendarIntegrations200Response](docs/ListCalendarIntegrations200Response.md)
396
+ - [ListCalendarMembers200Response](docs/ListCalendarMembers200Response.md)
397
+ - [ListCalendars200Response](docs/ListCalendars200Response.md)
398
+ - [ListContactLists200Response](docs/ListContactLists200Response.md)
399
+ - [ListContacts200Response](docs/ListContacts200Response.md)
400
+ - [ListDedicatedIPRequests200Response](docs/ListDedicatedIPRequests200Response.md)
401
+ - [ListDistributionLists200Response](docs/ListDistributionLists200Response.md)
402
+ - [ListMigrationCredentials200Response](docs/ListMigrationCredentials200Response.md)
403
+ - [ListMigrationEvents200Response](docs/ListMigrationEvents200Response.md)
404
+ - [ListMigrationMailboxes200Response](docs/ListMigrationMailboxes200Response.md)
405
+ - [ListMigrations200Response](docs/ListMigrations200Response.md)
406
+ - [ListResources200Response](docs/ListResources200Response.md)
407
+ - [ListSharedMembers200Response](docs/ListSharedMembers200Response.md)
408
+ - [ListUsers200Response](docs/ListUsers200Response.md)
409
+ - [Mailbox](docs/Mailbox.md)
410
+ - [MapMigrationRequest](docs/MapMigrationRequest.md)
411
+ - [MapMigrationRequestMappingsInner](docs/MapMigrationRequestMappingsInner.md)
412
+ - [Message](docs/Message.md)
413
+ - [MessageStats](docs/MessageStats.md)
414
+ - [MessageStatsCounts](docs/MessageStatsCounts.md)
415
+ - [MessageStatsRates](docs/MessageStatsRates.md)
416
+ - [MessageStatsWindow](docs/MessageStatsWindow.md)
417
+ - [Migration](docs/Migration.md)
418
+ - [MigrationCredential](docs/MigrationCredential.md)
419
+ - [MigrationEvent](docs/MigrationEvent.md)
420
+ - [MigrationMailbox](docs/MigrationMailbox.md)
421
+ - [MigrationProgress](docs/MigrationProgress.md)
422
+ - [MigrationProgressMailboxesInner](docs/MigrationProgressMailboxesInner.md)
423
+ - [MigrationSettings](docs/MigrationSettings.md)
424
+ - [PlanCatalogEntry](docs/PlanCatalogEntry.md)
425
+ - [Problem](docs/Problem.md)
426
+ - [ReplaceDistributionListMembers200Response](docs/ReplaceDistributionListMembers200Response.md)
427
+ - [ReplaceDistributionListMembersRequest](docs/ReplaceDistributionListMembersRequest.md)
428
+ - [Resource](docs/Resource.md)
429
+ - [RotateEncryptionKeyRequest](docs/RotateEncryptionKeyRequest.md)
430
+ - [SendMessage](docs/SendMessage.md)
431
+ - [SharedMember](docs/SharedMember.md)
432
+ - [SignupRequest](docs/SignupRequest.md)
433
+ - [StartMigration202Response](docs/StartMigration202Response.md)
434
+ - [Suppression](docs/Suppression.md)
435
+ - [Template](docs/Template.md)
436
+ - [TemplateInput](docs/TemplateInput.md)
437
+ - [Tenant](docs/Tenant.md)
438
+ - [UnitBundle](docs/UnitBundle.md)
439
+ - [UpdateCalendarEventRequest](docs/UpdateCalendarEventRequest.md)
440
+ - [UpdateCalendarIntegrationRequest](docs/UpdateCalendarIntegrationRequest.md)
441
+ - [UpdateCalendarMemberRequest](docs/UpdateCalendarMemberRequest.md)
442
+ - [UpdateCalendarPoliciesRequest](docs/UpdateCalendarPoliciesRequest.md)
443
+ - [UpdateCalendarRequest](docs/UpdateCalendarRequest.md)
444
+ - [UpdateContactListRequest](docs/UpdateContactListRequest.md)
445
+ - [UpdateContactRequest](docs/UpdateContactRequest.md)
446
+ - [UpdateDirectoryPermissionsRequest](docs/UpdateDirectoryPermissionsRequest.md)
447
+ - [UpdateGALSettingsRequest](docs/UpdateGALSettingsRequest.md)
448
+ - [UpdateMigrationMailboxRequest](docs/UpdateMigrationMailboxRequest.md)
449
+ - [UpdateMigrationRequest](docs/UpdateMigrationRequest.md)
450
+ - [UpdateResourceRequest](docs/UpdateResourceRequest.md)
451
+ - [UpdateUserRequest](docs/UpdateUserRequest.md)
452
+ - [User](docs/User.md)
453
+ - [UserEvent](docs/UserEvent.md)
454
+ - [V1AdminLoginPost200Response](docs/V1AdminLoginPost200Response.md)
455
+ - [V1AdminLoginPostRequest](docs/V1AdminLoginPostRequest.md)
456
+ - [V1AdminMeGet200Response](docs/V1AdminMeGet200Response.md)
457
+ - [V1AdminsGet200Response](docs/V1AdminsGet200Response.md)
458
+ - [V1AdminsIdPatchRequest](docs/V1AdminsIdPatchRequest.md)
459
+ - [V1AdminsPostRequest](docs/V1AdminsPostRequest.md)
460
+ - [V1AliasesGet200Response](docs/V1AliasesGet200Response.md)
461
+ - [V1AliasesPostRequest](docs/V1AliasesPostRequest.md)
462
+ - [V1ApiKeysGet200Response](docs/V1ApiKeysGet200Response.md)
463
+ - [V1ApiKeysPost201Response](docs/V1ApiKeysPost201Response.md)
464
+ - [V1ApiKeysPostRequest](docs/V1ApiKeysPostRequest.md)
465
+ - [V1DomainsGet200Response](docs/V1DomainsGet200Response.md)
466
+ - [V1DomainsPostRequest](docs/V1DomainsPostRequest.md)
467
+ - [V1InboxesMailboxMessagesPostRequest](docs/V1InboxesMailboxMessagesPostRequest.md)
468
+ - [V1MailboxesEmailExportPost201Response](docs/V1MailboxesEmailExportPost201Response.md)
469
+ - [V1MailboxesEmailPatchRequest](docs/V1MailboxesEmailPatchRequest.md)
470
+ - [V1MailboxesEmailVacationPutRequest](docs/V1MailboxesEmailVacationPutRequest.md)
471
+ - [V1MailboxesGet200Response](docs/V1MailboxesGet200Response.md)
472
+ - [V1MailboxesPostRequest](docs/V1MailboxesPostRequest.md)
473
+ - [V1MessagesGet200Response](docs/V1MessagesGet200Response.md)
474
+ - [V1SendBatchPost200Response](docs/V1SendBatchPost200Response.md)
475
+ - [V1SendBatchPostRequest](docs/V1SendBatchPostRequest.md)
476
+ - [V1SendPost202Response](docs/V1SendPost202Response.md)
477
+ - [V1SendPostRequest](docs/V1SendPostRequest.md)
478
+ - [V1SendPostRequestAttachmentsInner](docs/V1SendPostRequestAttachmentsInner.md)
479
+ - [V1SuppressionsGet200Response](docs/V1SuppressionsGet200Response.md)
480
+ - [V1SuppressionsPostRequest](docs/V1SuppressionsPostRequest.md)
481
+ - [V1TemplatesGet200Response](docs/V1TemplatesGet200Response.md)
482
+ - [V1UsageGet200Response](docs/V1UsageGet200Response.md)
483
+ - [V1VacationGet200Response](docs/V1VacationGet200Response.md)
484
+ - [V1WebhooksGet200Response](docs/V1WebhooksGet200Response.md)
485
+ - [V1WebhooksIdPatchRequest](docs/V1WebhooksIdPatchRequest.md)
486
+ - [V1WebhooksPostRequest](docs/V1WebhooksPostRequest.md)
487
+ - [VacationParams](docs/VacationParams.md)
488
+ - [VacationResponder](docs/VacationResponder.md)
489
+ - [Webhook](docs/Webhook.md)
490
+
491
+
492
+ <a id="documentation-for-authorization"></a>
493
+ ## Documentation For Authorization
494
+
495
+
496
+ Authentication schemes defined for the API:
497
+ <a id="bearerAuth"></a>
498
+ ### bearerAuth
499
+
500
+ - **Type**: Bearer authentication (lk_live_<prefix>_<secret>)
501
+
502
+ <a id="oauth2"></a>
503
+ ### oauth2
504
+
505
+ - **Type**: OAuth
506
+ - **Flow**: accessCode
507
+ - **Authorization URL**: https://api.lockally.com/oauth/authorize
508
+ - **Scopes**:
509
+ - **inboxes:read**: Read agent-accessible mailboxes and threads
510
+ - **inboxes:write**: Send and act on agent-accessible mailboxes
511
+
512
+
513
+ ## Author
514
+
515
+ support@lockally.com
516
+
517
+