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,677 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::Rules#create
7
+ class RuleCreateResponse < Openlayer::Internal::Type::BaseModel
8
+ # @!attribute name
9
+ # The rule name.
10
+ #
11
+ # @return [String]
12
+ required :name, String
13
+
14
+ # @!attribute scope
15
+ # Whether the rule is evaluated once for the whole workspace, or once per project
16
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
17
+ # the rule is created.
18
+ #
19
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Scope]
20
+ required :scope, enum: -> { Openlayer::Models::Governance::RuleCreateResponse::Scope }
21
+
22
+ # @!attribute type
23
+ # `platform` rules are evaluated automatically from the state of your Openlayer
24
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
25
+ # rule is created.
26
+ #
27
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Type]
28
+ required :type, enum: -> { Openlayer::Models::Governance::RuleCreateResponse::Type }
29
+
30
+ # @!attribute assignee_id
31
+ # The user responsible for satisfying the rule.
32
+ #
33
+ # @return [String, nil]
34
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
35
+
36
+ # @!attribute automation_params
37
+ # Configuration for the platform check, when the automation takes parameters. Omit
38
+ # or `null` for evidence rules. Fixed once the rule is created.
39
+ #
40
+ # @return [Hash{Symbol=>Object}, nil]
41
+ optional :automation_params,
42
+ Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
43
+ api_name: :automationParams,
44
+ nil?: true
45
+
46
+ # @!attribute automation_type
47
+ # Which workspace signal a platform rule checks, for example
48
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
49
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
50
+ # created.
51
+ #
52
+ # @return [String, nil]
53
+ optional :automation_type, String, api_name: :automationType, nil?: true
54
+
55
+ # @!attribute deactivated
56
+ # Whether the rule is excluded from compliance calculations.
57
+ #
58
+ # @return [Boolean, nil]
59
+ optional :deactivated, Openlayer::Internal::Type::Boolean
60
+
61
+ # @!attribute description
62
+ # What the rule requires.
63
+ #
64
+ # @return [String, nil]
65
+ optional :description, String, nil?: true
66
+
67
+ # @!attribute evidence_type
68
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
69
+ # `null` for platform rules. Fixed once the rule is created.
70
+ #
71
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::EvidenceType, nil]
72
+ optional :evidence_type,
73
+ enum: -> { Openlayer::Models::Governance::RuleCreateResponse::EvidenceType },
74
+ api_name: :evidenceType,
75
+ nil?: true
76
+
77
+ # @!attribute renewal_cadence_days
78
+ # How often evidence must be renewed, in days. Once evidence is older than this,
79
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
80
+ # whenever evidence is attached. Omit or `null` for platform rules.
81
+ #
82
+ # @return [Integer, nil]
83
+ optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true
84
+
85
+ response_only do
86
+ # @!attribute id
87
+ # The rule id.
88
+ #
89
+ # @return [String]
90
+ required :id, String
91
+
92
+ # @!attribute date_created
93
+ # The creation date.
94
+ #
95
+ # @return [Time]
96
+ required :date_created, Time, api_name: :dateCreated
97
+
98
+ # @!attribute date_updated
99
+ # The last update date.
100
+ #
101
+ # @return [Time]
102
+ required :date_updated, Time, api_name: :dateUpdated
103
+
104
+ # @!attribute workspace_id
105
+ # The id of the workspace the rule belongs to.
106
+ #
107
+ # @return [String]
108
+ required :workspace_id, String, api_name: :workspaceId
109
+
110
+ # @!attribute frameworks
111
+ # The frameworks that include this rule.
112
+ #
113
+ # @return [Array<Openlayer::Models::Governance::RuleCreateResponse::Framework>, nil]
114
+ optional :frameworks,
115
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleCreateResponse::Framework] }
116
+
117
+ # @!attribute immutable
118
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
119
+ # deleted; set `deactivated` to exclude one from compliance instead.
120
+ #
121
+ # @return [Boolean, nil]
122
+ optional :immutable, Openlayer::Internal::Type::Boolean
123
+
124
+ # @!attribute results
125
+ # The rule's results, one per entity the rule is evaluated against. Only returned
126
+ # when `includeResults` is `true`.
127
+ #
128
+ # @return [Array<Openlayer::Models::Governance::RuleCreateResponse::Result>, nil]
129
+ optional :results,
130
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleCreateResponse::Result] }
131
+
132
+ # @!attribute results_summary
133
+ # Pass-rate counts across all of the rule's entities, independent of any status
134
+ # filter applied to the request.
135
+ #
136
+ # @return [Openlayer::Models::Governance::RuleCreateResponse::ResultsSummary, nil]
137
+ optional :results_summary,
138
+ -> { Openlayer::Models::Governance::RuleCreateResponse::ResultsSummary },
139
+ api_name: :resultsSummary,
140
+ nil?: true
141
+
142
+ # @!attribute tags
143
+ # The rule tags associated with the rule.
144
+ #
145
+ # @return [Array<Openlayer::Models::Governance::RuleCreateResponse::Tag>, nil]
146
+ optional :tags,
147
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleCreateResponse::Tag] },
148
+ nil?: true
149
+ end
150
+
151
+ # @!method initialize(id:, date_created:, date_updated:, name:, scope:, type:, workspace_id:, assignee_id: nil, automation_params: nil, automation_type: nil, deactivated: nil, description: nil, evidence_type: nil, frameworks: nil, immutable: nil, renewal_cadence_days: nil, results: nil, results_summary: nil, tags: nil)
152
+ # Some parameter documentations has been truncated, see
153
+ # {Openlayer::Models::Governance::RuleCreateResponse} for more details.
154
+ #
155
+ # A single requirement Openlayer tracks. `platform` rules are evaluated
156
+ # automatically from the state of your workspace, and `evidence` rules are
157
+ # satisfied by attaching evidence. A rule can belong to several frameworks, or to
158
+ # none.
159
+ #
160
+ # @param id [String] The rule id.
161
+ #
162
+ # @param date_created [Time] The creation date.
163
+ #
164
+ # @param date_updated [Time] The last update date.
165
+ #
166
+ # @param name [String] The rule name.
167
+ #
168
+ # @param scope [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
169
+ #
170
+ # @param type [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
171
+ #
172
+ # @param workspace_id [String] The id of the workspace the rule belongs to.
173
+ #
174
+ # @param assignee_id [String, nil] The user responsible for satisfying the rule.
175
+ #
176
+ # @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters. Omit
177
+ #
178
+ # @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
179
+ #
180
+ # @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
181
+ #
182
+ # @param description [String, nil] What the rule requires.
183
+ #
184
+ # @param evidence_type [Symbol, Openlayer::Models::Governance::RuleCreateResponse::EvidenceType, nil] The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
185
+ #
186
+ # @param frameworks [Array<Openlayer::Models::Governance::RuleCreateResponse::Framework>] The frameworks that include this rule.
187
+ #
188
+ # @param immutable [Boolean] Whether the rule is managed by Openlayer. These rules can't be renamed or delete
189
+ #
190
+ # @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
191
+ #
192
+ # @param results [Array<Openlayer::Models::Governance::RuleCreateResponse::Result>] The rule's results, one per entity the rule is evaluated against. Only returned
193
+ #
194
+ # @param results_summary [Openlayer::Models::Governance::RuleCreateResponse::ResultsSummary, nil] Pass-rate counts across all of the rule's entities, independent of any status fi
195
+ #
196
+ # @param tags [Array<Openlayer::Models::Governance::RuleCreateResponse::Tag>, nil] The rule tags associated with the rule.
197
+
198
+ # Whether the rule is evaluated once for the whole workspace, or once per project
199
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
200
+ # the rule is created.
201
+ #
202
+ # @see Openlayer::Models::Governance::RuleCreateResponse#scope
203
+ module Scope
204
+ extend Openlayer::Internal::Type::Enum
205
+
206
+ PROJECT = :project
207
+ WORKSPACE = :workspace
208
+
209
+ # @!method self.values
210
+ # @return [Array<Symbol>]
211
+ end
212
+
213
+ # `platform` rules are evaluated automatically from the state of your Openlayer
214
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
215
+ # rule is created.
216
+ #
217
+ # @see Openlayer::Models::Governance::RuleCreateResponse#type
218
+ module Type
219
+ extend Openlayer::Internal::Type::Enum
220
+
221
+ PLATFORM = :platform
222
+ EVIDENCE = :evidence
223
+
224
+ # @!method self.values
225
+ # @return [Array<Symbol>]
226
+ end
227
+
228
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
229
+ # `null` for platform rules. Fixed once the rule is created.
230
+ #
231
+ # @see Openlayer::Models::Governance::RuleCreateResponse#evidence_type
232
+ module EvidenceType
233
+ extend Openlayer::Internal::Type::Enum
234
+
235
+ DOCUMENT = :document
236
+ TEXT = :text
237
+ URL = :url
238
+ CATEGORY_VALUE = :categoryValue
239
+
240
+ # @!method self.values
241
+ # @return [Array<Symbol>]
242
+ end
243
+
244
+ class Framework < Openlayer::Internal::Type::BaseModel
245
+ # @!attribute avatar
246
+ # The icon shown for the framework.
247
+ #
248
+ # @return [Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar, nil]
249
+ required :avatar, -> { Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar }, nil?: true
250
+
251
+ # @!attribute built_in_slug
252
+ # Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
253
+ # `iso_42001`, `nist_ai_rmf`, or `traiga`. `null` for frameworks you create
254
+ # yourself.
255
+ #
256
+ # @return [String, nil]
257
+ required :built_in_slug, String, api_name: :builtInSlug, nil?: true
258
+
259
+ # @!attribute enabled
260
+ # Whether the framework is active. Rules of a disabled framework are not evaluated
261
+ # and do not count towards compliance.
262
+ #
263
+ # @return [Boolean]
264
+ required :enabled, Openlayer::Internal::Type::Boolean
265
+
266
+ # @!attribute name
267
+ # The framework name.
268
+ #
269
+ # @return [String]
270
+ required :name, String
271
+
272
+ response_only do
273
+ # @!attribute id
274
+ # The framework id.
275
+ #
276
+ # @return [String]
277
+ required :id, String
278
+ end
279
+
280
+ # @!method initialize(id:, avatar:, built_in_slug:, enabled:, name:)
281
+ # Some parameter documentations has been truncated, see
282
+ # {Openlayer::Models::Governance::RuleCreateResponse::Framework} for more details.
283
+ #
284
+ # @param id [String] The framework id.
285
+ #
286
+ # @param avatar [Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar, nil] The icon shown for the framework.
287
+ #
288
+ # @param built_in_slug [String, nil] Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
289
+ # `iso\_
290
+ #
291
+ # @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated
292
+ #
293
+ # @param name [String] The framework name.
294
+
295
+ # @see Openlayer::Models::Governance::RuleCreateResponse::Framework#avatar
296
+ class Avatar < Openlayer::Internal::Type::BaseModel
297
+ # @!attribute type
298
+ #
299
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar::Type]
300
+ required :type, enum: -> { Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar::Type }
301
+
302
+ # @!attribute value
303
+ #
304
+ # @return [String]
305
+ required :value, String
306
+
307
+ # @!method initialize(type:, value:)
308
+ # The icon shown for the framework.
309
+ #
310
+ # @param type [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar::Type]
311
+ # @param value [String]
312
+
313
+ # @see Openlayer::Models::Governance::RuleCreateResponse::Framework::Avatar#type
314
+ module Type
315
+ extend Openlayer::Internal::Type::Enum
316
+
317
+ EMOJI = :emoji
318
+ IMAGE_URL = :imageUrl
319
+ BUILTIN_IMAGE = :builtinImage
320
+
321
+ # @!method self.values
322
+ # @return [Array<Symbol>]
323
+ end
324
+ end
325
+ end
326
+
327
+ class Result < Openlayer::Internal::Type::BaseModel
328
+ # @!attribute deactivated
329
+ # Whether this result is excluded from compliance calculations. Excludes just this
330
+ # result, without deactivating the rule everywhere.
331
+ #
332
+ # @return [Boolean]
333
+ required :deactivated, Openlayer::Internal::Type::Boolean
334
+
335
+ # @!attribute status
336
+ # The compliance status of the rule for this entity. Computed by Openlayer and
337
+ # can't be set directly.
338
+ #
339
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Result::Status]
340
+ required :status, enum: -> { Openlayer::Models::Governance::RuleCreateResponse::Result::Status }
341
+
342
+ # @!attribute assignee_id
343
+ # The user responsible for this result.
344
+ #
345
+ # @return [String, nil]
346
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
347
+
348
+ # @!attribute blocked_by
349
+ # Rule results that must pass before this one can be satisfied.
350
+ #
351
+ # @return [Array<Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy>, nil]
352
+ optional :blocked_by,
353
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy] },
354
+ api_name: :blockedBy
355
+
356
+ # @!attribute blocking
357
+ # Rule results that this one blocks.
358
+ #
359
+ # @return [Array<Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking>, nil]
360
+ optional :blocking,
361
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking] }
362
+
363
+ # @!attribute deactivated_reason
364
+ # Why the result was excluded. Required when setting `deactivated` to `true`.
365
+ #
366
+ # @return [String, nil]
367
+ optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
368
+
369
+ # @!attribute status_message
370
+ # A human-readable explanation of the status.
371
+ #
372
+ # @return [String, nil]
373
+ optional :status_message, String, api_name: :statusMessage, nil?: true
374
+
375
+ response_only do
376
+ # @!attribute id
377
+ # The rule result id.
378
+ #
379
+ # @return [String]
380
+ required :id, String
381
+
382
+ # @!attribute date_created
383
+ # The creation date.
384
+ #
385
+ # @return [Time]
386
+ required :date_created, Time, api_name: :dateCreated
387
+
388
+ # @!attribute date_updated
389
+ # The last update date.
390
+ #
391
+ # @return [Time]
392
+ required :date_updated, Time, api_name: :dateUpdated
393
+
394
+ # @!attribute rule_id
395
+ # The rule this result belongs to.
396
+ #
397
+ # @return [String]
398
+ required :rule_id, String, api_name: :ruleId
399
+
400
+ # @!attribute workspace_id
401
+ # The id of the workspace the rule result belongs to.
402
+ #
403
+ # @return [String]
404
+ required :workspace_id, String, api_name: :workspaceId
405
+
406
+ # @!attribute date_last_evaluated
407
+ # When the rule was last evaluated. Platform rules only.
408
+ #
409
+ # @return [Time, nil]
410
+ optional :date_last_evaluated, Time, api_name: :dateLastEvaluated, nil?: true
411
+
412
+ # @!attribute date_of_latest_evidence
413
+ # When the most recent piece of evidence was attached. Evidence rules only.
414
+ #
415
+ # @return [Time, nil]
416
+ optional :date_of_latest_evidence, Time, api_name: :dateOfLatestEvidence, nil?: true
417
+
418
+ # @!attribute date_of_next_evaluation
419
+ # When the rule will next be evaluated. Platform rules only.
420
+ #
421
+ # @return [Time, nil]
422
+ optional :date_of_next_evaluation, Time, api_name: :dateOfNextEvaluation, nil?: true
423
+
424
+ # @!attribute date_of_renewal
425
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
426
+ #
427
+ # @return [Time, nil]
428
+ optional :date_of_renewal, Time, api_name: :dateOfRenewal, nil?: true
429
+
430
+ # @!attribute project_id
431
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
432
+ #
433
+ # @return [String, nil]
434
+ optional :project_id, String, api_name: :projectId, nil?: true
435
+ end
436
+
437
+ # @!method initialize(id:, date_created:, date_updated:, deactivated:, rule_id:, status:, workspace_id:, assignee_id: nil, blocked_by: nil, blocking: nil, date_last_evaluated: nil, date_of_latest_evidence: nil, date_of_next_evaluation: nil, date_of_renewal: nil, deactivated_reason: nil, project_id: nil, status_message: nil)
438
+ # Some parameter documentations has been truncated, see
439
+ # {Openlayer::Models::Governance::RuleCreateResponse::Result} for more details.
440
+ #
441
+ # The compliance status of one rule for one entity: a project for project-scoped
442
+ # rules, or the workspace for workspace-scoped rules.
443
+ #
444
+ # @param id [String] The rule result id.
445
+ #
446
+ # @param date_created [Time] The creation date.
447
+ #
448
+ # @param date_updated [Time] The last update date.
449
+ #
450
+ # @param deactivated [Boolean] Whether this result is excluded from compliance calculations. Excludes just this
451
+ #
452
+ # @param rule_id [String] The rule this result belongs to.
453
+ #
454
+ # @param status [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Result::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
455
+ #
456
+ # @param workspace_id [String] The id of the workspace the rule result belongs to.
457
+ #
458
+ # @param assignee_id [String, nil] The user responsible for this result.
459
+ #
460
+ # @param blocked_by [Array<Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy>] Rule results that must pass before this one can be satisfied.
461
+ #
462
+ # @param blocking [Array<Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking>] Rule results that this one blocks.
463
+ #
464
+ # @param date_last_evaluated [Time, nil] When the rule was last evaluated. Platform rules only.
465
+ #
466
+ # @param date_of_latest_evidence [Time, nil] When the most recent piece of evidence was attached. Evidence rules only.
467
+ #
468
+ # @param date_of_next_evaluation [Time, nil] When the rule will next be evaluated. Platform rules only.
469
+ #
470
+ # @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
471
+ #
472
+ # @param deactivated_reason [String, nil] Why the result was excluded. Required when setting `deactivated` to `true`.
473
+ #
474
+ # @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
475
+ #
476
+ # @param status_message [String, nil] A human-readable explanation of the status.
477
+
478
+ # The compliance status of the rule for this entity. Computed by Openlayer and
479
+ # can't be set directly.
480
+ #
481
+ # @see Openlayer::Models::Governance::RuleCreateResponse::Result#status
482
+ module Status
483
+ extend Openlayer::Internal::Type::Enum
484
+
485
+ RUNNING = :running
486
+ PASSING = :passing
487
+ FAILING = :failing
488
+ SKIPPED = :skipped
489
+ ERROR = :error
490
+ PENDING = :pending
491
+ DUE_SOON = :due_soon
492
+
493
+ # @!method self.values
494
+ # @return [Array<Symbol>]
495
+ end
496
+
497
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
498
+ # @!attribute id
499
+ #
500
+ # @return [String, nil]
501
+ optional :id, String
502
+
503
+ # @!attribute status
504
+ # The compliance status of the rule for this entity. Computed by Openlayer and
505
+ # can't be set directly.
506
+ #
507
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy::Status, nil]
508
+ optional :status,
509
+ enum: -> { Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy::Status }
510
+
511
+ # @!method initialize(id: nil, status: nil)
512
+ # Some parameter documentations has been truncated, see
513
+ # {Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy} for more
514
+ # details.
515
+ #
516
+ # @param id [String]
517
+ #
518
+ # @param status [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
519
+
520
+ # The compliance status of the rule for this entity. Computed by Openlayer and
521
+ # can't be set directly.
522
+ #
523
+ # @see Openlayer::Models::Governance::RuleCreateResponse::Result::BlockedBy#status
524
+ module Status
525
+ extend Openlayer::Internal::Type::Enum
526
+
527
+ RUNNING = :running
528
+ PASSING = :passing
529
+ FAILING = :failing
530
+ SKIPPED = :skipped
531
+ ERROR = :error
532
+ PENDING = :pending
533
+ DUE_SOON = :due_soon
534
+
535
+ # @!method self.values
536
+ # @return [Array<Symbol>]
537
+ end
538
+ end
539
+
540
+ class Blocking < Openlayer::Internal::Type::BaseModel
541
+ # @!attribute id
542
+ #
543
+ # @return [String, nil]
544
+ optional :id, String
545
+
546
+ # @!attribute status
547
+ # The compliance status of the rule for this entity. Computed by Openlayer and
548
+ # can't be set directly.
549
+ #
550
+ # @return [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking::Status, nil]
551
+ optional :status, enum: -> { Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking::Status }
552
+
553
+ # @!method initialize(id: nil, status: nil)
554
+ # Some parameter documentations has been truncated, see
555
+ # {Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking} for more
556
+ # details.
557
+ #
558
+ # @param id [String]
559
+ #
560
+ # @param status [Symbol, Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
561
+
562
+ # The compliance status of the rule for this entity. Computed by Openlayer and
563
+ # can't be set directly.
564
+ #
565
+ # @see Openlayer::Models::Governance::RuleCreateResponse::Result::Blocking#status
566
+ module Status
567
+ extend Openlayer::Internal::Type::Enum
568
+
569
+ RUNNING = :running
570
+ PASSING = :passing
571
+ FAILING = :failing
572
+ SKIPPED = :skipped
573
+ ERROR = :error
574
+ PENDING = :pending
575
+ DUE_SOON = :due_soon
576
+
577
+ # @!method self.values
578
+ # @return [Array<Symbol>]
579
+ end
580
+ end
581
+ end
582
+
583
+ # @see Openlayer::Models::Governance::RuleCreateResponse#results_summary
584
+ class ResultsSummary < Openlayer::Internal::Type::BaseModel
585
+ # @!attribute passing
586
+ #
587
+ # @return [Integer, nil]
588
+ optional :passing, Integer
589
+
590
+ # @!attribute total
591
+ #
592
+ # @return [Integer, nil]
593
+ optional :total, Integer
594
+
595
+ # @!method initialize(passing: nil, total: nil)
596
+ # Pass-rate counts across all of the rule's entities, independent of any status
597
+ # filter applied to the request.
598
+ #
599
+ # @param passing [Integer]
600
+ # @param total [Integer]
601
+ end
602
+
603
+ class Tag < Openlayer::Internal::Type::BaseModel
604
+ # @!attribute name
605
+ # The tag name.
606
+ #
607
+ # @return [String]
608
+ required :name, String
609
+
610
+ # @!attribute color
611
+ # The color the tag is displayed with.
612
+ #
613
+ # @return [String, nil]
614
+ optional :color, String, nil?: true
615
+
616
+ response_only do
617
+ # @!attribute id
618
+ # The rule tag id.
619
+ #
620
+ # @return [String]
621
+ required :id, String
622
+
623
+ # @!attribute creator_id
624
+ # The user who created the tag. `null` for tags that ship with Openlayer.
625
+ #
626
+ # @return [String, nil]
627
+ required :creator_id, String, api_name: :creatorId, nil?: true
628
+
629
+ # @!attribute date_created
630
+ # The creation date.
631
+ #
632
+ # @return [Time]
633
+ required :date_created, Time, api_name: :dateCreated
634
+
635
+ # @!attribute date_updated
636
+ # The last update date.
637
+ #
638
+ # @return [Time]
639
+ required :date_updated, Time, api_name: :dateUpdated
640
+
641
+ # @!attribute immutable
642
+ # Whether the tag is managed by Openlayer. These tags can't be deleted.
643
+ #
644
+ # @return [Boolean]
645
+ required :immutable, Openlayer::Internal::Type::Boolean
646
+
647
+ # @!attribute workspace_id
648
+ # The id of the workspace the tag belongs to.
649
+ #
650
+ # @return [String]
651
+ required :workspace_id, String, api_name: :workspaceId
652
+ end
653
+
654
+ # @!method initialize(id:, creator_id:, date_created:, date_updated:, immutable:, name:, workspace_id:, color: nil)
655
+ # A label that groups rules across frameworks, for example by team or control
656
+ # family.
657
+ #
658
+ # @param id [String] The rule tag id.
659
+ #
660
+ # @param creator_id [String, nil] The user who created the tag. `null` for tags that ship with Openlayer.
661
+ #
662
+ # @param date_created [Time] The creation date.
663
+ #
664
+ # @param date_updated [Time] The last update date.
665
+ #
666
+ # @param immutable [Boolean] Whether the tag is managed by Openlayer. These tags can't be deleted.
667
+ #
668
+ # @param name [String] The tag name.
669
+ #
670
+ # @param workspace_id [String] The id of the workspace the tag belongs to.
671
+ #
672
+ # @param color [String, nil] The color the tag is displayed with.
673
+ end
674
+ end
675
+ end
676
+ end
677
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::Rules#delete
7
+ class RuleDeleteParams < Openlayer::Internal::Type::BaseModel
8
+ extend Openlayer::Internal::Type::RequestParameters::Converter
9
+ include Openlayer::Internal::Type::RequestParameters
10
+
11
+ # @!attribute rule_id
12
+ #
13
+ # @return [String]
14
+ required :rule_id, String
15
+
16
+ # @!method initialize(rule_id:, request_options: {})
17
+ # @param rule_id [String]
18
+ # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end