comet_backup_ruby_sdk 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a41caa98a2a94326271b4b1ee4f2d7f61e98b0d62c1964ac1707e1984dca72
-  data.tar.gz: 3dce1759fcc473dcd64b592cfab33633ae31fe619ea07b0a9e13719c7981e5da
+  metadata.gz: fd41ef7f0ce9f54555af78b82719b073f2bdedb8a1fac79da00fcfff58a82aae
+  data.tar.gz: aca0a1786bd48d8ed2f61a080c02fda37ac8d6b2bffc75421c3a37ea51c993a3
 SHA512:
-  metadata.gz: b3f505381b2cd44a90667f1de2f8fa6d4b99cffeb106e271eac055545ea7f51c57c948077baabb52025b120ded6efe0bd1bbbcf3df5b3dceabc84960b5040a3f
-  data.tar.gz: 4a3588488fb2a2da49662460438c0e8d85f7f57cb7fdd654199c30fe6c4bfd820e418872a8f0f751c1a7094d0d6b0754809c4fcb94cf98846cbbe3810eb341a0
+  metadata.gz: 34d97b5cf4cd1bd01ee04602688b5f5355e2cbe3b5667aef32973d0f7298178cef7fb3678f4a26ecbd524cc88a03ebcce1837398be4ad1bb9e6656508ce53c8e
+  data.tar.gz: 2c205b4ead8426f4e380977510b99069a74d9233ede9d1dce74c6ca43bede641784c5edd275a9a863bfd3a938d0a40484fa87155a0d53e0bd69656723d0fc919

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # CHANGELOG
 
+## 2022-05-10 v1.13.0
+- Based on 22.3.5
+- Add new `RestrictRuntime`, `FromTime`, `ToTime`, `RestrictDays`, `DaysSelect` types to ScheduleConfig to add time and day restrictions in a hourly schedule.
+- Add new `TotalVmCount` to `BackupJobDetail` API.
+- Add new fields to `MacOSCodeSignProperties` to support code signing.
+- Add new `ForceUpgradeRunning`, `ApplyDeviceFilter`, and `DeviceFilter` fields to `UpdateCampaign` types to support sending a bulk upgrade to a custom query of users
+- Add new `AdminBrandingGenerateClientSpkDsm6` and `AdminBrandingGenerateClientSpkDsm7` APIs and associated types for generating and downloading Synology SPKs
+- Add new `PathAppIconImage` field to branding options types to support branding of the app icon when installed in Synology's Package Center (and other software managers)
+- Add new constants for VMDK single file restore
+
 ## 2022-01-28 v1.12.0
 - Based on 21.12.4
 - Add `AdminStoragePingDestination` API to perform a server-side Test Connections action when configuring Storage Role
+- Add `DestinationSize*` on `BackupJobDetail` struct, to track Storage Vault size measurements taken as part of jobs
 - Add `HasLicense` on `Office365MixedVirtualAccount` struct, and add `TotalLicensedMailsCount` and `TotalUnlicensedMailsCount` on `BackupJobDetail` struct, to track Office 365 license usage
 - Add `AdminWebAuthnRegistration` new `Type` field and `WEBAUTHN_DEVICE_TYPE` constants, to determine the type of hardware WebAuthn device
 - Add deprecation comments to U2F types (use WebAuthn instead), to `B2DestinationLocation.MaxConnections`, and to `Office365CustomSetting` (use Office365CustomSettingV2 instead)

data/Gemfile.lock

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

data/lib/comet/comet_server.rb

@@ -551,6 +551,52 @@ module Comet
       perform_request('api/v1/admin/branding/generate-client/macos-x86_64', submit_params)
     end
 
+    # AdminBrandingGenerateClientSpkDsm6
+    #
+    # Download software (Synology SPK for DSM 6).
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_spk_dsm_6(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('api/v1/admin/branding/generate-client/spk-dsm6', submit_params)
+    end
+
+    # AdminBrandingGenerateClientSpkDsm7
+    #
+    # Download software (Synology SPK for DSM 7).
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_spk_dsm_7(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('api/v1/admin/branding/generate-client/spk-dsm7', submit_params)
+    end
+
     # AdminBrandingGenerateClientTest
     #
     # Check if a software download is available.
@@ -828,8 +874,10 @@ module Comet
 
     # AdminCreateInstallToken
     #
-    # Create token for silent installation (Windows only).
+    # Create token for silent installation.
+    # Currently only supported for Windows & macOS only
     # Provide the installation token to silently install the client on windows `install.exe /TOKEN=<installtoken>`
+    # Provide the installation token to silently install the client on Mac OS `sudo launchctl setenv BACKUP_APP_TOKEN "installtoken" && sudo /usr/sbin/installer -allowUntrusted -pkg "Comet Backup.pkg" -target /`
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -1631,9 +1679,10 @@ module Comet
     # @param [String] target_id The live connection GUID
     # @param [String] destination The Storage Vault ID
     # @param [String] snapshot_id The selected backup job snapshot
-    # @param [String] tree_id (Optional) Browse objects inside subdirectory of backup snapshot
+    # @param [String] tree_id (Optional) Browse objects inside subdirectory of backup snapshot. If it is for VMDK single file restore, it should be the disk image's subtree ID.
+    # @param [Comet::VMDKSnapshotViewOptions] options (Optional) Request a list of stored objects in vmdk file
     # @return [Comet::DispatcherStoredObjectsResponse]
-    def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil)
+    def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil, options = nil)
       submit_params = {}
       raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
 
