comet_backup_ruby_sdk 1.13.0 → 1.14.0

data/lib/models/install_creds.rb

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

@@ -0,0 +1,117 @@
+#!/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
+
+  # InstallToken is a typed class wrapper around the underlying Comet Server API data structure.
+  class InstallToken
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] server
+    attr_accessor :server
+
+    # @type [String] token
+    attr_accessor :token
+
+    # @type [Number] create_time
+    attr_accessor :create_time
+
+    # @type [Boolean] used
+    attr_accessor :used
+
+    # @type [Number] expire_time
+    attr_accessor :expire_time
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @username = ''
+      @server = ''
+      @token = ''
+      @create_time = 0
+      @expire_time = 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 'Username'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @username = v
+        when 'Server'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @server = v
+        when 'Token'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @token = v
+        when 'CreateTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @create_time = v
+        when 'Used'
+          @used = v
+        when 'ExpireTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @expire_time = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Username'] = @username
+      ret['Server'] = @server
+      ret['Token'] = @token
+      ret['CreateTime'] = @create_time
+      ret['Used'] = @used
+      ret['ExpireTime'] = @expire_time
+      @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/install_token_response.rb

@@ -0,0 +1,92 @@
+#!/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
+
+  # InstallTokenResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class InstallTokenResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Comet::InstallToken] install_token
+    attr_accessor :install_token
+
+    # @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 = ''
+      @install_token = Comet::InstallToken.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 '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 'InstallToken'
+          @install_token = Comet::InstallToken.new
+          @install_token.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['Status'] = @status
+      ret['Message'] = @message
+      ret['InstallToken'] = @install_token
+      @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/job_entry.rb

@@ -0,0 +1,94 @@
+#!/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
+
+  # JobEntry is a typed class wrapper around the underlying Comet Server API data structure.
+  # JobEntry is a single entry within a job report.
+  class JobEntry
+
+    # @type [Number] time
+    attr_accessor :time
+
+    # @type [String] severity
+    attr_accessor :severity
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @time = 0
+      @severity = ''
+      @message = ''
+      @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 'Time'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @time = v
+        when 'Severity'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @severity = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Time'] = @time
+      ret['Severity'] = @severity
+      ret['Message'] = @message
+      @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/live_user_connection.rb

@@ -0,0 +1,149 @@
+#!/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
+
+  # LiveUserConnection is a typed class wrapper around the underlying Comet Server API data structure.
+  class LiveUserConnection
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] device_id
+    attr_accessor :device_id
+
+    # @type [String] reported_version
+    attr_accessor :reported_version
+
+    # @type [String] reported_platform
+    attr_accessor :reported_platform
+
+    # @type [Comet::OSInfo] reported_platform_version
+    attr_accessor :reported_platform_version
+
+    # @type [String] device_time_zone
+    attr_accessor :device_time_zone
+
+    # @type [String] ipaddress
+    attr_accessor :ipaddress
+
+    # @type [Number] connection_time
+    attr_accessor :connection_time
+
+    # @type [Boolean] allows_filenames
+    attr_accessor :allows_filenames
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @username = ''
+      @device_id = ''
+      @reported_version = ''
+      @reported_platform = ''
+      @reported_platform_version = Comet::OSInfo.new
+      @device_time_zone = ''
+      @ipaddress = ''
+      @connection_time = 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 'Username'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @username = v
+        when 'DeviceID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_id = v
+        when 'ReportedVersion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @reported_version = v
+        when 'ReportedPlatform'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @reported_platform = v
+        when 'ReportedPlatformVersion'
+          @reported_platform_version = Comet::OSInfo.new
+          @reported_platform_version.from_hash(v)
+        when 'DeviceTimeZone'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_time_zone = v
+        when 'IPAddress'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @ipaddress = v
+        when 'ConnectionTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @connection_time = v
+        when 'AllowsFilenames'
+          @allows_filenames = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Username'] = @username
+      ret['DeviceID'] = @device_id
+      ret['ReportedVersion'] = @reported_version
+      ret['ReportedPlatform'] = @reported_platform
+      unless @reported_platform_version.nil?
+        ret['ReportedPlatformVersion'] = @reported_platform_version
+      end
+      unless @device_time_zone.nil?
+        ret['DeviceTimeZone'] = @device_time_zone
+      end
+      unless @ipaddress.nil?
+        ret['IPAddress'] = @ipaddress
+      end
+      ret['ConnectionTime'] = @connection_time
+      ret['AllowsFilenames'] = @allows_filenames
+      @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/local_destination_location.rb

@@ -0,0 +1,102 @@
+#!/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
+
+  # LocalDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  class LocalDestinationLocation
+
+    # @type [String] localcopy_path
+    attr_accessor :localcopy_path
+
+    # @type [String] localcopy_win_smbusername
+    attr_accessor :localcopy_win_smbusername
+
+    # @type [String] localcopy_win_smbpassword
+    attr_accessor :localcopy_win_smbpassword
+
+    # @type [Number] localcopy_win_smbpassword_format
+    attr_accessor :localcopy_win_smbpassword_format
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @localcopy_path = ''
+      @localcopy_win_smbusername = ''
+      @localcopy_win_smbpassword = ''
+      @localcopy_win_smbpassword_format = 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 'LocalcopyPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @localcopy_path = v
+        when 'LocalcopyWinSMBUsername'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @localcopy_win_smbusername = v
+        when 'LocalcopyWinSMBPassword'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @localcopy_win_smbpassword = v
+        when 'LocalcopyWinSMBPasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @localcopy_win_smbpassword_format = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['LocalcopyPath'] = @localcopy_path
+      ret['LocalcopyWinSMBUsername'] = @localcopy_win_smbusername
+      ret['LocalcopyWinSMBPassword'] = @localcopy_win_smbpassword
+      ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
+      @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