chargebee 2.41.0 → 3.0.0-beta.2

package/types/resources/Transaction.d.ts

@@ -1,948 +1,313 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Transaction {
-    
-    /**
-      * @description Uniquely identifies the transaction.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description Identifier of the customer for which this transaction is made
-
-      */
-    
-    customer_id?:string;
-    
-    /**
-      * @description Identifier of the subscription for which this transaction is made.
-
-      */
-    
-    subscription_id?:string;
-    
-    /**
-      * @description The gateway account used for this transaction
-
-      */
-    
-    gateway_account_id?:string;
-    
-    /**
-      * @description Identifier of the payment source for which this transaction is made
-
-      */
-    
-    payment_source_id?:string;
-    
-    /**
-      * @description The payment method of this transaction \* unionpay - Unionpay \* upi - upi \* check - Check \* custom - Custom \* amazon_payments - Amazon Payments \* boleto - boleto \* direct_debit - Direct Debit \* sepa_instant_transfer - Sepa Instant Transfer \* apple_pay - Apple Pay \* wechat_pay - WeChat Pay \* bancontact - Bancontact \* faster_payments - Faster Payments \* venmo - Venmo \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* other - Payment Methods other than the above types \* ach_credit - ACH Credit \* sepa_credit - SEPA Credit \* card - Card \* ideal - IDEAL \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) &#x3D; &#x60;refund&#x60;. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* google_pay - Google Pay \* netbanking_emandates - netbanking_emandates \* pay_to - PayTo \* dotpay - Dotpay \* alipay - Alipay \* sofort - Sofort \* giropay - giropay \* cash - Cash
-
-      */
-    
-    payment_method:PaymentMethod;
-    
-    /**
-      * @description The reference number for this transaction. For example, the check number when [payment_method](transactions#transaction_payment_method) &#x3D; &#x60;check&#x60;.
-
-      */
-    
-    reference_number?:string;
-    
-    /**
-      * @description Gateway through which this transaction was done. Applicable only for &#x27;Card&#x27; Payment Method \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* pay_com - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* bank_of_america - Bank of America Gateway \* gocardless - GoCardless is a payment service provider. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* paypal_pro - PayPal Pro Account is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* mollie - Mollie is a payment gateway. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
-
-      */
-    
-    gateway:Gateway;
-    
-    /**
-      * @description Type of the transaction. \* authorization - The transaction represents an authorization for capturing the [amount](transactions#transaction_amount) from the customer&#x27;s [payment_source](payment_sources). \* payment - The transaction represents capture of [amount](transactions#transaction_amount) from the customer&#x27;s [payment_source](payment_sources). \* refund - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer&#x27;s [payment_source](payment_sources). \* payment_reversal - Indicates a reversal transaction.
-
-      */
-    
-    type:'authorization' | 'payment_reversal' | 'payment' | 'refund';
-    
-    /**
-      * @description Indicates when this transaction occurred.
-
-      */
-    
-    date?:number;
-    
-    /**
-      * @description Indicates the time at which the final status of the transaction has been marked.
-
-      */
-    
-    settled_at?:number;
-    
-    /**
-      * @description Exchange rate used for base currency conversion
-
-      */
-    
-    exchange_rate?:number;
-    
-    /**
-      * @description The currency code (ISO 4217 format) for the transaction.
-
-      */
-    
-    currency_code:string;
-    
-    /**
-      * @description Amount for this transaction.
-
-      */
-    
-    amount?:number;
-    
-    /**
-      * @description The id with which this transaction is referred in gateway.
-
-      */
-    
-    id_at_gateway?:string;
-    
-    /**
-      * @description The status of this transaction. \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* timeout - Transaction failed because of Gateway not accepting the connection. \* success - The transaction is successful. \* voided - The transaction got voided or authorization expired at gateway. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* failure - Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure
-
-      */
-    
-    status?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
-    
-    /**
-      * @description Indicates whether or not the transaction has been identified as fraudulent. \* suspicious - The transaction has been identified as potentially fraudulent by the gateway \* safe - The transaction has been marked as safe \* fraudulent - The transaction has been marked as fraudulent
-
-      */
-    
-    fraud_flag?:'safe' | 'suspicious' | 'fraudulent';
-    
-    /**
-      * @description Marker for on-session payments (3DS). null indicates &#x27;merchant&#x27;. \* merchant - Payment initiated on stored payment method by the merchant \* customer - Customer initiated 3DS payment
-
-      */
-    
-    initiator_type?:'merchant' | 'customer';
-    
-    /**
-      * @description Indicates whether this transaction has gone through 3DS. Applicable only for &#x27;on-session&#x27; payments \&amp; verifications.If 3DS is not enforced by the gateway/bank or if the customers&#x27; card is not enrolled, this will be false.
-
-      */
-    
-    three_d_secure?:boolean;
-    
-    /**
-      * @description Type of authorization transaction. \* verification - The transaction has been created for payment method verification. \* blocking_funds - The transaction has been created to block the funds from payment method.
-
-      */
-    
-    authorization_reason?:'blocking_funds' | 'verification';
-    
-    /**
-      * @description Error code received from the payment gateway on failure.
-
-      */
-    
-    error_code?:string;
-    
-    /**
-      * @description Error message received from the payment gateway on failure.
-
-      */
-    
-    error_text?:string;
-    
-    /**
-      * @description Timestamp indicating when the payment was voided or authorization expired at gateway.
-
-      */
-    
-    voided_at?:number;
-    
-    /**
-      * @description Version number of this resource. The &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
-
-      */
-    
-    resource_version?:number;
-    
-    /**
-      * @description Timestamp indicating when this transaction was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
-
-      */
-    
-    updated_at?:number;
-    
-    /**
-      * @description Short description why the transaction was marked as fraud/suspicious
-
-      */
-    
-    fraud_reason?:string;
-    
-    custom_payment_method_id?:string;
-    
-    /**
-      * @description This is the part of the &#x60;amount&#x60; which has not been invoiced yet and is therefore added to [excess_payments](customers#customer_excess_payments) for the customer. Applicable only for a transaction of &#x60;type&#x60; &#x3D; &#x60;payment&#x60;.
-
-      */
-    
-    amount_unused?:number;
-    
-    /**
-      * @description The masked card number used for this transaction. Applicable only for &#x27;Card&#x27; Payment Method
-
-      */
-    
-    masked_card_number?:string;
-    
-    /**
-      * @description This is the &#x60;id&#x60; of the offline transaction that is being refunded or reversed. Applicable only for transaction of &#x60;type&#x60; &#x3D; &#x60;refund&#x60; or &#x60;payment_reversal&#x60;.
-
-      */
-    
-    reference_transaction_id?:string;
-    
-    /**
-      * @description This is the &#x60;id&#x60; of the transaction (always of &#x60;type&#x60; &#x3D; &#x60;payment&#x60;) being refunded. Applicable only for transaction of &#x60;type&#x60; &#x3D; &#x60;refund&#x60;.
-
-      */
-    
-    refunded_txn_id?:string;
-    
-    /**
-      * @description This is the &#x60;id&#x60; of the transaction (always of &#x60;type&#x60; &#x3D; &#x60;authorization&#x60;) which authorizes the payment being captured. Applicable only for transaction of &#x60;type&#x60; &#x3D; &#x60;payment&#x60;.
-
-      */
-    
-    reference_authorization_id?:string;
-    
-    /**
-      * @description This is the part of the authorized &#x60;amount&#x60; that is yet to be captured. The payment capture is recorded as a transaction of of &#x60;type&#x60; &#x3D; &#x60;payment&#x60;. Applicable only for a transaction of &#x60;type&#x60; &#x3D; &#x60;authorization&#x60;.
-
-      */
-    
-    amount_capturable?:number;
-    
-    /**
-      * @description Reversal transaction id. Applicable only for payment transactions.
-
-      */
-    
-    reversal_transaction_id?:string;
-    
-    /**
-      * @description Indicates that this resource has been deleted.
-
-      */
-    
-    deleted:boolean;
-    
-    /**
-      * @description First 6 digits of the card payment method.
-
-      */
-    
-    iin?:string;
-    
-    /**
-      * @description Last 4 digits of the card payment method.
-
-      */
-    
-    last4?:string;
-    
-    /**
-      * @description A unique id used to track this transaction across various systems you integrate with. This id is passed to the payment gateway when the transaction is initiated. Supported only for the [Exact payment gateway](https://www.chargebee.com/docs/exact-direct.html).
-
-      */
-    
-    merchant_reference_id?:string;
-    
-    /**
-      * @description The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this &#x60;transaction&#x60;. This is always the same as the business entity of the [customer](/docs/api/transactions?prod_cat_ver&#x3D;2#transaction_customer_id).   
-
-      */
-    
-    business_entity_id?:string;
-    
-    /**
-      * @description Payment method details of the corresponding transaction
-
-      */
-    
-    payment_method_details?:string;
-    
-    custom_payment_method_name?:string;
-    
-    /**
-      * @description Applicable only for &#x27;Payment&#x27; transactions. The list of invoices this &#x27;payment&#x27; transaction is applied to.
-
-      */
-    
-    linked_invoices?:Transaction.InvoiceTransaction[];
-    
-    /**
-      * @description Applicable only for &#x27;Refund&#x27; transactions. The list of Credit Notes this &#x27;refund&#x27; transaction is associated with.
-
-      */
-    
-    linked_credit_notes?:Transaction.CreditNoteTransaction[];
-    
-    /**
-      * @description Applicable only for Payment transactions. It only returns values when the transaction is not associated with an invoice, and that there is a refund for the transaction.
-
-      */
-    
-    linked_refunds?:Transaction.TxnRefundsAndReversal[];
-    
-    /**
-      * @description The list of payments captured for this authorization transaction.
-
-      */
-    
-    linked_payments?:Transaction.LinkedPayment[];
-    
-    /**
-      * @description Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about [gateway error references](gateway_error_references)
-
-      */
-    
-    error_detail?:Transaction.GatewayErrorDetail;
+    id: string;
+    customer_id?: string;
+    subscription_id?: string;
+    gateway_account_id?: string;
+    payment_source_id?: string;
+    payment_method: PaymentMethod;
+    reference_number?: string;
+    gateway: Gateway;
+    type: 'authorization' | 'payment' | 'refund' | 'payment_reversal';
+    date?: number;
+    settled_at?: number;
+    exchange_rate?: number;
+    currency_code: string;
+    amount?: number;
+    id_at_gateway?: string;
+    status?:
+      | 'in_progress'
+      | 'success'
+      | 'voided'
+      | 'failure'
+      | 'timeout'
+      | 'needs_attention';
+    fraud_flag?: 'safe' | 'suspicious' | 'fraudulent';
+    initiator_type?: 'customer' | 'merchant';
+    three_d_secure?: boolean;
+    authorization_reason?: 'blocking_funds' | 'verification';
+    error_code?: string;
+    error_text?: string;
+    voided_at?: number;
+    resource_version?: number;
+    updated_at?: number;
+    fraud_reason?: string;
+    custom_payment_method_id?: string;
+    amount_unused?: number;
+    masked_card_number?: string;
+    reference_transaction_id?: string;
+    refunded_txn_id?: string;
+    reference_authorization_id?: string;
+    amount_capturable?: number;
+    reversal_transaction_id?: string;
+    linked_invoices?: Transaction.LinkedInvoice[];
+    linked_credit_notes?: Transaction.LinkedCreditNote[];
+    linked_refunds?: Transaction.LinkedRefund[];
+    linked_payments?: Transaction.LinkedPayment[];
+    deleted: boolean;
+    iin?: string;
+    last4?: string;
+    merchant_reference_id?: string;
+    business_entity_id?: string;
+    payment_method_details?: string;
+    error_detail?: Transaction.GatewayErrorDetail;
+    custom_payment_method_name?: string;
   }
