comet_backup_ruby_sdk 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5ae4e7828fc8520eb623a3d8c5275a8171782f73242bf90eaed2c68b0dff90
-  data.tar.gz: 39e87b95a41e28ef54e5b31b939caae1304c5077106a7807b63a8f4aee0dca3b
+  metadata.gz: bf7e87fdc27ef3763c733ea58dc87801cee0f836a83aae1ef1bb7675a83d4af8
+  data.tar.gz: db96863bb3c92d8d1809b7db280af67c46c10922520ccb3ad3bc27de1d7aed65
 SHA512:
-  metadata.gz: 91e66f38698ff72a1a1eb0ca62b590d5e1bab5067674531c649eb11b842c6dc02ba3339c7495d759ea1a6e5dc726ef36179092d1e87ffb2b5d02bc482a24fbb6
-  data.tar.gz: '0519856cc928ad988ab384341481872dba1b40080b0af8e721f4863e05a600af86d3bf7e445669ea01f3189b64c25196afb47c444a2ce74997d68c0d5f015eea'
+  metadata.gz: 8bab833349a8fd00d7f32392f2fe4d1b796fb7c7299cdab66988b14e307a14ad24a50840aea05586fd37337a7e41fc0be606b1a6b5328e5ed8a78c0327e044df
+  data.tar.gz: 5997a150f92013e65f975872bd0028245fcb3d7f228a4bf81ed790fc0042d1db5227d84b36b9e5869ec83922c9e181d06d6aafae52d9951686a7c99f29d9fdda

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # 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
+- Add new `StreamableEventType` constants (`SEVT_*`) used for tracking Comet Server config changes
+- Add new `StreamerType` constants (`STREAMER_TYPE_*`)
+- Add new `FileOptions` type for configuring the Comet Server to log live events to a file
+- Add new field `AuditFileOptions` to the `Organization` type for configuring per-tenant audit log options
+- Add `Actor` (authenticated user), `ResourceID`, `Timestamp` and `TypeString` fields to the `StreamableEvent` type
+- Deprecate the `UserProfileFragment` type
+- Add extra comments to many types
+
 ## 2023-05-05 v2.8.0
 
 - Based on Comet 23.3.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.8.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.8.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.3.7'
+  APPLICATION_VERSION = '23.6.5'
 
   APPLICATION_VERSION_MAJOR = 23
 
-  APPLICATION_VERSION_MINOR = 3
+  APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 7
+  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
@@ -27,12 +27,16 @@ module Comet
   # AutoRetentionLevel: The system will follow the automatic ruleset for a 'Low Power' device.
   BACKUPJOBAUTORETENTION_LESS_OFTEN = 3
 
+  # If set, will be automatically replaced with one of the other BRANDINGSTYLETYPE_ constants after next server upgrade.
   BRANDINGSTYLETYPE_AUTO_LEGACY = 0
 
+  # Use Comet company branding and colours for all web interface branding
   BRANDINGSTYLETYPE_DEFAULT = 1
 
+  # Use custom branding and colours, with text in the main logo area.
   BRANDINGSTYLETYPE_CUSTOM_TEXT = 2
 
+  # Use custom branding and colours, with a supplied image in the main logo area.
   BRANDINGSTYLETYPE_CUSTOM_LOGO = 3
 
   # ClientBrandingBuildMode: The software client will be custom-built by this Comet Server, allowing custom branding, default server URL, and codesigning.
@@ -81,28 +85,40 @@ module Comet
 
   DESTINATIONTYPE___INVALID = 0
 
+  # S3-compatible, or a specific S3 service such as AWS S3, Wasabi, or iDrive e2
   DESTINATIONTYPE_S3 = 1000
 
+  # SFTP protocol
   DESTINATIONTYPE_SFTP = 1001
 
+  # Local Path
   DESTINATIONTYPE_LOCALCOPY = 1002
 
+  # The Comet Server Storage Role protocol
   DESTINATIONTYPE_COMET = 1003
 
+  # FTP protocol
   DESTINATIONTYPE_FTP = 1004
 
+  # Azure Blob Storage
   DESTINATIONTYPE_AZUREBLOB = 1005
 
+  # Spanned
   DESTINATIONTYPE_SPANNED = 1006
 
+  # Openstack Swift
   DESTINATIONTYPE_SWIFT = 1007
 
+  # Backblaze B2 (Native API)
   DESTINATIONTYPE_B2 = 1008
 
+  # Storj
   DESTINATIONTYPE_STORJ = 1009
 
+  # When defining a schedule via policy, use this option to dynamically select the Storage Vault that was created most recently.
   DESTINATIONTYPE_LATEST = 1100
 
