@blockchyp/blockchyp-ts 2.30.3 → 2.30.5

package/lib/src/models.d.ts

@@ -1204,11 +1204,15 @@ export declare class CustomerToken {
      * The card holder name.
      */
     cardHolderName?: string;
+    /**
+     * Whether the token was enrolled with a CVV value present.
+     */
+    hasCvv: boolean | null;
     /**
      * Models customer records associated with a payment token.
      */
     customers: Customer[] | null;
-    constructor(token?: string | null, maskedPan?: string | null, expiryMonth?: string | null, expiryYear?: string | null, paymentType?: string | null, accountType?: string | null, accountHolderType?: string | null, bankName?: string | null, routingNumber?: string | null, tokenHash?: string | null, bin?: string | null, postalCode?: string | undefined, address?: string | undefined, country?: string | undefined, cardHolderName?: string | undefined, customers?: Customer[] | null);
+    constructor(token?: string | null, maskedPan?: string | null, expiryMonth?: string | null, expiryYear?: string | null, paymentType?: string | null, accountType?: string | null, accountHolderType?: string | null, bankName?: string | null, routingNumber?: string | null, tokenHash?: string | null, bin?: string | null, postalCode?: string | undefined, address?: string | undefined, country?: string | undefined, cardHolderName?: string | undefined, hasCvv?: boolean | null, customers?: Customer[] | null);
 }
 /**
  * The response to a text prompt request.
@@ -1654,9 +1658,21 @@ export declare class AuthorizationRequest {
      * An optional field that can be used to pass through data to external partners.
      */
     externalPartnerMetadata?: string;
+    /**
+     * The external customer's email address.
+     */
+    externalCustomerEmail?: string;
+    /**
+     * The external customer's phone number.
+     */
+    externalCustomerPhone?: string;
+    /**
+     * The external customer's company name.
+     */
+    externalCustomerCompany?: string;
     constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, country?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, currencyCode?: string | null, amount?: string | null, taxExempt?: boolean | null, surcharge?: boolean | null, cashDiscount?: boolean | null, sigFile?: string | undefined, sigFormat?: SignatureFormat | undefined, sigWidth?: number, disableSignature?: boolean, tipAmount?: string | undefined, taxAmount?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, transactionId?: string | undefined, onlineAuthCode?: string | undefined, enroll?: boolean, bypassDupeFilter?: boolean, description?: string | undefined, promptForTip?: boolean, cashBackEnabled?: boolean, cardOnFile?: boolean, recurring?: boolean, cit?: boolean, mit?: boolean, subscription?: boolean, purchaseOrderNumber?: string | undefined, supplierReferenceNumber?: string | undefined, lineItems?: TransactionDisplayItem[] | null, altPrices?: {
         [key: string]: string;
-    } | undefined, customer?: Customer | undefined, roundingMode?: RoundingMode | undefined, healthcareMetadata?: HealthcareMetadata | undefined, cryptocurrency?: string | undefined, cryptoNetwork?: string | undefined, cryptoReceiveAddress?: string | undefined, paymentRequestLabel?: string | undefined, paymentRequestMessage?: string | undefined, simulateChipRejection?: boolean, simulateOutOfOrderReversal?: boolean, asyncReversals?: boolean, passthroughSurcharge?: string | undefined, healthcare?: boolean, healthcareTotal?: string | undefined, ebtTotal?: string | undefined, cardMetadataLookup?: boolean, totalDiscountAmount?: string | undefined, shippingAmount?: string | undefined, dutyAmount?: string | undefined, processorId?: string | undefined, externalCustomerId?: string | undefined, destinationCountryCode?: string | undefined, shipFromPostalCode?: string | undefined, shipToPostalCode?: string | undefined, orderDate?: Date | undefined, shipmentCount?: number | null, shipmentNumber?: number | null, externalPartnerMetadata?: string | undefined);
+    } | undefined, customer?: Customer | undefined, roundingMode?: RoundingMode | undefined, healthcareMetadata?: HealthcareMetadata | undefined, cryptocurrency?: string | undefined, cryptoNetwork?: string | undefined, cryptoReceiveAddress?: string | undefined, paymentRequestLabel?: string | undefined, paymentRequestMessage?: string | undefined, simulateChipRejection?: boolean, simulateOutOfOrderReversal?: boolean, asyncReversals?: boolean, passthroughSurcharge?: string | undefined, healthcare?: boolean, healthcareTotal?: string | undefined, ebtTotal?: string | undefined, cardMetadataLookup?: boolean, totalDiscountAmount?: string | undefined, shippingAmount?: string | undefined, dutyAmount?: string | undefined, processorId?: string | undefined, externalCustomerId?: string | undefined, destinationCountryCode?: string | undefined, shipFromPostalCode?: string | undefined, shipToPostalCode?: string | undefined, orderDate?: Date | undefined, shipmentCount?: number | null, shipmentNumber?: number | null, externalPartnerMetadata?: string | undefined, externalCustomerEmail?: string | undefined, externalCustomerPhone?: string | undefined, externalCustomerCompany?: string | undefined);
 }
 /**
  * Essential information about a payment card derived from its BIN/IIN.
@@ -3308,7 +3324,11 @@ export declare class EnrollResponse {
      * The first 8 digits of the card aka the BIN.
      */
     bin?: string;
