globalpayments-api 1.4.8 → 2.0.0

package/lib/src/Entities/Schedule.js

@@ -1,253 +0,0 @@
-"use strict";
-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 __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schedule = void 0;
-var _1 = require("./");
-var Schedule = /** @class */ (function (_super) {
-    __extends(Schedule, _super);
-    function Schedule(customerKey, paymentKey) {
-        var _this = _super.call(this) || this;
-        if (customerKey) {
-            _this.customerKey = customerKey;
-        }
-        if (paymentKey) {
-            _this.paymentKey = paymentKey;
-        }
-        return _this;
-    }
-    Object.defineProperty(Schedule.prototype, "totalAmount", {
-        /// <summary>
-        /// The total amount for the schedule (`Amount` + `TaxAmount`).
-        /// </summary>
-        get: function () {
-            return (parseFloat(this.amount.toString()) + parseFloat(this.taxAmount.toString()));
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /// <summary>
-    /// Sets the schedule's amount.
-    /// </summary>
-    /// <param name="value">The amount</param>
-    /// <returns>Schedule</returns>
-    Schedule.prototype.withAmount = function (value) {
-        if (value) {
-            this.amount = value;
-        }
-        return this;
-    };
-    /// <summary>
-    /// Sets the schedule's currency.
-    /// </summary>
-    /// <param name="value">The currency</param>
-    /// <returns>Schedule</returns>
-    Schedule.prototype.withCurrency = function (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>
-    Schedule.prototype.withCustomerKey = function (value) {
-        if (value) {
-            this.customerKey = value;
-        }
-        return this;
-    };
-    /// <summary>
-    /// Sets the schedule's description.
-    /// </summary>
-    /// <param name="value">The description</param>
-    /// <returns>Schedule</returns>
-    Schedule.prototype.withDescription = function (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>
-    Schedule.prototype.withDeviceId = function (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>
-    Schedule.prototype.withEmailNotification = function (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>
-    Schedule.prototype.withEmailReceipt = function (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>
-    Schedule.prototype.withEndDate = function (value) {
-        if (value) {
-            this.endDate = value;
-        }
-        return this;
-    };
-    /// <summary>
-    /// Sets the schedule's frequency.
-    /// </summary>
-    /// <param name="value">The frequency</param>
-    /// <returns>Schedule</returns>
-    Schedule.prototype.withFrequency = function (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>
-    Schedule.prototype.withInvoiceNumber = function (value) {
-        if (value) {
-            this.invoiceNumber = value;
-        }
-        return this;
-    };
-    /// <summary>
-    /// Sets the schedule's name.
-    /// </summary>
-    /// <param name="value">The name</param>
-    /// <returns>Schedule</returns>
-    Schedule.prototype.withName = function (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>
-    Schedule.prototype.withNumberOfPayments = function (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>
-    Schedule.prototype.withPoNumber = function (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>
-    Schedule.prototype.withPaymentKey = function (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>
-    Schedule.prototype.withPaymentSchedule = function (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>
-    Schedule.prototype.withReprocessingCount = function (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>
-    Schedule.prototype.withStartDate = function (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>
-    Schedule.prototype.withStatus = function (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>
-    Schedule.prototype.withTaxAmount = function (value) {
-        if (value) {
-            this.taxAmount = value;
-        }
-        return this;
-    };
-    return Schedule;
-}(_1.RecurringEntity));
-exports.Schedule = Schedule;

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

@@ -1,76 +0,0 @@
-import { AuthorizationBuilder, GiftCard, ManagementBuilder, PaymentMethodType, TransactionReference } from "../";
-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;
-    cardLast4: string;
-    cardType: string;
-    avsResponseMessage: string;
-    avsResponseCode: string;
-    availableBalance: string;
-    transactionReference: TransactionReference;
-    token: string;
-    giftCard: GiftCard;
-    clientTransactionId: string;
-    timestamp: string;
-    batchId: string;
-    batchSeqNbr: string;
-    get transactionId(): 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): AuthorizationBuilder;
-    /**
-     * 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): ManagementBuilder;
-    release(): ManagementBuilder;
-    /**
-     * Allows for a follow-up request to reverse the transaction
-     *
-     * @param string|number amount Amount to reverse
-     *
-     * @return ManagementBuilder
-     */
-    reverse(amount?: string | number): ManagementBuilder;
-    /**
-     * Allows for a follow-up request to void the transaction
-     *
-     * @return ManagementBuilder
-     */
-    void(): ManagementBuilder;
-}

package/lib/src/Entities/Transaction.js

@@ -1,108 +0,0 @@
-"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;

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

@@ -1,61 +0,0 @@
-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

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

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

@@ -1,12 +0,0 @@
-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 "./RecurringEntity";
-export * from "./Schedule";
-export * from "./Transaction";
-export * from "./TransactionSummary";

package/lib/src/Entities/index.js

@@ -1,24 +0,0 @@
-"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("./RecurringEntity"), exports);
-__exportStar(require("./Schedule"), exports);
-__exportStar(require("./Transaction"), exports);
-__exportStar(require("./TransactionSummary"), exports);

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

@@ -1,10 +0,0 @@
-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

@@ -1,42 +0,0 @@
-"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;

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

@@ -1,8 +0,0 @@
-import { AuthorizationBuilder, ManagementBuilder, ReportBuilder, Transaction } from "../";
-export interface IPaymentGateway {
-    supportsHostedPayments: boolean;
-    processAuthorization(builder: AuthorizationBuilder): Promise<Transaction>;
-    manageTransaction(builder: ManagementBuilder): Promise<Transaction>;
-    processReport<T>(builder: ReportBuilder<T>): Promise<T>;
-    serializeRequest(builder: AuthorizationBuilder): string;
-}

package/lib/src/Gateways/IPaymentGateway.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,6 +0,0 @@
-import { IRecurringEntity, RecurringBuilder } from "../";
-export interface IRecurringService {
-    supportsRetrieval: boolean;
-    supportsUpdatePaymentDetails: boolean;
-    processRecurring<T extends IRecurringEntity>(builder: RecurringBuilder<T>): Promise<T>;
-}

package/lib/src/Gateways/IRecurringService.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,42 +0,0 @@
-import { AccountType, Address, CheckType, Customer, IPaymentMethod, IRecurringEntity, IRecurringService, RecurringBuilder, RecurringPaymentMethod, Schedule, TransactionType } from "../";
-import { RestGateway } from "./RestGateway";
-export declare class PayPlanConnector extends RestGateway implements IRecurringService {
-    supportsRetrieval: boolean;
-    supportsUpdatePaymentDetails: boolean;
-    private _secretApiKey;
-    siteId: string;
-    licenseId: string;
-    deviceId: string;
-    private _username;
-    private _password;
-    developerId: string;
-    versionNumber: string;
-    get secretApiKey(): string;
-    set secretApiKey(value: string);
-    get username(): string;
-    set username(value: string);
-    get password(): string;
-    set password(value: string);
-    processRecurring<T extends IRecurringEntity>(builder: RecurringBuilder<T>): Promise<T>;
-    protected mapResponse<T extends IRecurringEntity>(builder: RecurringBuilder<T>, rawResponse: string): T;
-    protected buildCustomer(request: any, entity: Customer): any;
-    protected buildPaymentMethod(request: any, entity: RecurringPaymentMethod, transactionType: TransactionType): any;
-    protected buildSchedule(request: any, entity: Schedule, transactionType: TransactionType): any;
-    protected prepareAccountType(type: AccountType): "Savings" | "Checking";
-    protected prepareCheckType(type: CheckType): "Business" | "Payroll" | "Personal";
-    protected buildAddress(request: any, address: Address): any;
-    protected buildAmount(request: any, name: string, amount: number | string, currency: string, transactionType: TransactionType): any;
-    protected buildDate(request: any, name: string, date: Date, force?: boolean): any;
-    protected mapMethod(transactionType: TransactionType): "POST" | "PUT" | "DELETE" | "GET";
-    protected mapUrl<T extends IRecurringEntity>(builder: RecurringBuilder<T>): string;
-    protected hydrateCustomer(response: any): Customer;
-    protected hydrateRecurringPaymentMethod(response: any): RecurringPaymentMethod;
-    protected hydrateSchedule(response: any): Schedule;
-    protected hasToken(paymentMethod: IPaymentMethod): {
-        hasToken: boolean;
-        tokenValue: string;
-    };
-    protected setAuthorizationHeader(value: string): void;
-    protected maybeSetIdentityHeader(): void;
-    protected maybeSetIntegrationHeader(): void;
-}