@greensecurity/javascript-sdk 0.45.0-beta.12 → 0.45.0-beta.14

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 (349) hide show
  1. package/README.md +7 -1
  2. package/dist/commonjs/__tests__/companies.test.js +17 -0
  3. package/dist/commonjs/__tests__/companies.test.js.map +1 -1
  4. package/dist/commonjs/__tests__/doAdmin.test.js +51 -0
  5. package/dist/commonjs/__tests__/doAdmin.test.js.map +1 -1
  6. package/dist/commonjs/__tests__/kiosk.test.d.ts +2 -0
  7. package/dist/commonjs/__tests__/kiosk.test.d.ts.map +1 -0
  8. package/dist/commonjs/__tests__/kiosk.test.js +123 -0
  9. package/dist/commonjs/__tests__/kiosk.test.js.map +1 -0
  10. package/dist/commonjs/__tests__/lookups.test.js +21 -0
  11. package/dist/commonjs/__tests__/lookups.test.js.map +1 -1
  12. package/dist/commonjs/__tests__/vendors.test.js +1 -1
  13. package/dist/commonjs/__tests__/webhooks.test.js +5 -6
  14. package/dist/commonjs/__tests__/webhooks.test.js.map +1 -1
  15. package/dist/commonjs/__tests__/zones.test.js +7 -26
  16. package/dist/commonjs/__tests__/zones.test.js.map +1 -1
  17. package/dist/commonjs/admin-funcs/dismissCommunication.d.ts +3 -0
  18. package/dist/commonjs/admin-funcs/dismissCommunication.d.ts.map +1 -0
  19. package/dist/commonjs/admin-funcs/dismissCommunication.js +20 -0
  20. package/dist/commonjs/admin-funcs/dismissCommunication.js.map +1 -0
  21. package/dist/commonjs/admin-funcs/doAdmin.d.ts +4 -0
  22. package/dist/commonjs/admin-funcs/doAdmin.d.ts.map +1 -1
  23. package/dist/commonjs/admin-funcs/doAdmin.js +58 -0
  24. package/dist/commonjs/admin-funcs/doAdmin.js.map +1 -1
  25. package/dist/commonjs/admin-funcs/kioskCreateEvent.d.ts +3 -0
  26. package/dist/commonjs/admin-funcs/kioskCreateEvent.d.ts.map +1 -0
  27. package/dist/commonjs/admin-funcs/kioskCreateEvent.js +11 -0
  28. package/dist/commonjs/admin-funcs/kioskCreateEvent.js.map +1 -0
  29. package/dist/commonjs/admin-funcs/kioskCreateKioskDevice.d.ts +7 -0
  30. package/dist/commonjs/admin-funcs/kioskCreateKioskDevice.d.ts.map +1 -0
  31. package/dist/commonjs/admin-funcs/kioskCreateKioskDevice.js +11 -0
  32. package/dist/commonjs/admin-funcs/kioskCreateKioskDevice.js.map +1 -0
  33. package/dist/commonjs/admin-funcs/kioskCreateZoneDevice.d.ts +3 -0
  34. package/dist/commonjs/admin-funcs/kioskCreateZoneDevice.d.ts.map +1 -0
  35. package/dist/commonjs/admin-funcs/kioskCreateZoneDevice.js +11 -0
  36. package/dist/commonjs/admin-funcs/kioskCreateZoneDevice.js.map +1 -0
  37. package/dist/commonjs/admin-funcs/kioskGetKioskDevice.d.ts +3 -0
  38. package/dist/commonjs/admin-funcs/kioskGetKioskDevice.d.ts.map +1 -0
  39. package/dist/commonjs/admin-funcs/kioskGetKioskDevice.js +11 -0
  40. package/dist/commonjs/admin-funcs/kioskGetKioskDevice.js.map +1 -0
  41. package/dist/commonjs/admin-funcs/kioskHeartbeat.d.ts +8 -0
  42. package/dist/commonjs/admin-funcs/kioskHeartbeat.d.ts.map +1 -0
  43. package/dist/commonjs/admin-funcs/kioskHeartbeat.js +11 -0
  44. package/dist/commonjs/admin-funcs/kioskHeartbeat.js.map +1 -0
  45. package/dist/commonjs/admin-funcs/kioskPing2.d.ts +4 -0
  46. package/dist/commonjs/admin-funcs/kioskPing2.d.ts.map +1 -0
  47. package/dist/commonjs/admin-funcs/kioskPing2.js +10 -0
  48. package/dist/commonjs/admin-funcs/kioskPing2.js.map +1 -0
  49. package/dist/commonjs/admin-funcs/kioskUpdateKioskDevice.d.ts +9 -0
  50. package/dist/commonjs/admin-funcs/kioskUpdateKioskDevice.d.ts.map +1 -0
  51. package/dist/commonjs/admin-funcs/kioskUpdateKioskDevice.js +10 -0
  52. package/dist/commonjs/admin-funcs/kioskUpdateKioskDevice.js.map +1 -0
  53. package/dist/commonjs/admin-funcs/listCommunications.d.ts +3 -0
  54. package/dist/commonjs/admin-funcs/listCommunications.d.ts.map +1 -0
  55. package/dist/commonjs/admin-funcs/listCommunications.js +25 -0
  56. package/dist/commonjs/admin-funcs/listCommunications.js.map +1 -0
  57. package/dist/commonjs/funcs/companiesListCompanyManagerContacts.d.ts +18 -0
  58. package/dist/commonjs/funcs/companiesListCompanyManagerContacts.d.ts.map +1 -0
  59. package/dist/commonjs/funcs/companiesListCompanyManagerContacts.js +124 -0
  60. package/dist/commonjs/funcs/companiesListCompanyManagerContacts.js.map +1 -0
  61. package/dist/commonjs/funcs/lookupsLookupPostalCode.d.ts +35 -0
  62. package/dist/commonjs/funcs/lookupsLookupPostalCode.d.ts.map +1 -0
  63. package/dist/commonjs/funcs/lookupsLookupPostalCode.js +140 -0
  64. package/dist/commonjs/funcs/lookupsLookupPostalCode.js.map +1 -0
  65. package/dist/commonjs/funcs/usersUpdateUser.d.ts +6 -0
  66. package/dist/commonjs/funcs/usersUpdateUser.d.ts.map +1 -1
  67. package/dist/commonjs/funcs/usersUpdateUser.js +6 -0
  68. package/dist/commonjs/funcs/usersUpdateUser.js.map +1 -1
  69. package/dist/commonjs/funcs/vendorsCreateVendor.d.ts +4 -0
  70. package/dist/commonjs/funcs/vendorsCreateVendor.d.ts.map +1 -1
  71. package/dist/commonjs/funcs/vendorsCreateVendor.js +4 -0
  72. package/dist/commonjs/funcs/vendorsCreateVendor.js.map +1 -1
  73. package/dist/commonjs/funcs/vendorsUpdateVendorDetails.d.ts +9 -1
  74. package/dist/commonjs/funcs/vendorsUpdateVendorDetails.d.ts.map +1 -1
  75. package/dist/commonjs/funcs/vendorsUpdateVendorDetails.js +9 -1
  76. package/dist/commonjs/funcs/vendorsUpdateVendorDetails.js.map +1 -1
  77. package/dist/commonjs/index.extras.d.ts +22 -0
  78. package/dist/commonjs/index.extras.d.ts.map +1 -1
  79. package/dist/commonjs/index.extras.js +24 -0
  80. package/dist/commonjs/index.extras.js.map +1 -1
  81. package/dist/commonjs/lib/config.d.ts +3 -3
  82. package/dist/commonjs/lib/config.js +3 -3
  83. package/dist/commonjs/models/components/companymanagercontact.d.ts +19 -0
  84. package/dist/commonjs/models/components/companymanagercontact.d.ts.map +1 -0
  85. package/dist/commonjs/models/components/companymanagercontact.js +60 -0
  86. package/dist/commonjs/models/components/companymanagercontact.js.map +1 -0
  87. package/dist/commonjs/models/components/index.d.ts +1 -0
  88. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  89. package/dist/commonjs/models/components/index.js +1 -0
  90. package/dist/commonjs/models/components/index.js.map +1 -1
  91. package/dist/commonjs/models/operations/createvendorcompany.d.ts +7 -1
  92. package/dist/commonjs/models/operations/createvendorcompany.d.ts.map +1 -1
  93. package/dist/commonjs/models/operations/createvendorcompany.js.map +1 -1
  94. package/dist/commonjs/models/operations/index.d.ts +2 -0
  95. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  96. package/dist/commonjs/models/operations/index.js +2 -0
  97. package/dist/commonjs/models/operations/index.js.map +1 -1
  98. package/dist/commonjs/models/operations/listcompanymanagercontacts.d.ts +27 -0
  99. package/dist/commonjs/models/operations/listcompanymanagercontacts.d.ts.map +1 -0
  100. package/dist/commonjs/models/operations/listcompanymanagercontacts.js +65 -0
  101. package/dist/commonjs/models/operations/listcompanymanagercontacts.js.map +1 -0
  102. package/dist/commonjs/models/operations/lookuppostalcode.d.ts +59 -0
  103. package/dist/commonjs/models/operations/lookuppostalcode.d.ts.map +1 -0
  104. package/dist/commonjs/models/operations/lookuppostalcode.js +81 -0
  105. package/dist/commonjs/models/operations/lookuppostalcode.js.map +1 -0
  106. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.core.d.ts +12 -0
  107. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.core.d.ts.map +1 -0
  108. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.core.js +39 -0
  109. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.core.js.map +1 -0
  110. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.d.ts +29 -0
  111. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.d.ts.map +1 -0
  112. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.js +69 -0
  113. package/dist/commonjs/react-query/companiesListCompanyManagerContacts.js.map +1 -0
  114. package/dist/commonjs/react-query/index.d.ts +2 -0
  115. package/dist/commonjs/react-query/index.d.ts.map +1 -1
  116. package/dist/commonjs/react-query/index.js +2 -0
  117. package/dist/commonjs/react-query/index.js.map +1 -1
  118. package/dist/commonjs/react-query/lookupsLookupPostalCode.core.d.ts +16 -0
  119. package/dist/commonjs/react-query/lookupsLookupPostalCode.core.d.ts.map +1 -0
  120. package/dist/commonjs/react-query/lookupsLookupPostalCode.core.js +43 -0
  121. package/dist/commonjs/react-query/lookupsLookupPostalCode.core.js.map +1 -0
  122. package/dist/commonjs/react-query/lookupsLookupPostalCode.d.ts +71 -0
  123. package/dist/commonjs/react-query/lookupsLookupPostalCode.d.ts.map +1 -0
  124. package/dist/commonjs/react-query/lookupsLookupPostalCode.js +95 -0
  125. package/dist/commonjs/react-query/lookupsLookupPostalCode.js.map +1 -0
  126. package/dist/commonjs/react-query/usersUpdateUser.d.ts +6 -0
  127. package/dist/commonjs/react-query/usersUpdateUser.d.ts.map +1 -1
  128. package/dist/commonjs/react-query/usersUpdateUser.js +6 -0
  129. package/dist/commonjs/react-query/usersUpdateUser.js.map +1 -1
  130. package/dist/commonjs/react-query/vendorsCreateVendor.d.ts +4 -0
  131. package/dist/commonjs/react-query/vendorsCreateVendor.d.ts.map +1 -1
  132. package/dist/commonjs/react-query/vendorsCreateVendor.js +4 -0
  133. package/dist/commonjs/react-query/vendorsCreateVendor.js.map +1 -1
  134. package/dist/commonjs/react-query/vendorsUpdateVendorDetails.d.ts +9 -1
  135. package/dist/commonjs/react-query/vendorsUpdateVendorDetails.d.ts.map +1 -1
  136. package/dist/commonjs/react-query/vendorsUpdateVendorDetails.js +9 -1
  137. package/dist/commonjs/react-query/vendorsUpdateVendorDetails.js.map +1 -1
  138. package/dist/commonjs/sdk/companies.d.ts +7 -0
  139. package/dist/commonjs/sdk/companies.d.ts.map +1 -1
  140. package/dist/commonjs/sdk/companies.js +10 -0
  141. package/dist/commonjs/sdk/companies.js.map +1 -1
  142. package/dist/commonjs/sdk/lookups.d.ts +22 -0
  143. package/dist/commonjs/sdk/lookups.d.ts.map +1 -1
  144. package/dist/commonjs/sdk/lookups.js +25 -0
  145. package/dist/commonjs/sdk/lookups.js.map +1 -1
  146. package/dist/commonjs/sdk/users.d.ts +6 -0
  147. package/dist/commonjs/sdk/users.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/users.js +6 -0
  149. package/dist/commonjs/sdk/users.js.map +1 -1
  150. package/dist/commonjs/sdk/vendors.d.ts +13 -1
  151. package/dist/commonjs/sdk/vendors.d.ts.map +1 -1
  152. package/dist/commonjs/sdk/vendors.js +13 -1
  153. package/dist/commonjs/sdk/vendors.js.map +1 -1
  154. package/dist/esm/__tests__/companies.test.js +17 -0
  155. package/dist/esm/__tests__/companies.test.js.map +1 -1
  156. package/dist/esm/__tests__/doAdmin.test.js +53 -2
  157. package/dist/esm/__tests__/doAdmin.test.js.map +1 -1
  158. package/dist/esm/__tests__/kiosk.test.d.ts +2 -0
  159. package/dist/esm/__tests__/kiosk.test.d.ts.map +1 -0
  160. package/dist/esm/__tests__/kiosk.test.js +121 -0
  161. package/dist/esm/__tests__/kiosk.test.js.map +1 -0
  162. package/dist/esm/__tests__/lookups.test.js +21 -0
  163. package/dist/esm/__tests__/lookups.test.js.map +1 -1
  164. package/dist/esm/__tests__/vendors.test.js +1 -1
  165. package/dist/esm/__tests__/webhooks.test.js +5 -6
  166. package/dist/esm/__tests__/webhooks.test.js.map +1 -1
  167. package/dist/esm/__tests__/zones.test.js +7 -26
  168. package/dist/esm/__tests__/zones.test.js.map +1 -1
  169. package/dist/esm/admin-funcs/dismissCommunication.d.ts +3 -0
  170. package/dist/esm/admin-funcs/dismissCommunication.d.ts.map +1 -0
  171. package/dist/esm/admin-funcs/dismissCommunication.js +17 -0
  172. package/dist/esm/admin-funcs/dismissCommunication.js.map +1 -0
  173. package/dist/esm/admin-funcs/doAdmin.d.ts +4 -0
  174. package/dist/esm/admin-funcs/doAdmin.d.ts.map +1 -1
  175. package/dist/esm/admin-funcs/doAdmin.js +57 -0
  176. package/dist/esm/admin-funcs/doAdmin.js.map +1 -1
  177. package/dist/esm/admin-funcs/kioskCreateEvent.d.ts +3 -0
  178. package/dist/esm/admin-funcs/kioskCreateEvent.d.ts.map +1 -0
  179. package/dist/esm/admin-funcs/kioskCreateEvent.js +8 -0
  180. package/dist/esm/admin-funcs/kioskCreateEvent.js.map +1 -0
  181. package/dist/esm/admin-funcs/kioskCreateKioskDevice.d.ts +7 -0
  182. package/dist/esm/admin-funcs/kioskCreateKioskDevice.d.ts.map +1 -0
  183. package/dist/esm/admin-funcs/kioskCreateKioskDevice.js +8 -0
  184. package/dist/esm/admin-funcs/kioskCreateKioskDevice.js.map +1 -0
  185. package/dist/esm/admin-funcs/kioskCreateZoneDevice.d.ts +3 -0
  186. package/dist/esm/admin-funcs/kioskCreateZoneDevice.d.ts.map +1 -0
  187. package/dist/esm/admin-funcs/kioskCreateZoneDevice.js +8 -0
  188. package/dist/esm/admin-funcs/kioskCreateZoneDevice.js.map +1 -0
  189. package/dist/esm/admin-funcs/kioskGetKioskDevice.d.ts +3 -0
  190. package/dist/esm/admin-funcs/kioskGetKioskDevice.d.ts.map +1 -0
  191. package/dist/esm/admin-funcs/kioskGetKioskDevice.js +8 -0
  192. package/dist/esm/admin-funcs/kioskGetKioskDevice.js.map +1 -0
  193. package/dist/esm/admin-funcs/kioskHeartbeat.d.ts +8 -0
  194. package/dist/esm/admin-funcs/kioskHeartbeat.d.ts.map +1 -0
  195. package/dist/esm/admin-funcs/kioskHeartbeat.js +8 -0
  196. package/dist/esm/admin-funcs/kioskHeartbeat.js.map +1 -0
  197. package/dist/esm/admin-funcs/kioskPing2.d.ts +4 -0
  198. package/dist/esm/admin-funcs/kioskPing2.d.ts.map +1 -0
  199. package/dist/esm/admin-funcs/kioskPing2.js +7 -0
  200. package/dist/esm/admin-funcs/kioskPing2.js.map +1 -0
  201. package/dist/esm/admin-funcs/kioskUpdateKioskDevice.d.ts +9 -0
  202. package/dist/esm/admin-funcs/kioskUpdateKioskDevice.d.ts.map +1 -0
  203. package/dist/esm/admin-funcs/kioskUpdateKioskDevice.js +7 -0
  204. package/dist/esm/admin-funcs/kioskUpdateKioskDevice.js.map +1 -0
  205. package/dist/esm/admin-funcs/listCommunications.d.ts +3 -0
  206. package/dist/esm/admin-funcs/listCommunications.d.ts.map +1 -0
  207. package/dist/esm/admin-funcs/listCommunications.js +22 -0
  208. package/dist/esm/admin-funcs/listCommunications.js.map +1 -0
  209. package/dist/esm/funcs/companiesListCompanyManagerContacts.d.ts +18 -0
  210. package/dist/esm/funcs/companiesListCompanyManagerContacts.d.ts.map +1 -0
  211. package/dist/esm/funcs/companiesListCompanyManagerContacts.js +88 -0
  212. package/dist/esm/funcs/companiesListCompanyManagerContacts.js.map +1 -0
  213. package/dist/esm/funcs/lookupsLookupPostalCode.d.ts +35 -0
  214. package/dist/esm/funcs/lookupsLookupPostalCode.d.ts.map +1 -0
  215. package/dist/esm/funcs/lookupsLookupPostalCode.js +104 -0
  216. package/dist/esm/funcs/lookupsLookupPostalCode.js.map +1 -0
  217. package/dist/esm/funcs/usersUpdateUser.d.ts +6 -0
  218. package/dist/esm/funcs/usersUpdateUser.d.ts.map +1 -1
  219. package/dist/esm/funcs/usersUpdateUser.js +6 -0
  220. package/dist/esm/funcs/usersUpdateUser.js.map +1 -1
  221. package/dist/esm/funcs/vendorsCreateVendor.d.ts +4 -0
  222. package/dist/esm/funcs/vendorsCreateVendor.d.ts.map +1 -1
  223. package/dist/esm/funcs/vendorsCreateVendor.js +4 -0
  224. package/dist/esm/funcs/vendorsCreateVendor.js.map +1 -1
  225. package/dist/esm/funcs/vendorsUpdateVendorDetails.d.ts +9 -1
  226. package/dist/esm/funcs/vendorsUpdateVendorDetails.d.ts.map +1 -1
  227. package/dist/esm/funcs/vendorsUpdateVendorDetails.js +9 -1
  228. package/dist/esm/funcs/vendorsUpdateVendorDetails.js.map +1 -1
  229. package/dist/esm/index.extras.d.ts +22 -0
  230. package/dist/esm/index.extras.d.ts.map +1 -1
  231. package/dist/esm/index.extras.js +24 -0
  232. package/dist/esm/index.extras.js.map +1 -1
  233. package/dist/esm/lib/config.d.ts +3 -3
  234. package/dist/esm/lib/config.js +3 -3
  235. package/dist/esm/models/components/companymanagercontact.d.ts +19 -0
  236. package/dist/esm/models/components/companymanagercontact.d.ts.map +1 -0
  237. package/dist/esm/models/components/companymanagercontact.js +23 -0
  238. package/dist/esm/models/components/companymanagercontact.js.map +1 -0
  239. package/dist/esm/models/components/index.d.ts +1 -0
  240. package/dist/esm/models/components/index.d.ts.map +1 -1
  241. package/dist/esm/models/components/index.js +1 -0
  242. package/dist/esm/models/components/index.js.map +1 -1
  243. package/dist/esm/models/operations/createvendorcompany.d.ts +7 -1
  244. package/dist/esm/models/operations/createvendorcompany.d.ts.map +1 -1
  245. package/dist/esm/models/operations/createvendorcompany.js.map +1 -1
  246. package/dist/esm/models/operations/index.d.ts +2 -0
  247. package/dist/esm/models/operations/index.d.ts.map +1 -1
  248. package/dist/esm/models/operations/index.js +2 -0
  249. package/dist/esm/models/operations/index.js.map +1 -1
  250. package/dist/esm/models/operations/listcompanymanagercontacts.d.ts +27 -0
  251. package/dist/esm/models/operations/listcompanymanagercontacts.d.ts.map +1 -0
  252. package/dist/esm/models/operations/listcompanymanagercontacts.js +27 -0
  253. package/dist/esm/models/operations/listcompanymanagercontacts.js.map +1 -0
  254. package/dist/esm/models/operations/lookuppostalcode.d.ts +59 -0
  255. package/dist/esm/models/operations/lookuppostalcode.d.ts.map +1 -0
  256. package/dist/esm/models/operations/lookuppostalcode.js +43 -0
  257. package/dist/esm/models/operations/lookuppostalcode.js.map +1 -0
  258. package/dist/esm/react-query/companiesListCompanyManagerContacts.core.d.ts +12 -0
  259. package/dist/esm/react-query/companiesListCompanyManagerContacts.core.d.ts.map +1 -0
  260. package/dist/esm/react-query/companiesListCompanyManagerContacts.core.js +34 -0
  261. package/dist/esm/react-query/companiesListCompanyManagerContacts.core.js.map +1 -0
  262. package/dist/esm/react-query/companiesListCompanyManagerContacts.d.ts +29 -0
  263. package/dist/esm/react-query/companiesListCompanyManagerContacts.d.ts.map +1 -0
  264. package/dist/esm/react-query/companiesListCompanyManagerContacts.js +59 -0
  265. package/dist/esm/react-query/companiesListCompanyManagerContacts.js.map +1 -0
  266. package/dist/esm/react-query/index.d.ts +2 -0
  267. package/dist/esm/react-query/index.d.ts.map +1 -1
  268. package/dist/esm/react-query/index.js +2 -0
  269. package/dist/esm/react-query/index.js.map +1 -1
  270. package/dist/esm/react-query/lookupsLookupPostalCode.core.d.ts +16 -0
  271. package/dist/esm/react-query/lookupsLookupPostalCode.core.d.ts.map +1 -0
  272. package/dist/esm/react-query/lookupsLookupPostalCode.core.js +38 -0
  273. package/dist/esm/react-query/lookupsLookupPostalCode.core.js.map +1 -0
  274. package/dist/esm/react-query/lookupsLookupPostalCode.d.ts +71 -0
  275. package/dist/esm/react-query/lookupsLookupPostalCode.d.ts.map +1 -0
  276. package/dist/esm/react-query/lookupsLookupPostalCode.js +85 -0
  277. package/dist/esm/react-query/lookupsLookupPostalCode.js.map +1 -0
  278. package/dist/esm/react-query/usersUpdateUser.d.ts +6 -0
  279. package/dist/esm/react-query/usersUpdateUser.d.ts.map +1 -1
  280. package/dist/esm/react-query/usersUpdateUser.js +6 -0
  281. package/dist/esm/react-query/usersUpdateUser.js.map +1 -1
  282. package/dist/esm/react-query/vendorsCreateVendor.d.ts +4 -0
  283. package/dist/esm/react-query/vendorsCreateVendor.d.ts.map +1 -1
  284. package/dist/esm/react-query/vendorsCreateVendor.js +4 -0
  285. package/dist/esm/react-query/vendorsCreateVendor.js.map +1 -1
  286. package/dist/esm/react-query/vendorsUpdateVendorDetails.d.ts +9 -1
  287. package/dist/esm/react-query/vendorsUpdateVendorDetails.d.ts.map +1 -1
  288. package/dist/esm/react-query/vendorsUpdateVendorDetails.js +9 -1
  289. package/dist/esm/react-query/vendorsUpdateVendorDetails.js.map +1 -1
  290. package/dist/esm/sdk/companies.d.ts +7 -0
  291. package/dist/esm/sdk/companies.d.ts.map +1 -1
  292. package/dist/esm/sdk/companies.js +10 -0
  293. package/dist/esm/sdk/companies.js.map +1 -1
  294. package/dist/esm/sdk/lookups.d.ts +22 -0
  295. package/dist/esm/sdk/lookups.d.ts.map +1 -1
  296. package/dist/esm/sdk/lookups.js +25 -0
  297. package/dist/esm/sdk/lookups.js.map +1 -1
  298. package/dist/esm/sdk/users.d.ts +6 -0
  299. package/dist/esm/sdk/users.d.ts.map +1 -1
  300. package/dist/esm/sdk/users.js +6 -0
  301. package/dist/esm/sdk/users.js.map +1 -1
  302. package/dist/esm/sdk/vendors.d.ts +13 -1
  303. package/dist/esm/sdk/vendors.d.ts.map +1 -1
  304. package/dist/esm/sdk/vendors.js +13 -1
  305. package/dist/esm/sdk/vendors.js.map +1 -1
  306. package/jsr.json +1 -1
  307. package/package.json +1 -1
  308. package/src/__tests__/companies.test.ts +20 -0
  309. package/src/__tests__/doAdmin.test.ts +74 -1
  310. package/src/__tests__/kiosk.test.ts +163 -0
  311. package/src/__tests__/lookups.test.ts +24 -0
  312. package/src/__tests__/vendors.test.ts +1 -1
  313. package/src/__tests__/webhooks.test.ts +5 -6
  314. package/src/__tests__/zones.test.ts +7 -26
  315. package/src/admin-funcs/dismissCommunication.ts +20 -0
  316. package/src/admin-funcs/doAdmin.ts +107 -0
  317. package/src/admin-funcs/kioskCreateEvent.ts +18 -0
  318. package/src/admin-funcs/kioskCreateKioskDevice.ts +17 -0
  319. package/src/admin-funcs/kioskCreateZoneDevice.ts +17 -0
  320. package/src/admin-funcs/kioskGetKioskDevice.ts +16 -0
  321. package/src/admin-funcs/kioskHeartbeat.ts +23 -0
  322. package/src/admin-funcs/kioskPing2.ts +10 -0
  323. package/src/admin-funcs/kioskUpdateKioskDevice.ts +23 -0
  324. package/src/admin-funcs/listCommunications.ts +29 -0
  325. package/src/funcs/companiesListCompanyManagerContacts.ts +182 -0
  326. package/src/funcs/lookupsLookupPostalCode.ts +193 -0
  327. package/src/funcs/usersUpdateUser.ts +6 -0
  328. package/src/funcs/vendorsCreateVendor.ts +4 -0
  329. package/src/funcs/vendorsUpdateVendorDetails.ts +9 -1
  330. package/src/index.extras.ts +27 -0
  331. package/src/lib/config.ts +3 -3
  332. package/src/models/components/companymanagercontact.ts +50 -0
  333. package/src/models/components/index.ts +1 -0
  334. package/src/models/operations/createvendorcompany.ts +7 -1
  335. package/src/models/operations/index.ts +2 -0
  336. package/src/models/operations/listcompanymanagercontacts.ts +77 -0
  337. package/src/models/operations/lookuppostalcode.ts +118 -0
  338. package/src/react-query/companiesListCompanyManagerContacts.core.ts +78 -0
  339. package/src/react-query/companiesListCompanyManagerContacts.ts +150 -0
  340. package/src/react-query/index.ts +2 -0
  341. package/src/react-query/lookupsLookupPostalCode.core.ts +82 -0
  342. package/src/react-query/lookupsLookupPostalCode.ts +177 -0
  343. package/src/react-query/usersUpdateUser.ts +6 -0
  344. package/src/react-query/vendorsCreateVendor.ts +4 -0
  345. package/src/react-query/vendorsUpdateVendorDetails.ts +9 -1
  346. package/src/sdk/companies.ts +20 -0
  347. package/src/sdk/lookups.ts +33 -0
  348. package/src/sdk/users.ts +6 -0
  349. package/src/sdk/vendors.ts +13 -1
