comet_backup_ruby_sdk 1.10.0 → 1.11.0

data/lib/comet/models/web_authn_credential_descriptor.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 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
+
+  # WebAuthnCredentialDescriptor is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnCredentialDescriptor
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [Array<Object>] credential_id
+    attr_accessor :credential_id
+
+    # @type [Array<String>] transport
+    attr_accessor :transport
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @type = ''
+      @credential_id = []
+      @transport = []
+      @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 'type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'id'
+          @credential_id = Base64.decode64(v)
+        when 'transports'
+          if v.nil?
+            @transport = []
+          else
+            @transport = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @transport[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['type'] = @type
+      ret['id'] = Base64.strict_encode64(@credential_id)
+      unless @transport.nil?
+        ret['transports'] = @transport
+      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/web_authn_credential_entity.rb

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

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # WebAuthnCredentialParameter is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnCredentialParameter
+
+    # @type [String] type
+    attr_accessor :type
+
+    # @type [Number] algorithm
+    attr_accessor :algorithm
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @type = ''
+      @algorithm = 0
+      @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 'type'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @type = v
+        when 'alg'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @algorithm = 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['alg'] = @algorithm
+      @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/web_authn_public_key_credential_creation_options.rb

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 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
+
+  # WebAuthnPublicKeyCredentialCreationOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnPublicKeyCredentialCreationOptions
+
+    # @type [Array<Object>] challenge
+    attr_accessor :challenge
+
+    # @type [Comet::WebAuthnRelyingPartyEntity] relying_party
+    attr_accessor :relying_party
+
+    # @type [Comet::WebAuthnUserEntity] user
+    attr_accessor :user
+
+    # @type [Array<Comet::WebAuthnCredentialParameter>] parameters
+    attr_accessor :parameters
+
+    # @type [Comet::WebAuthnAuthenticatorSelection] authenticator_selection
+    attr_accessor :authenticator_selection
+
+    # @type [Number] timeout
+    attr_accessor :timeout
+
+    # @type [Array<Comet::WebAuthnCredentialDescriptor>] credential_exclude_list
+    attr_accessor :credential_exclude_list
+
+    # @type [Hash{String => Comet::interface}] extensions
+    attr_accessor :extensions
+
+    # @type [String] attestation
+    attr_accessor :attestation
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @challenge = []
+      @relying_party = Comet::WebAuthnRelyingPartyEntity.new
+      @user = Comet::WebAuthnUserEntity.new
+      @parameters = []
+      @authenticator_selection = Comet::WebAuthnAuthenticatorSelection.new
+      @timeout = 0
+      @credential_exclude_list = []
+      @extensions = {}
+      @attestation = ''
+      @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 'challenge'
+          @challenge = Base64.decode64(v)
+        when 'rp'
+          @relying_party = Comet::WebAuthnRelyingPartyEntity.new
+          @relying_party.from_hash(v)
+        when 'user'
+          @user = Comet::WebAuthnUserEntity.new
+          @user.from_hash(v)
+        when 'pubKeyCredParams'
+          if v.nil?
+            @parameters = []
+          else
+            @parameters = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @parameters[i1] = Comet::WebAuthnCredentialParameter.new
+              @parameters[i1].from_hash(v1)
+            end
+          end
+        when 'authenticatorSelection'
+          @authenticator_selection = Comet::WebAuthnAuthenticatorSelection.new
+          @authenticator_selection.from_hash(v)
+        when 'timeout'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @timeout = v
+        when 'excludeCredentials'
+          if v.nil?
+            @credential_exclude_list = []
+          else
+            @credential_exclude_list = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @credential_exclude_list[i1] = Comet::WebAuthnCredentialDescriptor.new
+              @credential_exclude_list[i1].from_hash(v1)
+            end
+          end
+        when 'extensions'
+          @extensions = {}
+          if v.nil?
+            @extensions = {}
+          else
+            v.each do |k1, v1|
+              @extensions[k1] = Comet::interface.new
+              @extensions[k1].from_hash(v1)
+            end
+          end
+        when 'attestation'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @attestation = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['challenge'] = Base64.strict_encode64(@challenge)
+      ret['rp'] = @relying_party
+      ret['user'] = @user
+      unless @parameters.nil?
+        ret['pubKeyCredParams'] = @parameters
+      end
+      unless @authenticator_selection.nil?
+        ret['authenticatorSelection'] = @authenticator_selection
+      end
+      unless @timeout.nil?
+        ret['timeout'] = @timeout
+      end
+      unless @credential_exclude_list.nil?
+        ret['excludeCredentials'] = @credential_exclude_list
+      end
+      unless @extensions.nil?
+        ret['extensions'] = @extensions
+      end
+      unless @attestation.nil?
+        ret['attestation'] = @attestation
+      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/web_authn_public_key_credential_request_options.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 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
+
+  # WebAuthnPublicKeyCredentialRequestOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnPublicKeyCredentialRequestOptions
+
+    # @type [Array<Object>] challenge
+    attr_accessor :challenge
+
+    # @type [Number] timeout
+    attr_accessor :timeout
+
+    # @type [String] relying_party_id
+    attr_accessor :relying_party_id
+
+    # @type [Array<Comet::WebAuthnCredentialDescriptor>] allowed_credentials
+    attr_accessor :allowed_credentials
+
+    # @type [String] user_verification
+    attr_accessor :user_verification
+
+    # @type [Hash{String => Comet::interface}] extensions
+    attr_accessor :extensions
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @challenge = []
+      @timeout = 0
+      @relying_party_id = ''
+      @allowed_credentials = []
+      @user_verification = ''
+      @extensions = {}
+      @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 'challenge'
+          @challenge = Base64.decode64(v)
+        when 'timeout'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @timeout = v
+        when 'rpId'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @relying_party_id = v
+        when 'allowCredentials'
+          if v.nil?
+            @allowed_credentials = []
+          else
+            @allowed_credentials = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @allowed_credentials[i1] = Comet::WebAuthnCredentialDescriptor.new
+              @allowed_credentials[i1].from_hash(v1)
+            end
+          end
+        when 'userVerification'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @user_verification = v
+        when 'extensions'
+          @extensions = {}
+          if v.nil?
+            @extensions = {}
+          else
+            v.each do |k1, v1|
+              @extensions[k1] = Comet::interface.new
+              @extensions[k1].from_hash(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['challenge'] = Base64.strict_encode64(@challenge)
+      unless @timeout.nil?
+        ret['timeout'] = @timeout
+      end
+      unless @relying_party_id.nil?
+        ret['rpId'] = @relying_party_id
+      end
+      unless @allowed_credentials.nil?
+        ret['allowCredentials'] = @allowed_credentials
+      end
+      unless @user_verification.nil?
+        ret['userVerification'] = @user_verification
+      end
+      unless @extensions.nil?
+        ret['extensions'] = @extensions
+      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/web_authn_registration_challenge_response.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # WebAuthnRegistrationChallengeResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class WebAuthnRegistrationChallengeResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [String] challenge_id
+    attr_accessor :challenge_id
+
+    # @type [Comet::WebAuthnPublicKeyCredentialCreationOptions] credential_creation_options
+    attr_accessor :credential_creation_options
+
+    # @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 = ''
+      @challenge_id = ''
+      @credential_creation_options = Comet::WebAuthnPublicKeyCredentialCreationOptions.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 '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 'ChallengeID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @challenge_id = v
+        when 'CredentialCreationOptions'
+          @credential_creation_options = Comet::WebAuthnPublicKeyCredentialCreationOptions.new
+          @credential_creation_options.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['Status'] = @status
+      ret['Message'] = @message
+      ret['ChallengeID'] = @challenge_id
+      ret['CredentialCreationOptions'] = @credential_creation_options
+      @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