comet_backup_ruby_sdk 2.41.0 → 2.43.0

data/lib/comet/models/backup_rule_config.rb

@@ -80,6 +80,10 @@ module Comet
     # @type [String] log_level
     attr_accessor :log_level
 
+    # Default disabled
+    # @type [String] tags
+    attr_accessor :tags
+
     # Scheduled start times
     # @type [Array<Comet::ScheduleConfig>] schedules
     attr_accessor :schedules
@@ -109,6 +113,7 @@ module Comet
       @auto_retention_level = 0
       @concurrency_count = 0
       @log_level = ''
+      @tags = ''
       @schedules = []
       @event_triggers = Comet::BackupRuleEventTriggers.new
       @unknown_json_fields = {}
@@ -208,6 +213,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @log_level = v
+        when 'Tags'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tags = v
         when 'Schedules'
           if v.nil?
             @schedules = []
@@ -247,6 +256,7 @@ module Comet
       ret['AutoRetentionLevel'] = @auto_retention_level
       ret['ConcurrencyCount'] = @concurrency_count
       ret['LogLevel'] = @log_level
+      ret['Tags'] = @tags
       ret['Schedules'] = @schedules
       ret['EventTriggers'] = @event_triggers
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/branding_options.rb

@@ -149,6 +149,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
 
@@ -198,6 +210,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
@@ -377,6 +392,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)
@@ -432,6 +459,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/branding_properties.rb

@@ -126,6 +126,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
 
@@ -169,6 +181,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
@@ -322,6 +337,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)
@@ -370,6 +397,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/browse_proxmox_nodes_response.rb

@@ -0,0 +1,99 @@
+# 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
+
+  # BrowseProxmoxNodesResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseProxmoxNodesResponse
+
+    # 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<String>] nodes
+    attr_accessor :nodes
+
+    # @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 = ''
+      @nodes = []
+      @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 'Nodes'
+          if v.nil?
+            @nodes = []
+          else
+            @nodes = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @nodes[i1] = 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['Nodes'] = @nodes
+      @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/browse_proxmox_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
+
+  # BrowseProxmoxResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseProxmoxResponse
+
+    # 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::PVEVM>] vms
+    attr_accessor :vms
+
+    # @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 = ''
+      @vms = []
+      @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 'VMs'
+          if v.nil?
+            @vms = []
+          else
+            @vms = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @vms[i1] = Comet::PVEVM.new
+              @vms[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['VMs'] = @vms
+      @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/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/dispatch_with_job_idresponse.rb

@@ -0,0 +1,94 @@
+# 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
+
+  # DispatchWithJobIDResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class DispatchWithJobIDResponse
+
+    # 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 [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
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @job_id = ''
+      @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 'JobID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @job_id = 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
+      unless @job_id.nil?
+        ret['JobID'] = @job_id
+      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/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