chargebee 3.0.0 → 3.0.2

package/types/resources/CustomerEntitlement.d.ts

@@ -0,0 +1,36 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface CustomerEntitlement {
+    customer_id: string;
+    subscription_id?: string;
+    feature_id?: string;
+    value?: string;
+    name?: string;
+    is_enabled: boolean;
+  }
+
+  export namespace CustomerEntitlement {
+    export class CustomerEntitlementResource {
+      entitlementsForCustomer(
+        customer_id: string,
+        input?: EntitlementsForCustomerInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<EntitlementsForCustomerResponse>>;
+    }
+
+    export interface EntitlementsForCustomerResponse {
+      list: { customer_entitlement: CustomerEntitlement }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface EntitlementsForCustomerInputParam {
+      limit?: number;
+      offset?: string;
+    }
+  }
+}

package/types/resources/DifferentialPrice.d.ts

@@ -0,0 +1,142 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface DifferentialPrice {
+    id: string;
+    item_price_id: string;
+    parent_item_id: string;
+    price?: number;
+    price_in_decimal?: string;
+    status?: 'active' | 'deleted';
+    resource_version?: number;
+    updated_at?: number;
+    created_at: number;
+    modified_at: number;
+    tiers?: DifferentialPrice.Tier[];
+    currency_code: string;
+    parent_periods?: DifferentialPrice.ParentPeriod[];
+  }
+
+  export namespace DifferentialPrice {
+    export class DifferentialPriceResource {
+      create(
+        item_price_id: string,
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        differential_price_id: string,
+        input: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        differential_price_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        differential_price_id: string,
+        input: DeleteInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      differential_price: DifferentialPrice;
+    }
+
+    export interface RetrieveResponse {
+      differential_price: DifferentialPrice;
+    }
+
+    export interface UpdateResponse {
+      differential_price: DifferentialPrice;
+    }
+
+    export interface DeleteResponse {
+      differential_price: DifferentialPrice;
+    }
+
+    export interface ListResponse {
+      list: { differential_price: DifferentialPrice }[];
+      next_offset?: 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 ParentPeriod {
+      period_unit: 'day' | 'week' | 'month' | 'year';
+      period?: any[];
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      parent_item_id: string;
+      price?: number;
+      price_in_decimal?: string;
+      parent_periods?: ParentPeriodsCreateInputParam[];
+      tiers?: TiersCreateInputParam[];
+    }
+    export interface RetrieveInputParam {
+      item_price_id: string;
+    }
+    export interface UpdateInputParam {
+      item_price_id: string;
+      price?: number;
+      price_in_decimal?: string;
+      parent_periods?: ParentPeriodsUpdateInputParam[];
+      tiers?: TiersUpdateInputParam[];
+    }
+    export interface DeleteInputParam {
+      item_price_id: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      item_price_id?: filter.String;
+      item_id?: filter.String;
+      id?: filter.String;
+      parent_item_id?: filter.String;
+    }
+    export interface TiersCreateInputParam {
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface ParentPeriodsCreateInputParam {
+      period_unit: 'day' | 'week' | 'month' | 'year';
+      period?: any;
+    }
+    export interface TiersUpdateInputParam {
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface ParentPeriodsUpdateInputParam {
+      period_unit: 'day' | 'week' | 'month' | 'year';
+      period?: any;
+    }
+  }
+}

package/types/resources/Discount.d.ts

@@ -0,0 +1,24 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Discount {
+    id: string;
+    invoice_name?: string;
+    type: 'fixed_amount' | 'percentage';
+    percentage?: number;
+    amount?: number;
+    currency_code?: string;
+    duration_type: DurationTypeEnum;
+    period?: number;
+    period_unit?: PeriodUnitEnum;
+    included_in_mrr: boolean;
+    apply_on: ApplyOnEnum;
+    item_price_id?: string;
+    created_at: number;
+    apply_till?: number;
+    applied_count?: number;
+    coupon_id: string;
+    index: number;
+  }
+}

package/types/resources/Download.d.ts

@@ -0,0 +1,10 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Download {
+    download_url: string;
+    valid_till: number;
+    mime_type?: string;
+  }
+}

package/types/resources/Entitlement.d.ts

@@ -0,0 +1,66 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Entitlement {
+    id: string;
+    entity_id?: string;
+    entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
+    feature_id?: string;
+    feature_name?: string;
+    value?: string;
+    name?: string;
+  }
+
+  export namespace Entitlement {
+    export class EntitlementResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { entitlement: Entitlement }[];
+      next_offset?: string;
+    }
+
+    export interface CreateResponse {
+      entitlement: Entitlement;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      feature_id?: filter.String;
+      entity_type?: filter.Enum;
+      entity_id?: filter.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 CreateInputParam {
+      action: ActionEnum;
+      entitlements?: EntitlementsCreateInputParam[];
+    }
+    export interface EntitlementsCreateInputParam {
+      entity_id: string;
+      feature_id: string;
+      entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
+      value?: string;
+    }
+  }
+}

package/types/resources/EntitlementOverride.d.ts

@@ -0,0 +1,76 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface EntitlementOverride {
+    id: string;
+    entity_id?: string;
+    entity_type?: string;
+    feature_id?: string;
+    feature_name?: string;
+    value?: string;
+    name?: string;
+    expires_at?: number;
+    effective_from?: number;
+    schedule_status?: 'activated' | 'scheduled' | 'failed';
+  }
+
+  export namespace EntitlementOverride {
+    export class EntitlementOverrideResource {
+      addEntitlementOverrideForSubscription(
+        subscription_id: string,
+        input: AddEntitlementOverrideForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<AddEntitlementOverrideForSubscriptionResponse>
+      >;
+
+      listEntitlementOverrideForSubscription(
+        subscription_id: string,
+        input?: ListEntitlementOverrideForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<ListEntitlementOverrideForSubscriptionResponse>
+      >;
+    }
+
+    export interface AddEntitlementOverrideForSubscriptionResponse {
+      entitlement_override: EntitlementOverride;
+    }
+
+    export interface ListEntitlementOverrideForSubscriptionResponse {
+      list: { entitlement_override: EntitlementOverride }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface AddEntitlementOverrideForSubscriptionInputParam {
+      action?: ActionEnum;
+      entitlement_overrides?: EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam[];
+    }
+    export interface ListEntitlementOverrideForSubscriptionInputParam {
+      limit?: number;
+      offset?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      embed?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      include_drafts?: boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      include_scheduled_overrides?: boolean;
+    }
+    export interface EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam {
+      feature_id: string;
+      value?: string;
+      expires_at?: number;
+      effective_from?: number;
+    }
+  }
+}