@artaio/node-api 1.9.1 → 1.11.0

package/dist/lib/arta.d.ts

@@ -20,6 +20,7 @@ import { SelfShipCollectionAvailabilityChecksEndpoint } from './endpoint/selfShi
 import { SelfShipCollectionsEndpoint } from './endpoint/selfShipCollections';
 import { ShipmentsEndpoint } from './endpoint/shipments';
 import { TagsEndpoint } from './endpoint/tags';
+import { ImportCostEstimatesEndpoint } from './endpoint/importCostEstimates';
 export interface ArtaConfig {
     host: string;
     verbosity: LoggerVerbosity;
@@ -33,6 +34,7 @@ export declare class Arta {
     email_rules: EmailRulesEndpoint;
     email_subscriptions: EmailSubscriptionsEndpoint;
     hosted_sessions: HostedSessionsEndpoint;
+    import_cost_estimates: ImportCostEstimatesEndpoint;
     invoice_payments: InvoicePaymentsEndpoint;
     invoices: InvoicesEndpoint;
     keys: KeysEndpoint;

package/dist/lib/arta.js

@@ -25,6 +25,7 @@ const selfShipCollectionAvailabilityChecks_1 = require("./endpoint/selfShipColle
 const selfShipCollections_1 = require("./endpoint/selfShipCollections");
 const shipments_1 = require("./endpoint/shipments");
 const tags_1 = require("./endpoint/tags");
+const importCostEstimates_1 = require("./endpoint/importCostEstimates");
 const defaultConfig = {
     host: 'api.arta.io',
     verbosity: 'ERROR',
@@ -43,6 +44,7 @@ class Arta {
         this.email_rules = new emailRules_1.EmailRulesEndpoint(this.artaClient);
         this.email_subscriptions = new emailSubscriptions_1.EmailSubscriptionsEndpoint(this.artaClient);
         this.hosted_sessions = new hostedSessions_1.HostedSessionsEndpoint(this.artaClient);
+        this.import_cost_estimates = new importCostEstimates_1.ImportCostEstimatesEndpoint(this.artaClient);
         this.invoice_payments = new invoicePayments_1.InvoicePaymentsEndpoint(this.artaClient);
         this.invoices = new invoices_1.InvoicesEndpoint(this.artaClient);
         this.keys = new keys_1.KeysEndpoint(this.artaClient);

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

@@ -10,6 +10,8 @@ export type EnrichedHostedSession = HostedSession & {
 export type HostedSessionCreateBody = {
     additional_services?: Nullable<AdditionalService[]>;
     cancel_url?: NullableString;
+    customs_end_use?: HostedSession['customs_end_use'];
+    customs_process?: HostedSession['customs_process'];
     destination?: Nullable<ArtaLocation>;
     insurance?: Nullable<Insurance>;
     internal_reference?: NullableString;
@@ -31,6 +33,8 @@ export type HostedSessionCreateBody = {
 } | {
     additional_services?: Nullable<AdditionalService[]>;
     cancel_url?: NullableString;
+    customs_end_use?: HostedSession['customs_end_use'];
+    customs_process?: HostedSession['customs_process'];
     destination: ArtaLocation;
     insurance?: Nullable<Insurance>;
     internal_reference?: NullableString;

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

@@ -0,0 +1,17 @@
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { ImportCostEstimate } from '../types';
+export type ImportCostEstimateCreateBodyFromQuote = Pick<ImportCostEstimate, 'currency' | 'end_use' | 'reference'> & {
+    quote_id: string;
+};
+export type ImportCostEstimateCreateBodyDirect = Pick<ImportCostEstimate, 'currency' | 'destination' | 'end_use' | 'objects' | 'origin' | 'reference' | 'transport'>;
+export type ImportCostEstimateCreateBody = ImportCostEstimateCreateBodyFromQuote | ImportCostEstimateCreateBodyDirect;
+export declare class ImportCostEstimatesEndpoint {
+    private readonly artaClient;
+    private readonly defaultEndpoint;
+    private readonly path;
+    constructor(artaClient: RestClient);
+    getById(id: ImportCostEstimate['id'], auth?: string): Promise<ImportCostEstimate>;
+    list(page?: number, pageSize?: number, auth?: string): Promise<Page<ImportCostEstimate>>;
+    create(payload: ImportCostEstimateCreateBody, auth?: string): Promise<ImportCostEstimate>;
+}

package/dist/lib/endpoint/importCostEstimates.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportCostEstimatesEndpoint = void 0;
+const endpoint_1 = require("./endpoint");
+class ImportCostEstimatesEndpoint {
+    constructor(artaClient) {
+        this.artaClient = artaClient;
+        this.path = '/import_cost_estimates';
+        this.defaultEndpoint = new endpoint_1.DefaultEndpoint(this.path, this.artaClient);
+    }
+    getById(id, auth) {
+        return this.defaultEndpoint.getById(id, auth);
+    }
+    list(page = 1, pageSize = 20, auth) {
+        return this.defaultEndpoint.list({ page, page_size: pageSize }, auth);
+    }
+    create(payload, auth) {
+        return this.defaultEndpoint.create({ import_cost_estimate: payload }, auth);
+    }
+}
+exports.ImportCostEstimatesEndpoint = ImportCostEstimatesEndpoint;

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

@@ -11,6 +11,8 @@ export type EnrichRequest<T> = T & {
 export interface QuoteRequestCreateBody {
     additional_services?: Nullable<AdditionalService[]>;
     currency?: Nullable<SupportedCurrency>;
+    customs_end_use?: QuoteRequest['customs_end_use'];
+    customs_process?: QuoteRequest['customs_process'];
     destination: ArtaLocation;
     insurance?: Nullable<Insurance>;
     internal_reference?: NullableString;

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

@@ -5,6 +5,7 @@ import type { ShipmentsSearch } from '../search';
 import type { NullableString } from '../utils';
 import type { Shipment } from '../types';
 export interface ShipmentCreateBody {
+    customs_process?: Shipment['customs_process'];
     exceptions?: Array<{
         type: 'label_hold';
     }>;

package/dist/lib/index.d.ts

@@ -5,6 +5,7 @@ export { AttachmentCreateBodyRequest, AttachmentCreateBodyShipment, AttachmentCr
 export { EmailRuleCreateBody } from './endpoint/emailRules';
 export { EmailSubscriptionCreateBody } from './endpoint/emailSubscriptions';
 export { HostedSessionCreateBody } from './endpoint/hostedSessions';
+export { ImportCostEstimateCreateBody, ImportCostEstimateCreateBodyDirect, ImportCostEstimateCreateBodyFromQuote, } from './endpoint/importCostEstimates';
 export { KeyCreateBody } from './endpoint/keys';
 export * from './MetadataTypes';
 export { UploadCreateBody } from './endpoint/uploads';

package/dist/lib/types.d.ts

@@ -25,6 +25,8 @@ export type QuoteRequest = {
         missing: string[];
         ready: boolean;
     };
+    customs_end_use: "for_resale" | "not_for_resale";
+    customs_process: "ddu" | "ddp" | "ddp_optional";
     destination: {
         access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
         address_line_1?: (string | null) | undefined;
@@ -190,6 +192,8 @@ export type Shipment = {
     updated_at: Date;
     created_at: Date;
     id: string;
+    customs_end_use?: (("for_resale" | "not_for_resale") | null) | undefined;
+    customs_process?: (("ddu" | "ddp" | "ddp_optional") | null) | undefined;
     destination: {
         access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
         address_line_1?: (string | null) | undefined;
@@ -392,6 +396,8 @@ export type HostedSession = {
     id: number;
     additional_services?: (("assembly" | "debris_disposal" | "deinstallation" | "destination_additional_labor" | "destination_building_coi" | "destination_condition_check" | "destination_full_condition_report" | "destination_unpacking" | "double_blind_bols" | "installation" | "origin_building_coi" | "origin_condition_check" | "origin_full_condition_report" | "placement" | "signature_delivery" | "tarmac_supervision")[] | null) | undefined;
     cancel_url?: (string | null) | undefined;
+    customs_end_use: "for_resale" | "not_for_resale";
+    customs_process: "ddu" | "ddp" | "ddp_optional";
     destination?: ({
         access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
         address_line_1?: (string | null) | undefined;
@@ -494,6 +500,53 @@ export type HostedSession = {
     public_instructions_confirmation?: (string | null) | undefined;
     quoting_strategy: "all_rates" | "best_rate" | "compare_carriers";
 };
+export type ImportCostEstimate = {
+    updated_at: Date;
+    created_at: Date;
+    id: string;
+    currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
+    destination: {
+        city?: (string | null) | undefined;
+        country: string;
+        postal_code?: (string | null) | undefined;
+        region?: (string | null) | undefined;
+    };
+    end_use?: (string | null) | undefined;
+    origin: {
+        country: string;
+    };
+    quote_id?: (string | null) | undefined;
+    reference?: (string | null) | undefined;
+    shortcode: string;
+    status: "failed" | "success";
+    transport: {
+        service_level: string;
+        amount: string | number;
+        amount_currency?: (string | null) | undefined;
+    };
+    objects: {
+        value: string | number;
+        quantity?: (number | null) | undefined;
+        value_currency?: (("CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD") | null) | undefined;
+        hs_code: string;
+        reference?: (string | null) | undefined;
+        country_of_origin?: (string | null) | undefined;
+    }[];
+    estimate: {
+        line_items: {
+            description: string;
+            subtype: string;
+            type: string;
+            amount: string | number;
+        }[];
+        summary: {
+            ddp_service_fees: string | number;
+            fees: string | number;
+            duties: string | number;
+            taxes: string | number;
+        };
+    };
+};
 export type InvoicePayment = {
     updated_at: Date;
     created_at: Date;
@@ -864,6 +917,8 @@ export type QuoteRequestListItem = {
         missing: string[];
         ready: boolean;
     };
+    customs_end_use: "for_resale" | "not_for_resale";
+    customs_process: "ddu" | "ddp" | "ddp_optional";
     destination: {
         access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
         address_line_1?: (string | null) | undefined;
@@ -955,6 +1010,8 @@ export type InboundHostedSession = {
     id: number;
     additional_services?: (("assembly" | "debris_disposal" | "deinstallation" | "destination_additional_labor" | "destination_building_coi" | "destination_condition_check" | "destination_full_condition_report" | "destination_unpacking" | "double_blind_bols" | "installation" | "origin_building_coi" | "origin_condition_check" | "origin_full_condition_report" | "placement" | "signature_delivery" | "tarmac_supervision")[] | null) | undefined;
     cancel_url?: (string | null) | undefined;
+    customs_end_use: "for_resale" | "not_for_resale";
+    customs_process: "ddu" | "ddp" | "ddp_optional";
     destination: {
         access_restrictions?: (("elevator_only" | "freight_elevator" | "loading_dock" | "loading_dock_low" | "low_clearance" | "non_paved" | "stairs_only" | "steep_gradient")[] | null) | undefined;
         address_line_1?: (string | null) | undefined;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@artaio/node-api",
-    "version": "1.9.1",
+    "version": "1.11.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.9.1",
+  "version": "1.11.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",