File: message.py

package info (click to toggle)
python-twilio 9.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 13,756 kB
  • sloc: python: 8,281; makefile: 65
file content (186 lines) | stat: -rw-r--r-- 6,751 bytes parent folder | download
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
r"""
    This code was generated by
   ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
    |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
    |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \

    Twilio - Assistants
    This is the public Twilio REST API.

    NOTE: This class is auto generated by OpenAPI Generator.
    https://openapi-generator.tech
    Do not edit the class manually.
"""

from typing import Any, Dict, Optional
from twilio.base import values

from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version


class MessageInstance(InstanceResource):

    class AssistantsV1ServiceAssistantSendMessageRequest(object):
        """
        :ivar identity: The unique identity of user for the session.
        :ivar session_id: The unique name for the session.
        :ivar body: The query to ask the assistant.
        :ivar webhook: The webhook url to call after the assistant has generated a response or report an error.
        :ivar mode: one of the modes 'chat', 'email' or 'voice'
        """

        def __init__(self, payload: Dict[str, Any]):

            self.identity: Optional[str] = payload.get("identity")
            self.session_id: Optional[str] = payload.get("session_id")
            self.body: Optional[str] = payload.get("body")
            self.webhook: Optional[str] = payload.get("webhook")
            self.mode: Optional[str] = payload.get("mode")

        def to_dict(self):
            return {
                "identity": self.identity,
                "session_id": self.session_id,
                "body": self.body,
                "webhook": self.webhook,
                "mode": self.mode,
            }

    """
    :ivar status: success or failure based on whether the request successfully generated a response.
    :ivar flagged: If successful, this property will denote whether the response was flagged or not.
    :ivar aborted: This property will denote whether the request was aborted or not.
    :ivar session_id: The unique name for the session.
    :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that sent the Message.
    :ivar body: If successful, the body of the generated response
    :ivar error: The error message if generation was not successful
    """

    def __init__(self, version: Version, payload: Dict[str, Any], id: str):
        super().__init__(version)

        self.status: Optional[str] = payload.get("status")
        self.flagged: Optional[bool] = payload.get("flagged")
        self.aborted: Optional[bool] = payload.get("aborted")
        self.session_id: Optional[str] = payload.get("session_id")
        self.account_sid: Optional[str] = payload.get("account_sid")
        self.body: Optional[str] = payload.get("body")
        self.error: Optional[str] = payload.get("error")

        self._solution = {
            "id": id,
        }

    def __repr__(self) -> str:
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        """
        context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
        return "<Twilio.Assistants.V1.MessageInstance {}>".format(context)


class MessageList(ListResource):

    class AssistantsV1ServiceAssistantSendMessageRequest(object):
        """
        :ivar identity: The unique identity of user for the session.
        :ivar session_id: The unique name for the session.
        :ivar body: The query to ask the assistant.
        :ivar webhook: The webhook url to call after the assistant has generated a response or report an error.
        :ivar mode: one of the modes 'chat', 'email' or 'voice'
        """

        def __init__(self, payload: Dict[str, Any]):

            self.identity: Optional[str] = payload.get("identity")
            self.session_id: Optional[str] = payload.get("session_id")
            self.body: Optional[str] = payload.get("body")
            self.webhook: Optional[str] = payload.get("webhook")
            self.mode: Optional[str] = payload.get("mode")

        def to_dict(self):
            return {
                "identity": self.identity,
                "session_id": self.session_id,
                "body": self.body,
                "webhook": self.webhook,
                "mode": self.mode,
            }

    def __init__(self, version: Version, id: str):
        """
        Initialize the MessageList

        :param version: Version that contains the resource
        :param id: the Assistant ID.

        """
        super().__init__(version)

        # Path Solution
        self._solution = {
            "id": id,
        }
        self._uri = "/Assistants/{id}/Messages".format(**self._solution)

    def create(
        self,
        assistants_v1_service_assistant_send_message_request: AssistantsV1ServiceAssistantSendMessageRequest,
    ) -> MessageInstance:
        """
        Create the MessageInstance

        :param assistants_v1_service_assistant_send_message_request:

        :returns: The created MessageInstance
        """
        data = assistants_v1_service_assistant_send_message_request.to_dict()

        headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})

        headers["Content-Type"] = "application/json"

        headers["Accept"] = "application/json"

        payload = self._version.create(
            method="POST", uri=self._uri, data=data, headers=headers
        )

        return MessageInstance(self._version, payload, id=self._solution["id"])

    async def create_async(
        self,
        assistants_v1_service_assistant_send_message_request: AssistantsV1ServiceAssistantSendMessageRequest,
    ) -> MessageInstance:
        """
        Asynchronously create the MessageInstance

        :param assistants_v1_service_assistant_send_message_request:

        :returns: The created MessageInstance
        """
        data = assistants_v1_service_assistant_send_message_request.to_dict()

        headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})

        headers["Content-Type"] = "application/json"

        headers["Accept"] = "application/json"

        payload = await self._version.create_async(
            method="POST", uri=self._uri, data=data, headers=headers
        )

        return MessageInstance(self._version, payload, id=self._solution["id"])

    def __repr__(self) -> str:
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        """
        return "<Twilio.Assistants.V1.MessageList>"