@vepler/sdk 1.9.11 → 1.10.0

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 (220) hide show
  1. package/README.md +23 -1
  2. package/dist/commonjs/funcs/schoolMetricsGetMetrics.d.ts +17 -0
  3. package/dist/commonjs/funcs/schoolMetricsGetMetrics.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/schoolMetricsGetMetrics.js +130 -0
  5. package/dist/commonjs/funcs/schoolMetricsGetMetrics.js.map +1 -0
  6. package/dist/commonjs/funcs/schoolMetricsListProfiles.d.ts +17 -0
  7. package/dist/commonjs/funcs/schoolMetricsListProfiles.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/schoolMetricsListProfiles.js +104 -0
  9. package/dist/commonjs/funcs/schoolMetricsListProfiles.js.map +1 -0
  10. package/dist/commonjs/funcs/schoolsGet.d.ts +17 -0
  11. package/dist/commonjs/funcs/schoolsGet.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/schoolsGet.js +124 -0
  13. package/dist/commonjs/funcs/schoolsGet.js.map +1 -0
  14. package/dist/commonjs/funcs/schoolsGetBySlug.d.ts +17 -0
  15. package/dist/commonjs/funcs/schoolsGetBySlug.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/schoolsGetBySlug.js +124 -0
  17. package/dist/commonjs/funcs/schoolsGetBySlug.js.map +1 -0
  18. package/dist/commonjs/funcs/schoolsGetByUrn.d.ts +17 -0
  19. package/dist/commonjs/funcs/schoolsGetByUrn.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/schoolsGetByUrn.js +124 -0
  21. package/dist/commonjs/funcs/schoolsGetByUrn.js.map +1 -0
  22. package/dist/commonjs/funcs/schoolsList.d.ts +17 -0
  23. package/dist/commonjs/funcs/schoolsList.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/schoolsList.js +126 -0
  25. package/dist/commonjs/funcs/schoolsList.js.map +1 -0
  26. package/dist/commonjs/funcs/schoolsSearchNearby.d.ts +17 -0
  27. package/dist/commonjs/funcs/schoolsSearchNearby.d.ts.map +1 -0
  28. package/dist/commonjs/funcs/schoolsSearchNearby.js +125 -0
  29. package/dist/commonjs/funcs/schoolsSearchNearby.js.map +1 -0
  30. package/dist/commonjs/funcs/schoolsSearchWithin.d.ts +17 -0
  31. package/dist/commonjs/funcs/schoolsSearchWithin.d.ts.map +1 -0
  32. package/dist/commonjs/funcs/schoolsSearchWithin.js +125 -0
  33. package/dist/commonjs/funcs/schoolsSearchWithin.js.map +1 -0
  34. package/dist/commonjs/lib/config.d.ts +3 -3
  35. package/dist/commonjs/lib/config.d.ts.map +1 -1
  36. package/dist/commonjs/lib/config.js +3 -3
  37. package/dist/commonjs/lib/config.js.map +1 -1
  38. package/dist/commonjs/sdk/models/operations/getmetricprofiles.d.ts +89 -0
  39. package/dist/commonjs/sdk/models/operations/getmetricprofiles.d.ts.map +1 -0
  40. package/dist/commonjs/sdk/models/operations/getmetricprofiles.js +122 -0
  41. package/dist/commonjs/sdk/models/operations/getmetricprofiles.js.map +1 -0
  42. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +245 -0
  43. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -0
  44. package/dist/commonjs/sdk/models/operations/getschoolbyid.js +267 -0
  45. package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -0
  46. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts +245 -0
  47. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js +267 -0
  49. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js.map +1 -0
  50. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts +245 -0
  51. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js +267 -0
  53. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js.map +1 -0
  54. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts +901 -0
  55. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts.map +1 -0
  56. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js +844 -0
  57. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js.map +1 -0
  58. package/dist/commonjs/sdk/models/operations/index.d.ts +8 -0
  59. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  60. package/dist/commonjs/sdk/models/operations/index.js +8 -0
  61. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  62. package/dist/commonjs/sdk/models/operations/listschools.d.ts +248 -0
  63. package/dist/commonjs/sdk/models/operations/listschools.d.ts.map +1 -0
  64. package/dist/commonjs/sdk/models/operations/listschools.js +262 -0
  65. package/dist/commonjs/sdk/models/operations/listschools.js.map +1 -0
  66. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts +274 -0
  67. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -0
  68. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js +282 -0
  69. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js.map +1 -0
  70. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts +243 -0
  71. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts.map +1 -0
  72. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js +260 -0
  73. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js.map +1 -0
  74. package/dist/commonjs/sdk/models/shared/index.d.ts +1 -0
  75. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  76. package/dist/commonjs/sdk/models/shared/index.js +1 -0
  77. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  78. package/dist/commonjs/sdk/models/shared/postcodeareafilter.d.ts +1 -1
  79. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +1 -1
  80. package/dist/commonjs/sdk/models/shared/school.d.ts +441 -0
  81. package/dist/commonjs/sdk/models/shared/school.d.ts.map +1 -0
  82. package/dist/commonjs/sdk/models/shared/school.js +301 -0
  83. package/dist/commonjs/sdk/models/shared/school.js.map +1 -0
  84. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts +2 -2
  85. package/dist/commonjs/sdk/schoolmetrics.d.ts +19 -0
  86. package/dist/commonjs/sdk/schoolmetrics.d.ts.map +1 -0
  87. package/dist/commonjs/sdk/schoolmetrics.js +32 -0
  88. package/dist/commonjs/sdk/schoolmetrics.js.map +1 -0
  89. package/dist/commonjs/sdk/schools.d.ts +47 -0
  90. package/dist/commonjs/sdk/schools.d.ts.map +1 -0
  91. package/dist/commonjs/sdk/schools.js +72 -0
  92. package/dist/commonjs/sdk/schools.js.map +1 -0
  93. package/dist/commonjs/sdk/sdk.d.ts +6 -0
  94. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  95. package/dist/commonjs/sdk/sdk.js +8 -0
  96. package/dist/commonjs/sdk/sdk.js.map +1 -1
  97. package/dist/esm/funcs/schoolMetricsGetMetrics.d.ts +17 -0
  98. package/dist/esm/funcs/schoolMetricsGetMetrics.d.ts.map +1 -0
  99. package/dist/esm/funcs/schoolMetricsGetMetrics.js +94 -0
  100. package/dist/esm/funcs/schoolMetricsGetMetrics.js.map +1 -0
  101. package/dist/esm/funcs/schoolMetricsListProfiles.d.ts +17 -0
  102. package/dist/esm/funcs/schoolMetricsListProfiles.d.ts.map +1 -0
  103. package/dist/esm/funcs/schoolMetricsListProfiles.js +68 -0
  104. package/dist/esm/funcs/schoolMetricsListProfiles.js.map +1 -0
  105. package/dist/esm/funcs/schoolsGet.d.ts +17 -0
  106. package/dist/esm/funcs/schoolsGet.d.ts.map +1 -0
  107. package/dist/esm/funcs/schoolsGet.js +88 -0
  108. package/dist/esm/funcs/schoolsGet.js.map +1 -0
  109. package/dist/esm/funcs/schoolsGetBySlug.d.ts +17 -0
  110. package/dist/esm/funcs/schoolsGetBySlug.d.ts.map +1 -0
  111. package/dist/esm/funcs/schoolsGetBySlug.js +88 -0
  112. package/dist/esm/funcs/schoolsGetBySlug.js.map +1 -0
  113. package/dist/esm/funcs/schoolsGetByUrn.d.ts +17 -0
  114. package/dist/esm/funcs/schoolsGetByUrn.d.ts.map +1 -0
  115. package/dist/esm/funcs/schoolsGetByUrn.js +88 -0
  116. package/dist/esm/funcs/schoolsGetByUrn.js.map +1 -0
  117. package/dist/esm/funcs/schoolsList.d.ts +17 -0
  118. package/dist/esm/funcs/schoolsList.d.ts.map +1 -0
  119. package/dist/esm/funcs/schoolsList.js +90 -0
  120. package/dist/esm/funcs/schoolsList.js.map +1 -0
  121. package/dist/esm/funcs/schoolsSearchNearby.d.ts +17 -0
  122. package/dist/esm/funcs/schoolsSearchNearby.d.ts.map +1 -0
  123. package/dist/esm/funcs/schoolsSearchNearby.js +89 -0
  124. package/dist/esm/funcs/schoolsSearchNearby.js.map +1 -0
  125. package/dist/esm/funcs/schoolsSearchWithin.d.ts +17 -0
  126. package/dist/esm/funcs/schoolsSearchWithin.d.ts.map +1 -0
  127. package/dist/esm/funcs/schoolsSearchWithin.js +89 -0
  128. package/dist/esm/funcs/schoolsSearchWithin.js.map +1 -0
  129. package/dist/esm/lib/config.d.ts +3 -3
  130. package/dist/esm/lib/config.d.ts.map +1 -1
  131. package/dist/esm/lib/config.js +3 -3
  132. package/dist/esm/lib/config.js.map +1 -1
  133. package/dist/esm/sdk/models/operations/getmetricprofiles.d.ts +89 -0
  134. package/dist/esm/sdk/models/operations/getmetricprofiles.d.ts.map +1 -0
  135. package/dist/esm/sdk/models/operations/getmetricprofiles.js +82 -0
  136. package/dist/esm/sdk/models/operations/getmetricprofiles.js.map +1 -0
  137. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +245 -0
  138. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -0
  139. package/dist/esm/sdk/models/operations/getschoolbyid.js +219 -0
  140. package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -0
  141. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts +245 -0
  142. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts.map +1 -0
  143. package/dist/esm/sdk/models/operations/getschoolbyslug.js +219 -0
  144. package/dist/esm/sdk/models/operations/getschoolbyslug.js.map +1 -0
  145. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts +245 -0
  146. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts.map +1 -0
  147. package/dist/esm/sdk/models/operations/getschoolbyurn.js +219 -0
  148. package/dist/esm/sdk/models/operations/getschoolbyurn.js.map +1 -0
  149. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts +901 -0
  150. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts.map +1 -0
  151. package/dist/esm/sdk/models/operations/getschoolmetrics.js +771 -0
  152. package/dist/esm/sdk/models/operations/getschoolmetrics.js.map +1 -0
  153. package/dist/esm/sdk/models/operations/index.d.ts +8 -0
  154. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  155. package/dist/esm/sdk/models/operations/index.js +8 -0
  156. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  157. package/dist/esm/sdk/models/operations/listschools.d.ts +248 -0
  158. package/dist/esm/sdk/models/operations/listschools.d.ts.map +1 -0
  159. package/dist/esm/sdk/models/operations/listschools.js +216 -0
  160. package/dist/esm/sdk/models/operations/listschools.js.map +1 -0
  161. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts +274 -0
  162. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -0
  163. package/dist/esm/sdk/models/operations/searchschoolsnearby.js +236 -0
  164. package/dist/esm/sdk/models/operations/searchschoolsnearby.js.map +1 -0
  165. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts +243 -0
  166. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts.map +1 -0
  167. package/dist/esm/sdk/models/operations/searchschoolswithin.js +214 -0
  168. package/dist/esm/sdk/models/operations/searchschoolswithin.js.map +1 -0
  169. package/dist/esm/sdk/models/shared/index.d.ts +1 -0
  170. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  171. package/dist/esm/sdk/models/shared/index.js +1 -0
  172. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  173. package/dist/esm/sdk/models/shared/postcodeareafilter.d.ts +1 -1
  174. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +1 -1
  175. package/dist/esm/sdk/models/shared/school.d.ts +441 -0
  176. package/dist/esm/sdk/models/shared/school.d.ts.map +1 -0
  177. package/dist/esm/sdk/models/shared/school.js +259 -0
  178. package/dist/esm/sdk/models/shared/school.js.map +1 -0
  179. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts +2 -2
  180. package/dist/esm/sdk/schoolmetrics.d.ts +19 -0
  181. package/dist/esm/sdk/schoolmetrics.d.ts.map +1 -0
  182. package/dist/esm/sdk/schoolmetrics.js +28 -0
  183. package/dist/esm/sdk/schoolmetrics.js.map +1 -0
  184. package/dist/esm/sdk/schools.d.ts +47 -0
  185. package/dist/esm/sdk/schools.d.ts.map +1 -0
  186. package/dist/esm/sdk/schools.js +68 -0
  187. package/dist/esm/sdk/schools.js.map +1 -0
  188. package/dist/esm/sdk/sdk.d.ts +6 -0
  189. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  190. package/dist/esm/sdk/sdk.js +8 -0
  191. package/dist/esm/sdk/sdk.js.map +1 -1
  192. package/openapi.json +908 -1
  193. package/package.json +1 -1
  194. package/src/funcs/schoolMetricsGetMetrics.ts +177 -0
  195. package/src/funcs/schoolMetricsListProfiles.ts +140 -0
  196. package/src/funcs/schoolsGet.ts +172 -0
  197. package/src/funcs/schoolsGetBySlug.ts +172 -0
  198. package/src/funcs/schoolsGetByUrn.ts +172 -0
  199. package/src/funcs/schoolsList.ts +173 -0
  200. package/src/funcs/schoolsSearchNearby.ts +172 -0
  201. package/src/funcs/schoolsSearchWithin.ts +172 -0
  202. package/src/lib/config.ts +3 -3
  203. package/src/sdk/models/operations/getmetricprofiles.ts +159 -0
  204. package/src/sdk/models/operations/getschoolbyid.ts +473 -0
  205. package/src/sdk/models/operations/getschoolbyslug.ts +479 -0
  206. package/src/sdk/models/operations/getschoolbyurn.ts +474 -0
  207. package/src/sdk/models/operations/getschoolmetrics.ts +1552 -0
  208. package/src/sdk/models/operations/index.ts +8 -0
  209. package/src/sdk/models/operations/listschools.ts +470 -0
  210. package/src/sdk/models/operations/searchschoolsnearby.ts +507 -0
  211. package/src/sdk/models/operations/searchschoolswithin.ts +475 -0
  212. package/src/sdk/models/shared/index.ts +1 -0
  213. package/src/sdk/models/shared/postcodeareafilter.ts +1 -1
  214. package/src/sdk/models/shared/propertyaddress.ts +1 -1
  215. package/src/sdk/models/shared/school.ts +588 -0
  216. package/src/sdk/models/shared/streetquerybycoordinates.ts +2 -2
  217. package/src/sdk/schoolmetrics.ts +43 -0
  218. package/src/sdk/schools.ts +117 -0
  219. package/src/sdk/sdk.ts +12 -0
  220. package/test-local.ts +4 -4
