comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/add_bucket_response_message.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AddBucketResponseMessage is a typed class wrapper around the underlying Comet Server API data structure.
+  class AddBucketResponseMessage
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [String] new_bucket_id
+    attr_accessor :new_bucket_id
+
+    # @type [String] new_bucket_key
+    attr_accessor :new_bucket_key
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @new_bucket_id = ''
+      @new_bucket_key = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" 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, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'NewBucketID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @new_bucket_id = v
+        when 'NewBucketKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @new_bucket_key = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['NewBucketID'] = @new_bucket_id
+      ret['NewBucketKey'] = @new_bucket_key
+      @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/models/admin_account_properties_response.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AdminAccountPropertiesResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminAccountPropertiesResponse
+
+    # @type [String] organization_id
+    attr_accessor :organization_id
+
+    # @type [Comet::AdminUserPermissions] permissions
+    attr_accessor :permissions
+
+    # @type [Comet::AdminSecurityOptions] security
+    attr_accessor :security
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @organization_id = ''
+      @permissions = Comet::AdminUserPermissions.new
+      @security = Comet::AdminSecurityOptions.new
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" 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, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'OrganizationID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @organization_id = v
+        when 'Permissions'
+          @permissions = Comet::AdminUserPermissions.new
+          @permissions.from_hash(v)
+        when 'Security'
+          @security = Comet::AdminSecurityOptions.new
+          @security.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['OrganizationID'] = @organization_id
+      ret['Permissions'] = @permissions
+      ret['Security'] = @security
+      @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/models/admin_email_options.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AdminEmailOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminEmailOptions
+
+    # @type [String] from_email
+    attr_accessor :from_email
+
+    # @type [String] from_name
+    attr_accessor :from_name
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @from_email = ''
+      @from_name = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" 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, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'FromEmail'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @from_email = v
+        when 'FromName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @from_name = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['FromEmail'] = @from_email
+      ret['FromName'] = @from_name
+      @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/models/admin_resource_response.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AdminResourceResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminResourceResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [String] resource_hash
+    attr_accessor :resource_hash
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @resource_hash = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" 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, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'ResourceHash'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @resource_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['Status'] = @status
+      ret['Message'] = @message
+      ret['ResourceHash'] = @resource_hash
+      @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/models/admin_security_options.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AdminSecurityOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminSecurityOptions
+
+    # @type [Number] password_format
+    attr_accessor :password_format
+
+    # @type [String] password
+    attr_accessor :password
+
+    # @type [Boolean] allow_password_login
+    attr_accessor :allow_password_login
+
+    # @type [Boolean] allow_password_and_totplogin
+    attr_accessor :allow_password_and_totplogin
+
+    # @type [Boolean] allow_password_and_u2flogin
+    # @deprecated This member has been deprecated since Comet version 21.12.0
+    attr_accessor :allow_password_and_u2flogin
+
+    # @type [Boolean] allow_password_and_web_authn_login
+    attr_accessor :allow_password_and_web_authn_login
+
+    # @type [Array<Comet::AdminU2FRegistration>] u2fregistrations
+    # @deprecated This member has been deprecated since Comet version 21.12.0
+    attr_accessor :u2fregistrations
+
+    # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
+    attr_accessor :web_authn_registrations
+
+    # @type [Number] totpkey_encryption_format
+    attr_accessor :totpkey_encryption_format
+
+    # @type [String] totpkey
+    attr_accessor :totpkey
+
+    # @type [String] ipwhitelist
+    attr_accessor :ipwhitelist
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @password_format = 0
+      @password = ''
+      @u2fregistrations = []
+      @web_authn_registrations = []
+      @totpkey_encryption_format = 0
+      @totpkey = ''
+      @ipwhitelist = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" 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, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'PasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @password_format = v
+        when 'Password'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @password = v
+        when 'AllowPasswordLogin'
+          @allow_password_login = v
+        when 'AllowPasswordAndTOTPLogin'
+          @allow_password_and_totplogin = v
+        when 'AllowPasswordAndU2FLogin'
+          @allow_password_and_u2flogin = v
+        when 'AllowPasswordAndWebAuthnLogin'
+          @allow_password_and_web_authn_login = v
+        when 'U2FRegistrations'
+          if v.nil?
+            @u2fregistrations = []
+          else
+            @u2fregistrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @u2fregistrations[i1] = Comet::AdminU2FRegistration.new
+              @u2fregistrations[i1].from_hash(v1)
+            end
+          end
+        when 'WebAuthnRegistrations'
+          if v.nil?
+            @web_authn_registrations = []
+          else
+            @web_authn_registrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @web_authn_registrations[i1] = Comet::AdminWebAuthnRegistration.new
+              @web_authn_registrations[i1].from_hash(v1)
+            end
+          end
+        when 'TOTPKeyEncryptionFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @totpkey_encryption_format = v
+        when 'TOTPKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @totpkey = v
+        when 'IPWhitelist'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @ipwhitelist = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['PasswordFormat'] = @password_format
+      ret['Password'] = @password
+      ret['AllowPasswordLogin'] = @allow_password_login
+      ret['AllowPasswordAndTOTPLogin'] = @allow_password_and_totplogin
+      ret['AllowPasswordAndU2FLogin'] = @allow_password_and_u2flogin
+      ret['AllowPasswordAndWebAuthnLogin'] = @allow_password_and_web_authn_login
+      unless @u2fregistrations.nil?
+        ret['U2FRegistrations'] = @u2fregistrations
+      end
+      unless @web_authn_registrations.nil?
+        ret['WebAuthnRegistrations'] = @web_authn_registrations
+      end
+      unless @totpkey_encryption_format.nil?
+        ret['TOTPKeyEncryptionFormat'] = @totpkey_encryption_format
+      end
+      unless @totpkey.nil?
+        ret['TOTPKey'] = @totpkey
+      end
+      unless @ipwhitelist.nil?
+        ret['IPWhitelist'] = @ipwhitelist
+      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/models/admin_u2fregistration.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+
+module Comet
+
+  # AdminU2FRegistration is a typed class wrapper around the underlying Comet Server API data structure.
+  # @deprecated This type has been deprecated since Comet version 21.12.0
+  class AdminU2FRegistration
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [Number] register_time
+    attr_accessor :register_time
+
+    # @type [Array<Object>] registration
+    attr_accessor :registration
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @description = ''
+      @register_time = 0
+      @registration = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" 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, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'RegisterTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @register_time = v
+        when 'Registration'
+          @registration = Base64.decode64(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Description'] = @description
+      ret['RegisterTime'] = @register_time
+      ret['Registration'] = Base64.strict_encode64(@registration)
+      @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