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,1050 @@
1
+ # typed: strong
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ module Frameworks
7
+ class DocumentListResponse < Openlayer::Internal::Type::BaseModel
8
+ OrHash =
9
+ T.type_alias do
10
+ T.any(
11
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse,
12
+ Openlayer::Internal::AnyHash
13
+ )
14
+ end
15
+
16
+ sig do
17
+ returns(
18
+ T::Array[
19
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::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::DocumentListResponse::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::DocumentListResponse::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::DocumentListResponse::Item,
54
+ Openlayer::Internal::AnyHash
55
+ )
56
+ end
57
+
58
+ # The document title.
59
+ sig { returns(String) }
60
+ attr_accessor :title
61
+
62
+ # The document id.
63
+ sig { returns(String) }
64
+ attr_accessor :id
65
+
66
+ # The creation date.
67
+ sig { returns(Time) }
68
+ attr_accessor :date_created
69
+
70
+ # The last update date.
71
+ sig { returns(Time) }
72
+ attr_accessor :date_updated
73
+
74
+ # The framework the document belongs to.
75
+ sig { returns(String) }
76
+ attr_accessor :framework_id
77
+
78
+ # The document's sections, in display order. Only returned when retrieving a
79
+ # single document.
80
+ sig do
81
+ returns(
82
+ T.nilable(
83
+ T::Array[
84
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section
85
+ ]
86
+ )
87
+ )
88
+ end
89
+ attr_reader :sections
90
+
91
+ sig do
92
+ params(
93
+ sections:
94
+ T::Array[
95
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::OrHash
96
+ ]
97
+ ).void
98
+ end
99
+ attr_writer :sections
100
+
101
+ # The text of the standard a framework is based on, split into sections and
102
+ # subsections, with the rules mapped to each part.
103
+ sig do
104
+ params(
105
+ id: String,
106
+ date_created: Time,
107
+ date_updated: Time,
108
+ framework_id: String,
109
+ title: String,
110
+ sections:
111
+ T::Array[
112
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::OrHash
113
+ ]
114
+ ).returns(T.attached_class)
115
+ end
116
+ def self.new(
117
+ # The document id.
118
+ id:,
119
+ # The creation date.
120
+ date_created:,
121
+ # The last update date.
122
+ date_updated:,
123
+ # The framework the document belongs to.
124
+ framework_id:,
125
+ # The document title.
126
+ title:,
127
+ # The document's sections, in display order. Only returned when retrieving a
128
+ # single document.
129
+ sections: nil
130
+ )
131
+ end
132
+
133
+ sig do
134
+ override.returns(
135
+ {
136
+ id: String,
137
+ date_created: Time,
138
+ date_updated: Time,
139
+ framework_id: String,
140
+ title: String,
141
+ sections:
142
+ T::Array[
143
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section
144
+ ]
145
+ }
146
+ )
147
+ end
148
+ def to_hash
149
+ end
150
+
151
+ class Section < Openlayer::Internal::Type::BaseModel
152
+ OrHash =
153
+ T.type_alias do
154
+ T.any(
155
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section,
156
+ Openlayer::Internal::AnyHash
157
+ )
158
+ end
159
+
160
+ # The section number as it appears in the source standard.
161
+ sig { returns(String) }
162
+ attr_accessor :number
163
+
164
+ # The position of the section within the document.
165
+ sig { returns(Integer) }
166
+ attr_accessor :sort_order
167
+
168
+ # The section title.
169
+ sig { returns(String) }
170
+ attr_accessor :title
171
+
172
+ # The section text.
173
+ sig { returns(T.nilable(String)) }
174
+ attr_accessor :text
175
+
176
+ # The section id.
177
+ sig { returns(String) }
178
+ attr_accessor :id
179
+
180
+ # The document the section belongs to.
181
+ sig { returns(String) }
182
+ attr_accessor :document_id
183
+
184
+ # How many rules are linked to this section, including its subsections. Use it to
185
+ # decide whether to fetch the section's rules.
186
+ sig { returns(T.nilable(Integer)) }
187
+ attr_reader :rule_count
188
+
189
+ sig { params(rule_count: Integer).void }
190
+ attr_writer :rule_count
191
+
192
+ # The rules linked directly to this section.
193
+ sig do
194
+ returns(
195
+ T.nilable(
196
+ T::Array[
197
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule
198
+ ]
199
+ )
200
+ )
201
+ end
202
+ attr_reader :rules
203
+
204
+ sig do
205
+ params(
206
+ rules:
207
+ T::Array[
208
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::OrHash
209
+ ]
210
+ ).void
211
+ end
212
+ attr_writer :rules
213
+
214
+ # The section's subsections, in display order.
215
+ sig do
216
+ returns(
217
+ T.nilable(
218
+ T::Array[
219
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection
220
+ ]
221
+ )
222
+ )
223
+ end
224
+ attr_reader :subsections
225
+
226
+ sig do
227
+ params(
228
+ subsections:
229
+ T::Array[
230
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::OrHash
231
+ ]
232
+ ).void
233
+ end
234
+ attr_writer :subsections
235
+
236
+ sig do
237
+ params(
238
+ id: String,
239
+ document_id: String,
240
+ number: String,
241
+ sort_order: Integer,
242
+ title: String,
243
+ rule_count: Integer,
244
+ rules:
245
+ T::Array[
246
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::OrHash
247
+ ],
248
+ subsections:
249
+ T::Array[
250
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::OrHash
251
+ ],
252
+ text: T.nilable(String)
253
+ ).returns(T.attached_class)
254
+ end
255
+ def self.new(
256
+ # The section id.
257
+ id:,
258
+ # The document the section belongs to.
259
+ document_id:,
260
+ # The section number as it appears in the source standard.
261
+ number:,
262
+ # The position of the section within the document.
263
+ sort_order:,
264
+ # The section title.
265
+ title:,
266
+ # How many rules are linked to this section, including its subsections. Use it to
267
+ # decide whether to fetch the section's rules.
268
+ rule_count: nil,
269
+ # The rules linked directly to this section.
270
+ rules: nil,
271
+ # The section's subsections, in display order.
272
+ subsections: nil,
273
+ # The section text.
274
+ text: nil
275
+ )
276
+ end
277
+
278
+ sig do
279
+ override.returns(
280
+ {
281
+ id: String,
282
+ document_id: String,
283
+ number: String,
284
+ sort_order: Integer,
285
+ title: String,
286
+ rule_count: Integer,
287
+ rules:
288
+ T::Array[
289
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule
290
+ ],
291
+ subsections:
292
+ T::Array[
293
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection
294
+ ],
295
+ text: T.nilable(String)
296
+ }
297
+ )
298
+ end
299
+ def to_hash
300
+ end
301
+
302
+ class Rule < Openlayer::Internal::Type::BaseModel
303
+ OrHash =
304
+ T.type_alias do
305
+ T.any(
306
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule,
307
+ Openlayer::Internal::AnyHash
308
+ )
309
+ end
310
+
311
+ # The rule name.
312
+ sig { returns(String) }
313
+ attr_accessor :name
314
+
315
+ # Whether the rule is evaluated once for the whole workspace, or once per project
316
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
317
+ # the rule is created.
318
+ sig do
319
+ returns(
320
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope::TaggedSymbol
321
+ )
322
+ end
323
+ attr_accessor :scope
324
+
325
+ # `platform` rules are evaluated automatically from the state of your Openlayer
326
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
327
+ # rule is created.
328
+ sig do
329
+ returns(
330
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type::TaggedSymbol
331
+ )
332
+ end
333
+ attr_accessor :type
334
+
335
+ # Configuration for the platform check, when the automation takes parameters. Omit
336
+ # or `null` for evidence rules. Fixed once the rule is created.
337
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
338
+ attr_accessor :automation_params
339
+
340
+ # Which workspace signal a platform rule checks, for example
341
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
342
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
343
+ # created.
344
+ sig { returns(T.nilable(String)) }
345
+ attr_accessor :automation_type
346
+
347
+ # Whether the rule is excluded from compliance calculations.
348
+ sig { returns(T.nilable(T::Boolean)) }
349
+ attr_reader :deactivated
350
+
351
+ sig { params(deactivated: T::Boolean).void }
352
+ attr_writer :deactivated
353
+
354
+ # What the rule requires.
355
+ sig { returns(T.nilable(String)) }
356
+ attr_accessor :description
357
+
358
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
359
+ # `null` for platform rules. Fixed once the rule is created.
360
+ sig do
361
+ returns(
362
+ T.nilable(
363
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
364
+ )
365
+ )
366
+ end
367
+ attr_accessor :evidence_type
368
+
369
+ # How often evidence must be renewed, in days. Once evidence is older than this,
370
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
371
+ # whenever evidence is attached. Omit or `null` for platform rules.
372
+ sig { returns(T.nilable(Integer)) }
373
+ attr_accessor :renewal_cadence_days
374
+
375
+ # The rule id.
376
+ sig { returns(String) }
377
+ attr_accessor :id
378
+
379
+ # The creation date.
380
+ sig { returns(T.nilable(Time)) }
381
+ attr_reader :date_created
382
+
383
+ sig { params(date_created: Time).void }
384
+ attr_writer :date_created
385
+
386
+ # The last update date.
387
+ sig { returns(T.nilable(Time)) }
388
+ attr_reader :date_updated
389
+
390
+ sig { params(date_updated: Time).void }
391
+ attr_writer :date_updated
392
+
393
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
394
+ # deleted; set `deactivated` to exclude one from compliance instead.
395
+ sig { returns(T.nilable(T::Boolean)) }
396
+ attr_reader :immutable
397
+
398
+ sig { params(immutable: T::Boolean).void }
399
+ attr_writer :immutable
400
+
401
+ sig do
402
+ params(
403
+ id: String,
404
+ name: String,
405
+ scope:
406
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope::OrSymbol,
407
+ type:
408
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type::OrSymbol,
409
+ automation_params: T.nilable(T::Hash[Symbol, T.anything]),
410
+ automation_type: T.nilable(String),
411
+ date_created: Time,
412
+ date_updated: Time,
413
+ deactivated: T::Boolean,
414
+ description: T.nilable(String),
415
+ evidence_type:
416
+ T.nilable(
417
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::OrSymbol
418
+ ),
419
+ immutable: T::Boolean,
420
+ renewal_cadence_days: T.nilable(Integer)
421
+ ).returns(T.attached_class)
422
+ end
423
+ def self.new(
424
+ # The rule id.
425
+ id:,
426
+ # The rule name.
427
+ name:,
428
+ # Whether the rule is evaluated once for the whole workspace, or once per project
429
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
430
+ # the rule is created.
431
+ scope:,
432
+ # `platform` rules are evaluated automatically from the state of your Openlayer
433
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
434
+ # rule is created.
435
+ type:,
436
+ # Configuration for the platform check, when the automation takes parameters. Omit
437
+ # or `null` for evidence rules. Fixed once the rule is created.
438
+ automation_params: nil,
439
+ # Which workspace signal a platform rule checks, for example
440
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
441
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
442
+ # created.
443
+ automation_type: nil,
444
+ # The creation date.
445
+ date_created: nil,
446
+ # The last update date.
447
+ date_updated: nil,
448
+ # Whether the rule is excluded from compliance calculations.
449
+ deactivated: nil,
450
+ # What the rule requires.
451
+ description: nil,
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
+ evidence_type: nil,
455
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
456
+ # deleted; set `deactivated` to exclude one from compliance instead.
457
+ immutable: nil,
458
+ # How often evidence must be renewed, in days. Once evidence is older than this,
459
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
460
+ # whenever evidence is attached. Omit or `null` for platform rules.
461
+ renewal_cadence_days: nil
462
+ )
463
+ end
464
+
465
+ sig do
466
+ override.returns(
467
+ {
468
+ id: String,
469
+ name: String,
470
+ scope:
471
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope::TaggedSymbol,
472
+ type:
473
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type::TaggedSymbol,
474
+ automation_params: T.nilable(T::Hash[Symbol, T.anything]),
475
+ automation_type: T.nilable(String),
476
+ date_created: Time,
477
+ date_updated: Time,
478
+ deactivated: T::Boolean,
479
+ description: T.nilable(String),
480
+ evidence_type:
481
+ T.nilable(
482
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
483
+ ),
484
+ immutable: T::Boolean,
485
+ renewal_cadence_days: T.nilable(Integer)
486
+ }
487
+ )
488
+ end
489
+ def to_hash
490
+ end
491
+
492
+ # Whether the rule is evaluated once for the whole workspace, or once per project
493
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
494
+ # the rule is created.
495
+ module Scope
496
+ extend Openlayer::Internal::Type::Enum
497
+
498
+ TaggedSymbol =
499
+ T.type_alias do
500
+ T.all(
501
+ Symbol,
502
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope
503
+ )
504
+ end
505
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
506
+
507
+ PROJECT =
508
+ T.let(
509
+ :project,
510
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope::TaggedSymbol
511
+ )
512
+ WORKSPACE =
513
+ T.let(
514
+ :workspace,
515
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope::TaggedSymbol
516
+ )
517
+
518
+ sig do
519
+ override.returns(
520
+ T::Array[
521
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Scope::TaggedSymbol
522
+ ]
523
+ )
524
+ end
525
+ def self.values
526
+ end
527
+ end
528
+
529
+ # `platform` rules are evaluated automatically from the state of your Openlayer
530
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
531
+ # rule is created.
532
+ module Type
533
+ extend Openlayer::Internal::Type::Enum
534
+
535
+ TaggedSymbol =
536
+ T.type_alias do
537
+ T.all(
538
+ Symbol,
539
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type
540
+ )
541
+ end
542
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
543
+
544
+ PLATFORM =
545
+ T.let(
546
+ :platform,
547
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type::TaggedSymbol
548
+ )
549
+ EVIDENCE =
550
+ T.let(
551
+ :evidence,
552
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type::TaggedSymbol
553
+ )
554
+
555
+ sig do
556
+ override.returns(
557
+ T::Array[
558
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::Type::TaggedSymbol
559
+ ]
560
+ )
561
+ end
562
+ def self.values
563
+ end
564
+ end
565
+
566
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
567
+ # `null` for platform rules. Fixed once the rule is created.
568
+ module EvidenceType
569
+ extend Openlayer::Internal::Type::Enum
570
+
571
+ TaggedSymbol =
572
+ T.type_alias do
573
+ T.all(
574
+ Symbol,
575
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType
576
+ )
577
+ end
578
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
579
+
580
+ DOCUMENT =
581
+ T.let(
582
+ :document,
583
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
584
+ )
585
+ TEXT =
586
+ T.let(
587
+ :text,
588
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
589
+ )
590
+ URL =
591
+ T.let(
592
+ :url,
593
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
594
+ )
595
+ CATEGORY_VALUE =
596
+ T.let(
597
+ :categoryValue,
598
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
599
+ )
600
+
601
+ sig do
602
+ override.returns(
603
+ T::Array[
604
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Rule::EvidenceType::TaggedSymbol
605
+ ]
606
+ )
607
+ end
608
+ def self.values
609
+ end
610
+ end
611
+ end
612
+
613
+ class Subsection < Openlayer::Internal::Type::BaseModel
614
+ OrHash =
615
+ T.type_alias do
616
+ T.any(
617
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection,
618
+ Openlayer::Internal::AnyHash
619
+ )
620
+ end
621
+
622
+ # The subsection number as it appears in the source standard.
623
+ sig { returns(String) }
624
+ attr_accessor :number
625
+
626
+ # The position of the subsection within its section.
627
+ sig { returns(Integer) }
628
+ attr_accessor :sort_order
629
+
630
+ # The subsection title.
631
+ sig { returns(String) }
632
+ attr_accessor :title
633
+
634
+ # The subsection text. This is the requirement your rules are mapped against.
635
+ sig { returns(T.nilable(String)) }
636
+ attr_accessor :text
637
+
638
+ # The subsection id.
639
+ sig { returns(String) }
640
+ attr_accessor :id
641
+
642
+ # The section the subsection belongs to.
643
+ sig { returns(String) }
644
+ attr_accessor :section_id
645
+
646
+ # How many rules are linked to this subsection.
647
+ sig { returns(T.nilable(Integer)) }
648
+ attr_reader :rule_count
649
+
650
+ sig { params(rule_count: Integer).void }
651
+ attr_writer :rule_count
652
+
653
+ # The rules linked to this subsection.
654
+ sig do
655
+ returns(
656
+ T.nilable(
657
+ T::Array[
658
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule
659
+ ]
660
+ )
661
+ )
662
+ end
663
+ attr_reader :rules
664
+
665
+ sig do
666
+ params(
667
+ rules:
668
+ T::Array[
669
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::OrHash
670
+ ]
671
+ ).void
672
+ end
673
+ attr_writer :rules
674
+
675
+ # A subsection usually states one individual requirement of the standard, so it is
676
+ # where you see which rules cover a specific clause.
677
+ sig do
678
+ params(
679
+ id: String,
680
+ number: String,
681
+ section_id: String,
682
+ sort_order: Integer,
683
+ title: String,
684
+ rule_count: Integer,
685
+ rules:
686
+ T::Array[
687
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::OrHash
688
+ ],
689
+ text: T.nilable(String)
690
+ ).returns(T.attached_class)
691
+ end
692
+ def self.new(
693
+ # The subsection id.
694
+ id:,
695
+ # The subsection number as it appears in the source standard.
696
+ number:,
697
+ # The section the subsection belongs to.
698
+ section_id:,
699
+ # The position of the subsection within its section.
700
+ sort_order:,
701
+ # The subsection title.
702
+ title:,
703
+ # How many rules are linked to this subsection.
704
+ rule_count: nil,
705
+ # The rules linked to this subsection.
706
+ rules: nil,
707
+ # The subsection text. This is the requirement your rules are mapped against.
708
+ text: nil
709
+ )
710
+ end
711
+
712
+ sig do
713
+ override.returns(
714
+ {
715
+ id: String,
716
+ number: String,
717
+ section_id: String,
718
+ sort_order: Integer,
719
+ title: String,
720
+ rule_count: Integer,
721
+ rules:
722
+ T::Array[
723
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule
724
+ ],
725
+ text: T.nilable(String)
726
+ }
727
+ )
728
+ end
729
+ def to_hash
730
+ end
731
+
732
+ class Rule < Openlayer::Internal::Type::BaseModel
733
+ OrHash =
734
+ T.type_alias do
735
+ T.any(
736
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule,
737
+ Openlayer::Internal::AnyHash
738
+ )
739
+ end
740
+
741
+ # The rule name.
742
+ sig { returns(String) }
743
+ attr_accessor :name
744
+
745
+ # Whether the rule is evaluated once for the whole workspace, or once per project
746
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
747
+ # the rule is created.
748
+ sig do
749
+ returns(
750
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope::TaggedSymbol
751
+ )
752
+ end
753
+ attr_accessor :scope
754
+
755
+ # `platform` rules are evaluated automatically from the state of your Openlayer
756
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
757
+ # rule is created.
758
+ sig do
759
+ returns(
760
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type::TaggedSymbol
761
+ )
762
+ end
763
+ attr_accessor :type
764
+
765
+ # Configuration for the platform check, when the automation takes parameters. Omit
766
+ # or `null` for evidence rules. Fixed once the rule is created.
767
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
768
+ attr_accessor :automation_params
769
+
770
+ # Which workspace signal a platform rule checks, for example
771
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
772
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
773
+ # created.
774
+ sig { returns(T.nilable(String)) }
775
+ attr_accessor :automation_type
776
+
777
+ # Whether the rule is excluded from compliance calculations.
778
+ sig { returns(T.nilable(T::Boolean)) }
779
+ attr_reader :deactivated
780
+
781
+ sig { params(deactivated: T::Boolean).void }
782
+ attr_writer :deactivated
783
+
784
+ # What the rule requires.
785
+ sig { returns(T.nilable(String)) }
786
+ attr_accessor :description
787
+
788
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
789
+ # `null` for platform rules. Fixed once the rule is created.
790
+ sig do
791
+ returns(
792
+ T.nilable(
793
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
794
+ )
795
+ )
796
+ end
797
+ attr_accessor :evidence_type
798
+
799
+ # How often evidence must be renewed, in days. Once evidence is older than this,
800
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
801
+ # whenever evidence is attached. Omit or `null` for platform rules.
802
+ sig { returns(T.nilable(Integer)) }
803
+ attr_accessor :renewal_cadence_days
804
+
805
+ # The rule id.
806
+ sig { returns(String) }
807
+ attr_accessor :id
808
+
809
+ # The creation date.
810
+ sig { returns(T.nilable(Time)) }
811
+ attr_reader :date_created
812
+
813
+ sig { params(date_created: Time).void }
814
+ attr_writer :date_created
815
+
816
+ # The last update date.
817
+ sig { returns(T.nilable(Time)) }
818
+ attr_reader :date_updated
819
+
820
+ sig { params(date_updated: Time).void }
821
+ attr_writer :date_updated
822
+
823
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
824
+ # deleted; set `deactivated` to exclude one from compliance instead.
825
+ sig { returns(T.nilable(T::Boolean)) }
826
+ attr_reader :immutable
827
+
828
+ sig { params(immutable: T::Boolean).void }
829
+ attr_writer :immutable
830
+
831
+ sig do
832
+ params(
833
+ id: String,
834
+ name: String,
835
+ scope:
836
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope::OrSymbol,
837
+ type:
838
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type::OrSymbol,
839
+ automation_params: T.nilable(T::Hash[Symbol, T.anything]),
840
+ automation_type: T.nilable(String),
841
+ date_created: Time,
842
+ date_updated: Time,
843
+ deactivated: T::Boolean,
844
+ description: T.nilable(String),
845
+ evidence_type:
846
+ T.nilable(
847
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::OrSymbol
848
+ ),
849
+ immutable: T::Boolean,
850
+ renewal_cadence_days: T.nilable(Integer)
851
+ ).returns(T.attached_class)
852
+ end
853
+ def self.new(
854
+ # The rule id.
855
+ id:,
856
+ # The rule name.
857
+ name:,
858
+ # Whether the rule is evaluated once for the whole workspace, or once per project
859
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
860
+ # the rule is created.
861
+ scope:,
862
+ # `platform` rules are evaluated automatically from the state of your Openlayer
863
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
864
+ # rule is created.
865
+ type:,
866
+ # Configuration for the platform check, when the automation takes parameters. Omit
867
+ # or `null` for evidence rules. Fixed once the rule is created.
868
+ automation_params: nil,
869
+ # Which workspace signal a platform rule checks, for example
870
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
871
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
872
+ # created.
873
+ automation_type: nil,
874
+ # The creation date.
875
+ date_created: nil,
876
+ # The last update date.
877
+ date_updated: nil,
878
+ # Whether the rule is excluded from compliance calculations.
879
+ deactivated: nil,
880
+ # What the rule requires.
881
+ description: nil,
882
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
883
+ # `null` for platform rules. Fixed once the rule is created.
884
+ evidence_type: nil,
885
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
886
+ # deleted; set `deactivated` to exclude one from compliance instead.
887
+ immutable: nil,
888
+ # How often evidence must be renewed, in days. Once evidence is older than this,
889
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
890
+ # whenever evidence is attached. Omit or `null` for platform rules.
891
+ renewal_cadence_days: nil
892
+ )
893
+ end
894
+
895
+ sig do
896
+ override.returns(
897
+ {
898
+ id: String,
899
+ name: String,
900
+ scope:
901
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope::TaggedSymbol,
902
+ type:
903
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type::TaggedSymbol,
904
+ automation_params:
905
+ T.nilable(T::Hash[Symbol, T.anything]),
906
+ automation_type: T.nilable(String),
907
+ date_created: Time,
908
+ date_updated: Time,
909
+ deactivated: T::Boolean,
910
+ description: T.nilable(String),
911
+ evidence_type:
912
+ T.nilable(
913
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
914
+ ),
915
+ immutable: T::Boolean,
916
+ renewal_cadence_days: T.nilable(Integer)
917
+ }
918
+ )
919
+ end
920
+ def to_hash
921
+ end
922
+
923
+ # Whether the rule is evaluated once for the whole workspace, or once per project
924
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
925
+ # the rule is created.
926
+ module Scope
927
+ extend Openlayer::Internal::Type::Enum
928
+
929
+ TaggedSymbol =
930
+ T.type_alias do
931
+ T.all(
932
+ Symbol,
933
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope
934
+ )
935
+ end
936
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
937
+
938
+ PROJECT =
939
+ T.let(
940
+ :project,
941
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope::TaggedSymbol
942
+ )
943
+ WORKSPACE =
944
+ T.let(
945
+ :workspace,
946
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope::TaggedSymbol
947
+ )
948
+
949
+ sig do
950
+ override.returns(
951
+ T::Array[
952
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Scope::TaggedSymbol
953
+ ]
954
+ )
955
+ end
956
+ def self.values
957
+ end
958
+ end
959
+
960
+ # `platform` rules are evaluated automatically from the state of your Openlayer
961
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
962
+ # rule is created.
963
+ module Type
964
+ extend Openlayer::Internal::Type::Enum
965
+
966
+ TaggedSymbol =
967
+ T.type_alias do
968
+ T.all(
969
+ Symbol,
970
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type
971
+ )
972
+ end
973
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
974
+
975
+ PLATFORM =
976
+ T.let(
977
+ :platform,
978
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type::TaggedSymbol
979
+ )
980
+ EVIDENCE =
981
+ T.let(
982
+ :evidence,
983
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type::TaggedSymbol
984
+ )
985
+
986
+ sig do
987
+ override.returns(
988
+ T::Array[
989
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::Type::TaggedSymbol
990
+ ]
991
+ )
992
+ end
993
+ def self.values
994
+ end
995
+ end
996
+
997
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
998
+ # `null` for platform rules. Fixed once the rule is created.
999
+ module EvidenceType
1000
+ extend Openlayer::Internal::Type::Enum
1001
+
1002
+ TaggedSymbol =
1003
+ T.type_alias do
1004
+ T.all(
1005
+ Symbol,
1006
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType
1007
+ )
1008
+ end
1009
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1010
+
1011
+ DOCUMENT =
1012
+ T.let(
1013
+ :document,
1014
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
1015
+ )
1016
+ TEXT =
1017
+ T.let(
1018
+ :text,
1019
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
1020
+ )
1021
+ URL =
1022
+ T.let(
1023
+ :url,
1024
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
1025
+ )
1026
+ CATEGORY_VALUE =
1027
+ T.let(
1028
+ :categoryValue,
1029
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
1030
+ )
1031
+
1032
+ sig do
1033
+ override.returns(
1034
+ T::Array[
1035
+ Openlayer::Models::Governance::Frameworks::DocumentListResponse::Item::Section::Subsection::Rule::EvidenceType::TaggedSymbol
1036
+ ]
1037
+ )
1038
+ end
1039
+ def self.values
1040
+ end
1041
+ end
1042
+ end
1043
+ end
1044
+ end
1045
+ end
1046
+ end
1047
+ end
1048
+ end
1049
+ end
1050
+ end