telnyx 3.4.0a0__py3-none-any.whl → 3.5.0__py3-none-any.whl

telnyx/resources/messaging_profiles/messaging_profiles.py

@@ -14,7 +14,7 @@ from ...types import (
     messaging_profile_list_short_codes_params,
     messaging_profile_list_phone_numbers_params,
 )
-from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
+from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -75,23 +75,24 @@ class MessagingProfilesResource(SyncAPIResource):
         *,
         name: str,
         whitelisted_destinations: SequenceNotStr[str],
-        alpha_sender: Optional[str] | NotGiven = NOT_GIVEN,
-        daily_spend_limit: str | NotGiven = NOT_GIVEN,
-        daily_spend_limit_enabled: bool | NotGiven = NOT_GIVEN,
-        enabled: bool | NotGiven = NOT_GIVEN,
-        mms_fall_back_to_sms: bool | NotGiven = NOT_GIVEN,
-        mms_transcoding: bool | NotGiven = NOT_GIVEN,
-        number_pool_settings: Optional[NumberPoolSettingsParam] | NotGiven = NOT_GIVEN,
-        url_shortener_settings: Optional[URLShortenerSettingsParam] | NotGiven = NOT_GIVEN,
-        webhook_api_version: Literal["1", "2", "2010-04-01"] | NotGiven = NOT_GIVEN,
-        webhook_failover_url: Optional[str] | NotGiven = NOT_GIVEN,
-        webhook_url: Optional[str] | NotGiven = NOT_GIVEN,
+        alpha_sender: Optional[str] | Omit = omit,
+        daily_spend_limit: str | Omit = omit,
+        daily_spend_limit_enabled: bool | Omit = omit,
+        enabled: bool | Omit = omit,
+        mms_fall_back_to_sms: bool | Omit = omit,
+        mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
+        number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
+        url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
+        webhook_api_version: Literal["1", "2", "2010-04-01"] | Omit = omit,
+        webhook_failover_url: Optional[str] | Omit = omit,
+        webhook_url: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileCreateResponse:
         """
         Create a messaging profile
@@ -117,6 +118,8 @@ class MessagingProfilesResource(SyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
               types, assigning weights to each type. The pool consists of all the long code
               and toll free numbers assigned to the messaging profile.
@@ -159,6 +162,7 @@ class MessagingProfilesResource(SyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
                     "webhook_api_version": webhook_api_version,
@@ -182,7 +186,7 @@ class MessagingProfilesResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileRetrieveResponse:
         """
         Retrieve a messaging profile
@@ -210,26 +214,27 @@ class MessagingProfilesResource(SyncAPIResource):
         self,
         id: str,
         *,
-        alpha_sender: Optional[str] | NotGiven = NOT_GIVEN,
-        daily_spend_limit: str | NotGiven = NOT_GIVEN,
-        daily_spend_limit_enabled: bool | NotGiven = NOT_GIVEN,
-        enabled: bool | NotGiven = NOT_GIVEN,
-        mms_fall_back_to_sms: bool | NotGiven = NOT_GIVEN,
-        mms_transcoding: bool | NotGiven = NOT_GIVEN,
-        name: str | NotGiven = NOT_GIVEN,
-        number_pool_settings: Optional[NumberPoolSettingsParam] | NotGiven = NOT_GIVEN,
-        url_shortener_settings: Optional[URLShortenerSettingsParam] | NotGiven = NOT_GIVEN,
-        v1_secret: str | NotGiven = NOT_GIVEN,
-        webhook_api_version: Literal["1", "2", "2010-04-01"] | NotGiven = NOT_GIVEN,
-        webhook_failover_url: Optional[str] | NotGiven = NOT_GIVEN,
-        webhook_url: Optional[str] | NotGiven = NOT_GIVEN,
-        whitelisted_destinations: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
+        alpha_sender: Optional[str] | Omit = omit,
+        daily_spend_limit: str | Omit = omit,
+        daily_spend_limit_enabled: bool | Omit = omit,
+        enabled: bool | Omit = omit,
+        mms_fall_back_to_sms: bool | Omit = omit,
+        mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
+        name: str | Omit = omit,
+        number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
+        url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
+        v1_secret: str | Omit = omit,
+        webhook_api_version: Literal["1", "2", "2010-04-01"] | Omit = omit,
+        webhook_failover_url: Optional[str] | Omit = omit,
+        webhook_url: Optional[str] | Omit = omit,
+        whitelisted_destinations: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileUpdateResponse:
         """
         Update a messaging profile
@@ -249,6 +254,8 @@ class MessagingProfilesResource(SyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           name: A user friendly name for the messaging profile.
 
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
@@ -301,6 +308,7 @@ class MessagingProfilesResource(SyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "name": name,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
@@ -321,14 +329,14 @@ class MessagingProfilesResource(SyncAPIResource):
     def list(
         self,
         *,
-        filter: messaging_profile_list_params.Filter | NotGiven = NOT_GIVEN,
-        page: messaging_profile_list_params.Page | NotGiven = NOT_GIVEN,
+        filter: messaging_profile_list_params.Filter | Omit = omit,
+        page: messaging_profile_list_params.Page | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileListResponse:
         """
         List messaging profiles
@@ -374,7 +382,7 @@ class MessagingProfilesResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileDeleteResponse:
         """
         Delete a messaging profile
@@ -402,13 +410,13 @@ class MessagingProfilesResource(SyncAPIResource):
         self,
         id: str,
         *,
-        page: messaging_profile_list_phone_numbers_params.Page | NotGiven = NOT_GIVEN,
+        page: messaging_profile_list_phone_numbers_params.Page | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileListPhoneNumbersResponse:
         """
         List phone numbers associated with a messaging profile
@@ -445,13 +453,13 @@ class MessagingProfilesResource(SyncAPIResource):
         self,
         id: str,
         *,
-        page: messaging_profile_list_short_codes_params.Page | NotGiven = NOT_GIVEN,
+        page: messaging_profile_list_short_codes_params.Page | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileListShortCodesResponse:
         """
         List short codes associated with a messaging profile
@@ -514,23 +522,24 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         *,
         name: str,
         whitelisted_destinations: SequenceNotStr[str],
-        alpha_sender: Optional[str] | NotGiven = NOT_GIVEN,
-        daily_spend_limit: str | NotGiven = NOT_GIVEN,
-        daily_spend_limit_enabled: bool | NotGiven = NOT_GIVEN,
-        enabled: bool | NotGiven = NOT_GIVEN,
-        mms_fall_back_to_sms: bool | NotGiven = NOT_GIVEN,
-        mms_transcoding: bool | NotGiven = NOT_GIVEN,
-        number_pool_settings: Optional[NumberPoolSettingsParam] | NotGiven = NOT_GIVEN,
-        url_shortener_settings: Optional[URLShortenerSettingsParam] | NotGiven = NOT_GIVEN,
-        webhook_api_version: Literal["1", "2", "2010-04-01"] | NotGiven = NOT_GIVEN,
-        webhook_failover_url: Optional[str] | NotGiven = NOT_GIVEN,
-        webhook_url: Optional[str] | NotGiven = NOT_GIVEN,
+        alpha_sender: Optional[str] | Omit = omit,
+        daily_spend_limit: str | Omit = omit,
+        daily_spend_limit_enabled: bool | Omit = omit,
+        enabled: bool | Omit = omit,
+        mms_fall_back_to_sms: bool | Omit = omit,
+        mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
+        number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
+        url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
+        webhook_api_version: Literal["1", "2", "2010-04-01"] | Omit = omit,
+        webhook_failover_url: Optional[str] | Omit = omit,
+        webhook_url: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileCreateResponse:
         """
         Create a messaging profile
@@ -556,6 +565,8 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
               types, assigning weights to each type. The pool consists of all the long code
               and toll free numbers assigned to the messaging profile.
@@ -598,6 +609,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
                     "webhook_api_version": webhook_api_version,
@@ -621,7 +633,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileRetrieveResponse:
         """
         Retrieve a messaging profile
@@ -649,26 +661,27 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         self,
         id: str,
         *,
-        alpha_sender: Optional[str] | NotGiven = NOT_GIVEN,
-        daily_spend_limit: str | NotGiven = NOT_GIVEN,
-        daily_spend_limit_enabled: bool | NotGiven = NOT_GIVEN,
-        enabled: bool | NotGiven = NOT_GIVEN,
-        mms_fall_back_to_sms: bool | NotGiven = NOT_GIVEN,
-        mms_transcoding: bool | NotGiven = NOT_GIVEN,
-        name: str | NotGiven = NOT_GIVEN,
-        number_pool_settings: Optional[NumberPoolSettingsParam] | NotGiven = NOT_GIVEN,
-        url_shortener_settings: Optional[URLShortenerSettingsParam] | NotGiven = NOT_GIVEN,
-        v1_secret: str | NotGiven = NOT_GIVEN,
-        webhook_api_version: Literal["1", "2", "2010-04-01"] | NotGiven = NOT_GIVEN,
-        webhook_failover_url: Optional[str] | NotGiven = NOT_GIVEN,
-        webhook_url: Optional[str] | NotGiven = NOT_GIVEN,
-        whitelisted_destinations: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
+        alpha_sender: Optional[str] | Omit = omit,
+        daily_spend_limit: str | Omit = omit,
+        daily_spend_limit_enabled: bool | Omit = omit,
+        enabled: bool | Omit = omit,
+        mms_fall_back_to_sms: bool | Omit = omit,
+        mms_transcoding: bool | Omit = omit,
+        mobile_only: bool | Omit = omit,
+        name: str | Omit = omit,
+        number_pool_settings: Optional[NumberPoolSettingsParam] | Omit = omit,
+        url_shortener_settings: Optional[URLShortenerSettingsParam] | Omit = omit,
+        v1_secret: str | Omit = omit,
+        webhook_api_version: Literal["1", "2", "2010-04-01"] | Omit = omit,
+        webhook_failover_url: Optional[str] | Omit = omit,
+        webhook_url: Optional[str] | Omit = omit,
+        whitelisted_destinations: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileUpdateResponse:
         """
         Update a messaging profile
@@ -688,6 +701,8 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
 
           mms_transcoding: enables automated resizing of MMS media.
 
+          mobile_only: Send messages only to mobile phone numbers.
+
           name: A user friendly name for the messaging profile.
 
           number_pool_settings: Number Pool allows you to send messages from a pool of numbers of different
@@ -740,6 +755,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
                     "enabled": enabled,
                     "mms_fall_back_to_sms": mms_fall_back_to_sms,
                     "mms_transcoding": mms_transcoding,
+                    "mobile_only": mobile_only,
                     "name": name,
                     "number_pool_settings": number_pool_settings,
                     "url_shortener_settings": url_shortener_settings,
@@ -760,14 +776,14 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
     async def list(
         self,
         *,
-        filter: messaging_profile_list_params.Filter | NotGiven = NOT_GIVEN,
-        page: messaging_profile_list_params.Page | NotGiven = NOT_GIVEN,
+        filter: messaging_profile_list_params.Filter | Omit = omit,
+        page: messaging_profile_list_params.Page | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileListResponse:
         """
         List messaging profiles
@@ -813,7 +829,7 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileDeleteResponse:
         """
         Delete a messaging profile
@@ -841,13 +857,13 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         self,
         id: str,
         *,
-        page: messaging_profile_list_phone_numbers_params.Page | NotGiven = NOT_GIVEN,
+        page: messaging_profile_list_phone_numbers_params.Page | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileListPhoneNumbersResponse:
         """
         List phone numbers associated with a messaging profile
@@ -884,13 +900,13 @@ class AsyncMessagingProfilesResource(AsyncAPIResource):
         self,
         id: str,
         *,
-        page: messaging_profile_list_short_codes_params.Page | NotGiven = NOT_GIVEN,
+        page: messaging_profile_list_short_codes_params.Page | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> MessagingProfileListShortCodesResponse:
         """
         List short codes associated with a messaging profile