@opengovsg/refx-ts-sdk 0.0.0-develop-alpha-1763535866 → 0.0.0-develop-alpha-1772437212

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

@@ -6,4 +6,6 @@ export interface Timeslot {
     from: number;
     /** End time in milliseconds since epoch */
     to: number;
+    /** Optional description of the timeslot */
+    description?: string;
 }

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

@@ -28,12 +28,13 @@ export * from "./ReferralDto";
 export * from "./PaginatedQuery";
 export * from "./PaginationMetadata";
 export * from "./PaginatedReferralsDto";
+export * from "./InstitutionIdType";
 export * from "./AdditionalReferralField";
 export * from "./TimelineEventType";
 export * from "./TimelineEventDtoSystem";
 export * from "./TimelineEventDto";
-export * from "./ReferralLinkType";
-export * from "./ReferralLinkDto";
+export * from "./ReferralActionLinkType";
+export * from "./ReferralActionLinkDto";
 export * from "./AppointmentDtoStatus";
 export * from "./AppointmentDto";
 export * from "./FullReferralDtoClinicType";
@@ -42,12 +43,17 @@ export * from "./FullReferralDto";
 export * from "./CreatePatientReqGender";
 export * from "./CreatePatientReqResidentialStatus";
 export * from "./CreatePatientReq";
+export * from "./CreateReferrerReq";
+export * from "./ReferrerStatusDto";
+export * from "./GetReferrersRes";
 export * from "./OfferingWithAllowedDto";
 export * from "./Timeslot";
 export * from "./UpdateEmailAckOfferingReq";
 export * from "./TriggerEmailReminderBody";
 export * from "./FormMetadata";
 export * from "./CreateReferralFormReq";
+export * from "./ReferralUpsertLinkType";
+export * from "./ReferralUpsertLinkDto";
 export * from "./PublicReferralDtoClinicType";
 export * from "./PublicReferralDto";
 export * from "./UpdateAacReq";

package/dist/api/types/index.js

@@ -44,12 +44,13 @@ __exportStar(require("./ReferralDto"), exports);
 __exportStar(require("./PaginatedQuery"), exports);
 __exportStar(require("./PaginationMetadata"), exports);
 __exportStar(require("./PaginatedReferralsDto"), exports);
+__exportStar(require("./InstitutionIdType"), exports);
 __exportStar(require("./AdditionalReferralField"), exports);
 __exportStar(require("./TimelineEventType"), exports);
 __exportStar(require("./TimelineEventDtoSystem"), exports);
 __exportStar(require("./TimelineEventDto"), exports);
-__exportStar(require("./ReferralLinkType"), exports);
-__exportStar(require("./ReferralLinkDto"), exports);
+__exportStar(require("./ReferralActionLinkType"), exports);
+__exportStar(require("./ReferralActionLinkDto"), exports);
 __exportStar(require("./AppointmentDtoStatus"), exports);
 __exportStar(require("./AppointmentDto"), exports);
 __exportStar(require("./FullReferralDtoClinicType"), exports);
@@ -58,12 +59,17 @@ __exportStar(require("./FullReferralDto"), exports);
 __exportStar(require("./CreatePatientReqGender"), exports);
 __exportStar(require("./CreatePatientReqResidentialStatus"), exports);
 __exportStar(require("./CreatePatientReq"), exports);
+__exportStar(require("./CreateReferrerReq"), exports);
+__exportStar(require("./ReferrerStatusDto"), exports);
+__exportStar(require("./GetReferrersRes"), exports);
 __exportStar(require("./OfferingWithAllowedDto"), exports);
 __exportStar(require("./Timeslot"), exports);
 __exportStar(require("./UpdateEmailAckOfferingReq"), exports);
 __exportStar(require("./TriggerEmailReminderBody"), exports);
 __exportStar(require("./FormMetadata"), exports);
 __exportStar(require("./CreateReferralFormReq"), exports);
