@artaio/node-api 1.2.0 → 1.2.3

package/dist/lib/arta.d.ts

@@ -16,6 +16,7 @@ import { WebhooksEndpoint } from './endpoint/webhooks';
 import { TrackingsEndpoint } from './endpoint/trackings';
 import { QuoteRequestsEndpoint } from './endpoint/requests';
 import { ShipmentsEndpoint } from './endpoint/shipments';
+import { TagsEndpoint } from './endpoint/tags';
 export interface ArtaConfig {
     host: string;
     verbosity: LoggerVerbosity;
@@ -37,6 +38,7 @@ export declare class Arta {
     payments: PaymentsEndpoint;
     requests: QuoteRequestsEndpoint;
     shipments: ShipmentsEndpoint;
+    tags: TagsEndpoint;
     trackings: TrackingsEndpoint;
     uploads: UploadsEndpoint;
     webhook_deliveries: WebhookDeliveriesEndpoint;

package/dist/lib/arta.js

@@ -21,6 +21,7 @@ var webhooks_1 = require("./endpoint/webhooks");
 var trackings_1 = require("./endpoint/trackings");
 var requests_1 = require("./endpoint/requests");
 var shipments_1 = require("./endpoint/shipments");
+var tags_1 = require("./endpoint/tags");
 var defaultConfig = {
     host: 'api.arta.io',
     verbosity: 'ERROR',
@@ -47,6 +48,7 @@ var Arta = /** @class */ (function () {
         this.payments = new payments_1.PaymentsEndpoint(this.artaClient);
         this.requests = new requests_1.QuoteRequestsEndpoint(this.artaClient);
         this.shipments = new shipments_1.ShipmentsEndpoint(this.artaClient);
+        this.tags = new tags_1.TagsEndpoint(this.artaClient);
         this.trackings = new trackings_1.TrackingsEndpoint(this.artaClient);
         this.uploads = new uploads_1.UploadsEndpoint(this.artaClient);
         this.webhook_deliveries = new webhookDeliveries_1.WebhookDeliveriesEndpoint(this.artaClient);

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

@@ -40,6 +40,9 @@ export declare class QuoteRequestsEndpoint {
     getById(id: string, auth?: string): Promise<EnrichRequest<QuoteRequest>>;
     list(search?: RequestsSearch, page?: number, pageSize?: number, auth?: string): Promise<Page<EnrichRequest<QuoteRequestListItem>>>;
     create(payload: QuoteRequestCreateBody, auth?: string): Promise<EnrichRequest<QuoteRequest>>;
+    update(id: QuoteRequest['id'], payload: Partial<Pick<QuoteRequest, 'destination' | 'internal_reference' | 'origin' | 'payment_process' | 'public_reference'> & {
+        tags: Array<string>;
+    }>, auth?: string): Promise<EnrichRequest<QuoteRequest>>;
     updateContacts(id: string, contacts: UpdateRequestsContactsBody, auth?: string): Promise<EnrichRequest<QuoteRequest>>;
     requireCustomQuotes(id: string, customQuote: CustomQuotePayload, auth?: string): Promise<QuoteRequest>;
     cancel(id: string, auth?: string): Promise<QuoteRequest>;

package/dist/lib/endpoint/requests.js

@@ -63,7 +63,19 @@ var QuoteRequestsEndpoint = /** @class */ (function () {
                 q.total = Number(q.total);
                 q.included_services.forEach(utils_1.parseService);
                 q.optional_services.forEach(utils_1.parseService);
+                if (q.tags) {
+                    q.tags.forEach(function (t) {
+                        q.created_at = (0, utils_1.createDateAsUTC)(t.created_at);
+                        q.updated_at = (0, utils_1.createDateAsUTC)(t.updated_at);
+                    });
+                }
             });
+            if (resource.tags) {
+                resource.tags.forEach(function (t) {
+                    t.created_at = (0, utils_1.createDateAsUTC)(t.created_at);
+                    t.updated_at = (0, utils_1.createDateAsUTC)(t.updated_at);
+                });
+            }
         }
         var updateContacts = function (contacts, auth) { return _this.updateContacts(resource.id, contacts, auth); };
         var requireCustomQuotes = function (customQuote, auth) { return _this.requireCustomQuotes(resource.id, customQuote, auth); };
@@ -81,6 +93,9 @@ var QuoteRequestsEndpoint = /** @class */ (function () {
     QuoteRequestsEndpoint.prototype.create = function (payload, auth) {
         return this.defaultEndpoint.create({ request: payload }, auth);
     };
+    QuoteRequestsEndpoint.prototype.update = function (id, payload, auth) {
+        return this.defaultEndpoint.update(id, { request: payload }, auth);
+    };
     QuoteRequestsEndpoint.prototype.updateContacts = function (id, contacts, auth) {
         return __awaiter(this, void 0, void 0, function () {
             var rawReq;

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

@@ -22,4 +22,7 @@ export declare class ShipmentsEndpoint {
     getById(id: ArtaID, auth?: string): Promise<Shipment>;
     list(search?: ShipmentsSearch, page?: number, pageSize?: number, auth?: string): Promise<Page<Shipment>>;
     create(payload: ShipmentCreateBody, auth?: string): Promise<Shipment>;
+    update(id: Shipment['id'], payload: Partial<Pick<Shipment, 'internal_reference' | 'payment_process' | 'public_reference'> & {
+        tags: Array<string>;
+    }>, auth?: string): Promise<Shipment>;
 }

package/dist/lib/endpoint/shipments.js

@@ -34,6 +34,12 @@ var ShipmentsEndpoint = /** @class */ (function () {
                 e.updated_at = (0, utils_1.createDateAsUTC)(e.updated_at);
             });
         }
+        if (s.tags) {
+            s.tags.forEach(function (t) {
+                t.created_at = (0, utils_1.createDateAsUTC)(t.created_at);
+                t.updated_at = (0, utils_1.createDateAsUTC)(t.updated_at);
+            });
+        }
         s.services && s.services.forEach(utils_1.parseService);
         return s;
     };
@@ -48,6 +54,9 @@ var ShipmentsEndpoint = /** @class */ (function () {
     ShipmentsEndpoint.prototype.create = function (payload, auth) {
         return this.defaultEndpoint.create({ shipment: payload }, auth);
     };
+    ShipmentsEndpoint.prototype.update = function (id, payload, auth) {
+        return this.defaultEndpoint.update(id, { shipment: payload }, auth);
+    };
     return ShipmentsEndpoint;
 }());
 exports.ShipmentsEndpoint = ShipmentsEndpoint;

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

@@ -0,0 +1,17 @@
+import type { RestClient } from '../net/RestClient';
+import type { Page } from '../pagination';
+import type { Tag } from '../types';
+export type TagCreateBody = Omit<Tag, 'id' | 'created_at' | 'updated_at'>;
+export interface TagCreate {
+    tag: TagCreateBody;
+}
+export declare class TagsEndpoint {
+    private readonly artaClient;
+    private readonly defaultEndpoint;
+    private readonly path;
+    constructor(artaClient: RestClient);
+    getByName(name: Tag['name'], auth?: string): Promise<Tag>;
+    list(page?: number, pageSize?: number, auth?: string): Promise<Page<Tag>>;
+    create(payload: TagCreateBody, auth?: string): Promise<Tag>;
+    update(name: Tag['name'], payload: Partial<TagCreateBody>, auth?: string): Promise<Tag>;
+}

package/dist/lib/endpoint/tags.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagsEndpoint = void 0;
+var endpoint_1 = require("./endpoint");
+var TagsEndpoint = /** @class */ (function () {
+    function TagsEndpoint(artaClient) {
+        this.artaClient = artaClient;
+        this.path = '/tags';
+        this.defaultEndpoint = new endpoint_1.DefaultEndpoint(this.path, this.artaClient);
+    }
+    TagsEndpoint.prototype.getByName = function (name, auth) {
+        return this.defaultEndpoint.getById(name, auth);
+    };
+    TagsEndpoint.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);
+    };
+    TagsEndpoint.prototype.create = function (payload, auth) {
+        return this.defaultEndpoint.create({ tag: payload }, auth);
+    };
+    TagsEndpoint.prototype.update = function (name, payload, auth) {
+        return this.defaultEndpoint.update(name, { tag: payload }, auth);
+    };
+    return TagsEndpoint;
+}());
+exports.TagsEndpoint = TagsEndpoint;

package/dist/lib/types.d.ts

@@ -1,3 +1,14 @@
+export type Tag = {
+    updated_at: Date;
+    created_at: Date;
+    id: string;
+    created_by?: (number | null) | undefined;
+    description?: (string | null) | undefined;
+    name: string;
+    updated_by?: (number | null) | undefined;
+    color: string;
+    is_active: boolean;
+};
 export type Attachment = {
     updated_at: Date;
     created_at: Date;
@@ -61,7 +72,17 @@ export type QuoteRequest = {
     quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
     shortcode: string;
     status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
-    tags?: any;
+    tags: {
+        updated_at: Date;
+        created_at: Date;
+        id: string;
+        created_by?: (number | null) | undefined;
+        description?: (string | null) | undefined;
+        name: string;
+        updated_by?: (number | null) | undefined;
+        color: string;
+        is_active: boolean;
+    }[];
     currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
     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")[];
     disqualifications: {
@@ -273,6 +294,17 @@ export type Shipment = {
     shortcode: string;
     status: "pending" | "confirmed" | "collected" | "in_transit" | "completed";
     total: number;
+    tags: {
+        updated_at: Date;
+        created_at: Date;
+        id: string;
+        created_by?: (number | null) | undefined;
+        description?: (string | null) | undefined;
+        name: string;
+        updated_by?: (number | null) | undefined;
+        color: string;
+        is_active: boolean;
+    }[];
     total_currency: "CAD" | "CHF" | "EUR" | "GBP" | "HKD" | "USD";
     url?: (string | null) | undefined;
     tracking?: ({
@@ -743,7 +775,17 @@ export type QuoteRequestListItem = {
     quote_types: ("parcel" | "premium" | "select" | "self_ship")[];
     shortcode: string;
     status: "cancelled" | "closed" | "disqualified" | "expired" | "in_progress" | "pending" | "quoted";
-    tags?: any;
+    tags: {
+        updated_at: Date;
+        created_at: Date;
+        id: string;
+        created_by?: (number | null) | undefined;
+        description?: (string | null) | undefined;
+        name: string;
+        updated_by?: (number | null) | undefined;
+        color: string;
+        is_active: boolean;
+    }[];
 };
 export type EmailNotificationId = "booking" | "cancelled" | "collected" | "collection" | "complete" | "custom_quoted_dashboard" | "in_transit" | "invoice" | "self_ship_label" | "payment" | "scheduling" | "eei";
 export type Recipient = "payer" | "origin" | "destination";

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@artaio/node-api",
-    "version": "1.2.0",
+    "version": "1.2.3",
     "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.2.0",
+  "version": "1.2.3",
   "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",