chargebee 3.0.0-beta.4 → 3.0.0

package/types/resources/QuoteLineGroup.d.ts

@@ -1,136 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface QuoteLineGroup {
-    version?: number;
-    id?: string;
-    sub_total: number;
-    total?: number;
-    credits_applied?: number;
-    amount_paid?: number;
-    amount_due?: number;
-    charge_event?:
-      | 'immediate'
-      | 'subscription_creation'
-      | 'trial_start'
-      | 'subscription_change'
-      | 'subscription_renewal'
-      | 'subscription_cancel';
-    billing_cycle_number?: number;
-    line_items?: QuoteLineGroup.LineItem[];
-    discounts?: QuoteLineGroup.Discount[];
-    line_item_discounts?: QuoteLineGroup.LineItemDiscount[];
-    taxes?: QuoteLineGroup.Tax[];
-    line_item_taxes?: QuoteLineGroup.LineItemTax[];
-  }
-
-  export namespace QuoteLineGroup {
-    export interface LineItem {
-      id?: string;
-      subscription_id?: string;
-      date_from: number;
-      date_to: number;
-      unit_amount: number;
-      quantity?: number;
-      amount?: number;
-      pricing_model?:
-        | 'flat_fee'
-        | 'per_unit'
-        | 'tiered'
-        | 'volume'
-        | 'stairstep';
-      is_taxed: boolean;
-      tax_amount?: number;
-      tax_rate?: number;
-      unit_amount_in_decimal?: string;
-      quantity_in_decimal?: string;
-      amount_in_decimal?: string;
-      discount_amount?: number;
-      item_level_discount_amount?: number;
-      usage_percentage?: string;
-      reference_line_item_id?: string;
-      description: string;
-      entity_description?: string;
-      entity_type:
-        | 'adhoc'
-        | 'plan_item_price'
-        | 'addon_item_price'
-        | 'charge_item_price'
-        | 'plan_setup'
-        | 'plan'
-        | 'addon';
-      tax_exempt_reason?:
-        | 'tax_not_configured'
-        | 'region_non_taxable'
-        | 'export'
-        | 'customer_exempt'
-        | 'product_exempt'
-        | 'zero_rated'
-        | 'reverse_charge'
-        | 'high_value_physical_goods'
-        | 'zero_value_item'
-        | 'tax_not_configured_external_provider';
-      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';
-      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 Tax {
-      name: string;
-      amount: number;
-      description?: string;
-    }
-    export interface LineItemTax {
-      line_item_id?: string;
-      tax_name: string;
-      tax_rate: number;
-      date_to?: number;
-      date_from?: number;
-      prorated_taxable_amount?: number;
-      is_partial_tax_applied?: boolean;
-      is_non_compliance_tax?: boolean;
-      taxable_amount: number;
-      tax_amount: number;
-      tax_juris_type?:
-        | 'country'
-        | 'federal'
-        | 'state'
-        | 'county'
-        | 'city'
-        | 'special'
-        | 'unincorporated'
-        | 'other';
-      tax_juris_name?: string;
-      tax_juris_code?: string;
-      tax_amount_in_local_currency?: number;
-      local_currency_code?: string;
-    }
-    // REQUEST PARAMS
-    //---------------
-  }
-}

package/types/resources/QuotedCharge.d.ts

@@ -1,56 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface QuotedCharge {
-    charges?: QuotedCharge.Charge[];
-    addons?: QuotedCharge.Addon[];
-    invoice_items?: QuotedCharge.InvoiceItem[];
-    item_tiers?: QuotedCharge.ItemTier[];
-    coupons?: QuotedCharge.Coupon[];
-  }
-
-  export namespace QuotedCharge {
-    export interface Charge {
-      amount?: number;
-      amount_in_decimal?: string;
-      description?: string;
-      service_period_in_days?: number;
-      avalara_sale_type?: 'wholesale' | 'retail' | 'consumed' | 'vendor_use';
-      avalara_transaction_type?: number;
-      avalara_service_type?: number;
-    }
-    export interface Addon {
-      id: string;
-      quantity?: number;
-      unit_price?: number;
-      quantity_in_decimal?: string;
-      unit_price_in_decimal?: string;
-      proration_type?: 'full_term' | 'partial_term' | 'none';
-      service_period?: number;
-    }
-    export interface InvoiceItem {
-      item_price_id: string;
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      service_period_days?: number;
-    }
-    export interface ItemTier {
-      item_price_id: string;
-      starting_unit: number;
-      ending_unit?: number;
-      price: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      price_in_decimal?: string;
-      index: number;
-    }
-    export interface Coupon {
-      coupon_id: string;
-    }
-    // REQUEST PARAMS
-    //---------------
-  }
-}

