@tiquo/dom-package 1.5.3 → 1.6.0

package/README.md

@@ -277,6 +277,32 @@ const page2 = await auth.getEnquiries({ limit: 10, cursor: page1.nextCursor });
 - `hasMore` - Whether there are more enquiries to fetch
 - `nextCursor` - Cursor for the next page (if `hasMore` is true)
 
+#### `createEnquiry(input): Promise<CreateEnquiryResult>`
+
+Create an enquiry from your website. `customer.email` is required. If the visitor is authenticated, the enquiry is attached to that customer. Otherwise the SDK uses your public key and allowed domain configuration, finds or creates a customer by email, and attaches the enquiry.
+
+Submitted customer fields fill missing profile data only; existing names, phones, and customer parameter values are not overwritten.
+
+```typescript
+const { enquiry, customer } = await auth.createEnquiry({
+  customer: {
+    email: 'customer@example.com',
+    firstName: 'Sam',
+    lastName: 'Taylor',
+    phone: '+44 7911 123456',
+    details: {
+      system_marketing_opt_in: true,
+    },
+  },
+  enquiry: {
+    subject: 'Private event request',
+    message: 'I would like to enquire about availability next Friday.',
+    category: 'events',
+    priority: 'medium',
+  },
+});
+```
+
 #### `destroy(): void`
 
 Clean up resources when destroying the auth instance. Call this when your component unmounts or when you no longer need the auth instance.

package/dist/index.d.mts

@@ -622,6 +622,40 @@ interface GetEnquiriesResult {
     hasMore: boolean;
     nextCursor?: string;
 }
+interface CreateEnquiryCustomerData {
+    /** Required. Used to find or create the customer profile for this enquiry. */
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    /**
+     * Primary phone number in E.164 format. The SDK auto-normalizes common
+     * formats before submission.
+     */
+    phone?: string;
+    /**
+     * Additional customer parameter values keyed by system parameter id
+     * (`system_marketing_opt_in`) or customer parameter schema id. Existing
+     * non-empty values are not overwritten.
+     */
+    details?: Record<string, string | number | boolean | null>;
+}
+interface CreateEnquiryData {
+    customer: CreateEnquiryCustomerData;
+    enquiry: {
+        type?: string;
+        subject?: string;
+        /** Required unless `subject` is supplied. */
+        message?: string;
+        category?: string;
+        priority?: "low" | "medium" | "high" | "urgent";
+        source?: "online" | "website" | "phone" | "email" | "walk_in" | "social" | "referral" | "pos" | "admin";
+    };
+}
+interface CreateEnquiryResult {
+    success: boolean;
+    enquiry: TiquoEnquiry;
+    customer: TiquoCustomer;
+}
 type TiquoCompanyRelationship = "employee" | "contractor" | "manager" | "executive" | "owner" | "contact" | "other";
 /**
  * The authenticated customer's membership in a company. Each company the
@@ -823,6 +857,18 @@ declare class TiquoAuth {
      * Only returns enquiries for the logged-in customer
      */
     getEnquiries(options?: GetEnquiriesOptions): Promise<GetEnquiriesResult>;
