chargebee 3.24.0 → 3.25.0-beta.1

package/esm/schema/addon.schema.js

@@ -0,0 +1,150 @@
+// Generated Zod schemas: Addon
+// Actions: create, update, copy
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//Addon.create
+const CreateAddonMetaDataSchema = z.looseObject({});
+const CreateAddonTiersSchema = z.object({
+    starting_unit: z.array(z.number().int().min(1).optional()).optional(),
+    ending_unit: z.array(z.number().int().optional()).optional(),
+    price: z.array(z.number().int().min(0).optional()).optional(),
+    starting_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
+    ending_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
+    price_in_decimal: z.array(z.string().max(39).optional()).optional(),
+});
+const CreateAddonTaxProvidersFieldsSchema = z.object({
+    provider_name: z.array(z.string().max(50).optional()),
+    field_id: z.array(z.string().max(50).optional()),
+    field_value: z.array(z.string().max(50).optional()),
+});
+const CreateAddonBodySchema = z.looseObject({
+    id: z.string().max(100),
+    name: z.string().max(100),
+    invoice_name: z.string().max(100).optional(),
+    description: z.string().max(2000).optional(),
+    charge_type: z.enum(['recurring', 'non_recurring']),
+    price: z.number().int().min(0).optional(),
+    currency_code: z.string().max(3).optional(),
+    period: z.number().int().min(1).optional(),
+    period_unit: z
+        .enum(['day', 'week', 'month', 'year', 'not_applicable'])
+        .optional(),
+    pricing_model: z
+        .enum(['flat_fee', 'per_unit', 'tiered', 'volume', 'stairstep'])
+        .optional(),
+    type: z
+        .enum(['on_off', 'quantity', 'tiered', 'volume', 'stairstep'])
+        .optional(),
+    unit: z.string().max(30).optional(),
+    enabled_in_portal: z.boolean().default(true).optional(),
+    taxable: z.boolean().default(true).optional(),
+    tax_profile_id: z.string().max(50).optional(),
+    avalara_sale_type: z
+        .enum(['wholesale', 'retail', 'consumed', 'vendor_use'])
+        .optional(),
+    avalara_transaction_type: z.number().int().optional(),
+    avalara_service_type: z.number().int().optional(),
+    tax_code: z.string().max(50).optional(),
+    hsn_code: z.string().max(50).optional(),
+    taxjar_product_code: z.string().max(50).optional(),
+    invoice_notes: z.string().max(2000).optional(),
+    meta_data: CreateAddonMetaDataSchema.optional(),
+    sku: z.string().max(100).optional(),
+    accounting_code: z.string().max(100).optional(),
+    accounting_category1: z.string().max(100).optional(),
+    accounting_category2: z.string().max(100).optional(),
+    accounting_category3: z.string().max(100).optional(),
+    accounting_category4: z.string().max(100).optional(),
+    is_shippable: z.boolean().default(false).optional(),
+    shipping_frequency_period: z.number().int().min(1).optional(),
+    shipping_frequency_period_unit: z
+        .enum(['year', 'month', 'week', 'day'])
+        .optional(),
+    included_in_mrr: z.boolean().optional(),
+    show_description_in_invoices: z.boolean().default(false).optional(),
+    show_description_in_quotes: z.boolean().default(false).optional(),
+    price_in_decimal: z.string().max(39).optional(),
+    proration_type: z
+        .enum(['site_default', 'partial_term', 'full_term'])
+        .optional(),
+    status: z.enum(['active', 'archived']).optional(),
+    tiers: CreateAddonTiersSchema.optional(),
+    tax_providers_fields: CreateAddonTaxProvidersFieldsSchema.optional(),
+});
+export { CreateAddonBodySchema };
+//Addon.update
+const UpdateAddonMetaDataSchema = z.looseObject({});
+const UpdateAddonTiersSchema = z.object({
+    starting_unit: z.array(z.number().int().min(1).optional()).optional(),
+    ending_unit: z.array(z.number().int().optional()).optional(),
+    price: z.array(z.number().int().min(0).optional()).optional(),
+    starting_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
+    ending_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
+    price_in_decimal: z.array(z.string().max(39).optional()).optional(),
+});
+const UpdateAddonTaxProvidersFieldsSchema = z.object({
+    provider_name: z.array(z.string().max(50).optional()),
+    field_id: z.array(z.string().max(50).optional()),
+    field_value: z.array(z.string().max(50).optional()),
+});
+const UpdateAddonBodySchema = z.looseObject({
+    name: z.string().max(100).optional(),
+    invoice_name: z.string().max(100).optional(),
+    description: z.string().max(2000).optional(),
+    charge_type: z.enum(['recurring', 'non_recurring']).optional(),
+    price: z.number().int().min(0).optional(),
+    currency_code: z.string().max(3).optional(),
+    period: z.number().int().min(1).optional(),
+    period_unit: z
+        .enum(['day', 'week', 'month', 'year', 'not_applicable'])
+        .optional(),
+    pricing_model: z
+        .enum(['flat_fee', 'per_unit', 'tiered', 'volume', 'stairstep'])
+        .optional(),
+    type: z
+        .enum(['on_off', 'quantity', 'tiered', 'volume', 'stairstep'])
+        .optional(),
+    unit: z.string().max(30).optional(),
+    enabled_in_portal: z.boolean().default(true).optional(),
+    taxable: z.boolean().default(true).optional(),
+    tax_profile_id: z.string().max(50).optional(),
+    avalara_sale_type: z
+        .enum(['wholesale', 'retail', 'consumed', 'vendor_use'])
+        .optional(),
+    avalara_transaction_type: z.number().int().optional(),
+    avalara_service_type: z.number().int().optional(),
+    tax_code: z.string().max(50).optional(),
+    hsn_code: z.string().max(50).optional(),
+    taxjar_product_code: z.string().max(50).optional(),
+    invoice_notes: z.string().max(2000).optional(),
+    meta_data: UpdateAddonMetaDataSchema.optional(),
+    sku: z.string().max(100).optional(),
+    accounting_code: z.string().max(100).optional(),
+    accounting_category1: z.string().max(100).optional(),
+    accounting_category2: z.string().max(100).optional(),
+    accounting_category3: z.string().max(100).optional(),
+    accounting_category4: z.string().max(100).optional(),
+    is_shippable: z.boolean().default(false).optional(),
+    shipping_frequency_period: z.number().int().min(1).optional(),
+    shipping_frequency_period_unit: z
+        .enum(['year', 'month', 'week', 'day'])
+        .optional(),
+    included_in_mrr: z.boolean().optional(),
+    show_description_in_invoices: z.boolean().default(false).optional(),
+    show_description_in_quotes: z.boolean().default(false).optional(),
+    price_in_decimal: z.string().max(39).optional(),
+    proration_type: z
+        .enum(['site_default', 'partial_term', 'full_term'])
+        .optional(),
+    tiers: UpdateAddonTiersSchema.optional(),
+    tax_providers_fields: UpdateAddonTaxProvidersFieldsSchema.optional(),
+});
+export { UpdateAddonBodySchema };
+//Addon.copy
+const CopyAddonBodySchema = z.looseObject({
+    from_site: z.string().max(50),
+    id_at_from_site: z.string().max(100),
+    id: z.string().max(100).optional(),
+    for_site_merging: z.boolean().default(false).optional(),
+});
+export { CopyAddonBodySchema };

