@hipnation-truth/sdk 0.1.6 → 0.2.0

package/dist/index.d.mts

@@ -127,6 +127,70 @@ declare class AppointmentResource {
     list(options?: AppointmentListOptions): Promise<PaginatedResult<Appointment>>;
 }
 
+/**
+ * AttachmentsResource — presigned S3 upload/download + Convex metadata.
+ *
+ * Replaces CommHub's base64-in-Postgres attachment flow:
+ *   1. client.attachments.createUploadUrl(...) → presigned PUT URL
+ *   2. Client PUTs bytes directly to S3
+ *   3. client.attachments.record(...) → writes Convex metadata
+ *   4. client.attachments.getDownloadUrl(s3Key) → presigned GET URL
+ */
+
+interface CreateUploadUrlInput {
+    fileName: string;
+    mimeType: string;
+    size: number;
+    conversationId?: string;
+}
+interface CreateUploadUrlResult {
+    uploadUrl: string;
+    s3Key: string;
+    expiresIn: number;
+    applicationId: string | null;
+}
+interface GetDownloadUrlResult {
+    url: string;
+    expiresIn: number;
+}
+interface RecordAttachmentInput {
+    s3Key: string;
+    fileName: string;
+    mimeType: string;
+    size: number;
+    conversationId?: string;
+    uploadedBy: string;
+}
+interface Attachment {
+    _id: string;
+    s3Key: string;
+    fileName: string;
+    mimeType: string;
+    size: number;
+    conversationId?: string;
+    uploadedBy: string;
+    createdAt: string;
+}
+declare class AttachmentsError extends Error {
+    readonly status: number;
+    constructor(operation: string, status: number, message?: string);
+}
+declare class AttachmentsResource {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly convex;
+    constructor(apiBaseUrl: string, apiKey: string, convexClient: ConvexHttpClient);
+    private post;
+    createUploadUrl(input: CreateUploadUrlInput): Promise<CreateUploadUrlResult>;
+    getDownloadUrl(s3Key: string, expiresIn?: number): Promise<GetDownloadUrlResult>;
+    record(input: RecordAttachmentInput): Promise<{
+        attachmentId: string;
+        s3Key: string;
+    }>;
+    get(attachmentId: string): Promise<Attachment | null>;
+    listByConversation(conversationId: string): Promise<Attachment[]>;
+}
+
 /**
  * Dialpad resource — typed access to Truth's Dialpad proxy endpoints.
  *
@@ -142,7 +206,7 @@ interface SendSmsParams {
     from_number: string;
     to_number: string;
     message?: string;
-    media?: string;
+    media?: string | string[];
 }
 interface SendSmsResponse {
     id: string;
@@ -176,7 +240,8 @@ interface VoicemailAuthResponse {
 }
 declare class DialpadResource {
     private readonly baseUrl;
-    constructor(apiBaseUrl: string);
+    private readonly apiKey;
+    constructor(apiBaseUrl: string, apiKey: string);
     /**
      * Send an SMS or MMS message via Dialpad.
      */
