merchi_sdk_ts 1.7.4 → 1.7.6

package/dist/entities/shipment.js

@@ -243,6 +243,10 @@ var Shipment = /** @class */ (function (_super) {
         Shipment.property({ arrayType: 'Reminder' }),
         __metadata("design:type", Array)
     ], Shipment.prototype, "reminders", void 0);
+    __decorate([
+        Shipment.property({ arrayType: 'ShipmentLog' }),
+        __metadata("design:type", Array)
+    ], Shipment.prototype, "logs", void 0);
     return Shipment;
 }(Entity));
 export { Shipment };

package/dist/entities/shipment_log.js

@@ -0,0 +1,75 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+/**
+ * Runtime type tag only. The API returns `detailJson` as arbitrary JSON; the
+ * entity layer rejects `Object` from decorator metadata, so we use an empty
+ * class as the property `type` (same pattern as DraftTemplate.customisationMap).
+ */
+var detailJsonPropertyType = /** @class */ (function () {
+    function detailJsonPropertyType() {
+    }
+    return detailJsonPropertyType;
+}());
+var ShipmentLog = /** @class */ (function (_super) {
+    __extends(ShipmentLog, _super);
+    function ShipmentLog() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    ShipmentLog.resourceName = 'shipment_logs';
+    ShipmentLog.singularName = 'shipmentLog';
+    ShipmentLog.pluralName = 'shipmentLogs';
+    __decorate([
+        ShipmentLog.property(),
+        __metadata("design:type", Number)
+    ], ShipmentLog.prototype, "id", void 0);
+    __decorate([
+        ShipmentLog.property({ type: 'Shipment' }),
+        __metadata("design:type", Object)
+    ], ShipmentLog.prototype, "shipment", void 0);
+    __decorate([
+        ShipmentLog.property({ type: User }),
+        __metadata("design:type", Object)
+    ], ShipmentLog.prototype, "user", void 0);
+    __decorate([
+        ShipmentLog.property({ type: String }),
+        __metadata("design:type", String)
+    ], ShipmentLog.prototype, "sourceType", void 0);
+    __decorate([
+        ShipmentLog.property({ type: String }),
+        __metadata("design:type", String)
+    ], ShipmentLog.prototype, "message", void 0);
+    __decorate([
+        ShipmentLog.property({ type: detailJsonPropertyType }),
+        __metadata("design:type", Object)
+    ], ShipmentLog.prototype, "detailJson", void 0);
+    __decorate([
+        ShipmentLog.property({ type: Date }),
+        __metadata("design:type", Object)
+    ], ShipmentLog.prototype, "createdAt", void 0);
+    return ShipmentLog;
+}(Entity));
+export { ShipmentLog };

package/dist/entities/user.js

@@ -327,6 +327,10 @@ var User = /** @class */ (function (_super) {
         User.property({ arrayType: 'JobComment' }),
         __metadata("design:type", Array)
     ], User.prototype, "jobComments", void 0);
