comet_backup_ruby_sdk 2.6.0 → 2.8.0

data/lib/comet/models/source_config.rb

@@ -12,6 +12,7 @@ module Comet
   # SourceConfig is a typed class wrapper around the underlying Comet Server API data structure.
   class SourceConfig
 
+    # One of the ENGINE_BUILTIN_ constants
     # @type [String] engine
     attr_accessor :engine
 
@@ -27,18 +28,68 @@ module Comet
     # @type [Number] modify_time
     attr_accessor :modify_time
 
+    # Custom commands to run before the job
     # @type [Array<String>] pre_exec
     attr_accessor :pre_exec
 
+    # Custom commands to run after taking a disk snapshot
     # @type [Array<String>] thaw_exec
     attr_accessor :thaw_exec
 
+    # Custom commands to run after the job
     # @type [Array<String>] post_exec
     attr_accessor :post_exec
 
+    # Configuration for the selected Protected Item type. Each "Engine" supports
+    # different configuration options for the EngineProps values.
+    #
+    # For engine1/file, Comet understands the following EngineProp keys:
+    #
+    # - Any key starting with INCLUDE: A path that is included
+    # - Any key starting with EXCLUDE: An exclusion (glob format)
+    # - Any key starting with REXCLUDE: An exclusion (regular expression format)
+    # - Any key starting with PINCLUDE: A JSON string {"TopDirectory": "", "Value": ""}. TopDirectory is
+    # the path where starts to match the value; Value is an inclusion (glob format)
+    # - Any key starting with RINCLUDE: A JSON string {"TopDirectory": "", "Value": ""}. TopDirectory is
+    # the path where starts to match the value; Value is an inclusion (regular expression format)
+    # - Any key starting with SMBAUTH: A set of Windows network share credentials in WinSMBAuth JSON
+    # format
+    # - USE_WIN_VSS: If present, the 'Take filesystem snapshot' checkbox is checked
+    # - CONFIRM_EFS: If present, the 'Dismiss EFS warning' checkbox is checked
+    # - RESCAN_UNCHANGED: If present, the 'Rescan unchanged files' checkbox is checked
+    #
+    # For engine1/mssql, Comet understands the following EngineProp keys:
+    #
+    # - ALL_DATABASES: If present, include all databases with specified exclusions. If not present, only
+    # back up the specified inclusions
+    # - Any key starting with DATABASE- : A database that is included. Only valid if ALL_DATABASES is
+    # not present.
+    # - Any key starting with EXCEPT-DATABASE- : A database that is excluded. Only valid if
+    # ALL_DATABASES is present.
+    # - INSTANCE: The Microsoft SQL Server instance name
+    # - USERNAME: The username to connect to Microsoft SQL Server
+    # - PASSWORD: The password to connect to Microsoft SQL Server
+    # - AUTHMODE: Either "windows" or "native" (corresponding to the declared MSSQL_AUTH_WINDOWS and
+    # MSSQL_AUTH_NATIVE constant values). If not present, use native authentication if the USERNAME
+    # and/or PASSWORD fields are filled in, use windows authentication if they are blank
+    # - METHOD: Either "OLEDB_NATIVE" or "OLEDB_32" (corresponding to the declared
+    # MSSQL_METHOD_OLEDB_NATIVE and MSSQL_METHOD_OLEDB_32 constant values). If not present, defaults to
+    # Native
+    # - DIFFBASE: If present, take a "Full (base image)" backup job. Otherwise, take a "Full (copy
+    # only)" backup job.
+    # - DIFFERENTIAL: If present, take a "Differential increment" backup job. Otherwise, take a "Full
+    # (copy only)" backup job.
+    # - LOGTRUNC: If present, take a "Log (truncating)" backup job. Otherwise, take a "Full (copy only)"
+    # backup job.
+    # - LOGNOTRUNC: If present, take a "Log (no truncation)" backup job. Otherwise, take a "Full (copy
+    # only)" backup job.
+    #
     # @type [Hash{String => String}] engine_props
     attr_accessor :engine_props
 
+    # By default, backup jobs from this Protected Item will be subject
+    # to the overall retention policy for the Storage Vault. You can override the policy
+    # for specific Storage Vaults by putting their destination ID as a key here.
     # @type [Hash{String => Comet::RetentionPolicy}] override_destination_retention
     attr_accessor :override_destination_retention
 

data/lib/comet/models/sshconnection.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] sshusername
     attr_accessor :sshusername
 
