comet_backup_ruby_sdk 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3faaa84e0d62d76bb3669935d01f4409c80a28a479c39cc5b60e8fe87b33494f
-  data.tar.gz: 0a67b796036d8880111aa4f10aa832f3994d268257d90d58603bc881b338c8b0
+  metadata.gz: 2ab077fca07acb49e1718c0ba71798a105e88ec3862457648e9c7ac99bc5da49
+  data.tar.gz: f495d2a625abb94c25ef337ac03dce967bc64595c8847f92215b7fe2efccf1b4
 SHA512:
-  metadata.gz: 2ac65df6ad2859aec9c90dffe1704bf8f8ac940e2f519fd3155169c9b6955f8b1c801ffea812428ab149604303f16b6b5a03bf5a0cd1fb8b7854e32d12143146
-  data.tar.gz: 108be0c78b2cf0be1d9ea54646993d34124aa7e7c21ffad2054d4eb35555a0d3f505f3a42aefda4596c5358d9cbc609c31c77d7a49fa7d6da4aae94d9d986830
+  metadata.gz: ebf84239a94db56cfc315b3a4e0b51805fa84cd9e6aaef679757ccbbad02e4bcc5f2b0b2f96b82993a4cfe23e280a9b5cce15c96237c43f922558f2b1d90b12a
+  data.tar.gz: 459c8197ab831eb5a6a9c526692ec2e3e30ff248647ca1b60cd8be20fe371f2ab940dcd1ae04658f2d8a2589364a5615e36482aaa4a941a9ee84c96956488ff7

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 2020-09-16 v1.0.0
+- Tag a v1.0.0 release as the SDK design has stabilized. Future v1.x.x SDK releases will remain compatible with code written against v1.0.0, according to [Semantic Versioning](https://semver.org/).
+- Support new Organization feature
+- Support new `AdminCreateInstallTokenRequest` API
+- Support new Admin user management APIs
+- Support new `RebrandStorage` property on Storage Vaults and on Requestable destination targets
+- Update descriptions for `SEVT_META_HELLO` and `AdminMetaWebhookOptionsSet`
+
 ## 2020-08-28 v0.4.0
 - Feature: Add definitions B2 and Wasabi `VirtualStorageRole` classes
 - Feature: Add definitions for remote LDAP authentication data sources

data/Gemfile.lock

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

data/RELEASING.md

@@ -3,7 +3,7 @@
 1. All tests passing
 2. Update changelog in `CHANGELOG.md`
 3. Update version number in `gemspec`
-4. `gem build`
+4. `gem build comet_backup_ruby_sdk`
 	- Should be warning-free
 5. Git tag
 	- Respect semver

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       = '0.4.0'
+  spec.version       = '1.0.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -309,6 +309,89 @@ module Comet
       ret
     end
 
+    # AdminAdminUserDelete
+    #
+    # Delete an administrator.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
+    #
+    # @param [String] target_user the username of the admin to be deleted
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_admin_user_delete(target_user)
+      submit_params = {}
+      raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/admin-user/delete', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAdminUserList
+    #
+    # List administrators.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
+    #
+    # @return [Array<Comet::AllowedAdminUser>]
+    def admin_admin_user_list
+      body = perform_request('/api/v1/admin/admin-user/list')
+      json_body = JSON.parse body
+      check_status json_body
+      if json_body.nil?
+        ret = []
+      else
+        ret = Array.new(json_body.length)
+        json_body.each_with_index do |v, i|
+          ret[i] = Comet::AllowedAdminUser.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminAdminUserNew
+    #
+    # Add a new administrator.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
+    #
+    # @param [String] target_user the username for this new admin
+    # @param [String] target_password the password for this new admin user
+    # @param [String] target_org_id (Optional) provide the organization ID for this user, it will default to the org of the authenticating user otherwise
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_admin_user_new(target_user, target_password, target_org_id = nil)
+      submit_params = {}
+      raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError "'target_password' expected String, got #{target_password.class}" unless target_password.is_a? String
+
+      submit_params['TargetPassword'] = target_password
+      unless target_org_id.nil?
+        raise TypeError "'target_org_id' expected String, got #{target_org_id.class}" unless target_org_id.is_a? String
+
+        submit_params['TargetOrgID'] = target_org_id
+      end
+
+      body = perform_request('/api/v1/admin/admin-user/new', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminBrandingAvailablePlatforms
     #
     # List available software download platforms.
@@ -615,6 +698,7 @@ 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]
@@ -632,6 +716,7 @@ 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]
@@ -649,6 +734,7 @@ module Comet
     # Prune unused buckets.
     #
     # 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::CometAPIResponseMessage]