+__exportStar(require("./ReferralUpsertLinkType"), exports);
+__exportStar(require("./ReferralUpsertLinkDto"), exports);
 __exportStar(require("./PublicReferralDtoClinicType"), exports);
 __exportStar(require("./PublicReferralDto"), exports);
 __exportStar(require("./UpdateAacReq"), exports);

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-develop-alpha-1763450943";
+export declare const SDK_VERSION = "0.0.0-develop-alpha-1772437212";

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-alpha-1763450943";
+exports.SDK_VERSION = "0.0.0-develop-alpha-1772437212";

package/package.json

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

package/reference.md

@@ -179,6 +179,70 @@ await client.referrals.upsert({
 </dl>
 </details>
 
+<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">listByInstitution</a>(institutionIdType, institutionId, { ...params }) -> ReferralExchange.PaginatedReferralsDto</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.referrals.listByInstitution("hci", "institutionId");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**institutionIdType:** `ReferralExchange.InstitutionIdType` — The type of institution ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**institutionId:** `string` — The institution ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ReferralExchange.ReferralsListByInstitutionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Referrals.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">get</a>(referralId, { ...params }) -> ReferralExchange.FullReferralDto</code></summary>
 <dl>
 <dd>
@@ -192,7 +256,11 @@ await client.referrals.upsert({
 <dd>
 
 ```typescript
-await client.referrals.get("referralId");
+await client.referrals.get("referralId", {
+    requesterIdentifier: "requester@example.com",
+    institutionIdType: "hci",
+    institutionId: "institutionId",
+});
 ```
 
 </dd>
@@ -235,7 +303,7 @@ await client.referrals.get("referralId");
 </dl>
 </details>
 
-<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">delete</a>(referralId) -> ReferralExchange.ReferralDto</code></summary>
+<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">delete</a>(referralId, { ...params }) -> ReferralExchange.ReferralDto</code></summary>
 <dl>
 <dd>
 
@@ -248,7 +316,10 @@ await client.referrals.get("referralId");
 <dd>
 
 ```typescript
-await client.referrals.delete("referralId");
+await client.referrals.delete("referralId", {
+    institutionIdType: "hci",
+    institutionId: "institutionId",
+});
 ```
 
 </dd>
@@ -272,6 +343,14 @@ await client.referrals.delete("referralId");
 <dl>
 <dd>
 
+**request:** `ReferralExchange.ReferralsDeleteRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Referrals.RequestOptions`
 
 </dd>
@@ -296,7 +375,10 @@ await client.referrals.delete("referralId");
 <dd>
 
 ```typescript
-await client.referrals.cancel("referralId");
+await client.referrals.cancel("referralId", {
+    institutionIdType: "hci",
+    institutionId: "institutionId",
+});
 ```
 
 </dd>
@@ -354,6 +436,8 @@ await client.referrals.cancel("referralId");
 ```typescript
 await client.referrals.amend("referralId", {
     timeslotStartAt: 1714857600000,
+    institutionIdType: "hci",
+    institutionId: "institutionId",
 });
 ```
 
@@ -410,7 +494,10 @@ await client.referrals.amend("referralId", {
 <dd>
 
 ```typescript
-await client.referrals.accept("referralId");
+await client.referrals.accept("referralId", {
+    institutionIdType: "hci",
+    institutionId: "institutionId",
+});
 ```
 
 </dd>
@@ -468,6 +555,8 @@ await client.referrals.accept("referralId");
 ```typescript
 await client.referrals.reject("referralId", {
     rejectionMessage: "rejectionMessage",
+    institutionIdType: "hci",
+    institutionId: "institutionId",
 });
 ```
 
@@ -511,7 +600,7 @@ await client.referrals.reject("referralId", {
 </dl>
 </details>
 
-<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">backToDraft</a>(referralId) -> ReferralExchange.ReferralDto</code></summary>
+<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">backToDraft</a>(referralId, { ...params }) -> ReferralExchange.ReferralDto</code></summary>
 <dl>
 <dd>
 
@@ -524,7 +613,10 @@ await client.referrals.reject("referralId", {
 <dd>
 
 ```typescript
-await client.referrals.backToDraft("referralId");
+await client.referrals.backToDraft("referralId", {
+    institutionIdType: "hci",
+    institutionId: "institutionId",
+});
 ```
 
 </dd>
@@ -548,6 +640,14 @@ await client.referrals.backToDraft("referralId");
 <dl>
 <dd>
 
+**request:** `ReferralExchange.BackToDraftReferralBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Referrals.RequestOptions`
 
 </dd>
@@ -576,6 +676,8 @@ await client.referrals.backToDraft("referralId");
 ```typescript
 await client.notes.create("referralId", {
     authorHciCode: "authorHciCode",
+    institutionIdType: "hci",
+    institutionId: "institutionId",
 });
 ```
 
@@ -619,6 +721,58 @@ await client.notes.create("referralId", {
 </dl>
 </details>
 
+## Referrers
+
+<details><summary><code>client.referrers.<a href="/src/api/resources/referrers/client/Client.ts">apiHoldingControllerGetReferrers</a>({ ...params }) -> ReferralExchange.GetReferrersRes</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.referrers.apiHoldingControllerGetReferrers({
+    idType: "mcr",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `ReferralExchange.ApiHoldingControllerGetReferrersRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Referrers.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>({ ...params }) -> ReferralExchange.OfferingWithAllowedDto[]</code></summary>
@@ -783,7 +937,7 @@ await client.offerings.listTimeslots("offeringId", {
 
 ## Links
 
-<details><summary><code>client.links.<a href="/src/api/resources/links/client/Client.ts">createUpsertLink</a>({ ...params }) -> ReferralExchange.ReferralLinkDto</code></summary>
+<details><summary><code>client.links.<a href="/src/api/resources/links/client/Client.ts">createUpsertLink</a>({ ...params }) -> ReferralExchange.ReferralUpsertLinkDto</code></summary>
 <dl>
 <dd>
 
@@ -800,6 +954,7 @@ await client.links.createUpsertLink({
     referrerInstitutionId: "referrerInstitutionId",
     referrerInstitutionName: "referrerInstitutionName",
     referrerId: "referrerId",
+    requesterIdentifier: "requester@example.com",
     referrerIdType: "mcr",
     referrerName: "referrerName",
 });
@@ -852,7 +1007,11 @@ await client.links.createUpsertLink({
 <dd>
 
 ```typescript
-await client.public.getReferral("referralId");
+await client.public.getReferral("referralId", {
+    requesterIdentifier: "requester@example.com",
+    institutionIdType: "hci",
+    institutionId: "institutionId",
+});
 ```
 
 </dd>

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-develop-alpha-1763450943";
+export declare const SDK_VERSION = "0.0.0-develop-alpha-1772437212";

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-alpha-1763450943";
+exports.SDK_VERSION = "0.0.0-develop-alpha-1772437212";

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Clinic type
- */
-export type CreateReferralReqClinicType = "CHAS-only" | "CHAS and HSG";
-export declare const CreateReferralReqClinicType: {
-    readonly ChasOnly: "CHAS-only";
-    readonly ChasAndHsg: "CHAS and HSG";
-};

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

@@ -1 +0,0 @@
-export * from "./CreateReferralReqClinicType";

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Clinic type
- */
-export type CreateReferralReqClinicType = "CHAS-only" | "CHAS and HSG";
-export declare const CreateReferralReqClinicType: {
-    readonly ChasOnly: "CHAS-only";
-    readonly ChasAndHsg: "CHAS and HSG";
-};

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

@@ -1 +0,0 @@
-export * from "./CreateReferralReqClinicType";