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