@merchi/sdk 1.42.22 → 1.42.23

package/dist/constants/index.d.ts

@@ -17,9 +17,10 @@ import * as production_status from './job/production_status.js';
 import * as shipment_status from './job/shipment_status.js';
 import * as call_to_actions from './call_to_actions.js';
 import * as domain_types from './domain_types.js';
+import * as job_followup_types from './job_followup_types.js';
 import * as job_status from './job_status.js';
 import * as white_label_accessibilities from './white_label_accessibilities.js';
 import * as robots_meta_directives from './robots_meta_directives.js';
 import * as inventory_statuses from './inventory_statuses.js';
 import * as discount_types from './discount_types.js';
-export { discount_types, field_types, input_types, inventory_statuses, platform, robots_meta_directives, system_roles, user_types, white_label_accessibilities, roles, notification_sections, notification_types, shipment_services, shipment_companies, auto_assign_production_on_actions, product_types, drafting_status, job_types, payment_status, production_status, shipment_status, call_to_actions, domain_types, job_status, };
+export { discount_types, field_types, input_types, inventory_statuses, platform, robots_meta_directives, system_roles, user_types, white_label_accessibilities, roles, notification_sections, notification_types, shipment_services, shipment_companies, auto_assign_production_on_actions, product_types, drafting_status, job_followup_types, job_types, payment_status, production_status, shipment_status, call_to_actions, domain_types, job_status, };

package/dist/constants/index.js

@@ -17,9 +17,10 @@ import * as production_status from './job/production_status.js';
 import * as shipment_status from './job/shipment_status.js';
 import * as call_to_actions from './call_to_actions.js';
 import * as domain_types from './domain_types.js';
+import * as job_followup_types from './job_followup_types.js';
 import * as job_status from './job_status.js';
 import * as white_label_accessibilities from './white_label_accessibilities.js';
 import * as robots_meta_directives from './robots_meta_directives.js';
 import * as inventory_statuses from './inventory_statuses.js';
 import * as discount_types from './discount_types.js';
-export { discount_types, field_types, input_types, inventory_statuses, platform, robots_meta_directives, system_roles, user_types, white_label_accessibilities, roles, notification_sections, notification_types, shipment_services, shipment_companies, auto_assign_production_on_actions, product_types, drafting_status, job_types, payment_status, production_status, shipment_status, call_to_actions, domain_types, job_status, };
+export { discount_types, field_types, input_types, inventory_statuses, platform, robots_meta_directives, system_roles, user_types, white_label_accessibilities, roles, notification_sections, notification_types, shipment_services, shipment_companies, auto_assign_production_on_actions, product_types, drafting_status, job_followup_types, job_types, payment_status, production_status, shipment_status, call_to_actions, domain_types, job_status, };

package/dist/constants/job_followup_types.d.ts

@@ -0,0 +1,8 @@
+export declare enum JobFollowupType {
+    COMPLETION = 0,
+    REVIEW_REQUEST = 1,
+    REORDER = 2,
+    FEEDBACK = 3,
+    CUSTOM = 4
+}
+export type JobFollowupStatus = 'pending' | 'sent' | 'cancelled' | 'failed';

package/dist/constants/job_followup_types.js

@@ -0,0 +1,8 @@
+export var JobFollowupType;
+(function (JobFollowupType) {
+    JobFollowupType[JobFollowupType["COMPLETION"] = 0] = "COMPLETION";
+    JobFollowupType[JobFollowupType["REVIEW_REQUEST"] = 1] = "REVIEW_REQUEST";
+    JobFollowupType[JobFollowupType["REORDER"] = 2] = "REORDER";
+    JobFollowupType[JobFollowupType["FEEDBACK"] = 3] = "FEEDBACK";
+    JobFollowupType[JobFollowupType["CUSTOM"] = 4] = "CUSTOM";
+})(JobFollowupType || (JobFollowupType = {}));

package/dist/constants/notification_types.d.ts

@@ -97,5 +97,6 @@ export declare enum NotificationType {
     REFERRER_ASSIGNED = 105,
     REFERRER_JOB_PAID = 106,
     REFERRER_JOB_RECEIVED = 107,
-    FULFILLMENT_PARTNER_INVITED = 108
+    FULFILLMENT_PARTNER_INVITED = 108,
+    JOB_FOLLOWUP = 109
 }

