comet_backup_ruby_sdk 2.7.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/request_storage_vault_response_message.rb

@@ -12,6 +12,7 @@ module Comet
   # RequestStorageVaultResponseMessage is a typed class wrapper around the underlying Comet Server API data structure.
   class RequestStorageVaultResponseMessage
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/restore_job_advanced_options.rb

@@ -12,57 +12,76 @@ 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
 
+    # For RESTORETYPE_FILE
     # @type [Boolean] overwrite_existing_files
     attr_accessor :overwrite_existing_files
 
+    # For RESTORETYPE_FILE. If set, OverwriteExistingFiles must be true
     # @type [Boolean] overwrite_if_newer
     attr_accessor :overwrite_if_newer
 
+    # For RESTORETYPE_FILE. If set, DestPath must be blank
     # @type [Boolean] dest_is_original_location
     attr_accessor :dest_is_original_location
 
+    # For RESTORETYPE_FILE or RESTORETYPE_PROCESS_xxx
     # @type [String] dest_path
     attr_accessor :dest_path
 
+    # For RESTORETYPE_WINDISK only. Must have one entry for each selected restore path
     # @type [Array<String>] exact_dest_paths
     attr_accessor :exact_dest_paths
 
+    # For RESTORETYPE_FILE_ARCHIVE or RESTORETYPE_PROCESS_ARCHIVE. Default 0 is *.tar, for backward
+    # compatibility
     # @type [Number] archive_format
     attr_accessor :archive_format
 
+    # For RESTORETYPE_OFFICE365_CLOUD.
     # @type [Comet::Office365Credential] office_365credential
     attr_accessor :office_365credential
 
+    # For RESTORETYPE_MYSQL
     # @type [String] username
     attr_accessor :username
 
+    # For RESTORETYPE_MYSQL
     # @type [String] password
     attr_accessor :password
 
+    # For RESTORETYPE_MYSQL
     # @type [String] host
     attr_accessor :host
 
+    # For RESTORETYPE_MYSQL
     # @type [String] port
     attr_accessor :port
 
+    # For RESTORETYPE_MYSQL
     # @type [Boolean] use_ssl
     attr_accessor :use_ssl
 
+    # For RESTORETYPE_MYSQL i.e.: Self signed certs
     # @type [Boolean] ssl_allow_invalid
     attr_accessor :ssl_allow_invalid
 
+    # For RESTORETYPE_MYSQL
     # @type [String] ssl_ca_file
     attr_accessor :ssl_ca_file
 
+    # For RESTORETYPE_MYSQL
     # @type [String] ssl_crt_file
     attr_accessor :ssl_crt_file
 
+    # For RESTORETYPE_MYSQL
     # @type [String] ssl_key_file
     attr_accessor :ssl_key_file
 
+    # For RESTORETYPE_MSSQL.
     # @type [Comet::MSSQLLoginArgs] ms_sql_connection
     attr_accessor :ms_sql_connection
 

data/lib/comet/models/retention_policy.rb

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

data/lib/comet/models/retention_range.rb

@@ -30,6 +30,7 @@ module Comet
     # @type [Number] months
     attr_accessor :months
 
+    # 0: Sunday, 6: Saturday
     # @type [Number] week_offset
     attr_accessor :week_offset
 

data/lib/comet/models/s3destination_location.rb

@@ -33,6 +33,7 @@ module Comet
     # @type [String] s3custom_region
     attr_accessor :s3custom_region
 
+    # If true, use legacy v2 signing. If false (default), use modern v4 signing
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 

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/search_snapshots_response.rb

@@ -12,6 +12,7 @@ module Comet
   # SearchSnapshotsResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class SearchSnapshotsResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

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

@@ -24,12 +24,18 @@ module Comet
     # @type [Comet::ConstellationRoleOptions] constellation_role
     attr_accessor :constellation_role
 
+    # This field is defined for compatibility with 17.x.x versions of Comet Server. Do not rely on this
+    # field. In Comet 23.2.x, if this field is defined, it is imported into the replacement
+    # 'ConstellationRole' field under the assumption that you are upgrading this Comet Server from a
+    # 17.x.x version. In Comet 23.3.x and later, this field is ignored and will not be respected during
+    # the import process.
     # @type [Comet::ConstellationRoleOptions] constellation_role__legacy
     attr_accessor :constellation_role__legacy
 
     # @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
 
@@ -42,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
 
@@ -63,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
 
@@ -95,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
 
@@ -217,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
@@ -249,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/server_meta_branding_properties.rb

@@ -18,9 +18,13 @@ module Comet
     # @type [String] product_name
     attr_accessor :product_name
 
+    # If true, this Comet Server has an image configured for its main logo. You can access it from the
+    # /gen/logo.img endpoint. If false, this Comet Server has text configured for its main logo.
     # @type [Boolean] has_image
     attr_accessor :has_image
 
+    # A value that will change if the branding image (/gen/logo.img) changes. You can use this as a
+    # cache key.
     # @type [String] image_etag
     attr_accessor :image_etag
 

data/lib/comet/models/server_meta_version_info.rb

@@ -28,6 +28,7 @@ module Comet
     attr_accessor :software_build_role
 
     # @type [Boolean] constellation_role__legacy
+    # @deprecated This member has been deprecated since Comet version 18.2.0 "Overseer Role" was the old name for the Constellation Role. This field is a duplicate of ConstellationRole for backward compatibility with earlier API consumers.
     attr_accessor :constellation_role__legacy
 
     # @type [Boolean] constellation_role
@@ -36,15 +37,22 @@ module Comet
     # @type [Array<String>] experimental_options
     attr_accessor :experimental_options
 
+    # Unix timestamp, in seconds.
     # @type [Number] server_start_time
     attr_accessor :server_start_time
 
+    # A GUID that was randomly generated when this Comet Server started up. You can check this value to
+    # see if the Comet Server has restarted.
     # @type [String] server_start_hash
     attr_accessor :server_start_hash
 
+    # The current time on the Comet Server host machine. Unix timestamp, in seconds. You can check this
+    # value to see if clock drift is occuring.
     # @type [Number] current_time
     attr_accessor :current_time
 
+    # A hash derived from the Comet Server's serial number. You can check this value to see if two Comet
+    # Server endpoints point to an identical server.
     # @type [String] server_license_hash
     attr_accessor :server_license_hash
 

data/lib/comet/models/session_key_regenerated_response.rb

@@ -12,6 +12,7 @@ module Comet
   # SessionKeyRegeneratedResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class SessionKeyRegeneratedResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

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,21 +18,29 @@ 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
 
+    # One of the DESTINATION_SFTP_AUTHMODE_ constants
     # @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