mailermine 1.0.0__py3-none-any.whl
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.
- mailermine/__init__.py +100 -0
- mailermine/_internal/__init__.py +1 -0
- mailermine/_internal/apis.py +111 -0
- mailermine/client.py +298 -0
- mailermine/config/__init__.py +174 -0
- mailermine/constants.py +13 -0
- mailermine/exceptions/__init__.py +608 -0
- mailermine/py.typed +1 -0
- mailermine/resources/__init__.py +43 -0
- mailermine/resources/analytics.py +668 -0
- mailermine/resources/api_keys.py +320 -0
- mailermine/resources/audiences.py +386 -0
- mailermine/resources/base.py +43 -0
- mailermine/resources/campaigns.py +1727 -0
- mailermine/resources/contacts.py +393 -0
- mailermine/resources/domains.py +308 -0
- mailermine/resources/emails.py +190 -0
- mailermine/resources/events.py +203 -0
- mailermine/resources/exports.py +137 -0
- mailermine/resources/imports.py +237 -0
- mailermine/resources/lists.py +320 -0
- mailermine/resources/messages.py +208 -0
- mailermine/resources/projects.py +225 -0
- mailermine/resources/segments.py +288 -0
- mailermine/resources/suppressions.py +258 -0
- mailermine/resources/tags.py +323 -0
- mailermine/resources/templates.py +368 -0
- mailermine/resources/webhooks.py +639 -0
- mailermine/support/__init__.py +183 -0
- mailermine/support/serialization.py +202 -0
- mailermine/types.py +9 -0
- mailermine-1.0.0.dist-info/METADATA +548 -0
- mailermine-1.0.0.dist-info/RECORD +266 -0
- mailermine-1.0.0.dist-info/WHEEL +4 -0
- mailermine-1.0.0.dist-info/licenses/LICENSE +21 -0
- mailermine_generated/__init__.py +490 -0
- mailermine_generated/api/__init__.py +26 -0
- mailermine_generated/api/analytics_api.py +2299 -0
- mailermine_generated/api/api_keys_api.py +2271 -0
- mailermine_generated/api/audiences_api.py +1293 -0
- mailermine_generated/api/campaign_analytics_api.py +609 -0
- mailermine_generated/api/campaign_events_api.py +1250 -0
- mailermine_generated/api/campaign_lifecycle_api.py +2948 -0
- mailermine_generated/api/campaigns_api.py +2420 -0
- mailermine_generated/api/contacts_api.py +3004 -0
- mailermine_generated/api/domains_api.py +1570 -0
- mailermine_generated/api/emails_api.py +334 -0
- mailermine_generated/api/events_api.py +750 -0
- mailermine_generated/api/exports_api.py +908 -0
- mailermine_generated/api/imports_api.py +1778 -0
- mailermine_generated/api/lists_api.py +3137 -0
- mailermine_generated/api/marketing_api.py +1579 -0
- mailermine_generated/api/messages_api.py +1018 -0
- mailermine_generated/api/projects_api.py +1596 -0
- mailermine_generated/api/segments_api.py +2450 -0
- mailermine_generated/api/suppressions_api.py +1516 -0
- mailermine_generated/api/tags_api.py +2178 -0
- mailermine_generated/api/templates_api.py +2856 -0
- mailermine_generated/api/webhooks_api.py +4076 -0
- mailermine_generated/api_client.py +804 -0
- mailermine_generated/api_response.py +21 -0
- mailermine_generated/configuration.py +606 -0
- mailermine_generated/exceptions.py +218 -0
- mailermine_generated/models/__init__.py +216 -0
- mailermine_generated/models/add_audience_members200_response.py +116 -0
- mailermine_generated/models/add_audience_members200_response_data.py +101 -0
- mailermine_generated/models/add_contacts_to_list200_response.py +116 -0
- mailermine_generated/models/analytics_campaigns.py +113 -0
- mailermine_generated/models/analytics_campaigns_campaigns_inner.py +115 -0
- mailermine_generated/models/analytics_campaigns_response.py +109 -0
- mailermine_generated/models/analytics_domains.py +113 -0
- mailermine_generated/models/analytics_domains_domains_inner.py +103 -0
- mailermine_generated/models/analytics_domains_response.py +109 -0
- mailermine_generated/models/analytics_engagement.py +121 -0
- mailermine_generated/models/analytics_engagement_response.py +109 -0
- mailermine_generated/models/analytics_messages.py +125 -0
- mailermine_generated/models/analytics_messages_daily_inner.py +113 -0
- mailermine_generated/models/analytics_messages_response.py +109 -0
- mailermine_generated/models/analytics_messages_totals.py +111 -0
- mailermine_generated/models/analytics_overview.py +153 -0
- mailermine_generated/models/analytics_overview_daily_series_inner.py +107 -0
- mailermine_generated/models/analytics_overview_recent_activity_inner.py +112 -0
- mailermine_generated/models/analytics_overview_response.py +109 -0
- mailermine_generated/models/analytics_overview_top_campaigns_inner.py +109 -0
- mailermine_generated/models/analytics_overview_top_links_inner.py +114 -0
- mailermine_generated/models/analytics_projects.py +120 -0
- mailermine_generated/models/analytics_projects_projects_inner.py +121 -0
- mailermine_generated/models/analytics_projects_response.py +109 -0
- mailermine_generated/models/analytics_providers.py +113 -0
- mailermine_generated/models/analytics_providers_providers_inner.py +103 -0
- mailermine_generated/models/analytics_providers_response.py +109 -0
- mailermine_generated/models/api_key_list_response.py +119 -0
- mailermine_generated/models/api_key_resource.py +172 -0
- mailermine_generated/models/api_key_response.py +109 -0
- mailermine_generated/models/audience_collection.py +119 -0
- mailermine_generated/models/audience_resource.py +116 -0
- mailermine_generated/models/audience_response.py +109 -0
- mailermine_generated/models/bulk_assign_tags200_response.py +116 -0
- mailermine_generated/models/bulk_assign_tags200_response_data.py +101 -0
- mailermine_generated/models/bulk_contact_ids_request.py +103 -0
- mailermine_generated/models/bulk_delete_contacts200_response.py +116 -0
- mailermine_generated/models/bulk_delete_contacts200_response_data.py +101 -0
- mailermine_generated/models/bulk_remove_tags200_response.py +116 -0
- mailermine_generated/models/bulk_restore_contacts200_response.py +116 -0
- mailermine_generated/models/bulk_restore_contacts200_response_data.py +101 -0
- mailermine_generated/models/bulk_tag_contacts_request.py +105 -0
- mailermine_generated/models/bulk_update_contacts200_response.py +116 -0
- mailermine_generated/models/bulk_update_contacts200_response_data.py +101 -0
- mailermine_generated/models/bulk_update_contacts_request.py +112 -0
- mailermine_generated/models/campaign_activity.py +122 -0
- mailermine_generated/models/campaign_activity_collection.py +113 -0
- mailermine_generated/models/campaign_activity_event.py +43 -0
- mailermine_generated/models/campaign_activity_payload.py +145 -0
- mailermine_generated/models/campaign_analytics.py +144 -0
- mailermine_generated/models/campaign_analytics_response.py +115 -0
- mailermine_generated/models/campaign_collection.py +119 -0
- mailermine_generated/models/campaign_event.py +139 -0
- mailermine_generated/models/campaign_events_response.py +109 -0
- mailermine_generated/models/campaign_link.py +114 -0
- mailermine_generated/models/campaign_links_response.py +113 -0
- mailermine_generated/models/campaign_preview.py +117 -0
- mailermine_generated/models/campaign_preview_response.py +109 -0
- mailermine_generated/models/campaign_recipient.py +161 -0
- mailermine_generated/models/campaign_recipient_collection.py +119 -0
- mailermine_generated/models/campaign_recipient_preview.py +111 -0
- mailermine_generated/models/campaign_recipient_preview_response.py +109 -0
- mailermine_generated/models/campaign_recipient_status.py +41 -0
- mailermine_generated/models/campaign_resource.py +280 -0
- mailermine_generated/models/campaign_response.py +109 -0
- mailermine_generated/models/campaign_statistics.py +172 -0
- mailermine_generated/models/campaign_statistics_response.py +109 -0
- mailermine_generated/models/campaign_status.py +44 -0
- mailermine_generated/models/campaign_timeline.py +116 -0
- mailermine_generated/models/campaign_timeline_response.py +113 -0
- mailermine_generated/models/campaign_validation.py +105 -0
- mailermine_generated/models/campaign_validation_response.py +109 -0
- mailermine_generated/models/configure_contact_import_request.py +187 -0
- mailermine_generated/models/contact_collection.py +119 -0
- mailermine_generated/models/contact_resource.py +152 -0
- mailermine_generated/models/contact_response.py +109 -0
- mailermine_generated/models/create_api_key_request.py +136 -0
- mailermine_generated/models/create_campaign_request.py +183 -0
- mailermine_generated/models/create_contact_request.py +180 -0
- mailermine_generated/models/create_custom_field_request.py +152 -0
- mailermine_generated/models/create_domain_request.py +112 -0
- mailermine_generated/models/create_list_request.py +116 -0
- mailermine_generated/models/create_project_request.py +166 -0
- mailermine_generated/models/create_segment_request.py +115 -0
- mailermine_generated/models/create_segment_request_rules.py +118 -0
- mailermine_generated/models/create_suppression_request.py +112 -0
- mailermine_generated/models/create_tag_request.py +109 -0
- mailermine_generated/models/create_template_request.py +179 -0
- mailermine_generated/models/create_template_request_branding.py +312 -0
- mailermine_generated/models/create_template_request_variables_inner.py +124 -0
- mailermine_generated/models/create_webhook_request.py +116 -0
- mailermine_generated/models/custom_field.py +148 -0
- mailermine_generated/models/custom_field_collection.py +119 -0
- mailermine_generated/models/custom_field_response.py +109 -0
- mailermine_generated/models/custom_field_type.py +47 -0
- mailermine_generated/models/delete_response.py +114 -0
- mailermine_generated/models/delivery_log.py +175 -0
- mailermine_generated/models/dns_record.py +129 -0
- mailermine_generated/models/domain_list_response.py +119 -0
- mailermine_generated/models/domain_resource.py +212 -0
- mailermine_generated/models/domain_response.py +109 -0
- mailermine_generated/models/duplicate_campaign_request.py +101 -0
- mailermine_generated/models/duplicate_template_request.py +107 -0
- mailermine_generated/models/email_attachment.py +115 -0
- mailermine_generated/models/event_list_response.py +119 -0
- mailermine_generated/models/event_response.py +109 -0
- mailermine_generated/models/export_contacts_request.py +143 -0
- mailermine_generated/models/export_job.py +139 -0
- mailermine_generated/models/export_job_response.py +109 -0
- mailermine_generated/models/import_job.py +159 -0
- mailermine_generated/models/import_job_collection.py +113 -0
- mailermine_generated/models/import_job_detail.py +165 -0
- mailermine_generated/models/import_job_detail_response.py +109 -0
- mailermine_generated/models/import_job_response.py +109 -0
- mailermine_generated/models/import_job_summary.py +144 -0
- mailermine_generated/models/import_progress.py +169 -0
- mailermine_generated/models/inline_object.py +111 -0
- mailermine_generated/models/inline_object1.py +105 -0
- mailermine_generated/models/list_collection.py +119 -0
- mailermine_generated/models/list_contacts_membership_request.py +103 -0
- mailermine_generated/models/list_resource.py +128 -0
- mailermine_generated/models/list_response.py +109 -0
- mailermine_generated/models/message.py +201 -0
- mailermine_generated/models/message_detail_response.py +109 -0
- mailermine_generated/models/message_events_response.py +109 -0
- mailermine_generated/models/message_list_response.py +119 -0
- mailermine_generated/models/message_status.py +44 -0
- mailermine_generated/models/pagination_meta.py +107 -0
- mailermine_generated/models/preview_segment_request.py +105 -0
- mailermine_generated/models/preview_segment_request_rules.py +118 -0
- mailermine_generated/models/preview_segment_request_rules_rules_inner.py +110 -0
- mailermine_generated/models/preview_template_by_id_request.py +108 -0
- mailermine_generated/models/preview_template_request.py +105 -0
- mailermine_generated/models/project_list_response.py +119 -0
- mailermine_generated/models/project_resource.py +151 -0
- mailermine_generated/models/project_response.py +109 -0
- mailermine_generated/models/remove_audience_members200_response.py +116 -0
- mailermine_generated/models/remove_audience_members200_response_data.py +101 -0
- mailermine_generated/models/remove_contacts_from_list200_response.py +116 -0
- mailermine_generated/models/replay_webhook_request.py +132 -0
- mailermine_generated/models/schedule_campaign_request.py +112 -0
- mailermine_generated/models/segment_collection.py +119 -0
- mailermine_generated/models/segment_count_response.py +109 -0
- mailermine_generated/models/segment_count_response_data.py +103 -0
- mailermine_generated/models/segment_preview_response.py +109 -0
- mailermine_generated/models/segment_preview_response_data.py +111 -0
- mailermine_generated/models/segment_resource.py +132 -0
- mailermine_generated/models/segment_response.py +109 -0
- mailermine_generated/models/send_email_request.py +147 -0
- mailermine_generated/models/send_email_request_attachments_inner.py +111 -0
- mailermine_generated/models/send_email_request_variables.py +139 -0
- mailermine_generated/models/send_email_response.py +109 -0
- mailermine_generated/models/suppression.py +149 -0
- mailermine_generated/models/suppression_list_response.py +119 -0
- mailermine_generated/models/suppression_reason.py +39 -0
- mailermine_generated/models/suppression_response.py +109 -0
- mailermine_generated/models/tag_collection.py +119 -0
- mailermine_generated/models/tag_resource.py +121 -0
- mailermine_generated/models/tag_response.py +109 -0
- mailermine_generated/models/template_layout_style.py +38 -0
- mailermine_generated/models/template_list_response.py +119 -0
- mailermine_generated/models/template_preview.py +115 -0
- mailermine_generated/models/template_preview_response.py +114 -0
- mailermine_generated/models/template_resource.py +225 -0
- mailermine_generated/models/template_response.py +109 -0
- mailermine_generated/models/template_status.py +38 -0
- mailermine_generated/models/template_test_response.py +109 -0
- mailermine_generated/models/template_test_response_data.py +103 -0
- mailermine_generated/models/template_variable.py +112 -0
- mailermine_generated/models/template_variable_type.py +39 -0
- mailermine_generated/models/test_template_request.py +117 -0
- mailermine_generated/models/test_webhook_request.py +116 -0
- mailermine_generated/models/timeline_event.py +161 -0
- mailermine_generated/models/update_api_key_request.py +148 -0
- mailermine_generated/models/update_campaign_request.py +171 -0
- mailermine_generated/models/update_contact_request.py +163 -0
- mailermine_generated/models/update_custom_field_request.py +132 -0
- mailermine_generated/models/update_list_request.py +116 -0
- mailermine_generated/models/update_project_request.py +178 -0
- mailermine_generated/models/update_segment_request.py +115 -0
- mailermine_generated/models/update_segment_request_rules.py +118 -0
- mailermine_generated/models/update_tag_request.py +109 -0
- mailermine_generated/models/update_template_request.py +174 -0
- mailermine_generated/models/update_webhook_request.py +119 -0
- mailermine_generated/models/webhook.py +143 -0
- mailermine_generated/models/webhook_delivery.py +182 -0
- mailermine_generated/models/webhook_delivery_list_response.py +119 -0
- mailermine_generated/models/webhook_delivery_message.py +105 -0
- mailermine_generated/models/webhook_delivery_response.py +109 -0
- mailermine_generated/models/webhook_delivery_status.py +38 -0
- mailermine_generated/models/webhook_delivery_webhook.py +105 -0
- mailermine_generated/models/webhook_last_delivery.py +112 -0
- mailermine_generated/models/webhook_list_response.py +119 -0
- mailermine_generated/models/webhook_project.py +103 -0
- mailermine_generated/models/webhook_replay_response.py +109 -0
- mailermine_generated/models/webhook_replay_response_data.py +101 -0
- mailermine_generated/models/webhook_response.py +109 -0
- mailermine_generated/models/webhook_retry_policy.py +103 -0
- mailermine_generated/models/webhook_secret_response.py +109 -0
- mailermine_generated/models/webhook_with_secret.py +145 -0
- mailermine_generated/py.typed +0 -0
- mailermine_generated/rest.py +263 -0
mailermine/__init__.py
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
"""Official MailerMine SDK for Python.
|
|
2
|
+
|
|
3
|
+
Install from PyPI with ``pip install mailermine``, then:
|
|
4
|
+
|
|
5
|
+
.. code-block:: python
|
|
6
|
+
|
|
7
|
+
from mailermine import MailerMine
|
|
8
|
+
|
|
9
|
+
client = MailerMine(api_key="relay_live_xxx")
|
|
10
|
+
client.emails.send(
|
|
11
|
+
from_="hello@example.com",
|
|
12
|
+
to="user@example.com",
|
|
13
|
+
subject="Welcome",
|
|
14
|
+
html="<p>Hello</p>",
|
|
15
|
+
)
|
|
16
|
+
|
|
17
|
+
Application code must never import ``mailermine_generated``.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
from __future__ import annotations
|
|
21
|
+
|
|
22
|
+
from mailermine.client import MailerMine
|
|
23
|
+
from mailermine.config import Configuration
|
|
24
|
+
from mailermine.constants import (
|
|
25
|
+
DEFAULT_BASE_URL,
|
|
26
|
+
DEFAULT_TIMEOUT,
|
|
27
|
+
DEFAULT_USER_AGENT,
|
|
28
|
+
VERSION,
|
|
29
|
+
)
|
|
30
|
+
from mailermine.exceptions import (
|
|
31
|
+
ApiError,
|
|
32
|
+
AuthenticationError,
|
|
33
|
+
MailerMineError,
|
|
34
|
+
NotFoundError,
|
|
35
|
+
PlanError,
|
|
36
|
+
RateLimitError,
|
|
37
|
+
ValidationError,
|
|
38
|
+
)
|
|
39
|
+
from mailermine.resources import (
|
|
40
|
+
Analytics,
|
|
41
|
+
ApiKeys,
|
|
42
|
+
Audiences,
|
|
43
|
+
Campaigns,
|
|
44
|
+
Contacts,
|
|
45
|
+
Domains,
|
|
46
|
+
Emails,
|
|
47
|
+
Events,
|
|
48
|
+
Exports,
|
|
49
|
+
Imports,
|
|
50
|
+
Lists,
|
|
51
|
+
Messages,
|
|
52
|
+
Projects,
|
|
53
|
+
Segments,
|
|
54
|
+
Suppressions,
|
|
55
|
+
Tags,
|
|
56
|
+
Templates,
|
|
57
|
+
Webhooks,
|
|
58
|
+
)
|
|
59
|
+
from mailermine.support import Collection, Pagination, Response
|
|
60
|
+
from mailermine.types import JsonObject, JsonPrimitive, JsonValue
|
|
61
|
+
|
|
62
|
+
__all__ = [
|
|
63
|
+
"DEFAULT_BASE_URL",
|
|
64
|
+
"DEFAULT_TIMEOUT",
|
|
65
|
+
"DEFAULT_USER_AGENT",
|
|
66
|
+
"VERSION",
|
|
67
|
+
"Analytics",
|
|
68
|
+
"ApiError",
|
|
69
|
+
"ApiKeys",
|
|
70
|
+
"Audiences",
|
|
71
|
+
"AuthenticationError",
|
|
72
|
+
"Campaigns",
|
|
73
|
+
"Collection",
|
|
74
|
+
"Configuration",
|
|
75
|
+
"Contacts",
|
|
76
|
+
"Domains",
|
|
77
|
+
"Emails",
|
|
78
|
+
"Events",
|
|
79
|
+
"Exports",
|
|
80
|
+
"Imports",
|
|
81
|
+
"JsonObject",
|
|
82
|
+
"JsonPrimitive",
|
|
83
|
+
"JsonValue",
|
|
84
|
+
"Lists",
|
|
85
|
+
"MailerMine",
|
|
86
|
+
"MailerMineError",
|
|
87
|
+
"Messages",
|
|
88
|
+
"NotFoundError",
|
|
89
|
+
"Pagination",
|
|
90
|
+
"PlanError",
|
|
91
|
+
"Projects",
|
|
92
|
+
"RateLimitError",
|
|
93
|
+
"Response",
|
|
94
|
+
"Segments",
|
|
95
|
+
"Suppressions",
|
|
96
|
+
"Tags",
|
|
97
|
+
"Templates",
|
|
98
|
+
"ValidationError",
|
|
99
|
+
"Webhooks",
|
|
100
|
+
]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Internal package — not part of the public API."""
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
"""Internal factory that builds generated OpenAPI API clients.
|
|
2
|
+
|
|
3
|
+
This module is private. Application code must never import it.
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
from __future__ import annotations
|
|
7
|
+
|
|
8
|
+
from dataclasses import dataclass
|
|
9
|
+
|
|
10
|
+
from mailermine_generated import (
|
|
11
|
+
AnalyticsApi,
|
|
12
|
+
ApiClient,
|
|
13
|
+
APIKeysApi,
|
|
14
|
+
AudiencesApi,
|
|
15
|
+
CampaignAnalyticsApi,
|
|
16
|
+
CampaignEventsApi,
|
|
17
|
+
CampaignLifecycleApi,
|
|
18
|
+
CampaignsApi,
|
|
19
|
+
ContactsApi,
|
|
20
|
+
DomainsApi,
|
|
21
|
+
EmailsApi,
|
|
22
|
+
EventsApi,
|
|
23
|
+
ExportsApi,
|
|
24
|
+
ImportsApi,
|
|
25
|
+
ListsApi,
|
|
26
|
+
MessagesApi,
|
|
27
|
+
ProjectsApi,
|
|
28
|
+
SegmentsApi,
|
|
29
|
+
SuppressionsApi,
|
|
30
|
+
TagsApi,
|
|
31
|
+
TemplatesApi,
|
|
32
|
+
WebhooksApi,
|
|
33
|
+
)
|
|
34
|
+
from mailermine_generated import (
|
|
35
|
+
Configuration as GeneratedConfiguration,
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
from mailermine.config import Configuration
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
@dataclass(frozen=True, slots=True)
|
|
42
|
+
class GeneratedApis:
|
|
43
|
+
"""Bundle of generated API clients sharing one ``ApiClient``."""
|
|
44
|
+
|
|
45
|
+
api_client: ApiClient
|
|
46
|
+
emails: EmailsApi
|
|
47
|
+
messages: MessagesApi
|
|
48
|
+
projects: ProjectsApi
|
|
49
|
+
api_keys: APIKeysApi
|
|
50
|
+
domains: DomainsApi
|
|
51
|
+
templates: TemplatesApi
|
|
52
|
+
contacts: ContactsApi
|
|
53
|
+
lists: ListsApi
|
|
54
|
+
segments: SegmentsApi
|
|
55
|
+
tags: TagsApi
|
|
56
|
+
audiences: AudiencesApi
|
|
57
|
+
campaigns: CampaignsApi
|
|
58
|
+
campaign_lifecycle: CampaignLifecycleApi
|
|
59
|
+
campaign_analytics: CampaignAnalyticsApi
|
|
60
|
+
campaign_events: CampaignEventsApi
|
|
61
|
+
analytics: AnalyticsApi
|
|
62
|
+
events: EventsApi
|
|
63
|
+
webhooks: WebhooksApi
|
|
64
|
+
suppressions: SuppressionsApi
|
|
65
|
+
imports: ImportsApi
|
|
66
|
+
exports: ExportsApi
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def create_generated_apis(configuration: Configuration) -> GeneratedApis:
|
|
70
|
+
"""Create the generated transport layer from public configuration.
|
|
71
|
+
|
|
72
|
+
Parameters
|
|
73
|
+
----------
|
|
74
|
+
configuration:
|
|
75
|
+
Validated SDK configuration.
|
|
76
|
+
|
|
77
|
+
Returns
|
|
78
|
+
-------
|
|
79
|
+
GeneratedApis
|
|
80
|
+
Shared generated client bundle.
|
|
81
|
+
"""
|
|
82
|
+
generated = GeneratedConfiguration(host=configuration.base_url)
|
|
83
|
+
generated.access_token = configuration.api_key
|
|
84
|
+
|
|
85
|
+
api_client = ApiClient(configuration=generated)
|
|
86
|
+
api_client.user_agent = configuration.user_agent
|
|
87
|
+
|
|
88
|
+
return GeneratedApis(
|
|
89
|
+
api_client=api_client,
|
|
90
|
+
emails=EmailsApi(api_client),
|
|
91
|
+
messages=MessagesApi(api_client),
|
|
92
|
+
projects=ProjectsApi(api_client),
|
|
93
|
+
api_keys=APIKeysApi(api_client),
|
|
94
|
+
domains=DomainsApi(api_client),
|
|
95
|
+
templates=TemplatesApi(api_client),
|
|
96
|
+
contacts=ContactsApi(api_client),
|
|
97
|
+
lists=ListsApi(api_client),
|
|
98
|
+
segments=SegmentsApi(api_client),
|
|
99
|
+
tags=TagsApi(api_client),
|
|
100
|
+
audiences=AudiencesApi(api_client),
|
|
101
|
+
campaigns=CampaignsApi(api_client),
|
|
102
|
+
campaign_lifecycle=CampaignLifecycleApi(api_client),
|
|
103
|
+
campaign_analytics=CampaignAnalyticsApi(api_client),
|
|
104
|
+
campaign_events=CampaignEventsApi(api_client),
|
|
105
|
+
analytics=AnalyticsApi(api_client),
|
|
106
|
+
events=EventsApi(api_client),
|
|
107
|
+
webhooks=WebhooksApi(api_client),
|
|
108
|
+
suppressions=SuppressionsApi(api_client),
|
|
109
|
+
imports=ImportsApi(api_client),
|
|
110
|
+
exports=ExportsApi(api_client),
|
|
111
|
+
)
|
mailermine/client.py
ADDED
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
"""Root MailerMine client."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from collections.abc import Mapping
|
|
6
|
+
|
|
7
|
+
from mailermine._internal.apis import GeneratedApis, create_generated_apis
|
|
8
|
+
from mailermine.config import Configuration
|
|
9
|
+
from mailermine.resources.analytics import Analytics
|
|
10
|
+
from mailermine.resources.api_keys import ApiKeys
|
|
11
|
+
from mailermine.resources.audiences import Audiences
|
|
12
|
+
from mailermine.resources.campaigns import Campaigns
|
|
13
|
+
from mailermine.resources.contacts import Contacts
|
|
14
|
+
from mailermine.resources.domains import Domains
|
|
15
|
+
from mailermine.resources.emails import Emails
|
|
16
|
+
from mailermine.resources.events import Events
|
|
17
|
+
from mailermine.resources.exports import Exports
|
|
18
|
+
from mailermine.resources.imports import Imports
|
|
19
|
+
from mailermine.resources.lists import Lists
|
|
20
|
+
from mailermine.resources.messages import Messages
|
|
21
|
+
from mailermine.resources.projects import Projects
|
|
22
|
+
from mailermine.resources.segments import Segments
|
|
23
|
+
from mailermine.resources.suppressions import Suppressions
|
|
24
|
+
from mailermine.resources.tags import Tags
|
|
25
|
+
from mailermine.resources.templates import Templates
|
|
26
|
+
from mailermine.resources.webhooks import Webhooks
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
class MailerMine:
|
|
30
|
+
"""Official MailerMine Python SDK client.
|
|
31
|
+
|
|
32
|
+
Parameters
|
|
33
|
+
----------
|
|
34
|
+
api_key:
|
|
35
|
+
Bearer API key, or omit to use ``MAILERMINE_API_KEY``.
|
|
36
|
+
base_url:
|
|
37
|
+
Optional API base URL override.
|
|
38
|
+
timeout:
|
|
39
|
+
Optional request timeout in seconds.
|
|
40
|
+
user_agent:
|
|
41
|
+
Optional User-Agent override.
|
|
42
|
+
configuration:
|
|
43
|
+
Optional pre-built :class:`~mailermine.config.Configuration`.
|
|
44
|
+
|
|
45
|
+
Examples
|
|
46
|
+
--------
|
|
47
|
+
>>> from mailermine import MailerMine
|
|
48
|
+
>>> client = MailerMine(api_key="relay_live_xxx")
|
|
49
|
+
>>> client.emails.send(
|
|
50
|
+
... from_="hello@example.com",
|
|
51
|
+
... to="user@example.com",
|
|
52
|
+
... subject="Hi",
|
|
53
|
+
... html="<p>Hi</p>",
|
|
54
|
+
... )
|
|
55
|
+
"""
|
|
56
|
+
|
|
57
|
+
def __init__(
|
|
58
|
+
self,
|
|
59
|
+
api_key: str | Configuration | Mapping[str, object] | None = None,
|
|
60
|
+
*,
|
|
61
|
+
base_url: str | None = None,
|
|
62
|
+
timeout: float | None = None,
|
|
63
|
+
user_agent: str | None = None,
|
|
64
|
+
configuration: Configuration | None = None,
|
|
65
|
+
) -> None:
|
|
66
|
+
if configuration is not None:
|
|
67
|
+
self._configuration = configuration
|
|
68
|
+
elif isinstance(api_key, Configuration):
|
|
69
|
+
self._configuration = api_key
|
|
70
|
+
elif isinstance(api_key, Mapping):
|
|
71
|
+
self._configuration = Configuration.from_mapping(api_key)
|
|
72
|
+
elif isinstance(api_key, str) or api_key is None:
|
|
73
|
+
self._configuration = Configuration.create(
|
|
74
|
+
api_key=api_key,
|
|
75
|
+
base_url=base_url,
|
|
76
|
+
timeout=timeout,
|
|
77
|
+
user_agent=user_agent,
|
|
78
|
+
)
|
|
79
|
+
else:
|
|
80
|
+
raise TypeError(
|
|
81
|
+
"MailerMine expects an api_key string, Configuration, mapping, or keyword options."
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
self._apis: GeneratedApis = create_generated_apis(self._configuration)
|
|
85
|
+
|
|
86
|
+
self._emails: Emails | None = None
|
|
87
|
+
self._projects: Projects | None = None
|
|
88
|
+
self._api_keys: ApiKeys | None = None
|
|
89
|
+
self._domains: Domains | None = None
|
|
90
|
+
self._templates: Templates | None = None
|
|
91
|
+
self._contacts: Contacts | None = None
|
|
92
|
+
self._lists: Lists | None = None
|
|
93
|
+
self._segments: Segments | None = None
|
|
94
|
+
self._tags: Tags | None = None
|
|
95
|
+
self._audiences: Audiences | None = None
|
|
96
|
+
self._campaigns: Campaigns | None = None
|
|
97
|
+
self._analytics: Analytics | None = None
|
|
98
|
+
self._events: Events | None = None
|
|
99
|
+
self._messages: Messages | None = None
|
|
100
|
+
self._webhooks: Webhooks | None = None
|
|
101
|
+
self._suppressions: Suppressions | None = None
|
|
102
|
+
self._imports: Imports | None = None
|
|
103
|
+
self._exports: Exports | None = None
|
|
104
|
+
|
|
105
|
+
@property
|
|
106
|
+
def configuration(self) -> Configuration:
|
|
107
|
+
"""Resolved SDK configuration."""
|
|
108
|
+
return self._configuration
|
|
109
|
+
|
|
110
|
+
@property
|
|
111
|
+
def emails(self) -> Emails:
|
|
112
|
+
"""Transactional email operations."""
|
|
113
|
+
if self._emails is None:
|
|
114
|
+
self._emails = Emails(
|
|
115
|
+
self._apis.emails,
|
|
116
|
+
self._apis.messages,
|
|
117
|
+
timeout=self._configuration.timeout,
|
|
118
|
+
)
|
|
119
|
+
return self._emails
|
|
120
|
+
|
|
121
|
+
@property
|
|
122
|
+
def projects(self) -> Projects:
|
|
123
|
+
"""Workspace project operations."""
|
|
124
|
+
if self._projects is None:
|
|
125
|
+
self._projects = Projects(
|
|
126
|
+
self._apis.projects,
|
|
127
|
+
timeout=self._configuration.timeout,
|
|
128
|
+
)
|
|
129
|
+
return self._projects
|
|
130
|
+
|
|
131
|
+
@property
|
|
132
|
+
def api_keys(self) -> ApiKeys:
|
|
133
|
+
"""Project API key operations."""
|
|
134
|
+
if self._api_keys is None:
|
|
135
|
+
self._api_keys = ApiKeys(
|
|
136
|
+
self._apis.api_keys,
|
|
137
|
+
timeout=self._configuration.timeout,
|
|
138
|
+
)
|
|
139
|
+
return self._api_keys
|
|
140
|
+
|
|
141
|
+
@property
|
|
142
|
+
def domains(self) -> Domains:
|
|
143
|
+
"""Sending domain operations."""
|
|
144
|
+
if self._domains is None:
|
|
145
|
+
self._domains = Domains(
|
|
146
|
+
self._apis.domains,
|
|
147
|
+
timeout=self._configuration.timeout,
|
|
148
|
+
)
|
|
149
|
+
return self._domains
|
|
150
|
+
|
|
151
|
+
@property
|
|
152
|
+
def templates(self) -> Templates:
|
|
153
|
+
"""Email template operations."""
|
|
154
|
+
if self._templates is None:
|
|
155
|
+
self._templates = Templates(
|
|
156
|
+
self._apis.templates,
|
|
157
|
+
timeout=self._configuration.timeout,
|
|
158
|
+
)
|
|
159
|
+
return self._templates
|
|
160
|
+
|
|
161
|
+
@property
|
|
162
|
+
def contacts(self) -> Contacts:
|
|
163
|
+
"""Contact operations."""
|
|
164
|
+
if self._contacts is None:
|
|
165
|
+
self._contacts = Contacts(
|
|
166
|
+
self._apis.contacts,
|
|
167
|
+
timeout=self._configuration.timeout,
|
|
168
|
+
)
|
|
169
|
+
return self._contacts
|
|
170
|
+
|
|
171
|
+
@property
|
|
172
|
+
def lists(self) -> Lists:
|
|
173
|
+
"""Static mailing list operations."""
|
|
174
|
+
if self._lists is None:
|
|
175
|
+
self._lists = Lists(
|
|
176
|
+
self._apis.lists,
|
|
177
|
+
timeout=self._configuration.timeout,
|
|
178
|
+
)
|
|
179
|
+
return self._lists
|
|
180
|
+
|
|
181
|
+
@property
|
|
182
|
+
def segments(self) -> Segments:
|
|
183
|
+
"""Dynamic segment operations."""
|
|
184
|
+
if self._segments is None:
|
|
185
|
+
self._segments = Segments(
|
|
186
|
+
self._apis.segments,
|
|
187
|
+
timeout=self._configuration.timeout,
|
|
188
|
+
)
|
|
189
|
+
return self._segments
|
|
190
|
+
|
|
191
|
+
@property
|
|
192
|
+
def tags(self) -> Tags:
|
|
193
|
+
"""Contact tag operations."""
|
|
194
|
+
if self._tags is None:
|
|
195
|
+
self._tags = Tags(
|
|
196
|
+
self._apis.tags,
|
|
197
|
+
timeout=self._configuration.timeout,
|
|
198
|
+
)
|
|
199
|
+
return self._tags
|
|
200
|
+
|
|
201
|
+
@property
|
|
202
|
+
def audiences(self) -> Audiences:
|
|
203
|
+
"""Unified audience catalog (lists and segments)."""
|
|
204
|
+
if self._audiences is None:
|
|
205
|
+
self._audiences = Audiences(
|
|
206
|
+
self._apis.audiences,
|
|
207
|
+
self.lists,
|
|
208
|
+
self.segments,
|
|
209
|
+
self.contacts,
|
|
210
|
+
timeout=self._configuration.timeout,
|
|
211
|
+
)
|
|
212
|
+
return self._audiences
|
|
213
|
+
|
|
214
|
+
@property
|
|
215
|
+
def campaigns(self) -> Campaigns:
|
|
216
|
+
"""Marketing campaign operations."""
|
|
217
|
+
if self._campaigns is None:
|
|
218
|
+
self._campaigns = Campaigns(
|
|
219
|
+
self._apis.campaigns,
|
|
220
|
+
self._apis.campaign_lifecycle,
|
|
221
|
+
self._apis.campaign_analytics,
|
|
222
|
+
self._apis.campaign_events,
|
|
223
|
+
timeout=self._configuration.timeout,
|
|
224
|
+
)
|
|
225
|
+
return self._campaigns
|
|
226
|
+
|
|
227
|
+
@property
|
|
228
|
+
def analytics(self) -> Analytics:
|
|
229
|
+
"""Account-wide delivery and engagement analytics."""
|
|
230
|
+
if self._analytics is None:
|
|
231
|
+
self._analytics = Analytics(
|
|
232
|
+
self._apis.analytics,
|
|
233
|
+
self.campaigns,
|
|
234
|
+
self.events,
|
|
235
|
+
timeout=self._configuration.timeout,
|
|
236
|
+
)
|
|
237
|
+
return self._analytics
|
|
238
|
+
|
|
239
|
+
@property
|
|
240
|
+
def events(self) -> Events:
|
|
241
|
+
"""Global message and delivery lifecycle events."""
|
|
242
|
+
if self._events is None:
|
|
243
|
+
self._events = Events(
|
|
244
|
+
self._apis.events,
|
|
245
|
+
self._apis.messages,
|
|
246
|
+
timeout=self._configuration.timeout,
|
|
247
|
+
)
|
|
248
|
+
return self._events
|
|
249
|
+
|
|
250
|
+
@property
|
|
251
|
+
def messages(self) -> Messages:
|
|
252
|
+
"""Delivery logs and outbound message history."""
|
|
253
|
+
if self._messages is None:
|
|
254
|
+
self._messages = Messages(
|
|
255
|
+
self._apis.messages,
|
|
256
|
+
timeout=self._configuration.timeout,
|
|
257
|
+
)
|
|
258
|
+
return self._messages
|
|
259
|
+
|
|
260
|
+
@property
|
|
261
|
+
def webhooks(self) -> Webhooks:
|
|
262
|
+
"""Webhook endpoint and delivery operations."""
|
|
263
|
+
if self._webhooks is None:
|
|
264
|
+
self._webhooks = Webhooks(
|
|
265
|
+
self._apis.webhooks,
|
|
266
|
+
timeout=self._configuration.timeout,
|
|
267
|
+
)
|
|
268
|
+
return self._webhooks
|
|
269
|
+
|
|
270
|
+
@property
|
|
271
|
+
def suppressions(self) -> Suppressions:
|
|
272
|
+
"""Account suppression-list operations."""
|
|
273
|
+
if self._suppressions is None:
|
|
274
|
+
self._suppressions = Suppressions(
|
|
275
|
+
self._apis.suppressions,
|
|
276
|
+
timeout=self._configuration.timeout,
|
|
277
|
+
)
|
|
278
|
+
return self._suppressions
|
|
279
|
+
|
|
280
|
+
@property
|
|
281
|
+
def imports(self) -> Imports:
|
|
282
|
+
"""Contact import job operations."""
|
|
283
|
+
if self._imports is None:
|
|
284
|
+
self._imports = Imports(
|
|
285
|
+
self._apis.imports,
|
|
286
|
+
timeout=self._configuration.timeout,
|
|
287
|
+
)
|
|
288
|
+
return self._imports
|
|
289
|
+
|
|
290
|
+
@property
|
|
291
|
+
def exports(self) -> Exports:
|
|
292
|
+
"""Contact export job operations."""
|
|
293
|
+
if self._exports is None:
|
|
294
|
+
self._exports = Exports(
|
|
295
|
+
self._apis.exports,
|
|
296
|
+
timeout=self._configuration.timeout,
|
|
297
|
+
)
|
|
298
|
+
return self._exports
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
"""Immutable SDK configuration."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
from collections.abc import Mapping
|
|
7
|
+
from dataclasses import dataclass
|
|
8
|
+
from urllib.parse import urlparse
|
|
9
|
+
|
|
10
|
+
from mailermine.constants import (
|
|
11
|
+
DEFAULT_BASE_URL,
|
|
12
|
+
DEFAULT_TIMEOUT,
|
|
13
|
+
DEFAULT_USER_AGENT,
|
|
14
|
+
)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
@dataclass(frozen=True, slots=True)
|
|
18
|
+
class Configuration:
|
|
19
|
+
"""Validated, immutable MailerMine client configuration.
|
|
20
|
+
|
|
21
|
+
Parameters
|
|
22
|
+
----------
|
|
23
|
+
api_key:
|
|
24
|
+
Bearer API key. Required unless provided via ``MAILERMINE_API_KEY``.
|
|
25
|
+
base_url:
|
|
26
|
+
API base URL. Defaults to production.
|
|
27
|
+
timeout:
|
|
28
|
+
Request timeout in seconds.
|
|
29
|
+
user_agent:
|
|
30
|
+
``User-Agent`` header value.
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
api_key: str
|
|
34
|
+
base_url: str = DEFAULT_BASE_URL
|
|
35
|
+
timeout: float = DEFAULT_TIMEOUT
|
|
36
|
+
user_agent: str = DEFAULT_USER_AGENT
|
|
37
|
+
|
|
38
|
+
def __post_init__(self) -> None:
|
|
39
|
+
object.__setattr__(self, "api_key", _normalize_api_key(self.api_key))
|
|
40
|
+
object.__setattr__(self, "base_url", _normalize_base_url(self.base_url))
|
|
41
|
+
object.__setattr__(self, "timeout", _normalize_timeout(self.timeout))
|
|
42
|
+
object.__setattr__(self, "user_agent", _normalize_user_agent(self.user_agent))
|
|
43
|
+
|
|
44
|
+
@classmethod
|
|
45
|
+
def create(
|
|
46
|
+
cls,
|
|
47
|
+
api_key: str | None = None,
|
|
48
|
+
*,
|
|
49
|
+
base_url: str | None = None,
|
|
50
|
+
timeout: float | None = None,
|
|
51
|
+
user_agent: str | None = None,
|
|
52
|
+
) -> Configuration:
|
|
53
|
+
"""Build configuration from explicit values and environment variables.
|
|
54
|
+
|
|
55
|
+
Environment variables
|
|
56
|
+
---------------------
|
|
57
|
+
``MAILERMINE_API_KEY``
|
|
58
|
+
Used when ``api_key`` is omitted.
|
|
59
|
+
``MAILERMINE_BASE_URL``
|
|
60
|
+
Used when ``base_url`` is omitted.
|
|
61
|
+
``MAILERMINE_TIMEOUT``
|
|
62
|
+
Used when ``timeout`` is omitted (seconds).
|
|
63
|
+
|
|
64
|
+
Parameters
|
|
65
|
+
----------
|
|
66
|
+
api_key:
|
|
67
|
+
Bearer API key.
|
|
68
|
+
base_url:
|
|
69
|
+
Optional API base URL override.
|
|
70
|
+
timeout:
|
|
71
|
+
Optional timeout override in seconds.
|
|
72
|
+
user_agent:
|
|
73
|
+
Optional User-Agent override.
|
|
74
|
+
|
|
75
|
+
Returns
|
|
76
|
+
-------
|
|
77
|
+
Configuration
|
|
78
|
+
Validated configuration instance.
|
|
79
|
+
|
|
80
|
+
Raises
|
|
81
|
+
------
|
|
82
|
+
ValueError
|
|
83
|
+
If the API key is missing or any option is invalid.
|
|
84
|
+
"""
|
|
85
|
+
resolved_api_key = api_key if api_key is not None else os.environ.get("MAILERMINE_API_KEY")
|
|
86
|
+
if base_url is not None:
|
|
87
|
+
resolved_base_url = base_url
|
|
88
|
+
else:
|
|
89
|
+
resolved_base_url = os.environ.get("MAILERMINE_BASE_URL", DEFAULT_BASE_URL)
|
|
90
|
+
if timeout is not None:
|
|
91
|
+
resolved_timeout = timeout
|
|
92
|
+
elif "MAILERMINE_TIMEOUT" in os.environ:
|
|
93
|
+
resolved_timeout = float(os.environ["MAILERMINE_TIMEOUT"])
|
|
94
|
+
else:
|
|
95
|
+
resolved_timeout = DEFAULT_TIMEOUT
|
|
96
|
+
|
|
97
|
+
if resolved_api_key is None or str(resolved_api_key).strip() == "":
|
|
98
|
+
raise ValueError(
|
|
99
|
+
"MailerMine requires an api_key argument or "
|
|
100
|
+
"MAILERMINE_API_KEY environment variable."
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
return cls(
|
|
104
|
+
api_key=str(resolved_api_key),
|
|
105
|
+
base_url=str(resolved_base_url),
|
|
106
|
+
timeout=float(resolved_timeout),
|
|
107
|
+
user_agent=user_agent if user_agent is not None else DEFAULT_USER_AGENT,
|
|
108
|
+
)
|
|
109
|
+
|
|
110
|
+
@classmethod
|
|
111
|
+
def from_mapping(cls, values: Mapping[str, object]) -> Configuration:
|
|
112
|
+
"""Create configuration from a mapping of options.
|
|
113
|
+
|
|
114
|
+
Parameters
|
|
115
|
+
----------
|
|
116
|
+
values:
|
|
117
|
+
Mapping that may include ``api_key`` / ``apiKey``, ``base_url`` /
|
|
118
|
+
``baseUrl``, ``timeout``, and ``user_agent`` / ``userAgent``.
|
|
119
|
+
|
|
120
|
+
Returns
|
|
121
|
+
-------
|
|
122
|
+
Configuration
|
|
123
|
+
Validated configuration.
|
|
124
|
+
"""
|
|
125
|
+
api_key = values.get("api_key", values.get("apiKey"))
|
|
126
|
+
base_url = values.get("base_url", values.get("baseUrl"))
|
|
127
|
+
timeout = values.get("timeout")
|
|
128
|
+
user_agent = values.get("user_agent", values.get("userAgent"))
|
|
129
|
+
return cls.create(
|
|
130
|
+
api_key=str(api_key) if api_key is not None else None,
|
|
131
|
+
base_url=str(base_url) if isinstance(base_url, str) else None,
|
|
132
|
+
timeout=float(timeout) if isinstance(timeout, (int, float)) else None,
|
|
133
|
+
user_agent=str(user_agent) if isinstance(user_agent, str) else None,
|
|
134
|
+
)
|
|
135
|
+
|
|
136
|
+
def to_dict(self) -> dict[str, str | float]:
|
|
137
|
+
"""Return a plain snapshot of the resolved configuration."""
|
|
138
|
+
return {
|
|
139
|
+
"api_key": self.api_key,
|
|
140
|
+
"base_url": self.base_url,
|
|
141
|
+
"timeout": self.timeout,
|
|
142
|
+
"user_agent": self.user_agent,
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
def _normalize_api_key(api_key: str) -> str:
|
|
147
|
+
if not isinstance(api_key, str) or api_key.strip() == "":
|
|
148
|
+
raise ValueError("MailerMine Configuration requires a non-empty api_key string.")
|
|
149
|
+
return api_key.strip()
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
def _normalize_base_url(base_url: str) -> str:
|
|
153
|
+
if not isinstance(base_url, str) or base_url.strip() == "":
|
|
154
|
+
raise ValueError("MailerMine Configuration base_url must be a non-empty string.")
|
|
155
|
+
trimmed = base_url.strip().rstrip("/")
|
|
156
|
+
parsed = urlparse(trimmed)
|
|
157
|
+
if parsed.scheme not in {"http", "https"} or not parsed.netloc:
|
|
158
|
+
raise ValueError(f"MailerMine Configuration base_url is not a valid URL: {base_url}")
|
|
159
|
+
return trimmed
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
def _normalize_timeout(timeout: float) -> float:
|
|
163
|
+
if not isinstance(timeout, (int, float)) or isinstance(timeout, bool):
|
|
164
|
+
raise ValueError("MailerMine Configuration timeout must be a positive number (seconds).")
|
|
165
|
+
value = float(timeout)
|
|
166
|
+
if value <= 0 or value != value: # NaN check
|
|
167
|
+
raise ValueError("MailerMine Configuration timeout must be a positive number (seconds).")
|
|
168
|
+
return value
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
def _normalize_user_agent(user_agent: str) -> str:
|
|
172
|
+
if not isinstance(user_agent, str) or user_agent.strip() == "":
|
|
173
|
+
raise ValueError("MailerMine Configuration user_agent must be a non-empty string.")
|
|
174
|
+
return user_agent.strip()
|
mailermine/constants.py
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"""Shared constants for the MailerMine Python SDK."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
VERSION: str = "1.0.0"
|
|
6
|
+
|
|
7
|
+
DEFAULT_BASE_URL: str = "https://mailermine.com/api/v1"
|
|
8
|
+
|
|
9
|
+
DEFAULT_TIMEOUT: float = 30.0
|
|
10
|
+
|
|
11
|
+
DEFAULT_USER_AGENT: str = f"mailermine-python/{VERSION}"
|
|
12
|
+
|
|
13
|
+
UPGRADE_URL: str = "https://mailermine.com/billing"
|