comet_backup_ruby_sdk 2.26.0 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14ddc4c8af2799ff5572ea1d4699207be21648f4a0b21f391becbef7bf644c92
-  data.tar.gz: 93f2d18fdace95d41e6761f5cdfea4717aa277fe22fd5d628d3821b54a8fb341
+  metadata.gz: afe39a5f978ad5e04e3f384e4f423a6d2bfafb6fd65916b5b4cfb8fa187bc018
+  data.tar.gz: 919e702d99a5544dc2fa292a7e7f0a3745a45339f606bee696d3242a362c31e2
 SHA512:
-  metadata.gz: 6e05c8e10916770ca48ac4a53d7e66109c8697bbff3da77efbf91a0634ba74162fbd49bf9fca6145a7b2b23f1f404315998025ea1c32b73a4936765ea0d532c3
-  data.tar.gz: 80cdbfb3e92be12f5de9df118bdda20fc00fda83ab58ffef1ce9a9f00cc0fed02c3054b42a9af970dc3d927d9beb502e3cfd694ce9fb0b4ee4890156508ce86c
+  metadata.gz: 571c2e0c125cd7cc63287966ed28bc7e2ca8fda6a4d901adf67bf5885a1cc2f9e08e3113bdd5c5d4749bd5c65ff022c9e912e45c3db05e3a1f007dd4b4ce54eb
+  data.tar.gz: 2d8a69b6dfe159a4eb1c04510453bbed3a54490dd4df221b0dc89a53bb2b9aab912d55effeac8afc6685148f3ccb18b90df6b5bc03e7dff8125f9c36259058c7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2024-04-12 v2.27.0
+
+- Based on Comet 24.3.5
+
 ## 2024-01-23 v2.26.0
 
 - Based on Comet 23.12.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.26.0)
+    comet_backup_ruby_sdk (2.27.0)
 
 GEM
   remote: https://rubygems.org/

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '2.26.0'
+  spec.version       = '2.27.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -3145,6 +3145,26 @@ module Comet
       perform_request('api/v1/admin/meta/read-logs', submit_params)
     end
 
+    # AdminMetaReadSelectLogs
+    #
+    # Get logs file content.
+    # On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2.
+    # This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
+    #
+    # @param [Array<Number>] logs An array of log days, selected from the options returned by the Get Log Files API
+    # @return [String]
+    def admin_meta_read_select_logs(logs)
+      submit_params = {}
+      raise TypeError, "'logs' expected Array, got #{logs.class}" unless logs.is_a? Array
+
+      submit_params['Logs'] = logs.to_json
+
+      perform_request('api/v1/admin/meta/read-select-logs', submit_params)
+    end
+
     # AdminMetaRemoteStorageVaultGet
     #
     # Get Requesting Remote Storage Vault Config.
@@ -3316,12 +3336,18 @@ module Comet
     # Access to this API may be prevented on a per-administrator basis.
     #
     # @param [Comet::EmailReportingOption] email_reporting_option Test email reporting option for sending
+    # @param [String] target_organization (Optional) If present, Testing email with a target organization. Only allowed for top-level admins. (>= 24.3.0)
     # @return [Comet::CometAPIResponseMessage]
-    def admin_meta_send_test_report(email_reporting_option)
+    def admin_meta_send_test_report(email_reporting_option, target_organization = nil)
       submit_params = {}
       raise TypeError, "'email_reporting_option' expected Comet::EmailReportingOption, got #{email_reporting_option.class}" unless email_reporting_option.is_a? Comet::EmailReportingOption
 
       submit_params['EmailReportingOption'] = email_reporting_option.to_json
+      unless target_organization.nil?
+        raise TypeError, "'target_organization' expected String, got #{target_organization.class}" unless target_organization.is_a? String
+
+        submit_params['TargetOrganization'] = target_organization
+      end
 
       body = perform_request('api/v1/admin/meta/send-test-report', submit_params)
       json_body = JSON.parse body

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.12.3'
+  APPLICATION_VERSION = '24.3.5'
 
-  APPLICATION_VERSION_MAJOR = 23
+  APPLICATION_VERSION_MAJOR = 24
 
-  APPLICATION_VERSION_MINOR = 12
+  APPLICATION_VERSION_MINOR = 3
 
-  APPLICATION_VERSION_REVISION = 3
+  APPLICATION_VERSION_REVISION = 5
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -117,6 +117,9 @@ module Comet
 
   DESTINATIONTYPE_WEBDAV = 1010
 
+  # SMB Path
+  DESTINATIONTYPE_SMB = 1011
+
   # When defining a schedule via policy, use this option to dynamically select the Storage Vault that was created most recently.
   DESTINATIONTYPE_LATEST = 1100
 
