Skip to content

Commit 67d7d48

Browse files
fern-api[bot]fern-api[bot]
committed
Release 0.0.40
1 parent 2ec8e4d commit 67d7d48

File tree

24 files changed

+272
-74
lines changed

24 files changed

+272
-74
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ npm i -s @opengovsg/refx-ts-sdk
1313

1414
## Reference
1515

16-
A full reference for this library is available [here](./reference.md).
16+
A full reference for this library is available [here](https://github.com/opengovsg/refer-ts-sdk/blob/HEAD/./reference.md).
1717

1818
## Usage
1919

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@opengovsg/refx-ts-sdk",
3-
"version": "0.0.0-develop-1748577388",
3+
"version": "0.0.40",
44
"private": false,
55
"repository": "https://github.com/opengovsg/refer-ts-sdk",
66
"main": "./index.js",

‎reference.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -668,6 +668,57 @@ await client.offerings.list();
668668
</dl>
669669
</details>
670670

671+
<details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">apiHoldingControllerGetRecommendedOffering</a>({ ...params }) -> ReferralExchange.OfferingDto</code></summary>
672+
<dl>
673+
<dd>
674+
675+
#### 🔌 Usage
676+
677+
<dl>
678+
<dd>
679+
680+
<dl>
681+
<dd>
682+
683+
```typescript
684+
await client.offerings.apiHoldingControllerGetRecommendedOffering({
685+
category: "aac service",
686+
postalCode: "postalCode",
687+
});
688+
```
689+
690+
</dd>
691+
</dl>
692+
</dd>
693+
</dl>
694+
695+
#### ⚙️ Parameters
696+
697+
<dl>
698+
<dd>
699+
700+
<dl>
701+
<dd>
702+
703+
**request:** `ReferralExchange.ApiHoldingControllerGetRecommendedOfferingRequest`
704+
705+
</dd>
706+
</dl>
707+
708+
<dl>
709+
<dd>
710+
711+
**requestOptions:** `Offerings.RequestOptions`
712+
713+
</dd>
714+
</dl>
715+
</dd>
716+
</dl>
717+
718+
</dd>
719+
</dl>
720+
</details>
721+
671722
<details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">listTimeslots</a>(offeringId, { ...params }) -> ReferralExchange.Timeslot[]</code></summary>
672723
<dl>
673724
<dd>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ export class Eligibility {
7575
headers: {
7676
"X-Fern-Language": "JavaScript",
7777
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
78-
"X-Fern-SDK-Version": "0.0.0-develop-1748577388",
79-
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748577388",
78+
"X-Fern-SDK-Version": "0.0.40",
79+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
8080
"X-Fern-Runtime": core.RUNTIME.type,
8181
"X-Fern-Runtime-Version": core.RUNTIME.version,
8282
...(await this._getCustomAuthorizationHeaders()),

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ export class Health {
5050
headers: {
5151
"X-Fern-Language": "JavaScript",
5252
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
53-
"X-Fern-SDK-Version": "0.0.0-develop-1748577388",
54-
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748577388",
53+
"X-Fern-SDK-Version": "0.0.40",
54+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
5555
"X-Fern-Runtime": core.RUNTIME.type,
5656
"X-Fern-Runtime-Version": core.RUNTIME.version,
5757
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/index.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
export * as offerings from "./offerings";
2+
export * from "./offerings/types";
13
export * as links from "./links";
24
export * from "./links/types";
35
export * as eligibility from "./eligibility";
46
export * as referrals from "./referrals";
57
export * as notes from "./notes";
6-
export * as offerings from "./offerings";
78
export * as public_ from "./public";
89
export * as webhooks from "./webhooks";
910
export * as health from "./health";

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ export class Links {
6262
headers: {
6363
"X-Fern-Language": "JavaScript",
6464
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
65-
"X-Fern-SDK-Version": "0.0.0-develop-1748577388",
66-
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748577388",
65+
"X-Fern-SDK-Version": "0.0.40",
66+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
6767
"X-Fern-Runtime": core.RUNTIME.type,
6868
"X-Fern-Runtime-Version": core.RUNTIME.version,
6969
...(await this._getCustomAuthorizationHeaders()),

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ export class Notes {
6060
headers: {
6161
"X-Fern-Language": "JavaScript",
6262
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
63-
"X-Fern-SDK-Version": "0.0.0-develop-1748577388",
64-
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748577388",
63+
"X-Fern-SDK-Version": "0.0.40",
64+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
6565
"X-Fern-Runtime": core.RUNTIME.type,
6666
"X-Fern-Runtime-Version": core.RUNTIME.version,
6767
...(await this._getCustomAuthorizationHeaders()),

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

Lines changed: 85 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ export class Offerings {
7070
headers: {
7171
"X-Fern-Language": "JavaScript",
7272
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
73-
"X-Fern-SDK-Version": "0.0.0-develop-1748577388",
74-
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748577388",
73+
"X-Fern-SDK-Version": "0.0.40",
74+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
7575
"X-Fern-Runtime": core.RUNTIME.type,
7676
"X-Fern-Runtime-Version": core.RUNTIME.version,
7777
...(await this._getCustomAuthorizationHeaders()),
@@ -115,6 +115,87 @@ export class Offerings {
115115
}
116116
}
117117

118+
/**
119+
* @param {ReferralExchange.ApiHoldingControllerGetRecommendedOfferingRequest} request
120+
* @param {Offerings.RequestOptions} requestOptions - Request-specific configuration.
121+
*
122+
* @throws {@link ReferralExchange.UnauthorizedError}
123+
* @throws {@link ReferralExchange.NotFoundError}
124+
*
125+
* @example
126+
* await client.offerings.apiHoldingControllerGetRecommendedOffering({
127+
* category: "aac service",
128+
* postalCode: "postalCode"
129+
* })
130+
*/
131+
public async apiHoldingControllerGetRecommendedOffering(
132+
request: ReferralExchange.ApiHoldingControllerGetRecommendedOfferingRequest,
133+
requestOptions?: Offerings.RequestOptions,
134+
): Promise<ReferralExchange.OfferingDto> {
135+
const { category, postalCode } = request;
136+
const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
137+
_queryParams["category"] = category;
138+
_queryParams["postalCode"] = postalCode;
139+
const _response = await (this._options.fetcher ?? core.fetcher)({
140+
url: urlJoin(
141+
(await core.Supplier.get(this._options.baseUrl)) ??
142+
(await core.Supplier.get(this._options.environment)) ??
143+
environments.ReferralExchangeEnvironment.SmartCms,
144+
"api/v1/offerings/recommended",
145+
),
146+
method: "GET",
147+
headers: {
148+
"X-Fern-Language": "JavaScript",
149+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
150+
"X-Fern-SDK-Version": "0.0.40",
151+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
152+
"X-Fern-Runtime": core.RUNTIME.type,
153+
"X-Fern-Runtime-Version": core.RUNTIME.version,
154+
...(await this._getCustomAuthorizationHeaders()),
155+
...requestOptions?.headers,
156+
},
157+
contentType: "application/json",
158+
queryParameters: _queryParams,
159+
requestType: "json",
160+
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
161+
maxRetries: requestOptions?.maxRetries,
162+
abortSignal: requestOptions?.abortSignal,
163+
});
164+
if (_response.ok) {
165+
return _response.body as ReferralExchange.OfferingDto;
166+
}
167+
168+
if (_response.error.reason === "status-code") {
169+
switch (_response.error.statusCode) {
170+
case 401:
171+
throw new ReferralExchange.UnauthorizedError(_response.error.body as unknown);
172+
case 404:
173+
throw new ReferralExchange.NotFoundError(_response.error.body as unknown);
174+
default:
175+
throw new errors.ReferralExchangeError({
176+
statusCode: _response.error.statusCode,
177+
body: _response.error.body,
178+
});
179+
}
180+
}
181+
182+
switch (_response.error.reason) {
183+
case "non-json":
184+
throw new errors.ReferralExchangeError({
185+
statusCode: _response.error.statusCode,
186+
body: _response.error.rawBody,
187+
});
188+
case "timeout":
189+
throw new errors.ReferralExchangeTimeoutError(
190+
"Timeout exceeded when calling GET /api/v1/offerings/recommended.",
191+
);
192+
case "unknown":
193+
throw new errors.ReferralExchangeError({
194+
message: _response.error.errorMessage,
195+
});
196+
}
197+
}
198+
118199
/**
119200
* @param {string} offeringId
120201
* @param {ReferralExchange.OfferingsListTimeslotsRequest} request
@@ -150,8 +231,8 @@ export class Offerings {
150231
headers: {
151232
"X-Fern-Language": "JavaScript",
152233
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
153-
"X-Fern-SDK-Version": "0.0.0-develop-1748577388",
154-
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.0-develop-1748577388",
234+
"X-Fern-SDK-Version": "0.0.40",
235+
"User-Agent": "@opengovsg/refx-ts-sdk/0.0.40",
155236
"X-Fern-Runtime": core.RUNTIME.type,
156237
"X-Fern-Runtime-Version": core.RUNTIME.version,
157238
...(await this._getCustomAuthorizationHeaders()),

‎src/api/resources/offerings/client/requests/ApiHoldingControllerGetRecommendedOfferingRequest.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
* category: "aac service",
11+
* postalCode: "postalCode"
12+
* }
13+
*/
14+
export interface ApiHoldingControllerGetRecommendedOfferingRequest {
15+
/**
16+
* Offering category to retrieve recommendation for
17+
*/
18+
category: ReferralExchange.ApiHoldingControllerGetRecommendedOfferingRequestCategory;
19+
/**
20+
* Postal code of the patient to retrieve recommendation for
21+
*/
22+
postalCode: string;
23+
}

0 commit comments

Comments
 (0)