chargebee 2.40.0 → 3.0.0-beta.1

package/types/resources/CouponCode.d.ts

@@ -1,66 +1,70 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface CouponCode {
-    
-    /**
-      * @description Unique coupon code that can be redeemed only once.
+    code: string;
+    status: 'not_redeemed' | 'redeemed' | 'archived';
+    coupon_id: string;
+    coupon_set_id: string;
+    coupon_set_name: string;
+  }
 
-      */
-    
-    code:string;
-    
-    /**
-      * @description Status of the coupon code. \* not_redeemed - Can be applied to a subscription. \* redeemed - Cannot be applied to a subscription as the coupon code has been already used. \* archived - Cannot be applied to a subscription as it has been made inactive.
+  export namespace CouponCode {
+    export class CouponCodeResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
 
-      */
-    
-    status:'archived' | 'redeemed' | 'not_redeemed';
-    
-    /**
-      * @description Id of the main coupon resource.
+      retrieve(
+        coupon_code_code: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
 
-      */
-    
-    coupon_id:string;
-    
-    /**
-      * @description Uniquely identifies a coupon_set
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
 
-      */
-    
-    coupon_set_id:string;
-    
-    /**
-      * @description Coupon set name to which this coupon code would be grouped under. If the coupon set with the passed name is not present, a new coupon set will be created.
+      archive(
+        coupon_code_code: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ArchiveResponse>>;
+    }
 
-      */
-    
-    coupon_set_name:string;
-  }
-  export namespace CouponCode {
-    export class CouponCodeResource {  
-      /**
-        * @description Retrieves a specific coupon code details.
+    export interface CreateResponse {
+      coupon_code: CouponCode;
+    }
 
-        */
-      
-      retrieve(coupon_code_code:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description Archives a coupon code thereby making it inactive. The archived coupon code cannot be applied to any subscription.
+    export interface RetrieveResponse {
+      coupon_code: CouponCode;
+    }
+
+    export interface ListResponse {
+      list: { coupon_code: CouponCode }[];
+      next_offset?: string;
+    }
 
-        */
-      
-      archive(coupon_code_code:string):ChargebeeRequest<ArchiveResponse>;
+    export interface ArchiveResponse {
+      coupon_code: CouponCode;
     }
-    export interface RetrieveResponse {  
-       coupon_code:CouponCode;
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      coupon_id: string;
+      coupon_set_name: string;
+      code: string;
     }
-    
-    export interface ArchiveResponse {  
-       coupon_code:CouponCode;
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      code?: filter.String;
+      coupon_id?: filter.String;
+      coupon_set_name?: filter.String;
+      status?: filter.Enum;
     }
-    
-    
   }
-}
+}

package/types/resources/CouponSet.d.ts

@@ -1,253 +1,111 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface CouponSet {
-    
-    /**
-      * @description Uniquely identifies a coupon_set
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description Coupon id linked to coupon set
-
-      */
-    
-    coupon_id:string;
-    
-    /**
-      * @description Name of the coupon set
-
-      */
-    
-    name:string;
-    
-    /**
-      * @description No of coupon codes present in coupon set
-
-      */
-    
-    total_count?:number;
-    
-    /**
-      * @description No of redeemed codes
-
-      */
-    
-    redeemed_count?:number;
-    
-    /**
-      * @description No of archived codes
-
-      */
-    
-    archived_count?:number;
+    id: string;
+    coupon_id: string;
+    name: string;
+    total_count?: number;
+    redeemed_count?: number;
+    archived_count?: number;
+    meta_data?: any;
   }
+
   export namespace CouponSet {
-    export class CouponSetResource {  
-      /**
-        * @description Create a coupon set with a coupon code compatible to your product offers and promotional discounts
-
-        */
-      
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-       
-      /**
-        * @description This API add coupon codes to an existing coupon set.
-
-        */
-      
-      add_coupon_codes(coupon_set_id:string, input?:AddCouponCodesInputParam):ChargebeeRequest<AddCouponCodesResponse>;
-       
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-      
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
-       
-      /**
-        * @description Use this API to retrieve a specific coupon set.
-
-        */
-      
-      retrieve(coupon_set_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description Use this API to update a specific coupon set by updating its &#x60;name&#x60; and the &#x60;meta_data&#x60;.
-
-        */
-      
-      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.
-
-        */
-      
-      delete_unused_coupon_codes(coupon_set_id:string):ChargebeeRequest<DeleteUnusedCouponCodesResponse>;
+    export class CouponSetResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      addCouponCodes(
+        coupon_set_id: string,
+        input?: AddCouponCodesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddCouponCodesResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        coupon_set_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        coupon_set_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        coupon_set_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      deleteUnusedCouponCodes(
+        coupon_set_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteUnusedCouponCodesResponse>>;
     }
-    export interface CreateResponse {  
-       coupon_set:CouponSet;
+
+    export interface CreateResponse {
+      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 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 AddCouponCodesResponse {  
-       coupon_set:CouponSet;
+
+    export interface ListResponse {
+      list: { coupon_set: CouponSet }[];
+      next_offset?: string;
     }
-    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 RetrieveResponse {
+      coupon_set: CouponSet;
     }
-    export interface ListResponse {  
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-       
-       list:{coupon_set:CouponSet}[];
-       
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-       
-       next_offset?:string;
+
+    export interface UpdateResponse {
+      coupon_set: CouponSet;
     }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Use this API to get the list of all the coupon sets.
-
-        */
-        
-      offset?:string;
-       
-      /**
-        * @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 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 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 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 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 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 DeleteResponse {
+      coupon_set: CouponSet;
     }
-    export interface RetrieveResponse {  
-       coupon_set:CouponSet;
+
+    export interface DeleteUnusedCouponCodesResponse {
+      coupon_set: CouponSet;
     }
-    
-    export interface UpdateResponse {  
-       coupon_set:CouponSet;
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      coupon_id: string;
+      name: string;
+      id: string;
+      meta_data?: any;
     }
-    export interface UpdateInputParam {
-       
-      /**
-        * @description Name of the coupon set.
-
-        */
-       
-      name?: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 AddCouponCodesInputParam {
+      code?: string[];
     }
-    export interface DeleteResponse {  
-       coupon_set:CouponSet;
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      name?: filter.String;
+      coupon_id?: filter.String;
+      total_count?: filter.Number;
+      redeemed_count?: filter.Number;
+      archived_count?: filter.Number;
     }
-    
-    export interface DeleteUnusedCouponCodesResponse {  
-       coupon_set:CouponSet;
+    export interface UpdateInputParam {
+      name?: string;
+      meta_data?: any;
     }
-    
-    
   }
-}
+}