package/types/resources/QuotedSubscription.d.ts

@@ -1,114 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface QuotedSubscription {
-    id: string;
-    plan_id: string;
-    plan_quantity: number;
-    plan_unit_price?: number;
-    setup_fee?: number;
-    billing_period?: number;
-    billing_period_unit?: 'day' | 'week' | 'month' | 'year';
-    start_date?: number;
-    trial_end?: number;
-    remaining_billing_cycles?: number;
-    po_number?: string;
-    auto_collection?: AutoCollection;
-    plan_quantity_in_decimal?: string;
-    plan_unit_price_in_decimal?: string;
-    changes_scheduled_at?: number;
-    change_option?: 'end_of_term' | 'specific_date' | 'immediately';
-    contract_term_billing_cycle_on_renewal?: number;
-    addons?: QuotedSubscription.Addon[];
-    event_based_addons?: QuotedSubscription.EventBasedAddon[];
-    coupons?: QuotedSubscription.Coupon[];
-    subscription_items?: QuotedSubscription.SubscriptionItem[];
-    item_tiers?: QuotedSubscription.ItemTier[];
-    quoted_contract_term?: QuotedSubscription.QuotedContractTerm;
-  }
-
-  export namespace QuotedSubscription {
-    export interface Addon {
-      id: string;
-      quantity?: number;
-      unit_price?: number;
-      amount?: number;
-      trial_end?: number;
-      remaining_billing_cycles?: number;
-      quantity_in_decimal?: string;
-      unit_price_in_decimal?: string;
-      amount_in_decimal?: string;
-      proration_type?: 'full_term' | 'partial_term' | 'none';
-    }
-    export interface EventBasedAddon {
-      id: string;
-      quantity: number;
-      unit_price: number;
-      service_period_in_days?: number;
-      on_event:
-        | 'subscription_creation'
-        | 'subscription_trial_start'
-        | 'plan_activation'
-        | 'subscription_activation'
-        | 'contract_termination';
-      charge_once: boolean;
-      quantity_in_decimal?: string;
-      unit_price_in_decimal?: string;
-    }
-    export interface Coupon {
-      coupon_id: string;
-    }
-    export interface SubscriptionItem {
-      item_price_id: string;
-      item_type: 'plan' | 'addon' | 'charge';
-      quantity?: number;
-      quantity_in_decimal?: string;
-      metered_quantity?: string;
-      last_calculated_at?: number;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      amount?: number;
-      amount_in_decimal?: string;
-      billing_period?: number;
-      billing_period_unit?: 'day' | 'week' | 'month' | 'year';
-      free_quantity?: number;
-      free_quantity_in_decimal?: string;
-      trial_end?: number;
-      billing_cycles?: number;
-      service_period_days?: number;
-      charge_on_event?:
-        | 'subscription_creation'
-        | 'subscription_trial_start'
-        | 'plan_activation'
-        | 'subscription_activation'
-        | 'contract_termination';
-      charge_once?: boolean;
-      charge_on_option?: 'immediately' | 'on_event';
-      proration_type?: 'full_term' | 'partial_term' | 'none';
-      usage_accumulation_reset_frequency?:
-        | 'never'
-        | 'subscription_billing_frequency';
-    }
-    export interface ItemTier {
-      item_price_id: string;
-      starting_unit: number;
-      ending_unit?: number;
-      price: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      price_in_decimal?: string;
-      index: number;
-    }
-    export interface QuotedContractTerm {
-      contract_start: number;
-      contract_end: number;
-      billing_cycle: number;
-      action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
-      total_contract_value: number;
-      cancellation_cutoff_period?: number;
-    }
-    // REQUEST PARAMS
-    //---------------
-  }
-}

package/types/resources/Ramp.d.ts

