comet_backup_ruby_sdk 2.42.0 → 2.43.0

data/lib/comet/models/{pverestore_selection.rb → dispatch_with_job_idresponse.rb}

@@ -9,17 +9,18 @@ require 'json'
 
 module Comet
 
-  # PVERestoreSelection is a typed class wrapper around the underlying Comet Server API data structure.
-  class PVERestoreSelection
+  # DispatchWithJobIDResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class DispatchWithJobIDResponse
 
-    # @type [String] id
-    attr_accessor :id
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
 
-    # @type [String] name
-    attr_accessor :name
+    # @type [String] message
+    attr_accessor :message
 
-    # @type [Comet::PVEVM] target_vm
-    attr_accessor :target_vm
+    # @type [String] job_id
+    attr_accessor :job_id
 
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
@@ -29,9 +30,9 @@ module Comet
     end
 
     def clear
-      @id = ''
-      @name = ''
-      @target_vm = Comet::PVEVM.new
+      @status = 0
+      @message = ''
+      @job_id = ''
       @unknown_json_fields = {}
     end
 
@@ -48,17 +49,18 @@ module Comet
 
       obj.each do |k, v|
         case k
-        when 'ID'
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
-          @id = v
-        when 'Name'
+          @message = v
+        when 'JobID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
-          @name = v
-        when 'TargetVM'
-          @target_vm = Comet::PVEVM.new
-          @target_vm.from_hash(v)
+          @job_id = v
         else
           @unknown_json_fields[k] = v
         end
@@ -68,13 +70,11 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
-      unless @id.nil?
-        ret['ID'] = @id
-      end
-      unless @name.nil?
-        ret['Name'] = @name
+      ret['Status'] = @status
+      ret['Message'] = @message
+      unless @job_id.nil?
+        ret['JobID'] = @job_id
       end
-      ret['TargetVM'] = @target_vm
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/private_branding_properties.rb

@@ -93,6 +93,18 @@ module Comet
     # @type [String] windows_code_sign_azure_tenant_id
     attr_accessor :windows_code_sign_azure_tenant_id
 
+    # URL of the SAS Relic server, with protocol (https://) and trailing slash
+    # @type [String] windows_code_sign_relic_server_url
+    attr_accessor :windows_code_sign_relic_server_url
+
+    # The SAS Relic client keypair in PEM format
+    # @type [String] windows_code_sign_relic_keypair_file
+    attr_accessor :windows_code_sign_relic_keypair_file
+
+    # The name of the key to select on the remote SAS Relic server
+    # @type [String] windows_code_sign_relic_key_name
+    attr_accessor :windows_code_sign_relic_key_name
+
     # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
     attr_accessor :mac_oscode_sign
 
@@ -129,6 +141,9 @@ module Comet
       @windows_code_sign_azure_app_secret_format = 0
       @windows_code_sign_azure_app_secret = ''
       @windows_code_sign_azure_tenant_id = ''
+      @windows_code_sign_relic_server_url = ''
+      @windows_code_sign_relic_keypair_file = ''
+      @windows_code_sign_relic_key_name = ''
       @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
       @unknown_json_fields = {}
     end
@@ -246,6 +261,18 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_azure_tenant_id = v
+        when 'WindowsCodeSignRelicServerURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_server_url = v
+        when 'WindowsCodeSignRelicKeypairFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_keypair_file = v
+        when 'WindowsCodeSignRelicKeyName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_key_name = v
         when 'MacOSCodeSign'
           @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
           @mac_oscode_sign.from_hash(v)
@@ -283,6 +310,9 @@ module Comet
       ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
       ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
       ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
