Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions src/RequestWrapper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { handleResponse } from './coreCommon.js';
import { Buffer } from 'node:buffer';
import type { ZodObject, ZodRawShape } from 'zod';
import { ChargebeeZodValidationError } from './chargebeeZodValidationError.js';
import { getSchema } from './validationLoader.js';

export class RequestWrapper {
private readonly args: IArguments;
Expand Down Expand Up @@ -89,19 +90,30 @@ export class RequestWrapper {
: this.args[0];
let headers = this.apiCall.hasIdInUrl ? this.args[2] : this.args[1];

if (env.enableValidation && this.apiCall.validationSchema) {
if (this.apiCall.httpMethod === 'GET') {
RequestWrapper._validateParams(
params ?? {},
this.apiCall.validationSchema as ZodObject<ZodRawShape>,
this.apiCall.methodName,
);
} else if (params != null) {
RequestWrapper._validateParams(
params,
this.apiCall.validationSchema as ZodObject<ZodRawShape>,
this.apiCall.methodName,
);
// Lazy-load Zod schema when enableValidation is true
if (
env.enableValidation &&
this.apiCall.resourceKey &&
this.apiCall.actionName
) {
const schema = await getSchema(
this.apiCall.resourceKey,
this.apiCall.actionName,
);
if (schema) {
if (this.apiCall.httpMethod === 'GET') {
RequestWrapper._validateParams(
params ?? {},
schema,
this.apiCall.methodName,
);
} else if (params != null) {
RequestWrapper._validateParams(
params,
schema,
this.apiCall.methodName,
);
}
}
}

Expand Down
1 change: 1 addition & 0 deletions src/chargebee.cjs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module.exports.WebhookAuthenticationError = WebhookAuthenticationError;
module.exports.WebhookPayloadValidationError = WebhookPayloadValidationError;
module.exports.WebhookPayloadParseError = WebhookPayloadParseError;

// Export validation error class
module.exports.ChargebeeZodValidationError = ChargebeeZodValidationError;

// Export webhook types
Expand Down
2 changes: 2 additions & 0 deletions src/chargebee.esm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export {
WebhookPayloadValidationError,
WebhookPayloadParseError,
} from './resources/webhook/handler.js';

// Export validation error class
export { ChargebeeZodValidationError } from './chargebeeZodValidationError.js';

// Export webhook types
Expand Down
6 changes: 3 additions & 3 deletions src/createChargebee.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { RequestWrapper } from './RequestWrapper.js';
import { Environment } from './environment.js';
import { Endpoints } from './resources/api_endpoints.js';
import { extend, sleep } from './util.js';
import { getSchema } from './validationLoader.js';
import { waitForProcessToComplete } from './asyncApiSupport.js';
import {
ResourceType,
Expand Down Expand Up @@ -107,8 +106,9 @@ export const CreateChargebee = (httpClient: HttpClientInterface) => {
options: metaArr[8],
};
if (this._env.enableValidation) {
apiCall.validationSchema =
getSchema(res, metaArr[0] as string) ?? undefined;
// Store resource and action for lazy schema loading in RequestWrapper
apiCall.resourceKey = res;
apiCall.actionName = metaArr[0] as string;
}
this[res][apiCall.methodName] = this._createApiFunc(
apiCall,
Expand Down
160 changes: 160 additions & 0 deletions src/schema/addon.schema.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
// 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 };
export type CreateAddonBody = z.infer<typeof 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 };
export type UpdateAddonBody = z.infer<typeof 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 };
export type CopyAddonBody = z.infer<typeof CopyAddonBodySchema>;
39 changes: 39 additions & 0 deletions src/schema/address.schema.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// 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 };
export type RetrieveAddressBody = z.infer<typeof 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 };
export type UpdateAddressBody = z.infer<typeof UpdateAddressBodySchema>;
42 changes: 42 additions & 0 deletions src/schema/alert.schema.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// 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 };
export type CreateAlertBody = z.infer<typeof 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 };
export type UpdateAlertBody = z.infer<typeof UpdateAlertBodySchema>;
Loading
Loading