@vepler/sdk 6.66.0 → 7.1.2

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 (357) hide show
  1. package/README.md +14 -2
  2. package/dist/commonjs/funcs/companiesGetCompaniesByLocation.d.ts +1 -1
  3. package/dist/commonjs/funcs/companiesGetCompaniesByLocation.d.ts.map +1 -1
  4. package/dist/commonjs/funcs/companiesGetCompaniesByLocation.js +1 -1
  5. package/dist/commonjs/funcs/companiesGetCompaniesByLocation.js.map +1 -1
  6. package/dist/commonjs/funcs/companiesGetCompany.d.ts +2 -2
  7. package/dist/commonjs/funcs/companiesGetCompany.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/companiesGetCompany.js +2 -2
  9. package/dist/commonjs/funcs/companiesGetCompany.js.map +1 -1
  10. package/dist/commonjs/funcs/companiesGetCompanyOfficers.d.ts +1 -1
  11. package/dist/commonjs/funcs/companiesGetCompanyOfficers.d.ts.map +1 -1
  12. package/dist/commonjs/funcs/companiesGetCompanyOfficers.js +1 -1
  13. package/dist/commonjs/funcs/companiesGetCompanyOfficers.js.map +1 -1
  14. package/dist/commonjs/funcs/companiesGetCompanyPscs.d.ts +2 -2
  15. package/dist/commonjs/funcs/companiesGetCompanyPscs.d.ts.map +1 -1
  16. package/dist/commonjs/funcs/companiesGetCompanyPscs.js +2 -2
  17. package/dist/commonjs/funcs/companiesGetCompanyPscs.js.map +1 -1
  18. package/dist/commonjs/funcs/companiesGetOfficer.d.ts +1 -1
  19. package/dist/commonjs/funcs/companiesGetOfficer.d.ts.map +1 -1
  20. package/dist/commonjs/funcs/companiesGetOfficer.js +1 -1
  21. package/dist/commonjs/funcs/companiesGetOfficer.js.map +1 -1
  22. package/dist/commonjs/funcs/companiesGetPerson.d.ts +1 -1
  23. package/dist/commonjs/funcs/companiesGetPerson.d.ts.map +1 -1
  24. package/dist/commonjs/funcs/companiesGetPerson.js +1 -1
  25. package/dist/commonjs/funcs/companiesGetPerson.js.map +1 -1
  26. package/dist/commonjs/funcs/companiesGetPersonAppointments.d.ts +1 -1
  27. package/dist/commonjs/funcs/companiesGetPersonAppointments.d.ts.map +1 -1
  28. package/dist/commonjs/funcs/companiesGetPersonAppointments.js +2 -1
  29. package/dist/commonjs/funcs/companiesGetPersonAppointments.js.map +1 -1
  30. package/dist/commonjs/funcs/companiesGetPersonCluster.d.ts +1 -1
  31. package/dist/commonjs/funcs/companiesGetPersonCluster.d.ts.map +1 -1
  32. package/dist/commonjs/funcs/companiesGetPersonCluster.js +1 -1
  33. package/dist/commonjs/funcs/companiesGetPersonCluster.js.map +1 -1
  34. package/dist/commonjs/funcs/companiesGetPsc.d.ts +1 -1
  35. package/dist/commonjs/funcs/companiesGetPsc.d.ts.map +1 -1
  36. package/dist/commonjs/funcs/companiesGetPsc.js +1 -1
  37. package/dist/commonjs/funcs/companiesGetPsc.js.map +1 -1
  38. package/dist/commonjs/funcs/companiesQueryCompanies.d.ts +2 -2
  39. package/dist/commonjs/funcs/companiesQueryCompanies.d.ts.map +1 -1
  40. package/dist/commonjs/funcs/companiesQueryCompanies.js +4 -6
  41. package/dist/commonjs/funcs/companiesQueryCompanies.js.map +1 -1
  42. package/dist/commonjs/funcs/companiesQueryPersons.d.ts +1 -1
  43. package/dist/commonjs/funcs/companiesQueryPersons.d.ts.map +1 -1
  44. package/dist/commonjs/funcs/companiesQueryPersons.js +1 -1
  45. package/dist/commonjs/funcs/companiesQueryPersons.js.map +1 -1
  46. package/dist/commonjs/lib/config.d.ts +2 -2
  47. package/dist/commonjs/lib/config.js +2 -2
  48. package/dist/commonjs/lib/config.js.map +1 -1
  49. package/dist/commonjs/sdk/companies.d.ts +4 -4
  50. package/dist/commonjs/sdk/companies.d.ts.map +1 -1
  51. package/dist/commonjs/sdk/companies.js +3 -3
  52. package/dist/commonjs/sdk/companies.js.map +1 -1
  53. package/dist/commonjs/sdk/models/errors/getcompaniesbylocation.d.ts +65 -0
  54. package/dist/commonjs/sdk/models/errors/getcompaniesbylocation.d.ts.map +1 -1
  55. package/dist/commonjs/sdk/models/errors/getcompaniesbylocation.js +57 -1
  56. package/dist/commonjs/sdk/models/errors/getcompaniesbylocation.js.map +1 -1
  57. package/dist/commonjs/sdk/models/errors/getcompany.d.ts +65 -0
  58. package/dist/commonjs/sdk/models/errors/getcompany.d.ts.map +1 -1
  59. package/dist/commonjs/sdk/models/errors/getcompany.js +57 -1
  60. package/dist/commonjs/sdk/models/errors/getcompany.js.map +1 -1
  61. package/dist/commonjs/sdk/models/errors/getcompanyofficers.d.ts +65 -0
  62. package/dist/commonjs/sdk/models/errors/getcompanyofficers.d.ts.map +1 -1
  63. package/dist/commonjs/sdk/models/errors/getcompanyofficers.js +57 -1
  64. package/dist/commonjs/sdk/models/errors/getcompanyofficers.js.map +1 -1
  65. package/dist/commonjs/sdk/models/errors/getcompanypscs.d.ts +130 -0
  66. package/dist/commonjs/sdk/models/errors/getcompanypscs.d.ts.map +1 -1
  67. package/dist/commonjs/sdk/models/errors/getcompanypscs.js +113 -1
  68. package/dist/commonjs/sdk/models/errors/getcompanypscs.js.map +1 -1
  69. package/dist/commonjs/sdk/models/errors/getofficer.d.ts +65 -0
  70. package/dist/commonjs/sdk/models/errors/getofficer.d.ts.map +1 -1
  71. package/dist/commonjs/sdk/models/errors/getofficer.js +57 -1
  72. package/dist/commonjs/sdk/models/errors/getofficer.js.map +1 -1
  73. package/dist/commonjs/sdk/models/errors/getperson.d.ts +65 -0
  74. package/dist/commonjs/sdk/models/errors/getperson.d.ts.map +1 -1
  75. package/dist/commonjs/sdk/models/errors/getperson.js +57 -1
  76. package/dist/commonjs/sdk/models/errors/getperson.js.map +1 -1
  77. package/dist/commonjs/sdk/models/errors/getpersonappointments.d.ts +65 -0
  78. package/dist/commonjs/sdk/models/errors/getpersonappointments.d.ts.map +1 -1
  79. package/dist/commonjs/sdk/models/errors/getpersonappointments.js +57 -1
  80. package/dist/commonjs/sdk/models/errors/getpersonappointments.js.map +1 -1
  81. package/dist/commonjs/sdk/models/errors/getpersoncluster.d.ts +65 -0
  82. package/dist/commonjs/sdk/models/errors/getpersoncluster.d.ts.map +1 -1
  83. package/dist/commonjs/sdk/models/errors/getpersoncluster.js +57 -1
  84. package/dist/commonjs/sdk/models/errors/getpersoncluster.js.map +1 -1
  85. package/dist/commonjs/sdk/models/errors/getpsc.d.ts +65 -0
  86. package/dist/commonjs/sdk/models/errors/getpsc.d.ts.map +1 -1
  87. package/dist/commonjs/sdk/models/errors/getpsc.js +57 -1
  88. package/dist/commonjs/sdk/models/errors/getpsc.js.map +1 -1
  89. package/dist/commonjs/sdk/models/errors/querycompanies.d.ts +65 -0
  90. package/dist/commonjs/sdk/models/errors/querycompanies.d.ts.map +1 -1
  91. package/dist/commonjs/sdk/models/errors/querycompanies.js +57 -1
  92. package/dist/commonjs/sdk/models/errors/querycompanies.js.map +1 -1
  93. package/dist/commonjs/sdk/models/errors/querypersons.d.ts +65 -0
  94. package/dist/commonjs/sdk/models/errors/querypersons.d.ts.map +1 -1
  95. package/dist/commonjs/sdk/models/errors/querypersons.js +57 -1
  96. package/dist/commonjs/sdk/models/errors/querypersons.js.map +1 -1
  97. package/dist/commonjs/sdk/models/operations/getcompany.d.ts +2 -2
  98. package/dist/commonjs/sdk/models/shared/airqualityinstallations.d.ts +4 -4
  99. package/dist/commonjs/sdk/models/shared/airqualityinstallations.d.ts.map +1 -1
  100. package/dist/commonjs/sdk/models/shared/airqualityinstallations.js +6 -7
  101. package/dist/commonjs/sdk/models/shared/airqualityinstallations.js.map +1 -1
  102. package/dist/commonjs/sdk/models/shared/appointmentsresponse.d.ts +1 -0
  103. package/dist/commonjs/sdk/models/shared/appointmentsresponse.d.ts.map +1 -1
  104. package/dist/commonjs/sdk/models/shared/appointmentsresponse.js +1 -0
  105. package/dist/commonjs/sdk/models/shared/appointmentsresponse.js.map +1 -1
  106. package/dist/commonjs/sdk/models/shared/company.d.ts +19 -88
  107. package/dist/commonjs/sdk/models/shared/company.d.ts.map +1 -1
  108. package/dist/commonjs/sdk/models/shared/company.js +9 -52
  109. package/dist/commonjs/sdk/models/shared/company.js.map +1 -1
  110. package/dist/commonjs/sdk/models/shared/companyqueryrequest.d.ts +5 -33
  111. package/dist/commonjs/sdk/models/shared/companyqueryrequest.d.ts.map +1 -1
  112. package/dist/commonjs/sdk/models/shared/companyqueryrequest.js +3 -19
  113. package/dist/commonjs/sdk/models/shared/companyqueryrequest.js.map +1 -1
  114. package/dist/commonjs/sdk/models/shared/companyresponse.d.ts +4 -0
  115. package/dist/commonjs/sdk/models/shared/companyresponse.d.ts.map +1 -1
  116. package/dist/commonjs/sdk/models/shared/companyresponse.js +1 -0
  117. package/dist/commonjs/sdk/models/shared/companyresponse.js.map +1 -1
  118. package/dist/commonjs/sdk/models/shared/companysummary.d.ts +18 -35
  119. package/dist/commonjs/sdk/models/shared/companysummary.d.ts.map +1 -1
  120. package/dist/commonjs/sdk/models/shared/companysummary.js +9 -22
  121. package/dist/commonjs/sdk/models/shared/companysummary.js.map +1 -1
  122. package/dist/commonjs/sdk/models/shared/index.d.ts +3 -0
  123. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/models/shared/index.js +3 -0
  125. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  126. package/dist/commonjs/sdk/models/shared/psc.d.ts +8 -4
  127. package/dist/commonjs/sdk/models/shared/psc.d.ts.map +1 -1
  128. package/dist/commonjs/sdk/models/shared/psc.js +3 -2
  129. package/dist/commonjs/sdk/models/shared/psc.js.map +1 -1
  130. package/dist/commonjs/sdk/models/shared/pscexemption.d.ts +33 -0
  131. package/dist/commonjs/sdk/models/shared/pscexemption.d.ts.map +1 -0
  132. package/dist/commonjs/sdk/models/shared/pscexemption.js +61 -0
  133. package/dist/commonjs/sdk/models/shared/pscexemption.js.map +1 -0
  134. package/dist/commonjs/sdk/models/shared/psclistresponse.d.ts +19 -1
  135. package/dist/commonjs/sdk/models/shared/psclistresponse.d.ts.map +1 -1
  136. package/dist/commonjs/sdk/models/shared/psclistresponse.js +6 -0
  137. package/dist/commonjs/sdk/models/shared/psclistresponse.js.map +1 -1
  138. package/dist/commonjs/sdk/models/shared/pscresponse.d.ts +4 -0
  139. package/dist/commonjs/sdk/models/shared/pscresponse.d.ts.map +1 -1
  140. package/dist/commonjs/sdk/models/shared/pscresponse.js +1 -0
  141. package/dist/commonjs/sdk/models/shared/pscresponse.js.map +1 -1
  142. package/dist/commonjs/sdk/models/shared/pscstatement.d.ts +32 -0
  143. package/dist/commonjs/sdk/models/shared/pscstatement.d.ts.map +1 -0
  144. package/dist/commonjs/sdk/models/shared/pscstatement.js +54 -0
  145. package/dist/commonjs/sdk/models/shared/pscstatement.js.map +1 -0
  146. package/dist/commonjs/sdk/models/shared/pscsummary.d.ts +8 -4
  147. package/dist/commonjs/sdk/models/shared/pscsummary.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/models/shared/pscsummary.js +3 -2
  149. package/dist/commonjs/sdk/models/shared/pscsummary.js.map +1 -1
  150. package/dist/commonjs/sdk/models/shared/site.d.ts +1 -1
  151. package/dist/commonjs/sdk/models/shared/siteplanningapplicationlink.d.ts +56 -0
  152. package/dist/commonjs/sdk/models/shared/siteplanningapplicationlink.d.ts.map +1 -0
  153. package/dist/commonjs/sdk/models/shared/siteplanningapplicationlink.js +73 -0
  154. package/dist/commonjs/sdk/models/shared/siteplanningapplicationlink.js.map +1 -0
  155. package/dist/commonjs/sdk/models/shared/siteplanningstats.d.ts +19 -14
  156. package/dist/commonjs/sdk/models/shared/siteplanningstats.d.ts.map +1 -1
  157. package/dist/commonjs/sdk/models/shared/siteplanningstats.js +3 -1
  158. package/dist/commonjs/sdk/models/shared/siteplanningstats.js.map +1 -1
  159. package/dist/esm/funcs/companiesGetCompaniesByLocation.d.ts +1 -1
  160. package/dist/esm/funcs/companiesGetCompaniesByLocation.d.ts.map +1 -1
  161. package/dist/esm/funcs/companiesGetCompaniesByLocation.js +1 -1
  162. package/dist/esm/funcs/companiesGetCompaniesByLocation.js.map +1 -1
  163. package/dist/esm/funcs/companiesGetCompany.d.ts +2 -2
  164. package/dist/esm/funcs/companiesGetCompany.d.ts.map +1 -1
  165. package/dist/esm/funcs/companiesGetCompany.js +2 -2
  166. package/dist/esm/funcs/companiesGetCompany.js.map +1 -1
  167. package/dist/esm/funcs/companiesGetCompanyOfficers.d.ts +1 -1
  168. package/dist/esm/funcs/companiesGetCompanyOfficers.d.ts.map +1 -1
  169. package/dist/esm/funcs/companiesGetCompanyOfficers.js +1 -1
  170. package/dist/esm/funcs/companiesGetCompanyOfficers.js.map +1 -1
  171. package/dist/esm/funcs/companiesGetCompanyPscs.d.ts +2 -2
  172. package/dist/esm/funcs/companiesGetCompanyPscs.d.ts.map +1 -1
  173. package/dist/esm/funcs/companiesGetCompanyPscs.js +2 -2
  174. package/dist/esm/funcs/companiesGetCompanyPscs.js.map +1 -1
  175. package/dist/esm/funcs/companiesGetOfficer.d.ts +1 -1
  176. package/dist/esm/funcs/companiesGetOfficer.d.ts.map +1 -1
  177. package/dist/esm/funcs/companiesGetOfficer.js +1 -1
  178. package/dist/esm/funcs/companiesGetOfficer.js.map +1 -1
  179. package/dist/esm/funcs/companiesGetPerson.d.ts +1 -1
  180. package/dist/esm/funcs/companiesGetPerson.d.ts.map +1 -1
  181. package/dist/esm/funcs/companiesGetPerson.js +1 -1
  182. package/dist/esm/funcs/companiesGetPerson.js.map +1 -1
  183. package/dist/esm/funcs/companiesGetPersonAppointments.d.ts +1 -1
  184. package/dist/esm/funcs/companiesGetPersonAppointments.d.ts.map +1 -1
  185. package/dist/esm/funcs/companiesGetPersonAppointments.js +2 -1
  186. package/dist/esm/funcs/companiesGetPersonAppointments.js.map +1 -1
  187. package/dist/esm/funcs/companiesGetPersonCluster.d.ts +1 -1
  188. package/dist/esm/funcs/companiesGetPersonCluster.d.ts.map +1 -1
  189. package/dist/esm/funcs/companiesGetPersonCluster.js +1 -1
  190. package/dist/esm/funcs/companiesGetPersonCluster.js.map +1 -1
  191. package/dist/esm/funcs/companiesGetPsc.d.ts +1 -1
  192. package/dist/esm/funcs/companiesGetPsc.d.ts.map +1 -1
  193. package/dist/esm/funcs/companiesGetPsc.js +1 -1
  194. package/dist/esm/funcs/companiesGetPsc.js.map +1 -1
  195. package/dist/esm/funcs/companiesQueryCompanies.d.ts +2 -2
  196. package/dist/esm/funcs/companiesQueryCompanies.d.ts.map +1 -1
  197. package/dist/esm/funcs/companiesQueryCompanies.js +4 -6
  198. package/dist/esm/funcs/companiesQueryCompanies.js.map +1 -1
  199. package/dist/esm/funcs/companiesQueryPersons.d.ts +1 -1
  200. package/dist/esm/funcs/companiesQueryPersons.d.ts.map +1 -1
  201. package/dist/esm/funcs/companiesQueryPersons.js +1 -1
  202. package/dist/esm/funcs/companiesQueryPersons.js.map +1 -1
  203. package/dist/esm/lib/config.d.ts +2 -2
  204. package/dist/esm/lib/config.js +2 -2
  205. package/dist/esm/lib/config.js.map +1 -1
  206. package/dist/esm/sdk/companies.d.ts +4 -4
  207. package/dist/esm/sdk/companies.d.ts.map +1 -1
  208. package/dist/esm/sdk/companies.js +3 -3
  209. package/dist/esm/sdk/companies.js.map +1 -1
  210. package/dist/esm/sdk/models/errors/getcompaniesbylocation.d.ts +65 -0
  211. package/dist/esm/sdk/models/errors/getcompaniesbylocation.d.ts.map +1 -1
  212. package/dist/esm/sdk/models/errors/getcompaniesbylocation.js +54 -0
  213. package/dist/esm/sdk/models/errors/getcompaniesbylocation.js.map +1 -1
  214. package/dist/esm/sdk/models/errors/getcompany.d.ts +65 -0
  215. package/dist/esm/sdk/models/errors/getcompany.d.ts.map +1 -1
  216. package/dist/esm/sdk/models/errors/getcompany.js +54 -0
  217. package/dist/esm/sdk/models/errors/getcompany.js.map +1 -1
  218. package/dist/esm/sdk/models/errors/getcompanyofficers.d.ts +65 -0
  219. package/dist/esm/sdk/models/errors/getcompanyofficers.d.ts.map +1 -1
  220. package/dist/esm/sdk/models/errors/getcompanyofficers.js +54 -0
  221. package/dist/esm/sdk/models/errors/getcompanyofficers.js.map +1 -1
  222. package/dist/esm/sdk/models/errors/getcompanypscs.d.ts +130 -0
  223. package/dist/esm/sdk/models/errors/getcompanypscs.d.ts.map +1 -1
  224. package/dist/esm/sdk/models/errors/getcompanypscs.js +108 -0
  225. package/dist/esm/sdk/models/errors/getcompanypscs.js.map +1 -1
  226. package/dist/esm/sdk/models/errors/getofficer.d.ts +65 -0
  227. package/dist/esm/sdk/models/errors/getofficer.d.ts.map +1 -1
  228. package/dist/esm/sdk/models/errors/getofficer.js +54 -0
  229. package/dist/esm/sdk/models/errors/getofficer.js.map +1 -1
  230. package/dist/esm/sdk/models/errors/getperson.d.ts +65 -0
  231. package/dist/esm/sdk/models/errors/getperson.d.ts.map +1 -1
  232. package/dist/esm/sdk/models/errors/getperson.js +54 -0
  233. package/dist/esm/sdk/models/errors/getperson.js.map +1 -1
  234. package/dist/esm/sdk/models/errors/getpersonappointments.d.ts +65 -0
  235. package/dist/esm/sdk/models/errors/getpersonappointments.d.ts.map +1 -1
  236. package/dist/esm/sdk/models/errors/getpersonappointments.js +54 -0
  237. package/dist/esm/sdk/models/errors/getpersonappointments.js.map +1 -1
  238. package/dist/esm/sdk/models/errors/getpersoncluster.d.ts +65 -0
  239. package/dist/esm/sdk/models/errors/getpersoncluster.d.ts.map +1 -1
  240. package/dist/esm/sdk/models/errors/getpersoncluster.js +54 -0
  241. package/dist/esm/sdk/models/errors/getpersoncluster.js.map +1 -1
  242. package/dist/esm/sdk/models/errors/getpsc.d.ts +65 -0
  243. package/dist/esm/sdk/models/errors/getpsc.d.ts.map +1 -1
  244. package/dist/esm/sdk/models/errors/getpsc.js +54 -0
  245. package/dist/esm/sdk/models/errors/getpsc.js.map +1 -1
  246. package/dist/esm/sdk/models/errors/querycompanies.d.ts +65 -0
  247. package/dist/esm/sdk/models/errors/querycompanies.d.ts.map +1 -1
  248. package/dist/esm/sdk/models/errors/querycompanies.js +54 -0
  249. package/dist/esm/sdk/models/errors/querycompanies.js.map +1 -1
  250. package/dist/esm/sdk/models/errors/querypersons.d.ts +65 -0
  251. package/dist/esm/sdk/models/errors/querypersons.d.ts.map +1 -1
  252. package/dist/esm/sdk/models/errors/querypersons.js +54 -0
  253. package/dist/esm/sdk/models/errors/querypersons.js.map +1 -1
  254. package/dist/esm/sdk/models/operations/getcompany.d.ts +2 -2
  255. package/dist/esm/sdk/models/shared/airqualityinstallations.d.ts +4 -4
  256. package/dist/esm/sdk/models/shared/airqualityinstallations.d.ts.map +1 -1
  257. package/dist/esm/sdk/models/shared/airqualityinstallations.js +4 -5
  258. package/dist/esm/sdk/models/shared/airqualityinstallations.js.map +1 -1
  259. package/dist/esm/sdk/models/shared/appointmentsresponse.d.ts +1 -0
  260. package/dist/esm/sdk/models/shared/appointmentsresponse.d.ts.map +1 -1
  261. package/dist/esm/sdk/models/shared/appointmentsresponse.js +1 -0
  262. package/dist/esm/sdk/models/shared/appointmentsresponse.js.map +1 -1
  263. package/dist/esm/sdk/models/shared/company.d.ts +19 -88
  264. package/dist/esm/sdk/models/shared/company.d.ts.map +1 -1
  265. package/dist/esm/sdk/models/shared/company.js +8 -51
  266. package/dist/esm/sdk/models/shared/company.js.map +1 -1
  267. package/dist/esm/sdk/models/shared/companyqueryrequest.d.ts +5 -33
  268. package/dist/esm/sdk/models/shared/companyqueryrequest.d.ts.map +1 -1
  269. package/dist/esm/sdk/models/shared/companyqueryrequest.js +2 -18
  270. package/dist/esm/sdk/models/shared/companyqueryrequest.js.map +1 -1
  271. package/dist/esm/sdk/models/shared/companyresponse.d.ts +4 -0
  272. package/dist/esm/sdk/models/shared/companyresponse.d.ts.map +1 -1
  273. package/dist/esm/sdk/models/shared/companyresponse.js +1 -0
  274. package/dist/esm/sdk/models/shared/companyresponse.js.map +1 -1
  275. package/dist/esm/sdk/models/shared/companysummary.d.ts +18 -35
  276. package/dist/esm/sdk/models/shared/companysummary.d.ts.map +1 -1
  277. package/dist/esm/sdk/models/shared/companysummary.js +8 -21
  278. package/dist/esm/sdk/models/shared/companysummary.js.map +1 -1
  279. package/dist/esm/sdk/models/shared/index.d.ts +3 -0
  280. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  281. package/dist/esm/sdk/models/shared/index.js +3 -0
  282. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  283. package/dist/esm/sdk/models/shared/psc.d.ts +8 -4
  284. package/dist/esm/sdk/models/shared/psc.d.ts.map +1 -1
  285. package/dist/esm/sdk/models/shared/psc.js +3 -2
  286. package/dist/esm/sdk/models/shared/psc.js.map +1 -1
  287. package/dist/esm/sdk/models/shared/pscexemption.d.ts +33 -0
  288. package/dist/esm/sdk/models/shared/pscexemption.d.ts.map +1 -0
  289. package/dist/esm/sdk/models/shared/pscexemption.js +23 -0
  290. package/dist/esm/sdk/models/shared/pscexemption.js.map +1 -0
  291. package/dist/esm/sdk/models/shared/psclistresponse.d.ts +19 -1
  292. package/dist/esm/sdk/models/shared/psclistresponse.d.ts.map +1 -1
  293. package/dist/esm/sdk/models/shared/psclistresponse.js +6 -0
  294. package/dist/esm/sdk/models/shared/psclistresponse.js.map +1 -1
  295. package/dist/esm/sdk/models/shared/pscresponse.d.ts +4 -0
  296. package/dist/esm/sdk/models/shared/pscresponse.d.ts.map +1 -1
  297. package/dist/esm/sdk/models/shared/pscresponse.js +1 -0
  298. package/dist/esm/sdk/models/shared/pscresponse.js.map +1 -1
  299. package/dist/esm/sdk/models/shared/pscstatement.d.ts +32 -0
  300. package/dist/esm/sdk/models/shared/pscstatement.d.ts.map +1 -0
  301. package/dist/esm/sdk/models/shared/pscstatement.js +17 -0
  302. package/dist/esm/sdk/models/shared/pscstatement.js.map +1 -0
  303. package/dist/esm/sdk/models/shared/pscsummary.d.ts +8 -4
  304. package/dist/esm/sdk/models/shared/pscsummary.d.ts.map +1 -1
  305. package/dist/esm/sdk/models/shared/pscsummary.js +3 -2
  306. package/dist/esm/sdk/models/shared/pscsummary.js.map +1 -1
  307. package/dist/esm/sdk/models/shared/site.d.ts +1 -1
  308. package/dist/esm/sdk/models/shared/siteplanningapplicationlink.d.ts +56 -0
  309. package/dist/esm/sdk/models/shared/siteplanningapplicationlink.d.ts.map +1 -0
  310. package/dist/esm/sdk/models/shared/siteplanningapplicationlink.js +36 -0
  311. package/dist/esm/sdk/models/shared/siteplanningapplicationlink.js.map +1 -0
  312. package/dist/esm/sdk/models/shared/siteplanningstats.d.ts +19 -14
  313. package/dist/esm/sdk/models/shared/siteplanningstats.d.ts.map +1 -1
  314. package/dist/esm/sdk/models/shared/siteplanningstats.js +3 -1
  315. package/dist/esm/sdk/models/shared/siteplanningstats.js.map +1 -1
  316. package/package.json +1 -1
  317. package/src/funcs/companiesGetCompaniesByLocation.ts +7 -0
  318. package/src/funcs/companiesGetCompany.ts +8 -1
  319. package/src/funcs/companiesGetCompanyOfficers.ts +7 -0
  320. package/src/funcs/companiesGetCompanyPscs.ts +16 -2
  321. package/src/funcs/companiesGetOfficer.ts +7 -0
  322. package/src/funcs/companiesGetPerson.ts +7 -0
  323. package/src/funcs/companiesGetPersonAppointments.ts +8 -0
  324. package/src/funcs/companiesGetPersonCluster.ts +7 -0
  325. package/src/funcs/companiesGetPsc.ts +4 -0
  326. package/src/funcs/companiesQueryCompanies.ts +12 -8
  327. package/src/funcs/companiesQueryPersons.ts +7 -0
  328. package/src/lib/config.ts +2 -2
  329. package/src/sdk/companies.ts +4 -4
  330. package/src/sdk/models/errors/getcompaniesbylocation.ts +140 -0
  331. package/src/sdk/models/errors/getcompany.ts +126 -0
  332. package/src/sdk/models/errors/getcompanyofficers.ts +136 -0
  333. package/src/sdk/models/errors/getcompanypscs.ts +265 -0
  334. package/src/sdk/models/errors/getofficer.ts +126 -0
  335. package/src/sdk/models/errors/getperson.ts +128 -0
  336. package/src/sdk/models/errors/getpersonappointments.ts +140 -0
  337. package/src/sdk/models/errors/getpersoncluster.ts +138 -0
  338. package/src/sdk/models/errors/getpsc.ts +127 -0
  339. package/src/sdk/models/errors/querycompanies.ts +129 -0
  340. package/src/sdk/models/errors/querypersons.ts +128 -0
  341. package/src/sdk/models/operations/getcompany.ts +2 -2
  342. package/src/sdk/models/shared/airqualityinstallations.ts +20 -17
  343. package/src/sdk/models/shared/appointmentsresponse.ts +1 -0
  344. package/src/sdk/models/shared/company.ts +25 -114
  345. package/src/sdk/models/shared/companyqueryrequest.ts +5 -39
  346. package/src/sdk/models/shared/companyresponse.ts +5 -0
  347. package/src/sdk/models/shared/companysummary.ts +24 -47
  348. package/src/sdk/models/shared/index.ts +3 -0
  349. package/src/sdk/models/shared/psc.ts +11 -6
  350. package/src/sdk/models/shared/pscexemption.ts +70 -0
  351. package/src/sdk/models/shared/psclistresponse.ts +23 -1
  352. package/src/sdk/models/shared/pscresponse.ts +5 -0
  353. package/src/sdk/models/shared/pscstatement.ts +57 -0
  354. package/src/sdk/models/shared/pscsummary.ts +11 -6
  355. package/src/sdk/models/shared/site.ts +1 -1
  356. package/src/sdk/models/shared/siteplanningapplicationlink.ts +92 -0
  357. package/src/sdk/models/shared/siteplanningstats.ts +24 -15
