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
342
343
344
345
346
347
348
|
# 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 DayList(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, resource_type):
"""
Initialize the DayList
:param Version version: Version that contains the resource
:param resource_type: The type of communication – Messages, Calls, Conferences, and Participants
:returns: twilio.rest.preview.bulk_exports.export.day.DayList
:rtype: twilio.rest.preview.bulk_exports.export.day.DayList
"""
super(DayList, self).__init__(version)
# Path Solution
self._solution = {'resource_type': resource_type, }
self._uri = '/Exports/{resource_type}/Days'.format(**self._solution)
def stream(self, limit=None, page_size=None):
"""
Streams DayInstance records from the API as a generator stream.
This operation lazily loads records as efficiently as possible until the limit
is reached.
The results are returned as a generator, so this operation is memory efficient.
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the
limit with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
:rtype: list[twilio.rest.preview.bulk_exports.export.day.DayInstance]
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(page_size=limits['page_size'], )
return self._version.stream(page, limits['limit'])
def list(self, limit=None, page_size=None):
"""
Lists DayInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, list() will attempt to read the limit
with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
:rtype: list[twilio.rest.preview.bulk_exports.export.day.DayInstance]
"""
return list(self.stream(limit=limit, page_size=page_size, ))
def page(self, page_token=values.unset, page_number=values.unset,
page_size=values.unset):
"""
Retrieve a single page of DayInstance records from the API.
Request is executed immediately
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
:returns: Page of DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayPage
"""
data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, })
response = self._version.page(method='GET', uri=self._uri, params=data, )
return DayPage(self._version, response, self._solution)
def get_page(self, target_url):
"""
Retrieve a specific page of DayInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return DayPage(self._version, response, self._solution)
def get(self, day):
"""
Constructs a DayContext
:param day: The date of the data in the file
:returns: twilio.rest.preview.bulk_exports.export.day.DayContext
:rtype: twilio.rest.preview.bulk_exports.export.day.DayContext
"""
return DayContext(self._version, resource_type=self._solution['resource_type'], day=day, )
def __call__(self, day):
"""
Constructs a DayContext
:param day: The date of the data in the file
:returns: twilio.rest.preview.bulk_exports.export.day.DayContext
:rtype: twilio.rest.preview.bulk_exports.export.day.DayContext
"""
return DayContext(self._version, resource_type=self._solution['resource_type'], day=day, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.BulkExports.DayList>'
class DayPage(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 DayPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param resource_type: The type of communication – Messages, Calls, Conferences, and Participants
:returns: twilio.rest.preview.bulk_exports.export.day.DayPage
:rtype: twilio.rest.preview.bulk_exports.export.day.DayPage
"""
super(DayPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of DayInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.preview.bulk_exports.export.day.DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayInstance
"""
return DayInstance(self._version, payload, resource_type=self._solution['resource_type'], )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.BulkExports.DayPage>'
class DayContext(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, resource_type, day):
"""
Initialize the DayContext
:param Version version: Version that contains the resource
:param resource_type: The type of communication – Messages, Calls, Conferences, and Participants
:param day: The date of the data in the file
:returns: twilio.rest.preview.bulk_exports.export.day.DayContext
:rtype: twilio.rest.preview.bulk_exports.export.day.DayContext
"""
super(DayContext, self).__init__(version)
# Path Solution
self._solution = {'resource_type': resource_type, 'day': day, }
self._uri = '/Exports/{resource_type}/Days/{day}'.format(**self._solution)
def fetch(self):
"""
Fetch the DayInstance
:returns: The fetched DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return DayInstance(
self._version,
payload,
resource_type=self._solution['resource_type'],
day=self._solution['day'],
)
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.BulkExports.DayContext {}>'.format(context)
class DayInstance(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, resource_type, day=None):
"""
Initialize the DayInstance
:returns: twilio.rest.preview.bulk_exports.export.day.DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayInstance
"""
super(DayInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'redirect_to': payload.get('redirect_to'),
'day': payload.get('day'),
'size': deserialize.integer(payload.get('size')),
'create_date': payload.get('create_date'),
'friendly_name': payload.get('friendly_name'),
'resource_type': payload.get('resource_type'),
}
# Context
self._context = None
self._solution = {'resource_type': resource_type, 'day': day or self._properties['day'], }
@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: DayContext for this DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayContext
"""
if self._context is None:
self._context = DayContext(
self._version,
resource_type=self._solution['resource_type'],
day=self._solution['day'],
)
return self._context
@property
def redirect_to(self):
"""
:returns: The redirect_to
:rtype: unicode
"""
return self._properties['redirect_to']
@property
def day(self):
"""
:returns: The date of the data in the file
:rtype: unicode
"""
return self._properties['day']
@property
def size(self):
"""
:returns: Size of the file in bytes
:rtype: unicode
"""
return self._properties['size']
@property
def create_date(self):
"""
:returns: The date when resource is created
:rtype: unicode
"""
return self._properties['create_date']
@property
def friendly_name(self):
"""
:returns: The friendly name specified when creating the job
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def resource_type(self):
"""
:returns: The type of communication – Messages, Calls, Conferences, and Participants
:rtype: unicode
"""
return self._properties['resource_type']
def fetch(self):
"""
Fetch the DayInstance
:returns: The fetched DayInstance
:rtype: twilio.rest.preview.bulk_exports.export.day.DayInstance
"""
return self._proxy.fetch()
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.BulkExports.DayInstance {}>'.format(context)
|