@@ -189,6 +254,25 @@ declare class DialpadResource {
      * Hang up an active call.
      */
     hangupCall(callId: number): Promise<void>;
+    /**
+     * Alias for `hangupCall` — mirrors the CommHub `endCall` action name so
+     * the SDK swap is a direct rename.
+     */
+    endCall(callId: number): Promise<void>;
+    /**
+     * Send an MMS with a pre-uploaded attachment. Takes the S3 key returned
+     * by `client.attachments.createUploadUrl(...)` + PUT, fetches a short-
+     * lived download URL, and hands it to Dialpad as `media[]`.
+     *
+     * Replaces CommHub's `sendAttachment` Hasura Action (which stored bytes
+     * as base64 in Postgres and served them through a GET endpoint).
+     */
+    sendAttachmentWithUrl(params: {
+        from_number: string;
+        to_number: string;
+        mediaUrl: string;
+        message?: string;
+    }): Promise<SendSmsResponse>;
     /**
      * Get the status of a call.
      */
@@ -220,7 +304,7 @@ declare class DialpadResource {
 }
 declare class MessagesResource {
     readonly dialpad: DialpadResource;
-    constructor(apiBaseUrl: string);
+    constructor(apiBaseUrl: string, apiKey: string);
 }
 declare class DialpadProxyError extends Error {
     readonly method: string;
@@ -284,6 +368,84 @@ declare class EhrProxyError extends Error {
     constructor(provider: string, method: string, path: string, status: number);
 }
 
+/**
+ * NotesResource — push formatted notes to Elation.
+ *
+ * Caller assembles the note body (text + bullets). Truth owns the Elation
+ * OAuth token and the HTTP call so applications can drop Elation
+ * credentials from their own config.
+ */
+interface NonVisitNoteBullet {
+    text: string;
+    category?: string;
+}
+interface PushNoteToElationInput {
+    patient: number;
+    physician: number;
+    practice: number;
+    note: {
+        text: string;
+        type?: string;
+    };
+    document_date?: string;
+    chart_date?: string;
+    bullets?: NonVisitNoteBullet[];
+}
+interface PushNoteToElationResult {
+    success: boolean;
+    elationNoteId: number | null;
+}
+declare class NotesError extends Error {
+    readonly status: number;
+    constructor(operation: string, status: number, message?: string);
+}
+declare class NotesResource {
+    private readonly baseUrl;
+    private readonly apiKey;
+    constructor(apiBaseUrl: string, apiKey: string);
+    pushToElation(input: PushNoteToElationInput): Promise<PushNoteToElationResult>;
+}
+
+/**
+ * PatientDetailsResource — merged Hint + Elation patient lookups.
+ *
+ * Backed by the Truth API at /api/patients/details/*, authenticated with
+ * X-API-Key. Replaces CommHub's getPatientDetails / getPatientBasicDetails
+ * / getPatientMedicalDetails actions.
+ */
+interface PatientDetailsInput {
+    hintId?: string;
+    elationId?: string;
+}
+interface PatientDetailsResult {
+    hint: unknown | null;
+    elation: unknown | null;
+    resolvedElationId: string | null;
+}
+interface PatientBasicDetailsResult {
+    hint: unknown | null;
+    elationId: string | null;
+}
+interface PatientMedicalDetailsResult {
+    problems: unknown | null;
+    medications: unknown | null;
+    allergies: unknown | null;
+    appointments: unknown | null;
+}
+declare class PatientDetailsError extends Error {
+    readonly status: number;
+    constructor(operation: string, status: number, message?: string);
+}
+declare class PatientDetailsResource {
+    private readonly baseUrl;
+    private readonly apiKey;
+    constructor(apiBaseUrl: string, apiKey: string);
+    private post;
+    get(input: PatientDetailsInput): Promise<PatientDetailsResult>;
+    getBasic(input: PatientDetailsInput): Promise<PatientBasicDetailsResult>;
+    getMedical(elationId: string): Promise<PatientMedicalDetailsResult>;
+}
+
 /**
  * Patient interfaces for the Truth SDK.
  */
@@ -356,6 +518,169 @@ declare class PatientResource {
     list(options?: PatientListOptions): Promise<PaginatedResult<Patient>>;
 }
 
+/**
+ * Reminder types — scheduled conversation reminders.
+ */
+type ReminderStatus = "pending" | "triggered" | "cancelled";
+interface Reminder {
+    _id: string;
+    conversationId: string;
+    remindAt: string;
+    status: ReminderStatus;
+    note?: string;
+    createdBy: string;
+    createdAt: string;
+    triggeredAt?: string;
+    cancelledAt?: string;
+}
+interface ScheduleReminderInput {
+    conversationId: string;
+    remindAt: string | Date;
+    note?: string;
+    createdBy: string;
+}
+interface ScheduleReminderResult {
+    reminderId: string;
+    remindAt: string;
+}
+
+/**
+ * RemindersResource — schedule, cancel, and list conversation reminders.
+ *
+ * Backed by Convex mutations/queries (durable scheduled functions) — replaces
+ * the in-memory setTimeout scheduler that used to live in CommHub's NestJS
+ * backend.
+ */
+
+declare class RemindersResource {
+    private readonly convex;
+    constructor(convexClient: ConvexHttpClient);
+    /**
+     * Schedule a reminder to fire at `remindAt`. Returns the reminder id,
+     * which callers should store if they may want to cancel it later.
+     */
+    schedule(input: ScheduleReminderInput): Promise<ScheduleReminderResult>;
+    /**
+     * Cancel a pending reminder. No-op if the reminder has already fired or
+     * been cancelled.
+     */
+    cancel(reminderId: string, cancelledBy: string): Promise<{
+        reminderId: string;
+        status: string;
+    }>;
+    /**
+     * List reminders for a conversation (most recent first).
+     */
+    listByConversation(conversationId: string): Promise<Reminder[]>;
+}
+
+type TaskStatus = "open" | "in_progress" | "resolved" | "cancelled";
+interface Task {
+    _id: string;
+    eventId?: string;
+    assignedTo: string;
+    createdBy: string;
+    title: string;
+    description?: string;
+    data?: unknown;
+    status: TaskStatus;
+    resolvedBy?: string;
+    resolvedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateTaskInput {
+    eventId?: string;
+    assignedTo: string;
+    createdBy: string;
+    title: string;
+    description?: string;
+    data?: unknown;
+}
+interface UpdateTaskStatusInput {
+    taskId: string;
+    status: TaskStatus;
+    resolvedBy?: string;
+    data?: unknown;
+}
+
+/**
+ * TasksResource — create, update status, list, get tasks.
+ *
+ * Backed by Convex. Replaces CommHub's createTaskWithNotification +
+ * updateTaskStatusWithNotification actions. Push notification side-effect
+ * is emitted downstream via Kinesis.
+ */
+
+declare class TasksResource {
+    private readonly convex;
+    constructor(convexClient: ConvexHttpClient);
+    create(input: CreateTaskInput): Promise<{
+        taskId: string;
+        status: TaskStatus;
+    }>;
+    updateStatus(input: UpdateTaskStatusInput): Promise<{
+        taskId: string;
+        status: TaskStatus;
+        previousStatus: TaskStatus;
+    }>;
+    get(taskId: string): Promise<Task | null>;
+    listByAssignee(assignedTo: string, options?: {
+        status?: TaskStatus;
+        limit?: number;
+    }): Promise<Task[]>;
+    listOpen(limit?: number): Promise<Task[]>;
+}
+
+interface TranslationResult {
+    translatedText: string;
+    detectedLanguage?: {
+        language: string;
+        score: number;
+    };
+    sourceLanguage: string;
+    targetLanguage: string;
+}
+interface DetectionResult {
+    language: string;
+    score: number;
+    isTranslationSupported: boolean;
+    isTransliterationSupported: boolean;
+}
+interface TranslateTextInput {
+    text: string;
+    targetLanguage: string;
+    sourceLanguage?: string;
+}
+interface TranslateBatchInput {
+    texts: string[];
+    targetLanguage: string;
+    sourceLanguage?: string;
+}
+
+/**
+ * TranslationResource — Azure Translator proxy through Truth API.
+ *
+ * All three operations are HTTP calls to Truth's oRPC endpoints at
+ * `/api/translation/*`, authenticated with the same X-API-Key as the
+ * event tracker.
+ */
+
+declare class TranslationError extends Error {
+    readonly status: number;
+    readonly operation: string;
+    constructor(operation: string, status: number, message?: string);
+}
+declare class TranslationResource {
+    private readonly baseUrl;
+    private readonly apiKey;
+    constructor(apiBaseUrl: string, apiKey: string);
+    private post;
+    translate(input: TranslateTextInput): Promise<TranslationResult>;
+    translateBatch(input: TranslateBatchInput): Promise<TranslationResult[]>;
+    detect(text: string): Promise<DetectionResult>;
+}
+
 /**
  * Typed event definitions for the Truth Platform event store.
  *
@@ -729,6 +1054,18 @@ declare class TruthClient {
     readonly ehr: EhrResource;
     /** Messaging proxy — typed access to Dialpad APIs through Truth */
     readonly messages: MessagesResource;
+    /** Conversation reminders (Convex-backed, durable scheduler) */
+    readonly reminders: RemindersResource;
+    /** Translation (Azure Translator proxy) */
+    readonly translation: TranslationResource;
+    /** Tasks (Convex-backed) */
+    readonly tasks: TasksResource;
+    /** Patient details — merged Hint + Elation lookups via Truth API */
+    readonly patientDetails: PatientDetailsResource;
+    /** Attachments — presigned S3 upload/download + Convex metadata */
+    readonly attachments: AttachmentsResource;
+    /** Notes — push formatted notes to Elation */
+    readonly notes: NotesResource;
     private readonly convex;
     private readonly tracker;
     constructor(config: TruthClientConfig);
@@ -856,4 +1193,4 @@ declare class Tracker {
     private registerShutdownHooks;
 }
 
-export { AUTH_EVENTS, type ActorContext, type Appointment, type AppointmentListOptions, AppointmentResource, type AuthEventType, type AuthLoginFailedPayload, type AuthLoginSucceededPayload, CALL_EVENTS, CONVERSATION_EVENTS, type CallConnectedPayload, type CallEndedPayload, type CallEventType, type CallInitiatedPayload, type CallMissedPayload, type CallStatusResponse, type ConversationAttachmentDownloadedPayload, type ConversationAttachmentUploadedPayload, type ConversationCreatedPayload, type ConversationEventType, type ConversationMarkedReadPayload, type ConversationMessageReceivedPayload, type ConversationMessageSentPayload, type DialpadNumberInfo, DialpadProxyError, DialpadResource, type DialpadUser, ENVIRONMENTS, EVENT_TYPES, EhrProviderProxy, EhrProxyError, EhrResource, type Environment, type EventActor, type EventCompliance, type EventEnvelope, type EventPayloadMap, type EventSubject, type EventType, type InitiateCallResponse, MessagesResource, NOTIFICATION_EVENTS, type NotificationDeliveredPayload, type NotificationEventType, type NotificationOpenedPayload, type NotificationSentPayload, PROVIDER_EVENTS, type PaginatedResult, type Patient, type PatientListOptions, PatientResource, type ProviderEventType, type ProviderSyncFailedPayload, type ProviderSyncStartedPayload, type ProviderSyncSucceededPayload, REMINDER_EVENTS, type ReminderEventType, type ReminderScheduledPayload, type ReminderTriggeredPayload, SECURITY_EVENTS, type SecurityAccessDeniedPayload, type SecurityEventType, type SendSmsParams, type SendSmsResponse, TASK_EVENTS, TRANSLATION_EVENTS, type TaskAssignedPayload, type TaskCreatedPayload, type TaskEventType, type TaskStatusChangedPayload, type TrackOptions, Tracker, type TranslationCompletedPayload, type TranslationEventType, type TranslationRequestedPayload, TruthClient, type TruthClientConfig, type VoicemailAuthResponse, generateUuidV7 };
+export { AUTH_EVENTS, type ActorContext, type Appointment, type AppointmentListOptions, AppointmentResource, type Attachment, AttachmentsError, AttachmentsResource, type AuthEventType, type AuthLoginFailedPayload, type AuthLoginSucceededPayload, CALL_EVENTS, CONVERSATION_EVENTS, type CallConnectedPayload, type CallEndedPayload, type CallEventType, type CallInitiatedPayload, type CallMissedPayload, type CallStatusResponse, type ConversationAttachmentDownloadedPayload, type ConversationAttachmentUploadedPayload, type ConversationCreatedPayload, type ConversationEventType, type ConversationMarkedReadPayload, type ConversationMessageReceivedPayload, type ConversationMessageSentPayload, type CreateTaskInput, type CreateUploadUrlInput, type CreateUploadUrlResult, type DetectionResult, type DialpadNumberInfo, DialpadProxyError, DialpadResource, type DialpadUser, ENVIRONMENTS, EVENT_TYPES, EhrProviderProxy, EhrProxyError, EhrResource, type Environment, type EventActor, type EventCompliance, type EventEnvelope, type EventPayloadMap, type EventSubject, type EventType, type GetDownloadUrlResult, type InitiateCallResponse, MessagesResource, NOTIFICATION_EVENTS, type NonVisitNoteBullet, NotesError, NotesResource, type NotificationDeliveredPayload, type NotificationEventType, type NotificationOpenedPayload, type NotificationSentPayload, PROVIDER_EVENTS, type PaginatedResult, type Patient, type PatientBasicDetailsResult, PatientDetailsError, type PatientDetailsInput, PatientDetailsResource, type PatientDetailsResult, type PatientListOptions, type PatientMedicalDetailsResult, PatientResource, type ProviderEventType, type ProviderSyncFailedPayload, type ProviderSyncStartedPayload, type ProviderSyncSucceededPayload, type PushNoteToElationInput, type PushNoteToElationResult, REMINDER_EVENTS, type RecordAttachmentInput, type Reminder, type ReminderEventType, type ReminderScheduledPayload, type ReminderStatus, type ReminderTriggeredPayload, RemindersResource, SECURITY_EVENTS, type ScheduleReminderInput, type ScheduleReminderResult, type SecurityAccessDeniedPayload, type SecurityEventType, type SendSmsParams, type SendSmsResponse, TASK_EVENTS, TRANSLATION_EVENTS, type Task, type TaskAssignedPayload, type TaskCreatedPayload, type TaskEventType, type TaskStatus, type TaskStatusChangedPayload, TasksResource, type TrackOptions, Tracker, type TranslateBatchInput, type TranslateTextInput, type TranslationCompletedPayload, TranslationError, type TranslationEventType, type TranslationRequestedPayload, TranslationResource, type TranslationResult, TruthClient, type TruthClientConfig, type UpdateTaskStatusInput, type VoicemailAuthResponse, generateUuidV7 };