Release 0.0.21

Author: fern-api[bot]

package.json

@@ -1,6 +1,6 @@
 {
     "name": "phenoml",
-    "version": "0.0.20",
+    "version": "0.0.21",
     "private": false,
     "repository": "github:PhenoML/phenoml-ts-sdk",
     "type": "commonjs",

reference.md

@@ -514,7 +514,7 @@ Retrieves a list of chat messages for a given chat session
 await client.agent.getChatMessages({
     chat_session_id: "chat_session_id",
     num_messages: 1,
-    role: "role",
+    role: "user",
     order: "asc"
 });
 
@@ -1589,7 +1589,7 @@ Examples:
 </dl>
 </details>
 
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">delete</a>(fhirProviderId, fhirPath, { ...params }) -> Record<string, unknown></code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">delete</a>(fhirProviderId, fhirPath, { ...params }) -> Record&lt;string, unknown&gt;</code></summary>
 <dl>
 <dd>
 
@@ -1914,7 +1914,9 @@ The ID of the FHIR provider to use. Can be either:
 <dl>
 <dd>
 
-Creates a new FHIR provider configuration with authentication credentials
+Creates a new FHIR provider configuration with authentication credentials.
+
+Note: The "sandbox" provider type cannot be created via this API - it is managed internally.
 </dd>
 </dl>
 </dd>
@@ -1982,7 +1984,10 @@ await client.fhirProvider.create({
 <dl>
 <dd>
 
-Retrieves a list of all active FHIR providers for the authenticated user
+Retrieves a list of all active FHIR providers for the authenticated user.
+
+On shared instances, only sandbox providers are returned.
+Sandbox providers return FhirProviderSandboxInfo.
 </dd>
 </dl>
 </dd>
@@ -2037,7 +2042,10 @@ await client.fhirProvider.list();
 <dl>
 <dd>
 
-Retrieves a specific FHIR provider configuration by its ID
+Retrieves a specific FHIR provider configuration by its ID.
+
+Sandbox providers return FhirProviderSandboxInfo.
+On shared instances, only sandbox providers can be accessed.
 </dd>
 </dl>
 </dd>
@@ -2100,7 +2108,9 @@ await client.fhirProvider.get("fhir_provider_id");
 <dl>
 <dd>
 
-Soft deletes a FHIR provider by setting is_active to false
+Soft deletes a FHIR provider by setting is_active to false.
+
+Note: Sandbox providers cannot be deleted.
 </dd>
 </dl>
 </dd>
@@ -2163,7 +2173,10 @@ await client.fhirProvider.delete("fhir_provider_id");
 <dl>
 <dd>
 
-Adds a new authentication configuration to an existing FHIR provider. This enables key rotation and multiple auth configurations per provider.
+Adds a new authentication configuration to an existing FHIR provider.
+This enables key rotation and multiple auth configurations per provider.
+
+Note: Sandbox providers cannot be modified.
 </dd>
 </dl>
 </dd>
@@ -2224,7 +2237,7 @@ await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad",
 </dl>
 </details>
 
-<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">setActiveAuthConfig</a>(fhirProviderId, { ...params }) -> phenoml.FhirProviderSetActiveAuthConfigResponse</code></summary>
+<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">setActiveAuthConfig</a>(fhirProviderId, { ...params }) -> phenoml.FhirProviderResponse</code></summary>
 <dl>
 <dd>
 
@@ -2236,7 +2249,13 @@ await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad",
 <dl>
 <dd>
 
-Sets which authentication configuration should be active for a FHIR provider. Only one auth config can be active at a time.
+Sets which authentication configuration should be active for a FHIR provider.
+Only one auth config can be active at a time.
+
+If the specified auth config is already active, the request succeeds without
+making any changes and returns a message indicating the config is already active.
+
+Note: Sandbox providers cannot be modified.
 </dd>
 </dl>
 </dd>
@@ -2309,7 +2328,10 @@ await client.fhirProvider.setActiveAuthConfig("1716d214-de93-43a4-aa6b-a878d864e
 <dl>
 <dd>
 
-Removes an authentication configuration from a FHIR provider. Cannot remove the currently active auth configuration.
+Removes an authentication configuration from a FHIR provider.
+Cannot remove the currently active auth configuration.
+
+Note: Sandbox providers cannot be modified.
 </dd>
 </dl>
 </dd>
@@ -2517,7 +2539,14 @@ await client.lang2Fhir.createMulti({
 <dl>
 <dd>
 
-Converts natural language text into FHIR search parameters
+Converts natural language text into FHIR search parameters.
+Automatically identifies the appropriate FHIR resource type and generates valid search query parameters.
+
+Supported resource types include: AllergyIntolerance, Appointment, CarePlan, CareTeam, Condition,
+Coverage, Device, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, Location,
+Medication, MedicationRequest, Observation, Organization, Patient, PlanDefinition, Practitioner,
+PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RelatedPerson,
+Schedule, ServiceRequest, Slot, and Specimen.
 </dd>
 </dl>
 </dd>

src/Client.ts

@@ -40,8 +40,8 @@ export class phenomlClient {
                 {
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "phenoml",
-                    "X-Fern-SDK-Version": "0.0.20",
-                    "User-Agent": "phenoml/0.0.20",
+                    "X-Fern-SDK-Version": "0.0.21",
+                    "User-Agent": "phenoml/0.0.21",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

src/api/resources/agent/client/Client.ts

@@ -695,7 +695,7 @@ export class Agent {
      *     await client.agent.getChatMessages({
      *         chat_session_id: "chat_session_id",
      *         num_messages: 1,
-     *         role: "role",
+     *         role: "user",
      *         order: "asc"
      *     })
      */

src/api/resources/agent/client/requests/AgentGetChatMessagesRequest.ts

@@ -7,7 +7,7 @@ import type * as phenoml from "../../../../index.js";
  *     {
  *         chat_session_id: "chat_session_id",
  *         num_messages: 1,
- *         role: "role",
+ *         role: "user",
  *         order: "asc"
  *     }
  */
@@ -16,8 +16,17 @@ export interface AgentGetChatMessagesRequest {
     chat_session_id: string;
     /** Number of messages to return */
     num_messages?: number;
-    /** Filter by role */
-    role?: string;
+    /**
+     * Filter by one or more message roles. Multiple roles can be specified as a comma-separated string.
+     * If not specified, messages with all roles are returned.
+     *
+     * **Available roles:**
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests from the model
+     * - `function` - Function/tool call results
+     */
+    role?: phenoml.agent.AgentGetChatMessagesRequestRole;
     /** Order of messages */
     order?: phenoml.agent.AgentGetChatMessagesRequestOrder;
 }

src/api/resources/agent/types/AgentGetChatMessagesRequestRole.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export const AgentGetChatMessagesRequestRole = {
+    User: "user",
+    Assistant: "assistant",
+    Model: "model",
+    Function: "function",
+} as const;
+export type AgentGetChatMessagesRequestRole =
+    (typeof AgentGetChatMessagesRequestRole)[keyof typeof AgentGetChatMessagesRequestRole];

src/api/resources/agent/types/ChatMessageTemplate.ts

@@ -5,8 +5,14 @@ export interface ChatMessageTemplate {
     id?: string;
     /** Chat session ID */
     session_id?: string;
-    /** Message role */
-    role?: string;
+    /**
+     * Message role indicating the source/type of the message:
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests to the model
+     * - `function` - Function/tool call results
+     */
+    role?: ChatMessageTemplate.Role;
     /** Message content */
     content?: string;
     /** Message created time */
@@ -24,3 +30,20 @@ export interface ChatMessageTemplate {
     /** Message order */
     message_order?: number;
 }
+
+export namespace ChatMessageTemplate {
+    /**
+     * Message role indicating the source/type of the message:
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests to the model
+     * - `function` - Function/tool call results
+     */
+    export const Role = {
+        User: "user",
+        Assistant: "assistant",
+        Model: "model",
+        Function: "function",
+    } as const;
+    export type Role = (typeof Role)[keyof typeof Role];
+}

src/api/resources/agent/types/index.ts

@@ -2,6 +2,7 @@ export * from "./AgentChatResponse.js";
 export * from "./AgentCreateRequest.js";
 export * from "./AgentDeleteResponse.js";
 export * from "./AgentGetChatMessagesRequestOrder.js";
+export * from "./AgentGetChatMessagesRequestRole.js";
 export * from "./AgentGetChatMessagesResponse.js";
 export * from "./AgentListResponse.js";
 export * from "./AgentPromptsResponse.js";

src/api/resources/fhirProvider/client/Client.ts

@@ -21,7 +21,9 @@ export class FhirProvider {
     }
 
     /**
-     * Creates a new FHIR provider configuration with authentication credentials
+     * Creates a new FHIR provider configuration with authentication credentials.
+     *
+     * Note: The "sandbox" provider type cannot be created via this API - it is managed internally.
      *
      * @param {phenoml.fhirProvider.FhirProviderCreateRequest} request
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,12 +130,14 @@ export class FhirProvider {
     }
 
     /**
-     * Retrieves a list of all active FHIR providers for the authenticated user
+     * Retrieves a list of all active FHIR providers for the authenticated user.
+     *
+     * On shared instances, only sandbox providers are returned.
+     * Sandbox providers return FhirProviderSandboxInfo.
      *
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.fhirProvider.UnauthorizedError}
-     * @throws {@link phenoml.fhirProvider.ForbiddenError}
      * @throws {@link phenoml.fhirProvider.InternalServerError}
      *
      * @example
@@ -181,11 +185,6 @@ export class FhirProvider {
                         _response.error.body as unknown,
                         _response.rawResponse,
                     );
-                case 403:
-                    throw new phenoml.fhirProvider.ForbiddenError(
-                        _response.error.body as unknown,
-                        _response.rawResponse,
-                    );
                 case 500:
                     throw new phenoml.fhirProvider.InternalServerError(
                         _response.error.body as unknown,
@@ -218,7 +217,10 @@ export class FhirProvider {
     }
 
     /**
-     * Retrieves a specific FHIR provider configuration by its ID
+     * Retrieves a specific FHIR provider configuration by its ID.
+     *
+     * Sandbox providers return FhirProviderSandboxInfo.
+     * On shared instances, only sandbox providers can be accessed.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to retrieve
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -319,7 +321,9 @@ export class FhirProvider {
     }
 
     /**
-     * Soft deletes a FHIR provider by setting is_active to false
+     * Soft deletes a FHIR provider by setting is_active to false.
+     *
+     * Note: Sandbox providers cannot be deleted.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to delete
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -420,7 +424,10 @@ export class FhirProvider {
     }
 
     /**
-     * Adds a new authentication configuration to an existing FHIR provider. This enables key rotation and multiple auth configurations per provider.
+     * Adds a new authentication configuration to an existing FHIR provider.
+     * This enables key rotation and multiple auth configurations per provider.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to add auth config to
      * @param {phenoml.fhirProvider.FhirProviderAddAuthConfigRequest} request
@@ -535,7 +542,13 @@ export class FhirProvider {
     }
 
     /**
-     * Sets which authentication configuration should be active for a FHIR provider. Only one auth config can be active at a time.
+     * Sets which authentication configuration should be active for a FHIR provider.
+     * Only one auth config can be active at a time.
+     *
+     * If the specified auth config is already active, the request succeeds without
+     * making any changes and returns a message indicating the config is already active.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider
      * @param {phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest} request
@@ -556,7 +569,7 @@ export class FhirProvider {
         fhirProviderId: string,
         request: phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest,
         requestOptions?: FhirProvider.RequestOptions,
-    ): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderSetActiveAuthConfigResponse> {
+    ): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderResponse> {
         return core.HttpResponsePromise.fromPromise(
             this.__setActiveAuthConfig(fhirProviderId, request, requestOptions),
         );
@@ -566,7 +579,7 @@ export class FhirProvider {
         fhirProviderId: string,
         request: phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest,
         requestOptions?: FhirProvider.RequestOptions,
-    ): Promise<core.WithRawResponse<phenoml.fhirProvider.FhirProviderSetActiveAuthConfigResponse>> {
+    ): Promise<core.WithRawResponse<phenoml.fhirProvider.FhirProviderResponse>> {
         const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
             this._options?.headers,
             mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
@@ -591,7 +604,7 @@ export class FhirProvider {
         });
         if (_response.ok) {
             return {
-                data: _response.body as phenoml.fhirProvider.FhirProviderSetActiveAuthConfigResponse,
+                data: _response.body as phenoml.fhirProvider.FhirProviderResponse,
                 rawResponse: _response.rawResponse,
             };
         }
@@ -652,7 +665,10 @@ export class FhirProvider {
     }
 
     /**
-     * Removes an authentication configuration from a FHIR provider. Cannot remove the currently active auth configuration.
+     * Removes an authentication configuration from a FHIR provider.
+     * Cannot remove the currently active auth configuration.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider
      * @param {phenoml.fhirProvider.FhirProviderRemoveAuthConfigRequest} request

src/api/resources/fhirProvider/types/FhirProviderAuthConfig.ts

@@ -11,12 +11,17 @@ export interface FhirProviderAuthConfig {
     auth_method?: phenoml.fhirProvider.AuthMethod;
     /** Whether this auth configuration is currently active */
     is_active_auth_config?: boolean;
+    /** Timestamp when this auth configuration was created */
+    created_at?: string;
+    /** Timestamp when this auth configuration was last updated */
+    updated_at?: string;
     /** Public key certificate in PEM format (visible for JWT auth) */
     public_key_cert_pem?: string;
     json_web_key?: phenoml.fhirProvider.JsonWebKey;
     /** Expiry time for credentials (JWT auth only) */
     credential_expiry?: string;
     smart_configuration?: phenoml.fhirProvider.SmartConfiguration;
+    service_account_metadata?: phenoml.fhirProvider.ServiceAccountMetadata;
     /** OAuth scopes */
     scopes?: string;
 }