comet_backup_ruby_sdk 1.5.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e207ce3e89091839b912a7f7ee7de17315de2474890d7560b5b79f1afee434c5
-  data.tar.gz: d85eddeaa1e27a71d3d1415742afa28808e8575f2a46bf20d56a7b0da75a3c9f
+  metadata.gz: bcf25f477167c1899508aee3c92beaba73a3832634a7b377915c26c11f5c0dec
+  data.tar.gz: 3a5a94ec4b0cddfd10ed3f819921cd1df9cf192aa76936562eaecd0f61b603b6
 SHA512:
-  metadata.gz: 566f2c136d8c7af458ab75d6fd9f0117ab68a5c114e1ab589af8990773f8e6850326d323380aec56a36332e6bfc85686ce5cbdafeeb358ccb5a0058a2d051e0e
-  data.tar.gz: c92c6256810c4dcaec62ee81ff44ebc2944b97c41a5fa193200b340f523973ea74fee4c4372d37321356020c9323723e7137d2b4593b8fc381ef00abcd96212c
+  metadata.gz: 435a8de3e5dc71585979cfc43549a1871fbf47d9b4a6b7575e559dd5b9cc1fd4fd3dd0a5aa2c036424b10e2f626cce5d3f18020ea3c884240c94190cbec08354
+  data.tar.gz: 3e876fa42cdfad439f0cf3db82f4536a915ec4e4033721c111d1e9435f15fe01167e79320532fff0a9cb5f9cd41f9195a71e00d26849b1eb3ac88a64f0b7918c

data/.rubocop.yml

@@ -23,3 +23,8 @@ Layout/EmptyLinesAroundClassBody:
 # with the times when we do need multi-line bodies
 Style/IfUnlessModifier:
   Enabled: false
+
+  # allow rocket hashes
+
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # CHANGELOG
 
+## 2021-10-21 1.9.0
+- Based on 21.9.7
+- Add Support for `HideFiles` parameter in B2 Destination Locations
+- Add support for `RegistrationTime` to `DeviceConfig`
+- Upgrade MYSQL to support new TLS connection options
+- Add support for new API: `AdminMetaReadAllLogsRequest` and `AdminDispatcherRequestWindiskSnapshot`
+
+## 2021-09-14 1.8.0
+- Based on Comet 21.9.2
+- Support new `custom_headers` field on the `WebhookOption` class for specifying custom HTTP headers
+  to be sent in webhook POST requests from Comet Server
+
+## 2021-09-08 v1.7.0
+- Based on Comet 21.9.1
+- Support new `device_timezone` field on the `DeviceConfig` class. 
+- Add `admin_dispatcher_ping_destination` api method
+- Add support for new retention range type constants: `RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAY`
+- Add support for new retention range type constants: `RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEK`
+- Add support for new retention range type constants: `RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTH`
+- Add support for Microsoft Office 365 Sharepoiint constant `STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_PUBLIC`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_CHINA`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_GERMANY`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_US_GOVT`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_US_DOD`
+
+## 2021-07-01 v1.6.0
+- Based on Comet 21.6.6
+- Support new `DefaultSourceWithOSRestriction` and `LastSuccessfulBackupJob` fields
+- Support custom credentials when performing a cloud Office 365 restore job
+- Support identifying Microsoft Teams folders inside a Sharepoint backup job
+- Document the `SourceIncludePattern` structure used for `PINCLUDE`/`RINCLUDE` rules in a File-type `EngineProps` array
+- Document existing `BrandingProps` endpoint
+
 ## 2021-05-25 v1.5.0
 - Based on Comet 21.6.1
 - Add new APIs to remotely browse MySQL, MongoDB, MSSQL database servers

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (1.4.0)
+    comet_backup_ruby_sdk (1.9.0)
 
 GEM
   remote: https://rubygems.org/