+      ret['WindowsCodeSignRelicServerURL'] = @windows_code_sign_relic_server_url
+      ret['WindowsCodeSignRelicKeypairFile'] = @windows_code_sign_relic_keypair_file
+      ret['WindowsCodeSignRelicKeyName'] = @windows_code_sign_relic_key_name
       ret['MacOSCodeSign'] = @mac_oscode_sign
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/protected_item_with_backup_rules_response.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # ProtectedItemWithBackupRulesResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProtectedItemWithBackupRulesResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # The Protected Item configuration
+    # @type [Comet::SourceConfig] source
+    attr_accessor :source
+
+    # All backup rules for the Protected Item
+    # @type [Hash{String => Comet::BackupRuleConfig}] backup_rules
+    attr_accessor :backup_rules
+
+    # @type [String] profile_hash
+    attr_accessor :profile_hash
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @source = Comet::SourceConfig.new
+      @backup_rules = {}
+      @profile_hash = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Source'
+          @source = Comet::SourceConfig.new
+          @source.from_hash(v)
+        when 'BackupRules'
+          @backup_rules = {}
+          if v.nil?
+            @backup_rules = {}
+          else
+            v.each do |k1, v1|
+              @backup_rules[k1] = Comet::BackupRuleConfig.new
+              @backup_rules[k1].from_hash(v1)
+            end
+          end
+        when 'ProfileHash'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @profile_hash = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Source'] = @source
+      unless @backup_rules.nil?
+        ret['BackupRules'] = @backup_rules
+      end
+      ret['ProfileHash'] = @profile_hash
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/pvebackup_disk.rb

@@ -10,11 +10,17 @@ require 'json'
 module Comet
 
   # PVEBackupDisk is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# selection state for a single disk attached to a single Proxmox VM or LXC Container. It is expected
+# to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEBackupDisk
 
+    # For a disk "scsi0", this field should contain: "scsi"
     # @type [String] device
     attr_accessor :device
 
+    # For a disk "scsi0", this field should contain: 0
     # @type [Number] device_num
     attr_accessor :device_num
 

data/lib/comet/models/pvebackup_node.rb

@@ -10,11 +10,16 @@ require 'json'
 module Comet
 
   # PVEBackupNode is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# selection state for a single Proxmox VE node. It is expected to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEBackupNode
 
     # @type [Array<Comet::PVEBackupVM>] included_vms
     attr_accessor :included_vms
 
+    # Used as a cache if the device is offline when editing the Protected Item; not considered as part
+    # of the selection
     # @type [String] name
     attr_accessor :name
 

data/lib/comet/models/pvebackup_vm.rb

@@ -10,17 +10,23 @@ require 'json'
 module Comet
 
   # PVEBackupVM is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# selection state for a single Proxmox VM or LXC Container. It is expected to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEBackupVM
 
     # @type [Array<Comet::PVEBackupDisk>] included_disks
     attr_accessor :included_disks
 
+    # Used as a cache if the device is offline when editing the Protected Item; not considered as part
+    # of the selection
     # @type [String] name
     attr_accessor :name
 
     # @type [Boolean] selected
     attr_accessor :selected
 
+    # One of the PROXMOX_TYPE_ constants
     # @type [String] type
     attr_accessor :type
 

data/lib/comet/models/pvedisk.rb

@@ -24,7 +24,8 @@ module Comet
     # @type [String] volume
     attr_accessor :volume
 
-    # @type [String] size
+    # Bytes
+    # @type [Number] size
     attr_accessor :size
 
     # @type [String] format
@@ -45,7 +46,7 @@ module Comet
       @device_num = 0
       @storage_id = ''
       @volume = ''
-      @size = ''
+      @size = 0
       @format = ''
       @options = ''
       @unknown_json_fields = {}
@@ -81,7 +82,7 @@ module Comet
 
           @volume = v
         when 'Size'
-          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @size = v
         when 'Format'

data/lib/comet/models/pveparams.rb

@@ -10,6 +10,9 @@ require 'json'
 module Comet
 
   # PVEParams is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# entire Protected Item configuration. It is expected to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEParams
 
     # @type [Boolean] everything
@@ -18,18 +21,20 @@ module Comet
     # @type [Array<Comet::PVEBackupNode>] exclusions
     attr_accessor :exclusions
 
+    # One of the PVE_BACKUP_METHOD constants
     # @type [String] method
     attr_accessor :method
 
-    # @type [Number] quota
-    attr_accessor :quota
-
+    # Primary node URL + SSH credentials
     # @type [Comet::SSHConnection] sshconnection
     attr_accessor :sshconnection
 
     # @type [Array<Comet::PVEBackupNode>] selections
     attr_accessor :selections
 
+    # @type [Boolean] use_cbt
+    attr_accessor :use_cbt
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -40,7 +45,6 @@ module Comet
     def clear
       @exclusions = []
       @method = ''
-      @quota = 0
       @sshconnection = Comet::SSHConnection.new
       @selections = []
       @unknown_json_fields = {}
