@opengovsg/refx-ts-sdk 2024.10.3 → 2025.2.20

package/api/resources/referrals/client/Client.js

@@ -39,11 +39,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Referrals = void 0;
+const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class Referrals {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -56,10 +57,16 @@ class Referrals {
      *     })
      */
     list(request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { hciCode, status, role, offset, pageSize } = request;
+            const { offset, pageSize, hciCode, status, role } = request;
             const _queryParams = {};
+            if (offset != null) {
+                _queryParams["offset"] = offset.toString();
+            }
+            if (pageSize != null) {
+                _queryParams["pageSize"] = pageSize.toString();
+            }
             _queryParams["hciCode"] = hciCode;
             if (status != null) {
                 if (Array.isArray(status)) {
@@ -72,16 +79,10 @@ class Referrals {
             if (role != null) {
                 _queryParams["role"] = role;
             }
-            if (offset != null) {
-                _queryParams["offset"] = JSON.stringify(offset);
-            }
-            if (pageSize != null) {
-                _queryParams["pageSize"] = JSON.stringify(pageSize);
-            }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), "api/v1/referrals"),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, "api/v1/referrals"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -133,25 +134,23 @@ class Referrals {
      *         doctorName: "doctorName",
      *         doctorEmail: "doctorEmail",
      *         doctorContactNumber: "doctorContactNumber",
-     *         isSubsidised: {
-     *             "key": "value"
-     *         },
-     *         isUrgent: {
-     *             "key": "value"
-     *         },
-     *         isDraft: {
-     *             "key": "value"
-     *         },
-     *         formResponses: [{}]
+     *         isSubsidised: true,
+     *         isUrgent: true,
+     *         isDraft: true,
+     *         formResponses: [{
+     *                 question: "question",
+     *                 id: "id",
+     *                 answer: "answer"
+     *             }]
      *     })
      */
     upsert(request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), "api/v1/referrals"),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, "api/v1/referrals"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: request,
@@ -184,20 +183,27 @@ class Referrals {
         });
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.ReferralsGetRequest} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.referrals.get("referralId")
      */
-    get(referralId, requestOptions) {
-        var _a;
+    get(referralId, request = {}, requestOptions) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            const { includeAttachments } = request;
+            const _queryParams = {};
+            if (includeAttachments != null) {
+                _queryParams["includeAttachments"] = includeAttachments.toString();
+            }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/referrals/${encodeURIComponent(referralId)}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
+                queryParameters: _queryParams,
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -228,19 +234,19 @@ class Referrals {
         });
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.referrals.delete("referralId")
      */
     delete(referralId, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/referrals/${encodeURIComponent(referralId)}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -272,7 +278,7 @@ class Referrals {
         });
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.CancelReferralReq} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -280,12 +286,12 @@ class Referrals {
      *     await client.referrals.cancel("referralId")
      */
     cancel(referralId, request = {}, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/referrals/${encodeURIComponent(referralId)}/cancel`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}/cancel`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: request,
@@ -318,7 +324,7 @@ class Referrals {
         });
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.AmendReferralReq} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -328,12 +334,12 @@ class Referrals {
      *     })
      */
     amend(referralId, request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/referrals/${encodeURIComponent(referralId)}/amend`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}/amend`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: request,
@@ -366,7 +372,7 @@ class Referrals {
         });
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.EaConfirmReferralBody} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -376,12 +382,12 @@ class Referrals {
      *     })
      */
     accept(referralId, request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/referrals/${encodeURIComponent(referralId)}/accept/ea`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}/accept/ea`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: request,
@@ -414,7 +420,7 @@ class Referrals {
         });
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.EaRejectReferralBody} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -424,12 +430,12 @@ class Referrals {
      *     })
      */
     reject(referralId, request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/referrals/${encodeURIComponent(referralId)}/reject/ea`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}/reject/ea`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: request,
@@ -461,6 +467,50 @@ class Referrals {
             }
         });
     }
