comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/partition.rb

@@ -0,0 +1,172 @@
+#!/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
+
+  # Partition is a typed class wrapper around the underlying Comet Server API data structure.
+  class Partition
+
+    # @type [String] device_name
+    attr_accessor :device_name
+
+    # @type [String] filesystem
+    attr_accessor :filesystem
+
+    # @type [String] volume_name
+    attr_accessor :volume_name
+
+    # @type [String] volume_guid
+    attr_accessor :volume_guid
+
+    # @type [String] volume_serial
+    attr_accessor :volume_serial
+
+    # @type [Array<String>] mount_points
+    attr_accessor :mount_points
+
+    # @type [Number] read_offset
+    attr_accessor :read_offset
+
+    # @type [Number] size
+    attr_accessor :size
+
+    # @type [Number] used_size
+    attr_accessor :used_size
+
+    # @type [Number] flags
+    attr_accessor :flags
+
+    # @type [Number] bytes_per_filesystem_cluster
+    attr_accessor :bytes_per_filesystem_cluster
+
+    # @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_name = ''
+      @filesystem = ''
+      @volume_name = ''
+      @volume_guid = ''
+      @volume_serial = ''
+      @mount_points = []
+      @read_offset = 0
+      @size = 0
+      @used_size = 0
+      @flags = 0
+      @bytes_per_filesystem_cluster = 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 'DeviceName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_name = v
+        when 'Filesystem'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @filesystem = v
+        when 'VolumeName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @volume_name = v
+        when 'VolumeGuid'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @volume_guid = v
+        when 'VolumeSerial'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @volume_serial = v
+        when 'MountPoints'
+          if v.nil?
+            @mount_points = []
+          else
+            @mount_points = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @mount_points[i1] = v1
+            end
+          end
+        when 'ReadOffset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @read_offset = v
+        when 'Size'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @size = v
+        when 'UsedSize'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @used_size = v
+        when 'Flags'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @flags = v
+        when 'BytesPerFilesystemCluster'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @bytes_per_filesystem_cluster = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['DeviceName'] = @device_name
+      ret['Filesystem'] = @filesystem
+      ret['VolumeName'] = @volume_name
+      ret['VolumeGuid'] = @volume_guid
+      ret['VolumeSerial'] = @volume_serial
+      ret['MountPoints'] = @mount_points
+      ret['ReadOffset'] = @read_offset
+      ret['Size'] = @size
+      ret['UsedSize'] = @used_size
+      ret['Flags'] = @flags
+      ret['BytesPerFilesystemCluster'] = @bytes_per_filesystem_cluster
+      @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/private_branding_properties.rb

@@ -0,0 +1,227 @@
+#!/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
+
+  # PrivateBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
+  class PrivateBrandingProperties
+
+    # @type [String] path_ico_file
+    attr_accessor :path_ico_file
+
+    # @type [String] path_icns_file
+    attr_accessor :path_icns_file
+
+    # @type [String] path_menu_bar_icns_file
+    attr_accessor :path_menu_bar_icns_file
+
+    # @type [String] path_eula_rtf
+    attr_accessor :path_eula_rtf
+
+    # @type [String] path_tile_png
+    attr_accessor :path_tile_png
+
+    # @type [String] path_header_image
+    attr_accessor :path_header_image
+
+    # @type [String] path_app_icon_image
+    attr_accessor :path_app_icon_image
+
+    # @type [String] package_identifier
+    attr_accessor :package_identifier
+
+    # @type [String] windows_code_sign_pkcs12file_path
+    attr_accessor :windows_code_sign_pkcs12file_path
+
+    # @type [Number] windows_code_sign_pkcs12password_format
+    attr_accessor :windows_code_sign_pkcs12password_format
+
+    # @type [String] windows_code_sign_pkcs12password
+    attr_accessor :windows_code_sign_pkcs12password
+
+    # @type [String] windows_code_sign_pkcs11engine
+    attr_accessor :windows_code_sign_pkcs11engine
+
+    # @type [String] windows_code_sign_pkcs11module
+    attr_accessor :windows_code_sign_pkcs11module
+
+    # @type [String] windows_code_sign_pkcs11certfile
+    attr_accessor :windows_code_sign_pkcs11certfile
+
+    # @type [String] windows_code_sign_pkcs11key_id
+    attr_accessor :windows_code_sign_pkcs11key_id
+
+    # @type [Number] windows_code_sign_pkcs11password_format
+    attr_accessor :windows_code_sign_pkcs11password_format
+
+    # @type [String] windows_code_sign_pkcs11password
+    attr_accessor :windows_code_sign_pkcs11password
+
+    # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
+    attr_accessor :mac_oscode_sign
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @path_ico_file = ''
+      @path_icns_file = ''
+      @path_menu_bar_icns_file = ''
+      @path_eula_rtf = ''
+      @path_tile_png = ''
+      @path_header_image = ''
+      @path_app_icon_image = ''
+      @package_identifier = ''
+      @windows_code_sign_pkcs12file_path = ''
+      @windows_code_sign_pkcs12password_format = 0
+      @windows_code_sign_pkcs12password = ''
+      @windows_code_sign_pkcs11engine = ''
+      @windows_code_sign_pkcs11module = ''
+      @windows_code_sign_pkcs11certfile = ''
+      @windows_code_sign_pkcs11key_id = ''
+      @windows_code_sign_pkcs11password_format = 0
+      @windows_code_sign_pkcs11password = ''
+      @mac_oscode_sign = Comet::MacOSCodeSignProperties.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 'PathIcoFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_ico_file = v
+        when 'PathIcnsFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_icns_file = v
+        when 'PathMenuBarIcnsFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_menu_bar_icns_file = v
+        when 'PathEulaRtf'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_eula_rtf = v
+        when 'PathTilePng'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_tile_png = v
+        when 'PathHeaderImage'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_header_image = v
+        when 'PathAppIconImage'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_app_icon_image = v
+        when 'PackageIdentifier'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @package_identifier = v
+        when 'WindowsCodeSignPKCS12FilePath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs12file_path = v
+        when 'WindowsCodeSignPKCS12PasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @windows_code_sign_pkcs12password_format = v
+        when 'WindowsCodeSignPKCS12Password'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs12password = v
+        when 'WindowsCodeSignPKCS11Engine'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs11engine = v
+        when 'WindowsCodeSignPKCS11Module'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs11module = v
+        when 'WindowsCodeSignPKCS11Certfile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs11certfile = v
+        when 'WindowsCodeSignPKCS11KeyID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs11key_id = v
+        when 'WindowsCodeSignPKCS11PasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @windows_code_sign_pkcs11password_format = v
+        when 'WindowsCodeSignPKCS11Password'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_pkcs11password = v
+        when 'MacOSCodeSign'
+          @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
+          @mac_oscode_sign.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['PathIcoFile'] = @path_ico_file
+      ret['PathIcnsFile'] = @path_icns_file
+      ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file
+      ret['PathEulaRtf'] = @path_eula_rtf
+      ret['PathTilePng'] = @path_tile_png
+      ret['PathHeaderImage'] = @path_header_image
+      ret['PathAppIconImage'] = @path_app_icon_image
+      ret['PackageIdentifier'] = @package_identifier
+      ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
+      ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
+      ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
+      ret['WindowsCodeSignPKCS11Engine'] = @windows_code_sign_pkcs11engine
+      ret['WindowsCodeSignPKCS11Module'] = @windows_code_sign_pkcs11module
+      ret['WindowsCodeSignPKCS11Certfile'] = @windows_code_sign_pkcs11certfile
+      ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
+      ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
+      ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
+      ret['MacOSCodeSign'] = @mac_oscode_sign
+      @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/protected_item_engine_type_policy.rb