+  # When defining a schedule via policy, use this option to create a schedule for each Storage Vault in the user's profile.
   DESTINATIONTYPE_ALL = 1101
 
   # The Comet Server is still starting up and has not yet checked whether any email reports are due to be sent.
@@ -192,25 +208,25 @@ module Comet
   # Office 365
   ENGINE_BUILTIN_MSOFFICE = 'engine1/winmsofficemail'
 
-  # FtpsModeType
+  # FtpsModeType: Use plain FTP, do not use FTPS.
   FTPS_MODE_PLAINTEXT = 0
 
-  # FtpsModeType
+  # FtpsModeType: Use implicit FTPS, immediately creating a secure SSL/TLS channel before any data is sent. This usually requires a different port on the FTP server. It is generally advised to use explicit mode instead.
   FTPS_MODE_IMPLICIT = 1
 
-  # FtpsModeType
+  # FtpsModeType: Use explicit FTPS, first creating an insecure connection and then upgrading to SSL/TLS using AUTH TLS (like STARTTLS).
   FTPS_MODE_EXPLICIT = 2
 
-  # JobClassification
+  # JobClassification: All BackupJobDetail.Classification fields will fall in the 4xxx range.
   JOB_CLASSIFICATION__MIN = 4000
 
   # JobClassification
   JOB_CLASSIFICATION_UNKNOWN = 4000
 
-  # JobClassification
+  # JobClassification: This is a backup job.
   JOB_CLASSIFICATION_BACKUP = 4001
 
-  # JobClassification
+  # JobClassification: This is a restore job.
   JOB_CLASSIFICATION_RESTORE = 4002
 
   # JobClassification: Automatic or manual retention cleaning pass.
@@ -228,13 +244,13 @@ module Comet
   # JobClassification: Software update
   JOB_CLASSIFICATION_UPDATE = 4007
 
-  # JobClassification
+  # JobClassification: Importing settings from another installed product
   JOB_CLASSIFICATION_IMPORT = 4008
 
   # JobClassification: Repair indexes
   JOB_CLASSIFICATION_REINDEX = 4009
 
-  # JobClassification
+  # JobClassification: Deep Verify
   JOB_CLASSIFICATION_DEEPVERIFY = 4010
 
   # JobClassification: Software uninstall
@@ -243,7 +259,7 @@ module Comet
   # JobClassification
   JOB_CLASSIFICATION__MAX = 4999
 
-  # JobStatus
+  # JobStatus: If the BackupJobDetail.Status field is a 5xxx code, the job has stopped for a successful reason.
   JOB_STATUS_STOP_SUCCESS__MIN = 5000
 
   # JobStatus
@@ -252,7 +268,7 @@ module Comet
   # JobStatus
   JOB_STATUS_STOP_SUCCESS__MAX = 5999
 
-  # JobStatus
+  # JobStatus: If the BackupJobDetail.Status field is a 6xxx code, the job is still running.
   JOB_STATUS_RUNNING__MIN = 6000
 
   # JobStatus: Unused
@@ -267,7 +283,7 @@ module Comet
   # JobStatus
   JOB_STATUS_RUNNING__MAX = 6999
 
-  # JobStatus
+  # JobStatus: If the BackupJobDetail.Status field is a 7xxx code, the job has stopped for an unsuccessful reason.
   JOB_STATUS_FAILED__MIN = 7000
 
   # JobStatus
@@ -306,13 +322,13 @@ module Comet
   # LDAPSecurityMethod
   LDAPSECURITYMETHOD_STARTTLS = 'starttls'
 
-  # MacOSCodesignLevel
+  # MacOSCodesignLevel: Sign only
   MACOSCODESIGN_LEVEL_SIGN = 0
 
-  # MacOSCodesignLevel
+  # MacOSCodesignLevel: Sign and notarize
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE = 1
 
-  # MacOSCodesignLevel
+  # MacOSCodesignLevel: Sign, notarize, and staple
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
 
   MIXED_VIRTUAL_ACCOUNT_TYPE_USER = 1
@@ -430,58 +446,58 @@ module Comet
   # ReplicatorDisplayClass
   REPLICATOR_DISPLAYCLASS_USER = 101
 
-  # RestoreArchiveFormat
+  # RestoreArchiveFormat: Tar file format
   RESTOREARCHIVEFORMAT_TAR = 0
 
-  # RestoreArchiveFormat
+  # RestoreArchiveFormat: Compressed Tar.gz (.tgz) file format
   RESTOREARCHIVEFORMAT_TARGZ = 1
 
-  # RestoreArchiveFormat
+  # RestoreArchiveFormat: Zip file format
   RESTOREARCHIVEFORMAT_ZIP = 2
 
   # RestoreArchiveFormat: SquashFS container
   RESTOREARCHIVEFORMAT_SQFS = 3
 
