@aptos-scp/scp-component-store-selling-features-domain-model 1.0.0

package/lib/domain/model/tender/exchange/StartTenderExchangeLine.d.ts

@@ -0,0 +1,28 @@
+import { ITransactionLine, UiBusinessEvent } from "@aptos-scp/scp-component-store-selling-core";
+import { TenderType as TenderTypeName } from "@aptos-scp/scp-types-commerce-devices";
+import { ITransactionLineReferenceType } from "@aptos-scp/scp-types-commerce-transaction";
+import { BaseTransactionLine } from "../../BaseTransactionLine";
+export declare const START_TENDER_EXCHANGE_LINE_TYPE: string;
+export declare class StartTenderExchangeLine extends BaseTransactionLine {
+    private _supervisorOverrideLineReference?;
+    private _tenderExchangeInTenderTypeName?;
+    /**
+     * The create method is called by the transaction line factory to create an instance and initialize it from the
+     * data collected during the qualification process.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {StartTenderExchangeLine}
+     */
+    static create(lineNumber: number, lineType: string, uiBusinessEvent: UiBusinessEvent, collectedData: Readonly<Map<string, any>>): StartTenderExchangeLine;
+    static createFromJsonObject(transactionLineJsonObj: any): StartTenderExchangeLine;
+    get couldAffectPricing(): boolean;
+    get supervisorOverrideLineReference(): ITransactionLineReferenceType;
+    get tenderExchangeInTenderTypeName(): TenderTypeName;
+    protected constructor(lineNumber: number, lineType: string, supervisorOverrideLineReference?: ITransactionLineReferenceType, tenderExchangeInTenderTypeName?: TenderTypeName);
+    protected newTransactionLine(): BaseTransactionLine;
+}
+export declare function isStartTenderExchangeLine(transactionLine: ITransactionLine): transactionLine is StartTenderExchangeLine;

package/lib/domain/model/tender/exchange/StartTenderExchangeLine.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseTransactionLine_1 = require("../../BaseTransactionLine");
+const Constants_1 = require("../../Constants");
+exports.START_TENDER_EXCHANGE_LINE_TYPE = "StartTenderExchange";
+class StartTenderExchangeLine extends BaseTransactionLine_1.BaseTransactionLine {
+    // Since the constructor is only called from the create methods it is made protected to prevent use by others.
+    constructor(lineNumber, lineType, supervisorOverrideLineReference, tenderExchangeInTenderTypeName) {
+        super(lineNumber, lineType);
+        this._supervisorOverrideLineReference = supervisorOverrideLineReference;
+        this._tenderExchangeInTenderTypeName = tenderExchangeInTenderTypeName;
+    }
+    /**
+     * The create method is called by the transaction line factory to create an instance and initialize it from the
+     * data collected during the qualification process.
+     *
+     * @param {number} lineNumber                        The line number of this line in the transaction
+     * @param {string} lineType                          The type of line
+     * @param {UiBusinessEvent} uiBusinessEvent          The UI business event that led to the creation of this line
+     * @param {Readonly<Map<string, any>>} collectedData The data collected during the qualification process
+     *
+     * @return {StartTenderExchangeLine}
+     */
+    static create(lineNumber, lineType, uiBusinessEvent, collectedData) {
+        const supervisorOverrideLineReference = collectedData.get(Constants_1.CollectedDataKey.SupervisorOverrideLineReference) || undefined;
+        const tenderExchangeInTenderTypeName = collectedData.get(Constants_1.CollectedDataKey.TenderTypeName);
+        return new StartTenderExchangeLine(lineNumber, lineType, supervisorOverrideLineReference, tenderExchangeInTenderTypeName);
+    }
+    static createFromJsonObject(transactionLineJsonObj) {
+        const lineNumber = BaseTransactionLine_1.BaseTransactionLine.lineNumberFromJsonObject(transactionLineJsonObj);
+        const lineType = BaseTransactionLine_1.BaseTransactionLine.lineTypeFromJsonObject(transactionLineJsonObj);
+        const supervisorOverrideLineReference = transactionLineJsonObj._supervisorOverrideLineReference;
+        const tenderExchangeInTenderTypeName = transactionLineJsonObj._tenderExchangeInTenderTypeName;
+        const startTenderExchangeLine = new StartTenderExchangeLine(lineNumber, lineType, supervisorOverrideLineReference, tenderExchangeInTenderTypeName);
+        startTenderExchangeLine.loadFromJsonObject(transactionLineJsonObj);
+        return startTenderExchangeLine;
+    }
+    get couldAffectPricing() {
+        return false;
+    }
+    get supervisorOverrideLineReference() {
+        return this._supervisorOverrideLineReference;
+    }
+    get tenderExchangeInTenderTypeName() {
+        return this._tenderExchangeInTenderTypeName;
+    }
+    newTransactionLine() {
+        return new StartTenderExchangeLine(this.lineNumber, this.lineType, this.supervisorOverrideLineReference, this._tenderExchangeInTenderTypeName);
+    }
+}
+exports.StartTenderExchangeLine = StartTenderExchangeLine;
+function isStartTenderExchangeLine(transactionLine) {
+    return transactionLine instanceof StartTenderExchangeLine;
+}
+exports.isStartTenderExchangeLine = isStartTenderExchangeLine;
+//# sourceMappingURL=StartTenderExchangeLine.js.map

