openlayer 0.16.0 → 0.17.0

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#retrieve
+      class APIKeyRetrieveParams < 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
+
+        # @!method initialize(workspace_id:, api_key_id:, request_options: {})
+        #   @param workspace_id [String]
+        #   @param api_key_id [String]
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#retrieve
+      class APIKeyRetrieveResponse < 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::APIKeyRetrieveResponse::Status]
+          required :status, enum: -> { Openlayer::Models::Workspaces::APIKeyRetrieveResponse::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::APIKeyRetrieveResponse} 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::APIKeyRetrieveResponse::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::APIKeyRetrieveResponse#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_rotate_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#rotate
+      class APIKeyRotateParams < 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 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 grace_period_hours
+        #   Hours the previous secret keeps authenticating. The default of 0 retires it
+        #   immediately. It never outlives `expiresAt`. Only one previous secret is kept, so
+        #   rotating again during a grace period retires the older one immediately.
+        #
+        #   @return [Integer, nil]
+        optional :grace_period_hours, Integer, api_name: :gracePeriodHours
+
+        # @!method initialize(workspace_id:, api_key_id:, expires_at: nil, grace_period_hours: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Openlayer::Models::Workspaces::APIKeyRotateParams} for more details.
+        #
+        #   @param workspace_id [String]
+        #
+        #   @param api_key_id [String]
+        #
+        #   @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
+        #
+        #   @param grace_period_hours [Integer] Hours the previous secret keeps authenticating. The default of 0 retires it imme
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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/resources/background_tasks.rb

@@ -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.
       #
       # @overload retrieve(task_id, request_options: {})
       #

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

@@ -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.
           #
           # @overload retrieve(document_id, framework_id:, request_options: {})
           #
@@ -38,10 +34,6 @@ module Openlayer
 
           # 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.
-          #
           # @overload list(framework_id, page: nil, per_page: nil, request_options: {})
           #
           # @param framework_id [String] The framework id.

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

@@ -9,11 +9,7 @@ module Openlayer
           # {Openlayer::Models::Governance::Frameworks::SectionListRulesParams} for more
           # details.
           #
-          # 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.
           #
           # @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: {})
           #

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

@@ -9,11 +9,7 @@ module Openlayer
           # {Openlayer::Models::Governance::Frameworks::SubsectionListRulesParams} for more
           # details.
           #
-          # 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.
           #
           # @overload list_rules(subsection_id, framework_id:, include_results: nil, page: nil, per_page: nil, project_id: nil, status: nil, request_options: {})
           #