@opengovsg/refx-ts-sdk 0.0.0-develop-1748577388 → 0.0.0-develop-1749093103

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/README.md +1 -1
  2. package/api/resources/eligibility/client/Client.js +1 -1
  3. package/api/resources/health/client/Client.js +1 -1
  4. package/api/resources/index.d.ts +2 -1
  5. package/api/resources/index.js +3 -2
  6. package/api/resources/links/client/Client.d.ts +2 -2
  7. package/api/resources/links/client/Client.js +3 -3
  8. package/api/resources/links/client/requests/CreateLinkReqUpsert.d.ts +4 -5
  9. package/api/resources/notes/client/Client.js +1 -1
  10. package/api/resources/offerings/client/Client.d.ts +14 -0
  11. package/api/resources/offerings/client/Client.js +64 -2
  12. package/api/resources/offerings/client/requests/ApiHoldingControllerGetRecommendedOfferingRequest.d.ts +21 -0
  13. package/api/resources/offerings/client/requests/ApiHoldingControllerGetRecommendedOfferingRequest.js +5 -0
  14. package/api/resources/offerings/client/requests/index.d.ts +1 -0
  15. package/api/resources/offerings/index.d.ts +1 -0
  16. package/api/resources/offerings/index.js +1 -0
  17. package/api/resources/offerings/types/ApiHoldingControllerGetRecommendedOfferingRequestCategory.d.ts +8 -0
  18. package/api/resources/offerings/types/ApiHoldingControllerGetRecommendedOfferingRequestCategory.js +10 -0
  19. package/api/resources/offerings/types/index.d.ts +1 -0
  20. package/api/resources/offerings/types/index.js +17 -0
  21. package/api/resources/public/client/Client.js +1 -1
  22. package/api/resources/referrals/client/Client.js +22 -10
  23. package/api/resources/referrals/client/requests/CreateReferralReq.d.ts +1 -0
  24. package/api/resources/referrals/client/requests/ReferralsListRequest.d.ts +16 -0
  25. package/api/resources/webhooks/client/Client.js +2 -2
  26. package/api/types/FullReferralDto.d.ts +1 -0
  27. package/api/types/OfferingDto.d.ts +2 -0
  28. package/api/types/OfferingDtoCategory.d.ts +11 -0
  29. package/api/types/OfferingDtoCategory.js +10 -0
  30. package/api/types/OfferingWithAllowedDto.d.ts +2 -0
  31. package/api/types/OfferingWithAllowedDtoCategory.d.ts +11 -0
  32. package/api/types/OfferingWithAllowedDtoCategory.js +10 -0
  33. package/api/types/PublicReferralDto.d.ts +1 -0
  34. package/api/types/ReferralDto.d.ts +1 -0
  35. package/api/types/ReferrerIdType.d.ts +1 -1
  36. package/api/types/ReferringDoctorDto.d.ts +2 -0
  37. package/api/types/index.d.ts +2 -0
  38. package/api/types/index.js +2 -0
  39. package/dist/api/resources/eligibility/client/Client.js +1 -1
  40. package/dist/api/resources/health/client/Client.js +1 -1
  41. package/dist/api/resources/index.d.ts +2 -1
  42. package/dist/api/resources/index.js +3 -2
  43. package/dist/api/resources/links/client/Client.d.ts +2 -2
  44. package/dist/api/resources/links/client/Client.js +3 -3
  45. package/dist/api/resources/links/client/requests/CreateLinkReqUpsert.d.ts +4 -5
  46. package/dist/api/resources/notes/client/Client.js +1 -1
  47. package/dist/api/resources/offerings/client/Client.d.ts +14 -0
  48. package/dist/api/resources/offerings/client/Client.js +64 -2
  49. package/dist/api/resources/offerings/client/requests/ApiHoldingControllerGetRecommendedOfferingRequest.d.ts +21 -0
  50. package/dist/api/resources/offerings/client/requests/ApiHoldingControllerGetRecommendedOfferingRequest.js +5 -0
  51. package/dist/api/resources/offerings/client/requests/index.d.ts +1 -0
  52. package/dist/api/resources/offerings/index.d.ts +1 -0
  53. package/dist/api/resources/offerings/index.js +1 -0
  54. package/dist/api/resources/offerings/types/ApiHoldingControllerGetRecommendedOfferingRequestCategory.d.ts +8 -0
  55. package/dist/api/resources/offerings/types/ApiHoldingControllerGetRecommendedOfferingRequestCategory.js +10 -0
  56. package/dist/api/resources/offerings/types/index.d.ts +1 -0
  57. package/dist/api/resources/offerings/types/index.js +17 -0
  58. package/dist/api/resources/public/client/Client.js +1 -1
  59. package/dist/api/resources/referrals/client/Client.js +22 -10
  60. package/dist/api/resources/referrals/client/requests/CreateReferralReq.d.ts +1 -0
  61. package/dist/api/resources/referrals/client/requests/ReferralsListRequest.d.ts +16 -0
  62. package/dist/api/resources/webhooks/client/Client.js +2 -2
  63. package/dist/api/types/FullReferralDto.d.ts +1 -0
  64. package/dist/api/types/OfferingDto.d.ts +2 -0
  65. package/dist/api/types/OfferingDtoCategory.d.ts +11 -0
  66. package/dist/api/types/OfferingDtoCategory.js +10 -0
  67. package/dist/api/types/OfferingWithAllowedDto.d.ts +2 -0
  68. package/dist/api/types/OfferingWithAllowedDtoCategory.d.ts +11 -0
  69. package/dist/api/types/OfferingWithAllowedDtoCategory.js +10 -0
  70. package/dist/api/types/PublicReferralDto.d.ts +1 -0
  71. package/dist/api/types/ReferralDto.d.ts +1 -0
  72. package/dist/api/types/ReferrerIdType.d.ts +1 -1
  73. package/dist/api/types/ReferringDoctorDto.d.ts +2 -0
  74. package/dist/api/types/index.d.ts +2 -0
  75. package/dist/api/types/index.js +2 -0
  76. package/dist/version.d.ts +1 -1
  77. package/dist/version.js +1 -1
  78. package/package.json +1 -1
  79. package/reference.md +52 -1
  80. package/version.d.ts +1 -1
  81. package/version.js +1 -1
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Category of the offering. Used to group offerings together.
6
+ */
7
+ export type OfferingDtoCategory = "aac service" | "befriending";
8
+ export declare const OfferingDtoCategory: {
9
+ readonly AacService: "aac service";
10
+ readonly Befriending: "befriending";
11
+ };
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.OfferingDtoCategory = void 0;
7
+ exports.OfferingDtoCategory = {
8
+ AacService: "aac service",
9
+ Befriending: "befriending",
10
+ };
@@ -16,6 +16,8 @@ export interface OfferingWithAllowedDto {
16
16
  /** Whether this offering supports subsidized referrals. */
17
17
  isSubsidisable: boolean;
18
18
  timeslotPolicy: ReferralExchange.TimeslotPolicy;
19
+ /** Category of the offering. Used to group offerings together. */
20
+ category?: ReferralExchange.OfferingWithAllowedDtoCategory;
19
21
  /** Whether the offering is allowed based on the provided query parameters */
20
22
  isAllowed: boolean;
21
23
  }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Category of the offering. Used to group offerings together.
