api.md

AddressVerification

Types:

• Errors
• Status
• AddressVerificationAutocompleteResponse
• AddressVerificationBatchVerificationResponse
• AddressVerificationGetAutocompletePreviewsResponse
• AddressVerificationGetLookupInfoResponse
• AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse
• AddressVerificationLookupZipCodeFromCityOrStateResponse
• AddressVerificationParseAnAddressResponse
• AddressVerificationSuggestAddressesResponse
• AddressVerificationVerifyResponse

Methods:

• client.addressVerification.autocomplete({ ...params }) -> AddressVerificationAutocompleteResponse
• client.addressVerification.batchVerification({ ...params }) -> AddressVerificationBatchVerificationResponse
• client.addressVerification.getAutocompletePreviews({ ...params }) -> AddressVerificationGetAutocompletePreviewsResponse
• client.addressVerification.getLookupInfo() -> AddressVerificationGetLookupInfoResponse
• client.addressVerification.lookupCityOrStateFromPostalOrZipCode({ ...params }) -> AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse
• client.addressVerification.lookupZipCodeFromCityOrState({ ...params }) -> AddressVerificationLookupZipCodeFromCityOrStateResponse
• client.addressVerification.parseAnAddress({ ...params }) -> AddressVerificationParseAnAddressResponse
• client.addressVerification.suggestAddresses({ ...params }) -> AddressVerificationSuggestAddressesResponse
• client.addressVerification.verify({ ...params }) -> AddressVerificationVerifyResponse

IntlAddressVerification

Types:

• IntlAddressVerificationAutocompleteResponse
• IntlAddressVerificationBatchVerificationResponse
• IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse
• IntlAddressVerificationGetAutocompletePreviewsResponse
• IntlAddressVerificationVerifyResponse

Methods:

• client.intlAddressVerification.autocomplete({ ...params }) -> IntlAddressVerificationAutocompleteResponse
• client.intlAddressVerification.batchVerification({ ...params }) -> IntlAddressVerificationBatchVerificationResponse
• client.intlAddressVerification.getAutocompleteAdvancedPreviews({ ...params }) -> IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse
• client.intlAddressVerification.getAutocompletePreviews({ ...params }) -> IntlAddressVerificationGetAutocompletePreviewsResponse
• client.intlAddressVerification.verify({ ...params }) -> IntlAddressVerificationVerifyResponse

BulkVerification

Types:

• AddverList
• BulkVerificationRetrieveResponse
• BulkVerificationListResponse
• BulkVerificationUploadResponse

Methods:

• client.bulkVerification.retrieve(id) -> BulkVerificationRetrieveResponse
• client.bulkVerification.list({ ...params }) -> BulkVerificationListResponse
• client.bulkVerification.upload({ ...params }) -> BulkVerificationUploadResponse

PrintMail

Contacts

Types:

• Contact
• ContactCreate
• ContactCreateWithCompanyName
• ContactCreateWithFirstName
• ContactDeleteResponse

Methods:

• client.printMail.contacts.create({ ...params }) -> Contact
• client.printMail.contacts.retrieve(id) -> Contact
• client.printMail.contacts.list({ ...params }) -> ContactsSkipLimit
• client.printMail.contacts.delete(id) -> ContactDeleteResponse

Templates

Types:

• Template
• TemplateDeleteResponse

Methods:

• client.printMail.templates.create({ ...params }) -> Template
• client.printMail.templates.retrieve(id) -> Template
• client.printMail.templates.update(id, { ...params }) -> Template
• client.printMail.templates.list({ ...params }) -> TemplatesSkipLimit
• client.printMail.templates.delete(id) -> TemplateDeleteResponse

Trackers

Types:

• TrackerCreateResponse
• TrackerRetrieveResponse
• TrackerUpdateResponse
• TrackerListResponse
• TrackerDeleteResponse
• TrackerRetrieveVisitsResponse

Methods:

