comet_backup_ruby_sdk 2.9.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535a75d833c8c1a3974c03508214df23536d188b0fa5c844f82d40142bab059b
-  data.tar.gz: f14c818c7c052a37a3cab8202e1d891c52e02ad45ed32a043de4ed1b311b2807
+  metadata.gz: 5d6a5ccdbb19a7a417c00bfbd4dfc033b95a0e173188156efaac65217517e6d7
+  data.tar.gz: 9b824422ee089951b33143150891724d457a0e945d8377d704e830356908db85
 SHA512:
-  metadata.gz: 482109073db2fd013d9fd3a4b81c6ee4a74891a97f5da029696e00106b46e0f5fe3addde28da1e1b0d7b7e8ce00b61895af4509a1c22bc47dc2a997f9730bebd
-  data.tar.gz: da454607ab7f08673a79776c06360d5da50c3acdb325e6119e087118719119819e720fbe9f9db2e9287ce6649735edf1f527142840b708fa6db324a4d9ec2fed
+  metadata.gz: a5a9419659e7d24216dd9221af230f9012c3c17d42cc476428f33583189835e95937f6dbac9d517ad72440528315e649b856ccb8472cf00bdd250874adcfb373
+  data.tar.gz: cd7d60617d3682eb905f926837dce922e8474d2ca5551337b377ad170498614d46111f7645e47caedd620f2e864d2baa2b6f9408b9a0a54f2488d9b60ab81de5

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## 2023-08-02 v2.11.0
+
+- Based on Comet 23.6.9
+- Support new API endpoints for managing external admin authentication sources
+- Support Object Lock policy option
+- Update docstrings for various types and fields
+
+## 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.11.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.11.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -136,6 +136,28 @@ module Comet
       ret
     end
 
