docker-engine-ruby 0.3.0 → 0.5.0

data/lib/docker_engine_ruby/models.rb

@@ -56,6 +56,10 @@ module DockerEngineRuby
 
   ConfigListParams = DockerEngineRuby::Models::ConfigListParams
 
+  ConfigObject = DockerEngineRuby::Models::ConfigObject
+
+  ConfigSpec = DockerEngineRuby::Models::ConfigSpec
+
   ConfigUpdateParams = DockerEngineRuby::Models::ConfigUpdateParams
 
   ConnectRequest = DockerEngineRuby::Models::ConnectRequest
@@ -160,6 +164,8 @@ module DockerEngineRuby
 
   ImageSearchParams = DockerEngineRuby::Models::ImageSearchParams
 
+  ImageSummary = DockerEngineRuby::Models::ImageSummary
+
   ImageTagParams = DockerEngineRuby::Models::ImageTagParams
 
   Info = DockerEngineRuby::Models::Info
@@ -176,6 +182,8 @@ module DockerEngineRuby
 
   NetworkCreateParams = DockerEngineRuby::Models::NetworkCreateParams
 
+  NetworkCreateResponse = DockerEngineRuby::Models::NetworkCreateResponse
+
   NetworkDeleteParams = DockerEngineRuby::Models::NetworkDeleteParams
 
   NetworkDisconnectParams = DockerEngineRuby::Models::NetworkDisconnectParams
@@ -186,6 +194,8 @@ module DockerEngineRuby
 
   NetworkPruneParams = DockerEngineRuby::Models::NetworkPruneParams
 
+  NetworkSummary = DockerEngineRuby::Models::NetworkSummary
+
   Node = DockerEngineRuby::Models::Node
 
   NodeDeleteParams = DockerEngineRuby::Models::NodeDeleteParams
@@ -194,6 +204,8 @@ module DockerEngineRuby
 
   NodeListParams = DockerEngineRuby::Models::NodeListParams
 
+  NodeSpec = DockerEngineRuby::Models::NodeSpec
+
   NodeUpdateParams = DockerEngineRuby::Models::NodeUpdateParams
 
   Plugin = DockerEngineRuby::Models::Plugin
@@ -232,12 +244,16 @@ module DockerEngineRuby
 
   SecretListParams = DockerEngineRuby::Models::SecretListParams
 
+  SecretSpec = DockerEngineRuby::Models::SecretSpec
+
   SecretUpdateParams = DockerEngineRuby::Models::SecretUpdateParams
 
   Service = DockerEngineRuby::Models::Service
 
   ServiceCreateParams = DockerEngineRuby::Models::ServiceCreateParams
 
+  ServiceCreateResponse = DockerEngineRuby::Models::ServiceCreateResponse
+
   ServiceDeleteParams = DockerEngineRuby::Models::ServiceDeleteParams
 
   ServiceInspectParams = DockerEngineRuby::Models::ServiceInspectParams
@@ -246,9 +262,11 @@ module DockerEngineRuby
 
   ServiceLogsParams = DockerEngineRuby::Models::ServiceLogsParams
 
+  ServiceSpec = DockerEngineRuby::Models::ServiceSpec
+
   ServiceUpdateParams = DockerEngineRuby::Models::ServiceUpdateParams
 
-  Spec = DockerEngineRuby::Models::Spec
+  ServiceUpdateResponse = DockerEngineRuby::Models::ServiceUpdateResponse
 
   StatsResponse = DockerEngineRuby::Models::StatsResponse
 
@@ -264,6 +282,8 @@ module DockerEngineRuby
 
   SwarmLeaveParams = DockerEngineRuby::Models::SwarmLeaveParams
 
+  SwarmSpec = DockerEngineRuby::Models::SwarmSpec
+
   SwarmUnlockKeyParams = DockerEngineRuby::Models::SwarmUnlockKeyParams
 
   SwarmUnlockParams = DockerEngineRuby::Models::SwarmUnlockParams
@@ -288,6 +308,8 @@ module DockerEngineRuby
 
   TaskLogsParams = DockerEngineRuby::Models::TaskLogsParams
 
+  TaskSpec = DockerEngineRuby::Models::TaskSpec
+
   TopResponse = DockerEngineRuby::Models::TopResponse
 
   UpdateResponse = DockerEngineRuby::Models::UpdateResponse

