@merchi/sdk 1.42.23 → 1.42.24

package/dist/constants/job_status.d.ts

@@ -12,6 +12,10 @@ export declare enum PaymentStatus {
     PARTIAL_PAID = 3,
     FULLY_PAID = 4
 }
+export declare enum InvoiceQuoteStatus {
+    ISSUED = "issued",
+    DECLINED = "declined"
+}
 export declare enum ProductionStatus {
     INIT = 0,
     REJECTED = 1,

package/dist/constants/job_status.js

@@ -14,6 +14,11 @@ export var PaymentStatus;
     PaymentStatus[PaymentStatus["PARTIAL_PAID"] = 3] = "PARTIAL_PAID";
     PaymentStatus[PaymentStatus["FULLY_PAID"] = 4] = "FULLY_PAID";
 })(PaymentStatus || (PaymentStatus = {}));
+export var InvoiceQuoteStatus;
+(function (InvoiceQuoteStatus) {
+    InvoiceQuoteStatus["ISSUED"] = "issued";
+    InvoiceQuoteStatus["DECLINED"] = "declined";
+})(InvoiceQuoteStatus || (InvoiceQuoteStatus = {}));
 export var ProductionStatus;
 (function (ProductionStatus) {
     ProductionStatus[ProductionStatus["INIT"] = 0] = "INIT";

package/dist/constants/notification_types.d.ts

@@ -98,5 +98,8 @@ export declare enum NotificationType {
     REFERRER_JOB_PAID = 106,
     REFERRER_JOB_RECEIVED = 107,
     FULFILLMENT_PARTNER_INVITED = 108,
-    JOB_FOLLOWUP = 109
+    JOB_FOLLOWUP = 109,
+    SEND_QUOTE = 110,
+    QUOTE_INVOICE_APPROVED = 111,
+    QUOTE_INVOICE_DECLINED = 112
 }

package/dist/constants/notification_types.js

@@ -100,4 +100,7 @@ export var NotificationType;
     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["SEND_QUOTE"] = 110] = "SEND_QUOTE";
+    NotificationType[NotificationType["QUOTE_INVOICE_APPROVED"] = 111] = "QUOTE_INVOICE_APPROVED";
+    NotificationType[NotificationType["QUOTE_INVOICE_DECLINED"] = 112] = "QUOTE_INVOICE_DECLINED";
 })(NotificationType || (NotificationType = {}));

package/dist/entities/invoice.d.ts

