comet_backup_ruby_sdk 2.9.0 → 2.11.0

data/lib/comet/models/oidc_config.rb

@@ -0,0 +1,203 @@
+# 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
+
+  # OidcConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class OidcConfig
+
+    # @type [String] display_name
+    attr_accessor :display_name
+
+    # @type [Array<String>] hosts
+    attr_accessor :hosts
+
+    # @type [String] organization_id
+    attr_accessor :organization_id
+
+    # @type [String] provider
+    attr_accessor :provider
+
+    # @type [String] client_id
+    attr_accessor :client_id
+
+    # @type [String] client_secret
+    attr_accessor :client_secret
+
+    # @type [Boolean] skip_mfa
+    attr_accessor :skip_mfa
+
+    # @type [Array<String>] scopes
+    attr_accessor :scopes
+
+    # @type [Array<Comet::OidcClaim>] required_claims
+    attr_accessor :required_claims
+
+    # @type [String] generic_op_discovery_document_url
+    attr_accessor :generic_op_discovery_document_url
+
+    # @type [String] azure_adv2op_tenant_id
+    attr_accessor :azure_adv2op_tenant_id
+
+    # @type [String] google_op_hosted_domain
+    attr_accessor :google_op_hosted_domain
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @display_name = ''
+      @hosts = []
+      @organization_id = ''
+      @provider = ''
+      @client_id = ''
+      @client_secret = ''
+      @scopes = []
+      @required_claims = []
+      @generic_op_discovery_document_url = ''
+      @azure_adv2op_tenant_id = ''
+      @google_op_hosted_domain = ''
+      @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 'DisplayName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @display_name = v
+        when 'Hosts'
+          if v.nil?
+            @hosts = []
+          else
+            @hosts = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @hosts[i1] = v1
+            end
+          end
+        when 'OrganizationID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @organization_id = v
+        when 'Provider'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @provider = v
+        when 'ClientID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @client_id = v
+        when 'ClientSecret'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @client_secret = v
+        when 'SkipMFA'
+          @skip_mfa = v
+        when 'Scopes'
+          if v.nil?
+            @scopes = []
+          else
+            @scopes = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @scopes[i1] = v1
+            end
+          end
+        when 'RequiredClaims'
+          if v.nil?
+            @required_claims = []
+          else
+            @required_claims = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @required_claims[i1] = Comet::OidcClaim.new
+              @required_claims[i1].from_hash(v1)
+            end
+          end
+        when 'DiscoveryDocumentURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @generic_op_discovery_document_url = v
+        when 'AzureTenantID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @azure_adv2op_tenant_id = v
+        when 'GoogleHostedDomain'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @google_op_hosted_domain = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['DisplayName'] = @display_name
+      unless @hosts.nil?
+        ret['Hosts'] = @hosts
+      end
+      unless @organization_id.nil?
+        ret['OrganizationID'] = @organization_id
+      end
+      ret['Provider'] = @provider
+      ret['ClientID'] = @client_id
+      ret['ClientSecret'] = @client_secret
+      ret['SkipMFA'] = @skip_mfa
+      unless @scopes.nil?
+        ret['Scopes'] = @scopes
+      end
+      unless @required_claims.nil?
+        ret['RequiredClaims'] = @required_claims
+      end
+      unless @generic_op_discovery_document_url.nil?
+        ret['DiscoveryDocumentURL'] = @generic_op_discovery_document_url
+      end
+      unless @azure_adv2op_tenant_id.nil?
+        ret['AzureTenantID'] = @azure_adv2op_tenant_id
+      end
+      unless @google_op_hosted_domain.nil?
+        ret['GoogleHostedDomain'] = @google_op_hosted_domain
+      end
+      @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/osinfo.rb

@@ -10,17 +10,31 @@ require 'json'
 module Comet
 
   # OSInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # OSInfo represents the common set of version information between all operating systems
   class OSInfo
 
+    # The primary version number (e.g. on Windows: 1703 / 2009, on Linux: 20.04 / 22.04)
     # @type [String] version
     attr_accessor :version
 
+    # The primary presentation name (e.g. "Windows 10 Pro", "debian", "Synology DSM")
     # @type [String] distribution
     attr_accessor :distribution
 
+    # The detailed build number (e.g. 19043)
     # @type [String] build
     attr_accessor :build
 
+    # The GOOS value
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] os
+    attr_accessor :os
+
+    # The GOARCH value
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] arch
+    attr_accessor :arch
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -32,6 +46,8 @@ module Comet
       @version = ''
       @distribution = ''
       @build = ''
+      @os = ''
+      @arch = ''
       @unknown_json_fields = {}
     end
 
