telnyx 3.0.0a0__py3-none-any.whl

telnyx/types/porting_order_update_params.py

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .porting_order_misc_param import PortingOrderMiscParam
+from .porting_order_end_user_param import PortingOrderEndUserParam
+from .porting_order_documents_param import PortingOrderDocumentsParam
+from .porting_order_user_feedback_param import PortingOrderUserFeedbackParam
+from .porting_order_phone_number_configuration_param import PortingOrderPhoneNumberConfigurationParam
+
+__all__ = ["PortingOrderUpdateParams", "ActivationSettings", "Messaging", "Requirement"]
+
+
+class PortingOrderUpdateParams(TypedDict, total=False):
+    activation_settings: ActivationSettings
+
+    customer_reference: str
+
+    documents: PortingOrderDocumentsParam
+    """Can be specified directly or via the `requirement_group_id` parameter."""
+
+    end_user: PortingOrderEndUserParam
+
+    messaging: Messaging
+
+    misc: PortingOrderMiscParam
+
+    phone_number_configuration: PortingOrderPhoneNumberConfigurationParam
+
+    requirement_group_id: str
+    """
+    If present, we will read the current values from the specified Requirement Group
+    into the Documents and Requirements for this Porting Order. Note that any future
+    changes in the Requirement Group would have no impact on this Porting Order. We
+    will return an error if a specified Requirement Group conflicts with documents
+    or requirements in the same request.
+    """
+
+    requirements: Iterable[Requirement]
+    """List of requirements for porting numbers."""
+
+    user_feedback: PortingOrderUserFeedbackParam
+
+    webhook_url: str
+
+
+class ActivationSettings(TypedDict, total=False):
+    foc_datetime_requested: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """ISO 8601 formatted Date/Time requested for the FOC date"""
+
+
+class Messaging(TypedDict, total=False):
+    enable_messaging: bool
+    """
+    Indicates whether Telnyx will port messaging capabilities from the losing
+    carrier. If false, any messaging capabilities will stay with their current
+    provider.
+    """
+
+
+class Requirement(TypedDict, total=False):
+    field_value: Required[str]
+    """
+    identifies the document or provides the text value that satisfies this
+    requirement
+    """
+
+    requirement_type_id: Required[str]
+    """Identifies the requirement type that the `field_value` fulfills"""

telnyx/types/porting_order_update_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .porting_order import PortingOrder
+
+__all__ = ["PortingOrderUpdateResponse", "Meta"]
+
+
+class Meta(BaseModel):
+    phone_numbers_url: Optional[str] = None
+    """Link to list all phone numbers"""
+
+
+class PortingOrderUpdateResponse(BaseModel):
+    data: Optional[PortingOrder] = None
+
+    meta: Optional[Meta] = None

telnyx/types/porting_order_user_feedback.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["PortingOrderUserFeedback"]
+
+
+class PortingOrderUserFeedback(BaseModel):
+    user_comment: Optional[str] = None
+    """A comment related to the customer rating."""
+
+    user_rating: Optional[int] = None
+    """
+    Once an order is ported, cancellation is requested or the request is cancelled,
+    the user may rate their experience
+    """

telnyx/types/porting_order_user_feedback_param.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["PortingOrderUserFeedbackParam"]
+
+
+class PortingOrderUserFeedbackParam(TypedDict, total=False):
+    user_comment: str
+    """A comment related to the customer rating."""
+
+    user_rating: int
+    """
+    Once an order is ported, cancellation is requested or the request is cancelled,
+    the user may rate their experience
+    """

