comet_backup_ruby_sdk 1.12.0 → 1.15.0

data/lib/comet/models/update_campaign_options.rb

@@ -12,6 +12,9 @@ require 'json'
 module Comet
 
   # UpdateCampaignOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  # This data structure describes which devices should receive a remote software upgrade. Both the
+  # target version criteria (UpgradeOlder/ReinstallCurrentVer/DowngradeNewer) and the target device
+  # criteria (ApplyDeviceFilter/DeviceFilter) must be met in order for the remote upgrade to be applied.
   class UpdateCampaignOptions
 
     # @type [Boolean] active
@@ -26,6 +29,15 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # @type [Boolean] force_upgrade_running
+    attr_accessor :force_upgrade_running
+
+    # @type [Boolean] apply_device_filter
+    attr_accessor :apply_device_filter
+
+    # @type [Comet::SearchClause] device_filter
+    attr_accessor :device_filter
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -34,6 +46,7 @@ module Comet
     end
 
     def clear
+      @device_filter = Comet::SearchClause.new
       @unknown_json_fields = {}
     end
 
@@ -58,6 +71,13 @@ module Comet
           @reinstall_current_ver = v
         when 'DowngradeNewer'
           @downgrade_newer = v
+        when 'ForceUpgradeRunning'
+          @force_upgrade_running = v
+        when 'ApplyDeviceFilter'
+          @apply_device_filter = v
+        when 'DeviceFilter'
+          @device_filter = Comet::SearchClause.new
+          @device_filter.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -71,6 +91,9 @@ module Comet
       ret['UpgradeOlder'] = @upgrade_older
       ret['ReinstallCurrentVer'] = @reinstall_current_ver
       ret['DowngradeNewer'] = @downgrade_newer
+      ret['ForceUpgradeRunning'] = @force_upgrade_running
+      ret['ApplyDeviceFilter'] = @apply_device_filter
+      ret['DeviceFilter'] = @device_filter
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/update_campaign_properties.rb

@@ -26,6 +26,15 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # @type [Boolean] force_upgrade_running
+    attr_accessor :force_upgrade_running
+
+    # @type [Boolean] apply_device_filter
+    attr_accessor :apply_device_filter
+
+    # @type [Comet::SearchClause] device_filter
+    attr_accessor :device_filter
+
     # @type [Number] start_time
     attr_accessor :start_time
 
@@ -40,6 +49,7 @@ module Comet
     end
 
     def clear
+      @device_filter = Comet::SearchClause.new
       @start_time = 0
       @target_version = ''
       @unknown_json_fields = {}
@@ -66,6 +76,13 @@ module Comet
           @reinstall_current_ver = v
         when 'DowngradeNewer'
           @downgrade_newer = v
+        when 'ForceUpgradeRunning'
+          @force_upgrade_running = v
+        when 'ApplyDeviceFilter'
+          @apply_device_filter = v
+        when 'DeviceFilter'
+          @device_filter = Comet::SearchClause.new
+          @device_filter.from_hash(v)
         when 'StartTime'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -87,6 +104,9 @@ module Comet
       ret['UpgradeOlder'] = @upgrade_older
       ret['ReinstallCurrentVer'] = @reinstall_current_ver
       ret['DowngradeNewer'] = @downgrade_newer
+      ret['ForceUpgradeRunning'] = @force_upgrade_running
+      ret['ApplyDeviceFilter'] = @apply_device_filter
+      ret['DeviceFilter'] = @device_filter
       ret['StartTime'] = @start_time
       ret['TargetVersion'] = @target_version
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/update_campaign_status.rb

@@ -26,6 +26,15 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # @type [Boolean] force_upgrade_running
+    attr_accessor :force_upgrade_running
+
+    # @type [Boolean] apply_device_filter
+    attr_accessor :apply_device_filter
+
+    # @type [Comet::SearchClause] device_filter
+    attr_accessor :device_filter
+
     # @type [Number] start_time
     attr_accessor :start_time
 
@@ -43,6 +52,7 @@ module Comet
     end
 
     def clear
+      @device_filter = Comet::SearchClause.new
       @start_time = 0
       @target_version = ''
       @devices = []
@@ -70,6 +80,13 @@ module Comet
           @reinstall_current_ver = v
         when 'DowngradeNewer'
           @downgrade_newer = v
+        when 'ForceUpgradeRunning'
+          @force_upgrade_running = v
+        when 'ApplyDeviceFilter'
+          @apply_device_filter = v
+        when 'DeviceFilter'
+          @device_filter = Comet::SearchClause.new
+          @device_filter.from_hash(v)
         when 'StartTime'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -101,6 +118,9 @@ module Comet
       ret['UpgradeOlder'] = @upgrade_older
       ret['ReinstallCurrentVer'] = @reinstall_current_ver
       ret['DowngradeNewer'] = @downgrade_newer
+      ret['ForceUpgradeRunning'] = @force_upgrade_running
+      ret['ApplyDeviceFilter'] = @apply_device_filter
+      ret['DeviceFilter'] = @device_filter
       ret['StartTime'] = @start_time
       ret['TargetVersion'] = @target_version
       ret['Devices'] = @devices

data/lib/comet/models/user_profile_config.rb

@@ -12,6 +12,7 @@ require 'json'
 module Comet
 
   # UserProfileConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  # This is the main data structure for a user's profile.
   class UserProfileConfig
 
     # @type [String] username
