norbelys 0.1.0

data/lib/norbelys/models/analytics_query_params.rb

@@ -0,0 +1,485 @@
+=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
+  # Query parameters; each query reads the subset it supports.
+  class AnalyticsQueryParams
+    # The outbound message id. Required by the message_events query; returns every event for that one send.
+    attr_accessor :activity
+
+    # Lookback window in days (alternative to since/until).
+    attr_accessor :days
+
+    # Sort direction for activity_feed (default desc).
+    attr_accessor :dir
+
+    # The monitored domain name. Required by dmarc_summary / dmarc_sources; optional on dmarc_reports / dmarc_receivers — omit for the account-wide feed. Example: acme.com
+    attr_accessor :domain
+
+    # activity_feed only: exclude machine-generated engagement — opens not classified as human (e.g. automated inbox prefetches) and any bot-classified event.
+    attr_accessor :exclude_machine
+
+    # Max rows returned.
+    attr_accessor :limit
+
+    # Rows to skip (activity_feed paging).
+    attr_accessor :offset
+
+    # Sort column for activity_feed. Example: occurred_at
+    attr_accessor :order_by
+
+    # Scope to one person (person id). Used by: contact_events.
+    attr_accessor :person
+
+    # Scope to one campaign (program id). Used by: activity_feed, program_funnel, sender_breakdown, variant_performance.
+    attr_accessor :program
+
+    # Narrow the DMARC queries to ONE reporter (receiver) — 'show me only what Gmail saw'. Used by: dmarc_summary, dmarc_sources, dmarc_geo, dmarc_reports.
+    attr_accessor :receiver
+
+    # Free-text search (activity_feed: matches recipient/subject).
+    attr_accessor :search
+
+    # Scope to one sender — by id (\"snd_…\") or by its from address (\"receipts@hola.com\"); both filter identically. Used by: activity_feed, sender_health, warmup_placement.
+    attr_accessor :sender
+
+    # Window start (ISO 8601). Most queries default to the last 30 days.
+    attr_accessor :since
+
+    # A conversation (thread) id — narrows agent_trace to one conversation.
+    attr_accessor :thread
+
+    # Filter to one event type.
+    attr_accessor :type
+
+    # Window end (ISO 8601).
+    attr_accessor :_until
+
+    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
+      {
+        :'activity' => :'activity',
+        :'days' => :'days',
+        :'dir' => :'dir',
+        :'domain' => :'domain',
+        :'exclude_machine' => :'excludeMachine',
+        :'limit' => :'limit',
+        :'offset' => :'offset',
+        :'order_by' => :'orderBy',
+        :'person' => :'person',
+        :'program' => :'program',
+        :'receiver' => :'receiver',
+        :'search' => :'search',
+        :'sender' => :'sender',
+        :'since' => :'since',
+        :'thread' => :'thread',
+        :'type' => :'type',
+        :'_until' => :'until'
+      }
+    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
+      {
+        :'activity' => :'String',
+        :'days' => :'Integer',
+        :'dir' => :'String',
+        :'domain' => :'String',
+        :'exclude_machine' => :'Boolean',
+        :'limit' => :'Integer',
+        :'offset' => :'Integer',
+        :'order_by' => :'String',
+        :'person' => :'String',
+        :'program' => :'String',
+        :'receiver' => :'String',
+        :'search' => :'String',
+        :'sender' => :'String',
+        :'since' => :'String',
+        :'thread' => :'String',
+        :'type' => :'String',
+        :'_until' => :'String'
+      }
+    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::AnalyticsQueryParams` 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::AnalyticsQueryParams`. 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?(:'activity')
+        self.activity = attributes[:'activity']
+      end
+
+      if attributes.key?(:'days')
+        self.days = attributes[:'days']
+      end
+
+      if attributes.key?(:'dir')
+        self.dir = attributes[:'dir']
+      end
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'exclude_machine')
+        self.exclude_machine = attributes[:'exclude_machine']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
+
+      if attributes.key?(:'order_by')
+        self.order_by = attributes[:'order_by']
+      end
+
+      if attributes.key?(:'person')
+        self.person = attributes[:'person']
+      end
+
+      if attributes.key?(:'program')
+        self.program = attributes[:'program']
+      end
+
+      if attributes.key?(:'receiver')
+        self.receiver = attributes[:'receiver']
+      end
+
+      if attributes.key?(:'search')
+        self.search = attributes[:'search']
+      end
+
+      if attributes.key?(:'sender')
+        self.sender = attributes[:'sender']
+      end
+
+      if attributes.key?(:'since')
+        self.since = attributes[:'since']
+      end
+
+      if attributes.key?(:'thread')
+        self.thread = attributes[:'thread']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'_until')
+        self._until = attributes[:'_until']
+      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 !@days.nil? && @days > 365
+        invalid_properties.push('invalid value for "days", must be smaller than or equal to 365.')
+      end
+
+      if !@days.nil? && @days < 1
+        invalid_properties.push('invalid value for "days", must be greater than or equal to 1.')
+      end
+
+      if !@limit.nil? && @limit > 1000
+        invalid_properties.push('invalid value for "limit", must be smaller than or equal to 1000.')
+      end
+
+      if !@limit.nil? && @limit < 1
+        invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
+      end
+
+      if !@offset.nil? && @offset < 0
+        invalid_properties.push('invalid value for "offset", 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 !@days.nil? && @days > 365
+      return false if !@days.nil? && @days < 1
+      dir_validator = EnumAttributeValidator.new('String', ["asc", "desc"])
+      return false unless dir_validator.valid?(@dir)
+      return false if !@limit.nil? && @limit > 1000
+      return false if !@limit.nil? && @limit < 1
+      return false if !@offset.nil? && @offset < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] days Value to be assigned
+    def days=(days)
+      if days.nil?
+        fail ArgumentError, 'days cannot be nil'
+      end
+
+      if days > 365
+        fail ArgumentError, 'invalid value for "days", must be smaller than or equal to 365.'
+      end
+
+      if days < 1
+        fail ArgumentError, 'invalid value for "days", must be greater than or equal to 1.'
+      end
+
+      @days = days
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dir Object to be assigned
+    def dir=(dir)
+      validator = EnumAttributeValidator.new('String', ["asc", "desc"])
+      unless validator.valid?(dir)
+        fail ArgumentError, "invalid value for \"dir\", must be one of #{validator.allowable_values}."
+      end
+      @dir = dir
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit Value to be assigned
+    def limit=(limit)
+      if limit.nil?
+        fail ArgumentError, 'limit cannot be nil'
+      end
+
+      if limit > 1000
+        fail ArgumentError, 'invalid value for "limit", must be smaller than or equal to 1000.'
+      end
+
+      if limit < 1
+        fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 1.'
+      end
+
+      @limit = limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] offset Value to be assigned
+    def offset=(offset)
+      if offset.nil?
+        fail ArgumentError, 'offset cannot be nil'
+      end
+
+      if offset < 0
+        fail ArgumentError, 'invalid value for "offset", must be greater than or equal to 0.'
+      end
+
+      @offset = offset
+    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 &&
+          activity == o.activity &&
+          days == o.days &&
+          dir == o.dir &&
+          domain == o.domain &&
+          exclude_machine == o.exclude_machine &&
+          limit == o.limit &&
+          offset == o.offset &&
+          order_by == o.order_by &&
+          person == o.person &&
+          program == o.program &&
+          receiver == o.receiver &&
+          search == o.search &&
+          sender == o.sender &&
+          since == o.since &&
+          thread == o.thread &&
+          type == o.type &&
+          _until == o._until
+    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
+      [activity, days, dir, domain, exclude_machine, limit, offset, order_by, person, program, receiver, search, sender, since, thread, type, _until].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