api.md

AddressVerification

Types:

from postgrid.types import (
    Errors,
    Status,
    AddressVerificationAutocompleteResponse,
    AddressVerificationBatchVerificationResponse,
    AddressVerificationGetAutocompletePreviewsResponse,
    AddressVerificationGetLookupInfoResponse,
    AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse,
    AddressVerificationLookupZipCodeFromCityOrStateResponse,
    AddressVerificationParseAnAddressResponse,
    AddressVerificationSuggestAddressesResponse,
    AddressVerificationVerifyResponse,
)

Methods:

• client.address_verification.autocomplete(**params) -> AddressVerificationAutocompleteResponse
• client.address_verification.batch_verification(**params) -> AddressVerificationBatchVerificationResponse
• client.address_verification.get_autocomplete_previews(**params) -> AddressVerificationGetAutocompletePreviewsResponse
• client.address_verification.get_lookup_info() -> AddressVerificationGetLookupInfoResponse
• client.address_verification.lookup_city_or_state_from_postal_or_zip_code(**params) -> AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse
• client.address_verification.lookup_zip_code_from_city_or_state(**params) -> AddressVerificationLookupZipCodeFromCityOrStateResponse
• client.address_verification.parse_an_address(**params) -> AddressVerificationParseAnAddressResponse
• client.address_verification.suggest_addresses(**params) -> AddressVerificationSuggestAddressesResponse
• client.address_verification.verify(**params) -> AddressVerificationVerifyResponse

IntlAddressVerification

Types:

from postgrid.types import (
    IntlAddressVerificationAutocompleteResponse,
    IntlAddressVerificationBatchVerificationResponse,
    IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse,
    IntlAddressVerificationGetAutocompletePreviewsResponse,
    IntlAddressVerificationVerifyResponse,
)

Methods:

• client.intl_address_verification.autocomplete(**params) -> IntlAddressVerificationAutocompleteResponse
• client.intl_address_verification.batch_verification(**params) -> IntlAddressVerificationBatchVerificationResponse
• client.intl_address_verification.get_autocomplete_advanced_previews(**params) -> IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse
• client.intl_address_verification.get_autocomplete_previews(**params) -> IntlAddressVerificationGetAutocompletePreviewsResponse
• client.intl_address_verification.verify(**params) -> IntlAddressVerificationVerifyResponse

BulkVerification

Types:

from postgrid.types import (
    AddverList,
    BulkVerificationRetrieveResponse,
    BulkVerificationListResponse,
    BulkVerificationUploadResponse,
)

Methods:

• client.bulk_verification.retrieve(id) -> BulkVerificationRetrieveResponse
• client.bulk_verification.list(**params) -> BulkVerificationListResponse
• client.bulk_verification.upload(**params) -> BulkVerificationUploadResponse

PrintMail

Contacts

Types:

from postgrid.types.print_mail import (
    Contact,
    ContactCreate,
    ContactCreateWithCompanyName,
    ContactCreateWithFirstName,
    ContactDeleteResponse,
)

Methods:

• client.print_mail.contacts.create(**params) -> Contact
• client.print_mail.contacts.retrieve(id) -> Contact
• client.print_mail.contacts.list(**params) -> SyncSkipLimit[Contact]
• client.print_mail.contacts.delete(id) -> ContactDeleteResponse

Templates

Types:

from postgrid.types.print_mail import Template, TemplateDeleteResponse

Methods:

• client.print_mail.templates.create(**params) -> Template
• client.print_mail.templates.retrieve(id) -> Template
• client.print_mail.templates.update(id, **params) -> Template
• client.print_mail.templates.list(**params) -> SyncSkipLimit[Template]
• client.print_mail.templates.delete(id) -> TemplateDeleteResponse

Trackers

Types:

from postgrid.types.print_mail import (
    TrackerCreateResponse,
    TrackerRetrieveResponse,
    TrackerUpdateResponse,
    TrackerListResponse,
    TrackerDeleteResponse,
    TrackerRetrieveVisitsResponse,
)

Methods:

• client.print_mail.trackers.create(**params) -> TrackerCreateResponse
• client.print_mail.trackers.retrieve(id) -> TrackerRetrieveResponse
• client.print_mail.trackers.update(id, **params) -> TrackerUpdateResponse
• client.print_mail.trackers.list(**params) -> SyncSkipLimit[TrackerListResponse]
• client.print_mail.trackers.delete(id) -> TrackerDeleteResponse
• client.print_mail.trackers.retrieve_visits(id, **params) -> SyncSkipLimit[TrackerRetrieveVisitsResponse]