• client.printMail.trackers.create({ ...params }) -> TrackerCreateResponse
• client.printMail.trackers.retrieve(id) -> TrackerRetrieveResponse
• client.printMail.trackers.update(id, { ...params }) -> TrackerUpdateResponse
• client.printMail.trackers.list({ ...params }) -> TrackerListResponsesSkipLimit
• client.printMail.trackers.delete(id) -> TrackerDeleteResponse
• client.printMail.trackers.retrieveVisits(id, { ...params }) -> TrackerRetrieveVisitsResponsesSkipLimit

Webhooks

Types:

• Webhook
• WebhookInvocation
• WebhookDeleteResponse

Methods:

• client.printMail.webhooks.create({ ...params }) -> Webhook
• client.printMail.webhooks.retrieve(id) -> Webhook
• client.printMail.webhooks.update(id, { ...params }) -> Webhook
• client.printMail.webhooks.list({ ...params }) -> WebhooksSkipLimit
• client.printMail.webhooks.delete(id) -> WebhookDeleteResponse
• client.printMail.webhooks.listInvocations(id, { ...params }) -> WebhookInvocationsSkipLimit

Events

Types:

• Event

Methods:

• client.printMail.events.list({ ...params }) -> EventsSkipLimit

Letters

Types:

• AddressPlacement
• AttachedPdf
• Letter
• LetterSize
• PlasticCard
• LetterCreateResponse
• LetterRetrieveURLResponse

Methods:

• client.printMail.letters.create({ ...params }) -> LetterCreateResponse
• client.printMail.letters.retrieve(id) -> Letter
• client.printMail.letters.list({ ...params }) -> LettersSkipLimit
• client.printMail.letters.delete(id) -> Letter
• client.printMail.letters.cancel(id, { ...params }) -> Letter
• client.printMail.letters.progress(id) -> Letter
• client.printMail.letters.retrieveURL(id) -> LetterRetrieveURLResponse

Postcards

Types:

• Postcard
• PostcardCreateResponse
• PostcardRetrieveURLResponse

Methods:

• client.printMail.postcards.create({ ...params }) -> PostcardCreateResponse
• client.printMail.postcards.retrieve(id) -> Postcard
• client.printMail.postcards.list({ ...params }) -> PostcardsSkipLimit
• client.printMail.postcards.delete(id) -> Postcard
• client.printMail.postcards.cancel(id, { ...params }) -> Postcard
• client.printMail.postcards.progress(id) -> Postcard
• client.printMail.postcards.retrieveURL(id) -> PostcardRetrieveURLResponse

BankAccounts

Types:

• BankAccount
• BankAccountCountryCode
• BankAccountDeleteResponse

Methods:

• client.printMail.bankAccounts.create({ ...params }) -> BankAccount
• client.printMail.bankAccounts.retrieve(id) -> BankAccount
• client.printMail.bankAccounts.list({ ...params }) -> BankAccountsSkipLimit
• client.printMail.bankAccounts.delete(id) -> BankAccountDeleteResponse

Cheques

Types:

• Cheque
• ChequeSize
• DigitalOnly
• ChequeRetrieveURLResponse

Methods:

• client.printMail.cheques.create({ ...params }) -> Cheque
• client.printMail.cheques.retrieve(id) -> Cheque
• client.printMail.cheques.list({ ...params }) -> ChequesSkipLimit
• client.printMail.cheques.delete(id) -> Cheque
• client.printMail.cheques.cancel(id, { ...params }) -> Cheque
• client.printMail.cheques.progress(id) -> Cheque
• client.printMail.cheques.retrieveURL(id) -> ChequeRetrieveURLResponse
• client.printMail.cheques.retrieveWithDepositReadyPdf(id) -> Cheque

SelfMailers

Types:

• SelfMailer
• SelfMailerCreateResponse
• SelfMailerRetrieveURLResponse

Methods:

• client.printMail.selfMailers.create({ ...params }) -> SelfMailerCreateResponse
• client.printMail.selfMailers.retrieve(id) -> SelfMailer
• client.printMail.selfMailers.list({ ...params }) -> SelfMailersSkipLimit
• client.printMail.selfMailers.delete(id) -> SelfMailer
• client.printMail.selfMailers.progress(id) -> SelfMailer
• client.printMail.selfMailers.retrieveURL(id) -> SelfMailerRetrieveURLResponse

