comet_backup_ruby_sdk 1.12.0 → 1.15.0

data/lib/comet/models/branding_properties.rb

@@ -56,6 +56,9 @@ module Comet
     # @type [String] path_header_image
     attr_accessor :path_header_image
 
+    # @type [String] path_app_icon_image
+    attr_accessor :path_app_icon_image
+
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
@@ -109,6 +112,7 @@ module Comet
       @path_eula_rtf = ''
       @path_tile_png = ''
       @path_header_image = ''
+      @path_app_icon_image = ''
       @package_identifier = ''
       @windows_code_sign_pkcs12file_path = ''
       @windows_code_sign_pkcs12password_format = 0
@@ -188,6 +192,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @path_header_image = v
+        when 'PathAppIconImage'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_app_icon_image = v
         when 'PackageIdentifier'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -254,6 +262,7 @@ module Comet
       ret['PathEulaRtf'] = @path_eula_rtf
       ret['PathTilePng'] = @path_tile_png
       ret['PathHeaderImage'] = @path_header_image
+      ret['PathAppIconImage'] = @path_app_icon_image
       ret['PackageIdentifier'] = @package_identifier
       ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
       ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format

data/lib/comet/models/days_of_week_config.rb

@@ -0,0 +1,108 @@
+#!/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
+
+  # DaysOfWeekConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class DaysOfWeekConfig
+
+    # @type [Boolean] sunday
+    attr_accessor :sunday
+
+    # @type [Boolean] monday
+    attr_accessor :monday
+
+    # @type [Boolean] tuesday
+    attr_accessor :tuesday
+
+    # @type [Boolean] wednesday
+    attr_accessor :wednesday
+
+    # @type [Boolean] thursday
+    attr_accessor :thursday
+
+    # @type [Boolean] friday
+    attr_accessor :friday
+
+    # @type [Boolean] saturday
+    attr_accessor :saturday
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @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 'Sunday'
+          @sunday = v
+        when 'Monday'
+          @monday = v
+        when 'Tuesday'
+          @tuesday = v
+        when 'Wednesday'
+          @wednesday = v
+        when 'Thursday'
+          @thursday = v
+        when 'Friday'
+          @friday = v
+        when 'Saturday'
+          @saturday = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Sunday'] = @sunday
+      ret['Monday'] = @monday
+      ret['Tuesday'] = @tuesday
+      ret['Wednesday'] = @wednesday
+      ret['Thursday'] = @thursday
+      ret['Friday'] = @friday
+      ret['Saturday'] = @saturday
+      @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/hour_sched_config.rb

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

@@ -12,6 +12,7 @@ require 'json'
 module Comet
 
   # JobEntry is a typed class wrapper around the underlying Comet Server API data structure.
+  # JobEntry is a single entry within a job report.
   class JobEntry
 
     # @type [Number] time

data/lib/comet/models/mac_oscode_sign_properties.rb

@@ -17,6 +17,9 @@ module Comet
     # @type [Number] level
     attr_accessor :level
 
+    # @type [Boolean] sign_locally
+    attr_accessor :sign_locally
+
     # @type [Comet::SSHConnection] sshserver
     attr_accessor :sshserver
 
@@ -35,6 +38,27 @@ module Comet
     # @type [Number] apple_idpass_format
     attr_accessor :apple_idpass_format
 
+    # @type [String] certificate_file
+    attr_accessor :certificate_file
+
+    # @type [String] app_certificate_file
+    attr_accessor :app_certificate_file
+
+    # @type [String] pfx_file_password
+    attr_accessor :pfx_file_password
+
+    # @type [Number] pfx_file_password_format
+    attr_accessor :pfx_file_password_format
+
+    # @type [String] notary_apiissuer_id
+    attr_accessor :notary_apiissuer_id
+
+    # @type [String] notary_apikey_id
+    attr_accessor :notary_apikey_id
+
+    # @type [String] notary_apikey_file
+    attr_accessor :notary_apikey_file
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -50,6 +74,13 @@ module Comet
       @apple_id = ''
       @apple_idpass = ''
       @apple_idpass_format = 0
+      @certificate_file = ''
+      @app_certificate_file = ''
+      @pfx_file_password = ''
+      @pfx_file_password_format = 0
+      @notary_apiissuer_id = ''
+      @notary_apikey_id = ''
+      @notary_apikey_file = ''
       @unknown_json_fields = {}
     end
 
@@ -70,6 +101,8 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @level = v
+        when 'SignLocally'
+          @sign_locally = v
         when 'SSHServer'
           @sshserver = Comet::SSHConnection.new
           @sshserver.from_hash(v)
