wiil-core-js 0.0.82

package/dist/core/business-mgt/customer-management/customer.schema.d.ts

@@ -0,0 +1,156 @@
+import z from "zod";
+import { BestTimeToCall, PreferredContactMethod } from "../../type-definitions";
+/**
+ * Customer schema.
+ * Individual customer record with contact info and preferences.
+ *
+ * @typedef {Object} Customer
+ * @property {string} [customerId] - External system customer ID
+ * @property {string} [phone_number] - Primary phone number (E.164 format)
+ * @property {string} [firstname] - Customer's first name
+ * @property {string} [lastname] - Customer's last name
+ * @property {string} [company] - Company name for business customers
+ * @property {string} [timezone] - Customer's timezone (IANA format)
+ * @property {string} [email] - Primary email address
+ * @property {string} preferred_language - Preferred language (ISO 639-1)
+ * @property {string} preferred_contact_method - Preferred contact method
+ * @property {string} [best_time_to_call] - Best time for phone contact
+ * @property {string} [notes] - Internal staff notes
+ * @property {string[]} [tags] - Categorization labels
+ * @property {Object} [custom_fields] - Business-specific custom fields
+ * @property {string} [channelId] - Channel where customer was created
+ * @property {Object} [address] - Primary physical address
+ * @property {boolean} isValidatedNames - Whether names are verified
+ * @property {string} [customerGroupId] - Customer group for pricing/terms
+ */
+export declare const CustomerSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    phone_number: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lastname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    company: z.ZodOptional<z.ZodString>;
+    timezone: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodEmail>;
+    preferred_language: z.ZodDefault<z.ZodString>;
+    preferred_contact_method: z.ZodDefault<z.ZodEnum<typeof PreferredContactMethod>>;
+    best_time_to_call: z.ZodOptional<z.ZodEnum<typeof BestTimeToCall>>;
+    notes: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    custom_fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    address: z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
+    isValidatedNames: z.ZodDefault<z.ZodBoolean>;
+    customerGroupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Schema for creating a new customer.
+ * Omits auto-generated fields and channelId (set by system).
+ */
+export declare const CreateCustomerSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodEmail>;
+    timezone: z.ZodOptional<z.ZodString>;
+    address: z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
+    customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    phone_number: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lastname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    company: z.ZodOptional<z.ZodString>;
+    preferred_language: z.ZodDefault<z.ZodString>;
+    preferred_contact_method: z.ZodDefault<z.ZodEnum<typeof PreferredContactMethod>>;
+    best_time_to_call: z.ZodOptional<z.ZodEnum<typeof BestTimeToCall>>;
+    notes: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    custom_fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    isValidatedNames: z.ZodDefault<z.ZodBoolean>;
+    customerGroupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an existing customer.
+ * All fields optional except id (required).
+ */
+export declare const UpdateCustomerSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodOptional<z.ZodEmail>>;
+    timezone: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    address: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>>;
+    customerId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    phone_number: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>>;
+    firstname: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    lastname: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    company: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    preferred_language: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    preferred_contact_method: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof PreferredContactMethod>>>;
+    best_time_to_call: z.ZodOptional<z.ZodOptional<z.ZodEnum<typeof BestTimeToCall>>>;
+    notes: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    tags: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    custom_fields: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    isValidatedNames: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    customerGroupId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type Customer = z.infer<typeof CustomerSchema>;
+export type CreateCustomer = z.infer<typeof CreateCustomerSchema>;
+export type UpdateCustomer = z.infer<typeof UpdateCustomerSchema>;
+/**
+ * Customer filter options.
+ * @interface CustomerFilters
+ */
+export interface CustomerFilters {
+    /** Text search across name/email/phone */
+    search?: string;
+    /** Filter by preferred contact method(s) */
+    preferredContactMethod?: (typeof PreferredContactMethod)[keyof typeof PreferredContactMethod][];
+    /** Filter by tags */
+    tags?: string[];
+    /** Filter by channel ID */
+    channelId?: string;
+    /** Filter by customer group ID */
+    customerGroupId?: string;
+}
+/**
+ * Customer sorting options.
+ * @interface CustomerSorting
+ */
+export interface CustomerSorting {
+    /** Field to sort by */
+    field: "firstname" | "lastname" | "createdAt";
+    /** Sort direction */
+    direction: "asc" | "desc";
+}
+/**
+ * Customer query options.
+ * @interface CustomerQueryOptions
+ */
+export interface CustomerQueryOptions {
+    /** Page number (1-indexed) */
+    page: number;
+    /** Items per page */
+    pageSize: number;
+    /** Optional filters */
+    filters?: CustomerFilters;
+    /** Optional sorting */
+    sorting?: CustomerSorting;
+}

