comet_backup_ruby_sdk 2.6.0 → 2.8.0

data/lib/comet/models/group_policy.rb

@@ -21,9 +21,19 @@ module Comet
     # @type [Comet::UserPolicy] policy
     attr_accessor :policy
 
+    # DefaultUserPolicy marks that this UserPolicy should be applied to all new users. The Comet Server
+    # will ensure that only one policy can be set as default.
     # @type [Boolean] default_user_policy
     attr_accessor :default_user_policy
 
+    # Unix timestamp in seconds. May be zero for Policies created prior to Comet 23.3.3.
+    # @type [Number] created_date
+    attr_accessor :created_date
+
+    # Unix timestamp in seconds. May be zero for Policies created prior to Comet 23.3.3.
+    # @type [Number] modified_date
+    attr_accessor :modified_date
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -35,6 +45,8 @@ module Comet
       @description = ''
       @organization_id = ''
       @policy = Comet::UserPolicy.new
+      @created_date = 0
+      @modified_date = 0
       @unknown_json_fields = {}
     end
 
@@ -64,6 +76,14 @@ module Comet
           @policy.from_hash(v)
         when 'DefaultUserPolicy'
           @default_user_policy = v
+        when 'CreatedDate'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @created_date = v
+        when 'ModifiedDate'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @modified_date = v
         else
           @unknown_json_fields[k] = v
         end
@@ -77,6 +97,8 @@ module Comet
       ret['OrganizationID'] = @organization_id
       ret['Policy'] = @policy
       ret['DefaultUserPolicy'] = @default_user_policy
+      ret['CreatedDate'] = @created_date
+      ret['ModifiedDate'] = @modified_date
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/install_token_response.rb

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

data/lib/comet/models/job_entry.rb

@@ -13,9 +13,11 @@ module Comet
   # JobEntry is a single entry within a job report.
   class JobEntry
 
+    # Unix timestamp in seconds
     # @type [Number] time
     attr_accessor :time
 
+    # One of the SEVERITY_ constants.
     # @type [String] severity
     attr_accessor :severity
 

data/lib/comet/models/live_user_connection.rb

@@ -18,24 +18,35 @@ module Comet
     # @type [String] device_id
     attr_accessor :device_id
 
+    # The Comet Backup software version that this live-connected device reports that it is running. It
+    # takes the format "MAJOR.MINOR.PATCH", such as "23.2.0". See the APPLICATION_VERSION constant for
+    # more information.
     # @type [String] reported_version
     attr_accessor :reported_version
 
+    # The operating system of the device. It is one of the PLATFORM_ constants; then a forwardslash (/);
+    # then the device's GOARCH.
     # @type [String] reported_platform
     attr_accessor :reported_platform
 
+    # The operating system of the device, in extended detail.
     # @type [Comet::OSInfo] reported_platform_version
     attr_accessor :reported_platform_version
 
+    # The reported timezone of the device, in IANA format.
     # @type [String] device_time_zone
     attr_accessor :device_time_zone
 
+    # The live-connected device's remote IP address, as seen from the Comet Server.
     # @type [String] ipaddress
     attr_accessor :ipaddress
 
+    # Unix timestamp, in seconds.
     # @type [Number] connection_time
     attr_accessor :connection_time
 
+    # The current state of the "Allow administrator to view my files" client-side option. If this option
+    # is refused, some live-connected actions will be refused by the device.
     # @type [Boolean] allows_filenames
     attr_accessor :allows_filenames
 

data/lib/comet/models/mongo_dbconnection.rb

@@ -27,6 +27,8 @@ module Comet
     # @type [String] authentication_db
     attr_accessor :authentication_db
 
+    # Prior to Comet 22.12.3, must be a filesystem path to `mongo` (n.b. not `mongosh`). In Comet >=
+    # 22.12.3, not used.
     # @type [String] mongo_shell_path
     # @deprecated This member has been deprecated since Comet version 22.12.3
     attr_accessor :mongo_shell_path

data/lib/comet/models/office_365object_info.rb

@@ -21,6 +21,7 @@ module Comet
     # @type [String] type
     attr_accessor :type
 
+    # May be an email address or a SharePoint site URL
     # @type [String] value
     attr_accessor :value
 

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

@@ -15,54 +15,72 @@ module Comet
     # @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

@@ -0,0 +1,136 @@
+# 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
+
+  # SearchResultFileInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class SearchResultFileInfo
+
+    # @type [String] path
+    attr_accessor :path
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [String] mode
+    attr_accessor :mode
+
+    # @type [String] mtime
+    attr_accessor :mtime
+
+    # @type [String] atime
+    attr_accessor :atime
+
+    # @type [String] ctime
+    attr_accessor :ctime
+
+    # @type [Number] size
+    attr_accessor :size
+
+    # @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 = ''
+      @name = ''
+      @type = ''
+      @mode = ''
+      @mtime = ''
+      @atime = ''
+      @ctime = ''
+      @size = 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 'path'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path = v
+        when 'name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'mode'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @mode = v
+        when 'mtime'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @mtime = v
+        when 'atime'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @atime = v
+        when 'ctime'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @ctime = v
+        when 'size'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @size = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['path'] = @path
+      ret['name'] = @name
+      ret['type'] = @type
+      ret['mode'] = @mode
+      ret['mtime'] = @mtime
+      ret['atime'] = @atime
+      ret['ctime'] = @ctime
+      ret['size'] = @size
+      @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/search_snapshots_response.rb