package/esm/schema/address.schema.js

@@ -0,0 +1,32 @@
+// Generated Zod schemas: Address
+// Actions: retrieve, update
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//Address.retrieve
+const RetrieveAddressBodySchema = z.looseObject({
+    subscription_id: z.string().max(50),
+    label: z.string().max(50),
+});
+export { RetrieveAddressBodySchema };
+//Address.update
+const UpdateAddressBodySchema = z.looseObject({
+    subscription_id: z.string().max(50),
+    label: z.string().max(50),
+    first_name: z.string().max(150).optional(),
+    last_name: z.string().max(150).optional(),
+    email: z.string().email().max(70).optional(),
+    company: z.string().max(250).optional(),
+    phone: z.string().max(50).optional(),
+    addr: z.string().max(150).optional(),
+    extended_addr: z.string().max(150).optional(),
+    extended_addr2: z.string().max(150).optional(),
+    city: z.string().max(50).optional(),
+    state_code: z.string().max(50).optional(),
+    state: z.string().max(50).optional(),
+    zip: z.string().max(20).optional(),
+    country: z.string().max(50).optional(),
+    validation_status: z
+        .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
+        .optional(),
+});
+export { UpdateAddressBodySchema };

package/esm/schema/alert.schema.js

@@ -0,0 +1,35 @@
+// Generated Zod schemas: Alert
+// Actions: create, update
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//Alert.create
+const CreateAlertThresholdSchema = z.object({
+    mode: z.enum(['absolute', 'percentage']),
+    value: z.number(),
+});
+const CreateAlertFilterConditionsSchema = z.object({
+    field: z.array(z.enum(['plan_price_id']).optional()).optional(),
+    operator: z.array(z.enum(['equals', 'not_equals']).optional()).optional(),
+    value: z.array(z.string().max(50).optional()).optional(),
+});
+const CreateAlertBodySchema = z.looseObject({
+    type: z.enum(['usage_exceeded']),
+    name: z.string().max(50),
+    description: z.string().max(65000).optional(),
+    metered_feature_id: z.string().max(50),
+    subscription_id: z.string().max(50).optional(),
+    meta: z.string().max(65000).optional(),
+    threshold: CreateAlertThresholdSchema.optional(),
+    filter_conditions: CreateAlertFilterConditionsSchema.optional(),
+});
+export { CreateAlertBodySchema };
+//Alert.update
+const UpdateAlertThresholdSchema = z.object({
+    mode: z.enum(['absolute', 'percentage']).optional(),
+    value: z.number().optional(),
+});
+const UpdateAlertBodySchema = z.looseObject({
+    status: z.enum(['enabled', 'disabled']).optional(),
+    threshold: UpdateAlertThresholdSchema.optional(),
+});
+export { UpdateAlertBodySchema };

