api.md

AddressVerification

Types:

from postgrid.types import Errors, Status, AddressVerificationVerifyResponse

Methods:

• client.address_verification.verify(**params) -> AddressVerificationVerifyResponse

IntlAddressVerification

Types:

from postgrid.types import IntlAddressVerificationVerifyResponse

Methods:

• client.intl_address_verification.verify(**params) -> IntlAddressVerificationVerifyResponse

PrintMail

Types:

from postgrid.types import ContactCreateWithCompanyName, ContactCreateWithFirstName

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

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

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.retrieve_url(id) -> ChequeRetrieveURLResponse
• client.print_mail.cheques.retrieve_with_deposit_ready_pdf(id) -> Cheque

Contacts

Types:

from postgrid.types.print_mail import Contact, ContactCreate, 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

Letters

Types:

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

Methods:

• client.print_mail.letters.create(**params) -> Letter
• 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.retrieve_url(id) -> LetterRetrieveURLResponse

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

OrderProfiles

Cheques

Types:

from postgrid.types.print_mail.order_profiles import (
    ChequeProfile,
    CurrencyCode,
    ChequeListResponse,
    ChequeDeleteResponse,
)

Methods:

• client.print_mail.order_profiles.cheques.create(**params) -> ChequeProfile
• client.print_mail.order_profiles.cheques.retrieve(id, **params) -> ChequeProfile
• client.print_mail.order_profiles.cheques.update(id, **params) -> ChequeProfile
• client.print_mail.order_profiles.cheques.list(**params) -> SyncSkipLimit[ChequeListResponse]
• client.print_mail.order_profiles.cheques.delete(id) -> ChequeDeleteResponse

Letters

Types:

from postgrid.types.print_mail.order_profiles import LetterProfile, LetterDeleteResponse

Methods:

• client.print_mail.order_profiles.letters.create(**params) -> LetterProfile
• client.print_mail.order_profiles.letters.retrieve(id, **params) -> LetterProfile
• client.print_mail.order_profiles.letters.update(id, **params) -> LetterProfile
• client.print_mail.order_profiles.letters.list(**params) -> SyncSkipLimit[LetterProfile]
• client.print_mail.order_profiles.letters.delete(id) -> LetterDeleteResponse

Postcards

Types:

from postgrid.types.print_mail.order_profiles import (
    PostcardProfile,
    PostcardSize,
    PostcardDeleteResponse,
)

Methods:

• client.print_mail.order_profiles.postcards.create(**params) -> PostcardProfile
• client.print_mail.order_profiles.postcards.retrieve(id, **params) -> PostcardProfile
• client.print_mail.order_profiles.postcards.update(id, **params) -> PostcardProfile
• client.print_mail.order_profiles.postcards.list(**params) -> SyncSkipLimit[PostcardProfile]
• client.print_mail.order_profiles.postcards.delete(id) -> PostcardDeleteResponse

SelfMailers

Types:

from postgrid.types.print_mail.order_profiles import (
    SelfMailerProfile,
    SelfMailerSize,
    SelfMailerDeleteResponse,
)

Methods:

• client.print_mail.order_profiles.self_mailers.create(**params) -> SelfMailerProfile
• client.print_mail.order_profiles.self_mailers.retrieve(id, **params) -> SelfMailerProfile
• client.print_mail.order_profiles.self_mailers.update(id, **params) -> SelfMailerProfile
• client.print_mail.order_profiles.self_mailers.list(**params) -> SyncSkipLimit[SelfMailerProfile]
• client.print_mail.order_profiles.self_mailers.delete(id) -> SelfMailerDeleteResponse

Postcards

Types:

from postgrid.types.print_mail import Postcard, PostcardRetrieveURLResponse

Methods:

• client.print_mail.postcards.create(**params) -> Postcard
• 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.retrieve_url(id) -> PostcardRetrieveURLResponse

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

SelfMailers

Types:

from postgrid.types.print_mail import SelfMailer, SelfMailerRetrieveURLResponse

Methods:

• client.print_mail.self_mailers.create(**params) -> SelfMailer
• 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.retrieve_url(id) -> SelfMailerRetrieveURLResponse

SubOrganizations

Types:

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

Methods:

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

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