@proveanything/smartlinks 1.0.41 → 1.0.43

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.41  |  Generated: 2025-11-16T09:32:15.868Z
+Version: 1.0.43  |  Generated: 2025-11-22T12:58:28.713Z
 
 This is a concise summary of all available API functions and types.
 
@@ -14,9 +14,11 @@ The Smartlinks SDK is organized into the following namespaces:
 - **asset** - File upload and asset management for collections, products, and proofs
 - **attestation** - Digital attestations and verification for products
 - **auth** - Authentication, login, and user account management
+- **authKit** - Functions for authKit operations
 - **batch** - Product batch management and tracking
 - **claimSet** - Claim creation, management, and verification
 - **collection** - Collection CRUD operations and management
+- **comms** - Functions for comms operations
 - **crate** - Container/crate management for organizing products
 - **form** - Dynamic form creation and submission
 - **product** - Product CRUD operations and management within collections
@@ -136,6 +138,119 @@ type UserAccountRegistrationRequest = {
 }
 ```
 
+### authKit
+
+**AuthKitUser** (interface)
+```typescript
+interface AuthKitUser {
+  uid: string
+  email?: string
+  displayName?: string | null
+  photoURL?: string | null
+  phoneNumber?: string | null
+  emailVerified?: boolean
+  accountData?: Record<string, any>
+}
+```
+
+**AuthLoginResponse** (interface)
+```typescript
+interface AuthLoginResponse {
+  token: string
+  user: AuthKitUser
+  accountData?: Record<string, any>
+}
+```
+
+**PhoneSendCodeResponse** (interface)
+```typescript
+interface PhoneSendCodeResponse {
+  verificationId: string
+  message: string
+}
+```
+
+**PhoneVerifyResponse** (interface)
+```typescript
+interface PhoneVerifyResponse {
+  token: string
+  user: AuthKitUser
+}
+```
+
+**PasswordResetRequestResponse** (interface)
+```typescript
+interface PasswordResetRequestResponse {
+  success: boolean
+  message: string
+}
+```
+
+**VerifyResetTokenResponse** (interface)
+```typescript
+interface VerifyResetTokenResponse {
+  valid: boolean
+  email?: string
+  expiresAt?: number
+  message?: string
+}
+```
+
+**PasswordResetCompleteResponse** (interface)
+```typescript
+interface PasswordResetCompleteResponse {
+  success: boolean
+  message: string
+}
+```
+
+**EmailVerificationActionResponse** (interface)
+```typescript
+interface EmailVerificationActionResponse {
+  success: boolean
+  message: string
+}
+```
+
+**EmailVerifyTokenResponse** (interface)
+```typescript
+interface EmailVerifyTokenResponse {
+  success: boolean
+  message: string
+  token?: string
+  user?: AuthKitUser
+}
+```
+
+**AuthKitBrandingConfig** (interface)
+```typescript
+interface AuthKitBrandingConfig {
+  logoUrl?: string
+  title?: string
+  subtitle?: string
+  primaryColor?: string
+  secondaryColor?: string
+  backgroundColor?: string
+  buttonStyle?: string
+  fontFamily?: string
+}
+```
+
+**AuthKitConfig** (interface)
+```typescript
+interface AuthKitConfig {
+  clientId: string
+  branding?: AuthKitBrandingConfig
+  enabledProviders?: string[]
+  customCss?: string
+  termsUrl?: string
+  privacyUrl?: string
+  supportEmail?: string
+  redirectUrl?: string
+  updatedAt?: string
+}
+```
+
 ### batch
 
 **BatchResponse** = `any`
@@ -221,6 +336,92 @@ interface CollectionResponse {
 }
 ```
 
