@blockchyp/blockchyp-ts 2.30.1 → 2.30.4

package/src/models.ts

@@ -2036,6 +2036,11 @@ export class CustomerToken {
    */
     cardHolderName?: string;
 
+  /**
+   * Whether the token was enrolled with a CVV value present.
+   */
+    hasCvv: boolean | null = null;
+
   /**
    * Models customer records associated with a payment token.
    */
@@ -2058,6 +2063,7 @@ export class CustomerToken {
         address: string | undefined = undefined,
         country: string | undefined = undefined,
         cardHolderName: string | undefined = undefined,
+        hasCvv: boolean | null = null,
         customers: Customer[] | null = null,
         ) {
         this.token = token;
@@ -2075,6 +2081,7 @@ export class CustomerToken {
         this.address = address;
         this.country = country;
         this.cardHolderName = cardHolderName;
+        this.hasCvv = hasCvv;
         this.customers = customers;
         }
 }
@@ -2653,6 +2660,11 @@ export class AuthorizationRequest {
    */
     shipmentNumber: number | null = null;
 
+  /**
+   * An optional field that can be used to pass through data to external partners.
+   */
+    externalPartnerMetadata?: string;
+
     // Constructor with default values for optional fields
     constructor(
         timeout: number | null = null,
@@ -2739,6 +2751,7 @@ export class AuthorizationRequest {
         orderDate: Date | undefined = undefined,
         shipmentCount: number | null = null,
         shipmentNumber: number | null = null,
+        externalPartnerMetadata: string | undefined = undefined,
         ) {
         this.timeout = timeout;
         this.test = test;
@@ -2824,6 +2837,7 @@ export class AuthorizationRequest {
         this.orderDate = orderDate;
         this.shipmentCount = shipmentCount;
         this.shipmentNumber = shipmentNumber;
+        this.externalPartnerMetadata = externalPartnerMetadata;
         }
 }
 
@@ -4591,6 +4605,11 @@ export class CaptureResponse {
    */
     customers: Customer[] | null = null;
 
+  /**
+   * Whether enhanced data was passed for the transaction.
+   */
+    enhancedDataPassed?: boolean;
+
     // Constructor with default values for optional fields
     constructor(
         success: boolean | null = null,
@@ -4638,6 +4657,7 @@ export class CaptureResponse {
         receiptSuggestions: ReceiptSuggestions | null = null,
         customer: Customer | undefined = undefined,
         customers: Customer[] | null = null,
+        enhancedDataPassed: boolean = false,
         ) {
         this.success = success;
         this.error = error;
@@ -4684,6 +4704,7 @@ export class CaptureResponse {
         this.receiptSuggestions = receiptSuggestions;
         this.customer = customer;
         this.customers = customers;
+        this.enhancedDataPassed = enhancedDataPassed;
         }
 }
 
@@ -5557,6 +5578,11 @@ export class EnrollResponse {
    */
     bin?: string;
 
+  /**
+   * Whether the token was enrolled with a CVV value present.
+   */
+    hasCvv: boolean | null = null;
+
     // Constructor with default values for optional fields
     constructor(
         success: boolean | null = null,
@@ -5600,6 +5626,7 @@ export class EnrollResponse {
         bankName: string | undefined = undefined,
         tokenHash: string | undefined = undefined,
         bin: string | undefined = undefined,
+        hasCvv: boolean | null = null,
         ) {
         this.success = success;
         this.error = error;
@@ -5642,6 +5669,7 @@ export class EnrollResponse {
         this.bankName = bankName;
         this.tokenHash = tokenHash;
         this.bin = bin;
+        this.hasCvv = hasCvv;
         }
 }
 
@@ -6847,6 +6875,11 @@ export class AuthorizationResponse {
    */
     cardMetadata?: CardMetadata;
 
+  /**
+   * Whether enhanced data was passed for the transaction.
+   */
+    enhancedDataPassed?: boolean;
+
     // Constructor with default values for optional fields
     constructor(
         success: boolean | null = null,
@@ -6909,6 +6942,7 @@ export class AuthorizationResponse {
         storeAndForward: boolean | null = null,
         status: string | null = null,
         cardMetadata: CardMetadata | undefined = undefined,
+        enhancedDataPassed: boolean = false,
         ) {
         this.success = success;
         this.error = error;
@@ -6970,6 +7004,7 @@ export class AuthorizationResponse {
         this.storeAndForward = storeAndForward;
         this.status = status;
         this.cardMetadata = cardMetadata;
+        this.enhancedDataPassed = enhancedDataPassed;
         }
 }
 
@@ -9713,7 +9748,7 @@ export class BatchDetailsResponse {
     netDeposit: string | null = null;
 
   /**
-   * The daily fees for this batch
+   * The daily fees for this batch.
    */
     dailyFees: string | null = null;
 
@@ -17758,197 +17793,140 @@ export class SubmitApplicationRequest {
 }
 
   /**
-   * Models settings related to state checks for a merchant.
-   */
-export class StateCheckSettings {
-
-  /**
-   * If state checks are enabled for the merchant.
-   */
-    enabled: boolean | null = null;
-
-  /**
-   * The list of states that are exempt from surcharges.
-   */
-    surchargeExemptStates: string[] | null = null;
-
-    // Constructor with default values for optional fields
-    constructor(
-        enabled: boolean | null = null,
-        surchargeExemptStates: string[] | null = null,
-        ) {
-        this.enabled = enabled;
-        this.surchargeExemptStates = surchargeExemptStates;
-        }
-}
-
-  /**
-   * Models merchant settings and configuration.
-   */
-export class PricingMerchantSettings {
-
-  /**
-   * The merchant account identifier.
+   * Models a surcharge review request.
    */
-    account: string | null = null;
+export class SurchargeReviewRequest {
 
   /**
-   * The gateway identifier.
-   */
-    gateway: string | null = null;
-
-  /**
-   * Whether surcharging is enabled for the merchant.
-   */
-    surchargingEnabled: boolean | null = null;
-
-  /**
-   * The custom surcharge percentage, if applicable.
-   */
-    customSurchargePercent?: number;
-
-  /**
-   * If reduced rate pricing is enabled.
+   * The request timeout in seconds.
    */
-    reducedRate?: boolean;
+    timeout: number | null = null;
 
   /**
-   * If inverse pricing is enabled.
+   * Whether or not to route transaction to the test gateway.
    */
-    inversePricingEnabled?: boolean;
+    test: boolean | null = null;
 
   /**
-   * The credit discount rate, if applicable.
+   * The card number for the pricing request.
    */
-    creditDiscountRate?: number;
+    cardNumber?: string;
 
   /**
-   * The acquiring solution identifier.
+   * The payment token.
    */
-    acquiringSolution: string | null = null;
+    token?: string;
 
   /**
-   * Whether the merchant accepts debit cards.
+   * The transaction amount.
    */
-    acceptDebit?: boolean;
+    amount?: string;
 
   /**
-   * State check settings for the merchant.
+   * The surcharge rate.
    */
-    stateCheckSettings?: StateCheckSettings;
-
-    // Constructor with default values for optional fields
-    constructor(
-        account: string | null = null,
-        gateway: string | null = null,
-        surchargingEnabled: boolean | null = null,
-        customSurchargePercent: number = 0,
-        reducedRate: boolean = false,
-        inversePricingEnabled: boolean = false,
-        creditDiscountRate: number = 0,
-        acquiringSolution: string | null = null,
-        acceptDebit: boolean = false,
-        stateCheckSettings: StateCheckSettings | undefined = undefined,
-        ) {
-        this.account = account;
-        this.gateway = gateway;
-        this.surchargingEnabled = surchargingEnabled;
-        this.customSurchargePercent = customSurchargePercent;
-        this.reducedRate = reducedRate;
-        this.inversePricingEnabled = inversePricingEnabled;
-        this.creditDiscountRate = creditDiscountRate;
-        this.acquiringSolution = acquiringSolution;
-        this.acceptDebit = acceptDebit;
-        this.stateCheckSettings = stateCheckSettings;
-        }
-}
+    surchargeRate?: string;
 
   /**
-   * Models the attributes for a pricing request.
+   * The debit transaction fee.
    */
-export class PricingRequestAttributes {
+    debitTransFee?: string;
 
   /**
-   * The card number for the pricing request.
+   * The debit discount rate.
    */
-    cardNumber?: string;
+    debitDiscountRate?: string;
 
   /**
-   * The payment token.
+   * The surcharge policy.
    */
-    token: string | null = null;
+    surchargePolicy: string | null = null;
 
   /**
-   * The merchant identifier.
+   * The list of excluded merchant states.
    */
-    merchantIdentifier?: string;
+    excludedMerchantStates: string[] | null = null;
 
   /**
-   * The transaction amount.
+   * The zip code.
    */
-    amount: number | null = null;
+    zip: string | null = null;
 
   /**
-   * The country code.
+   * The state or province.
    */
-    country?: string;
+    state: string | null = null;
 
   /**
-   * The postal code.
+   * If foreign cards are exempt.
    */
-    postalCode?: string;
+    exemptForeignCards: boolean | null = null;
 
   /**
-   * The state or province.
+   * The surcharging mode.
    */
-    state?: string;
+    surchargingMode: string | null = null;
 
   /**
-   * Merchant settings for the pricing request.
+   * The pricing plan.
    */
-    merchantSettings?: PricingMerchantSettings;
+    pricingPlan: string | null = null;
 
     // Constructor with default values for optional fields
     constructor(
+        timeout: number | null = null,
+        test: boolean | null = null,
         cardNumber: string | undefined = undefined,
-        token: string | null = null,
-        merchantIdentifier: string | undefined = undefined,
-        amount: number | null = null,
-        country: string | undefined = undefined,
-        postalCode: string | undefined = undefined,
-        state: string | undefined = undefined,
-        merchantSettings: PricingMerchantSettings | undefined = undefined,
+        token: string | undefined = undefined,
+        amount: string | undefined = undefined,
+        surchargeRate: string | undefined = undefined,
+        debitTransFee: string | undefined = undefined,
+        debitDiscountRate: string | undefined = undefined,
+        surchargePolicy: string | null = null,
+        excludedMerchantStates: string[] | null = null,
+        zip: string | null = null,
+        state: string | null = null,
+        exemptForeignCards: boolean | null = null,
+        surchargingMode: string | null = null,
+        pricingPlan: string | null = null,
         ) {
+        this.timeout = timeout;
+        this.test = test;
         this.cardNumber = cardNumber;
         this.token = token;
-        this.merchantIdentifier = merchantIdentifier;
         this.amount = amount;
-        this.country = country;
-        this.postalCode = postalCode;
+        this.surchargeRate = surchargeRate;
+        this.debitTransFee = debitTransFee;
+        this.debitDiscountRate = debitDiscountRate;
+        this.surchargePolicy = surchargePolicy;
+        this.excludedMerchantStates = excludedMerchantStates;
+        this.zip = zip;
         this.state = state;
-        this.merchantSettings = merchantSettings;
+        this.exemptForeignCards = exemptForeignCards;
+        this.surchargingMode = surchargingMode;
+        this.pricingPlan = pricingPlan;
         }
 }
 
   /**
-   * Models the data wrapper for a pricing request.
+   * Models the data included in a surcharge review response.
    */
-export class PricingRequestData {
+export class SurchargeReviewResponseData {
 
   /**
-   * The type of the request.
+   * The type of the response.
    */
     type: string | null = null;
 
   /**
-   * The pricing request attributes.
+   * The attributes of the response.
    */
-    attributes: PricingRequestAttributes | null = null;
+    attributes: SurchargeAttributeResponseData | null = null;
 
     // Constructor with default values for optional fields
     constructor(
         type: string | null = null,
-        attributes: PricingRequestAttributes | null = null,
+        attributes: SurchargeAttributeResponseData | null = null,
         ) {
         this.type = type;
         this.attributes = attributes;
@@ -17956,51 +17934,34 @@ export class PricingRequestData {
 }
 
   /**
-   * Models a pricing request.
+   * Models the surcharge attributes included in a surcharge review response.
    */
-export class PricingRequest {
+export class SurchargeAttributeResponseData {
 
   /**
-   * The request timeout in seconds.
+   * The total amount including surcharge.
    */
-    timeout: number | null = null;
+    totalWithSurchargeAmount: string | null = null;
 
   /**
-   * Whether or not to route transaction to the test gateway.
+   * If the surcharge review was successful.
    */
-    test: boolean | null = null;
-
-  /**
-   * The pricing request data.
-   */
-    data: PricingRequestData | null = null;
-
-    // Constructor with default values for optional fields
-    constructor(
-        timeout: number | null = null,
-        test: boolean | null = null,
-        data: PricingRequestData | null = null,
-        ) {
-        this.timeout = timeout;
-        this.test = test;
-        this.data = data;
-        }
-}
+    success: boolean | null = null;
 
   /**
-   * Models pricing response data for new handler for pricing api responses.
+   * The type of the response.
    */
-export class PricingResponseAttributes {
+    type: string | null = null;
 
   /**
    * The surcharge percentage.
    */
-    surchargePercent: number | null = null;
+    surchargePercent: string | null = null;
 
   /**
    * The surcharge amount.
    */
-    surchargeAmount: number | null = null;
+    surchargeAmount: string | null = null;
 
   /**
    * If the transaction is exempt from surcharges.
@@ -18030,7 +17991,27 @@ export class PricingResponseAttributes {
   /**
    * The commercial card indicator.
    */
-    commercialIndicator: string | null = null;
+    commercialIndicator?: string;
+
+  /**
+   * If the card is commercial.
+   */
+    isCommercial: boolean | null = null;
+
+  /**
+   * If the card is Durbin-regulated (US debit).
+   */
+    isRegulated: boolean | null = null;
+
+  /**
+   * The reason for the exemption.
+   */
+    exemptionReason?: string;
+
+  /**
+   * The debit fee amount.
+   */
+    debitFeeAmount?: string;
 
   /**
    * The disclosure statement.
@@ -18040,33 +18021,68 @@ export class PricingResponseAttributes {
   /**
    * The debit card category.
    */
-    debitCategory: string | null = null;
+    debitCategory?: string;
 
   /**
    * The country where the card was issued.
    */
-    countryIssued: string | null = null;
+    countryCode: string | null = null;
+
+  /**
+   * Only included if state was sent in request OR derived from ZIP code.
+   */
+    state?: string;
 
   /**
    * The unique identifier for the pricing response.
    */
     uuid: string | null = null;
 
+  /**
+   * The expiration date of the card.
+   */
+    expirationDate?: string;
+
+  /**
+   * When surcharging is enabled AND state is 'CO' (Colorado-specific statutory
+   * language).
+   */
+    disclosureAdditional?: string;
+
+  /**
+   * The cardholder information.
+   */
+    cardholderInfo?: string;
+
     // Constructor with default values for optional fields
     constructor(
-        surchargePercent: number | null = null,
-        surchargeAmount: number | null = null,
+        totalWithSurchargeAmount: string | null = null,
+        success: boolean | null = null,
+        type: string | null = null,
+        surchargePercent: string | null = null,
+        surchargeAmount: string | null = null,
         surchargeExempt: boolean | null = null,
         cardType: string | null = null,
         cardToken: string | undefined = undefined,
         brand: string | null = null,
         bin: string | null = null,
-        commercialIndicator: string | null = null,
+        commercialIndicator: string | undefined = undefined,
+        isCommercial: boolean | null = null,
+        isRegulated: boolean | null = null,
+        exemptionReason: string | undefined = undefined,
+        debitFeeAmount: string | undefined = undefined,
         disclosure: string | undefined = undefined,
-        debitCategory: string | null = null,
-        countryIssued: string | null = null,
+        debitCategory: string | undefined = undefined,
+        countryCode: string | null = null,
+        state: string | undefined = undefined,
         uuid: string | null = null,
+        expirationDate: string | undefined = undefined,
+        disclosureAdditional: string | undefined = undefined,
+        cardholderInfo: string | undefined = undefined,
         ) {
+        this.totalWithSurchargeAmount = totalWithSurchargeAmount;
+        this.success = success;
+        this.type = type;
         this.surchargePercent = surchargePercent;
         this.surchargeAmount = surchargeAmount;
         this.surchargeExempt = surchargeExempt;
@@ -18075,74 +18091,96 @@ export class PricingResponseAttributes {
         this.brand = brand;
         this.bin = bin;
         this.commercialIndicator = commercialIndicator;
+        this.isCommercial = isCommercial;
+        this.isRegulated = isRegulated;
+        this.exemptionReason = exemptionReason;
+        this.debitFeeAmount = debitFeeAmount;
         this.disclosure = disclosure;
         this.debitCategory = debitCategory;
-        this.countryIssued = countryIssued;
+        this.countryCode = countryCode;
+        this.state = state;
         this.uuid = uuid;
+        this.expirationDate = expirationDate;
+        this.disclosureAdditional = disclosureAdditional;
+        this.cardholderInfo = cardholderInfo;
         }
 }
 
   /**
-   * Models the data wrapper for a pricing response.
+   * Models a surcharge review response.
    */
-export class PricingResponseData {
+export class SurchargeReviewResponse {
 
   /**
-   * The type of the response.
+   * Whether or not the request succeeded.
    */
-    type: string | null = null;
+    success: boolean | null = null;
+
+  /**
+   * The error, if an error occurred.
+   */
+    error: string | null = null;
+
+  /**
+   * A narrative description of the transaction result.
+   */
+    responseDescription: string | null = null;
 
   /**
-   * The pricing response attributes.
+   * The data included in the surcharge review response.
    */
-    attributes: PricingResponseAttributes | null = null;
+    data: SurchargeReviewResponseData | null = null;
 
     // Constructor with default values for optional fields
     constructor(
-        type: string | null = null,
-        attributes: PricingResponseAttributes | null = null,
+        success: boolean | null = null,
+        error: string | null = null,
+        responseDescription: string | null = null,
+        data: SurchargeReviewResponseData | null = null,
         ) {
-        this.type = type;
-        this.attributes = attributes;
+        this.success = success;
+        this.error = error;
+        this.responseDescription = responseDescription;
+        this.data = data;
         }
 }
 
   /**
-   * Models an error response.
+   * Models a request for short-lived API credentials.
    */
-export class ErrorType {
+export class TransientKeyRequest {
 
   /**
-   * The HTTP status code.
+   * The request timeout in seconds.
    */
-    status: number | null = null;
+    timeout: number | null = null;
 
   /**
-   * The error title.
+   * Whether or not to route transaction to the test gateway.
    */
-    title: string | null = null;
+    test: boolean | null = null;
 
   /**
-   * The detailed error message.
+   * Restricts the returned credentials to a single API call when true.
    */
-    detail: string | null = null;
+    oneTime?: boolean;
 
     // Constructor with default values for optional fields
     constructor(
-        status: number | null = null,
-        title: string | null = null,
-        detail: string | null = null,
+        timeout: number | null = null,
+        test: boolean | null = null,
+        oneTime: boolean = false,
         ) {
-        this.status = status;
-        this.title = title;
-        this.detail = detail;
+        this.timeout = timeout;
+        this.test = test;
+        this.oneTime = oneTime;
         }
 }
 
   /**
-   * Models a pricing response.
+   * Models a response containing short-lived API credentials.
    */
-export class PricingResponse {
+export class TransientKeyResponse {
 
   /**
    * Whether or not the request succeeded.
@@ -18160,21 +18198,35 @@ export class PricingResponse {
     responseDescription: string | null = null;
 
   /**
-   * The pricing response data.
+   * The transient API key.
+   */
+    apiKey: string | null = null;
+
+  /**
+   * The transient bearer token.
    */
-    data: PricingResponseData | null = null;
+    bearerToken: string | null = null;
+
+  /**
+   * The transient signing key.
+   */
+    signingKey: string | null = null;
 
     // Constructor with default values for optional fields
     constructor(
         success: boolean | null = null,
         error: string | null = null,
         responseDescription: string | null = null,
-        data: PricingResponseData | null = null,
+        apiKey: string | null = null,
+        bearerToken: string | null = null,
+        signingKey: string | null = null,
         ) {
         this.success = success;
         this.error = error;
         this.responseDescription = responseDescription;
-        this.data = data;
+        this.apiKey = apiKey;
+        this.bearerToken = bearerToken;
+        this.signingKey = signingKey;
         }
 }