norbelys 0.1.0

data/lib/norbelys/models/domain_sending_policy.rb

@@ -0,0 +1,479 @@
+=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 daily-budget control policy.
+  class DomainSendingPolicy
+    # Whether the platform may pause ALL sends from this domain when health is critical.
+    attr_accessor :allow_pause_all
+
+    # Whether the platform may pause first-touch (cold) sends while replies keep flowing.
+    attr_accessor :allow_pause_first_touches
+
+    attr_accessor :autopilot_max
+
+    attr_accessor :autopilot_min
+
+    attr_accessor :configured_daily_cap
+
+    attr_accessor :effective_daily_cap
+
+    attr_accessor :max_daily_growth_percent
+
+    # Budget control mode: `legacy`, `manual`, or `autopilot`.
+    attr_accessor :mode
+
+    attr_accessor :recommended_daily_cap
+
+    # IANA timezone the daily window and reset are computed in.
+    attr_accessor :timezone
+
+    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
+      {
+        :'allow_pause_all' => :'allowPauseAll',
+        :'allow_pause_first_touches' => :'allowPauseFirstTouches',
+        :'autopilot_max' => :'autopilotMax',
+        :'autopilot_min' => :'autopilotMin',
+        :'configured_daily_cap' => :'configuredDailyCap',
+        :'effective_daily_cap' => :'effectiveDailyCap',
+        :'max_daily_growth_percent' => :'maxDailyGrowthPercent',
+        :'mode' => :'mode',
+        :'recommended_daily_cap' => :'recommendedDailyCap',
+        :'timezone' => :'timezone'
+      }
+    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
+      {
+        :'allow_pause_all' => :'Boolean',
+        :'allow_pause_first_touches' => :'Boolean',
+        :'autopilot_max' => :'Integer',
+        :'autopilot_min' => :'Integer',
+        :'configured_daily_cap' => :'Integer',
+        :'effective_daily_cap' => :'Integer',
+        :'max_daily_growth_percent' => :'Integer',
+        :'mode' => :'String',
+        :'recommended_daily_cap' => :'Integer',
+        :'timezone' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'autopilot_max',
+        :'autopilot_min',
+        :'configured_daily_cap',
+        :'effective_daily_cap',
+        :'max_daily_growth_percent',
+        :'recommended_daily_cap',
+      ])
+    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::DomainSendingPolicy` 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::DomainSendingPolicy`. 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?(:'allow_pause_all')
+        self.allow_pause_all = attributes[:'allow_pause_all']
+      else
+        self.allow_pause_all = nil
+      end
+
+      if attributes.key?(:'allow_pause_first_touches')
+        self.allow_pause_first_touches = attributes[:'allow_pause_first_touches']
+      else
+        self.allow_pause_first_touches = nil
+      end
+
+      if attributes.key?(:'autopilot_max')
+        self.autopilot_max = attributes[:'autopilot_max']
+      else
+        self.autopilot_max = nil
+      end
+
+      if attributes.key?(:'autopilot_min')
+        self.autopilot_min = attributes[:'autopilot_min']
+      else
+        self.autopilot_min = nil
+      end
+
+      if attributes.key?(:'configured_daily_cap')
+        self.configured_daily_cap = attributes[:'configured_daily_cap']
+      else
+        self.configured_daily_cap = nil
+      end
+
+      if attributes.key?(:'effective_daily_cap')
+        self.effective_daily_cap = attributes[:'effective_daily_cap']
+      else
+        self.effective_daily_cap = nil
+      end
+
+      if attributes.key?(:'max_daily_growth_percent')
+        self.max_daily_growth_percent = attributes[:'max_daily_growth_percent']
+      else
+        self.max_daily_growth_percent = nil
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'recommended_daily_cap')
+        self.recommended_daily_cap = attributes[:'recommended_daily_cap']
+      else
+        self.recommended_daily_cap = nil
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      else
+        self.timezone = 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 @allow_pause_all.nil?
+        invalid_properties.push('invalid value for "allow_pause_all", allow_pause_all cannot be nil.')
+      end
+
+      if @allow_pause_first_touches.nil?
+        invalid_properties.push('invalid value for "allow_pause_first_touches", allow_pause_first_touches cannot be nil.')
+      end
+
+      if @autopilot_max < 0
+        invalid_properties.push('invalid value for "autopilot_max", must be greater than or equal to 0.')
+      end
+
+      if @autopilot_min < 0
+        invalid_properties.push('invalid value for "autopilot_min", must be greater than or equal to 0.')
+      end
+
+      if @configured_daily_cap < 0
+        invalid_properties.push('invalid value for "configured_daily_cap", must be greater than or equal to 0.')
+      end
+
+      if @effective_daily_cap < 0
+        invalid_properties.push('invalid value for "effective_daily_cap", must be greater than or equal to 0.')
+      end
+
+      if @max_daily_growth_percent > 100
+        invalid_properties.push('invalid value for "max_daily_growth_percent", must be smaller than or equal to 100.')
+      end
+
+      if @max_daily_growth_percent < 0
+        invalid_properties.push('invalid value for "max_daily_growth_percent", must be greater than or equal to 0.')
+      end
+
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      if @recommended_daily_cap < 0
+        invalid_properties.push('invalid value for "recommended_daily_cap", must be greater than or equal to 0.')
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone 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 @allow_pause_all.nil?
+      return false if @allow_pause_first_touches.nil?
+      return false if @autopilot_max < 0
+      return false if @autopilot_min < 0
+      return false if @configured_daily_cap < 0
+      return false if @effective_daily_cap < 0
+      return false if @max_daily_growth_percent > 100
+      return false if @max_daily_growth_percent < 0
+      return false if @mode.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["legacy", "manual", "autopilot"])
+      return false unless mode_validator.valid?(@mode)
+      return false if @recommended_daily_cap < 0
+      return false if @timezone.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] autopilot_max Value to be assigned
+    def autopilot_max=(autopilot_max)
+      if !autopilot_max.nil? && autopilot_max < 0
+        fail ArgumentError, 'invalid value for "autopilot_max", must be greater than or equal to 0.'
+      end
+
+      @autopilot_max = autopilot_max
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] autopilot_min Value to be assigned
+    def autopilot_min=(autopilot_min)
+      if !autopilot_min.nil? && autopilot_min < 0
+        fail ArgumentError, 'invalid value for "autopilot_min", must be greater than or equal to 0.'
+      end
+
+      @autopilot_min = autopilot_min
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] configured_daily_cap Value to be assigned
+    def configured_daily_cap=(configured_daily_cap)
+      if !configured_daily_cap.nil? && configured_daily_cap < 0
+        fail ArgumentError, 'invalid value for "configured_daily_cap", must be greater than or equal to 0.'
+      end
+
+      @configured_daily_cap = configured_daily_cap
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] effective_daily_cap Value to be assigned
+    def effective_daily_cap=(effective_daily_cap)
+      if !effective_daily_cap.nil? && effective_daily_cap < 0
+        fail ArgumentError, 'invalid value for "effective_daily_cap", must be greater than or equal to 0.'
+      end
+
+      @effective_daily_cap = effective_daily_cap
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_daily_growth_percent Value to be assigned
+    def max_daily_growth_percent=(max_daily_growth_percent)
+      if !max_daily_growth_percent.nil? && max_daily_growth_percent > 100
+        fail ArgumentError, 'invalid value for "max_daily_growth_percent", must be smaller than or equal to 100.'
+      end
+
+      if !max_daily_growth_percent.nil? && max_daily_growth_percent < 0
+        fail ArgumentError, 'invalid value for "max_daily_growth_percent", must be greater than or equal to 0.'
+      end
+
+      @max_daily_growth_percent = max_daily_growth_percent
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["legacy", "manual", "autopilot"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recommended_daily_cap Value to be assigned
+    def recommended_daily_cap=(recommended_daily_cap)
+      if !recommended_daily_cap.nil? && recommended_daily_cap < 0
+        fail ArgumentError, 'invalid value for "recommended_daily_cap", must be greater than or equal to 0.'
+      end
+
+      @recommended_daily_cap = recommended_daily_cap
+    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 &&
+          allow_pause_all == o.allow_pause_all &&
+          allow_pause_first_touches == o.allow_pause_first_touches &&
+          autopilot_max == o.autopilot_max &&
+          autopilot_min == o.autopilot_min &&
+          configured_daily_cap == o.configured_daily_cap &&
+          effective_daily_cap == o.effective_daily_cap &&
+          max_daily_growth_percent == o.max_daily_growth_percent &&
+          mode == o.mode &&
+          recommended_daily_cap == o.recommended_daily_cap &&
+          timezone == o.timezone
+    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
+      [allow_pause_all, allow_pause_first_touches, autopilot_max, autopilot_min, configured_daily_cap, effective_daily_cap, max_daily_growth_percent, mode, recommended_daily_cap, timezone].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