relentless_identity 1.0.0

data/lib/relentless_identity/models/client_identity_response.rb

@@ -0,0 +1,285 @@
+=begin
+#Relentless Identity API
+
+#Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module RelentlessIdentity
+  # Compact public result envelope used by Finder and Probe style responses.
+  class ClientIdentityResponse < ApiModelBase
+    # Final public deliverability verdict.
+    attr_accessor :state
+
+    # Operational outcome. `error` means the verification could not complete cleanly and should not be treated as a negative mailbox verdict.
+    attr_accessor :outcome
+
+    attr_accessor :address
+
+    # Whether the resolved address is an alias rather than a primary mailbox.
+    attr_accessor :is_alias
+
+    attr_accessor :_alias
+
+    # Whether the mailbox domain behaved like a catch-all during verification.
+    attr_accessor :is_catchall
+
+    # Identity providers associated with the mailbox domain when available.
+    attr_accessor :identity_providers
+
+    # Observed MX hosts for the mailbox domain.
+    attr_accessor :mx_hosts
+
+    attr_accessor :request_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'state' => :'state',
+        :'outcome' => :'outcome',
+        :'address' => :'address',
+        :'is_alias' => :'is_alias',
+        :'_alias' => :'alias',
+        :'is_catchall' => :'is_catchall',
+        :'identity_providers' => :'identity_providers',
+        :'mx_hosts' => :'mx_hosts',
+        :'request_id' => :'request_id'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'state' => :'String',
+        :'outcome' => :'String',
+        :'address' => :'String',
+        :'is_alias' => :'Boolean',
+        :'_alias' => :'ClientFinderResponseAlias',
+        :'is_catchall' => :'Boolean',
+        :'identity_providers' => :'Array<IdentityProvider>',
+        :'mx_hosts' => :'Array<String>',
+        :'request_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'address',
+        :'request_id'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `RelentlessIdentity::ClientIdentityResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `RelentlessIdentity::ClientIdentityResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'is_alias')
+        self.is_alias = attributes[:'is_alias']
+      end
+
+      if attributes.key?(:'_alias')
+        self._alias = attributes[:'_alias']
+      end
+
+      if attributes.key?(:'is_catchall')
+        self.is_catchall = attributes[:'is_catchall']
+      end
+
+      if attributes.key?(:'identity_providers')
+        if (value = attributes[:'identity_providers']).is_a?(Array)
+          self.identity_providers = value
+        end
+      end
+
+      if attributes.key?(:'mx_hosts')
+        if (value = attributes[:'mx_hosts']).is_a?(Array)
+          self.mx_hosts = value
+        end
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["deliverable", "undeliverable"])
+      return false unless state_validator.valid?(@state)
+      outcome_validator = EnumAttributeValidator.new('String', ["found", "not_found", "error"])
+      return false unless outcome_validator.valid?(@outcome)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["deliverable", "undeliverable"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] outcome Object to be assigned
+    def outcome=(outcome)
+      validator = EnumAttributeValidator.new('String', ["found", "not_found", "error"])
+      unless validator.valid?(outcome)
+        fail ArgumentError, "invalid value for \"outcome\", must be one of #{validator.allowable_values}."
+      end
+      @outcome = outcome
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          state == o.state &&
+          outcome == o.outcome &&
+          address == o.address &&
+          is_alias == o.is_alias &&
+          _alias == o._alias &&
+          is_catchall == o.is_catchall &&
+          identity_providers == o.identity_providers &&
+          mx_hosts == o.mx_hosts &&
+          request_id == o.request_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [state, outcome, address, is_alias, _alias, is_catchall, identity_providers, mx_hosts, request_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end