comet_backup_ruby_sdk 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535a75d833c8c1a3974c03508214df23536d188b0fa5c844f82d40142bab059b
-  data.tar.gz: f14c818c7c052a37a3cab8202e1d891c52e02ad45ed32a043de4ed1b311b2807
+  metadata.gz: bf7e87fdc27ef3763c733ea58dc87801cee0f836a83aae1ef1bb7675a83d4af8
+  data.tar.gz: db96863bb3c92d8d1809b7db280af67c46c10922520ccb3ad3bc27de1d7aed65
 SHA512:
-  metadata.gz: 482109073db2fd013d9fd3a4b81c6ee4a74891a97f5da029696e00106b46e0f5fe3addde28da1e1b0d7b7e8ce00b61895af4509a1c22bc47dc2a997f9730bebd
-  data.tar.gz: da454607ab7f08673a79776c06360d5da50c3acdb325e6119e087118719119819e720fbe9f9db2e9287ce6649735edf1f527142840b708fa6db324a4d9ec2fed
+  metadata.gz: 8bab833349a8fd00d7f32392f2fe4d1b796fb7c7299cdab66988b14e307a14ad24a50840aea05586fd37337a7e41fc0be606b1a6b5328e5ed8a78c0327e044df
+  data.tar.gz: 5997a150f92013e65f975872bd0028245fcb3d7f228a4bf81ed790fc0042d1db5227d84b36b9e5869ec83922c9e181d06d6aafae52d9951686a7c99f29d9fdda

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 2023-07-11 v2.10.0
+
+- Based on Comet 23.6.5
+- Support `DeviceConfig->ClientVersion`
+- Support new `OSInfo` and `RestoreJobAdvancedOptions` fields
+- Support new `SourceConfig` fields for tracking policy-enforced Protected Items
+- Support new optional parameters in `AdminDispatcherRunRestoreCustom` API
+- Add many more documentation comments, including behaviour of base64 byte arrays
+
 ## 2023-06-01 v2.9.0
 
 - Based on Comet 23.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.9.0)
+    comet_backup_ruby_sdk (2.10.0)
 
 GEM
   remote: https://rubygems.org/

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '2.9.0'
+  spec.version       = '2.10.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -1983,8 +1983,11 @@ module Comet
     # @param [Comet::RestoreJobAdvancedOptions] options Restore targets
     # @param [String] snapshot (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair
     # @param [Array<String>] paths (Optional) If present, restore these paths only. Otherwise, restore all data
+    # @param [Number] known_file_count (Optional) The number of files to restore, if known. Supplying this means we don't need to walk the entire tree just to find the file count and will speed up the restoration process.
+    # @param [Number] known_byte_count (Optional) The total size in bytes of files to restore, if known. Supplying this means we don't need to walk the entire tree just to find the total file size and will speed up the restoration process.
+    # @param [Number] known_dir_count (Optional) The number of directories to restore, if known. Supplying this means we don't need to walk the entire tree just to find the number of directories and will speed up the restoration process.
     # @return [Comet::CometAPIResponseMessage]
-    def admin_dispatcher_run_restore_custom(target_id, source, destination, options, snapshot = nil, paths = nil)
+    def admin_dispatcher_run_restore_custom(target_id, source, destination, options, snapshot = nil, paths = nil, known_file_count = nil, known_byte_count = nil, known_dir_count = nil)
       submit_params = {}
       raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
 
@@ -2008,6 +2011,21 @@ module Comet
 
         submit_params['Paths'] = paths.to_json
       end
+      unless known_file_count.nil?
+        raise TypeError, "'known_file_count' expected Numeric, got #{known_file_count.class}" unless known_file_count.is_a? Numeric
+
+        submit_params['KnownFileCount'] = known_file_count
+      end
+      unless known_byte_count.nil?
+        raise TypeError, "'known_byte_count' expected Numeric, got #{known_byte_count.class}" unless known_byte_count.is_a? Numeric
+
+        submit_params['KnownByteCount'] = known_byte_count
+      end
+      unless known_dir_count.nil?
+        raise TypeError, "'known_dir_count' expected Numeric, got #{known_dir_count.class}" unless known_dir_count.is_a? Numeric
+
+        submit_params['KnownDirCount'] = known_dir_count
+      end
 
       body = perform_request('api/v1/admin/dispatcher/run-restore-custom', submit_params)
       json_body = JSON.parse body

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.5.0'
+  APPLICATION_VERSION = '23.6.5'
 
   APPLICATION_VERSION_MAJOR = 23
 
-  APPLICATION_VERSION_MINOR = 5
+  APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 0
+  APPLICATION_VERSION_REVISION = 5
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -396,7 +396,7 @@ module Comet
   # PSAType
   PSA_TYPE_GRADIENT = 1
 
