chargebee 2.40.0 → 3.0.0-beta.1

package/types/index.d.ts

@@ -15,6 +15,7 @@
 ///<reference path='./resources/CreditNoteEstimate.d.ts' />
 ///<reference path='./resources/Currency.d.ts' />
 ///<reference path='./resources/Customer.d.ts' />
+///<reference path='./resources/CustomerEntitlement.d.ts' />
 ///<reference path='./resources/DifferentialPrice.d.ts' />
 ///<reference path='./resources/Discount.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
@@ -42,7 +43,6 @@
 ///<reference path='./resources/ItemFamily.d.ts' />
 ///<reference path='./resources/ItemPrice.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
-///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
 ///<reference path='./resources/PaymentIntent.d.ts' />
 ///<reference path='./resources/PaymentReferenceNumber.d.ts' />
@@ -72,58 +72,95 @@
 ///<reference path='./resources/Usage.d.ts' />
 ///<reference path='./resources/VirtualBankAccount.d.ts' />
 
+export type Config = {
+  /**
+   * @apiKey api key for the site.
+   */
+  apiKey: string;
+  /**
+   * @site api site name.
+   */
+  site: string;
+  /**
+   * @apiPath this value indicates the api version, default value is /api/v2.
+   */
+  apiPath?: '/api/v2' | '/api/v1';
+  /**
+   * @timeout client side request timeout in milliseconds, default value is 80000ms.
+   */
+  timeout?: number;
+  /**
+   * @port url port
+   */
+  port?: number;
+  /**
+   * @timemachineWaitInMillis time interval at which two subsequent retrieve timemachine call in milliseconds, default value is 3000ms.
+   */
+  timemachineWaitInMillis?: number;
+  /**
+   * @exportWaitInMillis time interval at which two subsequent retrieve export call in milliseconds, default value is 3000ms.
+   */
+  exportWaitInMillis?: number;
+  /**
+   * @protocol http protocol, default value is https
+   */
+  protocol?: 'https' | 'http';
+  /**
+   * @hostSuffix url host suffix, default value is .chargebee.com
+   */
+  hostSuffix?: string;
+};
 declare module 'chargebee' {
-  export default class {
-    static configure({ site, api_key }: { site: string; api_key: string });
-    static address: Address.AddressResource;
-    static attached_item: AttachedItem.AttachedItemResource;
-    static business_entity: BusinessEntity.BusinessEntityResource;
-    static card: Card.CardResource;
-    static comment: Comment.CommentResource;
-    static coupon: Coupon.CouponResource;
-    static coupon_code: CouponCode.CouponCodeResource;
-    static coupon_set: CouponSet.CouponSetResource;
-    static credit_note: CreditNote.CreditNoteResource;
-    static currency: Currency.CurrencyResource;
-    static customer: Customer.CustomerResource;
-    static differential_price: DifferentialPrice.DifferentialPriceResource;
-    static entitlement: Entitlement.EntitlementResource;
-    static entitlement_override: EntitlementOverride.EntitlementOverrideResource;
-    static estimate: Estimate.EstimateResource;
-    static event: Event.EventResource;
-    static export: Export.ExportResource;
-    static feature: Feature.FeatureResource;
-    static gift: Gift.GiftResource;
-    static hosted_page: HostedPage.HostedPageResource;
-    static in_app_subscription: InAppSubscription.InAppSubscriptionResource;
-    static installment: Installment.InstallmentResource;
-    static installment_config: InstallmentConfig.InstallmentConfigResource;
-    static invoice: Invoice.InvoiceResource;
-    static item: Item.ItemResource;
-    static item_entitlement: ItemEntitlement.ItemEntitlementResource;
-    static item_family: ItemFamily.ItemFamilyResource;
-    static item_price: ItemPrice.ItemPriceResource;
-    static non_subscription: NonSubscription.NonSubscriptionResource;
-    static order: Order.OrderResource;
-    static payment_intent: PaymentIntent.PaymentIntentResource;
-    static payment_source: PaymentSource.PaymentSourceResource;
-    static payment_voucher: PaymentVoucher.PaymentVoucherResource;
-    static portal_session: PortalSession.PortalSessionResource;
-    static price_variant: PriceVariant.PriceVariantResource;
-    static pricing_page_session: PricingPageSession.PricingPageSessionResource;
-    static promotional_credit: PromotionalCredit.PromotionalCreditResource;
-    static purchase: Purchase.PurchaseResource;
-    static quote: Quote.QuoteResource;
-    static ramp: Ramp.RampResource;
-    static resource_migration: ResourceMigration.ResourceMigrationResource;
-    static site_migration_detail: SiteMigrationDetail.SiteMigrationDetailResource;
-    static subscription: Subscription.SubscriptionResource;
-    static subscription_entitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;
-    static time_machine: TimeMachine.TimeMachineResource;
-    static transaction: Transaction.TransactionResource;
-    static unbilled_charge: UnbilledCharge.UnbilledChargeResource;
-    static usage: Usage.UsageResource;
-    static virtual_bank_account: VirtualBankAccount.VirtualBankAccountResource;
-    
+  export default class Chargebee {
+    constructor(config: Config);
+    address: Address.AddressResource;
+    attachedItem: AttachedItem.AttachedItemResource;
+    businessEntity: BusinessEntity.BusinessEntityResource;
+    card: Card.CardResource;
+    comment: Comment.CommentResource;
+    coupon: Coupon.CouponResource;
+    couponCode: CouponCode.CouponCodeResource;
+    couponSet: CouponSet.CouponSetResource;
+    creditNote: CreditNote.CreditNoteResource;
+    currency: Currency.CurrencyResource;
+    customer: Customer.CustomerResource;
+    customerEntitlement: CustomerEntitlement.CustomerEntitlementResource;
+    differentialPrice: DifferentialPrice.DifferentialPriceResource;
+    entitlement: Entitlement.EntitlementResource;
+    entitlementOverride: EntitlementOverride.EntitlementOverrideResource;
+    estimate: Estimate.EstimateResource;
+    event: Event.EventResource;
+    export: Export.ExportResource;
+    feature: Feature.FeatureResource;
+    gift: Gift.GiftResource;
+    hostedPage: HostedPage.HostedPageResource;
+    inAppSubscription: InAppSubscription.InAppSubscriptionResource;
+    installment: Installment.InstallmentResource;
+    installmentConfig: InstallmentConfig.InstallmentConfigResource;
+    invoice: Invoice.InvoiceResource;
+    item: Item.ItemResource;
+    itemEntitlement: ItemEntitlement.ItemEntitlementResource;
+    itemFamily: ItemFamily.ItemFamilyResource;
+    itemPrice: ItemPrice.ItemPriceResource;
+    order: Order.OrderResource;
+    paymentIntent: PaymentIntent.PaymentIntentResource;
+    paymentSource: PaymentSource.PaymentSourceResource;
+    paymentVoucher: PaymentVoucher.PaymentVoucherResource;
+    portalSession: PortalSession.PortalSessionResource;
+    priceVariant: PriceVariant.PriceVariantResource;
+    pricingPageSession: PricingPageSession.PricingPageSessionResource;
+    promotionalCredit: PromotionalCredit.PromotionalCreditResource;
+    purchase: Purchase.PurchaseResource;
+    quote: Quote.QuoteResource;
+    ramp: Ramp.RampResource;
+    resourceMigration: ResourceMigration.ResourceMigrationResource;
+    siteMigrationDetail: SiteMigrationDetail.SiteMigrationDetailResource;
+    subscription: Subscription.SubscriptionResource;
+    subscriptionEntitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;
+    timeMachine: TimeMachine.TimeMachineResource;
+    transaction: Transaction.TransactionResource;
+    unbilledCharge: UnbilledCharge.UnbilledChargeResource;
+    usage: Usage.UsageResource;
+    virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
   }
-}
+}

