comet_backup_ruby_sdk 2.8.0 → 2.10.0

data/lib/comet/models/device_config.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] friendly_name
     attr_accessor :friendly_name
 
+    # Unix timestamp in seconds
     # @type [Number] registration_time
     attr_accessor :registration_time
 
@@ -31,6 +32,10 @@ module Comet
     # @type [String] device_timezone
     attr_accessor :device_timezone
 
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] client_version
+    attr_accessor :client_version
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -44,6 +49,7 @@ module Comet
       @platform_version = Comet::OSInfo.new
       @sources = {}
       @device_timezone = ''
+      @client_version = ''
       @unknown_json_fields = {}
     end
 
@@ -85,6 +91,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @device_timezone = v
+        when 'ClientVersion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @client_version = v
         else
           @unknown_json_fields[k] = v
         end
@@ -107,6 +117,9 @@ module Comet
       unless @device_timezone.nil?
         ret['DeviceTimezone'] = @device_timezone
       end
+      unless @client_version.nil?
+        ret['ClientVersion'] = @client_version
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/email_reporting_option.rb

@@ -15,9 +15,11 @@ module Comet
     # @type [Comet::EmailReportConfig] email_report_config
     attr_accessor :email_report_config
 
+    # A supported language code (e.g. "en_US" or the DEFAULT_LANGUAGE constant)
     # @type [String] language_code
     attr_accessor :language_code
 
+    # The timezone in IANA format (e.g. "Pacific/Auckland" or the DEFAULT_TIMEZONE constant)
     # @type [String] local_timezone
     attr_accessor :local_timezone
 

data/lib/comet/models/external_ldapauthentication_source_server.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Number] port
     attr_accessor :port
 
+    # One of the LDAPSECURITYMETHOD_ constants (e.g. "plain" / "ldaps" / "starttls")
     # @type [String] security_method
     attr_accessor :security_method
 

data/lib/comet/models/external_ldapauthentication_source_settings.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Number] port
     attr_accessor :port
 
+    # One of the LDAPSECURITYMETHOD_ constants (e.g. "plain" / "ldaps" / "starttls")
     # @type [String] security_method
     attr_accessor :security_method
 

data/lib/comet/models/file_option.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2023 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # FileOption is a typed class wrapper around the underlying Comet Server API data structure.
+  # FileOption defines the configuration for Comet Server to log live events to a file. See the SEVT_
+# constants for more information.
+  # This type is available in Comet 23.3.7 and later.
+  class FileOption
+
+    # The prefix for the log filename. It will be stored in the same file location as the Comet Server
+    # log files
+    # @type [String] filename
+    attr_accessor :filename
+
+    # Configure a subset of allowed event types (see SEVT_ constants). If the array is empty, all events
+    # will be sent
+    # @type [Array<Number>] allow_event_types
+    attr_accessor :allow_event_types
+
+    # One of the STREAM_LEVEL_ constants. This controls how much data is logged into the file
+    # @type [String] level
+    attr_accessor :level
+
+    # Enables pruning of log files
+    # @type [Boolean] pruning_enabled
+    attr_accessor :pruning_enabled
+
+    # Limit in days to keep log files when PruningEnabled is set to true. If not set or 0, uses server's
+    # PruneLogsAfterDays
+    # @type [Number] pruning_limit
+    attr_accessor :pruning_limit
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @filename = ''
+      @allow_event_types = []
+      @level = ''
+      @pruning_limit = 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 'Filename'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @filename = v
+        when 'AllowEventTypes'
+          if v.nil?
+            @allow_event_types = []
+          else
+            @allow_event_types = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @allow_event_types[i1] = v1
+            end
+          end
+        when 'Level'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @level = v
+        when 'PruningEnabled'
+          @pruning_enabled = v
+        when 'PruningLimit'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @pruning_limit = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Filename'] = @filename
+      unless @allow_event_types.nil?
+        ret['AllowEventTypes'] = @allow_event_types
+      end
+      unless @level.nil?
+        ret['Level'] = @level
+      end
+      unless @pruning_enabled.nil?
+        ret['PruningEnabled'] = @pruning_enabled
+      end
+      unless @pruning_limit.nil?
+        ret['PruningLimit'] = @pruning_limit
+      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/ftpdestination_location.rb

@@ -21,19 +21,23 @@ module Comet
     # @type [String] ftppassword
     attr_accessor :ftppassword
 
+    # If true, store data in the default home directory given by the FTP server. If false, store data in
+    # the FTPCustomBaseDirectory path.
     # @type [Boolean] ftpbase_use_home_directory
     attr_accessor :ftpbase_use_home_directory
 
