@merchi/sdk 1.40.2

package/src/entities/reminder.ts

@@ -0,0 +1,74 @@
+import { Assignment } from './assignment.js';
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { Entity } from '../entity.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { Notification } from './notification.js';
+import { Product } from './product.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+
+export class Reminder extends Entity {
+  protected static resourceName = 'reminders';
+  protected static singularName = 'reminder';
+  protected static pluralName = 'reminders';
+
+  @Reminder.property()
+  public id?: number;
+
+  @Reminder.property()
+  public user?: User;
+
+  @Reminder.property()
+  public userProfile?: User;
+
+  @Reminder.property()
+  public sendEmail?: boolean;
+
+  @Reminder.property()
+  public sendSms?: boolean;
+
+  @Reminder.property({type: Date})
+  public created?: Date;
+
+  @Reminder.property({type: Date})
+  public updated?: Date;
+
+  @Reminder.property({type: Date})
+  public remindDate?: Date;
+
+  @Reminder.property()
+  public message?: string;
+
+  @Reminder.property({arrayType: 'DomainTag'})
+  public domainTags?: DomainTag[];
+
+  @Reminder.property({arrayType: 'User'})
+  public remindUsers?: User[];
+
+  @Reminder.property()
+  public job?: Job;
+
+  @Reminder.property()
+  public product?: Product;
+
+  @Reminder.property()
+  public invoice?: Invoice;
+
+  @Reminder.property()
+  public domain?: Domain;
+
+  @Reminder.property()
+  public company?: Company;
+
+  @Reminder.property()
+  public shipment?: Shipment;
+
+  @Reminder.property()
+  public assignment?: Assignment;
+
+  @Reminder.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+}

package/src/entities/session.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Session', () => {
+  const merchi = new Merchi();
+  const session = new merchi.Session();
+  expect(session).toBeTruthy();
+});

package/src/entities/session.ts

@@ -0,0 +1,28 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+
+export class Session extends Entity {
+  protected static resourceName = 'sessions';
+  protected static singularName = 'session';
+  protected static pluralName = 'sessions';
+  protected static primaryKey = 'token';
+
+  @Session.property({type: Date})
+  public archived?: Date | null;
+
+  @Session.property({type: String})
+  public ip?: string | null;
+
+  @Session.property()
+  public token?: string;
+
+  @Session.property({type: Boolean})
+  public remember?: boolean | null;
+
+  @Session.property()
+  public user?: User;
+
+  @Session.property({type: Domain})
+  public domain?: Domain | null;
+}

package/src/entities/shipment.test.ts

@@ -0,0 +1,24 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Shipment', () => {
+  const merchi = new Merchi();
+  const shipment = new merchi.Shipment();
+  expect(shipment).toBeTruthy();
+});
+
+test('can calculation undefined handling', () => {
+  const merchi = new Merchi();
+  const shipment = new merchi.Shipment();
+  expect(() => shipment.calculateSubTotal()).toThrow();
+  expect(shipment.calculateSubTotal({strictEmbed: false})).toEqual('0.000');
+
+  expect(() => shipment.calculateTaxAmount()).toThrow();
+  expect(shipment.calculateTaxAmount({strictEmbed: false})).toEqual('0.000');
+});
+
+test('can calculation tax with tax type undefined', () => {
+  const merchi = new Merchi();
+  const shipment = new merchi.Shipment();
+  shipment.cost = 0;
+  expect(shipment.calculateTaxAmount()).toEqual('0.000');
+});

package/src/entities/shipment.ts