package/types/resources/Address.d.ts

@@ -1,286 +1,71 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface Address {
-    
-    /**
-      * @description Label to identify the address. This is unique for all the address for a subscription.
-
-      */
-    
-    label:string;
-    
-    /**
-      * @description First name
-
-      */
-    
-    first_name?:string;
-    
-    /**
-      * @description Last name
-
-      */
-    
-    last_name?:string;
-    
-    /**
-      * @description Email
-
-      */
-    
-    email?:string;
-    
-    /**
-      * @description Company name
-
-      */
-    
-    company?:string;
-    
-    /**
-      * @description Phone number
-
-      */
-    
-    phone?:string;
-    
-    /**
-      * @description Address line 1
-
-      */
-    
-    addr?:string;
-    
-    /**
-      * @description Address line 2
-
-      */
-    
-    extended_addr?:string;
-    
-    /**
-      * @description Address line 3
-
-      */
-    
-    extended_addr2?:string;
-    
-    /**
-      * @description Name of the city
-
-      */
-    
-    city?:string;
-    
-    /**
-      * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
-
-      */
-    
-    state_code?:string;
-    
-    /**
-      * @description State or Province
-
-      */
-    
-    state?:string;
-    
-    /**
-      * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).   
-
-**Note** : If you enter an invalid country code, the system will return an error.  
-
-**Brexit**
-
-
-If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
-
-      */
-    
-    country?:string;
-    
-    /**
-      * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
-
-      */
-    
-    zip?:string;
-    
-    /**
-      * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
-
-      */
-    
-    validation_status?:ValidationStatus;
-    
-    /**
-      * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
-
-      */
-    
-    subscription_id:string;
+    label: string;
+    first_name?: string;
+    last_name?: string;
+    email?: string;
+    company?: string;
+    phone?: string;
+    addr?: string;
+    extended_addr?: string;
+    extended_addr2?: string;
+    city?: string;
+    state_code?: string;
+    state?: string;
+    country?: string;
+    zip?: string;
+    validation_status?: ValidationStatus;
+    subscription_id: string;
   }
