comet_backup_ruby_sdk 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1541c88beaa1b7b97887d18d1ba96cf31c271f509d3f379affe65e6c6d3ab48
-  data.tar.gz: cab918f37bf9e129add1555a8f39a88e32495335c70a72aee8e0f1c660573722
+  metadata.gz: 33d616b7c183fa410f27c19bba61475b24ff0ba5e87b1adcf6354201ee645f3a
+  data.tar.gz: 5bbe3a08fc8552d36c9f379e9cdd80d6c31209741e940689651e443e75e2200d
 SHA512:
-  metadata.gz: ae6df3cc659a753e6f3638e17988af6e0e8b5bf4ea2b88be4150b05a421b9bdfaebbcd3d6cbe4e9284f1bd2d14d5e56bd4b9c8dff83fdf66a435f1c84c7773ab
-  data.tar.gz: cdbf3a20dc309b0285f3b08b5668e6e556becbd064fa2c8b0815c5df158490db582ce4018bf3e09e7270a5da290dd70af90d49d4934bd0711065a3a4015c3371
+  metadata.gz: 0d9400f4930b380cf561e95794a8c30f69eb777869bf6f629aef06bde55f834874f16857373ced01361f9d5239f4458fddf456ae2dfcb756efb0e10211e2850e
+  data.tar.gz: 4da36cb9d8d7896d8e09e1ccea1fca428cf43644521e01656df505257b5cbbdf60da44456ececb9e17172fef56f2328850ed9ef8e977ea5f629a0702a5dde798

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 2022-09-08 v2.2.0
+- Based on 22.9.0
+- Add Storj.io support as a Storage Vault Location and Storage Template provider
+- Add Constellation role support for Tenants
+- Add Webhook edit option for Tenant admins
+- Add MySQL direct RestoreType
+- Improve Office365 credentials handling
+
 ## 2022-07-27 v2.1.0
 - Based on 22.6.7
 - Add support enforcing the `RandomDelaySecs` for both whole-server and in policies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.1.0)
