chargebee 3.0.0-beta.5 → 3.0.1

package/types/resources/Comment.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 Comment {
-    id: string;
-    entity_type: EntityTypeEnum;
-    added_by?: string;
-    notes: string;
-    created_at: number;
-    type: 'user' | 'system';
-    entity_id: string;
-  }
-
-  export namespace Comment {
-    export class CommentResource {
-      create(
-        input: CreateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateResponse>>;
-
-      retrieve(
-        comment_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-
-      delete(
-        comment_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-    }
-
-    export interface CreateResponse {
-      comment: Comment;
-    }
-
-    export interface RetrieveResponse {
-      comment: Comment;
-    }
-
-    export interface ListResponse {
-      list: { comment: Comment }[];
-      next_offset?: string;
-    }
-
-    export interface DeleteResponse {
-      comment: Comment;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateInputParam {
-      entity_type: EntityTypeEnum;
-      entity_id: string;
-      notes: string;
-      added_by?: string;
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      entity_type?:
-        | 'customer'
-        | 'subscription'
-        | 'invoice'
-        | 'quote'
-        | 'credit_note'
-        | 'transaction'
-        | 'plan'
-        | 'addon'
-        | 'coupon'
-        | 'order'
-        | 'business_entity'
-        | 'item_family'
-        | 'item'
-        | 'item_price'
-        | 'price_variant';
-      entity_id?: string;
-      created_at?: filter.Timestamp;
-      'sort_by[asc]'?: string;
-      'sort_by[desc]'?: string;
-    }
-  }
-}

package/types/resources/Contact.d.ts

@@ -1,16 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface Contact {
-    id: string;
-    first_name?: string;
-    last_name?: string;
-    email: string;
-    phone?: string;
-    label?: string;
-    enabled: boolean;
-    send_account_email: boolean;
-    send_billing_email: boolean;
-  }
-}

package/types/resources/ContractTerm.d.ts

@@ -1,19 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-
-declare module 'chargebee' {
-  export interface ContractTerm {
-    id: string;
-    status: 'active' | 'completed' | 'cancelled' | 'terminated';
-    contract_start: number;
-    contract_end: number;
-    billing_cycle: number;
-    action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
-    total_contract_value: number;
-    total_contract_value_before_tax: number;
-    cancellation_cutoff_period?: number;
-    created_at: number;
-    subscription_id: string;
-    remaining_billing_cycles?: number;
-  }
-}

package/types/resources/Coupon.d.ts

@@ -1,314 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface Coupon {
-    [key: string]: unknown;
-    id: string;
-    name: string;
-    invoice_name?: string;
-    discount_type: 'fixed_amount' | 'percentage' | 'offer_quantity';
-    discount_percentage?: number;
-    discount_amount?: number;
-    discount_quantity?: number;
-    currency_code?: string;
-    duration_type: 'one_time' | 'forever' | 'limited_period';
-    duration_month?: number;
-    valid_till?: number;
-    max_redemptions?: number;
-    status?: 'active' | 'expired' | 'archived' | 'deleted';
-    apply_discount_on:
-      | 'plans'
-      | 'plans_and_addons'
-      | 'plans_with_quantity'
-      | 'not_applicable';
-    apply_on: 'invoice_amount' | 'each_specified_item';
-    plan_constraint: 'none' | 'all' | 'specific' | 'not_applicable';
-    addon_constraint: 'none' | 'all' | 'specific' | 'not_applicable';
-    created_at: number;
-    archived_at?: number;
-    resource_version?: number;
-    updated_at?: number;
-    included_in_mrr?: boolean;
-    period?: number;
-    period_unit?: PeriodUnitEnum;
-    plan_ids?: string[];
-    addon_ids?: string[];
-    item_constraints?: Coupon.ItemConstraint[];
-    item_constraint_criteria?: Coupon.ItemConstraintCriteria[];
-    redemptions?: number;
-    invoice_notes?: string;
-    meta_data?: any;
-    coupon_constraints?: Coupon.CouponConstraint[];
-  }
-
-  export namespace Coupon {
-    export class CouponResource {
-      create(
-        input: CreateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateResponse>>;
-
-      createForItems(
-        input: CreateForItemsInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateForItemsResponse>>;
-
-      updateForItems(
-        coupon_id: string,
-        input: UpdateForItemsInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateForItemsResponse>>;
-
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-
-      retrieve(
-        coupon_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      update(
-        coupon_id: string,
-        input?: UpdateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateResponse>>;
-
-      delete(
-        coupon_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-
-      copy(
-        input: CopyInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CopyResponse>>;
-
-      unarchive(
-        coupon_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UnarchiveResponse>>;
-    }
-
-    export interface CreateResponse {
-      coupon: Coupon;
-    }
-
-    export interface CreateForItemsResponse {
-      coupon: Coupon;
-    }
-
-    export interface UpdateForItemsResponse {
-      coupon: Coupon;
-    }
-
-    export interface ListResponse {
-      list: { coupon: Coupon }[];
-      next_offset?: string;
-    }
-
-    export interface RetrieveResponse {
-      coupon: Coupon;
-    }
-
-    export interface UpdateResponse {
-      coupon: Coupon;
-    }
-
-    export interface DeleteResponse {
-      coupon: Coupon;
-    }
-
-    export interface CopyResponse {
-      coupon: Coupon;
-    }
-
-    export interface UnarchiveResponse {
-      coupon: Coupon;
-    }
-
-    export interface ItemConstraint {
-      item_type: 'plan' | 'addon' | 'charge';
-      constraint: 'none' | 'all' | 'specific' | 'criteria';
-      item_price_ids?: any[];
-    }
-    export interface ItemConstraintCriteria {
-      item_type: 'plan' | 'addon' | 'charge';
-      currencies?: any[];
-      item_family_ids?: any[];
-      item_price_periods?: any[];
-    }
-    export interface CouponConstraint {
-      entity_type: 'customer';
-      type: 'max_redemptions' | 'unique_by';
-      value?: string;
-    }
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateInputParam {
-      id: string;
-      name: string;
-      invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
-      discount_amount?: number;
-      currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      discount_quantity?: number;
-      apply_on: 'invoice_amount' | 'each_specified_item';
-      duration_type?: 'one_time' | 'forever' | 'limited_period';
-      duration_month?: number;
-      valid_till?: number;
-      max_redemptions?: number;
-      invoice_notes?: string;
-      meta_data?: any;
-      included_in_mrr?: boolean;
-      period?: number;
-      period_unit?: PeriodUnitEnum;
-      plan_constraint?: 'none' | 'all' | 'specific';
-      addon_constraint?: 'none' | 'all' | 'specific';
-      plan_ids?: string[];
-      addon_ids?: string[];
-      status?: 'active' | 'archived';
-    }
-    export interface CreateForItemsInputParam {
-      id: string;
-      name: string;
-      invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
-      discount_amount?: number;
-      currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      discount_quantity?: number;
-      apply_on: 'invoice_amount' | 'each_specified_item';
-      duration_type?: 'one_time' | 'forever' | 'limited_period';
-      duration_month?: number;
-      valid_till?: number;
-      max_redemptions?: number;
-      invoice_notes?: string;
-      meta_data?: any;
-      included_in_mrr?: boolean;
-      period?: number;
-      period_unit?: PeriodUnitEnum;
-      status?: 'active' | 'archived';
-      item_constraints?: ItemConstraintsCreateForItemsInputParam[];
-      item_constraint_criteria?: ItemConstraintCriteriaCreateForItemsInputParam[];
-      coupon_constraints?: CouponConstraintsCreateForItemsInputParam[];
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface UpdateForItemsInputParam {
-      name?: string;
-      invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
-      discount_amount?: number;
-      currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      discount_quantity?: number;
-      apply_on?: 'invoice_amount' | 'each_specified_item';
-      duration_type?: 'one_time' | 'forever' | 'limited_period';
-      duration_month?: number;
-      valid_till?: number;
-      max_redemptions?: number;
-      invoice_notes?: string;
-      meta_data?: any;
-      included_in_mrr?: boolean;
-      period?: number;
-      period_unit?: PeriodUnitEnum;
-      item_constraints?: ItemConstraintsUpdateForItemsInputParam[];
-      item_constraint_criteria?: ItemConstraintCriteriaUpdateForItemsInputParam[];
-      coupon_constraints?: CouponConstraintsUpdateForItemsInputParam[];
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      id?: filter.String;
-      name?: filter.String;
-      discount_type?: filter.Enum;
-      duration_type?: filter.Enum;
-      status?: filter.Enum;
-      apply_on?: filter.Enum;
-      created_at?: filter.Timestamp;
-      updated_at?: filter.Timestamp;
-      currency_code?: filter.String;
-      'sort_by[asc]'?: string;
-      'sort_by[desc]'?: string;
-      [key: `cf_${string}`]: unknown;
-    }
-    export interface UpdateInputParam {
-      name?: string;
-      invoice_name?: string;
-      discount_type?: 'fixed_amount' | 'percentage' | 'offer_quantity';
-      discount_amount?: number;
-      currency_code?: string;
-      discount_percentage?: number /**
-       * @deprecated Please refer API docs to use other attributes
-       */;
-
-      discount_quantity?: number;
-      apply_on?: 'invoice_amount' | 'each_specified_item';
-      duration_type?: 'one_time' | 'forever' | 'limited_period';
-      duration_month?: number;
-      valid_till?: number;
-      max_redemptions?: number;
-      invoice_notes?: string;
-      meta_data?: any;
-      included_in_mrr?: boolean;
-      period?: number;
-      period_unit?: PeriodUnitEnum;
-      plan_constraint?: 'none' | 'all' | 'specific';
-      addon_constraint?: 'none' | 'all' | 'specific';
-      plan_ids?: string[];
-      addon_ids?: string[];
-    }
-    export interface CopyInputParam {
-      from_site: string;
-      id_at_from_site: string;
-      id?: string;
-      for_site_merging?: boolean;
-    }
-    export interface ItemConstraintCriteriaCreateForItemsInputParam {
-      item_type?: 'plan' | 'addon' | 'charge';
-      item_family_ids?: any;
-      currencies?: any;
-      item_price_periods?: any;
-    }
-    export interface CouponConstraintsCreateForItemsInputParam {
-      entity_type: 'customer';
-      type: 'max_redemptions' | 'unique_by';
-      value?: string;
-    }
-    export interface ItemConstraintsCreateForItemsInputParam {
-      constraint: 'none' | 'all' | 'specific' | 'criteria';
-      item_type: 'plan' | 'addon' | 'charge';
-      item_price_ids?: any;
-    }
-    export interface ItemConstraintCriteriaUpdateForItemsInputParam {
-      item_type?: 'plan' | 'addon' | 'charge';
-      item_family_ids?: any;
-      currencies?: any;
-      item_price_periods?: any;
-    }
-    export interface CouponConstraintsUpdateForItemsInputParam {
-      entity_type: 'customer';
-      type: 'max_redemptions' | 'unique_by';
-      value?: string;
-    }
-    export interface ItemConstraintsUpdateForItemsInputParam {
-      constraint: 'none' | 'all' | 'specific' | 'criteria';
-      item_type: 'plan' | 'addon' | 'charge';
-      item_price_ids?: any;
-    }
-  }
-}

package/types/resources/CouponCode.d.ts

@@ -1,70 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface CouponCode {
-    code: string;
-    status: 'not_redeemed' | 'redeemed' | 'archived';
-    coupon_id: string;
-    coupon_set_id: string;
-    coupon_set_name: string;
-  }
-
-  export namespace CouponCode {
-    export class CouponCodeResource {
-      create(
-        input: CreateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateResponse>>;
-
-      retrieve(
-        coupon_code_code: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-
-      archive(
-        coupon_code_code: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ArchiveResponse>>;
-    }
-
-    export interface CreateResponse {
-      coupon_code: CouponCode;
-    }
-
-    export interface RetrieveResponse {
-      coupon_code: CouponCode;
-    }
-
-    export interface ListResponse {
-      list: { coupon_code: CouponCode }[];
-      next_offset?: string;
-    }
-
-    export interface ArchiveResponse {
-      coupon_code: CouponCode;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateInputParam {
-      coupon_id: string;
-      coupon_set_name: string;
-      code: string;
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      code?: filter.String;
-      coupon_id?: filter.String;
-      coupon_set_name?: filter.String;
-      status?: filter.Enum;
-    }
-  }
-}

package/types/resources/CouponSet.d.ts

@@ -1,111 +0,0 @@
-///<reference path='./../core.d.ts'/>
-///<reference path='./../index.d.ts'/>
-///<reference path='./filter.d.ts'/>
-declare module 'chargebee' {
-  export interface CouponSet {
-    id: string;
-    coupon_id: string;
-    name: string;
-    total_count?: number;
-    redeemed_count?: number;
-    archived_count?: number;
-    meta_data?: any;
-  }
-
-  export namespace CouponSet {
-    export class CouponSetResource {
-      create(
-        input: CreateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<CreateResponse>>;
-
-      addCouponCodes(
-        coupon_set_id: string,
-        input?: AddCouponCodesInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<AddCouponCodesResponse>>;
-
-      list(
-        input?: ListInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<ListResponse>>;
-
-      retrieve(
-        coupon_set_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<RetrieveResponse>>;
-
-      update(
-        coupon_set_id: string,
-        input?: UpdateInputParam,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UpdateResponse>>;
-
-      delete(
-        coupon_set_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteResponse>>;
-
-      deleteUnusedCouponCodes(
-        coupon_set_id: string,
-        headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<DeleteUnusedCouponCodesResponse>>;
-    }
-
-    export interface CreateResponse {
-      coupon_set: CouponSet;
-    }
-
-    export interface AddCouponCodesResponse {
-      coupon_set: CouponSet;
-    }
-
-    export interface ListResponse {
-      list: { coupon_set: CouponSet }[];
-      next_offset?: string;
-    }
-
-    export interface RetrieveResponse {
-      coupon_set: CouponSet;
-    }
-
-    export interface UpdateResponse {
-      coupon_set: CouponSet;
-    }
-
-    export interface DeleteResponse {
-      coupon_set: CouponSet;
-    }
-
-    export interface DeleteUnusedCouponCodesResponse {
-      coupon_set: CouponSet;
-    }
-
-    // REQUEST PARAMS
-    //---------------
-
-    export interface CreateInputParam {
-      coupon_id: string;
-      name: string;
-      id: string;
-      meta_data?: any;
-    }
-    export interface AddCouponCodesInputParam {
-      code?: string[];
-    }
-    export interface ListInputParam {
-      limit?: number;
-      offset?: string;
-      id?: filter.String;
-      name?: filter.String;
-      coupon_id?: filter.String;
-      total_count?: filter.Number;
-      redeemed_count?: filter.Number;
-      archived_count?: filter.Number;
-    }
-    export interface UpdateInputParam {
-      name?: string;
-      meta_data?: any;
-    }
-  }
-}