data/lib/docker_engine_ruby/resources/configs.rb

@@ -7,7 +7,7 @@ module DockerEngineRuby
       #
       # @overload create(spec:, request_options: {})
       #
-      # @param spec [DockerEngineRuby::Models::Spec]
+      # @param spec [DockerEngineRuby::Models::ConfigSpec]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::ConfigCreateResponse]
@@ -32,7 +32,7 @@ module DockerEngineRuby
       #
       # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param
+      # @param spec [DockerEngineRuby::Models::ConfigSpec] Body param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -58,7 +58,7 @@ module DockerEngineRuby
       # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<DockerEngineRuby::Models::Config>]
+      # @return [Array<DockerEngineRuby::Models::ConfigObject>]
       #
       # @see DockerEngineRuby::Models::ConfigListParams
       def list(params = {})
@@ -67,7 +67,7 @@ module DockerEngineRuby
           method: :get,
           path: "configs",
           query: parsed,
-          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Config],
+          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ConfigObject],
           options: options
         )
       end
@@ -98,14 +98,14 @@ module DockerEngineRuby
       # @param id [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [DockerEngineRuby::Models::Config]
+      # @return [DockerEngineRuby::Models::ConfigObject]
       #
       # @see DockerEngineRuby::Models::ConfigInspectParams
       def inspect_(id, params = {})
         @client.request(
           method: :get,
           path: ["configs/%1$s", id],
-          model: DockerEngineRuby::Config,
+          model: DockerEngineRuby::ConfigObject,
           options: params[:request_options]
         )
       end

data/lib/docker_engine_ruby/resources/images.rb

@@ -14,7 +14,7 @@ module DockerEngineRuby
       # @param shared_size [Boolean]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<DockerEngineRuby::Models::Summary>]
+      # @return [Array<DockerEngineRuby::Models::ImageSummary>]
       #
       # @see DockerEngineRuby::Models::ImageListParams
       def list(params = {})
@@ -23,7 +23,7 @@ module DockerEngineRuby
           method: :get,
           path: "images/json",
           query: parsed.transform_keys(shared_size: "shared-size"),
-          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Summary],
+          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ImageSummary],
           options: options
         )
       end

data/lib/docker_engine_ruby/resources/networks.rb

@@ -38,7 +38,7 @@ module DockerEngineRuby
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [DockerEngineRuby::Models::CreateResponse]
+      # @return [DockerEngineRuby::Models::NetworkCreateResponse]
       #
       # @see DockerEngineRuby::Models::NetworkCreateParams
       def create(params)
@@ -47,7 +47,7 @@ module DockerEngineRuby
           method: :post,
           path: "networks/create",
           body: parsed,
-          model: DockerEngineRuby::CreateResponse,
+          model: DockerEngineRuby::NetworkCreateResponse,
           options: options
         )
       end
@@ -59,7 +59,7 @@ module DockerEngineRuby
       # @param filters [String]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<DockerEngineRuby::Models::Summary>]
+      # @return [Array<DockerEngineRuby::Models::NetworkSummary>]
       #
       # @see DockerEngineRuby::Models::NetworkListParams
       def list(params = {})
@@ -68,7 +68,7 @@ module DockerEngineRuby
           method: :get,
           path: "networks",
           query: parsed,
-          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Summary],
+          model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::NetworkSummary],
           options: options
         )
       end

data/lib/docker_engine_ruby/resources/nodes.rb

@@ -11,7 +11,7 @@ module DockerEngineRuby
       #
       # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param
+      # @param spec [DockerEngineRuby::Models::NodeSpec] Body param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/docker_engine_ruby/resources/secrets.rb

@@ -7,7 +7,7 @@ module DockerEngineRuby
       #
       # @overload create(spec:, request_options: {})
       #
-      # @param spec [DockerEngineRuby::Models::Spec]
+      # @param spec [DockerEngineRuby::Models::SecretSpec]
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [DockerEngineRuby::Models::SecretCreateResponse]
@@ -32,7 +32,7 @@ module DockerEngineRuby
       #
       # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param
+      # @param spec [DockerEngineRuby::Models::SecretSpec] Body param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/docker_engine_ruby/resources/services.rb

