globalpayments-api 3.1.0 → 3.1.1

package/lib/src/Builders/BaseBuilder/ValidationClause.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationClause = void 0;
+class ValidationClause {
+    parent;
+    target;
+    callback;
+    message;
+    precondition;
+    constructor(parent, target, precondition = false) {
+        this.parent = parent;
+        this.target = target;
+        this.precondition = precondition;
+    }
+    isNotNull(message) {
+        this.callback = (builder) => {
+            const value = builder[this.target.property];
+            return undefined !== value && null !== value;
+        };
+        this.message = message
+            ? message
+            : `${this.target.property} cannot be null for this transaction type.`;
+        if (this.precondition) {
+            return this.target;
+        }
+        return this.parent
+            .of(this.target.enumName, this.target.type)
+            .with(this.target.constraintProperty, this.target.constraint);
+    }
+    isNull(message) {
+        this.callback = (builder) => {
+            const value = builder[this.target.property];
+            return undefined === value || null === value;
+        };
+        this.message = message
+            ? message
+            : `${this.target.property} cannot be set for this transaction type.`;
+        if (this.precondition) {
+            return this.target;
+        }
+        return this.parent
+            .of(this.target.enumName, this.target.type)
+            .with(this.target.constraintProperty, this.target.constraint);
+    }
+    isNotEmpty(message) {
+        this.callback = (builder) => {
+            const value = builder[this.target.property];
+            return !!value;
+        };
+        this.message = message
+            ? message
+            : `${this.target.property} cannot be empty for this transaction type.`;
+        if (this.precondition) {
+            return this.target;
+        }
+        return this.parent
+            .of(this.target.enumName, this.target.type)
+            .with(this.target.constraintProperty, this.target.constraint);
+    }
+}
+exports.ValidationClause = ValidationClause;
+//# sourceMappingURL=ValidationClause.js.map

package/lib/src/Builders/BaseBuilder/ValidationClause.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationClause.js","sourceRoot":"","sources":["../../../../src/Builders/BaseBuilder/ValidationClause.ts"],"names":[],"mappings":";;;AAIA,MAAa,gBAAgB;IACpB,MAAM,CAAc;IACpB,MAAM,CAAmB;IACzB,QAAQ,CAAwC;IAChD,OAAO,CAAS;IAChB,YAAY,CAAU;IAE7B,YACE,MAAmB,EACnB,MAAwB,EACxB,YAAY,GAAG,KAAK;QAEpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAEM,SAAS,CAAC,OAAgB;QAC/B,IAAI,CAAC,QAAQ,GAAG,CAAI,OAAuB,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC5C,OAAO,SAAS,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,CAAC;QAC/C,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO;YACpB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,4CAA4C,CAAC;QAExE,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;QAED,OAAO,IAAI,CAAC,MAAM;aACf,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;aAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAEM,MAAM,CAAC,OAAgB;QAC5B,IAAI,CAAC,QAAQ,GAAG,CAAI,OAAuB,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC5C,OAAO,SAAS,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,CAAC;QAC/C,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO;YACpB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,2CAA2C,CAAC;QAEvE,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;QAED,OAAO,IAAI,CAAC,MAAM;aACf,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;aAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAEM,UAAU,CAAC,OAAgB;QAChC,IAAI,CAAC,QAAQ,GAAG,CAAI,OAAuB,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC5C,OAAO,CAAC,CAAC,KAAK,CAAC;QACjB,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO;YACpB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,6CAA6C,CAAC;QAEzE,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;QAED,OAAO,IAAI,CAAC,MAAM;aACf,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;aAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;CACF;AAtED,4CAsEC"}

package/lib/src/Builders/BaseBuilder/ValidationTarget.d.ts

@@ -0,0 +1,16 @@
+import { ValidationClause } from "./ValidationClause";
+import { Validations } from "./Validations";
+export declare class ValidationTarget {
+    parent: Validations;
+    type: number;
+    property: string;
+    clause: ValidationClause;
+    constraint: number;
+    constraintProperty: string;
+    enumName: string;
+    precondition: ValidationClause;
+    constructor(parent: Validations, enumName: string, type: number);
+    with(property: string, constraint: number): this;
+    check(targetProperty: string): ValidationClause;
+    when(targetProperty: string): ValidationClause;
+}

