@merchi/sdk 1.40.2

package/src/entities/job.ts

@@ -0,0 +1,401 @@
+import { Address } from './address.js';
+import { Assignment } from './assignment.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { Domain } from './domain.js';
+import { DomainTag } from './domain_tag.js';
+import { Draft } from './draft.js';
+import { DraftComment } from './draft_comment.js';
+import { EmailAddress } from './email_address.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { MatchingInventory } from './matching_inventory.js';
+import { InternalTag } from './internal_tag.js';
+import { Invoice } from './invoice.js';
+import { JobComment } from './job_comment.js';
+import { JobNote } from './job_note.js';
+import { JobOperationLog } from './job_operation_log.js';
+import { Notification } from './notification.js';
+import { PhoneNumber } from './phone_number.js';
+import { Product } from './product.js';
+import { Reminder } from './reminder.js';
+import { RequestOptions } from '../request.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+import { Variation } from './variation.js';
+import { VariationsGroup } from './variations_group.js';
+import { InventoryStatus } from '../constants/inventory_statuses.js';
+import { Item } from './item.js';
+
+
+export class Job extends Entity {
+  protected static resourceName = 'jobs';
+  protected static singularName = 'job';
+  protected static pluralName = 'jobs';
+
+  @Job.property({type: Date})
+  public archived?: Date | null;
+
+  @Job.property()
+  public id?: number;
+
+  @Job.property()
+  public jobType?: number;
+
+  @Job.property()
+  public quantity?: number;
+
+  @Job.property()
+  public currency?: string;
+
+  @Job.property({arrayType: 'JobNote'})
+  public jobNotes?: JobNote[];
+
+  @Job.property({arrayType: 'JobOperationLog'})
+  public operationLogs?: JobOperationLog[];
+
+  @Job.property({type: String})
+  public shopifyShopUrl?: string | null;
+
+  @Job.property()
+  public shopifyOrderId?: string;
+
+  @Job.property()
+  public shopifyOrderLineItemId?: string;
+
+  @Job.property({type: Number})
+  public productionStatus?: number | null;
+
+  @Job.property({type: Number})
+  public designStatus?: number | null;
+
+  @Job.property({type: Number})
+  public supplyChainRequestStatus?: number | null;
+
+  @Job.property()
+  public needsDrafting?: boolean;
+
+  @Job.property()
+  public assignToAgent?: boolean;
+
+  @Job.property({ type: Date })
+  public agentLastRunAt?: Date | null;
+
+  @Job.property({ type: Date })
+  public agentNextCheckAt?: Date | null;
+
+  @Job.property()
+  public needsGroupBuy?: boolean;
+
+  @Job.property()
+  public needsProduction?: boolean;
+
+  @Job.property()
+  public needsShipping?: boolean;
+
+  @Job.property()
+  public sendWhatsapp?: boolean;
+
+  @Job.property()
+  public needsInvoicing?: boolean;
+
+  @Job.property()
+  public needsInventory?: boolean;
+
+  @Job.property()
+  public needsSupplyChainRequest?: boolean;
+
+  @Job.property()
+  public showProductionFilesToClient?: boolean;
+
+  @Job.property()
+  public allowClientDraftContribution?: boolean;
+
+  @Job.property()
+  public quoteSet?: boolean;
+
+  @Job.property()
+  public jobInfoApprovedByClient?: boolean;
+
+  @Job.property({type: Number})
+  public groupBuyStatus?: number | null;
+
+  @Job.property({type: Number})
+  public paymentStatus?: number | null;
+
+  @Job.property({type: Date})
+  public deductionDate?: Date | null;
+
+  @Job.property({type: Number})
+  public shippingStatus?: number | null;
+
+  @Job.property()
+  public completed?: boolean;
+
+  @Job.property()
+  public callToActions?: string;
+
+  @Job.property()
+  public callToActionDetails?: any[];
+
+  @Job.property()
+  public priority?: number;
+
+  @Job.property({type: Number})
+  public jobWeight?: number | null;
+
+  @Job.property({type: Number})
+  public jobVolume?: number | null;
+
+  @Job.property()
+  public received?: Date;
+
+  @Job.property()
+  public deadline?: Date;
+
+  @Job.property()
+  public updated?: Date;
+
+  @Job.property({type: Date})
+  public dateLastActioned?: Date | null;
+
+  @Job.property({type: Date})
+  public dateFirstActioned?: Date | null;
+
+  @Job.property()
+  public groupBuyProductionStarted?: Date;
+
+  @Job.property()
+  public automaticPriceEnabled?: boolean;
+
+  @Job.property()
+  public dropShip?: boolean;
+
+  @Job.property()
+  public pickUp?: boolean;
+
+  @Job.property({type: Number})
+  public costPerUnit?: number | null;
+
+  @Job.property({type: Number})
+  public cost?: number | null;
+
+  @Job.property({type: Number})
+  public taxAmount?: number | null;
+
+  @Job.property({type: Number})
+  public totalCost?: number | null;
+
+  @Job.property({embeddedByDefault: false})
+  public inventoriesStatus?: InventoryStatus;
+
+  @Job.property({embeddedByDefault: false})
+  public unreadNotificationsCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public unreadJobInfoNotificationsCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public unreadJobDraftingNotificationsCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public unreadJobProductionNotificationsCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public unreadJobShippingNotificationsCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public unreadJobInvoicingNotificationsCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public limitedStock?: boolean;
+
+  @Job.property({embeddedByDefault: false})
+  public inventoryCount?: number;
+
+  @Job.property({embeddedByDefault: false})
+  public inventorySufficient?: boolean;
+
+  @Job.property({arrayType: 'Item'})
+  public items?: Item[];
+
+  @Job.property({arrayType: 'Draft'})
+  public drafts?: Draft[];
+
+  @Job.property({arrayType: 'Draft'})
+  public sharedDrafts?: Draft[];
+
+  @Job.property({arrayType: 'Draft'})
+  public ownDrafts?: Draft[];
+
+  @Job.property({arrayType: 'JobComment'})
+  public comments?: JobComment[];
+
+  @Job.property()
+  public client?: User;
+
+  @Job.property()
+  public clientBrowser?: string;
+
+  @Job.property()
+  public clientDevice?: string;
+
+  @Job.property()
+  public clientOs?: string;
+
+  @Job.property()
+  public clientIp?: string;
+
+  @Job.property()
+  public clientOrigin?: string;
+
+  @Job.property({type: User})
+  public manager?: User | null;
+
+  @Job.property({type: User})
+  public designer?: User | null;
+
+  @Job.property({type: Company})
+  public clientCompany?: Company | null;
+
+  @Job.property({arrayType: 'User'})
+  public notificationSubscribers?: User[];
+
+  @Job.property({type: PhoneNumber})
+  public clientPhone?: PhoneNumber | null;
+
+  @Job.property({type: EmailAddress})
+  public clientEmail?: EmailAddress | null;
+
+  @Job.property({type: PhoneNumber})
+  public clientCompanyPhone?: PhoneNumber | null;
+
+  @Job.property({type: EmailAddress})
+  public clientCompanyEmail?: EmailAddress | null;
+
+  @Job.property({type: 'Product'})
+  public product?: Product;
+
+  @Job.property()
+  public supplyChainRequestProduct?: Product;
+
+  @Job.property({arrayType: 'DraftComment'})
+  public draftComments?: DraftComment[];
+
+  @Job.property()
+  public preDraftCommentsCount?: number;
+
+  @Job.property({type: CountryTax})
+  public taxType?: CountryTax | null;
+
+  @Job.property({arrayType: 'InternalTag'})
+  public internalTags?: InternalTag[];
+
+  @Job.property({arrayType: 'DomainTag'})
+  public tags?: DomainTag[];
+
+  @Job.property({arrayType: 'Product'})
+  public createdProducts?: Product[];
+
+  @Job.property({type: Address})
+  public shipping?: Address | null;
+
+  @Job.property({type: Address})
+  public productionShippingAddress?: Address | null;
+
+  @Job.property()
+  public domain?: Domain;
+
+  @Job.property({type: Invoice})
+  public invoice?: Invoice | null;
+
+  @Job.property({arrayType: 'MerchiFile'})
+  public productionFiles?: MerchiFile[];
+
+  @Job.property({arrayType: 'MerchiFile'})
+  public clientFiles?: MerchiFile[];
+
+  @Job.property({type: Shipment})
+  public shipment?: Shipment | null;
+
+  @Job.property({arrayType: 'MatchingInventory'})
+  public matchingInventories?: MatchingInventory[];
+
+  @Job.property({arrayType: 'VariationsGroup'})
+  public variationsGroups?: VariationsGroup[];
+
+  @Job.property({arrayType: 'Variation'})
+  public variations?: Variation[];
+
+  @Job.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+
+  @Job.property({arrayType: 'Assignment'})
+  public assignments?: Assignment[];
+
+  @Job.property({arrayType: 'Reminder'})
+  public reminders?: Reminder[];
+
+  @Job.property()
+  public supplyAssignment?: Assignment;
+
+  @Job.property()
+  public supplyJob?: Job;
+
+  @Job.property()
+  public supplyQuoteTotalCost?: number;
+
+  @Job.property()
+  public hasValidVolume?: boolean;
+
+  @Job.property()
+  public hasValidWeight?: boolean;
+
+  @Job.property()
+  public isNewClient?: boolean;
+
+  public getQuote = () => {
+    const resource = '/specialised-order-estimate/';
+    const data = this.toFormData({excludeOld: false});
+    const fetchOptions: RequestOptions = {method: 'POST', body: data};
+    fetchOptions.query = [];
+    fetchOptions.query.push(['skip_rights', 'y']);
+    // insert product id to query for debug purposes
+    fetchOptions.query.push([
+      'product_id',
+      this.product!.id ? this.product!.id!.toString() : 'null'
+    ]);
+
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => { this.fromJson(data, {makeDirty: true});
+        return this;});
+  };
+
+  public deduct = (matchingInventories: MatchingInventory[]) => {
+    const resource = `/jobs/${this.id}/inventories_subtract/`;
+    const inventoriesNeedToBeDeducted = matchingInventories.map(
+      matchingInventory => matchingInventory.inventory!.id);
+    const embed = {matchingInventories: {inventory: {}, group: {}}};
+    const data = new FormData();
+    data.append('inventories', JSON.stringify(inventoriesNeedToBeDeducted));
+    const fetchOptions: RequestOptions = {
+      method: 'POST',
+      body: data,
+      query: [['embed', JSON.stringify(embed)]]
+    };
+
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => {
+        this.fromJson(data);
+        return this;});
+  };
+
+  public bulkDeduct = () => {
+    if (this.matchingInventories === undefined) {
+      const err = 'matchingInventories is undefined, did you forget to embed' +
+        ' it?';
+      throw new Error(err);
+    }
+    return this.deduct(this.matchingInventories);
+  };
+}

