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
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
from twilio.base import serialize
from twilio.base import values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
class UsageRecordList(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 UsageRecordList
:param Version version: Version that contains the resource
:returns: twilio.rest.supersim.v1.usage_record.UsageRecordList
:rtype: twilio.rest.supersim.v1.usage_record.UsageRecordList
"""
super(UsageRecordList, self).__init__(version)
# Path Solution
self._solution = {}
self._uri = '/UsageRecords'.format(**self._solution)
def stream(self, sim=values.unset, fleet=values.unset, network=values.unset,
iso_country=values.unset, group=values.unset,
granularity=values.unset, start_time=values.unset,
end_time=values.unset, limit=None, page_size=None):
"""
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 unicode sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param unicode 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 unicode network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param unicode 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.
:param UsageRecordInstance.Granularity granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`.
:param datetime start_time: Only include usage that occurred at or after this time.
:param datetime end_time: Only include usage that occurred before this time.
: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.supersim.v1.usage_record.UsageRecordInstance]
"""
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'])
def list(self, sim=values.unset, fleet=values.unset, network=values.unset,
iso_country=values.unset, group=values.unset, granularity=values.unset,
start_time=values.unset, end_time=values.unset, limit=None,
page_size=None):
"""
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 unicode sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param unicode 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 unicode network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param unicode 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.
:param UsageRecordInstance.Granularity granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`.
:param datetime start_time: Only include usage that occurred at or after this time.
:param datetime end_time: Only include usage that occurred before this time.
: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.supersim.v1.usage_record.UsageRecordInstance]
"""
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,
))
def page(self, sim=values.unset, fleet=values.unset, network=values.unset,
iso_country=values.unset, group=values.unset, granularity=values.unset,
start_time=values.unset, end_time=values.unset,
page_token=values.unset, page_number=values.unset,
page_size=values.unset):
"""
Retrieve a single page of UsageRecordInstance records from the API.
Request is executed immediately
:param unicode sim: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
:param unicode 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 unicode network: SID of a Network resource. Only show UsageRecords representing usage on this network.
:param unicode 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.
:param UsageRecordInstance.Granularity granularity: Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`.
:param datetime start_time: Only include usage that occurred at or after this time.
:param datetime end_time: Only include usage that occurred before this time.
: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 UsageRecordInstance
:rtype: twilio.rest.supersim.v1.usage_record.UsageRecordPage
"""
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,
})
response = self._version.page(method='GET', uri=self._uri, params=data, )
return UsageRecordPage(self._version, response, self._solution)
def get_page(self, target_url):
"""
Retrieve a specific page of UsageRecordInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of UsageRecordInstance
:rtype: twilio.rest.supersim.v1.usage_record.UsageRecordPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return UsageRecordPage(self._version, response, self._solution)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Supersim.V1.UsageRecordList>'
class UsageRecordPage(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 UsageRecordPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.supersim.v1.usage_record.UsageRecordPage
:rtype: twilio.rest.supersim.v1.usage_record.UsageRecordPage
"""
super(UsageRecordPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of UsageRecordInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.supersim.v1.usage_record.UsageRecordInstance
:rtype: twilio.rest.supersim.v1.usage_record.UsageRecordInstance
"""
return UsageRecordInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Supersim.V1.UsageRecordPage>'
class UsageRecordInstance(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. """
class Granularity(object):
HOUR = "hour"
DAY = "day"
ALL = "all"
class Group(object):
SIM = "sim"
FLEET = "fleet"
NETWORK = "network"
ISOCOUNTRY = "isoCountry"
class SortBy(object):
TIME = "time"
def __init__(self, version, payload):
"""
Initialize the UsageRecordInstance
:returns: twilio.rest.supersim.v1.usage_record.UsageRecordInstance
:rtype: twilio.rest.supersim.v1.usage_record.UsageRecordInstance
"""
super(UsageRecordInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'sim_sid': payload.get('sim_sid'),
'network_sid': payload.get('network_sid'),
'fleet_sid': payload.get('fleet_sid'),
'iso_country': payload.get('iso_country'),
'period': payload.get('period'),
'data_upload': deserialize.integer(payload.get('data_upload')),
'data_download': deserialize.integer(payload.get('data_download')),
'data_total': deserialize.integer(payload.get('data_total')),
}
# Context
self._context = None
self._solution = {}
@property
def account_sid(self):
"""
:returns: The SID of the Account that incurred the usage.
:rtype: unicode
"""
return self._properties['account_sid']
@property
def sim_sid(self):
"""
:returns: SID of a Sim resource to which the UsageRecord belongs.
:rtype: unicode
"""
return self._properties['sim_sid']
@property
def network_sid(self):
"""
:returns: SID of the Network resource on which the usage occurred.
:rtype: unicode
"""
return self._properties['network_sid']
@property
def fleet_sid(self):
"""
:returns: SID of the Fleet resource on which the usage occurred.
:rtype: unicode
"""
return self._properties['fleet_sid']
@property
def iso_country(self):
"""
:returns: Alpha-2 ISO Country Code of the country the usage occurred in.
:rtype: unicode
"""
return self._properties['iso_country']
@property
def period(self):
"""
:returns: The time period for which the usage is reported.
:rtype: dict
"""
return self._properties['period']
@property
def data_upload(self):
"""
:returns: Total data uploaded in bytes, aggregated by the query parameters.
:rtype: unicode
"""
return self._properties['data_upload']
@property
def data_download(self):
"""
:returns: Total data downloaded in bytes, aggregated by the query parameters.
:rtype: unicode
"""
return self._properties['data_download']
@property
def data_total(self):
"""
:returns: Total of data_upload and data_download.
:rtype: unicode
"""
return self._properties['data_total']
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Supersim.V1.UsageRecordInstance>'
|