chargebee 3.0.1 → 3.1.0

package/types/resources/CreditNoteEstimate.d.ts

@@ -0,0 +1,143 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface CreditNoteEstimate {
+    reference_invoice_id: string;
+    type: 'adjustment' | 'refundable';
+    price_type: PriceTypeEnum;
+    currency_code: string;
+    sub_total: number;
+    total: number;
+    amount_allocated: number;
+    amount_available: number;
+    line_items?: CreditNoteEstimate.LineItem[];
+    discounts?: CreditNoteEstimate.Discount[];
+    taxes?: CreditNoteEstimate.Tax[];
+    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
+    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
+    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
+    round_off_amount?: number;
+    customer_id?: string;
+  }
+
+  export namespace CreditNoteEstimate {
+    export interface LineItem {
+      id?: string;
+      subscription_id?: string;
+      date_from: number;
+      date_to: number;
+      unit_amount: number;
+      quantity?: number;
+      amount?: number;
+      pricing_model?:
+        | 'flat_fee'
+        | 'per_unit'
+        | 'tiered'
+        | 'volume'
+        | 'stairstep';
+      is_taxed: boolean;
+      tax_amount?: number;
+      tax_rate?: number;
+      unit_amount_in_decimal?: string;
+      quantity_in_decimal?: string;
+      amount_in_decimal?: string;
+      discount_amount?: number;
+      item_level_discount_amount?: number;
+      usage_percentage?: string;
+      reference_line_item_id?: string;
+      description: string;
+      entity_description?: string;
+      entity_type:
+        | 'adhoc'
+        | 'plan_item_price'
+        | 'addon_item_price'
+        | 'charge_item_price'
+        | 'plan_setup'
+        | 'plan'
+        | 'addon';
+      tax_exempt_reason?:
+        | 'tax_not_configured'
+        | 'region_non_taxable'
+        | 'export'
+        | 'customer_exempt'
+        | 'product_exempt'
+        | 'zero_rated'
+        | 'reverse_charge'
+        | 'high_value_physical_goods'
+        | 'zero_value_item'
+        | 'tax_not_configured_external_provider';
+      entity_id?: string;
+      customer_id?: string;
+    }
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      entity_id?: string;
+      coupon_set_code?: string;
+    }
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
+    }
+    export interface LineItemTax {
+      line_item_id?: string;
+      tax_name: string;
+      tax_rate: number;
+      date_to?: number;
+      date_from?: number;
+      prorated_taxable_amount?: number;
+      is_partial_tax_applied?: boolean;
+      is_non_compliance_tax?: boolean;
+      taxable_amount: number;
+      tax_amount: number;
+      tax_juris_type?:
+        | 'country'
+        | 'federal'
+        | 'state'
+        | 'county'
+        | 'city'
+        | 'special'
+        | 'unincorporated'
+        | 'other';
+      tax_juris_name?: string;
+      tax_juris_code?: string;
+      tax_amount_in_local_currency?: number;
+      local_currency_code?: string;
+    }
+    export interface LineItemDiscount {
+      line_item_id: string;
+      discount_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      coupon_id?: string;
+      entity_id?: string;
+      discount_amount: number;
+    }
+    export interface LineItemTier {
+      line_item_id?: string;
+      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
+    //---------------
+  }
+}

package/types/resources/Currency.d.ts

@@ -0,0 +1,91 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Currency {
+    id?: string;
+    enabled: boolean;
+    forex_type?: 'manual' | 'auto';
+    currency_code?: string;
+    is_base_currency?: boolean;
+    manual_exchange_rate?: string;
+  }
+
+  export namespace Currency {
+    export class CurrencyResource {
+      list(
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        site_currency_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        site_currency_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      addSchedule(
+        site_currency_id: string,
+        input: AddScheduleInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddScheduleResponse>>;
+
+      removeSchedule(
+        site_currency_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RemoveScheduleResponse>>;
+    }
+
+    export interface ListResponse {
+      currency: Currency;
+    }
+
+    export interface RetrieveResponse {
+      currency: Currency;
+    }
+
+    export interface CreateResponse {
+      currency: Currency;
+    }
+
+    export interface UpdateResponse {
+      currency: Currency;
+    }
+
+    export interface AddScheduleResponse {
+      scheduled_at: number;
+      currency: Currency;
+    }
+
+    export interface RemoveScheduleResponse {
+      scheduled_at: number;
+      currency: Currency;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      currency_code: string;
+      forex_type: 'manual' | 'auto';
+      manual_exchange_rate?: string;
+    }
+    export interface UpdateInputParam {
+      forex_type: 'manual' | 'auto';
+      manual_exchange_rate?: string;
+    }
+    export interface AddScheduleInputParam {
+      manual_exchange_rate: string;
+      schedule_at: number;
+    }
+  }
+}