@artaio/node-api 1.6.0 → 1.7.0

package/dist/lib/arta.d.ts

@@ -1,4 +1,5 @@
 import type { Logger, LoggerVerbosity } from './logging';
+import { AddressVerificationsEndpoint } from './endpoint/addressVerifications';
 import { AttachmentsEndpoint } from './endpoint/attachment';
 import { EmailRulesEndpoint } from './endpoint/emailRules';
 import { EmailSubscriptionsEndpoint } from './endpoint/emailSubscriptions';
@@ -25,6 +26,7 @@ export interface ArtaConfig {
 export declare class Arta {
     private readonly artaClient;
     private readonly config;
+    address_verifications: AddressVerificationsEndpoint;
     attachments: AttachmentsEndpoint;
     email_rules: EmailRulesEndpoint;
     email_subscriptions: EmailSubscriptionsEndpoint;

package/dist/lib/arta.js

@@ -4,6 +4,7 @@ exports.Arta = void 0;
 var ArtaClient_1 = require("./ArtaClient");
 var logging_1 = require("./logging");
 var FetchHttpClient_1 = require("./net/FetchHttpClient");
+var addressVerifications_1 = require("./endpoint/addressVerifications");
 var attachment_1 = require("./endpoint/attachment");
 var emailRules_1 = require("./endpoint/emailRules");
 var emailSubscriptions_1 = require("./endpoint/emailSubscriptions");
@@ -35,6 +36,7 @@ var Arta = /** @class */ (function () {
             apiKey: apiKey,
             host: this.config.host,
         });
+        this.address_verifications = new addressVerifications_1.AddressVerificationsEndpoint(this.artaClient);
         this.attachments = new attachment_1.AttachmentsEndpoint(this.artaClient);
         this.email_rules = new emailRules_1.EmailRulesEndpoint(this.artaClient);
         this.email_subscriptions = new emailSubscriptions_1.EmailSubscriptionsEndpoint(this.artaClient);

package/dist/lib/endpoint/addressVerifications.d.ts

@@ -0,0 +1,30 @@
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { AddressVerification } from '../types';
+export interface AddressVerificationCreateBodyInput {
+    address_line_1: string;
+    address_line_2?: string | null;
+    address_line_3?: string | null;
+    city?: string | null;
+    region?: string | null;
+    postal_code?: string | null;
+    country: string;
+}
+export interface AddressVerificationCreateBody {
+    input: AddressVerificationCreateBodyInput;
+    reference?: string | null;
+}
+export interface AddressVerificationCreate {
+    address_verification: AddressVerificationCreateBody;
+}
+export declare class AddressVerificationsEndpoint {
+    private readonly artaClient;
+    private readonly defaultEndpoint;
+    private readonly path;
+    constructor(artaClient: RestClient);
+    getById(id: ArtaID, auth?: string): Promise<AddressVerification>;
+    list(page?: number, pageSize?: number, auth?: string): Promise<Page<AddressVerification>>;
+    listAll(auth?: string): AsyncGenerator<AddressVerification>;
+    create(payload: AddressVerificationCreateBody, auth?: string): Promise<AddressVerification>;
+}

package/dist/lib/endpoint/addressVerifications.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressVerificationsEndpoint = void 0;
+var endpoint_1 = require("./endpoint");
+var AddressVerificationsEndpoint = /** @class */ (function () {
+    function AddressVerificationsEndpoint(artaClient) {
+        this.artaClient = artaClient;
+        this.path = '/address_verifications';
+        this.defaultEndpoint = new endpoint_1.DefaultEndpoint(this.path, this.artaClient);
+    }
+    AddressVerificationsEndpoint.prototype.getById = function (id, auth) {
+        return this.defaultEndpoint.getById(id, auth);
+    };
+    AddressVerificationsEndpoint.prototype.list = function (page, pageSize, auth) {
+        if (page === void 0) { page = 1; }
+        if (pageSize === void 0) { pageSize = 20; }
+        return this.defaultEndpoint.list({ page: page, page_size: pageSize }, auth);
+    };
+    AddressVerificationsEndpoint.prototype.listAll = function (auth) {
+        return this.defaultEndpoint.listAll(auth);
+    };
+    AddressVerificationsEndpoint.prototype.create = function (payload, auth) {
+        return this.defaultEndpoint.create({ address_verification: payload }, auth);
+    };
+    return AddressVerificationsEndpoint;
+}());
+exports.AddressVerificationsEndpoint = AddressVerificationsEndpoint;

package/dist/lib/index.d.ts

@@ -1,5 +1,6 @@
 export { Arta } from './arta';
 export { Logger, LoggerVerbosity } from './logging';
+export { AddressVerificationCreateBody } from './endpoint/addressVerifications';
 export { AttachmentCreateBodyRequest, AttachmentCreateBodyShipment, AttachmentCreateBody, } from './endpoint/attachment';
 export { EmailRuleCreateBody } from './endpoint/emailRules';
 export { EmailSubscriptionCreateBody } from './endpoint/emailSubscriptions';

package/dist/lib/types.d.ts

@@ -1100,3 +1100,33 @@ export type ArtaInboundObject = {
         value_currency?: (("CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD") | null) | undefined;
     }[] | null) | undefined;
 };
+export type AddressVerification = {
+    updated_at: Date;
+    created_at: Date;
+    id: string;
+    shortcode: string;
+    status: "success" | "partial" | "failed";
+    match_level: "delivery_point" | "premise" | "thoroughfare" | "locality" | "administrative_area" | "none";
+    reference: string | null;
+    input: {
+        address_line_1: string;
+        address_line_2: string | null;
+        address_line_3: string | null;
+        city: string | null;
+        region: string | null;
+        postal_code: string | null;
+        country: string;
+    };
+    recommendation: {
+        address_line_1: string | null;
+        address_line_2: string | null;
+        address_line_3: string | null;
+        city: string | null;
+        region: string | null;
+        postal_code: string | null;
+        country: string | null;
+        latitude: number | null;
+        longitude: number | null;
+        is_residential: boolean | null;
+    };
+};

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@artaio/node-api",
-    "version": "1.6.0",
+    "version": "1.7.0",
     "description": "The Arta Node library provides a seamless integration to Arta API for backend applications using both Typescript or Javascript.",
     "scripts": {
         "build": "npm run build:types && tsc -p tsconfig-build.json",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artaio/node-api",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "The Arta Node library provides a seamless integration to Arta API for backend applications using both Typescript or Javascript.",
   "scripts": {
     "build": "npm run build:types && tsc -p tsconfig-build.json",