package/lib/src/Builders/BaseBuilder/ValidationTarget.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationTarget = void 0;
+const ValidationClause_1 = require("./ValidationClause");
+class ValidationTarget {
+    parent;
+    type;
+    property;
+    clause;
+    constraint;
+    constraintProperty;
+    enumName;
+    precondition;
+    constructor(parent, enumName, type) {
+        this.parent = parent;
+        this.type = type;
+        this.enumName = enumName;
+    }
+    with(property, constraint) {
+        this.constraintProperty = property;
+        this.constraint = constraint;
+        return this;
+    }
+    check(targetProperty) {
+        this.property = targetProperty;
+        this.clause = new ValidationClause_1.ValidationClause(this.parent, this);
+        return this.clause;
+    }
+    when(targetProperty) {
+        this.property = targetProperty;
+        this.precondition = new ValidationClause_1.ValidationClause(this.parent, this, true);
+        return this.precondition;
+    }
+}
+exports.ValidationTarget = ValidationTarget;
+//# sourceMappingURL=ValidationTarget.js.map

package/lib/src/Builders/BaseBuilder/ValidationTarget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationTarget.js","sourceRoot":"","sources":["../../../../src/Builders/BaseBuilder/ValidationTarget.ts"],"names":[],"mappings":";;;AAAA,yDAAsD;AAGtD,MAAa,gBAAgB;IACpB,MAAM,CAAc;IACpB,IAAI,CAAS;IACb,QAAQ,CAAS;IACjB,MAAM,CAAmB;IACzB,UAAU,CAAS;IACnB,kBAAkB,CAAS;IAC3B,QAAQ,CAAS;IACjB,YAAY,CAAmB;IAEtC,YAAmB,MAAmB,EAAE,QAAgB,EAAE,IAAY;QACpE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAEM,IAAI,CAAC,QAAgB,EAAE,UAAkB;QAC9C,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,cAAsB;QACjC,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,IAAI,CAAC,cAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC;QAC/B,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;CACF;AAjCD,4CAiCC"}

package/lib/src/Builders/BaseBuilder/Validations.d.ts

@@ -0,0 +1,11 @@
+import { BaseBuilder } from "../../";
+import { ValidationTarget } from "./ValidationTarget";
+export interface IRuleSet {
+    [key: string]: ValidationTarget[][];
+}
+export declare class Validations {
+    rules: IRuleSet;
+    constructor();
+    of(enumProperty: string, type: number): ValidationTarget;
+    validate<T>(builder: BaseBuilder<T>): void;
+}

package/lib/src/Builders/BaseBuilder/Validations.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validations = void 0;
+const __1 = require("../../");
+const ValidationTarget_1 = require("./ValidationTarget");
+class Validations {
+    rules;
+    constructor() {
+        this.rules = {};
+    }
+    of(enumProperty, type) {
+        if (!this.rules.hasOwnProperty(enumProperty)) {
+            this.rules[enumProperty] = [];
+        }
+        if (!this.rules[enumProperty].hasOwnProperty(type.toString())) {
+            this.rules[enumProperty][type] = [];
+        }
+        const target = new ValidationTarget_1.ValidationTarget(this, enumProperty, type);
+        this.rules[enumProperty][type].push(target);
+        return target;
+    }
+    validate(builder) {
+        Object.keys(this.rules).forEach((enumName) => {
+            this.rules[enumName].forEach((rules, iKey) => {
+                let value = builder[enumName];
+                if ((value === undefined || value === null) &&
+                    builder instanceof __1.TransactionBuilder &&
+                    builder.paymentMethod) {
+                    value = builder.paymentMethod[enumName];
+                    if (value === undefined || value === null) {
+                        return;
+                    }
+                }
+                if ((iKey & value) !== value) {
+                    return;
+                }
+                for (const validation of rules) {
+                    if (!validation.clause) {
+                        continue;
+                    }
+                    if (validation.constraint !== undefined &&
+                        validation.constraint !== null &&
+                        validation.constraint !== builder[validation.constraintProperty]) {
+                        continue;
+                    }
+                    if (!validation.clause.callback(builder)) {
+                        throw new __1.BuilderError(validation.clause.message);
+                    }
+                }
+            });
+        });
+    }
+}
+exports.Validations = Validations;
+//# sourceMappingURL=Validations.js.map