@@ -60,6 +76,14 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @build = v
+        when 'os'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @os = v
+        when 'arch'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @arch = v
         else
           @unknown_json_fields[k] = v
         end
@@ -78,6 +102,12 @@ module Comet
       unless @build.nil?
         ret['build'] = @build
       end
+      unless @os.nil?
+        ret['os'] = @os
+      end
+      unless @arch.nil?
+        ret['arch'] = @arch
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/partition.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] device_name
     attr_accessor :device_name
 
+    # The name of the filesystem used on this partition (e.g. "NTFS")
     # @type [String] filesystem
     attr_accessor :filesystem
 
@@ -30,12 +31,16 @@ module Comet
     # @type [Array<String>] mount_points
     attr_accessor :mount_points
 
+    # Bytes. The partition's offset within the DeviceName. It will be zero if this partition has a
+    # direct DeviceName handle.
     # @type [Number] read_offset
     attr_accessor :read_offset
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
+    # Bytes. Only present for supported filesystems that are currently mounted by the OS
     # @type [Number] used_size
     attr_accessor :used_size
 

data/lib/comet/models/private_branding_properties.rb

@@ -12,6 +12,7 @@ module Comet
   # PrivateBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class PrivateBrandingProperties
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -39,12 +40,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
 
@@ -57,13 +60,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
 
@@ -79,6 +83,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/psaconfig.rb

@@ -12,18 +12,22 @@ module Comet
   # PSAConfig is a typed class wrapper around the underlying Comet Server API data structure.
   class PSAConfig
 
+    # For PSA_TYPE_GRADIENT. Defaults to enabled
     # @type [Boolean] alerts_disabled
     attr_accessor :alerts_disabled
 
     # @type [Hash{String => String}] custom_headers
     attr_accessor :custom_headers
 
+    # Specified credentials for the target PSA
     # @type [String] partner_key
     attr_accessor :partner_key
 
+    # One of the PSA_TYPE_ constants
     # @type [Number] type
     attr_accessor :type
 
+    # For PSA_TYPE_GENERIC
     # @type [String] url
     attr_accessor :url
 

data/lib/comet/models/remote_server_address.rb

@@ -30,6 +30,9 @@ module Comet
     # @type [Comet::ExternalLDAPAuthenticationSourceSettings] ldap
     attr_accessor :ldap
 
+    # @type [Comet::OidcConfig] oidc
+    attr_accessor :oidc
+
     # @type [Comet::B2VirtualStorageRoleSettings] b2
     attr_accessor :b2
 
@@ -63,6 +66,7 @@ module Comet
       @username = ''
       @password = ''
       @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+      @oidc = Comet::OidcConfig.new
       @b2 = Comet::B2VirtualStorageRoleSettings.new
       @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
       @custom = Comet::CustomRemoteBucketSettings.new
@@ -108,6 +112,9 @@ module Comet
         when 'LDAP'
           @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
           @ldap.from_hash(v)
+        when 'OIDC'
+          @oidc = Comet::OidcConfig.new
+          @oidc.from_hash(v)
         when 'B2'
           @b2 = Comet::B2VirtualStorageRoleSettings.new
           @b2.from_hash(v)
@@ -149,6 +156,9 @@ module Comet
       unless @ldap.nil?
         ret['LDAP'] = @ldap
       end
+      unless @oidc.nil?
+        ret['OIDC'] = @oidc
+      end
       unless @b2.nil?
         ret['B2'] = @b2
       end

data/lib/comet/models/remote_storage_option.rb

@@ -30,6 +30,9 @@ module Comet
     # @type [Comet::ExternalLDAPAuthenticationSourceSettings] ldap
     attr_accessor :ldap
 
+    # @type [Comet::OidcConfig] oidc
+    attr_accessor :oidc
+
     # @type [Comet::B2VirtualStorageRoleSettings] b2
     attr_accessor :b2
 
@@ -72,6 +75,7 @@ module Comet
       @username = ''
       @password = ''
       @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+      @oidc = Comet::OidcConfig.new
       @b2 = Comet::B2VirtualStorageRoleSettings.new
       @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
       @custom = Comet::CustomRemoteBucketSettings.new
@@ -118,6 +122,9 @@ module Comet
         when 'LDAP'
           @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
           @ldap.from_hash(v)
+        when 'OIDC'
+          @oidc = Comet::OidcConfig.new
+          @oidc.from_hash(v)
         when 'B2'
           @b2 = Comet::B2VirtualStorageRoleSettings.new
           @b2.from_hash(v)
@@ -167,6 +174,9 @@ module Comet
       unless @ldap.nil?
         ret['LDAP'] = @ldap
       end
+      unless @oidc.nil?
+        ret['OIDC'] = @oidc
+      end
       unless @b2.nil?
         ret['B2'] = @b2
       end

