@merchi/sdk 1.40.2

package/src/entities/invoice.ts

@@ -0,0 +1,192 @@
+import { Address } from './address.js';
+import { Cart } from './cart.js';
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { EmailAddress } from './email_address.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { InternalTag } from './internal_tag.js';
+import { Item } from './item.js';
+import { Job } from './job.js';
+import { Quote } from './quote.js';
+import { Reminder } from './reminder.js';
+import { Notification } from './notification.js';
+import { Payment } from './payment.js';
+import { PhoneNumber } from './phone_number.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+
+export class Invoice extends Entity {
+  protected static resourceName = 'invoices';
+  protected static singularName = 'invoice';
+  protected static pluralName = 'invoices';
+
+  @Invoice.property({type: Date})
+  public archived?: Date | null;
+
+  @Invoice.property()
+  public id?: number;
+
+  @Invoice.property()
+  public stripePaymentEngine?: string;
+
+  @Invoice.property({type: Date})
+  public creationDate?: Date | null;
+
+  @Invoice.property({type: Date})
+  public paymentDeadline?: Date | null;
+
+  @Invoice.property({type: Date})
+  public reminded?: Date | null;
+
+  @Invoice.property()
+  public reminderMessage?: string;
+
+  @Invoice.property()
+  public shopifyOrderId?: string;
+
+  @Invoice.property()
+  public forceReminders?: boolean;
+
+  @Invoice.property()
+  public buySide?: boolean;
+
+  @Invoice.property()
+  public canAutoPay?: boolean;
+
+  @Invoice.property({type: String})
+  public note?: string | null;
+
+  @Invoice.property({type: Date})
+  public terms?: Date | null;
+
+  @Invoice.property({type: Number})
+  public subtotalCost?: number | null;
+
+  @Invoice.property({type: Number})
+  public taxAmount?: number | null;
+
+  @Invoice.property({type: Number})
+  public totalCost?: number | null;
+
+  @Invoice.property({type: Boolean})
+  public sendSms?: boolean | null;
+
+  @Invoice.property({type: Boolean})
+  public sendEmail?: boolean | null;
+
+  @Invoice.property({type: Boolean})
+  public sendWhatsapp?: boolean | null;
+
+  @Invoice.property({type: Boolean})
+  public unpaid?: boolean | null;
+
+  @Invoice.property()
+  public currency?: string;
+
+  @Invoice.property()
+  public acceptSquare?: boolean;
+
+  @Invoice.property()
+  public acceptStripe?: boolean;
+
+  @Invoice.property()
+  public acceptPaypal?: boolean;
+
+  @Invoice.property()
+  public acceptUtrust?: boolean;
+
+  @Invoice.property()
+  public acceptBankTransfer?: boolean;
+
+  @Invoice.property()
+  public acceptPhonePayment?: boolean;
+
+  @Invoice.property({type: String})
+  public invoiceToken?: string | null;
+
+  @Invoice.property({type: String})
+  public paymentUrl?: string;
+
+  @Invoice.property()
+  public isRemindable?: boolean;
+
+  @Invoice.property({embeddedByDefault: false})
+  public owedMoney?: number;
+
+  @Invoice.property({embeddedByDefault: false})
+  public paidMoney?: number;
+
+  @Invoice.property({embeddedByDefault: false})
+  public isCompletelyPaid?: boolean;
+
+  @Invoice.property({type: User})
+  public responsibleManager?: User | null;
+
+  @Invoice.property({type: User})
+  public creator?: User | null;
+
+  @Invoice.property()
+  public client?: User;
+
+  @Invoice.property({type: Company})
+  public clientCompany?: Company | null;
+
+  @Company.property({arrayType: 'Company'})
+  public subscriptionCompanies?: Company[];
+
+  @Invoice.property({type: Address})
+  public shipping?: Address | null;
+
+  @Invoice.property()
+  public domain?: Domain;
+
+  @Invoice.property({arrayType: 'Item'})
+  public items?: Item[];
+
+  @Invoice.property({type: MerchiFile})
+  public pdf?: MerchiFile | null;
+
+  @Invoice.property({type: MerchiFile})
+  public receipt?: MerchiFile | null;
+
+  @Invoice.property({type: PhoneNumber})
+  public clientPhone?: PhoneNumber | null;
+
+  @Invoice.property({type: EmailAddress})
+  public clientEmail?: EmailAddress | null;
+
+  @Invoice.property({type: PhoneNumber})
+  public clientCompanyPhone?: PhoneNumber | null;
+
+  @Invoice.property({type: EmailAddress})
+  public clientCompanyEmail?: EmailAddress | null;
+
+  @Invoice.property({arrayType: 'InternalTag'})
+  public internalTags?: InternalTag[];
+
+  @Invoice.property({arrayType: 'DomainTag'})
+  public tags?: DomainTag[];
+
+  @Invoice.property({arrayType: 'Shipment'})
+  public shipments?: Shipment[];
+
+  @Invoice.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+
+  @Invoice.property({arrayType: 'Reminder'})
+  public reminders?: Reminder[];
+
+  @Invoice.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @Invoice.property({arrayType: 'Quote'})
+  public quotes?: Quote[];
+
+  @Invoice.property()
+  public cart?: Cart;
+
+  @Invoice.property({arrayType: 'Payment'})
+  public payments?: Payment[];
+}

package/src/entities/item.test.ts