@@ -11,6 +11,79 @@ import { Result as SafeParseResult } from "../../types/fp.js";
11
11
  import { SDKBaseError } from "./sdkbaseerror.js";
12
12
  import { SDKValidationError } from "./sdkvalidationerror.js";
13
13
 
14
+ /**
15
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
16
+ */
17
+ export const QueryPersonsCompaniesResponseType = {
18
+ ApiError: "api_error",
19
+ InvalidRequestError: "invalid_request_error",
20
+ AuthenticationError: "authentication_error",
21
+ RateLimitError: "rate_limit_error",
22
+ } as const;
23
+ /**
24
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
25
+ */
26
+ export type QueryPersonsCompaniesResponseType = OpenEnum<
27
+ typeof QueryPersonsCompaniesResponseType
28
+ >;
29
+
30
+ export type QueryPersonsCompaniesResponseError = {
31
+ /**
32
+ * Stable code identifying the specific failure, safe to branch on.
33
+ */
34
+ code?: string | undefined;
35
+ /**
36
+ * Link to the documentation for this error.
37
+ */
38
+ docUrl?: string | undefined;
39
+ /**
40
+ * Human-readable explanation of what went wrong.
41
+ */
42
+ message: string;
43
+ /**
44
+ * Name of the request parameter at fault, where the failure can be traced to one.
45
+ */
46
+ param?: string | undefined;
47
+ /**
48
+ * Alternative values worth retrying when the supplied one could not be matched.
49
+ */
50
+ suggestions?: Array<string> | undefined;
51
+ /**
52
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
53
+ */
54
+ type: QueryPersonsCompaniesResponseType;
55
+ };
56
+
57
+ /**
58
+ * Returned in place of the normal payload whenever a request fails.
59
+ */
60
+ export type QueryPersonsCompaniesResponseResponseBodyData = {
61
+ error: QueryPersonsCompaniesResponseError;
62
+ };
63
+
64
+ /**
65
+ * Returned in place of the normal payload whenever a request fails.
66
+ */
67
+ export class QueryPersonsCompaniesResponseResponseBody extends SDKBaseError {
68
+ error: QueryPersonsCompaniesResponseError;
69
+
70
+ /** The original data that was passed to this error instance. */
71
+ data$: QueryPersonsCompaniesResponseResponseBodyData;
72
+
73
+ constructor(
74
+ err: QueryPersonsCompaniesResponseResponseBodyData,
75
+ httpMeta: { response: Response; request: Request; body: string },
76
+ ) {
77
+ const message = err.error?.message
78
+ || `API error occurred: ${JSON.stringify(err)}`;
79
+ super(message, httpMeta);
80
+ this.data$ = err;
81
+ this.error = err.error;
82
+
83
+ this.name = "QueryPersonsCompaniesResponseResponseBody";
84
+ }
85
+ }
86
+
14
87
  /**
15
88
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
16
89
  */
