chargebee 3.0.0-beta.3 → 3.0.0-beta.5

package/types/resources/Invoice.d.ts

@@ -16,7 +16,7 @@ declare module 'chargebee' {
       | 'voided'
       | 'pending';
     vat_number?: string;
-    price_type: PriceType;
+    price_type: PriceTypeEnum;
     date?: number;
     due_date?: number;
     net_term_days?: number;
@@ -71,7 +71,7 @@ declare module 'chargebee' {
     deleted: boolean;
     tax_category?: string;
     vat_number_prefix?: string;
-    channel?: Channel;
+    channel?: ChannelEnum;
     business_entity_id?: string;
     site_details_at_creation?: Invoice.SiteDetailsAtCreation;
     tax_origin?: Invoice.TaxOrigin;
@@ -715,7 +715,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
       index: number;
     }
     export interface StatementDescriptor {
@@ -736,7 +736,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface Einvoice {
       id: string;
@@ -776,11 +776,11 @@ declare module 'chargebee' {
       coupon_ids?: string[];
       authorization_transaction_id?: string;
       payment_source_id?: string;
-      auto_collection?: AutoCollection;
+      auto_collection?: AutoCollectionEnum;
       token_id?: string;
       replace_primary_payment_source?: boolean;
       retain_payment_source?: boolean;
-      payment_initiator?: PaymentInitiator;
+      payment_initiator?: PaymentInitiatorEnum;
       shipping_address?: ShippingAddressCreateInputParam;
       statement_descriptor?: StatementDescriptorCreateInputParam;
       card?: CardCreateInputParam;
@@ -806,12 +806,12 @@ declare module 'chargebee' {
       coupon_ids?: string[];
       authorization_transaction_id?: string;
       payment_source_id?: string;
-      auto_collection?: AutoCollection;
+      auto_collection?: AutoCollectionEnum;
       invoice_date?: number;
       token_id?: string;
       replace_primary_payment_source?: boolean;
       retain_payment_source?: boolean;
-      payment_initiator?: PaymentInitiator;
+      payment_initiator?: PaymentInitiatorEnum;
       shipping_address?: ShippingAddressCreateForChargeItemsAndChargesInputParam;
       statement_descriptor?: StatementDescriptorCreateForChargeItemsAndChargesInputParam;
       card?: CardCreateForChargeItemsAndChargesInputParam;
@@ -839,13 +839,13 @@ declare module 'chargebee' {
        */;
 
       coupon?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       po_number?: string;
       invoice_date?: number;
       payment_source_id?: string;
-      payment_initiator?: PaymentInitiator;
+      payment_initiator?: PaymentInitiatorEnum;
       tax_providers_fields?: TaxProvidersFieldsChargeInputParam[];
     }
     export interface ChargeAddonInputParam {
@@ -866,7 +866,7 @@ declare module 'chargebee' {
       po_number?: string;
       invoice_date?: number;
       payment_source_id?: string;
-      payment_initiator?: PaymentInitiator;
+      payment_initiator?: PaymentInitiatorEnum;
     }
     export interface CreateForChargeItemInputParam {
       customer_id?: string;
@@ -874,7 +874,7 @@ declare module 'chargebee' {
       po_number?: string;
       coupon?: string;
       payment_source_id?: string;
-      payment_initiator?: PaymentInitiator;
+      payment_initiator?: PaymentInitiatorEnum;
       invoice_date?: number;
       item_price?: ItemPriceCreateForChargeItemInputParam;
       item_tiers?: ItemTiersCreateForChargeItemInputParam[];
@@ -888,8 +888,8 @@ declare module 'chargebee' {
       customer_id?: string;
       subscription_id?: string;
       po_number?: string;
-      price_type?: PriceType;
-      tax_override_reason?: TaxOverrideReason;
+      price_type?: PriceTypeEnum;
+      tax_override_reason?: TaxOverrideReasonEnum;
       vat_number?: string;
       vat_number_prefix?: string;
       date: number;
@@ -973,7 +973,7 @@ declare module 'chargebee' {
       offset?: string;
     }
     export interface PdfInputParam {
-      disposition_type?: DispositionType;
+      disposition_type?: DispositionTypeEnum;
     }
     export interface ListPaymentReferenceNumbersInputParam {
       limit?: number;
@@ -984,7 +984,7 @@ declare module 'chargebee' {
     export interface AddChargeInputParam {
       amount: number;
       description: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       avalara_tax_code?: string;
@@ -1022,7 +1022,7 @@ declare module 'chargebee' {
       authorization_transaction_id?: string;
       payment_source_id?: string;
       comment?: string;
-      payment_initiator?: PaymentInitiator;
+      payment_initiator?: PaymentInitiatorEnum;
     }
     export interface RecordPaymentInputParam {
       comment?: string;
@@ -1092,14 +1092,14 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface PaymentMethodCreateInputParam {
-      type?: Type;
+      type?: TypeEnum;
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      gateway?: Gateway;
+      gateway?: GatewayEnum;
       gateway_account_id?: string;
       reference_id?: string;
       tmp_token?: string;
@@ -1118,9 +1118,9 @@ declare module 'chargebee' {
       account_number?: string;
       routing_number?: string;
       bank_code?: string;
-      account_type?: AccountType;
-      account_holder_type?: AccountHolderType;
-      echeck_type?: EcheckType;
+      account_type?: AccountTypeEnum;
+      account_holder_type?: AccountHolderTypeEnum;
+      echeck_type?: EcheckTypeEnum;
       issuing_country?: string;
       swedish_identity_number?: string;
       billing_address?: any;
@@ -1161,7 +1161,7 @@ declare module 'chargebee' {
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      gateway?: Gateway;
+      gateway?: GatewayEnum;
       gateway_account_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1196,7 +1196,7 @@ declare module 'chargebee' {
       avalara_tax_code?: string;
       hsn_code?: string;
       taxjar_product_code?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       date_from?: number;
@@ -1217,7 +1217,7 @@ declare module 'chargebee' {
       field_value?: string;
     }
     export interface NotesToRemoveCreateInputParam {
-      entity_type?: EntityType;
+      entity_type?: EntityTypeEnum;
       entity_id?: string;
     }
     export interface StatementDescriptorCreateForChargeItemsAndChargesInputParam {
@@ -1237,14 +1237,14 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface PaymentMethodCreateForChargeItemsAndChargesInputParam {
-      type?: Type;
+      type?: TypeEnum;
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      gateway?: Gateway;
+      gateway?: GatewayEnum;
       gateway_account_id?: string;
       reference_id?: string;
       tmp_token?: string;
@@ -1263,9 +1263,9 @@ declare module 'chargebee' {
       account_number?: string;
       routing_number?: string;
       bank_code?: string;
-      account_type?: AccountType;
-      account_holder_type?: AccountHolderType;
-      echeck_type?: EcheckType;
+      account_type?: AccountTypeEnum;
+      account_holder_type?: AccountHolderTypeEnum;
+      echeck_type?: EcheckTypeEnum;
       issuing_country?: string;
       swedish_identity_number?: string;
       billing_address?: any;
@@ -1306,7 +1306,7 @@ declare module 'chargebee' {
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      gateway?: Gateway;
+      gateway?: GatewayEnum;
       gateway_account_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1341,7 +1341,7 @@ declare module 'chargebee' {
       avalara_tax_code?: string;
       hsn_code?: string;
       taxjar_product_code?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       date_from?: number;
@@ -1350,7 +1350,7 @@ declare module 'chargebee' {
     export interface DiscountsCreateForChargeItemsAndChargesInputParam {
       percentage?: number;
       amount?: number;
-      apply_on: ApplyOn;
+      apply_on: ApplyOnEnum;
       item_price_id?: string;
     }
     export interface ItemTiersCreateForChargeItemsAndChargesInputParam {
@@ -1377,7 +1377,7 @@ declare module 'chargebee' {
       field_value?: string;
     }
     export interface NotesToRemoveCreateForChargeItemsAndChargesInputParam {
-      entity_type?: EntityType;
+      entity_type?: EntityTypeEnum;
       entity_id?: string;
     }
     export interface TaxProvidersFieldsChargeInputParam {
@@ -1417,7 +1417,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ShippingAddressImportInvoiceInputParam {
       first_name?: string;
@@ -1433,7 +1433,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface CreditNoteImportInvoiceInputParam {
       id?: string;
@@ -1466,7 +1466,7 @@ declare module 'chargebee' {
     }
     export interface PaymentsImportInvoiceInputParam {
       amount: number;
-      payment_method: PaymentMethod;
+      payment_method: PaymentMethodEnum;
       date?: number;
       reference_number?: string;
     }
@@ -1588,12 +1588,12 @@ declare module 'chargebee' {
       price_in_decimal?: string;
     }
     export interface NotesToRemoveCloseInputParam {
-      entity_type?: EntityType;
+      entity_type?: EntityTypeEnum;
       entity_id?: string;
     }
     export interface TransactionRecordPaymentInputParam {
       amount?: number;
-      payment_method: PaymentMethod;
+      payment_method: PaymentMethodEnum;
       reference_number?: string;
       custom_payment_method_id?: string;
       id_at_gateway?: string;
@@ -1627,7 +1627,7 @@ declare module 'chargebee' {
 
     export interface TransactionRecordRefundInputParam {
       amount?: number;
-      payment_method: PaymentMethod;
+      payment_method: PaymentMethodEnum;
       reference_number?: string;
       custom_payment_method_id?: string;
       date: number;
@@ -1666,7 +1666,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface StatementDescriptorUpdateDetailsInputParam {
       descriptor?: string;
@@ -1685,7 +1685,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
   }
 }

package/types/resources/InvoiceEstimate.d.ts

@@ -4,7 +4,7 @@
 declare module 'chargebee' {
   export interface InvoiceEstimate {
     recurring: boolean;
-    price_type: PriceType;
+    price_type: PriceTypeEnum;
     currency_code: string;
     sub_total: number;
     total?: number;

package/types/resources/Item.d.ts

@@ -25,7 +25,7 @@ declare module 'chargebee' {
     metered: boolean;
     usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
     archived_at?: number;
-    channel?: Channel;
+    channel?: ChannelEnum;
     applicable_items?: Item.ApplicableItem[];
     bundle_items?: Item.BundleItem[];
     bundle_configuration?: Item.BundleConfiguration;
@@ -173,7 +173,7 @@ declare module 'chargebee' {
 
     export interface BundleItemsToAddCreateInputParam {
       item_id?: string;
-      item_type?: ItemType;
+      item_type?: ItemTypeEnum;
       quantity?: number;
       price_allocation?: number;
     }
@@ -183,19 +183,19 @@ declare module 'chargebee' {
 
     export interface BundleItemsToAddUpdateInputParam {
       item_id?: string;
-      item_type?: ItemType;
+      item_type?: ItemTypeEnum;
       quantity?: number;
       price_allocation?: number;
     }
     export interface BundleItemsToUpdateUpdateInputParam {
       item_id?: string;
-      item_type?: ItemType;
+      item_type?: ItemTypeEnum;
       quantity?: number;
       price_allocation?: number;
     }
     export interface BundleItemsToRemoveUpdateInputParam {
       item_id?: string;
-      item_type?: ItemType;
+      item_type?: ItemTypeEnum;
     }
     export interface BundleConfigurationItemListInputParam {
       type?: filter.Enum;

package/types/resources/ItemEntitlement.d.ts

@@ -83,11 +83,11 @@ declare module 'chargebee' {
       include_drafts?: boolean;
     }
     export interface AddItemEntitlementsInputParam {
-      action: Action;
+      action: ActionEnum;
       item_entitlements?: ItemEntitlementsAddItemEntitlementsInputParam[];
     }
     export interface UpsertOrRemoveItemEntitlementsForItemInputParam {
-      action: Action;
+      action: ActionEnum;
       item_entitlements?: ItemEntitlementsUpsertOrRemoveItemEntitlementsForItemInputParam[];
     }
     export interface ItemEntitlementsAddItemEntitlementsInputParam {

package/types/resources/ItemFamily.d.ts

@@ -10,7 +10,7 @@ declare module 'chargebee' {
     status?: 'active' | 'deleted';
     resource_version?: number;
     updated_at?: number;
-    channel?: Channel;
+    channel?: ChannelEnum;
   }
 
   export namespace ItemFamily {

package/types/resources/ItemPrice.d.ts

@@ -13,7 +13,7 @@ declare module 'chargebee' {
     external_name?: string;
     price_variant_id?: string;
     proration_type?: 'site_default' | 'partial_term' | 'full_term';
-    pricing_model: PricingModel;
+    pricing_model: PricingModelEnum;
     price?: number;
     price_in_decimal?: string;
     period?: number;
@@ -30,10 +30,11 @@ declare module 'chargebee' {
     billing_cycles?: number;
     free_quantity: number;
     free_quantity_in_decimal?: string;
-    channel?: Channel;
+    channel?: ChannelEnum;
     resource_version?: number;
     updated_at?: number;
     created_at: number;
+    usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
     archived_at?: number;
     invoice_notes?: string;
     tiers?: ItemPrice.Tier[];
@@ -42,7 +43,7 @@ declare module 'chargebee' {
     tax_providers_fields?: ItemPrice.TaxProvidersField[];
     accounting_detail?: ItemPrice.AccountingDetail;
     metadata?: any;
-    item_type?: ItemType;
+    item_type?: ItemTypeEnum;
     archivable?: boolean;
     parent_item_id?: string;
     show_description_in_invoices?: boolean;
@@ -131,7 +132,7 @@ declare module 'chargebee' {
     }
     export interface TaxDetail {
       tax_profile_id?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       avalara_tax_code?: string;
@@ -170,7 +171,8 @@ declare module 'chargebee' {
       metadata?: any;
       show_description_in_invoices?: boolean;
       show_description_in_quotes?: boolean;
-      pricing_model?: PricingModel;
+      usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
+      pricing_model?: PricingModelEnum;
       price?: number;
       price_in_decimal?: string;
       period_unit?: 'day' | 'week' | 'month' | 'year';
@@ -197,13 +199,14 @@ declare module 'chargebee' {
       price_variant_id?: string;
       status?: 'active' | 'archived';
       external_name?: string;
+      usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
       currency_code?: string;
       invoice_notes?: string;
       is_taxable?: boolean;
       free_quantity?: number;
       free_quantity_in_decimal?: string;
       metadata?: any;
-      pricing_model?: PricingModel;
+      pricing_model?: PricingModelEnum;
       price?: number;
       price_in_decimal?: string;
       period_unit?: 'day' | 'week' | 'month' | 'year';
@@ -263,7 +266,7 @@ declare module 'chargebee' {
       tax_profile_id?: string;
       avalara_tax_code?: string;
       hsn_code?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       taxjar_product_code?: string;
@@ -294,7 +297,7 @@ declare module 'chargebee' {
       tax_profile_id?: string;
       avalara_tax_code?: string;
       hsn_code?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       taxjar_product_code?: string;

package/types/resources/Order.d.ts

@@ -38,7 +38,7 @@ declare module 'chargebee' {
       | 'order_resent';
     payment_status?: 'not_paid' | 'paid';
     order_type?: 'manual' | 'system_generated';
-    price_type: PriceType;
+    price_type: PriceTypeEnum;
     reference_id?: string;
     fulfillment_status?: string;
     order_date?: number;
@@ -257,7 +257,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
       index: number;
     }
     export interface BillingAddress {
@@ -274,7 +274,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -508,7 +508,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
 
     export interface OrderLineItemsUpdateInputParam {
@@ -538,7 +538,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ShippingAddressImportOrderInputParam {
       first_name?: string;
@@ -554,7 +554,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
 
     export interface CreditNoteCancelInputParam {

package/types/resources/PaymentScheduleEstimate.d.ts

@@ -0,0 +1,25 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentScheduleEstimate {
+    id: string;
+    scheme_id: string;
+    entity_type: 'invoice';
+    entity_id?: string;
+    amount: number;
+    currency_code?: string;
+    schedule_entries?: PaymentScheduleEstimate.ScheduleEntry[];
+  }
+
+  export namespace PaymentScheduleEstimate {
+    export interface ScheduleEntry {
+      id: string;
+      date: number;
+      amount: number;
+      status: 'posted' | 'payment_due' | 'paid';
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/PaymentScheduleScheme.d.ts

@@ -4,6 +4,7 @@
 declare module 'chargebee' {
   export interface PaymentScheduleScheme {
     id: string;
+    name?: string;
     description?: string;
     number_of_schedules: number;
     period_unit: 'day' | 'week' | 'month';

package/types/resources/PaymentSource.d.ts

@@ -8,7 +8,7 @@ declare module 'chargebee' {
     updated_at?: number;
     created_at: number;
     customer_id: string;
-    type: Type;
+    type: TypeEnum;
     reference_id: string;
     status:
       | 'valid'
@@ -16,7 +16,7 @@ declare module 'chargebee' {
       | 'expired'
       | 'invalid'
       | 'pending_verification';
-    gateway: Gateway;
+    gateway: GatewayEnum;
     gateway_account_id?: string;
     ip_address?: string;
     issuing_country?: string;
@@ -224,6 +224,8 @@ declare module 'chargebee' {
         | 'carnet'
         | 'rupay'
         | 'maestro'
+        | 'dankort'
+        | 'cartes_bancaires'
         | 'not_applicable';
       funding_type:
         | 'credit'
@@ -247,12 +249,12 @@ declare module 'chargebee' {
       name_on_account?: string;
       first_name?: string;
       last_name?: string;
-      direct_debit_scheme?: DirectDebitScheme;
+      direct_debit_scheme?: DirectDebitSchemeEnum;
       bank_name?: string;
       mandate_id?: string;
-      account_type?: AccountType;
-      echeck_type?: EcheckType;
-      account_holder_type?: AccountHolderType;
+      account_type?: AccountTypeEnum;
+      echeck_type?: EcheckTypeEnum;
+      account_holder_type?: AccountHolderTypeEnum;
       email?: string;
     }
     export interface CustVoucherSource {
@@ -275,7 +277,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface AmazonPayment {
       email?: string;
@@ -305,7 +307,7 @@ declare module 'chargebee' {
     export interface CreateUsingTempTokenInputParam {
       customer_id: string;
       gateway_account_id?: string;
-      type: Type;
+      type: TypeEnum;
       tmp_token: string;
       issuing_country?: string;
       replace_primary_payment_source?: boolean;
@@ -313,7 +315,7 @@ declare module 'chargebee' {
     }
     export interface CreateUsingPermanentTokenInputParam {
       customer_id: string;
-      type: Type;
+      type: TypeEnum;
       gateway_account_id?: string;
       reference_id?: string;
       issuing_country?: string;
@@ -419,7 +421,9 @@ declare module 'chargebee' {
         | 'hipercard'
         | 'carnet'
         | 'rupay'
-        | 'maestro';
+        | 'maestro'
+        | 'dankort'
+        | 'cartes_bancaires';
       funding_type?: 'credit' | 'debit' | 'prepaid' | 'not_known';
     }
 
@@ -458,7 +462,7 @@ declare module 'chargebee' {
     }
 
     export interface VoucherPaymentSourceCreateVoucherPaymentSourceInputParam {
-      voucher_type: VoucherType;
+      voucher_type: VoucherTypeEnum;
       gateway_account_id?: string;
       tax_id?: string;
       billing_address?: any;
@@ -494,9 +498,9 @@ declare module 'chargebee' {
       account_number?: string;
       routing_number?: string;
       bank_code?: string;
-      account_type?: AccountType;
-      account_holder_type?: AccountHolderType;
-      echeck_type?: EcheckType;
+      account_type?: AccountTypeEnum;
+      account_holder_type?: AccountHolderTypeEnum;
+      echeck_type?: EcheckTypeEnum;
       swedish_identity_number?: string;
       billing_address?: any;
     }