comet_backup_ruby_sdk 1.8.0 → 1.12.0

data/lib/comet/models/admin_web_authn_registration.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+
+module Comet
+
+  # AdminWebAuthnRegistration is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminWebAuthnRegistration
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [Number] register_time
+    attr_accessor :register_time
+
+    # @type [Number] type
+    attr_accessor :type
+
+    # @type [Boolean] is_legacy_u2f
+    attr_accessor :is_legacy_u2f
+
+    # @type [Array<Object>] id
+    attr_accessor :id
+
+    # @type [Comet::WebAuthnCredential] credential
+    attr_accessor :credential
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @description = ''
+      @register_time = 0
+      @type = 0
+      @id = []
+      @credential = Comet::WebAuthnCredential.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 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'RegisterTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @register_time = v
+        when 'Type'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @type = v
+        when 'IsLegacyU2F'
+          @is_legacy_u2f = v
+        when 'ID'
+          @id = Base64.decode64(v)
+        when 'Credential'
+          @credential = Comet::WebAuthnCredential.new
+          @credential.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['Description'] = @description
+      ret['RegisterTime'] = @register_time
+      ret['Type'] = @type
+      unless @is_legacy_u2f.nil?
+        ret['IsLegacyU2F'] = @is_legacy_u2f
+      end
+      unless @id.nil?
+        ret['ID'] = @id
+      end
+      unless @credential.nil?
+        ret['Credential'] = @credential
+      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/allowed_admin_user.rb

@@ -0,0 +1,214 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AllowedAdminUser is a typed class wrapper around the underlying Comet Server API data structure.
+  class AllowedAdminUser
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] organization_id
+    attr_accessor :organization_id
+
+    # @type [String] external_authentication_source
+    attr_accessor :external_authentication_source
+
+    # @type [Number] password_format
+    attr_accessor :password_format
+
+    # @type [String] password
+    attr_accessor :password
+
+    # @type [Boolean] allow_password_login
+    attr_accessor :allow_password_login
+
+    # @type [Boolean] allow_password_and_totplogin
+    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
+
+    # @type [String] totpkey
+    attr_accessor :totpkey
+
+    # @type [String] ipwhitelist
+    attr_accessor :ipwhitelist
+
+    # @type [Comet::AdminUserPermissions] permissions
+    attr_accessor :permissions
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @username = ''
+      @organization_id = ''
+      @external_authentication_source = ''
+      @password_format = 0
+      @password = ''
+      @u2fregistrations = []
+      @web_authn_registrations = []
+      @totpkey_encryption_format = 0
+      @totpkey = ''
+      @ipwhitelist = ''
+      @permissions = Comet::AdminUserPermissions.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 'Username'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @username = v
+        when 'OrganizationID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @organization_id = v
+        when 'ExternalAuthenticationSource'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @external_authentication_source = v
+        when 'PasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @password_format = v
+        when 'Password'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @password = v
+        when 'AllowPasswordLogin'
+          @allow_password_login = v
+        when 'AllowPasswordAndTOTPLogin'
+          @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 = []
+          else
+            @u2fregistrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @u2fregistrations[i1] = Comet::AdminU2FRegistration.new
+              @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
+
+          @totpkey_encryption_format = v
+        when 'TOTPKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @totpkey = v
+        when 'IPWhitelist'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @ipwhitelist = v
+        when 'Permissions'
+          @permissions = Comet::AdminUserPermissions.new
+          @permissions.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['Username'] = @username
+      ret['OrganizationID'] = @organization_id
+      unless @external_authentication_source.nil?
+        ret['ExternalAuthenticationSource'] = @external_authentication_source
+      end
+      ret['PasswordFormat'] = @password_format
+      ret['Password'] = @password
+      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
+      unless @totpkey.nil?
+        ret['TOTPKey'] = @totpkey
+      end
+      unless @ipwhitelist.nil?
+        ret['IPWhitelist'] = @ipwhitelist
+      end
+      ret['Permissions'] = @permissions
+      @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/available_download.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/azure_destination_location.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/b2destination_location.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,8 +27,12 @@ module Comet
     attr_accessor :prefix
 
     # @type [Number] max_connections
