@artaio/node-api 1.3.0 → 1.4.0

package/dist/lib/MetadataTypes.d.ts

@@ -6,7 +6,6 @@ export type PackingType = 'alcohol_case' | 'blanket' | 'box' | 'cbin_closed' | '
 export type PackingSubType = 'alcohol_case' | 'lay_flat_wine_box' | 'blanket' | 'wardrobe_box' | 'cardboard_box' | 'chandelier_box' | 'chair_box' | 'cbin_closed' | 'cbin_open' | 'ply_box' | 'fine_art_econo_crate' | 'fine_art_international_crate' | 'econo_crate' | 'international_econo_crate' | 'furniture_crate' | 'international_furniture_crate' | 'parcel_crate' | 'museum_crate' | 'international_museum_crate' | 'foam_lined_box' | 'cavity_box' | 'strongbox' | 'double_box' | 'travel_frame' | 'travel_frame_art' | 'travel_frame_other' | 'a_frame' | 'slat_crate' | 'tri_wall_crate' | 'lockbox' | 'no_packing' | 'pallet' | 'international_pallet' | 'portfolio' | 'rug_rolled' | 'shadow_box' | 'slipcase' | 'slipcase_glass_tape' | 'poly_cardboard' | 'bubble_cardboard' | 'garment_bag' | 'poly_only' | 'dartek_only' | 'bubble_only' | 'cling_wrap' | 'cbin_communal' | 'sonotube' | 'stabilizing_box' | 'shipping_tube_small' | 'shipping_tube_large';
 export type ObjectType = 'art' | 'furniture' | 'jewelry' | 'decorative_arts' | 'collectibles' | 'alcohol' | 'automotive' | 'fashion' | 'other';
 export type ObjectSubType = 'painting_unframed' | 'painting_framed' | 'painting_framed_plexi' | 'painting_framed_glass' | 'work_on_paper_unframed' | 'work_on_paper_framed' | 'work_on_paper_framed_plexi' | 'work_on_paper_framed_glass' | 'mixed_media_unframed' | 'mixed_media_framed' | 'mixed_media_framed_plexi' | 'mixed_media_framed_glass' | 'photograph_unframed' | 'photograph_framed' | 'photograph_framed_plexi' | 'photograph_framed_glass' | 'new_media' | 'sculpture' | 'pedestal' | 'pedestal_case_glass' | 'pedestal_case_plexi' | 'ceramic' | 'neon' | 'tapestry' | 'other_art' | 'table' | 'chair' | 'sofa_loveseat_chaise' | 'floor_lamp' | 'floor_lamp_shade' | 'table_lamp' | 'table_lamp_shade' | 'sconce' | 'ottoman' | 'bookcase_storage' | 'nightstand' | 'armoire_dresser' | 'carpet_rug' | 'mirror' | 'chandelier' | 'bedframe' | 'headboard' | 'desk_vanity' | 'media_console' | 'other_furniture' | 'earrings' | 'necklace' | 'bracelet' | 'ring' | 'brooch' | 'watch' | 'cufflinks' | 'eyeglasses' | 'set' | 'precious_stones' | 'snuff_box_cigarette_case' | 'other_jewelry' | 'vase_vessel' | 'bowl' | 'plaque' | 'object_of_vertu' | 'candelabra_candlestick' | 'dinnerware' | 'flatware' | 'glassware' | 'serveware' | 'porcelain_plate' | 'porcelain_bowl' | 'tabletop_accessory' | 'clock' | 'other_decorative_arts' | 'stamp' | 'book' | 'coin' | 'document_manuscript' | 'toy' | 'miniature_model' | 'figurine_doll' | 'neon_sign' | 'memorabilia' | 'camera_electrical' | 'other_collectibles' | 'wine_bottle' | 'spirits_bottle' | 'beer_bottle' | 'wine_case' | 'spirits_case' | 'beer_case' | 'wine_barrel' | 'spirits_barrel' | 'beer_barrel' | 'other_alcohols' | 'car' | 'motorcycle' | 'bus' | 'van' | 'limousine' | 'carriage' | 'trailer' | 'sidecar' | 'other_automotive' | 'clothing' | 'footwear' | 'handbag' | 'accessories' | 'other_fashion' | 'musical_instrument' | 'firearm_weapon' | 'hunting_fishing' | 'medical_equipment' | 'other';