@@ -0,0 +1,117 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { schoolsGet } from "../funcs/schoolsGet.js";
6
+ import { schoolsGetBySlug } from "../funcs/schoolsGetBySlug.js";
7
+ import { schoolsGetByUrn } from "../funcs/schoolsGetByUrn.js";
8
+ import { schoolsList } from "../funcs/schoolsList.js";
9
+ import { schoolsSearchNearby } from "../funcs/schoolsSearchNearby.js";
10
+ import { schoolsSearchWithin } from "../funcs/schoolsSearchWithin.js";
11
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
12
+ import * as operations from "./models/operations/index.js";
13
+ import { unwrapAsync } from "./types/fp.js";
14
+
15
+ export class Schools extends ClientSDK {
16
+ /**
17
+ * Get school by ID
18
+ *
19
+ * @remarks
20
+ * Retrieve a single school by its internal ID
21
+ */
22
+ async get(
23
+ request: operations.GetSchoolByIdRequest,
24
+ options?: RequestOptions,
25
+ ): Promise<operations.GetSchoolByIdResponse> {
26
+ return unwrapAsync(schoolsGet(
27
+ this,
28
+ request,
29
+ options,
30
+ ));
31
+ }
32
+
33
+ /**
34
+ * Get school by slug
35
+ *
36
+ * @remarks
37
+ * Retrieve a single school by its URL slug
38
+ */
39
+ async getBySlug(
40
+ request: operations.GetSchoolBySlugRequest,
41
+ options?: RequestOptions,
42
+ ): Promise<operations.GetSchoolBySlugResponse> {
43
+ return unwrapAsync(schoolsGetBySlug(
44
+ this,
45
+ request,
46
+ options,
47
+ ));
48
+ }
49
+
50
+ /**
51
+ * Get school by URN
52
+ *
53
+ * @remarks
54
+ * Retrieve a single school by its Unique Reference Number
55
+ */
56
+ async getByUrn(
57
+ request: operations.GetSchoolByUrnRequest,
58
+ options?: RequestOptions,
59
+ ): Promise<operations.GetSchoolByUrnResponse> {
60
+ return unwrapAsync(schoolsGetByUrn(
61
+ this,
62
+ request,
63
+ options,
64
+ ));
65
+ }
66
+
67
+ /**
68
+ * List schools
69
+ *
70
+ * @remarks
71
+ * Retrieve a paginated list of schools with filtering and field selection
72
+ */
73
+ async list(
74
+ request?: operations.ListSchoolsRequest | undefined,
75
+ options?: RequestOptions,
76
+ ): Promise<operations.ListSchoolsResponse> {
77
+ return unwrapAsync(schoolsList(
78
+ this,
79
+ request,
80
+ options,
81
+ ));
82
+ }
83
+
84
+ /**
85
+ * Search schools near location
86
+ *
87
+ * @remarks
88
+ * Find schools within a specified radius of a geographic point
89
+ */
90
+ async searchNearby(
91
+ request: operations.SearchSchoolsNearbyRequest,
92
+ options?: RequestOptions,
93
+ ): Promise<operations.SearchSchoolsNearbyResponse> {
94
+ return unwrapAsync(schoolsSearchNearby(
95
+ this,
96
+ request,
97
+ options,
98
+ ));
99
+ }
100
+
101
+ /**
102
+ * Search schools within bounds
103
+ *
104
+ * @remarks
105
+ * Find schools within a geographic bounding box
106
+ */
107
+ async searchWithin(
108
+ request: operations.SearchSchoolsWithinRequest,
109
+ options?: RequestOptions,
110
+ ): Promise<operations.SearchSchoolsWithinResponse> {
111
+ return unwrapAsync(schoolsSearchWithin(
112
+ this,
113
+ request,
114
+ options,
115
+ ));
116
+ }
117
+ }
package/src/sdk/sdk.ts CHANGED
@@ -7,6 +7,8 @@ import { Health } from "./health.js";
7
7
  import { Location } from "./location.js";
