@opengovsg/refx-ts-sdk 2024.10.3 → 2025.2.20

package/index.js

@@ -23,10 +23,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReferralExchangeTimeoutError = exports.ReferralExchangeError = exports.ReferralExchangeClient = exports.ReferralExchange = void 0;
+exports.ReferralExchangeTimeoutError = exports.ReferralExchangeError = exports.ReferralExchangeEnvironment = exports.ReferralExchangeClient = exports.ReferralExchange = void 0;
 exports.ReferralExchange = __importStar(require("./api"));
 var Client_1 = require("./Client");
 Object.defineProperty(exports, "ReferralExchangeClient", { enumerable: true, get: function () { return Client_1.ReferralExchangeClient; } });
+var environments_1 = require("./environments");
+Object.defineProperty(exports, "ReferralExchangeEnvironment", { enumerable: true, get: function () { return environments_1.ReferralExchangeEnvironment; } });
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "ReferralExchangeError", { enumerable: true, get: function () { return errors_1.ReferralExchangeError; } });
 Object.defineProperty(exports, "ReferralExchangeTimeoutError", { enumerable: true, get: function () { return errors_1.ReferralExchangeTimeoutError; } });

package/package.json

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

package/reference.md

@@ -133,16 +133,16 @@ await client.referrals.upsert({
     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",
+        },
+    ],
 });
 ```
 
@@ -178,7 +178,7 @@ await client.referrals.upsert({
 </dl>
 </details>
 
-<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">get</a>(referralId) -> ReferralExchange.FullReferralDto</code></summary>
+<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">get</a>(referralId, { ...params }) -> ReferralExchange.FullReferralDto</code></summary>
 <dl>
 <dd>
 
@@ -207,7 +207,15 @@ await client.referrals.get("referralId");
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ReferralExchange.ReferralsGetRequest`
 
 </dd>
 </dl>
@@ -255,7 +263,7 @@ await client.referrals.delete("referralId");
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
 
 </dd>
 </dl>
@@ -303,7 +311,7 @@ await client.referrals.cancel("referralId");
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
 
 </dd>
 </dl>
