@proveanything/smartlinks 1.1.6 → 1.1.9

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.1.6  |  Generated: 2025-12-23T16:56:04.230Z
+Version: 1.1.9  |  Generated: 2025-12-24T13:18:43.320Z
 
 This is a concise summary of all available API functions and types.
 
@@ -47,6 +47,7 @@ The Smartlinks SDK is organized into the following namespaces:
 
 — Other —
 - **attestation** - Functions for attestation operations
+- **template** - Functions for template operations
 
 ## HTTP Utilities
 
@@ -230,7 +231,7 @@ interface ActionPermissions {
 **ActionRecord** (interface)
 ```typescript
 interface ActionRecord {
-  id: string
+  id?: string
   collectionId: string
   appId: string
   permissions?: ActionPermissions
@@ -921,6 +922,35 @@ interface ContactListResponse {
 }
 ```
 
+**PublicContactUpsertRequest** (interface)
+```typescript
+interface PublicContactUpsertRequest {
+  email?: string
+  phone?: string
+  userId?: string
+  firstName?: string
+  lastName?: string
+  displayName?: string
+  company?: string
+  tags?: string[]
+  source?: string
+  notes?: string
+  avatarUrl?: string
+  locale?: string
+  timezone?: string
+  externalIds?: Record<string, any>
+  customFields?: ContactCustomFields
+}
+```
+
+**PublicContactUpsertResponse** (interface)
+```typescript
+interface PublicContactUpsertResponse {
+  ok: boolean
+  contactId: string
+}
+```
+
 **ContactCustomFields** = `Record<string, any>`
 
 ### error
@@ -1204,6 +1234,39 @@ interface SegmentRecipientsResponse {
 }
 ```
 
+### template
+
+**TemplateBase** (interface)
+```typescript
+interface TemplateBase {
+  id: string
+  collectionId: string
+  name: string
+  description?: string
+  type: string
+  resizeMode?: string
+  pdf?: {
+  base: { url: string }
+  orientation: 'portrait' | 'landscape'
+  }
+  subject?: string
+  body?: string
+  css?: string
+  public?: boolean
+  engine?: string
+  component?: string
+  defaultProps?: Record<string, any>
+  collections?: string[]
+  [k: string]: any
+}
+```
+
+**TemplateInput** = `Omit<TemplateBase, 'id' | 'collectionId'>`
+
+**TemplateUpdate** = `Partial<Omit<TemplateBase, 'id' | 'collectionId'>>`
+
+**TemplatePublic** = `TemplateBase`
+
 ### variant
 
 **VariantResponse** = `any`
@@ -1807,6 +1870,9 @@ Logging: Append many communication events for a list of IDs. POST /admin/collect
 **upsert**(collectionId: string,
     data: ContactCreateRequest) → `Promise<ContactResponse>`
 
+**publicUpsert**(collectionId: string,
+    data: PublicContactUpsertRequest) → `Promise<PublicContactUpsertResponse>`
+
 **erase**(collectionId: string, contactId: string, body?: any) → `Promise<ContactResponse>`
 
 ### crate
@@ -1990,6 +2056,32 @@ Resolve a short code to related resource identifiers.
     id: string,
     query: { limit?: number; offset?: number } = {}) → `Promise<SegmentRecipientsResponse>`
 
+### template
+
+**getAll**(collectionId: string) → `Promise<Template[]>`
+
+**get**(collectionId: string, templateId: string) → `Promise<Template>`
+
+**create**(collectionId: string, data: TemplateInput) → `Promise<Template>`
+
+**update**(collectionId: string,
+    templateId: string,
+    data: TemplateUpdate) → `Promise<Template>`
+
+**del**(collectionId: string, templateId: string) → `Promise<Template>`
+
+**uploadAsset**(collectionId: string,
+    templateId: string,
+    file: File | Blob) → `Promise<`
+
+**getAllowed**(collectionId: string) → `Promise<TemplatePublic[]>`
+
+**getPublic**(collectionId: string, templateId: string) → `Promise<TemplatePublic>`
+
+**getGlobal**(templateId: string) → `Promise<TemplatePublic>`
+
+**getAllowedGlobal**(collectionId: string) → `Promise<TemplatePublic[]>`
+
 ### variant
 
 **get**(collectionId: string,

package/dist/api/contact.d.ts

@@ -1,4 +1,4 @@
-import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse } from "../types";
+import { ContactResponse, ContactCreateRequest, ContactUpdateRequest, ContactListResponse, PublicContactUpsertRequest, PublicContactUpsertResponse } from "../types";
 export declare namespace contact {
     function create(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
     function list(collectionId: string, params?: {
@@ -16,5 +16,6 @@ export declare namespace contact {
         phone?: string;
     }): Promise<ContactResponse>;
     function upsert(collectionId: string, data: ContactCreateRequest): Promise<ContactResponse>;
+    function publicUpsert(collectionId: string, data: PublicContactUpsertRequest): Promise<PublicContactUpsertResponse>;
     function erase(collectionId: string, contactId: string, body?: any): Promise<ContactResponse>;
 }

package/dist/api/contact.js

@@ -53,6 +53,12 @@ export var contact;
         return post(path, data);
     }
     contact.upsert = upsert;
+    // Public contact upsert (privacy-safe): returns only ok + contactId
+    async function publicUpsert(collectionId, data) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/contact`;
+        return post(path, data);
+    }
+    contact.publicUpsert = publicUpsert;
     async function erase(collectionId, contactId, body) {
         const path = `/admin/collection/${encodeURIComponent(collectionId)}/contacts/${encodeURIComponent(contactId)}/erase`;
         return post(path, body || {});

package/dist/api/index.d.ts

@@ -21,4 +21,5 @@ export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
 export { qr } from "./qr";
+export { template } from "./template";
 export type { AIGenerateContentRequest, AIGenerateImageRequest, AISearchPhotosRequest, AISearchPhotosPhoto } from "./ai";

package/dist/api/index.js

@@ -23,3 +23,4 @@ export { broadcasts } from "./broadcasts";
 export { segments } from "./segments";
 export { journeys } from "./journeys";
 export { qr } from "./qr";
+export { template } from "./template";

package/dist/api/template.d.ts

@@ -0,0 +1,15 @@
+import type { Template, TemplateInput, TemplateUpdate, TemplatePublic } from "../types";
+export declare namespace template {
+    function getAll(collectionId: string): Promise<Template[]>;
+    function get(collectionId: string, templateId: string): Promise<Template>;
+    function create(collectionId: string, data: TemplateInput): Promise<Template>;
+    function update(collectionId: string, templateId: string, data: TemplateUpdate): Promise<Template>;
+    function del(collectionId: string, templateId: string): Promise<Template>;
+    function uploadAsset(collectionId: string, templateId: string, file: File | Blob): Promise<{
+        url: string;
+    }>;
+    function getAllowed(collectionId: string): Promise<TemplatePublic[]>;
+    function getPublic(collectionId: string, templateId: string): Promise<TemplatePublic>;
+    function getGlobal(templateId: string): Promise<TemplatePublic>;
+    function getAllowedGlobal(collectionId: string): Promise<TemplatePublic[]>;
+}

package/dist/api/template.js

@@ -0,0 +1,59 @@
+import { request, post, put, del as httpDel } from "../http";
+export var template;
+(function (template) {
+    // Admin APIs
+    async function getAll(collectionId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template`;
+        return request(path);
+    }
+    template.getAll = getAll;
+    async function get(collectionId, templateId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template/${encodeURIComponent(templateId)}`;
+        return request(path);
+    }
+    template.get = get;
+    async function create(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template`;
+        return post(path, data);
+    }
+    template.create = create;
+    async function update(collectionId, templateId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template/${encodeURIComponent(templateId)}`;
+        return put(path, data);
+    }
+    template.update = update;
+    // Delete returns the (soft-deleted) Template per spec
+    async function del(collectionId, templateId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template/${encodeURIComponent(templateId)}`;
+        return httpDel(path);
+    }
+    template.del = del;
+    async function uploadAsset(collectionId, templateId, file) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/template/${encodeURIComponent(templateId)}/addFile`;
+        const form = new FormData();
+        form.append("file", file);
+        return post(path, form);
+    }
+    template.uploadAsset = uploadAsset;
+    // Public APIs
+    async function getAllowed(collectionId) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/template/getAllowed`;
+        return request(path);
+    }
+    template.getAllowed = getAllowed;
+    async function getPublic(collectionId, templateId) {
+        const path = `/public/collection/${encodeURIComponent(collectionId)}/template/${encodeURIComponent(templateId)}`;
+        return request(path);
+    }
+    template.getPublic = getPublic;
+    async function getGlobal(templateId) {
+        const path = `/public/template/${encodeURIComponent(templateId)}`;
+        return request(path);
+    }
+    template.getGlobal = getGlobal;
+    async function getAllowedGlobal(collectionId) {
+        const path = `/public/template/getAllowed/${encodeURIComponent(collectionId)}`;
+        return request(path);
+    }
+    template.getAllowedGlobal = getAllowedGlobal;
+})(template || (template = {}));

package/dist/types/actions.d.ts

@@ -81,7 +81,7 @@ export interface ActionPermissions {
     allowAuthenticatedSummary?: boolean;
 }
 export interface ActionRecord {
-    id: string;
+    id?: string;
     collectionId: string;
     appId: string;
     permissions?: ActionPermissions;

package/dist/types/contact.d.ts

@@ -39,3 +39,24 @@ export interface ContactListResponse {
     limit: number;
     offset: number;
 }
+export interface PublicContactUpsertRequest {
+    email?: string;
+    phone?: string;
+    userId?: string;
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    company?: string;
+    tags?: string[];
+    source?: string;
+    notes?: string;
+    avatarUrl?: string;
+    locale?: string;
+    timezone?: string;
+    externalIds?: Record<string, any>;
+    customFields?: ContactCustomFields;
+}
+export interface PublicContactUpsertResponse {
+    ok: boolean;
+    contactId: string;
+}

package/dist/types/index.d.ts

@@ -17,3 +17,4 @@ export * from "./segments";
 export * from "./common";
 export * from "./journeys";
 export * from "./qr";
+export * from "./template";

package/dist/types/index.js

@@ -19,3 +19,4 @@ export * from "./segments";
 export * from "./common";
 export * from "./journeys";
 export * from "./qr";
+export * from "./template";

package/dist/types/template.d.ts

@@ -0,0 +1,30 @@
+export interface TemplateBase {
+    id: string;
+    collectionId: string;
+    name: string;
+    description?: string;
+    type: string;
+    resizeMode?: string;
+    pdf?: {
+        base: {
+            url: string;
+        };
+        orientation: 'portrait' | 'landscape';
+    };
+    subject?: string;
+    body?: string;
+    css?: string;
+    public?: boolean;
+    engine?: string;
+    component?: string;
+    defaultProps?: Record<string, any>;
+    collections?: string[];
+    [k: string]: any;
+}
+export interface Template extends TemplateBase {
+    deleted?: boolean;
+    deletedAt?: string;
+}
+export type TemplateInput = Omit<TemplateBase, 'id' | 'collectionId'>;
+export type TemplateUpdate = Partial<Omit<TemplateBase, 'id' | 'collectionId'>>;
+export type TemplatePublic = TemplateBase;

package/dist/types/template.js

@@ -0,0 +1,2 @@
+// src/types/template.ts
+export {};

package/package.json

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