-  RELEASE_CODENAME = 'Thebe'
+  RELEASE_CODENAME = 'Voyager'
 
   # RemoteServerType
   REMOTESERVER_COMET = 'comet'
@@ -575,13 +575,13 @@ module Comet
 
   SCHEDULE_MAXINT = 1_125_899_906_842_624
 
-  # SearchClauseType
+  # SearchClauseType: The search clause is an explicit rule
   SEARCHCLAUSE_RULE = ''
 
-  # SearchClauseType
+  # SearchClauseType: All of the ClauseChildren must match
   SEARCHCLAUSE_AND = 'and'
 
-  # SearchClauseType
+  # SearchClauseType: At least one of the ClauseChildren must match
   SEARCHCLAUSE_OR = 'or'
 
   # SearchClauseType
@@ -590,56 +590,82 @@ module Comet
   # SearchClauseType
   SEARCHCLAUSE_NOT_OR = 'not_or'
 
+  # String equals (case sensitive)
   SEARCHOPERATOR_STRING_EQ = 'str_eq'
 
+  # String does not equal (case sensitive)
   SEARCHOPERATOR_STRING_NEQ = 'str_neq'
 
+  # String contains anywhere (case sensitive)
   SEARCHOPERATOR_STRING_CONTAINS = 'str_contains'
 
+  # String does not contain anywhere (case sensitive)
   SEARCHOPERATOR_STRING_NCONTAINS = 'str_ncontains'
 
+  # String starts with prefix (case sensitive)
   SEARCHOPERATOR_STRING_STARTSWITH = 'str_startswith'
 
+  # String does not start with prefix (case sensitive)
   SEARCHOPERATOR_STRING_NSTARTSWITH = 'str_nstartswith'
 
+  # String ends with suffix (case sensitive)
   SEARCHOPERATOR_STRING_ENDSWITH = 'str_endswith'
 
+  # String does not end with suffix (case sensitive)
   SEARCHOPERATOR_STRING_NENDSWITH = 'str_nendswith'
 
+  # String equals (case insensitive)
   SEARCHOPERATOR_STRING_EQ_CI = 'str_eq_ci'
 
+  # String does not equal (case insensitive)
   SEARCHOPERATOR_STRING_NEQ_CI = 'str_neq_ci'
 
+  # String contains anywhere (case sensitive)
   SEARCHOPERATOR_STRING_CONTAINS_CI = 'str_contains_ci'
 
+  # String does not contain anywhere (case sensitive)
   SEARCHOPERATOR_STRING_NCONTAINS_CI = 'str_ncontains_ci'
 
+  # String starts with prefix (case sensitive)
   SEARCHOPERATOR_STRING_STARTSWITH_CI = 'str_startswith_ci'
 
+  # String does not start with (case sensitive)
   SEARCHOPERATOR_STRING_NSTARTSWITH_CI = 'str_nstartswith_ci'
 
+  # String ends with suffix (case sensitive)
   SEARCHOPERATOR_STRING_ENDSWITH_CI = 'str_endswith_ci'
 
+  # String does not end with suffix (case sensitive)
   SEARCHOPERATOR_STRING_NENDSWITH_CI = 'str_nendswith_ci'
 
+  # String matches provided regular expression (using Go regex syntax)
   SEARCHOPERATOR_STRING_REGEXMATCH = 'str_regexmatch'
 
+  # String does not match provided regular expression (using Go regex syntax)
   SEARCHOPERATOR_STRING_NREGEXMATCH = 'str_nregexmatch'
 
+  # Integer field is equal to value
   SEARCHOPERATOR_INT_EQ = 'int_eq'
 
+  # Integer field is not equal to value
   SEARCHOPERATOR_INT_NEQ = 'int_neq'
 
+  # Integer field is greater than value
   SEARCHOPERATOR_INT_GT = 'int_gt'
 
+  # Integer field is greater than or equal to value
   SEARCHOPERATOR_INT_GTE = 'int_gte'
 
+  # Integer field is less than value
   SEARCHOPERATOR_INT_LT = 'int_lt'
 
+  # Integer field is less than or equal to value
   SEARCHOPERATOR_INT_LTE = 'int_lte'
 
+  # Boolean field matches value
   SEARCHOPERATOR_BOOL_IS = 'bool_is'
 
+  # Boolean field does not match value
   SEARCHOPERATOR_BOOL_NIS = 'bool_nis'
 
   # 0000 0001. If this value is present in the bitset, then the Calendar service is selected for backup.

data/lib/comet/models/admin_account_properties_response.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Comet::AdminUserPermissions] permissions
     attr_accessor :permissions
 
