comet_backup_ruby_sdk 1.10.0 → 1.13.0

data/lib/comet/models/update_campaign_options.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -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

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -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

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -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/update_campaign_status_device_entry.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/user_custom_email_settings.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/user_on_server.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/user_policy.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/user_profile_config.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -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/user_profile_fragment.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/vault_snapshot.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

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/models/vsscomponent.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/vsswriter_info.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/wasabi_virtual_storage_role_settings.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/web_authn_authenticator_selection.rb

@@ -0,0 +1,96 @@
+#!/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
+
+  # WebAuthnAuthenticatorSelection is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnAuthenticatorSelection
+
+    # @type [String] authenticator_attachment
+    attr_accessor :authenticator_attachment
+
+    # @type [Boolean] require_resident_key
+    attr_accessor :require_resident_key
+
+    # @type [String] user_verification
+    attr_accessor :user_verification
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @authenticator_attachment = ''
+      @user_verification = ''
+      @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 'authenticatorAttachment'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @authenticator_attachment = v
+        when 'requireResidentKey'
+          @require_resident_key = v
+        when 'userVerification'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @user_verification = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @authenticator_attachment.nil?
+        ret['authenticatorAttachment'] = @authenticator_attachment
+      end
+      unless @require_resident_key.nil?
+        ret['requireResidentKey'] = @require_resident_key
+      end
+      unless @user_verification.nil?
+        ret['userVerification'] = @user_verification
+      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/web_authn_credential.rb

@@ -0,0 +1,105 @@
+#!/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 'base64'
+require 'json'
+
+module Comet
+
+  # WebAuthnCredential is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnCredential
+
+    # @type [Array<Object>] public_key
+    attr_accessor :public_key
+
+    # @type [String] attestation_type
+    attr_accessor :attestation_type
+
+    # @type [Array<Object>] aaguid
+    attr_accessor :aaguid
+
+    # @type [Number] sign_count
+    attr_accessor :sign_count
+
+    # @type [Boolean] clone_warning
+    attr_accessor :clone_warning
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @public_key = []
+      @attestation_type = ''
+      @aaguid = []
+      @sign_count = 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 'PublicKey'
+          @public_key = Base64.decode64(v)
+        when 'AttestationType'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @attestation_type = v
+        when 'AAGUID'
+          @aaguid = Base64.decode64(v)
+        when 'SignCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @sign_count = v
+        when 'CloneWarning'
+          @clone_warning = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['PublicKey'] = Base64.strict_encode64(@public_key)
+      ret['AttestationType'] = @attestation_type
+      ret['AAGUID'] = Base64.strict_encode64(@aaguid)
+      ret['SignCount'] = @sign_count
+      ret['CloneWarning'] = @clone_warning
+      @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/web_authn_credential_assertion.rb

@@ -0,0 +1,74 @@
+#!/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
+
+  # WebAuthnCredentialAssertion is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnCredentialAssertion
+
+    # @type [Comet::WebAuthnPublicKeyCredentialRequestOptions] response
+    attr_accessor :response
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @response = Comet::WebAuthnPublicKeyCredentialRequestOptions.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 'publicKey'
+          @response = Comet::WebAuthnPublicKeyCredentialRequestOptions.new
+          @response.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['publicKey'] = @response
+      @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