postgrid-node 0.1.0-alpha.5 → 0.3.0

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "postgrid-node",
-  "version": "0.1.0-alpha.5",
-  "description": "The official TypeScript library for the PostGrid API",
-  "author": "PostGrid <support@postgrid.com>",
+  "version": "0.3.0",
+  "description": "The official TypeScript library for the Post Grid API",
+  "author": "Post Grid <support@postgrid.com>",
   "types": "./index.d.ts",
   "main": "./index.js",
   "type": "commonjs",
   "repository": "github:postgrid/postgrid-node",
   "license": "Apache-2.0",
-  "packageManager": "yarn@1.22.22",
   "files": [
     "**/*"
   ],
@@ -16,67 +15,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "test": "./scripts/test",
-    "build": "./scripts/build",
-    "format": "prettier --write --cache --cache-strategy metadata . !dist",
-    "tsn": "ts-node -r tsconfig-paths/register",
-    "lint": "./scripts/lint",
-    "fix": "./scripts/format"
-  },
-  "dependencies": {
-    "@types/node": "^18.11.18",
-    "@types/node-fetch": "^2.6.4",
-    "abort-controller": "^3.0.0",
-    "agentkeepalive": "^4.2.1",
-    "form-data-encoder": "1.7.2",
-    "formdata-node": "^4.3.2",
-    "node-fetch": "^2.6.7"
-  },
-  "sideEffects": [
-    "./_shims/index.js",
-    "./_shims/index.mjs",
-    "./shims/node.js",
-    "./shims/node.mjs",
-    "./shims/web.js",
-    "./shims/web.mjs"
-  ],
+  "dependencies": {},
   "exports": {
-    "./_shims/auto/*": {
-      "deno": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
-      },
-      "bun": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*-bun.js",
-        "default": "./_shims/auto/*-bun.mjs"
-      },
-      "browser": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
-      },
-      "worker": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
-      },
-      "workerd": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
-      },
-      "node": {
-        "types": "./_shims/auto/*-node.d.ts",
-        "require": "./_shims/auto/*-node.js",
-        "default": "./_shims/auto/*-node.mjs"
-      },
-      "types": "./_shims/auto/*.d.ts",
-      "require": "./_shims/auto/*.js",
-      "default": "./_shims/auto/*.mjs"
-    },
     ".": {
       "require": {
         "types": "./index.d.ts",
@@ -85,18 +25,113 @@
       "types": "./index.d.mts",
       "default": "./index.mjs"
     },
-    "./*.mjs": {
-      "types": "./*.d.ts",
-      "default": "./*.mjs"
+    "./api-promise": {
+      "import": "./api-promise.mjs",
+      "require": "./api-promise.js"
+    },
+    "./api-promise.js": {
+      "default": "./api-promise.js"
+    },
+    "./api-promise.mjs": {
+      "default": "./api-promise.mjs"
+    },
+    "./client": {
+      "import": "./client.mjs",
+      "require": "./client.js"
+    },
+    "./client.js": {
+      "default": "./client.js"
+    },
+    "./client.mjs": {
+      "default": "./client.mjs"
+    },
+    "./core/*.mjs": {
+      "default": "./core/*.mjs"
+    },
+    "./core/*.js": {
+      "default": "./core/*.js"
+    },
+    "./core/*": {
+      "import": "./core/*.mjs",
+      "require": "./core/*.js"
+    },
+    "./error": {
+      "import": "./error.mjs",
+      "require": "./error.js"
+    },
+    "./error.js": {
+      "default": "./error.js"
     },
-    "./*.js": {
-      "types": "./*.d.ts",
-      "default": "./*.js"
+    "./error.mjs": {
+      "default": "./error.mjs"
     },
-    "./*": {
-      "types": "./*.d.ts",
-      "require": "./*.js",
-      "default": "./*.mjs"
+    "./index": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    },
+    "./index.js": {
+      "default": "./index.js"
+    },
+    "./index.mjs": {
+      "default": "./index.mjs"
+    },
+    "./resource": {
+      "import": "./resource.mjs",
+      "require": "./resource.js"
+    },
+    "./resource.js": {
+      "default": "./resource.js"
+    },
+    "./resource.mjs": {
+      "default": "./resource.mjs"
+    },
+    "./resources/*.mjs": {
+      "default": "./resources/*.mjs"
+    },
+    "./resources/*.js": {
+      "default": "./resources/*.js"
+    },
+    "./resources/*": {
+      "import": "./resources/*.mjs",
+      "require": "./resources/*.js"
+    },
+    "./resources": {
+      "import": "./resources.mjs",
+      "require": "./resources.js"
+    },
+    "./resources.js": {
+      "default": "./resources.js"
+    },
+    "./resources.mjs": {
+      "default": "./resources.mjs"
+    },
+    "./uploads": {
+      "import": "./uploads.mjs",
+      "require": "./uploads.js"
+    },
+    "./uploads.js": {
+      "default": "./uploads.js"
+    },
+    "./uploads.mjs": {
+      "default": "./uploads.mjs"
+    },
+    "./version": {
+      "import": "./version.mjs",
+      "require": "./version.js"
+    },
+    "./version.js": {
+      "default": "./version.js"
+    },
+    "./version.mjs": {
+      "default": "./version.mjs"
     }
+  },
+  "scripts": {
+    "test": "./scripts/test",
+    "build": "./scripts/build",
+    "format": "./scripts/format",
+    "tsn": "ts-node -r tsconfig-paths/register",
+    "lint": "./scripts/lint",
+    "fix": "./scripts/format"
   }
-}
+}