+    /**
+     * Create a new enquiry through the DOM package.
+     *
+     * `customer.email` is required. If the current browser has an authenticated
+     * DOM session, the enquiry is associated with that customer. Otherwise the
+     * public key and allowed-domain configuration are used to accept the
+     * submission, find or create a customer by email, and attach the enquiry.
+     *
+     * Submitted customer details fill missing customer profile fields only; they
+     * do not overwrite existing profile data.
+     */
+    createEnquiry(input: CreateEnquiryData): Promise<CreateEnquiryResult>;
     /**
      * Get the companies the authenticated customer belongs to.
      *
@@ -946,6 +992,7 @@ declare function useTiquoAuth(auth: TiquoAuth): {
     getUpcomingBookings: (options?: Omit<GetBookingsOptions, "upcoming">) => Promise<GetBookingsResult>;
     getReceipt: (orderId: string) => Promise<TiquoReceipt>;
     getEnquiries: (options?: GetEnquiriesOptions) => Promise<GetEnquiriesResult>;
+    createEnquiry: (input: CreateEnquiryData) => Promise<CreateEnquiryResult>;
     getCompanies: () => Promise<GetCompaniesResult>;
     getCompanyColleagues: (companyId: string) => Promise<GetCompanyColleaguesResult>;
     getIframeToken: (flowId?: string) => Promise<IframeTokenResult>;
@@ -1010,4 +1057,4 @@ declare class TiquoPhone {
     static buildPhone: typeof buildPhone;
 }
 
-export { type AuthStateChangeCallback, type CountryPhoneInfo, type GetBookingsOptions, type GetBookingsResult, type GetCompaniesResult, type GetCompanyColleaguesResult, type GetEnquiriesOptions, type GetEnquiriesResult, type GetOrdersOptions, type GetOrdersResult, type IframeTokenResult, type PhoneValidationResult, type ProfilePhotoUploadResult, type ProfileUpdateData, type ProfileUpdateResult, type SendOTPResult, TiquoAnalytics, type TiquoAnalyticsConfig, type TiquoAnalyticsEventOptions, TiquoAuth, type TiquoAuthConfig, TiquoAuthError, type TiquoBooking, TiquoCMS, type TiquoCMSBlock, type TiquoCMSConfig, type TiquoCMSPage, type TiquoCMSPageRequest, type TiquoCompany, type TiquoCompanyColleague, type TiquoCompanyMembership, type TiquoCompanyRelationship, type TiquoCustomer, type TiquoCustomerEmail, type TiquoCustomerPhone, type TiquoEnquiry, type TiquoOrder, type TiquoOrderItem, TiquoPhone, type TiquoReceipt, type TiquoReceiptBusiness, type TiquoReceiptCustomer, type TiquoReceiptItem, type TiquoReceiptOrder, type TiquoSession, type TiquoUser, type VerifyOTPResult, addCustomerUserId, clearCachedEmail, TiquoAuth as default, getCustomerUserIds, getPrefilledEmailFromCookie, isDashboardSession, trackCustomerPresence, useTiquoAuth };
+export { type AuthStateChangeCallback, type CountryPhoneInfo, type CreateEnquiryCustomerData, type CreateEnquiryData, type CreateEnquiryResult, type GetBookingsOptions, type GetBookingsResult, type GetCompaniesResult, type GetCompanyColleaguesResult, type GetEnquiriesOptions, type GetEnquiriesResult, type GetOrdersOptions, type GetOrdersResult, type IframeTokenResult, type PhoneValidationResult, type ProfilePhotoUploadResult, type ProfileUpdateData, type ProfileUpdateResult, type SendOTPResult, TiquoAnalytics, type TiquoAnalyticsConfig, type TiquoAnalyticsEventOptions, TiquoAuth, type TiquoAuthConfig, TiquoAuthError, type TiquoBooking, TiquoCMS, type TiquoCMSBlock, type TiquoCMSConfig, type TiquoCMSPage, type TiquoCMSPageRequest, type TiquoCompany, type TiquoCompanyColleague, type TiquoCompanyMembership, type TiquoCompanyRelationship, type TiquoCustomer, type TiquoCustomerEmail, type TiquoCustomerPhone, type TiquoEnquiry, type TiquoOrder, type TiquoOrderItem, TiquoPhone, type TiquoReceipt, type TiquoReceiptBusiness, type TiquoReceiptCustomer, type TiquoReceiptItem, type TiquoReceiptOrder, type TiquoSession, type TiquoUser, type VerifyOTPResult, addCustomerUserId, clearCachedEmail, TiquoAuth as default, getCustomerUserIds, getPrefilledEmailFromCookie, isDashboardSession, trackCustomerPresence, useTiquoAuth };

package/dist/index.d.ts

@@ -622,6 +622,40 @@ interface GetEnquiriesResult {
     hasMore: boolean;
     nextCursor?: string;
 }
+interface CreateEnquiryCustomerData {
+    /** Required. Used to find or create the customer profile for this enquiry. */
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    /**
+     * Primary phone number in E.164 format. The SDK auto-normalizes common
+     * formats before submission.
+     */
+    phone?: string;
+    /**
+     * Additional customer parameter values keyed by system parameter id
+     * (`system_marketing_opt_in`) or customer parameter schema id. Existing
+     * non-empty values are not overwritten.
+     */
+    details?: Record<string, string | number | boolean | null>;
+}
+interface CreateEnquiryData {
+    customer: CreateEnquiryCustomerData;
+    enquiry: {
+        type?: string;
+        subject?: string;
+        /** Required unless `subject` is supplied. */
+        message?: string;
+        category?: string;
+        priority?: "low" | "medium" | "high" | "urgent";
+        source?: "online" | "website" | "phone" | "email" | "walk_in" | "social" | "referral" | "pos" | "admin";
+    };
+}
+interface CreateEnquiryResult {
+    success: boolean;
+    enquiry: TiquoEnquiry;
+    customer: TiquoCustomer;
+}
 type TiquoCompanyRelationship = "employee" | "contractor" | "manager" | "executive" | "owner" | "contact" | "other";
 /**
  * The authenticated customer's membership in a company. Each company the
@@ -823,6 +857,18 @@ declare class TiquoAuth {
      * Only returns enquiries for the logged-in customer
      */
     getEnquiries(options?: GetEnquiriesOptions): Promise<GetEnquiriesResult>;
