chargebee 2.24.0 → 2.25.1

package/types/resources/Item.d.ts

@@ -0,0 +1,119 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface Item {
+    [key : string] : any;
+    id:string;
+    name:string;
+    external_name?:string;
+    description?:string;
+    status?:'archived' | 'deleted' | 'active';
+    resource_version?:number;
+    updated_at?:number;
+    item_family_id?:string;
+    type:'charge' | 'addon' | 'plan';
+    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?:'max_usage' | 'sum_of_usages' | 'last_usage';
+    archived_at?:number;
+    channel?:Channel;
+    metadata?:object;
+    applicable_items?:Item.ApplicableItem[];
+  }
+  export namespace Item {
+    export class ItemResource {
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      delete(item_id:string):ChargebeeRequest<DeleteResponse>;
+      retrieve(item_id:string):ChargebeeRequest<RetrieveResponse>;
+      update(item_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+    }
+    export interface ListResponse {
+      list:{item:Item}[];
+      next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
+      name?:{is?:string,is_not?:string,starts_with?:string};
+      item_applicability?:{in?:string,is?:'all' | 'restricted',is_not?:'all' | 'restricted',not_in?:string};
+      status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string};
+      is_giftable?:{is?:'true' | 'false'};
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+      enabled_for_checkout?:{is?:'true' | 'false'};
+      enabled_in_portal?:{is?:'true' | 'false'};
+      metered?:{is?:'true' | 'false'};
+      usage_calculation?:{in?:string,is?:'max_usage' | 'sum_of_usages' | 'last_usage',is_not?:'max_usage' | 'sum_of_usages' | 'last_usage',not_in?:string};
+      channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string};
+      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+    }
+    export interface CreateResponse {
+      item:Item;
+    }
+    export interface CreateInputParam {
+      [key : string] : any;
+      id:string;
+      name:string;
+      type:'charge' | 'addon' | 'plan';
+      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?:'max_usage' | 'sum_of_usages' | 'last_usage';
+      metadata?:object;
+    }
+    export interface DeleteResponse {
+      item:Item;
+    }
+    
+    export interface RetrieveResponse {
+      item:Item;
+    }
+    
+    export interface UpdateResponse {
+      item:Item;
+    }
+    export interface UpdateInputParam {
+      [key : string] : any;
+      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';
+      applicable_items?:string[];
+      unit?:string;
+      gift_claim_redirect_url?:string;
+      metadata?:object;
+      included_in_mrr?:boolean;
+      status?:'archived' | 'active';
+    }
+    export interface ApplicableItem {
+      id?:string;
+    }
+  }
+}

package/types/resources/ItemEntitlement.d.ts

@@ -0,0 +1,56 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface ItemEntitlement {
+    
+    id:string;
+    item_id?:string;
+    item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan';
+    feature_id?:string;
+    feature_name?:string;
+    value?:string;
+    name?:string;
+  }
+  export namespace ItemEntitlement {
+    export class ItemEntitlementResource {
+      item_entitlements_for_feature(feature_id:string, input?:ItemEntitlementsForFeatureInputParam):ChargebeeRequest<ItemEntitlementsForFeatureResponse>;
+      add_item_entitlements(feature_id:string, input:AddItemEntitlementsInputParam):ChargebeeRequest<AddItemEntitlementsResponse>;
+      item_entitlements_for_item(item_id:string, input?:ItemEntitlementsForItemInputParam):ChargebeeRequest<ItemEntitlementsForItemResponse>;
+      upsert_or_remove_item_entitlements_for_item(item_id:string, input:UpsertOrRemoveItemEntitlementsForItemInputParam):ChargebeeRequest<UpsertOrRemoveItemEntitlementsForItemResponse>;
+    }
+    export interface ItemEntitlementsForFeatureResponse {
+      list:{item_entitlement:ItemEntitlement}[];
+      next_offset?:string;
+    }
+    export interface ItemEntitlementsForFeatureInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+    }
+    export interface AddItemEntitlementsResponse {
+      item_entitlement:ItemEntitlement;
+    }
+    export interface AddItemEntitlementsInputParam {
+      
+      action:Action;
+      item_entitlements?:{item_id:string,item_type?:'item' | 'charge' | 'addon' | 'subscription' | 'plan',value?:string}[];
+    }
+    export interface ItemEntitlementsForItemResponse {
+      list:{item_entitlement:ItemEntitlement}[];
+      next_offset?:string;
+    }
+    export interface ItemEntitlementsForItemInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+    }
+    export interface UpsertOrRemoveItemEntitlementsForItemResponse {
+      item_entitlement:ItemEntitlement;
+    }
+    export interface UpsertOrRemoveItemEntitlementsForItemInputParam {
+      
+      action:Action;
+      item_entitlements?:{feature_id:string,value?:string}[];
+    }
+    
+  }
+}

