comet_backup_ruby_sdk 2.41.0 → 2.43.0

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/proxmox_connection.rb

@@ -0,0 +1,72 @@
+# 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
+
+  # ProxmoxConnection is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProxmoxConnection
+
+    # @type [Comet::SSHConnection] ssh
+    attr_accessor :ssh
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @ssh = Comet::SSHConnection.new
+      @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 'SSH'
+          @ssh = Comet::SSHConnection.new
+          @ssh.from_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['SSH'] = @ssh
+      @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/proxmox_restore_target_options.rb

@@ -0,0 +1,92 @@
+# 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
+
+  # ProxmoxRestoreTargetOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProxmoxRestoreTargetOptions
+
+    # The name of the node to restore to in the Proxmox Cluster
+    # @type [String] node
+    attr_accessor :node
+
+    # @type [Comet::SSHConnection] ssh
+    attr_accessor :ssh
+
+    # the name of the storage location to restore to
+    # @type [String] storage
+    attr_accessor :storage
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @node = ''
+      @ssh = Comet::SSHConnection.new
+      @storage = ''
+      @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 'Node'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @node = v
+        when 'SSH'
+          @ssh = Comet::SSHConnection.new
+          @ssh.from_hash(v)
+        when 'Storage'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @storage = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Node'] = @node
+      ret['SSH'] = @ssh
+      ret['Storage'] = @storage
+      @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

@@ -0,0 +1,92 @@
+# 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
+
+  # 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
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @device = ''
+      @device_num = 0
+      @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 'Device'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device = v
+        when 'DeviceNum'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @device_num = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @device.nil?
+        ret['Device'] = @device
+      end
+      unless @device_num.nil?
+        ret['DeviceNum'] = @device_num
+      end
+      @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_node.rb

@@ -0,0 +1,105 @@
+# 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
+
+  # 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
+
+    # @type [Boolean] selected
+    attr_accessor :selected
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @included_vms = []
+      @name = ''
+      @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 'IncludedVMs'
+          if v.nil?
+            @included_vms = []
+          else
+            @included_vms = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @included_vms[i1] = Comet::PVEBackupVM.new
+              @included_vms[i1].from_hash(v1)
+            end
+          end
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Selected'
+          @selected = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @included_vms.nil?
+        ret['IncludedVMs'] = @included_vms
+      end
+      unless @name.nil?
+        ret['Name'] = @name
+      end
+      unless @selected.nil?
+        ret['Selected'] = @selected
+      end
+      @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_vm.rb

@@ -0,0 +1,128 @@
+# 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
+
+  # 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
+
+    # @type [String] vmid
+    attr_accessor :vmid
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @included_disks = []
+      @name = ''
+      @type = ''
+      @vmid = ''
+      @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 'IncludedDisks'
+          if v.nil?
+            @included_disks = []
+          else
+            @included_disks = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @included_disks[i1] = Comet::PVEBackupDisk.new
+              @included_disks[i1].from_hash(v1)
+            end
+          end
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Selected'
+          @selected = v
+        when 'Type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'VMID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @vmid = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @included_disks.nil?
+        ret['IncludedDisks'] = @included_disks
+      end
+      unless @name.nil?
+        ret['Name'] = @name
+      end
+      unless @selected.nil?
+        ret['Selected'] = @selected
+      end
+      unless @type.nil?
+        ret['Type'] = @type
+      end
+      unless @vmid.nil?
+        ret['VMID'] = @vmid
+      end
+      @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