@@ -0,0 +1,19 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Item', () => {
+  const merchi = new Merchi();
+  const item = new merchi.Item();
+  expect(item).toBeTruthy();
+});
+
+test('totalCost', () => {
+  const merchi = new Merchi();
+  const item = new merchi.Item();
+  expect(item.totalCost).toThrow();
+  item.quantity = 2.3;
+  expect(item.totalCost).toThrow();
+  item.cost = 4.9;
+  expect(item.totalCost()).toEqual(11.27);
+  item.quantity = null;
+  expect(item.totalCost()).toEqual(0);
+});

package/src/entities/item.ts

@@ -0,0 +1,59 @@
+import { CountryTax } from './country_tax.js';
+import { Entity } from '../entity.js';
+import { Cart } from './cart.js';
+import { Discount } from './discount.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+
+export class Item extends Entity {
+  protected static resourceName = 'items';
+  protected static singularName = 'item';
+  protected static pluralName = 'items';
+
+  @Item.property({type: Date})
+  public archived?: Date | null;
+
+  @Item.property()
+  public code?: string;
+
+  @Item.property()
+  public id?: number;
+
+  @Item.property({type: Number})
+  public quantity?: number | null;
+
+  @Item.property()
+  public description?: string;
+
+  @Item.property()
+  public cost?: number;
+
+  @Item.property({type: Number})
+  public taxAmount?: number | null;
+
+  @Item.property({type: "Cart"})
+  public cart?: Cart | null;
+
+  @Item.property({type: "Discount"})
+  public discount?: Discount | null;
+
+  @Item.property({type: "Invoice"})
+  public invoice?: Invoice | null;
+
+  @Item.property({type: "Job"})
+  public job?: Job | null;
+
+  @Item.property({type: CountryTax})
+  public taxType?: CountryTax | null;
+
+  public totalCost = () => {
+    if (this.quantity === undefined) {
+      throw 'quantity is undefined, did you forget to embed it?';
+    }
+    if (this.cost === undefined) {
+      throw 'cost is undefined, did you forget to embed it?';
+    }
+    const quantity = this.quantity === null ? 0 : this.quantity;
+    return quantity * this.cost;
+  };
+}

package/src/entities/job.test.ts

@@ -0,0 +1,95 @@
+import { Merchi } from '../merchi.js';
+import { setup, mockFetch } from '../test_util.js';
+import { InventoryStatus } from '../constants/inventory_statuses.js';
+
+setup();
+
+test('can make Job', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  expect(job).toBeTruthy();
+});
+
+test('Job deadline serialised to milliseconds in form data', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  job.deadline = new Date('Feb 28 2013 19:00:00 GMT-0500');
+  const correct = [['deadline', '1362096000']];
+  const backData = Array.from((job.toFormData() as any).entries());
+  expect(backData).toEqual(correct);
+});
+
+test('Job deadline serialised to milliseconds in JSON', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  job.deadline = new Date('Feb 28 2013 19:00:00 GMT-0500');
+  const jobJson = job.toJson();
+  expect(jobJson.deadline).toEqual(1362096000);
+});
+
+test('Job deadline serialised from milliseconds in JSON', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job().fromJson({deadline: 1362096000});
+  expect(job.deadline).toEqual(new Date('Feb 28 2013 19:00:00 GMT-0500'));
+});
+
+test('add two files to job', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  const f1 = new merchi.MerchiFile();
+  f1.fromFormFile(new File([''], '1'));
+  const f2 = new merchi.MerchiFile();
+  f2.fromFormFile(new File([''], '2'));
+  job.clientFiles = [f1, f2];
+  const fetch = mockFetch(true, {'job': {}}, 200);
+  return job.save().then(() => {
+    const data: any = Array.from(fetch.mock.calls[0][1]['body'].entries());
+    expect(data[1][1]).toEqual('0');
+    expect(data[2][1]).toEqual('1');
+    expect(data[6][1]).toEqual('1');
+    expect(data[10][1]).toEqual('2');
+  });
+});
+
+test('Get quote update job cost', () => {
+  const merchi = new Merchi();
+  const jobWithExistingProduct = new merchi.Job().fromJson(
+    {'quantity': 10, 'cost': 0, product: {'id': 1, 'name': 'test'}});
+  const jobWithNewProduct = new merchi.Job().fromJson(
+    {'quantity': 10, 'cost': 0, product: {'name': 'test'}});
+  mockFetch(true, {'quantity': 10, 'cost': 100}, 200);
+  jobWithExistingProduct.getQuote().then(job => {
+    expect(job.quantity).toEqual(10);
+    expect(job.cost).toEqual(100);
+  });
+  jobWithNewProduct.getQuote().then(job => {
+    expect(job.quantity).toEqual(10);
+    expect(job.cost).toEqual(100);
+  });
+});
+
+test('test deduct job inventory', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  const inventory = new merchi.Inventory();
+  inventory.id = 1;
+  job.id = 1;
+  const matchingInventoryOne = new merchi.MatchingInventory();
+  matchingInventoryOne.inventory = inventory;
+  matchingInventoryOne.status = InventoryStatus.CAN_DEDUCT;
+  matchingInventoryOne.deductionDate = null;
+  job.matchingInventories = [matchingInventoryOne];
+  const correct = [['inventories', '[1]']];
+  const fetch = mockFetch(true, {}, 200);
+  job.deduct([matchingInventoryOne]);
+  expect(Array.from(fetch.mock.calls[0][1]['body'].entries())).toEqual(correct);
+
+  job.bulkDeduct();
+  expect(Array.from(fetch.mock.calls[1][1]['body'].entries())).toEqual(correct);
+});
+
+test('test bulk deduct job without inventories will cause error', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  expect(job.bulkDeduct).toThrow();
+});