comet_backup_ruby_sdk 0.2.0

data/lib/comet/models/protected_item_engine_type_policy.rb

@@ -0,0 +1,84 @@
+#!/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 'json'
+
+module Comet
+
+  # ProtectedItemEngineTypePolicy is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProtectedItemEngineTypePolicy
+
+    # @type [Boolean] should_restrict_engine_type_list
+    attr_accessor :should_restrict_engine_type_list
+
+    # @type [Array<String>] allowed_engine_type_when_restricted
+    attr_accessor :allowed_engine_type_when_restricted
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @allowed_engine_type_when_restricted = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'ShouldRestrictEngineTypeList'
+          @should_restrict_engine_type_list = v
+        when 'AllowedEngineTypeWhenRestricted'
+          if v.nil?
+            @allowed_engine_type_when_restricted = []
+          else
+            @allowed_engine_type_when_restricted = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError 'expected string' unless v1.is_a? String
+
+              @allowed_engine_type_when_restricted[i1] = v1
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ShouldRestrictEngineTypeList'] = @should_restrict_engine_type_list
+      ret['AllowedEngineTypeWhenRestricted'] = @allowed_engine_type_when_restricted
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/public_branding_properties.rb

@@ -0,0 +1,122 @@
+#!/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 'json'
+
+module Comet
+
+  # PublicBrandingProperties is a typed class wrapper around the underlying Comet Server API data structure.
+  class PublicBrandingProperties
+
+    # @type [String] product_name
+    attr_accessor :product_name
+
+    # @type [String] company_name
+    attr_accessor :company_name
+
+    # @type [String] help_url
+    attr_accessor :help_url
+
+    # @type [Boolean] help_is_popup
+    attr_accessor :help_is_popup
+
+    # @type [String] default_login_server_url
+    attr_accessor :default_login_server_url
+
+    # @type [String] tile_background_color
+    attr_accessor :tile_background_color
+
+    # @type [String] account_register_url
+    attr_accessor :account_register_url
+
+    # @type [Boolean] hide_background_logo
+    attr_accessor :hide_background_logo
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'ProductName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @product_name = v
+        when 'CompanyName'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @company_name = v
+        when 'HelpURL'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @help_url = v
+        when 'HelpIsPopup'
+          @help_is_popup = v
+        when 'DefaultLoginServerURL'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @default_login_server_url = v
+        when 'TileBackgroundColor'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @tile_background_color = v
+        when 'AccountRegisterURL'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @account_register_url = v
+        when 'HideBackgroundLogo'
+          @hide_background_logo = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['ProductName'] = @product_name
+      ret['CompanyName'] = @company_name
+      ret['HelpURL'] = @help_url
+      ret['HelpIsPopup'] = @help_is_popup
+      ret['DefaultLoginServerURL'] = @default_login_server_url
+      ret['TileBackgroundColor'] = @tile_background_color
+      ret['AccountRegisterURL'] = @account_register_url
+      ret['HideBackgroundLogo'] = @hide_background_logo
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/remote_server_address.rb

@@ -0,0 +1,135 @@
+#!/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 'json'
+
+module Comet
+
+  # RemoteServerAddress is a typed class wrapper around the underlying Comet Server API data structure.
+  class RemoteServerAddress
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [String] remote_address
+    attr_accessor :remote_address
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] password
+    attr_accessor :password
+
+    # @type [Comet::ExternalLDAPAuthenticationSourceSettings] ldap
+    attr_accessor :ldap
+
+    # @type [Comet::B2VirtualStorageRoleSettings] b2
+    attr_accessor :b2
+
+    # @type [Comet::WasabiVirtualStorageRoleSettings] wasabi
+    attr_accessor :wasabi
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Type'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @type = v
+        when 'Description'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @description = v
+        when 'RemoteAddress'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @remote_address = v
+        when 'Username'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @username = v
+        when 'Password'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @password = v
+        when 'LDAP'
+          @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+          @ldap.from_hash(v)
+        when 'B2'
+          @b2 = Comet::B2VirtualStorageRoleSettings.new
+          @b2.from_hash(v)
+        when 'Wasabi'
+          @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
+          @wasabi.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Type'] = @type
+      ret['Description'] = @description
+      unless @remote_address.nil?
+        ret['RemoteAddress'] = @remote_address
+      end
+      unless @username.nil?
+        ret['Username'] = @username
+      end
+      unless @password.nil?
+        ret['Password'] = @password
+      end
+      unless @ldap.nil?
+        ret['LDAP'] = @ldap
+      end
+      unless @b2.nil?
+        ret['B2'] = @b2
+      end
+      unless @wasabi.nil?
+        ret['Wasabi'] = @wasabi
+      end
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/remote_storage_option.rb

@@ -0,0 +1,147 @@
+#!/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 'json'
+
+module Comet
+
+  # RemoteStorageOption is a typed class wrapper around the underlying Comet Server API data structure.
+  class RemoteStorageOption
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [String] remote_address
+    attr_accessor :remote_address
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] password
+    attr_accessor :password
+
+    # @type [Comet::ExternalLDAPAuthenticationSourceSettings] ldap
+    attr_accessor :ldap
+
+    # @type [Comet::B2VirtualStorageRoleSettings] b2
+    attr_accessor :b2
+
+    # @type [Comet::WasabiVirtualStorageRoleSettings] wasabi
+    attr_accessor :wasabi
+
+    # @type [Boolean] storage_limit_enabled
+    attr_accessor :storage_limit_enabled
+
+    # @type [Number] storage_limit_bytes
+    attr_accessor :storage_limit_bytes
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Type'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @type = v
+        when 'Description'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @description = v
+        when 'RemoteAddress'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @remote_address = v
+        when 'Username'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @username = v
+        when 'Password'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @password = v
+        when 'LDAP'
+          @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
+          @ldap.from_hash(v)
+        when 'B2'
+          @b2 = Comet::B2VirtualStorageRoleSettings.new
+          @b2.from_hash(v)
+        when 'Wasabi'
+          @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
+          @wasabi.from_hash(v)
+        when 'StorageLimitEnabled'
+          @storage_limit_enabled = v
+        when 'StorageLimitBytes'
+          @storage_limit_bytes = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Type'] = @type
+      ret['Description'] = @description
+      unless @remote_address.nil?
+        ret['RemoteAddress'] = @remote_address
+      end
+      unless @username.nil?
+        ret['Username'] = @username
+      end
+      unless @password.nil?
+        ret['Password'] = @password
+      end
+      unless @ldap.nil?
+        ret['LDAP'] = @ldap
+      end
+      unless @b2.nil?
+        ret['B2'] = @b2
+      end
+      unless @wasabi.nil?
+        ret['Wasabi'] = @wasabi
+      end
+      ret['StorageLimitEnabled'] = @storage_limit_enabled
+      ret['StorageLimitBytes'] = @storage_limit_bytes
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end