openlayer 0.15.0 → 0.17.0

data/lib/openlayer/models/governance/rule_result_create_evidence_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::RuleResults#create_evidence
+      class RuleResultCreateEvidenceParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute rule_result_id
+        #
+        #   @return [String]
+        required :rule_result_id, String
+
+        # @!attribute description
+        #   A description of what the evidence shows.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The evidence name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute storage_uri
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :storage_uri, String, api_name: :storageUri, nil?: true
+
+        # @!attribute text
+        #   The evidence text. Set when the rule's `evidenceType` is `text`.
+        #
+        #   @return [String, nil]
+        optional :text, String, nil?: true
+
+        # @!attribute url
+        #   A link to the evidence. Set when the rule's `evidenceType` is `url`.
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(rule_result_id:, description: nil, name: nil, storage_uri: nil, text: nil, url: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Openlayer::Models::Governance::RuleResultCreateEvidenceParams} for more
+        #   details.
+        #
+        #   @param rule_result_id [String]
+        #
+        #   @param description [String, nil] A description of what the evidence shows.
+        #
+        #   @param name [String, nil] The evidence name.
+        #
+        #   @param storage_uri [String, nil] Where the uploaded file is stored. Set when the rule's `evidenceType` is `docume
+        #
+        #   @param text [String, nil] The evidence text. Set when the rule's `evidenceType` is `text`.
+        #
+        #   @param url [String, nil] A link to the evidence. Set when the rule's `evidenceType` is `url`.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/rule_result_create_evidence_response.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::RuleResults#create_evidence
+      class RuleResultCreateEvidenceResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute description
+        #   A description of what the evidence shows.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The evidence name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute storage_uri
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :storage_uri, String, api_name: :storageUri, nil?: true
+
+        # @!attribute text
+        #   The evidence text. Set when the rule's `evidenceType` is `text`.
+        #
+        #   @return [String, nil]
+        optional :text, String, nil?: true
+
+        # @!attribute url
+        #   A link to the evidence. Set when the rule's `evidenceType` is `url`.
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        response_only do
+          # @!attribute id
+          #   The evidence id.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute creator_id
+          #   The user who attached the evidence.
+          #
+          #   @return [String, nil]
+          required :creator_id, String, api_name: :creatorId, nil?: true
+
+          # @!attribute date_created
+          #   The creation date.
+          #
+          #   @return [Time]
+          required :date_created, Time, api_name: :dateCreated
+
+          # @!attribute date_updated
+          #   The last update date.
+          #
+          #   @return [Time]
+          required :date_updated, Time, api_name: :dateUpdated
+        end
+
+        # @!method initialize(id:, creator_id:, date_created:, date_updated:, description: nil, name: nil, storage_uri: nil, text: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Openlayer::Models::Governance::RuleResultCreateEvidenceResponse} for more
+        #   details.
+        #
+        #   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.
+        #
+        #   @param id [String] The evidence id.
+        #
+        #   @param creator_id [String, nil] The user who attached the evidence.
+        #
+        #   @param date_created [Time] The creation date.
+        #
+        #   @param date_updated [Time] The last update date.
+        #
+        #   @param description [String, nil] A description of what the evidence shows.
+        #
+        #   @param name [String, nil] The evidence name.
+        #
+        #   @param storage_uri [String, nil] Where the uploaded file is stored. Set when the rule's `evidenceType` is `docume
+        #
+        #   @param text [String, nil] The evidence text. Set when the rule's `evidenceType` is `text`.
+        #
+        #   @param url [String, nil] A link to the evidence. Set when the rule's `evidenceType` is `url`.
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/rule_result_list_evidence_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::RuleResults#list_evidence
+      class RuleResultListEvidenceParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute rule_result_id
+        #
+        #   @return [String]
+        required :rule_result_id, String
+
+        # @!attribute page
+        #   The page to return in a paginated query.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!attribute per_page
+        #   Maximum number of items to return per page.
+        #
+        #   @return [Integer, nil]
+        optional :per_page, Integer
+
+        # @!method initialize(rule_result_id:, page: nil, per_page: nil, request_options: {})
+        #   @param rule_result_id [String]
+        #
+        #   @param page [Integer] The page to return in a paginated query.
+        #
+        #   @param per_page [Integer] Maximum number of items to return per page.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/rule_result_list_evidence_response.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::RuleResults#list_evidence
+      class RuleResultListEvidenceResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item>]
+        required :items,
+                 -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item] }
+
+        # @!method initialize(items:)
+        #   @param items [Array<Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item>]
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          # @!attribute description
+          #   A description of what the evidence shows.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute name
+          #   The evidence name.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute storage_uri
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :storage_uri, String, api_name: :storageUri, nil?: true
+
+          # @!attribute text
+          #   The evidence text. Set when the rule's `evidenceType` is `text`.
+          #
+          #   @return [String, nil]
+          optional :text, String, nil?: true
+
+          # @!attribute url
+          #   A link to the evidence. Set when the rule's `evidenceType` is `url`.
+          #
+          #   @return [String, nil]
+          optional :url, String, nil?: true
+
+          response_only do
+            # @!attribute id
+            #   The evidence id.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute creator_id
+            #   The user who attached the evidence.
+            #
+            #   @return [String, nil]
+            required :creator_id, String, api_name: :creatorId, nil?: true
+
+            # @!attribute date_created
+            #   The creation date.
+            #
+            #   @return [Time]
+            required :date_created, Time, api_name: :dateCreated
+
+            # @!attribute date_updated
+            #   The last update date.
+            #
+            #   @return [Time]
+            required :date_updated, Time, api_name: :dateUpdated
+          end
+
+          # @!method initialize(id:, creator_id:, date_created:, date_updated:, description: nil, name: nil, storage_uri: nil, text: nil, url: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Openlayer::Models::Governance::RuleResultListEvidenceResponse::Item} for more
+          #   details.
+          #
+          #   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.
+          #
+          #   @param id [String] The evidence id.
+          #
+          #   @param creator_id [String, nil] The user who attached the evidence.
+          #
+          #   @param date_created [Time] The creation date.
+          #
+          #   @param date_updated [Time] The last update date.
+          #
+          #   @param description [String, nil] A description of what the evidence shows.
+          #
+          #   @param name [String, nil] The evidence name.
+          #
+          #   @param storage_uri [String, nil] Where the uploaded file is stored. Set when the rule's `evidenceType` is `docume
+          #
+          #   @param text [String, nil] The evidence text. Set when the rule's `evidenceType` is `text`.
+          #
+          #   @param url [String, nil] A link to the evidence. Set when the rule's `evidenceType` is `url`.
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/rule_result_list_params.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      # @see Openlayer::Resources::Governance::RuleResults#list
+      class RuleResultListParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute workspace_id
+        #
+        #   @return [String]
+        required :workspace_id, String
+
+        # @!attribute enabled_framework_only
+        #   Only include items belonging to at least one enabled framework.
+        #
+        #   @return [Boolean, nil]
+        optional :enabled_framework_only, Openlayer::Internal::Type::Boolean
+
+        # @!attribute framework_id
+        #   Only include items belonging to this framework.
+        #
+        #   @return [String, nil]
+        optional :framework_id, String
+
+        # @!attribute include_unframed
+        #   Whether to include rules that are not part of any framework.
+        #
+        #   @return [Boolean, nil]
+        optional :include_unframed, Openlayer::Internal::Type::Boolean
+
+        # @!attribute page
+        #   The page to return in a paginated query.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!attribute per_page
+        #   Maximum number of items to return per page.
+        #
+        #   @return [Integer, nil]
+        optional :per_page, Integer
+
+        # @!attribute project_id
+        #   Only include items that apply to this project.
+        #
+        #   @return [String, nil]
+        optional :project_id, String
+
+        # @!attribute rule_id
+        #   Only include results of this rule.
+        #
+        #   @return [String, nil]
+        optional :rule_id, String
+
+        # @!attribute scope
+        #   Only include rules with this scope.
+        #
+        #   @return [Symbol, Openlayer::Models::Governance::RuleResultListParams::Scope, nil]
+        optional :scope, enum: -> { Openlayer::Governance::RuleResultListParams::Scope }
+
+        # @!attribute search_query
+        #   Filter by a free-text search over names and descriptions.
+        #
+        #   @return [String, nil]
+        optional :search_query, String
+
+        # @!attribute status
+        #   Only include items whose rule result has this compliance status.
+        #
+        #   @return [Symbol, Openlayer::Models::Governance::RuleResultListParams::Status, nil]
+        optional :status, enum: -> { Openlayer::Governance::RuleResultListParams::Status }
+
+        # @!attribute type
+        #   Only include rules of this type.
+        #
+        #   @return [Symbol, Openlayer::Models::Governance::RuleResultListParams::Type, nil]
+        optional :type, enum: -> { Openlayer::Governance::RuleResultListParams::Type }
+
+        # @!method initialize(workspace_id:, enabled_framework_only: nil, framework_id: nil, include_unframed: nil, page: nil, per_page: nil, project_id: nil, rule_id: nil, scope: nil, search_query: nil, status: nil, type: nil, request_options: {})
+        #   @param workspace_id [String]
+        #
+        #   @param enabled_framework_only [Boolean] Only include items belonging to at least one enabled framework.
+        #
+        #   @param framework_id [String] Only include items belonging to this framework.
+        #
+        #   @param include_unframed [Boolean] Whether to include rules that are not part of any framework.
+        #
+        #   @param page [Integer] The page to return in a paginated query.
+        #
+        #   @param per_page [Integer] Maximum number of items to return per page.
+        #
+        #   @param project_id [String] Only include items that apply to this project.
+        #
+        #   @param rule_id [String] Only include results of this rule.
+        #
+        #   @param scope [Symbol, Openlayer::Models::Governance::RuleResultListParams::Scope] Only include rules with this scope.
+        #
+        #   @param search_query [String] Filter by a free-text search over names and descriptions.
+        #
+        #   @param status [Symbol, Openlayer::Models::Governance::RuleResultListParams::Status] Only include items whose rule result has this compliance status.
+        #
+        #   @param type [Symbol, Openlayer::Models::Governance::RuleResultListParams::Type] Only include rules of this type.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+
+        # Only include rules with this scope.
+        module Scope
+          extend Openlayer::Internal::Type::Enum
+
+          PROJECT = :project
+          WORKSPACE = :workspace
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Only include items whose rule result has this compliance status.
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          RUNNING = :running
+          PASSING = :passing
+          FAILING = :failing
+          SKIPPED = :skipped
+          ERROR = :error
+          PENDING = :pending
+          DUE_SOON = :due_soon
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Only include rules of this type.
+        module Type
+          extend Openlayer::Internal::Type::Enum
+
+          PLATFORM = :platform
+          EVIDENCE = :evidence
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end