package/lib/domain/model/tender/exchange/index.d.ts

@@ -0,0 +1 @@
+export * from "./StartTenderExchangeLine";

package/lib/domain/model/tender/exchange/index.js

@@ -0,0 +1,7 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./StartTenderExchangeLine"));
+//# sourceMappingURL=index.js.map

package/lib/domain/model/tender/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./BaseTenderLineDecorator";
+export * from "./CancelSubscriptionTokenLine";
+export * from "./exchange";
+export * from "./ITenderLine";
+export * from "./OfflineAuthorization";
+export * from "./RefundedTenderLineDecorator";
+export * from "./reversals";
+export * from "./TenderAuthorizationStatusLine";
+export * from "./TenderChangeCancelLine";
+export * from "./TenderLine";
+export * from "./TenderSignatureLine";
+export * from "./TenderTaxLineDecorator";
+export * from "./valueCard";
+export * from "./valueCertificate";
+export * from "./VoidedTenderLineDecorator";
+export * from "./TenderUtils";

package/lib/domain/model/tender/index.js

@@ -0,0 +1,21 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./BaseTenderLineDecorator"));
+__export(require("./CancelSubscriptionTokenLine"));
+__export(require("./exchange"));
+__export(require("./OfflineAuthorization"));
+__export(require("./RefundedTenderLineDecorator"));
+__export(require("./reversals"));
+__export(require("./TenderAuthorizationStatusLine"));
+__export(require("./TenderChangeCancelLine"));
+__export(require("./TenderLine"));
+__export(require("./TenderSignatureLine"));
+__export(require("./TenderTaxLineDecorator"));
+__export(require("./valueCard"));
+__export(require("./valueCertificate"));
+__export(require("./VoidedTenderLineDecorator"));
+__export(require("./TenderUtils"));
+//# sourceMappingURL=index.js.map

package/lib/domain/model/tender/reversals/Interfaces.d.ts

@@ -0,0 +1,25 @@
+import { DeviceIdentity } from "@aptos-scp/scp-component-store-selling-core";
+import { TenderAuthCategory } from "../../Constants";
+export interface IReversal {
+    transaction: any;
+    reversalAttempts: number | 0;
+    deviceIdentity: DeviceIdentity;
+    businessDayDate: string;
+    transactionNumber: number;
+    languageCode?: string;
+    userId?: string;
+    accountNumber?: string;
+    reversalReason?: ReversalReason;
+    reversalConfiguration: IReversalConfiguration;
+    tenderAuthCategory: TenderAuthCategory;
+}
+export interface IReversalConfiguration {
+    maxRetries: number;
+    timeBetweenRetries: number;
+}
+export declare enum ReversalReason {
+    Timeout = "timeout",
+    Error = "error",
+    Cancel = "cancel",
+    Custom = "custom"
+}

