chargebee 2.27.0 → 2.29.0

package/types/resources/Comment.d.ts

@@ -10,7 +10,7 @@ declare module 'chargebee' {
     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
+      * @description Type of the entity this comment generated for \* item - Entity that represents item \* invoice - Invoice description \* product - Entity that represents product \* plan - Entity that represents a subscription plan \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* quote - Entity that represents a quote \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* variant - Entity that represents product variants \* business_entity - Entity that represents item of type business entity \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* addon - Entity that represents an addon \* credit_note - Credit note description
 
       */
     
@@ -38,7 +38,7 @@ declare module 'chargebee' {
     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
+      * @description Type of comment this is. \* system - Comment generated by Chargebee when any backend changes happen for an entity \* user - Comment generated by user either via API or Admin console.
 
       */
     
@@ -54,13 +54,11 @@ declare module 'chargebee' {
   export namespace Comment {
     export class CommentResource {  
       /**
-        * @description Delete a comment for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver=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 "System" comments cannot be deleted.
+        * @description Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
 
         */
       
-      delete(comment_id:string):ChargebeeRequest<DeleteResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
         * @description Retrieve a comment for an entity identified by comment ID.
@@ -79,16 +77,47 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
       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.
+        * @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.
 
         */
       
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      delete(comment_id:string):ChargebeeRequest<DeleteResponse>;
     }
-    export interface DeleteResponse {  
+    export interface CreateResponse {  
        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 \* variant - Entity that represents product variants \* invoice - Invoice description \* product - Entity that represents product \* 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;
+    }
     export interface RetrieveResponse {  
        comment:Comment;
     }
@@ -115,14 +144,18 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @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.
 
         */
         
       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.
+        * @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.
 
         */
         
@@ -147,7 +180,9 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
       entity_id?:string;
        
       /**
-        * @description The time at which this comment was created
+        * @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.
 
         */
         
@@ -162,39 +197,10 @@ 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 {  
+    export interface DeleteResponse {  
        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;
-    }
+    
     
   }
 }