openlayer 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (276) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/openlayer/client.rb +8 -0
  5. data/lib/openlayer/models/background_task_retrieve_params.rb +20 -0
  6. data/lib/openlayer/models/background_task_retrieve_response.rb +85 -0
  7. data/lib/openlayer/models/governance/framework_create_params.rb +143 -0
  8. data/lib/openlayer/models/governance/framework_create_response.rb +412 -0
  9. data/lib/openlayer/models/governance/framework_export_params.rb +36 -0
  10. data/lib/openlayer/models/governance/framework_export_response.rb +32 -0
  11. data/lib/openlayer/models/governance/framework_list_params.rb +148 -0
  12. data/lib/openlayer/models/governance/framework_list_project_rule_stats_params.rb +74 -0
  13. data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb +279 -0
  14. data/lib/openlayer/models/governance/framework_list_projects_params.rb +39 -0
  15. data/lib/openlayer/models/governance/framework_list_projects_response.rb +315 -0
  16. data/lib/openlayer/models/governance/framework_list_response.rb +423 -0
  17. data/lib/openlayer/models/governance/framework_list_rules_params.rb +39 -0
  18. data/lib/openlayer/models/governance/framework_list_rules_response.rb +696 -0
  19. data/lib/openlayer/models/governance/framework_retrieve_params.rb +22 -0
  20. data/lib/openlayer/models/governance/framework_retrieve_response.rb +412 -0
  21. data/lib/openlayer/models/governance/framework_update_params.rb +200 -0
  22. data/lib/openlayer/models/governance/framework_update_response.rb +412 -0
  23. data/lib/openlayer/models/governance/frameworks/document_list_params.rb +41 -0
  24. data/lib/openlayer/models/governance/frameworks/document_list_response.rb +598 -0
  25. data/lib/openlayer/models/governance/frameworks/document_retrieve_params.rb +30 -0
  26. data/lib/openlayer/models/governance/frameworks/document_retrieve_response.rb +587 -0
  27. data/lib/openlayer/models/governance/frameworks/section_list_rules_params.rb +96 -0
  28. data/lib/openlayer/models/governance/frameworks/section_list_rules_response.rb +700 -0
  29. data/lib/openlayer/models/governance/frameworks/subsection_list_rules_params.rb +88 -0
  30. data/lib/openlayer/models/governance/frameworks/subsection_list_rules_response.rb +700 -0
  31. data/lib/openlayer/models/governance/rule_create_params.rb +173 -0
  32. data/lib/openlayer/models/governance/rule_create_response.rb +677 -0
  33. data/lib/openlayer/models/governance/rule_delete_params.rb +22 -0
  34. data/lib/openlayer/models/governance/rule_list_params.rb +231 -0
  35. data/lib/openlayer/models/governance/rule_list_response.rb +694 -0
  36. data/lib/openlayer/models/governance/rule_result_create_evidence_params.rb +69 -0
  37. data/lib/openlayer/models/governance/rule_result_create_evidence_response.rb +95 -0
  38. data/lib/openlayer/models/governance/rule_result_list_evidence_params.rb +39 -0
  39. data/lib/openlayer/models/governance/rule_result_list_evidence_response.rb +106 -0
  40. data/lib/openlayer/models/governance/rule_result_list_params.rb +149 -0
  41. data/lib/openlayer/models/governance/rule_result_list_response.rb +276 -0
  42. data/lib/openlayer/models/governance/rule_result_retrieve_params.rb +22 -0
  43. data/lib/openlayer/models/governance/rule_result_retrieve_response.rb +264 -0
  44. data/lib/openlayer/models/governance/rule_result_update_params.rb +156 -0
  45. data/lib/openlayer/models/governance/rule_result_update_response.rb +263 -0
  46. data/lib/openlayer/models/governance/rule_retrieve_params.rb +22 -0
  47. data/lib/openlayer/models/governance/rule_retrieve_response.rb +681 -0
  48. data/lib/openlayer/models/governance/rule_stat_retrieve_params.rb +39 -0
  49. data/lib/openlayer/models/governance/rule_stat_retrieve_response.rb +508 -0
  50. data/lib/openlayer/models/governance/rule_tag_list_params.rb +39 -0
  51. data/lib/openlayer/models/governance/rule_tag_list_response.rb +91 -0
  52. data/lib/openlayer/models/governance/rule_update_params.rb +78 -0
  53. data/lib/openlayer/models/governance/rule_update_response.rb +677 -0
  54. data/lib/openlayer/models/inference_pipeline_retrieve_response.rb +0 -1
  55. data/lib/openlayer/models/inference_pipeline_retrieve_sessions_response.rb +3 -0
  56. data/lib/openlayer/models/inference_pipeline_retrieve_users_response.rb +3 -0
  57. data/lib/openlayer/models/inference_pipeline_update_response.rb +0 -1
  58. data/lib/openlayer/models/project_create_response.rb +0 -1
  59. data/lib/openlayer/models/project_list_response.rb +0 -1
  60. data/lib/openlayer/models/project_update_response.rb +0 -1
  61. data/lib/openlayer/models/projects/inference_pipeline_create_params.rb +0 -1
  62. data/lib/openlayer/models/projects/inference_pipeline_create_response.rb +0 -1
  63. data/lib/openlayer/models/projects/inference_pipeline_list_response.rb +0 -1
  64. data/lib/openlayer/models/storage/presigned_url_retrieve_params.rb +28 -0
  65. data/lib/openlayer/models/storage/presigned_url_retrieve_response.rb +19 -0
  66. data/lib/openlayer/models/workspaces/api_key_create_params.rb +17 -1
  67. data/lib/openlayer/models/workspaces/api_key_create_response.rb +73 -3
  68. data/lib/openlayer/models/workspaces/api_key_delete_params.rb +28 -0
  69. data/lib/openlayer/models/workspaces/api_key_list_params.rb +22 -0
  70. data/lib/openlayer/models/workspaces/api_key_list_response.rb +134 -0
  71. data/lib/openlayer/models/workspaces/api_key_retrieve_params.rb +28 -0
  72. data/lib/openlayer/models/workspaces/api_key_retrieve_response.rb +131 -0
  73. data/lib/openlayer/models/workspaces/api_key_rotate_params.rb +56 -0
  74. data/lib/openlayer/models/workspaces/api_key_rotate_response.rb +131 -0
  75. data/lib/openlayer/models/workspaces/api_key_update_params.rb +38 -0
  76. data/lib/openlayer/models/workspaces/api_key_update_response.rb +131 -0
  77. data/lib/openlayer/models.rb +4 -0
  78. data/lib/openlayer/resources/background_tasks.rb +34 -0
  79. data/lib/openlayer/resources/commits.rb +1 -1
  80. data/lib/openlayer/resources/governance/frameworks/documents.rb +72 -0
  81. data/lib/openlayer/resources/governance/frameworks/sections.rb +68 -0
  82. data/lib/openlayer/resources/governance/frameworks/subsections.rb +65 -0
  83. data/lib/openlayer/resources/governance/frameworks.rb +292 -0
  84. data/lib/openlayer/resources/governance/rule_results.rb +187 -0
  85. data/lib/openlayer/resources/governance/rule_stats.rb +43 -0
  86. data/lib/openlayer/resources/governance/rule_tags.rb +43 -0
  87. data/lib/openlayer/resources/governance/rules.rb +210 -0
  88. data/lib/openlayer/resources/governance.rb +34 -0
  89. data/lib/openlayer/resources/inference_pipelines/rows.rb +4 -5
  90. data/lib/openlayer/resources/inference_pipelines.rb +5 -14
  91. data/lib/openlayer/resources/projects/tests.rb +3 -3
  92. data/lib/openlayer/resources/storage/presigned_url.rb +27 -1
  93. data/lib/openlayer/resources/tests.rb +1 -4
  94. data/lib/openlayer/resources/workspaces/api_keys.rb +146 -2
  95. data/lib/openlayer/resources/workspaces/invites.rb +1 -1
  96. data/lib/openlayer/resources/workspaces.rb +1 -1
  97. data/lib/openlayer/version.rb +1 -1
  98. data/lib/openlayer.rb +70 -0
  99. data/rbi/openlayer/client.rbi +6 -0
  100. data/rbi/openlayer/models/background_task_retrieve_params.rbi +38 -0
  101. data/rbi/openlayer/models/background_task_retrieve_response.rbi +105 -0
  102. data/rbi/openlayer/models/governance/framework_create_params.rbi +298 -0
  103. data/rbi/openlayer/models/governance/framework_create_response.rbi +735 -0
  104. data/rbi/openlayer/models/governance/framework_export_params.rbi +58 -0
  105. data/rbi/openlayer/models/governance/framework_export_response.rbi +48 -0
  106. data/rbi/openlayer/models/governance/framework_list_params.rbi +310 -0
  107. data/rbi/openlayer/models/governance/framework_list_project_rule_stats_params.rbi +178 -0
  108. data/rbi/openlayer/models/governance/framework_list_project_rule_stats_response.rbi +441 -0
  109. data/rbi/openlayer/models/governance/framework_list_projects_params.rbi +68 -0
  110. data/rbi/openlayer/models/governance/framework_list_projects_response.rbi +498 -0
  111. data/rbi/openlayer/models/governance/framework_list_response.rbi +776 -0
  112. data/rbi/openlayer/models/governance/framework_list_rules_params.rbi +68 -0
  113. data/rbi/openlayer/models/governance/framework_list_rules_response.rbi +1334 -0
  114. data/rbi/openlayer/models/governance/framework_retrieve_params.rbi +40 -0
  115. data/rbi/openlayer/models/governance/framework_retrieve_response.rbi +735 -0
  116. data/rbi/openlayer/models/governance/framework_update_params.rbi +425 -0
  117. data/rbi/openlayer/models/governance/framework_update_response.rbi +735 -0
  118. data/rbi/openlayer/models/governance/frameworks/document_list_params.rbi +70 -0
  119. data/rbi/openlayer/models/governance/frameworks/document_list_response.rbi +1050 -0
  120. data/rbi/openlayer/models/governance/frameworks/document_retrieve_params.rbi +50 -0
  121. data/rbi/openlayer/models/governance/frameworks/document_retrieve_response.rbi +1006 -0
  122. data/rbi/openlayer/models/governance/frameworks/section_list_rules_params.rbi +193 -0
  123. data/rbi/openlayer/models/governance/frameworks/section_list_rules_response.rbi +1338 -0
  124. data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_params.rbi +182 -0
  125. data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_response.rbi +1338 -0
  126. data/rbi/openlayer/models/governance/rule_create_params.rbi +291 -0
  127. data/rbi/openlayer/models/governance/rule_create_response.rbi +1289 -0
  128. data/rbi/openlayer/models/governance/rule_delete_params.rbi +40 -0
  129. data/rbi/openlayer/models/governance/rule_list_params.rbi +486 -0
  130. data/rbi/openlayer/models/governance/rule_list_response.rbi +1330 -0
  131. data/rbi/openlayer/models/governance/rule_result_create_evidence_params.rbi +90 -0
  132. data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi +113 -0
  133. data/rbi/openlayer/models/governance/rule_result_list_evidence_params.rbi +68 -0
  134. data/rbi/openlayer/models/governance/rule_result_list_evidence_response.rbi +156 -0
  135. data/rbi/openlayer/models/governance/rule_result_list_params.rbi +322 -0
  136. data/rbi/openlayer/models/governance/rule_result_list_response.rbi +580 -0
  137. data/rbi/openlayer/models/governance/rule_result_retrieve_params.rbi +43 -0
  138. data/rbi/openlayer/models/governance/rule_result_retrieve_response.rbi +537 -0
  139. data/rbi/openlayer/models/governance/rule_result_update_params.rbi +381 -0
  140. data/rbi/openlayer/models/governance/rule_result_update_response.rbi +537 -0
  141. data/rbi/openlayer/models/governance/rule_retrieve_params.rbi +40 -0
  142. data/rbi/openlayer/models/governance/rule_retrieve_response.rbi +1289 -0
  143. data/rbi/openlayer/models/governance/rule_stat_retrieve_params.rbi +68 -0
  144. data/rbi/openlayer/models/governance/rule_stat_retrieve_response.rbi +877 -0
  145. data/rbi/openlayer/models/governance/rule_tag_list_params.rbi +68 -0
  146. data/rbi/openlayer/models/governance/rule_tag_list_response.rbi +141 -0
  147. data/rbi/openlayer/models/governance/rule_update_params.rbi +108 -0
  148. data/rbi/openlayer/models/governance/rule_update_response.rbi +1289 -0
  149. data/rbi/openlayer/models/inference_pipeline_retrieve_response.rbi +0 -5
  150. data/rbi/openlayer/models/inference_pipeline_retrieve_sessions_response.rbi +2 -0
  151. data/rbi/openlayer/models/inference_pipeline_retrieve_users_response.rbi +2 -0
  152. data/rbi/openlayer/models/inference_pipeline_update_response.rbi +0 -5
  153. data/rbi/openlayer/models/project_create_response.rbi +0 -5
  154. data/rbi/openlayer/models/project_list_response.rbi +0 -5
  155. data/rbi/openlayer/models/project_update_response.rbi +0 -5
  156. data/rbi/openlayer/models/projects/inference_pipeline_create_params.rbi +0 -5
  157. data/rbi/openlayer/models/projects/inference_pipeline_create_response.rbi +0 -5
  158. data/rbi/openlayer/models/projects/inference_pipeline_list_response.rbi +0 -5
  159. data/rbi/openlayer/models/storage/presigned_url_retrieve_params.rbi +47 -0
  160. data/rbi/openlayer/models/storage/presigned_url_retrieve_response.rbi +32 -0
  161. data/rbi/openlayer/models/workspaces/api_key_create_params.rbi +18 -0
  162. data/rbi/openlayer/models/workspaces/api_key_create_response.rbi +117 -5
  163. data/rbi/openlayer/models/workspaces/api_key_delete_params.rbi +48 -0
  164. data/rbi/openlayer/models/workspaces/api_key_list_params.rbi +40 -0
  165. data/rbi/openlayer/models/workspaces/api_key_list_response.rbi +202 -0
  166. data/rbi/openlayer/models/workspaces/api_key_retrieve_params.rbi +48 -0
  167. data/rbi/openlayer/models/workspaces/api_key_retrieve_response.rbi +194 -0
  168. data/rbi/openlayer/models/workspaces/api_key_rotate_params.rbi +85 -0
  169. data/rbi/openlayer/models/workspaces/api_key_rotate_response.rbi +194 -0
  170. data/rbi/openlayer/models/workspaces/api_key_update_params.rbi +60 -0
  171. data/rbi/openlayer/models/workspaces/api_key_update_response.rbi +194 -0
  172. data/rbi/openlayer/models.rbi +4 -0
  173. data/rbi/openlayer/resources/background_tasks.rbi +26 -0
  174. data/rbi/openlayer/resources/commits.rbi +1 -1
  175. data/rbi/openlayer/resources/governance/frameworks/documents.rbi +57 -0
  176. data/rbi/openlayer/resources/governance/frameworks/sections.rbi +56 -0
  177. data/rbi/openlayer/resources/governance/frameworks/subsections.rbi +52 -0
  178. data/rbi/openlayer/resources/governance/frameworks.rbi +261 -0
  179. data/rbi/openlayer/resources/governance/rule_results.rbi +167 -0
  180. data/rbi/openlayer/resources/governance/rule_stats.rbi +34 -0
  181. data/rbi/openlayer/resources/governance/rule_tags.rbi +34 -0
  182. data/rbi/openlayer/resources/governance/rules.rbi +209 -0
  183. data/rbi/openlayer/resources/governance.rbi +27 -0
  184. data/rbi/openlayer/resources/inference_pipelines/rows.rbi +4 -5
  185. data/rbi/openlayer/resources/inference_pipelines.rbi +5 -14
  186. data/rbi/openlayer/resources/projects/tests.rbi +3 -3
  187. data/rbi/openlayer/resources/storage/presigned_url.rbi +16 -1
  188. data/rbi/openlayer/resources/tests.rbi +1 -4
  189. data/rbi/openlayer/resources/workspaces/api_keys.rbi +110 -1
  190. data/rbi/openlayer/resources/workspaces/invites.rbi +1 -1
  191. data/rbi/openlayer/resources/workspaces.rbi +1 -1
  192. data/sig/openlayer/client.rbs +4 -0
  193. data/sig/openlayer/models/background_task_retrieve_params.rbs +23 -0
  194. data/sig/openlayer/models/background_task_retrieve_response.rbs +55 -0
  195. data/sig/openlayer/models/governance/framework_create_params.rbs +124 -0
  196. data/sig/openlayer/models/governance/framework_create_response.rbs +293 -0
  197. data/sig/openlayer/models/governance/framework_export_params.rbs +30 -0
  198. data/sig/openlayer/models/governance/framework_export_response.rbs +21 -0
  199. data/sig/openlayer/models/governance/framework_list_params.rbs +145 -0
  200. data/sig/openlayer/models/governance/framework_list_project_rule_stats_params.rbs +87 -0
  201. data/sig/openlayer/models/governance/framework_list_project_rule_stats_response.rbs +232 -0
  202. data/sig/openlayer/models/governance/framework_list_projects_params.rbs +38 -0
  203. data/sig/openlayer/models/governance/framework_list_projects_response.rbs +248 -0
  204. data/sig/openlayer/models/governance/framework_list_response.rbs +314 -0
  205. data/sig/openlayer/models/governance/framework_list_rules_params.rbs +38 -0
  206. data/sig/openlayer/models/governance/framework_list_rules_response.rbs +547 -0
  207. data/sig/openlayer/models/governance/framework_retrieve_params.rbs +25 -0
  208. data/sig/openlayer/models/governance/framework_retrieve_response.rbs +293 -0
  209. data/sig/openlayer/models/governance/framework_update_params.rbs +175 -0
  210. data/sig/openlayer/models/governance/framework_update_response.rbs +293 -0
  211. data/sig/openlayer/models/governance/frameworks/document_list_params.rbs +40 -0
  212. data/sig/openlayer/models/governance/frameworks/document_list_response.rbs +435 -0
  213. data/sig/openlayer/models/governance/frameworks/document_retrieve_params.rbs +32 -0
  214. data/sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs +418 -0
  215. data/sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs +102 -0
  216. data/sig/openlayer/models/governance/frameworks/section_list_rules_response.rbs +549 -0
  217. data/sig/openlayer/models/governance/frameworks/subsection_list_rules_params.rbs +95 -0
  218. data/sig/openlayer/models/governance/frameworks/subsection_list_rules_response.rbs +549 -0
  219. data/sig/openlayer/models/governance/rule_create_params.rbs +120 -0
  220. data/sig/openlayer/models/governance/rule_create_response.rbs +530 -0
  221. data/sig/openlayer/models/governance/rule_delete_params.rbs +25 -0
  222. data/sig/openlayer/models/governance/rule_list_params.rbs +228 -0
  223. data/sig/openlayer/models/governance/rule_list_response.rbs +547 -0
  224. data/sig/openlayer/models/governance/rule_result_create_evidence_params.rbs +53 -0
  225. data/sig/openlayer/models/governance/rule_result_create_evidence_response.rbs +62 -0
  226. data/sig/openlayer/models/governance/rule_result_list_evidence_params.rbs +38 -0
  227. data/sig/openlayer/models/governance/rule_result_list_evidence_response.rbs +79 -0
  228. data/sig/openlayer/models/governance/rule_result_list_params.rbs +156 -0
  229. data/sig/openlayer/models/governance/rule_result_list_response.rbs +252 -0
  230. data/sig/openlayer/models/governance/rule_result_retrieve_params.rbs +26 -0
  231. data/sig/openlayer/models/governance/rule_result_retrieve_response.rbs +235 -0
  232. data/sig/openlayer/models/governance/rule_result_update_params.rbs +165 -0
  233. data/sig/openlayer/models/governance/rule_result_update_response.rbs +235 -0
  234. data/sig/openlayer/models/governance/rule_retrieve_params.rbs +25 -0
  235. data/sig/openlayer/models/governance/rule_retrieve_response.rbs +530 -0
  236. data/sig/openlayer/models/governance/rule_stat_retrieve_params.rbs +38 -0
  237. data/sig/openlayer/models/governance/rule_stat_retrieve_response.rbs +434 -0
  238. data/sig/openlayer/models/governance/rule_tag_list_params.rbs +38 -0
  239. data/sig/openlayer/models/governance/rule_tag_list_response.rbs +74 -0
  240. data/sig/openlayer/models/governance/rule_update_params.rbs +62 -0
  241. data/sig/openlayer/models/governance/rule_update_response.rbs +530 -0
  242. data/sig/openlayer/models/inference_pipeline_retrieve_response.rbs +1 -2
  243. data/sig/openlayer/models/inference_pipeline_update_response.rbs +1 -2
  244. data/sig/openlayer/models/project_create_response.rbs +1 -2
  245. data/sig/openlayer/models/project_list_response.rbs +1 -2
  246. data/sig/openlayer/models/project_update_response.rbs +1 -2
  247. data/sig/openlayer/models/projects/inference_pipeline_create_params.rbs +1 -2
  248. data/sig/openlayer/models/projects/inference_pipeline_create_response.rbs +1 -2
  249. data/sig/openlayer/models/projects/inference_pipeline_list_response.rbs +1 -2
  250. data/sig/openlayer/models/storage/presigned_url_retrieve_params.rbs +25 -0
  251. data/sig/openlayer/models/storage/presigned_url_retrieve_response.rbs +15 -0
  252. data/sig/openlayer/models/workspaces/api_key_create_params.rbs +5 -1
  253. data/sig/openlayer/models/workspaces/api_key_create_response.rbs +42 -3
  254. data/sig/openlayer/models/workspaces/api_key_delete_params.rbs +30 -0
  255. data/sig/openlayer/models/workspaces/api_key_list_params.rbs +25 -0
  256. data/sig/openlayer/models/workspaces/api_key_list_response.rbs +91 -0
  257. data/sig/openlayer/models/workspaces/api_key_retrieve_params.rbs +30 -0
  258. data/sig/openlayer/models/workspaces/api_key_retrieve_response.rbs +86 -0
  259. data/sig/openlayer/models/workspaces/api_key_rotate_params.rbs +45 -0
  260. data/sig/openlayer/models/workspaces/api_key_rotate_response.rbs +86 -0
  261. data/sig/openlayer/models/workspaces/api_key_update_params.rbs +34 -0
  262. data/sig/openlayer/models/workspaces/api_key_update_response.rbs +86 -0
  263. data/sig/openlayer/models.rbs +4 -0
  264. data/sig/openlayer/resources/background_tasks.rbs +12 -0
  265. data/sig/openlayer/resources/governance/frameworks/documents.rbs +24 -0
  266. data/sig/openlayer/resources/governance/frameworks/sections.rbs +23 -0
  267. data/sig/openlayer/resources/governance/frameworks/subsections.rbs +22 -0
  268. data/sig/openlayer/resources/governance/frameworks.rbs +88 -0
  269. data/sig/openlayer/resources/governance/rule_results.rbs +57 -0
  270. data/sig/openlayer/resources/governance/rule_stats.rbs +16 -0
  271. data/sig/openlayer/resources/governance/rule_tags.rbs +16 -0
  272. data/sig/openlayer/resources/governance/rules.rbs +68 -0
  273. data/sig/openlayer/resources/governance.rbs +17 -0
  274. data/sig/openlayer/resources/storage/presigned_url.rbs +5 -0
  275. data/sig/openlayer/resources/workspaces/api_keys.rbs +33 -0
  276. metadata +212 -2
