comet_backup_ruby_sdk 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31d37f9db407cb918ddc8ef37463e6a0e5876adcb1c393b7139ec86631165c59
-  data.tar.gz: 4e418f15a2d9ef97ba7c6a1b01b33eea54e95080bbabfe4d595c084e402dabfe
+  metadata.gz: 1b5e28127380597ea90859ac7f6d8bfc0577e55ae772621809a406923d966859
+  data.tar.gz: 9688cfb057919eb7ba1ef32b0466b264555d87081e17d3e18891cb46fee5e82e
 SHA512:
-  metadata.gz: ac49b81b1c33dcf60b72dff86a78ec6e22ca1fee9735c11e085928be4a55f73ecb0897a2fd27f93fa1196526cda9746c98c533c8778fb02cbfc92a21b355983f
-  data.tar.gz: e129d700eaa4a97048052e1636fd4fcad77db8a903af92e063b1e4c62b579aa98b77d0a4270df3e248abf459f781ec7b520e04b71e121de3bd9a1f362c03d8bd
+  metadata.gz: 8e00d003558c7df673a1c25dd8e223a59163e60fa12dbcc26d23479e469cc3aadecfe91d3bb82051769f887cacad1b2c916886a0f91f7e3711a9316788a0fa6f
+  data.tar.gz: a58dc8f7d1f47f82ed49031221d91b6e6b508f5cc35c52e22e2e342b95ca44a3d80753d7687aae38ea67fc33d4ea66825f5f27a8650c15142603f34ae0e5bff3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
-# CHANGELOG
-
+# CHANGELOG
+
+## 2023-03-23 v2.6.0
+
+- Based on Comet 23.3.1
+- Support filter parameters on `AdminGetJobLogEntries`
+- Support S3 Object Lock
+- Support Azure Key Vault codesigning
+
 ## 2023-02-15 v2.5.0
 - Based on 22.12.8
 - Add `TimeSpan` option to `EmailReportOptions`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.5.0)