Webhooks

Types:

from postgrid.types.print_mail import Webhook, WebhookInvocation, WebhookDeleteResponse

Methods:

• client.print_mail.webhooks.create(**params) -> Webhook
• client.print_mail.webhooks.retrieve(id) -> Webhook
• client.print_mail.webhooks.update(id, **params) -> Webhook
• client.print_mail.webhooks.list(**params) -> SyncSkipLimit[Webhook]
• client.print_mail.webhooks.delete(id) -> WebhookDeleteResponse
• client.print_mail.webhooks.list_invocations(id, **params) -> SyncSkipLimit[WebhookInvocation]

Events

Types:

from postgrid.types.print_mail import Event

Methods:

• client.print_mail.events.list(**params) -> SyncSkipLimit[Event]

Letters

Types:

from postgrid.types.print_mail import (
    AddressPlacement,
    AttachedPdf,
    Letter,
    LetterSize,
    PlasticCard,
    LetterCreateResponse,
    LetterRetrieveURLResponse,
)

Methods:

• client.print_mail.letters.create(**params) -> LetterCreateResponse
• client.print_mail.letters.retrieve(id) -> Letter
• client.print_mail.letters.list(**params) -> SyncSkipLimit[Letter]
• client.print_mail.letters.delete(id) -> Letter
• client.print_mail.letters.cancel(id, **params) -> Letter
• client.print_mail.letters.progress(id) -> Letter
• client.print_mail.letters.retrieve_url(id) -> LetterRetrieveURLResponse

Postcards

Types:

from postgrid.types.print_mail import Postcard, PostcardCreateResponse, PostcardRetrieveURLResponse

Methods:

• client.print_mail.postcards.create(**params) -> PostcardCreateResponse
• client.print_mail.postcards.retrieve(id) -> Postcard
• client.print_mail.postcards.list(**params) -> SyncSkipLimit[Postcard]
• client.print_mail.postcards.delete(id) -> Postcard
• client.print_mail.postcards.cancel(id, **params) -> Postcard
• client.print_mail.postcards.progress(id) -> Postcard
• client.print_mail.postcards.retrieve_url(id) -> PostcardRetrieveURLResponse

BankAccounts

Types:

from postgrid.types.print_mail import BankAccount, BankAccountCountryCode, BankAccountDeleteResponse

Methods:

• client.print_mail.bank_accounts.create(**params) -> BankAccount
• client.print_mail.bank_accounts.retrieve(id) -> BankAccount
• client.print_mail.bank_accounts.list(**params) -> SyncSkipLimit[BankAccount]
• client.print_mail.bank_accounts.delete(id) -> BankAccountDeleteResponse

Cheques

Types:

from postgrid.types.print_mail import Cheque, ChequeSize, DigitalOnly, ChequeRetrieveURLResponse

Methods:

• client.print_mail.cheques.create(**params) -> Cheque
• client.print_mail.cheques.retrieve(id) -> Cheque
• client.print_mail.cheques.list(**params) -> SyncSkipLimit[Cheque]
• client.print_mail.cheques.delete(id) -> Cheque
• client.print_mail.cheques.cancel(id, **params) -> Cheque
• client.print_mail.cheques.progress(id) -> Cheque
• client.print_mail.cheques.retrieve_url(id) -> ChequeRetrieveURLResponse
• client.print_mail.cheques.retrieve_with_deposit_ready_pdf(id) -> Cheque

SelfMailers

Types:

from postgrid.types.print_mail import (
    SelfMailer,
    SelfMailerCreateResponse,
    SelfMailerRetrieveURLResponse,
)

Methods:

• client.print_mail.self_mailers.create(**params) -> SelfMailerCreateResponse
• client.print_mail.self_mailers.retrieve(id) -> SelfMailer
• client.print_mail.self_mailers.list(**params) -> SyncSkipLimit[SelfMailer]
• client.print_mail.self_mailers.delete(id) -> SelfMailer
• client.print_mail.self_mailers.progress(id) -> SelfMailer
• client.print_mail.self_mailers.retrieve_url(id) -> SelfMailerRetrieveURLResponse

ReturnEnvelopes

Types:

from postgrid.types.print_mail import ReturnEnvelope

Methods:

