chargebee 2.26.1 → 2.28.0

package/types/resources/PortalSession.d.ts

@@ -137,11 +137,6 @@ If this API is called for a Portal Session that currently is in :
       retrieve(portal_session_id:string):ChargebeeRequest<RetrieveResponse>;
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates a portal session for a customer. The session resource in the response contains the access URL. Forward the customer to that access URL. If you would like to logout the customer later via API call, you need to store the id of the portal session resource returned by this API. While creating a session, you also need to pass the redirect URL to which your customers will be sent to upon logout from the portal UI.
-
-        */
-       
        portal_session:PortalSession;
     }
     export interface CreateInputParam {
@@ -170,18 +165,6 @@ If this API is called for a Portal Session that currently is in :
       customer?:{id:string};
     }
     export interface ActivateResponse {  
-      /**
-        * @description When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:
-
-* **auth_session_id** - this should be sent as part of the endpoint.
-* **auth_session_token** - this should be sent as value for the input parameter **token**.
-
-
-
-**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
-
-        */
-       
        portal_session:PortalSession;
     }
     export interface ActivateInputParam {
@@ -194,26 +177,10 @@ If this API is called for a Portal Session that currently is in :
       token:string;
     }
     export interface LogoutResponse {  
-      /**
-        * @description Logs out the portal session. Typically this should be called when customers logout of your application.
-
-If this API is called for a Portal Session that currently is in :
-
-* &quot;created&quot; status, the session status will be marked as &quot;logged_out&quot; and the access URL will become invalid.
-* &quot;logged_in&quot; status, the session status will be marked as &quot;logged_out&quot; and customer will not be able to use that session.
-* &quot;logged_out&quot; status, this will return normally without changing any attribute of this resource.
-
-        */
-       
        portal_session:PortalSession;
     }
     
     export interface RetrieveResponse {  
-      /**
-        * @description This API retrieves a portal session using &#x60;portal_session_id&#x60; as a path parameter.
-
-        */
-       
        portal_session:PortalSession;
     }
     

package/types/resources/PromotionalCredit.d.ts

@@ -132,11 +132,6 @@ For example, if a customer has credits of $10, if you pass the **amount** as $10
       add(input:AddInputParam):ChargebeeRequest<AddResponse>;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description This endpoint retrieves the promotional credit based on the promotional credit id
-
-        */
-       
        promotional_credit:PromotionalCredit;
     }
     
