@vepler/sdk 2.18.12 → 2.24.1

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 (230) hide show
  1. package/README.md +7 -0
  2. package/dist/commonjs/funcs/councilsGet.d.ts +17 -0
  3. package/dist/commonjs/funcs/councilsGet.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/councilsGet.js +119 -0
  5. package/dist/commonjs/funcs/councilsGet.js.map +1 -0
  6. package/dist/commonjs/funcs/councilsList.d.ts +17 -0
  7. package/dist/commonjs/funcs/councilsList.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/councilsList.js +119 -0
  9. package/dist/commonjs/funcs/councilsList.js.map +1 -0
  10. package/dist/commonjs/lib/config.d.ts +3 -3
  11. package/dist/commonjs/lib/config.js +3 -3
  12. package/dist/commonjs/lib/config.js.map +1 -1
  13. package/dist/commonjs/lib/sdks.js +2 -2
  14. package/dist/commonjs/lib/sdks.js.map +1 -1
  15. package/dist/commonjs/sdk/councils.d.ts +19 -0
  16. package/dist/commonjs/sdk/councils.d.ts.map +1 -0
  17. package/dist/commonjs/sdk/councils.js +32 -0
  18. package/dist/commonjs/sdk/councils.js.map +1 -0
  19. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.d.ts +4 -3
  20. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.d.ts.map +1 -1
  21. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.js +2 -1
  22. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.js.map +1 -1
  23. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts +7 -5
  24. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts.map +1 -1
  25. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js +4 -2
  26. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js.map +1 -1
  27. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts +8 -6
  28. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts.map +1 -1
  29. package/dist/commonjs/sdk/models/operations/getborderingareas.js +4 -2
  30. package/dist/commonjs/sdk/models/operations/getborderingareas.js.map +1 -1
  31. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts +8 -6
  32. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts.map +1 -1
  33. package/dist/commonjs/sdk/models/operations/getchildareas.js +4 -2
  34. package/dist/commonjs/sdk/models/operations/getchildareas.js.map +1 -1
  35. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.d.ts +19 -0
  36. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.d.ts.map +1 -0
  37. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.js +60 -0
  38. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.js.map +1 -0
  39. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts +12 -9
  40. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  41. package/dist/commonjs/sdk/models/operations/getmetricvalues.js +6 -3
  42. package/dist/commonjs/sdk/models/operations/getmetricvalues.js.map +1 -1
  43. package/dist/commonjs/sdk/models/operations/index.d.ts +2 -0
  44. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  45. package/dist/commonjs/sdk/models/operations/index.js +2 -0
  46. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  47. package/dist/commonjs/sdk/models/operations/listcouncils.d.ts +78 -0
  48. package/dist/commonjs/sdk/models/operations/listcouncils.d.ts.map +1 -0
  49. package/dist/commonjs/sdk/models/operations/listcouncils.js +96 -0
  50. package/dist/commonjs/sdk/models/operations/listcouncils.js.map +1 -0
  51. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +115 -0
  52. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  53. package/dist/commonjs/sdk/models/operations/resolveaddress.js +61 -1
  54. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  55. package/dist/commonjs/sdk/models/shared/council.d.ts +131 -0
  56. package/dist/commonjs/sdk/models/shared/council.d.ts.map +1 -0
  57. package/dist/commonjs/sdk/models/shared/council.js +115 -0
  58. package/dist/commonjs/sdk/models/shared/council.js.map +1 -0
  59. package/dist/commonjs/sdk/models/shared/councilbranding.d.ts +32 -0
  60. package/dist/commonjs/sdk/models/shared/councilbranding.d.ts.map +1 -0
  61. package/dist/commonjs/sdk/models/shared/councilbranding.js +65 -0
  62. package/dist/commonjs/sdk/models/shared/councilbranding.js.map +1 -0
  63. package/dist/commonjs/sdk/models/shared/councilcontactdetails.d.ts +47 -0
  64. package/dist/commonjs/sdk/models/shared/councilcontactdetails.d.ts.map +1 -0
  65. package/dist/commonjs/sdk/models/shared/councilcontactdetails.js +79 -0
  66. package/dist/commonjs/sdk/models/shared/councilcontactdetails.js.map +1 -0
  67. package/dist/commonjs/sdk/models/shared/councilerrorresponse.d.ts +29 -0
  68. package/dist/commonjs/sdk/models/shared/councilerrorresponse.d.ts.map +1 -0
  69. package/dist/commonjs/sdk/models/shared/councilerrorresponse.js +70 -0
  70. package/dist/commonjs/sdk/models/shared/councilerrorresponse.js.map +1 -0
  71. package/dist/commonjs/sdk/models/shared/councillistresponse.d.ts +43 -0
  72. package/dist/commonjs/sdk/models/shared/councillistresponse.d.ts.map +1 -0
  73. package/dist/commonjs/sdk/models/shared/councillistresponse.js +69 -0
  74. package/dist/commonjs/sdk/models/shared/councillistresponse.js.map +1 -0
  75. package/dist/commonjs/sdk/models/shared/councilmetadata.d.ts +34 -0
  76. package/dist/commonjs/sdk/models/shared/councilmetadata.d.ts.map +1 -0
  77. package/dist/commonjs/sdk/models/shared/councilmetadata.js +59 -0
  78. package/dist/commonjs/sdk/models/shared/councilmetadata.js.map +1 -0
  79. package/dist/commonjs/sdk/models/shared/councilserviceurls.d.ts +26 -0
  80. package/dist/commonjs/sdk/models/shared/councilserviceurls.d.ts.map +1 -0
  81. package/dist/commonjs/sdk/models/shared/councilserviceurls.js +60 -0
  82. package/dist/commonjs/sdk/models/shared/councilserviceurls.js.map +1 -0
  83. package/dist/commonjs/sdk/models/shared/index.d.ts +7 -0
  84. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  85. package/dist/commonjs/sdk/models/shared/index.js +7 -0
  86. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  87. package/dist/commonjs/sdk/models/shared/listing.d.ts +8 -8
  88. package/dist/commonjs/sdk/models/shared/listing.d.ts.map +1 -1
  89. package/dist/commonjs/sdk/models/shared/listing.js +8 -8
  90. package/dist/commonjs/sdk/models/shared/listing.js.map +1 -1
  91. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +21 -0
  92. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  93. package/dist/commonjs/sdk/models/shared/propertydataapi.js +21 -1
  94. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  95. package/dist/commonjs/sdk/models/shared/school.d.ts +8 -8
  96. package/dist/commonjs/sdk/models/shared/school.d.ts.map +1 -1
  97. package/dist/commonjs/sdk/models/shared/school.js +9 -10
  98. package/dist/commonjs/sdk/models/shared/school.js.map +1 -1
  99. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  100. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  101. package/dist/commonjs/sdk/sdk.js +4 -0
  102. package/dist/commonjs/sdk/sdk.js.map +1 -1
  103. package/dist/esm/funcs/councilsGet.d.ts +17 -0
  104. package/dist/esm/funcs/councilsGet.d.ts.map +1 -0
  105. package/dist/esm/funcs/councilsGet.js +83 -0
  106. package/dist/esm/funcs/councilsGet.js.map +1 -0
  107. package/dist/esm/funcs/councilsList.d.ts +17 -0
  108. package/dist/esm/funcs/councilsList.d.ts.map +1 -0
  109. package/dist/esm/funcs/councilsList.js +83 -0
  110. package/dist/esm/funcs/councilsList.js.map +1 -0
  111. package/dist/esm/lib/config.d.ts +3 -3
  112. package/dist/esm/lib/config.js +3 -3
  113. package/dist/esm/lib/config.js.map +1 -1
  114. package/dist/esm/lib/sdks.js +2 -2
  115. package/dist/esm/lib/sdks.js.map +1 -1
  116. package/dist/esm/sdk/councils.d.ts +19 -0
  117. package/dist/esm/sdk/councils.d.ts.map +1 -0
  118. package/dist/esm/sdk/councils.js +28 -0
  119. package/dist/esm/sdk/councils.js.map +1 -0
  120. package/dist/esm/sdk/models/operations/getareasbyfieldandids.d.ts +4 -3
  121. package/dist/esm/sdk/models/operations/getareasbyfieldandids.d.ts.map +1 -1
  122. package/dist/esm/sdk/models/operations/getareasbyfieldandids.js +2 -1
  123. package/dist/esm/sdk/models/operations/getareasbyfieldandids.js.map +1 -1
  124. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts +7 -5
  125. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts.map +1 -1
  126. package/dist/esm/sdk/models/operations/getareaswithinradius.js +4 -2
  127. package/dist/esm/sdk/models/operations/getareaswithinradius.js.map +1 -1
  128. package/dist/esm/sdk/models/operations/getborderingareas.d.ts +8 -6
  129. package/dist/esm/sdk/models/operations/getborderingareas.d.ts.map +1 -1
  130. package/dist/esm/sdk/models/operations/getborderingareas.js +4 -2
  131. package/dist/esm/sdk/models/operations/getborderingareas.js.map +1 -1
  132. package/dist/esm/sdk/models/operations/getchildareas.d.ts +8 -6
  133. package/dist/esm/sdk/models/operations/getchildareas.d.ts.map +1 -1
  134. package/dist/esm/sdk/models/operations/getchildareas.js +4 -2
  135. package/dist/esm/sdk/models/operations/getchildareas.js.map +1 -1
  136. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.d.ts +19 -0
  137. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.d.ts.map +1 -0
  138. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.js +22 -0
  139. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.js.map +1 -0
  140. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts +12 -9
  141. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  142. package/dist/esm/sdk/models/operations/getmetricvalues.js +6 -3
  143. package/dist/esm/sdk/models/operations/getmetricvalues.js.map +1 -1
  144. package/dist/esm/sdk/models/operations/index.d.ts +2 -0
  145. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  146. package/dist/esm/sdk/models/operations/index.js +2 -0
  147. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  148. package/dist/esm/sdk/models/operations/listcouncils.d.ts +78 -0
  149. package/dist/esm/sdk/models/operations/listcouncils.d.ts.map +1 -0
  150. package/dist/esm/sdk/models/operations/listcouncils.js +58 -0
  151. package/dist/esm/sdk/models/operations/listcouncils.js.map +1 -0
  152. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +115 -0
  153. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  154. package/dist/esm/sdk/models/operations/resolveaddress.js +57 -0
  155. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  156. package/dist/esm/sdk/models/shared/council.d.ts +131 -0
  157. package/dist/esm/sdk/models/shared/council.d.ts.map +1 -0
  158. package/dist/esm/sdk/models/shared/council.js +78 -0
  159. package/dist/esm/sdk/models/shared/council.js.map +1 -0
  160. package/dist/esm/sdk/models/shared/councilbranding.d.ts +32 -0
  161. package/dist/esm/sdk/models/shared/councilbranding.d.ts.map +1 -0
  162. package/dist/esm/sdk/models/shared/councilbranding.js +27 -0
  163. package/dist/esm/sdk/models/shared/councilbranding.js.map +1 -0
  164. package/dist/esm/sdk/models/shared/councilcontactdetails.d.ts +47 -0
  165. package/dist/esm/sdk/models/shared/councilcontactdetails.d.ts.map +1 -0
  166. package/dist/esm/sdk/models/shared/councilcontactdetails.js +40 -0
  167. package/dist/esm/sdk/models/shared/councilcontactdetails.js.map +1 -0
  168. package/dist/esm/sdk/models/shared/councilerrorresponse.d.ts +29 -0
  169. package/dist/esm/sdk/models/shared/councilerrorresponse.d.ts.map +1 -0
  170. package/dist/esm/sdk/models/shared/councilerrorresponse.js +32 -0
  171. package/dist/esm/sdk/models/shared/councilerrorresponse.js.map +1 -0
  172. package/dist/esm/sdk/models/shared/councillistresponse.d.ts +43 -0
  173. package/dist/esm/sdk/models/shared/councillistresponse.d.ts.map +1 -0
  174. package/dist/esm/sdk/models/shared/councillistresponse.js +32 -0
  175. package/dist/esm/sdk/models/shared/councillistresponse.js.map +1 -0
  176. package/dist/esm/sdk/models/shared/councilmetadata.d.ts +34 -0
  177. package/dist/esm/sdk/models/shared/councilmetadata.d.ts.map +1 -0
  178. package/dist/esm/sdk/models/shared/councilmetadata.js +22 -0
  179. package/dist/esm/sdk/models/shared/councilmetadata.js.map +1 -0
  180. package/dist/esm/sdk/models/shared/councilserviceurls.d.ts +26 -0
  181. package/dist/esm/sdk/models/shared/councilserviceurls.d.ts.map +1 -0
  182. package/dist/esm/sdk/models/shared/councilserviceurls.js +23 -0
  183. package/dist/esm/sdk/models/shared/councilserviceurls.js.map +1 -0
  184. package/dist/esm/sdk/models/shared/index.d.ts +7 -0
  185. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  186. package/dist/esm/sdk/models/shared/index.js +7 -0
  187. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  188. package/dist/esm/sdk/models/shared/listing.d.ts +8 -8
  189. package/dist/esm/sdk/models/shared/listing.d.ts.map +1 -1
  190. package/dist/esm/sdk/models/shared/listing.js +7 -7
  191. package/dist/esm/sdk/models/shared/listing.js.map +1 -1
  192. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +21 -0
  193. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  194. package/dist/esm/sdk/models/shared/propertydataapi.js +20 -0
  195. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  196. package/dist/esm/sdk/models/shared/school.d.ts +8 -8
  197. package/dist/esm/sdk/models/shared/school.d.ts.map +1 -1
  198. package/dist/esm/sdk/models/shared/school.js +7 -8
  199. package/dist/esm/sdk/models/shared/school.js.map +1 -1
  200. package/dist/esm/sdk/sdk.d.ts +3 -0
  201. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  202. package/dist/esm/sdk/sdk.js +4 -0
  203. package/dist/esm/sdk/sdk.js.map +1 -1
  204. package/package.json +1 -1
  205. package/src/funcs/councilsGet.ts +167 -0
  206. package/src/funcs/councilsList.ts +167 -0
  207. package/src/lib/config.ts +3 -3
  208. package/src/lib/sdks.ts +2 -2
  209. package/src/sdk/councils.ts +45 -0
  210. package/src/sdk/models/operations/getareasbyfieldandids.ts +4 -3
  211. package/src/sdk/models/operations/getareaswithinradius.ts +7 -5
  212. package/src/sdk/models/operations/getborderingareas.ts +8 -6
  213. package/src/sdk/models/operations/getchildareas.ts +8 -6
  214. package/src/sdk/models/operations/getcouncilbyproviderid.ts +61 -0
  215. package/src/sdk/models/operations/getmetricvalues.ts +12 -9
  216. package/src/sdk/models/operations/index.ts +2 -0
  217. package/src/sdk/models/operations/listcouncils.ts +131 -0
  218. package/src/sdk/models/operations/resolveaddress.ts +182 -0
  219. package/src/sdk/models/shared/council.ts +191 -0
  220. package/src/sdk/models/shared/councilbranding.ts +77 -0
  221. package/src/sdk/models/shared/councilcontactdetails.ts +112 -0
  222. package/src/sdk/models/shared/councilerrorresponse.ts +73 -0
  223. package/src/sdk/models/shared/councillistresponse.ts +80 -0
  224. package/src/sdk/models/shared/councilmetadata.ts +64 -0
  225. package/src/sdk/models/shared/councilserviceurls.ts +57 -0
  226. package/src/sdk/models/shared/index.ts +7 -0
  227. package/src/sdk/models/shared/listing.ts +13 -13
  228. package/src/sdk/models/shared/propertydataapi.ts +33 -0
  229. package/src/sdk/models/shared/school.ts +24 -21
  230. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,167 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeFormQuery } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import {
14
+ ConnectionError,
15
+ InvalidRequestError,
16
+ RequestAbortedError,
17
+ RequestTimeoutError,
18
+ UnexpectedClientError,
19
+ } from "../sdk/models/errors/httpclienterrors.js";
20
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
21
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
22
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
23
+ import * as operations from "../sdk/models/operations/index.js";
24
+ import { APICall, APIPromise } from "../sdk/types/async.js";
25
+ import { Result } from "../sdk/types/fp.js";
26
+
27
+ /**
28
+ * List councils
29
+ *
30
+ * @remarks
31
+ * Retrieve a list of councils and local authorities for Great Britain and Ireland. Filter by country, status, or type.
32
+ */
33
+ export function councilsList(
34
+ client: SDKCore,
35
+ request?: operations.ListCouncilsRequest | undefined,
36
+ options?: RequestOptions,
37
+ ): APIPromise<
38
+ Result<
39
+ operations.ListCouncilsResponse,
40
+ | SDKBaseError
41
+ | ResponseValidationError
42
+ | ConnectionError
43
+ | RequestAbortedError
44
+ | RequestTimeoutError
45
+ | InvalidRequestError
46
+ | UnexpectedClientError
47
+ | SDKValidationError
48
+ >
49
+ > {
50
+ return new APIPromise($do(
51
+ client,
52
+ request,
53
+ options,
54
+ ));
55
+ }
56
+
57
+ async function $do(
58
+ client: SDKCore,
59
+ request?: operations.ListCouncilsRequest | undefined,
60
+ options?: RequestOptions,
61
+ ): Promise<
62
+ [
63
+ Result<
64
+ operations.ListCouncilsResponse,
65
+ | SDKBaseError
66
+ | ResponseValidationError
67
+ | ConnectionError
68
+ | RequestAbortedError
69
+ | RequestTimeoutError
70
+ | InvalidRequestError
71
+ | UnexpectedClientError
72
+ | SDKValidationError
73
+ >,
74
+ APICall,
75
+ ]
76
+ > {
77
+ const parsed = safeParse(
78
+ request,
79
+ (value) =>
80
+ operations.ListCouncilsRequest$outboundSchema.optional().parse(value),
81
+ "Input validation failed",
82
+ );
83
+ if (!parsed.ok) {
84
+ return [parsed, { status: "invalid" }];
85
+ }
86
+ const payload = parsed.value;
87
+ const body = null;
88
+
89
+ const path = pathToFunc("/v1/councils")();
90
+
91
+ const query = encodeFormQuery({
92
+ "country": payload?.country,
93
+ "status": payload?.status,
94
+ "type": payload?.type,
95
+ });
96
+
97
+ const headers = new Headers(compactMap({
98
+ Accept: "application/json",
99
+ }));
100
+
101
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
102
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
103
+ const requestSecurity = resolveGlobalSecurity(securityInput);
104
+
105
+ const context = {
106
+ options: client._options,
107
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
108
+ operationID: "listCouncils",
109
+ oAuth2Scopes: null,
110
+
111
+ resolvedSecurity: requestSecurity,
112
+
113
+ securitySource: client._options.apiKeyAuth,
114
+ retryConfig: options?.retries
115
+ || client._options.retryConfig
116
+ || { strategy: "none" },
117
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
118
+ };
119
+
120
+ const requestRes = client._createRequest(context, {
121
+ security: requestSecurity,
122
+ method: "GET",
123
+ baseURL: options?.serverURL,
124
+ path: path,
125
+ headers: headers,
126
+ query: query,
127
+ body: body,
128
+ userAgent: client._options.userAgent,
129
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
130
+ }, options);
131
+ if (!requestRes.ok) {
132
+ return [requestRes, { status: "invalid" }];
133
+ }
134
+ const req = requestRes.value;
135
+
136
+ const doResult = await client._do(req, {
137
+ context,
138
+ errorCodes: [],
139
+ retryConfig: context.retryConfig,
140
+ retryCodes: context.retryCodes,
141
+ });
142
+ if (!doResult.ok) {
143
+ return [doResult, { status: "request-error", request: req }];
144
+ }
145
+ const response = doResult.value;
146
+
147
+ const [result] = await M.match<
148
+ operations.ListCouncilsResponse,
149
+ | SDKBaseError
150
+ | ResponseValidationError
151
+ | ConnectionError
152
+ | RequestAbortedError
153
+ | RequestTimeoutError
154
+ | InvalidRequestError
155
+ | UnexpectedClientError
156
+ | SDKValidationError
157
+ >(
158
+ M.json(200, operations.ListCouncilsResponse$inboundSchema),
159
+ M.json(400, operations.ListCouncilsResponse$inboundSchema),
160
+ M.json(500, operations.ListCouncilsResponse$inboundSchema),
161
+ )(response, req);
162
+ if (!result.ok) {
163
+ return [result, { status: "complete", request: req, response }];
164
+ }
165
+
166
+ return [result, { status: "complete", request: req, response }];
167
+ }
package/src/lib/config.ts CHANGED
@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
60
60
 
