chargebee 3.0.1 → 3.1.0

package/types/resources/PortalSession.d.ts

@@ -0,0 +1,88 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PortalSession {
+    id: string;
+    token: string;
+    access_url: string;
+    redirect_url?: string;
+    status:
+      | 'created'
+      | 'logged_in'
+      | 'logged_out'
+      | 'not_yet_activated'
+      | 'activated';
+    created_at: number;
+    expires_at?: number;
+    customer_id: string;
+    login_at?: number;
+    logout_at?: number;
+    login_ipaddress?: string;
+    logout_ipaddress?: string;
+    linked_customers?: PortalSession.LinkedCustomer[];
+  }
+
+  export namespace PortalSession {
+    export class PortalSessionResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        portal_session_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      logout(
+        portal_session_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<LogoutResponse>>;
+
+      activate(
+        portal_session_id: string,
+        input: ActivateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateResponse>>;
+    }
+
+    export interface CreateResponse {
+      portal_session: PortalSession;
+    }
+
+    export interface RetrieveResponse {
+      portal_session: PortalSession;
+    }
+
+    export interface LogoutResponse {
+      portal_session: PortalSession;
+    }
+
+    export interface ActivateResponse {
+      portal_session: PortalSession;
+    }
+
+    export interface LinkedCustomer {
+      customer_id: string;
+      email?: string;
+      has_billing_address: boolean;
+      has_payment_method: boolean;
+      has_active_subscription: boolean;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      redirect_url?: string;
+      forward_url?: string;
+      customer?: CustomerCreateInputParam;
+    }
+    export interface ActivateInputParam {
+      token: string;
+    }
+    export interface CustomerCreateInputParam {
+      id: string;
+    }
+  }
+}

package/types/resources/PriceVariant.d.ts

@@ -0,0 +1,116 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface PriceVariant {
+    id: string;
+    name: string;
+    external_name?: string;
+    variant_group?: string;
+    description?: string;
+    status?: 'active' | 'archived' | 'deleted';
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    archived_at?: number;
+    attributes?: PriceVariant.Attribute[];
+    business_entity_id?: string;
+  }
+
+  export namespace PriceVariant {
+    export class PriceVariantResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        price_variant_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        price_variant_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        price_variant_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      price_variant: PriceVariant;
+    }
+
+    export interface RetrieveResponse {
+      price_variant: PriceVariant;
+    }
+
+    export interface UpdateResponse {
+      price_variant: PriceVariant;
+    }
+
+    export interface DeleteResponse {
+      price_variant: PriceVariant;
+    }
+
+    export interface ListResponse {
+      list: { price_variant: PriceVariant }[];
+      next_offset?: string;
+    }
+
+    export interface Attribute {
+      name: string;
+      value: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id: string;
+      name: string;
+      external_name?: string;
+      description?: string;
+      variant_group?: string;
+      business_entity_id?: string;
+      attributes?: AttributesCreateInputParam[];
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      external_name?: string;
+      description?: string;
+      variant_group?: string;
+      status?: 'active' | 'archived';
+      attributes?: AttributesUpdateInputParam[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      name?: filter.String;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface AttributesCreateInputParam {
+      name: string;
+      value: string;
+    }
+    export interface AttributesUpdateInputParam {
+      name: string;
+      value: string;
+    }
+  }
+}

package/types/resources/PricingPageSession.d.ts

