postgrid-node 0.4.2 → 0.6.1

package/resources/print-mail/targeted-list-builds/filters.d.mts

@@ -0,0 +1,92 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ *  **Beta:** the targeted list builds API is in beta and is subject to
+ *  breaking changes. Endpoint shapes, status values, and filter fields may
+ *  change without notice.
+ *
+ *  The targeted list builds API lets you programmatically build mailing
+ *  lists of US consumers (B2C) or US companies (B2B) that match a set of
+ *  demographic, geographic, and firmographic filters.
+ *
+ *  The lifecycle of a list build is:
+ *
+ *  1. Create a list build by supplying either `usConsumers` or `usCompanies`
+ *     filters. A quote is generated asynchronously — poll the resource or
+ *     wait for its `status` to become `quote_ready`.
+ *  2. Review the `quote` (total count and price per contact) and masked
+ *     `previewRecords`. Adjust the filters with an update call if needed —
+ *     this will regenerate the quote.
+ *  3. Confirm the build. This deducts the appropriate amount of list build
+ *     credits from your organization (in live mode) and begins constructing
+ *     the mailing list. `buildProgressPercent` reflects progress from 0 to
+ *     100.
+ *  4. Once `status` is `completed`, the ID of the resulting mailing list is
+ *     available in the `mailingList` field and can be used like any other
+ *     mailing list in the PostGrid API.
+ *
+ *  Targeted list builds must be enabled on your organization before they
+ *  can be used. Contact PostGrid support to request access.
+ */
+export declare class Filters extends APIResource {
+    /**
+     * Return a list of autocomplete suggestions for a given filter field (currently
+     * only `industry` is supported). Useful when building a UI around the `industries`
+     * company filter.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.targetedListBuilds.filters.autocomplete(
+     *     {
+     *       field: 'industry',
+     *       size: 5,
+     *       text: 'soft',
+     *     },
+     *   );
+     * ```
+     */
+    autocomplete(body: FilterAutocompleteParams, options?: RequestOptions): APIPromise<FilterAutocompleteResponse>;
+}
+/**
+ * The list of suggestions returned by an autocomplete query.
+ */
+export interface FilterAutocompleteResponse {
+    data: Array<FilterAutocompleteResponse.Data>;
+    object: 'list';
+}
+export declare namespace FilterAutocompleteResponse {
+    /**
+     * A single autocomplete suggestion.
+     */
+    interface Data {
+        /**
+         * A field that can be autocompleted when configuring list build filters.
+         */
+        type: 'industry';
+        /**
+         * The suggested value (e.g., an industry name).
+         */
+        value: string;
+    }
+}
+export interface FilterAutocompleteParams {
+    /**
+     * A field that can be autocompleted when configuring list build filters.
+     */
+    field: 'industry';
+    /**
+     * Maximum number of suggestions to return. Between 1 and 100. Defaults to 25 if
+     * omitted.
+     */
+    size?: number;
+    /**
+     * Optional text prefix to narrow the autocomplete suggestions.
+     */
+    text?: string;
+}
+export declare namespace Filters {
+    export { type FilterAutocompleteResponse as FilterAutocompleteResponse, type FilterAutocompleteParams as FilterAutocompleteParams, };
+}
+//# sourceMappingURL=filters.d.mts.map

package/resources/print-mail/targeted-list-builds/filters.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/filters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAM1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAE7C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,EAAE,UAAU,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/print-mail/targeted-list-builds/filters.d.ts