package/src/entities/job_comment.test.ts

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

package/src/entities/job_comment.ts

@@ -0,0 +1,53 @@
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Job } from './job.js';
+import { Notification } from './notification.js';
+import { User } from './user.js';
+
+export class JobComment extends Entity {
+  protected static resourceName = 'job_comments';
+  protected static singularName = 'jobComment';
+  protected static pluralName = 'jobComments';
+
+  @JobComment.property({type: Date})
+  public archived?: Date | null;
+
+  @JobComment.property()
+  public id?: number;
+
+  @JobComment.property({type: Date})
+  public date?: Date | null;
+
+  @JobComment.property()
+  public text?: string;
+
+  @JobComment.property()
+  public sendSms?: boolean;
+
+  @JobComment.property()
+  public sendEmail?: boolean;
+
+  @JobComment.property()
+  public sendWhatsapp?: boolean;
+
+  @JobComment.property()
+  public openToClient?: boolean;
+
+  @JobComment.property()
+  public urgency?: number;
+
+  @JobComment.property({arrayType: "MerchiFile"})
+  public files?: MerchiFile[];
+
+  @JobComment.property({arrayType: 'User'})
+  public forwards?: User[];
+
+  @JobComment.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+
+  @JobComment.property()
+  public job?: Job;
+
+  @JobComment.property()
+  public user?: User;
+}