+    comet_backup_ruby_sdk (2.6.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.5.0'
+  spec.version       = '2.6.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -2161,12 +2161,24 @@ module Comet
     # This API requires the Auth Role to be enabled.
     #
     # @param [String] job_id Selected job ID
+    # @param [String] min_severity (Optional) Return only job log entries with equal or higher severity
+    # @param [String] message_contains (Optional) Return only job log entries that contain exact string
     # @return [Array<Comet::JobEntry>]
-    def admin_get_job_log_entries(job_id)
+    def admin_get_job_log_entries(job_id, min_severity = nil, message_contains = nil)
       submit_params = {}
       raise TypeError, "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String
 
       submit_params['JobID'] = job_id
+      unless min_severity.nil?
+        raise TypeError, "'min_severity' expected String, got #{min_severity.class}" unless min_severity.is_a? String
+
+        submit_params['MinSeverity'] = min_severity
+      end
+      unless message_contains.nil?
+        raise TypeError, "'message_contains' expected String, got #{message_contains.class}" unless message_contains.is_a? String
+
+        submit_params['MessageContains'] = message_contains
+      end
 
       body = perform_request('api/v1/admin/get-job-log-entries', submit_params)
       json_body = JSON.parse body

data/lib/comet/definitions.rb

@@ -496,13 +496,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '22.12.8'
+  APPLICATION_VERSION = '23.3.1'
 
-  APPLICATION_VERSION_MAJOR = 22
+  APPLICATION_VERSION_MAJOR = 23
 
-  APPLICATION_VERSION_MINOR = 12
+  APPLICATION_VERSION_MINOR = 3
 
-  APPLICATION_VERSION_REVISION = 8
+  APPLICATION_VERSION_REVISION = 1
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -715,6 +715,22 @@ module Comet
   # LDAPSecurityMethod:
   LDAPSECURITYMETHOD_STARTTLS = 'starttls'
 
+  # WindowsCodesignMethod: When upgrading from a version of Comet Server prior to 22.12.7, this option will be automatically converted to a more specific type..
+  # @deprecated This const has been deprecated since Comet version 22.12.7
+  WINDOWSCODESIGN_METHOD_AUTO = 0
+
+  # WindowsCodesignMethod:
+  WINDOWSCODESIGN_METHOD_DISABLED = 1
+
+  # WindowsCodesignMethod:
+  WINDOWSCODESIGN_METHOD_PKCS12FILE = 2
+
+  # WindowsCodesignMethod:
+  WINDOWSCODESIGN_METHOD_PKCS11HSM = 3
+
+  # WindowsCodesignMethod:
+  WINDOWSCODESIGN_METHOD_AZUREKEYVAULT = 4
+
   # MacOSCodesignLevel:
   MACOSCODESIGN_LEVEL_SIGN = 0
 

data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb

@@ -21,6 +21,15 @@ module Comet
     # @type [String] secret_key
     attr_accessor :secret_key
 
+    # @type [Boolean] use_object_lock
+    attr_accessor :use_object_lock
+
+    # @type [Number] object_lock_days
+    attr_accessor :object_lock_days
+
+    # @type [Boolean] remove_deleted
+    attr_accessor :remove_deleted
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -32,6 +41,7 @@ module Comet
       @master_bucket = ''
       @access_key = ''
       @secret_key = ''
+      @object_lock_days = 0
       @unknown_json_fields = {}
     end
 
@@ -60,6 +70,14 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @secret_key = v
+        when 'UseObjectLock'
+          @use_object_lock = v
+        when 'ObjectLockDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @object_lock_days = v
+        when 'RemoveDeleted'
+          @remove_deleted = v
         else
           @unknown_json_fields[k] = v
         end
@@ -72,6 +90,9 @@ module Comet
       ret['MasterBucket'] = @master_bucket
       ret['AccessKey'] = @access_key
       ret['SecretKey'] = @secret_key
+      ret['UseObjectLock'] = @use_object_lock
+      ret['ObjectLockDays'] = @object_lock_days
+      ret['RemoveDeleted'] = @remove_deleted
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/branding_options.rb

@@ -78,6 +78,9 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # @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
 
@@ -94,6 +97,7 @@ module Comet
     attr_accessor :windows_code_sign_pkcs11module
 
     # @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
@@ -105,6 +109,24 @@ module Comet
     # @type [String] windows_code_sign_pkcs11password
     attr_accessor :windows_code_sign_pkcs11password
 
+    # @type [String] windows_code_sign_azure_vault_name
+    attr_accessor :windows_code_sign_azure_vault_name
+
+    # @type [String] windows_code_sign_azure_cert_name
+    attr_accessor :windows_code_sign_azure_cert_name
+
+    # @type [String] windows_code_sign_azure_app_id
+    attr_accessor :windows_code_sign_azure_app_id
+
+    # @type [Number] windows_code_sign_azure_app_secret_format
+    attr_accessor :windows_code_sign_azure_app_secret_format
+
+    # @type [String] windows_code_sign_azure_app_secret
+    attr_accessor :windows_code_sign_azure_app_secret
+
+    # @type [String] windows_code_sign_azure_tenant_id
+    attr_accessor :windows_code_sign_azure_tenant_id
+
     # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
     attr_accessor :mac_oscode_sign
 
@@ -135,6 +157,7 @@ module Comet
       @path_header_image = ''
       @path_app_icon_image = ''
       @package_identifier = ''
+      @windows_code_sign_method = 0
       @windows_code_sign_pkcs12file_path = ''
       @windows_code_sign_pkcs12password_format = 0
       @windows_code_sign_pkcs12password = ''
@@ -144,6 +167,12 @@ module Comet
       @windows_code_sign_pkcs11key_id = ''
       @windows_code_sign_pkcs11password_format = 0
       @windows_code_sign_pkcs11password = ''
+      @windows_code_sign_azure_vault_name = ''
+      @windows_code_sign_azure_cert_name = ''
+      @windows_code_sign_azure_app_id = ''
+      @windows_code_sign_azure_app_secret_format = 0
+      @windows_code_sign_azure_app_secret = ''
+      @windows_code_sign_azure_tenant_id = ''
       @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
       @unknown_json_fields = {}
     end
@@ -243,6 +272,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @package_identifier = v
+        when 'WindowsCodeSignMethod'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @windows_code_sign_method = v
         when 'WindowsCodeSignPKCS12FilePath'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -279,6 +312,30 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_pkcs11password = v
+        when 'WindowsCodeSignAzureVaultName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_vault_name = v
+        when 'WindowsCodeSignAzureCertName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_cert_name = v
+        when 'WindowsCodeSignAzureAppID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_app_id = v
+        when 'WindowsCodeSignAzureAppSecretFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @windows_code_sign_azure_app_secret_format = v
+        when 'WindowsCodeSignAzureAppSecret'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_app_secret = v
+        when 'WindowsCodeSignAzureTenantID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_tenant_id = v
         when 'MacOSCodeSign'
           @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
           @mac_oscode_sign.from_hash(v)
@@ -313,6 +370,7 @@ module Comet
       ret['PathHeaderImage'] = @path_header_image
       ret['PathAppIconImage'] = @path_app_icon_image
       ret['PackageIdentifier'] = @package_identifier
+      ret['WindowsCodeSignMethod'] = @windows_code_sign_method
       ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
       ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
       ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
@@ -322,6 +380,12 @@ module Comet
       ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
       ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
       ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
+      ret['WindowsCodeSignAzureVaultName'] = @windows_code_sign_azure_vault_name
+      ret['WindowsCodeSignAzureCertName'] = @windows_code_sign_azure_cert_name
+      ret['WindowsCodeSignAzureAppID'] = @windows_code_sign_azure_app_id
+      ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
+      ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
+      ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
       ret['MacOSCodeSign'] = @mac_oscode_sign
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/branding_properties.rb

@@ -63,6 +63,9 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # @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
 
@@ -79,6 +82,7 @@ module Comet
     attr_accessor :windows_code_sign_pkcs11module
 
     # @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
@@ -90,6 +94,24 @@ module Comet
     # @type [String] windows_code_sign_pkcs11password
     attr_accessor :windows_code_sign_pkcs11password
 
+    # @type [String] windows_code_sign_azure_vault_name
+    attr_accessor :windows_code_sign_azure_vault_name
+
+    # @type [String] windows_code_sign_azure_cert_name
+    attr_accessor :windows_code_sign_azure_cert_name
+
+    # @type [String] windows_code_sign_azure_app_id
+    attr_accessor :windows_code_sign_azure_app_id
+
+    # @type [Number] windows_code_sign_azure_app_secret_format
+    attr_accessor :windows_code_sign_azure_app_secret_format
+
+    # @type [String] windows_code_sign_azure_app_secret
+    attr_accessor :windows_code_sign_azure_app_secret
+
+    # @type [String] windows_code_sign_azure_tenant_id
+    attr_accessor :windows_code_sign_azure_tenant_id
+
     # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
     attr_accessor :mac_oscode_sign
 
@@ -116,6 +138,7 @@ module Comet
       @path_header_image = ''
       @path_app_icon_image = ''
       @package_identifier = ''
+      @windows_code_sign_method = 0
       @windows_code_sign_pkcs12file_path = ''
       @windows_code_sign_pkcs12password_format = 0
       @windows_code_sign_pkcs12password = ''
@@ -125,6 +148,12 @@ module Comet
       @windows_code_sign_pkcs11key_id = ''
       @windows_code_sign_pkcs11password_format = 0
       @windows_code_sign_pkcs11password = ''
+      @windows_code_sign_azure_vault_name = ''
+      @windows_code_sign_azure_cert_name = ''
+      @windows_code_sign_azure_app_id = ''
+      @windows_code_sign_azure_app_secret_format = 0
+      @windows_code_sign_azure_app_secret = ''
+      @windows_code_sign_azure_tenant_id = ''
       @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
       @unknown_json_fields = {}
     end
@@ -206,6 +235,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @package_identifier = v
+        when 'WindowsCodeSignMethod'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @windows_code_sign_method = v
         when 'WindowsCodeSignPKCS12FilePath'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -242,6 +275,30 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_pkcs11password = v
+        when 'WindowsCodeSignAzureVaultName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_vault_name = v
+        when 'WindowsCodeSignAzureCertName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_cert_name = v
+        when 'WindowsCodeSignAzureAppID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_app_id = v
+        when 'WindowsCodeSignAzureAppSecretFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @windows_code_sign_azure_app_secret_format = v
+        when 'WindowsCodeSignAzureAppSecret'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_app_secret = v
+        when 'WindowsCodeSignAzureTenantID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_azure_tenant_id = v
         when 'MacOSCodeSign'
           @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
           @mac_oscode_sign.from_hash(v)
@@ -271,6 +328,7 @@ module Comet
       ret['PathHeaderImage'] = @path_header_image
       ret['PathAppIconImage'] = @path_app_icon_image
       ret['PackageIdentifier'] = @package_identifier
+      ret['WindowsCodeSignMethod'] = @windows_code_sign_method
       ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
       ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
       ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
@@ -280,6 +338,12 @@ module Comet
       ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
       ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
       ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
+      ret['WindowsCodeSignAzureVaultName'] = @windows_code_sign_azure_vault_name
+      ret['WindowsCodeSignAzureCertName'] = @windows_code_sign_azure_cert_name
+      ret['WindowsCodeSignAzureAppID'] = @windows_code_sign_azure_app_id
+      ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
+      ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
+      ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
       ret['MacOSCodeSign'] = @mac_oscode_sign
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/destination_config.rb

@@ -66,6 +66,12 @@ module Comet
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 
+    # @type [Boolean] s3remove_deleted
+    attr_accessor :s3remove_deleted
+
+    # @type [Number] s3object_lock_days
+    attr_accessor :s3object_lock_days
+
     # @type [String] sftpserver
     attr_accessor :sftpserver
 
@@ -207,6 +213,7 @@ module Comet
       @s3bucket_name = ''
       @s3subdir = ''
       @s3custom_region = ''
+      @s3object_lock_days = 0
       @sftpserver = ''
       @sftpusername = ''
       @sftpremote_path = ''
@@ -345,6 +352,12 @@ module Comet
           @s3custom_region = v
         when 'S3UsesV2Signing'
           @s3uses_v2signing = v
+        when 'S3RemoveDeleted'
+          @s3remove_deleted = v
+        when 'S3ObjectLockDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @s3object_lock_days = v
         when 'SFTPServer'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -517,6 +530,8 @@ module Comet
       ret['S3Subdir'] = @s3subdir
       ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
+      ret['S3RemoveDeleted'] = @s3remove_deleted
+      ret['S3ObjectLockDays'] = @s3object_lock_days
       ret['SFTPServer'] = @sftpserver
       ret['SFTPUsername'] = @sftpusername
       ret['SFTPRemotePath'] = @sftpremote_path

data/lib/comet/models/destination_location.rb

@@ -48,6 +48,12 @@ module Comet
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 
+    # @type [Boolean] s3remove_deleted
+    attr_accessor :s3remove_deleted
+
+    # @type [Number] s3object_lock_days
+    attr_accessor :s3object_lock_days
+
     # @type [String] sftpserver
     attr_accessor :sftpserver
 
@@ -159,6 +165,7 @@ module Comet
       @s3bucket_name = ''
       @s3subdir = ''
       @s3custom_region = ''
+      @s3object_lock_days = 0
       @sftpserver = ''
       @sftpusername = ''
       @sftpremote_path = ''
@@ -246,6 +253,12 @@ module Comet
           @s3custom_region = v
         when 'S3UsesV2Signing'
           @s3uses_v2signing = v
+        when 'S3RemoveDeleted'
+          @s3remove_deleted = v
+        when 'S3ObjectLockDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @s3object_lock_days = v
         when 'SFTPServer'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -386,6 +399,8 @@ module Comet
       ret['S3Subdir'] = @s3subdir
       ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
+      ret['S3RemoveDeleted'] = @s3remove_deleted
+      ret['S3ObjectLockDays'] = @s3object_lock_days
       ret['SFTPServer'] = @sftpserver
       ret['SFTPUsername'] = @sftpusername
       ret['SFTPRemotePath'] = @sftpremote_path