6
+ */
7
+ export type OfferingWithAllowedDtoCategory = "aac service" | "befriending";
8
+ export declare const OfferingWithAllowedDtoCategory: {
9
+ readonly AacService: "aac service";
10
+ readonly Befriending: "befriending";
11
+ };
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.OfferingWithAllowedDtoCategory = void 0;
7
+ exports.OfferingWithAllowedDtoCategory = {
8
+ AacService: "aac service",
9
+ Befriending: "befriending",
10
+ };
@@ -5,6 +5,7 @@ import * as ReferralExchange from "../index";
5
5
  export interface PublicReferralDto {
6
6
  id: string;
7
7
  sender: ReferralExchange.InstitutionCoreDto;
8
+ senderSystem: ReferralExchange.System;
8
9
  offering: ReferralExchange.OfferingDto;
9
10
  patient: ReferralExchange.GetReferralPatientDto;
10
11
  referringDoctor: ReferralExchange.ReferringDoctorDto;
@@ -5,6 +5,7 @@ import * as ReferralExchange from "../index";
5
5
  export interface ReferralDto {
6
6
  id: string;
7
7
  sender: ReferralExchange.InstitutionCoreDto;
8
+ senderSystem: ReferralExchange.System;
8
9
  offering: ReferralExchange.OfferingDto;
9
10
  patient: ReferralExchange.GetReferralPatientDto;
10
11
  referringDoctor: ReferralExchange.ReferringDoctorDto;
@@ -2,7 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * Type of ID specified in referrerId. Use together with `referrerId` and `referrerInstitutionId` to filter based on referrer.
5
+ * Type of ID specified in referrerId.
6
6
  */
7
7
  export type ReferrerIdType = "mcr" | "nric" | "email";
8
8
  export declare const ReferrerIdType: {
@@ -1,8 +1,10 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import * as ReferralExchange from "../index";
4
5
  export interface ReferringDoctorDto {
5
6
  mcr: string;
7
+ idType: ReferralExchange.ReferrerIdType;
6
8
  name: string;
7
9
  email: string;
8
10
  contactNumber: string;
@@ -11,6 +11,7 @@ export * from "./ReferralRole";
11
11
  export * from "./InstitutionCoreDto";
12
12
  export * from "./System";
13
13
  export * from "./TimeslotPolicy";
14
+ export * from "./OfferingDtoCategory";
14
15
  export * from "./OfferingDto";
15
16
  export * from "./GetReferralPatientDtoGender";
16
17
  export * from "./GetReferralPatientDto";
@@ -33,6 +34,7 @@ export * from "./FullReferralDtoStatus";
33
34
  export * from "./FullReferralDto";
34
35
  export * from "./CreatePatientReqGender";
35
36
  export * from "./CreatePatientReq";
37
+ export * from "./OfferingWithAllowedDtoCategory";
36
38
  export * from "./OfferingWithAllowedDto";
37
39
  export * from "./Timeslot";
38
40
  export * from "./TriggerEmailReminderBody";
@@ -27,6 +27,7 @@ __exportStar(require("./ReferralRole"), exports);
27
27
  __exportStar(require("./InstitutionCoreDto"), exports);
28
28
  __exportStar(require("./System"), exports);
29
29
  __exportStar(require("./TimeslotPolicy"), exports);
30
+ __exportStar(require("./OfferingDtoCategory"), exports);
30
31
  __exportStar(require("./OfferingDto"), exports);
31
32
  __exportStar(require("./GetReferralPatientDtoGender"), exports);
32
33
  __exportStar(require("./GetReferralPatientDto"), exports);
@@ -49,6 +50,7 @@ __exportStar(require("./FullReferralDtoStatus"), exports);
49
50
  __exportStar(require("./FullReferralDto"), exports);
50
51
  __exportStar(require("./CreatePatientReqGender"), exports);
51
52
  __exportStar(require("./CreatePatientReq"), exports);
53
+ __exportStar(require("./OfferingWithAllowedDtoCategory"), exports);
52
54
  __exportStar(require("./OfferingWithAllowedDto"), exports);
53
55
  __exportStar(require("./Timeslot"), exports);
54
56
  __exportStar(require("./TriggerEmailReminderBody"), exports);
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.0-develop-1748577388";
1
+ export declare const SDK_VERSION = "0.0.0-develop-1749093103";
package/dist/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.0.0-develop-1748577388";
4
+ exports.SDK_VERSION = "0.0.0-develop-1749093103";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opengovsg/refx-ts-sdk",
3
- "version": "0.0.0-develop-1748577388",
3
+ "version": "0.0.0-develop-1749093103",
4
4
  "private": false,
5
5
  "repository": "https://github.com/opengovsg/refer-ts-sdk",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -668,6 +668,57 @@ await client.offerings.list();
668
668
  </dl>
669
669
  </details>
670
670
 
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
+
671
722
  <details><summary><code>client.offerings.<a href="/src/api/resources/offerings/client/Client.ts">listTimeslots</a>(offeringId, { ...params }) -> ReferralExchange.Timeslot[]</code></summary>
672
723
  <dl>
673
724
  <dd>
@@ -745,8 +796,8 @@ await client.links.createUpsertLink({
745
796
  referrerInstitutionId: "referrerInstitutionId",
746
797
  referrerInstitutionName: "referrerInstitutionName",
747
798
  referrerId: "referrerId",
799
+ referrerIdType: "mcr",
748
800
  referrerName: "referrerName",
749
- referrerIdType: "referrerIdType",
750
801
  });
751
802
  ```
752
803
 
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.0-develop-1748577388";
1
+ export declare const SDK_VERSION = "0.0.0-develop-1749093103";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.0.0-develop-1748577388";
4
+ exports.SDK_VERSION = "0.0.0-develop-1749093103";