@@ -375,6 +378,9 @@ module Comet
   # MSSQLRestoreOpt
   MSSQL_RESTORE_NORECOVERY = 'NO_RECOVERY'
 
+  # Enable Object Lock capability if the corresponding Days field is greater than zero.
+New code should explicitly use OBJECT_LOCK_ON / OBJECT_LOCK_OFF instead.
+  # @deprecated This const has been deprecated since Comet version 23.x.x
   OBJECT_LOCK_LEGACY = 0
 
   OBJECT_LOCK_ON = 1
@@ -435,39 +441,45 @@ module Comet
 
   RELEASE_CODENAME = 'Voyager'
 
-  # RemoteServerType
+  # RemoteServerType: Comet Server
   REMOTESERVER_COMET = 'comet'
 
-  # RemoteServerType
+  # RemoteServerType: Comet Storage powered by Wasabi
   REMOTESERVER_COMET_STORAGE = 'cometstorage'
 
-  # RemoteServerType
+  # RemoteServerType: LDAP (Lightweight Directory Access Protocol)
   REMOTESERVER_LDAP = 'ldap'
 
-  # RemoteServerType
+  # RemoteServerType: OpenID Connect
   REMOTESERVER_OIDC = 'oidc'
 
-  # RemoteServerType
+  # RemoteServerType: Backblaze B2
   REMOTESERVER_B2 = 'b2'
 
-  # RemoteServerType
+  # RemoteServerType: Wasabi Cloud Storage
   REMOTESERVER_WASABI = 'wasabi'
 
-  # RemoteServerType
+  # RemoteServerType: Custom Remote Bucket HTTP protocol
   REMOTESERVER_CUSTOM = 'custom'
 
-  # RemoteServerType
+  # RemoteServerType: Custom IAM-Compatible
   REMOTESERVER_S3_GENERIC = 's3'
 
-  # RemoteServerType
+  # RemoteServerType: Amazon Web Services
   REMOTESERVER_AWS = 'aws'
 
-  # RemoteServerType
+  # RemoteServerType: Storj DCS
   REMOTESERVER_STORJ = 'storj'
 
-  # RemoteServerType
+  # RemoteServerType: IDrive e2
   REMOTESERVER_IDRIVEE2 = 'idrivee2'
 
+  # RemoteServerType: Impossible Cloud (Partner API)
+  REMOTESERVER_IMPOSSIBLECLOUD_PARTNER = 'impossiblecloud-partner'
+
+  # RemoteServerType: Impossible Cloud
+  REMOTESERVER_IMPOSSIBLECLOUD_IAM = 'impossiblecloud-iam'
+
   # ReplicatorState
   REPLICATOR_STATE_NONE = 0
 
@@ -744,6 +756,9 @@ module Comet
   # DefaultSettingMode
   SETTING_ENFORCED_OFF = 4
 
+  # Severity
+  SEVERITY_DEBUG = 'D'
+
   # Severity
   SEVERITY_INFO = 'I'
 
@@ -903,6 +918,12 @@ module Comet
   # StoredObjectType
   STOREDOBJECTTYPE_WINEFS = 'winefs'
 
+  # StoredObjectType
+  STOREDOBJECTTYPE_WINDOWSFILE = 'winfile'
+
+  # StoredObjectType
+  STOREDOBJECTTYPE_WINDOWSDIR = 'windir'
+
   # StoredObjectType
   STOREDOBJECTTYPE_EMAILMESSAGE = 'emailmessage'
 

data/lib/comet/models/admin_user_permissions.rb

@@ -47,6 +47,10 @@ module Comet
     # @type [Boolean] deny_view_server_info
     attr_accessor :deny_view_server_info
 
+    # This field is available in Comet 24.3.2 and later.
+    # @type [Boolean] prevent_delete_storage_vault
+    attr_accessor :prevent_delete_storage_vault
+
     # This field is available in Comet 23.6.0 and later.
     # @type [Boolean] prevent_request_storage_vault
     attr_accessor :prevent_request_storage_vault
@@ -119,6 +123,8 @@ module Comet
           @deny_view_server_history = v
         when 'DenyViewServerInfo'
           @deny_view_server_info = v
+        when 'PreventDeleteStorageVault'
+          @prevent_delete_storage_vault = v
         when 'PreventRequestStorageVault'
           @prevent_request_storage_vault = v
         when 'PreventAddCustomStorageVault'
@@ -191,6 +197,9 @@ module Comet
       unless @deny_view_server_info.nil?
         ret['DenyViewServerInfo'] = @deny_view_server_info
       end
