@merchi/sdk 1.42.22 → 1.42.24

package/src/entities/job_followup.test.ts

@@ -0,0 +1,99 @@
+import { NotificationType } from '../constants/notification_types.js';
+import { JobFollowupType } from '../constants/job_followup_types.js';
+import { Merchi } from '../merchi.js';
+
+test('job follow-up notification type is 109', () => {
+  expect(NotificationType.JOB_FOLLOWUP).toBe(109);
+});
+
+test('can make a follow-up template', () => {
+  const merchi = new Merchi();
+  const template = new merchi.JobFollowupTemplate();
+  template.fromJson({
+    id: 11,
+    name: 'Completion',
+    followupType: JobFollowupType.COMPLETION,
+    defaultKey: 'completion',
+    subject: 'Your order is complete',
+    body: 'Hi {{client_first_name}}',
+  });
+  expect(template.name).toBe('Completion');
+  expect(template.followupType).toBe(0);
+  expect(template.defaultKey).toBe('completion');
+});
+
+test('job complete posts the follow-up sequence', async () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  job.id = 85;
+  const fetch = jest.spyOn(merchi, 'authenticatedFetch').mockResolvedValue({
+    jobFollowups: [{
+      id: 4,
+      jobId: 85,
+      templateId: 11,
+      templateName: 'Review request',
+      followupType: JobFollowupType.REVIEW_REQUEST,
+      subject: 'How did we do?',
+      sendAt: '2026-11-04T09:00:00Z',
+      sendEmail: true,
+      sendSms: false,
+      status: 'pending',
+      sentAt: null,
+    }],
+  });
+
+  const rows = await job.complete([{
+    templateId: 11,
+    sendAt: '2026-11-04T09:00',
+    timezone: 'Australia/Melbourne',
+    sendEmail: true,
+    sendSms: false,
+  }]);
+
+  expect(fetch).toHaveBeenCalledWith(
+    '/jobs/85/complete/',
+    expect.objectContaining({method: 'POST'})
+  );
+  const body = fetch.mock.calls[0][1].body as FormData;
+  expect(JSON.parse(String(body.get('followups')))).toEqual([{
+    templateId: 11,
+    sendAt: '2026-11-04T09:00',
+    timezone: 'Australia/Melbourne',
+    sendEmail: true,
+    sendSms: false,
+  }]);
+  expect(rows).toHaveLength(1);
+  expect(rows[0].sendAt).toBe('2026-11-04T09:00:00Z');
+  expect(rows[0].status).toBe('pending');
+  expect(rows[0].templateName).toBe('Review request');
+});
+
+test('can update and cancel a pending follow-up', async () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  job.id = 85;
+  const fetch = jest.spyOn(merchi, 'authenticatedFetch').mockResolvedValue({
+    jobFollowup: {
+      id: 4,
+      status: 'cancelled',
+      sendAt: '2026-12-01T09:00:00Z',
+    },
+  });
+
+  const updated = await job.updateFollowup(4, {
+    sendAt: '2026-12-01T09:00',
+    timezone: 'Australia/Melbourne',
+  });
+  expect(fetch).toHaveBeenCalledWith(
+    '/jobs/85/followups/4/',
+    expect.objectContaining({method: 'PATCH'})
+  );
+  expect(updated.sendAt).toBe('2026-12-01T09:00:00Z');
+
+  const cancelled = await job.cancelFollowup(4);
+  expect(fetch).toHaveBeenCalledWith(
+    '/jobs/85/followups/4/cancel/',
+    expect.objectContaining({method: 'POST'})
+  );
+  expect(cancelled.status).toBe('cancelled');
+});

package/src/entities/job_followup.ts

