chargebee 3.12.0-beta.1 → 3.13.0

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;
+    }
+  }
+}

package/types/resources/OmnichannelOneTimeOrderItem.d.ts

@@ -0,0 +1,20 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelOneTimeOrderItem {
+    id: string;
+    item_id_at_source: string;
+    item_type_at_source?: string;
+    quantity?: number;
+    cancelled_at?: number;
+    cancellation_reason?:
+      | 'customer_cancelled'
+      | 'customer_did_not_consent_to_price_increase'
+      | 'refunded_due_to_app_issue'
+      | 'refunded_for_other_reason'
+      | 'merchant_revoked';
+    created_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts

@@ -6,7 +6,7 @@ declare module 'chargebee' {
     id?: string;
     omnichannel_subscription_item_id?: string;
     scheduled_at: number;
-    change_type: 'downgrade';
+    change_type: 'downgrade' | 'pause';
     created_at: number;
     modified_at: number;
     resource_version?: number;

package/types/resources/PricingPageSession.d.ts

@@ -106,6 +106,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       label?: string;
     }
     export interface PricingPageCreateForExistingSubscriptionInputParam {
@@ -124,6 +125,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       label?: string;
     }
   }

package/types/resources/Product.d.ts

@@ -0,0 +1,135 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Product {
+    id: string;
+    name: string;
+    external_name: string;
+    description?: string;
+    has_variant: boolean;
+    status: 'active' | 'inactive';
+    shippable: boolean;
+    sku?: string;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    deleted: boolean;
+    options?: Product.Option[];
+    metadata?: any;
+  }
+
+  export namespace Product {
+    export class ProductResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        product_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        product_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        product_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      updateOptions(
+        product_id: string,
+        input: UpdateOptionsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateOptionsResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      product: Product;
+    }
+
+    export interface RetrieveResponse {
+      product: Product;
+    }
+
+    export interface UpdateResponse {
+      product: Product;
+    }
+
+    export interface DeleteResponse {
+      product: Product;
+    }
+
+    export interface UpdateOptionsResponse {
+      product: Product;
+    }
+
+    export interface ListResponse {
+      list: { product: Product }[];
+      next_offset?: string;
+    }
+
+    export interface Option {
+      id?: string;
+      name?: string;
+      values?: any[];
+      default_value?: string;
+      type?: 'select';
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      name: string;
+      external_name: string;
+      status: 'active' | 'inactive';
+      id?: string;
+      description?: string;
+      sku?: string;
+      metadata?: any;
+      shippable?: boolean;
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      external_name?: string;
+      description?: string;
+      status?: 'active' | 'inactive';
+      sku?: string;
+      shippable?: boolean;
+      metadata?: any;
+    }
+    export interface UpdateOptionsInputParam {
+      remove_options?: string[];
+      options?: OptionsUpdateOptionsInputParam[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      include_deleted?: boolean;
+      id?: filter.String;
+      name?: filter.String;
+      status?: filter.Enum;
+      shippable?: filter.Boolean;
+      has_variant?: filter.Boolean;
+      created_at?: filter.Timestamp;
+      updated_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface OptionsUpdateOptionsInputParam {
+      name: string;
+      values?: any;
+      default_value?: string;
+    }
+  }
+}

package/types/resources/PromotionalCredit.d.ts

@@ -15,6 +15,7 @@ declare module 'chargebee' {
     closing_balance: number;
     done_by?: string;
     created_at: number;
+    business_entity_id?: string;
   }
 
   export namespace PromotionalCredit {

package/types/resources/Purchase.d.ts

@@ -126,6 +126,7 @@ declare module 'chargebee' {
       index?: number;
       coupon_id?: string;
       percentage?: number;
+      quantity?: number;
       amount?: number;
       included_in_mrr?: boolean;
     }
@@ -199,6 +200,7 @@ declare module 'chargebee' {
       index?: number;
       coupon_id?: string;
       percentage?: number;
+      quantity?: number;
       amount?: number;
       included_in_mrr?: boolean;
     }

package/types/resources/Quote.d.ts

@@ -1150,6 +1150,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       start_date?: number;
       end_date?: number;
     }
@@ -1247,6 +1248,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       start_date?: number;
       end_date?: number;
     }
@@ -1354,6 +1356,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
       start_date?: number;
@@ -1462,6 +1465,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
       start_date?: number;
@@ -1528,6 +1532,7 @@ declare module 'chargebee' {
     }
     export interface DiscountsCreateForChargeItemsAndChargesInputParam {
       percentage?: number;
+      quantity?: number;
       amount?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
@@ -1600,6 +1605,7 @@ declare module 'chargebee' {
     }
     export interface DiscountsEditForChargeItemsAndChargesInputParam {
       percentage?: number;
+      quantity?: number;
       amount?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;

package/types/resources/QuotedCharge.d.ts

@@ -8,6 +8,7 @@ declare module 'chargebee' {
     invoice_items?: QuotedCharge.InvoiceItem[];
     item_tiers?: QuotedCharge.ItemTier[];
     coupons?: QuotedCharge.Coupon[];
+    coupon_applicability_mappings?: QuotedCharge.CouponApplicabilityMapping[];
   }
 
   export namespace QuotedCharge {
@@ -52,6 +53,10 @@ declare module 'chargebee' {
     export interface Coupon {
       coupon_id: string;
     }
+    export interface CouponApplicabilityMapping {
+      coupon_id?: string;
+      applicable_item_price_ids?: string[];
+    }
     // REQUEST PARAMS
     //---------------
   }

package/types/resources/RecordedPurchase.d.ts

@@ -12,6 +12,7 @@ declare module 'chargebee' {
     created_at: number;
     resource_version?: number;
     linked_omnichannel_subscriptions?: RecordedPurchase.LinkedOmnichannelSubscription[];
+    linked_omnichannel_one_time_orders?: RecordedPurchase.LinkedOmnichannelOneTimeOrder[];
     error_detail?: RecordedPurchase.ErrorDetail;
   }
 
@@ -40,6 +41,9 @@ declare module 'chargebee' {
     export interface LinkedOmnichannelSubscription {
       omnichannel_subscription_id?: string;
     }
+    export interface LinkedOmnichannelOneTimeOrder {
+      omnichannel_one_time_order_id?: string;
+    }
     export interface ErrorDetail {
       error_message?: string;
     }
@@ -58,6 +62,8 @@ declare module 'chargebee' {
     }
     export interface GooglePlayStoreCreateInputParam {
       purchase_token?: string;
+      product_id?: string;
+      order_id?: string;
     }
     export interface AppleAppStoreCreateInputParam {
       transaction_id?: string;