r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Messaging 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 from twilio.rest.messaging.v1.service.alpha_sender import AlphaSenderList from twilio.rest.messaging.v1.service.phone_number import PhoneNumberList from twilio.rest.messaging.v1.service.short_code import ShortCodeList from twilio.rest.messaging.v1.service.us_app_to_person import UsAppToPersonList from twilio.rest.messaging.v1.service.us_app_to_person_usecase import ( UsAppToPersonUsecaseList, ) class ServiceInstance(InstanceResource): class ScanMessageContent(object): INHERIT = "inherit" ENABLE = "enable" DISABLE = "disable" """ :ivar sid: The unique string that we created to identify the Service resource. :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. :ivar friendly_name: The string that you assigned to describe the resource. :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 inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :ivar inbound_method: The HTTP method we use to call `inbound_request_url`. Can be `GET` or `POST`. :ivar fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :ivar fallback_method: The HTTP method we use to call `fallback_url`. Can be: `GET` or `POST`. :ivar status_callback: The URL we call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :ivar sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :ivar mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :ivar smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :ivar scan_message_content: :ivar fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :ivar area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :ivar synchronous_validation: Reserved. :ivar validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :ivar url: The absolute URL of the Service resource. :ivar links: The absolute URLs of related resources. :ivar usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..] :ivar us_app_to_person_registered: Whether US A2P campaign is registered for this Service. :ivar use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. """ def __init__( self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None ): super().__init__(version) self.sid: Optional[str] = payload.get("sid") self.account_sid: Optional[str] = payload.get("account_sid") self.friendly_name: Optional[str] = payload.get("friendly_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.inbound_request_url: Optional[str] = payload.get("inbound_request_url") self.inbound_method: Optional[str] = payload.get("inbound_method") self.fallback_url: Optional[str] = payload.get("fallback_url") self.fallback_method: Optional[str] = payload.get("fallback_method") self.status_callback: Optional[str] = payload.get("status_callback") self.sticky_sender: Optional[bool] = payload.get("sticky_sender") self.mms_converter: Optional[bool] = payload.get("mms_converter") self.smart_encoding: Optional[bool] = payload.get("smart_encoding") self.scan_message_content: Optional[ "ServiceInstance.ScanMessageContent" ] = payload.get("scan_message_content") self.fallback_to_long_code: Optional[bool] = payload.get( "fallback_to_long_code" ) self.area_code_geomatch: Optional[bool] = payload.get("area_code_geomatch") self.synchronous_validation: Optional[bool] = payload.get( "synchronous_validation" ) self.validity_period: Optional[int] = deserialize.integer( payload.get("validity_period") ) self.url: Optional[str] = payload.get("url") self.links: Optional[Dict[str, object]] = payload.get("links") self.usecase: Optional[str] = payload.get("usecase") self.us_app_to_person_registered: Optional[bool] = payload.get( "us_app_to_person_registered" ) self.use_inbound_webhook_on_number: Optional[bool] = payload.get( "use_inbound_webhook_on_number" ) self._solution = { "sid": sid or self.sid, } self._context: Optional[ServiceContext] = None @property def _proxy(self) -> "ServiceContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: ServiceContext for this ServiceInstance """ if self._context is None: self._context = ServiceContext( self._version, sid=self._solution["sid"], ) return self._context def delete(self) -> bool: """ Deletes the ServiceInstance :returns: True if delete succeeds, False otherwise """ return self._proxy.delete() async def delete_async(self) -> bool: """ Asynchronous coroutine that deletes the ServiceInstance :returns: True if delete succeeds, False otherwise """ return await self._proxy.delete_async() def fetch(self) -> "ServiceInstance": """ Fetch the ServiceInstance :returns: The fetched ServiceInstance """ return self._proxy.fetch() async def fetch_async(self) -> "ServiceInstance": """ Asynchronous coroutine to fetch the ServiceInstance :returns: The fetched ServiceInstance """ return await self._proxy.fetch_async() def update( self, friendly_name: Union[str, object] = values.unset, inbound_request_url: Union[str, object] = values.unset, inbound_method: Union[str, object] = values.unset, fallback_url: Union[str, object] = values.unset, fallback_method: Union[str, object] = values.unset, status_callback: Union[str, object] = values.unset, sticky_sender: Union[bool, object] = values.unset, mms_converter: Union[bool, object] = values.unset, smart_encoding: Union[bool, object] = values.unset, scan_message_content: Union[ "ServiceInstance.ScanMessageContent", object ] = values.unset, fallback_to_long_code: Union[bool, object] = values.unset, area_code_geomatch: Union[bool, object] = values.unset, validity_period: Union[int, object] = values.unset, synchronous_validation: Union[bool, object] = values.unset, usecase: Union[str, object] = values.unset, use_inbound_webhook_on_number: Union[bool, object] = values.unset, ) -> "ServiceInstance": """ Update the ServiceInstance :param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long. :param inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :param inbound_method: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. :param fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :param fallback_method: The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. :param status_callback: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :param sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :param mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :param smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :param scan_message_content: :param fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :param area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :param validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :param synchronous_validation: Reserved. :param usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..] :param use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. :returns: The updated ServiceInstance """ return self._proxy.update( friendly_name=friendly_name, inbound_request_url=inbound_request_url, inbound_method=inbound_method, fallback_url=fallback_url, fallback_method=fallback_method, status_callback=status_callback, sticky_sender=sticky_sender, mms_converter=mms_converter, smart_encoding=smart_encoding, scan_message_content=scan_message_content, fallback_to_long_code=fallback_to_long_code, area_code_geomatch=area_code_geomatch, validity_period=validity_period, synchronous_validation=synchronous_validation, usecase=usecase, use_inbound_webhook_on_number=use_inbound_webhook_on_number, ) async def update_async( self, friendly_name: Union[str, object] = values.unset, inbound_request_url: Union[str, object] = values.unset, inbound_method: Union[str, object] = values.unset, fallback_url: Union[str, object] = values.unset, fallback_method: Union[str, object] = values.unset, status_callback: Union[str, object] = values.unset, sticky_sender: Union[bool, object] = values.unset, mms_converter: Union[bool, object] = values.unset, smart_encoding: Union[bool, object] = values.unset, scan_message_content: Union[ "ServiceInstance.ScanMessageContent", object ] = values.unset, fallback_to_long_code: Union[bool, object] = values.unset, area_code_geomatch: Union[bool, object] = values.unset, validity_period: Union[int, object] = values.unset, synchronous_validation: Union[bool, object] = values.unset, usecase: Union[str, object] = values.unset, use_inbound_webhook_on_number: Union[bool, object] = values.unset, ) -> "ServiceInstance": """ Asynchronous coroutine to update the ServiceInstance :param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long. :param inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :param inbound_method: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. :param fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :param fallback_method: The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. :param status_callback: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :param sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :param mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :param smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :param scan_message_content: :param fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :param area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :param validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :param synchronous_validation: Reserved. :param usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..] :param use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. :returns: The updated ServiceInstance """ return await self._proxy.update_async( friendly_name=friendly_name, inbound_request_url=inbound_request_url, inbound_method=inbound_method, fallback_url=fallback_url, fallback_method=fallback_method, status_callback=status_callback, sticky_sender=sticky_sender, mms_converter=mms_converter, smart_encoding=smart_encoding, scan_message_content=scan_message_content, fallback_to_long_code=fallback_to_long_code, area_code_geomatch=area_code_geomatch, validity_period=validity_period, synchronous_validation=synchronous_validation, usecase=usecase, use_inbound_webhook_on_number=use_inbound_webhook_on_number, ) @property def alpha_senders(self) -> AlphaSenderList: """ Access the alpha_senders """ return self._proxy.alpha_senders @property def phone_numbers(self) -> PhoneNumberList: """ Access the phone_numbers """ return self._proxy.phone_numbers @property def short_codes(self) -> ShortCodeList: """ Access the short_codes """ return self._proxy.short_codes @property def us_app_to_person(self) -> UsAppToPersonList: """ Access the us_app_to_person """ return self._proxy.us_app_to_person @property def us_app_to_person_usecases(self) -> UsAppToPersonUsecaseList: """ Access the us_app_to_person_usecases """ return self._proxy.us_app_to_person_usecases 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 ServiceContext(InstanceContext): def __init__(self, version: Version, sid: str): """ Initialize the ServiceContext :param version: Version that contains the resource :param sid: The SID of the Service resource to update. """ super().__init__(version) # Path Solution self._solution = { "sid": sid, } self._uri = "/Services/{sid}".format(**self._solution) self._alpha_senders: Optional[AlphaSenderList] = None self._phone_numbers: Optional[PhoneNumberList] = None self._short_codes: Optional[ShortCodeList] = None self._us_app_to_person: Optional[UsAppToPersonList] = None self._us_app_to_person_usecases: Optional[UsAppToPersonUsecaseList] = None def delete(self) -> bool: """ Deletes the ServiceInstance :returns: True if delete succeeds, False otherwise """ return self._version.delete( method="DELETE", uri=self._uri, ) async def delete_async(self) -> bool: """ Asynchronous coroutine that deletes the ServiceInstance :returns: True if delete succeeds, False otherwise """ return await self._version.delete_async( method="DELETE", uri=self._uri, ) def fetch(self) -> ServiceInstance: """ Fetch the ServiceInstance :returns: The fetched ServiceInstance """ payload = self._version.fetch( method="GET", uri=self._uri, ) return ServiceInstance( self._version, payload, sid=self._solution["sid"], ) async def fetch_async(self) -> ServiceInstance: """ Asynchronous coroutine to fetch the ServiceInstance :returns: The fetched ServiceInstance """ payload = await self._version.fetch_async( method="GET", uri=self._uri, ) return ServiceInstance( self._version, payload, sid=self._solution["sid"], ) def update( self, friendly_name: Union[str, object] = values.unset, inbound_request_url: Union[str, object] = values.unset, inbound_method: Union[str, object] = values.unset, fallback_url: Union[str, object] = values.unset, fallback_method: Union[str, object] = values.unset, status_callback: Union[str, object] = values.unset, sticky_sender: Union[bool, object] = values.unset, mms_converter: Union[bool, object] = values.unset, smart_encoding: Union[bool, object] = values.unset, scan_message_content: Union[ "ServiceInstance.ScanMessageContent", object ] = values.unset, fallback_to_long_code: Union[bool, object] = values.unset, area_code_geomatch: Union[bool, object] = values.unset, validity_period: Union[int, object] = values.unset, synchronous_validation: Union[bool, object] = values.unset, usecase: Union[str, object] = values.unset, use_inbound_webhook_on_number: Union[bool, object] = values.unset, ) -> ServiceInstance: """ Update the ServiceInstance :param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long. :param inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :param inbound_method: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. :param fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :param fallback_method: The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. :param status_callback: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :param sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :param mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :param smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :param scan_message_content: :param fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :param area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :param validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :param synchronous_validation: Reserved. :param usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..] :param use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. :returns: The updated ServiceInstance """ data = values.of( { "FriendlyName": friendly_name, "InboundRequestUrl": inbound_request_url, "InboundMethod": inbound_method, "FallbackUrl": fallback_url, "FallbackMethod": fallback_method, "StatusCallback": status_callback, "StickySender": sticky_sender, "MmsConverter": mms_converter, "SmartEncoding": smart_encoding, "ScanMessageContent": scan_message_content, "FallbackToLongCode": fallback_to_long_code, "AreaCodeGeomatch": area_code_geomatch, "ValidityPeriod": validity_period, "SynchronousValidation": synchronous_validation, "Usecase": usecase, "UseInboundWebhookOnNumber": use_inbound_webhook_on_number, } ) payload = self._version.update( method="POST", uri=self._uri, data=data, ) return ServiceInstance(self._version, payload, sid=self._solution["sid"]) async def update_async( self, friendly_name: Union[str, object] = values.unset, inbound_request_url: Union[str, object] = values.unset, inbound_method: Union[str, object] = values.unset, fallback_url: Union[str, object] = values.unset, fallback_method: Union[str, object] = values.unset, status_callback: Union[str, object] = values.unset, sticky_sender: Union[bool, object] = values.unset, mms_converter: Union[bool, object] = values.unset, smart_encoding: Union[bool, object] = values.unset, scan_message_content: Union[ "ServiceInstance.ScanMessageContent", object ] = values.unset, fallback_to_long_code: Union[bool, object] = values.unset, area_code_geomatch: Union[bool, object] = values.unset, validity_period: Union[int, object] = values.unset, synchronous_validation: Union[bool, object] = values.unset, usecase: Union[str, object] = values.unset, use_inbound_webhook_on_number: Union[bool, object] = values.unset, ) -> ServiceInstance: """ Asynchronous coroutine to update the ServiceInstance :param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long. :param inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :param inbound_method: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. :param fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :param fallback_method: The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. :param status_callback: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :param sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :param mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :param smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :param scan_message_content: :param fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :param area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :param validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :param synchronous_validation: Reserved. :param usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..] :param use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. :returns: The updated ServiceInstance """ data = values.of( { "FriendlyName": friendly_name, "InboundRequestUrl": inbound_request_url, "InboundMethod": inbound_method, "FallbackUrl": fallback_url, "FallbackMethod": fallback_method, "StatusCallback": status_callback, "StickySender": sticky_sender, "MmsConverter": mms_converter, "SmartEncoding": smart_encoding, "ScanMessageContent": scan_message_content, "FallbackToLongCode": fallback_to_long_code, "AreaCodeGeomatch": area_code_geomatch, "ValidityPeriod": validity_period, "SynchronousValidation": synchronous_validation, "Usecase": usecase, "UseInboundWebhookOnNumber": use_inbound_webhook_on_number, } ) payload = await self._version.update_async( method="POST", uri=self._uri, data=data, ) return ServiceInstance(self._version, payload, sid=self._solution["sid"]) @property def alpha_senders(self) -> AlphaSenderList: """ Access the alpha_senders """ if self._alpha_senders is None: self._alpha_senders = AlphaSenderList( self._version, self._solution["sid"], ) return self._alpha_senders @property def phone_numbers(self) -> PhoneNumberList: """ Access the phone_numbers """ if self._phone_numbers is None: self._phone_numbers = PhoneNumberList( self._version, self._solution["sid"], ) return self._phone_numbers @property def short_codes(self) -> ShortCodeList: """ Access the short_codes """ if self._short_codes is None: self._short_codes = ShortCodeList( self._version, self._solution["sid"], ) return self._short_codes @property def us_app_to_person(self) -> UsAppToPersonList: """ Access the us_app_to_person """ if self._us_app_to_person is None: self._us_app_to_person = UsAppToPersonList( self._version, self._solution["sid"], ) return self._us_app_to_person @property def us_app_to_person_usecases(self) -> UsAppToPersonUsecaseList: """ Access the us_app_to_person_usecases """ if self._us_app_to_person_usecases is None: self._us_app_to_person_usecases = UsAppToPersonUsecaseList( self._version, self._solution["sid"], ) return self._us_app_to_person_usecases 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 ServicePage(Page): def get_instance(self, payload: Dict[str, Any]) -> ServiceInstance: """ Build an instance of ServiceInstance :param payload: Payload response from the API """ return ServiceInstance(self._version, payload) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class ServiceList(ListResource): def __init__(self, version: Version): """ Initialize the ServiceList :param version: Version that contains the resource """ super().__init__(version) self._uri = "/Services" def create( self, friendly_name: str, inbound_request_url: Union[str, object] = values.unset, inbound_method: Union[str, object] = values.unset, fallback_url: Union[str, object] = values.unset, fallback_method: Union[str, object] = values.unset, status_callback: Union[str, object] = values.unset, sticky_sender: Union[bool, object] = values.unset, mms_converter: Union[bool, object] = values.unset, smart_encoding: Union[bool, object] = values.unset, scan_message_content: Union[ "ServiceInstance.ScanMessageContent", object ] = values.unset, fallback_to_long_code: Union[bool, object] = values.unset, area_code_geomatch: Union[bool, object] = values.unset, validity_period: Union[int, object] = values.unset, synchronous_validation: Union[bool, object] = values.unset, usecase: Union[str, object] = values.unset, use_inbound_webhook_on_number: Union[bool, object] = values.unset, ) -> ServiceInstance: """ Create the ServiceInstance :param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long. :param inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :param inbound_method: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. :param fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :param fallback_method: The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. :param status_callback: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :param sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :param mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :param smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :param scan_message_content: :param fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :param area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :param validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :param synchronous_validation: Reserved. :param usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]. :param use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. :returns: The created ServiceInstance """ data = values.of( { "FriendlyName": friendly_name, "InboundRequestUrl": inbound_request_url, "InboundMethod": inbound_method, "FallbackUrl": fallback_url, "FallbackMethod": fallback_method, "StatusCallback": status_callback, "StickySender": sticky_sender, "MmsConverter": mms_converter, "SmartEncoding": smart_encoding, "ScanMessageContent": scan_message_content, "FallbackToLongCode": fallback_to_long_code, "AreaCodeGeomatch": area_code_geomatch, "ValidityPeriod": validity_period, "SynchronousValidation": synchronous_validation, "Usecase": usecase, "UseInboundWebhookOnNumber": use_inbound_webhook_on_number, } ) payload = self._version.create( method="POST", uri=self._uri, data=data, ) return ServiceInstance(self._version, payload) async def create_async( self, friendly_name: str, inbound_request_url: Union[str, object] = values.unset, inbound_method: Union[str, object] = values.unset, fallback_url: Union[str, object] = values.unset, fallback_method: Union[str, object] = values.unset, status_callback: Union[str, object] = values.unset, sticky_sender: Union[bool, object] = values.unset, mms_converter: Union[bool, object] = values.unset, smart_encoding: Union[bool, object] = values.unset, scan_message_content: Union[ "ServiceInstance.ScanMessageContent", object ] = values.unset, fallback_to_long_code: Union[bool, object] = values.unset, area_code_geomatch: Union[bool, object] = values.unset, validity_period: Union[int, object] = values.unset, synchronous_validation: Union[bool, object] = values.unset, usecase: Union[str, object] = values.unset, use_inbound_webhook_on_number: Union[bool, object] = values.unset, ) -> ServiceInstance: """ Asynchronously create the ServiceInstance :param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long. :param inbound_request_url: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. :param inbound_method: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. :param fallback_url: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. :param fallback_method: The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. :param status_callback: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. :param sticky_sender: Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance. :param mms_converter: Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance. :param smart_encoding: Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance. :param scan_message_content: :param fallback_to_long_code: Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance. :param area_code_geomatch: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance. :param validity_period: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. :param synchronous_validation: Reserved. :param usecase: A string that describes the scenario in which the Messaging Service will be used. Examples: [notification, marketing, verification, poll ..]. :param use_inbound_webhook_on_number: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. :returns: The created ServiceInstance """ data = values.of( { "FriendlyName": friendly_name, "InboundRequestUrl": inbound_request_url, "InboundMethod": inbound_method, "FallbackUrl": fallback_url, "FallbackMethod": fallback_method, "StatusCallback": status_callback, "StickySender": sticky_sender, "MmsConverter": mms_converter, "SmartEncoding": smart_encoding, "ScanMessageContent": scan_message_content, "FallbackToLongCode": fallback_to_long_code, "AreaCodeGeomatch": area_code_geomatch, "ValidityPeriod": validity_period, "SynchronousValidation": synchronous_validation, "Usecase": usecase, "UseInboundWebhookOnNumber": use_inbound_webhook_on_number, } ) payload = await self._version.create_async( method="POST", uri=self._uri, data=data, ) return ServiceInstance(self._version, payload) def stream( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[ServiceInstance]: """ Streams ServiceInstance 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[ServiceInstance]: """ Asynchronously streams ServiceInstance 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[ServiceInstance]: """ Lists ServiceInstance 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[ServiceInstance]: """ Asynchronously lists ServiceInstance 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, ) -> ServicePage: """ Retrieve a single page of ServiceInstance 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 ServiceInstance """ data = values.of( { "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return ServicePage(self._version, response) 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, ) -> ServicePage: """ Asynchronously retrieve a single page of ServiceInstance 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 ServiceInstance """ data = values.of( { "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return ServicePage(self._version, response) def get_page(self, target_url: str) -> ServicePage: """ Retrieve a specific page of ServiceInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of ServiceInstance """ response = self._version.domain.twilio.request("GET", target_url) return ServicePage(self._version, response) async def get_page_async(self, target_url: str) -> ServicePage: """ Asynchronously retrieve a specific page of ServiceInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of ServiceInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return ServicePage(self._version, response) def get(self, sid: str) -> ServiceContext: """ Constructs a ServiceContext :param sid: The SID of the Service resource to update. """ return ServiceContext(self._version, sid=sid) def __call__(self, sid: str) -> ServiceContext: """ Constructs a ServiceContext :param sid: The SID of the Service resource to update. """ return ServiceContext(self._version, sid=sid) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""