@@ -0,0 +1,91 @@
+import type { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import type { Job } from './job.js';
+import type { JobFollowupTemplate } from './job_followup_template.js';
+import type { JobFollowupStatus } from '../constants/job_followup_types.js';
+import type { User } from './user.js';
+
+export interface ScheduledJobFollowup {
+  templateId: number;
+  sendAt: string;
+  timezone: string;
+  sendEmail: boolean;
+  sendSms: boolean;
+  subject?: string;
+  body?: string;
+}
+
+export interface JobFollowupUpdate {
+  sendAt?: string;
+  timezone?: string;
+  sendEmail?: boolean;
+  sendSms?: boolean;
+  subject?: string;
+  body?: string;
+}
+
+export class JobFollowup extends Entity {
+  // Scheduled rows are listed and updated under /jobs/<id>/followups/,
+  // not this collection path.
+  protected static resourceName = 'job_followups';
+  protected static singularName = 'jobFollowup';
+  protected static pluralName = 'jobFollowups';
+
+  @JobFollowup.property()
+  public id?: number;
+
+  @JobFollowup.property()
+  public jobId?: number;
+
+  @JobFollowup.property()
+  public domainId?: number;
+
+  @JobFollowup.property({type: Number})
+  public templateId?: number | null;
+
+  @JobFollowup.property()
+  public templateName?: string;
+
+  @JobFollowup.property()
+  public followupType?: number;
+
+  @JobFollowup.property()
+  public subject?: string;
+
+  @JobFollowup.property()
+  public body?: string;
+
+  // The job follow-up endpoints return an ISO timestamp, not unix seconds.
+  @JobFollowup.property()
+  public sendAt?: string;
+
+  @JobFollowup.property()
+  public sendEmail?: boolean;
+
+  @JobFollowup.property()
+  public sendSms?: boolean;
+
+  @JobFollowup.property({type: String})
+  public status?: JobFollowupStatus;
+
+  @JobFollowup.property({type: String})
+  public sentAt?: string | null;
+
+  @JobFollowup.property({type: String})
+  public lastError?: string | null;
+
+  @JobFollowup.property({type: Date})
+  public created?: Date;
+
+  @JobFollowup.property({type: 'Job'})
+  public job?: Job;
+
+  @JobFollowup.property({type: 'Domain'})
+  public domain?: Domain;
+
+  @JobFollowup.property({type: 'JobFollowupTemplate'})
+  public template?: JobFollowupTemplate;
+
+  @JobFollowup.property({type: 'User'})
+  public createdBy?: User;
+}

package/src/entities/job_followup_template.ts

@@ -0,0 +1,45 @@
+import type { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import type { User } from './user.js';
+
+export class JobFollowupTemplate extends Entity {
+  protected static resourceName = 'job_followup_templates';
+  protected static singularName = 'jobFollowupTemplate';
+  protected static pluralName = 'jobFollowupTemplates';
+
+  @JobFollowupTemplate.property({type: Date})
+  public archived?: Date | null;
+
+  @JobFollowupTemplate.property()
+  public id?: number;
+
+  @JobFollowupTemplate.property()
+  public name?: string;
+
+  @JobFollowupTemplate.property()
+  public followupType?: number;
+
+  @JobFollowupTemplate.property({type: String})
+  public defaultKey?: string | null;
+
+  @JobFollowupTemplate.property()
+  public subject?: string;
+
+  @JobFollowupTemplate.property()
+  public body?: string;
+
+  @JobFollowupTemplate.property({type: Date})
+  public created?: Date;
+
+  @JobFollowupTemplate.property({type: Date})
+  public updated?: Date;
+
+  @JobFollowupTemplate.property({type: Date})
+  public removed?: Date | null;
+
+  @JobFollowupTemplate.property({type: 'Domain'})
+  public domain?: Domain;
+
+  @JobFollowupTemplate.property({type: 'User'})
+  public createdBy?: User;
+}

package/src/index.ts

@@ -10,6 +10,10 @@ export type {
   DomainAnalyticsResponse,
   ProfileAnalyticsSummaryMetric,
 } from './entities/agent_token_analytics.js';
+export type {
+  JobFollowupUpdate,
+  ScheduledJobFollowup,
+} from './entities/job_followup.js';
 import { AgentSkill } from './entities/agent_skill.js';
 import { AgentSkillVersion } from './entities/agent_skill_version.js';
 import { AgentSkillApproval } from './entities/agent_skill_approval.js';
@@ -49,6 +53,8 @@ import { Invoice } from './entities/invoice.js';
 import { Item } from './entities/item.js';
 import { Job } from './entities/job.js';
 import { JobComment } from './entities/job_comment.js';
+import { JobFollowup } from './entities/job_followup.js';
+import { JobFollowupTemplate } from './entities/job_followup_template.js';
 import { JobNote } from './entities/job_note.js';
 import { JobOperationLog } from './entities/job_operation_log.js';
 import { MatchingInventory } from './entities/matching_inventory.js';
@@ -146,6 +152,8 @@ export {
   Item,
   Job,
   JobComment,
+  JobFollowup,
+  JobFollowupTemplate,
   JobNote,
   JobOperationLog,
   MatchingInventory,

package/src/merchi.ts

@@ -6,6 +6,8 @@ import {
 import { AutomaticPaymentRelationship } from './entities/automatic_payment_relationship.js';
 import { Session } from './entities/session.js';
 import { JobComment } from './entities/job_comment.js';
+import { JobFollowup } from './entities/job_followup.js';
+import { JobFollowupTemplate } from './entities/job_followup_template.js';
 import { JobNote } from './entities/job_note.js';
 import { JobOperationLog } from './entities/job_operation_log.js';
 import { Domain } from './entities/domain.js';
@@ -130,6 +132,8 @@ export class Merchi {
   public Inventory: typeof Inventory;
   public InventoryGroup: typeof InventoryGroup;
   public JobComment: typeof JobComment;
+  public JobFollowup: typeof JobFollowup;
+  public JobFollowupTemplate: typeof JobFollowupTemplate;
   public JobNote: typeof JobNote;
   public JobOperationLog: typeof JobOperationLog;
   public VariationOption: typeof VariationOption;
@@ -365,6 +369,10 @@ export class Merchi {
     this.MerchiFile = this.setupClass(MerchiFile) as typeof MerchiFile;
     this.User = this.setupClass(User) as typeof User;
     this.JobComment = this.setupClass(JobComment) as typeof JobComment;
+    this.JobFollowup = this.setupClass(JobFollowup) as typeof JobFollowup;
+    this.JobFollowupTemplate = this.setupClass(
+      JobFollowupTemplate
+    ) as typeof JobFollowupTemplate;
     this.JobNote = this.setupClass(JobNote) as typeof JobNote;
     this.JobOperationLog = this.setupClass(JobOperationLog) as typeof JobOperationLog;
     this.VariationOption = this.setupClass(