package/lib/domain/model/tender/reversals/Interfaces.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ReversalReason;
+(function (ReversalReason) {
+    ReversalReason["Timeout"] = "timeout";
+    ReversalReason["Error"] = "error";
+    ReversalReason["Cancel"] = "cancel";
+    ReversalReason["Custom"] = "custom";
+})(ReversalReason = exports.ReversalReason || (exports.ReversalReason = {}));
+//# sourceMappingURL=Interfaces.js.map

package/lib/domain/model/tender/reversals/index.d.ts

@@ -0,0 +1 @@
+export * from "./Interfaces";

package/lib/domain/model/tender/reversals/index.js

@@ -0,0 +1,7 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./Interfaces"));
+//# sourceMappingURL=index.js.map

package/lib/domain/model/tender/valueCard/Interfaces.d.ts

@@ -0,0 +1,84 @@
+import { IMoney } from "@aptos-scp/scp-component-business-core";
+import { EntryMethod, ResponseCodes } from "@aptos-scp/scp-types-commerce-devices";
+import { TenderAuthorizationStatus } from "@aptos-scp/scp-types-commerce-transaction";
+import { ReversalReason } from "../reversals/Interfaces";
+export interface IValueCard {
+    balance?: IMoney;
+    cardNumber: string;
+    cardStatus?: ValueCardStatus;
+    pin?: ISecureData;
+    cardIdentifier?: string;
+}
+export interface IValueCardTransaction {
+    action: ValueCardAction;
+    amount?: IMoney;
+    appliedAmount?: IMoney;
+    applyRemainingBalance?: boolean;
+    authorizationCode?: string;
+    card?: IValueCard;
+    entryMethod?: ValueCardEntryMethod;
+    origTransactionId?: string;
+    paymentProvider?: string;
+    paymentProviderSpecificInfo?: {
+        [k: string]: any;
+    };
+    receiptData?: string[];
+    responseCode?: ValueCardResponseCode;
+    responseMessage?: IValueCardMessage;
+    reversalReason?: ReversalReason;
+    transactionId?: string;
+}
+export interface IValueCardMessage {
+    message: string;
+}
+export interface ISecureData {
+    securityTypeCode?: SecurityTypeCode;
+    description?: string;
+    value: string;
+}
+export declare enum SecurityTypeCode {
+    None = "none"
+}
+export declare enum ValueCardStatus {
+    Activated = "activated",
+    Deactivated = "deactivated",
+    Redeemed = "redeemed"
+}
+export declare enum ValueCardAction {
+    Inquiry = "inquiry",
+    Redeem = "redeem",
+    AddValue = "addValue",
+    Issue = "issue",
+    VoidRedeem = "voidRedeem",
+    VoidIssue = "voidIssue",
+    VoidAddValue = "voidAddValue",
+    ReverseRedeem = "reverseRedeem",
+    ReverseIssue = "reverseIssue",
+    ReverseAddValue = "reverseAddValue",
+    Cashout = "cashout",
+    VoidCashout = "voidCashout",
+    ReverseCashout = "reverseCashout"
+}
+export declare enum ValueCardEntryMethod {
+    Insert = "insert",
+    Swipe = "swipe",
+    Keyed = "keyed",
+    Fallback = "fallback",
+    KeyFallback = "keyFallback",
+    Tap = "tap",
+    Scanned = "scanned",
+    Mobile = "mobile",
+    Unknown = "unknown"
+}
+export declare enum ValueCardResponseCode {
+    Approved = "approved",
+    Cancel = "cancel",
+    Error = "error",
+    Decline = "decline",
+    Timeout = "timeout",
+    CallForAuthorization = "callForAuthorization"
+}
+export declare function responseCodeMapper(): Map<ValueCardResponseCode, ResponseCodes>;
+export declare function entryMethodMapper(): Map<ValueCardEntryMethod, EntryMethod>;
+export declare function entryMethodToValueCardMethod(): Map<EntryMethod, ValueCardEntryMethod>;
+export declare function statusToValueCardAction(isExistingCard?: boolean): Map<TenderAuthorizationStatus, ValueCardAction>;