@@ -0,0 +1,196 @@
+import { Address } from './address.js';
+import { Assignment } from './assignment.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { DomainTag } from './domain_tag.js';
+import { Entity } from '../entity.js';
+import { InternalTag } from './internal_tag.js';
+import { Invoice } from './invoice.js';
+import { Quote } from './quote.js';
+import { Reminder } from './reminder.js';
+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 {
+  strictEmbed?: boolean;
+}
+
+export class Shipment extends Entity {
+  protected static resourceName = 'shipments';
+  protected static singularName = 'shipment';
+  protected static pluralName = 'shipments';
+
+  @Shipment.property({type: Date})
+  public archived?: Date | null;
+
+  @Shipment.property()
+  public id?: number;
+
+  @Shipment.property()
+  public name?: string;
+
+  @Shipment.property()
+  public shipmentServiceBookingInfo?: string;
+
+  @Shipment.property()
+  public shipmentServiceQuote?: string;
+
+  @Shipment.property()
+  public pickUp?: boolean;
+
+  @Shipment.property({arrayType: 'InternalTag'})
+  public internalTags?: InternalTag[];
+
+  @Shipment.property({type: MerchiFile})
+  public shipmentLabel?: MerchiFile | null;
+
+  @Shipment.property({type: Date})
+  public creationDate?: Date | null;
+
+  @Shipment.property({type: Date})
+  public dispatchedDate?: Date | null;
+
+  @Shipment.property({type: Date})
+  public dispatchDate?: Date | null;
+
+  @Shipment.property({type: Date})
+  public expectedReceiveDate?: Date | null;
+
+  @Shipment.property({type: Date})
+  public receivedDate?: Date | null;
+
+  @Shipment.property()
+  public senderResponsible?: boolean;
+
+  @Shipment.property({type: String})
+  public senderNotes?: string | null;
+
+  @Shipment.property({type: String})
+  public receiverNotes?: string | null;
+
+  @Shipment.property({type: Number})
+  public transportCompany?: number | null;
+
+  @Shipment.property({type: String})
+  public transportCompanyName?: string | null;
+
+  @Shipment.property({type: String})
+  public trackingNumber?: string | null;
+
+  @Shipment.property({type: Number})
+  public buyCost?: number | null;
+
+  @Shipment.property({type: String})
+  public buyCurrency?: string | null;
+
+  @Shipment.property({type: Number})
+  public cost?: number | null;
+
+  @Shipment.property({type: Number})
+  public taxAmount?: number | null;
+
+  @Shipment.property({type: Number})
+  public maxWeight?: number | null;
+
+  @Shipment.property({type: Number})
+  public maxVolume?: number | null;
+
+  @Shipment.property()
+  public sendSms?: boolean;
+
+  @Shipment.property()
+  public sendEmail?: boolean;
+
+  @Shipment.property()
+  public sendWhatsapp?: boolean;
+
+  @Shipment.property({type: CountryTax})
+  public taxType?: CountryTax | null;
+
+  @Shipment.property()
+  public isOnBehalfOf?: boolean;
+
+  @Shipment.property({type: User})
+  public onBehalfOf?: User | null;
+
+  @Shipment.property({type: Company})
+  public onBehalfOfCompany?: Company | null;
+
+  @Shipment.property({type: User})
+  public sender?: User | null;
+
+  @Shipment.property({type: Company})
+  public senderCompany?: Company | null;
+
+  @Shipment.property({type: Address})
+  public senderAddress?: Address | null;
+
+  @Shipment.property({type: String})
+  public blindShipTo?: string | null;
+
+  @Shipment.property({type: User})
+  public receiver?: User | null;
+
+  @Shipment.property({type: Company})
+  public receiverCompany?: Company | null;
+
+  @Shipment.property({type: Address})
+  public receiverAddress?: Address | null;
+
+  @Shipment.property({arrayType: 'Invoice'})
+  public invoices?: Invoice[];
+
+  @Shipment.property({type: Quote})
+  public quote?: Quote | null;
+
+  @Shipment.property({type: ShipmentMethod})
+  public shipmentMethod?: ShipmentMethod | null;
+
+  @Shipment.property({arrayType: 'DomainTag'})
+  public tags?: DomainTag[];
+
+  @Shipment.property({arrayType: 'Assignment'})
+  public assignments?: Assignment[];
+
+  @Shipment.property({arrayType: 'ShipmentItem'})
+  public items?: ShipmentItem[];
+
+  @Shipment.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @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){
+      if (this.cost === undefined) {
+        throw new Error('cost is undefined, did you forget to embed it?');
+      }
+    }
+    const cost = this.cost ? this.cost : 0;
+    return parseFloat(String(cost)).toFixed(3);
+  };
+
+  public calculateTaxAmount = (options?: CalculateOptions) => {
+    const taxPercent = this.taxType && this.taxType.taxPercent ?
+      this.taxType.taxPercent : 0;
+    const taxRate = taxPercent ? Number(taxPercent) / 100 : 0;
+    return (parseFloat(
+      this.calculateSubTotal(options)) * taxRate).toFixed(3);
+  };
+
+  public calculateTotal = (options?: CalculateOptions) => {
+    return (
+      parseFloat(this.calculateSubTotal(options)) +
+      parseFloat(this.calculateTaxAmount(options))
+    ).toFixed(3);
+  };
+}

package/src/entities/shipment_item.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make ShipmentItem', () => {
+  const merchi = new Merchi();
+  const shipmentItem = new merchi.ShipmentItem();
+  expect(shipmentItem).toBeTruthy();
+});

package/src/entities/shipment_item.ts

