comet_backup_ruby_sdk 2.9.0 → 2.10.0

data/lib/comet/models/news_entry.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # Unix timestamp, in seconds.
     # @type [Number] date_time
     attr_accessor :date_time
 

data/lib/comet/models/osinfo.rb

@@ -10,17 +10,31 @@ require 'json'
 module Comet
 
   # OSInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # OSInfo represents the common set of version information between all operating systems
   class OSInfo
 
+    # The primary version number (e.g. on Windows: 1703 / 2009, on Linux: 20.04 / 22.04)
     # @type [String] version
     attr_accessor :version
 
+    # The primary presentation name (e.g. "Windows 10 Pro", "debian", "Synology DSM")
     # @type [String] distribution
     attr_accessor :distribution
 
+    # The detailed build number (e.g. 19043)
     # @type [String] build
     attr_accessor :build
 
+    # The GOOS value
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] os
+    attr_accessor :os
+
+    # The GOARCH value
+    # This field is available in Comet 23.6.0 and later.
+    # @type [String] arch
+    attr_accessor :arch
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -32,6 +46,8 @@ module Comet
       @version = ''
       @distribution = ''
       @build = ''
+      @os = ''
+      @arch = ''
       @unknown_json_fields = {}
     end
 
@@ -60,6 +76,14 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @build = v
+        when 'os'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @os = v
+        when 'arch'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @arch = v
         else
           @unknown_json_fields[k] = v
         end
@@ -78,6 +102,12 @@ module Comet
       unless @build.nil?
         ret['build'] = @build
       end
+      unless @os.nil?
+        ret['os'] = @os
+      end
+      unless @arch.nil?
+        ret['arch'] = @arch
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/partition.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] device_name
     attr_accessor :device_name
 
+    # The name of the filesystem used on this partition (e.g. "NTFS")
     # @type [String] filesystem
     attr_accessor :filesystem
 
@@ -30,12 +31,16 @@ module Comet
     # @type [Array<String>] mount_points
     attr_accessor :mount_points
 
+    # Bytes. The partition's offset within the DeviceName. It will be zero if this partition has a
+    # direct DeviceName handle.
     # @type [Number] read_offset
     attr_accessor :read_offset
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
+    # Bytes. Only present for supported filesystems that are currently mounted by the OS
     # @type [Number] used_size
     attr_accessor :used_size
 

data/lib/comet/models/private_branding_properties.rb

@@ -12,6 +12,7 @@ module Comet
   # PrivateBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class PrivateBrandingProperties
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -39,12 +40,14 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # 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
 
@@ -64,6 +67,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
 
@@ -79,6 +83,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/models/psaconfig.rb

@@ -12,18 +12,22 @@ module Comet
   # PSAConfig is a typed class wrapper around the underlying Comet Server API data structure.
   class PSAConfig
 
+    # For PSA_TYPE_GRADIENT. Defaults to enabled
     # @type [Boolean] alerts_disabled
     attr_accessor :alerts_disabled
 
     # @type [Hash{String => String}] custom_headers
     attr_accessor :custom_headers
 
+    # Specified credentials for the target PSA
     # @type [String] partner_key
     attr_accessor :partner_key
 
+    # One of the PSA_TYPE_ constants
     # @type [Number] type
     attr_accessor :type
 
+    # For PSA_TYPE_GENERIC
     # @type [String] url
     attr_accessor :url
 

data/lib/comet/models/restore_job_advanced_options.rb

@@ -41,6 +41,16 @@ module Comet
     # @type [Number] archive_format
     attr_accessor :archive_format
 
+    # Corresponds to the "Allow partial file restores (zero-out unrecoverable data)" option
+    # This field is available in Comet 23.6.4 and later.
+    # @type [Boolean] skip_unreadable_chunks
+    attr_accessor :skip_unreadable_chunks
+
+    # Corresponds to the "Prefer temporary files instead of RAM (slower)" option
+    # This field is available in Comet 23.6.4 and later.
+    # @type [Boolean] on_disk_indexes_key
+    attr_accessor :on_disk_indexes_key
+
     # For RESTORETYPE_OFFICE365_CLOUD.
     # @type [Comet::Office365Credential] office_365credential
     attr_accessor :office_365credential