@@ -1649,6 +1698,11 @@ module Comet
 
         submit_params['TreeID'] = tree_id
       end
+      unless options.nil?
+        raise TypeError, "'options' expected Comet::VMDKSnapshotViewOptions, got #{options.class}" unless options.is_a? Comet::VMDKSnapshotViewOptions
+
+        submit_params['Options'] = options.to_json
+      end
 
       body = perform_request('api/v1/admin/dispatcher/request-stored-objects', submit_params)
       json_body = JSON.parse body

data/lib/comet/definitions.rb

@@ -9,6 +9,18 @@
 
 module Comet
 
+  # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
+  BACKUPJOBAUTORETENTION_AUTOMATIC = 0
+
+  # AutoRetentionLevel: The system will run a Retention Pass after every single backup job. This is more system-intensive, but is the most responsive at freeing storage space.
+  BACKUPJOBAUTORETENTION_IMMEDIATE = 1
+
+  # AutoRetentionLevel: The system will follow the automatic ruleset for a 'High Power' device.
+  BACKUPJOBAUTORETENTION_MORE_OFTEN = 2
+
+  # AutoRetentionLevel: The system will follow the automatic ruleset for a 'Low Power' device.
+  BACKUPJOBAUTORETENTION_LESS_OFTEN = 3
+
   # JobClassification:
   JOB_CLASSIFICATION__MIN = 4000
 
@@ -144,6 +156,8 @@ module Comet
   # FtpsModeType:
   FTPS_MODE_EXPLICIT = 2
 
+  INSTALLER_METADATA_FILE = 'installer.json'
+
   # Severity:
   SEVERITY_INFO = 'I'
 
@@ -197,6 +211,15 @@ module Comet
   # RestoreType:
   RESTORETYPE_OFFICE365_CLOUD = 6
 
+  # RestoreType:
+  RESTORETYPE_VMDK_FILE = 7
+
+  # RestoreType:
+  RESTORETYPE_VMDK_FILE_NULL = 8
+
+  # RestoreType:
+  RESTORETYPE_VMDK_FILE_ARCHIVE = 9
+
   # RestoreType: RESTORETYPE_PROCESS_ARCHIVE
   RESTORETYPE_PROCESS_TARBALL = 3
 
@@ -392,6 +415,18 @@ module Comet
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY = 'mssitelistdriveentity'
 
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_FILE = 'vmdkfile'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_DIRECTORY = 'vmdkdir'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_WINEFS = 'vmdkwinefs'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_VMDK_SYMLINK = 'vmdksymlink'
+
   # ExtraFileExclusionOSRestriction:
   OS_ANY = 0
 
@@ -430,13 +465,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.12.4'
+  APPLICATION_VERSION = '22.3.5'
 
-  APPLICATION_VERSION_MAJOR = 21
+  APPLICATION_VERSION_MAJOR = 22
 
-  APPLICATION_VERSION_MINOR = 12
+  APPLICATION_VERSION_MINOR = 3
 
-  APPLICATION_VERSION_REVISION = 4
+  APPLICATION_VERSION_REVISION = 5
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -448,6 +483,8 @@ module Comet
 
   TOTPREQUIRED_ERROR = 'ERR_TOTP_REQUIRED'
 
+  UNSUPPORT_VMDK_FILE_SYSTEM = 'ERR_UNSUPPORT_VMDK_FILE_SYSTEM'
+
   EMAIL_WORKER_STATE_NOT_STARTED = 0
 
   EMAIL_WORKER_STATE_STARTED = 1

data/lib/comet/models/backup_job_advanced_options.rb

@@ -32,6 +32,9 @@ module Comet
     # @type [Boolean] allow_zero_files_success
     attr_accessor :allow_zero_files_success
 
