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

import requests
from mailersend.base import base


class NewSmsNumbers(base.NewAPIClient):
    """
    Instantiates the /sms-numbers endpoint object
    """

    pass

    def get_phone_numbers(self, paused=False, page=None, limit=25):
        """
        Get a list of SMS phone numbers information.

        @params:
          paused (bool)
          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 == "paused":
                    query_params[key] = int(value)
                else:
                    query_params[key] = value

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

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

    def get_phone_number(self, sms_number_id):
        """
        Get information about a specific SMS phone number

        @params:
          sms_number_id (string)
        """

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

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

    def update_phone_number(self, sms_number_id, paused=True):
        """
        Update a specific SMS phone number

        @params:
          sms_number_id (string)
           paused (bool)
        """

        query_params = {"paused": int(paused)}
        data = {"sms_number_id": sms_number_id}

        request = requests.put(
            f"{self.api_base}/sms-numbers/{sms_number_id}",
            headers=self.headers_default,
            params=query_params,
            json=data,
        )

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

    def delete_phone_number(self, sms_number_id):
        """
        Delete a specific SMS phone number

        @params:
          sms_number_id (string)
        """

        data = {"sms_number_id": sms_number_id}

        request = requests.delete(
            f"{self.api_base}/sms-numbers/{sms_number_id}",
            headers=self.headers_default,
            json=data,
        )

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