@@ -151,6 +161,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @archive_format = v
+        when 'SkipUnreadableChunks'
+          @skip_unreadable_chunks = v
+        when 'OnDiskIndexesKey'
+          @on_disk_indexes_key = v
         when 'Office365Credential'
           @office_365credential = Comet::Office365Credential.new
           @office_365credential.from_hash(v)
@@ -205,6 +219,8 @@ module Comet
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths
       ret['ArchiveFormat'] = @archive_format
+      ret['SkipUnreadableChunks'] = @skip_unreadable_chunks
+      ret['OnDiskIndexesKey'] = @on_disk_indexes_key
       unless @office_365credential.nil?
         ret['Office365Credential'] = @office_365credential
       end

data/lib/comet/models/retention_range.rb

@@ -10,11 +10,15 @@ require 'json'
 module Comet
 
   # RetentionRange is a typed class wrapper around the underlying Comet Server API data structure.
+  # The Type field controls which fields of this data type are used. For additional information, see
+# the notes on the RETENTIONRANGE_ constants.
   class RetentionRange
 
+    # One of the RETENTIONRANGE_ constants
     # @type [Number] type
     attr_accessor :type
 
+    # Unix timestamp, in seconds. Used by RETENTIONRANGE_NEWER_THAN_X.
     # @type [Number] timestamp
     attr_accessor :timestamp
 
@@ -34,6 +38,10 @@ module Comet
     # @type [Number] week_offset
     attr_accessor :week_offset
 
+    # 1: 1st, 31: 31st
+    # Prior to Comet version 23.6.2, 31 was treated as 30.
+    # For months that do not have a day equal to the specified offset, no backup will be retained.
+    # For example, if the offset is set to 30, no backup will be kept for February.
     # @type [Number] month_offset
     attr_accessor :month_offset
 

data/lib/comet/models/search_clause.rb

@@ -12,18 +12,34 @@ module Comet
   # SearchClause is a typed class wrapper around the underlying Comet Server API data structure.
   class SearchClause
 
+    # One of the SEARCHCLAUSE_ constants (e.g. empty-string if this is a rule, or "and"/"or" if there
+    # are ClauseChildren)
     # @type [String] clause_type
     attr_accessor :clause_type
 
+    # The field name to search. Check the specific API for more information about which fields are
+    # available for searching. For use with ClauseType = SEARCHCLAUSE_RULE.
     # @type [String] rule_field
     attr_accessor :rule_field
 
+    # One of the SEARCHOPERATOR_ constants. The operator must match the type of the particular field.
+    # For use with ClauseType = SEARCHCLAUSE_RULE.
     # @type [String] rule_operator
     attr_accessor :rule_operator
 
+    # The value to compare the field against.
+    # - If the field is a string, any string is permissable.
+    # - If the field is an integer, the integer should be cast to a base-10 string. There is currently
+    # no support for fractional or floating-point numbers.
+    # - If the field is a boolean, the following values can be used for true ("1", "t", "T", "true",
+    # "TRUE", "True") and the following values can be used for false ("0", "f", "F", "false", "FALSE",
+    # "False").
+    # For use with ClauseType = SEARCHCLAUSE_RULE.
     # @type [String] rule_value
     attr_accessor :rule_value
 
+    # If ClauseType is not SEARCHCLAUSE_RULE, the child rules will be applied according to the
+    # ClauseType (e.g. "and"/"or")
     # @type [Array<Comet::SearchClause>] clause_children
     attr_accessor :clause_children
 

data/lib/comet/models/self_backup_export_options.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] encryption_key
     attr_accessor :encryption_key
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] encryption_key_format
     attr_accessor :encryption_key_format
 

data/lib/comet/models/self_backup_target.rb

