comet_backup_ruby_sdk 2.8.0 → 2.9.0

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

data/lib/comet/models/restore_job_advanced_options.rb

@@ -12,6 +12,7 @@ module Comet
   # RestoreJobAdvancedOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class RestoreJobAdvancedOptions
 
+    # One of the RESTORETYPE_ constants
     # @type [Number] type
     attr_accessor :type
 

data/lib/comet/models/search_result_file_info.rb

@@ -10,29 +10,41 @@ require 'json'
 module Comet
 
   # SearchResultFileInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # SearchResultFileInfo describes a single result entry when searching for files within a Storage
+# Vault snapshot.
   class SearchResultFileInfo
 
+    # Path to the file within the selected snapshot, using forwardslash (/) separators
     # @type [String] path
     attr_accessor :path
 
+    # Filename
     # @type [String] name
     attr_accessor :name
 
+    # One of the STOREDOBJECTTYPE_ constants
     # @type [String] type
     attr_accessor :type
 
     # @type [String] mode
     attr_accessor :mode
 
-    # @type [String] mtime
-    attr_accessor :mtime
+    # Timestamp in RFC3339 format with subsecond precision and time zone offset. See the Golang
+    # time.RFC3339Nano for more information.
+    # @type [String] mod_time
+    attr_accessor :mod_time
 
-    # @type [String] atime
-    attr_accessor :atime
+    # Timestamp in RFC3339 format with subsecond precision and time zone offset. See the Golang
+    # time.RFC3339Nano for more information.
+    # @type [String] access_time
+    attr_accessor :access_time
 
-    # @type [String] ctime
-    attr_accessor :ctime
+    # Timestamp in RFC3339 format with subsecond precision and time zone offset. See the Golang
+    # time.RFC3339Nano for more information.
+    # @type [String] change_time
+    attr_accessor :change_time
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
@@ -48,9 +60,9 @@ module Comet
       @name = ''
       @type = ''
       @mode = ''
-      @mtime = ''
-      @atime = ''
-      @ctime = ''
+      @mod_time = ''
+      @access_time = ''
+      @change_time = ''
       @size = 0
       @unknown_json_fields = {}
     end
@@ -87,15 +99,15 @@ module Comet
         when 'mtime'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
-          @mtime = v
+          @mod_time = v
         when 'atime'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
-          @atime = v
+          @access_time = v
         when 'ctime'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
-          @ctime = v
+          @change_time = v
         when 'size'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -112,11 +124,21 @@ module Comet
       ret['path'] = @path
       ret['name'] = @name
       ret['type'] = @type
-      ret['mode'] = @mode
-      ret['mtime'] = @mtime
-      ret['atime'] = @atime
-      ret['ctime'] = @ctime
-      ret['size'] = @size
+      unless @mode.nil?
+        ret['mode'] = @mode
+      end
+      unless @mod_time.nil?
+        ret['mtime'] = @mod_time
+      end
+      unless @access_time.nil?
+        ret['atime'] = @access_time
+      end
+      unless @change_time.nil?
+        ret['ctime'] = @change_time
+      end
+      unless @size.nil?
+        ret['size'] = @size
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/self_backup_export_options.rb

@@ -21,9 +21,12 @@ module Comet
     # @type [Number] encryption_key_format
     attr_accessor :encryption_key_format
 
+    # One of the COMPRESS_LVL_ constants
     # @type [Number] compression
     attr_accessor :compression
 
+    # The jobs database is often the largest component of the Server Self-Backup archive. By excluding
+    # it, you could run the Server Self-Backup more often.
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 

data/lib/comet/models/self_backup_target.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [Array<Comet::ScheduleConfig>] schedule
     attr_accessor :schedule
 
+    # Timezone in IANA format
     # @type [String] schedule_timezone
     attr_accessor :schedule_timezone
 
@@ -30,9 +31,12 @@ module Comet
     # @type [Number] encryption_key_format
     attr_accessor :encryption_key_format
 
+    # One of the COMPRESS_LVL_ constants
     # @type [Number] compression
     attr_accessor :compression
 
+    # The jobs database is often the largest component of the Server Self-Backup archive. By excluding
+    # it, you could run the Server Self-Backup more often.
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 

data/lib/comet/models/server_config_options.rb

@@ -35,6 +35,7 @@ module Comet
     # @type [Comet::EmailOptions] email
     attr_accessor :email
 
+    # An array of GUIDs that can enable additional early-access functionality
     # @type [Array<String>] experimental_options
     attr_accessor :experimental_options
 
@@ -47,18 +48,22 @@ module Comet
     # @type [Comet::LicenseOptions] license
     attr_accessor :license
 
+    # Configure ip, port, and SSL settings for this self-hosted Comet Server.
     # @type [Array<Comet::HTTPConnectorOptions>] listen_addresses
     attr_accessor :listen_addresses
 
