comet_backup_ruby_sdk 1.10.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1351a43776da0134fbbc0f29301c07bf21684f24fad024a2b24311c6c5f1993b
-  data.tar.gz: a21014914d06619f590dce35f990036d4369a76287a6d654a5565fb373ebf003
+  metadata.gz: fd41ef7f0ce9f54555af78b82719b073f2bdedb8a1fac79da00fcfff58a82aae
+  data.tar.gz: aca0a1786bd48d8ed2f61a080c02fda37ac8d6b2bffc75421c3a37ea51c993a3
 SHA512:
-  metadata.gz: 6c1267509de43041f58a02f46edd7aeb2d57eb7a464b5ba018d86398132bff04f94a5cc75bd6f04942a04fdd08a3a7e558c31cea467aae5090f192a75cb11a07
-  data.tar.gz: 8f5b8df8f2d55019e6ca2efd9ad5025d5d31e9bb00babd2fc82c3aeb3a434f4e6f790385cd8643170b4eb69ba2f30cb6d6fc4f59460f5177865f01678ec0ac08
+  metadata.gz: 34d97b5cf4cd1bd01ee04602688b5f5355e2cbe3b5667aef32973d0f7298178cef7fb3678f4a26ecbd524cc88a03ebcce1837398be4ad1bb9e6656508ce53c8e
+  data.tar.gz: 2c205b4ead8426f4e380977510b99069a74d9233ede9d1dce74c6ca43bede641784c5edd275a9a863bfd3a938d0a40484fa87155a0d53e0bd69656723d0fc919

data/CHANGELOG.md

@@ -1,6 +1,32 @@
 # CHANGELOG
 
-## 2021-11-24 v3.18.0
+## 2022-05-10 v1.13.0
+- Based on 22.3.5
+- Add new `RestrictRuntime`, `FromTime`, `ToTime`, `RestrictDays`, `DaysSelect` types to ScheduleConfig to add time and day restrictions in a hourly schedule.
+- Add new `TotalVmCount` to `BackupJobDetail` API.
+- Add new fields to `MacOSCodeSignProperties` to support code signing.
+- Add new `ForceUpgradeRunning`, `ApplyDeviceFilter`, and `DeviceFilter` fields to `UpdateCampaign` types to support sending a bulk upgrade to a custom query of users
+- Add new `AdminBrandingGenerateClientSpkDsm6` and `AdminBrandingGenerateClientSpkDsm7` APIs and associated types for generating and downloading Synology SPKs
+- Add new `PathAppIconImage` field to branding options types to support branding of the app icon when installed in Synology's Package Center (and other software managers)
+- Add new constants for VMDK single file restore
+
+## 2022-01-28 v1.12.0
+- Based on 21.12.4
+- Add `AdminStoragePingDestination` API to perform a server-side Test Connections action when configuring Storage Role
+- Add `DestinationSize*` on `BackupJobDetail` struct, to track Storage Vault size measurements taken as part of jobs
+- Add `HasLicense` on `Office365MixedVirtualAccount` struct, and add `TotalLicensedMailsCount` and `TotalUnlicensedMailsCount` on `BackupJobDetail` struct, to track Office 365 license usage
+- Add `AdminWebAuthnRegistration` new `Type` field and `WEBAUTHN_DEVICE_TYPE` constants, to determine the type of hardware WebAuthn device
+- Add deprecation comments to U2F types (use WebAuthn instead), to `B2DestinationLocation.MaxConnections`, and to `Office365CustomSetting` (use Office365CustomSettingV2 instead)
+- Fix an issue with wrong array types in `WebAuthnPublicKeyCredentialCreationOptions` and `WebAuthnPublicKeyCredentialRequestOptions`
+- Fix an issue with wrong values for some `STOREDOBJECTTYPE_` constants related to Office 365
+- Fix an issue with executable permissions on some files
+
+## 2021-12-22 v1.11.0
+- Based on 21.12.1
+- Add `AdminAccountWebauthnRegistration` endpoint for new WebAuthn support.
+- Deprecate `AdminAccountU2fSubmitChallenge` as U2F is ending browser support in February 2022.
+
+## 2021-11-24 v1.10.0
 - Based on 21.9.12
 - Add support for Thai and Danish localizations
 - Add From and To fields to the EmailReportGenerated API