@@ -93,6 +126,34 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @apple_idpass_format = v
+        when 'CertificateFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @certificate_file = v
+        when 'AppCertificateFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @app_certificate_file = v
+        when 'PfxFilePassword'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @pfx_file_password = v
+        when 'PfxFilePasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @pfx_file_password_format = v
+        when 'NotaryAPIIssuerID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @notary_apiissuer_id = v
+        when 'NotaryAPIKeyID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @notary_apikey_id = v
+        when 'NotaryAPIKeyFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @notary_apikey_file = v
         else
           @unknown_json_fields[k] = v
         end
@@ -103,12 +164,20 @@ module Comet
     def to_hash
       ret = {}
       ret['Level'] = @level
+      ret['SignLocally'] = @sign_locally
       ret['SSHServer'] = @sshserver
       ret['CertificateName'] = @certificate_name
       ret['AppCertificateName'] = @app_certificate_name
       ret['AppleID'] = @apple_id
       ret['AppleIDPass'] = @apple_idpass
       ret['AppleIDPassFormat'] = @apple_idpass_format
+      ret['CertificateFile'] = @certificate_file
+      ret['AppCertificateFile'] = @app_certificate_file
+      ret['PfxFilePassword'] = @pfx_file_password
+      ret['PfxFilePasswordFormat'] = @pfx_file_password_format
+      ret['NotaryAPIIssuerID'] = @notary_apiissuer_id
+      ret['NotaryAPIKeyID'] = @notary_apikey_id
+      ret['NotaryAPIKeyFile'] = @notary_apikey_file
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/private_branding_properties.rb

@@ -32,6 +32,9 @@ module Comet
     # @type [String] path_header_image
     attr_accessor :path_header_image
 
+    # @type [String] path_app_icon_image
+    attr_accessor :path_app_icon_image
+
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
@@ -79,6 +82,7 @@ module Comet
       @path_eula_rtf = ''
       @path_tile_png = ''
       @path_header_image = ''
+      @path_app_icon_image = ''
       @package_identifier = ''
       @windows_code_sign_pkcs12file_path = ''
       @windows_code_sign_pkcs12password_format = 0
@@ -130,6 +134,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @path_header_image = v
+        when 'PathAppIconImage'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_app_icon_image = v
         when 'PackageIdentifier'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -188,6 +196,7 @@ module Comet
       ret['PathEulaRtf'] = @path_eula_rtf
       ret['PathTilePng'] = @path_tile_png
       ret['PathHeaderImage'] = @path_header_image
+      ret['PathAppIconImage'] = @path_app_icon_image
       ret['PackageIdentifier'] = @package_identifier
       ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
       ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format

data/lib/comet/models/remote_server_address.rb

@@ -41,6 +41,13 @@ module Comet
     # @type [Comet::CustomRemoteBucketSettings] custom
     attr_accessor :custom
 
+    # @type [Comet::S3GenericVirtualStorageRole] s3
+    attr_accessor :s3
+
+    # Amazon AWS - Virtual Storage Role
+    # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
+    attr_accessor :aws
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -58,6 +65,8 @@ module Comet
       @b2 = Comet::B2VirtualStorageRoleSettings.new
       @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
       @custom = Comet::CustomRemoteBucketSettings.new
+      @s3 = Comet::S3GenericVirtualStorageRole.new
+      @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
       @unknown_json_fields = {}
     end
 
@@ -106,6 +115,12 @@ module Comet
         when 'Custom'
           @custom = Comet::CustomRemoteBucketSettings.new
           @custom.from_hash(v)
+        when 'S3'
+          @s3 = Comet::S3GenericVirtualStorageRole.new
+          @s3.from_hash(v)
+        when 'AWS'
+          @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
+          @aws.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -138,6 +153,12 @@ module Comet
       unless @custom.nil?
         ret['Custom'] = @custom
       end
+      unless @s3.nil?
+        ret['S3'] = @s3
+      end
+      unless @aws.nil?
+        ret['AWS'] = @aws
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/remote_storage_option.rb

@@ -41,6 +41,13 @@ module Comet
     # @type [Comet::CustomRemoteBucketSettings] custom
     attr_accessor :custom
 
+    # @type [Comet::S3GenericVirtualStorageRole] s3
+    attr_accessor :s3
+
+    # Amazon AWS - Virtual Storage Role
+    # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
+    attr_accessor :aws
+
     # @type [Boolean] storage_limit_enabled
     attr_accessor :storage_limit_enabled
 
@@ -67,6 +74,8 @@ module Comet
       @b2 = Comet::B2VirtualStorageRoleSettings.new
       @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
       @custom = Comet::CustomRemoteBucketSettings.new
