crexperium-sdk 1.2.2 → 1.2.3

package/dist/resources/contacts.d.ts

@@ -5,7 +5,38 @@ import { BaseResource } from './base';
 import { Contact, IdentifyOptions, IdentifyResponse, ContactFilters, CreateContactInput, PaginatedResponse } from '../types';
 export declare class ContactsResource extends BaseResource {
     /**
-     * Identify a contact (create or update)
+     * Identify a contact (create or update by multiple identifiers)
+     *
+     * Accepts at least ONE of: externalId, visitorId, email, or phone
+     * Priority: externalId > visitorId > email > phone
+     *
+     * @example
+     * // Identify by external ID (after login)
+     * await client.contacts.identify({
+     *   externalId: 'user_123',
+     *   email: 'user@example.com',
+     *   firstName: 'John'
+     * });
+     *
+     * @example
+     * // Identify by visitor ID (anonymous → known)
+     * await client.contacts.identify({
+     *   visitorId: client.visitorId.getVisitorId(),
+     *   email: 'user@example.com'
+     * });
+     *
+     * @example
+     * // Identify by email only
+     * await client.contacts.identify({
+     *   email: 'user@example.com',
+     *   firstName: 'John'
+     * });
+     *
+     * @example
+     * // Identify by phone only
+     * await client.contacts.identify({
+     *   phone: '+1234567890'
+     * });
      */
     identify(options: IdentifyOptions): Promise<IdentifyResponse>;
     /**

package/dist/types/contacts.d.ts

@@ -25,12 +25,22 @@ export interface Contact {
     updated_at: string;
     last_activity_at?: string;
 }
+/**
+ * Identify options - requires at least ONE identifier:
+ * - externalId: Your app's user ID (e.g., "user_123")
+ * - visitorId: SDK's auto-generated visitor ID (from client.visitorId.getVisitorId())
+ * - email: User's email address
+ * - phone: User's phone number
+ *
+ * Priority: externalId > visitorId > email > phone
+ */
 export interface IdentifyOptions {
-    externalId: string;
+    externalId?: string;
+    visitorId?: string;
     email?: string;
+    phone?: string;
     firstName?: string;
     lastName?: string;
-    phone?: string;
     title?: string;
     company?: string;
     website?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crexperium-sdk",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Official TypeScript/JavaScript SDK for Crexperium CRM",
   "main": "dist/index.js",
   "module": "dist/index.mjs",