crexperium-sdk 1.2.2 → 1.2.3

package/dist/index.js

@@ -451,11 +451,43 @@ class EventsResource extends BaseResource {
  */
 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'
+     * });
      */
     async identify(options) {
-        if (!options.externalId) {
-            throw new Error('externalId is required');
+        // Validate that at least one identifier is provided
+        if (!options.externalId && !options.visitorId && !options.email && !options.phone) {
+            throw new Error('At least one identifier is required: externalId, visitorId, email, or phone');
         }
         const data = this.cleanObject(this.toSnakeCase(options));
         return this.http.post('/api/v1/contacts/identify/', data);