chargebee 2.26.1 → 2.27.0

package/types/resources/Gift.d.ts

@@ -124,25 +124,10 @@ declare module 'chargebee' {
       claim(gift_id:string):ChargebeeRequest<ClaimResponse>;
     }
     export interface CreateForItemsResponse {  
-      /**
-        * @description Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
-
-        */
-       
        gift:Gift;
        
-      /**
-        * @description Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
-
-        */
-       
        subscription:Subscription;
        
-      /**
-        * @description Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
-
-        */
-       
        invoice?:Invoice;
     }
     export interface CreateForItemsInputParam {
@@ -218,34 +203,14 @@ declare module 'chargebee' {
       subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
     }
     export interface CancelResponse {  
-      /**
-        * @description This API allows to cancel gifts. Only gift in &#x27;scheduled&#x27; and &#x27;unclaimed&#x27; states can be cancelled.
-
-        */
-       
        gift:Gift;
        
-      /**
-        * @description This API allows to cancel gifts. Only gift in &#x27;scheduled&#x27; and &#x27;unclaimed&#x27; states can be cancelled.
-
-        */
-       
        subscription:Subscription;
     }
     
     export interface UpdateGiftResponse {  
-      /**
-        * @description Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled [status](https://apidocs.chargebee.com/docs/api/gifts#gift_status).
-
-        */
-       
        gift:Gift;
        
-      /**
-        * @description Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled [status](https://apidocs.chargebee.com/docs/api/gifts#gift_status).
-
-        */
-       
        subscription:Subscription;
     }
     export interface UpdateGiftInputParam {
@@ -317,34 +282,14 @@ declare module 'chargebee' {
       gifter?:{customer_id?:{is?:string,is_not?:string,starts_with?:string}};
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves a gift subscription. This API accepts the gift &#x27;id&#x27; and returns the gift along with the subscription.
-
-        */
-       
        gift:Gift;
        
-      /**
-        * @description Retrieves a gift subscription. This API accepts the gift &#x27;id&#x27; and returns the gift along with the subscription.
-
-        */
-       
        subscription:Subscription;
     }
     
     export interface ClaimResponse {  
-      /**
-        * @description Claiming a gift will move the status to &#x27;claimed&#x27;. Only gifts in &#x27;unclaimed&#x27; state can be claimed.
-
-        */
-       
        gift:Gift;
        
-      /**
-        * @description Claiming a gift will move the status to &#x27;claimed&#x27;. Only gifts in &#x27;unclaimed&#x27; state can be claimed.
-
-        */
-       
        subscription:Subscription;
     }
     

package/types/resources/HostedPage.d.ts

@@ -297,26 +297,6 @@ Customer locale is used to generate the PDF in the required language. If a custo
       manage_payment_sources(input?:ManagePaymentSourcesInputParam):ChargebeeRequest<ManagePaymentSourcesResponse>;
     }
     export interface CheckoutOneTimeForItemsResponse {  
-      /**
-        * @description Create a Chargebee hosted page to accept payment details from a customer and checkout [charge-items](./items?prod_cat_ver&#x3D;2) and [one-time charges](./invoices?prod_cat_ver&#x3D;2#create_invoice_for_items_and_one-time_charges).
-
-The following steps describe how best to use this API:
-
-1. Call this endpoint, providing [item prices](./item_prices?prod_cat_ver&#x3D;2), [charges](./items?prod_cat_ver&#x3D;2), [coupons](./coupons?prod_cat_ver&#x3D;2) and a host of other details such as billing and shipping addresses of the customer, to be prefilled on the checkout page.
-2. Send the customer to the Checkout &#x60;url&#x60; received in the response.
-3. Once they complete checkout, the set of charge-items and one-time charges are automatically invoiced against the respective &#x60;customer&#x60; record in Chargebee, and they are redirected to the &#x60;redirect_url&#x60; with the &#x60;id&#x60; and &#x60;state&#x60; attributes passed as query string parameters.
-4. [Retrieve the hosted page](./hosted_pages?prod_cat_ver&#x3D;2#retrieve_a_hosted_page) at this stage to get the invoice details.
-
-#### Customer resource lookup and creation {#customer_lookup1}
-
-When [customer[id]](/docs/api/hosted_pages#checkout_charge_items_and_one_time_charges_customer_id) is provided for this operation, it is looked up by Chargebee, and if found, the hosted_page is created for it. If not found, a new customer resource is created with the ID provided, and the hosted_page is created.
-
-##### Multiple business entities
-
-If multiple [business entities](/docs/api/advanced-features#mbe) are created for the site, the customer resource lookup and creation happen within the [context](/docs/api/advanced-features#mbe-context) of the business entity [specified](/docs/api/advanced-features#mbe-header-main) in this API call. If no business entity is specified, the customer resource lookup is performed within the [site context](/docs/api/advanced-features#mbe-context) , and if not found, the resource is created for the [default business entity](/docs/api/advanced-features#mbe-default-be) of the site.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface CheckoutOneTimeForItemsInputParam {
@@ -467,21 +447,6 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
       entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
     }
     export interface UpdatePaymentMethodResponse {  
-      /**
-        * @description **Note:** If you&#x27;re using [In-App Checkout](https://www.chargebee.com/docs/2.0/checkout.html), use [Manage Payment Sources API](/docs/api/hosted_pages#manage_payment_sources) to request your customers to update their payment method details or change their payment method.
-
-Using this API, you can request your customers to update their payment method details or change their payment method. This is used in scenarios like customers updating their payment methods before the end of trial or customers switching among payment methods.
-
-When this API is invoked, it returns a hosted page URL. When the customers are directed to this URL, they will be able to change/update their payment methods.
-
-Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments) that you offer your customers, they will find options to switch among the various methods of payment.
-**Note:**
-
-* If the card\[gateway\] parameter is passed, and the customer chooses Card as a payment method, then the card details are stored in the gateway which is passed. However, if the card\[gateway\] parameter is passed and the customer chooses PayPal Express Checkout/Amazon Payments as a payment method, the gateway passed will be ignored.
-* The option of embedding into an iframe is not supported for PayPal Express Checkout and Amazon Payments as customers are redirected to the respective website pages. Hence if you have PayPal Express Checkout/Amazon Payments configured and pass the parameter embed&#x3D;true, this will result in an unsuccessful API request. Also, if you have all the three payment methods (Card, Paypal Express Checkout and Amazon Payments) configured and pass the parameter embed&#x3D;true, the returned hosted page URL will show only Card Payment as a payment method.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface UpdatePaymentMethodInputParam {
@@ -544,11 +509,6 @@ Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments
       card?:{gateway_account_id?:string};
     }
     export interface ExtendSubscriptionResponse {  
-      /**
-        * @description This API generates a hosted page URL to extend the billing cycle of a subscription.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface ExtendSubscriptionInputParam {
@@ -575,11 +535,6 @@ Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments
       subscription?:{id:string};
     }
     export interface EventsResponse {  
-      /**
-        * @description Use this API to notify Chargebee about important events that occur on your web pages, such as subscription cancellations. An event contains data about affected resources and additional details such as when the change occurred.
-
-        */
-       
        success:boolean;
     }
     export interface EventsInputParam {
@@ -609,27 +564,6 @@ Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments
       event_data:object;
     }
     export interface CheckoutGiftForItemsResponse {  
-      /**
-        * @description Creates a hosted page for a customer (called the gifter) to gift a subscription to another customer (called the receiver).
-
-#### Gifter customer resource lookup and creation {#gifter_lookup}
-
-When [gifter[customer_id]](/docs/api/hosted_pages#checkout_gift_subscription_for_items_gifter_customer_id) is provided, it is looked up in Chargebee when the gifter completes the hosted page checkout. If not found, a new customer resource is created with this ID.
-
-##### Multiple business entities
-
-If multiple [business entities](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe) are created for the site, the lookup and creation of the gifter customer resource happen within the [context](/docs/api/advanced-features#mbe-context) of the business entity specified in this API call. If no business entity is [specified](/docs/api/advanced-features#mbe-header-main), the customer resource lookup is performed within the [site context](/docs/api/advanced-features#mbe-context), and if not found, the resource is created for the [default business entity](/docs/api/advanced-features#mbe-default-be) of the site.
-
-#### Gift receiver customer resource lookup and creation {#receiver_lookup}
-
-Once the gifter checks out using the hosted page returned by this endpoint, Chargebee checks if a customer resource with the receiver&#x27;s email address exists. The first such customer record is considered the receiver&#x27;s customer resource. A new customer resource is created for the receiver if none are found.
-
-##### Multiple business entities
-
-If multiple [business entities](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe) are created for the site, the lookup and creation of the gift receiver&#x27;s customer resource happen within the [context](/docs/api/advanced-features#mbe-context) of the business entity of the gifter
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface CheckoutGiftForItemsInputParam {
@@ -742,11 +676,6 @@ Gifter customer resource lookup and creation.
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
     }
     export interface ViewVoucherResponse {  
-      /**
-        * @description Creates a &#x60;hosted_page&#x60; resource of type, &#x60;view_voucher&#x60;. When your end customers choose the Boleto payment method, you can generate a voucher for their pending invoice. Using this API, you can create a voucher_detail hosted page for your customers and email them a link to this hosted page. Your customers can review the voucher details on the page by clicking the link in the email.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface ViewVoucherInputParam {
@@ -766,11 +695,6 @@ Gifter customer resource lookup and creation.
       customer?:{locale?:string};
     }
     export interface CollectNowResponse {  
-      /**
-        * @description This API generates a hosted page URL to collect due payments for the customer.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface CollectNowInputParam {
@@ -804,11 +728,6 @@ Gifter customer resource lookup and creation.
       card?:{gateway_account_id?:string};
     }
     export interface AcceptQuoteResponse {  
-      /**
-        * @description This API generates a hosted page URL for the customer to accept a quote. If the hosted page URL has expired, a new URL will be generated automatically.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface AcceptQuoteInputParam {
@@ -835,29 +754,6 @@ Gifter customer resource lookup and creation.
       quote?:{id:string};
     }
     export interface CheckoutNewForItemsResponse {  
-      /**
-        * @description Create a Chargebee hosted page to accept payment details from a customer and checkout a new subscription.
-
-The following steps describe how best to use this API:
-
-1. Call this endpoint, providing [item prices](./item_prices?prod_cat_ver&#x3D;2), [coupons](./coupons?prod_cat_ver&#x3D;2) and a host of other details such as billing and shipping addresses to be prefilled for the customer on the checkout page.
-2. Send the customer to the Checkout &#x60;url&#x60; received in the response.
-3. Once they complete checkout, a new subscription is automatically created and the customer is redirected to the &#x60;redirect_url&#x60; with the &#x60;id&#x60; and &#x60;state&#x60; attributes passed as query string parameters.  
-   Although the customer will be redirected to the &#x60;redirect_url&#x60; after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such as [subscription_created](./events#subscription_created) or [invoice_generated](./events#invoice_generated) to verify a successful checkout.
-4. [Retrieve the hosted page](./hosted_pages?prod_cat_ver&#x3D;2#retrieve_a_hosted_page) at this stage to get the subscription and invoice details.
-
-
-
-#### Customer resource lookup and creation {#customer_lookup2}
-
-When the [customer[id]](/docs/api/hosted_pages#create_checkout_for_a_new_subscription_customer_id) parameter is provided and if a customer resource with the ID is found to be already created in Chargebee, the subscription is created under that customer resource. If not found, then a new customer resource is created with the ID provided and the subscription is created under it.
-
-##### Multiple business entities
-
-If multiple [business entities](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe) are created for the site, the customer resource lookup and creation happen within the [context](/docs/api/advanced-features#mbe-context) of the business entity [specified](/docs/api/advanced-features#mbe-header-main) in this API call. If no business entity is specified, the customer resource lookup is performed within the [site context](/docs/api/advanced-features#mbe-context), and if not found, the resource is created for the [default business entity](/docs/api/advanced-features#mbe-default-be) of the site.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface CheckoutNewForItemsInputParam {
@@ -1029,11 +925,6 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
       entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
     }
     export interface ClaimGiftResponse {  
-      /**
-        * @description This API generates a hosted page URL to claim a gifted subscription.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface ClaimGiftInputParam {
@@ -1067,22 +958,6 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
       customer?:{locale?:string};
     }
     export interface CheckoutExistingForItemsResponse {  
-      /**
-        * @description Create a Chargebee hosted page to accept payment details from a customer and checkout to update the subscription.
-
-The following steps describe how best to use this API:
-
-1. Provide [item prices](./item_prices?prod_cat_ver&#x3D;2), [coupons](./coupons?prod_cat_ver&#x3D;2) and a host of other details such as billing and shipping addresses to be prefilled for the customer on the checkout page.
-2. Send the customer to the Checkout &#x60;url&#x60; received in the response. They can now add a payment method or use an existing one, to complete the checkout.
-3. The subscription is updated and the customer is redirected to the &#x60;redirect_url&#x60; with the &#x60;id&#x60; and &#x60;state&#x60; attributes passed as query string parameters.  
-   Although the customer will be redirected to the &#x60;redirect_url&#x60; after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such as [subscription_created](./events#subscription_created) or [invoice_generated](./events#invoice_generated) to verify a successful checkout.
-4. [Retrieve the hosted page](./hosted_pages?prod_cat_ver&#x3D;2#retrieve_a_hosted_page) at this stage to get the subscription and invoice details.
-
-
-
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface CheckoutExistingForItemsInputParam {
@@ -1276,12 +1151,6 @@ The following steps describe how best to use this API:
       entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
     }
     export interface PreCancelResponse {  
-      /**
-        * @description Creates a &#x60;hosted_page&#x60; resource of &#x60;type&#x60; &#x60;pre_cancel&#x60;. Route canceling users to this page to provide them a retention experience and start saving revenue.  
-The hosted page is created in accordance with the retention experience [configured in the Chargebee Retention app](https://help.brightback.com/article/239-steps-to-get-brightback-ready-to-launch-for-chargebee-billing-merchants), along with the data provided as input to this endpoint. Call the endpoint before your customer clicks the **Cancel** button, and when they do, route them to the [url](https://apidocs.chargebee.com/docs/api/hosted_pages#hosted_page_url) in the endpoint response.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface PreCancelInputParam {
@@ -1318,26 +1187,10 @@ Although only &#x60;pass_thru_content.custom&#x60; is sent to Chargebee Retentio
       subscription?:{id:string};
     }
     export interface AcknowledgeResponse {  
-      /**
-        * @description When a hosted page is successfully completed by the user and processed by Chargebee, its [&#x60;state&#x60;](hosted_pages#hosted_page_state) is automatically changed to &#x60;succeeded&#x60;. Acknowledging a hosted page confirms that you have moved the customer details from Chargebee into your system and are ready to fulfill it. This API is used to acknowledge the hosted page in &#x60;succeeded&#x60; state and change its state to &#x60;acknowledged&#x60;.  
-
-**Note:** The hosted page status must be succeeded for this API call to be allowed.
-
-        */
-       
        hosted_page:HostedPage;
     }
     
     export interface RetrieveAgreementPdfResponse {  
-      /**
-        * @description This is applicable only for Direct Debit via SEPA, Bacs, Bg Autogiro, BECS (for both Australia and New Zealand) and PAD. For Direct Debit, the customer needs to accept an agreement that allows the merchant to debit their bank account. This agreement PDF allows you to easily display scheme-rules compliant Direct Debit mandates to your customers.
-
-This API retrieves the redirect link to the corresponding agreement for customers. The agreement PDF can be your &quot;Thank You&quot; page or sent by email to customers. Communicating this PDF to your customers is mandatory.
-
-Customer locale is used to generate the PDF in the required language. If a customer language is not supported, the PDF is generated in English. Checkout the [list of languages](https://developer.gocardless.com/api-reference/#mandate-pdfs-create-a-mandate-pdf) supported by GoCardless.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface RetrieveAgreementPdfInputParam {
@@ -1350,29 +1203,10 @@ Customer locale is used to generate the PDF in the required language. If a custo
       payment_source_id:string;
     }
     export interface RetrieveResponse {  
-      /**
-        * @description When you retrieve a hosted page whose &#x60;status&#x60; is &#x60;successful&#x60;, the &#x60;content&#x60; attribute has the following objects based on the &#x60;type&#x60; of the hosted page.
-
-|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **&#x60;type&#x60; of hosted page** | **&#x60;content&#x60; attribute constituents**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| &#x60;checkout_new&#x60;            | * &#x60;customer&#x60;: the object representing the details of the [Customer](/docs/api/customers#customer_attributes) for whom the subscription was created. * &#x60;subscription&#x60;: the new Subscription object created. * &#x60;card&#x60;: the [Card](/docs/api/cards#card_attributes) object if the [payment method](/docs/api/customers#customer_payment_method) &#x60;type&#x60; used was &#x60;card&#x60;. * &#x60;invoice&#x60;: the Invoice object, if an invoice was generated.                                                                                                                                                            |
-| &#x60;checkout_existing&#x60;       | * &#x60;customer&#x60;: the object representing the details of the [Customer](/docs/api/customers#customer_attributes) whose subscription was changed. * &#x60;subscription&#x60;: the updated Subscription object created. * &#x60;card&#x60;: the [Card](/docs/api/cards#card_attributes) object if the [payment method](/docs/api/customers#customer_payment_method) &#x60;type&#x60; used was &#x60;card&#x60;. * &#x60;invoice&#x60;: the Invoice object, if an invoice was generated for the subscription change.                                                                                                                                   |
-| &#x60;update_payment_method&#x60;   | * &#x60;customer&#x60;: the object representing the details of the [Customer](/docs/api/customers#customer_attributes) whose subscription was changed. * &#x60;card&#x60;: the [Card](/docs/api/cards#card_attributes) object if the new [payment method](/docs/api/customers#customer_payment_method) added was of &#x60;type&#x60; &#x60;card&#x60;.                                                                                                                                                                                                                                                                                |
-| &#x60;pre_cancel&#x60;              | &#x60;retention&#x60;: Use the &#x60;bypass&#x60; flag in this object to route the cancellation flow to the merchants&#x27; portal or the Chargebee Retention. * If &#x60;bypass&#x60; flag is &#x60;true&#x60;, you should route the end-customers to your native cancellation flow. * If the &#x60;bypass&#x60; flag is &#x60;false&#x60;, you should route the end-customers to the hosted page URL. **Note:** Retention is currently in &#x60;beta&#x60;. To enable Retention, [Contact Support.](https://support.chargebee.com/support/home)                                                                                                                        |
-| &#x60;collect_now&#x60;             | * &#x60;transactions&#x60;: this object should contain a list of [transactions](/docs/api/transactions#transaction_attributes) triggered from the &#x60;collect_now&#x60; hosted page. Each transaction in the list should be represented as an array that includes relevant information about the transaction, such as transaction ID, customer ID, amount, currency, payment method, and any other relevant details. * &#x60;customer&#x60;: this object should contain the customer record associated with the transaction. The key, &#x60;customer_id&#x60; is used to link the transaction to the corresponding customer record. |
-
-
-        */
-       
        hosted_page:HostedPage;
     }
     
     export interface ManagePaymentSourcesResponse {  
-      /**
-        * @description This API generates a hosted page URL to add new or update existing payment sources for the customer.
-
-        */
-       
        hosted_page:HostedPage;
     }
     export interface ManagePaymentSourcesInputParam {