File: C:/Users/fred/anaconda3/Lib/site-packages/twilio/rest/video/v1/room/participant/published_track.py
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Video
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, 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.version import Version
from twilio.base.page import Page
class PublishedTrackInstance(InstanceResource):
class Kind(object):
AUDIO = "audio"
VIDEO = "video"
DATA = "data"
"""
:ivar sid: The unique string that we created to identify the RoomParticipantPublishedTrack resource.
:ivar participant_sid: The SID of the Participant resource with the published track.
:ivar room_sid: The SID of the Room resource where the track is published.
:ivar name: The track name. Must be no more than 128 characters, and be unique among the participant's published tracks.
:ivar date_created: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar date_updated: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar enabled: Whether the track is enabled.
:ivar kind:
:ivar url: The absolute URL of the resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
room_sid: str,
participant_sid: str,
sid: Optional[str] = None,
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.participant_sid: Optional[str] = payload.get("participant_sid")
self.room_sid: Optional[str] = payload.get("room_sid")
self.name: Optional[str] = payload.get("name")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_updated")
)
self.enabled: Optional[bool] = payload.get("enabled")
self.kind: Optional["PublishedTrackInstance.Kind"] = payload.get("kind")
self.url: Optional[str] = payload.get("url")
self._solution = {
"room_sid": room_sid,
"participant_sid": participant_sid,
"sid": sid or self.sid,
}
self._context: Optional[PublishedTrackContext] = None
@property
def _proxy(self) -> "PublishedTrackContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: PublishedTrackContext for this PublishedTrackInstance
"""
if self._context is None:
self._context = PublishedTrackContext(
self._version,
room_sid=self._solution["room_sid"],
participant_sid=self._solution["participant_sid"],
sid=self._solution["sid"],
)
return self._context
def fetch(self) -> "PublishedTrackInstance":
"""
Fetch the PublishedTrackInstance
:returns: The fetched PublishedTrackInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "PublishedTrackInstance":
"""
Asynchronous coroutine to fetch the PublishedTrackInstance
:returns: The fetched PublishedTrackInstance
"""
return await self._proxy.fetch_async()
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Video.V1.PublishedTrackInstance {}>".format(context)
class PublishedTrackContext(InstanceContext):
def __init__(self, version: Version, room_sid: str, participant_sid: str, sid: str):
"""
Initialize the PublishedTrackContext
:param version: Version that contains the resource
:param room_sid: The SID of the Room resource where the Track resource to fetch is published.
:param participant_sid: The SID of the Participant resource with the published track to fetch.
:param sid: The SID of the RoomParticipantPublishedTrack resource to fetch.
"""
super().__init__(version)
# Path Solution
self._solution = {
"room_sid": room_sid,
"participant_sid": participant_sid,
"sid": sid,
}
self._uri = "/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks/{sid}".format(
**self._solution
)
def fetch(self) -> PublishedTrackInstance:
"""
Fetch the PublishedTrackInstance
:returns: The fetched PublishedTrackInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return PublishedTrackInstance(
self._version,
payload,
room_sid=self._solution["room_sid"],
participant_sid=self._solution["participant_sid"],
sid=self._solution["sid"],
)
async def fetch_async(self) -> PublishedTrackInstance:
"""
Asynchronous coroutine to fetch the PublishedTrackInstance
:returns: The fetched PublishedTrackInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return PublishedTrackInstance(
self._version,
payload,
room_sid=self._solution["room_sid"],
participant_sid=self._solution["participant_sid"],
sid=self._solution["sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Video.V1.PublishedTrackContext {}>".format(context)
class PublishedTrackPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> PublishedTrackInstance:
"""
Build an instance of PublishedTrackInstance
:param payload: Payload response from the API
"""
return PublishedTrackInstance(
self._version,
payload,
room_sid=self._solution["room_sid"],
participant_sid=self._solution["participant_sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Video.V1.PublishedTrackPage>"
class PublishedTrackList(ListResource):
def __init__(self, version: Version, room_sid: str, participant_sid: str):
"""
Initialize the PublishedTrackList
:param version: Version that contains the resource
:param room_sid: The SID of the Room resource where the Track resources to read are published.
:param participant_sid: The SID of the Participant resource with the published tracks to read.
"""
super().__init__(version)
# Path Solution
self._solution = {
"room_sid": room_sid,
"participant_sid": participant_sid,
}
self._uri = (
"/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks".format(
**self._solution
)
)
def stream(
self,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[PublishedTrackInstance]:
"""
Streams PublishedTrackInstance 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 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(page_size=limits["page_size"])
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[PublishedTrackInstance]:
"""
Asynchronously streams PublishedTrackInstance 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 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(page_size=limits["page_size"])
return self._version.stream_async(page, limits["limit"])
def list(
self,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[PublishedTrackInstance]:
"""
Lists PublishedTrackInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
: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(
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[PublishedTrackInstance]:
"""
Asynchronously lists PublishedTrackInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
: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(
limit=limit,
page_size=page_size,
)
]
def page(
self,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> PublishedTrackPage:
"""
Retrieve a single page of PublishedTrackInstance records from the API.
Request is executed immediately
: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 PublishedTrackInstance
"""
data = values.of(
{
"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 PublishedTrackPage(self._version, response, self._solution)
async def page_async(
self,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> PublishedTrackPage:
"""
Asynchronously retrieve a single page of PublishedTrackInstance records from the API.
Request is executed immediately
: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 PublishedTrackInstance
"""
data = values.of(
{
"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 PublishedTrackPage(self._version, response, self._solution)
def get_page(self, target_url: str) -> PublishedTrackPage:
"""
Retrieve a specific page of PublishedTrackInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of PublishedTrackInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return PublishedTrackPage(self._version, response, self._solution)
async def get_page_async(self, target_url: str) -> PublishedTrackPage:
"""
Asynchronously retrieve a specific page of PublishedTrackInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of PublishedTrackInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return PublishedTrackPage(self._version, response, self._solution)
def get(self, sid: str) -> PublishedTrackContext:
"""
Constructs a PublishedTrackContext
:param sid: The SID of the RoomParticipantPublishedTrack resource to fetch.
"""
return PublishedTrackContext(
self._version,
room_sid=self._solution["room_sid"],
participant_sid=self._solution["participant_sid"],
sid=sid,
)
def __call__(self, sid: str) -> PublishedTrackContext:
"""
Constructs a PublishedTrackContext
:param sid: The SID of the RoomParticipantPublishedTrack resource to fetch.
"""
return PublishedTrackContext(
self._version,
room_sid=self._solution["room_sid"],
participant_sid=self._solution["participant_sid"],
sid=sid,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Video.V1.PublishedTrackList>"