linkbreakers 1.34.0 → 1.35.0

package/README.md

@@ -33,6 +33,83 @@ const link = await linksApi.createLink({
 console.log('Short link:', link.shortlink);
 ```
 
+### Identifying Visitors
+
+Use the `VisitorsApi` to identify and update visitor profiles. The `identify` method finds or creates a visitor using their LBID (from tracking) and merges attributes:
+
+```typescript
+import { Configuration, VisitorsApi } from 'linkbreakers';
+
+const config = new Configuration({
+  accessToken: 'your_api_key_here',
+  basePath: 'https://api.linkbreakers.com',
+});
+
+const visitorsApi = new VisitorsApi(config);
+
+// Identify a visitor using their LBID (from tracking cookie/parameter)
+const response = await visitorsApi.visitorsServiceIdentify({
+  identifyRequest: {
+    lbid: 'visitor-lbid-from-tracking',  // Base64 encoded event ID from click/scan
+    visitor: {
+      data: {
+        // System fields (prefixed with "$")
+        '$email': 'user@example.com',
+        '$phone': '+1234567890',
+        '$firstName': 'John',
+        '$lastName': 'Doe',
+
+        // Custom attributes (no "$" prefix)
+        'company': 'Acme Corp',
+        'plan': 'premium',
+        'signupDate': '2024-01-01'
+      }
+    },
+    setOnce: false  // If true, only sets empty fields (won't overwrite existing)
+  }
+});
+
+console.log('Created new profile:', response.created);
+console.log('Visitor:', response.visitor);
+```
+
+**Update an existing visitor by UUID:**
+
+```typescript
+// When you have the visitor's UUID (from your database)
+const visitor = await visitorsApi.visitorsServiceUpdate({
+  id: 'visitor-uuid',
+  visitorsServiceUpdateBody: {
+    visitor: {
+      data: {
+        '$email': 'updated@example.com',
+        'plan': 'enterprise'
+      }
+    }
+  }
+});
+```
+
+**Get visitor details:**
+
+```typescript
+const visitor = await visitorsApi.visitorsServiceGet({
+  id: 'visitor-uuid',
+  include: ['devices', 'events', 'links']  // Optional: include related data
+});
+```
+
+**List visitors:**
+
+```typescript
+const visitors = await visitorsApi.visitorsServiceList({
+  pageSize: 50,
+  email: 'user@example.com',  // Optional filters
+  linkId: 'link-uuid',
+  search: 'Acme Corp'
+});
+```
+
 ### Full API Support
 
 The SDK provides type-safe methods for all API operations:
@@ -67,6 +144,17 @@ const links = await linksApi.listLinks({
 - ✅ Auto-generated from OpenAPI specification
 - ✅ Automatically updated when API changes
 
+## Examples
+
+For complete, runnable code examples, see the [examples/](./examples) directory:
+
+- **[identify-visitor.ts](./examples/identify-visitor.ts)** - Identify visitors using LBID (most important!)
+- **[update-visitor.ts](./examples/update-visitor.ts)** - Update visitors by UUID
+- **[create-link.ts](./examples/create-link.ts)** - Create shortened links with various options
+- **[list-visitors.ts](./examples/list-visitors.ts)** - Query and filter visitors
+
+Each example is complete, well-documented, and ready to run. See [examples/README.md](./examples/README.md) for details.
+
 ## Documentation
 
 For complete API documentation, visit [https://docs.linkbreakers.com](https://docs.linkbreakers.com)

package/dist/apis/CustomDomainsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/CustomDomainsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/EventsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/EventsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/IntegrationsServiceApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/IntegrationsServiceApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/LinkSettingsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/LinkSettingsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/LinksApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/LinksApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MediaApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MediaApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MembersApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MembersApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/PageThemesApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/PageThemesApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/QRCodeDesignsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/QRCodeDesignsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/QRCodeTemplatesApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/QRCodeTemplatesApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/TagsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/TagsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/TimeSeriesApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/TimeSeriesApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/VisitorsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/VisitorsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WebhooksApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WebhooksApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkflowStepsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkflowStepsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkspaceMetricsApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkspaceMetricsApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkspaceTokensApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkspaceTokensApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkspacesApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/WorkspacesApi.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/Action.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/Action.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AddWorkflowStepRelationshipResponse.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AddWorkflowStepRelationshipResponse.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ApiTag.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ApiTag.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/BackgroundOptions.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/BackgroundOptions.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/CanvasPosition.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/CanvasPosition.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/CheckCustomDomainResponse.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/CheckCustomDomainResponse.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ClientRedirectPayload.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ClientRedirectPayload.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ContactCardTraceCard.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ContactCardTraceCard.js

@@ -5,7 +5,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ContactCardTraceData.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.34.0
+ * The version of the OpenAPI document: 1.35.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).