@@ -0,0 +1,1338 @@
1
+ # typed: strong
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ module Frameworks
7
+ class SectionListRulesResponse < Openlayer::Internal::Type::BaseModel
8
+ OrHash =
9
+ T.type_alias do
10
+ T.any(
11
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse,
12
+ Openlayer::Internal::AnyHash
13
+ )
14
+ end
15
+
16
+ sig do
17
+ returns(
18
+ T::Array[
19
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item
20
+ ]
21
+ )
22
+ end
23
+ attr_accessor :items
24
+
25
+ sig do
26
+ params(
27
+ items:
28
+ T::Array[
29
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::OrHash
30
+ ]
31
+ ).returns(T.attached_class)
32
+ end
33
+ def self.new(items:)
34
+ end
35
+
36
+ sig do
37
+ override.returns(
38
+ {
39
+ items:
40
+ T::Array[
41
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item
42
+ ]
43
+ }
44
+ )
45
+ end
46
+ def to_hash
47
+ end
48
+
49
+ class Item < Openlayer::Internal::Type::BaseModel
50
+ OrHash =
51
+ T.type_alias do
52
+ T.any(
53
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item,
54
+ Openlayer::Internal::AnyHash
55
+ )
56
+ end
57
+
58
+ # The rule name.
59
+ sig { returns(String) }
60
+ attr_accessor :name
61
+
62
+ # Whether the rule is evaluated once for the whole workspace, or once per project
63
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
64
+ # the rule is created.
65
+ sig do
66
+ returns(
67
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::TaggedSymbol
68
+ )
69
+ end
70
+ attr_accessor :scope
71
+
72
+ # `platform` rules are evaluated automatically from the state of your Openlayer
73
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
74
+ # rule is created.
75
+ sig do
76
+ returns(
77
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::TaggedSymbol
78
+ )
79
+ end
80
+ attr_accessor :type
81
+
82
+ # The user responsible for satisfying the rule.
83
+ sig { returns(T.nilable(String)) }
84
+ attr_accessor :assignee_id
85
+
86
+ # Configuration for the platform check, when the automation takes parameters. Omit
87
+ # or `null` for evidence rules. Fixed once the rule is created.
88
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
89
+ attr_accessor :automation_params
90
+
91
+ # Which workspace signal a platform rule checks, for example
92
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
93
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
94
+ # created.
95
+ sig { returns(T.nilable(String)) }
96
+ attr_accessor :automation_type
97
+
98
+ # Whether the rule is excluded from compliance calculations.
99
+ sig { returns(T.nilable(T::Boolean)) }
100
+ attr_reader :deactivated
101
+
102
+ sig { params(deactivated: T::Boolean).void }
103
+ attr_writer :deactivated
104
+
105
+ # What the rule requires.
106
+ sig { returns(T.nilable(String)) }
107
+ attr_accessor :description
108
+
109
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
110
+ # `null` for platform rules. Fixed once the rule is created.
111
+ sig do
112
+ returns(
113
+ T.nilable(
114
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
115
+ )
116
+ )
117
+ end
118
+ attr_accessor :evidence_type
119
+
120
+ # How often evidence must be renewed, in days. Once evidence is older than this,
121
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
122
+ # whenever evidence is attached. Omit or `null` for platform rules.
123
+ sig { returns(T.nilable(Integer)) }
124
+ attr_accessor :renewal_cadence_days
125
+
126
+ # The rule id.
127
+ sig { returns(String) }
128
+ attr_accessor :id
129
+
130
+ # The creation date.
131
+ sig { returns(Time) }
132
+ attr_accessor :date_created
133
+
134
+ # The last update date.
135
+ sig { returns(Time) }
136
+ attr_accessor :date_updated
137
+
138
+ # The id of the workspace the rule belongs to.
139
+ sig { returns(String) }
140
+ attr_accessor :workspace_id
141
+
142
+ # The frameworks that include this rule.
143
+ sig do
144
+ returns(
145
+ T.nilable(
146
+ T::Array[
147
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework
148
+ ]
149
+ )
150
+ )
151
+ end
152
+ attr_reader :frameworks
153
+
154
+ sig do
155
+ params(
156
+ frameworks:
157
+ T::Array[
158
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::OrHash
159
+ ]
160
+ ).void
161
+ end
162
+ attr_writer :frameworks
163
+
164
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
165
+ # deleted; set `deactivated` to exclude one from compliance instead.
166
+ sig { returns(T.nilable(T::Boolean)) }
167
+ attr_reader :immutable
168
+
169
+ sig { params(immutable: T::Boolean).void }
170
+ attr_writer :immutable
171
+
172
+ # The rule's results, one per entity the rule is evaluated against. Only returned
173
+ # when `includeResults` is `true`.
174
+ sig do
175
+ returns(
176
+ T.nilable(
177
+ T::Array[
178
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result
179
+ ]
180
+ )
181
+ )
182
+ end
183
+ attr_reader :results
184
+
185
+ sig do
186
+ params(
187
+ results:
188
+ T::Array[
189
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::OrHash
190
+ ]
191
+ ).void
192
+ end
193
+ attr_writer :results
194
+
195
+ # Pass-rate counts across all of the rule's entities, independent of any status
196
+ # filter applied to the request.
197
+ sig do
198
+ returns(
199
+ T.nilable(
200
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::ResultsSummary
201
+ )
202
+ )
203
+ end
204
+ attr_reader :results_summary
205
+
206
+ sig do
207
+ params(
208
+ results_summary:
209
+ T.nilable(
210
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::ResultsSummary::OrHash
211
+ )
212
+ ).void
213
+ end
214
+ attr_writer :results_summary
215
+
216
+ # The rule tags associated with the rule.
217
+ sig do
218
+ returns(
219
+ T.nilable(
220
+ T::Array[
221
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Tag
222
+ ]
223
+ )
224
+ )
225
+ end
226
+ attr_accessor :tags
227
+
228
+ # A single requirement Openlayer tracks. `platform` rules are evaluated
229
+ # automatically from the state of your workspace, and `evidence` rules are
230
+ # satisfied by attaching evidence. A rule can belong to several frameworks, or to
231
+ # none.
232
+ sig do
233
+ params(
234
+ id: String,
235
+ date_created: Time,
236
+ date_updated: Time,
237
+ name: String,
238
+ scope:
239
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::OrSymbol,
240
+ type:
241
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::OrSymbol,
242
+ workspace_id: String,
243
+ assignee_id: T.nilable(String),
244
+ automation_params: T.nilable(T::Hash[Symbol, T.anything]),
245
+ automation_type: T.nilable(String),
246
+ deactivated: T::Boolean,
247
+ description: T.nilable(String),
248
+ evidence_type:
249
+ T.nilable(
250
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::OrSymbol
251
+ ),
252
+ frameworks:
253
+ T::Array[
254
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::OrHash
255
+ ],
256
+ immutable: T::Boolean,
257
+ renewal_cadence_days: T.nilable(Integer),
258
+ results:
259
+ T::Array[
260
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::OrHash
261
+ ],
262
+ results_summary:
263
+ T.nilable(
264
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::ResultsSummary::OrHash
265
+ ),
266
+ tags:
267
+ T.nilable(
268
+ T::Array[
269
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Tag::OrHash
270
+ ]
271
+ )
272
+ ).returns(T.attached_class)
273
+ end
274
+ def self.new(
275
+ # The rule id.
276
+ id:,
277
+ # The creation date.
278
+ date_created:,
279
+ # The last update date.
280
+ date_updated:,
281
+ # The rule name.
282
+ name:,
283
+ # Whether the rule is evaluated once for the whole workspace, or once per project
284
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
285
+ # the rule is created.
286
+ scope:,
287
+ # `platform` rules are evaluated automatically from the state of your Openlayer
288
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
289
+ # rule is created.
290
+ type:,
291
+ # The id of the workspace the rule belongs to.
292
+ workspace_id:,
293
+ # The user responsible for satisfying the rule.
294
+ assignee_id: nil,
295
+ # Configuration for the platform check, when the automation takes parameters. Omit
296
+ # or `null` for evidence rules. Fixed once the rule is created.
297
+ automation_params: nil,
298
+ # Which workspace signal a platform rule checks, for example
299
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
300
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
301
+ # created.
302
+ automation_type: nil,
303
+ # Whether the rule is excluded from compliance calculations.
304
+ deactivated: nil,
305
+ # What the rule requires.
306
+ description: nil,
307
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
308
+ # `null` for platform rules. Fixed once the rule is created.
309
+ evidence_type: nil,
310
+ # The frameworks that include this rule.
311
+ frameworks: nil,
312
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
313
+ # deleted; set `deactivated` to exclude one from compliance instead.
314
+ immutable: nil,
315
+ # How often evidence must be renewed, in days. Once evidence is older than this,
316
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
317
+ # whenever evidence is attached. Omit or `null` for platform rules.
318
+ renewal_cadence_days: nil,
319
+ # The rule's results, one per entity the rule is evaluated against. Only returned
320
+ # when `includeResults` is `true`.
321
+ results: nil,
322
+ # Pass-rate counts across all of the rule's entities, independent of any status
323
+ # filter applied to the request.
324
+ results_summary: nil,
325
+ # The rule tags associated with the rule.
326
+ tags: nil
327
+ )
328
+ end
329
+
330
+ sig do
331
+ override.returns(
332
+ {
333
+ id: String,
334
+ date_created: Time,
335
+ date_updated: Time,
336
+ name: String,
337
+ scope:
338
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::TaggedSymbol,
339
+ type:
340
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::TaggedSymbol,
341
+ workspace_id: String,
342
+ assignee_id: T.nilable(String),
343
+ automation_params: T.nilable(T::Hash[Symbol, T.anything]),
344
+ automation_type: T.nilable(String),
345
+ deactivated: T::Boolean,
346
+ description: T.nilable(String),
347
+ evidence_type:
348
+ T.nilable(
349
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
350
+ ),
351
+ frameworks:
352
+ T::Array[
353
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework
354
+ ],
355
+ immutable: T::Boolean,
356
+ renewal_cadence_days: T.nilable(Integer),
357
+ results:
358
+ T::Array[
359
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result
360
+ ],
361
+ results_summary:
362
+ T.nilable(
363
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::ResultsSummary
364
+ ),
365
+ tag_ids: T.nilable(T::Array[String]),
366
+ tags:
367
+ T.nilable(
368
+ T::Array[
369
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Tag
370
+ ]
371
+ )
372
+ }
373
+ )
374
+ end
375
+ def to_hash
376
+ end
377
+
378
+ # Whether the rule is evaluated once for the whole workspace, or once per project
379
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
380
+ # the rule is created.
381
+ module Scope
382
+ extend Openlayer::Internal::Type::Enum
383
+
384
+ TaggedSymbol =
385
+ T.type_alias do
386
+ T.all(
387
+ Symbol,
388
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope
389
+ )
390
+ end
391
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
392
+
393
+ PROJECT =
394
+ T.let(
395
+ :project,
396
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::TaggedSymbol
397
+ )
398
+ WORKSPACE =
399
+ T.let(
400
+ :workspace,
401
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::TaggedSymbol
402
+ )
403
+
404
+ sig do
405
+ override.returns(
406
+ T::Array[
407
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Scope::TaggedSymbol
408
+ ]
409
+ )
410
+ end
411
+ def self.values
412
+ end
413
+ end
414
+
415
+ # `platform` rules are evaluated automatically from the state of your Openlayer
416
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
417
+ # rule is created.
418
+ module Type
419
+ extend Openlayer::Internal::Type::Enum
420
+
421
+ TaggedSymbol =
422
+ T.type_alias do
423
+ T.all(
424
+ Symbol,
425
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type
426
+ )
427
+ end
428
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
429
+
430
+ PLATFORM =
431
+ T.let(
432
+ :platform,
433
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::TaggedSymbol
434
+ )
435
+ EVIDENCE =
436
+ T.let(
437
+ :evidence,
438
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::TaggedSymbol
439
+ )
440
+
441
+ sig do
442
+ override.returns(
443
+ T::Array[
444
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Type::TaggedSymbol
445
+ ]
446
+ )
447
+ end
448
+ def self.values
449
+ end
450
+ end
451
+
452
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
453
+ # `null` for platform rules. Fixed once the rule is created.
454
+ module EvidenceType
455
+ extend Openlayer::Internal::Type::Enum
456
+
457
+ TaggedSymbol =
458
+ T.type_alias do
459
+ T.all(
460
+ Symbol,
461
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType
462
+ )
463
+ end
464
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
465
+
466
+ DOCUMENT =
467
+ T.let(
468
+ :document,
469
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
470
+ )
471
+ TEXT =
472
+ T.let(
473
+ :text,
474
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
475
+ )
476
+ URL =
477
+ T.let(
478
+ :url,
479
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
480
+ )
481
+ CATEGORY_VALUE =
482
+ T.let(
483
+ :categoryValue,
484
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
485
+ )
486
+
487
+ sig do
488
+ override.returns(
489
+ T::Array[
490
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::EvidenceType::TaggedSymbol
491
+ ]
492
+ )
493
+ end
494
+ def self.values
495
+ end
496
+ end
497
+
498
+ class Framework < Openlayer::Internal::Type::BaseModel
499
+ OrHash =
500
+ T.type_alias do
501
+ T.any(
502
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework,
503
+ Openlayer::Internal::AnyHash
504
+ )
505
+ end
506
+
507
+ # The icon shown for the framework.
508
+ sig do
509
+ returns(
510
+ T.nilable(
511
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar
512
+ )
513
+ )
514
+ end
515
+ attr_reader :avatar
516
+
517
+ sig do
518
+ params(
519
+ avatar:
520
+ T.nilable(
521
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::OrHash
522
+ )
523
+ ).void
524
+ end
525
+ attr_writer :avatar
526
+
527
+ # Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
528
+ # `iso_42001`, `nist_ai_rmf`, or `traiga`. `null` for frameworks you create
529
+ # yourself.
530
+ sig { returns(T.nilable(String)) }
531
+ attr_accessor :built_in_slug
532
+
533
+ # Whether the framework is active. Rules of a disabled framework are not evaluated
534
+ # and do not count towards compliance.
535
+ sig { returns(T::Boolean) }
536
+ attr_accessor :enabled
537
+
538
+ # The framework name.
539
+ sig { returns(String) }
540
+ attr_accessor :name
541
+
542
+ # The framework id.
543
+ sig { returns(String) }
544
+ attr_accessor :id
545
+
546
+ sig do
547
+ params(
548
+ id: String,
549
+ avatar:
550
+ T.nilable(
551
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::OrHash
552
+ ),
553
+ built_in_slug: T.nilable(String),
554
+ enabled: T::Boolean,
555
+ name: String
556
+ ).returns(T.attached_class)
557
+ end
558
+ def self.new(
559
+ # The framework id.
560
+ id:,
561
+ # The icon shown for the framework.
562
+ avatar:,
563
+ # Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
564
+ # `iso_42001`, `nist_ai_rmf`, or `traiga`. `null` for frameworks you create
565
+ # yourself.
566
+ built_in_slug:,
567
+ # Whether the framework is active. Rules of a disabled framework are not evaluated
568
+ # and do not count towards compliance.
569
+ enabled:,
570
+ # The framework name.
571
+ name:
572
+ )
573
+ end
574
+
575
+ sig do
576
+ override.returns(
577
+ {
578
+ id: String,
579
+ avatar:
580
+ T.nilable(
581
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar
582
+ ),
583
+ built_in_slug: T.nilable(String),
584
+ enabled: T::Boolean,
585
+ name: String
586
+ }
587
+ )
588
+ end
589
+ def to_hash
590
+ end
591
+
592
+ class Avatar < Openlayer::Internal::Type::BaseModel
593
+ OrHash =
594
+ T.type_alias do
595
+ T.any(
596
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar,
597
+ Openlayer::Internal::AnyHash
598
+ )
599
+ end
600
+
601
+ sig do
602
+ returns(
603
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::TaggedSymbol
604
+ )
605
+ end
606
+ attr_accessor :type
607
+
608
+ sig { returns(String) }
609
+ attr_accessor :value
610
+
611
+ # The icon shown for the framework.
612
+ sig do
613
+ params(
614
+ type:
615
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::OrSymbol,
616
+ value: String
617
+ ).returns(T.attached_class)
618
+ end
619
+ def self.new(type:, value:)
620
+ end
621
+
622
+ sig do
623
+ override.returns(
624
+ {
625
+ type:
626
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::TaggedSymbol,
627
+ value: String
628
+ }
629
+ )
630
+ end
631
+ def to_hash
632
+ end
633
+
634
+ module Type
635
+ extend Openlayer::Internal::Type::Enum
636
+
637
+ TaggedSymbol =
638
+ T.type_alias do
639
+ T.all(
640
+ Symbol,
641
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type
642
+ )
643
+ end
644
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
645
+
646
+ EMOJI =
647
+ T.let(
648
+ :emoji,
649
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::TaggedSymbol
650
+ )
651
+ IMAGE_URL =
652
+ T.let(
653
+ :imageUrl,
654
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::TaggedSymbol
655
+ )
656
+ BUILTIN_IMAGE =
657
+ T.let(
658
+ :builtinImage,
659
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::TaggedSymbol
660
+ )
661
+
662
+ sig do
663
+ override.returns(
664
+ T::Array[
665
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Framework::Avatar::Type::TaggedSymbol
666
+ ]
667
+ )
668
+ end
669
+ def self.values
670
+ end
671
+ end
672
+ end
673
+ end
674
+
675
+ class Result < Openlayer::Internal::Type::BaseModel
676
+ OrHash =
677
+ T.type_alias do
678
+ T.any(
679
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result,
680
+ Openlayer::Internal::AnyHash
681
+ )
682
+ end
683
+
684
+ # Whether this result is excluded from compliance calculations. Excludes just this
685
+ # result, without deactivating the rule everywhere.
686
+ sig { returns(T::Boolean) }
687
+ attr_accessor :deactivated
688
+
689
+ # The compliance status of the rule for this entity. Computed by Openlayer and
690
+ # can't be set directly.
691
+ sig do
692
+ returns(
693
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
694
+ )
695
+ end
696
+ attr_accessor :status
697
+
698
+ # The user responsible for this result.
699
+ sig { returns(T.nilable(String)) }
700
+ attr_accessor :assignee_id
701
+
702
+ # Rule results that must pass before this one can be satisfied.
703
+ sig do
704
+ returns(
705
+ T.nilable(
706
+ T::Array[
707
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy
708
+ ]
709
+ )
710
+ )
711
+ end
712
+ attr_reader :blocked_by
713
+
714
+ sig do
715
+ params(
716
+ blocked_by:
717
+ T::Array[
718
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::OrHash
719
+ ]
720
+ ).void
721
+ end
722
+ attr_writer :blocked_by
723
+
724
+ # Rule results that this one blocks.
725
+ sig do
726
+ returns(
727
+ T.nilable(
728
+ T::Array[
729
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking
730
+ ]
731
+ )
732
+ )
733
+ end
734
+ attr_reader :blocking
735
+
736
+ sig do
737
+ params(
738
+ blocking:
739
+ T::Array[
740
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::OrHash
741
+ ]
742
+ ).void
743
+ end
744
+ attr_writer :blocking
745
+
746
+ # Why the result was excluded. Required when setting `deactivated` to `true`.
747
+ sig { returns(T.nilable(String)) }
748
+ attr_accessor :deactivated_reason
749
+
750
+ # A human-readable explanation of the status.
751
+ sig { returns(T.nilable(String)) }
752
+ attr_accessor :status_message
753
+
754
+ # The rule result id.
755
+ sig { returns(String) }
756
+ attr_accessor :id
757
+
758
+ # The creation date.
759
+ sig { returns(Time) }
760
+ attr_accessor :date_created
761
+
762
+ # The last update date.
763
+ sig { returns(Time) }
764
+ attr_accessor :date_updated
765
+
766
+ # The rule this result belongs to.
767
+ sig { returns(String) }
768
+ attr_accessor :rule_id
769
+
770
+ # The id of the workspace the rule result belongs to.
771
+ sig { returns(String) }
772
+ attr_accessor :workspace_id
773
+
774
+ # When the rule was last evaluated. Platform rules only.
775
+ sig { returns(T.nilable(Time)) }
776
+ attr_accessor :date_last_evaluated
777
+
778
+ # When the most recent piece of evidence was attached. Evidence rules only.
779
+ sig { returns(T.nilable(Time)) }
780
+ attr_accessor :date_of_latest_evidence
781
+
782
+ # When the rule will next be evaluated. Platform rules only.
783
+ sig { returns(T.nilable(Time)) }
784
+ attr_accessor :date_of_next_evaluation
785
+
786
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
787
+ sig { returns(T.nilable(Time)) }
788
+ attr_accessor :date_of_renewal
789
+
790
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
791
+ sig { returns(T.nilable(String)) }
792
+ attr_accessor :project_id
793
+
794
+ # The compliance status of one rule for one entity: a project for project-scoped
795
+ # rules, or the workspace for workspace-scoped rules.
796
+ sig do
797
+ params(
798
+ id: String,
799
+ date_created: Time,
800
+ date_updated: Time,
801
+ deactivated: T::Boolean,
802
+ rule_id: String,
803
+ status:
804
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::OrSymbol,
805
+ workspace_id: String,
806
+ assignee_id: T.nilable(String),
807
+ blocked_by:
808
+ T::Array[
809
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::OrHash
810
+ ],
811
+ blocking:
812
+ T::Array[
813
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::OrHash
814
+ ],
815
+ date_last_evaluated: T.nilable(Time),
816
+ date_of_latest_evidence: T.nilable(Time),
817
+ date_of_next_evaluation: T.nilable(Time),
818
+ date_of_renewal: T.nilable(Time),
819
+ deactivated_reason: T.nilable(String),
820
+ project_id: T.nilable(String),
821
+ status_message: T.nilable(String)
822
+ ).returns(T.attached_class)
823
+ end
824
+ def self.new(
825
+ # The rule result id.
826
+ id:,
827
+ # The creation date.
828
+ date_created:,
829
+ # The last update date.
830
+ date_updated:,
831
+ # Whether this result is excluded from compliance calculations. Excludes just this
832
+ # result, without deactivating the rule everywhere.
833
+ deactivated:,
834
+ # The rule this result belongs to.
835
+ rule_id:,
836
+ # The compliance status of the rule for this entity. Computed by Openlayer and
837
+ # can't be set directly.
838
+ status:,
839
+ # The id of the workspace the rule result belongs to.
840
+ workspace_id:,
841
+ # The user responsible for this result.
842
+ assignee_id: nil,
843
+ # Rule results that must pass before this one can be satisfied.
844
+ blocked_by: nil,
845
+ # Rule results that this one blocks.
846
+ blocking: nil,
847
+ # When the rule was last evaluated. Platform rules only.
848
+ date_last_evaluated: nil,
849
+ # When the most recent piece of evidence was attached. Evidence rules only.
850
+ date_of_latest_evidence: nil,
851
+ # When the rule will next be evaluated. Platform rules only.
852
+ date_of_next_evaluation: nil,
853
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
854
+ date_of_renewal: nil,
855
+ # Why the result was excluded. Required when setting `deactivated` to `true`.
856
+ deactivated_reason: nil,
857
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
858
+ project_id: nil,
859
+ # A human-readable explanation of the status.
860
+ status_message: nil
861
+ )
862
+ end
863
+
864
+ sig do
865
+ override.returns(
866
+ {
867
+ id: String,
868
+ date_created: Time,
869
+ date_updated: Time,
870
+ deactivated: T::Boolean,
871
+ rule_id: String,
872
+ status:
873
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol,
874
+ workspace_id: String,
875
+ assignee_id: T.nilable(String),
876
+ blocked_by:
877
+ T::Array[
878
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy
879
+ ],
880
+ blocking:
881
+ T::Array[
882
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking
883
+ ],
884
+ date_last_evaluated: T.nilable(Time),
885
+ date_of_latest_evidence: T.nilable(Time),
886
+ date_of_next_evaluation: T.nilable(Time),
887
+ date_of_renewal: T.nilable(Time),
888
+ deactivated_reason: T.nilable(String),
889
+ project_id: T.nilable(String),
890
+ status_message: T.nilable(String)
891
+ }
892
+ )
893
+ end
894
+ def to_hash
895
+ end
896
+
897
+ # The compliance status of the rule for this entity. Computed by Openlayer and
898
+ # can't be set directly.
899
+ module Status
900
+ extend Openlayer::Internal::Type::Enum
901
+
902
+ TaggedSymbol =
903
+ T.type_alias do
904
+ T.all(
905
+ Symbol,
906
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status
907
+ )
908
+ end
909
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
910
+
911
+ RUNNING =
912
+ T.let(
913
+ :running,
914
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
915
+ )
916
+ PASSING =
917
+ T.let(
918
+ :passing,
919
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
920
+ )
921
+ FAILING =
922
+ T.let(
923
+ :failing,
924
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
925
+ )
926
+ SKIPPED =
927
+ T.let(
928
+ :skipped,
929
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
930
+ )
931
+ ERROR =
932
+ T.let(
933
+ :error,
934
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
935
+ )
936
+ PENDING =
937
+ T.let(
938
+ :pending,
939
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
940
+ )
941
+ DUE_SOON =
942
+ T.let(
943
+ :due_soon,
944
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
945
+ )
946
+
947
+ sig do
948
+ override.returns(
949
+ T::Array[
950
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Status::TaggedSymbol
951
+ ]
952
+ )
953
+ end
954
+ def self.values
955
+ end
956
+ end
957
+
958
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
959
+ OrHash =
960
+ T.type_alias do
961
+ T.any(
962
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy,
963
+ Openlayer::Internal::AnyHash
964
+ )
965
+ end
966
+
967
+ sig { returns(T.nilable(String)) }
968
+ attr_reader :id
969
+
970
+ sig { params(id: String).void }
971
+ attr_writer :id
972
+
973
+ # The compliance status of the rule for this entity. Computed by Openlayer and
974
+ # can't be set directly.
975
+ sig do
976
+ returns(
977
+ T.nilable(
978
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
979
+ )
980
+ )
981
+ end
982
+ attr_reader :status
983
+
984
+ sig do
985
+ params(
986
+ status:
987
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::OrSymbol
988
+ ).void
989
+ end
990
+ attr_writer :status
991
+
992
+ sig do
993
+ params(
994
+ id: String,
995
+ status:
996
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::OrSymbol
997
+ ).returns(T.attached_class)
998
+ end
999
+ def self.new(
1000
+ id: nil,
1001
+ # The compliance status of the rule for this entity. Computed by Openlayer and
1002
+ # can't be set directly.
1003
+ status: nil
1004
+ )
1005
+ end
1006
+
1007
+ sig do
1008
+ override.returns(
1009
+ {
1010
+ id: String,
1011
+ status:
1012
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1013
+ }
1014
+ )
1015
+ end
1016
+ def to_hash
1017
+ end
1018
+
1019
+ # The compliance status of the rule for this entity. Computed by Openlayer and
1020
+ # can't be set directly.
1021
+ module Status
1022
+ extend Openlayer::Internal::Type::Enum
1023
+
1024
+ TaggedSymbol =
1025
+ T.type_alias do
1026
+ T.all(
1027
+ Symbol,
1028
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status
1029
+ )
1030
+ end
1031
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1032
+
1033
+ RUNNING =
1034
+ T.let(
1035
+ :running,
1036
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1037
+ )
1038
+ PASSING =
1039
+ T.let(
1040
+ :passing,
1041
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1042
+ )
1043
+ FAILING =
1044
+ T.let(
1045
+ :failing,
1046
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1047
+ )
1048
+ SKIPPED =
1049
+ T.let(
1050
+ :skipped,
1051
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1052
+ )
1053
+ ERROR =
1054
+ T.let(
1055
+ :error,
1056
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1057
+ )
1058
+ PENDING =
1059
+ T.let(
1060
+ :pending,
1061
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1062
+ )
1063
+ DUE_SOON =
1064
+ T.let(
1065
+ :due_soon,
1066
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1067
+ )
1068
+
1069
+ sig do
1070
+ override.returns(
1071
+ T::Array[
1072
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::BlockedBy::Status::TaggedSymbol
1073
+ ]
1074
+ )
1075
+ end
1076
+ def self.values
1077
+ end
1078
+ end
1079
+ end
1080
+
1081
+ class Blocking < Openlayer::Internal::Type::BaseModel
1082
+ OrHash =
1083
+ T.type_alias do
1084
+ T.any(
1085
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking,
1086
+ Openlayer::Internal::AnyHash
1087
+ )
1088
+ end
1089
+
1090
+ sig { returns(T.nilable(String)) }
1091
+ attr_reader :id
1092
+
1093
+ sig { params(id: String).void }
1094
+ attr_writer :id
1095
+
1096
+ # The compliance status of the rule for this entity. Computed by Openlayer and
1097
+ # can't be set directly.
1098
+ sig do
1099
+ returns(
1100
+ T.nilable(
1101
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1102
+ )
1103
+ )
1104
+ end
1105
+ attr_reader :status
1106
+
1107
+ sig do
1108
+ params(
1109
+ status:
1110
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::OrSymbol
1111
+ ).void
1112
+ end
1113
+ attr_writer :status
1114
+
1115
+ sig do
1116
+ params(
1117
+ id: String,
1118
+ status:
1119
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::OrSymbol
1120
+ ).returns(T.attached_class)
1121
+ end
1122
+ def self.new(
1123
+ id: nil,
1124
+ # The compliance status of the rule for this entity. Computed by Openlayer and
1125
+ # can't be set directly.
1126
+ status: nil
1127
+ )
1128
+ end
1129
+
1130
+ sig do
1131
+ override.returns(
1132
+ {
1133
+ id: String,
1134
+ status:
1135
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1136
+ }
1137
+ )
1138
+ end
1139
+ def to_hash
1140
+ end
1141
+
1142
+ # The compliance status of the rule for this entity. Computed by Openlayer and
1143
+ # can't be set directly.
1144
+ module Status
1145
+ extend Openlayer::Internal::Type::Enum
1146
+
1147
+ TaggedSymbol =
1148
+ T.type_alias do
1149
+ T.all(
1150
+ Symbol,
1151
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status
1152
+ )
1153
+ end
1154
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1155
+
1156
+ RUNNING =
1157
+ T.let(
1158
+ :running,
1159
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1160
+ )
1161
+ PASSING =
1162
+ T.let(
1163
+ :passing,
1164
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1165
+ )
1166
+ FAILING =
1167
+ T.let(
1168
+ :failing,
1169
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1170
+ )
1171
+ SKIPPED =
1172
+ T.let(
1173
+ :skipped,
1174
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1175
+ )
1176
+ ERROR =
1177
+ T.let(
1178
+ :error,
1179
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1180
+ )
1181
+ PENDING =
1182
+ T.let(
1183
+ :pending,
1184
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1185
+ )
1186
+ DUE_SOON =
1187
+ T.let(
1188
+ :due_soon,
1189
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1190
+ )
1191
+
1192
+ sig do
1193
+ override.returns(
1194
+ T::Array[
1195
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Result::Blocking::Status::TaggedSymbol
1196
+ ]
1197
+ )
1198
+ end
1199
+ def self.values
1200
+ end
1201
+ end
1202
+ end
1203
+ end
1204
+
1205
+ class ResultsSummary < Openlayer::Internal::Type::BaseModel
1206
+ OrHash =
1207
+ T.type_alias do
1208
+ T.any(
1209
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::ResultsSummary,
1210
+ Openlayer::Internal::AnyHash
1211
+ )
1212
+ end
1213
+
1214
+ sig { returns(T.nilable(Integer)) }
1215
+ attr_reader :passing
1216
+
1217
+ sig { params(passing: Integer).void }
1218
+ attr_writer :passing
1219
+
1220
+ sig { returns(T.nilable(Integer)) }
1221
+ attr_reader :total
1222
+
1223
+ sig { params(total: Integer).void }
1224
+ attr_writer :total
1225
+
1226
+ # Pass-rate counts across all of the rule's entities, independent of any status
1227
+ # filter applied to the request.
1228
+ sig do
1229
+ params(passing: Integer, total: Integer).returns(
1230
+ T.attached_class
1231
+ )
1232
+ end
1233
+ def self.new(passing: nil, total: nil)
1234
+ end
1235
+
1236
+ sig { override.returns({ passing: Integer, total: Integer }) }
1237
+ def to_hash
1238
+ end
1239
+ end
1240
+
1241
+ class Tag < Openlayer::Internal::Type::BaseModel
1242
+ OrHash =
1243
+ T.type_alias do
1244
+ T.any(
1245
+ Openlayer::Models::Governance::Frameworks::SectionListRulesResponse::Item::Tag,
1246
+ Openlayer::Internal::AnyHash
1247
+ )
1248
+ end
1249
+
1250
+ # The tag name.
1251
+ sig { returns(String) }
1252
+ attr_accessor :name
1253
+
1254
+ # The color the tag is displayed with.
1255
+ sig { returns(T.nilable(String)) }
1256
+ attr_accessor :color
1257
+
1258
+ # The rule tag id.
1259
+ sig { returns(String) }
1260
+ attr_accessor :id
1261
+
1262
+ # The user who created the tag. `null` for tags that ship with Openlayer.
1263
+ sig { returns(T.nilable(String)) }
1264
+ attr_accessor :creator_id
1265
+
1266
+ # The creation date.
1267
+ sig { returns(Time) }
1268
+ attr_accessor :date_created
1269
+
1270
+ # The last update date.
1271
+ sig { returns(Time) }
1272
+ attr_accessor :date_updated
1273
+
1274
+ # Whether the tag is managed by Openlayer. These tags can't be deleted.
1275
+ sig { returns(T::Boolean) }
1276
+ attr_accessor :immutable
1277
+
1278
+ # The id of the workspace the tag belongs to.
1279
+ sig { returns(String) }
1280
+ attr_accessor :workspace_id
1281
+
1282
+ # A label that groups rules across frameworks, for example by team or control
1283
+ # family.
1284
+ sig do
1285
+ params(
1286
+ id: String,
1287
+ creator_id: T.nilable(String),
1288
+ date_created: Time,
1289
+ date_updated: Time,
1290
+ immutable: T::Boolean,
1291
+ name: String,
1292
+ workspace_id: String,
1293
+ color: T.nilable(String)
1294
+ ).returns(T.attached_class)
1295
+ end
1296
+ def self.new(
1297
+ # The rule tag id.
1298
+ id:,
1299
+ # The user who created the tag. `null` for tags that ship with Openlayer.
1300
+ creator_id:,
1301
+ # The creation date.
1302
+ date_created:,
1303
+ # The last update date.
1304
+ date_updated:,
1305
+ # Whether the tag is managed by Openlayer. These tags can't be deleted.
1306
+ immutable:,
1307
+ # The tag name.
1308
+ name:,
1309
+ # The id of the workspace the tag belongs to.
1310
+ workspace_id:,
1311
+ # The color the tag is displayed with.
1312
+ color: nil
1313
+ )
1314
+ end
1315
+
1316
+ sig do
1317
+ override.returns(
1318
+ {
1319
+ id: String,
1320
+ creator_id: T.nilable(String),
1321
+ date_created: Time,
1322
+ date_updated: Time,
1323
+ immutable: T::Boolean,
1324
+ name: String,
1325
+ workspace_id: String,
1326
+ color: T.nilable(String)
1327
+ }
1328
+ )
1329
+ end
1330
+ def to_hash
1331
+ end
1332
+ end
1333
+ end
1334
+ end
1335
+ end
1336
+ end
1337
+ end
1338
+ end