@opengovsg/refx-ts-sdk 2024.10.3 → 2025.2.20

package/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/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/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/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/api/resources/public/client/index.d.ts

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

package/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/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/api/resources/public/client/requests/index.d.ts

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

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

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

package/api/resources/referrals/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 Referrals {
     interface Options {
-        environment: core.Supplier<string>;
+        environment?: core.Supplier<environments.ReferralExchangeEnvironment | string>;
         apiKey?: core.Supplier<string | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -22,7 +23,7 @@ export declare namespace Referrals {
 }
 export declare class Referrals {
     protected readonly _options: Referrals.Options;
-    constructor(_options: Referrals.Options);
+    constructor(_options?: Referrals.Options);
     /**
      * @param {ReferralExchange.ReferralsListRequest} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
@@ -53,29 +54,28 @@ export declare class Referrals {
      *         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"
+     *             }]
      *     })
      */
     upsert(request: ReferralExchange.CreateReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
+     * @param {ReferralExchange.ReferralsGetRequest} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.referrals.get("referralId")
      */
-    get(referralId: string, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.FullReferralDto>;
+    get(referralId: string, request?: ReferralExchange.ReferralsGetRequest, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.FullReferralDto>;
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -83,7 +83,7 @@ export declare class Referrals {
      */
     delete(referralId: string, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.CancelReferralReq} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -92,7 +92,7 @@ export declare class Referrals {
      */
     cancel(referralId: string, request?: ReferralExchange.CancelReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.AmendReferralReq} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -103,7 +103,7 @@ export declare class Referrals {
      */
     amend(referralId: string, request: ReferralExchange.AmendReferralReq, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.EaConfirmReferralBody} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -114,7 +114,7 @@ export declare class Referrals {
      */
     accept(referralId: string, request: ReferralExchange.EaConfirmReferralBody, requestOptions?: Referrals.RequestOptions): Promise<void>;
     /**
-     * @param {string} referralId
+     * @param {string} referralId - Referral ID
      * @param {ReferralExchange.EaRejectReferralBody} request
      * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -124,6 +124,14 @@ export declare class Referrals {
      *     })
      */
     reject(referralId: string, request: ReferralExchange.EaRejectReferralBody, requestOptions?: Referrals.RequestOptions): Promise<void>;
+    /**
+     * @param {string} referralId - Referral ID
+     * @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.referrals.backToDraft("referralId")
+     */
+    backToDraft(referralId: string, requestOptions?: Referrals.RequestOptions): Promise<ReferralExchange.ReferralDto>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;