@artaio/node-api 0.29.3 → 0.30.0

package/dist/lib/MetadataTypes.d.ts

@@ -16,6 +16,7 @@ export type ObjectSubType = 'painting_unframed' | 'painting_framed' | 'painting_
 export type ParcelTransportServices = 'economy' | 'economy_freight' | 'ground' | 'next_day_air' | 'priority' | 'priority_freight' | 'second_day_air' | 'standard';
 export type WebhookDeliveryType = 'request.created' | 'request.status.updated' | 'shipment.created' | 'shipment.eei_form_status.updated' | 'shipment.schedule.updated' | 'shipment.status.updated' | 'shipment.tracking.updated' | 'ping';
 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 ShipmentExceptionTypeId = 'change_of_address_request' | 'customs_information_required' | 'damaged_items' | 'direct_payment_required' | 'held_at_customs' | 'inaccurate_object_details' | 'incorrect_address' | 'lost_in_transit' | 'not_ready_for_delivery' | 'not_ready_for_release' | 'other' | 'prepayment_required' | 'requested_hold_to_collect' | 'requested_hold_to_deliver' | 'wrong_item';
 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';
 export type ArtaTrackingServiceSubSubType = 'armored_transport' | 'dedicated_transport' | 'specialized_shuttle' | 'road_groupage' | 'sea_groupage' | 'sea_freight' | 'ltl_freight' | 'ftl_freight' | 'air_freight' | 'cargo_air_freight' | 'parcel' | 'priority_freight' | 'economy_freight' | 'collection' | 'art_fair_collection' | 'residential_collection' | 'airport_collection' | 'port_collection' | 'dock_collection' | 'consolidated_collection' | 'failed_collection' | 'recollection' | 'delivery' | 'inside_delivery' | 'art_fair_delivery' | 'room_of_choice_delivery' | 'curbside_delivery' | 'residential_delivery' | 'signature_delivery' | 'saturday_delivery' | 'sunday_delivery' | 'scheduled_delivery' | 'after_hours_delivery' | 'airport_delivery' | 'port_delivery' | 'dock_delivery' | 'failed_delivery' | 'redelivery' | 'origin_additional_stops' | 'destination_additional_stops' | 'origin_off_route' | 'destination_off_route' | 'must_fly' | 'origin_unpacking_soft' | 'destination_unpacking_soft' | 'origin_unpacking_wood' | 'destination_unpacking_wood' | 'origin_unpacking' | 'destination_unpacking' | 'origin_full_condition_report' | 'destination_full_condition_report' | 'origin_condition_check' | 'destination_condition_check' | 'installation' | 'placement' | 'assembly' | 'deinstallation' | 'disassembly' | 'debris_disposal' | 'crate_disposal' | 'soft_packed_disposal' | 'origin_site_visit' | 'destination_site_visit' | 'origin_additional_labor' | 'destination_additional_labor' | 'airport_handling' | 'origin_oversized_handling' | 'destination_oversized_handling' | 'origin_additional_stairs' | 'destination_additional_stairs' | 'packing_labor' | 'crate_fabrication' | 't_frame_fabrication' | 'fabrication' | 'retrofitting' | 'additional_packing' | 'pack_into' | 'poly' | 'dartek' | 'bubble' | 'cling_wrap' | 'cbin_communal' | 'blanket' | 'portfolio' | 'poly_cardboard' | 'bubble_cardboard' | 'rug_rolled' | 'cbin_closed' | 'cbin_open' | 'garment_bag' | 'wardrobe_box' | 'cardboard_box' | 'chandelier_box' | 'chair_box' | 'slipcase' | 'glass_tape' | 'stabilizing_box' | 'shadow_box' | 'foam_lined_box' | 'cavity_box' | 'strongbox' | 'double_box' | 'shipping_tube_small' | 'shipping_tube_large' | 'sonotube' | 'alcohol_case' | 'lay_flat_wine_box' | 'lockbox' | 'travel_frame' | 'travel_frame_art' | 'travel_frame_other' | 'a_frame' | 'slat_crate' | 'tri_wall_crate' | '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' | 'pallet' | 'international_pallet' | 'warehouse_handling' | 'receive_in_fee' | 'release_fee' | 'storage' | 'temp_storage' | 'viewing_room' | 'staging' | 'import_customs_formalities' | 'export_customs_formalities' | 'origin_building_coi' | 'destination_building_coi' | 'double_blind_bols' | 'power_of_attorney' | 'administrative' | 'mpf' | 'bond' | 'duties' | 'taxes' | 'disbursement' | 'temporary_customs_entry' | 'fuel_surcharge' | 'tarmac_supervision' | 'courier_onboard' | 'fork_lift' | 'gantry' | 'pallet_jack' | 'scaffolding' | 'rigging' | 'lift_gate' | 'ramp' | 'floor_protection';

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