package/dist/core/business-mgt/customer-management/customer.schema.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateCustomerSchema = exports.CreateCustomerSchema = exports.CustomerSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_schema_1 = require("../../base.schema");
+const type_definitions_1 = require("../../type-definitions");
+/**
+ * @fileoverview Customer schema definitions for business management.
+ * @module business-mgt/customer
+ *
+ * Customers represent individual customer records with contact information,
+ * preferences, and custom fields for business-specific data.
+ */
+// ============================================================================
+// HELPER SCHEMAS
+// ============================================================================
+/**
+ * Phone number validation (basic E.164 format).
+ * Automatically normalizes to E.164 format with leading +.
+ */
+const phoneNumberSchema = zod_1.default.string()
+    .regex(/^\+?[1-9]\d{1,14}$/, "Invalid phone number format")
+    .transform((phone) => {
+    return phone.startsWith("+") ? phone : `+${phone}`;
+});
+// ============================================================================
+// CUSTOMER SCHEMA
+// ============================================================================
+/**
+ * Customer schema.
+ * Individual customer record with contact info and preferences.
+ *
+ * @typedef {Object} Customer
+ * @property {string} [customerId] - External system customer ID
+ * @property {string} [phone_number] - Primary phone number (E.164 format)
+ * @property {string} [firstname] - Customer's first name
+ * @property {string} [lastname] - Customer's last name
+ * @property {string} [company] - Company name for business customers
+ * @property {string} [timezone] - Customer's timezone (IANA format)
+ * @property {string} [email] - Primary email address
+ * @property {string} preferred_language - Preferred language (ISO 639-1)
+ * @property {string} preferred_contact_method - Preferred contact method
+ * @property {string} [best_time_to_call] - Best time for phone contact
+ * @property {string} [notes] - Internal staff notes
+ * @property {string[]} [tags] - Categorization labels
+ * @property {Object} [custom_fields] - Business-specific custom fields
+ * @property {string} [channelId] - Channel where customer was created
+ * @property {Object} [address] - Primary physical address
+ * @property {boolean} isValidatedNames - Whether names are verified
+ * @property {string} [customerGroupId] - Customer group for pricing/terms
+ */
+exports.CustomerSchema = base_schema_1.BaseModelSchema.safeExtend({
+    customerId: zod_1.default.string().nullable().optional().describe("External system customer ID for integration with third-party CRM or legacy systems."),
+    phone_number: phoneNumberSchema.nullable().optional().describe("Primary phone number in E.164 format (e.g., +14155552671), automatically normalized."),
+    firstname: zod_1.default.string().nullable().optional().describe("Customer's first name for personalized communications."),
+    lastname: zod_1.default.string().nullable().optional().describe("Customer's last name for full identification."),
+    company: zod_1.default.string().optional().describe("Company name when customer represents a business entity."),
+    timezone: zod_1.default.string().optional().describe("IANA timezone identifier (e.g., 'America/New_York') for scheduling."),
+    email: zod_1.default.email().optional().describe("Primary email for confirmations and notifications."),
+    preferred_language: zod_1.default.string().default("en").describe("ISO 639-1 language code (e.g., 'en', 'es', 'fr')."),
+    preferred_contact_method: zod_1.default.enum(type_definitions_1.PreferredContactMethod).default(type_definitions_1.PreferredContactMethod.EMAIL).describe("Preferred channel for notifications: EMAIL, PHONE, SMS."),
+    best_time_to_call: zod_1.default.enum(type_definitions_1.BestTimeToCall).optional().describe("Optimal time window (MORNING, AFTERNOON, EVENING) for phone contact."),
+    notes: zod_1.default.string().optional().describe("Internal staff notes about customer preferences and history."),
+    tags: zod_1.default.array(zod_1.default.string()).optional().describe("Categorization labels for segmentation (e.g., ['vip', 'gluten-free'])."),
+    custom_fields: zod_1.default.record(zod_1.default.string(), zod_1.default.any()).optional().describe("Extensible key-value storage for business-specific attributes."),
+    channelId: zod_1.default.string().nullable().optional().describe("ID of the communication channel where customer was created."),
+    address: base_schema_1.AddressSchema.optional().describe("Primary physical address for delivery and billing."),
+    isValidatedNames: zod_1.default.boolean().default(false).describe("Whether first/last names have been verified."),
+    customerGroupId: zod_1.default.string().nullable().optional().describe("Customer group ID for pricing and terms."),
+});
+// ============================================================================
+// CREATE/UPDATE SCHEMAS
+// ============================================================================
+/**
+ * Schema for creating a new customer.
+ * Omits auto-generated fields and channelId (set by system).
+ */
+exports.CreateCustomerSchema = exports.CustomerSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+    channelId: true,
+});
+/**
+ * Schema for updating an existing customer.
+ * All fields optional except id (required).
+ */
+exports.UpdateCustomerSchema = exports.CreateCustomerSchema.partial().safeExtend({
+    id: zod_1.default.string().describe("Unique identifier of the Customer to update"),
+});

package/dist/core/business-mgt/customer-management/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Central export point for customer management schemas.
+ * @module business-mgt/customer-management
+ */
+export * from './customer.schema';
+export * from './customer-group.schema';
+export * from './shipping-address.schema';

package/dist/core/business-mgt/customer-management/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @fileoverview Central export point for customer management schemas.
+ * @module business-mgt/customer-management
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./customer.schema"), exports);
+__exportStar(require("./customer-group.schema"), exports);
+__exportStar(require("./shipping-address.schema"), exports);

package/dist/core/business-mgt/customer-management/shipping-address.schema.d.ts

@@ -0,0 +1,112 @@
+import z from "zod";
+/**
+ * Shipping Address schema.
+ * Customer shipping address record with delivery details.
+ *
+ * @typedef {Object} ShippingAddress
+ * @property {string} customerId - Customer this address belongs to
+ * @property {string} street - Primary street address
+ * @property {string} [street2] - Secondary address line (apt, suite, unit)
+ * @property {string} city - City or municipality
+ * @property {string} state - State, province, or region
+ * @property {string} postalCode - ZIP or postal code
+ * @property {string} country - Country code or name
+ * @property {string} [recipientName] - Name of recipient
+ * @property {string} [phoneNumber] - Contact phone for delivery
+ * @property {string} [instructions] - Special delivery instructions
+ * @property {boolean} isPrimary - Whether this is the primary address
+ */
+export declare const ShippingAddressSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    customerId: z.ZodString;
+    street: z.ZodString;
+    street2: z.ZodOptional<z.ZodString>;
+    city: z.ZodString;
+    state: z.ZodString;
+    postalCode: z.ZodString;
+    country: z.ZodString;
+    recipientName: z.ZodOptional<z.ZodString>;
+    phoneNumber: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    instructions: z.ZodOptional<z.ZodString>;
+    isPrimary: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for creating a new shipping address.
+ * Omits auto-generated fields.
+ */
+export declare const CreateShippingAddressSchema: z.ZodObject<{
+    street: z.ZodString;
+    street2: z.ZodOptional<z.ZodString>;
+    city: z.ZodString;
+    state: z.ZodString;
+    postalCode: z.ZodString;
+    country: z.ZodString;
+    instructions: z.ZodOptional<z.ZodString>;
+    isPrimary: z.ZodDefault<z.ZodBoolean>;
+    phoneNumber: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    customerId: z.ZodString;
+    recipientName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an existing shipping address.
+ * All fields optional except id (required).
+ */
+export declare const UpdateShippingAddressSchema: z.ZodObject<{
+    street: z.ZodOptional<z.ZodString>;
+    street2: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    city: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    postalCode: z.ZodOptional<z.ZodString>;
+    country: z.ZodOptional<z.ZodString>;
+    instructions: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    isPrimary: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    phoneNumber: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>>;
+    customerId: z.ZodOptional<z.ZodString>;
+    recipientName: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type ShippingAddress = z.infer<typeof ShippingAddressSchema>;
+export type CreateShippingAddress = z.infer<typeof CreateShippingAddressSchema>;
+export type UpdateShippingAddress = z.infer<typeof UpdateShippingAddressSchema>;
+/**
+ * Shipping address filter options.
+ * @interface ShippingAddressFilters
+ */
+export interface ShippingAddressFilters {
+    /** Filter by customer ID */
+    customerId?: string;
+    /** Filter by primary status */
+    isPrimary?: boolean;
+    /** Filter by country */
+    country?: string;
+    /** Filter by city */
+    city?: string;
+    /** Filter by state */
+    state?: string;
+}
+/**
+ * Shipping address sorting options.
+ * @interface ShippingAddressSorting
+ */
+export interface ShippingAddressSorting {
+    /** Field to sort by */
+    field: "createdAt" | "isPrimary" | "country" | "city";
+    /** Sort direction */
+    direction: "asc" | "desc";
+}
+/**
+ * Shipping address query options.
+ * @interface ShippingAddressQueryOptions
+ */
+export interface ShippingAddressQueryOptions {
+    /** Page number (1-indexed) */
+    page: number;
+    /** Items per page */
+    pageSize: number;
+    /** Optional filters */
+    filters?: ShippingAddressFilters;
+    /** Optional sorting */
+    sorting?: ShippingAddressSorting;
+}

package/dist/core/business-mgt/customer-management/shipping-address.schema.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateShippingAddressSchema = exports.CreateShippingAddressSchema = exports.ShippingAddressSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_schema_1 = require("../../base.schema");
+/**
+ * @fileoverview Shipping Address schema definitions for customer management.
+ * @module business-mgt/shipping-address
+ *
+ * Shipping addresses store customer delivery addresses with recipient details
+ * and special delivery instructions.
+ */
+// ============================================================================
+// HELPER SCHEMAS
+// ============================================================================
+/**
+ * Phone number validation (basic E.164 format).
+ * Automatically normalizes to E.164 format with leading +.
+ */
+const phoneNumberSchema = zod_1.default.string()
+    .regex(/^\+?[1-9]\d{1,14}$/, "Invalid phone number format")
+    .transform((phone) => {
+    return phone.startsWith("+") ? phone : `+${phone}`;
+});
+// ============================================================================
+// SHIPPING ADDRESS SCHEMA
+// ============================================================================
+/**
+ * Shipping Address schema.
+ * Customer shipping address record with delivery details.
+ *
+ * @typedef {Object} ShippingAddress
+ * @property {string} customerId - Customer this address belongs to
+ * @property {string} street - Primary street address
+ * @property {string} [street2] - Secondary address line (apt, suite, unit)
+ * @property {string} city - City or municipality
+ * @property {string} state - State, province, or region
+ * @property {string} postalCode - ZIP or postal code
+ * @property {string} country - Country code or name
+ * @property {string} [recipientName] - Name of recipient
+ * @property {string} [phoneNumber] - Contact phone for delivery
+ * @property {string} [instructions] - Special delivery instructions
+ * @property {boolean} isPrimary - Whether this is the primary address
+ */
+exports.ShippingAddressSchema = base_schema_1.BaseModelSchema.safeExtend({
+    customerId: zod_1.default.string().describe("ID of the customer this shipping address belongs to"),
+    street: zod_1.default.string().min(2, { message: "Street must be 2 or more characters long" }).describe("Primary street address including house/building number"),
+    street2: zod_1.default.string().optional().describe("Secondary address line for apartment, suite, or unit numbers"),
+    city: zod_1.default.string().min(2, { message: "City must be 2 or more characters long" }).describe("City or municipality name"),
+    state: zod_1.default.string().min(2, { message: "State must be 2 or more characters long" }).describe("State, province, or region code"),
+    postalCode: zod_1.default.string().min(2, { message: "Postal code must be 2 or more characters long" }).describe("ZIP code, postal code, or equivalent"),
+    country: zod_1.default.string().min(2, { message: "Country must be 2 or more characters long" }).describe("ISO country code or country name"),
+    recipientName: zod_1.default.string().optional().describe("Name of the recipient for shipping"),
+    phoneNumber: phoneNumberSchema.nullable().optional().describe("Phone number for shipping contact"),
+    instructions: zod_1.default.string().optional().describe("Special instructions for delivery"),
+    isPrimary: zod_1.default.boolean().default(false).describe("Whether this is the primary shipping address"),
+});
+// ============================================================================
+// CREATE/UPDATE SCHEMAS
+// ============================================================================
+/**
+ * Schema for creating a new shipping address.
+ * Omits auto-generated fields.
+ */
+exports.CreateShippingAddressSchema = exports.ShippingAddressSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Schema for updating an existing shipping address.
+ * All fields optional except id (required).
+ */
+exports.UpdateShippingAddressSchema = exports.CreateShippingAddressSchema.partial().safeExtend({
+    id: zod_1.default.string().describe("Unique identifier of the ShippingAddress to update"),
+});

package/dist/core/business-mgt/customer.schema.d.ts

@@ -0,0 +1,111 @@
+import { z } from 'zod';
+import { BestTimeToCall, PreferredContactMethod } from '../type-definitions';
+/**
+ * Customer schema - Individual customer record.
+ *
+ * @typedef {Object} Customer
+ * @property {string} [customerId] - External system customer ID for integration purposes
+ * @property {string} [phone_number] - Customer's primary phone number in E.164 format
+ * @property {string} [firstname] - Customer's first name
+ * @property {string} [lastname] - Customer's last name
+ * @property {string} [company] - Company name if customer represents a business
+ * @property {string} [timezone] - Customer's timezone for scheduling purposes
+ * @property {string} [email] - Customer's primary email address
+ * @property {string} preferred_language - Customer's preferred language for communication
+ * @property {string} preferred_contact_method - Customer's preferred method of contact
+ * @property {string} [best_time_to_call] - Best time of day to contact customer by phone
+ * @property {string} [notes] - Internal notes about the customer
+ * @property {string[]} [tags] - Labels or categories assigned to the customer
+ * @property {Object} [custom_fields] - Additional custom fields for business-specific customer data
+ * @property {string} [channelId] - Communication channel ID associated with the customer creation
+ * @property {Object} [address] - Customer's primary address information
+ * @property {boolean} isValidatedNames - Whether the customer's name has been validated for accuracy
+ */
+export declare const CustomerSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    phone_number: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lastname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    company: z.ZodOptional<z.ZodString>;
+    timezone: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodEmail>;
+    preferred_language: z.ZodDefault<z.ZodString>;
+    preferred_contact_method: z.ZodDefault<z.ZodEnum<typeof PreferredContactMethod>>;
+    best_time_to_call: z.ZodOptional<z.ZodEnum<typeof BestTimeToCall>>;
+    notes: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    custom_fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    address: z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
+    isValidatedNames: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for creating a new customer.
+ * Omits auto-generated fields.
+ */
+export declare const CreateCustomerSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodEmail>;
+    customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    phone_number: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lastname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    company: z.ZodOptional<z.ZodString>;
+    timezone: z.ZodOptional<z.ZodString>;
+    preferred_language: z.ZodDefault<z.ZodString>;
+    preferred_contact_method: z.ZodDefault<z.ZodEnum<typeof PreferredContactMethod>>;
+    best_time_to_call: z.ZodOptional<z.ZodEnum<typeof BestTimeToCall>>;
+    notes: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    custom_fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    address: z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
+    isValidatedNames: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an existing customer.
+ * All fields are optional except id.
+ */
+export declare const UpdateCustomerSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodOptional<z.ZodEmail>>;
+    customerId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    phone_number: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>>;
+    firstname: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    lastname: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    company: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    preferred_language: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    preferred_contact_method: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof PreferredContactMethod>>>;
+    best_time_to_call: z.ZodOptional<z.ZodOptional<z.ZodEnum<typeof BestTimeToCall>>>;
+    notes: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    tags: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    custom_fields: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    address: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>>;
+    isValidatedNames: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type CreateCustomer = z.infer<typeof CreateCustomerSchema>;
+export type UpdateCustomer = z.infer<typeof UpdateCustomerSchema>;
+export type Customer = z.infer<typeof CustomerSchema>;

package/dist/core/business-mgt/customer.schema.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateCustomerSchema = exports.CreateCustomerSchema = exports.CustomerSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../base.schema");
+const type_definitions_1 = require("../type-definitions");
+/**
+ * @fileoverview Customer schema definitions for business management.
+ * @module business-mgt/customer
+ */
+// Phone number validation (basic E.164 format)
+const phoneNumberSchema = zod_1.z.string()
+    .regex(/^\+?[1-9]\d{1,14}$/, 'Invalid phone number format')
+    .transform((phone) => {
+    // Normalize to E.164 format
+    return phone.startsWith('+') ? phone : `+${phone}`;
+});
+/**
+ * Customer schema - Individual customer record.
+ *
+ * @typedef {Object} Customer
+ * @property {string} [customerId] - External system customer ID for integration purposes
+ * @property {string} [phone_number] - Customer's primary phone number in E.164 format
+ * @property {string} [firstname] - Customer's first name
+ * @property {string} [lastname] - Customer's last name
+ * @property {string} [company] - Company name if customer represents a business
+ * @property {string} [timezone] - Customer's timezone for scheduling purposes
+ * @property {string} [email] - Customer's primary email address
+ * @property {string} preferred_language - Customer's preferred language for communication
+ * @property {string} preferred_contact_method - Customer's preferred method of contact
+ * @property {string} [best_time_to_call] - Best time of day to contact customer by phone
+ * @property {string} [notes] - Internal notes about the customer
+ * @property {string[]} [tags] - Labels or categories assigned to the customer
+ * @property {Object} [custom_fields] - Additional custom fields for business-specific customer data
+ * @property {string} [channelId] - Communication channel ID associated with the customer creation
+ * @property {Object} [address] - Customer's primary address information
+ * @property {boolean} isValidatedNames - Whether the customer's name has been validated for accuracy
+ */
+exports.CustomerSchema = base_schema_1.BaseModelSchema.safeExtend({
+    customerId: zod_1.z.string().nullable().optional().describe("External system customer ID for integration with third-party CRM or legacy systems. Links WIIL Platform customer records with existing databases while maintaining internal id as primary identifier."),
+    phone_number: phoneNumberSchema.nullable().optional().describe("Primary phone number in E.164 format (e.g., +14155552671), automatically normalized. Used by AI Powered Services for voice interactions, SMS, appointment reminders, and order notifications."),
+    firstname: zod_1.z.string().nullable().optional().describe("Customer's first name for personalized communications and AI conversations. May be null for walk-in customers or minimal-info transactions."),
+    lastname: zod_1.z.string().nullable().optional().describe("Customer's last name combined with firstname for full identification in appointments and orders. May be null for casual transactions."),
+    company: zod_1.z.string().optional().describe("Company name when customer represents a business entity. Used for B2B transactions, corporate accounts, and distinguishing business vs individual customers."),
+    timezone: zod_1.z.string().optional().describe("IANA timezone identifier (e.g., 'America/New_York') for accurate appointment scheduling, reservation timing, and ensuring communications arrive at appropriate local times."),
+    email: zod_1.z.email().optional().describe("Primary email for confirmations, receipts, and AI-generated summaries. Also serves as unique identifier for account recovery and duplicate detection."),
+    preferred_language: zod_1.z.string().default('en').describe("ISO 639-1 language code (e.g., 'en', 'es', 'fr') for AI conversations and notifications. Defaults to English. Essential for multilingual operations."),
+    preferred_contact_method: zod_1.z.enum(type_definitions_1.PreferredContactMethod).default(type_definitions_1.PreferredContactMethod.EMAIL).describe("Preferred channel for notifications: EMAIL, PHONE, SMS. AI Powered Services respects this when sending reminders and updates. Defaults to EMAIL."),
+    best_time_to_call: zod_1.z.enum(type_definitions_1.BestTimeToCall).optional().describe("Optimal time window (MORNING, AFTERNOON, EVENING) for phone contact. Used by support teams and automated systems to improve contact success rates."),
+    notes: zod_1.z.string().optional().describe("Internal staff notes about customer preferences, requirements, history, or behavioral patterns. Not visible to customers; used for personalized service delivery."),
+    tags: zod_1.z.array(zod_1.z.string()).optional().describe("Categorization labels for segmentation (e.g., ['vip', 'gluten-free']). Used for marketing campaigns, analytics, and dynamic customer grouping."),
+    custom_fields: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Extensible key-value storage for business-specific attributes (e.g., medical history, dietary restrictions, membership tier). Provides schema flexibility."),
+    channelId: zod_1.z.string().nullable().optional().describe("ID of the communication channel (phone, web, app) where customer record was created. Links to deployment configuration for attribution tracking and analytics."),
+    address: base_schema_1.AddressSchema.optional().describe("Primary physical address for delivery orders, on-site service appointments, billing, and geographic analysis."),
+    isValidatedNames: zod_1.z.boolean().default(false).describe("Whether first/last names have been verified through ID verification, payment matching, or manual confirmation. Maintains data quality and reduces fraud. Defaults to false."),
+});
+/**
+ * Schema for creating a new customer.
+ * Omits auto-generated fields.
+ */
+exports.CreateCustomerSchema = exports.CustomerSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+    channelId: true,
+});
+/**
+ * Schema for updating an existing customer.
+ * All fields are optional except id.
+ */
+exports.UpdateCustomerSchema = exports.CreateCustomerSchema.partial().safeExtend({
+    id: zod_1.z.string(),
+});