postgrid-node 0.5.0 → 0.6.1

package/src/resources/print-mail/sub-organizations.ts

@@ -7,20 +7,19 @@ import { PagePromise, SkipLimit, type SkipLimitParams } from '../../core/paginat
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ *  Sub-organizations enable you to create isolated PostGrid accounts
+ *  ("sub-organizations") under your PostGrid account (the "parent organization").
+ *  Each sub-organization has fully isolated resources
+ *  and users, and can act independently.
+ *
+ *  This allows you to isolate different departments or even re-sell PostGrid
+ *  entirely.
+ *
+ *  You can request access to this feature by reaching out to
+ *  support@postgrid.com
+ */
 export class SubOrganizations extends APIResource {
-  /**
-   * Get a sub-organization.
-   *
-   * @example
-   * ```ts
-   * const subOrganization =
-   *   await client.printMail.subOrganizations.retrieve('id');
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<SubOrganization> {
-    return this._client.get(path`/print-mail/v1/sub_organizations/${id}`, options);
-  }
-
   /**
    * When creating a user through the API, the verifiedEmail field will automatically
    * be set to true. However, if public signups are used, the email will need to be
@@ -29,7 +28,7 @@ export class SubOrganizations extends APIResource {
    * @example
    * ```ts
    * const subOrganization =
-   *   await client.printMail.subOrganizations.update({
+   *   await client.printMail.subOrganizations.create({
    *     countryCode: 'CA',
    *     email: 'suborg@postgrid.com',
    *     name: 'Calvin',
@@ -39,13 +38,26 @@ export class SubOrganizations extends APIResource {
    *   });
    * ```
    */
-  update(
-    body: SubOrganizationUpdateParams,
+  create(
+    body: SubOrganizationCreateParams,
     options?: RequestOptions,
-  ): APIPromise<SubOrganizationUpdateResponse> {
+  ): APIPromise<SubOrganizationCreateResponse> {
     return this._client.post('/print-mail/v1/sub_organizations', { body, ...options });
   }
 
+  /**
+   * Get a sub-organization.
+   *
+   * @example
+   * ```ts
+   * const subOrganization =
+   *   await client.printMail.subOrganizations.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SubOrganization> {
+    return this._client.get(path`/print-mail/v1/sub_organizations/${id}`, options);
+  }
+
   /**
    * List sub-organizations.
    *
@@ -150,7 +162,7 @@ export interface SubOrganization {
   usage: number;
 }
 
-export interface SubOrganizationUpdateResponse {
+export interface SubOrganizationCreateResponse {
   /**
    * The Sub-Organization object.
    */
@@ -159,10 +171,10 @@ export interface SubOrganizationUpdateResponse {
   /**
    * The user object.
    */
-  user: SubOrganizationUpdateResponse.User;
+  user: SubOrganizationCreateResponse.User;
 }
 
-export namespace SubOrganizationUpdateResponse {
+export namespace SubOrganizationCreateResponse {
   /**
    * The user object.
    */
@@ -314,7 +326,7 @@ export namespace SubOrganizationRetrieveUsersResponse {
   }
 }
 
-export interface SubOrganizationUpdateParams {
+export interface SubOrganizationCreateParams {
   /**
    * The country code of the sub-organization.
    */
@@ -376,10 +388,10 @@ export declare namespace SubOrganizations {
   export {
     type EmailPreferences as EmailPreferences,
     type SubOrganization as SubOrganization,
-    type SubOrganizationUpdateResponse as SubOrganizationUpdateResponse,
+    type SubOrganizationCreateResponse as SubOrganizationCreateResponse,
     type SubOrganizationRetrieveUsersResponse as SubOrganizationRetrieveUsersResponse,
     type SubOrganizationsSkipLimit as SubOrganizationsSkipLimit,
-    type SubOrganizationUpdateParams as SubOrganizationUpdateParams,
+    type SubOrganizationCreateParams as SubOrganizationCreateParams,
     type SubOrganizationListParams as SubOrganizationListParams,
     type SubOrganizationRetrieveUsersParams as SubOrganizationRetrieveUsersParams,
   };

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

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ *  **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: FilterAutocompleteParams,
+    options?: RequestOptions,
+  ): APIPromise<FilterAutocompleteResponse> {
+    return this._client.post('/print-mail/v1/targeted_list_builds/filters/autocomplete', {
+      body,
+      ...options,
+    });
+  }
+}
+
+/**
+ * The list of suggestions returned by an autocomplete query.
+ */
+export interface FilterAutocompleteResponse {
+  data: Array<FilterAutocompleteResponse.Data>;
+
+  object: 'list';
+}
+
+export namespace FilterAutocompleteResponse {
+  /**
+   * A single autocomplete suggestion.
+   */
+  export 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,
+  };
+}

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

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Filters, type FilterAutocompleteResponse, type FilterAutocompleteParams } from './filters';
+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';