chargebee 3.0.0-beta.4 → 3.0.0

package/types/resources/InvoiceEstimate.d.ts

@@ -1,143 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface InvoiceEstimate {
-    recurring: boolean;
-    price_type: PriceType;
-    currency_code: string;
-    sub_total: number;
-    total?: number;
-    credits_applied?: number;
-    amount_paid?: number;
-    amount_due?: number;
-    line_items?: InvoiceEstimate.LineItem[];
-    discounts?: InvoiceEstimate.Discount[];
-    taxes?: InvoiceEstimate.Tax[];
-    line_item_taxes?: InvoiceEstimate.LineItemTax[];
-    line_item_tiers?: InvoiceEstimate.LineItemTier[];
-    line_item_discounts?: InvoiceEstimate.LineItemDiscount[];
-    round_off_amount?: number;
-    customer_id?: string;
-  }
-
-  export namespace InvoiceEstimate {
-    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 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;
-    }
-    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;
-    }
-    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;
-    }
-    // REQUEST PARAMS
-    //---------------
-  }
-}

package/types/resources/Item.d.ts

@@ -1,204 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface Item {
-    [key: string]: unknown;
-    id: string;
-    name: string;
-    external_name?: string;
-    description?: string;
-    status?: 'active' | 'archived' | 'deleted';
-    resource_version?: number;
-    updated_at?: number;
-    item_family_id?: string;
-    type: 'plan' | 'addon' | 'charge';
-    is_shippable?: boolean;
-    is_giftable: boolean;
-    redirect_url?: string;
-    enabled_for_checkout: boolean;
-    enabled_in_portal: boolean;
-    included_in_mrr?: boolean;
-    item_applicability: 'all' | 'restricted';
-    gift_claim_redirect_url?: string;
-    unit?: string;
-    metered: boolean;
-    usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
-    archived_at?: number;
-    channel?: Channel;
-    applicable_items?: Item.ApplicableItem[];
-    bundle_items?: Item.BundleItem[];
-    bundle_configuration?: Item.BundleConfiguration;
-    metadata?: any;
-  }
-
-  export namespace Item {
-    export class ItemResource {
-      create(
-        input: CreateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateResponse>>;
-
-      retrieve(
-        item_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      update(
-        item_id: string,
-        input?: UpdateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateResponse>>;
-
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-
-      delete(
-        item_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-    }
-
-    export interface CreateResponse {
-      item: Item;
-    }
-
-    export interface RetrieveResponse {
-      item: Item;
-    }
-
-    export interface UpdateResponse {
-      item: Item;
-    }
-
-    export interface ListResponse {
-      list: { item: Item }[];
-      next_offset?: string;
-    }
-
-    export interface DeleteResponse {
-      item: Item;
-    }
-
-    export interface ApplicableItem {
-      id?: string;
-    }
-    export interface BundleItem {
-      item_id: string;
-      item_type?: 'plan' | 'addon' | 'charge';
-      quantity?: number;
-      price_allocation?: number;
-    }
-    export interface BundleConfiguration {
-      type?: 'fixed';
-    }
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateInputParam {
-      id: string;
-      name: string;
-      type: 'plan' | 'addon' | 'charge';
-      description?: string;
-      item_family_id: string;
-      is_giftable?: boolean;
-      is_shippable?: boolean;
-      external_name?: string;
-      enabled_in_portal?: boolean;
-      redirect_url?: string;
-      enabled_for_checkout?: boolean;
-      item_applicability?: 'all' | 'restricted';
-      applicable_items?: string[];
-      unit?: string;
-      gift_claim_redirect_url?: string;
-      included_in_mrr?: boolean;
-      metered?: boolean;
-      usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
-      metadata?: any;
-      bundle_configuration?: BundleConfigurationCreateInputParam;
-      bundle_items_to_add?: BundleItemsToAddCreateInputParam[];
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface UpdateInputParam {
-      name?: string;
-      description?: string;
-      is_shippable?: boolean;
-      external_name?: string;
-      item_family_id?: string;
-      enabled_in_portal?: boolean;
-      redirect_url?: string;
-      enabled_for_checkout?: boolean;
-      item_applicability?: 'all' | 'restricted' /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      clear_applicable_items?: boolean;
-      applicable_items?: string[];
-      unit?: string;
-      gift_claim_redirect_url?: string;
-      metadata?: any;
-      included_in_mrr?: boolean;
-      status?: 'active' | 'archived';
-      bundle_configuration?: BundleConfigurationUpdateInputParam;
-      bundle_items_to_add?: BundleItemsToAddUpdateInputParam[];
-      bundle_items_to_update?: BundleItemsToUpdateUpdateInputParam[];
-      bundle_items_to_remove?: BundleItemsToRemoveUpdateInputParam[];
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      bundle_configuration?: BundleConfigurationItemListInputParam;
-      id?: filter.String;
-      item_family_id?: filter.String;
-      type?: filter.Enum;
-      name?: filter.String;
-      item_applicability?: filter.Enum;
-      status?: filter.Enum;
-      is_giftable?: filter.Boolean;
-      updated_at?: filter.Timestamp;
-      enabled_for_checkout?: filter.Boolean;
-      enabled_in_portal?: filter.Boolean;
-      metered?: filter.Boolean;
-      usage_calculation?: filter.Enum;
-      channel?: filter.Enum;
-      'sort_by[asc]'?: string;
-      'sort_by[desc]'?: string;
-    }
-    export interface BundleConfigurationCreateInputParam {
-      type?: 'fixed';
-    }
-
-    export interface BundleItemsToAddCreateInputParam {
-      item_id?: string;
-      item_type?: ItemType;
-      quantity?: number;
-      price_allocation?: number;
-    }
-    export interface BundleConfigurationUpdateInputParam {
-      type?: 'fixed';
-    }
-
-    export interface BundleItemsToAddUpdateInputParam {
-      item_id?: string;
-      item_type?: ItemType;
-      quantity?: number;
-      price_allocation?: number;
-    }
-    export interface BundleItemsToUpdateUpdateInputParam {
-      item_id?: string;
-      item_type?: ItemType;
-      quantity?: number;
-      price_allocation?: number;
-    }
-    export interface BundleItemsToRemoveUpdateInputParam {
-      item_id?: string;
-      item_type?: ItemType;
-    }
-    export interface BundleConfigurationItemListInputParam {
-      type?: filter.Enum;
-    }
-  }
-}

package/types/resources/ItemEntitlement.d.ts

@@ -1,103 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface ItemEntitlement {
-    id: string;
-    item_id?: string;
-    item_type?: 'plan' | 'addon' | 'charge' | 'subscription' | 'item';
-    feature_id?: string;
-    feature_name?: string;
-    value?: string;
-    name?: string;
-  }
-
-  export namespace ItemEntitlement {
-    export class ItemEntitlementResource {
-      itemEntitlementsForItem(
-        item_id: string,
-        input?: ItemEntitlementsForItemInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ItemEntitlementsForItemResponse>>;
-
-      itemEntitlementsForFeature(
-        feature_id: string,
-        input?: ItemEntitlementsForFeatureInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ItemEntitlementsForFeatureResponse>>;
-
-      addItemEntitlements(
-        feature_id: string,
-        input: AddItemEntitlementsInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<AddItemEntitlementsResponse>>;
-
-      upsertOrRemoveItemEntitlementsForItem(
-        item_id: string,
-        input: UpsertOrRemoveItemEntitlementsForItemInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<
-        ChargebeeResponse<UpsertOrRemoveItemEntitlementsForItemResponse>
-      >;
-    }
-
-    export interface ItemEntitlementsForItemResponse {
-      list: { item_entitlement: ItemEntitlement }[];
-      next_offset?: string;
-    }
-
-    export interface ItemEntitlementsForFeatureResponse {
-      list: { item_entitlement: ItemEntitlement }[];
-      next_offset?: string;
-    }
-
-    export interface AddItemEntitlementsResponse {
-      item_entitlement: ItemEntitlement;
-    }
-
-    export interface UpsertOrRemoveItemEntitlementsForItemResponse {
-      item_entitlement: ItemEntitlement;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface ItemEntitlementsForItemInputParam {
-      limit?: number;
-      offset?: string /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      include_drafts?: boolean /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      embed?: string;
-    }
-    export interface ItemEntitlementsForFeatureInputParam {
-      limit?: number;
-      offset?: string /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      include_drafts?: boolean;
-    }
-    export interface AddItemEntitlementsInputParam {
-      action: Action;
-      item_entitlements?: ItemEntitlementsAddItemEntitlementsInputParam[];
-    }
-    export interface UpsertOrRemoveItemEntitlementsForItemInputParam {
-      action: Action;
-      item_entitlements?: ItemEntitlementsUpsertOrRemoveItemEntitlementsForItemInputParam[];
-    }
-    export interface ItemEntitlementsAddItemEntitlementsInputParam {
-      item_id: string;
-      item_type?: 'plan' | 'addon' | 'charge' | 'subscription' | 'item';
-      value?: string;
-    }
-    export interface ItemEntitlementsUpsertOrRemoveItemEntitlementsForItemInputParam {
-      feature_id: string;
-      value?: string;
-    }
-  }
-}

package/types/resources/ItemFamily.d.ts

@@ -1,89 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface ItemFamily {
-    [key: string]: unknown;
-    id: string;
-    name: string;
-    description?: string;
-    status?: 'active' | 'deleted';
-    resource_version?: number;
-    updated_at?: number;
-    channel?: Channel;
-  }
-
-  export namespace ItemFamily {
-    export class ItemFamilyResource {
-      create(
-        input: CreateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateResponse>>;
-
-      retrieve(
-        item_family_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-
-      update(
-        item_family_id: string,
-        input?: UpdateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateResponse>>;
-
-      delete(
-        item_family_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-    }
-
-    export interface CreateResponse {
-      item_family: ItemFamily;
-    }
-
-    export interface RetrieveResponse {
-      item_family: ItemFamily;
-    }
-
-    export interface ListResponse {
-      list: { item_family: ItemFamily }[];
-      next_offset?: string;
-    }
-
-    export interface UpdateResponse {
-      item_family: ItemFamily;
-    }
-
-    export interface DeleteResponse {
-      item_family: ItemFamily;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateInputParam {
-      id: string;
-      name: string;
-      description?: string;
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      id?: filter.String;
-      name?: filter.String;
-      updated_at?: filter.Timestamp;
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface UpdateInputParam {
-      name?: string;
-      description?: string;
-      [key: `cf_${string}`]: unknown;
-    }
-  }
-}