openlayer 0.15.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/models.rbi

@@ -1,10 +1,14 @@
 # typed: strong
 
 module Openlayer
+  BackgroundTaskRetrieveParams = Openlayer::Models::BackgroundTaskRetrieveParams
+
   CommitRetrieveParams = Openlayer::Models::CommitRetrieveParams
 
   Commits = Openlayer::Models::Commits
 
+  Governance = Openlayer::Models::Governance
+
   InferencePipelineDeleteParams =
     Openlayer::Models::InferencePipelineDeleteParams
 

data/rbi/openlayer/resources/background_tasks.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class BackgroundTasks
+      # Retrieve a background task's status and outputs.
+      sig do
+        params(
+          task_id: String,
+          request_options: Openlayer::RequestOptions::OrHash
+        ).returns(Openlayer::Models::BackgroundTaskRetrieveResponse)
+      end
+      def retrieve(
+        # The background task id.
+        task_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Openlayer::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        class Documents
+          # Retrieve a framework document with its sections and rules.
+          sig do
+            params(
+              document_id: String,
+              framework_id: String,
+              request_options: Openlayer::RequestOptions::OrHash
+            ).returns(
+              Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse
+            )
+          end
+          def retrieve(
+            # The framework document id.
+            document_id,
+            # The framework id.
+            framework_id:,
+            request_options: {}
+          )
+          end
+
+          # List the documents attached to a framework.
+          sig do
+            params(
+              framework_id: String,
+              page: Integer,
+              per_page: Integer,
+              request_options: Openlayer::RequestOptions::OrHash
+            ).returns(
+              Openlayer::Models::Governance::Frameworks::DocumentListResponse
+            )
+          end
+          def list(
+            # The framework id.
+            framework_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
+
+          # @api private
+          sig { params(client: Openlayer::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        class Sections
+          # List the rules mapped to a document section.
+          sig do
+            params(
+              section_id: String,
+              framework_id: String,
+              include_results: T::Boolean,
+              include_subsection_rules: T::Boolean,
+              page: Integer,
+              per_page: Integer,
+              project_id: String,
+              status:
+                Openlayer::Governance::Frameworks::SectionListRulesParams::Status::OrSymbol,
+              request_options: Openlayer::RequestOptions::OrHash
+            ).returns(
+              Openlayer::Models::Governance::Frameworks::SectionListRulesResponse
+            )
+          end
+          def list_rules(
+            # Path param: The framework document section id.
+            section_id,
+            # Path param: The framework id.
+            framework_id:,
+            # Query param: Whether to include each rule's results inline, in a `results`
+            # array.
+            include_results: nil,
+            # Query param: Whether to also include the rules mapped to the section's
+            # subsections.
+            include_subsection_rules: nil,
+            # Query param: The page to return in a paginated query.
+            page: nil,
+            # Query param: Maximum number of items to return per page.
+            per_page: nil,
+            # Query param: Only include items that apply to this project.
+            project_id: nil,
+            # Query param: Only include items whose rule result has this compliance status.
+            status: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Openlayer::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        class Subsections
+          # List the rules mapped to a document subsection.
+          sig do
+            params(
+              subsection_id: String,
+              framework_id: String,
+              include_results: T::Boolean,
+              page: Integer,
+              per_page: Integer,
+              project_id: String,
+              status:
+                Openlayer::Governance::Frameworks::SubsectionListRulesParams::Status::OrSymbol,
+              request_options: Openlayer::RequestOptions::OrHash
+            ).returns(
+              Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse
+            )
+          end
+          def list_rules(
+            # Path param: The framework document subsection id.
+            subsection_id,
+            # Path param: The framework id.
+            framework_id:,
+            # Query param: Whether to include each rule's results inline, in a `results`
+            # array.
+            include_results: nil,
+            # Query param: The page to return in a paginated query.
+            page: nil,
+            # Query param: Maximum number of items to return per page.
+            per_page: nil,
+            # Query param: Only include items that apply to this project.
+            project_id: nil,
+            # Query param: Only include items whose rule result has this compliance status.
+            status: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Openlayer::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end