data/lib/comet/models/replica_server.rb

@@ -30,6 +30,9 @@ module Comet
     # @type [Comet::ExternalLDAPAuthenticationSourceSettings] ldap
     attr_accessor :ldap
 
+    # @type [Comet::OidcConfig] oidc
+    attr_accessor :oidc
+
     # @type [Comet::B2VirtualStorageRoleSettings] b2
     attr_accessor :b2
 
@@ -66,6 +69,7 @@ module Comet
       @username = ''
       @password = ''
       @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+      @oidc = Comet::OidcConfig.new
       @b2 = Comet::B2VirtualStorageRoleSettings.new
       @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
       @custom = Comet::CustomRemoteBucketSettings.new
@@ -112,6 +116,9 @@ module Comet
         when 'LDAP'
           @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
           @ldap.from_hash(v)
+        when 'OIDC'
+          @oidc = Comet::OidcConfig.new
+          @oidc.from_hash(v)
         when 'B2'
           @b2 = Comet::B2VirtualStorageRoleSettings.new
           @b2.from_hash(v)
@@ -157,6 +164,9 @@ module Comet
       unless @ldap.nil?
         ret['LDAP'] = @ldap
       end
+      unless @oidc.nil?
+        ret['OIDC'] = @oidc
+      end
       unless @b2.nil?
         ret['B2'] = @b2
       end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -41,6 +41,19 @@ module Comet
     # @type [Number] archive_format
     attr_accessor :archive_format
 
+    # Default disabled. For RESTORETYPE_FILE and RESTORETYPE_WINDISK. Used to continue the restore job
+    # when unreadable data chunks are found.
+    # Corresponds to the "Allow partial file restores (zero-out unrecoverable data)" option
+    # This field is available in Comet 23.6.4 and later.
+    # @type [Boolean] skip_unreadable_chunks
+    attr_accessor :skip_unreadable_chunks
+
+    # Default disabled. Used to store the index files on disk instead of in memory.
+    # Corresponds to the "Prefer temporary files instead of RAM (slower)" option
+    # This field is available in Comet 23.6.4 and later.
+    # @type [Boolean] on_disk_indexes_key
+    attr_accessor :on_disk_indexes_key
+
     # For RESTORETYPE_OFFICE365_CLOUD.
     # @type [Comet::Office365Credential] office_365credential
     attr_accessor :office_365credential
@@ -151,6 +164,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @archive_format = v
+        when 'SkipUnreadableChunks'
+          @skip_unreadable_chunks = v
+        when 'OnDiskIndexesKey'
+          @on_disk_indexes_key = v
         when 'Office365Credential'
           @office_365credential = Comet::Office365Credential.new
           @office_365credential.from_hash(v)
@@ -205,6 +222,8 @@ module Comet
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths
       ret['ArchiveFormat'] = @archive_format
+      ret['SkipUnreadableChunks'] = @skip_unreadable_chunks
+      ret['OnDiskIndexesKey'] = @on_disk_indexes_key
       unless @office_365credential.nil?
         ret['Office365Credential'] = @office_365credential
       end

data/lib/comet/models/retention_range.rb

@@ -10,11 +10,15 @@ require 'json'
 module Comet
 
   # RetentionRange is a typed class wrapper around the underlying Comet Server API data structure.
+  # The Type field controls which fields of this data type are used. For additional information, see
+# the notes on the RETENTIONRANGE_ constants.
   class RetentionRange
 
+    # One of the RETENTIONRANGE_ constants
     # @type [Number] type
     attr_accessor :type
 
+    # Unix timestamp, in seconds. Used by RETENTIONRANGE_NEWER_THAN_X.
     # @type [Number] timestamp
     attr_accessor :timestamp
 
@@ -34,6 +38,10 @@ module Comet
     # @type [Number] week_offset
     attr_accessor :week_offset
 
+    # 1: 1st, 31: 31st
+    # Prior to Comet version 23.6.2, 31 was treated as 30.
+    # For months that do not have a day equal to the specified offset, no backup will be retained.
+    # For example, if the offset is set to 30, no backup will be kept for February.
     # @type [Number] month_offset
     attr_accessor :month_offset
 

data/lib/comet/models/search_clause.rb

@@ -12,18 +12,34 @@ module Comet
   # SearchClause is a typed class wrapper around the underlying Comet Server API data structure.
   class SearchClause
 
+    # One of the SEARCHCLAUSE_ constants (e.g. empty-string if this is a rule, or "and"/"or" if there
+    # are ClauseChildren)
     # @type [String] clause_type
     attr_accessor :clause_type
 
