chargebee 3.33.0 → 3.34.0

package/types/resources/CreditNote.d.ts

@@ -62,6 +62,7 @@ declare module 'chargebee' {
     create_reason_code?: string;
     vat_number_prefix?: string;
     business_entity_id?: string;
+    brand_id?: string;
     shipping_address?: CreditNote.ShippingAddress;
     billing_address?: CreditNote.BillingAddress;
     einvoice?: CreditNote.Einvoice;
@@ -110,6 +111,11 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<VoidCreditNoteResponse>>;
 
+      sendEmail(
+        credit_note_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SendEmailResponse>>;
+
       list(
         input?: ListInputParam,
         headers?: ChargebeeRequestHeader,
@@ -190,6 +196,10 @@ declare module 'chargebee' {
       credit_note: CreditNote;
     }
 
+    export interface SendEmailResponse {
+      email_logs: EmailLog[];
+    }
+
     export interface ListResponse {
       list: { credit_note: CreditNote }[];
       next_offset?: string;
@@ -718,6 +728,8 @@ declare module 'chargebee' {
       tax9_amount?: number;
       tax10_name?: string;
       tax10_amount?: number;
+      is_partial_tax_applied?: boolean;
+      taxable_amount?: number;
       proration_mode?:
         | 'reset'
         | 'delta'

package/types/resources/CustomDataSchema.d.ts

@@ -0,0 +1,15 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface CustomDataSchema {
+    id: string;
+    display_name: string;
+    entity_type: EntityTypeEnum;
+    schema_definition: string;
+    status: 'active' | 'archived';
+    created_at: number;
+    modified_at: number;
+    updated_at?: number;
+  }
+}

package/types/resources/Customer.d.ts

@@ -83,6 +83,7 @@ declare module 'chargebee' {
     vat_number_prefix?: string;
     entity_identifier_scheme?: string;
     entity_identifier_standard?: string;
+    brand_id?: string;
   }
 
   export namespace Customer {
@@ -192,6 +193,11 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<CollectPaymentResponse>>;
 
+      sendPaymentRequest(
+        customer_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SendPaymentRequestResponse>>;
+
       delete(
         customer_id: string,
         input?: DeleteInputParam,
@@ -326,6 +332,10 @@ declare module 'chargebee' {
       transaction: Transaction;
     }
 
+    export interface SendPaymentRequestResponse {
+      email_logs: EmailLog[];
+    }
+
     export interface DeleteResponse {
       customer: Customer;
       card?: Card;
@@ -491,7 +501,8 @@ declare module 'chargebee' {
       auto_close_invoices?: boolean;
       consolidated_invoicing?: boolean;
       token_id?: string;
-      business_entity_id?: string /**
+      business_entity_id?: string;
+      brand_id?: string /**
        * @deprecated Please refer API docs to use other attributes
        */;
 
@@ -781,7 +792,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -805,7 +829,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -985,7 +1009,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       /**
        * @deprecated Please refer API docs to use other attributes
        */
@@ -1001,7 +1038,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;

package/types/resources/Dispute.d.ts

@@ -0,0 +1,65 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Dispute {
+    id: string;
+    customer_id: string;
+    transaction_id: string;
+    gateway_account_id: string;
+    id_at_gateway?: string;
+    currency_code: string;
+    amount: number;
+    reason?: string;
+    status:
+      | 'initiated'
+      | 'funds_withdrawn'
+      | 'in_review'
+      | 'cancelled'
+      | 'lost'
+      | 'won';
+    type: 'chargeback' | 'inquiry';
+    is_partial_dispute: boolean;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+  }
+
+  export namespace Dispute {
+    export class DisputeResource {
+      retrieve(
+        dispute_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      dispute: Dispute;
+    }
+
+    export interface ListResponse {
+      list: { dispute: Dispute }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      status?: filter.Enum;
+      type?: filter.Enum;
+      customer_id?: filter.String;
+      transaction_id?: filter.String;
+      amount?: filter.Number;
+      created_at?: filter.Timestamp;
+    }
+  }
+}

package/types/resources/Einvoice.d.ts

@@ -1,9 +1,11 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Einvoice {
     id: string;
+    entity_type: 'invoice' | 'credit_note';
+    entity_id: string;
     reference_id?: string;
     reference_number?: string;
     status:
@@ -21,6 +23,67 @@ declare module 'chargebee' {
       | 'conditionally_accepted'
       | 'paid';
     message?: string;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    deleted: boolean;
     provider_references?: any;
+    business_entity_id?: string;
+    artifacts?: Einvoice.Artifact[];
+  }
+
+  export namespace Einvoice {
+    export class EinvoiceResource {
+      retrieve(
+        einvoice_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      listEinvoices(
+        input?: ListEinvoicesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListEinvoicesResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      einvoice: Einvoice;
+    }
+
+    export interface ListEinvoicesResponse {
+      list: { einvoice: Einvoice }[];
+      next_offset?: string;
+    }
+
+    export interface Artifact {
+      artifact_type: string;
+      direction: 'outbound' | 'inbound';
+      status:
+        | 'scheduled'
+        | 'skipped'
+        | 'in_progress'
+        | 'success'
+        | 'failed'
+        | 'registered';
+      code?: string;
+      external_artifact_id?: string;
+      created_at: number;
+      resource_version?: number;
+      updated_at?: number;
+      deleted: boolean;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListEinvoicesInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      reference_id?: filter.String;
+      updated_at?: filter.Timestamp;
+      invoice_id?: string;
+      credit_note_id?: string;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
   }
 }

package/types/resources/EmailLog.d.ts

@@ -0,0 +1,45 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface EmailLog {
+    id: string;
+    template_name?: string;
+    from_address: string;
+    to_address: string;
+    subject: string;
+    status: StatusEnum;
+    sent_on?: number;
+    customer_id?: string;
+    site_id?: string;
+    business_entity_id?: string;
+    brand_id?: string;
+    error_message?: string;
+  }
+
+  export namespace EmailLog {
+    export class EmailLogResource {
+      emailLogsForCustomer(
+        customer_id: string,
+        input?: EmailLogsForCustomerInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<EmailLogsForCustomerResponse>>;
+    }
+
+    export interface EmailLogsForCustomerResponse {
+      list: { email_log: EmailLog }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface EmailLogsForCustomerInputParam {
+      limit?: number;
+      offset?: string;
+      sent_on?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      brand_id?: filter.String;
+    }
+  }
+}

package/types/resources/Estimate.d.ts

@@ -622,6 +622,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       item_type?: ItemTypeEnum;
+      description?: string;
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCreateSubItemEstimateInputParam {
@@ -764,6 +765,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       item_type?: ItemTypeEnum;
+      description?: string;
       charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCreateSubItemForCustomerEstimateInputParam {
@@ -927,6 +929,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       item_type?: ItemTypeEnum;
+      description?: string;
       proration_type?: ProrationTypeEnum;
     }
     export interface DiscountsUpdateSubscriptionForItemsInputParam {
@@ -1078,7 +1081,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1187,7 +1203,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Event.d.ts

@@ -20,6 +20,7 @@ declare module 'chargebee' {
     webhook_failure_reason?: string;
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
+    site_id?: string;
     api_version?: ApiVersionEnum;
     content: SubscriptionPauseScheduledContent &
       CustomerBusinessEntityChangedContent &
@@ -35,6 +36,7 @@ declare module 'chargebee' {
       SubscriptionResumedContent &
       OmnichannelOneTimeOrderItemCancelledContent &
       SubscriptionCancelledContent &
+      BusinessRuleDeletedContent &
       ItemEntitlementsRemovedContent &
       BusinessEntityCreatedContent &
       CouponSetUpdatedContent &
@@ -46,6 +48,7 @@ declare module 'chargebee' {
       SubscriptionShippingAddressUpdatedContent &
       VoucherCreateFailedContent &
       GiftClaimedContent &
+      BusinessRulesAppliedContent &
       CustomerDeletedContent &
       RefundInitiatedContent &
       InvoiceGeneratedWithBackdatingContent &
@@ -74,12 +77,15 @@ declare module 'chargebee' {
       PriceVariantDeletedContent &
       AlertStatusChangedContent &
       SubscriptionMovementFailedContent &
+      BusinessRulesetUpdatedContent &
       CustomerMovedInContent &
       SubscriptionAdvanceInvoiceScheduleUpdatedContent &
       ItemDeletedContent &
       SubscriptionRampDraftedContent &
+      BusinessRuleCreatedContent &
       VaultTokenUpdatedContent &
       DunningUpdatedContent &
+      EinvoiceCreatedContent &
       OmnichannelSubscriptionItemRecoveredContent &
       ItemEntitlementsUpdatedContent &
       TokenConsumedContent &
@@ -101,9 +107,11 @@ declare module 'chargebee' {
       CardExpiredContent &
       CreditNoteUpdatedContent &
       OmnichannelSubscriptionItemDowngradedContent &
+      BusinessRulesetDeactivatedContent &
       PriceVariantUpdatedContent &
       PromotionalCreditsDeductedContent &
       SubscriptionRampAppliedContent &
+      BusinessRulesetDeletedContent &
       SubscriptionPausedContent &
       OrderReadyToProcessContent &
       FeatureCreatedContent &
@@ -112,6 +120,7 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemResubscribedContent &
       RecordPurchaseFailedContent &
       ItemCreatedContent &
+      BusinessRulesetCreatedContent &
       TransactionUpdatedContent &
       MrrUpdatedContent &
       UnbilledChargesInvoicedContent &
@@ -141,6 +150,7 @@ declare module 'chargebee' {
       SubscriptionScheduledChangesRemovedContent &
       PendingInvoiceCreatedContent &
       EntitlementOverridesAutoRemovedContent &
+      BusinessRulesetActivatedContent &
       OmnichannelSubscriptionItemUpgradedContent &
       SubscriptionBusinessEntityChangedContent &
       OmnichannelOneTimeOrderCreatedContent &
@@ -208,11 +218,14 @@ declare module 'chargebee' {
       PaymentSourceBusinessEntityChangedContent &
       PromotionalCreditsAddedContent &
       SubscriptionRampUpdatedContent &
+      BusinessRuleDeactivatedContent &
       LedgerAccountBalanceUpdatedContent &
       VaultTokenCreatedContent &
+      EinvoiceUpdatedContent &
       CustomerEntitlementsUpdatedContent &
       PaymentSourceExpiredContent &
       CustomerMovedOutContent &
+      BusinessRuleReleasedContent &
       SubscriptionEntitlementsUpdatedContent &
       OmnichannelSubscriptionItemDunningExpiredContent &
       HierarchyCreatedContent &
@@ -226,11 +239,13 @@ declare module 'chargebee' {
       TaxWithheldRecordedContent &
       PriceVariantCreatedContent &
       DifferentialPriceDeletedContent &
+      BusinessRuleActivatedContent &
       SubscriptionItemsRenewedContent &
       RuleCreatedContent &
       ContractTermCancelledContent &
       ContractTermRenewedContent &
       InvoiceDeletedContent &
+      BusinessRuleUpdatedContent &
       ItemPriceEntitlementsRemovedContent &
       SalesOrderUpdatedContent &
       OmnichannelSubscriptionItemDunningStartedContent &

package/types/resources/Gift.d.ts

@@ -235,7 +235,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -338,7 +351,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/GrantBlock.d.ts

@@ -4,19 +4,19 @@
 declare module 'chargebee' {
   export interface GrantBlock {
     id: string;
-    subscription_id?: string;
-    account_type?: 'provisioned' | 'overdraft';
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
+    account_type: 'provisioned' | 'overdraft';
     granted_amount: string;
     effective_from: number;
     expires_at: number;
     balance: string;
     hold_amount: string;
     used_amount: string;
-    expired_amount: string;
-    rolled_over_amount: string;
-    voided_amount: string;
+    expired_amount?: string;
+    rolled_over_amount?: string;
+    voided_amount?: string;
     origin_grant_block_id?: string;
     status: StatusEnum;
     grant_source:
@@ -30,6 +30,8 @@ declare module 'chargebee' {
     created_at: number;
     modified_at: number;
     resource_version?: number;
+    provisioned_block_balance?: GrantBlock.ProvisionedBlockBalance;
+    overdraft_block_balance?: GrantBlock.OverdraftBlockBalance;
     metadata?: any;
   }
 
@@ -46,6 +48,23 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface ProvisionedBlockBalance {
+      granted_amount?: string;
+      total_balance?: string;
+      usable_balance?: string;
+      hold_amount?: string;
+      used_amount?: string;
+      expired_amount?: string;
+      rolled_over_amount?: string;
+      voided_amount?: string;
+    }
+    export interface OverdraftBlockBalance {
+      is_unlimited: boolean;
+      limit?: string;
+      total_balance?: string;
+      usable_balance?: string;
+      used_amount?: string;
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/HostedPage.d.ts

@@ -34,6 +34,7 @@ declare module 'chargebee' {
     resource_version?: number;
     checkout_info?: any;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace HostedPage {
@@ -293,6 +294,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutOneTimeForItemsInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       layout?: LayoutEnum;
       invoice_note?: string /**
        * @deprecated Please refer API docs to use other attributes
@@ -318,6 +320,7 @@ declare module 'chargebee' {
     export interface CheckoutNewForItemsInputParam {
       layout?: LayoutEnum;
       business_entity_id?: string;
+      brand_id?: string;
       billing_cycles?: number;
       mandatory_items_to_remove?: string[];
       terms_to_charge?: number;
@@ -365,6 +368,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutExistingForItemsInputParam {
       layout?: LayoutEnum;
+      brand_id?: string;
       mandatory_items_to_remove?: string[];
       replace_items_list?: boolean;
       invoice_date?: number;
@@ -412,11 +416,13 @@ declare module 'chargebee' {
     }
     export interface ManagePaymentSourcesInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       redirect_url?: string;
       customer?: CustomerManagePaymentSourcesInputParam;
       card?: CardManagePaymentSourcesInputParam;
     }
     export interface CollectNowInputParam {
+      brand_id?: string;
       redirect_url?: string;
       currency_code?: string;
       payment_method_save_policy?: PaymentMethodSavePolicyEnum;
@@ -424,11 +430,13 @@ declare module 'chargebee' {
       card?: CardCollectNowInputParam;
     }
     export interface AcceptQuoteInputParam {
+      brand_id?: string;
       redirect_url?: string;
       layout?: LayoutEnum;
       quote?: QuoteAcceptQuoteInputParam;
     }
     export interface ExtendSubscriptionInputParam {
+      brand_id?: string;
       expiry?: number;
       billing_cycle?: number;
       subscription?: SubscriptionExtendSubscriptionInputParam;
@@ -443,6 +451,7 @@ declare module 'chargebee' {
     export interface CheckoutGiftForItemsInputParam {
       layout?: LayoutEnum;
       business_entity_id?: string;
+      brand_id?: string;
       redirect_url?: string;
       coupon_ids?: string[];
       gifter?: GifterCheckoutGiftForItemsInputParam;
@@ -450,6 +459,7 @@ declare module 'chargebee' {
       item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
+      brand_id?: string;
       redirect_url?: string;
       gift?: GiftClaimGiftInputParam;
       customer?: CustomerClaimGiftInputParam;
@@ -466,6 +476,7 @@ declare module 'chargebee' {
       updated_at?: filter.Timestamp;
     }
     export interface PreCancelInputParam {
+      brand_id?: string;
       pass_thru_content?: string;
       cancel_url?: string;
       redirect_url?: string;