telnyx/types/porting_orders/__init__.py

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .action_share_params import ActionShareParams as ActionShareParams
+from .comment_list_params import CommentListParams as CommentListParams
+from .action_share_response import ActionShareResponse as ActionShareResponse
+from .comment_create_params import CommentCreateParams as CommentCreateParams
+from .comment_list_response import CommentListResponse as CommentListResponse
+from .action_cancel_response import ActionCancelResponse as ActionCancelResponse
+from .action_confirm_response import ActionConfirmResponse as ActionConfirmResponse
+from .comment_create_response import CommentCreateResponse as CommentCreateResponse
+from .action_activate_response import ActionActivateResponse as ActionActivateResponse
+from .activation_job_list_params import ActivationJobListParams as ActivationJobListParams
+from .porting_phone_number_block import PortingPhoneNumberBlock as PortingPhoneNumberBlock
+from .activation_job_list_response import ActivationJobListResponse as ActivationJobListResponse
+from .activation_job_update_params import ActivationJobUpdateParams as ActivationJobUpdateParams
+from .verification_code_list_params import VerificationCodeListParams as VerificationCodeListParams
+from .verification_code_send_params import VerificationCodeSendParams as VerificationCodeSendParams
+from .action_requirement_list_params import ActionRequirementListParams as ActionRequirementListParams
+from .activation_job_update_response import ActivationJobUpdateResponse as ActivationJobUpdateResponse
+from .phone_number_block_list_params import PhoneNumberBlockListParams as PhoneNumberBlockListParams
+from .porting_phone_number_extension import PortingPhoneNumberExtension as PortingPhoneNumberExtension
+from .additional_document_list_params import AdditionalDocumentListParams as AdditionalDocumentListParams
+from .porting_associated_phone_number import PortingAssociatedPhoneNumber as PortingAssociatedPhoneNumber
+from .verification_code_list_response import VerificationCodeListResponse as VerificationCodeListResponse
+from .verification_code_verify_params import VerificationCodeVerifyParams as VerificationCodeVerifyParams
+from .action_requirement_list_response import ActionRequirementListResponse as ActionRequirementListResponse
+from .activation_job_retrieve_response import ActivationJobRetrieveResponse as ActivationJobRetrieveResponse
+from .phone_number_block_create_params import PhoneNumberBlockCreateParams as PhoneNumberBlockCreateParams
+from .phone_number_block_list_response import PhoneNumberBlockListResponse as PhoneNumberBlockListResponse
+from .additional_document_create_params import AdditionalDocumentCreateParams as AdditionalDocumentCreateParams
+from .additional_document_list_response import AdditionalDocumentListResponse as AdditionalDocumentListResponse
+from .verification_code_verify_response import VerificationCodeVerifyResponse as VerificationCodeVerifyResponse
+from .action_requirement_initiate_params import ActionRequirementInitiateParams as ActionRequirementInitiateParams
+from .phone_number_block_create_response import PhoneNumberBlockCreateResponse as PhoneNumberBlockCreateResponse
+from .phone_number_block_delete_response import PhoneNumberBlockDeleteResponse as PhoneNumberBlockDeleteResponse
+from .phone_number_extension_list_params import PhoneNumberExtensionListParams as PhoneNumberExtensionListParams
+from .additional_document_create_response import AdditionalDocumentCreateResponse as AdditionalDocumentCreateResponse
+from .associated_phone_number_list_params import AssociatedPhoneNumberListParams as AssociatedPhoneNumberListParams
+from .action_requirement_initiate_response import ActionRequirementInitiateResponse as ActionRequirementInitiateResponse
+from .phone_number_extension_create_params import PhoneNumberExtensionCreateParams as PhoneNumberExtensionCreateParams
+from .phone_number_extension_list_response import PhoneNumberExtensionListResponse as PhoneNumberExtensionListResponse
+from .associated_phone_number_create_params import (
+    AssociatedPhoneNumberCreateParams as AssociatedPhoneNumberCreateParams,
+)
+from .associated_phone_number_list_response import (
+    AssociatedPhoneNumberListResponse as AssociatedPhoneNumberListResponse,
+)
+from .phone_number_configuration_list_params import (
+    PhoneNumberConfigurationListParams as PhoneNumberConfigurationListParams,
+)
+from .phone_number_extension_create_response import (
+    PhoneNumberExtensionCreateResponse as PhoneNumberExtensionCreateResponse,
+)
+from .phone_number_extension_delete_response import (
+    PhoneNumberExtensionDeleteResponse as PhoneNumberExtensionDeleteResponse,
+)
+from .associated_phone_number_create_response import (
+    AssociatedPhoneNumberCreateResponse as AssociatedPhoneNumberCreateResponse,
+)
+from .associated_phone_number_delete_response import (
+    AssociatedPhoneNumberDeleteResponse as AssociatedPhoneNumberDeleteResponse,
+)
+from .phone_number_configuration_create_params import (
+    PhoneNumberConfigurationCreateParams as PhoneNumberConfigurationCreateParams,
+)
+from .phone_number_configuration_list_response import (
+    PhoneNumberConfigurationListResponse as PhoneNumberConfigurationListResponse,
+)
+from .phone_number_configuration_create_response import (
+    PhoneNumberConfigurationCreateResponse as PhoneNumberConfigurationCreateResponse,
+)

telnyx/types/porting_orders/action_activate_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from ..porting_orders_activation_job import PortingOrdersActivationJob
+
+__all__ = ["ActionActivateResponse"]
+
+
+class ActionActivateResponse(BaseModel):
+    data: Optional[PortingOrdersActivationJob] = None