package/lib/domain/model/tender/valueCard/Interfaces.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_types_commerce_devices_1 = require("@aptos-scp/scp-types-commerce-devices");
+const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
+var SecurityTypeCode;
+(function (SecurityTypeCode) {
+    SecurityTypeCode["None"] = "none";
+})(SecurityTypeCode = exports.SecurityTypeCode || (exports.SecurityTypeCode = {}));
+var ValueCardStatus;
+(function (ValueCardStatus) {
+    ValueCardStatus["Activated"] = "activated";
+    ValueCardStatus["Deactivated"] = "deactivated";
+    ValueCardStatus["Redeemed"] = "redeemed";
+})(ValueCardStatus = exports.ValueCardStatus || (exports.ValueCardStatus = {}));
+var ValueCardAction;
+(function (ValueCardAction) {
+    ValueCardAction["Inquiry"] = "inquiry";
+    ValueCardAction["Redeem"] = "redeem";
+    ValueCardAction["AddValue"] = "addValue";
+    ValueCardAction["Issue"] = "issue";
+    ValueCardAction["VoidRedeem"] = "voidRedeem";
+    ValueCardAction["VoidIssue"] = "voidIssue";
+    ValueCardAction["VoidAddValue"] = "voidAddValue";
+    ValueCardAction["ReverseRedeem"] = "reverseRedeem";
+    ValueCardAction["ReverseIssue"] = "reverseIssue";
+    ValueCardAction["ReverseAddValue"] = "reverseAddValue";
+    ValueCardAction["Cashout"] = "cashout";
+    ValueCardAction["VoidCashout"] = "voidCashout";
+    ValueCardAction["ReverseCashout"] = "reverseCashout";
+})(ValueCardAction = exports.ValueCardAction || (exports.ValueCardAction = {}));
+var ValueCardEntryMethod;
+(function (ValueCardEntryMethod) {
+    ValueCardEntryMethod["Insert"] = "insert";
+    ValueCardEntryMethod["Swipe"] = "swipe";
+    ValueCardEntryMethod["Keyed"] = "keyed";
+    ValueCardEntryMethod["Fallback"] = "fallback";
+    ValueCardEntryMethod["KeyFallback"] = "keyFallback";
+    ValueCardEntryMethod["Tap"] = "tap";
+    ValueCardEntryMethod["Scanned"] = "scanned";
+    ValueCardEntryMethod["Mobile"] = "mobile";
+    ValueCardEntryMethod["Unknown"] = "unknown";
+})(ValueCardEntryMethod = exports.ValueCardEntryMethod || (exports.ValueCardEntryMethod = {}));
+var ValueCardResponseCode;
+(function (ValueCardResponseCode) {
+    ValueCardResponseCode["Approved"] = "approved";
+    ValueCardResponseCode["Cancel"] = "cancel";
+    ValueCardResponseCode["Error"] = "error";
+    ValueCardResponseCode["Decline"] = "decline";
+    ValueCardResponseCode["Timeout"] = "timeout";
+    ValueCardResponseCode["CallForAuthorization"] = "callForAuthorization";
+})(ValueCardResponseCode = exports.ValueCardResponseCode || (exports.ValueCardResponseCode = {}));
+function responseCodeMapper() {
+    return new Map([
+        [ValueCardResponseCode.Approved, scp_types_commerce_devices_1.ResponseCodes.Approved],
+        [ValueCardResponseCode.Cancel, scp_types_commerce_devices_1.ResponseCodes.Cancel],
+        [ValueCardResponseCode.Error, scp_types_commerce_devices_1.ResponseCodes.Error],
+        [ValueCardResponseCode.Decline, scp_types_commerce_devices_1.ResponseCodes.Decline],
+        [ValueCardResponseCode.Timeout, scp_types_commerce_devices_1.ResponseCodes.Timeout],
+        [ValueCardResponseCode.CallForAuthorization, scp_types_commerce_devices_1.ResponseCodes.CallForAuthorization],
+    ]);
+}
+exports.responseCodeMapper = responseCodeMapper;
+function entryMethodMapper() {
+    return new Map([
+        [ValueCardEntryMethod.Insert, scp_types_commerce_devices_1.EntryMethod.Insert],
+        [ValueCardEntryMethod.Swipe, scp_types_commerce_devices_1.EntryMethod.Swipe],
+        [ValueCardEntryMethod.Keyed, scp_types_commerce_devices_1.EntryMethod.Keyed],
+        [ValueCardEntryMethod.Fallback, scp_types_commerce_devices_1.EntryMethod.Fallback],
+        [ValueCardEntryMethod.KeyFallback, scp_types_commerce_devices_1.EntryMethod.KeyFallback],
+        [ValueCardEntryMethod.Tap, scp_types_commerce_devices_1.EntryMethod.Tap],
+        [ValueCardEntryMethod.Scanned, scp_types_commerce_devices_1.EntryMethod.Scanned],
+        [ValueCardEntryMethod.Mobile, scp_types_commerce_devices_1.EntryMethod.Mobile],
+        [ValueCardEntryMethod.Unknown, scp_types_commerce_devices_1.EntryMethod.Unknown],
+    ]);
+}
+exports.entryMethodMapper = entryMethodMapper;
+function entryMethodToValueCardMethod() {
+    return new Map([
+        [scp_types_commerce_devices_1.EntryMethod.Insert, ValueCardEntryMethod.Insert],
+        [scp_types_commerce_devices_1.EntryMethod.Swipe, ValueCardEntryMethod.Swipe],
+        [scp_types_commerce_devices_1.EntryMethod.Keyed, ValueCardEntryMethod.Keyed],
+        [scp_types_commerce_devices_1.EntryMethod.Fallback, ValueCardEntryMethod.Fallback],
+        [scp_types_commerce_devices_1.EntryMethod.KeyFallback, ValueCardEntryMethod.KeyFallback],
+        [scp_types_commerce_devices_1.EntryMethod.Tap, ValueCardEntryMethod.Tap],
+        [scp_types_commerce_devices_1.EntryMethod.Scanned, ValueCardEntryMethod.Scanned],
+        [scp_types_commerce_devices_1.EntryMethod.Mobile, ValueCardEntryMethod.Mobile],
+        [scp_types_commerce_devices_1.EntryMethod.Unknown, ValueCardEntryMethod.Unknown],
+    ]);
+}
+exports.entryMethodToValueCardMethod = entryMethodToValueCardMethod;
+function statusToValueCardAction(isExistingCard) {
+    return new Map([
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.BalanceInquiryStarted, ValueCardAction.Inquiry],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCardIssueStarted, ValueCardAction.Issue],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCardReloadStarted, ValueCardAction.AddValue],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.GiftCardRedeemStarted, ValueCardAction.Redeem],
+        [scp_types_commerce_transaction_1.TenderAuthorizationStatus.CashoutStarted, ValueCardAction.Cashout],
+        isExistingCard
+            ? [scp_types_commerce_transaction_1.TenderAuthorizationStatus.RefundStarted, ValueCardAction.AddValue]
+            : [scp_types_commerce_transaction_1.TenderAuthorizationStatus.RefundStarted, ValueCardAction.Issue],
+    ]);
+}
+exports.statusToValueCardAction = statusToValueCardAction;
+//# sourceMappingURL=Interfaces.js.map

