@vepler/sdk 6.57.1 → 6.61.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 (123) hide show
  1. package/dist/commonjs/lib/config.d.ts +2 -2
  2. package/dist/commonjs/lib/config.js +2 -2
  3. package/dist/commonjs/sdk/models/operations/getsitetiles.d.ts +1 -1
  4. package/dist/commonjs/sdk/models/shared/index.d.ts +6 -1
  5. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  6. package/dist/commonjs/sdk/models/shared/index.js +6 -1
  7. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  8. package/dist/commonjs/sdk/models/shared/site.d.ts +3 -1
  9. package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
  10. package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
  11. package/dist/commonjs/sdk/models/shared/sitefilters.d.ts +136 -1
  12. package/dist/commonjs/sdk/models/shared/sitefilters.d.ts.map +1 -1
  13. package/dist/commonjs/sdk/models/shared/sitefilters.js +116 -1
  14. package/dist/commonjs/sdk/models/shared/sitefilters.js.map +1 -1
  15. package/dist/commonjs/sdk/models/shared/sitelandcovercanonical.d.ts +55 -0
  16. package/dist/commonjs/sdk/models/shared/sitelandcovercanonical.d.ts.map +1 -0
  17. package/dist/commonjs/sdk/models/shared/sitelandcovercanonical.js +73 -0
  18. package/dist/commonjs/sdk/models/shared/sitelandcovercanonical.js.map +1 -0
  19. package/dist/commonjs/sdk/models/shared/sitelandcovershare.d.ts +30 -0
  20. package/dist/commonjs/sdk/models/shared/sitelandcovershare.d.ts.map +1 -0
  21. package/dist/commonjs/sdk/models/shared/{sitelandshare.js → sitelandcovershare.js} +8 -6
  22. package/dist/commonjs/sdk/models/shared/sitelandcovershare.js.map +1 -0
  23. package/dist/commonjs/sdk/models/shared/sitelandprofile.d.ts +5 -4
  24. package/dist/commonjs/sdk/models/shared/sitelandprofile.d.ts.map +1 -1
  25. package/dist/commonjs/sdk/models/shared/sitelandprofile.js +4 -3
  26. package/dist/commonjs/sdk/models/shared/sitelandprofile.js.map +1 -1
  27. package/dist/commonjs/sdk/models/shared/sitelanduse.d.ts +176 -0
  28. package/dist/commonjs/sdk/models/shared/sitelanduse.d.ts.map +1 -0
  29. package/dist/commonjs/sdk/models/shared/sitelanduse.js +181 -0
  30. package/dist/commonjs/sdk/models/shared/sitelanduse.js.map +1 -0
  31. package/dist/commonjs/sdk/models/shared/sitelanduseclass.d.ts +257 -0
  32. package/dist/commonjs/sdk/models/shared/sitelanduseclass.d.ts.map +1 -0
  33. package/dist/commonjs/sdk/models/shared/sitelanduseclass.js +268 -0
  34. package/dist/commonjs/sdk/models/shared/sitelanduseclass.js.map +1 -0
  35. package/dist/commonjs/sdk/models/shared/sitelandusesource.d.ts +53 -0
  36. package/dist/commonjs/sdk/models/shared/sitelandusesource.d.ts.map +1 -0
  37. package/dist/commonjs/sdk/models/shared/sitelandusesource.js +73 -0
  38. package/dist/commonjs/sdk/models/shared/sitelandusesource.js.map +1 -0
  39. package/dist/commonjs/sdk/models/shared/sitelandusetotal.d.ts +135 -0
  40. package/dist/commonjs/sdk/models/shared/sitelandusetotal.d.ts.map +1 -0
  41. package/dist/commonjs/sdk/models/shared/sitelandusetotal.js +159 -0
  42. package/dist/commonjs/sdk/models/shared/sitelandusetotal.js.map +1 -0
  43. package/dist/commonjs/sdk/models/shared/sitetags.d.ts +2 -2
  44. package/dist/commonjs/sdk/models/shared/sitetags.d.ts.map +1 -1
  45. package/dist/commonjs/sdk/models/shared/sitetags.js +1 -1
  46. package/dist/commonjs/sdk/models/shared/sitetags.js.map +1 -1
  47. package/dist/commonjs/sdk/models/shared/tierskipreason.d.ts +4 -4
  48. package/dist/commonjs/sdk/models/shared/tierskipreason.d.ts.map +1 -1
  49. package/dist/commonjs/sdk/models/shared/tierskipreason.js +4 -4
  50. package/dist/commonjs/sdk/models/shared/tierskipreason.js.map +1 -1
  51. package/dist/esm/lib/config.d.ts +2 -2
  52. package/dist/esm/lib/config.js +2 -2
  53. package/dist/esm/sdk/models/operations/getsitetiles.d.ts +1 -1
  54. package/dist/esm/sdk/models/shared/index.d.ts +6 -1
  55. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  56. package/dist/esm/sdk/models/shared/index.js +6 -1
  57. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  58. package/dist/esm/sdk/models/shared/site.d.ts +3 -1
  59. package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
  60. package/dist/esm/sdk/models/shared/site.js.map +1 -1
  61. package/dist/esm/sdk/models/shared/sitefilters.d.ts +136 -1
  62. package/dist/esm/sdk/models/shared/sitefilters.d.ts.map +1 -1
  63. package/dist/esm/sdk/models/shared/sitefilters.js +114 -0
  64. package/dist/esm/sdk/models/shared/sitefilters.js.map +1 -1
  65. package/dist/esm/sdk/models/shared/sitelandcovercanonical.d.ts +55 -0
  66. package/dist/esm/sdk/models/shared/sitelandcovercanonical.d.ts.map +1 -0
  67. package/dist/esm/sdk/models/shared/sitelandcovercanonical.js +36 -0
  68. package/dist/esm/sdk/models/shared/sitelandcovercanonical.js.map +1 -0
  69. package/dist/esm/sdk/models/shared/sitelandcovershare.d.ts +30 -0
  70. package/dist/esm/sdk/models/shared/sitelandcovershare.d.ts.map +1 -0
  71. package/dist/esm/sdk/models/shared/sitelandcovershare.js +18 -0
  72. package/dist/esm/sdk/models/shared/sitelandcovershare.js.map +1 -0
  73. package/dist/esm/sdk/models/shared/sitelandprofile.d.ts +5 -4
  74. package/dist/esm/sdk/models/shared/sitelandprofile.d.ts.map +1 -1
  75. package/dist/esm/sdk/models/shared/sitelandprofile.js +4 -3
  76. package/dist/esm/sdk/models/shared/sitelandprofile.js.map +1 -1
  77. package/dist/esm/sdk/models/shared/sitelanduse.d.ts +176 -0
  78. package/dist/esm/sdk/models/shared/sitelanduse.d.ts.map +1 -0
  79. package/dist/esm/sdk/models/shared/sitelanduse.js +144 -0
  80. package/dist/esm/sdk/models/shared/sitelanduse.js.map +1 -0
  81. package/dist/esm/sdk/models/shared/sitelanduseclass.d.ts +257 -0
  82. package/dist/esm/sdk/models/shared/sitelanduseclass.d.ts.map +1 -0
  83. package/dist/esm/sdk/models/shared/sitelanduseclass.js +231 -0
  84. package/dist/esm/sdk/models/shared/sitelanduseclass.js.map +1 -0
  85. package/dist/esm/sdk/models/shared/sitelandusesource.d.ts +53 -0
  86. package/dist/esm/sdk/models/shared/sitelandusesource.d.ts.map +1 -0
  87. package/dist/esm/sdk/models/shared/sitelandusesource.js +36 -0
  88. package/dist/esm/sdk/models/shared/sitelandusesource.js.map +1 -0
  89. package/dist/esm/sdk/models/shared/sitelandusetotal.d.ts +135 -0
  90. package/dist/esm/sdk/models/shared/sitelandusetotal.d.ts.map +1 -0
  91. package/dist/esm/sdk/models/shared/sitelandusetotal.js +122 -0
  92. package/dist/esm/sdk/models/shared/sitelandusetotal.js.map +1 -0
  93. package/dist/esm/sdk/models/shared/sitetags.d.ts +2 -2
  94. package/dist/esm/sdk/models/shared/sitetags.d.ts.map +1 -1
  95. package/dist/esm/sdk/models/shared/sitetags.js +1 -1
  96. package/dist/esm/sdk/models/shared/sitetags.js.map +1 -1
  97. package/dist/esm/sdk/models/shared/tierskipreason.d.ts +4 -4
  98. package/dist/esm/sdk/models/shared/tierskipreason.d.ts.map +1 -1
  99. package/dist/esm/sdk/models/shared/tierskipreason.js +3 -3
  100. package/dist/esm/sdk/models/shared/tierskipreason.js.map +1 -1
  101. package/package.json +1 -1
  102. package/src/lib/config.ts +2 -2
  103. package/src/sdk/models/operations/getsitetiles.ts +1 -1
  104. package/src/sdk/models/shared/index.ts +6 -1
  105. package/src/sdk/models/shared/site.ts +3 -1
  106. package/src/sdk/models/shared/sitefilters.ts +154 -1
  107. package/src/sdk/models/shared/sitelandcovercanonical.ts +86 -0
  108. package/src/sdk/models/shared/sitelandcovershare.ts +58 -0
  109. package/src/sdk/models/shared/sitelandprofile.ts +10 -6
  110. package/src/sdk/models/shared/sitelanduse.ts +223 -0
  111. package/src/sdk/models/shared/sitelanduseclass.ts +297 -0
  112. package/src/sdk/models/shared/sitelandusesource.ts +92 -0
  113. package/src/sdk/models/shared/sitelandusetotal.ts +166 -0
  114. package/src/sdk/models/shared/sitetags.ts +3 -3
  115. package/src/sdk/models/shared/tierskipreason.ts +9 -6
  116. package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts +0 -25
  117. package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts.map +0 -1
  118. package/dist/commonjs/sdk/models/shared/sitelandshare.js.map +0 -1
  119. package/dist/esm/sdk/models/shared/sitelandshare.d.ts +0 -25
  120. package/dist/esm/sdk/models/shared/sitelandshare.d.ts.map +0 -1
  121. package/dist/esm/sdk/models/shared/sitelandshare.js +0 -16
  122. package/dist/esm/sdk/models/shared/sitelandshare.js.map +0 -1
  123. package/src/sdk/models/shared/sitelandshare.ts +0 -49
