comet_backup_ruby_sdk 2.8.0 → 2.10.0

data/lib/comet/models/source_config.rb

@@ -22,9 +22,11 @@ module Comet
     # @type [String] owner_device
     attr_accessor :owner_device
 
+    # Unix timestamp in seconds
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # Unix timestamp in seconds
     # @type [Number] modify_time
     attr_accessor :modify_time
 
@@ -48,10 +50,10 @@ module Comet
     # - 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 PINCLUDE: A SourceIncludePattern type encoded in JSON format, describing
+    # an advanced inclusion in glob format
+    # - Any key starting with RINCLUDE: A SourceIncludePattern type encoded in JSON format, describing
+    # an advanced inclusion in 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
@@ -87,6 +89,17 @@ module Comet
     # @type [Hash{String => String}] engine_props
     attr_accessor :engine_props
 
+    # If set, this SourceConfig was added from a Policy with the specified ID.
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] policy_source_id
+    attr_accessor :policy_source_id
+
+    # For a Policy-defined SourceConfig, this field controls whether the Protected Item will stay linked
+    # with the policy.
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] existing_user_update
+    attr_accessor :existing_user_update
+
     # 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.
@@ -113,6 +126,7 @@ module Comet
       @thaw_exec = []
       @post_exec = []
       @engine_props = {}
+      @policy_source_id = ''
       @override_destination_retention = {}
       @statistics = Comet::SourceStatistics.new
       @unknown_json_fields = {}
@@ -195,6 +209,12 @@ module Comet
               @engine_props[k1] = v1
             end
           end
+        when 'PolicySourceID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @policy_source_id = v
+        when 'ExistingUserUpdate'
+          @existing_user_update = v
         when 'OverrideDestinationRetention'
           @override_destination_retention = {}
           if v.nil?
@@ -226,6 +246,8 @@ module Comet
       ret['ThawExec'] = @thaw_exec
       ret['PostExec'] = @post_exec
       ret['EngineProps'] = @engine_props
+      ret['PolicySourceID'] = @policy_source_id
+      ret['ExistingUserUpdate'] = @existing_user_update
       unless @override_destination_retention.nil?
         ret['OverrideDestinationRetention'] = @override_destination_retention
       end

data/lib/comet/models/source_include_pattern.rb

@@ -10,11 +10,16 @@ require 'json'
 module Comet
 
   # SourceIncludePattern is a typed class wrapper around the underlying Comet Server API data structure.
+  # SourceIncludePattern is used for pattern inclusions for File and Folder Protected Items
+# (ENGINE_BUILTIN_FILE).
+# It should be marshalled as JSON and then stored in the PINCLUDE / RINCLUDE EngineProp keys.
   class SourceIncludePattern
 
+    # The filesystem path to search within, for matches
     # @type [String] top_directory
     attr_accessor :top_directory
 
+    # The pattern (glob or regex format) to match
     # @type [String] value
     attr_accessor :value
 

data/lib/comet/models/spanned_destination_location.rb

@@ -12,9 +12,20 @@ module Comet
   # SpannedDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
   class SpannedDestinationLocation
 
+    # A list of underlying destinations, that will be combined and presented as one.
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
 
+    # If true, this Spanned destination will use a consistent hashing scheme
+    # to immediately find specific files on exactly one of the target destinations.
+    # In the Static Slots mode, the span targets cannot be moved or merged, and
+    # the files must always remain in their original location.
+    #
+    # If false, the Spanned destination system will search all targets to find
+    # the requested file. This is slightly slower, but allows you to freely merge,
+    # split, and reorder the underlying destination locations.
+    #
+    # The default option is false.
     # @type [Boolean] span_use_static_slots
     attr_accessor :span_use_static_slots
 

data/lib/comet/models/sshconnection.rb

@@ -22,15 +22,21 @@ module Comet
     # @type [Number] sshauth_mode
     attr_accessor :sshauth_mode
 
+    # For use with SSHCONNECTION_AUTHMODE_PASSWORD only: the SSH password to connect with
     # @type [String] sshpassword
     attr_accessor :sshpassword
 
+    # For use with SSHCONNECTION_AUTHMODE_PRIVATEKEY only: the SSH private key to connect with, in
+    # OpenSSH format.
     # @type [String] sshprivate_key
     attr_accessor :sshprivate_key
 
+    # If true, then the SSHCustomAuth_KnownHostsFile will be used to verify the remote SSH server's host
+    # key, using Trust On First Use (TOFU).
     # @type [Boolean] sshcustom_auth__use_known_hosts_file
     attr_accessor :sshcustom_auth__use_known_hosts_file
 
+    # If SSHCustomAuth_UseKnownHostsFile is true, the path to the SSH known_hosts file.
     # @type [String] sshcustom_auth__known_hosts_file
     attr_accessor :sshcustom_auth__known_hosts_file
 