@@ -1,260 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface Ramp {
-    id: string;
-    description?: string;
-    subscription_id: string;
-    effective_from: number;
-    status: 'scheduled' | 'succeeded' | 'failed' | 'draft';
-    created_at: number;
-    resource_version?: number;
-    updated_at?: number;
-    items_to_add?: Ramp.ItemsToAdd[];
-    items_to_update?: Ramp.ItemsToUpdate[];
-    coupons_to_add?: Ramp.CouponsToAdd[];
-    discounts_to_add?: Ramp.DiscountsToAdd[];
-    item_tiers?: Ramp.ItemTier[];
-    items_to_remove?: string[];
-    coupons_to_remove?: string[];
-    discounts_to_remove?: string[];
-    deleted: boolean;
-    status_transition_reason?: Ramp.StatusTransitionReason;
-  }
-
-  export namespace Ramp {
-    export class RampResource {
-      createForSubscription(
-        subscription_id: string,
-        input: CreateForSubscriptionInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateForSubscriptionResponse>>;
-
-      update(
-        ramp_id: string,
-        input: UpdateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateResponse>>;
-
-      retrieve(
-        ramp_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      delete(
-        ramp_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-
-      list(
-        input: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-    }
-
-    export interface CreateForSubscriptionResponse {
-      ramp: Ramp;
-    }
-
-    export interface UpdateResponse {
-      ramp: Ramp;
-    }
-
-    export interface RetrieveResponse {
-      ramp: Ramp;
-    }
-
-    export interface DeleteResponse {
-      ramp: Ramp;
-    }
-
-    export interface ListResponse {
-      list: { ramp: Ramp }[];
-      next_offset?: string;
-    }
-
-    export interface ItemsToAdd {
-      item_price_id: string;
-      item_type: 'plan' | 'addon' | 'charge';
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      amount?: number;
-      amount_in_decimal?: string;
-      free_quantity?: number;
-      free_quantity_in_decimal?: string;
-      billing_cycles?: number;
-      service_period_days?: number;
-      metered_quantity?: string;
-    }
-    export interface ItemsToUpdate {
-      item_price_id: string;
-      item_type: 'plan' | 'addon' | 'charge';
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      amount?: number;
-      amount_in_decimal?: string;
-      free_quantity?: number;
-      free_quantity_in_decimal?: string;
-      billing_cycles?: number;
-      service_period_days?: number;
-      metered_quantity?: string;
-    }
-    export interface CouponsToAdd {
-      coupon_id: string;
-      apply_till?: number;
-    }
-    export interface DiscountsToAdd {
-      id: string;
-      invoice_name?: string;
-      type: 'fixed_amount' | 'percentage';
-      percentage?: number;
-      amount?: number;
-      duration_type: 'one_time' | 'forever' | 'limited_period';
-      period?: number;
-      period_unit?: 'day' | 'week' | 'month' | 'year';
-      included_in_mrr: boolean;
-      apply_on: 'invoice_amount' | 'specific_item_price';
-      item_price_id?: string;
-      created_at: number;
-    }
-    export interface ItemTier {
-      item_price_id: string;
-      starting_unit: number;
-      ending_unit?: number;
-      price: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      price_in_decimal?: string;
-      index: number;
-    }
-    export interface StatusTransitionReason {
-      code?: string;
-      message?: string;
-    }
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateForSubscriptionInputParam {
-      effective_from: number;
-      description?: string;
-      coupons_to_remove?: string[];
-      discounts_to_remove?: string[];
-      items_to_remove?: string[];
-      items_to_add?: ItemsToAddCreateForSubscriptionInputParam[];
-      items_to_update?: ItemsToUpdateCreateForSubscriptionInputParam[];
-      item_tiers?: ItemTiersCreateForSubscriptionInputParam[];
-      coupons_to_add?: CouponsToAddCreateForSubscriptionInputParam[];
-      discounts_to_add?: DiscountsToAddCreateForSubscriptionInputParam[];
-    }
-    export interface UpdateInputParam {
-      effective_from: number;
-      description?: string;
-      coupons_to_remove?: string[];
-      discounts_to_remove?: string[];
-      items_to_remove?: string[];
-      items_to_add?: ItemsToAddUpdateInputParam[];
-      items_to_update?: ItemsToUpdateUpdateInputParam[];
-      item_tiers?: ItemTiersUpdateInputParam[];
-      coupons_to_add?: CouponsToAddUpdateInputParam[];
-      discounts_to_add?: DiscountsToAddUpdateInputParam[];
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      include_deleted?: boolean;
-      status?: filter.Enum;
-      subscription_id: filter.String;
-      effective_from?: filter.Timestamp;
-      updated_at?: filter.Timestamp;
-      'sort_by[asc]'?: string;
-      'sort_by[desc]'?: string;
-    }
-    export interface ItemsToAddCreateForSubscriptionInputParam {
-      item_price_id: string;
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      billing_cycles?: number;
-      service_period_days?: number;
-    }
-    export interface CouponsToAddCreateForSubscriptionInputParam {
-      coupon_id?: string;
-      apply_till?: number;
-    }
-    export interface ItemTiersCreateForSubscriptionInputParam {
-      item_price_id?: string;
-      starting_unit?: number;
-      ending_unit?: number;
-      price?: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      price_in_decimal?: string;
-    }
-    export interface ItemsToUpdateCreateForSubscriptionInputParam {
-      item_price_id: string;
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      billing_cycles?: number;
-      service_period_days?: number;
-    }
-    export interface DiscountsToAddCreateForSubscriptionInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
-      percentage?: number;
-      amount?: number;
-      period?: number;
-      period_unit?: PeriodUnit;
-      included_in_mrr?: boolean;
-      item_price_id?: string;
-    }
-    export interface ItemsToAddUpdateInputParam {
-      item_price_id: string;
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      billing_cycles?: number;
-      service_period_days?: number;
-    }
-    export interface CouponsToAddUpdateInputParam {
-      coupon_id?: string;
-      apply_till?: number;
-    }
-    export interface ItemTiersUpdateInputParam {
-      item_price_id?: string;
-      starting_unit?: number;
-      ending_unit?: number;
-      price?: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      price_in_decimal?: string;
-    }
-    export interface ItemsToUpdateUpdateInputParam {
-      item_price_id: string;
-      quantity?: number;
-      quantity_in_decimal?: string;
-      unit_price?: number;
-      unit_price_in_decimal?: string;
-      billing_cycles?: number;
-      service_period_days?: number;
-    }
-    export interface DiscountsToAddUpdateInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
-      percentage?: number;
-      amount?: number;
-      period?: number;
-      period_unit?: PeriodUnit;
-      included_in_mrr?: boolean;
-      item_price_id?: string;
-    }
-  }
-}

package/types/resources/ResourceMigration.d.ts

@@ -1,36 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface ResourceMigration {
-    from_site: string;
-    entity_type: 'customer';
-    entity_id: string;
-    status: 'scheduled' | 'failed' | 'succeeded';
-    errors?: string;
-    created_at: number;
-    updated_at: number;
-  }
-
-  export namespace ResourceMigration {
-    export class ResourceMigrationResource {
-      retrieveLatest(
-        input: RetrieveLatestInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveLatestResponse>>;
-    }
-
-    export interface RetrieveLatestResponse {
-      resource_migration: ResourceMigration;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface RetrieveLatestInputParam {
-      from_site: string;
-      entity_type: 'customer';
-      entity_id: string;
-    }
-  }
-}

package/types/resources/SiteMigrationDetail.d.ts

@@ -1,46 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface SiteMigrationDetail {
-    entity_id: string;
-    other_site_name: string;
-    entity_id_at_other_site: string;
-    migrated_at: number;
-    entity_type:
-      | 'customer'
-      | 'subscription'
-      | 'invoice'
-      | 'credit_note'
-      | 'transaction'
-      | 'order';
-    status: 'moved_in' | 'moved_out' | 'moving_out';
-  }
-
-  export namespace SiteMigrationDetail {
-    export class SiteMigrationDetailResource {
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-    }
-
-    export interface ListResponse {
-      list: { site_migration_detail: SiteMigrationDetail }[];
-      next_offset?: string;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      entity_id_at_other_site?: filter.String;
-      other_site_name?: filter.String;
-      entity_id?: filter.String;
-      entity_type?: filter.Enum;
-      status?: filter.Enum;
-    }
-  }
-}