chargebee 3.12.0 → 3.14.0

package/types/resources/Ramp.d.ts

@@ -19,6 +19,7 @@ declare module 'chargebee' {
     items_to_remove?: string[];
     coupons_to_remove?: string[];
     discounts_to_remove?: string[];
+    contract_term?: Ramp.ContractTerm;
     deleted: boolean;
     status_transition_reason?: Ramp.StatusTransitionReason;
   }
@@ -88,6 +89,13 @@ declare module 'chargebee' {
       billing_cycles?: number;
       service_period_days?: number;
       metered_quantity?: string;
+      charge_once?: boolean;
+      charge_on_option?: 'immediately' | 'on_event';
+      charge_on_event?:
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
     }
     export interface ItemsToUpdate {
       item_price_id: string;
@@ -103,6 +111,13 @@ declare module 'chargebee' {
       billing_cycles?: number;
       service_period_days?: number;
       metered_quantity?: string;
+      charge_once?: boolean;
+      charge_on_option?: 'immediately' | 'on_event';
+      charge_on_event?:
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
     }
     export interface CouponsToAdd {
       coupon_id: string;
@@ -134,6 +149,11 @@ declare module 'chargebee' {
       package_size?: number;
       index: number;
     }
+    export interface ContractTerm {
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+      action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+    }
     export interface StatusTransitionReason {
       code?: string;
       message?: string;
@@ -147,6 +167,7 @@ declare module 'chargebee' {
       coupons_to_remove?: string[];
       discounts_to_remove?: string[];
       items_to_remove?: string[];
+      contract_term?: ContractTermCreateForSubscriptionInputParam;
       items_to_add?: ItemsToAddCreateForSubscriptionInputParam[];
       items_to_update?: ItemsToUpdateCreateForSubscriptionInputParam[];
       item_tiers?: ItemTiersCreateForSubscriptionInputParam[];
@@ -159,6 +180,7 @@ declare module 'chargebee' {
       coupons_to_remove?: string[];
       discounts_to_remove?: string[];
       items_to_remove?: string[];
+      contract_term?: ContractTermUpdateInputParam;
       items_to_add?: ItemsToAddUpdateInputParam[];
       items_to_update?: ItemsToUpdateUpdateInputParam[];
       item_tiers?: ItemTiersUpdateInputParam[];
@@ -176,6 +198,12 @@ declare module 'chargebee' {
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
+    export interface ContractTermCreateForSubscriptionInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+    }
+
     export interface ItemsToAddCreateForSubscriptionInputParam {
       item_price_id: string;
       quantity?: number;
@@ -184,6 +212,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface CouponsToAddCreateForSubscriptionInputParam {
       coupon_id?: string;
@@ -208,6 +239,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsToAddCreateForSubscriptionInputParam {
       apply_on: ApplyOnEnum;
@@ -219,6 +253,12 @@ declare module 'chargebee' {
       included_in_mrr?: boolean;
       item_price_id?: string;
     }
+    export interface ContractTermUpdateInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+    }
+
     export interface ItemsToAddUpdateInputParam {
       item_price_id: string;
       quantity?: number;
@@ -227,6 +267,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface CouponsToAddUpdateInputParam {
       coupon_id?: string;
@@ -251,6 +294,9 @@ declare module 'chargebee' {
       unit_price_in_decimal?: string;
       billing_cycles?: number;
       service_period_days?: number;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsToAddUpdateInputParam {
       apply_on: ApplyOnEnum;

package/types/resources/SalesOrder.d.ts

@@ -0,0 +1,143 @@
+///<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';
+  }
+
+  export namespace SalesOrder {
+    export interface LineItem {
+      id: string;
+      association_id?: string;
+      item_price_id: string;
+      name?: string;
+      quantity: string;
+      unit_price: 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';
+      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;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/Subscription.d.ts

@@ -650,7 +650,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface ReferralInfo {
       referral_code?: string;
@@ -825,6 +824,7 @@ declare module 'chargebee' {
       auto_collection?: AutoCollectionEnum;
       terms_to_charge?: number;
       billing_alignment_mode?: BillingAlignmentModeEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       po_number?: string;
       coupon_ids?: string[];
       payment_source_id?: string;

package/types/resources/SubscriptionEstimate.d.ts

@@ -37,7 +37,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface ContractTerm {
       id: string;

package/types/resources/Transaction.d.ts

@@ -249,6 +249,7 @@ declare module 'chargebee' {
       processor_error_code?: string;
       processor_error_message?: string;
       error_cause_id?: string;
+      processor_advice_code?: string;
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/UsageFile.d.ts

@@ -17,6 +17,8 @@ declare module 'chargebee' {
     processing_completed_at?: number;
     uploaded_by?: string;
     uploaded_at?: number;
+    error_file_path?: string;
+    error_file_url?: string;
     upload_details?: UsageFile.UploadDetail;
   }
 

package/types/resources/UsageReminderInfo.d.ts

@@ -0,0 +1,9 @@
+///<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

@@ -0,0 +1,116 @@
+///<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;
+    }
+  }
+}