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

package/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/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/Client.d.ts

@@ -6,6 +6,7 @@ import * as core from "./core";
 import { Eligibility } from "./api/resources/eligibility/client/Client";
 import { Referrals } from "./api/resources/referrals/client/Client";
 import { Notes } from "./api/resources/notes/client/Client";
+import { Referrers } from "./api/resources/referrers/client/Client";
 import { Offerings } from "./api/resources/offerings/client/Client";
 import { Links } from "./api/resources/links/client/Client";
 import { Public } from "./api/resources/public/client/Client";
@@ -35,6 +36,7 @@ export declare class ReferralExchangeClient {
     protected _eligibility: Eligibility | undefined;
     protected _referrals: Referrals | undefined;
     protected _notes: Notes | undefined;
+    protected _referrers: Referrers | undefined;
     protected _offerings: Offerings | undefined;
     protected _links: Links | undefined;
     protected _public: Public | undefined;
@@ -44,6 +46,7 @@ export declare class ReferralExchangeClient {
     get eligibility(): Eligibility;
     get referrals(): Referrals;
     get notes(): Notes;
+    get referrers(): Referrers;
     get offerings(): Offerings;
     get links(): Links;
     get public(): Public;

package/dist/Client.js

@@ -7,11 +7,12 @@ exports.ReferralExchangeClient = void 0;
 const Client_1 = require("./api/resources/eligibility/client/Client");
 const Client_2 = require("./api/resources/referrals/client/Client");
 const Client_3 = require("./api/resources/notes/client/Client");
-const Client_4 = require("./api/resources/offerings/client/Client");
-const Client_5 = require("./api/resources/links/client/Client");
-const Client_6 = require("./api/resources/public/client/Client");
-const Client_7 = require("./api/resources/webhooks/client/Client");
-const Client_8 = require("./api/resources/health/client/Client");
+const Client_4 = require("./api/resources/referrers/client/Client");
+const Client_5 = require("./api/resources/offerings/client/Client");
+const Client_6 = require("./api/resources/links/client/Client");
+const Client_7 = require("./api/resources/public/client/Client");
+const Client_8 = require("./api/resources/webhooks/client/Client");
+const Client_9 = require("./api/resources/health/client/Client");
 class ReferralExchangeClient {
     constructor(_options = {}) {
         this._options = _options;
@@ -28,25 +29,29 @@ class ReferralExchangeClient {
         var _a;
         return ((_a = this._notes) !== null && _a !== void 0 ? _a : (this._notes = new Client_3.Notes(this._options)));
     }
+    get referrers() {
+        var _a;
+        return ((_a = this._referrers) !== null && _a !== void 0 ? _a : (this._referrers = new Client_4.Referrers(this._options)));
+    }
     get offerings() {
         var _a;
-        return ((_a = this._offerings) !== null && _a !== void 0 ? _a : (this._offerings = new Client_4.Offerings(this._options)));
+        return ((_a = this._offerings) !== null && _a !== void 0 ? _a : (this._offerings = new Client_5.Offerings(this._options)));
     }
     get links() {
         var _a;
-        return ((_a = this._links) !== null && _a !== void 0 ? _a : (this._links = new Client_5.Links(this._options)));
+        return ((_a = this._links) !== null && _a !== void 0 ? _a : (this._links = new Client_6.Links(this._options)));
     }
     get public() {
         var _a;
-        return ((_a = this._public) !== null && _a !== void 0 ? _a : (this._public = new Client_6.Public(this._options)));
+        return ((_a = this._public) !== null && _a !== void 0 ? _a : (this._public = new Client_7.Public(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_7.Webhooks(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_8.Webhooks(this._options)));
     }
     get health() {
         var _a;
-        return ((_a = this._health) !== null && _a !== void 0 ? _a : (this._health = new Client_8.Health(this._options)));
+        return ((_a = this._health) !== null && _a !== void 0 ? _a : (this._health = new Client_9.Health(this._options)));
     }
 }
 exports.ReferralExchangeClient = ReferralExchangeClient;

package/dist/api/errors/BadRequestError.d.ts

@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
-import * as ReferralExchange from "../index";
 export declare class BadRequestError extends errors.ReferralExchangeError {
-    constructor(body: ReferralExchange.BadRequestErrorBody);
+    constructor(body?: unknown);
 }

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

@@ -89,7 +89,7 @@ class Eligibility {
             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/eligibility"),
                 method: "GET",
-                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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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",

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

@@ -69,7 +69,7 @@ class Health {
             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/health"),
                 method: "GET",
-                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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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/resources/index.d.ts

@@ -1,9 +1,9 @@
-export * as referrals from "./referrals";
-export * from "./referrals/types";
 export * as links from "./links";
 export * from "./links/types";
 export * as eligibility from "./eligibility";
+export * as referrals from "./referrals";
 export * as notes from "./notes";
+export * as referrers from "./referrers";
 export * as offerings from "./offerings";
 export * as public_ from "./public";
 export * as webhooks from "./webhooks";
@@ -11,6 +11,7 @@ export * as health from "./health";
 export * from "./eligibility/client/requests";
 export * from "./referrals/client/requests";
 export * from "./notes/client/requests";
+export * from "./referrers/client/requests";
 export * from "./offerings/client/requests";
 export * from "./links/client/requests";
 export * from "./public/client/requests";

package/dist/api/resources/index.js

@@ -36,13 +36,13 @@ 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 });
-exports.health = exports.webhooks = exports.public_ = exports.offerings = exports.notes = exports.eligibility = exports.links = exports.referrals = void 0;
-exports.referrals = __importStar(require("./referrals"));
-__exportStar(require("./referrals/types"), exports);
+exports.health = exports.webhooks = exports.public_ = exports.offerings = exports.referrers = exports.notes = exports.referrals = exports.eligibility = exports.links = void 0;
 exports.links = __importStar(require("./links"));
 __exportStar(require("./links/types"), exports);
 exports.eligibility = __importStar(require("./eligibility"));
+exports.referrals = __importStar(require("./referrals"));
 exports.notes = __importStar(require("./notes"));
+exports.referrers = __importStar(require("./referrers"));
 exports.offerings = __importStar(require("./offerings"));
 exports.public_ = __importStar(require("./public"));
 exports.webhooks = __importStar(require("./webhooks"));
@@ -50,6 +50,7 @@ exports.health = __importStar(require("./health"));
 __exportStar(require("./eligibility/client/requests"), exports);
 __exportStar(require("./referrals/client/requests"), exports);
 __exportStar(require("./notes/client/requests"), exports);
+__exportStar(require("./referrers/client/requests"), exports);
 __exportStar(require("./offerings/client/requests"), exports);
 __exportStar(require("./links/client/requests"), exports);
 __exportStar(require("./public/client/requests"), exports);

package/dist/api/resources/links/client/Client.d.ts

@@ -30,6 +30,7 @@ export declare class Links {
      * @param {ReferralExchange.CreateLinkReqUpsert} request
      * @param {Links.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link ReferralExchange.BadRequestError}
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
@@ -37,11 +38,12 @@ export declare class Links {
      *         referrerInstitutionId: "referrerInstitutionId",
      *         referrerInstitutionName: "referrerInstitutionName",
      *         referrerId: "referrerId",
+     *         requesterIdentifier: "requester@example.com",
      *         referrerIdType: "mcr",
      *         referrerName: "referrerName"
      *     })
      */
-    createUpsertLink(request: ReferralExchange.CreateLinkReqUpsert, requestOptions?: Links.RequestOptions): Promise<ReferralExchange.ReferralLinkDto>;
+    createUpsertLink(request: ReferralExchange.CreateLinkReqUpsert, requestOptions?: Links.RequestOptions): Promise<ReferralExchange.ReferralUpsertLinkDto>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;

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

@@ -62,6 +62,7 @@ class Links {
      * @param {ReferralExchange.CreateLinkReqUpsert} request
      * @param {Links.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link ReferralExchange.BadRequestError}
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
@@ -69,6 +70,7 @@ class Links {
      *         referrerInstitutionId: "referrerInstitutionId",
      *         referrerInstitutionName: "referrerInstitutionName",
      *         referrerId: "referrerId",
+     *         requesterIdentifier: "requester@example.com",
      *         referrerIdType: "mcr",
      *         referrerName: "referrerName"
      *     })
@@ -79,7 +81,7 @@ class Links {
             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/links/upsert"),
                 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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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,
@@ -92,6 +94,8 @@ class Links {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 400:
+                        throw new ReferralExchange.BadRequestError(_response.error.body);
                     case 401:
                         throw new ReferralExchange.UnauthorizedError(_response.error.body);
                     default:

package/dist/api/resources/links/client/requests/CreateLinkReqUpsert.d.ts

@@ -8,6 +8,7 @@ import * as ReferralExchange from "../../../../index";
  *         referrerInstitutionId: "referrerInstitutionId",
  *         referrerInstitutionName: "referrerInstitutionName",
  *         referrerId: "referrerId",
+ *         requesterIdentifier: "requester@example.com",
  *         referrerIdType: "mcr",
  *         referrerName: "referrerName"
  *     }
@@ -19,6 +20,8 @@ export interface CreateLinkReqUpsert {
     referrerInstitutionName: string;
     /** Id of the doctor authoring this referral. */
     referrerId: string;
+    /** Identifier for the individual requesting the link. The individual may or may not be the referrer. Preferred to be an email. */
+    requesterIdentifier: string;
     referrerIdType: ReferralExchange.ReferrerIdType;
     /** Name of the doctor authoring this referral. */
     referrerName: string;

package/dist/api/resources/links/types/CreateLinkReqUpsertClinicType.d.ts

@@ -4,8 +4,9 @@
 /**
  * Clinic type
  */
-export type CreateLinkReqUpsertClinicType = "CHAS-only" | "CHAS and HSG";
+export type CreateLinkReqUpsertClinicType = "CHAS-only" | "CHAS and HSG" | "CHAS and Healthier SG";
 export declare const CreateLinkReqUpsertClinicType: {
     readonly ChasOnly: "CHAS-only";
     readonly ChasAndHsg: "CHAS and HSG";
+    readonly ChasAndHealthierSg: "CHAS and Healthier SG";
 };

package/dist/api/resources/links/types/CreateLinkReqUpsertClinicType.js

@@ -7,4 +7,5 @@ exports.CreateLinkReqUpsertClinicType = void 0;
 exports.CreateLinkReqUpsertClinicType = {
     ChasOnly: "CHAS-only",
     ChasAndHsg: "CHAS and HSG",
+    ChasAndHealthierSg: "CHAS and Healthier SG",
 };

package/dist/api/resources/notes/client/Client.d.ts

@@ -35,7 +35,9 @@ export declare class Notes {
      *
      * @example
      *     await client.notes.create("referralId", {
-     *         authorHciCode: "authorHciCode"
+     *         authorHciCode: "authorHciCode",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
     create(referralId: string, request: ReferralExchange.CreateNoteReq, requestOptions?: Notes.RequestOptions): Promise<ReferralExchange.NoteDto>;

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

@@ -67,7 +67,9 @@ class Notes {
      *
      * @example
      *     await client.notes.create("referralId", {
-     *         authorHciCode: "authorHciCode"
+     *         authorHciCode: "authorHciCode",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
     create(referralId, request, requestOptions) {
@@ -76,10 +78,10 @@ class Notes {
             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/referrals/${encodeURIComponent(referralId)}/notes`),
                 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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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,
+                body: Object.assign(Object.assign({}, request), { institutionIdType: "hci" }),
                 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,

package/dist/api/resources/notes/client/requests/CreateNoteReq.d.ts

@@ -4,7 +4,9 @@
 /**
  * @example
  *     {
- *         authorHciCode: "authorHciCode"
+ *         authorHciCode: "authorHciCode",
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
  *     }
  */
 export interface CreateNoteReq {
@@ -12,4 +14,6 @@ export interface CreateNoteReq {
     content?: string;
     /** Author HCI code. Must be already tied to your system. */
     authorHciCode: string;
+    /** The institution ID */
+    institutionId: string;
 }

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

@@ -85,7 +85,7 @@ class Offerings {
             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/offerings"),
                 method: "GET",
-                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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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",
@@ -144,7 +144,7 @@ class Offerings {
             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/offerings/recommended"),
                 method: "GET",
-                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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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",
@@ -207,7 +207,7 @@ class Offerings {
             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/offerings/${encodeURIComponent(offeringId)}/timeslots`),
                 method: "GET",
-                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-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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",

package/dist/api/resources/public/client/Client.d.ts

@@ -34,9 +34,13 @@ export declare class Public {
      * @throws {@link ReferralExchange.NotFoundError}
      *
      * @example
-     *     await client.public.getReferral("referralId")
+     *     await client.public.getReferral("referralId", {
+     *         requesterIdentifier: "requester@example.com",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    getReferral(referralId: string, request?: ReferralExchange.PublicGetReferralRequest, requestOptions?: Public.RequestOptions): Promise<ReferralExchange.PublicReferralDto>;
+    getReferral(referralId: string, request: ReferralExchange.PublicGetReferralRequest, requestOptions?: Public.RequestOptions): Promise<ReferralExchange.PublicReferralDto>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;

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

@@ -66,12 +66,16 @@ class Public {
      * @throws {@link ReferralExchange.NotFoundError}
      *
      * @example
-     *     await client.public.getReferral("referralId")
+     *     await client.public.getReferral("referralId", {
+     *         requesterIdentifier: "requester@example.com",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    getReferral(referralId_1) {
-        return __awaiter(this, arguments, void 0, function* (referralId, request = {}, requestOptions) {
+    getReferral(referralId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
-            const { additionalField } = request;
+            const { additionalField, requesterIdentifier, institutionIdType, institutionId } = request;
             const _queryParams = {};
             if (additionalField != null) {
                 if (Array.isArray(additionalField)) {
@@ -81,10 +85,13 @@ class Public {
                     _queryParams["additionalField"] = additionalField;
                 }
             }
+            _queryParams["requesterIdentifier"] = requesterIdentifier;
+            _queryParams["institutionIdType"] = institutionIdType;
+            _queryParams["institutionId"] = institutionId;
             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/public/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": "0.0.0-develop-alpha-1763450943", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1763450943", "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-alpha-1772437212", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-alpha-1772437212", "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",

package/dist/api/resources/public/client/requests/PublicGetReferralRequest.d.ts

@@ -4,8 +4,24 @@
 import * as ReferralExchange from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         requesterIdentifier: "requester@example.com",
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
+ *     }
  */
 export interface PublicGetReferralRequest {
     additionalField?: ReferralExchange.AdditionalReferralField | ReferralExchange.AdditionalReferralField[];
+    /**
+     * Identifier for the individual requesting the referral. Preferred to be an email.
+     */
+    requesterIdentifier: string;
+    /**
+     * The type of institution ID
+     */
+    institutionIdType: ReferralExchange.InstitutionIdType;
+    /**
+     * The institution ID
+     */
+    institutionId: string;
 }

package/dist/api/resources/referrals/client/Client.d.ts

@@ -70,6 +70,18 @@ export declare class Referrals {
      *     })
      */
     upsert(request: ReferralExchange.CreateReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
+    /**
+     * @param {ReferralExchange.InstitutionIdType} institutionIdType - The type of institution ID
+     * @param {string} institutionId - The institution ID
+     * @param {ReferralExchange.ReferralsListByInstitutionRequest} request
+     * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ReferralExchange.UnauthorizedError}
+     *
+     * @example
+     *     await client.referrals.listByInstitution("hci", "institutionId")
+     */
+    listByInstitution(institutionIdType: ReferralExchange.InstitutionIdType, institutionId: string, request?: ReferralExchange.ReferralsListByInstitutionRequest, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.PaginatedReferralsDto>;
     /**
      * @param {string} referralId - Referral ID
      * @param {ReferralExchange.ReferralsGetRequest} request
@@ -79,19 +91,27 @@ export declare class Referrals {
      * @throws {@link ReferralExchange.NotFoundError}
      *
      * @example
-     *     await client.referrals.get("referralId")
+     *     await client.referrals.get("referralId", {
+     *         requesterIdentifier: "requester@example.com",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    get(referralId: string, request?: ReferralExchange.ReferralsGetRequest, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.FullReferralDto>;
+    get(referralId: string, request: ReferralExchange.ReferralsGetRequest, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.FullReferralDto>;
     /**
      * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.ReferralsDeleteRequest} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
-     *     await client.referrals.delete("referralId")
+     *     await client.referrals.delete("referralId", {
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    delete(referralId: string, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
+    delete(referralId: string, request: ReferralExchange.ReferralsDeleteRequest, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     /**
      * @param {string} referralId - Referral ID
      * @param {ReferralExchange.CancelReferralReq} request
@@ -100,9 +120,12 @@ export declare class Referrals {
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
-     *     await client.referrals.cancel("referralId")
+     *     await client.referrals.cancel("referralId", {
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    cancel(referralId: string, request?: ReferralExchange.CancelReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
+    cancel(referralId: string, request: ReferralExchange.CancelReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     /**
      * @param {string} referralId - Referral ID
      * @param {ReferralExchange.AmendReferralReq} request
@@ -112,7 +135,9 @@ export declare class Referrals {
      *
      * @example
      *     await client.referrals.amend("referralId", {
-     *         timeslotStartAt: 1714857600000
+     *         timeslotStartAt: 1714857600000,
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
     amend(referralId: string, request: ReferralExchange.AmendReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
@@ -121,12 +146,16 @@ export declare class Referrals {
      * @param {ReferralExchange.AcceptReferralBody} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link ReferralExchange.BadRequestError}
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
-     *     await client.referrals.accept("referralId")
+     *     await client.referrals.accept("referralId", {
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    accept(referralId: string, request?: ReferralExchange.AcceptReferralBody, requestOptions?: Referrals.RequestOptions): Promise<void>;
+    accept(referralId: string, request: ReferralExchange.AcceptReferralBody, requestOptions?: Referrals.RequestOptions): Promise<void>;
     /**
      * @param {string} referralId - Referral ID
      * @param {ReferralExchange.RejectReferralBody} request
@@ -136,20 +165,26 @@ export declare class Referrals {
      *
      * @example
      *     await client.referrals.reject("referralId", {
-     *         rejectionMessage: "rejectionMessage"
+     *         rejectionMessage: "rejectionMessage",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
     reject(referralId: string, request: ReferralExchange.RejectReferralBody, requestOptions?: Referrals.RequestOptions): Promise<void>;
     /**
      * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.BackToDraftReferralBody} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
-     *     await client.referrals.backToDraft("referralId")
+     *     await client.referrals.backToDraft("referralId", {
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    backToDraft(referralId: string, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
+    backToDraft(referralId: string, request: ReferralExchange.BackToDraftReferralBody, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;