@artaio/node-api 0.31.0 → 0.32.0

package/README.md

@@ -5,7 +5,9 @@ arta-node-api is in a pre-release beta. The package's API is unstable and expect
 Arta Node.js Library
 ===
 
-The Arta Node library provides a seamless integration to Arta API for applications running on Node.js using both Typescript or Javascript.
+The Arta Node library provides a seamless integration to Arta API for applications running on Node.js 18+ or any platform using [Serverless JS](https://www.cloudflare.com/learning/serverless/serverless-javascript/) using both Typescript or Javascript.
+
+It is a very light package with zero runtime dependencies using only the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) Web API.
 
 ## Documentation
 

package/dist/lib/ArtaClient.js

@@ -54,7 +54,10 @@ var ArtaClient = /** @class */ (function () {
                     case 0:
                         authValue = this.makeArtaAuthHeader(this.config.apiKey);
                         if (params.headers == null) {
-                            params.headers = {};
+                            params.headers = {
+                                'Content-Type': 'application/json',
+                                'User-Agent': "ARTA/v1 arta-node/".concat(package_json_1.version),
+                            };
                         }
                         if (params.headers.Authorization == null) {
                             params.headers.Authorization = authValue;
@@ -83,11 +86,15 @@ var ArtaClient = /** @class */ (function () {
             method: method,
             headers: {
                 'User-Agent': "ARTA/v1 arta-node/".concat(package_json_1.version),
+                'Content-Type': 'application/json'
             },
         };
         if (auth) {
             if (reqParams.headers == null) {
-                reqParams.headers = {};
+                reqParams.headers = {
+                    'User-Agent': "ARTA/v1 arta-node/".concat(package_json_1.version),
+                    'Content-Type': 'application/json'
+                };
             }
             reqParams.headers.Authorization = this.makeArtaAuthHeader(auth);
         }
@@ -105,7 +112,7 @@ var ArtaClient = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        reqParams = this.makeReqParams(path, 'get', auth);
+                        reqParams = this.makeReqParams(path, 'GET', auth);
                         return [4 /*yield*/, this.request(reqParams)];
                     case 1:
                         res = _a.sent();
@@ -120,7 +127,7 @@ var ArtaClient = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        reqParams = this.makeReqParams(path, 'post', auth, JSON.stringify(payload));
+                        reqParams = this.makeReqParams(path, 'POST', auth, JSON.stringify(payload));
                         return [4 /*yield*/, this.request(reqParams)];
                     case 1:
                         res = _a.sent();
@@ -135,7 +142,7 @@ var ArtaClient = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        reqParams = this.makeReqParams(path, 'patch', auth, JSON.stringify(payload));
+                        reqParams = this.makeReqParams(path, 'PATCH', auth, JSON.stringify(payload));
                         return [4 /*yield*/, this.request(reqParams)];
                     case 1:
                         res = _a.sent();
@@ -148,7 +155,7 @@ var ArtaClient = /** @class */ (function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.request(this.makeReqParams(path, 'delete', auth))];
+                    case 0: return [4 /*yield*/, this.request(this.makeReqParams(path, 'DELETE', auth))];
                     case 1:
                         _a.sent();
                         return [2 /*return*/, Promise.resolve()];

package/dist/lib/MetadataTypes.d.ts

@@ -1,110 +1,18 @@
-import { Nullable, NullableString } from './utils';
-export type AdditionalService = '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';
+export * from './types';
 export type AccessRestriction = 'elevator_only' | 'freight_elevator' | 'loading_dock' | 'loading_dock_low' | 'low_clearance' | 'non_paved' | 'stairs_only' | 'steep_gradient';
-export type Insurance = 'arta_transit_insurance' | 'no_arta_insurance';
 export type PaymentProcessType = 'checkout' | 'checkout_direct' | 'invoicing';
-export type QuoteType = 'parcel' | 'premium' | 'select' | 'self_ship';
 export type QuoteRequestStatus = 'cancelled' | 'closed' | 'disqualified' | 'expired' | 'in_progress' | 'pending' | 'quoted';
-export type EmailNotificationId = 'booking' | 'cancelled' | 'collected' | 'collection' | 'complete' | 'custom_quoted_dashboard' | 'in_transit' | 'invoice' | 'self_ship_label' | 'payment' | 'scheduling' | 'eei';
-export type Recipients = 'payer' | 'origin' | 'destination';
-export type MimeType = '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 DocumentType = '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 PackingType = 'alcohol_case' | 'blanket' | 'box' | 'cbin_closed' | 'cbin_open' | 'crate' | 'foam_lined_box' | 'frame' | 'lockbox' | 'no_packing' | 'pallet' | 'portfolio' | 'rug_roll' | 'shadow_box' | 'slipcase' | 'soft_packing' | 'soft_wrap' | 'sonotube' | 'stabilizing_box' | 'tube';
 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 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';
-export type DisqualificationReasonCode = 'external_service_unavailable' | 'client_timeout_reached';
-export type PackageStatus = 'pending' | 'transit' | 'out_for_delivery' | 'delivered' | 'unknown' | 'notfound' | 'undelivered' | 'exception' | 'expired';
 export type EEIFormStatus = 'pending' | 'cleared' | 'approved' | 'rejected' | 'submitted';
 export type ShipmentStatus = 'pending' | 'confirmed' | 'collected' | 'in_transit' | 'completed';
-export type WebhookResourceType = 'ping' | 'request' | 'shipment';
-export type WebhookDeliveryStatus = 'delivered' | 'failed';
 export type PaymentContext = 'hosted_checkout' | 'invoiced';
-export type SupportedCurrency = 'CAD' | 'EUR' | 'GBP' | 'HKD' | 'USD';
 export type AuthTypes = 'api_key';
 export type APIStatus = 'active' | 'beta' | 'deprecated';
-export interface Contact {
-    name: string;
-    email_address?: NullableString;
-    phone_number?: NullableString;
-}
-export interface ArtaLocation {
-    access_restrictions?: Nullable<AccessRestriction[]>;
-    address_line_1?: NullableString;
-    address_line_2?: NullableString;
-    address_line_3?: NullableString;
-    city?: NullableString;
-    region?: NullableString;
-    postal_code?: NullableString;
-    country: string;
-    title?: NullableString;
-    contacts?: Nullable<Contact[]>;
-    estimated_country?: string;
-    estimated_region?: string;
-    estimated_city?: string;
-}
-export type Details = {
-    materials?: Nullable<ObjectMaterial[]>;
-    creation_date?: NullableString;
-    creator?: NullableString;
-    notes?: NullableString;
-    title?: NullableString;
-    is_fragile?: Nullable<boolean>;
-    is_cites?: Nullable<boolean>;
-};
-export interface ArtaObject {
-    internal_reference?: NullableString;
-    current_packing?: Nullable<PackingSubType[]>;
-    details?: Nullable<Details>;
-    height: number | string;
-    width: number | string;
-    weight?: Nullable<number | string>;
-    value: number | string;
-    depth?: Nullable<number | string>;
-    images?: Nullable<string[]>;
-    public_reference?: string;
-    subtype: ObjectSubType;
-    unit_of_measurement?: NullableString;
-    weight_unit?: NullableString;
-    value_currency: SupportedCurrency;
-}
-export interface Disqualification {
-    quote_types: QuoteType[];
-    reason?: NullableString;
-    reason_code: DisqualificationReasonCode;
-}
-export interface InsurancePolicy {
-    amount: number;
-    amount_currency: SupportedCurrency;
-    id: string;
-    insured_value: number;
-    insured_value_currency: SupportedCurrency;
-}
-export interface ArtaService {
-    amount: number;
-    amount_currency: SupportedCurrency;
-    included_services: ArtaService[];
-    is_requested: boolean;
-    is_required: boolean;
-    name: string;
-    sub_subtype: ArtaTrackingServiceSubSubType;
-    subtype: ArtaTrackingServiceSubType;
-    type: ArtaTrackingServiceType;
-}
-export interface Quote {
-    id: number;
-    included_services: ArtaService[];
-    included_insurance_policy?: Nullable<InsurancePolicy>;
-    optional_services: ArtaService[];
-    quote_type: QuoteType;
-    status: string;
-    total: number;
-    total_currency: SupportedCurrency;
-}

package/dist/lib/MetadataTypes.js

@@ -1,2 +1,17 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/lib/arta.d.ts

@@ -1,4 +1,4 @@
-import { Logger, LoggerVerbosity } from './logging';
+import type { Logger, LoggerVerbosity } from './logging';
 import { AttachmentsEndpoint } from './endpoint/attachment';
 import { EmailRulesEndpoint } from './endpoint/emailRules';
 import { EmailSubscriptionsEndpoint } from './endpoint/emailSubscriptions';

package/dist/lib/arta.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Arta = void 0;
 var ArtaClient_1 = require("./ArtaClient");
 var logging_1 = require("./logging");
-var NodeHttpClient_1 = require("./net/NodeHttpClient");
+var FetchHttpClient_1 = require("./net/FetchHttpClient");
 var attachment_1 = require("./endpoint/attachment");
 var emailRules_1 = require("./endpoint/emailRules");
 var emailSubscriptions_1 = require("./endpoint/emailSubscriptions");
@@ -30,7 +30,7 @@ var Arta = /** @class */ (function () {
     function Arta(apiKey, config) {
         this.config = Object.assign(defaultConfig, config);
         (0, logging_1.initLogger)(this.config.logger, this.config.verbosity);
-        this.artaClient = new ArtaClient_1.ArtaClient(new NodeHttpClient_1.NodeHttpClient(), {
+        this.artaClient = new ArtaClient_1.ArtaClient(new FetchHttpClient_1.FetchHttpClient(), {
             apiKey: apiKey,
             host: this.config.host,
         });

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

@@ -1,13 +1,7 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { DatedInterface, NullableString } from '../utils';
-import { Page } from '../pagination';
-export interface Attachment extends DatedInterface {
-    id: ArtaID;
-    upload_id: number;
-    request_id?: NullableString;
-    shipment_id?: NullableString;
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { Attachment } from '../types';
 export interface AttachmentCreateBodyRequest {
     upload_id: number;
     request_id: string;

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

@@ -1,16 +1,10 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { DatedInterface } from '../utils';
-import { Page } from '../pagination';
-import { EmailNotificationId, Recipients } from '../MetadataTypes';
-export interface EmailRule extends DatedInterface {
-    id: ArtaID;
-    email_notification_id: EmailNotificationId;
-    recipients: Recipients[];
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { EmailNotificationId, EmailRule, Recipient } from '../types';
 export interface EmailRuleCreateBody {
     email_notification_id: EmailNotificationId;
-    recipients: Recipients[];
+    recipients: Recipient[];
 }
 export interface EmailRuleCreate {
     email_rule: EmailRuleCreateBody;
@@ -23,7 +17,7 @@ export declare class EmailRulesEndpoint {
     getById(id: ArtaID, auth?: string): Promise<EmailRule>;
     list(page?: number, pageSize?: number, auth?: string): Promise<Page<EmailRule>>;
     update(id: ArtaID, payload: {
-        recipients: Recipients[];
+        recipients: Recipient[];
     }, auth?: string): Promise<EmailRule>;
     create(payload: EmailRuleCreateBody, auth?: string): Promise<EmailRule>;
     remove(id: ArtaID, auth?: string): Promise<void>;

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

@@ -1,16 +1,10 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { DatedInterface, NullableString } from '../utils';
-import { Page } from '../pagination';
-import { EmailNotificationId } from '../MetadataTypes';
-export interface EmailSubscription extends DatedInterface {
-    id: ArtaID;
-    email_notification_ids: EmailNotificationId;
-    email_address: string;
-    name?: NullableString;
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { NullableString } from '../utils';
+import type { Page } from '../pagination';
+import type { EmailNotificationId, EmailSubscription } from '../types';
 export interface EmailSubscriptionCreateBody {
-    email_notification_ids: EmailNotificationId;
+    email_notification_ids: EmailNotificationId[];
     email_address: string;
     name?: NullableString;
 }

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

@@ -1,8 +1,8 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { DatedInterface } from '../utils';
-import { Page } from '../pagination';
-import { QueryParameters } from '../queryParams';
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { DatedInterface } from '../utils';
+import type { Page } from '../pagination';
+import type { QueryParameters } from '../queryParams';
 export interface Endpoint<T, U> {
     list: (queryParam?: QueryParameters, auth?: string) => Promise<Page<T>>;
     listAll: (auth?: string, onReturn?: (params: any) => T) => AsyncGenerator<T>;

package/dist/lib/endpoint/endpoint.js

@@ -39,8 +39,9 @@ var __await = (this && this.__await) || function (v) { return this instanceof __
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
-    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
     function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
     function fulfill(value) { resume("next", value); }

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

@@ -1,29 +1,12 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { Page } from '../pagination';
-import { AdditionalService, ArtaLocation, ArtaObject, Insurance, PaymentProcessType, QuoteType, QuoteRequestStatus } from '../MetadataTypes';
-import { type DatedInterface, type Nullable, type NullableString } from '../utils';
-import { HostedSessionsSearch } from '../search';
-export interface HostedSession extends DatedInterface {
-    id: ArtaID;
-    additional_services?: Nullable<AdditionalService[]>;
-    cancel_url?: NullableString;
-    destination?: Nullable<ArtaLocation>;
-    insurance?: Nullable<Insurance>;
-    internal_reference?: NullableString;
-    objects: ArtaObject[];
-    origin: ArtaLocation;
-    preferred_quote_types?: Nullable<QuoteType[]>;
-    public_reference?: NullableString;
-    shipping_notes?: NullableString;
-    success_url?: NullableString;
-    payment_process: PaymentProcessType;
-    private_token: string;
-    shortcode: string;
-    status: QuoteRequestStatus;
-    url?: NullableString;
+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 Nullable, type NullableString } from '../utils';
+import type { HostedSessionsSearch } from '../search';
+export type EnrichedHostedSession = HostedSession & {
     cancel: (auth?: string) => Promise<HostedSession>;
-}
+};
 export interface HostedSessionCreateBody {
     additional_services?: Nullable<AdditionalService[]>;
     cancel_url?: NullableString;
@@ -46,8 +29,8 @@ export declare class HostedSessionsEndpoint {
     private readonly path;
     constructor(artaClient: RestClient);
     private withFunctionCalls;
-    getById(id: ArtaID, auth?: string): Promise<HostedSession>;
-    list(search?: HostedSessionsSearch, page?: number, pageSize?: number, auth?: string): Promise<Page<HostedSession>>;
-    create(payload: HostedSessionCreateBody, auth?: string): Promise<HostedSession>;
-    cancel(id: ArtaID, auth?: string): Promise<HostedSession>;
+    getById(id: ArtaID, auth?: string): Promise<EnrichedHostedSession>;
+    list(search?: HostedSessionsSearch, page?: number, pageSize?: number, auth?: string): Promise<Page<EnrichedHostedSession>>;
+    create(payload: HostedSessionCreateBody, auth?: string): Promise<EnrichedHostedSession>;
+    cancel(id: ArtaID, auth?: string): Promise<EnrichedHostedSession>;
 }

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

@@ -1,18 +1,7 @@
-import { ArtaID } from '../ArtaClient';
-import { SupportedCurrency } from '../MetadataTypes';
-import { RestClient } from '../net/RestClient';
-import { Page } from '../pagination';
-import { DatedInterface, NullableString } from '../utils';
-export interface InvoicePayment extends DatedInterface {
-    id: ArtaID;
-    amount: number;
-    amount_currency: SupportedCurrency;
-    credit_id: NullableString;
-    invoice_id: NullableString;
-    paid_on: Date;
-    payment_id?: NullableString;
-    shipment_id?: NullableString;
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { InvoicePayment } from '../types';
 export interface UnparsedInvoicePayment extends Omit<InvoicePayment, 'paid_on' | 'amount'> {
     paid_on: string;
     amount: string;

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

@@ -1,21 +1,7 @@
-import { ArtaID } from '../ArtaClient';
-import { SupportedCurrency } from '../MetadataTypes';
-import { RestClient } from '../net/RestClient';
-import { Page } from '../pagination';
-import { DatedInterface, Nullable, NullableString } from '../utils';
-export interface Invoice extends DatedInterface {
-    amount_owed: number;
-    amount_owed_currency: SupportedCurrency;
-    amount_paid: number;
-    amount_paid_currency: SupportedCurrency;
-    created_at: Date;
-    invoice_url?: NullableString;
-    id: ArtaID;
-    issued_on: Nullable<Date>;
-    shipment_id: NullableString;
-    status: string;
-    updated_at: Date;
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { Invoice } from '../types';
 export declare class InvoicesEndpoint {
     private readonly artaClient;
     private readonly defaultEndpoint;

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

@@ -1,17 +1,7 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { DatedInterface, NullableString } from '../utils';
-import { Page } from '../pagination';
-export interface Key extends DatedInterface {
-    id: ArtaID;
-    is_testing: boolean;
-    name?: NullableString;
-    token: string;
-}
-export interface KeyCreateBody {
-    is_testing: boolean;
-    name?: NullableString;
-}
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { Key } from '../types';
+export type KeyCreateBody = Pick<Key, 'is_testing' | 'name'>;
 export interface KeyCreate {
     api_key: KeyCreateBody;
 }
@@ -20,9 +10,9 @@ export declare class KeysEndpoint {
     private readonly defaultEndpoint;
     private readonly path;
     constructor(artaClient: RestClient);
-    getById(id: ArtaID, auth?: string): Promise<Key>;
+    getById(id: Key['id'], auth?: string): Promise<Key>;
     list(page?: number, pageSize?: number, auth?: string): Promise<Page<Key>>;
     listAll(auth?: string): AsyncGenerator<Key>;
     create(payload: KeyCreateBody, auth?: string): Promise<Key>;
-    remove(id: ArtaID, auth?: string): Promise<void>;
+    remove(id: Key['id'], auth?: string): Promise<void>;
 }

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

@@ -1,23 +1,7 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { Page } from '../pagination';
-import { DatedInterface, NullableString } from '../utils';
-export interface Log extends DatedInterface {
-    api_key_id: number;
-    arta_version: string;
-    end_at: Date;
-    id: ArtaID;
-    created_at: Date;
-    method: string;
-    path: string;
-    query_params: string;
-    request_body?: NullableString;
-    request_id: string;
-    response_body?: NullableString;
-    start_at: Date;
-    status: number;
-    updated_at: Date;
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { Log } from '../types';
 export interface UnparsedLog extends Omit<Log, 'start_at' | 'end_at'> {
     start_at: string;
     end_at: string;

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

@@ -1,5 +1,5 @@
-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';
+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 { RestClient } from '../net/RestClient';
 export interface APIVersionMetadata {
     authentication: AuthTypes[];
     description: string;
@@ -13,7 +13,7 @@ export interface CurrencyMetadata {
 }
 export interface EmailNotificationMetadata {
     description: string;
-    optional_recipients: Recipients;
+    optional_recipients: Recipient[];
     id: EmailNotificationId;
 }
 export interface ShipmentExceptionTypeMetadata {

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

@@ -1,17 +1,5 @@
-import { ArtaID } from '../ArtaClient';
-import { RestClient } from '../net/RestClient';
-import { DatedInterface, NullableString } from '../utils';
-export interface Organization extends DatedInterface {
-    api_version: string;
-    id: ArtaID;
-    name: string;
-    billing_terms?: NullableString;
-    company_name?: NullableString;
-    display_name?: NullableString;
-    shortcode?: NullableString;
-    status?: NullableString;
-    stripe_customer_id?: NullableString;
-}
+import type { RestClient } from '../net/RestClient';
+import type { Organization } from '../types';
 export declare class OrganizationsEndpoint {
     private readonly artaClient;
     private readonly path;

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

@@ -1,15 +1,7 @@
-import { ArtaID } from '../ArtaClient';
-import { PaymentContext, SupportedCurrency } from '../MetadataTypes';
-import { RestClient } from '../net/RestClient';
-import { Page } from '../pagination';
-import { DatedInterface } from '../utils';
-export interface Payment extends DatedInterface {
-    id: ArtaID;
-    amount: number;
-    amount_currency: SupportedCurrency;
-    context: PaymentContext;
-    paid_on: Date;
-}
+import type { ArtaID } from '../ArtaClient';
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { Payment } from '../types';
 export interface UnparsedPayment extends Omit<Payment, 'paid_on' | 'amount'> {
     paid_on: string;
     amount: string;