chargebee 3.2.1 → 3.4.0

package/esm/util.js

@@ -148,47 +148,52 @@ export function encodeListParams(paramObj) {
     }
     return encodeParams(paramObj);
 }
-export function getHost(env) {
+export function getHost(env, subDomain) {
+    if (subDomain != null) {
+        return env.site + '.' + subDomain + env.hostSuffix;
+    }
     return env.site + env.hostSuffix;
 }
-export function encodeParams(paramObj, serialized, scope, index) {
+export function encodeParams(paramObj, serialized, scope, index, jsonKeys, level = 0) {
     let key, value;
     if (typeof serialized === 'undefined' || serialized === null) {
         serialized = [];
     }
     for (key in paramObj) {
         value = paramObj[key];
+        const originalKey = key;
         if (scope) {
-            key = '' + scope + '[' + key + ']';
+            key = `${scope}[${key}]`;
         }
         if (typeof index !== 'undefined' && index !== null) {
-            key = key + '[' + index + ']';
+            key = `${key}[${index}]`;
+        }
+        if (jsonKeys && jsonKeys[originalKey] === level) {
+            let attrVal = '';
+            if (value !== null) {
+                attrVal = encodeURIComponent(Object.prototype.toString.call(value) === '[object String]'
+                    ? trim(value)
+                    : JSON.stringify(value));
+            }
+            serialized.push(encodeURIComponent(key) + '=' + attrVal);
         }
-        if (isArray(value)) {
+        else if (isArray(value) &&
+            !(jsonKeys && jsonKeys[originalKey] === level)) {
             for (let arrIdx = 0; arrIdx < value.length; arrIdx++) {
                 if (typeof value[arrIdx] === 'object' || isArray(value[arrIdx])) {
-                    encodeParams(value[arrIdx], serialized, key, arrIdx);
+                    encodeParams(value[arrIdx], serialized, key, arrIdx, jsonKeys, level + 1);
                 }
                 else {
                     if (typeof value[arrIdx] !== 'undefined') {
-                        serialized.push(encodeURIComponent(key + '[' + arrIdx + ']') +
+                        serialized.push(encodeURIComponent(`${key}[${arrIdx}]`) +
                             '=' +
                             encodeURIComponent(trim(value[arrIdx]) !== '' ? value[arrIdx] : ''));
                     }
                 }
             }
         }
-        else if (key === 'meta_data' || key === 'metadata') {
-            let attrVal = '';
-            if (value !== null) {
-                attrVal = encodeURIComponent(Object.prototype.toString.call(value) === '[object String]'
-                    ? trim(value)
-                    : JSON.stringify(value));
-            }
-            serialized.push(encodeURIComponent(key) + '=' + attrVal);
-        }
         else if (typeof value === 'object' && !isArray(value)) {
-            encodeParams(value, serialized, key);
+            encodeParams(value, serialized, key, undefined, jsonKeys, level + 1);
         }
         else {
             if (typeof value !== 'undefined') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.2.1",
+  "version": "3.4.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",

package/types/core.d.ts

@@ -9,6 +9,7 @@ declare module 'chargebee' {
   export type ChargebeeResponse<T> = T & {
     headers: { [key: string]: string };
     isIdempotencyReplayed?: boolean | string;
+    httpStatusCode: number | null;
   };
   export type ChargebeeRequestHeader = {
     [key: string]: string | undefined;
@@ -135,7 +136,8 @@ declare module 'chargebee' {
     | 'price_variant'
     | 'omnichannel_subscription'
     | 'omnichannel_subscription_item'
-    | 'omnichannel_transaction';
+    | 'omnichannel_transaction'
+    | 'recorded_purchase';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -324,6 +326,15 @@ declare module 'chargebee' {
     | 'omnichannel_subscription_item_resubscribed'
     | 'omnichannel_subscription_item_upgraded'
     | 'omnichannel_subscription_item_cancelled'
+    | 'omnichannel_subscription_imported'
+    | 'omnichannel_subscription_item_grace_period_started'
+    | 'omnichannel_subscription_item_grace_period_expired'
+    | 'omnichannel_subscription_item_dunning_started'
+    | 'omnichannel_subscription_item_dunning_expired'
+    | 'rule_created'
+    | 'rule_updated'
+    | 'rule_deleted'
+    | 'record_purchase_failed'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -492,6 +503,7 @@ declare module 'chargebee' {
     | 'tiered'
     | 'volume'
     | 'stairstep';
+  type ProductCatalogVersionEnum = 'v1' | 'v2';
   type ProrationTypeEnum = 'full_term' | 'partial_term' | 'none';
   type ReferralSystemEnum =
     | 'referral_candy'

package/types/index.d.ts

@@ -6,6 +6,7 @@
 ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
+///<reference path='./resources/Configuration.d.ts' />
 ///<reference path='./resources/Contact.d.ts' />
 ///<reference path='./resources/ContractTerm.d.ts' />
 ///<reference path='./resources/Coupon.d.ts' />
@@ -64,6 +65,7 @@
 ///<reference path='./resources/Ramp.d.ts' />
 ///<reference path='./resources/RecordedPurchase.d.ts' />
 ///<reference path='./resources/ResourceMigration.d.ts' />
+///<reference path='./resources/Rule.d.ts' />
 ///<reference path='./resources/SiteMigrationDetail.d.ts' />
 ///<reference path='./resources/Subscription.d.ts' />
 ///<reference path='./resources/SubscriptionEntitlement.d.ts' />
@@ -75,6 +77,7 @@
 ///<reference path='./resources/Transaction.d.ts' />
 ///<reference path='./resources/UnbilledCharge.d.ts' />
 ///<reference path='./resources/Usage.d.ts' />
+///<reference path='./resources/UsageEvent.d.ts' />
 ///<reference path='./resources/VirtualBankAccount.d.ts' />
 
 export type Config = {
@@ -123,6 +126,7 @@ declare module 'chargebee' {
     businessEntity: BusinessEntity.BusinessEntityResource;
     card: Card.CardResource;
     comment: Comment.CommentResource;
+    configuration: Configuration.ConfigurationResource;
     coupon: Coupon.CouponResource;
     couponCode: CouponCode.CouponCodeResource;
     couponSet: CouponSet.CouponSetResource;
@@ -161,6 +165,7 @@ declare module 'chargebee' {
     ramp: Ramp.RampResource;
     recordedPurchase: RecordedPurchase.RecordedPurchaseResource;
     resourceMigration: ResourceMigration.ResourceMigrationResource;
+    rule: Rule.RuleResource;
     siteMigrationDetail: SiteMigrationDetail.SiteMigrationDetailResource;
     subscription: Subscription.SubscriptionResource;
     subscriptionEntitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;
@@ -168,6 +173,7 @@ declare module 'chargebee' {
     transaction: Transaction.TransactionResource;
     unbilledCharge: UnbilledCharge.UnbilledChargeResource;
     usage: Usage.UsageResource;
+    usageEvent: UsageEvent.UsageEventResource;
     virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
   }
 }

package/types/resources/AttachedItem.d.ts

@@ -18,6 +18,7 @@ declare module 'chargebee' {
     updated_at?: number;
     channel?: ChannelEnum;
     business_entity_id?: string;
+    deleted: boolean;
   }
 
   export namespace AttachedItem {

package/types/resources/Comment.d.ts

@@ -79,6 +79,7 @@ declare module 'chargebee' {
         | 'omnichannel_subscription'
         | 'omnichannel_subscription_item'
         | 'omnichannel_transaction'
+        | 'recorded_purchase'
         | 'item_family'
         | 'item'
         | 'item_price'

package/types/resources/Configuration.d.ts

@@ -0,0 +1,24 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Configuration {
+    domain?: string;
+    product_catalog_version?: ProductCatalogVersionEnum;
+  }
+
+  export namespace Configuration {
+    export class ConfigurationResource {
+      list(
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface ListResponse {
+      configurations: Configuration[];
+    }
+
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/Coupon.d.ts

@@ -41,6 +41,7 @@ declare module 'chargebee' {
     invoice_notes?: string;
     meta_data?: any;
     coupon_constraints?: Coupon.CouponConstraint[];
+    deleted: boolean;
   }
 
   export namespace Coupon {
@@ -160,10 +161,7 @@ declare module 'chargebee' {
       discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
+      discount_percentage?: number;
       discount_quantity?: number;
       apply_on: 'invoice_amount' | 'each_specified_item';
       duration_type?: 'one_time' | 'forever' | 'limited_period';
@@ -188,10 +186,7 @@ declare module 'chargebee' {
       discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
+      discount_percentage?: number;
       discount_quantity?: number;
       apply_on: 'invoice_amount' | 'each_specified_item';
       duration_type?: 'one_time' | 'forever' | 'limited_period';
@@ -216,10 +211,7 @@ declare module 'chargebee' {
       discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
+      discount_percentage?: number;
       discount_quantity?: number;
       apply_on?: 'invoice_amount' | 'each_specified_item';
       duration_type?: 'one_time' | 'forever' | 'limited_period';
@@ -259,10 +251,7 @@ declare module 'chargebee' {
       discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
       discount_amount?: number;
       currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
+      discount_percentage?: number;
       discount_quantity?: number;
       apply_on?: 'invoice_amount' | 'each_specified_item';
       duration_type?: 'one_time' | 'forever' | 'limited_period';

package/types/resources/CreditNote.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     customer_id: string;
     subscription_id?: string;
     reference_invoice_id?: string;
-    type: 'adjustment' | 'refundable';
+    type: 'adjustment' | 'refundable' | 'store';
     reason_code?:
       | 'write_off'
       | 'subscription_change'
@@ -274,6 +274,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }
@@ -359,6 +360,7 @@ declare module 'chargebee' {
         | 'not_paid'
         | 'voided'
         | 'pending';
+      tax_application?: 'pre_tax' | 'post_tax';
     }
     export interface ShippingAddress {
       first_name?: string;
@@ -408,7 +410,7 @@ declare module 'chargebee' {
       reference_invoice_id?: string;
       customer_id?: string;
       total?: number;
-      type: 'adjustment' | 'refundable';
+      type: 'adjustment' | 'refundable' | 'store';
       reason_code?:
         | 'product_unsatisfactory'
         | 'service_unsatisfactory'
@@ -479,7 +481,7 @@ declare module 'chargebee' {
       customer_id?: string;
       subscription_id?: string;
       reference_invoice_id: string;
-      type: 'adjustment' | 'refundable';
+      type: 'adjustment' | 'refundable' | 'store';
       currency_code?: string;
       create_reason_code: string;
       date: number;

package/types/resources/CreditNoteEstimate.d.ts

@@ -4,7 +4,7 @@
 declare module 'chargebee' {
   export interface CreditNoteEstimate {
     reference_invoice_id: string;
-    type: 'adjustment' | 'refundable';
+    type: 'adjustment' | 'refundable' | 'store';
     price_type: PriceTypeEnum;
     currency_code: string;
     sub_total: number;
@@ -80,6 +80,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/Customer.d.ts

@@ -608,7 +608,6 @@ declare module 'chargebee' {
     export interface MoveInputParam {
       id_at_from_site: string;
       from_site: string;
-      tax_providers_fields?: TaxProvidersFieldsMoveInputParam[];
     }
     export interface ChangeBillingDateInputParam {
       billing_date?: number;
@@ -627,7 +626,6 @@ declare module 'chargebee' {
     export interface MergeInputParam {
       from_customer_id: string;
       to_customer_id: string;
-      tax_providers_fields?: TaxProvidersFieldsMergeInputParam[];
     }
     export interface RelationshipsInputParam {
       parent_id?: string;
@@ -921,16 +919,6 @@ declare module 'chargebee' {
       invoice_id: string;
       allocation_amount?: number;
     }
-    export interface TaxProvidersFieldsMoveInputParam {
-      provider_name?: string;
-      field_id?: string;
-      field_value?: string;
-    }
-    export interface TaxProvidersFieldsMergeInputParam {
-      provider_name?: string;
-      field_id?: string;
-      field_value?: string;
-    }
     export interface ParentAccountAccessRelationshipsInputParam {
       portal_edit_child_subscriptions?: 'yes' | 'view_only' | 'no';
       portal_download_child_invoices?: 'yes' | 'view_only' | 'no';

package/types/resources/DifferentialPrice.d.ts

@@ -17,6 +17,7 @@ declare module 'chargebee' {
     currency_code: string;
     parent_periods?: DifferentialPrice.ParentPeriod[];
     business_entity_id?: string;
+    deleted: boolean;
   }
 
   export namespace DifferentialPrice {

package/types/resources/Event.d.ts

@@ -14,7 +14,8 @@ declare module 'chargebee' {
       | 're_scheduled'
       | 'failed'
       | 'skipped'
-      | 'not_applicable';
+      | 'not_applicable'
+      | 'disabled';
     webhook_failure_reason?: string;
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
@@ -54,7 +55,8 @@ declare module 'chargebee' {
         | 're_scheduled'
         | 'failed'
         | 'skipped'
-        | 'not_applicable';
+        | 'not_applicable'
+        | 'disabled';
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/Feature.d.ts

@@ -3,6 +3,7 @@
 ///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Feature {
+    [key: string]: unknown;
     id: string;
     name: string;
     description?: string;

package/types/resources/GatewayErrorDetail.d.ts

@@ -16,5 +16,6 @@ declare module 'chargebee' {
     recommendation_message?: string;
     processor_error_code?: string;
     processor_error_message?: string;
+    error_cause_id?: string;
   }
 }

package/types/resources/Invoice.d.ts

@@ -54,6 +54,7 @@ declare module 'chargebee' {
     line_item_discounts?: Invoice.LineItemDiscount[];
     taxes?: Invoice.Tax[];
     line_item_taxes?: Invoice.LineItemTax[];
+    line_item_credits?: Invoice.LineItemCredit[];
     line_item_tiers?: Invoice.LineItemTier[];
     linked_payments?: Invoice.LinkedPayment[];
     dunning_attempts?: Invoice.DunningAttempt[];
@@ -519,6 +520,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }
@@ -565,6 +567,11 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
+    export interface LineItemCredit {
+      cn_id: string;
+      applied_amount: number;
+      line_item_id?: string;
+    }
     export interface LineItemTier {
       line_item_id?: string;
       starting_unit: number;
@@ -626,6 +633,7 @@ declare module 'chargebee' {
       cn_create_reason_code?: string;
       cn_date?: number;
       cn_status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
+      tax_application?: 'pre_tax' | 'post_tax';
     }
     export interface AdjustmentCreditNote {
       cn_id: string;

package/types/resources/InvoiceEstimate.d.ts

@@ -16,6 +16,7 @@ declare module 'chargebee' {
     taxes?: InvoiceEstimate.Tax[];
     line_item_taxes?: InvoiceEstimate.LineItemTax[];
     line_item_tiers?: InvoiceEstimate.LineItemTier[];
+    line_item_credits?: InvoiceEstimate.LineItemCredit[];
     line_item_discounts?: InvoiceEstimate.LineItemDiscount[];
     round_off_amount?: number;
     customer_id?: string;
@@ -80,6 +81,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }
@@ -124,6 +126,11 @@ declare module 'chargebee' {
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
     }
+    export interface LineItemCredit {
+      cn_id: string;
+      applied_amount: number;
+      line_item_id?: string;
+    }
     export interface LineItemDiscount {
       line_item_id: string;
       discount_type:

package/types/resources/Item.d.ts

@@ -30,6 +30,7 @@ declare module 'chargebee' {
     bundle_items?: Item.BundleItem[];
     bundle_configuration?: Item.BundleConfiguration;
     metadata?: any;
+    deleted: boolean;
     business_entity_id?: string;
   }
 

package/types/resources/ItemFamily.d.ts

@@ -12,6 +12,7 @@ declare module 'chargebee' {
     updated_at?: number;
     channel?: ChannelEnum;
     business_entity_id?: string;
+    deleted: boolean;
   }
 
   export namespace ItemFamily {

package/types/resources/ItemPrice.d.ts

@@ -48,6 +48,7 @@ declare module 'chargebee' {
     parent_item_id?: string;
     show_description_in_invoices?: boolean;
     show_description_in_quotes?: boolean;
+    deleted: boolean;
     business_entity_id?: string;
   }
 

package/types/resources/OmnichannelSubscription.d.ts

@@ -11,6 +11,7 @@ declare module 'chargebee' {
     created_at: number;
     resource_version?: number;
     omnichannel_subscription_items: OmnichannelSubscriptionItem[];
+    initial_purchase_transaction?: OmnichannelSubscription.OmnichannelTransaction;
   }
 
   export namespace OmnichannelSubscription {
@@ -48,6 +49,18 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface OmnichannelTransaction {
+      id: string;
+      id_at_source: string;
+      app_id: string;
+      price_currency: string;
+      price_units: number;
+      price_nanos: number;
+      type: 'purchase' | 'renewal';
+      transacted_at: number;
+      created_at: number;
+      resource_version?: number;
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -5,7 +5,12 @@ declare module 'chargebee' {
   export interface OmnichannelSubscriptionItem {
     id: string;
     item_id_at_source: string;
-    status: 'active' | 'expired' | 'cancelled';
+    status:
+      | 'active'
+      | 'expired'
+      | 'cancelled'
+      | 'in_dunning'
+      | 'in_grace_period';
     current_term_start?: number;
     current_term_end?: number;
     expired_at?: number;
@@ -14,6 +19,7 @@ declare module 'chargebee' {
     cancellation_reason?:
       | 'customer_cancelled'
       | 'customer_did_not_consent_to_price_increase';
+    grace_period_expires_at?: number;
     resource_version?: number;
   }
 }

package/types/resources/Order.d.ts

@@ -317,7 +317,7 @@ declare module 'chargebee' {
     }
     export interface LinkedCreditNote {
       amount?: number;
-      type: 'adjustment' | 'refundable';
+      type: 'adjustment' | 'refundable' | 'store';
       id: string;
       status: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
       amount_adjusted?: number;

package/types/resources/PriceVariant.d.ts

@@ -15,6 +15,7 @@ declare module 'chargebee' {
     archived_at?: number;
     attributes?: PriceVariant.Attribute[];
     business_entity_id?: string;
+    deleted: boolean;
   }
 
   export namespace PriceVariant {

package/types/resources/Quote.d.ts

@@ -44,6 +44,7 @@ declare module 'chargebee' {
     contract_term_end?: number;
     contract_term_termination_fee?: number;
     business_entity_id?: string;
+    deleted: boolean;
   }
 
   export namespace Quote {
@@ -332,6 +333,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/QuoteLineGroup.d.ts

@@ -84,6 +84,7 @@ declare module 'chargebee' {
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
       coupon_set_code?: string;
     }

package/types/resources/QuotedSubscription.d.ts

@@ -69,6 +69,9 @@ declare module 'chargebee' {
       unit_price?: number;
       unit_price_in_decimal?: string;
       amount?: number;
+      current_term_start?: number;
+      current_term_end?: number;
+      next_billing_at?: number;
       amount_in_decimal?: string;
       billing_period?: number;
       billing_period_unit?: 'day' | 'week' | 'month' | 'year';

package/types/resources/RecordedPurchase.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     customer_id: string;
     app_id: string;
     source: 'apple_app_store';
-    status: 'in_process' | 'completed' | 'failed';
+    status: 'in_process' | 'completed' | 'failed' | 'ignored';
     omnichannel_transaction_id?: string;
     created_at: number;
     resource_version?: number;

package/types/resources/Rule.d.ts

@@ -0,0 +1,33 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Rule {
+    id: string;
+    namespace: string;
+    rule_name: string;
+    rule_order?: number;
+    status: 'active' | 'disabled';
+    conditions?: string;
+    outcome?: string;
+    deleted: boolean;
+    created_at: number;
+    modified_at: number;
+  }
+
+  export namespace Rule {
+    export class RuleResource {
+      retrieve(
+        rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      rule: Rule;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+  }
+}