package/esm/schema/attached_item.schema.js

@@ -0,0 +1,55 @@
+// Generated Zod schemas: AttachedItem
+// Actions: create, update, retrieve, delete
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//AttachedItem.create
+const CreateAttachedItemBodySchema = z.looseObject({
+    item_id: z.string().max(100),
+    type: z.enum(['recommended', 'mandatory', 'optional']).optional(),
+    billing_cycles: z.number().int().min(1).optional(),
+    quantity: z.number().int().min(1).optional(),
+    quantity_in_decimal: z.string().max(33).optional(),
+    charge_on_event: z
+        .enum([
+        'subscription_creation',
+        'subscription_trial_start',
+        'plan_activation',
+        'subscription_activation',
+        'contract_termination',
+        'on_demand',
+    ])
+        .optional(),
+    charge_once: z.boolean().optional(),
+    business_entity_id: z.string().max(50).optional(),
+});
+export { CreateAttachedItemBodySchema };
+//AttachedItem.update
+const UpdateAttachedItemBodySchema = z.looseObject({
+    parent_item_id: z.string().max(100),
+    type: z.enum(['recommended', 'mandatory', 'optional']).optional(),
+    billing_cycles: z.number().int().min(1).optional(),
+    quantity: z.number().int().min(1).optional(),
+    quantity_in_decimal: z.string().max(33).optional(),
+    charge_on_event: z
+        .enum([
+        'subscription_creation',
+        'subscription_trial_start',
+        'plan_activation',
+        'subscription_activation',
+        'contract_termination',
+        'on_demand',
+    ])
+        .optional(),
+    charge_once: z.boolean().optional(),
+});
+export { UpdateAttachedItemBodySchema };
+//AttachedItem.retrieve
+const RetrieveAttachedItemBodySchema = z.looseObject({
+    parent_item_id: z.string().max(100),
+});
+export { RetrieveAttachedItemBodySchema };
+//AttachedItem.delete
+const DeleteAttachedItemBodySchema = z.looseObject({
+    parent_item_id: z.string().max(100),
+});
+export { DeleteAttachedItemBodySchema };

package/esm/schema/business_entity.schema.js