+    # This field is available in Comet 18.9.9 and later.
     # @type [Comet::AdminSecurityOptions] security
     attr_accessor :security
 

data/lib/comet/models/admin_security_options.rb

@@ -12,6 +12,7 @@ module Comet
   # AdminSecurityOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class AdminSecurityOptions
 
+    # One of the PASSWORD_FORMAT_ constants
     # @type [Number] password_format
     attr_accessor :password_format
 
@@ -38,12 +39,15 @@ module Comet
     # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
     attr_accessor :web_authn_registrations
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] totpkey_encryption_format
     attr_accessor :totpkey_encryption_format
 
     # @type [String] totpkey
     attr_accessor :totpkey
 
+    # A regular expression in Go regex syntax, for which IP addresses are allowed to authenticate as
+    # this admin account
     # @type [String] ipwhitelist
     attr_accessor :ipwhitelist
 

data/lib/comet/models/admin_u2fregistration.rb

@@ -17,9 +17,11 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
+    # Unix timestamp, in seconds.
     # @type [Number] register_time
     attr_accessor :register_time
 
+    # When this field is expressed as a AdminU2FRegistration class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] registration
     attr_accessor :registration
 

data/lib/comet/models/admin_user_permissions.rb

@@ -36,6 +36,34 @@ module Comet
     # @type [Boolean] deny_constellation_role
     attr_accessor :deny_constellation_role
 
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] deny_view_server_history
+    attr_accessor :deny_view_server_history
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] deny_view_server_info
+    attr_accessor :deny_view_server_info
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] prevent_request_storage_vault
+    attr_accessor :prevent_request_storage_vault
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] prevent_add_custom_storage_vault
+    attr_accessor :prevent_add_custom_storage_vault
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] hide_cloud_storage_branding
+    attr_accessor :hide_cloud_storage_branding
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] should_restrict_provider_list
+    attr_accessor :should_restrict_provider_list
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Array<Number>] allowed_providers_when_restricted
+    attr_accessor :allowed_providers_when_restricted
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -44,6 +72,7 @@ module Comet
     end
 
     def clear
+      @allowed_providers_when_restricted = []
       @unknown_json_fields = {}
     end
 
@@ -76,6 +105,29 @@ module Comet
           @allow_edit_webhooks = v
         when 'DenyConstellationRole'
           @deny_constellation_role = v
+        when 'DenyViewServerHistory'
+          @deny_view_server_history = v
+        when 'DenyViewServerInfo'
+          @deny_view_server_info = v
+        when 'PreventRequestStorageVault'
+          @prevent_request_storage_vault = v
+        when 'PreventAddCustomStorageVault'
+          @prevent_add_custom_storage_vault = v
+        when 'HideCloudStorageBranding'
+          @hide_cloud_storage_branding = v
+        when 'ShouldRestrictProviderList'
+          @should_restrict_provider_list = v
+        when 'AllowedProvidersWhenRestricted'
+          if v.nil?
+            @allowed_providers_when_restricted = []
+          else
+            @allowed_providers_when_restricted = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @allowed_providers_when_restricted[i1] = v1
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -109,6 +161,27 @@ module Comet
       unless @deny_constellation_role.nil?
         ret['DenyConstellationRole'] = @deny_constellation_role
       end
+      unless @deny_view_server_history.nil?
+        ret['DenyViewServerHistory'] = @deny_view_server_history
+      end
+      unless @deny_view_server_info.nil?
+        ret['DenyViewServerInfo'] = @deny_view_server_info
+      end
+      unless @prevent_request_storage_vault.nil?
+        ret['PreventRequestStorageVault'] = @prevent_request_storage_vault
+      end
+      unless @prevent_add_custom_storage_vault.nil?
+        ret['PreventAddCustomStorageVault'] = @prevent_add_custom_storage_vault
+      end
+      unless @hide_cloud_storage_branding.nil?
+        ret['HideCloudStorageBranding'] = @hide_cloud_storage_branding
+      end
+      unless @should_restrict_provider_list.nil?
+        ret['ShouldRestrictProviderList'] = @should_restrict_provider_list
+      end
+      unless @allowed_providers_when_restricted.nil?
+        ret['AllowedProvidersWhenRestricted'] = @allowed_providers_when_restricted
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/admin_web_authn_registration.rb

@@ -16,6 +16,7 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
+    # Unix timestamp, in seconds.
     # @type [Number] register_time
     attr_accessor :register_time
 
@@ -25,6 +26,7 @@ module Comet
     # @type [Boolean] is_legacy_u2f
     attr_accessor :is_legacy_u2f
 
+    # When this field is expressed as a AdminWebAuthnRegistration class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] id
     attr_accessor :id
 

data/lib/comet/models/allowed_admin_user.rb

