telnyx 3.5.0a0__py3-none-any.whl → 3.7.0a0__py3-none-any.whl

telnyx/resources/oauth_grants.py

@@ -0,0 +1,349 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..types import oauth_grant_list_params
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from .._utils import maybe_transform, async_maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from .._base_client import make_request_options
+from ..types.oauth_grant_list_response import OAuthGrantListResponse
+from ..types.oauth_grant_delete_response import OAuthGrantDeleteResponse
+from ..types.oauth_grant_retrieve_response import OAuthGrantRetrieveResponse
+
+__all__ = ["OAuthGrantsResource", "AsyncOAuthGrantsResource"]
+
+
+class OAuthGrantsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> OAuthGrantsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/team-telnyx/telnyx-python#accessing-raw-response-data-eg-headers
+        """
+        return OAuthGrantsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> OAuthGrantsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/team-telnyx/telnyx-python#with_streaming_response
+        """
+        return OAuthGrantsResourceWithStreamingResponse(self)
+
+    def retrieve(
+        self,
+        id: str,
+        *,
+        # 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,
+    ) -> OAuthGrantRetrieveResponse:
+        """
+        Retrieve a single OAuth grant by ID
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/oauth_grants/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=OAuthGrantRetrieveResponse,
+        )
+
+    def list(
+        self,
+        *,
+        page_number: int | Omit = omit,
+        page_size: int | 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,
+    ) -> OAuthGrantListResponse:
+        """
+        Retrieve a paginated list of OAuth grants for the authenticated user
+
+        Args:
+          page_number: Page number
+
+          page_size: Number of results per page
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            "/oauth_grants",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "page_number": page_number,
+                        "page_size": page_size,
+                    },
+                    oauth_grant_list_params.OAuthGrantListParams,
+                ),
+            ),
+            cast_to=OAuthGrantListResponse,
+        )
+
+    def delete(
+        self,
+        id: str,
+        *,
+        # 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,
+    ) -> OAuthGrantDeleteResponse:
+        """
+        Revoke an OAuth grant
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._delete(
+            f"/oauth_grants/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=OAuthGrantDeleteResponse,
+        )
+
+
+class AsyncOAuthGrantsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncOAuthGrantsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/team-telnyx/telnyx-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncOAuthGrantsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncOAuthGrantsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/team-telnyx/telnyx-python#with_streaming_response
+        """
+        return AsyncOAuthGrantsResourceWithStreamingResponse(self)
+
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        # 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,
+    ) -> OAuthGrantRetrieveResponse:
+        """
+        Retrieve a single OAuth grant by ID
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/oauth_grants/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=OAuthGrantRetrieveResponse,
+        )
+
+    async def list(
+        self,
+        *,
+        page_number: int | Omit = omit,
+        page_size: int | 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,
+    ) -> OAuthGrantListResponse:
+        """
+        Retrieve a paginated list of OAuth grants for the authenticated user
+
+        Args:
+          page_number: Page number
+
+          page_size: Number of results per page
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            "/oauth_grants",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "page_number": page_number,
+                        "page_size": page_size,
+                    },
+                    oauth_grant_list_params.OAuthGrantListParams,
+                ),
+            ),
+            cast_to=OAuthGrantListResponse,
+        )
+
+    async def delete(
+        self,
+        id: str,
+        *,
+        # 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,
+    ) -> OAuthGrantDeleteResponse:
+        """
+        Revoke an OAuth grant
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._delete(
+            f"/oauth_grants/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=OAuthGrantDeleteResponse,
+        )
+
+
+class OAuthGrantsResourceWithRawResponse:
+    def __init__(self, oauth_grants: OAuthGrantsResource) -> None:
+        self._oauth_grants = oauth_grants
+
+        self.retrieve = to_raw_response_wrapper(
+            oauth_grants.retrieve,
+        )
+        self.list = to_raw_response_wrapper(
+            oauth_grants.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            oauth_grants.delete,
+        )
+
+
+class AsyncOAuthGrantsResourceWithRawResponse:
+    def __init__(self, oauth_grants: AsyncOAuthGrantsResource) -> None:
+        self._oauth_grants = oauth_grants
+
+        self.retrieve = async_to_raw_response_wrapper(
+            oauth_grants.retrieve,
+        )
+        self.list = async_to_raw_response_wrapper(
+            oauth_grants.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            oauth_grants.delete,
+        )
+
+
+class OAuthGrantsResourceWithStreamingResponse:
+    def __init__(self, oauth_grants: OAuthGrantsResource) -> None:
+        self._oauth_grants = oauth_grants
+
+        self.retrieve = to_streamed_response_wrapper(
+            oauth_grants.retrieve,
+        )
+        self.list = to_streamed_response_wrapper(
+            oauth_grants.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            oauth_grants.delete,
+        )
+
+
+class AsyncOAuthGrantsResourceWithStreamingResponse:
+    def __init__(self, oauth_grants: AsyncOAuthGrantsResource) -> None:
+        self._oauth_grants = oauth_grants
+
+        self.retrieve = async_to_streamed_response_wrapper(
+            oauth_grants.retrieve,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            oauth_grants.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            oauth_grants.delete,
+        )

telnyx/resources/phone_numbers/jobs.py

@@ -181,6 +181,7 @@ class JobsResource(SyncAPIResource):
         billing_group_id: str | Omit = omit,
         connection_id: str | Omit = omit,
         customer_reference: str | Omit = omit,
+        deletion_lock_enabled: bool | Omit = omit,
         external_pin: str | Omit = omit,
         hd_voice_enabled: bool | Omit = omit,
         tags: SequenceNotStr[str] | Omit = omit,
@@ -224,6 +225,10 @@ class JobsResource(SyncAPIResource):
 
           customer_reference: A customer reference string for customer look ups.
 
+          deletion_lock_enabled: Indicates whether to enable or disable the deletion lock on each phone number.
+              When enabled, this prevents the phone number from being deleted via the API or
+              Telnyx portal.
+
           external_pin: If someone attempts to port your phone number away from Telnyx and your phone
               number has an external PIN set, we will attempt to verify that you provided the
               correct external PIN to the winning carrier. Note that not all carriers
@@ -251,6 +256,7 @@ class JobsResource(SyncAPIResource):
                     "billing_group_id": billing_group_id,
                     "connection_id": connection_id,
                     "customer_reference": customer_reference,
+                    "deletion_lock_enabled": deletion_lock_enabled,
                     "external_pin": external_pin,
                     "hd_voice_enabled": hd_voice_enabled,
                     "tags": tags,
@@ -466,6 +472,7 @@ class AsyncJobsResource(AsyncAPIResource):
         billing_group_id: str | Omit = omit,
         connection_id: str | Omit = omit,
         customer_reference: str | Omit = omit,
+        deletion_lock_enabled: bool | Omit = omit,
         external_pin: str | Omit = omit,
         hd_voice_enabled: bool | Omit = omit,
         tags: SequenceNotStr[str] | Omit = omit,
@@ -509,6 +516,10 @@ class AsyncJobsResource(AsyncAPIResource):
 
           customer_reference: A customer reference string for customer look ups.
 
+          deletion_lock_enabled: Indicates whether to enable or disable the deletion lock on each phone number.
+              When enabled, this prevents the phone number from being deleted via the API or
+              Telnyx portal.
+
           external_pin: If someone attempts to port your phone number away from Telnyx and your phone
               number has an external PIN set, we will attempt to verify that you provided the
               correct external PIN to the winning carrier. Note that not all carriers
@@ -536,6 +547,7 @@ class AsyncJobsResource(AsyncAPIResource):
                     "billing_group_id": billing_group_id,
                     "connection_id": connection_id,
                     "customer_reference": customer_reference,
+                    "deletion_lock_enabled": deletion_lock_enabled,
                     "external_pin": external_pin,
                     "hd_voice_enabled": hd_voice_enabled,
                     "tags": tags,

telnyx/resources/porting_orders/porting_orders.py

@@ -194,6 +194,7 @@ class PortingOrdersResource(SyncAPIResource):
         self,
         *,
         phone_numbers: SequenceNotStr[str],
+        customer_group_reference: str | Omit = omit,
         customer_reference: 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.
@@ -208,6 +209,8 @@ class PortingOrdersResource(SyncAPIResource):
         Args:
           phone_numbers: The list of +E.164 formatted phone numbers
 
+          customer_group_reference: A customer-specified group reference for customer bookkeeping purposes
+
           customer_reference: A customer-specified reference number for customer bookkeeping purposes
 
           extra_headers: Send extra headers
@@ -223,6 +226,7 @@ class PortingOrdersResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "phone_numbers": phone_numbers,
+                    "customer_group_reference": customer_group_reference,
                     "customer_reference": customer_reference,
                 },
                 porting_order_create_params.PortingOrderCreateParams,
@@ -281,6 +285,7 @@ class PortingOrdersResource(SyncAPIResource):
         id: str,
         *,
         activation_settings: porting_order_update_params.ActivationSettings | Omit = omit,
+        customer_group_reference: str | Omit = omit,
         customer_reference: str | Omit = omit,
         documents: PortingOrderDocumentsParam | Omit = omit,
         end_user: PortingOrderEndUserParam | Omit = omit,
@@ -335,6 +340,7 @@ class PortingOrdersResource(SyncAPIResource):
             body=maybe_transform(
                 {
                     "activation_settings": activation_settings,
+                    "customer_group_reference": customer_group_reference,
                     "customer_reference": customer_reference,
                     "documents": documents,
                     "end_user": end_user,
@@ -374,10 +380,10 @@ class PortingOrdersResource(SyncAPIResource):
         Args:
           filter:
               Consolidated filter parameter (deepObject style). Originally:
-              filter[customer_reference], filter[parent_support_key],
-              filter[phone_numbers.country_code], filter[phone_numbers.carrier_name],
-              filter[misc.type], filter[end_user.admin.entity_name],
-              filter[end_user.admin.auth_person_name],
+              filter[customer_reference], filter[customer_group_reference],
+              filter[parent_support_key], filter[phone_numbers.country_code],
+              filter[phone_numbers.carrier_name], filter[misc.type],
+              filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name],
               filter[activation_settings.fast_port_eligible],
               filter[activation_settings.foc_datetime_requested][gt],
               filter[activation_settings.foc_datetime_requested][lt],
@@ -693,6 +699,7 @@ class AsyncPortingOrdersResource(AsyncAPIResource):
         self,
         *,
         phone_numbers: SequenceNotStr[str],
+        customer_group_reference: str | Omit = omit,
         customer_reference: 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.
@@ -707,6 +714,8 @@ class AsyncPortingOrdersResource(AsyncAPIResource):
         Args:
           phone_numbers: The list of +E.164 formatted phone numbers
 
+          customer_group_reference: A customer-specified group reference for customer bookkeeping purposes
+
           customer_reference: A customer-specified reference number for customer bookkeeping purposes
 
           extra_headers: Send extra headers
@@ -722,6 +731,7 @@ class AsyncPortingOrdersResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "phone_numbers": phone_numbers,
+                    "customer_group_reference": customer_group_reference,
                     "customer_reference": customer_reference,
                 },
                 porting_order_create_params.PortingOrderCreateParams,
@@ -780,6 +790,7 @@ class AsyncPortingOrdersResource(AsyncAPIResource):
         id: str,
         *,
         activation_settings: porting_order_update_params.ActivationSettings | Omit = omit,
+        customer_group_reference: str | Omit = omit,
         customer_reference: str | Omit = omit,
         documents: PortingOrderDocumentsParam | Omit = omit,
         end_user: PortingOrderEndUserParam | Omit = omit,
@@ -834,6 +845,7 @@ class AsyncPortingOrdersResource(AsyncAPIResource):
             body=await async_maybe_transform(
                 {
                     "activation_settings": activation_settings,
+                    "customer_group_reference": customer_group_reference,
                     "customer_reference": customer_reference,
                     "documents": documents,
                     "end_user": end_user,
@@ -873,10 +885,10 @@ class AsyncPortingOrdersResource(AsyncAPIResource):
         Args:
           filter:
               Consolidated filter parameter (deepObject style). Originally:
-              filter[customer_reference], filter[parent_support_key],
-              filter[phone_numbers.country_code], filter[phone_numbers.carrier_name],
-              filter[misc.type], filter[end_user.admin.entity_name],
-              filter[end_user.admin.auth_person_name],
+              filter[customer_reference], filter[customer_group_reference],
+              filter[parent_support_key], filter[phone_numbers.country_code],
+              filter[phone_numbers.carrier_name], filter[misc.type],
+              filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name],
               filter[activation_settings.fast_port_eligible],
               filter[activation_settings.foc_datetime_requested][gt],
               filter[activation_settings.foc_datetime_requested][lt],

telnyx/resources/sim_cards/sim_cards.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Literal
 
 import httpx
@@ -124,7 +125,7 @@ class SimCardsResource(SyncAPIResource):
         self,
         id: str,
         *,
-        authorized_imeis: SequenceNotStr[str] | Omit = omit,
+        authorized_imeis: Optional[SequenceNotStr[str]] | Omit = omit,
         data_limit: sim_card_update_params.DataLimit | Omit = omit,
         sim_card_group_id: str | Omit = omit,
         status: SimCardStatus | Omit = omit,
@@ -517,7 +518,7 @@ class AsyncSimCardsResource(AsyncAPIResource):
         self,
         id: str,
         *,
-        authorized_imeis: SequenceNotStr[str] | Omit = omit,
+        authorized_imeis: Optional[SequenceNotStr[str]] | Omit = omit,
         data_limit: sim_card_update_params.DataLimit | Omit = omit,
         sim_card_group_id: str | Omit = omit,
         status: SimCardStatus | Omit = omit,

telnyx/resources/verifications/verifications.py

@@ -111,6 +111,7 @@ class VerificationsResource(SyncAPIResource):
         phone_number: str,
         verify_profile_id: str,
         custom_code: Optional[str] | Omit = omit,
+        extension: Optional[str] | Omit = omit,
         timeout_secs: int | 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.
@@ -129,6 +130,9 @@ class VerificationsResource(SyncAPIResource):
 
           custom_code: Send a self-generated numeric code to the end-user
 
+          extension: Optional extension to dial after call is answered using DTMF digits. Valid
+              digits are 0-9, A-D, \\**, and #. Pauses can be added using w (0.5s) and W (1s).
+
           timeout_secs: The number of seconds the verification code is valid for.
 
           extra_headers: Send extra headers
@@ -146,6 +150,7 @@ class VerificationsResource(SyncAPIResource):
                     "phone_number": phone_number,
                     "verify_profile_id": verify_profile_id,
                     "custom_code": custom_code,
+                    "extension": extension,
                     "timeout_secs": timeout_secs,
                 },
                 verification_trigger_call_params.VerificationTriggerCallParams,
@@ -322,6 +327,7 @@ class AsyncVerificationsResource(AsyncAPIResource):
         phone_number: str,
         verify_profile_id: str,
         custom_code: Optional[str] | Omit = omit,
+        extension: Optional[str] | Omit = omit,
         timeout_secs: int | 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.
@@ -340,6 +346,9 @@ class AsyncVerificationsResource(AsyncAPIResource):
 
           custom_code: Send a self-generated numeric code to the end-user
 
+          extension: Optional extension to dial after call is answered using DTMF digits. Valid
+              digits are 0-9, A-D, \\**, and #. Pauses can be added using w (0.5s) and W (1s).
+
           timeout_secs: The number of seconds the verification code is valid for.
 
           extra_headers: Send extra headers
@@ -357,6 +366,7 @@ class AsyncVerificationsResource(AsyncAPIResource):
                     "phone_number": phone_number,
                     "verify_profile_id": verify_profile_id,
                     "custom_code": custom_code,
+                    "extension": extension,
                     "timeout_secs": timeout_secs,
                 },
                 verification_trigger_call_params.VerificationTriggerCallParams,