chargebee 2.26.0 → 2.27.0

package/types/resources/PaymentVoucher.d.ts

@@ -1,72 +1,310 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface PaymentVoucher {
+    
+    /**
+      * @description Uniquely identifies the payment voucher.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description The id with which this voucher is referred in gateway.
+
+      */
+    
     id_at_gateway?:string;
+    
+    /**
+      * @description Type of the payment source. \* boleto - Boleto
+
+      */
+    
     payment_voucher_type:PaymentVoucherType;
+    
+    /**
+      * @description Timestamp indicating when the Voucher will expire if left unconsumed.
+
+      */
+    
     expires_at?:number;
+    
+    /**
+      * @description Current status of the payment voucher. \* consumed - Consumed for a transaction and cannot be used again \* expired - Expired before consumed and cannot be used again \* active - Active and ready to be consumed \* failure - Failed to create the voucher due to gateway rejection
+
+      */
+    
     status?:'consumed' | 'expired' | 'failure' | 'active';
+    
+    /**
+      * @description Identifier of the subscription for which this payment voucher is made.
+
+      */
+    
     subscription_id?:string;
+    
+    /**
+      * @description The currency code (ISO 4217 format) for the voucher.
+
+      */
+    
     currency_code:string;
+    
+    /**
+      * @description Amount for this payment voucher.
+
+      */
+    
     amount?:number;
+    
+    /**
+      * @description The gateway account used for this voucher
+
+      */
+    
     gateway_account_id?:string;
+    
+    /**
+      * @description Identifier of the payment source for which this payment voucher is created
+
+      */
+    
     payment_source_id?:string;
+    
+    /**
+      * @description The gateway through which this payment voucher was created.  
+**Note** : Note: Currently, &#x60;stripe&#x60; is the only supported gateway through which you can create the payment voucher. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* 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. \* bank_of_america - Bank of America 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.
+
+      */
+    
     gateway:Gateway;
+    
+    /**
+      * @description Payload from the gateway response with voucher details
+
+      */
+    
     payload?:string;
+    
+    /**
+      * @description Error code received from the payment gateway on failure.
+
+      */
+    
     error_code?:string;
+    
+    /**
+      * @description Error message received from the payment gateway on failure.
+
+      */
+    
     error_text?:string;
+    
+    /**
+      * @description Chargebee Hosted Page url for payment voucher
+
+      */
+    
     url?:string;
+    
+    /**
+      * @description Indicates when this payment voucher occurred date.
+
+      */
+    
     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 voucher was last updated.
+
+      */
+    
     updated_at?:number;
+    
+    /**
+      * @description The unique identifier of the customer.
+
+      */
+    
     customer_id:string;
+    
+    /**
+      * @description Invoices related to the generated voucher
+
+      */
+    
     linked_invoices?:PaymentVoucher.InvoicePaymentVoucher[];
   }
   export namespace PaymentVoucher {
-    export class PaymentVoucherResource {
+    export class PaymentVoucherResource {  
+      /**
+        * @description Retrieves vouchers for a customer in reverse chronological order.
+
+        */
+      
       payment_vouchers_for_customer(customer_id:string, input?:Payment_vouchersForCustomerInputParam):ChargebeeRequest<Payment_vouchersForCustomerResponse>;
+       
+      /**
+        * @description Retrieves vouchers for an invoice in reverse chronological order.
+
+        */
+      
       payment_vouchers_for_invoice(invoice_id:string, input?:Payment_vouchersForInvoiceInputParam):ChargebeeRequest<Payment_vouchersForInvoiceResponse>;
+       
+      /**
+        * @description Retrieves a voucher using the unique &#x60;payment_voucher_id&#x60;.
+
+        */
+      
       retrieve(payment_voucher_id:string):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description Creates a voucher type payment source. If you create this voucher type payment source using customer details, like tax ID, you can then generate a voucher with that payment source.
+
+        */
+      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
     }
-    export interface Payment_vouchersForCustomerResponse {
-      list:{payment_voucher:PaymentVoucher}[];
-      next_offset?:string;
+    export interface Payment_vouchersForCustomerResponse {  
+      /**
+        * @description Retrieves vouchers for a customer in reverse chronological order.
+
+        */
+       
+       list:{payment_voucher:PaymentVoucher}[];
+       
+      /**
+        * @description Retrieves vouchers for a customer in reverse chronological order.
+
+        */
+       
+       next_offset?:string;
     }
     export interface Payment_vouchersForCustomerInputParam {
-      [key : string]: any;
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
       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.
+
+        */
+        
       offset?:string;
+       
+      /**
+        * @description Current status of Payment Voucher.
+
+        */
+        
       status?:{in?:string,is?:'consumed' | 'expired' | 'failure' | 'active',is_not?:'consumed' | 'expired' | 'failure' | 'active',not_in?:string};
+       
+      /**
+        * @description Retrieves vouchers for a customer in reverse chronological order.
+
+        */
+        
       sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
     }
-    export interface Payment_vouchersForInvoiceResponse {
-      list:{payment_voucher:PaymentVoucher}[];
-      next_offset?:string;
+    export interface Payment_vouchersForInvoiceResponse {  
+      /**
+        * @description Retrieves vouchers for an invoice in reverse chronological order.
+
+        */
+       
+       list:{payment_voucher:PaymentVoucher}[];
+       
+      /**
+        * @description Retrieves vouchers for an invoice in reverse chronological order.
+
+        */
+       
+       next_offset?:string;
     }
     export interface Payment_vouchersForInvoiceInputParam {
-      [key : string]: any;
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
       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.
+
+        */
+        
       offset?:string;
+       
+      /**
+        * @description Current status of Payment Voucher.
+
+        */
+        
       status?:{in?:string,is?:'consumed' | 'expired' | 'failure' | 'active',is_not?:'consumed' | 'expired' | 'failure' | 'active',not_in?:string};
+       
+      /**
+        * @description Retrieves vouchers for an invoice in reverse chronological order.
+
+        */
+        
       sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
     }
-    export interface RetrieveResponse {
-      payment_voucher:PaymentVoucher;
+    export interface RetrieveResponse {  
+       payment_voucher:PaymentVoucher;
     }
     
-    export interface CreateResponse {
-      payment_voucher:PaymentVoucher;
+    export interface CreateResponse {  
+       payment_voucher:PaymentVoucher;
     }
     export interface CreateInputParam {
+       
+      /**
+        * @description The unique identifier of the customer for whom you want to create the voucher.
+
+        */
+       
       customer_id:string;
+       
+      /**
+        * @description The identifier of the payment source used for generating the voucher.
+
+        */
+       
       payment_source_id?:string;
+       
+      /**
+        * @description Parameters for voucher_payment_source
+
+        */
+       
       voucher_payment_source?:{voucher_type:VoucherType};
+       
+      /**
+        * @description Parameters for &#x60;invoice_allocations&#x60;
+
+        */
+       
       invoice_allocations?:{invoice_id:string}[];
     }
-    export interface InvoicePaymentVoucher {
+    export interface InvoicePaymentVoucher {  
       invoice_id?:string;
+       
       txn_id?:string;
+       
       applied_at?:number;
     }
   }

package/types/resources/PortalSession.d.ts

@@ -1,54 +1,198 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface PortalSession {
+    
+    /**
+      * @description Unique identifier for the portal session.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description Unique pre-authenticated portal session token to access customer portal directly.
+
+      */
+    
     token:string;
+    
+    /**
+      * @description Unique URL for accessing the customer portal. Once accessed, this cannot be reused.
+
+      */
+    
     access_url:string;
+    
+    /**
+      * @description URL to redirect when the user logs out from the portal.
+
+      */
+    
     redirect_url?:string;
+    
+    /**
+      * @description Indicates the current status of the portal session. \* created - Indicates that the portal session is just created and not yet accessed by the user. \* logged_out - Indicates that the portal session is logged out either by user or via API. \* not_yet_activated - Indicates that the portal session is created and not yet activated for the customer to allow access to your website. This is applicable when you use Chargebee&#x27;s authentication for your website \* activated - Indicates that the portal session is activated for the customer to allow access to your website. This is applicable when you use Chargebee&#x27;s authentication for your website. \* logged_in - Indicates that the portal session URL has been accessed by the user and the session is active.
+
+      */
+    
     status:'not_yet_activated' | 'created' | 'logged_in' | 'logged_out' | 'activated';
+    
+    /**
+      * @description Timestamp indicating when this portal session was generated.
+
+      */
+    
     created_at:number;
+    
+    /**
+      * @description Timestamp indicating when the access URL will expire. Once expired, the URL cannot be used to login into the portal.
+
+      */
+    
     expires_at?:number;
+    
+    /**
+      * @description Identifier of the customer.
+
+      */
+    
     customer_id:string;
+    
+    /**
+      * @description Timestamp indicating when this portal session URL was accessed by the user.
+
+      */
+    
     login_at?:number;
+    
+    /**
+      * @description Timestamp indicating when this portal session was logged out either by user or via API.
+
+      */
+    
     logout_at?:number;
+    
+    /**
+      * @description IP Address from which the portal session URL was accessed.
+
+      */
+    
     login_ipaddress?:string;
+    
+    /**
+      * @description IP Address from which the portal session was logged out either by user or via API.
+
+      */
+    
     logout_ipaddress?:string;
+    
+    /**
+      * @description The list of customers for this session
+
+      */
+    
     linked_customers?:PortalSession.LinkedCustomer[];
   }
   export namespace PortalSession {
-    export class PortalSessionResource {
+    export class PortalSessionResource {  
+      /**
+        * @description Creates a portal session for a customer. The session resource in the response contains the access URL. Forward the customer to that access URL. If you would like to logout the customer later via API call, you need to store the id of the portal session resource returned by this API. While creating a session, you also need to pass the redirect URL to which your customers will be sent to upon logout from the portal UI.
+
+        */
+      
       create(input?:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
+      /**
+        * @description When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:
+
+* **auth_session_id** - this should be sent as part of the endpoint.
+* **auth_session_token** - this should be sent as value for the input parameter **token**.
+
+
+
+**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
+
+        */
+      
       activate(portal_session_id:string, input:ActivateInputParam):ChargebeeRequest<ActivateResponse>;
+       
+      /**
+        * @description Logs out the portal session. Typically this should be called when customers logout of your application.
+
+If this API is called for a Portal Session that currently is in :
+
+* &quot;created&quot; status, the session status will be marked as &quot;logged_out&quot; and the access URL will become invalid.
+* &quot;logged_in&quot; status, the session status will be marked as &quot;logged_out&quot; and customer will not be able to use that session.
+* &quot;logged_out&quot; status, this will return normally without changing any attribute of this resource.
+
+        */
+      
       logout(portal_session_id:string):ChargebeeRequest<LogoutResponse>;
+       
+      /**
+        * @description This API retrieves a portal session using &#x60;portal_session_id&#x60; as a path parameter.
+
+        */
+      
       retrieve(portal_session_id:string):ChargebeeRequest<RetrieveResponse>;
     }
-    export interface CreateResponse {
-      portal_session:PortalSession;
+    export interface CreateResponse {  
+       portal_session:PortalSession;
     }
     export interface CreateInputParam {
+       
+      /**
+        * @description URL to redirect when the user logs out from the portal.
+
+        */
+       
       redirect_url?:string;
+       
+      /**
+        * @description By default access_url redirects the customer to the portal home page. If you would like to redirect the customer to a different URL, you can use this parameter to do so.  
+
+**Note:** This parameter is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
+
+        */
+       
       forward_url?:string;
+       
+      /**
+        * @description Parameters for customer
+
+        */
+       
       customer?:{id:string};
     }
-    export interface ActivateResponse {
-      portal_session:PortalSession;
+    export interface ActivateResponse {  
+       portal_session:PortalSession;
     }
     export interface ActivateInputParam {
+       
+      /**
+        * @description Unique pre-authenticated portal session token to access customer portal directly.
+
+        */
+       
       token:string;
     }
-    export interface LogoutResponse {
-      portal_session:PortalSession;
+    export interface LogoutResponse {  
+       portal_session:PortalSession;
     }
     
-    export interface RetrieveResponse {
-      portal_session:PortalSession;
+    export interface RetrieveResponse {  
+       portal_session:PortalSession;
     }
     
-    export interface LinkedCustomer {
+    export interface LinkedCustomer {  
       customer_id?:string;
+       
       email?:string;
+       
       has_billing_address?:boolean;
+       
       has_payment_method?:boolean;
+       
       has_active_subscription?:boolean;
     }
   }