postgrid-node 0.1.0-alpha.5 → 0.2.0

package/resources/print-mail/bank-accounts.d.mts

@@ -0,0 +1,345 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class BankAccounts extends APIResource {
+    /**
+     * Create a bank account. A US bank account is created by setting `bankCountryCode`
+     * to `US` and providing `accountNumber` and `routingNumber`. A canadian bank
+     * account can be created by specifying `bankCountryCode` as `CA` and setting
+     * `accountNumber`, `routeNumber`, and `transitNumber` accordingly.
+     *
+     * You must specify _either_ `signatureImage` or `signatureText`. The image can be
+     * supplied as either a URL or a multipart file upload.
+     *
+     * @example
+     * ```ts
+     * const bankAccount =
+     *   await client.printMail.bankAccounts.create({
+     *     accountNumber: '1234567',
+     *     bankCountryCode: 'US',
+     *     bankName: 'Test Bank',
+     *     signatureText: 'Example',
+     *     bankPrimaryLine: '145 mulberry st',
+     *     bankSecondaryLine: 'new york ny 10013',
+     *     routingNumber: '123456789',
+     *   });
+     * ```
+     */
+    create(body: BankAccountCreateParams, options?: RequestOptions): APIPromise<BankAccount>;
+    /**
+     * Retrieve a bank account by ID.
+     *
+     * @example
+     * ```ts
+     * const bankAccount =
+     *   await client.printMail.bankAccounts.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<BankAccount>;
+    /**
+     * Get a list of bank accounts.
+     *
+     * @example
+     * ```ts
+     * const bankAccounts =
+     *   await client.printMail.bankAccounts.list();
+     * ```
+     */
+    list(query?: BankAccountListParams | null | undefined, options?: RequestOptions): APIPromise<BankAccountListResponse>;
+    /**
+     * Delete a bank account by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const bankAccount =
+     *   await client.printMail.bankAccounts.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<BankAccountDeleteResponse>;
+}
+export interface BankAccount {
+    /**
+     * A unique ID prefixed with bank*account*
+     */
+    id: string;
+    /**
+     * The account number of the bank account.
+     */
+    accountNumber: string;
+    /**
+     * Countries typically have different bank account formats and standards. These are
+     * the countries which PostGrid's bank accounts API supports.
+     */
+    bankCountryCode: BankAccountCountryCode;
+    /**
+     * The name of the bank.
+     */
+    bankName: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `bank_account`.
+     */
+    object: 'bank_account';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The primary address line of the bank.
+     */
+    bankPrimaryLine?: string;
+    /**
+     * The secondary address line of the bank.
+     */
+    bankSecondaryLine?: string;
+    /**
+     * The designation number of the bank account (for CA).
+     */
+    caDesignationNumber?: string;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The route number of the bank account (for CA).
+     */
+    routeNumber?: string;
+    /**
+     * The routing number of the bank account (for US).
+     */
+    routingNumber?: string;
+    /**
+     * A signed link to the signature image uploaded when this bank account was
+     * created. This is omitted if `signatureText` is present.
+     */
+    signatureImage?: string;
+    /**
+     * The signature text PostGrid uses to generate a signature for cheques created
+     * using this bank account. This is omitted if `signatureImage` is present.
+     */
+    signatureText?: string;
+    /**
+     * The transit number of the bank account (for CA).
+     */
+    transitNumber?: string;
+}
+/**
+ * Countries typically have different bank account formats and standards. These are
+ * the countries which PostGrid's bank accounts API supports.
+ */
+export type BankAccountCountryCode = 'CA' | 'US';
+export interface BankAccountListResponse {
+    data: Array<BankAccount>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface BankAccountDeleteResponse {
+    /**
+     * A unique ID prefixed with bank*account*
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `bank_account`.
+     */
+    object: 'bank_account';
+}
+export type BankAccountCreateParams = BankAccountCreateParams.BankAccountCreateSignatureText | BankAccountCreateParams.BankAccountCreateSignatureImageURL | BankAccountCreateParams.BankAccountCreateSignatureImageFile;
+export declare namespace BankAccountCreateParams {
+    interface BankAccountCreateSignatureText {
+        /**
+         * The account number of the bank account.
+         */
+        accountNumber: string;
+        /**
+         * Countries typically have different bank account formats and standards. These are
+         * the countries which PostGrid's bank accounts API supports.
+         */
+        bankCountryCode: BankAccountCountryCode;
+        /**
+         * The name of the bank.
+         */
+        bankName: string;
+        /**
+         * The signature text of the bank account.
+         */
+        signatureText: string;
+        /**
+         * The primary address line of the bank.
+         */
+        bankPrimaryLine?: string;
+        /**
+         * The secondary address line of the bank.
+         */
+        bankSecondaryLine?: string;
+        /**
+         * The designation number of the bank account (for CA).
+         */
+        caDesignationNumber?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The route number of the bank account (for CA).
+         */
+        routeNumber?: string;
+        /**
+         * The routing number of the bank account (for US).
+         */
+        routingNumber?: string;
+        /**
+         * The transit number of the bank account (for CA).
+         */
+        transitNumber?: string;
+    }
+    interface BankAccountCreateSignatureImageURL {
+        /**
+         * The account number of the bank account.
+         */
+        accountNumber: string;
+        /**
+         * Countries typically have different bank account formats and standards. These are
+         * the countries which PostGrid's bank accounts API supports.
+         */
+        bankCountryCode: BankAccountCountryCode;
+        /**
+         * The name of the bank.
+         */
+        bankName: string;
+        /**
+         * Link to signature image which PostGrid will download and apply to cheques
+         * created with this bank account.
+         */
+        signatureImage: string;
+        /**
+         * The primary address line of the bank.
+         */
+        bankPrimaryLine?: string;
+        /**
+         * The secondary address line of the bank.
+         */
+        bankSecondaryLine?: string;
+        /**
+         * The designation number of the bank account (for CA).
+         */
+        caDesignationNumber?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The route number of the bank account (for CA).
+         */
+        routeNumber?: string;
+        /**
+         * The routing number of the bank account (for US).
+         */
+        routingNumber?: string;
+        /**
+         * The transit number of the bank account (for CA).
+         */
+        transitNumber?: string;
+    }
+    interface BankAccountCreateSignatureImageFile {
+        /**
+         * The account number of the bank account.
+         */
+        accountNumber: string;
+        /**
+         * Countries typically have different bank account formats and standards. These are
+         * the countries which PostGrid's bank accounts API supports.
+         */
+        bankCountryCode: BankAccountCountryCode;
+        /**
+         * The name of the bank.
+         */
+        bankName: string;
+        /**
+         * A PNG or JPEG file which PostGrid will apply to checks created with this bank
+         * account.
+         */
+        signatureImage: string;
+        /**
+         * The primary address line of the bank.
+         */
+        bankPrimaryLine?: string;
+        /**
+         * The secondary address line of the bank.
+         */
+        bankSecondaryLine?: string;
+        /**
+         * The designation number of the bank account (for CA).
+         */
+        caDesignationNumber?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The route number of the bank account (for CA).
+         */
+        routeNumber?: string;
+        /**
+         * The routing number of the bank account (for US).
+         */
+        routingNumber?: string;
+        /**
+         * The transit number of the bank account (for CA).
+         */
+        transitNumber?: string;
+    }
+}
+export interface BankAccountListParams {
+    limit?: number;
+    /**
+     * You can supply any string to help narrow down the list of resources. For
+     * example, if you pass `"New York"` (quoted), it will return resources that have
+     * that string present somewhere in their response. Alternatively, you can supply a
+     * structured search query. See the documentation on `StructuredSearchQuery` for
+     * more details.
+     */
+    search?: string;
+    skip?: number;
+}
+export declare namespace BankAccounts {
+    export { type BankAccount as BankAccount, type BankAccountCountryCode as BankAccountCountryCode, type BankAccountListResponse as BankAccountListResponse, type BankAccountDeleteResponse as BankAccountDeleteResponse, type BankAccountCreateParams as BankAccountCreateParams, type BankAccountListParams as BankAccountListParams, };
+}
+//# sourceMappingURL=bank-accounts.d.mts.map

package/resources/print-mail/bank-accounts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bank-accounts.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/bank-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIxF;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGpF;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,EAAE,sBAAsB,CAAC;IAExC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjD,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,MAAM,uBAAuB,GAC/B,uBAAuB,CAAC,8BAA8B,GACtD,uBAAuB,CAAC,kCAAkC,GAC1D,uBAAuB,CAAC,mCAAmC,CAAC;AAEhE,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,eAAe,EAAE,sBAAsB,CAAC;QAExC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,kCAAkC;QACjD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,eAAe,EAAE,sBAAsB,CAAC;QAExC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,mCAAmC;QAClD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,eAAe,EAAE,sBAAsB,CAAC;QAExC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/print-mail/bank-accounts.d.ts

@@ -0,0 +1,345 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class BankAccounts extends APIResource {
+    /**
+     * Create a bank account. A US bank account is created by setting `bankCountryCode`
+     * to `US` and providing `accountNumber` and `routingNumber`. A canadian bank
+     * account can be created by specifying `bankCountryCode` as `CA` and setting
+     * `accountNumber`, `routeNumber`, and `transitNumber` accordingly.
+     *
+     * You must specify _either_ `signatureImage` or `signatureText`. The image can be
+     * supplied as either a URL or a multipart file upload.
+     *
+     * @example
+     * ```ts
+     * const bankAccount =
+     *   await client.printMail.bankAccounts.create({
+     *     accountNumber: '1234567',
+     *     bankCountryCode: 'US',
+     *     bankName: 'Test Bank',
+     *     signatureText: 'Example',
+     *     bankPrimaryLine: '145 mulberry st',
+     *     bankSecondaryLine: 'new york ny 10013',
+     *     routingNumber: '123456789',
+     *   });
+     * ```
+     */
+    create(body: BankAccountCreateParams, options?: RequestOptions): APIPromise<BankAccount>;
+    /**
+     * Retrieve a bank account by ID.
+     *
+     * @example
+     * ```ts
+     * const bankAccount =
+     *   await client.printMail.bankAccounts.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<BankAccount>;
+    /**
+     * Get a list of bank accounts.
+     *
+     * @example
+     * ```ts
+     * const bankAccounts =
+     *   await client.printMail.bankAccounts.list();
+     * ```
+     */
+    list(query?: BankAccountListParams | null | undefined, options?: RequestOptions): APIPromise<BankAccountListResponse>;
+    /**
+     * Delete a bank account by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const bankAccount =
+     *   await client.printMail.bankAccounts.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<BankAccountDeleteResponse>;
+}
+export interface BankAccount {
+    /**
+     * A unique ID prefixed with bank*account*
+     */
+    id: string;
+    /**
+     * The account number of the bank account.
+     */
+    accountNumber: string;
+    /**
+     * Countries typically have different bank account formats and standards. These are
+     * the countries which PostGrid's bank accounts API supports.
+     */
+    bankCountryCode: BankAccountCountryCode;
+    /**
+     * The name of the bank.
+     */
+    bankName: string;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always `bank_account`.
+     */
+    object: 'bank_account';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The primary address line of the bank.
+     */
+    bankPrimaryLine?: string;
+    /**
+     * The secondary address line of the bank.
+     */
+    bankSecondaryLine?: string;
+    /**
+     * The designation number of the bank account (for CA).
+     */
+    caDesignationNumber?: string;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The route number of the bank account (for CA).
+     */
+    routeNumber?: string;
+    /**
+     * The routing number of the bank account (for US).
+     */
+    routingNumber?: string;
+    /**
+     * A signed link to the signature image uploaded when this bank account was
+     * created. This is omitted if `signatureText` is present.
+     */
+    signatureImage?: string;
+    /**
+     * The signature text PostGrid uses to generate a signature for cheques created
+     * using this bank account. This is omitted if `signatureImage` is present.
+     */
+    signatureText?: string;
+    /**
+     * The transit number of the bank account (for CA).
+     */
+    transitNumber?: string;
+}
+/**
+ * Countries typically have different bank account formats and standards. These are
+ * the countries which PostGrid's bank accounts API supports.
+ */
+export type BankAccountCountryCode = 'CA' | 'US';
+export interface BankAccountListResponse {
+    data: Array<BankAccount>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface BankAccountDeleteResponse {
+    /**
+     * A unique ID prefixed with bank*account*
+     */
+    id: string;
+    deleted: true;
+    /**
+     * Always `bank_account`.
+     */
+    object: 'bank_account';
+}
+export type BankAccountCreateParams = BankAccountCreateParams.BankAccountCreateSignatureText | BankAccountCreateParams.BankAccountCreateSignatureImageURL | BankAccountCreateParams.BankAccountCreateSignatureImageFile;
+export declare namespace BankAccountCreateParams {
+    interface BankAccountCreateSignatureText {
+        /**
+         * The account number of the bank account.
+         */
+        accountNumber: string;
+        /**
+         * Countries typically have different bank account formats and standards. These are
+         * the countries which PostGrid's bank accounts API supports.
+         */
+        bankCountryCode: BankAccountCountryCode;
+        /**
+         * The name of the bank.
+         */
+        bankName: string;
+        /**
+         * The signature text of the bank account.
+         */
+        signatureText: string;
+        /**
+         * The primary address line of the bank.
+         */
+        bankPrimaryLine?: string;
+        /**
+         * The secondary address line of the bank.
+         */
+        bankSecondaryLine?: string;
+        /**
+         * The designation number of the bank account (for CA).
+         */
+        caDesignationNumber?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The route number of the bank account (for CA).
+         */
+        routeNumber?: string;
+        /**
+         * The routing number of the bank account (for US).
+         */
+        routingNumber?: string;
+        /**
+         * The transit number of the bank account (for CA).
+         */
+        transitNumber?: string;
+    }
+    interface BankAccountCreateSignatureImageURL {
+        /**
+         * The account number of the bank account.
+         */
+        accountNumber: string;
+        /**
+         * Countries typically have different bank account formats and standards. These are
+         * the countries which PostGrid's bank accounts API supports.
+         */
+        bankCountryCode: BankAccountCountryCode;
+        /**
+         * The name of the bank.
+         */
+        bankName: string;
+        /**
+         * Link to signature image which PostGrid will download and apply to cheques
+         * created with this bank account.
+         */
+        signatureImage: string;
+        /**
+         * The primary address line of the bank.
+         */
+        bankPrimaryLine?: string;
+        /**
+         * The secondary address line of the bank.
+         */
+        bankSecondaryLine?: string;
+        /**
+         * The designation number of the bank account (for CA).
+         */
+        caDesignationNumber?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The route number of the bank account (for CA).
+         */
+        routeNumber?: string;
+        /**
+         * The routing number of the bank account (for US).
+         */
+        routingNumber?: string;
+        /**
+         * The transit number of the bank account (for CA).
+         */
+        transitNumber?: string;
+    }
+    interface BankAccountCreateSignatureImageFile {
+        /**
+         * The account number of the bank account.
+         */
+        accountNumber: string;
+        /**
+         * Countries typically have different bank account formats and standards. These are
+         * the countries which PostGrid's bank accounts API supports.
+         */
+        bankCountryCode: BankAccountCountryCode;
+        /**
+         * The name of the bank.
+         */
+        bankName: string;
+        /**
+         * A PNG or JPEG file which PostGrid will apply to checks created with this bank
+         * account.
+         */
+        signatureImage: string;
+        /**
+         * The primary address line of the bank.
+         */
+        bankPrimaryLine?: string;
+        /**
+         * The secondary address line of the bank.
+         */
+        bankSecondaryLine?: string;
+        /**
+         * The designation number of the bank account (for CA).
+         */
+        caDesignationNumber?: string;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * The route number of the bank account (for CA).
+         */
+        routeNumber?: string;
+        /**
+         * The routing number of the bank account (for US).
+         */
+        routingNumber?: string;
+        /**
+         * The transit number of the bank account (for CA).
+         */
+        transitNumber?: string;
+    }
+}
+export interface BankAccountListParams {
+    limit?: number;
+    /**
+     * You can supply any string to help narrow down the list of resources. For
+     * example, if you pass `"New York"` (quoted), it will return resources that have
+     * that string present somewhere in their response. Alternatively, you can supply a
+     * structured search query. See the documentation on `StructuredSearchQuery` for
+     * more details.
+     */
+    search?: string;
+    skip?: number;
+}
+export declare namespace BankAccounts {
+    export { type BankAccount as BankAccount, type BankAccountCountryCode as BankAccountCountryCode, type BankAccountListResponse as BankAccountListResponse, type BankAccountDeleteResponse as BankAccountDeleteResponse, type BankAccountCreateParams as BankAccountCreateParams, type BankAccountListParams as BankAccountListParams, };
+}
+//# sourceMappingURL=bank-accounts.d.ts.map