@@ -0,0 +1,88 @@
+#!/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
+
+  # ProtectedItemEngineTypePolicy is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProtectedItemEngineTypePolicy
+
+    # @type [Boolean] should_restrict_engine_type_list
+    attr_accessor :should_restrict_engine_type_list
+
+    # @type [Array<String>] allowed_engine_type_when_restricted
+    attr_accessor :allowed_engine_type_when_restricted
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @allowed_engine_type_when_restricted = []
+      @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 'ShouldRestrictEngineTypeList'
+          @should_restrict_engine_type_list = v
+        when 'AllowedEngineTypeWhenRestricted'
+          if v.nil?
+            @allowed_engine_type_when_restricted = []
+          else
+            @allowed_engine_type_when_restricted = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @allowed_engine_type_when_restricted[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['ShouldRestrictEngineTypeList'] = @should_restrict_engine_type_list
+      ret['AllowedEngineTypeWhenRestricted'] = @allowed_engine_type_when_restricted
+      @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/public_branding_properties.rb

@@ -0,0 +1,132 @@
+#!/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
+
+  # PublicBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
+  class PublicBrandingProperties
+
+    # @type [String] product_name
+    attr_accessor :product_name
+
+    # @type [String] company_name
+    attr_accessor :company_name
+
+    # @type [String] help_url
+    attr_accessor :help_url
+
+    # @type [Boolean] help_is_popup
+    attr_accessor :help_is_popup
+
+    # @type [String] default_login_server_url
+    attr_accessor :default_login_server_url
+
+    # @type [String] tile_background_color
+    attr_accessor :tile_background_color
+
+    # @type [String] account_register_url
+    attr_accessor :account_register_url
+
+    # @type [Boolean] hide_background_logo
+    attr_accessor :hide_background_logo
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @product_name = ''
+      @company_name = ''
+      @help_url = ''
+      @default_login_server_url = ''
+      @tile_background_color = ''
+      @account_register_url = ''
+      @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 'ProductName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @product_name = v
+        when 'CompanyName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @company_name = v
+        when 'HelpURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @help_url = v
+        when 'HelpIsPopup'
+          @help_is_popup = v
+        when 'DefaultLoginServerURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @default_login_server_url = v
+        when 'TileBackgroundColor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tile_background_color = v
+        when 'AccountRegisterURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @account_register_url = v
+        when 'HideBackgroundLogo'
+          @hide_background_logo = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ProductName'] = @product_name
+      ret['CompanyName'] = @company_name
+      ret['HelpURL'] = @help_url
+      ret['HelpIsPopup'] = @help_is_popup
+      ret['DefaultLoginServerURL'] = @default_login_server_url
+      ret['TileBackgroundColor'] = @tile_background_color
+      ret['AccountRegisterURL'] = @account_register_url
+      ret['HideBackgroundLogo'] = @hide_background_logo
+      @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