openlayer 0.15.0 → 0.17.0

data/lib/openlayer/models/workspaces/api_key_rotate_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#rotate
+      class APIKeyRotateResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute expires_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :expires_at, Time, api_name: :expiresAt, nil?: true
+
+        # @!attribute name
+        #   The API key name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        response_only do
+          # @!attribute id
+          #   The API key id.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute date_created
+          #   The API key creation date.
+          #
+          #   @return [Time]
+          required :date_created, Time, api_name: :dateCreated
+
+          # @!attribute date_last_used
+          #   The API key last use date.
+          #
+          #   @return [Time, nil]
+          required :date_last_used, Time, api_name: :dateLastUsed, nil?: true
+
+          # @!attribute date_updated
+          #   The API key last update date.
+          #
+          #   @return [Time]
+          required :date_updated, Time, api_name: :dateUpdated
+
+          # @!attribute secure_key
+          #   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`.
+          #
+          #   @return [String]
+          required :secure_key, String, api_name: :secureKey
+
+          # @!attribute status
+          #   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.
+          #
+          #   @return [Symbol, Openlayer::Models::Workspaces::APIKeyRotateResponse::Status]
+          required :status, enum: -> { Openlayer::Models::Workspaces::APIKeyRotateResponse::Status }
+
+          # @!attribute last_rotated_at
+          #   When the key was last rotated.
+          #
+          #   @return [Time, nil]
+          optional :last_rotated_at, Time, api_name: :lastRotatedAt, nil?: true
+
+          # @!attribute previous_key_expires_at
+          #   While `status` is `rotating`, when the previous secret stops authenticating.
+          #
+          #   @return [Time, nil]
+          optional :previous_key_expires_at, Time, api_name: :previousKeyExpiresAt, nil?: true
+
+          # @!attribute secret
+          #   The full API key. Only present in the response that creates or rotates the key,
+          #   and never shown again.
+          #
+          #   @return [String, nil]
+          optional :secret, String
+        end
+
+        # @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, status:, expires_at: nil, last_rotated_at: nil, name: nil, previous_key_expires_at: nil, secret: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Openlayer::Models::Workspaces::APIKeyRotateResponse} for more details.
+        #
+        #   @param id [String] The API key id.
+        #
+        #   @param date_created [Time] The API key creation date.
+        #
+        #   @param date_last_used [Time, nil] The API key last use date.
+        #
+        #   @param date_updated [Time] The API key last update date.
+        #
+        #   @param secure_key [String] An obfuscated hint of the API key value. When a key is created or rotated this a
+        #
+        #   @param status [Symbol, Openlayer::Models::Workspaces::APIKeyRotateResponse::Status] The key's lifecycle state. `active`: the current secret authenticates. `rotating
+        #
+        #   @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
+        #
+        #   @param last_rotated_at [Time, nil] When the key was last rotated.
+        #
+        #   @param name [String, nil] The API key name.
+        #
+        #   @param previous_key_expires_at [Time, nil] While `status` is `rotating`, when the previous secret stops authenticating.
+        #
+        #   @param secret [String] The full API key. Only present in the response that creates or rotates the 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.
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyRotateResponse#status
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          ACTIVE = :active
+          ROTATING = :rotating
+          EXPIRED = :expired
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/models/workspaces/api_key_update_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#update
+      class APIKeyUpdateParams < 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 api_key_id
+        #
+        #   @return [String]
+        required :api_key_id, String
+
+        # @!attribute name
+        #   The API key name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(workspace_id:, api_key_id:, name: nil, request_options: {})
+        #   @param workspace_id [String]
+        #
+        #   @param api_key_id [String]
+        #
+        #   @param name [String, nil] The API key name.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openlayer/models/workspaces/api_key_update_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#update
+      class APIKeyUpdateResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute expires_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :expires_at, Time, api_name: :expiresAt, nil?: true
+
+        # @!attribute name
+        #   The API key name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        response_only do
+          # @!attribute id
+          #   The API key id.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute date_created
+          #   The API key creation date.
+          #
+          #   @return [Time]
+          required :date_created, Time, api_name: :dateCreated
+
+          # @!attribute date_last_used
+          #   The API key last use date.
+          #
+          #   @return [Time, nil]
+          required :date_last_used, Time, api_name: :dateLastUsed, nil?: true
+
+          # @!attribute date_updated
+          #   The API key last update date.
+          #
+          #   @return [Time]
+          required :date_updated, Time, api_name: :dateUpdated
+
+          # @!attribute secure_key
+          #   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`.
+          #
+          #   @return [String]
+          required :secure_key, String, api_name: :secureKey
+
+          # @!attribute status
+          #   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.
+          #
+          #   @return [Symbol, Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status]
+          required :status, enum: -> { Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status }
+
+          # @!attribute last_rotated_at
+          #   When the key was last rotated.
+          #
+          #   @return [Time, nil]
+          optional :last_rotated_at, Time, api_name: :lastRotatedAt, nil?: true
+
+          # @!attribute previous_key_expires_at
+          #   While `status` is `rotating`, when the previous secret stops authenticating.
+          #
+          #   @return [Time, nil]
+          optional :previous_key_expires_at, Time, api_name: :previousKeyExpiresAt, nil?: true
+
+          # @!attribute secret
+          #   The full API key. Only present in the response that creates or rotates the key,
+          #   and never shown again.
+          #
+          #   @return [String, nil]
+          optional :secret, String
+        end
+
+        # @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, status:, expires_at: nil, last_rotated_at: nil, name: nil, previous_key_expires_at: nil, secret: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Openlayer::Models::Workspaces::APIKeyUpdateResponse} for more details.
+        #
+        #   @param id [String] The API key id.
+        #
+        #   @param date_created [Time] The API key creation date.
+        #
+        #   @param date_last_used [Time, nil] The API key last use date.
+        #
+        #   @param date_updated [Time] The API key last update date.
+        #
+        #   @param secure_key [String] An obfuscated hint of the API key value. When a key is created or rotated this a
+        #
+        #   @param status [Symbol, Openlayer::Models::Workspaces::APIKeyUpdateResponse::Status] The key's lifecycle state. `active`: the current secret authenticates. `rotating
+        #
+        #   @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
+        #
+        #   @param last_rotated_at [Time, nil] When the key was last rotated.
+        #
+        #   @param name [String, nil] The API key name.
+        #
+        #   @param previous_key_expires_at [Time, nil] While `status` is `rotating`, when the previous secret stops authenticating.
+        #
+        #   @param secret [String] The full API key. Only present in the response that creates or rotates the 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.
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyUpdateResponse#status
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          ACTIVE = :active
+          ROTATING = :rotating
+          EXPIRED = :expired
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/models.rb