@@ -1,4 +1,4 @@
-import { AccessRestriction, APIStatus, ArtaTrackingServiceSubSubType, ArtaTrackingServiceSubType, ArtaTrackingServiceType, AuthTypes, EmailNotificationId, Insurance, ObjectMaterial, ObjectSubType, ObjectType, PackageStatus, PackingSubType, PackingType, ParcelTransportServices, PaymentProcessType, QuoteRequestStatus, QuoteType, Recipients, ShipmentStatus, SupportedCurrency } from '../MetadataTypes';
+import { AccessRestriction, APIStatus, ArtaTrackingServiceSubSubType, ArtaTrackingServiceSubType, ArtaTrackingServiceType, AuthTypes, EmailNotificationId, Insurance, ObjectMaterial, ObjectSubType, ObjectType, PackageStatus, PackingSubType, PackingType, ParcelTransportServices, PaymentProcessType, QuoteRequestStatus, QuoteType, Recipients, ShipmentExceptionTypeId, ShipmentStatus, SupportedCurrency } from '../MetadataTypes';
 import { RestClient } from '../net/RestClient';
 export interface APIVersionMetadata {
     authentication: AuthTypes[];
@@ -16,6 +16,11 @@ export interface EmailNotificationMetadata {
     optional_recipients: Recipients;
     id: EmailNotificationId;
 }
+export interface ShipmentExceptionTypeMetadata {
+    id: ShipmentExceptionTypeId;
+    name: string;
+    resolutions: string[];
+}
 export interface BaseMetadata<T> {
     description: string;
     id: T;
@@ -63,5 +68,6 @@ export declare class MetadataEndpoint {
     quotes(auth?: string): Promise<QuotesMetadata[]>;
     requestStatuses(auth?: string): Promise<RequestStatusesMetadata[]>;
     services(auth?: string): Promise<ServicesMetadata[]>;
+    shipmentExceptionTypes(auth?: string): Promise<ShipmentExceptionTypeMetadata[]>;
     shipmentStatuses(auth?: string): Promise<ShipmentStatusesMetadata[]>;
 }

package/dist/lib/endpoint/metadata.js

@@ -48,6 +48,9 @@ var MetadataEndpoint = /** @class */ (function () {
     MetadataEndpoint.prototype.services = function (auth) {
         return this.artaClient.get("".concat(this.path, "/services"), auth);
     };
+    MetadataEndpoint.prototype.shipmentExceptionTypes = function (auth) {
+        return this.artaClient.get("".concat(this.path, "/shipment_exception_types"), auth);
+    };
     MetadataEndpoint.prototype.shipmentStatuses = function (auth) {
         return this.artaClient.get("".concat(this.path, "/shipment_statuses"), auth);
     };

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

@@ -1,5 +1,5 @@
 import { ArtaID } from '../ArtaClient';
-import { ArtaLocation, ArtaObject, ArtaService, EEIFormStatus, InsurancePolicy, PackageStatus, PackingSubType, PaymentProcessType, QuoteType, ShipmentStatus, SupportedCurrency } from '../MetadataTypes';
+import { ArtaLocation, ArtaObject, ArtaService, EEIFormStatus, InsurancePolicy, PackageStatus, PackingSubType, PaymentProcessType, QuoteType, ShipmentStatus, ShipmentExceptionTypeId, SupportedCurrency } from '../MetadataTypes';
 import { RestClient } from '../net/RestClient';
 import { Page } from '../pagination';
 import { ShipmentsSearch } from '../search';
@@ -19,6 +19,15 @@ export interface Package {
     weight_unit: string;
     width: number;
 }
+export type ShipmentExceptionStatus = 'in_progress' | 'new' | 'resolved';
+export interface ShipmentException extends DatedInterface {
+    exception_type_label: NullableString;
+    id: ArtaID;
+    package_id: Nullable<number>;
+    resolution: NullableString;
+    status: ShipmentExceptionStatus;
+    type: ShipmentExceptionTypeId;
+}
 export interface ShipmentSchedule {
     delivery_end: Nullable<Date>;
     delivery_start: Nullable<Date>;
@@ -38,6 +47,9 @@ export interface Shipment extends DatedInterface {
     id: ArtaID;
     destination: ArtaLocation;
     eei_form_status?: Nullable<EEIFormStatus>;
+    emissions?: Nullable<number>;
+    emissions_unit?: NullableString;
+    exceptions?: Nullable<ShipmentException[]>;
     hosted_session_id?: Nullable<number>;
     insurance_policy?: Nullable<InsurancePolicy>;
     internal_reference?: NullableString;

package/dist/lib/endpoint/shipments.js

@@ -11,6 +11,9 @@ var ShipmentsEndpoint = /** @class */ (function () {
     }
     ShipmentsEndpoint.prototype.enrichFields = function (r) {
         r.total = Number(r.total);
+        if (r.emissions) {
+            r.emissions = Number(r.emissions);
+        }
         if (r.schedule) {
             r.schedule.delivery_end = new Date(r.schedule.delivery_end);
             r.schedule.delivery_start = new Date(r.schedule.delivery_start);

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@artaio/node-api",
-    "version": "0.29.3",
+    "version": "0.30.0",
     "description": "The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.",
     "scripts": {
         "build": "tsc -p tsconfig-build.json",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artaio/node-api",
-  "version": "0.29.3",
+  "version": "0.30.0",
   "description": "The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.",
   "scripts": {
     "build": "tsc -p tsconfig-build.json",