@@ -1,10 +1,13 @@
1
- import { expect, test } from "vitest";
1
+ import { afterEach, beforeEach, expect, test, vi } from "vitest";
2
2
  import type { HookContext } from "../hooks/types.js";
3
3
  import type { RetryConfig } from "../lib/retries.js";
4
4
  import {
5
+ $doPut,
5
6
  buildDoOptions,
6
7
  matchesInternalApiErrorStatusCode,
7
8
  } from "../admin-funcs/doAdmin.js";
9
+ import { initializeInternalCoreByUrl } from "../admin-funcs/initializeCore.js";
10
+ import { ApiErrorResponse } from "../models/errors/apierrorresponse.js";
8
11
 
9
12
  const retryConfig: RetryConfig = { strategy: "none" };
10
13
  const context: HookContext = {
@@ -47,3 +50,73 @@ test("buildDoOptions includes both legacy and current error matchers", () => {
47
50
  expect(compatibleOptions.isErrorStatusCode?.(302)).toBe(false);
48
51
  expect(compatibleOptions.retryCodes).toEqual(["429", "500"]);
49
52
  });
53
+
54
+ const originalFetch = globalThis.fetch;
55
+
56
+ beforeEach(() => {
57
+ initializeInternalCoreByUrl("test-token", "https://internal.test");
58
+ });
59
+
60
+ afterEach(() => {
61
+ globalThis.fetch = originalFetch;
62
+ vi.restoreAllMocks();
63
+ });
64
+
65
+ test("$doPut sends the JSON body via PUT and returns the parsed success payload", async () => {
66
+ const fetchMock = vi.fn(async (request: Request) => {
67
+ expect(request.method).toBe("PUT");
68
+ expect(await request.json()).toEqual({ name: "updated" });
69
+ return new Response(JSON.stringify({ ok: true }), {
70
+ status: 200,
71
+ headers: { "Content-Type": "application/json" },
72
+ });
73
+ });
74
+ globalThis.fetch = fetchMock as unknown as typeof fetch;
75
+
76
+ const [result, call] = await $doPut("/kiosks/1", { name: "updated" });
77
+
78
+ expect(fetchMock).toHaveBeenCalledTimes(1);
79
+ expect(result.ok).toBe(true);
80
+ expect(result.ok && result.value).toEqual({ ok: true });
81
+ expect(call.status).toBe("complete");
82
+ });
83
+
84
+ test("$doPut surfaces a typed 4xx as an ApiErrorResponse", async () => {
85
+ globalThis.fetch = vi.fn(async () =>
86
+ new Response(JSON.stringify({ error: "not found" }), {
87
+ status: 404,
88
+ headers: { "Content-Type": "application/json" },
89
+ })
90
+ ) as unknown as typeof fetch;
91
+
92
+ const [result, call] = await $doPut("/kiosks/1", { name: "updated" });
93
+
94
+ expect(result.ok).toBe(false);
95
+ expect(!result.ok && result.error).toBeInstanceOf(ApiErrorResponse);
96
+ expect(!result.ok && (result.error as ApiErrorResponse).error).toBe(
97
+ "not found",
98
+ );
99
+ expect(call.status).toBe("complete");
100
+ });
101
+
102
+ test("$doPut surfaces a 5xx as a failed result", async () => {
103
+ globalThis.fetch = vi.fn(async () =>
104
+ new Response("internal error", { status: 500 })
105
+ ) as unknown as typeof fetch;
106
+
107
+ const [result, call] = await $doPut("/kiosks/1", { name: "updated" });
108
+
109
+ expect(result.ok).toBe(false);
110
+ expect(call.status).toBe("complete");
111
+ });
112
+
113
+ test("$doPut reports a network failure as a request-error", async () => {
114
+ globalThis.fetch = vi.fn(async () => {
115
+ throw new TypeError("fetch failed");
116
+ }) as unknown as typeof fetch;
117
+
118
+ const [result, call] = await $doPut("/kiosks/1", { name: "updated" });
119
+
120
+ expect(result.ok).toBe(false);
121
+ expect(call.status).toBe("request-error");
122
+ });
@@ -0,0 +1,163 @@
1
+ import { beforeEach, describe, expect, it, vi } from "vitest";
2
+
3
+ // The parameters are declared, rather than `vi.fn(() => ...)`, so that mock.calls is typed as the
4
+ // argument tuple rather than `[][]` — see smartBadgeGetPsks.test.ts for why that matters for tshy.
5
+ const { doGetSingleMock, doPostMock, doPutMock } = vi.hoisted(() => ({
6
+ doGetSingleMock: vi.fn((_route: string, _query: unknown, _options?: unknown) =>
7
+ Promise.resolve([{ ok: true }, { status: "complete" }])
8
+ ),
9
+ doPostMock: vi.fn((_route: string, _body: unknown, _options?: unknown) =>
10
+ Promise.resolve([{ ok: true }, { status: "complete" }])
11
+ ),
12
+ doPutMock: vi.fn((_route: string, _body: unknown, _options?: unknown) =>
13
+ Promise.resolve([{ ok: true }, { status: "complete" }])
14
+ ),
15
+ }));
16
+
17
+ vi.mock("../admin-funcs/doAdmin.js", () => ({
18
+ $doGetSingle: doGetSingleMock,
19
+ $doPost: doPostMock,
20
+ $doPut: doPutMock,
21
+ }));
22
+
23
+ import { kioskPing2 } from "../admin-funcs/kioskPing2.js";
24
+ import { kioskCreateKioskDevice } from "../admin-funcs/kioskCreateKioskDevice.js";
25
+ import { kioskGetKioskDevice } from "../admin-funcs/kioskGetKioskDevice.js";
26
+ import { kioskUpdateKioskDevice } from "../admin-funcs/kioskUpdateKioskDevice.js";
27
+ import { kioskCreateZoneDevice } from "../admin-funcs/kioskCreateZoneDevice.js";
28
+ import { kioskCreateEvent } from "../admin-funcs/kioskCreateEvent.js";
29
+ import { kioskHeartbeat } from "../admin-funcs/kioskHeartbeat.js";
30
+
31
+ beforeEach(() => {
32
+ doGetSingleMock.mockClear();
33
+ doPostMock.mockClear();
34
+ doPutMock.mockClear();
35
+ });
36
+
37
+ describe("kioskPing2", () => {
38
+ it("calls the unauthenticated liveness route with no query parameters", () => {
39
+ const request = kioskPing2();
40
+
41
+ expect(doGetSingleMock).toHaveBeenCalledWith("/kiosks/ping2", {}, undefined);
42
+ expect(request).toBeDefined();
43
+ });
44
+
45
+ // The reachability probe passes a finite timeout so a half-open request cannot hang forever;
46
+ // that only works if the option actually reaches $doGetSingle.
47
+ it("forwards request options (e.g. timeoutMs) through to $doGetSingle", () => {
48
+ kioskPing2({ timeoutMs: 2000 });
49
+
50
+ expect(doGetSingleMock).toHaveBeenLastCalledWith("/kiosks/ping2", {}, { timeoutMs: 2000 });
51
+ });
52
+ });
53
+
54
+ describe("kioskCreateKioskDevice", () => {
55
+ it("posts to the unauthenticated device-registration route with the request body", () => {
56
+ const request = kioskCreateKioskDevice({ apns_token: "abc", sandbox: true });
57
+
58
+ expect(doPostMock).toHaveBeenCalledWith("/kiosk-api/kiosk-devices", { apns_token: "abc", sandbox: true });
59
+ expect(request).toBeDefined();
60
+ });
61
+ });
62
+
63
+ describe("kioskGetKioskDevice", () => {
64
+ it("builds the device+id+token path and sends no query parameters", () => {
65
+ kioskGetKioskDevice(42, "sekret");
66
+
67
+ expect(doGetSingleMock).toHaveBeenCalledWith("/kiosk-api/42/sekret/kiosk-devices/42", {});
68
+ });
69
+
70
+ // The security token authenticates the request, so it must reach the path percent-encoded rather
71
+ // than dropped or sent as a query parameter.
72
+ it("percent-encodes the security token", () => {
73
+ kioskGetKioskDevice(42, "tok/en+with special=chars");
74
+
75
+ expect(doGetSingleMock).toHaveBeenCalledWith(
76
+ "/kiosk-api/42/tok%2Fen%2Bwith%20special%3Dchars/kiosk-devices/42",
77
+ {}
78
+ );
79
+ });
80
+ });
81
+
82
+ describe("kioskUpdateKioskDevice", () => {
83
+ it("PUTs the update body to the device+id+token path", () => {
84
+ const request = kioskUpdateKioskDevice(42, "sekret", { apns_token: "xyz" });
85
+
86
+ expect(doPutMock).toHaveBeenCalledWith("/kiosk-api/42/sekret/kiosk-devices/42", { apns_token: "xyz" });
87
+ expect(request).toBeDefined();
88
+ });
89
+
90
+ it("percent-encodes the security token", () => {
91
+ kioskUpdateKioskDevice(42, "tok en", { apns_token: "xyz" });
92
+
93
+ expect(doPutMock).toHaveBeenCalledWith("/kiosk-api/42/tok%20en/kiosk-devices/42", { apns_token: "xyz" });
94
+ });
95
+ });
96
+
97
+ describe("kioskCreateZoneDevice", () => {
98
+ it("posts the zone id in the body, not the path", () => {
99
+ kioskCreateZoneDevice(42, "sekret", 7);
100
+
101
+ expect(doPostMock).toHaveBeenCalledWith("/kiosk-api/42/sekret/zone-devices", { zone_id: 7 });
102
+ });
103
+
104
+ it("percent-encodes the security token", () => {
105
+ kioskCreateZoneDevice(42, "tok en", 7);
106
+
107
+ expect(doPostMock).toHaveBeenCalledWith("/kiosk-api/42/tok%20en/zone-devices", { zone_id: 7 });
108
+ });
109
+ });
110
+
111
+ describe("kioskCreateEvent", () => {
112
+ it("posts the event name and value to the events route", () => {
113
+ kioskCreateEvent(42, "sekret", "print_job_completed", { pages: 1 });
114
+
115
+ expect(doPostMock).toHaveBeenCalledWith("/kiosk-api/42/sekret/events", {
116
+ name: "print_job_completed",
117
+ value: { pages: 1 },
118
+ });
119
+ });
120
+
121
+ // The ObjC fire-and-forget event calls sometimes have no payload; that must survive as an
122
+ // explicit null rather than being dropped, since it is what distinguishes "no value" from
123
+ // "value omitted" server-side.
124
+ it("normalizes an undefined value to null rather than dropping the field", () => {
125
+ kioskCreateEvent(42, "sekret", "printer_error", undefined);
126
+
127
+ expect(doPostMock).toHaveBeenCalledWith("/kiosk-api/42/sekret/events", {
128
+ name: "printer_error",
129
+ value: null,
130
+ });
131
+ });
132
+
133
+ it("percent-encodes the security token", () => {
134
+ kioskCreateEvent(42, "tok en", "printer_error", null);
135
+
136
+ expect(doPostMock).toHaveBeenCalledWith("/kiosk-api/42/tok%20en/events", {
137
+ name: "printer_error",
138
+ value: null,
139
+ });
140
+ });
141
+ });
142
+
143
+ describe("kioskHeartbeat", () => {
144
+ it("sends printer status, ip and last-notification timestamp as query parameters", () => {
145
+ const query = {
146
+ printer_status: "ok",
147
+ ip: "10.0.0.5",
148
+ date_received_notification: "2026-08-27T00:00:00Z",
149
+ };
150
+
151
+ kioskHeartbeat(42, "sekret", query);
152
+
153
+ expect(doGetSingleMock).toHaveBeenCalledWith("/kiosk-api/42/sekret/ping", query);
154
+ });
155
+
156
+ it("percent-encodes the security token", () => {
157
+ const query = { printer_status: "ok", ip: "10.0.0.5", date_received_notification: "2026-08-27T00:00:00Z" };
158
+
159
+ kioskHeartbeat(42, "tok en", query);
160
+
161
+ expect(doGetSingleMock).toHaveBeenCalledWith("/kiosk-api/42/tok%20en/ping", query);
162
+ });
163
+ });
@@ -27,3 +27,27 @@ test("Lookups List Lookup Systems", async () => {
27
27
  systems: [],
28
28
  });
29
29
  });
