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 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
|
# 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_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
from twilio.rest.insights.v1.room.participant import ParticipantList
class RoomList(ListResource):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
def __init__(self, version):
"""
Initialize the RoomList
:param Version version: Version that contains the resource
:returns: twilio.rest.insights.v1.room.RoomList
:rtype: twilio.rest.insights.v1.room.RoomList
"""
super(RoomList, self).__init__(version)
# Path Solution
self._solution = {}
self._uri = '/Video/Rooms'.format(**self._solution)
def stream(self, room_type=values.unset, codec=values.unset,
room_name=values.unset, created_after=values.unset,
created_before=values.unset, limit=None, page_size=None):
"""
Streams RoomInstance 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 list[RoomInstance.RoomType] room_type: The room_type
:param list[RoomInstance.Codec] codec: The codec
:param unicode room_name: The room_name
:param datetime created_after: The created_after
:param datetime created_before: The created_before
: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.insights.v1.room.RoomInstance]
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(
room_type=room_type,
codec=codec,
room_name=room_name,
created_after=created_after,
created_before=created_before,
page_size=limits['page_size'],
)
return self._version.stream(page, limits['limit'])
def list(self, room_type=values.unset, codec=values.unset,
room_name=values.unset, created_after=values.unset,
created_before=values.unset, limit=None, page_size=None):
"""
Lists RoomInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param list[RoomInstance.RoomType] room_type: The room_type
:param list[RoomInstance.Codec] codec: The codec
:param unicode room_name: The room_name
:param datetime created_after: The created_after
:param datetime created_before: The created_before
: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.insights.v1.room.RoomInstance]
"""
return list(self.stream(
room_type=room_type,
codec=codec,
room_name=room_name,
created_after=created_after,
created_before=created_before,
limit=limit,
page_size=page_size,
))
def page(self, room_type=values.unset, codec=values.unset,
room_name=values.unset, created_after=values.unset,
created_before=values.unset, page_token=values.unset,
page_number=values.unset, page_size=values.unset):
"""
Retrieve a single page of RoomInstance records from the API.
Request is executed immediately
:param list[RoomInstance.RoomType] room_type: The room_type
:param list[RoomInstance.Codec] codec: The codec
:param unicode room_name: The room_name
:param datetime created_after: The created_after
:param datetime created_before: The created_before
: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 RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomPage
"""
data = values.of({
'RoomType': serialize.map(room_type, lambda e: e),
'Codec': serialize.map(codec, lambda e: e),
'RoomName': room_name,
'CreatedAfter': serialize.iso8601_datetime(created_after),
'CreatedBefore': serialize.iso8601_datetime(created_before),
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
response = self._version.page(method='GET', uri=self._uri, params=data, )
return RoomPage(self._version, response, self._solution)
def get_page(self, target_url):
"""
Retrieve a specific page of RoomInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return RoomPage(self._version, response, self._solution)
def get(self, room_sid):
"""
Constructs a RoomContext
:param room_sid: The room_sid
:returns: twilio.rest.insights.v1.room.RoomContext
:rtype: twilio.rest.insights.v1.room.RoomContext
"""
return RoomContext(self._version, room_sid=room_sid, )
def __call__(self, room_sid):
"""
Constructs a RoomContext
:param room_sid: The room_sid
:returns: twilio.rest.insights.v1.room.RoomContext
:rtype: twilio.rest.insights.v1.room.RoomContext
"""
return RoomContext(self._version, room_sid=room_sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Insights.V1.RoomList>'
class RoomPage(Page):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
def __init__(self, version, response, solution):
"""
Initialize the RoomPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.insights.v1.room.RoomPage
:rtype: twilio.rest.insights.v1.room.RoomPage
"""
super(RoomPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of RoomInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.insights.v1.room.RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomInstance
"""
return RoomInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Insights.V1.RoomPage>'
class RoomContext(InstanceContext):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
def __init__(self, version, room_sid):
"""
Initialize the RoomContext
:param Version version: Version that contains the resource
:param room_sid: The room_sid
:returns: twilio.rest.insights.v1.room.RoomContext
:rtype: twilio.rest.insights.v1.room.RoomContext
"""
super(RoomContext, self).__init__(version)
# Path Solution
self._solution = {'room_sid': room_sid, }
self._uri = '/Video/Rooms/{room_sid}'.format(**self._solution)
# Dependents
self._participants = None
def fetch(self):
"""
Fetch the RoomInstance
:returns: The fetched RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return RoomInstance(self._version, payload, room_sid=self._solution['room_sid'], )
@property
def participants(self):
"""
Access the participants
:returns: twilio.rest.insights.v1.room.participant.ParticipantList
:rtype: twilio.rest.insights.v1.room.participant.ParticipantList
"""
if self._participants is None:
self._participants = ParticipantList(self._version, room_sid=self._solution['room_sid'], )
return self._participants
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.Insights.V1.RoomContext {}>'.format(context)
class RoomInstance(InstanceResource):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
class RoomType(object):
GO = "go"
PEER_TO_PEER = "peer_to_peer"
GROUP = "group"
GROUP_SMALL = "group_small"
class RoomStatus(object):
IN_PROGRESS = "in_progress"
COMPLETED = "completed"
class CreatedMethod(object):
SDK = "sdk"
AD_HOC = "ad_hoc"
API = "api"
class EndReason(object):
ROOM_ENDED_VIA_API = "room_ended_via_api"
TIMEOUT = "timeout"
class Codec(object):
VP8 = "VP8"
H264 = "H264"
VP9 = "VP9"
class TwilioRealm(object):
US1 = "us1"
US2 = "us2"
AU1 = "au1"
BR1 = "br1"
IE1 = "ie1"
JP1 = "jp1"
SG1 = "sg1"
IN1 = "in1"
DE1 = "de1"
GLL = "gll"
class ProcessingState(object):
COMPLETE = "complete"
IN_PROGRESS = "in_progress"
class EdgeLocation(object):
ASHBURN = "ashburn"
DUBLIN = "dublin"
FRANKFURT = "frankfurt"
SINGAPORE = "singapore"
SYDNEY = "sydney"
SAO_PAULO = "sao_paulo"
ROAMING = "roaming"
UMATILLA = "umatilla"
TOKYO = "tokyo"
def __init__(self, version, payload, room_sid=None):
"""
Initialize the RoomInstance
:returns: twilio.rest.insights.v1.room.RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomInstance
"""
super(RoomInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'room_sid': payload.get('room_sid'),
'room_name': payload.get('room_name'),
'create_time': deserialize.iso8601_datetime(payload.get('create_time')),
'end_time': deserialize.iso8601_datetime(payload.get('end_time')),
'room_type': payload.get('room_type'),
'room_status': payload.get('room_status'),
'status_callback': payload.get('status_callback'),
'status_callback_method': payload.get('status_callback_method'),
'created_method': payload.get('created_method'),
'end_reason': payload.get('end_reason'),
'max_participants': deserialize.integer(payload.get('max_participants')),
'unique_participants': deserialize.integer(payload.get('unique_participants')),
'unique_participant_identities': deserialize.integer(payload.get('unique_participant_identities')),
'concurrent_participants': deserialize.integer(payload.get('concurrent_participants')),
'max_concurrent_participants': deserialize.integer(payload.get('max_concurrent_participants')),
'codecs': payload.get('codecs'),
'media_region': payload.get('media_region'),
'duration_sec': deserialize.integer(payload.get('duration_sec')),
'total_participant_duration_sec': deserialize.integer(payload.get('total_participant_duration_sec')),
'total_recording_duration_sec': deserialize.integer(payload.get('total_recording_duration_sec')),
'processing_state': payload.get('processing_state'),
'recording_enabled': payload.get('recording_enabled'),
'edge_location': payload.get('edge_location'),
'url': payload.get('url'),
'links': payload.get('links'),
}
# Context
self._context = None
self._solution = {'room_sid': room_sid or self._properties['room_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: RoomContext for this RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomContext
"""
if self._context is None:
self._context = RoomContext(self._version, room_sid=self._solution['room_sid'], )
return self._context
@property
def account_sid(self):
"""
:returns: The account_sid
:rtype: unicode
"""
return self._properties['account_sid']
@property
def room_sid(self):
"""
:returns: The room_sid
:rtype: unicode
"""
return self._properties['room_sid']
@property
def room_name(self):
"""
:returns: The room_name
:rtype: unicode
"""
return self._properties['room_name']
@property
def create_time(self):
"""
:returns: The create_time
:rtype: datetime
"""
return self._properties['create_time']
@property
def end_time(self):
"""
:returns: The end_time
:rtype: datetime
"""
return self._properties['end_time']
@property
def room_type(self):
"""
:returns: The room_type
:rtype: RoomInstance.RoomType
"""
return self._properties['room_type']
@property
def room_status(self):
"""
:returns: The room_status
:rtype: RoomInstance.RoomStatus
"""
return self._properties['room_status']
@property
def status_callback(self):
"""
:returns: The status_callback
:rtype: unicode
"""
return self._properties['status_callback']
@property
def status_callback_method(self):
"""
:returns: The status_callback_method
:rtype: unicode
"""
return self._properties['status_callback_method']
@property
def created_method(self):
"""
:returns: The created_method
:rtype: RoomInstance.CreatedMethod
"""
return self._properties['created_method']
@property
def end_reason(self):
"""
:returns: The end_reason
:rtype: RoomInstance.EndReason
"""
return self._properties['end_reason']
@property
def max_participants(self):
"""
:returns: The max_participants
:rtype: unicode
"""
return self._properties['max_participants']
@property
def unique_participants(self):
"""
:returns: The unique_participants
:rtype: unicode
"""
return self._properties['unique_participants']
@property
def unique_participant_identities(self):
"""
:returns: The unique_participant_identities
:rtype: unicode
"""
return self._properties['unique_participant_identities']
@property
def concurrent_participants(self):
"""
:returns: The concurrent_participants
:rtype: unicode
"""
return self._properties['concurrent_participants']
@property
def max_concurrent_participants(self):
"""
:returns: The max_concurrent_participants
:rtype: unicode
"""
return self._properties['max_concurrent_participants']
@property
def codecs(self):
"""
:returns: The codecs
:rtype: list[RoomInstance.Codec]
"""
return self._properties['codecs']
@property
def media_region(self):
"""
:returns: The media_region
:rtype: RoomInstance.TwilioRealm
"""
return self._properties['media_region']
@property
def duration_sec(self):
"""
:returns: The duration_sec
:rtype: unicode
"""
return self._properties['duration_sec']
@property
def total_participant_duration_sec(self):
"""
:returns: The total_participant_duration_sec
:rtype: unicode
"""
return self._properties['total_participant_duration_sec']
@property
def total_recording_duration_sec(self):
"""
:returns: The total_recording_duration_sec
:rtype: unicode
"""
return self._properties['total_recording_duration_sec']
@property
def processing_state(self):
"""
:returns: The processing_state
:rtype: RoomInstance.ProcessingState
"""
return self._properties['processing_state']
@property
def recording_enabled(self):
"""
:returns: The recording_enabled
:rtype: bool
"""
return self._properties['recording_enabled']
@property
def edge_location(self):
"""
:returns: The edge_location
:rtype: RoomInstance.EdgeLocation
"""
return self._properties['edge_location']
@property
def url(self):
"""
:returns: The url
:rtype: unicode
"""
return self._properties['url']
@property
def links(self):
"""
:returns: The links
:rtype: unicode
"""
return self._properties['links']
def fetch(self):
"""
Fetch the RoomInstance
:returns: The fetched RoomInstance
:rtype: twilio.rest.insights.v1.room.RoomInstance
"""
return self._proxy.fetch()
@property
def participants(self):
"""
Access the participants
:returns: twilio.rest.insights.v1.room.participant.ParticipantList
:rtype: twilio.rest.insights.v1.room.participant.ParticipantList
"""
return self._proxy.participants
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.Insights.V1.RoomInstance {}>'.format(context)
|