feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 8
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hdr-parth-agrawal%2Ffirecracker-manager-07b6a4a1a7515802531be41461e4d9b4badad13e93492f5a408d54f51693d717.yml
-openapi_spec_hash: aba885b7687af21c2151833c9d7a2dab
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hdr-parth-agrawal%2Ffirecracker-manager-fc1351bc8599fc6873d1be7f16ed805907442c3a50f68659b312076be10bd5d0.yml
+openapi_spec_hash: 15a3d34206ed2dca0702a8a3291e1d7b
 config_hash: ba476ff7e5c71b83e72ad86fcb01beeb

lib/vers/models.rb

@@ -51,8 +51,6 @@ module Vers
 
   VmCommitParams = Vers::Models::VmCommitParams
 
-  VmCommitResponse = Vers::Models::VmCommitResponse
-
   VmCreateRootParams = Vers::Models::VmCreateRootParams
 
   VmDeleteParams = Vers::Models::VmDeleteParams

lib/vers/models/vm.rb

@@ -13,21 +13,39 @@ class VmAPI < Vers::Internal::Type::BaseModel
       #   @return [String]
       required :owner_id, String
 
+      # @!attribute state
+      #   The state of a VM
+      #
+      #   @return [Symbol, Vers::Models::VmAPI::State]
+      required :state, enum: -> { Vers::VmAPI::State }
+
       # @!attribute vm_id
       #
       #   @return [String]
       required :vm_id, String
 
-      # @!attribute parent
-      #
-      #   @return [String, nil]
-      optional :parent, String, nil?: true
-
-      # @!method initialize(created_at:, owner_id:, vm_id:, parent: nil)
+      # @!method initialize(created_at:, owner_id:, state:, vm_id:)
       #   @param created_at [Time]
+      #
       #   @param owner_id [String]
+      #
+      #   @param state [Symbol, Vers::Models::VmAPI::State] The state of a VM
+      #
       #   @param vm_id [String]
-      #   @param parent [String, nil]
+
+      # The state of a VM
+      #
+      # @see Vers::Models::VmAPI#state
+      module State
+        extend Vers::Internal::Type::Enum
+
+        BOOTING = :booting
+        RUNNING = :running
+        PAUSED = :paused
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

lib/vers/models/vm_commit_params.rb

@@ -7,7 +7,23 @@ class VmCommitParams < Vers::Internal::Type::BaseModel
       extend Vers::Internal::Type::RequestParameters::Converter
       include Vers::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute keep_paused
+      #   If true, keep VM paused after commit
+      #
+      #   @return [Boolean, nil]
+      optional :keep_paused, Vers::Internal::Type::Boolean
+
+      # @!attribute skip_wait_boot
+      #   If true, return an error immediately if the VM is still booting. Default: false
+      #
+      #   @return [Boolean, nil]
+      optional :skip_wait_boot, Vers::Internal::Type::Boolean
+
+      # @!method initialize(keep_paused: nil, skip_wait_boot: nil, request_options: {})
+      #   @param keep_paused [Boolean] If true, keep VM paused after commit
+      #
+      #   @param skip_wait_boot [Boolean] If true, return an error immediately if the VM is still booting. Default: false
+      #
       #   @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/vers/models/vm_commit_response.rb

@@ -5,23 +5,14 @@ module Models
     # @see Vers::Resources::Vm#commit
     class VmCommitResponse < Vers::Internal::Type::BaseModel
       # @!attribute commit_id
-      #   The commit ID, a (v4) UUID
       #
       #   @return [String]
       required :commit_id, String
 
-      # @!attribute host_architecture
-      #   The host architecture, eg: "x86_64" (currently implemented with `uname -m``)
+      # @!method initialize(commit_id:)
+      #   A summary of a commit, appropriate for displaying on the frontend
       #
-      #   @return [String]
-      required :host_architecture, String
-
-      # @!method initialize(commit_id:, host_architecture:)
-      #   The response body for POST /api/vm/{vm_id}/commit
-      #
-      #   @param commit_id [String] The commit ID, a (v4) UUID
-      #
-      #   @param host_architecture [String] The host architecture, eg: "x86_64" (currently implemented with `uname -m``)
+      #   @param commit_id [String]
     end
   end
 end

lib/vers/models/vm_create_root_params.rb

@@ -7,7 +7,19 @@ class VmCreateRootParams < Vers::Models::NewRootRequest
       extend Vers::Internal::Type::RequestParameters::Converter
       include Vers::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute wait_boot
+      #   If true, wait for the newly-created VM to finish booting before returning.
+      #   Default: false.
+      #
+      #   @return [Boolean, nil]
+      optional :wait_boot, Vers::Internal::Type::Boolean
+
+      # @!method initialize(wait_boot: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vers::Models::VmCreateRootParams} for more details.
+      #
+      #   @param wait_boot [Boolean] If true, wait for the newly-created VM to finish booting before returning. Defau
+      #
       #   @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/vers/models/vm_delete_params.rb

@@ -7,7 +7,15 @@ class VmDeleteParams < Vers::Internal::Type::BaseModel
       extend Vers::Internal::Type::RequestParameters::Converter
       include Vers::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute skip_wait_boot
+      #   If true, return an error immediately if the VM is still booting. Default: false
+      #
+      #   @return [Boolean, nil]
+      optional :skip_wait_boot, Vers::Internal::Type::Boolean
+
+      # @!method initialize(skip_wait_boot: nil, request_options: {})
+      #   @param skip_wait_boot [Boolean] If true, return an error immediately if the VM is still booting. Default: false
+      #
       #   @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/vers/models/vm_delete_response.rb

