Skip to content

SystemStirShakenModifyRequest

Bases: OCIRequest

Modify system Stir Shaken service settings.

Attributes:

signing_policy (Optional[str]):

tagging_policy (Optional[str]):

sign_emergency_calls (Optional[bool]):

tag_emergency_calls (Optional[bool]):

signing_service_url (Optional[Nillable[str]]):

tag_from_or_pai (Optional[str]):

verstat_tag (Optional[str]):

use_os_value_for_orig_id (Optional[bool]):

orig_uuid (Optional[Nillable[str]]):

attestation_level (Optional[str]):

enable_verification (Optional[bool]):

verification_service_url (Optional[Nillable[str]]):

verification_error_handling (Optional[str]):

proxy_verstat_to_cnam_subscribe (Optional[bool]):

use_unknown_headers_from_cnam_notify (Optional[bool]):

use_ts24229_headers (Optional[bool]):

enable_signing_for_unscreened_trunk_group_originations (Optional[bool]):

enable_tagging_for_unscreened_trunk_group_originations (Optional[bool]):

unscreened_trunk_group_origination_attestation_level (Optional[str]):

verify_gets_calls (Optional[bool]):

allow_partial_ingress_tagging (Optional[bool]):

include_verstat_to_mobile_network_locations (Optional[bool]):

allow_verstat_in_sipuri_with_phone_correction (Optional[bool]):

include_tagged_headers_to_access_side (Optional[bool]):

proxy_identity_header_to_access_side (Optional[bool]):

check_directory_numbers_for_attestation (Optional[bool]):

match_unassigned_numbers_only (Optional[bool]):

enable_tagging_for_redirected_calls (Optional[bool]):

