comet_backup_ruby_sdk 2.10.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf7e87fdc27ef3763c733ea58dc87801cee0f836a83aae1ef1bb7675a83d4af8
-  data.tar.gz: db96863bb3c92d8d1809b7db280af67c46c10922520ccb3ad3bc27de1d7aed65
+  metadata.gz: 3e58708772fc811caf320d5e37daead88298a9ef573d721055a3970bcf31d3bc
+  data.tar.gz: 70167999c8a0622c11845204871ef6c36679f73b506dc1b260fd0006a71a07ae
 SHA512:
-  metadata.gz: 8bab833349a8fd00d7f32392f2fe4d1b796fb7c7299cdab66988b14e307a14ad24a50840aea05586fd37337a7e41fc0be606b1a6b5328e5ed8a78c0327e044df
-  data.tar.gz: 5997a150f92013e65f975872bd0028245fcb3d7f228a4bf81ed790fc0042d1db5227d84b36b9e5869ec83922c9e181d06d6aafae52d9951686a7c99f29d9fdda
+  metadata.gz: 9c13573fc5191bcba1631a35a0a6b55ab1d8543cbe14c3260eda4991c5432c23a3613d7af77ecee2fe6e789c91b08d949cd61fe924f7521b9ac9778d14b62a07
+  data.tar.gz: 2a59d690d766d51a456d6cbf833287483c58630967f120433d1990afa7eeafb331e027ea7f0ae8b1e3ccd5572e7c3af5b0dd8d5d52a76e2c097c9d9900ca1814

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 2023-08-09 v2.12.0
+
+- Based on Comet 23.6.9
+- Added WebDAV `DestinationLocation`
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.10.0)
+    comet_backup_ruby_sdk (2.12.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.10.0'
+  spec.version       = '2.12.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.
@@ -2188,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.
@@ -3982,7 +4100,6 @@ module Comet
     #
     # 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 top-level administrator accounts, not for Tenant administrator accounts.
     #
     # @param [Comet::DestinationLocation] extra_data The destination location settings

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.6.5'
+  APPLICATION_VERSION = '23.6.9'
 
   APPLICATION_VERSION_MAJOR = 23
 
   APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 5
+  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
@@ -115,6 +115,8 @@ module Comet
   # Storj
   DESTINATIONTYPE_STORJ = 1009
 
+  DESTINATIONTYPE_WEBDAV = 1010
+
   # When defining a schedule via policy, use this option to dynamically select the Storage Vault that was created most recently.
   DESTINATIONTYPE_LATEST = 1100
 
@@ -390,6 +392,15 @@ 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
 
@@ -404,6 +415,9 @@ module Comet
   # RemoteServerType
   REMOTESERVER_LDAP = 'ldap'
 
+  # RemoteServerType
+  REMOTESERVER_OIDC = 'oidc'
+
   # RemoteServerType
   REMOTESERVER_B2 = 'b2'
 
@@ -974,8 +988,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_user_permissions.rb

@@ -33,6 +33,9 @@ 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
 
@@ -103,6 +106,8 @@ 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'
@@ -158,6 +163,9 @@ 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

data/lib/comet/models/branding_options.rb

@@ -107,8 +107,8 @@ 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

data/lib/comet/models/branding_properties.rb

@@ -84,8 +84,8 @@ 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

data/lib/comet/models/destination_config.rb

@@ -183,6 +183,10 @@ module Comet
     # @type [Comet::B2DestinationLocation] b2
     attr_accessor :b2
 
+    # This field is available in Comet 23.6.9 and later.
+    # @type [Comet::WebDavDestinationLocation] web_dav
+    attr_accessor :web_dav
+
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
@@ -286,6 +290,7 @@ module Comet
       @localcopy_win_smbpassword_format = 0
       @swift = Comet::SwiftDestinationLocation.new
       @b2 = Comet::B2DestinationLocation.new
+      @web_dav = Comet::WebDavDestinationLocation.new
       @storj = Comet::StorjDestinationLocation.new
       @span_targets = []
       @encryption_key_encryption_method = 0
@@ -509,6 +514,9 @@ module Comet
         when 'B2'
           @b2 = Comet::B2DestinationLocation.new
           @b2.from_hash(v)
+        when 'WebDav'
+          @web_dav = Comet::WebDavDestinationLocation.new
+          @web_dav.from_hash(v)
         when 'Storj'
           @storj = Comet::StorjDestinationLocation.new
           @storj.from_hash(v)
@@ -607,6 +615,7 @@ module Comet
       ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
       ret['Swift'] = @swift
       ret['B2'] = @b2
+      ret['WebDav'] = @web_dav
       ret['Storj'] = @storj
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots

data/lib/comet/models/destination_location.rb

@@ -163,6 +163,10 @@ module Comet
     # @type [Comet::B2DestinationLocation] b2
     attr_accessor :b2
 
+    # This field is available in Comet 23.6.9 and later.
+    # @type [Comet::WebDavDestinationLocation] web_dav
+    attr_accessor :web_dav
+
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
@@ -227,6 +231,7 @@ module Comet
       @localcopy_win_smbpassword_format = 0
       @swift = Comet::SwiftDestinationLocation.new
       @b2 = Comet::B2DestinationLocation.new
+      @web_dav = Comet::WebDavDestinationLocation.new
       @storj = Comet::StorjDestinationLocation.new
       @span_targets = []
       @unknown_json_fields = {}
@@ -399,6 +404,9 @@ module Comet
         when 'B2'
           @b2 = Comet::B2DestinationLocation.new
           @b2.from_hash(v)
+        when 'WebDav'
+          @web_dav = Comet::WebDavDestinationLocation.new
+          @web_dav.from_hash(v)
         when 'Storj'
           @storj = Comet::StorjDestinationLocation.new
           @storj.from_hash(v)
@@ -465,6 +473,7 @@ module Comet
       ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
       ret['Swift'] = @swift
       ret['B2'] = @b2
+      ret['WebDav'] = @web_dav
       ret['Storj'] = @storj
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots

data/lib/comet/models/external_authentication_source.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)
@@ -156,6 +163,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/external_authentication_source_display.rb