+    # @type [Number] auto_retention_level
+    attr_accessor :auto_retention_level
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -42,6 +45,7 @@ module Comet
     def clear
       @stop_after = 0
       @limit_vault_speed_bps = 0
+      @auto_retention_level = 0
       @unknown_json_fields = {}
     end
 
@@ -74,6 +78,10 @@ module Comet
           @use_on_disk_indexes = v
         when 'AllowZeroFilesSuccess'
           @allow_zero_files_success = v
+        when 'AutoRetentionLevel'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @auto_retention_level = v
         else
           @unknown_json_fields[k] = v
         end
@@ -89,6 +97,7 @@ module Comet
       ret['ReduceDiskConcurrency'] = @reduce_disk_concurrency
       ret['UseOnDiskIndexes'] = @use_on_disk_indexes
       ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
+      ret['AutoRetentionLevel'] = @auto_retention_level
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/backup_job_detail.rb

@@ -65,6 +65,9 @@ module Comet
     # @type [Number] download_size
     attr_accessor :download_size
 
+    # @type [Number] total_vm_count
+    attr_accessor :total_vm_count
+
     # @type [Number] total_mails_count
     attr_accessor :total_mails_count
 
@@ -117,6 +120,7 @@ module Comet
       @total_chunks = 0
       @upload_size = 0
       @download_size = 0
+      @total_vm_count = 0
       @total_mails_count = 0
       @total_sites_count = 0
       @total_accounts_count = 0
@@ -210,6 +214,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @download_size = v
+        when 'TotalVmCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_vm_count = v
         when 'TotalMailsCount'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -271,6 +279,9 @@ module Comet
       ret['TotalChunks'] = @total_chunks
       ret['UploadSize'] = @upload_size
       ret['DownloadSize'] = @download_size
+      unless @total_vm_count.nil?
+        ret['TotalVmCount'] = @total_vm_count
+      end
       unless @total_mails_count.nil?
         ret['TotalMailsCount'] = @total_mails_count
       end

data/lib/comet/models/backup_rule_config.rb

@@ -56,6 +56,9 @@ module Comet
     # @type [Boolean] allow_zero_files_success
     attr_accessor :allow_zero_files_success
 
+    # @type [Number] auto_retention_level
+    attr_accessor :auto_retention_level
+
     # @type [Array<Comet::ScheduleConfig>] schedules
     attr_accessor :schedules
 
@@ -80,6 +83,7 @@ module Comet
       @destination = ''
       @stop_after = 0
       @limit_vault_speed_bps = 0
+      @auto_retention_level = 0
       @schedules = []
       @event_triggers = Comet::BackupRuleEventTriggers.new
       @unknown_json_fields = {}
@@ -167,6 +171,10 @@ module Comet
           @use_on_disk_indexes = v
         when 'AllowZeroFilesSuccess'
           @allow_zero_files_success = v
+        when 'AutoRetentionLevel'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @auto_retention_level = v
         when 'Schedules'
           if v.nil?
             @schedules = []
@@ -203,6 +211,7 @@ module Comet
       ret['ReduceDiskConcurrency'] = @reduce_disk_concurrency
       ret['UseOnDiskIndexes'] = @use_on_disk_indexes
       ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
+      ret['AutoRetentionLevel'] = @auto_retention_level
       ret['Schedules'] = @schedules
       ret['EventTriggers'] = @event_triggers
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/branding_options.rb

@@ -71,6 +71,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
 
@@ -128,6 +131,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
@@ -225,6 +229,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
 
@@ -296,6 +304,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/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/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
 

data/lib/comet/models/update_campaign_options.rb

@@ -12,6 +12,9 @@ require 'json'
 module Comet
 
   # UpdateCampaignOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  # This data structure describes which devices should receive a remote software upgrade. Both the
+# target version criteria (UpgradeOlder/ReinstallCurrentVer/DowngradeNewer) and the target device
+# criteria (ApplyDeviceFilter/DeviceFilter) must be met in order for the remote upgrade to be applied.
   class UpdateCampaignOptions
 
     # @type [Boolean] active
@@ -26,6 +29,15 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # @type [Boolean] force_upgrade_running
+    attr_accessor :force_upgrade_running
+
+    # @type [Boolean] apply_device_filter
+    attr_accessor :apply_device_filter
+
+    # @type [Comet::SearchClause] device_filter
+    attr_accessor :device_filter
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -34,6 +46,7 @@ module Comet
     end
 
     def clear
+      @device_filter = Comet::SearchClause.new
       @unknown_json_fields = {}
     end
 