package/resource.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/resource.mjs";
+//# sourceMappingURL=resource.d.mts.map

package/resource.d.mts.map

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

package/resource.d.ts

@@ -1,6 +1,2 @@
-import type { PostGrid } from "./index.js";
-export declare abstract class APIResource {
-    protected _client: PostGrid;
-    constructor(client: PostGrid);
-}
+export * from "./core/resource.js";
 //# sourceMappingURL=resource.d.ts.map

package/resource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,8BAAsB,WAAW;IAC/B,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC;gBAEhB,MAAM,EAAE,QAAQ;CAG7B"}
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}

package/resource.js

@@ -1,11 +1,6 @@
 "use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.APIResource = void 0;
-class APIResource {
-    constructor(client) {
-        this._client = client;
-    }
-}
-exports.APIResource = APIResource;
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/resource instead */
+tslib_1.__exportStar(require("./core/resource.js"), exports);
 //# sourceMappingURL=resource.js.map

package/resource.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource.js","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAItF,MAAsB,WAAW;IAG/B,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;CACF;AAND,kCAMC"}
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,6DAAgC"}

package/resource.mjs

@@ -1,7 +1,2 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export class APIResource {
-    constructor(client) {
-        this._client = client;
-    }
-}
+export * from "./core/resource.mjs";
 //# sourceMappingURL=resource.mjs.map

package/resource.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAItF,MAAM,OAAgB,WAAW;IAG/B,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;CACF"}
+{"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":""}

package/resources/address-verification.d.mts