@@ -4,15 +4,15 @@ module Vers
   module Models
     # @see Vers::Resources::Vm#delete
     class VmDeleteResponse < Vers::Internal::Type::BaseModel
-      # @!attribute deleted_ids
+      # @!attribute vm_id
       #
-      #   @return [Array<String>]
-      required :deleted_ids, Vers::Internal::Type::ArrayOf[String]
+      #   @return [String]
+      required :vm_id, String
 
-      # @!method initialize(deleted_ids:)
+      # @!method initialize(vm_id:)
       #   Response body for DELETE /api/vm/{vm_id}
       #
-      #   @param deleted_ids [Array<String>]
+      #   @param vm_id [String]
     end
   end
 end

lib/vers/models/vm_update_state_params.rb

@@ -7,7 +7,15 @@ class VmUpdateStateParams < Vers::Models::VmUpdateStateRequest
       extend Vers::Internal::Type::RequestParameters::Converter
       include Vers::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute skip_wait_boot
+      #   If true, error immediately if the VM is not finished booting. Defaults to false
+      #
+      #   @return [Boolean, nil]
+      optional :skip_wait_boot, Vers::Internal::Type::Boolean
+
+      # @!method initialize(skip_wait_boot: nil, request_options: {})
+      #   @param skip_wait_boot [Boolean] If true, error immediately if the VM is not finished booting. Defaults to false
+      #
       #   @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/vers/resources/vm.rb

@@ -19,21 +19,25 @@ def list(params = {})
         )
       end
 
-      # @overload delete(vm_id, request_options: {})
+      # @overload delete(vm_id, skip_wait_boot: nil, request_options: {})
       #
       # @param vm_id [String] VM ID to delete
       #
+      # @param skip_wait_boot [Boolean] If true, return an error immediately if the VM is still booting. Default: false
+      #
       # @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Vers::Models::VmDeleteResponse]
       #
       # @see Vers::Models::VmDeleteParams
       def delete(vm_id, params = {})
+        parsed, options = Vers::VmDeleteParams.dump_request(params)
         @client.request(
           method: :delete,
           path: ["vm/%1$s", vm_id],
+          query: parsed,
           model: Vers::VmDeleteResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -55,27 +59,38 @@ def branch(vm_id, params = {})
         )
       end
 
-      # @overload commit(vm_id, request_options: {})
+      # @overload commit(vm_id, keep_paused: nil, skip_wait_boot: nil, request_options: {})
       #
       # @param vm_id [String] VM ID to commit
       #
+      # @param keep_paused [Boolean] If true, keep VM paused after commit
+      #
+      # @param skip_wait_boot [Boolean] If true, return an error immediately if the VM is still booting. Default: false
+      #
       # @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Vers::Models::VmCommitResponse]
       #
       # @see Vers::Models::VmCommitParams
       def commit(vm_id, params = {})
+        parsed, options = Vers::VmCommitParams.dump_request(params)
         @client.request(
           method: :post,
           path: ["vm/%1$s/commit", vm_id],
-          model: Vers::VmCommitResponse,
-          options: params[:request_options]
+          query: parsed,
+          model: Vers::Models::VmCommitResponse,
+          options: options
         )
       end
 
-      # @overload create_root(vm_config:, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Vers::Models::VmCreateRootParams} for more details.
       #
-      # @param vm_config [Vers::Models::NewRootRequest::VmConfig] Struct representing configuration options common to all VMs
+      # @overload create_root(vm_config:, wait_boot: nil, request_options: {})
+      #
+      # @param vm_config [Vers::Models::NewRootRequest::VmConfig] Body param: Struct representing configuration options common to all VMs
+      #
+      # @param wait_boot [Boolean] Query param: If true, wait for the newly-created VM to finish booting before ret
       #
       # @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -84,10 +99,12 @@ def commit(vm_id, params = {})
       # @see Vers::Models::VmCreateRootParams
       def create_root(params)
         parsed, options = Vers::VmCreateRootParams.dump_request(params)
+        query_params = [:wait_boot]
         @client.request(
           method: :post,
           path: "vm/new_root",
-          body: parsed,
+          query: parsed.slice(*query_params),
+          body: parsed.except(*query_params),
           model: Vers::NewVmResponse,
           options: options
         )
@@ -130,11 +147,16 @@ def restore_from_commit(params)
         )
       end
 
-      # @overload update_state(vm_id, state:, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Vers::Models::VmUpdateStateParams} for more details.
       #
-      # @param vm_id [String] VM ID
+      # @overload update_state(vm_id, state:, skip_wait_boot: nil, request_options: {})
       #
-      # @param state [Symbol, Vers::Models::VmUpdateStateRequest::State] The requested state for the VM
+      # @param vm_id [String] Path param: VM ID
+      #
+      # @param state [Symbol, Vers::Models::VmUpdateStateRequest::State] Body param: The requested state for the VM
+      #
+      # @param skip_wait_boot [Boolean] Query param: If true, error immediately if the VM is not finished booting. Defau
       #
       # @param request_options [Vers::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -143,10 +165,12 @@ def restore_from_commit(params)
       # @see Vers::Models::VmUpdateStateParams
       def update_state(vm_id, params)
         parsed, options = Vers::VmUpdateStateParams.dump_request(params)
+        query_params = [:skip_wait_boot]
         @client.request(
           method: :patch,
           path: ["vm/%1$s/state", vm_id],
-          body: parsed,
+          query: parsed.slice(*query_params),
+          body: parsed.except(*query_params),
           model: NilClass,
           options: options
         )