@stoplight/elements-core 9.0.10 → 9.0.12-beta-0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (418) hide show
  1. package/.storybook/main.js +6 -0
  2. package/.storybook/manager.js +1 -0
  3. package/.storybook/preview.jsx +50 -0
  4. package/dist/LICENSE +190 -0
  5. package/dist/README.md +1 -0
  6. package/{index.esm.js → dist/index.esm.js} +64 -20
  7. package/{index.js → dist/index.js} +64 -21
  8. package/{index.mjs → dist/index.mjs} +64 -20
  9. package/dist/package.json +64 -0
  10. package/dist/styled.d.ts +5 -0
  11. package/jest.config.js +10 -0
  12. package/package.json +74 -14
  13. package/src/__fixtures__/articles/basic.md +10 -0
  14. package/src/__fixtures__/articles/kitchen-sink.md +318 -0
  15. package/src/__fixtures__/articles/long-page-heading.md +955 -0
  16. package/src/__fixtures__/articles/multiple-try-its.md +54 -0
  17. package/src/__fixtures__/articles/schema-with-refs.ts +82 -0
  18. package/src/__fixtures__/http-request.json +11 -0
  19. package/src/__fixtures__/models/model-with-no-examples.json +15 -0
  20. package/src/__fixtures__/models/model-with-one-example.json +23 -0
  21. package/src/__fixtures__/models/model-with-three-examples.json +35 -0
  22. package/src/__fixtures__/operations/application-octet-stream-post.ts +39 -0
  23. package/src/__fixtures__/operations/base64-file-upload.ts +43 -0
  24. package/src/__fixtures__/operations/big-response.ts +4690 -0
  25. package/src/__fixtures__/operations/bundled-parameter.ts +128 -0
  26. package/src/__fixtures__/operations/empty-response.ts +15 -0
  27. package/src/__fixtures__/operations/examples-request-body.ts +135 -0
  28. package/src/__fixtures__/operations/head-todos.ts +49 -0
  29. package/src/__fixtures__/operations/invalid-response-example.ts +45 -0
  30. package/src/__fixtures__/operations/multipart-formdata-post.ts +61 -0
  31. package/src/__fixtures__/operations/operation-minimal.ts +11 -0
  32. package/src/__fixtures__/operations/operation-parameters.ts +337 -0
  33. package/src/__fixtures__/operations/operation-with-examples.ts +113 -0
  34. package/src/__fixtures__/operations/operation-without-servers.ts +16 -0
  35. package/src/__fixtures__/operations/patch-todos.ts +49 -0
  36. package/src/__fixtures__/operations/put-todos.ts +862 -0
  37. package/src/__fixtures__/operations/referenced-body.ts +62 -0
  38. package/src/__fixtures__/operations/request-body-empty-schema.ts +35 -0
  39. package/src/__fixtures__/operations/request-body.ts +62 -0
  40. package/src/__fixtures__/operations/securedOperation.ts +118 -0
  41. package/src/__fixtures__/operations/security-basic.ts +24 -0
  42. package/src/__fixtures__/operations/security-bearer.ts +25 -0
  43. package/src/__fixtures__/operations/simple-get.ts +17 -0
  44. package/src/__fixtures__/operations/simple.ts +103 -0
  45. package/src/__fixtures__/operations/string-numeric-enums.ts +32 -0
  46. package/src/__fixtures__/operations/urlencoded-post-oneof.ts +81 -0
  47. package/src/__fixtures__/operations/urlencoded-post.ts +54 -0
  48. package/src/__fixtures__/operations/vendor-extensions.ts +337 -0
  49. package/src/__fixtures__/operations/with-url-variables.ts +47 -0
  50. package/src/__fixtures__/operations/x-code-samples.ts +348 -0
  51. package/src/__fixtures__/schemas/circular.ts +1906 -0
  52. package/src/__fixtures__/schemas/contact.json +293 -0
  53. package/src/__fixtures__/schemas/media-entry.json +69 -0
  54. package/src/__fixtures__/schemas/simple.json +27 -0
  55. package/src/__fixtures__/schemas/todo-full.v1.json +35 -0
  56. package/src/__fixtures__/schemas/todo-partial.v1.json +14 -0
  57. package/src/__fixtures__/schemas/user.v1.json +17 -0
  58. package/src/__fixtures__/security-schemes/index.ts +38 -0
  59. package/src/__fixtures__/services/petstore.ts +167 -0
  60. package/src/__fixtures__/services/with-unnamed-servers.ts +38 -0
  61. package/src/__fixtures__/services/with-url-variables.ts +83 -0
  62. package/src/__fixtures__/services/without-origin.ts +20 -0
  63. package/src/__fixtures__/table-of-contents/nested.ts +44 -0
  64. package/src/__fixtures__/table-of-contents/studio-template.ts +100 -0
  65. package/src/__fixtures__/table-of-contents/studio.ts +559 -0
  66. package/src/components/Docs/Article/Article.spec.tsx +38 -0
  67. package/src/components/Docs/Article/Article.stories.tsx +17 -0
  68. package/src/components/Docs/Article/index.tsx +38 -0
  69. package/src/components/Docs/Docs.stories.tsx +33 -0
  70. package/src/components/Docs/Docs.tsx +272 -0
  71. package/src/components/Docs/HttpOperation/Badges.tsx +49 -0
  72. package/src/components/Docs/HttpOperation/Body.tsx +115 -0
  73. package/src/components/Docs/HttpOperation/Callbacks.tsx +89 -0
  74. package/src/components/Docs/HttpOperation/HttpOperation.spec.tsx +787 -0
  75. package/src/components/Docs/HttpOperation/HttpOperation.stories.ts +14 -0
  76. package/src/components/Docs/HttpOperation/HttpOperation.tsx +260 -0
  77. package/src/components/Docs/HttpOperation/LazySchemaTreePreviewer.tsx +651 -0
  78. package/src/components/Docs/HttpOperation/Parameters.spec.tsx +101 -0
  79. package/src/components/Docs/HttpOperation/Parameters.tsx +118 -0
  80. package/src/components/Docs/HttpOperation/Request.tsx +152 -0
  81. package/src/components/Docs/HttpOperation/Responses.tsx +301 -0
  82. package/src/components/Docs/HttpOperation/index.ts +1 -0
  83. package/src/components/Docs/HttpService/AdditionalInfo.stories.ts +48 -0
  84. package/src/components/Docs/HttpService/AdditionalInfo.tsx +61 -0
  85. package/src/components/Docs/HttpService/ExportButton.tsx +35 -0
  86. package/src/components/Docs/HttpService/HttpService.spec.tsx +429 -0
  87. package/src/components/Docs/HttpService/HttpService.stories.ts +14 -0
  88. package/src/components/Docs/HttpService/HttpService.tsx +99 -0
  89. package/src/components/Docs/HttpService/SecuritySchemes.tsx +82 -0
  90. package/src/components/Docs/HttpService/ServerInfo.tsx +196 -0
  91. package/src/components/Docs/HttpService/index.ts +1 -0
  92. package/src/components/Docs/Model/Model.spec.tsx +241 -0
  93. package/src/components/Docs/Model/Model.stories.tsx +16 -0
  94. package/src/components/Docs/Model/Model.tsx +192 -0
  95. package/src/components/Docs/Model/index.ts +1 -0
  96. package/src/components/Docs/NodeVendorExtensions.tsx +55 -0
  97. package/src/components/Docs/Sections.tsx +54 -0
  98. package/src/components/Docs/Security/PanelContent.tsx +38 -0
  99. package/src/components/Docs/Security/index.ts +1 -0
  100. package/src/components/Docs/Skeleton.tsx +12 -0
  101. package/src/components/Docs/TwoColumnLayout.tsx +27 -0
  102. package/src/components/Docs/index.ts +1 -0
  103. package/src/components/Docs/story-helper.ts +46 -0
  104. package/src/components/Docs/story-renderer-helper.tsx +56 -0
  105. package/src/components/Layout/MobileTopNav.tsx +78 -0
  106. package/src/components/Layout/ResponsiveSidebarLayout.tsx +175 -0
  107. package/src/components/Layout/SidebarLayout.tsx +107 -0
  108. package/src/components/LinkHeading.tsx +21 -0
  109. package/src/components/LoadMore.tsx +20 -0
  110. package/src/components/Loading/Loading.tsx +9 -0
  111. package/src/components/Logo.tsx +25 -0
  112. package/src/components/MarkdownViewer/CustomComponents/CodeComponent.spec.ts +90 -0
  113. package/src/components/MarkdownViewer/CustomComponents/CodeComponent.tsx +164 -0
  114. package/src/components/MarkdownViewer/CustomComponents/Provider.tsx +20 -0
  115. package/src/components/MarkdownViewer/CustomComponents/ReactRouterLink.tsx +27 -0
  116. package/src/components/MarkdownViewer/CustomComponents/ResolvedImage.tsx +86 -0
  117. package/src/components/MarkdownViewer/CustomComponents/ScrollToHashElement.tsx +96 -0
  118. package/src/components/MarkdownViewer/MarkdownViewer.spec.tsx +170 -0
  119. package/src/components/MarkdownViewer/index.tsx +10 -0
  120. package/src/components/NonIdealState.tsx +20 -0
  121. package/src/components/PoweredByLink.tsx +30 -0
  122. package/src/components/RequestSamples/RequestSamples.stories.tsx +67 -0
  123. package/src/components/RequestSamples/RequestSamples.tsx +246 -0
  124. package/src/components/RequestSamples/__tests__/RequestSamples.test.tsx +131 -0
  125. package/src/components/RequestSamples/__tests__/__snapshots__/convertRequestToSample.spec.ts.snap +746 -0
  126. package/src/components/RequestSamples/__tests__/convertRequestToSample.spec.ts +118 -0
  127. package/src/components/RequestSamples/convertRequestToSample.ts +56 -0
  128. package/src/components/RequestSamples/extractCodeSamples.ts +50 -0
  129. package/src/components/RequestSamples/index.ts +2 -0
  130. package/src/components/RequestSamples/requestSampleConfigs.ts +182 -0
  131. package/src/components/ResponseExamples/ResponseExamples.spec.tsx +121 -0
  132. package/src/components/ResponseExamples/ResponseExamples.stories.tsx +21 -0
  133. package/src/components/ResponseExamples/ResponseExamples.tsx +79 -0
  134. package/src/components/TableOfContents/TableOfContents.spec.tsx +301 -0
  135. package/src/components/TableOfContents/TableOfContents.stories.tsx +121 -0
  136. package/src/components/TableOfContents/TableOfContents.tsx +406 -0
  137. package/src/components/TableOfContents/constants.ts +45 -0
  138. package/src/components/TableOfContents/index.ts +2 -0
  139. package/src/components/TableOfContents/types.ts +51 -0
  140. package/src/components/TableOfContents/utils.ts +84 -0
  141. package/src/components/TryIt/Auth/APIKeyAuth.tsx +19 -0
  142. package/src/components/TryIt/Auth/Auth.tsx +169 -0
  143. package/src/components/TryIt/Auth/AuthTokenInput.tsx +37 -0
  144. package/src/components/TryIt/Auth/BasicAuth.tsx +62 -0
  145. package/src/components/TryIt/Auth/BearerAuth.tsx +19 -0
  146. package/src/components/TryIt/Auth/DigestAuth.tsx +35 -0
  147. package/src/components/TryIt/Auth/OAuth2Auth.tsx +19 -0
  148. package/src/components/TryIt/Auth/authentication-utils.ts +113 -0
  149. package/src/components/TryIt/Body/BinaryBody.tsx +52 -0
  150. package/src/components/TryIt/Body/FormDataBody.tsx +145 -0
  151. package/src/components/TryIt/Body/RequestBody.tsx +71 -0
  152. package/src/components/TryIt/Body/__tests__/BinaryBody.test.tsx +29 -0
  153. package/src/components/TryIt/Body/__tests__/FormDataBody.test.tsx +94 -0
  154. package/src/components/TryIt/Body/request-body-utils.ts +127 -0
  155. package/src/components/TryIt/Body/useTextRequestBodyState.ts +27 -0
  156. package/src/components/TryIt/Mocking/MockingButton.tsx +98 -0
  157. package/src/components/TryIt/Mocking/mocking-utils.ts +56 -0
  158. package/src/components/TryIt/Mocking/useMockingOptions.ts +6 -0
  159. package/src/components/TryIt/Parameters/FileUploadParameterEditors.tsx +62 -0
  160. package/src/components/TryIt/Parameters/OperationParameters.tsx +39 -0
  161. package/src/components/TryIt/Parameters/ParameterEditor.tsx +118 -0
  162. package/src/components/TryIt/Parameters/__tests__/parameter-utils.spec.ts +60 -0
  163. package/src/components/TryIt/Parameters/parameter-utils.spec.ts +118 -0
  164. package/src/components/TryIt/Parameters/parameter-utils.ts +179 -0
  165. package/src/components/TryIt/Parameters/useOperationParameters.ts +60 -0
  166. package/src/components/TryIt/Response/ReponseCodeViewer.tsx +28 -0
  167. package/src/components/TryIt/Response/Response.spec.tsx +174 -0
  168. package/src/components/TryIt/Response/Response.tsx +172 -0
  169. package/src/components/TryIt/Response/hooks/useLineCount.ts +7 -0
  170. package/src/components/TryIt/Servers/ServerVariables.tsx +33 -0
  171. package/src/components/TryIt/Servers/ServersDropdown.tsx +53 -0
  172. package/src/components/TryIt/Servers/VariableEditor.tsx +51 -0
  173. package/src/components/TryIt/Servers/useServerVariables.ts +19 -0
  174. package/src/components/TryIt/TryIt.spec.tsx +1511 -0
  175. package/src/components/TryIt/TryIt.stories.tsx +77 -0
  176. package/src/components/TryIt/TryIt.tsx +384 -0
  177. package/src/components/TryIt/TryItWithRequestSamples.spec.tsx +143 -0
  178. package/src/components/TryIt/TryItWithRequestSamples.stories.tsx +32 -0
  179. package/src/components/TryIt/TryItWithRequestSamples.tsx +42 -0
  180. package/src/components/TryIt/build-request.spec.ts +213 -0
  181. package/src/components/TryIt/build-request.ts +357 -0
  182. package/src/components/TryIt/chosenServer.ts +5 -0
  183. package/src/components/TryIt/index.ts +3 -0
  184. package/src/components/__tests__/LinkHeading.spec.tsx +125 -0
  185. package/src/constants.ts +176 -0
  186. package/src/containers/MockingProvider.tsx +23 -0
  187. package/src/context/InlineRefResolver.spec.tsx +183 -0
  188. package/src/context/InlineRefResolver.tsx +94 -0
  189. package/src/context/Options.tsx +27 -0
  190. package/src/context/Persistence.tsx +24 -0
  191. package/src/context/RouterType.tsx +9 -0
  192. package/src/core.css +97 -0
  193. package/src/hoc/utils.ts +5 -0
  194. package/src/hoc/withMosaicProvider.spec.tsx +48 -0
  195. package/src/hoc/withMosaicProvider.tsx +28 -0
  196. package/src/hoc/withQueryClientProvider.spec.tsx +38 -0
  197. package/src/hoc/withQueryClientProvider.tsx +35 -0
  198. package/src/hoc/withRouter.tsx +71 -0
  199. package/src/hooks/useBundleRefsIntoDocument.ts +60 -0
  200. package/src/hooks/useFirstRender.ts +8 -0
  201. package/src/hooks/useIsCompact.ts +26 -0
  202. package/src/hooks/useParsedData.ts +99 -0
  203. package/src/hooks/useParsedValue.ts +19 -0
  204. package/src/hooks/useResponsiveLayout.tsx +51 -0
  205. package/src/hooks/useRouter.tsx +31 -0
  206. package/src/hooks/useUniqueId.ts +4 -0
  207. package/src/index.ts +48 -0
  208. package/src/styled.tsx +22 -0
  209. package/src/styles.css +4 -0
  210. package/src/types.ts +170 -0
  211. package/src/utils/__tests__/securitySchemes.spec.ts +137 -0
  212. package/src/utils/exampleGeneration/exampleGeneration.spec.tsx +18 -0
  213. package/src/utils/exampleGeneration/exampleGeneration.ts +110 -0
  214. package/src/utils/fileToBase64.ts +11 -0
  215. package/src/utils/guards.ts +48 -0
  216. package/src/utils/headers.ts +316 -0
  217. package/src/utils/http-spec/IServer.ts +100 -0
  218. package/src/utils/http-spec/__tests__/IServer.spec.ts +51 -0
  219. package/src/utils/http-spec/examples.ts +5 -0
  220. package/src/utils/http.ts +9 -0
  221. package/src/utils/jotai/persistAtom.ts +31 -0
  222. package/src/utils/node.ts +19 -0
  223. package/src/utils/oas/__tests__/security.spec.ts +18 -0
  224. package/src/utils/oas/security.ts +76 -0
  225. package/src/utils/ref-resolving/ReferenceResolver.ts +29 -0
  226. package/src/utils/ref-resolving/resolvedObject.test.ts +415 -0
  227. package/src/utils/ref-resolving/resolvedObject.ts +109 -0
  228. package/src/utils/securitySchemes.ts +117 -0
  229. package/src/utils/string.ts +15 -0
  230. package/src/utils/tests/chooseOption.ts +7 -0
  231. package/src/web-components/createElementClass.ts +154 -0
  232. package/tsconfig.build.json +14 -0
  233. package/tsconfig.json +7 -0
  234. package/styled.d.ts +0 -12
  235. /package/{__fixtures__ → dist/__fixtures__}/articles/schema-with-refs.d.ts +0 -0
  236. /package/{__fixtures__ → dist/__fixtures__}/operations/application-octet-stream-post.d.ts +0 -0
  237. /package/{__fixtures__ → dist/__fixtures__}/operations/base64-file-upload.d.ts +0 -0
  238. /package/{__fixtures__ → dist/__fixtures__}/operations/big-response.d.ts +0 -0
  239. /package/{__fixtures__ → dist/__fixtures__}/operations/examples-request-body.d.ts +0 -0
  240. /package/{__fixtures__ → dist/__fixtures__}/operations/head-todos.d.ts +0 -0
  241. /package/{__fixtures__ → dist/__fixtures__}/operations/multipart-formdata-post.d.ts +0 -0
  242. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-minimal.d.ts +0 -0
  243. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-parameters.d.ts +0 -0
  244. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-with-examples.d.ts +0 -0
  245. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-without-servers.d.ts +0 -0
  246. /package/{__fixtures__ → dist/__fixtures__}/operations/patch-todos.d.ts +0 -0
  247. /package/{__fixtures__ → dist/__fixtures__}/operations/put-todos.d.ts +0 -0
  248. /package/{__fixtures__ → dist/__fixtures__}/operations/referenced-body.d.ts +0 -0
  249. /package/{__fixtures__ → dist/__fixtures__}/operations/request-body-empty-schema.d.ts +0 -0
  250. /package/{__fixtures__ → dist/__fixtures__}/operations/request-body.d.ts +0 -0
  251. /package/{__fixtures__ → dist/__fixtures__}/operations/securedOperation.d.ts +0 -0
  252. /package/{__fixtures__ → dist/__fixtures__}/operations/security-basic.d.ts +0 -0
  253. /package/{__fixtures__ → dist/__fixtures__}/operations/security-bearer.d.ts +0 -0
  254. /package/{__fixtures__ → dist/__fixtures__}/operations/simple-get.d.ts +0 -0
  255. /package/{__fixtures__ → dist/__fixtures__}/operations/string-numeric-enums.d.ts +0 -0
  256. /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post-oneof.d.ts +0 -0
  257. /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post.d.ts +0 -0
  258. /package/{__fixtures__ → dist/__fixtures__}/operations/with-url-variables.d.ts +0 -0
  259. /package/{__fixtures__ → dist/__fixtures__}/security-schemes/index.d.ts +0 -0
  260. /package/{__fixtures__ → dist/__fixtures__}/services/petstore.d.ts +0 -0
  261. /package/{__fixtures__ → dist/__fixtures__}/services/with-unnamed-servers.d.ts +0 -0
  262. /package/{__fixtures__ → dist/__fixtures__}/services/with-url-variables.d.ts +0 -0
  263. /package/{__fixtures__ → dist/__fixtures__}/services/without-origin.d.ts +0 -0
  264. /package/{components → dist/components}/Docs/Article/Article.spec.d.ts +0 -0
  265. /package/{components → dist/components}/Docs/Article/Article.stories.d.ts +0 -0
  266. /package/{components → dist/components}/Docs/Article/index.d.ts +0 -0
  267. /package/{components → dist/components}/Docs/Docs.d.ts +0 -0
  268. /package/{components → dist/components}/Docs/Docs.stories.d.ts +0 -0
  269. /package/{components → dist/components}/Docs/HttpOperation/Badges.d.ts +0 -0
  270. /package/{components → dist/components}/Docs/HttpOperation/Body.d.ts +0 -0
  271. /package/{components → dist/components}/Docs/HttpOperation/Callbacks.d.ts +0 -0
  272. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.d.ts +0 -0
  273. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.spec.d.ts +0 -0
  274. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.stories.d.ts +0 -0
  275. /package/{components → dist/components}/Docs/HttpOperation/LazySchemaTreePreviewer.d.ts +0 -0
  276. /package/{components → dist/components}/Docs/HttpOperation/Parameters.d.ts +0 -0
  277. /package/{components → dist/components}/Docs/HttpOperation/Parameters.spec.d.ts +0 -0
  278. /package/{components → dist/components}/Docs/HttpOperation/Request.d.ts +0 -0
  279. /package/{components → dist/components}/Docs/HttpOperation/Responses.d.ts +0 -0
  280. /package/{components → dist/components}/Docs/HttpOperation/index.d.ts +0 -0
  281. /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.d.ts +0 -0
  282. /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.stories.d.ts +0 -0
  283. /package/{components → dist/components}/Docs/HttpService/ExportButton.d.ts +0 -0
  284. /package/{components → dist/components}/Docs/HttpService/HttpService.d.ts +0 -0
  285. /package/{components → dist/components}/Docs/HttpService/HttpService.spec.d.ts +0 -0
  286. /package/{components → dist/components}/Docs/HttpService/HttpService.stories.d.ts +0 -0
  287. /package/{components → dist/components}/Docs/HttpService/SecuritySchemes.d.ts +0 -0
  288. /package/{components → dist/components}/Docs/HttpService/ServerInfo.d.ts +0 -0
  289. /package/{components → dist/components}/Docs/HttpService/index.d.ts +0 -0
  290. /package/{components → dist/components}/Docs/Model/Model.d.ts +0 -0
  291. /package/{components → dist/components}/Docs/Model/Model.spec.d.ts +0 -0
  292. /package/{components → dist/components}/Docs/Model/Model.stories.d.ts +0 -0
  293. /package/{components → dist/components}/Docs/Model/index.d.ts +0 -0
  294. /package/{components → dist/components}/Docs/NodeVendorExtensions.d.ts +0 -0
  295. /package/{components → dist/components}/Docs/Sections.d.ts +0 -0
  296. /package/{components → dist/components}/Docs/Security/PanelContent.d.ts +0 -0
  297. /package/{components → dist/components}/Docs/Security/index.d.ts +0 -0
  298. /package/{components → dist/components}/Docs/Skeleton.d.ts +0 -0
  299. /package/{components → dist/components}/Docs/TwoColumnLayout.d.ts +0 -0
  300. /package/{components → dist/components}/Docs/index.d.ts +0 -0
  301. /package/{components → dist/components}/Docs/story-helper.d.ts +0 -0
  302. /package/{components → dist/components}/Docs/story-renderer-helper.d.ts +0 -0
  303. /package/{components → dist/components}/Layout/MobileTopNav.d.ts +0 -0
  304. /package/{components → dist/components}/Layout/ResponsiveSidebarLayout.d.ts +0 -0
  305. /package/{components → dist/components}/Layout/SidebarLayout.d.ts +0 -0
  306. /package/{components → dist/components}/LinkHeading.d.ts +0 -0
  307. /package/{components → dist/components}/LoadMore.d.ts +0 -0
  308. /package/{components → dist/components}/Loading/Loading.d.ts +0 -0
  309. /package/{components → dist/components}/Logo.d.ts +0 -0
  310. /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.d.ts +0 -0
  311. /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.spec.d.ts +0 -0
  312. /package/{components → dist/components}/MarkdownViewer/CustomComponents/Provider.d.ts +0 -0
  313. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ReactRouterLink.d.ts +0 -0
  314. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ResolvedImage.d.ts +0 -0
  315. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ScrollToHashElement.d.ts +0 -0
  316. /package/{components → dist/components}/MarkdownViewer/MarkdownViewer.spec.d.ts +0 -0
  317. /package/{components → dist/components}/MarkdownViewer/index.d.ts +0 -0
  318. /package/{components → dist/components}/NonIdealState.d.ts +0 -0
  319. /package/{components → dist/components}/PoweredByLink.d.ts +0 -0
  320. /package/{components → dist/components}/RequestSamples/RequestSamples.d.ts +0 -0
  321. /package/{components → dist/components}/RequestSamples/RequestSamples.stories.d.ts +0 -0
  322. /package/{components → dist/components}/RequestSamples/convertRequestToSample.d.ts +0 -0
  323. /package/{components → dist/components}/RequestSamples/extractCodeSamples.d.ts +0 -0
  324. /package/{components → dist/components}/RequestSamples/index.d.ts +0 -0
  325. /package/{components → dist/components}/RequestSamples/requestSampleConfigs.d.ts +0 -0
  326. /package/{components → dist/components}/ResponseExamples/ResponseExamples.d.ts +0 -0
  327. /package/{components → dist/components}/ResponseExamples/ResponseExamples.spec.d.ts +0 -0
  328. /package/{components → dist/components}/ResponseExamples/ResponseExamples.stories.d.ts +0 -0
  329. /package/{components → dist/components}/TableOfContents/TableOfContents.d.ts +0 -0
  330. /package/{components → dist/components}/TableOfContents/TableOfContents.spec.d.ts +0 -0
  331. /package/{components → dist/components}/TableOfContents/TableOfContents.stories.d.ts +0 -0
  332. /package/{components → dist/components}/TableOfContents/constants.d.ts +0 -0
  333. /package/{components → dist/components}/TableOfContents/index.d.ts +0 -0
  334. /package/{components → dist/components}/TableOfContents/types.d.ts +0 -0
  335. /package/{components → dist/components}/TableOfContents/utils.d.ts +0 -0
  336. /package/{components → dist/components}/TryIt/Auth/APIKeyAuth.d.ts +0 -0
  337. /package/{components → dist/components}/TryIt/Auth/Auth.d.ts +0 -0
  338. /package/{components → dist/components}/TryIt/Auth/AuthTokenInput.d.ts +0 -0
  339. /package/{components → dist/components}/TryIt/Auth/BasicAuth.d.ts +0 -0
  340. /package/{components → dist/components}/TryIt/Auth/BearerAuth.d.ts +0 -0
  341. /package/{components → dist/components}/TryIt/Auth/DigestAuth.d.ts +0 -0
  342. /package/{components → dist/components}/TryIt/Auth/OAuth2Auth.d.ts +0 -0
  343. /package/{components → dist/components}/TryIt/Auth/authentication-utils.d.ts +0 -0
  344. /package/{components → dist/components}/TryIt/Body/BinaryBody.d.ts +0 -0
  345. /package/{components → dist/components}/TryIt/Body/FormDataBody.d.ts +0 -0
  346. /package/{components → dist/components}/TryIt/Body/RequestBody.d.ts +0 -0
  347. /package/{components → dist/components}/TryIt/Body/request-body-utils.d.ts +0 -0
  348. /package/{components → dist/components}/TryIt/Body/useTextRequestBodyState.d.ts +0 -0
  349. /package/{components → dist/components}/TryIt/Mocking/MockingButton.d.ts +0 -0
  350. /package/{components → dist/components}/TryIt/Mocking/mocking-utils.d.ts +0 -0
  351. /package/{components → dist/components}/TryIt/Mocking/useMockingOptions.d.ts +0 -0
  352. /package/{components → dist/components}/TryIt/Parameters/FileUploadParameterEditors.d.ts +0 -0
  353. /package/{components → dist/components}/TryIt/Parameters/OperationParameters.d.ts +0 -0
  354. /package/{components → dist/components}/TryIt/Parameters/ParameterEditor.d.ts +0 -0
  355. /package/{components → dist/components}/TryIt/Parameters/parameter-utils.d.ts +0 -0
  356. /package/{components → dist/components}/TryIt/Parameters/parameter-utils.spec.d.ts +0 -0
  357. /package/{components → dist/components}/TryIt/Parameters/useOperationParameters.d.ts +0 -0
  358. /package/{components → dist/components}/TryIt/Response/ReponseCodeViewer.d.ts +0 -0
  359. /package/{components → dist/components}/TryIt/Response/Response.d.ts +0 -0
  360. /package/{components → dist/components}/TryIt/Response/Response.spec.d.ts +0 -0
  361. /package/{components → dist/components}/TryIt/Response/hooks/useLineCount.d.ts +0 -0
  362. /package/{components → dist/components}/TryIt/Servers/ServerVariables.d.ts +0 -0
  363. /package/{components → dist/components}/TryIt/Servers/ServersDropdown.d.ts +0 -0
  364. /package/{components → dist/components}/TryIt/Servers/VariableEditor.d.ts +0 -0
  365. /package/{components → dist/components}/TryIt/Servers/useServerVariables.d.ts +0 -0
  366. /package/{components → dist/components}/TryIt/TryIt.d.ts +0 -0
  367. /package/{components → dist/components}/TryIt/TryIt.spec.d.ts +0 -0
  368. /package/{components → dist/components}/TryIt/TryIt.stories.d.ts +0 -0
  369. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.d.ts +0 -0
  370. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.spec.d.ts +0 -0
  371. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.stories.d.ts +0 -0
  372. /package/{components → dist/components}/TryIt/build-request.d.ts +0 -0
  373. /package/{components → dist/components}/TryIt/build-request.spec.d.ts +0 -0
  374. /package/{components → dist/components}/TryIt/chosenServer.d.ts +0 -0
  375. /package/{components → dist/components}/TryIt/index.d.ts +0 -0
  376. /package/{constants.d.ts → dist/constants.d.ts} +0 -0
  377. /package/{containers → dist/containers}/MockingProvider.d.ts +0 -0
  378. /package/{context → dist/context}/InlineRefResolver.d.ts +0 -0
  379. /package/{context → dist/context}/InlineRefResolver.spec.d.ts +0 -0
  380. /package/{context → dist/context}/Options.d.ts +0 -0
  381. /package/{context → dist/context}/Persistence.d.ts +0 -0
  382. /package/{context → dist/context}/RouterType.d.ts +0 -0
  383. /package/{core.css → dist/core.css} +0 -0
  384. /package/{hoc → dist/hoc}/utils.d.ts +0 -0
  385. /package/{hoc → dist/hoc}/withMosaicProvider.d.ts +0 -0
  386. /package/{hoc → dist/hoc}/withMosaicProvider.spec.d.ts +0 -0
  387. /package/{hoc → dist/hoc}/withQueryClientProvider.d.ts +0 -0
  388. /package/{hoc → dist/hoc}/withQueryClientProvider.spec.d.ts +0 -0
  389. /package/{hoc → dist/hoc}/withRouter.d.ts +0 -0
  390. /package/{hooks → dist/hooks}/useBundleRefsIntoDocument.d.ts +0 -0
  391. /package/{hooks → dist/hooks}/useFirstRender.d.ts +0 -0
  392. /package/{hooks → dist/hooks}/useIsCompact.d.ts +0 -0
  393. /package/{hooks → dist/hooks}/useParsedData.d.ts +0 -0
  394. /package/{hooks → dist/hooks}/useParsedValue.d.ts +0 -0
  395. /package/{hooks → dist/hooks}/useResponsiveLayout.d.ts +0 -0
  396. /package/{hooks → dist/hooks}/useRouter.d.ts +0 -0
  397. /package/{hooks → dist/hooks}/useUniqueId.d.ts +0 -0
  398. /package/{index.d.ts → dist/index.d.ts} +0 -0
  399. /package/{styles.min.css → dist/styles.min.css} +0 -0
  400. /package/{types.d.ts → dist/types.d.ts} +0 -0
  401. /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.d.ts +0 -0
  402. /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.spec.d.ts +0 -0
  403. /package/{utils → dist/utils}/fileToBase64.d.ts +0 -0
  404. /package/{utils → dist/utils}/guards.d.ts +0 -0
  405. /package/{utils → dist/utils}/headers.d.ts +0 -0
  406. /package/{utils → dist/utils}/http-spec/IServer.d.ts +0 -0
  407. /package/{utils → dist/utils}/http-spec/examples.d.ts +0 -0
  408. /package/{utils → dist/utils}/http.d.ts +0 -0
  409. /package/{utils → dist/utils}/jotai/persistAtom.d.ts +0 -0
  410. /package/{utils → dist/utils}/node.d.ts +0 -0
  411. /package/{utils → dist/utils}/oas/security.d.ts +0 -0
  412. /package/{utils → dist/utils}/ref-resolving/ReferenceResolver.d.ts +0 -0
  413. /package/{utils → dist/utils}/ref-resolving/resolvedObject.d.ts +0 -0
  414. /package/{utils → dist/utils}/ref-resolving/resolvedObject.test.d.ts +0 -0
  415. /package/{utils → dist/utils}/securitySchemes.d.ts +0 -0
  416. /package/{utils → dist/utils}/string.d.ts +0 -0
  417. /package/{utils → dist/utils}/tests/chooseOption.d.ts +0 -0
  418. /package/{web-components → dist/web-components}/createElementClass.d.ts +0 -0
