openlayer 0.16.0 → 0.17.0

data/rbi/openlayer/models/workspaces/api_key_list_response.rbi

@@ -0,0 +1,202 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyListResponseItem < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Workspaces::APIKeyListResponseItem,
+              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::APIKeyListResponseItem::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::APIKeyListResponseItem::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::APIKeyListResponseItem::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::APIKeyListResponseItem::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Openlayer::Models::Workspaces::APIKeyListResponseItem::Status::TaggedSymbol
+            )
+          ROTATING =
+            T.let(
+              :rotating,
+              Openlayer::Models::Workspaces::APIKeyListResponseItem::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Openlayer::Models::Workspaces::APIKeyListResponseItem::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Models::Workspaces::APIKeyListResponseItem::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      APIKeyListResponse =
+        T.let(
+          Openlayer::Internal::Type::ArrayOf[
+            Openlayer::Models::Workspaces::APIKeyListResponseItem
+          ],
+          Openlayer::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/openlayer/models/workspaces/api_key_retrieve_params.rbi

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

data/rbi/openlayer/models/workspaces/api_key_retrieve_response.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyRetrieveResponse < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::Workspaces::APIKeyRetrieveResponse,
+              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::APIKeyRetrieveResponse::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::APIKeyRetrieveResponse::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::APIKeyRetrieveResponse::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::APIKeyRetrieveResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status::TaggedSymbol
+            )
+          ROTATING =
+            T.let(
+              :rotating,
+              Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/workspaces/api_key_rotate_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Workspaces
+      class APIKeyRotateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Workspaces::APIKeyRotateParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :workspace_id
+
+        sig { returns(String) }
+        attr_accessor :api_key_id
+
+        # 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
+
+        # 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.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :grace_period_hours
+
+        sig { params(grace_period_hours: Integer).void }
+        attr_writer :grace_period_hours
+
+        sig do
+          params(
+            workspace_id: String,
+            api_key_id: String,
+            expires_at: T.nilable(Time),
+            grace_period_hours: Integer,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          workspace_id:,
+          api_key_id:,
+          # 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,
+          # 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.
+          grace_period_hours: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              workspace_id: String,
+              api_key_id: String,
+              expires_at: T.nilable(Time),
+              grace_period_hours: Integer,
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end