@gpt-platform/client 0.8.0 → 0.8.1

package/dist/index.d.ts

@@ -606,7 +606,7 @@ declare class BrowserApiKeyError extends Error {
 }
 
 /** SDK version — updated automatically by mix update.sdks */
-declare const SDK_VERSION = "0.8.0";
+declare const SDK_VERSION = "0.8.1";
 /** Default API version sent in every request — updated automatically by mix update.sdks */
 declare const DEFAULT_API_VERSION = "2026-03-11";
 
@@ -1199,6 +1199,144 @@ type WorkspaceAgentConfig = {
     };
     type: string;
 };
+/**
+ * A "Resource object" representing a clinical-goal-template
+ */
+type ClinicalGoalTemplate = {
+    /**
+     * An attributes object for a clinical-goal-template
+     */
+    attributes?: {
+        /**
+         * Field included by default.
+         */
+        action_steps: Array<string>;
+        /**
+         * Field included by default.
+         */
+        age_groups: Array<string>;
+        /**
+         * Field included by default.
+         */
+        applicable_conditions: Array<string>;
+        /**
+         * Field included by default.
+         */
+        category?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        created_by_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        description?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        difficulty?: "beginner" | "intermediate" | "advanced" | unknown;
+        /**
+         * Field included by default.
+         */
+        evidence_base?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        goal_type: string;
+        /**
+         * Field included by default.
+         */
+        instructions?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        is_active: boolean;
+        /**
+         * Field included by default.
+         */
+        linked_metric_type?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        metadata: {
+            [key: string]: unknown;
+        };
+        /**
+         * Field included by default.
+         */
+        priority?: "high" | "medium" | "low" | unknown;
+        /**
+         * Field included by default.
+         */
+        source_catalog_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        source_reference?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        source_template_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        suggested_duration_days?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        tags: Array<string>;
+        /**
+         * Field included by default.
+         */
+        target_value?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        timeframe?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        title: string;
+        /**
+         * Field included by default.
+         */
+        tool_ids: Array<string>;
+        /**
+         * Field included by default.
+         */
+        unit?: string | null | unknown;
+    };
+    id: string;
+    /**
+     * A relationships object for a clinical-goal-template
+     */
+    relationships?: {
+        [key: string]: never;
+    };
+    type: string;
+};
+/**
+ * A "Resource object" representing a clinical-goal-template-category
+ */
+type ClinicalGoalTemplateCategory = {
+    /**
+     * An attributes object for a clinical-goal-template-category
+     */
+    attributes?: {
+        /**
+         * Field included by default.
+         */
+        template_count: number;
+    };
+    id: string;
+    /**
+     * A relationships object for a clinical-goal-template-category
+     */
+    relationships?: {
+        [key: string]: never;
+    };
+    type: string;
+};
 /**
  * A "Resource object" representing a crawler_result
  */