• client.print_mail.return_envelopes.create(**params) -> ReturnEnvelope
• client.print_mail.return_envelopes.retrieve(id) -> ReturnEnvelope
• client.print_mail.return_envelopes.list(**params) -> SyncSkipLimit[ReturnEnvelope]

Orders

Types:

from postgrid.types.print_mail.return_envelopes import ReturnEnvelopeOrder

Methods:

• client.print_mail.return_envelopes.orders.create(id, **params) -> ReturnEnvelopeOrder
• client.print_mail.return_envelopes.orders.retrieve(order_id, *, id, **params) -> ReturnEnvelopeOrder
• client.print_mail.return_envelopes.orders.list(id, **params) -> SyncSkipLimit[ReturnEnvelopeOrder]
• client.print_mail.return_envelopes.orders.cancel(order_id, *, id, **params) -> ReturnEnvelopeOrder
• client.print_mail.return_envelopes.orders.fill(order_id, *, id) -> ReturnEnvelopeOrder

Campaigns

Types:

from postgrid.types.print_mail import Campaign, CampaignDeleteResponse

Methods:

• client.print_mail.campaigns.create(**params) -> Campaign
• client.print_mail.campaigns.retrieve(id) -> Campaign
• client.print_mail.campaigns.update(id, **params) -> Campaign
• client.print_mail.campaigns.list(**params) -> SyncSkipLimit[Campaign]
• client.print_mail.campaigns.delete(id) -> CampaignDeleteResponse
• client.print_mail.campaigns.send(id, **params) -> Campaign

MailingListImports

Types:

from postgrid.types.print_mail import (
    FileType,
    MailingListImportResponse,
    VerificationStatusCount,
    MailingListImportDeleteResponse,
)

Methods:

• client.print_mail.mailing_list_imports.create(**params) -> MailingListImportResponse
• client.print_mail.mailing_list_imports.retrieve(id) -> MailingListImportResponse
• client.print_mail.mailing_list_imports.update(id, **params) -> MailingListImportResponse
• client.print_mail.mailing_list_imports.list(**params) -> SyncSkipLimit[MailingListImportResponse]
• client.print_mail.mailing_list_imports.delete(id) -> MailingListImportDeleteResponse

MailingLists

Types:

from postgrid.types.print_mail import MailingList, MailingListUpdate, MailingListDeleteResponse

Methods:

• client.print_mail.mailing_lists.create(**params) -> MailingList
• client.print_mail.mailing_lists.retrieve(id) -> MailingList
• client.print_mail.mailing_lists.update(id, **params) -> MailingListUpdate
• client.print_mail.mailing_lists.list(**params) -> SyncSkipLimit[MailingList]
• client.print_mail.mailing_lists.delete(id) -> MailingListDeleteResponse
• client.print_mail.mailing_lists.jobs(id, **params) -> MailingList

Reports

Types:

from postgrid.types.print_mail import DeletedResponse, Report

Methods:

• client.print_mail.reports.create(**params) -> Report
• client.print_mail.reports.retrieve(id) -> Report
• client.print_mail.reports.update(id, **params) -> Report
• client.print_mail.reports.list(**params) -> SyncSkipLimit[Report]
• client.print_mail.reports.delete(id) -> DeletedResponse
• client.print_mail.reports.sample(**params) -> ReportSample

Samples

Types:

from postgrid.types.print_mail.reports import ReportSample, ReportSampleCreateBase

Methods:

• client.print_mail.reports.samples.create(id, **params) -> ReportSample

Exports

Types:

from postgrid.types.print_mail.reports import ReportExport

Methods:

• client.print_mail.reports.exports.create(report_id, **params) -> ReportExport
• client.print_mail.reports.exports.retrieve(export_id, *, report_id) -> ReportExport
• client.print_mail.reports.exports.delete(export_id, *, report_id) -> DeletedResponse

SubOrganizations

Types:

from postgrid.types.print_mail import (
    EmailPreferences,
    SubOrganization,
    SubOrganizationCreateResponse,
    SubOrganizationRetrieveUsersResponse,
)

Methods:

• client.print_mail.sub_organizations.create(**params) -> SubOrganizationCreateResponse
• client.print_mail.sub_organizations.retrieve(id) -> SubOrganization
• client.print_mail.sub_organizations.list(**params) -> SyncSkipLimit[SubOrganization]
• client.print_mail.sub_organizations.retrieve_users(id, **params) -> SubOrganizationRetrieveUsersResponse

