@opengovsg/refx-ts-sdk 0.0.60 → 0.0.62

package/api/resources/referrals/client/Client.js

@@ -107,7 +107,7 @@ class Referrals {
             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"),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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",
@@ -183,7 +183,7 @@ class Referrals {
             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"),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
@@ -267,7 +267,7 @@ class Referrals {
             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/institutions/${encodeURIComponent(institutionIdType)}/${encodeURIComponent(institutionId)}/referrals`),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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",
@@ -314,13 +314,15 @@ class Referrals {
      *
      * @example
      *     await client.referrals.get("referralId", {
-     *         requesterIdentifier: "requester@example.com"
+     *         requesterIdentifier: "requester@example.com",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
-    get(referralId_1) {
-        return __awaiter(this, arguments, void 0, function* (referralId, request = {}, requestOptions) {
+    get(referralId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
-            const { additionalField, requesterIdentifier } = request;
+            const { additionalField, requesterIdentifier, institutionIdType, institutionId } = request;
             const _queryParams = {};
             if (additionalField != null) {
                 if (Array.isArray(additionalField)) {
@@ -330,13 +332,13 @@ class Referrals {
                     _queryParams["additionalField"] = additionalField;
                 }
             }
-            if (requesterIdentifier != null) {
-                _queryParams["requesterIdentifier"] = requesterIdentifier;
-            }
+            _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/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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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",
@@ -377,21 +379,30 @@ class Referrals {
     }
     /**
      * @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, requestOptions) {
+    delete(referralId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
+            const { institutionIdType, institutionId } = request;
+            const _queryParams = {};
+            _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/referrals/${encodeURIComponent(referralId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk", "X-Fern-SDK-Version": "0.0.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
@@ -434,18 +445,21 @@ class Referrals {
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
-     *     await client.referrals.cancel("referralId")
+     *     await client.referrals.cancel("referralId", {
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    cancel(referralId_1) {
-        return __awaiter(this, arguments, void 0, function* (referralId, request = {}, requestOptions) {
+    cancel(referralId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             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)}/cancel`),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
@@ -488,7 +502,9 @@ class Referrals {
      *
      * @example
      *     await client.referrals.amend("referralId", {
-     *         timeslotStartAt: 1714857600000
+     *         timeslotStartAt: 1714857600000,
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
     amend(referralId, request, requestOptions) {
@@ -497,10 +513,10 @@ class Referrals {
             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)}/amend`),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
@@ -543,18 +559,21 @@ class Referrals {
      * @throws {@link ReferralExchange.UnauthorizedError}
      *
      * @example
-     *     await client.referrals.accept("referralId")
+     *     await client.referrals.accept("referralId", {
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
+     *     })
      */
-    accept(referralId_1) {
-        return __awaiter(this, arguments, void 0, function* (referralId, request = {}, requestOptions) {
+    accept(referralId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             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)}/accept`),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
@@ -599,7 +618,9 @@ class Referrals {
      *
      * @example
      *     await client.referrals.reject("referralId", {
-     *         rejectionMessage: "rejectionMessage"
+     *         rejectionMessage: "rejectionMessage",
+     *         institutionIdType: "hci",
+     *         institutionId: "institutionId"
      *     })
      */
     reject(referralId, request, requestOptions) {
@@ -608,10 +629,10 @@ class Referrals {
             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)}/reject`),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
@@ -647,22 +668,27 @@ class Referrals {
     }
     /**
      * @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, requestOptions) {
+    backToDraft(referralId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             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)}/back-to-draft`),
                 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.60", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.60", "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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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: 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/api/resources/referrals/client/requests/AcceptReferralBody.d.ts

@@ -3,11 +3,16 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
+ *     }
  */
 export interface AcceptReferralBody {
     /** Appointment time, in milliseconds since epoch. */
     appointmentTime?: number;
     /** Note content */
     noteContent?: string;
+    /** The institution ID */
+    institutionId: string;
 }

package/api/resources/referrals/client/requests/AmendReferralReq.d.ts

@@ -4,10 +4,14 @@
 /**
  * @example
  *     {
- *         timeslotStartAt: 1714857600000
+ *         timeslotStartAt: 1714857600000,
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
  *     }
  */
 export interface AmendReferralReq {
     /** New timeslot start time, in milliseconds since epoch. */
     timeslotStartAt: number;
+    /** The institution ID */
+    institutionId: string;
 }

package/api/resources/referrals/client/requests/BackToDraftReferralBody.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
+ *     }
+ */
+export interface BackToDraftReferralBody {
+    /** The institution ID */
+    institutionId: string;
+}

package/api/resources/referrals/client/requests/CancelReferralReq.d.ts

@@ -3,7 +3,10 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
+ *     }
  */
 export interface CancelReferralReq {
     /** UIN of the person cancelling the referral, if available */
@@ -12,4 +15,6 @@ export interface CancelReferralReq {
     cancelledByName?: string;
     /** Optional note to save when cancelling the referral */
     cancelNote?: string;
+    /** The institution ID */
+    institutionId: string;
 }

package/api/resources/referrals/client/requests/ReferralsDeleteRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../../../../index";
+/**
+ * @example
+ *     {
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
+ *     }
+ */
+export interface ReferralsDeleteRequest {
+    /**
+     * The type of institution ID
+     */
+    institutionIdType: ReferralExchange.InstitutionIdType;
+    /**
+     * The institution ID
+     */
+    institutionId: string;
+}

package/api/resources/referrals/client/requests/ReferralsGetRequest.d.ts

@@ -5,13 +5,23 @@ import * as ReferralExchange from "../../../../index";
 /**
  * @example
  *     {
- *         requesterIdentifier: "requester@example.com"
+ *         requesterIdentifier: "requester@example.com",
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
  *     }
  */
 export interface ReferralsGetRequest {
     additionalField?: ReferralExchange.AdditionalReferralField | ReferralExchange.AdditionalReferralField[];
     /**
-     * Identifier for the individual requesting attachments/link/url. Required when requesting attachments/link/url. Preferred to be an email.
+     * Identifier for the individual requesting the referral. Preferred to be an email.
      */
-    requesterIdentifier?: string;
+    requesterIdentifier: string;
+    /**
+     * The type of institution ID
+     */
+    institutionIdType: ReferralExchange.InstitutionIdType;
+    /**
+     * The institution ID
+     */
+    institutionId: string;
 }

package/api/resources/referrals/client/requests/RejectReferralBody.d.ts

@@ -4,10 +4,14 @@
 /**
  * @example
  *     {
- *         rejectionMessage: "rejectionMessage"
+ *         rejectionMessage: "rejectionMessage",
+ *         institutionIdType: "hci",
+ *         institutionId: "institutionId"
  *     }
  */
 export interface RejectReferralBody {
     /** Rejection message */
     rejectionMessage: string;
+    /** The institution ID */
+    institutionId: string;
 }

package/api/resources/referrals/client/requests/index.d.ts

@@ -2,7 +2,9 @@ export { type ReferralsListRequest } from "./ReferralsListRequest";
 export { type CreateReferralReq } from "./CreateReferralReq";
 export { type ReferralsListByInstitutionRequest } from "./ReferralsListByInstitutionRequest";
 export { type ReferralsGetRequest } from "./ReferralsGetRequest";
+export { type ReferralsDeleteRequest } from "./ReferralsDeleteRequest";
 export { type CancelReferralReq } from "./CancelReferralReq";
 export { type AmendReferralReq } from "./AmendReferralReq";
 export { type AcceptReferralBody } from "./AcceptReferralBody";
 export { type RejectReferralBody } from "./RejectReferralBody";
+export { type BackToDraftReferralBody } from "./BackToDraftReferralBody";

package/api/resources/referrers/client/Client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 Referrers {
+    interface Options {
+        environment?: core.Supplier<environments.ReferralExchangeEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<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 Referrers {
+    protected readonly _options: Referrers.Options;
+    constructor(_options?: Referrers.Options);
+    /**
+     * @param {ReferralExchange.ApiHoldingControllerGetReferrersRequest} request
+     * @param {Referrers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ReferralExchange.UnauthorizedError}
+     *
+     * @example
+     *     await client.referrers.apiHoldingControllerGetReferrers({
+     *         idType: "mcr"
+     *     })
+     */
+    apiHoldingControllerGetReferrers(request: ReferralExchange.ApiHoldingControllerGetReferrersRequest, requestOptions?: Referrers.RequestOptions): Promise<ReferralExchange.GetReferrersRes>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}

package/api/resources/referrers/client/Client.js

@@ -0,0 +1,128 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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.Referrers = 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 Referrers {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * @param {ReferralExchange.ApiHoldingControllerGetReferrersRequest} request
+     * @param {Referrers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ReferralExchange.UnauthorizedError}
+     *
+     * @example
+     *     await client.referrers.apiHoldingControllerGetReferrers({
+     *         idType: "mcr"
+     *     })
+     */
+    apiHoldingControllerGetReferrers(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const { idType, whitelisted } = request;
+            const _queryParams = {};
+            _queryParams["idType"] = idType;
+            if (whitelisted != null) {
+                _queryParams["whitelisted"] = whitelisted.toString();
+            }
+            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/referrers"),
+                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.62", "User-Agent": "@opengovsg/refx-ts-sdk/0.0.62", "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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return _response.body;
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 401:
+                        throw new ReferralExchange.UnauthorizedError(_response.error.body);
+                    default:
+                        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/referrers.");
+                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.Referrers = Referrers;

package/api/resources/referrers/client/index.d.ts

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

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../../../../index";
+/**
+ * @example
+ *     {
+ *         idType: "mcr"
+ *     }
+ */
+export interface ApiHoldingControllerGetReferrersRequest {
+    idType: ReferralExchange.ReferrerIdType;
+    /**
+     * Filter by whitelisting status. true = whitelisted only, false = unwhitelisted only, omit = all.
+     */
+    whitelisted?: boolean;
+}

package/api/resources/referrers/client/requests/ApiHoldingControllerGetReferrersRequest.js

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

package/api/resources/referrers/client/requests/index.d.ts

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

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

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

package/api/resources/referrers/index.d.ts

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