data/lib/comet/models/storage_role_options.rb

@@ -19,6 +19,7 @@ module Comet
     attr_accessor :storage
 
     # @type [Array<Comet::LocalStorageDirectory>] local_storage__legacy
+    # @deprecated This member has been deprecated since Comet version 17.3.5
     attr_accessor :local_storage__legacy
 
     # @type [Array<Comet::ReplicaServer>] replicate_to

data/lib/comet/models/stored_object.rb

@@ -12,9 +12,11 @@ module Comet
   # StoredObject is a typed class wrapper around the underlying Comet Server API data structure.
   class StoredObject
 
+    # The name of the stored object. It is unique within this directory tree.
     # @type [String] name
     attr_accessor :name
 
+    # Unix timestamp in seconds
     # @type [Number] modify_time
     attr_accessor :modify_time
 
@@ -22,9 +24,12 @@ module Comet
     # @type [String] type
     attr_accessor :type
 
+    # If this StoredObject represents a directory, this value can be used to recursively select the
+    # directory contents.
     # @type [String] subtree
     attr_accessor :subtree
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
@@ -46,9 +51,11 @@ module Comet
     # @type [Boolean] has_attachments
     attr_accessor :has_attachments
 
+    # Unix timestamp in seconds
     # @type [Number] start_time
     attr_accessor :start_time
 
+    # Unix timestamp in seconds
     # @type [Number] end_time
     attr_accessor :end_time
 

data/lib/comet/models/streamable_event.rb

@@ -12,12 +12,24 @@ module Comet
   # StreamableEvent is a typed class wrapper around the underlying Comet Server API data structure.
   class StreamableEvent
 
+    # @type [String] actor
+    attr_accessor :actor
+
     # @type [String] owner_organization_id
     attr_accessor :owner_organization_id
 
+    # @type [String] resource_id
+    attr_accessor :resource_id
+
     # @type [Number] type
     attr_accessor :type
 
+    # @type [Number] timestamp
+    attr_accessor :timestamp
+
+    # @type [String] type_string
+    attr_accessor :type_string
+
     # @type [Object] data
     attr_accessor :data
 
@@ -29,8 +41,12 @@ module Comet
     end
 
     def clear
+      @actor = ''
       @owner_organization_id = ''
+      @resource_id = ''
       @type = 0
+      @timestamp = 0
+      @type_string = ''
       @unknown_json_fields = {}
     end
 
@@ -47,14 +63,30 @@ module Comet
 
       obj.each do |k, v|
         case k
+        when 'Actor'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @actor = v
         when 'OwnerOrganizationID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @owner_organization_id = v
+        when 'ResourceID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @resource_id = v
         when 'Type'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @type = v
+        when 'Timestamp'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @timestamp = v
+        when 'TypeString'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type_string = v
         when 'Data'
           @data = v
         else
@@ -66,8 +98,18 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
+      ret['Actor'] = @actor
       ret['OwnerOrganizationID'] = @owner_organization_id
+      unless @resource_id.nil?
+        ret['ResourceID'] = @resource_id
+      end
       ret['Type'] = @type
+      unless @timestamp.nil?
+        ret['Timestamp'] = @timestamp
+      end
+      unless @type_string.nil?
+        ret['TypeString'] = @type_string
+      end
       unless @data.nil?
         ret['Data'] = @data
       end

data/lib/comet/models/totp_regenerated_response.rb

@@ -19,12 +19,15 @@ module Comet
     # @type [String] message
     attr_accessor :message
 
+    # A data URI of an image of a TOTP code (e.g. "data:image/png;base64,AAA...")
     # @type [String] image
     attr_accessor :image
 
+    # This field is available in Comet 18.9.9 and later.
     # @type [String] url
     attr_accessor :url
 
+    # This field is available in Comet 20.3.2 and later.
     # @type [String] profile_hash
     attr_accessor :profile_hash
 

data/lib/comet/models/update_campaign_device_status.rb

@@ -12,6 +12,7 @@ module Comet
   # UpdateCampaignDeviceStatus is a typed class wrapper around the underlying Comet Server API data structure.
   class UpdateCampaignDeviceStatus
 
+    # One of the UPDATESTATUS_ constants
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/update_campaign_properties.rb

@@ -36,6 +36,7 @@ module Comet
     # @type [Comet::SearchClause] device_filter
     attr_accessor :device_filter
 
+    # Unix timestamp, in seconds
     # @type [Number] start_time
     attr_accessor :start_time
 

data/lib/comet/models/update_campaign_status.rb

@@ -36,6 +36,7 @@ module Comet
     # @type [Comet::SearchClause] device_filter
     attr_accessor :device_filter
 
+    # Unix timestamp, in seconds
     # @type [Number] start_time
     attr_accessor :start_time
 

