@opengovsg/refx-ts-sdk 2024.10.3 → 2025.2.20

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

@@ -39,11 +39,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Health = 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 Health {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -53,12 +54,12 @@ class Health {
      *     await client.health.check()
      */
     check(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/health"),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, "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": "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/dist/api/resources/index.d.ts

@@ -1,10 +1,12 @@
-export * as referrals from "./referrals";
-export * from "./referrals/types";
 export * as eligibility from "./eligibility";
+export * as referrals from "./referrals";
+export * as notes from "./notes";
 export * as offerings from "./offerings";
 export * as public_ from "./public";
 export * as webhooks from "./webhooks";
 export * as health from "./health";
 export * from "./eligibility/client/requests";
 export * from "./referrals/client/requests";
+export * from "./notes/client/requests";
 export * from "./offerings/client/requests";
+export * from "./public/client/requests";

package/dist/api/resources/index.js

@@ -26,14 +26,16 @@ 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.eligibility = exports.referrals = void 0;
-exports.referrals = __importStar(require("./referrals"));
-__exportStar(require("./referrals/types"), exports);
+exports.health = exports.webhooks = exports.public_ = exports.offerings = exports.notes = exports.referrals = exports.eligibility = void 0;
 exports.eligibility = __importStar(require("./eligibility"));
+exports.referrals = __importStar(require("./referrals"));
+exports.notes = __importStar(require("./notes"));
 exports.offerings = __importStar(require("./offerings"));
 exports.public_ = __importStar(require("./public"));
 exports.webhooks = __importStar(require("./webhooks"));
 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("./offerings/client/requests"), exports);
+__exportStar(require("./public/client/requests"), exports);

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

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as ReferralExchange from "../../../index";
+export declare namespace Notes {
+    interface Options {
+        environment?: core.Supplier<environments.ReferralExchangeEnvironment | string>;
+        apiKey?: core.Supplier<string | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Notes {
+    protected readonly _options: Notes.Options;
+    constructor(_options?: Notes.Options);
+    /**
+     * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.CreateNoteReq} request
+     * @param {Notes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.notes.create("referralId", {
+     *         authorHciCode: "authorHciCode"
+     *     })
+     */
+    create(referralId: string, request: ReferralExchange.CreateNoteReq, requestOptions?: Notes.RequestOptions): Promise<ReferralExchange.NoteDto>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}

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

@@ -0,0 +1,105 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notes = 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 Notes {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.CreateNoteReq} request
+     * @param {Notes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.notes.create("referralId", {
+     *         authorHciCode: "authorHciCode"
+     *     })
+     */
+    create(referralId, request, 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)}/notes`),
+                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",
+                body: request,
+                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}/notes.");
+                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);
+            return { Authorization: apiKeyValue };
+        });
+    }
+}
+exports.Notes = Notes;

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

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

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./requests"), exports);

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         authorHciCode: "authorHciCode"
+ *     }
+ */
+export interface CreateNoteReq {
+    /** Note content - plaintext. */
+    content?: string;
+    /** Author HCI code. Must be already tied to your system. */
+    authorHciCode: string;
+}

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

@@ -0,0 +1 @@
+export { type CreateNoteReq } from "./CreateNoteReq";

package/dist/api/resources/notes/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/notes/index.d.ts

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

package/dist/api/resources/notes/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./client"), exports);

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

@@ -1,11 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as ReferralExchange from "../../../index";
 export declare namespace Offerings {
     interface Options {
-        environment: core.Supplier<string>;
+        environment?: core.Supplier<environments.ReferralExchangeEnvironment | string>;
         apiKey?: core.Supplier<string | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -22,22 +23,14 @@ export declare namespace Offerings {
 }
 export declare class Offerings {
     protected readonly _options: Offerings.Options;
-    constructor(_options: Offerings.Options);
+    constructor(_options?: Offerings.Options);
     /**
      * @param {Offerings.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.offerings.list()
      */
-    list(requestOptions?: Offerings.RequestOptions): Promise<ReferralExchange.OfferingCoreDto[]>;
-    /**
-     * @param {string} offeringId
-     * @param {Offerings.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.offerings.get("offeringId")
-     */
-    get(offeringId: string, requestOptions?: Offerings.RequestOptions): Promise<ReferralExchange.OfferingFullDto>;
+    list(requestOptions?: Offerings.RequestOptions): Promise<ReferralExchange.OfferingDto[]>;
     /**
      * @param {string} offeringId
      * @param {ReferralExchange.OfferingsListTimeslotsRequest} request
@@ -45,7 +38,8 @@ export declare class Offerings {
      *
      * @example
      *     await client.offerings.listTimeslots("offeringId", {
-     *         from: 1.1
+     *         from: 1.1,
+     *         isSubsidised: true
      *     })
      */
     listTimeslots(offeringId: string, request: ReferralExchange.OfferingsListTimeslotsRequest, requestOptions?: Offerings.RequestOptions): Promise<ReferralExchange.Timeslot[]>;

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

@@ -39,11 +39,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Offerings = 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 Offerings {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -53,12 +54,12 @@ class Offerings {
      *     await client.offerings.list()
      */
     list(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/offerings"),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, "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": "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,
@@ -89,50 +90,6 @@ class Offerings {
             }
         });
     }
-    /**
-     * @param {string} offeringId
-     * @param {Offerings.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.offerings.get("offeringId")
-     */
-    get(offeringId, requestOptions) {
-        var _a;
-        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/offerings/${encodeURIComponent(offeringId)}`),
-                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),
-                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 GET /api/v1/offerings/{offeringId}.");
-                case "unknown":
-                    throw new errors.ReferralExchangeError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
     /**
      * @param {string} offeringId
      * @param {ReferralExchange.OfferingsListTimeslotsRequest} request
@@ -140,22 +97,21 @@ class Offerings {
      *
      * @example
      *     await client.offerings.listTimeslots("offeringId", {
-     *         from: 1.1
+     *         from: 1.1,
+     *         isSubsidised: true
      *     })
      */
     listTimeslots(offeringId, request, requestOptions) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const { from: from_, isSubsidised } = request;
             const _queryParams = {};
             _queryParams["from"] = from_.toString();
-            if (isSubsidised != null) {
-                _queryParams["isSubsidised"] = isSubsidised.toString();
-            }
+            _queryParams["isSubsidised"] = isSubsidised.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/offerings/${encodeURIComponent(offeringId)}/timeslots`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ReferralExchangeEnvironment.Production, `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": "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",

package/dist/api/resources/offerings/client/requests/OfferingsListTimeslotsRequest.d.ts

@@ -4,10 +4,11 @@
 /**
  * @example
  *     {
- *         from: 1.1
+ *         from: 1.1,
+ *         isSubsidised: true
  *     }
  */
 export interface OfferingsListTimeslotsRequest {
     from: number;
-    isSubsidised?: boolean;
+    isSubsidised: boolean;
 }

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

@@ -1,11 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as ReferralExchange from "../../../index";
 export declare namespace Public {
     interface Options {
-        environment: core.Supplier<string>;
+        environment?: core.Supplier<environments.ReferralExchangeEnvironment | string>;
         apiKey?: core.Supplier<string | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -22,9 +23,10 @@ export declare namespace Public {
 }
 export declare class Public {
     protected readonly _options: Public.Options;
-    constructor(_options: Public.Options);
+    constructor(_options?: Public.Options);
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.PublicGetReferralRequest} request
      * @param {Public.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ReferralExchange.NotFoundError}
@@ -32,7 +34,7 @@ export declare class Public {
      * @example
      *     await client.public.getReferral("referralId")
      */
-    getReferral(referralId: string, 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

@@ -39,16 +39,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Public = void 0;
+const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const ReferralExchange = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class Public {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.PublicGetReferralRequest} request
      * @param {Public.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ReferralExchange.NotFoundError}
@@ -56,14 +58,20 @@ class Public {
      * @example
      *     await client.public.getReferral("referralId")
      */
-    getReferral(referralId, requestOptions) {
-        var _a;
+    getReferral(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/public/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/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": "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,

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

@@ -1 +1 @@
-export {};
+export * from "./requests";

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

@@ -1,2 +1,17 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./requests"), exports);

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

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

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

@@ -0,0 +1 @@
+export { type PublicGetReferralRequest } from "./PublicGetReferralRequest";

package/dist/api/resources/public/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });