Skip to content

SupportedAssociation

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/supported_association.py
class SupportedAssociation(TypedDict, closed=True):
    resource_type: "str"
    """<p>Defines the behavior of when an origination identity and registration can be associated with each other.</p>"""
    iso_country_code: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iso_country_code.IsoCountryCode"
    ]
    """<p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>"""
    association_behavior: "capo_pinpoint_sms_voice_v2.types.registration_association_behavior.RegistrationAssociationBehavior"
    """<p>The association behavior.</p> <ul> <li> <p> <code>ASSOCIATE_BEFORE_SUBMIT</code> The origination identity has to be supplied when creating a registration.</p> </li> <li> <p> <code>ASSOCIATE_ON_APPROVAL</code> This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.</p> </li> <li> <p> <code>ASSOCIATE_AFTER_COMPLETE</code> This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes. </p> </li> </ul>"""
    disassociation_behavior: "capo_pinpoint_sms_voice_v2.types.registration_disassociation_behavior.RegistrationDisassociationBehavior"
    """<p>The disassociation behavior.</p> <ul> <li> <p> <code>DISASSOCIATE_ALL_CLOSES_REGISTRATION</code> All origination identities must be disassociated from the registration before the registration can be closed.</p> </li> <li> <p> <code>DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION</code> All origination identities must be disassociated from the registration before the registration can be deleted.</p> </li> <li> <p> <code>DELETE_REGISTRATION_DISASSOCIATES</code> The registration can be deleted and all origination identities will be disasscoiated.</p> </li> </ul>"""

association_behavior instance-attribute

association_behavior: RegistrationAssociationBehavior

The association behavior.

  • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

  • ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.

  • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

disassociation_behavior instance-attribute

disassociation_behavior: RegistrationDisassociationBehavior

The disassociation behavior.

  • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

  • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

  • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

iso_country_code instance-attribute

iso_country_code: NotRequired[IsoCountryCode]

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

resource_type instance-attribute

resource_type: str

Defines the behavior of when an origination identity and registration can be associated with each other.