comet_backup_ruby_sdk 2.8.0 → 2.9.0

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/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/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_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.9.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-06-01 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