chargebee 3.11.0 → 3.12.0

package/types/resources/CreditNote.d.ts

@@ -36,7 +36,6 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
-    einvoice?: CreditNote.Einvoice;
     sub_total: number;
     sub_total_in_local_currency?: number;
     total_in_local_currency?: number;
@@ -44,11 +43,13 @@ declare module 'chargebee' {
     round_off_amount?: number;
     fractional_correction?: number;
     line_items?: CreditNote.LineItem[];
-    discounts?: CreditNote.Discount[];
-    line_item_discounts?: CreditNote.LineItemDiscount[];
     line_item_tiers?: CreditNote.LineItemTier[];
-    taxes?: CreditNote.Tax[];
+    line_item_discounts?: CreditNote.LineItemDiscount[];
     line_item_taxes?: CreditNote.LineItemTax[];
+    line_item_addresses?: CreditNote.LineItemAddress[];
+    discounts?: CreditNote.Discount[];
+    taxes?: CreditNote.Tax[];
+    tax_origin?: CreditNote.TaxOrigin;
     linked_refunds?: CreditNote.LinkedRefund[];
     allocations?: CreditNote.Allocation[];
     deleted: boolean;
@@ -59,9 +60,8 @@ declare module 'chargebee' {
     business_entity_id?: string;
     shipping_address?: CreditNote.ShippingAddress;
     billing_address?: CreditNote.BillingAddress;
+    einvoice?: CreditNote.Einvoice;
     site_details_at_creation?: CreditNote.SiteDetailsAtCreation;
-    tax_origin?: CreditNote.TaxOrigin;
-    line_item_addresses?: CreditNote.LineItemAddress[];
   }
 
   export namespace CreditNote {
@@ -206,18 +206,6 @@ declare module 'chargebee' {
       credit_note: CreditNote;
     }
 
-    export interface Einvoice {
-      id: string;
-      reference_number?: string;
-      status:
-        | 'scheduled'
-        | 'skipped'
-        | 'in_progress'
-        | 'success'
-        | 'failed'
-        | 'registered';
-      message?: string;
-    }
     export interface LineItem {
       id?: string;
       subscription_id?: string;
@@ -267,33 +255,6 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
-      entity_id?: string;
-      coupon_set_code?: string;
-    }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      coupon_id?: string;
-      entity_id?: string;
-      discount_amount: number;
-    }
     export interface LineItemTier {
       line_item_id?: string;
       starting_unit: number;
@@ -307,10 +268,18 @@ declare module 'chargebee' {
       pricing_type?: 'per_unit' | 'flat_fee' | 'package';
       package_size?: number;
     }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+    export interface LineItemDiscount {
+      line_item_id: string;
+      discount_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      coupon_id?: string;
+      entity_id?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -337,6 +306,50 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
+    export interface LineItemAddress {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
+      entity_id?: string;
+      coupon_set_code?: string;
+    }
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
+    }
+    export interface TaxOrigin {
+      country?: string;
+      registration_number?: string;
+    }
     export interface LinkedRefund {
       txn_id: string;
       applied_amount: number;
@@ -400,35 +413,22 @@ declare module 'chargebee' {
       zip?: string;
       validation_status?: ValidationStatusEnum;
     }
+    export interface Einvoice {
+      id: string;
+      reference_number?: string;
+      status:
+        | 'scheduled'
+        | 'skipped'
+        | 'in_progress'
+        | 'success'
+        | 'failed'
+        | 'registered';
+      message?: string;
+    }
     export interface SiteDetailsAtCreation {
       timezone?: string;
       organization_address?: object;
     }
-    export interface TaxOrigin {
-      country?: string;
-      registration_number?: string;
-    }
-    export interface LineItemAddress {
-      line_item_id?: string;
-      first_name?: string;
-      last_name?: string;
-      email?: string;
-      company?: string;
-      phone?: string;
-      line1?: string;
-      line2?: string;
-      line3?: string;
-      city?: string;
-      state_code?: string;
-      state?: string;
-      country?: string;
-      zip?: string;
-      validation_status?:
-        | 'not_validated'
-        | 'valid'
-        | 'partially_valid'
-        | 'invalid';
-    }
     // REQUEST PARAMS
     //---------------
 
@@ -543,7 +543,9 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
     }
     export interface LineItemRetrieveInputParam {
@@ -558,6 +560,7 @@ declare module 'chargebee' {
     }
 
     export interface TransactionRecordRefundInputParam {
+      id?: string;
       amount?: number;
       payment_method: PaymentMethodEnum;
       reference_number?: string;
@@ -590,6 +593,7 @@ declare module 'chargebee' {
       amount: number;
     }
     export interface LinkedRefundsImportCreditNoteInputParam {
+      id?: string;
       amount: number;
       payment_method: PaymentMethodEnum;
       date: number;
@@ -640,7 +644,10 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan_setup'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
       item_level_discount1_entity_id?: string;
       item_level_discount1_amount?: number;

package/types/resources/Customer.d.ts

@@ -869,6 +869,7 @@ declare module 'chargebee' {
     }
 
     export interface TransactionRecordExcessPaymentInputParam {
+      id?: string;
       amount: number;
       currency_code?: string;
       date: number;

package/types/resources/CustomerEntitlement.d.ts

@@ -31,6 +31,7 @@ declare module 'chargebee' {
     export interface EntitlementsForCustomerInputParam {
       limit?: number;
       offset?: string;
+      consolidate_entitlements?: boolean;
     }
   }
 }

package/types/resources/Discount.d.ts

@@ -5,9 +5,10 @@ declare module 'chargebee' {
   export interface Discount {
     id: string;
     invoice_name?: string;
-    type: 'fixed_amount' | 'percentage';
+    type: 'fixed_amount' | 'percentage' | 'offer_quantity';
     percentage?: number;
     amount?: number;
+    quantity?: number;
     currency_code?: string;
     duration_type: DurationTypeEnum;
     period?: number;

package/types/resources/Estimate.d.ts

@@ -625,6 +625,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface ItemTiersCreateSubItemEstimateInputParam {
       item_price_id?: string;
@@ -765,6 +766,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface ItemTiersCreateSubItemForCustomerEstimateInputParam {
       item_price_id?: string;
@@ -927,6 +929,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
     }
@@ -1232,6 +1235,7 @@ declare module 'chargebee' {
     export interface DiscountsCreateInvoiceForItemsInputParam {
       percentage?: number;
       amount?: number;
+      quantity?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
     }

package/types/resources/HostedPage.d.ts

@@ -720,6 +720,7 @@ declare module 'chargebee' {
     export interface DiscountsCheckoutOneTimeForItemsInputParam {
       percentage?: number;
       amount?: number;
+      quantity?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
     }
@@ -850,6 +851,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface EntityIdentifiersCheckoutNewForItemsInputParam {
       id?: string;
@@ -985,6 +987,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
     }

package/types/resources/ImpactedCustomer.d.ts

@@ -0,0 +1,19 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface ImpactedCustomer {
+    action_type?: string;
+    download?: ImpactedCustomer.Download;
+  }
+
+  export namespace ImpactedCustomer {
+    export interface Download {
+      download_url: string;
+      valid_till: number;
+      mime_type?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/Invoice.d.ts

@@ -4,8 +4,8 @@
 declare module 'chargebee' {
   export interface Invoice {
     id: string;
-    po_number?: string;
     customer_id: string;
+    payment_owner?: string;
     subscription_id?: string;
     recurring: boolean;
     status:
@@ -15,31 +15,32 @@ declare module 'chargebee' {
       | 'not_paid'
       | 'voided'
       | 'pending';
-    vat_number?: string;
-    price_type: PriceTypeEnum;
     date?: number;
     due_date?: number;
     net_term_days?: number;
+    po_number?: string;
+    vat_number?: string;
+    price_type: PriceTypeEnum;
     exchange_rate?: number;
+    local_currency_exchange_rate?: number;
     currency_code: string;
+    local_currency_code?: string;
+    tax: number;
+    sub_total: number;
+    sub_total_in_local_currency?: number;
     total?: number;
-    amount_paid?: number;
+    total_in_local_currency?: number;
+    amount_due?: number;
     amount_adjusted?: number;
+    amount_paid?: number;
+    paid_at?: number;
     write_off_amount?: number;
     credits_applied?: number;
-    amount_due?: number;
-    paid_at?: number;
     dunning_status?: 'in_progress' | 'exhausted' | 'stopped' | 'success';
     next_retry_at?: number;
     voided_at?: number;
     resource_version?: number;
     updated_at?: number;
-    sub_total: number;
-    sub_total_in_local_currency?: number;
-    total_in_local_currency?: number;
-    local_currency_code?: string;
-    tax: number;
-    local_currency_exchange_rate?: number;
     first_invoice?: boolean;
     new_sales_amount?: number;
     has_advance_charges?: boolean;
@@ -50,12 +51,14 @@ declare module 'chargebee' {
     amount_to_collect?: number;
     round_off_amount?: number;
     line_items?: Invoice.LineItem[];
-    discounts?: Invoice.Discount[];
+    line_item_tiers?: Invoice.LineItemTier[];
     line_item_discounts?: Invoice.LineItemDiscount[];
-    taxes?: Invoice.Tax[];
     line_item_taxes?: Invoice.LineItemTax[];
     line_item_credits?: Invoice.LineItemCredit[];
-    line_item_tiers?: Invoice.LineItemTier[];
+    line_item_addresses?: Invoice.LineItemAddress[];
+    discounts?: Invoice.Discount[];
+    taxes?: Invoice.Tax[];
+    tax_origin?: Invoice.TaxOrigin;
     linked_payments?: Invoice.LinkedPayment[];
     dunning_attempts?: Invoice.DunningAttempt[];
     applied_credits?: Invoice.AppliedCredit[];
@@ -64,10 +67,9 @@ declare module 'chargebee' {
     linked_orders?: Invoice.LinkedOrder[];
     notes?: Invoice.Note[];
     shipping_address?: Invoice.ShippingAddress;
-    statement_descriptor?: Invoice.StatementDescriptor;
     billing_address?: Invoice.BillingAddress;
+    statement_descriptor?: Invoice.StatementDescriptor;
     einvoice?: Invoice.Einvoice;
-    payment_owner?: string;
     void_reason_code?: string;
     deleted: boolean;
     tax_category?: string;
@@ -75,8 +77,6 @@ declare module 'chargebee' {
     channel?: ChannelEnum;
     business_entity_id?: string;
     site_details_at_creation?: Invoice.SiteDetailsAtCreation;
-    tax_origin?: Invoice.TaxOrigin;
-    line_item_addresses?: Invoice.LineItemAddress[];
   }
 
   export namespace Invoice {
@@ -533,19 +533,18 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
-      entity_id?: string;
-      coupon_set_code?: string;
+    export interface LineItemTier {
+      line_item_id?: string;
+      starting_unit: number;
+      ending_unit?: number;
+      quantity_used: number;
+      unit_amount: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      quantity_used_in_decimal?: string;
+      unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface LineItemDiscount {
       line_item_id: string;
@@ -560,11 +559,6 @@ declare module 'chargebee' {
       entity_id?: string;
       discount_amount: number;
     }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
-    }
     export interface LineItemTax {
       line_item_id?: string;
       tax_name: string;
@@ -595,18 +589,49 @@ declare module 'chargebee' {
       applied_amount: number;
       line_item_id?: string;
     }
-    export interface LineItemTier {
+    export interface LineItemAddress {
       line_item_id?: string;
-      starting_unit: number;
-      ending_unit?: number;
-      quantity_used: number;
-      unit_amount: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      quantity_used_in_decimal?: string;
-      unit_amount_in_decimal?: string;
-      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
-      package_size?: number;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
+      entity_id?: string;
+      coupon_set_code?: string;
+    }
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
+    }
+    export interface TaxOrigin {
+      country?: string;
+      registration_number?: string;
     }
     export interface LinkedPayment {
       txn_id: string;
@@ -753,10 +778,6 @@ declare module 'chargebee' {
       validation_status?: ValidationStatusEnum;
       index: number;
     }
-    export interface StatementDescriptor {
-      id: string;
-      descriptor?: string;
-    }
     export interface BillingAddress {
       first_name?: string;
       last_name?: string;
@@ -773,6 +794,10 @@ declare module 'chargebee' {
       zip?: string;
       validation_status?: ValidationStatusEnum;
     }
+    export interface StatementDescriptor {
+      id: string;
+      descriptor?: string;
+    }
     export interface Einvoice {
       id: string;
       reference_number?: string;
@@ -789,31 +814,6 @@ declare module 'chargebee' {
       timezone?: string;
       organization_address?: object;
     }
-    export interface TaxOrigin {
-      country?: string;
-      registration_number?: string;
-    }
-    export interface LineItemAddress {
-      line_item_id?: string;
-      first_name?: string;
-      last_name?: string;
-      email?: string;
-      company?: string;
-      phone?: string;
-      line1?: string;
-      line2?: string;
-      line3?: string;
-      city?: string;
-      state_code?: string;
-      state?: string;
-      country?: string;
-      zip?: string;
-      validation_status?:
-        | 'not_validated'
-        | 'valid'
-        | 'partially_valid'
-        | 'invalid';
-    }
     // REQUEST PARAMS
     //---------------
 
@@ -1421,6 +1421,7 @@ declare module 'chargebee' {
     export interface DiscountsCreateForChargeItemsAndChargesInputParam {
       percentage?: number;
       amount?: number;
+      quantity?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
     }
@@ -1524,7 +1525,9 @@ declare module 'chargebee' {
         | 'coupon'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
       note?: string;
     }
@@ -1540,6 +1543,7 @@ declare module 'chargebee' {
       amount: number;
     }
     export interface PaymentsImportInvoiceInputParam {
+      id?: string;
       amount: number;
       payment_method: PaymentMethodEnum;
       date?: number;
@@ -1606,7 +1610,10 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan_setup'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
       item_level_discount1_entity_id?: string;
       item_level_discount1_amount?: number;

package/types/resources/OmnichannelOneTimeOrder.d.ts

@@ -0,0 +1,62 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface OmnichannelOneTimeOrder {
+    id: string;
+    app_id: string;
+    customer_id?: string;
+    id_at_source: string;
+    origin?: string;
+    source: 'apple_app_store' | 'google_play_store';
+    created_at: number;
+    resource_version?: number;
+    omnichannel_one_time_order_items: OmnichannelOneTimeOrderItem[];
+    purchase_transaction?: OmnichannelOneTimeOrder.OmnichannelTransaction;
+  }
+
+  export namespace OmnichannelOneTimeOrder {
+    export class OmnichannelOneTimeOrderResource {
+      retrieve(
+        omnichannel_one_time_order_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      omnichannel_one_time_order: OmnichannelOneTimeOrder;
+    }
+
+    export interface ListResponse {
+      list: { omnichannel_one_time_order: OmnichannelOneTimeOrder }[];
+      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
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      source?: filter.Enum;
+      customer_id?: filter.String;
+    }
+  }
+}