ReturnEnvelopes

Types:

• ReturnEnvelope

Methods:

• client.printMail.returnEnvelopes.create({ ...params }) -> ReturnEnvelope
• client.printMail.returnEnvelopes.retrieve(id) -> ReturnEnvelope
• client.printMail.returnEnvelopes.list({ ...params }) -> ReturnEnvelopesSkipLimit

Orders

Types:

• ReturnEnvelopeOrder

Methods:

• client.printMail.returnEnvelopes.orders.create(id, { ...params }) -> ReturnEnvelopeOrder
• client.printMail.returnEnvelopes.orders.retrieve(orderID, { ...params }) -> ReturnEnvelopeOrder
• client.printMail.returnEnvelopes.orders.list(id, { ...params }) -> ReturnEnvelopeOrdersSkipLimit
• client.printMail.returnEnvelopes.orders.cancel(orderID, { ...params }) -> ReturnEnvelopeOrder
• client.printMail.returnEnvelopes.orders.fill(orderID, { ...params }) -> ReturnEnvelopeOrder

Campaigns

Types:

• Campaign
• CampaignDeleteResponse

Methods:

• client.printMail.campaigns.create({ ...params }) -> Campaign
• client.printMail.campaigns.retrieve(id) -> Campaign
• client.printMail.campaigns.update(id, { ...params }) -> Campaign
• client.printMail.campaigns.list({ ...params }) -> CampaignsSkipLimit
• client.printMail.campaigns.delete(id) -> CampaignDeleteResponse
• client.printMail.campaigns.send(id, { ...params }) -> Campaign

MailingListImports

Types:

• FileType
• MailingListImportResponse
• VerificationStatusCount
• MailingListImportDeleteResponse

Methods:

• client.printMail.mailingListImports.create({ ...params }) -> MailingListImportResponse
• client.printMail.mailingListImports.retrieve(id) -> MailingListImportResponse
• client.printMail.mailingListImports.update(id, { ...params }) -> MailingListImportResponse
• client.printMail.mailingListImports.list({ ...params }) -> MailingListImportResponsesSkipLimit
• client.printMail.mailingListImports.delete(id) -> MailingListImportDeleteResponse

MailingLists

Types:

• MailingList
• MailingListUpdate
• MailingListDeleteResponse

Methods:

• client.printMail.mailingLists.create({ ...params }) -> MailingList
• client.printMail.mailingLists.retrieve(id) -> MailingList
• client.printMail.mailingLists.update(id, { ...params }) -> MailingListUpdate
• client.printMail.mailingLists.list({ ...params }) -> MailingListsSkipLimit
• client.printMail.mailingLists.delete(id) -> MailingListDeleteResponse
• client.printMail.mailingLists.jobs(id, { ...params }) -> MailingList

Reports

Types:

• DeletedResponse
• Report

Methods:

• client.printMail.reports.create({ ...params }) -> Report
• client.printMail.reports.retrieve(id) -> Report
• client.printMail.reports.update(id, { ...params }) -> Report
• client.printMail.reports.list({ ...params }) -> ReportsSkipLimit
• client.printMail.reports.delete(id) -> DeletedResponse
• client.printMail.reports.sample({ ...params }) -> ReportSample

Samples

Types:

• ReportSample
• ReportSampleCreateBase

Methods:

• client.printMail.reports.samples.create(id, { ...params }) -> ReportSample

Exports

Types:

• ReportExport

Methods:

• client.printMail.reports.exports.create(reportID, { ...params }) -> ReportExport
• client.printMail.reports.exports.retrieve(exportID, { ...params }) -> ReportExport
• client.printMail.reports.exports.delete(exportID, { ...params }) -> DeletedResponse

SubOrganizations

Types:

• EmailPreferences
• SubOrganization
• SubOrganizationCreateResponse
• SubOrganizationRetrieveUsersResponse

Methods:

• client.printMail.subOrganizations.create({ ...params }) -> SubOrganizationCreateResponse
• client.printMail.subOrganizations.retrieve(id) -> SubOrganization
• client.printMail.subOrganizations.list({ ...params }) -> SubOrganizationsSkipLimit
• client.printMail.subOrganizations.retrieveUsers(id, { ...params }) -> SubOrganizationRetrieveUsersResponse