package/lib/src/Builders/BaseBuilder/Validations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validations.js","sourceRoot":"","sources":["../../../../src/Builders/BaseBuilder/Validations.ts"],"names":[],"mappings":";;;AAAA,8BAAuE;AACvE,yDAAsD;AAMtD,MAAa,WAAW;IACf,KAAK,CAAW;IAEvB;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAEM,EAAE,CAAC,YAAoB,EAAE,IAAY;QAC1C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;YAC5C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;SAC/B;QAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC7D,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SACrC;QAED,MAAM,MAAM,GAAG,IAAI,mCAAgB,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5C,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,QAAQ,CAAI,OAAuB;QACxC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,KAAK,GAAW,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEtC,IACE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;oBACvC,OAAO,YAAY,sBAAkB;oBACrC,OAAO,CAAC,aAAa,EACrB;oBACA,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;oBACxC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;wBACzC,OAAO;qBACR;iBACF;gBAED,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,KAAK,EAAE;oBAC5B,OAAO;iBACR;gBAED,KAAK,MAAM,UAAU,IAAI,KAAK,EAAE;oBAC9B,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;wBACtB,SAAS;qBACV;oBAED,IACE,UAAU,CAAC,UAAU,KAAK,SAAS;wBACnC,UAAU,CAAC,UAAU,KAAK,IAAI;wBAC9B,UAAU,CAAC,UAAU,KAAK,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAChE;wBACA,SAAS;qBACV;oBAED,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;wBACxC,MAAM,IAAI,gBAAY,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;qBACnD;iBACF;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,kCA6DC"}

package/lib/src/Builders/BaseBuilder.d.ts

@@ -0,0 +1,11 @@
+import { Validations } from "./BaseBuilder/Validations";
+export interface IDictionary<T> {
+    [key: string]: T;
+}
+export declare abstract class BaseBuilder<T> {
+    protected validations: Validations;
+    [key: string]: any;
+    constructor();
+    execute(): Promise<T | undefined>;
+    protected abstract setupValidations(): void;
+}

package/lib/src/Builders/BaseBuilder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseBuilder = void 0;
+const Validations_1 = require("./BaseBuilder/Validations");
+class BaseBuilder {
+    validations;
+    constructor() {
+        this.validations = new Validations_1.Validations();
+        this.setupValidations();
+    }
+    execute() {
+        this.validations.validate(this);
+        return Promise.resolve(undefined);
+    }
+}
+exports.BaseBuilder = BaseBuilder;
+//# sourceMappingURL=BaseBuilder.js.map

package/lib/src/Builders/BaseBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseBuilder.js","sourceRoot":"","sources":["../../../src/Builders/BaseBuilder.ts"],"names":[],"mappings":";;;AAAA,2DAAwD;AAMxD,MAAsB,WAAW;IACrB,WAAW,CAAc;IAGnC;QACE,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QACrC,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;CAGF;AAfD,kCAeC"}

package/lib/src/Builders/ManagementBuilder.d.ts