@@ -0,0 +1,82 @@
+# 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
+
+  # ExternalAuthenticationSourceDisplay is a typed class wrapper around the underlying Comet Server API data structure.
+  class ExternalAuthenticationSourceDisplay
+
+    # @type [String] display_name
+    attr_accessor :display_name
+
+    # @type [String] login_start_url
+    attr_accessor :login_start_url
+
+    # @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 = ''
+      @login_start_url = ''
+      @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 'LoginStartURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @login_start_url = 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
+      ret['LoginStartURL'] = @login_start_url
+      @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/external_authentication_source_response.rb

@@ -0,0 +1,99 @@
+# 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
+
+  # ExternalAuthenticationSourceResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class ExternalAuthenticationSourceResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [String] id
+    attr_accessor :id
+
+    # @type [Comet::ExternalAuthenticationSource] source
+    attr_accessor :source
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @id = ''
+      @source = Comet::ExternalAuthenticationSource.new
+      @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 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'ID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @id = v
+        when 'Source'
+          @source = Comet::ExternalAuthenticationSource.new
+          @source.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['ID'] = @id
+      ret['Source'] = @source
+      @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/oidc_claim.rb

@@ -0,0 +1,84 @@
+# 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
+
+  # OidcClaim is a typed class wrapper around the underlying Comet Server API data structure.
+  class OidcClaim
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [String] value
+    attr_accessor :value
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @name = ''
+      @value = ''
+      @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 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'Value'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @value = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Name'] = @name
+      unless @value.nil?
+        ret['Value'] = @value
+      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/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/private_branding_properties.rb

@@ -60,8 +60,8 @@ 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

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,11 +41,14 @@ 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

data/lib/comet/models/server_meta_branding_properties.rb

@@ -51,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
 
@@ -66,6 +69,7 @@ module Comet
       @accent_color = ''
       @prune_logs_after_days = 0
       @expired_in_seconds = 0
+      @external_authentication_sources = []
       @unknown_json_fields = {}
     end
 
@@ -118,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
@@ -138,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/user_policy.rb

@@ -99,6 +99,9 @@ module Comet
     # @type [Boolean] prevent_protected_item_retention
     attr_accessor :prevent_protected_item_retention
 
+    # @type [Boolean] allow_edit_object_lock_retention
+    attr_accessor :allow_edit_object_lock_retention
+
     # @type [Hash{String => Comet::SourceConfig}] default_sources
     attr_accessor :default_sources
 
@@ -230,6 +233,8 @@ module Comet
           @enforce_storage_vault_retention = v
         when 'PreventProtectedItemRetention'
           @prevent_protected_item_retention = v
+        when 'AllowEditObjectLockRetention'
+          @allow_edit_object_lock_retention = v
         when 'DefaultSources'
           @default_sources = {}
           if v.nil?
@@ -322,6 +327,7 @@ module Comet
       ret['DefaultStorageVaultRetention'] = @default_storage_vault_retention
       ret['EnforceStorageVaultRetention'] = @enforce_storage_vault_retention
       ret['PreventProtectedItemRetention'] = @prevent_protected_item_retention