telnyx/types/porting_orders/action_cancel_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from ..porting_order import PortingOrder
+
+__all__ = ["ActionCancelResponse", "Meta"]
+
+
+class Meta(BaseModel):
+    phone_numbers_url: Optional[str] = None
+    """Link to list all phone numbers"""
+
+
+class ActionCancelResponse(BaseModel):
+    data: Optional[PortingOrder] = None
+
+    meta: Optional[Meta] = None

telnyx/types/porting_orders/action_confirm_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from ..porting_order import PortingOrder
+
+__all__ = ["ActionConfirmResponse", "Meta"]
+
+
+class Meta(BaseModel):
+    phone_numbers_url: Optional[str] = None
+    """Link to list all phone numbers"""
+
+
+class ActionConfirmResponse(BaseModel):
+    data: Optional[PortingOrder] = None
+
+    meta: Optional[Meta] = None

telnyx/types/porting_orders/action_requirement_initiate_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ActionRequirementInitiateParams", "Params"]
+
+
+class ActionRequirementInitiateParams(TypedDict, total=False):
+    porting_order_id: Required[str]
+
+    params: Required[Params]
+    """
+    Required information for initiating the action requirement for AU ID
+    verification.
+    """
+
+
+class Params(TypedDict, total=False):
+    first_name: Required[str]
+    """The first name of the person that will perform the verification flow."""
+
+    last_name: Required[str]
+    """The last name of the person that will perform the verification flow."""

telnyx/types/porting_orders/action_requirement_initiate_response.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ActionRequirementInitiateResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the action requirement"""
+
+    action_type: Optional[str] = None
+    """The type of action required"""
+
+    action_url: Optional[str] = None
+    """Optional URL for the action"""
+
+    cancel_reason: Optional[str] = None
+    """Reason for cancellation if status is 'cancelled'"""
+
+    created_at: Optional[datetime] = None
+    """ISO 8601 formatted date-time indicating when the resource was created"""
+
+    porting_order_id: Optional[str] = None
+    """The ID of the porting order this action requirement belongs to"""
+
+    record_type: Optional[Literal["porting_action_requirement"]] = None
+    """Identifies the type of the resource"""
+
+    requirement_type_id: Optional[str] = None
+    """The ID of the requirement type"""
+
+    status: Optional[Literal["created", "pending", "completed", "cancelled", "failed"]] = None
+    """Current status of the action requirement"""
+
+    updated_at: Optional[datetime] = None
+    """ISO 8601 formatted date-time indicating when the resource was updated"""
+
+
+class ActionRequirementInitiateResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/porting_orders/action_requirement_list_params.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["ActionRequirementListParams", "Filter", "Page", "Sort"]
+
+
+class ActionRequirementListParams(TypedDict, total=False):
+    filter: Filter
+    """Consolidated filter parameter (deepObject style).
+
+    Originally: filter[id][in][], filter[requirement_type_id], filter[action_type],
+    filter[status]
+    """
+
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[size], page[number]
+    """
+
+    sort: Sort
+    """Consolidated sort parameter (deepObject style). Originally: sort[value]"""
+
+
+class Filter(TypedDict, total=False):
+    id: List[str]
+    """Filter action requirements by a list of IDs"""
+
+    action_type: Literal["au_id_verification"]
+    """Filter action requirements by action type"""
+
+    requirement_type_id: str
+    """Filter action requirements by requirement type ID"""
+
+    status: Literal["created", "pending", "completed", "cancelled", "failed"]
+    """Filter action requirements by status"""
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""
+
+
+class Sort(TypedDict, total=False):
+    value: Literal["created_at", "-created_at", "updated_at", "-updated_at"]
+    """Specifies the sort order for results.
+
+    If not given, results are sorted by created_at in descending order.
+    """

