relentless_identity 1.0.0

data/lib/relentless_identity/models/batch_summary.rb

@@ -0,0 +1,318 @@
+=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
+  class BatchSummary < ApiModelBase
+    # Total number of requested items.
+    attr_accessor :total
+
+    # Items that resolved to a positive deliverable result.
+    attr_accessor :found
+
+    # Items that completed cleanly with a negative result.
+    attr_accessor :not_found
+
+    # Items that ended with an operational verification error rather than a mailbox verdict.
+    attr_accessor :errors
+
+    # Distinct mailbox domains represented in the batch.
+    attr_accessor :unique_domains
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'found' => :'found',
+        :'not_found' => :'not_found',
+        :'errors' => :'errors',
+        :'unique_domains' => :'unique_domains'
+      }
+    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
+      {
+        :'total' => :'Integer',
+        :'found' => :'Integer',
+        :'not_found' => :'Integer',
+        :'errors' => :'Integer',
+        :'unique_domains' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::BatchSummary` 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::BatchSummary`. 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?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+
+      if attributes.key?(:'found')
+        self.found = attributes[:'found']
+      else
+        self.found = nil
+      end
+
+      if attributes.key?(:'not_found')
+        self.not_found = attributes[:'not_found']
+      else
+        self.not_found = nil
+      end
+
+      if attributes.key?(:'errors')
+        self.errors = attributes[:'errors']
+      else
+        self.errors = nil
+      end
+
+      if attributes.key?(:'unique_domains')
+        self.unique_domains = attributes[:'unique_domains']
+      else
+        self.unique_domains = 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 @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      if @total < 0
+        invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
+      end
+
+      if @found.nil?
+        invalid_properties.push('invalid value for "found", found cannot be nil.')
+      end
+
+      if @found < 0
+        invalid_properties.push('invalid value for "found", must be greater than or equal to 0.')
+      end
+
+      if @not_found.nil?
+        invalid_properties.push('invalid value for "not_found", not_found cannot be nil.')
+      end
+
+      if @not_found < 0
+        invalid_properties.push('invalid value for "not_found", must be greater than or equal to 0.')
+      end
+
+      if @errors.nil?
+        invalid_properties.push('invalid value for "errors", errors cannot be nil.')
+      end
+
+      if @errors < 0
+        invalid_properties.push('invalid value for "errors", must be greater than or equal to 0.')
+      end
+
+      if @unique_domains.nil?
+        invalid_properties.push('invalid value for "unique_domains", unique_domains cannot be nil.')
+      end
+
+      if @unique_domains < 0
+        invalid_properties.push('invalid value for "unique_domains", must be greater than or equal to 0.')
+      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 @total.nil?
+      return false if @total < 0
+      return false if @found.nil?
+      return false if @found < 0
+      return false if @not_found.nil?
+      return false if @not_found < 0
+      return false if @errors.nil?
+      return false if @errors < 0
+      return false if @unique_domains.nil?
+      return false if @unique_domains < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      if total < 0
+        fail ArgumentError, 'invalid value for "total", must be greater than or equal to 0.'
+      end
+
+      @total = total
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] found Value to be assigned
+    def found=(found)
+      if found.nil?
+        fail ArgumentError, 'found cannot be nil'
+      end
+
+      if found < 0
+        fail ArgumentError, 'invalid value for "found", must be greater than or equal to 0.'
+      end
+
+      @found = found
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] not_found Value to be assigned
+    def not_found=(not_found)
+      if not_found.nil?
+        fail ArgumentError, 'not_found cannot be nil'
+      end
+
+      if not_found < 0
+        fail ArgumentError, 'invalid value for "not_found", must be greater than or equal to 0.'
+      end
+
+      @not_found = not_found
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] errors Value to be assigned
+    def errors=(errors)
+      if errors.nil?
+        fail ArgumentError, 'errors cannot be nil'
+      end
+
+      if errors < 0
+        fail ArgumentError, 'invalid value for "errors", must be greater than or equal to 0.'
+      end
+
+      @errors = errors
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unique_domains Value to be assigned
+    def unique_domains=(unique_domains)
+      if unique_domains.nil?
+        fail ArgumentError, 'unique_domains cannot be nil'
+      end
+
+      if unique_domains < 0
+        fail ArgumentError, 'invalid value for "unique_domains", must be greater than or equal to 0.'
+      end
+
+      @unique_domains = unique_domains
+    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 &&
+          total == o.total &&
+          found == o.found &&
+          not_found == o.not_found &&
+          errors == o.errors &&
+          unique_domains == o.unique_domains
+    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
+      [total, found, not_found, errors, unique_domains].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

