Merge pull request #63 from PhenoML/fern-bot/2026-02-09T15-51Z

gavinsharp · web-flow · commit 669e17ce95ac · 2026-02-09T13:05:59.000-05:00
feat: add custom code system export endpoint
diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,14 @@
+## 5.3.0 - 2026-02-09
+* feat: add custom code system export endpoint
+* Add new exportCustomCodeSystem method to the construe client that allows exporting custom (non-builtin) code systems as JSON files. This feature enables users to backup and transfer code systems between instances.
+* Key changes:
+* Add exportCustomCodeSystem method to Construe client with GET endpoint
+* Create ExportCodeSystemResponse type definition for structured export data
+* Add GetConstrueCodesSystemsCodesystemExportRequest for version parameter
+* Include comprehensive test coverage for all HTTP response codes
+* Remove ForbiddenError from fhirProvider.get method and related tests
+* 🌿 Generated with Fern
+
 ## 5.2.0 - 2026-02-08
 * feat: refactor upload request structure with format-specific types
 * Refactor the upload code system functionality to use a discriminated union approach with format-specific request types. This improves type safety and API clarity by separating CSV and JSON upload requirements.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "phenoml",
-    "version": "5.2.0",
+    "version": "5.3.0",
     "private": false,
     "repository": "github:PhenoML/phenoml-ts-sdk",
     "type": "commonjs",
diff --git a/reference.md b/reference.md
@@ -1478,6 +1478,81 @@ await client.construe.deleteCustomCodeSystem("CUSTOM_CODES", {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">exportCustomCodeSystem</a>(codesystem, { ...params }) -> phenoml.ExportCodeSystemResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Exports a custom (non-builtin) code system as a JSON file compatible with the upload format.
+The exported file can be re-uploaded directly via POST /construe/upload with format "json".
+Only available on dedicated instances. Builtin systems cannot be exported.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.exportCustomCodeSystem("CUSTOM_CODES", {
+    version: "version"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**codesystem:** `string` — Code system name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
diff --git a/src/Client.ts b/src/Client.ts
@@ -40,8 +40,8 @@ export class phenomlClient {
                 {
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "phenoml",
-                    "X-Fern-SDK-Version": "5.2.0",
-                    "User-Agent": "phenoml/5.2.0",
+                    "X-Fern-SDK-Version": "5.3.0",
+                    "User-Agent": "phenoml/5.3.0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
diff --git a/src/api/resources/construe/client/Client.ts b/src/api/resources/construe/client/Client.ts
@@ -534,6 +534,126 @@ export class Construe {
         }
     }
 
+    /**
+     * Exports a custom (non-builtin) code system as a JSON file compatible with the upload format.
+     * The exported file can be re-uploaded directly via POST /construe/upload with format "json".
+     * Only available on dedicated instances. Builtin systems cannot be exported.
+     *
+     * @param {string} codesystem - Code system name
+     * @param {phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest} request
+     * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.construe.BadRequestError}
+     * @throws {@link phenoml.construe.UnauthorizedError}
+     * @throws {@link phenoml.construe.ForbiddenError}
+     * @throws {@link phenoml.construe.NotFoundError}
+     * @throws {@link phenoml.construe.ConflictError}
+     * @throws {@link phenoml.construe.FailedDependencyError}
+     * @throws {@link phenoml.construe.InternalServerError}
+     *
+     * @example
+     *     await client.construe.exportCustomCodeSystem("CUSTOM_CODES", {
+     *         version: "version"
+     *     })
+     */
+    public exportCustomCodeSystem(
+        codesystem: string,
+        request: phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest = {},
+        requestOptions?: Construe.RequestOptions,
+    ): core.HttpResponsePromise<phenoml.construe.ExportCodeSystemResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__exportCustomCodeSystem(codesystem, request, requestOptions));
+    }
+
+    private async __exportCustomCodeSystem(
+        codesystem: string,
+        request: phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest = {},
+        requestOptions?: Construe.RequestOptions,
+    ): Promise<core.WithRawResponse<phenoml.construe.ExportCodeSystemResponse>> {
+        const { version } = request;
+        const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
+        if (version != null) {
+            _queryParams.version = version;
+        }
+
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({ Authorization: await this._getAuthorizationHeader() }),
+            requestOptions?.headers,
+        );
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.phenomlEnvironment.Default,
+                `construe/codes/systems/${core.url.encodePathParam(codesystem)}/export`,
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return {
+                data: _response.body as phenoml.construe.ExportCodeSystemResponse,
+                rawResponse: _response.rawResponse,
+            };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new phenoml.construe.BadRequestError(_response.error.body as unknown, _response.rawResponse);
+                case 401:
+                    throw new phenoml.construe.UnauthorizedError(
+                        _response.error.body as unknown,
+                        _response.rawResponse,
+                    );
+                case 403:
+                    throw new phenoml.construe.ForbiddenError(_response.error.body as unknown, _response.rawResponse);
+                case 404:
+                    throw new phenoml.construe.NotFoundError(_response.error.body as unknown, _response.rawResponse);
+                case 409:
+                    throw new phenoml.construe.ConflictError(_response.error.body as unknown, _response.rawResponse);
+                case 424:
+                    throw new phenoml.construe.FailedDependencyError(
+                        _response.error.body as unknown,
+                        _response.rawResponse,
+                    );
+                case 500:
+                    throw new phenoml.construe.InternalServerError(
+                        _response.error.body as unknown,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.phenomlError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.phenomlError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.phenomlTimeoutError(
+                    "Timeout exceeded when calling GET /construe/codes/systems/{codesystem}/export.",
+                );
+            case "unknown":
+                throw new errors.phenomlError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
     /**
      * Returns a paginated list of all codes in the specified code system from the terminology server.
      *
diff --git a/src/api/resources/construe/client/requests/GetConstrueCodesSystemsCodesystemExportRequest.ts b/src/api/resources/construe/client/requests/GetConstrueCodesSystemsCodesystemExportRequest.ts
@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         version: "version"
+ *     }
+ */
+export interface GetConstrueCodesSystemsCodesystemExportRequest {
+    /** Specific version of the code system. Required if multiple versions exist. */
+    version?: string;
+}
diff --git a/src/api/resources/construe/client/requests/index.ts b/src/api/resources/construe/client/requests/index.ts
@@ -4,4 +4,5 @@ export type { GetConstrueCodesCodesystemCodeIdRequest } from "./GetConstrueCodes
 export type { GetConstrueCodesCodesystemRequest } from "./GetConstrueCodesCodesystemRequest.js";
 export type { GetConstrueCodesCodesystemSearchSemanticRequest } from "./GetConstrueCodesCodesystemSearchSemanticRequest.js";
 export type { GetConstrueCodesCodesystemSearchTextRequest } from "./GetConstrueCodesCodesystemSearchTextRequest.js";
+export type { GetConstrueCodesSystemsCodesystemExportRequest } from "./GetConstrueCodesSystemsCodesystemExportRequest.js";
 export type { GetConstrueCodesSystemsCodesystemRequest } from "./GetConstrueCodesSystemsCodesystemRequest.js";
diff --git a/src/api/resources/construe/types/ExportCodeSystemResponse.ts b/src/api/resources/construe/types/ExportCodeSystemResponse.ts
@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as phenoml from "../../../index.js";
+
+export interface ExportCodeSystemResponse {
+    /** Code system name */
+    name: string;
+    /** Code system version */
+    version: string;
+    /** Upload format (always "json") */
+    format: "json";
+    /** All codes in the system */
+    codes: phenoml.construe.CodeResponse[];
+}
diff --git a/src/api/resources/construe/types/index.ts b/src/api/resources/construe/types/index.ts
@@ -4,6 +4,7 @@ export * from "./CodeSystemDetails.js";
 export * from "./CodeSystemInfo.js";
 export * from "./ConstrueUploadCodeSystemResponse.js";
 export * from "./DeleteCodeSystemResponse.js";
+export * from "./ExportCodeSystemResponse.js";
 export * from "./ExtractCodesResult.js";
 export * from "./ExtractedCodeResult.js";
 export * from "./ExtractRequestConfig.js";
diff --git a/src/api/resources/fhirProvider/client/Client.ts b/src/api/resources/fhirProvider/client/Client.ts
@@ -226,7 +226,6 @@ export class FhirProvider {
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.fhirProvider.UnauthorizedError}
-     * @throws {@link phenoml.fhirProvider.ForbiddenError}
      * @throws {@link phenoml.fhirProvider.NotFoundError}
      * @throws {@link phenoml.fhirProvider.InternalServerError}
      *
@@ -277,11 +276,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 404:
                     throw new phenoml.fhirProvider.NotFoundError(
                         _response.error.body as unknown,
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const SDK_VERSION = "5.2.0";
+export const SDK_VERSION = "5.3.0";
diff --git a/tests/wire/construe/main.test.ts b/tests/wire/construe/main.test.ts
diff --git a/tests/wire/fhir_provider/main.test.ts b/tests/wire/fhir_provider/main.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "phenoml",`
`3`		`- "version": "5.2.0",`
	`3`	`+ "version": "5.3.0",`
`4`	`4`	`"private": false,`
`5`	`5`	`"repository": "github:PhenoML/phenoml-ts-sdk",`
`6`	`6`	`"type": "commonjs",`