@@ -155,6 +228,61 @@ export class QueryPersonsResponseBody extends SDKBaseError {
155
228
  }
156
229
  }
157
230
 
231
+ /** @internal */
232
+ export const QueryPersonsCompaniesResponseType$inboundSchema: z.ZodType<
233
+ QueryPersonsCompaniesResponseType,
234
+ z.ZodTypeDef,
235
+ unknown
236
+ > = openEnums.inboundSchema(QueryPersonsCompaniesResponseType);
237
+
238
+ /** @internal */
239
+ export const QueryPersonsCompaniesResponseError$inboundSchema: z.ZodType<
240
+ QueryPersonsCompaniesResponseError,
241
+ z.ZodTypeDef,
242
+ unknown
243
+ > = z.object({
244
+ code: z.string().optional(),
245
+ doc_url: z.string().optional(),
246
+ message: z.string(),
247
+ param: z.string().optional(),
248
+ suggestions: z.array(z.string()).optional(),
249
+ type: QueryPersonsCompaniesResponseType$inboundSchema,
250
+ }).transform((v) => {
251
+ return remap$(v, {
252
+ "doc_url": "docUrl",
253
+ });
254
+ });
255
+
256
+ export function queryPersonsCompaniesResponseErrorFromJSON(
257
+ jsonString: string,
258
+ ): SafeParseResult<QueryPersonsCompaniesResponseError, SDKValidationError> {
259
+ return safeParse(
260
+ jsonString,
261
+ (x) =>
262
+ QueryPersonsCompaniesResponseError$inboundSchema.parse(JSON.parse(x)),
263
+ `Failed to parse 'QueryPersonsCompaniesResponseError' from JSON`,
264
+ );
265
+ }
266
+
267
+ /** @internal */
268
+ export const QueryPersonsCompaniesResponseResponseBody$inboundSchema: z.ZodType<
269
+ QueryPersonsCompaniesResponseResponseBody,
270
+ z.ZodTypeDef,
271
+ unknown
272
+ > = z.object({
273
+ error: z.lazy(() => QueryPersonsCompaniesResponseError$inboundSchema),
274
+ request$: z.instanceof(Request),
275
+ response$: z.instanceof(Response),
276
+ body$: z.string(),
277
+ })
278
+ .transform((v) => {
279
+ return new QueryPersonsCompaniesResponseResponseBody(v, {
280
+ request: v.request$,
281
+ response: v.response$,
282
+ body: v.body$,
283
+ });
284
+ });
285
+
158
286
  /** @internal */
