globalpayments-api 3.0.0 → 3.1.1

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

@@ -1,103 +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(): 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;
-}
+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

@@ -1,228 +1,208 @@
-"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.ManagementBuilder = void 0;
-var __1 = require("../");
-var TransactionBuilder_1 = require("./TransactionBuilder");
-var ManagementBuilder = /** @class */ (function (_super) {
-    __extends(ManagementBuilder, _super);
-    function ManagementBuilder(type) {
-        return _super.call(this, type) || this;
-    }
-    Object.defineProperty(ManagementBuilder.prototype, "authorizationCode", {
-        get: function () {
-            if (this.paymentMethod instanceof __1.TransactionReference) {
-                return this.paymentMethod.authCode;
-            }
-            return undefined;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ManagementBuilder.prototype, "clientTransactionId", {
-        get: function () {
-            if (this.paymentMethod instanceof __1.TransactionReference) {
-                return this.paymentMethod.clientTransactionId;
-            }
-            return undefined;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ManagementBuilder.prototype, "orderId", {
-        get: function () {
-            if (this.paymentMethod instanceof __1.TransactionReference) {
-                return this.paymentMethod.orderId;
-            }
-            return undefined;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ManagementBuilder.prototype, "transactionId", {
-        get: function () {
-            if (this.paymentMethod instanceof __1.TransactionReference) {
-                return this.paymentMethod.transactionId;
-            }
-            return undefined;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Executes the builder against the gateway.
-     *
-     * @returns Promise<Transaction>
-     */
-    ManagementBuilder.prototype.execute = function () {
-        _super.prototype.execute.call(this);
-        return __1.ServicesContainer.instance()
-            .getClient()
-            .manageTransaction(this);
-    };
-    ManagementBuilder.prototype.setupValidations = function () {
-        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
-     */
-    ManagementBuilder.prototype.withAmount = function (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
-     */
-    ManagementBuilder.prototype.withAuthAmount = function (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
-     */
-    ManagementBuilder.prototype.withCurrency = function (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
-     */
-    ManagementBuilder.prototype.withDescription = function (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
-     */
-    ManagementBuilder.prototype.withGratuity = function (gratuity) {
-        if (gratuity !== undefined) {
-            this.gratuity = gratuity;
-        }
-        return this;
-    };
-    /**
-     * Sets the purchase order number; where applicable.
-     *
-     * @param poNumber The PO number
-     * @returns ManagementBuilder
-     */
-    ManagementBuilder.prototype.withPoNumber = function (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
-     */
-    ManagementBuilder.prototype.withReasonCode = function (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
-     */
-    ManagementBuilder.prototype.withTaxAmount = function (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
-     */
-    ManagementBuilder.prototype.withTaxType = function (type) {
-        this.transactionModifier = __1.TransactionModifier.LevelII;
-        if (type !== undefined) {
-            this.taxType = type;
-        }
-        return this;
-    };
-    return ManagementBuilder;
-}(TransactionBuilder_1.TransactionBuilder));
-exports.ManagementBuilder = ManagementBuilder;
+"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