Skip to content

PhoneNumberOrder

Source code in docs_src/capo_chime_sdk_voice/types/phone_number_order.py
class PhoneNumberOrder(TypedDict, closed=True):
    phone_number_order_id: NotRequired[
        "capo_chime_sdk_voice.types.guid_string.GuidString"
    ]
    """<p>The ID of the phone order.</p>"""
    product_type: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_product_type.PhoneNumberProductType"
    ]
    """<p>The phone number order product type.</p>"""
    status: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_order_status.PhoneNumberOrderStatus"
    ]
    """<p>The status of the phone number order.</p>"""
    order_type: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_order_type.PhoneNumberOrderType"
    ]
    """<p>The type of phone number being ordered, local or toll-free.</p>"""
    ordered_phone_numbers: NotRequired[
        "capo_chime_sdk_voice.types.ordered_phone_number_list.OrderedPhoneNumberList"
    ]
    """<p>The ordered phone number details, such as the phone number in E.164 format and the phone number status.</p>"""
    created_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The phone number order creation time stamp, in ISO 8601 format.</p>"""
    updated_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The updated phone number order time stamp, in ISO 8601 format.</p>"""
    foc_date: NotRequired["capo_chime_sdk_voice.types.string.String"]
    """<p>The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.</p>"""

created_timestamp instance-attribute

created_timestamp: NotRequired[Iso8601Timestamp]

The phone number order creation time stamp, in ISO 8601 format.

foc_date instance-attribute

foc_date: NotRequired[String]

The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.

order_type instance-attribute

order_type: NotRequired[PhoneNumberOrderType]

The type of phone number being ordered, local or toll-free.

ordered_phone_numbers instance-attribute

ordered_phone_numbers: NotRequired[OrderedPhoneNumberList]

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

phone_number_order_id instance-attribute

phone_number_order_id: NotRequired[GuidString]

The ID of the phone order.

product_type instance-attribute

product_type: NotRequired[PhoneNumberProductType]

The phone number order product type.

status instance-attribute

status: NotRequired[PhoneNumberOrderStatus]

The status of the phone number order.

updated_timestamp instance-attribute

updated_timestamp: NotRequired[Iso8601Timestamp]

The updated phone number order time stamp, in ISO 8601 format.