comet_backup_ruby_sdk 2.9.0 → 2.11.0

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/user_policy.rb

@@ -99,6 +99,9 @@ module Comet
     # @type [Boolean] prevent_protected_item_retention
     attr_accessor :prevent_protected_item_retention
 
+    # @type [Boolean] allow_edit_object_lock_retention
+    attr_accessor :allow_edit_object_lock_retention
+
     # @type [Hash{String => Comet::SourceConfig}] default_sources
     attr_accessor :default_sources
 
@@ -230,6 +233,8 @@ module Comet
           @enforce_storage_vault_retention = v
         when 'PreventProtectedItemRetention'
           @prevent_protected_item_retention = v
+        when 'AllowEditObjectLockRetention'
+          @allow_edit_object_lock_retention = v
         when 'DefaultSources'
           @default_sources = {}
           if v.nil?
@@ -322,6 +327,7 @@ module Comet
       ret['DefaultStorageVaultRetention'] = @default_storage_vault_retention
       ret['EnforceStorageVaultRetention'] = @enforce_storage_vault_retention
       ret['PreventProtectedItemRetention'] = @prevent_protected_item_retention
+      ret['AllowEditObjectLockRetention'] = @allow_edit_object_lock_retention
       ret['DefaultSources'] = @default_sources
       ret['DefaultSourcesBackupRules'] = @default_sources_backup_rules
       ret['DefaultSourcesWithOSRestriction'] = @default_sources_with_osrestriction

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
 
@@ -30,13 +32,14 @@ module Comet
     # @type [String] windows_code_sign_pkcs11module
     attr_accessor :windows_code_sign_pkcs11module
 
+    # This field was deprecated between 23.3.0 and 23.6.x, but is now used again.
     # @type [String] windows_code_sign_pkcs11certfile
-    # @deprecated This member has been deprecated since Comet version 22.12.7
     attr_accessor :windows_code_sign_pkcs11certfile
 
     # @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

@@ -70,6 +70,8 @@ require_relative 'comet/models/email_report_config'
 require_relative 'comet/models/email_report_generated_preview'
 require_relative 'comet/models/email_reporting_option'
 require_relative 'comet/models/external_authentication_source'
+require_relative 'comet/models/external_authentication_source_display'
+require_relative 'comet/models/external_authentication_source_response'
 require_relative 'comet/models/external_ldapauthentication_source_server'
 require_relative 'comet/models/external_ldapauthentication_source_settings'
 require_relative 'comet/models/extra_file_exclusion'
@@ -104,6 +106,8 @@ require_relative 'comet/models/office_365custom_setting'
 require_relative 'comet/models/office_365custom_setting_v2'
 require_relative 'comet/models/office_365mixed_virtual_account'
 require_relative 'comet/models/office_365object_info'
+require_relative 'comet/models/oidc_claim'
+require_relative 'comet/models/oidc_config'
 require_relative 'comet/models/organization'
 require_relative 'comet/models/organization_login_urlresponse'
 require_relative 'comet/models/organization_response'

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.11.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,8 @@ files:
 - lib/comet/models/email_report_generated_preview.rb
 - lib/comet/models/email_reporting_option.rb
 - lib/comet/models/external_authentication_source.rb
+- lib/comet/models/external_authentication_source_display.rb
+- lib/comet/models/external_authentication_source_response.rb
 - lib/comet/models/external_ldapauthentication_source_server.rb
 - lib/comet/models/external_ldapauthentication_source_settings.rb
 - lib/comet/models/extra_file_exclusion.rb
@@ -182,6 +184,8 @@ files:
 - lib/comet/models/office_365custom_setting_v2.rb
 - lib/comet/models/office_365mixed_virtual_account.rb
 - lib/comet/models/office_365object_info.rb
+- lib/comet/models/oidc_claim.rb
+- lib/comet/models/oidc_config.rb
 - lib/comet/models/organization.rb
 - lib/comet/models/organization_login_urlresponse.rb
 - lib/comet/models/organization_response.rb