@@ -0,0 +1,104 @@
+import { ReasonCode, TaxType, Transaction } from "../";
+import { TransactionBuilder } from "./TransactionBuilder";
+export declare class ManagementBuilder extends TransactionBuilder<Transaction> {
+    amount: string | number;
+    authAmount: string | number;
+    get authorizationCode(): string | undefined;
+    get clientTransactionId(): string | undefined;
+    currency: string;
+    description: string;
+    gratuity: string | number;
+    get orderId(): string | undefined;
+    poNumber: string;
+    reasonCode?: ReasonCode;
+    taxAmount: string | number;
+    taxType: TaxType;
+    get transactionId(): string | undefined;
+    constructor(type: number);
+    /**
+     * Executes the builder against the gateway.
+     *
+     * @returns Promise<Transaction>
+     */
+    execute(configName?: string): Promise<Transaction>;
+    protected setupValidations(): void;
+    /**
+     * Sets the current transaction's amount.
+     *
+     * @param amount The amount
+     * @returns ManagementBuilder
+     */
+    withAmount(amount?: string | number): this;
+    /**
+     * Sets the current transaction's authorized amount; where applicable.
+     *
+     * @param amount The authorized amount
+     * @returns ManagementBuilder
+     */
+    withAuthAmount(amount?: string | number): this;
+    /**
+     * Sets the currency.
+     *
+     * The formatting for the supplied value will currently depend on
+     * the configured gateway's requirements.
+     *
+     * @param currency The currency
+     * @returns ManagementBuilder
+     */
+    withCurrency(currency?: string): this;
+    /**
+     * Sets the transaction's description.
+     *
+     * This value is not guaranteed to be sent in the authorization
+     * or settlement process.
+     *
+     * @param description The description
+     * @returns ManagementBuilder
+     */
+    withDescription(description?: string): this;
+    /**
+     * Sets the gratuity amount; where applicable.
+     *
+     * This value is information only and does not affect
+     * the authorization amount.
+     *
+     * @param gratuity The gratuity amount
+     * @returns ManagementBuilder
+     */
+    withGratuity(gratuity?: string | number): this;
+    /**
+     * Sets the purchase order number; where applicable.
+     *
+     * @param poNumber The PO number
+     * @returns ManagementBuilder
+     */
+    withPoNumber(poNumber?: string): this;
+    /**
+     * Sets the reason code for the transaction.
+     *
+     * @param reasonCode The reason code
+     * @returns ManagementBuilder
+     */
+    withReasonCode(reasonCode?: ReasonCode): this;
+    /**
+     * Sets the tax amount.
+     *
+     * Useful for commercial purchase card requests.
+     *
+     * @see AuthorizationBuilder.WithCommercialRequest
+     * @param amount The tax amount
+     * @returns ManagementBuilder
+     */
+    withTaxAmount(amount?: string | number): this;
+    /**
+     * Sets the tax type.
+     *
+     * Useful for commercial purchase card requests.
+     *
+     * @see AuthorizationBuilder.withCommercialRequest
+     * @param type The tax type
+     * @returns ManagementBuilder
+     */
+    withTaxType(type?: TaxType): this;
+    withDynamicDescriptor(dynamicDescriptor: string): this;
+}

