relentless_identity 1.0.0

data/lib/relentless_identity/models/client_request_history_item.rb

@@ -0,0 +1,450 @@
+=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
+  # One completed direct request visible in the user's request history.
+  class ClientRequestHistoryItem < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :request_type
+
+    attr_accessor :input_name
+
+    attr_accessor :input_domain
+
+    attr_accessor :input_email
+
+    # Compact human-readable identifier for the original request input.
+    attr_accessor :input_label
+
+    attr_accessor :state
+
+    attr_accessor :outcome
+
+    attr_accessor :resolved_address
+
+    attr_accessor :duration_ms
+
+    attr_accessor :provider
+
+    attr_accessor :identity_providers
+
+    attr_accessor :mx_hosts
+
+    # Small transport and outcome metadata associated with the request.
+    attr_accessor :metadata
+
+    attr_accessor :is_alias
+
+    attr_accessor :is_catchall
+
+    attr_accessor :request_id
+
+    attr_accessor :created_at
+
+    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
+      {
+        :'id' => :'id',
+        :'request_type' => :'request_type',
+        :'input_name' => :'input_name',
+        :'input_domain' => :'input_domain',
+        :'input_email' => :'input_email',
+        :'input_label' => :'input_label',
+        :'state' => :'state',
+        :'outcome' => :'outcome',
+        :'resolved_address' => :'resolved_address',
+        :'duration_ms' => :'duration_ms',
+        :'provider' => :'provider',
+        :'identity_providers' => :'identity_providers',
+        :'mx_hosts' => :'mx_hosts',
+        :'metadata' => :'metadata',
+        :'is_alias' => :'is_alias',
+        :'is_catchall' => :'is_catchall',
+        :'request_id' => :'request_id',
+        :'created_at' => :'created_at'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'request_type' => :'String',
+        :'input_name' => :'String',
+        :'input_domain' => :'String',
+        :'input_email' => :'String',
+        :'input_label' => :'String',
+        :'state' => :'String',
+        :'outcome' => :'String',
+        :'resolved_address' => :'String',
+        :'duration_ms' => :'Integer',
+        :'provider' => :'String',
+        :'identity_providers' => :'Array<Hash<String, Object>>',
+        :'mx_hosts' => :'Array<String>',
+        :'metadata' => :'Hash<String, Object>',
+        :'is_alias' => :'Boolean',
+        :'is_catchall' => :'Boolean',
+        :'request_id' => :'String',
+        :'created_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'input_name',
+        :'input_domain',
+        :'input_email',
+        :'resolved_address',
+        :'duration_ms',
+        :'provider',
+        :'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::ClientRequestHistoryItem` 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::ClientRequestHistoryItem`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'request_type')
+        self.request_type = attributes[:'request_type']
+      else
+        self.request_type = nil
+      end
+
+      if attributes.key?(:'input_name')
+        self.input_name = attributes[:'input_name']
+      end
+
+      if attributes.key?(:'input_domain')
+        self.input_domain = attributes[:'input_domain']
+      end
+
+      if attributes.key?(:'input_email')
+        self.input_email = attributes[:'input_email']
+      end
+
+      if attributes.key?(:'input_label')
+        self.input_label = attributes[:'input_label']
+      else
+        self.input_label = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      else
+        self.outcome = nil
+      end
+
+      if attributes.key?(:'resolved_address')
+        self.resolved_address = attributes[:'resolved_address']
+      end
+
+      if attributes.key?(:'duration_ms')
+        self.duration_ms = attributes[:'duration_ms']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      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?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'is_alias')
+        self.is_alias = attributes[:'is_alias']
+      else
+        self.is_alias = false
+      end
+
+      if attributes.key?(:'is_catchall')
+        self.is_catchall = attributes[:'is_catchall']
+      else
+        self.is_catchall = false
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @request_type.nil?
+        invalid_properties.push('invalid value for "request_type", request_type cannot be nil.')
+      end
+
+      if @input_label.nil?
+        invalid_properties.push('invalid value for "input_label", input_label cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @outcome.nil?
+        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @id.nil?
+      return false if @request_type.nil?
+      request_type_validator = EnumAttributeValidator.new('String', ["finder", "probe"])
+      return false unless request_type_validator.valid?(@request_type)
+      return false if @input_label.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["deliverable", "undeliverable"])
+      return false unless state_validator.valid?(@state)
+      return false if @outcome.nil?
+      outcome_validator = EnumAttributeValidator.new('String', ["found", "not_found", "error"])
+      return false unless outcome_validator.valid?(@outcome)
+      return false if @created_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] request_type Object to be assigned
+    def request_type=(request_type)
+      validator = EnumAttributeValidator.new('String', ["finder", "probe"])
+      unless validator.valid?(request_type)
+        fail ArgumentError, "invalid value for \"request_type\", must be one of #{validator.allowable_values}."
+      end
+      @request_type = request_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input_label Value to be assigned
+    def input_label=(input_label)
+      if input_label.nil?
+        fail ArgumentError, 'input_label cannot be nil'
+      end
+
+      @input_label = input_label
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    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 &&
+          id == o.id &&
+          request_type == o.request_type &&
+          input_name == o.input_name &&
+          input_domain == o.input_domain &&
+          input_email == o.input_email &&
+          input_label == o.input_label &&
+          state == o.state &&
+          outcome == o.outcome &&
+          resolved_address == o.resolved_address &&
+          duration_ms == o.duration_ms &&
+          provider == o.provider &&
+          identity_providers == o.identity_providers &&
+          mx_hosts == o.mx_hosts &&
+          metadata == o.metadata &&
+          is_alias == o.is_alias &&
+          is_catchall == o.is_catchall &&
+          request_id == o.request_id &&
+          created_at == o.created_at
+    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
+      [id, request_type, input_name, input_domain, input_email, input_label, state, outcome, resolved_address, duration_ms, provider, identity_providers, mx_hosts, metadata, is_alias, is_catchall, request_id, created_at].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