chargebee 2.40.0 → 3.0.0-beta.1

package/types/resources/Installment.d.ts

@@ -1,123 +1,48 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Installment {
-    
-    /**
-      * @description An auto-generated unique identifier for the Payment installment.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description The ID of the invoice to which this installment belongs.
-
-      */
-    
-    invoice_id:string;
-    
-    /**
-      * @description The date when this installment is in effect.
-
-      */
-    
-    date:number;
-    
-    /**
-      * @description The part of invoice.amount_due allocated to this installment.
-
-      */
-    
-    amount:number;
-    
-    /**
-      * @description The payment status of the installment. Possible values are paid, payment_due: The payment is due, posted. \* posted - The invoice is finalized but the payment is not due yet. \* payment_due - The payment is due. One or more payments were attempted for the installment but were unsuccessful. \* paid - The installment has been paid.
-
-      */
-    
-    status:'paid' | 'posted' | 'payment_due';
-    
-    /**
-      * @description The time when this resource was created.
-
-      */
-    
-    created_at:number;
-    
-    resource_version?:number;
-    
-    /**
-      * @description The time when this resource was last updated.
-
-      */
-    
-    updated_at?:number;
+    id: string;
+    invoice_id: string;
+    date: number;
+    amount: number;
+    status: 'posted' | 'payment_due' | 'paid';
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
   }