package/dist/constants/notification_types.js

@@ -99,4 +99,5 @@ export var NotificationType;
     NotificationType[NotificationType["REFERRER_JOB_PAID"] = 106] = "REFERRER_JOB_PAID";
     NotificationType[NotificationType["REFERRER_JOB_RECEIVED"] = 107] = "REFERRER_JOB_RECEIVED";
     NotificationType[NotificationType["FULFILLMENT_PARTNER_INVITED"] = 108] = "FULFILLMENT_PARTNER_INVITED";
+    NotificationType[NotificationType["JOB_FOLLOWUP"] = 109] = "JOB_FOLLOWUP";
 })(NotificationType || (NotificationType = {}));

package/dist/entities/domain.d.ts

@@ -13,6 +13,7 @@ import { Job } from './job.js';
 import { User } from './user.js';
 import { Notification } from './notification.js';
 import { Product } from './product.js';
+import { JobFollowupTemplate } from './job_followup_template.js';
 import { Reminder } from './reminder.js';
 import { Session } from './session.js';
 import { SupplyDomain } from './supply_domain.js';
@@ -493,6 +494,7 @@ export declare class Domain extends Entity {
     categories?: Category[];
     notifications?: Notification[];
     reminders?: Reminder[];
+    jobFollowupTemplates?: JobFollowupTemplate[];
     products?: Product[];
     supplyProducts?: SupplyDomain[];
     jobs?: Job[];

package/dist/entities/domain.js

@@ -530,6 +530,10 @@ var Domain = /** @class */ (function (_super) {
         Domain.property({ arrayType: 'Reminder' }),
         __metadata("design:type", Array)
     ], Domain.prototype, "reminders", void 0);
+    __decorate([
+        Domain.property({ arrayType: 'JobFollowupTemplate' }),
+        __metadata("design:type", Array)
+    ], Domain.prototype, "jobFollowupTemplates", void 0);
     __decorate([
         Domain.property({ arrayType: 'Product' }),
         __metadata("design:type", Array)

package/dist/entities/job.d.ts

@@ -13,6 +13,7 @@ import { MatchingInventory } from './matching_inventory.js';
 import { InternalTag } from './internal_tag.js';
 import { Invoice } from './invoice.js';
 import { JobComment } from './job_comment.js';
+import { JobFollowup, JobFollowupUpdate, ScheduledJobFollowup } from './job_followup.js';
 import { JobNote } from './job_note.js';
 import { JobOperationLog } from './job_operation_log.js';
 import { Notification } from './notification.js';
@@ -143,6 +144,7 @@ export declare class Job extends Entity {
     notifications?: Notification[];
     assignments?: Assignment[];
     reminders?: Reminder[];
+    jobFollowups?: JobFollowup[];
     supplyAssignment?: Assignment;
     supplyJob?: Job;
     supplyQuoteTotalCost?: number;
@@ -153,4 +155,11 @@ export declare class Job extends Entity {
     getQuote: () => Promise<this>;
     deduct: (matchingInventories: MatchingInventory[]) => Promise<this>;
     bulkDeduct: () => Promise<this>;
+    private jobResourceId;
+    private readFollowups;
+    private readFollowup;
+    listFollowups: () => Promise<JobFollowup[]>;
+    complete: (followups?: ScheduledJobFollowup[]) => Promise<JobFollowup[]>;
+    updateFollowup: (followupId: number, changes: JobFollowupUpdate) => Promise<JobFollowup>;
+    cancelFollowup: (followupId: number) => Promise<JobFollowup>;
 }

package/dist/entities/job.js

@@ -81,6 +81,53 @@ var Job = /** @class */ (function (_super) {
             }
             return _this.deduct(_this.matchingInventories);
         };
+        _this.jobResourceId = function () {
+            if (_this.id === undefined || _this.id === null) {
+                throw new Error('id is undefined, did you forget to set it?');
+            }
+            return _this.id;
+        };
+        _this.readFollowups = function (data) {
+            var _a;
+            var rows = (_a = data === null || data === void 0 ? void 0 : data.jobFollowups) !== null && _a !== void 0 ? _a : [];
+            return rows.map(function (row) { return new _this.merchi.JobFollowup().fromJson(row); });
+        };
+        _this.readFollowup = function (data) {
+            var _a;
+            return new _this.merchi.JobFollowup().fromJson((_a = data === null || data === void 0 ? void 0 : data.jobFollowup) !== null && _a !== void 0 ? _a : data);
+        };
+        _this.listFollowups = function () {
+            var resource = "/jobs/".concat(_this.jobResourceId(), "/followups/");
+            var fetchOptions = { method: 'GET', query: [] };
+            return _this.merchi.authenticatedFetch(resource, fetchOptions).
+                then(function (data) { return _this.readFollowups(data); });
+        };
+        _this.complete = function (followups) {
+            if (followups === void 0) { followups = []; }
+            var resource = "/jobs/".concat(_this.jobResourceId(), "/complete/");
+            var data = new FormData();
+            data.append('followups', JSON.stringify(followups));
+            var fetchOptions = { method: 'POST', body: data, query: [] };
+            return _this.merchi.authenticatedFetch(resource, fetchOptions).
+                then(function (payload) { return _this.readFollowups(payload); });
+        };
+        _this.updateFollowup = function (followupId, changes) {
+            var resource = "/jobs/".concat(_this.jobResourceId(), "/followups/").concat(followupId, "/");
+            var fetchOptions = {
+                method: 'PATCH',
+                headers: { 'Content-Type': 'application/json' },
+                body: JSON.stringify(changes),
+                query: [],
+            };
+            return _this.merchi.authenticatedFetch(resource, fetchOptions).
+                then(function (data) { return _this.readFollowup(data); });
+        };
+        _this.cancelFollowup = function (followupId) {
+            var resource = "/jobs/".concat(_this.jobResourceId(), "/followups/").concat(followupId, "/cancel/");
+            var fetchOptions = { method: 'POST', query: [] };
+            return _this.merchi.authenticatedFetch(resource, fetchOptions).
+                then(function (data) { return _this.readFollowup(data); });
+        };
         return _this;
     }
     Job.resourceName = 'jobs';
@@ -542,6 +589,10 @@ var Job = /** @class */ (function (_super) {
         Job.property({ arrayType: 'Reminder' }),
         __metadata("design:type", Array)
     ], Job.prototype, "reminders", void 0);
+    __decorate([
+        Job.property({ arrayType: 'JobFollowup' }),
+        __metadata("design:type", Array)
+    ], Job.prototype, "jobFollowups", void 0);
     __decorate([
         Job.property(),
         __metadata("design:type", Assignment)

package/dist/entities/job_followup.d.ts

@@ -0,0 +1,47 @@
+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 declare class JobFollowup extends Entity {
+    protected static resourceName: string;
+    protected static singularName: string;
+    protected static pluralName: string;
+    id?: number;
+    jobId?: number;
+    domainId?: number;
+    templateId?: number | null;
+    templateName?: string;
+    followupType?: number;
+    subject?: string;
+    body?: string;
+    sendAt?: string;
+    sendEmail?: boolean;
+    sendSms?: boolean;
+    status?: JobFollowupStatus;
+    sentAt?: string | null;
+    lastError?: string | null;
+    created?: Date;
+    job?: Job;
+    domain?: Domain;
+    template?: JobFollowupTemplate;
+    createdBy?: User;
+}

package/dist/entities/job_followup.js

@@ -0,0 +1,114 @@
+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';
+var JobFollowup = /** @class */ (function (_super) {
+    __extends(JobFollowup, _super);
+    function JobFollowup() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    // Scheduled rows are listed and updated under /jobs/<id>/followups/,
+    // not this collection path.
+    JobFollowup.resourceName = 'job_followups';
+    JobFollowup.singularName = 'jobFollowup';
+    JobFollowup.pluralName = 'jobFollowups';
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", Number)
+    ], JobFollowup.prototype, "id", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", Number)
+    ], JobFollowup.prototype, "jobId", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", Number)
+    ], JobFollowup.prototype, "domainId", void 0);
+    __decorate([
+        JobFollowup.property({ type: Number }),
+        __metadata("design:type", Object)
+    ], JobFollowup.prototype, "templateId", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", String)
+    ], JobFollowup.prototype, "templateName", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", Number)
+    ], JobFollowup.prototype, "followupType", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", String)
+    ], JobFollowup.prototype, "subject", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", String)
+    ], JobFollowup.prototype, "body", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", String)
+    ], JobFollowup.prototype, "sendAt", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", Boolean)
+    ], JobFollowup.prototype, "sendEmail", void 0);
+    __decorate([
+        JobFollowup.property(),
+        __metadata("design:type", Boolean)
+    ], JobFollowup.prototype, "sendSms", void 0);
+    __decorate([
+        JobFollowup.property({ type: String }),
+        __metadata("design:type", String)
+    ], JobFollowup.prototype, "status", void 0);
+    __decorate([
+        JobFollowup.property({ type: String }),
+        __metadata("design:type", Object)
+    ], JobFollowup.prototype, "sentAt", void 0);
+    __decorate([
+        JobFollowup.property({ type: String }),
+        __metadata("design:type", Object)
+    ], JobFollowup.prototype, "lastError", void 0);
+    __decorate([
+        JobFollowup.property({ type: Date }),
+        __metadata("design:type", Date)
+    ], JobFollowup.prototype, "created", void 0);
+    __decorate([
+        JobFollowup.property({ type: 'Job' }),
+        __metadata("design:type", Function)
+    ], JobFollowup.prototype, "job", void 0);
+    __decorate([
+        JobFollowup.property({ type: 'Domain' }),
+        __metadata("design:type", Function)
+    ], JobFollowup.prototype, "domain", void 0);
+    __decorate([
+        JobFollowup.property({ type: 'JobFollowupTemplate' }),
+        __metadata("design:type", Function)
+    ], JobFollowup.prototype, "template", void 0);
+    __decorate([
+        JobFollowup.property({ type: 'User' }),
+        __metadata("design:type", Function)
+    ], JobFollowup.prototype, "createdBy", void 0);
+    return JobFollowup;
+}(Entity));
+export { JobFollowup };

