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