@proveanything/smartlinks 1.0.61 → 1.0.62

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.61  |  Generated: 2025-12-11T14:28:56.705Z
+Version: 1.0.62  |  Generated: 2025-12-17T18:11:04.911Z
 
 This is a concise summary of all available API functions and types.
 
@@ -19,6 +19,7 @@ The Smartlinks SDK is organized into the following namespaces:
 - **claimSet** - Claim creation, management, and verification
 - **collection** - Collection CRUD operations and management
 - **comms** - Functions for comms operations
+- **contact** - Functions for contact operations
 - **crate** - Container/crate management for organizing products
 - **form** - Dynamic form creation and submission
 - **nfc** - Functions for nfc operations
@@ -65,6 +66,11 @@ Internal helper that performs a POST request to `${baseURL}${path}`, injecting h
   extraHeaders?: Record<string, string>) → `Promise<T>`
 Internal helper that performs a PUT request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. If body is FormData, Content-Type is not set. Returns the parsed JSON as T, or throws an Error.
 
+**patch**(path: string,
+  body: any,
+  extraHeaders?: Record<string, string>) → `Promise<T>`
+Internal helper that performs a PATCH request to `${baseURL}${path}`, injecting headers for apiKey or bearerToken if present. If body is FormData, Content-Type is not set. Returns the parsed JSON as T, or throws an Error.
+
 **requestWithOptions**(path: string,
   options: RequestInit) → `Promise<T>`
 Internal helper that performs a request to `${baseURL}${path}` with custom options, injecting headers for apiKey or bearerToken if present. Returns the parsed JSON as T, or throws an Error.