-  # RestoreArchiveFormat
+  # RestoreArchiveFormat: Compressed Tar.zstd (.tzst) file format
   RESTOREARCHIVEFORMAT_TARZSTD = 4
 
   # RestoreType
   RESTORETYPE_INVALID = -1
 
-  # RestoreType
+  # RestoreType: Restore as files and folders
   RESTORETYPE_FILE = 0
 
-  # RestoreType
+  # RestoreType: Download and reconstruct files, but do not save them (for test purposes)
   RESTORETYPE_NULL = 1
 
-  # RestoreType
+  # RestoreType: Stream each restored file into the target command stdin. The target command may be executed multiple times, once for each restored file.
   RESTORETYPE_PROCESS_PERFILE = 2
 
-  # RestoreType
+  # RestoreType: Stream an archive of each restored file into the target command stdin. The target command will be executed only once.
   RESTORETYPE_PROCESS_ARCHIVE = 3
 
-  # RestoreType
+  # RestoreType: Restore partitions back to the physical disk
   RESTORETYPE_WINDISK = 4
 
-  # RestoreType
+  # RestoreType: Restore selected files and folders as a single compressed archive
   RESTORETYPE_FILE_ARCHIVE = 5
 
-  # RestoreType
+  # RestoreType: Restore selected Office 365 emails, contacts, calendars, and SharePoint/OneDrive data directly to the Office 365 cloud service
   RESTORETYPE_OFFICE365_CLOUD = 6
 
-  # RestoreType
+  # RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup
   RESTORETYPE_VMDK_FILE = 7
 
-  # RestoreType
+  # RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup, downloading and reconstructing files, but without saving them (for test purposes)
   RESTORETYPE_VMDK_FILE_NULL = 8
 
-  # RestoreType
+  # RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup, creating an archive file of all selected files
   RESTORETYPE_VMDK_FILE_ARCHIVE = 9
 
-  # RestoreType
+  # RestoreType: Stream restore as SQL statements into a target MySQL server
   RESTORETYPE_MYSQL = 10
 
-  # RestoreType
+  # RestoreType: Stream restore as T-SQL BACKUP output into a target Microsoft SQL Server
   RESTORETYPE_MSSQL = 11
 
   # RestoreType: Legacy name alias - Prefer to use RESTORETYPE_PROCESS_ARCHIVE since multiple archive file formats are supported within this single RESTORETYPE_
@@ -559,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
@@ -574,66 +590,97 @@ 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.
   SERVICE_CALENDAR = 1
 
+  # 0000 0010. If this value is present in the bitset, then the Contact service is selected for backup.
   SERVICE_CONTACT = 2
 
+  # 0000 0100. If this value is present in the bitset, then the Mail service is selected for backup.
   SERVICE_MAIL = 4
 
+  # 0000 1000. If this value is present in the bitset, then the SharePoint service is selected for backup.
   SERVICE_SHAREPOINT = 8
 
+  # 0001 0000. If this value is present in the bitset, then the OneDrive service is selected for backup.
   SERVICE_ONEDRIVE = 16
 
   # DefaultSettingMode
@@ -663,27 +710,111 @@ module Comet
   # StreamableEventType
   SEVT__MIN = 4000
 
-  # StreamableEventType: This event is emitted when the webhook is registered, or when the server starts up. The Data associated is ServerMetaVersionInfo
+  # StreamableEventType: New websocket connection. Data is typically ServerMetaVersionInfo
   SEVT_META_HELLO = 4000
 
-  # StreamableEventType: Data is the profile object
+  # StreamableEventType: User created. Data is the profile object
   SEVT_ACCOUNT_NEW = 4100
 
-  # StreamableEventType: Data is the username
+  # StreamableEventType: User deleted
   SEVT_ACCOUNT_REMOVED = 4101
 
-  # StreamableEventType: Data is the profile object
+  # StreamableEventType: User updated. Data is the profile object
   SEVT_ACCOUNT_UPDATED = 4102
 
