openlayer 0.16.0 → 0.17.0

data/rbi/openlayer/models/workspaces/api_key_rotate_response.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyRotateResponse < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Workspaces::APIKeyRotateResponse,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        # When the key stops authenticating. `null` means the key never expires. Set when
+        # the key is created or rotated, and must be in the future. When the request is
+        # authenticated with an API key that expires, the result can't be later than that
+        # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+        # keep the current one. It can't be changed with an update; rotate the key
+        # instead.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
+        # The API key name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The API key id.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The API key creation date.
+        sig { returns(Time) }
+        attr_accessor :date_created
+
+        # The API key last use date.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :date_last_used
+
+        # The API key last update date.
+        sig { returns(Time) }
+        attr_accessor :date_updated
+
+        # An obfuscated hint of the API key value. When a key is created or rotated this
+        # also holds the full secret, for backward compatibility; prefer `secret`.
+        sig { returns(String) }
+        attr_accessor :secure_key
+
+        # The key's lifecycle state. `active`: the current secret authenticates.
+        # `rotating`: the key was rotated and the previous secret still authenticates
+        # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+        # authenticates, and the key can't be rotated.
+        sig do
+          returns(
+            Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # When the key was last rotated.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :last_rotated_at
+
+        # While `status` is `rotating`, when the previous secret stops authenticating.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :previous_key_expires_at
+
+        # The full API key. Only present in the response that creates or rotates the key,
+        # and never shown again.
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret
+
+        sig { params(secret: String).void }
+        attr_writer :secret
+
+        sig do
+          params(
+            id: String,
+            date_created: Time,
+            date_last_used: T.nilable(Time),
+            date_updated: Time,
+            secure_key: String,
+            status:
+              Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::OrSymbol,
+            expires_at: T.nilable(Time),
+            last_rotated_at: T.nilable(Time),
+            name: T.nilable(String),
+            previous_key_expires_at: T.nilable(Time),
+            secret: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The API key id.
+          id:,
+          # The API key creation date.
+          date_created:,
+          # The API key last use date.
+          date_last_used:,
+          # The API key last update date.
+          date_updated:,
+          # An obfuscated hint of the API key value. When a key is created or rotated this
+          # also holds the full secret, for backward compatibility; prefer `secret`.
+          secure_key:,
+          # The key's lifecycle state. `active`: the current secret authenticates.
+          # `rotating`: the key was rotated and the previous secret still authenticates
+          # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+          # authenticates, and the key can't be rotated.
+          status:,
+          # When the key stops authenticating. `null` means the key never expires. Set when
+          # the key is created or rotated, and must be in the future. When the request is
+          # authenticated with an API key that expires, the result can't be later than that
+          # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+          # keep the current one. It can't be changed with an update; rotate the key
+          # instead.
+          expires_at: nil,
+          # When the key was last rotated.
+          last_rotated_at: nil,
+          # The API key name.
+          name: nil,
+          # While `status` is `rotating`, when the previous secret stops authenticating.
+          previous_key_expires_at: nil,
+          # The full API key. Only present in the response that creates or rotates the key,
+          # and never shown again.
+          secret: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              date_created: Time,
+              date_last_used: T.nilable(Time),
+              date_updated: Time,
+              secure_key: String,
+              status:
+                Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::TaggedSymbol,
+              expires_at: T.nilable(Time),
+              last_rotated_at: T.nilable(Time),
+              name: T.nilable(String),
+              previous_key_expires_at: T.nilable(Time),
+              secret: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The key's lifecycle state. `active`: the current secret authenticates.
+        # `rotating`: the key was rotated and the previous secret still authenticates
+        # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+        # authenticates, and the key can't be rotated.
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Openlayer::Models::Workspaces::APIKeyRotateResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::TaggedSymbol
+            )
+          ROTATING =
+            T.let(
+              :rotating,
+              Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Models::Workspaces::APIKeyRotateResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/workspaces/api_key_update_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyUpdateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Workspaces::APIKeyUpdateParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :workspace_id
+
+        sig { returns(String) }
+        attr_accessor :api_key_id
+
+        # The API key name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            workspace_id: String,
+            api_key_id: String,
+            name: T.nilable(String),
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          workspace_id:,
+          api_key_id:,
+          # The API key name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              workspace_id: String,
+              api_key_id: String,
+              name: T.nilable(String),
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/workspaces/api_key_update_response.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyUpdateResponse < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Workspaces::APIKeyUpdateResponse,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        # When the key stops authenticating. `null` means the key never expires. Set when
+        # the key is created or rotated, and must be in the future. When the request is
+        # authenticated with an API key that expires, the result can't be later than that
+        # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+        # keep the current one. It can't be changed with an update; rotate the key
+        # instead.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
+        # The API key name.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The API key id.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The API key creation date.
+        sig { returns(Time) }
+        attr_accessor :date_created
+
+        # The API key last use date.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :date_last_used
+
+        # The API key last update date.
+        sig { returns(Time) }
+        attr_accessor :date_updated
+
+        # An obfuscated hint of the API key value. When a key is created or rotated this
+        # also holds the full secret, for backward compatibility; prefer `secret`.
+        sig { returns(String) }
+        attr_accessor :secure_key
+
+        # The key's lifecycle state. `active`: the current secret authenticates.
+        # `rotating`: the key was rotated and the previous secret still authenticates
+        # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+        # authenticates, and the key can't be rotated.
+        sig do
+          returns(
+            Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # When the key was last rotated.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :last_rotated_at
+
+        # While `status` is `rotating`, when the previous secret stops authenticating.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :previous_key_expires_at
+
+        # The full API key. Only present in the response that creates or rotates the key,
+        # and never shown again.
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret
+
+        sig { params(secret: String).void }
+        attr_writer :secret
+
+        sig do
+          params(
+            id: String,
+            date_created: Time,
+            date_last_used: T.nilable(Time),
+            date_updated: Time,
+            secure_key: String,
+            status:
+              Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::OrSymbol,
+            expires_at: T.nilable(Time),
+            last_rotated_at: T.nilable(Time),
+            name: T.nilable(String),
+            previous_key_expires_at: T.nilable(Time),
+            secret: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The API key id.
+          id:,
+          # The API key creation date.
+          date_created:,
+          # The API key last use date.
+          date_last_used:,
+          # The API key last update date.
+          date_updated:,
+          # An obfuscated hint of the API key value. When a key is created or rotated this
+          # also holds the full secret, for backward compatibility; prefer `secret`.
+          secure_key:,
+          # The key's lifecycle state. `active`: the current secret authenticates.
+          # `rotating`: the key was rotated and the previous secret still authenticates
+          # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+          # authenticates, and the key can't be rotated.
+          status:,
+          # When the key stops authenticating. `null` means the key never expires. Set when
+          # the key is created or rotated, and must be in the future. When the request is
+          # authenticated with an API key that expires, the result can't be later than that
+          # key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
+          # keep the current one. It can't be changed with an update; rotate the key
+          # instead.
+          expires_at: nil,
+          # When the key was last rotated.
+          last_rotated_at: nil,
+          # The API key name.
+          name: nil,
+          # While `status` is `rotating`, when the previous secret stops authenticating.
+          previous_key_expires_at: nil,
+          # The full API key. Only present in the response that creates or rotates the key,
+          # and never shown again.
+          secret: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              date_created: Time,
+              date_last_used: T.nilable(Time),
+              date_updated: Time,
+              secure_key: String,
+              status:
+                Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::TaggedSymbol,
+              expires_at: T.nilable(Time),
+              last_rotated_at: T.nilable(Time),
+              name: T.nilable(String),
+              previous_key_expires_at: T.nilable(Time),
+              secret: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The key's lifecycle state. `active`: the current secret authenticates.
+        # `rotating`: the key was rotated and the previous secret still authenticates
+        # until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
+        # authenticates, and the key can't be rotated.
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::TaggedSymbol
+            )
+          ROTATING =
+            T.let(
+              :rotating,
+              Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/resources/background_tasks.rbi

@@ -3,11 +3,7 @@
 module Openlayer
   module Resources
     class BackgroundTasks
-      # Retrieve a background task's status, progress and results.
-      #
-      # Endpoints that cannot answer within one request queue a task and hand back its
-      # id -- for example `POST /frameworks/{frameworkId}/export`. Poll this endpoint
-      # until `complete` is `true`, then read what the task produced from `outputs`.
+      # Retrieve a background task's status and outputs.
       sig do
         params(
           task_id: String,

data/rbi/openlayer/resources/commits.rbi

@@ -6,7 +6,7 @@ module Openlayer
       sig { returns(Openlayer::Resources::Commits::TestResults) }
       attr_reader :test_results
 
-      # Retrieve a project version (commit) by its id.
+      # Retrieve a project commit.
       sig do
         params(
           project_version_id: String,

data/rbi/openlayer/resources/governance/frameworks/documents.rbi

@@ -5,11 +5,7 @@ module Openlayer
     class Governance
       class Frameworks
         class Documents
-          # Retrieve a framework document, including its sections, subsections, and the
-          # rules mapped to each.
-          #
-          # Each section and subsection carries a `ruleCount`, so you can tell which
-          # requirements have rules mapped to them before drilling in.
+          # Retrieve a framework document with its sections and rules.
           sig do
             params(
               document_id: String,
@@ -29,10 +25,6 @@ module Openlayer
           end
 
           # List the documents attached to a framework.
-          #
-          # A document holds the text of the standard the framework is based on, split into
-          # sections and subsections. Retrieve a single document to get that structure,
-          # along with the rules mapped to each part of it.
           sig do
             params(
               framework_id: String,

data/rbi/openlayer/resources/governance/frameworks/sections.rbi

@@ -5,11 +5,7 @@ module Openlayer
     class Governance
       class Frameworks
         class Sections
-          # List the rules mapped to a section of a framework document.
-          #
-          # Pass `includeSubsectionRules=true` to also return the rules mapped to the
-          # section's subsections, which is how you get every rule covering a requirement
-          # and everything under it.
+          # List the rules mapped to a document section.
           sig do
             params(
               section_id: String,

data/rbi/openlayer/resources/governance/frameworks/subsections.rbi

@@ -5,11 +5,7 @@ module Openlayer
     class Governance
       class Frameworks
         class Subsections
-          # List the rules mapped to a subsection of a framework document.
-          #
-          # A subsection is usually the level at which a standard states an individual
-          # requirement, so this is the endpoint to use when you want to show which rules
-          # cover a specific clause.
+          # List the rules mapped to a document subsection.
           sig do
             params(
               subsection_id: String,

data/rbi/openlayer/resources/governance/frameworks.rbi

@@ -15,14 +15,7 @@ module Openlayer
         end
         attr_reader :subsections
 
-        # Create a custom governance framework in a workspace.
-        #
-        # Use this to track compliance against an internal policy, or against a standard
-        # Openlayer does not ship as a built-in framework. A new framework starts with no
-        # rules -- add them from the Openlayer app, or map an existing rule to it.
-        #
-        # A framework is created disabled unless you pass `enabled: true`. While it is
-        # disabled its rules are not evaluated and do not count towards compliance.
+        # Create a custom framework in a workspace.
         sig do
           params(
             workspace_id: String,
@@ -56,7 +49,7 @@ module Openlayer
         )
         end
 
-        # Retrieve a governance framework by its id.
+        # Retrieve a framework.
         sig do
           params(
             framework_id: String,
@@ -70,17 +63,7 @@ module Openlayer
         )
         end
 
-        # Update a governance framework.
-        #
-        # The most common use is activating or deactivating a framework for the workspace
-        # by setting `enabled`. Rules of a disabled framework are not evaluated and do not
-        # count towards compliance.
-        #
-        # Frameworks that ship with Openlayer report `immutable: true`. For those, only
-        # `enabled`, `tags`, and `projectSelector` can be changed -- their name and
-        # definition are managed by Openlayer.
-        #
-        # Only the fields you send are changed.
+        # Update a framework.
         sig do
           params(
             framework_id: String,
@@ -126,12 +109,7 @@ module Openlayer
         )
         end
 
-        # List the governance frameworks in a workspace.
-        #
-        # A framework is a set of rules -- drawn from a regulation, a standard, or your
-        # own internal policy -- that Openlayer tracks compliance against. Use this
-        # endpoint to find the framework you want to report on, then read its rules and
-        # rule results.
+        # List the frameworks in a workspace.
         sig do
           params(
             workspace_id: String,
@@ -183,29 +161,7 @@ module Openlayer
         )
         end
 
-        # Export a framework's evidence and progress as an audit-ready zip archive.
-        #
-        # The archive holds every evidence file uploaded against the framework's
-        # evidence-based rules, a markdown report of the framework's progress and the
-        # status of all its rules (broken down by documentation section when the framework
-        # has documents), and CSV manifests of rules and evidence with SHA-256 checksums.
-        #
-        # Send `projectId` to export one project's compliance with the framework. Omit it
-        # for the workspace-wide view across every project in the framework, including
-        # workspace-scoped rules.
-        #
-        # The export runs as a background task, so this returns `202` immediately. To
-        # collect the archive:
-        #
-        # 1. Poll `GET /background-tasks/{taskId}` with the returned `taskResultId` until
-        #    `complete` is `true`.
-        # 2. Read `outputs.storageUri` off that task.
-        # 3. Exchange it for a download link at
-        #    `GET /storage/presigned-url?storageUri=<uri>`.
-        #
-        # Rate limited to 2 requests per minute per framework. Asking for an export while
-        # an identical one is still queued returns that task rather than starting a second
-        # one.
+        # Export a framework as an audit-ready zip archive.
         sig do
           params(
             framework_id: String,
@@ -216,17 +172,15 @@ module Openlayer
         def export(
           # The framework id.
           framework_id,
-          # Scope the export to this project. It must belong to the framework.
+          # Scope the export to this project. It must belong to the framework. Omit it for
+          # the workspace-wide view across every project in the framework, including
+          # workspace-scoped rules.
           project_id: nil,
           request_options: {}
         )
         end
 
-        # Get a compliance roll-up for a framework, one row per project it applies to.
-        #
-        # Each row counts the project's rule results by status, so you can report on where
-        # a framework is complete and where it is not without fetching every individual
-        # rule result.
+        # List a framework's compliance stats per project.
         sig do
           params(
             framework_id: String,
@@ -256,9 +210,6 @@ module Openlayer
         end
 
         # List the projects a framework applies to.
-        #
-        # Which projects a framework covers is determined by its `projectSelector`. A
-        # framework with an empty selector applies to every project in the workspace.
         sig do
           params(
             framework_id: String,
@@ -280,11 +231,7 @@ module Openlayer
         )
         end
 
-        # List the rules that belong to a framework.
-        #
-        # To read the compliance status of these rules, use
-        # [List rule results](/api-reference/rest/governance/list-rule-results) with the
-        # `frameworkId` filter, or fetch the results of an individual rule.
+        # List the rules in a framework.
         sig do
           params(
             framework_id: String,