@@ -26,6 +27,7 @@ module Comet
     # @type [String] language_code
     attr_accessor :language_code
 
+    # Tenant
     # @type [String] organization_id
     attr_accessor :organization_id
 
@@ -38,9 +40,11 @@ module Comet
     # @type [Boolean] send_email_reports
     attr_accessor :send_email_reports
 
+    # Storage Vaults
     # @type [Hash{String => Comet::DestinationConfig}] destinations
     attr_accessor :destinations
 
+    # Protected Items
     # @type [Hash{String => Comet::SourceConfig}] sources
     attr_accessor :sources
 
@@ -62,12 +66,17 @@ module Comet
     # @type [Number] maximum_devices
     attr_accessor :maximum_devices
 
+    # If the PolicyID field is set to a non-empty string, the Comet Server will enforce the contents of
+    # the Policy field based on the matching server's policy. Otherwise if the PolicyID field is set to an
+    # empty string, the administrator may configure any custom values in the Policy field.
     # @type [String] policy_id
     attr_accessor :policy_id
 
     # @type [Comet::UserPolicy] policy
     attr_accessor :policy
 
+    # To change the user's password, use the AdminResetUserPassword API instead of accessing these fields
+    # directly. Otherwise, other encrypted fields in the user profile may become corrupted.
     # @type [Number] password_format
     attr_accessor :password_format
 

data/lib/comet/models/vmdksnapshot_view_options.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # VMDKSnapshotViewOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class VMDKSnapshotViewOptions
+
+    # @type [Boolean] enabled
+    attr_accessor :enabled
+
+    # @type [String] partition_guid
+    attr_accessor :partition_guid
+
+    # @type [String] list_path
+    attr_accessor :list_path
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @partition_guid = ''
+      @list_path = ''
+      @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 'Enabled'
+          @enabled = v
+        when 'PartitionGUID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @partition_guid = v
+        when 'ListPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @list_path = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Enabled'] = @enabled
+      ret['PartitionGUID'] = @partition_guid
+      ret['ListPath'] = @list_path
+      @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_backup_ruby_sdk.rb

@@ -50,6 +50,7 @@ require_relative 'comet/models/content_measurement'
 require_relative 'comet/models/content_measurement_component'
 require_relative 'comet/models/create_group_policy_response'
 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'
 require_relative 'comet/models/destination_config'
@@ -72,6 +73,7 @@ require_relative 'comet/models/get_group_policy_response'
 require_relative 'comet/models/get_profile_and_hash_response_message'
 require_relative 'comet/models/get_profile_hash_response_message'
 require_relative 'comet/models/group_policy'
+require_relative 'comet/models/hour_sched_config'
 require_relative 'comet/models/hyper_vmachine_info'
 require_relative 'comet/models/install_creds'
 require_relative 'comet/models/install_token'
@@ -152,6 +154,7 @@ require_relative 'comet/models/user_policy'
 require_relative 'comet/models/user_profile_config'
 require_relative 'comet/models/user_profile_fragment'
 require_relative 'comet/models/vault_snapshot'
+require_relative 'comet/models/vmdksnapshot_view_options'
 require_relative 'comet/models/vsscomponent'
 require_relative 'comet/models/vsswriter_info'
 require_relative 'comet/models/wasabi_virtual_storage_role_settings'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,7 @@ files:
 - lib/comet/models/admin_user_permissions.rb
 - lib/comet/models/admin_web_authn_registration.rb
 - lib/comet/models/allowed_admin_user.rb
+- lib/comet/models/amazon_awsvirtual_storage_role_settings.rb
 - lib/comet/models/available_download.rb
 - lib/comet/models/azure_destination_location.rb
 - lib/comet/models/b2destination_location.rb
@@ -126,6 +127,7 @@ files:
 - lib/comet/models/content_measurement_component.rb
 - lib/comet/models/create_group_policy_response.rb
 - lib/comet/models/custom_remote_bucket_settings.rb
+- lib/comet/models/days_of_week_config.rb
 - lib/comet/models/default_email_report_policy.rb
 - lib/comet/models/default_source_with_osrestriction.rb
 - lib/comet/models/destination_config.rb
@@ -148,6 +150,7 @@ files:
 - lib/comet/models/get_profile_and_hash_response_message.rb
 - lib/comet/models/get_profile_hash_response_message.rb
 - lib/comet/models/group_policy.rb
+- lib/comet/models/hour_sched_config.rb
 - lib/comet/models/hyper_vmachine_info.rb
 - lib/comet/models/install_creds.rb
 - lib/comet/models/install_token.rb
@@ -184,6 +187,7 @@ files:
 - lib/comet/models/retention_policy.rb
 - lib/comet/models/retention_range.rb
 - lib/comet/models/s3destination_location.rb
+- lib/comet/models/s3generic_virtual_storage_role.rb
 - lib/comet/models/schedule_config.rb
 - lib/comet/models/search_clause.rb
 - lib/comet/models/self_backup_statistics.rb
@@ -228,6 +232,7 @@ files:
 - lib/comet/models/user_profile_config.rb
 - lib/comet/models/user_profile_fragment.rb
 - lib/comet/models/vault_snapshot.rb
+- lib/comet/models/vmdksnapshot_view_options.rb
 - lib/comet/models/vsscomponent.rb
 - lib/comet/models/vsswriter_info.rb
 - lib/comet/models/wasabi_virtual_storage_role_settings.rb