@@ -75,10 +79,6 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @method = v
-        when 'Quota'
-          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
-
-          @quota = v
         when 'SSHConnection'
           @sshconnection = Comet::SSHConnection.new
           @sshconnection.from_hash(v)
@@ -92,6 +92,8 @@ module Comet
               @selections[i1].from_hash(v1)
             end
           end
+        when 'UseCBT'
+          @use_cbt = v
         else
           @unknown_json_fields[k] = v
         end
@@ -110,15 +112,15 @@ module Comet
       unless @method.nil?
         ret['Method'] = @method
       end
-      unless @quota.nil?
-        ret['Quota'] = @quota
-      end
       unless @sshconnection.nil?
         ret['SSHConnection'] = @sshconnection
       end
       unless @selections.nil?
         ret['Selections'] = @selections
       end
+      unless @use_cbt.nil?
+        ret['UseCBT'] = @use_cbt
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/pvevm.rb

@@ -10,6 +10,7 @@ require 'json'
 module Comet
 
   # PVEVM is a typed class wrapper around the underlying Comet Server API data structure.
+  # PVEVM describes a single Proxmox virtual machine or container.
   class PVEVM
 
     # @type [String] cpu
@@ -36,6 +37,7 @@ module Comet
     # @type [String] type
     attr_accessor :type
 
+    # String type, but always contains an integer value
     # @type [String] vmid
     attr_accessor :vmid
 

data/lib/comet/models/source_config.rb

@@ -88,6 +88,13 @@ module Comet
     # - LOGNOTRUNC: If present, take a "Log (no truncation)" backup job. Otherwise, take a "Full (copy
     # only)" backup job.
     #
+    # For engine1/stdout, Comet understands the following EngineProp keys:
+    #
+    # - COMMAND: The command to run
+    # - WORKDIR: The working directory for the command
+    # - SAVEAS: The virtual filename inside the backup snapshot
+    # - Any key starting with EXTRACOMMAND- : Additional commands to run. Each value should be a JSON
+    # array of 3 strings, equivalent to the COMMAND, WORKDIR, SAVEAS values.
     # @type [Hash{String => String}] engine_props
     attr_accessor :engine_props
 

data/lib/comet/models/user_profile_config.rb

@@ -181,6 +181,11 @@ module Comet
     # @type [String] auto_storage_template_guid
     attr_accessor :auto_storage_template_guid
 
+    # If enabled, Linux devices in this user account will sandbox all read/write operations to paths
+    # inside user home directories
+    # @type [Boolean] linux_homedir_sandbox
+    attr_accessor :linux_homedir_sandbox
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -399,6 +404,8 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @auto_storage_template_guid = v
+        when 'LinuxHomedirSandbox'
+          @linux_homedir_sandbox = v
         else
           @unknown_json_fields[k] = v
         end
@@ -452,6 +459,7 @@ module Comet
         ret['ServerConfig'] = @server_config
       end
       ret['AutoStorageTemplateGUID'] = @auto_storage_template_guid
+      ret['LinuxHomedirSandbox'] = @linux_homedir_sandbox
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/vault_snapshot.rb

@@ -29,6 +29,10 @@ module Comet
     # @type [Boolean] has_original_path_info
     attr_accessor :has_original_path_info
 
+    # This field is available in Comet 25.9.4 and later.
+    # @type [Array<String>] tags
+    attr_accessor :tags
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -41,6 +45,7 @@ module Comet
       @engine_type = ''
       @source = ''
       @create_time = 0
+      @tags = []
       @unknown_json_fields = {}
     end
 
@@ -75,6 +80,17 @@ module Comet
           @create_time = v
         when 'HasOriginalPathInfo'
           @has_original_path_info = v
+        when 'Tags'
+          if v.nil?
+            @tags = []
+          else
+            @tags = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @tags[i1] = v1
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -89,6 +105,9 @@ module Comet
       ret['Source'] = @source
       ret['CreateTime'] = @create_time
       ret['HasOriginalPathInfo'] = @has_original_path_info
+      unless @tags.nil?
+        ret['Tags'] = @tags
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/windows_code_sign_properties.rb

@@ -65,6 +65,18 @@ module Comet
     # @type [String] windows_code_sign_azure_tenant_id
     attr_accessor :windows_code_sign_azure_tenant_id
 