@@ -28,6 +28,7 @@ module Comet
     # @type [String] encryption_key
     attr_accessor :encryption_key
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] encryption_key_format
     attr_accessor :encryption_key_format
 

data/lib/comet/models/server_config_options.rb

@@ -42,6 +42,7 @@ module Comet
     # @type [Hash{String => Comet::ExternalAuthenticationSource}] external_admin_user_sources
     attr_accessor :external_admin_user_sources
 
+    # The Comet Server can enforce a bandwidth limit based on the target IP address
     # @type [Comet::RatelimitOptions] iprate_limit
     attr_accessor :iprate_limit
 

data/lib/comet/models/server_meta_branding_properties.rb

@@ -28,9 +28,11 @@ module Comet
     # @type [String] image_etag
     attr_accessor :image_etag
 
+    # Colour in RGB hex format (e.g. "#FFFFFF")
     # @type [String] top_color
     attr_accessor :top_color
 
+    # Colour in RGB hex format (e.g. "#FFFFFF")
     # @type [String] accent_color
     attr_accessor :accent_color
 

data/lib/comet/models/server_meta_version_info.rb

@@ -62,6 +62,7 @@ module Comet
     # @type [Number] server_license_feature_set
     attr_accessor :server_license_feature_set
 
+    # Unix timestamp, in seconds.
     # @type [Number] license_valid_until
     attr_accessor :license_valid_until
 
@@ -89,6 +90,7 @@ module Comet
     # @type [Boolean] scheduled_email_thread_last_wake_sent_emails
     attr_accessor :scheduled_email_thread_last_wake_sent_emails
 
+    # This field is available in Comet 21.3.2 and later.
     # @type [Array<Comet::SelfBackupStatistics>] self_backup
     attr_accessor :self_backup
 

data/lib/comet/models/session_key_regenerated_response.rb

@@ -22,6 +22,8 @@ module Comet
     # @type [String] session_key
     attr_accessor :session_key
 
+    # e.g. "admin" or "user"
+    # This field is available in Comet 18.12.3 and later.
     # @type [String] session_type
     attr_accessor :session_type
 

data/lib/comet/models/single_field_source.rb

@@ -15,6 +15,7 @@ module Comet
     # @type [String] field_name
     attr_accessor :field_name
 
+    # One of "bool" / "int" / "string"
     # @type [String] field_type
     attr_accessor :field_type
 

data/lib/comet/models/software_update_news_response.rb

@@ -12,15 +12,19 @@ module Comet
   # SoftwareUpdateNewsResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class SoftwareUpdateNewsResponse
 
+    # The latest "Quarterly" release version of Comet known to the account.cometbackup.com system.
     # @type [String] latest_stable
     attr_accessor :latest_stable
 
+    # The latest "Voyager" release version of Comet known to the account.cometbackup.com system.
     # @type [String] latest_prerelease
     attr_accessor :latest_prerelease
 
+    # A URL linking to the Comet Server downloads page.
     # @type [String] downloads_url
     attr_accessor :downloads_url
 
+    # An array of recent news items written by Comet Backup staff. Entries are english plaintext.
     # @type [Array<String>] whats_new
     attr_accessor :whats_new
 

data/lib/comet/models/source_basic_info.rb

@@ -10,6 +10,8 @@ require 'json'
 module Comet
 
   # SourceBasicInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # SourceBasicInfo is the minimal amount of information one device knows about another device's
+# Protected Items, in order to safely perform retention passes on their behalf.
   class SourceBasicInfo
 
     # @type [String] description

data/lib/comet/models/source_config.rb

@@ -89,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.
@@ -115,6 +126,7 @@ module Comet
       @thaw_exec = []
       @post_exec = []
       @engine_props = {}
+      @policy_source_id = ''
       @override_destination_retention = {}
       @statistics = Comet::SourceStatistics.new
       @unknown_json_fields = {}
@@ -197,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?
@@ -228,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/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/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/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/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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler