chargebee 2.28.0 → 2.30.0

package/types/resources/Card.d.ts

@@ -10,14 +10,14 @@ declare module 'chargebee' {
     payment_source_id:string;
     
     /**
-      * @description Current status of the card. \* valid - A valid and active credit card \* expired - An expired card \* expiring - A card which is expiring in the current month.
+      * @description Current status of the card. \* valid - A valid and active credit card \* expiring - A card which is expiring in the current month. \* expired - An expired card
 
       */
     
     status:'valid' | 'expiring' | 'expired';
     
     /**
-      * @description Name of the gateway this payment source is stored with. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* eway - eWAY Account is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* amazon_payments - Amazon Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* worldpay - WorldPay is a payment gateway \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* stripe - Stripe is a payment gateway. \* vantiv - Vantiv is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* cybersource - CyberSource is a payment gateway.
+      * @description Name of the gateway this payment source is stored with. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* amazon_payments - Amazon Payments is a payment service provider. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* bank_of_america - Bank of America Gateway \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway
 
       */
     
@@ -66,14 +66,14 @@ declare module 'chargebee' {
     last4:string;
     
     /**
-      * @description Card type \* other - Card belonging to types other than those listed above. \* bancontact - A Bancontact card. \* american_express - An American Express card. \* mastercard - A MasterCard. \* jcb - A JCB card. \* not_applicable - Used for offline entries in transactions. Not applicable for cards \* visa - A Visa card. \* diners_club - A Diner's Club card. \* discover - A Discover card.
+      * @description Card type \* bancontact - A Bancontact card. \* american_express - An American Express card. \* not_applicable - Used for offline entries in transactions. Not applicable for cards \* diners_club - A Diner's Club card. \* discover - A Discover card. \* other - Card belonging to types other than those listed above. \* mastercard - A MasterCard. \* jcb - A JCB card. \* visa - A Visa card.
 
       */
     
     card_type?:'discover' | 'bancontact' | 'other' | 'visa' | 'jcb' | 'diners_club' | 'mastercard' | 'not_applicable' | 'american_express';
     
     /**
-      * @description Card Funding type \* prepaid - A prepaid card. \* debit - A debit card. \* not_applicable - Used for ACH. Not applicable for cards \* credit - A credit card. \* not_known - An unknown card.
+      * @description Card Funding type \* credit - A credit card. \* prepaid - A prepaid card. \* debit - A debit card. \* not_applicable - Used for ACH. Not applicable for cards \* not_known - An unknown card.
 
       */
     
@@ -185,7 +185,7 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
     ip_address?:string;
     
     /**
-      * @description Card is powered by payment method. \* ideal - ideal \* sofort - sofort \* bancontact - bancontact \* giropay - giropay \* latam_local_card - latam_local_card \* not_applicable - not_applicable \* card - card
+      * @description Card is powered by payment method. \* card - card \* ideal - ideal \* sofort - sofort \* bancontact - bancontact \* giropay - giropay \* latam_local_card - latam_local_card \* not_applicable - not_applicable
 
       */
     
@@ -207,20 +207,6 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
   }
   export namespace Card {
     export class CardResource {  
-      /**
-        * @description #### deprecated
-
-The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Export payment source API](/docs/api/payment_sources#export_payment_source).
-
-Copies the customer's card information to another payment gateway. This is useful if you want to port your customer's card details to another gateway.
-
-**Limitation**   
-This request does not support copying of cards between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
-
-        */
-      
-      copy_card_for_customer(customer_id:string, input:CopyCardForCustomerInputParam):ChargebeeRequest<CopyCardForCustomerResponse>;
-       
       /**
         * @description #### Deprecated
 
@@ -235,31 +221,6 @@ Retrieves the credit card for the customer id.
       /**
         * @description #### Deprecated
 
-This request is obsoleted by the [Switch gateway account API](/docs/api/payment_sources#switch_gateway_account) for Payment Sources.
-
-Switches the gateway in which customer&#x27;s card information is stored. This is applicable only if the payment method is &#x60;card&#x60;.
-
-**Limitation**   
-This request does not support switching between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
-
-        */
-      
-      switch_gateway_for_customer(customer_id:string, input:SwitchGatewayForCustomerInputParam):ChargebeeRequest<SwitchGatewayForCustomerResponse>;
-       
-      /**
-        * @description #### deprecated
-
-The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Delete a payment source API](/docs/api/payment_sources#delete_a_payment_source).
-
-Deletes the card for a customer. Upon successful deletion the &#x60;auto_collection&#x60; attribute for the customer is set to &#x60;off&#x60; and a &#x60;card_deleted&#x60; event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.
-
-        */
-      
-      delete_card_for_customer(customer_id:string):ChargebeeRequest<DeleteCardForCustomerResponse>;
-       
-      /**
-        * @description #### Deprecated
-
 The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the [Cards APIs](/docs/api/cards). This operation is obsoleted by the following:
 
 * [Create using temporary token](/docs/api/payment_sources#create_using_temporary_token)
@@ -273,7 +234,7 @@ Passing credit card details to this API involves PCI liability at your end as se
 * If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your card update form.
 * If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your card update form.
 * If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your card update form.
-* In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s [Client Side Encryption](https://docs.adyen.com/developers/features/client-side-encryption) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
+* In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
 * You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html) based integration. Use our [Hosted Page - Update Card](/docs/api/hosted_pages#update_card) API to generate a &#x27;Update Card&#x27; Hosted Page link.
 
 
@@ -286,39 +247,48 @@ Passing credit card details to this API involves PCI liability at your end as se
         */
       
       update_card_for_customer(customer_id:string, input:UpdateCardForCustomerInputParam):ChargebeeRequest<UpdateCardForCustomerResponse>;
-    }
-    export interface CopyCardForCustomerResponse {  
-       third_party_payment_method:ThirdPartyPaymentMethod;
-    }
-    export interface CopyCardForCustomerInputParam {
        
       /**
-        * @description The gateway account you want to copy the card.
+        * @description #### Deprecated
+
+This request is obsoleted by the [Switch gateway account API](/docs/api/payment_sources#switch_gateway_account) for Payment Sources.
+
+Switches the gateway in which customer&#x27;s card information is stored. This is applicable only if the payment method is &#x60;card&#x60;.
+
+**Limitation**   
+This request does not support switching between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
 
         */
-       
-      gateway_account_id:string;
-    }
-    export interface RetrieveResponse {  
-       card:Card;
-    }
-    
-    export interface SwitchGatewayForCustomerResponse {  
-       customer:Customer;
-       
-       card:Card;
-    }
-    export interface SwitchGatewayForCustomerInputParam {
+      
+      switch_gateway_for_customer(customer_id:string, input:SwitchGatewayForCustomerInputParam):ChargebeeRequest<SwitchGatewayForCustomerResponse>;
        
       /**
-        * @description The gateway account you want to switch to.
+        * @description #### deprecated
+
+The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Export payment source API](/docs/api/payment_sources#export_payment_source).
+
+Copies the customer&#x27;s card information to another payment gateway. This is useful if you want to port your customer&#x27;s card details to another gateway.
+
+**Limitation**   
+This request does not support copying of cards between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://chargebee.freshdesk.com/support/home) to perform those actions.
 
         */
+      
+      copy_card_for_customer(customer_id:string, input:CopyCardForCustomerInputParam):ChargebeeRequest<CopyCardForCustomerResponse>;
        
-      gateway_account_id:string;
+      /**
+        * @description #### deprecated
+
+The [Payment Sources API](/docs/api/payment_sources), with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Delete a payment source API](/docs/api/payment_sources#delete_a_payment_source).
+
+Deletes the card for a customer. Upon successful deletion the &#x60;auto_collection&#x60; attribute for the customer is set to &#x60;off&#x60; and a &#x60;card_deleted&#x60; event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.
+
+        */
+      
+      delete_card_for_customer(customer_id:string):ChargebeeRequest<DeleteCardForCustomerResponse>;
     }
-    export interface DeleteCardForCustomerResponse {  
-       customer:Customer;
+    export interface RetrieveResponse {  
+       card:Card;
     }
     
     export interface UpdateCardForCustomerResponse {  
@@ -442,6 +412,36 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
        
       billing_country?:string;
     }
+    export interface SwitchGatewayForCustomerResponse {  
+       customer:Customer;
+       
+       card:Card;
+    }
+    export interface SwitchGatewayForCustomerInputParam {
+       
+      /**
+        * @description The gateway account you want to switch to.
+
+        */
+       
+      gateway_account_id:string;
+    }
+    export interface CopyCardForCustomerResponse {  
+       third_party_payment_method:ThirdPartyPaymentMethod;
+    }
+    export interface CopyCardForCustomerInputParam {
+       
+      /**
+        * @description The gateway account you want to copy the card.
+
+        */
+       
+      gateway_account_id:string;
+    }
+    export interface DeleteCardForCustomerResponse {  
+       customer:Customer;
+    }
+    
     
   }
 }

package/types/resources/Comment.d.ts

@@ -10,7 +10,7 @@ declare module 'chargebee' {
     id:string;
     
     /**
-      * @description Type of the entity this comment generated for \* item - Entity that represents item \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* invoice - Invoice description \* business_entity - Entity that represents item of type business entity \* plan - Entity that represents a subscription plan \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* addon - Entity that represents an addon \* credit_note - Credit note description \* quote - Entity that represents a quote
+      * @description Type of the entity this comment generated for \* item - Entity that represents item \* invoice - Invoice description \* product - Entity that represents product \* plan - Entity that represents a subscription plan \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* quote - Entity that represents a quote \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* variant - Entity that represents product variants \* business_entity - Entity that represents item of type business entity \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* addon - Entity that represents an addon \* credit_note - Credit note description
 
       */
     
@@ -38,7 +38,7 @@ declare module 'chargebee' {
     created_at:number;
     
     /**
-      * @description Type of comment this is. \* user - Comment generated by user either via API or Admin console. \* system - Comment generated by Chargebee when any backend changes happen for an entity
+      * @description Type of comment this is. \* system - Comment generated by Chargebee when any backend changes happen for an entity \* user - Comment generated by user either via API or Admin console.
 
       */
     
@@ -54,13 +54,11 @@ declare module 'chargebee' {
   export namespace Comment {
     export class CommentResource {  
       /**
-        * @description Delete a comment for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver=1#create_a_comment_entity_type) identified by comment ID.
-
-Only the comments that are added via Admin console and API can be deleted. Chargebee generated "System" comments cannot be deleted.
+        * @description Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
 
         */
       
-      delete(comment_id:string):ChargebeeRequest<DeleteResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
         * @description Retrieve a comment for an entity identified by comment ID.
@@ -79,16 +77,47 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
       /**
-        * @description Create a new comment for an entity. The newly added comment will be shown in the web interface as well.
+        * @description Delete a comment for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#create_a_comment_entity_type) identified by comment ID.
+
+Only the comments that are added via Admin console and API can be deleted. Chargebee generated &quot;System&quot; comments cannot be deleted.
 
         */
       
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      delete(comment_id:string):ChargebeeRequest<DeleteResponse>;
     }
-    export interface DeleteResponse {  
+    export interface CreateResponse {  
        comment:Comment;
     }
-    
+    export interface CreateInputParam {
+       
+      /**
+        * @description Type of the entity to create the comment for. \* item - Entity that represents item \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* variant - Entity that represents product variants \* invoice - Invoice description \* product - Entity that represents product \* business_entity - Entity that represents item of type business entity \* plan - Entity that represents a subscription plan \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* addon - Entity that represents an addon \* credit_note - Credit note description \* quote - Entity that represents a quote
+
+        */
+       
+      entity_type:EntityType;
+       
+      /**
+        * @description Unique identifier of the entity.
+
+        */
+       
+      entity_id:string;
+       
+      /**
+        * @description Actual notes for the comment.
+
+        */
+       
+      notes:string;
+       
+      /**
+        * @description The user who created the comment. If created via API, this contains the name given for the API key used.
+
+        */
+       
+      added_by?:string;
+    }
     export interface RetrieveResponse {  
        comment:Comment;
     }
@@ -115,14 +144,18 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
 
         */
         
       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 Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
 
         */
         
@@ -147,7 +180,9 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
       entity_id?:string;
        
       /**
-        * @description The time at which this comment was created
+        * @description Retrieve the list of comments sorted by the recent ones on the top.
+
+If you want to retrieve the list of comments for an [entity](https://apidocs.chargebee.com/docs/api/v1/comments?prod_cat_ver&#x3D;1#list_comments_entity_type), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.
 
         */
         
@@ -162,39 +197,10 @@ If you want to retrieve the list of comments for an [entity](https://apidocs.cha
         
       sort_by?:{asc?:'created_at',desc?:'created_at'};
     }
-    export interface CreateResponse {  
+    export interface DeleteResponse {  
        comment:Comment;
     }
-    export interface CreateInputParam {
-       
-      /**
-        * @description Type of the entity to create the comment for. \* item - Entity that represents item \* order - Entity that represents an order \* item_price - Entity that represents item price \* customer - Entity that represents a customer \* invoice - Invoice description \* business_entity - Entity that represents item of type business entity \* plan - Entity that represents a subscription plan \* coupon - Entity that represents a discount coupon \* subscription - Entity that represents a subscription of a customer \* item_family - Entity that represents item family \* transaction - Entity that represents a transaction. \* addon - Entity that represents an addon \* credit_note - Credit note description \* quote - Entity that represents a quote
-
-        */
-       
-      entity_type:EntityType;
-       
-      /**
-        * @description Unique identifier of the entity.
-
-        */
-       
-      entity_id:string;
-       
-      /**
-        * @description Actual notes for the comment.
-
-        */
-       
-      notes:string;
-       
-      /**
-        * @description The user who created the comment. If created via API, this contains the name given for the API key used.
-
-        */
-       
-      added_by?:string;
-    }
+    
     
   }
 }