postgrid-node 0.1.0-alpha.2 → 0.1.0-alpha.4

package/resources/templates.js

@@ -9,18 +9,39 @@ class Templates extends resource_1.APIResource {
     /**
      * Create a template. Note that if you want to create a template that works with
      * our template editor, you must use our dashboard.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.create({
+     *   description: 'Test',
+     *   html: '<b>Hello</b> {{to.firstName}}',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/templates', { body, ...options });
     }
     /**
      * Retrieve a template by ID.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.retrieve('id');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(`/templates/${id}`, options);
     }
     /**
      * Update a template by ID.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.update('id', {
+     *   description: 'Test',
+     *   html: '<b>Hello</b> {{to.firstName}}!',
+     * });
+     * ```
      */
     update(id, body, options) {
         return this._client.post(`/templates/${id}`, { body, ...options });
@@ -33,6 +54,11 @@ class Templates extends resource_1.APIResource {
     }
     /**
      * Delete a template by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete(`/templates/${id}`, options);

package/resources/templates.js.map

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/resources/templates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;OAGG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAOD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AA5CD,8BA4CC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD;AAsHpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/resources/templates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAeD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AA9ED,8BA8EC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD;AAsHpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}

package/resources/templates.mjs

@@ -6,18 +6,39 @@ export class Templates extends APIResource {
     /**
      * Create a template. Note that if you want to create a template that works with
      * our template editor, you must use our dashboard.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.create({
+     *   description: 'Test',
+     *   html: '<b>Hello</b> {{to.firstName}}',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/templates', { body, ...options });
     }
     /**
      * Retrieve a template by ID.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.retrieve('id');
+     * ```
      */
     retrieve(id, options) {
         return this._client.get(`/templates/${id}`, options);
     }
     /**
      * Update a template by ID.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.update('id', {
+     *   description: 'Test',
+     *   html: '<b>Hello</b> {{to.firstName}}!',
+     * });
+     * ```
      */
     update(id, body, options) {
         return this._client.post(`/templates/${id}`, { body, ...options });
@@ -30,6 +51,11 @@ export class Templates extends APIResource {
     }
     /**
      * Delete a template by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const template = await client.templates.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete(`/templates/${id}`, options);

package/resources/templates.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"templates.mjs","sourceRoot":"","sources":["../src/resources/templates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;OAGG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAOD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAc;CAAG;AAsHpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}
+{"version":3,"file":"templates.mjs","sourceRoot":"","sources":["../src/resources/templates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAeD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAc;CAAG;AAsHpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}

package/resources.d.ts

@@ -0,0 +1,2 @@
+export * from "./resources/index.js";
+//# sourceMappingURL=resources.d.ts.map

package/resources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/resources.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/index.js"), exports);
+//# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAkC"}

package/resources.mjs

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.mjs.map

package/resources.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/src/_shims/index.d.ts

@@ -79,3 +79,5 @@ export function fileFromPath(path: string, options?: FileFromPathOptions): Promi
 export function fileFromPath(path: string, filename?: string, options?: FileFromPathOptions): Promise<File>;
 
 export function isFsReadStream(value: any): value is FsReadStream;
+
+export const init: () => void;

package/src/_shims/index.js

@@ -3,7 +3,9 @@
  */
 const shims = require('./registry');
 const auto = require('postgrid-node/_shims/auto/runtime');
-if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+exports.init = () => {
+  if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+};
 for (const property of Object.keys(shims)) {
   Object.defineProperty(exports, property, {
     get() {
@@ -11,3 +13,5 @@ for (const property of Object.keys(shims)) {
     },
   });
 }
+
+exports.init();

package/src/_shims/index.mjs

@@ -3,5 +3,9 @@
  */
 import * as shims from './registry.mjs';
 import * as auto from "./auto/runtime";
-if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+export const init = () => {
+  if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+};
 export * from './registry.mjs';
+
+init();

package/src/core.ts

@@ -16,7 +16,12 @@ import {
   type RequestInit,
   type Response,
   type HeadersInit,
+  init,
 } from './_shims/index';
+
+// try running side effects outside of _shims/index to workaround https://github.com/vercel/next.js/issues/76881
+init();
+
 export { type Response };
 import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
@@ -28,6 +33,20 @@ export {
 
 export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
 
+/**
+ * An alias to the builtin `Array` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Array<T> = Array<T>;
+
+/**
+ * An alias to the builtin `Record` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Record<K extends keyof any, T> = Record<K, T>;
+
+export type { _Array as Array, _Record as Record };
+
 type PromiseOrValue<T> = T | Promise<T>;
 
 type APIResponseProps = {
@@ -48,8 +67,8 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   }
 
   const contentType = response.headers.get('content-type');
-  const isJSON =
-    contentType?.includes('application/json') || contentType?.includes('application/vnd.api+json');
+  const mediaType = contentType?.split(';')[0]?.trim();
+  const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
     const json = await response.json();
 
@@ -151,6 +170,7 @@ export class APIPromise<T> extends Promise<T> {
 
 export abstract class APIClient {
   baseURL: string;
+  #baseURLOverridden: boolean;
   maxRetries: number;
   timeout: number;
   httpAgent: Agent | undefined;
@@ -160,18 +180,21 @@ export abstract class APIClient {
 
   constructor({
     baseURL,
+    baseURLOverridden,
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
     fetch: overriddenFetch,
   }: {
     baseURL: string;
+    baseURLOverridden: boolean;
     maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
     fetch: Fetch | undefined;
   }) {
     this.baseURL = baseURL;
+    this.#baseURLOverridden = baseURLOverridden;
     this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
@@ -194,7 +217,7 @@ export abstract class APIClient {
   protected defaultHeaders(opts: FinalRequestOptions): Headers {
     return {
       Accept: 'application/json',
-      'Content-Type': 'application/json',
+      ...(['head', 'get'].includes(opts.method) ? {} : { 'Content-Type': 'application/json' }),
       'User-Agent': this.getUserAgent(),
       ...getPlatformHeaders(),
       ...this.authHeaders(opts),
@@ -276,12 +299,12 @@ export abstract class APIClient {
     return null;
   }
 
-  buildRequest<Req>(
-    options: FinalRequestOptions<Req>,
+  async buildRequest<Req>(
+    inputOptions: FinalRequestOptions<Req>,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: RequestInit; url: string; timeout: number } {
-    options = { ...options };
-    const { method, path, query, headers: headers = {} } = options;
+  ): Promise<{ req: RequestInit; url: string; timeout: number }> {
+    const options = { ...inputOptions };
+    const { method, path, query, defaultBaseURL, headers: headers = {} } = options;
 
     const body =
       ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
@@ -291,7 +314,7 @@ export abstract class APIClient {
       : null;
     const contentLength = this.calculateContentLength(body);
 
-    const url = this.buildURL(path!, query);
+    const url = this.buildURL(path!, query, defaultBaseURL);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
@@ -308,8 +331,8 @@ export abstract class APIClient {
     }
 
     if (this.idempotencyHeader && method !== 'get') {
-      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
-      headers[this.idempotencyHeader] = options.idempotencyKey;
+      if (!inputOptions.idempotencyKey) inputOptions.idempotencyKey = this.defaultIdempotencyKey();
+      headers[this.idempotencyHeader] = inputOptions.idempotencyKey;
     }
 
     const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
@@ -366,7 +389,7 @@ export abstract class APIClient {
       getHeader(headers, 'x-stainless-timeout') === undefined &&
       options.timeout
     ) {
-      reqHeaders['x-stainless-timeout'] = String(options.timeout);
+      reqHeaders['x-stainless-timeout'] = String(Math.trunc(options.timeout / 1000));
     }
 
     this.validateHeaders(reqHeaders, headers);
@@ -395,7 +418,7 @@ export abstract class APIClient {
       !headers ? {}
       : Symbol.iterator in headers ?
         Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
-      : { ...headers }
+      : { ...(headers as any as Record<string, string>) }
     );
   }
 
@@ -427,7 +450,9 @@ export abstract class APIClient {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -484,11 +509,12 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined, defaultBaseURL?: string | undefined): string {
+    const baseURL = (!this.#baseURLOverridden && defaultBaseURL) || this.baseURL;
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
-      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
     if (!isEmptyObj(defaultQuery)) {
@@ -773,6 +799,7 @@ export type RequestOptions<
   query?: Req | undefined;
   body?: Req | null | undefined;
   headers?: Headers | undefined;
+  defaultBaseURL?: string | undefined;
 
   maxRetries?: number;
   stream?: boolean | undefined;
@@ -794,6 +821,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   query: true,
   body: true,
   headers: true,
+  defaultBaseURL: true,
 
   maxRetries: true,
   stream: true,

package/src/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { type Agent } from './_shims/index';
+import * as qs from './internal/qs';
 import * as Core from './core';
 import * as Errors from './error';
 import * as Pagination from './pagination';
@@ -57,6 +58,32 @@ import {
   Letters,
   LettersList,
 } from './resources/letters';
+import {
+  MailingListImportCreateParams,
+  MailingListImportCreateResponse,
+  MailingListImportDeleteResponse,
+  MailingListImportListParams,
+  MailingListImportListResponse,
+  MailingListImportListResponsesList,
+  MailingListImportRetrieveResponse,
+  MailingListImportUpdateParams,
+  MailingListImportUpdateResponse,
+  MailingListImports,
+} from './resources/mailing-list-imports';
+import {
+  MailingListCreateParams,
+  MailingListCreateResponse,
+  MailingListDeleteResponse,
+  MailingListListParams,
+  MailingListListResponse,
+  MailingListListResponsesList,
+  MailingListRetrieveResponse,
+  MailingListSubmitJobParams,
+  MailingListSubmitJobResponse,
+  MailingListUpdateParams,
+  MailingListUpdateResponse,
+  MailingLists,
+} from './resources/mailing-lists';
 import {
   Postcard,
   PostcardCreateParams,
@@ -73,9 +100,21 @@ import {
   SelfMailerListParams,
   SelfMailerListResponse,
   SelfMailerListResponsesList,
+  SelfMailerRetrievePreviewURLResponse,
   SelfMailerRetrieveResponse,
   SelfMailers,
 } from './resources/self-mailers';
+import {
+  SubOrganizationCreateParams,
+  SubOrganizationCreateResponse,
+  SubOrganizationListParams,
+  SubOrganizationListResponse,
+  SubOrganizationListResponsesList,
+  SubOrganizationListUsersParams,
+  SubOrganizationListUsersResponse,
+  SubOrganizationRetrieveResponse,
+  SubOrganizations,
+} from './resources/sub-organizations';
 import {
   Template,
   TemplateCreateParams,
@@ -94,6 +133,7 @@ import {
   Cheques,
   ChequesList,
 } from './resources/cheques/cheques';
+import { OrderProfiles } from './resources/order-profiles/order-profiles';
 import {
   ReportCreateParams,
   ReportCreateResponse,
@@ -112,10 +152,7 @@ import {
 } from './resources/reports/reports';
 
 export interface ClientOptions {
-  /**
-   * Defaults to process.env['POSTGRID_API_KEY'].
-   */
-  apiKey?: string | undefined;
+  apiKey: string;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -130,6 +167,8 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
   timeout?: number | undefined;
 
@@ -185,7 +224,7 @@ export class PostGrid extends Core.APIClient {
   /**
    * API Client for interfacing with the PostGrid API.
    *
-   * @param {string | undefined} [opts.apiKey=process.env['POSTGRID_API_KEY'] ?? undefined]
+   * @param {string} opts.apiKey
    * @param {string} [opts.baseURL=process.env['POSTGRID_BASE_URL'] ?? https://api.postgrid.com/print-mail/v1] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -194,14 +233,10 @@ export class PostGrid extends Core.APIClient {
    * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
    * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
-  constructor({
-    baseURL = Core.readEnv('POSTGRID_BASE_URL'),
-    apiKey = Core.readEnv('POSTGRID_API_KEY'),
-    ...opts
-  }: ClientOptions = {}) {
+  constructor({ baseURL = Core.readEnv('POSTGRID_BASE_URL'), apiKey, ...opts }: ClientOptions) {
     if (apiKey === undefined) {
       throw new Errors.PostGridError(
-        "The POSTGRID_API_KEY environment variable is missing or empty; either provide it, or instantiate the PostGrid client with an apiKey option, like new PostGrid({ apiKey: 'My API Key' }).",
+        "Missing required client option apiKey; you need to instantiate the PostGrid client with an apiKey option, like new PostGrid({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -213,6 +248,7 @@ export class PostGrid extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
+      baseURLOverridden: baseURL ? baseURL !== 'https://api.postgrid.com/print-mail/v1' : false,
       timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
@@ -235,6 +271,17 @@ export class PostGrid extends Core.APIClient {
   campaigns: API.Campaigns = new API.Campaigns(this);
   reports: API.Reports = new API.Reports(this);
   selfMailers: API.SelfMailers = new API.SelfMailers(this);
+  mailingListImports: API.MailingListImports = new API.MailingListImports(this);
+  mailingLists: API.MailingLists = new API.MailingLists(this);
+  orderProfiles: API.OrderProfiles = new API.OrderProfiles(this);
+  subOrganizations: API.SubOrganizations = new API.SubOrganizations(this);
+
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://api.postgrid.com/print-mail/v1';
+  }
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -251,6 +298,10 @@ export class PostGrid extends Core.APIClient {
     return { 'X-API-Key': this.apiKey };
   }
 
+  protected override stringifyQuery(query: Record<string, unknown>): string {
+    return qs.stringify(query, { arrayFormat: 'comma' });
+  }
+
   static PostGrid = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
@@ -292,6 +343,13 @@ PostGrid.Reports = Reports;
 PostGrid.ReportListResponsesList = ReportListResponsesList;
 PostGrid.SelfMailers = SelfMailers;
 PostGrid.SelfMailerListResponsesList = SelfMailerListResponsesList;
+PostGrid.MailingListImports = MailingListImports;
+PostGrid.MailingListImportListResponsesList = MailingListImportListResponsesList;
+PostGrid.MailingLists = MailingLists;
+PostGrid.MailingListListResponsesList = MailingListListResponsesList;
+PostGrid.OrderProfiles = OrderProfiles;
+PostGrid.SubOrganizations = SubOrganizations;
+PostGrid.SubOrganizationListResponsesList = SubOrganizationListResponsesList;
 export declare namespace PostGrid {
   export type RequestOptions = Core.RequestOptions;
 
@@ -406,11 +464,54 @@ export declare namespace PostGrid {
     type SelfMailerRetrieveResponse as SelfMailerRetrieveResponse,
     type SelfMailerListResponse as SelfMailerListResponse,
     type SelfMailerCancelResponse as SelfMailerCancelResponse,
+    type SelfMailerRetrievePreviewURLResponse as SelfMailerRetrievePreviewURLResponse,
     SelfMailerListResponsesList as SelfMailerListResponsesList,
     type SelfMailerCreateParams as SelfMailerCreateParams,
     type SelfMailerListParams as SelfMailerListParams,
   };
 
+  export {
+    MailingListImports as MailingListImports,
+    type MailingListImportCreateResponse as MailingListImportCreateResponse,
+    type MailingListImportRetrieveResponse as MailingListImportRetrieveResponse,
+    type MailingListImportUpdateResponse as MailingListImportUpdateResponse,
+    type MailingListImportListResponse as MailingListImportListResponse,
+    type MailingListImportDeleteResponse as MailingListImportDeleteResponse,
+    MailingListImportListResponsesList as MailingListImportListResponsesList,
+    type MailingListImportCreateParams as MailingListImportCreateParams,
+    type MailingListImportUpdateParams as MailingListImportUpdateParams,
+    type MailingListImportListParams as MailingListImportListParams,
+  };
+
+  export {
+    MailingLists as MailingLists,
+    type MailingListCreateResponse as MailingListCreateResponse,
+    type MailingListRetrieveResponse as MailingListRetrieveResponse,
+    type MailingListUpdateResponse as MailingListUpdateResponse,
+    type MailingListListResponse as MailingListListResponse,
+    type MailingListDeleteResponse as MailingListDeleteResponse,
+    type MailingListSubmitJobResponse as MailingListSubmitJobResponse,
+    MailingListListResponsesList as MailingListListResponsesList,
+    type MailingListCreateParams as MailingListCreateParams,
+    type MailingListUpdateParams as MailingListUpdateParams,
+    type MailingListListParams as MailingListListParams,
+    type MailingListSubmitJobParams as MailingListSubmitJobParams,
+  };
+
+  export { OrderProfiles as OrderProfiles };
+
+  export {
+    SubOrganizations as SubOrganizations,
+    type SubOrganizationCreateResponse as SubOrganizationCreateResponse,
+    type SubOrganizationRetrieveResponse as SubOrganizationRetrieveResponse,
+    type SubOrganizationListResponse as SubOrganizationListResponse,
+    type SubOrganizationListUsersResponse as SubOrganizationListUsersResponse,
+    SubOrganizationListResponsesList as SubOrganizationListResponsesList,
+    type SubOrganizationCreateParams as SubOrganizationCreateParams,
+    type SubOrganizationListParams as SubOrganizationListParams,
+    type SubOrganizationListUsersParams as SubOrganizationListUsersParams,
+  };
+
   export type Cancellation = API.Cancellation;
   export type ContactCreateWithCompanyName = API.ContactCreateWithCompanyName;
   export type ContactCreateWithFirstName = API.ContactCreateWithFirstName;

package/src/internal/qs/LICENSE.md

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2014, Nathan LaFreniere and other [contributors](https://github.com/puruvj/neoqs/graphs/contributors) All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/src/internal/qs/README.md

@@ -0,0 +1,3 @@
+# qs
+
+This is a vendored version of [neoqs](https://github.com/PuruVJ/neoqs) which is a TypeScript rewrite of [qs](https://github.com/ljharb/qs), a query string library.

package/src/internal/qs/formats.ts

@@ -0,0 +1,9 @@
+import type { Format } from './types';
+
+export const default_format: Format = 'RFC3986';
+export const formatters: Record<Format, (str: PropertyKey) => string> = {
+  RFC1738: (v: PropertyKey) => String(v).replace(/%20/g, '+'),
+  RFC3986: (v: PropertyKey) => String(v),
+};
+export const RFC1738 = 'RFC1738';
+export const RFC3986 = 'RFC3986';

package/src/internal/qs/index.ts

@@ -0,0 +1,13 @@
+import { default_format, formatters, RFC1738, RFC3986 } from './formats';
+
+const formats = {
+  formatters,
+  RFC1738,
+  RFC3986,
+  default: default_format,
+};
+
+export { stringify } from './stringify';
+export { formats };
+
+export type { DefaultDecoder, DefaultEncoder, Format, ParseOptions, StringifyOptions } from './types';