openlayer 0.15.0 → 0.17.0

data/rbi/openlayer/models/governance/rule_result_create_evidence_params.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleResultCreateEvidenceParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Governance::RuleResultCreateEvidenceParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :rule_result_id
+
+        # A description of what the evidence shows.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The evidence name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+        # `document`. Upload the file first with `POST /storage/presigned-url` and send
+        # the storage URI it returns.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :storage_uri
+
+        # The evidence text. Set when the rule's `evidenceType` is `text`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text
+
+        # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig do
+          params(
+            rule_result_id: String,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            storage_uri: T.nilable(String),
+            text: T.nilable(String),
+            url: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          rule_result_id:,
+          # A description of what the evidence shows.
+          description: nil,
+          # The evidence name.
+          name: nil,
+          # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
+          storage_uri: nil,
+          # The evidence text. Set when the rule's `evidenceType` is `text`.
+          text: nil,
+          # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+          url: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              rule_result_id: String,
+              description: T.nilable(String),
+              name: T.nilable(String),
+              storage_uri: T.nilable(String),
+              text: T.nilable(String),
+              url: T.nilable(String),
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleResultCreateEvidenceResponse < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Governance::RuleResultCreateEvidenceResponse,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        # A description of what the evidence shows.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The evidence name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+        # `document`. Upload the file first with `POST /storage/presigned-url` and send
+        # the storage URI it returns.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :storage_uri
+
+        # The evidence text. Set when the rule's `evidenceType` is `text`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text
+
+        # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # The evidence id.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The user who attached the evidence.
+        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
+
+        # Evidence attached to a rule result to satisfy an evidence rule. Which field
+        # holds it depends on the rule's `evidenceType`: `storageUri` for a document,
+        # `text` for a written statement, or `url` for a link.
+        sig do
+          params(
+            id: String,
+            creator_id: T.nilable(String),
+            date_created: Time,
+            date_updated: Time,
+            description: T.nilable(String),
+            name: T.nilable(String),
+            storage_uri: T.nilable(String),
+            text: T.nilable(String),
+            url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The evidence id.
+          id:,
+          # The user who attached the evidence.
+          creator_id:,
+          # The creation date.
+          date_created:,
+          # The last update date.
+          date_updated:,
+          # A description of what the evidence shows.
+          description: nil,
+          # The evidence name.
+          name: nil,
+          # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
+          storage_uri: nil,
+          # The evidence text. Set when the rule's `evidenceType` is `text`.
+          text: nil,
+          # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+          url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              creator_id: T.nilable(String),
+              date_created: Time,
+              date_updated: Time,
+              description: T.nilable(String),
+              name: T.nilable(String),
+              storage_uri: T.nilable(String),
+              text: T.nilable(String),
+              url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/governance/rule_result_list_evidence_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleResultListEvidenceParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Governance::RuleResultListEvidenceParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :rule_result_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(
+            rule_result_id: String,
+            page: Integer,
+            per_page: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          rule_result_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(
+            {
+              rule_result_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_result_list_evidence_response.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Governance
+      class RuleResultListEvidenceResponse < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Governance::RuleResultListEvidenceResponse,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item
+            ]
+          )
+        end
+        attr_accessor :items
+
+        sig do
+          params(
+            items:
+              T::Array[
+                Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(items:)
+        end
+
+        sig do
+          override.returns(
+            {
+              items:
+                T::Array[
+                  Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item,
+                Openlayer::Internal::AnyHash
+              )
+            end
+
+          # A description of what the evidence shows.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # The evidence name.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+          # `document`. Upload the file first with `POST /storage/presigned-url` and send
+          # the storage URI it returns.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :storage_uri
+
+          # The evidence text. Set when the rule's `evidenceType` is `text`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :text
+
+          # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :url
+
+          # The evidence id.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The user who attached the evidence.
+          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
+
+          # Evidence attached to a rule result to satisfy an evidence rule. Which field
+          # holds it depends on the rule's `evidenceType`: `storageUri` for a document,
+          # `text` for a written statement, or `url` for a link.
+          sig do
+            params(
+              id: String,
+              creator_id: T.nilable(String),
+              date_created: Time,
+              date_updated: Time,
+              description: T.nilable(String),
+              name: T.nilable(String),
+              storage_uri: T.nilable(String),
+              text: T.nilable(String),
+              url: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The evidence id.
+            id:,
+            # The user who attached the evidence.
+            creator_id:,
+            # The creation date.
+            date_created:,
+            # The last update date.
+            date_updated:,
+            # A description of what the evidence shows.
+            description: nil,
+            # The evidence name.
+            name: nil,
+            # Where the uploaded file is stored. Set when the rule's `evidenceType` is
+            # `document`. Upload the file first with `POST /storage/presigned-url` and send
+            # the storage URI it returns.
+            storage_uri: nil,
+            # The evidence text. Set when the rule's `evidenceType` is `text`.
+            text: nil,
+            # A link to the evidence. Set when the rule's `evidenceType` is `url`.
+            url: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                creator_id: T.nilable(String),
+                date_created: Time,
+                date_updated: Time,
+                description: T.nilable(String),
+                name: T.nilable(String),
+                storage_uri: T.nilable(String),
+                text: T.nilable(String),
+                url: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end