+    # Tenants
     # @type [Hash{String => Comet::Organization}] organizations
     attr_accessor :organizations
 
     # @type [Array<Comet::PSAConfig>] psaconfigs
     attr_accessor :psaconfigs
 
+    # Automatically create backup zip files of this Comet Server's configuration
     # @type [Comet::SelfBackupOptions] self_backup
     attr_accessor :self_backup
 
+    # Control how long admin accounts can remain logged in to the Comet Server web interface
     # @type [Comet::SessionOptions] session_settings
     attr_accessor :session_settings
 
@@ -68,12 +73,18 @@ module Comet
     # @type [Comet::StorageRoleOptions] storage_role
     attr_accessor :storage_role
 
+    # If true, the X-Forwarded-For header will be trusted for the purposes of IP allowlisting. This
+    # should only be enabled when you explicitly configure Comet Server behind a reverse proxy,
+    # otherwise it could allow malicious users to bypass the IP allowlist.
     # @type [Boolean] trust_xforwarded_for
     attr_accessor :trust_xforwarded_for
 
     # @type [Hash{String => Comet::WebhookOption}] webhook_options
     attr_accessor :webhook_options
 
+    # @type [Hash{String => Comet::FileOption}] audit_file_options
+    attr_accessor :audit_file_options
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -100,6 +111,7 @@ module Comet
       @software_build_role = Comet::SoftwareBuildRoleOptions.new
       @storage_role = Comet::StorageRoleOptions.new
       @webhook_options = {}
+      @audit_file_options = {}
       @unknown_json_fields = {}
     end
 
@@ -222,6 +234,16 @@ module Comet
               @webhook_options[k1].from_hash(v1)
             end
           end
+        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
         else
           @unknown_json_fields[k] = v
         end
@@ -254,6 +276,7 @@ module Comet
       ret['StorageRole'] = @storage_role
       ret['TrustXForwardedFor'] = @trust_xforwarded_for
       ret['WebhookOptions'] = @webhook_options
+      ret['AuditFileOptions'] = @audit_file_options
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/session_options.rb

@@ -12,6 +12,8 @@ module Comet
   # SessionOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class SessionOptions
 
+    # The number of seconds, after which an administrator should be automatically logged out of the
+    # Comet Server web interface. If zero, will be replaced with DEFAULT_SESSIONTIMEOUT.
     # @type [Number] expired_in_seconds
     attr_accessor :expired_in_seconds
 

data/lib/comet/models/sftpdestination_location.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] sftpusername
     attr_accessor :sftpusername
 
+    # The directory on the SFTP server in which data is stored.
     # @type [String] sftpremote_path
     attr_accessor :sftpremote_path
 
@@ -25,15 +26,21 @@ module Comet
     # @type [Number] sftpauth_mode
     attr_accessor :sftpauth_mode
 
+    # For use with DESTINATION_SFTP_AUTHMODE_PASSWORD only: the SSH password to connect with
     # @type [String] sftppassword
     attr_accessor :sftppassword
 
+    # For use with DESTINATION_SFTP_AUTHMODE_PRIVATEKEY only: the SSH private key to connect with, in
+    # OpenSSH format.
     # @type [String] sftpprivate_key
     attr_accessor :sftpprivate_key
 
+    # If true, then the SFTPCustomAuth_KnownHostsFile will be used to verify the remote SSH server's
+    # host key, using Trust On First Use (TOFU).
     # @type [Boolean] sftpcustom_auth__use_known_hosts_file
     attr_accessor :sftpcustom_auth__use_known_hosts_file
 
+    # If SFTPCustomAuth_UseKnownHostFile is true, the path to the SSH known_hosts file.
     # @type [String] sftpcustom_auth__known_hosts_file
     attr_accessor :sftpcustom_auth__known_hosts_file
 

data/lib/comet/models/size_measurement.rb

@@ -12,12 +12,15 @@ module Comet
   # SizeMeasurement is a typed class wrapper around the underlying Comet Server API data structure.
   class SizeMeasurement
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
+    # Unix timestamp in seconds
     # @type [Number] measure_started
     attr_accessor :measure_started
 
+    # Unix timestamp in seconds
     # @type [Number] measure_completed
     attr_accessor :measure_completed
 

data/lib/comet/models/source_basic_info.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Number] o365account_count
     attr_accessor :o365account_count
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 

data/lib/comet/models/source_config.rb

@@ -22,9 +22,11 @@ module Comet
     # @type [String] owner_device
     attr_accessor :owner_device
 
+    # Unix timestamp in seconds
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # Unix timestamp in seconds
     # @type [Number] modify_time
     attr_accessor :modify_time
 