+    # One of the SSHCONNECTION_AUTHMODE_ constants
     # @type [Number] sshauth_mode
     attr_accessor :sshauth_mode
 

data/lib/comet/models/swift_destination_location.rb

@@ -12,24 +12,30 @@ module Comet
   # SwiftDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
   class SwiftDestinationLocation
 
+    # Username or UserID or Application Credential name or Application Credential ID, or blank for token
+    # authentication
     # @type [String] username
     attr_accessor :username
 
+    # User Password, or Application Credential Key, or token if the Username field is blank
     # @type [String] apikey
     attr_accessor :apikey
 
     # @type [String] region
     attr_accessor :region
 
+    # Mandatory
     # @type [String] auth_url
     attr_accessor :auth_url
 
     # @type [String] domain
     attr_accessor :domain
 
+    # Tenant name (v2) or Project name (v3)
     # @type [String] tenant
     attr_accessor :tenant
 
+    # Project domain name (v3)
     # @type [String] tenant_domain
     attr_accessor :tenant_domain
 
@@ -40,6 +46,7 @@ module Comet
     attr_accessor :trust_id
 
     # @type [String] auth_token
+    # @deprecated This member has been deprecated since Comet version 17.8.0
     attr_accessor :auth_token
 
     # @type [String] prefix

data/lib/comet/models/test_response.rb

@@ -12,6 +12,7 @@ module Comet
   # TestResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class TestResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/time_span.rb

@@ -12,9 +12,11 @@ module Comet
   # TimeSpan is a typed class wrapper around the underlying Comet Server API data structure.
   class TimeSpan
 
+    # SCHEDULE_FREQUENCY_<TYPE>
     # @type [Number] frequency_type
     attr_accessor :frequency_type
 
+    # Used for Periodic and Once Only
     # @type [Number] seconds
     attr_accessor :seconds
 

data/lib/comet/models/totp_regenerated_response.rb

@@ -12,6 +12,7 @@ module Comet
   # TotpRegeneratedResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class TotpRegeneratedResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/u2fregistration_challenge_response.rb

@@ -13,6 +13,7 @@ module Comet
   # @deprecated This type has been deprecated since Comet version 21.12.0
   class U2FRegistrationChallengeResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/uninstall_config.rb

@@ -10,11 +10,15 @@ require 'json'
 module Comet
 
   # UninstallConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  # UninstallConfig allows configuring whether the target device will be uninstalled or not.
   class UninstallConfig
 
+    # If this option is true, the target device will receive a message asking it to uninstall the Comet
+    # Backup app.
     # @type [Boolean] uninstall_flag
     attr_accessor :uninstall_flag
 
+    # This controls the "Remove all user settings from this device" option.
     # @type [Boolean] remove_config_file
     attr_accessor :remove_config_file
 

data/lib/comet/models/update_campaign_options.rb

@@ -28,9 +28,12 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.
     # @type [Boolean] force_upgrade_running
     attr_accessor :force_upgrade_running
 
+    # If true, then the UserFilter will be used to restrict which accounts and devices will be eligible
+    # for the software update. If false, all users and devices will be eligible for the software update.
     # @type [Boolean] apply_device_filter
     attr_accessor :apply_device_filter
 

data/lib/comet/models/update_campaign_properties.rb

@@ -24,9 +24,12 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.
     # @type [Boolean] force_upgrade_running
     attr_accessor :force_upgrade_running
 
+    # If true, then the UserFilter will be used to restrict which accounts and devices will be eligible
+    # for the software update. If false, all users and devices will be eligible for the software update.
     # @type [Boolean] apply_device_filter
     attr_accessor :apply_device_filter
 

data/lib/comet/models/update_campaign_status.rb

@@ -24,9 +24,12 @@ module Comet
     # @type [Boolean] downgrade_newer
     attr_accessor :downgrade_newer
 
+    # Choose whether this bulk upgrade campaign is allowed to interrupt a running backup job.
     # @type [Boolean] force_upgrade_running
     attr_accessor :force_upgrade_running
 
+    # If true, then the UserFilter will be used to restrict which accounts and devices will be eligible
+    # for the software update. If false, all users and devices will be eligible for the software update.
     # @type [Boolean] apply_device_filter
     attr_accessor :apply_device_filter
 

data/lib/comet/models/user_on_server.rb

@@ -12,6 +12,8 @@ module Comet
   # UserOnServer is a typed class wrapper around the underlying Comet Server API data structure.
   class UserOnServer
 
