Release 0.0.10

opengovsg · Dec 16, 2024 · 4927b47 · 4927b47
1 parent 0f263cb
commit 4927b47
Show file tree

Hide file tree

Showing 22 changed files with 98 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -45,9 +45,7 @@ await client.referrals.upsert({
         {
             question: "question",
             id: "id",
-            answer: {
-                key: "value",
-            },
+            answer: "answer",
         },
     ],
 });

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@opengovsg/refx-ts-sdk",
-    "version": "0.0.9",
+    "version": "0.0.10",
     "private": false,
     "repository": "https://github.com/opengovsg/refer-ts-sdk",
     "main": "./index.js",

diff --git a/reference.md b/reference.md
@@ -69,6 +69,8 @@ await client.eligibility.get({
 
 ```typescript
 await client.referrals.list({
+    offset: 1.1,
+    pageSize: 1.1,
     hciCode: "hciCode",
 });
 ```
@@ -140,9 +142,7 @@ await client.referrals.upsert({
         {
             question: "question",
             id: "id",
-            answer: {
-                key: "value",
-            },
+            answer: "answer",
         },
     ],
 });

diff --git a/src/api/resources/eligibility/client/Client.ts b/src/api/resources/eligibility/client/Client.ts
@@ -58,8 +58,8 @@ export class Eligibility {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/resources/health/client/Client.ts b/src/api/resources/health/client/Client.ts
@@ -47,8 +47,8 @@ export class Health {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/resources/notes/client/Client.ts b/src/api/resources/notes/client/Client.ts
@@ -55,8 +55,8 @@ export class Notes {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/resources/offerings/client/Client.ts b/src/api/resources/offerings/client/Client.ts
@@ -47,8 +47,8 @@ export class Offerings {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -107,8 +107,8 @@ export class Offerings {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -178,8 +178,8 @@ export class Offerings {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/resources/public/client/Client.ts b/src/api/resources/public/client/Client.ts
@@ -61,8 +61,8 @@ export class Public {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/resources/referrals/client/Client.ts b/src/api/resources/referrals/client/Client.ts
@@ -36,6 +36,8 @@ export class Referrals {
      *
      * @example
      *     await client.referrals.list({
+     *         offset: 1.1,
+     *         pageSize: 1.1,
      *         hciCode: "hciCode"
      *     })
      */
@@ -45,14 +47,8 @@ export class Referrals {
     ): Promise<ReferralExchange.PaginatedReferralsDto> {
         const { offset, pageSize, hciCode, status, role } = request;
         const _queryParams: Record<string, string | string[] | object | object[]> = {};
-        if (offset != null) {
-            _queryParams["offset"] = offset.toString();
-        }
-
-        if (pageSize != null) {
-            _queryParams["pageSize"] = pageSize.toString();
-        }
-
+        _queryParams["offset"] = offset.toString();
+        _queryParams["pageSize"] = pageSize.toString();
         _queryParams["hciCode"] = hciCode;
         if (status != null) {
             if (Array.isArray(status)) {
@@ -76,8 +72,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -142,9 +138,7 @@ export class Referrals {
      *         formResponses: [{
      *                 question: "question",
      *                 id: "id",
-     *                 answer: {
-     *                     "key": "value"
-     *                 }
+     *                 answer: "answer"
      *             }]
      *     })
      */
@@ -162,8 +156,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -231,8 +225,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -294,8 +288,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -358,8 +352,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -425,8 +419,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -492,8 +486,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -559,8 +553,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -622,8 +616,8 @@ export class Referrals {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/resources/referrals/client/requests/CreateReferralReq.ts b/src/api/resources/referrals/client/requests/CreateReferralReq.ts
@@ -27,9 +27,7 @@ import * as ReferralExchange from "../../../../index";
  *         formResponses: [{
  *                 question: "question",
  *                 id: "id",
- *                 answer: {
- *                     "key": "value"
- *                 }
+ *                 answer: "answer"
  *             }]
  *     }
  */

diff --git a/src/api/resources/referrals/client/requests/ReferralsListRequest.ts b/src/api/resources/referrals/client/requests/ReferralsListRequest.ts
@@ -7,18 +7,20 @@ import * as ReferralExchange from "../../../../index";
 /**
  * @example
  *     {
+ *         offset: 1.1,
+ *         pageSize: 1.1,
  *         hciCode: "hciCode"
  *     }
  */
 export interface ReferralsListRequest {
     /**
      * Offset for pagination
      */
-    offset?: number;
+    offset: number;
     /**
      * Number of items per page
      */
-    pageSize?: number;
+    pageSize: number;
     /**
      * To identify the requesting institution
      */

diff --git a/src/api/resources/webhooks/client/Client.ts b/src/api/resources/webhooks/client/Client.ts
@@ -46,8 +46,8 @@ export class Webhooks {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -105,8 +105,8 @@ export class Webhooks {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
-                "X-Fern-SDK-Version": "0.0.9",
-                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.9",
+                "X-Fern-SDK-Version": "0.0.10",
+                "User-Agent": "@opengovsg/refx-ts-sdk/0.0.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),

diff --git a/src/api/types/FormResponse.ts b/src/api/types/FormResponse.ts
@@ -2,8 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
+import * as ReferralExchange from "../index";
+
 export interface FormResponse {
     question: string;
     id: string;
-    answer: Record<string, unknown>;
+    answer: ReferralExchange.FormResponseAnswer;
 }
diff --git a/src/api/types/FormResponseAnswer.ts b/src/api/types/FormResponseAnswer.ts
@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type FormResponseAnswer = string | string[] | number;
diff --git a/src/api/types/InstitutionCoreDto.ts b/src/api/types/InstitutionCoreDto.ts
@@ -2,10 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
+import * as ReferralExchange from "../index";
+
 export interface InstitutionCoreDto {
     hciCode: string;
     name: string;
-    system: string;
+    system: ReferralExchange.InstitutionCoreDtoSystem;
     block: string;
     streetName: string;
     buildingName?: string;

diff --git a/src/api/types/InstitutionCoreDtoSystem.ts b/src/api/types/InstitutionCoreDtoSystem.ts
@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type InstitutionCoreDtoSystem = "HAS" | "PartnersBuddy" | "Refer" | "EmailAck";
+export const InstitutionCoreDtoSystem = {
+    Has: "HAS",
+    PartnersBuddy: "PartnersBuddy",
+    Refer: "Refer",
+    EmailAck: "EmailAck",
+} as const;
diff --git a/src/api/types/PaginatedQuery.ts b/src/api/types/PaginatedQuery.ts
@@ -4,7 +4,7 @@
 
 export interface PaginatedQuery {
     /** Offset for pagination */
-    offset?: number;
+    offset: number;
     /** Number of items per page */
-    pageSize?: number;
+    pageSize: number;
 }
diff --git a/src/api/types/ReferralAmendedMetadata.ts b/src/api/types/ReferralAmendedMetadata.ts
@@ -2,7 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
+import * as ReferralExchange from "../index";
+
 export interface ReferralAmendedMetadata {
-    before: Record<string, unknown>;
-    after: Record<string, unknown>;
+    before: ReferralExchange.ReferralAmendedMetadataBefore;
+    after: ReferralExchange.ReferralAmendedMetadataAfter;
 }
diff --git a/src/api/types/ReferralAmendedMetadataAfter.ts b/src/api/types/ReferralAmendedMetadataAfter.ts
@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ReferralAmendedMetadataAfter {
+    timeslotStartAt?: number;
+}
diff --git a/src/api/types/ReferralAmendedMetadataBefore.ts b/src/api/types/ReferralAmendedMetadataBefore.ts
@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ReferralAmendedMetadataBefore {
+    timeslotStartAt?: number;
+}