+    /**
+     * @param {string} referralId - Referral ID
+     * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.referrals.backToDraft("referralId")
+     */
+    backToDraft(referralId, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/referrals/${encodeURIComponent(referralId)}/back-to-draft`),
+                method: "POST",
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return _response.body;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.ReferralExchangeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ReferralExchangeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.ReferralExchangeTimeoutError("Timeout exceeded when calling POST /api/v1/referrals/{referralId}/back-to-draft.");
+                case "unknown":
+                    throw new errors.ReferralExchangeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

package/api/resources/referrals/client/requests/CreateReferralReq.d.ts

@@ -19,16 +19,14 @@ import * as ReferralExchange from "../../../../index";
  *         doctorName: "doctorName",
  *         doctorEmail: "doctorEmail",
  *         doctorContactNumber: "doctorContactNumber",
- *         isSubsidised: {
- *             "key": "value"
- *         },
- *         isUrgent: {
- *             "key": "value"
- *         },
- *         isDraft: {
- *             "key": "value"
- *         },
- *         formResponses: [{}]
+ *         isSubsidised: true,
+ *         isUrgent: true,
+ *         isDraft: true,
+ *         formResponses: [{
+ *                 question: "question",
+ *                 id: "id",
+ *                 answer: "answer"
+ *             }]
  *     }
  */
 export interface CreateReferralReq {
@@ -46,10 +44,10 @@ export interface CreateReferralReq {
     doctorEmail: string;
     /** Contact number of the doctor authoring this referral. */
     doctorContactNumber: string;
-    isSubsidised: Record<string, unknown>;
-    isUrgent: Record<string, unknown>;
+    isSubsidised: boolean;
+    isUrgent: boolean;
     /** In draft state, further edits can be made. No referral will be emitted to the service provider yet. */
-    isDraft: Record<string, unknown>;
+    isDraft: boolean;
     /** Referral ID */
     id?: string;
     /** Timeslot start time, in milliseconds since epoch. */

package/api/resources/referrals/client/requests/ReferralsGetRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ReferralsGetRequest {
+    includeAttachments?: boolean;
+}

package/api/resources/referrals/client/requests/ReferralsListRequest.d.ts

@@ -10,20 +10,20 @@ import * as ReferralExchange from "../../../../index";
  */
 export interface ReferralsListRequest {
     /**
-     * To identify the requesting institution
+     * Offset for pagination
      */
-    hciCode: string;
-    status?: ReferralExchange.ReferralsListRequestStatusItem | ReferralExchange.ReferralsListRequestStatusItem[];
+    offset?: number;
     /**
-     * To filter by the institution's role in the referral. e.g. For outbound referrals, use "sender'
+     * Number of items per page
      */
-    role?: ReferralExchange.ReferralsListRequestRole;
+    pageSize?: number;
     /**
-     * Offset for pagination
+     * To identify the requesting institution
      */
-    offset?: Record<string, unknown>;
+    hciCode: string;
+    status?: ReferralExchange.ReferralStatusFilter | ReferralExchange.ReferralStatusFilter[];
     /**
-     * Number of items per page
+     * To filter by the institution's role in the referral. e.g. For outbound referrals, use "sender'
      */
-    pageSize?: Record<string, unknown>;
+    role?: ReferralExchange.ReferralRole;
 }

package/api/resources/referrals/client/requests/index.d.ts

@@ -1,5 +1,6 @@
 export { type ReferralsListRequest } from "./ReferralsListRequest";
 export { type CreateReferralReq } from "./CreateReferralReq";
+export { type ReferralsGetRequest } from "./ReferralsGetRequest";
 export { type CancelReferralReq } from "./CancelReferralReq";
 export { type AmendReferralReq } from "./AmendReferralReq";
 export { type EaConfirmReferralBody } from "./EaConfirmReferralBody";

package/api/resources/referrals/index.d.ts

@@ -1,2 +1 @@
-export * from "./types";
 export * from "./client";

package/api/resources/referrals/index.js

@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);

package/api/resources/webhooks/client/Client.d.ts

@@ -1,10 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 export declare namespace Webhooks {
     interface Options {
-        environment: core.Supplier<string>;
+        environment?: core.Supplier<environments.ReferralExchangeEnvironment | string>;
         apiKey?: core.Supplier<string | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -21,22 +22,22 @@ export declare namespace Webhooks {
 }
 export declare class Webhooks {
     protected readonly _options: Webhooks.Options;
-    constructor(_options: Webhooks.Options);
+    constructor(_options?: Webhooks.Options);
     /**
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.webhooks.handleSinghealthProfile()
+     *     await client.webhooks.submitSingHealthFormsg()
      */
-    handleSinghealthProfile(requestOptions?: Webhooks.RequestOptions): Promise<void>;
+    submitSingHealthFormsg(requestOptions?: Webhooks.RequestOptions): Promise<void>;
     /**
      * @param {string} formId
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.webhooks.handleDoctorNotes("formId")
+     *     await client.webhooks.submitFormsg("formId")
      */
-    handleDoctorNotes(formId: string, requestOptions?: Webhooks.RequestOptions): Promise<void>;
+    submitFormsg(formId: string, requestOptions?: Webhooks.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;

package/api/resources/webhooks/client/Client.js

@@ -39,26 +39,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Webhooks = void 0;
+const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class Webhooks {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.webhooks.handleSinghealthProfile()
+     *     await client.webhooks.submitSingHealthFormsg()
      */
-    handleSinghealthProfile(requestOptions) {
-        var _a;
+    submitSingHealthFormsg(requestOptions) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), "api/v1/webhooks/formsg/singhealth-profile"),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, "api/v1/webhooks/formsg/singhealth-profile"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -94,15 +95,15 @@ class Webhooks {
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.webhooks.handleDoctorNotes("formId")
+     *     await client.webhooks.submitFormsg("formId")
      */
-    handleDoctorNotes(formId, requestOptions) {
-        var _a;
+    submitFormsg(formId, requestOptions) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)(yield core.Supplier.get(this._options.environment), `api/v1/webhooks/formsg/form-submission/${encodeURIComponent(formId)}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `api/v1/webhooks/formsg/form-submission/${encodeURIComponent(formId)}`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2024.10.3", "User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "2025.2.20", "User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/types/AttachmentDto.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AttachmentDto {
+    url: string;
+    /** Human readable - include extension */
+    name: string;
+}

package/api/types/CreatePatientReq.d.ts

@@ -3,7 +3,7 @@
  */
 import * as ReferralExchange from "../index";
 export interface CreatePatientReq {
-    /** Patient UIN */
+    /** Patient UIN, e.g. NRIC or FIN */
     uin: string;
     /** Patient name */
     name: string;

package/api/types/Form.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface Form {
+    id: string;
+    url: string;
+    description: string;
+    isFilled: boolean;
+    formResponses: ReferralExchange.FormResponse[];
+}

package/api/types/FormResponse.d.ts

@@ -1,5 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as ReferralExchange from "../index";
 export interface FormResponse {
+    question: string;
+    id: string;
+    answer: ReferralExchange.FormResponseAnswer;
 }

package/{dist/api/types/CancelledEventMetadata.d.ts → api/types/FormResponseAnswer.d.ts}

@@ -1,6 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface CancelledEventMetadata {
-    cancelledByName: string;
-}
+export declare type FormResponseAnswer = string | string[] | number;

package/api/types/FullReferralDto.d.ts

@@ -5,19 +5,22 @@ import * as ReferralExchange from "../index";
 export interface FullReferralDto {
     id: string;
     sender: ReferralExchange.InstitutionCoreDto;
-    offering: ReferralExchange.OfferingFullDto;
+    offering: ReferralExchange.OfferingDto;
     patient: ReferralExchange.GetReferralPatientDto;
-    referringDoctor: ReferralExchange.FullReferralDtoReferringDoctor;
+    referringDoctor: ReferralExchange.ReferringDoctorDto;
     isSubsidised: boolean;
     isUrgent: boolean;
     /** Created at (ISO datetime) */
     createdAt: string;
     formResponses: ReferralExchange.FormResponse[];
+    /** Form ID of the referral form */
+    formId?: string;
+    /** List of forms required to complete the referral */
+    forms?: ReferralExchange.Form[];
+    attachments: ReferralExchange.AttachmentDto[];
     status: ReferralExchange.FullReferralDtoStatus;
     /** Timeslot start time (ISO datetime) */
     timeslotStartAt?: string;
-    /** TODO - do not use this, will be removed */
-    rejectionReason?: string;
     notes: ReferralExchange.NoteDto[];
     /** URL of the FormSG required to complete the referral */
     formUrl?: string;

package/api/types/FullReferralDtoStatus.d.ts

@@ -1,17 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type FullReferralDtoStatus = "draft" | "created" | "processing-has" | "processing-pb" | "processing-ea" | "pending-singhealth-formsg" | "pending-singhealth-call-centre" | "referral-confirmed-pending-appt" | "pending-email-ack" | "pending-amend-timeslot" | "confirmed" | "rejected" | "failed" | "pending-cancelled" | "cancelled";
+export declare type FullReferralDtoStatus = "draft" | "created" | "processing-has" | "processing-pb" | "processing-ea" | "processing-bright" | "pending-singhealth-formsg" | "pending-singhealth-call-centre" | "referral-confirmed-pending-appt" | "pending-email-ack" | "submitted-to-bright" | "pending-amend-timeslot" | "confirmed" | "rejected" | "failed" | "pending-cancelled" | "cancelled";
 export declare const FullReferralDtoStatus: {
     readonly Draft: "draft";
     readonly Created: "created";
     readonly ProcessingHas: "processing-has";
     readonly ProcessingPb: "processing-pb";
     readonly ProcessingEa: "processing-ea";
+    readonly ProcessingBright: "processing-bright";
     readonly PendingSinghealthFormsg: "pending-singhealth-formsg";
     readonly PendingSinghealthCallCentre: "pending-singhealth-call-centre";
     readonly ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt";
     readonly PendingEmailAck: "pending-email-ack";
+    readonly SubmittedToBright: "submitted-to-bright";
     readonly PendingAmendTimeslot: "pending-amend-timeslot";
     readonly Confirmed: "confirmed";
     readonly Rejected: "rejected";

package/api/types/FullReferralDtoStatus.js

@@ -10,10 +10,12 @@ exports.FullReferralDtoStatus = {
     ProcessingHas: "processing-has",
     ProcessingPb: "processing-pb",
     ProcessingEa: "processing-ea",
+    ProcessingBright: "processing-bright",
     PendingSinghealthFormsg: "pending-singhealth-formsg",
     PendingSinghealthCallCentre: "pending-singhealth-call-centre",
     ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt",
     PendingEmailAck: "pending-email-ack",
+    SubmittedToBright: "submitted-to-bright",
     PendingAmendTimeslot: "pending-amend-timeslot",
     Confirmed: "confirmed",
     Rejected: "rejected",

package/api/types/GetReferralPatientDto.d.ts

@@ -3,7 +3,7 @@
  */
 import * as ReferralExchange from "../index";
 export interface GetReferralPatientDto {
-    /** Patient UIN */
+    /** Patient UIN, e.g. NRIC or FIN */
     uin: string;
     /** Patient name */
     name: string;