api.md

Shared Types

from prelude_python_sdk.types import Signals, Target

Lookup

Types:

from prelude_python_sdk.types import LookupLookupResponse

Methods:

• client.lookup.lookup(phone_number, **params) -> LookupLookupResponse

Notify

Types:

from prelude_python_sdk.types import (
    NotifyGetSubscriptionConfigResponse,
    NotifyGetSubscriptionPhoneNumberResponse,
    NotifyListSubscriptionConfigsResponse,
    NotifyListSubscriptionPhoneNumberEventsResponse,
    NotifyListSubscriptionPhoneNumbersResponse,
    NotifyReplyResponse,
    NotifySendResponse,
    NotifySendBatchResponse,
)

Methods:

• client.notify.get_subscription_config(config_id) -> NotifyGetSubscriptionConfigResponse
• client.notify.get_subscription_phone_number(phone_number, *, config_id) -> NotifyGetSubscriptionPhoneNumberResponse
• client.notify.list_subscription_configs(**params) -> NotifyListSubscriptionConfigsResponse
• client.notify.list_subscription_phone_number_events(phone_number, *, config_id, **params) -> NotifyListSubscriptionPhoneNumberEventsResponse
• client.notify.list_subscription_phone_numbers(config_id, **params) -> NotifyListSubscriptionPhoneNumbersResponse
• client.notify.reply(**params) -> NotifyReplyResponse
• client.notify.send(**params) -> NotifySendResponse
• client.notify.send_batch(**params) -> NotifySendBatchResponse

Transactional

Types:

from prelude_python_sdk.types import TransactionalSendResponse

Methods:

• client.transactional.send(**params) -> TransactionalSendResponse

Verification

Types:

from prelude_python_sdk.types import VerificationCreateResponse, VerificationCheckResponse

Methods:

• client.verification.create(**params) -> VerificationCreateResponse
• client.verification.check(**params) -> VerificationCheckResponse

Phone

History

Types:

from prelude_python_sdk.types.verification.phone import (
    PhoneVerificationCarrier,
    PhoneVerificationMoney,
    PhoneVerificationPsd2Transaction,
    HistoryRetrieveResponse,
    HistoryListResponse,
)

Methods:

• client.verification.phone.history.retrieve(id) -> HistoryRetrieveResponse
• client.verification.phone.history.list(**params) -> HistoryListResponse

VerificationManagement

Types:

from prelude_python_sdk.types import (
    VerificationManagementDeletePhoneNumberResponse,
    VerificationManagementListPhoneNumbersResponse,
    VerificationManagementListSenderIDsResponse,
    VerificationManagementSetPhoneNumberResponse,
    VerificationManagementSubmitSenderIDResponse,
)

Methods:

• client.verification_management.delete_phone_number(action, **params) -> VerificationManagementDeletePhoneNumberResponse
• client.verification_management.list_phone_numbers(action) -> VerificationManagementListPhoneNumbersResponse
• client.verification_management.list_sender_ids() -> VerificationManagementListSenderIDsResponse
• client.verification_management.set_phone_number(action, **params) -> VerificationManagementSetPhoneNumberResponse
• client.verification_management.submit_sender_id(**params) -> VerificationManagementSubmitSenderIDResponse

Sandbox

Types:

from prelude_python_sdk.types.verification_management import (
    SandboxAddPhoneNumberResponse,
    SandboxDeletePhoneNumberResponse,
    SandboxListPhoneNumbersResponse,
)

Methods:

• client.verification_management.sandbox.add_phone_number(**params) -> SandboxAddPhoneNumberResponse
• client.verification_management.sandbox.delete_phone_number(phone_number) -> SandboxDeletePhoneNumberResponse
• client.verification_management.sandbox.list_phone_numbers() -> SandboxListPhoneNumbersResponse

Watch

Types:

from prelude_python_sdk.types import (
    WatchEvaluateResponse,
    WatchPredictResponse,
    WatchSendEventsResponse,
    WatchSendFeedbacksResponse,
)

Methods:

• client.watch.evaluate(**params) -> WatchEvaluateResponse
• client.watch.predict(**params) -> WatchPredictResponse
• client.watch.send_events(**params) -> WatchSendEventsResponse
• client.watch.send_feedbacks(**params) -> WatchSendFeedbacksResponse

Intel

KYC

Types:

from prelude_python_sdk.types.intel import KYCMatchResponse

Methods:

• client.intel.kyc.match(phone, **params) -> KYCMatchResponse