159
287
  export const QueryPersonsCompaniesType$inboundSchema: z.ZodType<
160
288
  QueryPersonsCompaniesType,
@@ -10,11 +10,11 @@ export type GetCompanyRequest = {
10
10
  */
11
11
  companyNumber: string;
12
12
  /**
13
- * Set to `true` to add up to 50 active officer summaries to the response. Any other value leaves them out.
13
+ * Set to `true` to add up to 50 active officer summaries to the response. Any other value leaves them out. While officer data is not available, `true` returns 503.
14
14
  */
15
15
  includeOfficers?: string | undefined;
16
16
  /**
17
- * Set to `true` to add up to 50 active PSC summaries to the response. Any other value leaves them out.
17
+ * Set to `true` to add up to 50 active PSC summaries to the response, with pscDataAsOf. People whose identities are protected by court order are left out. Any other value leaves them out. While PSC data is not available, `true` returns 503.
18
18
  */
19
19
  includePscs?: string | undefined;
20
20
  };
@@ -12,7 +12,7 @@ import {
12
12
  } from "./airqualitytoprelease.js";
13
13
  import { Regulator, Regulator$inboundSchema } from "./regulator.js";
14
14
 
15
- export type Items = {
15
+ export type AirQualityInstallationsItems = {
16
16
  /**
17
17
  * Direction to the feature, in degrees clockwise from true north. Between 0 and 360.
18
18
  */
@@ -56,7 +56,7 @@ export type Nearby = {
56
56
  /**
57
57
  * The matching features, nearest first, each with its distance.
58
58
  */
59
- items: Array<Items>;
59
+ items: Array<AirQualityInstallationsItems>;
60
60
  /**
61
61
  * Radius searched around the requested location, in metres.
62
62
  */
@@ -78,24 +78,27 @@ export type AirQualityInstallations = {
78
78
  };
79
79
 
80
80
  /** @internal */
81
- export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
82
- .object({
83
- bearingDeg: z.number().optional(),
84
- compliance: z.array(z.any()).optional(),
85
- distanceM: z.number(),
86
- operator: z.nullable(z.string()),
87
- permitReference: z.string(),
88
- regulator: Regulator$inboundSchema,
89
- sector: z.nullable(z.string()),
90
- });
81
+ export const AirQualityInstallationsItems$inboundSchema: z.ZodType<
82
+ AirQualityInstallationsItems,
83
+ z.ZodTypeDef,
84
+ unknown
85
+ > = z.object({
86
+ bearingDeg: z.number().optional(),
87
+ compliance: z.array(z.any()).optional(),
88
+ distanceM: z.number(),
89
+ operator: z.nullable(z.string()),
90
+ permitReference: z.string(),
91
+ regulator: Regulator$inboundSchema,
92
+ sector: z.nullable(z.string()),
93
+ });
91
94
 
92
- export function itemsFromJSON(
95
+ export function airQualityInstallationsItemsFromJSON(
93
96
  jsonString: string,
94
- ): SafeParseResult<Items, SDKValidationError> {
97
+ ): SafeParseResult<AirQualityInstallationsItems, SDKValidationError> {
95
98
  return safeParse(
96
99
  jsonString,
97
- (x) => Items$inboundSchema.parse(JSON.parse(x)),
98
- `Failed to parse 'Items' from JSON`,
100
+ (x) => AirQualityInstallationsItems$inboundSchema.parse(JSON.parse(x)),
101
+ `Failed to parse 'AirQualityInstallationsItems' from JSON`,
99
102
  );
100
103
  }
101
104
 
@@ -105,7 +108,7 @@ export const Nearby$inboundSchema: z.ZodType<Nearby, z.ZodTypeDef, unknown> = z
105
108
  capacity: z.number().int(),
106
109
  capped: z.boolean(),
107
110
  count: z.number().int(),
108
- items: z.array(z.lazy(() => Items$inboundSchema)),
111
+ items: z.array(z.lazy(() => AirQualityInstallationsItems$inboundSchema)),
109
112
  radiusM: z.number(),
110
113
  });
111
114
 
@@ -25,6 +25,7 @@ export const AppointmentsResponseCompanyStatus = {
25
25
  Closed: "closed",
26
26
  Registered: "registered",
27
27
  Removed: "removed",
28
+ NotInLatestRegister: "not-in-latest-register",
28
29
  } as const;
29
30
  /**
30
31
  * The company's current status on the register, which tells you whether the appointment is at a live company or one that has been dissolved.
@@ -7,39 +7,13 @@ import { safeParse } from "../../../lib/schemas.js";
7
7
  import * as openEnums from "../../types/enums.js";
8
8
  import { OpenEnum } from "../../types/enums.js";
9
9
  import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { RFCDate } from "../../types/rfcdate.js";
10
11
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
12
  import { PreviousName, PreviousName$inboundSchema } from "./previousname.js";
12
13
  import { SicCode, SicCode$inboundSchema } from "./siccode.js";
13
14
 
14
15
  /**
15
- * The kind of annual accounts the company files, which follows from its size. Null when the register does not record one.
16
- */
17
- export const AccountsType = {
18
- Null: "null",
19
- Full: "full",
20
- Small: "small",
21
- Medium: "medium",
22
- Group: "group",
23
- Dormant: "dormant",
24
- Interim: "interim",
25
- Initial: "initial",
26
- TotalExemptionFull: "total-exemption-full",
27
- TotalExemptionSmall: "total-exemption-small",
28
- PartialExemption: "partial-exemption",
29
- AuditExemptionSubsidiary: "audit-exemption-subsidiary",
30
- FilingExemptionSubsidiary: "filing-exemption-subsidiary",
31
- MicroEntity: "micro-entity",
32
- NoAccountsTypeAvailable: "no-accounts-type-available",
33
- AuditedAbridged: "audited-abridged",
34
- UnauditedAbridged: "unaudited-abridged",
35
- } as const;
36
- /**
37
- * The kind of annual accounts the company files, which follows from its size. Null when the register does not record one.
38
- */
39
- export type AccountsType = OpenEnum<typeof AccountsType>;
40
-
41
- /**
42
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
16
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from. Null when the register records no status for the company.
43
17
  */
44
18
  export const CompanyStatus = {
45
19
  Active: "active",
@@ -54,9 +28,10 @@ export const CompanyStatus = {
54
28
  Closed: "closed",
55
29
  Registered: "registered",
56
30
  Removed: "removed",
31
+ NotInLatestRegister: "not-in-latest-register",
57
32
  } as const;
58
33
  /**
59
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
34
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from. Null when the register records no status for the company.
60
35
  */
61
36
  export type CompanyStatus = OpenEnum<typeof CompanyStatus>;
62
37
 
@@ -76,7 +51,7 @@ export const CompanySubtype = {
76
51
  export type CompanySubtype = OpenEnum<typeof CompanySubtype>;
77
52
 
78
53
  /**
79
- * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types.
54
+ * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types. Null when the register records no type for the company.
80
55
  */
81
56
  export const CompanyType = {
82
57
  PrivateUnlimited: "private-unlimited",
@@ -123,28 +98,10 @@ export const CompanyType = {
123
98
  RegisteredOverseasEntity: "registered-overseas-entity",
124
99
  } as const;
125
100
  /**
126
- * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types.
101
+ * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types. Null when the register records no type for the company.
127
102
  */
128
103
  export type CompanyType = OpenEnum<typeof CompanyType>;
129
104
 
130
- /**
131
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
132
- */
133
- export const Jurisdiction = {
134
- EnglandWales: "england-wales",
135
- Wales: "wales",
136
- Scotland: "scotland",
137
- NorthernIreland: "northern-ireland",
138
- EuropeanUnion: "european-union",
139
- UnitedKingdom: "united-kingdom",
140
- England: "england",
141
- Noneu: "noneu",
142
- } as const;
143
- /**
144
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
145
- */
146
- export type Jurisdiction = OpenEnum<typeof Jurisdiction>;
147
-
148
105
  /**
149
106
  * The company's registered office, the official address for serving legal documents and for correspondence from Companies House. Every UK company must have one.
150
107
  */
@@ -203,14 +160,6 @@ export type Company = {
203
160
  * The deadline for filing the next set of annual accounts, as an ISO 8601 date.
204
161
  */
205
162
  accountsNextDueDate?: Date | null | undefined;
206
- /**
207
- * The kind of annual accounts the company files, which follows from its size. Null when the register does not record one.
208
- */
209
- accountsType?: AccountsType | null | undefined;
210
- /**
211
- * True when the company can still file documents with Companies House. It is false once a company has been dissolved, and in some insolvency states.
212
- */
213
- canFile: boolean;
214
163
  /**
215
164
  * The company's registered name as it appears on the register, normally in capitals. It includes the legal suffix, such as `LTD`, `PLC` or `LLP`, unless the company is exempt from using one.
216
165
  */
@@ -220,17 +169,17 @@ export type Company = {
220
169
  */
221
170
  companyNumber: string;
222
171
  /**
223
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
172
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from. Null when the register records no status for the company.
224
173
  */
225
- companyStatus: CompanyStatus;
174
+ companyStatus: CompanyStatus | null;
226
175
  /**
227
176
  * A further classification on top of the company type, such as `community-interest-company`. Null for most companies.
228
177
  */
229
178
  companySubtype?: CompanySubtype | null | undefined;
230
179
  /**
231
- * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types.
180
+ * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types. Null when the register records no type for the company.
232
181
  */
233
- companyType: CompanyType;
182
+ companyType: CompanyType | null;
234
183
  /**
235
184
  * The date the most recent confirmation statement was made up to, as an ISO 8601 date.
236
185
  */
@@ -240,53 +189,37 @@ export type Company = {
240
189
  */
241
190
  confirmationStatementNextDueDate?: Date | null | undefined;
242
191
  /**
243
- * For an entity incorporated outside the UK, the country it comes from. Null for UK-incorporated companies.
192
+ * The country of origin exactly as the register publishes it. For a UK-incorporated company it is normally `United Kingdom`; for an entity incorporated elsewhere it names that country. Null when the register gives none.
244
193
  */
245
194
  countryOfOrigin?: string | null | undefined;
246
195
  /**
247
196
  * When this record first appeared in the API, as an ISO 8601 timestamp.
248
197
  */
249
198
  createdAt: Date;
250
- /**
251
- * When the company was dissolved and struck off the register, as an ISO 8601 date. Null for companies that have not been dissolved.
252
- */
253
- dissolutionDate?: Date | null | undefined;
254
- /**
255
- * For an overseas entity, its registration number in its home jurisdiction. Null for UK-incorporated companies.
256
- */
257
- externalRegistrationNumber?: string | null | undefined;
258
199
  /**
259
200
  * True when the company has charges registered against it, such as mortgages, debentures or other security interests. Charges are registered under Part 25 of the Companies Act 2006.
260
201
  */
261
202
  hasCharges: boolean;
262
- /**
263
- * True when the register holds insolvency events for the company, such as a winding-up petition, an administration order, a company voluntary arrangement or liquidation proceedings.
264
- */
265
- hasInsolvencyHistory: boolean;
266
203
  /**
267
204
  * When the company came into legal existence, as an ISO 8601 date. Null when the register does not record one.
268
205
  */
269
206
  incorporationDate?: Date | null | undefined;
270
- /**
271
- * For an overseas entity, true when it is still registered in its home jurisdiction. Null for UK-incorporated companies.
272
- */
273
- isOnRegisterInJurisdiction?: boolean | null | undefined;
274
- /**
275
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
276
- */
277
- jurisdiction: Jurisdiction;
278
- /**
279
- * The date of the most recent annual return or confirmation statement, as an ISO 8601 date. The confirmation statement replaced the annual return in June 2016.
280
- */
281
- lastMembersListDate?: Date | null | undefined;
282
207
  /**
283
208
  * Identifier for a single addressable location. In Great Britain this is the Unique Property Reference Number (UPRN). It is the location of the registered office, and is null when that address could not be matched to one.
284
209
  */
285
210
  locationId?: string | null | undefined;
211
+ /**
212
+ * The release date of the first monthly release of the register that no longer listed the company, as an ISO 8601 date. The release lists live companies only, so this marks when the company stopped being listed; it is not a dissolution date. Null while the latest release lists the company, and companyStatus is `not-in-latest-register` whenever it is set.
213
+ */
214
+ notInLatestRegisterSince?: RFCDate | null | undefined;
286
215
  /**
287
216
  * Names the company was registered under before its current one, each with the dates it was in use. Up to 10 entries, which lets you trace a company across a rename.
288
217
  */
289
218
  previousNames?: Array<PreviousName> | undefined;
219
+ /**
220
+ * The company's status exactly as Companies House published it in the latest monthly release of the register that listed the company, such as `Active - Proposal to Strike off`. It keeps detail that companyStatus groups together. Null when no published status is held for the company.
221
+ */
222
+ registerStatus?: string | null | undefined;
290
223
  /**
291
224
  * The company's registered office, the official address for serving legal documents and for correspondence from Companies House. Every UK company must have one.
292
225
  */
@@ -301,13 +234,6 @@ export type Company = {
301
234
  updatedAt: Date;
302
235
  };
303
236
 
304
- /** @internal */
305
- export const AccountsType$inboundSchema: z.ZodType<
306
- AccountsType,
307
- z.ZodTypeDef,
308
- unknown
309
- > = openEnums.inboundSchema(AccountsType);
310
-
311
237
  /** @internal */
312
238
  export const CompanyStatus$inboundSchema: z.ZodType<
313
239
  CompanyStatus,
@@ -329,13 +255,6 @@ export const CompanyType$inboundSchema: z.ZodType<
329
255
  unknown
330
256
  > = openEnums.inboundSchema(CompanyType);
331
257
 
332
- /** @internal */
333
- export const Jurisdiction$inboundSchema: z.ZodType<
334
- Jurisdiction,
335
- z.ZodTypeDef,
336
- unknown
337
- > = openEnums.inboundSchema(Jurisdiction);
338
-
339
258
  /** @internal */
340
259
  export const RegisteredOfficeAddress$inboundSchema: z.ZodType<
341
260
  RegisteredOfficeAddress,
@@ -373,13 +292,11 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
373
292
  accountsNextDueDate: z.nullable(
374
293
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
375
294
  ).optional(),
376
- accountsType: z.nullable(AccountsType$inboundSchema).optional(),
377
- canFile: z.boolean(),
378
295
  companyName: z.string(),
379
296
  companyNumber: z.string(),
380
- companyStatus: CompanyStatus$inboundSchema,
297
+ companyStatus: z.nullable(CompanyStatus$inboundSchema),
381
298
  companySubtype: z.nullable(CompanySubtype$inboundSchema).optional(),
382
- companyType: CompanyType$inboundSchema,
299
+ companyType: z.nullable(CompanyType$inboundSchema),
383
300
  confirmationStatementLastMadeUpToDate: z.nullable(
384
301
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
385
302
  ).optional(),
@@ -390,22 +307,16 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
390
307
  createdAt: z.string().datetime({ offset: true }).transform(v =>
391
308
  new Date(v)
392
309
  ),
393
- dissolutionDate: z.nullable(
394
- z.string().datetime({ offset: true }).transform(v => new Date(v)),
395
- ).optional(),
396
- externalRegistrationNumber: z.nullable(z.string()).optional(),
397
310
  hasCharges: z.boolean(),
398
- hasInsolvencyHistory: z.boolean(),
399
311
  incorporationDate: z.nullable(
400
312
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
401
313
  ).optional(),
402
- isOnRegisterInJurisdiction: z.nullable(z.boolean()).optional(),
403
- jurisdiction: Jurisdiction$inboundSchema,
404
- lastMembersListDate: z.nullable(
405
- z.string().datetime({ offset: true }).transform(v => new Date(v)),
406
- ).optional(),
407
314
  locationId: z.nullable(z.string()).optional(),
315
+ notInLatestRegisterSince: z.nullable(
316
+ z.string().transform(v => new RFCDate(v)),
317
+ ).optional(),
408
318
  previousNames: z.array(PreviousName$inboundSchema).optional(),
319
+ registerStatus: z.nullable(z.string()).optional(),
409
320
  registeredOfficeAddress: z.nullable(
410
321
  z.lazy(() => RegisteredOfficeAddress$inboundSchema),
411
322
  ).optional(),
@@ -5,24 +5,6 @@
5
5
  import * as z from "zod/v3";
6
6
  import { ClosedEnum } from "../../types/enums.js";
7
7
 
8
- /**
9
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
10
- */
11
- export const Jurisdictions = {
12
- EnglandWales: "england-wales",
13
- Wales: "wales",
14
- Scotland: "scotland",
15
- NorthernIreland: "northern-ireland",
16
- EuropeanUnion: "european-union",
17
- UnitedKingdom: "united-kingdom",
18
- England: "england",
19
- Noneu: "noneu",
20
- } as const;
21
- /**
22
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
23
- */
24
- export type Jurisdictions = ClosedEnum<typeof Jurisdictions>;
25
-
26
8
  /**
27
9
  * Which field orders the results: `companyName` alphabetically, `incorporationDate` by age, `updatedAt` by when the record last changed. Defaults to `companyName`.
28
10
  */
@@ -49,7 +31,7 @@ export const SortOrder = {
49
31
  export type SortOrder = ClosedEnum<typeof SortOrder>;
50
32
 
51
33
  /**
52
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
34
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from.
53
35
  */
54
36
  export const Statuses = {
55
37
  Active: "active",
@@ -64,9 +46,10 @@ export const Statuses = {
64
46
  Closed: "closed",
65
47
  Registered: "registered",
66
48
  Removed: "removed",
49
+ NotInLatestRegister: "not-in-latest-register",
67
50
  } as const;
68
51
  /**
69
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
52
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from.
70
53
  */
71
54
  export type Statuses = ClosedEnum<typeof Statuses>;
72
55
 
@@ -134,10 +117,6 @@ export type CompanyQueryRequest = {
134
117
  * Set to true for companies that have charges registered against them, false for those that have none. Leave it out to include both.
135
118
  */
136
119
  hasCharges?: boolean | undefined;
137
- /**
138
- * Set to true for companies with insolvency events on the register, false for those with none. Leave it out to include both.
139
- */
140
- hasInsolvencyHistory?: boolean | undefined;
141
120
  /**
142
121
  * The registered office address is not part of a company search result. Read the full company record from /companies/{companyNumber} to get it.
143
122
  */
@@ -158,16 +137,12 @@ export type CompanyQueryRequest = {
158
137
  * Return only companies incorporated on or before this date. Send an ISO 8601 timestamp.
159
138
  */
160
139
  incorporatedBefore?: Date | undefined;
161
- /**
162
- * Return only companies registered in one of these UK jurisdictions, such as `england-wales`, `scotland` or `northern-ireland`.
163
- */
164
- jurisdictions?: Array<Jurisdictions> | undefined;
165
140
  /**
166
141
  * Maximum number of items to return. Defaults to 25. Minimum 1, maximum 100.
167
142
  */
168
143
  limit?: number | undefined;
169
144
  /**
170
- * Identifier for a single addressable location. In Great Britain this is the Unique Property Reference Number (UPRN). Returns only companies whose registered office is at that location.
145
+ * Identifier for a single addressable location. In Great Britain this is the Unique Property Reference Number (UPRN). Returns only companies whose registered office is at that location. While registered-office locations are not available, a search with this filter returns 503.
171
146
  */
172
147
  locationId?: string | undefined;
173
148
  /**
@@ -199,7 +174,7 @@ export type CompanyQueryRequest = {
199
174
  */
200
175
  sortOrder?: SortOrder | undefined;
201
176
  /**
202
- * Return only companies whose status is one of these values, such as `active` or `dissolved`.
177
+ * Return only companies whose companyStatus is one of these values, such as `active` or `dissolved`. The values match the companyStatus each result carries, so `active` never returns a company that is `not-in-latest-register`.
203
178
  */
204
179
  statuses?: Array<Statuses> | undefined;
205
180
  /**
@@ -208,11 +183,6 @@ export type CompanyQueryRequest = {
208
183
  types?: Array<Types> | undefined;
209
184
  };
210
185
 
211
- /** @internal */
212
- export const Jurisdictions$outboundSchema: z.ZodNativeEnum<
213
- typeof Jurisdictions
214
- > = z.nativeEnum(Jurisdictions);
215
-
216
186
  /** @internal */
217
187
  export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> = z
218
188
  .nativeEnum(SortBy);
@@ -234,13 +204,11 @@ export const Types$outboundSchema: z.ZodNativeEnum<typeof Types> = z.nativeEnum(
234
204
  export type CompanyQueryRequest$Outbound = {
235
205
  companyNumber?: string | undefined;
236
206
  hasCharges?: boolean | undefined;
237
- hasInsolvencyHistory?: boolean | undefined;
238
207
  includeAddress: boolean;
239
208
  includeOfficers: boolean;
240
209
  includePscs: boolean;
241
210
  incorporatedAfter?: string | undefined;
242
211
  incorporatedBefore?: string | undefined;
243
- jurisdictions?: Array<string> | undefined;
244
212
  limit: number;
245
213
  locationId?: string | undefined;
246
214
  name?: string | undefined;
@@ -262,13 +230,11 @@ export const CompanyQueryRequest$outboundSchema: z.ZodType<
262
230
  > = z.object({
263
231
  companyNumber: z.string().optional(),
264
232
  hasCharges: z.boolean().optional(),
265
- hasInsolvencyHistory: z.boolean().optional(),
266
233
  includeAddress: z.boolean().default(true),
267
234
  includeOfficers: z.boolean().default(false),
268
235
  includePscs: z.boolean().default(false),
269
236
  incorporatedAfter: z.date().transform(v => v.toISOString()).optional(),
270
237
  incorporatedBefore: z.date().transform(v => v.toISOString()).optional(),
271
- jurisdictions: z.array(Jurisdictions$outboundSchema).optional(),
272
238
  limit: z.number().int().default(25),
273
239
  locationId: z.string().optional(),
274
240
  name: z.string().optional(),
@@ -21,6 +21,10 @@ export type CompanyResponse = {
21
21
  * Active officer appointments at this company, up to 50 of them. Present only when the request sets includeOfficers=true.
22
22
  */
23
23
  officers?: Array<OfficerSummary> | undefined;
24
+ /**
25
+ * The date of the Companies House PSC data the pscs summaries were read from, as YYYY-MM-DD. Present only when the request sets includePscs=true.
26
+ */
27
+ pscDataAsOf?: string | undefined;
24
28
  /**
25
29
  * Active PSC notifications for this company, up to 50 of them. Present only when the request sets includePscs=true.
26
30
  */
@@ -42,6 +46,7 @@ export const CompanyResponse$inboundSchema: z.ZodType<
42
46
  unknown
43
47
  > = z.object({
44
48
  officers: z.array(OfficerSummary$inboundSchema).optional(),
49
+ pscDataAsOf: z.string().optional(),
45
50
  pscs: z.array(PscSummary$inboundSchema).optional(),
46
51
  result: Company$inboundSchema,
47
52
  success: z.literal(true),