+    # The server where this user was found. The 0-based indexes here correspond to the entries inside
+    # ConstellationRoleOptions->Servers.
     # @type [Number] server_id
     attr_accessor :server_id
 

data/lib/comet/models/user_profile_config.rb

@@ -13,15 +13,22 @@ module Comet
   # This is the main data structure for a user's profile.
   class UserProfileConfig
 
+    # The name for this account. It uniquely identifies this UserProfileConfig across the entire Comet
+    # Server. It cannot be changed directly.
     # @type [String] username
     attr_accessor :username
 
+    # A longer descriptive name for this account. It is not necessarily unique to the Comet Server. The
+    # end-user might be able to change it inside the Comet Backup desktop app.
     # @type [String] account_name
     attr_accessor :account_name
 
+    # Timezone in IANA format. Individual devices may declare a more specific timezone in the Devices
+    # field.
     # @type [String] local_timezone
     attr_accessor :local_timezone
 
+    # One of the supported languages, such as en_US (DEFAULT_LANGUAGE).
     # @type [String] language_code
     attr_accessor :language_code
 
@@ -29,12 +36,17 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # A list of email addresses to send reports to.
     # @type [Array<String>] emails
     attr_accessor :emails
 
+    # By default, all the email addresses in the Emails field will receieve the policy-default or
+    # server-wide-default style of email report. Add an override for a specific email address in here to
+    # allow customizing the email report that will be received.
     # @type [Hash{String => Comet::UserCustomEmailSettings}] override_email_settings
     attr_accessor :override_email_settings
 
+    # This option can be used to control whether any email reports are sent.
     # @type [Boolean] send_email_reports
     attr_accessor :send_email_reports
 
@@ -46,27 +58,41 @@ module Comet
     # @type [Hash{String => Comet::SourceConfig}] sources
     attr_accessor :sources
 
+    # Schedules
     # @type [Hash{String => Comet::BackupRuleConfig}] backup_rules
     attr_accessor :backup_rules
 
+    # Devices
+    # To revoke a device, use the AdminRevokeDevice API instead of accessing these fields directly. This
+    # API can also remove associated Protected Items, uninstall the remote device, and disconnect its
+    # live connection.
     # @type [Hash{String => Comet::DeviceConfig}] devices
     attr_accessor :devices
 
     # @type [Boolean] is_suspended
     attr_accessor :is_suspended
 
+    # Unix timestamp in seconds. Zero if the device is not suspended.
     # @type [Number] last_suspended
     attr_accessor :last_suspended
 
+    # A limit on the total Size of all Protected Items in this account. The number of bytes should be
+    # configured in AllProtectedItemsQuotaBytes.
     # @type [Boolean] all_protected_items_quota_enabled
     attr_accessor :all_protected_items_quota_enabled
 
+    # A limit on the total Size of all Protected Items in this account. It is enforced if
+    # AllProtectedItemsQuotaEnabled is true.
     # @type [Number] all_protected_items_quota_bytes
     attr_accessor :all_protected_items_quota_bytes
 
+    # A limit on the total number of devices registered in this account. Set to zero to allow unlimited
+    # devices.
     # @type [Number] maximum_devices
     attr_accessor :maximum_devices
 
+    # A limit on the total number of Office 365 Protected Accounts across all Office 365 Protected Items
+    # in this account. Set to zero to allow unlimited Office 365 Protected Accounts.
     # @type [Number] quota_office_365protected_accounts
     attr_accessor :quota_office_365protected_accounts
 
@@ -76,6 +102,8 @@ module Comet
     # @type [String] policy_id
     attr_accessor :policy_id
 
+    # The Policy field contains a read-only copy of the effective Policy that is applied to this user
+    # account.
     # @type [Comet::UserPolicy] policy
     attr_accessor :policy
 
@@ -87,6 +115,9 @@ module Comet
     # @type [String] password_hash
     attr_accessor :password_hash
 
+    # If this field is empty, the "Allow administrator to reset my password" feature is turned off. If
+    # this field is filled, it contains a cryptographic root of trust that can decrypt and re-encrypt
+    # other secrets in this profile.
     # @type [String] password_recovery
     attr_accessor :password_recovery
 
@@ -102,15 +133,20 @@ module Comet
     # @type [String] totpkey
     attr_accessor :totpkey
 
+    # This field is available in Comet 20.3.4 and later.
     # @type [Boolean] require_password_change
     attr_accessor :require_password_change
 