package/lib/src/Builders/ManagementBuilder.js

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManagementBuilder = void 0;
+const __1 = require("../");
+const TransactionBuilder_1 = require("./TransactionBuilder");
+class ManagementBuilder extends TransactionBuilder_1.TransactionBuilder {
+    amount;
+    authAmount;
+    get authorizationCode() {
+        if (this.paymentMethod instanceof __1.TransactionReference) {
+            return this.paymentMethod.authCode;
+        }
+        return undefined;
+    }
+    get clientTransactionId() {
+        if (this.paymentMethod instanceof __1.TransactionReference) {
+            return this.paymentMethod.clientTransactionId;
+        }
+        return undefined;
+    }
+    currency;
+    description;
+    gratuity;
+    get orderId() {
+        if (this.paymentMethod instanceof __1.TransactionReference) {
+            return this.paymentMethod.orderId;
+        }
+        return undefined;
+    }
+    poNumber;
+    reasonCode;
+    taxAmount;
+    taxType;
+    get transactionId() {
+        if (this.paymentMethod instanceof __1.TransactionReference) {
+            return this.paymentMethod.transactionId;
+        }
+        return undefined;
+    }
+    constructor(type) {
+        super(type);
+    }
+    /**
+     * Executes the builder against the gateway.
+     *
+     * @returns Promise<Transaction>
+     */
+    execute(configName = "default") {
+        super.execute();
+        return __1.ServicesContainer.instance()
+            .getClient(configName)
+            .manageTransaction(this);
+    }
+    setupValidations() {
+        this.validations
+            .of("transactionType", 
+        /* tslint:disable:trailing-comma */
+        __1.TransactionType.Capture |
+            __1.TransactionType.Edit |
+            __1.TransactionType.Hold |
+            __1.TransactionType.Release)
+            .check("transactionId")
+            .isNotNull();
+        this.validations
+            .of("transactionType", __1.TransactionType.Edit)
+            .with("transactionModifier", __1.TransactionModifier.LevelII)
+            .check("taxType")
+            .isNotNull();
+        this.validations
+            .of("transactionType", __1.TransactionType.Refund)
+            .when("amount")
+            .isNotNull()
+            .check("currency")
+            .isNotNull();
+    }
+    /**
+     * Sets the current transaction's amount.
+     *
+     * @param amount The amount
+     * @returns ManagementBuilder
+     */
+    withAmount(amount) {
+        if (amount !== undefined) {
+            this.amount = amount;
+        }
+        return this;
+    }
+    /**
+     * Sets the current transaction's authorized amount; where applicable.
+     *
+     * @param amount The authorized amount
+     * @returns ManagementBuilder
+     */
+    withAuthAmount(amount) {
+        if (amount !== undefined) {
+            this.authAmount = amount;
+        }
+        return this;
+    }
+    /**
+     * Sets the currency.
+     *
+     * The formatting for the supplied value will currently depend on
+     * the configured gateway's requirements.
+     *
+     * @param currency The currency
+     * @returns ManagementBuilder
+     */
+    withCurrency(currency) {
+        if (currency !== undefined) {
+            this.currency = currency;
+        }
+        return this;
+    }
+    /**
+     * Sets the transaction's description.
+     *
+     * This value is not guaranteed to be sent in the authorization
+     * or settlement process.
+     *
+     * @param description The description
+     * @returns ManagementBuilder
+     */
+    withDescription(description) {
+        if (description !== undefined) {
+            this.description = description;
+        }
+        return this;
+    }
+    /**
+     * Sets the gratuity amount; where applicable.
+     *
+     * This value is information only and does not affect
+     * the authorization amount.
+     *
+     * @param gratuity The gratuity amount
+     * @returns ManagementBuilder
+     */
+    withGratuity(gratuity) {
+        if (gratuity !== undefined) {
+            this.gratuity = gratuity;
+        }
+        return this;
+    }
+    /**
+     * Sets the purchase order number; where applicable.
+     *
+     * @param poNumber The PO number
+     * @returns ManagementBuilder
+     */
+    withPoNumber(poNumber) {
+        this.transactionModifier = __1.TransactionModifier.LevelII;
+        if (poNumber !== undefined) {
+            this.poNumber = poNumber;
+        }
+        return this;
+    }
+    /**
+     * Sets the reason code for the transaction.
+     *
+     * @param reasonCode The reason code
+     * @returns ManagementBuilder
+     */
+    withReasonCode(reasonCode) {
+        if (reasonCode !== undefined) {
+            this.reasonCode = reasonCode;
+        }
+        return this;
+    }
+    /**
+     * Sets the tax amount.
+     *
+     * Useful for commercial purchase card requests.
+     *
+     * @see AuthorizationBuilder.WithCommercialRequest
+     * @param amount The tax amount
+     * @returns ManagementBuilder
+     */
+    withTaxAmount(amount) {
+        this.transactionModifier = __1.TransactionModifier.LevelII;
+        if (amount !== undefined) {
+            this.taxAmount = amount;
+        }
+        return this;
+    }
+    /**
+     * Sets the tax type.
+     *
+     * Useful for commercial purchase card requests.
+     *
+     * @see AuthorizationBuilder.withCommercialRequest
+     * @param type The tax type
+     * @returns ManagementBuilder
+     */
+    withTaxType(type) {
+        this.transactionModifier = __1.TransactionModifier.LevelII;
+        if (type !== undefined) {
+            this.taxType = type;
+        }
+        return this;
+    }
+    withDynamicDescriptor(dynamicDescriptor) {
+        this.dynamicDescriptor = dynamicDescriptor;
+        return this;
+    }
+}
+exports.ManagementBuilder = ManagementBuilder;
+//# sourceMappingURL=ManagementBuilder.js.map

