norbelys 0.1.0

data/lib/norbelys/models/pulse_deliverability.rb

@@ -0,0 +1,325 @@
+=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
+  # The account deliverability headline over the window.
+  class PulseDeliverability
+    # All bounces ÷ sent (0-1). Example: 0.02
+    attr_accessor :bounce_rate
+
+    # Hard + soft bounces in the window. Example: 14
+    attr_accessor :bounces
+
+    # Spam complaints in the window. Example: 1
+    attr_accessor :complaints
+
+    # Hard bounces ÷ sent (0-1). Example: 0.01
+    attr_accessor :hard_bounce_rate
+
+    # Messages sent in the window. Example: 2100
+    attr_accessor :sent
+
+    # Complaints ÷ sent (0-1). Example: 0.0005
+    attr_accessor :spam_rate
+
+    # Unsubscribes in the window. Example: 6
+    attr_accessor :unsubscribes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bounce_rate' => :'bounceRate',
+        :'bounces' => :'bounces',
+        :'complaints' => :'complaints',
+        :'hard_bounce_rate' => :'hardBounceRate',
+        :'sent' => :'sent',
+        :'spam_rate' => :'spamRate',
+        :'unsubscribes' => :'unsubscribes'
+      }
+    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
+      {
+        :'bounce_rate' => :'Float',
+        :'bounces' => :'Float',
+        :'complaints' => :'Float',
+        :'hard_bounce_rate' => :'Float',
+        :'sent' => :'Float',
+        :'spam_rate' => :'Float',
+        :'unsubscribes' => :'Float'
+      }
+    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 `Norbelys::PulseDeliverability` 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::PulseDeliverability`. 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?(:'bounce_rate')
+        self.bounce_rate = attributes[:'bounce_rate']
+      else
+        self.bounce_rate = nil
+      end
+
+      if attributes.key?(:'bounces')
+        self.bounces = attributes[:'bounces']
+      else
+        self.bounces = nil
+      end
+
+      if attributes.key?(:'complaints')
+        self.complaints = attributes[:'complaints']
+      else
+        self.complaints = nil
+      end
+
+      if attributes.key?(:'hard_bounce_rate')
+        self.hard_bounce_rate = attributes[:'hard_bounce_rate']
+      else
+        self.hard_bounce_rate = nil
+      end
+
+      if attributes.key?(:'sent')
+        self.sent = attributes[:'sent']
+      else
+        self.sent = nil
+      end
+
+      if attributes.key?(:'spam_rate')
+        self.spam_rate = attributes[:'spam_rate']
+      else
+        self.spam_rate = nil
+      end
+
+      if attributes.key?(:'unsubscribes')
+        self.unsubscribes = attributes[:'unsubscribes']
+      else
+        self.unsubscribes = 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 @bounce_rate.nil?
+        invalid_properties.push('invalid value for "bounce_rate", bounce_rate cannot be nil.')
+      end
+
+      if @bounces.nil?
+        invalid_properties.push('invalid value for "bounces", bounces cannot be nil.')
+      end
+
+      if @complaints.nil?
+        invalid_properties.push('invalid value for "complaints", complaints cannot be nil.')
+      end
+
+      if @hard_bounce_rate.nil?
+        invalid_properties.push('invalid value for "hard_bounce_rate", hard_bounce_rate cannot be nil.')
+      end
+
+      if @sent.nil?
+        invalid_properties.push('invalid value for "sent", sent cannot be nil.')
+      end
+
+      if @spam_rate.nil?
+        invalid_properties.push('invalid value for "spam_rate", spam_rate cannot be nil.')
+      end
+
+      if @unsubscribes.nil?
+        invalid_properties.push('invalid value for "unsubscribes", unsubscribes 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 @bounce_rate.nil?
+      return false if @bounces.nil?
+      return false if @complaints.nil?
+      return false if @hard_bounce_rate.nil?
+      return false if @sent.nil?
+      return false if @spam_rate.nil?
+      return false if @unsubscribes.nil?
+      true
+    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 &&
+          bounce_rate == o.bounce_rate &&
+          bounces == o.bounces &&
+          complaints == o.complaints &&
+          hard_bounce_rate == o.hard_bounce_rate &&
+          sent == o.sent &&
+          spam_rate == o.spam_rate &&
+          unsubscribes == o.unsubscribes
+    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
+      [bounce_rate, bounces, complaints, hard_bounce_rate, sent, spam_rate, unsubscribes].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