@@ -0,0 +1,15 @@
+import { Entity } from '../entity.js';
+import { Job } from './job.js';
+import { ShipmentItemFulfillment } from './shipment_item_fulfillment.js';
+
+export class ShipmentItem extends Entity {
+  protected static resourceName = 'shipment_items';
+  protected static singularName = 'shipmentItem';
+  protected static pluralName = 'shipmentItems';
+
+  @ShipmentItem.property({type: Job})
+  public job?: Job;
+
+  @ShipmentItem.property({arrayType: 'ShipmentItemFulfillment'})
+  public fulfillments?: ShipmentItemFulfillment[];
+}

package/src/entities/shipment_item_fulfillment.test.ts

@@ -0,0 +1,8 @@
+import { Merchi } from '../merchi.js';
+
+test('can make ShipmentItemFulfillment', () => {
+  const merchi = new Merchi();
+  const shipmentItemFulfillment =
+    new merchi.ShipmentItemFulfillment();
+  expect(shipmentItemFulfillment).toBeTruthy();
+});

package/src/entities/shipment_item_fulfillment.ts

@@ -0,0 +1,15 @@
+import { Entity } from '../entity.js';
+import { Assignment } from './assignment.js';
+import { Job } from './job.js';
+
+export class ShipmentItemFulfillment extends Entity {
+  protected static resourceName = 'shipment_item_fulfillments';
+  protected static singularName = 'shipmentItemFulfillment';
+  protected static pluralName = 'shipmentItemFulfillments';
+
+  @ShipmentItemFulfillment.property({type: 'Assignment'})
+  public assignment?: Assignment;
+
+  @ShipmentItemFulfillment.property({type: 'Job'})
+  public job?: Job;
+}

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/shipment_method.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make ShipmentMethod', () => {
+  const merchi = new Merchi();
+  const shipmentMethod = new merchi.ShipmentMethod();
+  expect(shipmentMethod).toBeTruthy();
+});

package/src/entities/shipment_method.ts

@@ -0,0 +1,61 @@
+import { ShipmentService } from '../constants/shipment_services.js';
+import { Entity } from '../entity.js';
+import { Address } from './address.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { Product } from './product.js';
+import { ShipmentMethodVariation } from './shipment_method_variation.js';
+
+export class ShipmentMethod extends Entity {
+  protected static resourceName = 'shipment_methods';
+  protected static singularName = 'shipmentMethod';
+  protected static pluralName = 'shipmentMethods';
+
+  @ShipmentMethod.property()
+  public id?: number;
+
+  @ShipmentMethod.property()
+  public name?: string;
+
+  @ShipmentMethod.property({type: ShipmentService})
+  public shipmentService?: ShipmentService | null;
+
+  @ShipmentMethod.property({type: Address})
+  public originAddress?: Address | null;
+
+  @ShipmentMethod.property()
+  public pickUp?: boolean;
+
+  @ShipmentMethod.property({type: Company})
+  public company?: Company | null;
+
+  @ShipmentMethod.property()
+  public companyDefault?: boolean;
+
+  @ShipmentMethod.property()
+  public defaultCost?: number;
+
+  @ShipmentMethod.property()
+  public currency?: string;
+
+  @ShipmentMethod.property()
+  public buyCost?: number;
+
+  @ShipmentMethod.property()
+  public buyCurrency?: string;
+
+  @ShipmentMethod.property({type: Number})
+  public transportCompany?: number | null;
+
+  @ShipmentMethod.property()
+  public transportCompanyName?: string;
+
+  @ShipmentMethod.property({type: CountryTax})
+  public taxType?: CountryTax | null;
+
+  @ShipmentMethod.property({arrayType: 'ShipmentMethodVariation'})
+  public variations?: ShipmentMethodVariation[];
+
+  @ShipmentMethod.property({arrayType: 'Product'})
+  public products?: Product[];
+}

package/src/entities/shipment_method_variation.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make ShipmentMethodVariation', () => {
+  const merchi = new Merchi();
+  const shipmentMethodVariation = new merchi.ShipmentMethodVariation();
+  expect(shipmentMethodVariation).toBeTruthy();
+});

package/src/entities/shipment_method_variation.ts