package/types/resources/ItemFamily.d.ts

@@ -0,0 +1,60 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface ItemFamily {
+    [key : string] : any;
+    id:string;
+    name:string;
+    description?:string;
+    status?:'deleted' | 'active';
+    resource_version?:number;
+    updated_at?:number;
+    channel?:Channel;
+  }
+  export namespace ItemFamily {
+    export class ItemFamilyResource {
+      delete(item_family_id:string):ChargebeeRequest<DeleteResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      retrieve(item_family_id:string):ChargebeeRequest<RetrieveResponse>;
+      update(item_family_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+    }
+    export interface DeleteResponse {
+      item_family:ItemFamily;
+    }
+    
+    export interface ListResponse {
+      list:{item_family:ItemFamily}[];
+      next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      name?:{is?:string,is_not?:string,starts_with?:string};
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+    }
+    export interface CreateResponse {
+      item_family:ItemFamily;
+    }
+    export interface CreateInputParam {
+      [key : string] : any;
+      id:string;
+      name:string;
+      description?:string;
+    }
+    export interface RetrieveResponse {
+      item_family:ItemFamily;
+    }
+    
+    export interface UpdateResponse {
+      item_family:ItemFamily;
+    }
+    export interface UpdateInputParam {
+      [key : string] : any;
+      name?:string;
+      description?:string;
+    }
+    
+  }
+}

package/types/resources/ItemPrice.d.ts