+      unless @prevent_delete_storage_vault.nil?
+        ret['PreventDeleteStorageVault'] = @prevent_delete_storage_vault
+      end
       unless @prevent_request_storage_vault.nil?
         ret['PreventRequestStorageVault'] = @prevent_request_storage_vault
       end

data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb

@@ -12,6 +12,13 @@ module Comet
   # AmazonAWSVirtualStorageRoleSettings is a typed class wrapper around the underlying Comet Server API data structure.
   class AmazonAWSVirtualStorageRoleSettings
 
+    # If set, the Storage Template will generate Storage Vaults pointing to a subdirectory within this
+    # bucket. A single dynamic IAM policy will cover all created Storage Vaults.
+    # This is preferable for platforms that have limits on the total number of IAM policies. However, it
+    # requires a high level of IAM compatibility.
+    # If left blank, the Storage Template will generate Storage Vaults pointing to new, separate S3
+    # buckets each time. An additional IAM policy is created for each new Storage Vault.
+    # This is preferable for platforms that have a lower level of IAM compatibility.
     # @type [String] master_bucket
     attr_accessor :master_bucket
 
@@ -22,14 +29,21 @@ module Comet
     attr_accessor :secret_key
 
     # @type [Boolean] use_object_lock__legacy__do_not_use
+    # @deprecated This member has been deprecated since Comet version 23.x.x
     attr_accessor :use_object_lock__legacy__do_not_use
 
+    # Control whether the resulting Storage Vaults are configured for Object Lock. One of the
+    # OBJECT_LOCK_ constants
     # @type [Number] object_lock_mode
     attr_accessor :object_lock_mode
 
     # @type [Number] object_lock_days
     attr_accessor :object_lock_days
 
+    # Control whether the "Allow removal of deleted files" checkbox is enabled for Storage Vaults
+    # generated from this Storage Template.
+    # When configuring a Storage Template from the Comet Server web interface, this field is set
+    # automatically for Storage Templates using Object Lock.
     # @type [Boolean] remove_deleted
     attr_accessor :remove_deleted
 

data/lib/comet/models/destination_config.rb

@@ -193,6 +193,9 @@ module Comet
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
+    # @type [Comet::SMBDestinationLocation] smb
+    attr_accessor :smb
+
     # A list of underlying destinations, that will be combined and presented as one.
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
@@ -246,6 +249,10 @@ module Comet
     # @type [Boolean] rebrand_storage
     attr_accessor :rebrand_storage
 
+    # If not empty, an error occured during a retention pass. Describes the error.
+    # @type [String] retention_error
+    attr_accessor :retention_error
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -299,6 +306,7 @@ module Comet
       @b2 = Comet::B2DestinationLocation.new
       @web_dav = Comet::WebDavDestinationLocation.new
       @storj = Comet::StorjDestinationLocation.new
+      @smb = Comet::SMBDestinationLocation.new
       @span_targets = []
       @tag = ''
       @encryption_key_encryption_method = 0
@@ -307,6 +315,7 @@ module Comet
       @storage_limit_bytes = 0
       @statistics = Comet::DestinationStatistics.new
       @default_retention = Comet::RetentionPolicy.new
+      @retention_error = ''
       @unknown_json_fields = {}
     end
 
@@ -532,6 +541,9 @@ module Comet
         when 'Storj'
           @storj = Comet::StorjDestinationLocation.new
           @storj.from_hash(v)
+        when 'SMB'
+          @smb = Comet::SMBDestinationLocation.new
+          @smb.from_hash(v)
         when 'SpanTargets'
           if v.nil?
             @span_targets = []
@@ -574,6 +586,10 @@ module Comet
           @default_retention.from_hash(v)
         when 'RebrandStorage'
           @rebrand_storage = v
+        when 'RetentionError'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @retention_error = v
         else
           @unknown_json_fields[k] = v
         end
@@ -634,6 +650,7 @@ module Comet
       ret['B2'] = @b2
       ret['WebDav'] = @web_dav
       ret['Storj'] = @storj
+      ret['SMB'] = @smb
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots
       ret['Tag'] = @tag
@@ -647,6 +664,7 @@ module Comet
       end
       ret['DefaultRetention'] = @default_retention
       ret['RebrandStorage'] = @rebrand_storage
+      ret['RetentionError'] = @retention_error
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/destination_location.rb

@@ -173,6 +173,9 @@ module Comet
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
+    # @type [Comet::SMBDestinationLocation] smb
+    attr_accessor :smb
+
     # A list of underlying destinations, that will be combined and presented as one.
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
@@ -240,6 +243,7 @@ module Comet
       @b2 = Comet::B2DestinationLocation.new
       @web_dav = Comet::WebDavDestinationLocation.new
       @storj = Comet::StorjDestinationLocation.new