@@ -0,0 +1,130 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PricingPageSession {
+    id?: string;
+    url?: string;
+    created_at?: number;
+    expires_at?: number;
+  }
+
+  export namespace PricingPageSession {
+    export class PricingPageSessionResource {
+      createForNewSubscription(
+        input: CreateForNewSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateForNewSubscriptionResponse>>;
+
+      createForExistingSubscription(
+        input: CreateForExistingSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateForExistingSubscriptionResponse>>;
+    }
+
+    export interface CreateForNewSubscriptionResponse {
+      pricing_page_session: PricingPageSession;
+    }
+
+    export interface CreateForExistingSubscriptionResponse {
+      pricing_page_session: PricingPageSession;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateForNewSubscriptionInputParam {
+      redirect_url?: string;
+      business_entity_id?: string;
+      pricing_page?: PricingPageCreateForNewSubscriptionInputParam;
+      subscription?: SubscriptionCreateForNewSubscriptionInputParam;
+      customer?: CustomerCreateForNewSubscriptionInputParam;
+      billing_address?: BillingAddressCreateForNewSubscriptionInputParam;
+      shipping_address?: ShippingAddressCreateForNewSubscriptionInputParam;
+      discounts?: DiscountsCreateForNewSubscriptionInputParam[];
+    }
+    export interface CreateForExistingSubscriptionInputParam {
+      redirect_url?: string;
+      pricing_page?: PricingPageCreateForExistingSubscriptionInputParam;
+      subscription?: SubscriptionCreateForExistingSubscriptionInputParam;
+      discounts?: DiscountsCreateForExistingSubscriptionInputParam[];
+    }
+    export interface BillingAddressCreateForNewSubscriptionInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+    export interface PricingPageCreateForNewSubscriptionInputParam {
+      id: string;
+    }
+    export interface CustomerCreateForNewSubscriptionInputParam {
+      id?: string;
+      email?: string;
+      first_name?: string;
+      last_name?: string;
+      company?: string;
+      phone?: string;
+      locale?: string;
+    }
+    export interface ShippingAddressCreateForNewSubscriptionInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+    export interface SubscriptionCreateForNewSubscriptionInputParam {
+      id?: string;
+    }
+
+    export interface DiscountsCreateForNewSubscriptionInputParam {
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+      label?: string;
+    }
+    export interface PricingPageCreateForExistingSubscriptionInputParam {
+      id: string;
+    }
+    export interface SubscriptionCreateForExistingSubscriptionInputParam {
+      id: string;
+    }
+
+    export interface DiscountsCreateForExistingSubscriptionInputParam {
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+      label?: string;
+    }
+  }
+}

package/types/resources/PromotionalCredit.d.ts

@@ -0,0 +1,111 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface PromotionalCredit {
+    id: string;
+    customer_id: string;
+    type: 'increment' | 'decrement';
+    amount_in_decimal?: string;
+    amount: number;
+    currency_code: string;
+    description: string;
+    credit_type: CreditTypeEnum;
+    reference?: string;
+    closing_balance: number;
+    done_by?: string;
+    created_at: number;
+  }
+
+  export namespace PromotionalCredit {
+    export class PromotionalCreditResource {
+      add(
+        input: AddInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddResponse>>;
+
+      deduct(
+        input: DeductInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeductResponse>>;
+
+      set(
+        input: SetInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SetResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        account_credit_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface AddResponse {
+      customer: Customer;
+      promotional_credit: PromotionalCredit;
+    }
+
+    export interface DeductResponse {
+      customer: Customer;
+      promotional_credit: PromotionalCredit;
+    }
+
+    export interface SetResponse {
+      customer: Customer;
+      promotional_credit: PromotionalCredit;
+    }
+
+    export interface ListResponse {
+      list: { promotional_credit: PromotionalCredit }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      promotional_credit: PromotionalCredit;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface AddInputParam {
+      customer_id: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      currency_code?: string;
+      description: string;
+      credit_type?: CreditTypeEnum;
+      reference?: string;
+    }
+    export interface DeductInputParam {
+      customer_id: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      currency_code?: string;
+      description: string;
+      credit_type?: CreditTypeEnum;
+      reference?: string;
+    }
+    export interface SetInputParam {
+      customer_id: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      currency_code?: string;
+      description: string;
+      credit_type?: CreditTypeEnum;
+      reference?: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      created_at?: filter.Timestamp;
+      type?: filter.Enum;
+      customer_id?: filter.String;
+    }
+  }
+}

package/types/resources/Purchase.d.ts

@@ -0,0 +1,202 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Purchase {
+    id?: string;
+    customer_id: string;
+    created_at?: number;
+    modified_at?: number;
+    subscription_ids?: string[];
+    invoice_ids?: string[];
+  }
+
+  export namespace Purchase {
+    export class PurchaseResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      estimate(
+        input: EstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<EstimateResponse>>;
+    }
+
+    export interface CreateResponse {
+      purchase: Purchase;
+    }
+
+    export interface EstimateResponse {
+      estimate: Estimate;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      customer_id: string;
+      payment_source_id?: string;
+      invoice_info?: InvoiceInfoCreateInputParam;
+      payment_schedule?: PaymentScheduleCreateInputParam;
+      statement_descriptor?: StatementDescriptorCreateInputParam;
+      purchase_items?: PurchaseItemsCreateInputParam[];
+      item_tiers?: ItemTiersCreateInputParam[];
+      shipping_addresses?: ShippingAddressesCreateInputParam[];
+      discounts?: DiscountsCreateInputParam[];
+      subscription_info?: SubscriptionInfoCreateInputParam[];
+      contract_terms?: ContractTermsCreateInputParam[];
+    }
+    export interface EstimateInputParam {
+      client_profile_id?: string;
+      customer_id?: string;
+      customer?: CustomerEstimateInputParam;
+      billing_address?: BillingAddressEstimateInputParam;
+      purchase_items?: PurchaseItemsEstimateInputParam[];
+      item_tiers?: ItemTiersEstimateInputParam[];
+      shipping_addresses?: ShippingAddressesEstimateInputParam[];
+      discounts?: DiscountsEstimateInputParam[];
+      subscription_info?: SubscriptionInfoEstimateInputParam[];
+      contract_terms?: ContractTermsEstimateInputParam[];
+    }
+    export interface StatementDescriptorCreateInputParam {
+      descriptor?: string;
+    }
+    export interface PaymentScheduleCreateInputParam {
+      scheme_id?: string;
+      amount?: number;
+    }
+    export interface InvoiceInfoCreateInputParam {
+      po_number?: string;
+      notes?: string;
+    }
+
+    export interface SubscriptionInfoCreateInputParam {
+      index: number;
+      subscription_id?: string;
+      billing_cycles?: number;
+      contract_term_billing_cycle_on_renewal?: number;
+      meta_data?: any;
+    }
+    export interface PurchaseItemsCreateInputParam {
+      index: number;
+      item_price_id: string;
+      quantity?: number;
+      unit_amount?: number;
+      unit_amount_in_decimal?: string;
+      quantity_in_decimal?: string;
+    }
+    export interface DiscountsCreateInputParam {
+      index?: number;
+      coupon_id?: string;
+      percentage?: number;
+      amount?: number;
+      included_in_mrr?: boolean;
+    }
+    export interface ContractTermsCreateInputParam {
+      index: number;
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+    }
+    export interface ItemTiersCreateInputParam {
+      index: number;
+      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 ShippingAddressesCreateInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state?: string;
+      state_code?: string;
+      country?: string;
+      zip?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+    export interface BillingAddressEstimateInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+    export interface CustomerEstimateInputParam {
+      vat_number?: string;
+      vat_number_prefix?: string;
+      registered_for_gst?: boolean;
+      taxability?: TaxabilityEnum;
+      entity_code?: EntityCodeEnum;
+      exempt_number?: string;
+      exemption_details?: any;
+      customer_type?: CustomerTypeEnum;
+    }
+
+    export interface SubscriptionInfoEstimateInputParam {
+      index: number;
+      subscription_id?: string;
+      billing_cycles?: number;
+      contract_term_billing_cycle_on_renewal?: number;
+    }
+    export interface PurchaseItemsEstimateInputParam {
+      index: number;
+      item_price_id: string;
+      quantity?: number;
+      unit_amount?: number;
+      unit_amount_in_decimal?: string;
+      quantity_in_decimal?: string;
+    }
+    export interface DiscountsEstimateInputParam {
+      index?: number;
+      coupon_id?: string;
+      percentage?: number;
+      amount?: number;
+      included_in_mrr?: boolean;
+    }
+    export interface ContractTermsEstimateInputParam {
+      index: number;
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+    }
+    export interface ItemTiersEstimateInputParam {
+      index: number;
+      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 ShippingAddressesEstimateInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state?: string;
+      state_code?: string;
+      country?: string;
+      zip?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+  }
+}