Skip to content

Commit 361c846

Browse files
fern-api[bot]fern-api[bot]
committed
Release 2024.10.3
1 parent 64f4a05 commit 361c846

File tree

9 files changed

+57
-57
lines changed

9 files changed

+57
-57
lines changed

‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Opengovsg TypeScript Library
22

33
[![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)
4-
[![npm shield](https://img.shields.io/npm/v/ogp-refx)](https://www.npmjs.com/package/ogp-refx)
4+
[![npm shield](https://img.shields.io/npm/v/@opengovsg/refx-ts-sdk)](https://www.npmjs.com/package/@opengovsg/refx-ts-sdk)
55

66
The Opengovsg TypeScript library provides convenient access to the Opengovsg API from TypeScript.
77

88
## Installation
99

1010
```sh
11-
npm i -s ogp-refx
11+
npm i -s @opengovsg/refx-ts-sdk
1212
```
1313

1414
## Reference
@@ -20,7 +20,7 @@ A full reference for this library is available [here](./reference.md).
2020
Instantiate and use the client with the following:
2121

2222
```typescript
23-
import { ReferralExchangeClient } from "ogp-refx";
23+
import { ReferralExchangeClient } from "@opengovsg/refx-ts-sdk";
2424

2525
const client = new ReferralExchangeClient({ environment: "YOUR_BASE_URL", apiKey: "YOUR_API_KEY" });
2626
await client.referrals.upsert({
@@ -57,7 +57,7 @@ The SDK exports all request and response types as TypeScript interfaces. Simply
5757
following namespace:
5858

5959
```typescript
60-
import { ReferralExchange } from "ogp-refx";
60+
import { ReferralExchange } from "@opengovsg/refx-ts-sdk";
6161

6262
const request: ReferralExchange.EligibilityGetRequest = {
6363
...
@@ -70,7 +70,7 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
7070
will be thrown.
7171

7272
```typescript
73-
import { ReferralExchangeError } from "ogp-refx";
73+
import { ReferralExchangeError } from "@opengovsg/refx-ts-sdk";
7474

7575
try {
7676
await client.referrals.upsert(...);
@@ -157,7 +157,7 @@ The SDK provides a way for your to customize the underlying HTTP client / Fetch
157157
unsupported environment, this provides a way for you to break glass and ensure the SDK works.
158158

159159
```typescript
160-
import { ReferralExchangeClient } from "ogp-refx";
160+
import { ReferralExchangeClient } from "@opengovsg/refx-ts-sdk";
161161

162162
const client = new ReferralExchangeClient({
163163
...

‎package.json

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

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ export class Eligibility {
5252
method: "GET",
5353
headers: {
5454
"X-Fern-Language": "JavaScript",
55-
"X-Fern-SDK-Name": "ogp-refx",
56-
"X-Fern-SDK-Version": "0.0.3",
57-
"User-Agent": "ogp-refx/0.0.3",
55+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
56+
"X-Fern-SDK-Version": "2024.10.3",
57+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
5858
"X-Fern-Runtime": core.RUNTIME.type,
5959
"X-Fern-Runtime-Version": core.RUNTIME.version,
6060
...(await this._getCustomAuthorizationHeaders()),

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ export class Health {
4141
method: "GET",
4242
headers: {
4343
"X-Fern-Language": "JavaScript",
44-
"X-Fern-SDK-Name": "ogp-refx",
45-
"X-Fern-SDK-Version": "0.0.3",
46-
"User-Agent": "ogp-refx/0.0.3",
44+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
45+
"X-Fern-SDK-Version": "2024.10.3",
46+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
4747
"X-Fern-Runtime": core.RUNTIME.type,
4848
"X-Fern-Runtime-Version": core.RUNTIME.version,
4949
...(await this._getCustomAuthorizationHeaders()),

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ export class Offerings {
4141
method: "GET",
4242
headers: {
4343
"X-Fern-Language": "JavaScript",
44-
"X-Fern-SDK-Name": "ogp-refx",
45-
"X-Fern-SDK-Version": "0.0.3",
46-
"User-Agent": "ogp-refx/0.0.3",
44+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
45+
"X-Fern-SDK-Version": "2024.10.3",
46+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
4747
"X-Fern-Runtime": core.RUNTIME.type,
4848
"X-Fern-Runtime-Version": core.RUNTIME.version,
4949
...(await this._getCustomAuthorizationHeaders()),
@@ -100,9 +100,9 @@ export class Offerings {
100100
method: "GET",
101101
headers: {
102102
"X-Fern-Language": "JavaScript",
103-
"X-Fern-SDK-Name": "ogp-refx",
104-
"X-Fern-SDK-Version": "0.0.3",
105-
"User-Agent": "ogp-refx/0.0.3",
103+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
104+
"X-Fern-SDK-Version": "2024.10.3",
105+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
106106
"X-Fern-Runtime": core.RUNTIME.type,
107107
"X-Fern-Runtime-Version": core.RUNTIME.version,
108108
...(await this._getCustomAuthorizationHeaders()),
@@ -172,9 +172,9 @@ export class Offerings {
172172
method: "GET",
173173
headers: {
174174
"X-Fern-Language": "JavaScript",
175-
"X-Fern-SDK-Name": "ogp-refx",
176-
"X-Fern-SDK-Version": "0.0.3",
177-
"User-Agent": "ogp-refx/0.0.3",
175+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
176+
"X-Fern-SDK-Version": "2024.10.3",
177+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
178178
"X-Fern-Runtime": core.RUNTIME.type,
179179
"X-Fern-Runtime-Version": core.RUNTIME.version,
180180
...(await this._getCustomAuthorizationHeaders()),

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ export class Public {
5050
method: "GET",
5151
headers: {
5252
"X-Fern-Language": "JavaScript",
53-
"X-Fern-SDK-Name": "ogp-refx",
54-
"X-Fern-SDK-Version": "0.0.3",
55-
"User-Agent": "ogp-refx/0.0.3",
53+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
54+
"X-Fern-SDK-Version": "2024.10.3",
55+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
5656
"X-Fern-Runtime": core.RUNTIME.type,
5757
"X-Fern-Runtime-Version": core.RUNTIME.version,
5858
...(await this._getCustomAuthorizationHeaders()),

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

+24-24
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ export class Referrals {
7070
method: "GET",
7171
headers: {
7272
"X-Fern-Language": "JavaScript",
73-
"X-Fern-SDK-Name": "ogp-refx",
74-
"X-Fern-SDK-Version": "0.0.3",
75-
"User-Agent": "ogp-refx/0.0.3",
73+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
74+
"X-Fern-SDK-Version": "2024.10.3",
75+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
7676
"X-Fern-Runtime": core.RUNTIME.type,
7777
"X-Fern-Runtime-Version": core.RUNTIME.version,
7878
...(await this._getCustomAuthorizationHeaders()),
@@ -152,9 +152,9 @@ export class Referrals {
152152
method: "POST",
153153
headers: {
154154
"X-Fern-Language": "JavaScript",
155-
"X-Fern-SDK-Name": "ogp-refx",
156-
"X-Fern-SDK-Version": "0.0.3",
157-
"User-Agent": "ogp-refx/0.0.3",
155+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
156+
"X-Fern-SDK-Version": "2024.10.3",
157+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
158158
"X-Fern-Runtime": core.RUNTIME.type,
159159
"X-Fern-Runtime-Version": core.RUNTIME.version,
160160
...(await this._getCustomAuthorizationHeaders()),
@@ -212,9 +212,9 @@ export class Referrals {
212212
method: "GET",
213213
headers: {
214214
"X-Fern-Language": "JavaScript",
215-
"X-Fern-SDK-Name": "ogp-refx",
216-
"X-Fern-SDK-Version": "0.0.3",
217-
"User-Agent": "ogp-refx/0.0.3",
215+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
216+
"X-Fern-SDK-Version": "2024.10.3",
217+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
218218
"X-Fern-Runtime": core.RUNTIME.type,
219219
"X-Fern-Runtime-Version": core.RUNTIME.version,
220220
...(await this._getCustomAuthorizationHeaders()),
@@ -273,9 +273,9 @@ export class Referrals {
273273
method: "DELETE",
274274
headers: {
275275
"X-Fern-Language": "JavaScript",
276-
"X-Fern-SDK-Name": "ogp-refx",
277-
"X-Fern-SDK-Version": "0.0.3",
278-
"User-Agent": "ogp-refx/0.0.3",
276+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
277+
"X-Fern-SDK-Version": "2024.10.3",
278+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
279279
"X-Fern-Runtime": core.RUNTIME.type,
280280
"X-Fern-Runtime-Version": core.RUNTIME.version,
281281
...(await this._getCustomAuthorizationHeaders()),
@@ -336,9 +336,9 @@ export class Referrals {
336336
method: "POST",
337337
headers: {
338338
"X-Fern-Language": "JavaScript",
339-
"X-Fern-SDK-Name": "ogp-refx",
340-
"X-Fern-SDK-Version": "0.0.3",
341-
"User-Agent": "ogp-refx/0.0.3",
339+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
340+
"X-Fern-SDK-Version": "2024.10.3",
341+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
342342
"X-Fern-Runtime": core.RUNTIME.type,
343343
"X-Fern-Runtime-Version": core.RUNTIME.version,
344344
...(await this._getCustomAuthorizationHeaders()),
@@ -402,9 +402,9 @@ export class Referrals {
402402
method: "POST",
403403
headers: {
404404
"X-Fern-Language": "JavaScript",
405-
"X-Fern-SDK-Name": "ogp-refx",
406-
"X-Fern-SDK-Version": "0.0.3",
407-
"User-Agent": "ogp-refx/0.0.3",
405+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
406+
"X-Fern-SDK-Version": "2024.10.3",
407+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
408408
"X-Fern-Runtime": core.RUNTIME.type,
409409
"X-Fern-Runtime-Version": core.RUNTIME.version,
410410
...(await this._getCustomAuthorizationHeaders()),
@@ -468,9 +468,9 @@ export class Referrals {
468468
method: "POST",
469469
headers: {
470470
"X-Fern-Language": "JavaScript",
471-
"X-Fern-SDK-Name": "ogp-refx",
472-
"X-Fern-SDK-Version": "0.0.3",
473-
"User-Agent": "ogp-refx/0.0.3",
471+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
472+
"X-Fern-SDK-Version": "2024.10.3",
473+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
474474
"X-Fern-Runtime": core.RUNTIME.type,
475475
"X-Fern-Runtime-Version": core.RUNTIME.version,
476476
...(await this._getCustomAuthorizationHeaders()),
@@ -534,9 +534,9 @@ export class Referrals {
534534
method: "POST",
535535
headers: {
536536
"X-Fern-Language": "JavaScript",
537-
"X-Fern-SDK-Name": "ogp-refx",
538-
"X-Fern-SDK-Version": "0.0.3",
539-
"User-Agent": "ogp-refx/0.0.3",
537+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
538+
"X-Fern-SDK-Version": "2024.10.3",
539+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
540540
"X-Fern-Runtime": core.RUNTIME.type,
541541
"X-Fern-Runtime-Version": core.RUNTIME.version,
542542
...(await this._getCustomAuthorizationHeaders()),

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ export class Webhooks {
4343
method: "POST",
4444
headers: {
4545
"X-Fern-Language": "JavaScript",
46-
"X-Fern-SDK-Name": "ogp-refx",
47-
"X-Fern-SDK-Version": "0.0.3",
48-
"User-Agent": "ogp-refx/0.0.3",
46+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
47+
"X-Fern-SDK-Version": "2024.10.3",
48+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
4949
"X-Fern-Runtime": core.RUNTIME.type,
5050
"X-Fern-Runtime-Version": core.RUNTIME.version,
5151
...(await this._getCustomAuthorizationHeaders()),
@@ -101,9 +101,9 @@ export class Webhooks {
101101
method: "POST",
102102
headers: {
103103
"X-Fern-Language": "JavaScript",
104-
"X-Fern-SDK-Name": "ogp-refx",
105-
"X-Fern-SDK-Version": "0.0.3",
106-
"User-Agent": "ogp-refx/0.0.3",
104+
"X-Fern-SDK-Name": "@opengovsg/refx-ts-sdk",
105+
"X-Fern-SDK-Version": "2024.10.3",
106+
"User-Agent": "@opengovsg/refx-ts-sdk/2024.10.3",
107107
"X-Fern-Runtime": core.RUNTIME.type,
108108
"X-Fern-Runtime-Version": core.RUNTIME.version,
109109
...(await this._getCustomAuthorizationHeaders()),

‎src/version.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export const SDK_VERSION = "0.0.3";
1+
export const SDK_VERSION = "2024.10.3";

0 commit comments

Comments
 (0)