@blockchyp/blockchyp-ts 2.24.5 → 2.24.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2515,6 +2515,43 @@ client.unlinkToken(request)
2515
2515
 
2516
2516
  ```
2517
2517
 
2518
+ #### Update Token
2519
+
2520
+
2521
+
2522
+ * **API Credential Types:** Merchant
2523
+ * **Required Role:** Payment API Access
2524
+
2525
+ This API updates a payment token in the gateway. This can be used to update token metadata such as expiration dates, cardholder name, bank name, account holder type, account type, address, and postal code.
2526
+
2527
+
2528
+
2529
+
2530
+ ```typescript
2531
+ import * as BlockChyp from '@blockchyp/blockchyp-ts';
2532
+
2533
+ const client = BlockChyp.newClient({
2534
+ apiKey: 'ZDSMMZLGRPBPRTJUBTAFBYZ33Q',
2535
+ bearerToken: 'ZLBW5NR4U5PKD5PNP3ZP3OZS5U',
2536
+ signingKey: '9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947'
2537
+ });
2538
+
2539
+ const request = new BlockChyp.UpdateTokenRequest();
2540
+ request.token = '<TOKEN>';
2541
+ request.expiryMonth = '12';
2542
+ request.expiryYear = '2040';
2543
+
2544
+ client.updateToken(request)
2545
+ .then(function(httpResponse) {
2546
+ const response: BlockChyp.UpdateTokenResponse = httpResponse.data;
2547
+ console.log('Response: ' + JSON.stringify(response));
2548
+ })
2549
+ .catch(function (error: any) {
2550
+ console.log(error);
2551
+ });
2552
+
2553
+ ```
2554
+
2518
2555
  #### Delete Token
2519
2556
 
2520
2557
 
@@ -59111,6 +59111,12 @@ class BlockChypClient {
59111
59111
  unlinkToken(request) {
59112
59112
  return this._gatewayRequest('post', '/api/unlink-token', request);
59113
59113
  }
59114
+ /**
59115
+ * Updates a payment token.
59116
+ */
59117
+ updateToken(request) {
59118
+ return this._gatewayRequest('post', '/api/token/' + request.token, request);
59119
+ }
59114
59120
  /**
59115
59121
  * Deletes a payment token.
59116
59122
  */
@@ -59694,10 +59700,10 @@ exports["default"] = CryptoUtils;
59694
59700
  * file will be lost every time the code is regenerated.
59695
59701
  */
59696
59702
  Object.defineProperty(exports, "__esModule", ({ value: true }));
59697
- 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.CardMetadataResponse = exports.CardMetadataRequest = exports.CardMetadata = 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;
59698
- exports.MerchantPlatform = exports.UpdateMerchantPlatformResponse = exports.UpdateMerchantPlatformRequest = exports.MerchantPlatformsResponse = exports.MerchantUser = exports.MerchantUsersResponse = exports.GetMerchantsResponse = exports.GetMerchantsRequest = exports.HealthcareGroup = exports.HealthcareMetadata = 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 = exports.HeartbeatResponse = exports.TransactionDisplayRequest = exports.TransactionDisplayTransaction = void 0;
59699
- 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 = exports.TerminalDeactivationRequest = exports.TerminalProfileResponse = exports.TerminalProfileRequest = void 0;
59700
- 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.TerminalCardMetadataRequest = exports.TerminalAuthorizationRequest = exports.TerminalTextPromptRequest = exports.TerminalBooleanPromptRequest = exports.TerminalMessageRequest = exports.TerminalLocateRequest = exports.TerminalPingRequest = exports.TerminalCaptureSignatureRequest = exports.SubmitApplicationRequest = exports.MerchantApplication = exports.ApplicationAccount = exports.Owner = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = void 0;
59703
+ 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.CardMetadataResponse = exports.CardMetadataRequest = exports.CardMetadata = exports.AuthorizationRequest = exports.WhiteListedCard = exports.BooleanPromptResponse = exports.TextPromptResponse = exports.CustomerToken = exports.UpdateTokenResponse = exports.UpdateTokenRequest = 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;
59704
+ exports.UpdateMerchantPlatformRequest = exports.MerchantPlatformsResponse = exports.MerchantUser = exports.MerchantUsersResponse = exports.GetMerchantsResponse = exports.GetMerchantsRequest = exports.HealthcareGroup = exports.HealthcareMetadata = 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 = exports.HeartbeatResponse = exports.TransactionDisplayRequest = exports.TransactionDisplayTransaction = exports.TransactionDisplayItem = exports.TransactionDisplayDiscount = void 0;
59705
+ 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 = exports.TerminalDeactivationRequest = exports.TerminalProfileResponse = exports.TerminalProfileRequest = exports.MerchantPlatform = exports.UpdateMerchantPlatformResponse = void 0;
59706
+ 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.TerminalCardMetadataRequest = exports.TerminalAuthorizationRequest = exports.TerminalTextPromptRequest = exports.TerminalBooleanPromptRequest = exports.TerminalMessageRequest = exports.TerminalLocateRequest = exports.TerminalPingRequest = exports.TerminalCaptureSignatureRequest = exports.SubmitApplicationRequest = exports.MerchantApplication = exports.ApplicationAccount = exports.Owner = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = void 0;
59701
59707
  // CardType is used to differentiate credit, debit, and EBT.
59702
59708
  var CardType;
59703
59709
  (function (CardType) {
@@ -60587,6 +60593,99 @@ class TokenMetadataResponse {
60587
60593
  }
60588
60594
  }
60589
60595
  exports.TokenMetadataResponse = TokenMetadataResponse;
60596
+ /**
60597
+ * Updates a payment token.
60598
+ */
60599
+ class UpdateTokenRequest {
60600
+ // Constructor with default values for optional fields
60601
+ constructor(timeout = null, test = null, token = null, accountHolderType = null, accountType = null, bankName = null, cardHolderName = null, expiryMonth = null, expiryYear = null, address = null, postalCode = null) {
60602
+ /**
60603
+ * The request timeout in seconds.
60604
+ */
60605
+ this.timeout = null;
60606
+ /**
60607
+ * Whether or not to route transaction to the test gateway.
60608
+ */
60609
+ this.test = null;
60610
+ /**
60611
+ * The token to update.
60612
+ */
60613
+ this.token = null;
60614
+ /**
60615
+ * Bank account holder type (personal or business).
60616
+ */
60617
+ this.accountHolderType = null;
60618
+ /**
60619
+ * Bank account type (checking or saving).
60620
+ */
60621
+ this.accountType = null;
60622
+ /**
60623
+ * Bank name.
60624
+ */
60625
+ this.bankName = null;
60626
+ /**
60627
+ * Card holder name.
60628
+ */
60629
+ this.cardHolderName = null;
60630
+ /**
60631
+ * Expiry month.
60632
+ */
60633
+ this.expiryMonth = null;
60634
+ /**
60635
+ * Expiry year.
60636
+ */
60637
+ this.expiryYear = null;
60638
+ /**
60639
+ * Address.
60640
+ */
60641
+ this.address = null;
60642
+ /**
60643
+ * Postal code.
60644
+ */
60645
+ this.postalCode = null;
60646
+ this.timeout = timeout;
60647
+ this.test = test;
60648
+ this.token = token;
60649
+ this.accountHolderType = accountHolderType;
60650
+ this.accountType = accountType;
60651
+ this.bankName = bankName;
60652
+ this.cardHolderName = cardHolderName;
60653
+ this.expiryMonth = expiryMonth;
60654
+ this.expiryYear = expiryYear;
60655
+ this.address = address;
60656
+ this.postalCode = postalCode;
60657
+ }
60658
+ }
60659
+ exports.UpdateTokenRequest = UpdateTokenRequest;
60660
+ /**
60661
+ * The response to a update token request.
60662
+ */
60663
+ class UpdateTokenResponse {
60664
+ // Constructor with default values for optional fields
60665
+ constructor(success = null, error = null, responseDescription = null, token = null) {
60666
+ /**
60667
+ * Whether or not the request succeeded.
60668
+ */
60669
+ this.success = null;
60670
+ /**
60671
+ * The error, if an error occurred.
60672
+ */
60673
+ this.error = null;
60674
+ /**
60675
+ * A narrative description of the transaction result.
60676
+ */
60677
+ this.responseDescription = null;
60678
+ /**
60679
+ * The updated token for a given query.
60680
+ */
60681
+ this.token = null;
60682
+ this.success = success;
60683
+ this.error = error;
60684
+ this.responseDescription = responseDescription;
60685
+ this.token = token;
60686
+ }
60687
+ }
60688
+ exports.UpdateTokenResponse = UpdateTokenResponse;
60590
60689
  /**
60591
60690
  * Models a customer token.
60592
60691
  */