@@ -48,10 +50,10 @@ module Comet
     # - Any key starting with INCLUDE: A path that is included
     # - Any key starting with EXCLUDE: An exclusion (glob format)
     # - Any key starting with REXCLUDE: An exclusion (regular expression format)
-    # - Any key starting with PINCLUDE: A JSON string {"TopDirectory": "", "Value": ""}. TopDirectory is
-    # the path where starts to match the value; Value is an inclusion (glob format)
-    # - Any key starting with RINCLUDE: A JSON string {"TopDirectory": "", "Value": ""}. TopDirectory is
-    # the path where starts to match the value; Value is an inclusion (regular expression format)
+    # - Any key starting with PINCLUDE: A SourceIncludePattern type encoded in JSON format, describing
+    # an advanced inclusion in glob format
+    # - Any key starting with RINCLUDE: A SourceIncludePattern type encoded in JSON format, describing
+    # an advanced inclusion in regular expression format
     # - Any key starting with SMBAUTH: A set of Windows network share credentials in WinSMBAuth JSON
     # format
     # - USE_WIN_VSS: If present, the 'Take filesystem snapshot' checkbox is checked

data/lib/comet/models/source_include_pattern.rb

@@ -10,11 +10,16 @@ require 'json'
 module Comet
 
   # SourceIncludePattern is a typed class wrapper around the underlying Comet Server API data structure.
+  # SourceIncludePattern is used for pattern inclusions for File and Folder Protected Items
+# (ENGINE_BUILTIN_FILE).
+# It should be marshalled as JSON and then stored in the PINCLUDE / RINCLUDE EngineProp keys.
   class SourceIncludePattern
 
+    # The filesystem path to search within, for matches
     # @type [String] top_directory
     attr_accessor :top_directory
 
+    # The pattern (glob or regex format) to match
     # @type [String] value
     attr_accessor :value
 

data/lib/comet/models/spanned_destination_location.rb

@@ -12,9 +12,20 @@ module Comet
   # SpannedDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
   class SpannedDestinationLocation
 
+    # A list of underlying destinations, that will be combined and presented as one.
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
 
+    # If true, this Spanned destination will use a consistent hashing scheme
+    # to immediately find specific files on exactly one of the target destinations.
+    # In the Static Slots mode, the span targets cannot be moved or merged, and
+    # the files must always remain in their original location.
+    #
+    # If false, the Spanned destination system will search all targets to find
+    # the requested file. This is slightly slower, but allows you to freely merge,
+    # split, and reorder the underlying destination locations.
+    #
+    # The default option is false.
     # @type [Boolean] span_use_static_slots
     attr_accessor :span_use_static_slots
 

data/lib/comet/models/sshconnection.rb

@@ -22,15 +22,21 @@ module Comet
     # @type [Number] sshauth_mode
     attr_accessor :sshauth_mode
 
+    # For use with SSHCONNECTION_AUTHMODE_PASSWORD only: the SSH password to connect with
     # @type [String] sshpassword
     attr_accessor :sshpassword
 
+    # For use with SSHCONNECTION_AUTHMODE_PRIVATEKEY only: the SSH private key to connect with, in
+    # OpenSSH format.
     # @type [String] sshprivate_key
     attr_accessor :sshprivate_key
 
+    # If true, then the SSHCustomAuth_KnownHostsFile will be used to verify the remote SSH server's host
+    # key, using Trust On First Use (TOFU).
     # @type [Boolean] sshcustom_auth__use_known_hosts_file
     attr_accessor :sshcustom_auth__use_known_hosts_file
 
+    # If SSHCustomAuth_UseKnownHostsFile is true, the path to the SSH known_hosts file.
     # @type [String] sshcustom_auth__known_hosts_file
     attr_accessor :sshcustom_auth__known_hosts_file
 

data/lib/comet/models/stored_object.rb

@@ -12,9 +12,11 @@ module Comet
   # StoredObject is a typed class wrapper around the underlying Comet Server API data structure.
   class StoredObject
 
+    # The name of the stored object. It is unique within this directory tree.
     # @type [String] name
     attr_accessor :name
 
+    # Unix timestamp in seconds
     # @type [Number] modify_time
     attr_accessor :modify_time
 
@@ -22,9 +24,12 @@ module Comet
     # @type [String] type
     attr_accessor :type
 
+    # If this StoredObject represents a directory, this value can be used to recursively select the
+    # directory contents.
     # @type [String] subtree
     attr_accessor :subtree
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
@@ -46,9 +51,11 @@ module Comet
     # @type [Boolean] has_attachments
     attr_accessor :has_attachments
 
+    # Unix timestamp in seconds
     # @type [Number] start_time
     attr_accessor :start_time
 
+    # Unix timestamp in seconds
     # @type [Number] end_time
     attr_accessor :end_time