+      ret['AllowEditObjectLockRetention'] = @allow_edit_object_lock_retention
       ret['DefaultSources'] = @default_sources
       ret['DefaultSourcesBackupRules'] = @default_sources_backup_rules
       ret['DefaultSourcesWithOSRestriction'] = @default_sources_with_osrestriction

data/lib/comet/models/web_dav_destination_location.rb

@@ -0,0 +1,113 @@
+# 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
+
+  # WebDavDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 23.6.9 and later.
+  class WebDavDestinationLocation
+
+    # The URL of the WebDAV server, including http/https and any custom port
+    # @type [String] dav_server
+    attr_accessor :dav_server
+
+    # The username for logging in to the WebDAV server
+    # @type [String] user_name
+    attr_accessor :user_name
+
+    # The password for logging in to the WebDAV server
+    # @type [String] access_key
+    attr_accessor :access_key
+
+    # The target directory path within the WebDAV server
+    # @type [String] path
+    attr_accessor :path
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @dav_server = ''
+      @user_name = ''
+      @access_key = ''
+      @path = ''
+      @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 'DavServer'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @dav_server = v
+        when 'UserName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @user_name = v
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_key = v
+        when 'Path'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @dav_server.nil?
+        ret['DavServer'] = @dav_server
+      end
+      unless @user_name.nil?
+        ret['UserName'] = @user_name
+      end
+      unless @access_key.nil?
+        ret['AccessKey'] = @access_key
+      end
+      unless @path.nil?
+        ret['Path'] = @path
+      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/windows_code_sign_properties.rb

@@ -32,8 +32,8 @@ 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

data/lib/comet_backup_ruby_sdk.rb

@@ -70,6 +70,8 @@ require_relative 'comet/models/email_report_config'
 require_relative 'comet/models/email_report_generated_preview'
 require_relative 'comet/models/email_reporting_option'
 require_relative 'comet/models/external_authentication_source'
+require_relative 'comet/models/external_authentication_source_display'
+require_relative 'comet/models/external_authentication_source_response'
 require_relative 'comet/models/external_ldapauthentication_source_server'
 require_relative 'comet/models/external_ldapauthentication_source_settings'
 require_relative 'comet/models/extra_file_exclusion'
@@ -104,6 +106,8 @@ require_relative 'comet/models/office_365custom_setting'
 require_relative 'comet/models/office_365custom_setting_v2'
 require_relative 'comet/models/office_365mixed_virtual_account'
 require_relative 'comet/models/office_365object_info'
+require_relative 'comet/models/oidc_claim'
+require_relative 'comet/models/oidc_config'
 require_relative 'comet/models/organization'
 require_relative 'comet/models/organization_login_urlresponse'
 require_relative 'comet/models/organization_response'
@@ -201,6 +205,7 @@ require_relative 'comet/models/web_authn_relying_party_entity'
 require_relative 'comet/models/web_authn_sign_request'
 require_relative 'comet/models/web_authn_sign_response'
 require_relative 'comet/models/web_authn_user_entity'
+require_relative 'comet/models/web_dav_destination_location'
 require_relative 'comet/models/web_interface_branding_properties'
 require_relative 'comet/models/webhook_option'
 require_relative 'comet/models/win_smbauth'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,8 @@ files:
 - lib/comet/models/email_report_generated_preview.rb
 - lib/comet/models/email_reporting_option.rb
 - lib/comet/models/external_authentication_source.rb
+- lib/comet/models/external_authentication_source_display.rb
+- lib/comet/models/external_authentication_source_response.rb
 - lib/comet/models/external_ldapauthentication_source_server.rb
 - lib/comet/models/external_ldapauthentication_source_settings.rb
 - lib/comet/models/extra_file_exclusion.rb
@@ -182,6 +184,8 @@ files:
 - lib/comet/models/office_365custom_setting_v2.rb
 - lib/comet/models/office_365mixed_virtual_account.rb
 - lib/comet/models/office_365object_info.rb
+- lib/comet/models/oidc_claim.rb
+- lib/comet/models/oidc_config.rb
 - lib/comet/models/organization.rb
 - lib/comet/models/organization_login_urlresponse.rb
 - lib/comet/models/organization_response.rb
@@ -279,6 +283,7 @@ files:
 - lib/comet/models/web_authn_sign_request.rb
 - lib/comet/models/web_authn_sign_response.rb
 - lib/comet/models/web_authn_user_entity.rb
+- lib/comet/models/web_dav_destination_location.rb
 - lib/comet/models/web_interface_branding_properties.rb
 - lib/comet/models/webhook_option.rb
 - lib/comet/models/win_smbauth.rb