postgrid-node 0.5.0 → 0.6.1

package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts

@@ -0,0 +1,334 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as ContactsAPI from "../contacts.mjs";
+import * as ItemsAPI from "./items.mjs";
+import { ItemCreateParams, ItemCreateResponse, ItemListParams, ItemListResponse, ItemListResponsesSkipLimit, ItemRetrieveParams, ItemRetrieveResponse, Items } from "./items.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ *  Virtual mailboxes let you receive, scan, and forward your physical mail
+ *  without needing a traditional physical mailbox. Each mailbox is fully
+ *  digital, giving you a unique ID, status, and a set of capabilities such as
+ *  forwarding mail to another address or viewing envelope scans. This allows you
+ *  to manage physical correspondence entirely online.
+ *
+ *  You can request access to this feature by reaching out to
+ *  support@postgrid.com
+ */
+export declare class VirtualMailboxes extends APIResource {
+    items: ItemsAPI.Items;
+    /**
+     * Creates a new virtual mailbox. In live mode, the virtual mailbox will be pending
+     * assignment and cannot be used until it has been assigned and activated by our
+     * team. You will be notified via email once the virtual mailbox has been
+     * activated. In test mode, the virtual mailbox will be activated immediately upon
+     * creation.
+     *
+     * @example
+     * ```ts
+     * const virtualMailbox =
+     *   await client.printMail.virtualMailboxes.create({
+     *     countryCode: 'US',
+     *     capabilities: {
+     *       envelopeScans: true,
+     *       forwardMailTo: 'contact_pxd7wnnD1xY6H6etKNvjb4',
+     *     },
+     *   });
+     * ```
+     */
+    create(body: VirtualMailboxCreateParams, options?: RequestOptions): APIPromise<VirtualMailboxCreateResponse>;
+    /**
+     * Retrieve Virtual Mailbox
+     *
+     * @example
+     * ```ts
+     * const virtualMailbox =
+     *   await client.printMail.virtualMailboxes.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<VirtualMailboxRetrieveResponse>;
+    /**
+     * Lists virtual mailboxes. You can use the `skip`, `limit`, and `search` query
+     * parameters to refine the list.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const virtualMailboxListResponse of client.printMail.virtualMailboxes.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: VirtualMailboxListParams | null | undefined, options?: RequestOptions): PagePromise<VirtualMailboxListResponsesSkipLimit, VirtualMailboxListResponse>;
+    /**
+     * Retrieves the physical address of the virtual mailbox.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.virtualMailboxes.retrieveAddress(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieveAddress(id: string, options?: RequestOptions): APIPromise<VirtualMailboxRetrieveAddressResponse>;
+}
+export type VirtualMailboxListResponsesSkipLimit = SkipLimit<VirtualMailboxListResponse>;
+/**
+ * The virtual mailbox object.
+ */
+export interface VirtualMailboxCreateResponse {
+    /**
+     * A unique ID prefixed with virtual*mailbox*
+     */
+    id: string;
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    capabilities: VirtualMailboxCreateResponse.Capabilities;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always "virtual_mailbox".
+     */
+    object: 'virtual_mailbox';
+    /**
+     * The possible statuses of virtual mailboxes.
+     */
+    status: 'active' | 'pending_assignment';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: 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;
+    };
+}
+export declare namespace VirtualMailboxCreateResponse {
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    interface Capabilities {
+        /**
+         * Indicates if the virtual mailbox can produce scans of envelopes.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact to forward any returned mail to.
+         */
+        forwardMailTo?: ContactsAPI.Contact;
+    }
+}
+/**
+ * The virtual mailbox object.
+ */
+export interface VirtualMailboxRetrieveResponse {
+    /**
+     * A unique ID prefixed with virtual*mailbox*
+     */
+    id: string;
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    capabilities: VirtualMailboxRetrieveResponse.Capabilities;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always "virtual_mailbox".
+     */
+    object: 'virtual_mailbox';
+    /**
+     * The possible statuses of virtual mailboxes.
+     */
+    status: 'active' | 'pending_assignment';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: 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;
+    };
+}
+export declare namespace VirtualMailboxRetrieveResponse {
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    interface Capabilities {
+        /**
+         * Indicates if the virtual mailbox can produce scans of envelopes.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact to forward any returned mail to.
+         */
+        forwardMailTo?: ContactsAPI.Contact;
+    }
+}
+/**
+ * The virtual mailbox object.
+ */
+export interface VirtualMailboxListResponse {
+    /**
+     * A unique ID prefixed with virtual*mailbox*
+     */
+    id: string;
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    capabilities: VirtualMailboxListResponse.Capabilities;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always "virtual_mailbox".
+     */
+    object: 'virtual_mailbox';
+    /**
+     * The possible statuses of virtual mailboxes.
+     */
+    status: 'active' | 'pending_assignment';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: 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;
+    };
+}
+export declare namespace VirtualMailboxListResponse {
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    interface Capabilities {
+        /**
+         * Indicates if the virtual mailbox can produce scans of envelopes.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact to forward any returned mail to.
+         */
+        forwardMailTo?: ContactsAPI.Contact;
+    }
+}
+/**
+ * The address information for a mailbox.
+ */
+export interface VirtualMailboxRetrieveAddressResponse {
+    /**
+     * The address line 1 of the mailbox.
+     */
+    addressLine1: string;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The address line 2 of the mailbox.
+     */
+    addressLine2?: string;
+    /**
+     * The city of the mailbox.
+     */
+    city?: string;
+    /**
+     * The postal or ZIP code of the mailbox.
+     */
+    postalOrZip?: string;
+    /**
+     * The province or state of the mailbox.
+     */
+    provinceOrState?: string;
+}
+export interface VirtualMailboxCreateParams {
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The capabilities the virtual mailbox should support.
+     */
+    capabilities?: VirtualMailboxCreateParams.Capabilities;
+}
+export declare namespace VirtualMailboxCreateParams {
+    /**
+     * The capabilities the virtual mailbox should support.
+     */
+    interface Capabilities {
+        /**
+         * If the virtual mailbox should support envelope scans or not.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact ID or contact object.
+         */
+        forwardMailTo?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
+    }
+}
+export interface VirtualMailboxListParams extends SkipLimitParams {
+    /**
+     * 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;
+}
+export declare namespace VirtualMailboxes {
+    export { type VirtualMailboxCreateResponse as VirtualMailboxCreateResponse, type VirtualMailboxRetrieveResponse as VirtualMailboxRetrieveResponse, type VirtualMailboxListResponse as VirtualMailboxListResponse, type VirtualMailboxRetrieveAddressResponse as VirtualMailboxRetrieveAddressResponse, type VirtualMailboxListResponsesSkipLimit as VirtualMailboxListResponsesSkipLimit, type VirtualMailboxCreateParams as VirtualMailboxCreateParams, type VirtualMailboxListParams as VirtualMailboxListParams, };
+    export { Items as Items, type ItemCreateResponse as ItemCreateResponse, type ItemRetrieveResponse as ItemRetrieveResponse, type ItemListResponse as ItemListResponse, type ItemListResponsesSkipLimit as ItemListResponsesSkipLimit, type ItemCreateParams as ItemCreateParams, type ItemRetrieveParams as ItemRetrieveParams, type ItemListParams as ItemListParams, };
+}
+//# sourceMappingURL=virtual-mailboxes.d.mts.map

package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual-mailboxes.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,QAAQ;OACb,EACL,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,EACN;OACM,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;GASG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,0BAA0B,CAAC;IAQhF;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qCAAqC,CAAC;CAGzG;AAED,MAAM,MAAM,oCAAoC,GAAG,SAAS,CAAC,0BAA0B,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,4BAA4B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,oBAAoB,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,8BAA8B,CAAC,YAAY,CAAC;IAE1D;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,oBAAoB,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,0BAA0B,CAAC,YAAY,CAAC;IAEtD;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,oBAAoB,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,CAAC,YAAY,CAAC;CACxD;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EACV,WAAW,CAAC,0BAA0B,GACtC,WAAW,CAAC,4BAA4B,GACxC,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts

@@ -0,0 +1,334 @@
+import { APIResource } from "../../../core/resource.js";
+import * as ContactsAPI from "../contacts.js";
+import * as ItemsAPI from "./items.js";
+import { ItemCreateParams, ItemCreateResponse, ItemListParams, ItemListResponse, ItemListResponsesSkipLimit, ItemRetrieveParams, ItemRetrieveResponse, Items } from "./items.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ *  Virtual mailboxes let you receive, scan, and forward your physical mail
+ *  without needing a traditional physical mailbox. Each mailbox is fully
+ *  digital, giving you a unique ID, status, and a set of capabilities such as
+ *  forwarding mail to another address or viewing envelope scans. This allows you
+ *  to manage physical correspondence entirely online.
+ *
+ *  You can request access to this feature by reaching out to
+ *  support@postgrid.com
+ */
+export declare class VirtualMailboxes extends APIResource {
+    items: ItemsAPI.Items;
+    /**
+     * Creates a new virtual mailbox. In live mode, the virtual mailbox will be pending
+     * assignment and cannot be used until it has been assigned and activated by our
+     * team. You will be notified via email once the virtual mailbox has been
+     * activated. In test mode, the virtual mailbox will be activated immediately upon
+     * creation.
+     *
+     * @example
+     * ```ts
+     * const virtualMailbox =
+     *   await client.printMail.virtualMailboxes.create({
+     *     countryCode: 'US',
+     *     capabilities: {
+     *       envelopeScans: true,
+     *       forwardMailTo: 'contact_pxd7wnnD1xY6H6etKNvjb4',
+     *     },
+     *   });
+     * ```
+     */
+    create(body: VirtualMailboxCreateParams, options?: RequestOptions): APIPromise<VirtualMailboxCreateResponse>;
+    /**
+     * Retrieve Virtual Mailbox
+     *
+     * @example
+     * ```ts
+     * const virtualMailbox =
+     *   await client.printMail.virtualMailboxes.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<VirtualMailboxRetrieveResponse>;
+    /**
+     * Lists virtual mailboxes. You can use the `skip`, `limit`, and `search` query
+     * parameters to refine the list.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const virtualMailboxListResponse of client.printMail.virtualMailboxes.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: VirtualMailboxListParams | null | undefined, options?: RequestOptions): PagePromise<VirtualMailboxListResponsesSkipLimit, VirtualMailboxListResponse>;
+    /**
+     * Retrieves the physical address of the virtual mailbox.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.virtualMailboxes.retrieveAddress(
+     *     'id',
+     *   );
+     * ```
+     */
+    retrieveAddress(id: string, options?: RequestOptions): APIPromise<VirtualMailboxRetrieveAddressResponse>;
+}
+export type VirtualMailboxListResponsesSkipLimit = SkipLimit<VirtualMailboxListResponse>;
+/**
+ * The virtual mailbox object.
+ */
+export interface VirtualMailboxCreateResponse {
+    /**
+     * A unique ID prefixed with virtual*mailbox*
+     */
+    id: string;
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    capabilities: VirtualMailboxCreateResponse.Capabilities;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always "virtual_mailbox".
+     */
+    object: 'virtual_mailbox';
+    /**
+     * The possible statuses of virtual mailboxes.
+     */
+    status: 'active' | 'pending_assignment';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: 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;
+    };
+}
+export declare namespace VirtualMailboxCreateResponse {
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    interface Capabilities {
+        /**
+         * Indicates if the virtual mailbox can produce scans of envelopes.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact to forward any returned mail to.
+         */
+        forwardMailTo?: ContactsAPI.Contact;
+    }
+}
+/**
+ * The virtual mailbox object.
+ */
+export interface VirtualMailboxRetrieveResponse {
+    /**
+     * A unique ID prefixed with virtual*mailbox*
+     */
+    id: string;
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    capabilities: VirtualMailboxRetrieveResponse.Capabilities;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always "virtual_mailbox".
+     */
+    object: 'virtual_mailbox';
+    /**
+     * The possible statuses of virtual mailboxes.
+     */
+    status: 'active' | 'pending_assignment';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: 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;
+    };
+}
+export declare namespace VirtualMailboxRetrieveResponse {
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    interface Capabilities {
+        /**
+         * Indicates if the virtual mailbox can produce scans of envelopes.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact to forward any returned mail to.
+         */
+        forwardMailTo?: ContactsAPI.Contact;
+    }
+}
+/**
+ * The virtual mailbox object.
+ */
+export interface VirtualMailboxListResponse {
+    /**
+     * A unique ID prefixed with virtual*mailbox*
+     */
+    id: string;
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    capabilities: VirtualMailboxListResponse.Capabilities;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * Always "virtual_mailbox".
+     */
+    object: 'virtual_mailbox';
+    /**
+     * The possible statuses of virtual mailboxes.
+     */
+    status: 'active' | 'pending_assignment';
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: 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;
+    };
+}
+export declare namespace VirtualMailboxListResponse {
+    /**
+     * All of the capabilities a virtual mailbox may have.
+     */
+    interface Capabilities {
+        /**
+         * Indicates if the virtual mailbox can produce scans of envelopes.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact to forward any returned mail to.
+         */
+        forwardMailTo?: ContactsAPI.Contact;
+    }
+}
+/**
+ * The address information for a mailbox.
+ */
+export interface VirtualMailboxRetrieveAddressResponse {
+    /**
+     * The address line 1 of the mailbox.
+     */
+    addressLine1: string;
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The address line 2 of the mailbox.
+     */
+    addressLine2?: string;
+    /**
+     * The city of the mailbox.
+     */
+    city?: string;
+    /**
+     * The postal or ZIP code of the mailbox.
+     */
+    postalOrZip?: string;
+    /**
+     * The province or state of the mailbox.
+     */
+    provinceOrState?: string;
+}
+export interface VirtualMailboxCreateParams {
+    /**
+     * All of the supported countries for virtual mailboxes.
+     */
+    countryCode: 'US';
+    /**
+     * The capabilities the virtual mailbox should support.
+     */
+    capabilities?: VirtualMailboxCreateParams.Capabilities;
+}
+export declare namespace VirtualMailboxCreateParams {
+    /**
+     * The capabilities the virtual mailbox should support.
+     */
+    interface Capabilities {
+        /**
+         * If the virtual mailbox should support envelope scans or not.
+         */
+        envelopeScans: boolean;
+        /**
+         * A contact ID or contact object.
+         */
+        forwardMailTo?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
+    }
+}
+export interface VirtualMailboxListParams extends SkipLimitParams {
+    /**
+     * 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;
+}
+export declare namespace VirtualMailboxes {
+    export { type VirtualMailboxCreateResponse as VirtualMailboxCreateResponse, type VirtualMailboxRetrieveResponse as VirtualMailboxRetrieveResponse, type VirtualMailboxListResponse as VirtualMailboxListResponse, type VirtualMailboxRetrieveAddressResponse as VirtualMailboxRetrieveAddressResponse, type VirtualMailboxListResponsesSkipLimit as VirtualMailboxListResponsesSkipLimit, type VirtualMailboxCreateParams as VirtualMailboxCreateParams, type VirtualMailboxListParams as VirtualMailboxListParams, };
+    export { Items as Items, type ItemCreateResponse as ItemCreateResponse, type ItemRetrieveResponse as ItemRetrieveResponse, type ItemListResponse as ItemListResponse, type ItemListResponsesSkipLimit as ItemListResponsesSkipLimit, type ItemCreateParams as ItemCreateParams, type ItemRetrieveParams as ItemRetrieveParams, type ItemListParams as ItemListParams, };
+}
+//# sourceMappingURL=virtual-mailboxes.d.ts.map

package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual-mailboxes.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,QAAQ;OACb,EACL,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,EACN;OACM,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;GASG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,0BAA0B,CAAC;IAQhF;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qCAAqC,CAAC;CAGzG;AAED,MAAM,MAAM,oCAAoC,GAAG,SAAS,CAAC,0BAA0B,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,4BAA4B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,oBAAoB,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,8BAA8B,CAAC,YAAY,CAAC;IAE1D;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,oBAAoB,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,0BAA0B,CAAC,YAAY,CAAC;IAEtD;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,oBAAoB,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;KACrC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,CAAC,YAAY,CAAC;CACxD;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EACV,WAAW,CAAC,0BAA0B,GACtC,WAAW,CAAC,4BAA4B,GACxC,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}