@@ -0,0 +1,39 @@
+import { Entity } from '../entity.js';
+import { CountryTax } from './country_tax.js';
+import { ShipmentMethod } from './shipment_method.js';
+
+export class ShipmentMethodVariation extends Entity {
+  protected static resourceName = 'shipment_method_variations';
+  protected static singularName = 'shipmentMethodVariation';
+  protected static pluralName = 'shipmentMethodVariations';
+
+  @ShipmentMethodVariation.property()
+  public id?: number;
+
+  @ShipmentMethodVariation.property({type: String})
+  public destinationCountry?: string | null;
+
+  @ShipmentMethodVariation.property({type: String})
+  public destinationState?: string | null;
+
+  @ShipmentMethodVariation.property({type: Number})
+  public cost?: number | null;
+
+  @ShipmentMethodVariation.property()
+  public currency?: string;
+
+  @ShipmentMethodVariation.property({type: Number})
+  public buyCost?: number | null;
+
+  @ShipmentMethodVariation.property()
+  public buyCurrency?: string;
+
+  @ShipmentMethodVariation.property({type: Number})
+  public maxWeight?: number | null;
+
+  @ShipmentMethodVariation.property({type: 'CountryTax'})
+  public taxType?: CountryTax | null;
+
+  @ShipmentMethodVariation.property()
+  public shipmentMethod?: ShipmentMethod;
+}

package/src/entities/short_url.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make ShortUrl', () => {
+  const merchi = new Merchi();
+  const shortUrl = new merchi.ShortUrl();
+  expect(shortUrl).toBeTruthy();
+});

package/src/entities/short_url.ts

@@ -0,0 +1,36 @@
+import { Entity } from '../entity.js';
+import { Notification } from './notification.js';
+import { User } from './user.js';
+
+export class ShortUrl extends Entity {
+  protected static resourceName = 'short_urls';
+  protected static singularName = 'shortUrl';
+  protected static pluralName = 'shortUrls';
+
+  @ShortUrl.property({type: Date})
+  public archived?: Date | null;
+
+  @ShortUrl.property()
+  public id?: number;
+
+  @ShortUrl.property()
+  public prefixToken?: string;
+
+  @ShortUrl.property()
+  public suffixToken?: string;
+
+  @ShortUrl.property()
+  public originalLink?: string;
+
+  @ShortUrl.property()
+  public triedTimes?: number;
+
+  @ShortUrl.property({type: Date})
+  public lastLookup?: Date | null;
+
+  @ShortUrl.property({type: User})
+  public user?: User | null;
+
+  @ShortUrl.property({arrayType: 'Notification'})
+  public notification?: Notification[];
+}

package/src/entities/subscription_plan.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make SubscriptionPlan', () => {
+  const merchi = new Merchi();
+  const subscriptionPlan = new merchi.SubscriptionPlan();
+  expect(subscriptionPlan).toBeTruthy();
+});

package/src/entities/subscription_plan.ts

@@ -0,0 +1,73 @@
+import { Entity } from '../entity.js';
+import { CountryTax } from './country_tax.js';
+import { User } from './user.js';
+import { Company } from './company.js';
+
+export class SubscriptionPlan extends Entity {
+  protected static resourceName = 'subscription_plans';
+  protected static singularName = 'subscriptionPlan';
+  protected static pluralName = 'subscriptionPlans';
+
+  @SubscriptionPlan.property()
+  public id?: number;
+
+  @SubscriptionPlan.property({type: Date})
+  public created?: Date | null;
+
+  @SubscriptionPlan.property({type: Date})
+  public updated?: Date | null;
+
+  @SubscriptionPlan.property({type: User})
+  public createdBy?: User | null;
+
+  @SubscriptionPlan.property({type: User})
+  public updatedBy?: User | null;
+
+  @SubscriptionPlan.property()
+  public name?: string;
+
+  @SubscriptionPlan.property()
+  public currency?: string;
+
+  @SubscriptionPlan.property({type: CountryTax})
+  public tax?: CountryTax | null;
+
+  @SubscriptionPlan.property()
+  public baseCost?: number;
+
+  @SubscriptionPlan.property()
+  public whiteLabelDomainCost?: number;
+
+  @SubscriptionPlan.property()
+  public perSmsCost?: number;
+
+  @SubscriptionPlan.property()
+  public perUserCost?: number;
+
+  @SubscriptionPlan.property()
+  public perDomainCost?: number;
+
+  @SubscriptionPlan.property()
+  public transactionCost?: number;
+
+  @SubscriptionPlan.property()
+  public commissionRate?: number;
+
+  @SubscriptionPlan.property()
+  public baseUserCount?: number;
+
+  @SubscriptionPlan.property()
+  public baseDomainCount?: number;
+
+  @SubscriptionPlan.property()
+  public billingCycleDays?: number;
+
+  @SubscriptionPlan.property()
+  public isPrivate?: boolean;
+
+  @SubscriptionPlan.property()
+  public showPublic?: boolean;
+
+  @SubscriptionPlan.property({arrayType: 'Company'})
+  public companies?: Company[];
+}

package/src/entities/supply_domain.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make SupplyDomain', () => {
+  const merchi = new Merchi();
+  const supplyDomain = new merchi.SupplyDomain();
+  expect(supplyDomain).toBeTruthy();
+});