@@ -0,0 +1,43 @@
+// Generated Zod schemas: BusinessEntity
+// Actions: createTransfers, getTransfers
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//BusinessEntity.createTransfers
+const CreateTransfersBusinessEntityBodySchema = z.looseObject({
+    active_resource_ids: z.array(z.string().max(50).optional()),
+    destination_business_entity_ids: z.array(z.string().max(50).optional()),
+    source_business_entity_ids: z.array(z.string().max(50).optional()).optional(),
+    resource_types: z.array(z.string().max(50).optional()),
+    reason_codes: z.array(z.string().max(50).optional()),
+});
+export { CreateTransfersBusinessEntityBodySchema };
+//BusinessEntity.getTransfers
+const GetTransfersBusinessEntityResourceTypeSchema = z.object({
+    is: z.string().min(1).optional(),
+});
+const GetTransfersBusinessEntityResourceIdSchema = z.object({
+    is: z.string().min(1).optional(),
+});
+const GetTransfersBusinessEntityActiveResourceIdSchema = z.object({
+    is: z.string().min(1).optional(),
+});
+const GetTransfersBusinessEntityCreatedAtSchema = z.object({
+    after: z.string().regex(RegExp('^d{10}$')).optional(),
+    before: z.string().regex(RegExp('^d{10}$')).optional(),
+    on: z.string().regex(RegExp('^d{10}$')).optional(),
+    between: z.string().regex(RegExp('^[d{10},d{10}]$')).optional(),
+});
+const GetTransfersBusinessEntitySortBySchema = z.looseObject({
+    asc: z.enum(['created_at']).optional(),
+    desc: z.enum(['created_at']).optional(),
+});
+const GetTransfersBusinessEntityBodySchema = z.looseObject({
+    limit: z.number().int().min(1).max(100).optional(),
+    offset: z.string().max(1000).optional(),
+    resource_type: GetTransfersBusinessEntityResourceTypeSchema.optional(),
+    resource_id: GetTransfersBusinessEntityResourceIdSchema.optional(),
+    active_resource_id: GetTransfersBusinessEntityActiveResourceIdSchema.optional(),
+    created_at: GetTransfersBusinessEntityCreatedAtSchema.optional(),
+    sort_by: GetTransfersBusinessEntitySortBySchema.optional(),
+});
+export { GetTransfersBusinessEntityBodySchema };

package/esm/schema/card.schema.js

@@ -0,0 +1,162 @@
+// Generated Zod schemas: Card
+// Actions: updateCardForCustomer, switchGatewayForCustomer, copyCardForCustomer
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//Card.updateCardForCustomer
+const UpdateCardForCustomerCardCustomerSchema = z.object({
+    vat_number: z.string().max(20).optional(),
+});
+const UpdateCardForCustomerCardBodySchema = z.looseObject({
+    gateway: z
+        .enum([
+        'chargebee',
+        'chargebee_payments',
+        'adyen',
+        'stripe',
+        'wepay',
+        'braintree',
+        'authorize_net',
+        'paypal_pro',
+        'pin',
+        'eway',
+        'eway_rapid',
+        'worldpay',
+        'balanced_payments',
+        'beanstream',
+        'bluepay',
+        'elavon',
+        'first_data_global',
+        'hdfc',
+        'migs',
+        'nmi',
+        'ogone',
+        'paymill',
+        'paypal_payflow_pro',
+        'sage_pay',
+        'tco',
+        'wirecard',
+        'amazon_payments',
+        'paypal_express_checkout',
+        'orbital',
+        'moneris_us',
+        'moneris',
+        'bluesnap',
+        'cybersource',
+        'vantiv',
+        'checkout_com',
+        'paypal',
+        'ingenico_direct',
+        'exact',
+        'mollie',
+        'quickbooks',
+        'razorpay',
+        'global_payments',
+        'bank_of_america',
+        'ecentric',
+        'metrics_global',
+        'windcave',
+        'pay_com',
+        'ebanx',
+        'dlocal',
+        'nuvei',
+        'solidgate',
+        'paystack',
+        'jp_morgan',
+        'deutsche_bank',
+        'ezidebit',
+        'twikey',
+        'tempus',
+        'moyasar',
+        'payway',
+    ])
+        .optional(),
+    gateway_account_id: z.string().max(50).optional(),
+    tmp_token: z.string().max(300).optional(),
+    first_name: z.string().max(50).optional(),
+    last_name: z.string().max(50).optional(),
+    number: z.string().max(1500),
+    expiry_month: z.number().int().min(1).max(12),
+    expiry_year: z.number().int(),
+    cvv: z.string().max(520).optional(),
+    preferred_scheme: z
+        .enum(['cartes_bancaires', 'mastercard', 'visa'])
+        .optional(),
+    billing_addr1: z.string().max(150).optional(),
+    billing_addr2: z.string().max(150).optional(),
+    billing_city: z.string().max(50).optional(),
+    billing_state_code: z.string().max(50).optional(),
+    billing_state: z.string().max(50).optional(),
+    billing_zip: z.string().max(20).optional(),
+    billing_country: z.string().max(50).optional(),
+    ip_address: z.string().max(50).optional(),
+    customer: UpdateCardForCustomerCardCustomerSchema.optional(),
+});
+export { UpdateCardForCustomerCardBodySchema };
+//Card.switchGatewayForCustomer
+const SwitchGatewayForCustomerCardBodySchema = z.looseObject({
+    gateway: z
+        .enum([
+        'chargebee_payments',
+        'adyen',
+        'stripe',
+        'wepay',
+        'braintree',
+        'authorize_net',
+        'paypal_pro',
+        'pin',
+        'eway',
+        'eway_rapid',
+        'worldpay',
+        'balanced_payments',
+        'beanstream',
+        'bluepay',
+        'elavon',
+        'first_data_global',
+        'hdfc',
+        'migs',
+        'nmi',
+        'ogone',
+        'paymill',
+        'paypal_payflow_pro',
+        'sage_pay',
+        'wirecard',
+        'orbital',
+        'moneris_us',
+        'moneris',
+        'bluesnap',
+        'cybersource',
+        'vantiv',
+        'checkout_com',
+        'ingenico_direct',
+        'exact',
+        'mollie',
+        'quickbooks',
+        'razorpay',
+        'global_payments',
+        'bank_of_america',
+        'ecentric',
+        'metrics_global',
+        'windcave',
+        'pay_com',
+        'ebanx',
+        'dlocal',
+        'nuvei',
+        'solidgate',
+        'paystack',
+        'jp_morgan',
+        'deutsche_bank',
+        'ezidebit',
+        'twikey',
+        'tempus',
+        'moyasar',
+        'payway',
+    ])
+        .optional(),
+    gateway_account_id: z.string().max(50),
+});
+export { SwitchGatewayForCustomerCardBodySchema };
+//Card.copyCardForCustomer
+const CopyCardForCustomerCardBodySchema = z.looseObject({
+    gateway_account_id: z.string().max(50),
+});
+export { CopyCardForCustomerCardBodySchema };

