chargebee 2.26.1 → 2.27.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 * * *
 * Support Descriptions for the attributes and actions has been added.
 
+### v2.27.0 (2023-09-05)
+* * *
+
+#### New Resource:
+* CsvTaxRule has been added.
+
+#### New attributes:
+* direct_debit_scheme has been added to the PaymentSource#PaymentSourceBankAccount resource. 
+
+#### New Enum :
+* DirectDebitSchemeEnum has been added.
+* Tax1JurisTypeEnum has been added.
+* Tax2JurisTypeEnum has been added.
+* Tax3JurisTypeEnum has been added.
+* Tax4JurisTypeEnum has been added.
+
+#### New Input parameters:
+* avalara_tax_code, hsn_code, taxjar_product_code has been added to Invoice#AddChargeRequest. 
+
+
 ### v2.26.0 (2023-07-31)
 * * *
 

package/lib/chargebee.js

@@ -11,7 +11,7 @@ ChargeBee._env = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: 80000,
-    clientVersion: 'v2.26.1',
+    clientVersion: 'v2.27.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000

package/lib/resources/api_endpoints.js

@@ -2676,6 +2676,13 @@ var _endpoints = {
       "/payment_vouchers",
       true
     ]
-  ]
+  ],
+  "csv_tax_rule": [[
+    "create",
+    "POST",
+    "/csv_tax_rules",
+    null,
+    false
+  ]]
 };
 module.exports = _endpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.26.1",