+    # The field name to search. Check the specific API for more information about which fields are
+    # available for searching. For use with ClauseType = SEARCHCLAUSE_RULE.
     # @type [String] rule_field
     attr_accessor :rule_field
 
+    # One of the SEARCHOPERATOR_ constants. The operator must match the type of the particular field.
+    # For use with ClauseType = SEARCHCLAUSE_RULE.
     # @type [String] rule_operator
     attr_accessor :rule_operator
 
+    # The value to compare the field against.
+    # - If the field is a string, any string is permissable.
+    # - If the field is an integer, the integer should be cast to a base-10 string. There is currently
+    # no support for fractional or floating-point numbers.
+    # - If the field is a boolean, the following values can be used for true ("1", "t", "T", "true",
+    # "TRUE", "True") and the following values can be used for false ("0", "f", "F", "false", "FALSE",
+    # "False").
+    # For use with ClauseType = SEARCHCLAUSE_RULE.
     # @type [String] rule_value
     attr_accessor :rule_value
 
+    # If ClauseType is not SEARCHCLAUSE_RULE, the child rules will be applied according to the
+    # ClauseType (e.g. "and"/"or")
     # @type [Array<Comet::SearchClause>] clause_children
     attr_accessor :clause_children
 

data/lib/comet/models/self_backup_export_options.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] encryption_key
     attr_accessor :encryption_key
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] encryption_key_format
     attr_accessor :encryption_key_format
 

data/lib/comet/models/self_backup_target.rb

@@ -28,6 +28,7 @@ module Comet
     # @type [String] encryption_key
     attr_accessor :encryption_key
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] encryption_key_format
     attr_accessor :encryption_key_format
 

data/lib/comet/models/server_config_options.rb

@@ -42,6 +42,7 @@ module Comet
     # @type [Hash{String => Comet::ExternalAuthenticationSource}] external_admin_user_sources
     attr_accessor :external_admin_user_sources
 
+    # The Comet Server can enforce a bandwidth limit based on the target IP address
     # @type [Comet::RatelimitOptions] iprate_limit
     attr_accessor :iprate_limit
 

data/lib/comet/models/server_meta_branding_properties.rb

@@ -28,9 +28,11 @@ module Comet
     # @type [String] image_etag
     attr_accessor :image_etag
 
+    # Colour in RGB hex format (e.g. "#FFFFFF")
     # @type [String] top_color
     attr_accessor :top_color
 
+    # Colour in RGB hex format (e.g. "#FFFFFF")
     # @type [String] accent_color
     attr_accessor :accent_color
 
@@ -49,6 +51,9 @@ module Comet
     # @type [Number] expired_in_seconds
     attr_accessor :expired_in_seconds
 
+    # @type [Array<Comet::ExternalAuthenticationSourceDisplay>] external_authentication_sources
+    attr_accessor :external_authentication_sources
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -64,6 +69,7 @@ module Comet
       @accent_color = ''
       @prune_logs_after_days = 0
       @expired_in_seconds = 0
+      @external_authentication_sources = []
       @unknown_json_fields = {}
     end
 
@@ -116,6 +122,16 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @expired_in_seconds = v
+        when 'ExternalAuthenticationSources'
+          if v.nil?
+            @external_authentication_sources = []
+          else
+            @external_authentication_sources = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @external_authentication_sources[i1] = Comet::ExternalAuthenticationSourceDisplay.new
+              @external_authentication_sources[i1].from_hash(v1)
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -136,6 +152,9 @@ module Comet
       ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads
       ret['PruneLogsAfterDays'] = @prune_logs_after_days
       ret['ExpiredInSeconds'] = @expired_in_seconds
+      unless @external_authentication_sources.nil?
+        ret['ExternalAuthenticationSources'] = @external_authentication_sources
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/server_meta_version_info.rb

@@ -62,6 +62,7 @@ module Comet
     # @type [Number] server_license_feature_set
     attr_accessor :server_license_feature_set
 
+    # Unix timestamp, in seconds.
     # @type [Number] license_valid_until
     attr_accessor :license_valid_until
 
@@ -89,6 +90,7 @@ module Comet
     # @type [Boolean] scheduled_email_thread_last_wake_sent_emails
     attr_accessor :scheduled_email_thread_last_wake_sent_emails
 
+    # This field is available in Comet 21.3.2 and later.
     # @type [Array<Comet::SelfBackupStatistics>] self_backup
     attr_accessor :self_backup
 

data/lib/comet/models/session_key_regenerated_response.rb

@@ -22,6 +22,8 @@ module Comet
     # @type [String] session_key
     attr_accessor :session_key
 
+    # e.g. "admin" or "user"
+    # This field is available in Comet 18.12.3 and later.
     # @type [String] session_type
     attr_accessor :session_type