openlayer 0.15.0 → 0.17.0

data/rbi/openlayer/models/governance/rule_tag_list_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleTagListParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Governance::RuleTagListParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :workspace_id
+
+        # The page to return in a paginated query.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page
+
+        sig { params(page: Integer).void }
+        attr_writer :page
+
+        # Maximum number of items to return per page.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :per_page
+
+        sig { params(per_page: Integer).void }
+        attr_writer :per_page
+
+        sig do
+          params(
+            workspace_id: String,
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          workspace_id:,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              workspace_id: String,
+              page: Integer,
+              per_page: Integer,
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/governance/rule_tag_list_response.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleTagListResponse < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Governance::RuleTagListResponse,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[Openlayer::Models::Governance::RuleTagListResponse::Item]
+          )
+        end
+        attr_accessor :items
+
+        sig do
+          params(
+            items:
+              T::Array[
+                Openlayer::Models::Governance::RuleTagListResponse::Item::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(items:)
+        end
+
+        sig do
+          override.returns(
+            {
+              items:
+                T::Array[
+                  Openlayer::Models::Governance::RuleTagListResponse::Item
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Openlayer::Models::Governance::RuleTagListResponse::Item,
+                Openlayer::Internal::AnyHash
+              )
+            end
+
+          # The tag name.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # The color the tag is displayed with.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :color
+
+          # The rule tag id.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The user who created the tag. `null` for tags that ship with Openlayer.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :creator_id
+
+          # The creation date.
+          sig { returns(Time) }
+          attr_accessor :date_created
+
+          # The last update date.
+          sig { returns(Time) }
+          attr_accessor :date_updated
+
+          # Whether the tag is managed by Openlayer. These tags can't be deleted.
+          sig { returns(T::Boolean) }
+          attr_accessor :immutable
+
+          # The id of the workspace the tag belongs to.
+          sig { returns(String) }
+          attr_accessor :workspace_id
+
+          # A label that groups rules across frameworks, for example by team or control
+          # family.
+          sig do
+            params(
+              id: String,
+              creator_id: T.nilable(String),
+              date_created: Time,
+              date_updated: Time,
+              immutable: T::Boolean,
+              name: String,
+              workspace_id: String,
+              color: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The rule tag id.
+            id:,
+            # The user who created the tag. `null` for tags that ship with Openlayer.
+            creator_id:,
+            # The creation date.
+            date_created:,
+            # The last update date.
+            date_updated:,
+            # Whether the tag is managed by Openlayer. These tags can't be deleted.
+            immutable:,
+            # The tag name.
+            name:,
+            # The id of the workspace the tag belongs to.
+            workspace_id:,
+            # The color the tag is displayed with.
+            color: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                creator_id: T.nilable(String),
+                date_created: Time,
+                date_updated: Time,
+                immutable: T::Boolean,
+                name: String,
+                workspace_id: String,
+                color: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/governance/rule_update_params.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleUpdateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Governance::RuleUpdateParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :rule_id
+
+        # The user responsible for satisfying the rule.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :assignee_id
+
+        # Whether the rule is excluded from compliance calculations.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :deactivated
+
+        sig { params(deactivated: T::Boolean).void }
+        attr_writer :deactivated
+
+        # What the rule requires.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The rule name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # How often evidence must be renewed, in days. Once evidence is older than this,
+        # the rule result becomes `due_soon` and then `failing`. The window restarts
+        # whenever evidence is attached. Omit or `null` for platform rules.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :renewal_cadence_days
+
+        # The ids of the rule tags to associate with the rule. Replaces the rule's tags.
+        # Read them back from `tags`, and list the tags available in the workspace with
+        # `GET /workspaces/{workspaceId}/rule-tags`.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :tag_ids
+
+        sig do
+          params(
+            rule_id: String,
+            assignee_id: T.nilable(String),
+            deactivated: T::Boolean,
+            description: T.nilable(String),
+            name: String,
+            renewal_cadence_days: T.nilable(Integer),
+            tag_ids: T.nilable(T::Array[String]),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          rule_id:,
+          # The user responsible for satisfying the rule.
+          assignee_id: nil,
+          # Whether the rule is excluded from compliance calculations.
+          deactivated: nil,
+          # What the rule requires.
+          description: nil,
+          # The rule name.
+          name: nil,
+          # How often evidence must be renewed, in days. Once evidence is older than this,
+          # the rule result becomes `due_soon` and then `failing`. The window restarts
+          # whenever evidence is attached. Omit or `null` for platform rules.
+          renewal_cadence_days: nil,
+          # The ids of the rule tags to associate with the rule. Replaces the rule's tags.
+          # Read them back from `tags`, and list the tags available in the workspace with
+          # `GET /workspaces/{workspaceId}/rule-tags`.
+          tag_ids: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              rule_id: String,
+              assignee_id: T.nilable(String),
+              deactivated: T::Boolean,
+              description: T.nilable(String),
+              name: String,
+              renewal_cadence_days: T.nilable(Integer),
+              tag_ids: T.nilable(T::Array[String]),
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end