r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Chat 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_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 MemberInstance(InstanceResource): class WebhookEnabledType(object): TRUE = "true" FALSE = "false" """ :ivar sid: The unique string that we created to identify the Member resource. :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource. :ivar channel_sid: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource belongs to. :ivar service_sid: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Member resource is associated with. :ivar identity: The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. :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 role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the member. :ivar last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. :ivar last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :ivar url: The absolute URL of the Member resource. :ivar attributes: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. """ def __init__( self, version: Version, payload: Dict[str, Any], service_sid: str, channel_sid: str, sid: Optional[str] = None, ): super().__init__(version) self.sid: Optional[str] = payload.get("sid") self.account_sid: Optional[str] = payload.get("account_sid") self.channel_sid: Optional[str] = payload.get("channel_sid") self.service_sid: Optional[str] = payload.get("service_sid") self.identity: Optional[str] = payload.get("identity") 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.role_sid: Optional[str] = payload.get("role_sid") self.last_consumed_message_index: Optional[int] = deserialize.integer( payload.get("last_consumed_message_index") ) self.last_consumption_timestamp: Optional[ datetime ] = deserialize.iso8601_datetime(payload.get("last_consumption_timestamp")) self.url: Optional[str] = payload.get("url") self.attributes: Optional[str] = payload.get("attributes") self._solution = { "service_sid": service_sid, "channel_sid": channel_sid, "sid": sid or self.sid, } self._context: Optional[MemberContext] = None @property def _proxy(self) -> "MemberContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: MemberContext for this MemberInstance """ if self._context is None: self._context = MemberContext( self._version, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], sid=self._solution["sid"], ) return self._context def delete( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, ) -> bool: """ Deletes the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: True if delete succeeds, False otherwise """ return self._proxy.delete( x_twilio_webhook_enabled=x_twilio_webhook_enabled, ) async def delete_async( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, ) -> bool: """ Asynchronous coroutine that deletes the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: True if delete succeeds, False otherwise """ return await self._proxy.delete_async( x_twilio_webhook_enabled=x_twilio_webhook_enabled, ) def fetch(self) -> "MemberInstance": """ Fetch the MemberInstance :returns: The fetched MemberInstance """ return self._proxy.fetch() async def fetch_async(self) -> "MemberInstance": """ Asynchronous coroutine to fetch the MemberInstance :returns: The fetched MemberInstance """ return await self._proxy.fetch_async() def update( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, role_sid: Union[str, object] = values.unset, last_consumed_message_index: Union[int, object] = values.unset, last_consumption_timestamp: Union[datetime, object] = values.unset, date_created: Union[datetime, object] = values.unset, date_updated: Union[datetime, object] = values.unset, attributes: Union[str, object] = values.unset, ) -> "MemberInstance": """ Update the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :param role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). :param last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). :param last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :param date_created: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. :param date_updated: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. :param attributes: A valid JSON string that contains application-specific data. :returns: The updated MemberInstance """ return self._proxy.update( x_twilio_webhook_enabled=x_twilio_webhook_enabled, role_sid=role_sid, last_consumed_message_index=last_consumed_message_index, last_consumption_timestamp=last_consumption_timestamp, date_created=date_created, date_updated=date_updated, attributes=attributes, ) async def update_async( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, role_sid: Union[str, object] = values.unset, last_consumed_message_index: Union[int, object] = values.unset, last_consumption_timestamp: Union[datetime, object] = values.unset, date_created: Union[datetime, object] = values.unset, date_updated: Union[datetime, object] = values.unset, attributes: Union[str, object] = values.unset, ) -> "MemberInstance": """ Asynchronous coroutine to update the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :param role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). :param last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). :param last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :param date_created: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. :param date_updated: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. :param attributes: A valid JSON string that contains application-specific data. :returns: The updated MemberInstance """ return await self._proxy.update_async( x_twilio_webhook_enabled=x_twilio_webhook_enabled, role_sid=role_sid, last_consumed_message_index=last_consumed_message_index, last_consumption_timestamp=last_consumption_timestamp, date_created=date_created, date_updated=date_updated, attributes=attributes, ) 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 "".format(context) class MemberContext(InstanceContext): def __init__(self, version: Version, service_sid: str, channel_sid: str, sid: str): """ Initialize the MemberContext :param version: Version that contains the resource :param service_sid: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Member resource in. :param channel_sid: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`. :param sid: The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value. """ super().__init__(version) # Path Solution self._solution = { "service_sid": service_sid, "channel_sid": channel_sid, "sid": sid, } self._uri = ( "/Services/{service_sid}/Channels/{channel_sid}/Members/{sid}".format( **self._solution ) ) def delete( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, ) -> bool: """ Deletes the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: True if delete succeeds, False otherwise """ headers = values.of( { "X-Twilio-Webhook-Enabled": x_twilio_webhook_enabled, } ) return self._version.delete(method="DELETE", uri=self._uri, headers=headers) async def delete_async( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, ) -> bool: """ Asynchronous coroutine that deletes the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: True if delete succeeds, False otherwise """ headers = values.of( { "X-Twilio-Webhook-Enabled": x_twilio_webhook_enabled, } ) return await self._version.delete_async( method="DELETE", uri=self._uri, headers=headers ) def fetch(self) -> MemberInstance: """ Fetch the MemberInstance :returns: The fetched MemberInstance """ payload = self._version.fetch( method="GET", uri=self._uri, ) return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], sid=self._solution["sid"], ) async def fetch_async(self) -> MemberInstance: """ Asynchronous coroutine to fetch the MemberInstance :returns: The fetched MemberInstance """ payload = await self._version.fetch_async( method="GET", uri=self._uri, ) return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], sid=self._solution["sid"], ) def update( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, role_sid: Union[str, object] = values.unset, last_consumed_message_index: Union[int, object] = values.unset, last_consumption_timestamp: Union[datetime, object] = values.unset, date_created: Union[datetime, object] = values.unset, date_updated: Union[datetime, object] = values.unset, attributes: Union[str, object] = values.unset, ) -> MemberInstance: """ Update the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :param role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). :param last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). :param last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :param date_created: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. :param date_updated: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. :param attributes: A valid JSON string that contains application-specific data. :returns: The updated MemberInstance """ data = values.of( { "RoleSid": role_sid, "LastConsumedMessageIndex": last_consumed_message_index, "LastConsumptionTimestamp": serialize.iso8601_datetime( last_consumption_timestamp ), "DateCreated": serialize.iso8601_datetime(date_created), "DateUpdated": serialize.iso8601_datetime(date_updated), "Attributes": attributes, } ) headers = values.of( { "X-Twilio-Webhook-Enabled": x_twilio_webhook_enabled, } ) payload = self._version.update( method="POST", uri=self._uri, data=data, headers=headers ) return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], sid=self._solution["sid"], ) async def update_async( self, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, role_sid: Union[str, object] = values.unset, last_consumed_message_index: Union[int, object] = values.unset, last_consumption_timestamp: Union[datetime, object] = values.unset, date_created: Union[datetime, object] = values.unset, date_updated: Union[datetime, object] = values.unset, attributes: Union[str, object] = values.unset, ) -> MemberInstance: """ Asynchronous coroutine to update the MemberInstance :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :param role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). :param last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). :param last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :param date_created: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. :param date_updated: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. :param attributes: A valid JSON string that contains application-specific data. :returns: The updated MemberInstance """ data = values.of( { "RoleSid": role_sid, "LastConsumedMessageIndex": last_consumed_message_index, "LastConsumptionTimestamp": serialize.iso8601_datetime( last_consumption_timestamp ), "DateCreated": serialize.iso8601_datetime(date_created), "DateUpdated": serialize.iso8601_datetime(date_updated), "Attributes": attributes, } ) headers = values.of( { "X-Twilio-Webhook-Enabled": x_twilio_webhook_enabled, } ) payload = await self._version.update_async( method="POST", uri=self._uri, data=data, headers=headers ) return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_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 "".format(context) class MemberPage(Page): def get_instance(self, payload: Dict[str, Any]) -> MemberInstance: """ Build an instance of MemberInstance :param payload: Payload response from the API """ return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class MemberList(ListResource): def __init__(self, version: Version, service_sid: str, channel_sid: str): """ Initialize the MemberList :param version: Version that contains the resource :param service_sid: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Member resources from. :param channel_sid: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`. """ super().__init__(version) # Path Solution self._solution = { "service_sid": service_sid, "channel_sid": channel_sid, } self._uri = "/Services/{service_sid}/Channels/{channel_sid}/Members".format( **self._solution ) def create( self, identity: str, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, role_sid: Union[str, object] = values.unset, last_consumed_message_index: Union[int, object] = values.unset, last_consumption_timestamp: Union[datetime, object] = values.unset, date_created: Union[datetime, object] = values.unset, date_updated: Union[datetime, object] = values.unset, attributes: Union[str, object] = values.unset, ) -> MemberInstance: """ Create the MemberInstance :param identity: The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :param role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). :param last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source. :param last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :param date_created: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. :param date_updated: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated. :param attributes: A valid JSON string that contains application-specific data. :returns: The created MemberInstance """ data = values.of( { "Identity": identity, "RoleSid": role_sid, "LastConsumedMessageIndex": last_consumed_message_index, "LastConsumptionTimestamp": serialize.iso8601_datetime( last_consumption_timestamp ), "DateCreated": serialize.iso8601_datetime(date_created), "DateUpdated": serialize.iso8601_datetime(date_updated), "Attributes": attributes, } ) headers = values.of( { "X-Twilio-Webhook-Enabled": x_twilio_webhook_enabled, } ) payload = self._version.create( method="POST", uri=self._uri, data=data, headers=headers ) return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], ) async def create_async( self, identity: str, x_twilio_webhook_enabled: Union[ "MemberInstance.WebhookEnabledType", object ] = values.unset, role_sid: Union[str, object] = values.unset, last_consumed_message_index: Union[int, object] = values.unset, last_consumption_timestamp: Union[datetime, object] = values.unset, date_created: Union[datetime, object] = values.unset, date_updated: Union[datetime, object] = values.unset, attributes: Union[str, object] = values.unset, ) -> MemberInstance: """ Asynchronously create the MemberInstance :param identity: The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. :param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :param role_sid: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). :param last_consumed_message_index: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source. :param last_consumption_timestamp: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). :param date_created: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. :param date_updated: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated. :param attributes: A valid JSON string that contains application-specific data. :returns: The created MemberInstance """ data = values.of( { "Identity": identity, "RoleSid": role_sid, "LastConsumedMessageIndex": last_consumed_message_index, "LastConsumptionTimestamp": serialize.iso8601_datetime( last_consumption_timestamp ), "DateCreated": serialize.iso8601_datetime(date_created), "DateUpdated": serialize.iso8601_datetime(date_updated), "Attributes": attributes, } ) headers = values.of( { "X-Twilio-Webhook-Enabled": x_twilio_webhook_enabled, } ) payload = await self._version.create_async( method="POST", uri=self._uri, data=data, headers=headers ) return MemberInstance( self._version, payload, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], ) def stream( self, identity: Union[List[str], object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[MemberInstance]: """ Streams MemberInstance 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[str] identity: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. :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(identity=identity, page_size=limits["page_size"]) return self._version.stream(page, limits["limit"]) async def stream_async( self, identity: Union[List[str], object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[MemberInstance]: """ Asynchronously streams MemberInstance 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[str] identity: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. :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(identity=identity, page_size=limits["page_size"]) return self._version.stream_async(page, limits["limit"]) def list( self, identity: Union[List[str], object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[MemberInstance]: """ Lists MemberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param List[str] identity: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. :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( identity=identity, limit=limit, page_size=page_size, ) ) async def list_async( self, identity: Union[List[str], object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[MemberInstance]: """ Asynchronously lists MemberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param List[str] identity: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. :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( identity=identity, limit=limit, page_size=page_size, ) ] def page( self, identity: Union[List[str], object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> MemberPage: """ Retrieve a single page of MemberInstance records from the API. Request is executed immediately :param identity: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. :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 MemberInstance """ data = values.of( { "Identity": serialize.map(identity, lambda e: e), "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return MemberPage(self._version, response, self._solution) async def page_async( self, identity: Union[List[str], object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> MemberPage: """ Asynchronously retrieve a single page of MemberInstance records from the API. Request is executed immediately :param identity: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. :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 MemberInstance """ data = values.of( { "Identity": serialize.map(identity, lambda e: e), "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return MemberPage(self._version, response, self._solution) def get_page(self, target_url: str) -> MemberPage: """ Retrieve a specific page of MemberInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of MemberInstance """ response = self._version.domain.twilio.request("GET", target_url) return MemberPage(self._version, response, self._solution) async def get_page_async(self, target_url: str) -> MemberPage: """ Asynchronously retrieve a specific page of MemberInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of MemberInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return MemberPage(self._version, response, self._solution) def get(self, sid: str) -> MemberContext: """ Constructs a MemberContext :param sid: The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value. """ return MemberContext( self._version, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], sid=sid, ) def __call__(self, sid: str) -> MemberContext: """ Constructs a MemberContext :param sid: The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value. """ return MemberContext( self._version, service_sid=self._solution["service_sid"], channel_sid=self._solution["channel_sid"], sid=sid, ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""