@@ -40,4 +40,4 @@ DEPENDENCIES
   rubocop (~> 0.88)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -84,7 +84,7 @@ end
 ```ruby
 bundle exec rake rubocop
 
-COMETSERVER_ADDRESS='http://127.0.0.1:8060' \
+  COMETSERVER_ADDRESS='http://127.0.0.1:8060' \
 	COMETSERVER_ADMINUSER=admin \
 	COMETSERVER_ADMINPASS=admin \
 	bundle exec rake test

data/RELEASING.md

@@ -1,10 +1,13 @@
 # Procedure for releasing gem package updates
 
+0. As a cygwin user, with docker installed; `docker run -it -v "c://cygwin64/$PWD":/app -w /app ruby:2.7 bash` will get you with a suitable ruby environment for testing/building and releasing this package9.
 1. All tests passing
 2. Update changelog in `CHANGELOG.md`
-3. Update version number in `gemspec`
-4. `gem build comet_backup_ruby_sdk`
+3. Update version number in `comet_backup_ruby_sdk.gemspec`
+4. `bundle install`
+	- Should update our internal version in Gemfile.lock
+5. `gem build comet_backup_ruby_sdk.gemspec`
 	- Should be warning-free
-5. Git tag
+6. Git tag
 	- Respect semver
-6. `gem push comet_backup_ruby_sdk-0.x.x.gem`
+7. `gem push comet_backup_ruby_sdk-1.x.x.gem`

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.5.0'
+  spec.version       = '1.9.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -808,6 +808,7 @@ module Comet
     # This does not remove any storage buckets. Unused storage buckets will be cleaned up by the Constellation Role.
     # Any stored data can not be decrypted without the user profile. Misuse can cause data loss!
     # This also allows to uninstall software from active devices under the user account
+    # This also removes all job history for the user account.
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -1076,6 +1077,33 @@ module Comet
       ret
     end
 
+    # AdminDispatcherPingDestination
+    #
+    # Test the connection to the storage bucket.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::DestinationLocation] extra_data The destination location settings
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_ping_destination(target_id, extra_data)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'extra_data' expected Comet::DestinationLocation, got #{extra_data.class}" unless extra_data.is_a? Comet::DestinationLocation
+
+      submit_params['ExtraData'] = extra_data.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/ping-destination', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRefetchProfile
     #
     # Instruct a live connected device to refresh their profile.
@@ -1535,6 +1563,37 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRequestWindiskSnapshot
+    #
+    # Request a Disk Image snapshot with the windiskbrowse-style from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault ID
+    # @param [String] snapshot_id The Snapshot ID
+    # @return [Comet::DispatcherWindiskSnapshotResponse]
+    def admin_dispatcher_request_windisk_snapshot(target_id, destination, snapshot_id)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'destination' expected String, got #{destination.class}" unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      raise TypeError, "'snapshot_id' expected String, got #{snapshot_id.class}" unless snapshot_id.is_a? String
+
+      submit_params['SnapshotID'] = snapshot_id
+
+      body = perform_request('api/v1/admin/dispatcher/request-windisk-snapshot', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::DispatcherWindiskSnapshotResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRunBackup
     #
     # Instruct a live connected device to run a scheduled backup.
@@ -2111,6 +2170,7 @@ module Comet
     # Cancel a running job.
     # A request is sent to the live-connected device, asking it to cancel the operation. This may fail if there is no live-connection.
     # Only jobs from Comet 18.3.5 or newer can be cancelled. A job can only be cancelled if it has a non-empty CancellationID field in its properties.
+    # If the device is running Comet 21.9.5 or later, this API will wait up to ten seconds for a confirmation from the client.
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -2290,6 +2350,20 @@ module Comet
       ret
     end
 
+    # AdminMetaReadAllLogs
+    #
+    # Get a ZIP file of all of the server's log files.
+    # On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2.
+    # This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
+    #
+    # @return [String]
+    def admin_meta_read_all_logs
+      perform_request('api/v1/admin/meta/read-all-logs')
+    end
+
     # AdminMetaReadLogs
     #
     # Get log file content.
@@ -3455,7 +3529,7 @@ module Comet
 
       ret_error = Comet::CometAPIResponseMessage.new
       ret_error.from_hash(obj)
-      raise Comet::APIResponseError.new(ret_error)
+      raise Comet::APIResponseError.new(ret_error), 'Comet API response status was not OK'
     end
 
     # Perform a synchronous HTTP request.
@@ -3492,7 +3566,7 @@ module Comet
 
       form_params = []
       params.each do |k, v|
-        form_params.append [k, v, {:filename => k}]
+        form_params.append [k, v, { :filename => k }]
       end
       req.set_form(form_params, 'multipart/form-data')
 

data/lib/comet/definitions.rb

@@ -224,8 +224,17 @@ module Comet
   # RetentionRangeType: Uses Weeks, WeekOffset
   RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_WEEKS = 906
 
+  # RetentionRangeType: Uses Jobs
+  RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAY = 907
+
+  # RetentionRangeType: Uses Jobs
+  RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEK = 908
+
+  # RetentionRangeType: Uses Jobs
+  RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTH = 909
+
   # RetentionRangeType:
-  RETENTIONRANGE__HIGHEST = 906
+  RETENTIONRANGE__HIGHEST = 909
 
   RETENTIONRANGE_MAXINT = 1_125_899_906_842_624
 
@@ -353,12 +362,18 @@ module Comet
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITE = 'mssite'
 
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITE_TEAM = 'mssiteteam'
+
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITELISTENTITY = 'mssitelistentity'
 
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITEITEMENTITY = 'mssiteitementity'
 
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY = 'mssitelistdriveentity'
+
   # ExtraFileExclusionOSRestriction:
   OS_ANY = 0
 
@@ -397,13 +412,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.6.1'
+  APPLICATION_VERSION = '21.9.7'
 
   APPLICATION_VERSION_MAJOR = 21
 
-  APPLICATION_VERSION_MINOR = 6
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 1
+  APPLICATION_VERSION_REVISION = 7
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -576,6 +591,9 @@ module Comet
   # MacOSCodesignLevel:
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
 
+  # StreamableEventType:
+  SEVT__MIN = 4000
+
   # StreamableEventType: Event is emitted when the webhook is registered, or when the server starts up. The Data associated is ServerMetaVersionInfo
   SEVT_META_HELLO = 4000
 
@@ -597,4 +615,17 @@ module Comet
   # StreamableEventType: Data is the string bucket ref
   SEVT_BUCKET_NEW = 4300
 
+  # StreamableEventType:
+  SEVT__MAX = 4999
+
+  OFFICE365_REGION_PUBLIC = 'GlobalPublicCloud'
+
+  OFFICE365_REGION_CHINA = 'ChinaCloud'
+
+  OFFICE365_REGION_GERMANY = 'GermanCloud'
+
+  OFFICE365_REGION_US_GOVT = 'USGovtGccCloud'
+
+  OFFICE365_REGION_US_DOD = 'USGovtGccDoDCloud'
+
 end

data/lib/comet/models/b2destination_location.rb

@@ -29,6 +29,9 @@ module Comet
     # @type [Number] max_connections
     attr_accessor :max_connections
 
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -78,6 +81,8 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @max_connections = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
         else
           @unknown_json_fields[k] = v
         end
@@ -102,6 +107,9 @@ module Comet
       unless @max_connections.nil?
         ret['MaxConnections'] = @max_connections
       end
+      unless @hide_deleted_files.nil?
+        ret['HideDeletedFiles'] = @hide_deleted_files
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/b2virtual_storage_role_settings.rb

@@ -23,6 +23,9 @@ module Comet
     # @type [String] app_key
     attr_accessor :app_key
 
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -62,6 +65,8 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @app_key = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
         else
           @unknown_json_fields[k] = v
         end
@@ -74,6 +79,7 @@ module Comet
       ret['MasterBucket'] = @master_bucket
       ret['KeyID'] = @key_id
       ret['AppKey'] = @app_key
+      ret['HideDeletedFiles'] = @hide_deleted_files
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/default_source_with_osrestriction.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # DefaultSourceWithOSRestriction is a typed class wrapper around the underlying Comet Server API data structure.
+  class DefaultSourceWithOSRestriction
+
+    # @type [Comet::SourceConfig] source_config
+    attr_accessor :source_config
+
+    # @type [Number] restrict_os
+    attr_accessor :restrict_os
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @source_config = Comet::SourceConfig.new
+      @restrict_os = 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 'SourceConfig'
+          @source_config = Comet::SourceConfig.new
+          @source_config.from_hash(v)
+        when 'RestrictOS'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @restrict_os = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SourceConfig'] = @source_config
+      ret['RestrictOS'] = @restrict_os
+      @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/device_config.rb

@@ -17,12 +17,18 @@ module Comet
     # @type [String] friendly_name
     attr_accessor :friendly_name
 
+    # @type [Number] registration_time
+    attr_accessor :registration_time
+
     # @type [Comet::OSInfo] platform_version
     attr_accessor :platform_version
 
     # @type [Hash{String => Comet::SourceBasicInfo}] sources
     attr_accessor :sources
 
+    # @type [String] device_timezone
+    attr_accessor :device_timezone
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -32,8 +38,10 @@ module Comet
 
     def clear
       @friendly_name = ''
+      @registration_time = 0
       @platform_version = Comet::OSInfo.new
       @sources = {}
+      @device_timezone = ''
       @unknown_json_fields = {}
     end
 
@@ -54,6 +62,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @friendly_name = v
+        when 'RegistrationTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @registration_time = v
         when 'PlatformVersion'
           @platform_version = Comet::OSInfo.new
           @platform_version.from_hash(v)
@@ -67,6 +79,10 @@ module Comet
               @sources[k1].from_hash(v1)
             end
           end
+        when 'DeviceTimezone'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_timezone = v
         else
           @unknown_json_fields[k] = v
         end
@@ -77,12 +93,18 @@ module Comet
     def to_hash
       ret = {}
       ret['FriendlyName'] = @friendly_name
+      unless @registration_time.nil?
+        ret['RegistrationTime'] = @registration_time
+      end
       unless @platform_version.nil?
         ret['PlatformVersion'] = @platform_version
       end
       unless @sources.nil?
         ret['Sources'] = @sources
       end
+      unless @device_timezone.nil?
+        ret['DeviceTimezone'] = @device_timezone
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/dispatcher_windisk_snapshot_response.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # DispatcherWindiskSnapshotResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class DispatcherWindiskSnapshotResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::DiskDrive>] windisk_snapshot
+    attr_accessor :windisk_snapshot
+
+    # @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 = ''
+      @windisk_snapshot = []
+      @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 'WindiskSnapshot'
+          if v.nil?
+            @windisk_snapshot = []
+          else
+            @windisk_snapshot = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @windisk_snapshot[i1] = Comet::DiskDrive.new
+              @windisk_snapshot[i1].from_hash(v1)
+            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['WindiskSnapshot'] = @windisk_snapshot
+      @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/live_user_connection.rb

@@ -29,6 +29,9 @@ module Comet
     # @type [Comet::OSInfo] reported_platform_version
     attr_accessor :reported_platform_version
 
+    # @type [String] device_time_zone
+    attr_accessor :device_time_zone
+
     # @type [String] ipaddress
     attr_accessor :ipaddress
 
@@ -51,6 +54,7 @@ module Comet
       @reported_version = ''
       @reported_platform = ''
       @reported_platform_version = Comet::OSInfo.new
+      @device_time_zone = ''
       @ipaddress = ''
       @connection_time = 0
       @unknown_json_fields = {}
@@ -88,6 +92,10 @@ module Comet
         when 'ReportedPlatformVersion'
           @reported_platform_version = Comet::OSInfo.new
           @reported_platform_version.from_hash(v)
+        when 'DeviceTimeZone'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_time_zone = v
         when 'IPAddress'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -114,6 +122,9 @@ module Comet
       unless @reported_platform_version.nil?
         ret['ReportedPlatformVersion'] = @reported_platform_version
       end
+      unless @device_time_zone.nil?
+        ret['DeviceTimeZone'] = @device_time_zone
+      end
       unless @ipaddress.nil?
         ret['IPAddress'] = @ipaddress
       end

data/lib/comet/models/my_sqlconnection.rb

@@ -26,6 +26,21 @@ module Comet
     # @type [String] password
     attr_accessor :password
 
+    # @type [Boolean] use_tls
+    attr_accessor :use_tls
+
+    # @type [Boolean] tlsskip_verify
+    attr_accessor :tlsskip_verify
+
+    # @type [String] tlscustom_server_capath
+    attr_accessor :tlscustom_server_capath
+
+    # @type [String] tlscustom_client_crt_path
+    attr_accessor :tlscustom_client_crt_path
+
+    # @type [String] tlscustom_client_key_path
+    attr_accessor :tlscustom_client_key_path
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -38,6 +53,9 @@ module Comet
       @port = ''
       @username = ''
       @password = ''
+      @tlscustom_server_capath = ''
+      @tlscustom_client_crt_path = ''
+      @tlscustom_client_key_path = ''
       @unknown_json_fields = {}
     end
 
@@ -70,6 +88,22 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @password = v
+        when 'UseTLS'
+          @use_tls = v
+        when 'TLSSkipVerify'
+          @tlsskip_verify = v
+        when 'TLSCustomServerCAPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tlscustom_server_capath = v
+        when 'TLSCustomClientCrtPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tlscustom_client_crt_path = v
+        when 'TLSCustomClientKeyPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tlscustom_client_key_path = v
         else
           @unknown_json_fields[k] = v
         end
@@ -83,6 +117,11 @@ module Comet
       ret['Port'] = @port
       ret['Username'] = @username
       ret['Password'] = @password
+      ret['UseTLS'] = @use_tls
+      ret['TLSSkipVerify'] = @tlsskip_verify
+      ret['TLSCustomServerCAPath'] = @tlscustom_server_capath
+      ret['TLSCustomClientCrtPath'] = @tlscustom_client_crt_path
+      ret['TLSCustomClientKeyPath'] = @tlscustom_client_key_path
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/restore_job_advanced_options.rb

@@ -32,6 +32,9 @@ module Comet
     # @type [Number] archive_format
     attr_accessor :archive_format
 
+    # @type [Comet::Office365Credential] office_365credential
+    attr_accessor :office_365credential
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -44,6 +47,7 @@ module Comet
       @dest_path = ''
       @exact_dest_paths = []
       @archive_format = 0
+      @office_365credential = Comet::Office365Credential.new
       @unknown_json_fields = {}
     end
 
@@ -87,6 +91,9 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @archive_format = v
+        when 'Office365Credential'
+          @office_365credential = Comet::Office365Credential.new
+          @office_365credential.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -102,6 +109,9 @@ module Comet
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths
       ret['ArchiveFormat'] = @archive_format
+      unless @office_365credential.nil?
+        ret['Office365Credential'] = @office_365credential
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/server_meta_branding_properties.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # ServerMetaBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
+  class ServerMetaBrandingProperties
+
+    # @type [String] brand_name
+    attr_accessor :brand_name
+
+    # @type [String] product_name
+    attr_accessor :product_name
+
+    # @type [Boolean] has_image
+    attr_accessor :has_image
+
+    # @type [String] top_color
+    attr_accessor :top_color
+
+    # @type [Boolean] hide_news_area
+    attr_accessor :hide_news_area
+
+    # @type [Boolean] allow_unauthenticated_downloads
+    attr_accessor :allow_unauthenticated_downloads
+
+    # @type [Boolean] allow_authenticated_downloads
+    attr_accessor :allow_authenticated_downloads
+
+    # @type [Number] prune_logs_after_days
+    attr_accessor :prune_logs_after_days
+
+    # @type [Number] expired_in_seconds
+    attr_accessor :expired_in_seconds
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @brand_name = ''
+      @product_name = ''
+      @top_color = ''
+      @prune_logs_after_days = 0
+      @expired_in_seconds = 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 'BrandName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @brand_name = v
+        when 'ProductName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @product_name = v
+        when 'HasImage'
+          @has_image = v
+        when 'TopColor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @top_color = v
+        when 'HideNewsArea'
+          @hide_news_area = v
+        when 'AllowUnauthenticatedDownloads'
+          @allow_unauthenticated_downloads = v
+        when 'AllowAuthenticatedDownloads'
+          @allow_authenticated_downloads = v
+        when 'PruneLogsAfterDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @prune_logs_after_days = v
+        when 'ExpiredInSeconds'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @expired_in_seconds = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['BrandName'] = @brand_name
+      ret['ProductName'] = @product_name
+      ret['HasImage'] = @has_image
+      ret['TopColor'] = @top_color
+      ret['HideNewsArea'] = @hide_news_area
+      ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
+      ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads
+      ret['PruneLogsAfterDays'] = @prune_logs_after_days
+      ret['ExpiredInSeconds'] = @expired_in_seconds
+      @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/source_include_pattern.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # SourceIncludePattern is a typed class wrapper around the underlying Comet Server API data structure.
+  class SourceIncludePattern
+
+    # @type [String] top_directory
+    attr_accessor :top_directory
+
+    # @type [String] value
+    attr_accessor :value
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @top_directory = ''
+      @value = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'TopDirectory'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @top_directory = v
+        when 'Value'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @value = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['TopDirectory'] = @top_directory
+      ret['Value'] = @value
+      @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/source_statistics.rb

@@ -17,6 +17,9 @@ module Comet
     # @type [Comet::BackupJobDetail] last_backup_job
     attr_accessor :last_backup_job
 
+    # @type [Comet::BackupJobDetail] last_successful_backup_job
+    attr_accessor :last_successful_backup_job
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -26,6 +29,7 @@ module Comet
 
     def clear
       @last_backup_job = Comet::BackupJobDetail.new
+      @last_successful_backup_job = Comet::BackupJobDetail.new
       @unknown_json_fields = {}
     end
 
@@ -45,6 +49,9 @@ module Comet
         when 'LastBackupJob'
           @last_backup_job = Comet::BackupJobDetail.new
           @last_backup_job.from_hash(v)
+        when 'LastSuccessfulBackupJob'
+          @last_successful_backup_job = Comet::BackupJobDetail.new
+          @last_successful_backup_job.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -55,6 +62,7 @@ module Comet
     def to_hash
       ret = {}
       ret['LastBackupJob'] = @last_backup_job
+      ret['LastSuccessfulBackupJob'] = @last_successful_backup_job
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/user_policy.rb

@@ -107,6 +107,9 @@ module Comet
     # @type [Hash{String => Comet::BackupRuleConfig}] default_sources_backup_rules
     attr_accessor :default_sources_backup_rules
 
+    # @type [Hash{String => Comet::DefaultSourceWithOSRestriction}] default_sources_with_osrestriction
+    attr_accessor :default_sources_with_osrestriction
+
     # @type [Hash{String => Comet::BackupRuleConfig}] default_backup_rules
     attr_accessor :default_backup_rules
 
@@ -129,6 +132,7 @@ module Comet
       @default_storage_vault_retention = Comet::RetentionPolicy.new
       @default_sources = {}
       @default_sources_backup_rules = {}
+      @default_sources_with_osrestriction = {}
       @default_backup_rules = {}
       @unknown_json_fields = {}
     end
@@ -244,6 +248,16 @@ module Comet
               @default_sources_backup_rules[k1].from_hash(v1)
             end
           end
+        when 'DefaultSourcesWithOSRestriction'
+          @default_sources_with_osrestriction = {}
+          if v.nil?
+            @default_sources_with_osrestriction = {}
+          else
+            v.each do |k1, v1|
+              @default_sources_with_osrestriction[k1] = Comet::DefaultSourceWithOSRestriction.new
+              @default_sources_with_osrestriction[k1].from_hash(v1)
+            end
+          end
         when 'DefaultBackupRules'
           @default_backup_rules = {}
           if v.nil?
@@ -304,6 +318,7 @@ module Comet
       ret['PreventProtectedItemRetention'] = @prevent_protected_item_retention
       ret['DefaultSources'] = @default_sources
       ret['DefaultSourcesBackupRules'] = @default_sources_backup_rules
+      ret['DefaultSourcesWithOSRestriction'] = @default_sources_with_osrestriction
       ret['DefaultBackupRules'] = @default_backup_rules
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/webhook_option.rb

@@ -20,6 +20,9 @@ module Comet
     # @type [Array<Number>] white_listed_event_types
     attr_accessor :white_listed_event_types
 
+    # @type [Hash{String => String}] custom_headers
+    attr_accessor :custom_headers
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -30,6 +33,7 @@ module Comet
     def clear
       @url = ''
       @white_listed_event_types = []
+      @custom_headers = {}
       @unknown_json_fields = {}
     end
 
@@ -61,6 +65,17 @@ module Comet
               @white_listed_event_types[i1] = v1
             end
           end
+        when 'CustomHeaders'
+          @custom_headers = {}
+          if v.nil?
+            @custom_headers = {}
+          else
+            v.each do |k1, v1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @custom_headers[k1] = v1
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -72,6 +87,7 @@ module Comet
       ret = {}
       ret['URL'] = @url
       ret['WhiteListedEventTypes'] = @white_listed_event_types
+      ret['CustomHeaders'] = @custom_headers
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet_backup_ruby_sdk.rb

@@ -48,6 +48,7 @@ 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/default_email_report_policy'
+require_relative 'comet/models/default_source_with_osrestriction'
 require_relative 'comet/models/destination_config'
 require_relative 'comet/models/destination_location'
 require_relative 'comet/models/destination_statistics'
@@ -106,6 +107,7 @@ require_relative 'comet/models/search_clause'
 require_relative 'comet/models/self_backup_statistics'
 require_relative 'comet/models/server_config_options_branding_fragment'
 require_relative 'comet/models/server_config_options_software_build_role_fragment'
+require_relative 'comet/models/server_meta_branding_properties'
 require_relative 'comet/models/server_meta_version_info'
 require_relative 'comet/models/session_key_regenerated_response'
 require_relative 'comet/models/sftpdestination_location'
@@ -114,6 +116,7 @@ require_relative 'comet/models/software_build_role_options'
 require_relative 'comet/models/software_update_news_response'
 require_relative 'comet/models/source_basic_info'
 require_relative 'comet/models/source_config'
+require_relative 'comet/models/source_include_pattern'
 require_relative 'comet/models/source_statistics'
 require_relative 'comet/models/spanned_destination_location'
 require_relative 'comet/models/spanned_storage_extra_info'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- comet_backup_ruby_sdk-1.8.0.gem
 - comet_backup_ruby_sdk.gemspec
 - lib/comet/api_response_error.rb
 - lib/comet/comet_server.rb
@@ -123,6 +124,7 @@ files:
 - lib/comet/models/create_group_policy_response.rb
 - lib/comet/models/custom_remote_bucket_settings.rb
 - lib/comet/models/default_email_report_policy.rb
+- lib/comet/models/default_source_with_osrestriction.rb
 - lib/comet/models/destination_config.rb
 - lib/comet/models/destination_location.rb
 - lib/comet/models/destination_statistics.rb
@@ -131,6 +133,7 @@ files:
 - lib/comet/models/dispatcher_admin_sources_response.rb
 - lib/comet/models/dispatcher_stored_objects_response.rb
 - lib/comet/models/dispatcher_vault_snapshots_response.rb
+- lib/comet/models/dispatcher_windisk_snapshot_response.rb
 - lib/comet/models/edbfile_info.rb
 - lib/comet/models/email_options.rb
 - lib/comet/models/email_report_config.rb
@@ -181,6 +184,7 @@ files:
 - lib/comet/models/self_backup_statistics.rb
 - lib/comet/models/server_config_options_branding_fragment.rb
 - lib/comet/models/server_config_options_software_build_role_fragment.rb
+- lib/comet/models/server_meta_branding_properties.rb
 - lib/comet/models/server_meta_version_info.rb
 - lib/comet/models/session_key_regenerated_response.rb
 - lib/comet/models/sftpdestination_location.rb
@@ -189,6 +193,7 @@ files:
 - lib/comet/models/software_update_news_response.rb
 - lib/comet/models/source_basic_info.rb
 - lib/comet/models/source_config.rb
+- lib/comet/models/source_include_pattern.rb
 - lib/comet/models/source_statistics.rb
 - lib/comet/models/spanned_destination_location.rb
 - lib/comet/models/spanned_storage_extra_info.rb
@@ -245,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Comet Backup - Comet Server API SDK