+    # @deprecated This member has been deprecated since Comet version 21.9.7
     attr_accessor :max_connections
 
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -78,6 +82,8 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @max_connections = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
         else
           @unknown_json_fields[k] = v
         end
@@ -102,6 +108,9 @@ module Comet
       unless @max_connections.nil?
         ret['MaxConnections'] = @max_connections
       end
+      unless @hide_deleted_files.nil?
+        ret['HideDeletedFiles'] = @hide_deleted_files
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/b2storage_extra_info.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/b2transaction_totals.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/b2virtual_storage_role_settings.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
@@ -23,6 +23,9 @@ module Comet
     # @type [String] app_key
     attr_accessor :app_key
 
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -62,6 +65,8 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @app_key = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
         else
           @unknown_json_fields[k] = v
         end
@@ -74,6 +79,7 @@ module Comet
       ret['MasterBucket'] = @master_bucket
       ret['KeyID'] = @key_id
       ret['AppKey'] = @app_key
+      ret['HideDeletedFiles'] = @hide_deleted_files
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/backup_job_advanced_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/backup_job_detail.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
@@ -74,12 +74,24 @@ module Comet
     # @type [Number] total_accounts_count
     attr_accessor :total_accounts_count
 
+    # @type [Number] total_licensed_mails_count
+    attr_accessor :total_licensed_mails_count
+
+    # @type [Number] total_unlicensed_mails_count
+    attr_accessor :total_unlicensed_mails_count
+
     # @type [String] cancellation_id
     attr_accessor :cancellation_id
 
     # @type [Comet::BackupJobProgress] progress
     attr_accessor :progress
 
+    # @type [Comet::SizeMeasurement] destination_size_start
+    attr_accessor :destination_size_start
+
+    # @type [Comet::SizeMeasurement] destination_size_end
+    attr_accessor :destination_size_end
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -108,8 +120,12 @@ module Comet
       @total_mails_count = 0
       @total_sites_count = 0
       @total_accounts_count = 0
+      @total_licensed_mails_count = 0
+      @total_unlicensed_mails_count = 0
       @cancellation_id = ''
       @progress = Comet::BackupJobProgress.new
+      @destination_size_start = Comet::SizeMeasurement.new
+      @destination_size_end = Comet::SizeMeasurement.new
       @unknown_json_fields = {}
     end
 
@@ -206,6 +222,14 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @total_accounts_count = v
+        when 'TotalLicensedMailsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_licensed_mails_count = v
+        when 'TotalUnlicensedMailsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_unlicensed_mails_count = v
         when 'CancellationID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -213,6 +237,12 @@ module Comet
         when 'Progress'
           @progress = Comet::BackupJobProgress.new
           @progress.from_hash(v)
+        when 'DestinationSizeStart'
+          @destination_size_start = Comet::SizeMeasurement.new
+          @destination_size_start.from_hash(v)
+        when 'DestinationSizeEnd'
+          @destination_size_end = Comet::SizeMeasurement.new
+          @destination_size_end.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -250,12 +280,24 @@ module Comet
       unless @total_accounts_count.nil?
         ret['TotalAccountsCount'] = @total_accounts_count
       end
+      unless @total_licensed_mails_count.nil?
+        ret['TotalLicensedMailsCount'] = @total_licensed_mails_count
+      end
+      unless @total_unlicensed_mails_count.nil?
+        ret['TotalUnlicensedMailsCount'] = @total_unlicensed_mails_count
+      end
       unless @cancellation_id.nil?
         ret['CancellationID'] = @cancellation_id
       end
       unless @progress.nil?
         ret['Progress'] = @progress
       end
+      unless @destination_size_start.nil?
+        ret['DestinationSizeStart'] = @destination_size_start
+      end
+      unless @destination_size_end.nil?
+        ret['DestinationSizeEnd'] = @destination_size_end
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/backup_job_progress.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/backup_rule_config.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/backup_rule_event_triggers.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/branding_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/branding_properties.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/browse_disk_drives_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/browse_edbresponse.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/browse_hvresponse.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