package/src/entities/job_note.ts

@@ -0,0 +1,40 @@
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { Job } from './job.js';
+import { User } from './user.js';
+
+export class JobNote extends Entity {
+  protected static resourceName = 'job_notes';
+  protected static singularName = 'jobNote';
+  protected static pluralName = 'jobNotes';
+
+  @JobNote.property({type: Date})
+  public archived?: Date | null;
+
+  @JobNote.property()
+  public id?: number;
+
+  @JobNote.property()
+  public noteType?: number;
+
+  @JobNote.property()
+  public richText?: string;
+
+  @JobNote.property({type: Date})
+  public creationDate?: Date | null;
+
+  @JobNote.property({type: Date})
+  public lastEditedTime?: Date | null;
+
+  @JobNote.property({arrayType: 'MerchiFile'})
+  public files?: MerchiFile[];
+
+  @JobNote.property({type: 'Job'})
+  public job?: Job;
+
+  @JobNote.property({type: 'User'})
+  public createdBy?: User;
+
+  @JobNote.property({type: 'User'})
+  public lastEditedBy?: User;
+}

package/src/entities/job_operation_log.test.ts

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

package/src/entities/job_operation_log.ts

@@ -0,0 +1,41 @@
+import { Entity } from '../entity.js';
+import type { Job } from './job.js';
+import { User } from './user.js';
+
+const jsonPropertyType = class {};
+
+export class JobOperationLog extends Entity {
+  protected static resourceName = 'job_operation_logs';
+  protected static singularName = 'jobOperationLog';
+  protected static pluralName = 'jobOperationLogs';
+
+  @JobOperationLog.property({type: String})
+  public id?: string;
+
+  @JobOperationLog.property({type: 'Job'})
+  public job?: Job | null;
+
+  @JobOperationLog.property({type: User})
+  public user?: User | null;
+
+  @JobOperationLog.property({type: String})
+  public sourceType?: string;
+
+  @JobOperationLog.property({type: Boolean})
+  public aiInvolved?: boolean;
+
+  @JobOperationLog.property({type: String})
+  public action?: string;
+
+  @JobOperationLog.property({type: jsonPropertyType})
+  public payloadJson?: Record<string, unknown> | null;
+
+  @JobOperationLog.property({type: jsonPropertyType})
+  public changesJson?: Record<string, unknown> | null;
+
+  @JobOperationLog.property({type: jsonPropertyType})
+  public operationJson?: Record<string, unknown> | null;
+
+  @JobOperationLog.property({type: Date})
+  public createdAt?: Date | null;
+}