package/dist/entities/job_followup.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/job_followup.test.js

@@ -0,0 +1,138 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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', function () {
+    expect(NotificationType.JOB_FOLLOWUP).toBe(109);
+});
+test('can make a follow-up template', function () {
+    var merchi = new Merchi();
+    var 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', function () { return __awaiter(void 0, void 0, void 0, function () {
+    var merchi, job, fetch, rows, body;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                merchi = new Merchi();
+                job = new merchi.Job();
+                job.id = 85;
+                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,
+                        }],
+                });
+                return [4 /*yield*/, job.complete([{
+                            templateId: 11,
+                            sendAt: '2026-11-04T09:00',
+                            timezone: 'Australia/Melbourne',
+                            sendEmail: true,
+                            sendSms: false,
+                        }])];
+            case 1:
+                rows = _a.sent();
+                expect(fetch).toHaveBeenCalledWith('/jobs/85/complete/', expect.objectContaining({ method: 'POST' }));
+                body = fetch.mock.calls[0][1].body;
+                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');
+                return [2 /*return*/];
+        }
+    });
+}); });
+test('can update and cancel a pending follow-up', function () { return __awaiter(void 0, void 0, void 0, function () {
+    var merchi, job, fetch, updated, cancelled;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                merchi = new Merchi();
+                job = new merchi.Job();
+                job.id = 85;
+                fetch = jest.spyOn(merchi, 'authenticatedFetch').mockResolvedValue({
+                    jobFollowup: {
+                        id: 4,
+                        status: 'cancelled',
+                        sendAt: '2026-12-01T09:00:00Z',
+                    },
+                });
+                return [4 /*yield*/, job.updateFollowup(4, {
+                        sendAt: '2026-12-01T09:00',
+                        timezone: 'Australia/Melbourne',
+                    })];
+            case 1:
+                updated = _a.sent();
+                expect(fetch).toHaveBeenCalledWith('/jobs/85/followups/4/', expect.objectContaining({ method: 'PATCH' }));
+                expect(updated.sendAt).toBe('2026-12-01T09:00:00Z');
+                return [4 /*yield*/, job.cancelFollowup(4)];
+            case 2:
+                cancelled = _a.sent();
+                expect(fetch).toHaveBeenCalledWith('/jobs/85/followups/4/cancel/', expect.objectContaining({ method: 'POST' }));
+                expect(cancelled.status).toBe('cancelled');
+                return [2 /*return*/];
+        }
+    });
+}); });

