chargebee 3.34.0 → 3.36.0

package/types/resources/Content.d.ts

@@ -8,7 +8,6 @@ declare module 'chargebee' {
     advance_invoice_schedule: AdvanceInvoiceSchedule;
     alert: Alert;
     alert_status: AlertStatus;
-    applied_business_rule: AppliedBusinessRule;
     applied_rule: AppliedRule;
     apply_rule: ApplyRule;
     async_response: AsyncResponse;
@@ -16,6 +15,8 @@ declare module 'chargebee' {
     attached_item: AttachedItem;
     attribute: Attribute;
     billing_configuration: BillingConfiguration;
+    billing_line_item: BillingLineItem;
+    billing_metadata: BillingMetadata;
     brand: Brand;
     business_entity: BusinessEntity;
     business_entity_transfer: BusinessEntityTransfer;
@@ -23,6 +24,10 @@ declare module 'chargebee' {
     business_ruleset: BusinessRuleset;
     business_ruleset_rule: BusinessRulesetRule;
     card: Card;
+    citation: Citation;
+    collections_dispute: CollectionsDispute;
+    collections_payment_promise: CollectionsPaymentPromise;
+    collections_reminder_sequence: CollectionsReminderSequence;
     column_definition: ColumnDefinition;
     comment: Comment;
     configuration: Configuration;
@@ -36,6 +41,7 @@ declare module 'chargebee' {
     credit_note_estimate: CreditNoteEstimate;
     credit_unit: CreditUnit;
     currency: Currency;
+    custom_data: CustomData;
     custom_data_schema: CustomDataSchema;
     customer: Customer;
     customer_entitlement: CustomerEntitlement;
@@ -43,19 +49,29 @@ declare module 'chargebee' {
     discount: Discount;
     dispute: Dispute;
     download: Download;
+    draft_estimate: DraftEstimate;
+    draft_request: DraftRequest;
     einvoice: Einvoice;
+    email_attachment: EmailAttachment;
+    email_conversation: EmailConversation;
     email_log: EmailLog;
+    email_message: EmailMessage;
     entitlement: Entitlement;
     entitlement_override: EntitlementOverride;
     estimate: Estimate;
     event: Event;
+    execution: Execution;
     export: Export;
     feature: Feature;
     filter_condition: FilterCondition;
     gateway_error_detail: GatewayErrorDetail;
     gateway_payment_method_token: GatewayPaymentMethodToken;
+    gateway_request_log: GatewayRequestLog;
+    gateway_webhook_log: GatewayWebhookLog;
     gift: Gift;
     grant_block: GrantBlock;
+    group_by_attribute: GroupByAttribute;
+    group_by_recommendation: GroupByRecommendation;
     hierarchy: Hierarchy;
     hosted_page: HostedPage;
     impacted_customer: ImpactedCustomer;
@@ -87,6 +103,7 @@ declare module 'chargebee' {
     omnichannel_subscription_item_scheduled_change: OmnichannelSubscriptionItemScheduledChange;
     omnichannel_transaction: OmnichannelTransaction;
     order: Order;
+    organization_detail: OrganizationDetail;
     payment_intent: PaymentIntent;
     payment_reference_number: PaymentReferenceNumber;
     payment_schedule: PaymentSchedule;
@@ -97,8 +114,11 @@ declare module 'chargebee' {
     personalized_offer: PersonalizedOffer;
     plan: Plan;
     portal_session: PortalSession;
+    preference_variant: PreferenceVariant;
+    price_ramp: PriceRamp;
     price_variant: PriceVariant;
     pricing_page_session: PricingPageSession;
+    private_note: PrivateNote;
     promotional_credit: PromotionalCredit;
     promotional_grant: PromotionalGrant;
     purchase: Purchase;
@@ -110,8 +130,10 @@ declare module 'chargebee' {
     quoted_ramp: QuotedRamp;
     quoted_subscription: QuotedSubscription;
     ramp: Ramp;
+    ramp_interval: RampInterval;
     recorded_purchase: RecordedPurchase;
     resource_migration: ResourceMigration;
+    retry_segment: RetrySegment;
     rule: Rule;
     site_migration_detail: SiteMigrationDetail;
     subscription: Subscription;

package/types/resources/CreditNote.d.ts

@@ -567,6 +567,7 @@ declare module 'chargebee' {
       currency_code?: string;
       create_reason_code: string;
       date: number;
+      customer_notes?: string;
       status?: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
       total?: number;
       refunded_at?: number;

package/types/resources/CustomData.d.ts

@@ -0,0 +1,14 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface CustomData {
+    entity_type: EntityTypeEnum;
+    id: string;
+    schema_id: string;
+    schema_values: string;
+    created_at: number;
+    modified_at: number;
+    updated_at?: number;
+  }
+}

package/types/resources/Discount.d.ts

@@ -5,6 +5,7 @@ declare module 'chargebee' {
   export interface Discount {
     id: string;
     invoice_name?: string;
+    description?: string;
     type: 'fixed_amount' | 'percentage' | 'offer_quantity';
     percentage?: number;
     amount?: number;

package/types/resources/DraftEstimate.d.ts

@@ -0,0 +1,13 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface DraftEstimate {
+    status: 'success' | 'failed';
+    http_status?: number;
+    created_at: number;
+    result?: any;
+    error_detail?: any;
+    revision_version?: number;
+  }
+}

package/types/resources/DraftRequest.d.ts

@@ -0,0 +1,45 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface DraftRequest {
+    id: string;
+    path_param?: string;
+    request_uri?: string;
+    operation_id: string;
+    status: 'open' | 'executed';
+    executed_at?: number;
+    created_at: number;
+    resource_version?: number;
+    updated_at: number;
+    current_revision?: DraftRequest.DraftRevision;
+    validations?: DraftRequest.Validation[];
+    has_comments?: boolean;
+    has_citations?: boolean;
+    executions?: DraftRequest.Execution[];
+  }
+
+  export namespace DraftRequest {
+    export interface DraftRevision {
+      version: number;
+      created_at: number;
+      payload?: object;
+    }
+    export interface Validation {
+      category?: string;
+      level?: string;
+      message?: string;
+      param_name?: string;
+      type?: string;
+    }
+    export interface Execution {
+      status: 'success' | 'failed';
+      created_at: number;
+      result?: object;
+      error_detail?: object;
+      revision_version?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/EmailAttachment.d.ts

@@ -0,0 +1,16 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface EmailAttachment {
+    id: string;
+    email_message_id?: string;
+    file_name?: string;
+    content_type?: string;
+    size_bytes?: number;
+    content_disposition?: string;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/EmailConversation.d.ts

@@ -0,0 +1,18 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface EmailConversation {
+    id: string;
+    customer_id?: string;
+    mailbox_id?: string;
+    subject?: string;
+    last_message_preview?: string;
+    message_count: number;
+    status?: string;
+    last_message_at?: number;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/EmailLog.d.ts

@@ -11,6 +11,7 @@ declare module 'chargebee' {
     status: StatusEnum;
     sent_on?: number;
     customer_id?: string;
+    email_conversation_id?: string;
     site_id?: string;
     business_entity_id?: string;
     brand_id?: string;

package/types/resources/EmailMessage.d.ts

@@ -0,0 +1,40 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface EmailMessage {
+    id: string;
+    email_conversation_id?: string;
+    message_type?: string;
+    author_type?: 'contact' | 'site_user' | 'agent' | 'other';
+    send_status?: 'pending' | 'sent' | 'failed';
+    content_html?: string;
+    content_text?: string;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+    mailbox_id?: string;
+    author_id?: string;
+    author_name?: string;
+    from_email?: string;
+    to_emails?: string[];
+    cc_emails?: string[];
+    attachments?: EmailMessage.Attachment[];
+  }
+
+  export namespace EmailMessage {
+    export interface Attachment {
+      id: string;
+      email_message_id?: string;
+      file_name?: string;
+      content_type?: string;
+      size_bytes?: number;
+      content_disposition?: string;
+      created_at: number;
+      updated_at: number;
+      resource_version?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/Estimate.d.ts

@@ -635,6 +635,7 @@ declare module 'chargebee' {
       included_in_mrr?: boolean;
       item_price_id?: string;
       quantity?: number;
+      description?: string;
     }
     export interface ItemTiersCreateSubItemEstimateInputParam {
       item_price_id?: string;
@@ -778,6 +779,7 @@ declare module 'chargebee' {
       included_in_mrr?: boolean;
       item_price_id?: string;
       quantity?: number;
+      description?: string;
     }
     export interface ItemTiersCreateSubItemForCustomerEstimateInputParam {
       item_price_id?: string;
@@ -944,6 +946,7 @@ declare module 'chargebee' {
       quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
+      description?: string;
     }
     export interface ItemTiersUpdateSubscriptionForItemsInputParam {
       item_price_id?: string;

package/types/resources/Event.d.ts

@@ -30,6 +30,8 @@ declare module 'chargebee' {
       UnbilledChargesDeletedContent &
       CouponUpdatedContent &
       GrantBlocksCreatedContent &
+      ChargebackLostContent &
+      PriceRampUpdatedContent &
       OmnichannelSubscriptionItemReactivatedContent &
       OmnichannelSubscriptionItemRenewedContent &
       UnbilledChargesCreatedContent &
@@ -48,7 +50,6 @@ declare module 'chargebee' {
       SubscriptionShippingAddressUpdatedContent &
       VoucherCreateFailedContent &
       GiftClaimedContent &
-      BusinessRulesAppliedContent &
       CustomerDeletedContent &
       RefundInitiatedContent &
       InvoiceGeneratedWithBackdatingContent &
@@ -74,6 +75,7 @@ declare module 'chargebee' {
       ContractTermTerminatedContent &
       ItemFamilyUpdatedContent &
       OrderCreatedContent &
+      RefundFailedContent &
       PriceVariantDeletedContent &
       AlertStatusChangedContent &
       SubscriptionMovementFailedContent &
@@ -82,6 +84,7 @@ declare module 'chargebee' {
       SubscriptionAdvanceInvoiceScheduleUpdatedContent &
       ItemDeletedContent &
       SubscriptionRampDraftedContent &
+      ChargebackInitiatedContent &
       BusinessRuleCreatedContent &
       VaultTokenUpdatedContent &
       DunningUpdatedContent &
@@ -94,10 +97,12 @@ declare module 'chargebee' {
       SubscriptionCancellationScheduledContent &
       SubscriptionRenewedContent &
       FeatureUpdatedContent &
+      CollectionsPaymentPromiseFulfilledContent &
       FeatureDeletedContent &
       ItemFamilyCreatedContent &
       OmnichannelSubscriptionItemScheduledChangeRemovedContent &
       OmnichannelSubscriptionItemResumedContent &
+      CollectionsDisputeResolvedContent &
       PurchaseCreatedContent &
       EntitlementOverridesUpdatedContent &
       ItemFamilyDeletedContent &
@@ -109,6 +114,7 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemDowngradedContent &
       BusinessRulesetDeactivatedContent &
       PriceVariantUpdatedContent &
+      CollectionsDisputeUpdatedContent &
       PromotionalCreditsDeductedContent &
       SubscriptionRampAppliedContent &
       BusinessRulesetDeletedContent &
@@ -122,8 +128,10 @@ declare module 'chargebee' {
       ItemCreatedContent &
       BusinessRulesetCreatedContent &
       TransactionUpdatedContent &
+      CollectionsPaymentPromiseUpdatedContent &
       MrrUpdatedContent &
       UnbilledChargesInvoicedContent &
+      ChargebackWonContent &
       ItemPriceUpdatedContent &
       CouponCodesUpdatedContent &
       VirtualBankAccountUpdatedContent &
@@ -136,6 +144,8 @@ declare module 'chargebee' {
       PaymentSchedulesUpdatedContent &
       OmnichannelSubscriptionItemExpiredContent &
       CardUpdatedContent &
+      PriceRampCreatedContent &
+      CollectionsReminderSequenceCreatedContent &
       CustomerCreatedContent &
       SubscriptionRenewalReminderContent &
       OmnichannelSubscriptionItemMrrUpdatedContent &
@@ -144,20 +154,25 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemCancellationScheduledContent &
       OmnichannelSubscriptionItemGracePeriodExpiredContent &
       CouponCodesAddedContent &
+      EmailMessageReceivedContent &
       GiftCancelledContent &
       OrderCancelledContent &
       CouponDeletedContent &
       SubscriptionScheduledChangesRemovedContent &
       PendingInvoiceCreatedContent &
+      CollectionsPaymentPromiseBrokenContent &
       EntitlementOverridesAutoRemovedContent &
+      PriceRampDeletedContent &
       BusinessRulesetActivatedContent &
       OmnichannelSubscriptionItemUpgradedContent &
       SubscriptionBusinessEntityChangedContent &
       OmnichannelOneTimeOrderCreatedContent &
+      CollectionsPaymentPromiseCreatedContent &
       PaymentSourceDeletedContent &
       OmnichannelSubscriptionItemCancelledContent &
       QuoteDeletedContent &
       InvoiceUpdatedContent &
+      PrivateNoteAddedContent &
       SubscriptionAdvanceInvoiceScheduleRemovedContent &
       CardDeletedContent &
       OrderReadyToShipContent &
@@ -173,6 +188,7 @@ declare module 'chargebee' {
       CardAddedContent &
       CouponCreatedContent &
       RuleDeletedContent &
+      CollectionsDisputeCreatedContent &
       ItemPriceEntitlementsUpdatedContent &
       ItemPriceDeletedContent &
       VirtualBankAccountDeletedContent &
@@ -184,6 +200,7 @@ declare module 'chargebee' {
       PaymentSourceAddedContent &
       SubscriptionMovedInContent &
       LedgerUpdatedContent &
+      CollectionsPaymentPromiseCancelledContent &
       ItemPriceCreatedContent &
       SubscriptionScheduledCancellationRemovedContent &
       PaymentRefundedContent &
@@ -200,10 +217,12 @@ declare module 'chargebee' {
       SalesOrderCreatedContent &
       CustomerChangedContent &
       SubscriptionStartedContent &
+      OrganizationDetailsUpdatedContent &
       SubscriptionActivatedContent &
       PaymentSourceExpiringContent &
       SubscriptionReactivatedContent &
       OrderUpdatedContent &
+      CollectionsDisputeWithdrawnContent &
       SubscriptionScheduledPauseRemovedContent &
       SubscriptionCancellationReminderContent &
       SubscriptionCreatedWithBackdatingContent &
@@ -215,6 +234,7 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemGracePeriodStartedContent &
       CardExpiryReminderContent &
       TokenCreatedContent &
+      CollectionsReminderSequencePausedContent &
       PaymentSourceBusinessEntityChangedContent &
       PromotionalCreditsAddedContent &
       SubscriptionRampUpdatedContent &
@@ -232,15 +252,18 @@ declare module 'chargebee' {
       AttachedItemDeletedContent &
       OmnichannelSubscriptionItemScheduledCancellationRemovedContent &
       ItemUpdatedContent &
+      CollectionsReminderSequenceResumedContent &
       CouponSetCreatedContent &
       PaymentIntentUpdatedContent &
       OrderResentContent &
       OmnichannelSubscriptionCreatedContent &
       TaxWithheldRecordedContent &
       PriceVariantCreatedContent &
+      OrganizationDetailsCreatedContent &
       DifferentialPriceDeletedContent &
       BusinessRuleActivatedContent &
       SubscriptionItemsRenewedContent &
+      PaymentSchedulesCancelledContent &
       RuleCreatedContent &
       ContractTermCancelledContent &
       ContractTermRenewedContent &
@@ -257,6 +280,7 @@ declare module 'chargebee' {
       BusinessEntityDeletedContent &
       GrantBlocksUpdatedContent &
       AuthorizationVoidedContent &
+      CollectionsReminderSequenceCompletedContent &
       SubscriptionRampDeletedContent &
       PlanDeletedContent &
       AddonDeletedContent &

package/types/resources/Execution.d.ts

@@ -0,0 +1,12 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Execution {
+    status: 'success' | 'failed';
+    created_at: number;
+    result?: any;
+    error_detail?: any;
+    revision_version?: number;
+  }
+}

package/types/resources/GatewayPaymentMethodToken.d.ts

@@ -5,10 +5,10 @@ declare module 'chargebee' {
   export interface GatewayPaymentMethodToken {
     id: string;
     gateway_account_id: string;
-    gateway_name: GatewayNameEnum;
+    gateway: GatewayEnum;
     gateway_customer_id?: string;
     gateway_token: string;
-    status: 'active' | 'inactive' | 'pending_verification';
+    status: 'valid' | 'invalid' | 'pending_verification';
     created_at: number;
     updated_at?: number;
   }

package/types/resources/GatewayRequestLog.d.ts

@@ -0,0 +1,82 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GatewayRequestLog {
+    log_id?: string;
+    url?: string;
+    status_code?: string;
+    method?: string;
+    request_body?: string;
+    response_body?: string;
+    request_headers?: string;
+    response_headers?: string;
+    gateway?: string;
+    customer_handle?: string;
+    invoice_handle?: string;
+    transaction_handle?: string;
+    payment_method_handle?: string;
+    gateway_credential_handle?: string;
+    payment_attempt_handle?: string;
+    payment_intent_handle?: string;
+    payment_method_name?: string;
+    operation_name?: string;
+    operation_type?: string;
+    action_type?: string;
+    source?: string;
+    trace_id_hash?: string;
+    invocation_time?: number;
+    response_received_at?: number;
+    response_time?: number;
+  }
+
+  export namespace GatewayRequestLog {
+    export class GatewayRequestLogResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        gateway_request_log_log_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { gateway_request_log: GatewayRequestLog }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      gateway_request_log: GatewayRequestLog;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      log_id?: filter.String;
+      gateway?: filter.String;
+      status_code?: filter.String;
+      method?: filter.String;
+      url?: filter.String;
+      customer_handle?: filter.String;
+      invoice_handle?: filter.String;
+      transaction_handle?: filter.String;
+      payment_method_handle?: filter.String;
+      gateway_credential_handle?: filter.String;
+      payment_attempt_handle?: filter.String;
+      payment_intent_handle?: filter.String;
+      operation_name?: filter.String;
+      operation_type?: filter.String;
+      source?: filter.String;
+      invocation_time?: filter.Timestamp;
+      response_received_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/GatewayWebhookLog.d.ts

@@ -0,0 +1,74 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GatewayWebhookLog {
+    webhook_id?: string;
+    url?: string;
+    method?: string;
+    status_code?: string;
+    gateway?: string;
+    id_at_gateway?: string;
+    customer_handle?: string;
+    invoice_handle?: string;
+    transaction_handle?: string;
+    payment_method_handle?: string;
+    gateway_credential_handle?: string;
+    payment_attempt_handle?: string;
+    payment_intent_handle?: string;
+    payment_method_name?: string;
+    request_body?: string;
+    response_body?: string;
+    request_headers?: string;
+    response_headers?: string;
+    received_at?: number;
+    response_time?: number;
+  }
+
+  export namespace GatewayWebhookLog {
+    export class GatewayWebhookLogResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        gateway_webhook_log_webhook_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { gateway_webhook_log: GatewayWebhookLog }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      gateway_webhook_log: GatewayWebhookLog;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      webhook_id?: filter.String;
+      gateway?: filter.String;
+      status_code?: filter.String;
+      method?: filter.String;
+      url?: filter.String;
+      id_at_gateway?: filter.String;
+      customer_handle?: filter.String;
+      invoice_handle?: filter.String;
+      transaction_handle?: filter.String;
+      payment_method_handle?: filter.String;
+      gateway_credential_handle?: filter.String;
+      payment_attempt_handle?: filter.String;
+      payment_intent_handle?: filter.String;
+      received_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/GrantBlock.d.ts

@@ -32,6 +32,7 @@ declare module 'chargebee' {
     resource_version?: number;
     provisioned_block_balance?: GrantBlock.ProvisionedBlockBalance;
     overdraft_block_balance?: GrantBlock.OverdraftBlockBalance;
+    billing_metadata?: GrantBlock.BillingMetadata;
     metadata?: any;
   }
 
@@ -65,6 +66,10 @@ declare module 'chargebee' {
       usable_balance?: string;
       used_amount?: string;
     }
+    export interface BillingMetadata {
+      item_price_id?: string;
+      line_items?: BillingLineItem[];
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/GroupByAttribute.d.ts

@@ -0,0 +1,15 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface GroupByAttribute {
+    attribute_name: string;
+    rank: number;
+    coverage_percent: number;
+    cardinality: number;
+    remaining_value_count: number;
+    warning: boolean;
+    sample_values?: string[];
+    warning_reasons?: WarningReasonEnum[];
+  }
+}