@@ -0,0 +1,92 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ *  **Beta:** the targeted list builds API is in beta and is subject to
+ *  breaking changes. Endpoint shapes, status values, and filter fields may
+ *  change without notice.
+ *
+ *  The targeted list builds API lets you programmatically build mailing
+ *  lists of US consumers (B2C) or US companies (B2B) that match a set of
+ *  demographic, geographic, and firmographic filters.
+ *
+ *  The lifecycle of a list build is:
+ *
+ *  1. Create a list build by supplying either `usConsumers` or `usCompanies`
+ *     filters. A quote is generated asynchronously — poll the resource or
+ *     wait for its `status` to become `quote_ready`.
+ *  2. Review the `quote` (total count and price per contact) and masked
+ *     `previewRecords`. Adjust the filters with an update call if needed —
+ *     this will regenerate the quote.
+ *  3. Confirm the build. This deducts the appropriate amount of list build
+ *     credits from your organization (in live mode) and begins constructing
+ *     the mailing list. `buildProgressPercent` reflects progress from 0 to
+ *     100.
+ *  4. Once `status` is `completed`, the ID of the resulting mailing list is
+ *     available in the `mailingList` field and can be used like any other
+ *     mailing list in the PostGrid API.
+ *
+ *  Targeted list builds must be enabled on your organization before they
+ *  can be used. Contact PostGrid support to request access.
+ */
+export declare class Filters extends APIResource {
+    /**
+     * Return a list of autocomplete suggestions for a given filter field (currently
+     * only `industry` is supported). Useful when building a UI around the `industries`
+     * company filter.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.targetedListBuilds.filters.autocomplete(
+     *     {
+     *       field: 'industry',
+     *       size: 5,
+     *       text: 'soft',
+     *     },
+     *   );
+     * ```
+     */
+    autocomplete(body: FilterAutocompleteParams, options?: RequestOptions): APIPromise<FilterAutocompleteResponse>;
+}
+/**
+ * The list of suggestions returned by an autocomplete query.
+ */
+export interface FilterAutocompleteResponse {
+    data: Array<FilterAutocompleteResponse.Data>;
+    object: 'list';
+}
+export declare namespace FilterAutocompleteResponse {
+    /**
+     * A single autocomplete suggestion.
+     */
+    interface Data {
+        /**
+         * A field that can be autocompleted when configuring list build filters.
+         */
+        type: 'industry';
+        /**
+         * The suggested value (e.g., an industry name).
+         */
+        value: string;
+    }
+}
+export interface FilterAutocompleteParams {
+    /**
+     * A field that can be autocompleted when configuring list build filters.
+     */
+    field: 'industry';
+    /**
+     * Maximum number of suggestions to return. Between 1 and 100. Defaults to 25 if
+     * omitted.
+     */
+    size?: number;
+    /**
+     * Optional text prefix to narrow the autocomplete suggestions.
+     */
+    text?: string;
+}
+export declare namespace Filters {
+    export { type FilterAutocompleteResponse as FilterAutocompleteResponse, type FilterAutocompleteParams as FilterAutocompleteParams, };
+}
+//# sourceMappingURL=filters.d.ts.map

package/resources/print-mail/targeted-list-builds/filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/filters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAM1C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAE7C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,EAAE,UAAU,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/print-mail/targeted-list-builds/filters.js

@@ -0,0 +1,60 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Filters = void 0;
+const resource_1 = require("../../../core/resource.js");
+/**
+ *  **Beta:** the targeted list builds API is in beta and is subject to
+ *  breaking changes. Endpoint shapes, status values, and filter fields may
+ *  change without notice.
+ *
+ *  The targeted list builds API lets you programmatically build mailing
+ *  lists of US consumers (B2C) or US companies (B2B) that match a set of
+ *  demographic, geographic, and firmographic filters.
+ *
+ *  The lifecycle of a list build is:
+ *
+ *  1. Create a list build by supplying either `usConsumers` or `usCompanies`
+ *     filters. A quote is generated asynchronously — poll the resource or
+ *     wait for its `status` to become `quote_ready`.
+ *  2. Review the `quote` (total count and price per contact) and masked
+ *     `previewRecords`. Adjust the filters with an update call if needed —
+ *     this will regenerate the quote.
+ *  3. Confirm the build. This deducts the appropriate amount of list build
+ *     credits from your organization (in live mode) and begins constructing
+ *     the mailing list. `buildProgressPercent` reflects progress from 0 to
+ *     100.
+ *  4. Once `status` is `completed`, the ID of the resulting mailing list is
+ *     available in the `mailingList` field and can be used like any other
+ *     mailing list in the PostGrid API.
+ *
+ *  Targeted list builds must be enabled on your organization before they
+ *  can be used. Contact PostGrid support to request access.
+ */
+class Filters extends resource_1.APIResource {
+    /**
+     * Return a list of autocomplete suggestions for a given filter field (currently
+     * only `industry` is supported). Useful when building a UI around the `industries`
+     * company filter.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.targetedListBuilds.filters.autocomplete(
+     *     {
+     *       field: 'industry',
+     *       size: 5,
+     *       text: 'soft',
+     *     },
+     *   );
+     * ```
+     */
+    autocomplete(body, options) {
+        return this._client.post('/print-mail/v1/targeted_list_builds/filters/autocomplete', {
+            body,
+            ...options,
+        });
+    }
+}
+exports.Filters = Filters;
+//# sourceMappingURL=filters.js.map

package/resources/print-mail/targeted-list-builds/filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/filters.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0DAA0D,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,0BA2BC"}

