norbelys 0.1.0

data/lib/norbelys/models/warmup_settings.rb

@@ -0,0 +1,562 @@
+=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 WarmupSettings
+    # Automatically adapt warmup volume and matching over time.
+    attr_accessor :auto_adjust
+
+    # Your own copy to warm — used for a share of daily openers.
+    attr_accessor :custom_templates
+
+    # Ramp ceiling (max warmup sends per day).
+    attr_accessor :daily_max
+
+    # Warmup sends targeted today.
+    attr_accessor :daily_target
+
+    # Whether warmup is active for this mailbox.
+    attr_accessor :enabled
+
+    # Language for stock warmup conversations: English or Spanish (default en).
+    attr_accessor :language
+
+    # Grow the daily target over time.
+    attr_accessor :rampup_enabled
+
+    # Daily increase applied to the target while ramping.
+    attr_accessor :rampup_increment
+
+    # Fraction of warmup mail replied to, from 0 to 1.
+    attr_accessor :reply_rate
+
+    # IANA timezone the sending window is evaluated in.
+    attr_accessor :timezone
+
+    # Optional topics woven into stock warmup openers.
+    attr_accessor :topics
+
+    # Skip weekends.
+    attr_accessor :weekdays_only
+
+    # Window open, \"HH:MM\" in the mailbox timezone.
+    attr_accessor :window_from
+
+    # Window close, \"HH:MM\" in the mailbox timezone.
+    attr_accessor :window_to
+
+    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
+      {
+        :'auto_adjust' => :'autoAdjust',
+        :'custom_templates' => :'customTemplates',
+        :'daily_max' => :'dailyMax',
+        :'daily_target' => :'dailyTarget',
+        :'enabled' => :'enabled',
+        :'language' => :'language',
+        :'rampup_enabled' => :'rampupEnabled',
+        :'rampup_increment' => :'rampupIncrement',
+        :'reply_rate' => :'replyRate',
+        :'timezone' => :'timezone',
+        :'topics' => :'topics',
+        :'weekdays_only' => :'weekdaysOnly',
+        :'window_from' => :'windowFrom',
+        :'window_to' => :'windowTo'
+      }
+    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
+      {
+        :'auto_adjust' => :'Boolean',
+        :'custom_templates' => :'Array<WarmupTemplate>',
+        :'daily_max' => :'Integer',
+        :'daily_target' => :'Integer',
+        :'enabled' => :'Boolean',
+        :'language' => :'String',
+        :'rampup_enabled' => :'Boolean',
+        :'rampup_increment' => :'Integer',
+        :'reply_rate' => :'Float',
+        :'timezone' => :'String',
+        :'topics' => :'Array<String>',
+        :'weekdays_only' => :'Boolean',
+        :'window_from' => :'String',
+        :'window_to' => :'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::WarmupSettings` 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::WarmupSettings`. 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?(:'auto_adjust')
+        self.auto_adjust = attributes[:'auto_adjust']
+      else
+        self.auto_adjust = nil
+      end
+
+      if attributes.key?(:'custom_templates')
+        if (value = attributes[:'custom_templates']).is_a?(Array)
+          self.custom_templates = value
+        end
+      end
+
+      if attributes.key?(:'daily_max')
+        self.daily_max = attributes[:'daily_max']
+      else
+        self.daily_max = nil
+      end
+
+      if attributes.key?(:'daily_target')
+        self.daily_target = attributes[:'daily_target']
+      else
+        self.daily_target = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'rampup_enabled')
+        self.rampup_enabled = attributes[:'rampup_enabled']
+      else
+        self.rampup_enabled = nil
+      end
+
+      if attributes.key?(:'rampup_increment')
+        self.rampup_increment = attributes[:'rampup_increment']
+      else
+        self.rampup_increment = nil
+      end
+
+      if attributes.key?(:'reply_rate')
+        self.reply_rate = attributes[:'reply_rate']
+      else
+        self.reply_rate = nil
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'topics')
+        if (value = attributes[:'topics']).is_a?(Array)
+          self.topics = value
+        end
+      end
+
+      if attributes.key?(:'weekdays_only')
+        self.weekdays_only = attributes[:'weekdays_only']
+      else
+        self.weekdays_only = nil
+      end
+
+      if attributes.key?(:'window_from')
+        self.window_from = attributes[:'window_from']
+      end
+
+      if attributes.key?(:'window_to')
+        self.window_to = attributes[:'window_to']
+      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 @auto_adjust.nil?
+        invalid_properties.push('invalid value for "auto_adjust", auto_adjust cannot be nil.')
+      end
+
+      if !@custom_templates.nil? && @custom_templates.length > 5
+        invalid_properties.push('invalid value for "custom_templates", number of items must be less than or equal to 5.')
+      end
+
+      if @daily_max.nil?
+        invalid_properties.push('invalid value for "daily_max", daily_max cannot be nil.')
+      end
+
+      if @daily_max < 0
+        invalid_properties.push('invalid value for "daily_max", must be greater than or equal to 0.')
+      end
+
+      if @daily_target.nil?
+        invalid_properties.push('invalid value for "daily_target", daily_target cannot be nil.')
+      end
+
+      if @daily_target < 0
+        invalid_properties.push('invalid value for "daily_target", must be greater than or equal to 0.')
+      end
+
+      if @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @rampup_enabled.nil?
+        invalid_properties.push('invalid value for "rampup_enabled", rampup_enabled cannot be nil.')
+      end
+
+      if @rampup_increment.nil?
+        invalid_properties.push('invalid value for "rampup_increment", rampup_increment cannot be nil.')
+      end
+
+      if @rampup_increment < 0
+        invalid_properties.push('invalid value for "rampup_increment", must be greater than or equal to 0.')
+      end
+
+      if @reply_rate.nil?
+        invalid_properties.push('invalid value for "reply_rate", reply_rate cannot be nil.')
+      end
+
+      if @reply_rate > 1
+        invalid_properties.push('invalid value for "reply_rate", must be smaller than or equal to 1.')
+      end
+
+      if @reply_rate < 0
+        invalid_properties.push('invalid value for "reply_rate", must be greater than or equal to 0.')
+      end
+
+      if !@topics.nil? && @topics.length > 8
+        invalid_properties.push('invalid value for "topics", number of items must be less than or equal to 8.')
+      end
+
+      if @weekdays_only.nil?
+        invalid_properties.push('invalid value for "weekdays_only", weekdays_only 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 @auto_adjust.nil?
+      return false if !@custom_templates.nil? && @custom_templates.length > 5
+      return false if @daily_max.nil?
+      return false if @daily_max < 0
+      return false if @daily_target.nil?
+      return false if @daily_target < 0
+      return false if @enabled.nil?
+      language_validator = EnumAttributeValidator.new('String', ["en", "es"])
+      return false unless language_validator.valid?(@language)
+      return false if @rampup_enabled.nil?
+      return false if @rampup_increment.nil?
+      return false if @rampup_increment < 0
+      return false if @reply_rate.nil?
+      return false if @reply_rate > 1
+      return false if @reply_rate < 0
+      return false if !@topics.nil? && @topics.length > 8
+      return false if @weekdays_only.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] custom_templates Value to be assigned
+    def custom_templates=(custom_templates)
+      if custom_templates.nil?
+        fail ArgumentError, 'custom_templates cannot be nil'
+      end
+
+      if custom_templates.length > 5
+        fail ArgumentError, 'invalid value for "custom_templates", number of items must be less than or equal to 5.'
+      end
+
+      @custom_templates = custom_templates
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] daily_max Value to be assigned
+    def daily_max=(daily_max)
+      if daily_max.nil?
+        fail ArgumentError, 'daily_max cannot be nil'
+      end
+
+      if daily_max < 0
+        fail ArgumentError, 'invalid value for "daily_max", must be greater than or equal to 0.'
+      end
+
+      @daily_max = daily_max
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] daily_target Value to be assigned
+    def daily_target=(daily_target)
+      if daily_target.nil?
+        fail ArgumentError, 'daily_target cannot be nil'
+      end
+
+      if daily_target < 0
+        fail ArgumentError, 'invalid value for "daily_target", must be greater than or equal to 0.'
+      end
+
+      @daily_target = daily_target
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] language Object to be assigned
+    def language=(language)
+      validator = EnumAttributeValidator.new('String', ["en", "es"])
+      unless validator.valid?(language)
+        fail ArgumentError, "invalid value for \"language\", must be one of #{validator.allowable_values}."
+      end
+      @language = language
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rampup_increment Value to be assigned
+    def rampup_increment=(rampup_increment)
+      if rampup_increment.nil?
+        fail ArgumentError, 'rampup_increment cannot be nil'
+      end
+
+      if rampup_increment < 0
+        fail ArgumentError, 'invalid value for "rampup_increment", must be greater than or equal to 0.'
+      end
+
+      @rampup_increment = rampup_increment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reply_rate Value to be assigned
+    def reply_rate=(reply_rate)
+      if reply_rate.nil?
+        fail ArgumentError, 'reply_rate cannot be nil'
+      end
+
+      if reply_rate > 1
+        fail ArgumentError, 'invalid value for "reply_rate", must be smaller than or equal to 1.'
+      end
+
+      if reply_rate < 0
+        fail ArgumentError, 'invalid value for "reply_rate", must be greater than or equal to 0.'
+      end
+
+      @reply_rate = reply_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] topics Value to be assigned
+    def topics=(topics)
+      if topics.nil?
+        fail ArgumentError, 'topics cannot be nil'
+      end
+
+      if topics.length > 8
+        fail ArgumentError, 'invalid value for "topics", number of items must be less than or equal to 8.'
+      end
+
+      @topics = topics
+    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 &&
+          auto_adjust == o.auto_adjust &&
+          custom_templates == o.custom_templates &&
+          daily_max == o.daily_max &&
+          daily_target == o.daily_target &&
+          enabled == o.enabled &&
+          language == o.language &&
+          rampup_enabled == o.rampup_enabled &&
+          rampup_increment == o.rampup_increment &&
+          reply_rate == o.reply_rate &&
+          timezone == o.timezone &&
+          topics == o.topics &&
+          weekdays_only == o.weekdays_only &&
+          window_from == o.window_from &&
+          window_to == o.window_to
+    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
+      [auto_adjust, custom_templates, daily_max, daily_target, enabled, language, rampup_enabled, rampup_increment, reply_rate, timezone, topics, weekdays_only, window_from, window_to].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