@@ -5,7 +5,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
5
  /**
6
6
  * Stable code identifying why the tier was skipped, safe to branch on.
7
7
  */
8
- export declare const Code: {
8
+ export declare const TierSkipReasonCode: {
9
9
  readonly NoCoverageForLpa: "no_coverage_for_lpa";
10
10
  readonly NoCoverageForSchool: "no_coverage_for_school";
11
11
  readonly NoPolygonIntersects: "no_polygon_intersects";
@@ -17,7 +17,7 @@ export declare const Code: {
17
17
  /**
18
18
  * Stable code identifying why the tier was skipped, safe to branch on.
19
19
  */
20
- export type Code = OpenEnum<typeof Code>;
20
+ export type TierSkipReasonCode = OpenEnum<typeof TierSkipReasonCode>;
21
21
  /**
22
22
  * What evidence tied the school to the property. 'designated_polygon' means the property falls inside a catchment area the local authority publishes for the school. 'faith_jurisdiction' means it falls inside a parish or diocese tied to the school's faith criterion. 'last_admitted_distance' means it is at least as close as the furthest pupil the school admitted in the year read. 'feeder_link' means the school is named as a feeder destination by another school that already matched. 'distance_ranking' means the school is simply one of the nearest, the fallback that keeps a result set from being empty.
23
23
  */
@@ -36,7 +36,7 @@ export type TierSkipReason = {
36
36
  /**
37
37
  * Stable code identifying why the tier was skipped, safe to branch on.
38
38
  */
39
- code: Code;
39
+ code: TierSkipReasonCode;
40
40
  /**
41
41
  * Human-readable explanation of the skip, suitable for showing to an end user.
42
42
  */
@@ -47,7 +47,7 @@ export type TierSkipReason = {
47
47
  tier: TierSkipReasonTier;
48
48
  };
49
49
  /** @internal */
50
- export declare const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown>;
50
+ export declare const TierSkipReasonCode$inboundSchema: z.ZodType<TierSkipReasonCode, z.ZodTypeDef, unknown>;
51
51
  /** @internal */
52
52
  export declare const TierSkipReasonTier$inboundSchema: z.ZodType<TierSkipReasonTier, z.ZodTypeDef, unknown>;
53
53
  /** @internal */
@@ -1 +1 @@
1
- {"version":3,"file":"tierskipreason.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/tierskipreason.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,IAAI;;;;;;;;CAQP,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEzC;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;CAMrB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAErE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACvC,CAAC;AAEhC,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CACsC,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}
1
+ {"version":3,"file":"tierskipreason.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/tierskipreason.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;CAQrB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;CAMrB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAErE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CACsC,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CACsC,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}
@@ -7,7 +7,7 @@ import * as openEnums from "../../types/enums.js";
7
7
  /**
8
8
  * Stable code identifying why the tier was skipped, safe to branch on.
9
9
  */
10
- export const Code = {
10
+ export const TierSkipReasonCode = {
11
11
  NoCoverageForLpa: "no_coverage_for_lpa",
12
12
  NoCoverageForSchool: "no_coverage_for_school",
13
13
  NoPolygonIntersects: "no_polygon_intersects",
@@ -27,12 +27,12 @@ export const TierSkipReasonTier = {
27
27
  DistanceRanking: "distance_ranking",
28
28
  };
29
29
  /** @internal */
30
- export const Code$inboundSchema = openEnums.inboundSchema(Code);
30
+ export const TierSkipReasonCode$inboundSchema = openEnums.inboundSchema(TierSkipReasonCode);
31
31
  /** @internal */
32
32
  export const TierSkipReasonTier$inboundSchema = openEnums.inboundSchema(TierSkipReasonTier);
33
33
  /** @internal */
34
34
  export const TierSkipReason$inboundSchema = z.object({
35
- code: Code$inboundSchema,
35
+ code: TierSkipReasonCode$inboundSchema,
36
36
  reason: z.string(),
37
37
  tier: TierSkipReasonTier$inboundSchema,
38
38
  });
@@ -1 +1 @@
1
- {"version":3,"file":"tierskipreason.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/tierskipreason.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,gBAAgB,EAAE,qBAAqB;IACvC,mBAAmB,EAAE,wBAAwB;IAC7C,mBAAmB,EAAE,uBAAuB;IAC5C,gBAAgB,EAAE,qBAAqB;IACvC,4BAA4B,EAAE,kCAAkC;IAChE,oBAAoB,EAAE,yBAAyB;IAC/C,gBAAgB,EAAE,qBAAqB;CAC/B,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,iBAAiB,EAAE,oBAAoB;IACvC,oBAAoB,EAAE,wBAAwB;IAC9C,iBAAiB,EAAE,oBAAoB;IACvC,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAqBX,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAC7B,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AAEhC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,SAAS,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAEhD,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,kBAAkB;IACxB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,gCAAgC;CACvC,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"tierskipreason.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/tierskipreason.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,gBAAgB,EAAE,qBAAqB;IACvC,mBAAmB,EAAE,wBAAwB;IAC7C,mBAAmB,EAAE,uBAAuB;IAC5C,gBAAgB,EAAE,qBAAqB;IACvC,4BAA4B,EAAE,kCAAkC;IAChE,oBAAoB,EAAE,yBAAyB;IAC/C,gBAAgB,EAAE,qBAAqB;CAC/B,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,iBAAiB,EAAE,oBAAoB;IACvC,oBAAoB,EAAE,wBAAwB;IAC9C,iBAAiB,EAAE,oBAAoB;IACvC,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAqBX,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,SAAS,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAEhD,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,SAAS,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAEhD,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,gCAAgC;IACtC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,gCAAgC;CACvC,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vepler/sdk",
3
- "version": "6.57.1",
3
+ "version": "6.61.0",
4
4
  "author": "Vepler Limited",
5
5
  "type": "module",
6
6
  "tshy": {
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: "6.57.1",
63
+ openapiDocVersion: "6.61.0",
64
64
  sdkVersion: "0.12.0",
65
65
  genVersion: "2.950.13",
66
- userAgent: "speakeasy-sdk/typescript 0.12.0 2.950.13 6.57.1 @vepler/sdk",
66
+ userAgent: "speakeasy-sdk/typescript 0.12.0 2.950.13 6.61.0 @vepler/sdk",
67
67
  } as const;
@@ -10,7 +10,7 @@ export type GetSiteTilesRequest = {
10
10
  */
11
11
  area?: string | undefined;
12
12
  /**
13
- * Site fields to carry on each tile feature, as one comma-separated string. Defaults to `siteId`, `titleRef`, `tenureType`, `status`, `areaSqm`, `locationCount` and `areaMetrics.prosperityDecile`. Name each field in full; a wildcard such as `*` is rejected.
13
+ * Site fields to carry on each tile feature, as one comma-separated string. Defaults to `siteId`, `titleRef`, `tenureType`, `status`, `areaSqm`, `locationCount` and `areaMetrics.prosperityDecile`. Name each field in full; a wildcard such as `*` is rejected. `tags.agricultural` is worked out from `landProfile.use` when a site is returned, so it cannot be carried on a tile and is rejected.
14
14
  */
15
15
  fields?: string | undefined;
16
16
  /**
@@ -398,10 +398,15 @@ export * from "./siteconstraints.js";
398
398
  export * from "./siteconstraintunmeasured.js";
399
399
  export * from "./sitecontainspointareafilter.js";
400
400
  export * from "./sitefilters.js";
401
+ export * from "./sitelandcovercanonical.js";
402
+ export * from "./sitelandcovershare.js";
401
403
  export * from "./sitelandfeature.js";
402
404
  export * from "./sitelandlistresponse.js";
403
405
  export * from "./sitelandprofile.js";
404
- export * from "./sitelandshare.js";
406
+ export * from "./sitelanduse.js";
407
+ export * from "./sitelanduseclass.js";
408
+ export * from "./sitelandusesource.js";
409
+ export * from "./sitelandusetotal.js";
405
410
  export * from "./siteleafaggregation.js";
406
411
  export * from "./sitelistresponse.js";
407
412
  export * from "./sitemultipolygonareafilter.js";
@@ -335,7 +335,9 @@ export type Site = {
335
335
  */
336
336
  landProfile?: SiteLandProfile | undefined;
337
337
  /**
338
- * Land use classifications recorded for the site.
338
+ * Deprecated. Designations covering the site: `protected`, `woodland` and `urban`, the only values ever recorded here. They are designations and land cover rather than land use, and will move to `overlays`. The land use of the title, measured on the land inside the title boundary, is in `landProfile.use`.
339
+ *
340
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
339
341
  */
340
342
  landUse?: Array<LandUse> | undefined;
341
343
  /**
@@ -5,6 +5,128 @@
5
5
  import * as z from "zod/v3";
6
6
  import { ClosedEnum } from "../../types/enums.js";
7
7
 
8
+ /**
9
+ * A HILUCS land use code at any level. A broad code also matches the classes below it, so `1` matches `1_1` and `1_1_1`.
10
+ */
11
+ export const SiteFiltersCode = {
12
+ One: "1",
13
+ Two: "2",
14
+ Three: "3",
15
+ Four: "4",
16
+ Five: "5",
17
+ Six: "6",
18
+ One1: "1_1",
19
+ One11: "1_1_1",
20
+ One12: "1_1_2",
21
+ One13: "1_1_3",
22
+ One2: "1_2",
23
+ One21: "1_2_1",
24
+ One22: "1_2_2",
25
+ One23: "1_2_3",
26
+ One3: "1_3",
27
+ One31: "1_3_1",
28
+ One32: "1_3_2",
29
+ One33: "1_3_3",
30
+ One4: "1_4",
31
+ One41: "1_4_1",
32
+ One42: "1_4_2",
33
+ One5: "1_5",
34
+ One51: "1_5_1",
35
+ One52: "1_5_2",
36
+ One53: "1_5_3",
37
+ Two1: "2_1",
38
+ Two11: "2_1_1",
39
+ Two12: "2_1_2",
40
+ Two13: "2_1_3",
41
+ Two14: "2_1_4",
42
+ Two15: "2_1_5",
43
+ Two16: "2_1_6",
44
+ Two17: "2_1_7",
45
+ Two18: "2_1_8",
46
+ Two19: "2_1_9",
47
+ Two2: "2_2",
48
+ Two21: "2_2_1",
49
+ Two22: "2_2_2",
50
+ Two23: "2_2_3",
51
+ Two3: "2_3",
52
+ Two31: "2_3_1",
53
+ Two32: "2_3_2",
54
+ Two33: "2_3_3",
55
+ Two34: "2_3_4",
56
+ Two35: "2_3_5",
57
+ Two4: "2_4",
58
+ Two41: "2_4_1",
59
+ Two42: "2_4_2",
60
+ Two43: "2_4_3",
61
+ Two44: "2_4_4",
62
+ Two5: "2_5",
63
+ Three1: "3_1",
64
+ Three11: "3_1_1",
65
+ Three12: "3_1_2",
66
+ Three13: "3_1_3",
67
+ Three14: "3_1_4",
68
+ Three2: "3_2",
69
+ Three21: "3_2_1",
70
+ Three22: "3_2_2",
71
+ Three23: "3_2_3",
72
+ Three24: "3_2_4",
73
+ Three25: "3_2_5",
74
+ Three3: "3_3",
75
+ Three31: "3_3_1",
76
+ Three32: "3_3_2",
77
+ Three33: "3_3_3",
78
+ Three34: "3_3_4",
79
+ Three35: "3_3_5",
80
+ Three4: "3_4",
81
+ Three41: "3_4_1",
82
+ Three42: "3_4_2",
83
+ Three43: "3_4_3",
84
+ Three44: "3_4_4",
85
+ Three45: "3_4_5",
86
+ Three5: "3_5",
87
+ Four1: "4_1",
88
+ Four11: "4_1_1",
89
+ Four12: "4_1_2",
90
+ Four13: "4_1_3",
91
+ Four14: "4_1_4",
92
+ Four15: "4_1_5",
93
+ Four2: "4_2",
94
+ Four3: "4_3",
95
+ Four31: "4_3_1",
96
+ Four32: "4_3_2",
97
+ Four33: "4_3_3",
98
+ Four34: "4_3_4",
99
+ Five1: "5_1",
100
+ Five2: "5_2",
101
+ Five3: "5_3",
102
+ Six1: "6_1",
103
+ Six2: "6_2",
104
+ Six3: "6_3",
105
+ Six31: "6_3_1",
106
+ Six32: "6_3_2",
107
+ Six4: "6_4",
108
+ Six5: "6_5",
109
+ Six6: "6_6",
110
+ } as const;
111
+ /**
112
+ * A HILUCS land use code at any level. A broad code also matches the classes below it, so `1` matches `1_1` and `1_1_1`.
113
+ */
114
+ export type SiteFiltersCode = ClosedEnum<typeof SiteFiltersCode>;
115
+
116
+ /**
117
+ * Return only sites whose land carries this land use class, read from `landProfile.use`. Requires the `osNgdAccess` permission on the licence.
118
+ */
119
+ export type LandUseClass = {
120
+ /**
121
+ * A HILUCS land use code at any level. A broad code also matches the classes below it, so `1` matches `1_1` and `1_1_1`.
122
+ */
123
+ code: SiteFiltersCode;
124
+ /**
125
+ * Smallest share of the title's land area, by area, from 0 to 100, that the class and the classes below it must cover together. Defaults to 10.
126
+ */
127
+ minSharePct?: number | undefined;
128
+ };
129
+
8
130
  export const SiteFiltersStatus = {
9
131
  Active: "active",
10
132
  Pending: "pending",
@@ -17,7 +139,7 @@ export type SiteFiltersStatus = ClosedEnum<typeof SiteFiltersStatus>;
17
139
  */
18
140
  export type Tags = {
19
141
  /**
20
- * Match sites whose land use includes agricultural land.
142
+ * Match sites where HILUCS class `1_1` (agriculture) and the classes below it cover at least 10% of the title's land area, or less when `false`. The same as `landUseClass` with code `1_1` and the default share. Titles with no land polygons match neither. Requires the `osNgdAccess` permission on the licence.
21
143
  */
22
144
  agricultural?: boolean | undefined;
23
145
  /**
@@ -66,6 +188,10 @@ export type SiteFilters = {
66
188
  * Return only titles registered in this country, as an ISO 3166-1 alpha-2 code.
67
189
  */
68
190
  country?: string | undefined;
191
+ /**
192
+ * Return only sites whose land carries this land use class, read from `landProfile.use`. Requires the `osNgdAccess` permission on the licence.
193
+ */
194
+ landUseClass?: LandUseClass | undefined;
69
195
  /**
70
196
  * Return only sites carrying one of these overlay codes.
71
197
  */
@@ -92,6 +218,31 @@ export type SiteFilters = {
92
218
  tenureType?: Array<string> | undefined;
93
219
  };
94
220
 
221
+ /** @internal */
222
+ export const SiteFiltersCode$outboundSchema: z.ZodNativeEnum<
223
+ typeof SiteFiltersCode
224
+ > = z.nativeEnum(SiteFiltersCode);
225
+
226
+ /** @internal */
227
+ export type LandUseClass$Outbound = {
228
+ code: string;
229
+ minSharePct: number;
230
+ };
231
+
232
+ /** @internal */
233
+ export const LandUseClass$outboundSchema: z.ZodType<
234
+ LandUseClass$Outbound,
235
+ z.ZodTypeDef,
236
+ LandUseClass
237
+ > = z.object({
238
+ code: SiteFiltersCode$outboundSchema,
239
+ minSharePct: z.number().default(10),
240
+ });
241
+
242
+ export function landUseClassToJSON(landUseClass: LandUseClass): string {
243
+ return JSON.stringify(LandUseClass$outboundSchema.parse(landUseClass));
244
+ }
245
+
95
246
  /** @internal */
96
247
  export const SiteFiltersStatus$outboundSchema: z.ZodNativeEnum<
97
248
  typeof SiteFiltersStatus
@@ -129,6 +280,7 @@ export type SiteFilters$Outbound = {
129
280
  classTitleCode?: Array<string> | undefined;
130
281
  companyNumber?: string | undefined;
131
282
  country?: string | undefined;
283
+ landUseClass?: LandUseClass$Outbound | undefined;
132
284
  overlays?: Array<string> | undefined;
133
285
  ownerName?: string | undefined;
134
286
  ownershipCategory?: Array<string> | undefined;
@@ -148,6 +300,7 @@ export const SiteFilters$outboundSchema: z.ZodType<
148
300
  classTitleCode: z.array(z.string()).optional(),
149
301
  companyNumber: z.string().optional(),
150
302
  country: z.string().optional(),
303
+ landUseClass: z.lazy(() => LandUseClass$outboundSchema).optional(),
151
304
  overlays: z.array(z.string()).optional(),
152
305
  ownerName: z.string().optional(),
153
306
  ownershipCategory: z.array(z.string()).optional(),
@@ -0,0 +1,86 @@
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 * as openEnums from "../../types/enums.js";
8
+ import { ClosedEnum, OpenEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ /**
13
+ * How the source class relates to the class it is mapped to: `exact` when they mean the same, `broader` when the source class sits wholly inside the mapped class, which also covers other uses, and `partial` when the source class only partly belongs to it.
14
+ */
15
+ export const Mapping = {
16
+ Exact: "exact",
17
+ Broader: "broader",
18
+ Partial: "partial",
19
+ } as const;
20
+ /**
21
+ * How the source class relates to the class it is mapped to: `exact` when they mean the same, `broader` when the source class sits wholly inside the mapped class, which also covers other uses, and `partial` when the source class only partly belongs to it.
22
+ */
23
+ export type Mapping = OpenEnum<typeof Mapping>;
24
+
25
+ /**
26
+ * Classification the class is taken from. Always `esa_worldcover`.
27
+ */
28
+ export const Scheme = {
29
+ EsaWorldcover: "esa_worldcover",
30
+ } as const;
31
+ /**
32
+ * Classification the class is taken from. Always `esa_worldcover`.
33
+ */
34
+ export type Scheme = ClosedEnum<typeof Scheme>;
35
+
36
+ /**
37
+ * The same land cover in the ESA WorldCover classification. Null for an Ordnance Survey class that has no mapping yet.
38
+ */
39
+ export type SiteLandCoverCanonical = {
40
+ /**
41
+ * The ESA WorldCover land cover class code, one of its 11 classes.
42
+ */
43
+ code?: any | undefined;
44
+ /**
45
+ * English name of the ESA WorldCover class.
46
+ */
47
+ label?: string | undefined;
48
+ /**
49
+ * How the source class relates to the class it is mapped to: `exact` when they mean the same, `broader` when the source class sits wholly inside the mapped class, which also covers other uses, and `partial` when the source class only partly belongs to it.
50
+ */
51
+ mapping?: Mapping | undefined;
52
+ /**
53
+ * Classification the class is taken from. Always `esa_worldcover`.
54
+ */
55
+ scheme?: Scheme | undefined;
56
+ };
57
+
58
+ /** @internal */
59
+ export const Mapping$inboundSchema: z.ZodType<Mapping, z.ZodTypeDef, unknown> =
60
+ openEnums.inboundSchema(Mapping);
61
+
62
+ /** @internal */
63
+ export const Scheme$inboundSchema: z.ZodNativeEnum<typeof Scheme> = z
64
+ .nativeEnum(Scheme);
65
+
66
+ /** @internal */
67
+ export const SiteLandCoverCanonical$inboundSchema: z.ZodType<
68
+ SiteLandCoverCanonical,
69
+ z.ZodTypeDef,
70
+ unknown
71
+ > = z.object({
72
+ code: z.any().optional(),
73
+ label: z.string().optional(),
74
+ mapping: Mapping$inboundSchema.optional(),
75
+ scheme: Scheme$inboundSchema.optional(),
76
+ });
77
+
78
+ export function siteLandCoverCanonicalFromJSON(
79
+ jsonString: string,
80
+ ): SafeParseResult<SiteLandCoverCanonical, SDKValidationError> {
81
+ return safeParse(
82
+ jsonString,
83
+ (x) => SiteLandCoverCanonical$inboundSchema.parse(JSON.parse(x)),
84
+ `Failed to parse 'SiteLandCoverCanonical' from JSON`,
85
+ );
86
+ }
@@ -0,0 +1,58 @@
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 {
10
+ SiteLandCoverCanonical,
11
+ SiteLandCoverCanonical$inboundSchema,
12
+ } from "./sitelandcovercanonical.js";
13
+
14
+ export type SiteLandCoverShare = {
15
+ /**
16
+ * Area of the title carrying this class, in square metres. Where Ordnance Survey records several cover classes on one land polygon, its area is split evenly between them.
17
+ */
18
+ areaSqm?: number | undefined;
19
+ /**
20
+ * The same land cover in the ESA WorldCover classification. Null for an Ordnance Survey class that has no mapping yet.
21
+ */
22
+ canonical?: SiteLandCoverCanonical | null | undefined;
23
+ /**
24
+ * The broader Ordnance Survey land cover group the class belongs to.
25
+ */
26
+ group?: string | undefined;
27
+ /**
28
+ * Share of the title's land area carrying this class, by area, from 0 to 100.
29
+ */
30
+ pct?: number | undefined;
31
+ /**
32
+ * The Ordnance Survey land cover class this share is keyed by, as published.
33
+ */
34
+ value?: string | undefined;
35
+ };
36
+
37
+ /** @internal */
38
+ export const SiteLandCoverShare$inboundSchema: z.ZodType<
39
+ SiteLandCoverShare,
40
+ z.ZodTypeDef,
41
+ unknown
42
+ > = z.object({
43
+ areaSqm: z.number().optional(),
44
+ canonical: z.nullable(SiteLandCoverCanonical$inboundSchema).optional(),
45
+ group: z.string().optional(),
46
+ pct: z.number().optional(),
47
+ value: z.string().optional(),
48
+ });
49
+
50
+ export function siteLandCoverShareFromJSON(
51
+ jsonString: string,
52
+ ): SafeParseResult<SiteLandCoverShare, SDKValidationError> {
53
+ return safeParse(
54
+ jsonString,
55
+ (x) => SiteLandCoverShare$inboundSchema.parse(JSON.parse(x)),
56
+ `Failed to parse 'SiteLandCoverShare' from JSON`,
57
+ );
58
+ }
@@ -7,7 +7,11 @@ import { safeParse } from "../../../lib/schemas.js";
7
7
  import { ClosedEnum } from "../../types/enums.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
- import { SiteLandShare, SiteLandShare$inboundSchema } from "./sitelandshare.js";
10
+ import {
11
+ SiteLandCoverShare,
12
+ SiteLandCoverShare$inboundSchema,
13
+ } from "./sitelandcovershare.js";
14
+ import { SiteLandUse, SiteLandUse$inboundSchema } from "./sitelanduse.js";
11
15
 
12
16
  /**
13
17
  * Dataset the profile is computed from. Always `os_ngd_land`.
@@ -31,7 +35,7 @@ export type SiteLandProfile = {
31
35
  /**
32
36
  * The title's land area by Ordnance Survey land cover class, largest first.
33
37
  */
34
- cover?: Array<SiteLandShare> | undefined;
38
+ cover?: Array<SiteLandCoverShare> | undefined;
35
39
  /**
36
40
  * Share of the title area covered by land polygons, from 0 to 100. Building footprints are a separate feature type and are measured in `buildingProfile`, so a built title is rarely fully covered.
37
41
  */
@@ -69,9 +73,9 @@ export type SiteLandProfile = {
69
73
  */
70
74
  totalSqm?: number | undefined;
71
75
  /**
72
- * The title's land area by Ordnance Survey land use class, largest first.
76
+ * The title's land use, from Ordnance Survey land use data for the land inside the title boundary, mapped to the EU INSPIRE HILUCS land use code list. Each share is a share of the land area by area. It does not come from the title register or from your own records.
73
77
  */
74
- use?: Array<SiteLandShare> | undefined;
78
+ use?: SiteLandUse | undefined;
75
79
  };
76
80
 
77
81
  /** @internal */
@@ -86,7 +90,7 @@ export const SiteLandProfile$inboundSchema: z.ZodType<
86
90
  unknown
87
91
  > = z.object({
88
92
  asOf: z.string().optional(),
89
- cover: z.array(SiteLandShare$inboundSchema).optional(),
93
+ cover: z.array(SiteLandCoverShare$inboundSchema).optional(),
90
94
  coveredPct: z.number().optional(),
91
95
  madeSurfacePct: z.number().optional(),
92
96
  madeSurfaceSqm: z.number().optional(),
@@ -96,7 +100,7 @@ export const SiteLandProfile$inboundSchema: z.ZodType<
96
100
  source: SiteLandProfileSource$inboundSchema.optional(),
97
101
  tidalSqm: z.number().optional(),
98
102
  totalSqm: z.number().optional(),
99
- use: z.array(SiteLandShare$inboundSchema).optional(),
103
+ use: SiteLandUse$inboundSchema.optional(),
100
104
  });
101
105
 
102
106
  export function siteLandProfileFromJSON(