comet_backup_ruby_sdk 2.41.0 → 2.42.0

data/lib/comet/models/browse_proxmox_storage_response.rb

@@ -0,0 +1,98 @@
+# 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
+
+  # BrowseProxmoxStorageResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseProxmoxStorageResponse
+
+    # 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
+
+    # @type [Array<Comet::PVEStorageName>] 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
+      @status = 0
+      @message = ''
+      @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 '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 'Storage'
+          if v.nil?
+            @storage = []
+          else
+            @storage = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @storage[i1] = Comet::PVEStorageName.new
+              @storage[i1].from_hash(v1)
+            end
+          end
+        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['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/external_authentication_source.rb

@@ -18,15 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] remote_address
     attr_accessor :remote_address
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] username
     attr_accessor :username
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] password
     attr_accessor :password
 

data/lib/comet/models/office_365custom_setting_v2.rb

@@ -24,23 +24,27 @@ module Comet
     # @type [Boolean] filter_mode
     attr_accessor :filter_mode
 
+    # If true, backup everything, ignoring selection and filter options
+    # @type [Boolean] whole_org
+    attr_accessor :whole_org
+
     # Key is the ID of User, Group, or Site
-    # Value is a bitset of the SERVICE_ constants, to select which services to back up for members
+    # Value is a bitset of the SERVICE_ constants, to select which services to backup for accounts
     # @type [Hash{String => Number}] backup_options
     attr_accessor :backup_options
 
     # Key is the ID of a Group or Team Site
-    # Value is a bitset of the SERVICE_ constants, to select which services to back up for members
+    # Value is a bitset of the SERVICE_ constants, to select which services to backup for members
     # @type [Hash{String => Number}] member_backup_options
     attr_accessor :member_backup_options
 
     # Key is the ID of a User, Group, or Site
-    # Value is a bitset of the SERVICE_ constants, to select which services to back up for members
+    # Value is a bitset of the SERVICE_ constants, to select which services to not backup for accounts
     # @type [Hash{String => Number}] filter_options
     attr_accessor :filter_options
 
     # Key is the ID of a Group or Team Site
-    # Value is a bitset of the SERVICE_ constants, to select which services to back up for members
+    # Value is a bitset of the SERVICE_ constants, to select which services to not backup for members
     # @type [Hash{String => Number}] filter_member_options
     attr_accessor :filter_member_options
 
@@ -76,6 +80,8 @@ module Comet
           @organization = v
         when 'FilterMode'
           @filter_mode = v
+        when 'WholeOrg'
+          @whole_org = v
         when 'BackupOptions'
           @backup_options = {}
           if v.nil?
@@ -130,7 +136,12 @@ module Comet
     def to_hash
       ret = {}
       ret['Organization'] = @organization
-      ret['FilterMode'] = @filter_mode
+      unless @filter_mode.nil?
+        ret['FilterMode'] = @filter_mode
+      end
+      unless @whole_org.nil?
+        ret['WholeOrg'] = @whole_org
+      end
       unless @backup_options.nil?
         ret['BackupOptions'] = @backup_options
       end

data/lib/comet/models/partition.rb

@@ -15,6 +15,14 @@ module Comet
     # @type [String] device_name
     attr_accessor :device_name
 
+    # The partition's MBR or GPT id, if any
+    # @type [String] partition_guid
+    attr_accessor :partition_guid
+
+    # The partition's offset within the physical disk
+    # @type [Number] partition_offset
+    attr_accessor :partition_offset
+
     # The name of the filesystem used on this partition (e.g. "NTFS")
     # @type [String] filesystem
     attr_accessor :filesystem
@@ -59,6 +67,8 @@ module Comet
 
     def clear
       @device_name = ''
+      @partition_guid = ''
+      @partition_offset = 0
       @filesystem = ''
       @volume_name = ''
       @volume_guid = ''
@@ -89,6 +99,14 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @device_name = v
+        when 'PartitionGuid'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @partition_guid = v
+        when 'PartitionOffset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @partition_offset = v
         when 'Filesystem'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -146,6 +164,8 @@ module Comet
     def to_hash
       ret = {}
       ret['DeviceName'] = @device_name
+      ret['PartitionGuid'] = @partition_guid
+      ret['PartitionOffset'] = @partition_offset
       ret['Filesystem'] = @filesystem
       ret['VolumeName'] = @volume_name
       ret['VolumeGuid'] = @volume_guid

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,86 @@
+# 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.
+  class PVEBackupDisk
+
+    # @type [String] device
+    attr_accessor :device
+
+    # @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,100 @@
+# 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.
+  class PVEBackupNode
+
+    # @type [Array<Comet::PVEBackupVM>] included_vms
+    attr_accessor :included_vms
+
+    # @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,122 @@
+# 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.
+  class PVEBackupVM
+
+    # @type [Array<Comet::PVEBackupDisk>] included_disks
+    attr_accessor :included_disks
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Boolean] selected
+    attr_accessor :selected
+
+    # @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