30
+
31
+ test("Lookups Lookup Postal Code", async () => {
32
+ const testHttpClient = createTestHTTPClient("lookupPostalCode");
33
+
34
+ const greenSecurity = new GreenSecurity({
35
+ serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
36
+ httpClient: testHttpClient,
37
+ security: {
38
+ token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
39
+ },
40
+ });
41
+
42
+ const result = await greenSecurity.lookups.lookupPostalCode({
43
+ postalCode: "12383-0520",
44
+ state: "Rhode Island",
45
+ country: "Belgium",
46
+ });
47
+ expect(result).toBeDefined();
48
+ expect(result).toEqual({
49
+ status: "mismatch",
50
+ expectedStates: [],
51
+ error: "<value>",
52
+ });
53
+ });
@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
121
121
  page: 1,
122
122
  useUrlParams: false,
123
123
  },
124
- creditBalance: 6030.32,
124
+ creditBalance: 6121.86,
125
125
  });
126
126
  });
127
127
 
@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
20
20
  const testWebhookListForVendorUserResult = await greenSecurity.webhooks
21
21
  .listAllWebhookEndpoints({
22
22
  itemsPerPage: 25,
23
- desc: 0,
23
+ desc: true,
24
24
  sort: "",
25
25
  });
26
26
  expect(testWebhookListForVendorUserResult).toBeDefined();