package/lib/src/Builders/ManagementBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManagementBuilder.js","sourceRoot":"","sources":["../../../src/Builders/ManagementBuilder.ts"],"names":[],"mappings":";;;AAAA,2BAQa;AACb,6DAA0D;AAE1D,MAAa,iBAAkB,SAAQ,uCAA+B;IAC7D,MAAM,CAAkB;IACxB,UAAU,CAAkB;IACnC,IAAW,iBAAiB;QAC1B,IAAI,IAAI,CAAC,aAAa,YAAY,wBAAoB,EAAE;YACtD,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;SACpC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAW,mBAAmB;QAC5B,IAAI,IAAI,CAAC,aAAa,YAAY,wBAAoB,EAAE;YACtD,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;SAC/C;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,QAAQ,CAAS;IACjB,WAAW,CAAS;IACpB,QAAQ,CAAkB;IACjC,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,aAAa,YAAY,wBAAoB,EAAE;YACtD,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;SACnC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,QAAQ,CAAS;IACjB,UAAU,CAAc;IACxB,SAAS,CAAkB;IAC3B,OAAO,CAAU;IACxB,IAAW,aAAa;QACtB,IAAI,IAAI,CAAC,aAAa,YAAY,wBAAoB,EAAE;YACtD,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;SACzC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,YAAmB,IAAY;QAC7B,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,aAAqB,SAAS;QAC3C,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,OAAO,qBAAiB,CAAC,QAAQ,EAAE;aAChC,SAAS,CAAC,UAAU,CAAC;aACrB,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAES,gBAAgB;QACxB,IAAI,CAAC,WAAW;aACb,EAAE,CACD,iBAAiB;QACjB,mCAAmC;QACnC,mBAAe,CAAC,OAAO;YACrB,mBAAe,CAAC,IAAI;YACpB,mBAAe,CAAC,IAAI;YACpB,mBAAe,CAAC,OAAO,CAE1B;aACA,KAAK,CAAC,eAAe,CAAC;aACtB,SAAS,EAAE,CAAC;QAEf,IAAI,CAAC,WAAW;aACb,EAAE,CAAC,iBAAiB,EAAE,mBAAe,CAAC,IAAI,CAAC;aAC3C,IAAI,CAAC,qBAAqB,EAAE,uBAAmB,CAAC,OAAO,CAAC;aACxD,KAAK,CAAC,SAAS,CAAC;aAChB,SAAS,EAAE,CAAC;QAEf,IAAI,CAAC,WAAW;aACb,EAAE,CAAC,iBAAiB,EAAE,mBAAe,CAAC,MAAM,CAAC;aAC7C,IAAI,CAAC,QAAQ,CAAC;aACd,SAAS,EAAE;aACX,KAAK,CAAC,UAAU,CAAC;aACjB,SAAS,EAAE,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,MAAwB;QACxC,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,MAAwB;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,YAAY,CAAC,QAAiB;QACnC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,WAAoB;QACzC,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,YAAY,CAAC,QAA0B;QAC5C,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,QAAiB;QACnC,IAAI,CAAC,mBAAmB,GAAG,uBAAmB,CAAC,OAAO,CAAC;QACvD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAuB;QAC3C,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,aAAa,CAAC,MAAwB;QAC3C,IAAI,CAAC,mBAAmB,GAAG,uBAAmB,CAAC,OAAO,CAAC;QACvD,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;SACzB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,WAAW,CAAC,IAAc;QAC/B,IAAI,CAAC,mBAAmB,GAAG,uBAAmB,CAAC,OAAO,CAAC;QACvD,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;SACrB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,qBAAqB,CAAC,iBAAyB;QACpD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA3ND,8CA2NC"}

package/lib/src/Builders/PayFacBuilder.d.ts