data/lib/comet/models/update_campaign_status_device_entry.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] device_id
     attr_accessor :device_id
 
+    # One of the UPDATESTATUS_ constants
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/user_profile_config.rb

@@ -51,18 +51,23 @@ module Comet
     attr_accessor :send_email_reports
 
     # Storage Vaults
+    # The string keys can be any unique key. Using a GUID is recommended, but optional.
     # @type [Hash{String => Comet::DestinationConfig}] destinations
     attr_accessor :destinations
 
     # Protected Items
+    # The string keys can be any unique key. Using a GUID is recommended, but optional.
     # @type [Hash{String => Comet::SourceConfig}] sources
     attr_accessor :sources
 
     # Schedules
+    # The string keys can be any unique key. Using a GUID is recommended, but optional.
     # @type [Hash{String => Comet::BackupRuleConfig}] backup_rules
     attr_accessor :backup_rules
 
     # Devices
+    # The string keys are the device's ID. The device ID is generated automatically based on a mix of
+    # hardware and software identifiers on the installed PC.
     # 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.
@@ -107,6 +112,7 @@ module Comet
     # @type [Comet::UserPolicy] policy
     attr_accessor :policy
 
+    # One of the PASSWORD_FORMAT_ constants
     # 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
@@ -124,9 +130,12 @@ module Comet
     # @type [Boolean] allow_password_login
     attr_accessor :allow_password_login
 
+    # If true, then TOTP is required to open the desktop app or the Comet Server web interface with this
+    # user's credentials.
     # @type [Boolean] allow_password_and_totplogin
     attr_accessor :allow_password_and_totplogin
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] totpkey_encryption_format
     attr_accessor :totpkey_encryption_format
 

data/lib/comet/models/user_profile_fragment.rb

@@ -10,6 +10,7 @@ require 'json'
 module Comet
 
   # UserProfileFragment is a typed class wrapper around the underlying Comet Server API data structure.
+  # @deprecated This type has been deprecated since Comet version 23.3.5
   class UserProfileFragment
 
     # @type [String] username

data/lib/comet/models/vault_snapshot.rb

@@ -21,6 +21,7 @@ module Comet
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # This field is available in Comet 20.12.4 and later.
     # @type [Boolean] has_original_path_info
     attr_accessor :has_original_path_info
 

data/lib/comet/models/vsscomponent.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] name
     attr_accessor :name
 
+    # "VSS_CT_DATABASE" or "VSS_CT_FILEGROUP"
     # @type [String] ctype
     attr_accessor :ctype
 

data/lib/comet/models/web_authn_credential.rb

@@ -13,12 +13,14 @@ module Comet
   # WebAuthnCredential is a typed class wrapper around the underlying Comet Server API data structure.
   class WebAuthnCredential
 
+    # When this field is expressed as a WebAuthnCredential class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] public_key
     attr_accessor :public_key
 
     # @type [String] attestation_type
     attr_accessor :attestation_type
 
+    # When this field is expressed as a WebAuthnCredential class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] aaguid
     attr_accessor :aaguid
 

data/lib/comet/models/web_authn_credential_descriptor.rb

@@ -16,6 +16,7 @@ module Comet
     # @type [String] type
     attr_accessor :type
 
+    # When this field is expressed as a WebAuthnCredentialDescriptor class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] credential_id
     attr_accessor :credential_id
 

data/lib/comet/models/web_authn_public_key_credential_creation_options.rb

@@ -13,6 +13,7 @@ module Comet
   # WebAuthnPublicKeyCredentialCreationOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class WebAuthnPublicKeyCredentialCreationOptions
 
+    # When this field is expressed as a WebAuthnPublicKeyCredentialCreationOptions class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] challenge
     attr_accessor :challenge
 

data/lib/comet/models/web_authn_public_key_credential_request_options.rb

@@ -13,6 +13,7 @@ module Comet
   # WebAuthnPublicKeyCredentialRequestOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class WebAuthnPublicKeyCredentialRequestOptions
 
+    # When this field is expressed as a WebAuthnPublicKeyCredentialRequestOptions class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] challenge
     attr_accessor :challenge
 

data/lib/comet/models/web_authn_user_entity.rb

@@ -22,6 +22,7 @@ module Comet
     # @type [String] display_name
     attr_accessor :display_name
 
+    # When this field is expressed as a WebAuthnUserEntity class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] id
     attr_accessor :id
 

data/lib/comet/models/web_interface_branding_properties.rb

@@ -12,6 +12,8 @@ module Comet
   # WebInterfaceBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class WebInterfaceBrandingProperties
 
+    # One of the BRANDINGSTYLETYPE_ constants
+    # This field is available in Comet 23.3.3 and later.
     # @type [Number] branding_style_type
     attr_accessor :branding_style_type
 

