aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/mailersend/recipients/__init__.py
blob: 5761a8f110ce3056329cfe52a37c658a6402221d (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
"""
Handles /recipients endpoint
Doc: https://developers.mailersend.com/api/v1/recipients.html
"""

import requests
from mailersend.base import base


class NewRecipient(base.NewAPIClient):
    """
    Instantiates the /recipients endpoint object
    """

    pass

    def get_recipients(self):
        """
        Returns a JSON response from the MailerSend API
        """

        request = requests.get(
            f"{self.api_base}/recipients", headers=self.headers_default
        )
        return request.text

    def get_recipient_by_id(self, recipient_id):
        """
        Returns a JSON response from the MailerSend API
        """

        request = requests.get(
            f"{self.api_base}/recipients/{recipient_id}", headers=self.headers_default
        )
        return request.text

    def delete_recipient(self, recipient_id):
        """
        Returns a HTTP status code from the MailerSend API
        """

        request = requests.delete(
            f"{self.api_base}/recipients/{recipient_id}", headers=self.headers_default
        )
        return request.status_code

    def get_recipients_from_blocklist(self, domain_id=None, limit=None, page=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id
        message["limit"] = limit
        message["page"] = page

        request = requests.get(
            f"{self.api_base}/suppressions/blocklist",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def get_hard_bounces(self, domain_id=None, limit=None, page=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id
        message["limit"] = limit
        message["page"] = page

        request = requests.get(
            f"{self.api_base}/suppressions/hard_bounces",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def get_spam_complaints(self, domain_id=None, limit=None, page=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id
        message["limit"] = limit
        message["page"] = page

        request = requests.get(
            f"{self.api_base}/suppressions/spam-complaints",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def get_unsubscribes(self, domain_id=None, limit=None, page=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id
        message["limit"] = limit
        message["page"] = page

        request = requests.get(
            f"{self.api_base}/suppressions/unsubscribes",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def add_to_blocklist(self, domain_id, recipients=None, patterns=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if recipients is not None:
            message["recipients"] = recipients
        if patterns is not None:
            message["patterns"] = patterns

        request = requests.post(
            f"{self.api_base}/suppressions/blocklist",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def delete_from_blocklist(self, domain_id, ids=None, remove_all=False):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if ids is not None:
            message["ids"] = ids
        if remove_all is True:
            message["all"] = "true"

        request = requests.delete(
            f"{self.api_base}/suppressions/blocklist",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def add_hard_bounces(self, domain_id=None, recipients=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if recipients is not None:
            message["recipients"] = recipients

        request = requests.post(
            f"{self.api_base}/suppressions/hard-bounces",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def delete_hard_bounces(self, domain_id, ids=None, remove_all=False):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if ids is not None:
            message["ids"] = ids
        if remove_all is True:
            message["all"] = "true"

        request = requests.delete(
            f"{self.api_base}/suppressions/hard-bounces",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def add_spam_complaints(self, domain_id=None, recipients=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if recipients is not None:
            message["recipients"] = recipients

        request = requests.post(
            f"{self.api_base}/suppressions/spam-complaints",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def delete_spam_complaints(self, domain_id, ids=None, remove_all=False):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if ids is not None:
            message["ids"] = ids
        if remove_all is True:
            message["all"] = "true"

        request = requests.delete(
            f"{self.api_base}/suppressions/spam-complaints",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def add_unsubscribes(self, domain_id=None, recipients=None):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if recipients is not None:
            message["recipients"] = recipients

        request = requests.post(
            f"{self.api_base}/suppressions/unsubscribes",
            headers=self.headers_default,
            json=message,
        )
        return request.text

    def delete_unsubscribes(self, domain_id, ids=None, remove_all=False):
        """
        Returns a HTTP status code from the MailerSend API
        """
        message = {}
        message["domain_id"] = domain_id

        if ids is not None:
            message["ids"] = ids
        if remove_all is True:
            message["all"] = True

        request = requests.delete(
            f"{self.api_base}/suppressions/unsubscribes",
            headers=self.headers_default,
            json=message,
        )
        return request.text