@@ -7,13 +7,13 @@ module DockerEngineRuby
       #
       # @overload create(spec:, x_registry_auth: nil, request_options: {})
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param: User modifiable configuration for a service.
+      # @param spec [DockerEngineRuby::Models::ServiceSpec] Body param: User modifiable configuration for a service.
       #
       # @param x_registry_auth [String] Header param
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [DockerEngineRuby::Models::CreateResponse]
+      # @return [DockerEngineRuby::Models::ServiceCreateResponse]
       #
       # @see DockerEngineRuby::Models::ServiceCreateParams
       def create(params)
@@ -23,7 +23,7 @@ module DockerEngineRuby
           path: "services/create",
           headers: parsed.except(:spec).transform_keys(x_registry_auth: "x-registry-auth"),
           body: parsed[:spec],
-          model: DockerEngineRuby::CreateResponse,
+          model: DockerEngineRuby::ServiceCreateResponse,
           options: options
         )
       end
@@ -36,7 +36,7 @@ module DockerEngineRuby
       #
       # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param: User modifiable configuration for a service.
+      # @param spec [DockerEngineRuby::Models::ServiceSpec] Body param: User modifiable configuration for a service.
       #
       # @param registry_auth_from [Symbol, DockerEngineRuby::Models::ServiceUpdateParams::RegistryAuthFrom] Query param
       #
@@ -46,7 +46,7 @@ module DockerEngineRuby
       #
       # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [DockerEngineRuby::Models::UpdateResponse]
+      # @return [DockerEngineRuby::Models::ServiceUpdateResponse]
       #
       # @see DockerEngineRuby::Models::ServiceUpdateParams
       def update(id, params)
@@ -58,7 +58,7 @@ module DockerEngineRuby
           query: parsed.slice(*query_params).transform_keys(registry_auth_from: "registryAuthFrom"),
           headers: parsed.except(:spec, *query_params).transform_keys(x_registry_auth: "x-registry-auth"),
           body: parsed[:spec],
-          model: DockerEngineRuby::UpdateResponse,
+          model: DockerEngineRuby::ServiceUpdateResponse,
           options: options
         )
       end

data/lib/docker_engine_ruby/resources/swarm.rb

@@ -9,7 +9,7 @@ module DockerEngineRuby
       #
       # @param version [Integer] Query param
       #
-      # @param spec [DockerEngineRuby::Models::Spec] Body param: User modifiable swarm configuration.
+      # @param spec [DockerEngineRuby::Models::SwarmSpec] Body param: User modifiable swarm configuration.
       #
       # @param rotate_manager_token [Boolean] Query param
       #
@@ -54,7 +54,7 @@ module DockerEngineRuby
       #
       # @param listen_addr [String]
       #
-      # @param spec [DockerEngineRuby::Models::Spec] User modifiable swarm configuration.
+      # @param spec [DockerEngineRuby::Models::SwarmSpec] User modifiable swarm configuration.
       #
       # @param subnet_size [Integer]
       #

data/lib/docker_engine_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DockerEngineRuby
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/docker_engine_ruby.rb

@@ -52,17 +52,25 @@ require_relative "docker_engine_ruby/errors"
 require_relative "docker_engine_ruby/internal/transport/base_client"
 require_relative "docker_engine_ruby/internal/transport/pooled_net_requester"
 require_relative "docker_engine_ruby/client"
+require_relative "docker_engine_ruby/models/config_spec"
+require_relative "docker_engine_ruby/models/config"
+require_relative "docker_engine_ruby/models/connect_request"
+require_relative "docker_engine_ruby/models/disconnect_request"
+require_relative "docker_engine_ruby/models/node_spec"
+require_relative "docker_engine_ruby/models/secret_spec"
+require_relative "docker_engine_ruby/models/service_spec"
+require_relative "docker_engine_ruby/models/swarm_spec"
+require_relative "docker_engine_ruby/models/create_request"
 require_relative "docker_engine_ruby/models/auth_login_params"
 require_relative "docker_engine_ruby/models/auth_response"
-require_relative "docker_engine_ruby/models/config"
 require_relative "docker_engine_ruby/models/config_create_params"
 require_relative "docker_engine_ruby/models/config_create_response"
 require_relative "docker_engine_ruby/models/config_delete_params"
 require_relative "docker_engine_ruby/models/config_inspect_params"
 require_relative "docker_engine_ruby/models/config_list_params"
 require_relative "docker_engine_ruby/models/config_list_response"