@@ -0,0 +1,1906 @@
1
+ export default {
2
+ type: 'object',
3
+ properties: {
4
+ $ref: '#/definitions/UninterpretedOption',
5
+ },
6
+ definitions: {
7
+ TenantProcessRule: {
8
+ type: 'object',
9
+ properties: {
10
+ applications: { type: 'array', items: { $ref: '#/definitions/ApplicationProcessRule' } },
11
+ tenant_id: { type: 'string' },
12
+ },
13
+ },
14
+ Recipe: {
15
+ type: 'object',
16
+ properties: {
17
+ actionParams: { type: 'object', additionalProperties: { type: 'string' } },
18
+ actionTemplateId: { type: 'string' },
19
+ active: { type: 'boolean' },
20
+ categoryId: { type: 'string' },
21
+ createdAt: { type: 'string', format: 'date-time' },
22
+ id: { type: 'string' },
23
+ modifiedAt: { type: 'string', format: 'date-time' },
24
+ ruleIds: { type: 'array', items: { type: 'string' } },
25
+ scope: { type: 'string', enum: ['TENANT', 'USER'] },
26
+ tenantId: { type: 'string' },
27
+ title: { type: 'string' },
28
+ triggerParams: { type: 'object', additionalProperties: { type: 'string' } },
29
+ triggerTemplateId: { type: 'string' },
30
+ userId: { type: 'string' },
31
+ },
32
+ },
33
+ Customer: {
34
+ type: 'object',
35
+ required: ['identifier', 'type'],
36
+ properties: {
37
+ partners: { type: 'array', items: { $ref: '#/definitions/Partner' } },
38
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
39
+ status: { type: 'string', enum: ['ACTIVE', 'SUSPENDED'] },
40
+ zones: { type: 'array', items: { $ref: '#/definitions/Zone' } },
41
+ identifier: { type: 'string', description: 'identifier' },
42
+ type: { type: 'string', description: 'type' },
43
+ name: { type: 'string', description: 'name' },
44
+ },
45
+ description: 'Base Metadata Object Type',
46
+ },
47
+ ServiceOptions: {
48
+ type: 'object',
49
+ properties: {
50
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
51
+ defaultInstanceForType: { $ref: '#/definitions/ServiceOptions' },
52
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
53
+ initializationErrorString: { type: 'string' },
54
+ initialized: { type: 'boolean' },
55
+ parserForType: { $ref: '#/definitions/Parser«ServiceOptions»' },
56
+ serializedSize: { type: 'integer', format: 'int32' },
57
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
58
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
59
+ uninterpretedOptionOrBuilderList: {
60
+ type: 'array',
61
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
62
+ },
63
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
64
+ },
65
+ },
66
+ StateResult: {
67
+ type: 'object',
68
+ properties: {
69
+ assetState: { type: 'string' },
70
+ regionId: { type: 'string' },
71
+ regionName: { type: 'string' },
72
+ stateDwellTime: { type: 'integer', format: 'int64' },
73
+ stateEntry: { type: 'string', format: 'date-time' },
74
+ stateExit: { type: 'string', format: 'date-time' },
75
+ streamId: { type: 'string' },
76
+ },
77
+ },
78
+ ByteString: {
79
+ type: 'object',
80
+ properties: { empty: { type: 'boolean' }, validUtf8: { type: 'boolean' } },
81
+ },
82
+ 'Parser«NamePart»': { type: 'object' },
83
+ UninterpretedOption: {
84
+ type: 'object',
85
+ properties: {
86
+ aggregateValue: { type: 'string' },
87
+ aggregateValueBytes: { $ref: '#/definitions/ByteString' },
88
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
89
+ defaultInstanceForType: { $ref: '#/definitions/UninterpretedOption' },
90
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
91
+ doubleValue: { type: 'number', format: 'double' },
92
+ identifierValue: { type: 'string' },
93
+ identifierValueBytes: { $ref: '#/definitions/ByteString' },
94
+ initializationErrorString: { type: 'string' },
95
+ initialized: { type: 'boolean' },
96
+ nameCount: { type: 'integer', format: 'int32' },
97
+ nameList: { type: 'array', items: { $ref: '#/definitions/NamePart' } },
98
+ nameOrBuilderList: { type: 'array', items: { $ref: '#/definitions/NamePartOrBuilder' } },
99
+ negativeIntValue: { type: 'integer', format: 'int64' },
100
+ parserForType: { $ref: '#/definitions/Parser«UninterpretedOption»' },
101
+ positiveIntValue: { type: 'integer', format: 'int64' },
102
+ serializedSize: { type: 'integer', format: 'int32' },
103
+ stringValue: { $ref: '#/definitions/ByteString' },
104
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
105
+ },
106
+ },
107
+ DemoTasks: {
108
+ type: 'object',
109
+ properties: { peripheralId: { type: 'string' }, status: { type: 'string', enum: ['ON', 'OFF'] } },
110
+ },
111
+ MethodOptions: {
112
+ type: 'object',
113
+ properties: {
114
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
115
+ defaultInstanceForType: { $ref: '#/definitions/MethodOptions' },
116
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
117
+ initializationErrorString: { type: 'string' },
118
+ initialized: { type: 'boolean' },
119
+ parserForType: { $ref: '#/definitions/Parser«MethodOptions»' },
120
+ serializedSize: { type: 'integer', format: 'int32' },
121
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
122
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
123
+ uninterpretedOptionOrBuilderList: {
124
+ type: 'array',
125
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
126
+ },
127
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
128
+ },
129
+ },
130
+ EventData: {
131
+ type: 'object',
132
+ properties: { name: { type: 'string' }, type: { type: 'string' }, value: { type: 'string' } },
133
+ },
134
+ PeripheralMeta: {
135
+ type: 'object',
136
+ required: ['identifier'],
137
+ properties: {
138
+ mobilityState: { type: 'string', enum: ['FIXED', 'MOBILE', 'FENCED'] },
139
+ services: {
140
+ type: 'array',
141
+ description: 'Service metadata list',
142
+ items: { $ref: '#/definitions/ServiceMeta' },
143
+ },
144
+ tasks: {
145
+ type: 'object',
146
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/Command' } },
147
+ },
148
+ identifier: { type: 'string', description: 'identifier' },
149
+ type: { type: 'string', description: 'type' },
150
+ idPath: {
151
+ description: 'ID/ extraction command for peripheral Command Meta Info',
152
+ $ref: '#/definitions/IdCommand',
153
+ },
154
+ name: { type: 'string', description: 'name' },
155
+ },
156
+ description:
157
+ 'Peripheral Metadata Object - I/O object used to describe the metadata of a peripheral, its services, characteristics, and the tasks to be performed by CloudLeaf readers to access data on the peripheral',
158
+ },
159
+ TaggedAssetAssignment: {
160
+ type: 'object',
161
+ properties: {
162
+ assetId: { type: 'string' },
163
+ assetName: { type: 'string' },
164
+ id: { type: 'string' },
165
+ lastSeen: { type: 'string', format: 'date-time' },
166
+ status: { type: 'string' },
167
+ tag_id: { type: 'string' },
168
+ updatedDt: { type: 'string', format: 'date-time' },
169
+ },
170
+ },
171
+ Asset: {
172
+ type: 'object',
173
+ properties: {
174
+ category: { type: 'string' },
175
+ categoryName: { type: 'string' },
176
+ createdAt: { type: 'string', format: 'date-time' },
177
+ description: { type: 'string' },
178
+ externalId: { type: 'string' },
179
+ id: { type: 'string' },
180
+ imageURL: { type: 'string' },
181
+ modifiedAt: { type: 'string', format: 'date-time' },
182
+ name: { type: 'string' },
183
+ payload: { type: 'array', items: { type: 'string' } },
184
+ payloadOf: { type: 'string' },
185
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
186
+ sortOrder: { type: 'integer', format: 'int32' },
187
+ status: { type: 'string', enum: ['UNMONITORED', 'MONITORED', 'ARCHIVED'] },
188
+ tenantId: { type: 'string' },
189
+ },
190
+ },
191
+ StreamResultValue: {
192
+ type: 'object',
193
+ properties: {
194
+ areaName: { type: 'object' },
195
+ receiverId: { type: 'object' },
196
+ time: { type: 'string', format: 'date-time' },
197
+ value: { type: 'object' },
198
+ },
199
+ },
200
+ IoctlOrBuilder: {
201
+ type: 'object',
202
+ properties: {
203
+ actionType: {
204
+ type: 'string',
205
+ enum: [
206
+ 'BROADCAST',
207
+ 'READ',
208
+ 'WRITE_WITHOUT_RESPONSE',
209
+ 'WRITE',
210
+ 'NOTIFY',
211
+ 'INDICATE',
212
+ 'SIGNED_WRITE',
213
+ 'EXTENDED_PROPERTIES',
214
+ 'NOTIFY_ENCRYPTION_REQUIRED',
215
+ 'INDICATE_ENCRYPTION_REQUIRED',
216
+ 'WRITABLE_AUXILIARIES',
217
+ ],
218
+ },
219
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
220
+ cid: { type: 'string' },
221
+ cidBytes: { $ref: '#/definitions/ByteString' },
222
+ defaultInstanceForType: { $ref: '#/definitions/Message' },
223
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
224
+ initializationErrorString: { type: 'string' },
225
+ initialized: { type: 'boolean' },
226
+ optionsCount: { type: 'integer', format: 'int32' },
227
+ optionsList: { type: 'array', items: { $ref: '#/definitions/Option' } },
228
+ optionsOrBuilderList: { type: 'array', items: { $ref: '#/definitions/OptionOrBuilder' } },
229
+ sid: { type: 'string' },
230
+ sidBytes: { $ref: '#/definitions/ByteString' },
231
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
232
+ value: { $ref: '#/definitions/ByteString' },
233
+ },
234
+ },
235
+ Space: {
236
+ type: 'object',
237
+ required: ['identifier', 'type'],
238
+ properties: {
239
+ bounds: { $ref: '#/definitions/BoundingBox' },
240
+ locus: { $ref: '#/definitions/Point' },
241
+ order: { type: 'integer', format: 'int32' },
242
+ tags: { type: 'array', items: { type: 'string' } },
243
+ identifier: { type: 'string', description: 'identifier' },
244
+ type: { type: 'string', description: 'type' },
245
+ name: { type: 'string', description: 'name' },
246
+ },
247
+ description: 'Base Metadata Object Type',
248
+ },
249
+ RoleDTO: {
250
+ type: 'object',
251
+ properties: {
252
+ editable: { type: 'boolean' },
253
+ id: { type: 'string' },
254
+ permissions: { type: 'array', items: { type: 'string' } },
255
+ tenantId: { type: 'string' },
256
+ },
257
+ },
258
+ TriggerType: { type: 'object', properties: { id: { type: 'string' }, name: { type: 'string' } } },
259
+ SensorTagSummary: {
260
+ type: 'object',
261
+ properties: {
262
+ health: { $ref: '#/definitions/DeviceEventResult' },
263
+ heartBeat: { $ref: '#/definitions/DeviceEventResult' },
264
+ sensorTag: { $ref: '#/definitions/SensorTag' },
265
+ taggedAsset: { $ref: '#/definitions/TaggedAsset' },
266
+ },
267
+ },
268
+ Capability: {
269
+ type: 'object',
270
+ properties: {
271
+ action: { $ref: '#/definitions/ActionMeta' },
272
+ defaultOrder: { type: 'integer', format: 'int32' },
273
+ description: { type: 'string' },
274
+ displayable: { type: 'boolean' },
275
+ editable: { type: 'boolean' },
276
+ enabled: { type: 'boolean' },
277
+ name: { type: 'string' },
278
+ state: { $ref: '#/definitions/State' },
279
+ },
280
+ },
281
+ EnumOptions: {
282
+ type: 'object',
283
+ properties: {
284
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
285
+ allowAlias: { type: 'boolean' },
286
+ defaultInstanceForType: { $ref: '#/definitions/EnumOptions' },
287
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
288
+ initializationErrorString: { type: 'string' },
289
+ initialized: { type: 'boolean' },
290
+ parserForType: { $ref: '#/definitions/Parser«EnumOptions»' },
291
+ serializedSize: { type: 'integer', format: 'int32' },
292
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
293
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
294
+ uninterpretedOptionOrBuilderList: {
295
+ type: 'array',
296
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
297
+ },
298
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
299
+ },
300
+ },
301
+ AssetVisitResult: {
302
+ type: 'object',
303
+ properties: {
304
+ areaLocation: { type: 'string' },
305
+ assetExternalId: { type: 'string' },
306
+ assetName: { type: 'string' },
307
+ assetType: { type: 'string' },
308
+ dwellTime: { type: 'string' },
309
+ entry: { type: 'string' },
310
+ exit: { type: 'string' },
311
+ site: { type: 'string' },
312
+ status: { type: 'string' },
313
+ taggedAssetId: { type: 'string' },
314
+ },
315
+ },
316
+ PeripheralCommands: {
317
+ type: 'object',
318
+ properties: { unknownFields: { $ref: '#/definitions/UnknownFieldSet' } },
319
+ },
320
+ Ioctl: {
321
+ type: 'object',
322
+ required: ['action', 'cId'],
323
+ properties: {
324
+ options: {
325
+ type: 'object',
326
+ description: 'Map of options for a specific Action, for example read frequency, or value to be written',
327
+ additionalProperties: { type: 'string' },
328
+ },
329
+ cId: { type: 'string', description: 'Characteristic to act on' },
330
+ action: {
331
+ type: 'string',
332
+ description: "Action to perform, for Id set to 'Read'",
333
+ enum: ['Read', 'Notify', 'Write', 'WriteWithoutResponse', 'Indicate'],
334
+ },
335
+ },
336
+ description: 'Task object - describes commands to be performed on the peripheral',
337
+ },
338
+ NamePartOrBuilder: {
339
+ type: 'object',
340
+ properties: {
341
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
342
+ defaultInstanceForType: { $ref: '#/definitions/Message' },
343
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
344
+ initializationErrorString: { type: 'string' },
345
+ initialized: { type: 'boolean' },
346
+ isExtension: { type: 'boolean' },
347
+ namePart: { type: 'string' },
348
+ namePartBytes: { $ref: '#/definitions/ByteString' },
349
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
350
+ },
351
+ },
352
+ 'Parser«Property»': { type: 'object' },
353
+ Parser: { type: 'object' },
354
+ AssetResultValue: {
355
+ type: 'object',
356
+ properties: {
357
+ areaName: { type: 'object' },
358
+ cId: { type: 'string' },
359
+ receiverId: { type: 'object' },
360
+ time: { type: 'string', format: 'date-time' },
361
+ value: { type: 'object' },
362
+ },
363
+ },
364
+ PostalAddress: {
365
+ type: 'object',
366
+ properties: {
367
+ city: { type: 'string' },
368
+ countryCode: { type: 'string' },
369
+ postalCode: { type: 'string' },
370
+ stateCode: { type: 'string' },
371
+ streetAddr: { type: 'string' },
372
+ },
373
+ },
374
+ OptionOrBuilder: {
375
+ type: 'object',
376
+ properties: {
377
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
378
+ defaultInstanceForType: { $ref: '#/definitions/Message' },
379
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
380
+ initializationErrorString: { type: 'string' },
381
+ initialized: { type: 'boolean' },
382
+ optionType: {
383
+ type: 'string',
384
+ enum: ['CONNECTION_INTERVAL', 'NOTIFY_TIME_IN_MILLIS', 'NOTIFY_TIME_OUT_IN_MILLIS', 'PRIORITY'],
385
+ },
386
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
387
+ val: { type: 'integer', format: 'int64' },
388
+ },
389
+ },
390
+ Peripheral: {
391
+ type: 'object',
392
+ required: ['peripheralId', 'receiverId', 'type'],
393
+ properties: {
394
+ config: { $ref: '#/definitions/Tasks' },
395
+ leafId: { type: 'string' },
396
+ peripheralId: { type: 'string', description: 'Peripheral Id' },
397
+ type: { type: 'string', description: 'Peripheral type' },
398
+ deviceClass: { type: 'string', description: 'Peripheral Device Class' },
399
+ name: { type: 'string', description: 'Name' },
400
+ receiverId: { type: 'string', description: 'Leaf Reader Id' },
401
+ data: {
402
+ type: 'object',
403
+ description: 'Relevant peripheral data at registration time',
404
+ additionalProperties: { type: 'string' },
405
+ },
406
+ status: { type: 'string', description: 'Status', enum: ['UNPROVISIONED', 'PROVISIONED', 'DISABLED'] },
407
+ lastUpdate: {
408
+ type: 'string',
409
+ format: 'date-time',
410
+ description: 'Time of last data update from this peripheral',
411
+ },
412
+ tasks: {
413
+ type: 'object',
414
+ description: 'Map of tasks by service id',
415
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/Command' } },
416
+ },
417
+ tenantId: { type: 'string', description: 'Owning tenant' },
418
+ physicalId: { type: 'string', description: 'Physical Id, e.g., the MAC Address' },
419
+ tags: {
420
+ type: 'array',
421
+ description: 'Tags associated with this peripheral',
422
+ items: { type: 'string' },
423
+ },
424
+ createdAt: { type: 'string', format: 'date-time', description: 'Peripheral provisioning date' },
425
+ description: { type: 'string', description: 'Description' },
426
+ categoryId: { type: 'string', description: 'category Id' },
427
+ assetId: { type: 'string', description: 'asset Id' },
428
+ },
429
+ description: 'Peripheral Instance Information',
430
+ },
431
+ InputType: {
432
+ type: 'object',
433
+ properties: {
434
+ defaultValue: { type: 'string' },
435
+ name: { type: 'string' },
436
+ type: { $ref: '#/definitions/DataType' },
437
+ },
438
+ },
439
+ VisitResult: {
440
+ type: 'object',
441
+ properties: {
442
+ dwellTime: { type: 'integer', format: 'int64' },
443
+ entry: { type: 'string', format: 'date-time' },
444
+ exit: { type: 'string', format: 'date-time' },
445
+ regionId: { type: 'string' },
446
+ regionName: { type: 'string' },
447
+ regionType: { type: 'string' },
448
+ subRegions: { type: 'array', items: { $ref: '#/definitions/VisitResult' } },
449
+ },
450
+ },
451
+ UnknownFieldSet: {
452
+ type: 'object',
453
+ properties: {
454
+ defaultInstanceForType: { $ref: '#/definitions/UnknownFieldSet' },
455
+ initialized: { type: 'boolean' },
456
+ parserForType: { $ref: '#/definitions/Parser' },
457
+ serializedSize: { type: 'integer', format: 'int32' },
458
+ serializedSizeAsMessageSet: { type: 'integer', format: 'int32' },
459
+ },
460
+ },
461
+ Building: {
462
+ type: 'object',
463
+ required: ['identifier', 'type'],
464
+ properties: {
465
+ address: { $ref: '#/definitions/PostalAddress' },
466
+ bounds: { $ref: '#/definitions/BoundingBox' },
467
+ locus: { $ref: '#/definitions/Point' },
468
+ numFloors: { type: 'integer', format: 'int32' },
469
+ order: { type: 'integer', format: 'int32' },
470
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
471
+ tags: { type: 'array', items: { type: 'string' } },
472
+ identifier: { type: 'string', description: 'identifier' },
473
+ type: { type: 'string', description: 'type' },
474
+ name: { type: 'string', description: 'name' },
475
+ },
476
+ description: 'Base Metadata Object Type',
477
+ },
478
+ PeripheralBase: {
479
+ type: 'object',
480
+ required: ['peripheralId', 'type'],
481
+ properties: {
482
+ peripheralId: { type: 'string', description: 'Peripheral Id' },
483
+ type: { type: 'string', description: 'Peripheral type' },
484
+ deviceClass: { type: 'string', description: 'Peripheral Device Class' },
485
+ name: { type: 'string', description: 'Name' },
486
+ status: { type: 'string', description: 'Status', enum: ['UNPROVISIONED', 'PROVISIONED', 'DISABLED'] },
487
+ lastUpdate: {
488
+ type: 'string',
489
+ format: 'date-time',
490
+ description: 'Time of last data update from this peripheral',
491
+ },
492
+ tenantId: { type: 'string', description: 'Owning tenant' },
493
+ physicalId: { type: 'string', description: 'Physical Id, e.g., the MAC Address' },
494
+ createdAt: { type: 'string', format: 'date-time', description: 'Peripheral provisioning date' },
495
+ categoryId: { type: 'string', description: 'category Id' },
496
+ assetId: { type: 'string', description: 'asset Id' },
497
+ },
498
+ },
499
+ EnumValueOptions: {
500
+ type: 'object',
501
+ properties: {
502
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
503
+ defaultInstanceForType: { $ref: '#/definitions/EnumValueOptions' },
504
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
505
+ initializationErrorString: { type: 'string' },
506
+ initialized: { type: 'boolean' },
507
+ parserForType: { $ref: '#/definitions/Parser«EnumValueOptions»' },
508
+ serializedSize: { type: 'integer', format: 'int32' },
509
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
510
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
511
+ uninterpretedOptionOrBuilderList: {
512
+ type: 'array',
513
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
514
+ },
515
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
516
+ },
517
+ },
518
+ Notification: {
519
+ type: 'object',
520
+ properties: {
521
+ createdAt: { type: 'string', format: 'date-time' },
522
+ deliveredAt: { type: 'string', format: 'date-time' },
523
+ level: { type: 'string' },
524
+ message: { $ref: '#/definitions/ClfMessage' },
525
+ source: { type: 'string' },
526
+ status: { type: 'string', enum: ['UNREAD', 'READ', 'DELETED'] },
527
+ topic: { $ref: '#/definitions/NotificationTopic' },
528
+ transport: { type: 'string', enum: ['web', 'email', 'application', 'pubnub', 'sms', 'voice'] },
529
+ userId: { type: 'string' },
530
+ },
531
+ },
532
+ ServiceMeta: {
533
+ type: 'object',
534
+ required: ['identifier'],
535
+ properties: {
536
+ characteristics: {
537
+ type: 'array',
538
+ description: 'Characteristics metadata list',
539
+ items: { $ref: '#/definitions/CharacteristicMeta' },
540
+ },
541
+ identifier: { type: 'string', description: 'identifier' },
542
+ type: { type: 'string', description: 'type' },
543
+ name: { type: 'string', description: 'name' },
544
+ },
545
+ description: 'Base Metadata Object Type',
546
+ },
547
+ NotificationContext: {
548
+ type: 'object',
549
+ properties: {
550
+ applicableId: { type: 'string' },
551
+ categoryId: { type: 'string' },
552
+ deviceId: { type: 'string' },
553
+ level: { type: 'string' },
554
+ message: { type: 'string' },
555
+ notifTime: { type: 'integer', format: 'int64' },
556
+ notifType: { type: 'string' },
557
+ tenantId: { type: 'string' },
558
+ transport: { type: 'string' },
559
+ userId: { type: 'string' },
560
+ },
561
+ },
562
+ ObjectType: {
563
+ type: 'object',
564
+ required: ['identifier'],
565
+ properties: {
566
+ identifier: { type: 'string', description: 'identifier' },
567
+ type: { type: 'string', description: 'type' },
568
+ name: { type: 'string', description: 'name' },
569
+ },
570
+ description: 'Base Metadata Object Type',
571
+ },
572
+ 'Parser«Tasks»': { type: 'object' },
573
+ MessageOptions: {
574
+ type: 'object',
575
+ properties: {
576
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
577
+ defaultInstanceForType: { $ref: '#/definitions/MessageOptions' },
578
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
579
+ initializationErrorString: { type: 'string' },
580
+ initialized: { type: 'boolean' },
581
+ messageSetWireFormat: { type: 'boolean' },
582
+ noStandardDescriptorAccessor: { type: 'boolean' },
583
+ parserForType: { $ref: '#/definitions/Parser«MessageOptions»' },
584
+ serializedSize: { type: 'integer', format: 'int32' },
585
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
586
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
587
+ uninterpretedOptionOrBuilderList: {
588
+ type: 'array',
589
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
590
+ },
591
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
592
+ },
593
+ },
594
+ ActionMeta: {
595
+ type: 'object',
596
+ properties: {
597
+ actionId: { type: 'string' },
598
+ bulkEnabled: { type: 'boolean' },
599
+ inputTypes: { type: 'array', items: { $ref: '#/definitions/InputType' } },
600
+ },
601
+ },
602
+ BatteryStatResult: {
603
+ type: 'object',
604
+ properties: {
605
+ assetExternalId: { type: 'string' },
606
+ assetName: { type: 'string' },
607
+ assetType: { type: 'string' },
608
+ bLevel: { type: 'string' },
609
+ lastLocation: { type: 'string' },
610
+ lastUpdated: { type: 'string' },
611
+ taggedAssetId: { type: 'string' },
612
+ },
613
+ },
614
+ BoundingBox: {
615
+ type: 'object',
616
+ properties: { bottomRight: { $ref: '#/definitions/Point' }, topLeft: { $ref: '#/definitions/Point' } },
617
+ },
618
+ MetricsValueResult: {
619
+ type: 'object',
620
+ properties: {
621
+ metrics: { type: 'array', items: { $ref: '#/definitions/MetricsValue' } },
622
+ scope: { type: 'string' },
623
+ type: { type: 'string' },
624
+ },
625
+ },
626
+ DataType: {
627
+ type: 'object',
628
+ properties: { format: { type: 'string' }, unitType: { type: 'string' } },
629
+ },
630
+ Partner: {
631
+ type: 'object',
632
+ required: ['identifier', 'type'],
633
+ properties: {
634
+ customers: { type: 'array', items: { $ref: '#/definitions/Customer' } },
635
+ peripheralTypes: { type: 'array', items: { type: 'string' } },
636
+ identifier: { type: 'string', description: 'identifier' },
637
+ type: { type: 'string', description: 'type' },
638
+ name: { type: 'string', description: 'name' },
639
+ },
640
+ description: 'Base Metadata Object Type',
641
+ },
642
+ Property: {
643
+ type: 'object',
644
+ properties: {
645
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
646
+ defaultInstanceForType: { $ref: '#/definitions/Property' },
647
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
648
+ initializationErrorString: { type: 'string' },
649
+ initialized: { type: 'boolean' },
650
+ name: { type: 'string' },
651
+ nameBytes: { $ref: '#/definitions/ByteString' },
652
+ parserForType: { $ref: '#/definitions/Parser«Property»' },
653
+ serializedSize: { type: 'integer', format: 'int32' },
654
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
655
+ value: { type: 'string' },
656
+ valueBytes: { $ref: '#/definitions/ByteString' },
657
+ },
658
+ },
659
+ EnumValueDescriptor: {
660
+ type: 'object',
661
+ properties: {
662
+ file: { $ref: '#/definitions/FileDescriptor' },
663
+ fullName: { type: 'string' },
664
+ index: { type: 'integer', format: 'int32' },
665
+ name: { type: 'string' },
666
+ number: { type: 'integer', format: 'int32' },
667
+ options: { $ref: '#/definitions/EnumValueOptions' },
668
+ type: { $ref: '#/definitions/EnumDescriptor' },
669
+ },
670
+ },
671
+ ObjectMeta: {
672
+ type: 'object',
673
+ properties: {
674
+ applicationName: { type: 'string' },
675
+ categories: { type: 'array', items: { type: 'string' } },
676
+ id: { type: 'string' },
677
+ metric: { type: 'string' },
678
+ name: { type: 'string' },
679
+ properties: { type: 'array', items: { $ref: '#/definitions/PropertyMeta' } },
680
+ stage: { type: 'string' },
681
+ triggerGroups: { type: 'array', items: { type: 'string' } },
682
+ type: { type: 'string' },
683
+ },
684
+ },
685
+ ReceiverSummary: {
686
+ type: 'object',
687
+ properties: {
688
+ health: { $ref: '#/definitions/DeviceEventResult' },
689
+ heartBeat: { $ref: '#/definitions/DeviceEventResult' },
690
+ receiverSummaryDetail: { $ref: '#/definitions/ReceiverSummaryDetail' },
691
+ },
692
+ },
693
+ CommandOrBuilder: {
694
+ type: 'object',
695
+ properties: {
696
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
697
+ defaultInstanceForType: { $ref: '#/definitions/Message' },
698
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
699
+ exec: { $ref: '#/definitions/Ioctl' },
700
+ execOrBuilder: { $ref: '#/definitions/IoctlOrBuilder' },
701
+ initializationErrorString: { type: 'string' },
702
+ initialized: { type: 'boolean' },
703
+ setup: { $ref: '#/definitions/Ioctl' },
704
+ setupOrBuilder: { $ref: '#/definitions/IoctlOrBuilder' },
705
+ teardown: { $ref: '#/definitions/Ioctl' },
706
+ teardownOrBuilder: { $ref: '#/definitions/IoctlOrBuilder' },
707
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
708
+ },
709
+ },
710
+ ReceiverConfig: {
711
+ type: 'object',
712
+ required: ['identifier'],
713
+ properties: {
714
+ allowedTypes: { type: 'array', items: { $ref: '#/definitions/PeripheralTypeMeta' } },
715
+ children: { type: 'array', items: { $ref: '#/definitions/ReceiverConfig' } },
716
+ config: { type: 'object', additionalProperties: { type: 'string' } },
717
+ id: { type: 'string' },
718
+ mqttConfig: { $ref: '#/definitions/MQTTConfigBean' },
719
+ parent: { type: 'string' },
720
+ physicalId: { type: 'string' },
721
+ serverTime: { type: 'integer', format: 'int64' },
722
+ status: {
723
+ type: 'string',
724
+ enum: ['UNPROVISIONED', 'PROVISIONED', 'UP', 'DOWN', 'DEPROVISIONED', 'SOFTPROVISIONED'],
725
+ },
726
+ tenantId: { type: 'string' },
727
+ identifier: { type: 'string', description: 'identifier' },
728
+ type: { type: 'string', description: 'type' },
729
+ name: { type: 'string', description: 'name' },
730
+ },
731
+ description: 'Base Metadata Object Type',
732
+ },
733
+ ReceiverSummaryDetail: {
734
+ type: 'object',
735
+ properties: {
736
+ areaId: { type: 'string' },
737
+ areaName: { type: 'string' },
738
+ buildingId: { type: 'string' },
739
+ buildingName: { type: 'string' },
740
+ identifier: { type: 'string' },
741
+ name: { type: 'string' },
742
+ parentId: { type: 'string' },
743
+ parentName: { type: 'string' },
744
+ physicalId: { type: 'string' },
745
+ status: {
746
+ type: 'string',
747
+ enum: ['UNPROVISIONED', 'PROVISIONED', 'UP', 'DOWN', 'DEPROVISIONED', 'SOFTPROVISIONED'],
748
+ },
749
+ tenantId: { type: 'string' },
750
+ type: {
751
+ type: 'string',
752
+ enum: [
753
+ 'OMNI_RECEIVER',
754
+ 'MOBILE_RECEIVER',
755
+ 'OUT_OF_COVERAGE_PSEUDO_RECEIVER',
756
+ 'SOFT_RECEIVER',
757
+ 'LOCATION_MARKER',
758
+ 'CLOUD_CONNECTOR',
759
+ 'MICRO_CLOUD_CONNECTOR',
760
+ ],
761
+ },
762
+ },
763
+ },
764
+ ReceiverCredentials: {
765
+ type: 'object',
766
+ properties: {
767
+ apiKey: { type: 'string' },
768
+ apiSecret: { type: 'string' },
769
+ leafId: { type: 'string' },
770
+ receiverId: { type: 'string' },
771
+ },
772
+ },
773
+ 'Parser«EnumValueOptions»': { type: 'object' },
774
+ 'Parser«MessageOptions»': { type: 'object' },
775
+ 'Parser«Command»': { type: 'object' },
776
+ ActionTemplate: {
777
+ type: 'object',
778
+ properties: {
779
+ applicableTriggerTemplates: { type: 'array', items: { type: 'string' } },
780
+ description: { type: 'string' },
781
+ id: { type: 'string' },
782
+ inputForm: { type: 'string' },
783
+ name: { type: 'string' },
784
+ preResolvedParams: { type: 'object', additionalProperties: { type: 'string' } },
785
+ status: { type: 'string', enum: ['PARTIAL', 'RESOLVED', 'ARCHIVED'] },
786
+ tenantId: { type: 'string' },
787
+ type: { type: 'string' },
788
+ },
789
+ },
790
+ JarFile: { type: 'object', properties: { jarFileName: { type: 'string' } } },
791
+ UserDevice: {
792
+ type: 'object',
793
+ properties: {
794
+ appPlatform: { type: 'string', enum: ['ios', 'android', 'windows'] },
795
+ confirmationKey: { type: 'string' },
796
+ deviceIdentifier: { type: 'string' },
797
+ deviceName: { type: 'string' },
798
+ id: { type: 'string' },
799
+ providerDetails: { type: 'string' },
800
+ status: {
801
+ type: 'string',
802
+ enum: ['UNSUBSCRIBED', 'PENDING_CONFIRMATION', 'CONFIRMED', 'SUBSCRIBED', 'UNREACHABLE'],
803
+ },
804
+ transport: { type: 'string', enum: ['web', 'email', 'application', 'pubnub', 'sms', 'voice'] },
805
+ userId: { type: 'string' },
806
+ },
807
+ },
808
+ MqttRequest: { type: 'object', properties: { unknownFields: { $ref: '#/definitions/UnknownFieldSet' } } },
809
+ MessageLite: {
810
+ type: 'object',
811
+ properties: {
812
+ defaultInstanceForType: { $ref: '#/definitions/MessageLite' },
813
+ initialized: { type: 'boolean' },
814
+ parserForType: { $ref: '#/definitions/Parser«MessageLite»' },
815
+ serializedSize: { type: 'integer', format: 'int32' },
816
+ },
817
+ },
818
+ TripData: {
819
+ type: 'object',
820
+ properties: {
821
+ destination: { type: 'string' },
822
+ destinationId: { type: 'string' },
823
+ distance: { type: 'number', format: 'double' },
824
+ dwellTime: { type: 'integer', format: 'int64' },
825
+ entry: { type: 'string', format: 'date-time' },
826
+ exit: { type: 'string', format: 'date-time' },
827
+ origin: { type: 'string' },
828
+ originId: { type: 'string' },
829
+ },
830
+ },
831
+ ProcessRuleDTO: {
832
+ type: 'object',
833
+ properties: {
834
+ app_id: { type: 'string' },
835
+ is_ruleset: { type: 'boolean' },
836
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
837
+ recipe_id: { type: 'string' },
838
+ rule_class: { type: 'string' },
839
+ rule_id: { type: 'string' },
840
+ rule_type: { type: 'string' },
841
+ stage_id: {
842
+ type: 'string',
843
+ enum: [
844
+ 'ConvertValue',
845
+ 'ChangeTransformToMetrics',
846
+ 'ChangeTransformToStream',
847
+ 'Transition',
848
+ 'AlertSession',
849
+ 'StateAlertSession',
850
+ 'CountAlertSession',
851
+ 'PresenceTrackingSession',
852
+ 'Metrics',
853
+ 'Stats',
854
+ 'HealthStateAlertSession',
855
+ ],
856
+ },
857
+ tenant_id: { type: 'string' },
858
+ },
859
+ },
860
+ AssetsSensorTag: {
861
+ type: 'object',
862
+ properties: {
863
+ assets: { type: 'array', items: { $ref: '#/definitions/Asset' } },
864
+ sensorTags: { type: 'array', items: { $ref: '#/definitions/SensorTag' } },
865
+ },
866
+ },
867
+ 'Parser«EventData»': { type: 'object' },
868
+ NotificationAlert: {
869
+ type: 'object',
870
+ properties: {
871
+ alertType: { type: 'string' },
872
+ areaName: { type: 'string' },
873
+ assetCategoryId: { type: 'string' },
874
+ assetCategoryName: { type: 'string' },
875
+ assetId: { type: 'string' },
876
+ assetName: { type: 'string' },
877
+ level: { type: 'string' },
878
+ message: { type: 'string' },
879
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
880
+ siteName: { type: 'string' },
881
+ sourceId: { type: 'string' },
882
+ sourceType: { type: 'string' },
883
+ tagId: { type: 'string' },
884
+ tenantId: { type: 'string' },
885
+ time: { type: 'string', format: 'date-time' },
886
+ },
887
+ },
888
+ PropertyOrBuilder: {
889
+ type: 'object',
890
+ properties: {
891
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
892
+ defaultInstanceForType: { $ref: '#/definitions/Message' },
893
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
894
+ initializationErrorString: { type: 'string' },
895
+ initialized: { type: 'boolean' },
896
+ name: { type: 'string' },
897
+ nameBytes: { $ref: '#/definitions/ByteString' },
898
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
899
+ value: { type: 'string' },
900
+ valueBytes: { $ref: '#/definitions/ByteString' },
901
+ },
902
+ },
903
+ MetricsValue: {
904
+ type: 'object',
905
+ properties: {
906
+ group: { type: 'string' },
907
+ interval: { type: 'integer', format: 'int64' },
908
+ metrics: { type: 'object', additionalProperties: { type: 'string' } },
909
+ name: { type: 'string' },
910
+ scope: { type: 'string' },
911
+ time: { type: 'string', format: 'date-time' },
912
+ type: { type: 'string' },
913
+ },
914
+ },
915
+ NotificationAlertExt: {
916
+ type: 'object',
917
+ properties: {
918
+ alertType: { type: 'string' },
919
+ areaName: { type: 'string' },
920
+ assetCategoryId: { type: 'string' },
921
+ assetCategoryName: { type: 'string' },
922
+ assetExternalId: { type: 'string' },
923
+ assetId: { type: 'string' },
924
+ assetName: { type: 'string' },
925
+ level: { type: 'string' },
926
+ message: { type: 'string' },
927
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
928
+ siteName: { type: 'string' },
929
+ sourceId: { type: 'string' },
930
+ sourceType: { type: 'string' },
931
+ tagId: { type: 'string' },
932
+ taggedAssetId: { type: 'string' },
933
+ tenantId: { type: 'string' },
934
+ time: { type: 'string', format: 'date-time' },
935
+ },
936
+ },
937
+ FileOptions: {
938
+ type: 'object',
939
+ properties: {
940
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
941
+ ccGenericServices: { type: 'boolean' },
942
+ defaultInstanceForType: { $ref: '#/definitions/FileOptions' },
943
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
944
+ goPackage: { type: 'string' },
945
+ goPackageBytes: { $ref: '#/definitions/ByteString' },
946
+ initializationErrorString: { type: 'string' },
947
+ initialized: { type: 'boolean' },
948
+ javaGenerateEqualsAndHash: { type: 'boolean' },
949
+ javaGenericServices: { type: 'boolean' },
950
+ javaMultipleFiles: { type: 'boolean' },
951
+ javaOuterClassname: { type: 'string' },
952
+ javaOuterClassnameBytes: { $ref: '#/definitions/ByteString' },
953
+ javaPackage: { type: 'string' },
954
+ javaPackageBytes: { $ref: '#/definitions/ByteString' },
955
+ optimizeFor: { type: 'string', enum: ['SPEED', 'CODE_SIZE', 'LITE_RUNTIME'] },
956
+ parserForType: { $ref: '#/definitions/Parser«FileOptions»' },
957
+ pyGenericServices: { type: 'boolean' },
958
+ serializedSize: { type: 'integer', format: 'int32' },
959
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
960
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
961
+ uninterpretedOptionOrBuilderList: {
962
+ type: 'array',
963
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
964
+ },
965
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
966
+ },
967
+ },
968
+ DescriptorMeta: {
969
+ type: 'object',
970
+ required: ['identifier'],
971
+ properties: {
972
+ standard: { type: 'boolean' },
973
+ value: { type: 'string' },
974
+ identifier: { type: 'string', description: 'identifier' },
975
+ type: { type: 'string', description: 'type' },
976
+ name: { type: 'string', description: 'name' },
977
+ },
978
+ description: 'Base Metadata Object Type',
979
+ },
980
+ TaggedAsset: {
981
+ type: 'object',
982
+ properties: {
983
+ areaName: { type: 'string' },
984
+ asset: { $ref: '#/definitions/Asset' },
985
+ assetState: { type: 'string' },
986
+ buildingName: { type: 'string' },
987
+ categoryImageURL: { type: 'string' },
988
+ createdAt: { type: 'string', format: 'date-time' },
989
+ currentArea: { type: 'string' },
990
+ currentAreaId: { type: 'string' },
991
+ currentConnector: { type: 'string' },
992
+ currentConnectorId: { type: 'string' },
993
+ currentConnectorName: { type: 'string' },
994
+ id: { type: 'string' },
995
+ lastSeen: { type: 'string', format: 'date-time' },
996
+ modifiedAt: { type: 'string', format: 'date-time' },
997
+ position: { $ref: '#/definitions/GeoPoint' },
998
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
999
+ sensorTag: { $ref: '#/definitions/SensorTag' },
1000
+ status: { type: 'string', enum: ['UNPROVISIONED', 'PROVISIONED', 'DISABLED'] },
1001
+ tagImageURL: { type: 'string' },
1002
+ tenantId: { type: 'string' },
1003
+ tenantName: { type: 'string' },
1004
+ },
1005
+ },
1006
+ ActionType: { type: 'object', properties: { id: { type: 'string' }, name: { type: 'string' } } },
1007
+ UserDTO: {
1008
+ type: 'object',
1009
+ required: ['id', 'password', 'tenantId'],
1010
+ properties: {
1011
+ details: { type: 'object', additionalProperties: { type: 'string' } },
1012
+ id: { type: 'string', description: 'user id' },
1013
+ modifiedTime: { type: 'string', format: 'date-time' },
1014
+ primaryEmail: { type: 'string' },
1015
+ securityQset: { type: 'boolean' },
1016
+ securityQuestions: { type: 'object', additionalProperties: { type: 'string' } },
1017
+ userDevices: { type: 'array', items: { $ref: '#/definitions/UserDevice' } },
1018
+ tenantId: { type: 'string', description: 'organization id the user belongs' },
1019
+ password: { type: 'string', description: 'user login password' },
1020
+ name: { type: 'string', description: 'user display name' },
1021
+ enabled: { type: 'boolean', example: false, description: 'active user' },
1022
+ type: { type: 'string', description: 'user type', enum: ['NORMAL_USER', 'API_USER'] },
1023
+ roles: { type: 'array', description: 'roles', items: { type: 'string' } },
1024
+ permissions: { type: 'array', description: 'permissions', items: { type: 'string' } },
1025
+ properties: {
1026
+ type: 'object',
1027
+ description: 'custom properties',
1028
+ additionalProperties: { type: 'string' },
1029
+ },
1030
+ },
1031
+ description: 'Application or API User',
1032
+ },
1033
+ ReportDTO: { type: 'object', properties: { rows: { type: 'array', items: { type: 'object' } } } },
1034
+ FieldOptions: {
1035
+ type: 'object',
1036
+ properties: {
1037
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1038
+ ctype: { type: 'string', enum: ['STRING', 'CORD', 'STRING_PIECE'] },
1039
+ defaultInstanceForType: { $ref: '#/definitions/FieldOptions' },
1040
+ deprecated: { type: 'boolean' },
1041
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1042
+ experimentalMapKey: { type: 'string' },
1043
+ experimentalMapKeyBytes: { $ref: '#/definitions/ByteString' },
1044
+ initializationErrorString: { type: 'string' },
1045
+ initialized: { type: 'boolean' },
1046
+ lazy: { type: 'boolean' },
1047
+ packed: { type: 'boolean' },
1048
+ parserForType: { $ref: '#/definitions/Parser«FieldOptions»' },
1049
+ serializedSize: { type: 'integer', format: 'int32' },
1050
+ uninterpretedOptionCount: { type: 'integer', format: 'int32' },
1051
+ uninterpretedOptionList: { type: 'array', items: { $ref: '#/definitions/UninterpretedOption' } },
1052
+ uninterpretedOptionOrBuilderList: {
1053
+ type: 'array',
1054
+ items: { $ref: '#/definitions/UninterpretedOptionOrBuilder' },
1055
+ },
1056
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1057
+ weak: { type: 'boolean' },
1058
+ },
1059
+ },
1060
+ Result: {
1061
+ type: 'object',
1062
+ required: ['cId', 'format', 'oId', 'oType', 'sId', 'unit'],
1063
+ properties: {
1064
+ cId: { type: 'string', description: 'characteristic Id' },
1065
+ cName: { type: 'string', description: 'human readable characteristic name' },
1066
+ data: {
1067
+ type: 'array',
1068
+ description: 'array of data values and the time the data was recorded',
1069
+ items: { $ref: '#/definitions/StreamResultValue' },
1070
+ },
1071
+ format: {
1072
+ type: 'string',
1073
+ description:
1074
+ "format type - CloudLeaf known system types are: 'STRING_TYPE', 'INT_TYPE', 'FLOAT_TYPE', 'DOUBLE_TYPE'. Custom types can be defined. 'UNKNOWN_TYPE' if format is not known",
1075
+ },
1076
+ oId: { type: 'string', description: 'object Id' },
1077
+ oName: { type: 'string', description: 'object Name' },
1078
+ oType: {
1079
+ type: 'string',
1080
+ description: 'object Type',
1081
+ enum: ['PERIPHERAL', 'RECEIVER', 'ORGANIZATION', 'SITE', 'AREA', 'USER'],
1082
+ },
1083
+ sId: { type: 'string', description: 'service Id' },
1084
+ sName: { type: 'string', description: 'human readable service name' },
1085
+ sourceData: {
1086
+ type: 'array',
1087
+ description: 'array of data values for a source and the time the data was recorded',
1088
+ items: { $ref: '#/definitions/ResultValue' },
1089
+ },
1090
+ unit: { type: 'string', description: "unit type - 'UNKNOWN_TYPE' if type information is not known" },
1091
+ },
1092
+ description: 'Data Stream Values For different objects within the platform',
1093
+ },
1094
+ MQTTConfigBean: {
1095
+ type: 'object',
1096
+ properties: {
1097
+ brokerurl: { type: 'string' },
1098
+ enabled: { type: 'boolean' },
1099
+ externalBrokerurl: { type: 'string' },
1100
+ password: { type: 'string' },
1101
+ userid: { type: 'string' },
1102
+ },
1103
+ },
1104
+ ProcessRule: {
1105
+ type: 'object',
1106
+ properties: {
1107
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
1108
+ rule_class: { type: 'string' },
1109
+ rule_id: { type: 'string' },
1110
+ },
1111
+ },
1112
+ GeoPoint: {
1113
+ type: 'object',
1114
+ properties: {
1115
+ latitude: { type: 'number', format: 'double' },
1116
+ longitude: { type: 'number', format: 'double' },
1117
+ },
1118
+ },
1119
+ NotificationTopic: {
1120
+ type: 'object',
1121
+ properties: {
1122
+ category: { type: 'string' },
1123
+ description: { type: 'string' },
1124
+ id: { type: 'string' },
1125
+ name: { type: 'string' },
1126
+ notificationType: { type: 'string' },
1127
+ tenantId: { type: 'string' },
1128
+ },
1129
+ },
1130
+ 'Parser«Ioctl»': { type: 'object' },
1131
+ GeoEventData: {
1132
+ type: 'object',
1133
+ properties: {
1134
+ cId: { type: 'string' },
1135
+ eventTime: { type: 'integer', format: 'int64' },
1136
+ leafId: { type: 'string' },
1137
+ peripheralId: { type: 'string' },
1138
+ sId: { type: 'string' },
1139
+ time: { type: 'integer', format: 'int64' },
1140
+ value: { type: 'string' },
1141
+ },
1142
+ },
1143
+ PeripheralTasks: {
1144
+ type: 'object',
1145
+ properties: {
1146
+ peripheralId: { type: 'string' },
1147
+ tasks: {
1148
+ type: 'object',
1149
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/Command' } },
1150
+ },
1151
+ type: { type: 'string' },
1152
+ },
1153
+ },
1154
+ ServiceDescriptor: {
1155
+ type: 'object',
1156
+ properties: {
1157
+ file: { $ref: '#/definitions/FileDescriptor' },
1158
+ fullName: { type: 'string' },
1159
+ index: { type: 'integer', format: 'int32' },
1160
+ methods: { type: 'array', items: { $ref: '#/definitions/MethodDescriptor' } },
1161
+ name: { type: 'string' },
1162
+ options: { $ref: '#/definitions/ServiceOptions' },
1163
+ },
1164
+ },
1165
+ ReceiverAuth: {
1166
+ type: 'object',
1167
+ properties: { physicalId: { type: 'string' }, secret: { type: 'string' } },
1168
+ },
1169
+ AccessToken: {
1170
+ type: 'object',
1171
+ properties: { expiry: { type: 'string', format: 'date-time' }, token: { type: 'string' } },
1172
+ },
1173
+ MqttResponse: {
1174
+ type: 'object',
1175
+ properties: {
1176
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1177
+ correlationId: { type: 'string' },
1178
+ correlationIdBytes: { $ref: '#/definitions/ByteString' },
1179
+ dataCount: { type: 'integer', format: 'int32' },
1180
+ dataList: { type: 'array', items: { $ref: '#/definitions/Property' } },
1181
+ dataOrBuilderList: { type: 'array', items: { $ref: '#/definitions/PropertyOrBuilder' } },
1182
+ defaultInstanceForType: { $ref: '#/definitions/MqttResponse' },
1183
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1184
+ initializationErrorString: { type: 'string' },
1185
+ initialized: { type: 'boolean' },
1186
+ parserForType: { $ref: '#/definitions/Parser«MqttResponse»' },
1187
+ responseCode: { type: 'integer', format: 'int32' },
1188
+ responseTime: { type: 'integer', format: 'int64' },
1189
+ responseType: { type: 'string' },
1190
+ responseTypeBytes: { $ref: '#/definitions/ByteString' },
1191
+ serializedSize: { type: 'integer', format: 'int32' },
1192
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1193
+ },
1194
+ },
1195
+ 'Parser«UninterpretedOption»': { type: 'object' },
1196
+ JobData: {
1197
+ type: 'object',
1198
+ properties: {
1199
+ cassandraContactPt: { type: 'string' },
1200
+ dataSource: { type: 'string' },
1201
+ endTime: { type: 'string' },
1202
+ fileName: { type: 'string' },
1203
+ startTime: { type: 'string' },
1204
+ tenantId: { type: 'string' },
1205
+ },
1206
+ },
1207
+ 'Parser«Option»': { type: 'object' },
1208
+ 'Parser«FieldOptions»': { type: 'object' },
1209
+ Tasks: {
1210
+ type: 'object',
1211
+ properties: {
1212
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1213
+ commandsCount: { type: 'integer', format: 'int32' },
1214
+ commandsList: { type: 'array', items: { $ref: '#/definitions/Command' } },
1215
+ commandsOrBuilderList: { type: 'array', items: { $ref: '#/definitions/CommandOrBuilder' } },
1216
+ defaultInstanceForType: { $ref: '#/definitions/Tasks' },
1217
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1218
+ initializationErrorString: { type: 'string' },
1219
+ initialized: { type: 'boolean' },
1220
+ parserForType: { $ref: '#/definitions/Parser«Tasks»' },
1221
+ serializedSize: { type: 'integer', format: 'int32' },
1222
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1223
+ },
1224
+ },
1225
+ AssetResult: {
1226
+ type: 'object',
1227
+ required: ['cId', 'format', 'oId', 'oType', 'sId', 'unit'],
1228
+ properties: {
1229
+ areaName: { type: 'string', description: 'Area Name' },
1230
+ assetData: {
1231
+ type: 'array',
1232
+ description: 'array of data values and the time the data was recorded',
1233
+ items: { $ref: '#/definitions/AssetResultValue' },
1234
+ },
1235
+ assetName: { type: 'string', description: 'Asset Name' },
1236
+ cId: { type: 'string', description: 'characteristic Id' },
1237
+ cName: { type: 'string', description: 'human readable characteristic name' },
1238
+ data: {
1239
+ type: 'array',
1240
+ description: 'array of data values and the time the data was recorded',
1241
+ items: { $ref: '#/definitions/StreamResultValue' },
1242
+ },
1243
+ format: {
1244
+ type: 'string',
1245
+ description:
1246
+ "format type - CloudLeaf known system types are: 'STRING_TYPE', 'INT_TYPE', 'FLOAT_TYPE', 'DOUBLE_TYPE'. Custom types can be defined. 'UNKNOWN_TYPE' if format is not known",
1247
+ },
1248
+ oId: { type: 'string', description: 'object Id' },
1249
+ oName: { type: 'string', description: 'object Name' },
1250
+ oType: {
1251
+ type: 'string',
1252
+ description: 'object Type',
1253
+ enum: ['PERIPHERAL', 'RECEIVER', 'ORGANIZATION', 'SITE', 'AREA', 'USER'],
1254
+ },
1255
+ sId: { type: 'string', description: 'service Id' },
1256
+ sName: { type: 'string', description: 'human readable service name' },
1257
+ sourceData: {
1258
+ type: 'array',
1259
+ description: 'array of data values for a source and the time the data was recorded',
1260
+ items: { $ref: '#/definitions/ResultValue' },
1261
+ },
1262
+ unit: { type: 'string', description: "unit type - 'UNKNOWN_TYPE' if type information is not known" },
1263
+ },
1264
+ description: 'Data Stream Values For Asset objects within the platform',
1265
+ },
1266
+ DevicePropertyMeta: {
1267
+ type: 'object',
1268
+ properties: {
1269
+ modLevel: { type: 'string' },
1270
+ name: { type: 'string' },
1271
+ type: { type: 'string' },
1272
+ value: { type: 'string' },
1273
+ },
1274
+ },
1275
+ Receiver: {
1276
+ type: 'object',
1277
+ required: ['identifier'],
1278
+ properties: {
1279
+ parent: { type: 'string' },
1280
+ physicalId: { type: 'string' },
1281
+ status: {
1282
+ type: 'string',
1283
+ enum: ['UNPROVISIONED', 'PROVISIONED', 'UP', 'DOWN', 'DEPROVISIONED', 'SOFTPROVISIONED'],
1284
+ },
1285
+ tenantId: { type: 'string' },
1286
+ identifier: { type: 'string', description: 'identifier' },
1287
+ type: { type: 'string', description: 'type' },
1288
+ name: { type: 'string', description: 'name' },
1289
+ },
1290
+ description: 'Base Metadata Object Type',
1291
+ },
1292
+ EnumDescriptor: {
1293
+ type: 'object',
1294
+ properties: {
1295
+ containingType: { $ref: '#/definitions/Descriptor' },
1296
+ file: { $ref: '#/definitions/FileDescriptor' },
1297
+ fullName: { type: 'string' },
1298
+ index: { type: 'integer', format: 'int32' },
1299
+ name: { type: 'string' },
1300
+ options: { $ref: '#/definitions/EnumOptions' },
1301
+ values: { type: 'array', items: { $ref: '#/definitions/EnumValueDescriptor' } },
1302
+ },
1303
+ },
1304
+ StatsValue: {
1305
+ type: 'object',
1306
+ properties: {
1307
+ count: { type: 'integer', format: 'int64' },
1308
+ max: { type: 'number', format: 'double' },
1309
+ mean: { type: 'number', format: 'double' },
1310
+ min: { type: 'number', format: 'double' },
1311
+ stdev: { type: 'number', format: 'double' },
1312
+ time: { type: 'string', format: 'date-time' },
1313
+ },
1314
+ },
1315
+ Role: {
1316
+ type: 'object',
1317
+ properties: {
1318
+ id: { type: 'string' },
1319
+ permissions: { type: 'array', items: { type: 'string' } },
1320
+ tenantId: { type: 'string' },
1321
+ },
1322
+ },
1323
+ Area: {
1324
+ type: 'object',
1325
+ required: ['identifier', 'type'],
1326
+ properties: {
1327
+ bounds: { $ref: '#/definitions/BoundingBox' },
1328
+ deleted: { type: 'boolean' },
1329
+ locus: { $ref: '#/definitions/Point' },
1330
+ order: { type: 'integer', format: 'int32' },
1331
+ receiver: { $ref: '#/definitions/Receiver' },
1332
+ tags: { type: 'array', items: { type: 'string' } },
1333
+ identifier: { type: 'string', description: 'identifier' },
1334
+ type: { type: 'string', description: 'type' },
1335
+ name: { type: 'string', description: 'name' },
1336
+ },
1337
+ description: 'Base Metadata Object Type',
1338
+ },
1339
+ NamePart: {
1340
+ type: 'object',
1341
+ properties: {
1342
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1343
+ defaultInstanceForType: { $ref: '#/definitions/NamePart' },
1344
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1345
+ initializationErrorString: { type: 'string' },
1346
+ initialized: { type: 'boolean' },
1347
+ isExtension: { type: 'boolean' },
1348
+ namePart: { type: 'string' },
1349
+ namePartBytes: { $ref: '#/definitions/ByteString' },
1350
+ parserForType: { $ref: '#/definitions/Parser«NamePart»' },
1351
+ serializedSize: { type: 'integer', format: 'int32' },
1352
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1353
+ },
1354
+ },
1355
+ TriggerTemplate: {
1356
+ type: 'object',
1357
+ properties: {
1358
+ applicableMetric: { type: 'string' },
1359
+ description: { type: 'string' },
1360
+ id: { type: 'string' },
1361
+ inputForm: { type: 'string' },
1362
+ msgDetail: { type: 'string' },
1363
+ msgSummary: { type: 'string' },
1364
+ name: { type: 'string' },
1365
+ preResolvedParams: { type: 'object', additionalProperties: { type: 'string' } },
1366
+ status: { type: 'string', enum: ['PARTIAL', 'RESOLVED', 'ARCHIVED'] },
1367
+ tenantId: { type: 'string' },
1368
+ triggerGroups: { type: 'array', items: { type: 'string' } },
1369
+ type: { type: 'string' },
1370
+ },
1371
+ },
1372
+ 'Parser«Message»': { type: 'object' },
1373
+ State: {
1374
+ type: 'object',
1375
+ properties: { name: { type: 'string' }, type: { $ref: '#/definitions/DataType' } },
1376
+ },
1377
+ Stats: {
1378
+ type: 'object',
1379
+ properties: {
1380
+ data: {
1381
+ type: 'array',
1382
+ description: 'array of data values and the time the data was recorded',
1383
+ items: { $ref: '#/definitions/StatsValue' },
1384
+ },
1385
+ },
1386
+ description: 'Statistics metrics for different objects within the platform',
1387
+ },
1388
+ ClfMessage: {
1389
+ type: 'object',
1390
+ properties: {
1391
+ altBody: { type: 'string' },
1392
+ body: { type: 'string' },
1393
+ subject: { type: 'string' },
1394
+ transport: { type: 'string', enum: ['web', 'email', 'application', 'pubnub', 'sms', 'voice'] },
1395
+ },
1396
+ },
1397
+ Descriptor: {
1398
+ type: 'object',
1399
+ properties: {
1400
+ containingType: { $ref: '#/definitions/Descriptor' },
1401
+ enumTypes: { type: 'array', items: { $ref: '#/definitions/EnumDescriptor' } },
1402
+ extensions: { type: 'array', items: { $ref: '#/definitions/FieldDescriptor' } },
1403
+ fields: { type: 'array', items: { $ref: '#/definitions/FieldDescriptor' } },
1404
+ file: { $ref: '#/definitions/FileDescriptor' },
1405
+ fullName: { type: 'string' },
1406
+ index: { type: 'integer', format: 'int32' },
1407
+ name: { type: 'string' },
1408
+ nestedTypes: { type: 'array', items: { $ref: '#/definitions/Descriptor' } },
1409
+ options: { $ref: '#/definitions/MessageOptions' },
1410
+ },
1411
+ },
1412
+ Option: {
1413
+ type: 'object',
1414
+ properties: {
1415
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1416
+ defaultInstanceForType: { $ref: '#/definitions/Option' },
1417
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1418
+ initializationErrorString: { type: 'string' },
1419
+ initialized: { type: 'boolean' },
1420
+ optionType: {
1421
+ type: 'string',
1422
+ enum: ['CONNECTION_INTERVAL', 'NOTIFY_TIME_IN_MILLIS', 'NOTIFY_TIME_OUT_IN_MILLIS', 'PRIORITY'],
1423
+ },
1424
+ parserForType: { $ref: '#/definitions/Parser«Option»' },
1425
+ serializedSize: { type: 'integer', format: 'int32' },
1426
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1427
+ val: { type: 'integer', format: 'int64' },
1428
+ },
1429
+ },
1430
+ ReceiverDetail: {
1431
+ type: 'object',
1432
+ required: ['identifier'],
1433
+ properties: {
1434
+ area: { $ref: '#/definitions/Area' },
1435
+ areaId: { type: 'string' },
1436
+ attributes: { type: 'object', additionalProperties: { type: 'string' } },
1437
+ building: { $ref: '#/definitions/Building' },
1438
+ lastReported: { type: 'string', format: 'date-time' },
1439
+ parent: { type: 'string' },
1440
+ physicalId: { type: 'string' },
1441
+ position: { $ref: '#/definitions/GeoPoint' },
1442
+ provisionedAt: { type: 'string', format: 'date-time' },
1443
+ status: {
1444
+ type: 'string',
1445
+ enum: ['UNPROVISIONED', 'PROVISIONED', 'UP', 'DOWN', 'DEPROVISIONED', 'SOFTPROVISIONED'],
1446
+ },
1447
+ tags: { type: 'array', items: { type: 'string' } },
1448
+ tenantId: { type: 'string' },
1449
+ tenantName: { type: 'string' },
1450
+ identifier: { type: 'string', description: 'identifier' },
1451
+ type: { type: 'string', description: 'type' },
1452
+ name: { type: 'string', description: 'name' },
1453
+ },
1454
+ description: 'Base Metadata Object Type',
1455
+ },
1456
+ DeviceEvent: {
1457
+ type: 'object',
1458
+ properties: {
1459
+ deviceId: { type: 'string' },
1460
+ deviceType: { type: 'string' },
1461
+ level: { type: 'string' },
1462
+ payload: {
1463
+ type: 'object',
1464
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/EventData' } },
1465
+ },
1466
+ time: { type: 'string', format: 'date-time' },
1467
+ },
1468
+ },
1469
+ Action: {
1470
+ type: 'object',
1471
+ properties: { targetId: { type: 'string' }, targetType: { type: 'string' } },
1472
+ },
1473
+ Category: {
1474
+ type: 'object',
1475
+ properties: {
1476
+ assetStateValues: { type: 'array', items: { type: 'string' } },
1477
+ createdAt: { type: 'string', format: 'date-time' },
1478
+ description: { type: 'string' },
1479
+ id: { type: 'string' },
1480
+ imageURL: { type: 'string' },
1481
+ metrics: { type: 'array', items: { type: 'string' } },
1482
+ modifiedAt: { type: 'string', format: 'date-time' },
1483
+ name: { type: 'string' },
1484
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
1485
+ sortOrder: { type: 'integer', format: 'int32' },
1486
+ status: { type: 'string', enum: ['ACTIVE', 'ARCHIVED', 'DELETED'] },
1487
+ tenantId: { type: 'string' },
1488
+ },
1489
+ },
1490
+ Message: {
1491
+ type: 'object',
1492
+ properties: {
1493
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1494
+ defaultInstanceForType: { $ref: '#/definitions/MessageLite' },
1495
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1496
+ initializationErrorString: { type: 'string' },
1497
+ initialized: { type: 'boolean' },
1498
+ parserForType: { $ref: '#/definitions/Parser«Message»' },
1499
+ serializedSize: { type: 'integer', format: 'int32' },
1500
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1501
+ },
1502
+ },
1503
+ DeviceMeta: {
1504
+ type: 'object',
1505
+ properties: {
1506
+ payload: { type: 'array', items: { $ref: '#/definitions/DeviceTypeMeta' } },
1507
+ time: { type: 'string', format: 'date-time' },
1508
+ },
1509
+ },
1510
+ IdCommand: {
1511
+ type: 'object',
1512
+ required: ['action', 'cId', 'inAdvert'],
1513
+ properties: {
1514
+ options: {
1515
+ type: 'object',
1516
+ description: 'Map of options for a specific Action, for example read frequency, or value to be written',
1517
+ additionalProperties: { type: 'string' },
1518
+ },
1519
+ cId: { type: 'string', description: 'Characteristic to act on' },
1520
+ action: {
1521
+ type: 'string',
1522
+ description: "Action to perform, for Id set to 'Read'",
1523
+ enum: ['Read', 'Notify', 'Write', 'WriteWithoutResponse', 'Indicate'],
1524
+ },
1525
+ inAdvert: {
1526
+ type: 'boolean',
1527
+ example: false,
1528
+ description: 'Specifies whether Id is in the Advertisement',
1529
+ },
1530
+ sId: {
1531
+ type: 'string',
1532
+ description: 'Service from which to extract the Id of the peripheral - set if inAdvert is false',
1533
+ },
1534
+ },
1535
+ description: 'Command to determine how to extract the identity of the peripheral',
1536
+ },
1537
+ UserCredsModifier: {
1538
+ type: 'object',
1539
+ required: ['newSecret', 'oldSecret'],
1540
+ properties: { newSecret: { type: 'string' }, oldSecret: { type: 'string' } },
1541
+ },
1542
+ DeviceEventResult: {
1543
+ type: 'object',
1544
+ properties: {
1545
+ deviceId: { type: 'string' },
1546
+ deviceType: { type: 'string' },
1547
+ events: { type: 'array', items: { $ref: '#/definitions/EventDataResult' } },
1548
+ },
1549
+ },
1550
+ DeviceTypeMeta: {
1551
+ type: 'object',
1552
+ properties: {
1553
+ command: {
1554
+ type: 'object',
1555
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/DevicePropertyMeta' } },
1556
+ },
1557
+ configuration: {
1558
+ type: 'object',
1559
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/DevicePropertyMeta' } },
1560
+ },
1561
+ deviceID: { type: 'string' },
1562
+ deviceType: { type: 'string' },
1563
+ monitor: {
1564
+ type: 'object',
1565
+ additionalProperties: { type: 'array', items: { $ref: '#/definitions/DevicePropertyMeta' } },
1566
+ },
1567
+ },
1568
+ },
1569
+ 'Parser«MqttResponse»': { type: 'object' },
1570
+ FieldDescriptor: {
1571
+ type: 'object',
1572
+ properties: {
1573
+ containingType: { $ref: '#/definitions/Descriptor' },
1574
+ defaultValue: { type: 'object' },
1575
+ enumType: { $ref: '#/definitions/EnumDescriptor' },
1576
+ extension: { type: 'boolean' },
1577
+ extensionScope: { $ref: '#/definitions/Descriptor' },
1578
+ file: { $ref: '#/definitions/FileDescriptor' },
1579
+ fullName: { type: 'string' },
1580
+ index: { type: 'integer', format: 'int32' },
1581
+ javaType: {
1582
+ type: 'string',
1583
+ enum: ['INT', 'LONG', 'FLOAT', 'DOUBLE', 'BOOLEAN', 'STRING', 'BYTE_STRING', 'ENUM', 'MESSAGE'],
1584
+ },
1585
+ liteJavaType: {
1586
+ type: 'string',
1587
+ enum: ['INT', 'LONG', 'FLOAT', 'DOUBLE', 'BOOLEAN', 'STRING', 'BYTE_STRING', 'ENUM', 'MESSAGE'],
1588
+ },
1589
+ liteType: {
1590
+ type: 'string',
1591
+ enum: [
1592
+ 'DOUBLE',
1593
+ 'FLOAT',
1594
+ 'INT64',
1595
+ 'UINT64',
1596
+ 'INT32',
1597
+ 'FIXED64',
1598
+ 'FIXED32',
1599
+ 'BOOL',
1600
+ 'STRING',
1601
+ 'GROUP',
1602
+ 'MESSAGE',
1603
+ 'BYTES',
1604
+ 'UINT32',
1605
+ 'ENUM',
1606
+ 'SFIXED32',
1607
+ 'SFIXED64',
1608
+ 'SINT32',
1609
+ 'SINT64',
1610
+ ],
1611
+ },
1612
+ messageType: { $ref: '#/definitions/Descriptor' },
1613
+ name: { type: 'string' },
1614
+ number: { type: 'integer', format: 'int32' },
1615
+ optional: { type: 'boolean' },
1616
+ options: { $ref: '#/definitions/FieldOptions' },
1617
+ packable: { type: 'boolean' },
1618
+ packed: { type: 'boolean' },
1619
+ repeated: { type: 'boolean' },
1620
+ required: { type: 'boolean' },
1621
+ type: {
1622
+ type: 'string',
1623
+ enum: [
1624
+ 'DOUBLE',
1625
+ 'FLOAT',
1626
+ 'INT64',
1627
+ 'UINT64',
1628
+ 'INT32',
1629
+ 'FIXED64',
1630
+ 'FIXED32',
1631
+ 'BOOL',
1632
+ 'STRING',
1633
+ 'GROUP',
1634
+ 'MESSAGE',
1635
+ 'BYTES',
1636
+ 'UINT32',
1637
+ 'ENUM',
1638
+ 'SFIXED32',
1639
+ 'SFIXED64',
1640
+ 'SINT32',
1641
+ 'SINT64',
1642
+ ],
1643
+ },
1644
+ },
1645
+ },
1646
+ PropertyMeta: {
1647
+ type: 'object',
1648
+ properties: {
1649
+ appType: {
1650
+ type: 'string',
1651
+ enum: [
1652
+ 'TENANT',
1653
+ 'USER',
1654
+ 'USER_DEVICE',
1655
+ 'SITE',
1656
+ 'AREA',
1657
+ 'RECEIVER',
1658
+ 'PERIPHERAL',
1659
+ 'CATEGORY',
1660
+ 'PERIPHERALMETA',
1661
+ 'ASSET',
1662
+ 'SENSORTAG',
1663
+ 'TAGGEDASSET',
1664
+ 'RULES',
1665
+ 'ROLE',
1666
+ 'changelog',
1667
+ 'TRIGGER_TEMPLATE',
1668
+ 'ACTION_TEMPLATE',
1669
+ 'RECIPE',
1670
+ 'SYSRECIPE',
1671
+ 'NOTIFLEVEL',
1672
+ 'OTHER',
1673
+ ],
1674
+ },
1675
+ defaultValue: { type: 'string' },
1676
+ description: { type: 'string' },
1677
+ keyName: { type: 'string' },
1678
+ name: { type: 'string' },
1679
+ required: { type: 'boolean' },
1680
+ simpleClassName: { type: 'string' },
1681
+ type: { type: 'string', enum: ['KNOWN_APPLICATION_TYPE', 'JAVA_CLASS_TYPE'] },
1682
+ },
1683
+ },
1684
+ ProcessRuleStage: {
1685
+ type: 'object',
1686
+ properties: { ruleset: { $ref: '#/definitions/ProcessRuleSet' }, stage_id: { type: 'string' } },
1687
+ },
1688
+ 'Parser«MethodOptions»': { type: 'object' },
1689
+ SensorTag: {
1690
+ type: 'object',
1691
+ properties: {
1692
+ createdAt: { type: 'string', format: 'date-time' },
1693
+ id: { type: 'string' },
1694
+ modifiedAt: { type: 'string', format: 'date-time' },
1695
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
1696
+ status: { type: 'string', enum: ['READY', 'ACTIVE', 'INACTIVE', 'FAILED'] },
1697
+ tenantId: { type: 'string' },
1698
+ type: { type: 'string' },
1699
+ },
1700
+ },
1701
+ PeripheralTypeMeta: {
1702
+ type: 'object',
1703
+ properties: {
1704
+ createdAt: { type: 'string', format: 'date-time' },
1705
+ deviceClass: { type: 'string' },
1706
+ enabled: { type: 'boolean' },
1707
+ idCommand: { $ref: '#/definitions/IdCommand' },
1708
+ modifiedAt: { type: 'string', format: 'date-time' },
1709
+ regEx: { type: 'string' },
1710
+ },
1711
+ description:
1712
+ 'Peripheral Type Metadata Object - I/O object used to describe a type of peripheral, how to extract its ID, etc.',
1713
+ },
1714
+ 'Parser«EnumOptions»': { type: 'object' },
1715
+ UninterpretedOptionOrBuilder: {
1716
+ type: 'object',
1717
+ properties: {
1718
+ aggregateValue: { type: 'string' },
1719
+ aggregateValueBytes: { $ref: '#/definitions/ByteString' },
1720
+ allFields: { type: 'object', additionalProperties: { type: 'object' } },
1721
+ defaultInstanceForType: { $ref: '#/definitions/Message' },
1722
+ descriptorForType: { $ref: '#/definitions/Descriptor' },
1723
+ doubleValue: { type: 'number', format: 'double' },
1724
+ identifierValue: { type: 'string' },
1725
+ identifierValueBytes: { $ref: '#/definitions/ByteString' },
1726
+ initializationErrorString: { type: 'string' },
1727
+ initialized: { type: 'boolean' },
1728
+ nameCount: { type: 'integer', format: 'int32' },
1729
+ nameList: { type: 'array', items: { $ref: '#/definitions/NamePart' } },
1730
+ nameOrBuilderList: { type: 'array', items: { $ref: '#/definitions/NamePartOrBuilder' } },
1731
+ negativeIntValue: { type: 'integer', format: 'int64' },
1732
+ positiveIntValue: { type: 'integer', format: 'int64' },
1733
+ stringValue: { $ref: '#/definitions/ByteString' },
1734
+ unknownFields: { $ref: '#/definitions/UnknownFieldSet' },
1735
+ },
1736
+ },
1737
+ ApplicationProcessRule: {
1738
+ type: 'object',
1739
+ properties: {
1740
+ app_id: { type: 'string' },
1741
+ stages: { type: 'array', items: { $ref: '#/definitions/ProcessRuleStage' } },
1742
+ },
1743
+ },
1744
+ Zone: {
1745
+ type: 'object',
1746
+ required: ['identifier'],
1747
+ properties: {
1748
+ regions: { type: 'array', items: { $ref: '#/definitions/Space' } },
1749
+ identifier: { type: 'string', description: 'identifier' },
1750
+ type: { type: 'string', description: 'type' },
1751
+ name: { type: 'string', description: 'name' },
1752
+ },
1753
+ description: 'Base Metadata Object Type',
1754
+ },
1755
+ Point: {
1756
+ type: 'object',
1757
+ properties: {
1758
+ height: { type: 'number', format: 'double' },
1759
+ lat: { type: 'number', format: 'double' },
1760
+ lng: { type: 'number', format: 'double' },
1761
+ },
1762
+ },
1763
+ ResultValue: {
1764
+ type: 'object',
1765
+ properties: {
1766
+ reporterId: { type: 'object' },
1767
+ reporterName: { type: 'object' },
1768
+ time: { type: 'string', format: 'date-time' },
1769
+ value: { type: 'object' },
1770
+ },
1771
+ },
1772
+ EventDataResult: {
1773
+ type: 'object',
1774
+ properties: {
1775
+ level: { type: 'string' },
1776
+ module: { type: 'string' },
1777
+ name: { type: 'string' },
1778
+ time: { type: 'string', format: 'date-time' },
1779
+ type: { type: 'string' },
1780
+ value: { type: 'string' },
1781
+ },
1782
+ },
1783
+ PeripheralCapabilities: {
1784
+ type: 'object',
1785
+ properties: {
1786
+ capabilities: { type: 'array', items: { $ref: '#/definitions/Capability' } },
1787
+ peripheralActions: { type: 'array', items: { $ref: '#/definitions/ActionMeta' } },
1788
+ },
1789
+ },
1790
+ MethodDescriptor: {
1791
+ type: 'object',
1792
+ properties: {
1793
+ file: { $ref: '#/definitions/FileDescriptor' },
1794
+ fullName: { type: 'string' },
1795
+ index: { type: 'integer', format: 'int32' },
1796
+ inputType: { $ref: '#/definitions/Descriptor' },
1797
+ name: { type: 'string' },
1798
+ options: { $ref: '#/definitions/MethodOptions' },
1799
+ outputType: { $ref: '#/definitions/Descriptor' },
1800
+ service: { $ref: '#/definitions/ServiceDescriptor' },
1801
+ },
1802
+ },
1803
+ NotificationSubscription: {
1804
+ type: 'object',
1805
+ properties: {
1806
+ categoryRegEx: { type: 'string' },
1807
+ createdAt: { type: 'string', format: 'date-time' },
1808
+ device: { $ref: '#/definitions/UserDevice' },
1809
+ levelRegEx: { type: 'string' },
1810
+ modifiedAt: { type: 'string', format: 'date-time' },
1811
+ notifTypeRegEx: { type: 'string' },
1812
+ notificationStatus: { type: 'string' },
1813
+ regExString: { type: 'string' },
1814
+ tenantId: { type: 'string' },
1815
+ userId: { type: 'string' },
1816
+ },
1817
+ },
1818
+ FileDescriptor: {
1819
+ type: 'object',
1820
+ properties: {
1821
+ dependencies: { type: 'array', items: { $ref: '#/definitions/FileDescriptor' } },
1822
+ enumTypes: { type: 'array', items: { $ref: '#/definitions/EnumDescriptor' } },
1823
+ extensions: { type: 'array', items: { $ref: '#/definitions/FieldDescriptor' } },
1824
+ messageTypes: { type: 'array', items: { $ref: '#/definitions/Descriptor' } },
1825
+ name: { type: 'string' },
1826
+ options: { $ref: '#/definitions/FileOptions' },
1827
+ package: { type: 'string' },
1828
+ publicDependencies: { type: 'array', items: { $ref: '#/definitions/FileDescriptor' } },
1829
+ services: { type: 'array', items: { $ref: '#/definitions/ServiceDescriptor' } },
1830
+ },
1831
+ },
1832
+ 'Parser«FileOptions»': { type: 'object' },
1833
+ 'Parser«MessageLite»': { type: 'object' },
1834
+ 'Parser«ServiceOptions»': { type: 'object' },
1835
+ ProcessRuleSet: {
1836
+ type: 'object',
1837
+ properties: {
1838
+ properties: { type: 'object', additionalProperties: { type: 'string' } },
1839
+ rule_class: { type: 'string' },
1840
+ rule_id: { type: 'string' },
1841
+ rules: { type: 'array', items: { $ref: '#/definitions/ProcessRule' } },
1842
+ },
1843
+ },
1844
+ Command: {
1845
+ type: 'object',
1846
+ required: ['action', 'cId'],
1847
+ properties: {
1848
+ config: { type: 'array', items: { $ref: '#/definitions/Ioctl' } },
1849
+ options: {
1850
+ type: 'object',
1851
+ description: 'Map of options for a specific Action, for example read frequency, or value to be written',
1852
+ additionalProperties: { type: 'string' },
1853
+ },
1854
+ cId: { type: 'string', description: 'Characteristic to act on' },
1855
+ action: {
1856
+ type: 'string',
1857
+ description: "Action to perform, for Id set to 'Read'",
1858
+ enum: ['Read', 'Notify', 'Write', 'WriteWithoutResponse', 'Indicate'],
1859
+ },
1860
+ },
1861
+ description: 'Task object - describes commands to be performed on the peripheral',
1862
+ },
1863
+ UserCredentials: {
1864
+ type: 'object',
1865
+ required: ['login', 'secret'],
1866
+ properties: { login: { type: 'string' }, secret: { type: 'string' } },
1867
+ },
1868
+ CharacteristicMeta: {
1869
+ type: 'object',
1870
+ required: ['identifier'],
1871
+ properties: {
1872
+ descriptors: {
1873
+ type: 'array',
1874
+ description: 'Descriptor list',
1875
+ items: { $ref: '#/definitions/DescriptorMeta' },
1876
+ },
1877
+ properties: {
1878
+ type: 'array',
1879
+ description: 'Actions allowed on this characteristic',
1880
+ items: {
1881
+ type: 'string',
1882
+ enum: [
1883
+ 'Broadcast',
1884
+ 'Read',
1885
+ 'WriteWithoutResponse',
1886
+ 'Write',
1887
+ 'Notify',
1888
+ 'Indicate',
1889
+ 'SignedWrite',
1890
+ 'ExtendedProperties',
1891
+ 'NotifyEncryptionRequired',
1892
+ 'IndicateEncryptionRequired',
1893
+ 'WritableAuxiliaries',
1894
+ ],
1895
+ },
1896
+ },
1897
+ unitType: { type: 'string', description: 'Unit type of the characteristic' },
1898
+ identifier: { type: 'string', description: 'identifier' },
1899
+ type: { type: 'string', description: 'type' },
1900
+ name: { type: 'string', description: 'name' },
1901
+ },
1902
+ description: 'Base Metadata Object Type',
1903
+ },
1904
+ NotifEvent: { type: 'object', properties: { unknownFields: { $ref: '#/definitions/UnknownFieldSet' } } },
1905
+ },
1906
+ };