chargebee 2.41.0 → 3.0.0-beta.2

package/types/resources/PricingPageSession.d.ts

@@ -1,54 +1,105 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface PricingPageSession {
-    
-
-    id?:string;
-
-    url?:string;
+    id?: string;
+    url?: string;
+    created_at?: number;
+    expires_at?: number;
+  }
 
-    created_at?:number;
+  export namespace PricingPageSession {
+    export class PricingPageSessionResource {
+      createForNewSubscription(
+        input: CreateForNewSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateForNewSubscriptionResponse>>;
 
-    expires_at?:number;
+      createForExistingSubscription(
+        input: CreateForExistingSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateForExistingSubscriptionResponse>>;
+    }
 
-  }
-  export namespace PricingPageSession {
-    export class PricingPageSessionResource {  
-      create_for_new_subscription(input:CreateForNewSubscriptionInputParam):ChargebeeRequest<CreateForNewSubscriptionResponse>;
-       
-      create_for_existing_subscription(input:CreateForExistingSubscriptionInputParam):ChargebeeRequest<CreateForExistingSubscriptionResponse>;
+    export interface CreateForNewSubscriptionResponse {
+      pricing_page_session: PricingPageSession;
     }
-    export interface CreateForNewSubscriptionResponse {  
-       pricing_page_session:PricingPageSession;
+
+    export interface CreateForExistingSubscriptionResponse {
+      pricing_page_session: PricingPageSession;
     }
+
+    // REQUEST PARAMS
+    //---------------
+
     export interface CreateForNewSubscriptionInputParam {
-       
-      pricing_page:{id:string};
-       
-      subscription?:object;
-       
-      customer?:object;
-       
-      billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      redirect_url?:string;
-       
-      business_entity_id?:string;
-    }
-    export interface CreateForExistingSubscriptionResponse {  
-       pricing_page_session:PricingPageSession;
+      redirect_url?: string;
+      business_entity_id?: string;
+      pricing_page?: PricingPageCreateForNewSubscriptionInputParam;
+      subscription?: SubscriptionCreateForNewSubscriptionInputParam;
+      customer?: CustomerCreateForNewSubscriptionInputParam;
+      billing_address?: BillingAddressCreateForNewSubscriptionInputParam;
+      shipping_address?: ShippingAddressCreateForNewSubscriptionInputParam;
     }
     export interface CreateForExistingSubscriptionInputParam {
-       
-      pricing_page:{id:string};
-       
-      subscription:object;
-       
-      redirect_url?:string;
-    }
-    
+      redirect_url?: string;
+      pricing_page?: PricingPageCreateForExistingSubscriptionInputParam;
+      subscription?: SubscriptionCreateForExistingSubscriptionInputParam;
+    }
+    export interface BillingAddressCreateForNewSubscriptionInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface PricingPageCreateForNewSubscriptionInputParam {
+      id: string;
+    }
+    export interface CustomerCreateForNewSubscriptionInputParam {
+      id?: string;
+      email?: string;
+      first_name?: string;
+      last_name?: string;
+      company?: string;
+      phone?: string;
+      locale?: string;
+    }
+    export interface ShippingAddressCreateForNewSubscriptionInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface SubscriptionCreateForNewSubscriptionInputParam {
+      id?: string;
+    }
+
+    export interface PricingPageCreateForExistingSubscriptionInputParam {
+      id: string;
+    }
+    export interface SubscriptionCreateForExistingSubscriptionInputParam {
+      id: string;
+    }
   }
-}
+}

package/types/resources/PromotionalCredit.d.ts

@@ -1,367 +1,111 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface PromotionalCredit {
-    
-    /**
-      * @description Unique reference ID provided for promotional credits
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description Identifier of the customer.
-
-      */
-    
-    customer_id:string;
-    
-    /**
-      * @description Type of promotional credits \* decrement - Decrement \* increment - Increment
-
-      */
-    
-    type:'decrement' | 'increment';
-    
-    /**
-      * @description Amount in decimal
-
-      */
-    
-    amount_in_decimal?:string;
-    
-    /**
-      * @description Promotional credits amount
-
-      */
-    
-    amount:number;
-    
-    /**
-      * @description The currency code (ISO 4217 format) for promotional credit
-
-      */
-    
-    currency_code:string;
-    
-    /**
-      * @description Detailed description of this promotional credits.
-
-      */
-    
-    description:string;
-    
-    /**
-      * @description Type of promotional credits provided to customer \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits \* general - General
-
-      */
-    
-    credit_type:CreditType;
-    
-    /**
-      * @description Describes why promotional credits were provided
-
-      */
-    
-    reference?:string;
-    
-    /**
-      * @description Closing balance as on end date.
-
-      */
-    
-    closing_balance:number;
-    
-    /**
-      * @description The user who added/deducted the credit. If created via API, this contains the name given for the API key used.
-
-      */
-    
-    done_by?:string;
-    
-    /**
-      * @description Timestamp indicating when this promotional credit resource is created.
-
-      */
-    
-    created_at:number;
+    id: string;
+    customer_id: string;
+    type: 'increment' | 'decrement';
+    amount_in_decimal?: string;
+    amount: number;
+    currency_code: string;
+    description: string;
+    credit_type: CreditType;
+    reference?: string;
+    closing_balance: number;
+    done_by?: string;
+    created_at: number;
   }
-  export namespace PromotionalCredit {
-    export class PromotionalCreditResource {  
-      /**
-        * @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer&#x27;s credit balance would become $20.
 
-        */
-      
-      add(input:AddInputParam):ChargebeeRequest<AddResponse>;
-       
-      /**
-        * @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer&#x27;s credit balance would become $15.
-
-If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
-
-        */
-      
-      deduct(input:DeductInputParam):ChargebeeRequest<DeductResponse>;
-       
-      /**
-        * @description This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
-
-For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
-
-        */
-      
-      set(input:SetInputParam):ChargebeeRequest<SetResponse>;
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-      
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
-       
-      /**
-        * @description This endpoint retrieves the promotional credit based on the promotional credit id
-
-        */
-      
-      retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
-    }
-    export interface AddResponse {  
-       customer:Customer;
-       
-       promotional_credit:PromotionalCredit;
+  export namespace PromotionalCredit {
+    export class PromotionalCreditResource {
+      add(
+        input: AddInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddResponse>>;
+
+      deduct(
+        input: DeductInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeductResponse>>;
+
+      set(
+        input: SetInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SetResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        account_credit_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
     }
-    export interface AddInputParam {
-       
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
-      customer_id:string;
-       
-      /**
-        * @description Promotional credits amount.
-
-        */
-       
-      amount?:number;
-       
-      /**
-        * @description Amount in decimal.
-
-        */
-       
-      amount_in_decimal?:string;
-       
-      /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
-
-        */
-       
-      currency_code?:string;
-       
-      /**
-        * @description Detailed description of this promotional credits.
 
-        */
-       
-      description:string;
-       
-      /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
-
-        */
-       
-      credit_type?:CreditType;
-       
-      /**
-        * @description Describes why promotional credits were provided.
-
-        */
-       
-      reference?:string;
+    export interface AddResponse {
+      customer: Customer;
+      promotional_credit: PromotionalCredit;
     }
-    export interface DeductResponse {  
-       customer:Customer;
-       
-       promotional_credit:PromotionalCredit;
-    }
-    export interface DeductInputParam {
-       
-      /**
-        * @description Identifier of the customer.
 
-        */
-       
-      customer_id:string;
-       
-      /**
-        * @description Promotional credits amount.
-
-        */
-       
-      amount?:number;
-       
-      /**
-        * @description Amount in decimal.
+    export interface DeductResponse {
+      customer: Customer;
+      promotional_credit: PromotionalCredit;
+    }
 
-        */
-       
-      amount_in_decimal?:string;
-       
-      /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
+    export interface SetResponse {
+      customer: Customer;
+      promotional_credit: PromotionalCredit;
+    }
 
-        */
-       
-      currency_code?:string;
-       
-      /**
-        * @description Detailed description of this promotional credits.
+    export interface ListResponse {
+      list: { promotional_credit: PromotionalCredit }[];
+      next_offset?: string;
+    }
 
-        */
-       
-      description:string;
-       
-      /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
+    export interface RetrieveResponse {
+      promotional_credit: PromotionalCredit;
+    }
 
-        */
-       
-      credit_type?:CreditType;
-       
-      /**
-        * @description Describes why promotional credits were provided.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-       
-      reference?:string;
+    export interface AddInputParam {
+      customer_id: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      currency_code?: string;
+      description: string;
+      credit_type?: CreditType;
+      reference?: string;
     }
-    export interface SetResponse {  
-       customer:Customer;
-       
-       promotional_credit:PromotionalCredit;
+    export interface DeductInputParam {
+      customer_id: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      currency_code?: string;
+      description: string;
+      credit_type?: CreditType;
+      reference?: string;
     }
     export interface SetInputParam {
-       
-      /**
-        * @description Identifier of the customer.
-
-        */
-       
-      customer_id:string;
-       
-      /**
-        * @description Promotional credits amount.
-
-        */
-       
-      amount?:number;
-       
-      /**
-        * @description Amount in decimal.
-
-        */
-       
-      amount_in_decimal?:string;
-       
-      /**
-        * @description The currency code (ISO 4217 format) for promotional credit.
-
-        */
-       
-      currency_code?:string;
-       
-      /**
-        * @description Detailed description of this promotional credits.
-
-        */
-       
-      description:string;
-       
-      /**
-        * @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
-
-        */
-       
-      credit_type?:CreditType;
-       
-      /**
-        * @description Describes why promotional credits were provided.
-
-        */
-       
-      reference?:string;
-    }
-    export interface ListResponse {  
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-       
-       list:{promotional_credit:PromotionalCredit}[];
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-       
-       next_offset?:string;
+      customer_id: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      currency_code?: string;
+      description: string;
+      credit_type?: CreditType;
+      reference?: string;
     }
     export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-        
-      id?:{is?:string,is_not?:string,starts_with?:string};
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-        
-      created_at?:{after?:string,before?:string,between?:string,on?:string};
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-        
-      type?:{in?:string,is?:'decrement' | 'increment',is_not?:'decrement' | 'increment',not_in?:string};
-       
-      /**
-        * @description This endpoint lists the promotional credits set for a customer
-
-        */
-        
-      customer_id?:{is?:string,is_not?:string,starts_with?:string};
-    }
-    export interface RetrieveResponse {  
-       promotional_credit:PromotionalCredit;
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      created_at?: filter.Timestamp;
+      type?: filter.Enum;
+      customer_id?: filter.String;
     }
-    
-    
   }
-}
+}