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
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
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 JobList(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 JobList
:param Version version: Version that contains the resource
:returns: twilio.rest.preview.bulk_exports.export.job.JobList
:rtype: twilio.rest.preview.bulk_exports.export.job.JobList
"""
super(JobList, self).__init__(version)
# Path Solution
self._solution = {}
def get(self, job_sid):
"""
Constructs a JobContext
:param job_sid: The unique string that that we created to identify the Bulk Export job
:returns: twilio.rest.preview.bulk_exports.export.job.JobContext
:rtype: twilio.rest.preview.bulk_exports.export.job.JobContext
"""
return JobContext(self._version, job_sid=job_sid, )
def __call__(self, job_sid):
"""
Constructs a JobContext
:param job_sid: The unique string that that we created to identify the Bulk Export job
:returns: twilio.rest.preview.bulk_exports.export.job.JobContext
:rtype: twilio.rest.preview.bulk_exports.export.job.JobContext
"""
return JobContext(self._version, job_sid=job_sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.BulkExports.JobList>'
class JobPage(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 JobPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.preview.bulk_exports.export.job.JobPage
:rtype: twilio.rest.preview.bulk_exports.export.job.JobPage
"""
super(JobPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of JobInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.preview.bulk_exports.export.job.JobInstance
:rtype: twilio.rest.preview.bulk_exports.export.job.JobInstance
"""
return JobInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.BulkExports.JobPage>'
class JobContext(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, job_sid):
"""
Initialize the JobContext
:param Version version: Version that contains the resource
:param job_sid: The unique string that that we created to identify the Bulk Export job
:returns: twilio.rest.preview.bulk_exports.export.job.JobContext
:rtype: twilio.rest.preview.bulk_exports.export.job.JobContext
"""
super(JobContext, self).__init__(version)
# Path Solution
self._solution = {'job_sid': job_sid, }
self._uri = '/Exports/Jobs/{job_sid}'.format(**self._solution)
def fetch(self):
"""
Fetch the JobInstance
:returns: The fetched JobInstance
:rtype: twilio.rest.preview.bulk_exports.export.job.JobInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return JobInstance(self._version, payload, job_sid=self._solution['job_sid'], )
def delete(self):
"""
Deletes the JobInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._version.delete(method='DELETE', uri=self._uri, )
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.JobContext {}>'.format(context)
class JobInstance(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, job_sid=None):
"""
Initialize the JobInstance
:returns: twilio.rest.preview.bulk_exports.export.job.JobInstance
:rtype: twilio.rest.preview.bulk_exports.export.job.JobInstance
"""
super(JobInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'resource_type': payload.get('resource_type'),
'friendly_name': payload.get('friendly_name'),
'details': payload.get('details'),
'start_day': payload.get('start_day'),
'end_day': payload.get('end_day'),
'job_sid': payload.get('job_sid'),
'webhook_url': payload.get('webhook_url'),
'webhook_method': payload.get('webhook_method'),
'email': payload.get('email'),
'url': payload.get('url'),
}
# Context
self._context = None
self._solution = {'job_sid': job_sid or self._properties['job_sid'], }
@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: JobContext for this JobInstance
:rtype: twilio.rest.preview.bulk_exports.export.job.JobContext
"""
if self._context is None:
self._context = JobContext(self._version, job_sid=self._solution['job_sid'], )
return self._context
@property
def resource_type(self):
"""
:returns: The type of communication – Messages, Calls, Conferences, and Participants
:rtype: unicode
"""
return self._properties['resource_type']
@property
def friendly_name(self):
"""
:returns: The friendly name specified when creating the job
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def details(self):
"""
:returns: This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status
:rtype: dict
"""
return self._properties['details']
@property
def start_day(self):
"""
:returns: The start time for the export specified when creating the job
:rtype: unicode
"""
return self._properties['start_day']
@property
def end_day(self):
"""
:returns: The end time for the export specified when creating the job
:rtype: unicode
"""
return self._properties['end_day']
@property
def job_sid(self):
"""
:returns: The job_sid returned when the export was created
:rtype: unicode
"""
return self._properties['job_sid']
@property
def webhook_url(self):
"""
:returns: The optional webhook url called on completion
:rtype: unicode
"""
return self._properties['webhook_url']
@property
def webhook_method(self):
"""
:returns: This is the method used to call the webhook
:rtype: unicode
"""
return self._properties['webhook_method']
@property
def email(self):
"""
:returns: The optional email to send the completion notification to
:rtype: unicode
"""
return self._properties['email']
@property
def url(self):
"""
:returns: The url
:rtype: unicode
"""
return self._properties['url']
def fetch(self):
"""
Fetch the JobInstance
:returns: The fetched JobInstance
:rtype: twilio.rest.preview.bulk_exports.export.job.JobInstance
"""
return self._proxy.fetch()
def delete(self):
"""
Deletes the JobInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete()
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.JobInstance {}>'.format(context)
|