@@ -62,11 +62,10 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
62
62
  id: 220782,
63
63
  webhookEndpointUpdate: {
64
64
  webhookUrl: "https://example.com/webhook/incoming",
65
- subscriptions: {
66
- model: "Vendor",
67
- action: "updated",
68
- expands: "vendor.company,vendor.user",
69
- },
65
+ subscriptions: [
66
+ "Vendor.updated",
67
+ "Vendor.created",
68
+ ],
70
69
  consumers: {
71
70
  systemId: 1,
72
71
  facilityId: 1,
@@ -35,37 +35,19 @@ test("Zones List Or Search Security Zones", async () => {
35
35
  useUrlParams: false,
36
36
  },
37
37
  items: [
38
+ {
39
+ facility: {},
40
+ },
38
41
  {
39
42
  facility: {
40
- contacts: {
41
- contact: null,
42
- adminContact: {
43
- status: "Inactive",
44
- department: 123,
45
- },
46
- techContact: {
47
- status: "Active",
48
- department: 123,
49
- },
50
- greenSecurityCsm: {
51
- status: "Active",
52
- department: 123,
53
- },
54
- accountManager: {
55
- status: "Deleted",
56
- department: 123,
57
- },
58
- },
43
+ contacts: null,
59
44
  vendorGuestPolicy: {
60
- enabled: false,
45
+ enabled: true,
61
46
  vendorGuestLimitAndOr: "and",
62
47
  vendorGuestRequireEmail: false,
63
48
  },
64
49
  },
65
50
  },
66
- {
67
- facility: {},
68
- },
69
51
  ],
70
52
  });
71
53
  });