+      @smb = Comet::SMBDestinationLocation.new
       @span_targets = []
       @tag = ''
       @unknown_json_fields = {}
@@ -422,6 +426,9 @@ module Comet
         when 'Storj'
           @storj = Comet::StorjDestinationLocation.new
           @storj.from_hash(v)
+        when 'SMB'
+          @smb = Comet::SMBDestinationLocation.new
+          @smb.from_hash(v)
         when 'SpanTargets'
           if v.nil?
             @span_targets = []
@@ -492,6 +499,7 @@ module Comet
       ret['B2'] = @b2
       ret['WebDav'] = @web_dav
       ret['Storj'] = @storj
+      ret['SMB'] = @smb
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots
       ret['Tag'] = @tag

data/lib/comet/models/external_authentication_source.rb

@@ -18,12 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
+    # For use with Comet Server (Storage Role / Auth Role)
     # @type [String] remote_address
     attr_accessor :remote_address
 
+    # For use with Comet Server (Storage Role / Auth Role)
     # @type [String] username
     attr_accessor :username
 
+    # For use with Comet Server (Storage Role / Auth Role)
     # @type [String] password
     attr_accessor :password
 
@@ -33,25 +36,38 @@ module Comet
     # @type [Comet::OidcConfig] oidc
     attr_accessor :oidc
 
+    # Backblaze B2 (Storage Template / Constellation)
     # @type [Comet::B2VirtualStorageRoleSettings] b2
     attr_accessor :b2
 
+    # Wasabi, or Comet Storage powered by Wasabi (Storage Template / Constellation)
     # @type [Comet::WasabiVirtualStorageRoleSettings] wasabi
     attr_accessor :wasabi
 
+    # Custom Remote Bucket HTTP protocol (Storage Template)
     # @type [Comet::CustomRemoteBucketSettings] custom
     attr_accessor :custom
 
+    # IDrive e2, or Custom IAM-compatible (Storage Template / Constellation)
     # @type [Comet::S3GenericVirtualStorageRole] s3
     attr_accessor :s3
 
-    # Amazon AWS - Virtual Storage Role
+    # Amazon AWS (Storage Template / Constellation)
     # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
     attr_accessor :aws
 
+    # Storj (Storage Template / Constellation)
     # @type [Comet::StorjVirtualStorageRoleSetting] storj
     attr_accessor :storj
 
+    # Impossible Cloud Partner API (Storage Template / Constellation)
+    # @type [Comet::ImpossibleCloudPartnerTemplateSettings] imp_partner
+    attr_accessor :imp_partner
+
+    # Impossible Cloud IAM API (Storage Template / Constellation)
+    # @type [Comet::ImpossibleCloudIAMTemplateSettings] imp_user
+    attr_accessor :imp_user
+
     # @type [Comet::AdminUserPermissions] new_user_permissions
     attr_accessor :new_user_permissions
 
@@ -76,6 +92,8 @@ module Comet
       @s3 = Comet::S3GenericVirtualStorageRole.new
       @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
       @storj = Comet::StorjVirtualStorageRoleSetting.new
+      @imp_partner = Comet::ImpossibleCloudPartnerTemplateSettings.new
+      @imp_user = Comet::ImpossibleCloudIAMTemplateSettings.new
       @new_user_permissions = Comet::AdminUserPermissions.new
       @unknown_json_fields = {}
     end
@@ -137,6 +155,12 @@ module Comet
         when 'Storj'
           @storj = Comet::StorjVirtualStorageRoleSetting.new
           @storj.from_hash(v)
+        when 'ImpPartner'
+          @imp_partner = Comet::ImpossibleCloudPartnerTemplateSettings.new
+          @imp_partner.from_hash(v)
+        when 'ImpUser'
+          @imp_user = Comet::ImpossibleCloudIAMTemplateSettings.new
+          @imp_user.from_hash(v)
         when 'NewUserPermissions'
           @new_user_permissions = Comet::AdminUserPermissions.new
           @new_user_permissions.from_hash(v)
@@ -184,6 +208,12 @@ module Comet
       unless @storj.nil?
         ret['Storj'] = @storj
       end
+      unless @imp_partner.nil?
+        ret['ImpPartner'] = @imp_partner
+      end
+      unless @imp_user.nil?
+        ret['ImpUser'] = @imp_user
+      end
       ret['NewUserPermissions'] = @new_user_permissions
       @unknown_json_fields.each do |k, v|
         ret[k] = v