+### comms
+
+**NotificationSubjectTarget** (interface)
+```typescript
+interface NotificationSubjectTarget {
+  type: 'product' | 'collection' | 'user' | 'batch' | 'proof'
+  id: string
+}
+```
+
+**PushNotificationTemplate** (interface)
+```typescript
+interface PushNotificationTemplate {
+  title: string
+  body: string
+  icon?: string
+}
+```
+
+**EmailNotificationTemplate** (interface)
+```typescript
+interface EmailNotificationTemplate {
+  subject: string
+  body: string
+}
+```
+
+**WalletUpdateTemplate** (interface)
+```typescript
+interface WalletUpdateTemplate {
+  textModulesData?: Array<{
+  id: string
+  header: string
+  body: string
+  }>
+}
+```
+
+**NotificationTemplate** (interface)
+```typescript
+interface NotificationTemplate {
+  push?: PushNotificationTemplate
+  email?: EmailNotificationTemplate
+  walletUpdate?: WalletUpdateTemplate
+}
+```
+
+**SendNotificationRequest** (interface)
+```typescript
+interface SendNotificationRequest {
+  subjectTargets: NotificationSubjectTarget[]
+  severity: 'low' | 'normal' | 'important' | 'critical'
+  mode: 'preferred' | 'all'
+  channels : ("push" | "email" | "wallet")[]
+  template: NotificationTemplate
+}
+```
+
+**SendNotificationResponse** (interface)
+```typescript
+interface SendNotificationResponse {
+  ok: boolean
+  notificationId: string
+  counts: {
+  contacts: number
+  attempts: number
+  }
+  status: {
+  notification: {
+  notificationId: string
+  state: 'queued' | 'sent' | 'failed' | 'confirmed' | string
+  subjectTargets: NotificationSubjectTarget[]
+  severity: 'low' | 'normal' | 'important' | 'critical' | string
+  channelsOverride: Record<string, any>
+  template: NotificationTemplate
+  }
+  totals: {
+  queued: number
+  sent: number
+  failed: number
+  confirmed: number
+  }
+  }
+}
+```
+
 ### error
 
 **ErrorResponse** (interface)
@@ -558,6 +759,59 @@ Admin: Get a user bearer token (impersonation/automation). POST /admin/auth/user
 **getAccount**() → `Promise<AccountInfoResponse>`
 Gets current account information for the logged in user. Returns user, owner, account, and location objects.
 
+### authKit
+
+**login**(clientId: string, email: string, password: string) → `Promise<AuthLoginResponse>`
+Login with email + password (public).
+
+**register**(clientId: string, data: { email: string; password: string; displayName?: string; accountData?: Record<string, any> }) → `Promise<AuthLoginResponse>`
+Register a new user (public).
+
+**googleLogin**(clientId: string, idToken: string) → `Promise<AuthLoginResponse>`
+Google OAuth login (public).
+
+**sendPhoneCode**(clientId: string, phoneNumber: string) → `Promise<PhoneSendCodeResponse>`
+Send phone verification code (public).
+
+**verifyPhoneCode**(clientId: string, verificationId: string, code: string) → `Promise<PhoneVerifyResponse>`
+Verify phone verification code (public).
+
+**requestPasswordReset**(clientId: string, data: { email: string; redirectUrl?: string; clientName?: string }) → `Promise<PasswordResetRequestResponse>`
+Verify phone verification code (public).
+
+**verifyResetToken**(clientId: string, token: string) → `Promise<VerifyResetTokenResponse>`
+Verify phone verification code (public).
+
+**completePasswordReset**(clientId: string, token: string, newPassword: string) → `Promise<PasswordResetCompleteResponse>`
+Verify phone verification code (public).
+
+**sendEmailVerification**(clientId: string, data: { userId: string; email: string; redirectUrl?: string; clientName?: string }) → `Promise<EmailVerificationActionResponse>`
+Verify phone verification code (public).
+
+**verifyEmail**(clientId: string, token: string) → `Promise<EmailVerifyTokenResponse>`
+Verify phone verification code (public).
+
+**resendEmailVerification**(clientId: string, data: { userId: string; email: string; redirectUrl?: string; clientName?: string }) → `Promise<EmailVerificationActionResponse>`
+Verify phone verification code (public).
+
+**load**(authKitId: string) → `Promise<AuthKitConfig>`
+Verify phone verification code (public).
+
+**get**(collectionId: string, authKitId: string) → `Promise<AuthKitConfig>`
+Verify phone verification code (public).
+
+**list**(collectionId: string, admin?: boolean) → `Promise<AuthKitConfig[]>`
+Verify phone verification code (public).
+
+**create**(collectionId: string, data: any) → `Promise<AuthKitConfig>`
+Verify phone verification code (public).
+
+**update**(collectionId: string, authKitId: string, data: any) → `Promise<AuthKitConfig>`
+Verify phone verification code (public).
+
+**remove**(collectionId: string, authKitId: string) → `Promise<void>`
+Verify phone verification code (public).
+
 ### batch
 
 **get**(collectionId: string,
@@ -678,6 +932,12 @@ Look up a serial number by code for a collection (admin only).
     value: any) → `Promise<any>`
 Assign a value to a serial number for a collection (admin only).
 
