globalpayments-api 2.0.0 → 3.0.0

package/lib/src/Entities/Transaction.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transaction = void 0;
+var __1 = require("../");
+var Transaction = /** @class */ (function () {
+    function Transaction() {
+    }
+    Object.defineProperty(Transaction.prototype, "transactionId", {
+        get: function () {
+            return this.transactionReference.transactionId;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Transaction.fromId = function (transactionId, orderId, paymentMethodType) {
+        if (paymentMethodType === void 0) { paymentMethodType = __1.PaymentMethodType.Credit; }
+        var 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
+     */
+    Transaction.prototype.additionalAuth = function (amount) {
+        return new __1.AuthorizationBuilder(__1.TransactionType.Auth)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount)
+            .withModifier(__1.TransactionModifier.Additional);
+    };
+    /**
+     * Allows for a follow-up request to add the transaction to an open batch
+     *
+     * @param string|number amount Amount to capture
+     *
+     * @return ManagementBuilder
+     */
+    Transaction.prototype.capture = function (amount) {
+        return new __1.ManagementBuilder(__1.TransactionType.Capture)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    };
+    /**
+     * Allows for a follow-up request to edit the transaction
+     *
+     * @return ManagementBuilder
+     */
+    Transaction.prototype.edit = function () {
+        var builder = new __1.ManagementBuilder(__1.TransactionType.Edit).withPaymentMethod(this.transactionReference);
+        if (this.commercialIndicator) {
+            builder = builder.withModifier(__1.TransactionModifier.LevelII);
+        }
+        return builder;
+    };
+    Transaction.prototype.hold = function () {
+        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
+     */
+    Transaction.prototype.refund = function (amount) {
+        return new __1.ManagementBuilder(__1.TransactionType.Refund)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    };
+    Transaction.prototype.release = function () {
+        return new __1.ManagementBuilder(__1.TransactionType.Release).withPaymentMethod(this.transactionReference);
+    };
+    /**
+     * Allows for a follow-up request to reverse the transaction
+     *
+     * @param string|number amount Amount to reverse
+     *
+     * @return ManagementBuilder
+     */
+    Transaction.prototype.reverse = function (amount) {
+        return new __1.ManagementBuilder(__1.TransactionType.Reversal)
+            .withPaymentMethod(this.transactionReference)
+            .withAmount(amount);
+    };
+    /**
+     * Allows for a follow-up request to void the transaction
+     *
+     * @return ManagementBuilder
+     */
+    Transaction.prototype.void = function () {
+        return new __1.ManagementBuilder(__1.TransactionType.Void).withPaymentMethod(this.transactionReference);
+    };
+    return Transaction;
+}());
+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,yBAQa;AAEb;IAAA;IAmJA,CAAC;IAvHC,sBAAI,sCAAa;aAAjB;YACE,OAAO,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC;QACjD,CAAC;;;OAAA;IAEa,kBAAM,GAApB,UACE,aAAqB,EACrB,OAAoC,EACpC,iBAA4C;QAA5C,kCAAA,EAAA,oBAAoB,qBAAiB,CAAC,MAAM;QAE5C,IAAM,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,oCAAc,GAArB,UAAsB,MAAwB;QAC5C,OAAO,IAAI,wBAAoB,CAAC,mBAAe,CAAC,IAAI,CAAC;aAClD,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC;aAClB,YAAY,CAAC,uBAAmB,CAAC,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,6BAAO,GAAd,UAAe,MAAwB;QACrC,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,OAAO,CAAC;aAClD,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,0BAAI,GAAX;QACE,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,0BAAI,GAAX;QACE,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAClE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,4BAAM,GAAb,UAAc,MAAwB;QACpC,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,MAAM,CAAC;aACjD,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC;aAC5C,UAAU,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAEM,6BAAO,GAAd;QACE,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,CACrE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,6BAAO,GAAd,UAAe,MAAwB;QACrC,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,0BAAI,GAAX;QACE,OAAO,IAAI,qBAAiB,CAAC,mBAAe,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAClE,IAAI,CAAC,oBAAoB,CAC1B,CAAC;IACJ,CAAC;IACH,kBAAC;AAAD,CAAC,AAnJD,IAmJC;AAnJY,kCAAW"}

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

@@ -0,0 +1,61 @@
+export declare class TransactionSummary {
+    accountDataSource: string;
+    amount: string;
+    authCode: string;
+    authorizedAmount: string;
+    batchCloseDate: Date;
+    batchSequenceNumber: string;
+    cardSwiped: string;
+    cardType: string;
+    clerkId: string;
+    clientTransactionId: string;
+    convenienceAmt: string;
+    deviceId: string;
+    issuerResponseCode: string;
+    issuerResponseMessage: string;
+    issuerTransactionId: string;
+    gatewayResponseCode: string;
+    gatewayResponseMessage: string;
+    gratuityAmount: string;
+    maskedCardNumber: string;
+    originalTransactionId: string;
+    paymentType: string;
+    poNumber: string;
+    referenceNumber: string;
+    responseDate: Date;
+    serviceName: string;
+    settlementAmount: string;
+    shippingAmt: string;
+    siteTrace: string;
+    status: string;
+    taxAmount: string;
+    taxType: string;
+    transactionDate: Date;
+    transactionId: string;
+    username: string;
+    description: string;
+    invoiceNumber: string;
+    customerId: string;
+    uniqueDeviceId: string;
+    transactionDescriptor: string;
+    giftCurrency: string;
+    maskedAlias: string;
+    paymentMethodKey: string;
+    scheduleId: string;
+    oneTimePayment: string;
+    recurringDataCode: string;
+    surchargeAmount: string;
+    fraudRuleInfo: string;
+    repeatCount: string;
+    emvChipCondition: string;
+    hasEmvTags: string;
+    hasEcomPaymentData: string;
+    cavvResponseCode: string;
+    tokenPanLastFour: string;
+    companyName: string;
+    customerFirstName: string;
+    customerLastName: string;
+    debtRepaymentIndicator: string;
+    captureAmount: string;
+    fullyCaptured: string;
+}

package/lib/src/Entities/TransactionSummary.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionSummary = void 0;
+var TransactionSummary = /** @class */ (function () {
+    function TransactionSummary() {
+    }
+    return TransactionSummary;
+}());
+exports.TransactionSummary = TransactionSummary;
+//# sourceMappingURL=TransactionSummary.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionSummary.js","sourceRoot":"","sources":["../../../src/Entities/TransactionSummary.ts"],"names":[],"mappings":";;;AAAA;IAAA;IA6DA,CAAC;IAAD,yBAAC;AAAD,CAAC,AA7DD,IA6DC;AA7DY,gDAAkB"}

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

@@ -0,0 +1,15 @@
+export * from "./Address";
+export * from "./BatchSummary";
+export * from "./Customer";
+export * from "./EcommerceInfo";
+export * from "./EncryptionData";
+export * from "./Enums";
+export * from "./Errors";
+export * from "./HostedPaymentData";
+export * from "./IRequestBuilder";
+export * from "./RecurringEntity";
+export * from "./Request";
+export * from "./Schedule";
+export * from "./ServiceEndpoints";
+export * from "./Transaction";
+export * from "./TransactionSummary";

package/lib/src/Entities/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Address"), exports);
+__exportStar(require("./BatchSummary"), exports);
+__exportStar(require("./Customer"), exports);
+__exportStar(require("./EcommerceInfo"), exports);
+__exportStar(require("./EncryptionData"), exports);
+__exportStar(require("./Enums"), exports);
+__exportStar(require("./Errors"), exports);
+__exportStar(require("./HostedPaymentData"), exports);
+__exportStar(require("./IRequestBuilder"), exports);
+__exportStar(require("./RecurringEntity"), exports);
+__exportStar(require("./Request"), exports);
+__exportStar(require("./Schedule"), exports);
+__exportStar(require("./ServiceEndpoints"), exports);
+__exportStar(require("./Transaction"), exports);
+__exportStar(require("./TransactionSummary"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Entities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B;AAC3B,kDAAgC;AAChC,mDAAiC;AACjC,0CAAwB;AACxB,2CAAyB;AACzB,sDAAoC;AACpC,oDAAkC;AAClC,oDAAkC;AAClC,4CAA0B;AAC1B,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,uDAAqC"}

package/lib/src/Gateways/Gateway.d.ts

@@ -0,0 +1,10 @@
+import { IDictionary } from "../Builders";
+export declare abstract class Gateway {
+    headers: IDictionary<string>;
+    timeout: number;
+    serviceUrl: string;
+    private contentType;
+    constructor(contentType: string);
+    sendRequest(httpMethod: string, endpoint: string, data?: string, queryStringParams?: IDictionary<string>): Promise<string>;
+    protected buildQueryString(queryStringParams?: IDictionary<string>): string;
+}

package/lib/src/Gateways/Gateway.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gateway = void 0;
+var url = require("url");
+var https_wrapper_1 = require("./https-wrapper");
+var Gateway = /** @class */ (function () {
+    function Gateway(contentType) {
+        this.contentType = contentType;
+        this.headers = {};
+        this.headers["Content-Type"] = this.contentType;
+    }
+    Gateway.prototype.sendRequest = function (httpMethod, endpoint, data, queryStringParams) {
+        var uri = url.parse(this.serviceUrl);
+        var queryString = this.buildQueryString(queryStringParams);
+        var options = {
+            headers: this.headers,
+            host: uri.host,
+            method: httpMethod,
+            path: uri.path + endpoint + queryString,
+            port: uri.port ? parseInt(uri.port, 10) : 443,
+            timeout: this.timeout || 100000,
+        };
+        if (data !== undefined && options && options.headers) {
+            options.headers["Content-Length"] = data.length;
+        }
+        return https_wrapper_1.request(data, options);
+    };
+    Gateway.prototype.buildQueryString = function (queryStringParams) {
+        if (queryStringParams === undefined) {
+            return "";
+        }
+        var params = [];
+        for (var param in queryStringParams) {
+            if (queryStringParams.hasOwnProperty(param)) {
+                params.push(encodeURIComponent(param) + "=" + encodeURIComponent(queryStringParams[param]));
+            }
+        }
+        return "?" + params.join("&");
+    };
+    return Gateway;
+}());
+exports.Gateway = Gateway;
+//# sourceMappingURL=Gateway.js.map

package/lib/src/Gateways/Gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gateway.js","sourceRoot":"","sources":["../../../src/Gateways/Gateway.ts"],"names":[],"mappings":";;;AACA,yBAA2B;AAG3B,iDAA0C;AAE1C;IAME,iBAAmB,WAAmB;QACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;IAClD,CAAC;IAEM,6BAAW,GAAlB,UACE,UAAkB,EAClB,QAAgB,EAChB,IAAa,EACb,iBAAuC;QAEvC,IAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvC,IAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAC7D,IAAM,OAAO,GAAmB;YAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,MAAM,EAAE,UAAU;YAClB,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,QAAQ,GAAG,WAAW;YACvC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG;YAC7C,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,MAAM;SAChC,CAAC;QAEF,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE;YACpD,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;SACjD;QAED,OAAO,uBAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAES,kCAAgB,GAA1B,UAA2B,iBAAuC;QAChE,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACnC,OAAO,EAAE,CAAC;SACX;QACD,IAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,IAAM,KAAK,IAAI,iBAAiB,EAAE;YACrC,IAAI,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE;gBAC3C,MAAM,CAAC,IAAI,CACN,kBAAkB,CAAC,KAAK,CAAC,SAAI,kBAAkB,CAChD,iBAAiB,CAAC,KAAK,CAAC,CACvB,CACJ,CAAC;aACH;SACF;QAED,OAAO,MAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAG,CAAC;IAChC,CAAC;IACH,cAAC;AAAD,CAAC,AArDD,IAqDC;AArDqB,0BAAO"}

package/lib/src/Gateways/GpEcomConnector.d.ts

@@ -0,0 +1,36 @@
+import { Element } from "@azz/elementtree";
+import { AuthorizationBuilder, Customer, HostedPaymentConfig, IPaymentGateway, IRecurringEntity, IRecurringService, ManagementBuilder, RecurringBuilder, ReportBuilder, Transaction, TransactionType } from "..";
+import { XmlGateway } from "./XmlGateway";
+import { GpEcomConfig } from "src/ServiceConfigs/Gateways/GpEcomConfig";
+export declare class GpEcomConnector extends XmlGateway implements IPaymentGateway, IRecurringService {
+    merchantId: string;
+    accountId: string;
+    sharedSecret: string;
+    channel: string;
+    rebatePassword: string;
+    refundPassword: string;
+    supportsHostedPayments: boolean;
+    supportsRetrieval: boolean;
+    supportsUpdatePaymentDetails: boolean;
+    hostedPaymentConfig: HostedPaymentConfig;
+    config: GpEcomConfig;
+    constructor(config: GpEcomConfig);
+    processAuthorization(builder: AuthorizationBuilder): Promise<Transaction | void>;
+    private executeProcess;
+    processOldAuthorization(builder: AuthorizationBuilder): Promise<Transaction>;
+    serializeRequest(builder: AuthorizationBuilder): string;
+    manageTransaction(builder: ManagementBuilder): Promise<Transaction>;
+    processReport<T>(_builder: ReportBuilder<T>): Promise<T>;
+    processRecurring<T extends IRecurringEntity>(builder: RecurringBuilder<T>): Promise<T>;
+    protected buildEnvelope(transaction: Element): string;
+    protected buildCustomer(customer: Customer): Element;
+    protected mapResponse(rawResponse: string): Transaction;
+    protected mapRecurringResponse<T extends IRecurringEntity>(rawResponse: string, builder: RecurringBuilder<T>): T;
+    protected checkResponse(root: Element, acceptedCodes?: string[]): void;
+    protected generateHash(timestamp: string, orderId: string, amount: string, currency: string, paymentData: string, verify?: boolean): string;
+    protected mapAuthRequestType(builder: AuthorizationBuilder): string;
+    protected mapManageRequestType(type: TransactionType): string;
+    protected mapRecurringRequestType<T extends IRecurringEntity>(builder: RecurringBuilder<T>): "payer-new" | "card-new" | "payer-edit" | "card-update-card" | "card-cancel-card";
+    protected numberFormat(amount: number | string): string;
+    private mapAcceptedCodes;
+}