Skip to content

Commit e730fb2

Browse files
fern-api[bot]fern-api[bot]
committed
Release 2025.2.21
1 parent 822ddea commit e730fb2

20 files changed

+203
-39
lines changed

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@opengovsg/refx-ts-sdk",
3-
"version": "2025.2.20",
3+
"version": "2025.2.21",
44
"private": false,
55
"repository": "https://github.com/opengovsg/refer-ts-sdk",
66
"main": "./index.js",

‎reference.md

+56
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,62 @@ await client.referrals.backToDraft("referralId");
560560
</dl>
561561
</details>
562562

563+
<details><summary><code>client.referrals.<a href="/src/api/resources/referrals/client/Client.ts">apiHoldingControllerTriggerEmailReminder</a>(referralId, { ...params }) -> void</code></summary>
564+
<dl>
565+
<dd>
566+
567+
#### 🔌 Usage
568+
569+
<dl>
570+
<dd>
571+
572+
<dl>
573+
<dd>
574+
575+
```typescript
576+
await client.referrals.apiHoldingControllerTriggerEmailReminder("referralId");
577+
```
578+
579+
</dd>
580+
</dl>
581+
</dd>
582+
</dl>
583+
584+
#### ⚙️ Parameters
585+
586+
<dl>
587+
<dd>
588+
589+
<dl>
590+
<dd>
591+
592+
**referralId:** `string` — Referral ID
593+
594+
</dd>
595+
</dl>
596+
597+
<dl>
598+
<dd>
599+
600+
**request:** `ReferralExchange.TriggerEmailReminderBody`
601+
602+
</dd>
603+
</dl>
604+
605+
<dl>
606+
<dd>
607+
608+
**requestOptions:** `Referrals.RequestOptions`
609+
610+
</dd>
611+
</dl>
612+
</dd>
613+
</dl>
614+
615+
</dd>
616+
</dl>
617+
</details>
618+
563619
## Notes
564620

565621
<details><summary><code>client.notes.<a href="/src/api/resources/notes/client/Client.ts">create</a>(referralId, { ...params }) -> ReferralExchange.NoteDto</code></summary>