package/src/entities/matching_inventory.ts

@@ -0,0 +1,29 @@
+import { Entity } from '../entity.js';
+import { Job } from './job.js';
+import { Inventory } from './inventory.js';
+import { VariationsGroup } from './variations_group.js';
+import { InventoryStatus } from '../constants/inventory_statuses.js';
+
+export class MatchingInventory extends Entity {
+  protected static resourceName = 'matching_inventories';
+  protected static singularName = 'matchingInventory';
+  protected static pluralName = 'matchingInventories';
+
+  @MatchingInventory.property({type: Date})
+  public archived?: Date | null;
+
+  @MatchingInventory.property({type: Date})
+  public deductionDate?: Date | null;
+
+  @MatchingInventory.property()
+  public job?: Job;
+
+  @MatchingInventory.property({type: 'VariationsGroup'})
+  public group?: VariationsGroup | null;
+
+  @MatchingInventory.property({type: Inventory})
+  public inventory?: Inventory | null;
+
+  @MatchingInventory.property()
+  public status?: InventoryStatus;
+}

package/src/entities/notification.test.ts

@@ -0,0 +1,58 @@
+import { Merchi } from '../merchi.js';
+import { setup, mockFetch } from '../test_util.js';
+
+setup();
+
+test('can make Notification', () => {
+  const merchi = new Merchi();
+  const notification = new merchi.Notification();
+  expect(notification).toBeTruthy();
+});
+
+test('can list notifications with notificationSender filter', () => {
+  const merchi = new Merchi();
+  const fetch = mockFetch(true, {
+    'notifications': [],
+    'available': 0,
+    'count': 0
+  }, 200);
+  const options = { notificationSender: 123 };
+  return merchi.Notification.list(options).then(() => {
+    const query = fetch.mock.calls[0][1]['query'];
+    expect(query).toContainEqual(['notification_sender', '123']);
+  });
+});
+
+test('list forwards skipCount=true as skip_count query param', () => {
+  const merchi = new Merchi();
+  const fetch = mockFetch(true, {
+    'notifications': [],
+    // backend returns ``available: null`` when skip_count was honoured
+    'available': null,
+    'count': 0
+  }, 200);
+  const options = { skipCount: true };
+  return merchi.Notification.list(options).then((response) => {
+    const query = fetch.mock.calls[0][1]['query'];
+    expect(query).toContainEqual(['skip_count', 'true']);
+    // ``available`` must round-trip as ``null``; the typed metadata
+    // is now ``number | null``, so consumers can detect the absence.
+    expect(response.metadata.available).toBeNull();
+  });
+});
+
+test('list omits skip_count when skipCount is not set', () => {
+  const merchi = new Merchi();
+  const fetch = mockFetch(true, {
+    'notifications': [],
+    'available': 0,
+    'count': 0
+  }, 200);
+  return merchi.Notification.list({}).then(() => {
+    const query = fetch.mock.calls[0][1]['query'];
+    const skipCountEntries = query.filter(
+      (entry: [string, string]) => entry[0] === 'skip_count'
+    );
+    expect(skipCountEntries).toEqual([]);
+  });
+});