Skip to content

Commit 9dd7392

Browse files
chore(docs): add missing descriptions
1 parent d60d095 commit 9dd7392

15 files changed

Lines changed: 672 additions & 0 deletions

src/postgrid/_client.py

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,24 @@ def __init__(
113113

114114
@cached_property
115115
def address_verification(self) -> AddressVerificationResource:
116+
"""Standard Address Verification API.
117+
118+
Provides endpoints to verify and standardize addresses across US and Canada,
119+
supporting both structured and freeform inputs.
120+
121+
Note that this uses a different set of lookups than our international API.
122+
"""
116123
from .resources.address_verification import AddressVerificationResource
117124

118125
return AddressVerificationResource(self)
119126

120127
@cached_property
121128
def intl_address_verification(self) -> IntlAddressVerificationResource:
129+
"""International Address Verification API.
130+
131+
Provides endpoints to verify and standardize international addresses,
132+
supporting both structured and freeform inputs.
133+
"""
122134
from .resources.intl_address_verification import IntlAddressVerificationResource
123135

124136
return IntlAddressVerificationResource(self)
@@ -341,12 +353,24 @@ def __init__(
341353

342354
@cached_property
343355
def address_verification(self) -> AsyncAddressVerificationResource:
356+
"""Standard Address Verification API.
357+
358+
Provides endpoints to verify and standardize addresses across US and Canada,
359+
supporting both structured and freeform inputs.
360+
361+
Note that this uses a different set of lookups than our international API.
362+
"""
344363
from .resources.address_verification import AsyncAddressVerificationResource
345364

346365
return AsyncAddressVerificationResource(self)
347366

348367
@cached_property
349368
def intl_address_verification(self) -> AsyncIntlAddressVerificationResource:
369+
"""International Address Verification API.
370+
371+
Provides endpoints to verify and standardize international addresses,
372+
supporting both structured and freeform inputs.
373+
"""
350374
from .resources.intl_address_verification import AsyncIntlAddressVerificationResource
351375

352376
return AsyncIntlAddressVerificationResource(self)
@@ -516,12 +540,24 @@ def __init__(self, client: PostGrid) -> None:
516540

517541
@cached_property
518542
def address_verification(self) -> address_verification.AddressVerificationResourceWithRawResponse:
543+
"""Standard Address Verification API.
544+
545+
Provides endpoints to verify and standardize addresses across US and Canada,
546+
supporting both structured and freeform inputs.
547+
548+
Note that this uses a different set of lookups than our international API.
549+
"""
519550
from .resources.address_verification import AddressVerificationResourceWithRawResponse
520551

521552
return AddressVerificationResourceWithRawResponse(self._client.address_verification)
522553

523554
@cached_property
524555
def intl_address_verification(self) -> intl_address_verification.IntlAddressVerificationResourceWithRawResponse:
556+
"""International Address Verification API.
557+
558+
Provides endpoints to verify and standardize international addresses,
559+
supporting both structured and freeform inputs.
560+
"""
525561
from .resources.intl_address_verification import IntlAddressVerificationResourceWithRawResponse
526562

527563
return IntlAddressVerificationResourceWithRawResponse(self._client.intl_address_verification)
@@ -541,6 +577,13 @@ def __init__(self, client: AsyncPostGrid) -> None:
541577

542578
@cached_property
543579
def address_verification(self) -> address_verification.AsyncAddressVerificationResourceWithRawResponse:
580+
"""Standard Address Verification API.
581+
582+
Provides endpoints to verify and standardize addresses across US and Canada,
583+
supporting both structured and freeform inputs.
584+
585+
Note that this uses a different set of lookups than our international API.
586+
"""
544587
from .resources.address_verification import AsyncAddressVerificationResourceWithRawResponse
545588

546589
return AsyncAddressVerificationResourceWithRawResponse(self._client.address_verification)
@@ -549,6 +592,11 @@ def address_verification(self) -> address_verification.AsyncAddressVerificationR
549592
def intl_address_verification(
550593
self,
551594
) -> intl_address_verification.AsyncIntlAddressVerificationResourceWithRawResponse:
595+
"""International Address Verification API.
596+
597+
Provides endpoints to verify and standardize international addresses,
598+
supporting both structured and freeform inputs.
599+
"""
552600
from .resources.intl_address_verification import AsyncIntlAddressVerificationResourceWithRawResponse
553601

554602
return AsyncIntlAddressVerificationResourceWithRawResponse(self._client.intl_address_verification)
@@ -568,6 +616,13 @@ def __init__(self, client: PostGrid) -> None:
568616

569617
@cached_property
570618
def address_verification(self) -> address_verification.AddressVerificationResourceWithStreamingResponse:
619+
"""Standard Address Verification API.
620+
621+
Provides endpoints to verify and standardize addresses across US and Canada,
622+
supporting both structured and freeform inputs.
623+
624+
Note that this uses a different set of lookups than our international API.
625+
"""
571626
from .resources.address_verification import AddressVerificationResourceWithStreamingResponse
572627

573628
return AddressVerificationResourceWithStreamingResponse(self._client.address_verification)
@@ -576,6 +631,11 @@ def address_verification(self) -> address_verification.AddressVerificationResour
576631
def intl_address_verification(
577632
self,
578633
) -> intl_address_verification.IntlAddressVerificationResourceWithStreamingResponse:
634+
"""International Address Verification API.
635+
636+
Provides endpoints to verify and standardize international addresses,
637+
supporting both structured and freeform inputs.
638+
"""
579639
from .resources.intl_address_verification import IntlAddressVerificationResourceWithStreamingResponse
580640

581641
return IntlAddressVerificationResourceWithStreamingResponse(self._client.intl_address_verification)
@@ -595,6 +655,13 @@ def __init__(self, client: AsyncPostGrid) -> None:
595655

596656
@cached_property
597657
def address_verification(self) -> address_verification.AsyncAddressVerificationResourceWithStreamingResponse:
658+
"""Standard Address Verification API.
659+
660+
Provides endpoints to verify and standardize addresses across US and Canada,
661+
supporting both structured and freeform inputs.
662+
663+
Note that this uses a different set of lookups than our international API.
664+
"""
598665
from .resources.address_verification import AsyncAddressVerificationResourceWithStreamingResponse
599666

600667
return AsyncAddressVerificationResourceWithStreamingResponse(self._client.address_verification)
@@ -603,6 +670,11 @@ def address_verification(self) -> address_verification.AsyncAddressVerificationR
603670
def intl_address_verification(
604671
self,
605672
) -> intl_address_verification.AsyncIntlAddressVerificationResourceWithStreamingResponse:
673+
"""International Address Verification API.
674+
675+
Provides endpoints to verify and standardize international addresses,
676+
supporting both structured and freeform inputs.
677+
"""
606678
from .resources.intl_address_verification import AsyncIntlAddressVerificationResourceWithStreamingResponse
607679

608680
return AsyncIntlAddressVerificationResourceWithStreamingResponse(self._client.intl_address_verification)

src/postgrid/resources/address_verification.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@
2424

2525

2626
class AddressVerificationResource(SyncAPIResource):
27+
"""Standard Address Verification API.
28+
29+
Provides endpoints to verify and standardize addresses across US and Canada,
30+
supporting both structured and freeform inputs.
31+
32+
Note that this uses a different set of lookups than our international API.
33+
"""
34+
2735
@cached_property
2836
def with_raw_response(self) -> AddressVerificationResourceWithRawResponse:
2937
"""
@@ -162,6 +170,14 @@ def verify(
162170

163171

164172
class AsyncAddressVerificationResource(AsyncAPIResource):
173+
"""Standard Address Verification API.
174+
175+
Provides endpoints to verify and standardize addresses across US and Canada,
176+
supporting both structured and freeform inputs.
177+
178+
Note that this uses a different set of lookups than our international API.
179+
"""
180+
165181
@cached_property
166182
def with_raw_response(self) -> AsyncAddressVerificationResourceWithRawResponse:
167183
"""

src/postgrid/resources/intl_address_verification.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@
2424

2525

2626
class IntlAddressVerificationResource(SyncAPIResource):
27+
"""International Address Verification API.
28+
29+
Provides endpoints to verify and standardize international addresses,
30+
supporting both structured and freeform inputs.
31+
"""
32+
2733
@cached_property
2834
def with_raw_response(self) -> IntlAddressVerificationResourceWithRawResponse:
2935
"""
@@ -152,6 +158,12 @@ def verify(
152158

153159

154160
class AsyncIntlAddressVerificationResource(AsyncAPIResource):
161+
"""International Address Verification API.
162+
163+
Provides endpoints to verify and standardize international addresses,
164+
supporting both structured and freeform inputs.
165+
"""
166+
155167
@cached_property
156168
def with_raw_response(self) -> AsyncIntlAddressVerificationResourceWithRawResponse:
157169
"""

src/postgrid/resources/print_mail/campaigns.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232

3333

3434
class CampaignsResource(SyncAPIResource):
35+
"""
36+
The campaigns API enables you to send out large volumes of fully
37+
personalized mail to a mailing list.
38+
"""
39+
3540
@cached_property
3641
def with_raw_response(self) -> CampaignsResourceWithRawResponse:
3742
"""
@@ -378,6 +383,11 @@ def send(
378383

379384

380385
class AsyncCampaignsResource(AsyncAPIResource):
386+
"""
387+
The campaigns API enables you to send out large volumes of fully
388+
personalized mail to a mailing list.
389+
"""
390+
381391
@cached_property
382392
def with_raw_response(self) -> AsyncCampaignsResourceWithRawResponse:
383393
"""

src/postgrid/resources/print_mail/mailing_list_imports.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232

3333

3434
class MailingListImportsResource(SyncAPIResource):
35+
"""
36+
The mailing list imports API enables you to import contact lists from files
37+
and validate them for use in campaigns.
38+
"""
39+
3540
@cached_property
3641
def with_raw_response(self) -> MailingListImportsResourceWithRawResponse:
3742
"""
@@ -298,6 +303,11 @@ def delete(
298303

299304

300305
class AsyncMailingListImportsResource(AsyncAPIResource):
306+
"""
307+
The mailing list imports API enables you to import contact lists from files
308+
and validate them for use in campaigns.
309+
"""
310+
301311
@cached_property
302312
def with_raw_response(self) -> AsyncMailingListImportsResourceWithRawResponse:
303313
"""

src/postgrid/resources/print_mail/order_profiles/cheques.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@
4747

4848

4949
class ChequesResource(SyncAPIResource):
50+
"""
51+
Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers).
52+
They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata.
53+
Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.
54+
55+
Profiles are environment-specific (live vs. test).
56+
"""
57+
5058
@cached_property
5159
def with_raw_response(self) -> ChequesResourceWithRawResponse:
5260
"""
@@ -445,6 +453,14 @@ def delete(
445453

446454

447455
class AsyncChequesResource(AsyncAPIResource):
456+
"""
457+
Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers).
458+
They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata.
459+
Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.
460+
461+
Profiles are environment-specific (live vs. test).
462+
"""
463+
448464
@cached_property
449465
def with_raw_response(self) -> AsyncChequesResourceWithRawResponse:
450466
"""

src/postgrid/resources/print_mail/order_profiles/letters.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@
3636

3737

3838
class LettersResource(SyncAPIResource):
39+
"""
40+
Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers).
41+
They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata.
42+
Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.
43+
44+
Profiles are environment-specific (live vs. test).
45+
"""
46+
3947
@cached_property
4048
def with_raw_response(self) -> LettersResourceWithRawResponse:
4149
"""
@@ -442,6 +450,14 @@ def delete(
442450

443451

444452
class AsyncLettersResource(AsyncAPIResource):
453+
"""
454+
Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers).
455+
They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata.
456+
Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.
457+
458+
Profiles are environment-specific (live vs. test).
459+
"""
460+
445461
@cached_property
446462
def with_raw_response(self) -> AsyncLettersResourceWithRawResponse:
447463
"""

0 commit comments

Comments
 (0)