Boxes

Types:

from postgrid.types.print_mail import (
    BoxCreateResponse,
    BoxRetrieveResponse,
    BoxListResponse,
    BoxDeleteResponse,
    BoxProgressionsResponse,
)

Methods:

• client.print_mail.boxes.create(**params) -> BoxCreateResponse
• client.print_mail.boxes.retrieve(id) -> BoxRetrieveResponse
• client.print_mail.boxes.list(**params) -> SyncSkipLimit[BoxListResponse]
• client.print_mail.boxes.delete(id) -> BoxDeleteResponse
• client.print_mail.boxes.progressions(id) -> BoxProgressionsResponse

SnapPacks

Types:

from postgrid.types.print_mail import (
    SnapPack,
    SnapPackCreateResponse,
    SnapPackRetrieveCapabilitiesResponse,
)

Methods:

• client.print_mail.snap_packs.create(**params) -> SnapPackCreateResponse
• client.print_mail.snap_packs.retrieve(id) -> SnapPack
• client.print_mail.snap_packs.list(**params) -> SyncSkipLimit[SnapPack]
• client.print_mail.snap_packs.delete(id) -> SnapPack
• client.print_mail.snap_packs.progressions(id) -> SnapPack
• client.print_mail.snap_packs.retrieve_capabilities(**params) -> SnapPackRetrieveCapabilitiesResponse

TargetedListBuilds

Types:

from postgrid.types.print_mail import (
    TargetedListBuildCreateResponse,
    TargetedListBuildRetrieveResponse,
    TargetedListBuildUpdateResponse,
    TargetedListBuildListResponse,
    TargetedListBuildDeleteResponse,
    TargetedListBuildConfirmResponse,
)

Methods:

• client.print_mail.targeted_list_builds.create(**params) -> TargetedListBuildCreateResponse
• client.print_mail.targeted_list_builds.retrieve(id) -> TargetedListBuildRetrieveResponse
• client.print_mail.targeted_list_builds.update(id, **params) -> TargetedListBuildUpdateResponse
• client.print_mail.targeted_list_builds.list(**params) -> SyncSkipLimit[TargetedListBuildListResponse]
• client.print_mail.targeted_list_builds.delete(id) -> TargetedListBuildDeleteResponse
• client.print_mail.targeted_list_builds.confirm(id) -> TargetedListBuildConfirmResponse

Filters

Types:

from postgrid.types.print_mail.targeted_list_builds import FilterAutocompleteResponse

Methods:

• client.print_mail.targeted_list_builds.filters.autocomplete(**params) -> FilterAutocompleteResponse

TemplateEditorSessions

Types:

from postgrid.types.print_mail import (
    TemplateEditorSessionCreateResponse,
    TemplateEditorSessionListResponse,
    TemplateEditorSessionDeleteResponse,
)

Methods:

• client.print_mail.template_editor_sessions.create(**params) -> TemplateEditorSessionCreateResponse
• client.print_mail.template_editor_sessions.list(**params) -> SyncSkipLimit[TemplateEditorSessionListResponse]
• client.print_mail.template_editor_sessions.delete(id) -> TemplateEditorSessionDeleteResponse

VirtualMailboxes

Types:

from postgrid.types.print_mail import (
    VirtualMailboxCreateResponse,
    VirtualMailboxRetrieveResponse,
    VirtualMailboxListResponse,
    VirtualMailboxRetrieveAddressResponse,
)

Methods:

• client.print_mail.virtual_mailboxes.create(**params) -> VirtualMailboxCreateResponse
• client.print_mail.virtual_mailboxes.retrieve(id) -> VirtualMailboxRetrieveResponse
• client.print_mail.virtual_mailboxes.list(**params) -> SyncSkipLimit[VirtualMailboxListResponse]
• client.print_mail.virtual_mailboxes.retrieve_address(id) -> VirtualMailboxRetrieveAddressResponse

Items

Types:

from postgrid.types.print_mail.virtual_mailboxes import (
    ItemCreateResponse,
    ItemRetrieveResponse,
    ItemListResponse,
)

Methods:

• client.print_mail.virtual_mailboxes.items.create(id, **params) -> ItemCreateResponse
• client.print_mail.virtual_mailboxes.items.retrieve(item_id, *, id) -> ItemRetrieveResponse
• client.print_mail.virtual_mailboxes.items.list(id, **params) -> SyncSkipLimit[ItemListResponse]