@@ -361,7 +369,7 @@ await client.referrals.amend("referralId", {
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
 
 </dd>
 </dl>
@@ -419,7 +427,7 @@ await client.referrals.accept("referralId", {
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
 
 </dd>
 </dl>
@@ -477,7 +485,7 @@ await client.referrals.reject("referralId", {
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
 
 </dd>
 </dl>
@@ -504,9 +512,7 @@ await client.referrals.reject("referralId", {
 </dl>
 </details>
 
-## Offerings
-
-<details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">list</a>() -> ReferralExchange.OfferingCoreDto[]</code></summary>
+<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">backToDraft</a>(referralId) -> ReferralExchange.ReferralDto</code></summary>
 <dl>
 <dd>
 
@@ -519,7 +525,7 @@ await client.referrals.reject("referralId", {
 <dd>
 
 ```typescript
-await client.offerings.list();
+await client.referrals.backToDraft("referralId");
 ```
 
 </dd>
@@ -535,7 +541,15 @@ await client.offerings.list();
 <dl>
 <dd>
 
-**requestOptions:** `Offerings.RequestOptions`
+**referralId:** `string` — Referral ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Referrals.RequestOptions`
 
 </dd>
 </dl>
@@ -546,7 +560,9 @@ await client.offerings.list();
 </dl>
 </details>
 
-<details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">get</a>(offeringId) -> ReferralExchange.OfferingFullDto</code></summary>
+## Notes
+
+<details><summary><code>client.notes.<a href="/src/api/resources/notes/client/Client.ts">create</a>(referralId, { ...params }) -> ReferralExchange.NoteDto</code></summary>
 <dl>
 <dd>
 
@@ -559,7 +575,9 @@ await client.offerings.list();
 <dd>
 
 ```typescript
-await client.offerings.get("offeringId");
+await client.notes.create("referralId", {
+    authorHciCode: "authorHciCode",
+});
 ```
 
 </dd>
@@ -575,7 +593,15 @@ await client.offerings.get("offeringId");
 <dl>
 <dd>
 
-**offeringId:** `string`
+**referralId:** `string` — Referral ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ReferralExchange.CreateNoteReq`
 
 </dd>
 </dl>
@@ -583,6 +609,48 @@ await client.offerings.get("offeringId");
 <dl>
 <dd>
 
+**requestOptions:** `Notes.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Offerings
+
+<details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">list</a>() -> ReferralExchange.OfferingDto[]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.offerings.list();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
 **requestOptions:** `Offerings.RequestOptions`
 
 </dd>
@@ -609,6 +677,7 @@ await client.offerings.get("offeringId");
 ```typescript
 await client.offerings.listTimeslots("offeringId", {
     from: 1.1,
+    isSubsidised: true,
 });
 ```
 
@@ -654,7 +723,7 @@ await client.offerings.listTimeslots("offeringId", {
 
 ## Public
 
-<details><summary><code>client.public.<a href="/src/api/resources/public/client/Client.ts">getReferral</a>(referralId) -> ReferralExchange.PublicReferralDto[]</code></summary>
+<details><summary><code>client.public.<a href="/src/api/resources/public/client/Client.ts">getReferral</a>(referralId, { ...params }) -> ReferralExchange.PublicReferralDto</code></summary>
 <dl>
 <dd>
 
@@ -683,7 +752,15 @@ await client.public.getReferral("referralId");
 <dl>
 <dd>
 
-**referralId:** `string`
+**referralId:** `string` — Referral ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ReferralExchange.PublicGetReferralRequest`
 
 </dd>
 </dl>
@@ -704,7 +781,7 @@ await client.public.getReferral("referralId");
 
 ## Webhooks
 
-<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">handleSinghealthProfile</a>() -> void</code></summary>
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">submitSingHealthFormsg</a>() -> void</code></summary>
 <dl>
 <dd>
 
@@ -717,7 +794,7 @@ await client.public.getReferral("referralId");
 <dd>
 
 ```typescript
-await client.webhooks.handleSinghealthProfile();
+await client.webhooks.submitSingHealthFormsg();
 ```
 
 </dd>
@@ -744,7 +821,7 @@ await client.webhooks.handleSinghealthProfile();
 </dl>
 </details>
 
-<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">handleDoctorNotes</a>(formId) -> void</code></summary>
+<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">submitFormsg</a>(formId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -757,7 +834,7 @@ await client.webhooks.handleSinghealthProfile();
 <dd>
 
 ```typescript
-await client.webhooks.handleDoctorNotes("formId");
+await client.webhooks.submitFormsg("formId");
 ```
 
 </dd>

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2024.10.3";
+export declare const SDK_VERSION = "2025.2.20";

package/version.js

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

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

@@ -1,2 +0,0 @@
-export * from "./ReferralsListRequestStatusItem";
-export * from "./ReferralsListRequestRole";

package/api/types/CreatedEventMetadata.d.ts

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CreatedEventMetadata {
-    appointmentTime?: Record<string, unknown>;
-}

package/api/types/EaReminderSentMetadata.d.ts

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface EaReminderSentMetadata {
-    destinationEmail: string;
-}

package/api/types/FullReferralDtoReferringDoctor.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface FullReferralDtoReferringDoctor {
-    mcr?: string;
-    name?: string;
-    email?: string;
-    contactNumber?: string;
-}

package/api/types/NoteCreatedMetadata.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface NoteCreatedMetadata {
-    noteId: string;
-    authorHciCode: string;
-    systemUserIdentifier?: string;
-}

package/api/types/OfferingCoreDto.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
-export interface OfferingCoreDto {
-    id: string;
-    /** Name of the offering - use these as labels */
-    name: string;
-    institutionHciCode: string;
-    institution: ReferralExchange.InstitutionCoreDto;
-    /** TODO - do not use this field right now */
-    specialty: string;
-    /** Whether the offering is able to receive new referrals currently */
-    isActive: Record<string, unknown>;
-}

package/api/types/PublicReferralDtoReferringDoctor.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface PublicReferralDtoReferringDoctor {
-    mcr?: string;
-    name?: string;
-    email?: string;
-    contactNumber?: string;
-}

package/api/types/ReferralAmendedMetadata.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ReferralAmendedMetadata {
-    before: Record<string, unknown>;
-    after: Record<string, unknown>;
-}

package/api/types/ReferralDtoReferringDoctor.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ReferralDtoReferringDoctor {
-    mcr?: string;
-    name?: string;
-    email?: string;
-    contactNumber?: string;
-}

package/api/types/RejectedEventMetadata.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface RejectedEventMetadata {
-    rejectionCode?: string;
-    rejectionMessage?: string;
-}

package/api/types/RescheduleEventMetadata.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface RescheduleEventMetadata {
-    appointmentTime: number;
-    previousAppointmentTime?: Record<string, unknown>;
-    systemUserIdentifier?: Record<string, unknown>;
-}

package/api/types/SingHealthPatientDetailsMetadata.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface SingHealthPatientDetailsMetadata {
-    submissionId: string;
-    content: Record<string, unknown>;
-}

package/api/types/TimelineEventDtoMetadata.d.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
-export declare type TimelineEventDtoMetadata = ReferralExchange.CreatedEventMetadata | ReferralExchange.RejectedEventMetadata | ReferralExchange.NoteCreatedMetadata | ReferralExchange.RescheduleEventMetadata | ReferralExchange.SingHealthPatientDetailsMetadata | ReferralExchange.CancelledEventMetadata | ReferralExchange.ReferralAmendedMetadata | ReferralExchange.EaReminderSentMetadata;

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

@@ -1,2 +0,0 @@
-export * from "./ReferralsListRequestStatusItem";
-export * from "./ReferralsListRequestRole";

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CreatedEventMetadata {
-    appointmentTime?: Record<string, unknown>;
-}

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

@@ -1,6 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface EaReminderSentMetadata {
-    destinationEmail: string;
-}

package/dist/api/types/EaReminderSentMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface FullReferralDtoReferringDoctor {
-    mcr?: string;
-    name?: string;
-    email?: string;
-    contactNumber?: string;
-}

package/dist/api/types/FullReferralDtoReferringDoctor.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface NoteCreatedMetadata {
-    noteId: string;
-    authorHciCode: string;
-    systemUserIdentifier?: string;
-}

package/dist/api/types/NoteCreatedMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
-export interface OfferingCoreDto {
-    id: string;
-    /** Name of the offering - use these as labels */
-    name: string;
-    institutionHciCode: string;
-    institution: ReferralExchange.InstitutionCoreDto;
-    /** TODO - do not use this field right now */
-    specialty: string;
-    /** Whether the offering is able to receive new referrals currently */
-    isActive: Record<string, unknown>;
-}

package/dist/api/types/OfferingCoreDto.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/OfferingFullDto.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface PublicReferralDtoReferringDoctor {
-    mcr?: string;
-    name?: string;
-    email?: string;
-    contactNumber?: string;
-}

package/dist/api/types/PublicReferralDtoReferringDoctor.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ReferralAmendedMetadata {
-    before: Record<string, unknown>;
-    after: Record<string, unknown>;
-}

package/dist/api/types/ReferralAmendedMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ReferralDtoReferringDoctor {
-    mcr?: string;
-    name?: string;
-    email?: string;
-    contactNumber?: string;
-}

package/dist/api/types/ReferralDtoReferringDoctor.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface RejectedEventMetadata {
-    rejectionCode?: string;
-    rejectionMessage?: string;
-}

package/dist/api/types/RejectedEventMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface RescheduleEventMetadata {
-    appointmentTime: number;
-    previousAppointmentTime?: Record<string, unknown>;
-    systemUserIdentifier?: Record<string, unknown>;
-}

package/dist/api/types/RescheduleEventMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface SingHealthPatientDetailsMetadata {
-    submissionId: string;
-    content: Record<string, unknown>;
-}

package/dist/api/types/SingHealthPatientDetailsMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
-export declare type TimelineEventDtoMetadata = ReferralExchange.CreatedEventMetadata | ReferralExchange.RejectedEventMetadata | ReferralExchange.NoteCreatedMetadata | ReferralExchange.RescheduleEventMetadata | ReferralExchange.SingHealthPatientDetailsMetadata | ReferralExchange.CancelledEventMetadata | ReferralExchange.ReferralAmendedMetadata | ReferralExchange.EaReminderSentMetadata;

package/dist/api/types/TimelineEventDtoMetadata.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });