chargebee 2.28.0 → 2.30.0

package/types/resources/CouponSet.d.ts

@@ -47,25 +47,25 @@ declare module 'chargebee' {
   export namespace CouponSet {
     export class CouponSetResource {  
       /**
-        * @description Use this API to get the list of all the coupon sets.
+        * @description Create a coupon set with a coupon code compatible to your product offers and promotional discounts
 
         */
       
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
-        * @description Create a coupon set with a coupon code compatible to your product offers and promotional discounts
+        * @description This API add coupon codes to an existing coupon set.
 
         */
       
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      add_coupon_codes(coupon_set_id:string, input?:AddCouponCodesInputParam):ChargebeeRequest<AddCouponCodesResponse>;
        
       /**
-        * @description Use this API to update a specific coupon set by updating its &#x60;name&#x60; and the &#x60;meta_data&#x60;.
+        * @description Use this API to get the list of all the coupon sets.
 
         */
       
-      update(coupon_set_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
       /**
         * @description Use this API to retrieve a specific coupon set.
@@ -75,11 +75,18 @@ declare module 'chargebee' {
       retrieve(coupon_set_id:string):ChargebeeRequest<RetrieveResponse>;
        
       /**
-        * @description This API add coupon codes to an existing coupon set.
+        * @description Use this API to update a specific coupon set by updating its &#x60;name&#x60; and the &#x60;meta_data&#x60;.
 
         */
       
-      add_coupon_codes(coupon_set_id:string, input?:AddCouponCodesInputParam):ChargebeeRequest<AddCouponCodesResponse>;
+      update(coupon_set_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+       
+      /**
+        * @description Use this endpoint to delete a specific coupon set
+
+        */
+      
+      delete(coupon_set_id:string):ChargebeeRequest<DeleteResponse>;
        
       /**
         * @description Use this API to delete all the unutilised coupon codes from a specific coupon set.
@@ -87,13 +94,53 @@ declare module 'chargebee' {
         */
       
       delete_unused_coupon_codes(coupon_set_id:string):ChargebeeRequest<DeleteUnusedCouponCodesResponse>;
+    }
+    export interface CreateResponse {  
+       coupon_set:CouponSet;
+    }
+    export interface CreateInputParam {
        
       /**
-        * @description Use this endpoint to delete a specific coupon set
+        * @description Coupon id linked to coupon set.
 
         */
-      
-      delete(coupon_set_id:string):ChargebeeRequest<DeleteResponse>;
+       
+      coupon_id:string;
+       
+      /**
+        * @description Name of the coupon set.
+
+        */
+       
+      name:string;
+       
+      /**
+        * @description Uniquely identifies a coupon_set.
+
+        */
+       
+      id:string;
+       
+      /**
+        * @description A collection of key-value pairs that provides extra information about the coupon set.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
+
+        */
+       
+      meta_data?:object;
+    }
+    export interface AddCouponCodesResponse {  
+       coupon_set:CouponSet;
+    }
+    export interface AddCouponCodesInputParam {
+       
+      /**
+        * @description You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.
+
+        */
+       
+      code?:string[];
     }
     export interface ListResponse {  
       /**
@@ -113,94 +160,65 @@ declare module 'chargebee' {
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       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 Use this API to get the list of all the coupon sets.
 
         */
         
       offset?:string;
        
       /**
-        * @description Uniquely identifies a coupon_set
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Name of the coupon set
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Coupon id linked to coupon set
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       coupon_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description No of coupon codes present in coupon set
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       total_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description No of redeemed codes
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       redeemed_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description No of archived codes
+        * @description Use this API to get the list of all the coupon sets.
 
         */
         
       archived_count?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
     }
-    export interface CreateResponse {  
+    export interface RetrieveResponse {  
        coupon_set:CouponSet;
     }
-    export interface CreateInputParam {
-       
-      /**
-        * @description Coupon id linked to coupon set.
-
-        */
-       
-      coupon_id:string;
-       
-      /**
-        * @description Name of the coupon set.
-
-        */
-       
-      name:string;
-       
-      /**
-        * @description Uniquely identifies a coupon_set.
-
-        */
-       
-      id:string;
-       
-      /**
-        * @description A set of key-value pairs stored as additional information for the coupon set. [Learn more](./#meta_data).
-
-        */
-       
-      meta_data?:object;
-    }
+    
     export interface UpdateResponse {  
        coupon_set:CouponSet;
     }
@@ -214,36 +232,22 @@ declare module 'chargebee' {
       name?:string;
        
       /**
-        * @description A set of key-value pairs stored as additional information for the coupon set. [Learn more](./#meta_data).
+        * @description A collection of key-value pairs that provides extra information about the coupon set.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
 
         */
        
       meta_data?:object;
     }
-    export interface RetrieveResponse {  
+    export interface DeleteResponse {  
        coupon_set:CouponSet;
     }
     
-    export interface AddCouponCodesResponse {  
-       coupon_set:CouponSet;
-    }
-    export interface AddCouponCodesInputParam {
-       
-      /**
-        * @description You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.
-
-        */
-       
-      code?:string[];
-    }
     export interface DeleteUnusedCouponCodesResponse {  
        coupon_set:CouponSet;
     }
     
-    export interface DeleteResponse {  
-       coupon_set:CouponSet;
-    }
-    
     
   }
 }