@@ -2752,14 +2890,34 @@ type ClinicalPracticeTool = {
      * An attributes object for a clinical-practice-tool
      */
     attributes?: {
+        /**
+         * Field included by default.
+         */
+        app_store_url?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        category?: string | null | unknown;
         /**
          * Field included by default.
          */
         description?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        icon_url?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        integrations: Array<string>;
         /**
          * Field included by default.
          */
         is_active: boolean;
+        /**
+         * Field included by default.
+         */
+        logo_url?: string | null | unknown;
         /**
          * Field included by default.
          */
@@ -2768,6 +2926,34 @@ type ClinicalPracticeTool = {
          * Field included by default.
          */
         platform?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        play_store_url?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        pricing_model?: "free" | "freemium" | "paid" | "prescription" | unknown;
+        /**
+         * Field included by default.
+         */
+        privacy_rating: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown";
+        /**
+         * Field included by default.
+         */
+        rating?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        source_catalog_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        supported_platforms: Array<string>;
+        /**
+         * Field included by default.
+         */
+        tags: Array<string>;
         /**
          * Field included by default.
          */
@@ -2776,6 +2962,10 @@ type ClinicalPracticeTool = {
          * Field included by default.
          */
         url?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        website_url?: string | null | unknown;
     };
     id: string;
     /**
@@ -3929,7 +4119,7 @@ type LegalAcceptance = {
         /**
          * Field included by default.
          */
-        document_type: "terms_of_service" | "privacy_policy";
+        document_type: "terms_of_service" | "privacy_policy" | "baa" | "dpa" | "scc" | "npp" | "security_policy" | "incident_response_plan" | "contingency_plan" | "access_control_policy" | "risk_management_plan" | "training_policy" | "sanction_policy" | "breach_notification_policy" | "system_activity_review" | "data_retention_policy" | "minimum_necessary_policy" | "authorization_form";
         /**
          * Field included by default.
          */
@@ -5843,6 +6033,10 @@ type ClinicalSession = {
          * Field included by default.
          */
         session_status: "scheduled" | "in_progress" | "completed" | "cancelled" | "no_show";
+        /**
+         * Field included by default.
+         */
+        session_summary?: string | null | unknown;
         /**
          * Field included by default.
          */
@@ -7064,18 +7258,66 @@ type ClinicalPracticeResource = {
      * An attributes object for a clinical-practice-resource
      */
     attributes?: {
+        /**
+         * Field included by default.
+         */
+        applicable_conditions: Array<string>;
+        /**
+         * Field included by default.
+         */
+        audience: "patient" | "practitioner" | "both";
+        /**
+         * Field included by default.
+         */
+        author?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive" | unknown;
         /**
          * Field included by default.
          */
         description?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        estimated_duration_minutes?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        icon_url?: string | null | unknown;
         /**
          * Field included by default.
          */
         is_active: boolean;
+        /**
+         * Field included by default.
+         */
+        language: string;
+        /**
+         * Field included by default.
+         */
+        license?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        preview_url?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        reading_level?: "basic" | "intermediate" | "advanced" | "clinical" | unknown;
+        /**
+         * Field included by default.
+         */
+        related_goal_types: Array<string>;
         /**
          * Field included by default.
          */
         resource_type: "article" | "video" | "handout" | "worksheet" | "tool_link";
+        /**
+         * Field included by default.
+         */
+        source_catalog_id?: string | null | unknown;
         /**
          * Field included by default.
          */
@@ -7477,6 +7719,18 @@ type ClinicalDelivery = {
          * Field included by default.
          */
         delivery_type: "summary_email" | "goal_report" | "meal_plan" | "supplement_list";
+        /**
+         * Field included by default.
+         */
+        included_goal_ids: Array<string>;
+        /**
+         * Field included by default.
+         */
+        included_resource_ids: Array<string>;
+        /**
+         * Field included by default.
+         */
+        included_supplement_ids: Array<string>;
         /**
          * Field included by default.
          */
@@ -10046,6 +10300,14 @@ type ClinicalClientGoal = {
          * Field included by default.
          */
         achieved_at?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        action_steps: Array<string>;
+        /**
+         * Field included by default.
+         */
+        category?: string | null | unknown;
         /**
          * Field included by default.
          */
@@ -10054,6 +10316,10 @@ type ClinicalClientGoal = {
          * Field included by default.
          */
         description?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        email_sent_at?: string | null | unknown;
         /**
          * Field included by default.
          */
@@ -10062,6 +10328,12 @@ type ClinicalClientGoal = {
          * Field included by default.
          */
         linked_metric_type?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        metadata: {
+            [key: string]: unknown;
+        };
         /**
          * Field included by default.
          */
@@ -10069,7 +10341,23 @@ type ClinicalClientGoal = {
         /**
          * Field included by default.
          */
-        status: "active" | "completed" | "abandoned" | "paused";
+        position?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        priority?: "high" | "medium" | "low" | unknown;
+        /**
+         * Field included by default.
+         */
+        session_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        source: "manual" | "session" | "template";
+        /**
+         * Field included by default.
+         */
+        status: "active" | "completed" | "abandoned" | "paused" | "achieved" | "discontinued";
         /**
          * Field included by default.
          */
@@ -10078,6 +10366,14 @@ type ClinicalClientGoal = {
          * Field included by default.
          */
         target_value?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        template_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        timeframe?: string | null | unknown;
         /**
          * Field included by default.
          */
@@ -21209,7 +21505,7 @@ interface UpdateMealPlanAttributes {
 interface CreateClientGoalAttributes {
     workspace_id: string;
     patient_id: string;
-    status?: string;
+    status?: "active" | "completed" | "abandoned" | "paused" | "achieved" | "discontinued";
     goal_type: string;
     title: string;
     description?: string;
@@ -21219,11 +21515,21 @@ interface CreateClientGoalAttributes {
     target_date?: string;
     linked_metric_type?: string;
     tool_ids?: string[];
+    action_steps?: string[];
+    priority?: "high" | "medium" | "low";
+    category?: string;
+    timeframe?: string;
+    position?: number;
+    source?: "manual" | "session" | "template";
+    session_id?: string;
+    template_id?: string;
+    email_sent_at?: string;
+    metadata?: Record<string, unknown>;
     progress_notes?: string;
     achieved_at?: string;
 }
 interface UpdateClientGoalAttributes {
-    status?: string;
+    status?: "active" | "completed" | "abandoned" | "paused" | "achieved" | "discontinued";
     goal_type?: string;
     title?: string;
     description?: string;
@@ -21233,6 +21539,16 @@ interface UpdateClientGoalAttributes {
     target_date?: string;
     linked_metric_type?: string;
     tool_ids?: string[];
+    action_steps?: string[];
+    priority?: "high" | "medium" | "low";
+    category?: string;
+    timeframe?: string;
+    position?: number;
+    source?: "manual" | "session" | "template";
+    session_id?: string;
+    template_id?: string;
+    email_sent_at?: string;
+    metadata?: Record<string, unknown>;
     progress_notes?: string;
     achieved_at?: string;
 }
@@ -21285,20 +21601,42 @@ interface CreatePracticeResourceAttributes {
     workspace_id: string;
     title: string;
     description?: string;
-    resource_type?: string;
+    resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link";
     storage_key?: string;
     url?: string;
     tags?: string[];
     is_active?: boolean;
+    content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive";
+    preview_url?: string;
+    language?: string;
+    reading_level?: "basic" | "intermediate" | "advanced" | "clinical";
+    audience?: "patient" | "practitioner" | "both";
+    author?: string;
+    license?: string;
+    estimated_duration_minutes?: number;
+    applicable_conditions?: string[];
+    related_goal_types?: string[];
+    icon_url?: string;
 }
 interface UpdatePracticeResourceAttributes {
     title?: string;
     description?: string;
-    resource_type?: string;
+    resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link";
     storage_key?: string;
     url?: string;
     tags?: string[];
     is_active?: boolean;
+    content_format?: "pdf" | "html" | "video_embed" | "external_link" | "interactive";
+    preview_url?: string;
+    language?: string;
+    reading_level?: "basic" | "intermediate" | "advanced" | "clinical";
+    audience?: "patient" | "practitioner" | "both";
+    author?: string;
+    license?: string;
+    estimated_duration_minutes?: number;
+    applicable_conditions?: string[];
+    related_goal_types?: string[];
+    icon_url?: string;
 }
 interface CreatePracticeToolAttributes {
     workspace_id: string;
@@ -21308,6 +21646,18 @@ interface CreatePracticeToolAttributes {
     url?: string;
     platform?: string;
     is_active?: boolean;
+    category?: string;
+    pricing_model?: "free" | "freemium" | "paid" | "prescription";
+    supported_platforms?: string[];
+    integrations?: string[];
+    website_url?: string;
+    app_store_url?: string;
+    play_store_url?: string;
+    icon_url?: string;
+    logo_url?: string;
+    rating?: string;
+    privacy_rating?: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown";
+    tags?: string[];
 }
 interface UpdatePracticeToolAttributes {
     name?: string;
@@ -21316,6 +21666,18 @@ interface UpdatePracticeToolAttributes {
     url?: string;
     platform?: string;
     is_active?: boolean;
+    category?: string;
+    pricing_model?: "free" | "freemium" | "paid" | "prescription";
+    supported_platforms?: string[];
+    integrations?: string[];
+    website_url?: string;
+    app_store_url?: string;
+    play_store_url?: string;
+    icon_url?: string;
+    logo_url?: string;
+    rating?: string;
+    privacy_rating?: "hipaa_compliant" | "hipaa_partial" | "standard" | "unknown";
+    tags?: string[];
 }
 /** Parameters for listing practice tools. */
 interface ListPracticeToolsParams {
@@ -21366,6 +21728,65 @@ interface PatientAdherenceResponse {
     goals: PatientAdherenceGoals;
     health_metrics: PatientAdherenceHealthMetrics;
 }
+interface CreateGoalTemplateAttributes {
+    workspace_id: string;
+    goal_type: string;
+    title: string;
+    description?: string;
+    action_steps?: string[];
+    priority?: "high" | "medium" | "low";
+    category?: string;
+    timeframe?: string;
+    tool_ids?: string[];
+    metadata?: Record<string, unknown>;
+    tags?: string[];
+    target_value?: string;
+    unit?: string;
+    linked_metric_type?: string;
+    difficulty?: "beginner" | "intermediate" | "advanced";
+    evidence_base?: string;
+    instructions?: string;
+    suggested_duration_days?: number;
+    applicable_conditions?: string[];
+    age_groups?: string[];
+    source_reference?: string;
+}
+interface UpdateGoalTemplateAttributes {
+    goal_type?: string;
+    title?: string;
+    description?: string;
+    action_steps?: string[];
+    priority?: "high" | "medium" | "low";
+    category?: string;
+    timeframe?: string;
+    tool_ids?: string[];
+    metadata?: Record<string, unknown>;
+    is_active?: boolean;
+    tags?: string[];
+    target_value?: string;
+    unit?: string;
+    linked_metric_type?: string;
+    difficulty?: "beginner" | "intermediate" | "advanced";
+    evidence_base?: string;
+    instructions?: string;
+    suggested_duration_days?: number;
+    applicable_conditions?: string[];
+    age_groups?: string[];
+    source_reference?: string;
+}
+interface CreateGoalFromExistingAttributes {
+    workspace_id: string;
+    source_template_id: string;
+}
+interface ListGoalTemplatesParams {
+    workspace_id: string;
+    filter?: Record<string, unknown>;
+    sort?: string;
+    page?: {
+        offset?: number;
+        limit?: number;
+    };
+}
 interface RecipeSearchParams {
     query: string;
     connector_id: string;
@@ -22013,6 +22434,17 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
          * @returns `true` on successful deletion
          */
         delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * List application-level catalog practice resources.
+         *
+         * @param params - Optional filter/sort params. Application ID is resolved from the API key context.
+         * @param options - Request options
+         * @returns Array of {@link ClinicalPracticeResource} catalog records
+         */
+        listCatalog: (params?: {
+            filter?: Record<string, unknown>;
+            sort?: string;
+        }, options?: RequestOptions) => Promise<ClinicalPracticeResource[]>;
     };
     /**
      * Manage practice-level assessment and therapeutic tools.
@@ -22080,6 +22512,17 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
         listCategories: (params: {
             workspace_id: string;
         }, options?: RequestOptions) => Promise<PracticeToolCategory[]>;
+        /**
+         * List application-level catalog practice tools.
+         *
+         * @param params - Optional filter/sort params. Application ID is resolved from the API key context.
+         * @param options - Request options
+         * @returns Array of {@link ClinicalPracticeTool} catalog records
+         */
+        listCatalog: (params?: {
+            filter?: Record<string, unknown>;
+            sort?: string;
+        }, options?: RequestOptions) => Promise<ClinicalPracticeTool[]>;
     };
     /**
      * Manage assignments of practice resources to patients.
@@ -22175,14 +22618,117 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
          * ```
          */
         generate: (patientId: string, sessionId: string, workspaceId: string, options?: RequestOptions) => Promise<GenerateSupplementRecsResponse>;
+    };
+    /**
+     * Manage reusable clinical goal templates.
+     *
+     * Templates are workspace-scoped patterns that practitioners can personalize
+     * and instantiate as ClientGoals.
+     */
+    goalTemplates: {
         /**
-         * Delete a supplement recommendation cache entry.
+         * List goal templates in a workspace.
          *
-         * @param id - SupplementRecCache UUID
+         * @param params - Must include `workspace_id`
+         * @param options - Request options
+         * @returns Array of {@link ClinicalGoalTemplate} records
+         *
+         * @example
+         * ```typescript
+         * const templates = await client.clinical.goalTemplates.list({
+         *   workspace_id: "ws_123",
+         *   filter: { category: "nutrition" },
+         * });
+         * ```
+         */
+        list: (params: ListGoalTemplatesParams, options?: RequestOptions) => Promise<ClinicalGoalTemplate[]>;
+        /**
+         * List practitioner's personal templates.
+         *
+         * @param params - Must include `created_by_id`
+         * @param options - Request options
+         * @returns Array of {@link ClinicalGoalTemplate} records
+         */
+        listMine: (params: {
+            created_by_id: string;
+            page?: {
+                offset?: number;
+                limit?: number;
+            };
+        }, options?: RequestOptions) => Promise<ClinicalGoalTemplate[]>;
+        /**
+         * List distinct goal template categories with counts.
+         *
+         * @param params - Must include `workspace_id`
+         * @param options - Request options
+         * @returns Array of {@link ClinicalGoalTemplateCategory} records
+         */
+        listCategories: (params: {
+            workspace_id: string;
+        }, options?: RequestOptions) => Promise<ClinicalGoalTemplateCategory[]>;
+        /**
+         * Get a single goal template by ID.
+         *
+         * @param id - GoalTemplate UUID
+         * @param options - Request options
+         * @returns {@link ClinicalGoalTemplate} record
+         */
+        get: (id: string, options?: RequestOptions) => Promise<ClinicalGoalTemplate>;
+        /**
+         * Create a new goal template.
+         *
+         * @param attributes - Template creation attributes. Must include `workspace_id`, `goal_type`, and `title`.
+         * @param options - Request options
+         * @returns Created {@link ClinicalGoalTemplate} record
+         */
+        create: (attributes: CreateGoalTemplateAttributes, options?: RequestOptions) => Promise<ClinicalGoalTemplate>;
+        /**
+         * Create a personalized template from an existing one.
+         *
+         * Copies all fields from the source template, sets `created_by_id` to the
+         * current actor, and sets `source_template_id` as a reference.
+         *
+         * @param attributes - Must include `workspace_id` and `source_template_id`
+         * @param options - Request options
+         * @returns Created {@link ClinicalGoalTemplate} record
+         *
+         * @example
+         * ```typescript
+         * const personal = await client.clinical.goalTemplates.createFromExisting({
+         *   workspace_id: "ws_123",
+         *   source_template_id: "tmpl_abc",
+         * });
+         * ```
+         */
+        createFromExisting: (attributes: CreateGoalFromExistingAttributes, options?: RequestOptions) => Promise<ClinicalGoalTemplate>;
+        /**
+         * Update a goal template.
+         *
+         * @param id - GoalTemplate UUID
+         * @param attributes - Fields to update (PATCH semantics)
+         * @param options - Request options
+         * @returns Updated {@link ClinicalGoalTemplate} record
+         */
+        update: (id: string, attributes: UpdateGoalTemplateAttributes, options?: RequestOptions) => Promise<ClinicalGoalTemplate>;
+        /**
+         * Delete a goal template.
+         *
+         * @param id - GoalTemplate UUID
          * @param options - Request options
          * @returns `true` on successful deletion
          */
         delete: (id: string, options?: RequestOptions) => Promise<true>;
+        /**
+         * List application-level catalog goal templates.
+         *
+         * @param params - Optional filter/sort params. Application ID is resolved from the API key context.
+         * @param options - Request options
+         * @returns Array of {@link ClinicalGoalTemplate} catalog records
+         */
+        listCatalog: (params?: {
+            filter?: Record<string, unknown>;
+            sort?: string;
+        }, options?: RequestOptions) => Promise<ClinicalGoalTemplate[]>;
     };
     /**
      * Recipe search via configured Edamam connector.