chargebee 3.34.0 → 3.35.0

package/esm/resources/api_endpoints.js

@@ -1707,6 +1707,19 @@ export const Endpoints = {
                 isIdempotent: true,
             },
         ],
+        [
+            'removePaymentScheduleScheme',
+            'POST',
+            '/invoices',
+            '/remove_payment_schedule_scheme',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
         [
             'paymentSchedules',
             'GET',
@@ -3566,7 +3579,9 @@ export const Endpoints = {
             false,
             null,
             false,
-            {},
+            {
+                attributes: 1,
+            },
             {
                 isIdempotent: true,
             },
@@ -4278,6 +4293,50 @@ export const Endpoints = {
         ],
         ['list', 'GET', '/differential_prices', null, false, null, false, {}, {}],
     ],
+    priceRamp: [
+        [
+            'create',
+            'POST',
+            '/price_ramps',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['retrieve', 'GET', '/price_ramps', null, true, null, false, {}, {}],
+        [
+            'update',
+            'POST',
+            '/price_ramps',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        [
+            'delete',
+            'POST',
+            '/price_ramps',
+            '/delete',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['list', 'GET', '/price_ramps', null, false, null, false, {}, {}],
+    ],
+    rampInterval: [],
     configuration: [
         ['list', 'GET', '/configurations', null, false, null, false, {}, {}],
     ],
@@ -4623,6 +4682,34 @@ export const Endpoints = {
         ],
     ],
     businessEntity: [
+        [
+            'create',
+            'POST',
+            '/business_entities',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['list', 'GET', '/business_entities', null, false, null, false, {}, {}],
+        ['retrieve', 'GET', '/business_entities', null, true, null, false, {}, {}],
+        [
+            'update',
+            'POST',
+            '/business_entities',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
         [
             'createTransfers',
             'POST',
@@ -5004,7 +5091,12 @@ export const Endpoints = {
     ],
     omnichannelOneTimeOrderItem: [],
     rule: [['retrieve', 'GET', '/rules', null, true, null, false, {}, {}]],
+    retrySegment: [
+        ['retrieve', 'GET', '/retry_segments', null, true, null, false, {}, {}],
+    ],
     meter: [['list', 'GET', '/meters', null, false, null, false, {}, {}]],
+    groupByAttribute: [],
+    groupByRecommendation: [],
     usageEvent: [
         [
             'create',
@@ -5088,6 +5180,7 @@ export const Endpoints = {
         ],
     ],
     customDataSchema: [],
+    customData: [],
     usageFile: [
         [
             'uploadUrl',
@@ -5345,7 +5438,6 @@ export const Endpoints = {
     ],
     applyRule: [],
     appliedRule: [],
-    appliedBusinessRule: [],
     businessRuleset: [
         [
             'create',
@@ -5461,6 +5553,10 @@ export const Endpoints = {
         ['retrieve', 'GET', '/business_rulesets', null, true, null, false, {}, {}],
     ],
     businessRulesetRule: [],
+    draftRequest: [],
+    citation: [],
+    execution: [],
+    draftEstimate: [],
     usageSummary: [
         [
             'retrieveUsageSummaryForSubscription',
@@ -5566,6 +5662,71 @@ export const Endpoints = {
             {},
         ],
     ],
+    collectionsPaymentPromise: [
+        [
+            'retrieve',
+            'GET',
+            '/collections_payment_promises',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'listCollectionsPaymentPromises',
+            'GET',
+            '/collections_payment_promises',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'createCollectionsPaymentPromise',
+            'POST',
+            '/collections_payment_promises',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'updateCollectionsPaymentPromise',
+            'POST',
+            '/collections_payment_promises',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        [
+            'cancel',
+            'POST',
+            '/collections_payment_promises',
+            '/cancel',
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    collectionsDispute: [],
+    collectionsReminderSequence: [],
+    emailConversation: [],
+    emailMessage: [],
+    privateNote: [],
+    emailAttachment: [],
     ledgerAccountBalance: [
         [
             'listLedgerAccountBalances',
@@ -5578,6 +5739,17 @@ export const Endpoints = {
             {},
             {},
         ],
+        [
+            'updateOverdraftLimit',
+            'POST',
+            '/ledger_account_balances',
+            '/update_overdraft_limit',
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
     ],
     ledgerOperation: [
         [

package/esm/resources/webhook/eventType.js

@@ -23,7 +23,6 @@ export var WebhookEventType;
     WebhookEventType["BusinessRuleDeleted"] = "business_rule_deleted";
     WebhookEventType["BusinessRuleReleased"] = "business_rule_released";
     WebhookEventType["BusinessRuleUpdated"] = "business_rule_updated";
-    WebhookEventType["BusinessRulesApplied"] = "business_rules_applied";
     WebhookEventType["BusinessRulesetActivated"] = "business_ruleset_activated";
     WebhookEventType["BusinessRulesetCreated"] = "business_ruleset_created";
     WebhookEventType["BusinessRulesetDeactivated"] = "business_ruleset_deactivated";
@@ -34,6 +33,22 @@ export var WebhookEventType;
     WebhookEventType["CardExpired"] = "card_expired";
     WebhookEventType["CardExpiryReminder"] = "card_expiry_reminder";
     WebhookEventType["CardUpdated"] = "card_updated";
+    WebhookEventType["ChargebackInitiated"] = "chargeback_initiated";
+    WebhookEventType["ChargebackLost"] = "chargeback_lost";
+    WebhookEventType["ChargebackWon"] = "chargeback_won";
+    WebhookEventType["CollectionsDisputeCreated"] = "collections_dispute_created";
+    WebhookEventType["CollectionsDisputeResolved"] = "collections_dispute_resolved";
+    WebhookEventType["CollectionsDisputeUpdated"] = "collections_dispute_updated";
+    WebhookEventType["CollectionsDisputeWithdrawn"] = "collections_dispute_withdrawn";
+    WebhookEventType["CollectionsPaymentPromiseBroken"] = "collections_payment_promise_broken";
+    WebhookEventType["CollectionsPaymentPromiseCancelled"] = "collections_payment_promise_cancelled";
+    WebhookEventType["CollectionsPaymentPromiseCreated"] = "collections_payment_promise_created";
+    WebhookEventType["CollectionsPaymentPromiseFulfilled"] = "collections_payment_promise_fulfilled";
+    WebhookEventType["CollectionsPaymentPromiseUpdated"] = "collections_payment_promise_updated";
+    WebhookEventType["CollectionsReminderSequenceCompleted"] = "collections_reminder_sequence_completed";
+    WebhookEventType["CollectionsReminderSequenceCreated"] = "collections_reminder_sequence_created";
+    WebhookEventType["CollectionsReminderSequencePaused"] = "collections_reminder_sequence_paused";
+    WebhookEventType["CollectionsReminderSequenceResumed"] = "collections_reminder_sequence_resumed";
     WebhookEventType["ContractTermCancelled"] = "contract_term_cancelled";
     WebhookEventType["ContractTermCompleted"] = "contract_term_completed";
     WebhookEventType["ContractTermCreated"] = "contract_term_created";
@@ -65,6 +80,7 @@ export var WebhookEventType;
     WebhookEventType["DunningUpdated"] = "dunning_updated";
     WebhookEventType["EinvoiceCreated"] = "einvoice_created";
     WebhookEventType["EinvoiceUpdated"] = "einvoice_updated";
+    WebhookEventType["EmailMessageReceived"] = "email_message_received";
     WebhookEventType["EntitlementOverridesAutoRemoved"] = "entitlement_overrides_auto_removed";
     WebhookEventType["EntitlementOverridesRemoved"] = "entitlement_overrides_removed";
     WebhookEventType["EntitlementOverridesUpdated"] = "entitlement_overrides_updated";
@@ -152,6 +168,7 @@ export var WebhookEventType;
     WebhookEventType["PaymentRefunded"] = "payment_refunded";
     WebhookEventType["PaymentScheduleSchemeCreated"] = "payment_schedule_scheme_created";
     WebhookEventType["PaymentScheduleSchemeDeleted"] = "payment_schedule_scheme_deleted";
+    WebhookEventType["PaymentSchedulesCancelled"] = "payment_schedules_cancelled";
     WebhookEventType["PaymentSchedulesCreated"] = "payment_schedules_created";
     WebhookEventType["PaymentSchedulesUpdated"] = "payment_schedules_updated";
     WebhookEventType["PaymentSourceAdded"] = "payment_source_added";
@@ -167,9 +184,13 @@ export var WebhookEventType;
     WebhookEventType["PlanCreated"] = "plan_created";
     WebhookEventType["PlanDeleted"] = "plan_deleted";
     WebhookEventType["PlanUpdated"] = "plan_updated";
+    WebhookEventType["PriceRampCreated"] = "price_ramp_created";
+    WebhookEventType["PriceRampDeleted"] = "price_ramp_deleted";
+    WebhookEventType["PriceRampUpdated"] = "price_ramp_updated";
     WebhookEventType["PriceVariantCreated"] = "price_variant_created";
     WebhookEventType["PriceVariantDeleted"] = "price_variant_deleted";
     WebhookEventType["PriceVariantUpdated"] = "price_variant_updated";
+    WebhookEventType["PrivateNoteAdded"] = "private_note_added";
     WebhookEventType["ProductCreated"] = "product_created";
     WebhookEventType["ProductDeleted"] = "product_deleted";
     WebhookEventType["ProductUpdated"] = "product_updated";
@@ -180,6 +201,7 @@ export var WebhookEventType;
     WebhookEventType["QuoteDeleted"] = "quote_deleted";
     WebhookEventType["QuoteUpdated"] = "quote_updated";
     WebhookEventType["RecordPurchaseFailed"] = "record_purchase_failed";
+    WebhookEventType["RefundFailed"] = "refund_failed";
     WebhookEventType["RefundInitiated"] = "refund_initiated";
     WebhookEventType["RuleCreated"] = "rule_created";
     WebhookEventType["RuleDeleted"] = "rule_deleted";

package/esm/schema/business_entity.schema.js

@@ -1,7 +1,33 @@
 // Generated Zod schemas: BusinessEntity
-// Actions: createTransfers, getTransfers
+// Actions: create, list, update, createTransfers, getTransfers
 // Do not edit manually – regenerate via sdk-generator
 import { z } from 'zod';
+//BusinessEntity.create
+const CreateBusinessEntityBodySchema = z.looseObject({
+    name: z.string().max(100),
+    status: z.enum(['active', 'inactive']),
+});
+export { CreateBusinessEntityBodySchema };
+//BusinessEntity.list
+const ListBusinessEntityNameSchema = z.object({
+    is: z.string().min(1).optional(),
+    is_not: z.string().min(1).optional(),
+    starts_with: z.string().min(1).optional(),
+    is_present: z.enum(['true', 'false']).optional(),
+});
+const ListBusinessEntityBodySchema = z.looseObject({
+    limit: z.number().int().min(1).max(100).optional(),
+    offset: z.string().max(1000).optional(),
+    include_deleted: z.boolean().default(false).optional(),
+    name: ListBusinessEntityNameSchema.optional(),
+});
+export { ListBusinessEntityBodySchema };
+//BusinessEntity.update
+const UpdateBusinessEntityBodySchema = z.looseObject({
+    name: z.string().max(100).optional(),
+    status: z.enum(['active', 'inactive']).optional(),
+});
+export { UpdateBusinessEntityBodySchema };
 //BusinessEntity.createTransfers
 const CreateTransfersBusinessEntityBodySchema = z.looseObject({
     active_resource_ids: z.array(z.string().max(50).optional()),

package/esm/schema/collections_payment_promise.schema.js

@@ -0,0 +1,40 @@
+// Generated Zod schemas: CollectionsPaymentPromise
+// Actions: listCollectionsPaymentPromises, createCollectionsPaymentPromise, updateCollectionsPaymentPromise
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//CollectionsPaymentPromise.listCollectionsPaymentPromises
+const ListCollectionsPaymentPromisesCollectionsPaymentPromiseCustomerIdSchema = z.object({
+    is: z.string().min(1).optional(),
+});
+const ListCollectionsPaymentPromisesCollectionsPaymentPromiseInvoiceIdSchema = z.object({
+    is: z.string().min(1).optional(),
+});
+const ListCollectionsPaymentPromisesCollectionsPaymentPromiseStatusSchema = z.object({
+    is: z.enum(['active', 'fulfilled', 'broken', 'cancelled']).optional(),
+});
+const ListCollectionsPaymentPromisesCollectionsPaymentPromiseBodySchema = z.looseObject({
+    limit: z.number().int().min(1).max(100).optional(),
+    offset: z.string().max(1000).optional(),
+    customer_id: ListCollectionsPaymentPromisesCollectionsPaymentPromiseCustomerIdSchema.optional(),
+    invoice_id: ListCollectionsPaymentPromisesCollectionsPaymentPromiseInvoiceIdSchema.optional(),
+    status: ListCollectionsPaymentPromisesCollectionsPaymentPromiseStatusSchema.optional(),
+});
+export { ListCollectionsPaymentPromisesCollectionsPaymentPromiseBodySchema };
+//CollectionsPaymentPromise.createCollectionsPaymentPromise
+const CreateCollectionsPaymentPromiseCollectionsPaymentPromiseBodySchema = z.looseObject({
+    customer_id: z.string().max(100),
+    invoice_id: z.string().max(100).optional(),
+    amount: z.number().int(),
+    currency_code: z.string().max(3).optional(),
+    promised_on: z.number().int(),
+    reason: z.string().max(500).optional(),
+    promised_by: z.string().max(254).optional(),
+});
+export { CreateCollectionsPaymentPromiseCollectionsPaymentPromiseBodySchema };
+//CollectionsPaymentPromise.updateCollectionsPaymentPromise
+const UpdateCollectionsPaymentPromiseCollectionsPaymentPromiseBodySchema = z.looseObject({
+    promised_on: z.number().int().optional(),
+    reason: z.string().max(500).optional(),
+    promised_by: z.string().max(254).optional(),
+});
+export { UpdateCollectionsPaymentPromiseCollectionsPaymentPromiseBodySchema };

package/esm/schema/comment.schema.js

@@ -20,6 +20,7 @@ const CreateCommentBodySchema = z.looseObject({
         'item',
         'item_price',
         'price_variant',
+        'task',
     ]),
     entity_id: z.string().max(100),
     notes: z.string().max(1000),
@@ -57,6 +58,7 @@ const ListCommentBodySchema = z.looseObject({
         'item',
         'item_price',
         'price_variant',
+        'task',
     ])
         .optional(),
     entity_id: z.string().max(100).optional(),

package/esm/schema/coupon.schema.js

@@ -256,8 +256,8 @@ const ListCouponCurrencyCodeSchema = z.object({
     not_in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const ListCouponApplicableItemPriceIdsSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListCouponBodySchema = z.looseObject({
     limit: z.number().int().min(1).max(100).optional(),

package/esm/schema/credit_note.schema.js

@@ -505,6 +505,7 @@ const ImportCreditNoteCreditNoteBodySchema = z.looseObject({
     currency_code: z.string().max(3).optional(),
     create_reason_code: z.string().max(100),
     date: z.number().int(),
+    customer_notes: z.string().max(2000).optional(),
     status: z.enum(['adjusted', 'refunded', 'refund_due', 'voided']).optional(),
     total: z.number().int().min(0).optional(),
     refunded_at: z.number().int().optional(),

package/esm/schema/credit_unit.schema.js

@@ -4,12 +4,12 @@
 import { z } from 'zod';
 //CreditUnit.list
 const ListCreditUnitStatusSchema = z.object({
-    is: z.enum(['active', 'archived']).optional(),
     in: z.enum(['active', 'archived']).optional(),
+    is: z.enum(['active', 'archived']).optional(),
 });
 const ListCreditUnitIdSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListCreditUnitBodySchema = z.looseObject({
     limit: z.number().int().min(1).max(100).optional(),

package/esm/schema/einvoice.schema.js

@@ -4,12 +4,12 @@
 import { z } from 'zod';
 //Einvoice.listEinvoices
 const ListEinvoicesEinvoiceIdSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListEinvoicesEinvoiceReferenceIdSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListEinvoicesEinvoiceUpdatedAtSchema = z.object({
     after: z.string().regex(RegExp('^\\d{10}$')).optional(),

package/esm/schema/entitlement.schema.js

@@ -4,20 +4,20 @@
 import { z } from 'zod';
 //Entitlement.list
 const ListEntitlementFeatureIdSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListEntitlementEntityTypeSchema = z.object({
-    is: z
+    in: z
         .enum(['plan', 'addon', 'charge', 'plan_price', 'addon_price'])
         .optional(),
-    in: z
+    is: z
         .enum(['plan', 'addon', 'charge', 'plan_price', 'addon_price'])
         .optional(),
 });
 const ListEntitlementEntityIdSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListEntitlementBodySchema = z.looseObject({
     limit: z.number().int().min(1).max(100).optional(),

package/esm/schema/estimate.schema.js

@@ -281,7 +281,7 @@ const CreateSubItemEstimateEstimateSubscriptionItemsSchema = z.object({
     billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
     trial_end: z.array(z.number().int().optional()).optional(),
     service_period_days: z
-        .array(z.number().int().min(1).max(730).optional())
+        .array(z.number().int().min(1).max(4000).optional())
         .optional(),
     charge_on_event: z
         .array(z
@@ -547,7 +547,7 @@ const CreateSubItemForCustomerEstimateEstimateSubscriptionItemsSchema = z.object
     billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
     trial_end: z.array(z.number().int().optional()).optional(),
     service_period_days: z
-        .array(z.number().int().min(1).max(730).optional())
+        .array(z.number().int().min(1).max(4000).optional())
         .optional(),
     charge_on_event: z
         .array(z
@@ -832,7 +832,7 @@ const UpdateSubscriptionForItemsEstimateSubscriptionItemsSchema = z.object({
     billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
     trial_end: z.array(z.number().int().optional()).optional(),
     service_period_days: z
-        .array(z.number().int().min(1).max(730).optional())
+        .array(z.number().int().min(1).max(4000).optional())
         .optional(),
     charge_on_event: z
         .array(z
@@ -1020,7 +1020,7 @@ const CancelSubscriptionForItemsEstimateSubscriptionItemsSchema = z.object({
     unit_price: z.array(z.number().int().min(0).optional()).optional(),
     unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
     service_period_days: z
-        .array(z.number().int().min(1).max(730).optional())
+        .array(z.number().int().min(1).max(4000).optional())
         .optional(),
 });
 const CancelSubscriptionForItemsEstimateBodySchema = z.looseObject({