+require_relative "docker_engine_ruby/models/config_object"
 require_relative "docker_engine_ruby/models/config_update_params"
-require_relative "docker_engine_ruby/models/connect_request"
 require_relative "docker_engine_ruby/models/container"
 require_relative "docker_engine_ruby/models/container_archive_params"
 require_relative "docker_engine_ruby/models/container_attach_params"
@@ -91,10 +99,8 @@ require_relative "docker_engine_ruby/models/container_top_params"
 require_relative "docker_engine_ruby/models/container_unpause_params"
 require_relative "docker_engine_ruby/models/container_update_params"
 require_relative "docker_engine_ruby/models/container_wait_params"
-require_relative "docker_engine_ruby/models/create_request"
 require_relative "docker_engine_ruby/models/create_response"
 require_relative "docker_engine_ruby/models/delete_item"
-require_relative "docker_engine_ruby/models/disconnect_request"
 require_relative "docker_engine_ruby/models/distribution_inspect_params"
 require_relative "docker_engine_ruby/models/error"
 require_relative "docker_engine_ruby/models/exec_inspect_params"
@@ -125,6 +131,7 @@ require_relative "docker_engine_ruby/models/image_pull_params"
 require_relative "docker_engine_ruby/models/image_push_params"
 require_relative "docker_engine_ruby/models/image_search_params"
 require_relative "docker_engine_ruby/models/image_search_response"
+require_relative "docker_engine_ruby/models/image_summary"
 require_relative "docker_engine_ruby/models/image_tag_params"
 require_relative "docker_engine_ruby/models/info"
 require_relative "docker_engine_ruby/models/inspect"
@@ -133,6 +140,7 @@ require_relative "docker_engine_ruby/models/list_response"
 require_relative "docker_engine_ruby/models/network"
 require_relative "docker_engine_ruby/models/network_connect_params"
 require_relative "docker_engine_ruby/models/network_create_params"
+require_relative "docker_engine_ruby/models/network_create_response"
 require_relative "docker_engine_ruby/models/network_delete_params"
 require_relative "docker_engine_ruby/models/network_disconnect_params"
 require_relative "docker_engine_ruby/models/network_inspect_params"
@@ -141,6 +149,7 @@ require_relative "docker_engine_ruby/models/network_list_params"
 require_relative "docker_engine_ruby/models/network_list_response"
 require_relative "docker_engine_ruby/models/network_prune_params"
 require_relative "docker_engine_ruby/models/network_prune_response"
+require_relative "docker_engine_ruby/models/network_summary"
 require_relative "docker_engine_ruby/models/node"
 require_relative "docker_engine_ruby/models/node_delete_params"
 require_relative "docker_engine_ruby/models/node_inspect_params"
@@ -172,13 +181,14 @@ require_relative "docker_engine_ruby/models/secret_list_response"
 require_relative "docker_engine_ruby/models/secret_update_params"
 require_relative "docker_engine_ruby/models/service"
 require_relative "docker_engine_ruby/models/service_create_params"
+require_relative "docker_engine_ruby/models/service_create_response"
 require_relative "docker_engine_ruby/models/service_delete_params"
 require_relative "docker_engine_ruby/models/service_inspect_params"
 require_relative "docker_engine_ruby/models/service_list_params"
 require_relative "docker_engine_ruby/models/service_list_response"
 require_relative "docker_engine_ruby/models/service_logs_params"
 require_relative "docker_engine_ruby/models/service_update_params"
-require_relative "docker_engine_ruby/models/spec"
+require_relative "docker_engine_ruby/models/service_update_response"
 require_relative "docker_engine_ruby/models/stats_response"
 require_relative "docker_engine_ruby/models/summary"
 require_relative "docker_engine_ruby/models/swarm"
@@ -204,6 +214,7 @@ require_relative "docker_engine_ruby/models/task_inspect_params"
 require_relative "docker_engine_ruby/models/task_list_params"
 require_relative "docker_engine_ruby/models/task_list_response"
 require_relative "docker_engine_ruby/models/task_logs_params"
+require_relative "docker_engine_ruby/models/task_spec"
 require_relative "docker_engine_ruby/models/top_response"
 require_relative "docker_engine_ruby/models/update_response"
 require_relative "docker_engine_ruby/models/version"