@@ -21,6 +21,7 @@ module Comet
     # @type [String] external_authentication_source
     attr_accessor :external_authentication_source
 
+    # One of the PASSWORD_FORMAT_ constants
     # @type [Number] password_format
     attr_accessor :password_format
 
@@ -47,12 +48,15 @@ module Comet
     # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
     attr_accessor :web_authn_registrations
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] totpkey_encryption_format
     attr_accessor :totpkey_encryption_format
 
     # @type [String] totpkey
     attr_accessor :totpkey
 
+    # A regular expression in Go regex syntax, for which IP addresses are allowed to authenticate as
+    # this admin account
     # @type [String] ipwhitelist
     attr_accessor :ipwhitelist
 

data/lib/comet/models/authentication_role_options.rb

@@ -15,12 +15,14 @@ module Comet
     # @type [Boolean] role_enabled
     attr_accessor :role_enabled
 
+    # One of the INTEGRITYCHECK_ constants
     # @type [Number] database_check_level
     attr_accessor :database_check_level
 
     # @type [Boolean] generate_missed_backup_events
     attr_accessor :generate_missed_backup_events
 
+    # Unix timestamp in seconds, before which no Missed jobs are created
     # @type [Number] no_missed_backup_events_before
     attr_accessor :no_missed_backup_events_before
 

data/lib/comet/models/branding_options.rb

@@ -59,6 +59,7 @@ module Comet
     # @type [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -86,12 +87,14 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # One of the WINDOWSCODESIGN_METHOD_ constants
     # @type [Number] windows_code_sign_method
     attr_accessor :windows_code_sign_method
 
     # @type [String] windows_code_sign_pkcs12file_path
     attr_accessor :windows_code_sign_pkcs12file_path
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs12password_format
     attr_accessor :windows_code_sign_pkcs12password_format
 
@@ -111,6 +114,7 @@ module Comet
     # @type [String] windows_code_sign_pkcs11key_id
     attr_accessor :windows_code_sign_pkcs11key_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs11password_format
     attr_accessor :windows_code_sign_pkcs11password_format
 
@@ -126,6 +130,7 @@ module Comet
     # @type [String] windows_code_sign_azure_app_id
     attr_accessor :windows_code_sign_azure_app_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_azure_app_secret_format
     attr_accessor :windows_code_sign_azure_app_secret_format
 

data/lib/comet/models/branding_properties.rb

@@ -36,6 +36,7 @@ module Comet
     # @type [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -63,12 +64,14 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # One of the WINDOWSCODESIGN_METHOD_ constants
     # @type [Number] windows_code_sign_method
     attr_accessor :windows_code_sign_method
 
     # @type [String] windows_code_sign_pkcs12file_path
     attr_accessor :windows_code_sign_pkcs12file_path
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs12password_format
     attr_accessor :windows_code_sign_pkcs12password_format
 
@@ -88,6 +91,7 @@ module Comet
     # @type [String] windows_code_sign_pkcs11key_id
     attr_accessor :windows_code_sign_pkcs11key_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs11password_format
     attr_accessor :windows_code_sign_pkcs11password_format
 
@@ -103,6 +107,7 @@ module Comet
     # @type [String] windows_code_sign_azure_app_id
     attr_accessor :windows_code_sign_azure_app_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_azure_app_secret_format
     attr_accessor :windows_code_sign_azure_app_secret_format
 

data/lib/comet/models/bucket_properties.rb

@@ -15,9 +15,11 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # Unix timestamp, in seconds.
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # One of the PASSWORD_FORMAT_ constants
     # @type [Number] read_write_key_format
     attr_accessor :read_write_key_format
 

data/lib/comet/models/constellation_stats.rb

@@ -12,12 +12,17 @@ module Comet
   # ConstellationStats is a typed class wrapper around the underlying Comet Server API data structure.
   class ConstellationStats
 
+    # Unix timestamp, in seconds.
     # @type [Number] last_check_start
     attr_accessor :last_check_start
 
+    # The total number of Constellation bucket report scans that have been performed since this Comet
+    # Server was last restarted
     # @type [Number] total_checks_started
     attr_accessor :total_checks_started
 
+    # The total number of buckets that Constellation has successfully deleted since this Comet Server
+    # was last restarted
     # @type [Number] total_buckets_deleted
     attr_accessor :total_buckets_deleted
 

data/lib/comet/models/device_config.rb

@@ -32,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
 
@@ -45,6 +49,7 @@ module Comet
       @platform_version = Comet::OSInfo.new
       @sources = {}
       @device_timezone = ''
+      @client_version = ''
       @unknown_json_fields = {}
     end
 
@@ -86,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
@@ -108,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/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/mac_oscode_sign_properties.rb

@@ -22,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
 
@@ -34,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
 
@@ -46,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