comet_backup_ruby_sdk 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e51a11d5b03cf1b325584c429159a4e3ee504d3bbb35bba40018598ff96becf
+  data.tar.gz: 1ef176d29a079a13ae4aea6489afbd6b2682d143c567876bf9009aa33122b161
+SHA512:
+  metadata.gz: c6a241c4231616d77fc376d0d165b15256ae59cbf4fff1e62a62d9812d355f046cf52d89fa06b05ec5d1ec3cce902baf7b63c7faba8058051c2e22c45bc10f4a
+  data.tar.gz: b402d40013cab79d0af2b33c91423de4572686cd1b1ed372ccbdb2857745bbc48d46c01cdf904d09a9a846567c69b9813e92bd8f9c6cd1e08195c5a82d2d6731

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  NewCops: enable
+
+# Use unix LF file endings on all OS platforms
+Layout/EndOfLine:
+  EnforcedStyle: lf
+  
+# Disable complexity metrics - it's out of our control
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+# Allow a bit more whitespace
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Don't warn about single-line if bodies. It's better for us to be consistent
+# with the times when we do need multi-line bodies
+Style/IfUnlessModifier:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in comet_backup_ruby_sdk.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Comet Licensing Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Ruby SDK for the Comet Server API
+
+[![@CometBackup on Twitter](https://img.shields.io/badge/twitter-%40CometBackup-blue.svg?style=flat)](https://twitter.com/CometBackup)
+![MIT License](https://img.shields.io/packagist/l/cometbackup/comet-php-sdk.svg)
+
+The Comet Server API allows you to create and manage customer accounts on your Comet Server.
+
+Comet Licensing Ltd makes this library freely available under the [MIT license](https://spdx.org/licenses/MIT.html); you may embed it in any Ruby project, either free or commercial, as long as the copyright header comment remains intact in the `*.rb` files.
+
+## Features
+
+- Full coverage of Comet Server API methods, data structures, and constant definitions
+
+## Version compatibility
+
+This library uses [Semantic Versioning](https://semver.org/). However, large parts of this library are autogenerated from internal protocol descriptions from a specific version of Comet Server; to find the source Comet Server version, check the `Comet::APPLICATION_VERSION` constant.
+
+Newer API libraries can be safely used with older versions of Comet Server, however some features may be unavailable, and any new API properties will be unrecognized and ignored by the Comet Server.
+
+Older API libraries can be safely used with newer versions of Comet Server. Unknown API properties corresponding to new Comet Server features will be preserved via the `@unknown_json_fields` system.
+
+## Getting Started
+
+This package is provided as a Gem hosted on [rubygems.org](https://rubygems.org/).
+
+Install using [Bundler](https://bundler.io/):
+
+```bash
+echo "gem 'comet_backup_ruby_sdk'" >> Gemfile
+bundle
+```
+
+Or install using [Gem](https://rubygems.org/):
+
+    $ gem install comet_backup_ruby_sdk
+
+To compile the gem from source:
+
+```bash
+git clone https://github.com/CometBackup/comet-ruby-sdk.git
+cd comet-ruby-sdk
+gem build comet_backup_ruby_sdk.gemspec
+```
+
+## Usage
+
+Connect to the Comet Server and iterate through user profiles:
+
+```ruby
+require 'comet_backup_ruby_sdk'
+
+client = Comet::CometServer.new("http://127.0.0.1:8060", "admin", "admin")
+
+client.admin_list_users_full.each do |username, profile|
+  puts "#{username} has #{profile.destinations.length} Storage Vault(s)"
+end
+```
+
+The Comet Server API always returns an HTTP 200 status code, and puts application-level errors in the response message body using the `Comet::CometAPIResponseMessage` structure. This helps to distinguish between network-level errors and proxy-level errors. This SDK converts application-level errors to raise exceptions:
+
+```ruby
+begin
+  client.admin_get_user_profile('non_existent_user')
+
+rescue Comet::APIResponseError => err
+  if err.detail.status >= 400 && err.detail.status < 500
+    puts "Comet Server returned caller-side error (4xx) - permanent, do not retry"
+  else
+    puts "Comet Server returned server-side error (5xx) - may want to retry"
+  end
+
+rescue StandardError
+  puts "Failed to reach the Comet Server (non-200 HTTP status code) - may want to retry"
+end
+```
+
+## Getting Help
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/CometBackup/comet-ruby-sdk](https://github.com/CometBackup/comet-ruby-sdk).
+
+You may also submit issues via the ticket system at [cometbackup.com](https://cometbackup.com/).

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+# Rubocop task
+RuboCop::RakeTask.new
+
+# Minitest
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/comet_backup_ruby_sdk.gemspec

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'comet_backup_ruby_sdk'
+  spec.version       = '0.2.0'
+  spec.authors       = ['Comet Licensing Ltd.']
+  spec.email         = ['hello@cometbackup.com']
+
+  spec.summary       = 'Comet Backup - Comet Server API SDK'
+  spec.description   = 'The Comet Server can be controlled via an API over HTTP / HTTPS.'
+  spec.homepage      = 'https://github.com/CometBackup/comet-ruby-sdk'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.88'
+end

data/lib/comet/api_response_error.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+module Comet
+
+  # APIResponseError is a custom exception class that wraps the Comet::CometAPIResponseMessage
+  # type. These represent application-level error responses from the Comet Server API.
+  # Network-level error responses should be caught using the Net::HTTP error types.
+  class APIResponseError < StandardError
+
+    # @type [Comet::CometAPIResponseMessage] The application-level error
+    attr_reader :detail
+
+    def initialize(carm)
+      @detail = carm
+
+      super("#{carm.message} (#{carm.status})")
+    end
+  end
+
+end

data/lib/comet/comet_server.rb

@@ -0,0 +1,2926 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Comet
+
+  # The CometServer class enables making network requests to the Comet Server API.
+  class CometServer
+
+    # @type [String] The Comet Server URL
+    attr_accessor :server_address
+
+    # @type [String] Username to log in to the Comet Server API
+    attr_accessor :username
+
+    # @type [String] Password to log in to the Comet Server API
+    attr_accessor :password
+
+    # Initialize a new CometServer class instance.
+    def initialize(server_address, username, password)
+      raise TypeError 'expected string' unless server_address.is_a? String
+      raise TypeError 'expected string' unless username.is_a? String
+      raise TypeError 'expected string' unless password.is_a? String
+
+      @server_address = server_address
+      @username = username
+      @password = password
+    end
+
+    # AdminAccountProperties
+    #
+    # Retrieve properties about the current admin account.
+    # Some key parameters are obscured, but the obscured values are safely recognised by the corresponding AdminAccountSetProperties API.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Comet::AdminAccountPropertiesResponse]
+    def admin_account_properties
+      body = perform_request('/api/v1/admin/account/properties')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::AdminAccountPropertiesResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountRegenerateTotp
+    #
+    # Generate a new TOTP secret.
+    # The secret is returned as a `data-uri` image of a QR code. The new secret is immediately applied to the current admin account.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Comet::TotpRegeneratedResponse]
+    def admin_account_regenerate_totp
+      body = perform_request('/api/v1/admin/account/regenerate-totp')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::TotpRegeneratedResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountSessionRevoke
+    #
+    # Revoke a session key (log out).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_session_revoke
+      body = perform_request('/api/v1/admin/account/session-revoke')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountSessionStart
+    #
+    # Generate a session key (log in).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] self_address (Optional) External URL of this server (used for U2F AppID)
+    # @return [Comet::SessionKeyRegeneratedResponse]
+    def admin_account_session_start(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      body = perform_request('/api/v1/admin/account/session-start', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::SessionKeyRegeneratedResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountSessionStartAsUser
+    #
+    # Generate a session key for an end-user (log in as end-user).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] target_user Target account username
+    # @return [Comet::SessionKeyRegeneratedResponse]
+    def admin_account_session_start_as_user(target_user)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/account/session-start-as-user', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::SessionKeyRegeneratedResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountSetProperties
+    #
+    # Update settings for your own admin account.
+    # Updating your account password requires you to supply your current password.
+    # To set a new plaintext password, use a password format of 0 (PASSWORD_FORMAT_PLAINTEXT).
+    # This API does not currently allow you to modify your TOTP secret or IP whitelist.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [Comet::AdminSecurityOptions] security Updated account properties
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_set_properties(security)
+      submit_params = {}
+      raise TypeError 'expected Comet::AdminSecurityOptions' unless security.is_a? Comet::AdminSecurityOptions
+
+      submit_params['Security'] = security.to_json
+
+      body = perform_request('/api/v1/admin/account/set-properties', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountU2fRequestRegistrationChallenge
+    #
+    # Register a new FIDO U2F token.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] self_address External URL of this server, used as U2F AppID and Facet
+    # @return [Comet::U2FRegistrationChallengeResponse]
+    def admin_account_u2f_request_registration_challenge(self_address)
+      submit_params = {}
+      raise TypeError 'expected string' unless self_address.is_a? String
+
+      submit_params['SelfAddress'] = self_address
+
+      body = perform_request('/api/v1/admin/account/u2f/request-registration-challenge', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::U2FRegistrationChallengeResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountU2fSubmitChallengeResponse
+    #
+    # Register a new FIDO U2F token.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] u2fchallenge_id Associated value from AdminAccountU2fRequestRegistrationChallenge API
+    # @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
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_u2f_submit_challenge_response(u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description)
+      submit_params = {}
+      raise TypeError 'expected string' unless u2fchallenge_id.is_a? String
+
+      submit_params['U2FChallengeID'] = u2fchallenge_id
+      raise TypeError 'expected string' unless u2fclient_data.is_a? String
+
+      submit_params['U2FClientData'] = u2fclient_data
+      raise TypeError 'expected string' unless u2fregistration_data.is_a? String
+
+      submit_params['U2FRegistrationData'] = u2fregistration_data
+      raise TypeError 'expected string' unless u2fversion.is_a? String
+
+      submit_params['U2FVersion'] = u2fversion
+      raise TypeError 'expected string' unless description.is_a? String
+
+      submit_params['Description'] = description
+
+      body = perform_request('/api/v1/admin/account/u2f/submit-challenge-response', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountValidateTotp
+    #
+    # Validate the TOTP code before turning 2fa(TOTP) on.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] totpcode Six-digit code after scanning barcode image
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_validate_totp(totpcode)
+      submit_params = {}
+      raise TypeError 'expected string' unless totpcode.is_a? String
+
+      submit_params['TOTPCode'] = totpcode
+
+      body = perform_request('/api/v1/admin/account/validate-totp', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAddUser
+    #
+    # Add a new user account.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user New account username
+    # @param [String] target_password New account password
+    # @param [Number] store_recovery_code (Optional) If set to 1, store and keep a password recovery code for the generated user (>= 18.3.9)
+    # @param [Number] require_password_change (Optional) If set to 1, require to reset password at the first login for the generated user (>= 20.3.4)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_add_user(target_user, target_password, store_recovery_code = nil, require_password_change = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected string' unless target_password.is_a? String
+
+      submit_params['TargetPassword'] = target_password
+      unless store_recovery_code.nil?
+        submit_params['StoreRecoveryCode'] = store_recovery_code
+      end
+      unless require_password_change.nil?
+        submit_params['RequirePasswordChange'] = require_password_change
+      end
+
+      body = perform_request('/api/v1/admin/add-user', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAddUserFromProfile
+    #
+    # Add a new user account (with all information).
+    # This allows you to create a new account and set all its properties at once (e.g. during account replication). Developers creating a signup form may find it simpler to use the AdminAddUser and AdminGetUserProfile / AdminSetUserProfile APIs separately.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user New account username
+    # @param [Comet::UserProfileConfig] profile_data New account profile
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_add_user_from_profile(target_user, profile_data)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected Comet::UserProfileConfig' unless profile_data.is_a? Comet::UserProfileConfig
+
+      submit_params['ProfileData'] = profile_data.to_json
+
+      body = perform_request('/api/v1/admin/add-user-from-profile', 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.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{Number => Comet::AvailableDownload}]
+    def admin_branding_available_platforms
+      body = perform_request('/api/v1/admin/branding/available-platforms')
+      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::AvailableDownload.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminBrandingGenerateClientByPlatform
+    #
+    # Download software.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [Number] platform The selected download platform, from the AdminBrandingAvailablePlatforms API
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_by_platform(platform, self_address = nil)
+      submit_params = {}
+      submit_params['Platform'] = platform
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/by-platform', submit_params)
+    end
+
+    # AdminBrandingGenerateClientLinuxgeneric
+    #
+    # Download software (Linux Server .run).
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_linuxgeneric(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/linuxgeneric', submit_params)
+    end
+
+    # AdminBrandingGenerateClientMacosX8664
+    #
+    # Download software (macOS x86_64 pkg).
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_macos_x8664(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/macos-x86_64', submit_params)
+    end
+
+    # AdminBrandingGenerateClientTest
+    #
+    # Check if a software download is available.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [Number] platform The selected download platform, from the AdminBrandingAvailablePlatforms API
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_branding_generate_client_test(platform, self_address = nil)
+      submit_params = {}
+      submit_params['Platform'] = platform
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      body = perform_request('/api/v1/admin/branding/generate-client/test', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminBrandingGenerateClientWindowsAnycpuExe
+    #
+    # Download software update (Windows AnyCPU exe).
+    # The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_windows_anycpu_exe(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/windows-anycpu-exe', submit_params)
+    end
+
+    # AdminBrandingGenerateClientWindowsAnycpuZip
+    #
+    # Download software (Windows AnyCPU zip).
+    # The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_windows_anycpu_zip(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/windows-anycpu-zip', submit_params)
+    end
+
+    # AdminBrandingGenerateClientWindowsX8632Exe
+    #
+    # Download software update (Windows x86_32 exe).
+    # The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_windows_x8632exe(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/windows-x86_32-exe', submit_params)
+    end
+
+    # AdminBrandingGenerateClientWindowsX8632Zip
+    #
+    # Download software (Windows x86_32 zip).
+    # The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_windows_x8632zip(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/windows-x86_32-zip', submit_params)
+    end
+
+    # AdminBrandingGenerateClientWindowsX8664Exe
+    #
+    # Download software update (Windows x86_64 exe).
+    # The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_windows_x8664exe(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/windows-x86_64-exe', submit_params)
+    end
+
+    # AdminBrandingGenerateClientWindowsX8664Zip
+    #
+    # Download software (Windows x86_64 zip).
+    # The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.
+    #
+    # This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts
+    # @return [String]
+    def admin_branding_generate_client_windows_x8664zip(self_address = nil)
+      submit_params = {}
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      perform_request('/api/v1/admin/branding/generate-client/windows-x86_64-zip', submit_params)
+    end
+
+    # AdminBulletinSubmit
+    #
+    # Send an email bulletin to all users.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] subject Bulletin subject line
+    # @param [String] content Bulletin message content
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_bulletin_submit(subject, content)
+      submit_params = {}
+      raise TypeError 'expected string' unless subject.is_a? String
+
+      submit_params['Subject'] = subject
+      raise TypeError 'expected string' unless content.is_a? String
+
+      submit_params['Content'] = content
+
+      body = perform_request('/api/v1/admin/bulletin/submit', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminConstellationLastReport
+    #
+    # Get Constellation bucket usage report (cached).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Constellation Role to be enabled.
+    #
+    # @return [Comet::ConstellationCheckReport]
+    def admin_constellation_last_report
+      body = perform_request('/api/v1/admin/constellation/last-report')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ConstellationCheckReport.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminConstellationNewReport
+    #
+    # Get Constellation bucket usage report (regenerate).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Constellation Role to be enabled.
+    #
+    # @return [Comet::ConstellationCheckReport]
+    def admin_constellation_new_report
+      body = perform_request('/api/v1/admin/constellation/new-report')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ConstellationCheckReport.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminConstellationPruneNow
+    #
+    # Prune unused buckets.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Constellation Role to be enabled.
+    #
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_constellation_prune_now
+      body = perform_request('/api/v1/admin/constellation/prune-now')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminConstellationStatus
+    #
+    # Get Constellation status.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Constellation Role to be enabled.
+    #
+    # @return [Comet::ConstellationStatusAPIResponse]
+    def admin_constellation_status
+      body = perform_request('/api/v1/admin/constellation/status')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ConstellationStatusAPIResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDeleteUser
+    #
+    # Delete user account.
+    # This does not remove any storage buckets. Unused storage buckets will be cleaned up by the Constellation Role.
+    # Any stored data can not be decrypted without the user profile. Misuse can cause data loss!
+    # This also allows to uninstall software from active devices under the user account
+    #
+    # 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 [Comet::UninstallConfig] uninstall_config (Optional) Uninstall software configuration (>= 20.3.5)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_delete_user(target_user, uninstall_config = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      unless uninstall_config.nil?
+        raise TypeError 'expected Comet::UninstallConfig' unless uninstall_config.is_a? Comet::UninstallConfig
+
+        submit_params['UninstallConfig'] = uninstall_config.to_json
+      end
+
+      body = perform_request('/api/v1/admin/delete-user', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDisableUserTotp
+    #
+    # Disable user account 2FA(TOTP) authentication.
+    #
+    # 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
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_disable_user_totp(target_user)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/disable-user-totp', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherApplyRetentionRules
+    #
+    # Instruct a live connected device to apply retention rules now.
+    # This command is understood by Comet Backup 17.6.9 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_apply_retention_rules(target_id, destination)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+
+      body = perform_request('/api/v1/admin/dispatcher/apply-retention-rules', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherDeepverifyStorageVault
+    #
+    # Instruct a live connected device to deeply verify Storage Vault content.
+    # This command is understood by Comet Backup 18.8.2 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_deepverify_storage_vault(target_id, destination)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+
+      body = perform_request('/api/v1/admin/dispatcher/deepverify-storage-vault', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherDeleteSnapshot
+    #
+    # Instruct a live connected device to delete a stored snapshot.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination_id The Storage Vault GUID
+    # @param [String] snapshot_id The backup job snapshot ID to delete
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_delete_snapshot(target_id, destination_id, snapshot_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination_id.is_a? String
+
+      submit_params['DestinationID'] = destination_id
+      raise TypeError 'expected string' unless snapshot_id.is_a? String
+
+      submit_params['SnapshotID'] = snapshot_id
+
+      body = perform_request('/api/v1/admin/dispatcher/delete-snapshot', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherDropConnection
+    #
+    # Disconnect a live connected device.
+    # The device will almost certainly attempt to reconnect.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_drop_connection(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/drop-connection', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherImportApply
+    #
+    # Instruct a live connected device to import settings from an installed product.
+    # This command is understood by Comet Backup 17.12.0 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] import_source_id The selected import source, as found by the AdminDispatcherRequestImportSources API
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_import_apply(target_id, import_source_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless import_source_id.is_a? String
+
+      submit_params['ImportSourceID'] = import_source_id
+
+      body = perform_request('/api/v1/admin/dispatcher/import-apply', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherKillProcess
+    #
+    # Instruct a live connected device to disconnect.
+    # The device will terminate its live-connection process and will not reconnect.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_kill_process(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/kill-process', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherListActive
+    #
+    # List live connected devices.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => Comet::LiveUserConnection}]
+    def admin_dispatcher_list_active
+      body = perform_request('/api/v1/admin/dispatcher/list-active')
+      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::LiveUserConnection.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminDispatcherRefetchProfile
+    #
+    # Instruct a live connected device to refresh their profile.
+    # This command is understood by Comet Backup 17.12.0 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_refetch_profile(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/refetch-profile', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherReindexStorageVault
+    #
+    # Instruct a live connected device to rebuild Storage Vault indexes now.
+    # This command is understood by Comet Backup 18.6.9 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_reindex_storage_vault(target_id, destination)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+
+      body = perform_request('/api/v1/admin/dispatcher/reindex-storage-vault', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseDiskDrives
+    #
+    # Request a list of physical disk drive information from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::BrowseDiskDrivesResponse]
+    def admin_dispatcher_request_browse_disk_drives(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/request-browse-disk-drives', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseDiskDrivesResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseExchangeEdb
+    #
+    # Request a list of Exchange EDB databases from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::BrowseEDBResponse]
+    def admin_dispatcher_request_browse_exchange_edb(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/request-browse-exchange-edb', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseEDBResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseHyperv
+    #
+    # Request a list of Hyper-V virtual machines from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::BrowseHVResponse]
+    def admin_dispatcher_request_browse_hyperv(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/request-browse-hyperv', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseHVResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseVssAaw
+    #
+    # Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::BrowseVSSResponse]
+    def admin_dispatcher_request_browse_vss_aaw(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/request-browse-vss-aaw', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseVSSResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestFilesystemObjects
+    #
+    # Request a list of filesystem objects from a live connected device.
+    # The device must have granted the administrator permission to view its filenames.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] path (Optional) Browse objects inside this path. If empty or not present, returns the top-level device paths
+    # @return [Array<Comet::StoredObject>]
+    def admin_dispatcher_request_filesystem_objects(target_id, path = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      unless path.nil?
+        raise TypeError 'expected string' unless path.is_a? String
+
+        submit_params['Path'] = path
+      end
+
+      body = perform_request('/api/v1/admin/dispatcher/request-filesystem-objects', submit_params)
+      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::StoredObject.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminDispatcherRequestImportSources
+    #
+    # Request a list of import sources from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @return [Comet::DispatcherAdminSourcesResponse]
+    def admin_dispatcher_request_import_sources(target_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+
+      body = perform_request('/api/v1/admin/dispatcher/request-import-sources', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::DispatcherAdminSourcesResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestStoredObjects
+    #
+    # Request a list of stored objects inside an existing backup job.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault ID
+    # @param [String] snapshot_id The selected backup job snapshot
+    # @param [String] tree_id (Optional) Browse objects inside subdirectory of backup snapshot
+    # @return [Comet::DispatcherStoredObjectsResponse]
+    def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      raise TypeError 'expected string' unless snapshot_id.is_a? String
+
+      submit_params['SnapshotID'] = snapshot_id
+      unless tree_id.nil?
+        raise TypeError 'expected string' unless tree_id.is_a? String
+
+        submit_params['TreeID'] = tree_id
+      end
+
+      body = perform_request('/api/v1/admin/dispatcher/request-stored-objects', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::DispatcherStoredObjectsResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestVaultSnapshots
+    #
+    # Request a list of Storage Vault snapshots from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault ID
+    # @return [Comet::DispatcherVaultSnapshotsResponse]
+    def admin_dispatcher_request_vault_snapshots(target_id, destination)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+
+      body = perform_request('/api/v1/admin/dispatcher/request-vault-snapshots', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::DispatcherVaultSnapshotsResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRunBackup
+    #
+    # Instruct a live connected device to run a scheduled backup.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] backup_rule The schedule GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_run_backup(target_id, backup_rule)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless backup_rule.is_a? String
+
+      submit_params['BackupRule'] = backup_rule
+
+      body = perform_request('/api/v1/admin/dispatcher/run-backup', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRunBackupCustom
+    #
+    # Instruct a live connected device to run a backup.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] source The Protected Item GUID
+    # @param [String] destination The Storage Vault GUID
+    # @param [Comet::BackupJobAdvancedOptions] options (Optional) Extra job parameters (>= 19.3.6)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_run_backup_custom(target_id, source, destination, options = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless source.is_a? String
+
+      submit_params['Source'] = source
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      unless options.nil?
+        raise TypeError 'expected Comet::BackupJobAdvancedOptions' unless options.is_a? Comet::BackupJobAdvancedOptions
+
+        submit_params['Options'] = options.to_json
+      end
+
+      body = perform_request('/api/v1/admin/dispatcher/run-backup-custom', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRunRestore
+    #
+    # Instruct a live connected device to perform a local restore.
+    # This command is understood by Comet Backup 17.9.3 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] path The local path to restore to
+    # @param [String] source The Protected Item ID
+    # @param [String] destination The Storage Vault ID
+    # @param [String] snapshot (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair
+    # @param [Array<String>] paths (Optional) If present, restore these paths only. Otherwise, restore all data (>= 19.3.0)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_run_restore(target_id, path, source, destination, snapshot = nil, paths = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless path.is_a? String
+
+      submit_params['Path'] = path
+      raise TypeError 'expected string' unless source.is_a? String
+
+      submit_params['Source'] = source
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      unless snapshot.nil?
+        raise TypeError 'expected string' unless snapshot.is_a? String
+
+        submit_params['Snapshot'] = snapshot
+      end
+      unless paths.nil?
+        raise TypeError 'expected array' unless paths.is_a? Array
+
+        submit_params['Paths'] = paths.to_json
+      end
+
+      body = perform_request('/api/v1/admin/dispatcher/run-restore', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRunRestoreCustom
+    #
+    # Instruct a live connected device to perform a local restore.
+    # This command is understood by Comet Backup 18.6.0 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] source The Protected Item ID
+    # @param [String] destination The Storage Vault ID
+    # @param [Comet::RestoreJobAdvancedOptions] options Restore targets
+    # @param [String] snapshot (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair
+    # @param [Array<String>] paths (Optional) If present, restore these paths only. Otherwise, restore all data
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_run_restore_custom(target_id, source, destination, options, snapshot = nil, paths = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless source.is_a? String
+
+      submit_params['Source'] = source
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      raise TypeError 'expected Comet::RestoreJobAdvancedOptions' unless options.is_a? Comet::RestoreJobAdvancedOptions
+
+      submit_params['Options'] = options.to_json
+      unless snapshot.nil?
+        raise TypeError 'expected string' unless snapshot.is_a? String
+
+        submit_params['Snapshot'] = snapshot
+      end
+      unless paths.nil?
+        raise TypeError 'expected array' unless paths.is_a? Array
+
+        submit_params['Paths'] = paths.to_json
+      end
+
+      body = perform_request('/api/v1/admin/dispatcher/run-restore-custom', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherUninstallSoftware
+    #
+    # Instruct a live connected device to self-uninstall the software.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Boolean] remove_config_file Determine if the config.dat file will be deleted at the same time
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_uninstall_software(target_id, remove_config_file)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      submit_params['RemoveConfigFile'] = (remove_config_file ? 1 : 0)
+
+      body = perform_request('/api/v1/admin/dispatcher/uninstall-software', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherUnlock
+    #
+    # Instruct a live connected device to remove lock files from a Storage Vault.
+    # Misuse can cause data loss!
+    # This command is understood by Comet Backup 17.9.4 and newer.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_unlock(target_id, destination)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+
+      body = perform_request('/api/v1/admin/dispatcher/unlock', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherUpdateLoginUrl
+    #
+    # Instruct a live connected device to update its login server URL.
+    # The device will attempt to connect to the new Auth Role Comet Server using its current username and password. If the test connection succeeds, the device migrates its saved connection settings and live connections to the new server. If the device is not registered on the new URL, or if the credentials are incorrect, the device remains on the current Auth Role server.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] new_url The new external URL of this server
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_update_login_url(target_id, new_url)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError 'expected string' unless new_url.is_a? String
+
+      submit_params['NewURL'] = new_url
+
+      body = perform_request('/api/v1/admin/dispatcher/update-login-url', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherUpdateSoftware
+    #
+    # Instruct a live connected device to download a software update.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    # This API requires the Software Build Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] self_address (Optional) The external URL of this server, used to resolve conflicts (>= 19.3.11)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_update_software(target_id, self_address = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      body = perform_request('/api/v1/admin/dispatcher/update-software', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminGetJobLog
+    #
+    # Get the report log entries for a single job.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] job_id Selected job ID
+    # @return [String]
+    def admin_get_job_log(job_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless job_id.is_a? String
+
+      submit_params['JobID'] = job_id
+
+      perform_request('/api/v1/admin/get-job-log', submit_params)
+    end
+
+    # AdminGetJobProperties
+    #
+    # Get properties of a single job.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] job_id Selected job ID
+    # @return [Comet::BackupJobDetail]
+    def admin_get_job_properties(job_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless job_id.is_a? String
+
+      submit_params['JobID'] = job_id
+
+      body = perform_request('/api/v1/admin/get-job-properties', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BackupJobDetail.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminGetJobsAll
+    #
+    # Get jobs (All).
+    # The jobs are returned in an unspecified order.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Array<Comet::BackupJobDetail>]
+    def admin_get_jobs_all
+      body = perform_request('/api/v1/admin/get-jobs-all')
+      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::BackupJobDetail.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminGetJobsForCustomSearch
+    #
+    # Get jobs (for custom search).
+    # The jobs are returned in an unspecified order.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [Comet::SearchClause] query (No description available)
+    # @return [Array<Comet::BackupJobDetail>]
+    def admin_get_jobs_for_custom_search(query)
+      submit_params = {}
+      raise TypeError 'expected Comet::SearchClause' unless query.is_a? Comet::SearchClause
+
+      submit_params['Query'] = query.to_json
+
+      body = perform_request('/api/v1/admin/get-jobs-for-custom-search', submit_params)
+      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::BackupJobDetail.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminGetJobsForDateRange
+    #
+    # Get jobs (for date range).
+    # The jobs are returned in an unspecified order.
+    #
+    # If the `Start` parameter is later than `End`, they will be swapped.
+    #
+    # This API will return all jobs that either started or ended within the supplied range.
+    #
+    # Incomplete jobs have an end time of `0`. You can use this API to find incomplete jobs by setting both `Start` and `End` to `0`.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [Number] start_value Timestamp (Unix)
+    # @param [Number] end_value Timestamp (Unix)
+    # @return [Array<Comet::BackupJobDetail>]
+    def admin_get_jobs_for_date_range(start_value, end_value)
+      submit_params = {}
+      submit_params['Start'] = start_value
+      submit_params['End'] = end_value
+
+      body = perform_request('/api/v1/admin/get-jobs-for-date-range', submit_params)
+      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::BackupJobDetail.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminGetJobsForUser
+    #
+    # Get jobs (for user).
+    # The jobs are returned in an unspecified order.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user Selected username
+    # @return [Array<Comet::BackupJobDetail>]
+    def admin_get_jobs_for_user(target_user)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/get-jobs-for-user', submit_params)
+      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::BackupJobDetail.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminGetJobsRecent
+    #
+    # Get jobs (Recent and incomplete).
+    # The jobs are returned in an unspecified order.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Array<Comet::BackupJobDetail>]
+    def admin_get_jobs_recent
+      body = perform_request('/api/v1/admin/get-jobs-recent')
+      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::BackupJobDetail.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminGetUserProfile
+    #
+    # Get user account profile.
+    #
+    # 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
+    # @return [Comet::UserProfileConfig]
+    def admin_get_user_profile(target_user)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/get-user-profile', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::UserProfileConfig.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminGetUserProfileAndHash
+    #
+    # Get user account profile (atomic).
+    # The resulting hash parameter can be passed to the corresponding update API, to atomically ensure that no changes occur between get/set operations.
+    # The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.
+    #
+    # 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
+    # @return [Comet::GetProfileAndHashResponseMessage]
+    def admin_get_user_profile_and_hash(target_user)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/get-user-profile-and-hash', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::GetProfileAndHashResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminGetUserProfileHash
+    #
+    # Get user account profile (hash).
+    # The profile hash can be used to determine if a user account profile has changed.
+    # The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.
+    #
+    # 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
+    # @return [Comet::GetProfileHashResponseMessage]
+    def admin_get_user_profile_hash(target_user)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+
+      body = perform_request('/api/v1/admin/get-user-profile-hash', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::GetProfileHashResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminJobCancel
+    #
+    # Cancel a running job.
+    # A request is sent to the live-connected device, asking it to cancel the operation. This may fail if there is no live-connection.
+    # Only jobs from Comet 18.3.5 or newer can be cancelled. A job can only be cancelled if it has a non-empty CancellationID field in its properties.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user Username
+    # @param [String] job_id Job ID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_job_cancel(target_user, job_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected string' unless job_id.is_a? String
+
+      submit_params['JobID'] = job_id
+
+      body = perform_request('/api/v1/admin/job/cancel', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminListUsers
+    #
+    # List all user accounts.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Array<String>]
+    def admin_list_users
+      body = perform_request('/api/v1/admin/list-users')
+      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|
+          raise TypeError 'expected string' unless v.is_a? String
+
+          ret[i] = v
+        end
+      end
+      ret
+    end
+
+    # AdminListUsersFull
+    #
+    # List all user account profiles.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => Comet::UserProfileConfig}]
+    def admin_list_users_full
+      body = perform_request('/api/v1/admin/list-users-full')
+      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::UserProfileConfig.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminMetaBrandingConfigGet
+    #
+    # Get Branding configuration.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Comet::ServerConfigOptionsBrandingFragment]
+    def admin_meta_branding_config_get
+      body = perform_request('/api/v1/admin/meta/branding-config/get')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ServerConfigOptionsBrandingFragment.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaBrandingConfigSet
+    #
+    # Set Branding configuration.
+    # Note that file resources must be provided using a resource URI I.E `"resource://05ba0b90ee66bda433169581188aba8d29faa938f9464cccd651a02fdf2e5b57"`. See AdminMetaResourceNew for the API documentation to create new file resources.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @param [Comet::BrandingOptions] branding_config Updated configuration content
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_branding_config_set(branding_config)
+      submit_params = {}
+      raise TypeError 'expected Comet::BrandingOptions' unless branding_config.is_a? Comet::BrandingOptions
+
+      submit_params['BrandingConfig'] = branding_config.to_json
+
+      body = perform_request('/api/v1/admin/meta/branding-config/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaBuildConfigGet
+    #
+    # Get Software Build Role configuration.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Comet::ServerConfigOptionsSoftwareBuildRoleFragment]
+    def admin_meta_build_config_get
+      body = perform_request('/api/v1/admin/meta/build-config/get')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ServerConfigOptionsSoftwareBuildRoleFragment.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaBuildConfigSet
+    #
+    # Set Build Role configuration.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @param [Comet::SoftwareBuildRoleOptions] software_build_role_config Updated configuration content
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_build_config_set(software_build_role_config)
+      submit_params = {}
+      raise TypeError 'expected Comet::SoftwareBuildRoleOptions' unless software_build_role_config.is_a? Comet::SoftwareBuildRoleOptions
+
+      submit_params['SoftwareBuildRoleConfig'] = software_build_role_config.to_json
+
+      body = perform_request('/api/v1/admin/meta/build-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.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Array<Number>]
+    def admin_meta_list_available_log_days
+      body = perform_request('/api/v1/admin/meta/list-available-log-days')
+      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] = v
+        end
+      end
+      ret
+    end
+
+    # AdminMetaReadLogs
+    #
+    # Get log 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.
+    #
+    # @param [Number] log A log day, selected from the options returned by the Get Log Files API
+    # @return [String]
+    def admin_meta_read_logs(log)
+      submit_params = {}
+      submit_params['Log'] = log
+
+      perform_request('/api/v1/admin/meta/read-logs', submit_params)
+    end
+
+    # AdminMetaRemoteStorageVaultGet
+    #
+    # Get Requesting Remote Storage Vault Config.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Array<Comet::RemoteStorageOption>]
+    def admin_meta_remote_storage_vault_get
+      body = perform_request('/api/v1/admin/meta/remote-storage-vault/get')
+      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::RemoteStorageOption.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminMetaRemoteStorageVaultSet
+    #
+    # Set Requestable Remote Storage Vault options.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @param [Array<Comet::RemoteStorageOption>] remote_storage_options Updated configuration content
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_remote_storage_vault_set(remote_storage_options)
+      submit_params = {}
+      raise TypeError 'expected array' unless remote_storage_options.is_a? Array
+
+      submit_params['RemoteStorageOptions'] = remote_storage_options.to_json
+
+      body = perform_request('/api/v1/admin/meta/remote-storage-vault/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaResourceGet
+    #
+    # Get a resource file.
+    # Resources are used to upload files within the server configuration.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] hash The resource identifier
+    # @return [String]
+    def admin_meta_resource_get(hash)
+      submit_params = {}
+      raise TypeError 'expected string' unless hash.is_a? String
+
+      submit_params['Hash'] = hash
+
+      perform_request('/api/v1/admin/meta/resource/get', submit_params)
+    end
+
+    # AdminMetaRestartService
+    #
+    # Restart server.
+    # The Comet Server process will exit. The service manager should restart the server automatically.
+    #
+    # 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.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_restart_service
+      body = perform_request('/api/v1/admin/meta/restart-service')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaSendTestEmail
+    #
+    # Send a test email message.
+    # 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.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @param [Comet::EmailOptions] email_options Updated configuration content
+    # @param [String] recipient Target email address to send test email
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_send_test_email(email_options, recipient)
+      submit_params = {}
+      raise TypeError 'expected Comet::EmailOptions' unless email_options.is_a? Comet::EmailOptions
+
+      submit_params['EmailOptions'] = email_options.to_json
+      raise TypeError 'expected string' unless recipient.is_a? String
+
+      submit_params['Recipient'] = recipient
+
+      body = perform_request('/api/v1/admin/meta/send-test-email', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaServerConfigGet
+    #
+    # Get server configuration.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Comet::ServerConfigOptions]
+    def admin_meta_server_config_get
+      body = perform_request('/api/v1/admin/meta/server-config/get')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ServerConfigOptions.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaServerConfigNetworkInterfaces
+    #
+    # List the available network interfaces on the PC running Comet Server.
+    # Any IPv6 addresses are listed in compressed form without square-brackets.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Array<String>]
+    def admin_meta_server_config_network_interfaces
+      body = perform_request('/api/v1/admin/meta/server-config/network-interfaces')
+      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|
+          raise TypeError 'expected string' unless v.is_a? String
+
+          ret[i] = v
+        end
+      end
+      ret
+    end
+
+    # AdminMetaServerConfigSet
+    #
+    # Set server configuration.
+    # The Comet Server process will exit. The service manager should restart the server automatically.
+    #
+    # 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.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @param [Comet::ServerConfigOptions] config Updated configuration content
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_server_config_set(config)
+      submit_params = {}
+      raise TypeError 'expected Comet::ServerConfigOptions' unless config.is_a? Comet::ServerConfigOptions
+
+      submit_params['Config'] = config.to_json
+
+      body = perform_request('/api/v1/admin/meta/server-config/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaShutdownService
+    #
+    # Shut down server.
+    # The Comet Server process will exit.
+    #
+    # 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.
+    # Access to this API may be prevented on a per-administrator basis.
+    #
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_shutdown_service
+      body = perform_request('/api/v1/admin/meta/shutdown-service')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaSoftwareUpdateNews
+    #
+    # Get software update news from the software provider.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Comet::SoftwareUpdateNewsResponse]
+    def admin_meta_software_update_news
+      body = perform_request('/api/v1/admin/meta/software-update-news')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::SoftwareUpdateNewsResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaStats
+    #
+    # Get Comet Server historical statistics.
+    # The returned key-value map is not necessarily ordered. Client-side code should sort the result before display.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [Boolean] simple Remove redundant statistics
+    # @return [Hash{Number => Comet::StatResult}]
+    def admin_meta_stats(simple)
+      submit_params = {}
+      submit_params['Simple'] = (simple ? 1 : 0)
+
+      body = perform_request('/api/v1/admin/meta/stats', submit_params)
+      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::StatResult.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminMetaVersion
+    #
+    # Get server properties.
+    # Retrieve the version number and basic properties about the server.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Comet::ServerMetaVersionInfo]
+    def admin_meta_version
+      body = perform_request('/api/v1/admin/meta/version')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::ServerMetaVersionInfo.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminMetaWebhookOptionsGet
+    #
+    # Get the server webhook configuration.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Hash{String => Comet::WebhookOption}]
+    def admin_meta_webhook_options_get
+      body = perform_request('/api/v1/admin/meta/webhook-options/get')
+      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::WebhookOption.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminMetaWebhookOptionsSet
+    #
+    # Update the server webhook configuration.
+    # Calling this endpoint will interrupt any messages currently queued for existing webhook destinations.
+    #
+    # 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.
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_meta_webhook_options_set(webhook_options)
+      submit_params = {}
+      raise TypeError 'expected hash' unless webhook_options.is_a? Hash
+
+      submit_params['WebhookOptions'] = webhook_options.to_json
+
+      body = perform_request('/api/v1/admin/meta/webhook-options/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminNewsGetAll
+    #
+    # Get News entries (Admin).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => Comet::NewsEntry}]
+    def admin_news_get_all
+      body = perform_request('/api/v1/admin/news/get-all')
+      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::NewsEntry.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminNewsRemove
+    #
+    # Remove news item.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] news_item Selected news item GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_news_remove(news_item)
+      submit_params = {}
+      raise TypeError 'expected string' unless news_item.is_a? String
+
+      submit_params['NewsItem'] = news_item
+
+      body = perform_request('/api/v1/admin/news/remove', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminNewsSubmit
+    #
+    # Submit news item.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] news_content Content of news item
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_news_submit(news_content)
+      submit_params = {}
+      raise TypeError 'expected string' unless news_content.is_a? String
+
+      submit_params['NewsContent'] = news_content
+
+      body = perform_request('/api/v1/admin/news/submit', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminPoliciesDelete
+    #
+    # Delete an existing policy object.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] policy_id The policy ID to update or create
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_policies_delete(policy_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless policy_id.is_a? String
+
+      submit_params['PolicyID'] = policy_id
+
+      body = perform_request('/api/v1/admin/policies/delete', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminPoliciesGet
+    #
+    # Retrieve a single policy object.
+    # A hash is also returned, to allow atomic modification operations.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] policy_id The policy ID to retrieve
+    # @return [Comet::GetGroupPolicyResponse]
+    def admin_policies_get(policy_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless policy_id.is_a? String
+
+      submit_params['PolicyID'] = policy_id
+
+      body = perform_request('/api/v1/admin/policies/get', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::GetGroupPolicyResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminPoliciesList
+    #
+    # List all policy object names.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => String}]
+    def admin_policies_list
+      body = perform_request('/api/v1/admin/policies/list')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = {}
+      if json_body.nil?
+        ret = {}
+      else
+        json_body.each do |k, v|
+          raise TypeError 'expected string' unless v.is_a? String
+
+          ret[k] = v
+        end
+      end
+      ret
+    end
+
+    # AdminPoliciesListFull
+    #
+    # Get all policy objects.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => Comet::GroupPolicy}]
+    def admin_policies_list_full
+      body = perform_request('/api/v1/admin/policies/list-full')
+      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::GroupPolicy.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminPoliciesNew
+    #
+    # Create a new policy object.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [Comet::GroupPolicy] policy The policy data
+    # @return [Comet::CreateGroupPolicyResponse]
+    def admin_policies_new(policy)
+      submit_params = {}
+      raise TypeError 'expected Comet::GroupPolicy' unless policy.is_a? Comet::GroupPolicy
+
+      submit_params['Policy'] = policy.to_json
+
+      body = perform_request('/api/v1/admin/policies/new', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CreateGroupPolicyResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminPoliciesSet
+    #
+    # Update an existing policy object.
+    # An optional hash may be used, to ensure the modification was atomic.
+    # This API can also be used to create a new policy object with a specific hash.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] policy_id The policy ID to update or create
+    # @param [Comet::GroupPolicy] policy The policy data
+    # @param [String] check_policy_hash (Optional) An atomic verification hash as supplied by the AdminPoliciesGet API
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_policies_set(policy_id, policy, check_policy_hash = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless policy_id.is_a? String
+
+      submit_params['PolicyID'] = policy_id
+      raise TypeError 'expected Comet::GroupPolicy' unless policy.is_a? Comet::GroupPolicy
+
+      submit_params['Policy'] = policy.to_json
+      unless check_policy_hash.nil?
+        raise TypeError 'expected string' unless check_policy_hash.is_a? String
+
+        submit_params['CheckPolicyHash'] = check_policy_hash
+      end
+
+      body = perform_request('/api/v1/admin/policies/set', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminPreviewUserEmailReport
+    #
+    # Preview an email report for a customer.
+    #
+    # 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 [Comet::EmailReportConfig] email_report_config Email report configuration to preview
+    # @param [String] email_address (Optional) Email address that may be included in the report body (>= 20.3.3)
+    # @return [Comet::EmailReportGeneratedPreview]
+    def admin_preview_user_email_report(target_user, email_report_config, email_address = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected Comet::EmailReportConfig' unless email_report_config.is_a? Comet::EmailReportConfig
+
+      submit_params['EmailReportConfig'] = email_report_config.to_json
+      unless email_address.nil?
+        raise TypeError 'expected string' unless email_address.is_a? String
+
+        submit_params['EmailAddress'] = email_address
+      end
+
+      body = perform_request('/api/v1/admin/preview-user-email-report', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::EmailReportGeneratedPreview.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminReplicationState
+    #
+    # Get Replication status.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @return [Array<Comet::ReplicatorStateAPIResponse>]
+    def admin_replication_state
+      body = perform_request('/api/v1/admin/replication/state')
+      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::ReplicatorStateAPIResponse.new
+          ret[i].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminRequestStorageVault
+    #
+    # Request a new Storage Vault on behalf of a user.
+    # This action does not respect the "Prevent creating new Storage Vaults (via Request)" policy setting. New Storage Vaults can be requested regardless of the policy setting.
+    # Prior to Comet 19.8.0, the response type was CometAPIResponseMessage (i.e. no DestinationID field in response).
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user The user to receive the new Storage Vault
+    # @param [String] storage_provider ID for the Requestable destination
+    # @param [String] self_address (Optional) The external URL for this server. Used to resolve conflicts
+    # @return [Comet::RequestStorageVaultResponseMessage]
+    def admin_request_storage_vault(target_user, storage_provider, self_address = nil)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected string' unless storage_provider.is_a? String
+
+      submit_params['StorageProvider'] = storage_provider
+      if self_address.nil?
+        submit_params['SelfAddress'] = @server_address
+      else
+        raise TypeError 'expected string' unless self_address.is_a? String
+
+        submit_params['SelfAddress'] = self_address
+      end
+
+      body = perform_request('/api/v1/admin/request-storage-vault', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::RequestStorageVaultResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminRequestStorageVaultProviders
+    #
+    # Get the available options for Requesting a Storage Vault.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => String}]
+    def admin_request_storage_vault_providers
+      body = perform_request('/api/v1/admin/request-storage-vault-providers')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = {}
+      if json_body.nil?
+        ret = {}
+      else
+        json_body.each do |k, v|
+          raise TypeError 'expected string' unless v.is_a? String
+
+          ret[k] = v
+        end
+      end
+      ret
+    end
+
+    # AdminResetUserPassword
+    #
+    # Reset user account password.
+    # The user account must have a recovery code present. A new replacement recovery code will be generated automatically.
+    #
+    # 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] new_password New account password
+    # @param [String] old_password Old account password (optional)
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_reset_user_password(target_user, new_password, old_password)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected string' unless new_password.is_a? String
+
+      submit_params['NewPassword'] = new_password
+      raise TypeError 'expected string' unless old_password.is_a? String
+
+      submit_params['OldPassword'] = old_password
+
+      body = perform_request('/api/v1/admin/reset-user-password', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminRevokeDevice
+    #
+    # Revoke device from user account.
+    # It's possible to simply remove the Device section from the user's profile, however, using this dedicated API will also gracefully handle live connections.
+    #
+    # 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_device Selected Device ID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_revoke_device(target_user, target_device)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected string' unless target_device.is_a? String
+
+      submit_params['TargetDevice'] = target_device
+
+      body = perform_request('/api/v1/admin/revoke-device', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminSetUserProfile
+    #
+    # Modify user account profile.
+    #
+    # 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 [Comet::UserProfileConfig] profile_data Modified user profile
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_set_user_profile(target_user, profile_data)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected Comet::UserProfileConfig' unless profile_data.is_a? Comet::UserProfileConfig
+
+      submit_params['ProfileData'] = profile_data.to_json
+
+      body = perform_request('/api/v1/admin/set-user-profile', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminSetUserProfileHash
+    #
+    # Modify user account profile (atomic).
+    # The hash parameter can be determined from the corresponding API, to atomically ensure that no changes occur between get/set operations.
+    # The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.
+    #
+    # 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 [Comet::UserProfileConfig] profile_data Modified user profile
+    # @param [String] require_hash Previous hash parameter
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_set_user_profile_hash(target_user, profile_data, require_hash)
+      submit_params = {}
+      raise TypeError 'expected string' unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError 'expected Comet::UserProfileConfig' unless profile_data.is_a? Comet::UserProfileConfig
+
+      submit_params['ProfileData'] = profile_data.to_json
+      raise TypeError 'expected string' unless require_hash.is_a? String
+
+      submit_params['RequireHash'] = require_hash
+
+      body = perform_request('/api/v1/admin/set-user-profile-hash', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminStorageDeleteBucket
+    #
+    # Delete a bucket.
+    # All data will be removed from the server. Misuse can cause data loss!
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Storage Role to be enabled.
+    #
+    # @param [String] bucket_id Selected bucket name
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_storage_delete_bucket(bucket_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless bucket_id.is_a? String
+
+      submit_params['BucketID'] = bucket_id
+
+      body = perform_request('/api/v1/admin/storage/delete-bucket', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminStorageFreeSpace
+    #
+    # Retrieve available space metrics.
+    #
+    # 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.
+    #
+    # @param [String] bucket_id Selected bucket name
+    # @return [Comet::StorageFreeSpaceInfo]
+    def admin_storage_free_space(bucket_id)
+      submit_params = {}
+      raise TypeError 'expected string' unless bucket_id.is_a? String
+
+      submit_params['BucketID'] = bucket_id
+
+      body = perform_request('/api/v1/admin/storage/free-space', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::StorageFreeSpaceInfo.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminStorageListBuckets
+    #
+    # List all buckets.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Storage Role to be enabled.
+    #
+    # @return [Hash{String => Comet::BucketProperties}]
+    def admin_storage_list_buckets
+      body = perform_request('/api/v1/admin/storage/list-buckets')
+      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::BucketProperties.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminStorageRegisterBucket
+    #
+    # Create a new bucket.
+    # Leave the Set* parameters blank to generate a bucket with random credentials, or, supply a pre-hashed password for zero-knowledge operations.
+    # Any auto-generated credentials are returned in the response message.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Storage Role to be enabled.
+    #
+    # @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
+    # @return [Comet::AddBucketResponseMessage]
+    def admin_storage_register_bucket(set_bucket_value = nil, set_key_hash_format = nil, set_key_hash_value = nil)
+      submit_params = {}
+      unless set_bucket_value.nil?
+        raise TypeError 'expected string' unless set_bucket_value.is_a? String
+
+        submit_params['SetBucketValue'] = set_bucket_value
+      end
+      unless set_key_hash_format.nil?
+        raise TypeError 'expected string' unless set_key_hash_format.is_a? String
+
+        submit_params['SetKeyHashFormat'] = set_key_hash_format
+      end
+      unless set_key_hash_value.nil?
+        raise TypeError 'expected string' unless set_key_hash_value.is_a? String
+
+        submit_params['SetKeyHashValue'] = set_key_hash_value
+      end
+
+      body = perform_request('/api/v1/admin/storage/register-bucket', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::AddBucketResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminUpdateCampaignStart
+    #
+    # Start a new software update campaign.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [Comet::UpdateCampaignOptions] options Configure targets for the software update campaign
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_update_campaign_start(options)
+      submit_params = {}
+      raise TypeError 'expected Comet::UpdateCampaignOptions' unless options.is_a? Comet::UpdateCampaignOptions
+
+      submit_params['Options'] = options.to_json
+
+      body = perform_request('/api/v1/admin/update-campaign/start', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminUpdateCampaignStatus
+    #
+    # Get current campaign status.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Software Build Role to be enabled.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Comet::UpdateCampaignStatus]
+    def admin_update_campaign_status
+      body = perform_request('/api/v1/admin/update-campaign/status')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::UpdateCampaignStatus.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # HybridSessionStart
+    #
+    # Generate a session key (log in).
+    # This hybrid API allows you to log in to the Comet Server as either an administrator or end-user account.
+    # This API behaves like either AdminAccountSessionStart or UserWebSessionStart, depending on what the supplied credentials were valid for.
+    #
+    # @return [Comet::SessionKeyRegeneratedResponse]
+    def hybrid_session_start
+      body = perform_request('/api/v1/hybrid/session/start')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::SessionKeyRegeneratedResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # UserWebSessionRevoke
+    #
+    # Revoke a session key (log out).
+    #
+    # You must supply user authentication credentials to use this API, and the user account must be authorized for web access.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Comet::CometAPIResponseMessage]
+    def user_web_session_revoke
+      body = perform_request('/api/v1/user/web/session/revoke')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # UserWebSessionStart
+    #
+    # Generate a session key (log in).
+    #
+    # You must supply user authentication credentials to use this API, and the user account must be authorized for web access.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Comet::SessionKeyRegeneratedResponse]
+    def user_web_session_start
+      body = perform_request('/api/v1/user/web/session/start')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::SessionKeyRegeneratedResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # If the supplied object represents an unsuccessful CometAPIResponseMessage, raise
+    # it as an error.
+    #
+    # @param [Hash] obj
+    def check_status(obj)
+      return unless obj.is_a? Hash
+      return unless obj.key?('Status')
+      return unless obj.key?('Message')
+      return unless obj['Status'] != 200 && obj['Status'] != 201
+
+      ret_error = Comet::CometAPIResponseMessage.new
+      ret_error.from_hash(obj)
+      raise Comet::APIResponseError.new(ret_error)
+    end
+
+    # Perform a synchronous HTTP request.
+    #
+    # @param [String] endpoint The URL suffix
+    # @param [Hash<String,String>] params Form post parameters to submit to the target API
+    # @return [String] Response body
+    def perform_request(endpoint, params = {})
+      full_uri = URI(@server_address + endpoint)
+      params['Username'] = @username
+      params['AuthType'] = 'Password'
+      params['Password'] = @password
+
+      res = Net::HTTP.post_form(full_uri, params)
+      unless res.is_a?(Net::HTTPSuccess)
+        raise res
+      end
+
+      res.body
+    end
+  end
+
+end