+    # URL of the SAS Relic server, with protocol (https://) and trailing slash
+    # @type [String] windows_code_sign_relic_server_url
+    attr_accessor :windows_code_sign_relic_server_url
+
+    # The SAS Relic client keypair in PEM format
+    # @type [String] windows_code_sign_relic_keypair_file
+    attr_accessor :windows_code_sign_relic_keypair_file
+
+    # The name of the key to select on the remote SAS Relic server
+    # @type [String] windows_code_sign_relic_key_name
+    attr_accessor :windows_code_sign_relic_key_name
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -89,6 +101,9 @@ module Comet
       @windows_code_sign_azure_app_secret_format = 0
       @windows_code_sign_azure_app_secret = ''
       @windows_code_sign_azure_tenant_id = ''
+      @windows_code_sign_relic_server_url = ''
+      @windows_code_sign_relic_keypair_file = ''
+      @windows_code_sign_relic_key_name = ''
       @unknown_json_fields = {}
     end
 
@@ -169,6 +184,18 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_azure_tenant_id = v
+        when 'WindowsCodeSignRelicServerURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_server_url = v
+        when 'WindowsCodeSignRelicKeypairFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_keypair_file = v
+        when 'WindowsCodeSignRelicKeyName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_key_name = v
         else
           @unknown_json_fields[k] = v
         end
@@ -194,6 +221,9 @@ module Comet
       ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
       ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
       ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
+      ret['WindowsCodeSignRelicServerURL'] = @windows_code_sign_relic_server_url
+      ret['WindowsCodeSignRelicKeypairFile'] = @windows_code_sign_relic_keypair_file
+      ret['WindowsCodeSignRelicKeyName'] = @windows_code_sign_relic_key_name
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet_backup_ruby_sdk.rb

@@ -31,7 +31,6 @@ require_relative 'comet/models/backup_job_detail'
 require_relative 'comet/models/backup_job_progress'
 require_relative 'comet/models/backup_rule_config'
 require_relative 'comet/models/backup_rule_event_triggers'
-require_relative 'comet/models/block_info'
 require_relative 'comet/models/branding_options'
 require_relative 'comet/models/branding_properties'
 require_relative 'comet/models/browse_disk_drives_response'
@@ -63,7 +62,6 @@ require_relative 'comet/models/count_jobs_response'
 require_relative 'comet/models/create_group_policy_response'
 require_relative 'comet/models/create_user_group_response'
 require_relative 'comet/models/custom_remote_bucket_settings'
-require_relative 'comet/models/custom_remote_bucket_settings'
 require_relative 'comet/models/days_of_week_config'
 require_relative 'comet/models/default_email_report_policy'
 require_relative 'comet/models/default_source_with_osrestriction'
@@ -72,6 +70,7 @@ require_relative 'comet/models/destination_location'
 require_relative 'comet/models/destination_statistics'
 require_relative 'comet/models/device_config'
 require_relative 'comet/models/disk_drive'
+require_relative 'comet/models/dispatch_with_job_idresponse'
 require_relative 'comet/models/dispatcher_admin_sources_response'
 require_relative 'comet/models/dispatcher_list_snapshot_virtual_machines_response'
 require_relative 'comet/models/dispatcher_stored_objects_response'
@@ -138,6 +137,7 @@ require_relative 'comet/models/partition_conflict'
 require_relative 'comet/models/policy_options'
 require_relative 'comet/models/private_branding_properties'
 require_relative 'comet/models/protected_item_engine_type_policy'
+require_relative 'comet/models/protected_item_with_backup_rules_response'
 require_relative 'comet/models/proxmox_connection'
 require_relative 'comet/models/proxmox_restore_target_options'
 require_relative 'comet/models/psaconfig'
@@ -147,12 +147,9 @@ require_relative 'comet/models/pvebackup_disk'
 require_relative 'comet/models/pvebackup_node'
 require_relative 'comet/models/pvebackup_vm'
 require_relative 'comet/models/pvedisk'
-require_relative 'comet/models/pvedisk'
 require_relative 'comet/models/pveparams'
-require_relative 'comet/models/pverestore_selection'
 require_relative 'comet/models/pvestorage_name'
 require_relative 'comet/models/pvevm'
-require_relative 'comet/models/pvevm'
 require_relative 'comet/models/ratelimit_options'
 require_relative 'comet/models/ratelimit_rule'
 require_relative 'comet/models/register_office_application_begin_response'