package/lib/domain/model/tender/valueCard/index.d.ts

@@ -0,0 +1 @@
+export * from "./Interfaces";

package/lib/domain/model/tender/valueCard/index.js

@@ -0,0 +1,7 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./Interfaces"));
+//# sourceMappingURL=index.js.map

package/lib/domain/model/tender/valueCertificate/Interfaces.d.ts

@@ -0,0 +1,228 @@
+import { IMoney } from "@aptos-scp/scp-component-business-core";
+import { ResponseCodes, ValueCertSubType } from "@aptos-scp/scp-types-commerce-devices";
+import { TenderAuthorizationStatus } from "@aptos-scp/scp-types-commerce-transaction";
+import { CustomerDetails, LocalizedMessage } from "@aptos-scp/scp-types-value-certificate";
+import { ReversalReason } from "../reversals/Interfaces";
+export declare enum ValueCertificateAction {
+    Inquiry = "inquiry",
+    Redeem = "redeem",
+    Issue = "issue",
+    Claim = "claim",
+    ReleaseClaim = "releaseClaim",
+    VoidRedeem = "voidRedeem",
+    VoidIssue = "voidIssue",
+    ReverseRedeem = "reverseRedeem",
+    ReverseIssue = "reverseIssue"
+}
+export declare enum ValueCertificateType {
+    StoreCredit = "storeCredit",
+    GiftCertificate = "giftCertificate"
+}
+export declare enum ValueCertificateResponseCode {
+    Approved = "approved",
+    Cancel = "cancel",
+    Error = "error",
+    Decline = "decline",
+    Timeout = "timeout",
+    CallForAuthorization = "callForAuthorization"
+}
+export declare enum ValueCertificateStatus {
+    Inactive = "inactive",
+    Claimed = "claimed",
+    Issued = "issued",
+    Redeemed = "redeemed",
+    Cancelled = "cancelled",
+    Expired = "expired",
+    OnHold = "onHold",
+    PartiallyRedeemed = "partiallyRedeemed"
+}
+export interface IValueCertificateSearchParameters {
+    /**
+     * The type of the value certificate to search for.
+     */
+    valueCertificateType: ValueCertificateType[];
+    /**
+     * The details for the customer to whom the value certificates are issued.
+     */
+    issuedToCustomer?: CustomerDetails;
+    /**
+     * The minimum balance on the value certificates.
+     */
+    balanceFrom?: IMoney;
+}
+export interface IValueCertificateRequest {
+    /**
+     * The type of the value certificate.
+     */
+    valueCertificateType?: ValueCertificateType;
+    /**
+     * The issue date for the certificate in ISO 8601 (YYYY-MM-DD) format.
+     */
+    issueDate?: string;
+    /**
+     * The expiration date for the certificate in ISO 8601 (YYYY-MM-DD) format.
+     */
+    expiryDate?: string;
+    /**
+     * The available balance on the value certificate.
+     */
+    balance?: IMoney;
+}
+export interface IValueCertificate {
+    /**
+     * The account number associated to the value certificate.
+     */
+    accountNumber?: string;
+    /**
+     * The type of the value certificate.
+     */
+    valueCertificateType?: ValueCertificateType;
+    /**
+     * The status of the value certificate.
+     */
+    valueCertificateStatus?: ValueCertificateStatus;
+    /**
+     * The issue date for the certificate in ISO 8601 (YYYY-MM-DD) format.
+     */
+    issueDate?: string;
+    /**
+     * The expiration date for the certificate in ISO 8601 (YYYY-MM-DD) format.
+     */
+    expiryDate?: string;
+    /**
+     * The date the certificate was redeemed in ISO 8601 (YYYY-MM-DD) format.
+     */
+    redeemedDate?: string;
+    /**
+     * The available balance on the value certificate.
+     */
+    balance?: IMoney;
+    /**
+     * The country where the value certificate was issued.
+     */
+    issueCountry?: string;
+    /**
+     * The customer number the value certificate is issued to.
+     */
+    issuedToCustomerNumber?: string;
+    /**
+     * The customer number the value certificate was redeemed by.
+     */
+    redeemedByCustomerNumber?: string;
+}
+export interface IValueCertificateTransactionRequest {
+    /**
+     * The type of value certificate operation represented by this transaction.
+     */
+    action: ValueCertificateAction;
+    /**
+     * The amount to apply to the value certificate.
+     */
+    amount?: IMoney;
+    /**
+     * Indicates whether the calling application will accept an approved amount lower than the requested amount in the
+     * event that the remaining balance does not have sufficient funds. Relevant only to requests where the
+     * action = 'redeem'.
+     */
+    applyRemainingBalance?: boolean;
+    /**
+     * The country of origin for the value certificate action.
+     */
+    country?: string;
+    /**
+     * The details for the value certificate customer involved in this transaction.
+     */
+    customer?: CustomerDetails;
+    /**
+     * The original unique identifier for the transaction being reversed or voided.
+     */
+    origTransactionId?: string;
+    /**
+     * The reason for a reversal request.
+     */
+    reversalReason?: ReversalReason;
+    /**
+     * The description for a custom reversal reason.
+     */
+    customReversalReason?: string;
+    [k: string]: any;
+    /**
+     * The type of the value certificate.
+     */
+    valueCertificateType?: ValueCertificateType;
+}
+export interface IValueCertificateTransaction {
+    /**
+     * The type of value certificate operation represented by this transaction.
+     */
+    action: ValueCertificateAction;
+    /**
+     * The amount to apply to the value certificate.
+     */
+    amount?: IMoney;
+    /**
+     * The amount applied to the value certificate.
+     * This amount may be different from the amount requested when there are insufficient funds.
+     */
+    appliedAmount?: IMoney;
+    /**
+     * Processor authorization or approval code.
+     */
+    authorizationCode?: string;
+    /**
+     * The value certificate on which to take the specified action.
+     */
+    certificate?: IValueCertificate;
+    /**
+     * The country of origin for the value certificate action.
+     */
+    country?: string;
+    /**
+     * The details for the value certificate customer involved in this transaction.
+     */
+    customer?: CustomerDetails;
+    /**
+     * The transaction identifier for a transaction being voided.
+     */
+    origTransactionId?: string;
+    /**
+     * The name of the payment processor providing value certificate processing services.
+     */
+    paymentProvider?: string;
+    /**
+     * Payment Provider specific data that needs to be stored with the transaction
+     * but does not have a matching field in the API.
+     */
+    paymentProviderSpecificInfo?: {
+        [k: string]: any;
+    };
+    /**
+     * The processor provided receipt lines.
+     */
+    receiptData?: string[];
+    /**
+     * The response code that indicates the result of an action.
+     */
+    responseCode?: ValueCertificateResponseCode;
+    /**
+     * Additional information about the responseCode in a user-presentable format and language.
+     */
+    responseMessages?: LocalizedMessage[];
+    /**
+     * A unique identifier for this transaction.
+     */
+    transactionId?: string;
+    /**
+     * The reason for a reversal request.
+     */
+    reversalReason?: ReversalReason;
+    /**
+     * The description for a custom reversal reason.
+     */
+    customReversalReason?: string;
+    [k: string]: any;
+}
+export declare function valueCertificateResponseCodeMapper(): Map<ValueCertificateResponseCode, ResponseCodes>;
+export declare function valueCertificateTypeMapper(): Map<ValueCertificateType, ValueCertSubType>;
+export declare function tenderSubTypeMapper(): Map<ValueCertSubType, ValueCertificateType>;
+export declare function statusToValueCertificateAction(): Map<TenderAuthorizationStatus, ValueCertificateAction>;