chargebee 2.26.1 → 2.28.0

package/types/resources/TimeMachine.d.ts

@@ -78,20 +78,10 @@ declare module 'chargebee' {
       start_afresh(time_machine_name:string, input?:StartAfreshInputParam):ChargebeeRequest<StartAfreshResponse>;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves the time machine. Currently only one time machine is available per site and is named &#x27;delorean&#x27;.
-
-        */
-       
        time_machine:TimeMachine;
     }
     
     export interface TravelForwardResponse {  
-      /**
-        * @description Travel forward in time. This operation is **asynchronous** . You need to check if the &quot;start afresh&quot; operation has completed by checking if the time travel status is **successful** by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. Use method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes.
-
-        */
-       
        time_machine:TimeMachine;
     }
     export interface TravelForwardInputParam {
@@ -104,13 +94,6 @@ declare module 'chargebee' {
       destination_time?:number;
     }
     export interface StartAfreshResponse {  
-      /**
-        * @description Restart the time machine. This will clear the &quot;customer&quot; data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.
-
-**Note:** This API call is asynchronous. You need to check if the &quot;start afresh&quot; operation has completed by checking if the time travel status is **successful** by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for time travel completion** function provided as a instance method in the library. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **WaitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes.
-
-        */
-       
        time_machine:TimeMachine;
     }
     export interface StartAfreshInputParam {

package/types/resources/Token.d.ts

@@ -110,11 +110,6 @@ declare module 'chargebee' {
       retrieve(cb_token_id:string):ChargebeeRequest<RetrieveResponse>;
     }
     export interface CreateUsingTempTokenResponse {  
-      /**
-        * @description Generate a token using the one time token created by payment gateways for any specific payment method.
-
-        */
-       
        token:Token;
     }
     export interface CreateUsingTempTokenInputParam {
@@ -190,11 +185,6 @@ declare module 'chargebee' {
       token_billing_address?:{city?:string,country_code?:string,line1?:string,line2?:string,state?:string,state_code?:string,zip?:string};
     }
     export interface CreateForCardResponse {  
-      /**
-        * @description Generate a token that holds card related information.
-
-        */
-       
        token:Token;
     }
     export interface CreateForCardInputParam {
@@ -207,11 +197,6 @@ declare module 'chargebee' {
       card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,card_type?:'discover' | 'bancontact' | 'other' | 'visa' | 'jcb' | 'diners_club' | 'mastercard' | 'not_applicable' | 'american_express',cvv?:string,expiry_month:number,expiry_year:number,first_name?:string,gateway_account_id?:string,last_name?:string,number:string};
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieve a token using token ID.
-
-        */
-       
        token:Token;
     }
     

package/types/resources/Transaction.d.ts

@@ -362,11 +362,6 @@ declare module 'chargebee' {
       refund(transaction_id:string, input?:RefundInputParam):ChargebeeRequest<RefundResponse>;
     }
     export interface RecordRefundResponse {  
-      /**
-        * @description Records a refund made offline. Applicable only for &#x60;transaction&#x60;s of [type](transactions#transaction_type) &#x3D; &#x60;payment&#x60;.
-
-        */
-       
        transaction:Transaction;
     }
     export interface RecordRefundInputParam {
@@ -557,20 +552,10 @@ declare module 'chargebee' {
       sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
     }
     export interface VoidTransactionResponse {  
-      /**
-        * @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.
-
-        */
-       
        transaction:Transaction;
     }
     
     export interface CreateAuthorizationResponse {  
-      /**
-        * @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).
-
-        */
-       
        transaction:Transaction;
     }
     export interface CreateAuthorizationInputParam {
@@ -604,11 +589,6 @@ declare module 'chargebee' {
       amount:number;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieve a transaction identified by its unique id.
-
-        */
-       
        transaction:Transaction;
     }
     
@@ -644,11 +624,6 @@ declare module 'chargebee' {
       offset?:string;
     }
     export interface DeleteOfflineTransactionResponse {  
-      /**
-        * @description This API deletes an offline transaction. However, to delete an offline transaction all payment allocations associated with the transaction must be removed.
-
-        */
-       
        transaction:Transaction;
     }
     export interface DeleteOfflineTransactionInputParam {
@@ -661,11 +636,6 @@ declare module 'chargebee' {
       comment?:string;
     }
     export interface RefundResponse {  
-      /**
-        * @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;.
-
-        */
-       
        transaction:Transaction;
     }
     export interface RefundInputParam {

package/types/resources/UnbilledCharge.d.ts

@@ -222,32 +222,10 @@ If consolidated invoicing is enabled and the parameter 'customer_id' i
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
     }
     export interface DeleteResponse {  
-      /**
-        * @description Use this API to delete an unbilled charge by specifying the id of the charge.
-
-        */
-       
        unbilled_charge:UnbilledCharge;
     }
     
     export interface InvoiceNowEstimateResponse {  
-      /**
-        * @description This is similar to the &quot;Create an invoice for unbilled charges&quot; API but no invoice will be created, only an estimate for this operation is created.
-
-In the estimate response,
-
-* **estimate.invoice_estimates** is an array of **estimate.invoice_estimate**. This has the details of the invoices that will be generated now.
-
-**Note:**
-
-* This API when invoked does not perform the actual operation. It just generates an estimate.
-* Both *subscription_id* and *customer_id* parameters should not be given at the same time.
-
-
-
-
-        */
-       
        estimate:Estimate;
     }
     export interface InvoiceNowEstimateInputParam {
@@ -267,25 +245,6 @@ In the estimate response,
       customer_id?:string;
     }
     export interface InvoiceUnbilledChargesResponse {  
-      /**
-        * @description Use this API to bill the [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). Available Credits and Excess Payments will automatically be applied while creating the invoice.
-
-If the *Auto Collection* is turned on for the particular customer, the invoice will be created in payment_due state and the payment collection will be scheduled immediately.
-
-During invoice creation, the PO number for the line items will be filled from the subscription&#x27;s current PO number, if available.
-
-If no recurring item is present in the created invoice, the invoice will be marked as recurring&#x3D;false.
-
-If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; is passed, multiple invoices can be created based on the following factors.
-
-* Currency
-* PO number if &#x27;Group by PO number&#x27; is enabled
-* Shipping address
-* Auto Collection
-* Payment method
-
-        */
-       
        invoices:Invoice[];
     }
     export interface InvoiceUnbilledChargesInputParam {
@@ -364,11 +323,6 @@ If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; i
       customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
     }
     export interface CreateResponse {  
-      /**
-        * @description This endpoint creates unbilled charges for a subscription.
-
-        */
-       
        unbilled_charges:UnbilledCharge[];
     }
     export interface CreateInputParam {

package/types/resources/Usage.d.ts

@@ -127,11 +127,6 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
       list(input:ListInputParam):ChargebeeRequest<ListResponse>;
     }
     export interface PdfResponse {  
-      /**
-        * @description Retrieves usages record for an invoice in PDF file format.
-
-        */
-       
        download:Download;
     }
     export interface PdfInputParam {
@@ -151,11 +146,6 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
       invoice?:{id:string};
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves a usage record of a specific subscription.
-
-        */
-       
        usage:Usage;
     }
     export interface RetrieveInputParam {
@@ -168,13 +158,6 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
       id:string;
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates a usage record for an item price in a subscription. The item price must belong to a [metered](/docs/api/items?prod_cat_ver&#x3D;2#item_metered) item.  
-**Max Usages**   
-The maximum number of usages that can be recorded for the entire lifetime of a subscription is 5000. [Contact Support](https://chargebee.freshdesk.com/support/home) if you want this limit to be increased for your site.
-
-        */
-       
        usage:Usage;
     }
     export interface CreateInputParam {
@@ -216,11 +199,6 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
       note?:string;
     }
     export interface DeleteResponse {  
-      /**
-        * @description Deletes a usage record. This operation cannot be invoked for a usage record that has been [invoiced](usages?prod_cat_ver&#x3D;2#invoicing_usages).
-
-        */
-       
        usage:Usage;
     }
     export interface DeleteInputParam {

package/types/resources/VirtualBankAccount.d.ts

@@ -152,20 +152,10 @@ declare module 'chargebee' {
       create_using_permanent_token(input:CreateUsingPermanentTokenInputParam):ChargebeeRequest<CreateUsingPermanentTokenResponse>;
     }
     export interface DeleteLocalResponse {  
-      /**
-        * @description Deletes virtual bank accounts from Chargebee. Payment method in the payment gateway, and Auto Collection settings in Chargebee are not affected.
-
-        */
-       
        virtual_bank_account:VirtualBankAccount;
     }
     
     export interface DeleteResponse {  
-      /**
-        * @description Deletes a virtual bank account. If there is no virtual bank account present in the gateway for the customer, this API will return successfully without throwing an error.
-
-        */
-       
        virtual_bank_account:VirtualBankAccount;
     }
     
@@ -222,18 +212,8 @@ declare module 'chargebee' {
       created_at?:{after?:string,before?:string,between?:string,on?:string};
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates a virtual bank account for a customer. Email address is mandatory for virtual bank account creation. All notifications related to this virtual bank account will be sent to the email address you specify.
-
-        */
-       
        virtual_bank_account:VirtualBankAccount;
        
-      /**
-        * @description Creates a virtual bank account for a customer. Email address is mandatory for virtual bank account creation. All notifications related to this virtual bank account will be sent to the email address you specify.
-
-        */
-       
        customer?:Customer;
     }
     export interface CreateInputParam {
@@ -260,27 +240,12 @@ declare module 'chargebee' {
       scheme?:'ach_credit' | 'sepa_credit';
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves the virtual bank account identified by the unique identifier.
-
-        */
-       
        virtual_bank_account:VirtualBankAccount;
     }
     
     export interface CreateUsingPermanentTokenResponse {  
-      /**
-        * @description Creates a virtual bank account using the identifier provided by the gateway.
-
-        */
-       
        virtual_bank_account:VirtualBankAccount;
        
-      /**
-        * @description Creates a virtual bank account using the identifier provided by the gateway.
-
-        */
-       
        customer?:Customer;
     }
     export interface CreateUsingPermanentTokenInputParam {