globalpayments-api 3.5.1 → 3.5.3

package/lib/src/Entities/Schedule.js

@@ -0,0 +1,325 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedule = void 0;
+const _1 = require("./");
+class Schedule extends _1.RecurringEntity {
+    /// <summary>
+    /// The schedule's amount
+    /// </summary>
+    amount;
+    /// <summary>
+    /// The date/time the schedule was cancelled.
+    /// </summary>
+    cancellationDate;
+    /// <summary>
+    /// The schedule's currency.
+    /// </summary>
+    currency;
+    /// <summary>
+    /// The identifier of the customer associated
+    /// with the schedule.
+    /// </summary>
+    customerKey;
+    /// <summary>
+    /// The description of the schedule.
+    /// </summary>
+    description;
+    /// <summary>
+    /// The device ID associated with a schedule's
+    /// transactions.
+    /// </summary>
+    deviceId;
+    /// <summary>
+    /// Indicates if email notifications should be sent.
+    /// </summary>
+    emailNotification;
+    /// <summary>
+    /// Indicates when email notifications should be sent.
+    /// </summary>
+    emailReceipt;
+    /// <summary>
+    /// The end date of a schedule, if any.
+    /// </summary>
+    endDate;
+    /// <summary>
+    /// The schedule's frequency.
+    /// </summary>
+    /// <seealso>ScheduleFrequency</seealso>
+    frequency;
+    /// <summary>
+    /// Indicates if the schedule has started processing.
+    /// </summary>
+    hasStarted;
+    /// <summary>
+    /// The invoice number associated with the schedule.
+    /// </summary>
+    invoiceNumber;
+    /// <summary>
+    /// The schedule's name.
+    /// </summary>
+    name;
+    /// <summary>
+    /// The date/time when the schedule should process next.
+    /// </summary>
+    nextProcessingDate;
+    /// <summary>
+    /// The number of payments made to date on the schedule.
+    /// </summary>
+    numberOfPayments;
+    /// <summary>
+    /// The purchase order (PO) number associated with the schedule.
+    /// </summary>
+    poNumber;
+    /// <summary>
+    /// The identifier of the payment method associated with
+    /// the schedule.
+    /// </summary>
+    paymentKey;
+    /// <summary>
+    /// Indicates when in the month a recurring schedule should run.
+    /// </summary>
+    paymentSchedule;
+    /// <summary>
+    /// The number of times a failed schedule payment should be
+    /// reprocessed.
+    /// </summary>
+    reprocessingCount;
+    /// <summary>
+    /// The start date of a schedule.
+    /// </summary>
+    startDate;
+    /// <summary>
+    /// The schedule's status.
+    /// </summary>
+    status;
+    /// <summary>
+    /// The schedule's tax amount.
+    /// </summary>
+    taxAmount;
+    /// <summary>
+    /// The total amount for the schedule (`Amount` + `TaxAmount`).
+    /// </summary>
+    get totalAmount() {
+        return (parseFloat(this.amount.toString()) + parseFloat(this.taxAmount.toString()));
+    }
+    constructor(customerKey, paymentKey) {
+        super();
+        if (customerKey) {
+            this.customerKey = customerKey;
+        }
+        if (paymentKey) {
+            this.paymentKey = paymentKey;
+        }
+    }
+    /// <summary>
+    /// Sets the schedule's amount.
+    /// </summary>
+    /// <param name="value">The amount</param>
+    /// <returns>Schedule</returns>
+    withAmount(value) {
+        if (value) {
+            this.amount = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's currency.
+    /// </summary>
+    /// <param name="value">The currency</param>
+    /// <returns>Schedule</returns>
+    withCurrency(value) {
+        if (value) {
+            this.currency = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's customer.
+    /// </summary>
+    /// <param name="value">The customer's key</param>
+    /// <returns>Schedule</returns>
+    withCustomerKey(value) {
+        if (value) {
+            this.customerKey = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's description.
+    /// </summary>
+    /// <param name="value">The description</param>
+    /// <returns>Schedule</returns>
+    withDescription(value) {
+        if (value) {
+            this.description = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's device ID.
+    /// </summary>
+    /// <param name="value">The device ID</param>
+    /// <returns>Schedule</returns>
+    withDeviceId(value) {
+        if (value) {
+            this.deviceId = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets whether the schedule should send email notifications.
+    /// </summary>
+    /// <param name="value">The email notification flag</param>
+    /// <returns>Schedule</returns>
+    withEmailNotification(value) {
+        if (value) {
+            this.emailNotification = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets when the schedule should email receipts.
+    /// </summary>
+    /// <param name="value">When the schedule should email receipts</param>
+    /// <returns>Schedule</returns>
+    withEmailReceipt(value) {
+        if (value) {
+            this.emailReceipt = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's end date.
+    /// </summary>
+    /// <param name="value">The end date</param>
+    /// <returns>Schedule</returns>
+    withEndDate(value) {
+        if (value) {
+            this.endDate = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's frequency.
+    /// </summary>
+    /// <param name="value">The frequency</param>
+    /// <returns>Schedule</returns>
+    withFrequency(value) {
+        if (value) {
+            this.frequency = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's invoice number.
+    /// </summary>
+    /// <param name="value">The invoice number</param>
+    /// <returns>Schedule</returns>
+    withInvoiceNumber(value) {
+        if (value) {
+            this.invoiceNumber = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's name.
+    /// </summary>
+    /// <param name="value">The name</param>
+    /// <returns>Schedule</returns>
+    withName(value) {
+        if (value) {
+            this.name = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's number of payments.
+    /// </summary>
+    /// <param name="value">The number of payments</param>
+    /// <returns>Schedule</returns>
+    withNumberOfPayments(value) {
+        if (value) {
+            this.numberOfPayments = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's purchase order (PO) number.
+    /// </summary>
+    /// <param name="value">The purchase order (PO) number</param>
+    /// <returns>Schedule</returns>
+    withPoNumber(value) {
+        if (value) {
+            this.poNumber = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's payment method.
+    /// </summary>
+    /// <param name="value">The payment method's key</param>
+    /// <returns>Schedule</returns>
+    withPaymentKey(value) {
+        if (value) {
+            this.paymentKey = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's recurring schedule.
+    /// </summary>
+    /// <param name="value">The recurring schedule</param>
+    /// <returns>Schedule</returns>
+    withPaymentSchedule(value) {
+        if (value) {
+            this.paymentSchedule = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's reprocessing count.
+    /// </summary>
+    /// <param name="value">The reprocessing count</param>
+    /// <returns>Schedule</returns>
+    withReprocessingCount(value) {
+        if (value) {
+            this.reprocessingCount = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's start date.
+    /// </summary>
+    /// <param name="value">The start date</param>
+    /// <returns>Schedule</returns>
+    withStartDate(value) {
+        if (value) {
+            this.startDate = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's status.
+    /// </summary>
+    /// <param name="value">The new status</param>
+    /// <returns>Schedule</returns>
+    withStatus(value) {
+        if (value) {
+            this.status = value;
+        }
+        return this;
+    }
+    /// <summary>
+    /// Sets the schedule's tax amount.
+    /// </summary>
+    /// <param name="value">The tax amount</param>
+    /// <returns>Schedule</returns>
+    withTaxAmount(value) {
+        if (value) {
+            this.taxAmount = value;
+        }
+        return this;
+    }
+}
+exports.Schedule = Schedule;
+//# sourceMappingURL=Schedule.js.map

package/lib/src/Entities/Schedule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schedule.js","sourceRoot":"","sources":["../../../src/Entities/Schedule.ts"],"names":[],"mappings":";;;AACA,yBAAqC;AAErC,MAAa,QAAS,SAAQ,kBAAyB;IACrD,aAAa;IACb,yBAAyB;IACzB,cAAc;IACP,MAAM,CAAkB;IAE/B,aAAa;IACb,6CAA6C;IAC7C,cAAc;IACP,gBAAgB,CAAO;IAE9B,aAAa;IACb,4BAA4B;IAC5B,cAAc;IACP,QAAQ,CAAS;IAExB,aAAa;IACb,6CAA6C;IAC7C,sBAAsB;IACtB,cAAc;IACP,WAAW,CAAS;IAE3B,aAAa;IACb,oCAAoC;IACpC,cAAc;IACP,WAAW,CAAS;IAE3B,aAAa;IACb,8CAA8C;IAC9C,iBAAiB;IACjB,cAAc;IACP,QAAQ,CAAkB;IAEjC,aAAa;IACb,oDAAoD;IACpD,cAAc;IACP,iBAAiB,CAAU;IAElC,aAAa;IACb,sDAAsD;IACtD,cAAc;IACP,YAAY,CAAe;IAElC,aAAa;IACb,uCAAuC;IACvC,cAAc;IACP,OAAO,CAAO;IAErB,aAAa;IACb,6BAA6B;IAC7B,cAAc;IACd,wCAAwC;IACjC,SAAS,CAAoB;IAEpC,aAAa;IACb,qDAAqD;IACrD,cAAc;IACP,UAAU,CAAU;IAE3B,aAAa;IACb,oDAAoD;IACpD,cAAc;IACP,aAAa,CAAS;IAE7B,aAAa;IACb,wBAAwB;IACxB,cAAc;IACP,IAAI,CAAS;IAEpB,aAAa;IACb,wDAAwD;IACxD,cAAc;IACP,kBAAkB,CAAO;IAEhC,aAAa;IACb,wDAAwD;IACxD,cAAc;IACP,gBAAgB,CAAkB;IAEzC,aAAa;IACb,gEAAgE;IAChE,cAAc;IACP,QAAQ,CAAS;IAExB,aAAa;IACb,wDAAwD;IACxD,iBAAiB;IACjB,cAAc;IACP,UAAU,CAAS;IAE1B,aAAa;IACb,gEAAgE;IAChE,cAAc;IACP,eAAe,CAAkB;IAExC,aAAa;IACb,2DAA2D;IAC3D,gBAAgB;IAChB,cAAc;IACP,iBAAiB,CAAkB;IAE1C,aAAa;IACb,iCAAiC;IACjC,cAAc;IACP,SAAS,CAAO;IAEvB,aAAa;IACb,0BAA0B;IAC1B,cAAc;IACP,MAAM,CAAS;IAEtB,aAAa;IACb,8BAA8B;IAC9B,cAAc;IACP,SAAS,CAAkB;IAElC,aAAa;IACb,+DAA+D;IAC/D,cAAc;IACd,IAAW,WAAW;QACpB,OAAO,CACL,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAC3E,CAAC;IACJ,CAAC;IAED,YAAmB,WAAoB,EAAE,UAAmB;QAC1D,KAAK,EAAE,CAAC;QACR,IAAI,WAAW,EAAE;YACf,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SAChC;QACD,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;SAC9B;IACH,CAAC;IAED,aAAa;IACb,+BAA+B;IAC/B,cAAc;IACd,0CAA0C;IAC1C,+BAA+B;IACxB,UAAU,CAAC,KAAuB;QACvC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;SACrB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,iCAAiC;IACjC,cAAc;IACd,4CAA4C;IAC5C,+BAA+B;IACxB,YAAY,CAAC,KAAc;QAChC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,iCAAiC;IACjC,cAAc;IACd,kDAAkD;IAClD,+BAA+B;IACxB,eAAe,CAAC,KAAc;QACnC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,oCAAoC;IACpC,cAAc;IACd,+CAA+C;IAC/C,+BAA+B;IACxB,eAAe,CAAC,KAAc;QACnC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,kCAAkC;IAClC,cAAc;IACd,6CAA6C;IAC7C,+BAA+B;IACxB,YAAY,CAAC,KAAuB;QACzC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,8DAA8D;IAC9D,cAAc;IACd,2DAA2D;IAC3D,+BAA+B;IACxB,qBAAqB,CAAC,KAAe;QAC1C,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,iDAAiD;IACjD,cAAc;IACd,uEAAuE;IACvE,+BAA+B;IACxB,gBAAgB,CAAC,KAAoB;QAC1C,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;SAC3B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,iCAAiC;IACjC,cAAc;IACd,4CAA4C;IAC5C,+BAA+B;IACxB,WAAW,CAAC,KAAY;QAC7B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;SACtB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,kCAAkC;IAClC,cAAc;IACd,6CAA6C;IAC7C,+BAA+B;IACxB,aAAa,CAAC,KAAyB;QAC5C,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;SACxB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,uCAAuC;IACvC,cAAc;IACd,kDAAkD;IAClD,+BAA+B;IACxB,iBAAiB,CAAC,KAAc;QACrC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;SAC5B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,6BAA6B;IAC7B,cAAc;IACd,wCAAwC;IACxC,+BAA+B;IACxB,QAAQ,CAAC,KAAc;QAC5B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;SACnB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,2CAA2C;IAC3C,cAAc;IACd,sDAAsD;IACtD,+BAA+B;IACxB,oBAAoB,CAAC,KAAuB;QACjD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,mDAAmD;IACnD,cAAc;IACd,8DAA8D;IAC9D,+BAA+B;IACxB,YAAY,CAAC,KAAc;QAChC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,uCAAuC;IACvC,cAAc;IACd,wDAAwD;IACxD,+BAA+B;IACxB,cAAc,CAAC,KAAc;QAClC,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;SACzB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,2CAA2C;IAC3C,cAAc;IACd,sDAAsD;IACtD,+BAA+B;IACxB,mBAAmB,CAAC,KAAuB;QAChD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,2CAA2C;IAC3C,cAAc;IACd,sDAAsD;IACtD,+BAA+B;IACxB,qBAAqB,CAAC,KAAuB;QAClD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,mCAAmC;IACnC,cAAc;IACd,8CAA8C;IAC9C,+BAA+B;IACxB,aAAa,CAAC,KAAY;QAC/B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;SACxB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,+BAA+B;IAC/B,cAAc;IACd,8CAA8C;IAC9C,+BAA+B;IACxB,UAAU,CAAC,KAAc;QAC9B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;SACrB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;IACb,mCAAmC;IACnC,cAAc;IACd,8CAA8C;IAC9C,+BAA+B;IACxB,aAAa,CAAC,KAAuB;QAC1C,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;SACxB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1WD,4BA0WC"}

package/lib/src/Entities/ServiceEndpoints.d.ts

@@ -0,0 +1,12 @@
+export declare enum ServiceEndpoints {
+    GLOBAL_ECOM_PRODUCTION = "https://api.realexpayments.com/epage-remote.cgi",
+    GLOBAL_ECOM_TEST = "https://api.sandbox.realexpayments.com/epage-remote.cgi",
+    GP_API_PRODUCTION = "https://apis.globalpay.com/ucp",
+    GP_API_TEST = "https://apis.sandbox.globalpay.com/ucp",
+    PORTICO_PRODUCTION = "https://api2.heartlandportico.com",
+    PORTICO_TEST = "https://cert.api2.heartlandportico.com",
+    PROPAY_TEST = "https://xmltest.propay.com/API/PropayAPI.aspx",
+    PROPAY_TEST_CANADIAN = "https://xmltestcanada.propay.com/API/PropayAPI.aspx",
+    PROPAY_PRODUCTION = "https://epay.propay.com/API/PropayAPI.aspx",
+    PROPAY_PRODUCTION_CANADIAN = "https://www.propaycanada.ca/API/PropayAPI.aspx"
+}

package/lib/src/Entities/ServiceEndpoints.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceEndpoints = void 0;
+var ServiceEndpoints;
+(function (ServiceEndpoints) {
+    ServiceEndpoints["GLOBAL_ECOM_PRODUCTION"] = "https://api.realexpayments.com/epage-remote.cgi";
+    ServiceEndpoints["GLOBAL_ECOM_TEST"] = "https://api.sandbox.realexpayments.com/epage-remote.cgi";
+    ServiceEndpoints["GP_API_PRODUCTION"] = "https://apis.globalpay.com/ucp";
+    ServiceEndpoints["GP_API_TEST"] = "https://apis.sandbox.globalpay.com/ucp";
+    ServiceEndpoints["PORTICO_PRODUCTION"] = "https://api2.heartlandportico.com";
+    ServiceEndpoints["PORTICO_TEST"] = "https://cert.api2.heartlandportico.com";
+    ServiceEndpoints["PROPAY_TEST"] = "https://xmltest.propay.com/API/PropayAPI.aspx";
+    ServiceEndpoints["PROPAY_TEST_CANADIAN"] = "https://xmltestcanada.propay.com/API/PropayAPI.aspx";
+    ServiceEndpoints["PROPAY_PRODUCTION"] = "https://epay.propay.com/API/PropayAPI.aspx";
+    ServiceEndpoints["PROPAY_PRODUCTION_CANADIAN"] = "https://www.propaycanada.ca/API/PropayAPI.aspx";
+})(ServiceEndpoints || (exports.ServiceEndpoints = ServiceEndpoints = {}));
+//# sourceMappingURL=ServiceEndpoints.js.map

package/lib/src/Entities/ServiceEndpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceEndpoints.js","sourceRoot":"","sources":["../../../src/Entities/ServiceEndpoints.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,8FAA0E,CAAA;IAC1E,gGAA4E,CAAA;IAC5E,wEAAoD,CAAA;IACpD,0EAAsD,CAAA;IACtD,4EAAwD,CAAA;IACxD,2EAAuD,CAAA;IACvD,iFAA6D,CAAA;IAC7D,gGAA4E,CAAA;IAC5E,oFAAgE,CAAA;IAChE,iGAA6E,CAAA;AAC/E,CAAC,EAXW,gBAAgB,gCAAhB,gBAAgB,QAW3B"}

package/lib/src/Entities/StoredCredentials.d.ts

@@ -0,0 +1,9 @@
+import { StoredCredentialInitiator, StoredCredentialReason, StoredCredentialSequence, StoredCredentialType } from ".";
+export declare class StoredCredential {
+    type: StoredCredentialType;
+    initiator: StoredCredentialInitiator;
+    sequence: StoredCredentialSequence;
+    schemeId: string;
+    reason: StoredCredentialReason;
+    cardBrandTransactionId: string;
+}

package/lib/src/Entities/StoredCredentials.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StoredCredential = void 0;
+class StoredCredential {
+    type;
+    initiator;
+    sequence;
+    schemeId;
+    reason;
+    cardBrandTransactionId;
+}
+exports.StoredCredential = StoredCredential;
+//# sourceMappingURL=StoredCredentials.js.map

package/lib/src/Entities/StoredCredentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoredCredentials.js","sourceRoot":"","sources":["../../../src/Entities/StoredCredentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,gBAAgB;IACpB,IAAI,CAAuB;IAC3B,SAAS,CAA4B;IACrC,QAAQ,CAA2B;IACnC,QAAQ,CAAS;IACjB,MAAM,CAAyB;IAC/B,sBAAsB,CAAS;CACvC;AAPD,4CAOC"}

package/lib/src/Entities/Transaction.d.ts

@@ -0,0 +1,96 @@
+import { Card, GiftCard, ManagementBuilder, PayerDetails, PaymentMethodType, PaymentMethodUsageMode, StoredCredentialSequence, TransactionReference } from "../";
+import { PayFacResponseData } from "./ProFac/PayFacResponseData";
+export declare class Transaction {
+    authorizedAmount: string;
+    balanceAmount: string;
+    pointsBalanceAmount: string;
+    cardBrandTransactionId: string;
+    commercialIndicator: string;
+    responseCode: string;
+    responseMessage: string;
+    transactionDescriptor: string;
+    referenceNumber: string;
+    recurringDataCode: string;
+    cvnResponseMessage: string;
+    cvnResponseCode: string;
+    cavvResponseCode: string;
+    multiCapture: boolean;
+    multiCapturePaymentCount: number;
+    multiCaptureSequence: StoredCredentialSequence;
+    cardLast4: string;
+    cardType: string;
+    avsResponseMessage: string;
+    avsResponseCode: string;
+    availableBalance: string;
+    transactionReference: TransactionReference;
+    token: string;
+    giftCard: GiftCard;
+    clientTransactionId: string;
+    timestamp: string;
+    batchId: string;
+    batchSeqNbr: string;
+    payFacData: PayFacResponseData;
+    payerDetails: PayerDetails;
+    fingerprint: string;
+    fingerprintIndicator: string;
+    tokenUsageMode: PaymentMethodUsageMode;
+    cardDetails: Card;
+    get transactionId(): string;
+    set transactionId(id: string);
+    static fromId(transactionId: string, orderId?: string | PaymentMethodType, paymentMethodType?: PaymentMethodType): Transaction;
+    /**
+     * Allows for a follow-up request to add an additional authorization
+     *
+     * @param string|number amount Amount to authorize
+     *
+     * @return AuthorizationBuilder
+     */
+    additionalAuth(amount?: string | number): ManagementBuilder;
+    /**
+     * Allows for a follow-up request to add the transaction to an open batch
+     *
+     * @param string|number amount Amount to capture
+     *
+     * @return ManagementBuilder
+     */
+    capture(amount?: string | number): ManagementBuilder;
+    /**
+     * Allows for a follow-up request to edit the transaction
+     *
+     * @return ManagementBuilder
+     */
+    edit(): ManagementBuilder;
+    hold(): ManagementBuilder;
+    /**
+     * Allows for a follow-up request to refund the transaction
+     *
+     * @param {string|number} amount Amount to refund
+     *
+     * @return ManagementBuilder
+     */
+    refund(amount?: string | number | null): ManagementBuilder;
+    release(): ManagementBuilder;
+    /**
+     * Refresh the authorization associated with a transaction to get a more recent authcode or
+     * reauthorize a transaction reversed in error.
+     *
+     * @param {string|number|null} amount Amount to reverse
+     *
+     * @return ManagementBuilder
+     */
+    reauthorized(amount?: string | number | null): ManagementBuilder;
+    /**
+     * Allows for a follow-up request to reverse the transaction
+     *
+     * @param string|number amount Amount to reverse
+     *
+     * @return ManagementBuilder
+     */
+    reverse(amount?: string | number | null): ManagementBuilder;
+    /**
+     * Allows for a follow-up request to void the transaction
+     *
+     * @return ManagementBuilder
+     */
+    void(): ManagementBuilder;
+}

package/lib/src/Entities/Transaction.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transaction = void 0;
+const __1 = require("../");
+class Transaction {
+    authorizedAmount;
+    balanceAmount;
+    pointsBalanceAmount;
+    cardBrandTransactionId;
+    commercialIndicator;
+    responseCode;
+    responseMessage;
+    transactionDescriptor;
+    referenceNumber;
+    recurringDataCode;
+    cvnResponseMessage;
+    cvnResponseCode;
+    cavvResponseCode;
+    multiCapture;
+    multiCapturePaymentCount;
+    multiCaptureSequence;
+    cardLast4;
+    cardType;
+    avsResponseMessage;
+    avsResponseCode;
+    availableBalance;
+    transactionReference;
+    token;
+    giftCard;
+    clientTransactionId;
+    timestamp;
+    batchId;
+    batchSeqNbr;
+    payFacData;
+    payerDetails;
+    fingerprint;
+    fingerprintIndicator;
+    tokenUsageMode;
+    cardDetails;
+    get transactionId() {
+        return this.transactionReference?.transactionId;
+    }
+    set transactionId(id) {
+        if (!this.transactionReference) {
+            this.transactionReference = new __1.TransactionReference();
+        }
+        this.transactionReference.transactionId = id;
+    }
+    static fromId(transactionId, orderId, paymentMethodType = __1.PaymentMethodType.Credit) {
+        const transaction = new Transaction();
+        transaction.transactionReference = new __1.TransactionReference();
+        transaction.transactionReference.transactionId = transactionId;
+        if (orderId &&
+            (typeof orderId === "string" ||
+                Object.prototype.toString.call(orderId) === "[object String]")) {
+            transaction.transactionReference.orderId = orderId;
+        }
+        else if (orderId) {
+            paymentMethodType = orderId;
+        }
+        transaction.transactionReference.paymentMethodType = paymentMethodType;
+        return transaction;
+    }
+    /**
+     * Allows for a follow-up request to add an additional authorization
+     *
+     * @param string|number amount Amount to authorize
+     *
+     * @return AuthorizationBuilder
+     */
+    additionalAuth(amount) {
+        return new __1.ManagementBuilder(__1.TransactionType.Auth)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    }
+    /**
+     * Allows for a follow-up request to add the transaction to an open batch
+     *
+     * @param string|number amount Amount to capture
+     *
+     * @return ManagementBuilder
+     */
+    capture(amount) {
+        const builder = new __1.ManagementBuilder(__1.TransactionType.Capture)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+        if (this.multiCapture) {
+            builder.withMultiCapture(this.multiCaptureSequence, this.multiCapturePaymentCount);
+        }
+        return builder;
+    }
+    /**
+     * Allows for a follow-up request to edit the transaction
+     *
+     * @return ManagementBuilder
+     */
+    edit() {
+        let builder = new __1.ManagementBuilder(__1.TransactionType.Edit).withPaymentMethod(this.transactionReference);
+        if (this.commercialIndicator) {
+            builder = builder.withModifier(__1.TransactionModifier.LevelII);
+        }
+        return builder;
+    }
+    hold() {
+        return new __1.ManagementBuilder(__1.TransactionType.Hold).withPaymentMethod(this.transactionReference);
+    }
+    /**
+     * Allows for a follow-up request to refund the transaction
+     *
+     * @param {string|number} amount Amount to refund
+     *
+     * @return ManagementBuilder
+     */
+    refund(amount = null) {
+        return new __1.ManagementBuilder(__1.TransactionType.Refund)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    }
+    release() {
+        return new __1.ManagementBuilder(__1.TransactionType.Release).withPaymentMethod(this.transactionReference);
+    }
+    /**
+     * Refresh the authorization associated with a transaction to get a more recent authcode or
+     * reauthorize a transaction reversed in error.
+     *
+     * @param {string|number|null} amount Amount to reverse
+     *
+     * @return ManagementBuilder
+     */
+    reauthorized(amount = null) {
+        return new __1.ManagementBuilder(__1.TransactionType.Reauth)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    }
+    /**
+     * Allows for a follow-up request to reverse the transaction
+     *
+     * @param string|number amount Amount to reverse
+     *
+     * @return ManagementBuilder
+     */
+    reverse(amount = null) {
+        return new __1.ManagementBuilder(__1.TransactionType.Reversal)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    }
+    /**
+     * Allows for a follow-up request to void the transaction
+     *
+     * @return ManagementBuilder
+     */
+    void() {
+        return new __1.ManagementBuilder(__1.TransactionType.Void).withPaymentMethod(this.transactionReference);
+    }
+}
+exports.Transaction = Transaction;
+//# sourceMappingURL=Transaction.js.map

package/lib/src/Entities/Transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../src/Entities/Transaction.ts"],"names":[],"mappings":";;;AAAA,2BAWa;AAEb,MAAa,WAAW;IACf,gBAAgB,CAAS;IACzB,aAAa,CAAS;IACtB,mBAAmB,CAAS;IAC5B,sBAAsB,CAAS;IAC/B,mBAAmB,CAAS;IAC5B,YAAY,CAAS;IACrB,eAAe,CAAS;IACxB,qBAAqB,CAAS;IAC9B,eAAe,CAAS;IACxB,iBAAiB,CAAS;IAC1B,kBAAkB,CAAS;IAC3B,eAAe,CAAS;IACxB,gBAAgB,CAAS;IACzB,YAAY,CAAU;IACtB,wBAAwB,CAAS;IACjC,oBAAoB,CAA2B;IAC/C,SAAS,CAAS;IAClB,QAAQ,CAAS;IACjB,kBAAkB,CAAS;IAC3B,eAAe,CAAS;IACxB,gBAAgB,CAAS;IACzB,oBAAoB,CAAuB;IAC3C,KAAK,CAAS;IACd,QAAQ,CAAW;IACnB,mBAAmB,CAAS;IAC5B,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,WAAW,CAAS;IACpB,UAAU,CAAqB;IAC/B,YAAY,CAAe;IAC3B,WAAW,CAAS;IACpB,oBAAoB,CAAS;IAC7B,cAAc,CAAyB;IACvC,WAAW,CAAO;IAEzB,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC;IAClD,CAAC;IAED,IAAI,aAAa,CAAC,EAAU;QAC1B,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAC9B,IAAI,CAAC,oBAAoB,GAAG,IAAI,wBAAoB,EAAE,CAAC;SACxD;QACD,IAAI,CAAC,oBAAoB,CAAC,aAAa,GAAG,EAAE,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,aAAqB,EACrB,OAAoC,EACpC,iBAAiB,GAAG,qBAAiB,CAAC,MAAM;QAE5C,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,WAAW,CAAC,oBAAoB,GAAG,IAAI,wBAAoB,EAAE,CAAC;QAC9D,WAAW,CAAC,oBAAoB,CAAC,aAAa,GAAG,aAAa,CAAC;QAE/D,IACE,OAAO;YACP,CAAC,OAAO,OAAO,KAAK,QAAQ;gBAC1B,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,iBAAiB,CAAC,EAChE;YACA,WAAW,CAAC,oBAAoB,CAAC,OAAO,GAAG,OAAiB,CAAC;SAC9D;aAAM,IAAI,OAAO,EAAE;YAClB,iBAAiB,GAAG,OAA4B,CAAC;SAClD;QAED,WAAW,CAAC,oBAAoB,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QACvE,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,MAAwB;QAC5C,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,IAAI,CAAC;aAC/C,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,MAAwB;QACrC,MAAM,OAAO,GAAG,IAAI,qBAAiB,CAAC,mBAAe,CAAC,OAAO,CAAC;aAC3D,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;QAEtB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,gBAAgB,CACtB,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,wBAAwB,CAC9B,CAAC;SACH;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,IAAI,OAAO,GAAG,IAAI,qBAAiB,CAAC,mBAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,CACzE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QAEF,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5B,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,uBAAmB,CAAC,OAAO,CAAC,CAAC;SAC7D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAClE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,SAAiC,IAAI;QACjD,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,MAAM,CAAC;aACjD,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,CACrE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAAC,SAAiC,IAAI;QACvD,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,MAAM,CAAC;aACjD,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,SAAiC,IAAI;QAClD,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,QAAQ,CAAC;aACnD,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAClE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;IACJ,CAAC;CACF;AAxLD,kCAwLC"}

package/lib/src/Entities/TransactionStatus.d.ts

@@ -0,0 +1,13 @@
+export declare class TransactionStatus {
+    static INITIATED: string;
+    static AUTHENTICATED: string;
+    static PENDING: string;
+    static DECLINED: string;
+    static PREAUTHORIZED: string;
+    static CAPTURED: string;
+    static BATCHED: string;
+    static REVERSED: string;
+    static FUNDED: string;
+    static REJECTED: string;
+    static mapTransactionStatusResponse: Record<string, string>;
+}