data/rbi/docker_engine_ruby/client.rbi

@@ -10,6 +10,15 @@ module DockerEngineRuby
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
+    ENVIRONMENTS =
+      T.let(
+        {
+          production: "http://localhost:2375",
+          production_tls: "https://localhost:2376"
+        },
+        T::Hash[Symbol, String]
+      )
+
     sig { returns(DockerEngineRuby::Resources::Auth) }
     attr_reader :auth
 
@@ -58,6 +67,7 @@ module DockerEngineRuby
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
+        environment: T.nilable(T.any(Symbol, String)),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -66,6 +76,13 @@ module DockerEngineRuby
       ).returns(T.attached_class)
     end
     def self.new(
+      # Specifies the environment to use for the API.
+      #
+      # Each environment maps to a different base URL:
+      #
+      # - `production` corresponds to `http://localhost:2375`
+      # - `production_tls` corresponds to `https://localhost:2376`
+      environment: nil,
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["DOCKER_BASE_URL"]`
       base_url: ENV["DOCKER_BASE_URL"],

data/rbi/docker_engine_ruby/models/config_list_response.rbi

@@ -4,7 +4,9 @@ module DockerEngineRuby
   module Models
     ConfigListResponse =
       T.let(
-        DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Config],
+        DockerEngineRuby::Internal::Type::ArrayOf[
+          DockerEngineRuby::ConfigObject
+        ],
         DockerEngineRuby::Internal::Type::Converter
       )
   end

data/rbi/docker_engine_ruby/models/config_object.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module DockerEngineRuby
+  module Models
+    class ConfigObject < DockerEngineRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineRuby::ConfigObject,
+            DockerEngineRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(DockerEngineRuby::ConfigSpec)) }
+      attr_reader :spec
+
+      sig { params(spec: DockerEngineRuby::ConfigSpec::OrHash).void }
+      attr_writer :spec
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      # The version number of the object such as node, service, etc. This is needed to
+      # avoid conflicting writes. The client must send the version number along with the
+      # modified specification when updating these objects.
+      #
+      # This approach ensures safe concurrency and determinism in that the change on the
+      # object may not be applied if the version number has changed from the last read.
+      # In other words, if two update requests specify the same base version, only one
+      # of the requests can succeed. As a result, two separate update requests that
+      # happen at the same time will not unintentionally overwrite each other.
+      sig { returns(T.nilable(DockerEngineRuby::ConfigObject::Version)) }
+      attr_reader :version
+
+      sig do
+        params(version: DockerEngineRuby::ConfigObject::Version::OrHash).void
+      end
+      attr_writer :version
+
+      sig do
+        params(
+          created_at: Time,
+          id: String,
+          spec: DockerEngineRuby::ConfigSpec::OrHash,
+          updated_at: Time,
+          version: DockerEngineRuby::ConfigObject::Version::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        created_at: nil,
+        id: nil,
+        spec: nil,
+        updated_at: nil,
+        # The version number of the object such as node, service, etc. This is needed to
+        # avoid conflicting writes. The client must send the version number along with the
+        # modified specification when updating these objects.
+        #
+        # This approach ensures safe concurrency and determinism in that the change on the
+        # object may not be applied if the version number has changed from the last read.
+        # In other words, if two update requests specify the same base version, only one
+        # of the requests can succeed. As a result, two separate update requests that
+        # happen at the same time will not unintentionally overwrite each other.
+        version: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created_at: Time,
+            id: String,
+            spec: DockerEngineRuby::ConfigSpec,
+            updated_at: Time,
+            version: DockerEngineRuby::ConfigObject::Version
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Version < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::ConfigObject::Version,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :index
+
+        sig { params(index: Integer).void }
+        attr_writer :index
+
+        # The version number of the object such as node, service, etc. This is needed to
+        # avoid conflicting writes. The client must send the version number along with the
+        # modified specification when updating these objects.
+        #
+        # This approach ensures safe concurrency and determinism in that the change on the
+        # object may not be applied if the version number has changed from the last read.
+        # In other words, if two update requests specify the same base version, only one
+        # of the requests can succeed. As a result, two separate update requests that
+        # happen at the same time will not unintentionally overwrite each other.
+        sig { params(index: Integer).returns(T.attached_class) }
+        def self.new(index: nil)
+        end
+
+        sig { override.returns({ index: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end