+    comet_backup_ruby_sdk (2.2.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.1.0'
+  spec.version       = '2.2.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -199,9 +199,9 @@ module Comet
     # @param [String] u2fclient_data U2F response data supplied by hardware token
     # @param [String] u2fregistration_data U2F response data supplied by hardware token
     # @param [String] u2fversion U2F response data supplied by hardware token
-    # @param [String] description Optional description of the token
+    # @param [String] description (Optional) Description of the token
     # @return [Comet::CometAPIResponseMessage]
-    def admin_account_u2f_submit_challenge_response(u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description)
+    def admin_account_u2f_submit_challenge_response(u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description = nil)
       submit_params = {}
       raise TypeError, "'u2fchallenge_id' expected String, got #{u2fchallenge_id.class}" unless u2fchallenge_id.is_a? String
 
@@ -215,9 +215,11 @@ module Comet
       raise TypeError, "'u2fversion' expected String, got #{u2fversion.class}" unless u2fversion.is_a? String
 
       submit_params['U2FVersion'] = u2fversion
-      raise TypeError, "'description' expected String, got #{description.class}" unless description.is_a? String
+      unless description.nil?
+        raise TypeError, "'description' expected String, got #{description.class}" unless description.is_a? String
 
-      submit_params['Description'] = description
+        submit_params['Description'] = description
+      end
 
       body = perform_request('api/v1/admin/account/u2f/submit-challenge-response', submit_params)
       json_body = JSON.parse body
@@ -815,7 +817,6 @@ module Comet
     # Get Constellation bucket usage report (cached).
     #
     # You must supply administrator authentication credentials to use this API.
-    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     # This API requires the Constellation Role to be enabled.
     #
     # @return [Comet::ConstellationCheckReport]
@@ -833,7 +834,6 @@ module Comet
     # Get Constellation bucket usage report (regenerate).
     #
     # You must supply administrator authentication credentials to use this API.
-    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     # This API requires the Constellation Role to be enabled.
     #
     # @return [Comet::ConstellationCheckReport]
@@ -869,7 +869,6 @@ module Comet
     # Get Constellation status.
     #
     # You must supply administrator authentication credentials to use this API.
-    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     # This API requires the Constellation Role to be enabled.
     #
     # @return [Comet::ConstellationStatusAPIResponse]
@@ -2521,6 +2520,46 @@ module Comet
       ret
     end
 
+    # AdminMetaConstellationConfigGet
+    #
+    # Get Constellation configuration for the current organization.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Constellation Role to be enabled.
+    #
+    # @return [Comet::ConstellationRoleOptions]
+    def admin_meta_constellation_config_get
+      body = perform_request('api/v1/admin/meta/constellation/config/get')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ConstellationRoleOptions.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaConstellationConfigSet
+    #
+    # Set Constellation configuration for the current organization.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Constellation Role to be enabled.
+    #
+    # @param [Comet::ConstellationRoleOptions] constellation_role_options Constellation role options to set
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_constellation_config_set(constellation_role_options)
+      submit_params = {}
+      raise TypeError, "'constellation_role_options' expected Comet::ConstellationRoleOptions, got #{constellation_role_options.class}" unless constellation_role_options.is_a? Comet::ConstellationRoleOptions
+
+      submit_params['ConstellationRoleOptions'] = constellation_role_options.to_json
+
+      body = perform_request('api/v1/admin/meta/constellation/config/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminMetaListAvailableLogDays
     #
     # Get log files.
@@ -3390,9 +3429,9 @@ module Comet
     #
     # @param [String] target_user Selected account username
     # @param [String] new_password New account password
-    # @param [String] old_password Old account password (optional)
+    # @param [String] old_password (Optional) Old account password. Required if no recovery code is present for the user account.
     # @return [Comet::CometAPIResponseMessage]
-    def admin_reset_user_password(target_user, new_password, old_password)
+    def admin_reset_user_password(target_user, new_password, old_password = nil)
       submit_params = {}
       raise TypeError, "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
 
@@ -3400,9 +3439,11 @@ module Comet
       raise TypeError, "'new_password' expected String, got #{new_password.class}" unless new_password.is_a? String
 
       submit_params['NewPassword'] = new_password
-      raise TypeError, "'old_password' expected String, got #{old_password.class}" unless old_password.is_a? String
+      unless old_password.nil?
+        raise TypeError, "'old_password' expected String, got #{old_password.class}" unless old_password.is_a? String
 
-      submit_params['OldPassword'] = old_password
+        submit_params['OldPassword'] = old_password
+      end
 
       body = perform_request('api/v1/admin/reset-user-password', submit_params)
       json_body = JSON.parse body

data/lib/comet/definitions.rb

@@ -135,6 +135,8 @@ module Comet
 
   DESTINATIONTYPE_B2 = 1008
 
+  DESTINATIONTYPE_STORJ = 1009
+
   DESTINATIONTYPE_LATEST = 1100
 
   DESTINATIONTYPE_ALL = 1101
@@ -218,6 +220,9 @@ module Comet
   # RestoreType:
   RESTORETYPE_VMDK_FILE_ARCHIVE = 9
 
+  # RestoreType:
+  RESTORETYPE_MYSQL = 10
+
   # RestoreType: RESTORETYPE_PROCESS_ARCHIVE
   RESTORETYPE_PROCESS_TARBALL = 3
 
@@ -469,13 +474,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '22.6.7'
+  APPLICATION_VERSION = '22.9.0'
 
   APPLICATION_VERSION_MAJOR = 22
 
-  APPLICATION_VERSION_MINOR = 6
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 7
+  APPLICATION_VERSION_REVISION = 0
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -662,6 +667,9 @@ module Comet
   # RemoteServerType:
   REMOTESERVER_AWS = 'aws'
 
+  # RemoteServerType:
+  REMOTESERVER_STORJ = 'storj'
+
   # RemoteServerType:
   REMOTESERVER_IDRIVEE2 = 'idrivee2'
 

data/lib/comet/models/admin_user_permissions.rb

@@ -27,6 +27,12 @@ module Comet
     # @type [Boolean] allow_edit_remote_storage
     attr_accessor :allow_edit_remote_storage
 
+    # @type [Boolean] allow_edit_webhooks
+    attr_accessor :allow_edit_webhooks
+
+    # @type [Boolean] deny_constellation_role
+    attr_accessor :deny_constellation_role
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -61,6 +67,10 @@ module Comet
           @allow_edit_branding = v
         when 'AllowEditRemoteStorage'
           @allow_edit_remote_storage = v
+        when 'AllowEditWebhooks'
+          @allow_edit_webhooks = v
+        when 'DenyConstellationRole'
+          @deny_constellation_role = v
         else
           @unknown_json_fields[k] = v
         end
@@ -85,6 +95,12 @@ module Comet
       unless @allow_edit_remote_storage.nil?
         ret['AllowEditRemoteStorage'] = @allow_edit_remote_storage
       end
+      unless @allow_edit_webhooks.nil?
+        ret['AllowEditWebhooks'] = @allow_edit_webhooks
+      end
+      unless @deny_constellation_role.nil?
+        ret['DenyConstellationRole'] = @deny_constellation_role
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/destination_config.rb

@@ -150,6 +150,9 @@ module Comet
     # @type [Comet::B2DestinationLocation] b2
     attr_accessor :b2
 
+    # @type [Comet::StorjDestinationLocation] storj
+    attr_accessor :storj
+
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
 
@@ -229,6 +232,7 @@ module Comet
       @localcopy_win_smbpassword_format = 0
       @swift = Comet::SwiftDestinationLocation.new
       @b2 = Comet::B2DestinationLocation.new
+      @storj = Comet::StorjDestinationLocation.new
       @span_targets = []
       @encryption_key_encryption_method = 0
       @encrypted_encryption_key = ''
@@ -445,6 +449,9 @@ module Comet
         when 'B2'
           @b2 = Comet::B2DestinationLocation.new
           @b2.from_hash(v)
+        when 'Storj'
+          @storj = Comet::StorjDestinationLocation.new
+          @storj.from_hash(v)
         when 'SpanTargets'
           if v.nil?
             @span_targets = []
@@ -538,6 +545,7 @@ module Comet
       ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
       ret['Swift'] = @swift
       ret['B2'] = @b2
+      ret['Storj'] = @storj
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots
       ret['EncryptionKeyEncryptionMethod'] = @encryption_key_encryption_method

data/lib/comet/models/destination_location.rb

@@ -132,6 +132,9 @@ module Comet
     # @type [Comet::B2DestinationLocation] b2
     attr_accessor :b2
 
+    # @type [Comet::StorjDestinationLocation] storj
+    attr_accessor :storj
+
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
 
@@ -181,6 +184,7 @@ module Comet
       @localcopy_win_smbpassword_format = 0
       @swift = Comet::SwiftDestinationLocation.new
       @b2 = Comet::B2DestinationLocation.new
+      @storj = Comet::StorjDestinationLocation.new
       @span_targets = []
       @unknown_json_fields = {}
     end
@@ -346,6 +350,9 @@ module Comet
         when 'B2'
           @b2 = Comet::B2DestinationLocation.new
           @b2.from_hash(v)
+        when 'Storj'
+          @storj = Comet::StorjDestinationLocation.new
+          @storj.from_hash(v)
         when 'SpanTargets'
           if v.nil?
             @span_targets = []
@@ -407,6 +414,7 @@ module Comet
       ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
       ret['Swift'] = @swift
       ret['B2'] = @b2
+      ret['Storj'] = @storj
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/external_authentication_source.rb

@@ -46,6 +46,9 @@ module Comet
     # @type [Comet::AmazonAWSVirtualStorageRoleSettings] aws
     attr_accessor :aws
 
+    # @type [Comet::StorjVirtualStorageRoleSetting] storj
+    attr_accessor :storj
+
     # @type [Comet::AdminUserPermissions] new_user_permissions
     attr_accessor :new_user_permissions
 
@@ -68,6 +71,7 @@ module Comet
       @custom = Comet::CustomRemoteBucketSettings.new
       @s3 = Comet::S3GenericVirtualStorageRole.new
       @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
+      @storj = Comet::StorjVirtualStorageRoleSetting.new
       @new_user_permissions = Comet::AdminUserPermissions.new
       @unknown_json_fields = {}
     end
@@ -123,6 +127,9 @@ module Comet
         when 'AWS'
           @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
           @aws.from_hash(v)
+        when 'Storj'
+          @storj = Comet::StorjVirtualStorageRoleSetting.new
+          @storj.from_hash(v)
         when 'NewUserPermissions'
           @new_user_permissions = Comet::AdminUserPermissions.new
           @new_user_permissions.from_hash(v)
@@ -164,6 +171,9 @@ module Comet
       unless @aws.nil?
         ret['AWS'] = @aws
       end
+      unless @storj.nil?
+        ret['Storj'] = @storj
+      end
       ret['NewUserPermissions'] = @new_user_permissions
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/organization.rb

@@ -27,6 +27,9 @@ module Comet
     # @type [Array<Comet::RemoteStorageOption>] remote_storage
     attr_accessor :remote_storage
 
+    # @type [Comet::ConstellationRoleOptions] constellation_role
+    attr_accessor :constellation_role
+
     # @type [Hash{String => Comet::WebhookOption}] webhook_options
     attr_accessor :webhook_options
 
@@ -49,6 +52,7 @@ module Comet
       @software_build_role = Comet::SoftwareBuildRoleOptions.new
       @branding = Comet::BrandingOptions.new
       @remote_storage = []
+      @constellation_role = Comet::ConstellationRoleOptions.new
       @webhook_options = {}
       @email = Comet::EmailOptions.new
       @unknown_json_fields = {}
@@ -98,6 +102,9 @@ module Comet
               @remote_storage[i1].from_hash(v1)
             end
           end
+        when 'ConstellationRole'
+          @constellation_role = Comet::ConstellationRoleOptions.new
+          @constellation_role.from_hash(v)
         when 'WebhookOptions'
           @webhook_options = {}
           if v.nil?
@@ -127,6 +134,7 @@ module Comet
       ret['SoftwareBuildRole'] = @software_build_role
       ret['Branding'] = @branding
       ret['RemoteStorage'] = @remote_storage
+      ret['ConstellationRole'] = @constellation_role
       ret['WebhookOptions'] = @webhook_options
       ret['Email'] = @email
       ret['IsSuspended'] = @is_suspended