norbelys 0.1.0

data/lib/norbelys/models/person_import_stats.rb

@@ -0,0 +1,518 @@
+=begin
+#Norbelys API
+
+#The **Norbelys API** is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious.  ## Authentication  Every request authenticates with an **org-scoped API key**. Create one in **Settings → API keys** and send it as a bearer token:  ```http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… ```  Interactive agents may instead use OAuth 2.1 (see `/auth.md` and the `/.well-known/oauth-protected-resource` metadata).  ## Conventions  - **Base URL** — `https://api.norbelys.com/v1`. - **JSON in, JSON out.** Timestamps are ISO-8601 in UTC. - **Cursor pagination.** List endpoints take `limit` + `cursor` and return   `{ data, hasMore, nextCursor }` (offset-paged tables add `page` + `total`). - **Expansions.** Detail GETs take an `expand[]` query param to inline related   data (e.g. `GET /people/{id}?expand[]=timeline`) instead of extra calls. - **Soft deletes.** Anything that has been used is archived, never hard-deleted —   `DELETE` archives the resource and returns it.  ## Errors  Failures return the same envelope on every 4xx/5xx, with the matching HTTP status:  ```json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\",             \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } ```  `type` is a broad, machine-routable category derived from the status; `code` is the stable machine contract you branch on (never the human `message`). See the `ApiError` schema.  ## Idempotency  Every `POST` accepts an optional **`Idempotency-Key`** header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record.  ## Rate limits & versioning  Abuse control is enforced at the edge; responses advertise the policy via the `RateLimit-Policy` header, and a `429` carries `Retry-After`. The API is versioned in the URL path (`/v1`). Breaking changes ship under a new version; a retiring surface is announced with `Deprecation` + `Sunset` response headers at least 90 days ahead.
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Norbelys
+  class PersonImportStats
+    # New people this import inserted.
+    attr_accessor :created
+
+    # The import id.
+    attr_accessor :id
+
+    attr_accessor :object
+
+    # Created people still awaiting a verdict (`created − processed`).
+    attr_accessor :pending
+
+    # How many of the created people have been verified so far.
+    attr_accessor :processed
+
+    # The cleaning report: WHAT the verification found, per reason — which addresses were removed as dead domains, likely typos, disposables, previously bounced, and so on. Ordered by count, descending.
+    attr_accessor :reasons
+
+    # Verified and safe to email.
+    attr_accessor :sendable
+
+    # `processing` while addresses are still being verified, `completed` once every created person has a verdict.
+    attr_accessor :status
+
+    # Already on the suppression list before the import, so verification was skipped.
+    attr_accessor :suppressed_existing
+
+    # Newly suppressed by an undeliverable verdict.
+    attr_accessor :suppressed_new
+
+    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
+      {
+        :'created' => :'created',
+        :'id' => :'id',
+        :'object' => :'object',
+        :'pending' => :'pending',
+        :'processed' => :'processed',
+        :'reasons' => :'reasons',
+        :'sendable' => :'sendable',
+        :'status' => :'status',
+        :'suppressed_existing' => :'suppressedExisting',
+        :'suppressed_new' => :'suppressedNew'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'created' => :'Integer',
+        :'id' => :'String',
+        :'object' => :'Object',
+        :'pending' => :'Integer',
+        :'processed' => :'Integer',
+        :'reasons' => :'Array<PersonImportReason>',
+        :'sendable' => :'Integer',
+        :'status' => :'String',
+        :'suppressed_existing' => :'Integer',
+        :'suppressed_new' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'object',
+      ])
+    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 `Norbelys::PersonImportStats` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Norbelys::PersonImportStats`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      else
+        self.created = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      end
+
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
+      else
+        self.pending = nil
+      end
+
+      if attributes.key?(:'processed')
+        self.processed = attributes[:'processed']
+      else
+        self.processed = nil
+      end
+
+      if attributes.key?(:'reasons')
+        if (value = attributes[:'reasons']).is_a?(Array)
+          self.reasons = value
+        end
+      else
+        self.reasons = nil
+      end
+
+      if attributes.key?(:'sendable')
+        self.sendable = attributes[:'sendable']
+      else
+        self.sendable = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'suppressed_existing')
+        self.suppressed_existing = attributes[:'suppressed_existing']
+      else
+        self.suppressed_existing = nil
+      end
+
+      if attributes.key?(:'suppressed_new')
+        self.suppressed_new = attributes[:'suppressed_new']
+      else
+        self.suppressed_new = 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 @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @created < 0
+        invalid_properties.push('invalid value for "created", must be greater than or equal to 0.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @pending.nil?
+        invalid_properties.push('invalid value for "pending", pending cannot be nil.')
+      end
+
+      if @pending < 0
+        invalid_properties.push('invalid value for "pending", must be greater than or equal to 0.')
+      end
+
+      if @processed.nil?
+        invalid_properties.push('invalid value for "processed", processed cannot be nil.')
+      end
+
+      if @processed < 0
+        invalid_properties.push('invalid value for "processed", must be greater than or equal to 0.')
+      end
+
+      if @reasons.nil?
+        invalid_properties.push('invalid value for "reasons", reasons cannot be nil.')
+      end
+
+      if @sendable.nil?
+        invalid_properties.push('invalid value for "sendable", sendable cannot be nil.')
+      end
+
+      if @sendable < 0
+        invalid_properties.push('invalid value for "sendable", must be greater than or equal to 0.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @suppressed_existing.nil?
+        invalid_properties.push('invalid value for "suppressed_existing", suppressed_existing cannot be nil.')
+      end
+
+      if @suppressed_existing < 0
+        invalid_properties.push('invalid value for "suppressed_existing", must be greater than or equal to 0.')
+      end
+
+      if @suppressed_new.nil?
+        invalid_properties.push('invalid value for "suppressed_new", suppressed_new cannot be nil.')
+      end
+
+      if @suppressed_new < 0
+        invalid_properties.push('invalid value for "suppressed_new", 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 @created.nil?
+      return false if @created < 0
+      return false if @id.nil?
+      return false if @pending.nil?
+      return false if @pending < 0
+      return false if @processed.nil?
+      return false if @processed < 0
+      return false if @reasons.nil?
+      return false if @sendable.nil?
+      return false if @sendable < 0
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["processing", "completed"])
+      return false unless status_validator.valid?(@status)
+      return false if @suppressed_existing.nil?
+      return false if @suppressed_existing < 0
+      return false if @suppressed_new.nil?
+      return false if @suppressed_new < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created Value to be assigned
+    def created=(created)
+      if created.nil?
+        fail ArgumentError, 'created cannot be nil'
+      end
+
+      if created < 0
+        fail ArgumentError, 'invalid value for "created", must be greater than or equal to 0.'
+      end
+
+      @created = created
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pending Value to be assigned
+    def pending=(pending)
+      if pending.nil?
+        fail ArgumentError, 'pending cannot be nil'
+      end
+
+      if pending < 0
+        fail ArgumentError, 'invalid value for "pending", must be greater than or equal to 0.'
+      end
+
+      @pending = pending
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] processed Value to be assigned
+    def processed=(processed)
+      if processed.nil?
+        fail ArgumentError, 'processed cannot be nil'
+      end
+
+      if processed < 0
+        fail ArgumentError, 'invalid value for "processed", must be greater than or equal to 0.'
+      end
+
+      @processed = processed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sendable Value to be assigned
+    def sendable=(sendable)
+      if sendable.nil?
+        fail ArgumentError, 'sendable cannot be nil'
+      end
+
+      if sendable < 0
+        fail ArgumentError, 'invalid value for "sendable", must be greater than or equal to 0.'
+      end
+
+      @sendable = sendable
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["processing", "completed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] suppressed_existing Value to be assigned
+    def suppressed_existing=(suppressed_existing)
+      if suppressed_existing.nil?
+        fail ArgumentError, 'suppressed_existing cannot be nil'
+      end
+
+      if suppressed_existing < 0
+        fail ArgumentError, 'invalid value for "suppressed_existing", must be greater than or equal to 0.'
+      end
+
+      @suppressed_existing = suppressed_existing
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] suppressed_new Value to be assigned
+    def suppressed_new=(suppressed_new)
+      if suppressed_new.nil?
+        fail ArgumentError, 'suppressed_new cannot be nil'
+      end
+
+      if suppressed_new < 0
+        fail ArgumentError, 'invalid value for "suppressed_new", must be greater than or equal to 0.'
+      end
+
+      @suppressed_new = suppressed_new
+    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 &&
+          created == o.created &&
+          id == o.id &&
+          object == o.object &&
+          pending == o.pending &&
+          processed == o.processed &&
+          reasons == o.reasons &&
+          sendable == o.sendable &&
+          status == o.status &&
+          suppressed_existing == o.suppressed_existing &&
+          suppressed_new == o.suppressed_new
+    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
+      [created, id, object, pending, processed, reasons, sendable, status, suppressed_existing, suppressed_new].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Norbelys.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end