-  # StreamableEventType
+  # StreamableEventType: User authentication succeeded. Only emitted for non-session requests. Resource is the requested path
+  SEVT_ACCOUNT_LOGIN = 4103
+
+  # StreamableEventType: User authentication failed. Only emitted if the user exists. Resource is the requested path
+  SEVT_ACCOUNT_LOGIN_FAILED = 4104
+
+  # StreamableEventType: User session token created. Data is the session object
+  SEVT_ACCOUNT_SESSION_START = 4105
+
+  # StreamableEventType: User session token deleted
+  SEVT_ACCOUNT_SESSION_REVOKE = 4106
+
+  # StreamableEventType: User session token expired
+  SEVT_ACCOUNT_SESSION_EXPIRE = 4107
+
+  # StreamableEventType: Admin created. Data is the profile object
+  SEVT_ACCOUNT_ADMIN_NEW = 4150
+
+  # StreamableEventType: Admin deleted
+  SEVT_ACCOUNT_ADMIN_REMOVED = 4151
+
+  # StreamableEventType: Admin updated
+  SEVT_ACCOUNT_ADMIN_UPDATED = 4152
+
+  # StreamableEventType: Admin authentication suceeded. Only emitted for non-session requests. Resource is the requested path
+  SEVT_ACCOUNT_ADMIN_LOGIN = 4153
+
+  # StreamableEventType: Admin authentication failed. Only emitted if the admin exists. Resource is the request path
+  SEVT_ACCOUNT_ADMIN_LOGIN_FAILED = 4154
+
+  # StreamableEventType: Admin session token created. Data is the session object
+  SEVT_ACCOUNT_ADMIN_SESSION_START = 4155
+
+  # StreamableEventType: Admin session token deleted
+  SEVT_ACCOUNT_ADMIN_SESSION_REVOKE = 4156
+
+  # StreamableEventType: Admin session token expired
+  SEVT_ACCOUNT_ADMIN_SESSION_EXPIRE = 4157
+
+  # StreamableEventType: New backup job started. Data is the job object
   SEVT_JOB_NEW = 4200
 
-  # StreamableEventType
+  # StreamableEventType: Backup job completed. Data is the job object
   SEVT_JOB_COMPLETED = 4201
 
-  # StreamableEventType: Data is the string bucket ref
+  # StreamableEventType: New bucket created
   SEVT_BUCKET_NEW = 4300
 
+  # StreamableEventType: Bucket deleted
+  SEVT_BUCKET_REMOVED = 4301
+
+  # StreamableEventType: Server started
+  SEVT_SERVER_STARTED = 4400
+
+  # StreamableEventType: Server restarting (pending)
+  SEVT_SERVER_RESTARTED = 4401
+
+  # StreamableEventType: Server shutting down (pending)
+  SEVT_SERVER_SHUTDOWN = 4402
+
+  # StreamableEventType: Server configuration has been updated. Data is the server config object
+  SEVT_SERVER_UPDATED = 4403
+
+  # StreamableEventType: Tenant created. Data is the tenant object
+  SEVT_TENANT_NEW = 4500
+
+  # StreamableEventType: Tenant deleted
+  SEVT_TENANT_REMOVED = 4501
+
+  # StreamableEventType: Tenant updated. Data is the tenant object
+  SEVT_TENANT_UPDATED = 4502
+
+  # StreamableEventType: Policy created. Data is the policy object
+  SEVT_POLICY_NEW = 4600
+
+  # StreamableEventType: Policy deleted
+  SEVT_POLICY_REMOVED = 4601
+
+  # StreamableEventType: Policy updated. Data is the policy object
+  SEVT_POLICY_UPDATED = 4602
+
+  # StreamableEventType: Device created. Data is device object
+  SEVT_DEVICE_NEW = 4700
+
+  # StreamableEventType: Device deleted
+  SEVT_DEVICE_REMOVED = 4701
+
+  # StreamableEventType: Device live connection started
+  SEVT_DEVICE_LIVE_CONNECT = 4702
+
+  # StreamableEventType: Device live connection ended
+  SEVT_DEVICE_LIVE_DISCONNECT = 4703
+
   # StreamableEventType
   SEVT__MAX = 4999
 
@@ -774,6 +905,24 @@ module Comet
   # StoredObjectType
   STOREDOBJECTTYPE_VHDX_MBR_PARTITION = 'vhdxpartitionmbr'
 
+  # StreamLevel: Event data contains full data types
+  STREAM_LEVEL_FULL = 'full'
+
+  # StreamLevel: Event data contains nothing
+  STREAM_LEVEL_NONE = 'none'
+
+  # StreamerType
+  STREAMER_TYPE_INTERNAL = 'internal'
+
+  # StreamerType
+  STREAMER_TYPE_WEBHOOK = 'webhook'
+
+  # StreamerType
+  STREAMER_TYPE_WEBSOCKET = 'websocket'
+
+  # StreamerType
+  STREAMER_TYPE_FILE = 'file'
+
   # If an API response returns in failure, but it includes this value in the CometAPIResponseMessage->Message parameter, it indicates that your supplied authentication was insufficient, and you must supply additional two-factor authentication credentials.
   TOTPREQUIRED_ERROR = 'ERR_TOTP_REQUIRED'
 
@@ -825,7 +974,7 @@ 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..
+  # 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
   WINDOWSCODESIGN_METHOD_AUTO = 0
 

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