-  export namespace Installment {
-    export class InstallmentResource {  
-      /**
-        * @description Retrieves a specific installment resource.
 
-        */
-      
-      retrieve(installment_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
-
-        */
-      
-      list(input:ListInputParam):ChargebeeRequest<ListResponse>;
-    }
-    export interface RetrieveResponse {  
-       installment:Installment;
+  export namespace Installment {
+    export class InstallmentResource {
+      retrieve(
+        installment_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
     }
-    
-    export interface ListResponse {  
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
-
-        */
-       
-       list:{installment:Installment}[];
-       
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
 
-        */
-       
-       next_offset?:string;
+    export interface RetrieveResponse {
+      installment: Installment;
     }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
 
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
+    export interface ListResponse {
+      list: { installment: Installment }[];
+      next_offset?: string;
+    }
 
-        */
-        
-      sort_by?:string;
-       
-      /**
-        * @description Lists the installments that match the criteria provided in the filter parameters.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-        
-      invoice_id:{in?:string,is?:string};
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      sort_by?: string;
+      invoice_id: filter.String;
     }
-    
   }
-}
+}

package/types/resources/InstallmentConfig.d.ts

@@ -1,169 +1,68 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface InstallmentConfig {
-    
-    /**
-      * @description An auto-generated unique identifier for the Payment installment Configuration.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description A brief description for this installment configuration.
-
-      */
-    
-    description?:string;
-    
-    /**
-      * @description Specifies the total number of installments for the invoice.
-
-      */
-    
-    number_of_installments:number;
-    
-    /**
-      * @description Defines the time unit for intervals between installments.Possible values are: day, week, month \* month - month \* week - week \* day - day
-
-      */
-    
-    period_unit:'week' | 'month' | 'day';
-    
-    /**
-      * @description The time period between the effective dates of two consecutive installments, expressed in period_units.
-
-      */
-    
-    period?:number;
-    
-    /**
-      * @description The day of the week (or month) when the installment is in effect. For week: A value between 1 (Sunday) and 7 (Saturday) indicating the preferred day of the week for the installment dates. For example, 2 represents Monday. For month: A value from 1 to 31, indicating the preferred day of the month for installment dates. For example, 15 represents the 15th day of the month. If the month has fewer days than the specified preferred_day, the installment date is the last day of the month.
-
-      */
-    
-    preferred_day?:number;
-    
-    /**
-      * @description The timestamp at which the installment_config was created.
-
-      */
-    
-    created_at:number;
-    
-    /**
-      * @description Version number of this resource. The &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
-
-      */
-    
-    resource_version?:number;
-    
-    /**
-      * @description The timestamp at which the installment_config was last updated at.
-
-      */
-    
-    updated_at?:number;
-    
-    /**
-      * @description Defines the details for each installment individually.
-
-      */
-    
-    installments?:InstallmentConfig.Installments[];
+    id: string;
+    description?: string;
+    number_of_installments: number;
+    period_unit: 'day' | 'week' | 'month';
+    period?: number;
+    preferred_day?: number;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    installments?: InstallmentConfig.Installment[];
   }
-  export namespace InstallmentConfig {
-    export class InstallmentConfigResource {  
-      /**
-        * @description Creates an installment configuration. After creating an installment_config, you can use it to generate installments for multiple invoices.
-
-        */
-      
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-       
-      /**
-        * @description This endpoint retrieves an installment_config resource.
-
-        */
-      
-      retrieve(installment_config_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description This endpoint deletes an installment_config resource.
 
-        */
-      
-      delete(installment_config_id:string):ChargebeeRequest<DeleteResponse>;
-    }
-    export interface CreateResponse {  
-       installment_config:InstallmentConfig;
+  export namespace InstallmentConfig {
+    export class InstallmentConfigResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        installment_config_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        installment_config_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
     }
-    export interface CreateInputParam {
-       
-      /**
-        * @description Specifies the total number of installments for the invoice.
-
-        */
-       
-      number_of_installments:number;
-       
-      /**
-        * @description Defines the time unit for intervals between installments.Possible values are: day, week, month \* month - month \* week - week \* day - day
-
-        */
-       
-      period_unit:'week' | 'month' | 'day';
-       
-      /**
-        * @description The time period between the effective dates of two consecutive installments, expressed in period_units.
-
-        */
-       
-      period?:number;
-       
-      /**
-        * @description The day of the week (or month) when the installment is in effect. For week: A value between 1 (Sunday) and 7 (Saturday) indicating the preferred day of the week for the installment dates. For example, 2 represents Monday. For month: A value from 1 to 31, indicating the preferred day of the month for installment dates. For example, 15 represents the 15th day of the month. If the month has fewer days than the specified preferred_day, the installment date is the last day of the month.
-
-        */
-       
-      preferred_day?:number;
-       
-      /**
-        * @description A brief description for this installment configuration.
 
-        */
-       
-      description?:string;
-       
-      /**
-        * @description Parameters for installments
-
-        */
-       
-      installments?:{amount_percentage?:number,period?:number}[];
+    export interface CreateResponse {
+      installment_config: InstallmentConfig;
     }
-    export interface RetrieveResponse {  
-       installment_config:InstallmentConfig;
+
+    export interface RetrieveResponse {
+      installment_config: InstallmentConfig;
     }
-    
-    export interface DeleteResponse {  
-       installment_config:InstallmentConfig;
+
+    export interface DeleteResponse {
+      installment_config: InstallmentConfig;
     }
-    
-    export interface Installments {  
-         /**
-          * @description The period of time (expressed in period_units) after the invoice.date, marking the date when installment is in effect. For example, when installments.period is 3 and period_unit is month, this installment is effective 3 months after the invoice.date
 
-          */
-       
-      period?:number;
-       
-         /**
-          * @description The percentage of invoice.amount_due allocated to this installment. If unspecified, the invoice.amount_due is distributed equally among the installments.
+    export interface Installment {
+      period?: number;
+      amount_percentage?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
 
-          */
-       
-      amount_percentage?:number;
+    export interface CreateInputParam {
+      number_of_installments: number;
+      period_unit: 'day' | 'week' | 'month';
+      period?: number;
+      preferred_day?: number;
+      description?: string;
+      installments?: InstallmentsCreateInputParam[];
+    }
+    export interface InstallmentsCreateInputParam {
+      period?: number;
+      amount_percentage?: number;
     }
   }
-}
+}

package/types/resources/InstallmentDetail.d.ts

@@ -1,34 +1,26 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface InstallmentDetail {
-    
-    id?:string;
-    
-    invoice_id?:string;
-    
-    amount?:number;
-    
-    installments?:InstallmentDetail.Installment[];
+    id?: string;
+    invoice_id?: string;
+    amount?: number;
+    installments?: InstallmentDetail.Installment[];
   }
+
   export namespace InstallmentDetail {
-    
-    
-    export interface Installment {  
-      id:string;
-       
-      invoice_id:string;
-       
-      date:number;
-       
-      amount:number;
-       
-      status:'posted' | 'payment_due' | 'paid';
-       
-      created_at:number;
-       
-      resource_version?:number;
-       
-      updated_at?:number;
+    export interface Installment {
+      id: string;
+      invoice_id: string;
+      date: number;
+      amount: number;
+      status: 'posted' | 'payment_due' | 'paid';
+      created_at: number;
+      resource_version?: number;
+      updated_at?: number;
     }
+    // REQUEST PARAMS
+    //---------------
   }
-}
+}