norbelys 0.1.0

data/lib/norbelys/models/person_detail.rb

@@ -0,0 +1,548 @@
+=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 PersonDetail
+    attr_accessor :archived_at
+
+    attr_accessor :created_at
+
+    attr_accessor :custom_fields
+
+    attr_accessor :email
+
+    attr_accessor :email_domain
+
+    attr_accessor :family_name
+
+    attr_accessor :given_name
+
+    # The person id.
+    attr_accessor :id
+
+    attr_accessor :import_id
+
+    attr_accessor :last_activity_at
+
+    attr_accessor :object
+
+    attr_accessor :private_notes
+
+    attr_accessor :score
+
+    # Where the person came from: `csv_import`, `manual`, `api`, `form`, `inbound`, `integration`.
+    attr_accessor :source
+
+    # Lifecycle status: `active`, `replied`, `bounced`, `unsubscribed`, `finished`.
+    attr_accessor :status
+
+    attr_accessor :telephone
+
+    attr_accessor :telephones
+
+    attr_accessor :updated_at
+
+    # Expansion: the person's enrollments across all campaigns.
+    attr_accessor :enrollments
+
+    # Expansion: the static groups this person belongs to.
+    attr_accessor :groups
+
+    # Expansion: the dynamic segments this person currently matches.
+    attr_accessor :segments
+
+    # Expansion: the person's merged sent + received messages, newest first.
+    attr_accessor :timeline
+
+    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
+      {
+        :'archived_at' => :'archivedAt',
+        :'created_at' => :'createdAt',
+        :'custom_fields' => :'customFields',
+        :'email' => :'email',
+        :'email_domain' => :'emailDomain',
+        :'family_name' => :'familyName',
+        :'given_name' => :'givenName',
+        :'id' => :'id',
+        :'import_id' => :'importId',
+        :'last_activity_at' => :'lastActivityAt',
+        :'object' => :'object',
+        :'private_notes' => :'privateNotes',
+        :'score' => :'score',
+        :'source' => :'source',
+        :'status' => :'status',
+        :'telephone' => :'telephone',
+        :'telephones' => :'telephones',
+        :'updated_at' => :'updatedAt',
+        :'enrollments' => :'enrollments',
+        :'groups' => :'groups',
+        :'segments' => :'segments',
+        :'timeline' => :'timeline'
+      }
+    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
+      {
+        :'archived_at' => :'Object',
+        :'created_at' => :'Object',
+        :'custom_fields' => :'Hash<String, Object>',
+        :'email' => :'String',
+        :'email_domain' => :'String',
+        :'family_name' => :'String',
+        :'given_name' => :'String',
+        :'id' => :'String',
+        :'import_id' => :'String',
+        :'last_activity_at' => :'Object',
+        :'object' => :'Object',
+        :'private_notes' => :'String',
+        :'score' => :'Integer',
+        :'source' => :'String',
+        :'status' => :'String',
+        :'telephone' => :'String',
+        :'telephones' => :'Array<String>',
+        :'updated_at' => :'Object',
+        :'enrollments' => :'Array<Enrollment>',
+        :'groups' => :'Array<PersonGroupRef>',
+        :'segments' => :'Array<PersonSegmentRef>',
+        :'timeline' => :'Array<Message>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'archived_at',
+        :'created_at',
+        :'custom_fields',
+        :'email',
+        :'email_domain',
+        :'family_name',
+        :'given_name',
+        :'import_id',
+        :'last_activity_at',
+        :'object',
+        :'private_notes',
+        :'score',
+        :'telephone',
+        :'telephones',
+        :'updated_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::PersonDetail` 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::PersonDetail`. 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?(:'archived_at')
+        self.archived_at = attributes[:'archived_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'custom_fields')
+        if (value = attributes[:'custom_fields']).is_a?(Hash)
+          self.custom_fields = value
+        end
+      else
+        self.custom_fields = nil
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'email_domain')
+        self.email_domain = attributes[:'email_domain']
+      else
+        self.email_domain = nil
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      else
+        self.family_name = nil
+      end
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      else
+        self.given_name = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'import_id')
+        self.import_id = attributes[:'import_id']
+      else
+        self.import_id = nil
+      end
+
+      if attributes.key?(:'last_activity_at')
+        self.last_activity_at = attributes[:'last_activity_at']
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      end
+
+      if attributes.key?(:'private_notes')
+        self.private_notes = attributes[:'private_notes']
+      else
+        self.private_notes = nil
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      else
+        self.score = nil
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      else
+        self.source = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'telephone')
+        self.telephone = attributes[:'telephone']
+      else
+        self.telephone = nil
+      end
+
+      if attributes.key?(:'telephones')
+        if (value = attributes[:'telephones']).is_a?(Array)
+          self.telephones = value
+        end
+      else
+        self.telephones = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'enrollments')
+        if (value = attributes[:'enrollments']).is_a?(Array)
+          self.enrollments = value
+        end
+      end
+
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      end
+
+      if attributes.key?(:'segments')
+        if (value = attributes[:'segments']).is_a?(Array)
+          self.segments = value
+        end
+      end
+
+      if attributes.key?(:'timeline')
+        if (value = attributes[:'timeline']).is_a?(Array)
+          self.timeline = value
+        end
+      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 @score > 100
+        invalid_properties.push('invalid value for "score", must be smaller than or equal to 100.')
+      end
+
+      if @score < 0
+        invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
+      end
+
+      if @source.nil?
+        invalid_properties.push('invalid value for "source", source cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @score > 100
+      return false if @score < 0
+      return false if @source.nil?
+      source_validator = EnumAttributeValidator.new('String', ["csv_import", "manual", "api", "form", "inbound", "integration"])
+      return false unless source_validator.valid?(@source)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "replied", "bounced", "unsubscribed", "finished"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if !score.nil? && score > 100
+        fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 100.'
+      end
+
+      if !score.nil? && score < 0
+        fail ArgumentError, 'invalid value for "score", must be greater than or equal to 0.'
+      end
+
+      @score = score
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["csv_import", "manual", "api", "form", "inbound", "integration"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "replied", "bounced", "unsubscribed", "finished"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          archived_at == o.archived_at &&
+          created_at == o.created_at &&
+          custom_fields == o.custom_fields &&
+          email == o.email &&
+          email_domain == o.email_domain &&
+          family_name == o.family_name &&
+          given_name == o.given_name &&
+          id == o.id &&
+          import_id == o.import_id &&
+          last_activity_at == o.last_activity_at &&
+          object == o.object &&
+          private_notes == o.private_notes &&
+          score == o.score &&
+          source == o.source &&
+          status == o.status &&
+          telephone == o.telephone &&
+          telephones == o.telephones &&
+          updated_at == o.updated_at &&
+          enrollments == o.enrollments &&
+          groups == o.groups &&
+          segments == o.segments &&
+          timeline == o.timeline
+    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
+      [archived_at, created_at, custom_fields, email, email_domain, family_name, given_name, id, import_id, last_activity_at, object, private_notes, score, source, status, telephone, telephones, updated_at, enrollments, groups, segments, timeline].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