@@ -39,10 +39,14 @@ module Openlayer
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  BackgroundTaskRetrieveParams = Openlayer::Models::BackgroundTaskRetrieveParams
+
   CommitRetrieveParams = Openlayer::Models::CommitRetrieveParams
 
   Commits = Openlayer::Models::Commits
 
+  Governance = Openlayer::Models::Governance
+
   InferencePipelineDeleteParams = Openlayer::Models::InferencePipelineDeleteParams
 
   InferencePipelineRetrieveParams = Openlayer::Models::InferencePipelineRetrieveParams

data/lib/openlayer/resources/background_tasks.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class BackgroundTasks
+      # Retrieve a background task's status and outputs.
+      #
+      # @overload retrieve(task_id, request_options: {})
+      #
+      # @param task_id [String] The background task id.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::BackgroundTaskRetrieveResponse]
+      #
+      # @see Openlayer::Models::BackgroundTaskRetrieveParams
+      def retrieve(task_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["background-tasks/%1$s", task_id],
+          model: Openlayer::Models::BackgroundTaskRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/openlayer/resources/commits.rb

@@ -6,7 +6,7 @@ module Openlayer
       # @return [Openlayer::Resources::Commits::TestResults]
       attr_reader :test_results
 
-      # Retrieve a project version (commit) by its id.
+      # Retrieve a project commit.
       #
       # @overload retrieve(project_version_id, request_options: {})
       #

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        class Documents
+          # Retrieve a framework document with its sections and rules.
+          #
+          # @overload retrieve(document_id, framework_id:, request_options: {})
+          #
+          # @param document_id [String] The framework document id.
+          #
+          # @param framework_id [String] The framework id.
+          #
+          # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse]
+          #
+          # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveParams
+          def retrieve(document_id, params)
+            parsed, options = Openlayer::Governance::Frameworks::DocumentRetrieveParams.dump_request(params)
+            framework_id =
+              parsed.delete(:framework_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["frameworks/%1$s/documents/%2$s", framework_id, document_id],
+              model: Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse,
+              options: options
+            )
+          end
+
+          # List the documents attached to a framework.
+          #
+          # @overload list(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::Frameworks::DocumentListResponse]
+          #
+          # @see Openlayer::Models::Governance::Frameworks::DocumentListParams
+          def list(framework_id, params = {})
+            parsed, options = Openlayer::Governance::Frameworks::DocumentListParams.dump_request(params)
+            query = Openlayer::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: ["frameworks/%1$s/documents", framework_id],
+              query: query.transform_keys(per_page: "perPage"),
+              model: Openlayer::Models::Governance::Frameworks::DocumentListResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Openlayer::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        class Sections
+          # Some parameter documentations has been truncated, see
+          # {Openlayer::Models::Governance::Frameworks::SectionListRulesParams} for more
+          # details.
+          #
+          # List the rules mapped to a document section.
+          #
+          # @overload list_rules(section_id, framework_id:, include_results: nil, include_subsection_rules: nil, page: nil, per_page: nil, project_id: nil, status: nil, request_options: {})
+          #
+          # @param section_id [String] Path param: The framework document section id.
+          #
+          # @param framework_id [String] Path param: The framework id.
+          #
+          # @param include_results [Boolean] Query param: Whether to include each rule's results inline, in a `results` array
+          #
+          # @param include_subsection_rules [Boolean] Query param: Whether to also include the rules mapped to the section's subsectio
+          #
+          # @param page [Integer] Query param: The page to return in a paginated query.
+          #
+          # @param per_page [Integer] Query param: Maximum number of items to return per page.
+          #
+          # @param project_id [String] Query param: Only include items that apply to this project.
+          #
+          # @param status [Symbol, Openlayer::Models::Governance::Frameworks::SectionListRulesParams::Status] Query param: Only include items whose rule result has this compliance status.
+          #
+          # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Openlayer::Models::Governance::Frameworks::SectionListRulesResponse]
+          #
+          # @see Openlayer::Models::Governance::Frameworks::SectionListRulesParams
+          def list_rules(section_id, params)
+            parsed, options = Openlayer::Governance::Frameworks::SectionListRulesParams.dump_request(params)
+            query = Openlayer::Internal::Util.encode_query_params(parsed)
+            framework_id =
+              parsed.delete(:framework_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["frameworks/%1$s/sections/%2$s/rules", framework_id, section_id],
+              query: query.transform_keys(
+                include_results: "includeResults",
+                include_subsection_rules: "includeSubsectionRules",
+                per_page: "perPage",
+                project_id: "projectId"
+              ),
+              model: Openlayer::Models::Governance::Frameworks::SectionListRulesResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Openlayer::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Governance
+      class Frameworks
+        class Subsections
+          # Some parameter documentations has been truncated, see
+          # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesParams} for more
+          # details.
+          #
+          # List the rules mapped to a document subsection.
+          #
+          # @overload list_rules(subsection_id, framework_id:, include_results: nil, page: nil, per_page: nil, project_id: nil, status: nil, request_options: {})
+          #
+          # @param subsection_id [String] Path param: The framework document subsection id.
+          #
+          # @param framework_id [String] Path param: The framework id.
+          #
+          # @param include_results [Boolean] Query param: Whether to include each rule's results inline, in a `results` array
+          #
+          # @param page [Integer] Query param: The page to return in a paginated query.
+          #
+          # @param per_page [Integer] Query param: Maximum number of items to return per page.
+          #
+          # @param project_id [String] Query param: Only include items that apply to this project.
+          #
+          # @param status [Symbol, Openlayer::Models::Governance::Frameworks::SubsectionListRulesParams::Status] Query param: Only include items whose rule result has this compliance status.
+          #
+          # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse]
+          #
+          # @see Openlayer::Models::Governance::Frameworks::SubsectionListRulesParams
+          def list_rules(subsection_id, params)
+            parsed, options = Openlayer::Governance::Frameworks::SubsectionListRulesParams.dump_request(params)
+            query = Openlayer::Internal::Util.encode_query_params(parsed)
+            framework_id =
+              parsed.delete(:framework_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["frameworks/%1$s/subsections/%2$s/rules", framework_id, subsection_id],
+              query: query.transform_keys(
+                include_results: "includeResults",
+                per_page: "perPage",
+                project_id: "projectId"
+              ),
+              model: Openlayer::Models::Governance::Frameworks::SubsectionListRulesResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Openlayer::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end