@@ -0,0 +1,105 @@
+# 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
+
+  # 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
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Hash{String => Array<Comet::SearchResultFileInfo>}] snapshot_files
+    attr_accessor :snapshot_files
+
+    # @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 = ''
+      @snapshot_files = {}
+      @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 'SnapshotFiles'
+          @snapshot_files = {}
+          if v.nil?
+            @snapshot_files = {}
+          else
+            v.each do |k1, v1|
+              if v1.nil?
+                @snapshot_files[k1] = []
+              else
+                @snapshot_files[k1] = Array.new(v1.length)
+                v1.each_with_index do |v2, i2|
+                  @snapshot_files[k1][i2] = Comet::SearchResultFileInfo.new
+                  @snapshot_files[k1][i2].from_hash(v2)
+                end
+              end
+            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['Status'] = @status
+      ret['Message'] = @message
+      ret['SnapshotFiles'] = @snapshot_files
+      @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/self_backup_export_options.rb

@@ -27,6 +27,9 @@ module Comet
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 
+    # @type [Boolean] include_server_logs
+    attr_accessor :include_server_logs
+
     # @type [String] restrict_to_single_org_id
     attr_accessor :restrict_to_single_org_id
 
@@ -80,6 +83,8 @@ module Comet
           @compression = v
         when 'ExcludeJobsDB'
           @exclude_jobs_db = v
+        when 'IncludeServerLogs'
+          @include_server_logs = v
         when 'RestrictToSingleOrgID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -102,6 +107,7 @@ module Comet
       ret['EncryptionKeyFormat'] = @encryption_key_format
       ret['Compression'] = @compression
       ret['ExcludeJobsDB'] = @exclude_jobs_db
+      ret['IncludeServerLogs'] = @include_server_logs
       unless @restrict_to_single_org_id.nil?
         ret['RestrictToSingleOrgID'] = @restrict_to_single_org_id
       end

data/lib/comet/models/self_backup_target.rb

@@ -36,6 +36,9 @@ module Comet
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 
+    # @type [Boolean] include_server_logs
+    attr_accessor :include_server_logs
+
     # @type [String] restrict_to_single_org_id
     attr_accessor :restrict_to_single_org_id
 
@@ -109,6 +112,8 @@ module Comet
           @compression = v
         when 'ExcludeJobsDB'
           @exclude_jobs_db = v
+        when 'IncludeServerLogs'
+          @include_server_logs = v
         when 'RestrictToSingleOrgID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -134,6 +139,7 @@ module Comet
       ret['EncryptionKeyFormat'] = @encryption_key_format
       ret['Compression'] = @compression
       ret['ExcludeJobsDB'] = @exclude_jobs_db
+      ret['IncludeServerLogs'] = @include_server_logs
       unless @restrict_to_single_org_id.nil?
         ret['RestrictToSingleOrgID'] = @restrict_to_single_org_id
       end

data/lib/comet/models/server_config_options.rb

@@ -24,6 +24,11 @@ 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
 

data/lib/comet/models/server_meta_branding_properties.rb

@@ -18,15 +18,22 @@ 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
 
     # @type [String] top_color
     attr_accessor :top_color
 
+    # @type [String] accent_color
+    attr_accessor :accent_color
+
     # @type [Boolean] hide_news_area
     attr_accessor :hide_news_area
 
@@ -54,6 +61,7 @@ module Comet
       @product_name = ''
       @image_etag = ''
       @top_color = ''
+      @accent_color = ''
       @prune_logs_after_days = 0
       @expired_in_seconds = 0
       @unknown_json_fields = {}
@@ -90,6 +98,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @top_color = v
+        when 'AccentColor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @accent_color = v
         when 'HideNewsArea'
           @hide_news_area = v
         when 'AllowUnauthenticatedDownloads'
@@ -118,6 +130,7 @@ module Comet
       ret['HasImage'] = @has_image
       ret['ImageEtag'] = @image_etag
       ret['TopColor'] = @top_color
+      ret['AccentColor'] = @accent_color
       ret['HideNewsArea'] = @hide_news_area
       ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
       ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads

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

@@ -21,6 +21,7 @@ module Comet
     # @type [String] sftpremote_path
     attr_accessor :sftpremote_path
 
+    # One of the DESTINATION_SFTP_AUTHMODE_ constants
     # @type [Number] sftpauth_mode
     attr_accessor :sftpauth_mode