@@ -485,6 +491,66 @@ interface SendNotificationResponse {
 }
 ```
 
+### contact
+
+**ContactResponse** (interface)
+```typescript
+interface ContactResponse {
+  contactId: string
+  orgId: string
+  firstName: string | null
+  lastName: string | null
+  displayName: string | null
+  company: string | null
+  email: string | null
+  phone: string | null
+  emails?: string[]
+  phones?: string[]
+  customFields: ContactCustomFields
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  erasedAt: string | null
+}
+```
+
+**ContactCreateRequest** (interface)
+```typescript
+interface ContactCreateRequest {
+  firstName?: string | null
+  lastName?: string | null
+  displayName?: string | null
+  company?: string | null
+  email?: string | null
+  phone?: string | null
+  customFields?: ContactCustomFields
+}
+```
+
+**ContactUpdateRequest** (interface)
+```typescript
+interface ContactUpdateRequest {
+  firstName?: string | null
+  lastName?: string | null
+  displayName?: string | null
+  company?: string | null
+  email?: string | null
+  phone?: string | null
+  customFields?: ContactCustomFields
+}
+```
+
+**ContactListResponse** (interface)
+```typescript
+interface ContactListResponse {
+  items: ContactResponse[]
+  limit: number
+  offset: number
+}
+```
+
+**ContactCustomFields** = `Record<string, any>`
+
 ### error
 
 **ErrorResponse** (interface)
@@ -1089,6 +1155,31 @@ Assign a value to a serial number for a collection (admin only).
     request: SendNotificationRequest) → `Promise<SendNotificationResponse>`
 Send a notification to specified targets within a collection. Supports multiple delivery methods including push notifications, email, and wallet pass updates. The notification will be delivered based on user preferences and the specified delivery mode. ```typescript const result = await comms.sendNotification('my-collection', { subjectTargets: [{ type: 'product', id: 'prod_123' }], severity: 'important', mode: 'preferred', template: { push: { title: 'Update available', body: 'We\'ve shipped an important update.', icon: 'https://cdn.example.com/brand/logo-128.png' }, email: { subject: 'Important update for your product', body: 'There\'s an important update. Open your pass or profile to learn more.' }, walletUpdate: { textModulesData: [ { id: 'notice', header: 'Update', body: 'Open your wallet pass for details.' } ] } } }) if (result.ok) { console.log('Notification queued:', result.notificationId) console.log('Totals:', result.status.totals) } ```
 
+### contact
+
+**create**(collectionId: string, data: ContactCreateRequest) → `Promise<ContactResponse>`
+
+**list**(collectionId: string,
+    params?: { limit?: number; offset?: number; includeDeleted?: boolean }) → `Promise<ContactListResponse>`
+
+**get**(collectionId: string,
+    contactId: string,
+    params?: { includeDeleted?: boolean }) → `Promise<ContactResponse>`
+
+**update**(collectionId: string,
+    contactId: string,
+    data: ContactUpdateRequest) → `Promise<ContactResponse>`
+
+**remove**(collectionId: string, contactId: string) → `Promise<void>`
+
+**lookup**(collectionId: string,
+    params: { email?: string; phone?: string }) → `Promise<ContactResponse>`
+
+**upsert**(collectionId: string,
+    data: ContactCreateRequest) → `Promise<ContactResponse>`
+
+**erase**(collectionId: string, contactId: string, body?: any) → `Promise<ContactResponse>`
+
 ### crate
 
 **get**(collectionId: string, crateId: string) → `Promise<any>`

package/dist/api/contact.d.ts

@@ -0,0 +1,20 @@
+import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse } from "../types/contact";
+export declare namespace contact {
+    function create(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
+    function list(collectionId: string, params?: {
+        limit?: number;
+        offset?: number;
+        includeDeleted?: boolean;
+    }): Promise<ContactListResponse>;
+    function get(collectionId: string, contactId: string, params?: {
+        includeDeleted?: boolean;
+    }): Promise<ContactResponse>;
+    function update(collectionId: string, contactId: string, data: ContactUpdateRequest): Promise<ContactResponse>;
+    function remove(collectionId: string, contactId: string): Promise<void>;
+    function lookup(collectionId: string, params: {
+        email?: string;
+        phone?: string;
+    }): Promise<ContactResponse>;
+    function upsert(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
+    function erase(collectionId: string, contactId: string, body?: any): Promise<ContactResponse>;
+}

package/dist/api/contact.js

@@ -0,0 +1,61 @@
+import { request, post, del, patch } from "../http";
+export var contact;
+(function (contact) {
+    async function create(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts`;
+        return post(path, data);
+    }
+    contact.create = create;
+    async function list(collectionId, params) {
+        const query = new URLSearchParams();
+        if ((params === null || params === void 0 ? void 0 : params.limit) !== undefined)
+            query.set("limit", String(params.limit));
+        if ((params === null || params === void 0 ? void 0 : params.offset) !== undefined)
+            query.set("offset", String(params.offset));
+        if ((params === null || params === void 0 ? void 0 : params.includeDeleted) !== undefined)
+            query.set("includeDeleted", String(params.includeDeleted));
+        const qs = query.toString();
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts${qs ? `?${qs}` : ""}`;
+        return request(path);
+    }
+    contact.list = list;
+    async function get(collectionId, contactId, params) {
+        const query = new URLSearchParams();
+        if ((params === null || params === void 0 ? void 0 : params.includeDeleted) !== undefined)
+            query.set("includeDeleted", String(params.includeDeleted));
+        const qs = query.toString();
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}${qs ? `?${qs}` : ""}`;
+        return request(path);
+    }
+    contact.get = get;
+    async function update(collectionId, contactId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}`;
+        return patch(path, data);
+    }
+    contact.update = update;
+    async function remove(collectionId, contactId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}`;
+        return del(path);
+    }
+    contact.remove = remove;
+    async function lookup(collectionId, params) {
+        const query = new URLSearchParams();
+        if (params.email)
+            query.set("email", params.email);
+        if (params.phone)
+            query.set("phone", params.phone);
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/lookup?${query.toString()}`;
+        return request(path);
+    }
+    contact.lookup = lookup;
+    async function upsert(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts:upsert`;
+        return post(path, data);
+    }
+    contact.upsert = upsert;
+    async function erase(collectionId, contactId, body) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/crm/contacts/${encodeURIComponent(contactId)}/erase`;
+        return post(path, body || {});
+    }
+    contact.erase = erase;
+})(contact || (contact = {}));

package/dist/http.d.ts

@@ -43,6 +43,13 @@ export declare function post<T>(path: string, body: any, extraHeaders?: Record<s
  * Returns the parsed JSON as T, or throws an Error.
  */
 export declare function put<T>(path: string, body: any, extraHeaders?: Record<string, string>): Promise<T>;
+/**
+ * Internal helper that performs a PATCH request to `${baseURL}${path}`,
+ * injecting headers for apiKey or bearerToken if present.
+ * If body is FormData, Content-Type is not set.
+ * Returns the parsed JSON as T, or throws an Error.
+ */
+export declare function patch<T>(path: string, body: any, extraHeaders?: Record<string, string>): Promise<T>;
 /**
  * Internal helper that performs a request to `${baseURL}${path}` with custom options,
  * injecting headers for apiKey or bearerToken if present.

package/dist/http.js

@@ -292,6 +292,53 @@ export async function put(path, body, extraHeaders) {
     }
     return (await response.json());
 }
+/**
+ * Internal helper that performs a PATCH request to `${baseURL}${path}`,
+ * injecting headers for apiKey or bearerToken if present.
+ * If body is FormData, Content-Type is not set.
+ * Returns the parsed JSON as T, or throws an Error.
+ */
+export async function patch(path, body, extraHeaders) {
+    if (proxyMode) {
+        logDebug('[smartlinks] PATCH via proxy', { path, body: safeBodyPreview(body) });
+        return proxyRequest("PATCH", path, body, extraHeaders);
+    }
+    if (!baseURL) {
+        throw new Error("HTTP client is not initialized. Call initializeApi(...) first.");
+    }
+    const url = `${baseURL}${path}`;
+    const headers = extraHeaders ? Object.assign({}, extraHeaders) : {};
+    if (apiKey)
+        headers["X-API-Key"] = apiKey;
+    if (bearerToken)
+        headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
+    // Only set Content-Type for non-FormData bodies
+    if (!(body instanceof FormData)) {
+        headers["Content-Type"] = "application/json";
+    }
+    logDebug('[smartlinks] PATCH fetch', { url, headers: redactHeaders(headers), body: safeBodyPreview(body) });
+    const response = await fetch(url, {
+        method: "PATCH",
+        headers,
+        body: body instanceof FormData ? body : JSON.stringify(body),
+    });
+    logDebug('[smartlinks] PATCH response', { url, status: response.status, ok: response.ok });
+    if (!response.ok) {
+        try {
+            const errBody = (await response.json());
+            throw new Error(`Error ${errBody.code}: ${errBody.message}`);
+        }
+        catch (_a) {
+            throw new Error(`Request to ${url} failed with status ${response.status}`);
+        }
+    }
+    return (await response.json());
+}
 /**
  * Internal helper that performs a request to `${baseURL}${path}` with custom options,
  * injecting headers for apiKey or bearerToken if present.

package/dist/types/contact.d.ts

@@ -0,0 +1,41 @@
+export type ContactCustomFields = Record<string, any>;
+export interface ContactResponse {
+    contactId: string;
+    orgId: string;
+    firstName: string | null;
+    lastName: string | null;
+    displayName: string | null;
+    company: string | null;
+    email: string | null;
+    phone: string | null;
+    emails?: string[];
+    phones?: string[];
+    customFields: ContactCustomFields;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    erasedAt: string | null;
+}
+export interface ContactCreateRequest {
+    firstName?: string | null;
+    lastName?: string | null;
+    displayName?: string | null;
+    company?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    customFields?: ContactCustomFields;
+}
+export interface ContactUpdateRequest {
+    firstName?: string | null;
+    lastName?: string | null;
+    displayName?: string | null;
+    company?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    customFields?: ContactCustomFields;
+}
+export interface ContactListResponse {
+    items: ContactResponse[];
+    limit: number;
+    offset: number;
+}

package/dist/types/contact.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -10,3 +10,4 @@ export * from "./claimSet";
 export * from "./auth";
 export * from "./comms";
 export * from "./nfc";
+export * from "./contact";

package/dist/types/index.js

@@ -12,3 +12,4 @@ export * from "./claimSet";
 export * from "./auth";
 export * from "./comms";
 export * from "./nfc";
+export * from "./contact";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.0.61",
+  "version": "1.0.62",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",