@@ -200,26 +195,8 @@ For example, if a customer has credits of $10, if you pass the **amount** as $10
       customer_id?:{is?:string,is_not?:string,starts_with?:string};
     }
     export interface DeductResponse {  
-      /**
-        * @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer&#x27;s credit balance would become $15.
-
-If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
-
-        */
-       
        customer:Customer;
        
-      /**
-        * @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer&#x27;s credit balance would become $15.
-
-If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
-
-        */
-       
        promotional_credit:PromotionalCredit;
     }
     export interface DeductInputParam {
@@ -274,22 +251,8 @@ If you do not pass any amount as the input parameter then, it will deduct the wh
       reference?:string;
     }
     export interface SetResponse {  
-      /**
-        * @description This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
-
-        */
-       
        customer:Customer;
        
-      /**
-        * @description This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
-
-        */
-       
        promotional_credit:PromotionalCredit;
     }
     export interface SetInputParam {
@@ -344,22 +307,8 @@ For example, if a customer has a credit balance of $10 and if you would like to
       reference?:string;
     }
     export interface AddResponse {  
-      /**
-        * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
-
-        */
-       
        customer:Customer;
        
-      /**
-        * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
-
-        */
-       
        promotional_credit:PromotionalCredit;
     }
     export interface AddInputParam {

package/types/resources/Purchase.d.ts

@@ -119,69 +119,6 @@ Discounts, both [manual discounts](discounts) and <coupons>, can be applie
       estimate(input?:EstimateInputParam):ChargebeeRequest<EstimateResponse>;
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates a &#x60;purchase&#x60; resource. A purchase can contain one or more of the following:
-
-* subscriptions (a [subscription](subscriptions) resource consists of item prices such that at least one of the item prices belongs to an [item](items) of &#x60;type&#x60; &#x60;plan&#x60;.)
-* group of one-time charges (aka [charge item prices](item_prices#types))
-
-When you call this API, the invoices for the subscription(s) and one-time charge(s) are created immediately and not left [unbilled](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items_invoice_immediately).  
-**Note**
-
-Providing &#x60;shipping_addresses[]&#x60; is required when the [Orders feature](https://www.chargebee.com/docs/2.0/orders.html#configuration_step-1-configure-site-wide-settings) has been enabled.
-
-### Specifying &#x60;purchase_item&#x60; groups {#groups}
-
-
-When creating a purchase, you must specify the *group* or &#x60;index&#x60; to which each item price belongs. You can do this by setting the &#x60;purchase_items[index]&#x60; for each item price. Item prices with the same &#x60;purchase_items[index]&#x60; belong to the same group.
-
-
-The grouping of item prices allows you to specify the &#x60;discounts[]&#x60; applicable for each group and indicate which item prices should be added to any subscriptions you want to create. Groups can be one of two types:
-
-* Subscription groups
-* One-time charge groups
-
-The following subsections describe the types of groups in detail.  
-**Note**
-
-You can specify up to 10 groups,
-
-* with a recommended subscription group of 5. To increase this limit to a maximum of 8, contact [Chargebee Support](https://support.chargebee.com).
-* with a maximum of 10 one-time charge groups by default.
-
-The total limit for group items for a single purchase is 60.
-
-#### Subscription groups {#subscription}
-
-To create a subscription, specify a *subscription group* . A subscription [group](#groups) is a group of item prices that contains exactly one item price of &#x60;type&#x60; &#x60;plan&#x60;. To create multiple subscriptions, provide multiple subscription groups.  
-**Note**
-
-A subscription group can have up to 20 non-plan item prices. To increase this limit to a maximum of 60, contact [Chargebee Support](https://support.chargebee.com).  
-
-#### Custom Fields {#custom-fields}
-
-Purchase API supports custom fields of Subscriptions, use the following format to specify custom fields in Purchase API: **&#x60;subscription_info[custom_field]&#x60;**.
-
-#### One-time charge groups {#one-time}
-
-A one-time charge [group](#groups) is a group of charge item prices (i.e. item prices belonging to items of &#x60;type&#x60; &#x60;charge&#x60;). Charge item prices can be added to subscription groups as well. The charges within and across each one-time group must be unique.  
-**Note**
-
-* A one-time charge group can have up to 20 item prices. To increase this limit to a maximum of 60, contact [Chargebee Support](https://support.chargebee.com).
-* A charge item price can only be added to a single one-time charge group. However, it can be part of multiple [subscription groups](#subscription).
-
-### Applying discounts {#discounts}
-
-Discounts, both [manual discounts](discounts) and &lt;coupons&gt;, can be applied to groups by specifying the &#x60;discounts[]&#x60; array. The following table describes the method of application based on whether &#x60;discounts[index][i]&#x60; is provided:
-
-|                      |                                                                                                                                                                **&#x60;discounts[index][i]&#x60; is provided**                                                                                                                                                                 |                                                                                     **&#x60;discounts[index][i]&#x60; is not provided**                                                                                      |
-|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Coupons**          | * The coupon is applied exclusively to the invoice for group &#x60;i&#x60;. * The coupon is applied exclusively to the invoice created immediately upon invoking this API. * If group &#x60;i&#x60; is a [subscription group](#subscription), then the coupon is applied to invoices for subscription renewals based on coupon attributes such as &#x60;duration_type&#x60; and &#x60;max_redemptions&#x60;. | * The coupon is applied to all the invoices immediately generated upon invoking this API. * The coupon is not applied to subsequent invoices, such as those generated upon subscription renewal.                   |
-| **Manual discounts** | * The manual discount is applied exclusively to the invoice for group &#x60;i&#x60;. * The manual discount is applied exclusively to the invoice created immediately upon invoking this API. * The manual discount is not applied to subsequent invoices, such as those generated upon subscription renewal.                                                                   | * The manual discount is applied to all the invoices immediately generated upon invoking this API. * The manual discount is not applied to subsequent invoices, such as those generated upon subscription renewal. |
-
-
-        */
-       
        purchase:Purchase;
     }
     export interface CreateInputParam {
@@ -236,11 +173,6 @@ Discounts, both [manual discounts](discounts) and &lt;coupons&gt;, can be applie
       subscription_info?:{billing_cycles?:number,index:number,meta_data?:object,subscription_id?:string}[];
     }
     export interface EstimateResponse {  
-      /**
-        * @description Returns an estimate for creating a &#x60;purchase&#x60; resource. The operation works exactly like [Create a purchase](purchases#create_a_purchase), except that only an [estimate](estimates) resource is returned without an actual &#x60;purchase&#x60; resource being created.
-
-        */
-       
        estimate:Estimate;
     }
     export interface EstimateInputParam {

package/types/resources/Quote.d.ts

@@ -374,18 +374,8 @@ Ireland** . The first two characters of the VAT number in such a case is `X
       delete(quote_id:string, input?:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
     }
     export interface CreateSubItemsForCustomerQuoteResponse {  
-      /**
-        * @description Create a quote for new subscription line items of a customer.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Create a quote for new subscription line items of a customer.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
     }
     export interface CreateSubItemsForCustomerQuoteInputParam {
@@ -489,41 +479,16 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves the quotes identified by the &#x27;number&#x27; specified in the url.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Retrieves the quotes identified by the &#x27;number&#x27; specified in the url.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
        
-      /**
-        * @description Retrieves the quotes identified by the &#x27;number&#x27; specified in the url.
-
-        */
-       
        quoted_charge?:QuotedCharge;
     }
     
     export interface EditCreateSubCustomerQuoteForItemsResponse {  
-      /**
-        * @description Changes the quote produced for creating a new subscription items
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Changes the quote produced for creating a new subscription items
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
     }
     export interface EditCreateSubCustomerQuoteForItemsInputParam {
@@ -620,25 +585,10 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface UpdateStatusResponse {  
-      /**
-        * @description Updates the status of the quote. Status can be updated to Accepted, Declined, and Closed.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Updates the status of the quote. Status can be updated to Accepted, Declined, and Closed.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
        
-      /**
-        * @description Updates the status of the quote. Status can be updated to Accepted, Declined, and Closed.
-
-        */
-       
        quoted_charge?:QuotedCharge;
     }
     export interface UpdateStatusInputParam {
@@ -658,18 +608,8 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       comment?:string;
     }
     export interface UpdateSubscriptionQuoteForItemsResponse {  
-      /**
-        * @description Create a quote for updating subscription line items.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Create a quote for updating subscription line items.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
     }
     export interface UpdateSubscriptionQuoteForItemsInputParam {
@@ -888,25 +828,10 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       offset?:string;
     }
     export interface ExtendExpiryDateResponse {  
-      /**
-        * @description Can be used to extend the expiry date of a quote.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Can be used to extend the expiry date of a quote.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
        
-      /**
-        * @description Can be used to extend the expiry date of a quote.
-
-        */
-       
        quoted_charge?:QuotedCharge;
     }
     export interface ExtendExpiryDateInputParam {
@@ -919,18 +844,8 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       valid_till:number;
     }
     export interface EditForChargeItemsAndChargesResponse {  
-      /**
-        * @description Changes the quote produced for adding one-time charges and charge items.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Changes the quote produced for adding one-time charges and charge items.
-
-        */
-       
        quoted_charge?:QuotedCharge;
     }
     export interface EditForChargeItemsAndChargesInputParam {
@@ -1013,18 +928,8 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
       discounts?:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
     }
     export interface EditUpdateSubscriptionQuoteForItemsResponse {  
-      /**
-        * @description Changes the quote produced for updating the subscription items.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Changes the quote produced for updating the subscription items.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
     }
     export interface EditUpdateSubscriptionQuoteForItemsInputParam {
@@ -1293,11 +1198,6 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
       sort_by?:{asc?:'date',desc?:'date'};
     }
     export interface PdfResponse {  
-      /**
-        * @description Retrieves the quote as a PDF. The returned URL is secure, allows download and expires in 60 minutes.
-
-        */
-       
        download:Download;
     }
     export interface PdfInputParam {
@@ -1317,60 +1217,20 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
       disposition_type?:DispositionType;
     }
     export interface ConvertResponse {  
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        quoted_charge?:QuotedCharge;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        customer:Customer;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        subscription?:Subscription;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        invoice?:Invoice;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        credit_note?:CreditNote;
        
-      /**
-        * @description This API is to convert a quote to an invoice.
-
-        */
-       
        unbilled_charges?:UnbilledCharge[];
     }
     export interface ConvertInputParam {
@@ -1425,18 +1285,8 @@ This parameter is passed only when there are metered items in the subscription o
       subscription?:{auto_close_invoices?:boolean,auto_collection?:AutoCollection,id?:string,po_number?:string};
     }
     export interface CreateForChargeItemsAndChargesResponse {  
-      /**
-        * @description Creates a quote using charge-items and one-time charges.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Creates a quote using charge-items and one-time charges.
-
-        */
-       
        quoted_charge?:QuotedCharge;
     }
     export interface CreateForChargeItemsAndChargesInputParam {
@@ -1533,25 +1383,10 @@ This parameter is passed only when there are metered items in the subscription o
       discounts?:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
     }
     export interface DeleteResponse {  
-      /**
-        * @description Delete a quote using this API.
-
-        */
-       
        quote:Quote;
        
-      /**
-        * @description Delete a quote using this API.
-
-        */
-       
        quoted_subscription?:QuotedSubscription;
        
-      /**
-        * @description Delete a quote using this API.
-
-        */
-       
        quoted_charge?:QuotedCharge;
     }
     export interface DeleteInputParam {

package/types/resources/ResourceMigration.d.ts

@@ -61,11 +61,6 @@ declare module 'chargebee' {
       retrieve_latest(input:RetrieveLatestInputParam):ChargebeeRequest<RetrieveLatestResponse>;
     }
     export interface RetrieveLatestResponse {  
-      /**
-        * @description Gets the last migration details.
-
-        */
-       
        resource_migration:ResourceMigration;
     }
     export interface RetrieveLatestInputParam {