+   "version":"2.27.0",
    "description":"A library for integrating with ChargeBee.",
    "keywords":[
       "payments",

package/types/resources/Address.d.ts

@@ -138,11 +138,6 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
       update(input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
-
-        */
-       
        address:Address;
     }
     export interface RetrieveInputParam {
@@ -162,11 +157,6 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
       label:string;
     }
     export interface UpdateResponse {  
-      /**
-        * @description Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
-
-        */
-       
        address:Address;
     }
     export interface UpdateInputParam {

package/types/resources/AttachedItem.d.ts

@@ -139,11 +139,6 @@ The value set explicitly for `billing_cycles` while [applying the addo
       delete(attached_item_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves details of an attached addon or a charge item.
-
-        */
-       
        attached_item:AttachedItem;
     }
     export interface RetrieveInputParam {
@@ -156,11 +151,6 @@ The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addo
       parent_item_id:string;
     }
     export interface UpdateResponse {  
-      /**
-        * @description Updates an attached addon or a charge item for a plan.
-
-        */
-       
        attached_item:AttachedItem;
     }
     export interface UpdateInputParam {
@@ -290,11 +280,6 @@ The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addo
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates an attached addon or a charge item for a plan.
-
-        */
-       
        attached_item:AttachedItem;
     }
     export interface CreateInputParam {
@@ -351,11 +336,6 @@ The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addo
       charge_once?:boolean;
     }
     export interface DeleteResponse {  
-      /**
-        * @description Deletes an attached addon or a charge item.
-
-        */
-       
        attached_item:AttachedItem;
     }
     export interface DeleteInputParam {

package/types/resources/Card.d.ts

@@ -288,18 +288,6 @@ Passing credit card details to this API involves PCI liability at your end as se
       update_card_for_customer(customer_id:string, input:UpdateCardForCustomerInputParam):ChargebeeRequest<UpdateCardForCustomerResponse>;
     }
     export interface CopyCardForCustomerResponse {  
-      /**
-        * @description #### deprecated
-
-The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Export payment source API](/docs/api/payment_sources#export_payment_source).
-
-Copies the customer&#x27;s card information to another payment gateway. This is useful if you want to port your customer&#x27;s card details to another gateway.
-
-**Limitation**   
-This request does not support copying of cards between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
-
-        */
-       
        third_party_payment_method:ThirdPartyPaymentMethod;
     }
     export interface CopyCardForCustomerInputParam {
@@ -312,45 +300,12 @@ This request does not support copying of cards between Braintree and Stripe paym
       gateway_account_id:string;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description #### Deprecated
-
-This operation is obsoleted by the [Retrieve a payment source API](/docs/api/payment_sources#retrieve_a_payment_source).
-
-Retrieves the credit card for the customer id.
-
-        */
-       
        card:Card;
     }
     
     export interface SwitchGatewayForCustomerResponse {  
-      /**
-        * @description #### Deprecated
-
-This request is obsoleted by the [Switch gateway account API](/docs/api/payment_sources#switch_gateway_account) for Payment Sources.
-
-Switches the gateway in which customer&#x27;s card information is stored. This is applicable only if the payment method is &#x60;card&#x60;.
-
-**Limitation**   
-This request does not support switching between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
-
-        */
-       
        customer:Customer;
        
-      /**
-        * @description #### Deprecated
-
-This request is obsoleted by the [Switch gateway account API](/docs/api/payment_sources#switch_gateway_account) for Payment Sources.
-
-Switches the gateway in which customer&#x27;s card information is stored. This is applicable only if the payment method is &#x60;card&#x60;.
-
-**Limitation**   
-This request does not support switching between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
-
-        */
-       
        card:Card;
     }
     export interface SwitchGatewayForCustomerInputParam {
@@ -363,77 +318,12 @@ This request does not support switching between Braintree and Stripe payment gat
       gateway_account_id:string;
     }
     export interface DeleteCardForCustomerResponse {  
-      /**
-        * @description #### deprecated
-
-The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Delete a payment source API](/docs/api/payment_sources#delete_a_payment_source).
-
-Deletes the card for a customer. Upon successful deletion the &#x60;auto_collection&#x60; attribute for the customer is set to &#x60;off&#x60; and a &#x60;card_deleted&#x60; event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.
-
-        */
-       
        customer:Customer;
     }
     
     export interface UpdateCardForCustomerResponse {  
-      /**
-        * @description #### Deprecated
-
-The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the [Cards APIs](/docs/api/cards). This operation is obsoleted by the following:
-
-* [Create using temporary token](/docs/api/payment_sources#create_using_temporary_token)
-* [Create using permanent token](/docs/api/payment_sources#create_using_permanent_token)
-* [Create a card payment source](/docs/api/payment_sources#create_a_card_payment_source)
-
-Adds or replaces card details of a customer. Updating card details replaces the present payment method.
-
-Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
-
-* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your card update form.
-* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your card update form.
-* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your card update form.
-* In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s [Client Side Encryption](https://docs.adyen.com/developers/features/client-side-encryption) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
-* You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html) based integration. Use our [Hosted Page - Update Card](/docs/api/hosted_pages#update_card) API to generate a &#x27;Update Card&#x27; Hosted Page link.
-
-
-
-**Legacy behavior:**
-
-* **For [sites](https://www.chargebee.com/docs/sites-intro.html) created before March 1st, 2014:** On making this request, the &#x60;billing_address&#x60; and &#x60;vat_number&#x60; of the customer are **deleted** and replaced by the values passed with this request. Ensure that you pass the [billing address parameters](/docs/api/subscriptions?prod_cat_ver&#x3D;1#create_a_subscription_card_billing_addr1) and the &#x60;vat_number&#x60; parameters each time you make this request, to avoid losing the same information at the customer-level.
-* **For [sites](https://www.chargebee.com/docs/sites-intro.html) created on or after March 1st, 2014:** This request does not alter the &#x60;billing_address&#x60; and &#x60;vat_number&#x60; of the customer.
-
-        */
-       
        customer:Customer;
        
-      /**
-        * @description #### Deprecated
-
-The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the [Cards APIs](/docs/api/cards). This operation is obsoleted by the following:
-
-* [Create using temporary token](/docs/api/payment_sources#create_using_temporary_token)
-* [Create using permanent token](/docs/api/payment_sources#create_using_permanent_token)
-* [Create a card payment source](/docs/api/payment_sources#create_a_card_payment_source)
-
-Adds or replaces card details of a customer. Updating card details replaces the present payment method.
-
-Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
-
-* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your card update form.
-* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your card update form.
-* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your card update form.
-* In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s [Client Side Encryption](https://docs.adyen.com/developers/features/client-side-encryption) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
-* You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html) based integration. Use our [Hosted Page - Update Card](/docs/api/hosted_pages#update_card) API to generate a &#x27;Update Card&#x27; Hosted Page link.
-
-
-
-**Legacy behavior:**
-
-* **For [sites](https://www.chargebee.com/docs/sites-intro.html) created before March 1st, 2014:** On making this request, the &#x60;billing_address&#x60; and &#x60;vat_number&#x60; of the customer are **deleted** and replaced by the values passed with this request. Ensure that you pass the [billing address parameters](/docs/api/subscriptions?prod_cat_ver&#x3D;1#create_a_subscription_card_billing_addr1) and the &#x60;vat_number&#x60; parameters each time you make this request, to avoid losing the same information at the customer-level.
-* **For [sites](https://www.chargebee.com/docs/sites-intro.html) created on or after March 1st, 2014:** This request does not alter the &#x60;billing_address&#x60; and &#x60;vat_number&#x60; of the customer.
-
-        */
-       
        card:Card;
     }
     export interface UpdateCardForCustomerInputParam {

package/types/resources/Comment.d.ts

@@ -86,22 +86,10 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
     }
     export interface DeleteResponse {  
-      /**
-        * @description Delete a comment for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#create_a_comment_entity_type) identified by comment ID.
-
-Only the comments that are added via Admin console and API can be deleted. Chargebee generated &quot;System&quot; comments cannot be deleted.
-
-        */
-       
        comment:Comment;
     }
     
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieve a comment for an entity identified by comment ID.
-
-        */
-       
        comment:Comment;
     }
     
@@ -175,11 +163,6 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
       sort_by?:{asc?:'created_at',desc?:'created_at'};
     }
     export interface CreateResponse {  
-      /**
-        * @description Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
-
-        */
-       
        comment:Comment;
     }
     export interface CreateInputParam {

package/types/resources/Coupon.d.ts

@@ -362,11 +362,6 @@ Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon
       plan?:{};
     }
     export interface UpdateForItemsResponse {  
-      /**
-        * @description This API updates a coupon that is created for a specific promotion or offers.
-
-        */
-       
        coupon:Coupon;
     }
     export interface UpdateForItemsInputParam {
@@ -517,36 +512,14 @@ If not specified, the coupon can be redeemed an indefinite number of times.
       coupon_constraints?:{entity_type:'customer',type:'max_redemptions' | 'unique_by',value?:string}[];
     }
     export interface UnarchiveResponse {  
-      /**
-        * @description This API unarchives a specific coupon using the coupon ID.
-
-        */
-       
        coupon:Coupon;
     }
     
     export interface DeleteResponse {  
-      /**
-        * @description If no Subscriptions/Invoices are linked to this Coupon, the Coupon will be deleted from your Chargebee site. This action cannot be undone.
-
-To ensure that existing Subscriptions/Invoices are not affected, Coupons associated with them will not be deleted, but moved to "Archived" state. Once a Coupon has been archived, it cannot be edited or used again unless [unarchived](coupons#unarchive_a_coupon). Unused Coupons codes are deleted.
-
-        */
-       
        coupon:Coupon;
     }
     
     export interface CopyResponse {  
-      /**
-        * @description Copies a coupon over from one site to another. Copying of [archived](./coupons?prod_cat_ver=2#coupon_status) coupons is not supported.
-
-The item prices that are linked to the coupon in the source site are also linked to the coupon in the destination site. However, this will only work if those item prices exist and with the same [ids](./item_prices?prod_cat_ver=2#item_price_id), in the destination site. Hence, it is recommended that the item prices be copied over before copying the coupons.
-
-The value for [redemptions](./coupons?prod_cat_ver=2#coupon_redemptions) is not copied. It is set to `0` for the newly created coupon. Hence, if such a coupon had `expired` in the source site due to `redemptions` having reached [max_redemptions](./coupons?prod_cat_ver=2#coupon_max_redemptions), it's [status](./coupons?prod_cat_ver=2#coupon_status) would be `active` in the destination site.
-
-
-        */
-       
        coupon:Coupon;
     }
     export interface CopyInputParam {
@@ -582,20 +555,10 @@ The value for [redemptions](./coupons?prod_cat_ver=2#coupon_redemptions) is
       for_site_merging?:boolean;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description This API retrieves a specific coupon using the coupon ID.
-
-        */
-       
        coupon:Coupon;
     }
     
     export interface CreateForItemsResponse {  
-      /**
-        * @description This API creates a new coupon for a specific promotion or offers.
-
-        */
-       
        coupon:Coupon;
     }
     export interface CreateForItemsInputParam {

package/types/resources/CouponCode.d.ts

@@ -54,20 +54,10 @@ declare module 'chargebee' {
       archive(coupon_code_code:string):ChargebeeRequest<ArchiveResponse>;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves a specific coupon code details.
-
-        */
-       
        coupon_code:CouponCode;
     }
     
     export interface ArchiveResponse {  
-      /**
-        * @description Archives a coupon code thereby making it inactive. The archived coupon code cannot be applied to any subscription.
-
-        */
-       
        coupon_code:CouponCode;
     }
     

package/types/resources/CouponSet.d.ts

@@ -169,11 +169,6 @@ declare module 'chargebee' {
       archived_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
     }
     export interface CreateResponse {  
-      /**
-        * @description Create a coupon set with a coupon code compatible to your product offers and promotional discounts
-
-        */
-       
        coupon_set:CouponSet;
     }
     export interface CreateInputParam {
@@ -207,11 +202,6 @@ declare module 'chargebee' {
       meta_data?:object;
     }
     export interface UpdateResponse {  
-      /**
-        * @description Use this API to update a specific coupon set by updating its `name` and the `meta_data`.
-
-        */
-       
        coupon_set:CouponSet;
     }
     export interface UpdateInputParam {
@@ -231,20 +221,10 @@ declare module 'chargebee' {
       meta_data?:object;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Use this API to retrieve a specific coupon set.
-
-        */
-       
        coupon_set:CouponSet;
     }
     
     export interface AddCouponCodesResponse {  
-      /**
-        * @description This API add coupon codes to an existing coupon set.
-
-        */
-       
        coupon_set:CouponSet;
     }
     export interface AddCouponCodesInputParam {
@@ -257,20 +237,10 @@ declare module 'chargebee' {
       code?:string[];
     }
     export interface DeleteUnusedCouponCodesResponse {  
-      /**
-        * @description Use this API to delete all the unutilised coupon codes from a specific coupon set.
-
-        */
-       
        coupon_set:CouponSet;
     }
     
     export interface DeleteResponse {  
-      /**
-        * @description Use this endpoint to delete a specific coupon set
-
-        */
-       
        coupon_set:CouponSet;
     }
     

package/types/resources/CreditNote.d.ts

@@ -444,13 +444,6 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
       send_einvoice(credit_note_id:string):ChargebeeRequest<SendEinvoiceResponse>;
     }
     export interface VoidCreditNoteResponse {  
-      /**
-        * @description Use this API to [void a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A voided credit is a null entity and cannot be used again. A credit note which has already been voided or refunded cannot be voided. An error message will be displayed when you render such credit notes void.
-
-**Note:** When adjustment credit notes are voided, the associated invoice will reflect as NOT PAID, and the amount in the invoice will be recalculated to reflect the amount after considering the voided credit note.
-
-        */
-       
        credit_note:CreditNote;
     }
     export interface VoidCreditNoteInputParam {
@@ -463,18 +456,8 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
       comment?:string;
     }
     export interface RefundResponse {  
-      /**
-        * @description Refunds a ([refundable](https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note)) credit note to the [payment source](/docs/api/payment_sources) associated with the [transaction](/docs/api/transactions). Any [linked_tax_withheld_refunds](/docs/api/credit_notes#credit_note_linked_tax_withheld_refunds) recorded against the credit note are not refunded.
-
-        */
-       
        credit_note:CreditNote;
        
-      /**
-        * @description Refunds a ([refundable](https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note)) credit note to the [payment source](/docs/api/payment_sources) associated with the [transaction](/docs/api/transactions). Any [linked_tax_withheld_refunds](/docs/api/credit_notes#credit_note_linked_tax_withheld_refunds) recorded against the credit note are not refunded.
-
-        */
-       
        transaction:Transaction;
     }
     export interface RefundInputParam {
@@ -673,24 +656,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
       einvoice?:{status?:{in?:string,is?:'in_progress' | 'scheduled' | 'success' | 'registered' | 'failed' | 'skipped',is_not?:'in_progress' | 'scheduled' | 'success' | 'registered' | 'failed' | 'skipped',not_in?:string}};
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates a &#x60;credit_note&#x60; for the specified invoice.  
-**Note:**
-
-If the &#x60;credit_note&#x60; [type](/docs/api/credit_notes#create_credit_note_type) is &#x60;refundable&#x60;, then &#x60;linked_taxes_withheld.amount&#x60; for the [invoice specified](/docs/api/credit_notes#create_credit_note_reference_invoice_id) can also be included in the [total](/docs/api/credit_notes#create_credit_note_total).
-
-        */
-       
        credit_note:CreditNote;
        
-      /**
-        * @description Creates a &#x60;credit_note&#x60; for the specified invoice.  
-**Note:**
-
-If the &#x60;credit_note&#x60; [type](/docs/api/credit_notes#create_credit_note_type) is &#x60;refundable&#x60;, then &#x60;linked_taxes_withheld.amount&#x60; for the [invoice specified](/docs/api/credit_notes#create_credit_note_reference_invoice_id) can also be included in the [total](/docs/api/credit_notes#create_credit_note_total).
-
-        */
-       
        invoice:Invoice;
     }
     export interface CreateInputParam {
@@ -759,18 +726,8 @@ If the &#x60;credit_note&#x60; [type](/docs/api/credit_notes#create_credit_note_
       line_items?:{amount?:number,date_from?:number,date_to?:number,description?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
     }
     export interface RecordRefundResponse {  
-      /**
-        * @description Refunds a ([refundable](https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note)) credit note. The refund is provided against &#x60;linked_payments&#x60; first and then against any &#x60;linked_taxes_withheld&#x60; for the [invoice](/docs/api/credit_notes#credit_note_reference_invoice_id) associated with the &#x60;credit_note&#x60;. For payments made via online transactions, the refund request is processed via the [payment source](/docs/api/payment_sources) associated with the [transaction](/docs/api/transactions).
-
-        */
-       
        credit_note:CreditNote;
        
-      /**
-        * @description Refunds a ([refundable](https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note)) credit note. The refund is provided against &#x60;linked_payments&#x60; first and then against any &#x60;linked_taxes_withheld&#x60; for the [invoice](/docs/api/credit_notes#credit_note_reference_invoice_id) associated with the &#x60;credit_note&#x60;. For payments made via online transactions, the refund request is processed via the [payment source](/docs/api/payment_sources) associated with the [transaction](/docs/api/transactions).
-
-        */
-       
        transaction?:Transaction;
     }
     export interface RecordRefundInputParam {
@@ -797,11 +754,6 @@ If the &#x60;credit_note&#x60; [type](/docs/api/credit_notes#create_credit_note_
       transaction?:{amount?:number,date:number,payment_method:PaymentMethod,reference_number?:string};
     }
     export interface ImportCreditNoteResponse {  
-      /**
-        * @description Use this api to import credit notes into your Chargebee site. Billing address, Shipping Address, Vat number will be copied from the reference invoice.
-
-        */
-       
        credit_note:CreditNote;
     }
     export interface ImportCreditNoteInputParam {
@@ -966,11 +918,6 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       linked_refunds?:{amount:number,date:number,payment_method:PaymentMethod,reference_number?:string}[];
     }
     export interface DeleteResponse {  
-      /**
-        * @description This API [deletes a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A credit note once deleted, is deleted permanently. You cannot delete a credit which has already been deleted or refunded. If you try to delete a refunded or deleted credit note, an error message will be displayed.
-
-        */
-       
        credit_note:CreditNote;
     }
     export interface DeleteInputParam {
@@ -983,24 +930,10 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       comment?:string;
     }
     export interface DownloadEinvoiceResponse {  
-      /**
-        * @description Download the e-invoice for the credit note in both XML and PDF formats. The response consists of a &#x60;download&#x60; object for each format. The XML format follows the [structure as per Peppol BIS Billing v3.0](https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/tree/).  
-**Note**
-
-* You can only download e-invoices when their &#x60;status&#x60; is &#x60;success&#x60; or &#x60;registered&#x60;.
-* There are some cases in which the PDF is not available for download. In such cases, you can obtain it from the XML by decoding the value for [cbc:EmbeddedDocumentBinaryObject](https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AdditionalDocumentReference/cac-Attachment/cbc-EmbeddedDocumentBinaryObject/), which is the Base64-encoded version of the PDF.
-
-        */
-       
        downloads:Download[];
     }
     
     export interface PdfResponse {  
-      /**
-        * @description Gets the credit note as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.
-
-        */
-       
        download:Download;
     }
     export interface PdfInputParam {
@@ -1013,20 +946,10 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       disposition_type?:DispositionType;
     }
     export interface ResendEinvoiceResponse {  
-      /**
-        * @description Resend failed einvoice in credit notes.
-
-        */
-       
        credit_note:CreditNote;
     }
     
     export interface RemoveTaxWithheldRefundResponse {  
-      /**
-        * @description Removes a [linked_tax_withheld_refunds](/docs/api/credit_notes#credit_note_linked_tax_withheld_refunds) record from the &#x60;credit_note&#x60;.
-
-        */
-       
        credit_note:CreditNote;
     }
     export interface RemoveTaxWithheldRefundInputParam {
@@ -1039,35 +962,10 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       tax_withheld?:{id:string};
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves the Credit Note identified by the specified Credit Note number.
-
-        */
-       
        credit_note:CreditNote;
     }
     
     export interface SendEinvoiceResponse {  
-      /**
-        * @description This endpoint is used to send an e-invoice for invoice.
-
-To support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.
-
-This endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:
-
-* If e-invoicing is not enabled at the site and customer level.
-
-* If there is an e-invoice generated already for the invoice.
-
-* If the &quot;**Use automatic e-invoicing**&quot; option is selected.
-
-* If there are no generated e-invoices with the &#x60;failed&#x60; or &#x60;skipped&#x60; status.
-
-* If the invoice status is &#x60;voided&#x60; or &#x60;pending&#x60;.
-
-
-        */
-       
        credit_note:CreditNote;
     }