comet_backup_ruby_sdk 2.5.0 → 2.7.0

data/lib/comet/models/private_branding_properties.rb

@@ -39,6 +39,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
 
@@ -55,6 +58,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
@@ -66,6 +70,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
 
@@ -86,6 +108,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 = ''
@@ -95,6 +118,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
@@ -148,6 +177,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
 
@@ -184,6 +217,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)
@@ -205,6 +262,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
@@ -214,6 +272,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/s3destination_location.rb

@@ -36,6 +36,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 [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -50,6 +56,7 @@ module Comet
       @s3bucket_name = ''
       @s3subdir = ''
       @s3custom_region = ''
+      @s3object_lock_days = 0
       @unknown_json_fields = {}
     end
 
@@ -94,6 +101,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
         else
           @unknown_json_fields[k] = v
         end
@@ -111,6 +124,8 @@ module Comet
       ret['S3Subdir'] = @s3subdir
       ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
+      ret['S3RemoveDeleted'] = @s3remove_deleted
+      ret['S3ObjectLockDays'] = @s3object_lock_days
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/s3generic_virtual_storage_role.rb

@@ -27,6 +27,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
 
@@ -40,6 +49,7 @@ module Comet
       @master_bucket = ''
       @access_key = ''
       @secret_key = ''
+      @object_lock_days = 0
       @unknown_json_fields = {}
     end
 
@@ -76,6 +86,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
@@ -90,6 +108,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/search_result_file_info.rb

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

@@ -0,0 +1,104 @@
+# 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
+
+  # SearchSnapshotsResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class SearchSnapshotsResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Hash{String => Array<Comet::SearchResultFileInfo>}] snapshot_files
+    attr_accessor :snapshot_files
+
+    # @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 = ''
+      @snapshot_files = {}
+      @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 'SnapshotFiles'
+          @snapshot_files = {}
+          if v.nil?
+            @snapshot_files = {}
+          else
+            v.each do |k1, v1|
+              if v1.nil?
+                @snapshot_files[k1] = []
+              else
+                @snapshot_files[k1] = Array.new(v1.length)
+                v1.each_with_index do |v2, i2|
+                  @snapshot_files[k1][i2] = Comet::SearchResultFileInfo.new
+                  @snapshot_files[k1][i2].from_hash(v2)
+                end
+              end
+            end
+          end
+        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['SnapshotFiles'] = @snapshot_files
+      @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/self_backup_export_options.rb

@@ -27,6 +27,9 @@ module Comet
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 
+    # @type [Boolean] include_server_logs
+    attr_accessor :include_server_logs
+
     # @type [String] restrict_to_single_org_id
     attr_accessor :restrict_to_single_org_id
 
@@ -80,6 +83,8 @@ module Comet
           @compression = v
         when 'ExcludeJobsDB'
           @exclude_jobs_db = v
+        when 'IncludeServerLogs'
+          @include_server_logs = v
         when 'RestrictToSingleOrgID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -102,6 +107,7 @@ module Comet
       ret['EncryptionKeyFormat'] = @encryption_key_format
       ret['Compression'] = @compression
       ret['ExcludeJobsDB'] = @exclude_jobs_db
+      ret['IncludeServerLogs'] = @include_server_logs
       unless @restrict_to_single_org_id.nil?
         ret['RestrictToSingleOrgID'] = @restrict_to_single_org_id
       end

data/lib/comet/models/self_backup_target.rb

@@ -36,6 +36,9 @@ module Comet
     # @type [Boolean] exclude_jobs_db
     attr_accessor :exclude_jobs_db
 
+    # @type [Boolean] include_server_logs
+    attr_accessor :include_server_logs
+
     # @type [String] restrict_to_single_org_id
     attr_accessor :restrict_to_single_org_id
 
@@ -109,6 +112,8 @@ module Comet
           @compression = v
         when 'ExcludeJobsDB'
           @exclude_jobs_db = v
+        when 'IncludeServerLogs'
+          @include_server_logs = v
         when 'RestrictToSingleOrgID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -134,6 +139,7 @@ module Comet
       ret['EncryptionKeyFormat'] = @encryption_key_format
       ret['Compression'] = @compression
       ret['ExcludeJobsDB'] = @exclude_jobs_db
+      ret['IncludeServerLogs'] = @include_server_logs
       unless @restrict_to_single_org_id.nil?
         ret['RestrictToSingleOrgID'] = @restrict_to_single_org_id
       end

data/lib/comet/models/server_meta_branding_properties.rb

@@ -27,6 +27,9 @@ module Comet
     # @type [String] top_color
     attr_accessor :top_color
 
+    # @type [String] accent_color
+    attr_accessor :accent_color
+
     # @type [Boolean] hide_news_area
     attr_accessor :hide_news_area
 
@@ -54,6 +57,7 @@ module Comet
       @product_name = ''
       @image_etag = ''
       @top_color = ''
+      @accent_color = ''
       @prune_logs_after_days = 0
       @expired_in_seconds = 0
       @unknown_json_fields = {}
@@ -90,6 +94,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @top_color = v
+        when 'AccentColor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @accent_color = v
         when 'HideNewsArea'
           @hide_news_area = v
         when 'AllowUnauthenticatedDownloads'
@@ -118,6 +126,7 @@ module Comet
       ret['HasImage'] = @has_image
       ret['ImageEtag'] = @image_etag
       ret['TopColor'] = @top_color
+      ret['AccentColor'] = @accent_color
       ret['HideNewsArea'] = @hide_news_area
       ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
       ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads