@opengovsg/refx-ts-sdk 0.0.0-develop-1748575737 → 0.0.0-develop-1749093103

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

@@ -38,6 +38,7 @@ export interface CreateReferralReq {
     senderInstitutionName: string;
     /** MCR number of the doctor authoring this referral. */
     doctorMcr: string;
+    referrerIdType?: ReferralExchange.ReferrerIdType;
     /** Name of the doctor authoring this referral. */
     doctorName: string;
     /** Email of the doctor authoring this referral. */

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

@@ -26,4 +26,20 @@ export interface ReferralsListRequest {
      * To filter by the institution's role in the referral. e.g. For outbound referrals, use "sender'
      */
     role?: ReferralExchange.ReferralRole;
+    /**
+     * To filter by the referrer ID
+     */
+    referrerId?: string;
+    /**
+     * Type of ID specified in referrerId. Use together with `referrerId` to filter based on referrer.
+     */
+    referrerIdType?: ReferralExchange.ReferrerIdType;
+    /**
+     * To filter by the requesting institution
+     */
+    institutionId?: string;
+    /**
+     * To filter by the patient UIN
+     */
+    patientUin?: string;
 }

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

@@ -69,7 +69,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ReferralExchangeEnvironment.SmartCms, "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": "0.0.0-develop-1748575737", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748575737", "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": "0.0.0-develop-1749093103", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1749093103", "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,
@@ -113,7 +113,7 @@ class Webhooks {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ReferralExchangeEnvironment.SmartCms, `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": "0.0.0-develop-1748575737", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748575737", "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": "0.0.0-develop-1749093103", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1749093103", "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/dist/api/types/FullReferralDto.d.ts

@@ -5,6 +5,7 @@ import * as ReferralExchange from "../index";
 export interface FullReferralDto {
     id: string;
     sender: ReferralExchange.InstitutionCoreDto;
+    senderSystem: ReferralExchange.System;
     offering: ReferralExchange.OfferingDto;
     patient: ReferralExchange.GetReferralPatientDto;
     referringDoctor: ReferralExchange.ReferringDoctorDto;

package/dist/api/types/OfferingDto.d.ts

@@ -16,4 +16,6 @@ export interface OfferingDto {
     /** Whether this offering supports subsidized referrals. */
     isSubsidisable: boolean;
     timeslotPolicy: ReferralExchange.TimeslotPolicy;
+    /** Category of the offering. Used to group offerings together. */
+    category?: ReferralExchange.OfferingDtoCategory;
 }

package/dist/api/types/OfferingDtoCategory.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Category of the offering. Used to group offerings together.
+ */
+export type OfferingDtoCategory = "aac service" | "befriending";
+export declare const OfferingDtoCategory: {
+    readonly AacService: "aac service";
+    readonly Befriending: "befriending";
+};

package/dist/api/types/OfferingDtoCategory.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfferingDtoCategory = void 0;
+exports.OfferingDtoCategory = {
+    AacService: "aac service",
+    Befriending: "befriending",
+};

package/dist/api/types/OfferingWithAllowedDto.d.ts

@@ -16,6 +16,8 @@ export interface OfferingWithAllowedDto {
     /** Whether this offering supports subsidized referrals. */
     isSubsidisable: boolean;
     timeslotPolicy: ReferralExchange.TimeslotPolicy;
+    /** Category of the offering. Used to group offerings together. */
+    category?: ReferralExchange.OfferingWithAllowedDtoCategory;
     /** Whether the offering is allowed based on the provided query parameters */
     isAllowed: boolean;
 }

package/dist/api/types/OfferingWithAllowedDtoCategory.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Category of the offering. Used to group offerings together.
+ */
+export type OfferingWithAllowedDtoCategory = "aac service" | "befriending";
+export declare const OfferingWithAllowedDtoCategory: {
+    readonly AacService: "aac service";
+    readonly Befriending: "befriending";
+};

package/dist/api/types/OfferingWithAllowedDtoCategory.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfferingWithAllowedDtoCategory = void 0;
+exports.OfferingWithAllowedDtoCategory = {
+    AacService: "aac service",
+    Befriending: "befriending",
+};

package/dist/api/types/PublicReferralDto.d.ts

@@ -5,6 +5,7 @@ import * as ReferralExchange from "../index";
 export interface PublicReferralDto {
     id: string;
     sender: ReferralExchange.InstitutionCoreDto;
+    senderSystem: ReferralExchange.System;
     offering: ReferralExchange.OfferingDto;
     patient: ReferralExchange.GetReferralPatientDto;
     referringDoctor: ReferralExchange.ReferringDoctorDto;

package/dist/api/types/ReferralDto.d.ts

@@ -5,6 +5,7 @@ import * as ReferralExchange from "../index";
 export interface ReferralDto {
     id: string;
     sender: ReferralExchange.InstitutionCoreDto;
+    senderSystem: ReferralExchange.System;
     offering: ReferralExchange.OfferingDto;
     patient: ReferralExchange.GetReferralPatientDto;
     referringDoctor: ReferralExchange.ReferringDoctorDto;

package/dist/api/types/ReferrerIdType.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Type of ID specified in referrerId. Use together with `referrerId` and `referrerInstitutionId` to filter based on referrer.
+ * Type of ID specified in referrerId.
  */
 export type ReferrerIdType = "mcr" | "nric" | "email";
 export declare const ReferrerIdType: {

package/dist/api/types/ReferringDoctorDto.d.ts

@@ -1,8 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as ReferralExchange from "../index";
 export interface ReferringDoctorDto {
     mcr: string;
+    idType: ReferralExchange.ReferrerIdType;
     name: string;
     email: string;
     contactNumber: string;

package/dist/api/types/index.d.ts

@@ -11,6 +11,7 @@ export * from "./ReferralRole";
 export * from "./InstitutionCoreDto";
 export * from "./System";
 export * from "./TimeslotPolicy";
+export * from "./OfferingDtoCategory";
 export * from "./OfferingDto";
 export * from "./GetReferralPatientDtoGender";
 export * from "./GetReferralPatientDto";
@@ -33,6 +34,7 @@ export * from "./FullReferralDtoStatus";
 export * from "./FullReferralDto";
 export * from "./CreatePatientReqGender";
 export * from "./CreatePatientReq";
+export * from "./OfferingWithAllowedDtoCategory";
 export * from "./OfferingWithAllowedDto";
 export * from "./Timeslot";
 export * from "./TriggerEmailReminderBody";

package/dist/api/types/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./ReferralRole"), exports);
 __exportStar(require("./InstitutionCoreDto"), exports);
 __exportStar(require("./System"), exports);
 __exportStar(require("./TimeslotPolicy"), exports);
+__exportStar(require("./OfferingDtoCategory"), exports);
 __exportStar(require("./OfferingDto"), exports);
 __exportStar(require("./GetReferralPatientDtoGender"), exports);
 __exportStar(require("./GetReferralPatientDto"), exports);
@@ -49,6 +50,7 @@ __exportStar(require("./FullReferralDtoStatus"), exports);
 __exportStar(require("./FullReferralDto"), exports);
 __exportStar(require("./CreatePatientReqGender"), exports);
 __exportStar(require("./CreatePatientReq"), exports);
+__exportStar(require("./OfferingWithAllowedDtoCategory"), exports);
 __exportStar(require("./OfferingWithAllowedDto"), exports);
 __exportStar(require("./Timeslot"), exports);
 __exportStar(require("./TriggerEmailReminderBody"), exports);

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-develop-1748575737";
+export declare const SDK_VERSION = "0.0.0-develop-1749093103";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.0-develop-1748575737";
+exports.SDK_VERSION = "0.0.0-develop-1749093103";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@opengovsg/refx-ts-sdk",
-    "version": "0.0.0-develop-1748575737",
+    "version": "0.0.0-develop-1749093103",
     "private": false,
     "repository": "https://github.com/opengovsg/refer-ts-sdk",
     "main": "./index.js",

package/reference.md

@@ -668,6 +668,57 @@ await client.offerings.list();
 </dl>
 </details>
 
+<details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">apiHoldingControllerGetRecommendedOffering</a>({ ...params }) -> ReferralExchange.OfferingDto</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.offerings.apiHoldingControllerGetRecommendedOffering({
+    category: "aac service",
+    postalCode: "postalCode",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ReferralExchange.ApiHoldingControllerGetRecommendedOfferingRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Offerings.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">listTimeslots</a>(offeringId, { ...params }) -> ReferralExchange.Timeslot[]</code></summary>
 <dl>
 <dd>
@@ -745,15 +796,8 @@ await client.links.createUpsertLink({
     referrerInstitutionId: "referrerInstitutionId",
     referrerInstitutionName: "referrerInstitutionName",
     referrerId: "referrerId",
+    referrerIdType: "mcr",
     referrerName: "referrerName",
-    referrerIdType: "referrerIdType",
-    referrerEmail: "referrerEmail",
-    referrerContactNumber: "referrerContactNumber",
-    patientUin: "patientUin",
-    patientName: "patientName",
-    patientPhoneNumber: "91234567",
-    patientDob: "1990-01-01",
-    patientGender: "Male",
 });
 ```
 

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-develop-1748575737";
+export declare const SDK_VERSION = "0.0.0-develop-1749093103";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.0-develop-1748575737";
+exports.SDK_VERSION = "0.0.0-develop-1749093103";