@@ -58,6 +71,13 @@ module Comet
           @reinstall_current_ver = v
         when 'DowngradeNewer'
           @downgrade_newer = v
+        when 'ForceUpgradeRunning'
+          @force_upgrade_running = v
+        when 'ApplyDeviceFilter'
+          @apply_device_filter = v
+        when 'DeviceFilter'
+          @device_filter = Comet::SearchClause.new
+          @device_filter.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -71,6 +91,9 @@ module Comet
       ret['UpgradeOlder'] = @upgrade_older
       ret['ReinstallCurrentVer'] = @reinstall_current_ver
       ret['DowngradeNewer'] = @downgrade_newer
+      ret['ForceUpgradeRunning'] = @force_upgrade_running
+      ret['ApplyDeviceFilter'] = @apply_device_filter
+      ret['DeviceFilter'] = @device_filter
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/update_campaign_properties.rb

@@ -26,6 +26,15 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # @type [Boolean] force_upgrade_running
+    attr_accessor :force_upgrade_running
+
+    # @type [Boolean] apply_device_filter
+    attr_accessor :apply_device_filter
+
+    # @type [Comet::SearchClause] device_filter
+    attr_accessor :device_filter
+
     # @type [Number] start_time
     attr_accessor :start_time
 
@@ -40,6 +49,7 @@ module Comet
     end
 
     def clear
+      @device_filter = Comet::SearchClause.new
       @start_time = 0
       @target_version = ''
       @unknown_json_fields = {}
@@ -66,6 +76,13 @@ module Comet
           @reinstall_current_ver = v
         when 'DowngradeNewer'
           @downgrade_newer = v
+        when 'ForceUpgradeRunning'
+          @force_upgrade_running = v
+        when 'ApplyDeviceFilter'
+          @apply_device_filter = v
+        when 'DeviceFilter'
+          @device_filter = Comet::SearchClause.new
+          @device_filter.from_hash(v)
         when 'StartTime'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -87,6 +104,9 @@ module Comet
       ret['UpgradeOlder'] = @upgrade_older
       ret['ReinstallCurrentVer'] = @reinstall_current_ver
       ret['DowngradeNewer'] = @downgrade_newer
+      ret['ForceUpgradeRunning'] = @force_upgrade_running
+      ret['ApplyDeviceFilter'] = @apply_device_filter
+      ret['DeviceFilter'] = @device_filter
       ret['StartTime'] = @start_time
       ret['TargetVersion'] = @target_version
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/update_campaign_status.rb

@@ -26,6 +26,15 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # @type [Boolean] force_upgrade_running
+    attr_accessor :force_upgrade_running
+
+    # @type [Boolean] apply_device_filter
+    attr_accessor :apply_device_filter
+
+    # @type [Comet::SearchClause] device_filter
+    attr_accessor :device_filter
+
     # @type [Number] start_time
     attr_accessor :start_time
 
@@ -43,6 +52,7 @@ module Comet
     end
 
     def clear
+      @device_filter = Comet::SearchClause.new
       @start_time = 0
       @target_version = ''
       @devices = []
@@ -70,6 +80,13 @@ module Comet
           @reinstall_current_ver = v
         when 'DowngradeNewer'
           @downgrade_newer = v
+        when 'ForceUpgradeRunning'
+          @force_upgrade_running = v
+        when 'ApplyDeviceFilter'
+          @apply_device_filter = v
+        when 'DeviceFilter'
+          @device_filter = Comet::SearchClause.new
+          @device_filter.from_hash(v)
         when 'StartTime'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -101,6 +118,9 @@ module Comet
       ret['UpgradeOlder'] = @upgrade_older
       ret['ReinstallCurrentVer'] = @reinstall_current_ver
       ret['DowngradeNewer'] = @downgrade_newer
+      ret['ForceUpgradeRunning'] = @force_upgrade_running
+      ret['ApplyDeviceFilter'] = @apply_device_filter
+      ret['DeviceFilter'] = @device_filter
       ret['StartTime'] = @start_time
       ret['TargetVersion'] = @target_version
       ret['Devices'] = @devices

data/lib/comet/models/user_profile_config.rb

@@ -12,6 +12,7 @@ require 'json'
 module Comet
 
   # UserProfileConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  # This is the main data structure for a user's profile.
   class UserProfileConfig
 
     # @type [String] username
@@ -26,6 +27,7 @@ module Comet
     # @type [String] language_code
     attr_accessor :language_code
 
+    # Tenant
     # @type [String] organization_id
     attr_accessor :organization_id
 
