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,255 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::RuleResults#list
7
+ class RuleResultListResponse < Openlayer::Internal::Type::BaseModel
8
+ # @!attribute items
9
+ #
10
+ # @return [Array<Openlayer::Models::Governance::RuleResultListResponse::Item>]
11
+ required :items,
12
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item] }
13
+
14
+ # @!method initialize(items:)
15
+ # @param items [Array<Openlayer::Models::Governance::RuleResultListResponse::Item>]
16
+
17
+ class Item < Openlayer::Internal::Type::BaseModel
18
+ # @!attribute deactivated
19
+ # Whether this result is excluded from compliance calculations.
20
+ #
21
+ # @return [Boolean]
22
+ required :deactivated, Openlayer::Internal::Type::Boolean
23
+
24
+ # @!attribute status
25
+ # The compliance status of the rule for this entity.
26
+ #
27
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Status]
28
+ required :status, enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::Status }
29
+
30
+ # @!attribute assignee_id
31
+ # The user responsible for this result.
32
+ #
33
+ # @return [String, nil]
34
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
35
+
36
+ # @!attribute blocked_by
37
+ # Rule results that must pass before this one can be satisfied.
38
+ #
39
+ # @return [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy>, nil]
40
+ optional :blocked_by,
41
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy] },
42
+ api_name: :blockedBy
43
+
44
+ # @!attribute blocking
45
+ # Rule results that this one blocks.
46
+ #
47
+ # @return [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking>, nil]
48
+ optional :blocking,
49
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking] }
50
+
51
+ # @!attribute deactivated_reason
52
+ # Why the result was excluded.
53
+ #
54
+ # @return [String, nil]
55
+ optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
56
+
57
+ # @!attribute status_message
58
+ # A human-readable explanation of the status.
59
+ #
60
+ # @return [String, nil]
61
+ optional :status_message, String, api_name: :statusMessage, nil?: true
62
+
63
+ response_only do
64
+ # @!attribute id
65
+ # The rule result id.
66
+ #
67
+ # @return [String]
68
+ required :id, String
69
+
70
+ # @!attribute date_created
71
+ # The creation date.
72
+ #
73
+ # @return [Time]
74
+ required :date_created, Time, api_name: :dateCreated
75
+
76
+ # @!attribute date_updated
77
+ # The last update date.
78
+ #
79
+ # @return [Time]
80
+ required :date_updated, Time, api_name: :dateUpdated
81
+
82
+ # @!attribute rule_id
83
+ # The rule this result belongs to.
84
+ #
85
+ # @return [String]
86
+ required :rule_id, String, api_name: :ruleId
87
+
88
+ # @!attribute workspace_id
89
+ # The id of the workspace the rule result belongs to.
90
+ #
91
+ # @return [String]
92
+ required :workspace_id, String, api_name: :workspaceId
93
+
94
+ # @!attribute date_last_evaluated
95
+ # When the rule was last evaluated. Platform rules only.
96
+ #
97
+ # @return [Time, nil]
98
+ optional :date_last_evaluated, Time, api_name: :dateLastEvaluated, nil?: true
99
+
100
+ # @!attribute date_of_latest_evidence
101
+ # When the most recent piece of evidence was attached. Evidence rules only.
102
+ #
103
+ # @return [Time, nil]
104
+ optional :date_of_latest_evidence, Time, api_name: :dateOfLatestEvidence, nil?: true
105
+
106
+ # @!attribute date_of_next_evaluation
107
+ # When the rule will next be evaluated. Platform rules only.
108
+ #
109
+ # @return [Time, nil]
110
+ optional :date_of_next_evaluation, Time, api_name: :dateOfNextEvaluation, nil?: true
111
+
112
+ # @!attribute date_of_renewal
113
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
114
+ #
115
+ # @return [Time, nil]
116
+ optional :date_of_renewal, Time, api_name: :dateOfRenewal, nil?: true
117
+
118
+ # @!attribute project_id
119
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
120
+ #
121
+ # @return [String, nil]
122
+ optional :project_id, String, api_name: :projectId, nil?: true
123
+ end
124
+
125
+ # @!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)
126
+ # @param id [String] The rule result id.
127
+ #
128
+ # @param date_created [Time] The creation date.
129
+ #
130
+ # @param date_updated [Time] The last update date.
131
+ #
132
+ # @param deactivated [Boolean] Whether this result is excluded from compliance calculations.
133
+ #
134
+ # @param rule_id [String] The rule this result belongs to.
135
+ #
136
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Status] The compliance status of the rule for this entity.
137
+ #
138
+ # @param workspace_id [String] The id of the workspace the rule result belongs to.
139
+ #
140
+ # @param assignee_id [String, nil] The user responsible for this result.
141
+ #
142
+ # @param blocked_by [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy>] Rule results that must pass before this one can be satisfied.
143
+ #
144
+ # @param blocking [Array<Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking>] Rule results that this one blocks.
145
+ #
146
+ # @param date_last_evaluated [Time, nil] When the rule was last evaluated. Platform rules only.
147
+ #
148
+ # @param date_of_latest_evidence [Time, nil] When the most recent piece of evidence was attached. Evidence rules only.
149
+ #
150
+ # @param date_of_next_evaluation [Time, nil] When the rule will next be evaluated. Platform rules only.
151
+ #
152
+ # @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
153
+ #
154
+ # @param deactivated_reason [String, nil] Why the result was excluded.
155
+ #
156
+ # @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
157
+ #
158
+ # @param status_message [String, nil] A human-readable explanation of the status.
159
+
160
+ # The compliance status of the rule for this entity.
161
+ #
162
+ # @see Openlayer::Models::Governance::RuleResultListResponse::Item#status
163
+ module Status
164
+ extend Openlayer::Internal::Type::Enum
165
+
166
+ RUNNING = :running
167
+ PASSING = :passing
168
+ FAILING = :failing
169
+ SKIPPED = :skipped
170
+ ERROR = :error
171
+ PENDING = :pending
172
+ DUE_SOON = :due_soon
173
+
174
+ # @!method self.values
175
+ # @return [Array<Symbol>]
176
+ end
177
+
178
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
179
+ # @!attribute id
180
+ #
181
+ # @return [String, nil]
182
+ optional :id, String
183
+
184
+ # @!attribute status
185
+ # The compliance status of the rule for this entity.
186
+ #
187
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy::Status, nil]
188
+ optional :status,
189
+ enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy::Status }
190
+
191
+ # @!method initialize(id: nil, status: nil)
192
+ # @param id [String]
193
+ #
194
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy::Status] The compliance status of the rule for this entity.
195
+
196
+ # The compliance status of the rule for this entity.
197
+ #
198
+ # @see Openlayer::Models::Governance::RuleResultListResponse::Item::BlockedBy#status
199
+ module Status
200
+ extend Openlayer::Internal::Type::Enum
201
+
202
+ RUNNING = :running
203
+ PASSING = :passing
204
+ FAILING = :failing
205
+ SKIPPED = :skipped
206
+ ERROR = :error
207
+ PENDING = :pending
208
+ DUE_SOON = :due_soon
209
+
210
+ # @!method self.values
211
+ # @return [Array<Symbol>]
212
+ end
213
+ end
214
+
215
+ class Blocking < Openlayer::Internal::Type::BaseModel
216
+ # @!attribute id
217
+ #
218
+ # @return [String, nil]
219
+ optional :id, String
220
+
221
+ # @!attribute status
222
+ # The compliance status of the rule for this entity.
223
+ #
224
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking::Status, nil]
225
+ optional :status,
226
+ enum: -> { Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking::Status }
227
+
228
+ # @!method initialize(id: nil, status: nil)
229
+ # @param id [String]
230
+ #
231
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking::Status] The compliance status of the rule for this entity.
232
+
233
+ # The compliance status of the rule for this entity.
234
+ #
235
+ # @see Openlayer::Models::Governance::RuleResultListResponse::Item::Blocking#status
236
+ module Status
237
+ extend Openlayer::Internal::Type::Enum
238
+
239
+ RUNNING = :running
240
+ PASSING = :passing
241
+ FAILING = :failing
242
+ SKIPPED = :skipped
243
+ ERROR = :error
244
+ PENDING = :pending
245
+ DUE_SOON = :due_soon
246
+
247
+ # @!method self.values
248
+ # @return [Array<Symbol>]
249
+ end
250
+ end
251
+ end
252
+ end
253
+ end
254
+ end
255
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::RuleResults#retrieve
7
+ class RuleResultRetrieveParams < Openlayer::Internal::Type::BaseModel
8
+ extend Openlayer::Internal::Type::RequestParameters::Converter
9
+ include Openlayer::Internal::Type::RequestParameters
10
+
11
+ # @!attribute rule_result_id
12
+ #
13
+ # @return [String]
14
+ required :rule_result_id, String
15
+
16
+ # @!method initialize(rule_result_id:, request_options: {})
17
+ # @param rule_result_id [String]
18
+ # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,243 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::RuleResults#retrieve
7
+ class RuleResultRetrieveResponse < Openlayer::Internal::Type::BaseModel
8
+ # @!attribute deactivated
9
+ # Whether this result is excluded from compliance calculations.
10
+ #
11
+ # @return [Boolean]
12
+ required :deactivated, Openlayer::Internal::Type::Boolean
13
+
14
+ # @!attribute status
15
+ # The compliance status of the rule for this entity.
16
+ #
17
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultRetrieveResponse::Status]
18
+ required :status, enum: -> { Openlayer::Models::Governance::RuleResultRetrieveResponse::Status }
19
+
20
+ # @!attribute assignee_id
21
+ # The user responsible for this result.
22
+ #
23
+ # @return [String, nil]
24
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
25
+
26
+ # @!attribute blocked_by
27
+ # Rule results that must pass before this one can be satisfied.
28
+ #
29
+ # @return [Array<Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy>, nil]
30
+ optional :blocked_by,
31
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy] },
32
+ api_name: :blockedBy
33
+
34
+ # @!attribute blocking
35
+ # Rule results that this one blocks.
36
+ #
37
+ # @return [Array<Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking>, nil]
38
+ optional :blocking,
39
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking] }
40
+
41
+ # @!attribute deactivated_reason
42
+ # Why the result was excluded.
43
+ #
44
+ # @return [String, nil]
45
+ optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
46
+
47
+ # @!attribute status_message
48
+ # A human-readable explanation of the status.
49
+ #
50
+ # @return [String, nil]
51
+ optional :status_message, String, api_name: :statusMessage, nil?: true
52
+
53
+ response_only do
54
+ # @!attribute id
55
+ # The rule result id.
56
+ #
57
+ # @return [String]
58
+ required :id, String
59
+
60
+ # @!attribute date_created
61
+ # The creation date.
62
+ #
63
+ # @return [Time]
64
+ required :date_created, Time, api_name: :dateCreated
65
+
66
+ # @!attribute date_updated
67
+ # The last update date.
68
+ #
69
+ # @return [Time]
70
+ required :date_updated, Time, api_name: :dateUpdated
71
+
72
+ # @!attribute rule_id
73
+ # The rule this result belongs to.
74
+ #
75
+ # @return [String]
76
+ required :rule_id, String, api_name: :ruleId
77
+
78
+ # @!attribute workspace_id
79
+ # The id of the workspace the rule result belongs to.
80
+ #
81
+ # @return [String]
82
+ required :workspace_id, String, api_name: :workspaceId
83
+
84
+ # @!attribute date_last_evaluated
85
+ # When the rule was last evaluated. Platform rules only.
86
+ #
87
+ # @return [Time, nil]
88
+ optional :date_last_evaluated, Time, api_name: :dateLastEvaluated, nil?: true
89
+
90
+ # @!attribute date_of_latest_evidence
91
+ # When the most recent piece of evidence was attached. Evidence rules only.
92
+ #
93
+ # @return [Time, nil]
94
+ optional :date_of_latest_evidence, Time, api_name: :dateOfLatestEvidence, nil?: true
95
+
96
+ # @!attribute date_of_next_evaluation
97
+ # When the rule will next be evaluated. Platform rules only.
98
+ #
99
+ # @return [Time, nil]
100
+ optional :date_of_next_evaluation, Time, api_name: :dateOfNextEvaluation, nil?: true
101
+
102
+ # @!attribute date_of_renewal
103
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
104
+ #
105
+ # @return [Time, nil]
106
+ optional :date_of_renewal, Time, api_name: :dateOfRenewal, nil?: true
107
+
108
+ # @!attribute project_id
109
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
110
+ #
111
+ # @return [String, nil]
112
+ optional :project_id, String, api_name: :projectId, nil?: true
113
+ end
114
+
115
+ # @!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)
116
+ # @param id [String] The rule result id.
117
+ #
118
+ # @param date_created [Time] The creation date.
119
+ #
120
+ # @param date_updated [Time] The last update date.
121
+ #
122
+ # @param deactivated [Boolean] Whether this result is excluded from compliance calculations.
123
+ #
124
+ # @param rule_id [String] The rule this result belongs to.
125
+ #
126
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultRetrieveResponse::Status] The compliance status of the rule for this entity.
127
+ #
128
+ # @param workspace_id [String] The id of the workspace the rule result belongs to.
129
+ #
130
+ # @param assignee_id [String, nil] The user responsible for this result.
131
+ #
132
+ # @param blocked_by [Array<Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy>] Rule results that must pass before this one can be satisfied.
133
+ #
134
+ # @param blocking [Array<Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking>] Rule results that this one blocks.
135
+ #
136
+ # @param date_last_evaluated [Time, nil] When the rule was last evaluated. Platform rules only.
137
+ #
138
+ # @param date_of_latest_evidence [Time, nil] When the most recent piece of evidence was attached. Evidence rules only.
139
+ #
140
+ # @param date_of_next_evaluation [Time, nil] When the rule will next be evaluated. Platform rules only.
141
+ #
142
+ # @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
143
+ #
144
+ # @param deactivated_reason [String, nil] Why the result was excluded.
145
+ #
146
+ # @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
147
+ #
148
+ # @param status_message [String, nil] A human-readable explanation of the status.
149
+
150
+ # The compliance status of the rule for this entity.
151
+ #
152
+ # @see Openlayer::Models::Governance::RuleResultRetrieveResponse#status
153
+ module Status
154
+ extend Openlayer::Internal::Type::Enum
155
+
156
+ RUNNING = :running
157
+ PASSING = :passing
158
+ FAILING = :failing
159
+ SKIPPED = :skipped
160
+ ERROR = :error
161
+ PENDING = :pending
162
+ DUE_SOON = :due_soon
163
+
164
+ # @!method self.values
165
+ # @return [Array<Symbol>]
166
+ end
167
+
168
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
169
+ # @!attribute id
170
+ #
171
+ # @return [String, nil]
172
+ optional :id, String
173
+
174
+ # @!attribute status
175
+ # The compliance status of the rule for this entity.
176
+ #
177
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy::Status, nil]
178
+ optional :status,
179
+ enum: -> { Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy::Status }
180
+
181
+ # @!method initialize(id: nil, status: nil)
182
+ # @param id [String]
183
+ #
184
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy::Status] The compliance status of the rule for this entity.
185
+
186
+ # The compliance status of the rule for this entity.
187
+ #
188
+ # @see Openlayer::Models::Governance::RuleResultRetrieveResponse::BlockedBy#status
189
+ module Status
190
+ extend Openlayer::Internal::Type::Enum
191
+
192
+ RUNNING = :running
193
+ PASSING = :passing
194
+ FAILING = :failing
195
+ SKIPPED = :skipped
196
+ ERROR = :error
197
+ PENDING = :pending
198
+ DUE_SOON = :due_soon
199
+
200
+ # @!method self.values
201
+ # @return [Array<Symbol>]
202
+ end
203
+ end
204
+
205
+ class Blocking < Openlayer::Internal::Type::BaseModel
206
+ # @!attribute id
207
+ #
208
+ # @return [String, nil]
209
+ optional :id, String
210
+
211
+ # @!attribute status
212
+ # The compliance status of the rule for this entity.
213
+ #
214
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking::Status, nil]
215
+ optional :status, enum: -> { Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking::Status }
216
+
217
+ # @!method initialize(id: nil, status: nil)
218
+ # @param id [String]
219
+ #
220
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking::Status] The compliance status of the rule for this entity.
221
+
222
+ # The compliance status of the rule for this entity.
223
+ #
224
+ # @see Openlayer::Models::Governance::RuleResultRetrieveResponse::Blocking#status
225
+ module Status
226
+ extend Openlayer::Internal::Type::Enum
227
+
228
+ RUNNING = :running
229
+ PASSING = :passing
230
+ FAILING = :failing
231
+ SKIPPED = :skipped
232
+ ERROR = :error
233
+ PENDING = :pending
234
+ DUE_SOON = :due_soon
235
+
236
+ # @!method self.values
237
+ # @return [Array<Symbol>]
238
+ end
239
+ end
240
+ end
241
+ end
242
+ end
243
+ end
@@ -0,0 +1,140 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::RuleResults#update
7
+ class RuleResultUpdateParams < Openlayer::Internal::Type::BaseModel
8
+ extend Openlayer::Internal::Type::RequestParameters::Converter
9
+ include Openlayer::Internal::Type::RequestParameters
10
+
11
+ # @!attribute rule_result_id
12
+ #
13
+ # @return [String]
14
+ required :rule_result_id, String
15
+
16
+ # @!attribute assignee_id
17
+ # The user responsible for this result.
18
+ #
19
+ # @return [String, nil]
20
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
21
+
22
+ # @!attribute blocked_by
23
+ # Rule results that must pass before this one can be satisfied.
24
+ #
25
+ # @return [Array<Openlayer::Models::Governance::RuleResultUpdateParams::BlockedBy>, nil]
26
+ optional :blocked_by,
27
+ -> {
28
+ Openlayer::Internal::Type::ArrayOf[Openlayer::Governance::RuleResultUpdateParams::BlockedBy]
29
+ },
30
+ api_name: :blockedBy
31
+
32
+ # @!attribute blocking
33
+ # Rule results that this one blocks.
34
+ #
35
+ # @return [Array<Openlayer::Models::Governance::RuleResultUpdateParams::Blocking>, nil]
36
+ optional :blocking,
37
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Governance::RuleResultUpdateParams::Blocking] }
38
+
39
+ # @!attribute deactivated
40
+ # Whether this result is excluded from compliance calculations.
41
+ #
42
+ # @return [Boolean, nil]
43
+ optional :deactivated, Openlayer::Internal::Type::Boolean
44
+
45
+ # @!attribute deactivated_reason
46
+ # Why the result was excluded.
47
+ #
48
+ # @return [String, nil]
49
+ optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
50
+
51
+ # @!method initialize(rule_result_id:, assignee_id: nil, blocked_by: nil, blocking: nil, deactivated: nil, deactivated_reason: nil, request_options: {})
52
+ # @param rule_result_id [String]
53
+ #
54
+ # @param assignee_id [String, nil] The user responsible for this result.
55
+ #
56
+ # @param blocked_by [Array<Openlayer::Models::Governance::RuleResultUpdateParams::BlockedBy>] Rule results that must pass before this one can be satisfied.
57
+ #
58
+ # @param blocking [Array<Openlayer::Models::Governance::RuleResultUpdateParams::Blocking>] Rule results that this one blocks.
59
+ #
60
+ # @param deactivated [Boolean] Whether this result is excluded from compliance calculations.
61
+ #
62
+ # @param deactivated_reason [String, nil] Why the result was excluded.
63
+ #
64
+ # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
65
+
66
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
67
+ # @!attribute id
68
+ #
69
+ # @return [String, nil]
70
+ optional :id, String
71
+
72
+ # @!attribute status
73
+ # The compliance status of the rule for this entity.
74
+ #
75
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultUpdateParams::BlockedBy::Status, nil]
76
+ optional :status, enum: -> { Openlayer::Governance::RuleResultUpdateParams::BlockedBy::Status }
77
+
78
+ # @!method initialize(id: nil, status: nil)
79
+ # @param id [String]
80
+ #
81
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultUpdateParams::BlockedBy::Status] The compliance status of the rule for this entity.
82
+
83
+ # The compliance status of the rule for this entity.
84
+ #
85
+ # @see Openlayer::Models::Governance::RuleResultUpdateParams::BlockedBy#status
86
+ module Status
87
+ extend Openlayer::Internal::Type::Enum
88
+
89
+ RUNNING = :running
90
+ PASSING = :passing
91
+ FAILING = :failing
92
+ SKIPPED = :skipped
93
+ ERROR = :error
94
+ PENDING = :pending
95
+ DUE_SOON = :due_soon
96
+
97
+ # @!method self.values
98
+ # @return [Array<Symbol>]
99
+ end
100
+ end
101
+
102
+ class Blocking < Openlayer::Internal::Type::BaseModel
103
+ # @!attribute id
104
+ #
105
+ # @return [String, nil]
106
+ optional :id, String
107
+
108
+ # @!attribute status
109
+ # The compliance status of the rule for this entity.
110
+ #
111
+ # @return [Symbol, Openlayer::Models::Governance::RuleResultUpdateParams::Blocking::Status, nil]
112
+ optional :status, enum: -> { Openlayer::Governance::RuleResultUpdateParams::Blocking::Status }
113
+
114
+ # @!method initialize(id: nil, status: nil)
115
+ # @param id [String]
116
+ #
117
+ # @param status [Symbol, Openlayer::Models::Governance::RuleResultUpdateParams::Blocking::Status] The compliance status of the rule for this entity.
118
+
119
+ # The compliance status of the rule for this entity.
120
+ #
121
+ # @see Openlayer::Models::Governance::RuleResultUpdateParams::Blocking#status
122
+ module Status
123
+ extend Openlayer::Internal::Type::Enum
124
+
125
+ RUNNING = :running
126
+ PASSING = :passing
127
+ FAILING = :failing
128
+ SKIPPED = :skipped
129
+ ERROR = :error
130
+ PENDING = :pending
131
+ DUE_SOON = :due_soon
132
+
133
+ # @!method self.values
134
+ # @return [Array<Symbol>]
135
+ end
136
+ end
137
+ end
138
+ end
139
+ end
140
+ end