@@ -0,0 +1,425 @@
+import { APIResource } from "../core/resource.mjs";
+import * as AddressVerificationAPI from "./address-verification.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class AddressVerification extends APIResource {
+    /**
+     * 1. **Structured Address** — Verify and standardize a structured address (e.g.,
+     *    with `line1`, `city`, etc.).
+     * 2. **Freeform Address** — Verify and standardize a freeform address written on
+     *    one line. For best results, append the ISO 2-letter country code (e.g., `US`,
+     *    `CA`) to the end of the line.
+     *
+     * - Specifying `includeDetails=true` will provide additional output as documented
+     *   in the `Details` schema.
+     * - Uses 1 lookup for verification, and 1 more if geocoding (unless your contract
+     *   says otherwise).
+     *
+     * @example
+     * ```ts
+     * const response = await client.addressVerification.verify({
+     *   address: '1234 Elm St, Los Angeles, CA 90001, US',
+     * });
+     * ```
+     */
+    verify(params: AddressVerificationVerifyParams, options?: RequestOptions): APIPromise<AddressVerificationVerifyResponse>;
+}
+/**
+ * Errors encountered during address verification.
+ */
+export interface Errors {
+    /**
+     * Errors related to the city.
+     */
+    city?: Array<string>;
+    /**
+     * Generic errors not tied to a specific field.
+     */
+    generic?: Array<string>;
+    /**
+     * Errors related to the first address line.
+     */
+    line1?: Array<string>;
+    /**
+     * Errors related to the second address line.
+     */
+    line2?: Array<string>;
+    /**
+     * Errors related to the province or state.
+     */
+    provinceOrState?: Array<string>;
+}
+/**
+ * The verification status of an address.
+ */
+export type Status = 'verified' | 'corrected' | 'failed';
+export interface AddressVerificationVerifyResponse {
+    data: AddressVerificationVerifyResponse.Data;
+    message: string;
+    status: 'success' | 'error';
+}
+export declare namespace AddressVerificationVerifyResponse {
+    interface Data {
+        /**
+         * The city name of the address.
+         */
+        city: string;
+        /**
+         * The country code of the address.
+         */
+        country: string;
+        /**
+         * The first line of the address.
+         */
+        line1: string;
+        /**
+         * The postal code or ZIP code of the address.
+         */
+        postalOrZip: string;
+        /**
+         * The province or state of the address.
+         */
+        provinceOrState: string;
+        /**
+         * The country name of the address.
+         */
+        countryName?: string;
+        /**
+         * If you supply `includeDetails=true` as a query parameter, we will also populate
+         * an additional `details` field that follows the
+         * [Address Details](https://avdocs.postgrid.com/#address-details) schema.
+         */
+        details?: Data.Details;
+        /**
+         * Errors encountered during address verification.
+         */
+        errors?: AddressVerificationAPI.Errors;
+        /**
+         * The firm name of the address.
+         */
+        firmName?: string;
+        /**
+         * If the `geocode=true` query parameter is supplied, the response will include a
+         * geocodeResult which follows the
+         * [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this
+         * feature be enabled by emailing `support@postgrid.com`. This includes our
+         * verification, batch verification, suggestions, and POST /completions endpoint.
+         * Note that you must supply country when geocoding to get the result successfully.
+         */
+        geocodeResult?: Data.GeocodeResult;
+        /**
+         * The second line of the address.
+         */
+        line2?: string;
+        /**
+         * The verification status of an address.
+         */
+        status?: AddressVerificationAPI.Status;
+        /**
+         * The zip plus 4 code of the address.
+         */
+        zipPlus4?: string;
+    }
+    namespace Data {
+        /**
+         * If you supply `includeDetails=true` as a query parameter, we will also populate
+         * an additional `details` field that follows the
+         * [Address Details](https://avdocs.postgrid.com/#address-details) schema.
+         */
+        interface Details {
+            /**
+             * PO Box ID
+             */
+            boxID?: string;
+            /**
+             * County in the United States (US address only)
+             */
+            county?: string;
+            /**
+             * FIPS code for county (US address only)
+             */
+            countyNum?: string;
+            /**
+             * Delivery installation area name
+             */
+            deliveryInstallationAreaName?: string;
+            /**
+             * Delivery installation qualifier
+             */
+            deliveryInstallationQualifier?: string;
+            /**
+             * Delivery installation type
+             */
+            deliveryInstallationType?: string;
+            /**
+             * Any extra information relevant to the address
+             */
+            extraInfo?: string;
+            /**
+             * The post-direction of the street (after the street name, US addresses only)
+             */
+            postDirection?: string;
+            /**
+             * The pre-direction of the street (before the street name, US addresses only)
+             */
+            preDirection?: string;
+            /**
+             * Indicates that the address is residential (US address only)
+             */
+            residential?: boolean;
+            /**
+             * Rural route number
+             */
+            ruralRouteNumber?: string;
+            /**
+             * Rural route type
+             */
+            ruralRouteType?: string;
+            /**
+             * The direction of the street (N, S, E, W, etc)
+             */
+            streetDirection?: string;
+            /**
+             * Name of the street where the address is located
+             */
+            streetName?: string;
+            /**
+             * Street number (e.g. the 20 in 20 Bay St)
+             */
+            streetNumber?: string;
+            /**
+             * Type of the street (DR, ST, BLVD, etc)
+             */
+            streetType?: string;
+            /**
+             * The unit number/name
+             */
+            suiteID?: string;
+            /**
+             * The suite key
+             */
+            suiteKey?: string;
+            /**
+             * US Census block number
+             */
+            usCensusBlockNumber?: string;
+            /**
+             * US Census consolidated metropolitan statistical area
+             */
+            usCensusCMSA?: string;
+            /**
+             * US Census metropolitan area
+             */
+            usCensusMA?: string;
+            /**
+             * US Census metropolitan statistical area
+             */
+            usCensusMSA?: string;
+            /**
+             * US Census primary metropolitan statistical area
+             */
+            usCensusPMSA?: string;
+            /**
+             * US Census tract number
+             */
+            usCensusTractNumber?: string;
+            /**
+             * US congressional district number
+             */
+            usCongressionalDistrictNumber?: string;
+            /**
+             * True if address location recognizes DST
+             */
+            usHasDaylightSavings?: boolean;
+            /**
+             * PostNet barcode digit
+             */
+            usMailingCheckDigit?: string;
+            /**
+             * 4-character code assigned to mail delivery route within a 5 digit zip code
+             */
+            usMailingsCarrierRoute?: string;
+            /**
+             * True if US address matches a high-rise default or rural route default in the
+             * USPS data
+             */
+            usMailingsDefaultFlag?: boolean;
+            /**
+             * Unique USPS identifier for the delivery point
+             */
+            usMailingsDeliveryPoint?: string;
+            /**
+             * See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)
+             */
+            usMailingsDpvConfirmationIndicator?: string;
+            /**
+             * Y if this is a commercial mail receiving agency, N otherwise
+             */
+            usMailingsDpvCrmaIndicator?: string;
+            /**
+             * See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)
+             */
+            usMailingsDpvFootnote1?: string;
+            /**
+             * See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)
+             */
+            usMailingsDpvFootnote2?: string;
+            /**
+             * See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)
+             */
+            usMailingsDpvFootnote3?: string;
+            /**
+             * A for ascending, D for descending
+             */
+            usMailingsElotAscDesc?: string;
+            /**
+             * eLOT sequence number
+             */
+            usMailingsElotSequenceNumber?: string;
+            /**
+             * Y if address is in early warning system database
+             */
+            usMailingsEWSFlag?: string;
+            /**
+             * Y if address converted by LACS
+             */
+            usMailingsLACSFlag?: string;
+            /**
+             * Corresponds to USPS LACSLink return code
+             */
+            usMailingsLACSReturnCode?: string;
+            /**
+             * See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)
+             */
+            usMailingsRecordTypeCode?: string;
+            /**
+             * See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)
+             */
+            usMailingsSuiteLinkReturnCode?: string;
+            /**
+             * Lower legislative district for the US address
+             */
+            usStateLegislativeLower?: string;
+            /**
+             * Upper legislative district for the US address
+             */
+            usStateLegislativeUpper?: string;
+            /**
+             * Time zone for the US address area
+             */
+            usTimeZone?: string;
+            /**
+             * Indicates that the address is vacant according to the USPS (US address only)
+             */
+            vacant?: boolean;
+        }
+        /**
+         * If the `geocode=true` query parameter is supplied, the response will include a
+         * geocodeResult which follows the
+         * [Geocoding](https://avdocs.postgrid.com/#geocoding) schema. You can request this
+         * feature be enabled by emailing `support@postgrid.com`. This includes our
+         * verification, batch verification, suggestions, and POST /completions endpoint.
+         * Note that you must supply country when geocoding to get the result successfully.
+         */
+        interface GeocodeResult {
+            /**
+             * A real number from 0.00 to 1.00 which represents an
+             * [accuracy score](https://avdocs.postgrid.com/#accuracy-score)
+             */
+            accuracy: number;
+            /**
+             * A string representing the
+             * [accuracy type](https://avdocs.postgrid.com/#accuracy-type)
+             */
+            accuracyType: 'rooftop' | 'point' | 'range_interpolation' | 'nearest_rooftop_match' | 'intersection' | 'street_center' | 'place' | 'state';
+            /**
+             * Object that contains `lat`, `lng` properties with number values
+             */
+            location: GeocodeResult.Location;
+        }
+        namespace GeocodeResult {
+            /**
+             * Object that contains `lat`, `lng` properties with number values
+             */
+            interface Location {
+                lat: number;
+                lng: number;
+            }
+        }
+    }
+}
+export type AddressVerificationVerifyParams = AddressVerificationVerifyParams.StandardFreeformAddressInput | AddressVerificationVerifyParams.StandardStructuredAddressInput;
+export declare namespace AddressVerificationVerifyParams {
+    interface StandardFreeformAddressInput {
+        /**
+         * Body param: The address you want to verify, written on a single line.
+         */
+        address: string;
+        /**
+         * Query param:
+         */
+        geocode?: boolean;
+        /**
+         * Query param:
+         */
+        includeDetails?: boolean;
+        /**
+         * Query param:
+         */
+        properCase?: boolean;
+    }
+    interface StandardStructuredAddressInput {
+        /**
+         * Body param:
+         */
+        address: StandardStructuredAddressInput.Address;
+        /**
+         * Query param:
+         */
+        geocode?: boolean;
+        /**
+         * Query param:
+         */
+        includeDetails?: boolean;
+        /**
+         * Query param:
+         */
+        properCase?: boolean;
+    }
+    namespace StandardStructuredAddressInput {
+        interface Address {
+            /**
+             * The city of the address.
+             */
+            city: string;
+            /**
+             * The country of your address, one of `ca` or `us`.
+             */
+            country: 'ca' | 'us';
+            /**
+             * The first line of the address.
+             */
+            line1: string;
+            /**
+             * The postal code or ZIP code of the address.
+             */
+            postalOrZip: string;
+            /**
+             * The province or state of the address.
+             */
+            provinceOrState: string;
+            /**
+             * The second line of the address.
+             */
+            line2?: string;
+            /**
+             * The optional firm/recipient name.
+             */
+            recipient?: string;
+        }
+    }
+}
+export declare namespace AddressVerification {
+    export { type Errors as Errors, type Status as Status, type AddressVerificationVerifyResponse as AddressVerificationVerifyResponse, type AddressVerificationVerifyParams as AddressVerificationVerifyParams, };
+}
+//# sourceMappingURL=address-verification.d.mts.map