data/lib/relentless_identity/models/client_background_job_detail_response.rb

@@ -0,0 +1,307 @@
+=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
+  # Background job detail plus paginated item results.
+  class ClientBackgroundJobDetailResponse < ApiModelBase
+    attr_accessor :job
+
+    attr_accessor :items
+
+    attr_accessor :total_items
+
+    attr_accessor :page
+
+    attr_accessor :page_size
+
+    attr_accessor :total_pages
+
+    # Whether the stored item payload rows have already expired and been pruned.
+    attr_accessor :results_expired
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'job' => :'job',
+        :'items' => :'items',
+        :'total_items' => :'total_items',
+        :'page' => :'page',
+        :'page_size' => :'page_size',
+        :'total_pages' => :'total_pages',
+        :'results_expired' => :'results_expired'
+      }
+    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
+      {
+        :'job' => :'ClientBackgroundJobResponse',
+        :'items' => :'Array<ClientBackgroundJobItemResponse>',
+        :'total_items' => :'Integer',
+        :'page' => :'Integer',
+        :'page_size' => :'Integer',
+        :'total_pages' => :'Integer',
+        :'results_expired' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ClientBackgroundJobDetailResponse` 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::ClientBackgroundJobDetailResponse`. 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?(:'job')
+        self.job = attributes[:'job']
+      else
+        self.job = nil
+      end
+
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      else
+        self.items = nil
+      end
+
+      if attributes.key?(:'total_items')
+        self.total_items = attributes[:'total_items']
+      else
+        self.total_items = nil
+      end
+
+      if attributes.key?(:'page')
+        self.page = attributes[:'page']
+      else
+        self.page = nil
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      else
+        self.page_size = nil
+      end
+
+      if attributes.key?(:'total_pages')
+        self.total_pages = attributes[:'total_pages']
+      else
+        self.total_pages = nil
+      end
+
+      if attributes.key?(:'results_expired')
+        self.results_expired = attributes[:'results_expired']
+      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 @job.nil?
+        invalid_properties.push('invalid value for "job", job cannot be nil.')
+      end
+
+      if @items.nil?
+        invalid_properties.push('invalid value for "items", items cannot be nil.')
+      end
+
+      if @total_items.nil?
+        invalid_properties.push('invalid value for "total_items", total_items cannot be nil.')
+      end
+
+      if @page.nil?
+        invalid_properties.push('invalid value for "page", page cannot be nil.')
+      end
+
+      if @page_size.nil?
+        invalid_properties.push('invalid value for "page_size", page_size cannot be nil.')
+      end
+
+      if @total_pages.nil?
+        invalid_properties.push('invalid value for "total_pages", total_pages 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 @job.nil?
+      return false if @items.nil?
+      return false if @total_items.nil?
+      return false if @page.nil?
+      return false if @page_size.nil?
+      return false if @total_pages.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] job Value to be assigned
+    def job=(job)
+      if job.nil?
+        fail ArgumentError, 'job cannot be nil'
+      end
+
+      @job = job
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] items Value to be assigned
+    def items=(items)
+      if items.nil?
+        fail ArgumentError, 'items cannot be nil'
+      end
+
+      @items = items
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_items Value to be assigned
+    def total_items=(total_items)
+      if total_items.nil?
+        fail ArgumentError, 'total_items cannot be nil'
+      end
+
+      @total_items = total_items
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page Value to be assigned
+    def page=(page)
+      if page.nil?
+        fail ArgumentError, 'page cannot be nil'
+      end
+
+      @page = page
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_size Value to be assigned
+    def page_size=(page_size)
+      if page_size.nil?
+        fail ArgumentError, 'page_size cannot be nil'
+      end
+
+      @page_size = page_size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_pages Value to be assigned
+    def total_pages=(total_pages)
+      if total_pages.nil?
+        fail ArgumentError, 'total_pages cannot be nil'
+      end
+
+      @total_pages = total_pages
+    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 &&
+          job == o.job &&
+          items == o.items &&
+          total_items == o.total_items &&
+          page == o.page &&
+          page_size == o.page_size &&
+          total_pages == o.total_pages &&
+          results_expired == o.results_expired
+    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
+      [job, items, total_items, page, page_size, total_pages, results_expired].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