@channelpayments/node-sdk 1.137.0 → 1.177.0

package/dist/cjs/apis/ChannelPaymentsApi.d.ts

@@ -5,40 +5,7 @@
  *
  */
 import * as runtime from '../runtime';
-import type { BuyersEntity, BuyersSearchEntity, CaptureTransactionDto, CheckoutSessionEntity, ConnectorServiceTokenEntity, CreateBuyerDto, CreateCheckoutSessionDto, CreatePaymentMethodDto, CreateProvisionedCardTokenDto, CreateTransactionNoteDto, CreateTransactionRefundDto, CreateTransactionRequestDto, MerchantEntity, PaymentMethodEntity, PaymentMethodsSearchEntity, TagDto, TransactionEntity, TransactionNoteEntity, TransactionRefundEntity, TransactionRefundsSearchEntity, TransactionReturnsSearchEntity, TransactionsSearchEntity, UpdateBuyerDto } from '../models';
-export interface DeleteBuyerRequest {
-    buyerId: string;
-}
-export interface DeleteConnectorServiceTokenRequest {
-    connectorServiceTokenId: any;
-}
-export interface DeletePaymentMethodRequest {
-    paymentMethodId: any;
-}
-export interface DeleteTransactionNoteRequest {
-    noteId: string;
-}
-export interface GetBuyerRequest {
-    buyerId: string;
-}
-export interface GetCheckoutSessionRequest {
-    sessionId: string;
-}
-export interface GetConnectorServiceTokenRequest {
-    connectorServiceTokenId: any;
-}
-export interface GetConnectorServiceTokensRequest {
-    paymentMethodId: any;
-}
-export interface GetPaymentMethodRequest {
-    paymentMethodId: any;
-}
-export interface GetRefundRequest {
-    refundId: string;
-}
-export interface GetTransactionRequest {
-    transactionId: string;
-}
+import type { BuyersEntity, BuyersSearchEntity, CaptureTransactionDto, ChangeNotificationEntity, ChangeNotificationsSearchEntity, CheckoutSessionEntity, ConnectorServiceTokenEntity, CreateBuyerDto, CreateCheckoutSessionDto, CreatePaymentMethodDto, CreateProvisionedCardTokenDto, CreateTransactionNoteDto, CreateTransactionRefundDto, CreateTransactionRequestDto, MerchantEntity, PaymentMethodEntity, PaymentMethodsSearchEntity, ReturnNotificationEntity, ReturnNotificationsSearchEntity, TagDto, TransactionEntity, TransactionNoteEntity, TransactionRefundEntity, TransactionRefundsSearchEntity, TransactionsSearchEntity, UpdateBuyerDto, UpdateTransactionNoteDto } from '../models';
 export interface SearchBuyersRequest {
     merchantId: string;
     buyerId?: string;
@@ -53,6 +20,13 @@ export interface SearchBuyersRequest {
     order?: SearchBuyersOrderEnum;
     searchTerm?: string;
 }
+export interface SearchChangeNotificationsRequest {
+    startDate: string;
+    endDate?: string;
+    limit?: string;
+    order?: SearchChangeNotificationsOrderEnum;
+    cursor?: string;
+}
 export interface SearchPaymentMethodsRequest {
     merchantId: string;
     paymentMethodId?: string;
@@ -68,8 +42,9 @@ export interface SearchPaymentMethodsRequest {
     order?: SearchPaymentMethodsOrderEnum;
 }
 export interface SearchRefundsRequest {
-    merchantId: string;
+    merchantId?: string;
     transactionId?: string;
+    refundTransactionId?: string;
     status?: Array<SearchRefundsStatusEnum>;
     startDate?: string;
     endDate?: string;
@@ -78,16 +53,15 @@ export interface SearchRefundsRequest {
     limit?: string;
     order?: SearchRefundsOrderEnum;
 }
-export interface SearchReturnsRequest {
-    merchantId: string;
+export interface SearchReturnNotificationsRequest {
     startDate: string;
     endDate?: string;
     limit?: string;
-    order?: SearchReturnsOrderEnum;
+    order?: SearchReturnNotificationsOrderEnum;
     cursor?: string;
 }
 export interface SearchTransactionsRequest {
-    merchantId: string;
+    merchantId?: string;
     accountHolderName?: string;
     accountType?: Array<SearchTransactionsAccountTypeEnum>;
     amount?: string;
@@ -106,7 +80,7 @@ export interface SearchTransactionsRequest {
     hasRefunds?: string;
     includeCFee?: string;
     intent?: Array<SearchTransactionsIntentEnum>;
-    label?: string;
+    last4?: string;
     limit?: string;
     method?: Array<SearchTransactionsMethodEnum>;
     order?: SearchTransactionsOrderEnum;
@@ -116,69 +90,78 @@ export interface SearchTransactionsRequest {
     voidedAt?: string;
     sessionId?: string;
     tags?: Array<TagDto>;
-}
-export interface VoidTransactionRequest {
-    transactionId: string;
+    externalTransactionId?: string;
+    transactionId?: string;
 }
 /**
  *
  */
 export declare class ChannelPaymentsApi extends runtime.BaseAPI {
+    /**
+     * Attempts to acknowledge a change notification
+     * Acknowledge change notification
+    */
+    acknowledgeChangeNotification(changeNotificationId: string): Promise<ChangeNotificationEntity>;
+    /**
+     * Attempts to acknowledge a return notification
+     * Acknowledge return notification
+    */
+    acknowledgeReturnNotification(returnNotificationId: string): Promise<ReturnNotificationEntity>;
     /**
      * Attempts to capture an authorized transaction
      * Capture transaction
     */
-    captureTransaction(requestParameters: CaptureTransactionDto): Promise<TransactionEntity>;
+    captureTransaction(captureTransactionDto: CaptureTransactionDto, idempotencyKey?: string): Promise<TransactionEntity>;
     /**
      * Creates a new buyer.
      * Create buyer.
     */
-    createBuyer(requestParameters: CreateBuyerDto): Promise<BuyersEntity>;
+    createBuyer(createBuyerDto: CreateBuyerDto): Promise<BuyersEntity>;
     /**
      * Attempts to create a transaction session token
      * Create transaction session
     */
-    createCheckoutSession(requestParameters: CreateCheckoutSessionDto): Promise<CheckoutSessionEntity>;
+    createCheckoutSession(createCheckoutSessionDto: CreateCheckoutSessionDto): Promise<CheckoutSessionEntity>;
     /**
      * Attempts to create a new transaction by specified intent for a given payment method
      * Create transaction
     */
-    createTransaction(requestParameters: CreateTransactionRequestDto): Promise<TransactionEntity>;
+    createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, idempotencyKey?: string): Promise<TransactionEntity>;
     /**
      * Attempts to create a transaction note
      * Create transaction note
     */
-    createTransactionNote(requestParameters: CreateTransactionNoteDto): Promise<TransactionNoteEntity>;
+    createTransactionNote(createTransactionNoteDto: CreateTransactionNoteDto): Promise<TransactionNoteEntity>;
     /**
      * Removes a buyer ID.
      * Remove buyer.
     */
-    deleteBuyer(requestParameters: DeleteBuyerRequest): Promise<BuyersEntity>;
+    deleteBuyer(buyerId: string): Promise<BuyersEntity>;
     /**
      * Delete connector service token by connectorServiceTokenId.
      * Delete connector service token.
     */
-    deleteConnectorServiceToken(requestParameters: DeleteConnectorServiceTokenRequest): Promise<ConnectorServiceTokenEntity>;
+    deleteConnectorServiceToken(connectorServiceTokenId: string): Promise<ConnectorServiceTokenEntity>;
     /**
      * Delete payment method by paymentMethodId.
      * Delete payment method.
     */
-    deletePaymentMethod(requestParameters: DeletePaymentMethodRequest): Promise<PaymentMethodEntity>;
+    deletePaymentMethod(paymentMethodId: string): Promise<PaymentMethodEntity>;
     /**
      * Attempts to delete a transaction note.
      * Delete transaction note.
     */
-    deleteTransactionNote(requestParameters: DeleteTransactionNoteRequest): Promise<TransactionNoteEntity>;
+    deleteTransactionNote(noteId: string): Promise<TransactionNoteEntity>;
     /**
      * Find a buyer by buyer ID.
      * Find buyer.
     */
-    getBuyer(requestParameters: GetBuyerRequest): Promise<BuyersEntity>;
+    getBuyer(buyerId: string): Promise<BuyersEntity>;
     /**
      * Attempts to fetch a checkout session for hosted client
      * Get checkout session
     */
-    getCheckoutSession(requestParameters: GetCheckoutSessionRequest): Promise<CheckoutSessionEntity>;
+    getCheckoutSession(sessionId: string): Promise<CheckoutSessionEntity>;
     /**
      * Retrieve all child merchants of the merchant associated with the user making the request.
      * Find child merchants
@@ -188,12 +171,12 @@ export declare class ChannelPaymentsApi extends runtime.BaseAPI {
      * Find connector service token by connectorServiceTokenId.
      * Find connector service token.
     */
-    getConnectorServiceToken(requestParameters: GetConnectorServiceTokenRequest): Promise<ConnectorServiceTokenEntity>;
+    getConnectorServiceToken(connectorServiceTokenId: string): Promise<ConnectorServiceTokenEntity>;
     /**
      * Find connector service tokens by paymentMethodId.
      * Find connector service tokens.
     */
-    getConnectorServiceTokens(requestParameters: GetConnectorServiceTokensRequest): Promise<Array<ConnectorServiceTokenEntity>>;
+    getConnectorServiceTokens(paymentMethodId: string): Promise<Array<ConnectorServiceTokenEntity>>;
     /**
      * Retrieve the merchant associated with the user making the request.
      * Find merchant
@@ -203,32 +186,37 @@ export declare class ChannelPaymentsApi extends runtime.BaseAPI {
      * Find payment method by paymentMethodId.
      * Find by payment method.
     */
-    getPaymentMethod(requestParameters: GetPaymentMethodRequest): Promise<PaymentMethodEntity>;
+    getPaymentMethod(paymentMethodId: string): Promise<PaymentMethodEntity>;
     /**
      * Attempts to find refund by transaction ID and refund ID
      * Find refund
     */
-    getRefund(requestParameters: GetRefundRequest): Promise<TransactionRefundEntity>;
+    getRefund(refundId: string): Promise<TransactionRefundEntity>;
     /**
      * Attempts to find a transaction by ID
      * Find transaction
     */
-    getTransaction(requestParameters: GetTransactionRequest): Promise<TransactionEntity>;
+    getTransaction(transactionId: string): Promise<TransactionEntity>;
     /**
      * Provision a stored payment method.
      * Provision stored payment method.
     */
-    provisionCardPaymentMethod(requestParameters: CreateProvisionedCardTokenDto): Promise<ConnectorServiceTokenEntity>;
+    provisionCardPaymentMethod(createProvisionedCardTokenDto: CreateProvisionedCardTokenDto): Promise<ConnectorServiceTokenEntity>;
     /**
      * Attempts to refund a captured transaction
      * Refund a transaction
     */
-    refundTransaction(requestParameters: CreateTransactionRefundDto): Promise<TransactionRefundEntity>;
+    refundTransaction(createTransactionRefundDto: CreateTransactionRefundDto, idempotencyKey?: string): Promise<TransactionRefundEntity>;
     /**
      * Search a buyer by query param
      * Search a buyer
     */
     searchBuyers(requestParameters: SearchBuyersRequest): Promise<BuyersSearchEntity>;
+    /**
+     * Search all change notifications by date range.
+     * Search for change notifications.
+    */
+    searchChangeNotifications(requestParameters: SearchChangeNotificationsRequest): Promise<Array<ChangeNotificationsSearchEntity>>;
     /**
      * Search a payment methods by query params.
      * Search payment methods.
@@ -240,10 +228,10 @@ export declare class ChannelPaymentsApi extends runtime.BaseAPI {
     */
     searchRefunds(requestParameters: SearchRefundsRequest): Promise<TransactionRefundsSearchEntity>;
     /**
-     * Search all return notifications by date range
-     * Search for return notifications
+     * Search all return notifications by date range.
+     * Search for return notifications.
     */
-    searchReturns(requestParameters: SearchReturnsRequest): Promise<Array<TransactionReturnsSearchEntity>>;
+    searchReturnNotifications(requestParameters: SearchReturnNotificationsRequest): Promise<Array<ReturnNotificationsSearchEntity>>;
     /**
      * Search transactions by query params
      * Search transactions
@@ -253,17 +241,22 @@ export declare class ChannelPaymentsApi extends runtime.BaseAPI {
      * Store a payment method.
      * Store payment method.
     */
-    storePaymentMethod(requestParameters: CreatePaymentMethodDto): Promise<PaymentMethodEntity>;
+    storePaymentMethod(createPaymentMethodDto: CreatePaymentMethodDto): Promise<PaymentMethodEntity>;
     /**
      * Updates an existing buyer.
      * Update buyer.
     */
-    updateBuyer(requestParameters: UpdateBuyerDto): Promise<BuyersEntity>;
+    updateBuyer(updateBuyerDto: UpdateBuyerDto): Promise<BuyersEntity>;
+    /**
+     * Updates an existing transaction note.
+     * Update transaction note.
+    */
+    updateTransactionNote(noteId: string, updateTransactionNoteDto: UpdateTransactionNoteDto): Promise<TransactionNoteEntity>;
     /**
      * Attempts to void an authorized transaction
      * Void a transaction
     */
-    voidTransaction(requestParameters: VoidTransactionRequest): Promise<TransactionEntity>;
+    voidTransaction(transactionId: string, idempotencyKey?: string): Promise<TransactionEntity>;
 }
 /**
  * @export
@@ -273,6 +266,14 @@ export declare const SearchBuyersOrderEnum: {
     readonly Desc: "desc";
 };
 export type SearchBuyersOrderEnum = typeof SearchBuyersOrderEnum[keyof typeof SearchBuyersOrderEnum];
+/**
+ * @export
+ */
+export declare const SearchChangeNotificationsOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type SearchChangeNotificationsOrderEnum = typeof SearchChangeNotificationsOrderEnum[keyof typeof SearchChangeNotificationsOrderEnum];
 /**
  * @export
  */
@@ -334,11 +335,11 @@ export type SearchRefundsOrderEnum = typeof SearchRefundsOrderEnum[keyof typeof
 /**
  * @export
  */
-export declare const SearchReturnsOrderEnum: {
+export declare const SearchReturnNotificationsOrderEnum: {
     readonly Asc: "asc";
     readonly Desc: "desc";
 };
-export type SearchReturnsOrderEnum = typeof SearchReturnsOrderEnum[keyof typeof SearchReturnsOrderEnum];
+export type SearchReturnNotificationsOrderEnum = typeof SearchReturnNotificationsOrderEnum[keyof typeof SearchReturnNotificationsOrderEnum];
 /**
  * @export
  */