-export type ParcelTransportServices = 'economy' | 'economy_freight' | 'ground' | 'next_day_air' | 'priority' | 'priority_freight' | 'second_day_air' | 'standard';
 export type ObjectMaterial = 'stone_marble' | 'precious_stones' | 'fiber_synthetic' | 'fabric_natural' | 'taxidermy' | 'carbon_fiber' | 'live_animal' | 'paper' | 'glass' | 'presious_metals' | 'particleboard' | 'styrofoam' | 'wood' | 'photo_film' | 'sand' | 'metal' | 'plexiglass' | 'aquatic_life' | 'canvas' | 'drywall' | 'hard_plastic' | 'vinyl' | 'soft_plastic' | 'leather' | 'rubber' | 'concreate' | 'paint' | 'electronics' | 'fiber_natural' | 'gas' | 'fabric_synthetic' | 'CITES' | 'liquids' | 'salts';
 export type ArtaTrackingServiceType = 'transport' | 'location' | 'handling' | 'packing' | 'storage' | 'administration' | 'taxes_duties_fees' | 'security' | 'equipment';
 export type ArtaTrackingServiceSubType = 'specialized' | 'consolidated' | 'freight' | 'parcel' | 'collection' | 'delivery' | 'location' | 'unpacking' | 'condition' | 'installation' | 'deinstallation' | 'debris_disposal' | 'site_visit' | 'handling' | 'packing' | 'packing_materials' | 'receive_release' | 'warehouse' | 'customs' | 'coi' | 'administration' | 'taxes_duties' | 'fees' | 'security' | 'equipment';

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

@@ -1,7 +1,7 @@
 import type { ArtaID } from '../ArtaClient';
 import type { RestClient } from '../net/RestClient';
 import type { Page } from '../pagination';