@@ -666,6 +752,7 @@ 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]
@@ -678,6 +765,40 @@ module Comet
       ret
     end
 
+    # AdminCreateInstallToken
+    #
+    # Create token for silent installation (Windows only).
+    # Provide the installation token to silently install the client on windows `install.exe /TOKEN=<installtoken>`
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user Selected account username
+    # @param [String] target_password Selected account password
+    # @param [String] server (Optional) External URL of the authentication server that is different from the current server
+    # @return [Comet::InstallTokenResponse]
+    def admin_create_install_token(target_user, target_password, server = nil)
+      submit_params = {}
+      raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError "'target_password' expected String, got #{target_password.class}" unless target_password.is_a? String
+
+      submit_params['TargetPassword'] = target_password
+      unless server.nil?
+        raise TypeError "'server' expected String, got #{server.class}" unless server.is_a? String
+
+        submit_params['Server'] = server
+      end
+
+      body = perform_request('/api/v1/admin/create-install-token', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::InstallTokenResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDeleteUser
     #
     # Delete user account.
@@ -1924,6 +2045,7 @@ module Comet
     # Get log files.
     #
     # 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.
     #
     # @return [Array<Number>]
     def admin_meta_list_available_log_days
@@ -1950,6 +2072,7 @@ module Comet
     # 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 administrator accounts in the top-level Organization, not in any other Organization.
     #
     # @param [Number] log A log day, selected from the options returned by the Get Log Files API
     # @return [String]
@@ -2035,6 +2158,7 @@ module Comet
     # Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
     #
     # 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.
     # Access to this API may be prevented on a per-administrator basis.
     #
     # @return [Comet::CometAPIResponseMessage]
@@ -2053,6 +2177,7 @@ module Comet
     # This allows the Comet Server web interface to support testing different email credentials during setup.
     #
     # 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.
     # Access to this API may be prevented on a per-administrator basis.
     #
     # @param [Comet::EmailOptions] email_options Updated configuration content
@@ -2081,6 +2206,7 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     # Access to this API may be prevented on a per-administrator basis.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     #
     # @return [Comet::ServerConfigOptions]
     def admin_meta_server_config_get
@@ -2099,6 +2225,7 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     # Access to this API may be prevented on a per-administrator basis.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     #
     # @return [Array<String>]
     def admin_meta_server_config_network_interfaces
@@ -2127,6 +2254,7 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     # Access to this API may be prevented on a per-administrator basis.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     #
     # @param [Comet::ServerConfigOptions] config Updated configuration content
     # @return [Comet::CometAPIResponseMessage]
@@ -2152,6 +2280,7 @@ module Comet
     # Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
     #
     # 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.
     # Access to this API may be prevented on a per-administrator basis.
     #
     # @return [Comet::CometAPIResponseMessage]
@@ -2255,7 +2384,7 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     #
-    # @param [Hash{String => Comet::WebhookOption}] webhook_options A json encoded string of the new webhook target options.
+    # @param [Hash{String => Comet::WebhookOption}] webhook_options The replacement webhook target options.
     # @return [Comet::CometAPIResponseMessage]
     def admin_meta_webhook_options_set(webhook_options)
       submit_params = {}
@@ -2341,6 +2470,92 @@ module Comet
       ret
     end
 
+    # AdminOrganizationDelete
+    #
+    # Delete an organization and all related users.
+    #
+    # 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.
+    #
+    # @param [String] organization_id (Optional) (No description available)
+    # @param [Comet::UninstallConfig] uninstall_config (Optional) Uninstall software configuration
+    # @return [Comet::OrganizationResponse]
+    def admin_organization_delete(organization_id = nil, uninstall_config = nil)
+      submit_params = {}
+      unless organization_id.nil?
+        raise TypeError "'organization_id' expected String, got #{organization_id.class}" unless organization_id.is_a? String
+
+        submit_params['OrganizationID'] = organization_id
+      end
+      unless uninstall_config.nil?
+        raise TypeError "'uninstall_config' expected Comet::UninstallConfig, got #{uninstall_config.class}" unless uninstall_config.is_a? Comet::UninstallConfig
+
+        submit_params['UninstallConfig'] = uninstall_config.to_json
+      end
+
+      body = perform_request('/api/v1/admin/organization/delete', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::OrganizationResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminOrganizationList
+    #
+    # List Organizations.
+    #
+    # 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.
+    #
+    # @return [Hash{String => Comet::Organization}]
+    def admin_organization_list
+      body = perform_request('/api/v1/admin/organization/list')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = {}
+      if json_body.nil?
+        ret = {}
+      else
+        json_body.each do |k, v|
+          ret[k] = Comet::Organization.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminOrganizationSet
+    #
+    # Create or Update an Organization.
+    #
+    # 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.
+    #
+    # @param [String] organization_id (Optional) (No description available)
+    # @param [Comet::Organization] organization (Optional) (No description available)
+    # @return [Comet::OrganizationResponse]
+    def admin_organization_set(organization_id = nil, organization = nil)
+      submit_params = {}
+      unless organization_id.nil?
+        raise TypeError "'organization_id' expected String, got #{organization_id.class}" unless organization_id.is_a? String
+
+        submit_params['OrganizationID'] = organization_id
+      end
+      unless organization.nil?
+        raise TypeError "'organization' expected Comet::Organization, got #{organization.class}" unless organization.is_a? Comet::Organization
+
+        submit_params['Organization'] = organization.to_json
+      end
+
+      body = perform_request('/api/v1/admin/organization/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::OrganizationResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminPoliciesDelete
     #
     # Delete an existing policy object.
@@ -2533,6 +2748,7 @@ module Comet
     # Get Replication 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.
     #
     # @return [Array<Comet::ReplicatorStateAPIResponse>]
     def admin_replication_state
@@ -2764,6 +2980,7 @@ module Comet
     # You must supply administrator authentication credentials to use this API.
     # Access to this API may be prevented on a per-administrator basis.
     # This API requires the Storage Role to be enabled.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
     #
     # @param [String] bucket_id Selected bucket name
     # @return [Comet::StorageFreeSpaceInfo]
@@ -2817,8 +3034,9 @@ module Comet
     # @param [String] set_bucket_value (Optional) Bucket ID
     # @param [String] set_key_hash_format (Optional) Bucket key hashing format
     # @param [String] set_key_hash_value (Optional) Bucket key hash
+    # @param [String] set_organization_id (Optional) Target organization ID (>= 20.9.0)
     # @return [Comet::AddBucketResponseMessage]
-    def admin_storage_register_bucket(set_bucket_value = nil, set_key_hash_format = nil, set_key_hash_value = nil)
+    def admin_storage_register_bucket(set_bucket_value = nil, set_key_hash_format = nil, set_key_hash_value = nil, set_organization_id = nil)
       submit_params = {}
       unless set_bucket_value.nil?
         raise TypeError "'set_bucket_value' expected String, got #{set_bucket_value.class}" unless set_bucket_value.is_a? String
@@ -2835,6 +3053,11 @@ module Comet
 
         submit_params['SetKeyHashValue'] = set_key_hash_value
       end
+      unless set_organization_id.nil?
+        raise TypeError "'set_organization_id' expected String, got #{set_organization_id.class}" unless set_organization_id.is_a? String
+
+        submit_params['SetOrganizationID'] = set_organization_id
+      end
 
       body = perform_request('/api/v1/admin/storage/register-bucket', submit_params)
       json_body = JSON.parse body
@@ -2849,6 +3072,7 @@ module Comet
     # Start a new software update campaign.
     #
     # 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 Software Build Role to be enabled.
     # This API requires the Auth Role to be enabled.
     #
@@ -2873,6 +3097,7 @@ module Comet
     # Get current campaign 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 Software Build Role to be enabled.
     # This API requires the Auth Role to be enabled.
     #

data/lib/comet/definitions.rb

@@ -356,15 +356,15 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '20.8.0'
+  APPLICATION_VERSION = '20.9.1'
 
   APPLICATION_VERSION_MAJOR = 20
 
-  APPLICATION_VERSION_MINOR = 8
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 0
+  APPLICATION_VERSION_REVISION = 1
 
-  RELEASE_CODENAME = 'Jupiter'
+  RELEASE_CODENAME = 'Voyager'
 
   ENCRYPTIONMETHOD_UNCONFIGURED = 0
 
@@ -532,7 +532,7 @@ module Comet
   # MacOSCodesignLevel:
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
 
-  # StreamableEventType:
+  # StreamableEventType: Event is emitted when the webhook is registered, or when the server starts up. The Data associated is ServerMetaVersionInfo
   SEVT_META_HELLO = 4000
 
   # StreamableEventType: Data is the profile object