+### comms
+
+**sendNotification**(collectionId: string,
+    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) } ```
+
 ### crate
 
 **get**(collectionId: string, crateId: string) → `Promise<any>`

package/dist/api/authKit.d.ts

@@ -0,0 +1,48 @@
+import type { AuthLoginResponse, PhoneSendCodeResponse, PhoneVerifyResponse, PasswordResetRequestResponse, VerifyResetTokenResponse, PasswordResetCompleteResponse, EmailVerificationActionResponse, EmailVerifyTokenResponse, AuthKitConfig } from "../types/authKit";
+/**
+ * Namespace containing helper functions for the new AuthKit API.
+ * Legacy collection-based authKit helpers retained (marked as *Legacy*).
+ */
+export declare namespace authKit {
+    /** Login with email + password (public). */
+    function login(clientId: string, email: string, password: string): Promise<AuthLoginResponse>;
+    /** Register a new user (public). */
+    function register(clientId: string, data: {
+        email: string;
+        password: string;
+        displayName?: string;
+        accountData?: Record<string, any>;
+    }): Promise<AuthLoginResponse>;
+    /** Google OAuth login (public). */
+    function googleLogin(clientId: string, idToken: string): Promise<AuthLoginResponse>;
+    /** Send phone verification code (public). */
+    function sendPhoneCode(clientId: string, phoneNumber: string): Promise<PhoneSendCodeResponse>;
+    /** Verify phone verification code (public). */
+    function verifyPhoneCode(clientId: string, verificationId: string, code: string): Promise<PhoneVerifyResponse>;
+    function requestPasswordReset(clientId: string, data: {
+        email: string;
+        redirectUrl?: string;
+        clientName?: string;
+    }): Promise<PasswordResetRequestResponse>;
+    function verifyResetToken(clientId: string, token: string): Promise<VerifyResetTokenResponse>;
+    function completePasswordReset(clientId: string, token: string, newPassword: string): Promise<PasswordResetCompleteResponse>;
+    function sendEmailVerification(clientId: string, data: {
+        userId: string;
+        email: string;
+        redirectUrl?: string;
+        clientName?: string;
+    }): Promise<EmailVerificationActionResponse>;
+    function verifyEmail(clientId: string, token: string): Promise<EmailVerifyTokenResponse>;
+    function resendEmailVerification(clientId: string, data: {
+        userId: string;
+        email: string;
+        redirectUrl?: string;
+        clientName?: string;
+    }): Promise<EmailVerificationActionResponse>;
+    function load(authKitId: string): Promise<AuthKitConfig>;
+    function get(collectionId: string, authKitId: string): Promise<AuthKitConfig>;
+    function list(collectionId: string, admin?: boolean): Promise<AuthKitConfig[]>;
+    function create(collectionId: string, data: any): Promise<AuthKitConfig>;
+    function update(collectionId: string, authKitId: string, data: any): Promise<AuthKitConfig>;
+    function remove(collectionId: string, authKitId: string): Promise<void>;
+}

package/dist/api/authKit.js

@@ -0,0 +1,100 @@
+import { request, post, put, del } from "../http";
+/**
+ * Namespace containing helper functions for the new AuthKit API.
+ * Legacy collection-based authKit helpers retained (marked as *Legacy*).
+ */
+export var authKit;
+(function (authKit) {
+    /* ===================================
+     * Authentication (Per client)
+     * =================================== */
+    /** Login with email + password (public). */
+    async function login(clientId, email, password) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/login`, { email, password });
+    }
+    authKit.login = login;
+    /** Register a new user (public). */
+    async function register(clientId, data) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/register`, data);
+    }
+    authKit.register = register;
+    /** Google OAuth login (public). */
+    async function googleLogin(clientId, idToken) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/google`, { idToken });
+    }
+    authKit.googleLogin = googleLogin;
+    /** Send phone verification code (public). */
+    async function sendPhoneCode(clientId, phoneNumber) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/phone/send-code`, { phoneNumber });
+    }
+    authKit.sendPhoneCode = sendPhoneCode;
+    /** Verify phone verification code (public). */
+    async function verifyPhoneCode(clientId, verificationId, code) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/phone/verify`, { verificationId, code });
+    }
+    authKit.verifyPhoneCode = verifyPhoneCode;
+    /* ===================================
+     * Password Reset (Public flows)
+     * =================================== */
+    async function requestPasswordReset(clientId, data) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/reset-password`, data);
+    }
+    authKit.requestPasswordReset = requestPasswordReset;
+    async function verifyResetToken(clientId, token) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/verify-reset-token`, { token });
+    }
+    authKit.verifyResetToken = verifyResetToken;
+    async function completePasswordReset(clientId, token, newPassword) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/complete-reset`, { token, newPassword });
+    }
+    authKit.completePasswordReset = completePasswordReset;
+    /* ===================================
+     * Email Verification
+     * =================================== */
+    async function sendEmailVerification(clientId, data) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/send-verification`, data);
+    }
+    authKit.sendEmailVerification = sendEmailVerification;
+    async function verifyEmail(clientId, token) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/verify-email`, { token });
+    }
+    authKit.verifyEmail = verifyEmail;
+    async function resendEmailVerification(clientId, data) {
+        return post(`/authkit/${encodeURIComponent(clientId)}/auth/resend-verification`, data);
+    }
+    authKit.resendEmailVerification = resendEmailVerification;
+    /* ===================================
+     * Collection-based AuthKit
+     * =================================== */
+    async function load(authKitId) {
+        const path = `authKit/${encodeURIComponent(authKitId)}`;
+        return request(path);
+    }
+    authKit.load = load;
+    async function get(collectionId, authKitId) {
+        const path = `admin/collection/${encodeURIComponent(collectionId)}/authKit/${encodeURIComponent(authKitId)}`;
+        return request(path);
+    }
+    authKit.get = get;
+    async function list(collectionId, admin) {
+        const base = admin ? "/admin" : "/public";
+        const path = `${base}/collection/${encodeURIComponent(collectionId)}/authKit`;
+        return request(path);
+    }
+    authKit.list = list;
+    async function create(collectionId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/authKit`;
+        return post(path, data);
+    }
+    authKit.create = create;
+    async function update(collectionId, authKitId, data) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/authKit/${encodeURIComponent(authKitId)}`;
+        return put(path, data);
+    }
+    authKit.update = update;
+    async function remove(collectionId, authKitId) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/authKit/${encodeURIComponent(authKitId)}`;
+        return del(path);
+    }
+    authKit.remove = remove;
+})(authKit || (authKit = {}));

