norbelys 0.1.0

data/lib/norbelys/models/enrollment_counts.rb

@@ -0,0 +1,660 @@
+=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
+  # Enrollment-status counts for the whole queried scope (they ignore the `status` filter).
+  class EnrollmentCounts
+    # Active leads.
+    attr_accessor :active
+
+    # Leads that bounced.
+    attr_accessor :bounced
+
+    # Active leads waiting at each cadence step (`currentStepId` → count) — who sits between which emails right now.
+    attr_accessor :by_step
+
+    # Leads whose run was cancelled by archiving the campaign.
+    attr_accessor :cancelled
+
+    # Leads that finished the cadence.
+    attr_accessor :finished
+
+    # Active leads mid-cadence.
+    attr_accessor :in_progress
+
+    attr_accessor :next_send_at
+
+    # Active leads not yet contacted.
+    attr_accessor :not_started
+
+    # Paused leads.
+    attr_accessor :paused
+
+    # Leads that replied.
+    attr_accessor :replied
+
+    # Leads skipped because they were suppressed at send time.
+    attr_accessor :skipped
+
+    # Leads pulled out by an engagement stop (open/click).
+    attr_accessor :stopped
+
+    # All enrollments in scope.
+    attr_accessor :total
+
+    # Leads that unsubscribed.
+    attr_accessor :unsubscribed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'active' => :'active',
+        :'bounced' => :'bounced',
+        :'by_step' => :'byStep',
+        :'cancelled' => :'cancelled',
+        :'finished' => :'finished',
+        :'in_progress' => :'inProgress',
+        :'next_send_at' => :'nextSendAt',
+        :'not_started' => :'notStarted',
+        :'paused' => :'paused',
+        :'replied' => :'replied',
+        :'skipped' => :'skipped',
+        :'stopped' => :'stopped',
+        :'total' => :'total',
+        :'unsubscribed' => :'unsubscribed'
+      }
+    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
+      {
+        :'active' => :'Integer',
+        :'bounced' => :'Integer',
+        :'by_step' => :'Hash<String, Integer>',
+        :'cancelled' => :'Integer',
+        :'finished' => :'Integer',
+        :'in_progress' => :'Integer',
+        :'next_send_at' => :'Object',
+        :'not_started' => :'Integer',
+        :'paused' => :'Integer',
+        :'replied' => :'Integer',
+        :'skipped' => :'Integer',
+        :'stopped' => :'Integer',
+        :'total' => :'Integer',
+        :'unsubscribed' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'next_send_at',
+      ])
+    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::EnrollmentCounts` 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::EnrollmentCounts`. 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?(:'active')
+        self.active = attributes[:'active']
+      else
+        self.active = nil
+      end
+
+      if attributes.key?(:'bounced')
+        self.bounced = attributes[:'bounced']
+      else
+        self.bounced = nil
+      end
+
+      if attributes.key?(:'by_step')
+        if (value = attributes[:'by_step']).is_a?(Hash)
+          self.by_step = value
+        end
+      end
+
+      if attributes.key?(:'cancelled')
+        self.cancelled = attributes[:'cancelled']
+      else
+        self.cancelled = nil
+      end
+
+      if attributes.key?(:'finished')
+        self.finished = attributes[:'finished']
+      else
+        self.finished = nil
+      end
+
+      if attributes.key?(:'in_progress')
+        self.in_progress = attributes[:'in_progress']
+      else
+        self.in_progress = nil
+      end
+
+      if attributes.key?(:'next_send_at')
+        self.next_send_at = attributes[:'next_send_at']
+      end
+
+      if attributes.key?(:'not_started')
+        self.not_started = attributes[:'not_started']
+      else
+        self.not_started = nil
+      end
+
+      if attributes.key?(:'paused')
+        self.paused = attributes[:'paused']
+      else
+        self.paused = nil
+      end
+
+      if attributes.key?(:'replied')
+        self.replied = attributes[:'replied']
+      else
+        self.replied = nil
+      end
+
+      if attributes.key?(:'skipped')
+        self.skipped = attributes[:'skipped']
+      else
+        self.skipped = nil
+      end
+
+      if attributes.key?(:'stopped')
+        self.stopped = attributes[:'stopped']
+      else
+        self.stopped = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+
+      if attributes.key?(:'unsubscribed')
+        self.unsubscribed = attributes[:'unsubscribed']
+      else
+        self.unsubscribed = 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 @active.nil?
+        invalid_properties.push('invalid value for "active", active cannot be nil.')
+      end
+
+      if @active < 0
+        invalid_properties.push('invalid value for "active", must be greater than or equal to 0.')
+      end
+
+      if @bounced.nil?
+        invalid_properties.push('invalid value for "bounced", bounced cannot be nil.')
+      end
+
+      if @bounced < 0
+        invalid_properties.push('invalid value for "bounced", must be greater than or equal to 0.')
+      end
+
+      if @cancelled.nil?
+        invalid_properties.push('invalid value for "cancelled", cancelled cannot be nil.')
+      end
+
+      if @cancelled < 0
+        invalid_properties.push('invalid value for "cancelled", must be greater than or equal to 0.')
+      end
+
+      if @finished.nil?
+        invalid_properties.push('invalid value for "finished", finished cannot be nil.')
+      end
+
+      if @finished < 0
+        invalid_properties.push('invalid value for "finished", must be greater than or equal to 0.')
+      end
+
+      if @in_progress.nil?
+        invalid_properties.push('invalid value for "in_progress", in_progress cannot be nil.')
+      end
+
+      if @in_progress < 0
+        invalid_properties.push('invalid value for "in_progress", must be greater than or equal to 0.')
+      end
+
+      if @not_started.nil?
+        invalid_properties.push('invalid value for "not_started", not_started cannot be nil.')
+      end
+
+      if @not_started < 0
+        invalid_properties.push('invalid value for "not_started", must be greater than or equal to 0.')
+      end
+
+      if @paused.nil?
+        invalid_properties.push('invalid value for "paused", paused cannot be nil.')
+      end
+
+      if @paused < 0
+        invalid_properties.push('invalid value for "paused", must be greater than or equal to 0.')
+      end
+
+      if @replied.nil?
+        invalid_properties.push('invalid value for "replied", replied cannot be nil.')
+      end
+
+      if @replied < 0
+        invalid_properties.push('invalid value for "replied", must be greater than or equal to 0.')
+      end
+
+      if @skipped.nil?
+        invalid_properties.push('invalid value for "skipped", skipped cannot be nil.')
+      end
+
+      if @skipped < 0
+        invalid_properties.push('invalid value for "skipped", must be greater than or equal to 0.')
+      end
+
+      if @stopped.nil?
+        invalid_properties.push('invalid value for "stopped", stopped cannot be nil.')
+      end
+
+      if @stopped < 0
+        invalid_properties.push('invalid value for "stopped", must be greater than or equal to 0.')
+      end
+
+      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 @unsubscribed.nil?
+        invalid_properties.push('invalid value for "unsubscribed", unsubscribed cannot be nil.')
+      end
+
+      if @unsubscribed < 0
+        invalid_properties.push('invalid value for "unsubscribed", 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 @active.nil?
+      return false if @active < 0
+      return false if @bounced.nil?
+      return false if @bounced < 0
+      return false if @cancelled.nil?
+      return false if @cancelled < 0
+      return false if @finished.nil?
+      return false if @finished < 0
+      return false if @in_progress.nil?
+      return false if @in_progress < 0
+      return false if @not_started.nil?
+      return false if @not_started < 0
+      return false if @paused.nil?
+      return false if @paused < 0
+      return false if @replied.nil?
+      return false if @replied < 0
+      return false if @skipped.nil?
+      return false if @skipped < 0
+      return false if @stopped.nil?
+      return false if @stopped < 0
+      return false if @total.nil?
+      return false if @total < 0
+      return false if @unsubscribed.nil?
+      return false if @unsubscribed < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active Value to be assigned
+    def active=(active)
+      if active.nil?
+        fail ArgumentError, 'active cannot be nil'
+      end
+
+      if active < 0
+        fail ArgumentError, 'invalid value for "active", must be greater than or equal to 0.'
+      end
+
+      @active = active
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bounced Value to be assigned
+    def bounced=(bounced)
+      if bounced.nil?
+        fail ArgumentError, 'bounced cannot be nil'
+      end
+
+      if bounced < 0
+        fail ArgumentError, 'invalid value for "bounced", must be greater than or equal to 0.'
+      end
+
+      @bounced = bounced
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cancelled Value to be assigned
+    def cancelled=(cancelled)
+      if cancelled.nil?
+        fail ArgumentError, 'cancelled cannot be nil'
+      end
+
+      if cancelled < 0
+        fail ArgumentError, 'invalid value for "cancelled", must be greater than or equal to 0.'
+      end
+
+      @cancelled = cancelled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] finished Value to be assigned
+    def finished=(finished)
+      if finished.nil?
+        fail ArgumentError, 'finished cannot be nil'
+      end
+
+      if finished < 0
+        fail ArgumentError, 'invalid value for "finished", must be greater than or equal to 0.'
+      end
+
+      @finished = finished
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] in_progress Value to be assigned
+    def in_progress=(in_progress)
+      if in_progress.nil?
+        fail ArgumentError, 'in_progress cannot be nil'
+      end
+
+      if in_progress < 0
+        fail ArgumentError, 'invalid value for "in_progress", must be greater than or equal to 0.'
+      end
+
+      @in_progress = in_progress
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] not_started Value to be assigned
+    def not_started=(not_started)
+      if not_started.nil?
+        fail ArgumentError, 'not_started cannot be nil'
+      end
+
+      if not_started < 0
+        fail ArgumentError, 'invalid value for "not_started", must be greater than or equal to 0.'
+      end
+
+      @not_started = not_started
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] paused Value to be assigned
+    def paused=(paused)
+      if paused.nil?
+        fail ArgumentError, 'paused cannot be nil'
+      end
+
+      if paused < 0
+        fail ArgumentError, 'invalid value for "paused", must be greater than or equal to 0.'
+      end
+
+      @paused = paused
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] replied Value to be assigned
+    def replied=(replied)
+      if replied.nil?
+        fail ArgumentError, 'replied cannot be nil'
+      end
+
+      if replied < 0
+        fail ArgumentError, 'invalid value for "replied", must be greater than or equal to 0.'
+      end
+
+      @replied = replied
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] skipped Value to be assigned
+    def skipped=(skipped)
+      if skipped.nil?
+        fail ArgumentError, 'skipped cannot be nil'
+      end
+
+      if skipped < 0
+        fail ArgumentError, 'invalid value for "skipped", must be greater than or equal to 0.'
+      end
+
+      @skipped = skipped
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] stopped Value to be assigned
+    def stopped=(stopped)
+      if stopped.nil?
+        fail ArgumentError, 'stopped cannot be nil'
+      end
+
+      if stopped < 0
+        fail ArgumentError, 'invalid value for "stopped", must be greater than or equal to 0.'
+      end
+
+      @stopped = stopped
+    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] unsubscribed Value to be assigned
+    def unsubscribed=(unsubscribed)
+      if unsubscribed.nil?
+        fail ArgumentError, 'unsubscribed cannot be nil'
+      end
+
+      if unsubscribed < 0
+        fail ArgumentError, 'invalid value for "unsubscribed", must be greater than or equal to 0.'
+      end
+
+      @unsubscribed = unsubscribed
+    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 &&
+          active == o.active &&
+          bounced == o.bounced &&
+          by_step == o.by_step &&
+          cancelled == o.cancelled &&
+          finished == o.finished &&
+          in_progress == o.in_progress &&
+          next_send_at == o.next_send_at &&
+          not_started == o.not_started &&
+          paused == o.paused &&
+          replied == o.replied &&
+          skipped == o.skipped &&
+          stopped == o.stopped &&
+          total == o.total &&
+          unsubscribed == o.unsubscribed
+    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
+      [active, bounced, by_step, cancelled, finished, in_progress, next_send_at, not_started, paused, replied, skipped, stopped, total, unsubscribed].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