@@ -82,9 +64,8 @@ test("Zones Security Zone Checkin", async () => {
82
64
  });
83
65
 
84
66
  const result = await greenSecurity.zones.securityZoneCheckin({
85
- longitude: 2457.03,
86
- latitude: 5251.67,
87
- zoneId: 67821,
67
+ qrCode: "<value>",
68
+ zoneId: 679291,
88
69
  });
89
70
  expect(result).toBeDefined();
90
71
  expect(result).toEqual({});
@@ -0,0 +1,20 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doPost, internalApiResult } from "./doAdmin.js";
3
+
4
+ // Records that the caller dismissed a communication (GSSD-7336).
5
+ //
6
+ // Internal for the same reason as listCommunications: it only means anything to our own portal.
7
+ //
8
+ // The durable half of a two-layer dismissal — the client suppresses locally straight away so a
9
+ // banner does not flash back while this is in flight, and this row is what makes the timed
10
+ // rules ("after a week", "after a month") hold on a second device. Whether a past dismissal
11
+ // still suppresses anything is decided server-side on the next list call.
12
+ //
13
+ // The server re-checks the caller's audience before writing, so dismissing a communication that
14
+ // was never aimed at you answers 404 rather than creating a row.
15
+ export function dismissCommunication(communicationId: number): internalApiResult {
16
+ return new APIPromise($doPost(
17
+ `/communications/${communicationId}/dismiss`,
18
+ {},
19
+ ));
20
+ }
@@ -308,6 +308,113 @@ export async function $doPost<T extends object>(
308
308
  return [result, { status: "complete", request: req, response }];
309
309
  }