+    # If FTPBaseUseHomeDirectory is false, this field controls the path where data is stored.
     # @type [String] ftpcustom_base_directory
     attr_accessor :ftpcustom_base_directory
 
-    # One of the FTPS_MODE_ constants.
+    # Control whether this is plaintext FTP or secure FTPS by using one of the FTPS_MODE_ constants.
     # @type [Number] ftpsmode
     attr_accessor :ftpsmode
 
     # @type [Number] ftpport
     attr_accessor :ftpport
 
+    # If set to zero, uses a system default value that is not unlimited.
     # @type [Number] ftpmax_connections
     attr_accessor :ftpmax_connections
 

data/lib/comet/models/install_token.rb

@@ -15,18 +15,23 @@ module Comet
     # @type [String] username
     attr_accessor :username
 
+    # The URL of the Comet Server (Auth Role) for the target user to log in to.
     # @type [String] server
     attr_accessor :server
 
+    # The token for use with the "/TOKEN=" silent install flag.
     # @type [String] token
     attr_accessor :token
 
+    # Unix timestamp, in seconds.
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # If the token has been used, it cannot be used again.
     # @type [Boolean] used
     attr_accessor :used
 
+    # Unix timestamp, in seconds.
     # @type [Number] expire_time
     attr_accessor :expire_time
 

data/lib/comet/models/local_destination_location.rb

@@ -15,12 +15,17 @@ module Comet
     # @type [String] localcopy_path
     attr_accessor :localcopy_path
 
+    # If logging in to a Windows network share (SMB/CIFS) is required, enter the username here.
     # @type [String] localcopy_win_smbusername
     attr_accessor :localcopy_win_smbusername
 
+    # If logging in to a Windows network share (SMB/CIFS) is required, enter the password here. The
+    # password may be hashed as per the LocalcopyWinSMBPasswordFormat field.
     # @type [String] localcopy_win_smbpassword
     attr_accessor :localcopy_win_smbpassword
 
+    # One of the PASSWORD_FORMAT_ constants. It controls the hash format of the LocalcopyWinSMBPassword
+    # field.
     # @type [Number] localcopy_win_smbpassword_format
     attr_accessor :localcopy_win_smbpassword_format
 

data/lib/comet/models/mac_oscode_sign_properties.rb

@@ -12,6 +12,7 @@ module Comet
   # MacOSCodeSignProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class MacOSCodeSignProperties
 
+    # One of the MACOSCODESIGN_LEVEL_ constants
     # @type [Number] level
     attr_accessor :level
 
@@ -21,9 +22,13 @@ module Comet
     # @type [Comet::SSHConnection] sshserver
     attr_accessor :sshserver
 
+    # "Developer ID Installer" certificate, either a local filepath or a resource:// URI. Used for
+    # signing the final flat *.pkg.
     # @type [String] certificate_name
     attr_accessor :certificate_name
 
+    # "Developer ID Application" certificate, either a local filepath or a resource:// URI. Used for
+    # signing internal binaries if Notary is enabled
     # @type [String] app_certificate_name
     attr_accessor :app_certificate_name
 
@@ -33,6 +38,7 @@ module Comet
     # @type [String] apple_idpass
     attr_accessor :apple_idpass
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] apple_idpass_format
     attr_accessor :apple_idpass_format
 
@@ -45,6 +51,7 @@ module Comet
     # @type [String] pfx_file_password
     attr_accessor :pfx_file_password
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] pfx_file_password_format
     attr_accessor :pfx_file_password_format
 

data/lib/comet/models/mssqlconnection.rb

@@ -12,6 +12,7 @@ module Comet
   # MSSQLConnection is a typed class wrapper around the underlying Comet Server API data structure.
   class MSSQLConnection
 
+    # One of the MSSQL_AUTH_ constants (e.g. "windows" or "native")
     # @type [String] type
     attr_accessor :type
 
@@ -22,11 +23,13 @@ module Comet
     attr_accessor :password
 
     # @type [String] hostname
+    # @deprecated This member has been deprecated since Comet version Unused
     attr_accessor :hostname
 
     # @type [String] instance_name
     attr_accessor :instance_name
 
+    # One of the MSSQL_METHOD_ constants, to control using x86_32 or x86_64 OLEDB drivers
     # @type [String] method
     attr_accessor :method
 

data/lib/comet/models/mssqllogin_args.rb

@@ -27,6 +27,8 @@ module Comet
     # @type [Boolean] method_is_oledb_32bit
     attr_accessor :method_is_oledb_32bit
 
+    # If this MSSQLLoginArgs structure is used for a restore job (RestoreJobAdvancedOptions) using
+    # RESTORETYPE_MSSQL, then, this field controls the RECOVERY / NO RECOVERY option state.
     # @type [Boolean] restore_no_recovery
     attr_accessor :restore_no_recovery
 

data/lib/comet/models/my_sqlconnection.rb

@@ -18,9 +18,11 @@ module Comet
     # @type [String] port
     attr_accessor :port
 
+    # Optional
     # @type [String] username
     attr_accessor :username
 
+    # Optional
     # @type [String] password
     attr_accessor :password
 

data/lib/comet/models/news_entry.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # Unix timestamp, in seconds.
     # @type [Number] date_time
     attr_accessor :date_time
 

data/lib/comet/models/office_365custom_setting.rb

@@ -10,6 +10,9 @@ require 'json'
 module Comet
 
   # Office365CustomSetting is a typed class wrapper around the underlying Comet Server API data structure.
+  # Office365CustomSetting is used in the EngineProps for an Office 365 Protected Item (see
+# ENGINE_BUILTIN_MSOFFICE).
+# If present, it will be automatically converted to the replacement Office365CustomSettingV2 type.
   # @deprecated This type has been deprecated since Comet version 21.9.xx
   class Office365CustomSetting
 

data/lib/comet/models/office_365custom_setting_v2.rb

@@ -10,14 +10,23 @@ require 'json'
 module Comet
 
   # Office365CustomSettingV2 is a typed class wrapper around the underlying Comet Server API data structure.
+  # Office365CustomSettingV2 is used in the EngineProps for an Office 365 Protected Item (see
+# ENGINE_BUILTIN_MSOFFICE).
+  # This type is available in Comet 21.9.xx and later.
   class Office365CustomSettingV2
 
+    # If true, then backup the entire Office 365 Tenant except the selected members. If false, backup
+    # the selected members only.
     # @type [Boolean] organization
     attr_accessor :organization
 
+    # Key can be the ID of user, group or SharePoint
+    # Value is a bitset of the SERVICE_ constants, to select which services to back up for this member.
     # @type [Hash{String => Number}] backup_options
     attr_accessor :backup_options
 
+    # Key must be a group ID
+    # Value is a bitset of the SERVICE_ constants, to select which services to back up for this member.
     # @type [Hash{String => Number}] member_backup_options
     attr_accessor :member_backup_options
 

data/lib/comet/models/organization.rb

@@ -12,38 +12,41 @@ module Comet
   # Organization is a typed class wrapper around the underlying Comet Server API data structure.
   class Organization
 
-    # @type [String] name
-    attr_accessor :name
-
-    # @type [Array<String>] hosts
-    attr_accessor :hosts
-
-    # @type [Comet::SoftwareBuildRoleOptions] software_build_role
-    attr_accessor :software_build_role
+    # @type [Hash{String => Comet::FileOption}] audit_file_options
+    attr_accessor :audit_file_options
 
     # @type [Comet::BrandingOptions] branding
     attr_accessor :branding
 
-    # @type [Array<Comet::RemoteStorageOption>] remote_storage
-    attr_accessor :remote_storage
-
     # @type [Comet::ConstellationRoleOptions] constellation_role
     attr_accessor :constellation_role
 
-    # @type [Hash{String => Comet::WebhookOption}] webhook_options
-    attr_accessor :webhook_options
-
-    # @type [Array<Comet::PSAConfig>] psaconfigs
-    attr_accessor :psaconfigs
-
     # @type [Comet::EmailOptions] email
     attr_accessor :email
 
+    # @type [Array<String>] experimental_options
+    attr_accessor :experimental_options
+
+    # @type [Array<String>] hosts
+    attr_accessor :hosts
+
+    # @type [String] name
+    attr_accessor :name
+
     # @type [Boolean] is_suspended
     attr_accessor :is_suspended
 
-    # @type [Array<String>] experimental_options
-    attr_accessor :experimental_options
+    # @type [Array<Comet::PSAConfig>] psaconfigs
+    attr_accessor :psaconfigs
+
+    # @type [Array<Comet::RemoteStorageOption>] remote_storage
+    attr_accessor :remote_storage
+
+    # @type [Comet::SoftwareBuildRoleOptions] software_build_role
+    attr_accessor :software_build_role
+
+    # @type [Hash{String => Comet::WebhookOption}] webhook_options
+    attr_accessor :webhook_options
 
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
@@ -53,16 +56,17 @@ module Comet
     end
 
     def clear
-      @name = ''
-      @hosts = []
-      @software_build_role = Comet::SoftwareBuildRoleOptions.new
+      @audit_file_options = {}
       @branding = Comet::BrandingOptions.new
-      @remote_storage = []
       @constellation_role = Comet::ConstellationRoleOptions.new
