postgrid-node 0.1.0-alpha.3 → 0.1.0-alpha.5

package/src/resources/cheques/cheques.ts

@@ -40,6 +40,19 @@ export class Cheques extends APIResource {
    *   }
    * }
    * ```
+   *
+   * @example
+   * ```ts
+   * const cheque = await client.cheques.create({
+   *   amount: 1000,
+   *   bankAccount: 'bank_123',
+   *   from: 'contact_123',
+   *   to: 'contact_123',
+   *   currencyCode: 'USD',
+   *   number: 123456,
+   *   size: 'us_letter',
+   * });
+   * ```
    */
   create(body: ChequeCreateParams, options?: Core.RequestOptions): Core.APIPromise<Cheque> {
     return this._client.post('/cheques', { body, ...options });
@@ -47,6 +60,11 @@ export class Cheques extends APIResource {
 
   /**
    * Retrieve a cheque by ID.
+   *
+   * @example
+   * ```ts
+   * const cheque = await client.cheques.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Cheque> {
     return this._client.get(`/cheques/${id}`, options);
@@ -54,6 +72,14 @@ export class Cheques extends APIResource {
 
   /**
    * Get a list of cheques.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const cheque of client.cheques.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: ChequeListParams, options?: Core.RequestOptions): Core.PagePromise<ChequesList, Cheque>;
   list(options?: Core.RequestOptions): Core.PagePromise<ChequesList, Cheque>;
@@ -69,6 +95,11 @@ export class Cheques extends APIResource {
 
   /**
    * Cancel a cheque by ID. Note that this operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const cheque = await client.cheques.cancel('id');
+   * ```
    */
   cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<Cheque> {
     return this._client.delete(`/cheques/${id}`, options);
@@ -246,7 +277,7 @@ export interface Cheque {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * The message of the cheque.
@@ -256,7 +287,7 @@ export interface Cheque {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The number of the cheque. If you don't provide this, it will automatically be
@@ -410,7 +441,7 @@ export interface ChequeCreateParams {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * The message of the cheque.
@@ -420,7 +451,7 @@ export interface ChequeCreateParams {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The number of the cheque. If you don't provide this, it will automatically be

package/src/resources/cheques/url.ts

@@ -11,6 +11,11 @@ export class URL extends APIResource {
    * offers document generation and hosting capabilities. This endpoint has a much
    * higher rate limit than the regular order retrieval endpoint, so it is suitable
    * for customer-facing use-cases.
+   *
+   * @example
+   * ```ts
+   * const url = await client.cheques.url.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<URLRetrieveResponse> {
     return this._client.get(`/cheques/${id}/url`, options);

package/src/resources/cheques/with-deposit-ready-pdf.ts

@@ -10,6 +10,12 @@ export class WithDepositReadyPdf extends APIResource {
    * be called by users with 'Admin' role. In test mode, the preview PDF of the
    * digitalOnly cheque and the deposit-ready PDF are the same. In live mode, the
    * deposit-ready will have the full account number.
+   *
+   * @example
+   * ```ts
+   * const cheque =
+   *   await client.cheques.withDepositReadyPdf.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ChequesAPI.Cheque> {
     return this._client.get(`/cheques/${id}/with_deposit_ready_pdf`, options);

package/src/resources/contacts.ts

@@ -20,6 +20,16 @@ export class Contacts extends APIResource {
    * _Note that if you create a contact that has identical information to another
    * contact, this will simply update the description of the existing contact and
    * return it. This avoids creating duplicate contacts._
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.create({
+   *   addressLine1: '90 Canal St Suite 600, Boston MA 90210',
+   *   countryCode: 'US',
+   *   firstName: 'Kevin',
+   *   companyName: 'PostGrid',
+   * });
+   * ```
    */
   create(body: ContactCreateParams, options?: Core.RequestOptions): Core.APIPromise<Contact> {
     return this._client.post('/contacts', { body, ...options });
@@ -27,6 +37,11 @@ export class Contacts extends APIResource {
 
   /**
    * Retrieve a contact.
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Contact> {
     return this._client.get(`/contacts/${id}`, options);
@@ -34,6 +49,14 @@ export class Contacts extends APIResource {
 
   /**
    * Get a list of contacts.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const contact of client.contacts.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: ContactListParams, options?: Core.RequestOptions): Core.PagePromise<ContactsList, Contact>;
   list(options?: Core.RequestOptions): Core.PagePromise<ContactsList, Contact>;
@@ -50,6 +73,11 @@ export class Contacts extends APIResource {
   /**
    * Delete a contact. Note that this will not affect orders that were sent to this
    * contact.
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.delete('id');
+   * ```
    */
   delete(id: string, options?: Core.RequestOptions): Core.APIPromise<ContactDeleteResponse> {
     return this._client.delete(`/contacts/${id}`, options);
@@ -155,7 +183,7 @@ export interface Contact {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * Phone number of the contact.
@@ -256,7 +284,7 @@ export declare namespace ContactCreateParams {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * Phone number of the contact.
@@ -338,7 +366,7 @@ export declare namespace ContactCreateParams {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * Phone number of the contact.

package/src/resources/index.ts

@@ -59,6 +59,33 @@ export {
   type LetterCreateParams,
   type LetterListParams,
 } from './letters';
+export {
+  MailingListImportListResponsesList,
+  MailingListImports,
+  type MailingListImportCreateResponse,
+  type MailingListImportRetrieveResponse,
+  type MailingListImportUpdateResponse,
+  type MailingListImportListResponse,
+  type MailingListImportDeleteResponse,
+  type MailingListImportCreateParams,
+  type MailingListImportUpdateParams,
+  type MailingListImportListParams,
+} from './mailing-list-imports';
+export {
+  MailingListListResponsesList,
+  MailingLists,
+  type MailingListCreateResponse,
+  type MailingListRetrieveResponse,
+  type MailingListUpdateResponse,
+  type MailingListListResponse,
+  type MailingListDeleteResponse,
+  type MailingListSubmitJobResponse,
+  type MailingListCreateParams,
+  type MailingListUpdateParams,
+  type MailingListListParams,
+  type MailingListSubmitJobParams,
+} from './mailing-lists';
+export { OrderProfiles } from './order-profiles/order-profiles';
 export {
   PostcardsList,
   Postcards,
@@ -91,9 +118,21 @@ export {
   type SelfMailerRetrieveResponse,
   type SelfMailerListResponse,
   type SelfMailerCancelResponse,
+  type SelfMailerRetrievePreviewURLResponse,
   type SelfMailerCreateParams,
   type SelfMailerListParams,
 } from './self-mailers';
+export {
+  SubOrganizationListResponsesList,
+  SubOrganizations,
+  type SubOrganizationCreateResponse,
+  type SubOrganizationRetrieveResponse,
+  type SubOrganizationListResponse,
+  type SubOrganizationListUsersResponse,
+  type SubOrganizationCreateParams,
+  type SubOrganizationListParams,
+  type SubOrganizationListUsersParams,
+} from './sub-organizations';
 export {
   TemplatesList,
   Templates,

package/src/resources/letters.ts

@@ -15,6 +15,15 @@ export class Letters extends APIResource {
    * - A template ID for the letter
    * - A URL or file for a PDF for the letter
    * - Upload the aforementioned PDF file via a multipart form upload request
+   *
+   * @example
+   * ```ts
+   * const letter = await client.letters.create({
+   *   from: 'contact_123',
+   *   html: '<html>Content</html>',
+   *   to: 'contact_123',
+   * });
+   * ```
    */
   create(body: LetterCreateParams, options?: Core.RequestOptions): Core.APIPromise<Letter> {
     return this._client.post('/letters', { body, ...options });
@@ -22,6 +31,11 @@ export class Letters extends APIResource {
 
   /**
    * Retrieve a letter by ID.
+   *
+   * @example
+   * ```ts
+   * const letter = await client.letters.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Letter> {
     return this._client.get(`/letters/${id}`, options);
@@ -29,6 +43,14 @@ export class Letters extends APIResource {
 
   /**
    * Get a list of letters.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const letter of client.letters.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(query?: LetterListParams, options?: Core.RequestOptions): Core.PagePromise<LettersList, Letter>;
   list(options?: Core.RequestOptions): Core.PagePromise<LettersList, Letter>;
@@ -44,6 +66,11 @@ export class Letters extends APIResource {
 
   /**
    * Cancel a letter by ID. Note that this operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const letter = await client.letters.delete('id');
+   * ```
    */
   delete(id: string, options?: Core.RequestOptions): Core.APIPromise<Letter> {
     return this._client.delete(`/letters/${id}`, options);
@@ -56,6 +83,11 @@ export class Letters extends APIResource {
    * offers document generation and hosting capabilities. This endpoint has a much
    * higher rate limit than the regular order retrieval endpoint, so it is suitable
    * for customer-facing use-cases.
+   *
+   * @example
+   * ```ts
+   * const response = await client.letters.url('id');
+   * ```
    */
   url(id: string, options?: Core.RequestOptions): Core.APIPromise<LetterURLResponse> {
     return this._client.get(`/letters/${id}/url`, options);
@@ -217,12 +249,12 @@ export interface Letter {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The ID of the PDF workflow run that created the letter, if any.
@@ -492,12 +524,12 @@ export declare namespace LetterCreateParams {
      * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
      * PDFs uploaded with the order.
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * If specified, indicates which letter page is perforated. Currently, only the
@@ -717,12 +749,12 @@ export declare namespace LetterCreateParams {
      * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
      * PDFs uploaded with the order.
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * If specified, indicates which letter page is perforated. Currently, only the