mailermine 1.0.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 (268) hide show
  1. mailermine-1.0.0/.gitignore +45 -0
  2. mailermine-1.0.0/CHANGELOG.md +55 -0
  3. mailermine-1.0.0/LICENSE +21 -0
  4. mailermine-1.0.0/PKG-INFO +548 -0
  5. mailermine-1.0.0/README.md +508 -0
  6. mailermine-1.0.0/generated/mailermine_generated/__init__.py +490 -0
  7. mailermine-1.0.0/generated/mailermine_generated/api/__init__.py +26 -0
  8. mailermine-1.0.0/generated/mailermine_generated/api/analytics_api.py +2299 -0
  9. mailermine-1.0.0/generated/mailermine_generated/api/api_keys_api.py +2271 -0
  10. mailermine-1.0.0/generated/mailermine_generated/api/audiences_api.py +1293 -0
  11. mailermine-1.0.0/generated/mailermine_generated/api/campaign_analytics_api.py +609 -0
  12. mailermine-1.0.0/generated/mailermine_generated/api/campaign_events_api.py +1250 -0
  13. mailermine-1.0.0/generated/mailermine_generated/api/campaign_lifecycle_api.py +2948 -0
  14. mailermine-1.0.0/generated/mailermine_generated/api/campaigns_api.py +2420 -0
  15. mailermine-1.0.0/generated/mailermine_generated/api/contacts_api.py +3004 -0
  16. mailermine-1.0.0/generated/mailermine_generated/api/domains_api.py +1570 -0
  17. mailermine-1.0.0/generated/mailermine_generated/api/emails_api.py +334 -0
  18. mailermine-1.0.0/generated/mailermine_generated/api/events_api.py +750 -0
  19. mailermine-1.0.0/generated/mailermine_generated/api/exports_api.py +908 -0
  20. mailermine-1.0.0/generated/mailermine_generated/api/imports_api.py +1778 -0
  21. mailermine-1.0.0/generated/mailermine_generated/api/lists_api.py +3137 -0
  22. mailermine-1.0.0/generated/mailermine_generated/api/marketing_api.py +1579 -0
  23. mailermine-1.0.0/generated/mailermine_generated/api/messages_api.py +1018 -0
  24. mailermine-1.0.0/generated/mailermine_generated/api/projects_api.py +1596 -0
  25. mailermine-1.0.0/generated/mailermine_generated/api/segments_api.py +2450 -0
  26. mailermine-1.0.0/generated/mailermine_generated/api/suppressions_api.py +1516 -0
  27. mailermine-1.0.0/generated/mailermine_generated/api/tags_api.py +2178 -0
  28. mailermine-1.0.0/generated/mailermine_generated/api/templates_api.py +2856 -0
  29. mailermine-1.0.0/generated/mailermine_generated/api/webhooks_api.py +4076 -0
  30. mailermine-1.0.0/generated/mailermine_generated/api_client.py +804 -0
  31. mailermine-1.0.0/generated/mailermine_generated/api_response.py +21 -0
  32. mailermine-1.0.0/generated/mailermine_generated/configuration.py +606 -0
  33. mailermine-1.0.0/generated/mailermine_generated/exceptions.py +218 -0
  34. mailermine-1.0.0/generated/mailermine_generated/models/__init__.py +216 -0
  35. mailermine-1.0.0/generated/mailermine_generated/models/add_audience_members200_response.py +116 -0
  36. mailermine-1.0.0/generated/mailermine_generated/models/add_audience_members200_response_data.py +101 -0
  37. mailermine-1.0.0/generated/mailermine_generated/models/add_contacts_to_list200_response.py +116 -0
  38. mailermine-1.0.0/generated/mailermine_generated/models/analytics_campaigns.py +113 -0
  39. mailermine-1.0.0/generated/mailermine_generated/models/analytics_campaigns_campaigns_inner.py +115 -0
  40. mailermine-1.0.0/generated/mailermine_generated/models/analytics_campaigns_response.py +109 -0
  41. mailermine-1.0.0/generated/mailermine_generated/models/analytics_domains.py +113 -0
  42. mailermine-1.0.0/generated/mailermine_generated/models/analytics_domains_domains_inner.py +103 -0
  43. mailermine-1.0.0/generated/mailermine_generated/models/analytics_domains_response.py +109 -0
  44. mailermine-1.0.0/generated/mailermine_generated/models/analytics_engagement.py +121 -0
  45. mailermine-1.0.0/generated/mailermine_generated/models/analytics_engagement_response.py +109 -0
  46. mailermine-1.0.0/generated/mailermine_generated/models/analytics_messages.py +125 -0
  47. mailermine-1.0.0/generated/mailermine_generated/models/analytics_messages_daily_inner.py +113 -0
  48. mailermine-1.0.0/generated/mailermine_generated/models/analytics_messages_response.py +109 -0
  49. mailermine-1.0.0/generated/mailermine_generated/models/analytics_messages_totals.py +111 -0
  50. mailermine-1.0.0/generated/mailermine_generated/models/analytics_overview.py +153 -0
  51. mailermine-1.0.0/generated/mailermine_generated/models/analytics_overview_daily_series_inner.py +107 -0
  52. mailermine-1.0.0/generated/mailermine_generated/models/analytics_overview_recent_activity_inner.py +112 -0
  53. mailermine-1.0.0/generated/mailermine_generated/models/analytics_overview_response.py +109 -0
  54. mailermine-1.0.0/generated/mailermine_generated/models/analytics_overview_top_campaigns_inner.py +109 -0
  55. mailermine-1.0.0/generated/mailermine_generated/models/analytics_overview_top_links_inner.py +114 -0
  56. mailermine-1.0.0/generated/mailermine_generated/models/analytics_projects.py +120 -0
  57. mailermine-1.0.0/generated/mailermine_generated/models/analytics_projects_projects_inner.py +121 -0
  58. mailermine-1.0.0/generated/mailermine_generated/models/analytics_projects_response.py +109 -0
  59. mailermine-1.0.0/generated/mailermine_generated/models/analytics_providers.py +113 -0
  60. mailermine-1.0.0/generated/mailermine_generated/models/analytics_providers_providers_inner.py +103 -0
  61. mailermine-1.0.0/generated/mailermine_generated/models/analytics_providers_response.py +109 -0
  62. mailermine-1.0.0/generated/mailermine_generated/models/api_key_list_response.py +119 -0
  63. mailermine-1.0.0/generated/mailermine_generated/models/api_key_resource.py +172 -0
  64. mailermine-1.0.0/generated/mailermine_generated/models/api_key_response.py +109 -0
  65. mailermine-1.0.0/generated/mailermine_generated/models/audience_collection.py +119 -0
  66. mailermine-1.0.0/generated/mailermine_generated/models/audience_resource.py +116 -0
  67. mailermine-1.0.0/generated/mailermine_generated/models/audience_response.py +109 -0
  68. mailermine-1.0.0/generated/mailermine_generated/models/bulk_assign_tags200_response.py +116 -0
  69. mailermine-1.0.0/generated/mailermine_generated/models/bulk_assign_tags200_response_data.py +101 -0
  70. mailermine-1.0.0/generated/mailermine_generated/models/bulk_contact_ids_request.py +103 -0
  71. mailermine-1.0.0/generated/mailermine_generated/models/bulk_delete_contacts200_response.py +116 -0
  72. mailermine-1.0.0/generated/mailermine_generated/models/bulk_delete_contacts200_response_data.py +101 -0
  73. mailermine-1.0.0/generated/mailermine_generated/models/bulk_remove_tags200_response.py +116 -0
  74. mailermine-1.0.0/generated/mailermine_generated/models/bulk_restore_contacts200_response.py +116 -0
  75. mailermine-1.0.0/generated/mailermine_generated/models/bulk_restore_contacts200_response_data.py +101 -0
  76. mailermine-1.0.0/generated/mailermine_generated/models/bulk_tag_contacts_request.py +105 -0
  77. mailermine-1.0.0/generated/mailermine_generated/models/bulk_update_contacts200_response.py +116 -0
  78. mailermine-1.0.0/generated/mailermine_generated/models/bulk_update_contacts200_response_data.py +101 -0
  79. mailermine-1.0.0/generated/mailermine_generated/models/bulk_update_contacts_request.py +112 -0
  80. mailermine-1.0.0/generated/mailermine_generated/models/campaign_activity.py +122 -0
  81. mailermine-1.0.0/generated/mailermine_generated/models/campaign_activity_collection.py +113 -0
  82. mailermine-1.0.0/generated/mailermine_generated/models/campaign_activity_event.py +43 -0
  83. mailermine-1.0.0/generated/mailermine_generated/models/campaign_activity_payload.py +145 -0
  84. mailermine-1.0.0/generated/mailermine_generated/models/campaign_analytics.py +144 -0
  85. mailermine-1.0.0/generated/mailermine_generated/models/campaign_analytics_response.py +115 -0
  86. mailermine-1.0.0/generated/mailermine_generated/models/campaign_collection.py +119 -0
  87. mailermine-1.0.0/generated/mailermine_generated/models/campaign_event.py +139 -0
  88. mailermine-1.0.0/generated/mailermine_generated/models/campaign_events_response.py +109 -0
  89. mailermine-1.0.0/generated/mailermine_generated/models/campaign_link.py +114 -0
  90. mailermine-1.0.0/generated/mailermine_generated/models/campaign_links_response.py +113 -0
  91. mailermine-1.0.0/generated/mailermine_generated/models/campaign_preview.py +117 -0
  92. mailermine-1.0.0/generated/mailermine_generated/models/campaign_preview_response.py +109 -0
  93. mailermine-1.0.0/generated/mailermine_generated/models/campaign_recipient.py +161 -0
  94. mailermine-1.0.0/generated/mailermine_generated/models/campaign_recipient_collection.py +119 -0
  95. mailermine-1.0.0/generated/mailermine_generated/models/campaign_recipient_preview.py +111 -0
  96. mailermine-1.0.0/generated/mailermine_generated/models/campaign_recipient_preview_response.py +109 -0
  97. mailermine-1.0.0/generated/mailermine_generated/models/campaign_recipient_status.py +41 -0
  98. mailermine-1.0.0/generated/mailermine_generated/models/campaign_resource.py +280 -0
  99. mailermine-1.0.0/generated/mailermine_generated/models/campaign_response.py +109 -0
  100. mailermine-1.0.0/generated/mailermine_generated/models/campaign_statistics.py +172 -0
  101. mailermine-1.0.0/generated/mailermine_generated/models/campaign_statistics_response.py +109 -0
  102. mailermine-1.0.0/generated/mailermine_generated/models/campaign_status.py +44 -0
  103. mailermine-1.0.0/generated/mailermine_generated/models/campaign_timeline.py +116 -0
  104. mailermine-1.0.0/generated/mailermine_generated/models/campaign_timeline_response.py +113 -0
  105. mailermine-1.0.0/generated/mailermine_generated/models/campaign_validation.py +105 -0
  106. mailermine-1.0.0/generated/mailermine_generated/models/campaign_validation_response.py +109 -0
  107. mailermine-1.0.0/generated/mailermine_generated/models/configure_contact_import_request.py +187 -0
  108. mailermine-1.0.0/generated/mailermine_generated/models/contact_collection.py +119 -0
  109. mailermine-1.0.0/generated/mailermine_generated/models/contact_resource.py +152 -0
  110. mailermine-1.0.0/generated/mailermine_generated/models/contact_response.py +109 -0
  111. mailermine-1.0.0/generated/mailermine_generated/models/create_api_key_request.py +136 -0
  112. mailermine-1.0.0/generated/mailermine_generated/models/create_campaign_request.py +183 -0
  113. mailermine-1.0.0/generated/mailermine_generated/models/create_contact_request.py +180 -0
  114. mailermine-1.0.0/generated/mailermine_generated/models/create_custom_field_request.py +152 -0
  115. mailermine-1.0.0/generated/mailermine_generated/models/create_domain_request.py +112 -0
  116. mailermine-1.0.0/generated/mailermine_generated/models/create_list_request.py +116 -0
  117. mailermine-1.0.0/generated/mailermine_generated/models/create_project_request.py +166 -0
  118. mailermine-1.0.0/generated/mailermine_generated/models/create_segment_request.py +115 -0
  119. mailermine-1.0.0/generated/mailermine_generated/models/create_segment_request_rules.py +118 -0
  120. mailermine-1.0.0/generated/mailermine_generated/models/create_suppression_request.py +112 -0
  121. mailermine-1.0.0/generated/mailermine_generated/models/create_tag_request.py +109 -0
  122. mailermine-1.0.0/generated/mailermine_generated/models/create_template_request.py +179 -0
  123. mailermine-1.0.0/generated/mailermine_generated/models/create_template_request_branding.py +312 -0
  124. mailermine-1.0.0/generated/mailermine_generated/models/create_template_request_variables_inner.py +124 -0
  125. mailermine-1.0.0/generated/mailermine_generated/models/create_webhook_request.py +116 -0
  126. mailermine-1.0.0/generated/mailermine_generated/models/custom_field.py +148 -0
  127. mailermine-1.0.0/generated/mailermine_generated/models/custom_field_collection.py +119 -0
  128. mailermine-1.0.0/generated/mailermine_generated/models/custom_field_response.py +109 -0
  129. mailermine-1.0.0/generated/mailermine_generated/models/custom_field_type.py +47 -0
  130. mailermine-1.0.0/generated/mailermine_generated/models/delete_response.py +114 -0
  131. mailermine-1.0.0/generated/mailermine_generated/models/delivery_log.py +175 -0
  132. mailermine-1.0.0/generated/mailermine_generated/models/dns_record.py +129 -0
  133. mailermine-1.0.0/generated/mailermine_generated/models/domain_list_response.py +119 -0
  134. mailermine-1.0.0/generated/mailermine_generated/models/domain_resource.py +212 -0
  135. mailermine-1.0.0/generated/mailermine_generated/models/domain_response.py +109 -0
  136. mailermine-1.0.0/generated/mailermine_generated/models/duplicate_campaign_request.py +101 -0
  137. mailermine-1.0.0/generated/mailermine_generated/models/duplicate_template_request.py +107 -0
  138. mailermine-1.0.0/generated/mailermine_generated/models/email_attachment.py +115 -0
  139. mailermine-1.0.0/generated/mailermine_generated/models/event_list_response.py +119 -0
  140. mailermine-1.0.0/generated/mailermine_generated/models/event_response.py +109 -0
  141. mailermine-1.0.0/generated/mailermine_generated/models/export_contacts_request.py +143 -0
  142. mailermine-1.0.0/generated/mailermine_generated/models/export_job.py +139 -0
  143. mailermine-1.0.0/generated/mailermine_generated/models/export_job_response.py +109 -0
  144. mailermine-1.0.0/generated/mailermine_generated/models/import_job.py +159 -0
  145. mailermine-1.0.0/generated/mailermine_generated/models/import_job_collection.py +113 -0
  146. mailermine-1.0.0/generated/mailermine_generated/models/import_job_detail.py +165 -0
  147. mailermine-1.0.0/generated/mailermine_generated/models/import_job_detail_response.py +109 -0
  148. mailermine-1.0.0/generated/mailermine_generated/models/import_job_response.py +109 -0
  149. mailermine-1.0.0/generated/mailermine_generated/models/import_job_summary.py +144 -0
  150. mailermine-1.0.0/generated/mailermine_generated/models/import_progress.py +169 -0
  151. mailermine-1.0.0/generated/mailermine_generated/models/inline_object.py +111 -0
  152. mailermine-1.0.0/generated/mailermine_generated/models/inline_object1.py +105 -0
  153. mailermine-1.0.0/generated/mailermine_generated/models/list_collection.py +119 -0
  154. mailermine-1.0.0/generated/mailermine_generated/models/list_contacts_membership_request.py +103 -0
  155. mailermine-1.0.0/generated/mailermine_generated/models/list_resource.py +128 -0
  156. mailermine-1.0.0/generated/mailermine_generated/models/list_response.py +109 -0
  157. mailermine-1.0.0/generated/mailermine_generated/models/message.py +201 -0
  158. mailermine-1.0.0/generated/mailermine_generated/models/message_detail_response.py +109 -0
  159. mailermine-1.0.0/generated/mailermine_generated/models/message_events_response.py +109 -0
  160. mailermine-1.0.0/generated/mailermine_generated/models/message_list_response.py +119 -0
  161. mailermine-1.0.0/generated/mailermine_generated/models/message_status.py +44 -0
  162. mailermine-1.0.0/generated/mailermine_generated/models/pagination_meta.py +107 -0
  163. mailermine-1.0.0/generated/mailermine_generated/models/preview_segment_request.py +105 -0
  164. mailermine-1.0.0/generated/mailermine_generated/models/preview_segment_request_rules.py +118 -0
  165. mailermine-1.0.0/generated/mailermine_generated/models/preview_segment_request_rules_rules_inner.py +110 -0
  166. mailermine-1.0.0/generated/mailermine_generated/models/preview_template_by_id_request.py +108 -0
  167. mailermine-1.0.0/generated/mailermine_generated/models/preview_template_request.py +105 -0
  168. mailermine-1.0.0/generated/mailermine_generated/models/project_list_response.py +119 -0
  169. mailermine-1.0.0/generated/mailermine_generated/models/project_resource.py +151 -0
  170. mailermine-1.0.0/generated/mailermine_generated/models/project_response.py +109 -0
  171. mailermine-1.0.0/generated/mailermine_generated/models/remove_audience_members200_response.py +116 -0
  172. mailermine-1.0.0/generated/mailermine_generated/models/remove_audience_members200_response_data.py +101 -0
  173. mailermine-1.0.0/generated/mailermine_generated/models/remove_contacts_from_list200_response.py +116 -0
  174. mailermine-1.0.0/generated/mailermine_generated/models/replay_webhook_request.py +132 -0
  175. mailermine-1.0.0/generated/mailermine_generated/models/schedule_campaign_request.py +112 -0
  176. mailermine-1.0.0/generated/mailermine_generated/models/segment_collection.py +119 -0
  177. mailermine-1.0.0/generated/mailermine_generated/models/segment_count_response.py +109 -0
  178. mailermine-1.0.0/generated/mailermine_generated/models/segment_count_response_data.py +103 -0
  179. mailermine-1.0.0/generated/mailermine_generated/models/segment_preview_response.py +109 -0
  180. mailermine-1.0.0/generated/mailermine_generated/models/segment_preview_response_data.py +111 -0
  181. mailermine-1.0.0/generated/mailermine_generated/models/segment_resource.py +132 -0
  182. mailermine-1.0.0/generated/mailermine_generated/models/segment_response.py +109 -0
  183. mailermine-1.0.0/generated/mailermine_generated/models/send_email_request.py +147 -0
  184. mailermine-1.0.0/generated/mailermine_generated/models/send_email_request_attachments_inner.py +111 -0
  185. mailermine-1.0.0/generated/mailermine_generated/models/send_email_request_variables.py +139 -0
  186. mailermine-1.0.0/generated/mailermine_generated/models/send_email_response.py +109 -0
  187. mailermine-1.0.0/generated/mailermine_generated/models/suppression.py +149 -0
  188. mailermine-1.0.0/generated/mailermine_generated/models/suppression_list_response.py +119 -0
  189. mailermine-1.0.0/generated/mailermine_generated/models/suppression_reason.py +39 -0
  190. mailermine-1.0.0/generated/mailermine_generated/models/suppression_response.py +109 -0
  191. mailermine-1.0.0/generated/mailermine_generated/models/tag_collection.py +119 -0
  192. mailermine-1.0.0/generated/mailermine_generated/models/tag_resource.py +121 -0
  193. mailermine-1.0.0/generated/mailermine_generated/models/tag_response.py +109 -0
  194. mailermine-1.0.0/generated/mailermine_generated/models/template_layout_style.py +38 -0
  195. mailermine-1.0.0/generated/mailermine_generated/models/template_list_response.py +119 -0
  196. mailermine-1.0.0/generated/mailermine_generated/models/template_preview.py +115 -0
  197. mailermine-1.0.0/generated/mailermine_generated/models/template_preview_response.py +114 -0
  198. mailermine-1.0.0/generated/mailermine_generated/models/template_resource.py +225 -0
  199. mailermine-1.0.0/generated/mailermine_generated/models/template_response.py +109 -0
  200. mailermine-1.0.0/generated/mailermine_generated/models/template_status.py +38 -0
  201. mailermine-1.0.0/generated/mailermine_generated/models/template_test_response.py +109 -0
  202. mailermine-1.0.0/generated/mailermine_generated/models/template_test_response_data.py +103 -0
  203. mailermine-1.0.0/generated/mailermine_generated/models/template_variable.py +112 -0
  204. mailermine-1.0.0/generated/mailermine_generated/models/template_variable_type.py +39 -0
  205. mailermine-1.0.0/generated/mailermine_generated/models/test_template_request.py +117 -0
  206. mailermine-1.0.0/generated/mailermine_generated/models/test_webhook_request.py +116 -0
  207. mailermine-1.0.0/generated/mailermine_generated/models/timeline_event.py +161 -0
  208. mailermine-1.0.0/generated/mailermine_generated/models/update_api_key_request.py +148 -0
  209. mailermine-1.0.0/generated/mailermine_generated/models/update_campaign_request.py +171 -0
  210. mailermine-1.0.0/generated/mailermine_generated/models/update_contact_request.py +163 -0
  211. mailermine-1.0.0/generated/mailermine_generated/models/update_custom_field_request.py +132 -0
  212. mailermine-1.0.0/generated/mailermine_generated/models/update_list_request.py +116 -0
  213. mailermine-1.0.0/generated/mailermine_generated/models/update_project_request.py +178 -0
  214. mailermine-1.0.0/generated/mailermine_generated/models/update_segment_request.py +115 -0
  215. mailermine-1.0.0/generated/mailermine_generated/models/update_segment_request_rules.py +118 -0
  216. mailermine-1.0.0/generated/mailermine_generated/models/update_tag_request.py +109 -0
  217. mailermine-1.0.0/generated/mailermine_generated/models/update_template_request.py +174 -0
  218. mailermine-1.0.0/generated/mailermine_generated/models/update_webhook_request.py +119 -0
  219. mailermine-1.0.0/generated/mailermine_generated/models/webhook.py +143 -0
  220. mailermine-1.0.0/generated/mailermine_generated/models/webhook_delivery.py +182 -0
  221. mailermine-1.0.0/generated/mailermine_generated/models/webhook_delivery_list_response.py +119 -0
  222. mailermine-1.0.0/generated/mailermine_generated/models/webhook_delivery_message.py +105 -0
  223. mailermine-1.0.0/generated/mailermine_generated/models/webhook_delivery_response.py +109 -0
  224. mailermine-1.0.0/generated/mailermine_generated/models/webhook_delivery_status.py +38 -0
  225. mailermine-1.0.0/generated/mailermine_generated/models/webhook_delivery_webhook.py +105 -0
  226. mailermine-1.0.0/generated/mailermine_generated/models/webhook_last_delivery.py +112 -0
  227. mailermine-1.0.0/generated/mailermine_generated/models/webhook_list_response.py +119 -0
  228. mailermine-1.0.0/generated/mailermine_generated/models/webhook_project.py +103 -0
  229. mailermine-1.0.0/generated/mailermine_generated/models/webhook_replay_response.py +109 -0
  230. mailermine-1.0.0/generated/mailermine_generated/models/webhook_replay_response_data.py +101 -0
  231. mailermine-1.0.0/generated/mailermine_generated/models/webhook_response.py +109 -0
  232. mailermine-1.0.0/generated/mailermine_generated/models/webhook_retry_policy.py +103 -0
  233. mailermine-1.0.0/generated/mailermine_generated/models/webhook_secret_response.py +109 -0
  234. mailermine-1.0.0/generated/mailermine_generated/models/webhook_with_secret.py +145 -0
  235. mailermine-1.0.0/generated/mailermine_generated/py.typed +0 -0
  236. mailermine-1.0.0/generated/mailermine_generated/rest.py +263 -0
  237. mailermine-1.0.0/mailermine/__init__.py +100 -0
  238. mailermine-1.0.0/mailermine/_internal/__init__.py +1 -0
  239. mailermine-1.0.0/mailermine/_internal/apis.py +111 -0
  240. mailermine-1.0.0/mailermine/client.py +298 -0
  241. mailermine-1.0.0/mailermine/config/__init__.py +174 -0
  242. mailermine-1.0.0/mailermine/constants.py +13 -0
  243. mailermine-1.0.0/mailermine/exceptions/__init__.py +608 -0
  244. mailermine-1.0.0/mailermine/py.typed +1 -0
  245. mailermine-1.0.0/mailermine/resources/__init__.py +43 -0
  246. mailermine-1.0.0/mailermine/resources/analytics.py +668 -0
  247. mailermine-1.0.0/mailermine/resources/api_keys.py +320 -0
  248. mailermine-1.0.0/mailermine/resources/audiences.py +386 -0
  249. mailermine-1.0.0/mailermine/resources/base.py +43 -0
  250. mailermine-1.0.0/mailermine/resources/campaigns.py +1727 -0
  251. mailermine-1.0.0/mailermine/resources/contacts.py +393 -0
  252. mailermine-1.0.0/mailermine/resources/domains.py +308 -0
  253. mailermine-1.0.0/mailermine/resources/emails.py +190 -0
  254. mailermine-1.0.0/mailermine/resources/events.py +203 -0
  255. mailermine-1.0.0/mailermine/resources/exports.py +137 -0
  256. mailermine-1.0.0/mailermine/resources/imports.py +237 -0
  257. mailermine-1.0.0/mailermine/resources/lists.py +320 -0
  258. mailermine-1.0.0/mailermine/resources/messages.py +208 -0
  259. mailermine-1.0.0/mailermine/resources/projects.py +225 -0
  260. mailermine-1.0.0/mailermine/resources/segments.py +288 -0
  261. mailermine-1.0.0/mailermine/resources/suppressions.py +258 -0
  262. mailermine-1.0.0/mailermine/resources/tags.py +323 -0
  263. mailermine-1.0.0/mailermine/resources/templates.py +368 -0
  264. mailermine-1.0.0/mailermine/resources/webhooks.py +639 -0
  265. mailermine-1.0.0/mailermine/support/__init__.py +183 -0
  266. mailermine-1.0.0/mailermine/support/serialization.py +202 -0
  267. mailermine-1.0.0/mailermine/types.py +9 -0
  268. mailermine-1.0.0/pyproject.toml +152 -0