310
310
 
311
+ export async function $doPut<T extends object>(
312
+ route: string,
313
+ putData: T,
314
+ options?: RequestOptions,
315
+ ): Promise<
316
+ [
317
+ Result<
318
+ Json,
319
+ | errors.ApiErrorResponse
320
+ | GreenSecurityError
321
+ | ResponseValidationError
322
+ | SDKValidationError
323
+ | UnexpectedClientError
324
+ | InvalidRequestError
325
+ | RequestAbortedError
326
+ | RequestTimeoutError
327
+ | ConnectionError
328
+ >,
329
+ APICall,
330
+ ]
331
+ > {
332
+ const client = getInternalCore();
333
+ if (!client) {
334
+ throw new Error("GreenSecurityCore client is not initialized.");
335
+ }
336
+
337
+ const body = encodeJSON("body", putData, { explode: true });
338
+
339
+ // Extract the path parameters from the request object
340
+ const pathParams = {}; //extractRouteParameters(route, request);
341
+
342
+ const path = pathToFunc(route)(pathParams);
343
+
344
+ const headers = new Headers(compactMap({
345
+ "Content-Type": "application/json",
346
+ Accept: "application/json",
347
+ }));
348
+
349
+ const securityInput = await extractSecurity(client._options.security);
350
+ const requestSecurity = resolveGlobalSecurity(securityInput);
351
+
352
+ const context = {
353
+ options: client._options,
354
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
355
+ operationID: "internalApiRoutes",
356
+ oAuth2Scopes: [],
357
+
358
+ resolvedSecurity: requestSecurity,
359
+
360
+ securitySource: client._options.security,
361
+ retryConfig: options?.retries
362
+ || client._options.retryConfig
363
+ || { strategy: "none" },
364
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
365
+ };
366
+
367
+ const requestRes = client._createRequest(context, {
368
+ security: requestSecurity,
369
+ method: "PUT",
370
+ baseURL: options?.serverURL,
371
+ path: path,
372
+ headers: headers,
373
+ body: body,
374
+ userAgent: client._options.userAgent,
375
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
376
+ }, options);
377
+ if (!requestRes.ok) {
378
+ return [requestRes, { status: "invalid" }];
379
+ }
380
+ const req = requestRes.value;
381
+
382
+ const doResult = await client._do(req, {
383
+ ...buildDoOptions(context, context.retryConfig, context.retryCodes),
384
+ });
385
+ if (!doResult.ok) {
386
+ return [doResult, { status: "request-error", request: req }];
387
+ }
388
+ const response = doResult.value;
389
+
390
+ const responseFields = {
391
+ HttpMeta: { Response: response, Request: req },
392
+ };
393
+
394
+ const [result] = await M.match<
395
+ Json,
396
+ | errors.ApiErrorResponse
397
+ | GreenSecurityError
398
+ | ResponseValidationError
399
+ | SDKValidationError
400
+ | UnexpectedClientError
401
+ | InvalidRequestError
402
+ | RequestAbortedError
403
+ | RequestTimeoutError
404
+ | ConnectionError
405
+ >(
406
+ M.json(200, jsonSchema),
407
+ M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
408
+ M.fail("4XX"),
409
+ M.fail("5XX"),
410
+ )(response, req, { extraFields: responseFields });
411
+ if (!result.ok) {
412
+ return [result, { status: "complete", request: req, response }];
413
+ }
414
+
415
+ return [result, { status: "complete", request: req, response }];
416
+ }
417
+
311
418
  export function hashToQueryString(hash: Record<string, any>): string {
312
419
  const params = [];
313
420
  for (const key in hash) {
@@ -0,0 +1,18 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doPost, internalApiResult } from "./doAdmin.js";
3
+
4
+ // Logs a kiosk event (print jobs, printer errors, vending requests, phone
5
+ // home profiles, ...). `value` may be any JSON value or null.
6
+ export function kioskCreateEvent(
7
+ kioskDeviceId: number,
8
+ securityToken: string,
9
+ name: string,
10
+ value: unknown,
11
+ ): internalApiResult {
12
+ return new APIPromise(
13
+ $doPost(
14
+ `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/events`,
15
+ { name, value: value ?? null },
16
+ )
17
+ );
18
+ }
@@ -0,0 +1,17 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doPost, internalApiResult } from "./doAdmin.js";
3
+
4
+ export type KioskCreateKioskDeviceRequest = {
5
+ apns_token?: string;
6
+ sandbox?: boolean;
7
+ };
8
+
9
+ // Registers a new kiosk device. Unauthenticated; the response contains the
10
+ // device id and security token used by all subsequent kiosk-api calls.
11
+ export function kioskCreateKioskDevice(
12
+ request: KioskCreateKioskDeviceRequest,
13
+ ): internalApiResult {
14
+ return new APIPromise(
15
+ $doPost(`/kiosk-api/kiosk-devices`, request)
16
+ );
17
+ }
@@ -0,0 +1,17 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doPost, internalApiResult } from "./doAdmin.js";
3
+
4
+ // Registers a zone device for the kiosk's zone. The response includes the
5
+ // zone device id and a base64 PKCS#12 AWS IoT client certificate.
6
+ export function kioskCreateZoneDevice(
7
+ kioskDeviceId: number,
8
+ securityToken: string,
9
+ zoneId: number,
10
+ ): internalApiResult {
11
+ return new APIPromise(
12
+ $doPost(
13
+ `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/zone-devices`,
14
+ { zone_id: zoneId },
15
+ )
16
+ );
17
+ }
@@ -0,0 +1,16 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doGetSingle, internalApiResult } from "./doAdmin.js";
3
+
4
+ // Fetches the kiosk device (including its kiosk/zone assignment).
5
+ // Kiosk-api routes authenticate via the device id + security token in the path.
6
+ export function kioskGetKioskDevice(
7
+ kioskDeviceId: number,
8
+ securityToken: string,
9
+ ): internalApiResult {
10
+ return new APIPromise(
11
+ $doGetSingle(
12
+ `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/kiosk-devices/${kioskDeviceId}`,
13
+ {},
14
+ )
15
+ );
16
+ }
@@ -0,0 +1,23 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doGetSingle, internalApiResult } from "./doAdmin.js";
3
+
4
+ export type KioskHeartbeatQuery = {
5
+ printer_status: string;
6
+ ip: string;
7
+ date_received_notification: string;
8
+ };
9
+
10
+ // 60-second keep-alive ping carrying printer status, local IP and the last
11
+ // APNS heartbeat timestamp.
12
+ export function kioskHeartbeat(
13
+ kioskDeviceId: number,
14
+ securityToken: string,
15
+ query: KioskHeartbeatQuery,
16
+ ): internalApiResult {
17
+ return new APIPromise(
18
+ $doGetSingle(
19
+ `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/ping`,
20
+ query,
21
+ )
22
+ );
23
+ }
@@ -0,0 +1,10 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { $doGetSingle, internalApiResult } from "./doAdmin.js";
4
+
5
+ // Unauthenticated server liveness probe used by the kiosk before setup.
6
+ export function kioskPing2(options?: RequestOptions): internalApiResult {
7
+ return new APIPromise(
8
+ $doGetSingle(`/kiosks/ping2`, {}, options)
9
+ );
10
+ }
@@ -0,0 +1,23 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doPut, internalApiResult } from "./doAdmin.js";
3
+
4
+ export type KioskUpdateKioskDeviceRequest = {
5
+ apns_token?: string;
6
+ kiosk_id?: number;
7
+ user_id?: number;
8
+ sandbox?: boolean;
9
+ } & Record<string, unknown>;
10
+
11
+ // Updates kiosk device fields (e.g. the APNS push token after registration).
12
+ export function kioskUpdateKioskDevice(
13
+ kioskDeviceId: number,
14
+ securityToken: string,
15
+ request: KioskUpdateKioskDeviceRequest,
16
+ ): internalApiResult {
17
+ return new APIPromise(
18
+ $doPut(
19
+ `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/kiosk-devices/${kioskDeviceId}`,
20
+ request,
21
+ )
22
+ );
23
+ }
@@ -0,0 +1,29 @@
1
+ import { APIPromise } from "../types/async.js";
2
+ import { $doGetSingle, hashToQueryString, internalApiResult } from "./doAdmin.js";
3
+
4
+ // The banners, pop-ups and in-app notifications aimed at the signed-in user (GSSD-7336).
5
+ //
6
+ // Internal rather than part of the public spec: "the adverts for whoever is holding this token"
7
+ // is only meaningful to our own portal, and a third-party SDK consumer has no use for it. See
8
+ // the public/app-only split in AGENTS.md.
9
+ //
10
+ // The response is already filtered and ordered by the server — audience matched per caller,
11
+ // page matched, anything still suppressed by a dismissal removed, and sorted by priority — so a
12
+ // caller renders the list as it arrives.
13
+ //
14
+ // pageKey narrows to the communications configured for one page. Omitting it returns every
15
+ // communication for the user, which is what a caller that does its own page matching wants.
16
+ export function listCommunications(
17
+ pageKey?: string | null,
18
+ itemsPerPage: number = 100,
19
+ ): internalApiResult {
20
+ const query: Record<string, string | number> = { items_per_page: itemsPerPage };
21
+ if (pageKey) {
22
+ query["page_key"] = pageKey;
23
+ }
24
+
25
+ return new APIPromise($doGetSingle(
26
+ `/communications?${hashToQueryString(query)}`,
27
+ {},
28
+ ));
29
+ }