chargebee 3.19.0 → 3.21.0

package/types/resources/Subscription.d.ts

@@ -96,6 +96,7 @@ declare module 'chargebee' {
     auto_close_invoices?: boolean;
     discounts?: Subscription.Discount[];
     business_entity_id?: string;
+    decommissioned: boolean;
   }
 
   export namespace Subscription {
@@ -1268,6 +1269,7 @@ declare module 'chargebee' {
       contract_term_cancel_option?: ContractTermCancelOptionEnum;
       invoice_date?: number;
       cancel_reason_code?: string;
+      decommissioned?: boolean;
       subscription_items?: SubscriptionItemsCancelForItemsInputParam[];
     }
     export interface ResumeInputParam {
@@ -1410,7 +1412,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1543,7 +1551,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1643,7 +1657,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1798,7 +1818,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1967,7 +1993,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2092,7 +2124,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2523,7 +2561,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/WebhookEvent.d.ts

@@ -106,6 +106,7 @@ declare module 'chargebee' {
     CardUpdated = 'card_updated',
     CustomerCreated = 'customer_created',
     SubscriptionRenewalReminder = 'subscription_renewal_reminder',
+    PaymentDueReminder = 'payment_due_reminder',
     OrderDelivered = 'order_delivered',
     OmnichannelSubscriptionItemCancellationScheduled = 'omnichannel_subscription_item_cancellation_scheduled',
     OmnichannelSubscriptionItemGracePeriodExpired = 'omnichannel_subscription_item_grace_period_expired',
@@ -220,9 +221,9 @@ declare module 'chargebee' {
     PlanCreated = 'plan_created',
     PlanUpdated = 'plan_updated',
   }
-
   /**
-   * @deprecated Use WebhookEventType instead.
+   * @deprecated Renamed to `WebhookEventType` for clarity. Use `WebhookEventType` instead.
+   * This alias will be removed in the next major version.
    */
   export import WebhookContentType = WebhookEventType;
 
@@ -329,6 +330,7 @@ declare module 'chargebee' {
     [WebhookEventType.CardUpdated]: CardUpdatedContent;
     [WebhookEventType.CustomerCreated]: CustomerCreatedContent;
     [WebhookEventType.SubscriptionRenewalReminder]: SubscriptionRenewalReminderContent;
+    [WebhookEventType.PaymentDueReminder]: PaymentDueReminderContent;
     [WebhookEventType.OrderDelivered]: OrderDeliveredContent;
     [WebhookEventType.OmnichannelSubscriptionItemCancellationScheduled]: OmnichannelSubscriptionItemCancellationScheduledContent;
     [WebhookEventType.OmnichannelSubscriptionItemGracePeriodExpired]: OmnichannelSubscriptionItemGracePeriodExpiredContent;
@@ -477,8 +479,6 @@ declare module 'chargebee' {
     advance_invoice_schedule: AdvanceInvoiceSchedule;
   };
   export type CustomerBusinessEntityChangedContent = {
-    business_entity_change: BusinessEntityChange;
-
     business_entity_transfer: BusinessEntityTransfer;
 
     customer: Customer;
@@ -657,8 +657,6 @@ declare module 'chargebee' {
     subscription: Subscription;
 
     customer: Customer;
-
-    usage_reminder_info: UsageReminderInfo;
   };
   export type VoucherCreatedContent = {
     payment_voucher: PaymentVoucher;
@@ -1051,6 +1049,11 @@ declare module 'chargebee' {
 
     advance_invoice_schedule: AdvanceInvoiceSchedule;
   };
+  export type PaymentDueReminderContent = {
+    customer: Customer;
+
+    invoice: Invoice;
+  };
   export type OrderDeliveredContent = {
     order: Order;
   };
@@ -1115,8 +1118,6 @@ declare module 'chargebee' {
     customer: Customer;
   };
   export type SubscriptionBusinessEntityChangedContent = {
-    business_entity_change: BusinessEntityChange;
-
     business_entity_transfer: BusinessEntityTransfer;
 
     subscription: Subscription;
@@ -1364,9 +1365,7 @@ declare module 'chargebee' {
   export type AttachedItemCreatedContent = {
     attached_item: AttachedItem;
   };
-  export type SalesOrderCreatedContent = {
-    sales_order: SalesOrder;
-  };
+  export type SalesOrderCreatedContent = {};
   export type CustomerChangedContent = {
     customer: Customer;
 
@@ -1596,9 +1595,7 @@ declare module 'chargebee' {
 
     impacted_subscription: ImpactedSubscription;
   };
-  export type SalesOrderUpdatedContent = {
-    sales_order: SalesOrder;
-  };
+  export type SalesOrderUpdatedContent = {};
   export type OmnichannelSubscriptionItemDunningStartedContent = {
     omnichannel_subscription: OmnichannelSubscription;
 

package/types/resources/BusinessEntityChange.d.ts

@@ -1,16 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface BusinessEntityChange {
-    id: string;
-    business_entity_id: string;
-    reason?: 'correction';
-    active_from: number;
-    active_to?: number;
-    resource_type: 'customer' | 'subscription';
-    modified_at: number;
-    resource_id: string;
-    active_resource_id: string;
-  }
-}

package/types/resources/Product.d.ts

@@ -1,135 +0,0 @@
-///<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/SalesOrder.d.ts

@@ -1,153 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface SalesOrder {
-    id: string;
-    version: number;
-    renewed_from_order_id?: string;
-    updated_at?: number;
-    created_at: number;
-    po_number?: string;
-    meta_data?: string;
-    quote_id?: string;
-    effective_date: number;
-    end_date?: number;
-    business_entity_id?: string;
-    customer_id: string;
-    subscription_id: string;
-    currency_code: string;
-    line_items?: SalesOrder.LineItem[];
-    billing_addresses?: SalesOrder.BillingAddress[];
-    discounts?: SalesOrder.Discount[];
-    shipping_addresses?: SalesOrder.ShippingAddress[];
-    subscription_ids?: string[];
-    line_item_tiers?: SalesOrder.LineItemTier[];
-    payment_configuration?: SalesOrder.PaymentConfiguration;
-    billing_configuration?: SalesOrder.BillingConfiguration;
-    renewal_term?: SalesOrder.RenewalTerm;
-    status: 'active' | 'completed';
-    credit_lines?: SalesOrder.CreditLine[];
-    deleted: boolean;
-  }
-
-  export namespace SalesOrder {
-    export interface LineItem {
-      id: string;
-      association_id?: string;
-      item_price_id: string;
-      name?: string;
-      quantity: string;
-      unit_price: string;
-      billable_unit_price?: string;
-      billable_quantity?: string;
-      billable_amount?: string;
-      billing_period?: number;
-      billing_period_unit?: 'day' | 'week' | 'month' | 'year';
-      service_period_days?: number;
-      charge_on_event?:
-        | 'subscription_creation'
-        | 'subscription_trial_start'
-        | 'plan_activation'
-        | 'subscription_activation'
-        | 'contract_termination';
-      charge_once?: boolean;
-      billing_cycles?: number;
-      billing_type: 'recurring' | 'one_time' | 'event_based';
-      start_date: number;
-      end_date?: number;
-      trial_end?: number;
-    }
-    export interface BillingAddress {
-      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 {
-      id: string;
-      invoice_name?: string;
-      type: 'fixed_amount' | 'percentage' | 'offer_quantity';
-      apply_on: 'invoice_amount' | 'specific_item_price';
-      duration_type: 'one_time' | 'forever' | 'limited_period';
-      percentage?: number;
-      amount?: string;
-      coupon_id?: string;
-      period?: number;
-      period_unit?: 'day' | 'week' | 'month' | 'year';
-      item_price_id?: string;
-      start_date: number;
-      end_date?: number;
-    }
-    export interface ShippingAddress {
-      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 LineItemTier {
-      starting_unit: string;
-      ending_unit?: string;
-      price: string;
-      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
-      package_size?: number;
-      line_item_association_id?: string;
-    }
-    export interface PaymentConfiguration {
-      auto_collection?: AutoCollectionEnum;
-      payment_source_id?: string;
-      payment_intent_id?: string;
-      offline_payment_method?: OfflinePaymentMethodEnum;
-    }
-    export interface BillingConfiguration {
-      create_pending_invoices?: boolean;
-      invoice_immediately?: boolean;
-      first_invoice_pending?: boolean;
-      invoice_usages?: boolean;
-      net_term_days?: number;
-      invoice_date?: number;
-      billing_cycles_to_invoice?: number;
-      billing_alignment_mode?: BillingAlignmentModeEnum;
-    }
-    export interface RenewalTerm {
-      end_of_term_action: 'renew' | 'cancel' | 'evergreen';
-      cancellation_cutoff_period?: number;
-      renewal_billing_cycles?: number;
-    }
-    export interface CreditLine {
-      amount: string;
-      unit_price: string;
-      line_item_association_id?: string;
-    }
-    // REQUEST PARAMS
-    //---------------
-  }
-}

package/types/resources/UsageReminderInfo.d.ts

@@ -1,9 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface UsageReminderInfo {
-    usage_date_start?: number;
-    usage_date_end?: number;
-  }
-}

package/types/resources/Variant.d.ts

@@ -1,116 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface Variant {
-    id?: string;
-    name: string;
-    external_name?: string;
-    description?: string;
-    sku?: string;
-    deleted: boolean;
-    product_id: string;
-    status?: 'active' | 'inactive';
-    created_at: number;
-    resource_version?: number;
-    updated_at?: number;
-    option_values?: Variant.OptionValue[];
-    metadata?: any;
-  }
-
-  export namespace Variant {
-    export class VariantResource {
-      createProductVariant(
-        product_id: string,
-        input: CreateProductVariantInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateProductVariantResponse>>;
-
-      retrieve(
-        product_variant_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      update(
-        product_variant_id: string,
-        input?: UpdateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateResponse>>;
-
-      delete(
-        product_variant_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-
-      listProductVariants(
-        product_id: string,
-        input?: ListProductVariantsInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListProductVariantsResponse>>;
-    }
-
-    export interface CreateProductVariantResponse {
-      variant: Variant;
-    }
-
-    export interface RetrieveResponse {
-      variant: Variant;
-    }
-
-    export interface UpdateResponse {
-      variant: Variant;
-    }
-
-    export interface DeleteResponse {
-      variant: Variant;
-    }
-
-    export interface ListProductVariantsResponse {
-      list: { variant: Variant }[];
-      next_offset?: string;
-    }
-
-    export interface OptionValue {
-      name?: string;
-      value?: string;
-    }
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateProductVariantInputParam {
-      id?: string;
-      name: string;
-      external_name?: string;
-      description?: string;
-      sku?: string;
-      metadata?: any;
-      status?: 'active' | 'inactive';
-      option_values?: OptionValuesCreateProductVariantInputParam[];
-    }
-    export interface UpdateInputParam {
-      name?: string;
-      description?: string;
-      status?: 'active' | 'inactive';
-      external_name?: string;
-      sku?: string;
-      metadata?: any;
-    }
-    export interface ListProductVariantsInputParam {
-      limit?: number;
-      offset?: string;
-      include_deleted?: boolean;
-      id?: filter.String;
-      name?: filter.String;
-      sku?: filter.String;
-      status?: filter.Enum;
-      updated_at?: filter.Timestamp;
-      created_at?: filter.Timestamp;
-      'sort_by[asc]'?: string;
-      'sort_by[desc]'?: string;
-    }
-    export interface OptionValuesCreateProductVariantInputParam {
-      name: string;
-      value: string;
-    }
-  }
-}