chargebee 2.50.0 → 2.52.0

package/types/resources/Gift.d.ts

@@ -1,126 +1,46 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Gift {
     
-    /**
-      * @description Uniquely identifies a gift
 
-      */
-    
     id:string;
-    
-    /**
-      * @description Status of the gift. \* claimed - Gift is claimed. \* cancelled - Gift is cancelled. \* unclaimed - Gift is not yet claimed and is ready to be claimed. \* scheduled - Gift has been scheduled. \* expired - Gift is expired.
 
-      */
-    
-    status:'expired' | 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled';
-    
-    /**
-      * @description Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
+    status:'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired';
 
-      */
-    
     scheduled_at?:number;
-    
-    /**
-      * @description When &#x60;true&#x60;, the claim happens automatically. When not passed, the default value in the site settings is used.
 
-      */
-    
     auto_claim:boolean;
-    
-    /**
-      * @description When &#x60;true&#x60;, indicates that the gift does not expire. Do not pass or pass as &#x60;false&#x60; when &#x60;auto_claim&#x60; is set.
 
-      */
-    
     no_expiry:boolean;
-    
-    /**
-      * @description The date until which the gift can be claimed. Must be set to a value after &#x60;scheduled_at&#x60;. If the gift is not claimed within &#x60;claim_expiry_date&#x60;, it will expire and the subscription will move to &#x60;cancelled&#x60; state. When not passed, the value specified in the site settings will be used. Pass as &#x60;NULL&#x60; or do not pass when &#x60;auto_claim&#x60; or &#x60;no_expiry&#x60; are set.
 
-      */
-    
     claim_expiry_date?: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 Timestamp indicating when this gift resource was last updated.
 
-      */
-    
     updated_at?:number;
-    
-    /**
-      * @description Gifter details
 
-      */
-    
     gifter:Gift.Gifter;
-    
-    /**
-      * @description Receiver details
 
-      */
-    
     gift_receiver:Gift.GiftReceiver;
-    
-    /**
-      * @description Gift timeline details
 
-      */
-    
     gift_timelines?:Gift.GiftTimeline[];
+
   }
   export namespace Gift {
     export class GiftResource {  
-      /**
-        * @description Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
-
-        */
-      
-      create_for_items(input?:CreateForItemsInputParam):ChargebeeRequest<CreateForItemsResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
+      create_for_items(input:CreateForItemsInputParam):ChargebeeRequest<CreateForItemsResponse>;
        
-      /**
-        * @description Retrieves a gift subscription. This API accepts the gift &#x27;id&#x27; and returns the gift along with the subscription.
-
-        */
-      
       retrieve(gift_id:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Retrieves the list of gifts.
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @description Claiming a gift will move the status to &#x27;claimed&#x27;. Only gifts in &#x27;unclaimed&#x27; state can be claimed.
-
-        */
-      
       claim(gift_id:string):ChargebeeRequest<ClaimResponse>;
        
-      /**
-        * @description This API allows to cancel gifts. Only gift in &#x27;scheduled&#x27; and &#x27;unclaimed&#x27; states can be cancelled.
-
-        */
-      
       cancel(gift_id:string):ChargebeeRequest<CancelResponse>;
        
-      /**
-        * @description Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled [status](https://apidocs.chargebee.com/docs/api/gifts#gift_status).
-
-        */
-      
       update_gift(gift_id:string, input:UpdateGiftInputParam):ChargebeeRequest<UpdateGiftResponse>;
     }
     export interface CreateResponse {  
@@ -132,82 +52,27 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
        
-      /**
-        * @description Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
-
-        */
-       
-      scheduled_at?:number;
-       
-      /**
-        * @description When &#x60;true&#x60;, the claim happens automatically. When not passed, the default value in the site settings is used.
-
-        */
-       
-      auto_claim?:boolean;
-       
-      /**
-        * @description When &#x60;true&#x60;, indicates that the gift does not expire. Do not pass or pass as &#x60;false&#x60; when &#x60;auto_claim&#x60; is set. .
-
-        */
-       
-      no_expiry?:boolean;
-       
-      /**
-        * @description The date until which the gift can be claimed. Must be set to a value after &#x60;scheduled_at&#x60;. If the gift is not claimed within &#x60;claim_expiry_date&#x60;, it will expire and the subscription will move to &#x60;cancelled&#x60; state. When not passed, the value specified in the site settings will be used. Pass as &#x60;NULL&#x60; or do not pass when &#x60;auto_claim&#x60; or &#x60;no_expiry&#x60; are set.
-
-        */
-       
-      claim_expiry_date?:number;
-       
-      /**
-        * @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
-
-        */
-       
-      coupon_ids?:string[];
-       
-      /**
-        * @description Parameters for gifter
-
-        */
-       
       gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
        
-      /**
-        * @description Parameters for gift_receiver
-
-        */
-       
       gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
        
-      /**
-        * @description Parameters for payment_intent
-
-        */
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?: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};
        
-      /**
-        * @description Parameters for shipping_address
-
-        */
+      subscription:object;
        
-      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};
+      addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
        
-      /**
-        * @description Parameters for subscription
-
-        */
+      scheduled_at?:number;
        
-      subscription:object;
+      auto_claim?:boolean;
        
-      /**
-        * @description Parameters for addons
-
-        */
+      no_expiry?:boolean;
        
-      addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
+      claim_expiry_date?:number;
+       
+      coupon_ids?:string[];
     }
     export interface CreateForItemsResponse {  
        gift:Gift;
@@ -218,75 +83,25 @@ declare module 'chargebee' {
     }
     export interface CreateForItemsInputParam {
        
-      /**
-        * @description Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.
-
-        */
+      gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
        
-      scheduled_at?:number;
+      gift_receiver:{customer_id:string,email:string,first_name:string,last_name:string};
        
-      /**
-        * @description When &#x60;true&#x60;, the claim happens automatically. When not passed, the default value in the site settings is used.
-
-        */
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
        
-      auto_claim?:boolean;
+      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};
        
-      /**
-        * @description When &#x60;true&#x60;, indicates that the gift does not expire. Do not pass or pass as &#x60;false&#x60; when &#x60;auto_claim&#x60; is set. .
-
-        */
+      subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
        
-      no_expiry?:boolean;
+      scheduled_at?:number;
        
-      /**
-        * @description The date until which the gift can be claimed. Must be set to a value after &#x60;scheduled_at&#x60;. If the gift is not claimed within &#x60;claim_expiry_date&#x60;, it will expire and the subscription will move to &#x60;cancelled&#x60; state. When not passed, the value specified in the site settings will be used. Pass as &#x60;NULL&#x60; or do not pass when &#x60;auto_claim&#x60; or &#x60;no_expiry&#x60; are set.
-
-        */
+      auto_claim?:boolean;
        
-      claim_expiry_date?:number;
+      no_expiry?:boolean;
        
-      /**
-        * @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
-
-        */
+      claim_expiry_date?:number;
        
       coupon_ids?:string[];
-       
-      /**
-        * @description Parameters for gifter
-
-        */
-       
-      gifter?:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
-       
-      /**
-        * @description Parameters for gift_receiver
-
-        */
-       
-      gift_receiver?:{customer_id:string,email:string,first_name:string,last_name:string};
-       
-      /**
-        * @description Parameters for payment_intent
-
-        */
-       
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
-       
-      /**
-        * @description Parameters for shipping_address
-
-        */
-       
-      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};
-       
-      /**
-        * @description Parameters for subscription_items
-
-        */
-       
-      subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
     }
     export interface RetrieveResponse {  
        gift:Gift;
@@ -295,56 +110,46 @@ declare module 'chargebee' {
     }
     
     export interface ListResponse {  
-      /**
-        * @description Retrieves the list of gifts.
-
-        */
-       
        list:{gift:Gift,subscription:Subscription}[];
        
-      /**
-        * @description Retrieves the list of gifts.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description Retrieves the list of gifts.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description Retrieves the list of gifts.
+        * @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.
 
         */
         
       offset?:string;
        
       /**
-        * @description Retrieves the list of gifts.
+        * @description Parameters for gift_receiver
 
         */
         
-      status?:{in?:string,is?:'expired' | 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled',is_not?:'expired' | 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled',not_in?:string};
+      gift_receiver?:{customer_id?:{is?:string,is_not?:string,starts_with?:string},email?:{is?:string,is_not?:string,starts_with?:string}};
        
       /**
-        * @description Retrieves the list of gifts.
+        * @description Parameters for gifter
 
         */
         
-      gift_receiver?:{customer_id?:{is?:string,is_not?:string,starts_with?:string},email?:{is?:string,is_not?:string,starts_with?:string}};
+      gifter?:{customer_id?:{is?:string,is_not?:string,starts_with?:string}};
        
       /**
-        * @description Retrieves the list of gifts.
+        * @description Status of the gift.
 
         */
         
-      gifter?:{customer_id?:{is?:string,is_not?:string,starts_with?:string}};
+      status?:{in?:string,is?:'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired',is_not?:'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired',not_in?:string};
     }
     export interface ClaimResponse {  
        gift:Gift;
@@ -365,97 +170,32 @@ declare module 'chargebee' {
     }
     export interface UpdateGiftInputParam {
        
-      /**
-        * @description The new date/time at which the gift notification email is to be sent. The value must be greater than current time. If [no_expiry](https://apidocs.chargebee.com/docs/api/gifts#gift_no_expiry) is false then the value must also be less than [claim_expiry_date](https://apidocs.chargebee.com/docs/api/gifts#gift_claim_expiry_date).
-
-        */
-       
       scheduled_at:number;
        
-      /**
-        * @description An internal comment for this action. The comments are not retrievable via API and are only available on request via [Chargebee Support](https://chargebee.freshdesk.com/support/home).
-
-        */
-       
       comment?:string;
     }
     export interface Gifter {  
-         /**
-          * @description Gifter customer id.
-
-          */
-       
       customer_id:string;
        
-         /**
-          * @description Invoice raised on the gifter.
-
-          */
-       
       invoice_id?:string;
        
-         /**
-          * @description Gifter sign-off name
-
-          */
-       
       signature?:string;
        
-         /**
-          * @description Personalized message for the gift.
-
-          */
-       
       note?:string;
     }
     export interface GiftReceiver {  
-         /**
-          * @description Receiver customer id.
-
-          */
-       
       customer_id:string;
        
-         /**
-          * @description Subscription created for the gift.
-
-          */
-       
       subscription_id:string;
        
-         /**
-          * @description First name of the receiver as given by the gifter.
-
-          */
-       
       first_name?:string;
        
-         /**
-          * @description Last name of the receiver as given by the gifter,
-
-          */
-       
       last_name?:string;
        
-         /**
-          * @description Email of the receiver. All gift related emails are sent to this email.
-
-          */
-       
       email?:string;
     }
     export interface GiftTimeline {  
-         /**
-          * @description Status of the gift. \* cancelled - Gift is cancelled. \* expired - Gift is expired. \* scheduled - Gift has been scheduled. \* claimed - Gift is claimed. \* unclaimed - Gift is not yet claimed and is ready to be claimed.
-
-          */
-       
-      status:'expired' | 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled';
-       
-         /**
-          * @description Timestamp indicating when this event occurred.
-
-          */
+      status:'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired';
        
       occurred_at?:number;
     }

package/types/resources/Hierarchy.d.ts

@@ -1,40 +1,20 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Hierarchy {
     
-    /**
-      * @description The &#x60;id&#x60; of the customer associated with this &#x60;hierarchy&#x60; resource.
 
-      */
-    
     customer_id:string;
-    
-    /**
-      * @description The &#x60;id&#x60; of the immediate parent for the customer identified by &#x60;customer_id&#x60;. If the customer is the root of the hierarchy, this attribute isn&#x27;t returned.
 
-      */
-    
     parent_id?:string;
-    
-    /**
-      * @description The &#x60;id&#x60; of the customer responsible for paying the invoices for the customer identified by &#x60;customer_id&#x60;. This ID must match either &#x60;customer_id&#x60; or &#x60;invoice_owner_id&#x60;.
 
-      */
-    
     payment_owner_id:string;
-    
-    /**
-      * @description The &#x60;id&#x60; of the customer who receives the invoice for charges incurred by the customer identified by &#x60;customer_id&#x60;. This ID must match either &#x60;customer_id&#x60; or one of its ancestors.
 
-      */
-    
     invoice_owner_id:string;
-    
-    /**
-      * @description A list of &#x60;id&#x60;s representing the immediate children, if any exist, for the customer identified by &#x60;customer_id&#x60;.
 
-      */
-    
+    has_children?:boolean;
+
     children_ids?:string[];
+
   }
 }

package/types/resources/ImpactedItem.d.ts

@@ -1,55 +1,23 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ImpactedItem {
     
-    /**
-      * @description The total number of items that have been impacted.
 
-      */
-    
     count?:number;
-    
-    /**
-      * @description The list of items that have been impacted. The objects in this array have the following keys:
 
-* &#x60;id&#x60;: (string, max chars &#x3D; 100) The [unique identifier](/docs/api/items#item_id) for the item.
-* &#x60;type&#x60;: (enumerated string) The [type](/docs/api/items#item_type) of the item.
-
-This list can contain a maximum of 1,000 items. The full list of items is available in &#x60;download&#x60;.
+    download?:ImpactedItem.Download;
 
-      */
-    
     items?:any[];
-    
-    /**
-      * @description The [download](/docs/api/downloads) resource containing all the impacted items. The list of items is available as a JSON array in the file at &#x60;download.url&#x60; until &#x60;download.valid_till&#x60;.
 
-      */
-    
-    download?:ImpactedItem.Download;
   }
   export namespace ImpactedItem {
     
     
     export interface Download {  
-         /**
-          * @description The URL at which the file is available for download.
-
-          */
+      download_url:string;
        
-      download_url?:string;
-       
-         /**
-          * @description The time until which the &#x60;download_url&#x60; is valid.
-
-          */
-       
-      valid_till?:number;
-       
-         /**
-          * @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
-
-          */
+      valid_till:number;
        
       mime_type?:string;
     }

package/types/resources/ImpactedItemPrice.d.ts

@@ -1,12 +1,15 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ImpactedItemPrice {
     
+
     count?:number;
-    
+
     download?:ImpactedItemPrice.Download;
-    
+
     item_prices?:any[];
+
   }
   export namespace ImpactedItemPrice {
     

package/types/resources/ImpactedSubscription.d.ts

@@ -1,51 +1,24 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ImpactedSubscription {
     
-    /**
-      * @description The total count of affected subscriptions.
 
-      */
-    
     count?:number;
-    
-    /**
-      * @description The impacted subscription IDs. This list contains up to 1,000 IDs. The complete list of subscription IDs is in the &#x60;download&#x60; resource, which can store up to 100,000 IDs.
 
-      */
-    
+    download?:ImpactedSubscription.Download;
+
     subscription_ids?:any[];
-    
-    /**
-      * @description This [download](downloads) resource contains the impacted subscription IDs. These IDs are in a JSON array in the file at &#x60;download.url&#x60; until &#x60;download.valid_till&#x60;. The file at this URL stores up to 100,000 subscription IDs. [Contact Support](https://support.chargebee.com/support/home) to increase this limit for your Chargebee site.
 
-      */
-    
-    download?:ImpactedSubscription.Download;
   }
   export namespace ImpactedSubscription {
     
     
     export interface Download {  
-         /**
-          * @description The download URL for the file.
-
-          */
-       
       download_url:string;
        
-         /**
-          * @description The expiration time for the &#x60;download_url&#x60;.
-
-          */
-       
       valid_till:number;
        
-         /**
-          * @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
-
-          */
-       
       mime_type?:string;
     }
   }