phenoml 9.2.0 → 10.0.0

package/dist/esm/api/resources/construe/client/Client.d.mts

@@ -1,15 +1,15 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as phenoml from "../../../index.mjs";
-export declare namespace Construe {
-    interface Options extends BaseClientOptions {
-    }
+export declare namespace ConstrueClient {
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Construe {
-    protected readonly _options: Construe.Options;
-    constructor(_options: Construe.Options);
+export declare class ConstrueClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ConstrueClient.Options>;
+    constructor(options?: ConstrueClient.Options);
     /**
      * Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
      * Returns 202 immediately; embedding generation runs asynchronously. Poll
@@ -17,7 +17,7 @@ export declare class Construe {
      * transitions from "processing" to "ready" or "failed".
      *
      * @param {phenoml.construe.UploadRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -33,7 +33,7 @@ export declare class Construe {
      *         format: "csv"
      *     })
      */
-    uploadCodeSystem(request: phenoml.construe.UploadRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ConstrueUploadCodeSystemResponse>;
+    uploadCodeSystem(request: phenoml.construe.UploadRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ConstrueUploadCodeSystemResponse>;
     private __uploadCodeSystem;
     /**
      * Converts natural language text into structured medical codes.
@@ -41,7 +41,7 @@ export declare class Construe {
      * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {phenoml.construe.ExtractRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -55,12 +55,12 @@ export declare class Construe {
      *         text: "Patient is a 14-year-old female, previously healthy, who is here for evaluation of abnormal renal ultrasound with atrophic right kidney"
      *     })
      */
-    extractCodes(request: phenoml.construe.ExtractRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExtractCodesResult>;
+    extractCodes(request: phenoml.construe.ExtractRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExtractCodesResult>;
     private __extractCodes;
     /**
      * Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
      *
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.UnauthorizedError}
      * @throws {@link phenoml.construe.InternalServerError}
@@ -68,14 +68,14 @@ export declare class Construe {
      * @example
      *     await client.construe.listAvailableCodeSystems()
      */
-    listAvailableCodeSystems(requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodeSystemsResponse>;
+    listAvailableCodeSystems(requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodeSystemsResponse>;
     private __listAvailableCodeSystems;
     /**
      * Returns full metadata for a single code system, including timestamps and builtin status.
      *
      * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
      * @param {phenoml.construe.GetConstrueCodesSystemsCodesystemRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -87,7 +87,7 @@ export declare class Construe {
      *         version: "2025"
      *     })
      */
-    getCodeSystemDetail(codesystem: string, request?: phenoml.construe.GetConstrueCodesSystemsCodesystemRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeSystemDetailResponse>;
+    getCodeSystemDetail(codesystem: string, request?: phenoml.construe.GetConstrueCodesSystemsCodesystemRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeSystemDetailResponse>;
     private __getCodeSystemDetail;
     /**
      * Deletes a custom (non-builtin) code system and all its codes. Builtin systems cannot be deleted.
@@ -95,7 +95,7 @@ export declare class Construe {
      *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.DeleteConstrueCodesSystemsCodesystemRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -108,7 +108,7 @@ export declare class Construe {
      *         version: "version"
      *     })
      */
-    deleteCustomCodeSystem(codesystem: string, request?: phenoml.construe.DeleteConstrueCodesSystemsCodesystemRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.DeleteCodeSystemResponse>;
+    deleteCustomCodeSystem(codesystem: string, request?: phenoml.construe.DeleteConstrueCodesSystemsCodesystemRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.DeleteCodeSystemResponse>;
     private __deleteCustomCodeSystem;
     /**
      * Exports a custom (non-builtin) code system as a JSON file compatible with the upload format.
@@ -117,7 +117,7 @@ export declare class Construe {
      *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -132,7 +132,7 @@ export declare class Construe {
      *         version: "version"
      *     })
      */
-    exportCustomCodeSystem(codesystem: string, request?: phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExportCodeSystemResponse>;
+    exportCustomCodeSystem(codesystem: string, request?: phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExportCodeSystemResponse>;
     private __exportCustomCodeSystem;
     /**
      * Returns a paginated list of all codes in the specified code system from the terminology server.
@@ -141,7 +141,7 @@ export declare class Construe {
      *
      * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
      * @param {phenoml.construe.GetConstrueCodesCodesystemRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -155,7 +155,7 @@ export declare class Construe {
      *         limit: 1
      *     })
      */
-    listCodesInACodeSystem(codesystem: string, request?: phenoml.construe.GetConstrueCodesCodesystemRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodesResponse>;
+    listCodesInACodeSystem(codesystem: string, request?: phenoml.construe.GetConstrueCodesCodesystemRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodesResponse>;
     private __listCodesInACodeSystem;
     /**
      * Looks up a specific code in the terminology server and returns its details.
@@ -165,7 +165,7 @@ export declare class Construe {
      * @param {string} codesystem - Code system name
      * @param {string} codeID - The code identifier
      * @param {phenoml.construe.GetConstrueCodesCodesystemCodeIdRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -177,7 +177,7 @@ export declare class Construe {
      *         version: "version"
      *     })
      */
-    getASpecificCode(codesystem: string, codeID: string, request?: phenoml.construe.GetConstrueCodesCodesystemCodeIdRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeResponse>;
+    getASpecificCode(codesystem: string, codeID: string, request?: phenoml.construe.GetConstrueCodesCodesystemCodeIdRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeResponse>;
     private __getASpecificCode;
     /**
      * Performs semantic similarity search using vector embeddings.
@@ -202,7 +202,7 @@ export declare class Construe {
      *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -216,14 +216,14 @@ export declare class Construe {
      *         limit: 1
      *     })
      */
-    semanticSearchEmbeddingBased(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.SemanticSearchResponse>;
+    semanticSearchEmbeddingBased(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.SemanticSearchResponse>;
     private __semanticSearchEmbeddingBased;
     /**
      * Submits user feedback on results from the Construe extraction endpoint.
      * Feedback includes the full extraction result received and the result the user expected.
      *
      * @param {phenoml.construe.FeedbackRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -251,7 +251,7 @@ export declare class Construe {
      *         }
      *     })
      */
-    submitFeedbackOnExtractionResults(request: phenoml.construe.FeedbackRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.FeedbackResponse>;
+    submitFeedbackOnExtractionResults(request: phenoml.construe.FeedbackRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.FeedbackResponse>;
     private __submitFeedbackOnExtractionResults;
     /**
      * Performs fast full-text search over code IDs and descriptions.
@@ -281,7 +281,7 @@ export declare class Construe {
      *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest} request
-     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.construe.BadRequestError}
      * @throws {@link phenoml.construe.UnauthorizedError}
@@ -296,7 +296,6 @@ export declare class Construe {
      *         limit: 1
      *     })
      */
-    terminologyServerTextSearch(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
+    terminologyServerTextSearch(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
     private __terminologyServerTextSearch;
-    protected _getAuthorizationHeader(): Promise<string>;
 }