postgrid-node 0.1.0-alpha.4 → 0.2.0

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,gBAAgB,EAChB,YAAY,GAMb;OACM,EACL,oBAAoB,EACpB,KAAK,GAON;OACM,EACL,yBAAyB,EACzB,SAAS,GAWV;OACM,EACL,WAAW,EACX,OAAO,GAKR;OACM,EACL,YAAY,EACZ,QAAQ,GAKT;OACM,EACL,WAAW,EACX,OAAO,GAMR;OACM,EACL,kCAAkC,EAClC,kBAAkB,GASnB;OACM,EACL,4BAA4B,EAC5B,YAAY,GAWb;OACM,EAAE,aAAa,EAAE;OACjB,EACL,aAAa,EACb,SAAS,GAMV;OACM,EACL,uBAAuB,EACvB,OAAO,GAaR;OACM,EACL,2BAA2B,EAC3B,WAAW,GAQZ;OACM,EACL,gCAAgC,EAChC,gBAAgB,GAQjB;OACM,EACL,aAAa,EACb,SAAS,GAOV"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,mBAAmB,GAKpB;OACM,EACL,uBAAuB,GAGxB;OACM,EAAE,SAAS,EAAE"}

package/resources/intl-address-verification.d.mts

@@ -0,0 +1,406 @@
+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 IntlAddressVerification extends APIResource {
+    /**
+     * Verify and standardize an international address.
+     *
+     * - Supports both structured and freeform address inputs.
+     * - Specify `includeDetails=true` to get additional details as per the
+     *   `IntlDetails` schema.
+     * - Uses 1 lookup.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.intlAddressVerification.verify({
+     *     address: {
+     *       '0': '3',
+     *       '1': '1',
+     *       '2': ' ',
+     *       '3': 'F',
+     *       '4': 'l',
+     *       '5': ' ',
+     *       '6': 'S',
+     *       '7': 'c',
+     *       '8': 'a',
+     *       '9': 'r',
+     *       '10': 'b',
+     *       '11': 'o',
+     *       '12': 'r',
+     *       '13': 'o',
+     *       '14': 'u',
+     *       '15': 'g',
+     *       '16': 'h',
+     *       '17': ',',
+     *       '18': ' ',
+     *       '19': 'C',
+     *       '20': 'a',
+     *       '21': 'n',
+     *       '22': 'a',
+     *       '23': 'd',
+     *       '24': 'a',
+     *     },
+     *   });
+     * ```
+     */
+    verify(params: IntlAddressVerificationVerifyParams, options?: RequestOptions): APIPromise<IntlAddressVerificationVerifyResponse>;
+}
+export interface IntlAddressVerificationVerifyResponse {
+    /**
+     * The result of a verified international address.
+     */
+    data: IntlAddressVerificationVerifyResponse.Data;
+    message: string;
+    status: 'success' | 'error';
+}
+export declare namespace IntlAddressVerificationVerifyResponse {
+    /**
+     * The result of a verified international address.
+     */
+    interface Data {
+        /**
+         * The city or locality.
+         */
+        city: string;
+        /**
+         * The country code (ISO 3166-1 alpha-2).
+         */
+        country: string;
+        /**
+         * The first address line.
+         */
+        line1: string;
+        /**
+         * The postal or ZIP code.
+         */
+        postalOrZip: string;
+        /**
+         * The province or state.
+         */
+        provinceOrState: string;
+        /**
+         * The full country name.
+         */
+        countryName?: string;
+        /**
+         * Additional details about the verified address, such as premise, thoroughfare,
+         * and locality.
+         */
+        details?: Data.Details;
+        /**
+         * Errors encountered during address verification.
+         */
+        errors?: AddressVerificationAPI.Errors;
+        /**
+         * The firm or company name, if available.
+         */
+        firmName?: string;
+        /**
+         * The formatted address string.
+         */
+        formattedAddress?: string;
+        /**
+         * Geocoding result for the verified address.
+         */
+        geoData?: Data.GeoData;
+        /**
+         * The second address line.
+         */
+        line2?: string;
+        /**
+         * The third address line, if available.
+         */
+        line3?: string;
+        /**
+         * The verification status of an address.
+         */
+        status?: AddressVerificationAPI.Status;
+        /**
+         * A summary of the verification process and match levels.
+         */
+        summary?: Data.Summary;
+        /**
+         * The ZIP+4 code (for US addresses).
+         */
+        zipPlus4?: string;
+    }
+    namespace Data {
+        /**
+         * Additional details about the verified address, such as premise, thoroughfare,
+         * and locality.
+         */
+        interface Details {
+            /**
+             * The building name or number.
+             */
+            building?: string;
+            /**
+             * The type of building (e.g., apartment, office).
+             */
+            buildingType?: string;
+            /**
+             * The full city name.
+             */
+            cityName?: string;
+            /**
+             * Secondary city information.
+             */
+            citySecondary?: string;
+            /**
+             * The type of city (e.g., city, town, village).
+             */
+            cityType?: string;
+            /**
+             * The full delivery address.
+             */
+            deliveryAddress?: string;
+            /**
+             * The dependent locality (UK addresses).
+             */
+            dependentLocality?: string;
+            /**
+             * The double dependent locality (UK addresses).
+             */
+            doubleDependentLocality?: string;
+            /**
+             * The organization or company name.
+             */
+            organization?: string;
+            /**
+             * The primary part of the postal or ZIP code.
+             */
+            postalOrZipPrimary?: string;
+            /**
+             * The secondary part of the postal or ZIP code.
+             */
+            postalOrZipSecondary?: string;
+            /**
+             * The post box number.
+             */
+            postBox?: string;
+            /**
+             * The premise name or number.
+             */
+            premise?: string;
+            /**
+             * The premise number.
+             */
+            premiseNumber?: string;
+            /**
+             * Secondary premise information.
+             */
+            premiseSecondary?: string;
+            /**
+             * The type of premise (e.g., house, flat).
+             */
+            premiseType?: string;
+            /**
+             * The full name of the province or state.
+             */
+            provinceOrStateName?: string;
+            /**
+             * The type of province or state (e.g., province, state, region).
+             */
+            provinceOrStateType?: string;
+            /**
+             * The street name.
+             */
+            street?: string;
+            /**
+             * The directional suffix for the street (e.g., N, S, E, W).
+             */
+            streetPostDirection?: string;
+            /**
+             * The directional prefix for the street (e.g., N, S, E, W).
+             */
+            streetPreDirection?: string;
+            /**
+             * The type of street (e.g., St, Ave, Blvd).
+             */
+            streetType?: string;
+            /**
+             * The sub-administrative area.
+             */
+            subAdministrativeArea?: string;
+            /**
+             * The sub-building name or number (e.g., unit, suite).
+             */
+            subBuilding?: string;
+            /**
+             * The floor of the sub-building.
+             */
+            SubBuildingFloor?: string;
+            /**
+             * The sub-building number.
+             */
+            subBuildingNumber?: string;
+            /**
+             * The type of sub-building (e.g., floor, wing).
+             */
+            subBuildingType?: string;
+            /**
+             * The sub-street name.
+             */
+            subStreet?: string;
+            /**
+             * The directional suffix for the sub-street.
+             */
+            subStreetPostDirection?: string;
+            /**
+             * The directional prefix for the sub-street.
+             */
+            subStreetPreDirection?: string;
+            /**
+             * The type of sub-street.
+             */
+            subStreetType?: string;
+            /**
+             * The super-administrative area.
+             */
+            superAdministrativeArea?: string;
+            /**
+             * The telephone number associated with the address.
+             */
+            telephone?: string;
+        }
+        /**
+         * Geocoding result for the verified address.
+         */
+        interface GeoData {
+            /**
+             * The geocode accuracy.
+             */
+            geoAccuracy?: string;
+            /**
+             * The latitude of the address.
+             */
+            latitude?: string;
+            /**
+             * The longitude of the address.
+             */
+            longitude?: string;
+        }
+        /**
+         * A summary of the verification process and match levels.
+         */
+        interface Summary {
+            /**
+             * Context identification match level.
+             */
+            contextIdentificationMatchLevel?: string;
+            /**
+             * Lexicon identification match level.
+             */
+            lexiconIdentificationMatchLevel?: string;
+            /**
+             * The match score (0-100).
+             */
+            matchScore?: number;
+            /**
+             * Additional message about the verification.
+             */
+            message?: string;
+            /**
+             * The parsing status of the address.
+             */
+            parsingStatus?: string;
+            /**
+             * The status of the postal code.
+             */
+            postCodeStatus?: string;
+            /**
+             * The match level after post-processing.
+             */
+            postProcessedVerificationMatchLevel?: string;
+            /**
+             * The match level before post-processing.
+             */
+            preProcessedVerificationMatchLevel?: string;
+            /**
+             * The overall verification status.
+             */
+            verificationStatus?: string;
+        }
+    }
+}
+export type IntlAddressVerificationVerifyParams = IntlAddressVerificationVerifyParams.StructuredAddressInput | IntlAddressVerificationVerifyParams.FreeformAddressInput;
+export declare namespace IntlAddressVerificationVerifyParams {
+    interface StructuredAddressInput {
+        /**
+         * Body param:
+         */
+        address: StructuredAddressInput.Address;
+        /**
+         * Query param:
+         */
+        geoData?: boolean;
+        /**
+         * Query param:
+         */
+        includeDetails?: boolean;
+        /**
+         * Query param:
+         */
+        properCase?: boolean;
+    }
+    namespace StructuredAddressInput {
+        interface Address {
+            /**
+             * The country code (ISO 3166-1 alpha-2 or alpha-3).
+             */
+            country: string;
+            /**
+             * The first line of the address (e.g., street address, building, etc.).
+             */
+            line1: string;
+            /**
+             * The postal or ZIP code.
+             */
+            postalOrZip: string;
+            /**
+             * The administrative area (e.g., state, province, region).
+             */
+            provinceOrState: string;
+            /**
+             * The city, town, or locality of the address.
+             */
+            city?: string;
+            /**
+             * The second line of the address (e.g., apartment, suite, etc.).
+             */
+            line2?: string;
+            /**
+             * The third line of the address (e.g., additional locality or delivery info).
+             */
+            line3?: string;
+            /**
+             * The fourth line of the address (e.g., further address details).
+             */
+            line4?: string;
+        }
+    }
+    interface FreeformAddressInput {
+        /**
+         * Body param: The full address as a single string.
+         */
+        address: string;
+        /**
+         * Query param:
+         */
+        geoData?: boolean;
+        /**
+         * Query param:
+         */
+        includeDetails?: boolean;
+        /**
+         * Query param:
+         */
+        properCase?: boolean;
+    }
+}
+export declare namespace IntlAddressVerification {
+    export { type IntlAddressVerificationVerifyResponse as IntlAddressVerificationVerifyResponse, type IntlAddressVerificationVerifyParams as IntlAddressVerificationVerifyParams, };
+}
+//# sourceMappingURL=intl-address-verification.d.mts.map

package/resources/intl-address-verification.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intl-address-verification.d.mts","sourceRoot":"","sources":["../src/resources/intl-address-verification.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,sBAAsB;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CACJ,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAQrD;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,IAAI,EAAE,qCAAqC,CAAC,IAAI,CAAC;IAEjD,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;CAC7B;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;QAEvC;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;YAEjC;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;YAEhC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;YAEjC;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;YAEzC;;eAEG;YACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;YAEzC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;YAE7C;;eAEG;YACH,kCAAkC,CAAC,EAAE,MAAM,CAAC;YAE5C;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;SAC7B;KACF;CACF;AAED,MAAM,MAAM,mCAAmC,GAC3C,mCAAmC,CAAC,sBAAsB,GAC1D,mCAAmC,CAAC,oBAAoB,CAAC;AAE7D,MAAM,CAAC,OAAO,WAAW,mCAAmC,CAAC;IAC3D,UAAiB,sBAAsB;QACrC;;WAEG;QACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;QAExC;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;IAED,UAAiB,sBAAsB,CAAC;QACtC,UAAiB,OAAO;YACtB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}