@@ -0,0 +1,196 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface ItemPrice {
+    [key : string] : any;
+    id:string;
+    name:string;
+    item_family_id?:string;
+    product_id?:string;
+    item_id?:string;
+    description?:string;
+    status?:'archived' | 'deleted' | 'active';
+    external_name?:string;
+    pricing_model:PricingModel;
+    price?:number;
+    price_in_decimal?:string;
+    period?:number;
+    currency_code:string;
+    period_unit?:'week' | 'month' | 'year' | 'day';
+    trial_period?:number;
+    trial_period_unit?:'month' | 'day';
+    trial_end_action?:'activate_subscription' | 'cancel_subscription' | 'site_default';
+    shipping_period?:number;
+    shipping_period_unit?:'week' | 'month' | 'year' | 'day';
+    billing_cycles?:number;
+    free_quantity:number;
+    free_quantity_in_decimal?:string;
+    channel?:Channel;
+    resource_version?:number;
+    updated_at?:number;
+    created_at:number;
+    archived_at?:number;
+    invoice_notes?:string;
+    is_taxable?:boolean;
+    metadata?:object;
+    item_type?:ItemType;
+    show_description_in_invoices?:boolean;
+    show_description_in_quotes?:boolean;
+    tiers?:ItemPrice.Tier[];
+    tax_detail?:ItemPrice.TaxDetail;
+    accounting_detail?:ItemPrice.AccountingDetail;
+  }
+  export namespace ItemPrice {
+    export class ItemPriceResource {
+      find_applicable_items(item_price_id:string, input?:FindApplicableItemsInputParam):ChargebeeRequest<FindApplicableItemsResponse>;
+      retrieve(item_price_id:string):ChargebeeRequest<RetrieveResponse>;
+      update(item_price_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+      delete(item_price_id:string):ChargebeeRequest<DeleteResponse>;
+      find_applicable_item_prices(item_price_id:string, input?:FindApplicableItemPricesInputParam):ChargebeeRequest<FindApplicableItemPricesResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+    }
+    export interface FindApplicableItemsResponse {
+      list:{item:Item}[];
+      next_offset?:string;
+    }
+    export interface FindApplicableItemsInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+    }
+    export interface RetrieveResponse {
+      item_price:ItemPrice;
+    }
+    
+    export interface UpdateResponse {
+      item_price:ItemPrice;
+    }
+    export interface UpdateInputParam {
+      [key : string] : any;
+      name?:string;
+      description?:string;
+      status?:'archived' | 'active';
+      external_name?:string;
+      currency_code?:string;
+      invoice_notes?:string;
+      is_taxable?:boolean;
+      free_quantity?:number;
+      free_quantity_in_decimal?:string;
+      metadata?:object;
+      pricing_model?:PricingModel;
+      price?:number;
+      price_in_decimal?:string;
+      period_unit?:'week' | 'month' | 'year' | 'day';
+      period?:number;
+      trial_period_unit?:'month' | 'day';
+      trial_period?:number;
+      shipping_period?:number;
+      shipping_period_unit?:'week' | 'month' | 'year' | 'day';
+      billing_cycles?:number;
+      trial_end_action?:'activate_subscription' | 'cancel_subscription' | 'site_default';
+      show_description_in_invoices?:boolean;
+      show_description_in_quotes?:boolean;
+      tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
+      accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
+      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+    }
+    export interface DeleteResponse {
+      item_price:ItemPrice;
+    }
+    
+    export interface FindApplicableItemPricesResponse {
+      list:{item_price:ItemPrice}[];
+      next_offset?:string;
+    }
+    export interface FindApplicableItemPricesInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      item_id?:string;
+      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+    }
+    export interface ListResponse {
+      list:{item_price:ItemPrice}[];
+      next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      pricing_model?:{in?:string,is?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',is_not?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',not_in?:string};
+      item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
+      currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      trial_period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
+      trial_period_unit?:{in?:string,is?:'month' | 'day',is_not?:'month' | 'day',not_in?:string};
+      status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string};
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+      period_unit?:{in?:string,is?:'week' | 'month' | 'year' | 'day',is_not?:'week' | 'month' | 'year' | 'day',not_in?:string};
+      period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
+      channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string};
+      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+    }
+    export interface CreateResponse {
+      item_price:ItemPrice;
+    }
+    export interface CreateInputParam {
+      [key : string] : any;
+      id:string;
+      name:string;
+      description?:string;
+      item_id:string;
+      invoice_notes?:string;
+      external_name?:string;
+      currency_code?:string;
+      is_taxable?:boolean;
+      free_quantity?:number;
+      free_quantity_in_decimal?:string;
+      metadata?:object;
+      show_description_in_invoices?:boolean;
+      show_description_in_quotes?:boolean;
+      pricing_model?:PricingModel;
+      price?:number;
+      price_in_decimal?:string;
+      period_unit?:'week' | 'month' | 'year' | 'day';
+      period?:number;
+      trial_period_unit?:'month' | 'day';
+      trial_period?:number;
+      shipping_period?:number;
+      shipping_period_unit?:'week' | 'month' | 'year' | 'day';
+      billing_cycles?:number;
+      trial_end_action?:'activate_subscription' | 'cancel_subscription' | 'site_default';
+      tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
+      accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
+      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+    }
+    export interface Tier {
+      starting_unit?:number;
+      ending_unit?:number;
+      price?:number;
+      starting_unit_in_decimal?:string;
+      ending_unit_in_decimal?:string;
+      price_in_decimal?:string;
+    }
+    export interface TaxDetail {
+      tax_profile_id?:string;
+      avalara_sale_type?:AvalaraSaleType;
+      avalara_transaction_type?:number;
+      avalara_service_type?:number;
+      avalara_tax_code?:string;
+      hsn_code?:string;
+      taxjar_product_code?:string;
+    }
+    export interface AccountingDetail {
+      sku?:string;
+      accounting_code?:string;
+      accounting_category1?:string;
+      accounting_category2?:string;
+      accounting_category3?:string;
+      accounting_category4?:string;
+    }
+  }
+}

package/types/resources/Media.d.ts

@@ -0,0 +1,11 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface Media {
+    
+    id:string;
+    url?:string;
+    alt_text?:string;
+    media_type?:string;
+  }
+  
+}

package/types/resources/NonSubscription.d.ts

@@ -0,0 +1,24 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface NonSubscription {
+    
+    invoice_id:string;
+    customer_id?:string;
+    charge_id:string;
+  }
+  export namespace NonSubscription {
+    export class NonSubscriptionResource {
+      process_receipt(non_subscription_app_id:string, input:ProcessReceiptInputParam):ChargebeeRequest<ProcessReceiptResponse>;
+    }
+    export interface ProcessReceiptResponse {
+      non_subscription:NonSubscription;
+    }
+    export interface ProcessReceiptInputParam {
+      
+      receipt:string;
+      product?:{currency_code:string,id:string,name?:string,price:number,price_in_decimal?:string,type:'non_consumable' | 'consumable' | 'non_renewing_subscription'};
+      customer?:{email?:string,first_name?:string,id?:string,last_name?:string};
+    }
+    
+  }
+}