-      @webhook_options = {}
-      @psaconfigs = []
       @email = Comet::EmailOptions.new
       @experimental_options = []
+      @hosts = []
+      @name = ''
+      @psaconfigs = []
+      @remote_storage = []
+      @software_build_role = Comet::SoftwareBuildRoleOptions.new
+      @webhook_options = {}
       @unknown_json_fields = {}
     end
 
@@ -79,10 +83,36 @@ module Comet
 
       obj.each do |k, v|
         case k
-        when 'Name'
-          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+        when 'AuditFileOptions'
+          @audit_file_options = {}
+          if v.nil?
+            @audit_file_options = {}
+          else
+            v.each do |k1, v1|
+              @audit_file_options[k1] = Comet::FileOption.new
+              @audit_file_options[k1].from_hash(v1)
+            end
+          end
+        when 'Branding'
+          @branding = Comet::BrandingOptions.new
+          @branding.from_hash(v)
+        when 'ConstellationRole'
+          @constellation_role = Comet::ConstellationRoleOptions.new
+          @constellation_role.from_hash(v)
+        when 'Email'
+          @email = Comet::EmailOptions.new
+          @email.from_hash(v)
+        when 'ExperimentalOptions'
+          if v.nil?
+            @experimental_options = []
+          else
+            @experimental_options = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
 
-          @name = v
+              @experimental_options[i1] = v1
+            end
+          end
         when 'Hosts'
           if v.nil?
             @hosts = []
@@ -94,12 +124,22 @@ module Comet
               @hosts[i1] = v1
             end
           end
-        when 'SoftwareBuildRole'
-          @software_build_role = Comet::SoftwareBuildRoleOptions.new
-          @software_build_role.from_hash(v)
-        when 'Branding'
-          @branding = Comet::BrandingOptions.new
-          @branding.from_hash(v)
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'IsSuspended'
+          @is_suspended = v
+        when 'PSAConfigs'
+          if v.nil?
+            @psaconfigs = []
+          else
+            @psaconfigs = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @psaconfigs[i1] = Comet::PSAConfig.new
+              @psaconfigs[i1].from_hash(v1)
+            end
+          end
         when 'RemoteStorage'
           if v.nil?
             @remote_storage = []
@@ -110,9 +150,9 @@ module Comet
               @remote_storage[i1].from_hash(v1)
             end
           end
-        when 'ConstellationRole'
-          @constellation_role = Comet::ConstellationRoleOptions.new
-          @constellation_role.from_hash(v)
+        when 'SoftwareBuildRole'
+          @software_build_role = Comet::SoftwareBuildRoleOptions.new
+          @software_build_role.from_hash(v)
         when 'WebhookOptions'
           @webhook_options = {}
           if v.nil?
@@ -123,32 +163,6 @@ module Comet
               @webhook_options[k1].from_hash(v1)
             end
           end
-        when 'PSAConfigs'
-          if v.nil?
-            @psaconfigs = []
-          else
-            @psaconfigs = Array.new(v.length)
-            v.each_with_index do |v1, i1|
-              @psaconfigs[i1] = Comet::PSAConfig.new
-              @psaconfigs[i1].from_hash(v1)
-            end
-          end
-        when 'Email'
-          @email = Comet::EmailOptions.new
-          @email.from_hash(v)
-        when 'IsSuspended'
-          @is_suspended = v
-        when 'ExperimentalOptions'
-          if v.nil?
-            @experimental_options = []
-          else
-            @experimental_options = Array.new(v.length)
-            v.each_with_index do |v1, i1|
-              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
-
-              @experimental_options[i1] = v1
-            end
-          end
         else
           @unknown_json_fields[k] = v
         end
@@ -158,19 +172,20 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
-      ret['Name'] = @name
-      ret['Hosts'] = @hosts
-      ret['SoftwareBuildRole'] = @software_build_role
+      ret['AuditFileOptions'] = @audit_file_options
       ret['Branding'] = @branding
-      ret['RemoteStorage'] = @remote_storage
       ret['ConstellationRole'] = @constellation_role
-      ret['WebhookOptions'] = @webhook_options
-      ret['PSAConfigs'] = @psaconfigs
       ret['Email'] = @email
-      ret['IsSuspended'] = @is_suspended
       unless @experimental_options.nil?
         ret['ExperimentalOptions'] = @experimental_options
       end
+      ret['Hosts'] = @hosts
+      ret['Name'] = @name
+      ret['IsSuspended'] = @is_suspended
+      ret['PSAConfigs'] = @psaconfigs
+      ret['RemoteStorage'] = @remote_storage
+      ret['SoftwareBuildRole'] = @software_build_role
+      ret['WebhookOptions'] = @webhook_options
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end