openlayer 0.15.0 → 0.17.0

data/lib/openlayer/resources/governance/frameworks.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        # @return [Openlayer::Resources::Governance::Frameworks::Documents]
+        attr_reader :documents
+
+        # @return [Openlayer::Resources::Governance::Frameworks::Sections]
+        attr_reader :sections
+
+        # @return [Openlayer::Resources::Governance::Frameworks::Subsections]
+        attr_reader :subsections
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::FrameworkCreateParams} for more details.
+        #
+        # Create a custom framework in a workspace.
+        #
+        # @overload create(workspace_id, name:, description: nil, enabled: nil, project_selector: nil, tags: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param name [String] The framework name.
+        #
+        # @param description [String, nil] A short description of the framework.
+        #
+        # @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated
+        #
+        # @param project_selector [Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
+        #
+        # @param tags [Array<String>] Free-form labels on the framework.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkCreateResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkCreateParams
+        def create(workspace_id, params)
+          parsed, options = Openlayer::Governance::FrameworkCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["workspaces/%1$s/frameworks", workspace_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::FrameworkCreateResponse,
+            options: options
+          )
+        end
+
+        # Retrieve a framework.
+        #
+        # @overload retrieve(framework_id, request_options: {})
+        #
+        # @param framework_id [String] The framework id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkRetrieveResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkRetrieveParams
+        def retrieve(framework_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["frameworks/%1$s", framework_id],
+            model: Openlayer::Models::Governance::FrameworkRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::FrameworkUpdateParams} for more details.
+        #
+        # Update a framework.
+        #
+        # @overload update(framework_id, avatar: nil, description: nil, enabled: nil, extended_description: nil, href: nil, name: nil, project_selector: nil, tags: nil, request_options: {})
+        #
+        # @param framework_id [String] The framework id.
+        #
+        # @param avatar [Openlayer::Models::Governance::FrameworkUpdateParams::Avatar, nil] The icon shown for the framework.
+        #
+        # @param description [String, nil] A short description of the framework.
+        #
+        # @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated
+        #
+        # @param extended_description [Hash{Symbol=>Object}, nil] A longer, rich-text description, as a TipTap JSON document.
+        #
+        # @param href [String, nil] A link to the external standard or regulation the framework is based on.
+        #
+        # @param name [String] The framework name.
+        #
+        # @param project_selector [Openlayer::Models::Governance::FrameworkUpdateParams::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
+        #
+        # @param tags [Array<String>] Free-form labels on the framework.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkUpdateResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkUpdateParams
+        def update(framework_id, params = {})
+          parsed, options = Openlayer::Governance::FrameworkUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["frameworks/%1$s", framework_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::FrameworkUpdateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::FrameworkListParams} for more details.
+        #
+        # List the frameworks in a workspace.
+        #
+        # @overload list(workspace_id, asc: nil, completion_operator: nil, completion_value: nil, enabled: nil, include_rule_stats: nil, page: nil, per_page: nil, project_id: nil, search_query: nil, sort_column: nil, tags: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param asc [Boolean] Whether to sort in ascending order.
+        #
+        # @param completion_operator [Symbol, Openlayer::Models::Governance::FrameworkListParams::CompletionOperator] How to compare each framework's completion percentage with `completionValue`. Mu
+        #
+        # @param completion_value [Integer] The completion percentage to compare against, from 0 to 100.
+        #
+        # @param enabled [Boolean] Only include frameworks that are enabled (or disabled).
+        #
+        # @param include_rule_stats [Boolean] Whether to include a `ruleStats` object on each framework, with its rule result
+        #
+        # @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 search_query [String] Filter by a free-text search over names and descriptions.
+        #
+        # @param sort_column [Symbol, Openlayer::Models::Governance::FrameworkListParams::SortColumn] The column to sort on.
+        #
+        # @param tags [Array<String>] Only include frameworks carrying all of these tags.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkListResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkListParams
+        def list(workspace_id, params = {})
+          parsed, options = Openlayer::Governance::FrameworkListParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/frameworks", workspace_id],
+            query: query.transform_keys(
+              completion_operator: "completionOperator",
+              completion_value: "completionValue",
+              include_rule_stats: "includeRuleStats",
+              per_page: "perPage",
+              project_id: "projectId",
+              search_query: "searchQuery",
+              sort_column: "sortColumn"
+            ),
+            model: Openlayer::Models::Governance::FrameworkListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::FrameworkExportParams} for more details.
+        #
+        # Export a framework as an audit-ready zip archive.
+        #
+        # @overload export(framework_id, project_id: nil, request_options: {})
+        #
+        # @param framework_id [String] The framework id.
+        #
+        # @param project_id [String, nil] Scope the export to this project. It must belong to the framework. Omit it for t
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkExportResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkExportParams
+        def export(framework_id, params = {})
+          parsed, options = Openlayer::Governance::FrameworkExportParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["frameworks/%1$s/export", framework_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::FrameworkExportResponse,
+            options: options
+          )
+        end
+
+        # List a framework's compliance stats per project.
+        #
+        # @overload list_project_rule_stats(framework_id, asc: nil, page: nil, per_page: nil, sort_column: nil, request_options: {})
+        #
+        # @param framework_id [String] The framework id.
+        #
+        # @param asc [Boolean] Whether to sort in ascending order.
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param sort_column [Symbol, Openlayer::Models::Governance::FrameworkListProjectRuleStatsParams::SortColumn] The column to sort on.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkListProjectRuleStatsParams
+        def list_project_rule_stats(framework_id, params = {})
+          parsed, options = Openlayer::Governance::FrameworkListProjectRuleStatsParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["frameworks/%1$s/project-rule-stats", framework_id],
+            query: query.transform_keys(per_page: "perPage", sort_column: "sortColumn"),
+            model: Openlayer::Models::Governance::FrameworkListProjectRuleStatsResponse,
+            options: options
+          )
+        end
+
+        # List the projects a framework applies to.
+        #
+        # @overload list_projects(framework_id, page: nil, per_page: nil, request_options: {})
+        #
+        # @param framework_id [String] The framework id.
+        #
+        # @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}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkListProjectsResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkListProjectsParams
+        def list_projects(framework_id, params = {})
+          parsed, options = Openlayer::Governance::FrameworkListProjectsParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["frameworks/%1$s/projects", framework_id],
+            query: query.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Governance::FrameworkListProjectsResponse,
+            options: options
+          )
+        end
+
+        # List the rules in a framework.
+        #
+        # @overload list_rules(framework_id, page: nil, per_page: nil, request_options: {})
+        #
+        # @param framework_id [String] The framework id.
+        #
+        # @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}, nil]
+        #
+        # @return [Openlayer::Models::Governance::FrameworkListRulesResponse]
+        #
+        # @see Openlayer::Models::Governance::FrameworkListRulesParams
+        def list_rules(framework_id, params = {})
+          parsed, options = Openlayer::Governance::FrameworkListRulesParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["frameworks/%1$s/rules", framework_id],
+            query: query.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Governance::FrameworkListRulesResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+          @documents = Openlayer::Resources::Governance::Frameworks::Documents.new(client: client)
+          @sections = Openlayer::Resources::Governance::Frameworks::Sections.new(client: client)
+          @subsections = Openlayer::Resources::Governance::Frameworks::Subsections.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/governance/rule_results.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class RuleResults
+        # Retrieve a rule result.
+        #
+        # @overload retrieve(rule_result_id, request_options: {})
+        #
+        # @param rule_result_id [String] The rule result id.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleResultRetrieveResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleResultRetrieveParams
+        def retrieve(rule_result_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["rule-results/%1$s", rule_result_id],
+            model: Openlayer::Models::Governance::RuleResultRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::RuleResultUpdateParams} for more details.
+        #
+        # Update a rule result.
+        #
+        # @overload update(rule_result_id, assignee_id: nil, blocked_by: nil, blocking: nil, deactivated: nil, deactivated_reason: nil, request_options: {})
+        #
+        # @param rule_result_id [String] The rule result id.
+        #
+        # @param assignee_id [String, nil] The user responsible for this result.
+        #
+        # @param blocked_by [Array<Openlayer::Models::Governance::RuleResultUpdateParams::BlockedBy>] Rule results that must pass before this one can be satisfied.
+        #
+        # @param blocking [Array<Openlayer::Models::Governance::RuleResultUpdateParams::Blocking>] Rule results that this one blocks.
+        #
+        # @param deactivated [Boolean] Whether this result is excluded from compliance calculations. Excludes just this
+        #
+        # @param deactivated_reason [String, nil] Why the result was excluded. Required when setting `deactivated` to `true`.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleResultUpdateResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleResultUpdateParams
+        def update(rule_result_id, params = {})
+          parsed, options = Openlayer::Governance::RuleResultUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["rule-results/%1$s", rule_result_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::RuleResultUpdateResponse,
+            options: options
+          )
+        end
+
+        # List the rule results in a workspace.
+        #
+        # @overload list(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] The workspace id.
+        #
+        # @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}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleResultListResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleResultListParams
+        def list(workspace_id, params = {})
+          parsed, options = Openlayer::Governance::RuleResultListParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/rule-results", workspace_id],
+            query: query.transform_keys(
+              enabled_framework_only: "enabledFrameworkOnly",
+              framework_id: "frameworkId",
+              include_unframed: "includeUnframed",
+              per_page: "perPage",
+              project_id: "projectId",
+              rule_id: "ruleId",
+              search_query: "searchQuery"
+            ),
+            model: Openlayer::Models::Governance::RuleResultListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Openlayer::Models::Governance::RuleResultCreateEvidenceParams} for more
+        # details.
+        #
+        # Attach evidence to a rule result.
+        #
+        # @overload create_evidence(rule_result_id, description: nil, name: nil, storage_uri: nil, text: nil, url: nil, request_options: {})
+        #
+        # @param rule_result_id [String] The rule result id.
+        #
+        # @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}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleResultCreateEvidenceResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleResultCreateEvidenceParams
+        def create_evidence(rule_result_id, params = {})
+          parsed, options = Openlayer::Governance::RuleResultCreateEvidenceParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["rule-results/%1$s/evidence", rule_result_id],
+            body: parsed,
+            model: Openlayer::Models::Governance::RuleResultCreateEvidenceResponse,
+            options: options
+          )
+        end
+
+        # List the evidence attached to a rule result.
+        #
+        # @overload list_evidence(rule_result_id, page: nil, per_page: nil, request_options: {})
+        #
+        # @param rule_result_id [String] The rule result id.
+        #
+        # @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}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleResultListEvidenceResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleResultListEvidenceParams
+        def list_evidence(rule_result_id, params = {})
+          parsed, options = Openlayer::Governance::RuleResultListEvidenceParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["rule-results/%1$s/evidence", rule_result_id],
+            query: query.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Governance::RuleResultListEvidenceResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/governance/rule_stats.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class RuleStats
+        # Get compliance statistics for a workspace.
+        #
+        # @overload retrieve(workspace_id, framework_id: nil, project_id: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param framework_id [String] Only include items belonging to this framework.
+        #
+        # @param project_id [String] Only include items that apply to this project.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleStatRetrieveResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleStatRetrieveParams
+        def retrieve(workspace_id, params = {})
+          parsed, options = Openlayer::Governance::RuleStatRetrieveParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/rule-stats", workspace_id],
+            query: query.transform_keys(framework_id: "frameworkId", project_id: "projectId"),
+            model: Openlayer::Models::Governance::RuleStatRetrieveResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/governance/rule_tags.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class RuleTags
+        # List the rule tags in a workspace.
+        #
+        # @overload list(workspace_id, page: nil, per_page: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @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}, nil]
+        #
+        # @return [Openlayer::Models::Governance::RuleTagListResponse]
+        #
+        # @see Openlayer::Models::Governance::RuleTagListParams
+        def list(workspace_id, params = {})
+          parsed, options = Openlayer::Governance::RuleTagListParams.dump_request(params)
+          query = Openlayer::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/rule-tags", workspace_id],
+            query: query.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Governance::RuleTagListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end