aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/mailersend/sms_activity/__init__.py
blob: afe9044cfabed41a76c1ac751c661ee66428f6b5 (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
"""
Handles /sms-activity endpoint
"""

import requests
from mailersend.base import base


class NewSmsActivity(base.NewAPIClient):
    """
    Instantiates the /sms-activity endpoint object
    """

    pass

    def get_activities(
        self,
        sms_number_id=None,
        date_from=None,
        date_to=None,
        status=[],
        page=None,
        limit=25,
    ):
        """
        Retrieve every single data point of the activity that happened for a specific phone number.

        @params:
          sms_number_id (str)
          date_from (int): Timestamp is assumed to be `UTC`. Must be lower than `date_to`
          date_to (int): Timestamp is assumed to be `UTC`. Must be higher than `date_from`
          status (dict): Possible types: `processed`,`queued`,`sent`,`delivered`, `failed`
          page (int)
          limit (int): Min: `10`, Max: `100`, default is 25
        """

        passed_arguments = locals()
        query_params = {}

        for key, value in passed_arguments.items():
            if key != "self":
                if key == "status":
                    query_params[key + "[]"] = value
                else:
                    query_params[key] = value

        request = requests.get(
            f"{self.api_base}/sms-activity",
            headers=self.headers_default,
            params=query_params,
        )

        return f"{request.status_code}\n{request.text}"

    def get_activity(self, sms_message_id):
        """
        Get every single activity data point that happened to a specific SMS message

        @params:
          sms_message_id (str)
        """

        request = requests.get(
            f"{self.api_base}/sms-messages/{sms_message_id}",
            headers=self.headers_default,
        )

        return f"{request.status_code}\n{request.text}"