File: current_call.py

package info (click to toggle)
python-twilio 6.51.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 12,260 kB
  • sloc: python: 128,982; makefile: 51
file content (341 lines) | stat: -rw-r--r-- 10,840 bytes parent folder | download | duplicates (2)
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# coding=utf-8
r"""
This code was generated by
\ / _    _  _|   _  _
 | (_)\/(_)(_|\/| |(/_  v1.0.0
      /       /
"""

from twilio.base import deserialize
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page


class CurrentCallList(ListResource):
    """ PLEASE NOTE that this class contains preview products that are subject
    to change. Use them with caution. If you currently do not have developer
    preview access, please contact help@twilio.com. """

    def __init__(self, version):
        """
        Initialize the CurrentCallList

        :param Version version: Version that contains the resource

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallList
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallList
        """
        super(CurrentCallList, self).__init__(version)

        # Path Solution
        self._solution = {}

    def get(self):
        """
        Constructs a CurrentCallContext

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        """
        return CurrentCallContext(self._version, )

    def __call__(self):
        """
        Constructs a CurrentCallContext

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        """
        return CurrentCallContext(self._version, )

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        return '<Twilio.Preview.TrustedComms.CurrentCallList>'


class CurrentCallPage(Page):
    """ PLEASE NOTE that this class contains preview products that are subject
    to change. Use them with caution. If you currently do not have developer
    preview access, please contact help@twilio.com. """

    def __init__(self, version, response, solution):
        """
        Initialize the CurrentCallPage

        :param Version version: Version that contains the resource
        :param Response response: Response from the API

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallPage
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallPage
        """
        super(CurrentCallPage, self).__init__(version, response)

        # Path Solution
        self._solution = solution

    def get_instance(self, payload):
        """
        Build an instance of CurrentCallInstance

        :param dict payload: Payload response from the API

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallInstance
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallInstance
        """
        return CurrentCallInstance(self._version, payload, )

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        return '<Twilio.Preview.TrustedComms.CurrentCallPage>'


class CurrentCallContext(InstanceContext):
    """ PLEASE NOTE that this class contains preview products that are subject
    to change. Use them with caution. If you currently do not have developer
    preview access, please contact help@twilio.com. """

    def __init__(self, version):
        """
        Initialize the CurrentCallContext

        :param Version version: Version that contains the resource

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        """
        super(CurrentCallContext, self).__init__(version)

        # Path Solution
        self._solution = {}
        self._uri = '/CurrentCall'.format(**self._solution)

    def fetch(self, x_xcnam_sensitive_phone_number_from=values.unset,
              x_xcnam_sensitive_phone_number_to=values.unset):
        """
        Fetch the CurrentCallInstance

        :param unicode x_xcnam_sensitive_phone_number_from: The originating Phone Number
        :param unicode x_xcnam_sensitive_phone_number_to: The terminating Phone Number

        :returns: The fetched CurrentCallInstance
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallInstance
        """
        headers = values.of({
            'X-Xcnam-Sensitive-Phone-Number-From': x_xcnam_sensitive_phone_number_from,
            'X-Xcnam-Sensitive-Phone-Number-To': x_xcnam_sensitive_phone_number_to,
        })

        payload = self._version.fetch(method='GET', uri=self._uri, headers=headers, )

        return CurrentCallInstance(self._version, payload, )

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
        return '<Twilio.Preview.TrustedComms.CurrentCallContext {}>'.format(context)


class CurrentCallInstance(InstanceResource):
    """ PLEASE NOTE that this class contains preview products that are subject
    to change. Use them with caution. If you currently do not have developer
    preview access, please contact help@twilio.com. """

    def __init__(self, version, payload):
        """
        Initialize the CurrentCallInstance

        :returns: twilio.rest.preview.trusted_comms.current_call.CurrentCallInstance
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallInstance
        """
        super(CurrentCallInstance, self).__init__(version)

        # Marshaled Properties
        self._properties = {
            'bg_color': payload.get('bg_color'),
            'caller': payload.get('caller'),
            'created_at': deserialize.iso8601_datetime(payload.get('created_at')),
            'font_color': payload.get('font_color'),
            'from_': payload.get('from'),
            'logo': payload.get('logo'),
            'manager': payload.get('manager'),
            'reason': payload.get('reason'),
            'shield_img': payload.get('shield_img'),
            'sid': payload.get('sid'),
            'status': payload.get('status'),
            'to': payload.get('to'),
            'url': payload.get('url'),
            'use_case': payload.get('use_case'),
        }

        # Context
        self._context = None
        self._solution = {}

    @property
    def _proxy(self):
        """
        Generate an instance context for the instance, the context is capable of
        performing various actions.  All instance actions are proxied to the context

        :returns: CurrentCallContext for this CurrentCallInstance
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallContext
        """
        if self._context is None:
            self._context = CurrentCallContext(self._version, )
        return self._context

    @property
    def bg_color(self):
        """
        :returns: Background color of the current phone call
        :rtype: unicode
        """
        return self._properties['bg_color']

    @property
    def caller(self):
        """
        :returns: Caller name of the current phone call
        :rtype: unicode
        """
        return self._properties['caller']

    @property
    def created_at(self):
        """
        :returns: The date this current phone call was created
        :rtype: datetime
        """
        return self._properties['created_at']

    @property
    def font_color(self):
        """
        :returns: Font color of the current phone call
        :rtype: unicode
        """
        return self._properties['font_color']

    @property
    def from_(self):
        """
        :returns: The originating phone number
        :rtype: unicode
        """
        return self._properties['from_']

    @property
    def logo(self):
        """
        :returns: Logo URL of the caller
        :rtype: unicode
        """
        return self._properties['logo']

    @property
    def manager(self):
        """
        :returns: The name of the CPS organization
        :rtype: unicode
        """
        return self._properties['manager']

    @property
    def reason(self):
        """
        :returns: The business reason for this current phone call
        :rtype: unicode
        """
        return self._properties['reason']

    @property
    def shield_img(self):
        """
        :returns: Shield image URL that serves as authenticity proof of the current phone call
        :rtype: unicode
        """
        return self._properties['shield_img']

    @property
    def sid(self):
        """
        :returns: A string that uniquely identifies this current branded phone call.
        :rtype: unicode
        """
        return self._properties['sid']

    @property
    def status(self):
        """
        :returns: The status of the current phone call
        :rtype: unicode
        """
        return self._properties['status']

    @property
    def to(self):
        """
        :returns: The terminating phone number
        :rtype: unicode
        """
        return self._properties['to']

    @property
    def url(self):
        """
        :returns: The URL of this resource.
        :rtype: unicode
        """
        return self._properties['url']

    @property
    def use_case(self):
        """
        :returns: The use case for the current phone call
        :rtype: unicode
        """
        return self._properties['use_case']

    def fetch(self, x_xcnam_sensitive_phone_number_from=values.unset,
              x_xcnam_sensitive_phone_number_to=values.unset):
        """
        Fetch the CurrentCallInstance

        :param unicode x_xcnam_sensitive_phone_number_from: The originating Phone Number
        :param unicode x_xcnam_sensitive_phone_number_to: The terminating Phone Number

        :returns: The fetched CurrentCallInstance
        :rtype: twilio.rest.preview.trusted_comms.current_call.CurrentCallInstance
        """
        return self._proxy.fetch(
            x_xcnam_sensitive_phone_number_from=x_xcnam_sensitive_phone_number_from,
            x_xcnam_sensitive_phone_number_to=x_xcnam_sensitive_phone_number_to,
        )

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
        return '<Twilio.Preview.TrustedComms.CurrentCallInstance {}>'.format(context)