data/lib/comet/models/webhook_option.rb

@@ -10,17 +10,30 @@ require 'json'
 module Comet
 
   # WebhookOption is a typed class wrapper around the underlying Comet Server API data structure.
+  # WebhookOption defines the configuration of a webhook target. The Comet Server will send a live
+# HTTP POST event to the webhook URL when certain events happen.
   class WebhookOption
 
+    # The target URL to POST the event data to
     # @type [String] url
     attr_accessor :url
 
-    # @type [Array<Number>] white_listed_event_types
-    attr_accessor :white_listed_event_types
-
+    # CustomHeaders allows specifying custom headers which are added to the outgoing POST request
+    # from Comet Server. Custom headers are specified as (header name, header value) pairs. If a
+    # custom header conflicts with a header required by HTTP or the Comet tracing ID header
+    # (`x-Comet-Tracing-Id`), it will be ignored.
     # @type [Hash{String => String}] custom_headers
     attr_accessor :custom_headers
 
+    # One of the STREAM_LEVEL_ constants. This controls how much data is sent in the webhook event.
+    # @type [String] level
+    attr_accessor :level
+
+    # Configure a subset of allowed event types (see SEVT_ constants). If the array is empty, all events
+    # will be sent
+    # @type [Array<Number>] white_listed_event_types
+    attr_accessor :white_listed_event_types
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -30,8 +43,9 @@ module Comet
 
     def clear
       @url = ''
-      @white_listed_event_types = []
       @custom_headers = {}
+      @level = ''
+      @white_listed_event_types = []
       @unknown_json_fields = {}
     end
 
@@ -52,17 +66,6 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @url = v
-        when 'WhiteListedEventTypes'
-          if v.nil?
-            @white_listed_event_types = []
-          else
-            @white_listed_event_types = Array.new(v.length)
-            v.each_with_index do |v1, i1|
-              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
-
-              @white_listed_event_types[i1] = v1
-            end
-          end
         when 'CustomHeaders'
           @custom_headers = {}
           if v.nil?
@@ -74,6 +77,21 @@ module Comet
               @custom_headers[k1] = v1
             end
           end
+        when 'Level'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @level = v
+        when 'WhiteListedEventTypes'
+          if v.nil?
+            @white_listed_event_types = []
+          else
+            @white_listed_event_types = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @white_listed_event_types[i1] = v1
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -84,8 +102,9 @@ module Comet
     def to_hash
       ret = {}
       ret['URL'] = @url
-      ret['WhiteListedEventTypes'] = @white_listed_event_types
       ret['CustomHeaders'] = @custom_headers
+      ret['Level'] = @level
+      ret['WhiteListedEventTypes'] = @white_listed_event_types
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/windows_code_sign_properties.rb

@@ -12,12 +12,14 @@ module Comet
   # WindowsCodeSignProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class WindowsCodeSignProperties
 
+    # One of the WINDOWSCODESIGN_METHOD_ constants
     # @type [Number] windows_code_sign_method
     attr_accessor :windows_code_sign_method
 
     # @type [String] windows_code_sign_pkcs12file_path
     attr_accessor :windows_code_sign_pkcs12file_path
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs12password_format
     attr_accessor :windows_code_sign_pkcs12password_format
 
@@ -37,6 +39,7 @@ module Comet
     # @type [String] windows_code_sign_pkcs11key_id
     attr_accessor :windows_code_sign_pkcs11key_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs11password_format
     attr_accessor :windows_code_sign_pkcs11password_format
 
@@ -52,6 +55,7 @@ module Comet
     # @type [String] windows_code_sign_azure_app_id
     attr_accessor :windows_code_sign_azure_app_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_azure_app_secret_format
     attr_accessor :windows_code_sign_azure_app_secret_format
 

data/lib/comet_backup_ruby_sdk.rb

@@ -73,6 +73,7 @@ require_relative 'comet/models/external_authentication_source'
 require_relative 'comet/models/external_ldapauthentication_source_server'
 require_relative 'comet/models/external_ldapauthentication_source_settings'
 require_relative 'comet/models/extra_file_exclusion'
+require_relative 'comet/models/file_option'
 require_relative 'comet/models/ftpdestination_location'
 require_relative 'comet/models/get_group_policy_response'
 require_relative 'comet/models/get_profile_and_hash_response_message'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,7 @@ files:
 - lib/comet/models/external_ldapauthentication_source_server.rb
 - lib/comet/models/external_ldapauthentication_source_settings.rb
 - lib/comet/models/extra_file_exclusion.rb
+- lib/comet/models/file_option.rb
 - lib/comet/models/ftpdestination_location.rb
 - lib/comet/models/get_group_policy_response.rb
 - lib/comet/models/get_profile_and_hash_response_message.rb