telnyx/types/porting_orders/action_requirement_list_response.py

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from ..pagination_meta import PaginationMeta
+
+__all__ = ["ActionRequirementListResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the action requirement"""
+
+    action_type: Optional[str] = None
+    """The type of action required"""
+
+    action_url: Optional[str] = None
+    """Optional URL for the action"""
+
+    cancel_reason: Optional[str] = None
+    """Reason for cancellation if status is 'cancelled'"""
+
+    created_at: Optional[datetime] = None
+    """ISO 8601 formatted date-time indicating when the resource was created"""
+
+    porting_order_id: Optional[str] = None
+    """The ID of the porting order this action requirement belongs to"""
+
+    record_type: Optional[Literal["porting_action_requirement"]] = None
+    """Identifies the type of the resource"""
+
+    requirement_type_id: Optional[str] = None
+    """The ID of the requirement type"""
+
+    status: Optional[Literal["created", "pending", "completed", "cancelled", "failed"]] = None
+    """Current status of the action requirement"""
+
+    updated_at: Optional[datetime] = None
+    """ISO 8601 formatted date-time indicating when the resource was updated"""
+
+
+class ActionRequirementListResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/porting_orders/action_share_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["ActionShareParams"]
+
+
+class ActionShareParams(TypedDict, total=False):
+    expires_in_seconds: int
+    """The number of seconds the token will be valid for"""
+
+    permissions: Literal["porting_order.document.read", "porting_order.document.update"]
+    """The permissions the token will have"""

telnyx/types/porting_orders/action_share_response.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ActionShareResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies this sharing token"""
+
+    token: Optional[str] = None
+    """A signed JWT token that can be used to access the shared resource"""
+
+    created_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    expires_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the sharing token expires."""
+
+    expires_in_seconds: Optional[int] = None
+    """The number of seconds until the sharing token expires"""
+
+    permissions: Optional[List[Literal["porting_order.document.read", "porting_order.document.update"]]] = None
+    """The permissions granted to the sharing token"""
+
+    porting_order_id: Optional[str] = None
+    """Identifies the porting order resource being shared"""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+
+class ActionShareResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/porting_orders/activation_job_list_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ActivationJobListParams", "Page"]
+
+
+class ActivationJobListParams(TypedDict, total=False):
+    page: Page
+    """Consolidated page parameter (deepObject style).
+
+    Originally: page[size], page[number]
+    """
+
+
+class Page(TypedDict, total=False):
+    number: int
+    """The page number to load"""
+
+    size: int
+    """The size of the page"""

telnyx/types/porting_orders/activation_job_list_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from ..pagination_meta import PaginationMeta
+from ..porting_orders_activation_job import PortingOrdersActivationJob
+
+__all__ = ["ActivationJobListResponse"]
+
+
+class ActivationJobListResponse(BaseModel):
+    data: Optional[List[PortingOrdersActivationJob]] = None
+
+    meta: Optional[PaginationMeta] = None

telnyx/types/porting_orders/activation_job_retrieve_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from ..porting_orders_activation_job import PortingOrdersActivationJob
+
+__all__ = ["ActivationJobRetrieveResponse"]
+
+
+class ActivationJobRetrieveResponse(BaseModel):
+    data: Optional[PortingOrdersActivationJob] = None

telnyx/types/porting_orders/activation_job_update_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ActivationJobUpdateParams"]
+
+
+class ActivationJobUpdateParams(TypedDict, total=False):
+    id: Required[str]
+
+    activate_at: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """The desired activation time.
+
+    The activation time should be between any of the activation windows.
+    """

telnyx/types/porting_orders/activation_job_update_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from ..porting_orders_activation_job import PortingOrdersActivationJob
+
+__all__ = ["ActivationJobUpdateResponse"]
+
+
+class ActivationJobUpdateResponse(BaseModel):
+    data: Optional[PortingOrdersActivationJob] = None

telnyx/types/porting_orders/additional_document_create_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["AdditionalDocumentCreateParams", "AdditionalDocument"]
+
+
+class AdditionalDocumentCreateParams(TypedDict, total=False):
+    additional_documents: Iterable[AdditionalDocument]
+
+
+class AdditionalDocument(TypedDict, total=False):
+    document_id: str
+    """The document identification"""
+
+    document_type: Literal["loa", "invoice", "csr", "other"]
+    """The type of document being created."""

telnyx/types/porting_orders/additional_document_create_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["AdditionalDocumentCreateResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Uniquely identifies this additional document"""
+
+    content_type: Optional[str] = None
+    """The content type of the related document."""
+
+    created_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the resource was created."""
+
+    document_id: Optional[str] = None
+    """Identifies the associated document"""
+
+    document_type: Optional[Literal["loa", "invoice", "csr", "other"]] = None
+    """Identifies the type of additional document"""
+
+    filename: Optional[str] = None
+    """The filename of the related document."""
+
+    porting_order_id: Optional[str] = None
+    """Identifies the associated porting order"""
+
+    record_type: Optional[str] = None
+    """Identifies the type of the resource."""
+
+    updated_at: Optional[datetime] = None
+    """ISO 8601 formatted date indicating when the resource was updated."""
+
+
+class AdditionalDocumentCreateResponse(BaseModel):
+    data: Optional[List[Data]] = None