61
61
  export const SDK_METADATA = {
62
62
  language: "typescript",
63
- openapiDocVersion: "2.18.12",
63
+ openapiDocVersion: "2.24.1",
64
64
  sdkVersion: "0.8.0",
65
- genVersion: "2.788.5",
66
- userAgent: "speakeasy-sdk/typescript 0.8.0 2.788.5 2.18.12 @vepler/sdk",
65
+ genVersion: "2.795.8",
66
+ userAgent: "speakeasy-sdk/typescript 0.8.0 2.795.8 2.24.1 @vepler/sdk",
67
67
  } as const;
package/src/lib/sdks.ts CHANGED
@@ -304,9 +304,9 @@ export class ClientSDK {
304
304
  }
305
305
  }
306
306
 
307
- const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
307
+ const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
308
308
  const jsonlLikeContentTypeRE =
309
- /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
309
+ /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
310
310
  async function logRequest(logger: Logger | undefined, req: Request) {
311
311
  if (!logger) {
312
312
  return;
@@ -0,0 +1,45 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { councilsGet } from "../funcs/councilsGet.js";
6
+ import { councilsList } from "../funcs/councilsList.js";
7
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
8
+ import * as operations from "./models/operations/index.js";
9
+ import { unwrapAsync } from "./types/fp.js";
10
+
11
+ export class Councils extends ClientSDK {
12
+ /**
13
+ * Get council by provider ID
14
+ *
15
+ * @remarks
16
+ * Retrieve a single council by its provider identifier.
17
+ */
18
+ async get(
19
+ request: operations.GetCouncilByProviderIdRequest,
20
+ options?: RequestOptions,
21
+ ): Promise<operations.GetCouncilByProviderIdResponse> {
22
+ return unwrapAsync(councilsGet(
23
+ this,
24
+ request,
25
+ options,
26
+ ));
27
+ }
28
+
29
+ /**
30
+ * List councils
31
+ *
32
+ * @remarks
33
+ * Retrieve a list of councils and local authorities for Great Britain and Ireland. Filter by country, status, or type.
34
+ */
35
+ async list(
36
+ request?: operations.ListCouncilsRequest | undefined,
37
+ options?: RequestOptions,
38
+ ): Promise<operations.ListCouncilsResponse> {
39
+ return unwrapAsync(councilsList(
40
+ this,
41
+ request,
42
+ options,
43
+ ));
44
+ }
45
+ }
@@ -122,10 +122,11 @@ export type Relationships = {
122
122
  };
123
123
 
124
124
  /**
125
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
125
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
126
126
  */
127
127
  export const GetAreasByFieldAndIdsType = {
128
128
  Postcode: "postcode",
129
+ Outcode: "outcode",
129
130
  UkOutputArea: "uk_output_area",
130
131
  Lsoa21: "lsoa21",
131
132
  Ward: "ward",
@@ -178,7 +179,7 @@ export const GetAreasByFieldAndIdsType = {
178
179
  NoiseIndustryLden: "noise_industry_lden",
179
180
  } as const;
180
181
  /**
181
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
182
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
182
183
  */
183
184
  export type GetAreasByFieldAndIdsType = ClosedEnum<
184
185
  typeof GetAreasByFieldAndIdsType
@@ -233,7 +234,7 @@ export type GetAreasByFieldAndIdsResult = {
233
234
  */
234
235
  status?: string | undefined;
235
236
  /**
236
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
237
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
237
238
  */
238
239
  type: GetAreasByFieldAndIdsType;
239
240
  };
@@ -9,10 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
12
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
13
13
  */
14
14
  export const Type = {
15
15
  Postcode: "postcode",
16
+ Outcode: "outcode",
16
17
  UkOutputArea: "uk_output_area",
17
18
  Lsoa21: "lsoa21",
18
19
  Ward: "ward",
@@ -65,7 +66,7 @@ export const Type = {
65
66
  NoiseIndustryLden: "noise_industry_lden",
66
67
  } as const;
67
68
  /**
68
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
69
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
69
70
  */
70
71
  export type Type = ClosedEnum<typeof Type>;
71
72
 
@@ -175,10 +176,11 @@ export type GetAreasWithinRadiusRelationships = {
175
176
  };
176
177
 
177
178
  /**
178
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
179
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
179
180
  */
180
181
  export const GetAreasWithinRadiusType = {
181
182
  Postcode: "postcode",
183
+ Outcode: "outcode",
182
184
  UkOutputArea: "uk_output_area",
183
185
  Lsoa21: "lsoa21",
184
186
  Ward: "ward",
@@ -231,7 +233,7 @@ export const GetAreasWithinRadiusType = {
231
233
  NoiseIndustryLden: "noise_industry_lden",
232
234
  } as const;
233
235
  /**
234
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
236
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
235
237
  */
236
238
  export type GetAreasWithinRadiusType = ClosedEnum<
237
239
  typeof GetAreasWithinRadiusType
@@ -290,7 +292,7 @@ export type GetAreasWithinRadiusResult = {
290
292
  */
291
293
  status?: string | undefined;
292
294
  /**
293
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
295
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
294
296
  */
295
297
  type: GetAreasWithinRadiusType;
296
298
  };
@@ -106,10 +106,11 @@ export type GetBorderingAreasRelationships = {
106
106
  };
107
107
 
108
108
  /**
109
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
109
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
110
110
  */
111
111
  export const GetBorderingAreasType = {
112
112
  Postcode: "postcode",
113
+ Outcode: "outcode",
113
114
  UkOutputArea: "uk_output_area",
114
115
  Lsoa21: "lsoa21",
115
116
  Ward: "ward",
@@ -162,7 +163,7 @@ export const GetBorderingAreasType = {
162
163
  NoiseIndustryLden: "noise_industry_lden",
163
164
  } as const;
164
165
  /**
165
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
166
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
166
167
  */
167
168
  export type GetBorderingAreasType = ClosedEnum<typeof GetBorderingAreasType>;
168
169
 
@@ -215,7 +216,7 @@ export type BorderingAreas = {
215
216
  */
216
217
  status?: string | undefined;
217
218
  /**
218
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
219
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
219
220
  */
220
221
  type: GetBorderingAreasType;
221
222
  };
@@ -255,10 +256,11 @@ export type GetBorderingAreasAreasRelationships = {
255
256
  };
256
257
 
257
258
  /**
258
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
259
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
259
260
  */
260
261
  export const GetBorderingAreasAreasType = {
261
262
  Postcode: "postcode",
263
+ Outcode: "outcode",
262
264
  UkOutputArea: "uk_output_area",
263
265
  Lsoa21: "lsoa21",
264
266
  Ward: "ward",
@@ -311,7 +313,7 @@ export const GetBorderingAreasAreasType = {
311
313
  NoiseIndustryLden: "noise_industry_lden",
312
314
  } as const;
313
315
  /**
314
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
316
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
315
317
  */
316
318
  export type GetBorderingAreasAreasType = ClosedEnum<
317
319
  typeof GetBorderingAreasAreasType
@@ -366,7 +368,7 @@ export type Target = {
366
368
  */
367
369
  status?: string | undefined;
368
370
  /**
369
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
371
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
370
372
  */
371
373
  type: GetBorderingAreasAreasType;
372
374
  };
@@ -102,10 +102,11 @@ export type GetChildAreasRelationships = {
102
102
  };
103
103
 
104
104
  /**
105
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
105
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
106
106
  */
107
107
  export const GetChildAreasType = {
108
108
  Postcode: "postcode",
109
+ Outcode: "outcode",
109
110
  UkOutputArea: "uk_output_area",
110
111
  Lsoa21: "lsoa21",
111
112
  Ward: "ward",
@@ -158,7 +159,7 @@ export const GetChildAreasType = {
158
159
  NoiseIndustryLden: "noise_industry_lden",
159
160
  } as const;
160
161
  /**
161
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
162
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
162
163
  */
163
164
  export type GetChildAreasType = ClosedEnum<typeof GetChildAreasType>;
164
165
 
@@ -211,7 +212,7 @@ export type Children = {
211
212
  */
212
213
  status?: string | undefined;
213
214
  /**
214
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
215
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
215
216
  */
216
217
  type: GetChildAreasType;
217
218
  };
@@ -251,10 +252,11 @@ export type GetChildAreasAreasRelationships = {
251
252
  };
252
253
 
253
254
  /**
254
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
255
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
255
256
  */
256
257
  export const GetChildAreasAreasType = {
257
258
  Postcode: "postcode",
259
+ Outcode: "outcode",
258
260
  UkOutputArea: "uk_output_area",
259
261
  Lsoa21: "lsoa21",
260
262
  Ward: "ward",
@@ -307,7 +309,7 @@ export const GetChildAreasAreasType = {
307
309
  NoiseIndustryLden: "noise_industry_lden",
308
310
  } as const;
309
311
  /**
310
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
312
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
311
313
  */
312
314
  export type GetChildAreasAreasType = ClosedEnum<typeof GetChildAreasAreasType>;
313
315
 
@@ -360,7 +362,7 @@ export type Parent = {
360
362
  */
361
363
  status?: string | undefined;
362
364
  /**
363
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
365
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
364
366
  */
365
367
  type: GetChildAreasAreasType;
366
368
  };
@@ -0,0 +1,61 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import * as shared from "../shared/index.js";
10
+
11
+ export type GetCouncilByProviderIdRequest = {
12
+ providerId: string;
13
+ };
14
+
15
+ export type GetCouncilByProviderIdResponse =
16
+ | shared.Council
17
+ | shared.CouncilErrorResponse;
18
+
19
+ /** @internal */
20
+ export type GetCouncilByProviderIdRequest$Outbound = {
21
+ providerId: string;
22
+ };
23
+
24
+ /** @internal */
25
+ export const GetCouncilByProviderIdRequest$outboundSchema: z.ZodType<
26
+ GetCouncilByProviderIdRequest$Outbound,
27
+ z.ZodTypeDef,
28
+ GetCouncilByProviderIdRequest
29
+ > = z.object({
30
+ providerId: z.string(),
31
+ });
32
+
33
+ export function getCouncilByProviderIdRequestToJSON(
34
+ getCouncilByProviderIdRequest: GetCouncilByProviderIdRequest,
35
+ ): string {
36
+ return JSON.stringify(
37
+ GetCouncilByProviderIdRequest$outboundSchema.parse(
38
+ getCouncilByProviderIdRequest,
39
+ ),
40
+ );
41
+ }
42
+
43
+ /** @internal */
44
+ export const GetCouncilByProviderIdResponse$inboundSchema: z.ZodType<
45
+ GetCouncilByProviderIdResponse,
46
+ z.ZodTypeDef,
47
+ unknown
48
+ > = z.union([
49
+ shared.Council$inboundSchema,
50
+ shared.CouncilErrorResponse$inboundSchema,
51
+ ]);
52
+
53
+ export function getCouncilByProviderIdResponseFromJSON(
54
+ jsonString: string,
55
+ ): SafeParseResult<GetCouncilByProviderIdResponse, SDKValidationError> {
56
+ return safeParse(
57
+ jsonString,
58
+ (x) => GetCouncilByProviderIdResponse$inboundSchema.parse(JSON.parse(x)),
59
+ `Failed to parse 'GetCouncilByProviderIdResponse' from JSON`,
60
+ );
61
+ }
@@ -9,10 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
12
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
13
13
  */
14
14
  export const GeographicType = {
15
15
  Postcode: "postcode",
16
+ Outcode: "outcode",
16
17
  UkOutputArea: "uk_output_area",
17
18
  Lsoa21: "lsoa21",
18
19
  Ward: "ward",
@@ -65,7 +66,7 @@ export const GeographicType = {
65
66
  NoiseIndustryLden: "noise_industry_lden",
66
67
  } as const;
67
68
  /**
68
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
69
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
69
70
  */
70
71
  export type GeographicType = ClosedEnum<typeof GeographicType>;
71
72
 
@@ -74,7 +75,7 @@ export type GetMetricValuesRequest = {
74
75
  endPeriod?: string | undefined;
75
76
  geographicCode?: string | undefined;
76
77
  /**
77
- * Layer type identifier. Includes ONS statistical geographies, HM Land Registry INSPIRE polygons, Environment Agency flood zones, Natural England/NatureScot environmental designations, Historic England heritage assets, and DEFRA END Directive noise mapping.
78
+ * Layer type identifier. Includes postcodes, outcodes, ONS statistical geographies, HM Land Registry INSPIRE polygons, Environment Agency flood zones, Natural England/NatureScot environmental designations, Historic England heritage assets, and DEFRA END Directive noise mapping.
78
79
  */
79
80
  geographicType?: GeographicType | undefined;
80
81
  includeGeographyDetails?: string | undefined;
@@ -139,10 +140,11 @@ export type Pagination = {
139
140
  };
140
141
 
141
142
  /**
142
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
143
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
143
144
  */
144
145
  export const GetMetricValuesGeographicType = {
145
146
  Postcode: "postcode",
147
+ Outcode: "outcode",
146
148
  UkOutputArea: "uk_output_area",
147
149
  Lsoa21: "lsoa21",
148
150
  Ward: "ward",
@@ -195,17 +197,18 @@ export const GetMetricValuesGeographicType = {
195
197
  NoiseIndustryLden: "noise_industry_lden",
196
198
  } as const;
197
199
  /**
198
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
200
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
199
201
  */
200
202
  export type GetMetricValuesGeographicType = ClosedEnum<
201
203
  typeof GetMetricValuesGeographicType
202
204
  >;
203
205
 
204
206
  /**
205
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
207
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
206
208
  */
207
209
  export const GetMetricValuesType = {
208
210
  Postcode: "postcode",
211
+ Outcode: "outcode",
209
212
  UkOutputArea: "uk_output_area",
210
213
  Lsoa21: "lsoa21",
211
214
  Ward: "ward",
@@ -258,7 +261,7 @@ export const GetMetricValuesType = {
258
261
  NoiseIndustryLden: "noise_industry_lden",
259
262
  } as const;
260
263
  /**
261
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
264
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
262
265
  */
263
266
  export type GetMetricValuesType = ClosedEnum<typeof GetMetricValuesType>;
264
267
 
@@ -266,7 +269,7 @@ export type Geography = {
266
269
  code: string;
267
270
  name: string;
268
271
  /**
269
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
272
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
270
273
  */
271
274
  type: GetMetricValuesType;
272
275
  };
@@ -311,7 +314,7 @@ export type GetMetricValuesResult = {
311
314
  createdAt: string;
312
315
  geographicCode: string;
313
316
  /**
314
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
317
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
315
318
  */
316
319
  geographicType: GetMetricValuesGeographicType;
317
320
  geography?: Geography | undefined;
@@ -11,6 +11,7 @@ export * from "./getareaswithinradius.js";
11
11
  export * from "./getborderingareas.js";
12
12
  export * from "./getchildareas.js";
13
13
  export * from "./getconnectivityscores.js";
14
+ export * from "./getcouncilbyproviderid.js";
14
15
  export * from "./getepcbylocationid.js";
15
16
  export * from "./getlistingbyid.js";
16
17
  export * from "./getlistingbysource.js";
@@ -32,6 +33,7 @@ export * from "./getschoolbyurn.js";
32
33
  export * from "./getschoolmetrics.js";
33
34
  export * from "./getv1safetycrime.js";
34
35
  export * from "./getv1safetycrimestats.js";
36
+ export * from "./listcouncils.js";
35
37
  export * from "./listschools.js";
36
38
  export * from "./predictpropertyvalue.js";
37
39
  export * from "./predictpropertyvaluebylocation.js";