@blockchyp/blockchyp-ts 2.18.8 → 2.19.0

package/README.md

@@ -3848,6 +3848,49 @@ client.inviteMerchantUser(request)
 
 ```
 
+#### Add Gateway Merchant
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Gateway Boarding
+
+This is a partner level API that can be used to manually board gateway merchants.  Use this API in conjunction
+with Platform Configuration to instantly board gateway merchants.  Note that most partners don't have 
+permission to do this and are unlikely to get it.
+
+Settings can be changed by using the Update Merchant API.
+
+
+
+
+```typescript
+import * as BlockChyp from '@blockchyp/blockchyp-ts';
+
+const client = BlockChyp.newClient({
+  apiKey: 'ZDSMMZLGRPBPRTJUBTAFBYZ33Q',
+  bearerToken: 'ZLBW5NR4U5PKD5PNP3ZP3OZS5U',
+  signingKey: '9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947'
+});
+
+const request = new BlockChyp.AddGatewayMerchantRequest();
+
+const profile = new BlockChyp.MerchantProfile();
+profile.dbaName = 'DBA Name';
+profile.companyName = 'Corporate Entity Name';
+request.profile = profile;
+
+client.addGatewayMerchant(request)
+.then(function(httpResponse) {
+    const response: BlockChyp.MerchantProfileResponse = httpResponse.data;
+    console.log('Response: ' + JSON.stringify(response));
+  })
+  .catch(function (error: any) {
+    console.log(error);
+  });
+
+```
+
 #### Add Test Merchant
 
 

package/_bundles/blockchyp.js

@@ -59098,6 +59098,12 @@ class BlockChypClient {
     inviteMerchantUser(request) {
         return this._dashboardRequest('post', '/api/invite-merchant-user', request);
     }
+    /**
+     * Adds a live gateway merchant account.
+     */
+    addGatewayMerchant(request) {
+        return this._dashboardRequest('post', '/api/add-gateway-merchant', request);
+    }
     /**
      * Adds a test merchant account.
      */
@@ -59633,9 +59639,9 @@ exports["default"] = CryptoUtils;
  */
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.HeartbeatResponse = exports.TransactionDisplayRequest = exports.TransactionDisplayTransaction = exports.TransactionDisplayItem = exports.TransactionDisplayDiscount = exports.TransactionStatus = exports.PaymentLinkStatusResponse = exports.PaymentLinkStatusRequest = exports.TransactionStatusRequest = exports.AuthorizationResponse = exports.TermsAndConditionsResponse = exports.TermsAndConditionsRequest = exports.CloseBatchResponse = exports.CloseBatchRequest = exports.GiftActivateResponse = exports.GiftActivateRequest = exports.ClearTerminalRequest = exports.EnrollResponse = exports.EnrollRequest = exports.VoidResponse = exports.VoidRequest = exports.CaptureResponse = exports.CaptureRequest = exports.RefundRequest = exports.BalanceResponse = exports.BalanceRequest = exports.AuthorizationRequest = exports.WhiteListedCard = exports.BooleanPromptResponse = exports.TextPromptResponse = exports.CustomerToken = exports.TokenMetadataResponse = exports.TokenMetadataRequest = exports.Customer = exports.CustomerSearchResponse = exports.UpdateCustomerRequest = exports.CustomerSearchRequest = exports.CustomerResponse = exports.CustomerRequest = exports.TextPromptRequest = exports.BooleanPromptRequest = exports.MessageRequest = exports.LocateResponse = exports.LocateRequest = exports.PingResponse = exports.PingRequest = exports.CaptureSignatureResponse = exports.CaptureSignatureRequest = exports.Acknowledgement = exports.ReceiptSuggestions = void 0;
-exports.TermsAndConditionsTemplate = exports.TerminalProfile = exports.TerminalActivationRequest = exports.TerminalDeactivationRequest = exports.TerminalProfileResponse = exports.TerminalProfileRequest = exports.MerchantPlatform = exports.MerchantPlatformsResponse = exports.MerchantUser = exports.MerchantUsersResponse = exports.GetMerchantsResponse = exports.GetMerchantsRequest = exports.HealthcareGroup = exports.Healthcare = exports.UnlinkTokenRequest = exports.LinkTokenRequest = exports.DeleteTokenResponse = exports.DeleteTokenRequest = exports.DeleteCustomerResponse = exports.DeleteCustomerRequest = exports.DeleteQueuedTransactionResponse = exports.DeleteQueuedTransactionRequest = exports.ListQueuedTransactionsResponse = exports.ListQueuedTransactionsRequest = exports.BankAccount = exports.MerchantProfileResponse = exports.MerchantProfile = exports.Address = exports.InviteMerchantUserRequest = exports.MerchantPlatformRequest = exports.MerchantProfileRequest = exports.AddTestMerchantRequest = exports.TerminalVolume = exports.BatchDetailsResponse = exports.BatchDetailsRequest = exports.BatchSummary = exports.BatchHistoryResponse = exports.BatchHistoryRequest = exports.TransactionHistoryResponse = exports.TransactionHistoryRequest = exports.CashDiscountResponse = exports.CashDiscountRequest = exports.ResendPaymentLinkResponse = exports.ResendPaymentLinkRequest = exports.CancelPaymentLinkResponse = exports.CancelPaymentLinkRequest = exports.PaymentLinkResponse = exports.PaymentLinkRequest = exports.TerminalStatusResponse = exports.TerminalStatusRequest = void 0;
-exports.TerminalCaptureSignatureRequest = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = exports.StatementDeposit = exports.InvoicePayment = exports.InvoiceLineItem = exports.MerchantInvoiceDetailResponse = exports.MerchantInvoiceDetailRequest = exports.MerchantInvoiceSummary = exports.MerchantInvoiceListResponse = exports.MerchantInvoiceListRequest = exports.PartnerStatementAdjustment = exports.PartnerStatementDisbursement = exports.PartnerStatementLineItem = exports.PartnerStatementDetailResponse = exports.PartnerStatementDetailRequest = exports.PartnerStatementListResponse = exports.PartnerStatementSummary = exports.PartnerStatementListRequest = exports.PricingPolicyResponse = exports.PricePoint = exports.PricingPolicyRequest = exports.BrandingAssetResponse = exports.BrandingAsset = exports.BrandingAssetRequest = exports.SlideShowRequest = exports.SlideShowResponse = exports.SlideShow = exports.Slide = exports.MediaLibraryResponse = exports.MediaRequest = exports.UploadStatusRequest = exports.UploadStatus = exports.UploadMetadata = exports.MediaMetadata = exports.SurveyResultsRequest = exports.SurveyDataPoint = exports.SurveyQuestionResponse = exports.SurveyQuestionRequest = exports.SurveyQuestion = exports.TermsAndConditionsLogEntry = exports.TermsAndConditionsLogResponse = exports.TermsAndConditionsLogRequest = exports.TermsAndConditionsTemplateResponse = exports.TermsAndConditionsTemplateRequest = void 0;
-exports.CoreResponse = exports.PreviousTransaction = exports.Subtotals = exports.RequestAmount = exports.PaymentMethod = exports.PaymentAmounts = exports.CryptocurrencyResponse = exports.PaymentMethodResponse = exports.CoreRequest = exports.TimeoutRequest = exports.ApprovalResponse = exports.SignatureRequest = exports.SignatureResponse = exports.TerminalReference = exports.AbstractAcknowledgement = exports.TerminalDeleteQueuedTransactionRequest = exports.TerminalListQueuedTransactionsRequest = exports.TerminalTerminalStatusRequest = exports.TerminalTransactionDisplayRequest = exports.TerminalTermsAndConditionsResponse = exports.TerminalTermsAndConditionsRequest = exports.TerminalGiftActivateRequest = exports.TerminalClearTerminalRequest = exports.TerminalEnrollRequest = exports.TerminalRefundRequest = exports.TerminalBalanceRequest = exports.TerminalAuthorizationRequest = exports.TerminalTextPromptRequest = exports.TerminalBooleanPromptRequest = exports.TerminalMessageRequest = exports.TerminalLocateRequest = exports.TerminalPingRequest = void 0;
+exports.TerminalDeactivationRequest = exports.TerminalProfileResponse = exports.TerminalProfileRequest = exports.MerchantPlatform = exports.UpdateMerchantPlatformResponse = exports.UpdateMerchantPlatformRequest = exports.MerchantPlatformsResponse = exports.MerchantUser = exports.MerchantUsersResponse = exports.GetMerchantsResponse = exports.GetMerchantsRequest = exports.HealthcareGroup = exports.Healthcare = exports.UnlinkTokenRequest = exports.LinkTokenRequest = exports.DeleteTokenResponse = exports.DeleteTokenRequest = exports.DeleteCustomerResponse = exports.DeleteCustomerRequest = exports.DeleteQueuedTransactionResponse = exports.DeleteQueuedTransactionRequest = exports.ListQueuedTransactionsResponse = exports.ListQueuedTransactionsRequest = exports.BankAccount = exports.MerchantProfileResponse = exports.MerchantProfile = exports.Address = exports.InviteMerchantUserRequest = exports.MerchantPlatformRequest = exports.MerchantProfileRequest = exports.AddGatewayMerchantRequest = exports.AddTestMerchantRequest = exports.TerminalVolume = exports.BatchDetailsResponse = exports.BatchDetailsRequest = exports.BatchSummary = exports.BatchHistoryResponse = exports.BatchHistoryRequest = exports.TransactionHistoryResponse = exports.TransactionHistoryRequest = exports.CashDiscountResponse = exports.CashDiscountRequest = exports.ResendPaymentLinkResponse = exports.ResendPaymentLinkRequest = exports.CancelPaymentLinkResponse = exports.CancelPaymentLinkRequest = exports.PaymentLinkResponse = exports.PaymentLinkRequest = exports.TerminalStatusResponse = exports.TerminalStatusRequest = void 0;
+exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = exports.StatementDeposit = exports.InvoicePayment = exports.InvoiceLineItem = exports.MerchantInvoiceDetailResponse = exports.MerchantInvoiceDetailRequest = exports.MerchantInvoiceSummary = exports.MerchantInvoiceListResponse = exports.MerchantInvoiceListRequest = exports.PartnerStatementAdjustment = exports.PartnerStatementDisbursement = exports.PartnerStatementLineItem = exports.PartnerStatementDetailResponse = exports.PartnerStatementDetailRequest = exports.PartnerStatementListResponse = exports.PartnerStatementSummary = exports.PartnerStatementListRequest = exports.PricingPolicyResponse = exports.PricePoint = exports.PricingPolicyRequest = exports.BrandingAssetResponse = exports.BrandingAsset = exports.BrandingAssetRequest = exports.SlideShowRequest = exports.SlideShowResponse = exports.SlideShow = exports.Slide = exports.MediaLibraryResponse = exports.MediaRequest = exports.UploadStatusRequest = exports.UploadStatus = exports.UploadMetadata = exports.MediaMetadata = exports.SurveyResultsRequest = exports.SurveyDataPoint = exports.SurveyQuestionResponse = exports.SurveyQuestionRequest = exports.SurveyQuestion = exports.TermsAndConditionsLogEntry = exports.TermsAndConditionsLogResponse = exports.TermsAndConditionsLogRequest = exports.TermsAndConditionsTemplateResponse = exports.TermsAndConditionsTemplateRequest = exports.TermsAndConditionsTemplate = exports.TerminalProfile = exports.TerminalActivationRequest = void 0;
+exports.CoreResponse = exports.PreviousTransaction = exports.Subtotals = exports.RequestAmount = exports.PaymentMethod = exports.PaymentAmounts = exports.CryptocurrencyResponse = exports.PaymentMethodResponse = exports.CoreRequest = exports.TimeoutRequest = exports.ApprovalResponse = exports.SignatureRequest = exports.SignatureResponse = exports.TerminalReference = exports.AbstractAcknowledgement = exports.TerminalDeleteQueuedTransactionRequest = exports.TerminalListQueuedTransactionsRequest = exports.TerminalTerminalStatusRequest = exports.TerminalTransactionDisplayRequest = exports.TerminalTermsAndConditionsResponse = exports.TerminalTermsAndConditionsRequest = exports.TerminalGiftActivateRequest = exports.TerminalClearTerminalRequest = exports.TerminalEnrollRequest = exports.TerminalRefundRequest = exports.TerminalBalanceRequest = exports.TerminalAuthorizationRequest = exports.TerminalTextPromptRequest = exports.TerminalBooleanPromptRequest = exports.TerminalMessageRequest = exports.TerminalLocateRequest = exports.TerminalPingRequest = exports.TerminalCaptureSignatureRequest = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = void 0;
 // CardType is used to differentiate credit, debit, and EBT.
 var CardType;
 (function (CardType) {
@@ -63779,6 +63785,30 @@ class AddTestMerchantRequest {
     }
 }
 exports.AddTestMerchantRequest = AddTestMerchantRequest;
+/**
+ * Models basic information needed to create a gateway merchant.
+ */
+class AddGatewayMerchantRequest {
+    // Constructor with default values for optional fields
+    constructor(test = null, profile = null, timeout = null) {
+        /**
+         * Whether or not to route transaction to the test gateway.
+         */
+        this.test = null;
+        /**
+         * The merchant profile to be boarded.
+         */
+        this.profile = null;
+        /**
+         * The request timeout in seconds.
+         */
+        this.timeout = null;
+        this.test = test;
+        this.profile = profile;
+        this.timeout = timeout;
+    }
+}
+exports.AddGatewayMerchantRequest = AddGatewayMerchantRequest;
 /**
  * Models a request for information about the merchant profile.
  */
@@ -63998,7 +64028,7 @@ exports.Address = Address;
  */
 class MerchantProfile {
     // Constructor with default values for optional fields
-    constructor(timeout = null, test = null, merchantId = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null) {
+    constructor(timeout = null, test = null, merchantId = null, bankMid = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null) {
         /**
          * The request timeout in seconds.
          */
@@ -64011,6 +64041,10 @@ class MerchantProfile {
          * The merchant id.
          */
         this.merchantId = null;
+        /**
+         * The primary bank mid.
+         */
+        this.bankMid = null;
         /**
          * The merchant's company name.
          */
@@ -64214,6 +64248,7 @@ class MerchantProfile {
         this.timeout = timeout;
         this.test = test;
         this.merchantId = merchantId;
+        this.bankMid = bankMid;
         this.companyName = companyName;
         this.dbaName = dbaName;
         this.invoiceName = invoiceName;
@@ -64271,7 +64306,7 @@ exports.MerchantProfile = MerchantProfile;
  */
 class MerchantProfileResponse {
     // Constructor with default values for optional fields
-    constructor(success = null, error = null, responseDescription = null, test = null, merchantId = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null) {
+    constructor(success = null, error = null, responseDescription = null, test = null, merchantId = null, bankMid = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null) {
         /**
          * Whether or not the request succeeded.
          */
@@ -64292,6 +64327,10 @@ class MerchantProfileResponse {
          * The merchant id.
          */
         this.merchantId = null;
+        /**
+         * The primary bank mid.
+         */
+        this.bankMid = null;
         /**
          * The merchant's company name.
          */
@@ -64497,6 +64536,7 @@ class MerchantProfileResponse {
         this.responseDescription = responseDescription;
         this.test = test;
         this.merchantId = merchantId;
+        this.bankMid = bankMid;
         this.companyName = companyName;
         this.dbaName = dbaName;
         this.invoiceName = invoiceName;
@@ -65250,6 +65290,59 @@ class MerchantPlatformsResponse {
     }
 }
 exports.MerchantPlatformsResponse = MerchantPlatformsResponse;
+/**
+ * Used to up platform configuration for gateway merchants.
+ */
+class UpdateMerchantPlatformRequest {
+    // Constructor with default values for optional fields
+    constructor(timeout = null, test = null, platform = null) {
+        /**
+         * The request timeout in seconds.
+         */
+        this.timeout = null;
+        /**
+         * Whether or not to route transaction to the test gateway.
+         */
+        this.test = null;
+        /**
+         * The merchant platform configuration.
+         */
+        this.platform = null;
+        this.timeout = timeout;
+        this.test = test;
+        this.platform = platform;
+    }
+}
+exports.UpdateMerchantPlatformRequest = UpdateMerchantPlatformRequest;
+/**
+ * Echoes back the state of the current platform configuration after a change.
+ */
+class UpdateMerchantPlatformResponse {
+    // Constructor with default values for optional fields
+    constructor(success = null, error = null, responseDescription = null, platform = null) {
+        /**
+         * Whether or not the request succeeded.
+         */
+        this.success = null;
+        /**
+         * The error, if an error occurred.
+         */
+        this.error = null;
+        /**
+         * A narrative description of the transaction result.
+         */
+        this.responseDescription = null;
+        /**
+         * The current platform configuration.
+         */
+        this.platform = null;
+        this.success = success;
+        this.error = error;
+        this.responseDescription = responseDescription;
+        this.platform = platform;
+    }
+}
+exports.UpdateMerchantPlatformResponse = UpdateMerchantPlatformResponse;
 /**
  * Details about a merchant board platform configuration.
  */
@@ -68201,7 +68294,7 @@ exports.PartnerCommissionBreakdownResponse = PartnerCommissionBreakdownResponse;
  */
 class MerchantCredentialGenerationRequest {
     // Constructor with default values for optional fields
-    constructor(timeout = null, test = null, merchantId = null, deleteProtected = null, roles = null, notes = null) {
+    constructor(timeout = null, test = null, merchantId = null, deleteProtected = null, roles = null, notes = null, credentialType = null) {
         /**
          * The request timeout in seconds.
          */
@@ -68226,12 +68319,17 @@ class MerchantCredentialGenerationRequest {
          * Free form description of the purpose or intent behind the credentials.
          */
         this.notes = null;
+        /**
+         * Type of credentials to generate, either API or TOKENIZING. Defaults to API.
+         */
+        this.credentialType = null;
         this.timeout = timeout;
         this.test = test;
         this.merchantId = merchantId;
         this.deleteProtected = deleteProtected;
         this.roles = roles;
         this.notes = notes;
+        this.credentialType = credentialType;
     }
 }
 exports.MerchantCredentialGenerationRequest = MerchantCredentialGenerationRequest;
@@ -68240,7 +68338,7 @@ exports.MerchantCredentialGenerationRequest = MerchantCredentialGenerationReques
  */
 class MerchantCredentialGenerationResponse {
     // Constructor with default values for optional fields
-    constructor(success = null, error = null, responseDescription = null, apiKey = null, bearerToken = null, signingKey = null) {
+    constructor(success = null, error = null, responseDescription = null, apiKey = null, bearerToken = null, signingKey = null, tokenizingKey = null) {
         /**
          * Whether or not the request succeeded.
          */
@@ -68265,12 +68363,17 @@ class MerchantCredentialGenerationResponse {
          * The merchant signing key.
          */
         this.signingKey = null;
+        /**
+         * The tokenizing key.
+         */
+        this.tokenizingKey = null;
         this.success = success;
         this.error = error;
         this.responseDescription = responseDescription;
         this.apiKey = apiKey;
         this.bearerToken = bearerToken;
         this.signingKey = signingKey;
+        this.tokenizingKey = tokenizingKey;
     }
 }
 exports.MerchantCredentialGenerationResponse = MerchantCredentialGenerationResponse;