-import type { AdditionalService, ArtaLocation, ArtaObject, HostedSession, Insurance, QuoteType } from '../MetadataTypes';
+import type { AdditionalService, ArtaLocation, ArtaObject, HostedSession, Insurance, ParcelTransportServices, QuoteType } from '../MetadataTypes';
 import { type Nullable, type NullableString } from '../utils';
 import type { HostedSessionsSearch } from '../search';
 export type EnrichedHostedSession = HostedSession & {
@@ -16,6 +16,7 @@ export interface HostedSessionCreateBody {
     objects: ArtaObject[];
     origin: ArtaLocation;
     preferred_quote_types?: Nullable<QuoteType[]>;
+    preferred_parcel_transport_services?: Nullable<ParcelTransportServices[]>;
     public_reference?: NullableString;
     shipping_notes?: NullableString;
     success_url?: NullableString;

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

@@ -1,4 +1,4 @@
-import type { AccessRestriction, APIStatus, ArtaTrackingServiceSubSubType, ArtaTrackingServiceSubType, ArtaTrackingServiceType, AuthTypes, EmailNotificationId, Insurance, ObjectMaterial, ObjectSubType, ObjectType, PackageStatus, PackingSubType, PackingType, ParcelTransportServices, PaymentProcessType, QuoteRequestStatus, QuoteType, Recipient, ShipmentExceptionTypeId, ShipmentStatus, SupportedCurrency } from '../MetadataTypes';
+import type { AccessRestriction, APIStatus, ArtaTrackingServiceSubSubType, ArtaTrackingServiceSubType, ArtaTrackingServiceType, AuthTypes, EmailNotificationId, Insurance, ObjectMaterial, ObjectSubType, ObjectType, PackageStatus, PackingSubType, PackingType, ParcelTransportServices, PaymentProcessType, QuoteRequestStatus, QuoteType, QuotingStrategy, Recipient, ShipmentExceptionTypeId, ShipmentStatus, SupportedCurrency } from '../MetadataTypes';
 import type { RestClient } from '../net/RestClient';
 export interface APIVersionMetadata {
     authentication: AuthTypes[];
@@ -26,9 +26,11 @@ export interface BaseMetadata<T> {
     id: T;
     name: string;
 }
+type GenericMetadata = Pick<BaseMetadata<string>, 'id' | 'name'>;
 export type InsurancesMetadata = BaseMetadata<Insurance>;
 export type LocationAccessRestrictionMetadata = BaseMetadata<AccessRestriction>;
 export type ObjectMaterialsMetadata = BaseMetadata<ObjectMaterial>;
+export type QuotingStrategyMetadata = BaseMetadata<QuotingStrategy>;
 export interface ObjectMetadata extends BaseMetadata<ObjectType> {
     subtypes: BaseMetadata<ObjectSubType>[];
 }
@@ -66,8 +68,12 @@ export declare class MetadataEndpoint {
     parcelTransportServices(auth?: string): Promise<ParcelTransportServicesMetadata[]>;
     paymentProcessTypes(auth?: string): Promise<PaymentProcessTypeMetadata[]>;
     quotes(auth?: string): Promise<QuotesMetadata[]>;
+    quotingStrategies(auth?: string): Promise<QuotingStrategyMetadata[]>;
+    referenceRateProviders(auth?: string): Promise<GenericMetadata[]>;
+    referenceRateServiceLevels(auth?: string): Promise<GenericMetadata[]>;
     requestStatuses(auth?: string): Promise<RequestStatusesMetadata[]>;
     services(auth?: string): Promise<ServicesMetadata[]>;
     shipmentExceptionTypes(auth?: string): Promise<ShipmentExceptionTypeMetadata[]>;
     shipmentStatuses(auth?: string): Promise<ShipmentStatusesMetadata[]>;
 }
+export {};

package/dist/lib/endpoint/metadata.js

@@ -42,6 +42,15 @@ var MetadataEndpoint = /** @class */ (function () {
     MetadataEndpoint.prototype.quotes = function (auth) {
         return this.artaClient.get("".concat(this.path, "/quotes"), auth);
     };
+    MetadataEndpoint.prototype.quotingStrategies = function (auth) {
+        return this.artaClient.get("".concat(this.path, "/quoting_strategies"), auth);
+    };
+    MetadataEndpoint.prototype.referenceRateProviders = function (auth) {
+        return this.artaClient.get("".concat(this.path, "/reference_rate_providers"), auth);
+    };
+    MetadataEndpoint.prototype.referenceRateServiceLevels = function (auth) {
+        return this.artaClient.get("".concat(this.path, "/reference_rate_service_levels"), auth);
+    };
     MetadataEndpoint.prototype.requestStatuses = function (auth) {
         return this.artaClient.get("".concat(this.path, "/request_statuses"), auth);
     };

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

@@ -1,8 +1,7 @@
-import type { AdditionalService, ArtaLocation, ArtaObject, Contact, Insurance, QuoteType, SupportedCurrency } from '../types';
+import type { AdditionalService, ArtaLocation, ArtaObject, Contact, Insurance, ParcelTransportServices, QuoteRequest, QuoteRequestListItem, QuoteType, QuotingStrategy, SupportedCurrency } from '../types';
 import type { RestClient } from '../net/RestClient';
 import type { Page } from '../pagination';
 import type { RequestsSearch } from '../search';
-import type { QuoteRequest, QuoteRequestListItem } from '../types';
 import type { Nullable, NullableString } from '../utils';
 export type EnrichRequest<T> = T & {
     updateContacts: (contacts: UpdateRequestsContactsBody, auth?: string) => Promise<T>;
@@ -17,7 +16,9 @@ export interface QuoteRequestCreateBody {
     internal_reference?: NullableString;
     objects: ArtaObject[];
     origin: ArtaLocation;
+    preferred_parcel_transport_services?: Nullable<ParcelTransportServices[]>;
     preferred_quote_types?: Nullable<QuoteType[]>;
+    quoting_strategy?: QuotingStrategy;
     public_reference?: NullableString;
     shipping_notes?: NullableString;
 }

package/dist/lib/types.d.ts

@@ -70,6 +70,7 @@ export type QuoteRequest = {
     };
     public_reference?: (string | null) | undefined;
     quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
+    quoting_strategy: "best_rate" | "compare_carriers";
     shortcode: string;
     status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
     tags: {
@@ -116,6 +117,7 @@ export type QuoteRequest = {
     }[];
     payment_process: "checkout" | "checkout_direct" | "invoicing";
     preferred_quote_types?: (("parcel" | "premium" | "select" | "self_ship")[] | null) | undefined;
+    preferred_parcel_transport_services?: (("economy" | "economy_freight" | "ground" | "next_day_air" | "priority" | "priority_freight" | "second_day_air" | "standard")[] | null) | undefined;
     shipping_notes?: (string | null) | undefined;
     quotes: {
         id: number;
@@ -129,6 +131,9 @@ export type QuoteRequest = {
             subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
             type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
             included_services: any[];
+            metadata: {
+                [x: string]: unknown;
+            };
         }[];
         included_insurance_policy?: ({
             amount: number;
@@ -289,6 +294,9 @@ export type Shipment = {
         subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
         type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
         included_services: any[];
+        metadata: {
+            [x: string]: unknown;
+        };
     }[] | null) | undefined;
     shipping_notes?: (string | null) | undefined;
     shortcode: string;
@@ -310,6 +318,16 @@ export type Shipment = {
     tracking?: ({
         carrier_name: string;
         label_url?: (string | null) | undefined;
+        label_format_urls: {
+            pdf_4_x_6?: (string | null) | undefined;
+            pdf_a4?: (string | null) | undefined;
+            pdf_a4_half_page?: (string | null) | undefined;
+            pdf_letter?: (string | null) | undefined;
+            pdf_letter_half_page?: (string | null) | undefined;
+            png_4_x_6?: (string | null) | undefined;
+            zpl_12dpmm?: (string | null) | undefined;
+            zpl_8dpmm?: (string | null) | undefined;
+        } | null;
         package_id: number;
         tracking_number: string;
         url: string;
@@ -400,6 +418,7 @@ export type HostedSession = {
         estimated_region?: string | undefined;
         estimated_city?: string | undefined;
     };
+    preferred_parcel_transport_services?: (("economy" | "economy_freight" | "ground" | "next_day_air" | "priority" | "priority_freight" | "second_day_air" | "standard")[] | null) | undefined;
     preferred_quote_types?: (("parcel" | "premium" | "select" | "self_ship")[] | null) | undefined;
     public_reference?: (string | null) | undefined;
     shipping_notes?: (string | null) | undefined;
@@ -673,6 +692,16 @@ export type ShipmentSchedule = {
 export type ShipmentTracking = {
     carrier_name: string;
     label_url?: (string | null) | undefined;
+    label_format_urls: {
+        pdf_4_x_6?: (string | null) | undefined;
+        pdf_a4?: (string | null) | undefined;
+        pdf_a4_half_page?: (string | null) | undefined;
+        pdf_letter?: (string | null) | undefined;
+        pdf_letter_half_page?: (string | null) | undefined;
+        png_4_x_6?: (string | null) | undefined;
+        zpl_12dpmm?: (string | null) | undefined;
+        zpl_8dpmm?: (string | null) | undefined;
+    } | null;
     package_id: number;
     tracking_number: string;
     url: string;
@@ -696,6 +725,9 @@ export type Quote = {
         subtype: "specialized" | "consolidated" | "freight" | "parcel" | "collection" | "delivery" | "location" | "unpacking" | "condition" | "installation" | "deinstallation" | "debris_disposal" | "site_visit" | "handling" | "packing" | "packing_materials" | "receive_release" | "warehouse" | "customs" | "coi" | "administration" | "taxes_duties" | "fees" | "security" | "equipment";
         type: "transport" | "location" | "handling" | "packing" | "storage" | "administration" | "taxes_duties_fees" | "security" | "equipment";
         included_services: any[];
+        metadata: {
+            [x: string]: unknown;
+        };
     }[];
     included_insurance_policy?: ({
         amount: number;
@@ -720,6 +752,7 @@ export type Quote = {
     total: number;
     total_currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
 };
+export type QuotingStrategy = "best_rate" | "compare_carriers";
 export type QuoteRequestListItem = {
     updated_at: Date;
     created_at: Date;
@@ -773,6 +806,7 @@ export type QuoteRequestListItem = {
     };
     public_reference?: (string | null) | undefined;
     quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
+    quoting_strategy: "best_rate" | "compare_carriers";
     shortcode: string;
     status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
     tags: {
@@ -791,3 +825,4 @@ export type EmailNotificationId = "booking" | "cancelled" | "collected" | "colle
 export type Recipient = "payer" | "origin" | "destination";
 export type ArtaMimeType = "application/pdf" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "image/jpeg" | "image/png" | "text/csv" | "video/mp4" | "video/quicktime" | "application/msword";
 export type ArtaDocumentType = "bill_of_lading" | "certificate_of_insurance" | "certificate_of_insurance_template" | "condition_report" | "condition_check" | "image" | "instructions" | "airway_bill" | "commercial_invoice" | "power_of_attorney" | "proof_of_export" | "proof_of_delivery" | "quote" | "shipping_label" | "other";
+export type ParcelTransportServices = "economy" | "economy_freight" | "ground" | "next_day_air" | "priority" | "priority_freight" | "second_day_air" | "standard";

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@artaio/node-api",
-    "version": "1.3.0",
+    "version": "1.4.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",
@@ -47,7 +47,7 @@
         "eslint-plugin-promise": "^6.1.1",
         "husky": "^9.0.11",
         "jest": "^29.7.0",
-        "nock": "^14.0.0-beta.5",
+        "nock": "^14.0.1",
         "pinst": "^3.0.0",
         "prettier": "3.0.3",
         "ts-jest": "^29.1.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artaio/node-api",
-  "version": "1.3.0",
+  "version": "1.4.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",
@@ -47,7 +47,7 @@
     "eslint-plugin-promise": "^6.1.1",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "nock": "^14.0.0-beta.5",
+    "nock": "^14.0.1",
     "pinst": "^3.0.0",
     "prettier": "3.0.3",
     "ts-jest": "^29.1.1",