+    # AdminAccountSessionUpgrade
+    #
+    # Upgrade a session key which is pending an MFA upgrade to a full session key.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] session_key The session key to upgrade
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_session_upgrade(session_key)
+      submit_params = {}
+      raise TypeError, "'session_key' expected String, got #{session_key.class}" unless session_key.is_a? String
+
+      submit_params['SessionKey'] = session_key
+
+      body = perform_request('api/v1/admin/account/session-upgrade', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminAccountSetProperties
     #
     # Update settings for your own admin account.
@@ -1983,8 +2005,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 +2033,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
@@ -2170,6 +2210,102 @@ module Comet
       ret
     end
 
+    # AdminExternalAuthSourcesDelete
+    #
+    # Delete an external admin authentication source.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] source_id (No description available)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_external_auth_sources_delete(source_id)
+      submit_params = {}
+      raise TypeError, "'source_id' expected String, got #{source_id.class}" unless source_id.is_a? String
+
+      submit_params['SourceID'] = source_id
+
+      body = perform_request('api/v1/admin/external-auth-sources/delete', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminExternalAuthSourcesGet
+    #
+    # Get a map of all external admin authentication sources.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Hash{String => Comet::ExternalAuthenticationSource}]
+    def admin_external_auth_sources_get
+      body = perform_request('api/v1/admin/external-auth-sources/get')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = {}
+      if json_body.nil?
+        ret = {}
+      else
+        json_body.each do |k, v|
+          ret[k] = Comet::ExternalAuthenticationSource.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminExternalAuthSourcesNew
+    #
+    # Create an external admin authentication source.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [Comet::ExternalAuthenticationSource] source (No description available)
+    # @param [String] source_id (Optional) (No description available)
+    # @return [Comet::ExternalAuthenticationSourceResponse]
+    def admin_external_auth_sources_new(source, source_id = nil)
+      submit_params = {}
+      raise TypeError, "'source' expected Comet::ExternalAuthenticationSource, got #{source.class}" unless source.is_a? Comet::ExternalAuthenticationSource
+
+      submit_params['Source'] = source.to_json
+      unless source_id.nil?
+        raise TypeError, "'source_id' expected String, got #{source_id.class}" unless source_id.is_a? String
+
+        submit_params['SourceID'] = source_id
+      end
+
+      body = perform_request('api/v1/admin/external-auth-sources/new', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ExternalAuthenticationSourceResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminExternalAuthSourcesSet
+    #
+    # Updates the current tenant's external admin authentication sources. This will set all.
+    # sources for the tenant; none will be preserved.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [Hash{String => Comet::ExternalAuthenticationSource}] sources (No description available)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_external_auth_sources_set(sources)
+      submit_params = {}
+      raise TypeError, "'sources' expected Hash, got #{sources.class}" unless sources.is_a? Hash
+
+      submit_params['Sources'] = sources.to_json
+
+      body = perform_request('api/v1/admin/external-auth-sources/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminGetJobLog
     #
     # Get the report log entries for a single job, in plaintext format.

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.5.0'
+  APPLICATION_VERSION = '23.6.9'
 
   APPLICATION_VERSION_MAJOR = 23
 
-  APPLICATION_VERSION_MINOR = 5
+  APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 0
+  APPLICATION_VERSION_REVISION = 9
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -390,13 +390,22 @@ module Comet
   # When resetting a password with the API, set the PasswordFormat to this value. The Comet Server will re-hash the credential automatically.
   PASSWORD_FORMAT_PLAINTEXT = 0
 
+  # OidcProvider
+  PROVIDER_GENERIC = 'oidc'
+
+  # OidcProvider
+  PROVIDER_AZUREADV2 = 'azure-ad-v2'
+
+  # OidcProvider
+  PROVIDER_GOOGLE = 'google'
+
   # PSAType
   PSA_TYPE_GENERIC = 0
 
   # PSAType
   PSA_TYPE_GRADIENT = 1
 
-  RELEASE_CODENAME = 'Thebe'
+  RELEASE_CODENAME = 'Voyager'
 
   # RemoteServerType
   REMOTESERVER_COMET = 'comet'
@@ -404,6 +413,9 @@ module Comet
   # RemoteServerType
   REMOTESERVER_LDAP = 'ldap'
 
+  # RemoteServerType
+  REMOTESERVER_OIDC = 'oidc'
+
   # RemoteServerType
   REMOTESERVER_B2 = 'b2'
 
@@ -575,13 +587,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 +602,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.
@@ -948,8 +986,8 @@ module Comet
   # WebAuthnDeviceType
   WEBAUTHN_DEVICE_TYPE__TPM_LINUX = 6
 
-  # WindowsCodesignMethod: When upgrading from a version of Comet Server prior to 22.12.7, this option will be automatically converted to a more specific type.
-  # @deprecated This const has been deprecated since Comet version 22.12.7
+  # WindowsCodesignMethod: When upgrading from a version of Comet Server prior to 23.3.0, this option will be automatically converted to a more specific type.
+  # @deprecated This const has been deprecated since Comet version 23.3.0
   WINDOWSCODESIGN_METHOD_AUTO = 0
 
   # WindowsCodesignMethod: Do not perform Authenticode codesigning

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

@@ -33,9 +33,40 @@ module Comet
     # @type [Boolean] allow_edit_webhooks
     attr_accessor :allow_edit_webhooks
 
+    # @type [Boolean] allow_edit_external_auth_sources
+    attr_accessor :allow_edit_external_auth_sources
+
     # @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 +75,7 @@ module Comet
     end
 
     def clear
+      @allowed_providers_when_restricted = []
       @unknown_json_fields = {}
     end
 
@@ -74,8 +106,33 @@ module Comet
           @allow_edit_remote_storage = v
         when 'AllowEditWebhooks'
           @allow_edit_webhooks = v
+        when 'AllowEditExternalAuthSources'
+          @allow_edit_external_auth_sources = 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
@@ -106,9 +163,33 @@ module Comet
       unless @allow_edit_webhooks.nil?
         ret['AllowEditWebhooks'] = @allow_edit_webhooks
       end
+      unless @allow_edit_external_auth_sources.nil?
+        ret['AllowEditExternalAuthSources'] = @allow_edit_external_auth_sources
+      end
       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
 
@@ -104,13 +107,14 @@ module Comet
     # @type [String] windows_code_sign_pkcs11module
     attr_accessor :windows_code_sign_pkcs11module
 
+    # This field was deprecated between 23.3.0 and 23.6.x, but is now used again.
     # @type [String] windows_code_sign_pkcs11certfile
-    # @deprecated This member has been deprecated since Comet version 22.12.7
     attr_accessor :windows_code_sign_pkcs11certfile
 
     # @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