prefer_ingress_tagging (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemStirShakenModifyRequest(OCIRequest):
    """Modify system Stir Shaken service settings.

    Attributes:

        signing_policy (Optional[str]):

        tagging_policy (Optional[str]):

        sign_emergency_calls (Optional[bool]):

        tag_emergency_calls (Optional[bool]):

        signing_service_url (Optional[Nillable[str]]):

        tag_from_or_pai (Optional[str]):

        verstat_tag (Optional[str]):

        use_os_value_for_orig_id (Optional[bool]):

        orig_uuid (Optional[Nillable[str]]):

        attestation_level (Optional[str]):

        enable_verification (Optional[bool]):

        verification_service_url (Optional[Nillable[str]]):

        verification_error_handling (Optional[str]):

        proxy_verstat_to_cnam_subscribe (Optional[bool]):

        use_unknown_headers_from_cnam_notify (Optional[bool]):

        use_ts24229_headers (Optional[bool]):

        enable_signing_for_unscreened_trunk_group_originations (Optional[bool]):

        enable_tagging_for_unscreened_trunk_group_originations (Optional[bool]):

        unscreened_trunk_group_origination_attestation_level (Optional[str]):

        verify_gets_calls (Optional[bool]):

        allow_partial_ingress_tagging (Optional[bool]):

        include_verstat_to_mobile_network_locations (Optional[bool]):

        allow_verstat_in_sipuri_with_phone_correction (Optional[bool]):

        include_tagged_headers_to_access_side (Optional[bool]):

        proxy_identity_header_to_access_side (Optional[bool]):

        check_directory_numbers_for_attestation (Optional[bool]):

        match_unassigned_numbers_only (Optional[bool]):

        enable_tagging_for_redirected_calls (Optional[bool]):

        prefer_ingress_tagging (Optional[bool]):

    """

    signing_policy: Optional[str] = field(
        default=None, metadata={"alias": "signingPolicy"}
    )

    tagging_policy: Optional[str] = field(
        default=None, metadata={"alias": "taggingPolicy"}
    )

    sign_emergency_calls: Optional[bool] = field(
        default=None, metadata={"alias": "signEmergencyCalls"}
    )

    tag_emergency_calls: Optional[bool] = field(
        default=None, metadata={"alias": "tagEmergencyCalls"}
    )

    signing_service_url: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "signingServiceURL"}
    )

    tag_from_or_pai: Optional[str] = field(
        default=None, metadata={"alias": "tagFromOrPAI"}
    )

    verstat_tag: Optional[str] = field(default=None, metadata={"alias": "verstatTag"})

    use_os_value_for_orig_id: Optional[bool] = field(
        default=None, metadata={"alias": "useOSValueForOrigId"}
    )

    orig_uuid: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "origUUID"}
    )

    attestation_level: Optional[str] = field(
        default=None, metadata={"alias": "attestationLevel"}
    )

    enable_verification: Optional[bool] = field(
        default=None, metadata={"alias": "enableVerification"}
    )

    verification_service_url: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "verificationServiceURL"}
    )

    verification_error_handling: Optional[str] = field(
        default=None, metadata={"alias": "verificationErrorHandling"}
    )

    proxy_verstat_to_cnam_subscribe: Optional[bool] = field(
        default=None, metadata={"alias": "proxyVerstatToCNAMSubscribe"}
    )

    use_unknown_headers_from_cnam_notify: Optional[bool] = field(
        default=None, metadata={"alias": "useUnknownHeadersFromCNAMNotify"}
    )

    use_ts24229_headers: Optional[bool] = field(
        default=None, metadata={"alias": "useTS24229Headers"}
    )

    enable_signing_for_unscreened_trunk_group_originations: Optional[bool] = field(
        default=None,
        metadata={"alias": "enableSigningForUnscreenedTrunkGroupOriginations"},
    )

    enable_tagging_for_unscreened_trunk_group_originations: Optional[bool] = field(
        default=None,
        metadata={"alias": "enableTaggingForUnscreenedTrunkGroupOriginations"},
    )

    unscreened_trunk_group_origination_attestation_level: Optional[str] = field(
        default=None,
        metadata={"alias": "unscreenedTrunkGroupOriginationAttestationLevel"},
    )

    verify_gets_calls: Optional[bool] = field(
        default=None, metadata={"alias": "verifyGETSCalls"}
    )

    allow_partial_ingress_tagging: Optional[bool] = field(
        default=None, metadata={"alias": "allowPartialIngressTagging"}
    )

    include_verstat_to_mobile_network_locations: Optional[bool] = field(
        default=None, metadata={"alias": "includeVerstatToMobileNetworkLocations"}
    )

    allow_verstat_in_sipuri_with_phone_correction: Optional[bool] = field(
        default=None, metadata={"alias": "allowVerstatInSIPURIWithPhoneCorrection"}
    )

    include_tagged_headers_to_access_side: Optional[bool] = field(
        default=None, metadata={"alias": "includeTaggedHeadersToAccessSide"}
    )

    proxy_identity_header_to_access_side: Optional[bool] = field(
        default=None, metadata={"alias": "proxyIdentityHeaderToAccessSide"}
    )

    check_directory_numbers_for_attestation: Optional[bool] = field(
        default=None, metadata={"alias": "checkDirectoryNumbersForAttestation"}
    )

    match_unassigned_numbers_only: Optional[bool] = field(
        default=None, metadata={"alias": "matchUnassignedNumbersOnly"}
    )

    enable_tagging_for_redirected_calls: Optional[bool] = field(
        default=None, metadata={"alias": "enableTaggingForRedirectedCalls"}
    )

    prefer_ingress_tagging: Optional[bool] = field(
        default=None, metadata={"alias": "preferIngressTagging"}
    )

    def __post_init__(self):
        nillable_fields = [
            "signing_service_url",
            "orig_uuid",
            "verification_service_url",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

:: mercury_ocip.commands.base_command.ErrorResponse

:: mercury_ocip.commands.base_command.SuccessResponse

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import SystemStirShakenModifyRequest

client = Client()

command = SystemStirShakenModifyRequest(
    signing_policy=...,
    tagging_policy=...,
    sign_emergency_calls=...,
    tag_emergency_calls=...,
    signing_service_url=...,
    tag_from_or_pai=...,
    verstat_tag=...,
    use_os_value_for_orig_id=...,
    orig_uuid=...,
    attestation_level=...,
    enable_verification=...,
    verification_service_url=...,
    verification_error_handling=...,
    proxy_verstat_to_cnam_subscribe=...,
    use_unknown_headers_from_cnam_notify=...,
    use_ts24229_headers=...,
    enable_signing_for_unscreened_trunk_group_originations=...,
    enable_tagging_for_unscreened_trunk_group_originations=...,
    unscreened_trunk_group_origination_attestation_level=...,
    verify_gets_calls=...,
    allow_partial_ingress_tagging=...,
    include_verstat_to_mobile_network_locations=...,
    allow_verstat_in_sipuri_with_phone_correction=...,
    include_tagged_headers_to_access_side=...,
    proxy_identity_header_to_access_side=...,
    check_directory_numbers_for_attestation=...,
    match_unassigned_numbers_only=...,
    enable_tagging_for_redirected_calls=...,
    prefer_ingress_tagging=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemStirShakenModifyRequest",
    signing_policy=...,
    tagging_policy=...,
    sign_emergency_calls=...,
    tag_emergency_calls=...,
    signing_service_url=...,
    tag_from_or_pai=...,
    verstat_tag=...,
    use_os_value_for_orig_id=...,
    orig_uuid=...,
    attestation_level=...,
    enable_verification=...,
    verification_service_url=...,
    verification_error_handling=...,
    proxy_verstat_to_cnam_subscribe=...,
    use_unknown_headers_from_cnam_notify=...,
    use_ts24229_headers=...,
    enable_signing_for_unscreened_trunk_group_originations=...,
    enable_tagging_for_unscreened_trunk_group_originations=...,
    unscreened_trunk_group_origination_attestation_level=...,
    verify_gets_calls=...,
    allow_partial_ingress_tagging=...,
    include_verstat_to_mobile_network_locations=...,
    allow_verstat_in_sipuri_with_phone_correction=...,
    include_tagged_headers_to_access_side=...,
    proxy_identity_header_to_access_side=...,
    check_directory_numbers_for_attestation=...,
    match_unassigned_numbers_only=...,
    enable_tagging_for_redirected_calls=...,
    prefer_ingress_tagging=...,
)

print(response)