‎src/api/resources/eligibility/client/Client.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ export class Eligibility {
5858
headers: {
5959
"X-Fern-Language": "JavaScript",
6060
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
61-
"X-Fern-SDK-Version": "2025.2.20",
62-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
61+
"X-Fern-SDK-Version": "2025.2.21",
62+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
6363
"X-Fern-Runtime": core.RUNTIME.type,
6464
"X-Fern-Runtime-Version": core.RUNTIME.version,
6565
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/health/client/Client.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ export class Health {
4747
headers: {
4848
"X-Fern-Language": "JavaScript",
4949
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
50-
"X-Fern-SDK-Version": "2025.2.20",
51-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
50+
"X-Fern-SDK-Version": "2025.2.21",
51+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
5252
"X-Fern-Runtime": core.RUNTIME.type,
5353
"X-Fern-Runtime-Version": core.RUNTIME.version,
5454
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/notes/client/Client.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ export class Notes {
5555
headers: {
5656
"X-Fern-Language": "JavaScript",
5757
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
58-
"X-Fern-SDK-Version": "2025.2.20",
59-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
58+
"X-Fern-SDK-Version": "2025.2.21",
59+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
6060
"X-Fern-Runtime": core.RUNTIME.type,
6161
"X-Fern-Runtime-Version": core.RUNTIME.version,
6262
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/offerings/client/Client.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ export class Offerings {
4747
headers: {
4848
"X-Fern-Language": "JavaScript",
4949
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
50-
"X-Fern-SDK-Version": "2025.2.20",
51-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
50+
"X-Fern-SDK-Version": "2025.2.21",
51+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
5252
"X-Fern-Runtime": core.RUNTIME.type,
5353
"X-Fern-Runtime-Version": core.RUNTIME.version,
5454
...(await this._getCustomAuthorizationHeaders()),
@@ -116,8 +116,8 @@ export class Offerings {
116116
headers: {
117117
"X-Fern-Language": "JavaScript",
118118
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
119-
"X-Fern-SDK-Version": "2025.2.20",
120-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
119+
"X-Fern-SDK-Version": "2025.2.21",
120+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
121121
"X-Fern-Runtime": core.RUNTIME.type,
122122
"X-Fern-Runtime-Version": core.RUNTIME.version,
123123
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/public/client/Client.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ export class Public {
6161
headers: {
6262
"X-Fern-Language": "JavaScript",
6363
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
64-
"X-Fern-SDK-Version": "2025.2.20",
65-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
64+
"X-Fern-SDK-Version": "2025.2.21",
65+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
6666
"X-Fern-Runtime": core.RUNTIME.type,
6767
"X-Fern-Runtime-Version": core.RUNTIME.version,
6868
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/referrals/client/Client.ts

+83-18
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ export class Referrals {
7676
headers: {
7777
"X-Fern-Language": "JavaScript",
7878
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
79-
"X-Fern-SDK-Version": "2025.2.20",
80-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
79+
"X-Fern-SDK-Version": "2025.2.21",
80+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
8181
"X-Fern-Runtime": core.RUNTIME.type,
8282
"X-Fern-Runtime-Version": core.RUNTIME.version,
8383
...(await this._getCustomAuthorizationHeaders()),
@@ -160,8 +160,8 @@ export class Referrals {
160160
headers: {
161161
"X-Fern-Language": "JavaScript",
162162
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
163-
"X-Fern-SDK-Version": "2025.2.20",
164-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
163+
"X-Fern-SDK-Version": "2025.2.21",
164+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
165165
"X-Fern-Runtime": core.RUNTIME.type,
166166
"X-Fern-Runtime-Version": core.RUNTIME.version,
167167
...(await this._getCustomAuthorizationHeaders()),
@@ -229,8 +229,8 @@ export class Referrals {
229229
headers: {
230230
"X-Fern-Language": "JavaScript",
231231
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
232-
"X-Fern-SDK-Version": "2025.2.20",
233-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
232+
"X-Fern-SDK-Version": "2025.2.21",
233+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
234234
"X-Fern-Runtime": core.RUNTIME.type,
235235
"X-Fern-Runtime-Version": core.RUNTIME.version,
236236
...(await this._getCustomAuthorizationHeaders()),
@@ -292,8 +292,8 @@ export class Referrals {
292292
headers: {
293293
"X-Fern-Language": "JavaScript",
294294
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
295-
"X-Fern-SDK-Version": "2025.2.20",
296-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
295+
"X-Fern-SDK-Version": "2025.2.21",
296+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
297297
"X-Fern-Runtime": core.RUNTIME.type,
298298
"X-Fern-Runtime-Version": core.RUNTIME.version,
299299
...(await this._getCustomAuthorizationHeaders()),
@@ -356,8 +356,8 @@ export class Referrals {
356356
headers: {
357357
"X-Fern-Language": "JavaScript",
358358
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
359-
"X-Fern-SDK-Version": "2025.2.20",
360-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
359+
"X-Fern-SDK-Version": "2025.2.21",
360+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
361361
"X-Fern-Runtime": core.RUNTIME.type,
362362
"X-Fern-Runtime-Version": core.RUNTIME.version,
363363
...(await this._getCustomAuthorizationHeaders()),
@@ -423,8 +423,8 @@ export class Referrals {
423423
headers: {
424424
"X-Fern-Language": "JavaScript",
425425
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
426-
"X-Fern-SDK-Version": "2025.2.20",
427-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
426+
"X-Fern-SDK-Version": "2025.2.21",
427+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
428428
"X-Fern-Runtime": core.RUNTIME.type,
429429
"X-Fern-Runtime-Version": core.RUNTIME.version,
430430
...(await this._getCustomAuthorizationHeaders()),
@@ -490,8 +490,8 @@ export class Referrals {
490490
headers: {
491491
"X-Fern-Language": "JavaScript",
492492
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
493-
"X-Fern-SDK-Version": "2025.2.20",
494-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
493+
"X-Fern-SDK-Version": "2025.2.21",
494+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
495495
"X-Fern-Runtime": core.RUNTIME.type,
496496
"X-Fern-Runtime-Version": core.RUNTIME.version,
497497
...(await this._getCustomAuthorizationHeaders()),
@@ -557,8 +557,8 @@ export class Referrals {
557557
headers: {
558558
"X-Fern-Language": "JavaScript",
559559
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
560-
"X-Fern-SDK-Version": "2025.2.20",
561-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
560+
"X-Fern-SDK-Version": "2025.2.21",
561+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
562562
"X-Fern-Runtime": core.RUNTIME.type,
563563
"X-Fern-Runtime-Version": core.RUNTIME.version,
564564
...(await this._getCustomAuthorizationHeaders()),
@@ -620,8 +620,8 @@ export class Referrals {
620620
headers: {
621621
"X-Fern-Language": "JavaScript",
622622
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
623-
"X-Fern-SDK-Version": "2025.2.20",
624-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
623+
"X-Fern-SDK-Version": "2025.2.21",
624+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
625625
"X-Fern-Runtime": core.RUNTIME.type,
626626
"X-Fern-Runtime-Version": core.RUNTIME.version,
627627
...(await this._getCustomAuthorizationHeaders()),
@@ -661,6 +661,71 @@ export class Referrals {
661661
}
662662
}
663663

664+
/**
665+
* @param {string} referralId - Referral ID
666+
* @param {ReferralExchange.TriggerEmailReminderBody} request
667+
* @param {Referrals.RequestOptions} requestOptions - Request-specific configuration.
668+
*
669+
* @example
670+
* await client.referrals.apiHoldingControllerTriggerEmailReminder("referralId")
671+
*/
672+
public async apiHoldingControllerTriggerEmailReminder(
673+
referralId: string,
674+
request: ReferralExchange.TriggerEmailReminderBody = {},
675+
requestOptions?: Referrals.RequestOptions
676+
): Promise<void> {
677+
const _response = await (this._options.fetcher ?? core.fetcher)({
678+
url: urlJoin(
679+
(await core.Supplier.get(this._options.environment)) ??
680+
environments.ReferralExchangeEnvironment.Production,
681+
`api/v1/referrals/${encodeURIComponent(referralId)}/reminder`
682+
),
683+
method: "POST",
684+
headers: {
685+
"X-Fern-Language": "JavaScript",
686+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
687+
"X-Fern-SDK-Version": "2025.2.21",
688+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
689+
"X-Fern-Runtime": core.RUNTIME.type,
690+
"X-Fern-Runtime-Version": core.RUNTIME.version,
691+
...(await this._getCustomAuthorizationHeaders()),
692+
...requestOptions?.headers,
693+
},
694+
contentType: "application/json",
695+
requestType: "json",
696+
body: request,
697+
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
698+
maxRetries: requestOptions?.maxRetries,
699+
abortSignal: requestOptions?.abortSignal,
700+
});
701+
if (_response.ok) {
702+
return;
703+
}
704+
705+
if (_response.error.reason === "status-code") {
706+
throw new errors.ReferralExchangeError({
707+
statusCode: _response.error.statusCode,
708+
body: _response.error.body,
709+
});
710+
}
711+
712+
switch (_response.error.reason) {
713+
case "non-json":
714+
throw new errors.ReferralExchangeError({
715+
statusCode: _response.error.statusCode,
716+
body: _response.error.rawBody,
717+
});
718+
case "timeout":
719+
throw new errors.ReferralExchangeTimeoutError(
720+
"Timeout exceeded when calling POST /api/v1/referrals/{referralId}/reminder."
721+
);
722+
case "unknown":
723+
throw new errors.ReferralExchangeError({
724+
message: _response.error.errorMessage,
725+
});
726+
}
727+
}
728+
664729
protected async _getCustomAuthorizationHeaders() {
665730
const apiKeyValue = await core.Supplier.get(this._options.apiKey);
666731
return { Authorization: apiKeyValue };

‎src/api/resources/referrals/client/requests/TriggerEmailReminderBody.ts

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/**
2+
* This file was auto-generated by Fern from our API Definition.
3+
*/
4+
5+
import * as ReferralExchange from "../../../../index";
6+
7+
/**
8+
* @example
9+
* {}
10+
*/
11+
export interface TriggerEmailReminderBody {
12+
/** Email to cc the reminder to */
13+
ccEmail?: string;
14+
/** Email to send the reminder from */
15+
fromEmail?: string;
16+
/** Signature to be added to the email */
17+
signature?: ReferralExchange.EmailReminderSignature;
18+
}

‎src/api/resources/referrals/client/requests/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ export { type CancelReferralReq } from "./CancelReferralReq";
55
export { type AmendReferralReq } from "./AmendReferralReq";
66
export { type EaConfirmReferralBody } from "./EaConfirmReferralBody";
77
export { type EaRejectReferralBody } from "./EaRejectReferralBody";
8+
export { type TriggerEmailReminderBody } from "./TriggerEmailReminderBody";

‎src/api/resources/webhooks/client/Client.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ export class Webhooks {
4646
headers: {
4747
"X-Fern-Language": "JavaScript",
4848
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
49-
"X-Fern-SDK-Version": "2025.2.20",
50-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
49+
"X-Fern-SDK-Version": "2025.2.21",
50+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
5151
"X-Fern-Runtime": core.RUNTIME.type,
5252
"X-Fern-Runtime-Version": core.RUNTIME.version,
5353
...(await this._getCustomAuthorizationHeaders()),
@@ -105,8 +105,8 @@ export class Webhooks {
105105
headers: {
106106
"X-Fern-Language": "JavaScript",
107107
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
108-
"X-Fern-SDK-Version": "2025.2.20",
109-
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.20",
108+
"X-Fern-SDK-Version": "2025.2.21",
109+
"User-Agent": "@opengovsg/refx-ts-sdk/2025.2.21",
110110
"X-Fern-Runtime": core.RUNTIME.type,
111111
"X-Fern-Runtime-Version": core.RUNTIME.version,
112112
...(await this._getCustomAuthorizationHeaders()),

‎src/api/types/EmailReminderSignature.ts

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* This file was auto-generated by Fern from our API Definition.
3+
*/
4+
5+
export interface EmailReminderSignature {
6+
/** Name of the person signing the email */
7+
name: string;
8+
/** Title of the person signing the email */
9+
title: string;
10+
}

‎src/api/types/FullReferralDtoStatus.ts

+4
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ export type FullReferralDtoStatus =
99
| "processing-pb"
1010
| "processing-ea"
1111
| "processing-bright"
12+
| "processing-fyi"
1213
| "pending-singhealth-formsg"
1314
| "pending-singhealth-call-centre"
1415
| "referral-confirmed-pending-appt"
1516
| "pending-email-ack"
1617
| "submitted-to-bright"
1718
| "pending-amend-timeslot"
1819
| "confirmed"
20+
| "sent"
1921
| "rejected"
2022
| "failed"
2123
| "pending-cancelled"
@@ -27,13 +29,15 @@ export const FullReferralDtoStatus = {
2729
ProcessingPb: "processing-pb",
2830
ProcessingEa: "processing-ea",
2931
ProcessingBright: "processing-bright",
32+
ProcessingFyi: "processing-fyi",
3033
PendingSinghealthFormsg: "pending-singhealth-formsg",
3134
PendingSinghealthCallCentre: "pending-singhealth-call-centre",
3235
ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt",
3336
PendingEmailAck: "pending-email-ack",
3437
SubmittedToBright: "submitted-to-bright",
3538
PendingAmendTimeslot: "pending-amend-timeslot",
3639
Confirmed: "confirmed",
40+
Sent: "sent",
3741
Rejected: "rejected",
3842
Failed: "failed",
3943
PendingCancelled: "pending-cancelled",

0 commit comments

Comments
 (0)