+    __decorate([
+        User.property({ arrayType: 'ShipmentLog' }),
+        __metadata("design:type", Array)
+    ], User.prototype, "shipmentLogs", void 0);
     __decorate([
         User.property({ arrayType: 'EmailAddress' }),
         __metadata("design:type", Array)

package/dist/entity.js

@@ -760,6 +760,10 @@ var Entity = /** @class */ (function () {
             if (options.relatedJobs !== undefined) {
                 fetchOptions.query.push(['related_jobs', options.relatedJobs.toString()]);
             }
+            if (options.relatedShipment !== undefined) {
+                fetchOptions.query.push(['related_shipment',
+                    options.relatedShipment.toString()]);
+            }
             if (options.relatedProduct !== undefined) {
                 fetchOptions.query.push(['related_product',
                     options.relatedProduct.toString()]);

package/dist/index.js

@@ -58,6 +58,7 @@ import { Reminder } from './entities/reminder.js';
 import { apiFetch, apiFetchWithProgress } from './request.js'; // eslint-disable-next-line no-unused-vars
 import { Session } from './entities/session.js';
 import { Shipment } from './entities/shipment.js';
+import { ShipmentLog } from './entities/shipment_log.js';
 import { ShipmentItem } from './entities/shipment_item.js';
 import { ShipmentItemFulfillment } from './entities/shipment_item_fulfillment.js';
 import { ShipmentMethod } from './entities/shipment_method.js';
@@ -81,4 +82,4 @@ import * as constants from './constants/index.js';
 import * as request from './request.js';
 import * as util from './util/index.js';
 import { toastNotifications } from './toasts.js';
-export { constants, request, util, toastNotifications, Address, AgentConversation, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, Component, ComponentTag, ComponentVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, MatchingInventory, Menu, MenuItem, Merchi, MerchiFile, Notification, Page, Payment, PaymentDevice, PhoneNumber, Product, ProductionComment, Quote, QuoteItem, Reminder, apiFetch, apiFetchWithProgress, Session, Shipment, ShipmentItem, ShipmentItemFulfillment, ShipmentMethod, ShipmentMethodVariation, ShortUrl, SubscriptionPlan, SupplyDomain, SystemRole, Theme, ThemeCssSetting, User, UserCompany, Variation, VariationField, VariationFieldsOption, VariationOption, VariationsGroup, generateUUID, getCookie };
+export { constants, request, util, toastNotifications, Address, AgentConversation, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, Component, ComponentTag, ComponentVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, MatchingInventory, Menu, MenuItem, Merchi, MerchiFile, Notification, Page, Payment, PaymentDevice, PhoneNumber, Product, ProductionComment, Quote, QuoteItem, Reminder, apiFetch, apiFetchWithProgress, Session, Shipment, ShipmentLog, ShipmentItem, ShipmentItemFulfillment, ShipmentMethod, ShipmentMethodVariation, ShortUrl, SubscriptionPlan, SupplyDomain, SystemRole, Theme, ThemeCssSetting, User, UserCompany, Variation, VariationField, VariationFieldsOption, VariationOption, VariationsGroup, generateUUID, getCookie };

package/dist/merchi.js

@@ -31,6 +31,7 @@ import { InventoryUnitVariation } from './entities/inventory_unit_variation.js';
 import { VariationFieldsOption } from './entities/variation_fields_option.js';
 import { Bank } from './entities/bank.js';
 import { Shipment } from './entities/shipment.js';
+import { ShipmentLog } from './entities/shipment_log.js';
 import { ShipmentItem } from './entities/shipment_item.js';
 import { ShipmentItemFulfillment } from './entities/shipment_item_fulfillment.js';
 import { ShipmentMethod } from './entities/shipment_method.js';
@@ -221,6 +222,7 @@ var Merchi = /** @class */ (function () {
         this.InventoryGroup = this.setupClass(InventoryGroup);
         this.Notification = this.setupClass(Notification);
         this.Shipment = this.setupClass(Shipment);
+        this.ShipmentLog = this.setupClass(ShipmentLog);
         this.ShipmentItem = this.setupClass(ShipmentItem);
         this.ShipmentItemFulfillment = this.setupClass(ShipmentItemFulfillment);
         this.ShipmentMethod = this.setupClass(ShipmentMethod);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_sdk_ts",
-  "version": "1.7.4",
+  "version": "1.7.6",
   "main": "dist/index.js",
   "type": "module",
   "repository": "git@github.com:merchisdk/merchi_sdk_ts.git",

package/src/entities/shipment.ts

@@ -12,6 +12,7 @@ import { Job } from './job.js';
 import { MerchiFile } from './file.js';
 import { User } from './user.js';
 import { ShipmentItem } from './shipment_item.js';
+import { ShipmentLog } from './shipment_log.js';
 import { ShipmentMethod } from './shipment_method.js';
 
 interface CalculateOptions {
@@ -161,6 +162,9 @@ export class Shipment extends Entity {
   @Shipment.property({arrayType: 'Reminder'})
   public reminders?: Reminder[];
 
+  @Shipment.property({ arrayType: 'ShipmentLog' })
+  public logs?: ShipmentLog[];
+
   public calculateSubTotal = (options?: CalculateOptions) => {
     const { strictEmbed = true } = options ? options : {};
     if (strictEmbed){

package/src/entities/shipment_log.ts

@@ -0,0 +1,37 @@
+import { Entity } from '../entity.js';
+import type { Shipment } from './shipment.js';
+import { User } from './user.js';
+
+/**
+ * Runtime type tag only. The API returns `detailJson` as arbitrary JSON; the
+ * entity layer rejects `Object` from decorator metadata, so we use an empty
+ * class as the property `type` (same pattern as DraftTemplate.customisationMap).
+ */
+const detailJsonPropertyType = class {};
+
+export class ShipmentLog extends Entity {
+  protected static resourceName = 'shipment_logs';
+  protected static singularName = 'shipmentLog';
+  protected static pluralName = 'shipmentLogs';
+
+  @ShipmentLog.property()
+  public id?: number;
+
+  @ShipmentLog.property({ type: 'Shipment' })
+  public shipment?: Shipment | null;
+
+  @ShipmentLog.property({ type: User })
+  public user?: User | null;
+
+  @ShipmentLog.property({ type: String })
+  public sourceType?: string;
+
+  @ShipmentLog.property({ type: String })
+  public message?: string;
+
+  @ShipmentLog.property({ type: detailJsonPropertyType })
+  public detailJson?: Record<string, unknown> | null;
+
+  @ShipmentLog.property({ type: Date })
+  public createdAt?: Date | null;
+}

package/src/entities/user.ts

@@ -22,6 +22,7 @@ import { Reminder } from './reminder.js';
 import { ProductionComment } from './production_comment.js';
 import { Session } from './session.js';
 import { Shipment } from './shipment.js';
+import { ShipmentLog } from './shipment_log.js';
 import { SystemRole } from './system_role.js';
 import { Theme } from './theme.js';
 import { UserCompany } from './user_company.js';
@@ -167,6 +168,9 @@ export class User extends Entity {
   @User.property({ arrayType: 'JobComment' })
   public jobComments?: JobComment[];
 
+  @User.property({ arrayType: 'ShipmentLog' })
+  public shipmentLogs?: ShipmentLog[];
+
   @User.property({ arrayType: 'EmailAddress' })
   public _emailAddresses?: EmailAddress[];
 

package/src/entity.ts

@@ -138,6 +138,7 @@ interface ListOptions {
   relatedDraft?: number;
   relatedJob?: number;
   relatedJobs?: number[];
+  relatedShipment?: number;
   relatedProduct?: number;
   relatedUser?: number;
   savedByUser?: number;
@@ -565,6 +566,10 @@ export class Entity {
       if (options.relatedJobs !== undefined) {
         fetchOptions.query.push(['related_jobs', options.relatedJobs.toString()]);
       }
+      if (options.relatedShipment !== undefined) {
+        fetchOptions.query.push(['related_shipment',
+          options.relatedShipment.toString()]);
+      }
       if (options.relatedProduct !== undefined) {
         fetchOptions.query.push(['related_product',
           options.relatedProduct.toString()]);

package/src/index.ts

@@ -58,6 +58,7 @@ import { Reminder } from './entities/reminder.js';
 import { RequestOptions, apiFetch, apiFetchWithProgress } from './request.js'; // eslint-disable-next-line no-unused-vars
 import { Session } from './entities/session.js';
 import { Shipment } from './entities/shipment.js';
+import { ShipmentLog } from './entities/shipment_log.js';
 import { ShipmentItem } from './entities/shipment_item.js';
 import { ShipmentItemFulfillment } from './entities/shipment_item_fulfillment.js';
 import { ShipmentMethod } from './entities/shipment_method.js';
@@ -150,6 +151,7 @@ export {
   apiFetchWithProgress,
   Session,
   Shipment,
+  ShipmentLog,
   ShipmentItem,
   ShipmentItemFulfillment,
   ShipmentMethod,

package/src/merchi.ts

@@ -25,6 +25,7 @@ import { InventoryUnitVariation } from './entities/inventory_unit_variation.js';
 import { VariationFieldsOption } from './entities/variation_fields_option.js';
 import { Bank } from './entities/bank.js';
 import { Shipment } from './entities/shipment.js';
+import { ShipmentLog } from './entities/shipment_log.js';
 import { ShipmentItem } from './entities/shipment_item.js';
 import { ShipmentItemFulfillment } from './entities/shipment_item_fulfillment.js';
 import { ShipmentMethod } from './entities/shipment_method.js';
@@ -136,6 +137,7 @@ export class Merchi {
   public ProductionComment: typeof ProductionComment;
   public DraftComment: typeof DraftComment;
   public Shipment: typeof Shipment;
+  public ShipmentLog: typeof ShipmentLog;
   public ShipmentItem: typeof ShipmentItem;
   public ShipmentItemFulfillment: typeof ShipmentItemFulfillment;
   public ShipmentMethod: typeof ShipmentMethod;
@@ -278,6 +280,7 @@ export class Merchi {
     this.InventoryGroup = this.setupClass(InventoryGroup) as typeof InventoryGroup;
     this.Notification = this.setupClass(Notification) as typeof Notification;
     this.Shipment = this.setupClass(Shipment) as typeof Shipment;
+    this.ShipmentLog = this.setupClass(ShipmentLog) as typeof ShipmentLog;
     this.ShipmentItem = this.setupClass(ShipmentItem) as typeof ShipmentItem;
     this.ShipmentItemFulfillment = this.setupClass(
       ShipmentItemFulfillment