chargebee 3.0.0 → 3.0.2

package/types/resources/UnbilledCharge.d.ts

@@ -0,0 +1,209 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface UnbilledCharge {
+    id?: string;
+    customer_id?: string;
+    subscription_id?: string;
+    date_from?: number;
+    date_to?: number;
+    unit_amount?: number;
+    pricing_model?: PricingModelEnum;
+    quantity?: number;
+    amount?: number;
+    currency_code: string;
+    discount_amount?: number;
+    description?: string;
+    entity_type:
+      | 'adhoc'
+      | 'plan_item_price'
+      | 'addon_item_price'
+      | 'charge_item_price'
+      | 'plan_setup'
+      | 'plan'
+      | 'addon';
+    entity_id?: string;
+    is_voided: boolean;
+    voided_at?: number;
+    unit_amount_in_decimal?: string;
+    quantity_in_decimal?: string;
+    amount_in_decimal?: string;
+    updated_at: number;
+    tiers?: UnbilledCharge.Tier[];
+    is_advance_charge?: boolean;
+    business_entity_id?: string;
+    deleted: boolean;
+  }
+
+  export namespace UnbilledCharge {
+    export class UnbilledChargeResource {
+      createUnbilledCharge(
+        input: CreateUnbilledChargeInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateUnbilledChargeResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      invoiceUnbilledCharges(
+        input?: InvoiceUnbilledChargesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<InvoiceUnbilledChargesResponse>>;
+
+      delete(
+        unbilled_charge_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      invoiceNowEstimate(
+        input?: InvoiceNowEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<InvoiceNowEstimateResponse>>;
+    }
+
+    export interface CreateUnbilledChargeResponse {
+      unbilled_charges: UnbilledCharge[];
+    }
+
+    export interface CreateResponse {
+      unbilled_charges: UnbilledCharge[];
+    }
+
+    export interface InvoiceUnbilledChargesResponse {
+      invoices: Invoice[];
+    }
+
+    export interface DeleteResponse {
+      unbilled_charge: UnbilledCharge;
+    }
+
+    export interface ListResponse {
+      list: { unbilled_charge: UnbilledCharge }[];
+      next_offset?: string;
+    }
+
+    export interface InvoiceNowEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface Tier {
+      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;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateUnbilledChargeInputParam {
+      subscription_id: string;
+      currency_code?: string;
+      addons?: AddonsCreateUnbilledChargeInputParam[];
+      charges?: ChargesCreateUnbilledChargeInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateUnbilledChargeInputParam[];
+    }
+    export interface CreateInputParam {
+      subscription_id: string;
+      currency_code?: string;
+      item_prices?: ItemPricesCreateInputParam[];
+      item_tiers?: ItemTiersCreateInputParam[];
+      charges?: ChargesCreateInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
+    }
+    export interface InvoiceUnbilledChargesInputParam {
+      subscription_id?: string;
+      customer_id?: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      include_deleted?: boolean;
+      is_voided?: boolean;
+      subscription_id?: filter.String;
+      customer_id?: filter.String;
+    }
+    export interface InvoiceNowEstimateInputParam {
+      subscription_id?: string;
+      customer_id?: string;
+    }
+    export interface ChargesCreateUnbilledChargeInputParam {
+      amount?: number;
+      amount_in_decimal?: string;
+      description?: string;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      avalara_tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface AddonsCreateUnbilledChargeInputParam {
+      id?: string;
+      quantity?: number;
+      unit_price?: number;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface TaxProvidersFieldsCreateUnbilledChargeInputParam {
+      provider_name?: string;
+      field_id?: string;
+      field_value?: string;
+    }
+    export interface ChargesCreateInputParam {
+      amount?: number;
+      amount_in_decimal?: string;
+      description?: string;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      avalara_tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface ItemTiersCreateInputParam {
+      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 ItemPricesCreateInputParam {
+      item_price_id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface TaxProvidersFieldsCreateInputParam {
+      provider_name?: string;
+      field_id?: string;
+      field_value?: string;
+    }
+  }
+}

package/types/resources/Usage.d.ts

@@ -0,0 +1,113 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Usage {
+    id?: string;
+    usage_date: number;
+    subscription_id: string;
+    item_price_id: string;
+    invoice_id?: string;
+    line_item_id?: string;
+    quantity: string;
+    source?: SourceEnum;
+    note?: string;
+    resource_version?: number;
+    updated_at?: number;
+    created_at: number;
+  }
+
+  export namespace Usage {
+    export class UsageResource {
+      create(
+        subscription_id: string,
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        subscription_id: string,
+        input: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        subscription_id: string,
+        input: DeleteInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      pdf(
+        input: PdfInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PdfResponse>>;
+    }
+
+    export interface CreateResponse {
+      usage: Usage;
+    }
+
+    export interface RetrieveResponse {
+      usage: Usage;
+    }
+
+    export interface DeleteResponse {
+      usage: Usage;
+    }
+
+    export interface ListResponse {
+      list: { usage: Usage }[];
+      next_offset?: string;
+    }
+
+    export interface PdfResponse {
+      download: Download;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id?: string;
+      item_price_id: string;
+      quantity: string;
+      usage_date: number /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      dedupe_option?: DedupeOptionEnum;
+      note?: string;
+    }
+    export interface RetrieveInputParam {
+      id: string;
+    }
+    export interface DeleteInputParam {
+      id: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      subscription_id?: filter.String;
+      usage_date?: filter.Timestamp;
+      updated_at?: filter.Timestamp;
+      item_price_id?: filter.String;
+      invoice_id?: filter.String;
+      source?: filter.Enum;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface PdfInputParam {
+      disposition_type?: DispositionTypeEnum;
+      invoice?: InvoicePdfInputParam;
+    }
+    export interface InvoicePdfInputParam {
+      id: string;
+    }
+  }
+}

package/types/resources/VirtualBankAccount.d.ts

@@ -0,0 +1,125 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface VirtualBankAccount {
+    id: string;
+    customer_id: string;
+    email: string;
+    scheme?:
+      | 'ach_credit'
+      | 'sepa_credit'
+      | 'us_automated_bank_transfer'
+      | 'gb_automated_bank_transfer'
+      | 'eu_automated_bank_transfer'
+      | 'jp_automated_bank_transfer'
+      | 'mx_automated_bank_transfer';
+    bank_name?: string;
+    account_number: string;
+    routing_number?: string;
+    swift_code: string;
+    gateway: GatewayEnum;
+    gateway_account_id: string;
+    resource_version?: number;
+    updated_at?: number;
+    created_at: number;
+    reference_id: string;
+    deleted: boolean;
+  }
+
+  export namespace VirtualBankAccount {
+    export class VirtualBankAccountResource {
+      createUsingPermanentToken(
+        input: CreateUsingPermanentTokenInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateUsingPermanentTokenResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        virtual_bank_account_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      delete(
+        virtual_bank_account_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      deleteLocal(
+        virtual_bank_account_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteLocalResponse>>;
+    }
+
+    export interface CreateUsingPermanentTokenResponse {
+      virtual_bank_account: VirtualBankAccount;
+      customer?: Customer;
+    }
+
+    export interface CreateResponse {
+      virtual_bank_account: VirtualBankAccount;
+      customer?: Customer;
+    }
+
+    export interface RetrieveResponse {
+      virtual_bank_account: VirtualBankAccount;
+    }
+
+    export interface ListResponse {
+      list: { virtual_bank_account: VirtualBankAccount }[];
+      next_offset?: string;
+    }
+
+    export interface DeleteResponse {
+      virtual_bank_account: VirtualBankAccount;
+    }
+
+    export interface DeleteLocalResponse {
+      virtual_bank_account: VirtualBankAccount;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateUsingPermanentTokenInputParam {
+      customer_id: string;
+      reference_id: string;
+      scheme?:
+        | 'ach_credit'
+        | 'sepa_credit'
+        | 'us_automated_bank_transfer'
+        | 'gb_automated_bank_transfer'
+        | 'eu_automated_bank_transfer'
+        | 'jp_automated_bank_transfer'
+        | 'mx_automated_bank_transfer';
+    }
+    export interface CreateInputParam {
+      customer_id: string;
+      email?: string;
+      scheme?:
+        | 'ach_credit'
+        | 'sepa_credit'
+        | 'us_automated_bank_transfer'
+        | 'gb_automated_bank_transfer'
+        | 'eu_automated_bank_transfer'
+        | 'jp_automated_bank_transfer'
+        | 'mx_automated_bank_transfer';
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      customer_id?: filter.String;
+      updated_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+    }
+  }
+}

package/types/resources/filter.d.ts

@@ -0,0 +1,52 @@
+declare module 'chargebee' {
+  export namespace filter {
+    export interface String {
+      is?: string;
+      is_not?: string;
+      starts_with?: string;
+      is_present?: boolean;
+      in?: string[];
+      not_in?: string[];
+    }
+
+    export interface Timestamp {
+      on?: number;
+      before?: number;
+      after?: number;
+      between?: [number, number];
+      is_present?: boolean;
+    }
+
+    export interface Date {
+      on?: number;
+      before?: number;
+      after?: number;
+      between?: [number, number];
+      is_present?: boolean;
+    }
+
+    export interface Number {
+      gt?: number;
+      lt?: number;
+      gte?: number;
+      lte?: number;
+      between?: [number, number];
+      is?: number;
+      is_not?: number;
+      is_present?: number;
+    }
+
+    export interface Boolean {
+      is?: boolean;
+      is_present?: boolean;
+    }
+
+    export interface Enum {
+      is?: any;
+      is_not?: any;
+      is_present?: any;
+      in?: any[];
+      not_in?: any[];
+    }
+  }
+}