data/Gemfile.lock

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

data/RELEASING.md

@@ -1,6 +1,6 @@
 # Procedure for releasing gem package updates
 
-0. As a cygwin user, with docker installed; `docker run -it -v "c://cygwin64/$PWD":/app -w /app ruby:2.7 bash` will get you with a suitable ruby environment for testing/building and releasing this package9.
+0. As a cygwin user, with docker installed; `docker run -it -v "$(cygpath -w "$PWD"):/app" -w /app ruby:2.7 bash` will get you with a suitable ruby environment for testing/building and releasing this package9.
 1. All tests passing
 2. Update changelog in `CHANGELOG.md`
 3. Update version number in `comet_backup_ruby_sdk.gemspec`

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       = '1.10.0'
+  spec.version       = '1.13.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/api_response_error.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/comet_server.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -96,7 +96,7 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     #
-    # @param [String] self_address (Optional) External URL of this server (used for U2F AppID)
+    # @param [String] self_address (Optional) External URL of this server
     # @return [Comet::SessionKeyRegeneratedResponse]
     def admin_account_session_start(self_address = nil)
       submit_params = {}
@@ -166,6 +166,9 @@ module Comet
     # AdminAccountU2fRequestRegistrationChallenge
     #
     # Register a new FIDO U2F token.
+    # Browser support for U2F is ending in February 2022. WebAuthn is backwards
+    # compatible with U2F keys, and Comet will automatically migrate existing U2F keys
+    # to allow their use with the WebAuthn endpoints.
     #
     # You must supply administrator authentication credentials to use this API.
     #
@@ -188,6 +191,9 @@ module Comet
     # AdminAccountU2fSubmitChallengeResponse
     #
     # Register a new FIDO U2F token.
+    # Browser support for U2F is ending in February 2022. WebAuthn is backwards
+    # compatible with U2F keys, and Comet will automatically migrate existing U2F keys
+    # to allow their use with the WebAuthn endpoints.
     #
     # You must supply administrator authentication credentials to use this API.
     #
@@ -245,6 +251,58 @@ module Comet
       ret
     end
 