@@ -41,6 +41,10 @@ export declare class Invoice extends Entity {
     sendWhatsapp?: boolean | null;
     unpaid?: boolean | null;
     isTest?: boolean | null;
+    isQuote?: boolean | null;
+    quoteApprovedDate?: Date | null;
+    quoteDeclinedDate?: Date | null;
+    quoteDeclineReason?: string | null;
     currency?: string;
     acceptSquare?: boolean;
     acceptStripe?: boolean;
@@ -56,6 +60,7 @@ export declare class Invoice extends Entity {
     isCompletelyPaid?: boolean;
     responsibleManager?: User | null;
     creator?: User | null;
+    quoteApprovedBy?: User | null;
     client?: User;
     clientCompany?: Company | null;
     subscriptionCompanies?: Company[];
@@ -77,4 +82,14 @@ export declare class Invoice extends Entity {
     quotes?: Quote[];
     cart?: Cart;
     payments?: Payment[];
+    private respondToQuote;
+    /** Approving a quote turns it into a payable invoice. */
+    approveQuote: () => Promise<{
+        invoice: Invoice;
+        paymentUrl: string;
+    }>;
+    declineQuote: (reason?: string) => Promise<{
+        invoice: Invoice;
+        paymentUrl: string;
+    }>;
 }

package/dist/entities/invoice.js

@@ -34,7 +34,31 @@ import { User } from './user.js';
 var Invoice = /** @class */ (function (_super) {
     __extends(Invoice, _super);
     function Invoice() {
-        return _super !== null && _super.apply(this, arguments) || this;
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.respondToQuote = function (action, reason) {
+            if (_this.id === undefined || _this.id === null) {
+                throw new Error('id is undefined, did you forget to set it?');
+            }
+            var resource = "/invoices/".concat(_this.id, "/").concat(action, "_quote/");
+            var data = new FormData();
+            if (reason) {
+                data.append('reason', reason);
+            }
+            var fetchOptions = { method: 'POST', body: data, query: [] };
+            return _this.merchi.authenticatedFetch(resource, fetchOptions).
+                then(function (payload) {
+                _this.fromJson(payload.invoice);
+                return { invoice: _this, paymentUrl: payload.paymentUrl };
+            });
+        };
+        /** Approving a quote turns it into a payable invoice. */
+        _this.approveQuote = function () {
+            return _this.respondToQuote('approve');
+        };
+        _this.declineQuote = function (reason) {
+            return _this.respondToQuote('decline', reason);
+        };
+        return _this;
     }
     Invoice.resourceName = 'invoices';
     Invoice.singularName = 'invoice';
@@ -123,6 +147,22 @@ var Invoice = /** @class */ (function (_super) {
         Invoice.property({ type: Boolean }),
         __metadata("design:type", Object)
     ], Invoice.prototype, "isTest", void 0);
+    __decorate([
+        Invoice.property({ type: Boolean }),
+        __metadata("design:type", Object)
+    ], Invoice.prototype, "isQuote", void 0);
+    __decorate([
+        Invoice.property({ type: Date }),
+        __metadata("design:type", Object)
+    ], Invoice.prototype, "quoteApprovedDate", void 0);
+    __decorate([
+        Invoice.property({ type: Date }),
+        __metadata("design:type", Object)
+    ], Invoice.prototype, "quoteDeclinedDate", void 0);
+    __decorate([
+        Invoice.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Invoice.prototype, "quoteDeclineReason", void 0);
     __decorate([
         Invoice.property(),
         __metadata("design:type", String)
@@ -183,6 +223,10 @@ var Invoice = /** @class */ (function (_super) {
         Invoice.property({ type: User }),
         __metadata("design:type", Object)
     ], Invoice.prototype, "creator", void 0);
+    __decorate([
+        Invoice.property({ type: User }),
+        __metadata("design:type", Object)
+    ], Invoice.prototype, "quoteApprovedBy", void 0);
     __decorate([
         Invoice.property(),
         __metadata("design:type", User)

package/dist/entities/invoice.test.js

@@ -1,3 +1,39 @@
+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 { setup, mockFetch } from '../test_util.js';
 import { Merchi } from '../merchi.js';
 setup();
@@ -37,6 +73,59 @@ test('client and invoice tokens supported by merchi', function () {
     expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
     return invocation;
 });
+test('reads quote fields', function () {
+    var merchi = new Merchi();
+    var invoice = new merchi.Invoice();
+    invoice.fromJson({
+        id: 1,
+        isQuote: true,
+        quoteDeclinedDate: 1761700000,
+        quoteDeclineReason: 'Too expensive',
+    });
+    expect(invoice.isQuote).toBe(true);
+    expect(invoice.quoteDeclinedDate).toBeInstanceOf(Date);
+    expect(invoice.quoteDeclineReason).toBe('Too expensive');
+});
+test('approveQuote posts to approve_quote with the invoice token', function () { return __awaiter(void 0, void 0, void 0, function () {
+    var merchi, fetch, invoice, result;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                merchi = new Merchi(undefined, undefined, 'i');
+                fetch = mockFetch(true, { invoice: { id: 1, isQuote: false }, paymentUrl: 'https://pay' }, 200);
+                invoice = new merchi.Invoice();
+                invoice.id = 1;
+                invoice.isQuote = true;
+                return [4 /*yield*/, invoice.approveQuote()];
+            case 1:
+                result = _a.sent();
+                expect(fetch.mock.calls[0][0]).toContain('/invoices/1/approve_quote/');
+                expect(fetch.mock.calls[0][1]['method']).toBe('POST');
+                expect(fetch.mock.calls[0][1]['query']).toContainEqual(['invoice_token', 'i']);
+                expect(result.paymentUrl).toBe('https://pay');
+                expect(invoice.isQuote).toBe(false);
+                return [2 /*return*/];
+        }
+    });
+}); });
+test('declineQuote sends the reason', function () { return __awaiter(void 0, void 0, void 0, function () {
+    var merchi, fetch, invoice;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                merchi = new Merchi();
+                fetch = mockFetch(true, { invoice: { id: 1 }, paymentUrl: '' }, 200);
+                invoice = new merchi.Invoice();
+                invoice.id = 1;
+                return [4 /*yield*/, invoice.declineQuote('Too expensive')];
+            case 1:
+                _a.sent();
+                expect(fetch.mock.calls[0][0]).toContain('/invoices/1/decline_quote/');
+                expect(fetch.mock.calls[0][1]['body'].get('reason')).toBe('Too expensive');
+                return [2 /*return*/];
+        }
+    });
+}); });
 test('preserves server payment engine hint', function () {
     var merchi = new Merchi();
     var entity = new merchi.Invoice();

package/dist/entities/job.d.ts

@@ -25,6 +25,7 @@ import { User } from './user.js';
 import { Variation } from './variation.js';
 import { VariationsGroup } from './variations_group.js';
 import { InventoryStatus } from '../constants/inventory_statuses.js';
+import { InvoiceQuoteStatus } from '../constants/job_status.js';
 import { Item } from './item.js';
 export declare class Job extends Entity {
     protected static resourceName: string;
@@ -63,6 +64,8 @@ export declare class Job extends Entity {
     jobInfoApprovedByClient?: boolean;
     groupBuyStatus?: number | null;
     paymentStatus?: number | null;
+    /** Set while the job's invoice is still a quote; paymentStatus stays INIT. */
+    invoiceQuoteStatus?: InvoiceQuoteStatus | null;
     deductionDate?: Date | null;
     shippingStatus?: number | null;
     completed?: boolean;

package/dist/entities/job.js

@@ -265,6 +265,10 @@ var Job = /** @class */ (function (_super) {
         Job.property({ type: Number }),
         __metadata("design:type", Object)
     ], Job.prototype, "paymentStatus", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "invoiceQuoteStatus", void 0);
     __decorate([
         Job.property({ type: Date }),
         __metadata("design:type", Object)

package/package.json

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

package/src/constants/job_status.ts

@@ -14,6 +14,11 @@ export enum PaymentStatus {
   FULLY_PAID = 4,
 }
 
+export enum InvoiceQuoteStatus {
+  ISSUED = 'issued',
+  DECLINED = 'declined',
+}
+
 export enum ProductionStatus {
   INIT = 0,
   REJECTED = 1,

package/src/constants/notification_types.ts

@@ -99,4 +99,7 @@ export enum NotificationType {
   REFERRER_JOB_RECEIVED = 107,
   FULFILLMENT_PARTNER_INVITED = 108,
   JOB_FOLLOWUP = 109,
+  SEND_QUOTE = 110,
+  QUOTE_INVOICE_APPROVED = 111,
+  QUOTE_INVOICE_DECLINED = 112,
 }

package/src/entities/invoice.test.ts

@@ -42,6 +42,45 @@ test('client and invoice tokens supported by merchi', () => {
   return invocation;
 });
 
+test('reads quote fields', () => {
+  const merchi = new Merchi();
+  const invoice = new merchi.Invoice();
+  invoice.fromJson({
+    id: 1,
+    isQuote: true,
+    quoteDeclinedDate: 1761700000,
+    quoteDeclineReason: 'Too expensive',
+  });
+  expect(invoice.isQuote).toBe(true);
+  expect(invoice.quoteDeclinedDate).toBeInstanceOf(Date);
+  expect(invoice.quoteDeclineReason).toBe('Too expensive');
+});
+
+test('approveQuote posts to approve_quote with the invoice token', async () => {
+  const merchi = new Merchi(undefined, undefined, 'i');
+  const fetch = mockFetch(
+    true, {invoice: {id: 1, isQuote: false}, paymentUrl: 'https://pay'}, 200);
+  const invoice = new merchi.Invoice();
+  invoice.id = 1;
+  invoice.isQuote = true;
+  const result = await invoice.approveQuote();
+  expect(fetch.mock.calls[0][0]).toContain('/invoices/1/approve_quote/');
+  expect(fetch.mock.calls[0][1]['method']).toBe('POST');
+  expect(fetch.mock.calls[0][1]['query']).toContainEqual(['invoice_token', 'i']);
+  expect(result.paymentUrl).toBe('https://pay');
+  expect(invoice.isQuote).toBe(false);
+});
+
+test('declineQuote sends the reason', async () => {
+  const merchi = new Merchi();
+  const fetch = mockFetch(true, {invoice: {id: 1}, paymentUrl: ''}, 200);
+  const invoice = new merchi.Invoice();
+  invoice.id = 1;
+  await invoice.declineQuote('Too expensive');
+  expect(fetch.mock.calls[0][0]).toContain('/invoices/1/decline_quote/');
+  expect(fetch.mock.calls[0][1]['body'].get('reason')).toBe('Too expensive');
+});
+
 test('preserves server payment engine hint', () => {
   const merchi = new Merchi();
   const entity = new merchi.Invoice();

package/src/entities/invoice.ts

@@ -16,6 +16,7 @@ import { Payment } from './payment.js';
 import { PhoneNumber } from './phone_number.js';
 import { Shipment } from './shipment.js';
 import { User } from './user.js';
+import { RequestOptions } from '../request.js';
 
 export class Invoice extends Entity {
   protected static resourceName = 'invoices';
@@ -85,6 +86,18 @@ export class Invoice extends Entity {
   @Invoice.property({type: Boolean})
   public isTest?: boolean | null;
 
+  @Invoice.property({type: Boolean})
+  public isQuote?: boolean | null;
+
+  @Invoice.property({type: Date})
+  public quoteApprovedDate?: Date | null;
+
+  @Invoice.property({type: Date})
+  public quoteDeclinedDate?: Date | null;
+
+  @Invoice.property({type: String})
+  public quoteDeclineReason?: string | null;
+
   @Invoice.property()
   public currency?: string;
 
@@ -130,6 +143,9 @@ export class Invoice extends Entity {
   @Invoice.property({type: User})
   public creator?: User | null;
 
+  @Invoice.property({type: User})
+  public quoteApprovedBy?: User | null;
+
   @Invoice.property()
   public client?: User;
 
@@ -192,4 +208,30 @@ export class Invoice extends Entity {
 
   @Invoice.property({arrayType: 'Payment'})
   public payments?: Payment[];
+
+  private respondToQuote = (action: 'approve' | 'decline', reason?: string) => {
+    if (this.id === undefined || this.id === null) {
+      throw new Error('id is undefined, did you forget to set it?');
+    }
+    const resource = `/invoices/${this.id}/${action}_quote/`;
+    const data = new FormData();
+    if (reason) {
+      data.append('reason', reason);
+    }
+    const fetchOptions: RequestOptions = {method: 'POST', body: data, query: []};
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((payload: any) => {
+        this.fromJson(payload.invoice);
+        return {invoice: this, paymentUrl: payload.paymentUrl as string};
+      });
+  };
+
+  /** Approving a quote turns it into a payable invoice. */
+  public approveQuote = (): Promise<{invoice: Invoice; paymentUrl: string}> =>
+    this.respondToQuote('approve');
+
+  public declineQuote = (
+    reason?: string
+  ): Promise<{invoice: Invoice; paymentUrl: string}> =>
+    this.respondToQuote('decline', reason);
 }

package/src/entities/job.ts

@@ -26,6 +26,7 @@ import { User } from './user.js';
 import { Variation } from './variation.js';
 import { VariationsGroup } from './variations_group.js';
 import { InventoryStatus } from '../constants/inventory_statuses.js';
+import { InvoiceQuoteStatus } from '../constants/job_status.js';
 import { Item } from './item.js';
 
 
@@ -133,6 +134,10 @@ export class Job extends Entity {
   @Job.property({type: Number})
   public paymentStatus?: number | null;
 
+  /** Set while the job's invoice is still a quote; paymentStatus stays INIT. */
+  @Job.property({type: String})
+  public invoiceQuoteStatus?: InvoiceQuoteStatus | null;
+
   @Job.property({type: Date})
   public deductionDate?: Date | null;