@@ -38,9 +40,11 @@ module Comet
     # @type [Boolean] send_email_reports
     attr_accessor :send_email_reports
 
+    # Storage Vaults
     # @type [Hash{String => Comet::DestinationConfig}] destinations
     attr_accessor :destinations
 
+    # Protected Items
     # @type [Hash{String => Comet::SourceConfig}] sources
     attr_accessor :sources
 
@@ -62,12 +66,17 @@ module Comet
     # @type [Number] maximum_devices
     attr_accessor :maximum_devices
 
+    # If the PolicyID field is set to a non-empty string, the Comet Server will enforce the contents of
+    # the Policy field based on the matching server's policy. Otherwise if the PolicyID field is set to an
+    # empty string, the administrator may configure any custom values in the Policy field.
     # @type [String] policy_id
     attr_accessor :policy_id
 
     # @type [Comet::UserPolicy] policy
     attr_accessor :policy
 
+    # To change the user's password, use the AdminResetUserPassword API instead of accessing these fields
+    # directly. Otherwise, other encrypted fields in the user profile may become corrupted.
     # @type [Number] password_format
     attr_accessor :password_format
 

data/lib/comet/models/vmdksnapshot_view_options.rb

@@ -0,0 +1,90 @@
+#!/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
+
+  # VMDKSnapshotViewOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class VMDKSnapshotViewOptions
+
+    # @type [Boolean] enabled
+    attr_accessor :enabled
+
+    # @type [String] partition_guid
+    attr_accessor :partition_guid
+
+    # @type [String] list_path
+    attr_accessor :list_path
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @partition_guid = ''
+      @list_path = ''
+      @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 'Enabled'
+          @enabled = v
+        when 'PartitionGUID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @partition_guid = v
+        when 'ListPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @list_path = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Enabled'] = @enabled
+      ret['PartitionGUID'] = @partition_guid
+      ret['ListPath'] = @list_path
+      @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_backup_ruby_sdk.rb

@@ -50,6 +50,7 @@ require_relative 'comet/models/content_measurement'
 require_relative 'comet/models/content_measurement_component'
 require_relative 'comet/models/create_group_policy_response'
 require_relative 'comet/models/custom_remote_bucket_settings'
+require_relative 'comet/models/days_of_week_config'
 require_relative 'comet/models/default_email_report_policy'
 require_relative 'comet/models/default_source_with_osrestriction'
 require_relative 'comet/models/destination_config'
@@ -72,6 +73,7 @@ require_relative 'comet/models/get_group_policy_response'
 require_relative 'comet/models/get_profile_and_hash_response_message'
 require_relative 'comet/models/get_profile_hash_response_message'
 require_relative 'comet/models/group_policy'
+require_relative 'comet/models/hour_sched_config'
 require_relative 'comet/models/hyper_vmachine_info'
 require_relative 'comet/models/install_creds'
 require_relative 'comet/models/install_token'
@@ -152,6 +154,7 @@ require_relative 'comet/models/user_policy'
 require_relative 'comet/models/user_profile_config'
 require_relative 'comet/models/user_profile_fragment'
 require_relative 'comet/models/vault_snapshot'
+require_relative 'comet/models/vmdksnapshot_view_options'
 require_relative 'comet/models/vsscomponent'
 require_relative 'comet/models/vsswriter_info'
 require_relative 'comet/models/wasabi_virtual_storage_role_settings'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - lib/comet/models/content_measurement_component.rb
 - lib/comet/models/create_group_policy_response.rb
 - lib/comet/models/custom_remote_bucket_settings.rb
+- lib/comet/models/days_of_week_config.rb
 - lib/comet/models/default_email_report_policy.rb
 - lib/comet/models/default_source_with_osrestriction.rb
 - lib/comet/models/destination_config.rb
@@ -148,6 +149,7 @@ files:
 - lib/comet/models/get_profile_and_hash_response_message.rb
 - lib/comet/models/get_profile_hash_response_message.rb
 - lib/comet/models/group_policy.rb
+- lib/comet/models/hour_sched_config.rb
 - lib/comet/models/hyper_vmachine_info.rb
 - lib/comet/models/install_creds.rb
 - lib/comet/models/install_token.rb
@@ -228,6 +230,7 @@ files:
 - lib/comet/models/user_profile_config.rb
 - lib/comet/models/user_profile_fragment.rb
 - lib/comet/models/vault_snapshot.rb
+- lib/comet/models/vmdksnapshot_view_options.rb
 - lib/comet/models/vsscomponent.rb
 - lib/comet/models/vsswriter_info.rb
 - lib/comet/models/wasabi_virtual_storage_role_settings.rb