-    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, approved?: boolean | null, authCode?: string | undefined, authResponseCode?: string | undefined, transactionId?: string | null, batchId?: string | undefined, transactionRef?: string | undefined, transactionType?: string | null, timestamp?: string | null, tickBlock?: string | null, test?: boolean | null, destinationAccount?: string | undefined, sig?: string | undefined, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, postalCode?: string | undefined, address?: string | undefined, country?: string | undefined, avsResponse?: AVSResponse | null, cvvResponse?: string | undefined, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, sigFile?: string | undefined, cardMetadata?: CardMetadata | undefined, accountType?: string | undefined, accountHolderType?: string | undefined, bankName?: string | undefined, tokenHash?: string | undefined, bin?: string | undefined);
+    /**
+     * Whether the token was enrolled with a CVV value present.
+     */
+    hasCvv: boolean | null;
+    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, approved?: boolean | null, authCode?: string | undefined, authResponseCode?: string | undefined, transactionId?: string | null, batchId?: string | undefined, transactionRef?: string | undefined, transactionType?: string | null, timestamp?: string | null, tickBlock?: string | null, test?: boolean | null, destinationAccount?: string | undefined, sig?: string | undefined, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, postalCode?: string | undefined, address?: string | undefined, country?: string | undefined, avsResponse?: AVSResponse | null, cvvResponse?: string | undefined, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, sigFile?: string | undefined, cardMetadata?: CardMetadata | undefined, accountType?: string | undefined, accountHolderType?: string | undefined, bankName?: string | undefined, tokenHash?: string | undefined, bin?: string | undefined, hasCvv?: boolean | null);
 }
 /**
  * The information needed to enroll a new payment method in the token vault.
@@ -5712,7 +5732,7 @@ export declare class BatchDetailsResponse {
      */
     netDeposit: string | null;
     /**
-     * The daily fees for this batch
+     * The daily fees for this batch.
      */
     dailyFees: string | null;
     constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, test?: boolean | null, batchId?: string | null, entryMethod?: string | null, destinationAccountId?: string | null, capturedAmount?: string | null, openPreauths?: string | null, totalVolume?: string | null, transactionCount?: number | null, giftCardsSold?: string | null, giftCardVolume?: string | null, expectedDeposit?: string | null, open?: boolean | null, openDate?: Date | null, closeDate?: Date | null, volumeByTerminal?: TerminalVolume[] | null, netDeposit?: string | null, dailyFees?: string | null);

package/lib/src/models.js