+    # Unix timestamp in seconds
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # A random GUID that is allocated when the user profile is created for the first time. You can use
+    # this to help disambiguate users with the same username across multiple Comet Servers.
     # @type [String] creation_guid
     attr_accessor :creation_guid
 
+    # Additional server-wide settings that are enforced for this user profile
     # @type [Comet::UserServerConfig] server_config
     attr_accessor :server_config
 

data/lib/comet/models/vmdksnapshot_view_options.rb

@@ -12,12 +12,16 @@ module Comet
   # VMDKSnapshotViewOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class VMDKSnapshotViewOptions
 
+    # Request a list of stored objects in vmdk file. It should be always true for restoring single files
+    # from vmdk file
     # @type [Boolean] enabled
     attr_accessor :enabled
 
+    # The vmdk filename inside subdirectory of disk image, should be end with .vmdk
     # @type [String] partition_guid
     attr_accessor :partition_guid
 
+    # Browse objects' paths inside vmdk file
     # @type [String] list_path
     attr_accessor :list_path
 

data/lib/comet/models/web_authn_registration_challenge_response.rb

@@ -12,6 +12,7 @@ module Comet
   # WebAuthnRegistrationChallengeResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class WebAuthnRegistrationChallengeResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/web_interface_branding_properties.rb

@@ -12,6 +12,9 @@ module Comet
   # WebInterfaceBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class WebInterfaceBrandingProperties
 
+    # @type [Number] branding_style_type
+    attr_accessor :branding_style_type
+
     # @type [String] brand_name
     attr_accessor :brand_name
 
@@ -21,6 +24,9 @@ module Comet
     # @type [String] top_color
     attr_accessor :top_color
 
+    # @type [String] accent_color
+    attr_accessor :accent_color
+
     # @type [String] favicon
     attr_accessor :favicon
 
@@ -35,9 +41,11 @@ module Comet
     end
 
     def clear
+      @branding_style_type = 0
       @brand_name = ''
       @logo_image = ''
       @top_color = ''
+      @accent_color = ''
       @favicon = ''
       @unknown_json_fields = {}
     end
@@ -55,6 +63,10 @@ module Comet
 
       obj.each do |k, v|
         case k
+        when 'BrandingStyleType'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @branding_style_type = v
         when 'BrandName'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -67,6 +79,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @top_color = v
+        when 'AccentColor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @accent_color = v
         when 'Favicon'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -82,9 +98,11 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
+      ret['BrandingStyleType'] = @branding_style_type
       ret['BrandName'] = @brand_name
       ret['LogoImage'] = @logo_image
       ret['TopColor'] = @top_color
+      ret['AccentColor'] = @accent_color
       ret['Favicon'] = @favicon
       ret['HideNewsArea'] = @hide_news_area
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/win_smbauth.rb

@@ -12,15 +12,21 @@ module Comet
   # WinSMBAuth is a typed class wrapper around the underlying Comet Server API data structure.
   class WinSMBAuth
 
+    # The UNC path for the Windows network share (SMB).
     # @type [String] share_path
     attr_accessor :share_path
 
+    # The username to log in to the Windows network share (SMB).
     # @type [String] username
     attr_accessor :username
 
+    # The password might be hashed. To set this in cleartext, set PasswordFormat to 0
+    # (PASSWORD_FORMAT_PLAINTEXT).
     # @type [String] password
     attr_accessor :password
 
+    # The hash algorithm that is used for the Password field. It is one of the PASSWORD_FORMAT_
+    # constants.
     # @type [Number] password_format
     attr_accessor :password_format
 

data/lib/comet_backup_ruby_sdk.rb

@@ -128,6 +128,8 @@ require_relative 'comet/models/s3destination_location'
 require_relative 'comet/models/s3generic_virtual_storage_role'
 require_relative 'comet/models/schedule_config'
 require_relative 'comet/models/search_clause'
+require_relative 'comet/models/search_result_file_info'
+require_relative 'comet/models/search_snapshots_response'
 require_relative 'comet/models/self_backup_export_options'
 require_relative 'comet/models/self_backup_options'
 require_relative 'comet/models/self_backup_statistics'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,8 @@ files:
 - lib/comet/models/s3generic_virtual_storage_role.rb
 - lib/comet/models/schedule_config.rb
 - lib/comet/models/search_clause.rb
+- lib/comet/models/search_result_file_info.rb
+- lib/comet/models/search_snapshots_response.rb
 - lib/comet/models/self_backup_export_options.rb
 - lib/comet/models/self_backup_options.rb
 - lib/comet/models/self_backup_statistics.rb