chargebee 2.25.3 → 2.26.1

package/types/resources/Comment.d.ts

@@ -1,49 +1,215 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface Comment {
+    
+    /**
+      * @description Unique identifier for the comment.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description Type of the entity this comment generated for \* item - Entity that represents item \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* invoice - Invoice description \* business_entity - Entity that represents item of type business entity \* plan - Entity that represents a subscription plan \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* addon - Entity that represents an addon \* credit_note - Credit note description \* quote - Entity that represents a quote
+
+      */
+    
     entity_type:EntityType;
+    
+    /**
+      * @description The user who created the comment. If created via API, this contains the name given for the API key used.
+
+      */
+    
     added_by?:string;
+    
+    /**
+      * @description Actual notes for the comment.
+
+      */
+    
     notes:string;
+    
+    /**
+      * @description The time at which this comment was created
+
+      */
+    
     created_at:number;
+    
+    /**
+      * @description Type of comment this is. \* user - Comment generated by user either via API or Admin console. \* system - Comment generated by Chargebee when any backend changes happen for an entity
+
+      */
+    
     type:'system' | 'user';
+    
+    /**
+      * @description Unique identifier of the entity.
+
+      */
+    
     entity_id:string;
   }
   export namespace Comment {
-    export class CommentResource {
+    export class CommentResource {  
+      /**
+        * @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.
+
+        */
+      
       delete(comment_id:string):ChargebeeRequest<DeleteResponse>;
+       
+      /**
+        * @description Retrieve a comment for an entity identified by comment ID.
+
+        */
+      
       retrieve(comment_id:string):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
+
+        */
+      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
+      /**
+        * @description Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
+
+        */
+      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
     }
-    export interface DeleteResponse {
-      comment:Comment;
+    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 {
-      comment:Comment;
+    export interface RetrieveResponse {  
+      /**
+        * @description Retrieve a comment for an entity identified by comment ID.
+
+        */
+       
+       comment:Comment;
     }
     
-    export interface ListResponse {
-      list:{comment:Comment}[];
-      next_offset?:string;
+    export interface ListResponse {  
+      /**
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
+
+        */
+       
+       list:{comment:Comment}[];
+       
+      /**
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
+
+        */
+       
+       next_offset?:string;
     }
     export interface ListInputParam {
-      [key : string]: any;
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
       limit?:number;
+       
+      /**
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+
+        */
+        
       offset?:string;
+       
+      /**
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
+
+        */
+        
       entity_type?:'item' | 'product' | 'coupon' | 'addon' | 'item_price' | 'business_entity' | 'subscription' | 'item_family' | 'credit_note' | 'quote' | 'variant' | 'invoice' | 'plan' | 'transaction' | 'customer' | 'order';
+       
+      /**
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
+
+        */
+        
       entity_id?:string;
+       
+      /**
+        * @description The time at which this comment was created
+
+        */
+        
       created_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      /**
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
+
+        */
+        
       sort_by?:{asc?:'created_at',desc?:'created_at'};
     }
-    export interface CreateResponse {
-      comment:Comment;
+    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 {
+       
+      /**
+        * @description Type of the entity to create the comment for. \* item - Entity that represents item \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* invoice - Invoice description \* business_entity - Entity that represents item of type business entity \* plan - Entity that represents a subscription plan \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* addon - Entity that represents an addon \* credit_note - Credit note description \* quote - Entity that represents a quote
+
+        */
+       
       entity_type:EntityType;
+       
+      /**
+        * @description Unique identifier of the entity.
+
+        */
+       
       entity_id:string;
+       
+      /**
+        * @description Actual notes for the comment.
+
+        */
+       
       notes:string;
+       
+      /**
+        * @description The user who created the comment. If created via API, this contains the name given for the API key used.
+
+        */
+       
       added_by?:string;
     }
     

package/types/resources/Contact.d.ts

@@ -1,14 +1,68 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface Contact {
+    
+    /**
+      * @description Unique reference ID provided for the contact.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description First name of the contact.
+
+      */
+    
     first_name?:string;
+    
+    /**
+      * @description Last name of the contact.
+
+      */
+    
     last_name?:string;
+    
+    /**
+      * @description Email of the contact.
+
+      */
+    
     email:string;
+    
+    /**
+      * @description Phone number of the contact.
+
+      */
+    
     phone?:string;
+    
+    /**
+      * @description Label/Tag provided for contact.
+
+      */
+    
     label?:string;
+    
+    /**
+      * @description Contact enabled / disabled
+
+      */
+    
     enabled:boolean;
+    
+    /**
+      * @description Whether Account Emails option is enabled for the contact.
+
+      */
+    
     send_account_email:boolean;
+    
+    /**
+      * @description Whether Billing Emails option is enabled for the contact.
+
+      */
+    
     send_billing_email:boolean;
   }
 }

package/types/resources/ContractTerm.d.ts

@@ -1,17 +1,100 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface ContractTerm {
+    
+    /**
+      * @description Id that uniquely identifies the contract term in the site.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description Current status of contract \* active - An actively running contract term. \* cancelled - The contract term was ended because:
+
+* a change in the subscription caused a [subscription term reset](subscriptions#update_a_subscription_force_term_reset).
+* the subscription was cancelled due to non-payment.
+\* terminated - The contract term was terminated ahead of completion. \* completed - The contract term has run its full duration.
+
+      */
+    
     status:'active' | 'cancelled' | 'completed' | 'terminated';
+    
+    /**
+      * @description The start date of the contract term
+
+      */
+    
     contract_start:number;
+    
+    /**
+      * @description The end date of the contract term
+
+      */
+    
     contract_end:number;
+    
+    /**
+      * @description The number of billing cycles of the subscription that the contract term is for.
+
+      */
+    
     billing_cycle:number;
+    
+    /**
+      * @description Action to be taken when the contract term completes. \* renew -
+* Contract term completes and a new contract term is started for the number of billing cycles specified in [&#x60;contract_billing_cycle_on_renewal&#x60;](subscriptions#create_subscription_for_customer_contract_term_billing_cycle_on_renewal).
+* The &#x60;action_at_term_end&#x60; for the new contract term is set to &#x60;renew&#x60;.
+\* evergreen - Contract term completes and the subscription renews. \* renew_once - Used when you want to renew the contract term just once. Does the following:
+* Contract term completes and a new contract term is started for the number of billing cycles specified in [&#x60;contract_billing_cycle_on_renewal&#x60;](subscriptions#create_subscription_for_customer_contract_term_billing_cycle_on_renewal).
+* The &#x60;action_at_term_end&#x60; for the new contract term is set to &#x60;cancel&#x60;.
+\* cancel - Contract term completes and subscription is canceled.
+
+
+      */
+    
     action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
+    
+    /**
+      * @description The sum of the [totals](invoices#invoice_total) of all the invoices raised as part of the contract term. For &#x60;active&#x60; contract terms, this is a predicted value. The value depends on the [type of currency](./#handling_currency_units). If the subscription was [imported](#import_a_subscription) with the contract term, then this value includes the value passed for &#x60;total_amount_raised&#x60;.
+
+      */
+    
     total_contract_value:number;
+    
+    /**
+      * @description It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for &#x60;total_amount_raised_before_tax&#x60; is included in the calculation of the total contract value before tax. It&#x27;s important to note that this value excludes any applicable taxes.
+
+      */
+    
     total_contract_value_before_tax:number;
+    
+    /**
+      * @description The number of days before [&#x60;contract_end&#x60;](contract_terms#contract_term_contract_end), during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
+
+      */
+    
     cancellation_cutoff_period?:number;
+    
+    /**
+      * @description The date when the contract term was created.
+
+      */
+    
     created_at:number;
+    
+    /**
+      * @description The [Id](subscriptions#subscription_id) of the subscription that this contract term is for.
+
+      */
+    
     subscription_id:string;
+    
+    /**
+      * @description The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for &#x60;active&#x60; contract terms.
+
+      */
+    
     remaining_billing_cycles?:number;
   }
 }