comet_backup_ruby_sdk 2.9.0 → 2.11.0

data/lib/comet/models/branding_properties.rb

@@ -36,6 +36,7 @@ module Comet
     # @type [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -63,12 +64,14 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # One of the WINDOWSCODESIGN_METHOD_ constants
     # @type [Number] windows_code_sign_method
     attr_accessor :windows_code_sign_method
 
     # @type [String] windows_code_sign_pkcs12file_path
     attr_accessor :windows_code_sign_pkcs12file_path
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs12password_format
     attr_accessor :windows_code_sign_pkcs12password_format
 
@@ -81,13 +84,14 @@ module Comet
     # @type [String] windows_code_sign_pkcs11module
     attr_accessor :windows_code_sign_pkcs11module
 
+    # This field was deprecated between 23.3.0 and 23.6.x, but is now used again.
     # @type [String] windows_code_sign_pkcs11certfile
-    # @deprecated This member has been deprecated since Comet version 22.12.7
     attr_accessor :windows_code_sign_pkcs11certfile
 
     # @type [String] windows_code_sign_pkcs11key_id
     attr_accessor :windows_code_sign_pkcs11key_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs11password_format
     attr_accessor :windows_code_sign_pkcs11password_format
 
@@ -103,6 +107,7 @@ module Comet
     # @type [String] windows_code_sign_azure_app_id
     attr_accessor :windows_code_sign_azure_app_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_azure_app_secret_format
     attr_accessor :windows_code_sign_azure_app_secret_format
 

data/lib/comet/models/bucket_properties.rb

@@ -15,9 +15,11 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # Unix timestamp, in seconds.
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # One of the PASSWORD_FORMAT_ constants
     # @type [Number] read_write_key_format
     attr_accessor :read_write_key_format
 

data/lib/comet/models/constellation_stats.rb

@@ -12,12 +12,17 @@ module Comet
   # ConstellationStats is a typed class wrapper around the underlying Comet Server API data structure.
   class ConstellationStats
 
+    # Unix timestamp, in seconds.
     # @type [Number] last_check_start
     attr_accessor :last_check_start
 
+    # The total number of Constellation bucket report scans that have been performed since this Comet
+    # Server was last restarted
     # @type [Number] total_checks_started
     attr_accessor :total_checks_started
 
+    # The total number of buckets that Constellation has successfully deleted since this Comet Server
+    # was last restarted
     # @type [Number] total_buckets_deleted
     attr_accessor :total_buckets_deleted
 

data/lib/comet/models/device_config.rb

@@ -32,6 +32,10 @@ module Comet
     # @type [String] device_timezone
     attr_accessor :device_timezone
 
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] client_version
+    attr_accessor :client_version
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -45,6 +49,7 @@ module Comet
       @platform_version = Comet::OSInfo.new
       @sources = {}
       @device_timezone = ''
+      @client_version = ''
       @unknown_json_fields = {}
     end
 
@@ -86,6 +91,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @device_timezone = v
+        when 'ClientVersion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @client_version = v
         else
           @unknown_json_fields[k] = v
         end
@@ -108,6 +117,9 @@ module Comet
       unless @device_timezone.nil?
         ret['DeviceTimezone'] = @device_timezone
       end
+      unless @client_version.nil?
+        ret['ClientVersion'] = @client_version
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/email_reporting_option.rb

@@ -15,9 +15,11 @@ module Comet
     # @type [Comet::EmailReportConfig] email_report_config
     attr_accessor :email_report_config
 
+    # A supported language code (e.g. "en_US" or the DEFAULT_LANGUAGE constant)
     # @type [String] language_code
     attr_accessor :language_code
 
+    # The timezone in IANA format (e.g. "Pacific/Auckland" or the DEFAULT_TIMEZONE constant)
     # @type [String] local_timezone
     attr_accessor :local_timezone
 

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/external_ldapauthentication_source_server.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Number] port
     attr_accessor :port
 
+    # One of the LDAPSECURITYMETHOD_ constants (e.g. "plain" / "ldaps" / "starttls")
     # @type [String] security_method
     attr_accessor :security_method
 

data/lib/comet/models/external_ldapauthentication_source_settings.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Number] port
     attr_accessor :port
 
+    # One of the LDAPSECURITYMETHOD_ constants (e.g. "plain" / "ldaps" / "starttls")
     # @type [String] security_method
     attr_accessor :security_method
 

data/lib/comet/models/install_token.rb

@@ -15,18 +15,23 @@ module Comet
     # @type [String] username
     attr_accessor :username
 
+    # The URL of the Comet Server (Auth Role) for the target user to log in to.
     # @type [String] server
     attr_accessor :server
 
+    # The token for use with the "/TOKEN=" silent install flag.
     # @type [String] token
     attr_accessor :token
 
+    # Unix timestamp, in seconds.
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # If the token has been used, it cannot be used again.
     # @type [Boolean] used
     attr_accessor :used
 
+    # Unix timestamp, in seconds.
     # @type [Number] expire_time
     attr_accessor :expire_time
 

data/lib/comet/models/mac_oscode_sign_properties.rb

@@ -22,9 +22,13 @@ module Comet
     # @type [Comet::SSHConnection] sshserver
     attr_accessor :sshserver
 
+    # "Developer ID Installer" certificate, either a local filepath or a resource:// URI. Used for
+    # signing the final flat *.pkg.
     # @type [String] certificate_name
     attr_accessor :certificate_name
 
+    # "Developer ID Application" certificate, either a local filepath or a resource:// URI. Used for
+    # signing internal binaries if Notary is enabled
     # @type [String] app_certificate_name
     attr_accessor :app_certificate_name
 
@@ -34,6 +38,7 @@ module Comet
     # @type [String] apple_idpass
     attr_accessor :apple_idpass
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] apple_idpass_format
     attr_accessor :apple_idpass_format
 
@@ -46,6 +51,7 @@ module Comet
     # @type [String] pfx_file_password
     attr_accessor :pfx_file_password
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] pfx_file_password_format
     attr_accessor :pfx_file_password_format
 

data/lib/comet/models/mssqlconnection.rb

@@ -12,6 +12,7 @@ module Comet
   # MSSQLConnection is a typed class wrapper around the underlying Comet Server API data structure.
   class MSSQLConnection
 
+    # One of the MSSQL_AUTH_ constants (e.g. "windows" or "native")
     # @type [String] type
     attr_accessor :type
 
@@ -22,11 +23,13 @@ module Comet
     attr_accessor :password
 
     # @type [String] hostname
+    # @deprecated This member has been deprecated since Comet version Unused
     attr_accessor :hostname
 
     # @type [String] instance_name
     attr_accessor :instance_name
 
+    # One of the MSSQL_METHOD_ constants, to control using x86_32 or x86_64 OLEDB drivers
     # @type [String] method
     attr_accessor :method
 

data/lib/comet/models/news_entry.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # Unix timestamp, in seconds.
     # @type [Number] date_time
     attr_accessor :date_time
 

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