+    /**
+     * Create a new enquiry through the DOM package.
+     *
+     * `customer.email` is required. If the current browser has an authenticated
+     * DOM session, the enquiry is associated with that customer. Otherwise the
+     * public key and allowed-domain configuration are used to accept the
+     * submission, find or create a customer by email, and attach the enquiry.
+     *
+     * Submitted customer details fill missing customer profile fields only; they
+     * do not overwrite existing profile data.
+     */
+    createEnquiry(input: CreateEnquiryData): Promise<CreateEnquiryResult>;
     /**
      * Get the companies the authenticated customer belongs to.
      *
@@ -946,6 +992,7 @@ declare function useTiquoAuth(auth: TiquoAuth): {
     getUpcomingBookings: (options?: Omit<GetBookingsOptions, "upcoming">) => Promise<GetBookingsResult>;
     getReceipt: (orderId: string) => Promise<TiquoReceipt>;
     getEnquiries: (options?: GetEnquiriesOptions) => Promise<GetEnquiriesResult>;
+    createEnquiry: (input: CreateEnquiryData) => Promise<CreateEnquiryResult>;
     getCompanies: () => Promise<GetCompaniesResult>;
     getCompanyColleagues: (companyId: string) => Promise<GetCompanyColleaguesResult>;
     getIframeToken: (flowId?: string) => Promise<IframeTokenResult>;
@@ -1010,4 +1057,4 @@ declare class TiquoPhone {
     static buildPhone: typeof buildPhone;
 }
 
-export { type AuthStateChangeCallback, type CountryPhoneInfo, type GetBookingsOptions, type GetBookingsResult, type GetCompaniesResult, type GetCompanyColleaguesResult, type GetEnquiriesOptions, type GetEnquiriesResult, type GetOrdersOptions, type GetOrdersResult, type IframeTokenResult, type PhoneValidationResult, type ProfilePhotoUploadResult, type ProfileUpdateData, type ProfileUpdateResult, type SendOTPResult, TiquoAnalytics, type TiquoAnalyticsConfig, type TiquoAnalyticsEventOptions, TiquoAuth, type TiquoAuthConfig, TiquoAuthError, type TiquoBooking, TiquoCMS, type TiquoCMSBlock, type TiquoCMSConfig, type TiquoCMSPage, type TiquoCMSPageRequest, type TiquoCompany, type TiquoCompanyColleague, type TiquoCompanyMembership, type TiquoCompanyRelationship, type TiquoCustomer, type TiquoCustomerEmail, type TiquoCustomerPhone, type TiquoEnquiry, type TiquoOrder, type TiquoOrderItem, TiquoPhone, type TiquoReceipt, type TiquoReceiptBusiness, type TiquoReceiptCustomer, type TiquoReceiptItem, type TiquoReceiptOrder, type TiquoSession, type TiquoUser, type VerifyOTPResult, addCustomerUserId, clearCachedEmail, TiquoAuth as default, getCustomerUserIds, getPrefilledEmailFromCookie, isDashboardSession, trackCustomerPresence, useTiquoAuth };
+export { type AuthStateChangeCallback, type CountryPhoneInfo, type CreateEnquiryCustomerData, type CreateEnquiryData, type CreateEnquiryResult, type GetBookingsOptions, type GetBookingsResult, type GetCompaniesResult, type GetCompanyColleaguesResult, type GetEnquiriesOptions, type GetEnquiriesResult, type GetOrdersOptions, type GetOrdersResult, type IframeTokenResult, type PhoneValidationResult, type ProfilePhotoUploadResult, type ProfileUpdateData, type ProfileUpdateResult, type SendOTPResult, TiquoAnalytics, type TiquoAnalyticsConfig, type TiquoAnalyticsEventOptions, TiquoAuth, type TiquoAuthConfig, TiquoAuthError, type TiquoBooking, TiquoCMS, type TiquoCMSBlock, type TiquoCMSConfig, type TiquoCMSPage, type TiquoCMSPageRequest, type TiquoCompany, type TiquoCompanyColleague, type TiquoCompanyMembership, type TiquoCompanyRelationship, type TiquoCustomer, type TiquoCustomerEmail, type TiquoCustomerPhone, type TiquoEnquiry, type TiquoOrder, type TiquoOrderItem, TiquoPhone, type TiquoReceipt, type TiquoReceiptBusiness, type TiquoReceiptCustomer, type TiquoReceiptItem, type TiquoReceiptOrder, type TiquoSession, type TiquoUser, type VerifyOTPResult, addCustomerUserId, clearCachedEmail, TiquoAuth as default, getCustomerUserIds, getPrefilledEmailFromCookie, isDashboardSession, trackCustomerPresence, useTiquoAuth };

package/dist/index.js

@@ -1593,6 +1593,89 @@ var TiquoAuth = class {
     const result = await response.json();
     return result.data || { enquiries: [], hasMore: false };
   }
+  /**
+   * Create a new enquiry through the DOM package.
+   *
+   * `customer.email` is required. If the current browser has an authenticated
+   * DOM session, the enquiry is associated with that customer. Otherwise the
+   * public key and allowed-domain configuration are used to accept the
+   * submission, find or create a customer by email, and attach the enquiry.
+   *
+   * Submitted customer details fill missing customer profile fields only; they
+   * do not overwrite existing profile data.
+   */
+  async createEnquiry(input) {
+    if (this.accessToken) {
+      await this.refreshTokenIfNeeded();
+    }
+    const customer = { ...input.customer };
+    if (!customer.email?.trim()) {
+      throw new TiquoAuthError(
+        "customer.email is required",
+        "CREATE_ENQUIRY_FAILED"
+      );
+    }
+    if (customer.phone !== void 0 && customer.phone !== "") {
+      const normalized = normalizePhone(customer.phone);
+      const validation = validatePhone(customer.phone);
+      if (!validation.valid) {
+        this.log(
+          "\u26A0\uFE0F Phone validation warning:",
+          validation.reason,
+          "- Original:",
+          customer.phone
+        );
+      }
+      customer.phone = normalized || customer.phone;
+    }
+    const enquiry = { ...input.enquiry };
+    if (!enquiry.message?.trim() && !enquiry.subject?.trim()) {
+      throw new TiquoAuthError(
+        "enquiry.message or enquiry.subject is required",
+        "CREATE_ENQUIRY_FAILED"
+      );
+    }
+    this.log("Creating customer enquiry:", {
+      customer: { ...customer, email: customer.email },
+      enquiry
+    });
+    const response = await this.request("/api/client/v1/enquiries", {
+      method: "POST",
+      headers: {
+        "X-Public-Key": this.config.publicKey
+      },
+      body: JSON.stringify({
+        publicKey: this.config.publicKey,
+        customer,
+        enquiry
+      })
+    });
+    if (!response.ok) {
+      const error = await response.json().catch(() => ({ error: "Failed to create enquiry" }));
+      throw new TiquoAuthError(
+        error.error || "Failed to create enquiry",
+        "CREATE_ENQUIRY_FAILED",
+        response.status
+      );
+    }
+    const result = await response.json();
+    const data = result.data || result;
+    const createdCustomer = data.customer;
+    if (this.session && createdCustomer) {
+      this.session = {
+        ...this.session,
+        customer: createdCustomer
+      };
+      this.notifyListeners();
+      this.broadcastTabSync("SESSION_UPDATE");
+    }
+    this.analytics?.identify({ identityLinkType: "enquiry" }).catch(() => void 0);
+    return {
+      success: true,
+      enquiry: data.enquiry,
+      customer: createdCustomer
+    };
+  }
   /**
    * Get the companies the authenticated customer belongs to.
    *
@@ -2307,6 +2390,7 @@ function useTiquoAuth(auth) {
     getUpcomingBookings: (options) => auth.getUpcomingBookings(options),
     getReceipt: (orderId) => auth.getReceipt(orderId),
     getEnquiries: (options) => auth.getEnquiries(options),
+    createEnquiry: (input) => auth.createEnquiry(input),
     getCompanies: () => auth.getCompanies(),
     getCompanyColleagues: (companyId) => auth.getCompanyColleagues(companyId),
     getIframeToken: (flowId) => auth.getIframeToken(flowId),

package/dist/index.mjs

@@ -1555,6 +1555,89 @@ var TiquoAuth = class {
     const result = await response.json();
     return result.data || { enquiries: [], hasMore: false };
   }
+  /**
+   * Create a new enquiry through the DOM package.
+   *
+   * `customer.email` is required. If the current browser has an authenticated
+   * DOM session, the enquiry is associated with that customer. Otherwise the
+   * public key and allowed-domain configuration are used to accept the
+   * submission, find or create a customer by email, and attach the enquiry.
+   *
+   * Submitted customer details fill missing customer profile fields only; they
+   * do not overwrite existing profile data.
+   */
+  async createEnquiry(input) {
+    if (this.accessToken) {
+      await this.refreshTokenIfNeeded();
+    }
+    const customer = { ...input.customer };
+    if (!customer.email?.trim()) {
+      throw new TiquoAuthError(
+        "customer.email is required",
+        "CREATE_ENQUIRY_FAILED"
+      );
+    }
+    if (customer.phone !== void 0 && customer.phone !== "") {
+      const normalized = normalizePhone(customer.phone);
+      const validation = validatePhone(customer.phone);
+      if (!validation.valid) {
+        this.log(
+          "\u26A0\uFE0F Phone validation warning:",
+          validation.reason,
+          "- Original:",
+          customer.phone
+        );
+      }
+      customer.phone = normalized || customer.phone;
+    }
+    const enquiry = { ...input.enquiry };
+    if (!enquiry.message?.trim() && !enquiry.subject?.trim()) {
+      throw new TiquoAuthError(
+        "enquiry.message or enquiry.subject is required",
+        "CREATE_ENQUIRY_FAILED"
+      );
+    }
+    this.log("Creating customer enquiry:", {
+      customer: { ...customer, email: customer.email },
+      enquiry
+    });
+    const response = await this.request("/api/client/v1/enquiries", {
+      method: "POST",
+      headers: {
+        "X-Public-Key": this.config.publicKey
+      },
+      body: JSON.stringify({
+        publicKey: this.config.publicKey,
+        customer,
+        enquiry
+      })
+    });
+    if (!response.ok) {
+      const error = await response.json().catch(() => ({ error: "Failed to create enquiry" }));
+      throw new TiquoAuthError(
+        error.error || "Failed to create enquiry",
+        "CREATE_ENQUIRY_FAILED",
+        response.status
+      );
+    }
+    const result = await response.json();
+    const data = result.data || result;
+    const createdCustomer = data.customer;
+    if (this.session && createdCustomer) {
+      this.session = {
+        ...this.session,
+        customer: createdCustomer
+      };
+      this.notifyListeners();
+      this.broadcastTabSync("SESSION_UPDATE");
+    }
+    this.analytics?.identify({ identityLinkType: "enquiry" }).catch(() => void 0);
+    return {
+      success: true,
+      enquiry: data.enquiry,
+      customer: createdCustomer
+    };
+  }
   /**
    * Get the companies the authenticated customer belongs to.
    *
@@ -2269,6 +2352,7 @@ function useTiquoAuth(auth) {
     getUpcomingBookings: (options) => auth.getUpcomingBookings(options),
     getReceipt: (orderId) => auth.getReceipt(orderId),
     getEnquiries: (options) => auth.getEnquiries(options),
+    createEnquiry: (input) => auth.createEnquiry(input),
     getCompanies: () => auth.getCompanies(),
     getCompanyColleagues: (companyId) => auth.getCompanyColleagues(companyId),
     getIframeToken: (flowId) => auth.getIframeToken(flowId),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiquo/dom-package",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "description": "Tiquo SDK for third-party websites - authentication, customer profiles, orders, bookings, enquiries, receipts, and companies",
   "sideEffects": true,
   "publishConfig": {