comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/u2fregistration_challenge_response.rb

@@ -0,0 +1,133 @@
+#!/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
+
+  # U2FRegistrationChallengeResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # @deprecated This type has been deprecated since Comet version 21.12.0
+  class U2FRegistrationChallengeResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [String] challenge_id
+    attr_accessor :challenge_id
+
+    # @type [String] app_id
+    attr_accessor :app_id
+
+    # @type [Array<Comet::U2FRegisteredKey>] registered_keys
+    attr_accessor :registered_keys
+
+    # @type [Array<Comet::U2FRegisterRequest>] register_requests
+    attr_accessor :register_requests
+
+    # @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 = ''
+      @challenge_id = ''
+      @app_id = ''
+      @registered_keys = []
+      @register_requests = []
+      @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 'ChallengeID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @challenge_id = v
+        when 'AppID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @app_id = v
+        when 'RegisteredKeys'
+          if v.nil?
+            @registered_keys = []
+          else
+            @registered_keys = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @registered_keys[i1] = Comet::U2FRegisteredKey.new
+              @registered_keys[i1].from_hash(v1)
+            end
+          end
+        when 'RegisterRequests'
+          if v.nil?
+            @register_requests = []
+          else
+            @register_requests = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @register_requests[i1] = Comet::U2FRegisterRequest.new
+              @register_requests[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['ChallengeID'] = @challenge_id
+      ret['AppID'] = @app_id
+      ret['RegisteredKeys'] = @registered_keys
+      ret['RegisterRequests'] = @register_requests
+      @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/models/u2fsign_request.rb

@@ -0,0 +1,109 @@
+#!/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
+
+  # U2FSignRequest is a typed class wrapper around the underlying Comet Server API data structure.
+  # @deprecated This type has been deprecated since Comet version 21.12.0
+  class U2FSignRequest
+
+    # @type [String] challenge_id
+    attr_accessor :challenge_id
+
+    # @type [String] challenge_data
+    attr_accessor :challenge_data
+
+    # @type [String] app_id
+    attr_accessor :app_id
+
+    # @type [Array<Comet::U2FRegisteredKey>] registered_keys
+    attr_accessor :registered_keys
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @challenge_id = ''
+      @challenge_data = ''
+      @app_id = ''
+      @registered_keys = []
+      @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 'ChallengeID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @challenge_id = v
+        when 'ChallengeData'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @challenge_data = v
+        when 'AppID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @app_id = v
+        when 'RegisteredKeys'
+          if v.nil?
+            @registered_keys = []
+          else
+            @registered_keys = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @registered_keys[i1] = Comet::U2FRegisteredKey.new
+              @registered_keys[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['ChallengeID'] = @challenge_id
+      ret['ChallengeData'] = @challenge_data
+      ret['AppID'] = @app_id
+      ret['RegisteredKeys'] = @registered_keys
+      @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/models/u2fsign_response.rb

@@ -0,0 +1,103 @@
+#!/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
+
+  # U2FSignResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # @deprecated This type has been deprecated since Comet version 21.12.0
+  class U2FSignResponse
+
+    # @type [String] challenge_id
+    attr_accessor :challenge_id
+
+    # @type [String] key_handle
+    attr_accessor :key_handle
+
+    # @type [String] signature
+    attr_accessor :signature
+
+    # @type [String] client_data
+    attr_accessor :client_data
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @challenge_id = ''
+      @key_handle = ''
+      @signature = ''
+      @client_data = ''
+      @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 'ChallengeID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @challenge_id = v
+        when 'KeyHandle'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @key_handle = v
+        when 'Signature'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @signature = v
+        when 'ClientData'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @client_data = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ChallengeID'] = @challenge_id
+      ret['KeyHandle'] = @key_handle
+      ret['Signature'] = @signature
+      ret['ClientData'] = @client_data
+      @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/models/uninstall_config.rb

@@ -0,0 +1,78 @@
+#!/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
+
+  # UninstallConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class UninstallConfig
+
+    # @type [Boolean] uninstall_flag
+    attr_accessor :uninstall_flag
+
+    # @type [Boolean] remove_config_file
+    attr_accessor :remove_config_file
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @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 'UninstallFlag'
+          @uninstall_flag = v
+        when 'RemoveConfigFile'
+          @remove_config_file = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['UninstallFlag'] = @uninstall_flag
+      ret['RemoveConfigFile'] = @remove_config_file
+      @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/models/update_campaign_device_status.rb

@@ -0,0 +1,75 @@
+#!/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
+
+  # UpdateCampaignDeviceStatus is a typed class wrapper around the underlying Comet Server API data structure.
+  class UpdateCampaignDeviceStatus
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @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
+      @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
+        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
+      @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/models/update_campaign_options.rb

@@ -0,0 +1,113 @@
+#!/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
+
+  # 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
+    attr_accessor :active
+
+    # @type [Boolean] upgrade_older
+    attr_accessor :upgrade_older
+
+    # @type [Boolean] reinstall_current_ver
+    attr_accessor :reinstall_current_ver
+
+    # @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
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @device_filter = Comet::SearchClause.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 'Active'
+          @active = v
+        when 'UpgradeOlder'
+          @upgrade_older = v
+        when 'ReinstallCurrentVer'
+          @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
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Active'] = @active
+      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
+      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