@@ -0,0 +1,45 @@
1
+ # Byte-compiled / cache
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.so
6
+ .Python
7
+
8
+ # Virtual environments
9
+ .venv/
10
+ venv/
11
+ ENV/
12
+ env/
13
+
14
+ # Packaging / build
15
+ build/
16
+ dist/
17
+ *.egg-info/
18
+ .eggs/
19
+ *.egg
20
+
21
+ # Test / type / lint caches
22
+ .pytest_cache/
23
+ .mypy_cache/
24
+ .ruff_cache/
25
+ .coverage
26
+ .coverage.*
27
+ htmlcov/
28
+ coverage.xml
29
+
30
+ # OpenAPI Generator cache (pinned JAR lives here when generation lands)
31
+ .cache/
32
+
33
+ # Local env / secrets
34
+ .env
35
+ .env.*
36
+ !.env.example
37
+
38
+ # Editors / OS
39
+ .idea/
40
+ .vscode/
41
+ *.swp
42
+ .DS_Store
43
+
44
+ # Local OpenAPI pin may be regenerated; keep if committed for reproducibility
45
+ # openapi.json is intentionally not ignored (parity with Node/Laravel SDKs).
@@ -0,0 +1,55 @@
1
+ # Changelog
2
+
3
+ All notable changes to the MailerMine Python SDK are documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [1.0.0] — 2026-07-18
9
+
10
+ First stable public release of the official MailerMine Python SDK. Full public-surface
11
+ parity with `@mailermine/node` and `mailermine/mailermine` (Laravel).
12
+
13
+ ### Features
14
+
15
+ - `MailerMine` client with lazy-loaded resources and shared generated transport
16
+ - Immutable `Configuration` with environment variable support
17
+ - Sync-only HTTP client (urllib3) with architecture ready for a future async client
18
+ - Typed public surface (`py.typed`) for IDE autocomplete
19
+
20
+ ### Resources
21
+
22
+ Eighteen resources with Node/Laravel method parity:
23
+
24
+ - Projects, API Keys, Emails, Domains, Templates
25
+ - Contacts, Lists, Segments, Tags, Audiences
26
+ - Campaigns, Analytics, Events, Messages
27
+ - Webhooks, Suppressions, Imports, Exports
28
+
29
+ ### Exceptions
30
+
31
+ Public hierarchy (generated exceptions never leak):
32
+
33
+ - `MailerMineError`
34
+ - `ApiError`
35
+ - `AuthenticationError`
36
+ - `ValidationError`
37
+ - `NotFoundError`
38
+ - `PlanError`
39
+ - `RateLimitError`
40
+
41
+ ### Responses
42
+
43
+ - `Response` — `success`, `data`, `message`, `meta`
44
+ - `Collection` — iterable items, index access, `len()`
45
+ - `Pagination` — `current_page`, `per_page`, `total`, `last_page`
46
+
47
+ ### Packaging
48
+
49
+ - PyPI name: `mailermine`
50
+ - Python `>=3.10`
51
+ - Install via `pip`, `poetry`, or `uv`
52
+ - MIT license
53
+ - Wheel includes `mailermine` + internal `mailermine_generated` transport
54
+
55
+ [1.0.0]: https://github.com/rahulyadav5192/mailermine-sdk-python/releases/tag/v1.0.0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 MailerMine
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,548 @@
1
+ Metadata-Version: 2.4
2
+ Name: mailermine
3
+ Version: 1.0.0
4
+ Summary: Official MailerMine SDK for Python.
5
+ Project-URL: Homepage, https://mailermine.com
6
+ Project-URL: Documentation, https://mailermine.com/docs
7
+ Project-URL: Repository, https://github.com/rahulyadav5192/mailermine-sdk-python
8
+ Project-URL: Issues, https://github.com/rahulyadav5192/mailermine-sdk-python/issues
9
+ Project-URL: Changelog, https://github.com/rahulyadav5192/mailermine-sdk-python/blob/main/CHANGELOG.md
10
+ Author-email: MailerMine <support@mailermine.com>
11
+ License-Expression: MIT
12
+ License-File: LICENSE
13
+ Keywords: analytics,api,campaigns,email,mailermine,marketing,python,sdk,transactional,webhooks
14
+ Classifier: Development Status :: 5 - Production/Stable
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: License :: OSI Approved :: MIT License
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
24
+ Classifier: Topic :: Communications :: Email
25
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
26
+ Classifier: Typing :: Typed
27
+ Requires-Python: >=3.10
28
+ Requires-Dist: pydantic>=2.11
29
+ Requires-Dist: python-dateutil>=2.8.2
30
+ Requires-Dist: typing-extensions>=4.7.1
31
+ Requires-Dist: urllib3<3.0.0,>=2.1.0
32
+ Provides-Extra: dev
33
+ Requires-Dist: build>=1.2; extra == 'dev'
34
+ Requires-Dist: hatchling>=1.25; extra == 'dev'
35
+ Requires-Dist: mypy>=1.15; extra == 'dev'
36
+ Requires-Dist: pytest-cov>=6.0; extra == 'dev'
37
+ Requires-Dist: pytest>=8.3; extra == 'dev'
38
+ Requires-Dist: ruff>=0.11; extra == 'dev'
39
+ Description-Content-Type: text/markdown
40
+
41
+ # MailerMine Python SDK
42
+
43
+ Official MailerMine SDK for Python — send transactional email, run campaigns, manage
44
+ contacts, and read analytics with a clean, typed API.
45
+
46
+ [![PyPI](https://img.shields.io/pypi/v/mailermine.svg)](https://pypi.org/project/mailermine/)
47
+ [![Python](https://img.shields.io/pypi/pyversions/mailermine.svg)](https://pypi.org/project/mailermine/)
48
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
49
+
50
+ Parity with [`@mailermine/node`](https://www.npmjs.com/package/@mailermine/node) and
51
+ [`mailermine/mailermine`](https://packagist.org/packages/mailermine/mailermine) across
52
+ all **18** resources.
53
+
54
+ ---
55
+
56
+ ## Installation
57
+
58
+ ```bash
59
+ pip install mailermine
60
+ ```
61
+
62
+ ```bash
63
+ poetry add mailermine
64
+ ```
65
+
66
+ ```bash
67
+ uv add mailermine
68
+ ```
69
+
70
+ **Requirements:** Python 3.10+
71
+
72
+ ---
73
+
74
+ ## Quick Start
75
+
76
+ ```python
77
+ from mailermine import MailerMine
78
+
79
+ client = MailerMine(
80
+ api_key="relay_live_xxx"
81
+ )
82
+
83
+ response = client.emails.send(
84
+ from_="info@example.com",
85
+ to=["john@example.com"],
86
+ subject="Hello",
87
+ html="<h1>Hello</h1>",
88
+ )
89
+
90
+ print(response.data)
91
+ ```
92
+
93
+ Or load credentials from the environment:
94
+
95
+ ```python
96
+ import os
97
+ from mailermine import MailerMine
98
+
99
+ client = MailerMine(api_key=os.environ["MAILERMINE_API_KEY"])
100
+ ```
101
+
102
+ ---
103
+
104
+ ## Configuration
105
+
106
+ ```python
107
+ from mailermine import MailerMine, Configuration
108
+
109
+ client = MailerMine(
110
+ api_key="relay_live_xxx",
111
+ base_url="https://mailermine.com/api/v1",
112
+ timeout=30.0,
113
+ )
114
+
115
+ # Or build configuration explicitly:
116
+ config = Configuration.create(
117
+ api_key="relay_live_xxx",
118
+ base_url="https://mailermine.com/api/v1",
119
+ timeout=30.0,
120
+ )
121
+ client = MailerMine(configuration=config)
122
+ ```
123
+
124
+ ### Environment variables
125
+
126
+ | Variable | Purpose |
127
+ | --- | --- |
128
+ | `MAILERMINE_API_KEY` | Bearer API key (used when `api_key` is omitted) |
129
+ | `MAILERMINE_BASE_URL` | API base URL (default `https://mailermine.com/api/v1`) |
130
+ | `MAILERMINE_TIMEOUT` | Request timeout in **seconds** (default `30`) |
131
+
132
+ ```python
133
+ # Reads MAILERMINE_API_KEY / MAILERMINE_BASE_URL / MAILERMINE_TIMEOUT
134
+ client = MailerMine()
135
+ ```
136
+
137
+ | Option | Type | Default | Description |
138
+ | --- | --- | --- | --- |
139
+ | `api_key` | `str` | — | Required MailerMine API key |
140
+ | `base_url` | `str` | `https://mailermine.com/api/v1` | API base URL |
141
+ | `timeout` | `float` | `30.0` | Request timeout in seconds |
142
+ | `user_agent` | `str` | `mailermine-python/1.0.0` | User-Agent header |
143
+
144
+ ---
145
+
146
+ ## Resources
147
+
148
+ ### Projects
149
+
150
+ ```python
151
+ client.projects.create(name="Production", environment="production")
152
+ client.projects.list()
153
+ client.projects.get(project_id)
154
+ client.projects.update(project_id, name="Prod")
155
+ client.projects.delete(project_id)
156
+ ```
157
+
158
+ ### API Keys
159
+
160
+ ```python
161
+ client.api_keys.create(project_id, name="CI", scopes=["send"])
162
+ client.api_keys.list(project_id)
163
+ client.api_keys.get(project_id, api_key_id)
164
+ client.api_keys.update(project_id, api_key_id, name="CI Bot")
165
+ client.api_keys.rotate(project_id, api_key_id)
166
+ client.api_keys.reveal(project_id, api_key_id)
167
+ client.api_keys.delete(project_id, api_key_id)
168
+ ```
169
+
170
+ ### Emails
171
+
172
+ ```python
173
+ client.emails.send(
174
+ from_="MailerMine <hello@example.com>",
175
+ to=["user@example.com"],
176
+ subject="Invoice ready",
177
+ html="<p>Your invoice is ready.</p>",
178
+ text="Your invoice is ready.",
179
+ reply_to="support@example.com",
180
+ tags=["invoice"],
181
+ metadata={"order_id": "123"},
182
+ )
183
+
184
+ client.emails.list(status="delivered", per_page=25)
185
+ client.emails.get(message_id)
186
+ client.emails.events(message_id)
187
+ ```
188
+
189
+ > Use `from_` as a keyword argument (or pass `"from"` inside a dict) because `from` is reserved in Python.
190
+
191
+ ### Domains
192
+
193
+ ```python
194
+ created = client.domains.create(domain="mail.example.com")
195
+ domain_id = created.data["id"]
196
+
197
+ client.domains.list()
198
+ client.domains.get(domain_id)
199
+ client.domains.dns_records(domain_id)
200
+ client.domains.status(domain_id)
201
+ client.domains.verify(domain_id)
202
+ client.domains.delete(domain_id)
203
+ ```
204
+
205
+ ### Templates
206
+
207
+ ```python
208
+ client.templates.create(
209
+ name="Welcome",
210
+ subject="Welcome {{first_name}}",
211
+ html="<h1>Welcome {{first_name}}</h1>",
212
+ )
213
+ client.templates.list(search="welcome")
214
+ client.templates.get(template_id)
215
+ client.templates.update(template_id, subject="Hey {{first_name}}")
216
+ client.templates.preview(template_id, variables={"first_name": "John"})
217
+ client.templates.duplicate(template_id, name="Welcome (copy)")
218
+ client.templates.test(template_id, to="you@example.com")
219
+ client.templates.delete(template_id)
220
+ ```
221
+
222
+ ### Contacts
223
+
224
+ ```python
225
+ client.contacts.create(email="john@example.com", first_name="John")
226
+ client.contacts.upsert(email="john@example.com", first_name="Johnny")
227
+ client.contacts.list(page=1, per_page=25)
228
+ client.contacts.get(contact_id)
229
+ client.contacts.identify("john@example.com")
230
+ client.contacts.search("john")
231
+ client.contacts.update(contact_id, last_name="Doe")
232
+ client.contacts.subscribe(contact_id)
233
+ client.contacts.unsubscribe(contact_id)
234
+ client.contacts.delete(contact_id)
235
+ ```
236
+
237
+ ### Lists
238
+
239
+ ```python
240
+ client.lists.create(name="Newsletter")
241
+ client.lists.list()
242
+ client.lists.get(list_id)
243
+ client.lists.update(list_id, name="Weekly")
244
+ client.lists.add_contact(list_id, contact_ids)
245
+ client.lists.remove_contact(list_id, contact_ids)
246
+ client.lists.delete(list_id)
247
+ ```
248
+
249
+ ### Segments
250
+
251
+ ```python
252
+ client.segments.create(name="Active users", rules={...})
253
+ client.segments.list()
254
+ client.segments.get(segment_id)
255
+ client.segments.update(segment_id, name="Engaged")
256
+ client.segments.preview(segment_id)
257
+ client.segments.delete(segment_id)
258
+ ```
259
+
260
+ ### Tags
261
+
262
+ ```python
263
+ client.tags.create(name="vip")
264
+ client.tags.list()
265
+ client.tags.get(tag_id)
266
+ client.tags.update(tag_id, name="VIP")
267
+ client.tags.assign(contact_ids=[...], tag_ids=[...])
268
+ client.tags.remove(contact_ids=[...], tag_ids=[...])
269
+ client.tags.delete(tag_id)
270
+ ```
271
+
272
+ ### Audiences
273
+
274
+ ```python
275
+ client.audiences.list()
276
+ client.audiences.get("list", audience_id)
277
+ client.audiences.create(source="list", name="Launch list")
278
+ client.audiences.contacts("list", audience_id)
279
+ client.audiences.add_contacts(audience_id, contact_ids)
280
+ client.audiences.remove_contacts(audience_id, contact_ids)
281
+ ```
282
+
283
+ ### Campaigns
284
+
285
+ ```python
286
+ client.campaigns.create(name="Spring launch")
287
+ client.campaigns.list(status="draft")
288
+ client.campaigns.get(campaign_id)
289
+ client.campaigns.update(campaign_id, subject="Hello")
290
+ client.campaigns.set_template(campaign_id, template_id)
291
+ client.campaigns.set_subject(campaign_id, "Spring sale")
292
+ client.campaigns.set_sender(campaign_id, from_email="hello@example.com", from_name="Team")
293
+ client.campaigns.set_reply_to(campaign_id, "support@example.com")
294
+ client.campaigns.set_preheader(campaign_id, "Don't miss it")
295
+ client.campaigns.preview(campaign_id)
296
+ client.campaigns.render(campaign_id)
297
+ client.campaigns.validate(campaign_id)
298
+ client.campaigns.mark_ready(campaign_id)
299
+ client.campaigns.send(campaign_id)
300
+ client.campaigns.schedule(campaign_id, scheduled_at="2026-07-20T10:00:00Z")
301
+ client.campaigns.pause(campaign_id)
302
+ client.campaigns.resume(campaign_id)
303
+ client.campaigns.cancel(campaign_id)
304
+ client.campaigns.analytics(campaign_id)
305
+ client.campaigns.events(campaign_id)
306
+ client.campaigns.timeline(campaign_id)
307
+ client.campaigns.activity(campaign_id)
308
+ client.campaigns.progress(campaign_id)
309
+ client.campaigns.status(campaign_id)
310
+ ```
311
+
312
+ ### Analytics
313
+
314
+ ```python
315
+ client.analytics.overview()
316
+ client.analytics.usage()
317
+ client.analytics.messages()
318
+ client.analytics.engagement()
319
+ client.analytics.campaigns()
320
+ client.analytics.domains()
321
+ client.analytics.projects()
322
+ client.analytics.providers()
323
+ client.analytics.activity()
324
+ client.analytics.opens()
325
+ client.analytics.clicks()
326
+ client.analytics.deliveries()
327
+ client.analytics.bounces()
328
+ client.analytics.complaints()
329
+ client.analytics.unsubscribes()
330
+ ```
331
+
332
+ ### Events
333
+
334
+ ```python
335
+ client.events.list(event_type="delivered")
336
+ client.events.get(event_id)
337
+ client.events.timeline(message_id)
338
+ client.events.history(message_id)
339
+ client.events.message(message_id)
340
+ ```
341
+
342
+ ### Messages
343
+
344
+ ```python
345
+ client.messages.list(status="delivered")
346
+ client.messages.search("invoice")
347
+ client.messages.filter(status="bounced")
348
+ client.messages.get(message_id)
349
+ client.messages.events(message_id)
350
+ client.messages.timeline(message_id)
351
+ ```
352
+
353
+ ### Webhooks
354
+
355
+ ```python
356
+ client.webhooks.create(url="https://example.com/hooks/mailermine", events=["email.delivered"])
357
+ client.webhooks.list()
358
+ client.webhooks.get(webhook_id)
359
+ client.webhooks.update(webhook_id, url="https://example.com/hooks/v2")
360
+ client.webhooks.enable(webhook_id)
361
+ client.webhooks.disable(webhook_id)
362
+ client.webhooks.rotate_secret(webhook_id)
363
+ client.webhooks.test(webhook_id)
364
+ client.webhooks.deliveries(webhook_id)
365
+ client.webhooks.delivery(delivery_id)
366
+ client.webhooks.logs(webhook_id)
367
+ client.webhooks.failures(webhook_id)
368
+ client.webhooks.replay(webhook_id)
369
+ client.webhooks.retry(delivery_id)
370
+ client.webhooks.delete(webhook_id)
371
+
372
+ # Local signature verification (no network):
373
+ from mailermine import Webhooks
374
+
375
+ Webhooks.verify(raw_body, signature_header, signing_secret)
376
+ ```
377
+
378
+ ### Suppressions
379
+
380
+ ```python
381
+ client.suppressions.add(email="bounce@example.com", reason="hard_bounce")
382
+ client.suppressions.list()
383
+ client.suppressions.get(suppression_id)
384
+ client.suppressions.check("bounce@example.com")
385
+ client.suppressions.restore(suppression_id)
386
+ client.suppressions.remove(suppression_id)
387
+ ```
388
+
389
+ ### Imports
390
+
391
+ ```python
392
+ client.imports.create(...)
393
+ client.imports.list()
394
+ client.imports.status(import_id)
395
+ client.imports.configure(import_id, ...)
396
+ client.imports.start(import_id)
397
+ ```
398
+
399
+ ### Exports
400
+
401
+ ```python
402
+ job = client.exports.create()
403
+ client.exports.status(job.data["id"])
404
+ csv_body = client.exports.download(job.data["id"])
405
+ ```
406
+
407
+ ---
408
+
409
+ ## Response Objects
410
+
411
+ Successful calls return `Response` or `Collection` — never generated OpenAPI models.
412
+
413
+ ### Response
414
+
415
+ ```python
416
+ response = client.emails.send(...)
417
+
418
+ response.success # bool
419
+ response.message # str
420
+ response.data # primary payload (dict / list / scalar)
421
+ response.meta # optional metadata
422
+ response.to_dict() # JSON-serializable envelope
423
+ ```
424
+
425
+ ### Collection
426
+
427
+ ```python
428
+ page = client.contacts.list(page=1, per_page=25)
429
+
430
+ page.items # list of items on this page
431
+ page.pagination # Pagination
432
+ len(page) # page size
433
+ page[0] # index access
434
+ for contact in page: # iterable
435
+ print(contact["email"])
436
+ ```
437
+
438
+ ### Pagination
439
+
440
+ ```python
441
+ meta = page.pagination
442
+ meta.current_page
443
+ meta.per_page
444
+ meta.total
445
+ meta.last_page
446
+ meta.has_next_page
447
+ meta.has_previous_page
448
+ ```
449
+
450
+ ---
451
+
452
+ ## Exception Handling
453
+
454
+ ```python
455
+ from mailermine import (
456
+ MailerMine,
457
+ AuthenticationError,
458
+ ValidationError,
459
+ NotFoundError,
460
+ PlanError,
461
+ RateLimitError,
462
+ ApiError,
463
+ )
464
+
465
+ client = MailerMine(api_key="relay_live_xxx")
466
+
467
+ try:
468
+ client.emails.send(from_="hello@example.com", to="user@example.com", subject="Hi", html="<p>Hi</p>")
469
+ except ValidationError as e:
470
+ print(e.errors) # field -> messages
471
+ except AuthenticationError:
472
+ print("Check your API key")
473
+ except PlanError as e:
474
+ print(e.upgrade_url)
475
+ except NotFoundError:
476
+ print("Missing resource")
477
+ except RateLimitError as e:
478
+ print(e.retry_after) # seconds, or None
479
+ except ApiError as e:
480
+ print(e.status, e.request_id, e.body)
481
+ ```
482
+
483
+ | Exception | Typical cause |
484
+ | --- | --- |
485
+ | `AuthenticationError` | Invalid / missing API key (401) |
486
+ | `PlanError` | Plan or scope restriction (403) |
487
+ | `NotFoundError` | Missing object (404) |
488
+ | `ValidationError` | Invalid payload (422) |
489
+ | `RateLimitError` | Too many requests (429) |
490
+ | `ApiError` | Other HTTP / transport failures |
491
+ | `MailerMineError` | Base type for all SDK errors |
492
+
493
+ Generated OpenAPI exceptions are never exposed.
494
+
495
+ ---
496
+
497
+ ## Examples
498
+
499
+ Runnable scripts live in [`examples/`](examples):
500
+
501
+ | File | Topic |
502
+ | --- | --- |
503
+ | `send_email.py` | Transactional send |
504
+ | `campaign.py` | Campaign lifecycle |
505
+ | `contacts.py` | Contacts + lists |
506
+ | `analytics.py` | Account analytics |
507
+ | `domains.py` | Domains + DNS |
508
+ | `templates.py` | Templates |
509
+ | `webhooks.py` | Webhooks + verify |
510
+ | `messages.py` | Message history |
511
+ | `events.py` | Event stream |
512
+ | `imports.py` | Contact imports |
513
+ | `exports.py` | Contact exports |
514
+
515
+ ```bash
516
+ export MAILERMINE_API_KEY=relay_live_xxx
517
+ python examples/send_email.py
518
+ ```
519
+
520
+ ---
521
+
522
+ ## Development
523
+
524
+ ```bash
525
+ python -m venv .venv
526
+ source .venv/bin/activate
527
+ pip install -e ".[dev]"
528
+ ruff check mailermine tests
529
+ mypy mailermine
530
+ pytest
531
+ python -m build
532
+ ```
533
+
534
+ OpenAPI client code is generated into `generated/` and must not be edited by hand.
535
+ See [ARCHITECTURE.md](ARCHITECTURE.md), [GENERATION_REPORT.md](GENERATION_REPORT.md),
536
+ [WRAPPER_REPORT.md](WRAPPER_REPORT.md), and [PARITY_REPORT.md](PARITY_REPORT.md).
537
+
538
+ ---
539
+
540
+ ## Support
541
+
542
+ - Docs: https://mailermine.com/docs
543
+ - Issues: https://github.com/rahulyadav5192/mailermine-sdk-python/issues
544
+ - Email: support@mailermine.com
545
+
546
+ ## License
547
+
548
+ MIT — see [LICENSE](LICENSE).