@opengovsg/refx-ts-sdk 0.0.65 → 0.0.71

package/api/types/InstitutionCoreDto.d.ts

@@ -1,13 +1,10 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface InstitutionCoreDto {
     hciCode: string;
     name: string;
     block: string;
     streetName: string;
-    buildingName?: string;
-    floorNumber?: string;
-    unitNumber?: string;
+    buildingName: string | null;
+    floorNumber: string | null;
+    unitNumber: string | null;
     postalCode: string;
 }

package/api/types/InstitutionCoreDto.js

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

package/api/types/InstitutionIdType.d.ts

@@ -1,7 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The type of institution ID
- */
-export type InstitutionIdType = "hci";
+/** The type of institution ID */
+export declare const InstitutionIdType: {
+    readonly Hci: "hci";
+};
+export type InstitutionIdType = (typeof InstitutionIdType)[keyof typeof InstitutionIdType];

package/api/types/InstitutionIdType.js

@@ -1,5 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstitutionIdType = void 0;
+/** The type of institution ID */
+exports.InstitutionIdType = {
+    Hci: "hci",
+};

package/api/types/NotFoundErrorBody.d.ts

@@ -1,8 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface NotFoundErrorBody {
-    statusCode?: number;
-    message?: string;
-    error?: string;
+    statusCode?: number | undefined;
+    message?: string | undefined;
+    error?: string | undefined;
 }

package/api/types/NotFoundErrorBody.js

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