-  export namespace Transaction {
-    export class TransactionResource {  
-      /**
-        * @description Authorizes a specific amount in customer&#x27;s Credit card, which can be collected within a span of time. Read more on authorization and capture [here](https://www.chargebee.com/docs/stripe.html#auth-and-capture).
-
-        */
-      
-      create_authorization(input:CreateAuthorizationInputParam):ChargebeeRequest<CreateAuthorizationResponse>;
-       
-      /**
-        * @description This API voids the specific authorization transaction in order to release the blocked funds from the customer&#x27;s card. Voiding an already captured or voided transaction is not possible.
-
-        */
-      
-      void_transaction(transaction_id:string):ChargebeeRequest<VoidTransactionResponse>;
-       
-      /**
-        * @description Records a refund made offline. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;.
-
-        */
-      
-      record_refund(transaction_id:string, input:RecordRefundInputParam):ChargebeeRequest<RecordRefundResponse>;
-       
-      /**
-        * @description Refunds an online payment. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;. You can only refund a &#x60;transaction&#x60; whose [status](transactions#transaction_status)&#x60; &#x60; is &#x60;success&#x60;.
-
-        */
-      
-      refund(transaction_id:string, input?:RefundInputParam):ChargebeeRequest<RefundResponse>;
-       
-      /**
-        * @description Lists all the transactions.
 
-        */
-      
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
-       
-      /**
-        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
-
-        */
-      
-      payments_for_invoice(invoice_id:string, input?:PaymentsForInvoiceInputParam):ChargebeeRequest<PaymentsForInvoiceResponse>;
-       
-      /**
-        * @description Retrieve a transaction identified by its unique id.
-
-        */
-      
-      retrieve(transaction_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description This API deletes an offline transaction. However, to delete an offline transaction all payment allocations associated with the transaction must be removed.
-
-        */
-      
-      delete_offline_transaction(transaction_id:string, input?:DeleteOfflineTransactionInputParam):ChargebeeRequest<DeleteOfflineTransactionResponse>;
-      
-      reconcile(transaction_id:string, input?:ReconcileInputParam):ChargebeeRequest<ReconcileResponse>;
-    }
-    export interface CreateAuthorizationResponse {  
-       transaction:Transaction;
+  export namespace Transaction {
+    export class TransactionResource {
+      createAuthorization(
+        input: CreateAuthorizationInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateAuthorizationResponse>>;
+
+      voidTransaction(
+        transaction_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<VoidTransactionResponse>>;
+
+      recordRefund(
+        transaction_id: string,
+        input: RecordRefundInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RecordRefundResponse>>;
+
+      reconcile(
+        transaction_id: string,
+        input?: ReconcileInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReconcileResponse>>;
+
+      refund(
+        transaction_id: string,
+        input?: RefundInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RefundResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      transactionsForCustomer(
+        customer_id: string,
+        input?: TransactionsForCustomerInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<TransactionsForCustomerResponse>>;
+
+      transactionsForSubscription(
+        subscription_id: string,
+        input?: TransactionsForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<TransactionsForSubscriptionResponse>>;
+
+      paymentsForInvoice(
+        invoice_id: string,
+        input?: PaymentsForInvoiceInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PaymentsForInvoiceResponse>>;
+
+      retrieve(
+        transaction_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      deleteOfflineTransaction(
+        transaction_id: string,
+        input?: DeleteOfflineTransactionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteOfflineTransactionResponse>>;
     }
-    export interface CreateAuthorizationInputParam {
-       
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
-      customer_id:string;
-       
-      /**
-        * @description Payment source to be used for authorizing the transaction.
-
-        */
-       
-      payment_source_id?:string;
-       
-      /**
-        * @description The currency code (ISO 4217 format) of the transaction amount.
-
-        */
-       
-      currency_code?:string;
-       
-      /**
-        * @description The amount to be blocked.
 
-        */
-       
-      amount:number;
+    export interface CreateAuthorizationResponse {
+      transaction: Transaction;
     }
-    export interface VoidTransactionResponse {  
-       transaction:Transaction;
-    }
-    
-    export interface RecordRefundResponse {  
-       transaction:Transaction;
-    }
-    export interface RecordRefundInputParam {
-       
-      /**
-        * @description The amount to be recorded as refunded. Must not exceed [amount_unused](transactions#transaction_amount_unused). If not passed then all of [amount_unused](transactions#transaction_amount_unused) is recorded as refunded.
-
-        */
-       
-      amount?:number;
-       
-      /**
-        * @description The payment method used to make the refund. \* card - Card \* alipay - Alipay \* sofort - Sofort \* play_store - Play Store \* custom - Custom \* upi - upi \* ach_credit - ACH Credit \* amazon_payments - Amazon Payments \* apple_pay - Apple Pay \* ideal - IDEAL \* giropay - giropay \* boleto - boleto \* chargeback - Only applicable for a transaction of [type](transactions#transaction_type) &#x3D; &#x60;refund&#x60;. This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process) occurs. You can also set this explicitly when [recording a refund](transactions#record_an_offline_refund). \* wechat_pay - WeChat Pay \* sepa_credit - SEPA Credit \* google_pay - Google Pay \* cash - Cash \* netbanking_emandates - netbanking_emandates \* unionpay - Unionpay \* bancontact - Bancontact \* bank_transfer - Bank Transfer \* paypal_express_checkout - Paypal Express Checkout \* app_store - App Store \* check - Check \* direct_debit - Direct Debit \* dotpay - Dotpay \* other - Payment Methods other than the above types
 
-        */
-       
-      payment_method:PaymentMethod;
-       
-      /**
-        * @description The date when the refund was made.
-
-        */
-       
-      date:number;
-       
-      /**
-        * @description The reference number for this transaction. For example, the check number when &#x60;payment_method&#x60; &#x3D; &#x60;check&#x60;.
-
-        */
-       
-      reference_number?:string;
-       
-      /**
-        * @description Records a refund made offline. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;.
-
-        */
-       
-      custom_payment_method_id?:string;
-       
-      /**
-        * @description Remarks, if any, on the refund.
-
-        */
-       
-      comment?:string;
+    export interface VoidTransactionResponse {
+      transaction: Transaction;
     }
-    export interface RefundResponse {  
-       transaction:Transaction;
-    }
-    export interface RefundInputParam {
-       
-      /**
-        * @description The amount to be refunded. Must not exceed [amount_unused](transactions#transaction_amount_unused). If not passed then all of [amount_unused](transactions#transaction_amount_unused) is refunded.
 
-        */
-       
-      amount?:number;
-       
-      /**
-        * @description Remarks, if any, on the refund.
-
-        */
-       
-      comment?:string;
+    export interface RecordRefundResponse {
+      transaction: Transaction;
     }
-    export interface ListResponse {  
-      /**
-        * @description Lists all the transactions.
-
-        */
-       
-       list:{transaction:Transaction}[];
-       
-      /**
-        * @description Lists all the transactions.
 
-        */
-       
-       next_offset?:string;
+    export interface ReconcileResponse {
+      transaction: Transaction;
     }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      include_deleted?:boolean;
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'klarna_pay_now' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string};
-       
-      /**
-        * @description Lists all the transactions.
 
-        */
-        
-      gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',not_in?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      id_at_gateway?:{is?:string,is_not?:string,starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string};
-       
-      /**
-        * @description Lists all the transactions.
-
-        */
-        
-      date?:{after?:string,before?:string,between?:string,on?:string};
-       
-      /**
-        * @description Lists all the transactions.
+    export interface RefundResponse {
+      transaction: Transaction;
+    }
 
-        */
-        
-      amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
-       
-      /**
-        * @description Lists all the transactions.
+    export interface ListResponse {
+      list: { transaction: Transaction }[];
+      next_offset?: string;
+    }
 
-        */
-        
-      amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
-       
-      /**
-        * @description Lists all the transactions.
+    export interface TransactionsForCustomerResponse {
+      list: { transaction: Transaction }[];
+      next_offset?: string;
+    }
 
-        */
-        
-      status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string};
-       
-      /**
-        * @description Lists all the transactions.
+    export interface TransactionsForSubscriptionResponse {
+      list: { transaction: Transaction }[];
+      next_offset?: string;
+    }
 
-        */
-        
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
-       
-      /**
-        * @description Lists all the transactions.
+    export interface PaymentsForInvoiceResponse {
+      list: { transaction: Transaction }[];
+      next_offset?: string;
+    }
 
-        */
-        
-      sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
+    export interface RetrieveResponse {
+      transaction: Transaction;
     }
-    export interface PaymentsForInvoiceResponse {  
-      /**
-        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
 
-        */
-       
-       list:{transaction:Transaction}[];
-       
-      /**
-        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
+    export interface DeleteOfflineTransactionResponse {
+      transaction: Transaction;
+    }
 
-        */
-       
-       next_offset?:string;
+    export interface LinkedInvoice {
+      invoice_id: string;
+      applied_amount: number;
+      applied_at: number;
+      invoice_date?: number;
+      invoice_total?: number;
+      invoice_status:
+        | 'paid'
+        | 'posted'
+        | 'payment_due'
+        | 'not_paid'
+        | 'voided'
+        | 'pending';
     }
-    export interface ReconcileResponse {  
-      transaction:Transaction;
+    export interface LinkedCreditNote {
+      cn_id: string;
+      applied_amount: number;
+      applied_at: number;
+      cn_reason_code?:
+        | 'write_off'
+        | 'subscription_change'
+        | 'subscription_cancellation'
+        | 'subscription_pause'
+        | 'chargeback'
+        | 'product_unsatisfactory'
+        | 'service_unsatisfactory'
+        | 'order_change'
+        | 'order_cancellation'
+        | 'waiver'
+        | 'other'
+        | 'fraudulent';
+      cn_create_reason_code?: string;
+      cn_date?: number;
+      cn_total?: number;
+      cn_status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
+      cn_reference_invoice_id: string;
     }
-    export interface ReconcileInputParam {
-         
-      id_at_gateway?:string;
-       
-      customer_id?:string;
-       
-      status?:'success' | 'failure';
+    export interface LinkedRefund {
+      txn_id: string;
+      txn_status:
+        | 'in_progress'
+        | 'success'
+        | 'voided'
+        | 'failure'
+        | 'timeout'
+        | 'needs_attention';
+      txn_date: number;
+      txn_amount: number;
     }
-    export interface PaymentsForInvoiceInputParam {
-      [key : string]: any;  
-      /**
-        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \&amp; automatic) made for this invoice.
+    export interface LinkedPayment {
+      id: string;
+      status?:
+        | 'in_progress'
+        | 'success'
+        | 'voided'
+        | 'failure'
+        | 'timeout'
+        | 'needs_attention';
+      amount?: number;
+      date?: number;
+    }
+    export interface GatewayErrorDetail {
+      request_id?: string;
+      error_category?: string;
+      error_code?: string;
+      error_message?: string;
+      decline_code?: string;
+      decline_message?: string;
+      network_error_code?: string;
+      network_error_message?: string;
+      error_field?: string;
+      recommendation_code?: string;
+      recommendation_message?: string;
+      processor_error_code?: string;
+      processor_error_message?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
 
-        */
-        
-      offset?:string;
+    export interface CreateAuthorizationInputParam {
+      customer_id: string;
+      payment_source_id?: string;
+      currency_code?: string;
+      amount: number;
     }
-    export interface RetrieveResponse {  
-       transaction:Transaction;
+    export interface RecordRefundInputParam {
+      amount?: number;
+      payment_method: PaymentMethod;
+      date: number;
+      reference_number?: string;
+      custom_payment_method_id?: string;
+      comment?: string;
     }
-    
-    export interface DeleteOfflineTransactionResponse {  
-       transaction:Transaction;
+    export interface ReconcileInputParam {
+      id_at_gateway?: string;
+      customer_id?: string;
+      status?: 'success' | 'failure';
     }
-    export interface DeleteOfflineTransactionInputParam {
-       
-      /**
-        * @description Reason for deleting this transaction. This comment will be added to the associated entity.
-
-        */
-       
-      comment?:string;
+    export interface RefundInputParam {
+      amount?: number;
+      comment?: string;
     }
-    export interface InvoiceTransaction {  
-         /**
-          * @description Identifier for the invoice.
-
-          */
-       
-      invoice_id:string;
-       
-         /**
-          * @description The transaction amount applied to this invoice
-
-          */
-       
-      applied_amount:number;
-       
-         /**
-          * @description Timestamp at which the transaction is applied.
-
-          */
-       
-      applied_at:number;
-       
-         /**
-          * @description The date this invoice is issued.
-
-          */
-       
-      invoice_date?:number;
-       
-         /**
-          * @description Total amount of the invoice
-
-          */
-       
-      invoice_total?:number;
-       
-         /**
-          * @description Current status of this invoice. \* pending -  
-The [invoice](/docs/api/invoices?prod_cat_ver&#x3D;2#invoice_status) is yet to be closed (sent for payment collection). An invoice is generated with this &#x60;status&#x60; when it has line items that belong to items that are &#x60;metered&#x60; or when the &#x60;subscription.create_pending_invoices&#x60;attribute is set to &#x60;true&#x60;.  
-The [invoice](/docs/api/invoices?prod_cat_ver&#x3D;1#invoice_status) is yet to be closed (sent for payment collection). All invoices are generated with this &#x60;status&#x60; when [Metered Billing](https://www.chargebee.com/docs/1.0/metered_billing.html) is enabled for the site. \* voided - Indicates a voided invoice. \* payment_due - Indicates the payment is not yet collected and is being retried as per retry settings. \* paid - Indicates a paid invoice. \* posted - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period \* not_paid - Indicates the payment is not made and all attempts to collect is failed.
-
-          */
-       
-      invoice_status:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due';
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      include_deleted?: boolean;
+      id?: filter.String;
+      customer_id?: filter.String;
+      subscription_id?: filter.String;
+      payment_source_id?: filter.String;
+      payment_method?: filter.Enum;
+      gateway?: filter.Enum;
+      gateway_account_id?: filter.String;
+      id_at_gateway?: filter.String;
+      reference_number?: filter.String;
+      type?: filter.Enum;
+      date?: filter.Timestamp;
+      amount?: filter.Number;
+      amount_capturable?: filter.Number;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
     }
-    export interface CreditNoteTransaction {  
-         /**
-          * @description Identifier for the credit-notes.
-
-          */
-       
-      cn_id:string;
-       
-         /**
-          * @description The transaction amount applied to this invoice
-
-          */
-       
-      applied_amount:number;
-       
-         /**
-          * @description Timestamp at which the transaction is applied.
-
-          */
-       
-      applied_at:number;
-       
-         /**
-          * @description Credit note reason code. Deprecated use the cn_create_reason_code parameter instead \* service_unsatisfactory - Service Unsatisfactory \* other - Can be set when none of the above reason codes are applicable \* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation \* fraudulent - FRAUDULENT \* order_change - Order Change \* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* write_off - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* subscription_change - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* chargeback - Can be set when you are recording your customer Chargebacks \* waiver - Waiver \* order_cancellation - Order Cancellation \* product_unsatisfactory - Product Unsatisfactory
-
-          */
-       
-      cn_reason_code?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent';
-       
-         /**
-          * @description Credit note reason code
-
-          */
-       
-      cn_create_reason_code?:string;
-       
-         /**
-          * @description The date this credit note is created.
-
-          */
-       
-      cn_date?:number;
-       
-         /**
-          * @description Total amount of the credit note
-
-          */
-       
-      cn_total?:number;
-       
-         /**
-          * @description The status of this Credit Note. \* voided - When the Credit Note has been cancelled. \* refund_due - When the credits are yet to be used, or have been partially used. \* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* adjusted - When the Credit Note has been adjusted against an invoice.
-
-          */
-       
-      cn_status:'refund_due' | 'adjusted' | 'refunded' | 'voided';
-       
-         /**
-          * @description The invoice number. Acts as a identifier for invoice and typically generated sequentially.
-
-          */
-       
-      cn_reference_invoice_id:string;
+    export interface TransactionsForCustomerInputParam {
+      limit?: number;
+      offset?: string;
     }
-    export interface TxnRefundsAndReversal {  
-         /**
-          * @description Uniquely identifies the transaction.
-
-          */
-       
-      txn_id:string;
-       
-         /**
-          * @description The status of this transaction. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* voided - The transaction got voided or authorization expired at gateway. \* timeout - Transaction failed because of Gateway not accepting the connection. \* success - The transaction is successful. \* failure - Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
-
-          */
-       
-      txn_status:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
-       
-         /**
-          * @description Indicates when this refund occured.
-
-          */
-       
-      txn_date:number;
-       
-         /**
-          * @description Amount of this refund transaction.
-
-          */
-       
-      txn_amount:number;
+    export interface TransactionsForSubscriptionInputParam {
+      limit?: number;
+      offset?: string;
     }
-    export interface LinkedPayment {  
-         /**
-          * @description Uniquely identifies the transaction.
-
-          */
-       
-      id:string;
-       
-         /**
-          * @description The status of this transaction. \* needs_attention - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \* success - The transaction is successful. \* voided - The transaction got voided or authorization expired at gateway. \* in_progress - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \* failure - Transaction failed. Refer the &#x27;error_code&#x27; and &#x27;error_text&#x27; fields to know the reason for failure \* timeout - Transaction failed because of Gateway not accepting the connection.
-
-          */
-       
-      status?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention';
-       
-         /**
-          * @description Amount for this transaction.
-
-          */
-       
-      amount?:number;
-       
-         /**
-          * @description Indicates when this transaction occurred.
-
-          */
-       
-      date?:number;
+    export interface PaymentsForInvoiceInputParam {
+      limit?: number;
+      offset?: string;
     }
-    export interface GatewayErrorDetail {  
-         /**
-          * @description This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway
-
-          */
-       
-      request_id?:string;
-       
-         /**
-          * @description This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more
-
-          */
-       
-      error_category?:string;
-       
-         /**
-          * @description A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway&#x27;s services
-
-          */
-       
-      error_code?:string;
-       
-         /**
-          * @description A message provided by the gateway that describes the nature of the error encountered
-
-          */
-       
-      error_message?:string;
-       
-         /**
-          * @description When a transaction is declined, this code is provided by the gateway to specify the reason for the decline
-
-          */
-       
-      decline_code?:string;
-       
-         /**
-          * @description This message gives a descriptive explanation of the reason for the transaction&#x27;s decline
-
-          */
-       
-      decline_message?:string;
-       
-         /**
-          * @description This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network&#x27;s error-handling system
-
-          */
-       
-      network_error_code?:string;
-       
-         /**
-          * @description This the network related error message from the gateway, this is a detailed message provided by the payment network explaining the nature of the network error encountered
-
-          */
-       
-      network_error_message?:string;
-       
-         /**
-          * @description This parameter indicates which specific data field or attribute in the request caused the error
-
-          */
-       
-      error_field?:string;
-       
-         /**
-          * @description After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue
-
-          */
-       
-      recommendation_code?:string;
-       
-         /**
-          * @description This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue
-
-          */
-       
-      recommendation_message?:string;
-       
-         /**
-          * @description This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process
-
-          */
-       
-      processor_error_code?:string;
-       
-         /**
-          * @description This message describes the specific error that the payment processor encountered
-
-          */
-       
-      processor_error_message?:string;
+    export interface DeleteOfflineTransactionInputParam {
+      comment?: string;
     }
   }
-}
+}