8
8
  import { Planning } from "./planning.js";
9
9
  import { Property } from "./property.js";
10
+ import { SchoolMetrics } from "./schoolmetrics.js";
11
+ import { Schools } from "./schools.js";
10
12
 
11
13
  export class SDK extends ClientSDK {
12
14
  private _health?: Health;
@@ -28,4 +30,14 @@ export class SDK extends ClientSDK {
28
30
  get property(): Property {
29
31
  return (this._property ??= new Property(this._options));
30
32
  }
33
+
34
+ private _schools?: Schools;
35
+ get schools(): Schools {
36
+ return (this._schools ??= new Schools(this._options));
37
+ }
38
+
39
+ private _schoolMetrics?: SchoolMetrics;
40
+ get schoolMetrics(): SchoolMetrics {
41
+ return (this._schoolMetrics ??= new SchoolMetrics(this._options));
42
+ }
31
43
  }
package/test-local.ts CHANGED
@@ -39,7 +39,7 @@ async function test(name: string, fn: () => Promise<void>) {
39
39
  results.push({
40
40
  test: name,
41
41
  status: "❌",
42
- error: error instanceof Error ? error.message : String(error)
42
+ error: error instanceof Error ? error.message : String(error),
43
43
  });
44
44
  console.log(`❌ ${name} failed:`, error);
45
45
  }
@@ -128,8 +128,8 @@ async function runTests() {
128
128
  }
129
129
  });
130
130
 
131
- const passed = results.filter(r => r.status === "✅").length;
132
- const failed = results.filter(r => r.status === "❌").length;
131
+ const passed = results.filter((r) => r.status === "✅").length;
132
+ const failed = results.filter((r) => r.status === "❌").length;
133
133
 
134
134
  console.log(`\nTotal: ${passed} passed, ${failed} failed`);
135
135
 
@@ -142,4 +142,4 @@ async function runTests() {
142
142
  runTests().catch((error) => {
143
143
  console.error("Fatal error:", error);
144
144
  process.exit(1);
145
- });
145
+ });