@@ -999,7 +999,7 @@ exports.UpdateTokenResponse = UpdateTokenResponse;
  */
 class CustomerToken {
     // Constructor with default values for optional fields
-    constructor(token = null, maskedPan = null, expiryMonth = null, expiryYear = null, paymentType = null, accountType = null, accountHolderType = null, bankName = null, routingNumber = null, tokenHash = null, bin = null, postalCode = undefined, address = undefined, country = undefined, cardHolderName = undefined, customers = null) {
+    constructor(token = null, maskedPan = null, expiryMonth = null, expiryYear = null, paymentType = null, accountType = null, accountHolderType = null, bankName = null, routingNumber = null, tokenHash = null, bin = null, postalCode = undefined, address = undefined, country = undefined, cardHolderName = undefined, hasCvv = null, customers = null) {
         /**
          * BlockChyp assigned customer id.
          */
@@ -1044,6 +1044,10 @@ class CustomerToken {
          * Card bin.
          */
         this.bin = null;
+        /**
+         * Whether the token was enrolled with a CVV value present.
+         */
+        this.hasCvv = null;
         /**
          * Models customer records associated with a payment token.
          */
@@ -1063,6 +1067,7 @@ class CustomerToken {
         this.address = address;
         this.country = country;
         this.cardHolderName = cardHolderName;
+        this.hasCvv = hasCvv;
         this.customers = customers;
     }
 }
@@ -1159,7 +1164,7 @@ exports.WhiteListedCard = WhiteListedCard;
  */
 class AuthorizationRequest {
     // Constructor with default values for optional fields
-    constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, country = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, sigFile = undefined, sigFormat = undefined, sigWidth = 0, disableSignature = false, tipAmount = undefined, taxAmount = undefined, terminalName = undefined, resetConnection = null, transactionId = undefined, onlineAuthCode = undefined, enroll = false, bypassDupeFilter = false, description = undefined, promptForTip = false, cashBackEnabled = false, cardOnFile = false, recurring = false, cit = false, mit = false, subscription = false, purchaseOrderNumber = undefined, supplierReferenceNumber = undefined, lineItems = null, altPrices = undefined, customer = undefined, roundingMode = undefined, healthcareMetadata = undefined, cryptocurrency = undefined, cryptoNetwork = undefined, cryptoReceiveAddress = undefined, paymentRequestLabel = undefined, paymentRequestMessage = undefined, simulateChipRejection = false, simulateOutOfOrderReversal = false, asyncReversals = false, passthroughSurcharge = undefined, healthcare = false, healthcareTotal = undefined, ebtTotal = undefined, cardMetadataLookup = false, totalDiscountAmount = undefined, shippingAmount = undefined, dutyAmount = undefined, processorId = undefined, externalCustomerId = undefined, destinationCountryCode = undefined, shipFromPostalCode = undefined, shipToPostalCode = undefined, orderDate = undefined, shipmentCount = null, shipmentNumber = null, externalPartnerMetadata = undefined) {
+    constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, country = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, sigFile = undefined, sigFormat = undefined, sigWidth = 0, disableSignature = false, tipAmount = undefined, taxAmount = undefined, terminalName = undefined, resetConnection = null, transactionId = undefined, onlineAuthCode = undefined, enroll = false, bypassDupeFilter = false, description = undefined, promptForTip = false, cashBackEnabled = false, cardOnFile = false, recurring = false, cit = false, mit = false, subscription = false, purchaseOrderNumber = undefined, supplierReferenceNumber = undefined, lineItems = null, altPrices = undefined, customer = undefined, roundingMode = undefined, healthcareMetadata = undefined, cryptocurrency = undefined, cryptoNetwork = undefined, cryptoReceiveAddress = undefined, paymentRequestLabel = undefined, paymentRequestMessage = undefined, simulateChipRejection = false, simulateOutOfOrderReversal = false, asyncReversals = false, passthroughSurcharge = undefined, healthcare = false, healthcareTotal = undefined, ebtTotal = undefined, cardMetadataLookup = false, totalDiscountAmount = undefined, shippingAmount = undefined, dutyAmount = undefined, processorId = undefined, externalCustomerId = undefined, destinationCountryCode = undefined, shipFromPostalCode = undefined, shipToPostalCode = undefined, orderDate = undefined, shipmentCount = null, shipmentNumber = null, externalPartnerMetadata = undefined, externalCustomerEmail = undefined, externalCustomerPhone = undefined, externalCustomerCompany = undefined) {
         /**
          * The request timeout in seconds.
          */
@@ -1306,6 +1311,9 @@ class AuthorizationRequest {
         this.shipmentCount = shipmentCount;
         this.shipmentNumber = shipmentNumber;
         this.externalPartnerMetadata = externalPartnerMetadata;
+        this.externalCustomerEmail = externalCustomerEmail;
+        this.externalCustomerPhone = externalCustomerPhone;
+        this.externalCustomerCompany = externalCustomerCompany;
     }
 }
 exports.AuthorizationRequest = AuthorizationRequest;
@@ -2221,7 +2229,7 @@ exports.EnrollRequest = EnrollRequest;
  */
 class EnrollResponse {
     // Constructor with default values for optional fields
-    constructor(success = null, error = null, responseDescription = null, approved = null, authCode = undefined, authResponseCode = undefined, transactionId = null, batchId = undefined, transactionRef = undefined, transactionType = null, timestamp = null, tickBlock = null, test = null, destinationAccount = undefined, sig = undefined, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, postalCode = undefined, address = undefined, country = undefined, avsResponse = null, cvvResponse = undefined, receiptSuggestions = null, customer = undefined, customers = null, sigFile = undefined, cardMetadata = undefined, accountType = undefined, accountHolderType = undefined, bankName = undefined, tokenHash = undefined, bin = undefined) {
+    constructor(success = null, error = null, responseDescription = null, approved = null, authCode = undefined, authResponseCode = undefined, transactionId = null, batchId = undefined, transactionRef = undefined, transactionType = null, timestamp = null, tickBlock = null, test = null, destinationAccount = undefined, sig = undefined, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, postalCode = undefined, address = undefined, country = undefined, avsResponse = null, cvvResponse = undefined, receiptSuggestions = null, customer = undefined, customers = null, sigFile = undefined, cardMetadata = undefined, accountType = undefined, accountHolderType = undefined, bankName = undefined, tokenHash = undefined, bin = undefined, hasCvv = null) {
         /**
          * Whether or not the request succeeded.
          */
@@ -2270,6 +2278,10 @@ class EnrollResponse {
          * Customer data, if any.
          */
         this.customers = null;
+        /**
+         * Whether the token was enrolled with a CVV value present.
+         */
+        this.hasCvv = null;
         this.success = success;
         this.error = error;
         this.responseDescription = responseDescription;
@@ -2311,6 +2323,7 @@ class EnrollResponse {
         this.bankName = bankName;
         this.tokenHash = tokenHash;
         this.bin = bin;
+        this.hasCvv = hasCvv;
     }
 }
 exports.EnrollResponse = EnrollResponse;
@@ -4467,7 +4480,7 @@ class BatchDetailsResponse {
          */
         this.netDeposit = null;
         /**
-         * The daily fees for this batch
+         * The daily fees for this batch.
          */
         this.dailyFees = null;
         this.success = success;