package/esm/schema/comment.schema.js

@@ -0,0 +1,66 @@
+// Generated Zod schemas: Comment
+// Actions: create, list
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//Comment.create
+const CreateCommentBodySchema = z.looseObject({
+    entity_type: z.enum([
+        'customer',
+        'subscription',
+        'invoice',
+        'quote',
+        'credit_note',
+        'transaction',
+        'plan',
+        'addon',
+        'coupon',
+        'order',
+        'business_entity',
+        'item_family',
+        'item',
+        'item_price',
+        'price_variant',
+    ]),
+    entity_id: z.string().max(100),
+    notes: z.string().max(1000),
+    added_by: z.string().max(100).optional(),
+});
+export { CreateCommentBodySchema };
+//Comment.list
+const ListCommentCreatedAtSchema = z.object({
+    after: z.string().regex(RegExp('^d{10}$')).optional(),
+    before: z.string().regex(RegExp('^d{10}$')).optional(),
+    on: z.string().regex(RegExp('^d{10}$')).optional(),
+    between: z.string().regex(RegExp('^[d{10},d{10}]$')).optional(),
+});
+const ListCommentSortBySchema = z.looseObject({
+    asc: z.enum(['created_at']).optional(),
+    desc: z.enum(['created_at']).optional(),
+});
+const ListCommentBodySchema = z.looseObject({
+    limit: z.number().int().min(1).max(100).optional(),
+    offset: z.string().max(1000).optional(),
+    entity_type: z
+        .enum([
+        'customer',
+        'subscription',
+        'invoice',
+        'quote',
+        'credit_note',
+        'transaction',
+        'plan',
+        'addon',
+        'coupon',
+        'order',
+        'business_entity',
+        'item_family',
+        'item',
+        'item_price',
+        'price_variant',
+    ])
+        .optional(),
+    entity_id: z.string().max(100).optional(),
+    created_at: ListCommentCreatedAtSchema.optional(),
+    sort_by: ListCommentSortBySchema.optional(),
+});
+export { ListCommentBodySchema };