package/dist/entities/job_followup_template.d.ts

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

package/dist/entities/job_followup_template.js

@@ -0,0 +1,84 @@
+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';
+var JobFollowupTemplate = /** @class */ (function (_super) {
+    __extends(JobFollowupTemplate, _super);
+    function JobFollowupTemplate() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    JobFollowupTemplate.resourceName = 'job_followup_templates';
+    JobFollowupTemplate.singularName = 'jobFollowupTemplate';
+    JobFollowupTemplate.pluralName = 'jobFollowupTemplates';
+    __decorate([
+        JobFollowupTemplate.property({ type: Date }),
+        __metadata("design:type", Object)
+    ], JobFollowupTemplate.prototype, "archived", void 0);
+    __decorate([
+        JobFollowupTemplate.property(),
+        __metadata("design:type", Number)
+    ], JobFollowupTemplate.prototype, "id", void 0);
+    __decorate([
+        JobFollowupTemplate.property(),
+        __metadata("design:type", String)
+    ], JobFollowupTemplate.prototype, "name", void 0);
+    __decorate([
+        JobFollowupTemplate.property(),
+        __metadata("design:type", Number)
+    ], JobFollowupTemplate.prototype, "followupType", void 0);
+    __decorate([
+        JobFollowupTemplate.property({ type: String }),
+        __metadata("design:type", Object)
+    ], JobFollowupTemplate.prototype, "defaultKey", void 0);
+    __decorate([
+        JobFollowupTemplate.property(),
+        __metadata("design:type", String)
+    ], JobFollowupTemplate.prototype, "subject", void 0);
+    __decorate([
+        JobFollowupTemplate.property(),
+        __metadata("design:type", String)
+    ], JobFollowupTemplate.prototype, "body", void 0);
+    __decorate([
+        JobFollowupTemplate.property({ type: Date }),
+        __metadata("design:type", Date)
+    ], JobFollowupTemplate.prototype, "created", void 0);
+    __decorate([
+        JobFollowupTemplate.property({ type: Date }),
+        __metadata("design:type", Date)
+    ], JobFollowupTemplate.prototype, "updated", void 0);
+    __decorate([
+        JobFollowupTemplate.property({ type: Date }),
+        __metadata("design:type", Object)
+    ], JobFollowupTemplate.prototype, "removed", void 0);
+    __decorate([
+        JobFollowupTemplate.property({ type: 'Domain' }),
+        __metadata("design:type", Function)
+    ], JobFollowupTemplate.prototype, "domain", void 0);
+    __decorate([
+        JobFollowupTemplate.property({ type: 'User' }),
+        __metadata("design:type", Function)
+    ], JobFollowupTemplate.prototype, "createdBy", void 0);
+    return JobFollowupTemplate;
+}(Entity));
+export { JobFollowupTemplate };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { Address } from './entities/address.js';
 import { AgentConversation } from './entities/agent_conversation.js';
 import { AgentTokenUsage } from './entities/agent_token_usage.js';
 export type { AgentTokenAnalyticsSummary, AgentTokenAnalyticsTimeseries, AgentTokenUsageRecordPayload, AgentTokenUsageRecordResponse, CompanyAnalyticsResponse, 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';
@@ -41,6 +42,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';
@@ -85,4 +88,4 @@ import * as request from './request.js';
 import * as util from './util/index.js';
 import * as pricing from './pricing/index.js';
 import { toastNotifications } from './toasts.js';
-export { constants, request, util, pricing, toastNotifications, Address, AgentConversation, AgentTokenUsage, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, ProductForm, ProductFormVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, EmbedDescriptor, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, JobNote, JobOperationLog, MatchingInventory, Merchi, MerchiFile, Notification, Payment, PaymentDevice, PhoneNumber, Product, ProductReview, ProductionComment, Quote, QuoteItem, Reminder, RequestOptions, apiFetch, apiFetchWithProgress, Session, Shipment, ShipmentLog, ShipmentItem, ShipmentItemFulfillment, ShipmentMethod, ShipmentMethodVariation, ShortUrl, SubscriptionPlan, SupplyDomain, SystemRole, Theme, ThemeCssSetting, User, UserCompany, Variation, VariationField, VariationFieldsOption, VariationOption, VariationsGroup, generateUUID, getCookie };
+export { constants, request, util, pricing, toastNotifications, Address, AgentConversation, AgentTokenUsage, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, ProductForm, ProductFormVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, EmbedDescriptor, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, JobFollowup, JobFollowupTemplate, JobNote, JobOperationLog, MatchingInventory, Merchi, MerchiFile, Notification, Payment, PaymentDevice, PhoneNumber, Product, ProductReview, ProductionComment, Quote, QuoteItem, Reminder, RequestOptions, 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/index.js

@@ -40,6 +40,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';
@@ -83,4 +85,4 @@ import * as request from './request.js';
 import * as util from './util/index.js';
 import * as pricing from './pricing/index.js';
 import { toastNotifications } from './toasts.js';
-export { constants, request, util, pricing, toastNotifications, Address, AgentConversation, AgentTokenUsage, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, ProductForm, ProductFormVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, JobNote, JobOperationLog, MatchingInventory, Merchi, MerchiFile, Notification, Payment, PaymentDevice, PhoneNumber, Product, ProductReview, 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 };
+export { constants, request, util, pricing, toastNotifications, Address, AgentConversation, AgentTokenUsage, AgentSkill, AgentSkillVersion, AgentSkillApproval, DomainChatSettings, SupportConversation, SupportMessage, Assignment, AutomaticPaymentRelationship, Bank, Cart, CartItem, CartShipmentGroup, CartShipmentQuote, Category, Company, CompanyInvitation, ProductForm, ProductFormVersion, CountryTax, Discount, DiscountGroup, Domain, DomainInvitation, DomainTag, Draft, DraftComment, DraftTemplate, EmailAddress, EmailCounter, EnrolledDomain, Entity, ExchangeRate, InternalTag, Inventory, InventoryUnitVariation, Invoice, Item, Job, JobComment, JobFollowup, JobFollowupTemplate, JobNote, JobOperationLog, MatchingInventory, Merchi, MerchiFile, Notification, Payment, PaymentDevice, PhoneNumber, Product, ProductReview, 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.d.ts

@@ -2,6 +2,8 @@ import { Entity, EmbedDescriptor } from './entity.js';
 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';
@@ -105,6 +107,8 @@ export declare class Merchi {
     Inventory: typeof Inventory;
     InventoryGroup: typeof InventoryGroup;
     JobComment: typeof JobComment;
+    JobFollowup: typeof JobFollowup;
+    JobFollowupTemplate: typeof JobFollowupTemplate;
     JobNote: typeof JobNote;
     JobOperationLog: typeof JobOperationLog;
     VariationOption: typeof VariationOption;

package/dist/merchi.js

@@ -12,6 +12,8 @@ var __assign = (this && this.__assign) || function () {
 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';
@@ -280,6 +282,8 @@ var Merchi = /** @class */ (function () {
         this.MerchiFile = this.setupClass(MerchiFile);
         this.User = this.setupClass(User);
         this.JobComment = this.setupClass(JobComment);
+        this.JobFollowup = this.setupClass(JobFollowup);
+        this.JobFollowupTemplate = this.setupClass(JobFollowupTemplate);
         this.JobNote = this.setupClass(JobNote);
         this.JobOperationLog = this.setupClass(JobOperationLog);
         this.VariationOption = this.setupClass(VariationOption);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merchi/sdk",
-  "version": "1.42.22",
+  "version": "1.42.23",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/src/constants/index.ts

@@ -17,6 +17,7 @@ import * as production_status from './job/production_status.js';
 import * as shipment_status from './job/shipment_status.js';
 import * as call_to_actions from './call_to_actions.js';
 import * as domain_types from './domain_types.js';
+import * as job_followup_types from './job_followup_types.js';
 import * as job_status from './job_status.js';
 import * as white_label_accessibilities from './white_label_accessibilities.js';
 import * as robots_meta_directives from './robots_meta_directives.js';
@@ -41,6 +42,7 @@ export {
   auto_assign_production_on_actions,
   product_types,
   drafting_status,
+  job_followup_types,
   job_types,
   payment_status,
   production_status,

package/src/constants/job_followup_types.ts

@@ -0,0 +1,9 @@
+export enum JobFollowupType {
+  COMPLETION = 0,
+  REVIEW_REQUEST = 1,
+  REORDER = 2,
+  FEEDBACK = 3,
+  CUSTOM = 4,
+}
+
+export type JobFollowupStatus = 'pending' | 'sent' | 'cancelled' | 'failed';

package/src/constants/notification_types.ts

@@ -98,4 +98,5 @@ export enum NotificationType {
   REFERRER_JOB_PAID = 106,
   REFERRER_JOB_RECEIVED = 107,
   FULFILLMENT_PARTNER_INVITED = 108,
+  JOB_FOLLOWUP = 109,
 }

package/src/entities/domain.ts

@@ -16,6 +16,7 @@ import { Job } from './job.js';
 import { User } from './user.js';
 import { Notification } from './notification.js';
 import { Product } from './product.js';
+import { JobFollowupTemplate } from './job_followup_template.js';
 import { Reminder } from './reminder.js';
 import { Session } from './session.js';
 import { SupplyDomain } from './supply_domain.js';
@@ -684,6 +685,9 @@ export class Domain extends Entity {
   @Domain.property({arrayType: 'Reminder'})
   public reminders?: Reminder[];
 
+  @Domain.property({arrayType: 'JobFollowupTemplate'})
+  public jobFollowupTemplates?: JobFollowupTemplate[];
+
   @Domain.property({arrayType: 'Product'})
   public products?: Product[];
 

package/src/entities/job.ts

@@ -13,6 +13,7 @@ import { MatchingInventory } from './matching_inventory.js';
 import { InternalTag } from './internal_tag.js';
 import { Invoice } from './invoice.js';
 import { JobComment } from './job_comment.js';
+import { JobFollowup, JobFollowupUpdate, ScheduledJobFollowup } from './job_followup.js';
 import { JobNote } from './job_note.js';
 import { JobOperationLog } from './job_operation_log.js';
 import { Notification } from './notification.js';
@@ -375,6 +376,9 @@ export class Job extends Entity {
   @Job.property({arrayType: 'Reminder'})
   public reminders?: Reminder[];
 
+  @Job.property({arrayType: 'JobFollowup'})
+  public jobFollowups?: JobFollowup[];
+
   @Job.property()
   public supplyAssignment?: Assignment;
 
@@ -440,4 +444,56 @@ export class Job extends Entity {
     }
     return this.deduct(this.matchingInventories);
   };
+
+  private jobResourceId = () => {
+    if (this.id === undefined || this.id === null) {
+      throw new Error('id is undefined, did you forget to set it?');
+    }
+    return this.id;
+  };
+
+  private readFollowups = (data: any): JobFollowup[] => {
+    const rows = data?.jobFollowups ?? [];
+    return rows.map((row: any) => new this.merchi.JobFollowup().fromJson(row));
+  };
+
+  private readFollowup = (data: any): JobFollowup => {
+    return new this.merchi.JobFollowup().fromJson(data?.jobFollowup ?? data);
+  };
+
+  public listFollowups = () => {
+    const resource = `/jobs/${this.jobResourceId()}/followups/`;
+    const fetchOptions: RequestOptions = {method: 'GET', query: []};
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => this.readFollowups(data));
+  };
+
+  public complete = (followups: ScheduledJobFollowup[] = []) => {
+    const resource = `/jobs/${this.jobResourceId()}/complete/`;
+    const data = new FormData();
+    data.append('followups', JSON.stringify(followups));
+    const fetchOptions: RequestOptions = {method: 'POST', body: data, query: []};
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((payload: any) => this.readFollowups(payload));
+  };
+
+  public updateFollowup = (followupId: number, changes: JobFollowupUpdate) => {
+    const resource = `/jobs/${this.jobResourceId()}/followups/${followupId}/`;
+    const fetchOptions: RequestOptions = {
+      method: 'PATCH',
+      headers: {'Content-Type': 'application/json'},
+      body: JSON.stringify(changes),
+      query: [],
+    };
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => this.readFollowup(data));
+  };
+
+  public cancelFollowup = (followupId: number) => {
+    const resource =
+      `/jobs/${this.jobResourceId()}/followups/${followupId}/cancel/`;
+    const fetchOptions: RequestOptions = {method: 'POST', query: []};
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => this.readFollowup(data));
+  };
 }

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(