package/resources/print-mail/targeted-list-builds/filters.mjs

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+/**
+ *  **Beta:** the targeted list builds API is in beta and is subject to
+ *  breaking changes. Endpoint shapes, status values, and filter fields may
+ *  change without notice.
+ *
+ *  The targeted list builds API lets you programmatically build mailing
+ *  lists of US consumers (B2C) or US companies (B2B) that match a set of
+ *  demographic, geographic, and firmographic filters.
+ *
+ *  The lifecycle of a list build is:
+ *
+ *  1. Create a list build by supplying either `usConsumers` or `usCompanies`
+ *     filters. A quote is generated asynchronously — poll the resource or
+ *     wait for its `status` to become `quote_ready`.
+ *  2. Review the `quote` (total count and price per contact) and masked
+ *     `previewRecords`. Adjust the filters with an update call if needed —
+ *     this will regenerate the quote.
+ *  3. Confirm the build. This deducts the appropriate amount of list build
+ *     credits from your organization (in live mode) and begins constructing
+ *     the mailing list. `buildProgressPercent` reflects progress from 0 to
+ *     100.
+ *  4. Once `status` is `completed`, the ID of the resulting mailing list is
+ *     available in the `mailingList` field and can be used like any other
+ *     mailing list in the PostGrid API.
+ *
+ *  Targeted list builds must be enabled on your organization before they
+ *  can be used. Contact PostGrid support to request access.
+ */
+export class Filters extends APIResource {
+    /**
+     * Return a list of autocomplete suggestions for a given filter field (currently
+     * only `industry` is supported). Useful when building a UI around the `industries`
+     * company filter.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.printMail.targetedListBuilds.filters.autocomplete(
+     *     {
+     *       field: 'industry',
+     *       size: 5,
+     *       text: 'soft',
+     *     },
+     *   );
+     * ```
+     */
+    autocomplete(body, options) {
+        return this._client.post('/print-mail/v1/targeted_list_builds/filters/autocomplete', {
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=filters.mjs.map

package/resources/print-mail/targeted-list-builds/filters.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.mjs","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/filters.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0DAA0D,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/print-mail/targeted-list-builds/index.d.mts

@@ -0,0 +1,3 @@
+export { Filters, type FilterAutocompleteResponse, type FilterAutocompleteParams } from "./filters.mjs";
+export { TargetedListBuilds, type TargetedListBuildCreateResponse, type TargetedListBuildRetrieveResponse, type TargetedListBuildUpdateResponse, type TargetedListBuildListResponse, type TargetedListBuildDeleteResponse, type TargetedListBuildConfirmResponse, type TargetedListBuildCreateParams, type TargetedListBuildUpdateParams, type TargetedListBuildListParams, type TargetedListBuildListResponsesSkipLimit, } from "./targeted-list-builds.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/print-mail/targeted-list-builds/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,0BAA0B,EAAE,KAAK,wBAAwB,EAAE;OAC3E,EACL,kBAAkB,EAClB,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,uCAAuC,GAC7C"}

package/resources/print-mail/targeted-list-builds/index.d.ts

@@ -0,0 +1,3 @@
+export { Filters, type FilterAutocompleteResponse, type FilterAutocompleteParams } from "./filters.js";
+export { TargetedListBuilds, type TargetedListBuildCreateResponse, type TargetedListBuildRetrieveResponse, type TargetedListBuildUpdateResponse, type TargetedListBuildListResponse, type TargetedListBuildDeleteResponse, type TargetedListBuildConfirmResponse, type TargetedListBuildCreateParams, type TargetedListBuildUpdateParams, type TargetedListBuildListParams, type TargetedListBuildListResponsesSkipLimit, } from "./targeted-list-builds.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/print-mail/targeted-list-builds/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,0BAA0B,EAAE,KAAK,wBAAwB,EAAE;OAC3E,EACL,kBAAkB,EAClB,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,uCAAuC,GAC7C"}

package/resources/print-mail/targeted-list-builds/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TargetedListBuilds = exports.Filters = void 0;
+var filters_1 = require("./filters.js");
+Object.defineProperty(exports, "Filters", { enumerable: true, get: function () { return filters_1.Filters; } });
+var targeted_list_builds_1 = require("./targeted-list-builds.js");
+Object.defineProperty(exports, "TargetedListBuilds", { enumerable: true, get: function () { return targeted_list_builds_1.TargetedListBuilds; } });
+//# sourceMappingURL=index.js.map

package/resources/print-mail/targeted-list-builds/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAAoG;AAA3F,kGAAA,OAAO,OAAA;AAChB,kEAYgC;AAX9B,0HAAA,kBAAkB,OAAA"}

package/resources/print-mail/targeted-list-builds/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Filters } from "./filters.mjs";
+export { TargetedListBuilds, } from "./targeted-list-builds.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/print-mail/targeted-list-builds/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/print-mail/targeted-list-builds/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,OAAO,EAAkE;OAC3E,EACL,kBAAkB,GAWnB"}