+    # AdminAccountWebauthnRequestRegistrationChallenge
+    #
+    # Register a new FIDO2 WebAuthn token.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] self_address External URL of this server, used as WebAuthn ID
+    # @return [Comet::WebAuthnRegistrationChallengeResponse]
+    def admin_account_webauthn_request_registration_challenge(self_address)
+      submit_params = {}
+      raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+      submit_params['SelfAddress'] = self_address
+
+      body = perform_request('api/v1/admin/account/webauthn/request-registration-challenge', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::WebAuthnRegistrationChallengeResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountWebauthnSubmitChallengeResponse
+    #
+    # Register a new FIDO2 WebAuthn token.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] self_address External URL of this server, used as WebAuthn ID
+    # @param [String] challenge_id Associated value from AdminAccountWebAuthnRequestRegistrationChallenge API
+    # @param [String] credential JSON-encoded credential
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_webauthn_submit_challenge_response(self_address, challenge_id, credential)
+      submit_params = {}
+      raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+      submit_params['SelfAddress'] = self_address
+      raise TypeError, "'challenge_id' expected String, got #{challenge_id.class}" unless challenge_id.is_a? String
+
+      submit_params['ChallengeID'] = challenge_id
+      raise TypeError, "'credential' expected String, got #{credential.class}" unless credential.is_a? String
+
+      submit_params['Credential'] = credential
+
+      body = perform_request('api/v1/admin/account/webauthn/submit-challenge-response', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminAddUser
     #
     # Add a new user account.
@@ -493,6 +551,52 @@ module Comet
       perform_request('api/v1/admin/branding/generate-client/macos-x86_64', submit_params)
     end
 
+    # AdminBrandingGenerateClientSpkDsm6
+    #
+    # Download software (Synology SPK for DSM 6).
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_spk_dsm_6(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('api/v1/admin/branding/generate-client/spk-dsm6', submit_params)
+    end
+
+    # AdminBrandingGenerateClientSpkDsm7
+    #
+    # Download software (Synology SPK for DSM 7).
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_spk_dsm_7(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('api/v1/admin/branding/generate-client/spk-dsm7', submit_params)
+    end
+
     # AdminBrandingGenerateClientTest
     #
     # Check if a software download is available.
@@ -770,8 +874,10 @@ module Comet
 
     # AdminCreateInstallToken
     #
-    # Create token for silent installation (Windows only).
+    # Create token for silent installation.
+    # Currently only supported for Windows & macOS only
     # Provide the installation token to silently install the client on windows `install.exe /TOKEN=<installtoken>`
+    # Provide the installation token to silently install the client on Mac OS `sudo launchctl setenv BACKUP_APP_TOKEN "installtoken" && sudo /usr/sbin/installer -allowUntrusted -pkg "Comet Backup.pkg" -target /`
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -1573,9 +1679,10 @@ module Comet
     # @param [String] target_id The live connection GUID
     # @param [String] destination The Storage Vault ID
     # @param [String] snapshot_id The selected backup job snapshot
-    # @param [String] tree_id (Optional) Browse objects inside subdirectory of backup snapshot
+    # @param [String] tree_id (Optional) Browse objects inside subdirectory of backup snapshot. If it is for VMDK single file restore, it should be the disk image's subtree ID.
+    # @param [Comet::VMDKSnapshotViewOptions] options (Optional) Request a list of stored objects in vmdk file
     # @return [Comet::DispatcherStoredObjectsResponse]
-    def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil)
+    def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil, options = nil)
       submit_params = {}
       raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
 
@@ -1591,6 +1698,11 @@ module Comet
 
         submit_params['TreeID'] = tree_id
       end
+      unless options.nil?
+        raise TypeError, "'options' expected Comet::VMDKSnapshotViewOptions, got #{options.class}" unless options.is_a? Comet::VMDKSnapshotViewOptions
+
+        submit_params['Options'] = options.to_json
+      end
 
       body = perform_request('api/v1/admin/dispatcher/request-stored-objects', submit_params)
       json_body = JSON.parse body
@@ -3442,6 +3554,31 @@ module Comet
       ret
     end
 
+    # AdminStoragePingDestination
+    #
+    # Ping a storage destination.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    # This API requires the Storage Role to be enabled.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
+    #
+    # @param [Comet::DestinationLocation] extra_data The destination location settings
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_storage_ping_destination(extra_data)
+      submit_params = {}
+      raise TypeError, "'extra_data' expected Comet::DestinationLocation, got #{extra_data.class}" unless extra_data.is_a? Comet::DestinationLocation
+
+      submit_params['ExtraData'] = extra_data.to_json
+
+      body = perform_request('api/v1/admin/storage/ping-destination', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminStorageRegisterBucket
     #
     # Create a new bucket.
@@ -3593,7 +3730,7 @@ module Comet
 
       ret_error = Comet::CometAPIResponseMessage.new
       ret_error.from_hash(obj)
-      raise Comet::APIResponseError.new(ret_error), 'Comet API response status was not OK'
+      raise Comet::APIResponseError.new(ret_error)
     end
 
     # Perform a synchronous HTTP request.
@@ -3630,7 +3767,7 @@ module Comet
 
       form_params = []
       params.each do |k, v|
-        form_params.append [k, v, { :filename => k }]
+        form_params.append [k, v, {:filename => k}]
       end
       req.set_form(form_params, 'multipart/form-data')
 

data/lib/comet/definitions.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -9,6 +9,18 @@
 
 module Comet
 
+  # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
+  BACKUPJOBAUTORETENTION_AUTOMATIC = 0
+
+  # AutoRetentionLevel: The system will run a Retention Pass after every single backup job. This is more system-intensive, but is the most responsive at freeing storage space.
+  BACKUPJOBAUTORETENTION_IMMEDIATE = 1
+
+  # AutoRetentionLevel: The system will follow the automatic ruleset for a 'High Power' device.
+  BACKUPJOBAUTORETENTION_MORE_OFTEN = 2
+
+  # AutoRetentionLevel: The system will follow the automatic ruleset for a 'Low Power' device.
+  BACKUPJOBAUTORETENTION_LESS_OFTEN = 3
+
   # JobClassification:
   JOB_CLASSIFICATION__MIN = 4000
 
@@ -144,6 +156,8 @@ module Comet
   # FtpsModeType:
   FTPS_MODE_EXPLICIT = 2
 
+  INSTALLER_METADATA_FILE = 'installer.json'
+
   # Severity:
   SEVERITY_INFO = 'I'
 
@@ -197,6 +211,15 @@ module Comet
   # RestoreType:
   RESTORETYPE_OFFICE365_CLOUD = 6
 
+  # RestoreType:
+  RESTORETYPE_VMDK_FILE = 7
+
+  # RestoreType:
+  RESTORETYPE_VMDK_FILE_NULL = 8
+
+  # RestoreType:
+  RESTORETYPE_VMDK_FILE_ARCHIVE = 9
+
   # RestoreType: RESTORETYPE_PROCESS_ARCHIVE
   RESTORETYPE_PROCESS_TARBALL = 3
 
@@ -360,22 +383,22 @@ module Comet
   STOREDOBJECTTYPE_WINEFS = 'winefs'
 
   # StoredObjectType: "file"
-  STOREDOBJECTTYPE_EMAILMESSAGE = 'emailmessage\"'
+  STOREDOBJECTTYPE_EMAILMESSAGE = 'emailmessage'
 
   # StoredObjectType: "dir"
-  STOREDOBJECTTYPE_EMAILFOLDER = 'mailfolder\"'
+  STOREDOBJECTTYPE_EMAILFOLDER = 'mailfolder'
 
   # StoredObjectType: "file"
-  STOREDOBJECTTYPE_OFFICECONTACT = 'contact\"'
+  STOREDOBJECTTYPE_OFFICECONTACT = 'contact'
 
   # StoredObjectType: "dir"
-  STOREDOBJECTTYPE_OFFICECONTACTFOLDER = 'contactfolder\"'
+  STOREDOBJECTTYPE_OFFICECONTACTFOLDER = 'contactfolder'
 
   # StoredObjectType: "file"
-  STOREDOBJECTTYPE_OFFICECALENDAREVENT = 'calendarevent\"'
+  STOREDOBJECTTYPE_OFFICECALENDAREVENT = 'calendarevent'
 
   # StoredObjectType: "dir"
-  STOREDOBJECTTYPE_OFFICECALENDAR = 'calendar\"'
+  STOREDOBJECTTYPE_OFFICECALENDAR = 'calendar'
 
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITE = 'mssite'
@@ -392,6 +415,18 @@ module Comet
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY = 'mssitelistdriveentity'
 
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_FILE = 'vmdkfile'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_DIRECTORY = 'vmdkdir'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_WINEFS = 'vmdkwinefs'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_SYMLINK = 'vmdksymlink'
+
   # ExtraFileExclusionOSRestriction:
   OS_ANY = 0
 
@@ -425,18 +460,18 @@ module Comet
   # DefaultSettingMode:
   SETTING_ENFORCED_OFF = 4
 
-  # sz.LanguageCode:
+  # LanguageCode:
   DEFAULT_LANGUAGE = 'en_US'
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.9.12'
+  APPLICATION_VERSION = '22.3.5'
 
-  APPLICATION_VERSION_MAJOR = 21
+  APPLICATION_VERSION_MAJOR = 22
 
-  APPLICATION_VERSION_MINOR = 9
+  APPLICATION_VERSION_MINOR = 3
 
-  APPLICATION_VERSION_REVISION = 12
+  APPLICATION_VERSION_REVISION = 5
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -444,6 +479,12 @@ module Comet
 
   PASSWORD_FORMAT_PLAINTEXT = 0
 
+  UNKNOWN_DEVICE_ERROR = 'ERR_UNKNOWN_DEVICE'
+
+  TOTPREQUIRED_ERROR = 'ERR_TOTP_REQUIRED'
+
+  UNSUPPORT_VMDK_FILE_SYSTEM = 'ERR_UNSUPPORT_VMDK_FILE_SYSTEM'
+
   EMAIL_WORKER_STATE_NOT_STARTED = 0
 
   EMAIL_WORKER_STATE_STARTED = 1
@@ -454,9 +495,26 @@ module Comet
 
   EMAIL_WORKER_STATE_SENDING = 4
 
-  UNKNOWN_DEVICE_ERROR = 'ERR_UNKNOWN_DEVICE'
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__UNKNOWN = 0
 
-  TOTPREQUIRED_ERROR = 'ERR_TOTP_REQUIRED'
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__HARDWARE_TOKEN = 1
+
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__ANDROID = 2
+
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__APPLE = 3
+
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__TPM_GENERIC = 4
+
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__TPM_WINDOWS = 5
+
+  # WebAuthnDeviceType:
+  WEBAUTHN_DEVICE_TYPE__TPM_LINUX = 6
 
   # UpdateStatus:
   UPDATESTATUS_NOT_SEEN = 0

data/lib/comet/models/add_bucket_response_message.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/admin_account_properties_response.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/admin_email_options.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/admin_resource_response.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT

data/lib/comet/models/admin_security_options.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -27,11 +27,19 @@ module Comet
     attr_accessor :allow_password_and_totplogin
 
     # @type [Boolean] allow_password_and_u2flogin
+    # @deprecated This member has been deprecated since Comet version 21.12.0
     attr_accessor :allow_password_and_u2flogin
 
+    # @type [Boolean] allow_password_and_web_authn_login
+    attr_accessor :allow_password_and_web_authn_login
+
     # @type [Array<Comet::AdminU2FRegistration>] u2fregistrations
+    # @deprecated This member has been deprecated since Comet version 21.12.0
     attr_accessor :u2fregistrations
 
+    # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
+    attr_accessor :web_authn_registrations
+
     # @type [Number] totpkey_encryption_format
     attr_accessor :totpkey_encryption_format
 
@@ -52,6 +60,7 @@ module Comet
       @password_format = 0
       @password = ''
       @u2fregistrations = []
+      @web_authn_registrations = []
       @totpkey_encryption_format = 0
       @totpkey = ''
       @ipwhitelist = ''
@@ -85,6 +94,8 @@ module Comet
           @allow_password_and_totplogin = v
         when 'AllowPasswordAndU2FLogin'
           @allow_password_and_u2flogin = v
+        when 'AllowPasswordAndWebAuthnLogin'
+          @allow_password_and_web_authn_login = v
         when 'U2FRegistrations'
           if v.nil?
             @u2fregistrations = []
@@ -95,6 +106,16 @@ module Comet
               @u2fregistrations[i1].from_hash(v1)
             end
           end
+        when 'WebAuthnRegistrations'
+          if v.nil?
+            @web_authn_registrations = []
+          else
+            @web_authn_registrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @web_authn_registrations[i1] = Comet::AdminWebAuthnRegistration.new
+              @web_authn_registrations[i1].from_hash(v1)
+            end
+          end
         when 'TOTPKeyEncryptionFormat'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -121,9 +142,13 @@ module Comet
       ret['AllowPasswordLogin'] = @allow_password_login
       ret['AllowPasswordAndTOTPLogin'] = @allow_password_and_totplogin
       ret['AllowPasswordAndU2FLogin'] = @allow_password_and_u2flogin
+      ret['AllowPasswordAndWebAuthnLogin'] = @allow_password_and_web_authn_login
       unless @u2fregistrations.nil?
         ret['U2FRegistrations'] = @u2fregistrations
       end
+      unless @web_authn_registrations.nil?
+        ret['WebAuthnRegistrations'] = @web_authn_registrations
+      end
       unless @totpkey_encryption_format.nil?
         ret['TOTPKeyEncryptionFormat'] = @totpkey_encryption_format
       end

data/lib/comet/models/admin_u2fregistration.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
@@ -13,6 +13,7 @@ require 'json'
 module Comet
 
   # AdminU2FRegistration is a typed class wrapper around the underlying Comet Server API data structure.
+  # @deprecated This type has been deprecated since Comet version 21.12.0
   class AdminU2FRegistration
 
     # @type [String] description

data/lib/comet/models/admin_user_permissions.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby --enable-frozen-string-literal
 #
-# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT