@opengovsg/refx-ts-sdk 0.0.0-develop-1746623964

package/Client.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments";
+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 { Offerings } from "./api/resources/offerings/client/Client";
+import { Public } from "./api/resources/public/client/Client";
+import { Webhooks } from "./api/resources/webhooks/client/Client";
+import { Health } from "./api/resources/health/client/Client";
+export declare namespace ReferralExchangeClient {
+    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 ReferralExchangeClient {
+    protected readonly _options: ReferralExchangeClient.Options;
+    protected _eligibility: Eligibility | undefined;
+    protected _referrals: Referrals | undefined;
+    protected _notes: Notes | undefined;
+    protected _offerings: Offerings | undefined;
+    protected _public: Public | undefined;
+    protected _webhooks: Webhooks | undefined;
+    protected _health: Health | undefined;
+    constructor(_options?: ReferralExchangeClient.Options);
+    get eligibility(): Eligibility;
+    get referrals(): Referrals;
+    get notes(): Notes;
+    get offerings(): Offerings;
+    get public(): Public;
+    get webhooks(): Webhooks;
+    get health(): Health;
+}

package/Client.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+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/public/client/Client");
+const Client_6 = require("./api/resources/webhooks/client/Client");
+const Client_7 = require("./api/resources/health/client/Client");
+class ReferralExchangeClient {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get eligibility() {
+        var _a;
+        return ((_a = this._eligibility) !== null && _a !== void 0 ? _a : (this._eligibility = new Client_1.Eligibility(this._options)));
+    }
+    get referrals() {
+        var _a;
+        return ((_a = this._referrals) !== null && _a !== void 0 ? _a : (this._referrals = new Client_2.Referrals(this._options)));
+    }
+    get notes() {
+        var _a;
+        return ((_a = this._notes) !== null && _a !== void 0 ? _a : (this._notes = new Client_3.Notes(this._options)));
+    }
+    get offerings() {
+        var _a;
+        return ((_a = this._offerings) !== null && _a !== void 0 ? _a : (this._offerings = new Client_4.Offerings(this._options)));
+    }
+    get public() {
+        var _a;
+        return ((_a = this._public) !== null && _a !== void 0 ? _a : (this._public = new Client_5.Public(this._options)));
+    }
+    get webhooks() {
+        var _a;
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_6.Webhooks(this._options)));
+    }
+    get health() {
+        var _a;
+        return ((_a = this._health) !== null && _a !== void 0 ? _a : (this._health = new Client_7.Health(this._options)));
+    }
+}
+exports.ReferralExchangeClient = ReferralExchangeClient;

package/README.md

@@ -0,0 +1,176 @@
+# Opengovsg TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fopengovsg%2Frefer-ts-sdk)
+[![npm shield](https://img.shields.io/npm/v/@opengovsg/refx-ts-sdk)](https://www.npmjs.com/package/@opengovsg/refx-ts-sdk)
+
+The Opengovsg TypeScript library provides convenient access to the Opengovsg API from TypeScript.
+
+## Installation
+
+```sh
+npm i -s @opengovsg/refx-ts-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { ReferralExchangeClient } from "@opengovsg/refx-ts-sdk";
+
+const client = new ReferralExchangeClient({ apiKey: "YOUR_API_KEY" });
+await client.referrals.upsert({
+    patient: {
+        uin: "uin",
+        name: "name",
+        phoneNumber: "91234567",
+        dob: "1990-01-01",
+        gender: "Male",
+    },
+    offeringId: "offeringId",
+    senderHciCode: "senderHciCode",
+    senderInstitutionName: "senderInstitutionName",
+    doctorMcr: "doctorMcr",
+    doctorName: "doctorName",
+    doctorEmail: "doctorEmail",
+    doctorContactNumber: "doctorContactNumber",
+    isSubsidised: true,
+    isUrgent: true,
+    isDraft: true,
+    formResponses: [
+        {
+            question: "question",
+            id: "id",
+            answer: "answer",
+        },
+    ],
+});
+```
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { ReferralExchange } from "@opengovsg/refx-ts-sdk";
+
+const request: ReferralExchange.EligibilityGetRequest = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { ReferralExchangeError } from "@opengovsg/refx-ts-sdk";
+
+try {
+    await client.referrals.upsert(...);
+} catch (err) {
+    if (err instanceof ReferralExchangeError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
+}
+```
+
+## Advanced
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+const response = await client.referrals.upsert(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.referrals.upsert(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.referrals.upsert(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.referrals.upsert(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { ReferralExchangeClient } from "@opengovsg/refx-ts-sdk";
+
+const client = new ReferralExchangeClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/api/errors/BadRequestError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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);
+}

package/api/errors/BadRequestError.js

@@ -0,0 +1,51 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class BadRequestError extends errors.ReferralExchangeError {
+    constructor(body) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}
+exports.BadRequestError = BadRequestError;

package/api/errors/NotFoundError.d.ts

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

package/api/errors/NotFoundError.js

@@ -0,0 +1,51 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class NotFoundError extends errors.ReferralExchangeError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/api/errors/UnauthorizedError.d.ts

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

package/api/errors/UnauthorizedError.js

@@ -0,0 +1,51 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnauthorizedError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class UnauthorizedError extends errors.ReferralExchangeError {
+    constructor(body) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+        });
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;

package/api/errors/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./UnauthorizedError";
+export * from "./BadRequestError";
+export * from "./NotFoundError";

package/api/errors/index.js

@@ -0,0 +1,19 @@
+"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("./UnauthorizedError"), exports);
+__exportStar(require("./BadRequestError"), exports);
+__exportStar(require("./NotFoundError"), exports);

package/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./errors";
+export * from "./resources";

package/api/index.js

@@ -0,0 +1,19 @@
+"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("./types"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./resources"), exports);

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

@@ -0,0 +1,45 @@
+/**
+ * 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 Eligibility {
+    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 Eligibility {
+    protected readonly _options: Eligibility.Options;
+    constructor(_options?: Eligibility.Options);
+    /**
+     * @param {ReferralExchange.EligibilityGetRequest} request
+     * @param {Eligibility.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ReferralExchange.UnauthorizedError}
+     *
+     * @example
+     *     await client.eligibility.get({
+     *         uin: "uin",
+     *         offeringId: "offeringId"
+     *     })
+     */
+    get(request: ReferralExchange.EligibilityGetRequest, requestOptions?: Eligibility.RequestOptions): Promise<ReferralExchange.EligibilityRes>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}