@@ -0,0 +1,98 @@
+import { BaseBuilder } from "./";
+import { CreditCardData } from "../PaymentMethods";
+import { DocumentUploadData } from "../Entities/DocumentUploadData";
+import { AccountPermissions } from "../Entities/ProFac/AccountPermissions";
+import { BankAccountData } from "../Entities/ProFac/BankAccountData";
+import { BankAccountOwnershipData } from "../Entities/ProFac/BankAccountOwnershipData";
+import { BeneficialOwnerData } from "../Entities/ProFac/BeneficialOwnerData";
+import { BusinessData } from "../Entities/ProFac/BusinessData";
+import { DeviceData } from "../Entities/ProFac/DeviceData";
+import { FlashFundsPaymentCardData } from "../Entities/ProFac/FlashFundsPaymentCardData";
+import { GrossBillingInformation } from "../Entities/ProFac/GrossBillingInformation";
+import { RenewAccountData } from "../Entities/ProFac/RenewAccountData";
+import { SignificantOwnerData } from "../Entities/ProFac/SignificantOwnerData";
+import { ThreatRiskData } from "../Entities/ProFac/ThreatRiskData";
+import { UserPersonalData } from "../Entities/ProFac/UserPersonalData";
+import { SSORequestData } from "../Entities/SSORequestData";
+import { Address, Transaction, TransactionModifier, TransactionType } from "../";
+import { OrderDevice } from "../Entities/ProFac/OrderDevice";
+export declare class PayFacBuilder extends BaseBuilder<Transaction> {
+    protected setupValidations(): void;
+    transactionType: TransactionType;
+    transactionModifier: TransactionModifier;
+    bankAccountData: BankAccountData;
+    beneficialOwnerData: BeneficialOwnerData;
+    deviceData: DeviceData;
+    timeZone: string;
+    businessData: BusinessData;
+    significantOwnerData: SignificantOwnerData;
+    threatRiskData: ThreatRiskData;
+    userPersonalData: UserPersonalData;
+    creditCardInformation: CreditCardData;
+    aCHInformation: BankAccountData;
+    mailingAddressInformation: Address;
+    secondaryBankInformation: BankAccountData;
+    grossBillingInformation: GrossBillingInformation;
+    negativeLimit: string;
+    renewalAccountData: RenewAccountData;
+    accountNumber: string;
+    password: string;
+    accountPermissions: AccountPermissions;
+    primaryBankAccountOwner: BankAccountOwnershipData;
+    secondaryBankAccountOwner: BankAccountOwnershipData;
+    documentUploadData: DocumentUploadData;
+    sSORequestData: SSORequestData;
+    amount: string;
+    receivingAccountNumber: string;
+    allowPending: boolean;
+    cCAmount: string;
+    requireCCRefund: boolean;
+    transNum: string;
+    externalID: string;
+    sourceEmail: string;
+    gatewayTransactionId: string;
+    cardBrandTransactionId: string;
+    globaltransId: string;
+    globalTransSource: string;
+    orderDevice: OrderDevice;
+    orderDeviceData: DeviceData;
+    constructor(type: TransactionType, modifer?: TransactionModifier);
+    execute(configName?: string): Promise<Transaction>;
+    withBankAccountData(bankAccountData: BankAccountData): this;
+    withBeneficialOwnerData(beneficialOwnerData: BeneficialOwnerData): this;
+    withDeviceData(deviceData: DeviceData): this;
+    withTimeZone(timezone: string): this;
+    withBusinessData(businessData: BusinessData): this;
+    withSignificantOwnerData(significantOwnerData: SignificantOwnerData): this;
+    withThreatRiskData(threatRiskData: ThreatRiskData): this;
+    withUserPersonalData(userPersonalData: UserPersonalData): this;
+    withCreditCardData(creditCardInformation: CreditCardData): this;
+    withACHData(achInformation: BankAccountData): this;
+    withMailingAddress(mailingAddressInformation: Address): this;
+    withSecondaryBankAccountData(secondaryBankInformation: BankAccountData): this;
+    withGrossBillingSettleData(grossBillingInformation: GrossBillingInformation): this;
+    withAccountNumber(accountNumber: string): this;
+    withPassword(password: string): this;
+    withAccountPermissions(accountPermissions: AccountPermissions): this;
+    withPrimaryBankAccountOwner(primaryBankAccountOwner: BankAccountOwnershipData): this;
+    withSecondaryBankAccountOwner(secondaryBankAccountOwner: BankAccountOwnershipData): this;
+    withDocumentUploadData(docUploadData: DocumentUploadData): this;
+    withSSORequestData(ssoRequestData: SSORequestData): this;
+    withNegativeLimit(negativeLimit: string): this;
+    withRenewalAccountData(renewalAccountData: RenewAccountData): this;
+    withAmount(amount: string): this;
+    withFlashFundsPaymentCardData(cardData: FlashFundsPaymentCardData): this;
+    withReceivingAccountNumber(receivingAccountNumber: string): this;
+    withAllowPending(allowPending: boolean): this;
+    withCCAmount(ccAmount: string): this;
+    withRequireCCRefund(requireCCRefund: boolean): this;
+    withTransNum(transNum: string): this;
+    withGatewayTransactionId(gatewayTransactionId: string): this;
+    withCardBrandTransactionId(cardBrandTransactionId: string): this;
+    withGlobaltransId(globaltransId: string): this;
+    withGlobalTransSource(globalTransSource: string): this;
+    withExternalID(externalId: string): this;
+    withSourceEmail(sourceEmail: string): this;
+    withOrderDevice(orderDevice: OrderDevice): this;
+    withOrderDeviceData(orderDeviceData: DeviceData): this;
+}