package/api/types/NoteDto.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface NoteDto {
     id: string;
     content: string;

package/api/types/NoteDto.js

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

package/api/types/OfferingDto.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface OfferingDto {
     id: string;
     /** Name of the offering - use these as labels */
@@ -9,7 +6,7 @@ export interface OfferingDto {
     institutionHciCode: string;
     institution: ReferralExchange.InstitutionCoreDto;
     system: ReferralExchange.System;
-    /** Clinical guidelines and other information which clinicians should read before proceeding with creating the referral. May contain URLs - should be rendered in a Linkify component */
+    /** Clinical guidelines and other information which clinicians should read before proceeding with creating the referral. Rendered as markdown in the frontend infobox. Use `[label](https://…)` for links; bare URLs are not auto-linked. */
     description: string;
     /** Whether the offering is able to receive new referrals currently */
     isActive: boolean;
@@ -17,9 +14,9 @@ export interface OfferingDto {
     isSubsidisable: boolean;
     timeslotPolicy: ReferralExchange.TimeslotPolicy;
     /** Category of the offering. Used to group offerings together. */
-    category?: ReferralExchange.OfferingDtoCategory;
+    category?: ReferralExchange.OfferingDtoCategory | undefined;
     /** Specialty of the offering */
-    specialty?: string;
+    specialty?: string | undefined;
     /** NEHR code for the offering */
-    nehrCode?: string;
+    nehrCode?: string | undefined;
 }

package/api/types/OfferingDto.js

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

package/api/types/OfferingDtoCategory.d.ts

@@ -1,11 +1,8 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Category of the offering. Used to group offerings together.
- */
-export type OfferingDtoCategory = "aac" | "acp";
+/** Category of the offering. Used to group offerings together. */
 export declare const OfferingDtoCategory: {
     readonly Aac: "aac";
     readonly Acp: "acp";
+    readonly Gpfirst: "gpfirst";
+    readonly Ae: "ae";
 };
+export type OfferingDtoCategory = (typeof OfferingDtoCategory)[keyof typeof OfferingDtoCategory];

package/api/types/OfferingDtoCategory.js

@@ -1,10 +1,11 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OfferingDtoCategory = void 0;
+/** Category of the offering. Used to group offerings together. */
 exports.OfferingDtoCategory = {
     Aac: "aac",
     Acp: "acp",
+    Gpfirst: "gpfirst",
+    Ae: "ae",
 };

package/api/types/PaginatedQuery.d.ts

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface PaginatedQuery {
     /** Offset for pagination */
-    offset?: number;
+    offset?: number | undefined;
     /** Number of items per page */
-    pageSize?: number;
+    pageSize?: number | undefined;
 }

package/api/types/PaginatedQuery.js

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

package/api/types/PaginatedReferralsDto.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface PaginatedReferralsDto {
     data: ReferralExchange.ReferralDto[];
     metadata: ReferralExchange.PaginationMetadata;

package/api/types/PaginatedReferralsDto.js

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

package/api/types/PaginationMetadata.d.ts

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface PaginationMetadata {
     hasNext: boolean;
     totalCount: number;
-    nextParams?: ReferralExchange.PaginatedQuery;
+    nextParams?: ReferralExchange.PaginatedQuery | undefined;
 }

package/api/types/PaginationMetadata.js

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

package/api/types/ReferralActionLinkDto.d.ts

@@ -1,11 +1,10 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface ReferralActionLinkDto {
     /** The ID of the referral */
     referralId: string;
     /** The URL of the link */
     url: string;
     type: ReferralExchange.ReferralActionLinkType;
+    /** Human-readable label that can be displayed directly to users */
+    label: string;
 }

package/api/types/ReferralActionLinkDto.js

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

package/api/types/ReferralActionLinkType.d.ts

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * type of referral link
- */
-export type ReferralActionLinkType = "amend" | "select-timeslot" | "fill-singhealth-formsg";
+/** type of referral link */
 export declare const ReferralActionLinkType: {
     readonly Amend: "amend";
     readonly SelectTimeslot: "select-timeslot";
     readonly FillSinghealthFormsg: "fill-singhealth-formsg";
 };
+export type ReferralActionLinkType = (typeof ReferralActionLinkType)[keyof typeof ReferralActionLinkType];

package/api/types/ReferralActionLinkType.js

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferralActionLinkType = void 0;
+/** type of referral link */
 exports.ReferralActionLinkType = {
     Amend: "amend",
     SelectTimeslot: "select-timeslot",

package/api/types/ReferralDto.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface ReferralDto {
     id: string;
     sender: ReferralExchange.InstitutionCoreDto;
@@ -13,26 +10,30 @@ export interface ReferralDto {
     isUrgent: boolean;
     /** Created at (ISO datetime) */
     createdAt: string;
+    /** Submitted at (ISO datetime). Absent if the referral is a draft. */
+    submittedAt?: string | undefined;
     /** Updated at (ISO datetime) */
     updatedAt: string;
     formResponses: ReferralExchange.FormResponse[];
     /** List of forms required to complete the referral */
-    forms?: ReferralExchange.Form[];
+    forms?: ReferralExchange.Form[] | undefined;
     attachments: ReferralExchange.AttachmentDto[];
     /** URL to view the referral */
-    url?: string;
+    url?: string | undefined;
     /** Clinic license number */
-    clinicLicenseNumber?: string;
+    clinicLicenseNumber?: string | undefined;
     /** Clinic type */
-    clinicType?: ReferralExchange.ReferralDtoClinicType;
+    clinicType?: ReferralExchange.ReferralDtoClinicType | undefined;
     /** Any clinical information that is relevant to the referral, e.g. medical history, drug allergies, treatment provided, etc. */
-    clinicalInfo?: string;
+    clinicalInfo?: string | undefined;
+    /** Deprecated. Use coreStatus instead. */
     status: ReferralExchange.ReferralDtoStatus;
+    coreStatus: ReferralExchange.ReferralDtoCoreStatus;
     /** Whether this referral can be cancelled */
     isCancellable: boolean;
     /** Timeslot start time (ISO datetime) */
-    timeslotStartAt?: string;
+    timeslotStartAt?: string | undefined;
     /** Appointment location */
-    appointmentLocation?: string;
+    appointmentLocation?: string | undefined;
     notes: ReferralExchange.NoteDto[];
 }

package/api/types/ReferralDto.js

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

package/api/types/ReferralDtoClinicType.d.ts

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Clinic type
- */
-export type ReferralDtoClinicType = "CHAS-only" | "CHAS and HSG" | "CHAS and Healthier SG";
+/** Clinic type */
 export declare const ReferralDtoClinicType: {
     readonly ChasOnly: "CHAS-only";
     readonly ChasAndHsg: "CHAS and HSG";
     readonly ChasAndHealthierSg: "CHAS and Healthier SG";
 };
+export type ReferralDtoClinicType = (typeof ReferralDtoClinicType)[keyof typeof ReferralDtoClinicType];

package/api/types/ReferralDtoClinicType.js

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferralDtoClinicType = void 0;
+/** Clinic type */
 exports.ReferralDtoClinicType = {
     ChasOnly: "CHAS-only",
     ChasAndHsg: "CHAS and HSG",

package/api/types/ReferralDtoCoreStatus.d.ts

@@ -0,0 +1,9 @@
+export declare const ReferralDtoCoreStatus: {
+    readonly Draft: "draft";
+    readonly Pending: "pending";
+    readonly Confirmed: "confirmed";
+    readonly Rejected: "rejected";
+    readonly Cancelled: "cancelled";
+    readonly SenderActionRequired: "sender-action-required";
+};
+export type ReferralDtoCoreStatus = (typeof ReferralDtoCoreStatus)[keyof typeof ReferralDtoCoreStatus];

package/{dist/api/types/ReferralStatusFilter.js → api/types/ReferralDtoCoreStatus.js}

@@ -1,13 +1,12 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReferralStatusFilter = void 0;
-exports.ReferralStatusFilter = {
+exports.ReferralDtoCoreStatus = void 0;
+exports.ReferralDtoCoreStatus = {
     Draft: "draft",
     Pending: "pending",
     Confirmed: "confirmed",
     Rejected: "rejected",
     Cancelled: "cancelled",
+    SenderActionRequired: "sender-action-required",
 };

package/api/types/ReferralDtoStatus.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ReferralDtoStatus = "draft" | "created" | "processing-has" | "processing-pb" | "processing-ea" | "processing-bright" | "processing-fyi" | "processing-ngemr" | "pending-singhealth-formsg" | "pending-singhealth-call-centre" | "referral-confirmed-pending-appt" | "pending-email-ack" | "submitted-to-bright" | "pending-amend-timeslot" | "pending-acceptance" | "confirmed" | "sent" | "rejected" | "failed" | "pending-cancelled" | "cancelled";
+/** Deprecated. Use coreStatus instead. */
 export declare const ReferralDtoStatus: {
     readonly Draft: "draft";
     readonly Created: "created";
@@ -11,13 +8,13 @@ export declare const ReferralDtoStatus: {
     readonly ProcessingBright: "processing-bright";
     readonly ProcessingFyi: "processing-fyi";
     readonly ProcessingNgemr: "processing-ngemr";
-    readonly PendingSinghealthFormsg: "pending-singhealth-formsg";
     readonly PendingSinghealthCallCentre: "pending-singhealth-call-centre";
     readonly ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt";
     readonly PendingEmailAck: "pending-email-ack";
     readonly SubmittedToBright: "submitted-to-bright";
-    readonly PendingAmendTimeslot: "pending-amend-timeslot";
     readonly PendingAcceptance: "pending-acceptance";
+    readonly PendingSinghealthFormsg: "pending-singhealth-formsg";
+    readonly PendingAmendTimeslot: "pending-amend-timeslot";
     readonly Confirmed: "confirmed";
     readonly Sent: "sent";
     readonly Rejected: "rejected";
@@ -25,3 +22,4 @@ export declare const ReferralDtoStatus: {
     readonly PendingCancelled: "pending-cancelled";
     readonly Cancelled: "cancelled";
 };
+export type ReferralDtoStatus = (typeof ReferralDtoStatus)[keyof typeof ReferralDtoStatus];

package/api/types/ReferralDtoStatus.js

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferralDtoStatus = void 0;
+/** Deprecated. Use coreStatus instead. */
 exports.ReferralDtoStatus = {
     Draft: "draft",
     Created: "created",
@@ -13,13 +12,13 @@ exports.ReferralDtoStatus = {
     ProcessingBright: "processing-bright",
     ProcessingFyi: "processing-fyi",
     ProcessingNgemr: "processing-ngemr",
-    PendingSinghealthFormsg: "pending-singhealth-formsg",
     PendingSinghealthCallCentre: "pending-singhealth-call-centre",
     ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt",
     PendingEmailAck: "pending-email-ack",
     SubmittedToBright: "submitted-to-bright",
-    PendingAmendTimeslot: "pending-amend-timeslot",
     PendingAcceptance: "pending-acceptance",
+    PendingSinghealthFormsg: "pending-singhealth-formsg",
+    PendingAmendTimeslot: "pending-amend-timeslot",
     Confirmed: "confirmed",
     Sent: "sent",
     Rejected: "rejected",

package/api/types/ReferralRole.d.ts

@@ -1,8 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ReferralRole = "sender" | "receiver";
 export declare const ReferralRole: {
     readonly Sender: "sender";
     readonly Receiver: "receiver";
 };
+export type ReferralRole = (typeof ReferralRole)[keyof typeof ReferralRole];

package/api/types/ReferralRole.js

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

package/api/types/ReferralUpsertLinkDto.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface ReferralUpsertLinkDto {
     /** The ID of the referral */
     referralId: string;

package/api/types/ReferralUpsertLinkDto.js

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

package/api/types/ReferralUpsertLinkType.d.ts

@@ -1,7 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * type of referral link
- */
-export type ReferralUpsertLinkType = "upsert";
+/** type of referral link */
+export declare const ReferralUpsertLinkType: {
+    readonly Upsert: "upsert";
+};
+export type ReferralUpsertLinkType = (typeof ReferralUpsertLinkType)[keyof typeof ReferralUpsertLinkType];

package/api/types/ReferralUpsertLinkType.js

@@ -1,5 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralUpsertLinkType = void 0;
+/** type of referral link */
+exports.ReferralUpsertLinkType = {
+    Upsert: "upsert",
+};

package/api/types/ReferrerIdType.d.ts

@@ -1,10 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Type of ID specified in referrerId.
- */
-export type ReferrerIdType = "mcr" | "nric" | "email" | "brightUserId" | "dcr";
+/** Type of ID specified in referrerId. */
 export declare const ReferrerIdType: {
     readonly Mcr: "mcr";
     readonly Nric: "nric";
@@ -12,3 +6,4 @@ export declare const ReferrerIdType: {
     readonly BrightUserId: "brightUserId";
     readonly Dcr: "dcr";
 };
+export type ReferrerIdType = (typeof ReferrerIdType)[keyof typeof ReferrerIdType];

package/api/types/ReferrerIdType.js

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferrerIdType = void 0;
+/** Type of ID specified in referrerId. */
 exports.ReferrerIdType = {
     Mcr: "mcr",
     Nric: "nric",

package/api/types/ReferringDoctorDto.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface ReferringDoctorDto {
     mcr: string;
     idType: ReferralExchange.ReferrerIdType;

package/api/types/ReferringDoctorDto.js

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

package/api/types/System.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type System = "HAS" | "PartnersBuddy" | "Refer" | "EmailAck" | "Bright" | "FYI" | "AAC" | "NGEMR" | "GPConnect" | "CLINICASSIST" | "LINKDOCTORS" | "GALENHEALTH" | "VANDACMS" | "MANADR" | "PLATO" | "RAFFLESMG" | "RUBICON" | "SGIMED" | "UNITEDCREST" | "IAPPS" | "UNOTECH" | "ZANDEN" | "SCGINTERNAL";
 export declare const System: {
     readonly Has: "HAS";
     readonly PartnersBuddy: "PartnersBuddy";
@@ -11,6 +7,7 @@ export declare const System: {
     readonly Fyi: "FYI";
     readonly Aac: "AAC";
     readonly Ngemr: "NGEMR";
+    readonly Manual: "Manual";
     readonly GpConnect: "GPConnect";
     readonly Clinicassist: "CLINICASSIST";
     readonly Linkdoctors: "LINKDOCTORS";
@@ -27,3 +24,4 @@ export declare const System: {
     readonly Zanden: "ZANDEN";
     readonly Scginternal: "SCGINTERNAL";
 };
+export type System = (typeof System)[keyof typeof System];

package/api/types/System.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.System = void 0;
 exports.System = {
@@ -13,6 +11,7 @@ exports.System = {
     Fyi: "FYI",
     Aac: "AAC",
     Ngemr: "NGEMR",
+    Manual: "Manual",
     GpConnect: "GPConnect",
     Clinicassist: "CLINICASSIST",
     Linkdoctors: "LINKDOCTORS",

package/api/types/TimelineEventDto.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as ReferralExchange from "../index";
+import type * as ReferralExchange from "../index";
 export interface TimelineEventDto {
     type: ReferralExchange.TimelineEventType;
     description: string;

package/api/types/TimelineEventDto.js

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