package/dist/api/comms.d.ts

@@ -0,0 +1,47 @@
+import type { SendNotificationRequest, SendNotificationResponse } from "../types/comms";
+/**
+ * Communications namespace for sending notifications and managing user communications
+ */
+export declare namespace comms {
+    /**
+     * 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.
+     *
+     * @param collectionId - ID of the collection containing the notification targets
+     * @param request - Notification configuration including targets, severity, and content templates
+    * @returns Promise resolving to the notification enqueue/queue status and totals
+     * @throws ErrorResponse if the request fails or targets are invalid
+     *
+     * @example
+     * ```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)
+     * }
+     * ```
+     */
+    function sendNotification(collectionId: string, request: SendNotificationRequest): Promise<SendNotificationResponse>;
+}

package/dist/api/comms.js

@@ -0,0 +1,54 @@
+// src/api/comms.ts
+// Communications and notifications API for Smartlinks
+import { post } from "../http";
+/**
+ * Communications namespace for sending notifications and managing user communications
+ */
+export var comms;
+(function (comms) {
+    /**
+     * 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.
+     *
+     * @param collectionId - ID of the collection containing the notification targets
+     * @param request - Notification configuration including targets, severity, and content templates
+    * @returns Promise resolving to the notification enqueue/queue status and totals
+     * @throws ErrorResponse if the request fails or targets are invalid
+     *
+     * @example
+     * ```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)
+     * }
+     * ```
+     */
+    async function sendNotification(collectionId, request) {
+        const path = `/admin/collection/${encodeURIComponent(collectionId)}/comm/notify`;
+        return post(path, request);
+    }
+    comms.sendNotification = sendNotification;
+})(comms || (comms = {}));