+      @s3 = Comet::S3GenericVirtualStorageRole.new
+      @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
       @storage_limit_bytes = 0
       @unknown_json_fields = {}
     end
@@ -116,6 +125,12 @@ module Comet
         when 'Custom'
           @custom = Comet::CustomRemoteBucketSettings.new
           @custom.from_hash(v)
+        when 'S3'
+          @s3 = Comet::S3GenericVirtualStorageRole.new
+          @s3.from_hash(v)
+        when 'AWS'
+          @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
+          @aws.from_hash(v)
         when 'StorageLimitEnabled'
           @storage_limit_enabled = v
         when 'StorageLimitBytes'
@@ -156,6 +171,12 @@ module Comet
       unless @custom.nil?
         ret['Custom'] = @custom
       end
+      unless @s3.nil?
+        ret['S3'] = @s3
+      end
+      unless @aws.nil?
+        ret['AWS'] = @aws
+      end
       ret['StorageLimitEnabled'] = @storage_limit_enabled
       ret['StorageLimitBytes'] = @storage_limit_bytes
       ret['RebrandStorage'] = @rebrand_storage

data/lib/comet/models/s3generic_virtual_storage_role.rb

@@ -0,0 +1,111 @@
+#!/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
+
+  # S3GenericVirtualStorageRole is a typed class wrapper around the underlying Comet Server API data structure.
+  class S3GenericVirtualStorageRole
+
+    # @type [String] s3endpoint
+    attr_accessor :s3endpoint
+
+    # @type [String] iamendpoint
+    attr_accessor :iamendpoint
+
+    # @type [String] master_bucket
+    attr_accessor :master_bucket
+
+    # @type [String] access_key
+    attr_accessor :access_key
+
+    # @type [String] secret_key
+    attr_accessor :secret_key
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @s3endpoint = ''
+      @iamendpoint = ''
+      @master_bucket = ''
+      @access_key = ''
+      @secret_key = ''
+      @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 'S3Endpoint'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3endpoint = v
+        when 'IAMEndpoint'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @iamendpoint = v
+        when 'MasterBucket'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @master_bucket = v
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_key = v
+        when 'SecretKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @secret_key = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['S3Endpoint'] = @s3endpoint
+      ret['IAMEndpoint'] = @iamendpoint
+      ret['MasterBucket'] = @master_bucket
+      ret['AccessKey'] = @access_key
+      ret['SecretKey'] = @secret_key
+      @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/schedule_config.rb

@@ -23,6 +23,21 @@ module Comet
     # @type [Number] offset
     attr_accessor :offset
 
+    # @type [Boolean] restrict_runtime
+    attr_accessor :restrict_runtime
+
+    # @type [Comet::HourSchedConfig] from_time
+    attr_accessor :from_time
+
+    # @type [Comet::HourSchedConfig] to_time
+    attr_accessor :to_time
+
+    # @type [Boolean] restrict_days
+    attr_accessor :restrict_days
+
+    # @type [Comet::DaysOfWeekConfig] days_select
+    attr_accessor :days_select
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -34,6 +49,9 @@ module Comet
       @frequency_type = 0
       @seconds_past = 0
       @offset = 0
+      @from_time = Comet::HourSchedConfig.new
+      @to_time = Comet::HourSchedConfig.new
+      @days_select = Comet::DaysOfWeekConfig.new
       @unknown_json_fields = {}
     end
 
@@ -62,6 +80,19 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @offset = v
+        when 'RestrictRuntime'
+          @restrict_runtime = v
+        when 'FromTime'
+          @from_time = Comet::HourSchedConfig.new
+          @from_time.from_hash(v)
+        when 'ToTime'
+          @to_time = Comet::HourSchedConfig.new
+          @to_time.from_hash(v)
+        when 'RestrictDays'
+          @restrict_days = v
+        when 'DaysSelect'
+          @days_select = Comet::DaysOfWeekConfig.new
+          @days_select.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -76,6 +107,11 @@ module Comet
       unless @offset.nil?
         ret['Offset'] = @offset
       end
+      ret['RestrictRuntime'] = @restrict_runtime
+      ret['FromTime'] = @from_time
+      ret['ToTime'] = @to_time
+      ret['RestrictDays'] = @restrict_days
+      ret['DaysSelect'] = @days_select
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/stored_object.rb

@@ -20,6 +20,7 @@ module Comet
     # @type [Number] modify_time
     attr_accessor :modify_time
 
+    # One of the STOREDOBJECTTYPE_... constant values
     # @type [String] type
     attr_accessor :type