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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Supersim
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 datetime import datetime
from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
from twilio.base import deserialize, serialize, values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
from twilio.base.page import Page
class UsageRecordInstance(InstanceResource):
class Granularity(object):
HOUR = "hour"
DAY = "day"
ALL = "all"
class Group(object):
SIM = "sim"
FLEET = "fleet"
NETWORK = "network"
ISOCOUNTRY = "isoCountry"
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that incurred the usage.
:ivar sim_sid: SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the `Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`.
:ivar network_sid: SID of the Network resource the usage occurred on. Value will only be present when either a value for the `Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`.
:ivar fleet_sid: SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the `Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`.
:ivar iso_country: Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the `IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`.
:ivar period: The time period for which the usage is reported. The period is represented as a pair of `start_time` and `end_time` timestamps specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar data_upload: Total data uploaded in bytes, aggregated by the query parameters.
:ivar data_download: Total data downloaded in bytes, aggregated by the query parameters.
:ivar data_total: Total of data_upload and data_download.
:ivar data_total_billed: Total amount in the `billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by Twilio's billing system. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.
:ivar billed_unit: The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). This can be null when data_toal_billed is 0 and we do not yet have billing information for the corresponding data usage. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.sim_sid: Optional[str] = payload.get("sim_sid")
self.network_sid: Optional[str] = payload.get("network_sid")
self.fleet_sid: Optional[str] = payload.get("fleet_sid")
self.iso_country: Optional[str] = payload.get("iso_country")
self.period: Optional[Dict[str, object]] = payload.get("period")
self.data_upload: Optional[int] = payload.get("data_upload")
self.data_download: Optional[int] = payload.get("data_download")
self.data_total: Optional[int] = payload.get("data_total")
self.data_total_billed: Optional[float] = deserialize.decimal(
payload.get("data_total_billed")
)
self.billed_unit: Optional[str] = payload.get("billed_unit")
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Supersim.V1.UsageRecordInstance>"
class UsageRecordPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> UsageRecordInstance:
"""
Build an instance of UsageRecordInstance
:param payload: Payload response from the API
"""
return UsageRecordInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Supersim.V1.UsageRecordPage>"
class UsageRecordList(ListResource):
def __init__(self, version: Version):
"""
Initialize the UsageRecordList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/UsageRecords"
def stream(
self,
sim: Union[str, object] = values.unset,
fleet: Union[str, object] = values.unset,
network: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
group: Union["UsageRecordInstance.Group", object] = values.unset,
granularity: Union["UsageRecordInstance.Granularity", object] = values.unset,
start_time: Union[datetime, object] = values.unset,
end_time: Union[datetime, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[UsageRecordInstance]:
"""
Streams UsageRecordInstance 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 str sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param str fleet: SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
:param str network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param str iso_country: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
:param "UsageRecordInstance.Group" group: Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
:param "UsageRecordInstance.Granularity" granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
:param datetime start_time: Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
:param datetime end_time: Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
:param limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param 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
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(
sim=sim,
fleet=fleet,
network=network,
iso_country=iso_country,
group=group,
granularity=granularity,
start_time=start_time,
end_time=end_time,
page_size=limits["page_size"],
)
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
sim: Union[str, object] = values.unset,
fleet: Union[str, object] = values.unset,
network: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
group: Union["UsageRecordInstance.Group", object] = values.unset,
granularity: Union["UsageRecordInstance.Granularity", object] = values.unset,
start_time: Union[datetime, object] = values.unset,
end_time: Union[datetime, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[UsageRecordInstance]:
"""
Asynchronously streams UsageRecordInstance 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 str sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param str fleet: SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
:param str network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param str iso_country: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
:param "UsageRecordInstance.Group" group: Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
:param "UsageRecordInstance.Granularity" granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
:param datetime start_time: Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
:param datetime end_time: Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
:param limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param 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
"""
limits = self._version.read_limits(limit, page_size)
page = await self.page_async(
sim=sim,
fleet=fleet,
network=network,
iso_country=iso_country,
group=group,
granularity=granularity,
start_time=start_time,
end_time=end_time,
page_size=limits["page_size"],
)
return self._version.stream_async(page, limits["limit"])
def list(
self,
sim: Union[str, object] = values.unset,
fleet: Union[str, object] = values.unset,
network: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
group: Union["UsageRecordInstance.Group", object] = values.unset,
granularity: Union["UsageRecordInstance.Granularity", object] = values.unset,
start_time: Union[datetime, object] = values.unset,
end_time: Union[datetime, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[UsageRecordInstance]:
"""
Lists UsageRecordInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param str fleet: SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
:param str network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param str iso_country: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
:param "UsageRecordInstance.Group" group: Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
:param "UsageRecordInstance.Granularity" granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
:param datetime start_time: Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
:param datetime end_time: Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
:param limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param 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: list that will contain up to limit results
"""
return list(
self.stream(
sim=sim,
fleet=fleet,
network=network,
iso_country=iso_country,
group=group,
granularity=granularity,
start_time=start_time,
end_time=end_time,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
sim: Union[str, object] = values.unset,
fleet: Union[str, object] = values.unset,
network: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
group: Union["UsageRecordInstance.Group", object] = values.unset,
granularity: Union["UsageRecordInstance.Granularity", object] = values.unset,
start_time: Union[datetime, object] = values.unset,
end_time: Union[datetime, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[UsageRecordInstance]:
"""
Asynchronously lists UsageRecordInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param str fleet: SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
:param str network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param str iso_country: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
:param "UsageRecordInstance.Group" group: Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
:param "UsageRecordInstance.Granularity" granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
:param datetime start_time: Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
:param datetime end_time: Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
:param limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param 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: list that will contain up to limit results
"""
return [
record
async for record in await self.stream_async(
sim=sim,
fleet=fleet,
network=network,
iso_country=iso_country,
group=group,
granularity=granularity,
start_time=start_time,
end_time=end_time,
limit=limit,
page_size=page_size,
)
]
def page(
self,
sim: Union[str, object] = values.unset,
fleet: Union[str, object] = values.unset,
network: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
group: Union["UsageRecordInstance.Group", object] = values.unset,
granularity: Union["UsageRecordInstance.Granularity", object] = values.unset,
start_time: Union[datetime, object] = values.unset,
end_time: Union[datetime, object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> UsageRecordPage:
"""
Retrieve a single page of UsageRecordInstance records from the API.
Request is executed immediately
:param sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param fleet: SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
:param network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param iso_country: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
:param group: Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
:param granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
:param start_time: Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
:param end_time: Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
:param page_token: PageToken provided by the API
:param page_number: Page Number, this value is simply for client state
:param page_size: Number of records to return, defaults to 50
:returns: Page of UsageRecordInstance
"""
data = values.of(
{
"Sim": sim,
"Fleet": fleet,
"Network": network,
"IsoCountry": iso_country,
"Group": group,
"Granularity": granularity,
"StartTime": serialize.iso8601_datetime(start_time),
"EndTime": serialize.iso8601_datetime(end_time),
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = self._version.page(
method="GET", uri=self._uri, params=data, headers=headers
)
return UsageRecordPage(self._version, response)
async def page_async(
self,
sim: Union[str, object] = values.unset,
fleet: Union[str, object] = values.unset,
network: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
group: Union["UsageRecordInstance.Group", object] = values.unset,
granularity: Union["UsageRecordInstance.Granularity", object] = values.unset,
start_time: Union[datetime, object] = values.unset,
end_time: Union[datetime, object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> UsageRecordPage:
"""
Asynchronously retrieve a single page of UsageRecordInstance records from the API.
Request is executed immediately
:param sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param fleet: SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
:param network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param iso_country: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
:param group: Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
:param granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
:param start_time: Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
:param end_time: Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
:param page_token: PageToken provided by the API
:param page_number: Page Number, this value is simply for client state
:param page_size: Number of records to return, defaults to 50
:returns: Page of UsageRecordInstance
"""
data = values.of(
{
"Sim": sim,
"Fleet": fleet,
"Network": network,
"IsoCountry": iso_country,
"Group": group,
"Granularity": granularity,
"StartTime": serialize.iso8601_datetime(start_time),
"EndTime": serialize.iso8601_datetime(end_time),
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = await self._version.page_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return UsageRecordPage(self._version, response)
def get_page(self, target_url: str) -> UsageRecordPage:
"""
Retrieve a specific page of UsageRecordInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of UsageRecordInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return UsageRecordPage(self._version, response)
async def get_page_async(self, target_url: str) -> UsageRecordPage:
"""
Asynchronously retrieve a specific page of UsageRecordInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of UsageRecordInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return UsageRecordPage(self._version, response)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Supersim.V1.UsageRecordList>"
|