package/dist/api/index.d.ts

@@ -7,9 +7,11 @@ export { asset } from "./asset";
 export { attestation } from "./attestation";
 export { auth } from "./auth";
 export { form } from "./form";
+export { authKit } from "./authKit";
 export { claimSet } from "./claimSet";
 export { crate } from "./crate";
 export { batch } from "./batch";
 export { variant } from "./variant";
 export { ai } from "./ai";
+export { comms } from "./comms";
 export type { AIGenerateContentRequest, AIGenerateImageRequest, AISearchPhotosRequest, AISearchPhotosPhoto } from "./ai";

package/dist/api/index.js

@@ -9,8 +9,10 @@ export { asset } from "./asset";
 export { attestation } from "./attestation";
 export { auth } from "./auth";
 export { form } from "./form";
+export { authKit } from "./authKit";
 export { claimSet } from "./claimSet";
 export { crate } from "./crate";
 export { batch } from "./batch";
 export { variant } from "./variant";
 export { ai } from "./ai";
+export { comms } from "./comms";

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from "./api";
 export * from "./types";
 export type { LoginResponse, VerifyTokenResponse, AccountInfoResponse, } from "./api/auth";
 export type { UserAccountRegistrationRequest, } from "./types/auth";
+export type { SendNotificationRequest, SendNotificationResponse, NotificationSubjectTarget, NotificationTemplate, PushNotificationTemplate, EmailNotificationTemplate, WalletUpdateTemplate, } from "./types/comms";
 export type { AttestationResponse, AttestationCreateRequest, AttestationUpdateRequest, } from "./types/attestation";
 export type { BatchResponse, BatchCreateRequest, BatchUpdateRequest, } from "./types/batch";
 export type { VariantResponse, VariantCreateRequest, VariantUpdateRequest, } from "./types/variant";

package/dist/types/authKit.d.ts

@@ -0,0 +1,67 @@
+export interface AuthKitUser {
+    uid: string;
+    email?: string;
+    displayName?: string | null;
+    photoURL?: string | null;
+    phoneNumber?: string | null;
+    emailVerified?: boolean;
+    accountData?: Record<string, any>;
+}
+export interface AuthLoginResponse {
+    token: string;
+    user: AuthKitUser;
+    accountData?: Record<string, any>;
+}
+export interface PhoneSendCodeResponse {
+    verificationId: string;
+    message: string;
+}
+export interface PhoneVerifyResponse {
+    token: string;
+    user: AuthKitUser;
+}
+export interface PasswordResetRequestResponse {
+    success: boolean;
+    message: string;
+}
+export interface VerifyResetTokenResponse {
+    valid: boolean;
+    email?: string;
+    expiresAt?: number;
+    message?: string;
+}
+export interface PasswordResetCompleteResponse {
+    success: boolean;
+    message: string;
+}
+export interface EmailVerificationActionResponse {
+    success: boolean;
+    message: string;
+}
+export interface EmailVerifyTokenResponse {
+    success: boolean;
+    message: string;
+    token?: string;
+    user?: AuthKitUser;
+}
+export interface AuthKitBrandingConfig {
+    logoUrl?: string;
+    title?: string;
+    subtitle?: string;
+    primaryColor?: string;
+    secondaryColor?: string;
+    backgroundColor?: string;
+    buttonStyle?: string;
+    fontFamily?: string;
+}
+export interface AuthKitConfig {
+    clientId: string;
+    branding?: AuthKitBrandingConfig;
+    enabledProviders?: string[];
+    customCss?: string;
+    termsUrl?: string;
+    privacyUrl?: string;
+    supportEmail?: string;
+    redirectUrl?: string;
+    updatedAt?: string;
+}

package/dist/types/authKit.js

@@ -0,0 +1,2 @@
+// Types for the AuthKit API
+export {};

package/dist/types/comms.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Target subject for notifications (product, collection, etc.)
+ */
+export interface NotificationSubjectTarget {
+    /** Type of target entity */
+    type: 'product' | 'collection' | 'user' | 'batch' | 'proof';
+    /** ID of the target entity */
+    id: string;
+}
+/**
+ * Push notification template content
+ */
+export interface PushNotificationTemplate {
+    /** Notification title */
+    title: string;
+    /** Notification body text */
+    body: string;
+    /** Optional icon URL for the notification */
+    icon?: string;
+}
+/**
+ * Email notification template content
+ */
+export interface EmailNotificationTemplate {
+    /** Email subject line */
+    subject: string;
+    /** Email body content (plain text or HTML) */
+    body: string;
+}
+/**
+ * Wallet pass update template content
+ */
+export interface WalletUpdateTemplate {
+    /** Text modules to update in the wallet pass */
+    textModulesData?: Array<{
+        /** Module ID */
+        id: string;
+        /** Module header text */
+        header: string;
+        /** Module body text */
+        body: string;
+    }>;
+}
+/**
+ * Notification template containing different delivery methods
+ */
+export interface NotificationTemplate {
+    /** Push notification content */
+    push?: PushNotificationTemplate;
+    /** Email notification content */
+    email?: EmailNotificationTemplate;
+    /** Wallet pass update content */
+    walletUpdate?: WalletUpdateTemplate;
+}
+/**
+ * Request payload for sending notifications
+ */
+export interface SendNotificationRequest {
+    /** Target subjects that should receive the notification */
+    subjectTargets: NotificationSubjectTarget[];
+    /** Severity level of the notification */
+    severity: 'low' | 'normal' | 'important' | 'critical';
+    /** Delivery chanell mode preference */
+    mode: 'preferred' | 'all';
+    /** Specific channels to use for delivery */
+    channels: ("push" | "email" | "wallet")[];
+    /** Notification content templates for different delivery methods */
+    template: NotificationTemplate;
+}
+/**
+ * Response from sending notifications
+ */
+export interface SendNotificationResponse {
+    /** Whether the request was accepted */
+    ok: boolean;
+    /** Unique ID for this notification */
+    notificationId: string;
+    /** Basic counts for contacts and attempts */
+    counts: {
+        contacts: number;
+        attempts: number;
+    };
+    /** Detailed status for the notification */
+    status: {
+        notification: {
+            /** The notification ID (repeated for convenience) */
+            notificationId: string;
+            /** Current processing state */
+            state: 'queued' | 'sent' | 'failed' | 'confirmed' | string;
+            /** Targets this notification refers to */
+            subjectTargets: NotificationSubjectTarget[];
+            /** Severity of this notification */
+            severity: 'low' | 'normal' | 'important' | 'critical' | string;
+            /** Optional channel overrides used when sending */
+            channelsOverride: Record<string, any>;
+            /** The effective template used */
+            template: NotificationTemplate;
+        };
+        /** Totals across all contacts */
+        totals: {
+            queued: number;
+            sent: number;
+            failed: number;
+            confirmed: number;
+        };
+    };
+}

package/dist/types/comms.js

@@ -0,0 +1,3 @@
+// src/types/comms.ts
+// Communication and notification types for the Smartlinks API
+export {};

package/dist/types/index.d.ts

@@ -8,3 +8,4 @@ export * from "./batch";
 export * from "./variant";
 export * from "./claimSet";
 export * from "./auth";
+export * from "./comms";

package/dist/types/index.js

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

package/package.json

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