-  export namespace Address {
-    export class AddressResource {  
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
 
-        */
-      
-      retrieve(input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
+  export namespace Address {
+    export class AddressResource {
+      retrieve(
+        input: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+    }
 
-        */
-      
-      update(input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+    export interface RetrieveResponse {
+      address: Address;
     }
-    export interface RetrieveResponse {  
-       address:Address;
+
+    export interface UpdateResponse {
+      address: Address;
     }
-    export interface RetrieveInputParam {
-       
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
 
-        */
-        
-      subscription_id:string;
-       
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
+    // REQUEST PARAMS
+    //---------------
 
-        */
-        
-      label:string;
-    }
-    export interface UpdateResponse {  
-       address:Address;
+    export interface RetrieveInputParam {
+      subscription_id: string;
+      label: string;
     }
     export interface UpdateInputParam {
-       
-      /**
-        * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
-
-        */
-       
-      subscription_id:string;
-       
-      /**
-        * @description Label to identify the address. This is unique for all the address for a subscription.
-
-        */
-       
-      label:string;
-       
-      /**
-        * @description First name.
-
-        */
-       
-      first_name?:string;
-       
-      /**
-        * @description Last name.
-
-        */
-       
-      last_name?:string;
-       
-      /**
-        * @description Email.
-
-        */
-       
-      email?:string;
-       
-      /**
-        * @description Company name.
-
-        */
-       
-      company?:string;
-       
-      /**
-        * @description Phone number.
-
-        */
-       
-      phone?:string;
-       
-      /**
-        * @description Address line 1.
-
-        */
-       
-      addr?:string;
-       
-      /**
-        * @description Address line 2.
-
-        */
-       
-      extended_addr?:string;
-       
-      /**
-        * @description Address line 3.
-
-        */
-       
-      extended_addr2?:string;
-       
-      /**
-        * @description Name of the city.
-
-        */
-       
-      city?:string;
-       
-      /**
-        * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
-
-        */
-       
-      state_code?:string;
-       
-      /**
-        * @description The state/province name. Is set by Chargebee automatically for US, Canada and India If &#x60;state_code&#x60; is provided.
-
-        */
-       
-      state?:string;
-       
-      /**
-        * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
-
-        */
-       
-      zip?:string;
-       
-      /**
-        * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).   
-
-**Note** : If you enter an invalid country code, the system will return an error.  
-
-**Brexit**
-
-
-If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
-.
-
-        */
-       
-      country?:string;
-       
-      /**
-        * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
-
-        */
-       
-      validation_status?:ValidationStatus;
+      subscription_id: string;
+      label: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      addr?: string;
+      extended_addr?: string;
+      extended_addr2?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
     }
-    
   }
-}
+}

package/types/resources/AdvanceInvoiceSchedule.d.ts

@@ -1,102 +1,29 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface AdvanceInvoiceSchedule {
-    
-    /**
-      * @description System-generated and immutable unique Id for the &#x60;advance_invoice_schedule&#x60;.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description The type of advance invoice or advance invoicing schedule. \* specific_dates - The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](advance_invoice_schedules#advance_invoice_schedule_specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured. \* fixed_intervals - The advance charges occur at [fixed intervals of time](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_terms_to_charge).
-
-      */
-    
-    schedule_type?:'specific_dates' | 'fixed_intervals';
-    
-    /**
-      * @description When the &#x60;schedule_type&#x60; is &#x60;fixed_intervals&#x60;, this object gives further details of the schedule.
-
-      */
-    
-    fixed_interval_schedule?:AdvanceInvoiceSchedule.FixedIntervalSchedule;
-    
-    /**
-      * @description The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](advance_invoice_schedules#advance_invoice_schedule_specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured.
-
-      */
-    
-    specific_dates_schedule?:AdvanceInvoiceSchedule.SpecificDatesSchedule;
+    id: string;
+    schedule_type?: 'fixed_intervals' | 'specific_dates';
+    fixed_interval_schedule?: AdvanceInvoiceSchedule.FixedIntervalSchedule;
+    specific_dates_schedule?: AdvanceInvoiceSchedule.SpecificDatesSchedule;
   }
-  export namespace AdvanceInvoiceSchedule {
-    
-    
-    export interface FixedIntervalSchedule {  
-         /**
-          * @description Specifies when the schedule should end. \* after_number_of_intervals - Advance invoices are generated a &#x60;specified number of times&#x60; \* subscription_end - Advance invoices are generated for as long as the subscription is active. \* specific_date - End the advance invoicing schedule on a &#x60;specific date&#x60;.
-
-          */
-       
-      end_schedule_on?:EndScheduleOn;
-       
-         /**
-          * @description The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the [&#x60;remaining_billing_cycles&#x60;](subscriptions#subscription_remaining_billing_cycles) of the subscription. This parameter is applicable only when [&#x60;fixed_interval_schedule[end_schedule_on]&#x60;](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_end_schedule_on) &#x3D; &#x60;after_number_of_intervals&#x60;
-
-          */
-       
-      number_of_occurrences?:number;
-       
-         /**
-          * @description The number of days before each interval that advance invoices are generated.
 
-          */
-       
-      days_before_renewal?:number;
-       
-         /**
-          * @description The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when [&#x60;fixed_interval_schedule[end_schedule_on]&#x60;](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_end_schedule_on) &#x3D; &#x60;specific_date&#x60;.
-
-          */
-       
-      end_date?:number;
-       
-         /**
-          * @description The date when this advance invoicing schedule was created.
-
-          */
-       
-      created_at?:number;
-       
-         /**
-          * @description The number of billing cycles in one interval.
-
-          */
-       
-      terms_to_charge?:number;
+  export namespace AdvanceInvoiceSchedule {
+    export interface FixedIntervalSchedule {
+      end_schedule_on?: EndScheduleOn;
+      number_of_occurrences?: number;
+      days_before_renewal?: number;
+      end_date?: number;
+      created_at: number;
+      terms_to_charge?: number;
     }
-    export interface SpecificDatesSchedule {  
-         /**
-          * @description The number of billing cycles to charge for, on the date specified. Applicable only when [&#x60;schedule_type&#x60;](advance_invoice_schedules#advance_invoice_schedule_schedule_type) is specific_dates.
-
-          */
-       
-      terms_to_charge?:number;
-       
-         /**
-          * @description The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when [&#x60;schedule_type&#x60;](advance_invoice_schedules#advance_invoice_schedule_schedule_type) is &#x60;specific_dates&#x60;.
-
-          */
-       
-      date?:number;
-       
-         /**
-          * @description The date when this advance invoicing schedule was created.
-
-          */
-       
-      created_at?:number;
+    export interface SpecificDatesSchedule {
+      terms_to_charge?: number;
+      date?: number;
+      created_at: number;
     }
+    // REQUEST PARAMS
+    //---------------
   }
-}
+}