Boxes

Types:

• BoxCreateResponse
• BoxRetrieveResponse
• BoxListResponse
• BoxDeleteResponse
• BoxProgressionsResponse

Methods:

• client.printMail.boxes.create({ ...params }) -> BoxCreateResponse
• client.printMail.boxes.retrieve(id) -> BoxRetrieveResponse
• client.printMail.boxes.list({ ...params }) -> BoxListResponsesSkipLimit
• client.printMail.boxes.delete(id) -> BoxDeleteResponse
• client.printMail.boxes.progressions(id) -> BoxProgressionsResponse

SnapPacks

Types:

• SnapPack
• SnapPackCreateResponse
• SnapPackRetrieveCapabilitiesResponse

Methods:

• client.printMail.snapPacks.create({ ...params }) -> SnapPackCreateResponse
• client.printMail.snapPacks.retrieve(id) -> SnapPack
• client.printMail.snapPacks.list({ ...params }) -> SnapPacksSkipLimit
• client.printMail.snapPacks.delete(id) -> SnapPack
• client.printMail.snapPacks.progressions(id) -> SnapPack
• client.printMail.snapPacks.retrieveCapabilities({ ...params }) -> SnapPackRetrieveCapabilitiesResponse

TargetedListBuilds

Types:

• TargetedListBuildCreateResponse
• TargetedListBuildRetrieveResponse
• TargetedListBuildUpdateResponse
• TargetedListBuildListResponse
• TargetedListBuildDeleteResponse
• TargetedListBuildConfirmResponse

Methods:

• client.printMail.targetedListBuilds.create({ ...params }) -> TargetedListBuildCreateResponse
• client.printMail.targetedListBuilds.retrieve(id) -> TargetedListBuildRetrieveResponse
• client.printMail.targetedListBuilds.update(id, { ...params }) -> TargetedListBuildUpdateResponse
• client.printMail.targetedListBuilds.list({ ...params }) -> TargetedListBuildListResponsesSkipLimit
• client.printMail.targetedListBuilds.delete(id) -> TargetedListBuildDeleteResponse
• client.printMail.targetedListBuilds.confirm(id) -> TargetedListBuildConfirmResponse

Filters

Types:

• FilterAutocompleteResponse

Methods:

• client.printMail.targetedListBuilds.filters.autocomplete({ ...params }) -> FilterAutocompleteResponse

TemplateEditorSessions

Types:

• TemplateEditorSessionCreateResponse
• TemplateEditorSessionListResponse
• TemplateEditorSessionDeleteResponse

Methods:

• client.printMail.templateEditorSessions.create({ ...params }) -> TemplateEditorSessionCreateResponse
• client.printMail.templateEditorSessions.list({ ...params }) -> TemplateEditorSessionListResponsesSkipLimit
• client.printMail.templateEditorSessions.delete(id) -> TemplateEditorSessionDeleteResponse

VirtualMailboxes

Types:

• VirtualMailboxCreateResponse
• VirtualMailboxRetrieveResponse
• VirtualMailboxListResponse
• VirtualMailboxRetrieveAddressResponse

Methods:

• client.printMail.virtualMailboxes.create({ ...params }) -> VirtualMailboxCreateResponse
• client.printMail.virtualMailboxes.retrieve(id) -> VirtualMailboxRetrieveResponse
• client.printMail.virtualMailboxes.list({ ...params }) -> VirtualMailboxListResponsesSkipLimit
• client.printMail.virtualMailboxes.retrieveAddress(id) -> VirtualMailboxRetrieveAddressResponse

Items

Types:

• ItemCreateResponse
• ItemRetrieveResponse
• ItemListResponse

Methods:

• client.printMail.virtualMailboxes.items.create(id, { ...params }) -> ItemCreateResponse
• client.printMail.virtualMailboxes.items.retrieve(itemID, { ...params }) -> ItemRetrieveResponse
• client.printMail.virtualMailboxes.items.list(id, { ...params }) -> ItemListResponsesSkipLimit